custom/plugins/DIScoGA4/src/Storefront/Controller/CookieControllerDecorator.php line 72

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace DISco\GA4\Storefront\Controller;
  5. use ReflectionMethod;
  6. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
  7. use Shopware\Core\Framework\Log\Package;
  8. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  9. use Shopware\Core\System\SystemConfig\SystemConfigService;
  10. use Shopware\Storefront\Controller\CookieController;
  11. use Shopware\Storefront\Framework\Captcha\GoogleReCaptchaV2;
  12. use Shopware\Storefront\Framework\Captcha\GoogleReCaptchaV3;
  13. use Shopware\Storefront\Framework\Cookie\CookieProviderInterface;
  14. use Symfony\Component\HttpFoundation\Response;
  15. use Symfony\Component\Routing\Annotation\Route;
  16. use Symfony\Contracts\Translation\TranslatorInterface;
  17. use Twig\Environment;
  19. /**
  20.  * Support v6.4.1
  21.  * @Shopware\Core\Framework\Routing\Annotation\RouteScope(scopes={"storefront"})
  22.  */
  23. #[Route(defaults: ['_routeScope' => ['storefront']])]
  24. #[Package('storefront')]
  25. class CookieControllerDecorator extends CookieController
  26. {
  27.     private CookieProviderInterface $cookieProvider;
  29.     private CookieController $originalService;
  31.     private SystemConfigService $systemConfigService;
  33.     private TranslatorInterface $translator;
  35.     private EntityRepository $salesChannelAnalyticsRepository;
  37.     public function __construct(
  38.         CookieController $service,
  39.         CookieProviderInterface $cookieProvider,
  40.         SystemConfigService $systemConfigService,
  41.         TranslatorInterface $translator,
  42.         EntityRepository $salesChannelAnalyticsRepository
  43.     ) {
  44.         $numberOfParameters = (new ReflectionMethod(parent::class, '__construct'))->getNumberOfRequiredParameters();
  45.         if (3 === $numberOfParameters) { // For SW 6.6.*
  46.             parent::__construct($cookieProvider, $systemConfigService, $salesChannelAnalyticsRepository);
  47.         } else {
  48.             parent::__construct($cookieProvider, $systemConfigService);
  49.         }
  50.         $this->originalService = $service;
  51.         $this->cookieProvider = $cookieProvider;
  52.         $this->systemConfigService = $systemConfigService;
  53.         $this->translator = $translator;
  54.     }
  56.     public function setTwig(Environment $twig): void
  57.     {
  58.         if (is_callable('parent::setTwig')) {
  59.             parent::setTwig($twig);
  60.         }
  61.     }
  63.     public function getDecorated(): CookieController
  64.     {
  65.         return $this->originalService;
  66.     }
  68.     /**
  69.      * @Route("/cookie/offcanvas", name="frontend.cookie.offcanvas", options={"seo"="false"}, methods={"GET"}, defaults={"XmlHttpRequest"=true})
  70.      */
  71.     #[Route(path: '/cookie/offcanvas', name: 'frontend.cookie.offcanvas', options: ['seo' => false], defaults: ['XmlHttpRequest' => true], methods: ['GET'])]
  72.     public function offcanvas(SalesChannelContext $context): Response
  73.     {
  74.         $cookieGroups = $this->cookieProvider->getCookieGroups();
  76.         $cookieGroups = $this->filterGoogleAnalyticsCookie($context, $cookieGroups);
  78.         $cookieGroups = $this->filterComfortFeaturesCookie($context->getSalesChannelId(), $cookieGroups);
  80.         $cookieGroups = $this->filterGoogleReCaptchaCookie($context->getSalesChannelId(), $cookieGroups);
  82.         $cookieGroups = $this->filterGA4GoogleTagCookie($context->getSalesChannelId(), $cookieGroups);
  83.         $cookieGroups = $this->filterGA4GoogleAdsCookie($context->getSalesChannelId(), $cookieGroups);
  84.         $cookieGroups = $this->filterGA4GoogleAnalyticsCookie($context->getSalesChannelId(), $cookieGroups);
  86.         $response = $this->renderStorefront('@Storefront/storefront/layout/cookie/cookie-configuration.html.twig', ['cookieGroups' => $cookieGroups]);
  88.         $response->headers->set('x-robots-tag', 'noindex,follow');
  90.         return $response;
  91.     }
  93.     /**
  94.      * @Route("/cookie/permission", name="frontend.cookie.permission", options={"seo"="false"}, methods={"GET"}, defaults={"XmlHttpRequest"=true})
  95.      */
  96.     #[Route(path: '/cookie/permission', name: 'frontend.cookie.permission', options: ['seo' => false], defaults: ['XmlHttpRequest' => true], methods: ['GET'])]
  97.     public function permission(SalesChannelContext $context): Response
  98.     {
  100.         $cookieGroups = $this->cookieProvider->getCookieGroups();
  102.         $cookieGroups = $this->filterGoogleAnalyticsCookie($context, $cookieGroups);
  104.         $cookieGroups = $this->filterComfortFeaturesCookie($context->getSalesChannelId(), $cookieGroups);
  106.         $cookieGroups = $this->filterGoogleReCaptchaCookie($context->getSalesChannelId(), $cookieGroups);
  108.         $cookieGroups = $this->filterGA4GoogleTagCookie($context->getSalesChannelId(), $cookieGroups);
  109.         $cookieGroups = $this->filterGA4GoogleAdsCookie($context->getSalesChannelId(), $cookieGroups);
  110.         $cookieGroups = $this->filterGA4GoogleAnalyticsCookie($context->getSalesChannelId(), $cookieGroups);
  112.         $response = $this->renderStorefront('@Storefront/storefront/layout/cookie/cookie-permission.html.twig', ['cookieGroups' => $cookieGroups]);
  114.         $response->headers->set('x-robots-tag', 'noindex,follow');
  116.         return $response;
  117.     }
  119.     private function filterGA4GoogleTagCookie(string $salesChannelId, array $cookieGroups): array
  120.     {
  121.         if ($this->systemConfigService->get('DIScoGA4.config.googleTagEnabled',$salesChannelId)) {
  122.             return $cookieGroups;
  123.         }
  125.         $filteredGroups = [];
  127.         foreach ($cookieGroups as $cookieGroup) {
  128.             if ($this->translator->trans($cookieGroup['snippet_name']) == $this->translator->trans('cookie.googletag_name')) {
  129.                 $cookieGroup['entries'] = array_filter($cookieGroup['entries'], function ($item) {
  130.                     return $item['snippet_name'] !== 'cookie.cookie-gtag';
  131.                 });
  132.                 // Only add cookie group if it has entries
  133.                 if (\count($cookieGroup['entries']) > 0) {
  134.                     $filteredGroups[] = $cookieGroup;
  135.                 }
  137.                 continue;
  138.             }
  139.             $filteredGroups[] = $cookieGroup;
  140.         }
  142.         return $filteredGroups;
  143.     }
  145.     private function filterGA4GoogleAdsCookie(string $salesChannelId, array $cookieGroups): array
  146.     {
  147.         if ($this->systemConfigService->get('DIScoGA4.config.googleAdsEnabled',$salesChannelId)) {
  148.             return $cookieGroups;
  149.         }
  151.         $filteredGroups = [];
  153.         foreach ($cookieGroups as $cookieGroup) {
  154.             if ($this->translator->trans($cookieGroup['snippet_name']) == $this->translator->trans('cookie.marketing_name')) {
  155.                 $cookieGroup['entries'] = array_filter($cookieGroup['entries'], function ($item) {
  156.                     return $item['snippet_name'] !== 'cookie.cookie-gads';
  157.                 });
  158.                 // Only add cookie group if it has entries
  159.                 if (\count($cookieGroup['entries']) > 0) {
  160.                     $filteredGroups[] = $cookieGroup;
  161.                 }
  163.                 continue;
  164.             }
  165.             $filteredGroups[] = $cookieGroup;
  166.         }
  168.         return $filteredGroups;
  169.     }
  171.     private function filterGA4GoogleAnalyticsCookie(string $salesChannelId, array $cookieGroups): array
  172.     {
  173.         if ($this->systemConfigService->get('DIScoGA4.config.googleAnalyticsEnabled',$salesChannelId)) {
  174.             return $cookieGroups;
  175.         }
  177.         $filteredGroups = [];
  179.         foreach ($cookieGroups as $cookieGroup) {
  180.             if ($this->translator->trans($cookieGroup['snippet_name']) == $this->translator->trans('cookie.statistics_name')) {
  181.                 $cookieGroup['entries'] = array_filter($cookieGroup['entries'], function ($item) {
  182.                     return $item['snippet_name'] !== 'cookie.cookie-ga';
  183.                 });
  184.                 // Only add cookie group if it has entries
  185.                 if (\count($cookieGroup['entries']) > 0) {
  186.                     $filteredGroups[] = $cookieGroup;
  187.                 }
  189.                 continue;
  190.             }
  191.             $filteredGroups[] = $cookieGroup;
  192.         }
  194.         return $filteredGroups;
  195.     }
  197.     private function filterGoogleAnalyticsCookie(SalesChannelContext $context, array $cookieGroups): array
  198.     {
  199.         if ($context->getSalesChannel()->getAnalytics() && $context->getSalesChannel()->getAnalytics()->isActive()) {
  200.             return $cookieGroups;
  201.         }
  203.         $filteredGroups = [];
  205.         foreach ($cookieGroups as $cookieGroup) {
  206.             if ($cookieGroup['snippet_name'] === 'cookie.groupStatistical') {
  207.                 $cookieGroup['entries'] = array_filter($cookieGroup['entries'], function ($item) {
  208.                     return $item['snippet_name'] !== 'cookie.groupStatisticalGoogleAnalytics';
  209.                 });
  210.                 // Only add statistics cookie group if it has entries
  211.                 if (\count($cookieGroup['entries']) > 0) {
  212.                     $filteredGroups[] = $cookieGroup;
  213.                 }
  215.                 continue;
  216.             }
  217.             $filteredGroups[] = $cookieGroup;
  218.         }
  220.         return $filteredGroups;
  221.     }
  223.     private function filterComfortFeaturesCookie(string $salesChannelId, array $cookieGroups): array
  224.     {
  225.         foreach ($cookieGroups as $groupIndex => $cookieGroup) {
  226.             if ($cookieGroup['snippet_name'] !== 'cookie.groupComfortFeatures') {
  227.                 continue;
  228.             }
  230.             foreach ($cookieGroup['entries'] as $entryIndex => $entry) {
  231.                 if ($entry['snippet_name'] !== 'cookie.groupComfortFeaturesWishlist') {
  232.                     continue;
  233.                 }
  235.                 if (!$this->systemConfigService->get('core.cart.wishlistEnabled', $salesChannelId)) {
  236.                     unset($cookieGroups[$groupIndex]['entries'][$entryIndex]);
  237.                 }
  238.             }
  240.             if (\count($cookieGroups[$groupIndex]['entries']) === 0) {
  241.                 unset($cookieGroups[$groupIndex]);
  242.             }
  243.         }
  245.         return $cookieGroups;
  246.     }
  248.     private function filterGoogleReCaptchaCookie(string $salesChannelId, array $cookieGroups): array
  249.     {
  250.         foreach ($cookieGroups as $groupIndex => $cookieGroup) {
  251.             if ($cookieGroup['snippet_name'] !== 'cookie.groupRequired') {
  252.                 continue;
  253.             }
  255.             foreach ($cookieGroup['entries'] as $entryIndex => $entry) {
  256.                 if ($entry['snippet_name'] !== 'cookie.groupRequiredCaptcha') {
  257.                     continue;
  258.                 }
  260.                 $activeGreCaptchaV2 = $this->systemConfigService->get('core.basicInformation.activeCaptchasV2.' . GoogleReCaptchaV2::CAPTCHA_NAME . '.isActive', $salesChannelId) ?? false;
  261.                 $activeGreCaptchaV3 = $this->systemConfigService->get('core.basicInformation.activeCaptchasV2.' . GoogleReCaptchaV3::CAPTCHA_NAME . '.isActive', $salesChannelId) ?? false;
  263.                 if (!$activeGreCaptchaV2 && !$activeGreCaptchaV3) {
  264.                     unset($cookieGroups[$groupIndex]['entries'][$entryIndex]);
  265.                 }
  266.             }
  268.             if (\count($cookieGroups[$groupIndex]['entries']) === 0) {
  269.                 unset($cookieGroups[$groupIndex]);
  270.             }
  271.         }
  273.         return $cookieGroups;
  274.     }
  275. }