SelectableSubmissionFileListCategoryGridHandler.inc.php

<?php
 
// Import UI base classes.
import('lib.pkp.classes.controllers.grid.CategoryGridHandler');
 
// Import submission files grid specific classes.
import('lib.pkp.controllers.grid.files.SubmissionFilesGridRow');
import('lib.pkp.controllers.grid.files.FileNameGridColumn');
import('lib.pkp.controllers.grid.files.SelectableSubmissionFileListCategoryGridRow');
 
// Import the class that defines file grids capabilities.
import('lib.pkp.classes.controllers.grid.files.FilesGridCapabilities');
 
// Import file constants.
import('lib.pkp.classes.submission.SubmissionFile');
 
class SelectableSubmissionFileListCategoryGridHandler extends CategoryGridHandler {
 
   var $_capabilities;
 
   var $_stageId;
 
   function __construct($dataProvider, $stageId, $capabilities = 0) {
      // the StageId can be set later if necessary.
      if ($stageId) {
         $this->_stageId = (int)$stageId;
      }
 
      $this->_capabilities = new FilesGridCapabilities($capabilities);
 
      parent::__construct($dataProvider);
   }
 
 
   //
   // Getters and Setters
   //
   function getCapabilities() {
      return $this->_capabilities;
   }
 
   function getStageId() {
      return $this->_stageId;
   }
 
   function getSubmission() {
      // We assume proper authentication by the data provider.
      $submission = $this->getAuthorizedContextObject(ASSOC_TYPE_SUBMISSION);
      assert(is_a($submission, 'Submission'));
      return $submission;
   }
 
 
   //
   // Overridden methods from GridHandler
   //
   protected function loadData($request, $filter) {
      // Let parent class get data from data provider.
      $workflowStages = parent::loadData($request, $filter);
 
      // Filter the data.
      if ($filter['allStages']) {
         return array_combine($workflowStages, $workflowStages);
      } else {
         return array($this->getStageId() => $this->getStageId());
      }
   }
 
   protected function getFilterForm() {
      return 'controllers/grid/files/selectableSubmissionFileListCategoryGridFilter.tpl';
   }
 
   protected function isFilterFormCollapsible() {
      return false;
   }
 
   function getFilterSelectionData($request) {
      return array('allStages' => $request->getUserVar('allStages') ? true : false);
   }
 
 
   //
   // Overridden methods from CategoryGridHandler
   //
   protected function getCategoryRowInstance() {
      return new SelectableSubmissionFileListCategoryGridRow();
   }
 
 
   //
   // Implement template methods from PKPHandler
   //
   function authorize($request, &$args, $roleAssignments) {
      // Set the stage id from the request parameter if not set previously.
      if (!$this->getStageId()) {
         $stageId = (int) $request->getUserVar('stageId');
         // This will be validated with the authorization policy added by
         // the grid data provider.
         $this->_stageId = $stageId;
      }
 
      $dataProvider = $this->getDataProvider();
      $dataProvider->setStageId($this->getStageId());
 
      return parent::authorize($request, $args, $roleAssignments);
   }
 
   function initialize($request, $args = null) {
      parent::initialize($request, $args);
 
      // Load translations.
      AppLocale::requireComponents(
         LOCALE_COMPONENT_APP_SUBMISSION,
         LOCALE_COMPONENT_PKP_SUBMISSION,
         LOCALE_COMPONENT_APP_EDITOR,
         LOCALE_COMPONENT_PKP_EDITOR,
         LOCALE_COMPONENT_PKP_COMMON,
         LOCALE_COMPONENT_APP_COMMON
      );
 
      // Add grid actions
      $capabilities = $this->getCapabilities();
      $dataProvider = $this->getDataProvider();
 
      if($capabilities->canManage()) {
         $this->addAction($dataProvider->getSelectAction($request));
      }
 
      if($capabilities->canAdd()) {
         assert(isset($dataProvider));
         $this->addAction($dataProvider->getAddFileAction($request));
      }
 
      // Test whether an archive tool is available for the export to work, if so, add 'download all' grid action
      if ($capabilities->canDownloadAll() && $this->hasGridDataElements($request)) {
         $submission = $this->getSubmission();
         $stageId = $this->getStageId();
         $linkParams = array('submissionId' => $submission->getId(), 'stageId' => $stageId);
         $files = $this->getFilesToDownload($request);
 
         $this->addAction($capabilities->getDownloadAllAction($request, $files, $linkParams), GRID_ACTION_POSITION_BELOW);
      }
 
      // The file name column is common to all file grid types.
      $this->addColumn(new FileNameGridColumn($capabilities->canViewNotes(), $this->getStageId()));
 
      // The file list grid layout has an additional file genre column.
      import('lib.pkp.controllers.grid.files.fileList.FileGenreGridColumn');
      $this->addColumn(new FileGenreGridColumn());
 
      // Set the no items row text
      $this->setEmptyRowText('grid.noFiles');
   }
 
   function initFeatures($request, $args) {
      import('lib.pkp.classes.controllers.grid.feature.selectableItems.SelectableItemsFeature');
      return array(new SelectableItemsFeature());
   }
 
 
   //
   // Overridden methods from GridHandler
   //
   protected function getRowInstance() {
      return new SubmissionFilesGridRow($this->getCapabilities(), $this->getStageId());
   }
 
 
   //
   // Protected methods
   //
   function getFilesToDownload($request) {
      $dataProvider = $this->getDataProvider();
      $workflowStages = $this->getGridDataElements($request);
 
      // Get the submission files to be downloaded.
      $submissionFiles = array();
      foreach ($workflowStages as $stageId) {
         $submissionFiles = array_merge(
            $submissionFiles,
            $this->getGridCategoryDataElements($request, $stageId)
         );
      }
      return $submissionFiles;
   }
 
   function isDataElementInCategorySelected($categoryDataId, &$gridDataElement) {
      $currentStageId = $this->getAuthorizedContextObject(ASSOC_TYPE_WORKFLOW_STAGE);
      $submissionFile = $gridDataElement['submissionFile'];
 
      // Check for special cases when the file needs to be unselected.
      $dataProvider = $this->getDataProvider();
      if ($dataProvider->getFileStage() != $submissionFile->getFileStage()) {
         return false;
      } elseif ($currentStageId == WORKFLOW_STAGE_ID_INTERNAL_REVIEW || $currentStageId == WORKFLOW_STAGE_ID_EXTERNAL_REVIEW) {
         if ($currentStageId != $categoryDataId) {
            return false;
         }
      }
 
      // Passed the checks above. If viewable then select it.
      return $submissionFile->getViewable();
   }
 
   function getSelectName() {
      return 'selectedFiles';
   }
}