AuthorDashboardTabHandler.inc.php

<?php
 
// Import the base Handler.
import('classes.handler.Handler');
import('lib.pkp.classes.core.JSONMessage');
 
class AuthorDashboardTabHandler extends Handler {
 
   function __construct() {
      parent::__construct();
      $this->addRoleAssignment(array(ROLE_ID_AUTHOR), array('fetchTab'));
   }
 
 
   //
   // Extended methods from Handler
   //
   function authorize($request, &$args, $roleAssignments) {
      import('lib.pkp.classes.security.authorization.AuthorDashboardAccessPolicy');
      $this->addPolicy(new AuthorDashboardAccessPolicy($request, $args, $roleAssignments), true);
 
      return parent::authorize($request, $args, $roleAssignments);
   }
 
 
   //
   // Public handler operations
   //
   function fetchTab($args, $request) {
      $this->setupTemplate($request);
      $templateMgr = TemplateManager::getManager($request);
 
      $stageId = $request->getUserVar('stageId');
      $templateMgr->assign('stageId', $stageId);
 
      $submission = $this->getAuthorizedContextObject(ASSOC_TYPE_SUBMISSION);
      $templateMgr->assign('submission', $submission);
 
      // Check if current author can access CopyeditFilesGrid within copyedit stage
      $canAccessCopyeditingStage = true;
      $userAllowedStages = $this->getAuthorizedContextObject(ASSOC_TYPE_ACCESSIBLE_WORKFLOW_STAGES);
      if (!array_key_exists(WORKFLOW_STAGE_ID_EDITING, $userAllowedStages)) {
         $canAccessCopyeditingStage = false;
      }
      $templateMgr->assign('canAccessCopyeditingStage', $canAccessCopyeditingStage);
 
      // Import submission file to define file stages.
      import('lib.pkp.classes.submission.SubmissionFile');
 
      // Workflow-stage specific "upload file" action.
      $currentStage = $submission->getStageId();
 
      $templateMgr->assign('lastReviewRoundNumber', $this->_getLastReviewRoundNumber($submission, $currentStage));
 
      if (in_array($stageId, array(WORKFLOW_STAGE_ID_INTERNAL_REVIEW, WORKFLOW_STAGE_ID_EXTERNAL_REVIEW))) {
         $reviewRoundDao = DAORegistry::getDAO('ReviewRoundDAO'); /* @var $reviewRoundDao ReviewRoundDAO */
         $templateMgr->assign('reviewRounds', $reviewRoundDao->getBySubmissionId($submission->getId(), $stageId));
      }
 
      // If the submission is in or past the editorial stage,
      // assign the editor's copyediting emails to the template
      $submissionEmailLogDao = DAORegistry::getDAO('SubmissionEmailLogDAO'); /* @var $submissionEmailLogDao SubmissionEmailLogDAO */
      $user = $request->getUser();
 
      // Define the notification options.
      $templateMgr->assign(
         'authorDashboardNotificationRequestOptions',
         $this->_getNotificationRequestOptions($submission)
      );
 
      AppLocale::requireComponents(LOCALE_COMPONENT_PKP_SUBMISSION);
 
      switch ($stageId) {
         case WORKFLOW_STAGE_ID_SUBMISSION:
            return $templateMgr->fetchJson('controllers/tab/authorDashboard/submission.tpl');
         case WORKFLOW_STAGE_ID_INTERNAL_REVIEW:
            return $templateMgr->fetchJson('controllers/tab/authorDashboard/internalReview.tpl');
         case WORKFLOW_STAGE_ID_EXTERNAL_REVIEW:
            return $templateMgr->fetchJson('controllers/tab/authorDashboard/externalReview.tpl');
         case WORKFLOW_STAGE_ID_EDITING:
            $templateMgr->assign('copyeditingEmails', $submissionEmailLogDao->getByEventType($submission->getId(), SUBMISSION_EMAIL_COPYEDIT_NOTIFY_AUTHOR, $user->getId()));
            return $templateMgr->fetchJson('controllers/tab/authorDashboard/editorial.tpl');
         case WORKFLOW_STAGE_ID_PRODUCTION:
            $templateMgr->assign(array(
               'productionEmails' => $submissionEmailLogDao->getByEventType($submission->getId(), SUBMISSION_EMAIL_PROOFREAD_NOTIFY_AUTHOR, $user->getId()),
            ));
            return $templateMgr->fetchJson('controllers/tab/authorDashboard/production.tpl');
      }
   }
 
   protected function _getLastReviewRoundNumber($submission, $stageId) {
      $reviewRoundDao = DAORegistry::getDAO('ReviewRoundDAO'); /* @var $reviewRoundDao ReviewRoundDAO */
      $lastExternalReviewRound = $reviewRoundDao->getLastReviewRoundBySubmissionId($submission->getId(), $stageId);
      if ($lastExternalReviewRound) {
         return $lastExternalReviewRound->getRound();
      }
      return 0;
   }
 
   protected function _getNotificationRequestOptions($submission) {
      $submissionAssocTypeAndIdArray = array(ASSOC_TYPE_SUBMISSION, $submission->getId());
      return array(
         NOTIFICATION_LEVEL_TASK => array(
            NOTIFICATION_TYPE_PENDING_EXTERNAL_REVISIONS => $submissionAssocTypeAndIdArray),
         NOTIFICATION_LEVEL_NORMAL => array(
            NOTIFICATION_TYPE_EDITOR_DECISION_ACCEPT => $submissionAssocTypeAndIdArray,
            NOTIFICATION_TYPE_EDITOR_DECISION_EXTERNAL_REVIEW => $submissionAssocTypeAndIdArray,
            NOTIFICATION_TYPE_EDITOR_DECISION_PENDING_REVISIONS => $submissionAssocTypeAndIdArray,
            NOTIFICATION_TYPE_EDITOR_DECISION_RESUBMIT => $submissionAssocTypeAndIdArray,
            NOTIFICATION_TYPE_EDITOR_DECISION_NEW_ROUND => $submissionAssocTypeAndIdArray,
            NOTIFICATION_TYPE_EDITOR_DECISION_DECLINE => $submissionAssocTypeAndIdArray,
            NOTIFICATION_TYPE_EDITOR_DECISION_SEND_TO_PRODUCTION => $submissionAssocTypeAndIdArray),
         NOTIFICATION_LEVEL_TRIVIAL => array()
      );
   }
}