PKPReviewerHandler.inc.php

<?php
 
import('classes.handler.Handler');
import('lib.pkp.classes.core.JSONMessage');
import('lib.pkp.classes.submission.reviewer.ReviewerAction');
 
class PKPReviewerHandler extends Handler {
 
   var $_isBackendPage = true;
 
   function submission($args, $request) {
      $reviewAssignment = $this->getAuthorizedContextObject(ASSOC_TYPE_REVIEW_ASSIGNMENT); /* @var $reviewAssignment ReviewAssignment */
      $reviewerSubmissionDao = DAORegistry::getDAO('ReviewerSubmissionDAO'); /* @var $reviewerSubmissionDao ReviewerSubmissionDAO */
      $reviewerSubmission = $reviewerSubmissionDao->getReviewerSubmission($reviewAssignment->getId());
      assert(is_a($reviewerSubmission, 'ReviewerSubmission'));
 
      $this->setupTemplate($request);
 
      $templateMgr = TemplateManager::getManager($request);
      $reviewStep = max($reviewerSubmission->getStep(), 1);
      $userStep = (int) $request->getUserVar('step');
      $step = (int) (!empty($userStep) ? $userStep: $reviewStep);
      if ($step > $reviewStep) $step = $reviewStep; // Reviewer can't go past incomplete steps
      if ($step < 1 || $step > 4) throw new Exception('Invalid step!');
      $templateMgr->assign([
         'pageTitle' => __('semicolon', ['label' => __('submission.review')]) . $reviewerSubmission->getLocalizedTitle(),
         'reviewStep' => $reviewStep,
         'selected' => $step - 1,
         'submission' => $reviewerSubmission,
      ]);
 
      $templateMgr->display('reviewer/review/reviewStepHeader.tpl');
   }
 
   function step($args, $request) {
      $reviewAssignment = $this->getAuthorizedContextObject(ASSOC_TYPE_REVIEW_ASSIGNMENT); /* @var $reviewAssignment ReviewAssignment */
      $reviewId = (int) $reviewAssignment->getId();
      assert(!empty($reviewId));
 
      $reviewerSubmissionDao = DAORegistry::getDAO('ReviewerSubmissionDAO'); /* @var $reviewerSubmissionDao ReviewerSubmissionDAO */
      $reviewerSubmission = $reviewerSubmissionDao->getReviewerSubmission($reviewAssignment->getId());
      assert(is_a($reviewerSubmission, 'ReviewerSubmission'));
 
      $this->setupTemplate($request);
 
      $reviewStep = max($reviewerSubmission->getStep(), 1); // Get the current saved step from the DB
      $userStep = (int) $request->getUserVar('step');
      $step = (int) (!empty($userStep) ? $userStep: $reviewStep);
      if ($step > $reviewStep) $step = $reviewStep; // Reviewer can't go past incomplete steps
      if ($step < 1 || $step > 4) fatalError('Invalid step!');
 
      if ($step < 4) {
         $reviewerForm = $this->getReviewForm($step, $request, $reviewerSubmission, $reviewAssignment);
         $reviewerForm->initData();
         return new JSONMessage(true, $reviewerForm->fetch($request));
      } else {
         $templateMgr = TemplateManager::getManager($request);
         $templateMgr->assign([
            'submission' => $reviewerSubmission,
            'step' => 4,
            'reviewAssignment' => $reviewAssignment,
         ]);
         return $templateMgr->fetchJson('reviewer/review/reviewCompleted.tpl');
      }
   }
 
   function saveStep($args, $request) {
      $step = (int)$request->getUserVar('step');
      if ($step<1 || $step>3) fatalError('Invalid step!');
      $saveFormButton = (bool)$request->getUserVar('saveFormButton');
 
      $reviewAssignment = $this->getAuthorizedContextObject(ASSOC_TYPE_REVIEW_ASSIGNMENT); /* @var $reviewAssignment ReviewAssignment */
      if ($reviewAssignment->getDateCompleted()) fatalError('Review already completed!');
 
      $reviewerSubmissionDao = DAORegistry::getDAO('ReviewerSubmissionDAO'); /* @var $reviewerSubmissionDao ReviewerSubmissionDAO */
      $reviewerSubmission = $reviewerSubmissionDao->getReviewerSubmission($reviewAssignment->getId());
      assert(is_a($reviewerSubmission, 'ReviewerSubmission'));
 
      $reviewerForm = $this->getReviewForm($step, $request, $reviewerSubmission, $reviewAssignment);
      $reviewerForm->readInputData();
 
      // Save the available form data, but do not submit
      if ($saveFormButton) {
         $reviewerForm->saveForLater();
         $notificationMgr = new NotificationManager();
         $user = $request->getUser();
         $notificationMgr->createTrivialNotification($user->getId(), NOTIFICATION_TYPE_SUCCESS, array('contents' => __('common.changesSaved')));
         return DAO::getDataChangedEvent();        
      }
      // Submit the form data and move forward
      else {
         if ($reviewerForm->validate()) {
            $reviewerForm->execute();
            $json = new JSONMessage(true);
            $json->setEvent('setStep', $step+1);
            return $json;
         } else {
            $this->setupTemplate($request);
            return new JSONMessage(true, $reviewerForm->fetch($request));
         }
      }
   }
 
