vendor/symfony/http-kernel/EventListener/DebugHandlersListener.php line 76

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\HttpKernel\EventListener;
  14. use Psr\Log\LoggerInterface;
  15. use Symfony\Component\Console\ConsoleEvents;
  16. use Symfony\Component\Console\Event\ConsoleEvent;
  17. use Symfony\Component\Console\Output\ConsoleOutputInterface;
  18. use Symfony\Component\ErrorHandler\ErrorHandler;
  19. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  20. use Symfony\Component\HttpKernel\Event\KernelEvent;
  21. use Symfony\Component\HttpKernel\KernelEvents;
  23. /**
  24.  * Sets an exception handler.
  25.  *
  26.  * @author Nicolas Grekas <p@tchwork.com>
  27.  *
  28.  * @final
  29.  *
  30.  * @internal
  31.  */
  32. class DebugHandlersListener implements EventSubscriberInterface
  33. {
  34.     private string|object|null $earlyHandler;
  35.     private ?\Closure $exceptionHandler;
  36.     private bool $webMode;
  37.     private bool $firstCall = true;
  38.     private bool $hasTerminatedWithException = false;
  40.     /**
  41.      * @param bool          $webMode
  42.      * @param callable|null $exceptionHandler A handler that must support \Throwable instances that will be called on Exception
  43.      */
  44.     public function __construct(?callable $exceptionHandler = null, bool|LoggerInterface|null $webMode = null)
  45.     {
  46.         if ($webMode instanceof LoggerInterface) {
  47.             // BC with Symfony 5
  48.             $webMode = null;
  49.         }
  50.         $handler = set_exception_handler('is_int');
  51.         $this->earlyHandler = \is_array($handler) ? $handler[0] : null;
  52.         restore_exception_handler();
  54.         $this->exceptionHandler = null === $exceptionHandler ? null : $exceptionHandler(...);
  55.         $this->webMode = $webMode ?? !\in_array(\PHP_SAPI, ['cli', 'phpdbg', 'embed'], true);
  56.     }
  58.     /**
  59.      * Configures the error handler.
  60.      */
  61.     public function configure(?object $event = null): void
  62.     {
  63.         if ($event instanceof ConsoleEvent && $this->webMode) {
  64.             return;
  65.         }
  66.         if (!$event instanceof KernelEvent ? !$this->firstCall : !$event->isMainRequest()) {
  67.             return;
  68.         }
  69.         $this->firstCall = $this->hasTerminatedWithException = false;
  71.         if (!$this->exceptionHandler) {
  72.             if ($event instanceof KernelEvent) {
  73.                 if (method_exists($kernel = $event->getKernel(), 'terminateWithException')) {
  74.                     $request = $event->getRequest();
  75.                     $hasRun = &$this->hasTerminatedWithException;
  76.                     $this->exceptionHandler = static function (\Throwable $e) use ($kernel, $request, &$hasRun) {
  77.                         if ($hasRun) {
  78.                             throw $e;
  79.                         }
  81.                         $hasRun = true;
  82.                         $kernel->terminateWithException($e, $request);
  83.                     };
  84.                 }
  85.             } elseif ($event instanceof ConsoleEvent && $app = $event->getCommand()->getApplication()) {
  86.                 $output = $event->getOutput();
  87.                 if ($output instanceof ConsoleOutputInterface) {
  88.                     $output = $output->getErrorOutput();
  89.                 }
  90.                 $this->exceptionHandler = static function (\Throwable $e) use ($app, $output) {
  91.                     $app->renderThrowable($e, $output);
  92.                 };
  93.             }
  94.         }
  95.         if ($this->exceptionHandler) {
  96.             $handler = set_exception_handler(static fn () => null);
  97.             $handler = \is_array($handler) ? $handler[0] : null;
  98.             restore_exception_handler();
  100.             if (!$handler instanceof ErrorHandler) {
  101.                 $handler = $this->earlyHandler;
  102.             }
  104.             if ($handler instanceof ErrorHandler) {
  105.                 $handler->setExceptionHandler($this->exceptionHandler);
  106.             }
  107.             $this->exceptionHandler = null;
  108.         }
  109.     }
  111.     public static function getSubscribedEvents(): array
  112.     {
  113.         $events = [KernelEvents::REQUEST => ['configure', 2048]];
  115.         if (\defined('Symfony\Component\Console\ConsoleEvents::COMMAND')) {
  116.             $events[ConsoleEvents::COMMAND] = ['configure', 2048];
  117.         }
  119.         return $events;
  120.     }
  121. }