Fix #7859 - blacklist detection
[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 class Pman_Core_NotifySend_Exception_Success extends Exception {}
30 class Pman_Core_NotifySend_Exception_Fail extends Exception {}
31
32
33 class Pman_Core_NotifySend extends Pman
34 {
35     static $cli_desc = "Send out single notification email (usually called from  Core/Notify)";
36     
37     static $cli_opts = array(
38         'debug' => array(
39             'desc' => 'Turn on debugging (see DataObjects debugLevel )',
40             'default' => 0,
41             'short' => 'v',
42             'min' => 0,
43             'max' => 0,
44             
45         ),
46         'DB_DataObject-debug' => array(
47             'desc' => 'Turn on debugging (see DataObjects debugLevel )',
48             'default' => 0,
49             'short' => 'd',
50             'min' => 1,
51             'max' => 1,
52             
53         ),
54         'force' => array(
55             'desc' => 'Force redelivery, even if it has been sent before or not queued...',
56             'default' => 0,
57             'short' => 'f',
58             'min' => 0,
59             'max' => 0,
60         ),
61         'send-to' => array(
62             'desc' => 'Send the message to this address, rather than the one listed.',
63             'default' => '',
64             'short' => 't',
65             'min' => 0,
66             'max' => 1,
67         )
68         
69         
70         
71     );
72     var $table = 'core_notify';
73     var $error_handler = 'die';
74     var $poolname = 'core';
75     var $server; // core_notify_server
76     
77     function getAuth()
78     {
79         $ff = HTML_FlexyFramework::get();
80         if (!$ff->cli) {
81             $this->errorHandler("access denied");
82         }
83         //HTML_FlexyFramework::ensureSingle(__FILE__, $this);
84         return true;
85         
86     }
87    
88     function get($id,$opts=array())
89     {
90
91         //print_r($opts);
92         if (!empty($opts['DB_DataObject-debug'])) {
93             DB_DataObject::debugLevel($opts['DB_DataObject-debug']);
94         }
95         
96         //DB_DataObject::debugLevel(1);
97         //date_default_timezone_set('UTC');
98         // phpinfo();exit;
99         $force = empty($opts['force']) ? 0 : 1;
100         
101         $w = DB_DataObject::factory($this->table);
102
103         if (!$w->get($id)) {
104             $this->errorHandler("invalid id\n");
105         }
106
107         if (!$force && !empty($w->sent) && strtotime($w->act_when) < strtotime($w->sent)) {
108              
109             $this->errorHandler("already sent - repeat to early\n");
110         }
111         
112         $this->server = DB_DataObject::Factory('core_notify_server')->getCurrent($this);
113         if (!$force && $w->server_id != $this->server->id) {
114             $this->errorHandler("Server id does not match - use force to try again\n");
115         }
116         
117         if (!empty($opts['debug'])) {
118             print_r($w);
119             $ff = HTML_FlexyFramework::get();
120             if (!isset($ff->Core_Mailer)) {
121                 $ff->Core_Mailer = array();
122             }
123             HTML_FlexyFramework::get()->Core_Mailer['debug'] = true;
124         }
125         
126         $sent = (empty($w->sent) || preg_match('/^0000/', $w->sent)) ? false : true;
127         
128         if (!$force && (!empty($w->msgid) || $sent)) {
129             $ww = clone($w);
130             if (!$sent) {   // fix sent.
131                 $w->sent = $w->sent == '0000-00-00 00:00:00' ? $w->sqlValue('NOW()') :$w->sent; // do not update if sent.....
132                 $w->update($ww);
133             }    
134             $this->errorHandler("message has been sent already.\n");
135         }
136         
137         $o = $w->object();
138         
139         if ($o === false)  {
140              
141             $ev = $this->addEvent('NOTIFY', $w,   "Notification event cleared (underlying object does not exist)" );
142             $w->flagDone($ev, '');
143             $this->errorHandler(  $ev->remarks);
144         }
145      
146         
147         
148         $p = $w->person();
149         
150         if (isset($p->active) && empty($p->active)) {
151             $ev = $this->addEvent('NOTIFY', $w, "Notification event cleared (not user not active any more)" );;
152              $w->flagDone($ev, '');
153             $this->errorHandler(  $ev->remarks);
154         }
155         // has it failed mutliple times..
156         
157         if (!empty($w->field) && isset($p->{$w->field .'_fails'}) && $p->{$w->field .'_fails'} > 9) {
158             $ev = $this->addEvent('NOTIFY', $w, "Notification event cleared (user has to many failures)" );;
159             $w->flagDone($ev, '');
160             $this->errorHandler(  $ev->remarks);
161         }
162         
163         // let's work out the last notification sent to this user..
164         $l = DB_DataObject::factory($this->table);
165         
166         $lar = array(
167                 'ontable' => $w->ontable,
168                 'onid' => $w->onid,
169         );
170         // only newer version of the database us this..
171         if (isset($w->person_table)) {
172             $personid_col = strtolower($w->person_table).'_id';
173             if (isset($w->{$personid_col})) {
174                 $lar[$personid_col] = $w->{$personid_col};
175             }
176         }
177         
178         
179         $l->setFrom( $lar );       
180         $l->whereAdd('id != '. $w->id);
181         $l->orderBy('sent DESC');
182         $l->limit(1);
183         $ar = $l->fetchAll('sent');
184         $last = empty($ar) ? date('Y-m-d H:i:s', 0) : $ar[0];
185         
186         // find last event..
187         $ev = DB_DataObject::factory('Events');
188         $ev->on_id = $w->id;                           // int(11)
189         $ev->on_table = $this->table;
190         $ev->limit(1);
191         $ev->orderBy('event_when DESC');
192         $ar = $ev->fetchAll('event_when');
193         $last_event = empty($ar) ? 0 : $ar[0];
194         $next_try_min = 5;
195         if ($last_event) {
196             $next_try_min = floor((time() - strtotime($last_event)) / 60) * 2;
197         }
198         $next_try = $next_try_min . ' MINUTES';
199          
200         // this may modify $p->email. (it will not update it though)
201         $email =  $this->makeEmail($o, $p, $last, $w, $force);
202         
203         if ($email === true)  {
204             $ev = $this->addEvent('NOTIFY', $w, "Notification event cleared (not required any more) - toEmail=true" );;
205             $w->flagDone($ev, '');
206             $this->errorHandler( $ev->remarks);
207         }
208         if (is_a($email, 'PEAR_Error')) {
209             $email =array(
210                 'error' => $email->toString()
211             );
212         }
213         
214         if (empty($p) && !empty($email['recipients'])) {
215             // make a fake person..
216             $p = (object) array(
217                 'email' => $email['recipients']
218             );
219         }
220          
221         if ($email === false || isset($email['error']) || empty($p)) {
222             // object returned 'false' - it does not know how to send it..
223             $ev = $this->addEvent('NOTIFYFAIL', $w, isset($email['error'])  ? $email['error'] : "INTERNAL ERROR  - We can not handle " . $w->ontable); 
224             $w->flagDone($ev, '');
225             $this->errorHandler(  $ev->remarks);
226         }
227         
228          
229         
230         if (isset($email['later'])) {
231             
232             $this->server->updateNotifyToNextServer($w, $email['later'],true);
233              
234             $this->errorHandler("Delivery postponed by email creator to {$email['later']}");
235         }
236         
237          
238         if (empty($email['headers']['Message-Id'])) {
239             $HOST = gethostname();
240             $email['headers']['Message-Id'] = "<{$this->table}-{$id}@{$HOST}>";
241             
242         }
243         
244         
245             
246         
247         //$p->email = 'alan@akbkhome.com'; //for testing..
248         //print_r($email);exit;
249         // should we fetch the watch that caused it.. - which should contain the method to call..
250         // --send-to=test@xxx.com
251        
252         if (!empty($email['send-to'])) {
253             $p->email = $email['send-to'];
254         }
255          if (!empty($opts['send-to'])) {
256             $p->email = $opts['send-to'];
257         }
258         
259             // since some of them have spaces?!?!
260         $p->email = trim($p->email);
261         $ww = clone($w);
262         $ww->to_email = empty($ww->to_email) ? $p->email : $ww->to_email;
263         $explode_email = explode('@', $ww->to_email);
264         $dom = array_pop($explode_email);
265         
266         $core_domain = DB_DataObject::factory('core_domain')->loadOrCreate($dom);
267
268         
269         $ww->domain_id = $core_domain->id;
270         // if to_email has not been set!?
271         $ww->update($w); // if nothing has changed this will not do anything.
272         $w = clone($ww);
273     
274       
275         
276         require_once 'Validate.php';
277         if (!Validate::email($p->email, true)) {
278             $ev = $this->addEvent('NOTIFYFAIL', $w, "INVALID ADDRESS: " . $p->email);
279             $w->flagDone($ev, '');
280             $this->errorHandler($ev->remarks);
281             
282         }
283         
284         
285         $ff = HTML_FlexyFramework::get();
286         
287      
288         $mxs = $this->mxs($dom);
289         $ww = clone($w);
290
291         // we might fail doing this...
292         // need to handle temporary failure..
293        
294         
295           // we try for 2 days..
296         $retry = 15;
297         if (strtotime($w->act_start) <  strtotime('NOW - 1 HOUR')) {
298             // older that 1 hour.
299             $retry = 60;
300         }
301         
302         if (strtotime($w->act_start) <  strtotime('NOW - 1 DAY')) {
303             // older that 1 day.
304             $retry = 120;
305         }
306         if (strtotime($w->act_start) <  strtotime('NOW - 2 DAY')) {
307             // older that 1 day.
308             $retry = 240;
309         }
310         
311         if (empty($mxs)) {
312             // only retry for 1 day if the MX issue..
313             if ($retry < 240) {
314                 $this->addEvent('NOTIFY', $w, 'MX LOOKUP FAILED ' . $dom );
315                 $w->flagLater(date('Y-m-d H:i:s', strtotime('NOW + ' . $retry . ' MINUTES')));
316                 $this->errorHandler($ev->remarks);
317             }
318             
319             $ev = $this->addEvent('NOTIFYFAIL', $w, "BAD ADDRESS - BAD DOMAIN - ". $p->email );
320             $w->flagDone($ev, '');
321             $this->errorHandler($ev->remarks);
322             
323             
324         }
325         
326         
327         
328         
329         if (!$force && strtotime($w->act_start) <  strtotime('NOW - 3 DAY')) {
330             $ev = $this->addEvent('NOTIFYFAIL', $w, "BAD ADDRESS - GIVE UP - ". $p->email );
331             $w->flagDone($ev, '');
332             $this->errorHandler(  $ev->remarks);
333         }
334         
335         
336         //$this->addEvent('NOTIFY', $w, 'GREYLISTED ' . $p->email . ' ' . $res->toString());
337         // we can only update act_when if it has not been sent already (only happens when running in force mode..)
338         // set act when if it's empty...
339         $w->act_when =  (!$w->act_when || $w->act_when == '0000-00-00 00:00:00') ? date('Y-m-d H:i:s', strtotime('NOW + ' . $retry . ' MINUTES')) : $w->act_when;
340         
341         $w->update($ww);
342         
343         $ww = clone($w);   
344         
345         $fail = false;
346         require_once 'Mail.php';
347         
348         
349         $this->server->initHelo();
350         
351         if (!isset($ff->Mail['helo'])) {
352             $this->errorHandler("config Mail[helo] is not set");
353         }
354         
355         
356                         
357         foreach($mxs as $mx) {
358             
359            
360             $this->debug_str = '';
361             $this->debug("Trying SMTP: $mx / HELO {$ff->Mail['helo']}");
362             $mailer = Mail::factory('smtp', array(
363                     'host'    => $mx ,
364                     'localhost' => $ff->Mail['helo'],
365                     'timeout' => 15,
366                     'socket_options' =>  isset($ff->Mail['socket_options']) ? $ff->Mail['socket_options'] : null,
367                     //'debug' => isset($opts['debug']) ?  1 : 0,
368                     'debug' => 1,
369                     'debug_handler' => array($this, 'debugHandler')
370             ));
371             
372             // if the host is the mail host + it's authenticated add auth details
373             // this normally will happen if you sent  Pman_Core_NotifySend['host']
374              
375             
376             if (isset($ff->Mail['host']) && $ff->Mail['host'] == $mx && !empty($ff->Mail['auth'] )) {
377                 
378                 $mailer->auth = true;
379                 $mailer->username = $ff->Mail['username'];
380                 $mailer->password = $ff->Mail['password'];        
381             }
382             
383             if(!empty($ff->Core_Notify) && !empty($ff->Core_Notify['routes'])){
384                 
385                 // we might want to regex 'office365 as a mx host 
386                 foreach ($ff->Core_Notify['routes'] as $server => $settings){
387                     if(!in_array($dom, $settings['domains'])){
388                         continue;
389                     }
390                     
391                     // what's the minimum timespan.. - if we have 60/hour.. that's 1 every minute.
392                     // if it's newer that '1' minute...
393                     // then shunt it..
394                     
395                     $settings['rate'] = isset( $settings['rate']) ?  $settings['rate']  : 360;
396                     
397                     $seconds = floor((60 * 60) / $settings['rate']);
398                     
399                     $core_notify = DB_DataObject::factory($this->table);
400                     $core_notify->domain_id = $core_domain->id;
401                     $core_notify->server_id = $this->server->id;
402                     $core_notify->whereAdd("
403                         sent >= NOW() - INTERVAL $seconds SECOND
404                     ");
405                     
406                     if($core_notify->count()){
407                         $this->server->updateNotifyToNextServer( $w , date("Y-m-d H:i:s", time() + $seconds), true);
408                         $this->errorHandler( " Too many emails sent by {$dom} - requeing");
409                     }
410                      
411                     
412                     
413                     $mailer->host = $server;
414                     $mailer->auth = isset($settings['auth']) ? $settings['auth'] : true;
415                     $mailer->username = $settings['username'];
416                     $mailer->password = $settings['password'];
417                     if (isset($settings['port'])) {
418                         $mailer->port = $settings['port'];
419                     }
420                     if (isset($settings['socket_options'])) {
421                         $mailer->socket_options = $settings['socket_options'];
422                         
423                     }
424                     
425                     
426                     break;
427                 }
428                 
429             }
430         
431             
432             $res = $mailer->send($p->email, $email['headers'], $email['body']);
433             if (is_object($res)) {
434                 $res->backtrace = array(); 
435             }
436             $this->debug("GOT response to send: ". print_r($res,true)); 
437             
438             if ($res === true) {
439                 // success....
440                 
441                 $successEventName = (empty($email['successEventName'])) ? 'NOTIFYSENT' : $email['successEventName'];
442                 
443                 $ev = $this->addEvent($successEventName, $w, "{$w->to_email} - {$email['headers']['Subject']}");
444                 
445                 $ev->writeEventLog($this->debug_str);
446                  
447                 $w->flagDone($ev,$email['headers']['Message-Id']);
448                 
449                  
450                 // enable cc in notify..
451                 if (!empty($email['headers']['Cc'])) {
452                     $cmailer = Mail::factory('smtp',  isset($ff->Mail) ? $ff->Mail : array() );
453                     $email['headers']['Subject'] = "(CC): " . $email['headers']['Subject'];
454                     $cmailer->send($email['headers']['Cc'],    $email['headers'], $email['body']);
455                     
456                 }
457                 
458                 if (!empty($email['bcc'])) {
459                     $cmailer = Mail::factory('smtp', isset($ff->Mail) ? $ff->Mail : array() );
460                     $email['headers']['Subject'] = "(CC): " . $email['headers']['Subject'];
461                     $res = $cmailer->send($email['bcc'],  $email['headers'], $email['body']);
462                     if (!$res || is_a($res, 'PEAR_Error')) {
463                         echo "could not send bcc..\n";
464                     } else {
465                         echo "Sent BCC to {$email['bcc']}\n";
466                     }
467                 }
468                  
469                 $this->errorHandler( " SENT {$w->id} - {$ev->remarks}", true);
470             }
471             // what type of error..
472             $code = empty($res->userinfo['smtpcode']) ? -1 : $res->userinfo['smtpcode'];
473             if (!empty($res->code) && $res->code == 10001) {
474                 // fake greylist if timed out.
475                 $code = 421;
476             }
477             
478             if ($code < 0) {
479                 $this->debug($res->message);
480                 continue; // try next mx... ??? should we wait??? - nope we did not even connect..
481             }
482             // give up after 2 days..
483             if (in_array($code, array( 421, 450, 451, 452))   && $next_try_min < (2*24*60)) {
484                 // try again later..
485                 // check last event for this item..
486                 //$errmsg=  $fail ? ($res->userinfo['smtpcode'] . ': ' .$res->toString()) :  " - UNKNOWN ERROR";
487                 $errmsg=  $res->userinfo['smtpcode'] . ': ' .$res->message ;
488                 if (!empty($res->userinfo['smtptext'])) {
489                     $errmsg=  $res->userinfo['smtpcode'] . ':' . $res->userinfo['smtptext'];
490                 }
491                 //print_r($res);
492                 $ev = $this->addEvent('NOTIFY', $w, 'GREYLISTED - ' . $errmsg);
493                 
494                 $this->server->updateNotifyToNextServer($w,  strtotime('NOW + ' . $retry . ' MINUTES'),true);
495                 
496                 $this->errorHandler(  $ev->remarks);
497             }
498             
499             $fail = true;
500             break;
501         }
502         
503         // after trying all mxs - could not connect...
504         if  (!$fail && ($next_try_min > (2*24*60) || strtotime($w->act_start) < strtotime('NOW - 3 DAYS'))) {
505             
506             $errmsg=  " - UNKNOWN ERROR";
507             if (isset($res->userinfo['smtptext'])) {
508                 $errmsg=  $res->userinfo['smtpcode'] . ':' . $res->userinfo['smtptext'];
509             }
510             
511             $ev = $this->addEvent('NOTIFYFAIL', $w,  "RETRY TIME EXCEEDED - " .  $errmsg);
512             $w->flagDone($ev, '');
513             $this->errorHandler( $ev->remarks);
514         }
515         
516         if ($fail) { //// !!!!<<< BLACKLIST DETECT?
517         // fail.. = log and give up..
518             $errmsg=   $res->userinfo['smtpcode'] . ': ' .$res->toString();
519             if (isset($res->userinfo['smtptext'])) {
520                 $errmsg=  $res->userinfo['smtpcode'] . ':' . $res->userinfo['smtptext'];
521             }
522             
523             if ($res->userinfo['smtpcode'] == 550) {
524                 if ($this->server->checkSmtpResponse($errmsg, $core_domain)) {
525                     $ev = $this->addEvent('NOTIFY', $w, 'BLACKLISTED  - ' . $errmsg);
526                     $this->server->updateNotifyToNextServer($w,  strtotime('NOW + ' . $retry . ' MINUTES'),true);
527                     $this->errorHandler( $ev->remarks);
528                 }
529             }
530             
531             
532             $ev = $this->addEvent('NOTIFYFAIL', $w, ($fail ? "FAILED - " : "RETRY TIME EXCEEDED - ") .  $errmsg);
533             $w->flagDone($ev, '');
534             
535             
536             
537
538             $this->errorHandler( $ev->remarks);
539         }
540         
541         // at this point we just could not find any MX records..
542         
543         
544         // try again.
545         
546         $ev = $this->addEvent('NOTIFY', $w, 'NO HOST CAN BE CONTACTED:' . $p->email);
547         
548         $this->server->updateNotifyToNextServer($w,  strtotime('NOW + ' . $retry . ' MINUTES'),true);
549
550         
551          
552         $this->errorHandler($ev->remarks);
553
554         
555     }
556     function mxs($fqdn)
557     {
558         $ff = HTML_FlexyFramework::get();
559         if (isset($ff->Pman_Core_NotifySend['host'])) {
560             return array($ff->Pman_Core_NotifySend['host']);
561         }
562         
563         $mx_records = array();
564         $mx_weight = array();
565         $mxs = array();
566         if (!getmxrr($fqdn, $mx_records, $mx_weight)) {
567             if (!checkdnsrr($fqdn)) {
568                 return false;
569             }
570             return array($fqdn);
571         }
572         
573         asort($mx_weight,SORT_NUMERIC);
574         
575         foreach($mx_weight as $k => $weight) {
576             if (!empty($mx_records[$k])) {
577                 $mxs[] = $mx_records[$k];
578             }
579         }
580         return empty($mxs) ? false : $mxs;
581     }
582     
583     /**
584      * wrapper to call object->toEmail()
585      *
586      * return
587      *   {
588         headers : {AssocArray},
589         body: {String}
590         
591         // optional..
592         error :  {String} // error message in log.
593         send-to: {String} // use to override rcpt
594          
595      }
596      **/
597     function makeEmail($object, $rcpt, $last_sent_date, $notify, $force =false)
598     {
599         $m = 'notify'. $notify->evtype;
600         //var_dump(get_class($object) . '::' .$m);
601         if (!empty($notify->evtype) && method_exists($object,$m)) {
602             echo "calling :" . get_class($object) . '::' .$m . "\n";
603             return $object->$m($rcpt, $last_sent_date, $notify, $force);
604         }
605         
606         $type = explode('::', $notify->evtype);
607         
608         if(!empty($type[1]) && method_exists($object,$type[1])){
609             $m = $type[1];
610             echo "calling :" . get_class($object) . '::' .$m . "\n";
611             return $object->$m($rcpt, $last_sent_date, $notify, $force);
612         }
613         // fallback if evtype is empty..
614         
615         if (method_exists($object, 'toMailerData')) {
616             return $object->toMailerData(array(
617                 'rcpts'=>$rcpt,
618                 'person'=>$rcpt, // added as mediaoutreach used this?
619             )); //this is core_email - i think it's only used for testing...
620             //var_Dump($object);
621             //exit;
622         }
623         if (method_exists($object, 'toEmail')) {
624             return $object->toEmail($rcpt, $last_sent_date, $notify, $force);
625         }
626         // no way to send this.. - this needs to handle core_notify how we have used it for the approval stuff..
627         
628         return false;
629     }
630     
631     function debug($str)
632     {
633         if (empty($this->cli_args['debug'])) {
634             return;
635             
636         }
637         echo $str . "\n";
638     }
639     function output()
640     {
641         $this->errorHandler("done\n");
642     }
643     var $debug_str = '';
644     
645     function debugHandler ($smtp, $message)
646     {
647         $this->debug_str .= strlen($this->debug_str) ? "\n" : '';
648         $this->debug_str .= $message;
649         //echo $message ."\n";
650     }
651     
652     function errorHandler($msg, $success = false)
653     {
654         if($this->error_handler == 'exception'){
655             if($success){
656                 throw new Pman_Core_NotifySend_Exception_Success($msg);
657             }
658             
659             throw new Pman_Core_NotifySend_Exception_Fail($msg);
660         }
661         
662         die(date('Y-m-d h:i:s') . ' ' . $msg ."\n");
663         
664         
665     }
666     
667     function updateServer($w)
668     {
669         $ff = HTML_FlexyFramework::get();
670          
671         if (empty($ff->Core_Notify['servers'])) {
672             return;
673         }
674         // some classes dont support server routing
675         if (!property_exists($w, 'server_id')) {
676             return;
677         }
678         // next server..
679         $w->server_id = ($w->server_id + 1) % count(array_keys($ff->Core_Notify['servers']));
680          
681     }
682     
683
684     
685 }