Allow command classes to manually display usage

James Moger

2014-03-21 355901d24dd400ca17a7eb8f688ba9c2e15f23ba

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

@@ -48,8 +48,13 @@

   private static final Logger log = LoggerFactory.getLogger(BaseCommand.class);

   /** Ssh context */
   protected SshCommandContext ctx;
   private static final int PRIVATE_STATUS = 1 << 30;

   public final static int STATUS_CANCEL = PRIVATE_STATUS | 1;

   public final static int STATUS_NOT_FOUND = PRIVATE_STATUS | 2;

   public final static int STATUS_NOT_ADMIN = PRIVATE_STATUS | 3;

   protected InputStream in;

@@ -60,6 +65,9 @@
   protected ExitCallback exit;

   protected ServerSession session;

   /** Ssh command context */
   private SshCommandContext ctx;

   /** Text of the command line which lead up to invoking this instance. */
   private String commandName = "";
@@ -86,6 +94,8 @@

   @Override
   public void destroy() {
      log.debug("destroying " + getClass().getName());
      session = null;
      ctx = null;
   }

@@ -96,8 +106,20 @@
   @Override
   public abstract void start(Environment env) throws IOException;

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

   public void setContext(SshCommandContext ctx) {
      this.ctx = ctx;
   }

   public SshCommandContext getContext() {
      return ctx;
   }

   @Override
@@ -194,6 +216,11 @@
      return "";
   }

   protected void showHelp() throws UnloggedFailure {
      argv = new String [] { "--help" };
      parseCommandLine();
   }

   private final class TaskThunk implements CancelableRunnable {
      private final CommandRunnable thunk;
      private final String taskName;
@@ -210,7 +237,7 @@
      public void cancel() {
         synchronized (this) {
            try {
               // onExit(/*STATUS_CANCEL*/);
               onExit(STATUS_CANCEL);
            } finally {
               ctx = null;
            }
@@ -295,18 +322,12 @@
   /**
    * Terminate this command and return a result code to the remote client.
    * <p>
    * Commands should invoke this at most once. Once invoked, the command may
    * lose access to request based resources as any callbacks previously
    * registered with {@link RequestCleanup} will fire.
    * Commands should invoke this at most once.
    *
    * @param rc
    *            exit code for the remote client.
    * @param rc exit code for the remote client.
    */
   protected void onExit(final int rc) {
      exit.onExit(rc);
      // if (cleanup != null) {
      // cleanup.run();
      // }
   }

   private int handleError(final Throwable e) {
@@ -324,16 +345,14 @@
      } else {
         final StringBuilder m = new StringBuilder();
         m.append("Internal server error");
         // if (userProvider.get().isIdentifiedUser()) {
         // final IdentifiedUser u = (IdentifiedUser) userProvider.get();
         // m.append(" (user ");
         // m.append(u.getAccount().getUserName());
         // m.append(" account ");
         // m.append(u.getAccountId());
         // m.append(")");
         // }
         // m.append(" during ");
         // m.append(contextProvider.get().getCommandLine());
         String user = ctx.getClient().getUsername();
         if (user != null) {
            m.append(" (user ");
            m.append(user);
            m.append(")");
         }
         m.append(" during ");
         m.append(ctx.getCommandLine());
         log.error(m.toString(), e);
      }