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

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