[PKP-LIB][main] #4860 Add JAV support to publications

api/v1/submissions/PKPSubmissionController.php

@@ -53,6 +53,7 @@
 use PKP\notification\NotificationSubscriptionSettingsDAO;
 use PKP\plugins\Hook;
 use PKP\plugins\PluginRegistry;
+use PKP\publication\enums\JavStage;
 use PKP\security\authorization\ContextAccessPolicy;
 use PKP\security\authorization\DecisionWritePolicy;
 use PKP\security\authorization\internal\SubmissionCompletePolicy;
@@ -111,7 +112,10 @@ class PKPSubmissionController extends PKPBaseController
         'getPublicationIdentifierForm',
         'getPublicationLicenseForm',
         'getPublicationTitleAbstractForm',
-        'getChangeLanguageMetadata'
+        'getChangeLanguageMetadata',
+        'getJAVStageMetadata',
+        'changeJavStageAndNumbering',
+        'getNextAvailableJavVersionNumberingForStage',
     ];
 
     /** @var array Handlers that must be authorized to write to a publication */
@@ -122,6 +126,7 @@ class PKPSubmissionController extends PKPBaseController
         'editContributor',
         'saveContributorsOrder',
         'changeLocale',
+        'changeJavStageAndNumbering'
     ];
 
     /** @var array Handlers that must be authorized to access a submission's production stage */
@@ -236,6 +241,14 @@ public function getGroupRoutes(): void
             Route::put('{submissionId}/publications/{publicationId}/changeLocale', $this->changeLocale(...))
                 ->name('submission.publication.changeLocale')
                 ->whereNumber(['submissionId', 'publicationId']);
+
+            Route::put('{submissionId}/publications/{publicationId}/changeJavStageAndNumbering', $this->changeJavStageAndNumbering(...))
+                ->name('submission.publication.changeJavStageAndNumbering')
+                ->whereNumber(['submissionId', 'publicationId']);
+
+            Route::get('{submissionId}/getNextAvailableJavVersionNumberingForStage', $this->getNextAvailableJavVersionNumberingForStage(...))
+                ->name('submission.getNextAvailableJavVersionNumberingForStage')
+                ->whereNumber(['submissionId']);
         });
 
         Route::middleware([
@@ -301,6 +314,7 @@ public function getGroupRoutes(): void
                 Route::get('reference', $this->getPublicationReferenceForm(...))->name('submission.publication._components.reference');
                 Route::get('titleAbstract', $this->getPublicationTitleAbstractForm(...))->name('submission.publication._components.titleAbstract');
                 Route::get('changeLanguageMetadata', $this->getChangeLanguageMetadata(...))->name('submission.publication._components.changeLanguageMetadata');
+                Route::get('getJAVStageMetadata', $this->getJAVStageMetadata(...))->name('submission.publication._components.getJAVStageMetadata');
             })->whereNumber(['submissionId', 'publicationId']);
         });
 
@@ -943,6 +957,68 @@ public function changeLocale(Request $illuminateRequest): JsonResponse
         return $this->edit($illuminateRequest);
     }
 
+    /**
+     * Change version stage
+     */
+    public function changeJavStageAndNumbering(Request $illuminateRequest): JsonResponse
+    {
+        $request = $this->getRequest();
+        $publication = Repo::publication()->get((int) $illuminateRequest->route('publicationId'));
+
+        if (!$publication) {
+            return response()->json([
+                'error' => __('api.404.resourceNotFound'),
+            ], Response::HTTP_NOT_FOUND);
+        }
+
+        // $submission = Repo::submission()->get((int) $illuminateRequest->route('submissionId'));
+        $submission = $this->getAuthorizedContextObject(Application::ASSOC_TYPE_SUBMISSION);
+
+        if ($submission->getId() !== $publication->getData('submissionId')) {
+            return response()->json([
+                'error' => __('api.publications.403.submissionsDidNotMatch'),
+            ], Response::HTTP_FORBIDDEN);
+        }
+
+        $params = $this->convertStringsToSchema(PKPSchemaService::SCHEMA_PUBLICATION, $illuminateRequest->input());
+
+        $submissionContext = $request->getContext();
+
+        $errors = Repo::publication()->validate($publication, $params, $submission, $submissionContext);
+
+        if (!empty($errors)) {
+            return response()->json($errors, Response::HTTP_BAD_REQUEST);
+        }
+
+        $versionStage = $params['javVersionStage'];
+        $versionStageIsMinor = (bool) $params['javVersionIsMinor'];
+
+        Repo::publication()->updateJavVersionStageAndNumbering($publication, JavStage::from($versionStage), $versionStageIsMinor);
+
+        return $this->edit($illuminateRequest);
+    }
+
+    /**
+     * Get next potential JAV version stage
+     */
+    public function getNextAvailableJavVersionNumberingForStage(Request $illuminateRequest): JsonResponse
+    {
+        $submission = $this->getAuthorizedContextObject(Application::ASSOC_TYPE_SUBMISSION);
+
+        $params = $illuminateRequest->input();
+        $potentialVersionStage = JavStage::from($params['javVersionStage']);
+        $potentialIsMinor = ($params['javVersionIsMinor'] === 'false') ? false : (bool) $params['javVersionIsMinor'];
+
+        $potentialVersionStage = $submission->getNextAvailableJavVersionNumberingForStage($potentialVersionStage, $potentialIsMinor);
+
+        $retValue = $potentialVersionStage->getVersionStageDisplay();
+
+        return response()->json(
+            $retValue,
+            Response::HTTP_OK
+        );
+    }
+
     /**
      * Get the decisions recorded on a submission
      */

