src/Core/System/SalesChannel/Context/SalesChannelContextFactory.php line 52

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\System\SalesChannel\Context;
  5. use Shopware\Core\Checkout\Cart\Delivery\Struct\ShippingLocation;
  6. use Shopware\Core\Checkout\Cart\Price\Struct\CartPrice;
  7. use Shopware\Core\Checkout\Cart\Tax\TaxDetector;
  8. use Shopware\Core\Checkout\Customer\Aggregate\CustomerAddress\CustomerAddressEntity;
  9. use Shopware\Core\Checkout\Customer\CustomerEntity;
  10. use Shopware\Core\Checkout\Payment\Exception\UnknownPaymentMethodException;
  11. use Shopware\Core\Checkout\Payment\PaymentMethodEntity;
  12. use Shopware\Core\Framework\Api\Context\SalesChannelApiSource;
  13. use Shopware\Core\Framework\Context;
  14. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Pricing\CashRoundingConfig;
  16. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  17. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  18. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\MultiFilter;
  19. use Shopware\Core\Framework\Log\Package;
  20. use Shopware\Core\Framework\Plugin\Exception\DecorationPatternException;
  21. use Shopware\Core\System\Currency\Aggregate\CurrencyCountryRounding\CurrencyCountryRoundingEntity;
  22. use Shopware\Core\System\SalesChannel\BaseContext;
  23. use Shopware\Core\System\SalesChannel\Event\SalesChannelContextPermissionsChangedEvent;
  24. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  25. use Shopware\Core\System\Tax\Aggregate\TaxRule\TaxRuleCollection;
  26. use Shopware\Core\System\Tax\Aggregate\TaxRule\TaxRuleEntity;
  27. use Shopware\Core\System\Tax\TaxCollection;
  28. use Shopware\Core\System\Tax\TaxRuleType\TaxRuleTypeFilterInterface;
  29. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  30. use function array_unique;
  32. #[Package('sales-channel')]
  33. class SalesChannelContextFactory extends AbstractSalesChannelContextFactory
  34. {
  35.     /**
  36.      * @internal
  37.      *
  38.      * @param iterable<TaxRuleTypeFilterInterface> $taxRuleTypeFilter
  39.      */
  40.     public function __construct(private readonly EntityRepository $customerRepository, private readonly EntityRepository $customerGroupRepository, private readonly EntityRepository $addressRepository, private readonly EntityRepository $paymentMethodRepository, private readonly TaxDetector $taxDetector, private readonly iterable $taxRuleTypeFilter, private readonly EventDispatcherInterface $eventDispatcher, private readonly EntityRepository $currencyCountryRepository, private readonly AbstractBaseContextFactory $baseContextFactory)
  41.     {
  42.     }
  44.     public function getDecorated(): AbstractSalesChannelContextFactory
  45.     {
  46.         throw new DecorationPatternException(self::class);
  47.     }
  49.     public function create(string $token, string $salesChannelId, array $options = []): SalesChannelContext
  50.     {
  51.         // we split the context generation to allow caching of the base context
  52.         $base = $this->baseContextFactory->create($salesChannelId, $options);
  54.         // customer
  55.         $customer = null;
  56.         if (\array_key_exists(SalesChannelContextService::CUSTOMER_ID, $options) && $options[SalesChannelContextService::CUSTOMER_ID] !== null) {
  57.             //load logged in customer and set active addresses
  58.             $customer = $this->loadCustomer($options, $base->getContext());
  59.         }
  61.         $shippingLocation = $base->getShippingLocation();
  62.         if ($customer) {
  63.             /** @var CustomerAddressEntity $activeShippingAddress */
  64.             $activeShippingAddress = $customer->getActiveShippingAddress();
  65.             $shippingLocation = ShippingLocation::createFromAddress($activeShippingAddress);
  66.         }
  68.         $customerGroup = $base->getCurrentCustomerGroup();
  70.         if ($customer) {
  71.             $criteria = new Criteria([$customer->getGroupId()]);
  72.             $criteria->setTitle('context-factory::customer-group');
  73.             $customerGroup = $this->customerGroupRepository->search($criteria, $base->getContext())->first() ?? $customerGroup;
  74.         }
  76.         //loads tax rules based on active customer and delivery address
  77.         $taxRules = $this->getTaxRules($base, $customer, $shippingLocation);
  79.         //detect active payment method, first check if checkout defined other payment method, otherwise validate if customer logged in, at least use shop default
  80.         $payment = $this->getPaymentMethod($options, $base, $customer);
  82.         [$itemRounding, $totalRounding] = $this->getCashRounding($base, $shippingLocation);
  84.         $context = new Context(
  85.             $base->getContext()->getSource(),
  86.             [],
  87.             $base->getCurrencyId(),
  88.             $base->getContext()->getLanguageIdChain(),
  89.             $base->getContext()->getVersionId(),
  90.             $base->getCurrency()->getFactor(),
  91.             true,
  92.             CartPrice::TAX_STATE_GROSS,
  93.             $itemRounding
  94.         );
  96.         $salesChannelContext = new SalesChannelContext(
  97.             $context,
  98.             $token,
  99.             $options[SalesChannelContextService::DOMAIN_ID] ?? null,
  100.             $base->getSalesChannel(),
  101.             $base->getCurrency(),
  102.             $customerGroup,
  103.             $taxRules,
  104.             $payment,
  105.             $base->getShippingMethod(),
  106.             $shippingLocation,
  107.             $customer,
  108.             $itemRounding,
  109.             $totalRounding
  110.         );
  112.         if (\array_key_exists(SalesChannelContextService::PERMISSIONS, $options)) {
  113.             $salesChannelContext->setPermissions($options[SalesChannelContextService::PERMISSIONS]);
  115.             $event = new SalesChannelContextPermissionsChangedEvent($salesChannelContext, $options[SalesChannelContextService::PERMISSIONS]);
  116.             $this->eventDispatcher->dispatch($event);
  118.             $salesChannelContext->lockPermissions();
  119.         }
  121.         $salesChannelContext->setTaxState($this->taxDetector->getTaxState($salesChannelContext));
  123.         return $salesChannelContext;
  124.     }
  126.     private function getTaxRules(BaseContext $context, ?CustomerEntity $customer, ShippingLocation $shippingLocation): TaxCollection
  127.     {
  128.         $taxes = $context->getTaxRules()->getElements();
  130.         foreach ($taxes as $tax) {
  131.             $taxRules = $tax->getRules();
  132.             if ($taxRules === null) {
  133.                 continue;
  134.             }
  136.             $taxRules = $taxRules->filter(function (TaxRuleEntity $taxRule) use ($customer, $shippingLocation) {
  137.                 foreach ($this->taxRuleTypeFilter as $ruleTypeFilter) {
  138.                     if ($ruleTypeFilter->match($taxRule, $customer, $shippingLocation)) {
  139.                         return true;
  140.                     }
  141.                 }
  143.                 return false;
  144.             });
  145.             $taxRules->sortByTypePosition();
  146.             $taxRule = $taxRules->first();
  148.             $matchingRules = new TaxRuleCollection();
  149.             if ($taxRule) {
  150.                 $matchingRules->add($taxRule);
  151.             }
  152.             $tax->setRules($matchingRules);
  153.         }
  155.         return new TaxCollection($taxes);
  156.     }
  158.     /**
  159.      * @group not-deterministic
  160.      * NEXT-21735 - This is covered randomly
  161.      * @codeCoverageIgnore
  162.      *
  163.      * @param array<string, mixed> $options
  164.      */
  165.     private function getPaymentMethod(array $options, BaseContext $context, ?CustomerEntity $customer): PaymentMethodEntity
  166.     {
  167.         if ($customer === null || isset($options[SalesChannelContextService::PAYMENT_METHOD_ID])) {
  168.             return $context->getPaymentMethod();
  169.         }
  171.         $id = $customer->getLastPaymentMethodId() ?? $customer->getDefaultPaymentMethodId();
  172.         if ($id === $context->getPaymentMethod()->getId()) {
  173.             // NEXT-21735 - does not execute on every test run
  174.             return $context->getPaymentMethod();
  175.         }
  177.         $criteria = new Criteria([$id]);
  178.         $criteria->addAssociation('media');
  179.         $criteria->setTitle('context-factory::payment-method');
  181.         /** @var PaymentMethodEntity|null $paymentMethod */
  182.         $paymentMethod = $this->paymentMethodRepository->search($criteria, $context->getContext())->get($id);
  184.         if (!$paymentMethod) {
  185.             throw new UnknownPaymentMethodException($id);
  186.         }
  188.         return $paymentMethod;
  189.     }
  191.     /**
  192.      * @param array<string, mixed> $options
  193.      */
  194.     private function loadCustomer(array $options, Context $context): ?CustomerEntity
  195.     {
  196.         $addressIds = [];
  197.         $customerId = $options[SalesChannelContextService::CUSTOMER_ID];
  199.         $criteria = new Criteria([$customerId]);
  200.         $criteria->setTitle('context-factory::customer');
  201.         $criteria->addAssociation('salutation');
  202.         $criteria->addAssociation('defaultPaymentMethod');
  204.         /** @var SalesChannelApiSource $source */
  205.         $source = $context->getSource();
  207.         $criteria->addFilter(new MultiFilter(MultiFilter::CONNECTION_OR, [
  208.             new EqualsFilter('customer.boundSalesChannelId', null),
  209.             new EqualsFilter('customer.boundSalesChannelId', $source->getSalesChannelId()),
  210.         ]));
  212.         /** @var CustomerEntity|null $customer */
  213.         $customer = $this->customerRepository->search($criteria, $context)->get($customerId);
  215.         if (!$customer) {
  216.             return null;
  217.         }
  219.         $activeBillingAddressId = $options[SalesChannelContextService::BILLING_ADDRESS_ID] ?? $customer->getDefaultBillingAddressId();
  220.         $activeShippingAddressId = $options[SalesChannelContextService::SHIPPING_ADDRESS_ID] ?? $customer->getDefaultShippingAddressId();
  222.         $addressIds[] = $activeBillingAddressId;
  223.         $addressIds[] = $activeShippingAddressId;
  224.         $addressIds[] = $customer->getDefaultBillingAddressId();
  225.         $addressIds[] = $customer->getDefaultShippingAddressId();
  227.         $criteria = new Criteria(array_unique($addressIds));
  228.         $criteria->setTitle('context-factory::addresses');
  229.         $criteria->addAssociation('salutation');
  230.         $criteria->addAssociation('country');
  231.         $criteria->addAssociation('countryState');
  233.         $addresses = $this->addressRepository->search($criteria, $context);
  235.         /** @var CustomerAddressEntity $activeBillingAddress */
  236.         $activeBillingAddress = $addresses->get($activeBillingAddressId);
  237.         $customer->setActiveBillingAddress($activeBillingAddress);
  238.         /** @var CustomerAddressEntity $activeShippingAddress */
  239.         $activeShippingAddress = $addresses->get($activeShippingAddressId);
  240.         $customer->setActiveShippingAddress($activeShippingAddress);
  241.         /** @var CustomerAddressEntity $defaultBillingAddress */
  242.         $defaultBillingAddress = $addresses->get($customer->getDefaultBillingAddressId());
  243.         $customer->setDefaultBillingAddress($defaultBillingAddress);
  244.         /** @var CustomerAddressEntity $defaultShippingAddress */
  245.         $defaultShippingAddress = $addresses->get($customer->getDefaultShippingAddressId());
  246.         $customer->setDefaultShippingAddress($defaultShippingAddress);
  248.         return $customer;
  249.     }
  251.     /**
  252.      * @return CashRoundingConfig[]
  253.      *
  254.      * @group not-deterministic
  255.      * NEXT-21735 - This is covered randomly
  256.      * @codeCoverageIgnore
  257.      */
  258.     private function getCashRounding(BaseContext $context, ShippingLocation $shippingLocation): array
  259.     {
  260.         if ($context->getShippingLocation()->getCountry()->getId() === $shippingLocation->getCountry()->getId()) {
  261.             return [$context->getItemRounding(), $context->getTotalRounding()];
  262.         }
  264.         $criteria = new Criteria();
  265.         $criteria->setTitle('context-factory::cash-rounding');
  266.         $criteria->setLimit(1);
  267.         $criteria->addFilter(new EqualsFilter('currencyId', $context->getCurrencyId()));
  268.         $criteria->addFilter(new EqualsFilter('countryId', $shippingLocation->getCountry()->getId()));
  270.         /** @var CurrencyCountryRoundingEntity|null $countryConfig */
  271.         $countryConfig = $this->currencyCountryRepository
  272.             ->search($criteria, $context->getContext())
  273.             ->first();
  275.         if ($countryConfig) {
  276.             return [$countryConfig->getItemRounding(), $countryConfig->getTotalRounding()];
  277.         }
  279.         return [$context->getCurrency()->getItemRounding(), $context->getCurrency()->getTotalRounding()];
  280.     }
  281. }