Cleaned up RegionCommands, abstracted region permissions.

src/main/java/com/sk89q/worldguard/bukkit/AbstractPermissionModel.java

@@ -0,0 +1,46 @@
+// $Id$
+/*
+ * This file is a part of WorldGuard.
+ * Copyright (c) sk89q <http://www.sk89q.com>
+ * Copyright (c) the WorldGuard team and contributors
+ *
+ * This program is free software: you can redistribute it and/or modify it under the
+ * terms of the GNU Lesser General Public License as published by the Free Software
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY), without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along with
+ * this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+package com.sk89q.worldguard.bukkit;
+
+import org.bukkit.command.CommandSender;
+import org.enginehub.util.PermissionModel;
+
+abstract class AbstractPermissionModel implements PermissionModel {
+    
+    private final WorldGuardPlugin plugin;
+    private final CommandSender sender;
+
+    public AbstractPermissionModel(WorldGuardPlugin plugin, CommandSender sender) {
+        this.plugin = plugin;
+        this.sender = sender;
+    }
+    
+    protected WorldGuardPlugin getPlugin() {
+        return plugin;
+    }
+
+    public CommandSender getSender() {
+        return sender;
+    }
+
+    protected boolean hasPluginPermission(String permission) {
+        return plugin.hasPermission(getSender(), "worldguard." + permission);
+    }
+
+}

src/main/java/com/sk89q/worldguard/bukkit/RegionPermissionModel.java

@@ -0,0 +1,145 @@
+// $Id$
+/*
+ * This file is a part of WorldGuard.
+ * Copyright (c) sk89q <http://www.sk89q.com>
+ * Copyright (c) the WorldGuard team and contributors
+ *
+ * This program is free software: you can redistribute it and/or modify it under the
+ * terms of the GNU Lesser General Public License as published by the Free Software
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY), without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along with
+ * this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+package com.sk89q.worldguard.bukkit;
+
+import org.bukkit.command.CommandSender;
+import org.bukkit.entity.Player;
+
+import com.sk89q.worldguard.LocalPlayer;
+import com.sk89q.worldguard.protection.flags.Flag;
+import com.sk89q.worldguard.protection.regions.ProtectedRegion;
+
+/**
+ * Used for querying region-related permissions.
+ */
+public class RegionPermissionModel extends AbstractPermissionModel {
+    
+    public RegionPermissionModel(WorldGuardPlugin plugin, CommandSender sender) {
+        super(plugin, sender);
+    }
+    
+    public boolean canForceLoadRegions() {
+        return hasPluginPermission("region.load");
+    }
+    
+    public boolean canForceSaveRegions() {
+        return hasPluginPermission("region.save");
+    }
+    
+    public boolean canMigrateRegionStore() {
+        return hasPluginPermission("region.migratedb");
+    }
+    
+    public boolean canDefine() {
+        return hasPluginPermission("region.define");
+    }
+    
+    public boolean canRedefine(ProtectedRegion region) {
+        return hasPatternPermission("redefine", region);
+    }
+    
+    public boolean canClaim() {
+        return hasPluginPermission("region.claim");
+    }
+    
+    public boolean canClaimRegionsUnbounded() {
+        return hasPluginPermission("region.unlimited");
+    }
+    
+    public boolean canDelete(ProtectedRegion region) {
+        return hasPatternPermission("remove", region);
+    }
+    
+    public boolean canSetPriority(ProtectedRegion region) {
+        return hasPatternPermission("setpriority", region);
+    }
+    
+    public boolean canSetParent(ProtectedRegion child, ProtectedRegion parent) {
+        return hasPatternPermission("setparent", child) &&
+                (parent == null ||
+                hasPatternPermission("setparent", parent));
+    }
+    
+    public boolean canSelect(ProtectedRegion region) {
+        return hasPatternPermission("select", region);
+    }
+    
+    public boolean canLookup(ProtectedRegion region) {
+        return hasPatternPermission("info", region);
+    }
+    
+    public boolean canTeleportTo(ProtectedRegion region) {
+        return hasPatternPermission("teleport", region);
+    }
+    
+    public boolean canList() {
+        return hasPluginPermission("region.list");
+    }
+    
+    public boolean canList(String targetPlayer) {
+        if (targetPlayer == null) {
+            return canList();
+        }
+        
+        if (targetPlayer.equalsIgnoreCase(getSender().getName())) {
+            return hasPluginPermission("region.list.own");
+        } else {
+            return canList();
+        }
+    }
+    
+    public boolean canSetFlag(ProtectedRegion region) {
+        return hasPatternPermission("flag", region);
+    }
+    
+    public boolean canSetFlag(ProtectedRegion region, Flag<?> flag) {
+        // This is a WTF permission
+        return hasPatternPermission(
+                "flag.flags." + flag.getName().toLowerCase(), region);
+    }
+    
+    /**
+     * Checks to see if the given sender has permission to modify the given region
+     * using the region permission pattern.
+     * 
+     * @param perm the name of the node
+     * @param region the region
+     */
+    private boolean hasPatternPermission(String perm, ProtectedRegion region) {
+        if (!(getSender() instanceof Player)) {
+            return true; // Non-players (i.e. console, command blocks, etc.) have full power
+        }
+        
+        LocalPlayer localPlayer = getPlugin().wrapPlayer((Player) getSender());
+        String idLower = region.getId().toLowerCase();
+        String effectivePerm;
+        
+        if (region.isOwner(localPlayer)) {
+            return hasPluginPermission("region." + perm + ".own." + idLower) ||
+                    hasPluginPermission("region." + perm + ".member." + idLower);
+        } else if (region.isMember(localPlayer)) {
+            return hasPluginPermission("region." + perm + ".member." + idLower);
+        } else {
+            effectivePerm = "region." + perm + "." + idLower;
+        }
+
+        return hasPluginPermission(effectivePerm);
+    }
+
+}

