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      * @property err_src {int} the watch for errors
 153      */
 154
 155     int err_src = -1;
 156       /**
 157      * @property err_src {int} the watch for output
 158      */
 159     int out_src = -1;
 160
 161     /**
 162      *
 163      * @method run
 164      * Run the configured command.
 165      * result is applied to object properties (eg. 'output' or 'stderr')
 166      * @returns {Object} self.
 167      */
 168     public run : function()
 169     {
 170
 171
 172         var err_src = false;
 173         var out_src = false;
 174         int standard_input;
 175         int standard_output;
 176         int standard_error;
 177
 178
 179         var ret = {};
 180
 181         if (this.cfg.debug) {
 182             print("cd " + this.cfg.cwd +";" + string.joinv(" ", this.cfg.args));
 183         }
 184
 185         Process.spawn_async_with_pipes (
 186                         this.cfg.cwd,
 187                         this.cfg.args,
 188                         this.cfg.env,
 189                         SpawnFlags.SEARCH_PATH | SpawnFlags.DO_NOT_REAP_CHILD,
 190                         null,
 191                         out this.pid,
 192                         out standard_input,
 193                         out standard_output,
 194                         out standard_error);
 195
 196                 // stdout:
 197
 198
 199         //print(JSON.stringify(gret));
 200
 201         if (this.cfg.debug) {
 202             print("PID: " + this.pid);
 203         }
 204
 205         ChildWatch.add (this.pid, (w_pid, result) => {
 206
 207             this.result = result;
 208             if (_this.debug) {
 209                 print("child_watch_add : result: " + result);
 210             }
 211
 212             this.read(this.out_ch);
 213             this.read(this.err_ch);
 214
 215
 216             Process.close_pid(this.pid);
 217             this.pid = -1;
 218             if (this.ctx) {
 219                 this.ctx.quit();
 220             }
 221             this.tidyup();
 222             //print("DONE TIDYUP");
 223             if (this.cfg.finish) {
 224                 this.cfg.finish(this.result);
 225             }
 226         });
 227
 228
 229
 230
 231         this.in_ch = new GLib.IOChannel.unix_new(ret.standard_input);
 232         this.out_ch = new GLib.IOChannel.unix_new(ret.standard_output);
 233         this.err_ch = new GLib.IOChannel.unix_new(ret.standard_error);
 234
 235         // make everything non-blocking!
 236
 237
 238
 239                         // using NONBLOCKING only works if io_add_watch
 240            //returns true/false in right conditions
 241            this.in_ch.set_flags (GLib.IOFlags.NONBLOCK);
 242            this.out_ch.set_flags (GLib.IOFlags.NONBLOCK);
 243            this.err_ch.set_flags (GLib.IOFlags.NONBLOCK);
 244
 245
 246
 247         // add handlers for output and stderr.
 248         out_src= GLib.io_add_watch(this.out_ch, GLib.PRIORITY_DEFAULT,
 249             GLib.IOCondition.OUT + GLib.IOCondition.IN  + GLib.IOCondition.PRI +  GLib.IOCondition.HUP +  GLib.IOCondition.ERR,
 250             function() {
 251
 252                return  _this.read(_this.out_ch);
 253
 254             }
 255         );
 256         err_src= GLib.io_add_watch(this.err_ch, GLib.PRIORITY_DEFAULT,
 257             GLib.IOCondition.ERR + GLib.IOCondition.IN + GLib.IOCondition.PRI + GLib.IOCondition.OUT +  GLib.IOCondition.HUP,
 258             function()
 259         {
 260             return _this.read(_this.err_ch);
 261
 262         });
 263
 264
 265
 266         // call input..
 267         if (this.pid !== false) {
 268             // child can exit before 1we get this far..
 269             if (this.listeners.input) {
 270                                 print("Trying to call listeners");
 271                 try {
 272                     this.write(this.listeners.input.call(this));
 273                      // this probably needs to be a bit smarter...
 274                     //but... let's close input now..
 275                     this.in_ch.close();
 276                     _this.in_ch = false;
 277
 278
 279
 280
 281
 282                 } catch (e) {
 283                     tidyup();
 284                     throw e;
 285
 286                 }
 287
 288             }
 289         }
 290         // async - if running - return..
 291         if (this.async && this.pid) {
 292             return this;
 293         }
 294
 295         // start mainloop if not async..
 296
 297         if (this.pid !== false) {
 298             if (this.debug) {
 299                 print("starting main loop");
 300             }
 301
 302             this.ctx = isSeed ? new GLib.MainLoop.c_new (null, false) : GLib.MainLoop.new (null, false);;
 303             this.ctx.run(false); // wait fore exit?
 304
 305             //print("main_loop done!");
 306         } else {
 307             tidyup(); // tidyup get's called in main loop.
 308         }
 309
 310         if (this.exceptions && this.result != 0) {
 311             this.toString = function() { return this.stderr; };
 312             throw this; // we throw self...
 313         }
 314
 315         // finally throw, or return self..
 316
 317         return this;
 318
 319     },
 320
 321
 322
 323     private void tidyup()
 324     {
 325         if (this.pid > -1) {
 326             Process.close_pid(this.pid); // hopefully kills it..
 327             this.pid = -1;
 328         }
 329         if (this.in_ch)  this.in_ch.close();
 330         if (this.out_ch)  this.out_ch.close();
 331         if (this.err_ch)  this.err_ch.close();
 332         // blank out channels
 333         this.in_ch = false;
 334         this.err_ch = false;
 335         this.out_ch = false;
 336         // rmeove listeners !! important otherwise we kill the CPU
 337         if (this.err_src !== false) GLib.source_remove(this.err_src);
 338         if (this.out_src !== false) GLib.source_remove(this.out_src);
 339         this.err_src = false;
 340         this.out_src = false;
 341
 342     }
 343
 344
 345     /**
 346      * write to stdin of process
 347      * @arg str {String} string to write to stdin of process
 348      * @returns GLib.IOStatus (0 == error, 1= NORMAL)
 349      */
 350     write : function(str) // write a line to
 351     {
 352         if (!this.in_ch) {
 353             return 0; // input is closed
 354         }
 355         //print("write: " + str);
 356         // NEEDS GIR FIX! for return value.. let's ignore for the time being..
 357         //var ret = {};
 358         //var res = this.in_ch.write_chars(str, str.length, ret);
 359         var res = this.in_ch.write_chars(str, str.length);
 360
 361         //print("write_char retunred:" + JSON.stringify(res) +  ' ' +JSON.stringify(ret)  );
 362
 363         if (res != GLib.IOStatus.NORMAL) {
 364             throw "Write failed";
 365         }
 366         //return ret.value;
 367         return str.length;
 368
 369     },
 370
 371     /**
 372      * read from pipe and call appropriate listerner and add to output or stderr string.
 373      * @arg giochannel to read from.
 374      * @returns none
 375      */
 376     read: function(ch)
 377     {
 378         var prop = ch == this.out_ch ? 'output' : 'stderr';
 379        // print("prop: " + prop);
 380         var _this = this;
 381
 382
 383         //print(JSON.stringify(ch, null,4));
 384         while (true) {
 385
 386             var x =   {};
 387             var status = ch.read_line( x);
 388             // print('status: '  +JSON.stringify(status));
 389             // print(JSON.stringify(x));
 390              switch(status) {
 391                 case GLib.IOStatus.NORMAL:
 392
 393                     //write(fn, x.str);
 394                     if (this.listeners[prop]) {
 395                         this.listeners[prop].call(this, x.str_return);
 396                     }
 397                     _this[prop] += x.str_return;
 398                     if (_this.debug) {
 399                         print(prop + ':' + x.str_return.replace(/\n/, ''));
 400                     }
 401                     if (this.async) {
 402                         try {
 403                             if (imports.gi.Gtk.events_pending()) {
 404                                 imports.gi.Gtk.main_iteration();
 405                             }
 406                         } catch(e) {
 407
 408                         }
 409                     }
 410
 411                     //this.ctx.iteration(true);
 412                    continue;
 413                 case GLib.IOStatus.AGAIN:
 414                     //print("Should be called again.. waiting for more data..");
 415                     return true;
 416                     break;
 417                 case GLib.IOStatus.ERROR:
 418                 case GLib.IOStatus.EOF:
 419                     return false;
 420                    break;
 421
 422             }
 423             break;
 424         }
 425
 426         //print("RETURNING");
 427          return false; // allow it to be called again..
 428     }
 429
 430 };
 431 /**
 432  * @function run
 433  *
 434  * simple run a process - returns result, or throws stderr result...
 435  * @param cfg {Object}  see spawn
 436  * @return {string} stdout output.
 437  */
 438 function run(cfg) {
 439     cfg.exceptions = true;
 440     cfg.async = false;
 441     var s = new Spawn(cfg);
 442     var ret = s.run();
 443     return s.output;
 444 }
 445  /*
 446 // test
 447 try {
 448     Seed.print(run({
 449         args: ['ls', '/tmp'],
 450         debug : true
 451     }));
 452 } catch (e) { print(JSON.stringify(e)); }
 453
 454 var secs = (new Date()).getSeconds()
 455
 456 try {
 457 Seed.print(run({
 458     args: ['/bin/touch', '/tmp/spawntest-' + secs ],
 459     debug : true
 460 }));
 461 } catch (e) { print( 'Error: ' + JSON.stringify(e)); }
 462
 463
 464  */
 465