TreeFromLineStreamBuilder.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\Core\TypoScript\IncludeTree;
 
use ‪TYPO3\CMS\Core\Resource\Security\FileNameValidator;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\IncludeNode\AtImportInclude;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\IncludeNode\ConditionElseInclude;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\IncludeNode\ConditionInclude;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\IncludeNode\ConditionIncludeTyposcriptInclude;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\IncludeNode\DefaultTypoScriptMagicKeyInclude;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\IncludeNode\IncludeInterface;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\IncludeNode\IncludeTyposcriptInclude;
use ‪TYPO3\CMS\Core\TypoScript\IncludeTree\IncludeNode\SegmentInclude;
use ‪TYPO3\CMS\Core\TypoScript\Tokenizer\Line\ConditionElseLine;
use ‪TYPO3\CMS\Core\TypoScript\Tokenizer\Line\ConditionLine;
use ‪TYPO3\CMS\Core\TypoScript\Tokenizer\Line\ConditionStopLine;
use ‪TYPO3\CMS\Core\TypoScript\Tokenizer\Line\ImportLine;
use ‪TYPO3\CMS\Core\TypoScript\Tokenizer\Line\ImportOldLine;
use ‪TYPO3\CMS\Core\TypoScript\Tokenizer\Line\LineInterface;
use ‪TYPO3\CMS\Core\TypoScript\Tokenizer\Line\LineStream;
use ‪TYPO3\CMS\Core\TypoScript\Tokenizer\Token\Token;
use ‪TYPO3\CMS\Core\TypoScript\Tokenizer\Token\TokenType;
use ‪TYPO3\CMS\Core\TypoScript\Tokenizer\TokenizerInterface;
use ‪TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
final class ‪TreeFromLineStreamBuilder
{
    private string ‪$type;
    private ‪TokenizerInterface ‪$tokenizer;
    private bool ‪$enableMagicIncludes = false;
 
    private array ‪$atImportTypeToSuffixMap = [
        'constants' => ['typoscript'],
        'setup' => ['typoscript'],
        'other' => ['typoscript'],
        'tsconfig' => ['typoscript', 'tsconfig'],
    ];
 
    public function ‪__construct(
        private readonly ‪FileNameValidator $fileNameValidator,
    ) {}
 
    public function ‪buildTree(‪IncludeInterface $node, string ‪$type, ‪TokenizerInterface ‪$tokenizer, bool ‪$enableMagicIncludes = true): void
    {
        if (!in_array(‪$type, ['constants', 'setup', 'tsconfig', 'other'], true)) {
            // Type "constants" and "setup" trigger the weird addStaticMagicFromGlobals() resolving, while "other" ignores it.
            throw new \RuntimeException('type must be either "constants", "setup", "tsconfig" or "other"', 1652741356);
        }
        $this->type = ‪$type;
        $this->tokenizer = ‪$tokenizer;
        $this->enableMagicIncludes = ‪$enableMagicIncludes;
        $this->‪buildTreeInternal($node);
    }
 
