2 require_once 'Pman.php';
5 * notification script runner
7 * This does not actualy send stuf out, it only starts the NotifySend/{id}
8 * which does the actuall notifcations.
10 * It manages a pool of notifiers.
16 class Pman_Core_Notify extends Pman
19 static $cli_desc = "Runs the notification queue (usually from cron)
20 Normally used to sends out emails to anyone in the notification list.
22 /etc/cron.d/pman-core-notify
23 * * * * * www-data /usr/bin/php /home/gitlive/web.mtrack/admin.php Core/Notify > /dev/null
27 static $cli_opts = array(
29 'desc' => 'Turn on debugging (see DataObjects debugLevel )',
37 'desc' => 'List message to send, do not send them..',
45 'desc' => 'Show old messages.. (and new messages...)',
53 'desc' => 'Force redelivery, even if it has been sent before or not queued...',
59 /* removed - use GenerateNotifcations.php hooked classes
60 'generate' => 'Generate notifications for a table, eg. cash_invoice',
65 'desc' => 'Limit search for no. to send to ',
72 'desc' => 'Dry run - do not send.',
79 'desc' => 'Pool size',
87 * @var $nice_level Unix 'nice' level to stop it jamming server up.
89 var $nice_level = false;
91 * @var $max_pool_size maximum runners to start at once.
93 var $max_pool_size = 10;
95 * @var $max_to_domain maximum connections to make to a single domain
97 var $max_to_domain = 10;
100 * @var $maxruntime - maximum seconds a child is allowed to run - defaut 2 minutes
102 var $maxruntime = 120;
105 * @var {Boolean} log_events - default true if events should be logged.
107 var $log_events = true;
109 * @var {Number} try_again_minutes how long after failing to try again default = 30 if max runtime fails
111 var $try_again_minutes = 30;
114 * @var {String} table - the table that the class will query for notification events
116 var $table = 'core_notify';
118 * @var {String} target - the application that will run for each Row in the table (eg. Pman/Core/NotifySend)
120 var $target = 'Core/NotifySend';
124 var $evtype = ''; // any notification...
125 // this script should only handle EMAIL notifications..
131 $ff = HTML_FlexyFramework::get();
133 die("access denied");
135 HTML_FlexyFramework::ensureSingle($_SERVER["SCRIPT_NAME"] .'|'. __FILE__ .'|'. (empty($_SERVER['argv'][1]) ? '': $_SERVER['argv'][1]), $this);
141 function parseArgs(&$opts)
143 if ($opts['debug']) {
144 DB_DataObject::debugLevel($opts['debug']);
148 if (!empty($opts['poolsize'])) {
149 $this->max_pool_size = $opts['poolsize'];
152 if (empty($opts['limit'])) {
153 $opts['limit'] = '1000'; // not sure why it's not picking up the defautl..
156 if (!empty($opts['old'])) {
157 $opts['list'] = 1; // force listing..
160 $this->force = empty($opts['force']) ? 0 : 1;
162 if (!empty($opts['send-to'])) {
163 $this->send_to = $opts['send-to'];
167 var $queue = array();
168 var $domain_queue = array(); // false to use nextquee
169 var $next_queue = array();
171 function get($r,$opts=array())
173 $this->parseArgs($opts);
175 //date_default_timezone_set('UTC');
178 $this->generateNotifications();
180 $this->assignQueues();
182 //DB_DataObject::debugLevel(1);
183 $w = DB_DataObject::factory($this->table);
186 if (!empty($opts['old'])) {
187 // show old and new...
189 $w->orderBy('act_when DESC'); // latest first
190 $w->limit($opts['limit']); // we can run
191 $total = min($w->count(), $opts['limit']);
195 //$w->whereAdd('act_when > sent'); // eg.. sent is not valid..
196 $w->whereAdd("sent < '1970-01-01' OR sent IS NULL"); // eg.. sent is not valid..
198 $w->whereAdd('act_start > NOW() - INTERVAL 14 DAY'); // ignore the ones stuck in the queue
200 $w->whereAdd('act_when < NOW()'); // eg.. not if future..
203 $w->orderBy('act_when ASC'); // oldest first.
204 $total = min($w->count(), $opts['limit']);
205 $this->logecho("QUEUE is {$w->count()} only running " . ((int) $opts['limit']));
207 $w->limit($opts['limit']); // we can run 1000 ...
210 if (!empty($this->evtype)) {
211 $w->evtype = $this->evtype;
214 $ff = HTML_FlexyFramework::get();
215 if (!empty($ff->Core_Notify['servers'])) {
216 if (!isset($ff->Core_Notify['servers'][gethostname()])) {
217 $this->jerr("Core_Notify['servers']['" . gethostname() ."'] is not set");
219 $w->server_id = array_search(gethostname(),array_keys($ff->Core_Notify['servers']));
230 if (!empty($opts['list'])) {
233 while ($w->fetch()) {
237 $this->logecho("{$w->id} : {$w->person()->email} email : ".
238 $o->toEventString()." ". $w->status() );
243 //echo "BATCH SIZE: ". count($ar) . "\n";
247 // only add if we don't have any queued up..
248 if (empty($this->queue) && $w->fetch()) {
249 $this->queue[] = clone($w);
253 $this->logecho("BATCH SIZE: Queue=". count($this->queue) . " TOTAL = " . $total );
255 if (empty($this->queue)) {
256 $this->logecho("COMPLETED MAIN QUEUE - running maxed out domains");
257 if ($this->domain_queue !== false) {
258 $this->queue = $this->remainingDomainQueue();
262 break; // nothing more in queue.. and no remaining one
266 $p = array_shift($this->queue);
267 if (!$this->poolfree()) {
268 array_unshift($this->queue,$p); /// put it back on..
272 $email = $p->person() ? $p->person()->email : $p->to_email;
274 if ($this->poolHasDomain($email) > $this->max_to_domain) {
276 // push it to a 'domain specific queue'
277 $this->logecho("REQUEING - maxed out that domain - {$email}");
278 $this->pushQueueDomain($p, $email);
286 $this->run($p->id,$email);
291 $this->logecho("REQUEUING all emails that maxed out:" . count($this->next_queue));
292 if (!empty($this->next_queue)) {
294 foreach($this->next_queue as $p) {
296 $p->act_when = $p->sqlValue('NOW + INTERVAL 1 MINUTE');
297 $this->updateServer($p);
304 $this->logecho("QUEUE COMPLETE - waiting for pool to end");
305 // we should have a time limit here...
306 while(count($this->pool)) {
314 $this->logecho("DONE");
318 // this sequentially distributes requeued emails.. - to other servers.
319 function updateServer($w)
321 $ff = HTML_FlexyFramework::get();
323 if (empty($ff->Core_Notify['servers'])) {
328 $w->server_id = $num % count(array_keys($ff->Core_Notify['servers']));
333 function generateNotifications()
335 // this should check each module for 'GenerateNotifications.php' class..
336 //and run it if found..
337 $ff = HTML_FlexyFramework::get();
339 $disabled = explode(',', $ff->disable);
341 $modules = array_reverse($this->modulesList());
343 // move 'project' one to the end...
345 foreach ($modules as $module){
346 if(in_array($module, $disabled)){
349 $file = $this->rootDir. "/Pman/$module/GenerateNotifications.php";
350 if(!file_exists($file)){
355 $class = "Pman_{$module}_GenerateNotifications";
357 if(!method_exists($x, 'generate')){
367 function assignQueues()
369 $ff = HTML_FlexyFramework::get();
371 if (empty($ff->Core_Notify['servers'])) {
375 $num_servers = count(array_keys($ff->Core_Notify['servers']));
376 $p = DB_DataObject::factory($this->table);
377 // 6 seconds on this machne...
382 server_id = ((@row_number := CASE WHEN @row_number IS NULL THEN 0 ELSE @row_number END +1) % {$num_servers})
400 function run($id, $email='', $cmdOpts="")
403 static $renice = false;
405 require_once 'System.php';
406 $renice = System::which('renice');
412 $tn = $this->tempName('stdout', true);
413 $descriptorspec = array(
414 0 => array("pipe", 'r'), // stdin is a pipe that the child will read from
415 1 => array("file", $tn, 'w'), // stdout is a pipe that the child will write to
416 2 => array("pipe", "w") // stderr is a file to write to
421 require_once 'System.php';
422 $php = System::which('php');
425 $sn = $_SERVER["SCRIPT_NAME"];
427 $cwd = $sn[0] == '/' ? dirname($sn) : dirname(realpath(getcwd() . '/'. $sn)); // same as run on.. (so script should end up being same relatively..)
428 $app = $cwd . '/' . basename($_SERVER["SCRIPT_NAME"]) . ' ' . $this->target . '/'. $id;
432 if (!empty($this->send_to)) {
433 $app .= ' --sent-to='.escapeshellarg($this->send_to);
435 $cmd = 'exec ' . $php . ' ' . $app . ' ' . $cmdOpts; //. ' &';
439 //$this->logecho("call proc_open $cmd");
442 if ($this->max_pool_size === 1) {
443 this->logecho("call passthru [{$email}] $cmd");
449 if (!empty($this->opts['dryrun'])) {
450 $this->logecho("DRY RUN");
454 $p = proc_open($cmd, $descriptorspec, $pipes, $cwd );
455 $info = proc_get_status($p);
457 if ($this->nice_level !== false) {
458 $rcmd = "$renice {$this->nice_level} {$info['pid']}";
461 $this->pool[] = array(
463 'pid' => $info['pid'],
473 $this->logecho("RUN [{$email}] ({$info['pid']}) $cmd ");
481 foreach($this->pool as $p) {
483 //echo "CHECK PID: " . $p['pid'] . "\n";
484 $info = proc_get_status($p['proc']);
487 // update if necessday.
488 if ($info['pid'] && $p['pid'] != $info['pid']) {
489 $this->logecho("CHANING PID FROM " . $p['pid'] . " TO ". $info['pid']);
490 $p['pid'] = $info['pid'];
493 //echo @file_get_contents('/proc/'. $p['pid'] .'/cmdline') . "\n";
495 if ($info['running']) {
497 //if (file_exists('/proc/'.$p['pid'])) {
498 $runtime = time() - $p['started'];
499 //echo "RUNTIME ({$p['pid']}): $runtime\n";
500 if ($runtime > $this->maxruntime) {
502 proc_terminate($p['proc'], 9);
503 //fclose($p['pipes'][1]);
504 fclose($p['pipes'][0]);
505 fclose($p['pipes'][2]);
506 $this->logecho("TERMINATING: ({$p['pid']}) " . $p['cmd'] . " : " . file_get_contents($p['out']));
510 $w = DB_DataObject::factory($this->table);
511 $w->get($p['notify_id']);
513 if ($this->log_events) {
514 $this->addEvent('NOTIFY', $w, 'TERMINATED - TIMEOUT');
516 $w->act_when = date('Y-m-d H:i:s', strtotime("NOW + {$this->try_again_minutes} MINUTES"));
525 fclose($p['pipes'][0]);
526 fclose($p['pipes'][2]);
527 //echo "CLOSING: ({$p['pid']}) " . $p['cmd'] . " : " . file_get_contents($p['out']) . "\n";
528 //fclose($p['pipes'][1]);
530 proc_close($p['proc']);
534 //if (file_exists('/proc/'.$p['pid'])) {
538 $this->logecho("ENDED: ({$p['pid']}) " . $p['cmd'] . " : " . file_get_contents($p['out']) );
540 // at this point we could pop onto the queue the
541 $this->popQueueDomain($p['email']);
545 $this->logecho("POOL SIZE: ". count($pool) );
547 if (count($pool) < $this->max_pool_size) {
554 * see if pool is already trying to deliver to this domain.?
555 * -- if so it get's pushed to the end of the queue.
558 function poolHasDomain($email)
561 $ea = explode('@',$email);
562 $dom = strtolower(array_pop($ea));
563 foreach($this->pool as $p) {
564 $ea = explode('@',$p['email']);
565 $mdom = strtolower(array_pop($ea));
573 function popQueueDomain($email)
575 $ea = explode('@',$email);
576 $dom = strtolower(array_pop($ea));
577 if (empty($this->domain_queue[$dom])) {
580 array_unshift($this->queue, array_shift($this->domain_queue[$dom]));
584 function pushQueueDomain($e, $email)
586 if ($this->domain_queue === false) {
587 $this->next_queue[] = $e;
591 $ea = explode('@',$email);
592 $dom = strtolower(array_pop($ea));
593 if (!isset($this->domain_queue[$dom])) {
594 $this->domain_queue[$dom] = array();
596 $this->domain_queue[$dom][] = $e;
598 function remainingDomainQueue()
601 foreach($this->domain_queue as $dom => $ar) {
602 $ret = array_merge($ret, $ar);
604 $this->domain_queue = false;
612 $this->logecho("DONE");
615 function logecho($str)
617 echo date("Y-m-d H:i:s - ") . $str . "\n";