ReviewReminderForm.inc.php

<?php
 
import('lib.pkp.classes.form.Form');
 
class ReviewReminderForm extends Form {
   var $_reviewAssignment;
 
   function __construct($reviewAssignment) {
      parent::__construct('controllers/grid/users/reviewer/form/reviewReminderForm.tpl');
      $this->_reviewAssignment = $reviewAssignment;
      AppLocale::requireComponents(LOCALE_COMPONENT_APP_SUBMISSION);
 
      // Validation checks for this form
      $this->addCheck(new FormValidatorPost($this));
      $this->addCheck(new FormValidatorCSRF($this));
   }
 
   //
   // Getters and Setters
   //
   function getReviewAssignment() {
      return $this->_reviewAssignment;
   }
 
 
   //
   // Overridden template methods
   //
   function initData() {
      $request = Application::get()->getRequest();
      $userDao = DAORegistry::getDAO('UserDAO'); /* @var $userDao UserDAO */
      $user = $request->getUser();
      $context = $request->getContext();
 
      $reviewAssignment = $this->getReviewAssignment();
      $reviewerId = $reviewAssignment->getReviewerId();
      $reviewer = $userDao->getById($reviewerId);
 
      $submissionDao = DAORegistry::getDAO('SubmissionDAO'); /* @var $submissionDao SubmissionDAO */
      $submission = $submissionDao->getById($reviewAssignment->getSubmissionId());
 
      import('lib.pkp.classes.mail.SubmissionMailTemplate');
      $context = $request->getContext();
      $templateKey = $this->_getMailTemplateKey($context);
 
      $email = new SubmissionMailTemplate($submission, $templateKey);
 
      // Format the review due date
      $reviewDueDate = strtotime($reviewAssignment->getDateDue());
      $dateFormatShort = $context->getLocalizedDateFormatShort();
      if ($reviewDueDate == -1) $reviewDueDate = $dateFormatShort; // Default to something human-readable if no date specified
      else $reviewDueDate = strftime($dateFormatShort, $reviewDueDate);
 
      $dispatcher = $request->getDispatcher();
      $paramArray = array(
         'reviewerName' => $reviewer->getFullName(),
         'reviewDueDate' => $reviewDueDate,
         'editorialContactSignature' => $user->getContactSignature(),
         'reviewerUserName' => $reviewer->getUsername(),
         'passwordResetUrl' => $dispatcher->url($request, ROUTE_PAGE, null, 'login', 'resetPassword', $reviewer->getUsername(), array('confirm' => Validation::generatePasswordResetHash($reviewer->getId()))),
         'submissionReviewUrl' => $dispatcher->url($request, ROUTE_PAGE, null, 'reviewer', 'submission', null, array('submissionId' => $reviewAssignment->getSubmissionId()))
      );
      $email->assignParams($paramArray);
 
      $this->setData('stageId', $reviewAssignment->getStageId());
      $this->setData('reviewAssignmentId', $reviewAssignment->getId());
      $this->setData('submissionId', $submission->getId());
      $this->setData('reviewAssignment', $reviewAssignment);
      $this->setData('reviewerName', $reviewer->getFullName() . ' <' . $reviewer->getEmail() . '>');
      $this->setData('message', $email->getBody());
      $this->setData('reviewDueDate', $reviewDueDate);
   }
 
   function fetch($request, $template = null, $display = false) {
      $context = $request->getContext();
      $user = $request->getUser();
 
      $templateMgr = TemplateManager::getManager($request);
      $templateMgr->assign('emailVariables', array(
         'reviewerName' => __('user.name'),
         'reviewDueDate' => __('reviewer.submission.reviewDueDate'),
         'submissionReviewUrl' => __('common.url'),
         'submissionTitle' => __('submission.title'),
         'passwordResetUrl' => __('common.url'),
         'contextName' => $context->getLocalizedName(),
         'editorialContactSignature' => $user->getContactSignature(),
      ));
      return parent::fetch($request, $template, $display);
   }
 
   function readInputData() {
      $this->readUserVars(array(
         'message',
         'reviewDueDate',
      ));
   }
 
   function execute(...$functionArgs) {
      $userDao = DAORegistry::getDAO('UserDAO'); /* @var $userDao UserDAO */
      $submissionDao = DAORegistry::getDAO('SubmissionDAO'); /* @var $submissionDao SubmissionDAO */
      $request = Application::get()->getRequest();
 
      $reviewAssignment = $this->getReviewAssignment();
      $reviewerId = $reviewAssignment->getReviewerId();
      $reviewer = $userDao->getById($reviewerId);
      $submission = $submissionDao->getById($reviewAssignment->getSubmissionId());
      $reviewDueDate = $this->getData('reviewDueDate');
      $dispatcher = $request->getDispatcher();
      $user = $request->getUser();
 
      import('lib.pkp.classes.mail.SubmissionMailTemplate');
      $context = $request->getContext();
      $templateKey = $this->_getMailTemplateKey($context);
      $email = new SubmissionMailTemplate($submission, $templateKey, null, null, null, false);
 
      $reviewUrlArgs = array('submissionId' => $reviewAssignment->getSubmissionId());
      if ($context->getData('reviewerAccessKeysEnabled')) {
         import('lib.pkp.classes.security.AccessKeyManager');
         $accessKeyManager = new AccessKeyManager();
         $expiryDays = ($context->getData('numWeeksPerReview') + 4) * 7;
         $accessKey = $accessKeyManager->createKey($context->getId(), $reviewerId, $reviewAssignment->getId(), $expiryDays);
         $reviewUrlArgs = array_merge($reviewUrlArgs, array('reviewId' => $reviewAssignment->getId(), 'key' => $accessKey));
      }
 
      $email->addRecipient($reviewer->getEmail(), $reviewer->getFullName());
      $email->setBody($this->getData('message'));
      $email->assignParams(array(
         'reviewerName' => $reviewer->getFullName(),
         'reviewDueDate' => $reviewDueDate,
         'passwordResetUrl' => $dispatcher->url($request, ROUTE_PAGE, null, 'login', 'resetPassword', $reviewer->getUsername(), array('confirm' => Validation::generatePasswordResetHash($reviewer->getId()))),
         'submissionReviewUrl' => $dispatcher->url($request, ROUTE_PAGE, null, 'reviewer', 'submission', null, $reviewUrlArgs),
         'editorialContactSignature' => $user->getContactSignature(),
      ));
      if (!$email->send($request)) {
         import('classes.notification.NotificationManager');
         $notificationMgr = new NotificationManager();
         $notificationMgr->createTrivialNotification($request->getUser()->getId(), NOTIFICATION_TYPE_ERROR, array('contents' => __('email.compose.error')));
      }
 
      // update the ReviewAssignment with the reminded and modified dates
      $reviewAssignment->setDateReminded(Core::getCurrentDate());
      $reviewAssignment->stampModified();
      $reviewAssignmentDao = DAORegistry::getDAO('ReviewAssignmentDAO'); /* @var $reviewAssignmentDao ReviewAssignmentDAO */
      $reviewAssignmentDao->updateObject($reviewAssignment);
 
      parent::execute(...$functionArgs);
   }
 
   function _getMailTemplateKey($context) {
      $templateKey = 'REVIEW_REMIND';
      if ($context->getData('reviewerAccessKeysEnabled')) {
         $templateKey = 'REVIEW_REMIND_ONECLICK';
      }
 
      return $templateKey;
   }
 
}