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; // not supported
  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     function __construct($args) {
  90         foreach($args as $k=>$v) {
  91             // a bit trusting..
  92             $this->$k =  $v;
  93         }
  94         // allow core mailer debug setting.
  95         $ff = HTML_FlexyFramework::get();
  96
  97         if (!empty($ff->Core_Mailer['debug'])) {
  98             $this->debug = $ff->Core_Mailer['debug'];
  99         }
 100         //$this->log("URL MAP");
 101         //$this->log($this->urlmap);
 102
 103     }
 104
 105     /**
 106      * ---------------- Global Tools ---------------
 107      */
 108
 109     function toData()
 110     {
 111         $templateFile = $this->template;
 112         $args = (array)$this->contents;
 113         $content  = clone($this->page);
 114
 115         foreach($args as $k=>$v) {
 116             $content->$k = $v;
 117         }
 118
 119         $content->msgid = empty($content->msgid ) ? md5(time() . rand()) : $content->msgid ;
 120
 121         $ff = HTML_FlexyFramework::get();
 122         $http_host = isset($_SERVER["HTTP_HOST"]) ? $_SERVER["HTTP_HOST"] : 'pman.HTTP_HOST.not.set';
 123         if (isset($ff->Pman['HTTP_HOST'])) {
 124             $http_host  = $ff->Pman['HTTP_HOST'];
 125         }
 126
 127
 128         $content->HTTP_HOST = $http_host;
 129
 130
 131
 132
 133         // this should be done by having multiple template sources...!!!
 134
 135         require_once 'HTML/Template/Flexy.php';
 136
 137         $tmp_opts = array(
 138            // 'forceCompile' => true,
 139             'site_prefix' => false,
 140             'multiSource' => true,
 141         );
 142         if (!empty($this->templateDir)) {
 143             $tmp_opts['templateDir'] = $this->templateDir;
 144         }
 145         $fopts = HTML_FlexyFramework::get()->HTML_Template_Flexy;
 146         if (!empty($fopts['DB_DataObject_translator'])) {
 147             $tmp_opts['DB_DataObject_translator'] = $fopts['DB_DataObject_translator'];
 148         }
 149         if (!empty($fopts['locale'])) {
 150             $tmp_opts['locale'] = $fopts['locale'];
 151         }
 152
 153         // local opt's overwrite
 154         if (!empty($this->locale)) {
 155             $tmp_opts['locale'] = $this->locale;
 156         }
 157
 158         $htmlbody = false;
 159         $html_tmp_opts = $tmp_opts;
 160         $htmltemplate = new HTML_Template_Flexy( $html_tmp_opts );
 161         if (is_string($htmltemplate->resolvePath('mail/'.$templateFile.'.body.html')) ) {
 162             // then we have a multi-part email...
 163             if (!empty($this->html_locale)) {
 164                 $html_tmp_opts['locale'] = $this->html_locale;
 165             }
 166             $htmltemplate = new HTML_Template_Flexy( $html_tmp_opts );
 167
 168             $htmltemplate->compile('mail/'. $templateFile.'.body.html');
 169             $htmlbody =  $htmltemplate->bufferedOutputObject($content);
 170
 171             $this->htmlbody = $htmlbody;
 172
 173             // for the html body, we may want to convert the attachments to images.
 174 //            var_dump($htmlbody);exit;
 175             if ($this->replaceImages) {
 176                 $htmlbody = $this->htmlbodytoCID($htmlbody);
 177             }
 178             if ($this->css_embed) {
 179                 $htmlbody = $this->htmlbodyCssEmbed($htmlbody);
 180
 181             }
 182         }
 183         $tmp_opts['nonHTML'] = true;
 184
 185
 186         //print_R($tmp_opts);
 187         // $tmp_opts['force'] = true;
 188
 189         $template = new HTML_Template_Flexy(  $tmp_opts );
 190         $template->compile('mail/'. $templateFile.'.txt');
 191
 192         /* use variables from this object to ouput data. */
 193         $mailtext = $template->bufferedOutputObject($content);
 194         //print_r($mailtext);exit;
 195
 196
 197
 198         //echo "<PRE>";print_R($mailtext);
 199
 200         /* With the output try and send an email, using a few tricks in Mail_MimeDecode. */
 201         require_once 'Mail/mimeDecode.php';
 202         require_once 'Mail.php';
 203
 204         $decoder = new Mail_mimeDecode($mailtext);
 205         $parts = $decoder->getSendArray();
 206         if (PEAR::isError($parts)) {
 207             return $parts;
 208             //echo "PROBLEM: {$parts->message}";
 209             //exit;
 210         }
 211
 212         $isMime = false;
 213
 214         require_once 'Mail/mime.php';
 215         $mime = new Mail_mime(array(
 216             'eol' => "\n",
 217             //'html_encoding' => 'base64',
 218             'html_charset' => 'utf-8',
 219             'text_charset' => 'utf-8',
 220             'head_charset' => 'utf-8',
 221         ));
 222         // clean up the headers...
 223
 224
 225         $parts[1]['Message-Id'] = '<' .   $content->msgid   .
 226                                      '@' . $content->HTTP_HOST .'>';
 227
 228
 229         if ($htmlbody !== false) {
 230             // got a html headers...
 231
 232             if (isset($parts[1]['Content-Type'])) {
 233                 unset($parts[1]['Content-Type']);
 234             }
 235             $mime->setTXTBody($parts[2]);
 236             $mime->setHTMLBody($htmlbody);
 237 //            var_dump($mime);exit;
 238             foreach($this->images as $cid=>$cdata) {
 239
 240                 $mime->addHTMLImage(
 241                     $cdata['file'],
 242                      $cdata['mimetype'],
 243                      $cid.'.'.$cdata['ext'],
 244                     true,
 245                     $cdata['contentid']
 246                 );
 247             }
 248             $isMime = true;
 249         }
 250
 251         if(!empty($this->attachments)){
 252             //if got a attachments
 253             $header = $mime->headers($parts[1]);
 254
 255             if (isset($parts[1]['Content-Type'])) {
 256                 unset($parts[1]['Content-Type']);
 257             }
 258
 259             if (!$isMime) {
 260
 261                 if(preg_match('/text\/html/', $header['Content-Type'])){
 262                     $mime->setHTMLBody($parts[2]);
 263                     $mime->setTXTBody('This message is in HTML only');
 264                 }else{
 265                     $mime->setTXTBody($parts[2]);
 266                     $mime->setHTMLBody('<PRE>'.htmlspecialchars($parts[2]).'</PRE>');
 267                 }
 268             }
 269             foreach($this->attachments as $attch){
 270                 $mime->addAttachment(
 271                         $attch['file'],
 272                         $attch['mimetype'],
 273                         (!empty($attch['name'])) ? $attch['name'] : '',
 274                         true
 275                 );
 276             }
 277
 278             $isMime = true;
 279         }
 280
 281         if($isMime){
 282             $parts[2] = $mime->get();
 283             $parts[1] = $mime->headers($parts[1]);
 284         }
 285
 286
 287         $ret = array(
 288             'recipents' => $parts[0],
 289             'headers' => $parts[1],
 290             'body' => $parts[2],
 291             'mailer' => $this
 292         );
 293         if ($this->rcpts !== false) {
 294             $ret['recipents'] =  $this->rcpts;
 295         }
 296         // if 'to' is empty, then add the recipents in there... (must be an array?
 297         if (!empty($ret['recipents']) && is_array($ret['recipents']) &&
 298                 (empty($ret['headers']['To']) || !strlen(trim($ret['headers']['To'])))) {
 299             $ret['headers']['To'] = implode(',', $ret['recipents']);
 300         }
 301
 302
 303         // add bcc if necessary..
 304         if (!empty($this->bcc)) {
 305            $ret['bcc'] = $this->bcc;
 306         }
 307         return $ret;
 308     }
 309     function send($email = false)
 310     {
 311
 312         $ff = HTML_FlexyFramework::get();
 313
 314         $pg = $ff->page;
 315
 316         $email = is_array($email)  ? $email : $this->toData();
 317
 318         if (is_a($email, 'PEAR_Error')) {
 319             $pg->addEvent("COREMAILER-FAIL",  false, "email toData failed");
 320
 321
 322             return $email;
 323         }
 324
 325         //$this->log( htmlspecialchars(print_r($email,true)));
 326
 327         ///$recipents = array($this->email);
 328 //        $mailOptions = PEAR::getStaticProperty('Mail','options');
 329
 330         $mailOptions = isset($ff->Mail) ? $ff->Mail : array();
 331         //print_R($mailOptions);exit;
 332
 333         if ($this->mail_method == 'SMTPMX' && empty($mailOptions['mailname'])) {
 334             $pg->jerr("Mail[mailname] is not set - this is required for SMTPMX");
 335
 336         }
 337
 338         $mail = Mail::factory($this->mail_method,$mailOptions);
 339         if ($this->debug) {
 340             $mail->debug = (bool) $this->debug;
 341         }
 342
 343         $email['headers']['Date'] = date('r');
 344         if (PEAR::isError($mail)) {
 345             $pg->addEvent("COREMAILER-FAIL",  false, "mail factory failed");
 346
 347
 348             return $mail;
 349         }
 350         $rcpts = $this->rcpts == false ? $email['recipents'] : $this->rcpts;
 351
 352
 353
 354         // this makes contents untrustable...
 355         if (!empty($this->contents['bcc']) && is_array($this->contents['bcc'])) {
 356             $rcpts =array_merge(is_array($rcpts) ? $rcpts : array($rcpts), $this->contents['bcc']);
 357         }
 358
 359         $oe = error_reporting(E_ALL & ~E_NOTICE & ~E_STRICT);
 360         $ret = $mail->send($rcpts,$email['headers'],$email['body']);
 361         error_reporting($oe);
 362         if ($ret === true) {
 363             $pg->addEvent("COREMAILER-SENT",  false,
 364                 'To: ' .  ( is_array($rcpts) ? implode(', ', $rcpts) : $rcpts ) .
 365                 'Subject: '  . @$email['headers']['Subject']
 366             );
 367         }  else {
 368             $pg->addEvent("COREMAILER-FAIL",  false, $ret->toString());
 369         }
 370
 371         return $ret;
 372     }
 373
 374     function htmlbodytoCID($html)
 375     {
 376         $dom = new DOMDocument();
 377         // this may raise parse errors as some html may be a component..
 378         @$dom->loadHTML('<?xml encoding="UTF-8">' .$html);
 379         $imgs= $dom->getElementsByTagName('img');
 380
 381         foreach ($imgs as $i=>$img) {
 382             $url  = $img->getAttribute('src');
 383             if (preg_match('#^cid:#', $url)) {
 384                 continue;
 385             }
 386             $me = $img->getAttribute('mailembed');
 387             if ($me == 'no') {
 388                 continue;
 389             }
 390
 391             $conv = $this->fetchImage($url);
 392             $this->images[$conv['contentid']] = $conv;
 393
 394             $img->setAttribute('src', 'cid:' . $conv['contentid']);
 395
 396
 397         }
 398         return $dom->saveHTML();
 399
 400
 401
 402     }
 403     function htmlbodyCssEmbed($html)
 404     {
 405         $ff = HTML_FlexyFramework::get();
 406         $dom = new DOMDocument();
 407
 408         // this may raise parse errors as some html may be a component..
 409         @$dom->loadHTML('<?xml encoding="UTF-8">' .$html);
 410         $links = $dom->getElementsByTagName('link');
 411         $lc = array();
 412         foreach ($links as $link) {  // duplicate as links is dynamic and we change it..!
 413             $lc[] = $link;
 414         }
 415         //<link rel="stylesheet" type="text/css" href="{rootURL}/roojs1/css-mailer/mailer.css">
 416
 417         foreach ($lc as $i=>$link) {
 418             //var_dump($link->getAttribute('href'));
 419
 420             if ($link->getAttribute('rel') != 'stylesheet') {
 421                 continue;
 422             }
 423             $url  = $link->getAttribute('href');
 424             $file = $ff->rootDir . $url;
 425
 426             if (!preg_match('#^(http|https)://#', $url)) {
 427                 $file = $ff->rootDir . $url;
 428
 429                 if (!file_exists($file)) {
 430 //                    echo $file;
 431                     $link->setAttribute('href', 'missing:' . $file);
 432                     continue;
 433                 }
 434             } else {
 435                $file = $this->mapurl($url);
 436             }
 437
 438             $par = $link->parentNode;
 439             $par->removeChild($link);
 440             $s = $dom->createElement('style');
 441             $e = $dom->createTextNode(file_get_contents($file));
 442             $s->appendChild($e);
 443             $par->appendChild($s);
 444
 445         }
 446         return $dom->saveHTML();
 447
 448
 449     }
 450
 451
 452
 453     function fetchImage($url)
 454     {
 455
 456
 457         $this->log( "FETCH : $url\n");
 458
 459         if ($url[0] == '/') {
 460             $ff = HTML_FlexyFramework::get();
 461             $file = $ff->rootDir . $url;
 462             require_once 'File/MimeType.php';
 463             $m  = new File_MimeType();
 464             $mt = $m->fromFilename($file);
 465             $ext = $m->toExt($mt);
 466
 467             return array(
 468                     'mimetype' => $mt,
 469                    'ext' => $ext,
 470                    'contentid' => md5($file),  // mailer makes md5 cid's' -- cid with attachment-** are done by mailer.
 471                    'file' => $file
 472             );
 473
 474
 475
 476         }
 477
 478         //print_R($url); exit;
 479
 480
 481         if (preg_match('#^file:///#', $url)) {
 482             $file = preg_replace('#^file://#', '', $url);
 483             require_once 'File/MimeType.php';
 484             $m  = new File_MimeType();
 485             $mt = $m->fromFilename($file);
 486             $ext = $m->toExt($mt);
 487
 488             return array(
 489                 'mimetype'  => $mt,
 490                 'ext'       =>   $ext,
 491                 'contentid' => md5($file),
 492                 'file'      => $file
 493             );
 494
 495         }
 496
 497         // CACHE???
 498         // 2 files --- the info file.. and the actual file...
 499         // add user
 500         // unix only...
 501         $uinfo = posix_getpwuid( posix_getuid () );
 502         $user = $uinfo['name'];
 503
 504         $cache = ini_get('session.save_path')."/Pman_Core_Mailer-{$user}/" . md5($url);
 505         if ($this->cache_images &&
 506                 file_exists($cache) &&
 507                 filemtime($cache) > strtotime('NOW - 1 WEEK')
 508             ) {
 509             $ret =  json_decode(file_get_contents($cache), true);
 510             $this->log("fetched from cache");
 511             $ret['file'] = $cache . '.data';
 512             return $ret;
 513         }
 514         if (!file_exists(dirname($cache))) {
 515             mkdir(dirname($cache),0700, true);
 516         }
 517
 518         require_once 'HTTP/Request.php';
 519
 520         $real_url = str_replace(' ', '%20', $this->mapurl($url));
 521         $a = new HTTP_Request($real_url);
 522         $a->sendRequest();
 523         $data = $a->getResponseBody();
 524
 525         $this->log("got file of size " . strlen($data));
 526         $this->log("save contentid " . md5($url));
 527
 528         file_put_contents($cache .'.data', $data);
 529
 530
 531         $mt = $a->getResponseHeader('Content-Type');
 532
 533         require_once 'File/MimeType.php';
 534         $m  = new File_MimeType();
 535         $ext = $m->toExt($mt);
 536
 537         $ret = array(
 538             'mimetype' => $mt,
 539             'ext' => $ext,
 540             'contentid' => md5($url)
 541
 542         );
 543
 544         file_put_contents($cache, json_encode($ret));
 545         $ret['file'] = $cache . '.data';
 546         return $ret;
 547     }
 548
 549     function mapurl($in)
 550     {
 551
 552         foreach($this->urlmap as $o=>$n) {
 553             if (strpos($in,$o) === 0) {
 554                 $ret =$n . substr($in,strlen($o));
 555                 $this->log("mapURL in $in = $ret");
 556                 return $ret;
 557             }
 558         }
 559         $this->log("mapurl no change - $in");
 560         return $in;
 561
 562
 563     }
 564
 565
 566
 567     function log($val)
 568     {
 569         if (!$this->debug) {
 570             return;
 571         }
 572         if ($this->debug < 2) {
 573             echo '<PRE>' . print_r($val,true). "\n";
 574             return;
 575         }
 576         $fh = fopen('/tmp/core_mailer.log', 'a');
 577         fwrite($fh, date('Y-m-d H:i:s -') . json_encode($val) . "\n");
 578         fclose($fh);
 579
 580
 581     }
 582
 583 }