From 43bca4b515e6020694f01c16a4d33aefdc0b27c3 Mon Sep 17 00:00:00 2001
From: Richard Haeser <richard@richardhaeser.com>
Date: Tue, 16 Feb 2021 10:43:05 +0100
Subject: [PATCH] [FEATURE] Possibility to disable hreflang per page
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
If you have a good reason to disable the default rendering of
hreflang tags, you can now use a TypoScript setting.
To disable the hreflang generation, you can add the following
line to your TypoScript setup.
.. code-block:: typoscript
config.disableHrefLang = 1
Resolves: #93188
Releases: master
Change-Id: I7678b395e4c2bfd6a62a87c928b3f8a44af381ec
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/67930
Tested-by: TYPO3com <noreply@typo3.com>
Tested-by: core-ci <typo3@b13.com>
Tested-by: Guido Schmechel <guido.schmechel@brandung.de>
Tested-by: Georg Ringer <georg.ringer@gmail.com>
Reviewed-by: Jörg Bösche <typo3@joergboesche.de>
Reviewed-by: Guido Schmechel <guido.schmechel@brandung.de>
Reviewed-by: Torben Hansen <derhansen@gmail.com>
Reviewed-by: Georg Ringer <georg.ringer@gmail.com>
---
...88-PossibilityToDisableHreflangPerPage.rst | 32 +++++++++++++++++++
.../frontend/Classes/Http/RequestHandler.php | 4 +++
.../Functional/Fixtures/HrefLang.typoscript | 4 +++
.../Functional/Fixtures/HrefLangScenario.yml | 4 +++
.../HrefLang/HrefLangGeneratorTest.php | 16 ++++++++--
5 files changed, 58 insertions(+), 2 deletions(-)
create mode 100644 typo3/sysext/core/Documentation/Changelog/master/Feature-93188-PossibilityToDisableHreflangPerPage.rst
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Feature-93188-PossibilityToDisableHreflangPerPage.rst b/typo3/sysext/core/Documentation/Changelog/master/Feature-93188-PossibilityToDisableHreflangPerPage.rst
new file mode 100644
index 000000000000..e11174071534
--- /dev/null
+++ b/typo3/sysext/core/Documentation/Changelog/master/Feature-93188-PossibilityToDisableHreflangPerPage.rst
@@ -0,0 +1,32 @@
+.. include:: ../../Includes.txt
+
+==========================================================
+Feature: #93188 - Possibility to disable hreflang per page
+==========================================================
+
+See :issue:`93188`
+
+Description
+===========
+
+Although it should not be needed to disable the hreflang generation, people might
+have a reason to disable the hreflang generation. If for some reason core does not
+render the proper hreflang tags and also the PSR-14 event called `ModifyHrefLangTagsEvent`
+is not enough, you are now able to disable the generation of the hreflang tags
+via TypoScript. This can be done per page or part of your tree depending on where
+you set the configuration.
+
+To disable the hreflang generation, you can add the following line to your
+TypoScript setup.
+
+.. code-block:: typoscript
+
+ config.disableHrefLang = 1
+
+
+Impact
+======
+
+Only when you set this option, the hreflang generation will be skipped.
+
+.. index:: Frontend, TypoScript, ext:seo
diff --git a/typo3/sysext/frontend/Classes/Http/RequestHandler.php b/typo3/sysext/frontend/Classes/Http/RequestHandler.php
index 15937ba32146..e32960852d7d 100644
--- a/typo3/sysext/frontend/Classes/Http/RequestHandler.php
+++ b/typo3/sysext/frontend/Classes/Http/RequestHandler.php
@@ -1011,6 +1011,10 @@ class RequestHandler implements RequestHandlerInterface
protected function generateHrefLangTags(TypoScriptFrontendController $controller, ServerRequestInterface $request): void
{
+ if ($controller->config['config']['disableHrefLang'] ?? false) {
+ return;
+ }
+
$hrefLangs = $this->eventDispatcher->dispatch(
new ModifyHrefLangTagsEvent($request)
)->getHrefLangs();
diff --git a/typo3/sysext/seo/Tests/Functional/Fixtures/HrefLang.typoscript b/typo3/sysext/seo/Tests/Functional/Fixtures/HrefLang.typoscript
index 100db96b8964..e702a36f490a 100644
--- a/typo3/sysext/seo/Tests/Functional/Fixtures/HrefLang.typoscript
+++ b/typo3/sysext/seo/Tests/Functional/Fixtures/HrefLang.typoscript
@@ -10,3 +10,7 @@ page {
10 = TEXT
10.value = Test
}
+
+[page["uid"] == 1500]
+ config.disableHrefLang = 1
+[end]
diff --git a/typo3/sysext/seo/Tests/Functional/Fixtures/HrefLangScenario.yml b/typo3/sysext/seo/Tests/Functional/Fixtures/HrefLangScenario.yml
index 6553054ba94e..6b624534f470 100644
--- a/typo3/sysext/seo/Tests/Functional/Fixtures/HrefLangScenario.yml
+++ b/typo3/sysext/seo/Tests/Functional/Fixtures/HrefLangScenario.yml
@@ -57,3 +57,7 @@ entities:
languageVariants:
- self: {id: 1401, title: 'DE: Produkte', language: 1, slug: '/produkte'}
- self: {id: 1402, title: 'DE-CH: Produkte', language: 2, slug: '/produkte'}
+ - self: {id: 1500, title: 'EN: No hreflang', slug: '/no-hreflang'}
+ languageVariants:
+ - self: {id: 1501, title: 'DE: Kein hreflang', language: 1, slug: '/kein-hreflang'}
+ - self: {id: 1502, title: 'DE-CH: Kein hreflang', language: 2, slug: '/kein-hreflang'}
diff --git a/typo3/sysext/seo/Tests/Functional/HrefLang/HrefLangGeneratorTest.php b/typo3/sysext/seo/Tests/Functional/HrefLang/HrefLangGeneratorTest.php
index 49e54f80012c..5a3e78c39c15 100644
--- a/typo3/sysext/seo/Tests/Functional/HrefLang/HrefLangGeneratorTest.php
+++ b/typo3/sysext/seo/Tests/Functional/HrefLang/HrefLangGeneratorTest.php
@@ -206,10 +206,22 @@ class HrefLangGeneratorTest extends FunctionalTestCase
],
[
'<link rel="alternate" hreflang="fr-FR"',
-
]
],
-
+ 'Pages with disabled hreflang generation should not render any hreflang tag' => [
+ 'https://acme.com/no-hreflang',
+ [],
+ [
+ '<link rel="alternate" hreflang="',
+ ]
+ ],
+ 'Translated pages with disabled hreflang generation in original language should not render any hreflang tag' => [
+ 'https://acme.com/de/kein-hreflang',
+ [],
+ [
+ '<link rel="alternate" hreflang="',
+ ]
+ ],
];
}
--
GitLab