ArticleGalleyGridHandler.inc.php

<?php
 
// import grid base classes
import('lib.pkp.classes.controllers.grid.GridHandler');
 
// Link action & modal classes
import('lib.pkp.classes.linkAction.request.AjaxModal');
 
class ArticleGalleyGridHandler extends GridHandler {
 
   var $_request;
 
   function __construct() {
      parent::__construct();
      $this->addRoleAssignment(
         array(ROLE_ID_MANAGER, ROLE_ID_SUB_EDITOR, ROLE_ID_ASSISTANT, ROLE_ID_AUTHOR),
         array('fetchGrid', 'fetchRow', 'addGalley', 'editGalley', 'editGalleyTab', 'updateGalley', 'deleteGalley', 'identifiers', 'updateIdentifiers', 'clearPubId', 'saveSequence'));
   }
 
 
   //
   // Getters/Setters
   //
   function getSubmission() {
      return $this->getAuthorizedContextObject(ASSOC_TYPE_SUBMISSION);
   }
 
   function getPublication() {
      return $this->getAuthorizedContextObject(ASSOC_TYPE_PUBLICATION);
   }
 
   function getGalley() {
      return $this->getAuthorizedContextObject(ASSOC_TYPE_REPRESENTATION);
   }
 
 
   //
   // Overridden methods from PKPHandler.
   //
   public function getJSHandler() {
      return '$.pkp.controllers.grid.articleGalleys.ArticleGalleyGridHandler';
   }
 
   function authorize($request, &$args, $roleAssignments) {
      $this->_request = $request;
 
      import('lib.pkp.classes.security.authorization.WorkflowStageAccessPolicy');
      $this->addPolicy(new WorkflowStageAccessPolicy($request, $args, $roleAssignments, 'submissionId', WORKFLOW_STAGE_ID_PRODUCTION));
 
      import('lib.pkp.classes.security.authorization.PublicationAccessPolicy');
      $this->addPolicy(new PublicationAccessPolicy($request, $args, $roleAssignments));
 
      if ($request->getUserVar('representationId')) {
         import('lib.pkp.classes.security.authorization.internal.RepresentationRequiredPolicy');
         $this->addPolicy(new RepresentationRequiredPolicy($request, $args));
      }
 
      return parent::authorize($request, $args, $roleAssignments);
   }
 
   function initialize($request, $args = null) {
      parent::initialize($request, $args);
      $this->setTitle('submission.layout.galleys');
 
      // Load pkp-lib translations
      AppLocale::requireComponents(
         LOCALE_COMPONENT_PKP_SUBMISSION,
         LOCALE_COMPONENT_PKP_USER,
         LOCALE_COMPONENT_PKP_EDITOR,
         LOCALE_COMPONENT_APP_EDITOR
      );
 
      import('controllers.grid.articleGalleys.ArticleGalleyGridCellProvider');
      $cellProvider = new ArticleGalleyGridCellProvider($this->getSubmission(), $this->getPublication(), $this->canEdit());
 
      // Columns
      $this->addColumn(new GridColumn(
         'label',
         'common.name',
         null,
         null,
         $cellProvider
      ));
 
      
      if ($this->canEdit()) {
         $this->addAction(new LinkAction(
            'addGalley',
            new AjaxModal(
               $request->getRouter()->url($request, null, null, 'addGalley', null, $this->getRequestArgs()),
               __('submission.layout.newGalley'),
               'modal_add_item'
            ),
            __('grid.action.addGalley'),
            'add_item'
         ));
      }
      
   }
 
   //
   // Overridden methods from GridHandler
   //
   function initFeatures($request, $args) {
      if ($this->canEdit()) {
         import('lib.pkp.classes.controllers.grid.feature.OrderGridItemsFeature');
         return array(new OrderGridItemsFeature());
      }
 
      return array();
   }
 
   function getDataElementSequence($row) {
      return $row->getSequence();
   }
 
   function setDataElementSequence($request, $rowId, $gridDataElement, $newSequence) {
      $galleyDao = DAORegistry::getDAO('ArticleGalleyDAO');
      $galley = $galleyDao->getById($rowId);
      $galley->setSequence($newSequence);
      $galleyDao->updateObject($galley);
   }
 
   //
   // Overridden methods from GridHandler
   //
   function getRowInstance() {
      import('controllers.grid.articleGalleys.ArticleGalleyGridRow');
      return new ArticleGalleyGridRow(
         $this->getSubmission(),
         $this->getPublication(),
         $this->canEdit()
      );
   }
 
