Skip to content
Navigation Menu
{{ message }}
forked from atom/atom
-
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathbuffered-process.js
More file actions
340 lines (297 loc) · 9.35 KB
/
Copy pathbuffered-process.js
File metadata and controls
340 lines (297 loc) · 9.35 KB
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
const _ = require('underscore-plus');
const ChildProcess = require('child_process');
const { Emitter } = require('event-kit');
const path = require('path');
// Extended: A wrapper which provides standard error/output line buffering for
// Node's ChildProcess.
//
// ## Examples
//
// ```js
// {BufferedProcess} = require('atom')
//
// const command = 'ps'
// const args = ['-ef']
// const stdout = (output) => console.log(output)
// const exit = (code) => console.log("ps -ef exited with #{code}")
// const process = new BufferedProcess({command, args, stdout, exit})
// ```
module.exports = class BufferedProcess {
/*
Section: Construction
*/
// Public: Runs the given command by spawning a new child process.
//
// * `options` An {Object} with the following keys:
// * `command` The {String} command to execute.
// * `args` The {Array} of arguments to pass to the command (optional).
// * `options` {Object} (optional) The options {Object} to pass to Node's
// `ChildProcess.spawn` method.
// * `stdout` {Function} (optional) The callback that receives a single
// argument which contains the standard output from the command. The
// callback is called as data is received but it's buffered to ensure only
// complete lines are passed until the source stream closes. After the
// source stream has closed all remaining data is sent in a final call.
// * `data` {String}
// * `stderr` {Function} (optional) The callback that receives a single
// argument which contains the standard error output from the command. The
// callback is called as data is received but it's buffered to ensure only
// complete lines are passed until the source stream closes. After the
// source stream has closed all remaining data is sent in a final call.
// * `data` {String}
// * `exit` {Function} (optional) The callback which receives a single
// argument containing the exit status.
// * `code` {Number}
// * `autoStart` {Boolean} (optional) Whether the command will automatically start
// when this BufferedProcess is created. Defaults to true. When set to false you
// must call the `start` method to start the process.
constructor({
command,
args,
options = {},
stdout,
stderr,
exit,
autoStart = true
} = {}) {
this.emitter = new Emitter();
this.command = command;
this.args = args;
this.options = options;
this.stdout = stdout;
this.stderr = stderr;
this.exit = exit;
if (autoStart === true) {
this.start();
}
this.killed = false;
}
start() {
if (this.started === true) return;
this.started = true;
// Related to joyent/node#2318
if (process.platform === 'win32' && this.options.shell === undefined) {
this.spawnWithEscapedWindowsArgs(this.command, this.args, this.options);
} else {
this.spawn(this.command, this.args, this.options);
}
this.handleEvents(this.stdout, this.stderr, this.exit);
}
// Windows has a bunch of special rules that node still doesn't take care of for you
spawnWithEscapedWindowsArgs(command, args, options) {
let cmdArgs = [];
// Quote all arguments and escapes inner quotes
if (args) {
cmdArgs = args
.filter(arg => arg != null)
.map(arg => {
if (this.isExplorerCommand(command) && /^\/[a-zA-Z]+,.*$/.test(arg)) {
// Don't wrap /root,C:\folder style arguments to explorer calls in
// quotes since they will not be interpreted correctly if they are
return arg;
} else {
// Escape double quotes by putting a backslash in front of them
return `"${arg.toString().replace(/"/g, '\\"')}"`;
}
});
}
// The command itself is quoted if it contains spaces, &, ^, | or # chars
cmdArgs.unshift(
/\s|&|\^|\(|\)|\||#/.test(command) ? `"${command}"` : command
);
const cmdOptions = _.clone(options);
cmdOptions.windowsVerbatimArguments = true;
this.spawn(
this.getCmdPath(),
['/s', '/d', '/c', `"${cmdArgs.join(' ')}"`],
cmdOptions
);
}
/*
Section: Event Subscription
*/
// Public: Will call your callback when an error will be raised by the process.
// Usually this is due to the command not being available or not on the PATH.
// You can call `handle()` on the object passed to your callback to indicate
// that you have handled this error.
//
// * `callback` {Function} callback
// * `errorObject` {Object}
// * `error` {Object} the error object
// * `handle` {Function} call this to indicate you have handled the error.
// The error will not be thrown if this function is called.
//
// Returns a {Disposable}
onWillThrowError(callback) {
return this.emitter.on('will-throw-error', callback);
}
/*
Section: Helper Methods
*/
// Helper method to pass data line by line.
//
// * `stream` The Stream to read from.
// * `onLines` The callback to call with each line of data.
// * `onDone` The callback to call when the stream has closed.
bufferStream(stream, onLines, onDone) {
stream.setEncoding('utf8');
let buffered = '';
stream.on('data', data => {
if (this.killed) return;
let bufferedLength = buffered.length;
buffered += data;
let lastNewlineIndex = data.lastIndexOf('\n');
if (lastNewlineIndex !== -1) {
let lineLength = lastNewlineIndex + bufferedLength + 1;
onLines(buffered.substring(0, lineLength));
buffered = buffered.substring(lineLength);
}
});
stream.on('close', () => {
if (this.killed) return;
if (buffered.length > 0) onLines(buffered);
onDone();
});
}
// Kill all child processes of the spawned cmd.exe process on Windows.
//
// This is required since killing the cmd.exe does not terminate child
// processes.
killOnWindows() {
if (!this.process) return;
const parentPid = this.process.pid;
const cmd = 'wmic';
const args = [
'process',
'where',
`(ParentProcessId=${parentPid})`,
'get',
'processid'
];
let wmicProcess;
try {
wmicProcess = ChildProcess.spawn(cmd, args);
} catch (spawnError) {
this.killProcess();
return;
}
wmicProcess.on('error', () => {}); // ignore errors
let output = '';
wmicProcess.stdout.on('data', data => {
output += data;
});
wmicProcess.stdout.on('close', () => {
for (let pid of output.split(/\s+/)) {
if (!/^\d{1,10}$/.test(pid)) continue;
pid = parseInt(pid, 10);
if (!pid || pid === parentPid) continue;
try {
process.kill(pid);
} catch (error) {}
}
this.killProcess();
});
}
killProcess() {
if (this.process) this.process.kill();
this.process = null;
}
isExplorerCommand(command) {
if (command === 'explorer.exe' || command === 'explorer') {
return true;
} else if (process.env.SystemRoot) {
return (
command === path.join(process.env.SystemRoot, 'explorer.exe') ||
command === path.join(process.env.SystemRoot, 'explorer')
);
} else {
return false;
}
}
getCmdPath() {
if (process.env.comspec) {
return process.env.comspec;
} else if (process.env.SystemRoot) {
return path.join(process.env.SystemRoot, 'System32', 'cmd.exe');
} else {
return 'cmd.exe';
}
}
// Public: Terminate the process.
kill() {
if (this.killed) return;
this.killed = true;
if (process.platform === 'win32') {
this.killOnWindows();
} else {
this.killProcess();
}
}
spawn(command, args, options) {
try {
this.process = ChildProcess.spawn(command, args, options);
} catch (spawnError) {
process.nextTick(() => this.handleError(spawnError));
}
}
handleEvents(stdout, stderr, exit) {
if (!this.process) return;
const triggerExitCallback = () => {
if (this.killed) return;
if (
stdoutClosed &&
stderrClosed &&
processExited &&
typeof exit === 'function'
) {
exit(exitCode);
}
};
let stdoutClosed = true;
let stderrClosed = true;
let processExited = true;
let exitCode = 0;
if (stdout) {
stdoutClosed = false;
this.bufferStream(this.process.stdout, stdout, () => {
stdoutClosed = true;
triggerExitCallback();
});
}
if (stderr) {
stderrClosed = false;
this.bufferStream(this.process.stderr, stderr, () => {
stderrClosed = true;
triggerExitCallback();
});
}
if (exit) {
processExited = false;
this.process.on('exit', code => {
exitCode = code;
processExited = true;
triggerExitCallback();
});
}
this.process.on('error', error => {
this.handleError(error);
});
}
handleError(error) {
let handled = false;
const handle = () => {
handled = true;
};
this.emitter.emit('will-throw-error', { error, handle });
if (error.code === 'ENOENT' && error.syscall.indexOf('spawn') === 0) {
error = new Error(
`Failed to spawn command \`${this.command}\`. Make sure \`${
this.command
}\` is installed and on your PATH`,
error.path
);
error.name = 'BufferedProcessError';
}
if (!handled) throw error;
}
};
You can’t perform that action at this time.