pimcore/lib/Pimcore/Bundle/AdminBundle/EventListener/AdminExceptionListener.php line 48

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /**
  6.  * Pimcore
  7.  *
  8.  * This source file is available under two different licenses:
  9.  * - GNU General Public License version 3 (GPLv3)
  10.  * - Pimcore Enterprise License (PEL)
  11.  * Full copyright and license information is available in
  12.  * LICENSE.md which is distributed with this source code.
  13.  *
  14.  * @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  15.  * @license    http://www.pimcore.org/license     GPLv3 and PEL
  16.  */
  18. namespace Pimcore\Bundle\AdminBundle\EventListener;
  20. use Pimcore\Bundle\AdminBundle\HttpFoundation\JsonResponse;
  21. use Pimcore\Bundle\CoreBundle\EventListener\Traits\PimcoreContextAwareTrait;
  22. use Pimcore\Http\Request\Resolver\PimcoreContextResolver;
  23. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  24. use Symfony\Component\HttpFoundation\Response;
  25. use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
  26. use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
  27. use Symfony\Component\HttpKernel\KernelEvents;
  29. class AdminExceptionListener implements EventSubscriberInterface
  30. {
  31.     use PimcoreContextAwareTrait;
  33.     /**
  34.      * @inheritDoc
  35.      */
  36.     public static function getSubscribedEvents(): array
  37.     {
  38.         return [
  39.             KernelEvents::EXCEPTION => 'onKernelException'
  40.         ];
  41.     }
  43.     /**
  44.      * Return JSON error responses from webservice context
  45.      *
  46.      * @param GetResponseForExceptionEvent $event
  47.      */
  48.     public function onKernelException(GetResponseForExceptionEvent $event)
  49.     {
  50.         $request = $event->getRequest();
  51.         $ex      = $event->getException();
  53.         if ($this->matchesPimcoreContext($request, PimcoreContextResolver::CONTEXT_ADMIN)) {
  54.             // only return JSON error for XHR requests
  55.             if (!$request->isXmlHttpRequest()) {
  56.                 return;
  57.             }
  59.             list($code, $headers, $message) = $this->getResponseData($ex);
  61.             $data = [
  62.                 'success' => false,
  63.                 'message' => $message,
  64.             ];
  66.             if (\Pimcore::inDebugMode()) {
  67.                 $data['trace'] = $ex->getTrace();
  68.             }
  70.             $response = new JsonResponse($data, $code, $headers);
  71.             $event->setResponse($response);
  73.             return;
  74.         } elseif ($this->matchesPimcoreContext($request, PimcoreContextResolver::CONTEXT_WEBSERVICE)) {
  75.             list($code, $headers, $message) = $this->getResponseData($ex);
  77.             $data = [
  78.                 'success' => false,
  79.                 'msg'     => $message
  80.             ];
  82.             $response = new JsonResponse($data, $code, $headers);
  83.             $event->setResponse($response);
  85.             return;
  86.         }
  87.     }
  89.     private function getResponseData(\Exception $ex, int $defaultStatusCode = 500): array
  90.     {
  91.         $code    = $defaultStatusCode;
  92.         $headers = [];
  94.         $message = $ex->getMessage();
  96.         if ($ex instanceof HttpExceptionInterface) {
  97.             if (empty($message)) {
  98.                 $message = Response::$statusTexts[$ex->getStatusCode()];
  99.             }
  101.             $code    = $ex->getStatusCode();
  102.             $headers = $ex->getHeaders();
  103.         }
  105.         return [$code, $headers, $message];
  106.     }
  107. }