first commit

lib/pkp/controllers/informationCenter/SubmissionInformationCenterHandler.php

@@ -0,0 +1,171 @@
+<?php
+
+/**
+ * @file controllers/informationCenter/SubmissionInformationCenterHandler.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 SubmissionInformationCenterHandler
+ *
+ * @ingroup controllers_informationCenter
+ *
+ * @brief Handle requests to view the information center for a submission.
+ */
+
+namespace PKP\controllers\informationCenter;
+
+use APP\core\Application;
+use APP\notification\NotificationManager;
+use APP\template\TemplateManager;
+use PKP\controllers\informationCenter\form\NewSubmissionNoteForm;
+use PKP\core\JSONMessage;
+use PKP\core\PKPApplication;
+use PKP\log\event\EventLogEntry;
+use PKP\notification\PKPNotification;
+use PKP\security\Role;
+
+class SubmissionInformationCenterHandler extends InformationCenterHandler
+{
+    /** @var bool Is the current user assigned to an editorial role for this submission */
+    public $_isCurrentUserAssignedEditor;
+
+    /**
+     * @copydoc PKPHandler::authorize()
+     */
+    public function authorize($request, &$args, $roleAssignments)
+    {
+        $success = parent::authorize($request, $args, $roleAssignments);
+
+        // Prevent users from accessing history unless they are assigned to an
+        // appropriate role in this submission
+        $this->_isCurrentUserAssignedEditor = false;
+        $userAssignedRoles = $this->getAuthorizedContextObject(Application::ASSOC_TYPE_ACCESSIBLE_WORKFLOW_STAGES);
+        if (!empty($userAssignedRoles)) {
+            foreach ($userAssignedRoles as $stageId => $roles) {
+                if (array_intersect([Role::ROLE_ID_SITE_ADMIN, Role::ROLE_ID_MANAGER, Role::ROLE_ID_SUB_EDITOR], $roles)) {
+                    $this->_isCurrentUserAssignedEditor = true;
+                    break;
+                }
+            }
+        } else {
+            $userGlobalRoles = $this->getAuthorizedContextObject(Application::ASSOC_TYPE_USER_ROLES);
+            if (array_intersect([Role::ROLE_ID_SITE_ADMIN, Role::ROLE_ID_MANAGER], $userGlobalRoles)) {
+                $this->_isCurrentUserAssignedEditor = true;
+            }
+        }
+
+        if (!$this->_isCurrentUserAssignedEditor) {
+            return false;
+        }
+
+        return $success;
+    }
+
+    /**
+     * @copydoc InformationCenterHandler::viewInformationCenter()
+     */
+    public function viewInformationCenter($args, $request)
+    {
+        $templateMgr = TemplateManager::getManager($request);
+        $user = $request->getUser();
+        // Do not display the History tab if the user is not a manager or a sub-editor
+        $userHasRole = $user->hasRole([Role::ROLE_ID_MANAGER, Role::ROLE_ID_SUB_EDITOR], $this->_submission->getContextId());
+        $templateMgr->assign('removeHistoryTab', !$userHasRole || !$this->_isCurrentUserAssignedEditor);
+        return parent::viewInformationCenter($args, $request);
+    }
+
+    /**
+     * Display the notes tab.
+     *
+     * @param array $args
+     * @param PKPRequest $request
+     *
+     * @return JSONMessage JSON object
+     */
+    public function viewNotes($args, $request)
+    {
+        $this->setupTemplate($request);
+
+        $notesForm = new NewSubmissionNoteForm($this->_submission->getId());
+        $notesForm->initData();
+
+        $templateMgr = TemplateManager::getManager($request);
+        $templateMgr->assign('notesList', $this->_listNotes($args, $request));
+
+        return new JSONMessage(true, $notesForm->fetch($request));
+    }
+
+    /**
+     * Save a note.
+     *
+     * @param array $args
+     * @param PKPRequest $request
+     */
+    public function saveNote($args, $request)
+    {
+        $this->setupTemplate($request);
+
+        $notesForm = new NewSubmissionNoteForm($this->_submission->getId());
+        $notesForm->readInputData();
+
+        if ($notesForm->validate()) {
+            $notesForm->execute();
+
+            // Save to event log
+            $this->_logEvent($request, $this->_submission, EventLogEntry::SUBMISSION_LOG_NOTE_POSTED, PKPApplication::ASSOC_TYPE_SUBMISSION);
+
+            $user = $request->getUser();
+            $notificationManager = new NotificationManager();
+            $notificationManager->createTrivialNotification($user->getId(), PKPNotification::NOTIFICATION_TYPE_SUCCESS, ['contents' => __('notification.addedNote')]);
+
+            $jsonViewNotesResponse = $this->viewNotes($args, $request);
+            $json = new JSONMessage(true);
+            $json->setEvent('dataChanged');
+            $json->setEvent('noteAdded', $jsonViewNotesResponse->_content);
+
+            return $json;
+        } else {
+            // Return a JSON string indicating failure
+            return new JSONMessage(false);
+        }
+    }
+
+    /**
+     * Fetch the contents of the event log.
+     *
+     * @param array $args
+     * @param PKPRequest $request
+     *
+     * @return JSONMessage JSON object
+     */
+    public function viewHistory($args, $request)
+    {
+        $this->setupTemplate($request);
+        $templateMgr = TemplateManager::getManager($request);
+        $dispatcher = $request->getDispatcher();
+        $templateMgr->assign('gridParameters', $this->_getLinkParams());
+        return $templateMgr->fetchJson('controllers/informationCenter/submissionHistory.tpl');
+    }
+
+    /**
+     * Get the association ID for this information center view
+     *
+     * @return int
+     */
+    public function _getAssocId()
+    {
+        return $this->_submission->getId();
+    }
+
+    /**
+     * Get the association type for this information center view
+     *
+     * @return int
+     */
+    public function _getAssocType()
+    {
+        return Application::ASSOC_TYPE_SUBMISSION;
+    }
+}