Documentation

James Moger

2014-04-13 a3ac802e4cd624129131b8004852d608ac2cf64c

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

@@ -30,15 +30,23 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import ro.fortsoft.pf4j.ExtensionPoint;

import com.gitblit.models.UserModel;
import com.gitblit.transport.ssh.CommandMetaData;
import com.gitblit.utils.StringUtils;
import com.gitblit.utils.cli.SubcommandHandler;
import com.google.common.base.Charsets;
import com.google.common.base.Joiner;
import com.google.common.base.Strings;
import com.google.common.collect.Maps;

public abstract class DispatchCommand extends BaseCommand {
/**
 * Parses an SSH command-line and dispatches the command to the appropriate
 * BaseCommand instance.
 *
 * @since 1.5.0
 */
public abstract class DispatchCommand extends BaseCommand implements ExtensionPoint {

   private Logger log = LoggerFactory.getLogger(getClass());

@@ -48,41 +56,142 @@
   @Argument(index = 1, multiValued = true, metaVar = "ARG")
   private List<String> args = new ArrayList<String>();

   private Set<Class<? extends BaseCommand>> commands;
   private final Set<Class<? extends BaseCommand>> commands;
   private final Map<String, DispatchCommand> dispatchers;
   private final Map<String, String> aliasToCommand;
   private final Map<String, List<String>> commandToAliases;
   private final List<BaseCommand> instantiated;
   private Map<String, Class<? extends BaseCommand>> map;
   private Map<String, BaseCommand> dispatchers;

