first commit

lib/pkp/controllers/grid/files/submissionDocuments/SubmissionDocumentsFilesGridDataProvider.php

@@ -0,0 +1,74 @@
+<?php
+/**
+ * @file controllers/grid/files/submissionDocuments/SubmissionDocumentsFilesGridDataProvider.php
+ *
+ * Copyright (c) 2014-2021 Simon Fraser University
+ * Copyright (c) 2000-2021 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class SubmissionDocumentsFilesGridDataProvider
+ *
+ * @ingroup controllers_grid_files_submissionDocuments
+ *
+ * @brief The base data provider for the submission documents library files grid.
+ */
+
+namespace PKP\controllers\grid\files\submissionDocuments;
+
+use APP\core\Application;
+use APP\submission\Submission;
+use PKP\context\LibraryFileDAO;
+use PKP\controllers\grid\CategoryGridDataProvider;
+use PKP\db\DAORegistry;
+use PKP\security\authorization\SubmissionAccessPolicy;
+
+class SubmissionDocumentsFilesGridDataProvider extends CategoryGridDataProvider
+{
+    /**
+     * @copydoc GridDataProvider::getAuthorizationPolicy()
+     */
+    public function getAuthorizationPolicy($request, $args, $roleAssignments)
+    {
+        return new SubmissionAccessPolicy($request, $args, $roleAssignments, 'submissionId');
+    }
+
+    //
+    // Getters and Setters
+    //
+
+    /**
+     * Get the authorized submission.
+     *
+     * @return Submission
+     */
+    public function getSubmission()
+    {
+        return $this->getAuthorizedContextObject(Application::ASSOC_TYPE_SUBMISSION);
+    }
+
+    /**
+     * @copydoc GridDataProvider::getRequestArgs()
+     */
+    public function getRequestArgs()
+    {
+        $submission = $this->getSubmission();
+        return [
+            'submissionId' => $submission->getId(),
+        ];
+    }
+
+    /**
+     * @copydoc CategoryGridHandler::loadCategoryData()
+     *
+     * @param null|mixed $filter
+     */
+    public function loadCategoryData($request, $fileType, $filter = null)
+    {
+        // Retrieve all library files for the given submission document category.
+        $submission = $this->getSubmission();
+        $libraryFileDao = DAORegistry::getDAO('LibraryFileDAO'); /** @var LibraryFileDAO $libraryFileDao */
+        $libraryFiles = $libraryFileDao->getBySubmissionId($submission->getId(), $fileType);
+
+        return $libraryFiles->toAssociativeArray();
+    }
+}

lib/pkp/controllers/grid/files/submissionDocuments/SubmissionDocumentsFilesGridHandler.php

