pkp/pkp-lib#9425 Make submission language selection and metadata form…

…s independent from website language settings
jyhein · Oct 31, 2023 · f7f6525 · f7f6525
1 parent 528f732
commit f7f6525
Show file tree

Hide file tree

Showing 11 changed files with 71 additions and 19 deletions.
diff --git a/api/v1/_submissions/BackendSubmissionsController.php b/api/v1/_submissions/BackendSubmissionsController.php
@@ -175,8 +175,8 @@ public function addToCatalog(Request $illuminateRequest): JsonResponse
             ], Response::HTTP_BAD_REQUEST);
         }
 
-        $primaryLocale = $this->getRequest()->getContext()->getPrimaryLocale();
-        $allowedLocales = $this->getRequest()->getContext()->getSupportedFormLocales();
+        $submissionLocale = $submission->getData('locale');
+        $supportedMetadataLocales = $this->getRequest()->getContext()->getSupportedSubmissionMetadataLocales();
 
         $validPublications = [];
         foreach ($submissionIds as $submissionId) {
@@ -193,9 +193,8 @@ public function addToCatalog(Request $illuminateRequest): JsonResponse
             if ($publication->getData('status') === Submission::STATUS_PUBLISHED) {
                 continue;
             }
-
-            $errors = Repo::publication()->validatePublish($publication, $submission, $allowedLocales, $primaryLocale);
-
+            $allowedLocales = $publication->getLanguages($supportedMetadataLocales);
+            $errors = Repo::publication()->validatePublish($publication, $submission, $allowedLocales, $submissionLocale);
             if (!empty($errors)) {
                 return response()->json($errors, Response::HTTP_BAD_REQUEST);
             }

diff --git a/api/v1/vocabs/VocabController.php b/api/v1/vocabs/VocabController.php
@@ -19,6 +19,7 @@
 
 use APP\codelist\ONIXCodelistItemDAO;
 use APP\core\Application;
+use APP\facades\Repo;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
 use Illuminate\Http\Response;
@@ -50,8 +51,9 @@ public function getMany(Request $illuminateRequest): JsonResponse
         $locale = $requestParams['locale'] ?? Locale::getLocale();
         $term = $requestParams['term'] ?? null;
         $codeList = (int) ($requestParams['codeList'] ?? static::LANGUAGE_CODE_LIST);
+        $locales = array_merge($context->getSupportedSubmissionMetadataLocales(), isset($requestParams['publicationId']) ? Repo::publication()->get((int) $requestParams['publicationId'])?->getLanguages() ?? [] : []);
 
-        if (!in_array($locale, $context->getData('supportedSubmissionLocales'))) {
+        if (!in_array($locale, $locales)) {
             return response()->json([
                 'error' => __('api.vocabs.400.localeNotSupported', ['locale' => $locale]),
             ], Response::HTTP_BAD_REQUEST);

diff --git a/classes/components/listPanels/CatalogListPanel.php b/classes/components/listPanels/CatalogListPanel.php
@@ -138,8 +138,10 @@ public function getConfig()
             'submissions'
         );
 
-        $locales = $context->getSupportedFormLocaleNames();
-        $locales = array_map(fn (string $locale, string $name) => ['key' => $locale, 'label' => $name], array_keys($locales), $locales);
+        $locales = collect($context->getSupportedSubmissionMetadataLocaleNames())
+            ->map(fn (string $locale, string $name) => ['key' => $locale, 'label' => $name])
+            ->values()
+            ->toArray();
         $addEntryForm = new \APP\components\forms\catalog\AddEntryForm($addEntryApiUrl, $searchSubmissionsApiUrl, $locales);
         $config['addEntryForm'] = $addEntryForm->getConfig();
 
@@ -150,7 +152,6 @@ public function getConfig()
             'ASSOC_TYPE_SERIES' => Application::ASSOC_TYPE_SERIES,
         ]);
 
-
         return $config;
     }
 }
