lib/netgen/content-browser/bundle/EventListener/ExceptionSerializerListener.php line 51

  1. <?php
  3. declare(strict_types=1);
  5. namespace Netgen\Bundle\ContentBrowserBundle\EventListener;
  7. use Exception;
  8. use Netgen\ContentBrowser\Utils\BackwardsCompatibility\ExceptionEventThrowableTrait;
  9. use Netgen\ContentBrowser\Utils\BackwardsCompatibility\MainRequestEventTrait;
  10. use Psr\Log\LoggerInterface;
  11. use Psr\Log\NullLogger;
  12. use Symfony\Component\Debug\Exception\FlattenException as DebugFlattenException;
  13. use Symfony\Component\ErrorHandler\Exception\FlattenException as ErrorHandlerFlattenException;
  14. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  15. use Symfony\Component\HttpFoundation\JsonResponse;
  16. use Symfony\Component\HttpFoundation\Response;
  17. use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
  18. use Symfony\Component\HttpKernel\KernelEvents;
  19. use Throwable;
  21. use function class_exists;
  22. use function get_debug_type;
  23. use function sprintf;
  25. final class ExceptionSerializerListener implements EventSubscriberInterface
  26. {
  27.     use ExceptionEventThrowableTrait;
  28.     use MainRequestEventTrait;
  30.     private bool $outputDebugInfo;
  32.     private LoggerInterface $logger;
  34.     public function __construct(bool $outputDebugInfo, ?LoggerInterface $logger = null)
  35.     {
  36.         $this->outputDebugInfo = $outputDebugInfo;
  37.         $this->logger = $logger ?? new NullLogger();
  38.     }
  40.     public static function getSubscribedEvents(): array
  41.     {
  42.         // Must happen BEFORE Symfony Security component ExceptionListener
  43.         return [KernelEvents::EXCEPTION => ['onException', 5]];
  44.     }
  46.     /**
  47.      * Serializes the exception.
  48.      *
  49.      * @param \Symfony\Component\HttpKernel\Event\ExceptionEvent $event
  50.      */
  51.     public function onException($event): void
  52.     {
  53.         if (!$this->isMainRequest($event)) {
  54.             return;
  55.         }
  57.         $attributes = $event->getRequest()->attributes;
  58.         if ($attributes->get(SetIsApiRequestListener::API_FLAG_NAME) !== true) {
  59.             return;
  60.         }
  62.         $exception = $this->getThrowable($event);
  63.         $this->logException($exception);
  65.         $data = [
  66.             'code' => $exception->getCode(),
  67.             'message' => $exception->getMessage(),
  68.         ];
  70.         if ($exception instanceof HttpExceptionInterface) {
  71.             $statusCode = $exception->getStatusCode();
  72.             if (isset(Response::$statusTexts[$statusCode])) {
  73.                 $data['status_code'] = $statusCode;
  74.                 $data['status_text'] = Response::$statusTexts[$statusCode];
  75.             }
  76.         }
  78.         if ($this->outputDebugInfo) {
  79.             $debugException = $exception->getPrevious() ?? $exception;
  80.             if (class_exists(ErrorHandlerFlattenException::class)) {
  81.                 $debugException = ErrorHandlerFlattenException::createFromThrowable($debugException);
  82.             } elseif ($debugException instanceof Exception && class_exists(DebugFlattenException::class)) {
  83.                 $debugException = DebugFlattenException::create($debugException);
  84.             }
  86.             $data['debug'] = [
  87.                 'file' => $debugException->getFile(),
  88.                 'line' => $debugException->getLine(),
  89.                 'trace' => $debugException->getTrace(),
  90.             ];
  91.         }
  93.         $event->setResponse(new JsonResponse($data));
  94.     }
  96.     /**
  97.      * Logs all critical errors.
  98.      */
  99.     private function logException(Throwable $error): void
  100.     {
  101.         if ($error instanceof HttpExceptionInterface && $error->getStatusCode() < 500) {
  102.             return;
  103.         }
  105.         $this->logger->critical(
  106.             sprintf(
  107.                 'Uncaught PHP error %s: "%s" at %s line %s',
  108.                 get_debug_type($error),
  109.                 $error->getMessage(),
  110.                 $error->getFile(),
  111.                 $error->getLine(),
  112.             ),
  113.             ['error' => $error],
  114.         );
  115.     }
  116. }