   function getRequestArgs() {
      return array(
         'submissionId' => $this->getSubmission()->getId(),
         'publicationId' => $this->getPublication()->getId(),
      );
   }
 
   function loadData($request, $filter = null) {
      $galleyDao = DAORegistry::getDAO('ArticleGalleyDAO');
      return $galleyDao->getByPublicationId($this->getPublication()->getId());
   }
 
   //
   // Public Galley Grid Actions
   //
   function identifiers($args, $request) {
      $representationDao = Application::getRepresentationDAO();
      $representation = $representationDao->getById($request->getUserVar('representationId'));
      import('controllers.tab.pubIds.form.PublicIdentifiersForm');
      $form = new PublicIdentifiersForm($representation);
      $form->initData();
      return new JSONMessage(true, $form->fetch($request));
   }
 
   function updateIdentifiers($args, $request) {
      $representationDao = Application::getRepresentationDAO();
      $representation = $representationDao->getById($request->getUserVar('representationId'));
      import('controllers.tab.pubIds.form.PublicIdentifiersForm');
      $form = new PublicIdentifiersForm($representation, null, array_merge($this->getRequestArgs(), ['representationId' => $representation->getId()]));
      $form->readInputData();
      if ($form->validate()) {
         $form->execute();
         return DAO::getDataChangedEvent();
      } else {
         return new JSONMessage(true, $form->fetch($request));
      }
   }
 
   function clearPubId($args, $request) {
      if (!$request->checkCSRF()) return new JSONMessage(false);
 
      $submission = $this->getSubmission();
      $representationDao = Application::getRepresentationDAO();
      $representation = $representationDao->getById($request->getUserVar('representationId'));
      import('controllers.tab.pubIds.form.PublicIdentifiersForm');
      $form = new PublicIdentifiersForm($representation);
      $form->clearPubId($request->getUserVar('pubIdPlugIn'));
      return new JSONMessage(true);
   }
 
   function addGalley($args, $request) {
      import('controllers.grid.articleGalleys.form.ArticleGalleyForm');
      $galleyForm = new ArticleGalleyForm(
         $request,
         $this->getSubmission(),
         $this->getPublication()
      );
      $galleyForm->initData();
      return new JSONMessage(true, $galleyForm->fetch($request));
   }
 
   function deleteGalley($args, $request) {
      $galley = $this->getGalley();
      if (!$galley || !$request->checkCSRF()) return new JSONMessage(false);
 
      $galleyDao = DAORegistry::getDAO('ArticleGalleyDAO');
      $galleyDao->deleteObject($galley);
 
      if ($galley->getFileId()) {
         import('lib.pkp.classes.submission.SubmissionFile'); // Import constants
         $publication = Services::get('publication')->get($galley->getData('publicationId'));
 
         // Delete dependent files if no other galley uses them
         $submissionFileDao = DAORegistry::getDAO('SubmissionFileDAO'); /* @var $submissionFileDao SubmissionFileDAO */
         $articleGalleyDao = DAORegistry::getDAO('ArticleGalleyDAO'); /* @var $articleGalleyDao ArticleGalleyDAO */
         $galleyFiles = $submissionFileDao->getLatestRevisionsByAssocId(ASSOC_TYPE_GALLEY, $galley->getId(), $publication->getData('submissionId'), SUBMISSION_FILE_PROOF);
         foreach ($galleyFiles as $file) {
            $sharedFileGalleys = $articleGalleyDao->getByFileId($file->getFileId())->toArray();
            if (empty($sharedFileGalleys)) {
               $submissionFileDao->deleteAllRevisionsByAssocId(ASSOC_TYPE_SUBMISSION_FILE, $file->getFileId(), SUBMISSION_FILE_DEPENDENT);
            }
         }
 
         // Delete main galley file if no other galley uses it
         $sharedFileGalleys = $articleGalleyDao->getByFileId($galley->getFileId())->toArray();
         if (empty($sharedFileGalleys)) {
            $submissionFileDao = DAORegistry::getDAO('SubmissionFileDAO');
            $submissionFileDao->deleteAllRevisionsById($galley->getFileId());
         }
      }
 
      $notificationDao = DAORegistry::getDAO('NotificationDAO');
      $notificationDao->deleteByAssoc(ASSOC_TYPE_REPRESENTATION, $galley->getId());
 
      if ($this->getSubmission()->getStageId() == WORKFLOW_STAGE_ID_EDITING ||
         $this->getSubmission()->getStageId() == WORKFLOW_STAGE_ID_PRODUCTION) {
 
         $notificationMgr = new NotificationManager();
         $notificationMgr->updateNotification(
            $request,
            array(NOTIFICATION_TYPE_ASSIGN_PRODUCTIONUSER, NOTIFICATION_TYPE_AWAITING_REPRESENTATIONS),
            null,
            ASSOC_TYPE_SUBMISSION,
            $this->getSubmission()->getId()
         );
      }
 
      //inform search index that file has been deleted
      $articleSearchIndex = Application::getSubmissionSearchIndex();
      $articleSearchIndex->submissionFileDeleted($this->getSubmission()->getId());
      $articleSearchIndex->submissionChangesFinished();
 
      return DAO::getDataChangedEvent($galley->getId());
   }
 
