SqlSrv.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\Install\SystemEnvironment\DatabaseCheck\Platform;
 
use ‪TYPO3\CMS\Core\Database\Connection;
use ‪TYPO3\CMS\Core\Database\ConnectionPool;
use ‪TYPO3\CMS\Core\Messaging\FlashMessage;
use ‪TYPO3\CMS\Core\Messaging\FlashMessageQueue;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪SqlSrv extends ‪AbstractPlatform
{
    protected const ‪SCHEMA_NAME_MAX_LENGTH = 128;
 
    protected ‪$databaseCharsetToCheck = [
        '_UTF8',
    ];
 
    protected ‪$databaseServerCharsetToCheck = [
        '_UTF8'
    ];
 
    public function ‪getStatus(): ‪FlashMessageQueue
    {
        $defaultConnection = GeneralUtility::makeInstance(ConnectionPool::class)
            ->getConnectionByName(ConnectionPool::DEFAULT_CONNECTION_NAME);
        if (strpos($defaultConnection->getServerVersion(), 'mssql') !== 0) {
            return ‪$this->messageQueue;
        }
 
        $this->‪checkDefaultDatabaseCharset($defaultConnection);
        $this->‪checkDefaultDatabaseServerCharset($defaultConnection);
        $this->‪checkDatabaseName($defaultConnection);
 
        return ‪$this->messageQueue;
    }
 
    public function ‪checkDefaultDatabaseCharset(‪Connection $connection): void
    {
        $defaultDatabaseCharset = $connection->executeQuery(
            'SELECT DATABASEPROPERTYEX(?,\'collation\')',
            [$connection->getDatabase()],
            [\PDO::PARAM_STR]
        )
            ->fetch(\PDO::FETCH_NUM);
 
        foreach ($this->databaseCharsetToCheck as ‪$databaseCharsetToCheck) {
            if (!stripos($defaultDatabaseCharset[0], ‪$databaseCharsetToCheck)) {
                $this->messageQueue->enqueue(new ‪FlashMessage(
                    sprintf(
                        'Checking database character set failed, got key "%s" where "%s" is not part of the collation',
                        $defaultDatabaseCharset[0],
                        ‪$databaseCharsetToCheck
                    ),
                    'SQL Server database character set check failed',
                    ‪FlashMessage::ERROR
                ));
            } else {
                $this->messageQueue->enqueue(new ‪FlashMessage(
                    '',
                    sprintf('SQL Server database uses %s. All good.', implode(' or ', $this->databaseCharsetToCheck))
                ));
            }
        }
    }
 
    public function ‪checkDefaultDatabaseServerCharset(Connection $connection): void
    {
        $defaultServerCharset = $connection->executeQuery('SELECT SERVERPROPERTY(\'Collation\')')
            ->fetch(\PDO::FETCH_NUM);
 
        foreach ($this->databaseServerCharsetToCheck as ‪$databaseServerCharsetToCheck) {
            // is charset part of collation
            if (!stripos($defaultServerCharset[0], ‪$databaseServerCharsetToCheck)) {
                $this->messageQueue->enqueue(new FlashMessage(
                    sprintf(
                        'Checking server character set failed, got key "%s" where "%s" is not part of the collation',
                        $defaultServerCharset[0],
                        ‪$databaseServerCharsetToCheck
                    ),
                    'SQL Server database character set check failed',
                    ‪FlashMessage::INFO
                ));
            } else {
                $this->messageQueue->enqueue(new FlashMessage(
                    '',
                    sprintf('SQL Server server default uses %s. All good.', implode(' or ', $this->databaseCharsetToCheck))
                ));
            }
        }
    }
 
    public static function ‪isValidDatabaseName(string $databaseName): bool
    {
        return strlen($databaseName) <= static::SCHEMA_NAME_MAX_LENGTH && preg_match('/^(?!@@)[a-zA-Z0-9\$_@#\p{L}]*$/u', $databaseName);
    }
 
    protected function ‪checkDatabaseName(‪Connection $connection): void
    {
        if (static::isValidDatabaseName($connection->getDatabase())) {
            return;
        }
 
        $this->messageQueue->enqueue(
            new ‪FlashMessage(
                'The given database name must not be longer than ' . static::SCHEMA_NAME_MAX_LENGTH . ' characters'
                . ' and consist solely of basic latin letters (a-z), unicode characters, digits (0-9), dollar signs ($),'
                . ' symbol @, underscores (_) and does not start with "@@".',
                'Database name not valid',
                ‪FlashMessage::ERROR
            )
        );
    }
}