Merge branch '4.4' into 5.0

nicolas-grekas · nicolas-grekas · commit 9befa5924157 · 2019-11-28T15:20:16.000+01:00
* 4.4: (28 commits) bug symfony#34554 [HttpClient] Fix early cleanup of pushed HTTP/2 responses (lyrixx) Fix tests [Console] Fix commands description with numeric namespaces [HttpFoundation] Fixed typo [DI] Skip unknown method calls for factories in check types pass [EventDispatcher] Better error reporting when arguments to dispatch() are swapped improve upgrade instructions for twig.exception_controller configuration [HttpFoundation] Update CHANGELOG for PdoSessionHandler BC BREAK in 4.4 [Serializer] CsvEncoder::NO_HEADERS_KEY ignored when used in constructor [Form] Keep preferred_choices order for choice groups [Debug] work around failing chdir() on Darwin [PhpUnitBridge] Read configuration CLI directive [DI] Missing test on YamlFileLoader Revert "minor symfony#34608 [Process] add tests for php executable finder if file does not exist (ahmedash95)" Simpler example for Apache basic auth workaround [Console] Fix trying to access array offset on value of type int [Config] Remove extra sprintf arg [HttpKernel] fix typo [HttpKernel] Support typehint to deprecated FlattenException in controller Add preview mode support for Html and Serializer error renderers ...
diff --git a/DebugClassLoader.php b/DebugClassLoader.php
@@ -723,7 +723,11 @@ private function darwinRealpath(string $real): string
                 $real = self::$darwinCache[$kDir][0];
             } else {
                 $dir = getcwd();
-                chdir($real);
+
+                if (!@chdir($real)) {
+                    return $real.$file;
+                }
+
                 $real = getcwd().'/';
                 chdir($dir);
 
diff --git a/ErrorRenderer/HtmlErrorRenderer.php b/ErrorRenderer/HtmlErrorRenderer.php
@@ -36,16 +36,28 @@ class HtmlErrorRenderer implements ErrorRendererInterface
     private $charset;
     private $fileLinkFormat;
     private $projectDir;
-    private $requestStack;
+    private $outputBuffer;
     private $logger;
 
-    public function __construct(bool $debug = false, string $charset = null, $fileLinkFormat = null, string $projectDir = null, RequestStack $requestStack = null, LoggerInterface $logger = null)
+    /**
+     * @param bool|callable $debug        The debugging mode as a boolean or a callable that should return it
+     * @param bool|callable $outputBuffer The output buffer as a string or a callable that should return it
+     */
+    public function __construct($debug = false, string $charset = null, $fileLinkFormat = null, string $projectDir = null, $outputBuffer = '', LoggerInterface $logger = null)
     {
+        if (!\is_bool($debug) && !\is_callable($debug)) {
+            throw new \TypeError(sprintf('Argument 1 passed to %s() must be a boolean or a callable, %s given.', __METHOD__, \is_object($debug) ? \get_class($debug) : \gettype($debug)));
+        }
+
+        if (!\is_string($outputBuffer) && !\is_callable($outputBuffer)) {
+            throw new \TypeError(sprintf('Argument 5 passed to %s() must be a string or a callable, %s given.', __METHOD__, \is_object($outputBuffer) ? \get_class($outputBuffer) : \gettype($outputBuffer)));
+        }
+
         $this->debug = $debug;
         $this->charset = $charset ?: (ini_get('default_charset') ?: 'UTF-8');
         $this->fileLinkFormat = $fileLinkFormat ?: (ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format'));
         $this->projectDir = $projectDir;
-        $this->requestStack = $requestStack;
+        $this->outputBuffer = $outputBuffer;
         $this->logger = $logger;
     }
 
@@ -57,7 +69,7 @@ public function render(\Throwable $exception): FlattenException
         $exception = FlattenException::createFromThrowable($exception, null, [
             'Content-Type' => 'text/html; charset='.$this->charset,
         ]);
-        
+
         return $exception->setAsString($this->renderException($exception));
     }
 
@@ -81,42 +93,61 @@ public function getStylesheet(): string
         return $this->include('assets/css/exception.css');
     }
 
