src/Core/Checkout/Cart/CartPersister.php line 38

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Checkout\Cart;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\Checkout\Cart\Error\ErrorCollection;
  7. use Shopware\Core\Checkout\Cart\Event\CartSavedEvent;
  8. use Shopware\Core\Checkout\Cart\Event\CartVerifyPersistEvent;
  9. use Shopware\Core\Defaults;
  10. use Shopware\Core\Framework\Adapter\Cache\CacheValueCompressor;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Dbal\EntityDefinitionQueryHelper;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Doctrine\RetryableQuery;
  13. use Shopware\Core\Framework\Log\Package;
  14. use Shopware\Core\Framework\Plugin\Exception\DecorationPatternException;
  15. use Shopware\Core\Framework\Uuid\Exception\InvalidUuidException;
  16. use Shopware\Core\Framework\Uuid\Uuid;
  17. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  18. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  20. #[Package('checkout')]
  21. class CartPersister extends AbstractCartPersister
  22. {
  23.     /**
  24.      * @internal
  25.      */
  26.     public function __construct(private readonly Connection $connection, private readonly EventDispatcherInterface $eventDispatcher, private readonly CartSerializationCleaner $cartSerializationCleaner, private readonly bool $compress)
  27.     {
  28.     }
  30.     public function getDecorated(): AbstractCartPersister
  31.     {
  32.         throw new DecorationPatternException(self::class);
  33.     }
  35.     public function load(string $token, SalesChannelContext $context): Cart
  36.     {
  37.         // @deprecated tag:v6.6.0 - remove else part
  38.         if ($this->payloadExists()) {
  39.             $content = $this->connection->fetchAssociative(
  40.                 '#cart-persister::load
  41.                 SELECT `cart`.`payload`, `cart`.`rule_ids`, `cart`.`compressed` FROM cart WHERE `token` = :token',
  42.                 ['token' => $token]
  43.             );
  44.         } else {
  45.             $content = $this->connection->fetchAssociative(
  46.                 '#cart-persister::load
  47.                 SELECT `cart`.`cart` as payload, `cart`.`rule_ids`, 0 as `compressed` FROM cart WHERE `token` = :token',
  48.                 ['token' => $token]
  49.             );
  50.         }
  52.         if (!\is_array($content)) {
  53.             throw CartException::tokenNotFound($token);
  54.         }
  56.         $cart = $content['compressed'] ? CacheValueCompressor::uncompress($content['payload']) : unserialize((string) $content['payload']);
  58.         if (!$cart instanceof Cart) {
  59.             throw CartException::deserializeFailed();
  60.         }
  62.         $cart->setToken($token);
  63.         $cart->setRuleIds(json_decode((string) $content['rule_ids'], true, 512, \JSON_THROW_ON_ERROR) ?? []);
  65.         return $cart;
  66.     }
  68.     /**
  69.      * @throws InvalidUuidException
  70.      */
  71.     public function save(Cart $cart, SalesChannelContext $context): void
  72.     {
  73.         $shouldPersist = $this->shouldPersist($cart);
  75.         $event = new CartVerifyPersistEvent($context, $cart, $shouldPersist);
  76.         $this->eventDispatcher->dispatch($event);
  78.         if (!$event->shouldBePersisted()) {
  79.             $this->delete($cart->getToken(), $context);
  81.             return;
  82.         }
  84.         $payloadExists = $this->payloadExists();
  86.         $sql = <<<'SQL'
  87.             INSERT INTO `cart` (`token`, `currency_id`, `shipping_method_id`, `payment_method_id`, `country_id`, `sales_channel_id`, `customer_id`, `price`, `line_item_count`, `cart`, `rule_ids`, `created_at`)
  88.             VALUES (:token, :currency_id, :shipping_method_id, :payment_method_id, :country_id, :sales_channel_id, :customer_id, :price, :line_item_count, :payload, :rule_ids, :now)
  89.             ON DUPLICATE KEY UPDATE `currency_id` = :currency_id, `shipping_method_id` = :shipping_method_id, `payment_method_id` = :payment_method_id, `country_id` = :country_id, `sales_channel_id` = :sales_channel_id, `customer_id` = :customer_id,`price` = :price, `line_item_count` = :line_item_count, `cart` = :payload, `rule_ids` = :rule_ids, `updated_at` = :now;
  90.         SQL;
  92.         if ($payloadExists) {
  93.             $sql = <<<'SQL'
  94.                 INSERT INTO `cart` (`token`, `currency_id`, `shipping_method_id`, `payment_method_id`, `country_id`, `sales_channel_id`, `customer_id`, `price`, `line_item_count`, `payload`, `rule_ids`, `compressed`, `created_at`)
  95.                 VALUES (:token, :currency_id, :shipping_method_id, :payment_method_id, :country_id, :sales_channel_id, :customer_id, :price, :line_item_count, :payload, :rule_ids, :compressed, :now)
  96.                 ON DUPLICATE KEY UPDATE `currency_id` = :currency_id, `shipping_method_id` = :shipping_method_id, `payment_method_id` = :payment_method_id, `country_id` = :country_id, `sales_channel_id` = :sales_channel_id, `customer_id` = :customer_id,`price` = :price, `line_item_count` = :line_item_count, `payload` = :payload, `compressed` = :compressed, `rule_ids` = :rule_ids, `updated_at` = :now;
  97.             SQL;
  98.         }
  100.         $customerId = $context->getCustomer() ? Uuid::fromHexToBytes($context->getCustomer()->getId()) : null;
  102.         $data = [
  103.             'token' => $cart->getToken(),
  104.             'currency_id' => Uuid::fromHexToBytes($context->getCurrency()->getId()),
  105.             'shipping_method_id' => Uuid::fromHexToBytes($context->getShippingMethod()->getId()),
  106.             'payment_method_id' => Uuid::fromHexToBytes($context->getPaymentMethod()->getId()),
  107.             'country_id' => Uuid::fromHexToBytes($context->getShippingLocation()->getCountry()->getId()),
  108.             'sales_channel_id' => Uuid::fromHexToBytes($context->getSalesChannel()->getId()),
  109.             'customer_id' => $customerId,
  110.             'price' => $cart->getPrice()->getTotalPrice(),
  111.             'line_item_count' => $cart->getLineItems()->count(),
  112.             'payload' => $this->serializeCart($cart, $payloadExists),
  113.             'rule_ids' => json_encode($context->getRuleIds(), \JSON_THROW_ON_ERROR),
  114.             'now' => (new \DateTime())->format(Defaults::STORAGE_DATE_TIME_FORMAT),
  115.         ];
  117.         // @deprecated tag:v6.6.0 - remove if condition, but keep body
  118.         if ($payloadExists) {
  119.             $data['compressed'] = (int) $this->compress;
  120.         }
  122.         $query = new RetryableQuery($this->connection, $this->connection->prepare($sql));
  123.         $query->execute($data);
  125.         $this->eventDispatcher->dispatch(new CartSavedEvent($context, $cart));
  126.     }
  128.     public function delete(string $token, SalesChannelContext $context): void
  129.     {
  130.         $query = new RetryableQuery(
  131.             $this->connection,
  132.             $this->connection->prepare('DELETE FROM `cart` WHERE `token` = :token')
  133.         );
  134.         $query->execute(['token' => $token]);
  135.     }
  137.     public function replace(string $oldToken, string $newToken, SalesChannelContext $context): void
  138.     {
  139.         $this->connection->executeStatement(
  140.             'UPDATE `cart` SET `token` = :newToken WHERE `token` = :oldToken',
  141.             ['newToken' => $newToken, 'oldToken' => $oldToken]
  142.         );
  143.     }
  145.     /**
  146.      * @deprecated tag:v6.6.0 - will be removed
  147.      */
  148.     private function payloadExists(): bool
  149.     {
  150.         return EntityDefinitionQueryHelper::columnExists($this->connection, 'cart', 'payload');
  151.     }
  153.     private function serializeCart(Cart $cart, bool $payloadExists): string
  154.     {
  155.         $errors = $cart->getErrors();
  156.         $data = $cart->getData();
  158.         $cart->setErrors(new ErrorCollection());
  159.         $cart->setData(null);
  161.         $this->cartSerializationCleaner->cleanupCart($cart);
  163.         // @deprecated tag:v6.6.0 - remove else part
  164.         if ($payloadExists) {
  165.             $serialized = $this->compress ? CacheValueCompressor::compress($cart) : serialize($cart);
  166.         } else {
  167.             $serialized = serialize($cart);
  168.         }
  170.         $cart->setErrors($errors);
  171.         $cart->setData($data);
  173.         return $serialized;
  174.     }
  175. }