1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
|
// 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.
package com.gitblit.transport.ssh.commands;
import java.io.IOException;
import java.io.StringWriter;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import org.apache.sshd.server.Command;
import org.apache.sshd.server.Environment;
import org.kohsuke.args4j.Argument;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.gitblit.models.UserModel;
import com.gitblit.utils.StringUtils;
import com.gitblit.utils.cli.SubcommandHandler;
import com.google.common.base.Charsets;
import com.google.common.base.Strings;
import com.google.common.collect.Maps;
public abstract class DispatchCommand extends BaseCommand {
private Logger log = LoggerFactory.getLogger(getClass());
@Argument(index = 0, required = false, metaVar = "COMMAND", handler = SubcommandHandler.class)
private String commandName;
@Argument(index = 1, multiValued = true, metaVar = "ARG")
private List<String> args = new ArrayList<String>();
private final Set<Class<? extends BaseCommand>> commands;
private final Map<String, DispatchCommand> dispatchers;
private final List<BaseCommand> instantiated;
private Map<String, Class<? extends BaseCommand>> map;
protected DispatchCommand() {
commands = new HashSet<Class<? extends BaseCommand>>();
dispatchers = Maps.newHashMap();
instantiated = new ArrayList<BaseCommand>();
}
@Override
public void destroy() {
super.destroy();
commands.clear();
map = null;
for (BaseCommand command : instantiated) {
command.destroy();
}
for (DispatchCommand dispatcher : dispatchers.values()) {
dispatcher.destroy();
}
}
protected 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(),
CommandMetaData.class.getName()));
}
CommandMetaData meta = cmd.getAnnotation(CommandMetaData.class);
if (meta.admin() && !user.canAdmin()) {
log.debug(MessageFormat.format("excluding admin dispatch command {0} for {1}", meta.name(), user.username));
return;
}
try {
DispatchCommand dispatcher = cmd.newInstance();
dispatcher.registerCommands(user);
dispatchers.put(meta.name(), dispatcher);
} catch (Exception e) {
log.error("failed to register {} dispatcher", meta.name());
}
}
protected abstract void registerCommands(UserModel user);
/**
* Registers a command as long as the user is permitted to execute it.
*
* @param user
* @param 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()));
}
CommandMetaData meta = cmd.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);
}
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);
}
for (Map.Entry<String, DispatchCommand> entry : dispatchers.entrySet()) {
map.put(entry.getKey(), entry.getValue().getClass());
}
}
return map;
}
@Override
public void start(Environment env) throws IOException {
try {
parseCommandLine();
if (Strings.isNullOrEmpty(commandName)) {
StringWriter msg = new StringWriter();
msg.write(usage());
throw new UnloggedFailure(1, msg.toString());
}
BaseCommand cmd = getCommand();
if (getName().isEmpty()) {
cmd.setName(commandName);
} else {
cmd.setName(getName() + " " + commandName);
}
cmd.setArguments(args.toArray(new String[args.size()]));
provideStateTo(cmd);
// atomicCmd.set(cmd);
cmd.start(env);
} catch (UnloggedFailure e) {
String msg = e.getMessage();
if (!msg.endsWith("\n")) {
msg += "\n";
}
err.write(msg.getBytes(Charsets.UTF_8));
err.flush();
exit.onExit(e.exitCode);
}
}
private BaseCommand getCommand() throws UnloggedFailure {
if (dispatchers != null && dispatchers.containsKey(commandName)) {
return dispatchers.get(commandName);
}
final Class<? extends BaseCommand> c = getMap().get(commandName);
if (c == null) {
String msg = (getName().isEmpty() ? "Gitblit" : getName()) + ": " + commandName + ": not found";
throw new UnloggedFailure(1, msg);
}
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));
}
return cmd;
}
@Override
public String usage() {
Set<String> commands = new TreeSet<String>();
Set<String> dispatchers = new TreeSet<String>();
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;
}
}
maxLength = Math.max(maxLength, name.length());
if (DispatchCommand.class.isAssignableFrom(c)) {
dispatchers.add(name);
} else {
commands.add(name);
}
}
String format = "%-" + maxLength + "s %s";
final StringBuilder usage = new StringBuilder();
if (!commands.isEmpty()) {
usage.append("Available commands");
if (!getName().isEmpty()) {
usage.append(" of ");
usage.append(getName());
}
usage.append(" are:\n");
usage.append("\n");
for (String name : commands) {
final Class<? extends Command> c = m.get(name);
CommandMetaData meta = c.getAnnotation(CommandMetaData.class);
usage.append(" ");
usage.append(String.format(format, name, Strings.nullToEmpty(meta.description())));
usage.append("\n");
}
usage.append("\n");
}
if (!dispatchers.isEmpty()) {
usage.append("Available command dispatchers");
if (!getName().isEmpty()) {
usage.append(" of ");
usage.append(getName());
}
usage.append(" are:\n");
usage.append("\n");
for (String name : dispatchers) {
final Class<? extends BaseCommand> c = m.get(name);
CommandMetaData meta = c.getAnnotation(CommandMetaData.class);
usage.append(" ");
usage.append(String.format(format, name, Strings.nullToEmpty(meta.description())));
usage.append("\n");
}
usage.append("\n");
}
usage.append("See '");
if (!StringUtils.isEmpty(getName())) {
usage.append(getName());
usage.append(' ');
}
usage.append("COMMAND --help' for more information.\n");
usage.append("\n");
return usage.toString();
}
}
|
