ExtensionConfiguration.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\Configuration;
 
use ‪TYPO3\CMS\Core\Configuration\Exception\ExtensionConfigurationExtensionNotConfiguredException;
use ‪TYPO3\CMS\Core\Configuration\Exception\ExtensionConfigurationPathDoesNotExistException;
use ‪TYPO3\CMS\Core\EventDispatcher\NoopEventDispatcher;
use TYPO3\CMS\Core\Package\PackageManager;
use ‪TYPO3\CMS\Core\TypoScript\AST\AstBuilder;
use ‪TYPO3\CMS\Core\TypoScript\TypoScriptStringFactory;
use ‪TYPO3\CMS\Core\Utility\ArrayUtility;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪ExtensionConfiguration
{
    public function get(string $extension, string $path = ''): mixed
    {
        $hasBeenSynchronized = false;
        if (!$this->‪hasConfiguration($extension)) {
            // This if() should not be hit at "casual" runtime, but only in early setup phases
            $this->‪synchronizeExtConfTemplateWithLocalConfigurationOfAllExtensions(true);
            $hasBeenSynchronized = true;
            if (!$this->‪hasConfiguration($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(true);
            }
            // 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, mixed $value = null): void
    {
        if (empty($extension)) {
            throw new \RuntimeException('extension name must not be empty', 1509715852);
        }
        $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;
        }
    }
 
    public function ‪setAll(array $configuration, bool $skipWriteIfLocalConfigurationDoesNotExist = false): void
    {
        $configurationManager = GeneralUtility::makeInstance(ConfigurationManager::class);
        if ($skipWriteIfLocalConfigurationDoesNotExist === false || @file_exists($configurationManager->getSystemConfigurationFileLocation())) {
            $configurationManager->setLocalConfigurationValueByPath('EXTENSIONS', $configuration);
        }
        ‪$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS'] = $configuration;
    }
 
    public function ‪synchronizeExtConfTemplateWithLocalConfigurationOfAllExtensions(bool $skipWriteIfLocalConfigurationDoesNotExist = false): void
    {
        $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, $skipWriteIfLocalConfigurationDoesNotExist);
        }
    }
 
    public function ‪synchronizeExtConfTemplateWithLocalConfiguration(string $extensionKey): void
    {
        $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);
        }
    }
 
    protected function ‪getExtConfTablesWithoutCommentsAsNestedArrayWithoutDots(string $extensionKey): array
    {
        $rawConfigurationString = $this->‪getDefaultConfigurationRawString($extensionKey);
        $typoScriptStringFactory = GeneralUtility::makeInstance(TypoScriptStringFactory::class);
        $typoScriptTree = $typoScriptStringFactory->parseFromString($rawConfigurationString, new ‪AstBuilder(new ‪NoopEventDispatcher()));
        return GeneralUtility::removeDotsFromTS($typoScriptTree->toArray());
    }
 
    protected function ‪getDefaultConfigurationRawString(string $extensionKey): string
    {
        $rawString = '';
        $extConfTemplateFileLocation = GeneralUtility::getFileAbsFileName(
            'EXT:' . $extensionKey . '/ext_conf_template.txt'
        );
        if (file_exists($extConfTemplateFileLocation)) {
            $rawString = (string)file_get_contents($extConfTemplateFileLocation);
        }
        return $rawString;
    }
 
    protected function ‪hasConfiguration(string $extension): bool
    {
        return isset(‪$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS'][$extension]) && is_array(‪$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS'][$extension]);
    }
}