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

  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\Routing\Exception\LanguageNotFoundException;
  22. use Shopware\Core\Framework\Uuid\Uuid;
  23. use Shopware\Core\System\Country\Aggregate\CountryState\CountryStateEntity;
  24. use Shopware\Core\System\Country\CountryEntity;
  25. use Shopware\Core\System\Currency\Aggregate\CurrencyCountryRounding\CurrencyCountryRoundingEntity;
  26. use Shopware\Core\System\Currency\CurrencyEntity;
  27. use Shopware\Core\System\SalesChannel\BaseContext;
  28. use Shopware\Core\System\SalesChannel\SalesChannelEntity;
  29. use Shopware\Core\System\Tax\TaxCollection;
  30. use function array_unique;
  32. /**
  33.  * @internal
  34.  */
  35. #[Package('core')]
  36. class BaseContextFactory extends AbstractBaseContextFactory
  37. {
  38.     public function __construct(
  39.         private readonly EntityRepository $salesChannelRepository,
  40.         private readonly EntityRepository $currencyRepository,
  41.         private readonly EntityRepository $customerGroupRepository,
  42.         private readonly EntityRepository $countryRepository,
  43.         private readonly EntityRepository $taxRepository,
  44.         private readonly EntityRepository $paymentMethodRepository,
  45.         private readonly EntityRepository $shippingMethodRepository,
  46.         private readonly Connection $connection,
  47.         private readonly EntityRepository $countryStateRepository,
  48.         private readonly EntityRepository $currencyCountryRepository
  49.     ) {
  50.     }
  52.     public function create(string $salesChannelId, array $options = []): BaseContext
  53.     {
  54.         $context = $this->getContext($salesChannelId, $options);
  56.         $criteria = new Criteria([$salesChannelId]);
  57.         $criteria->setTitle('base-context-factory::sales-channel');
  58.         $criteria->addAssociation('currency');
  59.         $criteria->addAssociation('domains');
  61.         /** @var SalesChannelEntity|null $salesChannel */
  62.         $salesChannel = $this->salesChannelRepository->search($criteria, $context)
  63.             ->get($salesChannelId);
  65.         if (!$salesChannel) {
  66.             throw new \RuntimeException(sprintf('Sales channel with id %s not found or not valid!', $salesChannelId));
  67.         }
  69.         //load active currency, fallback to shop currency
  70.         /** @var CurrencyEntity $currency */
  71.         $currency = $salesChannel->getCurrency();
  72.         if (\array_key_exists(SalesChannelContextService::CURRENCY_ID, $options)) {
  73.             $currencyId = $options[SalesChannelContextService::CURRENCY_ID];
  74.             \assert(\is_string($currencyId) && Uuid::isValid($currencyId));
  76.             $criteria = new Criteria([$currencyId]);
  77.             $criteria->setTitle('base-context-factory::currency');
  79.             /** @var CurrencyEntity|null $currency */
  80.             $currency = $this->currencyRepository->search($criteria, $context)->get($currencyId);
  82.             if (!$currency) {
  83.                 throw new \RuntimeException(sprintf('Currency with id %s not found', $currencyId));
  84.             }
  85.         }
  87.         //load not logged in customer with default shop configuration or with provided checkout scopes
  88.         $shippingLocation = $this->loadShippingLocation($options, $context, $salesChannel);
  90.         $groupId = $salesChannel->getCustomerGroupId();
  92.         $criteria = new Criteria([$salesChannel->getCustomerGroupId()]);
  93.         $criteria->setTitle('base-context-factory::customer-group');
  95.         $customerGroups = $this->customerGroupRepository->search($criteria, $context);
  97.         /** @var CustomerGroupEntity $customerGroup */
  98.         $customerGroup = $customerGroups->get($groupId);
  100.         //loads tax rules based on active customer and delivery address
  101.         $taxRules = $this->getTaxRules($context);
  103.         //detect active payment method, first check if checkout defined other payment method, otherwise validate if customer logged in, at least use shop default
  104.         $payment = $this->getPaymentMethod($options, $context, $salesChannel);
  106.         //detect active delivery method, at first checkout scope, at least shop default method
  107.         $shippingMethod = $this->getShippingMethod($options, $context, $salesChannel);
  109.         [$itemRounding, $totalRounding] = $this->getCashRounding($currency, $shippingLocation, $context);
  111.         $context = new Context(
  112.             $context->getSource(),
  113.             [],
  114.             $currency->getId(),
  115.             $context->getLanguageIdChain(),
  116.             $context->getVersionId(),
  117.             $currency->getFactor(),
  118.             true,
  119.             CartPrice::TAX_STATE_GROSS,
  120.             $itemRounding
  121.         );
  123.         return new BaseContext(
  124.             $context,
  125.             $salesChannel,
  126.             $currency,
  127.             $customerGroup,
  128.             $taxRules,
  129.             $payment,
  130.             $shippingMethod,
  131.             $shippingLocation,
  132.             $itemRounding,
  133.             $totalRounding
  134.         );
  135.     }
  137.     private function getTaxRules(Context $context): TaxCollection
  138.     {
  139.         $criteria = new Criteria();
  140.         $criteria->setTitle('base-context-factory::taxes');
  141.         $criteria->addAssociation('rules.type');
  143.         /** @var TaxCollection $taxes */
  144.         $taxes = $this->taxRepository->search($criteria, $context)->getEntities();
  146.         return $taxes;
  147.     }
  149.     /**
  150.      * @param array<string, mixed> $options
  151.      */
  152.     private function getPaymentMethod(array $options, Context $context, SalesChannelEntity $salesChannel): PaymentMethodEntity
  153.     {
  154.         $id = $options[SalesChannelContextService::PAYMENT_METHOD_ID] ?? $salesChannel->getPaymentMethodId();
  156.         $criteria = (new Criteria([$id]))->addAssociation('media');
  157.         $criteria->setTitle('base-context-factory::payment-method');
  159.         /** @var PaymentMethodEntity|null $paymentMethod */
  160.         $paymentMethod = $this->paymentMethodRepository
  161.             ->search($criteria, $context)
  162.             ->get($id);
  164.         if (!$paymentMethod) {
  165.             throw new UnknownPaymentMethodException($id);
  166.         }
  168.         return $paymentMethod;
  169.     }
  171.     /**
  172.      * @param array<string, mixed> $options
  173.      */
  174.     private function getShippingMethod(array $options, Context $context, SalesChannelEntity $salesChannel): ShippingMethodEntity
  175.     {
  176.         $id = $options[SalesChannelContextService::SHIPPING_METHOD_ID] ?? $salesChannel->getShippingMethodId();
  178.         $ids = array_unique(array_filter([$id, $salesChannel->getShippingMethodId()]));
  180.         $criteria = new Criteria($ids);
  181.         $criteria->addAssociation('media');
  182.         $criteria->setTitle('base-context-factory::shipping-method');
  184.         $shippingMethods = $this->shippingMethodRepository->search($criteria, $context);
  186.         /** @var ShippingMethodEntity $shippingMethod */
  187.         $shippingMethod = $shippingMethods->get($id) ?? $shippingMethods->get($salesChannel->getShippingMethodId());
  189.         return $shippingMethod;
  190.     }
  192.     /**
  193.      * @param array<string, mixed> $session
  194.      */
  195.     private function getContext(string $salesChannelId, array $session): Context
  196.     {
  197.         $sql = '
  198.         # context-factory::base-context
  200.         SELECT
  201.           sales_channel.id as sales_channel_id,
  202.           sales_channel.language_id as sales_channel_default_language_id,
  203.           sales_channel.currency_id as sales_channel_currency_id,
  204.           currency.factor as sales_channel_currency_factor,
  205.           GROUP_CONCAT(LOWER(HEX(sales_channel_language.language_id))) as sales_channel_language_ids
  206.         FROM sales_channel
  207.             INNER JOIN currency
  208.                 ON sales_channel.currency_id = currency.id
  209.             LEFT JOIN sales_channel_language
  210.                 ON sales_channel_language.sales_channel_id = sales_channel.id
  211.         WHERE sales_channel.id = :id
  212.         GROUP BY sales_channel.id, sales_channel.language_id, sales_channel.currency_id, currency.factor';
  214.         $data = $this->connection->fetchAssociative($sql, [
  215.             'id' => Uuid::fromHexToBytes($salesChannelId),
  216.         ]);
  217.         if ($data === false) {
  218.             throw new \RuntimeException(sprintf('No context data found for SalesChannel "%s"', $salesChannelId));
  219.         }
  221.         if (isset($session[SalesChannelContextService::ORIGINAL_CONTEXT])) {
  222.             $origin = new AdminSalesChannelApiSource($salesChannelId, $session[SalesChannelContextService::ORIGINAL_CONTEXT]);
  223.         } else {
  224.             $origin = new SalesChannelApiSource($salesChannelId);
  225.         }
  227.         //explode all available languages for the provided sales channel
  228.         $languageIds = $data['sales_channel_language_ids'] ? explode(',', (string) $data['sales_channel_language_ids']) : [];
  229.         $languageIds = array_keys(array_flip($languageIds));
  231.         //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`)
  232.         $defaultLanguageId = Uuid::fromBytesToHex($data['sales_channel_default_language_id']);
  234.         $languageChain = $this->buildLanguageChain($session, $defaultLanguageId, $languageIds);
  236.         $versionId = Defaults::LIVE_VERSION;
  237.         if (isset($session[SalesChannelContextService::VERSION_ID])) {
  238.             $versionId = $session[SalesChannelContextService::VERSION_ID];
  239.         }
  241.         return new Context(
  242.             $origin,
  243.             [],
  244.             Uuid::fromBytesToHex($data['sales_channel_currency_id']),
  245.             $languageChain,
  246.             $versionId,
  247.             (float) $data['sales_channel_currency_factor'],
  248.             true
  249.         );
  250.     }
  252.     private function getParentLanguageId(string $languageId): ?string
  253.     {
  254.         if (!Uuid::isValid($languageId)) {
  255.             throw new LanguageNotFoundException($languageId);
  256.         }
  258.         $data = $this->connection->createQueryBuilder()
  259.             ->select(['LOWER(HEX(language.parent_id))'])
  260.             ->from('language')
  261.             ->where('language.id = :id')
  262.             ->setParameter('id', Uuid::fromHexToBytes($languageId))
  263.             ->executeQuery()
  264.             ->fetchOne();
  266.         if ($data === false) {
  267.             throw new LanguageNotFoundException($languageId);
  268.         }
  270.         return $data;
  271.     }
  273.     /**
  274.      * @param array<string, mixed> $options
  275.      */
  276.     private function loadShippingLocation(array $options, Context $context, SalesChannelEntity $salesChannel): ShippingLocation
  277.     {
  278.         //allows previewing cart calculation for a specify state for not logged in customers
  279.         if (isset($options[SalesChannelContextService::COUNTRY_STATE_ID])) {
  280.             $countryStateId = $options[SalesChannelContextService::COUNTRY_STATE_ID];
  281.             \assert(\is_string($countryStateId) && Uuid::isValid($countryStateId));
  283.             $criteria = new Criteria([$countryStateId]);
  284.             $criteria->addAssociation('country');
  286.             $criteria->setTitle('base-context-factory::country');
  288.             /** @var CountryStateEntity|null $state */
  289.             $state = $this->countryStateRepository->search($criteria, $context)
  290.                 ->get($countryStateId);
  292.             if (!$state) {
  293.                 throw new \RuntimeException(sprintf('Country state with id "%s" not found', $countryStateId));
  294.             }
  296.             /** @var CountryEntity $country */
  297.             $country = $state->getCountry();
  299.             return new ShippingLocation($country, $state, null);
  300.         }
  302.         $countryId = $options[SalesChannelContextService::COUNTRY_ID] ?? $salesChannel->getCountryId();
  303.         \assert(\is_string($countryId) && Uuid::isValid($countryId));
  305.         $criteria = new Criteria([$countryId]);
  306.         $criteria->setTitle('base-context-factory::country');
  308.         /** @var CountryEntity|null $country */
  309.         $country = $this->countryRepository->search($criteria, $context)->get($countryId);
  310.         if (!$country) {
  311.             throw new \RuntimeException(sprintf('Country with id "%s" not found', $countryId));
  312.         }
  314.         return ShippingLocation::createFromCountry($country);
  315.     }
  317.     /**
  318.      * @param array<string, mixed> $sessionOptions
  319.      * @param array<string> $availableLanguageIds
  320.      *
  321.      * @return non-empty-array<string>
  322.      */
  323.     private function buildLanguageChain(array $sessionOptions, string $defaultLanguageId, array $availableLanguageIds): array
  324.     {
  325.         $current = $sessionOptions[SalesChannelContextService::LANGUAGE_ID] ?? $defaultLanguageId;
  326.         \assert(\is_string($current) && Uuid::isValid($current));
  328.         //check provided language is part of the available languages
  329.         if (!\in_array($current, $availableLanguageIds, true)) {
  330.             throw new \RuntimeException(
  331.                 sprintf('Provided language %s is not in list of available languages: %s', $current, implode(', ', $availableLanguageIds))
  332.             );
  333.         }
  335.         if ($current === Defaults::LANGUAGE_SYSTEM) {
  336.             return [Defaults::LANGUAGE_SYSTEM];
  337.         }
  339.         //provided language can be a child language
  340.         return array_filter([$current, $this->getParentLanguageId($current), Defaults::LANGUAGE_SYSTEM]);
  341.     }
  343.     /**
  344.      * @return CashRoundingConfig[]
  345.      */
  346.     private function getCashRounding(CurrencyEntity $currency, ShippingLocation $shippingLocation, Context $context): array
  347.     {
  348.         $criteria = new Criteria();
  349.         $criteria->setTitle('base-context-factory::cash-rounding');
  350.         $criteria->setLimit(1);
  351.         $criteria->addFilter(new EqualsFilter('currencyId', $currency->getId()));
  352.         $criteria->addFilter(new EqualsFilter('countryId', $shippingLocation->getCountry()->getId()));
  354.         /** @var CurrencyCountryRoundingEntity|null $countryConfig */
  355.         $countryConfig = $this->currencyCountryRepository->search($criteria, $context)->first();
  357.         if ($countryConfig) {
  358.             return [$countryConfig->getItemRounding(), $countryConfig->getTotalRounding()];
  359.         }
  361.         return [$currency->getItemRounding(), $currency->getTotalRounding()];
  362.     }
  363. }