CacheManager.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Cache;

/*
 * 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\Cache\Exception\NoSuchCacheGroupException;

class CacheManager implements \TYPO3\CMS\Core\SingletonInterface
{
    protected $cacheFactory;

    protected $caches = array();

    protected $cacheConfigurations = array();

    protected $cacheGroups = array();

    protected $defaultCacheConfiguration = array(
        'frontend' => \TYPO3\CMS\Core\Cache\Frontend\VariableFrontend::class,
        'backend' => \TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class,
        'options' => array(),
        'groups' => array('all')
    );

    public function injectCacheFactory(\TYPO3\CMS\Core\Cache\CacheFactory $cacheFactory)
    {
        $this->cacheFactory = $cacheFactory;
    }

    public function setCacheConfigurations(array $cacheConfigurations)
    {
        foreach ($cacheConfigurations as $identifier => $configuration) {
            if (!is_array($configuration)) {
                throw new \InvalidArgumentException('The cache configuration for cache "' . $identifier . '" was not an array as expected.', 1231259656);
            }
            $this->cacheConfigurations[$identifier] = $configuration;
        }
    }

    public function registerCache(\TYPO3\CMS\Core\Cache\Frontend\FrontendInterface $cache)
    {
        $identifier = $cache->getIdentifier();
        if (isset($this->caches[$identifier])) {
            throw new \TYPO3\CMS\Core\Cache\Exception\DuplicateIdentifierException('A cache with identifier "' . $identifier . '" has already been registered.', 1203698223);
        }
        $this->caches[$identifier] = $cache;
    }

    public function getCache($identifier)
    {
        if ($this->hasCache($identifier) === false) {
            throw new \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException('A cache with identifier "' . $identifier . '" does not exist.', 1203699034);
        }
        if (!isset($this->caches[$identifier])) {
            $this->createCache($identifier);
        }
        return $this->caches[$identifier];
    }

    public function hasCache($identifier)
    {
        return isset($this->caches[$identifier]) || isset($this->cacheConfigurations[$identifier]);
    }

    public function flushCaches()
    {
        $this->createAllCaches();
        foreach ($this->caches as $cache) {
            $cache->flush();
        }
    }

    public function flushCachesInGroup($groupIdentifier)
    {
        $this->createAllCaches();
        if (isset($this->cacheGroups[$groupIdentifier])) {
            foreach ($this->cacheGroups[$groupIdentifier] as $cacheIdentifier) {
                if (isset($this->caches[$cacheIdentifier])) {
                    $this->caches[$cacheIdentifier]->flush();
                }
            }
        } else {
            throw new NoSuchCacheGroupException('No cache in the specified group \'' . $groupIdentifier . '\'', 1390334120);
        }
    }

    public function flushCachesInGroupByTag($groupIdentifier, $tag)
    {
        $this->createAllCaches();
        if (isset($this->cacheGroups[$groupIdentifier])) {
            foreach ($this->cacheGroups[$groupIdentifier] as $cacheIdentifier) {
                if (isset($this->caches[$cacheIdentifier])) {
                    $this->caches[$cacheIdentifier]->flushByTag($tag);
                }
            }
        } else {
            throw new NoSuchCacheGroupException('No cache in the specified group \'' . $groupIdentifier . '\'', 1390337129);
        }
    }


    public function flushCachesByTag($tag)
    {
        $this->createAllCaches();
        foreach ($this->caches as $cache) {
            $cache->flushByTag($tag);
        }
    }

    public function flushClassFileCachesByChangedFiles($fileMonitorIdentifier, array $changedFiles)
    {
        $modifiedClassNamesWithUnderscores = array();
        $objectClassesCache = $this->getCache('FLOW3_Object_Classes');
        $objectConfigurationCache = $this->getCache('FLOW3_Object_Configuration');
        switch ($fileMonitorIdentifier) {
            case 'FLOW3_ClassFiles':
                $modifiedAspectClassNamesWithUnderscores = array();
                foreach ($changedFiles as $pathAndFilename => $status) {
                    $pathAndFilename = str_replace(FLOW3_PATH_PACKAGES, '', $pathAndFilename);
                    $matches = array();
                    if (preg_match('/[^\\/]+\\/(.+)\\/(Classes|Tests)\\/(.+)\\.php/', $pathAndFilename, $matches) === 1) {
                        $classNameWithUnderscores = str_replace(array('/', '.'), '_', $matches[1] . '_' . ($matches[2] === 'Tests' ? 'Tests_' : '') . $matches[3]);
                        $modifiedClassNamesWithUnderscores[$classNameWithUnderscores] = true;
                        // If an aspect was modified, the whole code cache needs to be flushed, so keep track of them:
                        if (substr($classNameWithUnderscores, -6, 6) === 'Aspect') {
                            $modifiedAspectClassNamesWithUnderscores[$classNameWithUnderscores] = true;
                        }
                        // As long as no modified aspect was found, we are optimistic that only part of the cache needs to be flushed:
                        if (empty($modifiedAspectClassNamesWithUnderscores)) {
                            $objectClassesCache->remove($classNameWithUnderscores);
                        }
                    }
                }
                $flushDoctrineProxyCache = false;
                if (!empty($modifiedClassNamesWithUnderscores)) {
                    $reflectionStatusCache = $this->getCache('FLOW3_Reflection_Status');
                    foreach ($modifiedClassNamesWithUnderscores as $classNameWithUnderscores => $_) {
                        $reflectionStatusCache->remove($classNameWithUnderscores);
                        if ($flushDoctrineProxyCache === false && preg_match('/_Domain_Model_(.+)/', $classNameWithUnderscores) === 1) {
                            $flushDoctrineProxyCache = true;
                        }
                    }
                    $objectConfigurationCache->remove('allCompiledCodeUpToDate');
                }
                if (!empty($modifiedAspectClassNamesWithUnderscores)) {
                    $this->systemLogger->log('Aspect classes have been modified, flushing the whole proxy classes cache.', LOG_INFO);
                    $objectClassesCache->flush();
                }
                if ($flushDoctrineProxyCache === true) {
                    $this->systemLogger->log('Domain model changes have been detected, triggering Doctrine 2 proxy rebuilding.', LOG_INFO);
                    $objectConfigurationCache->remove('doctrineProxyCodeUpToDate');
                }
                break;
            case 'FLOW3_ConfigurationFiles':
                $policyChangeDetected = false;
                $routesChangeDetected = false;
                foreach ($changedFiles as $pathAndFilename => $_) {
                    $filename = basename($pathAndFilename);
                    if (!in_array($filename, array('Policy.yaml', 'Routes.yaml'))) {
                        continue;
                    }
                    if ($policyChangeDetected === false && $filename === 'Policy.yaml') {
                        $this->systemLogger->log('The security policies have changed, flushing the policy cache.', LOG_INFO);
                        $this->getCache('FLOW3_Security_Policy')->flush();
                        $policyChangeDetected = true;
                    } elseif ($routesChangeDetected === false && $filename === 'Routes.yaml') {
                        $this->systemLogger->log('A Routes.yaml file has been changed, flushing the routing cache.', LOG_INFO);
                        $this->getCache('FLOW3_Mvc_Routing_FindMatchResults')->flush();
                        $this->getCache('FLOW3_Mvc_Routing_Resolve')->flush();
                        $routesChangeDetected = true;
                    }
                }
                $this->systemLogger->log('The configuration has changed, triggering an AOP proxy class rebuild.', LOG_INFO);
                $objectConfigurationCache->remove('allAspectClassesUpToDate');
                $objectConfigurationCache->remove('allCompiledCodeUpToDate');
                $objectClassesCache->flush();
                break;
            case 'FLOW3_TranslationFiles':
                foreach ($changedFiles as $pathAndFilename => $status) {
                    $matches = array();
                    if (preg_match('/\\/Translations\\/.+\\.xlf/', $pathAndFilename, $matches) === 1) {
                        $this->systemLogger->log('The localization files have changed, thus flushing the I18n XML model cache.', LOG_INFO);
                        $this->getCache('FLOW3_I18n_XmlModelCache')->flush();
                        break;
                    }
                }
                break;
        }
    }

    public static function getClassTag($className = '')
    {
        return $className === '' ? \TYPO3\CMS\Core\Cache\Frontend\FrontendInterface::TAG_CLASS : \TYPO3\CMS\Core\Cache\Frontend\FrontendInterface::TAG_CLASS . str_replace('\\', '_', $className);
    }

    protected function createAllCaches()
    {
        foreach ($this->cacheConfigurations as $identifier => $_) {
            if (!isset($this->caches[$identifier])) {
                $this->createCache($identifier);
            }
        }
    }

    protected function createCache($identifier)
    {
        if (isset($this->cacheConfigurations[$identifier]['frontend'])) {
            $frontend = $this->cacheConfigurations[$identifier]['frontend'];
        } else {
            $frontend = $this->defaultCacheConfiguration['frontend'];
        }
        if (isset($this->cacheConfigurations[$identifier]['backend'])) {
            $backend = $this->cacheConfigurations[$identifier]['backend'];
        } else {
            $backend = $this->defaultCacheConfiguration['backend'];
        }
        if (isset($this->cacheConfigurations[$identifier]['options'])) {
            $backendOptions = $this->cacheConfigurations[$identifier]['options'];
        } else {
            $backendOptions = $this->defaultCacheConfiguration['options'];
        }

        // Add the cache identifier to the groups that it should be attached to, or use the default ones.
        if (isset($this->cacheConfigurations[$identifier]['groups']) && is_array($this->cacheConfigurations[$identifier]['groups'])) {
            $assignedGroups = $this->cacheConfigurations[$identifier]['groups'];
        } else {
            $assignedGroups = $this->defaultCacheConfiguration['groups'];
        }
        foreach ($assignedGroups as $groupIdentifier) {
            if (!isset($this->cacheGroups[$groupIdentifier])) {
                $this->cacheGroups[$groupIdentifier] = array();
            }
            $this->cacheGroups[$groupIdentifier][] = $identifier;
        }

        $this->cacheFactory->create($identifier, $frontend, $backend, $backendOptions);
    }
}