bug #33260 [ErrorHandler] Registering basic exception handler to handle early failures (yceruto)

fabpot · fabpot · commit b7954640e3fd · 2019-08-20T21:09:10.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [ErrorHandler] Registering basic exception handler to handle early failures | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - This behavior was previously handled by the removed `ExceptionHandler` class in #32637. As this method is mainly called during Kernel boot, where nothing is yet available, the Response content is always HTML. Otherwise, If all goes well on booting, this exception handler will be replaced in `DebugHandlersListener` class: https://github.com/symfony/symfony/blob/8073b8abfb82d59c6acabce7cec7bfb3af24738a/src/Symfony/Component/HttpKernel/EventListener/DebugHandlersListener.php#L139 where the advanced exception handler mechanism is activated. Commits ------- a2077a2 Registers basic exception handler to handle early failures
diff --git a/src/Symfony/Component/ErrorHandler/ErrorHandler.php b/src/Symfony/Component/ErrorHandler/ErrorHandler.php
@@ -21,6 +21,8 @@
 use Symfony\Component\ErrorHandler\FatalErrorHandler\FatalErrorHandlerInterface;
 use Symfony\Component\ErrorHandler\FatalErrorHandler\UndefinedFunctionFatalErrorHandler;
 use Symfony\Component\ErrorHandler\FatalErrorHandler\UndefinedMethodFatalErrorHandler;
+use Symfony\Component\ErrorRenderer\ErrorRenderer\HtmlErrorRenderer;
+use Symfony\Component\ErrorRenderer\Exception\FlattenException;
 
 /**
  * A generic ErrorHandler for the PHP engine.
@@ -144,6 +146,8 @@ public static function register(self $handler = null, bool $replace = true): sel
                 $handler->setExceptionHandler($p);
                 $prev[0]->setExceptionHandler($p);
             }
+        } elseif (null === $prev && !\in_array(\PHP_SAPI, ['cli', 'phpdbg'], true)) {
+            $handler->setExceptionHandler([$handler, 'sendPhpResponse']);
         } else {
             $handler->setExceptionHandler($prev);
         }
@@ -320,7 +324,7 @@ public function throwAt(int $levels, bool $replace = false): int
     public function scopeAt(int $levels, bool $replace = false): int
     {
         $prev = $this->scopedErrors;
-        $this->scopedErrors = (int) $levels;
+        $this->scopedErrors = $levels;
         if (!$replace) {
             $this->scopedErrors |= $prev;
         }
@@ -358,7 +362,7 @@ public function traceAt(int $levels, bool $replace = false): int
     public function screamAt(int $levels, bool $replace = false): int
     {
         $prev = $this->screamedErrors;
-        $this->screamedErrors = (int) $levels;
+        $this->screamedErrors = $levels;
         if (!$replace) {
             $this->screamedErrors |= $prev;
         }
@@ -683,6 +687,29 @@ public static function handleFatalError(array $error = null): void
         }
     }
 
+    /**
+     * Sends the error associated with the given Exception as a plain PHP response.
+     *
+     * As this method is mainly called during Kernel boot, where nothing is yet
+     * available, the Response content is always HTML.
+     */
+    private function sendPhpResponse(\Throwable $exception)
+    {
+        $charset = ini_get('default_charset') ?: 'UTF-8';
+
+        if (!headers_sent()) {
+            header('HTTP/1.0 500');
+            header(sprintf('Content-Type: text/html; charset=%s', $charset));
+        }
+
+        if (class_exists(HtmlErrorRenderer::class)) {
+            echo (new HtmlErrorRenderer(true))->render(FlattenException::createFromThrowable($exception));
+        } else {
+            $message = htmlspecialchars($exception->getMessage(), ENT_COMPAT | ENT_SUBSTITUTE, $charset);
+            echo sprintf('<!DOCTYPE html><html><head><meta charset="%s" /><meta name="robots" content="noindex,nofollow" /></head><body>%s</body></html>', $charset, $message);
+        }
+    }
+
     /**
      * Gets the fatal error handlers.
      *
diff --git a/src/Symfony/Component/ErrorHandler/composer.json b/src/Symfony/Component/ErrorHandler/composer.json
@@ -22,6 +22,9 @@
     "require-dev": {
         "symfony/http-kernel": "^3.4|^4.0|^5.0"
     },
+    "suggest": {
+        "symfony/error-renderer": "For better error rendering"
+    },
     "conflict": {
         "symfony/http-kernel": "<3.4"
     },
