From 62a78994fd0074e1c419d2c14008e38fd5171011 Mon Sep 17 00:00:00 2001
From: Wizjany <wizjany@gmail.com>
Date: Fri, 27 May 2011 00:17:51 -0400
Subject: [PATCH] Added permissions node to Documentation Printer.

---
 .../worldedit/dev/DocumentationPrinter.java   |   8 +-
 src/main/resources/plugin.yml                 | 636 ++++++++++--------
 2 files changed, 364 insertions(+), 280 deletions(-)

diff --git a/src/main/java/com/sk89q/worldedit/dev/DocumentationPrinter.java b/src/main/java/com/sk89q/worldedit/dev/DocumentationPrinter.java
index 23e28e60d..2871865f4 100644
--- a/src/main/java/com/sk89q/worldedit/dev/DocumentationPrinter.java
+++ b/src/main/java/com/sk89q/worldedit/dev/DocumentationPrinter.java
@@ -171,7 +171,7 @@ public class DocumentationPrinter {
 
         stream.println("name: WorldEdit");
         stream.println("main: com.sk89q.worldedit.bukkit.WorldEditPlugin");
-        stream.println("version: \"WEVERSIONMACRO\"");
+        stream.println("version: ${project.version}");
         stream.println("commands:");
         
         for (Class<?> cls : commandClasses) {
@@ -192,6 +192,12 @@ public class DocumentationPrinter {
                             + StringUtil.joinQuotedString(cmd.aliases(), ", ", 1, "'")
                             + "]");
                 }
+                if (!method.isAnnotationPresent(CommandPermissions.class)) {
+                    continue;
+                }
+                CommandPermissions cmdPerms = method.getAnnotation(CommandPermissions.class);
+                stream.println("        permissions: "
+                        + StringUtil.joinQuotedString(cmdPerms.value(), ", ", 0, "'"));
             }
         }
     }
diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml
index ed33d0920..af7c466ae 100644
--- a/src/main/resources/plugin.yml
+++ b/src/main/resources/plugin.yml
@@ -1,279 +1,357 @@
-name: WorldEdit
-main: com.sk89q.worldedit.bukkit.WorldEditPlugin
-version: "${project.version}"
-commands:
-    chunkinfo:
-        description: Get information about the chunk that you are inside
-        usage: /<command> 
-    listchunks:
-        description: List chunks that your selection includes
-        usage: /<command> 
-    delchunks:
-        description: Delete chunks that your selection includes
-        usage: /<command> 
-    clearclipboard:
-        description: Clear your clipboard
-        usage: /<command> 
-    /load:
-        description: Load a schematic into your clipboard
-        usage: /<command> <filename>
-    /save:
-        description: Save a schematic into your clipboard
-        usage: /<command> <filename>
-    /copy:
-        description: Copy the selection to the clipboard
-        usage: /<command> 
-    /flip:
-        description: Flip the contents of the clipboard
-        usage: /<command> [dir]
-    /rotate:
-        description: Rotate the contents of the clipboard
-        usage: /<command> <angle-in-degrees>
-    /cut:
-        description: Cut the selection to the clipboard
-        usage: /<command> [leave-id]
-    /paste:
-        description: Paste the clipboard's contents
-        usage: /<command> [-ao] 
-    we:
-        description: WorldEdit commands
-        usage: /<command> 
-        aliases: ['worldedit']
-    toggleplace:
-        description: 
-        usage: /<command> 
-    searchitem:
-        description: Search for an item
-        usage: /<command> [-bi] <query>
-        aliases: ['/l', 'search']
-    /limit:
-        description: Modify block change limit
-        usage: /<command> <limit>
-    /hcyl:
-        description: Generate a hollow cylinder
-        usage: /<command> <block> <radius> [height] 
-    /cyl:
-        description: Generate a cylinder
-        usage: /<command> <block> <radius> [height] 
-    /hsphere:
-        description: Generate a hollow sphere
-        usage: /<command> <block> <radius> [raised?] 
-    /sphere:
-        description: Generate a filled sphere
-        usage: /<command> <block> <radius> [raised?] 
-    forestgen:
-        description: Generate a forest
-        usage: /<command> [size] [type] [density]
-    pumpkins:
-        description: Generate pumpkin patches
-        usage: /<command> [size]
-    clearhistory:
-        description: Clear your history
-        usage: /<command> 
-    /redo:
-        description: Redoes the last action (from history)
-        usage: /<command> [times]
-        aliases: ['redo']
-    /undo:
-        description: Undoes the last action
-        usage: /<command> [times]
-        aliases: ['undo']
-    unstuck:
-        description: Escape from being stuck inside a block
-        usage: /<command> 
-    ascend:
-        description: Go up a floor
-        usage: /<command> 
-    descend:
-        description: Go down a floor
-        usage: /<command> 
-    thru:
-        description: Passthrough walls
-        usage: /<command> 
-    jumpto:
-        description: Teleport to a location
-        usage: /<command> 
-    ceil:
-        description: Go to the celing
-        usage: /<command> [clearance]
-    up:
-        description: Go upwards some distance
-        usage: /<command> <block>
-    /overlay:
-        description: Set a block on top of blocks in the region
-        usage: /<command> <block>
-    /walls:
-        description: Build the four sides of the selection
-        usage: /<command> <block>
-    /faces:
-        description: Build the walls, ceiling, and roof of a selection
-        usage: /<command> <block>
-        aliases: ['/outline']
-    /smooth:
-        description: Smooth the elevation in the selection
-        usage: /<command> [iterations]
-    /regen:
-        description: Regenerates the contents of the selection
-        usage: /<command> 
-    /replace:
-        description: Replace all blocks in the selection with another
-        usage: /<command> [from-block] <to-block>
-    /stack:
-        description: Repeat the contents of the selection
-        usage: /<command> [-a] [count] [direction]
-    /set:
-        description: Set all the blocks inside the selection to a block
-        usage: /<command> <block>
-    /move:
-        description: Move the contents of the selection
-        usage: /<command> [count] [direction] [leave-id]
-    .s:
-        description: Execute last CraftScript
-        usage: /<command> [args...]
-    cs:
-        description: Execute a CraftScript
-        usage: /<command> <filename> [args...]
-    /chunk:
-        description: Set the selection to your current chunk
-        usage: /<command> 
-    /pos1:
-        description: Set position 1
-        usage: /<command> 
-    /pos2:
-        description: Set position 2
-        usage: /<command> 
-    /hpos1:
-        description: Set position 1 to targeted block
-        usage: /<command> 
-    /hpos2:
-        description: Set position 2 to targeted block
-        usage: /<command> 
-    /wand:
-        description: Get the wand object
-        usage: /<command> 
-    toggleeditwand:
-        description: Toggle functionality of the edit wand
-        usage: /<command> 
-    /contract:
-        description: Contract the selection area
-        usage: /<command> <amount> [reverse-amount] [direction]
-    /outset:
-        description: Outset the selection area
-        usage: /<command> [-hv] <amount>
-    /distr:
-        description: Get the distribution of blocks in the selection
-        usage: /<command> [-c] 
-    /count:
-        description: Counts the number of a certain type of block
-        usage: /<command> <block>
-    /size:
-        description: Get information about the selection
-        usage: /<command> 
-    /shift:
-        description: Shift the selection area
-        usage: /<command> <amount> [direction]
-    /expand:
-        description: Expand the selection area
-        usage: /<command> <amount> [reverse-amount] <direction>
-    /sel:
-        description: Choose a region selector
-        usage: /<command> [type]
-        aliases: [',']
-    /inset:
-        description: Inset the selection area
-        usage: /<command> [-hv] <amount>
-    snapshot:
-        description: Snapshot commands
-        usage: /<command> 
-        aliases: ['snap']
-    restore:
-        description: Restore the selection from a snapshot
-        usage: /<command> [snapshot]
-        aliases: ['/restore']
-    /:
-        description: Toggle the super pickaxe pickaxe function
-        usage: /<command> 
-        aliases: [',']
-    superpickaxe:
-        description: Select super pickaxe mode
-        usage: /<command> 
-        aliases: ['pickaxe', 'sp']
-    tool:
-        description: Select a tool to bind
-        usage: /<command> 
-    mat:
-        description: Set the brush material
-        usage: /<command> [pattern]
-        aliases: ['material', 'fill']
-    size:
-        description: Set the brush size
-        usage: /<command> [pattern]
-    mask:
-        description: Set the brush mask
-        usage: /<command> [mask]
-    none:
-        description: Turn off all superpickaxe alternate modes
-        usage: /<command> 
-    repl:
-        description: Block replacer tool
-        usage: /<command> <block>
-    cycler:
-        description: Block data cycler tool
-        usage: /<command> 
-    brush:
-        description: Brush tool
-        usage: /<command> 
-        aliases: ['br']
-    info:
-        description: Block information tool
-        usage: /<command> 
-    tree:
-        description: Tree generator tool
-        usage: /<command> [type]
-    deltree:
-        description: Floating tree remover tool
-        usage: /<command>
-    /fillr:
-        description: Fill a hole recursively
-        usage: /<command>  <block> <radius> [depth] 
-    fixlava:
-        description: Fix lava to be stationary
-        usage: /<command> <radius>
-    fixwater:
-        description: Fix water to be stationary
-        usage: /<command> <radius>
-    removeabove:
-        description: Remove blocks above your head. 
-        usage: /<command> [size] [height] 
-    removebelow:
-        description: Remove blocks below your head. 
-        usage: /<command> [size] [height] 
-    removenear:
-        description: Remove blocks near you.
-        usage: /<command> <block> [size] 
-    replacenear:
-        description: Replace nearby blocks
-        usage: /<command> <size> <from-id> <to-id> 
-    snow:
-        description: Simulates snow
-        usage: /<command> [radius]
-    thaw:
-        description: Thaws the area
-        usage: /<command> [radius]
-    ex:
-        description: Extinguish nearby fire
-        usage: /<command> [radius]
-        aliases: ['ext', 'extinguish']
-    butcher:
-        description: Kill all or nearby mobs
-        usage: /<command> [radius]
-    remove:
-        description: Remove all entities of a type
-        usage: /<command> <type> <radius>
-        aliases: ['rem', 'rement']
-    /fill:
-        description: Fill a hole
-        usage: /<command>  <block> <radius> [depth] 
-    /drain:
-        description: Drain a pool
-        usage: /<command> <radius>
+name: WorldEdit
+main: com.sk89q.worldedit.bukkit.WorldEditPlugin
+version: ${project.version}
+commands:
+    chunkinfo:
+        description: Get information about the chunk that you are inside
+        usage: /<command> 
+        permissions: 'worldedit.chunkinfo'
+    listchunks:
+        description: List chunks that your selection includes
+        usage: /<command> 
+        permissions: 'worldedit.listchunks'
+    delchunks:
+        description: Delete chunks that your selection includes
+        usage: /<command> 
+        permissions: 'worldedit.delchunks'
+    /load:
+        description: Load a schematic into your clipboard
+        usage: /<command> <filename>
+        permissions: 'worldedit.clipboard.load'
+    /save:
+        description: Save a schematic into your clipboard
+        usage: /<command> <filename>
+        permissions: 'worldedit.clipboard.save'
+    /copy:
+        description: Copy the selection to the clipboard
+        usage: /<command> 
+        permissions: 'worldedit.clipboard.copy'
+    /flip:
+        description: Flip the contents of the clipboard
+        usage: /<command> [dir]
+        permissions: 'worldedit.clipboard.flip'
+    /rotate:
+        description: Rotate the contents of the clipboard
+        usage: /<command> <angle-in-degrees>
+        permissions: 'worldedit.clipboard.rotate'
+    /cut:
+        description: Cut the selection to the clipboard
+        usage: /<command> [leave-id]
+        permissions: 'worldedit.clipboard.cut'
+    /paste:
+        description: Paste the clipboard's contents
+        usage: /<command> [-ao] 
+        permissions: 'worldedit.clipboard.paste'
+    clearclipboard:
+        description: Clear your clipboard
+        usage: /<command> 
+        permissions: 'worldedit.clipboard.clear'
+    /limit:
+        description: Modify block change limit
+        usage: /<command> <limit>
+        permissions: 'worldedit.limit'
+    we:
+        description: WorldEdit commands
+        usage: /<command> 
+        aliases: ['worldedit']
+    toggleplace:
+        description: 
+        usage: /<command> 
+    searchitem:
+        description: Search for an item
+        usage: /<command> [-bi] <query>
+        aliases: ['/l', 'search']
+    /hcyl:
+        description: Generate a hollow cylinder
+        usage: /<command> <block> <radius> [height] 
+        permissions: 'worldedit.generation.cylinder'
+    /cyl:
+        description: Generate a cylinder
+        usage: /<command> <block> <radius> [height] 
+        permissions: 'worldedit.generation.cylinder'
+    /hsphere:
+        description: Generate a hollow sphere
+        usage: /<command> <block> <radius> [raised?] 
+        permissions: 'worldedit.generation.sphere'
+    /sphere:
+        description: Generate a filled sphere
+        usage: /<command> <block> <radius> [raised?] 
+        permissions: 'worldedit.generation.sphere'
+    forestgen:
+        description: Generate a forest
+        usage: /<command> [size] [type] [density]
+        permissions: 'worldedit.generation.forest'
+    pumpkins:
+        description: Generate pumpkin patches
+        usage: /<command> [size]
+        permissions: 'worldedit.generation.pumpkins'
+    /undo:
+        description: Undoes the last action
+        usage: /<command> [times]
+        aliases: ['undo']
+        permissions: 'worldedit.history.undo'
+    /redo:
+        description: Redoes the last action (from history)
+        usage: /<command> [times]
+        aliases: ['redo']
+        permissions: 'worldedit.history.redo'
+    clearhistory:
+        description: Clear your history
+        usage: /<command> 
+        permissions: 'worldedit.history.clear'
+    unstuck:
+        description: Escape from being stuck inside a block
+        usage: /<command> 
+        permissions: 'worldedit.navigation.unstuck'
+    ascend:
+        description: Go up a floor
+        usage: /<command> 
+        permissions: 'worldedit.navigation.ascend'
+    descend:
+        description: Go down a floor
+        usage: /<command> 
+        permissions: 'worldedit.navigation.descend'
+    ceil:
+        description: Go to the celing
+        usage: /<command> [clearance]
+        permissions: 'worldedit.navigation.ceiling'
+    thru:
+        description: Passthrough walls
+        usage: /<command> 
+        permissions: 'worldedit.navigation.thru'
+    jumpto:
+        description: Teleport to a location
+        usage: /<command> 
+        permissions: 'worldedit.navigation.jumpto'
+    up:
+        description: Go upwards some distance
+        usage: /<command> <block>
+        permissions: 'worldedit.navigation.up'
+    /replace:
+        description: Replace all blocks in the selection with another
+        usage: /<command> [from-block] <to-block>
+        permissions: 'worldedit.region.replace'
+    /stack:
+        description: Repeat the contents of the selection
+        usage: /<command> [-sa] [count] [direction]
+        permissions: 'worldedit.region.stack'
+    /set:
+        description: Set all the blocks inside the selection to a block
+        usage: /<command> <block>
+        permissions: 'worldedit.region.set'
+    /overlay:
+        description: Set a block on top of blocks in the region
+        usage: /<command> <block>
+        permissions: 'worldedit.region.overlay'
+    /walls:
+        description: Build the four sides of the selection
+        usage: /<command> <block>
+        permissions: 'worldedit.region.walls'
+    /faces:
+        description: Build the walls, ceiling, and roof of a selection
+        usage: /<command> <block>
+        aliases: ['/outline']
+        permissions: 'worldedit.region.faces'
+    /smooth:
+        description: Smooth the elevation in the selection
+        usage: /<command> [iterations]
+        permissions: 'worldedit.region.smooth'
+    /move:
+        description: Move the contents of the selection
+        usage: /<command> [-s] [count] [direction] [leave-id]
+        permissions: 'worldedit.region.move'
+    /regen:
+        description: Regenerates the contents of the selection
+        usage: /<command> 
+        permissions: 'worldedit.regen'
+    cs:
+        description: Execute a CraftScript
+        usage: /<command> <filename> [args...]
+        permissions: 'worldedit.scripting.execute'
+    .s:
+        description: Execute last CraftScript
+        usage: /<command> [args...]
+        permissions: 'worldedit.scripting.execute'
+    /count:
+        description: Counts the number of a certain type of block
+        usage: /<command> <block>
+        permissions: 'worldedit.analysis.count'
+    /size:
+        description: Get information about the selection
+        usage: /<command> 
+        permissions: 'worldedit.selection.size'
+    /shift:
+        description: Shift the selection area
+        usage: /<command> <amount> [direction]
+        permissions: 'worldedit.selection.shift'
+    /chunk:
+        description: Set the selection to your current chunk
+        usage: /<command> 
+        permissions: 'worldedit.selection.chunk'
+    /expand:
+        description: Expand the selection area
+        usage: /<command> <amount> [reverse-amount] <direction>
+        permissions: 'worldedit.selection.expand'
+    /contract:
+        description: Contract the selection area
+        usage: /<command> <amount> [reverse-amount] [direction]
+        permissions: 'worldedit.selection.contract'
+    /pos1:
+        description: Set position 1
+        usage: /<command> 
+        permissions: 'worldedit.selection.pos'
+    /pos2:
+        description: Set position 2
+        usage: /<command> 
+        permissions: 'worldedit.selection.pos'
+    /hpos1:
+        description: Set position 1 to targeted block
+        usage: /<command> 
+        permissions: 'worldedit.selection.hpos'
+    /hpos2:
+        description: Set position 2 to targeted block
+        usage: /<command> 
+        permissions: 'worldedit.selection.hpos'
+    /wand:
+        description: Get the wand object
+        usage: /<command> 
+        permissions: 'worldedit.wand'
+    toggleeditwand:
+        description: Toggle functionality of the edit wand
+        usage: /<command> 
+        permissions: 'worldedit.wand.toggle'
+    /outset:
+        description: Outset the selection area
+        usage: /<command> [-hv] <amount>
+        permissions: 'worldedit.selection.outset'
+    /inset:
+        description: Inset the selection area
+        usage: /<command> [-hv] <amount>
+        permissions: 'worldedit.selection.inset'
+    /distr:
+        description: Get the distribution of blocks in the selection
+        usage: /<command> [-c] 
+        permissions: 'worldedit.analysis.distr'
+    /sel:
+        description: Choose a region selector
+        usage: /<command> [type]
+        aliases: [',']
+    snapshot:
+        description: Snapshot commands
+        usage: /<command> 
+        aliases: ['snap']
+    restore:
+        description: Restore the selection from a snapshot
+        usage: /<command> [snapshot]
+        aliases: ['/restore']
+        permissions: 'worldedit.snapshots.restore'
+    size:
+        description: Set the brush size
+        usage: /<command> [pattern]
+        permissions: 'worldedit.brush.options.size'
+    mask:
+        description: Set the brush mask
+        usage: /<command> [mask]
+        permissions: 'worldedit.brush.options.mask'
+    /:
+        description: Toggle the super pickaxe pickaxe function
+        usage: /<command> 
+        aliases: [',']
+        permissions: 'worldedit.superpickaxe'
+    superpickaxe:
+        description: Select super pickaxe mode
+        usage: /<command> 
+        aliases: ['pickaxe', 'sp']
+    tool:
+        description: Select a tool to bind
+        usage: /<command> 
+    mat:
+        description: Set the brush material
+        usage: /<command> [pattern]
+        aliases: ['material', 'fill']
+        permissions: 'worldedit.brush.options.material'
+    info:
+        description: Block information tool
+        usage: /<command> 
+        permissions: 'worldedit.tool.info'
+    none:
+        description: Turn off all superpickaxe alternate modes
+        usage: /<command> 
+    tree:
+        description: Tree generator tool
+        usage: /<command> [type]
+        permissions: 'worldedit.tool.tree'
+    repl:
+        description: Block replacer tool
+        usage: /<command> <block>
+        permissions: 'worldedit.tool.replacer'
+    cycler:
+        description: Block data cycler tool
+        usage: /<command> 
+        permissions: 'worldedit.tool.data-cycler'
+    brush:
+        description: Brush tool
+        usage: /<command> 
+        aliases: ['br']
+    deltree:
+        description: Floating tree remover tool
+        usage: /<command> 
+        permissions: 'worldedit.tool.deltree'
+    remove:
+        description: Remove all entities of a type
+        usage: /<command> <type> <radius>
+        aliases: ['rem', 'rement']
+        permissions: 'worldedit.remove'
+    /fill:
+        description: Fill a hole
+        usage: /<command>  <block> <radius> [depth] 
+        permissions: 'worldedit.fill'
+    /fillr:
+        description: Fill a hole recursively
+        usage: /<command>  <block> <radius> [depth] 
+        permissions: 'worldedit.fill.recursive'
+    /drain:
+        description: Drain a pool
+        usage: /<command> <radius>
+        permissions: 'worldedit.drain'
+    fixlava:
+        description: Fix lava to be stationary
+        usage: /<command> <radius>
+        permissions: 'worldedit.fixlava'
+    fixwater:
+        description: Fix water to be stationary
+        usage: /<command> <radius>
+        permissions: 'worldedit.fixwater'
+    removeabove:
+        description: Remove blocks above your head. 
+        usage: /<command> [size] [height] 
+        permissions: 'worldedit.removeabove'
+    removebelow:
+        description: Remove blocks below your head. 
+        usage: /<command> [size] [height] 
+        permissions: 'worldedit.removebelow'
+    removenear:
+        description: Remove blocks near you.
+        usage: /<command> <block> [size] 
+        permissions: 'worldedit.removenear'
+    replacenear:
+        description: Replace nearby blocks
+        usage: /<command> <size> <from-id> <to-id> 
+        permissions: 'worldedit.replacenear'
+    snow:
+        description: Simulates snow
+        usage: /<command> [radius]
+        permissions: 'worldedit.snow'
+    thaw:
+        description: Thaws the area
+        usage: /<command> [radius]
+        permissions: 'worldedit.thaw'
+    ex:
+        description: Extinguish nearby fire
+        usage: /<command> [radius]
+        aliases: ['ext', 'extinguish']
+        permissions: 'worldedit.extinguish'
+    butcher:
+        description: Kill all or nearby mobs
+        usage: /<command> [-p] [radius]
+        permissions: 'worldedit.butcher'