@@ -0,0 +1,174 @@
+<?php
+
+/**
+ * @file controllers/grid/files/submissionDocuments/SubmissionDocumentsFilesGridHandler.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 SubmissionDocumentsFilesGridHandler
+ *
+ * @ingroup controllers_grid_files_submissionDocuments
+ *
+ * @brief Handle submission documents file grid requests.
+ */
+
+namespace PKP\controllers\grid\files\submissionDocuments;
+
+use APP\core\Application;
+use APP\template\TemplateManager;
+use PKP\context\Context;
+use PKP\controllers\grid\files\LibraryFileGridHandler;
+use PKP\controllers\grid\files\LibraryFileGridRow;
+use PKP\controllers\grid\files\submissionDocuments\form\EditLibraryFileForm;
+use PKP\controllers\grid\files\submissionDocuments\form\NewLibraryFileForm;
+use PKP\core\JSONMessage;
+use PKP\core\PKPRequest;
+use PKP\linkAction\LinkAction;
+use PKP\linkAction\request\AjaxModal;
+use PKP\security\Role;
+
+class SubmissionDocumentsFilesGridHandler extends LibraryFileGridHandler
+{
+    /**
+     * Constructor
+     */
+    public function __construct()
+    {
+        parent::__construct(new SubmissionDocumentsFilesGridDataProvider());
+        $this->addRoleAssignment(
+            [Role::ROLE_ID_MANAGER, Role::ROLE_ID_SITE_ADMIN, Role::ROLE_ID_SUB_EDITOR, Role::ROLE_ID_ASSISTANT, Role::ROLE_ID_AUTHOR],
+            [
+                'addFile', 'uploadFile', 'saveFile', // Adding new library files
+                'editFile', 'updateFile', // Editing existing library files
+                'deleteFile', 'viewLibrary'
+            ]
+        );
+    }
+
+
+    //
+    // Overridden template methods
+    //
+    /**
+     * Configure the grid
+     *
+     * @see LibraryFileGridHandler::initialize
+     *
+     * @param null|mixed $args
+     */
+    public function initialize($request, $args = null)
+    {
+        $this->setCanEdit(true); // this grid can always be edited.
+        parent::initialize($request, $args);
+
+        $this->setTitle(null);
+
+        $router = $request->getRouter();
+
+        // Add grid-level actions
+
+        if ($this->canEdit()) {
+            $this->addAction(
+                new LinkAction(
+                    'addFile',
+                    new AjaxModal(
+                        $router->url($request, null, null, 'addFile', null, $this->getActionArgs()),
+                        __('grid.action.addFile'),
+                        'modal_add_file'
+                    ),
+                    __('grid.action.addFile'),
+                    'add'
+                )
+            );
+        }
+
+        $this->addAction(
+            new LinkAction(
+                'viewLibrary',
+                new AjaxModal(
+                    $router->url($request, null, null, 'viewLibrary', null, $this->getActionArgs()),
+                    __('grid.action.viewLibrary'),
+                    'modal_information'
+                ),
+                __('grid.action.viewLibrary'),
+                'more_info'
+            )
+        );
+    }
+
+    /**
+     * Retrieve the arguments for the 'add file' action.
+     *
+     * @return array
+     */
+    public function getActionArgs()
+    {
+        $submission = $this->getAuthorizedContextObject(Application::ASSOC_TYPE_SUBMISSION);
+        $actionArgs = [
+            'submissionId' => $submission->getId(),
+        ];
+
+        return $actionArgs;
+    }
+
+    /**
+     * Get the row handler - override the default row handler
+     *
+     * @return LibraryFileGridRow
+     */
+    protected function getRowInstance()
+    {
+        $submission = $this->getAuthorizedContextObject(Application::ASSOC_TYPE_SUBMISSION);
+        return new LibraryFileGridRow($this->canEdit(), $submission);
+    }
+
+    //
+    // Public File Grid Actions
+    //
+
+    /**
+     * Load the (read only) context file library.
+     *
+     * @param array $args
+     * @param PKPRequest $request
+     *
+     * @return JSONMessage JSON object
+     */
+    public function viewLibrary($args, $request)
+    {
+        $templateMgr = TemplateManager::getManager($request);
+        $templateMgr->assign('isModal', true);
+        $userRoles = $this->getAuthorizedContextObject(Application::ASSOC_TYPE_USER_ROLES);
+        $templateMgr->assign('canEdit', !empty(array_intersect([Role::ROLE_ID_MANAGER, Role::ROLE_ID_SITE_ADMIN], $userRoles)));
+        return $templateMgr->fetchJson('controllers/modals/documentLibrary/publisherLibrary.tpl');
+    }
+
+    /**
+     * Returns a specific instance of the new form for this grid.
+     *
+     * @param Context $context
+     *
+     * @return NewLibraryFileForm
+     */
+    public function _getNewFileForm($context)
+    {
+        $submission = $this->getAuthorizedContextObject(Application::ASSOC_TYPE_SUBMISSION);
+        return new NewLibraryFileForm($context->getId(), $submission->getId());
+    }
+
+    /**
+     * Returns a specific instance of the edit form for this grid.
+     *
+     * @param Context $context
+     * @param int $fileId
+     *
+     * @return EditLibraryFileForm
+     */
+    public function _getEditFileForm($context, $fileId)
+    {
+        $submission = $this->getAuthorizedContextObject(Application::ASSOC_TYPE_SUBMISSION);
+        return new EditLibraryFileForm($context->getId(), $fileId, $submission->getId());
+    }
+}

lib/pkp/controllers/grid/files/submissionDocuments/form/EditLibraryFileForm.php

@@ -0,0 +1,86 @@
+<?php
+
+/**
+ * @file controllers/grid/files/submissionDocuments/form/EditLibraryFileForm.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 EditLibraryFileForm
+ *
+ * @ingroup controllers_grid_files_submissionDocuments_form
+ *
+ * @brief Form for editing a library file
+ */
+
+namespace PKP\controllers\grid\files\submissionDocuments\form;
+
+use PKP\context\LibraryFile;
+use PKP\context\LibraryFileDAO;
+use PKP\controllers\grid\files\form\LibraryFileForm;
+use PKP\db\DAORegistry;
+
+class EditLibraryFileForm extends LibraryFileForm
+{
+    /** @var LibraryFile the file being edited, or null for new */
+    public $libraryFile;
+
+    /** @var int the id of the submission for this library file */
+    public $submissionId;
+
+    /**
+     * Constructor.
+     *
+     * @param int $contextId
+     * @param int $fileId optional
+     */
+    public function __construct($contextId, $fileId, $submissionId)
+    {
+        parent::__construct('controllers/grid/files/submissionDocuments/form/editFileForm.tpl', $contextId);
+
+        $this->submissionId = $submissionId;
+        $libraryFileDao = DAORegistry::getDAO('LibraryFileDAO'); /** @var LibraryFileDAO $libraryFileDao */
+        $this->libraryFile = $libraryFileDao->getById($fileId);
+
+        if (!$this->libraryFile || $this->libraryFile->getContextId() != $this->contextId || $this->libraryFile->getSubmissionId() != $this->getSubmissionId()) {
+            fatalError('Invalid library file!');
+        }
+    }
+
+    /**
+     * Initialize form data from current settings.
+     */
+    public function initData()
+    {
+        $this->_data = [
+            'submissionId' => $this->libraryFile->getSubmissionId(),
+            'libraryFileName' => $this->libraryFile->getName(null), // Localized
+            'libraryFile' => $this->libraryFile // For read-only info
+        ];
+    }
+
+    /**
+     * @copydoc Form::execute()
+     */
+    public function execute(...$functionArgs)
+    {
+        $this->libraryFile->setName($this->getData('libraryFileName'), null); // Localized
+        $this->libraryFile->setType($this->getData('fileType'));
+
+        $libraryFileDao = DAORegistry::getDAO('LibraryFileDAO'); /** @var LibraryFileDAO $libraryFileDao */
+        $libraryFileDao->updateObject($this->libraryFile);
+
+        parent::execute(...$functionArgs);
+    }
+
+    /**
+     * return the submission ID for this library file.
+     *
+     * @return int
+     */
+    public function getSubmissionId()
+    {
+        return $this->submissionId;
+    }
+}

