[HttpFoundation][Cache] Added MarshallingSessionHandler

atailouloute · atailouloute · commit 45f08b1d06b9 · 2020-02-20T18:38:34.000+01:00
diff --git a/src/Symfony/Component/Cache/CHANGELOG.md b/src/Symfony/Component/Cache/CHANGELOG.md
@@ -6,6 +6,7 @@ CHANGELOG
 
  * added max-items + LRU + max-lifetime capabilities to `ArrayCache`
  * added `CouchbaseBucketAdapter`
+ * added `IdentityMarshaller`
 
 5.0.0
 -----
diff --git a/src/Symfony/Component/Cache/Marshaller/IdentityMarshaller.php b/src/Symfony/Component/Cache/Marshaller/IdentityMarshaller.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\Marshaller;
+
+/**
+ * @author Ahmed TAILOULOUTE <ahmed.tailouloute@gmail.com>
+ */
+class IdentityMarshaller implements MarshallerInterface
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function marshall(array $values, ?array &$failed): array
+    {
+        foreach ($values as $key => $value) {
+            if (!\is_string($value)) {
+                throw new \RuntimeException(sprintf('%s accepts only string as data.', __METHOD__));
+            }
+        }
+
+        return $values;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function unmarshall(string $value)
+    {
+        return $value;
+    }
+}
diff --git a/src/Symfony/Component/HttpFoundation/CHANGELOG.md b/src/Symfony/Component/HttpFoundation/CHANGELOG.md
@@ -23,6 +23,7 @@ CHANGELOG
  * made `Request::getSession()` throw if the session has not been set before
  * removed `Response::HTTP_RESERVED_FOR_WEBDAV_ADVANCED_COLLECTIONS_EXPIRED_PROPOSAL`
  * passing a null url when instantiating a `RedirectResponse` is not allowed
+ * added `MarshallingSessionHandler`
 
 4.4.0
 -----
diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MarshallingSessionHandler.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MarshallingSessionHandler.php
@@ -0,0 +1,101 @@
+<?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\HttpFoundation\Session\Storage\Handler;
+
+use Symfony\Component\Cache\Marshaller\IdentityMarshaller;
+use Symfony\Component\Cache\Marshaller\MarshallerInterface;
+
+/**
+ * @author Ahmed TAILOULOUTE <ahmed.tailouloute@gmail.com>
+ */
+class MarshallingSessionHandler implements \SessionHandlerInterface, \SessionUpdateTimestampHandlerInterface
+{
+    private $handler;
+    private $marshaller;
+
+    public function __construct(AbstractSessionHandler $handler, MarshallerInterface $marshaller = null)
+    {
+        $this->handler = $handler;
+        $this->marshaller = $marshaller ?? new IdentityMarshaller();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function close()
+    {
+        return $this->handler->close();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function destroy($sessionId)
+    {
+        return $this->handler->destroy($sessionId);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function gc($maxlifetime)
+    {
+        return $this->handler->gc($maxlifetime);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function open($savePath, $name)
+    {
+        return $this->handler->open($savePath, $name);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function read($sessionId)
+    {
+        return $this->marshaller->unmarshall($this->handler->read($sessionId));
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function write($sessionId, $data)
+    {
+        $failed = [];
+        $marshalledData = $this->marshaller->marshall(['data' => $data], $failed);
+
+        if (!isset($failed['data'])) {
+            $data = $marshalledData['data'];
+        }
+
+        return $this->handler->write($sessionId, $data);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function validateId($sessionId)
+    {
+        return $this->handler->validateId($sessionId);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function updateTimestamp($sessionId, $data)
+    {
+        return $this->handler->updateTimestamp($sessionId, $data);
+    }
+}
