pages/submission/PKPSubmissionHandler.inc.php

<?php
 
import('classes.handler.Handler');
import('lib.pkp.classes.core.JSONMessage');
 
abstract class PKPSubmissionHandler extends Handler {
 
   var $_isBackendPage = true;
 
   function authorize($request, &$args, $roleAssignments) {
      // The policy for the submission handler depends on the
      // step currently requested.
      $step = isset($args[0]) ? (int) $args[0] : 1;
      if ($step<1 || $step>$this->getStepCount()) return false;
 
      // Do we have a submission present in the request?
      $submissionId = (int)$request->getUserVar('submissionId');
 
      // Are we in step one without a submission present?
      if ($step === 1 && $submissionId === 0) {
         // Authorize submission creation. Author role not required.
         import('lib.pkp.classes.security.authorization.UserRequiredPolicy');
         $this->addPolicy(new UserRequiredPolicy($request));
         $this->markRoleAssignmentsChecked();
      } else {
         // Authorize editing of incomplete submissions.
         import('lib.pkp.classes.security.authorization.SubmissionAccessPolicy');
         $this->addPolicy(new SubmissionAccessPolicy($request, $args, $roleAssignments, 'submissionId'));
      }
 
      // Do policy checking.
      if (!parent::authorize($request, $args, $roleAssignments)) return false;
 
      // Execute additional checking of the step.
      // NB: Move this to its own policy for reuse when required in other places.
      $submission = $this->getAuthorizedContextObject(ASSOC_TYPE_SUBMISSION);
 
      // Permit if there is no submission set, but request is for initial step.
      if (!is_a($submission, 'Submission') && $step == 1) return true;
 
      // In all other cases we expect an authorized submission due to
      // the submission access policy above.
      assert(is_a($submission, 'Submission'));
 
      // Deny if submission is complete (==0 means complete) and at
      // any step other than the "complete" step (the last one)
      if ($submission->getSubmissionProgress() == 0 && $step != $this->getStepCount() ) return false;
 
      // Deny if trying to access a step greater than the current progress
      if ($submission->getSubmissionProgress() != 0 && $step > $submission->getSubmissionProgress()) return false;
 
      return true;
   }
 
 
   //
   // Public Handler Methods
   //
   function index($args, $request) {
      $request->redirect(null, null, 'wizard');
   }
 
   function wizard($args, $request) {
      $this->setupTemplate($request);
      $templateMgr = TemplateManager::getManager($request);
      $step = isset($args[0]) ? (int) $args[0] : 1;
      $templateMgr->assign('step', $step);
 
      $templateMgr->assign('sectionId', (int) $request->getUserVar('sectionId')); // to add a sectionId parameter to tab links in template
 
      $submission = $this->getAuthorizedContextObject(ASSOC_TYPE_SUBMISSION);
      if ($submission) {
         $templateMgr->assign('submissionId', $submission->getId());
         $templateMgr->assign('submissionProgress', (int) $submission->getSubmissionProgress());
      } else {
         $templateMgr->assign('submissionProgress', 1);
      }
      $templateMgr->assign([
         'pageTitle' => __('submission.submit.title'),
      ]);
      $templateMgr->display('submission/form/index.tpl');
   }
 
   function step($args, $request) {
      $step = isset($args[0]) ? (int) $args[0] : 1;
 
      $context = $request->getContext();
      $submission = $this->getAuthorizedContextObject(ASSOC_TYPE_SUBMISSION);
 
      $this->setupTemplate($request);
 
      if ( $step < $this->getStepCount() ) {
         $formClass = "SubmissionSubmitStep{$step}Form";
         import("classes.submission.form.$formClass");
 
         $submitForm = new $formClass($context, $submission);
         $submitForm->initData();
         return new JSONMessage(true, $submitForm->fetch($request));
      } elseif($step == $this->getStepCount()) {
         $templateMgr = TemplateManager::getManager($request);
         $templateMgr->assign('context', $context);
 
         // Retrieve the correct url for author review his submission.
         import('classes.core.Services');
         $reviewSubmissionUrl = Services::get('submission')->getWorkflowUrlByUserRoles($submission);
         $router = $request->getRouter();
         $dispatcher = $router->getDispatcher();
 
         $templateMgr->assign(array(
            'reviewSubmissionUrl' => $reviewSubmissionUrl,
            'submissionId' => $submission->getId(),
            'submitStep' => $step,
            'submissionProgress' => $submission->getSubmissionProgress(),
         ));
 
         return new JSONMessage(true, $templateMgr->fetch('submission/form/complete.tpl'));
      }
   }
 
   function saveStep($args, $request) {
      $step = isset($args[0]) ? (int) $args[0] : 1;
 
      $router = $request->getRouter();
      $context = $router->getContext($request);
      $submission = $this->getAuthorizedContextObject(ASSOC_TYPE_SUBMISSION);
 
      $this->setupTemplate($request);
 
      $formClass = "SubmissionSubmitStep{$step}Form";
      import("classes.submission.form.$formClass");
 
      $submitForm = new $formClass($context, $submission);
      $submitForm->readInputData();
 
      if (!HookRegistry::call('SubmissionHandler::saveSubmit', array($step, &$submission, &$submitForm))) {
         if ($submitForm->validate()) {
            $submissionId = $submitForm->execute();
            if (!$submission) {
               return $request->redirectUrlJson($router->url($request, null, null, 'wizard', $step+1, array('submissionId' => $submissionId), 'step-2'));
            }
            $json = new JSONMessage(true);
            $json->setEvent('setStep', max($step+1, $submission->getSubmissionProgress()));
            return $json;
         } else {
            // Provide entered tagit fields values
            $tagitKeywords = $submitForm->getData('keywords');
            if (is_array($tagitKeywords)) {
               $tagitFieldNames = $submitForm->_metadataFormImplem->getTagitFieldNames();
               $locales = array_keys($submitForm->supportedLocales);
               $formTagitData = array();
               foreach ($tagitFieldNames as $tagitFieldName) {
                  foreach ($locales as $locale) {
                     $formTagitData[$locale] = array_key_exists($locale . "-$tagitFieldName", $tagitKeywords) ? $tagitKeywords[$locale . "-$tagitFieldName"] : array();
                  }
                  $submitForm->setData($tagitFieldName, $formTagitData);
               }
            }
            return new JSONMessage(true, $submitForm->fetch($request));
         }
      }
   }
 
   //
   // Protected helper methods
   //
   function setupTemplate($request) {
      parent::setupTemplate($request);
      AppLocale::requireComponents(LOCALE_COMPONENT_APP_SUBMISSION, LOCALE_COMPONENT_PKP_SUBMISSION, LOCALE_COMPONENT_APP_MANAGER);
      // Get steps information.
      $templateMgr = TemplateManager::getManager($request);
      $templateMgr->assign('steps', $this->getStepsNumberAndLocaleKeys());
   }
 
   abstract function getStepsNumberAndLocaleKeys();
 
   abstract function getStepCount();
}