git.roojs.org Git - Pman.Core/blob - Notify.php

   1 <?php
   2 require_once 'Pman.php';
   3
   4 /**
   5  * notification script runner
   6  *
   7  * This does not actualy send stuf out, it only starts the NotifySend/{id}
   8  * which does the actuall notifcations.
   9  *
  10  * It manages a pool of notifiers.
  11  *
  12  *
  13  */
  14
  15
  16 class Pman_Core_Notify extends Pman
  17 {
  18
  19     static $cli_desc = "Runs the notification queue (usually from cron)
  20                         Normally used to sends out emails to anyone in the notification list.
  21
  22                         /etc/cron.d/pman-core-notify
  23                         * *  * * *     www-data     /usr/bin/php /home/gitlive/web.mtrack/admin.php  Core/Notify > /dev/null
  24
  25 ";
  26
  27     static $cli_opts = array(
  28         'debug' => array(
  29             'desc' => 'Turn on debugging (see DataObjects debugLevel )',
  30             'default' => 0,
  31             'short' => 'v',
  32             'min' => 1,
  33             'max' => 1,
  34
  35         ),
  36         'list' => array(
  37             'desc' => 'List message to send, do not send them..',
  38             'default' => 0,
  39             'short' => 'l',
  40             'min' => 0,
  41             'max' => 0,
  42
  43         ),
  44         'old' => array(
  45             'desc' => 'Show old messages.. (and new messages...)',
  46             'default' => 0,
  47             'short' => 'o',
  48             'min' => 0,
  49             'max' => 0,
  50
  51         ),
  52         'force' => array(
  53             'desc' => 'Force redelivery, even if it has been sent before or not queued...',
  54             'default' => 0,
  55             'short' => 'f',
  56             'min' => 0,
  57             'max' => 0,
  58         ),
  59         'generate' => array(
  60             'desc' => 'Generate notifications for a table, eg. cash_invoice',
  61             'default' => '',
  62             'short' => 'g',
  63             'min' => 0,
  64             'max' => 1,
  65         ),
  66          'limit' => array(
  67             'desc' => 'Limit search for no. to send to ',
  68             'default' => 1000,
  69             'short' => 'L',
  70             'min' => 0,
  71             'max' => 999,
  72         ),
  73         'dryrun' => array(
  74             'desc' => 'Dry run - do not send.',
  75             'default' => 0,
  76             'short' => 'D',
  77             'min' => 0,
  78             'max' => 0,
  79         ),
  80         'poolsize' => array(
  81             'desc' => 'Pool size',
  82             'default' => 10,
  83             'short' => 'P',
  84             'min' => 0,
  85             'max' => 100,
  86         ),
  87     );
  88     /**
  89      * @var $nice_level Unix 'nice' level to stop it jamming server up.
  90      */
  91     var $nice_level = false;
  92     /**
  93      * @var $max_pool_size maximum runners to start at once.
  94      */
  95     var $max_pool_size = 10;
  96     /**
  97      * @var $max_to_domain maximum connections to make to a single domain
  98      */
  99     var $max_to_domain = 10;
 100
 101     /**
 102      * @var $maxruntime - maximum time a child is allowed to run - defaut 2 minutes
 103      */
 104     var $maxruntime = 120;
 105
 106     var $table = 'core_notify';
 107     var $target = 'Core/NotifySend';
 108     var $evtype = ''; // any notification...
 109                     // this script should only handle EMAIL notifications..
 110     var $force = false;
 111     function getAuth()
 112     {
 113         $ff = HTML_FlexyFramework::get();
 114         if (!$ff->cli) {
 115             die("access denied");
 116         }
 117         HTML_FlexyFramework::ensureSingle($_SERVER["SCRIPT_NAME"] .'|'. __FILE__, $this);
 118         return true;
 119     }
 120
 121     var $pool = array();
 122
 123     function parseArgs(&$opts)
 124     {
 125         if ($opts['debug']) {
 126             DB_DataObject::debugLevel($opts['debug']);
 127             print_r($opts);
 128         }
 129         $this->opts = $opts;
 130         if (!empty($opts['poolsize'])) {
 131             $this->max_pool_size = $opts['poolsize'];
 132         }
 133
 134         if (empty($opts['limit'])) {
 135             $opts['limit'] = '1000'; // not sure why it's not picking up the defautl..
 136         }
 137
 138         if (!empty($opts['old'])) {
 139             $opts['list'] = 1; // force listing..
 140         }
 141
 142         $this->force = empty($opts['force']) ? 0 : 1;
 143
 144         if (!empty($opts['send-to'])) {
 145             $this->send_to = $opts['send-to'];
 146         }
 147     }
 148
 149
 150     function get($r,$opts)
 151     {
 152         $this->parseArgs($opts);
 153
 154         //date_default_timezone_set('UTC');
 155
 156
 157
 158
 159        // phpinfo();exit;
 160         if (!empty($opts['generate'])) {
 161             $w = DB_DataObject::factory($opts['generate']);
 162             if (is_a($w, 'DB_DataObject')) {
 163                 $w->generateNotifications();
 164             }
 165             exit;
 166         }
 167
 168
 169
 170         $w = DB_DataObject::factory('core_notify_recur');
 171         if (is_a($w, 'DB_DataObject')) {
 172             $w->generateNotifications();
 173         }
 174
 175         //DB_DataObject::debugLevel(1);
 176         $w = DB_DataObject::factory($this->table);
 177         $total = 0;
 178
 179         if (!empty($opts['old'])) {
 180             // show old and new...
 181
 182             $w->orderBy('act_when DESC'); // latest first
 183             $w->limit($opts['limit']); // we can run
 184             $total = min($w->count(), $opts['limit']);
 185         } else {
 186             // standard
 187
 188             //$w->whereAdd('act_when > sent'); // eg.. sent is not valid..
 189             $w->whereAdd("sent < '1970-01-01' OR sent IS NULL"); // eg.. sent is not valid..
 190
 191             $w->whereAdd('act_start > NOW() - INTERVAL 14 DAY'); // ignore the ones stuck in the queue
 192             if (!$this->force) {
 193                 $w->whereAdd('act_when < NOW()'); // eg.. not if future..
 194             }
 195
 196             $w->orderBy('act_when ASC'); // oldest first.
 197             $total = min($w->count(), $opts['limit']);
 198             $this->logecho("QUEUE is {$w->count()} only running " . ((int) $opts['limit']));
 199
 200             $w->limit($opts['limit']); // we can run 1000 ...
 201         }
 202
 203         if (!empty($this->evtype)) {
 204             $w->evtype = $this->evtype;
 205         }
 206
 207         $w->autoJoin();
 208         $w->find();
 209
 210         $ar = array(); // $w->fetchAll();
 211
 212         if (!empty($opts['list'])) {
 213
 214
 215             while ($w->fetch()) {
 216                 $o = $w->object();
 217
 218
 219                 $this->logecho("{$w->id} : {$w->person()->email} email    : ".
 220                         $o->toEventString()."    ". $w->status()  );
 221             }
 222             exit;
 223         }
 224
 225         //echo "BATCH SIZE: ".  count($ar) . "\n";
 226         $pushed = array();
 227         $requeue = array();
 228         while (true) {
 229             if ($w->fetch()) {
 230                 $ar[] = clone($w);
 231                 $total--;
 232             }
 233
 234             $this->logecho("BATCH SIZE: ".  (count($ar) + $total) );
 235
 236             if (empty($ar)) {
 237                 $this->logecho("COMPLETED MAIN QUEUE - running deleted");
 238
 239                 if (empty($pushed)) {
 240                     break;
 241                 }
 242                 $ar = $pushed;
 243                 $pushed = false;
 244                 continue;
 245             }
 246
 247
 248             $p = array_shift($ar);
 249             if (!$this->poolfree()) {
 250                 array_unshift($ar,$p); /// put it back on..
 251                 sleep(3);
 252                 continue;
 253             }
 254             $email = $p->person() ? $p->person()->email : $p->to_email;
 255
 256             if ($this->poolHasDomain($email) > $this->max_to_domain) {
 257
 258                 if ($pushed === false) {
 259                     // we only try once to requeue..
 260                     $requeue[] = $p;
 261                     continue;
 262                 }
 263                 $pushed[] = $p;
 264
 265
 266                 //sleep(3);
 267                 continue;
 268             }
 269
 270
 271             $this->run($p->id,$email);
 272
 273
 274
 275         }
 276
 277         // we should have a time limit here...
 278         while(count($this->pool)) {
 279             $this->poolfree();
 280              sleep(3);
 281         }
 282
 283         foreach($requeue as $p) {
 284             $pp = clone($p);
 285             $p->act_when = $p->sqlValue('NOW + INTERVAL 1 MINUTE');
 286             $p->update($pp);
 287
 288         }
 289
 290
 291         $this->logecho("DONE");
 292         exit;
 293     }
 294
 295     function generateNotifications()
 296     {
 297         // this should check each module for 'GenerateNotifications.php' class..
 298         //and run it if found..
 299
 300
 301         $modules = array_reverse($this->modulesList());
 302
 303         // move 'project' one to the end...
 304
 305         foreach ($modules as $module){
 306             if(in_array($module, $this->disabled)){
 307                 continue;
 308             }
 309             $file = $this->rootDir. "/Pman/$module/GenerateNotifications.php";
 310             if(!file_exists($file)){
 311                 continue;
 312             }
 313
 314             require_once $file;
 315             $class = "Pman_{$module}_GenerateNotifications";
 316             $x = new $class;
 317             if(!method_exists($x, 'generate')){
 318                 continue;
 319             };
 320             //echo "$module\n";
 321             $x->generate();
 322         }
 323
 324
 325     }
 326
 327
 328
 329     function run($id, $email, $cmdOpts="")
 330     {
 331
 332         static $renice = false;
 333         if (!$renice) {
 334             require_once 'System.php';
 335             $renice = System::which('renice');
 336         }
 337
 338         // phpinfo();exit;
 339         $tnx = tempnam(ini_get('session.save_path'),'stdout');
 340         unlink($tnx);
 341         $tn =  $tnx . '.stdout';
 342         $descriptorspec = array(
 343             0 => array("pipe", 'r'),  // stdin is a pipe that the child will read from
 344             1 => array("file", $tn, 'w'),  // stdout is a pipe that the child will write to
 345             2 => array("pipe", "w") // stderr is a file to write to
 346          );
 347
 348         static $php = false;
 349         if (!$php) {
 350             require_once 'System.php';
 351             $php = System::which('php');
 352         }
 353
 354         $sn =  $_SERVER["SCRIPT_NAME"];
 355
 356         $cwd = $sn[0] == '/' ? dirname($sn) : dirname(realpath(getcwd() . '/'. $sn)); // same as run on.. (so script should end up being same relatively..)
 357         $app = $cwd . '/' . basename($_SERVER["SCRIPT_NAME"]) . '  ' . $this->target . '/'. $id;
 358         if ($this->force) {
 359             $app .= ' -f';
 360         }
 361         if (!empty($this->send_to)) {
 362             $app .= ' --sent-to='.escapeshellarg($this->send_to);
 363         }
 364         $cmd = 'exec ' . $php . ' ' . $app . ' ' . $cmdOpts; //. ' &';
 365
 366
 367         $pipe = array();
 368         $this->logecho("call proc_open $cmd");
 369
 370
 371         if ($this->max_pool_size === 1) {
 372             passthru($cmd);
 373             return;
 374         }
 375
 376
 377         if (!empty($this->opts['dryrun'])) {
 378             $this->logecho("DRY RUN");
 379             return;
 380         }
 381
 382         $p = proc_open($cmd, $descriptorspec, $pipes, $cwd );
 383         $info =  proc_get_status($p);
 384
 385         if ($this->nice_level !== false) {
 386             $rcmd = "$renice {$this->nice_level} {$info['pid']}";
 387             `$rcmd`;
 388         }
 389         $this->pool[] = array(
 390                 'proc' => $p,
 391                 'pid' => $info['pid'],
 392                 'out' => $tn,
 393                 'cmd' => $cmd,
 394                 'email' => $email,
 395                 'pipes' => $pipes,
 396                 'notify_id' => $id,
 397                 'started' => time()
 398
 399
 400         );
 401         $this->logecho("RUN ({$info['pid']}) $cmd ");
 402     }
 403
 404     function poolfree()
 405     {
 406         $pool = array();
 407         clearstatcache();
 408
 409         foreach($this->pool as $p) {
 410
 411             //echo "CHECK PID: " . $p['pid'] . "\n";
 412             $info =  proc_get_status($p['proc']);
 413             //var_dump($info);
 414
 415             // update if necessday.
 416             if ($info['pid'] && $p['pid'] != $info['pid']) {
 417                 $this->logecho("CHANING PID FROM " . $p['pid']  .  "  TO ". $info['pid']);
 418                 $p['pid'] = $info['pid'];
 419             }
 420
 421             //echo @file_get_contents('/proc/'. $p['pid'] .'/cmdline') . "\n";
 422
 423             if ($info['running']) {
 424
 425                 //if (file_exists('/proc/'.$p['pid'])) {
 426                 $runtime = time() - $p['started'];
 427                 //echo "RUNTIME ({$p['pid']}): $runtime\n";
 428                 if ($runtime > $this->maxruntime) {
 429
 430                     proc_terminate($p['proc'], 9);
 431                     //fclose($p['pipes'][1]);
 432                     fclose($p['pipes'][0]);
 433                     fclose($p['pipes'][2]);
 434                     $this->logecho("TERMINATING: ({$p['pid']}) " . $p['cmd'] . " : " . file_get_contents($p['out']));
 435                     @unlink($p['out']);
 436
 437                     $w = DB_DataObject::factory($this->table);
 438                     $w->get($p['notify_id']);
 439                     $ww = clone($w);
 440                     $this->addEvent('NOTIFY', $w, 'TERMINATED - TIMEOUT');
 441                     $w->act_when = date('Y-m-d H:i:s', strtotime('NOW + 30  MINUTES'));
 442                     $w->update($ww);
 443
 444
 445                     continue;
 446                 }
 447
 448                 $pool[] = $p;
 449                 continue;
 450             }
 451             fclose($p['pipes'][0]);
 452             fclose($p['pipes'][2]);
 453             //echo "CLOSING: ({$p['pid']}) " . $p['cmd'] . " : " . file_get_contents($p['out']) . "\n";
 454             //fclose($p['pipes'][1]);
 455
 456             proc_close($p['proc']);
 457
 458
 459             //clearstatcache();
 460             //if (file_exists('/proc/'.$p['pid'])) {
 461             //    $pool[] = $p;
 462             //    continue;
 463             //}
 464             $this->logecho("ENDED: ({$p['pid']}) " .  $p['cmd'] . " : " . file_get_contents($p['out']) );
 465             @unlink($p['out']);
 466             //unlink($p['out']);
 467         }
 468         $this->logecho("POOL SIZE: ". count($pool) );
 469         $this->pool = $pool;
 470         if (count($pool) < $this->max_pool_size) {
 471             return true;
 472         }
 473         return false;
 474
 475     }
 476     /**
 477      * see if pool is already trying to deliver to this domain.?
 478      * -- if so it get's pushed to the end of the queue.
 479      *
 480      */
 481     function poolHasDomain($email)
 482     {
 483         $ret = 0;
 484         $dom = strtolower(array_pop(explode('@',$email)));
 485         foreach($this->pool as $p) {
 486             $mdom = strtolower(array_pop(explode('@',$p['email'])));
 487             if ($mdom == $dom) {
 488                 $ret++;
 489             }
 490         }
 491         return $ret;
 492
 493     }
 494
 495     function output()
 496     {
 497         $this->logecho("DONE");
 498         exit;
 499     }
 500     function logecho($str)
 501     {
 502         echo date("Y-m-d H:i:s - ") . $str . "\n";
 503     }
 504 }