git.roojs.org Git - Pman.Core/blob - Mailer.php

   1 <?php
   2
   3 /**
   4  *
   5  *  code that used to be in Pman (sendTemplate / emailTemplate)
   6  *
   7  *  template is in template directory subfolder 'mail'
   8  *
   9  *  eg. use 'welcome' as template -> this will use templates/mail/welcome.txt
  10  *  if you also have templates/mail/welcome.body.html - then that will be used as
  11  *     the html body
  12  *
  13  *
  14  *  usage:
  15  *
  16  *
  17  *  require_once 'Pman/Core/Mailer.php';
  18  *  $x= new  Pman_Core_Mailer(array(
  19        'page' => $this,
  20                 // if bcc is property of this, then it will be used (BAD DESIGN)
  21        'rcpts' => array(),
  22        'template' => 'your_template',
  23                 // must be in templates/mail direcotry..
  24                 // header and plaintext verison in mail/your_template.txt
  25                 // if you want a html body - use  mail/your_template.body.html
  26
  27         // 'bcc' => 'xyz@abc.com,abc@xyz.com',  // string...
  28         // 'contents'  => array(),              //  << keys must be trusted
  29                                             // if bcc is property of contents, then it will be used (BAD DESIGN)
  30
  31         // 'html_locale => 'en',                // always use the 'english translated verison'
  32         // 'cache_images => true,               // -- defaults to caching images - set to false to disable.
  33         // 'replaceImages => false,             // should images be replaced.
  34         // 'urlmap => array(                    // map urls from template to a different location.
  35         //      'https://www.mysite.com/' => 'http://localhost/',
  36         // ),
  37         // 'locale' => 'en',                    // .... or zh_hk....
  38
  39         // 'attachments' => array(
  40         //       array(
  41         //        'file' => '/path/to/file',    // file location
  42         //        name => 'myfile.pdf',         // (optional) - uses basename of file
  43         //        mimetype :
  44         //      ),
  45         //
  46         // 'mail_method' =>  'SMTP',            // or SMTPMX
  47
  48     )
  49  *
  50  *  recipents is gathered from the resulting template
  51  *   -- eg.
  52  *    To: <a>,<b>,<c>
  53  *
  54  *
  55  *  if the file     '
  56  *
  57  *
  58  *  $x->toData(); // returns data needed for notify?? - notify should really
  59  *                  // just use this to pass around later..
  60  *
  61  *  $x->send();
  62  *
  63  */
  64
  65 class Pman_Core_Mailer {
  66     var $debug          = 0;
  67     var $page           = false; /* usually a html_flexyframework_page */
  68     var $contents       = false; /* object or array */
  69     var $template       = false; /* string */
  70     var $replaceImages  = false; /* boolean */
  71     var $rcpts   = false;
  72     var $templateDir = false;
  73     var $locale = false; // eg. 'en' or 'zh_HK'
  74     var $urlmap = array();
  75
  76
  77     var $html_locale = false; // eg. 'en' or 'zh_HK'
  78     var $images         = array(); // generated list of cid images for sending
  79     var $attachments = false;
  80     var $css_inline = false; // put the css into the html
  81     var $css_embed = false; // put the css tags into the body.
  82
  83     var $mail_method = 'SMTP';
  84
  85     var $cache_images = true;
  86
  87     var $bcc = false;
  88
  89     var $body_cls = false;
  90
  91     function __construct($args) {
  92         foreach($args as $k=>$v) {
  93             // a bit trusting..
  94             $this->$k =  $v;
  95         }
  96         // allow core mailer debug setting.
  97         $ff = HTML_FlexyFramework::get();
  98
  99         if (!empty($ff->Core_Mailer['debug'])) {
 100             $this->debug = $ff->Core_Mailer['debug'];
 101         }
 102         //$this->log("URL MAP");
 103         //$this->log($this->urlmap);
 104
 105     }
 106
 107     /**
 108      * ---------------- Global Tools ---------------
 109      */
 110
 111     function toData()
 112     {
 113         $templateFile = $this->template;
 114         $args = (array)$this->contents;
 115         $content  = clone($this->page);
 116
 117         foreach($args as $k=>$v) {
 118             $content->$k = $v;
 119         }
 120
 121         $content->msgid = empty($content->msgid ) ? md5(time() . rand()) : $content->msgid ;
 122
 123         $ff = HTML_FlexyFramework::get();
 124         $http_host = isset($_SERVER["HTTP_HOST"]) ? $_SERVER["HTTP_HOST"] : 'pman.HTTP_HOST.not.set';
 125         if (isset($ff->Pman['HTTP_HOST']) && $http_host != 'localhost') {
 126             $http_host  = $ff->Pman['HTTP_HOST'];
 127         }
 128
 129         $content->HTTP_HOST = $http_host;
 130
 131         // this should be done by having multiple template sources...!!!
 132
 133         require_once 'HTML/Template/Flexy.php';
 134
 135         $tmp_opts = array(
 136            // 'forceCompile' => true,
 137             'site_prefix' => false,
 138             'multiSource' => true,
 139         );
 140         if (!empty($this->templateDir)) {
 141             $tmp_opts['templateDir'] = $this->templateDir;
 142         }
 143         $fopts = HTML_FlexyFramework::get()->HTML_Template_Flexy;
 144         if (!empty($fopts['DB_DataObject_translator'])) {
 145             $tmp_opts['DB_DataObject_translator'] = $fopts['DB_DataObject_translator'];
 146         }
 147         if (!empty($fopts['locale'])) {
 148             $tmp_opts['locale'] = $fopts['locale'];
 149         }
 150
 151         // local opt's overwrite
 152         if (!empty($this->locale)) {
 153             $tmp_opts['locale'] = $this->locale;
 154         }
 155
 156         $htmlbody = false;
 157         $html_tmp_opts = $tmp_opts;
 158         $htmltemplate = new HTML_Template_Flexy( $html_tmp_opts );
 159         if (is_string($htmltemplate->resolvePath('mail/'.$templateFile.'.body.html')) ) {
 160             // then we have a multi-part email...
 161             if (!empty($this->html_locale)) {
 162                 $html_tmp_opts['locale'] = $this->html_locale;
 163             }
 164             $htmltemplate = new HTML_Template_Flexy( $html_tmp_opts );
 165
 166             $htmltemplate->compile('mail/'. $templateFile.'.body.html');
 167             $htmlbody =  $htmltemplate->bufferedOutputObject($content);
 168
 169             $this->htmlbody = $htmlbody;
 170
 171             // for the html body, we may want to convert the attachments to images.
 172 //            var_dump($htmlbody);exit;
 173
 174             if(!empty($content->body_cls) && strlen($content->body_cls)){
 175                 $htmlbody = $this->htmlbodySetClass($htmlbody, $content->body_cls);
 176             }
 177
 178             if ($this->replaceImages) {
 179                 $htmlbody = $this->htmlbodytoCID($htmlbody);
 180             }
 181
 182             if ($this->css_embed) {
 183                 $htmlbody = $this->htmlbodyCssEmbed($htmlbody);
 184             }
 185
 186             if ($this->css_inline && strlen($this->css_inline)) {
 187                 $htmlbody = $this->htmlbodyInlineCss($htmlbody);
 188             }
 189
 190         }
 191         $tmp_opts['nonHTML'] = true;
 192
 193
 194         //print_R($tmp_opts);
 195         // $tmp_opts['force'] = true;
 196
 197         $template = new HTML_Template_Flexy(  $tmp_opts );
 198         $template->compile('mail/'. $templateFile.'.txt');
 199
 200         /* use variables from this object to ouput data. */
 201         $mailtext = $template->bufferedOutputObject($content);
 202         //print_r($mailtext);exit;
 203
 204
 205
 206         //echo "<PRE>";print_R($mailtext);
 207
 208         /* With the output try and send an email, using a few tricks in Mail_MimeDecode. */
 209         require_once 'Mail/mimeDecode.php';
 210         require_once 'Mail.php';
 211
 212         $decoder = new Mail_mimeDecode($mailtext);
 213         $parts = $decoder->getSendArray();
 214         if (PEAR::isError($parts)) {
 215             return $parts;
 216             //echo "PROBLEM: {$parts->message}";
 217             //exit;
 218         }
 219
 220         $isMime = false;
 221
 222         require_once 'Mail/mime.php';
 223         $mime = new Mail_mime(array(
 224             'eol' => "\n",
 225             //'html_encoding' => 'base64',
 226             'html_charset' => 'utf-8',
 227             'text_charset' => 'utf-8',
 228             'head_charset' => 'utf-8',
 229         ));
 230         // clean up the headers...
 231
 232
 233         $parts[1]['Message-Id'] = '<' .   $content->msgid   .
 234                                      '@' . $content->HTTP_HOST .'>';
 235
 236
 237         if ($htmlbody !== false) {
 238             // got a html headers...
 239
 240             if (isset($parts[1]['Content-Type'])) {
 241                 unset($parts[1]['Content-Type']);
 242             }
 243             $mime->setTXTBody($parts[2]);
 244             $mime->setHTMLBody($htmlbody);
 245 //            var_dump($mime);exit;
 246             foreach($this->images as $cid=>$cdata) {
 247
 248                 $mime->addHTMLImage(
 249                     $cdata['file'],
 250                      $cdata['mimetype'],
 251                      $cid.'.'.$cdata['ext'],
 252                     true,
 253                     $cdata['contentid']
 254                 );
 255             }
 256             $isMime = true;
 257         }
 258
 259         if(!empty($this->attachments)){
 260             //if got a attachments
 261             $header = $mime->headers($parts[1]);
 262
 263             if (isset($parts[1]['Content-Type'])) {
 264                 unset($parts[1]['Content-Type']);
 265             }
 266
 267             if (!$isMime) {
 268
 269                 if(preg_match('/text\/html/', $header['Content-Type'])){
 270                     $mime->setHTMLBody($parts[2]);
 271                     $mime->setTXTBody('This message is in HTML only');
 272                 }else{
 273                     $mime->setTXTBody($parts[2]);
 274                     $mime->setHTMLBody('<PRE>'.htmlspecialchars($parts[2]).'</PRE>');
 275                 }
 276             }
 277             foreach($this->attachments as $attch){
 278                 $mime->addAttachment(
 279                         $attch['file'],
 280                         $attch['mimetype'],
 281                         (!empty($attch['name'])) ? $attch['name'] : '',
 282                         true
 283                 );
 284             }
 285
 286             $isMime = true;
 287         }
 288
 289         if($isMime){
 290             $parts[2] = $mime->get();
 291             $parts[1] = $mime->headers($parts[1]);
 292         }
 293
 294
 295         $ret = array(
 296             'recipents' => $parts[0],
 297             'headers' => $parts[1],
 298             'body' => $parts[2],
 299             'mailer' => $this
 300         );
 301         if ($this->rcpts !== false) {
 302             $ret['recipents'] =  $this->rcpts;
 303         }
 304         // if 'to' is empty, then add the recipents in there... (must be an array?
 305         if (!empty($ret['recipents']) && is_array($ret['recipents']) &&
 306                 (empty($ret['headers']['To']) || !strlen(trim($ret['headers']['To'])))) {
 307             $ret['headers']['To'] = implode(',', $ret['recipents']);
 308         }
 309
 310
 311         // add bcc if necessary..
 312         if (!empty($this->bcc)) {
 313            $ret['bcc'] = $this->bcc;
 314         }
 315         return $ret;
 316     }
 317     function send($email = false)
 318     {
 319
 320         $ff = HTML_FlexyFramework::get();
 321
 322         $pg = $ff->page;
 323
 324         $email = is_array($email)  ? $email : $this->toData();
 325
 326         if (is_a($email, 'PEAR_Error')) {
 327             $pg->addEvent("COREMAILER-FAIL",  false, "email toData failed");
 328
 329
 330             return $email;
 331         }
 332
 333         //$this->log( htmlspecialchars(print_r($email,true)));
 334
 335         ///$recipents = array($this->email);
 336 //        $mailOptions = PEAR::getStaticProperty('Mail','options');
 337
 338         $mailOptions = isset($ff->Mail) ? $ff->Mail : array();
 339         //print_R($mailOptions);exit;
 340
 341         if ($this->mail_method == 'SMTPMX' && empty($mailOptions['mailname'])) {
 342             $pg->jerr("Mail[mailname] is not set - this is required for SMTPMX");
 343
 344         }
 345
 346         $mail = Mail::factory($this->mail_method,$mailOptions);
 347         if ($this->debug) {
 348             $mail->debug = (bool) $this->debug;
 349         }
 350
 351         $email['headers']['Date'] = date('r');
 352         if (PEAR::isError($mail)) {
 353             $pg->addEvent("COREMAILER-FAIL",  false, "mail factory failed");
 354
 355
 356             return $mail;
 357         }
 358         $rcpts = $this->rcpts == false ? $email['recipents'] : $this->rcpts;
 359
 360
 361
 362         // this makes contents untrustable...
 363         if (!empty($this->contents['bcc']) && is_array($this->contents['bcc'])) {
 364             $rcpts =array_merge(is_array($rcpts) ? $rcpts : array($rcpts), $this->contents['bcc']);
 365         }
 366
 367         $oe = error_reporting(E_ALL & ~E_NOTICE & ~E_STRICT);
 368         if ($this->debug) {
 369             print_r(array(
 370                 'rcpts' => $rcpts,
 371                 'email' => $email
 372             ));
 373         }
 374         $ret = $mail->send($rcpts,$email['headers'],$email['body']);
 375         error_reporting($oe);
 376         if ($ret === true) {
 377             $pg->addEvent("COREMAILER-SENT",  false,
 378                 'To: ' .  ( is_array($rcpts) ? implode(', ', $rcpts) : $rcpts ) .
 379                 'Subject: '  . @$email['headers']['Subject']
 380             );
 381         }  else {
 382             $pg->addEvent("COREMAILER-FAIL",  false,
 383                 "Sending to : " . ( is_array($rcpts) ? implode(', ', $rcpts) : $rcpts ) .
 384                 " Error: " . $ret->toString());
 385
 386         }
 387
 388         return $ret;
 389     }
 390
 391     function htmlbodytoCID($html)
 392     {
 393         $dom = new DOMDocument();
 394         // this may raise parse errors as some html may be a component..
 395         @$dom->loadHTML('<?xml encoding="UTF-8">' .$html);
 396         $imgs= $dom->getElementsByTagName('img');
 397
 398         $urls = array();
 399
 400         foreach ($imgs as $i=>$img) {
 401             $url  = $img->getAttribute('src');
 402             if (preg_match('#^cid:#', $url)) {
 403                 continue;
 404             }
 405             $me = $img->getAttribute('mailembed');
 406             if ($me == 'no') {
 407                 continue;
 408             }
 409
 410             if(!array_key_exists($url, $urls)){
 411                 $conv = $this->fetchImage($url);
 412                 $urls[$url] = $conv;
 413                 $this->images[$conv['contentid']] = $conv;
 414             } else {
 415                 $conv = $urls[$url];
 416             }
 417             $img->setAttribute('origsrc', $url);
 418             $img->setAttribute('src', 'cid:' . $conv['contentid']);
 419         }
 420
 421
 422         return $dom->saveHTML();
 423
 424     }
 425     function htmlbodyCssEmbed($html)
 426     {
 427         $ff = HTML_FlexyFramework::get();
 428         $dom = new DOMDocument();
 429
 430         // this may raise parse errors as some html may be a component..
 431         @$dom->loadHTML('<?xml encoding="UTF-8">' .$html);
 432         $links = $dom->getElementsByTagName('link');
 433         $lc = array();
 434         foreach ($links as $link) {  // duplicate as links is dynamic and we change it..!
 435             $lc[] = $link;
 436         }
 437         //<link rel="stylesheet" type="text/css" href="{rootURL}/roojs1/css-mailer/mailer.css">
 438
 439         foreach ($lc as $i=>$link) {
 440             //var_dump($link->getAttribute('href'));
 441
 442             if ($link->getAttribute('rel') != 'stylesheet') {
 443                 continue;
 444             }
 445             $url  = $link->getAttribute('href');
 446             $file = $ff->rootDir . $url;
 447
 448             if (!preg_match('#^(http|https)://#', $url)) {
 449                 $file = $ff->rootDir . $url;
 450
 451                 if (!file_exists($file)) {
 452 //                    echo $file;
 453                     $link->setAttribute('href', 'missing:' . $file);
 454                     continue;
 455                 }
 456             } else {
 457                $file = $this->mapurl($url);
 458             }
 459
 460             $par = $link->parentNode;
 461             $par->removeChild($link);
 462             $s = $dom->createElement('style');
 463             $e = $dom->createTextNode(file_get_contents($file));
 464             $s->appendChild($e);
 465             $par->appendChild($s);
 466
 467         }
 468         return $dom->saveHTML();
 469
 470
 471     }
 472
 473     function htmlbodyInlineCss($html)
 474     {
 475         $dom = new DOMDocument();
 476
 477         @$dom->loadHTML('<?xml encoding="UTF-8">' .$html);
 478
 479         $html = $dom->getElementsByTagName('html');
 480         $head = $dom->getElementsByTagName('head');
 481         $body = $dom->getElementsByTagName('body');
 482
 483         if(!$head->length){
 484             $head = $dom->createElement('head');
 485             $html->item(0)->insertBefore($head, $body->item(0));
 486             $head = $dom->getElementsByTagName('head');
 487         }
 488
 489         $s = $dom->createElement('style');
 490         $e = $dom->createTextNode($this->css_inline);
 491         $s->appendChild($e);
 492         $head->item(0)->appendChild($s);
 493
 494         return $dom->saveHTML();
 495
 496         /* Inline
 497         require_once 'HTML/CSS/InlineStyle.php';
 498
 499         $doc = new HTML_CSS_InlineStyle($html);
 500
 501         $doc->applyStylesheet($this->css_inline);
 502
 503         $html = $doc->getHTML();
 504
 505         return $html;
 506         */
 507     }
 508
 509     function htmlbodySetClass($html, $cls)
 510     {
 511         $dom = new DOMDocument();
 512
 513         @$dom->loadHTML('<?xml encoding="UTF-8">' .$html);
 514
 515         $body = $dom->getElementsByTagName('body');
 516         if (!empty($body->length)) {
 517             $body->item(0)->setAttribute('class', $cls);
 518         } else {
 519             $body = $dom->createElement("body");
 520             $body->setAttribute('class', $cls);
 521             $dom->appendChild($body);
 522         }
 523
 524
 525         return $dom->saveHTML();
 526     }
 527
 528     function fetchImage($url)
 529     {
 530
 531
 532         $this->log( "FETCH : $url\n");
 533
 534         if ($url[0] == '/') {
 535             $ff = HTML_FlexyFramework::get();
 536             $file = $ff->rootDir . $url;
 537             require_once 'File/MimeType.php';
 538             $m  = new File_MimeType();
 539             $mt = $m->fromFilename($file);
 540             $ext = $m->toExt($mt);
 541
 542             return array(
 543                     'mimetype' => $mt,
 544                    'ext' => $ext,
 545                    'contentid' => md5($file),  // mailer makes md5 cid's' -- cid with attachment-** are done by mailer.
 546                    'file' => $file
 547             );
 548
 549
 550
 551         }
 552
 553         //print_R($url); exit;
 554
 555
 556         if (preg_match('#^file:///#', $url)) {
 557             $file = preg_replace('#^file://#', '', $url);
 558             require_once 'File/MimeType.php';
 559             $m  = new File_MimeType();
 560             $mt = $m->fromFilename($file);
 561             $ext = $m->toExt($mt);
 562
 563             return array(
 564                 'mimetype'  => $mt,
 565                 'ext'       =>   $ext,
 566                 'contentid' => md5($file),
 567                 'file'      => $file
 568             );
 569
 570         }
 571
 572         // CACHE???
 573         // 2 files --- the info file.. and the actual file...
 574         // add user
 575         // unix only...
 576         $uinfo = posix_getpwuid( posix_getuid () );
 577         $user = $uinfo['name'];
 578
 579         $cache = ini_get('session.save_path')."/Pman_Core_Mailer-{$user}/" . md5($url);
 580         if ($this->cache_images &&
 581                 file_exists($cache) &&
 582                 filemtime($cache) > strtotime('NOW - 1 WEEK')
 583             ) {
 584             $ret =  json_decode(file_get_contents($cache), true);
 585             $this->log("fetched from cache");
 586             $ret['file'] = $cache . '.data';
 587             return $ret;
 588         }
 589         if (!file_exists(dirname($cache))) {
 590             mkdir(dirname($cache),0700, true);
 591         }
 592
 593         require_once 'HTTP/Request.php';
 594
 595         $real_url = str_replace(' ', '%20', $this->mapurl($url));
 596         $a = new HTTP_Request($real_url);
 597         $a->sendRequest();
 598         $data = $a->getResponseBody();
 599
 600         $this->log("got file of size " . strlen($data));
 601         $this->log("save contentid " . md5($url));
 602
 603         file_put_contents($cache .'.data', $data);
 604
 605
 606         $mt = $a->getResponseHeader('Content-Type');
 607
 608         require_once 'File/MimeType.php';
 609         $m  = new File_MimeType();
 610         $ext = $m->toExt($mt);
 611
 612         $ret = array(
 613             'mimetype' => $mt,
 614             'ext' => $ext,
 615             'contentid' => md5($url)
 616
 617         );
 618
 619         file_put_contents($cache, json_encode($ret));
 620         $ret['file'] = $cache . '.data';
 621         return $ret;
 622     }
 623
 624     function mapurl($in)
 625     {
 626          foreach($this->urlmap as $o=>$n) {
 627             if (strpos($in,$o) === 0) {
 628                 $ret =$n . substr($in,strlen($o));
 629                 $this->log("mapURL in $in = $ret");
 630                 return $ret;
 631             }
 632         }
 633         $this->log("mapurl no change - $in");
 634         return $in;
 635
 636
 637     }
 638
 639
 640
 641     function log($val)
 642     {
 643         if (!$this->debug) {
 644             return;
 645         }
 646         if ($this->debug < 2) {
 647             echo '<PRE>' . print_r($val,true). "\n";
 648             return;
 649         }
 650         $fh = fopen('/tmp/core_mailer.log', 'a');
 651         fwrite($fh, date('Y-m-d H:i:s -') . json_encode($val) . "\n");
 652         fclose($fh);
 653
 654
 655     }
 656
 657 }