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         $ret = $mail->send($rcpts,$email['headers'],$email['body']);
 369         error_reporting($oe);
 370         if ($ret === true) {
 371             $pg->addEvent("COREMAILER-SENT",  false,
 372                 'To: ' .  ( is_array($rcpts) ? implode(', ', $rcpts) : $rcpts ) .
 373                 'Subject: '  . @$email['headers']['Subject']
 374             );
 375         }  else {
 376             $pg->addEvent("COREMAILER-FAIL",  false,
 377                 "Sending to : " . ( is_array($rcpts) ? implode(', ', $rcpts) : $rcpts ) .
 378                 " Error: " . $ret->toString());
 379
 380         }
 381
 382         return $ret;
 383     }
 384
 385     function htmlbodytoCID($html)
 386     {
 387         $dom = new DOMDocument();
 388         // this may raise parse errors as some html may be a component..
 389         @$dom->loadHTML('<?xml encoding="UTF-8">' .$html);
 390         $imgs= $dom->getElementsByTagName('img');
 391
 392         $urls = array();
 393
 394         foreach ($imgs as $i=>$img) {
 395             $url  = $img->getAttribute('src');
 396             if (preg_match('#^cid:#', $url)) {
 397                 continue;
 398             }
 399             $me = $img->getAttribute('mailembed');
 400             if ($me == 'no') {
 401                 continue;
 402             }
 403
 404             if(!array_key_exists($url, $urls)){
 405                 $conv = $this->fetchImage($url);
 406                 $urls[$url] = $conv;
 407                 $this->images[$conv['contentid']] = $conv;
 408             } else {
 409                 $conv = $urls[$url];
 410             }
 411             $img->setAttribute('origsrc', $url);
 412             $img->setAttribute('src', 'cid:' . $conv['contentid']);
 413         }
 414
 415
 416         return $dom->saveHTML();
 417
 418     }
 419     function htmlbodyCssEmbed($html)
 420     {
 421         $ff = HTML_FlexyFramework::get();
 422         $dom = new DOMDocument();
 423
 424         // this may raise parse errors as some html may be a component..
 425         @$dom->loadHTML('<?xml encoding="UTF-8">' .$html);
 426         $links = $dom->getElementsByTagName('link');
 427         $lc = array();
 428         foreach ($links as $link) {  // duplicate as links is dynamic and we change it..!
 429             $lc[] = $link;
 430         }
 431         //<link rel="stylesheet" type="text/css" href="{rootURL}/roojs1/css-mailer/mailer.css">
 432
 433         foreach ($lc as $i=>$link) {
 434             //var_dump($link->getAttribute('href'));
 435
 436             if ($link->getAttribute('rel') != 'stylesheet') {
 437                 continue;
 438             }
 439             $url  = $link->getAttribute('href');
 440             $file = $ff->rootDir . $url;
 441
 442             if (!preg_match('#^(http|https)://#', $url)) {
 443                 $file = $ff->rootDir . $url;
 444
 445                 if (!file_exists($file)) {
 446 //                    echo $file;
 447                     $link->setAttribute('href', 'missing:' . $file);
 448                     continue;
 449                 }
 450             } else {
 451                $file = $this->mapurl($url);
 452             }
 453
 454             $par = $link->parentNode;
 455             $par->removeChild($link);
 456             $s = $dom->createElement('style');
 457             $e = $dom->createTextNode(file_get_contents($file));
 458             $s->appendChild($e);
 459             $par->appendChild($s);
 460
 461         }
 462         return $dom->saveHTML();
 463
 464
 465     }
 466
 467     function htmlbodyInlineCss($html)
 468     {
 469         $dom = new DOMDocument();
 470
 471         @$dom->loadHTML('<?xml encoding="UTF-8">' .$html);
 472
 473         $html = $dom->getElementsByTagName('html');
 474         $head = $dom->getElementsByTagName('head');
 475         $body = $dom->getElementsByTagName('body');
 476
 477         if(!$head->length){
 478             $head = $dom->createElement('head');
 479             $html->item(0)->insertBefore($head, $body->item(0));
 480             $head = $dom->getElementsByTagName('head');
 481         }
 482
 483         $s = $dom->createElement('style');
 484         $e = $dom->createTextNode($this->css_inline);
 485         $s->appendChild($e);
 486         $head->item(0)->appendChild($s);
 487
 488         return $dom->saveHTML();
 489
 490         /* Inline
 491         require_once 'HTML/CSS/InlineStyle.php';
 492
 493         $doc = new HTML_CSS_InlineStyle($html);
 494
 495         $doc->applyStylesheet($this->css_inline);
 496
 497         $html = $doc->getHTML();
 498
 499         return $html;
 500         */
 501     }
 502
 503     function htmlbodySetClass($html, $cls)
 504     {
 505         $dom = new DOMDocument();
 506
 507         @$dom->loadHTML('<?xml encoding="UTF-8">' .$html);
 508
 509         $body = $dom->getElementsByTagName('body');
 510         if (!empty($body->length)) {
 511             $body->item(0)->setAttribute('class', $cls);
 512         } else {
 513             $body = $dom->createElement("body");
 514             $body->setAttribute('class', $cls);
 515             $dom->appendChild($body);
 516         }
 517
 518
 519         return $dom->saveHTML();
 520     }
 521
 522     function fetchImage($url)
 523     {
 524
 525
 526         $this->log( "FETCH : $url\n");
 527
 528         if ($url[0] == '/') {
 529             $ff = HTML_FlexyFramework::get();
 530             $file = $ff->rootDir . $url;
 531             require_once 'File/MimeType.php';
 532             $m  = new File_MimeType();
 533             $mt = $m->fromFilename($file);
 534             $ext = $m->toExt($mt);
 535
 536             return array(
 537                     'mimetype' => $mt,
 538                    'ext' => $ext,
 539                    'contentid' => md5($file),  // mailer makes md5 cid's' -- cid with attachment-** are done by mailer.
 540                    'file' => $file
 541             );
 542
 543
 544
 545         }
 546
 547         //print_R($url); exit;
 548
 549
 550         if (preg_match('#^file:///#', $url)) {
 551             $file = preg_replace('#^file://#', '', $url);
 552             require_once 'File/MimeType.php';
 553             $m  = new File_MimeType();
 554             $mt = $m->fromFilename($file);
 555             $ext = $m->toExt($mt);
 556
 557             return array(
 558                 'mimetype'  => $mt,
 559                 'ext'       =>   $ext,
 560                 'contentid' => md5($file),
 561                 'file'      => $file
 562             );
 563
 564         }
 565
 566         // CACHE???
 567         // 2 files --- the info file.. and the actual file...
 568         // add user
 569         // unix only...
 570         $uinfo = posix_getpwuid( posix_getuid () );
 571         $user = $uinfo['name'];
 572
 573         $cache = ini_get('session.save_path')."/Pman_Core_Mailer-{$user}/" . md5($url);
 574         if ($this->cache_images &&
 575                 file_exists($cache) &&
 576                 filemtime($cache) > strtotime('NOW - 1 WEEK')
 577             ) {
 578             $ret =  json_decode(file_get_contents($cache), true);
 579             $this->log("fetched from cache");
 580             $ret['file'] = $cache . '.data';
 581             return $ret;
 582         }
 583         if (!file_exists(dirname($cache))) {
 584             mkdir(dirname($cache),0700, true);
 585         }
 586
 587         require_once 'HTTP/Request.php';
 588
 589         $real_url = str_replace(' ', '%20', $this->mapurl($url));
 590         $a = new HTTP_Request($real_url);
 591         $a->sendRequest();
 592         $data = $a->getResponseBody();
 593
 594         $this->log("got file of size " . strlen($data));
 595         $this->log("save contentid " . md5($url));
 596
 597         file_put_contents($cache .'.data', $data);
 598
 599
 600         $mt = $a->getResponseHeader('Content-Type');
 601
 602         require_once 'File/MimeType.php';
 603         $m  = new File_MimeType();
 604         $ext = $m->toExt($mt);
 605
 606         $ret = array(
 607             'mimetype' => $mt,
 608             'ext' => $ext,
 609             'contentid' => md5($url)
 610
 611         );
 612
 613         file_put_contents($cache, json_encode($ret));
 614         $ret['file'] = $cache . '.data';
 615         return $ret;
 616     }
 617
 618     function mapurl($in)
 619     {
 620
 621         foreach($this->urlmap as $o=>$n) {
 622             if (strpos($in,$o) === 0) {
 623                 $ret =$n . substr($in,strlen($o));
 624                 $this->log("mapURL in $in = $ret");
 625                 return $ret;
 626             }
 627         }
 628         $this->log("mapurl no change - $in");
 629         return $in;
 630
 631
 632     }
 633
 634
 635
 636     function log($val)
 637     {
 638         if (!$this->debug) {
 639             return;
 640         }
 641         if ($this->debug < 2) {
 642             echo '<PRE>' . print_r($val,true). "\n";
 643             return;
 644         }
 645         $fh = fopen('/tmp/core_mailer.log', 'a');
 646         fwrite($fh, date('Y-m-d H:i:s -') . json_encode($val) . "\n");
 647         fclose($fh);
 648
 649
 650     }
 651
 652 }