Commit | Line | Data |
---|---|---|
eb1bab5b | 1 | /********************************************************************** |
60ae41e1 | 2 | * Copyright (c) 2012, 2014 Ericsson |
ea21cd65 | 3 | * |
eb1bab5b BH |
4 | * All rights reserved. This program and the accompanying materials are |
5 | * made available under the terms of the Eclipse Public License v1.0 which | |
6 | * accompanies this distribution, and is available at | |
7 | * http://www.eclipse.org/legal/epl-v10.html | |
ea21cd65 AM |
8 | * |
9 | * Contributors: | |
eb1bab5b BH |
10 | * Patrick Tasse - Initial API and implementation |
11 | * Bernd Hufmann - Updated using Executor Framework | |
12 | **********************************************************************/ | |
8e8c0226 | 13 | package org.eclipse.linuxtools.internal.lttng2.control.ui.views.remote; |
eb1bab5b BH |
14 | |
15 | import java.io.BufferedReader; | |
16 | import java.io.IOException; | |
17 | import java.io.InputStreamReader; | |
18 | import java.util.ArrayList; | |
d6fc6e1b | 19 | import java.util.Random; |
eb1bab5b BH |
20 | import java.util.concurrent.Callable; |
21 | import java.util.concurrent.CancellationException; | |
22 | import java.util.concurrent.ExecutorService; | |
23 | import java.util.concurrent.Executors; | |
24 | import java.util.concurrent.FutureTask; | |
25 | import java.util.concurrent.TimeUnit; | |
26 | import java.util.concurrent.TimeoutException; | |
27 | ||
28 | import org.eclipse.core.commands.ExecutionException; | |
29 | import org.eclipse.core.runtime.IProgressMonitor; | |
30 | import org.eclipse.core.runtime.NullProgressMonitor; | |
8e8c0226 AM |
31 | import org.eclipse.linuxtools.internal.lttng2.control.ui.views.messages.Messages; |
32 | import org.eclipse.linuxtools.internal.lttng2.control.ui.views.preferences.ControlPreferences; | |
eb1bab5b BH |
33 | import org.eclipse.rse.services.shells.HostShellProcessAdapter; |
34 | import org.eclipse.rse.services.shells.IHostShell; | |
35 | import org.eclipse.rse.services.shells.IShellService; | |
36 | ||
37 | /** | |
eb1bab5b | 38 | * <p> |
ea21cd65 | 39 | * Implementation of remote command execution using RSE's shell service. |
eb1bab5b | 40 | * </p> |
cfdb727a | 41 | * |
dbd4432d BH |
42 | * @author Patrick Tasse |
43 | * @author Bernd Hufmann | |
eb1bab5b BH |
44 | */ |
45 | public class CommandShell implements ICommandShell { | |
46 | ||
47 | // ------------------------------------------------------------------------ | |
48 | // Constants | |
49 | // ------------------------------------------------------------------------ | |
50 | ||
d6fc6e1b | 51 | /** Sub-string to be echo'ed when running command in shell, used to indicate that the command has finished running */ |
77735e82 | 52 | public static final String DONE_MARKUP_STRING = "--RSE:donedonedone:--"; //$NON-NLS-1$ |
ea21cd65 AM |
53 | |
54 | /** Sub-string to be echoed when running a command in shell. */ | |
77735e82 | 55 | public static final String BEGIN_END_TAG = "BEGIN-END-TAG:"; //$NON-NLS-1$ |
ea21cd65 | 56 | |
cfdb727a | 57 | /** Command delimiter for shell */ |
77735e82 | 58 | public static final String CMD_DELIMITER = "\n"; //$NON-NLS-1$ |
eb1bab5b | 59 | |
cfdb727a | 60 | /** Shell "echo" command */ |
77735e82 | 61 | public static final String SHELL_ECHO_CMD = " echo "; //$NON-NLS-1$ |
ea21cd65 | 62 | |
d6fc6e1b | 63 | /** Default command separator */ |
77735e82 | 64 | public static final char CMD_SEPARATOR = ';'; |
eb1bab5b | 65 | |
eb1bab5b BH |
66 | // ------------------------------------------------------------------------ |
67 | // Attributes | |
68 | // ------------------------------------------------------------------------ | |
69 | private IRemoteSystemProxy fProxy = null; | |
70 | private IHostShell fHostShell = null; | |
d6fc6e1b BH |
71 | private BufferedReader fInputBufferReader = null; |
72 | private BufferedReader fErrorBufferReader = null; | |
ea21cd65 | 73 | private final ExecutorService fExecutor = Executors.newFixedThreadPool(1); |
eb1bab5b | 74 | private boolean fIsConnected = false; |
ea21cd65 | 75 | private final Random fRandom = new Random(System.currentTimeMillis()); |
d6fc6e1b | 76 | private int fReturnValue; |
ea21cd65 | 77 | |
eb1bab5b BH |
78 | // ------------------------------------------------------------------------ |
79 | // Constructors | |
80 | // ------------------------------------------------------------------------ | |
ea21cd65 AM |
81 | |
82 | /** | |
83 | * Create a new command shell | |
84 | * | |
85 | * @param proxy | |
86 | * The RSE proxy for this shell | |
87 | */ | |
eb1bab5b BH |
88 | public CommandShell(IRemoteSystemProxy proxy) { |
89 | fProxy = proxy; | |
90 | } | |
91 | ||
92 | // ------------------------------------------------------------------------ | |
93 | // Operations | |
94 | // ------------------------------------------------------------------------ | |
11252342 | 95 | |
eb1bab5b BH |
96 | @Override |
97 | public void connect() throws ExecutionException { | |
98 | IShellService shellService = fProxy.getShellService(); | |
99 | Process p = null; | |
100 | try { | |
a657b111 BH |
101 | String[] env = new String[0]; |
102 | ||
103 | if (fProxy.isLocal()) { | |
104 | env = shellService.getHostEnvironment(); | |
105 | } | |
106 | ||
107 | fHostShell = shellService.launchShell("", env, new NullProgressMonitor()); //$NON-NLS-1$ | |
eb1bab5b BH |
108 | p = new HostShellProcessAdapter(fHostShell); |
109 | } catch (Exception e) { | |
110 | throw new ExecutionException(Messages.TraceControl_CommandShellError, e); | |
111 | } | |
d6fc6e1b BH |
112 | fInputBufferReader = new BufferedReader(new InputStreamReader(p.getInputStream())); |
113 | fErrorBufferReader = new BufferedReader(new InputStreamReader(p.getErrorStream())); | |
eb1bab5b | 114 | fIsConnected = true; |
eb1bab5b BH |
115 | } |
116 | ||
eb1bab5b BH |
117 | @Override |
118 | public void disconnect() { | |
119 | fIsConnected = false; | |
120 | try { | |
d6fc6e1b BH |
121 | fInputBufferReader.close(); |
122 | fErrorBufferReader.close(); | |
eb1bab5b BH |
123 | } catch (IOException e) { |
124 | // ignore | |
125 | } | |
126 | } | |
127 | ||
eb1bab5b BH |
128 | @Override |
129 | public ICommandResult executeCommand(String command, IProgressMonitor monitor) throws ExecutionException { | |
130 | return executeCommand(command, monitor, true); | |
131 | } | |
132 | ||
eb1bab5b BH |
133 | @Override |
134 | public ICommandResult executeCommand(final String command, final IProgressMonitor monitor, final boolean checkReturnValue) throws ExecutionException { | |
135 | if (fIsConnected) { | |
e0838ca1 | 136 | FutureTask<CommandResult> future = new FutureTask<>(new Callable<CommandResult>() { |
eb1bab5b BH |
137 | @Override |
138 | public CommandResult call() throws IOException, CancellationException { | |
e0838ca1 | 139 | final ArrayList<String> result = new ArrayList<>(); |
6418ef54 | 140 | final ArrayList<String> errorResult = new ArrayList<>(); |
ea21cd65 | 141 | |
eb1bab5b | 142 | synchronized (fHostShell) { |
d6fc6e1b BH |
143 | // Initialize return value which will be updated in isAliasEchoResult() |
144 | fReturnValue = 0; | |
145 | ||
146 | int startAlias = fRandom.nextInt(); | |
147 | int endAlias = fRandom.nextInt(); | |
148 | fHostShell.writeToShell(formatShellCommand(command, startAlias, endAlias)); | |
ea21cd65 | 149 | |
eb1bab5b | 150 | String nextLine; |
d6fc6e1b BH |
151 | boolean isStartFound = false; |
152 | while ((nextLine = fInputBufferReader.readLine()) != null) { | |
eb1bab5b BH |
153 | |
154 | if (monitor.isCanceled()) { | |
155 | flushInput(); | |
ea21cd65 | 156 | throw new CancellationException(); |
eb1bab5b BH |
157 | } |
158 | ||
ea21cd65 | 159 | // check if line contains echoed start alias |
d6fc6e1b BH |
160 | if (isAliasEchoResult(nextLine, startAlias, true)) { |
161 | isStartFound = true; | |
162 | continue; | |
eb1bab5b | 163 | } |
eb1bab5b | 164 | |
ea21cd65 AM |
165 | // check if line contains is the end mark-up. This will retrieve also |
166 | // the return value of the actual command. | |
d6fc6e1b BH |
167 | if (isAliasEchoResult(nextLine, endAlias, false)) { |
168 | break; | |
eb1bab5b BH |
169 | } |
170 | ||
d6fc6e1b BH |
171 | // Ignore line if |
172 | // 1) start hasn't been found or | |
173 | // 2) line is an echo of the command or | |
174 | // 3) line is an echo of the end mark-up | |
175 | if (!isStartFound || | |
176 | isCommandEcho(nextLine, command) || | |
177 | nextLine.contains(getEchoResult(endAlias))) | |
178 | { | |
179 | continue; | |
eb1bab5b | 180 | } |
d6fc6e1b BH |
181 | |
182 | // Now it's time add to the result | |
183 | result.add(nextLine); | |
eb1bab5b BH |
184 | } |
185 | ||
ea21cd65 | 186 | // Read any left over output |
eb1bab5b | 187 | flushInput(); |
ea21cd65 | 188 | |
d6fc6e1b | 189 | // Read error stream output when command failed. |
ea21cd65 | 190 | if (fReturnValue != 0) { |
d6fc6e1b BH |
191 | while(fErrorBufferReader.ready()) { |
192 | if ((nextLine = fErrorBufferReader.readLine()) != null) { | |
6418ef54 | 193 | errorResult.add(nextLine); |
d6fc6e1b BH |
194 | } |
195 | } | |
1a18ada9 BH |
196 | // Workaround if error stream is not available and stderr output is written |
197 | // in standard output above. This is true for the SshTerminalShell implementation. | |
198 | if (errorResult.isEmpty()) { | |
199 | errorResult.addAll(result); | |
200 | } | |
d6fc6e1b | 201 | } |
eb1bab5b | 202 | } |
6418ef54 | 203 | return new CommandResult(fReturnValue, result.toArray(new String[result.size()]), errorResult.toArray(new String[errorResult.size()])); |
eb1bab5b BH |
204 | } |
205 | }); | |
206 | ||
207 | fExecutor.execute(future); | |
208 | ||
209 | try { | |
4bdf5f96 | 210 | return future.get(ControlPreferences.getInstance().getCommandTimeout(), TimeUnit.SECONDS); |
eb1bab5b BH |
211 | } catch (java.util.concurrent.ExecutionException ex) { |
212 | throw new ExecutionException(Messages.TraceControl_ExecutionFailure, ex); | |
213 | } catch (InterruptedException ex) { | |
214 | throw new ExecutionException(Messages.TraceControl_ExecutionCancelled, ex); | |
215 | } catch (TimeoutException ex) { | |
216 | throw new ExecutionException(Messages.TraceControl_ExecutionTimeout, ex); | |
217 | } | |
218 | } | |
219 | throw new ExecutionException(Messages.TraceControl_ShellNotConnected, null); | |
220 | } | |
cfdb727a | 221 | |
eb1bab5b BH |
222 | // ------------------------------------------------------------------------ |
223 | // Helper methods | |
224 | // ------------------------------------------------------------------------ | |
225 | /** | |
cfdb727a | 226 | * Flushes the buffer reader |
eb1bab5b BH |
227 | * @throws IOException |
228 | */ | |
229 | private void flushInput() throws IOException { | |
230 | char[] cbuf = new char[1]; | |
d6fc6e1b BH |
231 | while (fInputBufferReader.ready()) { |
232 | if (fInputBufferReader.read(cbuf, 0, 1) == -1) { | |
eb1bab5b BH |
233 | break; |
234 | } | |
235 | } | |
236 | } | |
cfdb727a | 237 | |
eb1bab5b | 238 | /** |
d6fc6e1b | 239 | * Format the command to be sent into the shell command with start and end marker strings. |
ea21cd65 | 240 | * The start marker is need to know when the actual command output starts. The end marker |
d6fc6e1b | 241 | * string is needed so we can tell that end of output has been reached. |
ea21cd65 AM |
242 | * |
243 | * @param cmd The actual command | |
d6fc6e1b BH |
244 | * @param startAlias The command alias for start marker |
245 | * @param endAlias The command alias for end marker | |
eb1bab5b BH |
246 | * @return formatted command string |
247 | */ | |
ea21cd65 | 248 | private static String formatShellCommand(String cmd, int startAlias, int endAlias) { |
cfdb727a | 249 | if (cmd == null || cmd.equals("")) { //$NON-NLS-1$ |
eb1bab5b | 250 | return cmd; |
cfdb727a | 251 | } |
eb1bab5b | 252 | StringBuffer formattedCommand = new StringBuffer(); |
ea21cd65 | 253 | // Make multi-line command. |
d6fc6e1b BH |
254 | // Wrap actual command with start marker and end marker to wrap actual command. |
255 | formattedCommand.append(getEchoCmd(startAlias)); | |
256 | formattedCommand.append(CMD_DELIMITER); | |
257 | formattedCommand.append(cmd); | |
258 | formattedCommand.append(CMD_DELIMITER); | |
259 | formattedCommand.append(getEchoCmd(endAlias)); | |
eb1bab5b BH |
260 | formattedCommand.append(CMD_DELIMITER); |
261 | return formattedCommand.toString(); | |
262 | } | |
ea21cd65 | 263 | |
d6fc6e1b BH |
264 | /** |
265 | * Creates a echo command line in the format: echo <start tag> <alias> <end tag> $? | |
ea21cd65 | 266 | * |
d6fc6e1b BH |
267 | * @param alias The command alias integer to be included in the echoed message. |
268 | * @return the echo command line | |
269 | */ | |
ea21cd65 | 270 | private static String getEchoCmd(int alias) { |
d6fc6e1b BH |
271 | return SHELL_ECHO_CMD + getEchoResult(alias) + "$?"; //$NON-NLS-1$ |
272 | } | |
273 | ||
274 | /** | |
ea21cd65 | 275 | * Creates the expected result for a given command alias: |
d6fc6e1b | 276 | * <start tag> <alias> <end tag> $? |
ea21cd65 | 277 | * |
d6fc6e1b BH |
278 | * @param alias The command alias integer to be included in the echoed message. |
279 | * @return the expected echo result | |
280 | */ | |
ea21cd65 | 281 | private static String getEchoResult(int alias) { |
d6fc6e1b BH |
282 | return BEGIN_END_TAG + String.valueOf(alias) + DONE_MARKUP_STRING; |
283 | } | |
ea21cd65 | 284 | |
d6fc6e1b BH |
285 | /** |
286 | * Verifies if given command line contains a command alias echo result. | |
ea21cd65 | 287 | * |
d6fc6e1b BH |
288 | * @param line The output line to test. |
289 | * @param alias The command alias | |
290 | * @param checkReturnValue <code>true</code> to retrieve command result (previous command) <code>false</code> | |
291 | * @return <code>true</code> if output line is a command alias echo result else <code>false</code> | |
292 | */ | |
293 | private boolean isAliasEchoResult(String line, int alias, boolean checkReturnValue) { | |
294 | String expected = getEchoResult(alias); | |
295 | if (line.startsWith(expected)) { | |
296 | if (!checkReturnValue) { | |
297 | try { | |
298 | int k = Integer.valueOf(line.substring(expected.length())); | |
299 | fReturnValue = k; | |
300 | } catch (NumberFormatException e) { | |
301 | // do nothing | |
302 | } | |
303 | } | |
304 | return true; | |
ea21cd65 AM |
305 | } |
306 | int index = line.indexOf(expected); | |
77735e82 BH |
307 | if ((index > 0) && (line.indexOf(SHELL_ECHO_CMD) == -1)) { |
308 | return true; | |
d6fc6e1b | 309 | } |
eb1bab5b | 310 | |
d6fc6e1b BH |
311 | return false; |
312 | } | |
ea21cd65 | 313 | |
d6fc6e1b | 314 | /** |
ea21cd65 AM |
315 | * Verifies if output line is an echo of the given command line. If the |
316 | * output line is longer then the maximum line lengths (e.g. for ssh), the | |
317 | * shell adds a line break character. This method takes this in | |
318 | * consideration by comparing the command line without any whitespaces. | |
319 | * | |
320 | * @param line | |
321 | * The output line to verify | |
322 | * @param cmd | |
323 | * The command executed | |
324 | * @return <code>true</code> if it's an echoed command line else | |
325 | * <code>false</code> | |
d6fc6e1b BH |
326 | */ |
327 | @SuppressWarnings("nls") | |
ea21cd65 | 328 | private static boolean isCommandEcho(String line, String cmd) { |
d6fc6e1b BH |
329 | String s1 = line.replaceAll("\\s",""); |
330 | String s2 = cmd.replaceAll("\\s",""); | |
ea21cd65 | 331 | s2 = s2.replaceAll("(\\*)", "(\\\\*)"); |
d6fc6e1b BH |
332 | String patternStr = ".*(" + s2 +")$"; |
333 | return s1.matches(patternStr); | |
334 | } | |
eb1bab5b | 335 | } |