SuiteCRM-Core/modules/EmailTemplates/EmailTemplate.php

<?php
if (!defined('sugarEntry') || !sugarEntry) {
    die('Not A Valid Entry Point');
}
/**
 *
 * SugarCRM Community Edition is a customer relationship management program developed by
 * SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
 *
 * SuiteCRM is an extension to SugarCRM Community Edition developed by SalesAgility Ltd.
 * Copyright (C) 2011 - 2018 SalesAgility Ltd.
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by the
 * Free Software Foundation with the addition of the following permission added
 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Affero General Public License along with
 * this program; if not, see http://www.gnu.org/licenses or write to the Free
 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA.
 *
 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
 * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License version 3.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
 * these Appropriate Legal Notices must retain the display of the "Powered by
 * SugarCRM" logo and "Supercharged by SuiteCRM" logo. If the display of the logos is not
 * reasonably feasible for technical reasons, the Appropriate Legal Notices must
 * display the words "Powered by SugarCRM" and "Supercharged by SuiteCRM".
 */

// EmailTemplate is used to store email email_template information.
class EmailTemplate extends SugarBean
{
    public $field_name_map = array();
    // Stored fields
    public $id;
    public $date_entered;
    public $date_modified;
    public $modified_user_id;
    public $created_by;
    public $created_by_name;
    public $modified_by_name;
    public $assigned_user_id;
    public $assigned_user_name;
    public $name;
    public $published;
    public $description;
    public $body;
    public $body_html;
    public $subject;
    public $attachments;
    public $from_name;
    public $from_address;
    public $table_name = "email_templates";
    public $object_name = "EmailTemplate";
    public $module_dir = "EmailTemplates";
    public $new_schema = true;
    // This is used to retrieve related fields from form posts.
    public $additional_column_fields = array();
    // add fields here that would not make sense in an email template
    public $badFields = array(
        'account_description',
        'contact_id',
        'lead_id',
        'opportunity_amount',
        'opportunity_id',
        'opportunity_name',
        'opportunity_role_id',
        'opportunity_role_fields',
        'opportunity_role',
        'campaign_id',
        // User objects
        'id',
        'date_entered',
        'date_modified',
        'user_preferences',
        'accept_status',
        'user_hash',
        'authenticate_id',
        'sugar_login',
        'reports_to_id',
        'reports_to_name',
        'is_admin',
        'receive_notifications',
        'modified_user_id',
        'modified_by_name',
        'created_by',
        'created_by_name',
        'accept_status_id',
        'accept_status_name',
    );

    /**
     * @var array temp storage for template variables while cleanBean
     */
    protected $storedVariables = array();

    private $imageLinkReplaced = false;

    public function __construct()
    {
        parent::__construct();
    }




    /**
     * Generates the extended field_defs for creating macros
     * @return array
     */
    public function generateFieldDefsJS()
    {
        global $current_user;


        $contact = BeanFactory::newBean('Contacts');
        $account = BeanFactory::newBean('Accounts');
        $lead = BeanFactory::newBean('Leads');
        $prospect = BeanFactory::newBean('Prospects');


        $loopControl = array(
            'Contacts' => array(
                'Contacts' => $contact,
                'Leads' => $lead,
                'Prospects' => $prospect,
            ),
            'Accounts' => array(
                'Accounts' => $account,
            ),
            'Users' => array(
                'Users' => $current_user,
            ),
        );

        $prefixes = array(
            'Contacts' => 'contact_',
            'Accounts' => 'account_',
            'Users' => 'contact_user_',
        );

        $collection = array();
        foreach ($loopControl as $collectionKey => $beans) {
            $collection[$collectionKey] = array();
            foreach ($beans as $beankey => $bean) {
                foreach ($bean->field_defs as $key => $field_def) {
                    if (($field_def['type'] == 'relate' && empty($field_def['custom_type'])) ||
                        ($field_def['type'] == 'assigned_user_name' || $field_def['type'] == 'link') ||
                        ($field_def['type'] == 'bool') ||
                        (isset($field_def['name']) && in_array((array)$field_def['name'], $this->badFields))
                    ) {
                        continue;
                    }
                    if (!isset($field_def['vname'])) {
                        //echo $key;
                    }
                    // valid def found, process
                    $optionKey = strtolower("{$prefixes[$collectionKey]}{$key}");
                    if (!isset($field_def['vname'])) {
                        LoggerManager::getLogger()->warn('Filed def has not translatable name.');
                    }
                    $optionLabel = preg_replace('/:$/', "", translate(isset($field_def['vname']) ? $field_def['vname'] : null, $beankey));
                    $dup = 1;
                    foreach ($collection[$collectionKey] as $value) {
                        if ($value['name'] == $optionKey) {
                            $dup = 0;
                            break;
                        }
                    }
                    if ($dup) {
                        $collection[$collectionKey][] = array("name" => $optionKey, "value" => $optionLabel);
                    }
                }
            }
        }

        $json = getJSONobj();
        $ret = "var field_defs = ";
        $ret .= $json->encode($collection, false);
        $ret .= ";";
        return $ret;
    }

