pimcore/lib/Pimcore/Bundle/CoreBundle/EventListener/ResponseExceptionListener.php line 66

Open in your IDE?
  1. <?php
  2. /**
  3.  * Pimcore
  4.  *
  5.  * This source file is available under two different licenses:
  6.  * - GNU General Public License version 3 (GPLv3)
  7.  * - Pimcore Enterprise License (PEL)
  8.  * Full copyright and license information is available in
  9.  * LICENSE.md which is distributed with this source code.
  10.  *
  11.  * @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  12.  * @license    http://www.pimcore.org/license     GPLv3 and PEL
  13.  */
  15. namespace Pimcore\Bundle\CoreBundle\EventListener;
  17. use Pimcore\Bundle\CoreBundle\EventListener\Traits\PimcoreContextAwareTrait;
  18. use Pimcore\Config;
  19. use Pimcore\Http\Exception\ResponseException;
  20. use Pimcore\Http\Request\Resolver\PimcoreContextResolver;
  21. use Pimcore\Model\Document;
  22. use Pimcore\Model\Site;
  23. use Pimcore\Templating\Renderer\ActionRenderer;
  24. use Psr\Log\LoggerAwareTrait;
  25. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  26. use Symfony\Component\HttpFoundation\Response;
  27. use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
  28. use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
  29. use Symfony\Component\HttpKernel\KernelEvents;
  31. class ResponseExceptionListener implements EventSubscriberInterface
  32. {
  33.     use LoggerAwareTrait;
  34.     use PimcoreContextAwareTrait;
  36.     /**
  37.      * @var ActionRenderer
  38.      */
  39.     protected $actionRenderer;
  41.     /**
  42.      * @var bool
  43.      */
  44.     protected $renderErrorPage = true;
  46.     /**
  47.      * @param ActionRenderer $actionRenderer
  48.      * @param bool $renderErrorPage
  49.      */
  50.     public function __construct(ActionRenderer $actionRenderer, $renderErrorPage = true)
  51.     {
  52.         $this->actionRenderer  = $actionRenderer;
  53.         $this->renderErrorPage = (bool)$renderErrorPage;
  54.     }
  56.     /**
  57.      * @inheritDoc
  58.      */
  59.     public static function getSubscribedEvents()
  60.     {
  61.         return [
  62.             KernelEvents::EXCEPTION => 'onKernelException'
  63.         ];
  64.     }
  66.     public function onKernelException(GetResponseForExceptionEvent $event)
  67.     {
  68.         $exception = $event->getException();
  70.         // handle ResponseException (can be used from any context)
  71.         if ($exception instanceof ResponseException) {
  72.             $event->setResponse($exception->getResponse());
  74.             // a response was explicitely set -> do not continue to error page
  75.             return;
  76.         }
  78.         // further checks are only valid for default context
  79.         $request = $event->getRequest();
  80.         if ($this->matchesPimcoreContext($request, PimcoreContextResolver::CONTEXT_DEFAULT)) {
  81.             if ($this->renderErrorPage) {
  82.                 $this->handleErrorPage($event);
  83.             }
  84.         }
  85.     }
  87.     protected function handleErrorPage(GetResponseForExceptionEvent $event)
  88.     {
  89.         if (\Pimcore::inDebugMode() || PIMCORE_DEVMODE) {
  90.             return;
  91.         }
  93.         $exception = $event->getException();
  95.         $statusCode = 500;
  96.         $headers    = [];
  98.         if ($exception instanceof HttpExceptionInterface) {
  99.             $statusCode = $exception->getStatusCode();
  100.             $header     = $exception->getHeaders();
  101.         }
  103.         $errorPath = Config::getSystemConfig()->documents->error_pages->default;
  105.         if (Site::isSiteRequest()) {
  106.             $site      = Site::getCurrentSite();
  107.             $errorPath = $site->getErrorDocument();
  108.         }
  110.         if (empty($errorPath)) {
  111.             $errorPath = '/';
  112.         }
  114.         $document = Document::getByPath($errorPath);
  116.         if (!$document instanceof Document\Page) {
  117.             // default is home
  118.             $document = Document::getById(1);
  119.         }
  121.         try {
  122.             $response = $this->actionRenderer->render($document);
  123.         } catch (\Exception $e) {
  124.             // we are even not able to render the error page, so we send the client a unicorn
  125.             $response = 'Page not found. ðŸ¦„';
  126.             $this->logger->emergency('Unable to render error page, exception thrown');
  127.             $this->logger->emergency($e);
  128.         }
  130.         $event->setResponse(new Response($response, $statusCode, $headers));
  131.     }
  132. }