src/main/java/com/sk89q/worldguard/bukkit/commands/RegionListEntry.java

@@ -0,0 +1,58 @@
+// $Id$
+/*
+ * This file is a part of WorldGuard.
+ * Copyright (c) sk89q <http://www.sk89q.com>
+ * Copyright (c) the WorldGuard team and contributors
+ *
+ * This program is free software: you can redistribute it and/or modify it under the
+ * terms of the GNU Lesser General Public License as published by the Free Software
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY), without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along with
+ * this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+package com.sk89q.worldguard.bukkit.commands;
+
+/**
+ * Used for /rg list.
+ */
+class RegionListEntry implements Comparable<RegionListEntry> {
+    
+    private final String id;
+    private final int index;
+    boolean isOwner;
+    boolean isMember;
+
+    public RegionListEntry(String id, int index) {
+        this.id = id;
+        this.index = index;
+    }
+
+    @Override
+    public int compareTo(RegionListEntry o) {
+        if (isOwner != o.isOwner) {
+            return isOwner ? 1 : -1;
+        }
+        if (isMember != o.isMember) {
+            return isMember ? 1 : -1;
+        }
+        return id.compareTo(o.id);
+    }
+
+    @Override
+    public String toString() {
+        if (isOwner) {
+            return (index + 1) + ". +" + id;
+        } else if (isMember) {
+            return (index + 1) + ". -" + id;
+        } else {
+            return (index + 1) + ". " + id;
+        }
+    }
+    
+}

src/main/java/com/sk89q/worldguard/bukkit/commands/RegionPrintoutBuilder.java

