git.roojs.org Git - app.Builder.js/blob - src/Spawn.vala

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