vendor/pimcore/pimcore/lib/Targeting/EventListener/TargetingSessionBagListener.php line 99

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\Targeting\EventListener;
  20. use Pimcore\Event\Cache\FullPage\IgnoredSessionKeysEvent;
  21. use Pimcore\Event\Cache\FullPage\PrepareResponseEvent;
  22. use Pimcore\Event\FullPageCacheEvents;
  23. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  24. use Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag;
  25. use Symfony\Component\HttpFoundation\Session\SessionInterface;
  26. use Symfony\Component\HttpKernel\Event\RequestEvent;
  27. use Symfony\Component\HttpKernel\KernelEvents;
  29. class TargetingSessionBagListener implements EventSubscriberInterface
  30. {
  31.     const TARGETING_BAG_SESSION = 'pimcore_targeting_session';
  33.     const TARGETING_BAG_VISITOR = 'pimcore_targeting_visitor';
  35.     /**
  36.      * {@inheritdoc}
  37.      *
  38.      * @return array
  39.      */
  40.     public static function getSubscribedEvents()//: array
  41.     {
  42.         return [
  43.             FullPageCacheEvents::IGNORED_SESSION_KEYS => 'configureIgnoredSessionKeys',
  44.             FullPageCacheEvents::PREPARE_RESPONSE => 'prepareFullPageCacheResponse',
  45.             //run after Symfony\Component\HttpKernel\EventListener\SessionListener
  46.             KernelEvents::REQUEST => ['onKernelRequest', 127],
  47.         ];
  48.     }
  50.     /**
  51.      * @param RequestEvent $event
  52.      */
  53.     public function onKernelRequest(RequestEvent $event)
  54.     {
  55.         if (!$event->isMainRequest()) {
  56.             return;
  57.         }
  59.         $session = $event->getRequest()->getSession();
  61.         //do not register bags, if session is already started
  62.         if ($session->isStarted()) {
  63.             return;
  64.         }
  66.         $this->configure($session);
  67.     }
  69.     /**
  70.      * @param SessionInterface $session
  71.      *
  72.      */
  73.     public function configure(SessionInterface $session)
  74.     {
  75.         $sessionBag = new AttributeBag('_' . self::TARGETING_BAG_SESSION);
  76.         $sessionBag->setName(self::TARGETING_BAG_SESSION);
  78.         $visitorBag = new AttributeBag('_' . self::TARGETING_BAG_VISITOR);
  79.         $visitorBag->setName(self::TARGETING_BAG_VISITOR);
  81.         $session->registerBag($sessionBag);
  82.         $session->registerBag($visitorBag);
  83.     }
  85.     public function configureIgnoredSessionKeys(IgnoredSessionKeysEvent $event)
  86.     {
  87.         // configures full page cache to ignore session data in targeting storage
  88.         $event->setKeys(array_merge($event->getKeys(), [
  89.             '_' . self::TARGETING_BAG_SESSION,
  90.             '_' . self::TARGETING_BAG_VISITOR,
  91.         ]));
  92.     }
  94.     /**
  95.      * Removes session cookie from cached response
  96.      *
  97.      * @param PrepareResponseEvent $event
  98.      */
  99.     public function prepareFullPageCacheResponse(PrepareResponseEvent $event)
  100.     {
  101.         $request = $event->getRequest();
  102.         $response = $event->getResponse();
  104.         if (!$request->hasSession()) {
  105.             return;
  106.         }
  108.         $sessionName = $request->getSession()->getName();
  109.         if (empty($sessionName)) {
  110.             return;
  111.         }
  113.         $cookies = $response->headers->getCookies();
  115.         foreach ($cookies as $cookie) {
  116.             if ($cookie->getName() === $sessionName) {
  117.                 $response->headers->removeCookie(
  118.                     $cookie->getName(),
  119.                     $cookie->getPath(),
  120.                     $cookie->getDomain()
  121.                 );
  122.             }
  123.         }
  124.     }
  125. }