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/DispatchCommand.java | 175 +++++++++++++++++++++++++++++++++++++++++++--------------
1 files changed, 131 insertions(+), 44 deletions(-)
diff --git a/src/main/java/com/gitblit/transport/ssh/commands/DispatchCommand.java b/src/main/java/com/gitblit/transport/ssh/commands/DispatchCommand.java
index 76012a2..d17a4eb 100644
--- a/src/main/java/com/gitblit/transport/ssh/commands/DispatchCommand.java
+++ b/src/main/java/com/gitblit/transport/ssh/commands/DispatchCommand.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.IOException;
@@ -40,6 +42,12 @@
import com.google.common.base.Strings;
import com.google.common.collect.Maps;
+/**
+ * Parses an SSH command-line and dispatches the command to the appropriate
+ * BaseCommand instance.
+ *
+ * @since 1.5.0
+ */
public abstract class DispatchCommand extends BaseCommand implements ExtensionPoint {
private Logger log = LoggerFactory.getLogger(getClass());
@@ -84,31 +92,77 @@
dispatchers.clear();
}
- protected void registerDispatcher(UserModel user, Class<? extends DispatchCommand> cmd) {
+ /**
+ * Setup this dispatcher. Commands and nested dispatchers are normally
+ * registered within this method.
+ *
+ * @since 1.5.0
+ */
+ protected abstract void setup();
+
+ /**
+ * Register a command or a dispatcher by it's class.
+ *
+ * @param clazz
+ */
+ @SuppressWarnings("unchecked")
+ protected final void register(Class<? extends BaseCommand> clazz) {
+ if (DispatchCommand.class.isAssignableFrom(clazz)) {
+ registerDispatcher((Class<? extends DispatchCommand>) clazz);
+ return;
+ }
+
+ registerCommand(clazz);
+ }
+
+ /**
+ * Register a command or a dispatcher instance.
+ *
+ * @param cmd
+ */
+ protected final void register(BaseCommand cmd) {
+ if (cmd instanceof DispatchCommand) {
+ registerDispatcher((DispatchCommand) cmd);
+ return;
+ }
+ registerCommand(cmd);
+ }
+
+ private void registerDispatcher(Class<? extends DispatchCommand> clazz) {
try {
- DispatchCommand dispatcher = cmd.newInstance();
- registerDispatcher(user, dispatcher);
+ DispatchCommand dispatcher = clazz.newInstance();
+ registerDispatcher(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(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(),
CommandMetaData.class.getName()));
}
+ UserModel user = getContext().getClient().getUser();
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.setContext(getContext());
+ dispatcher.setWorkQueue(getWorkQueue());
+ dispatcher.setup();
+ 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,39 +176,38 @@
}
}
-
- 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(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);
+
+ UserModel user = getContext().getClient().getUser();
+ 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);
}
/**
* Registers a command as long as the user is permitted to execute it.
*
- * @param user
* @param cmd
*/
- protected void registerCommand(UserModel user, BaseCommand cmd) {
+ private void registerCommand(BaseCommand cmd) {
if (!cmd.getClass().isAnnotationPresent(CommandMetaData.class)) {
throw new RuntimeException(MessageFormat.format("{0} must be annotated with {1}!", cmd.getName(),
CommandMetaData.class.getName()));
}
+
+ UserModel user = getContext().getClient().getUser();
CommandMetaData meta = cmd.getClass().getAnnotation(CommandMetaData.class);
if (meta.admin() && !user.canAdmin()) {
log.debug(MessageFormat.format("excluding admin command {0} for {1}", meta.name(), user.username));
@@ -259,10 +312,31 @@
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;
+ }
+
+ public String getDescription() {
+ return getClass().getAnnotation(CommandMetaData.class).description();
+ }
+
@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 +347,36 @@
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 (!StringUtils.isEmpty(getName())) {
+ String title = getName().toUpperCase() + ": " + getDescription();
+ String b = com.gitblit.utils.StringUtils.leftPad("", title.length() + 2, '═');
+ usage.append('\n');
+ usage.append(b).append('\n');
+ usage.append(' ').append(title).append('\n');
+ usage.append(b).append('\n');
+ usage.append('\n');
+ }
+
+ if (!cmds.isEmpty()) {
usage.append("Available commands");
if (!getName().isEmpty()) {
usage.append(" of ");
@@ -297,7 +384,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 +395,7 @@
usage.append("\n");
}
- if (!dispatchers.isEmpty()) {
+ if (!dcs.isEmpty()) {
usage.append("Available command dispatchers");
if (!getName().isEmpty()) {
usage.append(" of ");
@@ -316,7 +403,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);
--
Gitblit v1.9.1