Mods-for-HESK-Netsyms/api/BusinessLogic/Emails/EmailTemplateParser.php

<?php

namespace BusinessLogic\Emails;


use BusinessLogic\Exceptions\EmailTemplateNotFoundException;
use BusinessLogic\Exceptions\InvalidEmailTemplateException;
use BusinessLogic\Security\UserContext;
use BusinessLogic\Statuses\DefaultStatusForAction;
use BusinessLogic\Tickets\Ticket;
use Core\Constants\Priority;
use DataAccess\Categories\CategoryGateway;
use DataAccess\Logging\LoggingGateway;
use DataAccess\Security\UserGateway;
use DataAccess\Statuses\StatusGateway;

class EmailTemplateParser extends \BaseClass {

    /**
     * @var $statusGateway StatusGateway
     */
    private $statusGateway;

    /**
     * @var $categoryGateway CategoryGateway
     */
    private $categoryGateway;

    /**
     * @var $userGateway UserGateway
     */
    private $userGateway;

    /**
     * @var $emailTemplateRetriever EmailTemplateRetriever
     */
    private $emailTemplateRetriever;

    /**
     * @var $logger LoggingGateway
     */
    private $logger;

    function __construct(StatusGateway $statusGateway,
                         CategoryGateway $categoryGateway,
                         UserGateway $userGateway,
                         EmailTemplateRetriever $emailTemplateRetriever,
                         LoggingGateway $loggingGateway) {
        $this->statusGateway = $statusGateway;
        $this->categoryGateway = $categoryGateway;
        $this->userGateway = $userGateway;
        $this->emailTemplateRetriever = $emailTemplateRetriever;
        $this->logger = $loggingGateway;
    }

    /**
     * @param $templateId int
     * @param $languageCode string
     * @param $ticket Ticket
     * @param $heskSettings array
     * @param $modsForHeskSettings array
     * @return ParsedEmailProperties
     * @throws InvalidEmailTemplateException
     * @throws \Exception
     */
    function getFormattedEmailForLanguage($templateId, $languageCode, $ticket, $heskSettings, $modsForHeskSettings) {
        global $hesklang;

        $emailTemplate = $this->emailTemplateRetriever->getTemplate($templateId);

        if ($emailTemplate === null) {
            throw new InvalidEmailTemplateException($templateId);
        }

        $template = self::getFromFileSystem($emailTemplate->fileName, $languageCode, false);
        $htmlTemplate = self::getFromFileSystem($emailTemplate->fileName, $languageCode, true);
        $subject = $hesklang[$emailTemplate->languageKey];

        $fullLanguageName = null;
        foreach ($heskSettings['languages'] as $key => $value) {
            if ($value['folder'] === $languageCode) {
                $fullLanguageName = $key;
                break;
            }
        }

        if ($fullLanguageName === null) {
            throw new \BaseException("Language code {$languageCode} did not return any valid HESK languages!");
        }

        $subject = $this->parseSubject($subject, $ticket, $fullLanguageName, $heskSettings, $modsForHeskSettings);
        $message = $this->parseMessage($template, $ticket, $fullLanguageName, $emailTemplate->forStaff, $heskSettings, $modsForHeskSettings, false);
        $htmlMessage = $this->parseMessage($htmlTemplate, $ticket, $fullLanguageName, $emailTemplate->forStaff, $heskSettings, $modsForHeskSettings, true);

        return new ParsedEmailProperties($subject, $message, $htmlMessage);
    }

    /**
     * @param $template string
     * @param $language string
     * @param $html bool
     * @return string The template
     * @throws EmailTemplateNotFoundException If the template was not found in the filesystem for the provided language
     */
    private function getFromFileSystem($template, $language, $html)
    {
        $htmlFolder = $html ? 'html/' : '';

        /* Get email template */
        $file = "language/{$language}/emails/{$htmlFolder}{$template}.txt";
        $absoluteFilePath = __DIR__ . '/../../../' . $file;

        if (file_exists($absoluteFilePath)) {
            return file_get_contents($absoluteFilePath);
        } else {
            throw new EmailTemplateNotFoundException($template, $language);
        }
    }