    private function ‪buildTreeInternal(‪IncludeInterface $node): void
    {
        $parentNode = $node;
        $givenTokenLineStream = $node->‪getLineStream();
        $lineStream = new ‪LineStream();
        $childNode = new ‪SegmentInclude();
        $childNode->setName($node->‪getName());
        $childNode->setPath($node->‪getPath());
 
        foreach ($givenTokenLineStream->getNextLine() as $line) {
            if ($line instanceof ‪ConditionLine && $node instanceof ‪ConditionInclude) {
                // Finish current condition when this line is another condition
                $node->‪setSplit();
                if (!$lineStream->isEmpty()) {
                    $childNode->setLineStream($lineStream);
                    $node->‪addChild($childNode);
                    $lineStream = new ‪LineStream();
                }
                $node = $parentNode;
            }
 
            if ($line instanceof ‪ConditionLine) {
                // A new condition not yet in condition context
                $node->‪setSplit();
                $conditionValueToken = $line->getTokenValue();
                if (!$lineStream->isEmpty()) {
                    $childNode->setLineStream($lineStream);
                    $node->‪addChild($childNode);
                    $lineStream = new ‪LineStream();
                }
                $childNode = new ‪ConditionInclude();
                $childNode->setSplit();
                $childNode->setName($node->‪getName());
                $childNode->setPath($node->‪getPath());
                $childNode->setConditionToken($conditionValueToken);
                $lineStream->append($line);
                $childNode->setLineStream($lineStream);
                $node->‪addChild($childNode);
                $parentNode = $node;
                $node = $childNode;
                $childNode = new ‪SegmentInclude();
                $childNode->setName($node->‪getName());
                $childNode->setPath($node->‪getPath());
                $lineStream = new ‪LineStream();
                continue;
            }
 
            if (($node instanceof ‪ConditionInclude || $node instanceof ‪ConditionElseInclude)
                && $line instanceof ‪ConditionStopLine
            ) {
                // Finish condition segment due to [end] or [global] line
                $node->‪setSplit();
                $lineStream->append($line);
                $childNode->setLineStream($lineStream);
                $node->‪addChild($childNode);
                $node = $parentNode;
                $childNode = new ‪SegmentInclude();
                $childNode->setName($node->‪getName());
                $childNode->setPath($node->‪getPath());
                $lineStream = new ‪LineStream();
                continue;
            }
 
            if ($node instanceof ‪ConditionInclude && $line instanceof ‪ConditionElseLine) {
                // Active condition into [else] condition
                $node->‪setSplit();
                if (!$lineStream->isEmpty()) {
                    $childNode->setLineStream($lineStream);
                    $node->‪addChild($childNode);
                }
                $conditionToken = $node->getConditionToken();
                $node = $parentNode;
                $childNode = new ‪ConditionElseInclude();
                $childNode->setSplit();
                $childNode->setName($node->‪getName());
                $childNode->setPath($node->‪getPath());
                $childNode->setConditionToken($conditionToken);
                $lineStream = new ‪LineStream();
                $lineStream->append($line);
                $childNode->setLineStream($lineStream);
                $node->‪addChild($childNode);
                $parentNode = $node;
                $node = $childNode;
                $childNode = new ‪SegmentInclude();
                $childNode->setName($node->‪getName());
                $childNode->setPath($node->‪getPath());
                $lineStream = new ‪LineStream();
                continue;
            }
 
            if ($line instanceof ‪ImportLine) {
                $node->‪setSplit();
                $atImportValueToken = $line->getValueToken();
                if (!$lineStream->isEmpty()) {
                    $childNode->setLineStream($lineStream);
                    $node->‪addChild($childNode);
                    $lineStream = new ‪LineStream();
                }
                $childNode = new ‪SegmentInclude();
                $childNode->setName($node->‪getName());
                $childNode->setPath($node->‪getPath());
                $allowedSuffixes = $this->atImportTypeToSuffixMap[‪$this->type];
                foreach ($allowedSuffixes as $allowedSuffix) {
                    $this->‪processAtImport($allowedSuffix, $node, $atImportValueToken, $line);
                }
                continue;
            }
 
            if ($line instanceof ‪ImportOldLine) {
                $node->‪setSplit();
                $includeTypoScriptValueToken = $line->getValueToken();
                if (!$lineStream->isEmpty()) {
                    $childNode->setLineStream($lineStream);
                    $node->‪addChild($childNode);
                    $lineStream = new ‪LineStream();
                }
                $childNode = new ‪SegmentInclude();
                $childNode->setName($node->‪getName());
                $childNode->setPath($node->‪getPath());
                $this->‪processIncludeTyposcript($node, $includeTypoScriptValueToken, $line);
                continue;
            }
 
            $lineStream->append($line);
        }
 
        if ($node->‪isSplit() && !$lineStream->isEmpty()) {
            $childNode->setLineStream($lineStream);
            $node->‪addChild($childNode);
        }
    }
 
