first commit

lib/pkp/controllers/grid/files/proof/ManageProofFilesGridHandler.php

@@ -0,0 +1,118 @@
+<?php
+
+/**
+ * @file controllers/grid/files/proof/ManageProofFilesGridHandler.php
+ *
+ * Copyright (c) 2014-2021 Simon Fraser University
+ * Copyright (c) 2003-2021 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class ManageProofFilesGridHandler
+ *
+ * @ingroup controllers_grid_files_proof
+ *
+ * @brief Handle the editor's proof files selection grid (selects which files to include)
+ */
+
+namespace PKP\controllers\grid\files\proof;
+
+use APP\core\Application;
+use PKP\controllers\grid\files\proof\form\ManageProofFilesForm;
+use PKP\controllers\grid\files\SelectableSubmissionFileListCategoryGridHandler;
+use PKP\controllers\grid\files\SubmissionFilesCategoryGridDataProvider;
+use PKP\core\JSONMessage;
+use PKP\core\PKPRequest;
+use PKP\security\authorization\internal\RepresentationRequiredPolicy;
+use PKP\security\authorization\PublicationAccessPolicy;
+use PKP\security\authorization\SubmissionAccessPolicy;
+use PKP\security\Role;
+use PKP\submissionFile\SubmissionFile;
+
+class ManageProofFilesGridHandler extends SelectableSubmissionFileListCategoryGridHandler
+{
+    /**
+     * Constructor
+     */
+    public function __construct()
+    {
+        parent::__construct(
+            new SubmissionFilesCategoryGridDataProvider(SubmissionFile::SUBMISSION_FILE_PROOF),
+            WORKFLOW_STAGE_ID_PRODUCTION
+        );
+
+        $this->addRoleAssignment(
+            [Role::ROLE_ID_SUB_EDITOR, Role::ROLE_ID_MANAGER, Role::ROLE_ID_SITE_ADMIN],
+            [
+                'fetchGrid', 'fetchCategory', 'fetchRow',
+                'addFile', 'downloadFile', 'deleteFile',
+                'updateProofFiles',
+            ]
+        );
+
+        // Set the grid title.
+        $this->setTitle('submission.pageProofs');
+    }
+
+    /**
+     * @copydoc PKPHandler::authorize()
+     */
+    public function authorize($request, &$args, $roleAssignments)
+    {
+        $this->addPolicy(new SubmissionAccessPolicy($request, $args, $roleAssignments));
+
+        $this->addPolicy(new PublicationAccessPolicy($request, $args, $roleAssignments));
+        $this->addPolicy(new RepresentationRequiredPolicy($request, $args));
+        return parent::authorize($request, $args, $roleAssignments);
+    }
+
+    /**
+     * Get the grid request parameters.
+     *
+     * @return array
+     */
+    public function getRequestArgs()
+    {
+        $publication = $this->getAuthorizedContextObject(Application::ASSOC_TYPE_PUBLICATION);
+        $representation = $this->getAuthorizedContextObject(Application::ASSOC_TYPE_REPRESENTATION);
+        return array_merge(
+            parent::getRequestArgs(),
+            [
+                'publicationId' => $publication->getId(),
+                'representationId' => $representation->getId()
+            ]
+        );
+    }
+
+    //
+    // Public handler methods
+    //
+    /**
+     * Save 'manage proof files' form
+     *
+     * @param array $args
+     * @param PKPRequest $request
+     *
+     * @return JSONMessage JSON object
+     */
+    public function updateProofFiles($args, $request)
+    {
+        $submission = $this->getSubmission();
+        $publication = $this->getAuthorizedContextObject(Application::ASSOC_TYPE_PUBLICATION);
+        $representation = $this->getAuthorizedContextObject(Application::ASSOC_TYPE_REPRESENTATION);
+
+        $manageProofFilesForm = new ManageProofFilesForm($submission->getId(), $publication->getId(), $representation->getId());
+        $manageProofFilesForm->readInputData();
+
+        if ($manageProofFilesForm->validate()) {
+            $manageProofFilesForm->execute(
+                $this->getGridCategoryDataElements($request, $this->getStageId()),
+                SubmissionFile::SUBMISSION_FILE_PROOF
+            );
+
+            // Let the calling grid reload itself
+            return \PKP\db\DAO::getDataChangedEvent();
+        } else {
+            return new JSONMessage(false);
+        }
+    }
+}

lib/pkp/controllers/grid/files/proof/form/ManageProofFilesForm.php

@@ -0,0 +1,84 @@
+<?php
+
+/**
+ * @file controllers/grid/files/proof/form/ManageProofFilesForm.php
+ *
+ * Copyright (c) 2014-2021 Simon Fraser University
+ * Copyright (c) 2003-2021 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class ManageProofFilesForm
+ *
+ * @ingroup controllers_grid_files_proof
+ *
+ * @brief Form to add files to the proof files grid
+ */
+
+namespace PKP\controllers\grid\files\proof\form;
+
+use APP\core\Application;
+use APP\template\TemplateManager;
+use PKP\controllers\grid\files\form\ManageSubmissionFilesForm;
+use PKP\submissionFile\SubmissionFile;
+
+class ManageProofFilesForm extends ManageSubmissionFilesForm
+{
+    /** @var int PublicationId ID. */
+    public $_publicationId;
+
+    /** @var int Representation ID. */
+    public $_representationId;
+
+    /**
+     * Constructor.
+     *
+     * @param int $submissionId Submission ID.
+     * @param int $publicationId Publication ID
+     * @param int $representationId Representation ID.
+     */
+    public function __construct($submissionId, $publicationId, $representationId)
+    {
+        parent::__construct($submissionId, 'controllers/grid/files/proof/manageProofFiles.tpl');
+        $this->_publicationId = $publicationId;
+        $this->_representationId = $representationId;
+    }
+
+
+    //
+    // Overridden template methods
+    //
+    /**
+     * @copydoc ManageSubmissionFilesForm::fetch
+     *
+     * @param null|mixed $template
+     */
+    public function fetch($request, $template = null, $display = false)
+    {
+        $templateMgr = TemplateManager::getManager($request);
+        $templateMgr->assign('publicationId', $this->_publicationId);
+        $templateMgr->assign('representationId', $this->_representationId);
+        return parent::fetch($request, $template, $display);
+    }
+
+    /**
+     * @copydoc ManageSubmissionFilesForm::fileExistsInStage
+     */
+    protected function fileExistsInStage($submissionFile, $stageSubmissionFiles, $fileStage)
+    {
+        return false;
+    }
+
+
+    /**
+     * @copydoc ManageSubmissionFilesForm::importFile()
+     */
+    protected function importFile($submissionFile, $fileStage)
+    {
+        $newSubmissionFile = clone $submissionFile;
+        $newSubmissionFile->setData('assocType', Application::ASSOC_TYPE_REPRESENTATION);
+        $newSubmissionFile->setData('assocId', $this->_representationId);
+        $newSubmissionFile->setData('viewable', false); // Not approved by default
+
+        return parent::importFile($newSubmissionFile, SubmissionFile::SUBMISSION_FILE_PROOF);
+    }
+}