vendor/symfony/framework-bundle/Command/CacheClearCommand.php line 43

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Bundle\FrameworkBundle\Command;
  14. use Symfony\Component\Console\Attribute\AsCommand;
  15. use Symfony\Component\Console\Command\Command;
  16. use Symfony\Component\Console\Exception\RuntimeException;
  17. use Symfony\Component\Console\Input\InputInterface;
  18. use Symfony\Component\Console\Input\InputOption;
  19. use Symfony\Component\Console\Output\OutputInterface;
  20. use Symfony\Component\Console\Style\SymfonyStyle;
  21. use Symfony\Component\DependencyInjection\Dumper\Preloader;
  22. use Symfony\Component\EventDispatcher\EventDispatcher;
  23. use Symfony\Component\Filesystem\Exception\IOException;
  24. use Symfony\Component\Filesystem\Filesystem;
  25. use Symfony\Component\Finder\Finder;
  26. use Symfony\Component\HttpKernel\CacheClearer\CacheClearerInterface;
  27. use Symfony\Component\HttpKernel\RebootableInterface;
  29. /**
  30.  * Clear and Warmup the cache.
  31.  *
  32.  * @author Francis Besset <francis.besset@gmail.com>
  33.  * @author Fabien Potencier <fabien@symfony.com>
  34.  *
  35.  * @final
  36.  */
  37. #[AsCommand(name: 'cache:clear', description: 'Clear the cache')]
  38. class CacheClearCommand extends Command
  39. {
  40.     private CacheClearerInterface $cacheClearer;
  41.     private Filesystem $filesystem;
  43.     public function __construct(CacheClearerInterface $cacheClearer, Filesystem $filesystem = null)
  44.     {
  45.         parent::__construct();
  47.         $this->cacheClearer = $cacheClearer;
  48.         $this->filesystem = $filesystem ?? new Filesystem();
  49.     }
  51.     protected function configure()
  52.     {
  53.         $this
  54.             ->setDefinition([
  55.                 new InputOption('no-warmup', '', InputOption::VALUE_NONE, 'Do not warm up the cache'),
  56.                 new InputOption('no-optional-warmers', '', InputOption::VALUE_NONE, 'Skip optional cache warmers (faster)'),
  57.             ])
  58.             ->setHelp(<<<'EOF'
  59. The <info>%command.name%</info> command clears and warms up the application cache for a given environment
  60. and debug mode:
  62.   <info>php %command.full_name% --env=dev</info>
  63.   <info>php %command.full_name% --env=prod --no-debug</info>
  64. EOF
  65.             )
  66.         ;
  67.     }
  69.     protected function execute(InputInterface $input, OutputInterface $output): int
  70.     {
  71.         $fs = $this->filesystem;
  72.         $io = new SymfonyStyle($input, $output);
  74.         $kernel = $this->getApplication()->getKernel();
  75.         $realCacheDir = $kernel->getContainer()->getParameter('kernel.cache_dir');
  76.         $realBuildDir = $kernel->getContainer()->hasParameter('kernel.build_dir') ? $kernel->getContainer()->getParameter('kernel.build_dir') : $realCacheDir;
  77.         // the old cache dir name must not be longer than the real one to avoid exceeding
  78.         // the maximum length of a directory or file path within it (esp. Windows MAX_PATH)
  79.         $oldCacheDir = substr($realCacheDir, 0, -1).(str_ends_with($realCacheDir, '~') ? '+' : '~');
  80.         $fs->remove($oldCacheDir);
  82.         if (!is_writable($realCacheDir)) {
  83.             throw new RuntimeException(sprintf('Unable to write in the "%s" directory.', $realCacheDir));
  84.         }
  86.         $useBuildDir = $realBuildDir !== $realCacheDir;
  87.         $oldBuildDir = substr($realBuildDir, 0, -1).(str_ends_with($realBuildDir, '~') ? '+' : '~');
  88.         if ($useBuildDir) {
  89.             $fs->remove($oldBuildDir);
  91.             if (!is_writable($realBuildDir)) {
  92.                 throw new RuntimeException(sprintf('Unable to write in the "%s" directory.', $realBuildDir));
  93.             }
  95.             if ($this->isNfs($realCacheDir)) {
  96.                 $fs->remove($realCacheDir);
  97.             } else {
  98.                 $fs->rename($realCacheDir, $oldCacheDir);
  99.             }
  100.             $fs->mkdir($realCacheDir);
  101.         }
  103.         $io->comment(sprintf('Clearing the cache for the <info>%s</info> environment with debug <info>%s</info>', $kernel->getEnvironment(), var_export($kernel->isDebug(), true)));
  104.         if ($useBuildDir) {
  105.             $this->cacheClearer->clear($realBuildDir);
  106.         }
  107.         $this->cacheClearer->clear($realCacheDir);
  109.         // The current event dispatcher is stale, let's not use it anymore
  110.         $this->getApplication()->setDispatcher(new EventDispatcher());
  112.         $containerFile = (new \ReflectionObject($kernel->getContainer()))->getFileName();
  113.         $containerDir = basename(\dirname($containerFile));
  115.         // the warmup cache dir name must have the same length as the real one
  116.         // to avoid the many problems in serialized resources files
  117.         $warmupDir = substr($realBuildDir, 0, -1).(str_ends_with($realBuildDir, '_') ? '-' : '_');
  119.         if ($output->isVerbose() && $fs->exists($warmupDir)) {
  120.             $io->comment('Clearing outdated warmup directory...');
  121.         }
  122.         $fs->remove($warmupDir);
  124.         if ($_SERVER['REQUEST_TIME'] <= filemtime($containerFile) && filemtime($containerFile) <= time()) {
  125.             if ($output->isVerbose()) {
  126.                 $io->comment('Cache is fresh.');
  127.             }
  128.             if (!$input->getOption('no-warmup') && !$input->getOption('no-optional-warmers')) {
  129.                 if ($output->isVerbose()) {
  130.                     $io->comment('Warming up optional cache...');
  131.                 }
  132.                 $this->warmupOptionals($realCacheDir);
  133.             }
  134.         } else {
  135.             $fs->mkdir($warmupDir);
  137.             if (!$input->getOption('no-warmup')) {
  138.                 if ($output->isVerbose()) {
  139.                     $io->comment('Warming up cache...');
  140.                 }
  141.                 $this->warmup($warmupDir, $realBuildDir);
  143.                 if (!$input->getOption('no-optional-warmers')) {
  144.                     if ($output->isVerbose()) {
  145.                         $io->comment('Warming up optional cache...');
  146.                     }
  147.                     $this->warmupOptionals($realCacheDir);
  148.                 }
  149.             }
  151.             if (!$fs->exists($warmupDir.'/'.$containerDir)) {
  152.                 $fs->rename($realBuildDir.'/'.$containerDir, $warmupDir.'/'.$containerDir);
  153.                 touch($warmupDir.'/'.$containerDir.'.legacy');
  154.             }
  156.             if ($this->isNfs($realBuildDir)) {
  157.                 $io->note('For better performances, you should move the cache and log directories to a non-shared folder of the VM.');
  158.                 $fs->remove($realBuildDir);
  159.             } else {
  160.                 $fs->rename($realBuildDir, $oldBuildDir);
  161.             }
  163.             $fs->rename($warmupDir, $realBuildDir);
  165.             if ($output->isVerbose()) {
  166.                 $io->comment('Removing old build and cache directory...');
  167.             }
  169.             if ($useBuildDir) {
  170.                 try {
  171.                     $fs->remove($oldBuildDir);
  172.                 } catch (IOException $e) {
  173.                     if ($output->isVerbose()) {
  174.                         $io->warning($e->getMessage());
  175.                     }
  176.                 }
  177.             }
  179.             try {
  180.                 $fs->remove($oldCacheDir);
  181.             } catch (IOException $e) {
  182.                 if ($output->isVerbose()) {
  183.                     $io->warning($e->getMessage());
  184.                 }
  185.             }
  186.         }
  188.         if ($output->isVerbose()) {
  189.             $io->comment('Finished');
  190.         }
  192.         $io->success(sprintf('Cache for the "%s" environment (debug=%s) was successfully cleared.', $kernel->getEnvironment(), var_export($kernel->isDebug(), true)));
  194.         return 0;
  195.     }
  197.     private function isNfs(string $dir): bool
  198.     {
  199.         static $mounts = null;
  201.         if (null === $mounts) {
  202.             $mounts = [];
  203.             if ('/' === \DIRECTORY_SEPARATOR && $files = @file('/proc/mounts')) {
  204.                 foreach ($files as $mount) {
  205.                     $mount = \array_slice(explode(' ', $mount), 1, -3);
  206.                     if (!\in_array(array_pop($mount), ['vboxsf', 'nfs'])) {
  207.                         continue;
  208.                     }
  209.                     $mounts[] = implode(' ', $mount).'/';
  210.                 }
  211.             }
  212.         }
  213.         foreach ($mounts as $mount) {
  214.             if (str_starts_with($dir, $mount)) {
  215.                 return true;
  216.             }
  217.         }
  219.         return false;
  220.     }
  222.     private function warmup(string $warmupDir, string $realBuildDir): void
  223.     {
  224.         // create a temporary kernel
  225.         $kernel = $this->getApplication()->getKernel();
  226.         if (!$kernel instanceof RebootableInterface) {
  227.             throw new \LogicException('Calling "cache:clear" with a kernel that does not implement "Symfony\Component\HttpKernel\RebootableInterface" is not supported.');
  228.         }
  229.         $kernel->reboot($warmupDir);
  231.         // fix references to cached files with the real cache directory name
  232.         $search = [$warmupDir, str_replace('\\', '\\\\', $warmupDir)];
  233.         $replace = str_replace('\\', '/', $realBuildDir);
  234.         foreach (Finder::create()->files()->in($warmupDir) as $file) {
  235.             $content = str_replace($search, $replace, file_get_contents($file), $count);
  236.             if ($count) {
  237.                 file_put_contents($file, $content);
  238.             }
  239.         }
  240.     }
  242.     private function warmupOptionals(string $realCacheDir): void
  243.     {
  244.         $kernel = $this->getApplication()->getKernel();
  245.         $warmer = $kernel->getContainer()->get('cache_warmer');
  246.         // non optional warmers already ran during container compilation
  247.         $warmer->enableOnlyOptionalWarmers();
  248.         $preload = (array) $warmer->warmUp($realCacheDir);
  250.         if ($preload && file_exists($preloadFile = $realCacheDir.'/'.$kernel->getContainer()->getParameter('kernel.container_class').'.preload.php')) {
  251.             Preloader::append($preloadFile, $preload);
  252.         }
  253.     }
  254. }