    private function ‪processAtImport(string $fileSuffix, ‪IncludeInterface $node, ‪Token $atImportValueToken, ‪LineInterface $atImportLine, bool $tryRelative = false): void
    {
        $atImportValue = $atImportValueToken->‪getValue();
        $atImportName = $atImportValue;
        if ($tryRelative) {
            if (empty($node->‪getPath())) {
                return;
            }
            $parentPath = rtrim(dirname($node->‪getPath()), '/') . '/';
            $atImportValue = ltrim($atImportValue, './');
            $atImportName = preg_replace('#([:/])[^:/]+$#', '$1', $node->‪getName()) . $atImportValue;
            $atImportValue = $parentPath . $atImportValue;
        }
        $absoluteFileName = rtrim(GeneralUtility::getFileAbsFileName($atImportValue), '/');
        if ($absoluteFileName === '') {
            return;
        }
        if (str_ends_with($absoluteFileName, '.' . $fileSuffix) && is_file($absoluteFileName)) {
            // Simple file with allowed file suffix
            if ($this->fileNameValidator->isValid($absoluteFileName)) {
                $this->‪addSingleAtImportFile($node, $absoluteFileName, $atImportValue, $atImportName, $atImportLine);
                $this->‪addStaticMagicFromGlobals($node, $atImportValue);
            }
        } elseif (is_dir($absoluteFileName)) {
            // Directories with and without ending /
            $filesAndDirs = scandir($absoluteFileName);
            foreach ($filesAndDirs as $potentialInclude) {
                if (!str_ends_with($potentialInclude, '.' . $fileSuffix)
                    || is_dir($absoluteFileName . '/' . $potentialInclude)
                    || !$this->fileNameValidator->isValid($absoluteFileName . '/' . $potentialInclude)
                ) {
                    continue;
                }
                $singleAbsoluteFileName = $absoluteFileName . '/' . $potentialInclude;
                ‪$identifier = rtrim($atImportValue, '/') . '/' . $potentialInclude;
                $this->‪addSingleAtImportFile($node, $singleAbsoluteFileName, ‪$identifier, ‪$identifier, $atImportLine);
                $this->‪addStaticMagicFromGlobals($node, ‪$identifier);
            }
        } elseif (is_file($absoluteFileName . '.' . $fileSuffix)) {
            // File without .typoscript / .tsconfig suffix, but exists when suffix is added
            if ($this->fileNameValidator->isValid($absoluteFileName . '.' . $fileSuffix)) {
                $singleAbsoluteFileName = $absoluteFileName . '.' . $fileSuffix;
                ‪$identifier = $atImportValue . '.' . $fileSuffix;
                $this->‪addSingleAtImportFile($node, $singleAbsoluteFileName, ‪$identifier, ‪$identifier, $atImportLine);
                $this->‪addStaticMagicFromGlobals($node, ‪$identifier);
            }
        } elseif (str_contains($absoluteFileName, '*')) {
            // Something with *
            $directory = rtrim(dirname($absoluteFileName) . '/');
            $directoryExists = is_dir($directory);
            if (!$directoryExists && str_starts_with($atImportValue, './') && !$tryRelative) {
                // See if we can import some relative wildcard like "./Setup/*" or "./Setup/*.typoscript"
                $this->‪processAtImport($fileSuffix, $node, $atImportValueToken, $atImportLine, true);
                return;
            }
            if (!$directoryExists) {
                // Absolute directory. There is nothing to import if the directory does not exist.
                return;
            }
            $filePattern = basename($absoluteFileName);
            if (!str_contains($filePattern, '*')) {
                // The * wildcard must occur in the filename, wildcards in directories are not handled.
                return;
            }
            if (mb_substr_count($filePattern, '*') > 1) {
                // Only one wildcard character is allowed, foo*.bar*.typoscript is considered an invalid pattern.
                return;
            }
            // Normalize right side, making sure it always ends with $fileSuffix ".typoscript" / ".tsconfig"
            if (str_ends_with($filePattern, $fileSuffix)) {
                $filePattern = mb_substr($filePattern, 0, -1 * strlen($fileSuffix));
                $filePattern = rtrim($filePattern, '.');
            }
            $filePattern = $filePattern . '.' . $fileSuffix;
            $wildcardPosition = mb_strpos($filePattern, '*');
            $leftPrefix = mb_substr($filePattern, 0, $wildcardPosition);
            $rightPrefix = mb_substr($filePattern, $wildcardPosition + 1);
            $filesAndDirs = scandir($directory);
            foreach ($filesAndDirs as $potentialInclude) {
                if ($potentialInclude === '.'
                    || $potentialInclude === '..'
                    || !str_starts_with($potentialInclude, $leftPrefix)
                    || !str_ends_with($potentialInclude, $rightPrefix)
                    || is_dir($directory . $potentialInclude)
                    || !$this->fileNameValidator->isValid($directory . $potentialInclude)
                ) {
                    continue;
                }
                $singleAbsoluteFileName = $directory . $potentialInclude;
                ‪$identifier = rtrim(dirname($atImportValue), '/') . '/' . $potentialInclude;
                $this->‪addSingleAtImportFile($node, $singleAbsoluteFileName, ‪$identifier, ‪$identifier, $atImportLine);
                $this->‪addStaticMagicFromGlobals($node, ‪$identifier);
            }
        } elseif (!$tryRelative) {
            // See if we can import relative "./foo.typoscript" or "foo.typoscript"
            $this->‪processAtImport($fileSuffix, $node, $atImportValueToken, $atImportLine, true);
        }
    }
 