    public function generateFieldDefsJS2()
    {
        global $current_user;

        $contact = BeanFactory::newBean('Contacts');
        $account = BeanFactory::newBean('Accounts');
        $lead = BeanFactory::newBean('Leads');
        $prospect = BeanFactory::newBean('Prospects');
        $event = BeanFactory::newBean('FP_events');


        $loopControl = array(
            'Contacts' => array(
                'Contacts' => $contact,
                'Leads' => $lead,
                'Prospects' => $prospect,
            ),
            'Accounts' => array(
                'Accounts' => $account,
            ),
            'Users' => array(
                'Users' => $current_user,
            ),
            'Events' => array(
                'Events' => $event,
            ),
        );

        $prefixes = array(
            'Contacts' => 'contact_',
            'Accounts' => 'account_',
            'Users' => 'contact_user_',
            'Events' => 'event_',
        );

        $collection = array();
        foreach ($loopControl as $collectionKey => $beans) {
            $collection[$collectionKey] = array();
            foreach ($beans as $beankey => $bean) {
                foreach ($bean->field_defs as $key => $field_def) {
                    if (($field_def['type'] == 'relate' && empty($field_def['custom_type'])) ||
                        ($field_def['type'] == 'assigned_user_name' || $field_def['type'] == 'link') ||
                        ($field_def['type'] == 'bool') ||
                        (in_array($field_def['name'], $this->badFields))
                    ) {
                        continue;
                    }
                    if (!isset($field_def['vname'])) {
                        //echo $key;
                    }
                    // valid def found, process
                    $optionKey = strtolower("{$prefixes[$collectionKey]}{$key}");
                    $optionLabel = preg_replace('/:$/', "", translate($field_def['vname'], $beankey));
                    $dup = 1;
                    foreach ($collection[$collectionKey] as $value) {
                        if ($value['name'] == $optionKey) {
                            $dup = 0;
                            break;
                        }
                    }
                    if ($dup) {
                        $collection[$collectionKey][] = array("name" => $optionKey, "value" => $optionLabel);
                    }
                }
            }
        }

        $json = getJSONobj();
        $ret = "var field_defs = ";
        $ret .= $json->encode($collection, false);
        $ret .= ";";
        return $ret;
    }

    public function get_summary_text()
    {
        return (string)$this->name;
    }

    public function create_export_query($order_by, $where)
    {
        return $this->create_new_list_query($order_by, $where);
    }

    public function fill_in_additional_list_fields()
    {
        $this->fill_in_additional_parent_fields();
    }

    public function fill_in_additional_detail_fields()
    {
        if (empty($this->body) && !empty($this->body_html)) {
            global $sugar_config;

            $bodyCleanup = $this->body_html;

            $bodyCleanup = html_entity_decode($bodyCleanup, ENT_COMPAT, $sugar_config['default_charset']);

            // Template contents should contains at least one
            // white space character at after the variable names
            // to recognise it when parsing and replacing variables
            $bodyCleanup = preg_replace('/(\$\w+\b)([^\s\/&"\'])/', '$1 $2', $bodyCleanup);

            $bodyCleanup = Html2Text\Html2Text::convert($bodyCleanup, true);

            $this->body = $bodyCleanup;
        }
        $this->created_by_name = get_assigned_user_name($this->created_by);
        $this->modified_by_name = get_assigned_user_name($this->modified_user_id);
        $this->assigned_user_name = get_assigned_user_name($this->assigned_user_id);
        $this->fill_in_additional_parent_fields();
    }