classes/migration/upgrade/v3_5_0/I4860_AddJavStageDataToPublication.php

@@ -0,0 +1,59 @@
+<?php
+
+/**
+ * @file classes/migration/upgrade/v3_5_0/I4860_AddJavStageDataToPublication.php
+ *
+ * Copyright (c) 2024 Simon Fraser University
+ * Copyright (c) 2024 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class I4860_AddJavStageDataToPublication
+ *
+ * @brief Add columns for JAV Versioning and migrate existing data
+ */
+
+namespace PKP\migration\upgrade\v3_5_0;
+
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\Schema;
+use PKP\migration\Migration;
+use PKP\publication\enums\JavStage;
+use PKP\publication\helpers\JavStageAndNumbering;
+
+class I4860_AddJavStageDataToPublication extends Migration
+{
+    /**
+     * Run the migration.
+     */
+    public function up(): void
+    {
+        Schema::table('publications', function (Blueprint $table) {
+            // Adding the enum column for VersionStage
+            $table->enum('jav_version_stage', array_column(JavStage::cases(), 'value'))
+                ->default(JavStage::VERSION_OF_RECORD);
+
+            // Adding minorVersion and majorVersion as integers
+            $table->integer('jav_version_minor')
+                ->default(JavStageAndNumbering::JAV_DEFAULT_NUMBERING_MINOR);
+
+            $table->integer('jav_version_major')
+                ->default(JavStageAndNumbering::JAV_DEFAULT_NUMBERING_MAJOR);
+        });
+
+        // Update the version_major column based on the version column
+        DB::table('publications')->update([
+            'jav_version_major' => DB::raw('version')
+        ]);
+    }
+
+    /**
+     * Reverses the migration
+     */
+    public function down(): void
+    {
+        Schema::table('publications', function (Blueprint $table) {
+            $table->dropColumn(['jav_version_stage', 'jav_version_minor', 'jav_version_major']);
+        });
+    }
+}

classes/publication/PKPPublication.php

@@ -23,7 +23,8 @@
 use PKP\core\Core;
 use PKP\core\PKPString;
 use PKP\facades\Locale;
-use PKP\i18n\LocaleMetadata;
+use PKP\publication\enums\JavStage;
+use PKP\publication\helpers\JavStageAndNumbering;
 use PKP\services\PKPSchemaService;
 use PKP\userGroup\UserGroup;
 
@@ -470,6 +471,50 @@ public function getLanguages(?array ...$additionalLocales): array
             ->values()
             ->toArray();
     }
