custom/plugins/AcrisCookieConsentCS/src/Components/CookieService.php line 90

Open in your IDE?
  1. <?php declare(strict_types=1);
  2. /**
  3.  * ACRIS Shopware Plugin
  4.  * Copyright (c) - ACRIS E-Commerce GmbH
  5.  *
  6.  * Die Urheberrechte verbleiben bei der ACRIS E-Commerce GmbH.
  7.  * Sie dürfen vom Auftraggeber während und nach der Beendigung
  8.  * der Zusammenarbeit ausschließlich für die vereinbarten Zwe-
  9.  * cke verändert werden. Der Auftraggeber ist nicht berechtigt
  10.  * ohne ausdrückliche Zustimmung des Auftragnehmers das Werk zu
  11.  * vervielfältigen und / oder zu verbreiten. Änderungen bzw. Be-
  12.  * arbeitungen von Leistungen des Auftragnehmers, wie insbeson-
  13.  * dere deren Weiterentwicklung durch den Auftragnehmer (Käufer)
  14.  * oder durch für diesen tätige Dritte, sind nur mit ausdrückli-
  15.  * cher Zustimmung der ACRIS E-Commerce GmbH zulässig.
  16.  *
  17.  * Es gelten die AGB der ACRIS E-Commerce GmbH in der aktuell
  18.  * gültigen Fassung.
  19.  */
  21. namespace Acris\CookieConsent\Components;
  23. use Acris\CookieConsent\AcrisCookieConsentCS as AcrisCookieConsent;
  24. use Acris\CookieConsent\Custom\CookieEntity;
  25. use Acris\CookieConsent\Custom\CookieGroupEntity;
  26. use Shopware\Core\Defaults;
  27. use Shopware\Core\Framework\Context;
  28. use Shopware\Core\Framework\DataAbstractionLayer\EntityCollection;
  29. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepositoryInterface;
  30. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  31. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntitySearchResult;
  32. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  33. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\NotFilter;
  34. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\OrFilter;
  35. use Shopware\Core\Framework\DataAbstractionLayer\Search\Sorting\FieldSorting;
  36. use Shopware\Core\System\SalesChannel\SalesChannelCollection;
  37. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  38. use Shopware\Core\System\SystemConfig\SystemConfigService;
  39. use Symfony\Component\DependencyInjection\ContainerInterface;
  41. class CookieService
  42. {
  43.     const EXPECTED_COOKIES = [
  44.         'sf_redirect',
  45.         'googtrans',
  46.         'language',
  47.         'PHPSESSID',
  48.         'acrisImportExportCookie'
  49.     ];
  51.     /**
  52.      * @var ContainerInterface
  53.      */
  54.     private $container;
  55.     /**
  56.      * @var AcrisCookieConsent
  57.      */
  58.     private $acrisCookieConsent;
  59.     /**
  60.      * @var EntityRepositoryInterface
  61.      */
  62.     private $cookieRepository;
  63.     /**
  64.      * @var EntityRepositoryInterface
  65.      */
  66.     private $cookieGroupRepository;
  67.     /**
  68.      * @var SystemConfigService
  69.      */
  70.     private $systemConfigService;
  72.     /**
  73.      * @param ContainerInterface $container
  74.      */
  75.     public function __construct(ContainerInterface $container, EntityRepositoryInterface $cookieRepository, EntityRepositoryInterface $cookieGroupRepository, AcrisCookieConsent $acrisCookieConsent, SystemConfigService $systemConfigService)
  76.     {
  77.         $this->container = $container;
  78.         $this->acrisCookieConsent = $acrisCookieConsent;
  79.         $this->cookieRepository = $cookieRepository;
  80.         $this->cookieGroupRepository = $cookieGroupRepository;
  81.         $this->systemConfigService = $systemConfigService;
  82.     }
  84.     /**
  85.      * @param Context $context
  86.      * @param string $salesChannelId
  87.      * @return array
  88.      * @throws \Shopware\Core\Framework\DataAbstractionLayer\Exception\InconsistentCriteriaIdsException
  89.      */
  90.     public function getAllKnownCookieIds(Context $context, string $salesChannelId): array
  91.     {
  92.         /** @var EntityCollection $cookies */
  93.         $cookies = $this->cookieRepository->search((new Criteria())->addAssociation('salesChannels'), $context)->getEntities();
  94.         $cookieIds = [];
  95.         if(!$cookies) return [];
  96.         /** @var CookieEntity $cookie */
  97.         foreach ($cookies->getElements() as $cookie) {
  98.             if($cookie->isDefault() !== true && $this->isCookieAvailableForSalesChannels($salesChannelId, $cookie->getSalesChannels()) === false) {
  99.                 continue;
  100.             }
  101.             $cookieIds[] = $cookie->getCookieId();
  102.         }
  103.         return $cookieIds;
  104.     }
  106.     /**
  107.      * @param Context $context
  108.      * @param string $salesChannelId
  109.      * @return array
  110.      * @throws \Shopware\Core\Framework\DataAbstractionLayer\Exception\InconsistentCriteriaIdsException
  111.      */
  112.     public function getAvailableCookieGroups(Context $context, string $salesChannelId): array
  113.     {
  114.         /** @var EntitySearchResult $cookieGroups */
  115.         $cookieGroups = $this->cookieGroupRepository->search((new Criteria())->addAssociation('cookies')->addAssociation('cookies.salesChannels')->addSorting(new FieldSorting('isDefault', FieldSorting::DESCENDING)), $context);
  117.         $cookieGroupArray = [];
  118.         /** @var CookieGroupEntity $cookieGroup */
  119.         foreach ($cookieGroups->getElements() as $cookieGroup) {
  120.             $cookies = $cookieGroup->getCookies();
  121.             if(!empty($cookies)) {
  122.                 $cookiesArray = [];
  123.                 foreach ($cookies->getElements() as $cookie) {
  124.                     if($cookie->isActive() === true) {
  125.                         // check if cookie is allowed for shop
  126.                         if(!$cookie->isDefault()) {
  127.                             if($this->isCookieAvailableForSalesChannels($salesChannelId, $cookie->getSalesChannels()) === false) continue;
  128.                         }
  129.                         $cookiesArray[$cookie->getId()] = $cookie->getVars();
  130.                     }
  131.                 }
  132.                 if(!empty($cookiesArray)) {
  133.                     $cookieGroupArray[$cookieGroup->getId()] = $cookieGroup->getVars();
  134.                     $cookieGroupArray[$cookieGroup->getId()]['cookies'] = $cookiesArray;
  135.                 }
  136.             }
  137.         }
  139.         return $cookieGroupArray;
  140.     }
  142.     /**
  143.      * @param string $salesChannelId
  144.      * @param SalesChannelCollection|null $salesChannelCollection
  145.      * @return bool
  146.      */
  147.     protected function isCookieAvailableForSalesChannels(string $salesChannelId, ?SalesChannelCollection $salesChannelCollection): bool
  148.     {
  149.         if($salesChannelCollection && $salesChannelCollection->count()) {
  150.             foreach ($salesChannelCollection->getElements() as $salesChannelEntity) {
  151.                 if($salesChannelEntity->getId() === $salesChannelId) {
  152.                     return true;
  153.                 }
  154.             }
  155.             return false;
  156.         }
  157.         return true;
  158.     }
  160.     public function getAllCookies(SalesChannelContext $salesChannelContext): EntityCollection
  161.     {
  162.         return $this->cookieRepository->search((new Criteria())->addAssociation('salesChannels'), $salesChannelContext->getContext())->getEntities();
  163.     }
  165.     /**
  166.      * @param SalesChannelContext $salesChannelContext
  167.      * @return array
  168.      * @throws \Shopware\Core\Framework\DataAbstractionLayer\Exception\InconsistentCriteriaIdsException
  169.      */
  170.     public function getNotFunctionalCookieGroupIds(SalesChannelContext $salesChannelContext): array
  171.     {
  172.         $notFunctionalGroups = $this->cookieGroupRepository->searchIds((new Criteria())->addFilter(new EqualsFilter('isDefault', false)), $salesChannelContext->getContext())->getIds();
  173.         $notFunctionalGroupArray = [];
  174.         foreach ($notFunctionalGroups as $notFunctionalGroupId) {
  175.             $notFunctionalGroupArray[$notFunctionalGroupId] = $notFunctionalGroupId;
  176.         }
  177.         return $notFunctionalGroupArray;
  178.     }
  180.     /**
  181.      * @param SalesChannelContext $salesChannelContext
  182.      * @param string $cookieName
  183.      * @param false $force
  184.      * @param null $availableCookies
  185.      * @param array $additionalCookieData
  186.      * @param false $isShopwareCookie
  187.      */
  188.     public function insertCookieIfNotKnown(SalesChannelContext $salesChannelContext, string $cookieName, $force = false, $availableCookies = null, $additionalCookieData = [], $isShopwareCookie = false): void
  189.     {
  190.         if($isShopwareCookie === false && !$this->systemConfigService->get('AcrisCookieConsentCS.config.autoDetectionActive', $salesChannelContext->getSalesChannel()->getId())) {
  191.             return;
  192.         }
  194.         if(!$cookieName) return;
  196.         if(in_array($cookieName, self::EXPECTED_COOKIES)) return;
  198.         if(!$force) {
  199.             if($availableCookies === null) {
  200.                 $availableCookies = $this->getAllCookies($salesChannelContext);
  201.             }
  202.             if($this->isCookieKnownForSalesChannel($cookieName, $availableCookies, $salesChannelContext->getSalesChannel()->getId(), $salesChannelContext->getContext()) === true) {
  203.                 return;
  204.             }
  205.         }
  207.         $knownCookies = parse_ini_file($this->acrisCookieConsent->getPath() . "/Components/Resources/optionalKnownCookies.ini", true);
  209.         foreach ($knownCookies as $cookieId => $knownCookie) {
  210.             if($knownCookie['groupIdentification'] && $cookieName === $cookieId || preg_match("#^(" . $cookieId . ")$#", $cookieName)) {
  211.                 $groupId = $this->findGroupIdByIdentification($salesChannelContext, $knownCookie['groupIdentification']);
  212.                 if(!$groupId && !empty($additionalCookieData) && array_key_exists('cookieGroupId', $additionalCookieData) === true && $additionalCookieData['cookieGroupId']) {
  213.                     $groupId = $additionalCookieData['cookieGroupId'];
  214.                 }
  215.                 if(!$groupId) continue;
  216.                 $data = ['cookieId'=>$cookieId,'translations' => [
  217.                     'en-GB' => [
  218.                         'title' => $knownCookie['title-en'],
  219.                         'description' => $knownCookie['description-en'],
  220.                     ],'de-DE' => [
  221.                         'title' => $knownCookie['title-de'],
  222.                         'description' => $knownCookie['description-de'],
  223.                     ],[
  224.                         'title' => $knownCookie['title-en'],
  225.                         'description' => $knownCookie['description-en'],
  226.                         'languageId' => Defaults::LANGUAGE_SYSTEM
  227.                     ]
  228.                     ],'provider'=>$knownCookie['provider'],'unknown'=>false,'active'=>true,'cookieGroupId'=>$groupId, 'salesChannels' => [0 => ['id' => $salesChannelContext->getSalesChannel()->getId()]]];
  229.                 if(array_key_exists('defaultValue', $additionalCookieData) && $additionalCookieData['defaultValue']) {
  230.                     $data['defaultValue'] = $additionalCookieData['defaultValue'];
  231.                 }
  233.                 if(array_key_exists("googleCookieConsentMode", $knownCookie)) {
  234.                     $googleCookieConsentMode = [];
  236.                     if(str_contains($knownCookie["googleCookieConsentMode"], "|")){
  237.                         $googleCookieConsentModes = explode("|", $knownCookie["googleCookieConsentMode"]);
  239.                         foreach($googleCookieConsentModes as $cookieConsentMode){
  240.                             $googleCookieConsentMode[] = $cookieConsentMode;
  241.                         }
  242.                     } else {
  243.                         $googleCookieConsentMode[] = $knownCookie["googleCookieConsentMode"];
  244.                     }
  246.                     $data["googleCookieConsentMode"] = $googleCookieConsentMode;
  247.                 }
  249.                 $this->cookieRepository->create([$data], $salesChannelContext->getContext());
  250.                 return;
  251.             }
  252.         }
  253.         $cookieData = array_merge(['cookieId'=>$cookieName,'unknown'=>true,'active'=>false, 'salesChannels' => [0 => ['id' => $salesChannelContext->getSalesChannel()->getId()]]], $additionalCookieData);
  254.         $this->cookieRepository->create([$cookieData], $salesChannelContext->getContext());
  255.     }
  257.     public function findGroupIdByIdentification(SalesChannelContext $salesChannelContext, string $identification): string
  258.     {
  259.         $cookieGroups = $this->cookieGroupRepository->searchIds((new Criteria())->addFilter(new EqualsFilter('identification', $identification))->setLimit(1), $salesChannelContext->getContext())->getIds();
  260.         empty($cookieGroups) ? $cookieGroupId = "" : $cookieGroupId = $cookieGroups[0];
  261.         return $cookieGroupId;
  262.     }
  264.     public function isCookieKnownForSalesChannel(string $cookieName, EntityCollection $availableCookies, string $currentSalesChannelId, Context $context): bool
  265.     {
  266.         /** @var CookieEntity $availableCookie */
  267.         foreach ($availableCookies->getElements() as $availableCookie) {
  268.             try {
  269.                 if($cookieName === $availableCookie->getCookieId() || preg_match("#^(" . $availableCookie->getCookieId() . ")$#", $cookieName)) {
  270.                     if($availableCookie->getSalesChannels()) {
  271.                         foreach ($availableCookie->getSalesChannels()->getElements() as $salesChannel) {
  272.                             if($currentSalesChannelId === $salesChannel->getId()) {
  273.                                 return true;
  274.                             }
  275.                         }
  276.                     }
  277.                     $this->addSalesChannelToCookie($availableCookie, $currentSalesChannelId, $context);
  278.                     return true;
  279.                 }
  280.             } catch (\Throwable $e) { }
  281.         }
  282.         return false;
  283.     }
  285.     public function getDefaultCookies(String $salesChannelId, Context $context): EntityCollection {
  286.         $criteria = new Criteria();
  287.         $criteria->addAssociation('salesChannels')
  288.                  ->addFilter(new EqualsFilter('active', true))
  289.                  ->addFilter(new NotFilter(NotFilter::CONNECTION_AND,
  290.                             [new EqualsFilter('defaultValue', null)]))
  291.                  ->addFilter(new OrFilter([new EqualsFilter('salesChannels.id', null), new EqualsFilter('salesChannels.id', $salesChannelId)]))
  292.                  ->addFilter(new EqualsFilter('cookieGroup.isDefault', true));
  293.         return $this->cookieRepository->search($criteria, $context)->getEntities();
  294.     }
  296.     private function addSalesChannelToCookie(CookieEntity $availableCookie, string $currentSalesChannelId, Context $context): void
  297.     {
  298.         $salesChannelsArray = [];
  299.         if($availableCookie->getSalesChannels()) {
  300.             foreach ($availableCookie->getSalesChannels() as $salesChannel) {
  301.                 $salesChannelsArray[] = ['id'=> $salesChannel->getId()];
  302.             }
  303.         }
  304.         $salesChannelsArray[] = ['id'=> $currentSalesChannelId];
  306.         $this->cookieRepository->upsert([['id'=>$availableCookie->getId(), 'salesChannels' => $salesChannelsArray]], $context);
  307.     }
  308. }