1 ///<script type="text/javascript">
3 var Gio = imports.gi.Gio;
4 var GLib = imports.gi.GLib;
10 * Library to wrap GLib.spawn_async_with_pipes
14 * Spawn = import.Spawn;
17 * var output = Spawn.run({
19 * args : [ 'ls', '-l' ],
20 * env : [], // optional
22 output : function (line) { Seed.print(line); },
23 * stderr : function (line) {Seed.print("ERROR" + line); },
24 * input : function() { return 'xxx' },
33 * CRITICAL - needs this change to gir in GLib-2.0.gir g_spawn_async_with_pipes
35 <parameter name="argv" transfer-ownership="none">
36 <array c:type="gchar**">
40 <parameter name="envp" transfer-ownership="none" allow-none="1">
41 <array c:type="gchar**">
47 *<method name="read_line"
48 c:identifier="g_io_channel_read_line"
50 <return-value transfer-ownership="none">
51 <type name="IOStatus" c:type="GIOStatus"/>
54 <parameter name="str_return" transfer-ownership="full" direction="out">
55 <type name="utf8" c:type="gchar**"/>
57 <parameter name="length" transfer-ownership="none" direction="out">
58 <type name="gsize" c:type="gsize*"/>
60 <parameter name="terminator_pos" transfer-ownership="none" direction="out">
61 <type name="gsize" c:type="gsize*"/>
74 * @param cfg {Object} settings - see properties.
76 * @arg cwd {String} working directory. (defaults to home directory)
77 * @arg args {Array} arguments eg. [ 'ls', '-l' ]
78 * @arg listeners {Object} (optional) handlers for output, stderr, input
79 * stderr/output both receive output line as argument
80 * input should return any standard input
81 * finish recieves result as argument.
82 * @arg env {Array} enviroment eg. [ 'GITDIR=/home/test' ]
83 * @arg async {Boolean} (optional)return instantly, or wait for exit. (default no)
84 * @arg exceptions {Boolean} throw exception on failure (default no)
85 * @arg debug {Boolean} print out what's going on.. (default no)
93 this.listeners = this.listeners || {};
94 this.cwd = this.cwd || GLib.get_home_dir();
95 if (!this.args || !this.args.length) {
104 ctx : false, // the mainloop ctx.
113 * @property output {String} resulting output
117 * @property stderr {String} resulting output from stderr
121 * @property result {Number} execution result.
125 * @property pid {Number} pid of child process (of false if it's not running)
129 * @property in_ch {GLib.IOChannel} input io channel
133 * @property out_ch {GLib.IOChannel} output io channel
137 * @property err_ch {GLib.IOChannel} stderr io channel
143 * Run the configured command.
144 * result is applied to object properties (eg. 'output' or 'stderr')
145 * @returns {Object} self.
157 print("cd " + this.cwd +";" + this.args.join(" "));
160 GLib.spawn_async_with_pipes(this.cwd, this.args, this.env,
161 GLib.SpawnFlags.DO_NOT_REAP_CHILD + GLib.SpawnFlags.SEARCH_PATH ,
164 //print(JSON.stringify(ret));
165 this.pid = ret.child_pid;
168 print("PID: " + this.pid);
173 GLib.child_watch_add(GLib.PRIORITY_DEFAULT, this.pid, function(pid, result) {
174 _this.result = result;
176 print("child_watch_add : result: " + result);
178 _this.read(_this.out_ch);
179 _this.read(_this.err_ch);
181 GLib.spawn_close_pid(_this.pid);
187 //print("DONE TIDYUP");
188 if (_this.listeners.finish) {
189 _this.listeners.finish.call(this, _this.result);
196 GLib.spawn_close_pid(_this.pid); // hopefully kills it..
199 if (_this.in_ch) _this.in_ch.close();
200 if (_this.out_ch) _this.out_ch.close();
201 if (_this.err_ch) _this.err_ch.close();
202 // blank out channels
204 _this.err_ch = false;
205 _this.out_ch = false;
206 // rmeove listeners !! important otherwise we kill the CPU
207 if (err_src !== false) GLib.source_remove(err_src);
208 if (out_src !== false) GLib.source_remove(out_src);
215 this.in_ch = new GLib.IOChannel.unix_new(ret.standard_input);
216 this.out_ch = new GLib.IOChannel.unix_new(ret.standard_output);
217 this.err_ch = new GLib.IOChannel.unix_new(ret.standard_error);
219 // make everything non-blocking!
223 // using NONBLOCKING only works if io_add_watch
224 //returns true/false in right conditions
225 this.in_ch.set_flags (GLib.IOFlags.NONBLOCK);
226 this.out_ch.set_flags (GLib.IOFlags.NONBLOCK);
227 this.err_ch.set_flags (GLib.IOFlags.NONBLOCK);
231 // add handlers for output and stderr.
232 out_src= GLib.io_add_watch(this.out_ch, GLib.PRIORITY_DEFAULT,
233 GLib.IOCondition.OUT + GLib.IOCondition.IN + GLib.IOCondition.PRI + GLib.IOCondition.HUP + GLib.IOCondition.ERR,
236 return _this.read(_this.out_ch);
240 err_src= GLib.io_add_watch(this.err_ch, GLib.PRIORITY_DEFAULT,
241 GLib.IOCondition.ERR + GLib.IOCondition.IN + GLib.IOCondition.PRI + GLib.IOCondition.OUT + GLib.IOCondition.HUP,
244 return _this.read(_this.err_ch);
251 if (this.pid !== false) {
252 // child can exit before we get this far..
253 if (this.listeners.input) {
254 print("Trying to call listeners");
256 this.write(this.listeners.input.call(this));
257 // this probably needs to be a bit smarter...
258 //but... let's close input now..
274 // async - if running - return..
275 if (this.async && this.pid) {
280 // start mainloop if not async..
282 if (this.pid !== false) {
284 print("starting main loop");
287 this.ctx = new GLib.MainLoop.c_new (null, false);
288 this.ctx.run(false); // wait fore exit?
290 //print("main_loop done!");
292 tidyup(); // tidyup get's called in main loop.
295 if (this.exceptions && this.result != 0) {
296 this.toString = function() { return this.stderr; };
297 throw this; // we throw self...
300 // finally throw, or return self..
306 * write to stdin of process
307 * @arg str {String} string to write to stdin of process
308 * @returns GLib.IOStatus (0 == error, 1= NORMAL)
310 write : function(str) // write a line to
313 return 0; // input is closed
315 //print("write: " + str);
316 // NEEDS GIR FIX! for return value.. let's ignore for the time being..
318 //var res = this.in_ch.write_chars(str, str.length, ret);
319 var res = this.in_ch.write_chars(str, str.length);
321 //print("write_char retunred:" + JSON.stringify(res) + ' ' +JSON.stringify(ret) );
323 if (res != GLib.IOStatus.NORMAL) {
324 throw "Write failed";
332 * read from pipe and call appropriate listerner and add to output or stderr string.
333 * @arg giochannel to read from.
338 var prop = ch == this.out_ch ? 'output' : 'stderr';
339 // print("prop: " + prop);
343 //print(JSON.stringify(ch, null,4));
347 var status = ch.read_line( x);
348 // print('status: ' +JSON.stringify(status));
349 // print(JSON.stringify(x));
351 case GLib.IOStatus.NORMAL:
354 if (this.listeners[prop]) {
355 this.listeners[prop].call(this, x.str_return);
357 _this[prop] += x.str_return;
359 print(prop + ':' + x.str_return.replace(/\n/, ''));
363 if (imports.gi.Gtk.events_pending()) {
364 imports.gi.Gtk.main_iteration();
371 //this.ctx.iteration(true);
373 case GLib.IOStatus.AGAIN:
374 //print("Should be called again.. waiting for more data..");
377 case GLib.IOStatus.ERROR:
378 case GLib.IOStatus.EOF:
386 //print("RETURNING");
387 return false; // allow it to be called again..
394 * simple run a process - returns result, or throws stderr result...
395 * @param cfg {Object} see spawn
396 * @return {string} stdout output.
399 cfg.exceptions = true;
401 var s = new Spawn(cfg);
409 args: ['ls', '/tmp'],
412 } catch (e) { print(JSON.stringify(e)); }
414 var secs = (new Date()).getSeconds()
418 args: ['/bin/touch', '/tmp/spawntest-' + secs ],
421 } catch (e) { print( 'Error: ' + JSON.stringify(e)); }