git.roojs.org Git - gitlive/blob - Spawn.vala

   1
   2
   3 using Gee; // for array list?
   4
   5 static int main (string[] args) {
   6     // A reference to our file
   7     var file = File.new_for_path ("data.txt");
   8     var m = new Monitor();
   9     return 0;
  10
  11 }
  12
  13 var Gio      = imports.gi.Gio;
  14 var GLib      = imports.gi.GLib;
  15
  16
  17 /**
  18 * @namespace Spawn
  19 *
  20 * Library to wrap GLib.spawn_async_with_pipes
  21 *
  22 * usage:
  23 *
  24 * Spawn = import.Spawn;
  25 *
  26 * simple version..
  27 * var output = Spawn.run({
  28 *   cwd : '/home',
  29 *   args : [ 'ls', '-l' ],
  30 *   env : [], // optional
  31 *   listeners : {
  32         output : function (line) { Seed.print(line); },
  33 *       stderr :  function (line) {Seed.print("ERROR" + line);  },
  34 *       input : function() { return 'xxx' },
  35 *   }
  36 *  });
  37 *
  38 *
  39 *
  40 *
  41 *
  42 *var output = Spawn.run( SpawnConfig() {
  43     cwd = "/home",  // empty string to default to homedirectory.
  44     args = {"ls", "-l" },
  45     evn = {},
  46     ouput  = (line) => { stdout.printf("%d\n", line); }
  47     stderr  = (line) => { stdout.printf("%d\n", line); }
  48     input  = () => { return "xxx"; }
  49 };
  50 *
  51 *
  52 */
  53 delegate void SpawnOutput(string line);
  54 delegate void SpawnErr(string line);
  55 delegate string SpawnInput();
  56
  57
  58
  59 struct SpawnConfig
  60 struct SpawnConfig {
  61     public string cwd;
  62     public string[] args;
  63     public string[]  env;
  64     public boolean async;
  65     public boolean exceptions; // fire exceptions.
  66     public boolean debug; // fire exceptions.
  67
  68     public SpawnOutput output
  69     public SpawnErr stderr;
  70     public SpawnInput input;
  71     // defaults..
  72     public SpawnConfig() {
  73         cwd = "";
  74         args = [];
  75         env = [];
  76         async = false;
  77         exceptions = false;
  78         debug = false;
  79
  80     }
  81 }
  82
  83 /**
  84  * @class Spawn
  85  * @param cfg {SpawnConfig} settings - see properties.
  86  *
  87  * @arg cwd {String}            working directory. (defaults to home directory)
  88  * @arg args {Array}            arguments eg. [ 'ls', '-l' ]
  89  * @arg listeners {Object} (optional) handlers for output, stderr, input
  90  *     stderr/output both receive output line as argument
  91  *     input should return any standard input
  92  *     finish recieves result as argument.
  93  * @arg env {Array}             enviroment eg. [ 'GITDIR=/home/test' ]
  94  * @arg async {Boolean} (optional)return instantly, or wait for exit. (default no)
  95  * @arg exceptions {Boolean}    throw exception on failure (default no)
  96  * @arg debug {Boolean}    print out what's going on.. (default no)
  97  *
  98  */
  99
 100
 101 public class Spawn : Object
 102 {
 103
 104
 105
 106     public Spawn(SpawnConfig cfg)
 107     {
 108
 109
 110         this.cfg = cfg;
 111
 112
 113         this.cwd =  this.cfg.cwd.length || GLib.get_home_dir();
 114         if (!this.cfg.args.length) {
 115             throw "No arguments";
 116         }
 117
 118     }
 119
 120
 121     boolean ctx = false; // the mainloop ctx.
 122
 123     /**
 124      * @property output {String} resulting output
 125      */
 126     string output  = "";
 127     /**
 128      * @property stderr {String} resulting output from stderr
 129      */
 130     string stderr  = "";
 131      /**
 132      * @property result {Number} execution result.
 133      */
 134     int result= 0;
 135     /**
 136      * @property pid {Number} pid of child process (of false if it's not running)
 137      */
 138     int  pid = -1;
 139     /**
 140      * @property in_ch {GLib.IOChannel} input io channel
 141      */
 142     IOChannel in_ch = null;
 143     /**
 144      * @property out_ch {GLib.IOChannel} output io channel
 145      */
 146     IOChannel out_ch = null;
 147     /**
 148      * @property err_ch {GLib.IOChannel} stderr io channel
 149      */
 150     IOChannel err_ch = null;
 151     /**
 152      *
 153      * @method run
 154      * Run the configured command.
 155      * result is applied to object properties (eg. 'output' or 'stderr')
 156      * @returns {Object} self.
 157      */
 158     public run : function()
 159     {
 160
 161
 162         var err_src = false;
 163         var out_src = false;
 164         int standard_input;
 165         int standard_output;
 166         int standard_error;
 167
 168
 169         var ret = {};
 170
 171         if (this.cfg.debug) {
 172             print("cd " + this.cfg.cwd +";" + string.joinv(" ", this.cfg.args));
 173         }
 174
 175         Process.spawn_async_with_pipes (
 176                         this.cfg.cwd,
 177                         this.cfg.args,
 178                         this.cfg.env,
 179                         SpawnFlags.SEARCH_PATH | SpawnFlags.DO_NOT_REAP_CHILD,
 180                         null,
 181                         out this.pid,
 182                         out standard_input,
 183                         out standard_output,
 184                         out standard_error);
 185
 186                 // stdout:
 187
 188
 189         //print(JSON.stringify(gret));
 190
 191         if (this.cfg.debug) {
 192             print("PID: " + this.pid);
 193         }
 194
 195
 196
 197         GLib.child_watch_add(GLib.PRIORITY_DEFAULT, this.pid, function(pid, result) {
 198             _this.result = result;
 199             if (_this.debug) {
 200                 print("child_watch_add : result: " + result);
 201             }
 202             _this.read(_this.out_ch);
 203             _this.read(_this.err_ch);
 204
 205
 206             GLib.spawn_close_pid(_this.pid);
 207             _this.pid = false;
 208             if (_this.ctx) {
 209                 _this.ctx.quit();
 210             }
 211             tidyup();
 212             //print("DONE TIDYUP");
 213             if (_this.listeners.finish) {
 214                 _this.listeners.finish.call(this, _this.result);
 215             }
 216         });
 217
 218         function tidyup()
 219         {
 220             if (_this.pid) {
 221                 GLib.spawn_close_pid(_this.pid); // hopefully kills it..
 222                 _this.pid = false;
 223             }
 224             if (_this.in_ch)  _this.in_ch.close();
 225             if (_this.out_ch)  _this.out_ch.close();
 226             if (_this.err_ch)  _this.err_ch.close();
 227             // blank out channels
 228             _this.in_ch = false;
 229             _this.err_ch = false;
 230             _this.out_ch = false;
 231             // rmeove listeners !! important otherwise we kill the CPU
 232             if (err_src !== false) GLib.source_remove(err_src);
 233             if (out_src !== false) GLib.source_remove(out_src);
 234             err_src = false;
 235             out_src = false;
 236
 237         }
 238
 239
 240         this.in_ch = new GLib.IOChannel.unix_new(ret.standard_input);
 241         this.out_ch = new GLib.IOChannel.unix_new(ret.standard_output);
 242         this.err_ch = new GLib.IOChannel.unix_new(ret.standard_error);
 243
 244         // make everything non-blocking!
 245
 246
 247
 248                         // using NONBLOCKING only works if io_add_watch
 249            //returns true/false in right conditions
 250            this.in_ch.set_flags (GLib.IOFlags.NONBLOCK);
 251            this.out_ch.set_flags (GLib.IOFlags.NONBLOCK);
 252            this.err_ch.set_flags (GLib.IOFlags.NONBLOCK);
 253
 254
 255
 256         // add handlers for output and stderr.
 257         out_src= GLib.io_add_watch(this.out_ch, GLib.PRIORITY_DEFAULT,
 258             GLib.IOCondition.OUT + GLib.IOCondition.IN  + GLib.IOCondition.PRI +  GLib.IOCondition.HUP +  GLib.IOCondition.ERR,
 259             function() {
 260
 261                return  _this.read(_this.out_ch);
 262
 263             }
 264         );
 265         err_src= GLib.io_add_watch(this.err_ch, GLib.PRIORITY_DEFAULT,
 266             GLib.IOCondition.ERR + GLib.IOCondition.IN + GLib.IOCondition.PRI + GLib.IOCondition.OUT +  GLib.IOCondition.HUP,
 267             function()
 268         {
 269             return _this.read(_this.err_ch);
 270
 271         });
 272
 273
 274
 275         // call input..
 276         if (this.pid !== false) {
 277             // child can exit before 1we get this far..
 278             if (this.listeners.input) {
 279                                 print("Trying to call listeners");
 280                 try {
 281                     this.write(this.listeners.input.call(this));
 282                      // this probably needs to be a bit smarter...
 283                     //but... let's close input now..
 284                     this.in_ch.close();
 285                     _this.in_ch = false;
 286
 287
 288
 289
 290
 291                 } catch (e) {
 292                     tidyup();
 293                     throw e;
 294
 295                 }
 296
 297             }
 298         }
 299         // async - if running - return..
 300         if (this.async && this.pid) {
 301             return this;
 302         }
 303
 304         // start mainloop if not async..
 305
 306         if (this.pid !== false) {
 307             if (this.debug) {
 308                 print("starting main loop");
 309             }
 310
 311             this.ctx = isSeed ? new GLib.MainLoop.c_new (null, false) : GLib.MainLoop.new (null, false);;
 312             this.ctx.run(false); // wait fore exit?
 313
 314             //print("main_loop done!");
 315         } else {
 316             tidyup(); // tidyup get's called in main loop.
 317         }
 318
 319         if (this.exceptions && this.result != 0) {
 320             this.toString = function() { return this.stderr; };
 321             throw this; // we throw self...
 322         }
 323
 324         // finally throw, or return self..
 325
 326         return this;
 327
 328     },
 329     /**
 330      * write to stdin of process
 331      * @arg str {String} string to write to stdin of process
 332      * @returns GLib.IOStatus (0 == error, 1= NORMAL)
 333      */
 334     write : function(str) // write a line to
 335     {
 336         if (!this.in_ch) {
 337             return 0; // input is closed
 338         }
 339         //print("write: " + str);
 340         // NEEDS GIR FIX! for return value.. let's ignore for the time being..
 341         //var ret = {};
 342         //var res = this.in_ch.write_chars(str, str.length, ret);
 343         var res = this.in_ch.write_chars(str, str.length);
 344
 345         //print("write_char retunred:" + JSON.stringify(res) +  ' ' +JSON.stringify(ret)  );
 346
 347         if (res != GLib.IOStatus.NORMAL) {
 348             throw "Write failed";
 349         }
 350         //return ret.value;
 351         return str.length;
 352
 353     },
 354
 355     /**
 356      * read from pipe and call appropriate listerner and add to output or stderr string.
 357      * @arg giochannel to read from.
 358      * @returns none
 359      */
 360     read: function(ch)
 361     {
 362         var prop = ch == this.out_ch ? 'output' : 'stderr';
 363        // print("prop: " + prop);
 364         var _this = this;
 365
 366
 367         //print(JSON.stringify(ch, null,4));
 368         while (true) {
 369
 370             var x =   {};
 371             var status = ch.read_line( x);
 372             // print('status: '  +JSON.stringify(status));
 373             // print(JSON.stringify(x));
 374              switch(status) {
 375                 case GLib.IOStatus.NORMAL:
 376
 377                     //write(fn, x.str);
 378                     if (this.listeners[prop]) {
 379                         this.listeners[prop].call(this, x.str_return);
 380                     }
 381                     _this[prop] += x.str_return;
 382                     if (_this.debug) {
 383                         print(prop + ':' + x.str_return.replace(/\n/, ''));
 384                     }
 385                     if (this.async) {
 386                         try {
 387                             if (imports.gi.Gtk.events_pending()) {
 388                                 imports.gi.Gtk.main_iteration();
 389                             }
 390                         } catch(e) {
 391
 392                         }
 393                     }
 394
 395                     //this.ctx.iteration(true);
 396                    continue;
 397                 case GLib.IOStatus.AGAIN:
 398                     //print("Should be called again.. waiting for more data..");
 399                     return true;
 400                     break;
 401                 case GLib.IOStatus.ERROR:
 402                 case GLib.IOStatus.EOF:
 403                     return false;
 404                    break;
 405
 406             }
 407             break;
 408         }
 409
 410         //print("RETURNING");
 411          return false; // allow it to be called again..
 412     }
 413
 414 };
 415 /**
 416  * @function run
 417  *
 418  * simple run a process - returns result, or throws stderr result...
 419  * @param cfg {Object}  see spawn
 420  * @return {string} stdout output.
 421  */
 422 function run(cfg) {
 423     cfg.exceptions = true;
 424     cfg.async = false;
 425     var s = new Spawn(cfg);
 426     var ret = s.run();
 427     return s.output;
 428 }
 429  /*
 430 // test
 431 try {
 432     Seed.print(run({
 433         args: ['ls', '/tmp'],
 434         debug : true
 435     }));
 436 } catch (e) { print(JSON.stringify(e)); }
 437
 438 var secs = (new Date()).getSeconds()
 439
 440 try {
 441 Seed.print(run({
 442     args: ['/bin/touch', '/tmp/spawntest-' + secs ],
 443     debug : true
 444 }));
 445 } catch (e) { print( 'Error: ' + JSON.stringify(e)); }
 446
 447
 448  */
 449