Merge pull request pkp#1622 from bozana/9468-3_4_0

pkp/pkp-lib#9468 assign DOIs only to chapters that have a landing pag…
bozana · Aug 22, 2024 · 4460a7f · 4460a7f
2 parents 9cd1808 + f5db4c5
commit 4460a7f
Show file tree

Hide file tree

Showing 14 changed files with 46 additions and 10 deletions.
diff --git a/api/v1/_dois/BackendDoiHandler.php b/api/v1/_dois/BackendDoiHandler.php
@@ -68,6 +68,9 @@ public function editChapter(SlimRequest $slimRequest, APIResponse $response, arr
         if (!$chapter) {
             return $response->withStatus(404)->withJsonError('api.404.resourceNotFound');
         }
+        if (!$chapter->isPageEnabled() && empty($chapter->getDoi())) {
+            return $response->withStatus(403)->withJsonError('api.dois.403.editItemDoiCantBeAssigned');
+        }
 
         $publication = Repo::publication()->get($chapter->getData('publicationId'));
         $submission = Repo::submission()->get($publication->getData('submissionId'));

diff --git a/classes/components/listPanels/DoiListPanel.php b/classes/components/listPanels/DoiListPanel.php
@@ -65,6 +65,9 @@ protected function setAppConfig(array &$config): void
         // Provide required locale keys
         $request = Application::get()->getRequest();
         $templateMgr = TemplateManager::getManager($request);
-        $templateMgr->setLocaleKeys(['submission.monograph']);
+        $templateMgr->setLocaleKeys([
+            'submission.monograph',
+            'manager.dois.disabledChaptersDescription',
+        ]);
     }
 }
diff --git a/classes/monograph/Chapter.php b/classes/monograph/Chapter.php
@@ -330,20 +330,20 @@ public function setSourceChapterId(?int $sourceChapterId): void
     /**
      * Is a landing page enabled or disabled.
      *
-     * @return null|int
+     * @return null|bool
      */
     public function isPageEnabled()
     {
-        return $this->getData('isPageEnabled');
+        return $this->getData('isPageEnabled') || !empty($this->getDoi());
     }
 
     /**
      * Enable or disable a landing page.
      *
      */
-    public function setPageEnabled(?int $enable): void
+    public function setPageEnabled(?bool $enable): void
     {
-        $this->setData('isPageEnabled', $enable);
+        $this->setData('isPageEnabled', $enable || !empty($this->getDoi()));
     }
 
     /**

diff --git a/classes/submission/Collector.php b/classes/submission/Collector.php
@@ -88,6 +88,7 @@ protected function addHasDoisFilterToQuery(Builder $q)
             $q->select('current_p.publication_id')
                 ->from('publications', 'current_p')
                 ->leftJoin('submission_chapters as current_c', 'current_p.publication_id', '=', 'current_c.publication_id')
+                ->leftJoin('submission_chapter_settings as current_cs', 'current_cs.chapter_id', '=', 'current_c.chapter_id')
                 ->leftJoin('publication_formats as current_pf', 'current_p.publication_id', '=', 'current_pf.publication_id')
                 ->where(function (Builder $q) {
                     $q->when($this->hasDois === true, function (Builder $q) {
@@ -109,6 +110,10 @@ protected function addHasDoisFilterToQuery(Builder $q)
                             $q->orWhere(function (Builder $q) {
                                 $q->whereNull('current_c.doi_id');
                                 $q->whereNotNull('current_c.chapter_id');
+                                $q->where(function (Builder $q) {
+                                    $q->where('current_cs.setting_name', '=', 'isPageEnabled');
+                                    $q->where('current_cs.setting_value', '=', 1);
+                                });
                             });
                         });
                         $q->when(in_array(Repo::doi()::TYPE_REPRESENTATION, $this->enabledDoiTypes), function (Builder $q) {

diff --git a/classes/submission/Repository.php b/classes/submission/Repository.php
@@ -76,7 +76,7 @@ public function createDois(Submission $submission): array
             /** @var ChapterDAO $chapterDao */
             $chapterDao = DAORegistry::getDAO('ChapterDAO');
             foreach ($chapters as $chapter) {
-                if (empty($chapter->getData('doiId'))) {
+                if (empty($chapter->getData('doiId')) && $chapter->isPageEnabled()) {
                     try {
                         $doiId = Repo::doi()->mintChapterDoi($chapter, $submission, $context);
                         $chapter->setData('doiId', $doiId);

diff --git a/controllers/grid/users/chapter/form/ChapterForm.php b/controllers/grid/users/chapter/form/ChapterForm.php
@@ -278,6 +278,7 @@ public function fetch($request, $template = null, $display = false)
             }, $selectedChapterAuthorsArray),
             'chapterFileOptions' => $chapterFileOptions,
             'selectedChapterFiles' => $selectedChapterFiles,
+            'doi' => $this->getChapter()?->getDoi()
         ]);
 
         return parent::fetch($request, $template, $display);

