Merge pull request #4146 from jyhein/f699

pkp/pkp-lib#699 Show locale in url in multilingual contexts
pkp · Apr 25, 2024 · 072fea3 · 072fea3
2 parents 42d6fcc + d8d2f1f
commit 072fea3
Show file tree

Hide file tree

Showing 23 changed files with 52 additions and 35 deletions.
diff --git a/cypress/tests/integration/Pubmed.cy.js b/cypress/tests/integration/Pubmed.cy.js
@@ -18,7 +18,7 @@ describe('Pubmed tests', function () {
 		.then((win) => {
 			const csrfToken = win.pkp.currentUser.csrfToken;
 			cy.request({
-					url: '/index.php/publicknowledge/management/importexport/plugin/PubMedExportPlugin/exportSubmissions',
+					url: '/index.php/publicknowledge/en/management/importexport/plugin/PubMedExportPlugin/exportSubmissions',
 					method: 'POST',
 					headers: {
 						'X-Csrf-Token': csrfToken

diff --git a/cypress/tests/integration/Z_ArticleViewDCMetadata.cy.js b/cypress/tests/integration/Z_ArticleViewDCMetadata.cy.js
@@ -384,7 +384,7 @@ describe('Article View Metadata - DC Plugin', function() {
 				return cy.submitSubmissionWithApi(submission.id, this.csrfToken);
 			})
 			.then(xhr => {
-				cy.visit('/index.php/publicknowledge/workflow/index/' + submission.id + '/1');
+				cy.visit('/index.php/publicknowledge/en/workflow/index/' + submission.id + '/1');
 			});
 
 
@@ -481,7 +481,7 @@ describe('Article View Metadata - DC Plugin', function() {
 	});
 
 	it('Tests if Header DC Metadata are present and consistent', function() {
-		cy.visit('/index.php/publicknowledge/article/view/' + submission.urlPath);
+		cy.visit('/index.php/publicknowledge/en/article/view/' + submission.urlPath);
 
 		cy.get('meta[name^="DC."]').each((item, index, list) => {
 			cy.wrap(item)

diff --git a/lib/pkp b/lib/pkp
diff --git a/pages/user/index.php b/pages/user/index.php
@@ -23,7 +23,6 @@
     //
     case 'index':
     case 'subscriptions':
-    case 'setLocale':
     case 'authorizationDenied':
     case 'purchaseSubscription':
     case 'payPurchaseSubscription':

diff --git a/plugins/blocks/languageToggle/LanguageToggleBlockPlugin.php b/plugins/blocks/languageToggle/LanguageToggleBlockPlugin.php
@@ -85,10 +85,8 @@ public function getContents($templateMgr, $request = null)
             $templateMgr->assign('languageToggleNoUser', true);
         }
 
-        if (!empty($locales)) {
-            $templateMgr->assign('enableLanguageToggle', true);
-            $templateMgr->assign('languageToggleLocales', $locales);
-        }
+        $templateMgr->assign('enableLanguageToggle', count($locales) > 1);
+        $templateMgr->assign('languageToggleLocales', $locales);
 
         return parent::getContents($templateMgr, $request);
     }

diff --git a/plugins/blocks/languageToggle/templates/block.tpl b/plugins/blocks/languageToggle/templates/block.tpl
@@ -17,7 +17,7 @@
 		<ul>
 			{foreach from=$languageToggleLocales item=localeName key=localeKey}
 				<li class="locale_{$localeKey|escape}{if $localeKey == $currentLocale} current{/if}" lang="{$localeKey|replace:"_":"-"}">
-					<a href="{url router=\PKP\core\PKPApplication::ROUTE_PAGE page="user" op="setLocale" path=$localeKey source=$smarty.server.REQUEST_URI}">
+					<a href="{url router=\PKP\core\PKPApplication::ROUTE_PAGE page="user" op="setLocale" path=$localeKey}">
 						{$localeName}
 					</a>
 				</li>

diff --git a/plugins/generic/citationStyleLanguage b/plugins/generic/citationStyleLanguage
diff --git a/plugins/generic/crossref b/plugins/generic/crossref
diff --git a/plugins/generic/datacite/DataciteExportPlugin.php b/plugins/generic/datacite/DataciteExportPlugin.php
@@ -410,13 +410,13 @@ public function _getObjectUrl($request, $context, $object)
         $url = null;
         switch (true) {
             case $object instanceof Issue:
-                $url = $dispatcher->url($request, PKPApplication::ROUTE_PAGE, $context->getPath(), 'issue', 'view', $object->getBestIssueId(), null, null, true);
+                $url = $dispatcher->url($request, PKPApplication::ROUTE_PAGE, $context->getPath(), 'issue', 'view', $object->getBestIssueId(), null, null, true, '');
                 break;
             case $object instanceof Submission:
-                $url = $dispatcher->url($request, PKPApplication::ROUTE_PAGE, $context->getPath(), 'article', 'view', $object->getBestId(), null, null, true);
+                $url = $dispatcher->url($request, PKPApplication::ROUTE_PAGE, $context->getPath(), 'article', 'view', $object->getBestId(), null, null, true, '');
                 break;
             case $object instanceof Galley:
-                $url = $dispatcher->url($request, PKPApplication::ROUTE_PAGE, $context->getPath(), 'article', 'view', [$article->getBestId(), $object->getBestGalleyId()], null, null, true);
+                $url = $dispatcher->url($request, PKPApplication::ROUTE_PAGE, $context->getPath(), 'article', 'view', [$article->getBestId(), $object->getBestGalleyId()], null, null, true, '');
                 break;
         }
         if ($this->isTestMode($context)) {

diff --git a/plugins/generic/datacite/filter/DataciteXmlFilter.php b/plugins/generic/datacite/filter/DataciteXmlFilter.php
@@ -821,7 +821,8 @@ public function createRelatedItemsNode($doc, $issue, $article, $publication, $pu
                 $contextUrl = $request->getDispatcher()->url(
                     $request,
                     Application::ROUTE_PAGE,
-                    $context->getPath()
+                    $context->getPath(),
+                    urlLocaleForPage: ''
                 );
                 $relatedItemIdentifierNode = $doc->createElementNS($deployment->getNamespace(), 'relatedItemIdentifier', $contextUrl);
                 $relatedItemIdentifierNode->setAttribute('relatedItemIdentifierType', DATACITE_IDTYPE_URL);

diff --git a/plugins/generic/dublinCoreMeta/DublinCoreMetaPlugin.php b/plugins/generic/dublinCoreMeta/DublinCoreMetaPlugin.php
@@ -16,6 +16,7 @@
 
 use APP\facades\Repo;
 use APP\template\TemplateManager;
+use PKP\core\PKPApplication;
 use PKP\plugins\GenericPlugin;
 use PKP\plugins\Hook;
 
@@ -143,7 +144,7 @@ public function articleView($hookName, $args)
             }
         }
 
-        $templateMgr->addHeader('dublinCoreUri', '<meta name="DC.Identifier.URI" content="' . $request->url(null, 'article', 'view', [$articleBestId]) . '"/>');
+        $templateMgr->addHeader('dublinCoreUri', '<meta name="DC.Identifier.URI" content="' . $request->getDispatcher()->url($request, PKPApplication::ROUTE_PAGE, null, 'article', 'view', [$articleBestId], urlLocaleForPage: '') . '"/>');
 
         $templateMgr->addHeader('dublinCoreLanguage', '<meta name="DC.Language" scheme="ISO639-1" content="' . substr($publicationLocale, 0, 2) . '"/>');
 
@@ -166,7 +167,7 @@ public function articleView($hookName, $args)
                 $templateMgr->addHeader('dublinCoreVolume', '<meta name="DC.Source.Volume" content="' . htmlspecialchars($issue->getVolume()) . '"/>');
             }
         }
-        $templateMgr->addHeader('dublinCoreSourceUri', '<meta name="DC.Source.URI" content="' . $request->url($journal->getPath()) . '"/>');
+        $templateMgr->addHeader('dublinCoreSourceUri', '<meta name="DC.Source.URI" content="' . $request->getDispatcher()->url($request, PKPApplication::ROUTE_PAGE, null, $journal->getPath(), urlLocaleForPage: '') . '"/>');
 
         if ($subjects = $publication->getData('subjects')) {
             foreach ($subjects as $locale => $localeSubjects) {

diff --git a/plugins/generic/googleScholar b/plugins/generic/googleScholar
diff --git a/plugins/generic/recommendByAuthor/templates/articleFooter.tpl b/plugins/generic/recommendByAuthor/templates/articleFooter.tpl
@@ -26,11 +26,10 @@
 						{foreach from=$article->getCurrentPublication()->getData('authors') item=author}
 							{$author->getFullName()|escape},
 						{/foreach}
-						<a href="{url journal=$journal->getPath() page="article" op="view" path=$submission->g
-etBestId()}">
+						<a href="{url router=\PKP\core\PKPApplication::ROUTE_PAGE journal=$journal->getPath() page="article" op="view" path=$submission->getBestId() urlLocaleForPage=""}">
 							{$publication->getLocalizedFullTitle(null, 'html')|strip_unsafe_html}
 						</a>,
-						<a href="{url journal=$journal->getPath() page="issue" op="view" path=$issue->getBestIssueId()}">
+						<a href="{url router=\PKP\core\PKPApplication::ROUTE_PAGE journal=$journal->getPath() page="issue" op="view" path=$issue->getBestIssueId() urlLocaleForPage=""}">
 							{$journal->getLocalizedName()|escape}: {$issue->getIssueIdentification()|escape}
 						</a>
 					</li>

diff --git a/plugins/generic/recommendBySimilarity/RecommendBySimilarityPlugin.php b/plugins/generic/recommendBySimilarity/RecommendBySimilarityPlugin.php
@@ -21,6 +21,7 @@
 use APP\submission\Collector;
 use APP\submission\Submission;
 use APP\template\TemplateManager;
+use PKP\core\PKPApplication;
 use PKP\plugins\GenericPlugin;
 use PKP\plugins\Hook;
 
@@ -100,10 +101,10 @@ private function buildTemplate(): ?string
             ->getMany();
 
         $nextPage = $rangeInfo->getPage() * $rangeInfo->getCount() < $submissionCount
-            ? $request->url(path: $submissionId, params: ['articlesBySimilarityPage' => $rangeInfo->getPage() + 1])
+            ? $request->getDispatcher()->url($request, PKPApplication::ROUTE_PAGE, path: $submissionId, params: ['articlesBySimilarityPage' => $rangeInfo->getPage() + 1], urlLocaleForPage: '')
             : null;
         $previousPage = $rangeInfo->getPage() > 1
-            ? $request->url(path: $submissionId, params: ['articlesBySimilarityPage' => $rangeInfo->getPage() - 1])
+            ? $request->getDispatcher()->url($request, PKPApplication::ROUTE_PAGE, path: $submissionId, params: ['articlesBySimilarityPage' => $rangeInfo->getPage() - 1], urlLocaleForPage: '')
             : null;
 
         $templateManager->assign('articlesBySimilarity', (object) [

diff --git a/plugins/generic/recommendBySimilarity/templates/articleFooter.tpl b/plugins/generic/recommendBySimilarity/templates/articleFooter.tpl
@@ -21,11 +21,11 @@
 					{foreach from=$publication->getData('authors') item=author}
 						{$author->getFullName()|escape},
 					{/foreach}
-					<a href="{url journal=$currentContext->getPath() page="article" op="view" path=$submission->getBestId()}">
+					<a href="{url router=\PKP\core\PKPApplication::ROUTE_PAGE journal=$currentContext->getPath() page="article" op="view" path=$submission->getBestId() urlLocaleForPage=""}">
 						{$publication->getLocalizedFullTitle(null, 'html')|strip_unsafe_html}
 					</a>
 					{if $issue},
-					<a href="{url journal=$currentContext->getPath() page="issue" op="view" path=$issue->getBestIssueId()}">
+					<a href="{url router=\PKP\core\PKPApplication::ROUTE_PAGE journal=$currentContext->getPath() page="issue" op="view" path=$issue->getBestIssueId() urlLocaleForPage=""}">
 						{$currentContext->getLocalizedName()|escape}: {$issue->getIssueIdentification()|escape}
 					</a>
 					{/if}

diff --git a/plugins/importexport/doaj/filter/DOAJJsonFilter.php b/plugins/importexport/doaj/filter/DOAJJsonFilter.php
@@ -148,7 +148,7 @@ public function &process(&$pubObject)
         $request = Application::get()->getRequest();
         $article['bibjson']['link'] = [];
         $article['bibjson']['link'][] = [
-            'url' => $request->url($context->getPath(), 'article', 'view', $pubObject->getId()),
+            'url' => $request->getDispatcher()->url($request, Application::ROUTE_PAGE, $context->getPath(), 'article', 'view', $pubObject->getId(), urlLocaleForPage: ''),
             'type' => 'fulltext',
             'content_type' => 'html'
         ];

diff --git a/plugins/importexport/doaj/filter/DOAJXmlFilter.php b/plugins/importexport/doaj/filter/DOAJXmlFilter.php
@@ -187,7 +187,7 @@ public function &process(&$pubObjects)
             }
             // FullText URL
             $request = Application::get()->getRequest();
-            $recordNode->appendChild($node = $doc->createElement('fullTextUrl', htmlspecialchars($request->url(null, 'article', 'view', $pubObject->getId()), ENT_COMPAT, 'UTF-8')));
+            $recordNode->appendChild($node = $doc->createElement('fullTextUrl', htmlspecialchars($request->getDispatcher()->url($request, Application::ROUTE_PAGE, null, 'article', 'view', $pubObject->getId(), urlLocaleForPage: ''), ENT_COMPAT, 'UTF-8')));
             $node->setAttribute('format', 'html');
             // Keywords
             $supportedLocales = $context->getSupportedFormLocales();

diff --git a/plugins/importexport/pubmed/PubMedExportPlugin.php b/plugins/importexport/pubmed/PubMedExportPlugin.php
@@ -166,7 +166,11 @@ public function exportSubmissions($submissionIds, $context, $user)
             return $a->level == LIBXML_ERR_ERROR || $a->level == LIBXML_ERR_FATAL;
         });
         if (!empty($errors)) {
-            $this->displayXMLValidationErrors($errors, $xml);
+            try {
+                $this->displayXMLValidationErrors($errors, $xml);
+            } catch (Exception $e) {
+                error_log($e->getMessage());
+            }
         }
         return $xml;
     }

diff --git a/plugins/metadata/dc11/filter/Dc11SchemaArticleAdapter.php b/plugins/metadata/dc11/filter/Dc11SchemaArticleAdapter.php
@@ -28,6 +28,7 @@
 use APP\oai\ojs\OAIDAO;
 use APP\plugins\PubIdPlugin;
 use APP\submission\Submission;
+use PKP\core\PKPApplication;
 use PKP\db\DAORegistry;
 use PKP\facades\Locale;
 use PKP\metadata\MetadataDataObjectAdapter;
@@ -151,7 +152,7 @@ public function &extractMetadataFromDataObject(&$article)
         $request = Application::get()->getRequest();
         $includeUrls = $journal->getSetting('publishingMode') != Journal::PUBLISHING_MODE_NONE || $issueAction->subscribedUser($request->getUser(), $journal, null, $article->getId());
         if ($includeUrls) {
-            $dc11Description->addStatement('dc:identifier', $request->url($journal->getPath(), 'article', 'view', [$article->getBestId()]));
+            $dc11Description->addStatement('dc:identifier', $request->getDispatcher()->url($request, PKPApplication::ROUTE_PAGE, null, 'article', 'view', [$article->getBestId()], urlLocaleForPage: ''));
         }
 
         // Source (journal title, issue id and pages)
@@ -184,7 +185,7 @@ public function &extractMetadataFromDataObject(&$article)
         // full text URLs
         if ($includeUrls) {
             foreach ($galleys as $galley) {
-                $relation = $request->url($journal->getPath(), 'article', 'view', [$article->getBestId(), $galley->getBestGalleyId()]);
+                $relation = $request->getDispatcher()->url($request, PKPApplication::ROUTE_PAGE, null, 'article', 'view', [$article->getBestId(), $galley->getBestGalleyId()], urlLocaleForPage: '');
                 $dc11Description->addStatement('dc:relation', $relation);
             }
         }

diff --git a/plugins/oaiMetadataFormats/dc/tests/OAIMetadataFormat_DCTest.php b/plugins/oaiMetadataFormats/dc/tests/OAIMetadataFormat_DCTest.php
@@ -37,6 +37,7 @@
 use Illuminate\Support\LazyCollection;
 use PHPUnit\Framework\MockObject\MockObject;
 use PKP\author\Repository as AuthorRepository;
+use PKP\core\Dispatcher;
 use PKP\core\Registry;
 use PKP\db\DAORegistry;
 use PKP\doi\Doi;
@@ -213,13 +214,25 @@ public function testToXml()
             ->method('url')
             ->will($this->returnCallback(fn ($request, $newContext = null, $handler = null, $op = null, $path = null) => $handler . '-' . $op . '-' . implode('-', $path)));
 
+        // Dispatcher
+        /** @var Dispatcher|MockObject */
+        $dispatcher = $this->getMockBuilder(Dispatcher::class)
+        ->onlyMethods(['url'])
+        ->getMock();
+        $dispatcher->expects($this->any())
+            ->method('url')
+            ->will($this->returnCallback(fn ($request, $shortcut, $newContext = null, $handler = null, $op = null, $path = null) => $handler . '-' . $op . '-' . implode('-', $path)));
+
         // Request
         $requestMock = $this->getMockBuilder(Request::class)
-            ->onlyMethods(['getRouter'])
+            ->onlyMethods(['getRouter', 'getDispatcher'])
             ->getMock();
         $requestMock->expects($this->any())
             ->method('getRouter')
             ->will($this->returnValue($router));
+        $requestMock->expects($this->any())
+            ->method('getDispatcher')
+            ->will($this->returnValue($dispatcher));
         Registry::set('request', $requestMock);
 
         //

diff --git a/plugins/oaiMetadataFormats/marc/templates/record.tpl b/plugins/oaiMetadataFormats/marc/templates/record.tpl
@@ -69,7 +69,7 @@
 		</varfield>
 	{/foreach}
 	<varfield id="856" i1="4" i2="0">
-		<subfield label="u">{url journal=$journal->getPath() page="article" op="view" path=$article->getBestId()|escape}</subfield>
+		<subfield label="u">{url router=\PKP\core\PKPApplication::ROUTE_PAGE journal=$journal->getPath() page="article" op="view" path=$article->getBestId()|escape urlLocaleForPage=""}</subfield>
 	</varfield>
 
 	<varfield id="786" i1="0" i2=" ">

diff --git a/plugins/oaiMetadataFormats/marcxml/templates/record.tpl b/plugins/oaiMetadataFormats/marcxml/templates/record.tpl
@@ -78,7 +78,7 @@
 		</datafield>
 	{/foreach}
 	<datafield tag="856" ind1="4" ind2="0">
-		<subfield code="u">{url journal=$journal->getPath() page="article" op="view" path=$article->getBestId()|escape}</subfield>
+		<subfield code="u">{url router=\PKP\core\PKPApplication::ROUTE_PAGE journal=$journal->getPath() page="article" op="view" path=$article->getBestId()|escape urlLocaleForPage=""}</subfield>
 	</datafield>
 
 	<datafield tag="786" ind1="0" ind2=" ">

diff --git a/plugins/oaiMetadataFormats/rfc1807/OAIMetadataFormat_RFC1807.php b/plugins/oaiMetadataFormats/rfc1807/OAIMetadataFormat_RFC1807.php
@@ -81,7 +81,7 @@ public function toXml($record, $format = null)
 
         $issueAction = new IssueAction();
         $request = Application::get()->getRequest();
-        $url = $request->url($journal->getPath(), 'article', 'view', [$article->getBestId()]);
+        $url = $request->getDispatcher()->url($request, Application::ROUTE_PAGE, $journal->getPath(), 'article', 'view', [$article->getBestId()], urlLocaleForPage: '');
         $includeUrls = $journal->getSetting('publishingMode') != \APP\journal\Journal::PUBLISHING_MODE_NONE || $issueAction->subscribedUser($request->getUser(), $journal, null, $article->getId());
         $response = "<rfc1807\n" .
             "\txmlns=\"http://info.internet.isi.edu:80/in-notes/rfc/files/rfc1807.txt\"\n" .
+25 −4		classes/core/Core.php
+4 −2		classes/core/Dispatcher.php
+98 −10		classes/core/PKPPageRouter.php
+3 −2		classes/core/PKPRequest.php
+8 −0		classes/core/PKPRouter.php
+2 −1		classes/observers/events/UsageEvent.php
+15 −3		classes/template/PKPTemplateManager.php
+1 −1		cypress/support/commands.js
+0 −32		pages/user/PKPUserHandler.php
+3 −2		plugins/generic/usageEvent/PKPUsageEventPlugin.php
+34 −0		tests/classes/core/DispatcherTest.php
+23 −0		tests/classes/core/PKPPageRouterTest.php
+5 −5		tests/classes/core/PKPRouterTestCase.php
+4 −4		filter/ArticleCrossrefXmlFilter.php
+1 −1		filter/IssueCrossrefXmlFilter.php