vendor/shopware/core/System/SalesChannel/Context/SalesChannelContextFactory.php line 61

  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(
  41.         private readonly EntityRepository $customerRepository,
  42.         private readonly EntityRepository $customerGroupRepository,
  43.         private readonly EntityRepository $addressRepository,
  44.         private readonly EntityRepository $paymentMethodRepository,
  45.         private readonly TaxDetector $taxDetector,
  46.         private readonly iterable $taxRuleTypeFilter,
  47.         private readonly EventDispatcherInterface $eventDispatcher,
  48.         private readonly EntityRepository $currencyCountryRepository,
  49.         private readonly AbstractBaseContextFactory $baseContextFactory
  50.     ) {
  51.     }
  53.     public function getDecorated(): AbstractSalesChannelContextFactory
  54.     {
  55.         throw new DecorationPatternException(self::class);
  56.     }
  58.     public function create(string $token, string $salesChannelId, array $options = []): SalesChannelContext
  59.     {
  60.         // we split the context generation to allow caching of the base context
  61.         $base = $this->baseContextFactory->create($salesChannelId, $options);
  63.         // customer
  64.         $customer = null;
  65.         if (\array_key_exists(SalesChannelContextService::CUSTOMER_ID, $options) && $options[SalesChannelContextService::CUSTOMER_ID] !== null) {
  66.             //load logged in customer and set active addresses
  67.             $customer = $this->loadCustomer($options, $base->getContext());
  68.         }
  70.         $shippingLocation = $base->getShippingLocation();
  71.         if ($customer) {
  72.             /** @var CustomerAddressEntity $activeShippingAddress */
  73.             $activeShippingAddress = $customer->getActiveShippingAddress();
  74.             $shippingLocation = ShippingLocation::createFromAddress($activeShippingAddress);
  75.         }
  77.         $customerGroup = $base->getCurrentCustomerGroup();
  79.         if ($customer) {
  80.             $criteria = new Criteria([$customer->getGroupId()]);
  81.             $criteria->setTitle('context-factory::customer-group');
  82.             $customerGroup = $this->customerGroupRepository->search($criteria, $base->getContext())->first() ?? $customerGroup;
  83.         }
  85.         //loads tax rules based on active customer and delivery address
  86.         $taxRules = $this->getTaxRules($base, $customer, $shippingLocation);
  88.         //detect active payment method, first check if checkout defined other payment method, otherwise validate if customer logged in, at least use shop default
  89.         $payment = $this->getPaymentMethod($options, $base, $customer);
  91.         [$itemRounding, $totalRounding] = $this->getCashRounding($base, $shippingLocation);
  93.         $context = new Context(
  94.             $base->getContext()->getSource(),
  95.             [],
  96.             $base->getCurrencyId(),
  97.             $base->getContext()->getLanguageIdChain(),
  98.             $base->getContext()->getVersionId(),
  99.             $base->getCurrency()->getFactor(),
  100.             true,
  101.             CartPrice::TAX_STATE_GROSS,
  102.             $itemRounding
  103.         );
  105.         $salesChannelContext = new SalesChannelContext(
  106.             $context,
  107.             $token,
  108.             $options[SalesChannelContextService::DOMAIN_ID] ?? null,
  109.             $base->getSalesChannel(),
  110.             $base->getCurrency(),
  111.             $customerGroup,
  112.             $taxRules,
  113.             $payment,
  114.             $base->getShippingMethod(),
  115.             $shippingLocation,
  116.             $customer,
  117.             $itemRounding,
  118.             $totalRounding
  119.         );
  121.         if (\array_key_exists(SalesChannelContextService::PERMISSIONS, $options)) {
  122.             $salesChannelContext->setPermissions($options[SalesChannelContextService::PERMISSIONS]);
  124.             $event = new SalesChannelContextPermissionsChangedEvent($salesChannelContext, $options[SalesChannelContextService::PERMISSIONS]);
  125.             $this->eventDispatcher->dispatch($event);
  127.             $salesChannelContext->lockPermissions();
  128.         }
  130.         $salesChannelContext->setTaxState($this->taxDetector->getTaxState($salesChannelContext));
  132.         return $salesChannelContext;
  133.     }
  135.     private function getTaxRules(BaseContext $context, ?CustomerEntity $customer, ShippingLocation $shippingLocation): TaxCollection
  136.     {
  137.         $taxes = $context->getTaxRules()->getElements();
  139.         foreach ($taxes as $tax) {
  140.             $taxRules = $tax->getRules();
  141.             if ($taxRules === null) {
  142.                 continue;
  143.             }
  145.             $taxRules = $taxRules->filter(function (TaxRuleEntity $taxRule) use ($customer, $shippingLocation) {
  146.                 foreach ($this->taxRuleTypeFilter as $ruleTypeFilter) {
  147.                     if ($ruleTypeFilter->match($taxRule, $customer, $shippingLocation)) {
  148.                         return true;
  149.                     }
  150.                 }
  152.                 return false;
  153.             });
  154.             $taxRules->sortByTypePosition();
  155.             $taxRule = $taxRules->first();
  157.             $matchingRules = new TaxRuleCollection();
  158.             if ($taxRule) {
  159.                 $matchingRules->add($taxRule);
  160.             }
  161.             $tax->setRules($matchingRules);
  162.         }
  164.         return new TaxCollection($taxes);
  165.     }
  167.     /**
  168.      * @group not-deterministic
  169.      * NEXT-21735 - This is covered randomly
  170.      *
  171.      * @codeCoverageIgnore
  172.      *
  173.      * @param array<string, mixed> $options
  174.      */
  175.     private function getPaymentMethod(array $options, BaseContext $context, ?CustomerEntity $customer): PaymentMethodEntity
  176.     {
  177.         if ($customer === null || isset($options[SalesChannelContextService::PAYMENT_METHOD_ID])) {
  178.             return $context->getPaymentMethod();
  179.         }
  181.         $id = $customer->getLastPaymentMethodId() ?? $customer->getDefaultPaymentMethodId();
  182.         if ($id === $context->getPaymentMethod()->getId()) {
  183.             // NEXT-21735 - does not execute on every test run
  184.             return $context->getPaymentMethod();
  185.         }
  187.         $criteria = new Criteria([$id]);
  188.         $criteria->addAssociation('media');
  189.         $criteria->setTitle('context-factory::payment-method');
  191.         /** @var PaymentMethodEntity|null $paymentMethod */
  192.         $paymentMethod = $this->paymentMethodRepository->search($criteria, $context->getContext())->get($id);
  194.         if (!$paymentMethod) {
  195.             throw new UnknownPaymentMethodException($id);
  196.         }
  198.         return $paymentMethod;
  199.     }
  201.     /**
  202.      * @param array<string, mixed> $options
  203.      */
  204.     private function loadCustomer(array $options, Context $context): ?CustomerEntity
  205.     {
  206.         $addressIds = [];
  207.         $customerId = $options[SalesChannelContextService::CUSTOMER_ID];
  209.         $criteria = new Criteria([$customerId]);
  210.         $criteria->setTitle('context-factory::customer');
  211.         $criteria->addAssociation('salutation');
  212.         $criteria->addAssociation('defaultPaymentMethod');
  214.         /** @var SalesChannelApiSource $source */
  215.         $source = $context->getSource();
  217.         $criteria->addFilter(new MultiFilter(MultiFilter::CONNECTION_OR, [
  218.             new EqualsFilter('customer.boundSalesChannelId', null),
  219.             new EqualsFilter('customer.boundSalesChannelId', $source->getSalesChannelId()),
  220.         ]));
  222.         /** @var CustomerEntity|null $customer */
  223.         $customer = $this->customerRepository->search($criteria, $context)->get($customerId);
  225.         if (!$customer) {
  226.             return null;
  227.         }
  229.         $activeBillingAddressId = $options[SalesChannelContextService::BILLING_ADDRESS_ID] ?? $customer->getDefaultBillingAddressId();
  230.         $activeShippingAddressId = $options[SalesChannelContextService::SHIPPING_ADDRESS_ID] ?? $customer->getDefaultShippingAddressId();
  232.         $addressIds[] = $activeBillingAddressId;
  233.         $addressIds[] = $activeShippingAddressId;
  234.         $addressIds[] = $customer->getDefaultBillingAddressId();
  235.         $addressIds[] = $customer->getDefaultShippingAddressId();
  237.         $criteria = new Criteria(array_unique($addressIds));
  238.         $criteria->setTitle('context-factory::addresses');
  239.         $criteria->addAssociation('salutation');
  240.         $criteria->addAssociation('country');
  241.         $criteria->addAssociation('countryState');
  243.         $addresses = $this->addressRepository->search($criteria, $context);
  245.         /** @var CustomerAddressEntity $activeBillingAddress */
  246.         $activeBillingAddress = $addresses->get($activeBillingAddressId);
  247.         $customer->setActiveBillingAddress($activeBillingAddress);
  248.         /** @var CustomerAddressEntity $activeShippingAddress */
  249.         $activeShippingAddress = $addresses->get($activeShippingAddressId);
  250.         $customer->setActiveShippingAddress($activeShippingAddress);
  251.         /** @var CustomerAddressEntity $defaultBillingAddress */
  252.         $defaultBillingAddress = $addresses->get($customer->getDefaultBillingAddressId());
  253.         $customer->setDefaultBillingAddress($defaultBillingAddress);
  254.         /** @var CustomerAddressEntity $defaultShippingAddress */
  255.         $defaultShippingAddress = $addresses->get($customer->getDefaultShippingAddressId());
  256.         $customer->setDefaultShippingAddress($defaultShippingAddress);
  258.         return $customer;
  259.     }
  261.     /**
  262.      * @return CashRoundingConfig[]
  263.      *
  264.      * @group not-deterministic
  265.      * NEXT-21735 - This is covered randomly
  266.      *
  267.      * @codeCoverageIgnore
  268.      */
  269.     private function getCashRounding(BaseContext $context, ShippingLocation $shippingLocation): array
  270.     {
  271.         if ($context->getShippingLocation()->getCountry()->getId() === $shippingLocation->getCountry()->getId()) {
  272.             return [$context->getItemRounding(), $context->getTotalRounding()];
  273.         }
  275.         $criteria = new Criteria();
  276.         $criteria->setTitle('context-factory::cash-rounding');
  277.         $criteria->setLimit(1);
  278.         $criteria->addFilter(new EqualsFilter('currencyId', $context->getCurrencyId()));
  279.         $criteria->addFilter(new EqualsFilter('countryId', $shippingLocation->getCountry()->getId()));
  281.         /** @var CurrencyCountryRoundingEntity|null $countryConfig */
  282.         $countryConfig = $this->currencyCountryRepository
  283.             ->search($criteria, $context->getContext())
  284.             ->first();
  286.         if ($countryConfig) {
  287.             return [$countryConfig->getItemRounding(), $countryConfig->getTotalRounding()];
  288.         }
  290.         return [$context->getCurrency()->getItemRounding(), $context->getCurrency()->getTotalRounding()];
  291.     }
  292. }