SubmissionMailTemplate.inc.php

<?php
 
import('lib.pkp.classes.mail.MailTemplate');
 
class SubmissionMailTemplate extends MailTemplate {
 
   var $submission;
 
   var $context;
 
   var $logEventType;
 
   function __construct($submission, $emailKey = null, $locale = null, $context = null, $includeSignature = true) {
      parent::__construct($emailKey, $locale, $context, $includeSignature);
      $this->submission = $submission;
   }
 
   function assignParams($paramArray = array()) {
      $submission = $this->submission;
      $request = Application::get()->getRequest();
      parent::assignParams(array_merge(
         array(
            'submissionTitle' => strip_tags($submission->getLocalizedFullTitle()),
            'submissionId' => $submission->getId(),
            'submissionAbstract' => PKPString::stripUnsafeHtml($submission->getLocalizedAbstract()),
            'authorString' => strip_tags($submission->getAuthorString()),
         ),
         $paramArray
      ));
   }
 
   function send($request = null) {
      if (parent::send()) {
         $this->log($request);
         return true;
      } else {
         return false;
      }
   }
 
   function sendWithParams($paramArray) {
      $savedSubject = $this->getSubject();
      $savedBody = $this->getBody();
 
      $this->assignParams($paramArray);
 
      $ret = $this->send();
 
      $this->setSubject($savedSubject);
      $this->setBody($savedBody);
 
      return $ret;
   }
 
   function setEventType($eventType) {
      $this->logEventType = $eventType;
   }
 
   function setContext($context) {
      $this->context = $context;
   }
 
   function log($request = null) {
      $logDao = DAORegistry::getDAO('SubmissionEmailLogDAO'); /* @var $logDao SubmissionEmailLogDAO */
      $entry = $logDao->newDataObject();
      $submission = $this->submission;
 
      // Event data
      $entry->setEventType($this->logEventType);
      $entry->setAssocId($submission->getId());
      $entry->setDateSent(Core::getCurrentDate());
 
      // User data
      if ($request) {
         $user = $request->getUser();
         $entry->setSenderId($user == null ? 0 : $user->getId());
      } else {
         // No user supplied -- this is e.g. a cron-automated email
         $entry->setSenderId(0);
      }
 
      // Email data
      $entry->setSubject($this->getSubject());
      $entry->setBody($this->getBody());
      $entry->setFrom($this->getFromString(false));
      $entry->setRecipients($this->getRecipientString());
      $entry->setCcs($this->getCcString());
      $entry->setBccs($this->getBccString());
 
      // Add log entry
      $logEntryId = $logDao->insertObject($entry);
   }
 
   function toAssignedSubEditors($submissionId, $stageId) {
      return $this->_addUsers($submissionId, ROLE_ID_SUB_EDITOR, $stageId, 'addRecipient');
   }
 
   function ccAssignedSubEditors($submissionId, $stageId) {
      return $this->_addUsers($submissionId, ROLE_ID_SUB_EDITOR, $stageId, 'addCc');
   }
 
   function bccAssignedSubEditors($submissionId, $stageId) {
      return $this->_addUsers($submissionId, ROLE_ID_SUB_EDITOR, $stageId, 'addBcc');
   }
 
   protected function _addUsers($submissionId, $roleId, $stageId, $method) {
      assert(in_array($method, array('addRecipient', 'addCc', 'addBcc')));
 
      $userGroupDao = DAORegistry::getDAO('UserGroupDAO'); /* @var $userGroupDao UserGroupDAO */
      $userGroups = $userGroupDao->getByRoleId($this->context->getId(), $roleId);
 
      $returner = array();
      // Cycle through all the userGroups for this role
      while ($userGroup = $userGroups->next()) {
         $userStageAssignmentDao = DAORegistry::getDAO('UserStageAssignmentDAO'); /* @var $userStageAssignmentDao UserStageAssignmentDAO */
         // FIXME: #6692# Should this be getting users just for a specific user group?
         $users = $userStageAssignmentDao->getUsersBySubmissionAndStageId($submissionId, $stageId, $userGroup->getId());
         while ($user = $users->next()) {
            $this->$method($user->getEmail(), $user->getFullName());
            $returner[] = $user;
         }
      }
      return $returner;
   }
}