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        /* removed - use GenerateNotifcations.php hooked classes
  60          'generate' =>  'Generate notifications for a table, eg. cash_invoice',
  61
  62         ),
  63         */
  64          'limit' => array(
  65             'desc' => 'Limit search for no. to send to ',
  66             'default' => 1000,
  67             'short' => 'L',
  68             'min' => 0,
  69             'max' => 999,
  70         ),
  71         'dryrun' => array(
  72             'desc' => 'Dry run - do not send.',
  73             'default' => 0,
  74             'short' => 'D',
  75             'min' => 0,
  76             'max' => 0,
  77         ),
  78         'poolsize' => array(
  79             'desc' => 'Pool size',
  80             'default' => 10,
  81             'short' => 'P',
  82             'min' => 0,
  83             'max' => 100,
  84         ),
  85     );
  86     /**
  87      * @var $nice_level Unix 'nice' level to stop it jamming server up.
  88      */
  89     var $nice_level = false;
  90     /**
  91      * @var $max_pool_size maximum runners to start at once.
  92      */
  93     var $max_pool_size = 10;
  94     /**
  95      * @var $max_to_domain maximum connections to make to a single domain
  96      */
  97     var $max_to_domain = 10;
  98
  99     /**
 100      * @var $maxruntime - maximum seconds a child is allowed to run - defaut 2 minutes
 101      */
 102     var $maxruntime = 120;
 103
 104     /**
 105     * @var {Boolean} log_events - default true if events should be logged.
 106     */
 107     var $log_events = true;
 108     /**
 109     * @var {Number} try_again_minutes how long after failing to try again default = 30 if max runtime fails
 110     */
 111     var $try_again_minutes = 30;
 112
 113     /**
 114      * @var {String} table - the table that the class will query for notification events
 115      */
 116     var $table = 'core_notify';
 117     /**
 118      * @var {String} target - the application that will run for each Row in the table (eg. Pman/Core/NotifySend)
 119      */
 120     var $target = 'Core/NotifySend';
 121
 122
 123
 124     var $evtype = ''; // any notification...
 125                     // this script should only handle EMAIL notifications..
 126
 127     var $server;  // core_notify_server
 128
 129     var $poolname = 'core';
 130
 131     var $opts;
 132     var $force = false;
 133     function getAuth()
 134     {
 135         $ff = HTML_FlexyFramework::get();
 136         if (!$ff->cli) {
 137             die("access denied");
 138         }
 139         HTML_FlexyFramework::ensureSingle($_SERVER["SCRIPT_NAME"] .'|'. __FILE__ .'|'. (empty($_SERVER['argv'][1]) ? '': $_SERVER['argv'][1]), $this);
 140         return true;
 141     }
 142
 143     var $pool = array();
 144
 145     function parseArgs(&$opts)
 146     {
 147         if ($opts['debug']) {
 148             DB_DataObject::debugLevel($opts['debug']);
 149             print_r($opts);
 150         }
 151         $this->opts = $opts;
 152         if (!empty($opts['poolsize'])) {
 153             $this->max_pool_size = $opts['poolsize'];
 154         }
 155
 156         if (empty($opts['limit'])) {
 157             $opts['limit'] = '1000'; // not sure why it's not picking up the defautl..
 158         }
 159
 160         if (!empty($opts['old'])) {
 161             $opts['list'] = 1; // force listing..
 162         }
 163
 164         $this->force = empty($opts['force']) ? 0 : 1;
 165
 166         if (!empty($opts['send-to'])) {
 167             $this->send_to = $opts['send-to'];
 168         }
 169     }
 170
 171     var $queue = array();
 172     var $domain_queue = array(); // false to use nextquee
 173     var $next_queue = array();
 174
 175
 176     function get($r,$opts=array())
 177     {
 178         $this->parseArgs($opts);
 179
 180         //date_default_timezone_set('UTC');
 181
 182
 183         $this->generateNotifications();
 184
 185         $this->assignQueues();
 186
 187         //DB_DataObject::debugLevel(1);
 188         $w = DB_DataObject::factory($this->table);
 189         $total = 0;
 190
 191
 192
 193         $ff = HTML_FlexyFramework::get();
 194
 195
 196         $this->server = DB_DataObject::Factory('core_notify_server')->getCurrent($this);
 197
 198         if (!empty($this->evtype)) {
 199             $w->evtype = $this->evtype;
 200         }
 201
 202
 203
 204         if (!empty($opts['old'])) {
 205             // show old and new...
 206
 207             $w->orderBy('act_when DESC'); // latest first
 208             $w->limit($opts['limit']); // we can run
 209             $total = min($w->count(), $opts['limit']);
 210         } else {
 211             // standard
 212
 213             //$w->whereAdd('act_when > sent'); // eg.. sent is not valid..
 214             $w->whereAdd("sent < '1970-01-01' OR sent IS NULL"); // eg.. sent is not valid..
 215
 216             $w->whereAdd('act_start > NOW() - INTERVAL 14 DAY'); // ignore the ones stuck in the queue
 217             if (!$this->force) {
 218                 $w->whereAdd('act_when < NOW()'); // eg.. not if future..
 219             }
 220
 221             $w->orderBy('act_when ASC'); // oldest first.
 222             $total = min($w->count(), $opts['limit']);
 223             $this->logecho("QUEUE is {$w->count()} only running " . ((int) $opts['limit']));
 224
 225             $w->limit($opts['limit']); // we can run 1000 ...
 226         }
 227
 228
 229
 230
 231
 232
 233         $w->autoJoin();
 234         $total = $w->find();
 235
 236         if (empty($total)) {
 237             $this->logecho("Nothing In Queue - DONE");
 238             exit;
 239         }
 240
 241
 242         if (!empty($opts['list'])) {
 243
 244
 245             while ($w->fetch()) {
 246                 $o = $w->object();
 247
 248
 249                 $this->logecho("{$w->id} : {$w->person()->email} email    : ".
 250                         $o->toEventString()."    ". $w->status()  );
 251             }
 252             exit;
 253         }
 254
 255         //echo "BATCH SIZE: ".  count($ar) . "\n";
 256
 257
 258         while (true) {
 259             // only add if we don't have any queued up..
 260             if (empty($this->queue) && $w->fetch()) {
 261                 $this->queue[] = clone($w);
 262                 $total--;
 263             }
 264
 265             $this->logecho("BATCH SIZE: Queue=".  count($this->queue) . " TOTAL = " . $total  );
 266
 267             if (empty($this->queue)) {
 268                 $this->logecho("COMPLETED MAIN QUEUE - running maxed out domains");
 269                 if ($this->domain_queue !== false) {
 270                     $this->queue  = $this->remainingDomainQueue();
 271
 272                     continue;
 273                 }
 274                 break; // nothing more in queue.. and no remaining one
 275             }
 276
 277
 278             $p = array_shift($this->queue);
 279             if (!$this->poolfree()) {
 280                 array_unshift($this->queue,$p); /// put it back on..
 281                 sleep(3);
 282                 continue;
 283             }
 284             // not sure what happesn if person email and to_email is empty!!?
 285             $email = empty($p->to_email) ? ($p->person() ? $p->person()->email : $p->to_email) : $p->to_email;
 286
 287             $black = $this->server->isBlacklisted($email);
 288             if ($black !== false) {
 289
 290                 if (false === $this->server->updateNotifyToNextServer($p)) {
 291                     $p->updateState("????");
 292                 }
 293
 294                 continue;
 295             }
 296
 297
 298             if ($this->poolHasDomain($email) > $this->max_to_domain) {
 299
 300                 // push it to a 'domain specific queue'
 301                 $this->logecho("REQUEING - maxed out that domain - {$email}");
 302                 $this->pushQueueDomain($p, $email);
 303
 304                 //sleep(3);
 305                 continue;
 306             }
 307
 308
 309             $this->run($p->id,$email);
 310
 311
 312
 313         }
 314         $this->logecho("REQUEUING all emails that maxed out:" . count($this->next_queue));
 315         if (!empty($this->next_queue)) {
 316
 317             foreach($this->next_queue as $p) {
 318                 if (false === $this->server->updateNotifyToNextServer($p)) {
 319                     $p->updateState("????");
 320                 }
 321             }
 322         }
 323
 324
 325         $this->logecho("QUEUE COMPLETE - waiting for pool to end");
 326         // we should have a time limit here...
 327         while(count($this->pool)) {
 328             $this->poolfree();
 329             sleep(3);
 330         }
 331
 332
 333
 334
 335         $this->logecho("DONE");
 336         exit;
 337     }
 338
 339
 340
 341
 342     // this sequentially distributes requeued emails.. - to other servers. (can exclude current one if we have that flagged.)
 343
 344
 345
 346     function generateNotifications()
 347     {
 348         // this should check each module for 'GenerateNotifications.php' class..
 349         //and run it if found..
 350         $ff = HTML_FlexyFramework::get();
 351
 352         $disabled = explode(',', $ff->disable);
 353
 354         $modules = array_reverse($this->modulesList());
 355
 356         // move 'project' one to the end...
 357
 358         foreach ($modules as $module){
 359             if(in_array($module, $disabled)){
 360                 continue;
 361             }
 362             $file = $this->rootDir. "/Pman/$module/GenerateNotifications.php";
 363             if(!file_exists($file)){
 364                 continue;
 365             }
 366
 367             require_once $file;
 368             $class = "Pman_{$module}_GenerateNotifications";
 369             $x = new $class;
 370             if(!method_exists($x, 'generate')){
 371                 continue;
 372             };
 373             //echo "$module\n";
 374             $x->generate($this);
 375         }
 376
 377
 378     }
 379
 380     function assignQueues()
 381     {
 382
 383         DB_DataObject::Factory('core_notify_server')->assignQueues($this);
 384
 385
 386     }
 387
 388     function run($id, $email='', $cmdOpts="")
 389     {
 390
 391         static $renice = false;
 392         if (!$renice) {
 393             require_once 'System.php';
 394             $renice = System::which('renice');
 395         }
 396
 397         // phpinfo();exit;
 398
 399
 400         $tn =  $this->tempName('stdout', true);
 401         $descriptorspec = array(
 402             0 => array("pipe", 'r'),  // stdin is a pipe that the child will read from
 403             1 => array("file", $tn, 'w'),  // stdout is a pipe that the child will write to
 404             2 => array("pipe", "w") // stderr is a file to write to
 405          );
 406
 407         static $php = false;
 408         if (!$php) {
 409             require_once 'System.php';
 410             $php = System::which('php');
 411         }
 412
 413         $sn =  $_SERVER["SCRIPT_NAME"];
 414
 415         $cwd = $sn[0] == '/' ? dirname($sn) : dirname(realpath(getcwd() . '/'. $sn)); // same as run on.. (so script should end up being same relatively..)
 416         $app = $cwd . '/' . basename($_SERVER["SCRIPT_NAME"]) . '  ' . $this->target . '/'. $id;
 417         if ($this->force) {
 418             $app .= ' -f';
 419         }
 420         if (!empty($this->send_to)) {
 421             $app .= ' --sent-to='.escapeshellarg($this->send_to);
 422         }
 423         $cmd = 'exec ' . $php . ' ' . $app . ' ' . $cmdOpts; //. ' &';
 424
 425
 426         $pipe = array();
 427         //$this->logecho("call proc_open $cmd");
 428
 429
 430         if ($this->max_pool_size === 1) {
 431             $this->logecho("call passthru [{$email}] $cmd");
 432             passthru($cmd);
 433             return;
 434         }
 435
 436
 437         if (!empty($this->opts['dryrun'])) {
 438             $this->logecho("DRY RUN");
 439             return;
 440         }
 441
 442         $p = proc_open($cmd, $descriptorspec, $pipes, $cwd );
 443         $info =  proc_get_status($p);
 444
 445         if ($this->nice_level !== false) {
 446             $rcmd = "$renice {$this->nice_level} {$info['pid']}";
 447             `$rcmd`;
 448         }
 449         $this->pool[] = array(
 450                 'proc' => $p,
 451                 'pid' => $info['pid'],
 452                 'out' => $tn,
 453                 'cmd' => $cmd,
 454                 'email' => $email,
 455                 'pipes' => $pipes,
 456                 'notify_id' => $id,
 457                 'started' => time()
 458
 459
 460         );
 461         $this->logecho("RUN [{$email}] ({$info['pid']}) $cmd ");
 462     }
 463
 464     function poolfree()
 465     {
 466         $pool = array();
 467         clearstatcache();
 468
 469         foreach($this->pool as $p) {
 470
 471             //echo "CHECK PID: " . $p['pid'] . "\n";
 472             $info =  proc_get_status($p['proc']);
 473             //var_dump($info);
 474
 475             // update if necessday.
 476             if ($info['pid'] && $p['pid'] != $info['pid']) {
 477                 $this->logecho("CHANING PID FROM " . $p['pid']  .  "  TO ". $info['pid']);
 478                 $p['pid'] = $info['pid'];
 479             }
 480
 481             //echo @file_get_contents('/proc/'. $p['pid'] .'/cmdline') . "\n";
 482
 483             if ($info['running']) {
 484
 485                 //if (file_exists('/proc/'.$p['pid'])) {
 486                 $runtime = time() - $p['started'];
 487                 //echo "RUNTIME ({$p['pid']}): $runtime\n";
 488                 if ($runtime > $this->maxruntime) {
 489
 490                     proc_terminate($p['proc'], 9);
 491                     //fclose($p['pipes'][1]);
 492                     fclose($p['pipes'][0]);
 493                     fclose($p['pipes'][2]);
 494                     $this->logecho("TERMINATING: ({$p['pid']}) {$p['email']} " . $p['cmd'] . " : " . file_get_contents($p['out']));
 495                     @unlink($p['out']);
 496
 497                     // schedule again
 498                     $w = DB_DataObject::factory($this->table);
 499                     $w->get($p['notify_id']);
 500                     $ww = clone($w);
 501                     if ($this->log_events) {
 502                         $this->addEvent('NOTIFY', $w, 'TERMINATED - TIMEOUT');
 503                     }
 504                     $w->act_when = date('Y-m-d H:i:s', strtotime("NOW + {$this->try_again_minutes} MINUTES"));
 505                     $w->update($ww);
 506
 507                     continue;
 508                 }
 509
 510                 $pool[] = $p;
 511                 continue;
 512             }
 513             fclose($p['pipes'][0]);
 514             fclose($p['pipes'][2]);
 515             //echo "CLOSING: ({$p['pid']}) " . $p['cmd'] . " : " . file_get_contents($p['out']) . "\n";
 516             //fclose($p['pipes'][1]);
 517
 518             proc_close($p['proc']);
 519
 520
 521             //clearstatcache();
 522             //if (file_exists('/proc/'.$p['pid'])) {
 523             //    $pool[] = $p;
 524             //    continue;
 525             //}
 526             $this->logecho("ENDED: ({$p['pid']}) {$p['email']} " .  $p['cmd'] . " : " . file_get_contents($p['out']) );
 527             @unlink($p['out']);
 528             // at this point we could pop onto the queue the
 529             $this->popQueueDomain($p['email']);
 530
 531             //unlink($p['out']);
 532         }
 533         $this->logecho("POOL SIZE: ". count($pool) );
 534         $this->pool = $pool;
 535         if (count($pool) < $this->max_pool_size) {
 536             return true;
 537         }
 538         return false;
 539
 540     }
 541     /**
 542      * see if pool is already trying to deliver to this domain.?
 543      * -- if so it get's pushed to the end of the queue.
 544      *
 545      */
 546     function poolHasDomain($email)
 547     {
 548         $ret = 0;
 549         $ea = explode('@',$email);
 550         $dom = strtolower(array_pop($ea));
 551         foreach($this->pool as $p) {
 552             $ea = explode('@',$p['email']);
 553             $mdom = strtolower(array_pop($ea));
 554             if ($mdom == $dom) {
 555                 $ret++;
 556             }
 557         }
 558         return $ret;
 559
 560     }
 561     function popQueueDomain($email)
 562     {
 563         $ea = explode('@',$email);
 564         $dom = strtolower(array_pop($ea));
 565         if (empty($this->domain_queue[$dom])) {
 566             return;
 567         }
 568         array_unshift($this->queue, array_shift($this->domain_queue[$dom]));
 569
 570     }
 571
 572     function pushQueueDomain($e, $email)
 573     {
 574         if ($this->domain_queue === false) {
 575             $this->next_queue[] = $e;
 576             return;
 577         }
 578
 579         $ea = explode('@',$email);
 580         $dom = strtolower(array_pop($ea));
 581         if (!isset($this->domain_queue[$dom])) {
 582             $this->domain_queue[$dom] = array();
 583         }
 584         $this->domain_queue[$dom][] = $e;
 585     }
 586     function remainingDomainQueue()
 587     {
 588         $ret = array();
 589         foreach($this->domain_queue as $dom => $ar) {
 590             $ret = array_merge($ret, $ar);
 591         }
 592         $this->domain_queue = false;
 593         return $ret;
 594     }
 595
 596
 597
 598     function output()
 599     {
 600         $this->logecho("DONE");
 601         exit;
 602     }
 603     function logecho($str)
 604     {
 605         echo date("Y-m-d H:i:s - ") . $str . "\n";
 606     }
 607 }