pkp#10537 Add available editorial decisions to submission's stages data

forgive38 · Oct 24, 2024 · af501d2 · af501d2
1 parent 9e75633
commit af501d2
Show file tree

Hide file tree

Showing 2 changed files with 92 additions and 7 deletions.
diff --git a/classes/submission/maps/Schema.php b/classes/submission/maps/Schema.php
@@ -20,9 +20,9 @@
 use Illuminate\Support\Enumerable;
 use Illuminate\Support\LazyCollection;
 use PKP\db\DAORegistry;
+use PKP\decision\DecisionType;
 use PKP\plugins\Hook;
 use PKP\plugins\PluginRegistry;
-use PKP\query\Query;
 use PKP\security\Role;
 use PKP\services\PKPSchemaService;
 use PKP\stageAssignment\StageAssignment;
@@ -31,6 +31,7 @@
 use PKP\submission\reviewRound\ReviewRound;
 use PKP\submission\reviewRound\ReviewRoundDAO;
 use PKP\submissionFile\SubmissionFile;
+use PKP\user\User;
 use PKP\userGroup\UserGroup;
 use PKP\workflow\WorkflowStageDAO;
 
@@ -527,7 +528,7 @@ public function getPropertyStages(Submission $submission): array
             $currentUserAssignedRoles = [];
             $stageAssignmentsOverview = [];
             if ($currentUser) {
-                // FIXME - $stageAssignments are just temporarly added until https://github.com/pkp/pkp-lib/issues/10480 is ready
+                // FIXME - $stageAssignments are just temporarily added until https://github.com/pkp/pkp-lib/issues/10480 is ready
                 $currentRoles = array_map(
                     function (Role $role) {
                         return $role->getId();
@@ -556,10 +557,10 @@ function (Role $role) {
                 foreach ($stageAssignments as $stageAssignment) {
                     $userGroup = Repo::userGroup()->get($stageAssignment->userGroupId);
                     $stageAssignmentsOverview[] = [
-                        "roleId" => $userGroup->getRoleId(),
-                        "recommendOnly" => $stageAssignment->recommendOnly,
-                        "canChangeMetadata" => $stageAssignment->canChangeMetadata,
-                        "userId" => $stageAssignment->userId
+                        'roleId' => $userGroup->getRoleId(),
+                        'recommendOnly' => $stageAssignment->recommendOnly,
+                        'canChangeMetadata' => $stageAssignment->canChangeMetadata,
+                        'userId' => $stageAssignment->userId
                     ];
                 }
             }
@@ -568,7 +569,7 @@ function (Role $role) {
             $stage['stageAssignments'] = $stageAssignmentsOverview;
             if(!$stage['currentUserAssignedRoles']) {
                 if(in_array(Role::ROLE_ID_MANAGER, $currentRoles)) {
-                     $stage['currentUserAssignedRoles'][] = Role::ROLE_ID_MANAGER;
+                    $stage['currentUserAssignedRoles'][] = Role::ROLE_ID_MANAGER;
                 }
             }
             // Stage-specific statuses
@@ -649,6 +650,10 @@ function (Role $role) {
                     break;
             }
 
+
+            $availableEditorialDecisions = $this->getAvailableEditorialDecisions($stageId, $submission);
+            $stage['availableEditorialDecisions'] = array_map(fn (DecisionType $decisionType) => ['id' => $decisionType->getDecision(), 'label' => $decisionType->getLabel()], $availableEditorialDecisions);
+
             $stages[] = $stage;
         }
 
@@ -722,4 +727,69 @@ protected function appSpecificProps(): array
     {
         return [];
     }
+
+    /**
+     * Implement by a child class to get available editorial decisions data for a stage of a submission.
+     */
+    protected function getAvailableEditorialDecisions(int $stageId, Submission $submission): array
+    {
+        return [];
+    }
+
+    /**
+     * Check if a user can make Decisions or Recommendations on a submission's stage
+    */
+    protected function checkDecisionPermissions(int $stageId, Submission $submission, User $user, int $contextId): array
+    {
+        /** @var StageAssignment[] $editorsStageAssignments*/
+        $editorsStageAssignments = StageAssignment::withSubmissionIds([$submission->getId()])
+            ->withStageIds([$stageId])
+            ->withRoleIds([Role::ROLE_ID_MANAGER, Role::ROLE_ID_SUB_EDITOR])
+            ->withUserId($user->getId())
+            ->get();
+
+        $makeRecommendation = $makeDecision = false;
+        // if the user is assigned several times in an editorial role, check his/her assignments permissions i.e.
+        // if the user is assigned with both possibilities: to only recommend as well as make decision
+        foreach ($editorsStageAssignments as $editorsStageAssignment) {
+            if (!$editorsStageAssignment->recommendOnly) {
+                $makeDecision = true;
+            } else {
+                $makeRecommendation = true;
+            }
+        }
+
+        // If user is not assigned to the submission,
+        // see if the user is manager, and
+        // if the group is recommendOnly
+        if (!$makeRecommendation && !$makeDecision) {
+            $userGroups = Repo::userGroup()->userUserGroups($user->getId(), $contextId);
+            foreach ($userGroups as $userGroup) {
+                if (in_array($userGroup->getRoleId(), [Role::ROLE_ID_MANAGER, Role::ROLE_ID_SITE_ADMIN])) {
+                    if (!$userGroup->getRecommendOnly()) {
+                        $makeDecision = true;
+                    } else {
+                        $makeRecommendation = true;
+                    }
+                }
+            }
+        }
+
+        // if the user can make recommendations, check whether there are any decisions that can be made given
+        // the stage that we are operating into.
+        $isOnlyRecommending = $makeRecommendation && !$makeDecision;
+
+        if ($isOnlyRecommending) {
+            if (!empty(Repo::decision()->getDecisionTypesMadeByRecommendingUsers($stageId))) {
+                // If there are any, then the user can be considered a decision user.
+                $makeDecision = true;
+            }
+        }
+
+        return [
+            'canMakeDecision' => $makeDecision,
+            'canMakeRecommendation' => $makeRecommendation,
+            'isOnlyRecommending' => $isOnlyRecommending
+        ];
+    }
 }
diff --git a/schemas/submission.json b/schemas/submission.json
@@ -265,6 +265,21 @@
 								"type": "boolean"
 							}
 						}
+					},
+					"availableEditorialDecisions": {
+						"description": "The editorial decisions that are available for this stage.",
+						"type": "array",
+						"items": {
+							"type": "object",
+							"properties": {
+								"id": {
+									"type": "integer"
+								},
+								"label": {
+									"type": "string"
+								}
+							}
+						}
 					}
 				}
 			}