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)"
216 if ($email === false || isset($email['error'])) {
217 // object returned 'false' - it does not know how to send it..
218 $ev = $this->addEvent('NOTIFY', $w, isset($email['error']) ?
219 $email['error'] : "INTERNAL ERROR - We can not handle " . $w->ontable);
221 $w->sent = date('Y-m-d H:i:s');
223 $w->event_id = $ev->id;
225 $this->errorHandler(date('Y-m-d h:i:s ') .
226 (isset($email['error']) ?
227 $email['error'] : "INTERNAL ERROR - We can not handle " . $w->ontable)
232 if (isset($email['later'])) {
234 $w->act_when = $email['later'];
236 $this->errorHandler(date('Y-m-d h:i:s ') . " Delivery postponed by email creator to {$email['later']}");
240 if (empty($email['headers']['Message-Id'])) {
241 $HOST = gethostname();
242 $email['headers']['Message-Id'] = "<{$this->table}-{$id}@{$HOST}>";
245 //$p->email = 'alan@akbkhome.com'; //for testing..
246 //print_r($email);exit;
247 // should we fetch the watch that caused it.. - which should contain the method to call..
248 // --send-to=test@xxx.com
250 if (!empty($email['send-to'])) {
251 $p->email = $email['send-to'];
253 if (!empty($opts['send-to'])) {
254 $p->email = $opts['send-to'];
256 // since some of them have spaces?!?!
257 $p->email = trim($p->email);
259 require_once 'Validate.php';
260 if (!Validate::email($p->email, true)) {
261 $ev = $this->addEvent('NOTIFY', $w, "INVALID ADDRESS: " . $p->email);
263 $w->sent = date('Y-m-d H:i:s');
265 $w->event_id = $ev->id;
267 $this->errorHandler(date('Y-m-d h:i:s ') . "INVALID ADDRESS: " . $p->email. "\n");
272 $ff = HTML_FlexyFramework::get();
275 $dom = array_pop(explode('@', $p->email));
277 $mxs = $this->mxs($dom);
280 // we might fail doing this...
281 // need to handle temporary failure..
284 // we try for 3 days..
286 if (strtotime($w->act_start) < strtotime('NOW - 1 HOUR')) {
287 // older that 1 hour.
291 if (strtotime($w->act_start) < strtotime('NOW - 1 DAY')) {
295 if (strtotime($w->act_start) < strtotime('NOW - 2 DAY')) {
300 if ($mxs === false) {
301 // only retry for 2 day son the MX issue..
303 $this->addEvent('NOTIFY', $w, 'MX LOOKUP FAILED ' . $dom );
304 $w->act_when = date('Y-m-d H:i:s', strtotime('NOW + ' . $retry . ' MINUTES'));
306 $this->errorHandler(date('Y-m-d h:i:s') . " - MX LOOKUP FAILED\n");
309 $ev = $this->addEvent('NOTIFY', $w, "BAD ADDRESS - BAD DOMAIN - ". $p->email );
310 $w->sent = date('Y-m-d H:i:s');
312 $w->event_id = $ev->id;
314 $this->errorHandler(date('Y-m-d h:i:s') . " - FAILED - BAD EMAIL - {$p->email} \n");
322 if (!$force && strtotime($w->act_start) < strtotime('NOW - 14 DAY')) {
323 $ev = $this->addEvent('NOTIFY', $w, "BAD ADDRESS - GIVE UP - ". $p->email );
324 $w->sent = date('Y-m-d H:i:s');
326 $w->event_id = $ev->id;
328 $this->errorHandler(date('Y-m-d h:i:s') . " - FAILED - GAVE UP TO OLD - {$p->email} \n");
333 $w->to_email = $p->email;
334 //$this->addEvent('NOTIFY', $w, 'GREYLISTED ' . $p->email . ' ' . $res->toString());
335 $w->act_when = date('Y-m-d H:i:s', strtotime('NOW + ' . $retry . ' MINUTES'));
341 require_once 'Mail.php';
343 foreach($mxs as $dom) {
347 if (!isset($ff->Mail['helo'])) {
348 $this->errorHandler("config Mail[helo] is not set");
350 $this->debug_str = '';
351 $this->debug("Trying SMTP: $dom / HELO {$ff->Mail['helo']}");
352 $mailer = Mail::factory('smtp', array(
354 'localhost' => $ff->Mail['helo'],
356 'socket_options' => isset($ff->Mail['socket_options']) ? $ff->Mail['socket_options'] : null,
357 //'debug' => isset($opts['debug']) ? 1 : 0,
359 'debug_handler' => array($this, 'debugHandler')
362 // if the host is the mail host + it's authenticated add auth details
363 // this normally will happen if you sent Pman_Core_NotifySend['host']
364 if (isset($ff->Mail['host']) && $ff->Mail['host'] == $dom && !empty($ff->Mail['auth'] )) {
365 $mailer->auth = true;
366 $mailer->username = $ff->Mail['username'] ;
367 $mailer->password = $ff->Mail['password'] ;
370 $res = $mailer->send($p->email, $email['headers'], $email['body']);
376 $ev = $this->addEvent('NOTIFYSENT', $w, "{$w->to_email} - {$email['headers']['Subject']}");
378 $ev->writeEventLog($this->debug_str);
380 $w->sent = date('Y-m-d H:i:s');
381 $w->msgid = $email['headers']['Message-Id'];
382 $w->event_id = $ev->id; // sent ok.. - no need to record it..
385 // enable cc in notify..
386 if (!empty($email['headers']['Cc'])) {
387 $cmailer = Mail::factory('smtp', isset($ff->Mail) ? $ff->Mail : array() );
388 $email['headers']['Subject'] = "(CC): " . $email['headers']['Subject'];
389 $cmailer->send($email['headers']['Cc'],
390 $email['headers'], $email['body']);
394 if (!empty($email['bcc'])) {
395 $cmailer = Mail::factory('smtp', isset($ff->Mail) ? $ff->Mail : array() );
396 $email['headers']['Subject'] = "(CC): " . $email['headers']['Subject'];
397 $res = $cmailer->send($email['bcc'],
398 $email['headers'], $email['body']);
399 if (!$res || is_a($res, 'PEAR_Error')) {
400 echo "could not send bcc..\n";
402 echo "Sent BCC to {$email['bcc']}\n";
407 $this->errorHandler(date('Y-m-d h:i:s') . " - SENT\n");
409 // what type of error..
410 $code = empty($res->userinfo['smtpcode']) ? -1 : $res->userinfo['smtpcode'];
411 if (!empty($res->code) && $res->code == 10001) {
412 // fake greylist if timed out.
417 $this->debug($res->message);
418 continue; // try next mx... ??? should we wait??? - nope we did not even connect..
420 // give up after 2 days..
421 if (in_array($code, array( 421, 450, 451, 452)) && $next_try_min < (2*24*60)) {
423 // check last event for this item..
424 //$errmsg= $fail ? ($res->userinfo['smtpcode'] . ': ' .$res->toString()) : " - UNKNOWN ERROR";
425 $errmsg= $res->userinfo['smtpcode'] . ': ' .$res->message ;
426 if (!empty($res->userinfo['smtptext'])) {
427 $errmsg= $res->userinfo['smtpcode'] . ':' . $res->userinfo['smtptext'];
430 $this->addEvent('NOTIFY', $w, 'GREYLISTED - ' . $errmsg);
431 $w->act_when = date('Y-m-d H:i:s', strtotime('NOW + ' . $retry . ' MINUTES'));
435 $this->errorHandler(date('Y-m-d h:i:s') . " - GREYLISTED - $errmsg \n");
440 if ($fail || $next_try_min > (2*24*60)) {
441 // fail.. = log and give up..
442 $errmsg= $fail ? ($res->userinfo['smtpcode'] . ': ' .$res->toString()) : " - UNKNOWN ERROR";
443 if (isset($res->userinfo['smtptext'])) {
444 $errmsg= $res->userinfo['smtpcode'] . ':' . $res->userinfo['smtptext'];
447 $ev = $this->addEvent('NOTIFY', $w, ($fail ? "FAILED - " : "RETRY TIME EXCEEDED - ") .
449 $w->sent = date('Y-m-d H:i:s');
451 $w->event_id = $ev->id;
453 $this->errorHandler(date('Y-m-d h:i:s') . ' - FAILED - '. ($fail ? $res->toString() : "RETRY TIME EXCEEDED\n"));
456 // handle no host availalbe forever...
457 if (strtotime($w->act_start) < strtotime('NOW - 3 DAYS')) {
458 $ev = $this->addEvent('NOTIFY', $w, "RETRY TIME EXCEEDED - ". $p->email);
459 $w->sent = date('Y-m-d H:i:s');
461 $w->event_id = $ev->id;
463 $this->errorHandler(date('Y-m-d h:i:s') . " - FAILED - RETRY TIME EXCEEDED\n");
467 $this->addEvent('NOTIFY', $w, 'NO HOST CAN BE CONTACTED:' . $p->email);
468 $w->act_when = date('Y-m-d H:i:s', strtotime('NOW + 5 MINUTES'));
470 $this->errorHandler(date('Y-m-d h:i:s') ." - NO HOST AVAILABLE\n");
476 $ff = HTML_FlexyFramework::get();
477 if (isset($ff->Pman_Core_NotifySend['host'])) {
478 return array($ff->Pman_Core_NotifySend['host']);
481 $mx_records = array();
482 $mx_weight = array();
484 if (!getmxrr($fqdn, $mx_records, $mx_weight)) {
485 if (!checkdnsrr($fqdn)) {
491 asort($mx_weight,SORT_NUMERIC);
493 foreach($mx_weight as $k => $weight) {
494 $mxs[] = $mx_records[$k];
500 * wrapper to call object->toEmail()
504 headers : {AssocArray},
508 error : {String} // error message in log.
509 send-to: {String} // use to override rcpt
513 function makeEmail($object, $rcpt, $last_sent_date, $notify, $force =false)
515 $m = 'notify'. $notify->evtype;
516 //var_dump(get_class($object) . '::' .$m);
517 if (!empty($notify->evtype) && method_exists($object,$m)) {
518 echo "calling :" . get_class($object) . '::' .$m . "\n";
519 return $object->$m($rcpt, $last_sent_date, $notify, $force);
522 $type = explode('::', $notify->evtype);
524 if(!empty($type[1]) && method_exists($object,$type[1])){
526 echo "calling :" . get_class($object) . '::' .$m . "\n";
527 return $object->$m($rcpt, $last_sent_date, $notify, $force);
530 if (!method_exists($object, 'toEmail')) {
535 return $object->toEmail($rcpt, $last_sent_date, $notify, $force);
540 if (empty($this->cli_args['debug'])) {
548 $this->errorHandler("done\n");
552 function debugHandler ($smtp, $message)
554 $this->debug_str .= strlen($this->debug_str) ? "\n" : '';
555 $this->debug_str .= $message;
558 function errorHandler($msg)
560 if($this->error_handler == 'exception'){
561 throw new Exception($msg);