    public function fill_in_additional_parent_fields()
    {
    }

    //function all string that match the pattern {.} , also catches the list of found strings.
    //the cache will get refreshed when the template bean instance changes.
    //The found url key patterns are replaced with name value pairs provided as function parameter. $tracked_urls.
    //$url_template is used to construct the url for the email message. the template should have place holder for 1 variable parameter, represented by %1
    //$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.
    //$removeme_url_template, if the url has is_optout property checked then use this template.
    public function parse_tracker_urls($template_text_array, $url_template, $tracked_urls, $removeme_url_template)
    {
        global $beanFiles, $beanList, $app_list_strings, $sugar_config;
        if (!isset($this->parsed_urls)) {
            $this->parsed_urls = array();
        }

        $return_array = $template_text_array;
        if (count($tracked_urls) > 0) {
            //parse the template and find all the dynamic strings that need replacement.
            foreach ($template_text_array as $key => $template_text) {
                if (!empty($template_text)) {
                    if (!isset($this->parsed_urls[$key]) || $this->parsed_urls[$key]['text'] != $template_text) {
                        // Fix for bug52014.
                        $template_text = urldecode($template_text);
                        $matches = $this->_preg_match_tracker_url($template_text);
                        $count = count($matches[0]);
                        $this->parsed_urls[$key] = array('matches' => $matches, 'text' => $template_text);
                    } else {
                        $matches = $this->parsed_urls[$key]['matches'];
                        if (!empty($matches[0])) {
                            $count = count($matches[0]);
                        } else {
                            $count = 0;
                        }
                    }

                    //navigate thru all the matched keys and replace the keys with actual strings.

                    if ($count > 0) {
                        for ($i = ($count - 1); $i >= 0; $i--) {
                            $url_key_name = $matches[0][$i][0];
                            if (!empty($tracked_urls[$url_key_name])) {
                                if ($tracked_urls[$url_key_name]['is_optout'] == 1) {
                                    $tracker_url = $removeme_url_template;
                                } else {
                                    $tracker_url = sprintf($url_template, $tracked_urls[$url_key_name]['id']);
                                }
                            }
                            if (!empty($tracker_url) && !empty($template_text) && !empty($matches[0][$i][0]) && !empty($tracked_urls[$matches[0][$i][0]])) {
                                $template_text = substr_replace($template_text, $tracker_url, $matches[0][$i][1], strlen($matches[0][$i][0]));
                                $template_text = str_replace($sugar_config['site_url'] . '/' . $sugar_config['site_url'], $sugar_config['site_url'], $template_text);
                            }
                        }
                    }
                }
                $return_array[$key] = $template_text;
            }
        }
        return $return_array;
    }

    /**
     *
     * Method for replace "preg_match_all" in method "parse_tracker_urls"
     * @param $text string String in which we need to search all string that match the pattern {.}
     * @return array result of search
     */
    private function _preg_match_tracker_url($text)
    {
        $result = array();
        $ind = 0;
        $switch = false;
        for ($i = 0; $i < strlen($text); $i++) {
            if ($text[$i] == '{') {
                $ind = $i;
                $switch = true;
            } elseif ($text[$i] == '}' && $switch === true) {
                $switch = false;
                array_push($result, array(substr($text, $ind, $i - $ind + 1), $ind));
            }
        }
        return array($result);
    }

