From caa2e7676b3ccb6ba13974600ed293376f805b0e Mon Sep 17 00:00:00 2001
From: Touhidur Rahman <abir.ruet@gmail.com>
Date: Mon, 29 Aug 2022 17:06:28 +0600
Subject: [PATCH] pkp/pkp-lib#7725 editorial decision constants synced up

---
 classes/decision/Decision.php                 |  42 ----
 classes/decision/types/Accept.php             |   2 +-
 classes/decision/types/SkipExternalReview.php |   2 +-
 .../v3_4_0/I7725_DecisionConstantsUpdate.php  | 207 ++++++++++++++++++
 dbscripts/xml/upgrade.xml                     |   1 +
 .../datacite/filter/DataciteXmlFilter.php     |   2 +-
 .../pubmed/filter/ArticlePubMedXmlFilter.php  |   2 +-
 .../reports/articles/ArticleReportPlugin.php  |   2 +-
 8 files changed, 213 insertions(+), 47 deletions(-)
 delete mode 100644 classes/decision/Decision.php
 create mode 100644 classes/migration/upgrade/v3_4_0/I7725_DecisionConstantsUpdate.php

diff --git a/classes/decision/Decision.php b/classes/decision/Decision.php
deleted file mode 100644
index 16c824357f0..00000000000
--- a/classes/decision/Decision.php
+++ /dev/null
@@ -1,42 +0,0 @@
-<?php
-
-/**
- * @defgroup decision Decision
- */
-
-/**
- * @file classes/decision/Decision.inc.php
- *
- * Copyright (c) 2014-2022 Simon Fraser University
- * Copyright (c) 2000-2022 John Willinsky
- * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
- *
- * @class Decision
- * @ingroup decision
- *
- * @see DAO
- *
- * @brief An editorial decision taken on a submission, such as to accept, decline or request revisions.
- */
-
-namespace APP\decision;
-
-use PKP\decision\Decision as BaseDecision;
-
-class Decision extends BaseDecision
-{
-    public const ACCEPT = 1;
-    public const PENDING_REVISIONS = 2;
-    public const RESUBMIT = 3;
-    public const DECLINE = 4;
-    public const EXTERNAL_REVIEW = 8;
-}
-
-if (!PKP_STRICT_MODE) {
-    // Some constants are not redefined here because they never existed as global constants
-    define('SUBMISSION_EDITOR_DECISION_EXTERNAL_REVIEW', Decision::EXTERNAL_REVIEW);
-    define('SUBMISSION_EDITOR_DECISION_ACCEPT', Decision::ACCEPT);
-    define('SUBMISSION_EDITOR_DECISION_DECLINE', Decision::DECLINE);
-    define('SUBMISSION_EDITOR_DECISION_PENDING_REVISIONS', Decision::PENDING_REVISIONS);
-    define('SUBMISSION_EDITOR_DECISION_RESUBMIT', Decision::RESUBMIT);
-}
diff --git a/classes/decision/types/Accept.php b/classes/decision/types/Accept.php
index 43348bc333d..c099167af17 100644
--- a/classes/decision/types/Accept.php
+++ b/classes/decision/types/Accept.php
@@ -14,11 +14,11 @@
 namespace APP\decision\types;
 
 use APP\core\Application;
-use APP\decision\Decision;
 use APP\decision\types\traits\RequestPayment;
 use APP\submission\Submission;
 use Illuminate\Validation\Validator;
 use PKP\context\Context;
+use PKP\decision\Decision;
 use PKP\decision\Steps;
 use PKP\decision\types\Accept as TypesAccept;
 use PKP\submission\reviewRound\ReviewRound;
diff --git a/classes/decision/types/SkipExternalReview.php b/classes/decision/types/SkipExternalReview.php
index 376021a596e..3149148b03e 100644
--- a/classes/decision/types/SkipExternalReview.php
+++ b/classes/decision/types/SkipExternalReview.php
@@ -13,11 +13,11 @@
 
 namespace APP\decision\types;
 
-use APP\decision\Decision;
 use APP\decision\types\traits\RequestPayment;
 use APP\submission\Submission;
 use Illuminate\Validation\Validator;
 use PKP\context\Context;
+use PKP\decision\Decision;
 use PKP\decision\types\SkipExternalReview as PKPSkipExternalReview;
 use PKP\user\User;
 
