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