AllConfiguration.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Install\Controller\Action\Tool;

/*
 * 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\Utility\GeneralUtility;
use TYPO3\CMS\Install\Controller\Action;

class AllConfiguration extends Action\AbstractAction
{
    protected $phpErrorCodesSettings = [
        'errorHandlerErrors',
        'exceptionalErrors',
        'syslogErrorReporting',
        'belogErrorReporting',
    ];

    protected function executeAction()
    {
        if (isset($this->postValues['set']['write'])) {
            $this->view->assign('configurationValuesSaved', true);
            $this->view->assign('savedConfigurationValueMessages', $this->updateLocalConfigurationValues());
        } else {
            $this->view->assign('sectionNames', $this->getSpeakingSectionNames());
            $this->view->assign('data', $this->setUpConfigurationData());
        }

        return $this->view->render();
    }

    protected function getSpeakingSectionNames()
    {
        return [
            'BE' => 'Backend',
            'DB' => 'Database',
            'EXT' => 'Extension Installation',
            'FE' => 'Frontend',
            'GFX' => 'Image Processing',
            'HTTP' => 'Connection',
            'MAIL' => 'Mail',
            'SYS' => 'System'
        ];
    }

    protected function setUpConfigurationData()
    {
        $data = [];
        $typo3ConfVars = array_keys($GLOBALS['TYPO3_CONF_VARS']);
        sort($typo3ConfVars);
        $commentArray = $this->getDefaultConfigArrayComments();
        foreach ($typo3ConfVars as $sectionName) {
            $data[$sectionName] = [];

            foreach ($GLOBALS['TYPO3_CONF_VARS'][$sectionName] as $key => $value) {
                // @deprecated since TYPO3 v8, will be removed in TYPO3 v9. The array TYPO3_CONF_VARS_extensionAdded will be removed in v9.
                if (isset($GLOBALS['TYPO3_CONF_VARS_extensionAdded'][$sectionName][$key])) {
                    // Don't allow editing stuff which is added by extensions
                    // Make sure we fix potentially duplicated entries from older setups
                    $potentialValue = str_replace(['\' . LF . \'', '\' . LF . \''], [LF, LF], $value);
                    while (preg_match('/' . preg_quote($GLOBALS['TYPO3_CONF_VARS_extensionAdded'][$sectionName][$key], '/') . '$/', $potentialValue)) {
                        $potentialValue = preg_replace('/' . preg_quote($GLOBALS['TYPO3_CONF_VARS_extensionAdded'][$sectionName][$key], '/') . '$/', '', $potentialValue);
                    }
                    $value = $potentialValue;
                }

                $description = trim($commentArray[$sectionName][$key]);
                $isTextarea = (bool)preg_match('/^(<.*?>)?string \\(textarea\\)/i', $description);
                $doNotRender = (bool)preg_match('/^(<.*?>)?string \\(exclude\\)/i', $description);

                if (!is_array($value) && !$doNotRender && (!preg_match('/[' . LF . CR . ']/', $value) || $isTextarea)) {
                    $itemData = [];
                    $itemData['key'] = $key;
                    $itemData['description'] = $description;
                    if ($isTextarea) {
                        $itemData['type'] = 'textarea';
                        $itemData['value'] = str_replace(['\' . LF . \'', '\' . LF . \''], [LF, LF], $value);
                    } elseif (preg_match('/^(<.*?>)?boolean/i', $description)) {
                        $itemData['type'] = 'checkbox';
                        $itemData['value'] = $value ? '1' : '0';
                        $itemData['checked'] = (bool)$value;
                    } elseif (preg_match('/^(<.*?>)?integer/i', $description)) {
                        $itemData['type'] = 'number';
                        $itemData['value'] = (int)$value;
                    } else {
                        $itemData['type'] = 'input';
                        $itemData['value'] = $value;
                    }

                    // Check if the setting is a PHP error code, will trigger a view helper in fluid
                    if ($sectionName === 'SYS' && in_array($key, $this->phpErrorCodesSettings)) {
                        $itemData['phpErrorCode'] = true;
                    }

                    $data[$sectionName][] = $itemData;
                }
            }
        }
        return $data;
    }

    protected function updateLocalConfigurationValues()
    {
        $statusObjects = [];
        if (isset($this->postValues['values']) && is_array($this->postValues['values'])) {
            $configurationPathValuePairs = [];
            $commentArray = $this->getDefaultConfigArrayComments();
            $formValues = $this->postValues['values'];
            foreach ($formValues as $section => $valueArray) {
                if (is_array($GLOBALS['TYPO3_CONF_VARS'][$section])) {
                    foreach ($valueArray as $valueKey => $value) {
                        if (isset($GLOBALS['TYPO3_CONF_VARS'][$section][$valueKey])) {
                            $oldValue = $GLOBALS['TYPO3_CONF_VARS'][$section][$valueKey];
                            $description = trim($commentArray[$section][$valueKey]);

                            if (preg_match('/^string \\(textarea\\)/i', $description)) {
                                // Force Unix linebreaks in textareas
                                $value = str_replace(CR, '', $value);
                                // Preserve linebreaks
                                $value = str_replace(LF, '\' . LF . \'', $value);
                            }

                            if (preg_match('/^(<.*?>)?boolean/i', $description)) {
                                // 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 (preg_match('/^(<.*?>)?integer/i', $description)) {
                                // Cast integer values to integers (but only for values that can not contain a string as well)
                                $value = (int)$value;
                                $valueHasChanged = (int)$oldValue !== $value;
                            } else {
                                $valueHasChanged = (string)$oldValue !== (string)$value;
                            }

                            // Save if value changed
                            if ($valueHasChanged) {
                                $configurationPathValuePairs[$section . '/' . $valueKey] = $value;
                                $status = GeneralUtility::makeInstance(\TYPO3\CMS\Install\Status\OkStatus::class);
                                $status->setTitle('$GLOBALS[\'TYPO3_CONF_VARS\'][\'' . $section . '\'][\'' . $valueKey . '\']');
                                if (is_bool($value)) {
                                    $status->setMessage('New value = ' . ($value ? 'true' : 'false'));
                                } else {
                                    $status->setMessage('New value = ' . $value);
                                }
                                $statusObjects[] = $status;
                            }
                        }
                    }
                }
            }
            if (!empty($statusObjects)) {
                $configurationManager = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Configuration\ConfigurationManager::class);
                $configurationManager->setLocalConfigurationValuesByPathValuePairs($configurationPathValuePairs);
            }
        }
        return $statusObjects;
    }

    protected function getDefaultConfigArrayComments(): array
    {
        $configurationManager = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Configuration\ConfigurationManager::class);
        return require $configurationManager->getDefaultConfigurationDescriptionFileLocation();
    }
}