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
  30
  31 class Pman_Core_NotifySend extends Pman
  32 {
  33     static $cli_desc = "Send out single notification email (usually called from  Core/Notify)";
  34
  35     static $cli_opts = array(
  36         'debug' => array(
  37             'desc' => 'Turn on debugging (see DataObjects debugLevel )',
  38             'default' => 0,
  39             'short' => 'v',
  40             'min' => 0,
  41             'max' => 0,
  42
  43         ),
  44         'DB_DataObject-debug' => array(
  45             'desc' => 'Turn on debugging (see DataObjects debugLevel )',
  46             'default' => 0,
  47             'short' => 'd',
  48             'min' => 1,
  49             'max' => 1,
  50
  51         ),
  52         'force' => array(
  53             'desc' => 'Force redelivery, even if it has been sent before or not queued...',
  54             'default' => 0,
  55             'short' => 'f',
  56             'min' => 0,
  57             'max' => 0,
  58         ),
  59         'send-to' => array(
  60             'desc' => 'Send the message to this address, rather than the one listed.',
  61             'default' => '',
  62             'short' => 't',
  63             'min' => 0,
  64             'max' => 1,
  65         )
  66
  67
  68
  69     );
  70     var $table = 'core_notify';
  71     var $error_handler = 'die';
  72
  73     function getAuth()
  74     {
  75         $ff = HTML_FlexyFramework::get();
  76         if (!$ff->cli) {
  77             $this->errorHandler("access denied");
  78         }
  79         //HTML_FlexyFramework::ensureSingle(__FILE__, $this);
  80         return true;
  81
  82     }
  83
  84     function get($id,$opts)
  85     {
  86
  87         //print_r($opts);
  88         if (!empty($opts['DB_DataObject-debug'])) {
  89             DB_DataObject::debugLevel($opts['DB_DataObject-debug']);
  90         }
  91
  92         //DB_DataObject::debugLevel(1);
  93         //date_default_timezone_set('UTC');
  94         // phpinfo();exit;
  95         $force = empty($opts['force']) ? 0 : 1;
  96
  97         $w = DB_DataObject::factory($this->table);
  98
  99         if (!$w->get($id)) {
 100             $this->errorHandler("invalid id\n");
 101         }
 102         if (!$force && strtotime($w->act_when) < strtotime($w->sent)) {
 103
 104
 105             $this->errorHandler("send repeat to early\n");
 106         }
 107         if (!empty($opts['debug'])) {
 108             print_r($w);
 109             $ff = HTML_FlexyFramework::get();
 110             if (!isset($ff->Core_Mailer)) {
 111                 $ff->Core_Mailer = array();
 112             }
 113             HTML_FlexyFramework::get()->Core_Mailer['debug'] = true;
 114         }
 115
 116         $sent = (empty($w->sent) || preg_match('/^0000/', $w->sent)) ? false : true;
 117
 118         if (!$force && (!empty($w->msgid) || $sent)) {
 119             $ww = clone($w);
 120             if (!$sent) {
 121                 $w->sent = $w->sqlValue("NOW()");
 122                 $w->update($ww);
 123             }
 124             $this->errorHandler("message has been sent already.\n");
 125         }
 126
 127         $o = $w->object();
 128
 129         if ($o === false)  {
 130
 131             $ev = $this->addEvent('NOTIFY', $w,
 132                             "Notification event cleared (underlying object does not exist)" );;
 133             $ww = clone($w);
 134             $w->sent = date('Y-m-d H:i:s');
 135             $w->msgid = '';
 136             $w->event_id = $ev->id;
 137             $w->update($ww);
 138             $this->errorHandler(date('Y-m-d h:i:s ') .
 139                      "Notification event cleared (underlying object does not exist)"
 140                     ."\n");
 141         }
 142
 143
 144
 145         $p = $w->person();
 146
 147         if (isset($p->active) && empty($p->active)) {
 148             $ev = $this->addEvent('NOTIFY', $w,
 149                             "Notification event cleared (not user not active any more)" );;
 150             $ww = clone($w);
 151             $w->sent = date('Y-m-d H:i:s');
 152             $w->msgid = '';
 153             $w->event_id = $ev->id;
 154             $w->update($ww);
 155             $this->errorHandler(date('Y-m-d h:i:s ') .
 156                      "Notification event cleared (not user not active any more)"
 157                     ."\n");
 158             $this->errorHandler("message has been sent already.\n");
 159         }
 160
 161
 162         // let's work out the last notification sent to this user..
 163         $l = DB_DataObject::factory($this->table);
 164
 165         $lar = array(
 166                 'ontable' => $w->ontable,
 167                 'onid' => $w->onid,
 168         );
 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};
 173         }
 174
 175
 176         $l->setFrom( $lar );
 177         $l->whereAdd('id != '. $w->id);
 178         $l->orderBy('sent DESC');
 179         $l->limit(1);
 180         $ar = $l->fetchAll('sent');
 181         $last = empty($ar) ? date('Y-m-d H:i:s', 0) : $ar[0];
 182
 183         // find last event..
 184         $ev = DB_DataObject::factory('Events');
 185         $ev->on_id = $w->id;                           // int(11)
 186         $ev->on_table = $this->table;
 187         $ev->limit(1);
 188         $ev->orderBy('event_when DESC');
 189         $ar = $ev->fetchAll('event_when');
 190         $last_event = empty($ar) ? 0 : $ar[0];
 191         $next_try_min = 5;
 192         if ($last_event) {
 193             $next_try_min = floor((time() - strtotime($last_event)) / 60) * 2;
 194         }
 195         $next_try = $next_try_min . ' MINUTES';
 196
 197         // this may modify $p->email. (it will not update it though)
 198         $email =  $this->makeEmail($o, $p, $last, $w, $force);
 199
 200         if ($email === true)  {
 201
 202             $ev = $this->addEvent('NOTIFY', $w,
 203                             "Notification event cleared (not required any more)" );;
 204             $ww = clone($w);
 205             $w->sent = date('Y-m-d H:i:s');
 206             $w->msgid = '';
 207             $w->event_id = $ev->id;
 208             $w->update($ww);
 209             $this->errorHandler(date('Y-m-d h:i:s ') .
 210                      "Notification event cleared (not required any more)"
 211                     ."\n");
 212         }
 213
 214         if (empty($p) && !empty($email['rcpts'])) {
 215             // make a fake person..
 216             $p = (object) array(
 217                 'email' => $email['rcpts']
 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('NOTIFY', $w, isset($email['error'])  ?
 224                             $email['error'] : "INTERNAL ERROR  - We can not handle " . $w->ontable);
 225             $ww = clone($w);
 226             $w->sent = date('Y-m-d H:i:s');
 227             $w->msgid = '';
 228             $w->event_id = $ev->id;
 229             $w->update($ww);
 230             $this->errorHandler(date('Y-m-d h:i:s ') .
 231                     (isset($email['error'])  ?
 232                             $email['error'] : "INTERNAL ERROR  - We can not handle " . $w->ontable)
 233                     ."\n");
 234         }
 235
 236
 237         if (isset($email['later'])) {
 238             $old = clone($w);
 239             $w->act_when = $email['later'];
 240             $w->update($old);
 241             $this->errorHandler(date('Y-m-d h:i:s ') . " Delivery postponed by email creator to {$email['later']}");
 242         }
 243
 244
 245         if (empty($email['headers']['Message-Id'])) {
 246             $HOST = gethostname();
 247             $email['headers']['Message-Id'] = "<{$this->table}-{$id}@{$HOST}>";
 248
 249         }
 250
 251
 252         if (empty($p)) {
 253
 254
 255         //$p->email = 'alan@akbkhome.com'; //for testing..
 256         //print_r($email);exit;
 257         // should we fetch the watch that caused it.. - which should contain the method to call..
 258         // --send-to=test@xxx.com
 259
 260         if (!empty($email['send-to'])) {
 261             $p->email = $email['send-to'];
 262         }
 263          if (!empty($opts['send-to'])) {
 264             $p->email = $opts['send-to'];
 265         }
 266
 267             // since some of them have spaces?!?!
 268             $p->email = trim($p->email);
 269         }
 270
 271         require_once 'Validate.php';
 272         if (!Validate::email($p->email, true)) {
 273             $ev = $this->addEvent('NOTIFY', $w, "INVALID ADDRESS: " . $p->email);
 274             $ww = clone($w);
 275             $w->sent = date('Y-m-d H:i:s');
 276             $w->msgid = '';
 277             $w->event_id = $ev->id;
 278             $w->update($ww);
 279             $this->errorHandler(date('Y-m-d h:i:s ') . "INVALID ADDRESS: " . $p->email. "\n");
 280
 281         }
 282
 283
 284         $ff = HTML_FlexyFramework::get();
 285
 286
 287         $dom = array_pop(explode('@', $p->email));
 288
 289         $mxs = $this->mxs($dom);
 290         $ww = clone($w);
 291
 292         // we might fail doing this...
 293         // need to handle temporary failure..
 294
 295
 296           // we try for 3 days..
 297         $retry = 5;
 298         if (strtotime($w->act_start) <  strtotime('NOW - 1 HOUR')) {
 299             // older that 1 hour.
 300             $retry = 15;
 301         }
 302
 303         if (strtotime($w->act_start) <  strtotime('NOW - 1 DAY')) {
 304             // older that 1 day.
 305             $retry = 60;
 306         }
 307         if (strtotime($w->act_start) <  strtotime('NOW - 2 DAY')) {
 308             // older that 1 day.
 309             $retry = 120;
 310         }
 311
 312         if ($mxs === false) {
 313             // only retry for 2 day son the MX issue..
 314             if ($retry < 120) {
 315                 $this->addEvent('NOTIFY', $w, 'MX LOOKUP FAILED ' . $dom );
 316                 $w->act_when = date('Y-m-d H:i:s', strtotime('NOW + ' . $retry . ' MINUTES'));
 317                 $w->update($ww);
 318                 $this->errorHandler(date('Y-m-d h:i:s') . " - MX LOOKUP FAILED\n");
 319             }
 320
 321             $ev = $this->addEvent('NOTIFY', $w, "BAD ADDRESS - BAD DOMAIN - ". $p->email );
 322             $w->sent = date('Y-m-d H:i:s');
 323             $w->msgid = '';
 324             $w->event_id = $ev->id;
 325             $w->update($ww);
 326             $this->errorHandler(date('Y-m-d h:i:s') . " - FAILED -  BAD EMAIL - {$p->email} \n");
 327
 328
 329         }
 330
 331
 332
 333
 334         if (!$force && strtotime($w->act_start) <  strtotime('NOW - 14 DAY')) {
 335             $ev = $this->addEvent('NOTIFY', $w, "BAD ADDRESS - GIVE UP - ". $p->email );
 336             $w->sent = date('Y-m-d H:i:s');
 337             $w->msgid = '';
 338             $w->event_id = $ev->id;
 339             $w->update($ww);
 340             $this->errorHandler(date('Y-m-d h:i:s') . " - FAILED -  GAVE UP TO OLD - {$p->email} \n");
 341         }
 342
 343
 344
 345         $w->to_email = $p->email;
 346         //$this->addEvent('NOTIFY', $w, 'GREYLISTED ' . $p->email . ' ' . $res->toString());
 347         $w->act_when = date('Y-m-d H:i:s', strtotime('NOW + ' . $retry . ' MINUTES'));
 348         $w->update($ww);
 349
 350         $ww = clone($w);
 351
 352         $fail = false;
 353         require_once 'Mail.php';
 354
 355         foreach($mxs as $dom) {
 356
 357
 358
 359             if (!isset($ff->Mail['helo'])) {
 360                 $this->errorHandler("config Mail[helo] is not set");
 361             }
 362             $this->debug_str = '';
 363             $this->debug("Trying SMTP: $dom / HELO {$ff->Mail['helo']}");
 364             $mailer = Mail::factory('smtp', array(
 365                     'host'    => $dom ,
 366                     'localhost' => $ff->Mail['helo'],
 367                     'timeout' => 15,
 368                     'socket_options' =>  isset($ff->Mail['socket_options']) ? $ff->Mail['socket_options'] : null,
 369                     //'debug' => isset($opts['debug']) ?  1 : 0,
 370                     'debug' => 1,
 371                     'debug_handler' => array($this, 'debugHandler')
 372                 ));
 373
 374             // if the host is the mail host + it's authenticated add auth details
 375             // this normally will happen if you sent  Pman_Core_NotifySend['host']
 376             if (isset($ff->Mail['host']) && $ff->Mail['host'] == $dom && !empty($ff->Mail['auth'] )) {
 377                 $mailer->auth = true;
 378                 $mailer->username = $ff->Mail['username'] ;
 379                 $mailer->password = $ff->Mail['password'] ;
 380             }
 381
 382             $res = $mailer->send($p->email, $email['headers'], $email['body']);
 383
 384
 385             if ($res === true) {
 386                 // success....
 387
 388                 $ev = $this->addEvent('NOTIFYSENT', $w, "{$w->to_email} - {$email['headers']['Subject']}");
 389
 390                 $ev->writeEventLog($this->debug_str);
 391
 392                 $w->sent = date('Y-m-d H:i:s');
 393                 $w->msgid = $email['headers']['Message-Id'];
 394                 $w->event_id = $ev->id; // sent ok.. - no need to record it..
 395                 $w->update($ww);
 396
 397                 // enable cc in notify..
 398                 if (!empty($email['headers']['Cc'])) {
 399                     $cmailer = Mail::factory('smtp',  isset($ff->Mail) ? $ff->Mail : array() );
 400                     $email['headers']['Subject'] = "(CC): " . $email['headers']['Subject'];
 401                     $cmailer->send($email['headers']['Cc'],
 402                                   $email['headers'], $email['body']);
 403
 404                 }
 405
 406                 if (!empty($email['bcc'])) {
 407                     $cmailer = Mail::factory('smtp', isset($ff->Mail) ? $ff->Mail : array() );
 408                     $email['headers']['Subject'] = "(CC): " . $email['headers']['Subject'];
 409                     $res = $cmailer->send($email['bcc'],
 410                                   $email['headers'], $email['body']);
 411                     if (!$res || is_a($res, 'PEAR_Error')) {
 412                         echo "could not send bcc..\n";
 413                     } else {
 414                         echo "Sent BCC to {$email['bcc']}\n";
 415                     }
 416                 }
 417
 418
 419                 $this->errorHandler(date('Y-m-d h:i:s') . " - SENT {$w->id} - {$w->to_email} \n");
 420             }
 421             // what type of error..
 422             $code = empty($res->userinfo['smtpcode']) ? -1 : $res->userinfo['smtpcode'];
 423             if (!empty($res->code) && $res->code == 10001) {
 424                 // fake greylist if timed out.
 425                 $code = 421;
 426             }
 427
 428             if ($code < 0) {
 429                 $this->debug($res->message);
 430                 continue; // try next mx... ??? should we wait??? - nope we did not even connect..
 431             }
 432             // give up after 2 days..
 433             if (in_array($code, array( 421, 450, 451, 452))   && $next_try_min < (2*24*60)) {
 434                 // try again later..
 435                 // check last event for this item..
 436                 //$errmsg=  $fail ? ($res->userinfo['smtpcode'] . ': ' .$res->toString()) :  " - UNKNOWN ERROR";
 437                 $errmsg=  $res->userinfo['smtpcode'] . ': ' .$res->message ;
 438                 if (!empty($res->userinfo['smtptext'])) {
 439                     $errmsg=  $res->userinfo['smtpcode'] . ':' . $res->userinfo['smtptext'];
 440                 }
 441                 //print_r($res);
 442                 $this->addEvent('NOTIFY', $w, 'GREYLISTED - ' . $errmsg);
 443                 $w->act_when = date('Y-m-d H:i:s', strtotime('NOW + ' . $retry . ' MINUTES'));
 444                 $w->update($ww);
 445
 446
 447                 $this->errorHandler(date('Y-m-d h:i:s') . " - GREYLISTED -  $errmsg \n");
 448             }
 449             $fail = true;
 450             break;
 451         }
 452         if ($fail || $next_try_min > (2*24*60)) {
 453         // fail.. = log and give up..
 454             $errmsg=  $fail ? ($res->userinfo['smtpcode'] . ': ' .$res->toString()) :  " - UNKNOWN ERROR";
 455             if (isset($res->userinfo['smtptext'])) {
 456                 $errmsg=  $res->userinfo['smtpcode'] . ':' . $res->userinfo['smtptext'];
 457             }
 458
 459             $ev = $this->addEvent('NOTIFY', $w, ($fail ? "FAILED - " : "RETRY TIME EXCEEDED - ") .
 460                        $errmsg);
 461             $w->sent = date('Y-m-d H:i:s');
 462             $w->msgid = '';
 463             $w->event_id = $ev->id;
 464             $w->update($ww);
 465             $this->errorHandler(date('Y-m-d h:i:s') . ' - FAILED - '. ($fail ? $res->toString() : "RETRY TIME EXCEEDED\n"));
 466         }
 467
 468         // handle no host availalbe forever...
 469         if (strtotime($w->act_start) < strtotime('NOW - 3 DAYS')) {
 470             $ev = $this->addEvent('NOTIFY', $w, "RETRY TIME EXCEEDED - ". $p->email);
 471             $w->sent = date('Y-m-d H:i:s');
 472             $w->msgid = '';
 473             $w->event_id = $ev->id;
 474             $w->update($ww);
 475             $this->errorHandler(date('Y-m-d h:i:s') . " - FAILED - RETRY TIME EXCEEDED\n");
 476         }
 477
 478
 479         $this->addEvent('NOTIFY', $w, 'NO HOST CAN BE CONTACTED:' . $p->email);
 480         $w->act_when = date('Y-m-d H:i:s', strtotime('NOW + 5 MINUTES'));
 481         $w->update($ww);
 482         $this->errorHandler(date('Y-m-d h:i:s') ." - NO HOST AVAILABLE\n");
 483
 484
 485     }
 486     function mxs($fqdn)
 487     {
 488         $ff = HTML_FlexyFramework::get();
 489         if (isset($ff->Pman_Core_NotifySend['host'])) {
 490             return array($ff->Pman_Core_NotifySend['host']);
 491         }
 492
 493         $mx_records = array();
 494         $mx_weight = array();
 495         $mxs = array();
 496         if (!getmxrr($fqdn, $mx_records, $mx_weight)) {
 497             if (!checkdnsrr($fqdn)) {
 498                 return false;
 499             }
 500             return array($fqdn);
 501         }
 502
 503         asort($mx_weight,SORT_NUMERIC);
 504
 505         foreach($mx_weight as $k => $weight) {
 506             $mxs[] = $mx_records[$k];
 507         }
 508         return $mxs;
 509     }
 510
 511     /**
 512      * wrapper to call object->toEmail()
 513      *
 514      * return
 515      *   {
 516         headers : {AssocArray},
 517         body: {String}
 518
 519         // optional..
 520         error :  {String} // error message in log.
 521         send-to: {String} // use to override rcpt
 522
 523      }
 524      **/
 525     function makeEmail($object, $rcpt, $last_sent_date, $notify, $force =false)
 526     {
 527         $m = 'notify'. $notify->evtype;
 528         //var_dump(get_class($object) . '::' .$m);
 529         if (!empty($notify->evtype) && method_exists($object,$m)) {
 530             echo "calling :" . get_class($object) . '::' .$m . "\n";
 531             return $object->$m($rcpt, $last_sent_date, $notify, $force);
 532         }
 533
 534         $type = explode('::', $notify->evtype);
 535
 536         if(!empty($type[1]) && method_exists($object,$type[1])){
 537             $m = $type[1];
 538             echo "calling :" . get_class($object) . '::' .$m . "\n";
 539             return $object->$m($rcpt, $last_sent_date, $notify, $force);
 540         }
 541
 542         if (!method_exists($object, 'toEmail')) {
 543             //var_Dump($object);
 544             //exit;
 545         }
 546
 547         return $object->toEmail($rcpt, $last_sent_date, $notify, $force);
 548     }
 549
 550     function debug($str)
 551     {
 552         if (empty($this->cli_args['debug'])) {
 553             return;
 554
 555         }
 556         echo $str . "\n";
 557     }
 558     function output()
 559     {
 560         $this->errorHandler("done\n");
 561     }
 562     var $debug_str = '';
 563
 564     function debugHandler ($smtp, $message)
 565     {
 566         $this->debug_str .= strlen($this->debug_str) ? "\n" : '';
 567         $this->debug_str .= $message;
 568     }
 569
 570     function errorHandler($msg)
 571     {
 572         if($this->error_handler == 'exception'){
 573             throw new Exception($msg);
 574         }
 575
 576         die($msg);
 577
 578
 579     }
 580 }