Deprecate session.storage

Author: jderusse

CHANGELOG.md

@@ -4,6 +4,7 @@ CHANGELOG
 5.3
 ---
 
+ * Add the `SessionFactory`, `NativeSessionStorageFactory`, `PhpBridgeSessionStorageFactory` and `MockFileSessionStorageFactory` classes
  * Calling `Request::getSession()` when there is no available session throws a `SessionNotFoundException`
  * Add the `RequestStack::getSession` method
  * Deprecate the `NamespacedAttributeBag` class

Session/SessionFactory.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\HttpFoundation\Session;
+
+use Symfony\Component\HttpFoundation\RequestStack;
+use Symfony\Component\HttpFoundation\Session\Storage\SessionStorageFactoryInterface;
+
+// Help opcache.preload discover always-needed symbols
+class_exists(Session::class);
+
+/**
+ * @author Jérémy Derussé <jeremy@derusse.com>
+ */
+class SessionFactory
+{
+    private $requestStack;
+    private $storageFactory;
+    private $usageReporter;
+
+    public function __construct(RequestStack $requestStack, SessionStorageFactoryInterface $storageFactory, callable $usageReporter = null)
+    {
+        $this->requestStack = $requestStack;
+        $this->storageFactory = $storageFactory;
+        $this->usageReporter = $usageReporter;
+    }
+
+    public function createSession(): SessionInterface
+    {
+        return new Session($this->storageFactory->createStorage($this->requestStack->getMasterRequest()), null, null, $this->usageReporter);
+    }
+}

Session/Storage/MockFileSessionStorageFactory.php

@@ -0,0 +1,42 @@
+<?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;
+
+use Symfony\Component\HttpFoundation\Request;
+
+// Help opcache.preload discover always-needed symbols
+class_exists(MockFileSessionStorage::class);
+
+/**
+ * @author Jérémy Derussé <jeremy@derusse.com>
+ */
+class MockFileSessionStorageFactory implements SessionStorageFactoryInterface
+{
+    private $savePath;
+    private $name;
+    private $metaBag;
+
+    /**
+     * @see MockFileSessionStorage constructor.
+     */
+    public function __construct(string $savePath = null, string $name = 'MOCKSESSID', MetadataBag $metaBag = null)
+    {
+        $this->savePath = $savePath;
+        $this->name = $name;
+        $this->metaBag = $metaBag;
+    }
+
+    public function createStorage(?Request $request): SessionStorageInterface
+    {
+        return new MockFileSessionStorage($this->savePath, $this->name, $this->metaBag);
+    }
+}

Session/Storage/NativeSessionStorageFactory.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\HttpFoundation\Session\Storage;
+
+use Symfony\Component\HttpFoundation\Request;
+
+// Help opcache.preload discover always-needed symbols
+class_exists(NativeSessionStorage::class);
+
+/**
+ * @author Jérémy Derussé <jeremy@derusse.com>
+ */
+class NativeSessionStorageFactory implements SessionStorageFactoryInterface
+{
+    private $options;
+    private $handler;
+    private $metaBag;
+    private $secure;
+
+    /**
+     * @see NativeSessionStorage constructor.
+     */
+    public function __construct(array $options = [], $handler = null, MetadataBag $metaBag = null, bool $secure = false)
+    {
+        $this->options = $options;
+        $this->handler = $handler;
+        $this->metaBag = $metaBag;
+        $this->secure = $secure;
+    }
+
+    public function createStorage(?Request $request): SessionStorageInterface
+    {
+        $storage = new NativeSessionStorage($this->options, $this->handler, $this->metaBag);
+        if ($this->secure && $request && $request->isSecure()) {
+            $storage->setOptions(['cookie_secure' => true]);
+        }
+
+        return $storage;
+    }
+}

Session/Storage/PhpBridgeSessionStorageFactory.php

@@ -0,0 +1,47 @@
+<?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;
+
+use Symfony\Component\HttpFoundation\Request;
+
+// Help opcache.preload discover always-needed symbols
+class_exists(PhpBridgeSessionStorage::class);
+
+/**
+ * @author Jérémy Derussé <jeremy@derusse.com>
+ */
+class PhpBridgeSessionStorageFactory implements SessionStorageFactoryInterface
+{
+    private $handler;
+    private $metaBag;
+    private $secure;
+
+    /**
+     * @see PhpBridgeSessionStorage constructor.
+     */
+    public function __construct($handler = null, MetadataBag $metaBag = null, bool $secure = false)
+    {
+        $this->handler = $handler;
+        $this->metaBag = $metaBag;
+        $this->secure = $secure;
+    }
+
+    public function createStorage(?Request $request): SessionStorageInterface
+    {
+        $storage = new PhpBridgeSessionStorage($this->handler, $this->metaBag);
+        if ($this->secure && $request && $request->isSecure()) {
+            $storage->setOptions(['cookie_secure' => true]);
+        }
+
+        return $storage;
+    }
+}

Session/Storage/ServiceSessionFactory.php

@@ -0,0 +1,38 @@
+<?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;
+
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * @author Jérémy Derussé <jeremy@derusse.com>
+ *
+ * @internal to be removed in Symfony 6
+ */
+final class ServiceSessionFactory implements SessionStorageFactoryInterface
+{
+    private $storage;
+
+    public function __construct(SessionStorageInterface $storage)
+    {
+        $this->storage = $storage;
+    }
+
+    public function createStorage(?Request $request): SessionStorageInterface
+    {
+        if ($this->storage instanceof NativeSessionStorage && $request && $request->isSecure()) {
+            $this->storage->setOptions(['cookie_secure' => true]);
+        }
+
+        return $this->storage;
+    }
+}

Session/Storage/SessionStorageFactoryInterface.php

@@ -0,0 +1,25 @@
+<?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;
+
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * @author Jérémy Derussé <jeremy@derusse.com>
+ */
+interface SessionStorageFactoryInterface
+{
+    /**
+     * Creates a new instance of SessionStorageInterface
+     */
+    public function createStorage(?Request $request): SessionStorageInterface;
+}