]> CyberLeo.Net >> Repos - Github/sugarcrm.git/blob - modules/EmailTemplates/EmailTemplate.php
Release 6.4.0
[Github/sugarcrm.git] / modules / EmailTemplates / EmailTemplate.php
1 <?php
2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
3 /*********************************************************************************
4  * SugarCRM Community Edition is a customer relationship management program developed by
5  * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
6  * 
7  * This program is free software; you can redistribute it and/or modify it under
8  * the terms of the GNU Affero General Public License version 3 as published by the
9  * Free Software Foundation with the addition of the following permission added
10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
13  * 
14  * This program is distributed in the hope that it will be useful, but WITHOUT
15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
17  * details.
18  * 
19  * You should have received a copy of the GNU Affero General Public License along with
20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
22  * 02110-1301 USA.
23  * 
24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
26  * 
27  * The interactive user interfaces in modified source and object code versions
28  * of this program must display Appropriate Legal Notices, as required under
29  * Section 5 of the GNU Affero General Public License version 3.
30  * 
31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
32  * these Appropriate Legal Notices must retain the display of the "Powered by
33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
34  * technical reasons, the Appropriate Legal Notices must display the words
35  * "Powered by SugarCRM".
36  ********************************************************************************/
37
38 /*********************************************************************************
39
40  * Description:  TODO: To be written.
41  * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
42  * All Rights Reserved.
43  * Contributor(s): ______________________________________..
44  ********************************************************************************/
45
46
47
48
49
50
51 // EmailTemplate is used to store email email_template information.
52 class EmailTemplate extends SugarBean {
53         var $field_name_map = array();
54         // Stored fields
55         var $id;
56         var $date_entered;
57         var $date_modified;
58         var $modified_user_id;
59         var $created_by;
60         var $created_by_name;
61         var $modified_by_name;
62     var $assigned_user_id;
63     var $assigned_user_name;
64         var $name;
65         var $published;
66         var $description;
67         var $body;
68         var $body_html;
69     var $subject;
70         var $attachments;
71         var $from_name;
72         var $from_address;
73         var $table_name = "email_templates";
74         var $object_name = "EmailTemplate";
75         var $module_dir = "EmailTemplates";
76         var $new_schema = true;
77         // This is used to retrieve related fields from form posts.
78         var $additional_column_fields = array(
79         );
80         // add fields here that would not make sense in an email template
81         var $badFields = array(
82                 'account_description',
83                 'contact_id',
84                 'lead_id',
85                 'opportunity_amount',
86                 'opportunity_id',
87                 'opportunity_name',
88                 'opportunity_role_id',
89                 'opportunity_role_fields',
90                 'opportunity_role',
91                 'campaign_id',
92                 // User objects
93                 'id',
94                 'date_entered',
95                 'date_modified',
96                 'user_preferences',
97                 'accept_status',
98                 'user_hash',
99                 'authenticate_id',
100                 'sugar_login',
101                 'reports_to_id',
102                 'reports_to_name',
103                 'is_admin',
104                 'receive_notifications',
105                 'modified_user_id',
106                 'modified_by_name',
107                 'created_by',
108                 'created_by_name',
109                 'accept_status_id',
110                 'accept_status_name',
111         );
112
113         function EmailTemplate() {
114                 parent::SugarBean();
115         }
116
117         /**
118          * Generates the extended field_defs for creating macros
119          * @param object $bean SugarBean
120          * @param string $prefix "contact_", "user_" etc.
121          * @return
122          */
123         function generateFieldDefsJS() {
124                 global $current_user;
125
126
127
128
129
130                 $contact = new Contact();
131                 $account = new Account();
132                 $lead = new Lead();
133                 $prospect = new Prospect();
134
135
136                 $loopControl = array(
137                         'Contacts' => array(
138                             'Contacts' => $contact,
139                             'Leads' => $lead,
140                                 'Prospects' => $prospect,
141                         ),
142                         'Accounts' => array(
143                                 'Accounts' => $account,
144                         ),
145                         'Users' => array(
146                                 'Users' => $current_user,
147                         ),
148                 );
149
150                 $prefixes = array(
151                         'Contacts' => 'contact_',
152                         'Accounts' => 'account_',
153                         'Users' => 'contact_user_',
154                 );
155
156                 $collection = array();
157                 foreach($loopControl as $collectionKey => $beans) {
158                         $collection[$collectionKey] = array();
159                         foreach($beans as $beankey => $bean) {
160
161                                 foreach($bean->field_defs as $key => $field_def) {
162                                     if( ($field_def['type'] == 'relate' && empty($field_def['custom_type'])) ||
163                                                 ($field_def['type'] == 'assigned_user_name' || $field_def['type'] =='link') ||
164                                                 ($field_def['type'] == 'bool') ||
165                                                 (in_array($field_def['name'], $this->badFields)) ) {
166                                         continue;
167                                     }
168                                     if(!isset($field_def['vname'])) {
169                                         //echo $key;
170                                     }
171                                     // valid def found, process
172                                     $optionKey = strtolower("{$prefixes[$collectionKey]}{$key}");
173                                     $optionLabel = preg_replace('/:$/', "", translate($field_def['vname'], $beankey));
174                                     $dup=1;
175                                     foreach ($collection[$collectionKey] as $value){
176                                         if($value['name']==$optionKey){
177                                                 $dup=0;
178                                                 break;
179                                         }
180                                     }
181                                     if($dup)
182                                         $collection[$collectionKey][] = array("name" => $optionKey, "value" => $optionLabel);
183                                 }
184                         }
185                 }
186
187                 $json = getJSONobj();
188                 $ret = "var field_defs = ";
189                 $ret .= $json->encode($collection, false);
190                 $ret .= ";";
191                 return $ret;
192         }
193
194         function get_summary_text() {
195                 return "$this->name";
196         }
197
198         function create_export_query(&$order_by, &$where) {
199                 return $this->create_new_list_query($order_by, $where);
200         }
201
202         function fill_in_additional_list_fields() {
203                 $this->fill_in_additional_parent_fields();
204         }
205
206         function fill_in_additional_detail_fields() {
207             if (empty($this->body) && !empty($this->body_html))
208         {
209             $this->body = strip_tags(html_entity_decode($this->body_html));
210         }
211                 $this->created_by_name = get_assigned_user_name($this->created_by);
212                 $this->modified_by_name = get_assigned_user_name($this->modified_user_id);
213         $this->assigned_user_name = get_assigned_user_name($this->assigned_user_id);
214                 $this->fill_in_additional_parent_fields();
215         }
216
217         function fill_in_additional_parent_fields() {
218         }
219
220         function get_list_view_data() {
221                 global $app_list_strings, $focus, $action, $currentModule;
222                 $fields = $this->get_list_view_array();
223                 $fields["DATE_MODIFIED"] = substr($fields["DATE_MODIFIED"], 0 , 10);
224                 return $fields;
225         }
226
227         //function all string that match the pattern {.} , also catches the list of found strings.
228         //the cache will get refreshed when the template bean instance changes.
229         //The found url key patterns are replaced with name value pairs provided as function parameter. $tracked_urls.
230         //$url_template is used to construct the url for the email message. the template should have place holder for 1 varaible parameter, represented by %1
231         //$template_text_array is a list of text strings that need to be searched. usually the subject, html body and text body of the email message.
232         //$removeme_url_template, if the url has is_optout property checked then use this template.
233         function parse_tracker_urls($template_text_array,$url_template,$tracked_urls,$removeme_url_template) {
234                 global $beanFiles,$beanList, $app_list_strings,$sugar_config;
235                 if (!isset($this->parsed_urls))
236                         $this->parsed_urls=array();
237
238                 //parse the template and find all the dynamic strings that need replacement.
239                 $pattern = '/\{*[^\{\}]*\}/'; // cn: bug 6638, find multibyte strings
240                 foreach ($template_text_array as $key=>$template_text) {
241                         if (!empty($template_text)) {
242                 if(!isset($this->parsed_urls[$key]) || $this->parsed_urls[$key]['text'] != $template_text) {
243                                         $matches=array();
244                                         $count=preg_match_all($pattern,$template_text,$matches,PREG_OFFSET_CAPTURE);
245                                         $this->parsed_urls[$key]=array('matches' => $matches, 'text' => $template_text);
246                                 } else {
247                                         $matches=$this->parsed_urls[$key]['matches'];
248                                         if(!empty($matches[0])) {
249                                                 $count=count($matches[0]);
250                                         } else {
251                                                 $count=0;
252                                         }
253                                 }
254
255                                 //navigate thru all the matched keys and replace the keys with actual strings.
256                                 for ($i=($count -1); $i>=0; $i--) {
257                                         $url_key_name=$matches[0][$i][0];
258
259                                         if (!empty($tracked_urls[$url_key_name])) {
260                                                 if ($tracked_urls[$url_key_name]['is_optout']==1){
261                                                         $tracker_url = $removeme_url_template;
262                                                 } else {
263                                                         $tracker_url = sprintf($url_template,$tracked_urls[$url_key_name]['id']);
264                                                 }
265                                         }
266                                         if(!empty($tracker_url) && !empty($template_text) && !empty($matches[0][$i][0]) && !empty($tracked_urls[$matches[0][$i][0]])){
267                         $template_text=substr_replace($template_text,$tracker_url,$matches[0][$i][1], strlen($matches[0][$i][0]));
268                         $template_text=str_replace($sugar_config['site_url'].'/'.$sugar_config['site_url'],$sugar_config['site_url'],$template_text);
269                     }
270                                 }
271                         }
272                         $return_array[$key]=$template_text;
273                 }
274
275                 return $return_array;
276         }
277
278         function parse_email_template($template_text_array, $focus_name, $focus, &$macro_nv) {
279
280
281                 global $beanFiles, $beanList, $app_list_strings;
282
283                 // generate User instance that owns this "Contact" for contact_user_* macros
284                 $user = new User();
285         if(isset($focus->assigned_user_id)  && !empty($focus->assigned_user_id)){
286                   $user->retrieve($focus->assigned_user_id);
287         }
288
289                 if(!isset($this->parsed_entities))
290                         $this->parsed_entities=array();
291
292                 //parse the template and find all the dynamic strings that need replacement.
293         // Bug #48111 It's strange why prefix for User module is contact_user (see self::generateFieldDefsJS method)
294         if ($beanList[$focus_name] == 'User')
295         {
296             $pattern_prefix = '$contact_user_';
297         }
298         else
299         {
300             $pattern_prefix = '$'.strtolower($beanList[$focus_name]).'_';
301         }
302                 $pattern_prefix_length = strlen($pattern_prefix);
303                 $pattern = '/\\'.$pattern_prefix.'[A-Za-z_0-9]*/';
304
305                 foreach($template_text_array as $key=>$template_text) {
306                         if(!isset($this->parsed_entities[$key])) {
307                                 $matches = array();
308                                 $count = preg_match_all($pattern, $template_text, $matches, PREG_OFFSET_CAPTURE);
309
310                                 if($count != 0) {
311                                         for($i=($count -1); $i>=0; $i--) {
312                                                 if(!isset($matches[0][$i][2])) {
313                                                         //find the field name in the bean.
314                                                         $matches[0][$i][2]=substr($matches[0][$i][0],$pattern_prefix_length,strlen($matches[0][$i][0]) - $pattern_prefix_length);
315
316                                                         //store the localized strings if the field is of type enum..
317                                                         if(isset($focus->field_defs[$matches[0][$i][2]]) && $focus->field_defs[$matches[0][$i][2]]['type']=='enum' && isset($focus->field_defs[$matches[0][$i][2]]['options'])) {
318                                                                 $matches[0][$i][3]=$focus->field_defs[$matches[0][$i][2]]['options'];
319                                                         }
320                                                 }
321                                         }
322                                 }
323                                 $this->parsed_entities[$key]=$matches;
324                         } else {
325                                 $matches=$this->parsed_entities[$key];
326                                 if(!empty($matches[0])) {
327                                         $count=count($matches[0]);
328                                 } else {
329                                         $count=0;
330                                 }
331                         }
332
333                         for ($i=($count -1); $i>=0; $i--) {
334                                 $field_name=$matches[0][$i][2];
335
336                                 // cn: feel for User object attribute key and assign as found
337                                 if(strpos($field_name, "user_") === 0) {
338                                         $userFieldName = substr($field_name, 5);
339                                         $value = $user->$userFieldName;
340                                         //_pp($userFieldName."[{$value}]");
341                                 } else {
342                                         $value = $focus->{$field_name};
343                                 }
344
345                                 //check dom
346                                 if(isset($matches[0][$i][3])) {
347                                         if(isset($app_list_strings[$matches[0][$i][3]][$value])) {
348                                                 $value=$app_list_strings[$matches[0][$i][3]][$value];
349                                         }
350                                 }
351
352                 //generate name value pair array of macros and corresponding values for the targed.
353                 $macro_nv[$matches[0][$i][0]] =$value;
354
355                                 $template_text=substr_replace($template_text,$value,$matches[0][$i][1], strlen($matches[0][$i][0]));
356                         }
357
358                         //parse the template for tracker url strings. patter for these strings in {[a-zA-Z_0-9]+}
359
360                         $return_array[$key]=$template_text;
361                 }
362
363                 return $return_array;
364         }
365
366
367         /**
368          * Convenience method to parse for user's values in a template
369          * @param array $repl_arr
370          * @param object $user
371          * @return array
372          */
373         function _parseUserValues($repl_arr, &$user) {
374                 foreach($user->field_defs as $field_def) {
375                         if(($field_def['type'] == 'relate' && empty($field_def['custom_type'])) || $field_def['type'] == 'assigned_user_name') {
376                         continue;
377                         }
378
379                         if($field_def['type'] == 'enum') {
380                                 $translated = translate($field_def['options'], 'Users', $user->$field_def['name']);
381
382                                 if(isset($translated) && ! is_array($translated)) {
383                                         $repl_arr["contact_user_".$field_def['name']] = $translated;
384                                 } else { // unset enum field, make sure we have a match string to replace with ""
385                                         $repl_arr["contact_user_".$field_def['name']] = '';
386                                 }
387                         } else {
388                                 if(isset($user->$field_def['name'])) {
389                                         $repl_arr["contact_user_".$field_def['name']] = $user->$field_def['name'];
390                                 } else {
391                                         $repl_arr["contact_user_".$field_def['name']] = "";
392                                 }
393                         }
394                 }
395
396                 return $repl_arr;
397         }
398
399
400         function parse_template_bean($string, $bean_name, &$focus) {
401                 global $current_user;
402                 global $beanFiles, $beanList;
403                 $repl_arr = array();
404
405                 // cn: bug 9277 - create a replace array with empty strings to blank-out invalid vars
406                 if(!class_exists('Account'))
407                 if(!class_exists('Contact'))
408                 if(!class_exists('Leads'))
409                 if(!class_exists('Prospects'))
410                 
411                 require_once('modules/Accounts/Account.php');
412                 $acct = new Account();
413                 $contact = new Contact();
414                 $lead = new Lead();
415                 $prospect = new Prospect();
416                 
417                 foreach($lead->field_defs as $field_def) {
418                         if(($field_def['type'] == 'relate' && empty($field_def['custom_type'])) || $field_def['type'] == 'assigned_user_name') {
419                         continue;
420                         }
421                         $repl_arr["contact_".$field_def['name']] = '';
422                         $repl_arr["contact_account_".$field_def['name']] = '';
423                 }
424                 foreach($prospect->field_defs as $field_def) {
425                         if(($field_def['type'] == 'relate' && empty($field_def['custom_type'])) || $field_def['type'] == 'assigned_user_name') {
426                         continue;
427                         }
428                         $repl_arr["contact_".$field_def['name']] = '';
429                         $repl_arr["contact_account_".$field_def['name']] = '';
430                 }
431                 foreach($contact->field_defs as $field_def) {
432                         if(($field_def['type'] == 'relate' && empty($field_def['custom_type'])) || $field_def['type'] == 'assigned_user_name') {
433                         continue;
434                         }
435                         $repl_arr["contact_".$field_def['name']] = '';
436                         $repl_arr["contact_account_".$field_def['name']] = '';
437                 }
438                 foreach($acct->field_defs as $field_def) {
439                         if(($field_def['type'] == 'relate' && empty($field_def['custom_type'])) || $field_def['type'] == 'assigned_user_name') {
440                         continue;
441                         }
442                         $repl_arr["account_".$field_def['name']] = '';
443                         $repl_arr["account_contact_".$field_def['name']] = '';
444                 }
445                 // cn: end bug 9277 fix
446
447
448                 // feel for Parent account, only for Contacts traditionally, but written for future expansion
449                 if(isset($focus->account_id) && !empty($focus->account_id)) {
450                         $acct->retrieve($focus->account_id);
451                 }
452
453                 if($bean_name == 'Contacts') {
454                         // cn: bug 9277 - email templates not loading account/opp info for templates
455                         if(!empty($acct->id)) {
456                                 foreach($acct->field_defs as $field_def) {
457                                         if(($field_def['type'] == 'relate' && empty($field_def['custom_type'])) || $field_def['type'] == 'assigned_user_name') {
458                                 continue;
459                                         }
460
461                                         if($field_def['type'] == 'enum') {
462                                                 $translated = translate($field_def['options'], 'Accounts' ,$acct->$field_def['name']);
463
464                                                 if(isset($translated) && ! is_array($translated)) {
465                                                         $repl_arr["account_".$field_def['name']] = $translated;
466                                                         $repl_arr["contact_account_".$field_def['name']] = $translated;
467                                                 } else { // unset enum field, make sure we have a match string to replace with ""
468                                                         $repl_arr["account_".$field_def['name']] = '';
469                                                         $repl_arr["contact_account_".$field_def['name']] = '';
470                                                 }
471                                         } else {
472                                                 $repl_arr["account_".$field_def['name']] = $acct->$field_def['name'];
473                                                 $repl_arr["contact_account_".$field_def['name']] = $acct->$field_def['name'];
474                                         }
475                                 }
476                         }
477
478                         if(!empty($focus->assigned_user_id)) {
479                                 $user = new User();
480                                 $user->retrieve($focus->assigned_user_id);
481                                 $repl_arr = EmailTemplate::_parseUserValues($repl_arr, $user);
482                         }
483                 } elseif($bean_name == 'Users') {
484                         /**
485                          * This section of code will on do work when a blank Contact, Lead,
486                          * etc. is passed in to parse the contact_* vars.  At this point,
487                          * $current_user will be used to fill in the blanks.
488                          */
489                         $repl_arr = EmailTemplate::_parseUserValues($repl_arr, $current_user);
490                 } else {
491                         // assumed we have an Account in focus
492                         foreach($contact->field_defs as $field_def) {
493                                 if(($field_def['type'] == 'relate' && empty($field_def['custom_type'])) || $field_def['type'] == 'assigned_user_name' || $field_def['type'] == 'link') {
494                         continue;
495                                 }
496
497                                 if($field_def['type'] == 'enum') {
498                                         $translated = translate($field_def['options'], 'Accounts' ,$contact->$field_def['name']);
499
500                                         if(isset($translated) && ! is_array($translated)) {
501                                                 $repl_arr["contact_".$field_def['name']] = $translated;
502                                                 $repl_arr["contact_account_".$field_def['name']] = $translated;
503                                         } else { // unset enum field, make sure we have a match string to replace with ""
504                                                 $repl_arr["contact_".$field_def['name']] = '';
505                                                 $repl_arr["contact_account_".$field_def['name']] = '';
506                                         }
507                                 } else {
508                                         if (isset($contact->$field_def['name'])) {
509                                                 $repl_arr["contact_".$field_def['name']] = $contact->$field_def['name'];
510                                                 $repl_arr["contact_account_".$field_def['name']] = $contact->$field_def['name'];
511                                         } // if
512                                 }
513                         }
514                 }
515
516                 ///////////////////////////////////////////////////////////////////////
517                 ////    LOAD FOCUS DATA INTO REPL_ARR
518                 foreach($focus->field_defs as $field_def) {
519                         if(isset($focus->$field_def['name'])) {
520                                 if(($field_def['type'] == 'relate' && empty($field_def['custom_type'])) || $field_def['type'] == 'assigned_user_name') {
521                         continue;
522                                 }
523
524                                 if($field_def['type'] == 'enum' && isset($field_def['options'])) {
525                                         $translated = translate($field_def['options'],$bean_name,$focus->$field_def['name']);
526
527                                         if(isset($translated) && ! is_array($translated)) {
528                                                 $repl_arr[strtolower($beanList[$bean_name])."_".$field_def['name']] = $translated;
529                                         } else { // unset enum field, make sure we have a match string to replace with ""
530                                                 $repl_arr[strtolower($beanList[$bean_name])."_".$field_def['name']] = '';
531                                         }
532                                 } else {
533                                         $repl_arr[strtolower($beanList[$bean_name])."_".$field_def['name']] = $focus->$field_def['name'];
534                                 }
535                         } else {
536                                 if($field_def['name'] == 'full_name') {
537                                         $repl_arr[strtolower($beanList[$bean_name]).'_full_name'] = $focus->get_summary_text();
538                                 } else {
539                                         $repl_arr[strtolower($beanList[$bean_name])."_".$field_def['name']] = '';
540                                 }
541                         }
542                 } // end foreach()
543
544                 krsort($repl_arr);
545                 reset($repl_arr);
546                 //20595 add nl2br() to respect the multi-lines formatting
547                 if(isset($repl_arr['contact_primary_address_street'])){
548                     $repl_arr['contact_primary_address_street'] = nl2br($repl_arr['contact_primary_address_street']);
549                 }
550                 if(isset($repl_arr['contact_alt_address_street'])){
551                     $repl_arr['contact_alt_address_street'] = nl2br($repl_arr['contact_alt_address_street']);   
552                 }
553
554                 foreach ($repl_arr as $name=>$value) {
555                         if($value != '' && is_string($value)) {
556                                 $string = str_replace("\$$name", $value, $string);
557                         } else {
558                                 $string = str_replace("\$$name", ' ', $string);
559                         }
560                 }
561
562                 return $string;
563         }
564
565         function parse_template($string, &$bean_arr) {
566                 global $beanFiles, $beanList;
567
568                 foreach($bean_arr as $bean_name => $bean_id) {
569                         require_once($beanFiles[$beanList[$bean_name]]);
570
571                         $focus = new $beanList[$bean_name];
572                         $result = $focus->retrieve($bean_id);
573
574                         if($bean_name == 'Leads' || $bean_name == 'Prospects') {
575                                 $bean_name = 'Contacts';
576                         }
577
578                         if(isset($this) && isset($this->module_dir) && $this->module_dir == 'EmailTemplates') {
579                                 $string = $this->parse_template_bean($string, $bean_name, $focus);
580                         } else {
581                                 $string = EmailTemplate::parse_template_bean($string, $bean_name, $focus);
582                         }
583                 }
584                 return $string;
585         }
586
587         function bean_implements($interface) {
588                 switch($interface) {
589                         case 'ACL':return true;
590                 }
591                 return false;
592         }
593
594         function is_used_by_email_marketing() {
595                 $query = "select id from email_marketing where template_id='$this->id' and deleted=0";
596                 $result = $this->db->query($query);
597                 if($this->db->fetchByAssoc($result)) {
598                         return true;
599                 }
600                 return false;
601         }
602 }
603 ?>