feature #21421 Use proper error message when session write fails #20807 (digilist)

fabpot · fabpot · commit 3d67aba24a7f · 2017-03-05T12:27:24.000-08:00
This PR was submitted for the 2.8 branch but it was merged into the 3.3-dev branch instead (closes #21421). Discussion ---------- Use proper error message when session write fails #20807 This improves the error message that is thrown if a session write fails (see #20807) As there was no way to get the actual handler, I introduced a method on the SessionHandlerProxy. I hope that's okay, otherwise please give me a hint on what to do. | Q | A | ------------- | --- | Branch? | 2.8 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #20807 | License | MIT Commits ------- c7a44be Use proper error message when session write fails #20807
diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/NativeSessionStorage.php b/src/Symfony/Component/HttpFoundation/Session/Storage/NativeSessionStorage.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\HttpFoundation\Session\Storage;
 
+use Symfony\Component\Debug\Exception\ContextErrorException;
 use Symfony\Component\HttpFoundation\Session\SessionBagInterface;
 use Symfony\Component\HttpFoundation\Session\Storage\Handler\NativeSessionHandler;
 use Symfony\Component\HttpFoundation\Session\Storage\Proxy\AbstractProxy;
@@ -208,7 +209,28 @@ public function regenerate($destroy = false, $lifetime = null)
      */
     public function save()
     {
-        session_write_close();
+        // Register custom error handler to catch a possible failure warning during session write
+        set_error_handler(function ($errno, $errstr, $errfile, $errline, $errcontext) {
+            throw new ContextErrorException($errstr, $errno, E_WARNING, $errfile, $errline, $errcontext);
+        }, E_WARNING);
+
+        try {
+            session_write_close();
+            restore_error_handler();
+        } catch (ContextErrorException $e) {
+            // The default PHP error message is not very helpful, as it does not give any information on the current save handler.
+            // Therefore, we catch this error and trigger a warning with a better error message
+            $handler = $this->getSaveHandler();
+            if ($handler instanceof SessionHandlerProxy) {
+                $handler = $handler->getHandler();
+            }
+
+            restore_error_handler();
+            trigger_error(sprintf(
+                'session_write_close(): Failed to write session data with %s handler',
+                get_class($handler)
+            ), E_USER_WARNING);
+        }
 
         $this->closed = true;
         $this->started = false;
diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/Proxy/SessionHandlerProxy.php b/src/Symfony/Component/HttpFoundation/Session/Storage/Proxy/SessionHandlerProxy.php
@@ -35,6 +35,14 @@ public function __construct(\SessionHandlerInterface $handler)
         $this->saveHandlerName = $this->wrapper ? ini_get('session.save_handler') : 'user';
     }
 
+    /**
+     * @return \SessionHandlerInterface
+     */
+    public function getHandler()
+    {
+        return $this->handler;
+    }
+
     // \SessionHandlerInterface
 
     /**