diff --git a/classes/migration/upgrade/v3_4_0/I7725_DecisionConstantsUpdate.php b/classes/migration/upgrade/v3_4_0/I7725_DecisionConstantsUpdate.php
new file mode 100644
index 00000000000..842fd67dada
--- /dev/null
+++ b/classes/migration/upgrade/v3_4_0/I7725_DecisionConstantsUpdate.php
@@ -0,0 +1,207 @@
+<?php
+
+/**
+ * @file classes/migration/upgrade/v3_4_0/I7725_DecisionConstantsUpdate.inc.php
+ *
+ * Copyright (c) 2014-2022 Simon Fraser University
+ * Copyright (c) 2000-2022 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class I7725_DecisionConstantsUpdate
+ * @brief Editorial decision constant sync up accross all application
+ *
+ * @see https://github.com/pkp/pkp-lib/issues/7725
+ */
+
+namespace APP\migration\upgrade\v3_4_0;
+
+use Illuminate\Support\Facades\DB;
+use PKP\migration\Migration;
+use Throwable;
+
+class I7725_DecisionConstantsUpdate extends Migration
+{
+    /**
+     * Updated decision constant value mapping
+     *
+     * @var array
+     */
+    protected $decisionMappings = [
+        // \PKP\decision\Decision::ACCEPT
+        [
+            'stage_id' => [WORKFLOW_STAGE_ID_EDITING],
+            'current_value' => 1,
+            'updated_value' => 2,
+        ],
+
+        // \PKP\decision\Decision::EXTERNAL_REVIEW
+        [
+            'stage_id' => [WORKFLOW_STAGE_ID_EXTERNAL_REVIEW],
+            'current_value' => 8,
+            'updated_value' => 3,
+        ],
+
+        // \PKP\decision\Decision::PENDING_REVISIONS
+        [
+            'stage_id' => [WORKFLOW_STAGE_ID_EXTERNAL_REVIEW],
+            'current_value' => 2,
+            'updated_value' => 4,
+        ],
+
+        // \PKP\decision\Decision::RESUBMIT
+        [
+            'stage_id' => [WORKFLOW_STAGE_ID_EXTERNAL_REVIEW],
+            'current_value' => 3,
+            'updated_value' => 5,
+        ],
+
+        // \PKP\decision\Decision::DECLINE
+        [
+            'stage_id' => [WORKFLOW_STAGE_ID_EXTERNAL_REVIEW],
+            'current_value' => 4,
+            'updated_value' => 6,
+        ],
+
+        // \PKP\decision\Decision::INITIAL_DECLINE
+        [
+            'stage_id' => [WORKFLOW_STAGE_ID_SUBMISSION],
+            'current_value' => 9,
+            'updated_value' => 8,
+        ],
+
+        // \PKP\decision\Decision::RECOMMEND_ACCEPT
+        [
+            'stage_id' => [WORKFLOW_STAGE_ID_EXTERNAL_REVIEW],
+            'current_value' => 11,
+            'updated_value' => 9,
+        ],
+
+        // \PKP\decision\Decision::RECOMMEND_PENDING_REVISIONS
+        [
+            'stage_id' => [WORKFLOW_STAGE_ID_EXTERNAL_REVIEW],
+            'current_value' => 12,
+            'updated_value' => 10,
+        ],
+
+        // \PKP\decision\Decision::RECOMMEND_RESUBMIT
+        [
+            'stage_id' => [WORKFLOW_STAGE_ID_EXTERNAL_REVIEW],
+            'current_value' => 13,
+            'updated_value' => 11,
+        ],
+
+        // \PKP\decision\Decision::RECOMMEND_DECLINE
+        [
+            'stage_id' => [WORKFLOW_STAGE_ID_EXTERNAL_REVIEW],
+            'current_value' => 14,
+            'updated_value' => 12,
+        ],
+
+        // \PKP\decision\Decision::NEW_EXTERNAL_ROUND
+        [
+            'stage_id' => [WORKFLOW_STAGE_ID_EXTERNAL_REVIEW],
+            'current_value' => 16,
+            'updated_value' => 14,
+        ],
+
+        // \PKP\decision\Decision::REVERT_DECLINE
+        [
+            'stage_id' => [WORKFLOW_STAGE_ID_EXTERNAL_REVIEW],
+            'current_value' => 17,
+            'updated_value' => 15,
+        ],
+
+        // \PKP\decision\Decision::REVERT_INITIAL_DECLINE
+        [
+            'stage_id' => [WORKFLOW_STAGE_ID_SUBMISSION],
+            'current_value' => 18,
+            'updated_value' => 16
+        ],
+
+        // \PKP\decision\Decision::SKIP_EXTERNAL_REVIEW
+        [
+            'stage_id' => [WORKFLOW_STAGE_ID_EDITING],
+            'current_value' => 19,
+            'updated_value' => 17,
+        ],
+
+        // \PKP\decision\Decision::BACK_FROM_PRODUCTION
+        [
+            'stage_id' => [WORKFLOW_STAGE_ID_EDITING],
+            'current_value' => 31,
+            'updated_value' => 29,
+        ],
+
+        // \PKP\decision\Decision::BACK_FROM_COPYEDITING
+        [
+            'stage_id' => [WORKFLOW_STAGE_ID_SUBMISSION, WORKFLOW_STAGE_ID_EXTERNAL_REVIEW],
+            'current_value' => 32,
+            'updated_value' => 30,
+        ],
+
+        // \PKP\decision\Decision::CANCEL_REVIEW_ROUND
+        [
+            'stage_id' => [WORKFLOW_STAGE_ID_SUBMISSION, WORKFLOW_STAGE_ID_EXTERNAL_REVIEW],
+            'current_value' => 33,
+            'updated_value' => 31,
+        ],
+    ];
+
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        try {
+            DB::beginTransaction();
+
+            collect($this->decisionMappings)
+                ->each(
+                    fn ($decisionMapping) => DB::table('edit_decisions')
+                        ->when(
+                            isset($decisionMapping['stage_id']) && !empty($decisionMapping['stage_id']),
+                            fn ($query) => $query->whereIn('stage_id', $decisionMapping['stage_id'])
+                        )
+                        ->where('decision', $decisionMapping['current_value'])
+                        ->update([
+                            'decision' => $decisionMapping['updated_value'],
+                        ])
+                );
+
+            DB::commit();
+        } catch (Throwable $exception) {
+            DB::rollBack();
+
+            error_log($exception->__toString());
+        }
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        try {
+            DB::beginTransaction();
+
+            collect($this->decisionMappings)
+                ->each(
+                    fn ($decisionMapping) => DB::table('edit_decisions')
+                        ->when(
+                            isset($decisionMapping['stage_id']) && !empty($decisionMapping['stage_id']),
+                            fn ($query) => $query->whereIn('stage_id', $decisionMapping['stage_id'])
+                        )
+                        ->where('decision', $decisionMapping['updated_value'])
+                        ->update([
+                            'decision' => $decisionMapping['current_value'],
+                        ])
+                );
+
+            DB::commit();
+        } catch (Throwable $exception) {
+            DB::rollBack();
+
+            error_log($exception->__toString());
+        }
+    }
+}
diff --git a/dbscripts/xml/upgrade.xml b/dbscripts/xml/upgrade.xml
index 121ed7fc353..fde63e32d2e 100644
--- a/dbscripts/xml/upgrade.xml
+++ b/dbscripts/xml/upgrade.xml
@@ -174,6 +174,7 @@
 		<migration class="APP\migration\upgrade\v3_4_0\I7901_Duplicate_OAI_IDs"/>
 		<migration class="PKP\migration\upgrade\v3_4_0\I7366_UpdateUserAPIKeySettings"/>
 		<migration class="PKP\migration\upgrade\v3_4_0\I8093_UpdateUserGroupRelationTablesFK"/>
