symfony · palex-fpt · Jun 1, 2018
diff --git a/src/Symfony/Component/Cache/Adapter/ArrayAdapter.php b/src/Symfony/Component/Cache/Adapter/ArrayAdapter.php
@@ -15,6 +15,8 @@
 use Psr\Log\LoggerAwareInterface;
 use Symfony\Component\Cache\CacheInterface;
 use Symfony\Component\Cache\CacheItem;
+use Symfony\Component\Cache\Serializer\IdentitySerializer;
+use Symfony\Component\Cache\Serializer\PhpSerializer;
 use Symfony\Component\Cache\ResettableInterface;
 use Symfony\Component\Cache\Traits\ArrayTrait;
 use Symfony\Component\Cache\Traits\GetTrait;
@@ -35,7 +37,7 @@ class ArrayAdapter implements AdapterInterface, CacheInterface, LoggerAwareInter
      */
     public function __construct(int $defaultLifetime = 0, bool $storeSerialized = true)
     {
-        $this->storeSerialized = $storeSerialized;
+        $this->setSerializer($storeSerialized ? new PhpSerializer() : new IdentitySerializer());
         $this->createCacheItem = \Closure::bind(
             function ($key, $value, $isHit) use ($defaultLifetime) {
                 $item = new CacheItem();
@@ -60,13 +62,8 @@ public function getItem($key)
         try {
             if (!$isHit) {
                 $this->values[$key] = $value = null;
-            } elseif (!$this->storeSerialized) {
-                $value = $this->values[$key];
-            } elseif ('b:0;' === $value = $this->values[$key]) {
-                $value = false;
-            } elseif (false === $value = unserialize($value)) {
-                $this->values[$key] = $value = null;
-                $isHit = false;
+            } else {
+                $value = $this->unserialize($this->values[$key]);
             }
         } catch (\Exception $e) {
             CacheItem::log($this->logger, 'Failed to unserialize key "{key}"', array('key' => $key, 'exception' => $e));
@@ -120,15 +117,13 @@ public function save(CacheItemInterface $item)
 
             return true;
         }
-        if ($this->storeSerialized) {
-            try {
-                $value = serialize($value);
-            } catch (\Exception $e) {
-                $type = is_object($value) ? get_class($value) : gettype($value);
-                CacheItem::log($this->logger, 'Failed to save key "{key}" ({type})', array('key' => $key, 'type' => $type, 'exception' => $e));
-
-                return false;
-            }
+        try {
+            $value = $this->serialize($value);
+        } catch (\Exception $e) {
+            $type = is_object($value) ? get_class($value) : gettype($value);
+            CacheItem::log($this->logger, 'Failed to save key "{key}" ({type})', array('key' => $key, 'type' => $type, 'exception' => $e));
+
+            return false;
         }
         if (null === $expiry && 0 < $item["\0*\0defaultLifetime"]) {
             $expiry = microtime(true) + $item["\0*\0defaultLifetime"];

diff --git a/src/Symfony/Component/Cache/Serializer/IdentitySerializer.php b/src/Symfony/Component/Cache/Serializer/IdentitySerializer.php
@@ -0,0 +1,27 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Cache\Serializer;
+
+use Symfony\Component\Cache\SerializerInterface;
+
+class IdentitySerializer implements SerializerInterface
+{
+    public function serialize($data)
+    {
+        return $data;
+    }
+
+    public function unserialize($serialized)
+    {
+        return $serialized;
+    }
+}
diff --git a/src/Symfony/Component/Cache/Serializer/IgbinarySerializer.php b/src/Symfony/Component/Cache/Serializer/IgbinarySerializer.php
@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Cache\Serializer;
+
+use Symfony\Component\Cache\Exception\CacheException;
+use Symfony\Component\Cache\SerializerInterface;
+
+class IgbinarySerializer implements SerializerInterface
+{
+    public function serialize($data)
+    {
+        return igbinary_serialize($data);
+    }
+
+    public function unserialize($serialized)
+    {
+        $unserializeCallbackHandler = ini_set(
+            'unserialize_callback_func',
+            PhpSerializer::class.'::handleUnserializeCallback'
+        );
+        try {
+            $value = igbinary_unserialize($serialized);
+            if (false === $value && igbinary_serialize(false) !== $serialized) {
+                throw new CacheException('failed to unserialize value');
+            }
+
+            return $value;
+        } catch (\Error $e) {
+            throw new \ErrorException($e->getMessage(), $e->getCode(), E_ERROR, $e->getFile(), $e->getLine());
+        } finally {
+            ini_set('unserialize_callback_func', $unserializeCallbackHandler);
+        }
+    }
+}
diff --git a/src/Symfony/Component/Cache/Serializer/PhpSerializer.php b/src/Symfony/Component/Cache/Serializer/PhpSerializer.php
@@ -0,0 +1,49 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Cache\Serializer;
+
+use Symfony\Component\Cache\Exception\CacheException;
+use Symfony\Component\Cache\SerializerInterface;
+
+class PhpSerializer implements SerializerInterface
+{
+    public function serialize($data)
+    {
+        return serialize($data);
+    }
+
+    public function unserialize($serialized)
+    {
+        $unserializeCallbackHandler = ini_set('unserialize_callback_func', __CLASS__.'::handleUnserializeCallback');
+        try {
+            if ('b:0;' === $serialized) {
+                return false;
+            } elseif (false === $value = unserialize($serialized)) {
+                throw new CacheException('failed to unserialize value');
+            }
+
+            return $value;
+        } catch (\Error $e) {
+            throw new \ErrorException($e->getMessage(), $e->getCode(), E_ERROR, $e->getFile(), $e->getLine());
+        } finally {
+            ini_set('unserialize_callback_func', $unserializeCallbackHandler);
+        }
+    }
+
+    /**
+     * @internal
+     */
+    public static function handleUnserializeCallback($class)
+    {
+        throw new \DomainException('Class not found: '.$class);
+    }
+}
diff --git a/src/Symfony/Component/Cache/SerializerInterface.php b/src/Symfony/Component/Cache/SerializerInterface.php
@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Cache;
+
+use Symfony\Component\Cache\Exception\InvalidArgumentException;
+
+/**
+ * @author Alexei Prilipko <palex.fpt@gmail.com>
+ */
+interface SerializerInterface
+{
+    /**
+     * Generates a storable representation of a value.
+     *
+     * @param $data mixed
+     *
+     * @return string|mixed serialized value
+     *
+     * @throws InvalidArgumentException when $data can not be serialized
+     */
+    public function serialize($data);
+
    /**
+     * Creates a PHP value from a stored representation.
+     *
+     * @param string|mixed $serialized the serialized string
+     *
+     * @return mixed Original value
+     */
+    public function unserialize($serialized);
+}
diff --git a/src/Symfony/Component/Cache/Simple/ArrayCache.php b/src/Symfony/Component/Cache/Simple/ArrayCache.php
@@ -15,6 +15,8 @@
 use Psr\SimpleCache\CacheInterface;
 use Symfony\Component\Cache\CacheItem;
 use Symfony\Component\Cache\Exception\InvalidArgumentException;
+use Symfony\Component\Cache\Serializer\IdentitySerializer;
+use Symfony\Component\Cache\Serializer\PhpSerializer;
 use Symfony\Component\Cache\ResettableInterface;
 use Symfony\Component\Cache\Traits\ArrayTrait;
 
@@ -37,7 +39,7 @@ class ArrayCache implements CacheInterface, LoggerAwareInterface, ResettableInte
     public function __construct(int $defaultLifetime = 0, bool $storeSerialized = true)
     {
         $this->defaultLifetime = $defaultLifetime;
-        $this->storeSerialized = $storeSerialized;
+        $this->setSerializer($storeSerialized ? new PhpSerializer() : new IdentitySerializer());
     }
 
     /**
@@ -109,16 +111,14 @@ public function setMultiple($values, $ttl = null)
         if (false === $ttl = $this->normalizeTtl($ttl)) {
             return $this->deleteMultiple(array_keys($valuesArray));
         }
-        if ($this->storeSerialized) {
-            foreach ($valuesArray as $key => $value) {
-                try {
-                    $valuesArray[$key] = serialize($value);
-                } catch (\Exception $e) {
-                    $type = is_object($value) ? get_class($value) : gettype($value);
-                    CacheItem::log($this->logger, 'Failed to save key "{key}" ({type})', array('key' => $key, 'type' => $type, 'exception' => $e));
-
-                    return false;
-                }
+        foreach ($valuesArray as $key => $value) {
+            try {
+                $valuesArray[$key] = $this->serialize($value);
+            } catch (\Exception $e) {
+                $type = is_object($value) ? get_class($value) : gettype($value);
+                CacheItem::log($this->logger, 'Failed to save key "{key}" ({type})', array('key' => $key, 'type' => $type, 'exception' => $e));
+
+                return false;
             }
         }
         $expiry = 0 < $ttl ? microtime(true) + $ttl : PHP_INT_MAX;

diff --git a/src/Symfony/Component/Cache/Tests/Serializer/IgbinarySerializerTest.php b/src/Symfony/Component/Cache/Tests/Serializer/IgbinarySerializerTest.php
@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Cache\Tests\Serializer;
+
+use Symfony\Component\Cache\Serializer\IgbinarySerializer;
+use Symfony\Component\Cache\SerializerInterface;
+
+class IgbinarySerializerTest extends SerializerTest
+{
+    public static function setUpBeforeClass()
+    {
+        parent::setUpBeforeClass();
+        if (!extension_loaded('igbinary')) {
+            self::markTestSkipped('Extension igbinary is not loaded.');
+        }
+    }
+
+    protected function createSerializer(): SerializerInterface
+    {
+        return new IgbinarySerializer();
+    }
+}
diff --git a/src/Symfony/Component/Cache/Tests/Serializer/PhpSerializerTest.php b/src/Symfony/Component/Cache/Tests/Serializer/PhpSerializerTest.php
@@ -0,0 +1,23 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Cache\Tests\Serializer;
+
+use Symfony\Component\Cache\Serializer\PhpSerializer;
+use Symfony\Component\Cache\SerializerInterface;
+
+class PhpSerializerTest extends SerializerTest
+{
+    protected function createSerializer(): SerializerInterface
+    {
+        return new PhpSerializer();
+    }
+}
diff --git a/src/Symfony/Component/Cache/Tests/Serializer/SerializerTest.php b/src/Symfony/Component/Cache/Tests/Serializer/SerializerTest.php
@@ -0,0 +1,72 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Cache\Tests\Serializer;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Cache\SerializerInterface;
+
+abstract class SerializerTest extends TestCase
+{
+    /** @var SerializerInterface */
+    private $serializer;
+
+    protected function setUp()
+    {
+        parent::setUp();
+
+        $this->serializer = $this->createSerializer();
+    }
+
+    abstract protected function createSerializer(): SerializerInterface;
+
+    /**
+     * @dataProvider validData
+     */
+    public function testSerializeInvariants($value)
+    {
+        $serialized = $this->serializer->serialize($value);
+        $restored = $this->serializer->unserialize($serialized);
+        $this->assertEquals($value, $restored);
+    }
+
+    /**
+     * Data provider for valid data to store.
+     *
+     * @return array
+     */
+    public static function validData()
+    {
+        return array(
+            array(false),
+            array('AbC19_.'),
+            array(4711),
+            array(47.11),
+            array(true),
+            array(null),
+            array(array('key' => 'value')),
+            array(new \stdClass()),
+        );
+    }
+}
+
+class NotUnserializable implements \Serializable
+{
+    public function serialize()
+    {
+        return serialize(123);
+    }
+
+    public function unserialize($ser)
+    {
+        throw new \Exception(__CLASS__);
+    }
+}