+
+    /**
+     * Get the JAV string that describes the 
+     * given publication.
+     */
+    public function getJavStageAndNumberingDisplay(): ?string 
+    {
+        $currentVersionStage = $this->getCurrentVersionStage();
+        if (!isset($currentVersionStage)) {
+            return null;
+        }
+
+        return $currentVersionStage->getVersionStageDisplay();
+    }
+
+    /**
+     * Get the current JAV stage object that describes the 
+     * given publication version.
+     */
+    public function getCurrentVersionStage(): ?JavStageAndNumbering 
+    {
+        $versionStageStr = $this->getData('javVersionStage');
+        if (!isset($versionStageStr)) {
+            return null;
+        }
+
+        $versionStage = new JavStageAndNumbering();
+        $versionStage->javStage = JavStage::from($versionStageStr);
+        $versionStage->javVersionMajor = $this->getData('javVersionMajor');
+        $versionStage->javVersionMinor = $this->getData('javVersionMinor');
+
+        return $versionStage;
+    }
+
+    /**
+     * Set the current JAV stage of the publication 
+     * given a JavStageAndNumbering object
+     */
+    public function setVersionStage(JavStageAndNumbering $versionStage): void
+    {
+        $this->setData('javVersionStage', $versionStage->javStage->value);
+        $this->setData('javVersionMajor', $versionStage->javVersionMajor);
+        $this->setData('javVersionMinor', $versionStage->javVersionMinor);
+    }
 }
 if (!PKP_STRICT_MODE) {
     class_alias('\PKP\publication\PKPPublication', '\PKPPublication');

classes/publication/Repository.php

@@ -32,6 +32,7 @@
 use PKP\observers\events\PublicationUnpublished;
 use PKP\orcid\OrcidManager;
 use PKP\plugins\Hook;
+use PKP\publication\enums\JavStage;
 use PKP\security\Validation;
 use PKP\services\PKPSchemaService;
 use PKP\submission\Genre;
@@ -335,6 +336,19 @@ public function version(Publication $publication): int
         $newPublication->setData('datePublished', null);
         $newPublication->setData('status', Submission::STATUS_QUEUED);
         $newPublication->setData('version', $publication->getData('version') + 1);
+
+        // VersionStage Update
+        $currentVersionStage = $newPublication->getCurrentVersionStage();
+
+        if (isset($currentVersionStage)) {
+            $submission = Repo::submission()->get($publication->getData('submissionId'));
+
+            $newVersionStage = $submission->getNextAvailableJavVersionNumberingForStage($currentVersionStage->javStage);
+            $newPublication->setVersionStage($newVersionStage);
+
+            $newPublication->setData('versionDescription', null);
+        }
+
         $newPublication->stampModified();
 
         $request = Application::get()->getRequest();
@@ -380,8 +394,6 @@ public function version(Publication $publication): int
 
         Hook::call('Publication::version', [&$newPublication, $publication]);
 
-        $submission = Repo::submission()->get($newPublication->getData('submissionId'));
-
         $eventLog = Repo::eventLog()->newDataObject([
             'assocType' => PKPApplication::ASSOC_TYPE_SUBMISSION,
             'assocId' => $submission->getId(),
@@ -662,6 +674,37 @@ public function delete(Publication $publication)
         Hook::call('Publication::delete', [&$publication]);
     }
 
+    /**
+     * Given a JAV Stage and a flag of whether the Version isMinor, 
+     * the publication's related data is being updated
+     *
+     * @hook 'Publication::updateJavVersionStageAndNumbering::before' [[ &$newPublication, $publication ]]
+     */
+    public function updateJavVersionStageAndNumbering(Publication $publication, JavStage $versioningStage, bool $isMinor = true): Publication
+    {
+        $submission = Repo::submission()->get($publication->getData('submissionId'));
+        $nextAvailableVersionStage = $submission->getNextAvailableJavVersionNumberingForStage($versioningStage, $isMinor);
+
+        $newPublication = clone $publication;
+        $newPublication->setData('javVersionIsMinor', $isMinor);
+        $newPublication->setVersionStage($nextAvailableVersionStage);
+
+        $newPublication->stampModified();
+        Hook::call(
+            'Publication::updateJavVersionStageAndNumbering::before',
+            [
+                &$newPublication,
+                $publication
+            ]
+        );
+
+        $this->dao->update($newPublication);
+
+        $newPublication = Repo::publication()->get($newPublication->getId());
+
+        return $newPublication;
+    }
+
     /**
      * Handle a publication setting for an uploaded file
      *

classes/publication/enums/JavStage.php

@@ -0,0 +1,24 @@
+<?php
+
+/**
+ * @file publication/enums/JavStage.php
+ *
+ * Copyright (c) 2023-2024 Simon Fraser University
+ * Copyright (c) 2023-2024 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class JavStage
+ *
+ * @brief Enumeration for JAV versioning stages
+ */
+
+namespace PKP\publication\enums;
+
+enum JavStage: string
+{
+    case AUTHOR_ORIGINAL = 'AO';
+    case ACCEPTED_MANUSCRIPT = 'AM';
+    case SUBMITTED_MANUSCRIPT = 'SM';
+    case PROOF = 'PF';
+    case VERSION_OF_RECORD = 'VoR';
+}

classes/publication/helpers/JavStageAndNumbering.php

@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * @file classes/publication/JavStageAndNumbering.php
+ *
+ * Copyright (c) 2016-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 JavStageAndNumbering
+ *
+ * @brief Base class for JavStageAndNumbering.
+ */
+
+namespace PKP\publication\helpers;
+
+use PKP\publication\enums\JavStage;
+
+class JavStageAndNumbering extends \PKP\core\DataObject
+{
+    public const JAV_DEFAULT_NUMBERING_MINOR = 0;
+    public const JAV_DEFAULT_NUMBERING_MAJOR = 1;
+
+    public JavStage $javStage;
+    public int $javVersionMajor;
+    public int $javVersionMinor;
+
+    public function getVersionStageDisplay(): string 
+    {
+        $versionStageValue = $this->javStage->value;
+
+        return "$versionStageValue $this->javVersionMajor.$this->javVersionMinor";
+    }
+}
+

classes/publication/maps/Schema.php

@@ -156,6 +156,9 @@ function ($citation) {
                 case 'fullTitle':
                     $output[$prop] = $publication->getFullTitles('html');
                     break;
+                case 'javStageDisplay':
+                    $output[$prop] = $publication->getJavStageAndNumberingDisplay();
+                    break;
                 default:
                     $output[$prop] = $publication->getData($prop);
                     break;