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