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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: ProcessHandler.java,v $
* $Revision: 1.3 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
import java.io.InputStream;
import java.io.File;
import java.io.FileFilter;
import java.util.ArrayList;
import java.io.PrintWriter;
import java.io.PrintStream;
import java.io.LineNumberReader;
import java.io.InputStreamReader;
import java.io.OutputStreamWriter;
/**
* Class collect information from input stream in
* background (sparate thread) and outputs it to
* some log stream. I helps to avoid buffer overflow
* when output stream has small buffer size (e.g.
* in case when handling stdout from external
* <code>Process</code>)
*
* This class is currently used by ProcesHandler
* internally only.
*/
class Pump extends Thread {
private LineNumberReader reader;
private String pref ;
private Pump thread ;
private StringBuffer buf = new StringBuffer(256);
private PrintWriter log ;
/**
* Creates Pump for specified <code>InputStream</code>.
* This Pump also synchronously output text read to
* log by prefixed lines. Constructor immediately
* starts reading in a separate thread.
*
* @param is Stream which requires permanent reading.
* @param log Writer where prefixed text lines to be output
* @param outPrefix A prefix which is printed at the
* beginning of each output line.
*/
public Pump(InputStream is, PrintWriter log, String outPrefix) {
this.pref = outPrefix == null ? "" : outPrefix ;
reader = new LineNumberReader(new InputStreamReader(is));
this.log = log ;
start() ;
}
public void run() {
try {
String line = reader.readLine() ;
while (line != null) {
log.println(pref + line);
log.flush();
buf.append(line).append('\n');
line = reader.readLine() ;
}
} catch (java.io.IOException e) {
log.println(pref + "Exception occured: " + e) ;
}
}
/**
* Returns the text collected from input stream.
*/
public String getStringBuffer() {
return buf.toString();
}
}
/**
* Class provides convenient way for running external program
* handle its standard streams, control execution and check results.
* Instance of this class must be created only for a single
* execution. If you need to execute the same command again you
* should create a new instance for this.
*/
public class ProcessHandler {
private String cmdLine;
private String[] envVars = null;
private File workDir = null;
private PrintWriter log;
private int exitValue = -1;
private boolean isFinished = false;
private boolean isStarted = false;
private String stdInBuff = "";
private Pump stdout = null ;
private Pump stderr = null ;
private PrintStream stdIn = null ;
private Process proc = null ;
/**
* Creates instance with specified external command and
* log stream where debug info is printed and output
* of external command.
*/
public ProcessHandler(String cmdLine, PrintWriter log) {
this(cmdLine, log, null, null);
}
/**
* Creates instance with specified external command.
* Debug info and output
* of external commandis printed to stdout.
*/
public ProcessHandler(String cmdLine) {
this(cmdLine, null, null, null);
}
/**
* Creates instance with specified external command which
* will be executed in the some work directory and
* log stream where debug info and output
* of external command is printed .
* The specified environment variables are set for the new process.
* If log stream is null, logging is printed to stdout.
*/
public ProcessHandler(String cmdLine, PrintWriter log,
File workDir, String[] envVars) {
this.cmdLine = cmdLine ;
this.workDir = workDir;
this.log = log;
this.cmdLine = cmdLine ;
this.envVars = envVars;
if (log == null)
this.log = new PrintWriter(new OutputStreamWriter(System.out));
else
this.log = log;
}
/**
* Creates instance with specified external command which
* will be executed in the some work directory.
* Debug info and output
* of external commandis printed to stdout.
*/
public ProcessHandler(String cmdLine, File workDir) {
this(cmdLine, null, workDir, null);
}
/**
* Executes the command and returns only when the process
* exits.
*
* @return <code>true</code> if process was successfully
* started and correcly exits (exit code doesn't affect
* to this result).
*/
public boolean executeSynchronously() {
execute() ;
return waitFor() ;
}
/**
* Executes the command immediately returns. The process
* remains in running state. Control of its state should
* be made by <code>waitFor</code> methods.
*
* @return <code>true</code> if process was successfully
* started.
*/
public boolean executeAsynchronously() {
execute() ;
return isStarted() ;
}
public void kill() {
if (!isStarted()) return;
proc.destroy();
isStarted = false;
}
protected void execute() {
if (isStarted()) {
throw new RuntimeException(
"The process handler has already been executed.") ;
}
Runtime runtime = Runtime.getRuntime() ;
try {
log.println("Starting command: " + cmdLine) ;
if (workDir != null) {
proc = runtime.exec(cmdLine, envVars, workDir) ;
} else {
proc = runtime.exec(cmdLine, envVars) ;
}
isStarted = true ;
} catch (java.io.IOException e) {
log.println("The command "+cmdLine+" can't be started: " + e);
return;
}
stdout = new Pump(proc.getInputStream(), log, "out > ");
stderr = new Pump(proc.getErrorStream(), log, "err > ");
stdIn = new PrintStream(proc.getOutputStream()) ;
flushInput() ;
}
/**
* This method is useful when the process was executed
* asynchronously. Waits for process to exit and return
* its result.
*
* @return <code>true</code> if process correctly exited
* (exit code doesn't affect to this result).
*/
public boolean waitFor() {
return waitFor(0) ;
}
/**
* This method is useful when the process was executed
* asynchronously. Waits during specified time for process
* to exit and return its status.
*
* @return <code>true</code> if process correctly exited
* (exit code doesn't affect to this result).
*/
public boolean waitFor(long timeout) {
if (isFinished()) return true ;
if (!isStarted()) return false ;
if (timeout == 0) {
try {
proc.waitFor() ;
} catch (InterruptedException e) {
log.println("The process was interrupted: " + e);
}
isFinished = true ;
try {
exitValue = proc.exitValue() ;
} catch (IllegalThreadStateException e) {}
} else {
try {
while (!isFinished && timeout > 0) {
isFinished = true ;
Thread.sleep(1000);
timeout -= 1000 ;
try {
exitValue = proc.exitValue() ;
} catch (IllegalThreadStateException e) {
isFinished = false ;
}
}
} catch (InterruptedException ex) {
log.println("The process was interrupted: " + ex);
}
}
if (!isFinished) {
proc.destroy();
}
try {
stdout.join();
stderr.join();
} catch (InterruptedException e) {}
return isFinished() ;
}
protected void flushInput() {
if (stdIn == null) return ;
synchronized(stdInBuff) {
stdIn.print(stdInBuff);
stdIn.flush();
stdInBuff = "" ;
}
}
/**
* Returns the text output by external command to stdout.
*/
public String getOutputText() {
return stdout.getStringBuffer();
}
/**
* Returns the text output by external command to stderr.
*/
public String getErrorText() {
return stderr.getStringBuffer();
}
/**
* Prints the string specified to sdtin of external
* command. '\n' is not added so if you need you
* should terminate the string with '\n'. <p>
*
* The method can also be called before the command
* starts its execution. Then the text is buffered
* and transfered to command when it will be started.
*/
public void printInputText(String str) {
stdInBuff += str ;
flushInput();
}
/**
* Returns information about was the command started or
* not.
*
* @return <code>true</code> if the external command was
* found and successfully started.
*/
public boolean isStarted() {
return isStarted ;
}
/**
* Returns the information about the final state of command
* execution.
*
* @return <code>true</code> if the command correctly starts,
* exits and was not interrupted due to timeout.
*/
public boolean isFinished() {
return isFinished ;
}
/**
* Returns exit code of the external command.
*
* @return exit code of command if it was finished,
* -1 if not.
*/
public int getExitCode() {
return exitValue ;
}
}
|