vendor/shopware/storefront/Controller/CookieController.php line 59

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Controller;
  5. use Shopware\Core\Framework\Routing\Annotation\RouteScope;
  6. use Shopware\Core\Framework\Routing\Annotation\Since;
  7. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  8. use Shopware\Core\System\SystemConfig\SystemConfigService;
  9. use Shopware\Storefront\Framework\Captcha\GoogleReCaptchaV2;
  10. use Shopware\Storefront\Framework\Captcha\GoogleReCaptchaV3;
  11. use Shopware\Storefront\Framework\Cookie\CookieProviderInterface;
  12. use Symfony\Component\HttpFoundation\Response;
  13. use Symfony\Component\Routing\Annotation\Route;
  15. /**
  16.  * Returns the cookie-configuration.html.twig template including all cookies returned by the "getCookieGroup"-method
  17.  *
  18.  * Cookies are returned within groups, groups require the "group" attribute
  19.  * A group is structured as described above the "getCookieGroup"-method
  20.  *
  21.  * @Route(defaults={"_routeScope"={"storefront"}})
  22.  *
  23.  * @deprecated tag:v6.5.0 - reason:becomes-internal - Will be internal
  24.  */
  25. class CookieController extends StorefrontController
  26. {
  27.     /**
  28.      * @var CookieProviderInterface
  29.      */
  30.     private $cookieProvider;
  32.     /**
  33.      * @var SystemConfigService
  34.      */
  35.     private $systemConfigService;
  37.     /**
  38.      * @internal
  39.      */
  40.     public function __construct(CookieProviderInterface $cookieProvider, SystemConfigService $systemConfigService)
  41.     {
  42.         $this->cookieProvider = $cookieProvider;
  43.         $this->systemConfigService = $systemConfigService;
  44.     }
  46.     /**
  47.      * @Since("6.1.0.0")
  48.      * @Route("/cookie/offcanvas", name="frontend.cookie.offcanvas", options={"seo"="false"}, methods={"GET"}, defaults={"XmlHttpRequest"=true})
  49.      */
  50.     public function offcanvas(SalesChannelContext $context): Response
  51.     {
  52.         $cookieGroups = $this->cookieProvider->getCookieGroups();
  53.         $cookieGroups = $this->filterGoogleAnalyticsCookie($context, $cookieGroups);
  55.         $cookieGroups = $this->filterComfortFeaturesCookie($context->getSalesChannelId(), $cookieGroups);
  57.         $cookieGroups = $this->filterGoogleReCaptchaCookie($context->getSalesChannelId(), $cookieGroups);
  59.         $response = $this->renderStorefront('@Storefront/storefront/layout/cookie/cookie-configuration.html.twig', ['cookieGroups' => $cookieGroups]);
  60.         $response->headers->set('x-robots-tag', 'noindex,follow');
  62.         return $response;
  63.     }
  65.     /**
  66.      * @Since("6.1.0.0")
  67.      * @Route("/cookie/permission", name="frontend.cookie.permission", options={"seo"="false"}, methods={"GET"}, defaults={"XmlHttpRequest"=true})
  68.      */
  69.     public function permission(SalesChannelContext $context): Response
  70.     {
  71.         $cookieGroups = $this->cookieProvider->getCookieGroups();
  72.         $cookieGroups = $this->filterGoogleAnalyticsCookie($context, $cookieGroups);
  74.         $cookieGroups = $this->filterComfortFeaturesCookie($context->getSalesChannelId(), $cookieGroups);
  76.         $cookieGroups = $this->filterGoogleReCaptchaCookie($context->getSalesChannelId(), $cookieGroups);
  78.         $response = $this->renderStorefront('@Storefront/storefront/layout/cookie/cookie-permission.html.twig', ['cookieGroups' => $cookieGroups]);
  79.         $response->headers->set('x-robots-tag', 'noindex,follow');
  81.         return $response;
  82.     }
  84.     private function filterGoogleAnalyticsCookie(SalesChannelContext $context, array $cookieGroups): array
  85.     {
  86.         if ($context->getSalesChannel()->getAnalytics() && $context->getSalesChannel()->getAnalytics()->isActive()) {
  87.             return $cookieGroups;
  88.         }
  90.         $filteredGroups = [];
  92.         foreach ($cookieGroups as $cookieGroup) {
  93.             if ($cookieGroup['snippet_name'] === 'cookie.groupStatistical') {
  94.                 $cookieGroup['entries'] = array_filter($cookieGroup['entries'], function ($item) {
  95.                     return $item['snippet_name'] !== 'cookie.groupStatisticalGoogleAnalytics';
  96.                 });
  97.                 // Only add statistics cookie group if it has entries
  98.                 if (\count($cookieGroup['entries']) > 0) {
  99.                     $filteredGroups[] = $cookieGroup;
  100.                 }
  102.                 continue;
  103.             }
  104.             $filteredGroups[] = $cookieGroup;
  105.         }
  107.         return $filteredGroups;
  108.     }
  110.     private function filterComfortFeaturesCookie(string $salesChannelId, array $cookieGroups): array
  111.     {
  112.         foreach ($cookieGroups as $groupIndex => $cookieGroup) {
  113.             if ($cookieGroup['snippet_name'] !== 'cookie.groupComfortFeatures') {
  114.                 continue;
  115.             }
  117.             foreach ($cookieGroup['entries'] as $entryIndex => $entry) {
  118.                 if ($entry['snippet_name'] !== 'cookie.groupComfortFeaturesWishlist') {
  119.                     continue;
  120.                 }
  122.                 if (!$this->systemConfigService->get('core.cart.wishlistEnabled', $salesChannelId)) {
  123.                     unset($cookieGroups[$groupIndex]['entries'][$entryIndex]);
  124.                 }
  125.             }
  127.             if (\count($cookieGroups[$groupIndex]['entries']) === 0) {
  128.                 unset($cookieGroups[$groupIndex]);
  129.             }
  130.         }
  132.         return $cookieGroups;
  133.     }
  135.     private function filterGoogleReCaptchaCookie(string $salesChannelId, array $cookieGroups): array
  136.     {
  137.         foreach ($cookieGroups as $groupIndex => $cookieGroup) {
  138.             if ($cookieGroup['snippet_name'] !== 'cookie.groupRequired') {
  139.                 continue;
  140.             }
  142.             foreach ($cookieGroup['entries'] as $entryIndex => $entry) {
  143.                 if ($entry['snippet_name'] !== 'cookie.groupRequiredCaptcha') {
  144.                     continue;
  145.                 }
  147.                 $activeGreCaptchaV2 = $this->systemConfigService->get('core.basicInformation.activeCaptchasV2.' . GoogleReCaptchaV2::CAPTCHA_NAME . '.isActive', $salesChannelId) ?? false;
  148.                 $activeGreCaptchaV3 = $this->systemConfigService->get('core.basicInformation.activeCaptchasV2.' . GoogleReCaptchaV3::CAPTCHA_NAME . '.isActive', $salesChannelId) ?? false;
  150.                 if (!$activeGreCaptchaV2 && !$activeGreCaptchaV3) {
  151.                     unset($cookieGroups[$groupIndex]['entries'][$entryIndex]);
  152.                 }
  153.             }
  155.             if (\count($cookieGroups[$groupIndex]['entries']) === 0) {
  156.                 unset($cookieGroups[$groupIndex]);
  157.             }
  158.         }
  160.         return $cookieGroups;
  161.     }
  162. }