   function editGalley($args, $request) {
      $galley = $this->getGalley();
 
      // Check if this is a remote galley
      $templateMgr = TemplateManager::getManager($request);
      $templateMgr->assign(array(
         'submissionId' => $this->getSubmission()->getId(),
         'publicationId' => $this->getPublication()->getId(),
         'representationId' => $galley->getId(),
      ));
      $publisherIdEnabled = in_array('galley', (array) $request->getContext()->getData('enablePublisherId'));
      $pubIdsEnabled = false;
      $pubIdPlugins = PluginRegistry::loadCategory('pubIds', true, $request->getContext()->getId());
      foreach ($pubIdPlugins as $pubIdPlugin) {
         if ($pubIdPlugin->isObjectTypeEnabled('Representation', $request->getContext()->getId())) {
            $pubIdsEnabled = true;
            break;
         }
      }
      if ($publisherIdEnabled || $pubIdsEnabled) {
         $templateMgr->assign('enableIdentifiers', true);
      }
      return new JSONMessage(true, $templateMgr->fetch('controllers/grid/articleGalleys/editFormat.tpl'));
   }
 
   function editGalleyTab($args, $request) {
      // Form handling
      import('controllers.grid.articleGalleys.form.ArticleGalleyForm');
      $galleyForm = new ArticleGalleyForm(
         $request,
         $this->getSubmission(),
         $this->getPublication(),
         $this->getGalley()
      );
      $galleyForm->initData();
      return new JSONMessage(true, $galleyForm->fetch($request));
   }
 
   function updateGalley($args, $request) {
      $galley = $this->getGalley();
 
      import('controllers.grid.articleGalleys.form.ArticleGalleyForm');
      $galleyForm = new ArticleGalleyForm($request, $this->getSubmission(), $this->getPublication(), $galley);
      $galleyForm->readInputData();
 
      if ($galleyForm->validate()) {
         $galley = $galleyForm->execute();
 
         if ($this->getSubmission()->getStageId() == WORKFLOW_STAGE_ID_EDITING ||
            $this->getSubmission()->getStageId() == WORKFLOW_STAGE_ID_PRODUCTION) {
 
            $notificationMgr = new NotificationManager();
            $notificationMgr->updateNotification(
               $request,
               array(NOTIFICATION_TYPE_ASSIGN_PRODUCTIONUSER, NOTIFICATION_TYPE_AWAITING_REPRESENTATIONS),
               null,
               ASSOC_TYPE_SUBMISSION,
               $this->getSubmission()->getId()
            );
         }
 
         return DAO::getDataChangedEvent($galley->getId());
      }
      return new JSONMessage(true, $galleyForm->fetch($request));
   }
 
   function fetchRow($args, $request) {
      $json = parent::fetchRow($args, $request);
      if ($row = $this->getRequestedRow($request, $args)) {
         $galley = $row->getData();
         if ($galley->getRemoteUrl()=='' && !$galley->getFileId()) {
            $json->setEvent('uploadFile', $galley->getId());
         }
      }
 
      return $json;
   }
 
   public function canEdit() {
      $request = Application::get()->getRequest();
      $user = $request->getUser();
      $publication = $this->getPublication();
      $submission = $this->getSubmission();
      $userRoles = $this->getAuthorizedContextObject(ASSOC_TYPE_USER_ROLES);
 
      if ($publication->getData('status') === STATUS_PUBLISHED) {
         return false;
      }
 
      if (in_array(ROLE_ID_SITE_ADMIN, $userRoles)) {
         return true;
      }
 
      if ($submission->getDateSubmitted() == null) return true;
 
      if (Services::get('submission')->canEditPublication($submission->getId(), $user->getId())) {
         return true;
      }
 
      // Default: Read-only.
      return false;
   }
}