package com.massivecraft.factions.zcore; import java.util.*; import java.util.Map.Entry; import org.bukkit.Bukkit; import org.bukkit.command.CommandSender; import org.bukkit.entity.Player; import com.massivecraft.factions.zcore.MCommand; import com.massivecraft.factions.zcore.MPlugin; import com.massivecraft.factions.zcore.util.TextUtil; public abstract class MCommand { public T p; // The sub-commands to this command public List> subCommands; // The different names this commands will react to public List aliases; public boolean allowNoSlashAccess; // Information on the args public List requiredArgs; public LinkedHashMap optionalArgs; // FIELD: Help Short // This field may be left blank and will in such case be loaded from the permissions node instead. // Thus make sure the permissions node description is an action description like "eat hamburgers" or "do admin stuff". private String helpShort; public void setHelpShort(String val) { this.helpShort = val; } public String getHelpShort() { if (this.helpShort == null) { String pdesc = p.perm.getPermissionDescription(this.permission); if (pdesc != null) { return pdesc; } return "*no short help available*"; } return this.helpShort; } public List helpLong; public CommandVisibility visibility; // Some information on permissions public boolean senderMustBePlayer; public String permission; // Information available on execution of the command public CommandSender sender; // Will always be set public Player me; // Will only be set when the sender is a player public boolean senderIsConsole; public List args; // Will contain the arguments, or and empty list if there are none. public List> commandChain; // The command chain used to execute this command public MCommand(T p) { this.p = p; this.permission = null; this.allowNoSlashAccess = false; this.subCommands = new ArrayList>(); this.aliases = new ArrayList(); this.requiredArgs = new ArrayList(); this.optionalArgs = new LinkedHashMap(); this.helpShort = null; this.helpLong = new ArrayList(); this.visibility = CommandVisibility.VISIBLE; } // The commandChain is a list of the parent command chain used to get to this command. public void execute(CommandSender sender, List args, List> commandChain) { // Set the execution-time specific variables this.sender = sender; if (sender instanceof Player) { this.me = (Player)sender; this.senderIsConsole = false; } else { this.me = null; this.senderIsConsole = true; } this.args = args; this.commandChain = commandChain; // Is there a matching sub command? if (args.size() > 0 ) { for (MCommand subCommand: this.subCommands) { if (subCommand.aliases.contains(args.get(0))) { args.remove(0); commandChain.add(this); subCommand.execute(sender, args, commandChain); return; } } } if ( ! validCall(this.sender, this.args)) { return; } perform(); } public void execute(CommandSender sender, List args) { execute(sender, args, new ArrayList>()); } // This is where the command action is performed. public abstract void perform(); // -------------------------------------------- // // Call Validation // -------------------------------------------- // /** * In this method we validate that all prerequisites to perform this command has been met. */ // TODO: There should be a boolean for silence public boolean validCall(CommandSender sender, List args) { if ( ! validSenderType(sender, true)) { return false; } if ( ! validSenderPermissions(sender, true)) { return false; } if ( ! validArgs(args, sender)) { return false; } return true; } public boolean validSenderType(CommandSender sender, boolean informSenderIfNot) { if (this.senderMustBePlayer && ! (sender instanceof Player)) { if (informSenderIfNot) { sender.sendMessage(p.txt.get("command.sender_must_me_player")); } return false; } return true; } public boolean validSenderPermissions(CommandSender sender, boolean informSenderIfNot) { if (this.permission == null) return true; return p.perm.has(sender, this.permission, informSenderIfNot); } public boolean validArgs(List args, CommandSender sender) { if (args.size() < this.requiredArgs.size()) { if (sender != null) { sender.sendMessage(p.txt.get("command.to_few_args")); sender.sendMessage(this.getUseageTemplate()); } return false; } if (args.size() > this.requiredArgs.size() + this.optionalArgs.size()) { if (sender != null) { // Get the to many string slice List theToMany = args.subList(this.requiredArgs.size() + this.optionalArgs.size(), args.size()); sender.sendMessage(String.format(p.txt.get("command.to_many_args"), TextUtil.implode(theToMany, " "))); sender.sendMessage(this.getUseageTemplate()); } return false; } return true; } public boolean validArgs(List args) { return this.validArgs(args, null); } // -------------------------------------------- // // Help and Usage information // -------------------------------------------- // public String getUseageTemplate(List> commandChain, boolean addShortHelp) { StringBuilder ret = new StringBuilder(); ret.append(p.txt.tags("")); ret.append('/'); for (MCommand mc : commandChain) { ret.append(TextUtil.implode(mc.aliases, ",")); ret.append(' '); } ret.append(TextUtil.implode(this.aliases, ",")); List args = new ArrayList(); for (String requiredArg : this.requiredArgs) { args.add("<"+requiredArg+">"); } for (Entry optionalArg : this.optionalArgs.entrySet()) { String val = optionalArg.getValue(); if (val == null) { val = ""; } else { val = "="+val; } args.add("["+optionalArg.getKey()+val+"]"); } if (args.size() > 0) { ret.append(p.txt.tags("

")); ret.append(TextUtil.implode(args, " ")); } if (addShortHelp) { ret.append(p.txt.tags(" ")); ret.append(this.helpShort); } return ret.toString(); } public String getUseageTemplate(boolean addShortHelp) { return getUseageTemplate(this.commandChain, addShortHelp); } public String getUseageTemplate() { return getUseageTemplate(false); } // -------------------------------------------- // // Message Sending Helpers // -------------------------------------------- // public void sendMessageParsed(String str, Object... args) { sender.sendMessage(p.txt.parse(str, args)); } public void sendMessage(String msg) { sender.sendMessage(msg); } public void sendMessage(List msgs) { for(String msg : msgs) { this.sendMessage(msg); } } // -------------------------------------------- // // Argument Readers // -------------------------------------------- // // Is set? ====================== public boolean argIsSet(int idx) { if (this.args.size() < idx+1) { return false; } return true; } // STRING ====================== public String argAsString(int idx, String def) { if (this.args.size() < idx+1) { return def; } return this.args.get(idx); } public String argAsString(int idx) { return this.argAsString(idx, null); } // INT ====================== public int argAsInt(int idx, int def) { String str = this.argAsString(idx); if (str == null) return def; try { int ret = Integer.parseInt(str); return ret; } catch (Exception e) { return def; } } public int argAsInt(int idx) { return this.argAsInt(idx, -1); } // Double ====================== public double argAsDouble(int idx, double def) { String str = this.argAsString(idx); if (str == null) return def; try { double ret = Double.parseDouble(str); return ret; } catch (Exception e) { return def; } } public double argAsDouble(int idx) { return this.argAsDouble(idx, -1d); } // TODO: Go through the str conversion for the other arg-readers as well. // Boolean ====================== public Boolean strAsBool(String str) { str = str.toLowerCase(); if (str.startsWith("y") || str.startsWith("t") || str.startsWith("on") || str.startsWith("+") || str.startsWith("1")) { return true; } return false; } public Boolean argAsBool(int idx, boolean def) { String str = this.argAsString(idx); if (str == null) return def; return strAsBool(str); } public Boolean argAsBool(int idx) { return this.argAsBool(idx, false); } // PLAYER ====================== public Player argAsPlayer(int idx, Player def, boolean msg) { Player ret = def; String name = this.argAsString(idx); if (name != null) { Player player = Bukkit.getServer().getPlayer(name); if (player != null) { ret = player; } } if (msg && ret == null) { this.sendMessageParsed("No player \"

%s\" could not be found.", name); } return ret; } public Player argAsPlayer(int idx, Player def) { return this.argAsPlayer(idx, def, true); } public Player argAsPlayer(int idx) { return this.argAsPlayer(idx, null); } // BEST PLAYER MATCH ====================== public Player argAsBestPlayerMatch(int idx, Player def, boolean msg) { Player ret = def; String name = this.argAsString(idx); if (name != null) { List players = Bukkit.getServer().matchPlayer(name); if (players.size() > 0) { ret = players.get(0); } } if (msg && ret == null) { this.sendMessageParsed("No player match found for \"

%s\".", name); } return ret; } public Player argAsBestPlayerMatch(int idx, Player def) { return this.argAsBestPlayerMatch(idx, def, true); } public Player argAsBestPlayerMatch(int idx) { return this.argAsPlayer(idx, null); } }