    private function ‪addSingleAtImportFile(
        ‪IncludeInterface $parentNode,
        string $absoluteFileName,
        string $path,
        string $name,
        ‪LineInterface $atImportLine
    ): void {
        $content = file_get_contents($absoluteFileName);
        $newNode = new ‪AtImportInclude();
        $newNode->setName($name);
        $newNode->setPath($path);
        $newNode->setLineStream($this->tokenizer->tokenize($content));
        $newNode->setOriginalLine($atImportLine);
        $this->‪buildTreeInternal($newNode);
        $parentNode->‪addChild($newNode);
    }
 
    private function ‪processIncludeTyposcript(‪IncludeInterface $node, ‪Token $includeTyposcriptValueToken, ‪LineInterface $importKeywordOldLine): void
    {
        $fullString = $includeTyposcriptValueToken->‪getValue();
        $potentialSourceArray = preg_split('#.*(source="[^"]*").*|>#', $fullString, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
        $source = '';
        foreach ($potentialSourceArray as $candidate) {
            $candidate = trim($candidate);
            if (str_starts_with($candidate, 'source="')) {
                $source = rtrim(substr($candidate, 8), '"');
                $source = str_replace([' ', "\t"], '', $source);
                break;
            }
        }
        if (empty($source)) {
            // No 'source="..."'
            return;
        }
        $potentialConditionArray = preg_split('#.*(condition="(?:\\\\\\\\|\\\\"|[^\"])*").*|>#', $fullString, 2, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
        $condition = '';
        foreach ($potentialConditionArray as $candidate) {
            $candidate = trim($candidate);
            if (str_starts_with($candidate, 'condition="')) {
                $candidate = trim(substr($candidate, 10), '"');
                if (str_starts_with($candidate, '[') && str_ends_with($candidate, ']')) {
                    // Cut off '[' and ']' if exist.
                    $candidate = mb_substr($candidate, 1, -1);
                }
                $condition = stripslashes($candidate);
                break;
            }
        }
        $potentialExtensionsArray = preg_split('#.*(extensions*="[^"]*").*|>#', $fullString, 2, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
        $extensions = [];
        foreach ($potentialExtensionsArray as $candidate) {
            $candidate = trim($candidate);
            if (str_starts_with($candidate, 'extensions="')) {
                $extensions = ‪GeneralUtility::trimExplode(',', rtrim(substr($candidate, 12), '"'), true);
                break;
            }
        }
 
        if (str_starts_with($source, 'FILE:./')) {
            // Single relative file include
            $fileName = dirname($node->‪getPath()) . '/' . substr($source, 7);
            $absoluteFileName = rtrim(GeneralUtility::getFileAbsFileName($fileName), '/');
            if ($absoluteFileName === '') {
                return;
            }
            if ($this->fileNameValidator->isValid($absoluteFileName) && is_file($absoluteFileName)) {
                $nodeToAddTo = $this->‪processConditionalIncludeTyposcript($node, $condition, $fileName);
                $this->‪addSingleIncludeTyposcriptFile($nodeToAddTo, $absoluteFileName, $fileName, $importKeywordOldLine);
            }
        } elseif (str_starts_with($source, 'FILE:')) {
            // Single file include, either prefixed with EXT:, or relative to public dir
            // Throw away FILE:, then resolve EXT: or public dir relative
            $fileName = substr($source, 5);
            $absoluteFileName = rtrim(GeneralUtility::getFileAbsFileName($fileName), '/');
            if ($absoluteFileName === '') {
                return;
            }
            if ($this->fileNameValidator->isValid($absoluteFileName) && is_file($absoluteFileName)) {
                $nodeToAddTo = $this->‪processConditionalIncludeTyposcript($node, $condition, $fileName);
                $this->‪addSingleIncludeTyposcriptFile($nodeToAddTo, $absoluteFileName, $fileName, $importKeywordOldLine);
                $this->‪addStaticMagicFromGlobals($nodeToAddTo, $fileName);
            }
        } elseif (str_starts_with($source, 'DIR:')) {
            // Single file include, either prefixed with EXT:, or relative to public dir
            // Throw away FILE:, then resolve EXT: or public dir relative
            $dirName = substr($source, 4);
            $absoluteDirName = rtrim(GeneralUtility::getFileAbsFileName($dirName), '/');
            if ($absoluteDirName === '' || !is_dir($absoluteDirName)) {
                return;
            }
            $nodeToAddTo = $this->‪processConditionalIncludeTyposcript($node, $condition, $dirName);
            $this->‪importIncludeTyposcriptDirectoryRecursive($nodeToAddTo, $importKeywordOldLine, $dirName, $absoluteDirName, $extensions);
        }
    }
 
    private function ‪processConditionalIncludeTyposcript(‪IncludeInterface $parentNode, ?string $condition, string $fileName): ‪IncludeInterface
    {
        $nodeToAddTo = $parentNode;
        if ($condition) {
            $conditionNode = new ‪ConditionIncludeTyposcriptInclude();
            $conditionNode->setName($fileName);
            $conditionNode->setConditionToken(new ‪Token(TokenType::T_VALUE, $condition, 0, 0));
            $conditionNode->setSplit();
            $nodeToAddTo->addChild($conditionNode);
            $nodeToAddTo = $conditionNode;
        }
        return $nodeToAddTo;
    }
 
    private function ‪importIncludeTyposcriptDirectoryRecursive(
        ‪IncludeInterface $nodeToAddTo,
        ‪LineInterface $importKeywordOldLine,
        string $dirName,
        string $absoluteDirName,
        array $extensions
    ): void {
        $filesAndDirs = scandir($absoluteDirName);
        $subDirs = [];
        foreach ($filesAndDirs as $potentialInclude) {
            // Handle files in this dir and remember possible sub-dirs
            if ($potentialInclude === '.' || $potentialInclude === '..') {
                continue;
            }
            if (is_dir($absoluteDirName . '/' . $potentialInclude)) {
                $subDirs[] = $potentialInclude;
                continue;
            }
            if (!$this->fileNameValidator->isValid($absoluteDirName . '/' . $potentialInclude)) {
                continue;
            }
            if (!empty($extensions)) {
                // Check if file is allowed by allowed 'extensions' setting if given
                $fileIsAllowed = false;
                foreach ($extensions as $extension) {
                    if (str_ends_with($potentialInclude, $extension)) {
                        $fileIsAllowed = true;
                        break;
                    }
                }
                if (!$fileIsAllowed) {
                    continue;
                }
            }
            ‪$identifier = rtrim($dirName, '/') . '/' . $potentialInclude;
            $absoluteFileName = $absoluteDirName . '/' . $potentialInclude;
            $this->‪addSingleIncludeTyposcriptFile($nodeToAddTo, $absoluteFileName, ‪$identifier, $importKeywordOldLine);
        }
        foreach ($subDirs as $subDir) {
            $this->‪importIncludeTyposcriptDirectoryRecursive(
                $nodeToAddTo,
                $importKeywordOldLine,
                $dirName . '/' . $subDir,
                $absoluteDirName . '/' . $subDir,
                $extensions
            );
        }
    }
 
    private function ‪addSingleIncludeTyposcriptFile(‪IncludeInterface $parentNode, string $absoluteFileName, string $path, ‪LineInterface $importKeywordOldLine): void
    {
        $content = file_get_contents($absoluteFileName);
        $newNode = new ‪IncludeTyposcriptInclude();
        $newNode->setName($path);
        $newNode->setPath($path);
        $newNode->setLineStream($this->tokenizer->tokenize($content));
        $newNode->setOriginalLine($importKeywordOldLine);
        $this->‪buildTreeInternal($newNode);
        $parentNode->‪addChild($newNode);
    }
 
    private function ‪addStaticMagicFromGlobals(‪IncludeInterface $parentNode, string $path): void
    {
        if (!in_array($this->type, ['constants', 'setup'], true) || !str_starts_with($path, 'EXT:')) {
            // This magic method is relevant for Frontend TypoScript only, indicated by
            // $this->type being either "constants" or "setup".
            return;
        }
        $includeStaticFileWithoutExt = substr($path, 4);
        $includeStaticFileExtKeyAndPath = ‪GeneralUtility::trimExplode('/', $includeStaticFileWithoutExt, true, 2);
        $extensionKey = $includeStaticFileExtKeyAndPath[0];
        $extensionKeyWithoutUnderscores = str_replace('_', '', $extensionKey);
        if (!$extensionKeyWithoutUnderscores || !‪ExtensionManagementUtility::isLoaded($extensionKey)) {
            return;
        }
        // example: 'Configuration/TypoScript/MyStaticInclude/'
        $pathSegmentWithAppendedSlash = rtrim(dirname($includeStaticFileExtKeyAndPath[1])) . '/';
        $file = basename($path);
        ‪$type = ‪GeneralUtility::trimExplode('.', $file, false, 2)[0] ?? '';
        if (‪$type !== $this->type) {
            return;
        }
        $globalsLookup = $extensionKeyWithoutUnderscores . '/' . $pathSegmentWithAppendedSlash;
 
        if (!$this->enableMagicIncludes) {
            return;
        }
        // If this is a template of type "default content rendering", see if other extensions have added their TypoScript that should be included.
        if (in_array($globalsLookup, ‪$GLOBALS['TYPO3_CONF_VARS']['FE']['contentRenderingTemplates'], true)) {
            $source = ‪$GLOBALS['TYPO3_CONF_VARS']['FE']['defaultTypoScript_' . ‪$type . '.']['defaultContentRendering'] ?? null;
            if (!empty($source)) {
                $node = new ‪DefaultTypoScriptMagicKeyInclude();
                $node->setName('TYPO3_CONF_VARS defaultContentRendering for ' . $path);
                $node->setLineStream($this->tokenizer->tokenize($source));
                $this->‪buildTreeInternal($node);
                $parentNode->‪addChild($node);
            }
        }
    }
}