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