vendor/pimcore/pimcore/bundles/EcommerceFrameworkBundle/EventListener/Frontend/TrackingCodeFlashMessageListener.php line 95

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Commercial License (PCL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  14.  */
  16. namespace Pimcore\Bundle\EcommerceFrameworkBundle\EventListener\Frontend;
  18. use Pimcore\Bundle\CoreBundle\EventListener\Traits\PimcoreContextAwareTrait;
  19. use Pimcore\Bundle\EcommerceFrameworkBundle\Tracking\TrackingCodeAwareInterface;
  20. use Pimcore\Bundle\EcommerceFrameworkBundle\Tracking\TrackingManager;
  21. use Pimcore\Http\Request\Resolver\PimcoreContextResolver;
  22. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  23. use Symfony\Component\HttpFoundation\Cookie;
  24. use Symfony\Component\HttpFoundation\Session\Session;
  25. use Symfony\Component\HttpFoundation\Session\SessionInterface;
  26. use Symfony\Component\HttpKernel\Event\RequestEvent;
  27. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  28. use Symfony\Component\HttpKernel\KernelEvents;
  30. /**
  31.  * @internal
  32.  */
  33. class TrackingCodeFlashMessageListener implements EventSubscriberInterface
  34. {
  35.     use PimcoreContextAwareTrait;
  37.     const FLASH_MESSAGE_BAG_KEY = 'ecommerceframework_trackingcode_flashmessagelistener';
  39.     /**
  40.      * @var SessionInterface
  41.      */
  42.     protected $session;
  44.     /**
  45.      * @var TrackingManager
  46.      */
  47.     protected $trackingManger;
  49.     public function __construct(SessionInterface $session, TrackingManager $trackingManager)
  50.     {
  51.         $this->session = $session;
  52.         $this->trackingManger = $trackingManager;
  53.     }
  55.     public static function getSubscribedEvents()
  56.     {
  57.         return [
  58.             KernelEvents::REQUEST => 'onKernelRequest',
  59.             KernelEvents::RESPONSE => 'onKernelResponse',
  60.         ];
  61.     }
  63.     public function onKernelRequest(RequestEvent $event)
  64.     {
  65.         $request = $event->getRequest();
  67.         if (!$this->matchesPimcoreContext($request, PimcoreContextResolver::CONTEXT_DEFAULT)) {
  68.             return;
  69.         }
  71.         if (!$event->isMainRequest()) {
  72.             return;
  73.         }
  75.         // Check FlashBag cookie exists to avoid autostart session by accessing the FlashBag.
  76.         $flashBagCookie = (bool)$request->cookies->get(self::FLASH_MESSAGE_BAG_KEY);
  77.         if ($flashBagCookie && $this->session instanceof Session) {
  78.             $trackedCodes = $this->session->getFlashBag()->get(self::FLASH_MESSAGE_BAG_KEY);
  80.             if (is_array($trackedCodes) && count($trackedCodes)) {
  81.                 foreach ($this->trackingManger->getTrackers() as $tracker) {
  82.                     if ($tracker instanceof TrackingCodeAwareInterface && isset($trackedCodes[get_class($tracker)])) {
  83.                         foreach ($trackedCodes[get_class($tracker)] as $trackedCode) {
  84.                             $tracker->trackCode($trackedCode);
  85.                         }
  86.                     }
  87.                 }
  88.             }
  89.         }
  90.     }
  92.     /**
  93.      * @param ResponseEvent $event
  94.      */
  95.     public function onKernelResponse(ResponseEvent $event)
  96.     {
  97.         $response = $event->getResponse();
  98.         $request = $event->getRequest();
  100.         /**
  101.          * If tracking codes are forwarded as FlashMessage, then set a cookie which is checked in subsequent request for successful handshake
  102.          * else clear cookie, if set and FlashBag is already processed.
  103.          */
  104.         if (
  105.             $this->session instanceof Session &&
  106.             $this->session->isStarted() &&
  107.             $this->session->getFlashBag()->has(self::FLASH_MESSAGE_BAG_KEY)
  108.         ) {
  109.             $response->headers->setCookie(new Cookie(self::FLASH_MESSAGE_BAG_KEY, '1'));
  110.             $response->headers->set('X-Pimcore-Output-Cache-Disable-Reason', 'Tracking Codes Passed');
  111.         } elseif ($request->cookies->has(self::FLASH_MESSAGE_BAG_KEY)) {
  112.             $response->headers->clearCookie(self::FLASH_MESSAGE_BAG_KEY);
  113.         }
  114.     }
  115. }