9.5/_local_configuration_value_service_8php_source.html

<?php

declare(strict_types = 1);

namespace ‪TYPO3\CMS\Install\Service;


/*

 * 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\ConfigurationManager;

use ‪TYPO3\CMS\Core\Configuration\Loader\YamlFileLoader;

use ‪TYPO3\CMS\Core\Messaging\FlashMessage;

use ‪TYPO3\CMS\Core\Messaging\FlashMessageQueue;

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


class ‪LocalConfigurationValueService

{


    public function ‪getCurrentConfigurationData(): array

    {

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

        $localConfiguration = $configurationManager->getMergedLocalConfiguration();


        $data = [];

        $commentArray = $this->‪getDefaultConfigArrayComments();


        foreach ($localConfiguration as $sectionName => $section) {

            if (isset($commentArray[$sectionName])) {

                $data[$sectionName]['description'] = $commentArray[$sectionName]['description'] ?? $sectionName;

                $data[$sectionName]['items'] = $this->‪recursiveConfigurationFetching(

                    $section,

                    ‪$GLOBALS['TYPO3_CONF_VARS'][$sectionName] ?? null,

                    $commentArray[$sectionName]

                );

            }

        }


        ksort($data);


        return $data;

    }


    protected function ‪recursiveConfigurationFetching(array $sections, array $sectionsFromCurrentConfiguration, array $descriptions, array $path = []): array

    {

        $data = [];


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

            if (!isset($descriptions['items'][$key])) {

                // @todo should we do something here?

                continue;

            }


            $descriptionInfo = $descriptions['items'][$key];

            $descriptionType = $descriptionInfo['type'];


            $newPath = $path;

            $newPath[] = $key;


            if ($descriptionType === 'container') {

                $valueFromCurrentConfiguration = $sectionsFromCurrentConfiguration[$key] ?? null;

                $data = array_merge($data, $this->‪recursiveConfigurationFetching($value, $valueFromCurrentConfiguration, $descriptionInfo, $newPath));

            } elseif (!preg_match('/[' . LF . CR . ']/', (string)$value) || $descriptionType === 'multiline') {

                $itemData = [];

                $itemData['key'] = implode('/', $newPath);

                $itemData['path'] = '[' . implode('][', $newPath) . ']';

                $itemData['fieldType'] = $descriptionInfo['type'];

                $itemData['description'] = $descriptionInfo['description'];

                $itemData['allowedValues'] = $descriptionInfo['allowedValues'];

                $itemData['differentValueInCurrentConfiguration'] = (!isset($descriptionInfo['compareValuesWithCurrentConfiguration']) ||

                    $descriptionInfo['compareValuesWithCurrentConfiguration']) &&

                    isset($sectionsFromCurrentConfiguration[$key]) &&

                    $value !== $sectionsFromCurrentConfiguration[$key];

                switch ($descriptionType) {

                    case 'multiline':

                        $itemData['type'] = 'textarea';

                        $itemData['value'] = str_replace(['\' . LF . \'', '\' . LF . \''], [LF, LF], $value);

                        break;

                    case 'bool':

                        $itemData['type'] = 'checkbox';

                        $itemData['value'] = $value ? '1' : '0';

                        $itemData['checked'] = (bool)$value;

                        break;

                    case 'int':

                        $itemData['type'] = 'number';

                        $itemData['value'] = (int)$value;

                        break;

                    case 'array':

                        $itemData['type'] = 'input';

                        // @todo The line below should be improved when the array handling is introduced in the global settings manager.

                        $itemData['value'] = is_array($value)

                            ? implode(',', $value)

                            : (string)$value;

                        break;

                    // Check if the setting is a PHP error code, will trigger a view helper in fluid

                    case 'errors':

                        $itemData['type'] = 'input';

                        $itemData['value'] = $value;

                        $itemData['phpErrorCode'] = true;

                        break;

                    case 'password':

                        $itemData['type'] = 'password';

                        $itemData['value'] = $value;

                        $itemData['hideValue'] = true;

                        break;

                    default:

                        $itemData['type'] = 'input';

                        $itemData['value'] = $value;

                }


                $data[] = $itemData;

            }

        }


        return $data;

    }


    public function ‪updateLocalConfigurationValues(array $valueList): ‪FlashMessageQueue

    {

        $messageQueue = new ‪FlashMessageQueue('install');

        $configurationPathValuePairs = [];

        $commentArray = $this->‪getDefaultConfigArrayComments();

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

        foreach ($valueList as $path => $value) {

            $oldValue = $configurationManager->getConfigurationValueByPath($path);

            $pathParts = explode('/', $path);

            $descriptionData = $commentArray[$pathParts[0]];


            while ($part = next($pathParts)) {

                $descriptionData = $descriptionData['items'][$part];

            }


            $dataType = $descriptionData['type'];


            if ($dataType === 'multiline') {

                // Force Unix line breaks in text areas

                // Preserve line breaks

                $value = str_replace([CR, LF], ['', '\' . LF . \''], $value);

            }


            if ($dataType === 'bool') {

                // When submitting settings in the Install Tool, values that default to "FALSE" or "TRUE"

                // in EXT:core/Configuration/DefaultConfiguration.php will be sent as "0" resp. "1".

                $value = $value === '1';

                $valueHasChanged = (bool)$oldValue !== $value;

            } elseif ($dataType === 'int') {

                // Cast integer values to integers (but only for values that can not contain a string as well)

                $value = (int)$value;

                $valueHasChanged = (int)$oldValue !== $value;

            } elseif ($dataType === 'array') {

                $oldValueAsString = is_array($oldValue)

                    ? implode(',', $oldValue)

                    : (string)$oldValue;

                $valueHasChanged = $oldValueAsString !== $value;

                $value = GeneralUtility::trimExplode(',', $value, true);

            } else {

                $valueHasChanged = (string)$oldValue !== (string)$value;

            }


            // Save if value changed

            if ($valueHasChanged) {

                $configurationPathValuePairs[$path] = $value;


                if (is_bool($value)) {

                    $messageBody = 'New value = ' . ($value ? 'true' : 'false');

                } elseif (empty($value)) {

                    $messageBody = 'New value = none';

                } elseif (is_array($value)) {

                    $messageBody = "New value = ['" . implode("', '", $value) . "']";

                } elseif ($dataType === 'password') {

                    $messageBody = 'New value is set';

                } else {

                    $messageBody = 'New value = ' . $value;

                }


                $messageQueue->enqueue(new ‪FlashMessage(

                    $messageBody,

                    $path

                ));

            }

        }

        if (!empty($messageQueue)) {

            $configurationManager->setLocalConfigurationValuesByPathValuePairs($configurationPathValuePairs);

        }

        return $messageQueue;

    }


    protected function ‪getDefaultConfigArrayComments(): array

    {

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

        $fileName = $configurationManager->getDefaultConfigurationDescriptionFileLocation();

        $fileLoader = GeneralUtility::makeInstance(YamlFileLoader::class);

        return $fileLoader->load($fileName);

    }

}