    public function parse_email_template($template_text_array, $focus_name, $focus, &$macro_nv)
    {
        global $beanList, $app_list_strings;

        // generate User instance that owns this "Contact" for contact_user_* macros
        $user = BeanFactory::newBean('Users');
        if (isset($focus->assigned_user_id) && !empty($focus->assigned_user_id)) {
            $user->retrieve($focus->assigned_user_id);
        }

        if (!isset($this->parsed_entities)) {
            $this->parsed_entities = array();
        }

        //parse the template and find all the dynamic strings that need replacement.
        // Bug #48111 It's strange why prefix for User module is contact_user (see self::generateFieldDefsJS method)
        if ($beanList[$focus_name] == 'User') {
            $pattern_prefix = '$contact_user_';
        } else {
            $pattern_prefix = '$' . strtolower($beanList[$focus_name]) . '_';
        }
        $pattern_prefix_length = strlen($pattern_prefix);
        $pattern = '/\\' . $pattern_prefix . '[A-Za-z_0-9]*/';

        $return_array = array();
        foreach ($template_text_array as $key => $template_text) {
            if (!isset($this->parsed_entities[$key])) {
                $matches = array();
                $count = preg_match_all($pattern, $template_text, $matches, PREG_OFFSET_CAPTURE);

                if ($count != 0) {
                    for ($i = ($count - 1); $i >= 0; $i--) {
                        if (!isset($matches[0][$i][2])) {
                            //find the field name in the bean.
                            $matches[0][$i][2] = substr($matches[0][$i][0], $pattern_prefix_length, strlen($matches[0][$i][0]) - $pattern_prefix_length);

                            //store the localized strings if the field is of type enum..
                            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'])) {
                                $matches[0][$i][3] = $focus->field_defs[$matches[0][$i][2]]['options'];
                            }
                        }
                    }
                }
                $this->parsed_entities[$key] = $matches;
            } else {
                $matches = $this->parsed_entities[$key];
                if (!empty($matches[0])) {
                    $count = count($matches[0]);
                } else {
                    $count = 0;
                }
            }

            for ($i = ($count - 1); $i >= 0; $i--) {
                $field_name = $matches[0][$i][2];

                // cn: feel for User object attribute key and assign as found
                if (strpos($field_name, "user_") === 0) {
                    $userFieldName = substr($field_name, 5);
                    $value = $user->$userFieldName;
                } else {
                    if (isset($focus->{$field_name})) {
                        $value = $focus->{$field_name};
                    } else {
                        $value = null;
                        $GLOBALS['log']->warn("Undefined field name in email template: $field_name");
                    }
                }

                //check dom
                if (isset($matches[0][$i][3])) {
                    if (isset($app_list_strings[$matches[0][$i][3]][$value])) {
                        $value = $app_list_strings[$matches[0][$i][3]][$value];
                    }
                }

                //generate name value pair array of macros and corresponding values for the targed.
                $macro_nv[$matches[0][$i][0]] = $value;

                $template_text = substr_replace($template_text, $value, $matches[0][$i][1], strlen($matches[0][$i][0]));
            }

            //parse the template for tracker url strings. patter for these strings in {[a-zA-Z_0-9]+}

            $return_array[$key] = $template_text;
        }

