NotifySend.php
[Pman.Core] / NotifySend.php
1 <?php
2 require_once 'Pman.php';
3
4 /**
5  * notification script sender - designed to be run by the Notify script - with many children running
6  * in parallel.
7  *
8  * called with an id of a core_notify element
9  *
10  * uses core_notify - to find an event to object and person.
11  *
12  * uses Events table to log failures
13  * 
14  * 
15  * calls $object->toEmail($person,$last_send, $notify) to generate an email struct with
16  *  array (
17  *      headers =>
18  *      recipients =>
19  *      body =>
20  *  )
21  *
22  *
23  * Note uses configuration
24  *
25  * Pman_Core_NotifySend[host] = 'localhost' << to override direct sending..
26  * Mail[helo] << helo host name
27  * Mail[socket_options] << any socket option.
28  */
29
30
31 class Pman_Core_NotifySend extends Pman
32 {
33     static $cli_desc = "Send out single notification email (usually called from  Core/Notify)";
34     
35     static $cli_opts = array(
36         'debug' => array(
37             'desc' => 'Turn on debugging (see DataObjects debugLevel )',
38             'default' => 0,
39             'short' => 'v',
40             'min' => 0,
41             'max' => 0,
42             
43         ),
44         'DB_DataObject-debug' => array(
45             'desc' => 'Turn on debugging (see DataObjects debugLevel )',
46             'default' => 0,
47             'short' => 'd',
48             'min' => 1,
49             'max' => 1,
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         'send-to' => array(
60             'desc' => 'Send the message to this address, rather than the one listed.',
61             'default' => '',
62             'short' => 't',
63             'min' => 0,
64             'max' => 1,
65         )
66         
67         
68         
69     );
70     var $table = 'core_notify';
71     function getAuth()
72     {
73         $ff = HTML_FlexyFramework::get();
74         if (!$ff->cli) {
75             die("access denied");
76         }
77         //HTML_FlexyFramework::ensureSingle(__FILE__, $this);
78         return true;
79         
80     }
81    
82     function get($id,$opts)
83     {
84         
85         //print_r($opts);
86         if ($opts['DB_DataObject-debug']) {
87             DB_DataObject::debugLevel($opts['DB_DataObject-debug']);
88         }
89         //DB_DataObject::debugLevel(1);
90         //date_default_timezone_set('UTC');
91         // phpinfo();exit;
92         $force = empty($opts['force']) ? 0 : 1;
93         
94         $w = DB_DataObject::factory($this->table);
95         
96         if (!$w->get($id)) {
97             die("invalid id\n");
98         }
99         if (!$force && strtotime($w->act_when) < strtotime($w->sent)) {
100             
101             
102             die("send repeat to early\n");
103         }
104         if (!empty($opts['debug'])) {
105             print_r($w);
106         }
107         
108         $sent = (empty($w->sent) || preg_match('/^0000/', $w->sent)) ? false : true;
109         
110         if (!$force && (!empty($w->msgid) || $sent)) {
111             $ww = clone($w);
112             if (!$sent) { 
113                 $w->sent = $w->sqlValue("NOW()");
114                 $w->update($ww);
115             }    
116             die("message has been sent already.\n");
117         }
118         
119         $o = $w->object();
120         
121         if ($o === false)  {
122             
123             $ev = $this->addEvent('NOTIFY', $w,
124                             "Notification event cleared (underlying object does not exist)" );;
125             $ww = clone($w);
126             $w->sent = date('Y-m-d H:i:s');
127             $w->msgid = '';
128             $w->event_id = $ev->id;
129             $w->update($ww);
130             die(date('Y-m-d h:i:s ') . 
131                      "Notification event cleared (underlying object does not exist)" 
132                     ."\n");
133         }
134      
135         
136         
137         $p = $w->person();
138         
139         if (isset($p->active) && empty($p->active)) {
140             $ev = $this->addEvent('NOTIFY', $w,
141                             "Notification event cleared (not user not active any more)" );;
142             $ww = clone($w);
143             $w->sent = date('Y-m-d H:i:s');
144             $w->msgid = '';
145             $w->event_id = $ev->id;
146             $w->update($ww);
147             die(date('Y-m-d h:i:s ') . 
148                      "Notification event cleared (not user not active any more)" 
149                     ."\n");
150             die("message has been sent already.\n");
151         }
152         
153         
154         // let's work out the last notification sent to this user..
155         $l = DB_DataObject::factory($this->table);
156         $l->setFrom( array(
157                 'ontable' => $w->ontable,
158                 'onid' => $w->onid,
159                 'person_id' => $w->person_id,
160         ));        
161         $l->whereAdd('id != '. $w->id);
162         $l->orderBy('sent DESC');
163         $l->limit(1);
164         $ar = $l->fetchAll('sent');
165         $last = empty($ar) ? date('Y-m-d H:i:s', 0) : $ar[0];
166         
167         // find last event..
168         $ev = DB_DataObject::factory('Events');
169         $ev->on_id = $w->id;                           // int(11)
170         $ev->on_table = $this->table;
171         $ev->limit(1);
172         $ev->orderBy('event_when DESC');
173         $ar = $ev->fetchAll('event_when');
174         $last_event = empty($ar) ? 0 : $ar[0];
175         $next_try_min = 5;
176         if ($last_event) {
177             $next_try_min = floor((time() - strtotime($last_event)) / 60) * 2;
178         }
179         $next_try = $next_try_min . ' MINUTES';
180          
181         // this may modify $p->email. (it will not update it though)
182         $email =  $this->makeEmail($o, $p, $last, $w, $force);
183         
184         if ($email === true)  {
185             
186             $ev = $this->addEvent('NOTIFY', $w,
187                             "Notification event cleared (not required any more)" );;
188             $ww = clone($w);
189             $w->sent = date('Y-m-d H:i:s');
190             $w->msgid = '';
191             $w->event_id = $ev->id;
192             $w->update($ww);
193             die(date('Y-m-d h:i:s ') . 
194                      "Notification event cleared (not required any more)" 
195                     ."\n");
196         }
197      
198        
199         
200         if ($email === false || isset($email['error'])) {
201             // object returned 'false' - it does not know how to send it..
202             $ev = $this->addEvent('NOTIFY', $w, isset($email['error'])  ?
203                             $email['error'] : "INTERNAL ERROR  - We can not handle " . $w->ontable); 
204             $ww = clone($w);
205             $w->sent = date('Y-m-d H:i:s');
206             $w->msgid = '';
207             $w->event_id = $ev->id;
208             $w->update($ww);
209             die(date('Y-m-d h:i:s ') . 
210                     (isset($email['error'])  ?
211                             $email['error'] : "INTERNAL ERROR  - We can not handle " . $w->ontable)
212                     ."\n");
213         }
214         
215         
216         if (isset($email['later'])) {
217             $old = clone($w);
218             $w->act_when = $email['later'];
219             $w->update($old);
220             die(date('Y-m-d h:i:s ') . " Delivery postponed by email creator");
221         }
222         
223          
224         if (empty($email['headers']['Message-Id'])) {
225             $HOST = gethostname();
226             $email['headers']['Message-Id'] = "<{$this->table}-{$id}@{$HOST}>";
227             
228         }
229         //$p->email = 'alan@akbkhome.com'; //for testing..
230         //print_r($email);exit;
231         // should we fetch the watch that caused it.. - which should contain the method to call..
232         // --send-to=test@xxx.com
233        
234         if (!empty($email['send-to'])) {
235             print_r($email);exit;
236             $p->email = $email['send-to'];
237         }
238          if (!empty($opts['send-to'])) {
239             $p->email = $opts['send-to'];
240         }
241         // since some of them have spaces?!?!
242         $p->email = trim($p->email);
243         
244         
245         require_once 'Validate.php';
246         if (!Validate::email($p->email, true)) {
247             $ev = $this->addEvent('NOTIFY', $w, "INVALID ADDRESS: " . $p->email);
248             $ww = clone($w);
249             $w->sent = date('Y-m-d H:i:s');
250             $w->msgid = '';
251             $w->event_id = $ev->id;
252             $w->update($ww);
253             die(date('Y-m-d h:i:s ') . "INVALID ADDRESS: " . $p->email. "\n");
254             
255         }
256         
257         
258         $ff = HTML_FlexyFramework::get();
259         
260         
261         $dom = array_pop(explode('@', $p->email));
262         
263         $mxs = $this->mxs($dom);
264         $ww = clone($w);
265
266         // we might fail doing this...
267         // need to handle temporary failure..
268        
269         
270           // we try for 3 days..
271         $retry = 5;
272         if (strtotime($w->act_start) <  strtotime('NOW - 1 HOUR')) {
273             // older that 1 hour.
274             $retry = 15;
275         }
276         
277         if (strtotime($w->act_start) <  strtotime('NOW - 1 DAY')) {
278             // older that 1 day.
279             $retry = 60;
280         }
281         if (strtotime($w->act_start) <  strtotime('NOW - 2 DAY')) {
282             // older that 1 day.
283             $retry = 120;
284         }
285         
286         if ($mxs === false) {
287             // only retry for 2 day son the MX issue..
288             if ($retry < 120) {
289                 $this->addEvent('NOTIFY', $w, 'MX LOOKUP FAILED ' . $dom . ' ' . $res->toString());
290                 $w->act_when = date('Y-m-d H:i:s', strtotime('NOW + ' . $retry . ' MINUTES'));
291                 $w->update($ww);
292                 die(date('Y-m-d h:i:s') . " - GREYLISTED\n");
293             }
294             
295             $ev = $this->addEvent('NOTIFY', $w, "BAD ADDRESS - ". $p->email );
296             $w->sent = date('Y-m-d H:i:s');
297             $w->msgid = '';
298             $w->event_id = $ev->id;
299             $w->update($ww);
300             die(date('Y-m-d h:i:s') . " - FAILED -  BAD EMAIL - {$p->email} \n");
301             
302             
303         }
304         
305         
306         
307         
308         if (!$force && strtotime($w->act_start) <  strtotime('NOW - 14 DAY')) {
309             $ev = $this->addEvent('NOTIFY', $w, "BAD ADDRESS - ". $p->email );
310             $w->sent = date('Y-m-d H:i:s');
311             $w->msgid = '';
312             $w->event_id = $ev->id;
313             $w->update($ww);
314             die(date('Y-m-d h:i:s') . " - FAILED -  GAVE UP TO OLD - {$p->email} \n");
315         }
316         
317         
318         
319         $w->to_email = $p->email; 
320         //$this->addEvent('NOTIFY', $w, 'GREYLISTED ' . $p->email . ' ' . $res->toString());
321         $w->act_when = date('Y-m-d H:i:s', strtotime('NOW + ' . $retry . ' MINUTES'));
322         $w->update($ww);
323         
324         $ww = clone($w);   
325         
326         $fail = false;
327         require_once 'Mail.php';
328         
329         foreach($mxs as $dom) {
330             
331             
332             
333             if (!isset($ff->Mail['helo'])) {
334                 die("config Mail[helo] is not set");
335             }
336             $this->debug_str = '';
337             $this->debug("Trying SMTP: $dom / HELO {$ff->Mail['helo']}");
338             $mailer = Mail::factory('smtp', array(
339                     'host'    => $dom ,
340                     'localhost' => $ff->Mail['helo'],
341                     'timeout' => 15,
342                     'socket_options' =>  isset($ff->Mail['socket_options']) ? $ff->Mail['socket_options'] : null,
343                     //'debug' => isset($opts['debug']) ?  1 : 0,
344                     'debug' => 1,
345                     'debug_handler' => array($this, 'debugHandler')
346                 ));
347             $res = $mailer->send($p->email, $email['headers'], $email['body']);
348              
349             
350             if ($res === true) {
351                 // success....
352                 
353                 $ev = $this->addEvent('NOTIFYSENT', $w, "{$w->to_email} - {$email['headers']['Subject']}");
354                 
355                 $ev->writeEventLog($this->debug_str);
356                 
357                 $w->sent = date('Y-m-d H:i:s');
358                 $w->msgid = $email['headers']['Message-Id'];
359                 $w->event_id = $ev->id; // sent ok.. - no need to record it..
360                 $w->update($ww);
361                 
362                 // enable cc in notify..
363                 if (!empty($email['headers']['Cc'])) {
364                     $mailer = Mail::factory('smtp', array(
365                        //'host'    => $dom ,
366                       //  'debug' => true
367                     ));
368                     $email['headers']['Subject'] = "(CC): " . $email['headers']['Subject'];
369                     $mailer->send($email['headers']['Cc'],
370                                   $email['headers'], $email['body']);
371                     
372                 }
373                 
374                 if (!empty($email['bcc'])) {
375                     $mailer = Mail::factory('smtp', array(
376                        //'host'    => $dom ,
377                       //  'debug' => true
378                     ));
379                     $email['headers']['Subject'] = "(CC): " . $email['headers']['Subject'];
380                     $mailer->send($email['bcc'],
381                                   $email['headers'], $email['body']);
382                     
383                 }
384                 
385                 
386                 die(date('Y-m-d h:i:s') . " - SENT\n");
387             }
388             // what type of error..
389             $code = empty($res->userinfo['smtpcode']) ? -1 : $res->userinfo['smtpcode'];
390             if (!empty($res->code) && $res->code == 10001) {
391                 // fake greylist if timed out.
392                 $code = 421;
393             }
394             
395             if ($code < 0) {
396                 $this->debug($res->message);
397                 continue; // try next mx... ??? should we wait??? - nope we did not even connect..
398             }
399             // give up after 2 days..
400             if (in_array($code, array( 421, 450, 451, 452))   && $next_try_min < (2*24*60)) {
401                 // try again later..
402                 // check last event for this item..
403                 $errmsg=  $fail ? ($res->userinfo['smtpcode'] . ': ' .$res->toString()) :  " - UNKNOWN ERROR";
404                 if (isset($res->userinfo['smtptext'])) {
405                     $errmsg=  $res->userinfo['smtpcode'] . ':' . $res->userinfo['smtptext'];
406                 }
407                 //print_r($res);
408                 $this->addEvent('NOTIFY', $w, 'GREYLISTED - ' . $errmsg);
409                 $w->act_when = date('Y-m-d H:i:s', strtotime('NOW + ' . $retry . ' MINUTES'));
410                 $w->update($ww);
411                 die(date('Y-m-d h:i:s') . " - GREYLISTED\n");
412             }
413             $fail = true;
414             break;
415         }
416         if ($fail || $next_try_min > (2*24*60)) {
417         // fail.. = log and give up..
418             $errmsg=  $fail ? ($res->userinfo['smtpcode'] . ': ' .$res->toString()) :  " - UNKNOWN ERROR";
419             if (isset($res->userinfo['smtptext'])) {
420                 $errmsg=  $res->userinfo['smtpcode'] . ':' . $res->userinfo['smtptext'];
421             }
422             
423             $ev = $this->addEvent('NOTIFY', $w, ($fail ? "FAILED - " : "RETRY TIME EXCEEDED - ") .
424                        $errmsg);
425             $w->sent = date('Y-m-d H:i:s');
426             $w->msgid = '';
427             $w->event_id = $ev->id;
428             $w->update($ww);
429             die(date('Y-m-d h:i:s') . ' - FAILED - '. ($fail ? $res->toString() : "RETRY TIME EXCEEDED\n"));
430         }
431         
432         // handle no host availalbe forever...
433         if (strtotime($w->act_start) < strtotime('NOW - 3 DAYS')) {
434             $ev = $this->addEvent('NOTIFY', $w, "RETRY TIME EXCEEDED - ". $p->email);
435             $w->sent = date('Y-m-d H:i:s');
436             $w->msgid = '';
437             $w->event_id = $ev->id;
438             $w->update($ww);
439             die(date('Y-m-d h:i:s') . " - FAILED - RETRY TIME EXCEEDED\n");
440             
441             
442         }
443         
444         
445         $this->addEvent('NOTIFY', $w, 'NO HOST CAN BE CONTACTED:' . $p->email);
446         $w->act_when = date('Y-m-d H:i:s', strtotime('NOW + 5 MINUTES'));
447         $w->update($ww);
448         die(date('Y-m-d h:i:s') ." - NO HOST AVAILABLE\n");
449
450         
451     }
452     function mxs($fqdn)
453     {
454         $ff = HTML_FlexyFramework::get();
455         if (isset($ff->Pman_Core_NotifySend['host'])) {
456             return array($ff->Pman_Core_NotifySend['host']);
457         }
458         
459         $mx_records = array();
460         $mx_weight = array();
461         $mxs = array();
462         if (!getmxrr($fqdn, $mx_records, $mx_weight)) {
463             if (!checkdnsrr($fqdn)) {
464                 return false;
465             }
466             return array($fqdn);
467         }
468         
469         asort($mx_weight,SORT_NUMERIC);
470         
471         foreach($mx_weight as $k => $weight) {
472             $mxs[] = $mx_records[$k];
473         }
474         return $mxs;
475     }
476     
477     /**
478      * wrapper to call object->toEmail()
479      *
480      * return
481      *   {
482         headers : {AssocArray},
483         body: {String}
484         
485         // optional..
486         error :  {String} // error message in log.
487         send-to: {String} // use to override rcpt
488          
489      }
490      **/
491     function makeEmail($object, $rcpt, $last_sent_date, $notify, $force =false)
492     {
493         $m = 'notify'. $notify->evtype;
494         //var_dump(get_class($object) . '::' .$m);
495         if (!empty($notify->evtype) && method_exists($object,$m)) {
496             echo "calling :" . get_class($object) . '::' .$m . "\n";
497             return $object->$m($rcpt, $last_sent_date, $notify, $force);
498         }
499         
500         $type = explode('::', $notify->evtype);
501         
502         if(!empty($type[1]) && method_exists($object,$type[1])){
503             $m = $type[1];
504             echo "calling :" . get_class($object) . '::' .$m . "\n";
505             return $object->$m($rcpt, $last_sent_date, $notify, $force);
506         }
507                 
508         if (!method_exists($object, 'toEmail')) {
509             //var_Dump($object);
510             //exit;
511         }
512         
513         return $object->toEmail($rcpt, $last_sent_date, $notify, $force);
514     }
515     
516     function debug($str)
517     {
518         if (empty($this->cli_args['debug'])) {
519             return;
520             
521         }
522         echo $str . "\n";
523     }
524     function output()
525     {
526         die("done\n");
527     }
528     var $debug_str = '';
529     
530     function debugHandler ($smtp, $message)
531     {
532         $this->debug_str .= strlen($this->debug_str) ? "\n" : '';
533         $this->debug_str .= $message;
534     }
535 }