vendor/symfony/http-kernel/EventListener/ExceptionListener.php line 43

Open in your IDE?
  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\Debug\Exception\FlattenException;
  16. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  17. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  18. use Symfony\Component\HttpFoundation\Request;
  19. use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
  20. use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
  21. use Symfony\Component\HttpKernel\HttpKernelInterface;
  22. use Symfony\Component\HttpKernel\KernelEvents;
  23. use Symfony\Component\HttpKernel\Log\DebugLoggerInterface;
  25. /**
  26.  * @author Fabien Potencier <fabien@symfony.com>
  27.  *
  28.  * @final since Symfony 4.3
  29.  */
  30. class ExceptionListener implements EventSubscriberInterface
  31. {
  32.     protected $controller;
  33.     protected $logger;
  34.     protected $debug;
  36.     public function __construct($controller, LoggerInterface $logger = null, $debug = false)
  37.     {
  38.         $this->controller = $controller;
  39.         $this->logger = $logger;
  40.         $this->debug = $debug;
  41.     }
  43.     public function logKernelException(GetResponseForExceptionEvent $event)
  44.     {
  45.         $e = FlattenException::create($event->getException());
  47.         $this->logException($event->getException(), sprintf('Uncaught PHP Exception %s: "%s" at %s line %s', $e->getClass(), $e->getMessage(), $e->getFile(), $e->getLine()));
  48.     }
  50.     public function onKernelException(GetResponseForExceptionEvent $event)
  51.     {
  52.         if (null === $this->controller) {
  53.             return;
  54.         }
  56.         $exception = $event->getException();
  57.         $request = $this->duplicateRequest($exception, $event->getRequest());
  58.         $eventDispatcher = \func_num_args() > 2 ? func_get_arg(2) : null;
  60.         try {
  61.             $response = $event->getKernel()->handle($request, HttpKernelInterface::SUB_REQUEST, false);
  62.         } catch (\Exception $e) {
  63.             $f = FlattenException::create($e);
  65.             $this->logException($e, sprintf('Exception thrown when handling an exception (%s: %s at %s line %s)', $f->getClass(), $f->getMessage(), $e->getFile(), $e->getLine()));
  67.             $prev = $e;
  68.             do {
  69.                 if ($exception === $wrapper = $prev) {
  70.                     throw $e;
  71.                 }
  72.             } while ($prev = $wrapper->getPrevious());
  74.             $prev = new \ReflectionProperty($wrapper instanceof \Exception ? \Exception::class : \Error::class, 'previous');
  75.             $prev->setAccessible(true);
  76.             $prev->setValue($wrapper, $exception);
  78.             throw $e;
  79.         }
  81.         $event->setResponse($response);
  83.         if ($this->debug && $eventDispatcher instanceof EventDispatcherInterface) {
  84.             $cspRemovalListener = function ($event) use (&$cspRemovalListener, $eventDispatcher) {
  85.                 $event->getResponse()->headers->remove('Content-Security-Policy');
  86.                 $eventDispatcher->removeListener(KernelEvents::RESPONSE, $cspRemovalListener);
  87.             };
  88.             $eventDispatcher->addListener(KernelEvents::RESPONSE, $cspRemovalListener, -128);
  89.         }
  90.     }
  92.     public static function getSubscribedEvents()
  93.     {
  94.         return [
  95.             KernelEvents::EXCEPTION => [
  96.                 ['logKernelException', 0],
  97.                 ['onKernelException', -128],
  98.             ],
  99.         ];
  100.     }
  102.     /**
  103.      * Logs an exception.
  104.      *
  105.      * @param \Exception $exception The \Exception instance
  106.      * @param string     $message   The error message to log
  107.      */
  108.     protected function logException(\Exception $exception, $message)
  109.     {
  110.         if (null !== $this->logger) {
  111.             if (!$exception instanceof HttpExceptionInterface || $exception->getStatusCode() >= 500) {
  112.                 $this->logger->critical($message, ['exception' => $exception]);
  113.             } else {
  114.                 $this->logger->error($message, ['exception' => $exception]);
  115.             }
  116.         }
  117.     }
  119.     /**
  120.      * Clones the request for the exception.
  121.      *
  122.      * @param \Exception $exception The thrown exception
  123.      * @param Request    $request   The original request
  124.      *
  125.      * @return Request The cloned request
  126.      */
  127.     protected function duplicateRequest(\Exception $exception, Request $request)
  128.     {
  129.         $attributes = [
  130.             '_controller' => $this->controller,
  131.             'exception' => FlattenException::create($exception),
  132.             'logger' => $this->logger instanceof DebugLoggerInterface ? $this->logger : null,
  133.         ];
  134.         $request = $request->duplicate(null, null, $attributes);
  135.         $request->setMethod('GET');
  137.         return $request;
  138.     }
  139. }