PKPReviewerReviewStep3Form.inc.php

<?php
 
import('lib.pkp.classes.submission.reviewer.form.ReviewerReviewForm');
 
class PKPReviewerReviewStep3Form extends ReviewerReviewForm {
   function __construct($request, $reviewerSubmission, $reviewAssignment) {
      parent::__construct($request, $reviewerSubmission, $reviewAssignment, 3);
 
      // Validation checks for this form
      $reviewFormElementDao = DAORegistry::getDAO('ReviewFormElementDAO'); /* @var $reviewFormElementDao ReviewFormElementDAO */
      $requiredReviewFormElementIds = $reviewFormElementDao->getRequiredReviewFormElementIds($reviewAssignment->getReviewFormId());
      $this->addCheck(new FormValidatorCustom($this, 'reviewFormResponses', 'required', 'reviewer.submission.reviewFormResponse.form.responseRequired', function($reviewFormResponses) use ($requiredReviewFormElementIds) {
         foreach ($requiredReviewFormElementIds as $requiredReviewFormElementId) {
            if (!isset($reviewFormResponses[$requiredReviewFormElementId]) || $reviewFormResponses[$requiredReviewFormElementId] == '') return false;
         }
         return true;
      }));
 
      $this->addCheck(new FormValidatorPost($this));
      $this->addCheck(new FormValidatorCSRF($this));
      
   }
 
   function initData() {
      $reviewAssignment = $this->getReviewAssignment();
 
      // Retrieve most recent reviewer comments, one private, one public.
      $submissionCommentDao = DAORegistry::getDAO('SubmissionCommentDAO'); /* @var $submissionCommentDao SubmissionCommentDAO */
 
      $submissionComments = $submissionCommentDao->getReviewerCommentsByReviewerId($reviewAssignment->getSubmissionId(), $reviewAssignment->getReviewerId(), $reviewAssignment->getId(), true);
      $submissionComment = $submissionComments->next();
      $this->setData('comments', $submissionComment?$submissionComment->getComments():'');
 
      $submissionCommentsPrivate = $submissionCommentDao->getReviewerCommentsByReviewerId($reviewAssignment->getSubmissionId(), $reviewAssignment->getReviewerId(), $reviewAssignment->getId(), false);
      $submissionCommentPrivate = $submissionCommentsPrivate->next();
      $this->setData('commentsPrivate', $submissionCommentPrivate?$submissionCommentPrivate->getComments():'');
   }
 
   //
   // Implement protected template methods from Form
   //
   function readInputData() {
      $this->readUserVars(
         array('reviewFormResponses', 'comments', 'recommendation', 'commentsPrivate')
      );
   }
 
   function fetch($request, $template = null, $display = false) {
      $templateMgr = TemplateManager::getManager($request);
      $reviewAssignment = $this->getReviewAssignment();
 
      // Assign the objects and data to the template.
      $context = $this->request->getContext();
      $templateMgr->assign(array(
         'reviewAssignment' => $reviewAssignment,
         'reviewRoundId' => $reviewAssignment->getReviewRoundId(),
         'reviewerRecommendationOptions' => ReviewAssignment::getReviewerRecommendationOptions(),
      ));
 
      if ($reviewAssignment->getReviewFormId()) {
 
         // Get the review form components
         $reviewFormElementDao = DAORegistry::getDAO('ReviewFormElementDAO'); /* @var $reviewFormElementDao ReviewFormElementDAO */
         $reviewFormResponseDao = DAORegistry::getDAO('ReviewFormResponseDAO'); /* @var $reviewFormResponseDao ReviewFormResponseDAO */
         $reviewFormDao = DAORegistry::getDAO('ReviewFormDAO'); /* @var $reviewFormDao ReviewFormDAO */
         $templateMgr->assign(array(
            'reviewForm' => $reviewFormDao->getById($reviewAssignment->getReviewFormId(), Application::getContextAssocType(), $context->getId()),
            'reviewFormElements' => $reviewFormElementDao->getByReviewFormId($reviewAssignment->getReviewFormId()),
            'reviewFormResponses' => $reviewFormResponseDao->getReviewReviewFormResponseValues($reviewAssignment->getId()),
            'disabled' => isset($reviewAssignment) && $reviewAssignment->getDateCompleted() != null,
         ));
      }
 
      //
      // Assign the link actions
      //
      import('lib.pkp.controllers.confirmationModal.linkAction.ViewReviewGuidelinesLinkAction');
      $viewReviewGuidelinesAction = new ViewReviewGuidelinesLinkAction($request, $reviewAssignment->getStageId());
      if ($viewReviewGuidelinesAction->getGuidelines()) {
         $templateMgr->assign('viewGuidelinesAction', $viewReviewGuidelinesAction);
      }
 
      return parent::fetch($request, $template, $display);
   }
 
