eventmessagecompiler.php

См. документацию.

<?php

 
namespace Bitrix\Main\Mail;
 
use Bitrix\Main\Localization\Loc;
use Bitrix\Main\Mail\Internal as MailInternal;
use Bitrix\Main\Config as Config;
 
class EventMessageCompiler
{
    protected $mailTo;
    protected $mailHeaders;
    protected $mailSubject;
    protected $mailBody;
    protected $mailCharset;
    protected $mailId;
    protected $mailContentType;
    protected $mailAttachment;
    protected $eventMessageId = null;
    protected $event = [];
    protected $eventMessageFields;
    protected $eventFields;
    protected $siteFields;
    protected $siteId;
    protected $languageId;
    protected $eventSiteFields;
 
    /*
     *  'MESSAGE' = array(
            'BODY_TYPE' => 'html',
            'SUBJECT' => '',
            'EMAIL_TO' => '',
            'EMAIL_FROM' => '',
            'MESSAGE' => '',
            'ID' => '',
            'DATE_INSERT' => '',
            'SITE_TEMPLATE_ID' => '',
            'BCC' => '',
            'CC' => '',
            'REPLY_TO' => '',
            'IN_REPLY_TO' => '',
            'PRIORITY' => '',
            'ADDITIONAL_FIELD' => array(),
            'FILE' => array(),
        )
     */
    public function __construct(array $arMessageParams)
    {
        if (!array_key_exists('FIELDS', $arMessageParams))
        {
            throw new \Bitrix\Main\ArgumentTypeException("FIELDS");
        }
        if (!array_key_exists('MESSAGE', $arMessageParams))
        {
            throw new \Bitrix\Main\ArgumentTypeException("MESSAGE");
        }
        if (!array_key_exists('SITE', $arMessageParams))
        {
            throw new \Bitrix\Main\ArgumentTypeException("SITE");
        }
        if (!array_key_exists('CHARSET', $arMessageParams))
        {
            throw new \Bitrix\Main\ArgumentTypeException("CHARSET");
        }
 
        $this->eventFields = $arMessageParams['FIELDS'];
        if (array_key_exists('EVENT', $arMessageParams))
        {
            $this->event = $arMessageParams['EVENT'];
            $this->languageId = $this->event['LANGUAGE_ID'] ?? null;
        }
 
        $this->eventMessageFields = $arMessageParams['MESSAGE'];
        if (array_key_exists('ID', $arMessageParams['MESSAGE']))
        {
            $this->eventMessageId = $arMessageParams['MESSAGE']['ID'];
        }
 
        $this->siteFields = $this->getSiteFieldsArray(
            is_array($arMessageParams['SITE'])
                ? $arMessageParams['SITE']
                : [$arMessageParams['SITE']]
        );
        $this->eventSiteFields = array_merge($this->siteFields, $this->eventFields);
        foreach ($this->eventSiteFields as $k => $v)
        {
            $this->eventSiteFields[$k] = static::getFieldFlatValue($v);
        }
        $this->setMailCharset($arMessageParams['CHARSET']);
    }

    public static function createInstance(array $arMessageParams)
    {
        return new static($arMessageParams);
    }

    public function compile()
    {
        $this->setMailHeaders();
 
        $this->setMailId();
        $this->setMailContentType();
 
        $this->setMailTo();
        $this->setMailSubject();
        $this->setMailBody();
        $this->setMailAttachment();
    }

