pimcore/lib/Pimcore/Analytics/Piwik/EventListener/TrackingCodeListener.php line 71

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\Analytics\Piwik\EventListener;
  20. use Pimcore\Analytics\Piwik\Tracker;
  21. use Pimcore\Bundle\CoreBundle\EventListener\Traits\PimcoreContextAwareTrait;
  22. use Pimcore\Bundle\CoreBundle\EventListener\Traits\ResponseInjectionTrait;
  23. use Pimcore\Http\Request\Resolver\PimcoreContextResolver;
  24. use Pimcore\Tool;
  25. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  26. use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
  27. use Symfony\Component\HttpKernel\KernelEvents;
  29. class TrackingCodeListener implements EventSubscriberInterface
  30. {
  31.     use ResponseInjectionTrait;
  32.     use PimcoreContextAwareTrait;
  34.     /**
  35.      * @var Tracker
  36.      */
  37.     private $tracker;
  39.     /**
  40.      * @var bool
  41.      */
  42.     private $enabled = true;
  44.     public function __construct(Tracker $tracker)
  45.     {
  46.         $this->tracker = $tracker;
  47.     }
  49.     public static function getSubscribedEvents()
  50.     {
  51.         return [
  52.             KernelEvents::RESPONSE => ['onKernelResponse', -110]
  53.         ];
  54.     }
  56.     public function enable()
  57.     {
  58.         $this->enabled = true;
  59.     }
  61.     public function disable()
  62.     {
  63.         $this->enabled = false;
  64.     }
  66.     public function isEnabled(): bool
  67.     {
  68.         return $this->enabled;
  69.     }
  71.     public function onKernelResponse(FilterResponseEvent $event)
  72.     {
  73.         if (!$this->enabled) {
  74.             return;
  75.         }
  77.         $request = $event->getRequest();
  78.         if (!$event->isMasterRequest()) {
  79.             return;
  80.         }
  82.         // only inject analytics code on non-admin requests
  83.         if (!$this->matchesPimcoreContext($request, PimcoreContextResolver::CONTEXT_DEFAULT)) {
  84.             return;
  85.         }
  87.         // it's standard industry practice to exclude tracking if the request includes
  88.         // the header 'X-Purpose:preview'
  89.         if ($request->server->get('HTTP_X_PURPOSE') === 'preview') {
  90.             return;
  91.         }
  93.         // output filters are disabled
  94.         if (!Tool::useFrontendOutputFilters($event->getRequest())) {
  95.             return;
  96.         }
  98.         $response = $event->getResponse();
  99.         if (!$this->isHtmlResponse($response)) {
  100.             return;
  101.         }
  103.         $code = $this->tracker->generateCode();
  104.         if (empty($code)) {
  105.             return;
  106.         }
  108.         $this->injectBeforeHeadEnd($response, $code);
  109.     }
  110. }