    /**
     * @param $subjectTemplate string
     * @param $ticket Ticket
     * @param $language string
     * @param $heskSettings array
     * @return string
     * @throws \Exception if common.inc.php isn't loaded
     */
    private function parseSubject($subjectTemplate, $ticket, $language, $heskSettings, $modsForHeskSettings) {
        global $hesklang;

        if (!function_exists('hesk_msgToPlain')) {
            throw new \BaseException("common.inc.php not loaded!");
        }

        if ($ticket === null) {
            return $subjectTemplate;
        }

        // Status name and category name
        $defaultStatus = $this->statusGateway->getStatusForDefaultAction(DefaultStatusForAction::NEW_TICKET, $heskSettings);

        if (key_exists($language, $defaultStatus->localizedNames)) {
            $statusName = $defaultStatus->localizedNames[$language];
        } elseif (key_exists('English', $defaultStatus->localizedNames)) {
            $statusName = $defaultStatus->localizedNames['English'];
            $this->logger->logWarning('EmailTemplateParser', "No localized status found for status '{$defaultStatus->id}' and language '{$language}'. Defaulted to English.", "", new UserContext(), $heskSettings);
        } else {
            $statusName = "[ERROR: No localized status found for status '{$defaultStatus->id}']";
            $this->logger->logError('EmailTemplateParser', "No localized status found for status '{$defaultStatus->id}'", "",  new UserContext(), $heskSettings);
        }

        $categories = $this->categoryGateway->getAllCategories($heskSettings, $modsForHeskSettings);
        $category = null;
        foreach ($categories as $innerCategory) {
            if ($innerCategory->id === $ticket->categoryId) {
                $category = $innerCategory;
                break;
            }
        }

        switch ($ticket->priorityId) {
            case Priority::CRITICAL:
                $priority = $hesklang['critical'];
                break;
            case Priority::HIGH:
                $priority = $hesklang['high'];
                break;
            case Priority::MEDIUM:
                $priority = $hesklang['medium'];
                break;
            case Priority::LOW:
                $priority = $hesklang['low'];
                break;
            default:
                $priority = 'PRIORITY NOT FOUND';
                break;
        }

        // Special tags
        $subject = str_replace('%%SUBJECT%%', $ticket->subject, $subjectTemplate);
        $subject = str_replace('%%TRACK_ID%%', $ticket->trackingId, $subject);
        $subject = str_replace('%%CATEGORY%%', $category->id, $subject);
        $subject = str_replace('%%PRIORITY%%', $priority, $subject);
        $subject = str_replace('%%STATUS%%', $statusName, $subject);

        return $subject;
    }

