vendor/pimcore/pimcore/bundles/AdminBundle/EventListener/AdminExceptionListener.php line 52

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 Commercial License (PCL)
  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 PCL
  16.  */
  18. namespace Pimcore\Bundle\AdminBundle\EventListener;
  20. use Doctrine\DBAL\Exception as DBALException;
  21. use Pimcore\Bundle\AdminBundle\HttpFoundation\JsonResponse;
  22. use Pimcore\Bundle\CoreBundle\EventListener\Traits\PimcoreContextAwareTrait;
  23. use Pimcore\Http\Request\Resolver\PimcoreContextResolver;
  24. use Pimcore\Model\Element\ValidationException;
  25. use Pimcore\Model\Exception\ConfigWriteException;
  26. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  27. use Symfony\Component\HttpFoundation\Response;
  28. use Symfony\Component\HttpKernel\Event\ExceptionEvent;
  29. use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
  30. use Symfony\Component\HttpKernel\KernelEvents;
  32. /**
  33.  * @internal
  34.  */
  35. class AdminExceptionListener implements EventSubscriberInterface
  36. {
  37.     use PimcoreContextAwareTrait;
  39.     /**
  40.      * {@inheritdoc}
  41.      */
  42.     public static function getSubscribedEvents(): array
  43.     {
  44.         return [
  45.             KernelEvents::EXCEPTION => 'onKernelException',
  46.         ];
  47.     }
  49.     /**
  50.      * @param ExceptionEvent $event
  51.      */
  52.     public function onKernelException(ExceptionEvent $event)
  53.     {
  54.         $request = $event->getRequest();
  55.         $ex = $event->getThrowable();
  57.         if ($this->matchesPimcoreContext($request, PimcoreContextResolver::CONTEXT_ADMIN)) {
  58.             // only return JSON error for XHR requests
  59.             if (!$request->isXmlHttpRequest()) {
  60.                 return;
  61.             }
  63.             list($code, $headers, $message) = $this->getResponseData($ex);
  65.             $data = [
  66.                 'success' => false,
  67.             ];
  69.             if (!\Pimcore::inDebugMode()) {
  70.                 // DBAL exceptions do include SQL statements, we don't want to expose them
  71.                 if ($ex instanceof DBALException) {
  72.                     $message = 'Database error, see logs for details';
  73.                 }
  74.             }
  76.             if (\Pimcore::inDebugMode()) {
  77.                 $data['trace'] = $ex->getTrace();
  78.                 $data['traceString'] = 'in ' . $ex->getFile() . ':' . $ex->getLine() . "\n" . $ex->getTraceAsString();
  79.             }
  81.             if ($ex instanceof ValidationException) {
  82.                 $data['type'] = 'ValidationException';
  83.                 $code = 422;
  85.                 $this->recursiveAddValidationExceptionSubItems($ex->getSubItems(), $message, $data['traceString']);
  86.             }
  88.             if ($ex instanceof ConfigWriteException) {
  89.                 $data['type'] = 'ConfigWriteException';
  90.                 $code = 422;
  91.             }
  93.             $data['message'] = $message;
  95.             $response = new JsonResponse($data, $code, $headers);
  96.             $event->setResponse($response);
  98.             return;
  99.         }
  100.     }
  102.     private function getResponseData(\Throwable $ex, int $defaultStatusCode = 500): array
  103.     {
  104.         $code = $defaultStatusCode;
  105.         $headers = [];
  107.         $message = $ex->getMessage();
  109.         if ($ex instanceof HttpExceptionInterface) {
  110.             if (empty($message)) {
  111.                 $message = Response::$statusTexts[$ex->getStatusCode()];
  112.             }
  114.             $code = $ex->getStatusCode();
  115.             $headers = $ex->getHeaders();
  116.         }
  118.         return [$code, $headers, $message];
  119.     }
  121.     /**
  122.      * @param ValidationException[] $items
  123.      * @param string $message
  124.      * @param string $detailedInfo
  125.      */
  126.     protected function recursiveAddValidationExceptionSubItems($items, &$message, &$detailedInfo)
  127.     {
  128.         if (!$items) {
  129.             return;
  130.         }
  131.         foreach ($items as $e) {
  132.             if ($e->getMessage()) {
  133.                 $message .= '<b>' . $e->getMessage() . '</b>';
  134.                 $this->addContext($e, $message);
  135.                 $message .= '<br>';
  137.                 $detailedInfo .= '<br><b>Message:</b><br>';
  138.                 $detailedInfo .= $e->getMessage() . '<br>';
  140.                 $inner = $this->getInnerStack($e);
  141.                 $detailedInfo .= '<br><b>Trace:</b> ' . $inner->getTraceAsString() . '<br>';
  142.             }
  144.             $this->recursiveAddValidationExceptionSubItems($e->getSubItems(), $message, $detailedInfo);
  145.         }
  146.     }
  148.     /**
  149.      * @param ValidationException $e
  150.      * @param string $message
  151.      */
  152.     protected function addContext(ValidationException $e, &$message)
  153.     {
  154.         $contextStack = $e->getContextStack();
  155.         if ($contextStack) {
  156.             $message = $message . ' (' . implode(',', $contextStack) . ')';
  157.         }
  158.     }
  160.     /**
  161.      * @param \Throwable $e
  162.      *
  163.      * @return \Throwable
  164.      */
  165.     protected function getInnerStack(\Throwable $e)
  166.     {
  167.         while ($e->getPrevious()) {
  168.             $e = $e->getPrevious();
  169.         }
  171.         return $e;
  172.     }
  173. }