[HttpFoundation] Make SessionHandlerProxy implement SessionIdInterface

MatTheCat · MatTheCat · commit 06b6e7306645 · 2023-06-12T13:37:28.000+02:00
diff --git a/src/Symfony/Component/HttpFoundation/CHANGELOG.md b/src/Symfony/Component/HttpFoundation/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Make `HeaderBag::getDate()`, `Response::getDate()`, `getExpires()` and `getLastModified()` return a `DateTimeImmutable`
+ * Make `SessionHandlerProxy` implement `SessionIdInterface`
 
 6.3
 ---
diff --git a/src/Symfony/Component/HttpFoundation/Exception/SessionIdCreationException.php b/src/Symfony/Component/HttpFoundation/Exception/SessionIdCreationException.php
@@ -0,0 +1,20 @@
+<?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\Exception;
+
+class SessionIdCreationException extends \RuntimeException
+{
+    public function __construct(string $message = 'Could not create a session id.', int $code = 0, \Throwable $previous = null)
+    {
+        parent::__construct($message, $code, $previous);
+    }
+}
diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Proxy/SessionHandlerProxy.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Proxy/SessionHandlerProxy.php
@@ -11,12 +11,13 @@
 
 namespace Symfony\Component\HttpFoundation\Session\Storage\Proxy;
 
+use Symfony\Component\HttpFoundation\Exception\SessionIdCreationException;
 use Symfony\Component\HttpFoundation\Session\Storage\Handler\StrictSessionHandler;
 
 /**
  * @author Drak <drak@zikula.org>
  */
-class SessionHandlerProxy extends AbstractProxy implements \SessionHandlerInterface, \SessionUpdateTimestampHandlerInterface
+class SessionHandlerProxy extends AbstractProxy implements \SessionHandlerInterface, \SessionUpdateTimestampHandlerInterface, \SessionIdInterface
 {
     protected $handler;
 
@@ -73,4 +74,17 @@ public function updateTimestamp(#[\SensitiveParameter] string $sessionId, string
     {
         return $this->handler instanceof \SessionUpdateTimestampHandlerInterface ? $this->handler->updateTimestamp($sessionId, $data) : $this->write($sessionId, $data);
     }
+
+    public function create_sid(): string
+    {
+        if ($this->handler instanceof \SessionIdInterface) {
+            return $this->handler->create_sid();
+        }
+
+        if (!$id = session_create_id()) {
+            throw new SessionIdCreationException();
+        }
+
+        return $id;
+    }
 }
diff --git a/src/Symfony/Component/HttpFoundation/Tests/Session/Storage/Proxy/SessionHandlerProxyTest.php b/src/Symfony/Component/HttpFoundation/Tests/Session/Storage/Proxy/SessionHandlerProxyTest.php
@@ -179,8 +179,26 @@ public static function provideNativeSessionStorageHandler()
             [new SessionHandlerProxy(new StrictSessionHandler(new \SessionHandler()))],
         ];
     }
+
+    public function testCreateSid()
+    {
+        $mock = $this->createMock(SessionIdSessionHandler::class);
+        $mock->expects($this->once())
+            ->method('create_sid')
+            ->willReturn('a-valid-session-identifier');
+
+        $proxy = new SessionHandlerProxy($mock);
+        $this->assertSame('a-valid-session-identifier', $proxy->create_sid());
+
+        $this->proxy->create_sid();
+        $this->addToAssertionCount(1);
+    }
 }
 
 abstract class TestSessionHandler implements \SessionHandlerInterface, \SessionUpdateTimestampHandlerInterface
 {
 }
+
+abstract class SessionIdSessionHandler implements \SessionHandlerInterface, \SessionIdInterface
+{
+}
