From a502d96a860456ec5e8c96761db70f7cabb74751 Mon Sep 17 00:00:00 2001
From: Paul Martin <paul@paulsputer.com>
Date: Sat, 30 Apr 2016 04:19:14 -0400
Subject: [PATCH] Merge pull request #1073 from gitblit/1062-DocEditorUpdates

---
 src/main/java/com/gitblit/transport/ssh/commands/BaseCommand.java |   72 +++++++++++++++++++++++-------------
 1 files changed, 46 insertions(+), 26 deletions(-)

diff --git a/src/main/java/com/gitblit/transport/ssh/commands/BaseCommand.java b/src/main/java/com/gitblit/transport/ssh/commands/BaseCommand.java
index 6662a32..ab2756d 100644
--- a/src/main/java/com/gitblit/transport/ssh/commands/BaseCommand.java
+++ b/src/main/java/com/gitblit/transport/ssh/commands/BaseCommand.java
@@ -1,17 +1,19 @@
-// Copyright (C) 2009 The Android Open Source Project
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
+/*
+ * Copyright (C) 2009 The Android Open Source Project
+ * Copyright 2014 gitblit.com.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package com.gitblit.transport.ssh.commands;
 
 import java.io.BufferedWriter;
@@ -38,7 +40,6 @@
 import org.slf4j.LoggerFactory;
 
 import com.gitblit.Keys;
-import com.gitblit.utils.IdGenerator;
 import com.gitblit.utils.StringUtils;
 import com.gitblit.utils.WorkQueue;
 import com.gitblit.utils.WorkQueue.CancelableRunnable;
@@ -80,13 +81,10 @@
 	/** The task, as scheduled on a worker thread. */
 	private final AtomicReference<Future<?>> task;
 
-	private final WorkQueue.Executor executor;
+	private WorkQueue workQueue;
 
 	public BaseCommand() {
 		task = Atomics.newReference();
-		IdGenerator gen = new IdGenerator();
-		WorkQueue w = new WorkQueue(gen);
-		this.executor = w.getDefaultQueue();
 	}
 
 	@Override
@@ -97,6 +95,10 @@
 	@Override
 	public void destroy() {
 		log.debug("destroying " + getClass().getName());
+		Future<?> future = task.getAndSet(null);
+		if (future != null && !future.isDone()) {
+			future.cancel(true);
+		}
 		session = null;
 		ctx = null;
 	}
@@ -110,10 +112,19 @@
 
 	protected void provideStateTo(final BaseCommand cmd) {
 		cmd.setContext(ctx);
+		cmd.setWorkQueue(workQueue);
 		cmd.setInputStream(in);
 		cmd.setOutputStream(out);
 		cmd.setErrorStream(err);
 		cmd.setExitCallback(exit);
+	}
+
+	public WorkQueue getWorkQueue() {
+		return workQueue;
+	}
+
+	public void setWorkQueue(WorkQueue workQueue) {
+		this.workQueue = workQueue;
 	}
 
 	public void setContext(SshCommandContext ctx) {
@@ -222,6 +233,11 @@
 			msg.write("  ");
 			clp.printSingleLineUsage(msg, null);
 			msg.write("\n\n");
+			String txt = getUsageText();
+			if (!StringUtils.isEmpty(txt)) {
+				msg.write(txt);
+				msg.write("\n\n");
+			}
 			msg.write("ARGUMENTS & OPTIONS\n");
 			msg.write("───────────────────\n");
 			clp.printUsage(msg, null);
@@ -251,6 +267,10 @@
 		} else if (clazz.isAnnotationPresent(UsageExample.class)) {
 			return examples(clazz.getAnnotation(UsageExample.class));
 		}
+		return "";
+	}
+
+	protected String getUsageText() {
 		return "";
 	}
 
@@ -339,13 +359,13 @@
 	}
 
 	/** Runnable function which can throw an exception. */
-	public static interface CommandRunnable {
-		public void run() throws Exception;
+	public interface CommandRunnable {
+		void run() throws Exception;
 	}
 
 	/** Runnable function which can retrieve a project name related to the task */
-	public static interface RepositoryCommandRunnable extends CommandRunnable {
-		public String getRepository();
+	public interface RepositoryCommandRunnable extends CommandRunnable {
+		String getRepository();
 	}
 
 	/**
@@ -387,8 +407,8 @@
 	}
 
 	private int handleError(final Throwable e) {
-		if ((e.getClass() == IOException.class && "Pipe closed".equals(e.getMessage())) || //
-				(e.getClass() == SshException.class && "Already closed".equals(e.getMessage())) || //
+		if ((e.getClass() == IOException.class && "Pipe closed".equals(e.getMessage())) ||
+				(e.getClass() == SshException.class && "Already closed".equals(e.getMessage())) ||
 				e.getClass() == InterruptedIOException.class) {
 			// This is sshd telling us the client just dropped off while
 			// we were waiting for a read or a write to complete. Either
@@ -458,7 +478,7 @@
 	 */
 	protected void startThread(final CommandRunnable thunk) {
 		final TaskThunk tt = new TaskThunk(thunk);
-		task.set(executor.submit(tt));
+		task.set(workQueue.getDefaultQueue().submit(tt));
 	}
 
 	/** Thrown from {@link CommandRunnable#run()} with client message and code. */

--
Gitblit v1.9.1