pimcore/lib/Pimcore/Bundle/CoreBundle/EventListener/Frontend/GoogleAnalyticsCodeListener.php line 44

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 Enterprise License (PEL)
  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 PEL
  16.  */
  18. namespace Pimcore\Bundle\CoreBundle\EventListener\Frontend;
  20. use Pimcore\Analytics\Google\Tracker;
  21. use Pimcore\Bundle\CoreBundle\EventListener\Traits\EnabledTrait;
  22. use Pimcore\Bundle\CoreBundle\EventListener\Traits\PimcoreContextAwareTrait;
  23. use Pimcore\Bundle\CoreBundle\EventListener\Traits\ResponseInjectionTrait;
  24. use Pimcore\Http\Request\Resolver\PimcoreContextResolver;
  25. use Pimcore\Tool;
  26. use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
  28. class GoogleAnalyticsCodeListener
  29. {
  30.     use EnabledTrait;
  31.     use ResponseInjectionTrait;
  32.     use PimcoreContextAwareTrait;
  34.     /**
  35.      * @var Tracker
  36.      */
  37.     private $tracker;
  39.     public function __construct(Tracker $tracker)
  40.     {
  41.         $this->tracker = $tracker;
  42.     }
  44.     public function onKernelResponse(FilterResponseEvent $event)
  45.     {
  46.         if (!$this->isEnabled()) {
  47.             return;
  48.         }
  50.         $request = $event->getRequest();
  51.         if (!$event->isMasterRequest()) {
  52.             return;
  53.         }
  55.         // only inject analytics code on non-admin requests
  56.         if (!$this->matchesPimcoreContext($request, PimcoreContextResolver::CONTEXT_DEFAULT)) {
  57.             return;
  58.         }
  60.         if (!Tool::useFrontendOutputFilters()) {
  61.             return;
  62.         }
  64.         // It's standard industry practice to exclude tracking if the request includes the header 'X-Purpose:preview'
  65.         if ($request->server->get('HTTP_X_PURPOSE') === 'preview') {
  66.             return;
  67.         }
  69.         $response = $event->getResponse();
  70.         if (!$this->isHtmlResponse($response)) {
  71.             return;
  72.         }
  74.         $code = $this->tracker->generateCode();
  75.         if (empty($code)) {
  76.             return;
  77.         }
  79.         $this->injectBeforeHeadEnd($response, $code);
  80.     }
  81. }