From 55c7e6ed6ab4f2002f1e8f0f20ff9ada6bd5bdd9 Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Wed, 02 Jul 2014 17:41:40 -0400
Subject: [PATCH] Update to Freemarker 2.3.20
---
src/main/java/com/gitblit/transport/ssh/commands/BaseCommand.java | 132 ++++++++++++++++++++++++++++++++++---------
1 files changed, 104 insertions(+), 28 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 6a190df..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;
@@ -37,7 +39,8 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-import com.gitblit.utils.IdGenerator;
+import com.gitblit.Keys;
+import com.gitblit.utils.StringUtils;
import com.gitblit.utils.WorkQueue;
import com.gitblit.utils.WorkQueue.CancelableRunnable;
import com.gitblit.utils.cli.CmdLineParser;
@@ -78,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
@@ -95,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;
}
@@ -108,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) {
@@ -200,9 +213,44 @@
}
if (clp.wasHelpRequestedByOption()) {
+ CommandMetaData meta = getClass().getAnnotation(CommandMetaData.class);
+ String title = meta.name().toUpperCase() + ": " + meta.description();
+ String b = com.gitblit.utils.StringUtils.leftPad("", title.length() + 2, '═');
StringWriter msg = new StringWriter();
- clp.printDetailedUsage(commandName, msg);
- msg.write(usage());
+ msg.write('\n');
+ msg.write(b);
+ msg.write('\n');
+ msg.write(' ');
+ msg.write(title);
+ msg.write('\n');
+ msg.write(b);
+ msg.write("\n\n");
+ msg.write("USAGE\n");
+ msg.write("─────\n");
+ msg.write(' ');
+ msg.write(commandName);
+ msg.write('\n');
+ 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);
+ msg.write('\n');
+ String examples = usage().trim();
+ if (!StringUtils.isEmpty(examples)) {
+ msg.write('\n');
+ msg.write("EXAMPLES\n");
+ msg.write("────────\n");
+ msg.write(examples);
+ msg.write('\n');
+ }
+
throw new UnloggedFailure(1, msg.toString());
}
}
@@ -213,7 +261,35 @@
}
public String usage() {
+ Class<? extends BaseCommand> clazz = getClass();
+ if (clazz.isAnnotationPresent(UsageExamples.class)) {
+ return examples(clazz.getAnnotation(UsageExamples.class).examples());
+ } else if (clazz.isAnnotationPresent(UsageExample.class)) {
+ return examples(clazz.getAnnotation(UsageExample.class));
+ }
return "";
+ }
+
+ protected String getUsageText() {
+ return "";
+ }
+
+ protected String examples(UsageExample... examples) {
+ int sshPort = getContext().getGitblit().getSettings().getInteger(Keys.git.sshPort, 29418);
+ String username = getContext().getClient().getUsername();
+ String hostname = "localhost";
+ String ssh = String.format("ssh -l %s -p %d %s", username, sshPort, hostname);
+
+ StringBuilder sb = new StringBuilder();
+ for (UsageExample example : examples) {
+ sb.append(example.description()).append("\n\n");
+ String syntax = example.syntax();
+ syntax = syntax.replace("${ssh}", ssh);
+ syntax = syntax.replace("${username}", username);
+ syntax = syntax.replace("${cmd}", commandName);
+ sb.append(" ").append(syntax).append("\n\n");
+ }
+ return sb.toString();
}
protected void showHelp() throws UnloggedFailure {
@@ -283,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();
}
/**
@@ -331,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
@@ -402,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