classes/mail/MailTemplate.inc.php

   1 <?php
   2
   3 /**
   4  * @file classes/mail/MailTemplate.inc.php
   5  *
   6  * Copyright (c) 2003-2008 John Willinsky
   7  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
   8  *
   9  * @class MailTemplate
  10  * @ingroup mail
  11  *
  12  * @brief Subclass of PKPMailTemplate for mailing a template email.
  13  */
  14
  15 // $Id: MailTemplate.inc.php,v 1.6 2009/06/09 23:37:13 tylerl Exp $
  16
  17
  18 import('mail.PKPMailTemplate');
  19
  20 class MailTemplate extends PKPMailTemplate {
  21         /** @var $press object The press this message relates to */
  22         var $press;
  23
  24         /**
  25          * Constructor.
  26          * @param $emailKey string unique identifier for the template
  27          * @param $locale string locale of the template
  28          * @param $enableAttachments boolean optional Whether or not to enable monograph attachments in the template
  29          * @param $press object optional The press this message relates to
  30          */
  31         function MailTemplate($emailKey = null, $locale = null, $enableAttachments = null, $press = null) {
  32                 parent::PKPMailTemplate($emailKey, $locale, $enableAttachments);
  33
  34                 // If a press wasn't specified, use the current request.
  35                 if ($press === null) $press =& Request::getPress();
  36
  37                 if (isset($this->emailKey)) {
  38                         $emailTemplateDao =& DAORegistry::getDAO('EmailTemplateDAO');
  39                         $emailTemplate =& $emailTemplateDao->getEmailTemplate($this->emailKey, $this->locale, $press == null ? 0 : $press->getId());
  40                 }
  41
  42                 $userSig = '';
  43                 $user =& Request::getUser();
  44                 if ($user) {
  45                         $userSig = $user->getLocalizedSignature();
  46                         if (!empty($userSig)) $userSig = "\n" . $userSig;
  47                 }
  48
  49                 if (isset($emailTemplate) && Request::getUserVar('subject')==null && Request::getUserVar('body')==null) {
  50                         $this->setSubject($emailTemplate->getSubject());
  51                         $this->setBody($emailTemplate->getBody() . $userSig);
  52                         $this->enabled = $emailTemplate->getEnabled();
  53
  54                         if (Request::getUserVar('usePostedAddresses')) {
  55                                 $to = Request::getUserVar('to');
  56                                 if (is_array($to)) {
  57                                         $this->setRecipients($this->processAddresses ($this->getRecipients(), $to));
  58                                 }
  59                                 $cc = Request::getUserVar('cc');
  60                                 if (is_array($cc)) {
  61                                         $this->setCcs($this->processAddresses ($this->getCcs(), $cc));
  62                                 }
  63                                 $bcc = Request::getUserVar('bcc');
  64                                 if (is_array($bcc)) {
  65                                         $this->setBccs($this->processAddresses ($this->getBccs(), $bcc));
  66                                 }
  67                         }
  68                 } else {
  69                         $this->setSubject(Request::getUserVar('subject'));
  70                         $body = Request::getUserVar('body');
  71                         if (empty($body)) $this->setBody($userSig);
  72                         else $this->setBody($body);
  73                         $this->skip = (($tmp = Request::getUserVar('send')) && is_array($tmp) && isset($tmp['skip']));
  74                         $this->enabled = true;
  75
  76                         if (is_array($toEmails = Request::getUserVar('to'))) {
  77                                 $this->setRecipients($this->processAddresses ($this->getRecipients(), $toEmails));
  78                         }
  79                         if (is_array($ccEmails = Request::getUserVar('cc'))) {
  80                                 $this->setCcs($this->processAddresses ($this->getCcs(), $ccEmails));
  81                         }
  82                         if (is_array($bccEmails = Request::getUserVar('bcc'))) {
  83                                 $this->setBccs($this->processAddresses ($this->getBccs(), $bccEmails));
  84                         }
  85                 }
  86
  87                 // Default "From" to user if available, otherwise site/press principal contact
  88                 $user =& Request::getUser();
  89                 if ($user) {
  90                         $this->setFrom($user->getEmail(), $user->getFullName());
  91                 } elseif ($press == null) {
  92                         $site =& Request::getSite();
  93                         $this->setFrom($site->getLocalizedContactEmail(), $site->getLocalizedContactName());
  94
  95                 } else {
  96                         $this->setFrom($press->getSetting('contactEmail'), $press->getSetting('contactName'));
  97                 }
  98
  99                 if ($press && !Request::getUserVar('continued')) {
 100                         $this->setSubject('[' . $press->getLocalizedSetting('initials') . '] ' . $this->getSubject());
 101                 }
 102
 103                 $this->press =& $press;
 104         }
 105
 106         /**
 107          * Assigns values to e-mail parameters.
 108          * @param $paramArray array
 109          * @return void
 110          */
 111         function assignParams($paramArray = array()) {
 112                 // Add commonly-used variables to the list
 113                 if (isset($this->press)) {
 114                         // FIXME Include affiliation, title, etc. in signature?
 115                         $paramArray['pressName'] = $this->press->getLocalizedName();
 116                         $paramArray['principalContactSignature'] = $this->press->getSetting('contactName');
 117                 } else {
 118                         $site =& Request::getSite();
 119                         $paramArray['principalContactSignature'] = $site->getLocalizedContactName();
 120                 }
 121                 if (!isset($paramArray['pressUrl'])) $paramArray['pressUrl'] = Request::url(Request::getRequestedPressPath());
 122
 123                 return parent::assignParams($paramArray);
 124         }
 125
 126         /**
 127          * Displays an edit form to customize the email.
 128          * @param $formActionUrl string
 129          * @param $hiddenFormParams array
 130          * @return void
 131          */
 132         function displayEditForm($formActionUrl, $hiddenFormParams = null, $alternateTemplate = null, $additionalParameters = array()) {
 133                 $templateMgr =& TemplateManager::getManager();
 134                 $templateMgr->assign('helpTopicId', 'press.managementPages.emails');
 135
 136                 parent::displayEditForm($formActionUrl, $hiddenFormParams, $alternateTemplate, $additionalParameters);
 137         }
 138
 139         /**
 140          * Send the email.
 141          * Aside from calling the parent method, this actually attaches
 142          * the persistent attachments if they are used.
 143          * @param $clearAttachments boolean Whether to delete attachments after
 144          */
 145         function send($clearAttachments = true) {
 146                 if (isset($this->press)) {
 147                         //If {$templateSignature} exists in the body of the
 148                         // message, replace it with the press signature;
 149                         // otherwise just append it. This is here to
 150                         // accomodate MIME-encoded messages or other cases
 151                         // where the signature cannot just be appended.
 152                         $searchString = '{$templateSignature}';
 153                         if (strstr($this->getBody(), $searchString) === false) {
 154                                 $this->setBody($this->getBody() . "\n" . $this->press->getSetting('emailSignature'));
 155                         } else {
 156                                 $this->setBody(str_replace($searchString, $this->press->getSetting('emailSignature'), $this->getBody()));
 157                         }
 158
 159                         $envelopeSender = $this->press->getSetting('envelopeSender');
 160                         if (!empty($envelopeSender) && Config::getVar('email', 'allow_envelope_sender')) $this->setEnvelopeSender($envelopeSender);
 161                 }
 162
 163                 return parent::send($clearAttachments);
 164         }
 165 }
 166
 167 ?>