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

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Controller;
  5. use Shopware\Core\Framework\Log\Package;
  6. use Shopware\Core\Framework\Routing\Annotation\RouteScope;
  7. use Shopware\Core\Framework\Routing\Annotation\Since;
  8. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  9. use Shopware\Core\System\SystemConfig\SystemConfigService;
  10. use Shopware\Storefront\Framework\Captcha\GoogleReCaptchaV2;
  11. use Shopware\Storefront\Framework\Captcha\GoogleReCaptchaV3;
  12. use Shopware\Storefront\Framework\Cookie\CookieProviderInterface;
  13. use Symfony\Component\HttpFoundation\Response;
  14. use Symfony\Component\Routing\Annotation\Route;
  16. /**
  17.  * @Route(defaults={"_routeScope"={"storefront"}})
  18.  *
  19.  * @deprecated tag:v6.5.0 - reason:becomes-internal - Will be internal
  20.  */
  21. #[Package('storefront')]
  22. class CookieController extends StorefrontController
  23. {
  24.     /**
  25.      * @var CookieProviderInterface
  26.      */
  27.     private $cookieProvider;
  29.     /**
  30.      * @var SystemConfigService
  31.      */
  32.     private $systemConfigService;
  34.     /**
  35.      * @internal
  36.      */
  37.     public function __construct(CookieProviderInterface $cookieProvider, SystemConfigService $systemConfigService)
  38.     {
  39.         $this->cookieProvider = $cookieProvider;
  40.         $this->systemConfigService = $systemConfigService;
  41.     }
  43.     /**
  44.      * @Since("6.1.0.0")
  45.      * @Route("/cookie/offcanvas", name="frontend.cookie.offcanvas", options={"seo"="false"}, methods={"GET"}, defaults={"XmlHttpRequest"=true})
  46.      */
  47.     public function offcanvas(SalesChannelContext $context): Response
  48.     {
  49.         $cookieGroups = $this->cookieProvider->getCookieGroups();
  50.         $cookieGroups = $this->filterGoogleAnalyticsCookie($context, $cookieGroups);
  52.         $cookieGroups = $this->filterComfortFeaturesCookie($context->getSalesChannelId(), $cookieGroups);
  54.         $cookieGroups = $this->filterGoogleReCaptchaCookie($context->getSalesChannelId(), $cookieGroups);
  56.         $response = $this->renderStorefront('@Storefront/storefront/layout/cookie/cookie-configuration.html.twig', ['cookieGroups' => $cookieGroups]);
  57.         $response->headers->set('x-robots-tag', 'noindex,follow');
  59.         return $response;
  60.     }
  62.     /**
  63.      * @Since("6.1.0.0")
  64.      * @Route("/cookie/permission", name="frontend.cookie.permission", options={"seo"="false"}, methods={"GET"}, defaults={"XmlHttpRequest"=true})
  65.      */
  66.     public function permission(SalesChannelContext $context): Response
  67.     {
  68.         $cookieGroups = $this->cookieProvider->getCookieGroups();
  69.         $cookieGroups = $this->filterGoogleAnalyticsCookie($context, $cookieGroups);
  71.         $cookieGroups = $this->filterComfortFeaturesCookie($context->getSalesChannelId(), $cookieGroups);
  73.         $cookieGroups = $this->filterGoogleReCaptchaCookie($context->getSalesChannelId(), $cookieGroups);
  75.         $response = $this->renderStorefront('@Storefront/storefront/layout/cookie/cookie-permission.html.twig', ['cookieGroups' => $cookieGroups]);
  76.         $response->headers->set('x-robots-tag', 'noindex,follow');
  78.         return $response;
  79.     }
  81.     private function filterGoogleAnalyticsCookie(SalesChannelContext $context, array $cookieGroups): array
  82.     {
  83.         if ($context->getSalesChannel()->getAnalytics() && $context->getSalesChannel()->getAnalytics()->isActive()) {
  84.             return $cookieGroups;
  85.         }
  87.         $filteredGroups = [];
  89.         foreach ($cookieGroups as $cookieGroup) {
  90.             if ($cookieGroup['snippet_name'] === 'cookie.groupStatistical') {
  91.                 $cookieGroup['entries'] = array_filter($cookieGroup['entries'], function ($item) {
  92.                     return $item['snippet_name'] !== 'cookie.groupStatisticalGoogleAnalytics';
  93.                 });
  94.                 // Only add statistics cookie group if it has entries
  95.                 if (\count($cookieGroup['entries']) > 0) {
  96.                     $filteredGroups[] = $cookieGroup;
  97.                 }
  99.                 continue;
  100.             }
  101.             $filteredGroups[] = $cookieGroup;
  102.         }
  104.         return $filteredGroups;
  105.     }
  107.     private function filterComfortFeaturesCookie(string $salesChannelId, array $cookieGroups): array
  108.     {
  109.         foreach ($cookieGroups as $groupIndex => $cookieGroup) {
  110.             if ($cookieGroup['snippet_name'] !== 'cookie.groupComfortFeatures') {
  111.                 continue;
  112.             }
  114.             foreach ($cookieGroup['entries'] as $entryIndex => $entry) {
  115.                 if ($entry['snippet_name'] !== 'cookie.groupComfortFeaturesWishlist') {
  116.                     continue;
  117.                 }
  119.                 if (!$this->systemConfigService->get('core.cart.wishlistEnabled', $salesChannelId)) {
  120.                     unset($cookieGroups[$groupIndex]['entries'][$entryIndex]);
  121.                 }
  122.             }
  124.             if (\count($cookieGroups[$groupIndex]['entries']) === 0) {
  125.                 unset($cookieGroups[$groupIndex]);
  126.             }
  127.         }
  129.         return $cookieGroups;
  130.     }
  132.     private function filterGoogleReCaptchaCookie(string $salesChannelId, array $cookieGroups): array
  133.     {
  134.         foreach ($cookieGroups as $groupIndex => $cookieGroup) {
  135.             if ($cookieGroup['snippet_name'] !== 'cookie.groupRequired') {
  136.                 continue;
  137.             }
  139.             foreach ($cookieGroup['entries'] as $entryIndex => $entry) {
  140.                 if ($entry['snippet_name'] !== 'cookie.groupRequiredCaptcha') {
  141.                     continue;
  142.                 }
  144.                 $activeGreCaptchaV2 = $this->systemConfigService->get('core.basicInformation.activeCaptchasV2.' . GoogleReCaptchaV2::CAPTCHA_NAME . '.isActive', $salesChannelId) ?? false;
  145.                 $activeGreCaptchaV3 = $this->systemConfigService->get('core.basicInformation.activeCaptchasV2.' . GoogleReCaptchaV3::CAPTCHA_NAME . '.isActive', $salesChannelId) ?? false;
  147.                 if (!$activeGreCaptchaV2 && !$activeGreCaptchaV3) {
  148.                     unset($cookieGroups[$groupIndex]['entries'][$entryIndex]);
  149.                 }
  150.             }
  152.             if (\count($cookieGroups[$groupIndex]['entries']) === 0) {
  153.                 unset($cookieGroups[$groupIndex]);
  154.             }
  155.         }
  157.         return $cookieGroups;
  158.     }
  159. }