vendor/contao/core-bundle/src/EventListener/StoreRefererListener.php line 45

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of Contao.
  7.  *
  8.  * (c) Leo Feyer
  9.  *
  10.  * @license LGPL-3.0-or-later
  11.  */
  13. namespace Contao\CoreBundle\EventListener;
  15. use Contao\CoreBundle\Routing\ScopeMatcher;
  16. use Contao\User;
  17. use Symfony\Component\HttpFoundation\Request;
  18. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  19. use Symfony\Component\Security\Core\Security;
  21. /**
  22.  * @internal
  23.  */
  24. class StoreRefererListener
  25. {
  26.     /**
  27.      * @var Security
  28.      */
  29.     private $security;
  31.     /**
  32.      * @var ScopeMatcher
  33.      */
  34.     private $scopeMatcher;
  36.     public function __construct(Security $security, ScopeMatcher $scopeMatcher)
  37.     {
  38.         $this->security = $security;
  39.         $this->scopeMatcher = $scopeMatcher;
  40.     }
  42.     /**
  43.      * Stores the referer in the session.
  44.      */
  45.     public function __invoke(ResponseEvent $event): void
  46.     {
  47.         if (!$this->scopeMatcher->isBackendMasterRequest($event)) {
  48.             return;
  49.         }
  51.         $request = $event->getRequest();
  53.         if (!$request->isMethod(Request::METHOD_GET)) {
  54.             return;
  55.         }
  57.         $response = $event->getResponse();
  59.         if (200 !== $response->getStatusCode()) {
  60.             return;
  61.         }
  63.         $user = $this->security->getUser();
  65.         if (!$user instanceof User) {
  66.             return;
  67.         }
  69.         if (!$this->canModifyBackendSession($request)) {
  70.             return;
  71.         }
  73.         if (!$request->hasSession()) {
  74.             throw new \RuntimeException('The request did not contain a session.');
  75.         }
  77.         $session = $request->getSession();
  78.         $key = $request->query->has('popup') ? 'popupReferer' : 'referer';
  79.         $refererId = $request->attributes->get('_contao_referer_id');
  80.         $referers = $this->prepareBackendReferer($refererId, $session->get($key));
  81.         $ref = $request->query->get('ref', '');
  83.         // Move current to last if the referer is in both the URL and the session
  84.         if ('' !== $ref && isset($referers[$ref])) {
  85.             $referers[$refererId] = array_merge($referers[$ref], $referers[$refererId]);
  86.             $referers[$refererId]['last'] = $referers[$ref]['current'];
  87.         }
  89.         // Set new current referer
  90.         $referers[$refererId]['current'] = $this->getRelativeRequestUri($request);
  92.         // Makes testing easier
  93.         ksort($referers[$refererId]);
  94.         ksort($referers);
  96.         $session->set($key, $referers);
  97.     }
  99.     private function canModifyBackendSession(Request $request): bool
  100.     {
  101.         return !$request->query->has('act')
  102.             && !$request->query->has('key')
  103.             && !$request->query->has('token')
  104.             && !$request->query->has('state')
  105.             && 'feRedirect' !== $request->query->get('do')
  106.             && 'contao_backend' === $request->attributes->get('_route')
  107.             && !$request->isXmlHttpRequest();
  108.     }
  110.     /**
  111.      * @return array<string,array<string,string>>
  112.      */
  113.     private function prepareBackendReferer(string $refererId, array $referers = null): array
  114.     {
  115.         if (!\is_array($referers)) {
  116.             $referers = [];
  117.         }
  119.         if (!isset($referers[$refererId]) || !\is_array($referers[$refererId])) {
  120.             $referers[$refererId] = end($referers) ?: ['last' => ''];
  121.         }
  123.         // Make sure we never have more than 25 different referer URLs
  124.         while (\count($referers) >= 25) {
  125.             array_shift($referers);
  126.         }
  128.         return $referers;
  129.     }
  131.     /**
  132.      * Returns the current request URI relative to the base path.
  133.      */
  134.     private function getRelativeRequestUri(Request $request): string
  135.     {
  136.         return (string) substr($request->getRequestUri(), \strlen($request->getBasePath()) + 1);
  137.     }
  138. }