DatabaseSelect.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!
 */

class DatabaseSelect extends AbstractStepAction
{
    protected $databaseConnection = null;

    public function execute()
    {
        $result = [];
        $this->initializeDatabaseConnection();
        $postValues = $this->postValues['values'];
        $localConfigurationPathValuePairs = [];
        $configurationManager = $this->objectManager->get(\TYPO3\CMS\Core\Configuration\ConfigurationManager::class);
        if ($postValues['type'] === 'new') {
            $newDatabaseName = $postValues['new'];
            if ($this->isValidDatabaseName($newDatabaseName)) {
                $createDatabaseResult = $this->databaseConnection->admin_query('CREATE DATABASE ' . $newDatabaseName . ' CHARACTER SET utf8');
                if ($createDatabaseResult) {
                    $localConfigurationPathValuePairs['DB/database'] = $newDatabaseName;
                } else {
                    $errorStatus = $this->objectManager->get(\TYPO3\CMS\Install\Status\ErrorStatus::class);
                    $errorStatus->setTitle('Unable to create database');
                    $errorStatus->setMessage(
                        'Database with name ' . $newDatabaseName . ' could not be created.' .
                        ' Either your database name contains a reserved keyword or your database' .
                        ' user does not have sufficient permissions to create it.' .
                        ' Please choose an existing (empty) database or contact administration.'
                    );
                    $result[] = $errorStatus;
                }
            } 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' .
                    ' and consist solely of basic latin letters (a-z), digits (0-9), dollar signs ($)' .
                    ' and underscores (_).'
                );
                $result[] = $errorStatus;
            }
        } elseif ($postValues['type'] === 'existing' && !empty($postValues['existing'])) {
            // Only store database information when it's empty
            $this->databaseConnection->setDatabaseName($postValues['existing']);
            try {
                $this->databaseConnection->sql_select_db();
                $existingTables = $this->databaseConnection->admin_get_tables();
                if (!empty($existingTables)) {
                    $errorStatus = $this->objectManager->get(\TYPO3\CMS\Install\Status\ErrorStatus::class);
                    $errorStatus->setTitle('Selected database is not empty!');
                    $errorStatus->setMessage(
                        sprintf('Cannot use database "%s"', $postValues['existing'])
                        . ', because it has tables already. Please select a different database or choose to create one!'
                    );
                    $result[] = $errorStatus;
                }
            } catch (\RuntimeException $e) {
                $errorStatus = $this->objectManager->get(\TYPO3\CMS\Install\Status\ErrorStatus::class);
                $errorStatus->setTitle('Could not connect to selected database!');
                $errorStatus->setMessage(
                    sprintf('Could not connect to database "%s"', $postValues['existing'])
                    . '! Make sure it really exists and your database user has the permissions to select it!'
                );
                $result[] = $errorStatus;
            }
            $isInitialInstallation = $configurationManager->getConfigurationValueByPath('SYS/isInitialInstallationInProgress');
            if (!$isInitialInstallation || empty($result)) {
                $localConfigurationPathValuePairs['DB/database'] = $postValues['existing'];
            }
        } else {
            $errorStatus = $this->objectManager->get(\TYPO3\CMS\Install\Status\ErrorStatus::class);
            $errorStatus->setTitle('No Database selected');
            $errorStatus->setMessage('You must select a database.');
            $result[] = $errorStatus;
        }

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

        return $result;
    }

    public function needsExecution()
    {
        $this->initializeDatabaseConnection();
        $result = true;
        if ((string)$GLOBALS['TYPO3_CONF_VARS']['DB']['database'] !== '') {
            $this->databaseConnection->setDatabaseName($GLOBALS['TYPO3_CONF_VARS']['DB']['database']);
            try {
                $selectResult = $this->databaseConnection->sql_select_db();
                if ($selectResult === true) {
                    $result = false;
                }
            } catch (\RuntimeException $e) {
            }
        }
        return $result;
    }

    protected function executeAction()
    {
        $configurationManager = $this->objectManager->get(\TYPO3\CMS\Core\Configuration\ConfigurationManager::class);
        $isInitialInstallationInProgress = $configurationManager->getConfigurationValueByPath('SYS/isInitialInstallationInProgress');
        $this->view->assign('databaseList', $this->getDatabaseList($isInitialInstallationInProgress));
        $this->view->assign('isInitialInstallationInProgress', $isInitialInstallationInProgress);
        $this->assignSteps();
        return $this->view->render();
    }

    protected function getDatabaseList($initialInstallation)
    {
        $this->initializeDatabaseConnection();
        $databaseArray = $this->databaseConnection->admin_get_dbs();
        // Remove mysql organizational tables from database list
        $reservedDatabaseNames = ['mysql', 'information_schema', 'performance_schema'];
        $allPossibleDatabases = array_diff($databaseArray, $reservedDatabaseNames);

        // If we are upgrading we show *all* databases the user has access to
        if ($initialInstallation === false) {
            return $allPossibleDatabases;
        } else {
            // In first installation we show all databases but disable not empty ones (with tables)
            $databases = [];
            foreach ($allPossibleDatabases as $database) {
                $this->databaseConnection->setDatabaseName($database);
                $this->databaseConnection->sql_select_db();
                $existingTables = $this->databaseConnection->admin_get_tables();
                $databases[] = [
                    'name' => $database,
                    'tables' => count($existingTables),
                ];
            }
            return $databases;
        }
    }

    protected function initializeDatabaseConnection()
    {
        $this->databaseConnection = $this->objectManager->get(\TYPO3\CMS\Core\Database\DatabaseConnection::class);
        $this->databaseConnection->setDatabaseUsername($GLOBALS['TYPO3_CONF_VARS']['DB']['username']);
        $this->databaseConnection->setDatabasePassword($GLOBALS['TYPO3_CONF_VARS']['DB']['password']);
        $this->databaseConnection->setDatabaseHost($GLOBALS['TYPO3_CONF_VARS']['DB']['host']);
        $this->databaseConnection->setDatabasePort($GLOBALS['TYPO3_CONF_VARS']['DB']['port']);
        $this->databaseConnection->setDatabaseSocket($GLOBALS['TYPO3_CONF_VARS']['DB']['socket']);
        $this->databaseConnection->sql_pconnect();
    }

    protected function isValidDatabaseName($databaseName)
    {
        return strlen($databaseName) <= 50 && preg_match('/^[a-zA-Z0-9\$_]*$/', $databaseName);
    }
}