check what is being written to our log files.
[Pman.Core] / Notify.php
index 6fd34e0..fd58209 100644 (file)
@@ -16,86 +16,474 @@ require_once 'Pman.php';
 class Pman_Core_Notify extends Pman
 {
     
+    static $cli_desc = "Runs the notification queue (usually from cron)
+                        Normally used to sends out emails to anyone in the notification list.
+    
+                        /etc/cron.d/pman-core-notify
+                        * *  * * *     www-data     /usr/bin/php /home/gitlive/web.mtrack/admin.php  Core/Notify > /dev/null
+    
+";
+    
+    static $cli_opts = array(
+        'debug' => array(
+            'desc' => 'Turn on debugging (see DataObjects debugLevel )',
+            'default' => 0,
+            'short' => 'v',
+            'min' => 1,
+            'max' => 1,
+            
+        ),
+        'list' => array(
+            'desc' => 'List message to send, do not send them..',
+            'default' => 0,
+            'short' => 'l',
+            'min' => 0,
+            'max' => 0,
+            
+        ),
+        'old' => array(
+            'desc' => 'Show old messages.. (and new messages...)',
+            'default' => 0,
+            'short' => 'o',
+            'min' => 0,
+            'max' => 0,
+            
+        ),
+        'force' => array(
+            'desc' => 'Force redelivery, even if it has been sent before or not queued...',
+            'default' => 0,
+            'short' => 'f',
+            'min' => 0,
+            'max' => 0,
+        ),
+       /* removed - use GenerateNotifcations.php hooked classes
+         'generate' =>  'Generate notifications for a table, eg. cash_invoice',
+            
+        ),
+        */
+         'limit' => array(
+            'desc' => 'Limit search for no. to send to ',
+            'default' => 1000,
+            'short' => 'L',
+            'min' => 0,
+            'max' => 999,
+        ),
+        'dryrun' => array(
+            'desc' => 'Dry run - do not send.',
+            'default' => 0,
+            'short' => 'D',
+            'min' => 0,
+            'max' => 0,
+        ),
+        'poolsize' => array(
+            'desc' => 'Pool size',
+            'default' => 10,
+            'short' => 'P',
+            'min' => 0,
+            'max' => 100,
+        ),
+    );
+    /**
+     * @var $nice_level Unix 'nice' level to stop it jamming server up.
+     */
+    var $nice_level = false;
+    /**
+     * @var $max_pool_size maximum runners to start at once.
+     */
+    var $max_pool_size = 10;
+    /**
+     * @var $max_to_domain maximum connections to make to a single domain
+     */
+    var $max_to_domain = 10;
+    
+    /**
+     * @var $maxruntime - maximum time a child is allowed to run - defaut 2 minutes
+     */
+    var $maxruntime = 120;
+    
     var $table = 'core_notify';
     var $target = 'Core/NotifySend';
-    
+    var $evtype = ''; // any notification...
+                    // this script should only handle EMAIL notifications..
+    var $force = false;
     function getAuth()
     {
         $ff = HTML_FlexyFramework::get();
         if (!$ff->cli) {
             die("access denied");
         }
-        HTML_FlexyFramework::ensureSingle(__FILE__, $this);
+        HTML_FlexyFramework::ensureSingle($_SERVER["SCRIPT_NAME"] .'|'. __FILE__, $this);
         return true;
-        
     }
     
     var $pool = array();
     
-    function get()    
+    function parseArgs(&$opts)
     {
-        DB_DataObject::debugLevel(1);
+        if ($opts['debug']) {
+            DB_DataObject::debugLevel($opts['debug']);
+            print_r($opts);
+        }
+        $this->opts = $opts;
+        if (!empty($opts['poolsize'])) {
+            $this->max_pool_size = $opts['poolsize'];
+        }
+        
+        if (empty($opts['limit'])) {
+            $opts['limit'] = '1000'; // not sure why it's not picking up the defautl..
+        }
+        
+        if (!empty($opts['old'])) {
+            $opts['list'] = 1; // force listing..
+        }
+        
+        $this->force = empty($opts['force']) ? 0 : 1;
+     
+        if (!empty($opts['send-to'])) {
+            $this->send_to = $opts['send-to'];
+        }
+    }
+    
+    
+    function get($r,$opts=array())    
+    {
+        $this->parseArgs($opts); 
+         
         //date_default_timezone_set('UTC');
-       // phpinfo();exit;
         
+        
+        $this->generateNotifications();
+        
+         
+        //DB_DataObject::debugLevel(1);
         $w = DB_DataObject::factory($this->table);
-        $w->whereAdd('act_when > sent'); // eg.. sent is not valid..
-        $w->orderBy('act_when ASC'); // oldest first.
-        $w->limit(1000); // we can run 1000 ...
-        $ar = $w->fetchAll('id');
+        $total = 0;
+        
+        if (!empty($opts['old'])) {
+            // show old and new...
+            
+            $w->orderBy('act_when DESC'); // latest first
+            $w->limit($opts['limit']); // we can run 
+            $total = min($w->count(), $opts['limit']);
+        } else {   
+            // standard
+            
+            //$w->whereAdd('act_when > sent'); // eg.. sent is not valid..
+            $w->whereAdd("sent < '1970-01-01' OR sent IS NULL"); // eg.. sent is not valid..
+            
+            $w->whereAdd('act_start > NOW() - INTERVAL 14 DAY'); // ignore the ones stuck in the queue
+            if (!$this->force) {
+                $w->whereAdd('act_when < NOW()'); // eg.. not if future..
+            }
+    
+            $w->orderBy('act_when ASC'); // oldest first.
+            $total = min($w->count(), $opts['limit']);
+            $this->logecho("QUEUE is {$w->count()} only running " . ((int) $opts['limit']));
+            
+            $w->limit($opts['limit']); // we can run 1000 ...
+        }
+        
+        if (!empty($this->evtype)) {
+            $w->evtype = $this->evtype;
+        }
+        
+        $w->autoJoin();
+        $w->find();
+        
+        $ar = array(); // $w->fetchAll();
         
+        if (!empty($opts['list'])) {
+            
+            
+            while ($w->fetch()) { 
+                $o = $w->object();
+                
+                
+                $this->logecho("{$w->id} : {$w->person()->email} email    : ".
+                        $o->toEventString()."    ". $w->status()  );
+            }
+            exit;
+        }
+        
+        //echo "BATCH SIZE: ".  count($ar) . "\n";
+        $pushed = array();
+        $requeue = array();
         while (true) {
+            if ($w->fetch()) {
+                $ar[] = clone($w);
+                $total--;
+            }
+            
+            $this->logecho("BATCH SIZE: ".  (count($ar) + $total) );
+            
             if (empty($ar)) {
-                break;
+                $this->logecho("COMPLETED MAIN QUEUE - running deleted");
+                
+                if (empty($pushed)) {
+                    break;
+                }
+                $ar = $pushed;
+                $pushed = false;
+                continue;
             }
+            
+            
+            $p = array_shift($ar);
             if (!$this->poolfree()) {
-                sleep(10);
+                array_unshift($ar,$p); /// put it back on..
+                sleep(3);
                 continue;
             }
-            $p = array_shift($ar);
-            $this->run($p);
+            $email = $p->person() ? $p->person()->email : $p->to_email;
+            
+            if ($this->poolHasDomain($email) > $this->max_to_domain) {
+                
+                if ($pushed === false) {
+                    // we only try once to requeue..
+                    $requeue[] = $p;
+                    continue;
+                }
+                $pushed[] = $p;
+                
+                
+                //sleep(3);
+                continue;
+            }
+            
+            
+            $this->run($p->id,$email);
+            
+            
+            
         }
+        
+        // we should have a time limit here...
         while(count($this->pool)) {
             $this->poolfree();
-            sleep(10);
+             sleep(3);
+        }
+         
+        foreach($requeue as $p) {
+            $pp = clone($p);
+            $p->act_when = $p->sqlValue('NOW + INTERVAL 1 MINUTE');
+            $p->update($pp);
+            
         }
         
-        die("DONE\n");
+        
+        $this->logecho("DONE");
+        exit;
     }
     
-    function run($id)
+    function generateNotifications()
     {
+        // this should check each module for 'GenerateNotifications.php' class..
+        //and run it if found..
+        $ff = HTML_FlexyFramework::get();
+       
+        $disabled = explode(',', $ff->disable);
+
+        $modules = array_reverse($this->modulesList());
+        
+        // move 'project' one to the end...
+        
+        foreach ($modules as $module){
+            if(in_array($module, $disabled)){
+                continue;
+            }
+            $file = $this->rootDir. "/Pman/$module/GenerateNotifications.php";
+            if(!file_exists($file)){
+                continue;
+            }
+            
+            require_once $file;
+            $class = "Pman_{$module}_GenerateNotifications";
+            $x = new $class;
+            if(!method_exists($x, 'generate')){
+                continue;
+            };
+            //echo "$module\n";
+            $x->generate($this);
+        }
+                
+    
+    }
+    
+    
+    
+    function run($id, $email, $cmdOpts="")
+    {
+        
+        static $renice = false;
+        if (!$renice) {
+            require_once 'System.php';
+            $renice = System::which('renice');
+        }
+        
+        // phpinfo();exit;
+        $tnx = tempnam(ini_get('session.save_path'),'stdout');
+        unlink($tnx);
+        $tn =  $tnx . '.stdout';
         $descriptorspec = array(
-            0 => array("file", "/dev/null", 'r'),  // stdin is a pipe that the child will read from
-            1 => array("file", "/dev/null", 'a'),  // stdout is a pipe that the child will write to
-            2 => array("file", "/dev/null", "a") // stderr is a file to write to
+            0 => array("pipe", 'r'),  // stdin is a pipe that the child will read from
+            1 => array("file", $tn, 'w'),  // stdout is a pipe that the child will write to
+            2 => array("pipe", "w") // stderr is a file to write to
          );
-        $php = $_SERVER["_"];
-        $cwd = getcwd(); // same as run on.. (so script should end up being same relatively..)
-        $app = $cwd . '/'. $_SERVER["SCRIPT_NAME"] . '  ' . $this->target . '/'. $id;
-        $cmd = $php . ' ' . $app;
-        echo $cmd . "\n";
+        
+        static $php = false;
+        if (!$php) {
+            require_once 'System.php';
+            $php = System::which('php');
+        }
+        
+        $sn =  $_SERVER["SCRIPT_NAME"];
+        
+        $cwd = $sn[0] == '/' ? dirname($sn) : dirname(realpath(getcwd() . '/'. $sn)); // same as run on.. (so script should end up being same relatively..)
+        $app = $cwd . '/' . basename($_SERVER["SCRIPT_NAME"]) . '  ' . $this->target . '/'. $id;
+        if ($this->force) {
+            $app .= ' -f';
+        }
+        if (!empty($this->send_to)) {
+            $app .= ' --sent-to='.escapeshellarg($this->send_to);
+        }
+        $cmd = 'exec ' . $php . ' ' . $app . ' ' . $cmdOpts; //. ' &';
+        
+       
         $pipe = array();
+        $this->logecho("call proc_open $cmd");
+        
+        
+        if ($this->max_pool_size === 1) {
+            passthru($cmd);
+            return;
+        }
+        
+        
+        if (!empty($this->opts['dryrun'])) {
+            $this->logecho("DRY RUN");
+            return;
+        }
+        
         $p = proc_open($cmd, $descriptorspec, $pipes, $cwd );
-        $this->pool[] = $p;
+        $info =  proc_get_status($p);
+        
+        if ($this->nice_level !== false) { 
+            $rcmd = "$renice {$this->nice_level} {$info['pid']}";
+            `$rcmd`;
+        } 
+        $this->pool[] = array(
+                'proc' => $p,
+                'pid' => $info['pid'],
+                'out' => $tn,
+                'cmd' => $cmd,
+                'email' => $email,
+                'pipes' => $pipes,
+                'notify_id' => $id,
+                'started' => time()
+            
+                
+        );
+        $this->logecho("RUN ({$info['pid']}) $cmd ");
     }
     
-    function poolfree() {
+    function poolfree()
+    {
         $pool = array();
+        clearstatcache();
+         
         foreach($this->pool as $p) {
-            $ar = proc_get_Status($p);
-            var_dump($ar);
-            if ($p['running']) {
+             
+            //echo "CHECK PID: " . $p['pid'] . "\n";
+            $info =  proc_get_status($p['proc']);
+            //var_dump($info);
+            
+            // update if necessday.
+            if ($info['pid'] && $p['pid'] != $info['pid']) {
+                $this->logecho("CHANING PID FROM " . $p['pid']  .  "  TO ". $info['pid']);
+                $p['pid'] = $info['pid'];
+            }
+            
+            //echo @file_get_contents('/proc/'. $p['pid'] .'/cmdline') . "\n";
+            
+            if ($info['running']) {
+            
+                //if (file_exists('/proc/'.$p['pid'])) {
+                $runtime = time() - $p['started'];
+                //echo "RUNTIME ({$p['pid']}): $runtime\n";
+                if ($runtime > $this->maxruntime) {
+                    
+                    proc_terminate($p['proc'], 9);
+                    //fclose($p['pipes'][1]);
+                    fclose($p['pipes'][0]);
+                    fclose($p['pipes'][2]);
+                    $this->logecho("TERMINATING: ({$p['pid']}) " . $p['cmd'] . " : " . file_get_contents($p['out']));
+                    @unlink($p['out']);
+                    
+                    $w = DB_DataObject::factory($this->table);
+                    $w->get($p['notify_id']);
+                    $ww = clone($w);
+                    $this->addEvent('NOTIFY', $w, 'TERMINATED - TIMEOUT');
+                    $w->act_when = date('Y-m-d H:i:s', strtotime('NOW + 30  MINUTES'));
+                    $w->update($ww);
+                    
+                    
+                    continue;
+                }
+                
                 $pool[] = $p;
+                continue;
             }
+            fclose($p['pipes'][0]);
+            fclose($p['pipes'][2]);
+            //echo "CLOSING: ({$p['pid']}) " . $p['cmd'] . " : " . file_get_contents($p['out']) . "\n";
+            //fclose($p['pipes'][1]);
+            
+            proc_close($p['proc']);
+            
+            
+            //clearstatcache();
+            //if (file_exists('/proc/'.$p['pid'])) {
+            //    $pool[] = $p;
+            //    continue;
+            //}
+            $this->logecho("ENDED: ({$p['pid']}) " .  $p['cmd'] . " : " . file_get_contents($p['out']) );
+            @unlink($p['out']);
+            //unlink($p['out']);
         }
+        $this->logecho("POOL SIZE: ". count($pool) );
         $this->pool = $pool;
-        if (count($pool) < 10) {
+        if (count($pool) < $this->max_pool_size) {
             return true;
         }
         return false;
         
     }
-    
-    
+    /**
+     * see if pool is already trying to deliver to this domain.?
+     * -- if so it get's pushed to the end of the queue.
+     *
+     */
+    function poolHasDomain($email)
+    {
+        $ret = 0;
+        $dom = strtolower(array_pop(explode('@',$email)));
+        foreach($this->pool as $p) {
+            $mdom = strtolower(array_pop(explode('@',$p['email'])));
+            if ($mdom == $dom) {
+                $ret++;
+            }
+        }
+        return $ret;
+        
+    }
+
+    function output()
+    {
+        $this->logecho("DONE");
+        exit;
+    }
+    function logecho($str)
+    {
+        echo date("Y-m-d H:i:s - ") . $str . "\n";
+    }
 }
\ No newline at end of file