Connection.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\Core\Database;
 
use Doctrine\Common\EventManager;
use Doctrine\DBAL\Configuration;
use Doctrine\DBAL\Driver;
use Doctrine\DBAL\Platforms\MariaDBPlatform as DoctrineMariaDBPlatform;
use Doctrine\DBAL\Platforms\MySQLPlatform as DoctrineMySQLPlatform;
use Doctrine\DBAL\Platforms\OraclePlatform as DoctrineOraclePlatform;
use Doctrine\DBAL\Platforms\PostgreSQLPlatform as DoctrinePostgreSqlPlatform;
use Doctrine\DBAL\Result;
use Doctrine\DBAL\Types\Type;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use ‪TYPO3\CMS\Core\Cache\CacheManager;
use ‪TYPO3\CMS\Core\Database\Query\BulkInsertQuery;
use ‪TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder;
use TYPO3\CMS\Core\Database\Query\QueryBuilder;
use ‪TYPO3\CMS\Core\Database\Schema\SchemaInformation;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪Connection extends \Doctrine\DBAL\Connection implements LoggerAwareInterface
{
    use LoggerAwareTrait;
 
    public const ‪PARAM_NULL = \PDO::PARAM_NULL; // 0
 
    public const ‪PARAM_INT = \PDO::PARAM_INT; // 1
 
    public const ‪PARAM_STR = \PDO::PARAM_STR; // 2
 
    public const ‪PARAM_LOB = \PDO::PARAM_LOB; // 3
 
    public const ‪PARAM_STMT = \PDO::PARAM_STMT; // 4
 
    public const ‪PARAM_BOOL = \PDO::PARAM_BOOL; // 5
 
    protected ‪$_expr;
 
    private ‪$prepareConnectionCommands = [];
 
    public function ‪__construct(array $params, Driver $driver, Configuration $config = null, EventManager $em = null)
    {
        parent::__construct($params, $driver, $config, $em);
        $this->_expr = GeneralUtility::makeInstance(ExpressionBuilder::class, $this);
    }
 
    public function ‪connect(): bool
    {
        // Early return if the connection is already open and custom setup has been done.
        if (!parent::connect()) {
            return false;
        }
 
        foreach ($this->prepareConnectionCommands as $command) {
            $this->executeStatement($command);
        }
 
        return true;
    }
 
    public function ‪createQueryBuilder(): QueryBuilder
    {
        return GeneralUtility::makeInstance(QueryBuilder::class, $this);
    }
 
    public function ‪quoteIdentifier(‪$identifier): string
    {
        if (‪$identifier === '*') {
            return ‪$identifier;
        }
 
        return parent::quoteIdentifier(‪$identifier);
    }
 
    public function ‪quoteIdentifiers(array $input): array
    {
        return array_map($this->‪quoteIdentifier(...), $input);
    }
 
    public function ‪quoteColumnValuePairs(array $input): array
    {
        return array_combine($this->‪quoteIdentifiers(array_keys($input)), array_values($input));
    }
 
    protected function ‪quoteColumnTypes(array $input): array
    {
        if (!is_string(key($input))) {
            return $input;
        }
 
        return $this->‪quoteColumnValuePairs($input);
    }
 
    public function ‪escapeLikeWildcards(string $value): string
    {
        return addcslashes($value, '_%');
    }
 
    public function ‪insert($tableName, array $data, array $types = []): int
    {
        $this->‪ensureDatabaseValueTypes($tableName, $data, $types);
        return parent::insert(
            $this->‪quoteIdentifier($tableName),
            $this->‪quoteColumnValuePairs($data),
            $this->‪quoteColumnTypes($types)
        );
    }
 
    public function ‪bulkInsert(string $tableName, array $data, array $columns = [], array $types = []): int
    {
        $query = GeneralUtility::makeInstance(BulkInsertQuery::class, $this, $tableName, $columns);
        foreach ($data as $values) {
            $this->‪ensureDatabaseValueTypes($tableName, $values, $types);
            $query->addValues($values, $types);
        }
 
        return $query->execute();
    }
 
    public function ‪select(
        array $columns,
        string $tableName,
        array $identifiers = [],
        array $groupBy = [],
        array $orderBy = [],
        int $limit = 0,
        int $offset = 0
    ) {
        $query = $this->‪createQueryBuilder();
        $query->select(...$columns)
            ->from($tableName);
 
        foreach ($identifiers as ‪$identifier => $value) {
            $query->andWhere($query->expr()->eq(‪$identifier, $query->createNamedParameter($value)));
        }
 
        foreach ($orderBy as $fieldName => $order) {
            $query->addOrderBy($fieldName, $order);
        }
 
        if (!empty($groupBy)) {
            $query->groupBy(...$groupBy);
        }
 
        if ($limit > 0) {
            $query->setMaxResults($limit);
            $query->setFirstResult($offset);
        }
 
        return $query->executeQuery();
    }
 
    public function ‪update($tableName, array $data, array ‪$identifier, array $types = []): int
    {
        $this->‪ensureDatabaseValueTypes($tableName, $data, $types);
        return parent::update(
            $this->‪quoteIdentifier($tableName),
            $this->‪quoteColumnValuePairs($data),
            $this->‪quoteColumnValuePairs($identifier),
            $this->‪quoteColumnTypes($types)
        );
    }
 
    public function delete($tableName, array ‪$identifier, array $types = []): int
    {
        return parent::delete(
            $this->‪quoteIdentifier($tableName),
            $this->‪quoteColumnValuePairs($identifier),
            $this->‪quoteColumnTypes($types)
        );
    }
 
    public function ‪truncate(string $tableName, bool $cascade = false): int
    {
        return $this->executeStatement(
            $this->getDatabasePlatform()->getTruncateTableSQL(
                $this->‪quoteIdentifier($tableName),
                $cascade
            )
        );
    }
 
    public function ‪count(string $item, string $tableName, array $identifiers): int
    {
        $query = $this->‪createQueryBuilder();
        $query->count($item)
            ->from($tableName);
 
        foreach ($identifiers as ‪$identifier => $value) {
            $query->andWhere($query->expr()->eq(‪$identifier, $query->createNamedParameter($value)));
        }
 
        return (int)$query->executeQuery()->fetchOne();
    }
 
    public function ‪getServerVersion(): string
    {
        $connection = $this->getWrappedConnection();
        if (method_exists($connection, 'getServerVersion')) {
            return $connection->getServerVersion();
        }
 
        // Return empty server version due to database connection error.
        return '';
    }
 
    public function ‪getPlatformServerVersion(): string
    {
        $platform = $this->getDatabasePlatform();
        $version = trim($this->‪getServerVersion());
        if ($version !== '') {
            $version = ' ' . $version;
        }
        return match (true) {
            // @todo Check if we should use 'MariaDB' now directly instead of MySQL as an alias.
            $platform instanceof DoctrineMariaDBPlatform => 'MySQL' . $version,
            $platform instanceof DoctrineMySQLPlatform => 'MySQL' . $version,
            $platform instanceof DoctrinePostgreSQLPlatform => 'PostgreSQL' . $version,
            $platform instanceof DoctrineOraclePlatform => 'Oracle' . $version,
            default => (str_replace('Platform', '', array_reverse(explode('\\', $platform::class))[0] ?? '')) . $version,
        };
    }
 
    public function ‪prepareConnection(string $commands)
    {
        if (empty($commands)) {
            return;
        }
 
        $this->prepareConnectionCommands = GeneralUtility::trimExplode(
            LF,
            str_replace(
                '\' . LF . \'',
                LF,
                $commands
            ),
            true
        );
    }
 
    public function ‪lastInsertId($tableName = null, string $fieldName = 'uid'): string
    {
        $databasePlatform = $this->getDatabasePlatform();
        if ($databasePlatform instanceof DoctrinePostgreSqlPlatform) {
            return parent::lastInsertId(trim(implode('_', [$tableName, $fieldName, 'seq']), '_'));
        }
        return (string)parent::lastInsertId($tableName);
    }
 
    public function ‪getExpressionBuilder()
    {
        return ‪$this->_expr;
    }
 
    protected function ‪ensureDatabaseValueTypes(string $tableName, array &$data, array &$types): void
    {
        // If types are incoming already (meaning they're hand over to insert() for instance), don't auto-set them.
        $setAllTypes = $types === [];
        $tableDetails = $this->‪getSchemaInformation()->introspectTable($tableName);
        array_walk($data, function (mixed &$value, string $key) use ($tableDetails, $setAllTypes, &$types): void {
            if ($tableDetails->hasColumn($key)) {
                $type = $tableDetails->getColumn($key)->getType();
                if ($setAllTypes) {
                    $types[$key] = $type->getBindingType();
                }
                $value = $this->convertToDatabaseValue($value, $type);
            }
        });
    }
 
    public function convertToDatabaseValue($value, $type)
    {
        if (is_string($type)) {
            $type = Type::getType($type);
        }
        return $type->convertToDatabaseValue($value, $this->getDatabasePlatform());
    }
 
    public function getSchemaInformation(): SchemaInformation
    {
        return new SchemaInformation(
            $this,
            GeneralUtility::makeInstance(CacheManager::class)->getCache('database_schema')
        );
    }
}