    /**
     * @param $messageTemplate string
     * @param $ticket Ticket
     * @param $language string
     * @param $heskSettings array
     * @return string
     * @throws \Exception if common.inc.php isn't loaded
     */
    private function parseMessage($messageTemplate, $ticket, $language, $admin, $heskSettings, $modsForHeskSettings, $html) {
        global $hesklang;

        if (!function_exists('hesk_msgToPlain')) {
            throw new \BaseException("common.inc.php not loaded!");
        }

        if ($ticket === null) {
            return $messageTemplate;
        }

        $heskSettings['site_title'] = hesk_msgToPlain($heskSettings['site_title'], 1);

        // Is email required to view ticket (for customers only)?
        $heskSettings['e_param'] = $heskSettings['email_view_ticket'] ? '&e=' . rawurlencode(implode(';', $ticket->email)) : '';

        /* Generate the ticket URLs */
        $trackingURL = $heskSettings['hesk_url'];
        $trackingURL .= $admin ? '/' . $heskSettings['admin_dir'] . '/admin_ticket.php' : '/ticket.php';
        $trackingURL .= '?track=' . $ticket->trackingId . ($admin ? '' : $heskSettings['e_param']) . '&Refresh=' . rand(10000, 99999);

        // Status name and category name
        $defaultStatus = $this->statusGateway->getStatusForDefaultAction(DefaultStatusForAction::NEW_TICKET, $heskSettings);
        $statusName = hesk_msgToPlain($defaultStatus->localizedNames[$language]);

        $categories = $this->categoryGateway->getAllCategories($heskSettings, $modsForHeskSettings);
        $category = null;
        foreach ($categories as $innerCategory) {
            if ($innerCategory->id === $ticket->categoryId) {
                $category = $innerCategory;
                break;
            }
        }

        $category = hesk_msgToPlain($category->name);
        $owner = $this->userGateway->getUserById($ticket->ownerId, $heskSettings);

        $ownerName = $owner === null ? $hesklang['unas'] : hesk_msgToPlain($owner->name);

        switch ($ticket->priorityId) {
            case Priority::CRITICAL:
                $priority = $hesklang['critical'];
                break;
            case Priority::HIGH:
                $priority = $hesklang['high'];
                break;
            case Priority::MEDIUM:
                $priority = $hesklang['medium'];
                break;
            case Priority::LOW:
                $priority = $hesklang['low'];
                break;
            default:
                $priority = 'PRIORITY NOT FOUND';
                break;
        }

        // Special tags
        $msg = str_replace('%%NAME%%', $ticket->name, $messageTemplate);
        $msg = str_replace('%%SUBJECT%%', $ticket->subject, $msg);
        $msg = str_replace('%%TRACK_ID%%', $ticket->trackingId, $msg);
        $msg = str_replace('%%TRACK_URL%%', $trackingURL, $msg);
        $msg = str_replace('%%SITE_TITLE%%', $heskSettings['site_title'], $msg);
        $msg = str_replace('%%SITE_URL%%', $heskSettings['site_url'], $msg);
        $msg = str_replace('%%CATEGORY%%', $category, $msg);
        $msg = str_replace('%%PRIORITY%%', $priority, $msg);
        $msg = str_replace('%%OWNER%%', $ownerName, $msg);
        $msg = str_replace('%%STATUS%%', $statusName, $msg);
        $msg = str_replace('%%EMAIL%%', implode(';', $ticket->email), $msg);
        $msg = str_replace('%%CREATED%%', $ticket->dateCreated, $msg);
        $msg = str_replace('%%UPDATED%%', $ticket->lastChanged, $msg);
        $msg = str_replace('%%ID%%', $ticket->id, $msg);
        $msg = str_replace('%%TIME_WORKED%%', $ticket->timeWorked, $msg);

        $lastReplyBy = '';
        // Get the last reply by
        if (!empty($ticket->lastReplier)) {
            $lastReplyBy = $ticket->lastReplier;
        } else {
            $lastReplyBy = $ticket->name;
        }

        $msg = str_replace('%%LAST_REPLY_BY%%', $lastReplyBy, $msg);

        /* All custom fields */
        for ($i=1; $i<=50; $i++) {
            $k = 'custom'.$i;

            if (isset($heskSettings['custom_fields'][$k]) && isset($ticket->customFields[$i])) {
                $v = $heskSettings['custom_fields'][$k];

                switch ($v['type']) {
                    case 'checkbox':
                        $ticket->customFields[$i] = str_replace("<br>","\n",$ticket->customFields[$i]);
                        break;
                    case 'date':
                        $ticket->customFields[$i] = hesk_custom_date_display_format($ticket->customFields[$i], $v['value']['date_format']);
                        break;
                }

                $msg = str_replace('%%'.strtoupper($k).'%%',stripslashes($ticket->customFields[$i]),$msg);
            } else {
                $msg = str_replace('%%'.strtoupper($k).'%%','',$msg);
            }
        }

        // Is message tag in email template?
        if (strpos($msg, '%%MESSAGE%%') !== false) {
            // Replace message
            if ($html) {
                $htmlMessage = html_entity_decode($ticket->message);
                $htmlMessage = nl2br($htmlMessage);
                $msg = str_replace('%%MESSAGE%%', $htmlMessage, $msg);
            } else {
                $plainTextMessage = $ticket->message;

                $messageHtml = $ticket->usesHtml;

                if (count($ticket->replies) > 0) {
                    $lastReply = end($ticket->replies);
                    $messageHtml = $lastReply->usesHtml;
                }

                if ($messageHtml) {
                    if (!function_exists('convert_html_to_text')) {
                        require(__DIR__ . '/../../../inc/html2text/html2text.php');
                    }
                    $plainTextMessage = convert_html_to_text($plainTextMessage);
                    $plainTextMessage = fix_newlines($plainTextMessage);
                }
                $msg = str_replace('%%MESSAGE%%', $plainTextMessage, $msg);
            }

            // Add direct links to any attachments at the bottom of the email message
            if ($heskSettings['attachments']['use'] && isset($ticket->attachments) && count($ticket->attachments) > 0) {
                if (!$modsForHeskSettings['attachments']) {
                    if ($html) {
                        $msg .= "<br><br><br>" . $hesklang['fatt'];
                    } else {
                        $msg .= "\n\n\n" . $hesklang['fatt'];
                    }

                    foreach ($ticket->attachments as $attachment) {
                        if ($html) {
                            $msg .= "<br><br>{$attachment->fileName}<br>";
                        } else {
                            $msg .= "\n\n{$attachment->fileName}\n";
                        }

                        $msg .= "{$heskSettings['hesk_url']}/download_attachment.php?att_id={$attachment->id}&track={$ticket->trackingId}{$heskSettings['e_param']}";
                    }
                }
            }

            // For customer notifications: if we allow email piping/pop 3 fetching and
            // stripping quoted replies add an "reply above this line" tag
            if (!$admin && ($heskSettings['email_piping'] || $heskSettings['pop3']) && $heskSettings['strip_quoted']) {
                $msg = $hesklang['EMAIL_HR'] . "\n\n" . $msg;
            }
        } elseif (strpos($msg, '%%MESSAGE_NO_ATTACHMENTS%%') !== false) {
            if ($html) {
                $htmlMessage = nl2br($ticket->message);
                $msg = str_replace('%%MESSAGE_NO_ATTACHMENTS%%', $htmlMessage, $msg);
            } else {
                $plainTextMessage = $ticket->message;

                $messageHtml = $ticket->usesHtml;

                if (count($ticket->replies) > 0) {
                    $lastReply = end($ticket->replies);
                    $messageHtml = $lastReply->usesHtml;
                }

                if ($messageHtml) {
                    if (!function_exists('convert_html_to_text')) {
                        require(__DIR__ . '/../../../inc/html2text/html2text.php');
                    }
                    $plainTextMessage = convert_html_to_text($plainTextMessage);
                    $plainTextMessage = fix_newlines($plainTextMessage);
                }
                $msg = str_replace('%%MESSAGE_NO_ATTACHMENTS%%', $plainTextMessage, $msg);
            }
        }

        return $msg;
    }
}