vendor/sulu/sulu/src/Sulu/Bundle/WebsiteBundle/EventListener/AppendAnalyticsListener.php line 86

  1. <?php
  3. /*
  4.  * This file is part of Sulu.
  5.  *
  6.  * (c) Sulu GmbH
  7.  *
  8.  * This source file is subject to the MIT license that is bundled
  9.  * with this source code in the file LICENSE.
  10.  */
  12. namespace Sulu\Bundle\WebsiteBundle\EventListener;
  14. use Sulu\Bundle\WebsiteBundle\Entity\AnalyticsInterface;
  15. use Sulu\Bundle\WebsiteBundle\Entity\AnalyticsRepositoryInterface;
  16. use Sulu\Component\Webspace\Analyzer\RequestAnalyzerInterface;
  17. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  18. use Twig\Environment;
  20. /**
  21.  * Appends analytics scripts into body.
  22.  */
  23. class AppendAnalyticsListener
  24. {
  25.     private static $positions = [
  26.         'head-open' => [
  27.             'regex' => '/(<head [^>]*>|<head>)/',
  28.             'sprintf' => '$1%s',
  29.         ],
  30.         'head-close' => [
  31.             'regex' => '/<\/head>/',
  32.             'sprintf' => '%s</head>',
  33.         ],
  34.         'body-open' => [
  35.             'regex' => '/(<body [^>]*>|<body>)/',
  36.             'sprintf' => '$1%s',
  37.         ],
  38.         'body-close' => [
  39.             'regex' => '/<\/body>/',
  40.             'sprintf' => '%s</body>',
  41.         ],
  42.     ];
  44.     /**
  45.      * @var Environment
  46.      */
  47.     private $engine;
  49.     /**
  50.      * @var RequestAnalyzerInterface
  51.      */
  52.     private $requestAnalyzer;
  54.     /**
  55.      * @var AnalyticsRepositoryInterface
  56.      */
  57.     private $analyticsRepository;
  59.     /**
  60.      * @var string
  61.      */
  62.     private $environment;
  64.     /**
  65.      * @var bool
  66.      */
  67.     private $preview;
  69.     public function __construct(
  70.         Environment $engine,
  71.         RequestAnalyzerInterface $requestAnalyzer,
  72.         AnalyticsRepositoryInterface $analyticsRepository,
  73.         $environment,
  74.         bool $preview = false
  75.     ) {
  76.         $this->engine = $engine;
  77.         $this->requestAnalyzer = $requestAnalyzer;
  78.         $this->analyticsRepository = $analyticsRepository;
  79.         $this->environment = $environment;
  80.         $this->preview = $preview;
  81.     }
  83.     /**
  84.      * Appends analytics scripts into body.
  85.      */
  86.     public function onResponse(ResponseEvent $event)
  87.     {
  88.         if (!$event->isMainRequest()
  89.             || $this->preview
  90.         ) {
  91.             return;
  92.         }
  94.         $response = $event->getResponse();
  96.         if (0 !== \strpos($response->headers->get('Content-Type'), 'text/html')
  97.             || !$response->getContent()
  98.             || null === $this->requestAnalyzer->getPortalInformation()
  99.         ) {
  100.             return;
  101.         }
  103.         $portalUrl = $this->requestAnalyzer->getAttribute('urlExpression');
  105.         if (!$portalUrl) {
  106.             return;
  107.         }
  109.         $analyticsArray = $this->analyticsRepository->findByUrl(
  110.             $portalUrl,
  111.             $this->requestAnalyzer->getPortalInformation()->getWebspaceKey(),
  112.             $this->environment
  113.         );
  115.         $analyticsContent = [];
  116.         foreach ($analyticsArray as $analytics) {
  117.             $analyticsContent = $this->generateAnalyticsContent($analyticsContent, $analytics);
  118.         }
  120.         $response = $event->getResponse();
  121.         $response->setContent($this->setAnalyticsContent($response->getContent(), $analyticsContent));
  122.     }
  124.     /**
  125.      * Generate content for each possible position.
  126.      *
  127.      * @return array
  128.      */
  129.     protected function generateAnalyticsContent(array $analyticsContent, AnalyticsInterface $analytics)
  130.     {
  131.         foreach (\array_keys(self::$positions) as $position) {
  132.             $template = '@SuluWebsite/Analytics/' . $analytics->getType() . '/' . $position . '.html.twig';
  134.             if (!$this->engine->getLoader()->exists($template)) {
  135.                 continue;
  136.             }
  138.             $content = $this->engine->render($template, ['analytics' => $analytics]);
  139.             if (!$content) {
  140.                 continue;
  141.             }
  143.             if (!\array_key_exists($position, $analyticsContent)) {
  144.                 $analyticsContent[$position] = '';
  145.             }
  147.             $analyticsContent[$position] .= $content;
  148.         }
  150.         return $analyticsContent;
  151.     }
  153.     /**
  154.      * Set the generated content for each position.
  155.      *
  156.      * @param string $responseContent
  157.      *
  158.      * @return string
  159.      */
  160.     protected function setAnalyticsContent($responseContent, array $analyticsContent)
  161.     {
  162.         foreach ($analyticsContent as $id => $content) {
  163.             if (!$content) {
  164.                 continue;
  165.             }
  167.             $responseContent = \preg_replace(
  168.                 self::$positions[$id]['regex'],
  169.                 \sprintf(self::$positions[$id]['sprintf'], $content),
  170.                 $responseContent
  171.             );
  172.         }
  174.         return $responseContent;
  175.     }
  176. }