+		<migration class="APP\migration\upgrade\v3_4_0\I7725_DecisionConstantsUpdate"/>
 		<data file="dbscripts/xml/upgrade/3.4.0_preupdate_email_templates.xml" />
 		<code function="installEmailTemplate" key="EDITOR_DECISION_NOTIFY_OTHER_AUTHORS" locales="en_US" />
 		<code function="installEmailTemplate" key="EDITOR_DECISION_NEW_ROUND" locales="en_US" />
diff --git a/plugins/generic/datacite/filter/DataciteXmlFilter.php b/plugins/generic/datacite/filter/DataciteXmlFilter.php
index 9e826ba46a7..1e969ef417d 100644
--- a/plugins/generic/datacite/filter/DataciteXmlFilter.php
+++ b/plugins/generic/datacite/filter/DataciteXmlFilter.php
@@ -15,12 +15,12 @@
 
 use APP\core\Application;
 use APP\core\Services;
-use APP\decision\Decision;
 use APP\facades\Repo;
 use APP\issue\Issue;
 use APP\submission\Submission;
 use PKP\core\PKPString;
 use PKP\db\DAORegistry;
+use PKP\decision\Decision;
 use PKP\facades\Locale;
 use PKP\galley\Galley;
 use PKP\i18n\LocaleConversion;
diff --git a/plugins/importexport/pubmed/filter/ArticlePubMedXmlFilter.php b/plugins/importexport/pubmed/filter/ArticlePubMedXmlFilter.php
index b3a90d700b8..8a2275772e4 100644
--- a/plugins/importexport/pubmed/filter/ArticlePubMedXmlFilter.php
+++ b/plugins/importexport/pubmed/filter/ArticlePubMedXmlFilter.php
@@ -14,13 +14,13 @@
 namespace APP\plugins\importexport\pubmed\filter;
 
 use APP\author\Author;
-use APP\decision\Decision;
 use APP\facades\Repo;
 use APP\issue\Issue;
 use APP\journal\Journal;
 use APP\submission\Submission;
 use PKP\core\PKPString;
 use PKP\db\DAORegistry;
+use PKP\decision\Decision;
 use PKP\filter\PersistableFilter;
 use PKP\i18n\LocaleConversion;
 
diff --git a/plugins/reports/articles/ArticleReportPlugin.php b/plugins/reports/articles/ArticleReportPlugin.php
index 46ce8fbc0ee..81fa4103ac5 100644
--- a/plugins/reports/articles/ArticleReportPlugin.php
+++ b/plugins/reports/articles/ArticleReportPlugin.php
@@ -15,11 +15,11 @@
 
 namespace APP\plugins\reports\articles;
 
-use APP\decision\Decision;
 use APP\facades\Repo;
 use APP\i18n\AppLocale;
 use PKP\core\PKPString;
 use PKP\db\DAORegistry;
+use PKP\decision\Decision;
 use PKP\plugins\ReportPlugin;
 use PKP\security\Role;
 use PKP\submission\PKPSubmission;