Upstream/Citizens2
1
0
Fork 0
mirror of https://github.com/CitizensDev/Citizens2.git synced 2024-11-26 12:46:04 +01:00
Code Issues Projects Releases Wiki Activity

Merge branch 'master' of github.com:aPunch/Citizens2

Browse Source
This commit is contained in:
aPunch 2012-02-08 09:35:18 -06:00
commit d511cafec4
4 changed files with 30 additions and 198 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/net/citizensnpcs/Citizens.java
View File

@ -24,7 +24,6 @@ import net.citizensnpcs.command.command.AdminCommands;
import net.citizensnpcs.command.command.HelpCommands; import net.citizensnpcs.command.command.HelpCommands;
import net.citizensnpcs.command.command.NPCCommands; import net.citizensnpcs.command.command.NPCCommands;
import net.citizensnpcs.command.exception.CommandUsageException; import net.citizensnpcs.command.exception.CommandUsageException;
import net.citizensnpcs.command.exception.MissingNestedCommandException;
import net.citizensnpcs.command.exception.NoPermissionsException; import net.citizensnpcs.command.exception.NoPermissionsException;
import net.citizensnpcs.command.exception.RequirementMissingException; import net.citizensnpcs.command.exception.RequirementMissingException;
import net.citizensnpcs.command.exception.ServerCommandException; import net.citizensnpcs.command.exception.ServerCommandException;
@ -120,8 +119,6 @@ public class Citizens extends JavaPlugin {
sender.sendMessage("You must be in-game to execute that command."); sender.sendMessage("You must be in-game to execute that command.");
} catch (NoPermissionsException ex) { } catch (NoPermissionsException ex) {
Messaging.sendError(player, "You don't have permission to execute that command."); Messaging.sendError(player, "You don't have permission to execute that command.");
} catch (MissingNestedCommandException ex) {
Messaging.sendError(player, ex.getUsage());
} catch (CommandUsageException ex) { } catch (CommandUsageException ex) {
Messaging.sendError(player, ex.getMessage()); Messaging.sendError(player, ex.getMessage());
Messaging.sendError(player, ex.getUsage()); Messaging.sendError(player, ex.getUsage());

168
src/net/citizensnpcs/command/CommandManager.java
View File

@ -23,7 +23,6 @@ import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method; import java.lang.reflect.Method;
import java.lang.reflect.Modifier; import java.lang.reflect.Modifier;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap; import java.util.HashMap;
import java.util.HashSet; import java.util.HashSet;
import java.util.List; import java.util.List;
@ -36,18 +35,15 @@ import java.util.logging.Logger;
import net.citizensnpcs.api.npc.NPC; import net.citizensnpcs.api.npc.NPC;
import net.citizensnpcs.api.npc.trait.trait.Owner; import net.citizensnpcs.api.npc.trait.trait.Owner;
import net.citizensnpcs.command.annotation.Command; import net.citizensnpcs.command.annotation.Command;
import net.citizensnpcs.command.annotation.NestedCommand;
import net.citizensnpcs.command.annotation.Requirements; import net.citizensnpcs.command.annotation.Requirements;
import net.citizensnpcs.command.annotation.ServerCommand; import net.citizensnpcs.command.annotation.ServerCommand;
import net.citizensnpcs.command.exception.CommandException; import net.citizensnpcs.command.exception.CommandException;
import net.citizensnpcs.command.exception.CommandUsageException; import net.citizensnpcs.command.exception.CommandUsageException;
import net.citizensnpcs.command.exception.MissingNestedCommandException;
import net.citizensnpcs.command.exception.NoPermissionsException; import net.citizensnpcs.command.exception.NoPermissionsException;
import net.citizensnpcs.command.exception.RequirementMissingException; import net.citizensnpcs.command.exception.RequirementMissingException;
import net.citizensnpcs.command.exception.ServerCommandException; import net.citizensnpcs.command.exception.ServerCommandException;
import net.citizensnpcs.command.exception.UnhandledCommandException; import net.citizensnpcs.command.exception.UnhandledCommandException;
import net.citizensnpcs.command.exception.WrappedCommandException; import net.citizensnpcs.command.exception.WrappedCommandException;
import net.citizensnpcs.util.Messaging;
import org.bukkit.command.ConsoleCommandSender; import org.bukkit.command.ConsoleCommandSender;
import org.bukkit.entity.Player; import org.bukkit.entity.Player;
@ -60,7 +56,7 @@ public class CommandManager {
* their respective Method. The child map has the key of the command name * their respective Method. The child map has the key of the command name
* (one for each alias) with the method. * (one for each alias) with the method.
*/ */
private final Map<Method, Map<CommandIdentifier, Method>> commands = new HashMap<Method, Map<CommandIdentifier, Method>>(); private final Map<CommandIdentifier, Method> commands = new HashMap<CommandIdentifier, Method>();
private final Map<String, List<Command>> subCommands = new HashMap<String, List<Command>>(); private final Map<String, List<Command>> subCommands = new HashMap<String, List<Command>>();
@ -85,53 +81,36 @@ public class CommandManager {
Object[] newMethodArgs = new Object[methodArgs.length + 1]; Object[] newMethodArgs = new Object[methodArgs.length + 1];
System.arraycopy(methodArgs, 0, newMethodArgs, 1, methodArgs.length); System.arraycopy(methodArgs, 0, newMethodArgs, 1, methodArgs.length);
executeMethod(null, newArgs, player, newMethodArgs, 0); executeMethod(null, newArgs, player, newMethodArgs);
} }
// Attempt to execute a command. // Attempt to execute a command.
public void execute(String[] args, Player player, Object... methodArgs) throws CommandException { public void execute(String[] args, Player player, Object... methodArgs) throws CommandException {
Object[] newMethodArgs = new Object[methodArgs.length + 1]; Object[] newMethodArgs = new Object[methodArgs.length + 1];
System.arraycopy(methodArgs, 0, newMethodArgs, 1, methodArgs.length); System.arraycopy(methodArgs, 0, newMethodArgs, 1, methodArgs.length);
executeMethod(null, args, player, newMethodArgs, 0); executeMethod(null, args, player, newMethodArgs);
} }
// Attempt to execute a command. // Attempt to execute a command.
public void executeMethod(Method parent, String[] args, Player player, Object[] methodArgs, int level) public void executeMethod(Method parent, String[] args, Player player, Object[] methodArgs) throws CommandException {
throws CommandException { String cmdName = args[0];
String cmdName = args[level]; String modifier = args.length >= 1 ? args[1] : "";
String modifier = "";
if (args.length > level + 1)
modifier = args[level + 1];
Map<CommandIdentifier, Method> map = commands.get(parent); Method method = commands.get(new CommandIdentifier(cmdName.toLowerCase(), modifier.toLowerCase()));
Method method = map.get(new CommandIdentifier(cmdName.toLowerCase(), modifier.toLowerCase()));
if (method == null) if (method == null)
method = map.get(new CommandIdentifier(cmdName.toLowerCase(), "*")); method = commands.get(new CommandIdentifier(cmdName.toLowerCase(), "*"));
if (method != null && methodArgs != null && serverCommands.get(method) == null if (method != null && methodArgs != null && serverCommands.get(method) == null
&& methodArgs[1] instanceof ConsoleCommandSender) && methodArgs[1] instanceof ConsoleCommandSender)
throw new ServerCommandException(); throw new ServerCommandException();
if (method == null) if (method == null && parent == null)
if (parent == null) throw new UnhandledCommandException();
throw new UnhandledCommandException();
else
throw new MissingNestedCommandException("Unknown command: " + cmdName, getNestedUsage(args, level - 1,
parent, player));
if (methodArgs[1] instanceof Player) if (methodArgs[1] instanceof Player && !hasPermission(method, player))
if (!hasPermission(method, player)) throw new NoPermissionsException();
throw new NoPermissionsException();
int argsCount = args.length - 1 - level; if (methodArgs[1] instanceof Player) {
if (method.isAnnotationPresent(NestedCommand.class))
if (argsCount == 0)
throw new MissingNestedCommandException("Sub-command required.", getNestedUsage(args, level, method,
player));
else
executeMethod(method, args, player, methodArgs, level + 1);
else if (methodArgs[1] instanceof Player) {
Requirements cmdRequirements = requirements.get(method); Requirements cmdRequirements = requirements.get(method);
if (cmdRequirements != null) { if (cmdRequirements != null) {
NPC npc = (NPC) methodArgs[2]; NPC npc = (NPC) methodArgs[2];
@ -141,26 +120,22 @@ public class CommandManager {
if (cmdRequirements.ownership() && npc != null if (cmdRequirements.ownership() && npc != null
&& !npc.getTrait(Owner.class).getOwner().equals(player.getName())) && !npc.getTrait(Owner.class).getOwner().equals(player.getName()))
throw new RequirementMissingException("You must be the owner of this NPC to execute that command."); throw new RequirementMissingException("You must be the owner of this NPC to execute that command.");
} else }
Messaging.debug("No annotation present.");
} }
Command cmd = method.getAnnotation(Command.class); Command cmd = method.getAnnotation(Command.class);
String[] newArgs = new String[args.length - level]; CommandContext context = new CommandContext(args);
System.arraycopy(args, level, newArgs, 0, args.length - level);
CommandContext context = new CommandContext(newArgs);
if (context.argsLength() < cmd.min()) if (context.argsLength() < cmd.min())
throw new CommandUsageException("Too few arguments.", getUsage(args, level, cmd)); throw new CommandUsageException("Too few arguments.", getUsage(args, cmd));
if (cmd.max() != -1 && context.argsLength() > cmd.max()) if (cmd.max() != -1 && context.argsLength() > cmd.max())
throw new CommandUsageException("Too many arguments.", getUsage(args, level, cmd)); throw new CommandUsageException("Too many arguments.", getUsage(args, cmd));
for (char flag : context.getFlags()) for (char flag : context.getFlags())
if (cmd.flags().indexOf(String.valueOf(flag)) == -1) if (cmd.flags().indexOf(String.valueOf(flag)) == -1)
throw new CommandUsageException("Unknown flag: " + flag, getUsage(args, level, cmd)); throw new CommandUsageException("Unknown flag: " + flag, getUsage(args, cmd));
methodArgs[0] = context; methodArgs[0] = context;
Object instance = instances.get(method); Object instance = instances.get(method);
@ -180,70 +155,24 @@ public class CommandManager {
public String[] getAllCommandModifiers(String command) { public String[] getAllCommandModifiers(String command) {
Set<String> cmds = new HashSet<String>(); Set<String> cmds = new HashSet<String>();
for (Map<CommandIdentifier, Method> enclosing : commands.values()) { for (CommandIdentifier identifier : commands.keySet()) {
for (CommandIdentifier identifier : enclosing.keySet()) { if (identifier.getCommand().equals(command)) {
if (identifier.getCommand().equals(command)) { cmds.add(identifier.getModifier());
cmds.add(identifier.getModifier());
}
} }
} }
return cmds.toArray(new String[cmds.size()]); return cmds.toArray(new String[cmds.size()]);
} }
/*
* // Get a list of command descriptions. This is only for root commands.
* public Map<CommandIdentifier, String> getCommands() { return descs; }
*/
// Get the usage string for a nested command.
private String getNestedUsage(String[] args, int level, Method method, Player player) throws CommandException {
StringBuilder command = new StringBuilder();
command.append("/");
for (int i = 0; i <= level; i++)
command.append(args[i] + " ");
Map<CommandIdentifier, Method> map = commands.get(method);
boolean found = false;
command.append("<");
Set<String> allowedCommands = new HashSet<String>();
for (Map.Entry<CommandIdentifier, Method> entry : map.entrySet()) {
Method childMethod = entry.getValue();
found = true;
if (hasPermission(childMethod, player)) {
Command childCmd = childMethod.getAnnotation(Command.class);
allowedCommands.add(childCmd.aliases()[0]);
}
}
if (allowedCommands.size() > 0)
command.append(joinString(allowedCommands, "|", 0));
else {
if (!found)
command.append("?");
else
throw new NoPermissionsException();
}
command.append(">");
return command.toString();
}
// Get the usage string for a command. // Get the usage string for a command.
private String getUsage(String[] args, int level, Command cmd) { private String getUsage(String[] args, Command cmd) {
StringBuilder command = new StringBuilder(); StringBuilder command = new StringBuilder();
command.append("/"); command.append("/");
for (int i = 0; i <= level; i++) command.append(args[0] + " ");
command.append(args[i] + " "); if (args.length > 1)
command.append(args[1] + " ");
// removed arbitrary positioning of flags. // removed arbitrary positioning of flags.
command.append(cmd.usage()); command.append(cmd.usage());
@ -256,15 +185,15 @@ public class CommandManager {
* This will check aliases as well. * This will check aliases as well.
*/ */
public boolean hasCommand(String command, String modifier) { public boolean hasCommand(String command, String modifier) {
return commands.get(null).containsKey(new CommandIdentifier(command.toLowerCase(), modifier.toLowerCase())) return commands.containsKey(new CommandIdentifier(command.toLowerCase(), modifier.toLowerCase()))
|| commands.get(null).containsKey(new CommandIdentifier(command.toLowerCase(), "*")); || commands.containsKey(new CommandIdentifier(command.toLowerCase(), "*"));
} }
public List<Command> getCommands(String command) { public List<Command> getCommands(String command) {
if (subCommands.containsKey(command)) if (subCommands.containsKey(command))
return subCommands.get(command); return subCommands.get(command);
List<Command> cmds = new ArrayList<Command>(); List<Command> cmds = new ArrayList<Command>();
for (Entry<CommandIdentifier, Method> entry : commands.get(null).entrySet()) { for (Entry<CommandIdentifier, Method> entry : commands.entrySet()) {
if (!entry.getKey().getCommand().equalsIgnoreCase(command) if (!entry.getKey().getCommand().equalsIgnoreCase(command)
|| !entry.getValue().isAnnotationPresent(Command.class)) || !entry.getValue().isAnnotationPresent(Command.class))
continue; continue;
@ -311,17 +240,6 @@ public class CommandManager {
// Register the methods of a class. // Register the methods of a class.
private void registerMethods(Class<?> clazz, Method parent, Object obj) { private void registerMethods(Class<?> clazz, Method parent, Object obj) {
Map<CommandIdentifier, Method> map;
// Make a new hash map to cache the commands for this class
// as looking up methods via reflection is fairly slow
if (commands.containsKey(parent))
map = commands.get(parent);
else {
map = new HashMap<CommandIdentifier, Method>();
commands.put(parent, map);
}
for (Method method : clazz.getMethods()) { for (Method method : clazz.getMethods()) {
if (!method.isAnnotationPresent(Command.class)) if (!method.isAnnotationPresent(Command.class))
continue; continue;
@ -333,7 +251,7 @@ public class CommandManager {
// Cache the aliases too // Cache the aliases too
for (String alias : cmd.aliases()) for (String alias : cmd.aliases())
for (String modifier : modifiers) for (String modifier : modifiers)
map.put(new CommandIdentifier(alias, modifier), method); commands.put(new CommandIdentifier(alias, modifier), method);
Requirements cmdRequirements = null; Requirements cmdRequirements = null;
if (method.getDeclaringClass().isAnnotationPresent(Requirements.class)) if (method.getDeclaringClass().isAnnotationPresent(Requirements.class))
@ -360,16 +278,6 @@ public class CommandManager {
instances.put(method, obj); instances.put(method, obj);
} }
// Look for nested commands -- if there are any, those have
// to be cached too so that they can be quickly looked
// up when processing commands
if (method.isAnnotationPresent(NestedCommand.class)) {
NestedCommand nestedCmd = method.getAnnotation(NestedCommand.class);
for (Class<?> nestedCls : nestedCmd.value())
registerMethods(nestedCls, method);
}
} }
} }
@ -379,20 +287,4 @@ public class CommandManager {
// Logger for general errors. // Logger for general errors.
private static final Logger logger = Logger.getLogger(CommandManager.class.getCanonicalName()); private static final Logger logger = Logger.getLogger(CommandManager.class.getCanonicalName());
public static String joinString(Collection<?> str, String delimiter, int initialIndex) {
if (str.size() == 0)
return "";
StringBuilder buffer = new StringBuilder();
int i = 0;
for (Object o : str) {
if (i >= initialIndex) {
if (i > 0)
buffer.append(delimiter);
buffer.append(o.toString());
}
i++;
}
return buffer.toString();
}
} }

29
src/net/citizensnpcs/command/annotation/NestedCommand.java
View File

@ -1,29 +0,0 @@
// $Id$
/*
* WorldEdit
* Copyright (C) 2010, 2011 sk89q <http://www.sk89q.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package net.citizensnpcs.command.annotation;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@Retention(RetentionPolicy.RUNTIME)
public @interface NestedCommand {
Class<?>[] value();
}

28
src/net/citizensnpcs/command/exception/MissingNestedCommandException.java
View File

@ -1,28 +0,0 @@
// $Id$
/*
* WorldEdit
* Copyright (C) 2010, 2011 sk89q <http://www.sk89q.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package net.citizensnpcs.command.exception;
public class MissingNestedCommandException extends CommandUsageException {
public MissingNestedCommandException(String message, String usage) {
super(message, usage);
}
private static final long serialVersionUID = -4382896182979285355L;
}