MailTemplate.inc.php

<?php
 
import('lib.pkp.classes.mail.Mail');
 
define('MAIL_ERROR_INVALID_EMAIL', 0x000001);
 
class MailTemplate extends Mail {
   var $context;
 
   var $includeSignature;
 
   var $emailKey;
 
   var $locale;
 
   var $enabled;
 
   var $errorMessages;
 
   var $bccSender;
 
   var $addressFieldsEnabled;
 
   var $params;
 
   function __construct($emailKey = null, $locale = null, $context = null, $includeSignature = true) {
      parent::__construct();
      $this->emailKey = isset($emailKey) ? $emailKey : null;
 
      // If a context wasn't specified, use the current request.
      $request = Application::get()->getRequest();
      if ($context === null) $context = $request->getContext();
 
      $this->includeSignature = $includeSignature;
      // Use current user's locale if none specified
      $this->locale = isset($locale) ? $locale : AppLocale::getLocale();
 
      // Record whether or not to BCC the sender when sending message
      $this->bccSender = $request->getUserVar('bccSender');
 
      $this->addressFieldsEnabled = true;
 
      if (isset($this->emailKey)) {
         $emailTemplate = Services::get('emailTemplate')->getByKey($context ? $context->getId() : CONTEXT_SITE, $this->emailKey);
      }
 
      $userSig = '';
      $user = defined('SESSION_DISABLE_INIT')?null:$request->getUser();
      if ($user && $this->includeSignature) {
         $userSig = $user->getLocalizedSignature();
         if (!empty($userSig)) $userSig = "<br/>" . $userSig;
      }
 
      if (isset($emailTemplate)) {
         $this->setSubject($emailTemplate->getData('subject', $this->locale));
         $this->setBody($emailTemplate->getData('body', $this->locale) . $userSig);
         $this->enabled = $emailTemplate->getData('enabled');
      } else {
         $this->setBody($userSig);
         $this->enabled = true;
      }
 
      // Default "From" to user if available, otherwise site/context principal contact
      if ($user) {
         $this->setFrom($user->getEmail(), $user->getFullName());
      } elseif (is_null($context) || is_null($context->getData('contactEmail'))) {
         $site = $request->getSite();
         $this->setFrom($site->getLocalizedContactEmail(), $site->getLocalizedContactName());
      } else {
         $this->setFrom($context->getData('contactEmail'), $context->getData('contactName'));
      }
 
      if ($context) {
         $this->setSubject('[' . $context->getLocalizedAcronym() . '] ' . $this->getSubject());
      }
 
      $this->context = $context;
      $this->params = array();
   }
 
   function setAddressFieldsEnabled($addressFieldsEnabled) {
      $this->addressFieldsEnabled = $addressFieldsEnabled;
   }
 
   function getAddressFieldsEnabled() {
      return $this->addressFieldsEnabled;
   }
 
   function hasErrors() {
      return ($this->errorMessages != null);
   }
 
   function assignParams($params = array()) {
      $application = Application::get();
      $request = $application->getRequest();
      $site = $request->getSite();
 
      if ($this->context) {
         // Add context-specific variables
         $dispatcher = $application->getDispatcher();
         $params = array_merge(array(
            'principalContactSignature' => $this->context->getData('contactName'),
            'contextName' => $this->context->getLocalizedName(),
            'contextUrl' => $dispatcher->url($request, ROUTE_PAGE, $this->context->getPath()),
         ), $params);
      } else {
         // No context available
         $params = array_merge(array(
            'principalContactSignature' => $site->getLocalizedContactName(),
         ), $params);
      }
 
      if (!defined('SESSION_DISABLE_INIT') && ($user = $request->getUser())) {
         // Add user-specific variables
         $params = array_merge(array(
            'senderEmail' => $user->getEmail(),
            'senderName' => $user->getFullName(),
         ), $params);
      }
 
      // Add some general variables
      $params = array_merge(array(
         'siteTitle' => $site->getLocalizedTitle(),
      ), $params);
 
      $this->params = $params;
   }
 
   function isEnabled() {
      return $this->enabled;
   }
 
   function send() {
      if (isset($this->context)) {
         $signature = $this->context->getData('emailSignature');
         if (strstr($this->getBody(), '{$templateSignature}') === false) {
            $this->setBody($this->getBody() . "<br/>" . $signature);
         } else {
            $this->setBody(str_replace('{$templateSignature}', $signature, $this->getBody()));
         }
 
         $envelopeSender = $this->context->getData('envelopeSender');
         if (!empty($envelopeSender) && Config::getVar('email', 'allow_envelope_sender')) $this->setEnvelopeSender($envelopeSender);
      }
 
      $request = Application::get()->getRequest();
      $user = defined('SESSION_DISABLE_INIT')?null:$request->getUser();
 
      if ($user && $this->bccSender) {
         $this->addBcc($user->getEmail(), $user->getFullName());
      }
 
      // Replace variables in message with values
      $this->replaceParams();
 
      return parent::send();
   }
 
   function replaceParams() {
      $subject = $this->getSubject();
      $body = $this->getBody();
      foreach ($this->params as $key => $value) {
         if (!is_object($value)) {
            // $value is checked to identify URL pattern
            if (filter_var($value, FILTER_VALIDATE_URL) != false) {
               $body = $this->manageURLValues($body, $key, $value);
            } else {
               $body = str_replace('{$' . $key . '}', $value, $body);
            }
         }
 
         $subject = str_replace('{$' . $key . '}', $value, $subject);
      }
      $this->setSubject($subject);
      $this->setBody($body);
   }
 
   function sendWithParams($params) {
      $savedHeaders = $this->getHeaders();
      $savedSubject = $this->getSubject();
      $savedBody = $this->getBody();
 
      $this->assignParams($params);
      $ret = $this->send();
 
      $this->setHeaders($savedHeaders);
      $this->setSubject($savedSubject);
      $this->setBody($savedBody);
 
      return $ret;
   }
 
   function clearRecipients($clearHeaders = true) {
      $this->setData('recipients', null);
      $this->setData('ccs', null);
      $this->setData('bccs', null);
      if ($clearHeaders) {
         $this->setData('headers', null);
      }
   }
 
   function manageURLValues($targetString, $key, $value) {
      // If the value is URL, we need to find if $key resides in a href={$...} pattern.
      preg_match_all('/=[\\\'"]{\\$' . preg_quote($key) . '}/', $targetString, $matches, PREG_SET_ORDER|PREG_OFFSET_CAPTURE);
 
      // if we find some ={$...} occurences of the $key in the email body, then we need to replace them with
      // the corresponding value
      if ($matches) {
         // We make the change backwords (last offset replaced first) so that smaller offsets correctly mark the string they supposed to.
         for($i = count($matches)-1; $i >= 0; $i--) {
            $match = $matches[$i][0];
            $targetString = substr_replace($targetString,  str_replace('{$' . $key . '}', $value, $match[0]), $match[1], strlen($match[0]));
         }
      }
 
      // all the ={$...} patterns have been replaced - now we can change the remaining URL $keys with the following pattern
      $value = "<a href='$value' class='$key-style-class'>$value</a>";
 
      $targetString = str_replace('{$' . $key . '}', $value, $targetString);
 
      return $targetString;
   }
}