   function showDeclineReview($args, $request) {
      $reviewAssignment = $this->getAuthorizedContextObject(ASSOC_TYPE_REVIEW_ASSIGNMENT); /* @var $reviewAssignment ReviewAssignment */
 
      $reviewerSubmissionDao = DAORegistry::getDAO('ReviewerSubmissionDAO'); /* @var $reviewerSubmissionDao ReviewerSubmissionDAO */
      $reviewerSubmission = $reviewerSubmissionDao->getReviewerSubmission($reviewAssignment->getId());
      assert(is_a($reviewerSubmission, 'ReviewerSubmission'));
 
      $this->setupTemplate($request);
 
      $templateMgr = TemplateManager::getManager($request);
      $templateMgr->assign('submissionId', $reviewerSubmission->getId());
 
      // Provide the email body to the template
      $reviewerAction = new ReviewerAction();
      $email = $reviewerAction->getResponseEmail($reviewerSubmission, $reviewAssignment, $request, 1);
      $templateMgr->assign('declineMessageBody', $email->getBody());
 
      return $templateMgr->fetchJson('reviewer/review/modal/regretMessage.tpl');
   }
 
   function saveDeclineReview($args, $request) {
      $reviewAssignment = $this->getAuthorizedContextObject(ASSOC_TYPE_REVIEW_ASSIGNMENT); /* @var $reviewAssignment ReviewAssignment */
      if ($reviewAssignment->getDateCompleted()) fatalError('Review already completed!');
 
      $reviewId = (int) $reviewAssignment->getId();
      $declineReviewMessage = $request->getUserVar('declineReviewMessage');
 
      // Decline the review
      $reviewerAction = new ReviewerAction();
      $submission = $this->getAuthorizedContextObject(ASSOC_TYPE_SUBMISSION);
      $reviewerAction->confirmReview($request, $reviewAssignment, $submission, 1, $declineReviewMessage);
 
      $dispatcher = $request->getDispatcher();
      return $request->redirectUrlJson($dispatcher->url($request, ROUTE_PAGE, null, 'index'));
   }
 
   function setupTemplate($request) {
      parent::setupTemplate($request);
      AppLocale::requireComponents(
         LOCALE_COMPONENT_PKP_SUBMISSION,
         LOCALE_COMPONENT_APP_SUBMISSION,
         LOCALE_COMPONENT_APP_COMMON,
         LOCALE_COMPONENT_PKP_GRID,
         LOCALE_COMPONENT_PKP_REVIEWER,
         LOCALE_COMPONENT_PKP_EDITOR,
         LOCALE_COMPONENT_PKP_USER
      );
   }
 
   public function getReviewForm($step, $request, $reviewerSubmission, $reviewAssignment) {
       switch ($step) {
           case 1:
            import("lib.pkp.classes.submission.reviewer.form.PKPReviewerReviewStep1Form"); 
            return new PKPReviewerReviewStep1Form($request, $reviewerSubmission, $reviewAssignment);
           case 2: 
            import("lib.pkp.classes.submission.reviewer.form.PKPReviewerReviewStep2Form");
            return new PKPReviewerReviewStep2Form($request, $reviewerSubmission, $reviewAssignment);
           case 3: 
            import("lib.pkp.classes.submission.reviewer.form.PKPReviewerReviewStep3Form");
            return new PKPReviewerReviewStep3Form($request, $reviewerSubmission, $reviewAssignment);
       }
   }
 
   //
   // Private helper methods
   //
   function _retrieveStep() {
      $reviewAssignment = $this->getAuthorizedContextObject(ASSOC_TYPE_REVIEW_ASSIGNMENT); /* @var $reviewAssignment ReviewAssignment */
      $reviewId = (int) $reviewAssignment->getId();
      assert(!empty($reviewId));
      return $reviewId;
   }
}