DataObjects/Core_email.php
[Pman.Core] / DataObjects / Core_email.php
1 <?php
2 /**
3  * Table Definition for core_email
4  */
5 class_exists('DB_DataObject') ? '' : require_once 'DB/DataObject.php';
6
7 class Pman_Core_DataObjects_Core_email extends DB_DataObject 
8 {
9     ###START_AUTOCODE
10     /* the code below is auto generated do not remove the above tag */
11   
12     public $__table = 'core_email';    // table name
13     public $id;                              // int(11)  not_null primary_key auto_increment
14     public $name;                            // 
15     public $subject;                         // blob(65535)  blob
16     public $bodytext;                        // blob(65535)  blob
17     public $plaintext;
18     public $updated_dt;                      //datetime not_null
19     public $from_email;
20     public $from_name;
21     public $owner_id;
22     public $is_system;
23     public $active;
24     public $bcc_group_id;
25     public $test_class;
26     
27  
28
29     /* the code above is auto generated do not remove the tag below */
30     ###END_AUTOCODE
31     
32     function applyFilters($q, $au, $roo)
33     {
34         $tn = $this->tableName();
35         
36         if(!empty($q['search']['nameortitle'])){
37             $this->whereAdd("
38                 $tn.name LIKE '%{$this->escape($q['search']['nameortitle'])}%'
39                 OR
40                 $tn.subject LIKE '%{$this->escape($q['search']['nameortitle'])}%'
41             ");
42         }
43         $cgm = DB_DataObject::Factory('core_group_member')->tableName();;
44       
45         $this->selectAdd("
46             (
47                 SELECT 
48                     count(id) 
49                 FROM 
50                     {$cgm}
51                 WHERE 
52                     to_group_id = {$cgm}.group_id
53             )  AS group_member_count,
54             
55             (
56                 SELECT 
57                     count(id) 
58                 FROM 
59                     {$cgm}
60                 WHERE 
61                     bcc_group_id = {$cgm}.group_id
62             )  AS bcc_group_member_count
63         ");
64     }
65     
66     function beforeDelete($dependants_array, $roo)
67     {   
68         $i = DB_DataObject::factory('Images');
69         $i->onid = $this->id;
70         $i->ontable = $this->tableName();
71         $i->find();
72         while ($i->fetch()){
73             $i->beforeDelete();
74             $i->delete();
75         }
76     }
77     
78     function beforeUpdate($old, $request,$roo)
79     {   
80         if (!empty($request['_make_copy'])) {
81             $this->makeCopy($roo);
82             
83         }
84         
85         if ($this->to_group_id != -1) {
86                    
87             $c = DB_DataObject::factory('core_group_member');            
88             $c->group_id = $this->to_group_id;
89                         
90             if (!$c->count()) {
91                 //cannot go to second check
92                  if (!empty($request['_ignore_group_count'])) {
93                     if (!$request['_ignore_group_count']) {
94                         $roo->jerr('no_member',array('errcode'=> 100));
95                     }
96                 } else {
97                     $roo->jerr('no_member',array('errcode'=> 100));
98                 }
99             }
100             
101         }
102     }
103     
104     function makeCopy($roo)
105     {
106         $c = DB_DataObject::Factory($this->tableName());
107         $c->setFrom($this);
108         $c->name = "COPY of " . $this->name;
109         $c->updated_dt = $this->sqlValue('NOW()');
110         
111         $id = $c->insert();
112         $c = DB_DataObject::Factory($this->tableName());
113         $c->get($id);
114         
115         
116         // copy images.
117         
118         $i = DB_DataObject::factory('Images');
119         $i->onid = $this->id;
120         $i->ontable = $this->tableName();
121         $i->find();
122         while ($i->fetch()){
123             
124             $new_image = DB_DataObject::factory('Images');
125             $new_image->onid = $c->id;
126             $new_image->ontable = $this->tableName();
127             $new_image->createFrom($i->getStoreName(), $i->filename);
128             
129             $map[$i->id] = $new_image->id;
130         }
131         
132         
133         libxml_use_internal_errors (true);
134         $doc = new DOMDocument('1.0', 'UTF-8');
135         $doc->loadHTML('<?xml encoding="UTF-8"><HTML><BODY>'.$this->bodytext.'</BODY></HTML>');
136         $doc->formatOutput = true;
137
138        //echo '<PRE>'; print_R($doc);
139         
140         
141         $xpath = new DOMXpath($doc);
142         foreach ($xpath->query('//img[@src]') as $img) {
143             $href = $img->getAttribute('src');
144             //var_dump($href);
145             $matches = array();
146             if (preg_match("/Images\/([0-9]+)\/([^#]+)\#image\-([0-9]+)$/", $href, $matches)) {
147                  
148                 $oid = $matches[1];
149                 
150                 if (!isset($map[$oid])) {
151                     //echo "skip no new id for $oid";
152                     continue;
153                 }
154                 $nid = $map[$oid];
155                 $nstr = "/Images/$nid/{$matches[2]}/#image-{$nid}";
156                 
157                 $img->setAttribute('src',  str_replace($matches[0], $nstr, $href ));
158                     
159                  
160             }
161         }
162         $cc = clone($c);
163         $c->bodytext = $doc->saveHTML();
164         $c->update($cc);
165         libxml_use_internal_errors (false);
166         
167         
168         $roo->jok("duplicated");
169     }
170     
171     function onInsert($q,$roo)
172     {   
173         $i = DB_DataObject::factory('Images');
174         $i->onid = 0;
175         $i->ontable = $this->tableName();
176         $i->find();
177         while ($i->fetch()){
178             $ii = clone ($i);
179             $i->onid = $this->id;
180             $i->update($ii);
181         }
182         
183         $this->cachedMailWithOutImages(true, (get_class($this) == 'Pman_Core_DataObjects_Core_email') ? false : true);
184 //        $this->cachedMailWithOutImages(true, false);
185        
186     }
187     
188     function onUpdate($old, $q,$roo)
189     {
190         $this->cachedMailWithOutImages(true, (get_class($this) == 'Pman_Core_DataObjects_Core_email') ? false : true);
191     }
192
193
194     function attachmentIds()
195     {
196         libxml_use_internal_errors (true);
197         $doc = new DOMDocument('1.0', 'UTF-8');
198         $doc->loadHTML('<?xml encoding="UTF-8">'.$this->bodytext);
199         
200         $xpath = new DOMXpath($doc);
201         $ret = array();
202         
203         foreach ($xpath->query('//img[@src]') as $img) { // process images!
204             $href = $img->getAttribute('src');
205             $cid = explode('#', $href);
206             if(!isset($cid[1])){
207                 continue;
208             }
209             $cid = explode('-', $cid[1]);
210             if (!isset($cid[1])||!is_numeric($cid[1])) {
211                 continue;
212             }
213             $ret[] = $cid[1];
214         }
215         
216         return $ret;
217     }
218     /**
219      * process replacements is run to generate a template - not the final content..
220      *
221      */
222     
223     function processRelacements($replace_links = true)
224     {   
225         $cfg = isset(HTML_FlexyFramework::get()->Pman_Crm) ? HTML_FlexyFramework::get()->Pman_Crm : false;
226         
227         libxml_use_internal_errors (true);
228         $doc = new DOMDocument('1.0', 'UTF-8');
229         $doc->loadHTML('<?xml encoding="UTF-8">'.$this->bodytext);
230         
231         $xpath = new DOMXpath($doc);
232         
233         foreach ($xpath->query('//img[@src]') as $img) { // process images!
234             $href = $img->getAttribute('src');
235             $hash = explode('#', $href);
236             // we name all our cid's as attachment-*
237             // however the src url may be #image-*
238             
239             
240             if(!isset($hash[1])){
241                 continue;
242             }
243             $cid = explode('-', $hash[1]);
244             if(!empty($cid[1])){
245                 $img->setAttribute('src', 'cid:attachment-' . $cid[1]);
246             }
247         }
248         
249         $unsubscribe = $this->unsubscribe_url();
250         
251         foreach ($xpath->query('//a[@href]') as $a) { 
252             
253             $href = $a->getAttribute('href');
254             
255             if(preg_match('/#unsubscribe/', $href) && !empty($unsubscribe)){
256                 $a->setAttribute('href', $unsubscribe);
257                 continue;
258             }
259             
260             if(!preg_match('/^http(.*)/', $href)){
261                 continue;
262             }
263             if (!$replace_links) {
264                 continue;
265             }
266             if (empty($cfg)) {
267                 continue;
268             }
269             // not available if server_baseurl not set... and crm module not used.
270             $link = DB_DataObject::factory('crm_mailing_list_link');
271             $link->setFrom(array(
272                 'url' => $href
273             ));
274             
275             if(!$link->find(true)){
276                 $link->insert();
277             }
278             
279             if(!$link->id){
280                 continue;
281             }
282             
283             $l = $cfg ['server_baseurl'] . '/Crm/Link/' .$this->id . '/' . $link->id . '/{person.id}.html';
284             
285             $a->setAttribute('href', $l);
286             
287         }
288         
289         if(!empty($unsubscribe) && !empty($cfg)){
290             $element = $doc->createElement('img');
291             $element->setAttribute('mailembed', 'no');
292             $element->setAttribute('src', $cfg ['server_baseurl']  . '/Crm/Open/' . $this->id . '/{person.id}.html');
293             $element->setAttribute('width', '1');
294             $element->setAttribute('height', '1');
295
296             $html = $doc->getElementsByTagName('html');
297             if ($html->length) {
298                 $html->item(0)->appendChild($element);
299             }
300             
301             $this->plaintext = str_replace("{unsubscribe_link}", $unsubscribe, $this->plaintext);
302         }
303         
304         
305         $this->bodytext = $doc->saveHTML();
306         
307         libxml_use_internal_errors (false);
308         
309         $this->bodytext = str_replace('%7B', '{', $this->bodytext ); // kludge as template is not interpretated as html.
310         $this->bodytext = str_replace('%7D', '}', $this->bodytext ); // kludge as template is not interpretated as html.
311          
312         return;
313     }
314     
315     function unsubscribe_url()
316     {
317         $unsubscribe = false;
318         
319         $cfg = isset(HTML_FlexyFramework::get()->Pman_Crm) ? HTML_FlexyFramework::get()->Pman_Crm : false;
320         
321         if(!empty($cfg)){
322             $unsubscribe = $cfg ['server_baseurl'] . '/Crm/Unsubscribe/' . $this->id . '/{person.id}';
323         }
324         
325         return $unsubscribe;
326     }
327     
328     /**
329      * convert email with contents into a core mailer object. - ready to send..
330      * @param Object|Array $obj Object (or array) to send @see Pman_Core_Mailer
331      *    + subject
332      *    + rcpts || person   << if person is set - then it goes to them...
333      *    + rcpts_group (string) << name of group - normally to send admin emails.. (if set, then bcc_group is ignored.)
334      *    + replace_links
335      *    + template
336      *    + mailer_opts
337      *    + person << who it actually goes to..
338      *    
339      * @param bool $force - force re-creation of cached version of email.
340      *
341      * @returns Pman_Core_Mailer||PEAR_Error
342      */
343     
344     function toMailer($obj,$force=false)
345     {
346         require_once 'PEAR.php';
347         
348         $p = new PEAR();
349         $contents = (array)$obj;
350         
351         if(empty($this->id) && !empty($contents['template'])){
352             $this->get('name', $contents['template']);
353         }
354              
355         
356         if(empty($this->active)){
357             return $p->raiseError("template [{$contents['template']}] is Disabled");
358         }
359         
360         
361         if(empty($this->id)){
362             return $p->raiseError("template [{$contents['template']}] has not been set");
363         }
364         
365         // fill in BCC
366         
367         if (!empty($this->bcc_group_id) && $this->bcc_group_id > 0 && empty($contents['rcpts_group'])) {
368             $admin_grp = DB_DAtaObject::Factory('core_group')->load($this->bcc_group_id);
369             $admin = $admin_grp->members('email');
370             
371             if (empty($admin) && $admin_grp->name != 'Empty Group') { // allow 'empty group mname'
372                 return $p->raiseError("template [{$contents['template']}] - bcc group is empty");
373             }
374             
375             $contents['bcc'] = $admin ;
376         }
377         if (!empty($contents['rcpts_group'])) {
378             
379             $admin = DB_DAtaObject::Factory('core_group')->lookupMembers($contents['rcpts_group'],'email');
380             
381             if (empty($admin)) {
382                 return $p->raiseError("Trying to send to {$contents['rcpts_group']} - group is empty");
383             }
384             $contents['rcpts'] = $admin;
385         }
386         
387         //subject replacement
388         if(empty($contents['subject'])){
389            $contents['subject'] = $this->subject; 
390         }
391
392         if (!empty($contents['subject_replace'])) {
393             if (isset($contents['mapping'])) {
394                 foreach ($contents['mapping'] as $pattern => $replace) {
395                     $contents['subject'] = preg_replace($pattern,$replace,$contents['subject']);
396                 }
397             }
398             foreach ($contents as $k => $v) {
399                 if (is_string($v)) {
400                     $contents['subject'] = str_replace('{'. $k . '}', $v, $contents['subject']);
401                 }
402             }
403         }
404         
405         if(!empty($contents['rcpts']) && is_array($contents['rcpts'])){
406             $contents['rcpts'] = implode(',', $contents['rcpts']);
407         }     
408         
409         $ui = posix_getpwuid(posix_geteuid());
410         
411         $cachePath = session_save_path() . '/email-cache-' . $ui['name'] . '/mail/' . $this->tableName() . '-' . $this->id . '.txt';
412         
413         if($force || !$this->isGenerated($cachePath)){
414             $this->cachedMailWithOutImages($force, empty($contents['replace_links']) ? false : $contents['replace_links']);
415         }
416          
417         require_once 'Pman/Core/Mailer.php';
418               
419         
420         $templateDir = session_save_path() . '/email-cache-' . $ui['name'] ;
421         //print_r($this);
422         
423         
424         $cfg = array(
425             'template'=> $this->tableName() . '-' . $this->id,
426             'templateDir' => $templateDir,
427             'page' => $this,
428             'contents' => $contents,
429             'css_embed' => true, // we should always try and do this with emails...
430         );
431         
432         if (isset($contents['rcpts'])) {
433             $cfg['rcpts'] = $contents['rcpts'];
434         }
435         
436         if (isset($contents['attachments'])) {
437             $cfg['attachments'] = $contents['attachments'];
438         }
439         
440         if (isset($contents['mailer_opts']) && is_array($contents['mailer_opts'])) {
441             $cfg = array_merge($contents['mailer_opts'], $cfg);
442         }
443         
444         if(isset($contents['css_inline'])){
445             $cfg['css_inline'] = $contents['css_inline'];
446         }
447         
448         $r = new Pman_Core_Mailer($cfg);
449         
450         $imageCache = session_save_path() . '/email-cache-' . $ui['name'] . '/mail/' . $this->tableName() . '-' . $this->id . '-images.txt';
451         
452         if(file_exists($imageCache) && filesize($imageCache)){
453             $images = json_decode(file_get_contents($imageCache), true);
454             $r->images = $images;
455         }
456         
457         return $r;
458     }
459     function toMailerData($obj,$force=false)
460     {   
461         $r = $this->toMailer($obj, $force);
462         if (is_a($r, 'PEAR_Error')) {
463             return $r;
464         }
465         return $r->toData();
466     }
467     
468     /**
469      *
470      * DEPRICATED !!! - DO NOT USE THIS !!!
471      *
472      * use: toMailerData() -- to return the email data..
473      * or
474      * $mailer = $core_email->toMailer($obj, false);
475      * $sent = is_a($mailer,'PEAR_Error') ? false : $mailer->send();
476
477      * toMailer($obj, false)->send()
478      *
479      * 
480      */
481     
482     function send($obj, $force = true, $send = true)
483     {   
484         if (!$send) {
485             return $this->toMailerData($obj,$force);
486         }
487         
488         $r = $this->toMailer($obj, $force);
489         
490         if (is_a($r, 'PEAR_Error')) {
491             return $r;
492         }
493         
494         return $r->send();
495     }
496     
497     function cachedMailWithOutImages($force = false, $replace_links = true)
498     {  
499         
500         $ui = posix_getpwuid(posix_geteuid());
501         
502         $cachePath = session_save_path() . '/email-cache-' . $ui['name'] . '/mail/' . $this->tableName() . '-' . $this->id . '.txt';
503           
504         if (!$force && $this->isGenerated($cachePath)) {
505             return;
506         }
507         
508         if (!file_exists(dirname($cachePath))) {
509             mkdir(dirname($cachePath), 0700, true);
510         }
511         
512         $random_hash = md5(date('r', time()));
513         
514         $this->cachedImages();
515         
516         $fh = fopen($cachePath, 'w');
517
518         fwrite($fh, implode("\n", array(
519             "From: {if:t.messageFrom}{t.messageFrom:h}{else:}{t.messageFrom():h}{end:}",
520             "To: {if:t.person}{t.person.getEmailFrom():h}{else:}{rcpts:h}{end:}",
521             "Subject: {t.subject:h} ",
522             "X-Message-ID: {t.id} ",
523             "{if:t.replyTo}Reply-To: {t.replyTo:h}{end:}",
524             "{if:t.mailgunVariables}X-Mailgun-Variables: {t.mailgunVariables:h}{end:}"
525         ))."\n");
526         
527         
528 // note the extra space to finish the last line..
529         fwrite($fh, " " . "
530 Content-Type: multipart/alternative; boundary=alt-{$random_hash}
531
532 --alt-{$random_hash}
533 Content-Type: text/plain; charset=utf-8; format=flowed
534 Content-Transfer-Encoding: 7bit
535
536 {$this->plaintext}
537
538 ");
539         fclose($fh);
540         
541         // cache body
542         
543         $this->processRelacements($replace_links);
544         
545         $cachePath = session_save_path() . '/email-cache-' . $ui['name'] . '/mail/' . $this->tableName() . '-' . $this->id . '.body.html';
546         
547         if (!file_exists(dirname($cachePath))) {
548             mkdir(dirname($cachePath), 0700, true);
549         }
550         
551         if (empty($this->use_file)) {
552             file_put_contents($cachePath, $this->bodytext);
553             return;
554         }
555         // use-file -- uses the original template...
556         $mailtext = file_get_contents($this->use_file);        
557          
558         require_once 'Mail/mimeDecode.php';
559         require_once 'Mail/RFC822.php';
560         
561         $decoder = new Mail_mimeDecode($mailtext);
562         $parts = $decoder->getSendArray();
563         file_put_contents($cachePath,$parts[2]);
564          
565     }
566     
567     function cachedImages()
568     {
569         $ui = posix_getpwuid(posix_geteuid());
570         
571         $imageCache = session_save_path() . '/email-cache-' . $ui['name'] . '/mail/' . $this->tableName() . '-' . $this->id . '-images.txt';
572         
573         $ids = $this->attachmentIds();
574         
575          
576         $fh = fopen($imageCache, 'w');
577         
578         $i = DB_DataObject::factory('Images');
579         $i->onid = $this->id;
580         $i->ontable = $this->tableName();
581         $i->whereAddIn('id', $ids, 'int');
582         $i->find();
583         
584         $images = array();
585         
586         require_once 'File/MimeType.php';
587         $y = new File_MimeType();
588         
589         while ($i->fetch()){
590             if (!file_exists($i->getStoreName()) || !filesize($i->getStoreName())) {
591                 continue;
592             }
593             
594             $images["attachment-{$i->id}"] = array(
595                 'file' => $i->getStoreName(),
596                 'mimetype' => $i->mimetype,
597                 'ext' => $y->toExt($i->mimetype),
598                 'contentid' => "attachment-$i->id"
599             );
600         }
601             
602         file_put_contents($imageCache, json_encode($images));
603         
604     }
605     
606     function isGenerated($cachePath)
607     {
608         if (!file_exists($cachePath) || !filesize($cachePath)) {
609             return false;
610         }
611         
612         if (!empty($this->use_file)) {
613             $ctime = filemtime($cachePath);
614             $mtime = filemtime($this->use_file);
615             if($ctime >= $mtime){
616                 return true;
617             }
618             return false;
619             
620         }
621         
622         
623         
624         $ctime = filemtime($cachePath);
625         $mtime = array();
626         $mtime[] = $this->updated_dt;
627         $i = DB_DataObject::factory('Images');
628         $i->onid = $this->id;
629         $i->ontable = $this->tableName();
630         $i->selectAdd();
631         $i->selectAdd('max(created) as created');
632         $i->find(true);
633         $mtime[] = $i->created;
634         if($ctime >= strtotime(max($mtime))){
635             return true;
636         }
637         
638         return false;
639     }
640     
641     function messageFrom()
642     {
643         if (empty($this->from_name)) {
644             return trim($this->from_email);
645         }
646         return trim('"' . addslashes($this->from_name) . '" <' . $this->from_email. '>')  ;
647     }
648     
649     function formatDate($dt, $format = 'd/M/Y')
650     {
651         return date($format, strtotime($dt));
652     } 
653     
654     
655      // fixme - this is now in core/udatedatabase..
656     
657     function initMail($mail_template_dir,  $name, $master='')
658     {
659         $cm = DB_DataObject::factory('core_email');
660         if ($cm->get('name', $name)) {
661             return;
662         }
663         
664 //        $basedir = $this->bootLoader->rootDir . $mail_template_dir;
665         
666         $opts = array();
667         
668         $opts['file'] = $mail_template_dir. $name .'.html';
669         if (!empty($master)) {
670             $opts['master'] = $mail_template_dir . $master .'.html';
671         }
672         //print_r($opts);
673         require_once 'Pman/Core/Import/Core_email.php';
674         $x = new Pman_Core_Import_Core_email();
675         $x->get('', $opts);
676          
677     }
678     
679     
680     
681 }