Preserve key index when re-adding an existing key

James Moger

2014-03-27 ab07d0d86d8b64b4f7c88b45bc81f1eec22105db

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

@@ -84,16 +84,54 @@
      dispatchers.clear();
   }

   protected void registerDispatcher(UserModel user, Class<? extends DispatchCommand> cmd) {
   /**
    * Setup this dispatcher. Commands and nested dispatchers are normally
    * registered within this method.
    *
    * @param user
    */
   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;
      }

      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 = cmd.newInstance();
         DispatchCommand dispatcher = clazz.newInstance();
         registerDispatcher(user, dispatcher);
      } catch (Exception e) {
         log.error("failed to instantiate {}", cmd.getName());
         log.error("failed to instantiate {}", clazz.getName());
      }
   }

   protected void registerDispatcher(UserModel user, DispatchCommand dispatcher) {
   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(),
@@ -102,13 +140,20 @@

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

      log.debug("registering {} dispatcher", meta.name());
      try {
         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());
@@ -122,26 +167,23 @@
      }
   }


   protected abstract void registerCommands(UserModel user);

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

   /**
@@ -150,7 +192,7 @@
    * @param user
    * @param cmd
    */
   protected void registerCommand(UserModel user, BaseCommand cmd) {
   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()));
@@ -259,10 +301,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();
@@ -273,23 +332,26 @@
            continue;
         }

         String displayName = name;
         String displayName = name  + (meta.admin() ? "*" : "");
         if (commandToAliases.containsKey(meta.name())) {
            displayName = name + " (" + Joiner.on(',').join(commandToAliases.get(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 (!cmds.isEmpty()) {
         usage.append("Available commands");
         if (!getName().isEmpty()) {
            usage.append(" of ");
@@ -297,7 +359,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);
@@ -308,7 +370,7 @@
         usage.append("\n");
      }

      if (!dispatchers.isEmpty()) {
      if (!dcs.isEmpty()) {
         usage.append("Available command dispatchers");
         if (!getName().isEmpty()) {
            usage.append(" of ");
@@ -316,7 +378,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);