vendor/shopware/core/System/SalesChannel/Context/BaseContextFactory.php line 50

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\System\SalesChannel\Context;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\Checkout\Cart\Delivery\Struct\ShippingLocation;
  7. use Shopware\Core\Checkout\Cart\Price\Struct\CartPrice;
  8. use Shopware\Core\Checkout\Customer\Aggregate\CustomerGroup\CustomerGroupEntity;
  9. use Shopware\Core\Checkout\Payment\Exception\UnknownPaymentMethodException;
  10. use Shopware\Core\Checkout\Payment\PaymentMethodEntity;
  11. use Shopware\Core\Checkout\Shipping\ShippingMethodEntity;
  12. use Shopware\Core\Defaults;
  13. use Shopware\Core\Framework\Api\Context\AdminSalesChannelApiSource;
  14. use Shopware\Core\Framework\Api\Context\SalesChannelApiSource;
  15. use Shopware\Core\Framework\Context;
  16. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
  17. use Shopware\Core\Framework\DataAbstractionLayer\Pricing\CashRoundingConfig;
  18. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  19. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  20. use Shopware\Core\Framework\Log\Package;
  21. use Shopware\Core\Framework\Plugin\Exception\DecorationPatternException;
  22. use Shopware\Core\Framework\Routing\Exception\LanguageNotFoundException;
  23. use Shopware\Core\Framework\Uuid\Uuid;
  24. use Shopware\Core\System\Country\Aggregate\CountryState\CountryStateEntity;
  25. use Shopware\Core\System\Country\CountryEntity;
  26. use Shopware\Core\System\Currency\Aggregate\CurrencyCountryRounding\CurrencyCountryRoundingEntity;
  27. use Shopware\Core\System\Currency\CurrencyEntity;
  28. use Shopware\Core\System\SalesChannel\BaseContext;
  29. use Shopware\Core\System\SalesChannel\SalesChannelEntity;
  30. use Shopware\Core\System\Tax\TaxCollection;
  31. use function array_unique;
  33. /**
  34.  * @internal
  35.  */
  36. #[Package('core')]
  37. class BaseContextFactory extends AbstractBaseContextFactory
  38. {
  39.     public function __construct(private readonly EntityRepository $salesChannelRepository, private readonly EntityRepository $currencyRepository, private readonly EntityRepository $customerGroupRepository, private readonly EntityRepository $countryRepository, private readonly EntityRepository $taxRepository, private readonly EntityRepository $paymentMethodRepository, private readonly EntityRepository $shippingMethodRepository, private readonly Connection $connection, private readonly EntityRepository $countryStateRepository, private readonly EntityRepository $currencyCountryRepository)
  40.     {
  41.     }
  43.     public function getDecorated(): AbstractBaseContextFactory
  44.     {
  45.         throw new DecorationPatternException(self::class);
  46.     }
  48.     public function create(string $salesChannelId, array $options = []): BaseContext
  49.     {
  50.         $context = $this->getContext($salesChannelId, $options);
  52.         $criteria = new Criteria([$salesChannelId]);
  53.         $criteria->setTitle('base-context-factory::sales-channel');
  54.         $criteria->addAssociation('currency');
  55.         $criteria->addAssociation('domains');
  57.         /** @var SalesChannelEntity|null $salesChannel */
  58.         $salesChannel = $this->salesChannelRepository->search($criteria, $context)
  59.             ->get($salesChannelId);
  61.         if (!$salesChannel) {
  62.             throw new \RuntimeException(sprintf('Sales channel with id %s not found or not valid!', $salesChannelId));
  63.         }
  65.         //load active currency, fallback to shop currency
  66.         /** @var CurrencyEntity $currency */
  67.         $currency = $salesChannel->getCurrency();
  68.         if (\array_key_exists(SalesChannelContextService::CURRENCY_ID, $options)) {
  69.             $currencyId = $options[SalesChannelContextService::CURRENCY_ID];
  71.             $criteria = new Criteria([$currencyId]);
  72.             $criteria->setTitle('base-context-factory::currency');
  74.             /** @var CurrencyEntity|null $currency */
  75.             $currency = $this->currencyRepository->search($criteria, $context)->get($currencyId);
  77.             if (!$currency) {
  78.                 throw new \RuntimeException(sprintf('Currency with id %s not found', $currencyId));
  79.             }
  80.         }
  82.         //load not logged in customer with default shop configuration or with provided checkout scopes
  83.         $shippingLocation = $this->loadShippingLocation($options, $context, $salesChannel);
  85.         $groupId = $salesChannel->getCustomerGroupId();
  87.         $criteria = new Criteria([$salesChannel->getCustomerGroupId()]);
  88.         $criteria->setTitle('base-context-factory::customer-group');
  90.         $customerGroups = $this->customerGroupRepository->search($criteria, $context);
  92.         /** @var CustomerGroupEntity $customerGroup */
  93.         $customerGroup = $customerGroups->get($groupId);
  95.         //loads tax rules based on active customer and delivery address
  96.         $taxRules = $this->getTaxRules($context);
  98.         //detect active payment method, first check if checkout defined other payment method, otherwise validate if customer logged in, at least use shop default
  99.         $payment = $this->getPaymentMethod($options, $context, $salesChannel);
  101.         //detect active delivery method, at first checkout scope, at least shop default method
  102.         $shippingMethod = $this->getShippingMethod($options, $context, $salesChannel);
  104.         [$itemRounding, $totalRounding] = $this->getCashRounding($currency, $shippingLocation, $context);
  106.         $context = new Context(
  107.             $context->getSource(),
  108.             [],
  109.             $currency->getId(),
  110.             $context->getLanguageIdChain(),
  111.             $context->getVersionId(),
  112.             $currency->getFactor(),
  113.             true,
  114.             CartPrice::TAX_STATE_GROSS,
  115.             $itemRounding
  116.         );
  118.         return new BaseContext(
  119.             $context,
  120.             $salesChannel,
  121.             $currency,
  122.             $customerGroup,
  123.             $taxRules,
  124.             $payment,
  125.             $shippingMethod,
  126.             $shippingLocation,
  127.             $itemRounding,
  128.             $totalRounding
  129.         );
  130.     }
  132.     private function getTaxRules(Context $context): TaxCollection
  133.     {
  134.         $criteria = new Criteria();
  135.         $criteria->setTitle('base-context-factory::taxes');
  136.         $criteria->addAssociation('rules.type');
  138.         /** @var TaxCollection $taxes */
  139.         $taxes = $this->taxRepository->search($criteria, $context)->getEntities();
  141.         return $taxes;
  142.     }
  144.     /**
  145.      * @param array<string, mixed> $options
  146.      */
  147.     private function getPaymentMethod(array $options, Context $context, SalesChannelEntity $salesChannel): PaymentMethodEntity
  148.     {
  149.         $id = $options[SalesChannelContextService::PAYMENT_METHOD_ID] ?? $salesChannel->getPaymentMethodId();
  151.         $criteria = (new Criteria([$id]))->addAssociation('media');
  152.         $criteria->setTitle('base-context-factory::payment-method');
  154.         /** @var PaymentMethodEntity|null $paymentMethod */
  155.         $paymentMethod = $this->paymentMethodRepository
  156.             ->search($criteria, $context)
  157.             ->get($id);
  159.         if (!$paymentMethod) {
  160.             throw new UnknownPaymentMethodException($id);
  161.         }
  163.         return $paymentMethod;
  164.     }
  166.     /**
  167.      * @param array<string, mixed> $options
  168.      */
  169.     private function getShippingMethod(array $options, Context $context, SalesChannelEntity $salesChannel): ShippingMethodEntity
  170.     {
  171.         $id = $options[SalesChannelContextService::SHIPPING_METHOD_ID] ?? $salesChannel->getShippingMethodId();
  173.         $ids = array_unique(array_filter([$id, $salesChannel->getShippingMethodId()]));
  175.         $criteria = new Criteria($ids);
  176.         $criteria->addAssociation('media');
  177.         $criteria->setTitle('base-context-factory::shipping-method');
  179.         $shippingMethods = $this->shippingMethodRepository->search($criteria, $context);
  181.         /** @var ShippingMethodEntity $shippingMethod */
  182.         $shippingMethod = $shippingMethods->get($id) ?? $shippingMethods->get($salesChannel->getShippingMethodId());
  184.         return $shippingMethod;
  185.     }
  187.     /**
  188.      * @param array<string, mixed> $session
  189.      */
  190.     private function getContext(string $salesChannelId, array $session): Context
  191.     {
  192.         $sql = '
  193.         # context-factory::base-context
  195.         SELECT
  196.           sales_channel.id as sales_channel_id,
  197.           sales_channel.language_id as sales_channel_default_language_id,
  198.           sales_channel.currency_id as sales_channel_currency_id,
  199.           currency.factor as sales_channel_currency_factor,
  200.           GROUP_CONCAT(LOWER(HEX(sales_channel_language.language_id))) as sales_channel_language_ids
  201.         FROM sales_channel
  202.             INNER JOIN currency
  203.                 ON sales_channel.currency_id = currency.id
  204.             LEFT JOIN sales_channel_language
  205.                 ON sales_channel_language.sales_channel_id = sales_channel.id
  206.         WHERE sales_channel.id = :id
  207.         GROUP BY sales_channel.id, sales_channel.language_id, sales_channel.currency_id, currency.factor';
  209.         $data = $this->connection->fetchAssociative($sql, [
  210.             'id' => Uuid::fromHexToBytes($salesChannelId),
  211.         ]);
  212.         if ($data === false) {
  213.             throw new \RuntimeException(sprintf('No context data found for SalesChannel "%s"', $salesChannelId));
  214.         }
  216.         if (isset($session[SalesChannelContextService::ORIGINAL_CONTEXT])) {
  217.             $origin = new AdminSalesChannelApiSource($salesChannelId, $session[SalesChannelContextService::ORIGINAL_CONTEXT]);
  218.         } else {
  219.             $origin = new SalesChannelApiSource($salesChannelId);
  220.         }
  222.         //explode all available languages for the provided sales channel
  223.         $languageIds = $data['sales_channel_language_ids'] ? explode(',', (string) $data['sales_channel_language_ids']) : [];
  224.         $languageIds = array_keys(array_flip($languageIds));
  226.         //check which language should be used in the current request (request header set, or context already contains a language - stored in `sales_channel_api_context`)
  227.         $defaultLanguageId = Uuid::fromBytesToHex($data['sales_channel_default_language_id']);
  229.         $languageChain = $this->buildLanguageChain($session, $defaultLanguageId, $languageIds);
  231.         $versionId = Defaults::LIVE_VERSION;
  232.         if (isset($session[SalesChannelContextService::VERSION_ID])) {
  233.             $versionId = $session[SalesChannelContextService::VERSION_ID];
  234.         }
  236.         return new Context(
  237.             $origin,
  238.             [],
  239.             Uuid::fromBytesToHex($data['sales_channel_currency_id']),
  240.             $languageChain,
  241.             $versionId,
  242.             (float) $data['sales_channel_currency_factor'],
  243.             true
  244.         );
  245.     }
  247.     private function getParentLanguageId(string $languageId): ?string
  248.     {
  249.         if (!Uuid::isValid($languageId)) {
  250.             throw new LanguageNotFoundException($languageId);
  251.         }
  253.         $data = $this->connection->createQueryBuilder()
  254.             ->select(['LOWER(HEX(language.parent_id))'])
  255.             ->from('language')
  256.             ->where('language.id = :id')
  257.             ->setParameter('id', Uuid::fromHexToBytes($languageId))
  258.             ->executeQuery()
  259.             ->fetchOne();
  261.         if ($data === false) {
  262.             throw new LanguageNotFoundException($languageId);
  263.         }
  265.         return $data;
  266.     }
  268.     /**
  269.      * @param array<string, mixed> $options
  270.      */
  271.     private function loadShippingLocation(array $options, Context $context, SalesChannelEntity $salesChannel): ShippingLocation
  272.     {
  273.         //allows previewing cart calculation for a specify state for not logged in customers
  274.         if (isset($options[SalesChannelContextService::COUNTRY_STATE_ID])) {
  275.             $criteria = new Criteria([$options[SalesChannelContextService::COUNTRY_STATE_ID]]);
  276.             $criteria->addAssociation('country');
  278.             $criteria->setTitle('base-context-factory::country');
  280.             /** @var CountryStateEntity|null $state */
  281.             $state = $this->countryStateRepository->search($criteria, $context)
  282.                 ->get($options[SalesChannelContextService::COUNTRY_STATE_ID]);
  284.             if (!$state) {
  285.                 throw new \RuntimeException(sprintf('Country state with id "%s" not found', $options[SalesChannelContextService::COUNTRY_STATE_ID]));
  286.             }
  288.             /** @var CountryEntity $country */
  289.             $country = $state->getCountry();
  291.             return new ShippingLocation($country, $state, null);
  292.         }
  294.         $countryId = $options[SalesChannelContextService::COUNTRY_ID] ?? $salesChannel->getCountryId();
  296.         $criteria = new Criteria([$countryId]);
  297.         $criteria->setTitle('base-context-factory::country');
  299.         /** @var CountryEntity|null $country */
  300.         $country = $this->countryRepository->search($criteria, $context)->get($countryId);
  301.         if (!$country) {
  302.             throw new \RuntimeException(sprintf('Country with id "%s" not found', $countryId));
  303.         }
  305.         return ShippingLocation::createFromCountry($country);
  306.     }
  308.     /**
  309.      * @param array<string, mixed> $sessionOptions
  310.      * @param array<string> $availableLanguageIds
  311.      *
  312.      * @return non-empty-array<string>
  313.      */
  314.     private function buildLanguageChain(array $sessionOptions, string $defaultLanguageId, array $availableLanguageIds): array
  315.     {
  316.         $current = $sessionOptions[SalesChannelContextService::LANGUAGE_ID] ?? $defaultLanguageId;
  318.         //check provided language is part of the available languages
  319.         if (!\in_array($current, $availableLanguageIds, true)) {
  320.             throw new \RuntimeException(
  321.                 sprintf('Provided language %s is not in list of available languages: %s', $current, implode(', ', $availableLanguageIds))
  322.             );
  323.         }
  325.         if ($current === Defaults::LANGUAGE_SYSTEM) {
  326.             return [Defaults::LANGUAGE_SYSTEM];
  327.         }
  329.         //provided language can be a child language
  330.         return array_filter([$current, $this->getParentLanguageId($current), Defaults::LANGUAGE_SYSTEM]);
  331.     }
  333.     /**
  334.      * @return CashRoundingConfig[]
  335.      */
  336.     private function getCashRounding(CurrencyEntity $currency, ShippingLocation $shippingLocation, Context $context): array
  337.     {
  338.         $criteria = new Criteria();
  339.         $criteria->setTitle('base-context-factory::cash-rounding');
  340.         $criteria->setLimit(1);
  341.         $criteria->addFilter(new EqualsFilter('currencyId', $currency->getId()));
  342.         $criteria->addFilter(new EqualsFilter('countryId', $shippingLocation->getCountry()->getId()));
  344.         /** @var CurrencyCountryRoundingEntity|null $countryConfig */
  345.         $countryConfig = $this->currencyCountryRepository->search($criteria, $context)->first();
  347.         if ($countryConfig) {
  348.             return [$countryConfig->getItemRounding(), $countryConfig->getTotalRounding()];
  349.         }
  351.         return [$currency->getItemRounding(), $currency->getTotalRounding()];
  352.     }
  353. }