@@ -0,0 +1,334 @@
+// $Id$
+/*
+ * This file is a part of WorldGuard.
+ * Copyright (c) sk89q <http://www.sk89q.com>
+ * Copyright (c) the WorldGuard team and contributors
+ *
+ * This program is free software: you can redistribute it and/or modify it under the
+ * terms of the GNU Lesser General Public License as published by the Free Software
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY), without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along with
+ * this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+package com.sk89q.worldguard.bukkit.commands;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.ListIterator;
+
+import org.bukkit.ChatColor;
+import org.bukkit.command.CommandSender;
+
+import com.sk89q.worldedit.BlockVector;
+import com.sk89q.worldguard.domains.DefaultDomain;
+import com.sk89q.worldguard.protection.flags.DefaultFlag;
+import com.sk89q.worldguard.protection.flags.Flag;
+import com.sk89q.worldguard.protection.flags.RegionGroupFlag;
+import com.sk89q.worldguard.protection.regions.ProtectedRegion;
+
+/**
+ * Create a region printout, as used in /region info to show information about
+ * a region.
+ */
+public class RegionPrintoutBuilder {
+    
+    private final ProtectedRegion region;
+    private final StringBuilder builder = new StringBuilder();
+
+    /**
+     * Create a new instance with a region to report on.
+     * 
+     * @param region the region
+     */
+    public RegionPrintoutBuilder(ProtectedRegion region) {
+        this.region = region;
+    }
+
+    /**
+     * Add a new line.
+     */
+    private void newLine() {
+        builder.append("\n");
+    }
+    
+    /**
+     * Add region name, type, and priority.
+     */
+    public void appendBasics() {
+        builder.append(ChatColor.BLUE);
+        builder.append("Region: ");
+        builder.append(ChatColor.YELLOW);
+        builder.append(region.getId());
+        
+        builder.append(ChatColor.GRAY);
+        builder.append(" (type=");
+        builder.append(region.getTypeName());
+        
+        builder.append(ChatColor.GRAY);
+        builder.append(", priority=");
+        builder.append(region.getPriority());
+        builder.append(")");
+
+        newLine();
+    }
+    
+    /**
+     * Add information about flags.
+     */
+    public void appendFlags() {
+        builder.append(ChatColor.BLUE);
+        builder.append("Flags: ");
+        
+        appendFlagsList(true);
+        
+        newLine();
+    }
+    
+    /**
+     * Append just the list of flags (without "Flags:"), including colors.
+     *
+     * @param useColors true to use colors
+     */
+    public void appendFlagsList(boolean useColors) {
+        boolean hasFlags = false;
+        
+        for (Flag<?> flag : DefaultFlag.getFlags()) {
+            Object val = region.getFlag(flag), group = null;
+            
+            // No value
+            if (val == null) {
+                continue;
+            }
+
+            if (hasFlags) {
+                builder.append(", ");
+            } else {
+                if (useColors) {
+                    builder.append(ChatColor.YELLOW);
+                }
+            }
+
+            RegionGroupFlag groupFlag = flag.getRegionGroupFlag();
+            if (groupFlag != null) {
+                group = region.getFlag(groupFlag);
+            }
+
+            if(group == null) {
+                builder.append(flag.getName()).append(": ")
+                    .append(String.valueOf(val));
+            } else {
+                builder.append(flag.getName()).append(" -g ")
+                    .append(String.valueOf(group)).append(": ")
+                    .append(String.valueOf(val));
+            }
+
+            hasFlags = true;
+        }
+            
+        if (!hasFlags) {
+            if (useColors) {
+                builder.append(ChatColor.RED);
+            }
+            builder.append("(none)");
+        }
+    }
+    
+    /**
+     * Add information about parents.
+     */
+    public void appendParents() {
+        appendParentTree(true);
+    }
+    
+    /**
+     * Add information about parents.
+     * 
+     * @param useColors true to use colors
+     */
+    public void appendParentTree(boolean useColors) {
+        if (region.getParent() == null) {
+            return;
+        }
+        
+        List<ProtectedRegion> inheritance = new ArrayList<ProtectedRegion>();
+
+        ProtectedRegion r = region;
+        inheritance.add(r);
+        while (r.getParent() != null) {
+            r = r.getParent();
+            inheritance.add(r);
+        }
+
+        ListIterator<ProtectedRegion> it = inheritance.listIterator(
+                inheritance.size());
+
+        int indent = 0;
+        while (it.hasPrevious()) {
+            ProtectedRegion cur = it.previous();
+            if (useColors) {
+                builder.append(ChatColor.GREEN);
+            }
+            
+            // Put symbol for child
+            if (indent != 0) {
+                for (int i = 0; i < indent; i++) {
+                    builder.append("  ");
+                }
+                builder.append("\u2517");
+            }
+            
+            // Put name
+            builder.append(cur.getId());
+            
+            // Put (parent)
+            if (!cur.equals(region)) {
+                if (useColors) {
+                    builder.append(ChatColor.GRAY);
+                }
+                builder.append(" (parent, priority=" + cur.getPriority() + ")");
+            }
+            
+            indent++;
+            newLine();
+        }
+    }
+    
+    /**
+     * Add information about members.
+     */
+    public void appendDomain() {
+        builder.append(ChatColor.BLUE);
+        builder.append("Owners: ");
+        DefaultDomain owners = region.getOwners();
+        if (owners.size() != 0) {
+            builder.append(ChatColor.YELLOW);
+            builder.append(owners.toUserFriendlyString());
+        } else {
+            builder.append(ChatColor.RED);
+            builder.append("(no owners)");
+        }
+
+        newLine();
+
+        builder.append(ChatColor.BLUE);
+        builder.append("Members: ");
+        DefaultDomain members = region.getMembers();
+        if (members.size() != 0) {
+            builder.append(ChatColor.YELLOW);
+            builder.append(members.toUserFriendlyString());
+        } else {
+            builder.append(ChatColor.RED);
+            builder.append("(no members)");
+        }
+        
+        newLine();
+    }
+    
+    /**
+     * Add information about coordinates.
+     */
+    public void appendBounds() {
+        BlockVector min = region.getMinimumPoint();
+        BlockVector max = region.getMaximumPoint();
+        builder.append(ChatColor.BLUE);
+        builder.append("Bounds:");
+        builder.append(ChatColor.YELLOW);
+        builder.append(" (" + min.getBlockX() + "," + min.getBlockY() + "," + min.getBlockZ() + ")");
+        builder.append(" -> (" + max.getBlockX() + "," + max.getBlockY() + "," + max.getBlockZ() + ")");
+        
+        newLine();
+    }
+    
+    /**
+     * Append all the default fields used for /rg info.
+     */
+    public void appendRegionInfo() {
+        builder.append(ChatColor.GRAY);
+        builder.append("\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550");
+        builder.append(" Region Info ");
+        builder.append("\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550");
+        newLine();
+        appendBasics();
+        appendFlags();
+        appendParents();
+        appendDomain();
+        appendBounds();
+    }
+    
+    /**
+     * Send the report to a {@link CommandSender}.
+     * 
+     * @param sender the recepient
+     */
+    public void send(CommandSender sender) {
+        sender.sendMessage(toString());
+    }
+    
+    public StringBuilder append(boolean b) {
+        return builder.append(b);
+    }
+
+    public StringBuilder append(char c) {
+        return builder.append(c);
+    }
+
+    public StringBuilder append(char[] str, int offset, int len) {
+        return builder.append(str, offset, len);
+    }
+
+    public StringBuilder append(char[] str) {
+        return builder.append(str);
+    }
+
+    public StringBuilder append(CharSequence s, int start, int end) {
+        return builder.append(s, start, end);
+    }
+
+    public StringBuilder append(CharSequence s) {
+        return builder.append(s);
+    }
+
+    public StringBuilder append(double d) {
+        return builder.append(d);
+    }
+
+    public StringBuilder append(float f) {
+        return builder.append(f);
+    }
+
+    public StringBuilder append(int i) {
+        return builder.append(i);
+    }
+
+    public StringBuilder append(long lng) {
+        return builder.append(lng);
+    }
+
+    public StringBuilder append(Object obj) {
+        return builder.append(obj);
+    }
+
+    public StringBuilder append(String str) {
+        return builder.append(str);
+    }
+
+    public StringBuilder append(StringBuffer sb) {
+        return builder.append(sb);
+    }
+
+    public StringBuilder appendCodePoint(int codePoint) {
+        return builder.appendCodePoint(codePoint);
+    }
+    
+    @Override
+    public String toString() {
+        return builder.toString().trim();
+    }
+
+}

src/main/java/com/sk89q/worldguard/protection/flags/DefaultFlag.java

@@ -119,4 +119,20 @@ private DefaultFlag() {
     public static Flag<?>[] getFlags() {
         return flagsList;
     }
+    
+    /**
+     * Try to match the flag with the given ID using a fuzzy name match.
+     * 
+     * @param id the flag ID
+     * @return a flag, or null
+     */
+    public static Flag<?> fuzzyMatchFlag(String id) {
+        for (Flag<?> flag : DefaultFlag.getFlags()) {
+            if (flag.getName().replace("-", "").equalsIgnoreCase(id.replace("-", ""))) {
+                return flag;
+            }
+        }
+        
+        return null;
+    }
 }

src/main/java/org/enginehub/util/PermissionModel.java

@@ -0,0 +1,23 @@
+// $Id$
+/*
+ * This file is a part of WorldGuard.
+ * Copyright (c) sk89q <http://www.sk89q.com>
+ * Copyright (c) the WorldGuard team and contributors
+ *
+ * This program is free software: you can redistribute it and/or modify it under the
+ * terms of the GNU Lesser General Public License as published by the Free Software
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY), without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along with
+ * this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+package org.enginehub.util;
+
+public interface PermissionModel {
+
+}