CacheWarmupCommand.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\Command;
 
use Psr\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use ‪TYPO3\CMS\Core\Cache\CacheManager;
use ‪TYPO3\CMS\Core\Cache\Event\CacheWarmupEvent;
use ‪TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
use ‪TYPO3\CMS\Core\Configuration\Event\AfterTcaCompilationEvent;
use ‪TYPO3\CMS\Core\Core\BootService;
use ‪TYPO3\CMS\Core\Core\Event\WarmupBaseTcaCache;
use TYPO3\CMS\Core\DependencyInjection\ContainerBuilder;
use ‪TYPO3\CMS\Core\EventDispatcher\ListenerProvider;
use TYPO3\CMS\Core\Package\PackageManager;
use ‪TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
 
class ‪CacheWarmupCommand extends Command
{
    protected ContainerBuilder ‪$containerBuilder;
    protected PackageManager ‪$packageManager;
    protected ‪BootService ‪$bootService;
    protected ‪FrontendInterface ‪$dependencyInjectionCache;
 
    public function ‪__construct(
        ContainerBuilder ‪$containerBuilder,
        PackageManager ‪$packageManager,
        ‪BootService ‪$bootService,
        ‪FrontendInterface ‪$dependencyInjectionCache
    ) {
        $this->containerBuilder = ‪$containerBuilder;
        $this->packageManager = ‪$packageManager;
        $this->bootService = ‪$bootService;
        $this->dependencyInjectionCache = ‪$dependencyInjectionCache;
        parent::__construct('cache:warmup');
    }
 
    protected function ‪configure(): void
    {
        $this->setDescription('Warmup TYPO3 caches.');
        $this->setHelp('This command is useful for deployments to warmup caches during release preparation.');
        $this->setDefinition([
            new InputOption('group', 'g', InputOption::VALUE_OPTIONAL, 'The cache group to warmup (system, pages, di or all)', 'all'),
        ]);
    }
 
    protected function ‪execute(InputInterface $input, OutputInterface ‪$output): int
    {
        $group = $input->getOption('group') ?? 'all';
 
        if ($group === 'di' || $group === 'system' || $group === 'all') {
            $this->containerBuilder->warmupCache($this->packageManager, $this->dependencyInjectionCache);
            if ($group === 'di') {
                return 0;
            }
        }
 
        $container = $this->bootService->getContainer();
 
        $allowExtFileCaches = true;
        if ($group === 'system' || $group === 'all') {
            $coreCache = $container->get('cache.core');
            ‪ExtensionManagementUtility::createExtLocalconfCacheEntry($coreCache);
            ‪ExtensionManagementUtility::createExtTablesCacheEntry($coreCache);
 
            // Load TCA uncached…
            $allowExtFileCaches = false;
            // …but store the fresh base TCA to cache
            $listenerProvider = $container->get(ListenerProvider::class);
            $listenerProvider->addListener(AfterTcaCompilationEvent::class, WarmupBaseTcaCache::class, 'storeBaseTcaCache');
        }
 
        // Perform a full boot to load localconf as requirement extensions and for TCA loading.
        // TCA will be cached during dispatch of AfterTcaCompilationEvent.
        $this->bootService->loadExtLocalconfDatabaseAndExtTables(false, $allowExtFileCaches);
 
        $eventDispatcher = $container->get(EventDispatcherInterface::class);
 
        $groups = $group === 'all' ? $container->get(CacheManager::class)->getCacheGroups() : [$group];
        $event = new ‪CacheWarmupEvent($groups);
        $eventDispatcher->dispatch($event);
 
        if (count($event->getErrors()) > 0) {
            return 1;
        }
 
        return 0;
    }
}