Move dispatcher creation to SshCommandFactory and revise permission checks

James Moger

2014-03-14 59e621d541746ff5f2576541abc1a201afcbc15f

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

@@ -26,10 +26,13 @@
import org.apache.sshd.server.Command;
import org.apache.sshd.server.Environment;
import org.kohsuke.args4j.Argument;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.gitblit.git.GitblitReceivePackFactory;
import com.gitblit.git.GitblitUploadPackFactory;
import com.gitblit.git.RepositoryResolver;
import com.gitblit.models.UserModel;
import com.gitblit.transport.ssh.CommandMetaData;
import com.gitblit.transport.ssh.PublicKeyAuthenticator;
import com.gitblit.transport.ssh.SshDaemonClient;
@@ -40,6 +43,8 @@
import com.google.common.collect.Sets;

public class DispatchCommand extends BaseCommand {

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

  @Argument(index = 0, required = false, metaVar = "COMMAND", handler = SubcommandHandler.class)
  private String commandName;
@@ -62,10 +67,21 @@
     root.put(name, cmd);
  }

  public void registerCommand(Class<? extends Command> cmd) {
   /**
    * Registers a command as long as the user is permitted to execute it.
    *
    * @param user
    * @param cmd
    */
   public void registerCommand(UserModel user, Class<? extends Command> cmd) {
     if (!cmd.isAnnotationPresent(CommandMetaData.class)) {
        throw new RuntimeException(MessageFormat.format("{0} must be annotated with {1}!",
              cmd.getName(), CommandMetaData.class.getName()));
         throw new RuntimeException(MessageFormat.format("{0} must be annotated with {1}!", cmd.getName(),
               CommandMetaData.class.getName()));
      }
      CommandMetaData meta = cmd.getAnnotation(CommandMetaData.class);
      if (meta.admin() && user.canAdmin()) {
         log.debug(MessageFormat.format("excluding admin command {} for {}", meta.name(), user.username));
         return;
     }
     commands.add(cmd);
  }
@@ -92,12 +108,6 @@
      }

      Command cmd = getCommand();
      if (cmd.getClass().isAnnotationPresent(CommandMetaData.class)) {
         CommandMetaData meta = cmd.getClass().getAnnotation(CommandMetaData.class);
         if (meta.admin() && !ctx.getClient().getUser().canAdmin()) {
            throw new UnloggedFailure(1, MessageFormat.format("{0} requires admin permissions", commandName));
         }
      }
      if (cmd instanceof BaseCommand) {
        BaseCommand bc = (BaseCommand) cmd;
        if (getName().isEmpty()) {
@@ -108,9 +118,7 @@
        bc.setArguments(args.toArray(new String[args.size()]));
      }

      provideBaseStateTo(cmd);
      provideGitState(cmd);
      reset();
         provideStateTo(cmd);
      //atomicCmd.set(cmd);
      cmd.start(env);

@@ -131,9 +139,7 @@
   }
   final Class<? extends Command> c = getMap().get(commandName);
      if (c == null) {
        String msg =
            (getName().isEmpty() ? "Gitblit" : getName()) + ": "
                + commandName + ": not found";
         String msg = (getName().isEmpty() ? "Gitblit" : getName()) + ": " + commandName + ": not found";
        throw new UnloggedFailure(1, msg);
      }

@@ -167,15 +173,11 @@
      final Class<? extends Command> c = m.get(name);
      CommandMetaData meta = c.getAnnotation(CommandMetaData.class);
      if (meta != null) {
        if (meta.admin() && !ctx.getClient().getUser().canAdmin()) {
           continue;
        }
        if (meta.hidden()) {
           continue;
        }
        usage.append("   ");
        usage.append(String.format(format, name,
            Strings.nullToEmpty(meta.description())));
            usage.append(String.format(format, name, Strings.nullToEmpty(meta.description())));
      }
      usage.append("\n");
    }
@@ -191,13 +193,15 @@
    return usage.toString();
  }

  // This is needed because we are not using provider or
  // clazz.newInstance() for DispatchCommand
  private void reset() {
     args = new ArrayList<String>();
   protected void provideStateTo(final Command cmd) {
      if (cmd instanceof BaseCommand) {
         ((BaseCommand) cmd).setContext(ctx);
  }
      cmd.setInputStream(in);
      cmd.setOutputStream(out);
      cmd.setErrorStream(err);
      cmd.setExitCallback(exit);

  private void provideGitState(Command cmd) {
     if (cmd instanceof BaseGitCommand) {
      BaseGitCommand a = (BaseGitCommand) cmd;
      a.setRepositoryResolver(repositoryResolver);
@@ -216,21 +220,25 @@
  }

  private RepositoryResolver<SshDaemonClient> repositoryResolver;

  public void setRepositoryResolver(RepositoryResolver<SshDaemonClient> repositoryResolver) {
     this.repositoryResolver = repositoryResolver;
  }

  private GitblitUploadPackFactory<SshDaemonClient> gitblitUploadPackFactory;

  public void setUploadPackFactory(GitblitUploadPackFactory<SshDaemonClient> gitblitUploadPackFactory) {
     this.gitblitUploadPackFactory = gitblitUploadPackFactory;
  }

  private GitblitReceivePackFactory<SshDaemonClient> gitblitReceivePackFactory;

  public void setReceivePackFactory(GitblitReceivePackFactory<SshDaemonClient> gitblitReceivePackFactory) {
     this.gitblitReceivePackFactory = gitblitReceivePackFactory;
  }

  private PublicKeyAuthenticator authenticator;

  public void setAuthenticator(PublicKeyAuthenticator authenticator) {
   this.authenticator = authenticator;
  }