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 | 75 +++++++++++++++++++++----------------
1 files changed, 43 insertions(+), 32 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 f8239b5..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());
@@ -88,56 +96,55 @@
* Setup this dispatcher. Commands and nested dispatchers are normally
* registered within this method.
*
- * @param user
+ * @since 1.5.0
*/
- protected abstract void setup(UserModel user);
+ protected abstract void setup();
/**
* Register a command or a dispatcher by it's class.
*
- * @param user
* @param clazz
*/
@SuppressWarnings("unchecked")
- protected final void register(UserModel user, Class<? extends BaseCommand> clazz) {
+ protected final void register(Class<? extends BaseCommand> clazz) {
if (DispatchCommand.class.isAssignableFrom(clazz)) {
- registerDispatcher(user, (Class<? extends DispatchCommand>) clazz);
+ registerDispatcher((Class<? extends DispatchCommand>) clazz);
return;
}
- registerCommand(user, clazz);
+ registerCommand(clazz);
}
/**
* Register a command or a dispatcher instance.
*
- * @param user
* @param cmd
*/
- protected final void register(UserModel user, BaseCommand cmd) {
+ protected final void register(BaseCommand cmd) {
if (cmd instanceof DispatchCommand) {
- registerDispatcher(user, (DispatchCommand) cmd);
+ registerDispatcher((DispatchCommand) cmd);
return;
}
- registerCommand(user, cmd);
+ registerCommand(cmd);
}
- private void registerDispatcher(UserModel user, Class<? extends DispatchCommand> clazz) {
+ private void registerDispatcher(Class<? extends DispatchCommand> clazz) {
try {
DispatchCommand dispatcher = clazz.newInstance();
- registerDispatcher(user, dispatcher);
+ registerDispatcher(dispatcher);
} catch (Exception e) {
log.error("failed to instantiate {}", clazz.getName());
}
}
- private 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}",
@@ -146,7 +153,9 @@
}
try {
- dispatcher.setup(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));
@@ -170,14 +179,15 @@
/**
* Registers a command as long as the user is permitted to execute it.
*
- * @param user
* @param clazz
*/
- private void registerCommand(UserModel user, Class<? extends BaseCommand> clazz) {
+ 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()));
}
+
+ 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));
@@ -189,14 +199,15 @@
/**
* Registers a command as long as the user is permitted to execute it.
*
- * @param user
* @param cmd
*/
- private 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));
--
Gitblit v1.9.1