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

  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(private readonly AbstractCartPersister $cartPersister, private readonly Processor $processor, private readonly LoggerInterface $logger, private readonly CacheInterface $cache, private readonly AbstractRuleLoader $ruleLoader, private readonly TaxDetector $taxDetector, private readonly Connection $connection, private readonly EventDispatcherInterface $dispatcher)
  43.     {
  44.     }
  46.     public function loadByToken(SalesChannelContext $context, string $cartToken): RuleLoaderResult
  47.     {
  48.         try {
  49.             $cart = $this->cartPersister->load($cartToken, $context);
  51.             return $this->load($context, $cart, new CartBehavior($context->getPermissions()), false);
  52.         } catch (CartTokenNotFoundException) {
  53.             $cart = new Cart($cartToken);
  54.             $this->dispatcher->dispatch(new CartCreatedEvent($cart));
  56.             return $this->load($context, $cart, new CartBehavior($context->getPermissions()), true);
  57.         }
  58.     }
  60.     public function loadByCart(SalesChannelContext $context, Cart $cart, CartBehavior $behaviorContext, bool $isNew = false): RuleLoaderResult
  61.     {
  62.         return $this->load($context, $cart, $behaviorContext, $isNew);
  63.     }
  65.     public function reset(): void
  66.     {
  67.         $this->rules = null;
  68.     }
  70.     public function invalidate(): void
  71.     {
  72.         $this->reset();
  73.         $this->cache->delete(CachedRuleLoader::CACHE_KEY);
  74.     }
  76.     private function load(SalesChannelContext $context, Cart $cart, CartBehavior $behaviorContext, bool $new): RuleLoaderResult
  77.     {
  78.         return Profiler::trace('cart-rule-loader', function () use ($context, $cart, $behaviorContext, $new) {
  79.             $rules = $this->loadRules($context->getContext());
  81.             // save all rules for later usage
  82.             $all = $rules;
  84.             $ids = $new ? $rules->getIds() : $cart->getRuleIds();
  86.             // update rules in current context
  87.             $context->setRuleIds($ids);
  89.             $iteration = 1;
  91.             $timestamps = $cart->getLineItems()->fmap(function (LineItem $lineItem) {
  92.                 if ($lineItem->getDataTimestamp() === null) {
  93.                     return null;
  94.                 }
  96.                 return $lineItem->getDataTimestamp()->format(Defaults::STORAGE_DATE_TIME_FORMAT);
  97.             });
  99.             // start first cart calculation to have all objects enriched
  100.             $cart = $this->processor->process($cart, $context, $behaviorContext);
  102.             do {
  103.                 $compare = $cart;
  105.                 if ($iteration > self::MAX_ITERATION) {
  106.                     break;
  107.                 }
  109.                 // filter rules which matches to current scope
  110.                 $rules = $rules->filterMatchingRules($cart, $context);
  112.                 // update matching rules in context
  113.                 $context->setRuleIds($rules->getIds());
  115.                 // calculate cart again
  116.                 $cart = $this->processor->process($cart, $context, $behaviorContext);
  118.                 // check if the cart changed, in this case we have to recalculate the cart again
  119.                 $recalculate = $this->cartChanged($cart, $compare);
  121.                 // check if rules changed for the last calculated cart, in this case we have to recalculate
  122.                 $ruleCompare = $all->filterMatchingRules($cart, $context);
  124.                 if (!$rules->equals($ruleCompare)) {
  125.                     $recalculate = true;
  126.                     $rules = $ruleCompare;
  127.                 }
  129.                 ++$iteration;
  130.             } while ($recalculate);
  132.             $cart = $this->validateTaxFree($context, $cart, $behaviorContext);
  134.             $index = 0;
  135.             foreach ($rules as $rule) {
  136.                 ++$index;
  137.                 $this->logger->info(
  138.                     sprintf('#%s Rule detection: %s with priority %s (id: %s)', $index, $rule->getName(), $rule->getPriority(), $rule->getId())
  139.                 );
  140.             }
  142.             $context->setRuleIds($rules->getIds());
  143.             $context->setAreaRuleIds($rules->getIdsByArea());
  145.             // save the cart if errors exist, so the errors get persisted
  146.             if ($cart->getErrors()->count() > 0 || $this->updated($cart, $timestamps)) {
  147.                 $this->cartPersister->save($cart, $context);
  148.             }
  150.             return new RuleLoaderResult($cart, $rules);
  151.         });
  152.     }
  154.     private function loadRules(Context $context): RuleCollection
  155.     {
  156.         if ($this->rules !== null) {
  157.             return $this->rules;
  158.         }
  160.         return $this->rules = $this->ruleLoader->load($context)->filterForContext();
  161.     }
  163.     private function cartChanged(Cart $previous, Cart $current): bool
  164.     {
  165.         $previousLineItems = $previous->getLineItems();
  166.         $currentLineItems = $current->getLineItems();
  168.         return $previousLineItems->count() !== $currentLineItems->count()
  169.             || $previous->getPrice()->getTotalPrice() !== $current->getPrice()->getTotalPrice()
  170.             || $previousLineItems->getKeys() !== $currentLineItems->getKeys()
  171.             || $previousLineItems->getTypes() !== $currentLineItems->getTypes()
  172.         ;
  173.     }
  175.     private function detectTaxType(SalesChannelContext $context, float $cartNetAmount = 0): string
  176.     {
  177.         $currency = $context->getCurrency();
  178.         $currencyTaxFreeAmount = $currency->getTaxFreeFrom();
  179.         $isReachedCurrencyTaxFreeAmount = $currencyTaxFreeAmount > 0 && $cartNetAmount >= $currencyTaxFreeAmount;
  181.         if ($isReachedCurrencyTaxFreeAmount) {
  182.             return CartPrice::TAX_STATE_FREE;
  183.         }
  185.         $country = $context->getShippingLocation()->getCountry();
  187.         $isReachedCustomerTaxFreeAmount = $country->getCustomerTax()->getEnabled() && $this->isReachedCountryTaxFreeAmount($context, $country, $cartNetAmount);
  188.         $isReachedCompanyTaxFreeAmount = $this->taxDetector->isCompanyTaxFree($context, $country) && $this->isReachedCountryTaxFreeAmount($context, $country, $cartNetAmount, CountryDefinition::TYPE_COMPANY_TAX_FREE);
  189.         if ($isReachedCustomerTaxFreeAmount || $isReachedCompanyTaxFreeAmount) {
  190.             return CartPrice::TAX_STATE_FREE;
  191.         }
  193.         if ($this->taxDetector->useGross($context)) {
  194.             return CartPrice::TAX_STATE_GROSS;
  195.         }
  197.         return CartPrice::TAX_STATE_NET;
  198.     }
  200.     /**
  201.      * @param array<string, string> $timestamps
  202.      */
  203.     private function updated(Cart $cart, array $timestamps): bool
  204.     {
  205.         foreach ($cart->getLineItems() as $lineItem) {
  206.             if (!isset($timestamps[$lineItem->getId()])) {
  207.                 return true;
  208.             }
  210.             $original = $timestamps[$lineItem->getId()];
  212.             $timestamp = $lineItem->getDataTimestamp() !== null ? $lineItem->getDataTimestamp()->format(Defaults::STORAGE_DATE_TIME_FORMAT) : null;
  214.             if ($original !== $timestamp) {
  215.                 return true;
  216.             }
  217.         }
  219.         return \count($timestamps) !== $cart->getLineItems()->count();
  220.     }
  222.     private function isReachedCountryTaxFreeAmount(
  223.         SalesChannelContext $context,
  224.         CountryEntity $country,
  225.         float $cartNetAmount = 0,
  226.         string $taxFreeType = CountryDefinition::TYPE_CUSTOMER_TAX_FREE
  227.     ): bool {
  228.         $countryTaxFreeLimit = $taxFreeType === CountryDefinition::TYPE_CUSTOMER_TAX_FREE ? $country->getCustomerTax() : $country->getCompanyTax();
  229.         if (!$countryTaxFreeLimit->getEnabled()) {
  230.             return false;
  231.         }
  233.         $countryTaxFreeLimitAmount = $countryTaxFreeLimit->getAmount() / $this->fetchCurrencyFactor($countryTaxFreeLimit->getCurrencyId(), $context);
  235.         $currency = $context->getCurrency();
  237.         $cartNetAmount /= $this->fetchCurrencyFactor($currency->getId(), $context);
  239.         // currency taxFreeAmount === 0.0 mean currency taxFreeFrom is disabled
  240.         return $currency->getTaxFreeFrom() === 0.0 && FloatComparator::greaterThanOrEquals($cartNetAmount, $countryTaxFreeLimitAmount);
  241.     }
  243.     private function fetchCurrencyFactor(string $currencyId, SalesChannelContext $context): float
  244.     {
  245.         if ($currencyId === Defaults::CURRENCY) {
  246.             return 1;
  247.         }
  249.         $currency = $context->getCurrency();
  250.         if ($currencyId === $currency->getId()) {
  251.             return $currency->getFactor();
  252.         }
  254.         if (\array_key_exists($currencyId, $this->currencyFactor)) {
  255.             return $this->currencyFactor[$currencyId];
  256.         }
  258.         $currencyFactor = $this->connection->fetchOne(
  259.             'SELECT `factor` FROM `currency` WHERE `id` = :currencyId',
  260.             ['currencyId' => Uuid::fromHexToBytes($currencyId)]
  261.         );
  263.         if (!$currencyFactor) {
  264.             throw new EntityNotFoundException('currency', $currencyId);
  265.         }
  267.         return $this->currencyFactor[$currencyId] = (float) $currencyFactor;
  268.     }
  270.     private function validateTaxFree(SalesChannelContext $context, Cart $cart, CartBehavior $behaviorContext): Cart
  271.     {
  272.         $totalCartNetAmount = $cart->getPrice()->getPositionPrice();
  273.         if ($context->getTaxState() === CartPrice::TAX_STATE_GROSS) {
  274.             $totalCartNetAmount = $totalCartNetAmount - $cart->getLineItems()->getPrices()->getCalculatedTaxes()->getAmount();
  275.         }
  276.         $taxState = $this->detectTaxType($context, $totalCartNetAmount);
  277.         $previous = $context->getTaxState();
  278.         if ($taxState === $previous) {
  279.             return $cart;
  280.         }
  282.         $context->setTaxState($taxState);
  283.         $cart->setData(null);
  284.         $cart = $this->processor->process($cart, $context, $behaviorContext);
  285.         if ($previous !== CartPrice::TAX_STATE_FREE) {
  286.             $context->setTaxState($previous);
  287.         }
  289.         return $cart;
  290.     }
  291. }