[Cache] Unconditionally use PhpFilesAdapter for system pools

nicolas-grekas · nicolas-grekas · commit cc1edab13ad4 · 2018-06-08T13:08:56.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -1538,7 +1538,6 @@ private function registerCacheConfiguration(array $config, ContainerBuilder $con
     {
         $version = new Parameter('container.build_id');
         $container->getDefinition('cache.adapter.apcu')->replaceArgument(2, $version);
-        $container->getDefinition('cache.adapter.system')->replaceArgument(2, $version);
         $container->getDefinition('cache.adapter.filesystem')->replaceArgument(2, $config['directory']);
 
         if (isset($config['prefix_seed'])) {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/cache.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/cache.xml
@@ -35,15 +35,15 @@
             <tag name="cache.pool" />
         </service>
 
-        <service id="cache.adapter.system" class="Symfony\Component\Cache\Adapter\AdapterInterface" abstract="true">
-            <factory class="Symfony\Component\Cache\Adapter\AbstractAdapter" method="createSystemCache" />
+        <service id="cache.adapter.system" class="Symfony\Component\Cache\Adapter\PhpFilesAdapter" abstract="true">
             <tag name="cache.pool" clearer="cache.system_clearer" />
             <tag name="monolog.logger" channel="cache" />
             <argument /> <!-- namespace -->
             <argument>0</argument> <!-- default lifetime -->
-            <argument /> <!-- version -->
             <argument>%kernel.cache_dir%/pools</argument>
-            <argument type="service" id="logger" on-invalid="ignore" />
+            <call method="setLogger">
+                <argument type="service" id="logger" on-invalid="ignore" />
+            </call>
         </service>
 
         <service id="cache.adapter.apcu" class="Symfony\Component\Cache\Adapter\ApcuAdapter" abstract="true">
diff --git a/src/Symfony/Component/Cache/Adapter/AbstractAdapter.php b/src/Symfony/Component/Cache/Adapter/AbstractAdapter.php
@@ -87,9 +87,13 @@ function ($deferred, $namespace, &$expiredIds) use ($getId) {
      * @param LoggerInterface|null $logger
      *
      * @return AdapterInterface
+     *
+     * @deprecated since Symfony 4.2.
      */
     public static function createSystemCache($namespace, $defaultLifetime, $version, $directory, LoggerInterface $logger = null)
     {
+        @trigger_error(sprintf('The "%s()" method is deprecated since Symfony 4.2.', __CLASS__), E_USER_DEPRECATED);
+
         if (null === self::$apcuSupported) {
             self::$apcuSupported = ApcuAdapter::isSupported();
         }
diff --git a/src/Symfony/Component/Cache/Adapter/FilesystemAdapter.php b/src/Symfony/Component/Cache/Adapter/FilesystemAdapter.php
@@ -12,9 +12,10 @@
 namespace Symfony\Component\Cache\Adapter;
 
 use Symfony\Component\Cache\PruneableInterface;
+use Symfony\Component\Cache\ResettableInterface;
 use Symfony\Component\Cache\Traits\FilesystemTrait;
 
-class FilesystemAdapter extends AbstractAdapter implements PruneableInterface
+class FilesystemAdapter extends AbstractAdapter implements PruneableInterface, ResettableInterface
 {
     use FilesystemTrait;
 
diff --git a/src/Symfony/Component/Cache/Adapter/PhpFilesAdapter.php b/src/Symfony/Component/Cache/Adapter/PhpFilesAdapter.php
@@ -13,9 +13,10 @@
 
 use Symfony\Component\Cache\Exception\CacheException;
 use Symfony\Component\Cache\PruneableInterface;
+use Symfony\Component\Cache\ResettableInterface;
 use Symfony\Component\Cache\Traits\PhpFilesTrait;
 
-class PhpFilesAdapter extends AbstractAdapter implements PruneableInterface
+class PhpFilesAdapter extends AbstractAdapter implements PruneableInterface, ResettableInterface
 {
     use PhpFilesTrait;
 
@@ -24,9 +25,7 @@ class PhpFilesAdapter extends AbstractAdapter implements PruneableInterface
      */
     public function __construct(string $namespace = '', int $defaultLifetime = 0, string $directory = null)
     {
-        if (!static::isSupported()) {
-            throw new CacheException('OPcache is not enabled');
-        }
+        self::$startTime = self::$startTime ?? $_SERVER['REQUEST_TIME'] ?? time();
         parent::__construct('', $defaultLifetime);
         $this->init($namespace, $directory);
 
diff --git a/src/Symfony/Component/Cache/CHANGELOG.md b/src/Symfony/Component/Cache/CHANGELOG.md
@@ -6,6 +6,7 @@ CHANGELOG
 
  * added `CacheInterface`, which should become the preferred way to use a cache
  * throw `LogicException` when `CacheItem::tag()` is called on an item coming from a non tag-aware pool
+ * deprecated the `AbstractAdapter::createSystemCache()` method
 
 3.4.0
 -----
diff --git a/src/Symfony/Component/Cache/Simple/FilesystemCache.php b/src/Symfony/Component/Cache/Simple/FilesystemCache.php
@@ -12,9 +12,10 @@
 namespace Symfony\Component\Cache\Simple;
 
 use Symfony\Component\Cache\PruneableInterface;
+use Symfony\Component\Cache\ResettableInterface;
 use Symfony\Component\Cache\Traits\FilesystemTrait;
 
-class FilesystemCache extends AbstractCache implements PruneableInterface
+class FilesystemCache extends AbstractCache implements PruneableInterface, ResettableInterface
 {
     use FilesystemTrait;
 
diff --git a/src/Symfony/Component/Cache/Simple/PhpFilesCache.php b/src/Symfony/Component/Cache/Simple/PhpFilesCache.php
@@ -13,9 +13,10 @@
 
 use Symfony\Component\Cache\Exception\CacheException;
 use Symfony\Component\Cache\PruneableInterface;
+use Symfony\Component\Cache\ResettableInterface;
 use Symfony\Component\Cache\Traits\PhpFilesTrait;
 
-class PhpFilesCache extends AbstractCache implements PruneableInterface
+class PhpFilesCache extends AbstractCache implements PruneableInterface, ResettableInterface
 {
     use PhpFilesTrait;
 
@@ -24,9 +25,7 @@ class PhpFilesCache extends AbstractCache implements PruneableInterface
      */
     public function __construct(string $namespace = '', int $defaultLifetime = 0, string $directory = null)
     {
-        if (!static::isSupported()) {
-            throw new CacheException('OPcache is not enabled');
-        }
+        self::$startTime = self::$startTime ?? $_SERVER['REQUEST_TIME'] ?? time();
         parent::__construct('', $defaultLifetime);
         $this->init($namespace, $directory);
 
diff --git a/src/Symfony/Component/Cache/Tests/Adapter/PhpFilesAdapterTest.php b/src/Symfony/Component/Cache/Tests/Adapter/PhpFilesAdapterTest.php
@@ -25,10 +25,6 @@ class PhpFilesAdapterTest extends AdapterTestCase
 
     public function createCachePool()
     {
-        if (!PhpFilesAdapter::isSupported()) {
-            $this->markTestSkipped('OPcache extension is not enabled.');
-        }
-
         return new PhpFilesAdapter('sf-cache');
     }
 
diff --git a/src/Symfony/Component/Cache/Tests/Simple/PhpFilesCacheTest.php b/src/Symfony/Component/Cache/Tests/Simple/PhpFilesCacheTest.php
@@ -25,10 +25,6 @@ class PhpFilesCacheTest extends CacheTestCase
 
     public function createSimpleCache()
     {
-        if (!PhpFilesCache::isSupported()) {
-            $this->markTestSkipped('OPcache extension is not enabled.');
-        }
-
         return new PhpFilesCache('sf-cache');
     }
 
diff --git a/src/Symfony/Component/Cache/Traits/FilesystemCommonTrait.php b/src/Symfony/Component/Cache/Traits/FilesystemCommonTrait.php
@@ -22,6 +22,7 @@ trait FilesystemCommonTrait
 {
     private $directory;
     private $tmp;
+    private $hashes;
 
     private function init($namespace, $directory)
     {
@@ -56,7 +57,7 @@ protected function doClear($namespace)
         $ok = true;
 
         foreach (new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($this->directory, \FilesystemIterator::SKIP_DOTS)) as $file) {
-            $ok = ($file->isDir() || @unlink($file) || !file_exists($file)) && $ok;
+            $ok = ($file->isDir() || $this->doUnlink($file) || !file_exists($file)) && $ok;
         }
 
         return $ok;
@@ -71,7 +72,7 @@ protected function doDelete(array $ids)
 
         foreach ($ids as $id) {
             $file = $this->getFile($id);
-            $ok = (!file_exists($file) || @unlink($file) || !file_exists($file)) && $ok;
+            $ok = (!file_exists($file) || $this->doUnlink($file) || !file_exists($file)) && $ok;
         }
 
         return $ok;
@@ -98,14 +99,17 @@ private function write($file, $data, $expiresAt = null)
 
     private function getFile($id, $mkdir = false)
     {
-        $hash = str_replace('/', '-', base64_encode(hash('sha256', static::class.$id, true)));
-        $dir = $this->directory.strtoupper($hash[0].DIRECTORY_SEPARATOR.$hash[1].DIRECTORY_SEPARATOR);
+        if (!$hash = $this->hashes[$id] ?? null) {
+            $hash = str_replace('/', '-', base64_encode(hash('md5', static::class.$id, true)));
+            $hash = strtoupper($hash[0].DIRECTORY_SEPARATOR.$hash[1].DIRECTORY_SEPARATOR).substr($hash, 2, 20);
+            $this->hashes[$id] = $hash;
+        }
 
-        if ($mkdir && !file_exists($dir)) {
+        if ($mkdir && !file_exists($dir = $this->directory.dirname($hash))) {
             @mkdir($dir, 0777, true);
         }
 
-        return $dir.substr($hash, 2, 20);
+        return $this->directory.$hash;
     }
 
     /**
@@ -122,7 +126,20 @@ public function __destruct()
             parent::__destruct();
         }
         if (null !== $this->tmp && file_exists($this->tmp)) {
-            unlink($this->tmp);
+            $this->doUnlink($this->tmp);
         }
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function reset()
+    {
+        $this->hashes = array();
+    }
+
+    protected function doUnlink($file)
+    {
+        return @unlink($file);
+    }
 }
diff --git a/src/Symfony/Component/Cache/Traits/PhpFilesTrait.php b/src/Symfony/Component/Cache/Traits/PhpFilesTrait.php
@@ -28,9 +28,13 @@ trait PhpFilesTrait
     private $includeHandler;
     private $zendDetectUnicode;
 
+    private static $startTime;
+
     public static function isSupported()
     {
-        return function_exists('opcache_invalidate') && ini_get('opcache.enable');
+        self::$startTime = self::$startTime ?? $_SERVER['REQUEST_TIME'] ?? time();
+
+        return \function_exists('opcache_invalidate') && ini_get('opcache.enable') && ('cli' !== \PHP_SAPI || ini_get('opcache.enable_cli'));
     }
 
     /**
@@ -40,7 +44,7 @@ public function prune()
     {
         $time = time();
         $pruned = true;
-        $allowCompile = 'cli' !== PHP_SAPI || ini_get('opcache.enable_cli');
+        $allowCompile = self::isSupported();
 
         set_error_handler($this->includeHandler);
         try {
@@ -119,7 +123,7 @@ protected function doSave(array $values, $lifetime)
     {
         $ok = true;
         $data = array($lifetime ? time() + $lifetime : PHP_INT_MAX, '');
-        $allowCompile = 'cli' !== PHP_SAPI || ini_get('opcache.enable_cli');
+        $allowCompile = self::isSupported();
 
         foreach ($values as $key => $value) {
             if (null === $value || \is_object($value)) {
@@ -142,7 +146,8 @@ protected function doSave(array $values, $lifetime)
 
             $data[1] = $value;
             $file = $this->getFile($key, true);
-            $ok = $this->write($file, '<?php return '.var_export($data, true).';') && $ok;
+            // Since OPcache only compiles files older than the script execution start, set the file's mtime in the past
+            $ok = $this->write($file, '<?php return '.var_export($data, true).';', self::$startTime - 10) && $ok;
 
             if ($allowCompile) {
                 @opcache_invalidate($file, true);
@@ -155,4 +160,13 @@ protected function doSave(array $values, $lifetime)
 
         return $ok;
     }
+
+    protected function doUnlink($file)
+    {
+        if (self::isSupported()) {
+            @opcache_invalidate($file, true);
+        }
+
+        return @unlink($file);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -1538,7 +1538,6 @@ private function registerCacheConfiguration(array $config, ContainerBuilder $con`
`1538`	`1538`	`{`
`1539`	`1539`	`$version = new Parameter('container.build_id');`
`1540`	`1540`	`$container->getDefinition('cache.adapter.apcu')->replaceArgument(2, $version);`
`1541`		`- $container->getDefinition('cache.adapter.system')->replaceArgument(2, $version);`
`1542`	`1541`	`$container->getDefinition('cache.adapter.filesystem')->replaceArgument(2, $config['directory']);`
`1543`	`1542`
`1544`	`1543`	`if (isset($config['prefix_seed'])) {`
Original file line number	Diff line number	Diff line change
`@@ -87,9 +87,13 @@ function ($deferred, $namespace, &$expiredIds) use ($getId) {`
`87`	`87`	`* @param LoggerInterface\|null $logger`
`88`	`88`	`*`
`89`	`89`	`* @return AdapterInterface`
	`90`	`+ *`
	`91`	`+ * @deprecated since Symfony 4.2.`
`90`	`92`	`*/`
`91`	`93`	`public static function createSystemCache($namespace, $defaultLifetime, $version, $directory, LoggerInterface $logger = null)`
`92`	`94`	`{`
	`95`	`+ @trigger_error(sprintf('The "%s()" method is deprecated since Symfony 4.2.', __CLASS__), E_USER_DEPRECATED);`
	`96`	`+`
`93`	`97`	`if (null === self::$apcuSupported) {`
`94`	`98`	`self::$apcuSupported = ApcuAdapter::isSupported();`
`95`	`99`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,9 +12,10 @@`
`12`	`12`	`namespace Symfony\Component\Cache\Adapter;`
`13`	`13`
`14`	`14`	`use Symfony\Component\Cache\PruneableInterface;`
	`15`	`+use Symfony\Component\Cache\ResettableInterface;`
`15`	`16`	`use Symfony\Component\Cache\Traits\FilesystemTrait;`
`16`	`17`
`17`		`-class FilesystemAdapter extends AbstractAdapter implements PruneableInterface`
	`18`	`+class FilesystemAdapter extends AbstractAdapter implements PruneableInterface, ResettableInterface`
`18`	`19`	`{`
`19`	`20`	`use FilesystemTrait;`
`20`	`21`
Original file line number	Diff line number	Diff line change
`@@ -25,10 +25,6 @@ class PhpFilesAdapterTest extends AdapterTestCase`
`25`	`25`
`26`	`26`	`public function createCachePool()`
`27`	`27`	`{`
`28`		`- if (!PhpFilesAdapter::isSupported()) {`
`29`		`- $this->markTestSkipped('OPcache extension is not enabled.');`
`30`		`- }`
`31`		`-`
`32`	`28`	`return new PhpFilesAdapter('sf-cache');`
`33`	`29`	`}`
`34`	`30`
Original file line number	Diff line number	Diff line change
`@@ -25,10 +25,6 @@ class PhpFilesCacheTest extends CacheTestCase`
`25`	`25`
`26`	`26`	`public function createSimpleCache()`
`27`	`27`	`{`
`28`		`- if (!PhpFilesCache::isSupported()) {`
`29`		`- $this->markTestSkipped('OPcache extension is not enabled.');`
`30`		`- }`
`31`		`-`
`32`	`28`	`return new PhpFilesCache('sf-cache');`
`33`	`29`	`}`
`34`	`30`