[HttpFoundation] Add Psr6SessionHandler

atailouloute · atailouloute · commit ec321140a813 · 2020-02-20T14:43:56.000+01:00
diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/Psr6SessionHandler.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/Psr6SessionHandler.php
@@ -17,8 +17,9 @@
  * Session handler that supports a PSR6 cache implementation.
  *
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ * @author Ahmed TAILOULOUTE <ahmed.tailouloute@gmail.com>
  */
-class Psr6SessionHandler implements \SessionHandlerInterface
+class Psr6SessionHandler extends AbstractSessionHandler
 {
     /**
      * @var CacheItemPoolInterface
@@ -31,7 +32,7 @@ class Psr6SessionHandler implements \SessionHandlerInterface
     private $ttl;
 
     /**
-     * @var string Key prefix for shared environments.
+     * @var string Key prefix for shared environments
      */
     private $prefix;
 
@@ -43,61 +44,54 @@ class Psr6SessionHandler implements \SessionHandlerInterface
      * @param CacheItemPoolInterface $cache   A Cache instance
      * @param array                  $options An associative array of cache options
      */
-    public function __construct(CacheItemPoolInterface $cache, array $options = array())
+    public function __construct(CacheItemPoolInterface $cache, array $options = [])
     {
         $this->cache = $cache;
 
-        $this->ttl = isset($options['ttl']) ? (int) $options['ttl'] : 86400;
-        $this->prefix = isset($options['prefix']) ? $options['prefix'] : 'sfPsr6sess_';
-    }
+        if ($diff = array_diff(array_keys($options), ['prefix', 'ttl'])) {
+            throw new \InvalidArgumentException(sprintf('The following options are not supported "%s"', implode(', ', $diff)));
+        }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function open($savePath, $sessionName)
-    {
-        return true;
+        $this->ttl = $options['ttl'] ?? null;
+        $this->prefix = $options['prefix'] ?? 'sf_s';
     }
 
     /**
      * {@inheritdoc}
      */
-    public function close()
+    protected function doRead(string $sessionId)
     {
-        return true;
+        $item = $this->cache->getItem($this->prefix.$sessionId);
+
+        return $item->isHit() ? $item->get() : '';
     }
 
     /**
      * {@inheritdoc}
      */
-    public function read($sessionId)
+    protected function doWrite(string $sessionId, string $data)
     {
-        $item = $this->getCacheItem($sessionId);
-        if ($item->isHit()) {
-            return $item->get();
-        }
+        $item = $this->cache->getItem($this->prefix.$sessionId);
+        $item->set($data)
+            ->expiresAfter($this->ttl ?? ini_get('session.gc_maxlifetime'));
 
-        return '';
+        return $this->cache->save($item);
     }
 
     /**
      * {@inheritdoc}
      */
-    public function write($sessionId, $data)
+    protected function doDestroy(string $sessionId)
     {
-        $item = $this->getCacheItem($sessionId);
-        $item->set($data)
-            ->expiresAfter($this->ttl);
-
-        return $this->cache->save($item);
+        return $this->cache->deleteItem($this->prefix.$sessionId);
     }
 
     /**
      * {@inheritdoc}
      */
-    public function destroy($sessionId)
+    public function close()
     {
-        return $this->cache->deleteItem($this->prefix.$sessionId);
+        return true;
     }
 
     /**
@@ -110,12 +104,13 @@ public function gc($lifetime)
     }
 
     /**
-     * @param string $sessionId
-     *
-     * @return \Psr\Cache\CacheItemInterface
+     * {@inheritdoc}
      */
-    private function getCacheItem($sessionId)
+    public function updateTimestamp($sessionId, $data)
     {
-        return $this->cache->getItem($this->prefix.$sessionId);
+        $cacheItem = $this->cache->getItem($this->prefix.$sessionId);
+        $cacheItem->expiresAfter((int) ($this->ttl ?? ini_get('session.gc_maxlifetime')));
+
+        return $this->cache->save($cacheItem);
     }
 }
diff --git a/src/Symfony/Component/HttpFoundation/composer.json b/src/Symfony/Component/HttpFoundation/composer.json
@@ -23,10 +23,12 @@
     "require-dev": {
         "predis/predis": "~1.0",
         "symfony/mime": "^4.4|^5.0",
-        "symfony/expression-language": "^4.4|^5.0"
+        "symfony/expression-language": "^4.4|^5.0",
+        "psr/cache": "~1.0"
     },
     "suggest" : {
-        "symfony/mime": "To use the file extension guesser"
+        "symfony/mime": "To use the file extension guesser",
+        "psr/cache": "To use the Psr6SessionHandler"
     },
     "autoload": {
         "psr-4": { "Symfony\\Component\\HttpFoundation\\": "" },