diff --git a/classes/migration/upgrade/v3_5_0/I9425_SeparateUIAndSubmissionLocales.php b/classes/migration/upgrade/v3_5_0/I9425_SeparateUIAndSubmissionLocales.php
@@ -0,0 +1,31 @@
+<?php
+
+/**
+ * @file classes/migration/upgrade/v3_5_0/I9425_SeparateUIAndSubmissionLocales.php
+ *
+ * Copyright (c) 2023 Simon Fraser University
+ * Copyright (c) 2023 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class I9425_SeparateUIAndSubmissionLocales
+ *
+ * @brief pkp/pkp-lib#9425 Make submission language selection and metadata forms independent from website language settings
+ */
+
+namespace APP\migration\upgrade\v3_5_0;
+
+class I9425_SeparateUIAndSubmissionLocales extends \PKP\migration\upgrade\v3_5_0\I9425_SeparateUIAndSubmissionLocales
+{
+    protected function getContextTable(): string
+    {
+        return 'presses';
+    }
+    protected function getContextSettingsTable(): string
+    {
+        return 'press_settings';
+    }
+    protected function getContextIdColumn(): string
+    {
+        return 'press_id';
+    }
+}
diff --git a/classes/publication/Repository.php b/classes/publication/Repository.php
@@ -77,7 +77,7 @@ public function add(Publication $publication): int
                 $submissionContext = Services::get('context')->get($submission->getData('contextId'));
             }
 
-            $supportedLocales = $submissionContext->getSupportedSubmissionLocales();
+            $supportedLocales = $publication->getLanguages($submissionContext->getSupportedSubmissionMetadataLocales());
             foreach ($supportedLocales as $localeKey) {
                 if (!array_key_exists($localeKey, $publication->getData('coverImage'))) {
                     continue;

diff --git a/classes/publication/maps/Schema.php b/classes/publication/maps/Schema.php
@@ -96,7 +96,9 @@ function ($publicationFormat) use ($submissionFiles, $genres) {
             );
         }
 
-        $output = $this->schemaService->addMissingMultilingualValues(PKPSchemaService::SCHEMA_PUBLICATION, $output, $this->context->getSupportedSubmissionLocales());
+        $locales = $publication->getLanguages($this->context->getSupportedSubmissionMetadataLocales());
+
+        $output = $this->schemaService->addMissingMultilingualValues(PKPSchemaService::SCHEMA_PUBLICATION, $output, $locales);
 
         ksort($output);
 

diff --git a/classes/submission/maps/Schema.php b/classes/submission/maps/Schema.php
@@ -59,7 +59,13 @@ protected function mapByProperties(array $props, Submission $submission): array
             $output['newRelease'] = $newReleaseDao->getNewReleaseAll($submission->getId());
         }
 
-        $output = $this->schemaService->addMissingMultilingualValues($this->schemaService::SCHEMA_SUBMISSION, $output, $this->context->getSupportedSubmissionLocales());
+        $locales = $this->context->getSupportedSubmissionMetaDataLocales();
+
+        if (!in_array($primaryLocale = $submission->getData('locale'), $locales)) {
+            $locales[] = $primaryLocale;
+        }
+
+        $output = $this->schemaService->addMissingMultilingualValues($this->schemaService::SCHEMA_SUBMISSION, $output, $locales);
 
         ksort($output);
 

