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

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\Db\Connection;
  20. use Pimcore\Document\Renderer\DocumentRenderer;
  21. use Pimcore\FeatureToggles\Features\DebugMode;
  22. use Pimcore\Http\Exception\ResponseException;
  23. use Pimcore\Http\Request\Resolver\PimcoreContextResolver;
  24. use Pimcore\Model\Document;
  25. use Pimcore\Model\Site;
  26. use Pimcore\Templating\Renderer\ActionRenderer;
  27. use Psr\Log\LoggerAwareTrait;
  28. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  29. use Symfony\Component\HttpFoundation\Response;
  30. use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
  31. use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
  32. use Symfony\Component\HttpKernel\KernelEvents;
  34. class ResponseExceptionListener implements EventSubscriberInterface
  35. {
  36.     use LoggerAwareTrait;
  37.     use PimcoreContextAwareTrait;
  39.     /**
  40.      * @var ActionRenderer
  41.      */
  42.     protected $documentRenderer;
  44.     /**
  45.      * @var bool
  46.      */
  47.     protected $renderErrorPage = true;
  49.     /**
  50.      * @var Connection
  51.      */
  52.     protected $db;
  54.     /**
  55.      * @param DocumentRenderer $documentRenderer
  56.      * @param Connection $db
  57.      * @param bool $renderErrorPage
  58.      */
  59.     public function __construct(DocumentRenderer $documentRenderer, Connection $db, $renderErrorPage = true)
  60.     {
  61.         $this->documentRenderer  = $documentRenderer;
  62.         $this->renderErrorPage = (bool)$renderErrorPage;
  63.         $this->db = $db;
  64.     }
  66.     /**
  67.      * @inheritDoc
  68.      */
  69.     public static function getSubscribedEvents()
  70.     {
  71.         return [
  72.             KernelEvents::EXCEPTION => 'onKernelException'
  73.         ];
  74.     }
  76.     public function onKernelException(GetResponseForExceptionEvent $event)
  77.     {
  78.         $exception = $event->getException();
  80.         // handle ResponseException (can be used from any context)
  81.         if ($exception instanceof ResponseException) {
  82.             $event->setResponse($exception->getResponse());
  84.             // a response was explicitely set -> do not continue to error page
  85.             return;
  86.         }
  88.         // further checks are only valid for default context
  89.         $request = $event->getRequest();
  90.         if ($this->matchesPimcoreContext($request, PimcoreContextResolver::CONTEXT_DEFAULT)) {
  91.             if ($this->renderErrorPage) {
  92.                 $this->handleErrorPage($event);
  93.             }
  94.         }
  95.     }
  97.     protected function handleErrorPage(GetResponseForExceptionEvent $event)
  98.     {
  99.         if (\Pimcore::inDebugMode(DebugMode::NO_ERROR_PAGE)) {
  100.             return;
  101.         }
  103.         $exception = $event->getException();
  105.         $statusCode = 500;
  106.         $headers    = [];
  108.         if ($exception instanceof HttpExceptionInterface) {
  109.             $statusCode = $exception->getStatusCode();
  110.             $headers    = $exception->getHeaders();
  111.         }
  113.         $errorPath = Config::getSystemConfig()->documents->error_pages->default;
  115.         if (Site::isSiteRequest()) {
  116.             $site      = Site::getCurrentSite();
  117.             $errorPath = $site->getErrorDocument();
  118.         }
  120.         // HTTP Error Log
  121.         $uri = $event->getRequest()->getUri();
  122.         $exists = $this->db->fetchOne('SELECT date FROM http_error_log WHERE uri = ?', $uri);
  123.         if ($exists) {
  124.             $this->db->query('UPDATE http_error_log SET `count` = `count` + 1, date = ? WHERE uri = ?', [time(), $uri]);
  125.         } else {
  126.             $this->db->insert('http_error_log', [
  127.                 'uri' => $uri,
  128.                 'code' => (int) $statusCode,
  129.                 'parametersGet' => serialize($_GET),
  130.                 'parametersPost' => serialize($_POST),
  131.                 'cookies' => serialize($_COOKIE),
  132.                 'serverVars' => serialize($_SERVER),
  133.                 'date' => time(),
  134.                 'count' => 1
  135.             ]);
  136.         }
  138.         // Error page rendering
  139.         if (empty($errorPath)) {
  140.             $errorPath = '/';
  141.         }
  143.         $document = Document::getByPath($errorPath);
  145.         if (!$document instanceof Document\Page) {
  146.             // default is home
  147.             $document = Document::getById(1);
  148.         }
  150.         try {
  151.             $response = $this->documentRenderer->render($document, [
  152.                 'exception' => $exception
  153.             ]);
  154.         } catch (\Exception $e) {
  155.             // we are even not able to render the error page, so we send the client a unicorn
  156.             $response = 'Page not found. ðŸ¦„';
  157.             $this->logger->emergency('Unable to render error page, exception thrown');
  158.             $this->logger->emergency($e);
  159.         }
  161.         $event->setResponse(new Response($response, $statusCode, $headers));
  162.     }
  163. }