2 require_once 'Pman.php';
5 * notification script sender - designed to be run by the Notify script - with many children running
8 * called with an id of a core_notify element
10 * uses core_notify - to find an event to object and person.
12 * uses Events table to log failures
15 * calls $object->toEmail($person,$last_send, $notify) to generate an email struct with
23 * Note uses configuration
25 * Pman_Core_NotifySend[host] = 'localhost' << to override direct sending..
26 * Mail[helo] << helo host name
27 * Mail[socket_options] << any socket option.
31 class Pman_Core_NotifySend extends Pman
33 static $cli_desc = "Send out single notification email (usually called from Core/Notify)";
35 static $cli_opts = array(
37 'desc' => 'Turn on debugging (see DataObjects debugLevel )',
44 'DB_DataObject-debug' => array(
45 'desc' => 'Turn on debugging (see DataObjects debugLevel )',
53 'desc' => 'Force redelivery, even if it has been sent before or not queued...',
60 'desc' => 'Send the message to this address, rather than the one listed.',
70 var $table = 'core_notify';
71 var $error_handler = 'die';
75 $ff = HTML_FlexyFramework::get();
77 $this->errorHandler("access denied");
79 //HTML_FlexyFramework::ensureSingle(__FILE__, $this);
84 function get($id,$opts)
88 if (!empty($opts['DB_DataObject-debug'])) {
89 DB_DataObject::debugLevel($opts['DB_DataObject-debug']);
92 //DB_DataObject::debugLevel(1);
93 //date_default_timezone_set('UTC');
95 $force = empty($opts['force']) ? 0 : 1;
97 $w = DB_DataObject::factory($this->table);
100 $this->errorHandler("invalid id\n");
102 if (!$force && strtotime($w->act_when) < strtotime($w->sent)) {
105 $this->errorHandler("send repeat to early\n");
107 if (!empty($opts['debug'])) {
109 $ff = HTML_FlexyFramework::get();
110 if (!isset($ff->Core_Mailer)) {
111 $ff->Core_Mailer = array();
113 HTML_FlexyFramework::get()->Core_Mailer['debug'] = true;
116 $sent = (empty($w->sent) || preg_match('/^0000/', $w->sent)) ? false : true;
118 if (!$force && (!empty($w->msgid) || $sent)) {
121 $w->sent = $w->sqlValue("NOW()");
124 $this->errorHandler("message has been sent already.\n");
131 $ev = $this->addEvent('NOTIFY', $w,
132 "Notification event cleared (underlying object does not exist)" );;
134 $w->sent = date('Y-m-d H:i:s');
136 $w->event_id = $ev->id;
138 $this->errorHandler(date('Y-m-d h:i:s ') .
139 "Notification event cleared (underlying object does not exist)"
147 if (isset($p->active) && empty($p->active)) {
148 $ev = $this->addEvent('NOTIFY', $w,
149 "Notification event cleared (not user not active any more)" );;
151 $w->sent = date('Y-m-d H:i:s');
153 $w->event_id = $ev->id;
155 $this->errorHandler(date('Y-m-d h:i:s ') .
156 "Notification event cleared (not user not active any more)"
158 $this->errorHandler("message has been sent already.\n");
162 // let's work out the last notification sent to this user..
163 $l = DB_DataObject::factory($this->table);
166 'ontable' => $w->ontable,
169 // only newer version of the database us this..
170 $personid_col = strtolower($w->person_table).'_id';
171 if (isset($w->{$personid_col})) {
172 $lar[$personid_col] = $w->{$personid_col};
177 $l->whereAdd('id != '. $w->id);
178 $l->orderBy('sent DESC');
180 $ar = $l->fetchAll('sent');
181 $last = empty($ar) ? date('Y-m-d H:i:s', 0) : $ar[0];
184 $ev = DB_DataObject::factory('Events');
185 $ev->on_id = $w->id; // int(11)
186 $ev->on_table = $this->table;
188 $ev->orderBy('event_when DESC');
189 $ar = $ev->fetchAll('event_when');
190 $last_event = empty($ar) ? 0 : $ar[0];
193 $next_try_min = floor((time() - strtotime($last_event)) / 60) * 2;
195 $next_try = $next_try_min . ' MINUTES';
197 // this may modify $p->email. (it will not update it though)
198 $email = $this->makeEmail($o, $p, $last, $w, $force);
200 if ($email === true) {
202 $ev = $this->addEvent('NOTIFY', $w,
203 "Notification event cleared (not required any more)" );;
205 $w->sent = date('Y-m-d H:i:s');
207 $w->event_id = $ev->id;
209 $this->errorHandler(date('Y-m-d h:i:s ') .
210 "Notification event cleared (not required any more)"
213 if (is_a($email, 'PEAR_Error')) {
215 'error' => $email->toString()
219 if (empty($p) && !empty($email['recipients'])) {
220 // make a fake person..
222 'email' => $email['recipients']
226 if ($email === false || isset($email['error']) || empty($p)) {
227 // object returned 'false' - it does not know how to send it..
228 $ev = $this->addEvent('NOTIFY', $w, isset($email['error']) ?
229 $email['error'] : "INTERNAL ERROR - We can not handle " . $w->ontable);
231 $w->sent = date('Y-m-d H:i:s');
233 $w->event_id = $ev->id;
235 $this->errorHandler(date('Y-m-d h:i:s ') .
236 (isset($email['error']) ?
237 $email['error'] : "INTERNAL ERROR - We can not handle " . $w->ontable)
242 if (isset($email['later'])) {
244 $w->act_when = $email['later'];
246 $this->errorHandler(date('Y-m-d h:i:s ') . " Delivery postponed by email creator to {$email['later']}");
250 if (empty($email['headers']['Message-Id'])) {
251 $HOST = gethostname();
252 $email['headers']['Message-Id'] = "<{$this->table}-{$id}@{$HOST}>";
259 //$p->email = 'alan@akbkhome.com'; //for testing..
260 //print_r($email);exit;
261 // should we fetch the watch that caused it.. - which should contain the method to call..
262 // --send-to=test@xxx.com
264 if (!empty($email['send-to'])) {
265 $p->email = $email['send-to'];
267 if (!empty($opts['send-to'])) {
268 $p->email = $opts['send-to'];
271 // since some of them have spaces?!?!
272 $p->email = trim($p->email);
275 require_once 'Validate.php';
276 if (!Validate::email($p->email, true)) {
277 $ev = $this->addEvent('NOTIFY', $w, "INVALID ADDRESS: " . $p->email);
279 $w->sent = date('Y-m-d H:i:s');
281 $w->event_id = $ev->id;
283 $this->errorHandler(date('Y-m-d h:i:s ') . "INVALID ADDRESS: " . $p->email. "\n");
288 $ff = HTML_FlexyFramework::get();
291 $dom = array_pop(explode('@', $p->email));
293 $mxs = $this->mxs($dom);
296 // we might fail doing this...
297 // need to handle temporary failure..
300 // we try for 3 days..
302 if (strtotime($w->act_start) < strtotime('NOW - 1 HOUR')) {
303 // older that 1 hour.
307 if (strtotime($w->act_start) < strtotime('NOW - 1 DAY')) {
311 if (strtotime($w->act_start) < strtotime('NOW - 2 DAY')) {
316 if ($mxs === false) {
317 // only retry for 2 day son the MX issue..
319 $this->addEvent('NOTIFY', $w, 'MX LOOKUP FAILED ' . $dom );
320 $w->act_when = date('Y-m-d H:i:s', strtotime('NOW + ' . $retry . ' MINUTES'));
322 $this->errorHandler(date('Y-m-d h:i:s') . " - MX LOOKUP FAILED\n");
325 $ev = $this->addEvent('NOTIFY', $w, "BAD ADDRESS - BAD DOMAIN - ". $p->email );
326 $w->sent = date('Y-m-d H:i:s');
328 $w->event_id = $ev->id;
330 $this->errorHandler(date('Y-m-d h:i:s') . " - FAILED - BAD EMAIL - {$p->email} \n");
338 if (!$force && strtotime($w->act_start) < strtotime('NOW - 14 DAY')) {
339 $ev = $this->addEvent('NOTIFY', $w, "BAD ADDRESS - GIVE UP - ". $p->email );
340 $w->sent = date('Y-m-d H:i:s');
342 $w->event_id = $ev->id;
344 $this->errorHandler(date('Y-m-d h:i:s') . " - FAILED - GAVE UP TO OLD - {$p->email} \n");
349 $w->to_email = $p->email;
350 //$this->addEvent('NOTIFY', $w, 'GREYLISTED ' . $p->email . ' ' . $res->toString());
351 $w->act_when = date('Y-m-d H:i:s', strtotime('NOW + ' . $retry . ' MINUTES'));
357 require_once 'Mail.php';
359 $core_domain = DB_DataObject::factory('core_domain');
360 if(!$core_domain->get('domain', $dom)){
361 $core_domain = DB_DataObject::factory('core_domain');
362 $core_domain->setFrom(array(
365 $core_domain->insert();
368 foreach($mxs as $mx) {
370 if (!isset($ff->Mail['helo'])) {
371 $this->errorHandler("config Mail[helo] is not set");
373 $this->debug_str = '';
374 $this->debug("Trying SMTP: $mx / HELO {$ff->Mail['helo']}");
375 $mailer = Mail::factory('smtp', array(
377 'localhost' => $ff->Mail['helo'],
379 'socket_options' => isset($ff->Mail['socket_options']) ? $ff->Mail['socket_options'] : null,
380 //'debug' => isset($opts['debug']) ? 1 : 0,
382 'debug_handler' => array($this, 'debugHandler')
385 // if the host is the mail host + it's authenticated add auth details
386 // this normally will happen if you sent Pman_Core_NotifySend['host']
387 if (isset($ff->Mail['host']) && $ff->Mail['host'] == $mx && !empty($ff->Mail['auth'] )) {
389 $username = $ff->Mail['username'] ;
390 $password = $ff->Mail['password'] ;
392 if(!empty($ff->Core_Notify) && !empty($ff->Core_Notify['routes'])){
394 foreach ($ff->Core_Notify['routes'] as $server => $settings){
395 if(!in_array($dom, $settings['domains'])){
399 // what's the minimum timespan.. - if we have 60/hour.. that's 1 every minute.
400 // if it's newer that '1' minute...
403 $seconds = floor((60 * 60) / $settings['rate']);
405 $core_notify = DB_DataObject::factory($this->table);
406 $core_notify->domain_id = $core_domain->id;
407 $core_notify->whereAdd("
408 sent >= NOW() - INTERVAL $seconds SECONDS
411 if($core_notify->count()){
413 $w->act_when = date("Y-m-d H:i:s", time() + $seconds);
415 $this->errorHandler(date('Y-m-d h:i:s ') . " Too many emails sent by {$dom}");
418 // that make's this test obsolete...
421 $core_notify = DB_DataObject::factory($this->table);
422 $core_notify->domain_id = $core_domain->id;
423 $core_notify->whereAdd("
424 sent >= NOW() - INTERVAL 1 HOUR
427 if($core_notify->count() >= $settings['rate']){
429 $w->act_when = date("Y-m-d H:i:s", strtotime('+1 HOUR'));
431 $this->errorHandler(date('Y-m-d h:i:s ') . " Too many emails sent by {$dom}");
437 $mailer->host = $server;
438 $username = $settings['username'];
439 $password = $settings['password'];
446 $mailer->auth = true;
447 $mailer->username = $username;
448 $mailer->password = $password;
451 $res = $mailer->send($p->email, $email['headers'], $email['body']);
457 $successEventName = (empty($email['successEventName'])) ? 'NOTIFYSENT' : $email['successEventName'];
459 $ev = $this->addEvent($successEventName, $w, "{$w->to_email} - {$email['headers']['Subject']}");
461 $ev->writeEventLog($this->debug_str);
463 if(strtotime($w->act_when) > strtotime("NOW")){
464 $w->act_when = date('Y-m-d H:i:s');
467 $w->sent = date('Y-m-d H:i:s');
468 $w->msgid = $email['headers']['Message-Id'];
469 $w->event_id = $ev->id; // sent ok.. - no need to record it..
470 $w->domain_id = $core_domain->id;
473 // enable cc in notify..
474 if (!empty($email['headers']['Cc'])) {
475 $cmailer = Mail::factory('smtp', isset($ff->Mail) ? $ff->Mail : array() );
476 $email['headers']['Subject'] = "(CC): " . $email['headers']['Subject'];
477 $cmailer->send($email['headers']['Cc'],
478 $email['headers'], $email['body']);
482 if (!empty($email['bcc'])) {
483 $cmailer = Mail::factory('smtp', isset($ff->Mail) ? $ff->Mail : array() );
484 $email['headers']['Subject'] = "(CC): " . $email['headers']['Subject'];
485 $res = $cmailer->send($email['bcc'],
486 $email['headers'], $email['body']);
487 if (!$res || is_a($res, 'PEAR_Error')) {
488 echo "could not send bcc..\n";
490 echo "Sent BCC to {$email['bcc']}\n";
495 $this->errorHandler(date('Y-m-d h:i:s') . " - SENT {$w->id} - {$w->to_email} \n");
497 // what type of error..
498 $code = empty($res->userinfo['smtpcode']) ? -1 : $res->userinfo['smtpcode'];
499 if (!empty($res->code) && $res->code == 10001) {
500 // fake greylist if timed out.
505 $this->debug($res->message);
506 continue; // try next mx... ??? should we wait??? - nope we did not even connect..
508 // give up after 2 days..
509 if (in_array($code, array( 421, 450, 451, 452)) && $next_try_min < (2*24*60)) {
511 // check last event for this item..
512 //$errmsg= $fail ? ($res->userinfo['smtpcode'] . ': ' .$res->toString()) : " - UNKNOWN ERROR";
513 $errmsg= $res->userinfo['smtpcode'] . ': ' .$res->message ;
514 if (!empty($res->userinfo['smtptext'])) {
515 $errmsg= $res->userinfo['smtpcode'] . ':' . $res->userinfo['smtptext'];
518 $this->addEvent('NOTIFY', $w, 'GREYLISTED - ' . $errmsg);
519 $w->act_when = date('Y-m-d H:i:s', strtotime('NOW + ' . $retry . ' MINUTES'));
520 $w->domain_id = $core_domain->id;
524 $this->errorHandler(date('Y-m-d h:i:s') . " - GREYLISTED - $errmsg \n");
529 if ($fail || $next_try_min > (2*24*60)) {
530 // fail.. = log and give up..
531 $errmsg= $fail ? ($res->userinfo['smtpcode'] . ': ' .$res->toString()) : " - UNKNOWN ERROR";
532 if (isset($res->userinfo['smtptext'])) {
533 $errmsg= $res->userinfo['smtpcode'] . ':' . $res->userinfo['smtptext'];
536 $ev = $this->addEvent('NOTIFY', $w, ($fail ? "FAILED - " : "RETRY TIME EXCEEDED - ") .
538 $w->sent = date('Y-m-d H:i:s');
540 $w->event_id = $ev->id;
541 $w->domain_id = $core_domain->id;
543 $this->errorHandler(date('Y-m-d h:i:s') . ' - FAILED - '. ($fail ? $res->toString() : "RETRY TIME EXCEEDED\n"));
546 // handle no host availalbe forever...
547 if (strtotime($w->act_start) < strtotime('NOW - 3 DAYS')) {
548 $ev = $this->addEvent('NOTIFY', $w, "RETRY TIME EXCEEDED - ". $p->email);
549 $w->sent = date('Y-m-d H:i:s');
551 $w->event_id = $ev->id;
552 $w->domain_id = $core_domain->id;
554 $this->errorHandler(date('Y-m-d h:i:s') . " - FAILED - RETRY TIME EXCEEDED\n");
558 $this->addEvent('NOTIFY', $w, 'NO HOST CAN BE CONTACTED:' . $p->email);
559 $w->act_when = date('Y-m-d H:i:s', strtotime('NOW + 5 MINUTES'));
560 $w->domain_id = $core_domain->id;
562 $this->errorHandler(date('Y-m-d h:i:s') ." - NO HOST AVAILABLE\n");
568 $ff = HTML_FlexyFramework::get();
569 if (isset($ff->Pman_Core_NotifySend['host'])) {
570 return array($ff->Pman_Core_NotifySend['host']);
573 $mx_records = array();
574 $mx_weight = array();
576 if (!getmxrr($fqdn, $mx_records, $mx_weight)) {
577 if (!checkdnsrr($fqdn)) {
583 asort($mx_weight,SORT_NUMERIC);
585 foreach($mx_weight as $k => $weight) {
586 $mxs[] = $mx_records[$k];
592 * wrapper to call object->toEmail()
596 headers : {AssocArray},
600 error : {String} // error message in log.
601 send-to: {String} // use to override rcpt
605 function makeEmail($object, $rcpt, $last_sent_date, $notify, $force =false)
607 $m = 'notify'. $notify->evtype;
608 //var_dump(get_class($object) . '::' .$m);
609 if (!empty($notify->evtype) && method_exists($object,$m)) {
610 echo "calling :" . get_class($object) . '::' .$m . "\n";
611 return $object->$m($rcpt, $last_sent_date, $notify, $force);
614 $type = explode('::', $notify->evtype);
616 if(!empty($type[1]) && method_exists($object,$type[1])){
618 echo "calling :" . get_class($object) . '::' .$m . "\n";
619 return $object->$m($rcpt, $last_sent_date, $notify, $force);
622 if (!method_exists($object, 'toEmail')) {
627 return $object->toEmail($rcpt, $last_sent_date, $notify, $force);
632 if (empty($this->cli_args['debug'])) {
640 $this->errorHandler("done\n");
644 function debugHandler ($smtp, $message)
646 $this->debug_str .= strlen($this->debug_str) ? "\n" : '';
647 $this->debug_str .= $message;
650 function errorHandler($msg)
652 if($this->error_handler == 'exception'){
653 throw new Exception($msg);