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' },
34 * @param cfg {Object} settings - see properties.
36 * @arg cwd {String} working directory. (defaults to home directory)
37 * @arg args {Array} arguments eg. [ 'ls', '-l' ]
38 * @arg listeners {Object} (optional) handlers for output, stderr, input
39 * stderr/output both receive output line as argument
40 * input should return any standard input
41 * finish recieves result as argument.
42 * @arg env {Array} enviroment eg. [ 'GITDIR=/home/test' ]
43 * @arg async {Boolean} (optional)return instantly, or wait for exit. (default no)
44 * @arg exceptions {Boolean} throw exception on failure (default no)
45 * @arg debug {Boolean} print out what's going on.. (default no)
53 this.listeners = this.listeners || {};
54 this.cwd = this.cwd || GLib.get_home_dir();
55 if (!this.args || !this.args.length) {
72 * @property output {String} resulting output
76 * @property stderr {String} resulting output from stderr
80 * @property result {Number} execution result.
84 * @property pid {Number} pid of child process (of false if it's not running)
91 * @property in_ch {GLib.IOChannel} input io channel
95 * @property out_ch {GLib.IOChannel} output io channel
99 * @property err_ch {GLib.IOChannel} stderr io channel
106 * Run the configured command.
122 print("spawn : " + this.args.join(" "));
125 GLib.spawn_async_with_pipes(this.cwd, this.args, this.env,
126 GLib.SpawnFlags.DO_NOT_REAP_CHILD + GLib.SpawnFlags.SEARCH_PATH ,
129 this.pid = ret.child_pid;
132 print("PID: " + this.pid);
138 GLib.spawn_close_pid(_this.pid); // hopefully kills it..
141 if (_this.in_ch) _this.in_ch.close();
142 if (_this.out_ch) _this.out_ch.close();
143 if (_this.err_ch) _this.err_ch.close();
144 // blank out channels
146 _this.err_ch = false;
147 _this.out_ch = false;
148 // rmeove listeners !! important otherwise we kill the CPU
149 if (err_src !== false) GLib.source_remove(err_src);
150 if (out_src !== false) GLib.source_remove(out_src);
158 GLib.child_watch_add(GLib.PRIORITY_DEFAULT, this.pid, function(pid, result) {
159 _this.result = result;
161 print("result: " + result);
163 _this.read(_this.out_ch);
164 _this.read(_this.err_ch);
166 GLib.spawn_close_pid(_this.pid);
172 if (_this.listeners.finish) {
173 _this.listeners.finish.call(this, _this.result);
178 this.in_ch = GLib.io_channel_unix_new(ret.standard_input);
179 this.out_ch = GLib.io_channel_unix_new(ret.standard_output);
180 this.err_ch = GLib.io_channel_unix_new(ret.standard_error);
182 // make everything non-blocking!
183 this.in_ch.set_flags (GLib.IOFlags.NONBLOCK);
184 this.out_ch.set_flags (GLib.IOFlags.NONBLOCK);
185 this.err_ch.set_flags (GLib.IOFlags.NONBLOCK);
188 // add handlers for output and stderr.
189 out_src= GLib.io_add_watch(this.out_ch, GLib.PRIORITY_DEFAULT,
190 GLib.IOCondition.OUT + GLib.IOCondition.IN + GLib.IOCondition.PRI, function()
192 _this.read(_this.out_ch);
195 err_src= GLib.io_add_watch(this.err_ch, GLib.PRIORITY_DEFAULT,
196 GLib.IOCondition.ERR + GLib.IOCondition.IN + GLib.IOCondition.PRI + GLib.IOCondition.OUT,
199 _this.read(_this.err_ch);
206 if (this.pid !== false) {
207 // child can exit before we get this far..
208 if (this.listeners.input) {
210 this.write(this.listeners.input.call(this));
219 // async - if running - return..
220 if (this.async && this.pid) {
225 // start mainloop if not async..
227 if (this.pid !== false) {
229 print("starting main loop");
231 ctx = new GLib.MainLoop.c_new (null, false);
232 ctx.run(false); // wait fore exit?
235 tidyup(); // tidyup get's called in main loop.
238 if (this.exceptions && this.result != 0) {
239 this.toString = function() { return this.stderr; };
240 throw this; // we throw self...
243 // finally throw, or return self..
249 * write to stdin of process
250 * @arg str {String} string to write to stdin of process
251 * @returns GLib.IOStatus (0 == error, 1= NORMAL)
253 write : function(str) // write a line to
256 return 0; // input is closed
259 var res = this.in_ch.write_chars(str, str.length);
260 if (res != GLib.IOStatus.NORMAL) {
261 throw "Write failed";
263 return ret.bytes_written;
268 * read from pipe and call appropriate listerner and add to output or stderr string.
269 * @arg giochannel to read from.
274 var prop = ch == this.out_ch ? 'output' : 'stderr';
277 var x = new GLib.String();
278 var status = ch.read_line_string( x);
280 case GLib.IOStatus.NORMAL:
282 if (this.listeners[prop]) {
283 this.listeners[prop].call(this, x.str);
285 _this[prop] += x.str;
287 print(prop + ':' + x.str);
290 case GLib.IOStatus.AGAIN:
292 case GLib.IOStatus.ERROR:
293 case GLib.IOStatus.EOF:
305 * simple run a process - returns result, or throws stderr result...
306 * @param cfg {Object} see spawn
307 * @return {string} stdout output.
310 cfg.exceptions = true;
312 var s = new Spawn(cfg);
321 // args: ['ls', '/tmp'],