+    public static function isDebug(RequestStack $requestStack, bool $debug): \Closure
+    {
+        return static function () use ($requestStack, $debug): bool {
+            if (!$request = $requestStack->getCurrentRequest()) {
+                return $debug;
+            }
+
+            return $debug && $request->attributes->getBoolean('showException', true);
+        };
+    }
+
+    public static function getAndCleanOutputBuffer(RequestStack $requestStack): \Closure
+    {
+        return static function () use ($requestStack): string {
+            if (!$request = $requestStack->getCurrentRequest()) {
+                return '';
+            }
+
+            $startObLevel = $request->headers->get('X-Php-Ob-Level', -1);
+
+            if (ob_get_level() <= $startObLevel) {
+                return '';
+            }
+
+            Response::closeOutputBuffers($startObLevel + 1, true);
+
+            return ob_get_clean();
+        };
+    }
+
     private function renderException(FlattenException $exception, string $debugTemplate = 'views/exception_full.html.php'): string
     {
+        $debug = \is_bool($this->debug) ? $this->debug : ($this->debug)($exception);
         $statusText = $this->escape($exception->getStatusText());
         $statusCode = $this->escape($exception->getStatusCode());
 
-        if (!$this->debug) {
+        if (!$debug) {
             return $this->include('views/error.html.php', [
                 'statusText' => $statusText,
                 'statusCode' => $statusCode,
             ]);
         }
 
         $exceptionMessage = $this->escape($exception->getMessage());
-        $request = $this->requestStack ? $this->requestStack->getCurrentRequest() : null;
 
         return $this->include($debugTemplate, [
             'exception' => $exception,
             'exceptionMessage' => $exceptionMessage,
             'statusText' => $statusText,
             'statusCode' => $statusCode,
             'logger' => $this->logger instanceof DebugLoggerInterface ? $this->logger : null,
-            'currentContent' => $request ? $this->getAndCleanOutputBuffering($request->headers->get('X-Php-Ob-Level', -1)) : '',
+            'currentContent' => \is_string($this->outputBuffer) ? $this->outputBuffer : ($this->outputBuffer)(),
         ]);
     }
 
-    private function getAndCleanOutputBuffering(int $startObLevel): string
-    {
-        if (ob_get_level() <= $startObLevel) {
-            return '';
-        }
-
-        Response::closeOutputBuffers($startObLevel + 1, true);
-
-        return ob_get_clean();
-    }
-
     /**
      * Formats an array as a string.
      */
@@ -312,7 +343,7 @@ private function include(string $name, array $context = []): string
     {
         extract($context, EXTR_SKIP);
         ob_start();
-        include __DIR__ . '/../Resources/' .$name;
+        include __DIR__.'/../Resources/'.$name;
 
         return trim(ob_get_clean());
     }
diff --git a/ErrorRenderer/SerializerErrorRenderer.php b/ErrorRenderer/SerializerErrorRenderer.php
@@ -26,19 +26,26 @@ class SerializerErrorRenderer implements ErrorRendererInterface
     private $serializer;
     private $format;
     private $fallbackErrorRenderer;
+    private $debug;
 
     /**
      * @param string|callable(FlattenException) $format The format as a string or a callable that should return it
+     * @param bool|callable                     $debug  The debugging mode as a boolean or a callable that should return it
      */
-    public function __construct(SerializerInterface $serializer, $format, ErrorRendererInterface $fallbackErrorRenderer = null)
+    public function __construct(SerializerInterface $serializer, $format, ErrorRendererInterface $fallbackErrorRenderer = null, $debug = false)
     {
         if (!\is_string($format) && !\is_callable($format)) {
             throw new \TypeError(sprintf('Argument 2 passed to %s() must be a string or a callable, %s given.', __METHOD__, \is_object($format) ? \get_class($format) : \gettype($format)));
         }
 
+        if (!\is_bool($debug) && !\is_callable($debug)) {
+            throw new \TypeError(sprintf('Argument 4 passed to %s() must be a boolean or a callable, %s given.', __METHOD__, \is_object($debug) ? \get_class($debug) : \gettype($debug)));
+        }
+
         $this->serializer = $serializer;
         $this->format = $format;
         $this->fallbackErrorRenderer = $fallbackErrorRenderer ?? new HtmlErrorRenderer();
+        $this->debug = $debug;
     }
 
     /**
@@ -51,7 +58,10 @@ public function render(\Throwable $exception): FlattenException
         try {
             $format = \is_string($this->format) ? $this->format : ($this->format)($flattenException);
 
-            return $flattenException->setAsString($this->serializer->serialize($flattenException, $format, ['exception' => $exception]));
+            return $flattenException->setAsString($this->serializer->serialize($flattenException, $format, [
+                'exception' => $exception,
+                'debug' => \is_bool($this->debug) ? $this->debug : ($this->debug)($exception),
+            ]));
         } catch (NotEncodableValueException $e) {
             return $this->fallbackErrorRenderer->render($exception);
         }
