PageTsConfigIncludesController.php

Go to the documentation of this file.

<?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\Backend\Controller\PageTsConfig;
 
use Psr\Container\ContainerInterface;
use Psr\Http\Message\ResponseFactoryInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\StreamFactoryInterface;
use ‪TYPO3\CMS\Backend\Attribute\AsController;
use ‪TYPO3\CMS\Backend\Module\ModuleData;
use ‪TYPO3\CMS\Backend\Routing\UriBuilder;
use ‪TYPO3\CMS\Backend\Template\ModuleTemplate;
use ‪TYPO3\CMS\Backend\Template\ModuleTemplateFactory;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Http\RedirectResponse;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
use ‪TYPO3\CMS\Core\Site\Entity\Site;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\IncludeNode\RootInclude;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\IncludeNode\SiteInclude;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\IncludeNode\TsConfigInclude;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\Traverser\IncludeTreeTraverser;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\TsConfigTreeBuilder;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\Visitor\IncludeTreeAstBuilderVisitor;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\Visitor\IncludeTreeConditionAggregatorVisitor;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\Visitor\IncludeTreeConditionEnforcerVisitor;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\Visitor\IncludeTreeNodeFinderVisitor;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\Visitor\IncludeTreeSetupConditionConstantSubstitutionVisitor;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\Visitor\IncludeTreeSourceAggregatorVisitor;
use TYPO3\CMS\Core\TypoScript\IncludeTree\Visitor\IncludeTreeSyntaxScannerVisitor;
use ‪TYPO3\CMS\Core\TypoScript\Tokenizer\LosslessTokenizer;
 
#[AsController]
final class ‪PageTsConfigIncludesController
{
    public function ‪__construct(
        private readonly ContainerInterface $container,
        private readonly ‪UriBuilder $uriBuilder,
        private readonly ‪ModuleTemplateFactory $moduleTemplateFactory,
        private readonly ‪TsConfigTreeBuilder $tsConfigTreeBuilder,
        private readonly ResponseFactoryInterface $responseFactory,
        private readonly StreamFactoryInterface $streamFactory,
    ) {}
 