   function execute(...$functionParams) {
      $reviewAssignment = $this->getReviewAssignment();
      $notificationMgr = new NotificationManager();
 
      // Save the answers to the review form
      $this->saveReviewForm($reviewAssignment);
 
      // Send notification
      $submissionDao = DAORegistry::getDAO('SubmissionDAO'); /* @var $submissionDao SubmissionDAO */
      $submission = $submissionDao->getById($reviewAssignment->getSubmissionId());
 
      $stageAssignmentDao = DAORegistry::getDAO('StageAssignmentDAO'); /* @var $stageAssignmentDao StageAssignmentDAO */
      $stageAssignments = $stageAssignmentDao->getBySubmissionAndStageId($submission->getId(), $submission->getStageId());
      $userGroupDao = DAORegistry::getDAO('UserGroupDAO'); /* @var $userGroupDao UserGroupDAO */
      $receivedList = array(); // Avoid sending twice to the same user.
 
      while ($stageAssignment = $stageAssignments->next()) {
         $userId = $stageAssignment->getUserId();
         $userGroup = $userGroupDao->getById($stageAssignment->getUserGroupId(), $submission->getContextId());
 
         // Never send reviewer comment notification to users other than mangers and editors.
         if (!in_array($userGroup->getRoleId(), array(ROLE_ID_MANAGER, ROLE_ID_SUB_EDITOR)) || in_array($userId, $receivedList)) continue;
 
         $notificationMgr->createNotification(
            Application::get()->getRequest(), $userId, NOTIFICATION_TYPE_REVIEWER_COMMENT,
            $submission->getContextId(), ASSOC_TYPE_REVIEW_ASSIGNMENT, $reviewAssignment->getId()
         );
 
         $receivedList[] = $userId;
      }
 
      // Set review to next step.
      $this->updateReviewStepAndSaveSubmission($this->getReviewerSubmission());
 
      // Mark the review assignment as completed.
      $reviewAssignment->setDateCompleted(Core::getCurrentDate());
      $reviewAssignment->stampModified();
 
      // assign the recommendation to the review assignment, if there was one.
      $reviewAssignment->setRecommendation((int) $this->getData('recommendation'));
 
      // Persist the updated review assignment.
      $reviewAssignmentDao = DAORegistry::getDAO('ReviewAssignmentDAO'); /* @var $reviewAssignmentDao ReviewAssignmentDAO */
      $reviewAssignmentDao->updateObject($reviewAssignment);
 
      // Remove the task
      $notificationDao = DAORegistry::getDAO('NotificationDAO'); /* @var $notificationDao NotificationDAO */
      $notificationDao->deleteByAssoc(
         ASSOC_TYPE_REVIEW_ASSIGNMENT,
         $reviewAssignment->getId(),
         $reviewAssignment->getReviewerId(),
         NOTIFICATION_TYPE_REVIEW_ASSIGNMENT
      );
 
      // Add log
      import('lib.pkp.classes.log.SubmissionLog');
      import('classes.log.SubmissionEventLogEntry');
 
      $userDao = DAORegistry::getDAO('UserDAO'); /* @var $userDao UserDAO */
      $reviewer = $userDao->getById($reviewAssignment->getReviewerId());
      $request = Application::get()->getRequest();
      SubmissionLog::logEvent(
         $request,
         $submission,
         SUBMISSION_LOG_REVIEW_READY,
         'log.review.reviewReady',
         array(
            'reviewAssignmentId' => $reviewAssignment->getId(),
            'reviewerName' => $reviewer->getFullName(),
            'submissionId' => $reviewAssignment->getSubmissionId(),
            'round' => $reviewAssignment->getRound()
         )
      );
 
      parent::execute(...$functionParams);
   }
 
   function saveForLater() {
      $reviewAssignment = $this->getReviewAssignment();
      $notificationMgr = new NotificationManager();
 
      // Save the answers to the review form
      $this->saveReviewForm($reviewAssignment);
 
      // Mark the review assignment as modified.
      $reviewAssignment->stampModified();
 
      // save the recommendation to the review assignment
      $reviewAssignment->setRecommendation((int) $this->getData('recommendation'));
 
      // Persist the updated review assignment.
      $reviewAssignmentDao = DAORegistry::getDAO('ReviewAssignmentDAO'); /* @var $reviewAssignmentDao ReviewAssignmentDAO */
      $reviewAssignmentDao->updateObject($reviewAssignment);
      
      return true;
   }
 
