ReviewReminder.inc.php

<?php
 
import('lib.pkp.classes.scheduledTask.ScheduledTask');
 
define('REVIEW_REMIND_AUTO', 'REVIEW_REMIND_AUTO');
define('REVIEW_REQUEST_REMIND_AUTO', 'REVIEW_REQUEST_REMIND_AUTO');
 
class ReviewReminder extends ScheduledTask {
 
 
   function getName() {
      return __('admin.scheduledTask.reviewReminder');
   }
 
   function sendReminder ($reviewAssignment, $submission, $context, $reminderType = REVIEW_REMIND_AUTO) {
      $reviewAssignmentDao = DAORegistry::getDAO('ReviewAssignmentDAO'); /* @var $reviewAssignmentDao ReviewAssignmentDAO */
      $userDao = DAORegistry::getDAO('UserDAO'); /* @var $userDao UserDAO */
      $reviewId = $reviewAssignment->getId();
 
      $reviewer = $userDao->getById($reviewAssignment->getReviewerId());
      if (!isset($reviewer)) return false;
 
      import('lib.pkp.classes.mail.SubmissionMailTemplate');
      $emailKey = $reminderType;
      $reviewerAccessKeysEnabled = $context->getData('reviewerAccessKeysEnabled');
      switch (true) {
         case $reviewerAccessKeysEnabled && ($reminderType == REVIEW_REMIND_AUTO):
            $emailKey = 'REVIEW_REMIND_AUTO_ONECLICK';
            break;
         case $reviewerAccessKeysEnabled && ($reminderType == REVIEW_REQUEST_REMIND_AUTO):
            $emailKey = 'REVIEW_REQUEST_REMIND_AUTO_ONECLICK';
            break;
      }
      $email = new SubmissionMailTemplate($submission, $emailKey, $context->getPrimaryLocale(), $context, false);
      $email->setContext($context);
      $email->setReplyTo(null);
      $email->addRecipient($reviewer->getEmail(), $reviewer->getFullName());
      $email->setSubject($email->getSubject($context->getPrimaryLocale()));
      $email->setBody($email->getBody($context->getPrimaryLocale()));
      $email->setFrom($context->getData('contactEmail'), $context->getData('contactName'));
 
      $reviewUrlArgs = array('submissionId' => $reviewAssignment->getSubmissionId());
      if ($reviewerAccessKeysEnabled) {
         import('lib.pkp.classes.security.AccessKeyManager');
         $accessKeyManager = new AccessKeyManager();
 
         // Key lifetime is the typical review period plus four weeks
         $keyLifetime = ($context->getData('numWeeksPerReview') + 4) * 7;
         $accessKey = $accessKeyManager->createKey($context->getId(), $reviewer->getId(), $reviewId, $keyLifetime);
         $reviewUrlArgs = array_merge($reviewUrlArgs, array('reviewId' => $reviewId, 'key' => $accessKey));
      }
 
      $application = Application::get();
      $request = $application->getRequest();
      $dispatcher = $application->getDispatcher();
      $submissionReviewUrl = $dispatcher->url($request, ROUTE_PAGE, $context->getPath(), 'reviewer', 'submission', null, $reviewUrlArgs);
 
      // Format the review due date
      $reviewDueDate = strtotime($reviewAssignment->getDateDue());
      $dateFormatShort = $context->getLocalizedDateFormatShort();
      if ($reviewDueDate === -1 || $reviewDueDate === false) {
         // Default to something human-readable if no date specified
         $reviewDueDate = '_____';
      } else {
         $reviewDueDate = strftime($dateFormatShort, $reviewDueDate);
      }
      // Format the review response due date
      $responseDueDate = strtotime($reviewAssignment->getDateResponseDue());
      if ($responseDueDate === -1 || $responseDueDate === false) {
         // Default to something human-readable if no date specified
         $responseDueDate = '_____';
      } else {
         $responseDueDate = strftime($dateFormatShort, $responseDueDate);
      }
 
      AppLocale::requireComponents(LOCALE_COMPONENT_PKP_REVIEWER);
      AppLocale::requireComponents(LOCALE_COMPONENT_PKP_COMMON);
      $paramArray = array(
         'reviewerName' => $reviewer->getFullName(),
         'reviewerUserName' => $reviewer->getUsername(),
         'reviewDueDate' => $reviewDueDate,
         'responseDueDate' => $responseDueDate,
         'editorialContactSignature' => $context->getData('contactName') . "\n" . $context->getLocalizedName(),
         'passwordResetUrl' => $dispatcher->url($request, ROUTE_PAGE, $context->getPath(), 'login', 'resetPassword', $reviewer->getUsername(), array('confirm' => Validation::generatePasswordResetHash($reviewer->getId()))),
         'submissionReviewUrl' => $submissionReviewUrl,
         'messageToReviewer' => __('reviewer.step1.requestBoilerplate'),
         'abstractTermIfEnabled' => ($submission->getLocalizedAbstract() == '' ? '' : __('common.abstract')),
      );
      $email->assignParams($paramArray);
 
      $email->send();
 
      $reviewAssignment->setDateReminded(Core::getCurrentDate());
      $reviewAssignment->setReminderWasAutomatic(1);
      $reviewAssignmentDao->updateObject($reviewAssignment);
 
   }
 
   function executeActions() {
      $submission = null;
      $context = null;
 
      $reviewAssignmentDao = DAORegistry::getDAO('ReviewAssignmentDAO'); /* @var $reviewAssignmentDao ReviewAssignmentDAO */
      $submissionDao = DAORegistry::getDAO('SubmissionDAO'); /* @var $submissionDao SubmissionDAO */
      $contextDao = Application::getContextDAO();
 
      $incompleteAssignments = $reviewAssignmentDao->getIncompleteReviewAssignments();
      $inviteReminderDays = $submitReminderDays = null;
      foreach ($incompleteAssignments as $reviewAssignment) {
         // Avoid review assignments that a reminder exists for.
         if ($reviewAssignment->getDateReminded() !== null) continue;
 
         // Fetch the submission
         if ($submission == null || $submission->getId() != $reviewAssignment->getSubmissionId()) {
            unset($submission);
            $submission = $submissionDao->getById($reviewAssignment->getSubmissionId());
            // Avoid review assignments without submission in database.
            if (!$submission) continue;
 
         }
 
         if ($submission->getStatus() != STATUS_QUEUED) continue;
 
         // Fetch the context
         if ($context == null || $context->getId() != $submission->getContextId()) {
            unset($context);
            $context = $contextDao->getById($submission->getContextId());
 
            $inviteReminderDays = $context->getData('numDaysBeforeInviteReminder');
            $submitReminderDays = $context->getData('numDaysBeforeSubmitReminder');
         }
 
         $reminderType = false;
         if ($submitReminderDays>=1 && $reviewAssignment->getDateDue() != null) {
            $checkDate = strtotime($reviewAssignment->getDateDue());
            if (time() - $checkDate > 60 * 60 * 24 * $submitReminderDays) {
               $reminderType = REVIEW_REMIND_AUTO;
            }
         }
         if ($inviteReminderDays>=1 && $reviewAssignment->getDateConfirmed() == null) {
            $checkDate = strtotime($reviewAssignment->getDateResponseDue());
            if (time() - $checkDate > 60 * 60 * 24 * $inviteReminderDays) {
               $reminderType = REVIEW_REQUEST_REMIND_AUTO;
            }
         }
 
         if ($reminderType) $this->sendReminder ($reviewAssignment, $submission, $context, $reminderType);
      }
 
      return true;
   }
}