From 4495ff757818e2a5c2a556ab2e6a0c3d36bbbc11 Mon Sep 17 00:00:00 2001
From: David Ostrovsky <david@ostrovsky.org>
Date: Thu, 10 Apr 2014 18:58:09 -0400
Subject: [PATCH] Report identified user and command on command failure
---
src/main/java/com/gitblit/transport/ssh/commands/DispatchCommand.java | 169 ++++++++++++++++++++++++++++++++++++++++++--------------
1 files changed, 127 insertions(+), 42 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 dd581f4..76012a2 100644
--- a/src/main/java/com/gitblit/transport/ssh/commands/DispatchCommand.java
+++ b/src/main/java/com/gitblit/transport/ssh/commands/DispatchCommand.java
@@ -30,15 +30,17 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import ro.fortsoft.pf4j.ExtensionPoint;
+
import com.gitblit.models.UserModel;
-import com.gitblit.transport.ssh.CommandMetaData;
import com.gitblit.utils.StringUtils;
import com.gitblit.utils.cli.SubcommandHandler;
import com.google.common.base.Charsets;
+import com.google.common.base.Joiner;
import com.google.common.base.Strings;
import com.google.common.collect.Maps;
-public abstract class DispatchCommand extends BaseCommand {
+public abstract class DispatchCommand extends BaseCommand implements ExtensionPoint {
private Logger log = LoggerFactory.getLogger(getClass());
@@ -48,41 +50,80 @@
@Argument(index = 1, multiValued = true, metaVar = "ARG")
private List<String> args = new ArrayList<String>();
- private Set<Class<? extends BaseCommand>> commands;
+ private final Set<Class<? extends BaseCommand>> commands;
+ private final Map<String, DispatchCommand> dispatchers;
+ private final Map<String, String> aliasToCommand;
+ private final Map<String, List<String>> commandToAliases;
+ private final List<BaseCommand> instantiated;
private Map<String, Class<? extends BaseCommand>> map;
- private Map<String, BaseCommand> dispatchers;
- public DispatchCommand() {
+ protected DispatchCommand() {
commands = new HashSet<Class<? extends BaseCommand>>();
+ dispatchers = Maps.newHashMap();
+ aliasToCommand = Maps.newHashMap();
+ commandToAliases = Maps.newHashMap();
+ instantiated = new ArrayList<BaseCommand>();
}
- public void registerDispatcher(UserModel user, Class<? extends DispatchCommand> cmd) {
- if (!cmd.isAnnotationPresent(CommandMetaData.class)) {
- throw new RuntimeException(MessageFormat.format("{0} must be annotated with {1}!", cmd.getName(),
+ @Override
+ public void destroy() {
+ super.destroy();
+ commands.clear();
+ aliasToCommand.clear();
+ commandToAliases.clear();
+ map = null;
+
+ for (BaseCommand command : instantiated) {
+ command.destroy();
+ }
+ instantiated.clear();
+
+ for (DispatchCommand dispatcher : dispatchers.values()) {
+ dispatcher.destroy();
+ }
+ dispatchers.clear();
+ }
+
+ protected void registerDispatcher(UserModel user, Class<? extends DispatchCommand> cmd) {
+ try {
+ DispatchCommand dispatcher = cmd.newInstance();
+ registerDispatcher(user, dispatcher);
+ } catch (Exception e) {
+ log.error("failed to instantiate {}", cmd.getName());
+ }
+ }
+
+ protected void registerDispatcher(UserModel user, 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()));
}
- if (dispatchers == null) {
- dispatchers = Maps.newHashMap();
- }
- CommandMetaData meta = cmd.getAnnotation(CommandMetaData.class);
+ CommandMetaData meta = dispatcherClass.getAnnotation(CommandMetaData.class);
if (meta.admin() && !user.canAdmin()) {
- log.debug(MessageFormat.format("excluding admin dispatch command {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 {
- DispatchCommand dispatcher = cmd.newInstance();
dispatcher.registerCommands(user);
dispatchers.put(meta.name(), dispatcher);
+ for (String alias : meta.aliases()) {
+ aliasToCommand.put(alias, meta.name());
+ if (!commandToAliases.containsKey(meta.name())) {
+ commandToAliases.put(meta.name(), new ArrayList<String>());
+ }
+ commandToAliases.get(meta.name()).add(alias);
+ }
} catch (Exception e) {
log.error("failed to register {} dispatcher", meta.name());
}
}
- protected void registerCommands(UserModel user) {
- }
+ protected abstract void registerCommands(UserModel user);
/**
* Registers a command as long as the user is permitted to execute it.
@@ -90,7 +131,7 @@
* @param user
* @param cmd
*/
- public void registerCommand(UserModel user, Class<? extends BaseCommand> cmd) {
+ 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(),
CommandMetaData.class.getName()));
@@ -103,17 +144,51 @@
commands.add(cmd);
}
+ /**
+ * Registers a command as long as the user is permitted to execute it.
+ *
+ * @param user
+ * @param cmd
+ */
+ protected void registerCommand(UserModel user, BaseCommand cmd) {
+ if (!cmd.getClass().isAnnotationPresent(CommandMetaData.class)) {
+ throw new RuntimeException(MessageFormat.format("{0} must be annotated with {1}!", cmd.getName(),
+ CommandMetaData.class.getName()));
+ }
+ 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));
+ return;
+ }
+ commands.add(cmd.getClass());
+ instantiated.add(cmd);
+ }
+
private Map<String, Class<? extends BaseCommand>> getMap() {
if (map == null) {
map = Maps.newHashMapWithExpectedSize(commands.size());
for (Class<? extends BaseCommand> cmd : commands) {
CommandMetaData meta = cmd.getAnnotation(CommandMetaData.class);
- map.put(meta.name(), cmd);
- }
- if (dispatchers != null) {
- for (Map.Entry<String, BaseCommand> entry : dispatchers.entrySet()) {
- map.put(entry.getKey(), entry.getValue().getClass());
+ if (map.containsKey(meta.name()) || aliasToCommand.containsKey(meta.name())) {
+ log.warn("{} already contains the \"{}\" command!", getName(), meta.name());
+ } else {
+ map.put(meta.name(), cmd);
}
+ for (String alias : meta.aliases()) {
+ if (map.containsKey(alias) || aliasToCommand.containsKey(alias)) {
+ log.warn("{} already contains the \"{}\" command!", getName(), alias);
+ } else {
+ aliasToCommand.put(alias, meta.name());
+ if (!commandToAliases.containsKey(meta.name())) {
+ commandToAliases.put(meta.name(), new ArrayList<String>());
+ }
+ commandToAliases.get(meta.name()).add(alias);
+ }
+ }
+ }
+
+ for (Map.Entry<String, DispatchCommand> entry : dispatchers.entrySet()) {
+ map.put(entry.getKey(), entry.getValue().getClass());
}
}
return map;
@@ -153,18 +228,31 @@
}
private BaseCommand getCommand() throws UnloggedFailure {
- if (dispatchers != null && dispatchers.containsKey(commandName)) {
- return dispatchers.get(commandName);
+ Map<String, Class<? extends BaseCommand>> map = getMap();
+ String name = commandName;
+ if (aliasToCommand.containsKey(commandName)) {
+ name = aliasToCommand.get(name);
}
- final Class<? extends BaseCommand> c = getMap().get(commandName);
+ if (dispatchers.containsKey(name)) {
+ return dispatchers.get(name);
+ }
+ final Class<? extends BaseCommand> c = map.get(name);
if (c == null) {
String msg = (getName().isEmpty() ? "Gitblit" : getName()) + ": " + commandName + ": not found";
throw new UnloggedFailure(1, msg);
}
+ for (BaseCommand cmd : instantiated) {
+ // use an already instantiated command
+ if (cmd.getClass().equals(c)) {
+ return cmd;
+ }
+ }
+
BaseCommand cmd = null;
try {
cmd = c.newInstance();
+ instantiated.add(cmd);
} catch (Exception e) {
throw new UnloggedFailure(1, MessageFormat.format("Failed to instantiate {0} command", commandName));
}
@@ -175,18 +263,23 @@
public String usage() {
Set<String> commands = new TreeSet<String>();
Set<String> dispatchers = new TreeSet<String>();
+ Map<String, String> displayNames = Maps.newHashMap();
int maxLength = -1;
Map<String, Class<? extends BaseCommand>> m = getMap();
for (String name : m.keySet()) {
Class<? extends BaseCommand> c = m.get(name);
CommandMetaData meta = c.getAnnotation(CommandMetaData.class);
- if (meta != null) {
- if (meta.hidden()) {
- continue;
- }
+ if (meta.hidden()) {
+ continue;
}
- maxLength = Math.max(maxLength, name.length());
+ String displayName = name;
+ if (commandToAliases.containsKey(meta.name())) {
+ displayName = name + " (" + 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);
} else {
@@ -206,9 +299,10 @@
usage.append("\n");
for (String name : commands) {
final Class<? extends Command> c = m.get(name);
+ String displayName = displayNames.get(name);
CommandMetaData meta = c.getAnnotation(CommandMetaData.class);
usage.append(" ");
- usage.append(String.format(format, name, Strings.nullToEmpty(meta.description())));
+ usage.append(String.format(format, displayName, Strings.nullToEmpty(meta.description())));
usage.append("\n");
}
usage.append("\n");
@@ -224,9 +318,10 @@
usage.append("\n");
for (String name : dispatchers) {
final Class<? extends BaseCommand> c = m.get(name);
+ String displayName = displayNames.get(name);
CommandMetaData meta = c.getAnnotation(CommandMetaData.class);
usage.append(" ");
- usage.append(String.format(format, name, Strings.nullToEmpty(meta.description())));
+ usage.append(String.format(format, displayName, Strings.nullToEmpty(meta.description())));
usage.append("\n");
}
usage.append("\n");
@@ -240,15 +335,5 @@
usage.append("COMMAND --help' for more information.\n");
usage.append("\n");
return usage.toString();
- }
-
- protected void provideStateTo(final BaseCommand cmd) {
- if (cmd instanceof BaseCommand) {
- cmd.setContext(ctx);
- }
- cmd.setInputStream(in);
- cmd.setOutputStream(out);
- cmd.setErrorStream(err);
- cmd.setExitCallback(exit);
}
}
--
Gitblit v1.9.1