    public function ‪indexAction(ServerRequestInterface $request): ResponseInterface
    {
        $backendUser = $this->‪getBackendUser();
        $languageService = $this->‪getLanguageService();
 
        $queryParams = $request->getQueryParams();
        $parsedBody = $request->getParsedBody();
 
        $currentModule = $request->getAttribute('module');
        $currentModuleIdentifier = $currentModule->getIdentifier();
        $moduleData = $request->getAttribute('moduleData');
 
        $pageUid = (int)($queryParams['id'] ?? 0);
        $pageRecord = BackendUtility::readPageAccess($pageUid, '1=1') ?: [];
        if (empty($pageRecord)) {
            // Redirect to records overview if page could not be determined.
            // Edge case if page has been removed meanwhile.
            BackendUtility::setUpdateSignal('updatePageTree');
            return new ‪RedirectResponse($this->uriBuilder->buildUriFromRoute('pagetsconfig_pages'));
        }
 
        // Prepare site constants if any
        $site = $request->getAttribute('site');
        $siteSettingsTree = new ‪RootInclude();
        $siteSettingsFlat = [];
        if ($site instanceof ‪Site && !$site->‪getSettings()->isEmpty()) {
            $siteSettings = $site->getSettings()->getAllFlat();
            $siteConstants = '';
            foreach ($siteSettings as $nodeIdentifier => $value) {
                $siteConstants .= $nodeIdentifier . ' = ' . $value . LF;
            }
            $siteSettingsNode = new ‪SiteInclude();
            $siteSettingsNode->setName('Site constants settings of site "' . $site->getIdentifier() . '"');
            $siteSettingsNode->setLineStream((new ‪LosslessTokenizer())->tokenize($siteConstants));
            $siteSettingsTree->addChild($siteSettingsNode);
            $siteSettingsTree->setIdentifier('pageTsConfig-siteSettingsTree');
            $astBuilderVisitor = $this->container->get(IncludeTreeAstBuilderVisitor::class);
            $includeTreeTraverser = new ‪IncludeTreeTraverser();
            $includeTreeTraverser->traverse($siteSettingsTree, [$astBuilderVisitor]);
            $siteSettingsAst = $astBuilderVisitor->getAst();
            $siteSettingsFlat = $siteSettingsAst->flatten();
        }
 
        // Base page TSconfig tree
        $rootLine = BackendUtility::BEgetRootLine($pageUid, '', true);
        ksort($rootLine);
        $pageTsConfigTree = $this->tsConfigTreeBuilder->getPagesTsConfigTree($rootLine, new ‪LosslessTokenizer());
 
        // Overload tree with user TSconfig if any
        $userTsConfig = $backendUser->getUserTsConfig();
        if ($userTsConfig === null) {
            throw new \RuntimeException('User TSconfig not initialized', 1675535278);
        }
        $userTsConfigAst = $userTsConfig->getUserTsConfigTree();
        $userTsConfigPageOverrides = '';
        // @todo: Ugly, similar in PageTsConfigFactory.
        $userTsConfigFlat = $userTsConfigAst->flatten();
        foreach ($userTsConfigFlat as $userTsConfigIdentifier => $userTsConfigValue) {
            if (str_starts_with($userTsConfigIdentifier, 'page.')) {
                $userTsConfigPageOverrides .= substr($userTsConfigIdentifier, 5) . ' = ' . $userTsConfigValue . chr(10);
            }
        }
        if (!empty($userTsConfigPageOverrides)) {
            $includeNode = new ‪TsConfigInclude();
            $includeNode->setName('pageTsConfig-overrides-by-userTsConfig');
            $includeNode->setLineStream((new ‪LosslessTokenizer())->tokenize($userTsConfigPageOverrides));
            $pageTsConfigTree->addChild($includeNode);
        }
        $pageTsConfigTree->setIdentifier('pageTsConfig-pageTsConfigTree');
 
        // Set enabled conditions in page TSconfig include tree and let it handle constant substitutions in page TSconfig conditions.
        $treeTraverser = new ‪IncludeTreeTraverser();
        $treeTraverserVisitors = [];
        $syntaxScannerVisitor = new IncludeTreeSyntaxScannerVisitor();
        $treeTraverserVisitors[] = $syntaxScannerVisitor;
        $pageTsConfigConditions = $this->‪handleToggledPageTsConfigConditions($pageTsConfigTree, $moduleData, $parsedBody, $siteSettingsFlat);
        $conditionEnforcerVisitor = new ‪IncludeTreeConditionEnforcerVisitor();
        $conditionEnforcerVisitor->setEnabledConditions(array_column(array_filter($pageTsConfigConditions, static fn(array $condition): bool => (bool)$condition['active']), 'value'));
        $treeTraverserVisitors[] = $conditionEnforcerVisitor;
        $treeTraverser->traverse($pageTsConfigTree, $treeTraverserVisitors);
 
        $view = $this->moduleTemplateFactory->create($request);
        $view->setTitle($languageService->sL($currentModule->getTitle()), $pageRecord['title'] ?? ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'] ?? '');
        $view->getDocHeaderComponent()->setMetaInformation($pageRecord);
        $this->‪addShortcutButtonToDocHeader($view, $currentModuleIdentifier, $pageRecord, $pageUid);
        $view->makeDocHeaderModuleMenu(['id' => $pageUid]);
        $view->assignMultiple([
            'pageUid' => $pageUid,
            'pageTitle' => $pageRecord['title'] ?? ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'] ?? '',
            'siteSettingsTree' => $siteSettingsTree,
            'pageTsConfigTree' => $pageTsConfigTree,
            'pageTsConfigConditions' => $pageTsConfigConditions,
            'pageTsConfigConditionsActiveCount' => count(array_filter($pageTsConfigConditions, static fn(array $condition): bool => (bool)$condition['active'])),
            'syntaxErrors' => $syntaxScannerVisitor->getErrors(),
            'syntaxErrorCount' => count($syntaxScannerVisitor->getErrors()),
        ]);
        return $view->renderResponse('PageTsConfig/Includes');
    }
 
    public function ‪sourceAction(ServerRequestInterface $request): ResponseInterface
    {
        $backendUser = $this->‪getBackendUser();
        $queryParams = $request->getQueryParams();
        $pageUid = (int)($queryParams['id'] ?? 0);
        $type = $queryParams['includeType'] ?? null;
        $includeIdentifier = $queryParams['identifier'] ?? null;
        if ($pageUid === 0 || $includeIdentifier === null || !in_array($type, ['constants', 'setup'], true)) {
            return $this->responseFactory->createResponse(400);
        }
 
        if ($type === 'constants') {
            // Prepare site constants if any
            $site = $request->getAttribute('site');
            $includeTree = new ‪RootInclude();
            if ($site instanceof ‪Site && !$site->‪getSettings()->isEmpty()) {
                $siteSettings = $site->getSettings()->getAllFlat();
                $siteConstants = '';
                foreach ($siteSettings as $nodeIdentifier => $value) {
                    $siteConstants .= $nodeIdentifier . ' = ' . $value . LF;
                }
                $siteSettingsNode = new ‪SiteInclude();
                $siteSettingsNode->setName('Site constants settings of site "' . $site->getIdentifier() . '"');
                $siteSettingsNode->setLineStream((new ‪LosslessTokenizer())->tokenize($siteConstants));
                $includeTree->addChild($siteSettingsNode);
                $includeTree->setIdentifier('pageTsConfig-siteSettingsTree');
            }
        } else {
            // Base page TSconfig tree
            $rootLine = BackendUtility::BEgetRootLine($pageUid, '', true);
            ksort($rootLine);
            $includeTree = $this->tsConfigTreeBuilder->getPagesTsConfigTree($rootLine, new ‪LosslessTokenizer());
 
            // Overload tree with user TSconfig if any
            $userTsConfig = $backendUser->getUserTsConfig();
            if ($userTsConfig === null) {
                throw new \RuntimeException('UserTsConfig not initialized', 1675535279);
            }
            $userTsConfigAst = $userTsConfig->getUserTsConfigTree();
            $userTsConfigPageOverrides = '';
            // @todo: Ugly, similar in PageTsConfigFactory.
            $userTsConfigFlat = $userTsConfigAst->flatten();
            foreach ($userTsConfigFlat as $userTsConfigIdentifier => $userTsConfigValue) {
                if (str_starts_with($userTsConfigIdentifier, 'page.')) {
                    $userTsConfigPageOverrides .= substr($userTsConfigIdentifier, 5) . ' = ' . $userTsConfigValue . chr(10);
                }
            }
            if (!empty($userTsConfigPageOverrides)) {
                $includeNode = new ‪TsConfigInclude();
                $includeNode->setName('pageTsConfig-overrides-by-userTsConfig');
                $includeNode->setLineStream((new ‪LosslessTokenizer())->tokenize($userTsConfigPageOverrides));
                $includeTree->addChild($includeNode);
            }
            $includeTree->setIdentifier('pageTsConfig-pageTsConfigTree');
        }
 
        $nodeFinderVisitor = new ‪IncludeTreeNodeFinderVisitor();
        $nodeFinderVisitor->setNodeIdentifier($includeIdentifier);
        $treeTraverser = new ‪IncludeTreeTraverser();
        $treeTraverser->traverse($includeTree, [$nodeFinderVisitor]);
        $lineStream = $nodeFinderVisitor->getFoundNode()?->getLineStream();
        if ($lineStream === null) {
            return $this->responseFactory->createResponse(400);
        }
 
        return $this->responseFactory
            ->createResponse()
            ->withHeader('Content-Type', 'text/plain')
            ->withBody($this->streamFactory->createStream((string)$lineStream));
    }
 
    public function ‪sourceWithIncludesAction(ServerRequestInterface $request): ResponseInterface
    {
        $backendUser = $this->‪getBackendUser();
        $queryParams = $request->getQueryParams();
        $pageUid = (int)($queryParams['id'] ?? 0);
        $type = $queryParams['includeType'] ?? null;
        $includeIdentifier = $queryParams['identifier'] ?? null;
        if ($pageUid === 0 || $includeIdentifier === null || !in_array($type, ['constants', 'setup'], true)) {
            return $this->responseFactory->createResponse(400);
        }
 
        if ($type === 'constants') {
            // Prepare site constants if any
            $site = $request->getAttribute('site');
            $includeTree = new ‪RootInclude();
            if ($site instanceof ‪Site && !$site->‪getSettings()->isEmpty()) {
                $siteSettings = $site->getSettings()->getAllFlat();
                $siteConstants = '';
                foreach ($siteSettings as $nodeIdentifier => $value) {
                    $siteConstants .= $nodeIdentifier . ' = ' . $value . LF;
                }
                $siteSettingsNode = new ‪SiteInclude();
                $siteSettingsNode->setName('Site constants settings of site "' . $site->getIdentifier() . '"');
                $siteSettingsNode->setLineStream((new ‪LosslessTokenizer())->tokenize($siteConstants));
                $includeTree->addChild($siteSettingsNode);
                $includeTree->setIdentifier('pageTsConfig-siteSettingsTree');
            }
        } else {
            // Base page TSconfig tree
            $rootLine = BackendUtility::BEgetRootLine($pageUid, '', true);
            ksort($rootLine);
            $includeTree = $this->tsConfigTreeBuilder->getPagesTsConfigTree($rootLine, new ‪LosslessTokenizer());
 
            // Overload tree with user TSconfig if any
            $userTsConfig = $backendUser->getUserTsConfig();
            if ($userTsConfig === null) {
                throw new \RuntimeException('UserTsConfig not initialized', 1675535280);
            }
            $userTsConfigAst = $userTsConfig->getUserTsConfigTree();
            $userTsConfigPageOverrides = '';
            // @todo: Ugly, similar in PageTsConfigFactory.
            $userTsConfigFlat = $userTsConfigAst->flatten();
            foreach ($userTsConfigFlat as $userTsConfigIdentifier => $userTsConfigValue) {
                if (str_starts_with($userTsConfigIdentifier, 'page.')) {
                    $userTsConfigPageOverrides .= substr($userTsConfigIdentifier, 5) . ' = ' . $userTsConfigValue . chr(10);
                }
            }
            if (!empty($userTsConfigPageOverrides)) {
                $includeNode = new ‪TsConfigInclude();
                $includeNode->setName('pageTsConfig-overrides-by-userTsConfig');
                $includeNode->setLineStream((new ‪LosslessTokenizer())->tokenize($userTsConfigPageOverrides));
                $includeTree->addChild($includeNode);
            }
            $includeTree->setIdentifier('pageTsConfig-pageTsConfigTree');
        }
 
        $sourceAggregatorVisitor = new ‪IncludeTreeSourceAggregatorVisitor();
        $sourceAggregatorVisitor->setStartNodeIdentifier($includeIdentifier);
        $treeTraverser = new ‪IncludeTreeTraverser();
        $treeTraverser->traverse($includeTree, [$sourceAggregatorVisitor]);
        $source =  $sourceAggregatorVisitor->getSource();
 
        return $this->responseFactory
            ->createResponse()
            ->withHeader('Content-Type', 'text/plain')
            ->withBody($this->streamFactory->createStream($source));
    }
 
    private function ‪handleToggledPageTsConfigConditions(‪RootInclude $pageTsConfigTree, ‪ModuleData $moduleData, ?array $parsedBody, array $flattenedConstants): array
    {
        $treeTraverser = new ‪IncludeTreeTraverser();
        $treeTraverserVisitors = [];
        $setupConditionConstantSubstitutionVisitor = new ‪IncludeTreeSetupConditionConstantSubstitutionVisitor();
        $setupConditionConstantSubstitutionVisitor->setFlattenedConstants($flattenedConstants);
        $treeTraverserVisitors[] = $setupConditionConstantSubstitutionVisitor;
        $conditionAggregatorVisitor = new ‪IncludeTreeConditionAggregatorVisitor();
        $treeTraverserVisitors[] = $conditionAggregatorVisitor;
        $treeTraverser->traverse($pageTsConfigTree, $treeTraverserVisitors);
        $pageTsConfigConditions = $conditionAggregatorVisitor->getConditions();
        $conditionsFromPost = $parsedBody['pageTsConfigConditions'] ?? [];
        $conditionsFromModuleData = array_flip((array)$moduleData->‪get('pageTsConfigConditions'));
        $conditions = [];
        foreach ($pageTsConfigConditions as $condition) {
            $conditionHash = hash('xxh3', $condition['value']);
            $conditionActive = array_key_exists($conditionHash, $conditionsFromModuleData);
            // Note we're not feeding the post values directly to module data, but filter
            // them through available conditions to prevent polluting module data with
            // manipulated post values.
            if (($conditionsFromPost[$conditionHash] ?? null) === '0') {
                unset($conditionsFromModuleData[$conditionHash]);
                $conditionActive = false;
            } elseif (($conditionsFromPost[$conditionHash] ?? null) === '1') {
                $conditionsFromModuleData[$conditionHash] = true;
                $conditionActive = true;
            }
            $conditions[] = [
                'value' => $condition['value'],
                'originalValue' => $condition['originalValue'],
                'hash' => $conditionHash,
                'active' => $conditionActive,
            ];
        }
        if ($conditionsFromPost) {
            $moduleData->‪set('pageTsConfigConditions', array_keys($conditionsFromModuleData));
            $this->‪getBackendUser()->pushModuleData($moduleData->‪getModuleIdentifier(), $moduleData->‪toArray());
        }
        return $conditions;
    }
 
    private function ‪addShortcutButtonToDocHeader(‪ModuleTemplate $view, string $moduleIdentifier, array $pageInfo, int $pageUid): void
    {
        $languageService = $this->‪getLanguageService();
        $buttonBar = $view->‪getDocHeaderComponent()->getButtonBar();
        $shortcutTitle = sprintf(
            '%s: %s [%d]',
            $languageService->sL('LLL:EXT:backend/Resources/Private/Language/locallang_pagetsconfig.xlf:module.pagetsconfig_includes'),
            BackendUtility::getRecordTitle('pages', $pageInfo),
            $pageUid
        );
        $shortcutButton = $buttonBar->makeShortcutButton()
            ->setRouteIdentifier($moduleIdentifier)
            ->setDisplayName($shortcutTitle)
            ->setArguments(['id' => $pageUid]);
        $buttonBar->addButton($shortcutButton);
    }
 
    private function ‪getLanguageService(): ‪LanguageService
    {
        return ‪$GLOBALS['LANG'];
    }
 
    private function ‪getBackendUser(): ‪BackendUserAuthentication
    {
        return ‪$GLOBALS['BE_USER'];
    }
}