diff --git a/controllers/grid/catalogEntry/form/PublicationFormatForm.php b/controllers/grid/catalogEntry/form/PublicationFormatForm.php
@@ -48,7 +48,8 @@ class PublicationFormatForm extends Form
      */
     public function __construct($monograph, $publicationFormat, $publication)
     {
-        parent::__construct('controllers/grid/catalogEntry/form/formatForm.tpl');
+        $localeNames = Application::get()->getRequest()->getContext()->getSupportedSubmissionMetadataLocaleNames() + $publication->getLanguageNames();
+        parent::__construct('controllers/grid/catalogEntry/form/formatForm.tpl', true, $publication->getData('locale'), $localeNames);
         $this->setMonograph($monograph);
         $this->setPublicationFormat($publicationFormat);
         $this->setPublication($publication);

diff --git a/cypress/tests/data/10-ApplicationSetup/20-CreateContext.cy.js b/cypress/tests/data/10-ApplicationSetup/20-CreateContext.cy.js
@@ -70,8 +70,13 @@ describe('Data suite tests', function() {
 		cy.get('#appearance [role="status"]').contains('Saved');
 
 		cy.get('button[id="languages-button"]').click();
-		cy.get('input[id^=select-cell-fr_CA-submissionLocale]').click();
-		cy.contains('Locale settings saved.');
+		cy.get('input[id^="select-cell-fr_CA-formLocale"]').click();
+		cy.get('a[id^=component-grid-settings-languages-submissionlanguagegrid-addLanguageModal-button]').click();
+		cy.get('#locale-fr_CA').should('exist').click();
+		cy.get('#addLanguageForm button[name="submitFormButton"]').click();
+		cy.contains('Submission locales updated.').should('exist');
+		cy.get('input[id^="select-cell-fr_CA-submissionLocale"]').click();
+		cy.get('input[id^="select-cell-fr_CA-submissionMetadataLocale"]').should('be.checked');
 
 		cy.get('button[id="indexing-button"]').click();
 		cy.get('input[name="searchDescription-en"]').type(Cypress.env('contextDescriptions')['en']);

diff --git a/dbscripts/xml/upgrade.xml b/dbscripts/xml/upgrade.xml
@@ -197,6 +197,7 @@
 		<migration class="PKP\migration\upgrade\v3_5_0\I9197_MigrateAccessKeys"/>
 		<migration class="PKP\migration\upgrade\v3_5_0\I9262_Highlights"/>
 		<migration class="APP\migration\upgrade\v3_5_0\I9262_Highlights"/>
+		<migration class="APP\migration\upgrade\v3_5_0\I9425_SeparateUIAndSubmissionLocales"/>
 	</upgrade>
 
 	<!-- Update plugin configuration - should be done as the final upgrade task -->

diff --git a/pages/workflow/WorkflowHandler.php b/pages/workflow/WorkflowHandler.php
@@ -115,10 +115,14 @@ public function setupIndex($request)
             $submissionContext = Services::get('context')->get($submission->getContextId());
         }
 
-        $locales = $submissionContext->getSupportedFormLocaleNames();
-        $locales = array_map(fn (string $locale, string $name) => ['key' => $locale, 'label' => $name], array_keys($locales), $locales);
         $latestPublication = $submission->getLatestPublication();
 
+        $locales = collect($submissionContext->getSupportedSubmissionMetadataLocaleNames() + $latestPublication->getLanguageNames())
+            ->map(fn (string $name, string $locale) => ['key' => $locale, 'label' => $name])
+            ->sortBy('key')
+            ->values()
+            ->toArray();
+
         $submissionApiUrl = $request->getDispatcher()->url($request, PKPApplication::ROUTE_API, $submissionContext->getData('urlPath'), 'submissions/' . $submission->getId());
         $latestPublicationApiUrl = $request->getDispatcher()->url($request, PKPApplication::ROUTE_API, $submissionContext->getData('urlPath'), 'submissions/' . $submission->getId() . '/publications/' . $latestPublication->getId());
         $temporaryFileApiUrl = $request->getDispatcher()->url($request, PKPApplication::ROUTE_API, $submissionContext->getData('urlPath'), 'temporaryFiles');
@@ -156,9 +160,9 @@ public function setupIndex($request)
 
         $components = $templateMgr->getState('components');
         $components[FORM_AUDIENCE] = $audienceForm->getConfig();
-        $components[FORM_CATALOG_ENTRY] = $catalogEntryForm->getConfig();
+        $components[FORM_CATALOG_ENTRY] = $this->getLocalizedForm($catalogEntryForm, $latestPublication, $submissionContext);
         $components[FORM_PUBLICATION_DATES] = $publicationDatesForm->getConfig();
-        $components[$publicationLicenseForm->id] = $publicationLicenseForm->getConfig();
+        $components[$publicationLicenseForm->id] = $this->getLocalizedForm($publicationLicenseForm, $latestPublication, $submissionContext);
 
         $publicationFormIds = $templateMgr->getState('publicationFormIds');
         $publicationFormIds[] = FORM_CATALOG_ENTRY;