Merge branch 'refactorings-897' into 'main'

Realiza refatorações na classe principal do plugin

See merge request softwares-pkp/plugins_ojs/scieloModerationStages!30

Author: JhonathanLepidus

ScieloModerationStagesPlugin.php

@@ -23,19 +23,14 @@
 use PKP\security\Role;
 use PKP\db\DAORegistry;
 use Illuminate\Support\Facades\Event;
-use Illuminate\Support\Facades\Mail;
 use PKP\linkAction\LinkAction;
 use PKP\linkAction\request\AjaxModal;
 use PKP\core\JSONMessage;
-use APP\plugins\generic\scieloModerationStages\classes\ModerationStage;
-use APP\plugins\generic\scieloModerationStages\classes\ModerationStageRegister;
-use APP\plugins\generic\scieloModerationStages\classes\mail\builders\StageAdvancementEmailBuilder;
+use APP\plugins\generic\scieloModerationStages\classes\SchemaEditor;
 use APP\plugins\generic\scieloModerationStages\classes\observers\listeners\AssignFirstModerationStage;
 
 class ScieloModerationStagesPlugin extends GenericPlugin
 {
-    private const SCIELO_BRASIL_EMAIL = 'scielo.submission@scielo.org';
-
     public function register($category, $path, $mainContextId = null)
     {
         $success = parent::register($category, $path, $mainContextId);
@@ -47,29 +42,22 @@ public function register($category, $path, $mainContextId = null)
         if ($success && $this->getEnabled($mainContextId)) {
             Event::subscribe(new AssignFirstModerationStage());
 
-            Hook::add('Schema::get::submission', [$this, 'addNewPropsToSubmissionSchema']);
-            Hook::add('Schema::get::eventLog', [$this, 'addNewPropsToEventLogSchema']);
-            Hook::add('addparticipantform::display', [$this, 'addStageAdvanceToAssignForm']);
-            Hook::add('addparticipantform::execute', [$this, 'sendSubmissionToNextModerationStage']);
-            Hook::add('queryform::display', [$this, 'hideParticipantsOnDiscussionOpening']);
-
-            Hook::add('Template::Workflow::Publication', [$this, 'addToWorkflowTabs']);
-            Hook::add('Template::Workflow', [$this, 'addCurrentStageStatusToWorkflow']);
             Hook::add('LoadComponentHandler', [$this, 'setupScieloModerationStagesHandler']);
-
             Hook::add('AcronPlugin::parseCronTab', [$this, 'addTasksToCrontab']);
             Hook::add('TemplateManager::display', [$this, 'addMessageToSubmissionComplete']);
 
-            $this->addHandlerURLToJavaScript();
+            $this->editSchemas();
             $this->loadDispatcherClasses();
+            $this->addHandlerURLToJavaScript();
         }
         return $success;
     }
 
     private function loadDispatcherClasses(): void
     {
         $dispatcherClasses = [
-            'DashboardDispatcher'
+            'DashboardDispatcher',
+            'WorkflowDispatcher'
         ];
 
         foreach ($dispatcherClasses as $dispatcherClass) {
@@ -78,6 +66,13 @@ private function loadDispatcherClasses(): void
         }
     }
 
+    private function editSchemas()
+    {
+        $schemaEditor = new SchemaEditor();
+        Hook::add('Schema::get::submission', [$schemaEditor, 'editSubmissionSchema']);
+        Hook::add('Schema::get::eventLog', [$schemaEditor, 'editEventLogSchema']);
+    }
+
     public function addHandlerURLToJavaScript()
     {
         $request = Application::get()->getRequest();
@@ -215,104 +210,6 @@ public function addNewPropsToEventLogSchema($hookName, $params)
         return Hook::CONTINUE;
     }
 
-    public function addStageAdvanceToAssignForm($hookName, $params)
-    {
-        $request = Application::get()->getRequest();
-        $templateMgr = TemplateManager::getManager($request);
-
-        $submission = $params[0]->getSubmission();
-        $moderationStage = new ModerationStage($submission);
-
-        if ($moderationStage->canAdvanceStage()) {
-            $currentStageName = $moderationStage->getCurrentStageName();
-            $nextStageName = $moderationStage->getNextStageName();
-
-            $templateMgr->assign('currentStage', $currentStageName);
-            $templateMgr->assign('nextStage', $nextStageName);
-
-            $templateMgr->registerFilter("output", array($this, 'addCheckboxesToAssignForm'));
-        }
-
-        return false;
-    }
-
-    public function addCheckboxesToAssignForm($output, $templateMgr)
-    {
-        if (preg_match('/<div[^>]+class="section formButtons/', $output, $matches, PREG_OFFSET_CAPTURE)) {
-            $posMatch = $matches[0][1];
-
-            $sentNextStageOutput = $templateMgr->fetch($this->getTemplateResource('sentNextStage.tpl'));
-
-            $output = substr_replace($output, $sentNextStageOutput, $posMatch, 0);
-            $templateMgr->unregisterFilter('output', array($this, 'addCheckboxesToAssignForm'));
-        }
-        return $output;
-    }
-
-    public function addToWorkflowTabs($hookName, $params)
-    {
-        $templateMgr = &$params[1];
-        $output = &$params[2];
-        $submission = $templateMgr->getTemplateVars('submission');
-
-        $request = Application::get()->getRequest();
-        $context = $request->getContext();
-        $faqUrl = $request->url($context->getPath()) . '/faq';
-
-        $moderationStage = new ModerationStage($submission);
-        if ($moderationStage->submissionStageExists()) {
-            $stageDates = $moderationStage->getStageEntryDates();
-            $currentStageName = $moderationStage->getCurrentStageName(false);
-
-            $templateMgr->assign([
-                ...$stageDates,
-                'submissionId' => $submission->getId(),
-                'userIsAuthor' => $this->userIsAuthor($submission),
-                'currentStage' => $currentStageName,
-                'canAdvanceStage' => $moderationStage->canAdvanceStage(),
-                'faqUrl' => $faqUrl
-            ]);
-
-            if ($moderationStage->canAdvanceStage()) {
-                $templateMgr->assign('nextStage', $moderationStage->getNextStageName());
-            }
-
-            $output .= sprintf(
-                '<tab id="scieloModerationStages" label="%s">%s</tab>',
-                __('plugins.generic.scieloModerationStages.displayNameWorkflow'),
-                $templateMgr->fetch($this->getTemplateResource('moderationStageMenu.tpl'))
-            );
-        }
-    }
-
-    public function addCurrentStageStatusToWorkflow($hookName, $params)
-    {
-        $templateMgr = &$params[1];
-        $submission = $templateMgr->getTemplateVars('submission');
-
-        if (!is_null($submission->getData('currentModerationStage'))) {
-            $moderationStage = new ModerationStage($submission);
-
-            $templateMgr->assign('currentStageName', $moderationStage->getCurrentStageName());
-            $templateMgr->registerFilter("output", [$this, 'addCurrentStageStatusToWorkflowFilter']);
-        }
-
-        return false;
-    }
-
-    public function addCurrentStageStatusToWorkflowFilter($output, $templateMgr)
-    {
-        if (preg_match('/<span[^>]+v-if="publicationList.length/', $output, $matches, PREG_OFFSET_CAPTURE)) {
-            $posMatch = $matches[0][1];
-
-            $currentStageStatus = $templateMgr->fetch($this->getTemplateResource('currentStageStatus.tpl'));
-
-            $output = substr_replace($output, $currentStageStatus, $posMatch, 0);
-            $templateMgr->unregisterFilter('output', array($this, 'addCurrentStageStatusToWorkflowFilter'));
-        }
-        return $output;
-    }
-
     public function addMessageToSubmissionComplete($hookName, $params)
     {
         $template = &$params[1];
@@ -343,7 +240,7 @@ public function getStyleSheet()
         return $this->getPluginPath() . '/styles/moderationStageStyleSheet.css';
     }
 
-    private function userIsAuthor($submission)
+    public function userIsAuthor($submission)
     {
         $currentUser = Application::get()->getRequest()->getUser();
         $currentUserAssignedRoles = array();
@@ -359,61 +256,4 @@ private function userIsAuthor($submission)
 
         return $currentUserAssignedRoles[0] == Role::ROLE_ID_AUTHOR;
     }
-
-    public function sendSubmissionToNextModerationStage($hookName, $params)
-    {
-        $request = Application::get()->getRequest();
-        $form = $params[0];
-        $requestVars = $request->getUserVars();
-
-        if ($requestVars['sendNextStage']) {
-            $submission = $form->getSubmission();
-            $moderationStage = new ModerationStage($submission);
-
-            if ($moderationStage->canAdvanceStage()) {
-                $moderationStage->sendNextStage();
-                $moderationStageRegister = new ModerationStageRegister();
-                $moderationStageRegister->registerModerationStageOnDatabase($moderationStage);
-                $moderationStageRegister->registerModerationStageOnSubmissionLog($moderationStage);
-
-                $emailBuilder = new StageAdvancementEmailBuilder();
-                $email = $emailBuilder->setSubmission($submission)
-                    ->buildEmailParams()
-                    ->build();
-                Mail::send($email);
-            }
-        }
-    }
-
-    public function hideParticipantsOnDiscussionOpening($hookName, $params)
-    {
-        $form = $params[0];
-        $request = Application::get()->getRequest();
-        $templateMgr = TemplateManager::getManager($request);
-        $allParticipants = $templateMgr->getTemplateVars('allParticipants');
-
-        $query = $form->getQuery();
-        $submission = Repo::submission()->get($query->getData('assocId'));
-
-        if ($this->userIsAuthor($submission)) {
-            $author = $request->getUser();
-            $newParticipantsList = [];
-            $allowedUsersEmails = [
-                $author->getEmail(),
-                self::SCIELO_BRASIL_EMAIL
-            ];
-
-            foreach ($allParticipants as $participantId => $participantData) {
-                $participant = Repo::user()->get($participantId);
-
-                if (in_array($participant->getEmail(), $allowedUsersEmails)) {
-                    $newParticipantsList[$participantId] = $participantData;
-                }
-            }
-
-            $templateMgr->assign('allParticipants', $newParticipantsList);
-        }
-
-        return false;
-    }
 }

classes/SchemaEditor.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace APP\plugins\generic\scieloModerationStages\classes;
+
+use PKP\plugins\Hook;
+
+class SchemaEditor
+{
+    public function editSubmissionSchema($hookName, $params)
+    {
+        $schema = &$params[0];
+        $newProperties = [
+            'currentModerationStage' => 'string',
+            'lastModerationStageChange' => 'string',
+            'formatStageEntryDate' => 'string',
+            'contentStageEntryDate' => 'string',
+            'areaStageEntryDate' => 'string'
+        ];
+
+        foreach ($newProperties as $property => $type) {
+            $schema->properties->{$property} = (object) [
+                'type' => $type,
+                'apiSummary' => true,
+                'validation' => ['nullable'],
+            ];
+        }
+
+        return Hook::CONTINUE;
+    }
+
+    public function editEventLogSchema($hookName, $params)
+    {
+        $schema = &$params[0];
+        $newProperties = [
+            'moderationStageName' => 'string',
+        ];
+
+        foreach ($newProperties as $property => $type) {
+            $schema->properties->{$property} = (object) [
+                'type' => $type,
+                'apiSummary' => true,
+                'validation' => ['nullable'],
+            ];
+        }
+
+        return Hook::CONTINUE;
+    }
+}