   public DispatchCommand() {
   protected DispatchCommand() {
      commands = new HashSet<Class<? extends BaseCommand>>();
      dispatchers = Maps.newHashMap();
      aliasToCommand = Maps.newHashMap();
      commandToAliases = Maps.newHashMap();
      instantiated = new ArrayList<BaseCommand>();
   }

   public void registerDispatcher(UserModel user, Class<? extends DispatchCommand> cmd) {
      if (!cmd.isAnnotationPresent(CommandMetaData.class)) {
         throw new RuntimeException(MessageFormat.format("{0} must be annotated with {1}!", cmd.getName(),
               CommandMetaData.class.getName()));
   @Override
   public void destroy() {
      super.destroy();
      commands.clear();
      aliasToCommand.clear();
      commandToAliases.clear();
      map = null;

      for (BaseCommand command : instantiated) {
         command.destroy();
      }
      if (dispatchers == null) {
         dispatchers = Maps.newHashMap();
      instantiated.clear();

      for (DispatchCommand dispatcher : dispatchers.values()) {
         dispatcher.destroy();
      }
      dispatchers.clear();
   }

   /**
    * Setup this dispatcher. Commands and nested dispatchers are normally
    * registered within this method.
    *
    * @param user
    * @since 1.5.0
    */
   protected abstract void setup(UserModel user);

   /**
    * Register a command or a dispatcher by it's class.
    *
    * @param user
    * @param clazz
    */
   @SuppressWarnings("unchecked")
   protected final void register(UserModel user, Class<? extends BaseCommand> clazz) {
      if (DispatchCommand.class.isAssignableFrom(clazz)) {
         registerDispatcher(user, (Class<? extends DispatchCommand>) clazz);
         return;
      }

      CommandMetaData meta = cmd.getAnnotation(CommandMetaData.class);
      registerCommand(user, clazz);
   }

   /**
    * Register a command or a dispatcher instance.
    *
    * @param user
    * @param cmd
    */
   protected final void register(UserModel user, BaseCommand cmd) {
      if (cmd instanceof DispatchCommand) {
         registerDispatcher(user, (DispatchCommand) cmd);
         return;
      }
      registerCommand(user, cmd);
   }

   private void registerDispatcher(UserModel user, Class<? extends DispatchCommand> clazz) {
      try {
         DispatchCommand dispatcher = clazz.newInstance();
         registerDispatcher(user, dispatcher);
      } catch (Exception e) {
         log.error("failed to instantiate {}", clazz.getName());
      }
   }

   private void registerDispatcher(UserModel user, DispatchCommand dispatcher) {
      Class<? extends DispatchCommand> dispatcherClass = dispatcher.getClass();
      if (!dispatcherClass.isAnnotationPresent(CommandMetaData.class)) {
         throw new RuntimeException(MessageFormat.format("{0} must be annotated with {1}!", dispatcher.getName(),
               CommandMetaData.class.getName()));
      }

      CommandMetaData meta = dispatcherClass.getAnnotation(CommandMetaData.class);
      if (meta.admin() && !user.canAdmin()) {
         log.debug(MessageFormat.format("excluding admin dispatch command {0} for {1}", meta.name(), user.username));
         log.debug(MessageFormat.format("excluding admin dispatcher {0} for {1}",
               meta.name(), user.username));
         return;
      }

      try {
         DispatchCommand dispatcher = cmd.newInstance();
         dispatcher.registerCommands(user);
         dispatcher.setup(user);
         if (dispatcher.commands.isEmpty() && dispatcher.dispatchers.isEmpty()) {
            log.debug(MessageFormat.format("excluding empty dispatcher {0} for {1}",
                  meta.name(), user.username));
            return;
         }

         log.debug("registering {} dispatcher", meta.name());
         dispatchers.put(meta.name(), dispatcher);
         for (String alias : meta.aliases()) {
            aliasToCommand.put(alias, meta.name());
            if (!commandToAliases.containsKey(meta.name())) {
               commandToAliases.put(meta.name(), new ArrayList<String>());
            }
            commandToAliases.get(meta.name()).add(alias);
         }
      } catch (Exception e) {
         log.error("failed to register {} dispatcher", meta.name());
      }
   }

   protected void registerCommands(UserModel user) {
   /**
    * Registers a command as long as the user is permitted to execute it.
    *
    * @param user
    * @param clazz
    */
   private void registerCommand(UserModel user, Class<? extends BaseCommand> clazz) {
      if (!clazz.isAnnotationPresent(CommandMetaData.class)) {
         throw new RuntimeException(MessageFormat.format("{0} must be annotated with {1}!", clazz.getName(),
               CommandMetaData.class.getName()));
      }
      CommandMetaData meta = clazz.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(clazz);
   }


   /**
    * Registers a command as long as the user is permitted to execute it.
@@ -90,17 +199,18 @@
    * @param user
    * @param cmd
    */
   public void registerCommand(UserModel user, Class<? extends BaseCommand> cmd) {
      if (!cmd.isAnnotationPresent(CommandMetaData.class)) {
   private 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.getAnnotation(CommandMetaData.class);
      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);
      commands.add(cmd.getClass());
      instantiated.add(cmd);
   }

   private Map<String, Class<? extends BaseCommand>> getMap() {
@@ -108,12 +218,26 @@
         map = Maps.newHashMapWithExpectedSize(commands.size());
         for (Class<? extends BaseCommand> cmd : commands) {
            CommandMetaData meta = cmd.getAnnotation(CommandMetaData.class);
            map.put(meta.name(), cmd);
         }
         if (dispatchers != null) {
            for (Map.Entry<String, BaseCommand> entry : dispatchers.entrySet()) {
               map.put(entry.getKey(), entry.getValue().getClass());
            if (map.containsKey(meta.name()) || aliasToCommand.containsKey(meta.name())) {
               log.warn("{} already contains the \"{}\" command!", getName(), meta.name());
            } else {
               map.put(meta.name(), cmd);
            }
            for (String alias : meta.aliases()) {
               if (map.containsKey(alias) || aliasToCommand.containsKey(alias)) {
                  log.warn("{} already contains the \"{}\" command!", getName(), alias);
               } else {
                  aliasToCommand.put(alias, meta.name());
                  if (!commandToAliases.containsKey(meta.name())) {
                     commandToAliases.put(meta.name(), new ArrayList<String>());
                  }
                  commandToAliases.get(meta.name()).add(alias);
               }
            }
         }

         for (Map.Entry<String, DispatchCommand> entry : dispatchers.entrySet()) {
            map.put(entry.getKey(), entry.getValue().getClass());
         }
      }
      return map;
@@ -153,50 +277,102 @@
   }

   private BaseCommand getCommand() throws UnloggedFailure {
      if (dispatchers != null && dispatchers.containsKey(commandName)) {
         return dispatchers.get(commandName);
      Map<String, Class<? extends BaseCommand>> map = getMap();
      String name = commandName;
      if (aliasToCommand.containsKey(commandName)) {
         name = aliasToCommand.get(name);
      }
      final Class<? extends BaseCommand> c = getMap().get(commandName);
      if (dispatchers.containsKey(name)) {
         return dispatchers.get(name);
      }
      final Class<? extends BaseCommand> c = map.get(name);
      if (c == null) {
         String msg = (getName().isEmpty() ? "Gitblit" : getName()) + ": " + commandName + ": not found";
         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();
         instantiated.add(cmd);
      } catch (Exception e) {
         throw new UnloggedFailure(1, MessageFormat.format("Failed to instantiate {0} command", commandName));
      }
      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;
   }

   public String getDescription() {
      return getClass().getAnnotation(CommandMetaData.class).description();
   }

   @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();
      for (String name : m.keySet()) {
         Class<? extends BaseCommand> c = m.get(name);
         CommandMetaData meta = c.getAnnotation(CommandMetaData.class);
         if (meta != null) {
            if (meta.hidden()) {
               continue;
            }
         if (meta.hidden()) {
            continue;
         }

         maxLength = Math.max(maxLength, name.length());
         String displayName = name  + (meta.admin() ? "*" : "");
         if (commandToAliases.containsKey(meta.name())) {
            displayName = name  + (meta.admin() ? "*" : "")+ " (" + Joiner.on(',').join(commandToAliases.get(meta.name())) + ")";
         }
         displayNames.put(name, displayName);

         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 (!StringUtils.isEmpty(getName())) {
         String title = getName().toUpperCase() + ": " + getDescription();
         String b = com.gitblit.utils.StringUtils.leftPad("", title.length() + 2, '═');
         usage.append('\n');
         usage.append(b).append('\n');
         usage.append(' ').append(title).append('\n');
         usage.append(b).append('\n');
         usage.append('\n');
      }

      if (!cmds.isEmpty()) {
         usage.append("Available commands");
         if (!getName().isEmpty()) {
            usage.append(" of ");
@@ -204,17 +380,18 @@
         }
         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);
            usage.append("   ");
            usage.append(String.format(format, name, Strings.nullToEmpty(meta.description())));
            usage.append(String.format(format, displayName, Strings.nullToEmpty(meta.description())));
            usage.append("\n");
         }
         usage.append("\n");
      }

      if (!dispatchers.isEmpty()) {
      if (!dcs.isEmpty()) {
         usage.append("Available command dispatchers");
         if (!getName().isEmpty()) {
            usage.append(" of ");
@@ -222,11 +399,12 @@
         }
         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);
            usage.append("   ");
            usage.append(String.format(format, name, Strings.nullToEmpty(meta.description())));
            usage.append(String.format(format, displayName, Strings.nullToEmpty(meta.description())));
            usage.append("\n");
         }
         usage.append("\n");
@@ -240,15 +418,5 @@
      usage.append("COMMAND --help' for more information.\n");
      usage.append("\n");
      return usage.toString();
   }

   protected void provideStateTo(final BaseCommand cmd) {
      if (cmd instanceof BaseCommand) {
         cmd.setContext(ctx);
      }
      cmd.setInputStream(in);
      cmd.setOutputStream(out);
      cmd.setErrorStream(err);
      cmd.setExitCallback(exit);
   }
}