Allow command classes to manually display usage

James Moger

2014-03-21 355901d24dd400ca17a7eb8f688ba9c2e15f23ba

 src/main/java/com/gitblit/transport/ssh/commands/DispatchCommand.java

@@ -109,6 +109,12 @@
      log.debug("registering {} dispatcher", meta.name());
      try {
         dispatcher.registerCommands(user);
         if (dispatcher.commands.isEmpty() && dispatcher.dispatchers.isEmpty()) {
            // exclude because there are no commands available to the user
            log.debug(MessageFormat.format("excluding dispatcher {0} for {1}", meta.name(), user.username));
            return;
         }

         dispatchers.put(meta.name(), dispatcher);
         for (String alias : meta.aliases()) {
            aliasToCommand.put(alias, meta.name());
@@ -144,6 +150,26 @@
      commands.add(cmd);
   }

   /**
    * Registers a command as long as the user is permitted to execute it.
    *
    * @param user
    * @param cmd
    */
   protected void registerCommand(UserModel user, BaseCommand cmd) {
      if (!cmd.getClass().isAnnotationPresent(CommandMetaData.class)) {
         throw new RuntimeException(MessageFormat.format("{0} must be annotated with {1}!", cmd.getName(),
               CommandMetaData.class.getName()));
      }
      CommandMetaData meta = cmd.getClass().getAnnotation(CommandMetaData.class);
      if (meta.admin() && !user.canAdmin()) {
         log.debug(MessageFormat.format("excluding admin command {0} for {1}", meta.name(), user.username));
         return;
      }
      commands.add(cmd.getClass());
      instantiated.add(cmd);
   }

   private Map<String, Class<? extends BaseCommand>> getMap() {
      if (map == null) {
         map = Maps.newHashMapWithExpectedSize(commands.size());
@@ -168,6 +194,7 @@
         }

         for (Map.Entry<String, DispatchCommand> entry : dispatchers.entrySet()) {
            DispatchCommand dispatcher = entry.getValue();
            map.put(entry.getKey(), entry.getValue().getClass());
         }
      }
@@ -222,6 +249,13 @@
         throw new UnloggedFailure(1, msg);
      }

      for (BaseCommand cmd : instantiated) {
         // use an already instantiated command
         if (cmd.getClass().equals(c)) {
            return cmd;
         }
      }

      BaseCommand cmd = null;
      try {
         cmd = c.newInstance();
@@ -232,10 +266,27 @@
      return cmd;
   }

   private boolean hasVisibleCommands() {
      boolean visible = false;
      for (Class<? extends BaseCommand> cmd : commands) {
         visible  |= !cmd.getAnnotation(CommandMetaData.class).hidden();
         if (visible) {
            return true;
         }
      }
      for (DispatchCommand cmd : dispatchers.values()) {
         visible |= cmd.hasVisibleCommands();
         if (visible) {
            return true;
         }
      }
      return false;
   }

   @Override
   public String usage() {
      Set<String> commands = new TreeSet<String>();
      Set<String> dispatchers = new TreeSet<String>();
      Set<String> cmds = new TreeSet<String>();
      Set<String> dcs = new TreeSet<String>();
      Map<String, String> displayNames = Maps.newHashMap();
      int maxLength = -1;
      Map<String, Class<? extends BaseCommand>> m = getMap();
@@ -254,15 +305,18 @@

         maxLength = Math.max(maxLength, displayName.length());
         if (DispatchCommand.class.isAssignableFrom(c)) {
            dispatchers.add(name);
            DispatchCommand d = dispatchers.get(name);
            if (d.hasVisibleCommands()) {
               dcs.add(name);
            }
         } else {
            commands.add(name);
            cmds.add(name);
         }
      }
      String format = "%-" + maxLength + "s   %s";

      final StringBuilder usage = new StringBuilder();
      if (!commands.isEmpty()) {
      if (!cmds.isEmpty()) {
         usage.append("Available commands");
         if (!getName().isEmpty()) {
            usage.append(" of ");
@@ -270,7 +324,7 @@
         }
         usage.append(" are:\n");
         usage.append("\n");
         for (String name : commands) {
         for (String name : cmds) {
            final Class<? extends Command> c = m.get(name);
            String displayName = displayNames.get(name);
            CommandMetaData meta = c.getAnnotation(CommandMetaData.class);
@@ -281,7 +335,7 @@
         usage.append("\n");
      }

      if (!dispatchers.isEmpty()) {
      if (!dcs.isEmpty()) {
         usage.append("Available command dispatchers");
         if (!getName().isEmpty()) {
            usage.append(" of ");
@@ -289,7 +343,7 @@
         }
         usage.append(" are:\n");
         usage.append("\n");
         for (String name : dispatchers) {
         for (String name : dcs) {
            final Class<? extends BaseCommand> c = m.get(name);
            String displayName = displayNames.get(name);
            CommandMetaData meta = c.getAnnotation(CommandMetaData.class);