        return $return_array;
    }

    /**
     * Convenience method to convert raw value into appropriate type format
     * @param string $type
     * @param string $value
     * @return string
     */
    public function _convertToType($type, $value)
    {
        switch ($type) {
            case 'currency':
                return currency_format_number($value);
            default:
                return $value;
        }
    }

    /**
     * Convenience method to parse for user's values in a template
     * @param array $repl_arr
     * @param object $user
     * @return array
     */
    public function _parseUserValues($repl_arr, &$user)
    {
        foreach ($user->field_defs as $field_def) {
            if (($field_def['type'] == 'relate' && empty($field_def['custom_type'])) || $field_def['type'] == 'assigned_user_name') {
                continue;
            }

            $fieldName = isset($field_def['name']) ? $field_def['name'] : null;
            if ($field_def['type'] == 'enum') {
                if (!isset($fieldName)) {
                    LoggerManager::getLogger()->warn('Email Template / parse user level error: Field name not found');
                } else {
                    if (!isset($user->$fieldName)) {
                        LoggerManager::getLogger()->warn('Email Template / parse user level error: User field not found. Field name was: "' . $fieldName . '"');
                        $userFieldName = null;
                    } else {
                        $userFieldName = $user->$fieldName;
                    }

                    $translated = translate($field_def['options'], 'Users', $userFieldName);

                    if (isset($translated) && !is_array($translated)) {
                        $repl_arr["contact_user_" . $fieldName] = $translated;
                    } else { // unset enum field, make sure we have a match string to replace with ""
                        $repl_arr["contact_user_" . $fieldName] = '';
                    }
                }
            } else {
                if (isset($user->$fieldName)) {
                    // bug 47647 - allow for fields to translate before adding to template
                    $repl_arr["contact_user_" . $fieldName] = self::_convertToType($field_def['type'], $user->$fieldName);
                } else {
                    $repl_arr["contact_user_" . $fieldName] = "";
                }
            }
        }

        return $repl_arr;
    }


    public function parse_template_bean($string, $bean_name, &$focus)
    {
        global $current_user;
        global $beanList;
        $repl_arr = array();

        // cn: bug 9277 - create a replace array with empty strings to blank-out invalid vars
        $acct = BeanFactory::newBean('Accounts');
        $contact = BeanFactory::newBean('Contacts');
        $lead = BeanFactory::newBean('Leads');
        $prospect = BeanFactory::newBean('Prospects');

        foreach ($lead->field_defs as $field_def) {
            if (($field_def['type'] == 'relate' && empty($field_def['custom_type'])) || $field_def['type'] == 'assigned_user_name') {
                continue;
            }
            $repl_arr = EmailTemplate::add_replacement($repl_arr, $field_def, array(
                'contact_' . $field_def['name'] => '',
                'contact_account_' . $field_def['name'] => '',
            ));
        }
        foreach ($prospect->field_defs as $field_def) {
            if (($field_def['type'] == 'relate' && empty($field_def['custom_type'])) || $field_def['type'] == 'assigned_user_name') {
                continue;
            }
            $repl_arr = EmailTemplate::add_replacement($repl_arr, $field_def, array(
                'contact_' . $field_def['name'] => '',
                'contact_account_' . $field_def['name'] => '',
            ));
        }
        foreach ($contact->field_defs as $field_def) {
            if (($field_def['type'] == 'relate' && empty($field_def['custom_type'])) || $field_def['type'] == 'assigned_user_name') {
                continue;
            }
            $repl_arr = EmailTemplate::add_replacement($repl_arr, $field_def, array(
                'contact_' . $field_def['name'] => '',
                'contact_account_' . $field_def['name'] => '',
            ));
        }
        foreach ($acct->field_defs as $field_def) {
            if (($field_def['type'] == 'relate' && empty($field_def['custom_type'])) || $field_def['type'] == 'assigned_user_name') {
                continue;
            }
            $repl_arr = EmailTemplate::add_replacement($repl_arr, $field_def, array(
                'account_' . $field_def['name'] => '',
                'account_contact_' . $field_def['name'] => '',
            ));
        }
        // cn: end bug 9277 fix


        // feel for Parent account, only for Contacts traditionally, but written for future expansion
        if (isset($focus->account_id) && !empty($focus->account_id)) {
            $acct->retrieve($focus->account_id);
        }

        if ($bean_name == 'Contacts') {
            // cn: bug 9277 - email templates not loading account/opp info for templates
            if (!empty($acct->id)) {
                foreach ($acct->field_defs as $field_def) {
                    if (($field_def['type'] == 'relate' && empty($field_def['custom_type'])) || $field_def['type'] == 'assigned_user_name') {
                        continue;
                    }

                    $fieldName = $field_def['name'];
                    if ($field_def['type'] == 'enum') {
                        $translated = translate($field_def['options'], 'Accounts', $acct->$fieldName);

                        if (isset($translated) && !is_array($translated)) {
                            $repl_arr = EmailTemplate::add_replacement($repl_arr, $field_def, array(
                                'account_' . $fieldName => $translated,
                                'contact_account_' . $fieldName => $translated,
                            ));
                        } else { // unset enum field, make sure we have a match string to replace with ""
                            $repl_arr = EmailTemplate::add_replacement($repl_arr, $field_def, array(
                                'account_' . $fieldName => '',
                                'contact_account_' . $fieldName => '',
                            ));
                        }
                    } else {
                        // bug 47647 - allow for fields to translate before adding to template
                        $translated = self::_convertToType($field_def['type'], $acct->$fieldName);
                        $repl_arr = EmailTemplate::add_replacement($repl_arr, $field_def, array(
                            'account_' . $fieldName => $translated,
                            'contact_account_' . $fieldName => $translated,
                        ));
                    }
                }
            }

            if (!empty($focus->assigned_user_id)) {
                $user = BeanFactory::newBean('Users');
                $user->retrieve($focus->assigned_user_id);
                $repl_arr = EmailTemplate::_parseUserValues($repl_arr, $user);
            }
        } elseif ($bean_name == 'Users') {
            /**
             * This section of code will on do work when a blank Contact, Lead,
             * etc. is passed in to parse the contact_* vars.  At this point,
             * $current_user will be used to fill in the blanks.
             */
            $repl_arr = EmailTemplate::_parseUserValues($repl_arr, $current_user);
        } else {
            // assumed we have an Account in focus
            foreach ($contact->field_defs as $field_def) {
                if (($field_def['type'] == 'relate' && empty($field_def['custom_type'])) || $field_def['type'] == 'assigned_user_name' || $field_def['type'] == 'link') {
                    continue;
                }

                $fieldName = $field_def['name'];
                if ($field_def['type'] == 'enum') {
                    if (!isset($contact->$fieldName)) {
                        LoggerManager::getLogger()->warn('Email Template / parse template bean error: Contact field not found. Field name was: "' . $fieldName . '"');
                        $contactFieldName = null;
                    } else {
                        $contactFieldName = $contact->$fieldName;
                    }

                    $translated = translate($field_def['options'], 'Accounts', $contactFieldName);

                    if (isset($translated) && !is_array($translated)) {
                        $repl_arr = EmailTemplate::add_replacement($repl_arr, $field_def, array(
                            'contact_' . $fieldName => $translated,
                            'contact_account_' . $fieldName => $translated,
                        ));
                    } else { // unset enum field, make sure we have a match string to replace with ""
                        $repl_arr = EmailTemplate::add_replacement($repl_arr, $field_def, array(
                            'contact_' . $fieldName => '',
                            'contact_account_' . $fieldName => '',
                        ));
                    }
                } else {
                    if (isset($contact->$fieldName)) {
                        // bug 47647 - allow for fields to translate before adding to template
                        $translated = self::_convertToType($field_def['type'], $contact->$fieldName);
                        $repl_arr = EmailTemplate::add_replacement($repl_arr, $field_def, array(
                            'contact_' . $fieldName => $translated,
                            'contact_account_' . $fieldName => $translated,
                        ));
                    } // if
                }
            }
        }

        ///////////////////////////////////////////////////////////////////////
        ////	LOAD FOCUS DATA INTO REPL_ARR
        if (!isset($focus->field_defs)) {
            LoggerManager::getLogger()->warn('Email Template / parse template bean error on load focus data into repl_arr: Focus field defs is undefined.');
        } else {
            foreach ($focus->field_defs as $field_def) {
                if (!isset($field_def['name'])) {
                    LoggerManager::getLogger()->warn('Email Template / parse template bean error on load focus data into repl_arr: Focus field defs [name] is undefined.');
                }
                $fieldName = isset($field_def['name']) ? $field_def['name'] : null;
                if (isset($focus->$fieldName)) {
                    if (($field_def['type'] == 'relate' && empty($field_def['custom_type'])) || $field_def['type'] == 'assigned_user_name') {
                        continue;
                    }

                    if ($field_def['type'] == 'enum' && isset($field_def['options'])) {
                        $translated = translate($field_def['options'], $bean_name, $focus->$fieldName);

                        if (isset($translated) && !is_array($translated)) {
                            $repl_arr = EmailTemplate::add_replacement($repl_arr, $field_def, array(
                                strtolower($beanList[$bean_name]) . "_" . $fieldName => $translated,
                            ));
                        } else { // unset enum field, make sure we have a match string to replace with ""
                            $repl_arr = EmailTemplate::add_replacement($repl_arr, $field_def, array(
                                strtolower($beanList[$bean_name]) . "_" . $fieldName => '',
                            ));
                        }
                    } else {
                        // bug 47647 - translate currencies to appropriate values
                        $repl_arr = EmailTemplate::add_replacement($repl_arr, $field_def, array(
                            strtolower($beanList[$bean_name]) . "_" . $fieldName => self::_convertToType($field_def['type'], $focus->$fieldName),
                        ));
                    }
                } else {
                    if ($fieldName == 'full_name') {
                        $repl_arr = EmailTemplate::add_replacement($repl_arr, $field_def, array(
                            strtolower($beanList[$bean_name]) . '_full_name' => $focus->get_summary_text(),
                        ));
                    } else {
                        $repl_arr = EmailTemplate::add_replacement($repl_arr, $field_def, array(
                            strtolower($beanList[$bean_name]) . "_" . $fieldName => '',
                        ));
                    }
                }
            } // end foreach()
        }

        krsort($repl_arr);
        reset($repl_arr);
        //20595 add nl2br() to respect the multi-lines formatting
        if (isset($repl_arr['contact_primary_address_street'])) {
            $repl_arr['contact_primary_address_street'] = nl2br($repl_arr['contact_primary_address_street']);
        }
        if (isset($repl_arr['contact_alt_address_street'])) {
            $repl_arr['contact_alt_address_street'] = nl2br($repl_arr['contact_alt_address_street']);
        }

        foreach ($repl_arr as $name => $value) {
            if ($value != '' && is_string($value)) {
                $string = str_replace("\$$name", $value, $string);
            } else {
                $string = str_replace("\$$name", ' ', $string);
            }
        }

        return $string;
    }

    /**
     * Add replacement(s) to the collection based on field definition
     *
     * @param array $data
     * @param array $field_def
     * @param array $replacement
     * @return array
     */
    protected static function add_replacement($data, $field_def, $replacement)
    {
        foreach ($replacement as $key => $value) {
            // @see defect #48641
            if ('multienum' == $field_def['type']) {
                $mVals = unencodeMultienum($value);
                $translatedVals = array();
                foreach ($mVals as $mVal) {
                    $translatedVals[] = translate($field_def['options'], '', $mVal);
                }
                if (isset($translatedVals[0]) && is_array($translatedVals[0])) {
                    $value = implode(", ", $translatedVals[0]);
                } else {
                    $value = implode(", ", $translatedVals);
                }
            }
            $data[$key] = $value;
        }

        return $data;
    }

    public function parse_template($string, &$bean_arr)
    {
        foreach ($bean_arr as $bean_name => $bean_id) {
            $focus = BeanFactory::getBean($bean_name, $bean_id);
            if ($focus && $bean_id && !$focus->fetched_row) {
                // We do not want the cached version for a newly created bean, as some data such as date fields and
                // auto increment fields will only be correct after a retrieve operation
                BeanFactory::unregisterBean($focus->module_dir, $focus->id);
                $focus = BeanFactory::getBean($bean_name, $bean_id);
            }

            if ($bean_name == 'Leads' || $bean_name == 'Prospects') {
                $bean_name = 'Contacts';
            }

            if (isset($this) && isset($this->module_dir) && $this->module_dir == 'EmailTemplates') {
                $string = $this->parse_template_bean($string, $bean_name, $focus);
            } else {
                $string = EmailTemplate::parse_template_bean($string, $bean_name, $focus);
            }
        }
        return $string;
    }

    public function bean_implements($interface)
    {
        switch ($interface) {
            case 'ACL':
                return true;
        }
        return false;
    }

    public static function getTypeOptionsForSearch()
    {
        $template = BeanFactory::newBean('EmailTemplates');
        $optionKey = $template->field_defs['type']['options'];
        $options = $GLOBALS['app_list_strings'][$optionKey];
        if (!is_admin($GLOBALS['current_user']) && isset($options['workflow'])) {
            unset($options['workflow']);
        }

        return $options;
    }

    public function is_used_by_email_marketing()
    {
        $query = "select id from email_marketing where template_id='$this->id' and deleted=0";
        $result = $this->db->query($query);
        if ($this->db->fetchByAssoc($result)) {
            return true;
        }
        return false;
    }

    /**
     * Allows us to save variables of template as they are
     */
    public function cleanBean()
    {
        $this->storedVariables = array();
        $this->body_html = preg_replace_callback('/\{::[^}]+::\}/', array($this, 'storeVariables'), $this->body_html);
        parent::cleanBean();
        $this->body_html = str_replace(array_values($this->storedVariables), array_keys($this->storedVariables), $this->body_html);
    }

    /**
     * Replacing variables of templates by their md5 hash
     *
     * @param array $text result of preg_replace_callback
     * @return string md5 hash of result
     */
    protected function storeVariables($text)
    {
        if (isset($this->storedVariables[$text[0]]) == false) {
            $this->storedVariables[$text[0]] = md5($text[0]);
        }
        return $this->storedVariables[$text[0]];
    }

    public function save($check_notify = false)
    {
        $this->repairMozaikClears();
        return parent::save($check_notify);
    }

    public function retrieve($id = -1, $encode = true, $deleted = true)
    {
        $ret = parent::retrieve($id, $encode, $deleted);
        $this->repairMozaikClears();
        $this->imageLinkReplaced = false;
        $this->repairEntryPointImages();
        if ($this->imageLinkReplaced) {
            $this->save();
        }
        $this->addDomainToRelativeImagesSrc();
        return $ret;
    }

    public function addDomainToRelativeImagesSrc()
    {
        global $sugar_config;
        $domain = $sugar_config['site_url'] . '/';
        $ret = $this->body_html = preg_replace('/(src=&quot;)(public\/[^.]*.(jpg|jpeg|png|gif|bmp))(&quot;)/', "$1" . $domain . "$2$4", $this->body_html);
        return $ret;
    }

    private function repairMozaikClears()
    {
        // repair tinymce auto correction in mozaik clears
        $this->body_html = str_replace('&lt;div class=&quot;mozaik-clear&quot;&gt;&nbsp;&lt;br&gt;&lt;/div&gt;', '&lt;div class=&quot;mozaik-clear&quot;&gt;&lt;/div&gt;', $this->body_html);
    }



    private function repairEntryPointImages()
    {
        global $sugar_config, $log;

        // repair the images url at entry points, change to a public direct link for remote email clients..

        $html = from_html($this->body_html);
        $siteUrl = $sugar_config['site_url'];
        $regex = '#<img[^>]*[\s]+src=[\s]*["\'](' . preg_quote($siteUrl) . '\/index\.php\?entryPoint=download&type=Notes&id=([a-f0-9]{8}\-[a-f0-9]{4}\-[a-f0-9]{4}\-[a-f0-9]{4}\-[a-f0-9]{12})&filename=.+?)["\']#si';

        if (preg_match($regex, $html, $match)) {

            $splits = explode('.', $match[1]);

            $fileExtension = end($splits);

            $toFile = $match[2] . '.' . $fileExtension;
            if (is_string($toFile) && !has_valid_image_extension('repair-entrypoint-images-fileext', $toFile)){
                $log->error("repairEntryPointImages | file with invalid extension '$toFile'");
                return;
            }

            $this->makePublicImage($match[2], $fileExtension);
            $newSrc = $sugar_config['site_url'] . '/public/' . $match[2] . '.' . $fileExtension;
            $this->body_html = to_html(str_replace($match[1], $newSrc, $html));
            $this->imageLinkReplaced = true;
            $this->repairEntryPointImages();
        }
    }

    private function makePublicImage($id, $ext = 'jpg')
    {
        $toFile = 'public/' . $id . '.' . $ext;
        if (file_exists($toFile)) {
            return;
        }
        $fromFile = 'upload://' . $id;
        if (!file_exists($fromFile)) {
            throw new Exception('file not found');
        }
        if (!file_exists('public')) {
            sugar_mkdir('public', 0777);
        }
        $fdata = file_get_contents($fromFile);
        if (!file_put_contents($toFile, $fdata)) {
            throw new Exception('file write error');
        }
    }

    public function getAttachments()
    {
        return BeanFactory::getBean('Notes')->get_full_list('', "parent_id = '" . $this->id . "'");
    }
}