vendor/shopware/core/Checkout/Cart/CartRuleLoader.php line 70

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Checkout\Cart;
  5. use Doctrine\DBAL\Connection;
  6. use Psr\Log\LoggerInterface;
  7. use Shopware\Core\Checkout\Cart\Event\CartCreatedEvent;
  8. use Shopware\Core\Checkout\Cart\Exception\CartTokenNotFoundException;
  9. use Shopware\Core\Checkout\Cart\LineItem\LineItem;
  10. use Shopware\Core\Checkout\Cart\Price\Struct\CartPrice;
  11. use Shopware\Core\Checkout\Cart\Tax\TaxDetector;
  12. use Shopware\Core\Content\Rule\RuleCollection;
  13. use Shopware\Core\Defaults;
  14. use Shopware\Core\Framework\Context;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Exception\EntityNotFoundException;
  16. use Shopware\Core\Framework\Log\Package;
  17. use Shopware\Core\Framework\Util\FloatComparator;
  18. use Shopware\Core\Framework\Uuid\Uuid;
  19. use Shopware\Core\Profiling\Profiler;
  20. use Shopware\Core\System\Country\CountryDefinition;
  21. use Shopware\Core\System\Country\CountryEntity;
  22. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  23. use Symfony\Contracts\Cache\CacheInterface;
  24. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  25. use Symfony\Contracts\Service\ResetInterface;
  27. #[Package('checkout')]
  28. class CartRuleLoader implements ResetInterface
  29. {
  30.     private const MAX_ITERATION = 7;
  32.     private ?RuleCollection $rules = null;
  34.     /**
  35.      * @var array<string, float>
  36.      */
  37.     private array $currencyFactor = [];
  39.     /**
  40.      * @internal
  41.      */
  42.     public function __construct(
  43.         private readonly AbstractCartPersister $cartPersister,
  44.         private readonly Processor $processor,
  45.         private readonly LoggerInterface $logger,
  46.         private readonly CacheInterface $cache,
  47.         private readonly AbstractRuleLoader $ruleLoader,
  48.         private readonly TaxDetector $taxDetector,
  49.         private readonly Connection $connection,
  50.         private readonly EventDispatcherInterface $dispatcher
  51.     ) {
  52.     }
  54.     public function loadByToken(SalesChannelContext $context, string $cartToken): RuleLoaderResult
  55.     {
  56.         try {
  57.             $cart = $this->cartPersister->load($cartToken, $context);
  59.             return $this->load($context, $cart, new CartBehavior($context->getPermissions()), false);
  60.         } catch (CartTokenNotFoundException) {
  61.             $cart = new Cart($cartToken);
  62.             $this->dispatcher->dispatch(new CartCreatedEvent($cart));
  64.             return $this->load($context, $cart, new CartBehavior($context->getPermissions()), true);
  65.         }
  66.     }
  68.     public function loadByCart(SalesChannelContext $context, Cart $cart, CartBehavior $behaviorContext, bool $isNew = false): RuleLoaderResult
  69.     {
  70.         return $this->load($context, $cart, $behaviorContext, $isNew);
  71.     }
  73.     public function reset(): void
  74.     {
  75.         $this->rules = null;
  76.     }
  78.     public function invalidate(): void
  79.     {
  80.         $this->reset();
  81.         $this->cache->delete(CachedRuleLoader::CACHE_KEY);
  82.     }
  84.     private function load(SalesChannelContext $context, Cart $cart, CartBehavior $behaviorContext, bool $new): RuleLoaderResult
  85.     {
  86.         return Profiler::trace('cart-rule-loader', function () use ($context, $cart, $behaviorContext, $new) {
  87.             $rules = $this->loadRules($context->getContext());
  89.             // save all rules for later usage
  90.             $all = $rules;
  92.             $ids = $new ? $rules->getIds() : $cart->getRuleIds();
  94.             // update rules in current context
  95.             $context->setRuleIds($ids);
  97.             $iteration = 1;
  99.             $timestamps = $cart->getLineItems()->fmap(function (LineItem $lineItem) {
  100.                 if ($lineItem->getDataTimestamp() === null) {
  101.                     return null;
  102.                 }
  104.                 return $lineItem->getDataTimestamp()->format(Defaults::STORAGE_DATE_TIME_FORMAT);
  105.             });
  107.             // start first cart calculation to have all objects enriched
  108.             $cart = $this->processor->process($cart, $context, $behaviorContext);
  110.             do {
  111.                 $compare = $cart;
  113.                 if ($iteration > self::MAX_ITERATION) {
  114.                     break;
  115.                 }
  117.                 // filter rules which matches to current scope
  118.                 $rules = $rules->filterMatchingRules($cart, $context);
  120.                 // update matching rules in context
  121.                 $context->setRuleIds($rules->getIds());
  123.                 // calculate cart again
  124.                 $cart = $this->processor->process($cart, $context, $behaviorContext);
  126.                 // check if the cart changed, in this case we have to recalculate the cart again
  127.                 $recalculate = $this->cartChanged($cart, $compare);
  129.                 // check if rules changed for the last calculated cart, in this case we have to recalculate
  130.                 $ruleCompare = $all->filterMatchingRules($cart, $context);
  132.                 if (!$rules->equals($ruleCompare)) {
  133.                     $recalculate = true;
  134.                     $rules = $ruleCompare;
  135.                 }
  137.                 ++$iteration;
  138.             } while ($recalculate);
  140.             $cart = $this->validateTaxFree($context, $cart, $behaviorContext);
  142.             $index = 0;
  143.             foreach ($rules as $rule) {
  144.                 ++$index;
  145.                 $this->logger->info(
  146.                     sprintf('#%d Rule detection: %s with priority %d (id: %s)', $index, $rule->getName(), $rule->getPriority(), $rule->getId())
  147.                 );
  148.             }
  150.             $context->setRuleIds($rules->getIds());
  151.             $context->setAreaRuleIds($rules->getIdsByArea());
  153.             // save the cart if errors exist, so the errors get persisted
  154.             if ($cart->getErrors()->count() > 0 || $this->updated($cart, $timestamps)) {
  155.                 $this->cartPersister->save($cart, $context);
  156.             }
  158.             return new RuleLoaderResult($cart, $rules);
  159.         });
  160.     }
  162.     private function loadRules(Context $context): RuleCollection
  163.     {
  164.         if ($this->rules !== null) {
  165.             return $this->rules;
  166.         }
  168.         return $this->rules = $this->ruleLoader->load($context)->filterForContext();
  169.     }
  171.     private function cartChanged(Cart $previous, Cart $current): bool
  172.     {
  173.         $previousLineItems = $previous->getLineItems();
  174.         $currentLineItems = $current->getLineItems();
  176.         return $previousLineItems->count() !== $currentLineItems->count()
  177.             || $previous->getPrice()->getTotalPrice() !== $current->getPrice()->getTotalPrice()
  178.             || $previousLineItems->getKeys() !== $currentLineItems->getKeys()
  179.             || $previousLineItems->getTypes() !== $currentLineItems->getTypes()
  180.         ;
  181.     }
  183.     private function detectTaxType(SalesChannelContext $context, float $cartNetAmount = 0): string
  184.     {
  185.         $currency = $context->getCurrency();
  186.         $currencyTaxFreeAmount = $currency->getTaxFreeFrom();
  187.         $isReachedCurrencyTaxFreeAmount = $currencyTaxFreeAmount > 0 && $cartNetAmount >= $currencyTaxFreeAmount;
  189.         if ($isReachedCurrencyTaxFreeAmount) {
  190.             return CartPrice::TAX_STATE_FREE;
  191.         }
  193.         $country = $context->getShippingLocation()->getCountry();
  195.         $isReachedCustomerTaxFreeAmount = $country->getCustomerTax()->getEnabled() && $this->isReachedCountryTaxFreeAmount($context, $country, $cartNetAmount);
  196.         $isReachedCompanyTaxFreeAmount = $this->taxDetector->isCompanyTaxFree($context, $country) && $this->isReachedCountryTaxFreeAmount($context, $country, $cartNetAmount, CountryDefinition::TYPE_COMPANY_TAX_FREE);
  197.         if ($isReachedCustomerTaxFreeAmount || $isReachedCompanyTaxFreeAmount) {
  198.             return CartPrice::TAX_STATE_FREE;
  199.         }
  201.         if ($this->taxDetector->useGross($context)) {
  202.             return CartPrice::TAX_STATE_GROSS;
  203.         }
  205.         return CartPrice::TAX_STATE_NET;
  206.     }
  208.     /**
  209.      * @param array<string, string> $timestamps
  210.      */
  211.     private function updated(Cart $cart, array $timestamps): bool
  212.     {
  213.         foreach ($cart->getLineItems() as $lineItem) {
  214.             if (!isset($timestamps[$lineItem->getId()])) {
  215.                 return true;
  216.             }
  218.             $original = $timestamps[$lineItem->getId()];
  220.             $timestamp = $lineItem->getDataTimestamp() !== null ? $lineItem->getDataTimestamp()->format(Defaults::STORAGE_DATE_TIME_FORMAT) : null;
  222.             if ($original !== $timestamp) {
  223.                 return true;
  224.             }
  225.         }
  227.         return \count($timestamps) !== $cart->getLineItems()->count();
  228.     }
  230.     private function isReachedCountryTaxFreeAmount(
  231.         SalesChannelContext $context,
  232.         CountryEntity $country,
  233.         float $cartNetAmount = 0,
  234.         string $taxFreeType = CountryDefinition::TYPE_CUSTOMER_TAX_FREE
  235.     ): bool {
  236.         $countryTaxFreeLimit = $taxFreeType === CountryDefinition::TYPE_CUSTOMER_TAX_FREE ? $country->getCustomerTax() : $country->getCompanyTax();
  237.         if (!$countryTaxFreeLimit->getEnabled()) {
  238.             return false;
  239.         }
  241.         $countryTaxFreeLimitAmount = $countryTaxFreeLimit->getAmount() / $this->fetchCurrencyFactor($countryTaxFreeLimit->getCurrencyId(), $context);
  243.         $currency = $context->getCurrency();
  245.         $cartNetAmount /= $this->fetchCurrencyFactor($currency->getId(), $context);
  247.         // currency taxFreeAmount === 0.0 mean currency taxFreeFrom is disabled
  248.         return $currency->getTaxFreeFrom() === 0.0 && FloatComparator::greaterThanOrEquals($cartNetAmount, $countryTaxFreeLimitAmount);
  249.     }
  251.     private function fetchCurrencyFactor(string $currencyId, SalesChannelContext $context): float
  252.     {
  253.         if ($currencyId === Defaults::CURRENCY) {
  254.             return 1;
  255.         }
  257.         $currency = $context->getCurrency();
  258.         if ($currencyId === $currency->getId()) {
  259.             return $currency->getFactor();
  260.         }
  262.         if (\array_key_exists($currencyId, $this->currencyFactor)) {
  263.             return $this->currencyFactor[$currencyId];
  264.         }
  266.         $currencyFactor = $this->connection->fetchOne(
  267.             'SELECT `factor` FROM `currency` WHERE `id` = :currencyId',
  268.             ['currencyId' => Uuid::fromHexToBytes($currencyId)]
  269.         );
  271.         if (!$currencyFactor) {
  272.             throw new EntityNotFoundException('currency', $currencyId);
  273.         }
  275.         return $this->currencyFactor[$currencyId] = (float) $currencyFactor;
  276.     }
  278.     private function validateTaxFree(SalesChannelContext $context, Cart $cart, CartBehavior $behaviorContext): Cart
  279.     {
  280.         $totalCartNetAmount = $cart->getPrice()->getPositionPrice();
  281.         if ($context->getTaxState() === CartPrice::TAX_STATE_GROSS) {
  282.             $totalCartNetAmount = $totalCartNetAmount - $cart->getLineItems()->getPrices()->getCalculatedTaxes()->getAmount();
  283.         }
  284.         $taxState = $this->detectTaxType($context, $totalCartNetAmount);
  285.         $previous = $context->getTaxState();
  286.         if ($taxState === $previous) {
  287.             return $cart;
  288.         }
  290.         $context->setTaxState($taxState);
  291.         $cart->setData(null);
  292.         $cart = $this->processor->process($cart, $context, $behaviorContext);
  293.         if ($previous !== CartPrice::TAX_STATE_FREE) {
  294.             $context->setTaxState($previous);
  295.         }
  297.         return $cart;
  298.     }
  299. }