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
|
/*******************************************************************************
* Copyright (c) 2011, 2012 SAP AG
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Lazar Kirchev, SAP AG - initial API and implementation
*******************************************************************************/
package org.eclipse.equinox.console.commands;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Dictionary;
import java.util.HashSet;
import java.util.Hashtable;
import java.util.Set;
import org.apache.felix.service.command.CommandProcessor;
import org.apache.felix.service.command.CommandSession;
import org.eclipse.equinox.console.command.adapter.CustomCommandInterpreter;
import org.eclipse.osgi.framework.console.CommandInterpreter;
import org.eclipse.osgi.framework.console.CommandProvider;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
import org.osgi.framework.Constants;
import org.osgi.framework.ServiceReference;
import org.osgi.util.tracker.ServiceTracker;
import org.osgi.util.tracker.ServiceTrackerCustomizer;
/**
* This class provides help for the legacy equinox commands, which are adapted to Gogo commands.
*/
public class HelpCommand {
private BundleContext context;
private Set<CommandProvider> legacyCommandProviders;
private ServiceTracker<CommandProvider, Set<CommandProvider>> commandProvidersTracker;
private static final String COMMANDS = ".commands";
public class CommandProviderCustomizer implements ServiceTrackerCustomizer<CommandProvider, Set<CommandProvider>> {
private BundleContext context;
public CommandProviderCustomizer(BundleContext context) {
this.context = context;
}
public Set<CommandProvider> addingService(
ServiceReference<CommandProvider> reference) {
if (reference.getProperty("osgi.command.function") != null) {
// must be a gogo function already; don' track
return null;
}
CommandProvider command = context.getService(reference);
legacyCommandProviders.add(command);
context.ungetService(reference);
return legacyCommandProviders;
}
public void modifiedService(
ServiceReference<CommandProvider> reference,
Set<CommandProvider> service) {
// nothing to do
}
public void removedService(ServiceReference<CommandProvider> reference,
Set<CommandProvider> providers) {
CommandProvider provider = context.getService(reference);
providers.remove(provider);
}
}
public HelpCommand(BundleContext context) {
this.context = context;
legacyCommandProviders = new HashSet<CommandProvider>();
commandProvidersTracker = new ServiceTracker<CommandProvider, Set<CommandProvider>>(context, CommandProvider.class.getName(), new CommandProviderCustomizer(context));
commandProvidersTracker.open();
}
public void startService() {
Dictionary<String, Object> props = new Hashtable<String, Object>();
props.put(Constants.SERVICE_RANKING, new Integer(Integer.MAX_VALUE));
props.put(CommandProcessor.COMMAND_SCOPE, "equinox");
props.put(CommandProcessor.COMMAND_FUNCTION, new String[] {"help"});
context.registerService(HelpCommand.class.getName(), this, props);
}
/**
* Provides help for the available commands. Prints the names, descriptions and parameters of all registered commands.
*
* If -scope <command_scope> is passed to the command, help is printed only for the commands with the specified scope.
*
* If a command name is passed as argument to the help command, then the help
* message only for the particular command is displayed (if such is defined).
*
* @param session
* @param args
* @throws Exception
*/
public void help(final CommandSession session, String... args) throws Exception {
String command = null;
String scope = null;
if (args.length > 0) {
if (args[0].equals("-scope")) {
if (args.length < 2) {
System.out.println("Specify scope");
return;
} else {
scope = args[1];
}
} else {
command = args[0];
}
}
if (command != null) {
printLegacyCommandHelp(command);
printGogoCommandHelp(session, command);
return;
}
if ((scope == null) || "equinox".equals(scope)) {
printAllLegacyCommandsHelp();
}
printAllGogoCommandsHelp(session, scope);
}
private void printGogoCommandHelp(final CommandSession session, String command) throws Exception {
try {
session.execute("felix:help " + command);
} catch (IllegalArgumentException e) {
handleCommandNotFound();
}
}
private void printAllLegacyCommandsHelp() {
for (CommandProvider commandProvider : legacyCommandProviders) {
System.out.println(commandProvider.getHelp());
}
}
private void printAllGogoCommandsHelp(final CommandSession session, String scope) throws Exception {
@SuppressWarnings("unchecked")
Set<String> commandNames = (Set<String>) session.get(COMMANDS);
try {
for (String commandName : commandNames) {
if (scope != null && !commandName.startsWith(scope + ":")) {
continue;
}
session.execute("felix:help " + commandName);
}
} catch (IllegalArgumentException e) {
handleCommandNotFound();
}
}
private void printLegacyCommandHelp(String command) {
for (CommandProvider provider : legacyCommandProviders) {
Method[] methods = provider.getClass().getMethods();
for (Method method : methods) {
Object retval = null;
if (method.getName().equals("_" + command)) {
try {
Method helpMethod = provider.getClass().getMethod("_help", CommandInterpreter.class);
ArrayList<Object> argsList = new ArrayList<Object>();
argsList.add(command);
retval = helpMethod.invoke(provider, new CustomCommandInterpreter(argsList));
} catch (Exception e) {
System.out.println(provider.getHelp());
break;
}
if (retval != null && retval instanceof String) {
System.out.println(retval);
}
break;
}
}
}
}
private boolean checkStarted(String symbolicName) {
Bundle[] bundles = context.getBundles();
for (Bundle bundle : bundles) {
if (bundle.getSymbolicName().equals(symbolicName) && bundle.getState() == Bundle.ACTIVE) {
return true;
}
}
return false;
}
private void handleCommandNotFound() {
if (checkStarted("org.apache.felix.gogo.command")) {
System.out.println("Cannot find felix:help command");
} else {
System.out.println("Cannot find felix:help command; bundle org.apache.felix.gogo.command is not started");
}
}
}
|