diff --git a/cypress/support/commands.js b/cypress/support/commands.js
@@ -51,6 +51,15 @@ Cypress.Commands.add('addChapters', (chapters) => {
 			cy.get('div:contains("Your changes have been saved.")');
 		}
 
+		// Landing page
+		if ('landingPage' in chapter) {
+			cy.get('div[id="chaptersGridContainer"] a:contains("' + Cypress.$.escapeSelector(chapter.title) + '")').click();
+			cy.flushNotifications();
+			cy.get('form[id="editChapterForm"] input[id="isPageEnabled"]').click();
+			cy.get('form[id="editChapterForm"] button:contains("Save")').click();
+			cy.get('div:contains("Your changes have been saved.")');
+		}
+
 		cy.get('div[id^="component-grid-users-chapter-chaptergrid-"] a.pkp_linkaction_editChapter:contains("' + Cypress.$.escapeSelector(chapter.title) + '")');
 	});
 });

diff --git a/cypress/tests/data/60-content/MdawsonSubmission.cy.js b/cypress/tests/data/60-content/MdawsonSubmission.cy.js
@@ -103,7 +103,8 @@ describe('Data suite tests', function() {
 				{
 					'title': 'Chapter 1: Mind Control—Internal or External?',
 					'contributors': ['Michael Dawson'],
-					files: ['chapter1.pdf']
+					files: ['chapter1.pdf'],
+					'landingPage': true
 				},
 				{
 					'title': 'Chapter 2: Classical Music and the Classical Mind',
@@ -132,7 +133,6 @@ describe('Data suite tests', function() {
 			'affiliation': 'University of Alberta',
 			'country': 'Canada'
 		});
-
 		cy.getCsrfToken();
 		cy.window()
 			.then(() => {

diff --git a/cypress/tests/integration/Doi.cy.js b/cypress/tests/integration/Doi.cy.js
@@ -11,6 +11,7 @@ describe('DOI tests', function() {
 	const submissionId = 14;
 	const publicationId = 14;
 	const chapterId = 54;
+	const chapterIdDisabled = 55;
 	const publicationFormatId = 3;
 	const submissionFileId = 113;
 	const unpublishedSubmissionId = 4;
@@ -46,6 +47,7 @@ describe('DOI tests', function() {
 		cy.get(`#list-item-submission-${submissionId} button.expander`).click();
 		cy.checkDoiAssignment(`${submissionId}-monograph-${publicationId}`);
 		cy.checkDoiAssignment(`${submissionId}-chapter-${chapterId}`);
+		cy.checkDisabledDoiAssignment(`${submissionId}-chapter-${chapterIdDisabled}`);
 		cy.checkDoiAssignment(`${submissionId}-representation-${publicationFormatId}`);
 		cy.checkDoiAssignment(`${submissionId}-file-${submissionFileId}`);
 
@@ -61,6 +63,10 @@ describe('DOI tests', function() {
 		cy.get('div.item.chapters ul')
 			.find('li:first-child')
 			.contains('https://doi.org/10.1234/');
+		// No chapter DOI
+		cy.get('div.item.chapters ul>li')
+			.eq(1)
+			.should('not.contain', 'https://doi.org/10.1234/')
 		// PublicationFormat DOI
 		cy.get(
 			`div.item.publication_format div.sub_item.pubid.${publicationFormatId} div.value`

diff --git a/lib/pkp b/lib/pkp
diff --git a/lib/ui-library b/lib/ui-library
diff --git a/locale/en/manager.po b/locale/en/manager.po
@@ -392,6 +392,9 @@ msgstr "Use default patterns.<br />%p.%m for monographs<br />%p.%m.c%c for chapt
 msgid "doi.manager.settings.doiCreationTime.copyedit"
 msgstr "Upon reaching the copyediting stage"
 
+msgid "manager.dois.disabledChaptersDescription"
+msgstr "Chapters without a landing page cannot have a DOI."
+
 msgid "manager.dois.formatIdentifier.file"
 msgstr "Format / {$format}"
 

diff --git a/locale/en/submission.po b/locale/en/submission.po
@@ -462,6 +462,9 @@ msgstr "Production Discussions"
 msgid "publication.chapter.landingPage"
 msgstr "Chapter Page"
 
+msgid "publication.chapter.landingPage.doi.description"
+msgstr "(This chapter will always be shown on its own page because it has a DOI.)"
+
 msgid "publication.chapter.hasLandingPage"
 msgstr ""
 "Show this chapter on its own page and link to that page from the book's "

diff --git a/templates/controllers/grid/users/chapter/form/chapterForm.tpl b/templates/controllers/grid/users/chapter/form/chapterForm.tpl
@@ -57,6 +57,9 @@
 
 	{fbvFormSection list=true title="publication.chapter.landingPage" for="customExtras"}
 	{fbvElement type="checkbox" name="isPageEnabled" id="isPageEnabled" checked=$isPageEnabled|compare:true label="publication.chapter.hasLandingPage" value="1" translate="true"}
+	{if $doi}
+		<div class="pkpFormField__description">{translate key="publication.chapter.landingPage.doi.description"}</div>
+	{/if}
 	{/fbvFormSection}
 
 	{fbvFormSection list=true title="submission.submit.addAuthor"}