toEmail($person,$last_send, $notify) to generate an email struct with * array ( * headers => * recipients => * body => * ) * * * Note uses configuration * * Pman_Core_NotifySend[host] = 'localhost' << to override direct sending.. * Mail[helo] << helo host name * Mail[socket_options] << any socket option. */ class Pman_Core_NotifySend_Exception_Success extends Exception {} class Pman_Core_NotifySend_Exception_Fail extends Exception {} class Pman_Core_NotifySend extends Pman { static $cli_desc = "Send out single notification email (usually called from Core/Notify)"; static $cli_opts = array( 'debug' => array( 'desc' => 'Turn on debugging (see DataObjects debugLevel )', 'default' => 0, 'short' => 'v', 'min' => 0, 'max' => 0, ), 'DB_DataObject-debug' => array( 'desc' => 'Turn on debugging (see DataObjects debugLevel )', 'default' => 0, 'short' => 'd', 'min' => 1, 'max' => 1, ), 'force' => array( 'desc' => 'Force redelivery, even if it has been sent before or not queued...', 'default' => 0, 'short' => 'f', 'min' => 0, 'max' => 0, ), 'send-to' => array( 'desc' => 'Send the message to this address, rather than the one listed.', 'default' => '', 'short' => 't', 'min' => 0, 'max' => 1, ) ); var $table = 'core_notify'; var $error_handler = 'die'; function getAuth() { $ff = HTML_FlexyFramework::get(); if (!$ff->cli) { $this->errorHandler("access denied"); } //HTML_FlexyFramework::ensureSingle(__FILE__, $this); return true; } function get($id,$opts=array()) { //print_r($opts); if (!empty($opts['DB_DataObject-debug'])) { DB_DataObject::debugLevel($opts['DB_DataObject-debug']); } //DB_DataObject::debugLevel(1); //date_default_timezone_set('UTC'); // phpinfo();exit; $force = empty($opts['force']) ? 0 : 1; $w = DB_DataObject::factory($this->table); if (!$w->get($id)) { $this->errorHandler("invalid id\n"); } if (!$force && strtotime($w->act_when) < strtotime($w->sent)) { $this->errorHandler("send repeat to early\n"); } if (!empty($opts['debug'])) { print_r($w); $ff = HTML_FlexyFramework::get(); if (!isset($ff->Core_Mailer)) { $ff->Core_Mailer = array(); } HTML_FlexyFramework::get()->Core_Mailer['debug'] = true; } $sent = (empty($w->sent) || preg_match('/^0000/', $w->sent)) ? false : true; if (!$force && (!empty($w->msgid) || $sent)) { $ww = clone($w); if (!$sent) { $w->sent = $w->sent == '0000-00-00 00:00:00' ? $w->sqlValue('NOW()') :$w->sent; // do not update if sent..... $w->update($ww); } $this->errorHandler("message has been sent already.\n"); } $o = $w->object(); if ($o === false) { $ev = $this->addEvent('NOTIFY', $w, "Notification event cleared (underlying object does not exist)" );; $ww = clone($w); $w->sent = $w->sent == '0000-00-00 00:00:00' ? $w->sqlValue('NOW()') :$w->sent; // do not update if sent..... $w->msgid = ''; $w->event_id = $ev->id; $w->update($ww); $this->errorHandler(date('Y-m-d h:i:s ') . "Notification event cleared (underlying object does not exist)" ."\n"); } $p = $w->person(); if (isset($p->active) && empty($p->active)) { $ev = $this->addEvent('NOTIFY', $w, "Notification event cleared (not user not active any more)" );; $ww = clone($w); $w->sent = $w->sent == '0000-00-00 00:00:00' ? $w->sqlValue('NOW()') :$w->sent; // do not update if sent..... $w->msgid = ''; $w->event_id = $ev->id; $w->update($ww); $this->errorHandler(date('Y-m-d h:i:s ') . "Notification event cleared (not user not active any more)" ."\n"); $this->errorHandler("message has been sent already.\n"); } // let's work out the last notification sent to this user.. $l = DB_DataObject::factory($this->table); $lar = array( 'ontable' => $w->ontable, 'onid' => $w->onid, ); // only newer version of the database us this.. $personid_col = strtolower($w->person_table).'_id'; if (isset($w->{$personid_col})) { $lar[$personid_col] = $w->{$personid_col}; } $l->setFrom( $lar ); $l->whereAdd('id != '. $w->id); $l->orderBy('sent DESC'); $l->limit(1); $ar = $l->fetchAll('sent'); $last = empty($ar) ? date('Y-m-d H:i:s', 0) : $ar[0]; // find last event.. $ev = DB_DataObject::factory('Events'); $ev->on_id = $w->id; // int(11) $ev->on_table = $this->table; $ev->limit(1); $ev->orderBy('event_when DESC'); $ar = $ev->fetchAll('event_when'); $last_event = empty($ar) ? 0 : $ar[0]; $next_try_min = 5; if ($last_event) { $next_try_min = floor((time() - strtotime($last_event)) / 60) * 2; } $next_try = $next_try_min . ' MINUTES'; // this may modify $p->email. (it will not update it though) $email = $this->makeEmail($o, $p, $last, $w, $force); if ($email === true) { $ev = $this->addEvent('NOTIFY', $w, "Notification event cleared (not required any more)" );; $ww = clone($w); $w->sent = (!$w->sent || $w->sent == '0000-00-00 00:00:00') ? $w->sqlValue('NOW()') : $w->sent; // do not update if sent..... $w->msgid = ''; $w->event_id = $ev->id; $w->update($ww); $this->errorHandler(date('Y-m-d h:i:s ') . "Notification event cleared (not required any more)" ."\n"); } if (is_a($email, 'PEAR_Error')) { $email =array( 'error' => $email->toString() ); } if (empty($p) && !empty($email['recipients'])) { // make a fake person.. $p = (object) array( 'email' => $email['recipients'] ); } if ($email === false || isset($email['error']) || empty($p)) { // object returned 'false' - it does not know how to send it.. $ev = $this->addEvent('NOTIFY', $w, isset($email['error']) ? $email['error'] : "INTERNAL ERROR - We can not handle " . $w->ontable); $ww = clone($w); $w->sent = (!$w->sent || $w->sent == '0000-00-00 00:00:00') ? $w->sqlValue('NOW()') : $w->sent; // do not update if sent..... $w->msgid = ''; $w->event_id = $ev->id; $w->update($ww); $this->errorHandler(date('Y-m-d h:i:s ') . (isset($email['error']) ? $email['error'] : "INTERNAL ERROR - We can not handle " . $w->ontable) ."\n"); } if (isset($email['later'])) { $old = clone($w); $w->act_when = $email['later']; $w->update($old); $this->errorHandler(date('Y-m-d h:i:s ') . " Delivery postponed by email creator to {$email['later']}"); } if (empty($email['headers']['Message-Id'])) { $HOST = gethostname(); $email['headers']['Message-Id'] = "<{$this->table}-{$id}@{$HOST}>"; } //$p->email = 'alan@akbkhome.com'; //for testing.. //print_r($email);exit; // should we fetch the watch that caused it.. - which should contain the method to call.. // --send-to=test@xxx.com if (!empty($email['send-to'])) { $p->email = $email['send-to']; } if (!empty($opts['send-to'])) { $p->email = $opts['send-to']; } // since some of them have spaces?!?! $p->email = trim($p->email); require_once 'Validate.php'; if (!Validate::email($p->email, true)) { $ev = $this->addEvent('NOTIFY', $w, "INVALID ADDRESS: " . $p->email); $ww = clone($w); $w->sent = (!$w->sent || $w->sent == '0000-00-00 00:00:00') ? $w->sqlValue('NOW()') : $w->sent; // do not update if sent..... $w->msgid = ''; $w->event_id = $ev->id; $w->update($ww); $this->errorHandler(date('Y-m-d h:i:s ') . "INVALID ADDRESS: " . $p->email. "\n"); } $ff = HTML_FlexyFramework::get(); $explode_email = explode('@', $p->email); $dom = array_pop($explode_email); $mxs = $this->mxs($dom); $ww = clone($w); // we might fail doing this... // need to handle temporary failure.. // we try for 3 days.. $retry = 5; if (strtotime($w->act_start) < strtotime('NOW - 1 HOUR')) { // older that 1 hour. $retry = 15; } if (strtotime($w->act_start) < strtotime('NOW - 1 DAY')) { // older that 1 day. $retry = 60; } if (strtotime($w->act_start) < strtotime('NOW - 2 DAY')) { // older that 1 day. $retry = 120; } if ($mxs === false) { // only retry for 2 day son the MX issue.. if ($retry < 120) { $this->addEvent('NOTIFY', $w, 'MX LOOKUP FAILED ' . $dom ); $w->act_when = date('Y-m-d H:i:s', strtotime('NOW + ' . $retry . ' MINUTES')); $w->update($ww); $this->errorHandler(date('Y-m-d h:i:s') . " - MX LOOKUP FAILED\n"); } $ev = $this->addEvent('NOTIFY', $w, "BAD ADDRESS - BAD DOMAIN - ". $p->email ); $w->sent = (!$w->sent || $w->sent == '0000-00-00 00:00:00') ? $w->sqlValue('NOW()') : $w->sent; // do not update if sent..... $w->msgid = ''; $w->event_id = $ev->id; $w->update($ww); $this->errorHandler(date('Y-m-d h:i:s') . " - FAILED - BAD EMAIL - {$p->email} \n"); } if (!$force && strtotime($w->act_start) < strtotime('NOW - 14 DAY')) { $ev = $this->addEvent('NOTIFY', $w, "BAD ADDRESS - GIVE UP - ". $p->email ); $w->sent = (!$w->sent || $w->sent == '0000-00-00 00:00:00') ? $w->sqlValue('NOW()') :$w->sent; // do not update if sent..... $w->msgid = ''; $w->event_id = $ev->id; $w->update($ww); $this->errorHandler(date('Y-m-d h:i:s') . " - FAILED - GAVE UP TO OLD - {$p->email} \n"); } $w->to_email = $p->email; //$this->addEvent('NOTIFY', $w, 'GREYLISTED ' . $p->email . ' ' . $res->toString()); // we can only update act_when if it has not been sent already (only happens when running in force mode..) $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; $w->update($ww); $ww = clone($w); $fail = false; require_once 'Mail.php'; $core_domain = DB_DataObject::factory('core_domain'); if(!$core_domain->get('domain', $dom)){ $core_domain = DB_DataObject::factory('core_domain'); $core_domain->setFrom(array( 'domain' => $dom )); $core_domain->insert(); } foreach($mxs as $mx) { if (!isset($ff->Mail['helo'])) { $this->errorHandler("config Mail[helo] is not set"); } $this->debug_str = ''; $this->debug("Trying SMTP: $mx / HELO {$ff->Mail['helo']}"); $mailer = Mail::factory('smtp', array( 'host' => $mx , 'localhost' => $ff->Mail['helo'], 'timeout' => 15, 'socket_options' => isset($ff->Mail['socket_options']) ? $ff->Mail['socket_options'] : null, //'debug' => isset($opts['debug']) ? 1 : 0, 'debug' => 1, 'debug_handler' => array($this, 'debugHandler') )); // if the host is the mail host + it's authenticated add auth details // this normally will happen if you sent Pman_Core_NotifySend['host'] if (isset($ff->Mail['host']) && $ff->Mail['host'] == $mx && !empty($ff->Mail['auth'] )) { $username = $ff->Mail['username'] ; $password = $ff->Mail['password'] ; if(!empty($ff->Core_Notify) && !empty($ff->Core_Notify['routes'])){ foreach ($ff->Core_Notify['routes'] as $server => $settings){ if(!in_array($dom, $settings['domains'])){ continue; } // what's the minimum timespan.. - if we have 60/hour.. that's 1 every minute. // if it's newer that '1' minute... // then shunt it.. $seconds = floor((60 * 60) / $settings['rate']); $core_notify = DB_DataObject::factory($this->table); $core_notify->domain_id = $core_domain->id; $core_notify->whereAdd(" sent >= NOW() - INTERVAL $seconds SECONDS "); if($core_notify->count()){ $old = clone($w); $w->act_when = date("Y-m-d H:i:s", time() + $seconds); $w->update($old); $this->errorHandler(date('Y-m-d h:i:s ') . " Too many emails sent by {$dom}"); } // that make's this test obsolete... /* $core_notify = DB_DataObject::factory($this->table); $core_notify->domain_id = $core_domain->id; $core_notify->whereAdd(" sent >= NOW() - INTERVAL 1 HOUR "); if($core_notify->count() >= $settings['rate']){ $old = clone($w); $w->act_when = date("Y-m-d H:i:s", strtotime('+1 HOUR')); $w->update($old); $this->errorHandler(date('Y-m-d h:i:s ') . " Too many emails sent by {$dom}"); } */ $mailer->host = $server; $username = $settings['username']; $password = $settings['password']; break; } } $mailer->auth = true; $mailer->username = $username; $mailer->password = $password; } $res = $mailer->send($p->email, $email['headers'], $email['body']); if ($res === true) { // success.... $successEventName = (empty($email['successEventName'])) ? 'NOTIFYSENT' : $email['successEventName']; $ev = $this->addEvent($successEventName, $w, "{$w->to_email} - {$email['headers']['Subject']}"); $ev->writeEventLog($this->debug_str); if(strtotime($w->act_when) > strtotime("NOW")){ $w->act_when = date('Y-m-d H:i:s'); } $w->sent = (!$w->sent || $w->sent == '0000-00-00 00:00:00') ? $w->sqlValue('NOW()') : $w->sent; // do not update if sent..... $w->msgid = $email['headers']['Message-Id']; $w->event_id = $ev->id; // sent ok.. - no need to record it.. $w->domain_id = $core_domain->id; $w->update($ww); // enable cc in notify.. if (!empty($email['headers']['Cc'])) { $cmailer = Mail::factory('smtp', isset($ff->Mail) ? $ff->Mail : array() ); $email['headers']['Subject'] = "(CC): " . $email['headers']['Subject']; $cmailer->send($email['headers']['Cc'], $email['headers'], $email['body']); } if (!empty($email['bcc'])) { $cmailer = Mail::factory('smtp', isset($ff->Mail) ? $ff->Mail : array() ); $email['headers']['Subject'] = "(CC): " . $email['headers']['Subject']; $res = $cmailer->send($email['bcc'], $email['headers'], $email['body']); if (!$res || is_a($res, 'PEAR_Error')) { echo "could not send bcc..\n"; } else { echo "Sent BCC to {$email['bcc']}\n"; } } $this->errorHandler(date('Y-m-d h:i:s') . " - SENT {$w->id} - {$w->to_email} \n", true); } // what type of error.. $code = empty($res->userinfo['smtpcode']) ? -1 : $res->userinfo['smtpcode']; if (!empty($res->code) && $res->code == 10001) { // fake greylist if timed out. $code = 421; } if ($code < 0) { $this->debug($res->message); continue; // try next mx... ??? should we wait??? - nope we did not even connect.. } // give up after 2 days.. if (in_array($code, array( 421, 450, 451, 452)) && $next_try_min < (2*24*60)) { // try again later.. // check last event for this item.. //$errmsg= $fail ? ($res->userinfo['smtpcode'] . ': ' .$res->toString()) : " - UNKNOWN ERROR"; $errmsg= $res->userinfo['smtpcode'] . ': ' .$res->message ; if (!empty($res->userinfo['smtptext'])) { $errmsg= $res->userinfo['smtpcode'] . ':' . $res->userinfo['smtptext']; } //print_r($res); $this->addEvent('NOTIFY', $w, 'GREYLISTED - ' . $errmsg); $w->act_when = date('Y-m-d H:i:s', strtotime('NOW + ' . $retry . ' MINUTES')); $w->domain_id = $core_domain->id; $w->update($ww); $this->errorHandler(date('Y-m-d h:i:s') . " - GREYLISTED - $errmsg \n"); } $fail = true; break; } if ($fail || $next_try_min > (2*24*60)) { // fail.. = log and give up.. $errmsg= $fail ? ($res->userinfo['smtpcode'] . ': ' .$res->toString()) : " - UNKNOWN ERROR"; if (isset($res->userinfo['smtptext'])) { $errmsg= $res->userinfo['smtpcode'] . ':' . $res->userinfo['smtptext']; } $ev = $this->addEvent('NOTIFY', $w, ($fail ? "FAILED - " : "RETRY TIME EXCEEDED - ") . $errmsg); $w->sent = (!$w->sent || $w->sent == '0000-00-00 00:00:00') ? $w->sqlValue('NOW()') : $w->sent; // do not update if sent..... $w->msgid = ''; $w->event_id = $ev->id; $w->domain_id = $core_domain->id; $w->update($ww); $this->errorHandler(date('Y-m-d h:i:s') . ' - FAILED - '. ($fail ? $res->toString() : "RETRY TIME EXCEEDED\n")); } // handle no host availalbe forever... if (strtotime($w->act_start) < strtotime('NOW - 3 DAYS')) { $ev = $this->addEvent('NOTIFY', $w, "RETRY TIME EXCEEDED - ". $p->email); $w->sent = (!$w->sent || $w->sent == '0000-00-00 00:00:00') ? $w->sqlValue('NOW()') : $w->sent; // do not update if sent..... $w->msgid = ''; $w->event_id = $ev->id; $w->domain_id = $core_domain->id; $w->update($ww); $this->errorHandler(date('Y-m-d h:i:s') . " - FAILED - RETRY TIME EXCEEDED\n"); } $this->addEvent('NOTIFY', $w, 'NO HOST CAN BE CONTACTED:' . $p->email); $w->act_when = date('Y-m-d H:i:s', strtotime('NOW + 5 MINUTES')); $w->domain_id = $core_domain->id; $w->update($ww); $this->errorHandler(date('Y-m-d h:i:s') ." - NO HOST AVAILABLE\n"); } function mxs($fqdn) { $ff = HTML_FlexyFramework::get(); if (isset($ff->Pman_Core_NotifySend['host'])) { return array($ff->Pman_Core_NotifySend['host']); } $mx_records = array(); $mx_weight = array(); $mxs = array(); if (!getmxrr($fqdn, $mx_records, $mx_weight)) { if (!checkdnsrr($fqdn)) { return false; } return array($fqdn); } asort($mx_weight,SORT_NUMERIC); foreach($mx_weight as $k => $weight) { $mxs[] = $mx_records[$k]; } return $mxs; } /** * wrapper to call object->toEmail() * * return * { headers : {AssocArray}, body: {String} // optional.. error : {String} // error message in log. send-to: {String} // use to override rcpt } **/ function makeEmail($object, $rcpt, $last_sent_date, $notify, $force =false) { $m = 'notify'. $notify->evtype; //var_dump(get_class($object) . '::' .$m); if (!empty($notify->evtype) && method_exists($object,$m)) { echo "calling :" . get_class($object) . '::' .$m . "\n"; return $object->$m($rcpt, $last_sent_date, $notify, $force); } $type = explode('::', $notify->evtype); if(!empty($type[1]) && method_exists($object,$type[1])){ $m = $type[1]; echo "calling :" . get_class($object) . '::' .$m . "\n"; return $object->$m($rcpt, $last_sent_date, $notify, $force); } if (method_exists($object, 'toMailerData')) { return $object->toMailerData(array( 'rcpts'=>$rcpt, 'person'=>$rcpt, // added as mediaoutreach used this? )); //this is core_email - i think it's only used for testing... //var_Dump($object); //exit; } return $object->toEmail($rcpt, $last_sent_date, $notify, $force); } function debug($str) { if (empty($this->cli_args['debug'])) { return; } echo $str . "\n"; } function output() { $this->errorHandler("done\n"); } var $debug_str = ''; function debugHandler ($smtp, $message) { $this->debug_str .= strlen($this->debug_str) ? "\n" : ''; $this->debug_str .= $message; } function errorHandler($msg, $success = false) { if($this->error_handler == 'exception'){ if($success){ throw new Pman_Core_NotifySend_Exception_Success($msg); } throw new Pman_Core_NotifySend_Exception_Fail($msg); } die($msg); } }