#23354 Add $kernel->getTmpDir() to separate it from the cache directory

mnapoli · mnapoli · commit 61bd29e306b2 · 2020-04-21T14:36:15.000+02:00
diff --git a/src/Symfony/Bridge/Doctrine/Tests/DependencyInjection/DoctrineExtensionTest.php b/src/Symfony/Bridge/Doctrine/Tests/DependencyInjection/DoctrineExtensionTest.php
@@ -263,6 +263,7 @@ protected function createContainer(array $data = []): ContainerBuilder
         return new ContainerBuilder(new ParameterBag(array_merge([
             'kernel.bundles' => ['FrameworkBundle' => 'Symfony\\Bundle\\FrameworkBundle\\FrameworkBundle'],
             'kernel.cache_dir' => __DIR__,
+            'kernel.tmp_dir' => __DIR__,
             'kernel.container_class' => 'kernel',
             'kernel.project_dir' => __DIR__,
         ], $data)));
diff --git a/src/Symfony/Bundle/DebugBundle/Tests/DependencyInjection/DebugExtensionTest.php b/src/Symfony/Bundle/DebugBundle/Tests/DependencyInjection/DebugExtensionTest.php
@@ -74,6 +74,7 @@ private function createContainer()
     {
         $container = new ContainerBuilder(new ParameterBag([
             'kernel.cache_dir' => __DIR__,
+            'kernel.tmp_dir' => __DIR__,
             'kernel.charset' => 'UTF-8',
             'kernel.debug' => true,
             'kernel.bundles' => ['DebugBundle' => 'Symfony\\Bundle\\DebugBundle\\DebugBundle'],
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/AboutCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/AboutCommand.php
@@ -76,6 +76,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             ['Debug', $kernel->isDebug() ? 'true' : 'false'],
             ['Charset', $kernel->getCharset()],
             ['Cache directory', self::formatPath($kernel->getCacheDir(), $kernel->getProjectDir()).' (<comment>'.self::formatFileSize($kernel->getCacheDir()).'</>)'],
+            ['Temp directory', self::formatPath($kernel->getTmpDir(), $kernel->getTmpDir()).' (<comment>'.self::formatFileSize($kernel->getTmpDir()).'</>)'],
             ['Log directory', self::formatPath($kernel->getLogDir(), $kernel->getProjectDir()).' (<comment>'.self::formatFileSize($kernel->getLogDir()).'</>)'],
             new TableSeparator(),
             ['<info>PHP</>'],
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/CacheClearCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/CacheClearCommand.php
@@ -80,10 +80,12 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         $kernel = $this->getApplication()->getKernel();
         $realCacheDir = $kernel->getContainer()->getParameter('kernel.cache_dir');
+        $realTmpDir = $kernel->getContainer()->getParameter('kernel.tmp_dir');
         // 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).('~' === substr($realCacheDir, -1) ? '+' : '~');
-        $fs->remove($oldCacheDir);
+        $oldTmpDir = substr($realTmpDir, 0, -1).('~' === substr($realTmpDir, -1) ? '+' : '~');
+        $fs->remove([$oldCacheDir, $oldTmpDir]);
 
         if (!is_writable($realCacheDir)) {
             throw new RuntimeException(sprintf('Unable to write in the "%s" directory.', $realCacheDir));
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/CachePoolClearCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/CachePoolClearCommand.php
@@ -85,7 +85,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         foreach ($clearers as $id => $clearer) {
             $io->comment(sprintf('Calling cache clearer: <info>%s</info>', $id));
-            $clearer->clear($kernel->getContainer()->getParameter('kernel.cache_dir'));
+            $clearer->clear($kernel->getContainer()->getParameter('kernel.tmp_dir'));
         }
 
         foreach ($pools as $id => $pool) {
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -230,7 +230,7 @@ private function addProfilerSection(ArrayNodeDefinition $rootNode)
                         ->booleanNode('collect')->defaultTrue()->end()
                         ->booleanNode('only_exceptions')->defaultFalse()->end()
                         ->booleanNode('only_master_requests')->defaultFalse()->end()
-                        ->scalarNode('dsn')->defaultValue('file:%kernel.cache_dir%/profiler')->end()
+                        ->scalarNode('dsn')->defaultValue('file:%kernel.tmp_dir%/profiler')->end()
                     ->end()
                 ->end()
             ->end()
@@ -527,7 +527,7 @@ private function addSessionSection(ArrayNodeDefinition $rootNode)
                         ->scalarNode('gc_divisor')->end()
                         ->scalarNode('gc_probability')->defaultValue(1)->end()
                         ->scalarNode('gc_maxlifetime')->end()
-                        ->scalarNode('save_path')->defaultValue('%kernel.cache_dir%/sessions')->end()
+                        ->scalarNode('save_path')->defaultValue('%kernel.tmp_dir%/sessions')->end()
                         ->integerNode('metadata_update_threshold')
                             ->defaultValue(0)
                             ->info('seconds to wait between 2 session metadata updates')
@@ -881,7 +881,7 @@ private function addCacheSection(ArrayNodeDefinition $rootNode)
                             ->info('System related cache pools configuration')
                             ->defaultValue('cache.adapter.system')
                         ->end()
-                        ->scalarNode('directory')->defaultValue('%kernel.cache_dir%/pools')->end()
+                        ->scalarNode('directory')->defaultValue('%kernel.tmp_dir%/pools')->end()
                         ->scalarNode('default_doctrine_provider')->end()
                         ->scalarNode('default_psr6_provider')->end()
                         ->scalarNode('default_redis_provider')->defaultValue('redis://localhost')->end()
diff --git a/src/Symfony/Bundle/FrameworkBundle/HttpCache/HttpCache.php b/src/Symfony/Bundle/FrameworkBundle/HttpCache/HttpCache.php
@@ -74,6 +74,6 @@ protected function createSurrogate()
 
     protected function createStore()
     {
-        return new Store($this->cacheDir ?: $this->kernel->getCacheDir().'/http_cache');
+        return new Store($this->cacheDir ?: $this->kernel->getTmpDir().'/http_cache');
     }
 }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/cache.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/cache.xml
@@ -46,7 +46,7 @@
             <argument /> <!-- namespace -->
             <argument>0</argument> <!-- default lifetime -->
             <argument /> <!-- version -->
-            <argument>%kernel.cache_dir%/pools</argument>
+            <argument>%kernel.tmp_dir%/pools</argument>
             <argument type="service" id="logger" on-invalid="ignore" />
         </service>
 
@@ -77,7 +77,7 @@
             <tag name="monolog.logger" channel="cache" />
             <argument /> <!-- namespace -->
             <argument>0</argument> <!-- default lifetime -->
-            <argument>%kernel.cache_dir%/pools</argument>
+            <argument>%kernel.tmp_dir%/pools</argument>
             <argument type="service" id="cache.default_marshaller" on-invalid="ignore" />
             <call method="setLogger">
                 <argument type="service" id="logger" on-invalid="ignore" />
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/collectors.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/collectors.xml
@@ -35,7 +35,7 @@
             <tag name="data_collector" template="@WebProfiler/Collector/logger.html.twig" id="logger" priority="300" />
             <tag name="monolog.logger" channel="profiler" />
             <argument type="service" id="logger" on-invalid="ignore" />
-            <argument>%kernel.cache_dir%/%kernel.container_class%</argument>
+            <argument>%kernel.tmp_dir%/%kernel.container_class%</argument>
             <argument type="service" id="request_stack" on-invalid="ignore" />
         </service>
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/session.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/session.xml
@@ -53,7 +53,7 @@
         </service>
 
         <service id="session.storage.mock_file" class="Symfony\Component\HttpFoundation\Session\Storage\MockFileSessionStorage">
-            <argument>%kernel.cache_dir%/sessions</argument>
+            <argument>%kernel.tmp_dir%/sessions</argument>
             <argument>MOCKSESSID</argument>
             <argument type="service" id="session.storage.metadata_bag" />
         </service>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/translation.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/translation.xml
@@ -13,7 +13,7 @@
             <argument>%kernel.default_locale%</argument>
             <argument type="collection" /> <!-- translation loaders ids -->
             <argument type="collection">
-                <argument key="cache_dir">%kernel.cache_dir%/translations</argument>
+                <argument key="cache_dir">%kernel.tmp_dir%/translations</argument>
                 <argument key="debug">%kernel.debug%</argument>
             </argument>
             <argument type="collection" /> <!-- enabled locales -->
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php
@@ -362,7 +362,7 @@ protected static function getBundleDefaultConfig()
                 'enabled' => false,
                 'only_exceptions' => false,
                 'only_master_requests' => false,
-                'dsn' => 'file:%kernel.cache_dir%/profiler',
+                'dsn' => 'file:%kernel.tmp_dir%/profiler',
                 'collect' => true,
             ],
             'translator' => [
@@ -427,7 +427,7 @@ protected static function getBundleDefaultConfig()
                 'cookie_httponly' => true,
                 'cookie_samesite' => null,
                 'gc_probability' => 1,
-                'save_path' => '%kernel.cache_dir%/sessions',
+                'save_path' => '%kernel.tmp_dir%/sessions',
                 'metadata_update_threshold' => 0,
             ],
             'request' => [
@@ -448,7 +448,7 @@ protected static function getBundleDefaultConfig()
                 'pools' => [],
                 'app' => 'cache.adapter.filesystem',
                 'system' => 'cache.adapter.system',
-                'directory' => '%kernel.cache_dir%/pools',
+                'directory' => '%kernel.tmp_dir%/pools',
                 'default_redis_provider' => 'redis://localhost',
                 'default_memcached_provider' => 'memcached://localhost',
                 'default_pdo_provider' => class_exists(Connection::class) ? 'database_connection' : null,
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
@@ -1457,6 +1457,7 @@ protected function createContainer(array $data = [])
             'kernel.bundles' => ['FrameworkBundle' => 'Symfony\\Bundle\\FrameworkBundle\\FrameworkBundle'],
             'kernel.bundles_metadata' => ['FrameworkBundle' => ['namespace' => 'Symfony\\Bundle\\FrameworkBundle', 'path' => __DIR__.'/../..']],
             'kernel.cache_dir' => __DIR__,
+            'kernel.tmp_dir' => __DIR__,
             'kernel.project_dir' => __DIR__,
             'kernel.debug' => false,
             'kernel.environment' => 'test',
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/CachePoolsTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/CachePoolsTest.php
@@ -90,7 +90,7 @@ private function doTestCachePools($options, $adapterClass)
         $pool2 = $container->get('cache.pool2');
         $pool2->save($item);
 
-        $container->get('cache_clearer')->clear($container->getParameter('kernel.cache_dir'));
+        $container->get('cache_clearer')->clear($container->getParameter('kernel.tmp_dir'));
         $item = $pool1->getItem($key);
         $this->assertFalse($item->isHit());
 
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/DependencyInjection/Compiler/AddSessionDomainConstraintPassTest.php b/src/Symfony/Bundle/SecurityBundle/Tests/DependencyInjection/Compiler/AddSessionDomainConstraintPassTest.php
@@ -125,6 +125,7 @@ private function createContainer($sessionStorageOptions)
         $container = new ContainerBuilder();
         $container->setParameter('kernel.bundles_metadata', []);
         $container->setParameter('kernel.cache_dir', __DIR__);
+        $container->setParameter('kernel.tmp_dir', __DIR__);
         $container->setParameter('kernel.charset', 'UTF-8');
         $container->setParameter('kernel.container_class', 'cc');
         $container->setParameter('kernel.debug', true);
diff --git a/src/Symfony/Bundle/WebProfilerBundle/Tests/DependencyInjection/WebProfilerExtensionTest.php b/src/Symfony/Bundle/WebProfilerBundle/Tests/DependencyInjection/WebProfilerExtensionTest.php
@@ -62,6 +62,7 @@ protected function setUp(): void
         $this->container->register('twig', 'Twig\Environment')->addArgument(new Reference('twig_loader'))->setPublic(true);
         $this->container->setParameter('kernel.bundles', []);
         $this->container->setParameter('kernel.cache_dir', __DIR__);
+        $this->container->setParameter('kernel.tmp_dir', __DIR__);
         $this->container->setParameter('kernel.debug', false);
         $this->container->setParameter('kernel.project_dir', __DIR__);
         $this->container->setParameter('kernel.charset', 'UTF-8');
diff --git a/src/Symfony/Component/HttpKernel/Kernel.php b/src/Symfony/Component/HttpKernel/Kernel.php
@@ -333,6 +333,15 @@ public function getCacheDir()
         return $this->getProjectDir().'/var/cache/'.$this->environment;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function getTmpDir()
+    {
+        // Returns $this->getCacheDir() for backward compatibility
+        return $this->getCacheDir();
+    }
+
     /**
      * {@inheritdoc}
      */
@@ -595,6 +604,7 @@ protected function getKernelParameters()
             'kernel.environment' => $this->environment,
             'kernel.debug' => $this->debug,
             'kernel.cache_dir' => realpath($cacheDir = $this->warmupDir ?: $this->getCacheDir()) ?: $cacheDir,
+            'kernel.tmp_dir' => realpath($this->getTmpDir()) ?: $this->getTmpDir(),
             'kernel.logs_dir' => realpath($this->getLogDir()) ?: $this->getLogDir(),
             'kernel.bundles' => $bundles,
             'kernel.bundles_metadata' => $bundlesMetadata,
diff --git a/src/Symfony/Component/HttpKernel/KernelInterface.php b/src/Symfony/Component/HttpKernel/KernelInterface.php
@@ -125,6 +125,13 @@ public function getStartTime();
      */
     public function getCacheDir();
 
+    /**
+     * Gets the temporary directory.
+     *
+     * @return string The temporary directory
+     */
+    public function getTmpDir();
+
     /**
      * Gets the log directory.
      *

Original file line number	Diff line number	Diff line change
`@@ -74,6 +74,7 @@ private function createContainer()`
`74`	`74`	`{`
`75`	`75`	`$container = new ContainerBuilder(new ParameterBag([`
`76`	`76`	`'kernel.cache_dir' => __DIR__,`
	`77`	`+ 'kernel.tmp_dir' => __DIR__,`
`77`	`78`	`'kernel.charset' => 'UTF-8',`
`78`	`79`	`'kernel.debug' => true,`
`79`	`80`	`'kernel.bundles' => ['DebugBundle' => 'Symfony\\Bundle\\DebugBundle\\DebugBundle'],`
Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int`
`85`	`85`
`86`	`86`	`foreach ($clearers as $id => $clearer) {`
`87`	`87`	`$io->comment(sprintf('Calling cache clearer: <info>%s</info>', $id));`
`88`		`- $clearer->clear($kernel->getContainer()->getParameter('kernel.cache_dir'));`
	`88`	`+ $clearer->clear($kernel->getContainer()->getParameter('kernel.tmp_dir'));`
`89`	`89`	`}`
`90`	`90`
`91`	`91`	`foreach ($pools as $id => $pool) {`
Original file line number	Diff line number	Diff line change
`@@ -74,6 +74,6 @@ protected function createSurrogate()`
`74`	`74`
`75`	`75`	`protected function createStore()`
`76`	`76`	`{`
`77`		`- return new Store($this->cacheDir ?: $this->kernel->getCacheDir().'/http_cache');`
	`77`	`+ return new Store($this->cacheDir ?: $this->kernel->getTmpDir().'/http_cache');`
`78`	`78`	`}`
`79`	`79`	`}`