<?php
/**
 * @file controllers/grid/files/SubmissionFilesGridDataProvider.inc.php
 *
 * Copyright (c) 2014-2019 Simon Fraser University
 * Copyright (c) 2000-2019 John Willinsky
 * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
 *
 * @class PKPSubmissionFilesGridDataProvider
 * @ingroup controllers_grid_files
 *
 * @brief Provide access to submission file data for grids.
 */


import('lib.pkp.controllers.grid.files.FilesGridDataProvider');

class SubmissionFilesGridDataProvider extends FilesGridDataProvider {

	/** @var integer */
	var $_stageId;

	/** @var integer */
	var $_fileStage;


	/**
	 * Constructor
	 * @param $fileStage integer One of the SUBMISSION_FILE_* constants.
	 * @param $viewableOnly boolean True iff only viewable files should be included.
	 */
	function __construct($fileStage, $viewableOnly = false) {
		assert(is_numeric($fileStage) && $fileStage > 0);
		$this->_fileStage = (int)$fileStage;
		parent::__construct();

		$this->setViewableOnly($viewableOnly);
	}


	//
	// Getters and setters.
	//
	/**
	 * Set the workflow stage.
	 * @param $stageId int WORKFLOW_STAGE_ID_...
	 */
	function setStageId($stageId) {
		$this->_stageId = $stageId;
	}

	/**
	 * Get the workflow stage.
	 * @return integer WORKFLOW_STAGE_ID_...
	 */
	function getStageId() {
		return $this->_stageId;
	}


	//
	// Implement template methods from GridDataProvider
	//
	/**
	 * @copydoc GridDataProvider::getRequestArgs()
	 */
	function getRequestArgs() {
		$submission = $this->getSubmission();
		return array(
			'submissionId' => $submission->getId(),
			'stageId' => $this->getStageId(),
			'fileStage' => $this->getFileStage()
		);
	}

	/**
	 * Get the file stage.
	 * @return integer SUBMISSION_FILE_...
	 */
	function getFileStage() {
		return $this->_fileStage;
	}

	/**
	 * @copydoc GridDataProvider::loadData()
	 */
	function loadData($filter = array()) {
		// Retrieve all submission files for the given file stage.
		$submission = $this->getSubmission();
		$submissionFileDao = DAORegistry::getDAO('SubmissionFileDAO'); /* @var $submissionFileDao SubmissionFileDAO */
		$submissionFiles = $submissionFileDao->getLatestRevisions($submission->getId(), $this->getFileStage());
		return $this->prepareSubmissionFileData($submissionFiles, $this->_viewableOnly, $filter);
	}

	//
	// Implement template methods from GridDataProvider
	//
	/**
	 * @copydoc GridDataProvider::getAuthorizationPolicy()
	 */
	function getAuthorizationPolicy($request, $args, $roleAssignments) {
		$this->setUploaderRoles($roleAssignments);

		import('lib.pkp.classes.security.authorization.WorkflowStageAccessPolicy');
		return new WorkflowStageAccessPolicy($request, $args, $roleAssignments, 'submissionId', $this->getStageId());
	}

	//
	// Overridden public methods from FilesGridDataProvider
	//
	/**
	 * @copydoc FilesGridDataProvider::getAddFileAction()
	 */
	function getAddFileAction($request) {
		import('lib.pkp.controllers.api.file.linkAction.AddFileLinkAction');
		$submission = $this->getSubmission();
		return new AddFileLinkAction(
			$request, $submission->getId(),
			$this->getStageId(), $this->getUploaderRoles(), $this->getFileStage()
		);
	}


	//
	// Protected functions
	//
	/**
	 * Apply the filter to the list of revisions, returning only matching elements.
	 * @param $revisions array List of potential submission files to include.
	 * @param $filter array Associative array of filter data
	 * @return array
	 */
	protected function applyFilter($revisions, $filter) {
		if (!empty($filter['search'])) switch ($filter['column']) {
			case 'name':
				foreach ($revisions as $key => $submissionFile) {
					if (!stristr($submissionFile->getName(AppLocale::getLocale()), $filter['search'])) {
						unset($revisions[$key]);
					}
				}
				break;
		}
		return $revisions;
	}

	/**
	 * Rearrange file revisions by file id and return the file
	 * data wrapped into an array so that grid implementations
	 * can add further data.
	 * @param $revisions array List of SubmissionFiles
	 * @param $viewableOnly boolean optional True iff only viewable files should be listed
	 * @param $filter array optional Associative array of filter conditions
	 * @return array
	 */
	function prepareSubmissionFileData($revisions, $viewableOnly = false, $filter = array()) {
		$revisions = $this->applyFilter($revisions, $filter);

		// Rearrange the files as required by submission file grids.
		$submissionFileData = array();
		foreach ($revisions as $revision) {
			if ($viewableOnly && !$revision->getViewable()) continue;

			$submissionFileData[$revision->getFileId()] = array(
				'submissionFile' => $revision
			);
			unset($revision);
		}
		return $submissionFileData;
	}
}