    protected function setMailBody()
    {
        $isHtml = $this->eventMessageFields["BODY_TYPE"] == "html";
 
        // replace placeholders in body
        $message = $this->eventMessageFields["MESSAGE_PHP"];
        if (empty($message) && !empty($this->eventMessageFields["MESSAGE"]))
        {
            $message = MailInternal\EventMessageTable::replaceTemplateToPhp($this->eventMessageFields["MESSAGE"]);
            if ($this->eventMessageFields["ID"] > 0)
            {
                MailInternal\EventMessageTable::update($this->eventMessageFields["ID"], ['MESSAGE_PHP' => $message]);
            }
        }
 
        if (!empty($this->eventMessageFields['SITE_TEMPLATE_ID']))
        {
            $siteTemplateId = $this->eventMessageFields['SITE_TEMPLATE_ID'];
        }
        else
        {
            $siteTemplateId = null;
        }
 
        $themeCompiler = EventMessageThemeCompiler::createInstance($siteTemplateId, $message, $isHtml);
 
        if (empty($siteTemplateId))
        {
            $siteTemplateId = ".default";
        }
 
        // set context variables for components
        $themeCompiler->setSiteTemplateId($siteTemplateId);
        $themeCompiler->setSiteId($this->siteId);
        $themeCompiler->setLanguageId($this->languageId);
        Loc::setCurrentLang($themeCompiler->getLanguageId());
 
        // set values of $arParams, used by components
        $eventSiteFields = $this->eventSiteFields;
        if ($isHtml)
        {
            foreach ($this->eventSiteFields as $fieldKey => $fieldValue)
            {
                $eventSiteFields["HTML_" . $fieldKey] = nl2br(htmlspecialcharsbx($fieldValue, ENT_COMPAT, false));
 
                if (!str_contains($fieldValue, "<"))
                {
                    $eventSiteFields[$fieldKey] = nl2br($fieldValue);
                }
            }
        }
        $eventSiteFields['MAIL_EVENTS_UNSUBSCRIBE_LINK'] = Tracking::getLinkUnsub(
            'main',
            [
                'CODE' => mb_strtolower(trim(explode(',', $this->getMailTo())[0])),
                'EVENT_NAME' => $this->eventMessageFields["EVENT_NAME"],
            ]
        );
        $themeCompiler->setParams($eventSiteFields);
        // eval site template and body
        $themeCompiler->execute();
        // get eval result of site template and body
        $message = $themeCompiler->getResult();
 
        $this->mailBody = $message;
 
        Loc::setCurrentLang(null);
        EventMessageThemeCompiler::unsetInstance();
    }

    public function getMailBody()
    {
        return $this->mailBody;
    }

    protected function setMailCharset($mailCharset)
    {
        $this->mailCharset = $mailCharset;
    }

    public function getMailCharset()
    {
        return $this->mailCharset;
    }

    protected function setMailContentType()
    {
        $this->mailContentType = $this->eventMessageFields["BODY_TYPE"];
    }

    public function getMailContentType()
    {
        return $this->mailContentType;
    }
 
    protected function setMailAttachment()
    {
        $eventMessageAttachment = [];
        $eventFilesContent = [];
 
        // Attach files from message template
        if (array_key_exists('FILE', $this->eventMessageFields))
        {
            $eventMessageAttachment = $this->eventMessageFields["FILE"];
        }
 
        if (array_key_exists('FILES_CONTENT', $this->event))
        {
            $eventFilesContent = $this->event["FILES_CONTENT"];
        }
 
        // Attach files from event
        if (isset($this->event["FILE"]) && is_array($this->event["FILE"]))
        {
            $eventFileList = [];
            foreach ($this->event["FILE"] as $fileId)
            {
                if (is_numeric($fileId))
                {
                    $eventFileList[] = $fileId;
                }
            }
 
            $eventMessageAttachment = array_merge($eventMessageAttachment, $eventFileList);
        }
 
        if (!empty($eventMessageAttachment))
        {
            $attachFileList = [];
            $eventMessageAttachment = array_unique($eventMessageAttachment);
 
            $strId = implode(',', $eventMessageAttachment);
            $conn = \Bitrix\Main\Application::getConnection();
            $strSql = "SELECT * FROM b_file WHERE ID IN(" . $strId . ")";
            $resultDb = $conn->query($strSql);
            while ($file = $resultDb->fetch())
            {
                $tempFile = \CFile::MakeFileArray($file["ID"]);
                $attachFileList[] = [
                    'PATH' => $tempFile['tmp_name'],
                    'ID' => $file['ID'],
                    'CONTENT_TYPE' => $file['CONTENT_TYPE'],
                    'NAME' => ($file['ORIGINAL_NAME'] <> "" ? $file['ORIGINAL_NAME'] : $file['FILE_NAME']),
                ];
            }
 
            $this->mailAttachment = $attachFileList;
        }
 
        if (!empty($eventFilesContent))
        {
            foreach ($eventFilesContent as $item)
            {
                $this->mailAttachment[] = [
                    'CONTENT_TYPE' => $item['CONTENT_TYPE'],
                    'NAME' => $item['NAME'],
                    'CONTENT' => $item['CONTENT'],
                    'ID' => $item['ID'],
                    'CHARSET' => $item['CHARSET'],
                    'METHOD' => $item['METHOD'],
                ];
            }
        }
    }

