TYPO3-translation/cms-seo
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

TYPO3 v15 dev-main snapshot ()

Browse Source
This commit is contained in:
wappler
2026-08-10 22:31:39 +02:00
commit e54ab24745
68 changed files with 3683 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Classes/XmlSitemap/AbstractXmlSitemapDataProvider.php
+84
View File
@@ -0,0 +1,84 @@
<?php
declare(strict_types=1);
/*
* This file is part of the TYPO3 CMS project.
*
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
namespace TYPO3\CMS\Seo\XmlSitemap;
use Psr\Http\Message\ServerRequestInterface;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
/**
* Base class for XmlSitemapProviders to extend
*/
abstract class AbstractXmlSitemapDataProvider implements XmlSitemapDataProviderInterface
{
protected string $key;
protected array $items = [];
protected array $config = [];
protected ContentObjectRenderer $cObj;
protected int $numberOfItemsPerPage = 1000;
protected ServerRequestInterface $request;
public function __construct(ServerRequestInterface $request, string $key, array $config = [], ?ContentObjectRenderer $cObj = null)
{
$this->key = $key;
$this->config = $config;
$this->request = $request;
$this->cObj = $cObj ?? GeneralUtility::makeInstance(ContentObjectRenderer::class);
$this->cObj->setRequest($request);
}
public function getKey(): string
{
return $this->key;
}
public function getNumberOfPages(): int
{
return (int)ceil(count($this->items) / $this->numberOfItemsPerPage);
}
public function getLastModified(): int
{
$lastMod = 0;
foreach ($this->items as $item) {
if ((int)($item['lastMod'] ?? 0) > $lastMod) {
$lastMod = (int)$item['lastMod'];
}
}
return $lastMod;
}
protected function defineUrl(array $data): array
{
return $data;
}
public function getItems(): array
{
$pageNumber = (int)($this->request->getQueryParams()['tx_seo']['page'] ?? 0);
$page = $pageNumber > 0 ? $pageNumber : 0;
$items = array_slice(
$this->items,
$page * $this->numberOfItemsPerPage,
$this->numberOfItemsPerPage
);
return array_map([$this, 'defineUrl'], $items);
}
}
Classes/XmlSitemap/Exception/InvalidConfigurationException.php
+22
View File
@@ -0,0 +1,22 @@
<?php
declare(strict_types=1);
/*
* This file is part of the TYPO3 CMS project.
*
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
namespace TYPO3\CMS\Seo\XmlSitemap\Exception;
use TYPO3\CMS\Core\Resource\Exception;
class InvalidConfigurationException extends Exception {}
Classes/XmlSitemap/Exception/MissingConfigurationException.php
+22
View File
@@ -0,0 +1,22 @@
<?php
declare(strict_types=1);
/*
* This file is part of the TYPO3 CMS project.
*
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
namespace TYPO3\CMS\Seo\XmlSitemap\Exception;
use TYPO3\CMS\Core\Resource\Exception;
class MissingConfigurationException extends Exception {}
Classes/XmlSitemap/PagesXmlSitemapDataProvider.php
+119
View File
@@ -0,0 +1,119 @@
<?php
declare(strict_types=1);
/*
* This file is part of the TYPO3 CMS project.
*
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
namespace TYPO3\CMS\Seo\XmlSitemap;
use Psr\Http\Message\ServerRequestInterface;
use TYPO3\CMS\Core\Context\Context;
use TYPO3\CMS\Core\Context\LanguageAspect;
use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Database\Query\QueryHelper;
use TYPO3\CMS\Core\Domain\RecordFactory;
use TYPO3\CMS\Core\Domain\Repository\PageRepository;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
/**
* Class to generate a XML sitemap for pages
* @internal this class is not part of TYPO3's Core API.
*/
class PagesXmlSitemapDataProvider extends AbstractXmlSitemapDataProvider
{
public function __construct(ServerRequestInterface $request, string $key, array $config = [], ?ContentObjectRenderer $cObj = null)
{
parent::__construct($request, $key, $config, $cObj);
$this->generateItems();
}
protected function generateItems(): void
{
$pageRepository = GeneralUtility::makeInstance(PageRepository::class);
$pages = $pageRepository->getPagesOverlay($this->getPages());
$languageAspect = $this->getCurrentLanguageAspect();
foreach ($pages as $page) {
if (!$pageRepository->isPageSuitableForLanguage($page, $languageAspect)) {
continue;
}
$this->items[] = $page + [
'lastMod' => (int)($page['SYS_LASTCHANGED'] ?: $page['tstamp']),
'changefreq' => $page['sitemap_changefreq'],
'priority' => (float)$page['sitemap_priority'],
];
}
}
protected function getPages(): array
{
if (!empty($this->config['rootPage'])) {
$rootPageId = (int)$this->config['rootPage'];
} else {
$site = $this->request->getAttribute('site');
$rootPageId = $site->getRootPageId();
}
$excludePagesRecursive = GeneralUtility::intExplode(',', (string)($this->config['excludePagesRecursive'] ?? ''), true);
$pageRepository = GeneralUtility::makeInstance(PageRepository::class);
$pageIds = $pageRepository->getDescendantPageIdsRecursive($rootPageId, 99, 0, $excludePagesRecursive);
$pageIds = array_merge([$rootPageId], $pageIds);
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
->getQueryBuilderForTable('pages');
$constraints = [
$queryBuilder->expr()->in('uid', $pageIds),
];
if (!empty($this->config['additionalWhere'])) {
$constraints[] = QueryHelper::quoteDatabaseIdentifiers($queryBuilder->getConnection(), QueryHelper::stripLogicalOperatorPrefix($this->config['additionalWhere']));
}
if (!empty($this->config['excludedDoktypes'])) {
$excludedDoktypes = GeneralUtility::intExplode(',', (string)$this->config['excludedDoktypes']);
if (!empty($excludedDoktypes)) {
$constraints[] = $queryBuilder->expr()->notIn('doktype', implode(',', $excludedDoktypes));
}
}
$pages = $queryBuilder->select('*')
->from('pages')
->where(...$constraints)
->orderBy('uid', 'ASC')
->executeQuery()
->fetchAllAssociative();
return $pages;
}
protected function getCurrentLanguageAspect(): LanguageAspect
{
return GeneralUtility::makeInstance(Context::class)->getAspect('language');
}
protected function defineUrl(array $data): array
{
$typoLinkConfig = [
'page' => GeneralUtility::makeInstance(RecordFactory::class)->createFromDatabaseRow('pages', $data),
'parameter' => $data['uid'],
'forceAbsoluteUrl' => 1,
];
$data['loc'] = $this->cObj->createUrl($typoLinkConfig);
return $data;
}
}
Classes/XmlSitemap/RecordsXmlSitemapDataProvider.php
+175
View File
@@ -0,0 +1,175 @@
<?php
declare(strict_types=1);
/*
* This file is part of the TYPO3 CMS project.
*
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
namespace TYPO3\CMS\Seo\XmlSitemap;
use Psr\Http\Message\ServerRequestInterface;
use TYPO3\CMS\Core\Context\Context;
use TYPO3\CMS\Core\Context\WorkspaceAspect;
use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Database\Query\QueryHelper;
use TYPO3\CMS\Core\Database\Query\Restriction\WorkspaceRestriction;
use TYPO3\CMS\Core\Domain\Repository\PageRepository;
use TYPO3\CMS\Core\Schema\Capability\LanguageAwareSchemaCapability;
use TYPO3\CMS\Core\Schema\Capability\TcaSchemaCapability;
use TYPO3\CMS\Core\Schema\TcaSchemaFactory;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
use TYPO3\CMS\Seo\XmlSitemap\Exception\MissingConfigurationException;
/**
* XmlSiteDataProvider will provide information for the XML sitemap for a specific database table
* @internal this class is not part of TYPO3's Core API.
*/
class RecordsXmlSitemapDataProvider extends AbstractXmlSitemapDataProvider
{
private TcaSchemaFactory $tcaSchemaFactory;
public function __construct(ServerRequestInterface $request, string $key, array $config = [], ?ContentObjectRenderer $cObj = null)
{
parent::__construct($request, $key, $config, $cObj);
$this->tcaSchemaFactory = GeneralUtility::makeInstance(TcaSchemaFactory::class);
$this->generateItems();
}
/**
* @throws MissingConfigurationException
*/
public function generateItems(): void
{
$table = $this->config['table'];
if (!$this->tcaSchemaFactory->has($table)) {
throw new MissingConfigurationException(
'No configuration found for sitemap ' . $this->getKey(),
1535576053
);
}
$schema = $this->tcaSchemaFactory->get($table);
$pids = !empty($this->config['pid']) ? GeneralUtility::intExplode(',', (string)$this->config['pid']) : [];
$lastModifiedField = $this->config['lastModifiedField'] ?? 'tstamp';
$sortField = $this->config['sortField'] ?? 'sorting';
$changeFreqField = $schema->hasField($this->config['changeFreqField'] ?? '') ? $this->config['changeFreqField'] : '';
$priorityField = $schema->hasField($this->config['priorityField'] ?? '') ? $this->config['priorityField'] : '';
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
->getQueryBuilderForTable($table);
$constraints = [];
if ($schema->isLanguageAware()) {
/** @var LanguageAwareSchemaCapability $languageCapability */
$languageCapability = $schema->getCapability(TcaSchemaCapability::Language);
$constraints[] = $queryBuilder->expr()->in(
$languageCapability->getLanguageField()->getName(),
[
-1, // All languages
$this->getLanguageId(), // Current language
]
);
}
if (!empty($pids)) {
$recursiveLevel = isset($this->config['recursive']) ? (int)$this->config['recursive'] : 0;
$pids = GeneralUtility::makeInstance(PageRepository::class)->getPageIdsRecursive($pids, $recursiveLevel);
$constraints[] = $queryBuilder->expr()->in('pid', $pids);
}
if (!empty($this->config['additionalWhere'])) {
$constraints[] = QueryHelper::quoteDatabaseIdentifiers($queryBuilder->getConnection(), QueryHelper::stripLogicalOperatorPrefix($this->config['additionalWhere']));
}
$queryBuilder->getRestrictions()->add(
GeneralUtility::makeInstance(WorkspaceRestriction::class, $this->getCurrentWorkspaceAspect()->getId())
);
$queryBuilder->select('*')
->from($table);
if (!empty($constraints)) {
$queryBuilder->where(
...$constraints
);
}
$rows = $queryBuilder->orderBy($sortField)
->executeQuery()
->fetchAllAssociative();
foreach ($rows as $row) {
$item = [
'data' => $row,
'lastMod' => (int)$row[$lastModifiedField],
];
if (!empty($changeFreqField)) {
$item['changefreq'] = $row[$changeFreqField];
}
$item['priority'] = !empty($priorityField) ? $row[$priorityField] : 0.5;
$this->items[] = $item;
}
}
protected function defineUrl(array $data): array
{
$pageId = $this->request->getAttribute('frontend.page.information')->getId();
$pageId = $this->config['url']['pageId'] ?? $pageId;
$additionalParams = $this->getUrlFieldParameterMap($data['data']);
$additionalParams = $this->getUrlAdditionalParams($additionalParams);
$data['loc'] = $this->cObj->createUrl([
'parameter' => $pageId,
'queryParameters' => $additionalParams,
'forceAbsoluteUrl' => 1,
]);
return $data;
}
protected function getUrlFieldParameterMap(array $data): array
{
$additionalParams = [];
if (!empty($this->config['url']['fieldToParameterMap'])
&& is_array($this->config['url']['fieldToParameterMap'])) {
foreach ($this->config['url']['fieldToParameterMap'] as $field => $urlPart) {
$paramValue = $data[$field];
parse_str($urlPart . '=' . urlencode((string)$paramValue), $nested);
$additionalParams = array_replace_recursive($additionalParams, $nested);
}
}
return $additionalParams;
}
protected function getUrlAdditionalParams(array $additionalParams): array
{
if (!empty($this->config['url']['additionalGetParameters'])
&& is_array($this->config['url']['additionalGetParameters'])) {
$additionalParams = array_replace_recursive($additionalParams, $this->config['url']['additionalGetParameters']);
}
return $additionalParams;
}
protected function getLanguageId(): int
{
$context = GeneralUtility::makeInstance(Context::class);
return (int)$context->getPropertyFromAspect('language', 'id');
}
protected function getCurrentWorkspaceAspect(): WorkspaceAspect
{
return GeneralUtility::makeInstance(Context::class)->getAspect('workspace');
}
}
Classes/XmlSitemap/XmlSitemapDataProviderInterface.php
+33
View File
@@ -0,0 +1,33 @@
<?php
declare(strict_types=1);
/*
* This file is part of the TYPO3 CMS project.
*
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
namespace TYPO3\CMS\Seo\XmlSitemap;
use Psr\Http\Message\ServerRequestInterface;
use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
/**
* Interface for XmlSitemapDataProviders containing the methods that are called by the XmlSitemapRenderer
*/
interface XmlSitemapDataProviderInterface
{
public function __construct(ServerRequestInterface $request, string $name, array $config = [], ?ContentObjectRenderer $cObj = null);
public function getKey(): string;
public function getItems(): array;
public function getLastModified(): int;
public function getNumberOfPages(): int;
}
Classes/XmlSitemap/XmlSitemapRenderer.php
+201
View File
@@ -0,0 +1,201 @@
<?php
declare(strict_types=1);
/*
* This file is part of the TYPO3 CMS project.
*
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
namespace TYPO3\CMS\Seo\XmlSitemap;
use Psr\Http\Message\ServerRequestInterface;
use Symfony\Component\DependencyInjection\Attribute\Autoconfigure;
use TYPO3\CMS\Core\Attribute\AsAllowedCallable;
use TYPO3\CMS\Core\Http\PropagateResponseException;
use TYPO3\CMS\Core\Security\ContentSecurityPolicy\Directive;
use TYPO3\CMS\Core\Security\ContentSecurityPolicy\HashValue;
use TYPO3\CMS\Core\Security\ContentSecurityPolicy\Mutation;
use TYPO3\CMS\Core\Security\ContentSecurityPolicy\MutationCollection;
use TYPO3\CMS\Core\Security\ContentSecurityPolicy\MutationMode;
use TYPO3\CMS\Core\Security\ContentSecurityPolicy\PolicyRegistry;
use TYPO3\CMS\Core\SystemResource\Exception\CanNotResolvePublicResourceException;
use TYPO3\CMS\Core\SystemResource\Exception\CanNotResolveSystemResourceException;
use TYPO3\CMS\Core\SystemResource\Exception\SystemResourceDoesNotExistException;
use TYPO3\CMS\Core\SystemResource\Publishing\SystemResourcePublisherInterface;
use TYPO3\CMS\Core\SystemResource\SystemResourceFactory;
use TYPO3\CMS\Core\SystemResource\Type\PublicResourceInterface;
use TYPO3\CMS\Core\SystemResource\Type\SystemResourceInterface;
use TYPO3\CMS\Core\TypoScript\TypoScriptService;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\View\ViewFactoryData;
use TYPO3\CMS\Core\View\ViewFactoryInterface;
use TYPO3\CMS\Core\View\ViewInterface;
use TYPO3\CMS\Frontend\Controller\ErrorController;
use TYPO3\CMS\Seo\XmlSitemap\Exception\InvalidConfigurationException;
/**
* Class to render the XML Sitemap to be used as a UserFunction.
*
* @internal this class is not part of TYPO3's Core API.
*/
#[Autoconfigure(public: true)]
final readonly class XmlSitemapRenderer
{
public function __construct(
private TypoScriptService $typoScriptService,
private ErrorController $errorController,
private ViewFactoryInterface $viewFactory,
private PolicyRegistry $policyRegistry,
private SystemResourceFactory $resourceFactory,
private SystemResourcePublisherInterface $resourcePublisher,
) {}
/**
* @param string $_ unused, but needed as this is called via userfunc and passes a string as first parameter
* @param array $typoScriptConfiguration TypoScript configuration specified in USER Content Object
* @throws InvalidConfigurationException
*/
#[AsAllowedCallable]
public function render(string $_, array $typoScriptConfiguration, ServerRequestInterface $request): string
{
$settingsTree = $request->getAttribute('frontend.typoscript')->getSetupTree()->getChildByName('plugin')->getChildByName('tx_seo');
$configurationArrayWithoutDots = $this->typoScriptService->convertTypoScriptArrayToPlainArray($settingsTree->toArray());
$viewConfiguration = $configurationArrayWithoutDots['view'] ?? [];
$viewFactoryData = new ViewFactoryData(
templateRootPaths: $viewConfiguration['templateRootPaths'] ?? [],
partialRootPaths: $viewConfiguration['partialRootPaths'] ?? [],
layoutRootPaths: $viewConfiguration['layoutRootPaths'] ?? [],
request: $request,
format: 'xml',
);
$view = $this->viewFactory->create($viewFactoryData);
$sitemapType = $typoScriptConfiguration['sitemapType'] ?? 'xmlSitemap';
$view->assign('type', $request->getAttribute('routing')->getPageType());
$view->assign('sitemapType', $sitemapType);
$configConfiguration = $configurationArrayWithoutDots['config'] ?? [];
if (!empty($sitemapName = ($request->getQueryParams()['tx_seo']['sitemap'] ?? null))) {
$xslResource = $this->getXslResource($configConfiguration, $sitemapType, $sitemapName);
$this->applyDynamicContentSecurityPolicy($xslResource);
$view->assign('xslFile', (string)$this->resourcePublisher->generateUri($xslResource, $request));
return $this->renderSitemap($request, $view, $configConfiguration, $sitemapType, $sitemapName);
}
$xslResource = $this->getXslResource($configConfiguration, $sitemapType);
$this->applyDynamicContentSecurityPolicy($xslResource);
$view->assign('xslFile', (string)$this->resourcePublisher->generateUri($xslResource, $request));
return $this->renderIndex($request, $view, $configConfiguration, $sitemapType);
}
private function renderIndex(ServerRequestInterface $request, ViewInterface $view, array $configConfiguration, string $sitemapType): string
{
$sitemaps = [];
foreach ($configConfiguration[$sitemapType]['sitemaps'] as $sitemapName => $sitemapConfig) {
$sitemapProvider = $sitemapConfig['provider'] ?? null;
if (is_string($sitemapName)
&& is_string($sitemapProvider)
&& class_exists($sitemapProvider)
&& is_subclass_of($sitemapProvider, XmlSitemapDataProviderInterface::class)
) {
/** @var XmlSitemapDataProviderInterface $provider */
$provider = GeneralUtility::makeInstance($sitemapProvider, $request, $sitemapName, $sitemapConfig['config'] ?? []);
$pages = $provider->getNumberOfPages();
for ($page = 0; $page < $pages; $page++) {
$sitemaps[] = [
'key' => $sitemapName,
'page' => $page,
'lastMod' => $provider->getLastModified(),
];
}
}
}
$view->assign('sitemaps', $sitemaps);
return $view->render('Index');
}
private function renderSitemap(ServerRequestInterface $request, ViewInterface $view, array $configConfiguration, string $sitemapType, string $sitemapName): string
{
$sitemapConfig = $configConfiguration[$sitemapType]['sitemaps'][$sitemapName] ?? null;
if ($sitemapConfig) {
$sitemapProvider = $sitemapConfig['provider'] ?? null;
if (is_string($sitemapProvider)
&& class_exists($sitemapProvider)
&& is_subclass_of($sitemapProvider, XmlSitemapDataProviderInterface::class)
) {
/** @var XmlSitemapDataProviderInterface $provider */
$provider = GeneralUtility::makeInstance($sitemapProvider, $request, $sitemapName, $sitemapConfig['config'] ?? []);
$items = $provider->getItems();
$view->assign('items', $items);
$template = $sitemapConfig['config']['template'] ?? $sitemapConfig['template'] ?? 'Sitemap';
return $view->render($template);
}
throw new InvalidConfigurationException('No valid provider set for ' . $sitemapName, 1535578522);
}
throw new PropagateResponseException(
$this->errorController->pageNotFoundAction(
$request,
'No valid configuration found for sitemap ' . $sitemapName
),
1535578569
);
}
/**
* @throws CanNotResolvePublicResourceException
* @throws CanNotResolveSystemResourceException
*/
private function getXslResource(array $configConfiguration, string $sitemapType, ?string $sitemapName = null): PublicResourceInterface&SystemResourceInterface
{
$resourceIdentifier = $configConfiguration[$sitemapType]['sitemaps'][$sitemapName ?? '']['config']['xslFile']
?? $configConfiguration[$sitemapType]['sitemaps']['xslFile']
?? $configConfiguration['xslFile']
?? 'EXT:seo/Resources/Public/CSS/Sitemap.xsl';
$xslResource = $this->resourceFactory->createPublicResource($resourceIdentifier);
if (!$xslResource instanceof SystemResourceInterface) {
throw new \InvalidArgumentException('Can not resolve xslFile "%s" to a system resource', 1761032332);
}
return $xslResource;
}
/**
* Applies `Content-Security-Policy` mutations for `unsafe-hashes` for XSLT styles.
* This is done dynamically, since XSLT styles might change some day...
*
* The expected hash for the default XSLT styles is `sha256-d0ax6zoVJBeBpy4l3O2FJ6Y1L4SalCWw2x62uoJH15k=`.
*/
private function applyDynamicContentSecurityPolicy(SystemResourceInterface $xslResource): void
{
try {
$dom = new \DOMDocument();
$dom->loadXML($xslResource->getContents());
} catch (SystemResourceDoesNotExistException) {
return;
}
$hashes = [];
foreach ($dom->getElementsByTagName('style') as $node) {
if ($node->getAttribute('type') !== 'text/css') {
continue;
}
$hashes[] = HashValue::hash($node->textContent);
}
if ($hashes === []) {
return;
}
$this->policyRegistry->appendMutationCollection(
new MutationCollection(
new Mutation(
MutationMode::Extend,
Directive::StyleSrcElem,
...$hashes
)
)
);
}
}