Typo3DatabaseBackend.php

Go to the documentation of this file.

<?php
 
/*
 * 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\Cache\Backend;
 
use ‪TYPO3\CMS\Core\Cache\Exception;
use ‪TYPO3\CMS\Core\Cache\Exception\InvalidDataException;
use ‪TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
use ‪TYPO3\CMS\Core\Database\Connection;
use ‪TYPO3\CMS\Core\Database\ConnectionPool;
use ‪TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪Typo3DatabaseBackend extends ‪AbstractBackend implements ‪TaggableBackendInterface
{
    public const ‪FAKED_UNLIMITED_EXPIRE = 2145909600;
    protected ‪$cacheTable;
 
    protected ‪$tagsTable;
 
    protected ‪$compression = false;
 
    protected ‪$compressionLevel = -1;
 
    protected ‪$maximumLifetime;
 
    public function ‪setCache(‪FrontendInterface ‪$cache)
    {
        parent::setCache(‪$cache);
        $this->cacheTable = 'cache_' . ‪$this->cacheIdentifier;
        $this->tagsTable = 'cache_' . $this->cacheIdentifier . '_tags';
        $this->maximumLifetime = self::FAKED_UNLIMITED_EXPIRE - ‪$GLOBALS['EXEC_TIME'];
    }
 
    public function set($entryIdentifier, $data, array $tags = [], $lifetime = null)
    {
        $this->‪throwExceptionIfFrontendDoesNotExist();
        if (!is_string($data)) {
            throw new ‪InvalidDataException(
                'The specified data is of type "' . gettype($data) . '" but a string is expected.',
                1236518298
            );
        }
        if ($lifetime === null) {
            $lifetime = ‪$this->defaultLifetime;
        }
        if ($lifetime === 0 || $lifetime > $this->maximumLifetime) {
            $lifetime = ‪$this->maximumLifetime;
        }
        $expires = ‪$GLOBALS['EXEC_TIME'] + $lifetime;
        $this->remove($entryIdentifier);
        if ($this->compression) {
            $data = gzcompress($data, $this->compressionLevel);
        }
        GeneralUtility::makeInstance(ConnectionPool::class)
            ->getConnectionForTable($this->cacheTable)
            ->insert(
                $this->cacheTable,
                [
                    'identifier' => $entryIdentifier,
                    'expires' => $expires,
                    'content' => $data,
                ],
                [
                    'content' => ‪Connection::PARAM_LOB,
                ]
            );
        if (!empty($tags)) {
            $tagRows = [];
            foreach ($tags as $tag) {
                $tagRows[] = [$entryIdentifier, $tag];
            }
            GeneralUtility::makeInstance(ConnectionPool::class)
                ->getConnectionForTable($this->tagsTable)
                ->bulkInsert($this->tagsTable, $tagRows, ['identifier', 'tag']);
        }
    }
 
    public function get($entryIdentifier)
    {
        $this->‪throwExceptionIfFrontendDoesNotExist();
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
            ->getQueryBuilderForTable($this->cacheTable);
        $cacheRow = $queryBuilder->select('content')
            ->from($this->cacheTable)
            ->where(
                $queryBuilder->expr()->eq(
                    'identifier',
                    $queryBuilder->createNamedParameter($entryIdentifier, ‪Connection::PARAM_STR)
                ),
                $queryBuilder->expr()->gte(
                    'expires',
                    $queryBuilder->createNamedParameter(‪$GLOBALS['EXEC_TIME'], ‪Connection::PARAM_INT)
                )
            )
            ->executeQuery()
            ->fetchAssociative();
        $content = '';
        if (!empty($cacheRow)) {
            $content = $cacheRow['content'];
        }
        if ($this->compression && (string)$content !== '') {
            $content = gzuncompress($content);
        }
        return !empty($cacheRow) ? $content : false;
    }
 
    public function ‪has($entryIdentifier)
    {
        $this->‪throwExceptionIfFrontendDoesNotExist();
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
            ->getQueryBuilderForTable($this->cacheTable);
        $count = $queryBuilder->count('*')
            ->from($this->cacheTable)
            ->where(
                $queryBuilder->expr()->eq(
                    'identifier',
                    $queryBuilder->createNamedParameter($entryIdentifier, ‪Connection::PARAM_STR)
                ),
                $queryBuilder->expr()->gte(
                    'expires',
                    $queryBuilder->createNamedParameter(‪$GLOBALS['EXEC_TIME'], ‪Connection::PARAM_INT)
                )
            )
            ->executeQuery()
            ->fetchOne();
        return (bool)$count;
    }
 
    public function remove($entryIdentifier)
    {
        $this->‪throwExceptionIfFrontendDoesNotExist();
        $numberOfRowsRemoved = GeneralUtility::makeInstance(ConnectionPool::class)
            ->getConnectionForTable($this->cacheTable)
            ->delete(
                $this->cacheTable,
                ['identifier' => $entryIdentifier]
            );
        GeneralUtility::makeInstance(ConnectionPool::class)
            ->getConnectionForTable($this->tagsTable)
            ->delete(
                $this->tagsTable,
                ['identifier' => $entryIdentifier]
            );
        return (bool)$numberOfRowsRemoved;
    }
 
    public function ‪findIdentifiersByTag($tag)
    {
        $this->‪throwExceptionIfFrontendDoesNotExist();
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
            ->getQueryBuilderForTable($this->tagsTable);
        $result = $queryBuilder->select($this->cacheTable . '.identifier')
            ->from($this->cacheTable)
            ->from($this->tagsTable)
            ->where(
                $queryBuilder->expr()->eq($this->cacheTable . '.identifier', $queryBuilder->quoteIdentifier($this->tagsTable . '.identifier')),
                $queryBuilder->expr()->eq(
                    $this->tagsTable . '.tag',
                    $queryBuilder->createNamedParameter($tag, ‪Connection::PARAM_STR)
                ),
                $queryBuilder->expr()->gte(
                    $this->cacheTable . '.expires',
                    $queryBuilder->createNamedParameter(‪$GLOBALS['EXEC_TIME'], ‪Connection::PARAM_INT)
                )
            )
            ->groupBy($this->cacheTable . '.identifier')
            ->executeQuery();
        $identifiers = $result->fetchFirstColumn();
        return array_combine($identifiers, $identifiers);
    }
 
    public function ‪flush()
    {
        $this->‪throwExceptionIfFrontendDoesNotExist();
        GeneralUtility::makeInstance(ConnectionPool::class)
            ->getConnectionForTable($this->cacheTable)
            ->truncate($this->cacheTable);
        GeneralUtility::makeInstance(ConnectionPool::class)
            ->getConnectionForTable($this->tagsTable)
            ->truncate($this->tagsTable);
    }
 
    public function ‪flushByTags(array $tags)
    {
        $this->‪throwExceptionIfFrontendDoesNotExist();
 
        if (empty($tags)) {
            return;
        }
 
        $connection = GeneralUtility::makeInstance(ConnectionPool::class)->getConnectionForTable($this->cacheTable);
 
        // A large set of tags was detected. Process it in chunks to guard against exceeding
        // maximum SQL query limits.
        if (count($tags) > 100) {
            $chunks = array_chunk($tags, 100);
            array_walk($chunks, [$this, 'flushByTags']);
            return;
        }
        // VERY simple quoting of tags is sufficient here for performance. Tags are already
        // validated to not contain any bad characters, e.g. they are automatically generated
        // inside this class and suffixed with a pure integer enforced by DB.
        $quotedTagList = array_map(static function ($value) {
            return '\'' . $value . '\'';
        }, $tags);
 
        if ($this->‪isConnectionMysql($connection)) {
            // Use an optimized query on mysql ... don't use on your own
            // * ansi sql does not know about multi table delete
            // * doctrine query builder does not support join on delete()
            $connection->executeQuery(
                'DELETE tags2, cache1'
                . ' FROM ' . $this->tagsTable . ' AS tags1'
                . ' JOIN ' . $this->tagsTable . ' AS tags2 ON tags1.identifier = tags2.identifier'
                . ' JOIN ' . $this->cacheTable . ' AS cache1 ON tags1.identifier = cache1.identifier'
                . ' WHERE tags1.tag IN (' . implode(',', $quotedTagList) . ')'
            );
        } else {
            $queryBuilder = $connection->createQueryBuilder();
            $result = $queryBuilder->select('identifier')
                ->from($this->tagsTable)
                ->where('tag IN (' . implode(',', $quotedTagList) . ')')
                // group by is like DISTINCT and used here to suppress possible duplicate identifiers
                ->groupBy('identifier')
                ->executeQuery();
            $cacheEntryIdentifiers = $result->fetchFirstColumn();
            $quotedIdentifiers = $queryBuilder->createNamedParameter($cacheEntryIdentifiers, Connection::PARAM_STR_ARRAY);
            $queryBuilder->delete($this->cacheTable)
                ->where($queryBuilder->expr()->in('identifier', $quotedIdentifiers))
                ->executeStatement();
            $queryBuilder->delete($this->tagsTable)
                ->where($queryBuilder->expr()->in('identifier', $quotedIdentifiers))
                ->executeStatement();
        }
    }
 
    public function ‪flushByTag($tag)
    {
        $this->‪throwExceptionIfFrontendDoesNotExist();
 
        if (empty($tag)) {
            return;
        }
 
        $connection = GeneralUtility::makeInstance(ConnectionPool::class)->getConnectionForTable($this->cacheTable);
 
        $quotedTag = '\'' . $tag . '\'';
 
        if ($this->‪isConnectionMysql($connection)) {
            // Use an optimized query on mysql ... don't use on your own
            // * ansi sql does not know about multi table delete
            // * doctrine query builder does not support join on delete()
            $connection->executeQuery(
                'DELETE tags2, cache1'
                . ' FROM ' . $this->tagsTable . ' AS tags1'
                . ' JOIN ' . $this->tagsTable . ' AS tags2 ON tags1.identifier = tags2.identifier'
                . ' JOIN ' . $this->cacheTable . ' AS cache1 ON tags1.identifier = cache1.identifier'
                . ' WHERE tags1.tag = ' . $quotedTag
            );
        } else {
            $queryBuilder = $connection->createQueryBuilder();
            $result = $queryBuilder->select('identifier')
                ->from($this->tagsTable)
                ->where('tag = ' . $quotedTag)
                // group by is like DISTINCT and used here to suppress possible duplicate identifiers
                ->groupBy('identifier')
                ->executeQuery();
            $cacheEntryIdentifiers = $result->fetchFirstColumn();
            $quotedIdentifiers = $queryBuilder->createNamedParameter($cacheEntryIdentifiers, Connection::PARAM_STR_ARRAY);
            $queryBuilder->delete($this->cacheTable)
                ->where($queryBuilder->expr()->in('identifier', $quotedIdentifiers))
                ->executeStatement();
            $queryBuilder->delete($this->tagsTable)
                ->where($queryBuilder->expr()->in('identifier', $quotedIdentifiers))
                ->executeStatement();
        }
    }
 
    public function ‪collectGarbage()
    {
        $this->‪throwExceptionIfFrontendDoesNotExist();
 
        $connection = GeneralUtility::makeInstance(ConnectionPool::class)->getConnectionForTable($this->cacheTable);
        if ($this->‪isConnectionMysql($connection)) {
            // Use an optimized query on mysql ... don't use on your own
            // * ansi sql does not know about multi table delete
            // * doctrine query builder does not support join on delete()
            // First delete all expired rows from cache table and their connected tag rows
            $connection->executeQuery(
                'DELETE cache, tags'
                . ' FROM ' . $this->cacheTable . ' AS cache'
                . ' LEFT OUTER JOIN ' . $this->tagsTable . ' AS tags ON cache.identifier = tags.identifier'
                . ' WHERE cache.expires < ?',
                [(int)‪$GLOBALS['EXEC_TIME']]
            );
            // Then delete possible "orphaned" rows from tags table - tags that have no cache row for whatever reason
            $connection->executeQuery(
                'DELETE tags'
                . ' FROM ' . $this->tagsTable . ' AS tags'
                . ' LEFT OUTER JOIN ' . $this->cacheTable . ' as cache ON tags.identifier = cache.identifier'
                . ' WHERE cache.identifier IS NULL'
            );
        } else {
            $queryBuilder = $connection->createQueryBuilder();
            $result = $queryBuilder->select('identifier')
                ->from($this->cacheTable)
                ->where($queryBuilder->expr()->lt(
                    'expires',
                    $queryBuilder->createNamedParameter(‪$GLOBALS['EXEC_TIME'], ‪Connection::PARAM_INT)
                ))
                // group by is like DISTINCT and used here to suppress possible duplicate identifiers
                ->groupBy('identifier')
                ->executeQuery();
 
            // Get identifiers of expired cache entries
            $cacheEntryIdentifiers = $result->fetchFirstColumn();
            if (!empty($cacheEntryIdentifiers)) {
                // Delete tag rows connected to expired cache entries
                $quotedIdentifiers = $queryBuilder->createNamedParameter($cacheEntryIdentifiers, Connection::PARAM_STR_ARRAY);
                $queryBuilder->delete($this->tagsTable)
                    ->where($queryBuilder->expr()->in('identifier', $quotedIdentifiers))
                    ->executeStatement();
            }
            $queryBuilder->delete($this->cacheTable)
                ->where($queryBuilder->expr()->lt(
                    'expires',
                    $queryBuilder->createNamedParameter(‪$GLOBALS['EXEC_TIME'], ‪Connection::PARAM_INT)
                ))
                ->executeStatement();
 
            // Find out which "orphaned" tags rows exists that have no cache row and delete those, too.
            $queryBuilder = $connection->createQueryBuilder();
            $result = $queryBuilder->select('tags.identifier')
                ->from($this->tagsTable, 'tags')
                ->leftJoin(
                    'tags',
                    $this->cacheTable,
                    'cache',
                    $queryBuilder->expr()->eq('tags.identifier', $queryBuilder->quoteIdentifier('cache.identifier'))
                )
                ->where($queryBuilder->expr()->isNull('cache.identifier'))
                ->groupBy('tags.identifier')
                ->executeQuery();
            $tagsEntryIdentifiers = $result->fetchFirstColumn();
 
            if (!empty($tagsEntryIdentifiers)) {
                $quotedIdentifiers = $queryBuilder->createNamedParameter($tagsEntryIdentifiers, Connection::PARAM_STR_ARRAY);
                $queryBuilder->delete($this->tagsTable)
                    ->where($queryBuilder->expr()->in('identifier', $quotedIdentifiers))
                    ->executeStatement();
            }
        }
    }
 
    public function ‪getCacheTable()
    {
        $this->‪throwExceptionIfFrontendDoesNotExist();
        return ‪$this->cacheTable;
    }
 
    public function ‪getTagsTable()
    {
        $this->‪throwExceptionIfFrontendDoesNotExist();
        return ‪$this->tagsTable;
    }
 
    public function ‪setCompression(‪$compression)
    {
        $this->compression = ‪$compression;
    }
 
    public function ‪setCompressionLevel(‪$compressionLevel)
    {
        if (‪$compressionLevel >= -1 && ‪$compressionLevel <= 9) {
            $this->compressionLevel = ‪$compressionLevel;
        }
    }
 
    protected function ‪isConnectionMysql(Connection $connection): bool
    {
        $serverVersion = $connection->getServerVersion();
        return (bool)(strpos($serverVersion, 'MySQL') === 0);
    }
 
    protected function ‪throwExceptionIfFrontendDoesNotExist()
    {
        if (!$this->cache instanceof FrontendInterface) {
            throw new Exception('No cache frontend has been set via setCache() yet.', 1236518288);
        }
    }
 
    public function ‪getTableDefinitions()
    {
        $cacheTableSql = (string)file_get_contents(
            ‪ExtensionManagementUtility::extPath('core') .
            'Resources/Private/Sql/Cache/Backend/Typo3DatabaseBackendCache.sql'
        );
        $requiredTableStructures = str_replace('###CACHE_TABLE###', $this->cacheTable, $cacheTableSql) . LF . LF;
        $tagsTableSql = (string)file_get_contents(
            ‪ExtensionManagementUtility::extPath('core') .
            'Resources/Private/Sql/Cache/Backend/Typo3DatabaseBackendTags.sql'
        );
        $requiredTableStructures .= str_replace('###TAGS_TABLE###', $this->tagsTable, $tagsTableSql) . LF;
        return $requiredTableStructures;
    }
}