lib/pkp/controllers/grid/files/submissionDocuments/form/NewLibraryFileForm.php

@@ -0,0 +1,114 @@
+<?php
+/**
+ * @file controllers/grid/files/submissionDocuments/form/NewLibraryFileForm.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 NewLibraryFileForm
+ *
+ * @ingroup controllers_grid_files_submissionDocuments_form
+ *
+ * @brief Form for adding/editing a file
+ * stores/retrieves from an associative array
+ */
+
+namespace PKP\controllers\grid\files\submissionDocuments\form;
+
+use APP\core\Application;
+use APP\file\LibraryFileManager;
+use APP\template\TemplateManager;
+use PKP\context\LibraryFileDAO;
+use PKP\controllers\grid\files\form\LibraryFileForm;
+use PKP\db\DAORegistry;
+use PKP\file\TemporaryFileDAO;
+use PKP\file\TemporaryFileManager;
+
+class NewLibraryFileForm extends LibraryFileForm
+{
+    /** @var int */
+    public $submissionId;
+
+    /**
+     * Constructor.
+     *
+     * @param int $contextId
+     */
+    public function __construct($contextId, $submissionId)
+    {
+        parent::__construct('controllers/grid/files/submissionDocuments/form/newFileForm.tpl', $contextId);
+        $this->submissionId = $submissionId;
+        $this->addCheck(new \PKP\form\validation\FormValidator($this, 'temporaryFileId', 'required', 'settings.libraryFiles.fileRequired'));
+    }
+
+    /**
+     * Assign form data to user-submitted data.
+     *
+     * @copydoc Form::readInputData()
+     */
+    public function readInputData()
+    {
+        $this->readUserVars(['temporaryFileId', 'submissionId']);
+        return parent::readInputData();
+    }
+
+    /**
+     * @copydoc LibraryFileForm::fetch()
+     *
+     * @param null|mixed $template
+     */
+    public function fetch($request, $template = null, $display = false)
+    {
+        $templateMgr = TemplateManager::getManager($request);
+        $templateMgr->assign('submissionId', $this->getSubmissionId());
+        return parent::fetch($request, $template, $display);
+    }
+
+    /**
+     * @copydoc Form::execute()
+     *
+     * @return $fileId int The new library file id.
+     */
+    public function execute(...$functionArgs)
+    {
+        $userId = Application::get()->getRequest()->getUser()->getId();
+
+        // Fetch the temporary file storing the uploaded library file
+        $temporaryFileDao = DAORegistry::getDAO('TemporaryFileDAO'); /** @var TemporaryFileDAO $temporaryFileDao */
+        $temporaryFile = $temporaryFileDao->getTemporaryFile(
+            $this->getData('temporaryFileId'),
+            $userId
+        );
+        $libraryFileDao = DAORegistry::getDAO('LibraryFileDAO'); /** @var LibraryFileDAO $libraryFileDao */
+        $libraryFileManager = new LibraryFileManager($this->contextId);
+
+        // Convert the temporary file to a library file and store
+        $libraryFile = & $libraryFileManager->copyFromTemporaryFile($temporaryFile, $this->getData('fileType'));
+        assert(isset($libraryFile));
+        $libraryFile->setContextId($this->contextId);
+        $libraryFile->setName($this->getData('libraryFileName'), null); // Localized
+        $libraryFile->setType($this->getData('fileType'));
+        $libraryFile->setSubmissionId($this->getData('submissionId'));
+
+        $fileId = $libraryFileDao->insertObject($libraryFile);
+
+        // Clean up the temporary file
+        $temporaryFileManager = new TemporaryFileManager();
+        $temporaryFileManager->deleteById($this->getData('temporaryFileId'), $userId);
+
+        parent::execute(...$functionArgs);
+
+        return $fileId;
+    }
+
+    /**
+     * return the submission ID for this library file.
+     *
+     * @return int
+     */
+    public function getSubmissionId()
+    {
+        return $this->submissionId;
+    }
+}