9.5/_extension_configuration_8php_source.html

<?php

declare(strict_types = 1);

namespace ‪TYPO3\CMS\Core\Configuration;


/*

 * 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!

 */


use ‪TYPO3\CMS\Core\Configuration\Exception\ExtensionConfigurationExtensionNotConfiguredException;

use ‪TYPO3\CMS\Core\Configuration\Exception\ExtensionConfigurationPathDoesNotExistException;

use TYPO3\CMS\Core\Package\PackageManager;

use ‪TYPO3\CMS\Core\Utility\ArrayUtility;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;


class ‪ExtensionConfiguration

{

    protected ‪$setup = [];


    protected ‪$raw;


    protected ‪$rawPointer = 0;


    protected ‪$lastComment = '';


    protected ‪$commentSet = false;


    protected ‪$inBrace = 0;


    public function get(string $extension, string $path = '')

    {

        $hasBeenSynchronized = false;

        if (!isset(‪$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS'][$extension]) || !is_array(‪$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS'][$extension])) {

            // This if() should not be hit at "casual" runtime, but only in early setup phases

            $this->‪synchronizeExtConfTemplateWithLocalConfigurationOfAllExtensions();

            $hasBeenSynchronized = true;

            if (!isset(‪$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS'][$extension]) || !is_array(‪$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS'][$extension])) {

                // If there is still no such entry, even after sync -> throw

                throw new ‪ExtensionConfigurationExtensionNotConfiguredException(

                    'No extension configuration for extension ' . $extension . ' found. Either this extension'

                    . ' has no extension configuration or the configuration is not up to date. Execute the'

                    . ' install tool to update configuration.',

                    1509654728

                );

            }

        }

        if (empty($path)) {

            return ‪$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS'][$extension];

        }

        if (!‪ArrayUtility::isValidPath(‪$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS'], $extension . '/' . $path)) {

            // This if() should not be hit at "casual" runtime, but only in early setup phases

            if (!$hasBeenSynchronized) {

                $this->‪synchronizeExtConfTemplateWithLocalConfigurationOfAllExtensions();

            }

            // If there is still no such entry, even after sync -> throw

            if (!‪ArrayUtility::isValidPath(‪$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS'], $extension . '/' . $path)) {

                throw new ‪ExtensionConfigurationPathDoesNotExistException(

                    'Path ' . $path . ' does not exist in extension configuration',

                    1509977699

                );

            }

        }

        return ‪ArrayUtility::getValueByPath(‪$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS'], $extension . '/' . $path);

    }


    public function set(string $extension, string $path = '', $value = null)

    {

        if (empty($extension)) {

            throw new \RuntimeException('extension name must not be empty', 1509715852);

        }

        if (!empty($path)) {

            // @todo: this functionality can be removed once EXT:bootstrap_package is adapted to the new API.

            $extensionConfiguration = $this->get($extension);

            $value = ‪ArrayUtility::setValueByPath($extensionConfiguration, $path, $value);

        }

        $configurationManager = GeneralUtility::makeInstance(ConfigurationManager::class);

        if ($value === null) {

            // Remove whole extension config

            $configurationManager->removeLocalConfigurationKeysByPath(['EXTENSIONS/' . $extension]);

            if (isset(‪$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS'][$extension])) {

                unset(‪$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS'][$extension]);

            }

        } else {

            // Set full extension config

            $configurationManager->setLocalConfigurationValueByPath('EXTENSIONS/' . $extension, $value);

            ‪$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS'][$extension] = $value;

        }


        // After TYPO3_CONF_VARS['EXTENSIONS'] has been written, update legacy layer TYPO3_CONF_VARS['EXTENSIONS']['extConf']

        // @deprecated since TYPO3 v9, will be removed in TYPO3 v10.0 with removal of old serialized 'extConf' layer

        if (!empty(‪$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS'])) {

            $extConfArray = [];

            foreach (‪$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS'] as $extensionName => $extensionConfig) {

                $extConfArray[$extensionName] = serialize($this->‪addDotsToArrayKeysRecursiveForLegacyExtConf($extensionConfig));

            }

            $configurationManager->setLocalConfigurationValueByPath('EXT/extConf', $extConfArray);

            ‪$GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'] = $extConfArray;

        }

    }


    public function ‪setAll(array $configuration)

    {

        $configurationManager = GeneralUtility::makeInstance(ConfigurationManager::class);

        $configurationManager->setLocalConfigurationValueByPath('EXTENSIONS', $configuration);

        ‪$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS'] = $configuration;


        // After TYPO3_CONF_VARS['EXTENSIONS'] has been written, update legacy layer TYPO3_CONF_VARS['EXTENSIONS']['extConf']

        // @deprecated since TYPO3 v9, will be removed in TYPO3 v10.0 with removal of old serialized 'extConf' layer

        $extConfArray = [];

        foreach ($configuration as $extensionName => $extensionConfig) {

            $extConfArray[$extensionName] = serialize($this->‪addDotsToArrayKeysRecursiveForLegacyExtConf($extensionConfig));

        }

        $configurationManager->setLocalConfigurationValueByPath('EXT/extConf', $extConfArray);

        ‪$GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'] = $extConfArray;

    }


    public function ‪synchronizeExtConfTemplateWithLocalConfigurationOfAllExtensions()

    {

        $activePackages = GeneralUtility::makeInstance(PackageManager::class)->getActivePackages();

        $fullConfiguration = [];

        $currentLocalConfiguration = ‪$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS'] ?? [];

        foreach ($activePackages as $package) {

            if (!@is_file($package->getPackagePath() . 'ext_conf_template.txt')) {

                continue;

            }

            $extensionKey = $package->getPackageKey();

            $currentExtensionConfig = $currentLocalConfiguration[$extensionKey] ?? [];

            $extConfTemplateConfiguration = $this->‪getExtConfTablesWithoutCommentsAsNestedArrayWithoutDots($extensionKey);

            ‪ArrayUtility::mergeRecursiveWithOverrule($extConfTemplateConfiguration, $currentExtensionConfig);

            if (!empty($extConfTemplateConfiguration)) {

                $fullConfiguration[$extensionKey] = $extConfTemplateConfiguration;

            }

        }

        // Write new config if changed. Loose array comparison to not write if only array key order is different

        if ($fullConfiguration != $currentLocalConfiguration) {

            $this->‪setAll($fullConfiguration);

        }

    }


    public function ‪synchronizeExtConfTemplateWithLocalConfiguration(string $extensionKey)

    {

        $package = GeneralUtility::makeInstance(PackageManager::class)->getPackage($extensionKey);

        if (!@is_file($package->getPackagePath() . 'ext_conf_template.txt')) {

            return;

        }

        $currentLocalConfiguration = ‪$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS'][$extensionKey] ?? [];

        $extConfTemplateConfiguration = $this->‪getExtConfTablesWithoutCommentsAsNestedArrayWithoutDots($extensionKey);

        ‪ArrayUtility::mergeRecursiveWithOverrule($extConfTemplateConfiguration, $currentLocalConfiguration);

        // Write new config if changed. Loose array comparison to not write if only array key order is different

        if ($extConfTemplateConfiguration != $currentLocalConfiguration) {

            $this->set($extensionKey, '', $extConfTemplateConfiguration);

        }

    }


    private function ‪addDotsToArrayKeysRecursiveForLegacyExtConf(array $extensionConfig): array

    {

        $newArray = [];

        foreach ($extensionConfig as $key => $value) {

            if (is_array($value)) {

                $newArray[$key . '.'] = $this->‪addDotsToArrayKeysRecursiveForLegacyExtConf($value);

            } else {

                $newArray[$key] = $value;

            }

        }

        return $newArray;

    }


    protected function ‪getExtConfTablesWithoutCommentsAsNestedArrayWithoutDots(string $extensionKey): array

    {

        $configuration = $this->‪getParsedExtConfTemplate($extensionKey);

        return $this->‪removeCommentsAndDotsRecursive($configuration);

    }


    public function ‪getParsedExtConfTemplate(string $extensionKey): array

    {

        $rawConfigurationString = $this->‪getDefaultConfigurationRawString($extensionKey);

        $configuration = [];

        if ((string)$rawConfigurationString !== '') {

            $this->raw = explode(LF, $rawConfigurationString);

            $this->rawPointer = 0;

            $this->setup = [];

            $this->‪parseSub($this->setup);

            if ($this->inBrace) {

                throw new \RuntimeException(

                    'Line ' . ($this->rawPointer - 1) . ': The script is short of ' . $this->inBrace . ' end brace(s)',

                    1507645349

                );

            }

            $configuration = ‪$this->setup;

        }

        return $configuration;

    }


    protected function ‪getDefaultConfigurationRawString(string $extensionKey): string

    {

        $rawString = '';

        $extConfTemplateFileLocation = GeneralUtility::getFileAbsFileName(

            'EXT:' . $extensionKey . '/ext_conf_template.txt'

        );

        if (file_exists($extConfTemplateFileLocation)) {

            $rawString = file_get_contents($extConfTemplateFileLocation);

        }

        return $rawString;

    }


    protected function ‪removeCommentsAndDotsRecursive(array $config): array

    {

        $cleanedConfig = [];

        foreach ($config as $key => $value) {

            if (substr($key, -2) === '..') {

                continue;

            }

            if (substr($key, -1) === '.') {

                $cleanedConfig[rtrim($key, '.')] = $this->‪removeCommentsAndDotsRecursive($value);

            } else {

                $cleanedConfig[$key] = $value;

            }

        }

        return $cleanedConfig;

    }


    protected function ‪parseSub(array &‪$setup)

    {

        while (isset($this->raw[$this->rawPointer])) {

            $line = ltrim($this->raw[$this->rawPointer]);

            $this->rawPointer++;

            // Set comment flag?

            if (strpos($line, '/*') === 0) {

                $this->commentSet = 1;

            }

            if (!$this->commentSet && $line) {

                if ($line[0] !== '}' && $line[0] !== '#' && $line[0] !== '/') {

                    // If not brace-end or comment

                    // Find object name string until we meet an operator

                    $varL = strcspn($line, "\t" . ' {=<>(');

                    // check for special ":=" operator

                    if ($varL > 0 && substr($line, $varL - 1, 2) === ':=') {

                        --$varL;

                    }

                    // also remove tabs after the object string name

                    $objStrName = substr($line, 0, $varL);

                    if ($objStrName !== '') {

                        $r = [];

                        if (preg_match('/[^[:alnum:]_\\\\\\.:-]/i', $objStrName, $r)) {

                            throw new \RuntimeException(

                                'Line ' . ($this->rawPointer - 1) . ': Object Name String, "' . htmlspecialchars($objStrName) . '" contains invalid character "' . $r[0] . '". Must be alphanumeric or one of: "_:-\\."',

                                1507645381

                            );

                        }

                        $line = ltrim(substr($line, $varL));

                        if ($line === '') {

                            throw new \RuntimeException(

                                'Line ' . ($this->rawPointer - 1) . ': Object Name String, "' . htmlspecialchars($objStrName) . '" was not followed by any operator, =<>({',

                                1507645417

                            );

                        }

                        switch ($line[0]) {

                            case '=':

                                if (strpos($objStrName, '.') !== false) {

                                    $value = [];

                                    $value[0] = trim(substr($line, 1));

                                    $this->‪setVal($objStrName, ‪$setup, $value);

                                } else {

                                    ‪$setup[$objStrName] = trim(substr($line, 1));

                                    if ($this->lastComment) {

                                        // Setting comment..

                                        ‪$setup[$objStrName . '..'] .= ‪$this->lastComment;

                                    }

                                }

                                break;

                            case '{':

                                $this->inBrace++;

                                if (strpos($objStrName, '.') !== false) {

                                    $this->‪rollParseSub($objStrName, ‪$setup);

                                } else {

                                    if (!isset(‪$setup[$objStrName . '.'])) {

                                        ‪$setup[$objStrName . '.'] = [];

                                    }

                                    $this->‪parseSub($setup[$objStrName . '.']);

                                }

                                break;

                            default:

                                throw new \RuntimeException(

                                    'Line ' . ($this->rawPointer - 1) . ': Object Name String, "' . htmlspecialchars($objStrName) . '" was not followed by any operator, =<>({',

                                    1507645445

                                );

                        }


                        $this->lastComment = '';

                    }

                } elseif ($line[0] === '}') {

                    $this->inBrace--;

                    $this->lastComment = '';

                    if ($this->inBrace < 0) {

                        throw new \RuntimeException(

                            'Line ' . ($this->rawPointer - 1) . ': An end brace is in excess.',

                            1507645489

                        );

                    }

                    break;

                } else {

                    $this->lastComment .= rtrim($line) . LF;

                }

            }

            // Unset comment

            if ($this->commentSet) {

                if (strpos($line, '*/') === 0) {

                    $this->commentSet = 0;

                }

            }

        }

    }


    protected function ‪rollParseSub($string, array &‪$setup)

    {

        if ((string)$string === '') {

            return;

        }

        list($key, $remainingKey) = $this->‪parseNextKeySegment($string);

        $key .= '.';

        if (!isset(‪$setup[$key])) {

            ‪$setup[$key] = [];

        }

        $remainingKey === ''

            ? $this->‪parseSub($setup[$key])

            : $this->‪rollParseSub($remainingKey, ‪$setup[$key]);

    }


    protected function ‪setVal($string, array &‪$setup, $value)

    {

        if ((string)$string === '') {

            return;

        }


        list($key, $remainingKey) = $this->‪parseNextKeySegment($string);

        $subKey = $key . '.';

        if ($remainingKey === '') {

            if (isset($value[0])) {

                ‪$setup[$key] = $value[0];

            }

            if (isset($value[1])) {

                ‪$setup[$subKey] = $value[1];

            }

            if ($this->lastComment) {

                ‪$setup[$key . '..'] .= ‪$this->lastComment;

            }

        } else {

            if (!isset(‪$setup[$subKey])) {

                ‪$setup[$subKey] = [];

            }

            $this->‪setVal($remainingKey, ‪$setup[$subKey], $value);

        }

    }


    protected function ‪parseNextKeySegment($key): array

    {

        // if no dot is in the key, nothing to do

        $dotPosition = strpos($key, '.');

        if ($dotPosition === false) {

            return [$key, ''];

        }


        if (strpos($key, '\\') !== false) {

            // backslashes are in the key, so we do further parsing

            while ($dotPosition !== false) {

                if ($dotPosition > 0 && $key[$dotPosition - 1] !== '\\' || $dotPosition > 1 && $key[$dotPosition - 2] === '\\') {

                    break;

                }

                // escaped dot found, continue

                $dotPosition = strpos($key, '.', $dotPosition + 1);

            }


            if ($dotPosition === false) {

                // no regular dot found

                $keySegment = $key;

                $remainingKey = '';

            } else {

                if ($dotPosition > 1 && $key[$dotPosition - 2] === '\\' && $key[$dotPosition - 1] === '\\') {

                    $keySegment = substr($key, 0, $dotPosition - 1);

                } else {

                    $keySegment = substr($key, 0, $dotPosition);

                }

                $remainingKey = substr($key, $dotPosition + 1);

            }


            // fix key segment by removing escape sequences

            $keySegment = str_replace('\\.', '.', $keySegment);

        } else {

            // no backslash in the key, we're fine off

            list($keySegment, $remainingKey) = explode('.', $key, 2);

        }

        return [$keySegment, $remainingKey];

    }

}