DatabaseConnect.php

Go to the documentation of this file.

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

/*
 * 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\ExtensionManagementUtility;

class DatabaseConnect extends AbstractStepAction
{
    public function execute()
    {
        $result = [];

        $configurationManager = $this->objectManager->get(\TYPO3\CMS\Core\Configuration\ConfigurationManager::class);

        $postValues = $this->postValues['values'];
        if (isset($postValues['loadDbal'])) {
            $result[] = $this->executeLoadDbalExtension();
        } elseif ($postValues['unloadDbal']) {
            $result[] = $this->executeUnloadDbalExtension();
        } elseif ($postValues['setDbalDriver']) {
            $driver = $postValues['setDbalDriver'];
            switch ($driver) {
                case 'mssql':
                case 'odbc_mssql':
                    $driverConfig = [
                        'useNameQuote' => true,
                        'quoteClob' => false,
                    ];
                    break;
                case 'oci8':
                    $driverConfig = [
                        'driverOptions' => [
                            'connectSID' => '',
                        ],
                    ];
                    break;
            }
            $config = [
                '_DEFAULT' => [
                    'type' => 'adodb',
                    'config' => [
                        'driver' => $driver,
                    ]
                ]
            ];
            if (isset($driverConfig)) {
                $config['_DEFAULT']['config'] = array_merge($config['_DEFAULT']['config'], $driverConfig);
            }
            $configurationManager->setLocalConfigurationValueByPath('EXTCONF/dbal/handlerCfg', $config);
        } else {
            $localConfigurationPathValuePairs = [];

            if ($this->isDbalEnabled()) {
                $config = $configurationManager->getConfigurationValueByPath('EXTCONF/dbal/handlerCfg');
                $driver = $config['_DEFAULT']['config']['driver'];
                if ($driver === 'oci8') {
                    $config['_DEFAULT']['config']['driverOptions']['connectSID'] = ($postValues['type'] === 'sid');
                    $localConfigurationPathValuePairs['EXTCONF/dbal/handlerCfg'] = $config;
                }
            }

            if (isset($postValues['username'])) {
                $value = $postValues['username'];
                if (strlen($value) <= 50) {
                    $localConfigurationPathValuePairs['DB/username'] = $value;
                } else {
                    $errorStatus = $this->objectManager->get(\TYPO3\CMS\Install\Status\ErrorStatus::class);
                    $errorStatus->setTitle('Database username not valid');
                    $errorStatus->setMessage('Given username must be shorter than fifty characters.');
                    $result[] = $errorStatus;
                }
            }

            if (isset($postValues['password'])) {
                $value = $postValues['password'];
                if (strlen($value) <= 50) {
                    $localConfigurationPathValuePairs['DB/password'] = $value;
                } else {
                    $errorStatus = $this->objectManager->get(\TYPO3\CMS\Install\Status\ErrorStatus::class);
                    $errorStatus->setTitle('Database password not valid');
                    $errorStatus->setMessage('Given password must be shorter than fifty characters.');
                    $result[] = $errorStatus;
                }
            }

            if (isset($postValues['host'])) {
                $value = $postValues['host'];
                if (preg_match('/^[a-zA-Z0-9_\\.-]+(:.+)?$/', $value) && strlen($value) <= 255) {
                    $localConfigurationPathValuePairs['DB/host'] = $value;
                } else {
                    $errorStatus = $this->objectManager->get(\TYPO3\CMS\Install\Status\ErrorStatus::class);
                    $errorStatus->setTitle('Database host not valid');
                    $errorStatus->setMessage('Given host is not alphanumeric (a-z, A-Z, 0-9 or _-.:) or longer than 255 characters.');
                    $result[] = $errorStatus;
                }
            }

            if (isset($postValues['port']) && $postValues['host'] !== 'localhost') {
                $value = $postValues['port'];
                if (preg_match('/^[0-9]+(:.+)?$/', $value) && $value > 0 && $value <= 65535) {
                    $localConfigurationPathValuePairs['DB/port'] = (int)$value;
                } else {
                    $errorStatus = $this->objectManager->get(\TYPO3\CMS\Install\Status\ErrorStatus::class);
                    $errorStatus->setTitle('Database port not valid');
                    $errorStatus->setMessage('Given port is not numeric or within range 1 to 65535.');
                    $result[] = $errorStatus;
                }
            }

            if (isset($postValues['socket']) && $postValues['socket'] !== '') {
                if (@file_exists($postValues['socket'])) {
                    $localConfigurationPathValuePairs['DB/socket'] = $postValues['socket'];
                } else {
                    $errorStatus = $this->objectManager->get(\TYPO3\CMS\Install\Status\ErrorStatus::class);
                    $errorStatus->setTitle('Socket does not exist');
                    $errorStatus->setMessage('Given socket location does not exist on server.');
                    $result[] = $errorStatus;
                }
            }

            if (isset($postValues['database'])) {
                $value = $postValues['database'];
                if (strlen($value) <= 50) {
                    $localConfigurationPathValuePairs['DB/database'] = $value;
                } else {
                    $errorStatus = $this->objectManager->get(\TYPO3\CMS\Install\Status\ErrorStatus::class);
                    $errorStatus->setTitle('Database name not valid');
                    $errorStatus->setMessage('Given database name must be shorter than fifty characters.');
                    $result[] = $errorStatus;
                }
            }

            if (!empty($localConfigurationPathValuePairs)) {
                $configurationManager->setLocalConfigurationValuesByPathValuePairs($localConfigurationPathValuePairs);

                // After setting new credentials, test again and create an error message if connect is not successful
                // @TODO: This could be simplified, if isConnectSuccessful could be released from TYPO3_CONF_VARS
                // and fed with connect values directly in order to obsolete the bootstrap reload.
                \TYPO3\CMS\Core\Core\Bootstrap::getInstance()
                    ->populateLocalConfiguration()
                    ->disableCoreCache();
                if ($this->isDbalEnabled()) {
                    require(ExtensionManagementUtility::extPath('dbal') . 'ext_localconf.php');
                    \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Core\Cache\CacheManager::class)->setCacheConfigurations($GLOBALS['TYPO3_CONF_VARS']['SYS']['caching']['cacheConfigurations']);
                }
                if (!$this->isConnectSuccessful()) {
                    $errorStatus = $this->objectManager->get(\TYPO3\CMS\Install\Status\ErrorStatus::class);
                    $errorStatus->setTitle('Database connect not successful');
                    $errorStatus->setMessage('Connecting to the database with given settings failed. Please check.');
                    $result[] = $errorStatus;
                }
            }
        }

        return $result;
    }

    public function needsExecution()
    {
        if ($this->isConnectSuccessful() && $this->isConfigurationComplete()) {
            return false;
        }
        if (!$this->isHostConfigured() && !$this->isDbalEnabled()) {
            $this->useDefaultValuesForNotConfiguredOptions();
            throw new \TYPO3\CMS\Install\Controller\Exception\RedirectException(
                'Wrote default settings to LocalConfiguration.php, redirect needed',
                1377611168
            );
        }
        return true;
    }

    protected function executeAction()
    {
        $isDbalEnabled = $this->isDbalEnabled();
        $this->view
            ->assign('isDbalEnabled', $isDbalEnabled)
            ->assign('username', $this->getConfiguredUsername())
            ->assign('password', $this->getConfiguredPassword())
            ->assign('host', $this->getConfiguredHost())
            ->assign('port', $this->getConfiguredOrDefaultPort())
            ->assign('database', $GLOBALS['TYPO3_CONF_VARS']['DB']['database'] ?: '')
            ->assign('socket', $GLOBALS['TYPO3_CONF_VARS']['DB']['socket'] ?: '');

        if ($isDbalEnabled) {
            $this->view->assign('selectedDbalDriver', $this->getSelectedDbalDriver());
            $this->view->assign('dbalDrivers', $this->getAvailableDbalDrivers());
            $this->setDbalInputFieldsToRender();
        } else {
            $this->view
                ->assign('renderConnectDetailsUsername', true)
                ->assign('renderConnectDetailsPassword', true)
                ->assign('renderConnectDetailsHost', true)
                ->assign('renderConnectDetailsPort', true)
                ->assign('renderConnectDetailsSocket', true);
        }
        $this->assignSteps();

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

    protected function getConfiguredOrDefaultPort()
    {
        $configuredPort = (int)$this->getConfiguredPort();
        if (!$configuredPort) {
            if ($this->isDbalEnabled()) {
                $driver = $this->getSelectedDbalDriver();
                switch ($driver) {
                    case 'postgres':
                        $port = 5432;
                        break;
                    case 'mssql':
                    case 'odbc_mssql':
                        $port = 1433;
                        break;
                    case 'oci8':
                        $port = 1521;
                        break;
                    default:
                        $port = 3306;
                }
            } else {
                $port = 3306;
            }
        } else {
            $port = $configuredPort;
        }
        return $port;
    }

    protected function isConnectSuccessful()
    {
        $databaseConnection = $this->objectManager->get(\TYPO3\CMS\Core\Database\DatabaseConnection::class);

        if ($this->isDbalEnabled()) {
            // Set additional connect information based on dbal driver. postgres for example needs
            // database name already for connect.
            if (isset($GLOBALS['TYPO3_CONF_VARS']['DB']['database'])) {
                $databaseConnection->setDatabaseName($GLOBALS['TYPO3_CONF_VARS']['DB']['database']);
            }
        }

        $databaseConnection->setDatabaseUsername($this->getConfiguredUsername());
        $databaseConnection->setDatabasePassword($this->getConfiguredPassword());
        $databaseConnection->setDatabaseHost($this->getConfiguredHost());
        $databaseConnection->setDatabasePort($this->getConfiguredPort());
        $databaseConnection->setDatabaseSocket($this->getConfiguredSocket());

        $databaseConnection->initialize();

        return (bool)@$databaseConnection->sql_pconnect();
    }

    protected function isHostConfigured()
    {
        $hostConfigured = true;
        if (empty($GLOBALS['TYPO3_CONF_VARS']['DB']['host'])) {
            $hostConfigured = false;
        }
        if (
            !isset($GLOBALS['TYPO3_CONF_VARS']['DB']['port'])
            && !isset($GLOBALS['TYPO3_CONF_VARS']['DB']['socket'])
        ) {
            $hostConfigured = false;
        }
        return $hostConfigured;
    }

    protected function isConfigurationComplete()
    {
        $configurationComplete = $this->isHostConfigured();
        if (!isset($GLOBALS['TYPO3_CONF_VARS']['DB']['username'])) {
            $configurationComplete = false;
        }
        if (!isset($GLOBALS['TYPO3_CONF_VARS']['DB']['password'])) {
            $configurationComplete = false;
        }
        return $configurationComplete;
    }

    protected function useDefaultValuesForNotConfiguredOptions()
    {
        $localConfigurationPathValuePairs = [];

        $localConfigurationPathValuePairs['DB/host'] = $this->getConfiguredHost();

        // If host is "local" either by upgrading or by first install, we try a socket
        // connection first and use TCP/IP as fallback
        if ($localConfigurationPathValuePairs['DB/host'] === 'localhost'
            || \TYPO3\CMS\Core\Utility\GeneralUtility::cmpIP($localConfigurationPathValuePairs['DB/host'], '127.*.*.*')
            || (string)$localConfigurationPathValuePairs['DB/host'] === ''
        ) {
            if ($this->isConnectionWithUnixDomainSocketPossible()) {
                $localConfigurationPathValuePairs['DB/host'] = 'localhost';
                $localConfigurationPathValuePairs['DB/socket'] = $this->getConfiguredSocket();
            } else {
                if (!\TYPO3\CMS\Core\Utility\GeneralUtility::isFirstPartOfStr($localConfigurationPathValuePairs['DB/host'], '127.')) {
                    $localConfigurationPathValuePairs['DB/host'] = '127.0.0.1';
                }
            }
        }

        if (!isset($localConfigurationPathValuePairs['DB/socket'])) {
            // Make sure a default port is set if not configured yet
            // This is independent from any host configuration
            $port = $this->getConfiguredPort();
            if ($port > 0) {
                $localConfigurationPathValuePairs['DB/port'] = $port;
            } else {
                $localConfigurationPathValuePairs['DB/port'] = $this->getConfiguredOrDefaultPort();
            }
        }

        $configurationManager = $this->objectManager->get(\TYPO3\CMS\Core\Configuration\ConfigurationManager::class);
        $configurationManager->setLocalConfigurationValuesByPathValuePairs($localConfigurationPathValuePairs);
    }

    protected function isConnectionWithUnixDomainSocketPossible()
    {
        $result = false;
        // Use configured socket
        $socket = (string)$this->getConfiguredSocket();
        if ($socket === '') {
            // If no configured socket, use default php socket
            $defaultSocket = (string)ini_get('mysqli.default_socket');
            if ($defaultSocket !== '') {
                $socket = $defaultSocket;
            }
        }
        if ($socket !== '') {
            $socketOpenResult = @fsockopen('unix://' . $socket);
            if ($socketOpenResult) {
                fclose($socketOpenResult);
                $result = true;
            }
        }
        return $result;
    }

    protected function setDbalInputFieldsToRender()
    {
        $driver = $this->getSelectedDbalDriver();
        switch ($driver) {
            case 'mssql':
            case 'odbc_mssql':
            case 'postgres':
                $this->view
                    ->assign('renderConnectDetailsUsername', true)
                    ->assign('renderConnectDetailsPassword', true)
                    ->assign('renderConnectDetailsHost', true)
                    ->assign('renderConnectDetailsPort', true)
                    ->assign('renderConnectDetailsDatabase', true);
                break;
            case 'oci8':
                $this->view
                    ->assign('renderConnectDetailsUsername', true)
                    ->assign('renderConnectDetailsPassword', true)
                    ->assign('renderConnectDetailsHost', true)
                    ->assign('renderConnectDetailsPort', true)
                    ->assign('renderConnectDetailsDatabase', true)
                    ->assign('renderConnectDetailsOracleSidConnect', true);
                $type = isset($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['dbal']['handlerCfg']['_DEFAULT']['config']['driverOptions']['connectSID'])
                    ? $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['dbal']['handlerCfg']['_DEFAULT']['config']['driverOptions']['connectSID']
                    : '';
                if ($type === true) {
                    $this->view->assign('oracleSidSelected', true);
                }
                break;
        }
    }

    protected function getAvailableDbalDrivers()
    {
        $supportedDrivers = $this->getSupportedDbalDrivers();
        $availableDrivers = [];
        $selectedDbalDriver = $this->getSelectedDbalDriver();
        foreach ($supportedDrivers as $abstractionLayer => $drivers) {
            foreach ($drivers as $driver => $info) {
                if (isset($info['combine']) && $info['combine'] === 'OR') {
                    $isAvailable = false;
                } else {
                    $isAvailable = true;
                }
                // Loop through each PHP module dependency to ensure it is loaded
                foreach ($info['extensions'] as $extension) {
                    if (isset($info['combine']) && $info['combine'] === 'OR') {
                        $isAvailable |= extension_loaded($extension);
                    } else {
                        $isAvailable &= extension_loaded($extension);
                    }
                }
                if ($isAvailable) {
                    if (!isset($availableDrivers[$abstractionLayer])) {
                        $availableDrivers[$abstractionLayer] = [];
                    }
                    $availableDrivers[$abstractionLayer][$driver] = [];
                    $availableDrivers[$abstractionLayer][$driver]['driver'] = $driver;
                    $availableDrivers[$abstractionLayer][$driver]['label'] = $info['label'];
                    $availableDrivers[$abstractionLayer][$driver]['selected'] = false;
                    if ($selectedDbalDriver === $driver) {
                        $availableDrivers[$abstractionLayer][$driver]['selected'] = true;
                    }
                }
            }
        }
        return $availableDrivers;
    }

    protected function getSupportedDbalDrivers()
    {
        $supportedDrivers = [
            'Native' => [
                'mssql' => [
                    'label' => 'Microsoft SQL Server',
                    'extensions' => ['mssql']
                ],
                'oci8' => [
                    'label' => 'Oracle OCI8',
                    'extensions' => ['oci8']
                ],
                'postgres' => [
                    'label' => 'PostgreSQL',
                    'extensions' => ['pgsql']
                ]
            ],
            'ODBC' => [
                'odbc_mssql' => [
                    'label' => 'Microsoft SQL Server',
                    'extensions' => ['odbc', 'mssql']
                ]
            ]
        ];
        return $supportedDrivers;
    }

    protected function getSelectedDbalDriver()
    {
        if (isset($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['dbal']['handlerCfg']['_DEFAULT']['config']['driver'])) {
            return $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['dbal']['handlerCfg']['_DEFAULT']['config']['driver'];
        }
        return '';
    }

    protected function executeLoadDbalExtension()
    {
        if (!ExtensionManagementUtility::isLoaded('adodb')) {
            ExtensionManagementUtility::loadExtension('adodb');
        }
        if (!ExtensionManagementUtility::isLoaded('dbal')) {
            ExtensionManagementUtility::loadExtension('dbal');
        }
        $warningStatus = $this->objectManager->get(\TYPO3\CMS\Install\Status\WarningStatus::class);
        $warningStatus->setTitle('Loaded database abstraction layer');
        return $warningStatus;
    }

    protected function executeUnloadDbalExtension()
    {
        if (ExtensionManagementUtility::isLoaded('adodb')) {
            ExtensionManagementUtility::unloadExtension('adodb');
        }
        if (ExtensionManagementUtility::isLoaded('dbal')) {
            ExtensionManagementUtility::unloadExtension('dbal');
        }
        // @TODO: Remove configuration from TYPO3_CONF_VARS['EXTCONF']['dbal']
        $warningStatus = $this->objectManager->get(\TYPO3\CMS\Install\Status\WarningStatus::class);
        $warningStatus->setTitle('Removed database abstraction layer');
        return $warningStatus;
    }

    protected function getConfiguredUsername()
    {
        $username = isset($GLOBALS['TYPO3_CONF_VARS']['DB']['username']) ? $GLOBALS['TYPO3_CONF_VARS']['DB']['username'] : '';
        return $username;
    }

    protected function getConfiguredPassword()
    {
        $password = isset($GLOBALS['TYPO3_CONF_VARS']['DB']['password']) ? $GLOBALS['TYPO3_CONF_VARS']['DB']['password'] : '';
        return $password;
    }

    protected function getConfiguredHost()
    {
        $host = isset($GLOBALS['TYPO3_CONF_VARS']['DB']['host']) ? $GLOBALS['TYPO3_CONF_VARS']['DB']['host'] : '';
        $port = isset($GLOBALS['TYPO3_CONF_VARS']['DB']['port']) ? $GLOBALS['TYPO3_CONF_VARS']['DB']['port'] : '';
        if (strlen($port) < 1 && substr_count($host, ':') === 1) {
            list($host) = explode(':', $host);
        }
        return $host;
    }

    protected function getConfiguredPort()
    {
        $host = isset($GLOBALS['TYPO3_CONF_VARS']['DB']['host']) ? $GLOBALS['TYPO3_CONF_VARS']['DB']['host'] : '';
        $port = isset($GLOBALS['TYPO3_CONF_VARS']['DB']['port']) ? $GLOBALS['TYPO3_CONF_VARS']['DB']['port'] : '';
        if ($port === '' && substr_count($host, ':') === 1) {
            $hostPortArray = explode(':', $host);
            $port = $hostPortArray[1];
        }
        return (int)$port;
    }

    protected function getConfiguredSocket()
    {
        $socket = isset($GLOBALS['TYPO3_CONF_VARS']['DB']['socket']) ? $GLOBALS['TYPO3_CONF_VARS']['DB']['socket'] : '';
        return $socket;
    }
}