* * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Symfony\Bundle\FrameworkBundle\Command; use Symfony\Component\Console\Attribute\AsCommand; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Exception\RuntimeException; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Style\SymfonyStyle; use Symfony\Component\DependencyInjection\Dumper\Preloader; use Symfony\Component\EventDispatcher\EventDispatcher; use Symfony\Component\Filesystem\Exception\IOException; use Symfony\Component\Filesystem\Filesystem; use Symfony\Component\Finder\Finder; use Symfony\Component\HttpKernel\CacheClearer\CacheClearerInterface; use Symfony\Component\HttpKernel\RebootableInterface; /** * Clear and Warmup the cache. * * @author Francis Besset * @author Fabien Potencier * * @final */ #[AsCommand(name: 'cache:clear', description: 'Clear the cache')] class CacheClearCommand extends Command { private Filesystem $filesystem; public function __construct( private CacheClearerInterface $cacheClearer, ?Filesystem $filesystem = null, ) { parent::__construct(); $this->filesystem = $filesystem ?? new Filesystem(); } protected function configure(): void { $this ->setDefinition([ new InputOption('no-warmup', '', InputOption::VALUE_NONE, 'Do not warm up the cache'), new InputOption('no-optional-warmers', '', InputOption::VALUE_NONE, 'Skip optional cache warmers (faster)'), ]) ->setHelp(<<<'EOF' The %command.name% command clears and warms up the application cache for a given environment and debug mode: php %command.full_name% --env=dev php %command.full_name% --env=prod --no-debug EOF ) ; } protected function execute(InputInterface $input, OutputInterface $output): int { $fs = $this->filesystem; $io = new SymfonyStyle($input, $output); $kernel = $this->getApplication()->getKernel(); $realCacheDir = $kernel->getContainer()->getParameter('kernel.cache_dir'); $realBuildDir = $kernel->getContainer()->hasParameter('kernel.build_dir') ? $kernel->getContainer()->getParameter('kernel.build_dir') : $realCacheDir; // the old cache dir name must not be longer than the real one to avoid exceeding // the maximum length of a directory or file path within it (esp. Windows MAX_PATH) $oldCacheDir = substr($realCacheDir, 0, -1).(str_ends_with($realCacheDir, '~') ? '+' : '~'); $fs->remove($oldCacheDir); if (!is_writable($realCacheDir)) { throw new RuntimeException(sprintf('Unable to write in the "%s" directory.', $realCacheDir)); } $useBuildDir = $realBuildDir !== $realCacheDir; $oldBuildDir = substr($realBuildDir, 0, -1).(str_ends_with($realBuildDir, '~') ? '+' : '~'); if ($useBuildDir) { $fs->remove($oldBuildDir); if (!is_writable($realBuildDir)) { throw new RuntimeException(sprintf('Unable to write in the "%s" directory.', $realBuildDir)); } if ($this->isNfs($realCacheDir)) { $fs->remove($realCacheDir); } else { $fs->rename($realCacheDir, $oldCacheDir); } $fs->mkdir($realCacheDir); } $io->comment(sprintf('Clearing the cache for the %s environment with debug %s', $kernel->getEnvironment(), var_export($kernel->isDebug(), true))); if ($useBuildDir) { $this->cacheClearer->clear($realBuildDir); } $this->cacheClearer->clear($realCacheDir); // The current event dispatcher is stale, let's not use it anymore $this->getApplication()->setDispatcher(new EventDispatcher()); $containerFile = (new \ReflectionObject($kernel->getContainer()))->getFileName(); $containerDir = basename(\dirname($containerFile)); // the warmup cache dir name must have the same length as the real one // to avoid the many problems in serialized resources files $warmupDir = substr($realBuildDir, 0, -1).(str_ends_with($realBuildDir, '_') ? '-' : '_'); if ($output->isVerbose() && $fs->exists($warmupDir)) { $io->comment('Clearing outdated warmup directory...'); } $fs->remove($warmupDir); if ($_SERVER['REQUEST_TIME'] <= filemtime($containerFile) && filemtime($containerFile) <= time()) { if ($output->isVerbose()) { $io->comment('Cache is fresh.'); } if (!$input->getOption('no-warmup') && !$input->getOption('no-optional-warmers')) { if ($output->isVerbose()) { $io->comment('Warming up optional cache...'); } $this->warmupOptionals($realCacheDir, $realBuildDir, $io); } } else { $fs->mkdir($warmupDir); if (!$input->getOption('no-warmup')) { if ($output->isVerbose()) { $io->comment('Warming up cache...'); } $this->warmup($warmupDir, $realBuildDir); if (!$input->getOption('no-optional-warmers')) { if ($output->isVerbose()) { $io->comment('Warming up optional cache...'); } $this->warmupOptionals($useBuildDir ? $realCacheDir : $warmupDir, $warmupDir, $io); } } if (!$fs->exists($warmupDir.'/'.$containerDir)) { $fs->rename($realBuildDir.'/'.$containerDir, $warmupDir.'/'.$containerDir); touch($warmupDir.'/'.$containerDir.'.legacy'); } if ($this->isNfs($realBuildDir)) { $io->note('For better performance, you should move the cache and log directories to a non-shared folder of the VM.'); $fs->remove($realBuildDir); } else { $fs->rename($realBuildDir, $oldBuildDir); } $fs->rename($warmupDir, $realBuildDir); if ($output->isVerbose()) { $io->comment('Removing old build and cache directory...'); } if ($useBuildDir) { try { $fs->remove($oldBuildDir); } catch (IOException $e) { if ($output->isVerbose()) { $io->warning($e->getMessage()); } } } try { $fs->remove($oldCacheDir); } catch (IOException $e) { if ($output->isVerbose()) { $io->warning($e->getMessage()); } } } if ($output->isVerbose()) { $io->comment('Finished'); } $io->success(sprintf('Cache for the "%s" environment (debug=%s) was successfully cleared.', $kernel->getEnvironment(), var_export($kernel->isDebug(), true))); return 0; } private function isNfs(string $dir): bool { static $mounts = null; if (null === $mounts) { $mounts = []; if ('/' === \DIRECTORY_SEPARATOR && @is_readable('/proc/mounts') && $files = @file('/proc/mounts')) { foreach ($files as $mount) { $mount = \array_slice(explode(' ', $mount), 1, -3); if (!\in_array(array_pop($mount), ['vboxsf', 'nfs'])) { continue; } $mounts[] = implode(' ', $mount).'/'; } } } foreach ($mounts as $mount) { if (str_starts_with($dir, $mount)) { return true; } } return false; } private function warmup(string $warmupDir, string $realBuildDir): void { // create a temporary kernel $kernel = $this->getApplication()->getKernel(); if (!$kernel instanceof RebootableInterface) { throw new \LogicException('Calling "cache:clear" with a kernel that does not implement "Symfony\Component\HttpKernel\RebootableInterface" is not supported.'); } $kernel->reboot($warmupDir); // fix references to cached files with the real cache directory name $search = [$warmupDir, str_replace('\\', '\\\\', $warmupDir)]; $replace = str_replace('\\', '/', $realBuildDir); foreach (Finder::create()->files()->in($warmupDir) as $file) { $content = str_replace($search, $replace, $this->filesystem->readFile($file), $count); if ($count) { file_put_contents($file, $content); } } } private function warmupOptionals(string $cacheDir, string $warmupDir, SymfonyStyle $io): void { $kernel = $this->getApplication()->getKernel(); $warmer = $kernel->getContainer()->get('cache_warmer'); // non optional warmers already ran during container compilation $warmer->enableOnlyOptionalWarmers(); $preload = (array) $warmer->warmUp($cacheDir, $warmupDir, $io); if ($preload && file_exists($preloadFile = $warmupDir.'/'.$kernel->getContainer()->getParameter('kernel.container_class').'.preload.php')) { Preloader::append($preloadFile, $preload); } } }