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

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