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