   function saveReviewForm($reviewAssignment) {
      if ($reviewAssignment->getReviewFormId()) {
         $reviewFormResponseDao = DAORegistry::getDAO('ReviewFormResponseDAO'); /* @var $reviewFormResponseDao ReviewFormResponseDAO */
         $reviewFormResponses = $this->getData('reviewFormResponses');
         if (is_array($reviewFormResponses)) foreach ($reviewFormResponses as $reviewFormElementId => $reviewFormResponseValue) {
            $reviewFormResponse = $reviewFormResponseDao->getReviewFormResponse($reviewAssignment->getId(), $reviewFormElementId);
            if (!isset($reviewFormResponse)) {
               $reviewFormResponse = new ReviewFormResponse();
            }
            $reviewFormElementDao = DAORegistry::getDAO('ReviewFormElementDAO'); /* @var $reviewFormElementDao ReviewFormElementDAO */
            $reviewFormElement = $reviewFormElementDao->getById($reviewFormElementId);
            $elementType = $reviewFormElement->getElementType();
            switch ($elementType) {
               case REVIEW_FORM_ELEMENT_TYPE_SMALL_TEXT_FIELD:
               case REVIEW_FORM_ELEMENT_TYPE_TEXT_FIELD:
               case REVIEW_FORM_ELEMENT_TYPE_TEXTAREA:
                  $reviewFormResponse->setResponseType('string');
                  $reviewFormResponse->setValue($reviewFormResponseValue);
                  break;
               case REVIEW_FORM_ELEMENT_TYPE_RADIO_BUTTONS:
               case REVIEW_FORM_ELEMENT_TYPE_DROP_DOWN_BOX:
                  $reviewFormResponse->setResponseType('int');
                  $reviewFormResponse->setValue($reviewFormResponseValue);
                  break;
               case REVIEW_FORM_ELEMENT_TYPE_CHECKBOXES:
                  $reviewFormResponse->setResponseType('object');
                  $reviewFormResponse->setValue($reviewFormResponseValue);
                  break;
            }
            if ($reviewFormResponse->getReviewFormElementId() != null && $reviewFormResponse->getReviewId() != null) {
               $reviewFormResponseDao->updateObject($reviewFormResponse);
            } else {
               $reviewFormResponse->setReviewFormElementId($reviewFormElementId);
               $reviewFormResponse->setReviewId($reviewAssignment->getId());
               $reviewFormResponseDao->insertObject($reviewFormResponse);
            }
         }
      } else {       
         // No review form configured. Use the default form.
         if (strlen($comments = $this->getData('comments'))>0) {
            // Create a comment with the review.
            $submissionCommentDao = DAORegistry::getDAO('SubmissionCommentDAO'); /* @var $submissionCommentDao SubmissionCommentDAO */
            $submissionComments = $submissionCommentDao->getReviewerCommentsByReviewerId($reviewAssignment->getSubmissionId(), $reviewAssignment->getReviewerId(), $reviewAssignment->getId(), true);
            $comment = $submissionComments->next();
 
            if (!isset($comment)) {
               $comment = $submissionCommentDao->newDataObject();
            }
 
            $comment->setCommentType(COMMENT_TYPE_PEER_REVIEW);
            $comment->setRoleId(ROLE_ID_REVIEWER);
            $comment->setAssocId($reviewAssignment->getId());
            $comment->setSubmissionId($reviewAssignment->getSubmissionId());
            $comment->setAuthorId($reviewAssignment->getReviewerId());
            $comment->setComments($comments);
            $comment->setCommentTitle('');
            $comment->setViewable(true);
            $comment->setDatePosted(Core::getCurrentDate());
 
            // Save or update
            if ($comment->getId() != null) {
               $submissionCommentDao->updateObject($comment);
            } else {
               $submissionCommentDao->insertObject($comment);
            }
 
         }
         unset($comment);
 
         if (strlen($commentsPrivate = $this->getData('commentsPrivate'))>0) {
            // Create a comment with the review.
            $submissionCommentDao = DAORegistry::getDAO('SubmissionCommentDAO'); /* @var $submissionCommentDao SubmissionCommentDAO */
            $submissionCommentsPrivate = $submissionCommentDao->getReviewerCommentsByReviewerId($reviewAssignment->getSubmissionId(), $reviewAssignment->getReviewerId(), $reviewAssignment->getId(), false);
            $comment = $submissionCommentsPrivate->next();
 
            if (!isset($comment)) {
               $comment = $submissionCommentDao->newDataObject();
            }
 
            $comment->setCommentType(COMMENT_TYPE_PEER_REVIEW);
            $comment->setRoleId(ROLE_ID_REVIEWER);
            $comment->setAssocId($reviewAssignment->getId());
            $comment->setSubmissionId($reviewAssignment->getSubmissionId());
            $comment->setAuthorId($reviewAssignment->getReviewerId());
            $comment->setComments($commentsPrivate);
            $comment->setCommentTitle('');
            $comment->setViewable(false);
            $comment->setDatePosted(Core::getCurrentDate());
 
            // Save or update
            if ($comment->getId() != null) {
               $submissionCommentDao->updateObject($comment);
            } else {
               $submissionCommentDao->insertObject($comment);
            }
 
         }
         unset($comment);
      }
   }
}