This repository has been archived by the owner on Aug 11, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 28
/
CommandLineUtils.java
505 lines (452 loc) · 17.8 KB
/
CommandLineUtils.java
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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
package org.codehaus.plexus.util.cli;
/*
* Copyright The Codehaus Foundation.
*
* 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.
*/
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Method;
import java.util.Locale;
import java.util.Map;
import java.util.Properties;
import java.util.StringTokenizer;
import java.util.Vector;
import org.codehaus.plexus.util.Os;
import org.codehaus.plexus.util.StringUtils;
/**
* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl </a>
* @version $Id$
*/
public abstract class CommandLineUtils
{
public static class StringStreamConsumer
implements StreamConsumer
{
private StringBuffer string = new StringBuffer();
private String ls = System.getProperty( "line.separator" );
public void consumeLine( String line )
{
string.append( line ).append( ls );
}
public String getOutput()
{
return string.toString();
}
}
private static class ProcessHook extends Thread {
private final Process process;
private ProcessHook( Process process )
{
super("CommandlineUtils process shutdown hook");
this.process = process;
this.setContextClassLoader( null );
}
public void run()
{
process.destroy();
}
}
public static int executeCommandLine( Commandline cl, StreamConsumer systemOut, StreamConsumer systemErr )
throws CommandLineException
{
return executeCommandLine( cl, null, systemOut, systemErr, 0 );
}
public static int executeCommandLine( Commandline cl, StreamConsumer systemOut, StreamConsumer systemErr,
int timeoutInSeconds )
throws CommandLineException
{
return executeCommandLine( cl, null, systemOut, systemErr, timeoutInSeconds );
}
public static int executeCommandLine( Commandline cl, InputStream systemIn, StreamConsumer systemOut,
StreamConsumer systemErr )
throws CommandLineException
{
return executeCommandLine( cl, systemIn, systemOut, systemErr, 0 );
}
/**
* @param cl The command line to execute
* @param systemIn The input to read from, must be thread safe
* @param systemOut A consumer that receives output, must be thread safe
* @param systemErr A consumer that receives system error stream output, must be thread safe
* @param timeoutInSeconds Positive integer to specify timeout, zero and negative integers for no timeout.
* @return A return value, see {@link Process#exitValue()}
* @throws CommandLineException or CommandLineTimeOutException if time out occurs
* @noinspection ThrowableResultOfMethodCallIgnored
*/
public static int executeCommandLine( Commandline cl, InputStream systemIn, StreamConsumer systemOut,
StreamConsumer systemErr, int timeoutInSeconds )
throws CommandLineException
{
final CommandLineCallable future =
executeCommandLineAsCallable( cl, systemIn, systemOut, systemErr, timeoutInSeconds );
return future.call();
}
/**
* Immediately forks a process, returns a callable that will block until process is complete.
* @param cl The command line to execute
* @param systemIn The input to read from, must be thread safe
* @param systemOut A consumer that receives output, must be thread safe
* @param systemErr A consumer that receives system error stream output, must be thread safe
* @param timeoutInSeconds Positive integer to specify timeout, zero and negative integers for no timeout.
* @return A CommandLineCallable that provides the process return value, see {@link Process#exitValue()}. "call" must be called on
* this to be sure the forked process has terminated, no guarantees is made about
* any internal state before after the completion of the call statements
* @throws CommandLineException or CommandLineTimeOutException if time out occurs
* @noinspection ThrowableResultOfMethodCallIgnored
*/
public static CommandLineCallable executeCommandLineAsCallable( final Commandline cl, final InputStream systemIn,
final StreamConsumer systemOut,
final StreamConsumer systemErr,
final int timeoutInSeconds )
throws CommandLineException
{
if ( cl == null )
{
throw new IllegalArgumentException( "cl cannot be null." );
}
final Process p = cl.execute();
final StreamFeeder inputFeeder = systemIn != null ?
new StreamFeeder( systemIn, p.getOutputStream() ) : null;
final StreamPumper outputPumper = new StreamPumper( p.getInputStream(), systemOut );
final StreamPumper errorPumper = new StreamPumper( p.getErrorStream(), systemErr );
if ( inputFeeder != null )
{
inputFeeder.start();
}
outputPumper.start();
errorPumper.start();
final ProcessHook processHook = new ProcessHook( p );
ShutdownHookUtils.addShutDownHook( processHook );
return new CommandLineCallable()
{
public Integer call()
throws CommandLineException
{
try
{
int returnValue;
if ( timeoutInSeconds <= 0 )
{
returnValue = p.waitFor();
}
else
{
long now = System.currentTimeMillis();
long timeoutInMillis = 1000L * timeoutInSeconds;
long finish = now + timeoutInMillis;
while ( isAlive( p ) && ( System.currentTimeMillis() < finish ) )
{
Thread.sleep( 10 );
}
if ( isAlive( p ) )
{
throw new InterruptedException( "Process timeout out after " + timeoutInSeconds + " seconds" );
}
returnValue = p.exitValue();
}
waitForAllPumpers( inputFeeder, outputPumper, errorPumper );
if ( outputPumper.getException() != null )
{
throw new CommandLineException( "Error inside systemOut parser", outputPumper.getException() );
}
if ( errorPumper.getException() != null )
{
throw new CommandLineException( "Error inside systemErr parser", errorPumper.getException() );
}
return returnValue;
}
catch ( InterruptedException ex )
{
if ( inputFeeder != null )
{
inputFeeder.disable();
}
outputPumper.disable();
errorPumper.disable();
throw new CommandLineTimeOutException( "Error while executing external command, process killed.", ex );
}
finally
{
ShutdownHookUtils.removeShutdownHook( processHook );
processHook.run();
if ( inputFeeder != null )
{
inputFeeder.close();
}
outputPumper.close();
errorPumper.close();
}
}
};
}
private static void waitForAllPumpers( StreamFeeder inputFeeder, StreamPumper outputPumper,
StreamPumper errorPumper )
throws InterruptedException
{
if ( inputFeeder != null )
{
inputFeeder.waitUntilDone();
}
outputPumper.waitUntilDone();
errorPumper.waitUntilDone();
}
/**
* Gets the shell environment variables for this process. Note that the returned mapping from variable names to
* values will always be case-sensitive regardless of the platform, i.e. <code>getSystemEnvVars().get("path")</code>
* and <code>getSystemEnvVars().get("PATH")</code> will in general return different values. However, on platforms
* with case-insensitive environment variables like Windows, all variable names will be normalized to upper case.
*
* @return The shell environment variables, can be empty but never <code>null</code>.
* @throws IOException If the environment variables could not be queried from the shell.
* @see System#getenv() System.getenv() API, new in JDK 5.0, to get the same result
* <b>since 2.0.2 System#getenv() will be used if available in the current running jvm.</b>
*/
public static Properties getSystemEnvVars()
throws IOException
{
return getSystemEnvVars( !Os.isFamily( Os.FAMILY_WINDOWS ) );
}
/**
* Return the shell environment variables. If <code>caseSensitive == true</code>, then envar
* keys will all be upper-case.
*
* @param caseSensitive Whether environment variable keys should be treated case-sensitively.
* @return Properties object of (possibly modified) envar keys mapped to their values.
* @throws IOException .
* @see System#getenv() System.getenv() API, new in JDK 5.0, to get the same result
* <b>since 2.0.2 System#getenv() will be used if available in the current running jvm.</b>
*/
public static Properties getSystemEnvVars( boolean caseSensitive )
throws IOException
{
Properties envVars = new Properties();
Map<String, String> envs = System.getenv();
for ( String key : envs.keySet() )
{
String value = envs.get( key );
if ( !caseSensitive)
{
key = key.toUpperCase( Locale.ENGLISH );
}
envVars.put( key, value );
}
return envVars;
}
public static boolean isAlive( Process p )
{
if ( p == null )
{
return false;
}
try
{
p.exitValue();
return false;
}
catch ( IllegalThreadStateException e )
{
return true;
}
}
public static String[] translateCommandline( String toProcess )
throws Exception
{
if ( ( toProcess == null ) || ( toProcess.length() == 0 ) )
{
return new String[0];
}
// parse with a simple finite state machine
final int normal = 0;
final int inQuote = 1;
final int inDoubleQuote = 2;
int state = normal;
StringTokenizer tok = new StringTokenizer( toProcess, "\"\' ", true );
Vector<String> v = new Vector<String>();
StringBuilder current = new StringBuilder();
while ( tok.hasMoreTokens() )
{
String nextTok = tok.nextToken();
switch ( state )
{
case inQuote:
if ( "\'".equals( nextTok ) )
{
state = normal;
}
else
{
current.append( nextTok );
}
break;
case inDoubleQuote:
if ( "\"".equals( nextTok ) )
{
state = normal;
}
else
{
current.append( nextTok );
}
break;
default:
if ( "\'".equals( nextTok ) )
{
state = inQuote;
}
else if ( "\"".equals( nextTok ) )
{
state = inDoubleQuote;
}
else if ( " ".equals( nextTok ) )
{
if ( current.length() != 0 )
{
v.addElement( current.toString() );
current.setLength( 0 );
}
}
else
{
current.append( nextTok );
}
break;
}
}
if ( current.length() != 0 )
{
v.addElement( current.toString() );
}
if ( ( state == inQuote ) || ( state == inDoubleQuote ) )
{
throw new CommandLineException( "unbalanced quotes in " + toProcess );
}
String[] args = new String[v.size()];
v.copyInto( args );
return args;
}
/**
* <p>Put quotes around the given String if necessary.</p>
* <p>If the argument doesn't include spaces or quotes, return it
* as is. If it contains double quotes, use single quotes - else
* surround the argument by double quotes.</p>
*
* @throws CommandLineException if the argument contains both, single
* and double quotes.
* @deprecated Use {@link StringUtils#quoteAndEscape(String, char, char[], char[], char, boolean)},
* {@link StringUtils#quoteAndEscape(String, char, char[], char, boolean)}, or
* {@link StringUtils#quoteAndEscape(String, char)} instead.
*/
@SuppressWarnings( { "JavaDoc", "deprecation" } )
public static String quote( String argument )
throws CommandLineException
{
return quote( argument, false, false, true );
}
/**
* <p>Put quotes around the given String if necessary.</p>
* <p>If the argument doesn't include spaces or quotes, return it
* as is. If it contains double quotes, use single quotes - else
* surround the argument by double quotes.</p>
*
* @throws CommandLineException if the argument contains both, single
* and double quotes.
* @deprecated Use {@link StringUtils#quoteAndEscape(String, char, char[], char[], char, boolean)},
* {@link StringUtils#quoteAndEscape(String, char, char[], char, boolean)}, or
* {@link StringUtils#quoteAndEscape(String, char)} instead.
*/
@SuppressWarnings( { "JavaDoc", "UnusedDeclaration", "deprecation" } )
public static String quote( String argument, boolean wrapExistingQuotes )
throws CommandLineException
{
return quote( argument, false, false, wrapExistingQuotes );
}
/**
* @deprecated Use {@link StringUtils#quoteAndEscape(String, char, char[], char[], char, boolean)},
* {@link StringUtils#quoteAndEscape(String, char, char[], char, boolean)}, or
* {@link StringUtils#quoteAndEscape(String, char)} instead.
*/
@SuppressWarnings( { "JavaDoc" } )
public static String quote( String argument, boolean escapeSingleQuotes, boolean escapeDoubleQuotes,
boolean wrapExistingQuotes )
throws CommandLineException
{
if ( argument.contains( "\"" ) )
{
if ( argument.contains( "\'" ) )
{
throw new CommandLineException( "Can't handle single and double quotes in same argument" );
}
else
{
if ( escapeSingleQuotes )
{
return "\\\'" + argument + "\\\'";
}
else if ( wrapExistingQuotes )
{
return '\'' + argument + '\'';
}
}
}
else if ( argument.contains( "\'" ) )
{
if ( escapeDoubleQuotes )
{
return "\\\"" + argument + "\\\"";
}
else if ( wrapExistingQuotes )
{
return '\"' + argument + '\"';
}
}
else if ( argument.contains( " " ) )
{
if ( escapeDoubleQuotes )
{
return "\\\"" + argument + "\\\"";
}
else
{
return '\"' + argument + '\"';
}
}
return argument;
}
public static String toString( String[] line )
{
// empty path return empty string
if ( ( line == null ) || ( line.length == 0 ) )
{
return "";
}
// path containing one or more elements
final StringBuilder result = new StringBuilder();
for ( int i = 0; i < line.length; i++ )
{
if ( i > 0 )
{
result.append( ' ' );
}
try
{
result.append( StringUtils.quoteAndEscape( line[i], '\"' ) );
}
catch ( Exception e )
{
System.err.println( "Error quoting argument: " + e.getMessage() );
}
}
return result.toString();
}
}