    public function getMailAttachment()
    {
        return $this->mailAttachment;
    }

    protected function setMailHeaders()
    {
        $arMailFields = [];
        $messageFields = $this->eventMessageFields;
        $arFields = $this->eventFields + $this->siteFields;
 
        $arMailFields["From"] = $this->replaceTemplate($messageFields["EMAIL_FROM"], $arFields);
 
        if (isset($messageFields["BCC"]) && $messageFields["BCC"] != '')
        {
            $bcc = $this->replaceTemplate($messageFields["BCC"], $arFields);
            if (str_contains($bcc, "@"))
            {
                $arMailFields["BCC"] = $bcc;
            }
        }
 
        if (isset($messageFields["CC"]) && $messageFields["CC"] != '')
        {
            $arMailFields["CC"] = $this->replaceTemplate($messageFields["CC"], $arFields);
        }
 
        if (isset($messageFields["REPLY_TO"]) && $messageFields["REPLY_TO"] != '')
        {
            $arMailFields["Reply-To"] = $this->replaceTemplate($messageFields["REPLY_TO"], $arFields);
        }
        else
        {
            $arMailFields["Reply-To"] = preg_replace("/(.*)\\<(.*)\\>/i", '$2', $arMailFields["From"]);
        }
 
        if (isset($messageFields["IN_REPLY_TO"]) && $messageFields["IN_REPLY_TO"] != '')
        {
            $arMailFields["In-Reply-To"] = $this->replaceTemplate($messageFields["IN_REPLY_TO"], $arFields);
        }
 
        if (isset($messageFields["ADDITIONAL_FIELD"]) && is_array($messageFields['ADDITIONAL_FIELD']))
        {
            foreach ($messageFields['ADDITIONAL_FIELD'] as $additionalField)
            {
                $arMailFields[$additionalField['NAME']] = static::replaceTemplate($additionalField['VALUE'], $arFields);
            }
        }
 
        if (isset($messageFields["PRIORITY"]) && $messageFields["PRIORITY"] != '')
        {
            $arMailFields["X-Priority"] = $this->replaceTemplate($messageFields["PRIORITY"], $arFields);
        }
 
        foreach ($arFields as $f => $v)
        {
            if (str_starts_with($f, "="))
            {
                $arMailFields[substr($f, 1)] = $v;
            }
        }
 
        foreach ($arMailFields as $k => $v)
        {
            $arMailFields[$k] = trim($v, "\r\n");
        }
 
        //add those who want to receive all emails
        if (isset($this->event["DUPLICATE"]) && $this->event["DUPLICATE"] == "Y")
        {
            $all_bcc = Config\Option::get("main", "all_bcc");
            if (str_contains($all_bcc, "@"))
            {
                $arMailFields["BCC"] .= ($all_bcc <> '' ? ($arMailFields["BCC"] <> '' ? "," : "") . $all_bcc : "");
            }
        }
 
        if (isset($this->event["EVENT_NAME"]))
        {
            $arMailFields['X-EVENT_NAME'] = $this->event["EVENT_NAME"];
        }
 
        $this->mailHeaders = $arMailFields;
    }

    public function getMailHeaders()
    {
        return $this->mailHeaders;
    }

    protected function setMailId()
    {
        if (isset($this->event['ID']) && isset($this->eventMessageFields["ID"]))
        {
            $this->mailId = $this->event['ID'] . "." . $this->eventMessageFields["ID"] . " (" . $this->event["DATE_INSERT"] . ")";
        }
        else
        {
            $this->mailId = '';
        }
    }

    public function getMailId()
    {
        return $this->mailId;
    }

    protected function setMailSubject()
    {
        $this->mailSubject = $this->replaceTemplate($this->eventMessageFields["SUBJECT"], $this->eventSiteFields);
    }

    public function getMailSubject()
    {
        return $this->mailSubject;
    }

    protected function setMailTo()
    {
        $this->mailTo = $this->replaceTemplate($this->eventMessageFields["EMAIL_TO"], $this->eventSiteFields);
    }

    public function getMailTo()
    {
        return $this->mailTo;
    }

