custom/plugins/FourtwosixShippingCostsCalculator/src/Decorator/Core/System/SalesChannel/Context/BaseContextFactoryDecorator.php line 184

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace FourtwosixShippingCostsCalculator\Decorator\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\CustomerAddress\CustomerAddressEntity;
  9. use Shopware\Core\Checkout\Payment\PaymentMethodEntity;
  10. use Shopware\Core\Checkout\Shipping\ShippingMethodEntity;
  11. use Shopware\Core\Defaults;
  12. use Shopware\Core\Framework\Api\Context\AdminSalesChannelApiSource;
  13. use Shopware\Core\Framework\Api\Context\SalesChannelApiSource;
  14. use Shopware\Core\Framework\Context;
  15. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
  16. use Shopware\Core\Framework\DataAbstractionLayer\Pricing\CashRoundingConfig;
  17. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  18. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  19. use Shopware\Core\Framework\Feature;
  20. use Shopware\Core\Framework\Uuid\Uuid;
  21. use Shopware\Core\System\Country\Aggregate\CountryState\CountryStateEntity;
  22. use Shopware\Core\System\Country\CountryEntity;
  23. use Shopware\Core\System\Currency\Aggregate\CurrencyCountryRounding\CurrencyCountryRoundingEntity;
  24. use Shopware\Core\System\Currency\CurrencyEntity;
  25. use Shopware\Core\System\SalesChannel\BaseContext;
  26. use Shopware\Core\System\SalesChannel\Context\BaseContextFactory;
  27. use Shopware\Core\System\SalesChannel\Context\SalesChannelContextService;
  28. use Shopware\Core\System\SalesChannel\SalesChannelEntity;
  29. use Shopware\Core\System\SalesChannel\SalesChannelException;
  30. use Shopware\Core\System\Tax\TaxCollection;
  32. class BaseContextFactoryDecorator extends BaseContextFactory
  33. {
  34.     public function __construct(private EntityRepository $salesChannelRepository,
  35.                                 private EntityRepository $currencyRepository,
  36.                                 private EntityRepository $customerGroupRepository,
  37.                                 private EntityRepository $countryRepository,
  38.                                 private EntityRepository $taxRepository,
  39.                                 private $paymentMethodRepository,
  40.                                 private EntityRepository $shippingMethodRepository,
  41.                                 private Connection       $connection,
  42.                                 private EntityRepository $countryStateRepository,
  43.                                 private EntityRepository $currencyCountryRepository)
  44.     {
  45.         parent::__construct($salesChannelRepository, $currencyRepository, $customerGroupRepository, $countryRepository, $taxRepository, $paymentMethodRepository, $shippingMethodRepository, $connection, $countryStateRepository, $currencyCountryRepository);
  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.         if (!Feature::isActive('FEATURE_NEXT_17276')) {
  66.             /*
  67.              * @deprecated tag:v6.5.0 - Overriding the languageId of the SalesChannel is deprecated and will be removed in v6.5.0
  68.              * use `$salesChannelContext->getLanguageId()` instead
  69.              */
  70.             if (\array_key_exists(SalesChannelContextService::LANGUAGE_ID, $options)) {
  71.                 $salesChannel->setLanguageId($options[SalesChannelContextService::LANGUAGE_ID]);
  72.             }
  73.         }
  75.         //load active currency, fallback to shop currency
  76.         $currency = $salesChannel->getCurrency();
  77.         if (\array_key_exists(SalesChannelContextService::CURRENCY_ID, $options)) {
  78.             $currencyId = $options[SalesChannelContextService::CURRENCY_ID];
  80.             $criteria = new Criteria([$currencyId]);
  81.             $criteria->setTitle('base-context-factory::currency');
  82.             $currency = $this->currencyRepository->search($criteria, $context)->get($currencyId);
  83.         }
  85.         //load not logged in customer with default shop configuration or with provided checkout scopes
  86.         $shippingLocation = $this->loadShippingLocation($options, $context, $salesChannel);
  88.         $groupId = $salesChannel->getCustomerGroupId();
  90.         /** @deprecated tag:v6.5.0 - Fallback customer group is deprecated and will be removed */
  91.         $groupIds = array_unique([$salesChannel->getCustomerGroupId(), Defaults::FALLBACK_CUSTOMER_GROUP]);
  93.         $criteria = new Criteria($groupIds);
  94.         $criteria->setTitle('base-context-factory::customer-group');
  96.         $customerGroups = $this->customerGroupRepository->search($criteria, $context);
  98.         /** @deprecated tag:v6.5.0 - Fallback customer group is deprecated and will be removed */
  99.         $fallbackGroup = $customerGroups->has(Defaults::FALLBACK_CUSTOMER_GROUP) ? $customerGroups->get(Defaults::FALLBACK_CUSTOMER_GROUP) : $customerGroups->get($salesChannel->getCustomerGroupId());
  100.         $customerGroup = $customerGroups->get($groupId);
  102.         //loads tax rules based on active customer and delivery address
  103.         $taxRules = $this->getTaxRules($context);
  105.         //detect active payment method, first check if checkout defined other payment method, otherwise validate if customer logged in, at least use shop default
  106.         $payment = $this->getPaymentMethod($options, $context, $salesChannel);
  108.         //detect active delivery method, at first checkout scope, at least shop default method
  109.         $shippingMethod = $this->getShippingMethod($options, $context, $salesChannel);
  111.         [$itemRounding, $totalRounding] = $this->getCashRounding($currency, $shippingLocation, $context);
  113.         $context = new Context(
  114.             $context->getSource(),
  115.             [],
  116.             $currency->getId(),
  117.             $context->getLanguageIdChain(),
  118.             $context->getVersionId(),
  119.             $currency->getFactor(),
  120.             true,
  121.             CartPrice::TAX_STATE_GROSS,
  122.             $itemRounding
  123.         );
  125.         return new BaseContext(
  126.             $context,
  127.             $salesChannel,
  128.             $currency,
  129.             $customerGroup,
  130.             $fallbackGroup,
  131.             $taxRules,
  132.             $payment,
  133.             $shippingMethod,
  134.             $shippingLocation,
  135.             $itemRounding,
  136.             $totalRounding
  137.         );
  138.     }
  140.     /**
  141.      * @param array<string, mixed> $options
  142.      * @fourtwosix-edit
  143.      */
  144.     private function loadShippingLocation(array $options, Context $context, SalesChannelEntity $salesChannel): ShippingLocation
  145.     {
  146.         $customerAddress = null;
  147.         if (isset($options["zipcode"])) {
  148.             $customerAddress = new CustomerAddressEntity();
  149.             $customerAddress->setZipcode($options["zipcode"]);
  150.         }
  152.         // allows previewing cart calculation for a specify state for not logged in customers
  153.         if (isset($options[SalesChannelContextService::COUNTRY_STATE_ID])) {
  154.             $countryStateId = $options[SalesChannelContextService::COUNTRY_STATE_ID];
  155.             \assert(\is_string($countryStateId) && Uuid::isValid($countryStateId));
  157.             $criteria = new Criteria([$countryStateId]);
  158.             $criteria->addAssociation('country');
  160.             $criteria->setTitle('base-context-factory::country');
  162.             $state = $this->countryStateRepository->search($criteria, $context)->get($countryStateId);
  164.             if (!$state instanceof CountryStateEntity) {
  165.                 throw SalesChannelException::countryStateNotFound($countryStateId);
  166.             }
  168.             /** @var CountryEntity $country */
  169.             $country = $state->getCountry();
  171.             if (isset($options["zipcode"])) {
  172.                 $customerAddress->setCountry($country);
  173.             }
  175.             return new ShippingLocation($country, $state, $customerAddress);
  176.         }
  178.         $countryId = $options[SalesChannelContextService::COUNTRY_ID] ?? $salesChannel->getCountryId();
  179.         \assert(\is_string($countryId) && Uuid::isValid($countryId));
  181.         $criteria = new Criteria([$countryId]);
  182.         $criteria->setTitle('base-context-factory::country');
  184.         $country = $this->countryRepository->search($criteria, $context)->get($countryId);
  186.         if (!$country instanceof CountryEntity) {
  187.             throw SalesChannelException::countryNotFound($countryId);
  188.         }
  190.         if (isset($options["zipcode"])) {
  191.             $customerAddress->setCountry($country);
  192.         }
  194.         return new ShippingLocation($country, null, $customerAddress);
  195.     }
  197.     private function getTaxRules(Context $context): TaxCollection
  198.     {
  199.         $criteria = new Criteria();
  200.         $criteria->setTitle('base-context-factory::taxes');
  201.         $criteria->addAssociation('rules.type');
  203.         /** @var TaxCollection $taxes */
  204.         $taxes = $this->taxRepository->search($criteria, $context)->getEntities();
  206.         return $taxes;
  207.     }
  209.     /**
  210.      * @param array<string, mixed> $options
  211.      */
  212.     private function getPaymentMethod(array $options, Context $context, SalesChannelEntity $salesChannel): PaymentMethodEntity
  213.     {
  214.         $id = $options[SalesChannelContextService::PAYMENT_METHOD_ID] ?? $salesChannel->getPaymentMethodId();
  216.         $criteria = (new Criteria([$id]))->addAssociation('media');
  217.         $criteria->setTitle('base-context-factory::payment-method');
  219.         $paymentMethod = $this->paymentMethodRepository
  220.             ->search($criteria, $context)
  221.             ->get($id);
  223.         if (!$paymentMethod instanceof PaymentMethodEntity) {
  224.             throw SalesChannelException::unknownPaymentMethod($id);
  225.         }
  227.         return $paymentMethod;
  228.     }
  230.     /**
  231.      * @param array<string, mixed> $options
  232.      */
  233.     private function getShippingMethod(array $options, Context $context, SalesChannelEntity $salesChannel): ShippingMethodEntity
  234.     {
  235.         $id = $options[SalesChannelContextService::SHIPPING_METHOD_ID] ?? $salesChannel->getShippingMethodId();
  237.         $ids = \array_unique(array_filter([$id, $salesChannel->getShippingMethodId()]));
  239.         $criteria = new Criteria($ids);
  240.         $criteria->addAssociation('media');
  241.         $criteria->setTitle('base-context-factory::shipping-method');
  243.         $shippingMethods = $this->shippingMethodRepository->search($criteria, $context);
  245.         /** @var ShippingMethodEntity $shippingMethod */
  246.         $shippingMethod = $shippingMethods->get($id) ?? $shippingMethods->get($salesChannel->getShippingMethodId());
  248.         return $shippingMethod;
  249.     }
  251.     /**
  252.      * @return CashRoundingConfig[]
  253.      */
  254.     private function getCashRounding(CurrencyEntity $currency, ShippingLocation $shippingLocation, Context $context): array
  255.     {
  256.         $criteria = new Criteria();
  257.         $criteria->setTitle('base-context-factory::cash-rounding');
  258.         $criteria->setLimit(1);
  259.         $criteria->addFilter(new EqualsFilter('currencyId', $currency->getId()));
  260.         $criteria->addFilter(new EqualsFilter('countryId', $shippingLocation->getCountry()->getId()));
  262.         $countryConfig = $this->currencyCountryRepository->search($criteria, $context)->first();
  264.         if ($countryConfig instanceof CurrencyCountryRoundingEntity) {
  265.             return [$countryConfig->getItemRounding(), $countryConfig->getTotalRounding()];
  266.         }
  268.         return [$currency->getItemRounding(), $currency->getTotalRounding()];
  269.     }
  271.     /**
  272.      * @param array<string, mixed> $session
  273.      */
  274.     private function getContext(string $salesChannelId, array $session): Context
  275.     {
  276.         $sql = '
  277.         # context-factory::base-context
  279.         SELECT
  280.           sales_channel.id as sales_channel_id,
  281.           sales_channel.language_id as sales_channel_default_language_id,
  282.           sales_channel.currency_id as sales_channel_currency_id,
  283.           currency.factor as sales_channel_currency_factor,
  284.           GROUP_CONCAT(LOWER(HEX(sales_channel_language.language_id))) as sales_channel_language_ids
  285.         FROM sales_channel
  286.             INNER JOIN currency
  287.                 ON sales_channel.currency_id = currency.id
  288.             LEFT JOIN sales_channel_language
  289.                 ON sales_channel_language.sales_channel_id = sales_channel.id
  290.         WHERE sales_channel.id = :id
  291.         GROUP BY sales_channel.id, sales_channel.language_id, sales_channel.currency_id, currency.factor';
  293.         $data = $this->connection->fetchAssociative($sql, [
  294.             'id' => Uuid::fromHexToBytes($salesChannelId),
  295.         ]);
  296.         if ($data === false) {
  297.             throw SalesChannelException::noContextData($salesChannelId);
  298.         }
  300.         if (isset($session[SalesChannelContextService::ORIGINAL_CONTEXT])) {
  301.             $origin = new AdminSalesChannelApiSource($salesChannelId, $session[SalesChannelContextService::ORIGINAL_CONTEXT]);
  302.         } else {
  303.             $origin = new SalesChannelApiSource($salesChannelId);
  304.         }
  306.         // explode all available languages for the provided sales channel
  307.         $languageIds = $data['sales_channel_language_ids'] ? explode(',', (string)$data['sales_channel_language_ids']) : [];
  308.         $languageIds = array_keys(array_flip($languageIds));
  310.         // 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`)
  311.         $defaultLanguageId = Uuid::fromBytesToHex($data['sales_channel_default_language_id']);
  313.         $languageChain = $this->buildLanguageChain($session, $defaultLanguageId, $languageIds);
  315.         $versionId = Defaults::LIVE_VERSION;
  316.         if (isset($session[SalesChannelContextService::VERSION_ID])) {
  317.             $versionId = $session[SalesChannelContextService::VERSION_ID];
  318.         }
  320.         return new Context(
  321.             $origin,
  322.             [],
  323.             Uuid::fromBytesToHex($data['sales_channel_currency_id']),
  324.             $languageChain,
  325.             $versionId,
  326.             (float)$data['sales_channel_currency_factor'],
  327.             true
  328.         );
  329.     }
  331.     /**
  332.      * @param array<string, mixed> $sessionOptions
  333.      * @param array<string> $availableLanguageIds
  334.      *
  335.      * @return non-empty-array<string>
  336.      */
  337.     private function buildLanguageChain(array $sessionOptions, string $defaultLanguageId, array $availableLanguageIds): array
  338.     {
  339.         $current = $sessionOptions[SalesChannelContextService::LANGUAGE_ID] ?? $defaultLanguageId;
  341.         if (!\is_string($current) || !Uuid::isValid($current)) {
  342.             throw SalesChannelException::invalidLanguageId();
  343.         }
  345.         // check provided language is part of the available languages
  346.         if (!\in_array($current, $availableLanguageIds, true)) {
  347.             throw SalesChannelException::providedLanguageNotAvailable($current, $availableLanguageIds);
  348.         }
  350.         if ($current === Defaults::LANGUAGE_SYSTEM) {
  351.             return [Defaults::LANGUAGE_SYSTEM];
  352.         }
  354.         // provided language can be a child language
  355.         return array_filter([$current, $this->getParentLanguageId($current), Defaults::LANGUAGE_SYSTEM]);
  356.     }
  358.     private function getParentLanguageId(string $languageId): ?string
  359.     {
  360.         $data = $this->connection->createQueryBuilder()
  361.             ->select(['LOWER(HEX(language.parent_id))'])
  362.             ->from('language')
  363.             ->where('language.id = :id')
  364.             ->setParameter('id', Uuid::fromHexToBytes($languageId))
  365.             ->executeQuery()
  366.             ->fetchOne();
  368.         if ($data === false) {
  369.             throw SalesChannelException::languageNotFound($languageId);
  370.         }
  372.         return $data;
  373.     }
  375. }