    protected function replaceTemplate($str, $ar, $bNewLineToBreak = false)
    {
        $str = str_replace("%", "%2", $str);
 
        foreach ($ar as $key => $val)
        {
            if (is_array($val))
            {
                $val = implode(', ', $val);
            }
 
            if ($bNewLineToBreak && !str_contains($val, "<"))
            {
                $val = nl2br($val);
            }
 
            $val = str_replace("%", "%2", $val);
            $val = str_replace("#", "%1", $val);
            $str = str_replace("#" . $key . "#", $val, $str);
        }
 
        $str = str_replace("%1", "#", $str);
        $str = str_replace("%2", "%", $str);
 
        return $str;
    }

    protected function getSiteFieldsArray($sites)
    {
        $site_id = $sites[0];
 
        if (!empty($this->eventMessageId))
        {
            $messageSiteDb = MailInternal\EventMessageSiteTable::getList([
                'select' => ['SITE_ID'],
                'filter' => [
                    '=EVENT_MESSAGE_ID' => $this->eventMessageId,
                    '=SITE_ID' => $sites,
                ],
            ]);
            if ($arMessageSite = $messageSiteDb->Fetch())
            {
                $site_id = $arMessageSite['SITE_ID'];
            }
        }
 
        $globalName = $GLOBALS["SERVER_NAME"] ?? '';
        $SITE_NAME = Config\Option::get("main", "site_name", $globalName);
        $SERVER_NAME = Config\Option::get("main", "server_name", $globalName);
        $DEFAULT_EMAIL_FROM = Config\Option::get("main", "email_from", "admin@" . $globalName);
 
        if ($site_id <> '')
        {
            $result = \Bitrix\Main\SiteTable::getById($site_id);
            if ($arSite = $result->fetch())
            {
                $this->siteId = $arSite['LID'];
                if ($this->languageId === null)
                {
                    $this->languageId = $arSite['LANGUAGE_ID'];
                }
 
                \CEvent::$EVENT_SITE_PARAMS[$site_id] = [
                    "SITE_NAME" => ($arSite["SITE_NAME"] <> '' ? $arSite["SITE_NAME"] : $SITE_NAME),
                    "SERVER_NAME" => ($arSite["SERVER_NAME"] <> '' ? $arSite["SERVER_NAME"] : $SERVER_NAME),
                    "DEFAULT_EMAIL_FROM" => ($arSite["EMAIL"] <> '' ? $arSite["EMAIL"] : $DEFAULT_EMAIL_FROM),
                    "LANGUAGE_ID" => $arSite['LANGUAGE_ID'],
                    "SITE_ID" => $arSite['LID'],
                    "SITE_DIR" => $arSite['DIR'],
                ];
                return \CEvent::$EVENT_SITE_PARAMS[$site_id];
            }
        }
 
        return [
            "SITE_NAME" => $SITE_NAME,
            "SERVER_NAME" => $SERVER_NAME,
            "DEFAULT_EMAIL_FROM" => $DEFAULT_EMAIL_FROM,
        ];
    }

    protected static function getFieldFlatValue($value)
    {
        $flatValue = '';
        if (is_array($value))
        {
            foreach ($value as $v)
            {
                $flatValue .= ($flatValue <> '' ? ', ' : '') . static::getFieldFlatValue($v);
            }
        }
        else
        {
            $flatValue = $value;
        }
 
        return $flatValue;
    }

    public function toString()
    {
        $result = '';
        $delimeter = str_repeat('-', 5);
 
        $result .= $delimeter . "CHARSET" . $delimeter . "\n" . $this->getMailCharset() . "\n\n";
        $result .= $delimeter . "CONTENT_TYPE" . $delimeter . "\n" . $this->getMailContentType() . "\n\n";
        $result .= $delimeter . "MESSAGE_ID" . $delimeter . "\n" . $this->getMailId() . "\n\n";
        $result .= $delimeter . "TO" . $delimeter . "\n" . $this->getMailTo() . "\n\n";
        $result .= $delimeter . "SUBJECT" . $delimeter . "\n" . $this->getMailSubject() . "\n\n";
        $result .= $delimeter . "HEADERS" . $delimeter . "\n" . print_r($this->getMailHeaders(), true) . "\n\n";
        $result .= $delimeter . "BODY" . $delimeter . "\n" . $this->getMailBody() . "\n\n";
        $result .= $delimeter . "ATTACHMENT" . $delimeter . "\n" . print_r($this->getMailAttachment(), true) . "\n\n";
 
        return $result;
    }
}