src/Core/System/SalesChannel/Context/SalesChannelContextPersister.php line 129

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\System\SalesChannel\Context;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\Checkout\Cart\AbstractCartPersister;
  7. use Shopware\Core\Defaults;
  8. use Shopware\Core\Framework\Log\Package;
  9. use Shopware\Core\Framework\Util\Random;
  10. use Shopware\Core\Framework\Uuid\Uuid;
  11. use Shopware\Core\System\SalesChannel\Event\SalesChannelContextTokenChangeEvent;
  12. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  13. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  15. #[Package('core')]
  16. class SalesChannelContextPersister
  17. {
  18.     private readonly string $lifetimeInterval;
  20.     /**
  21.      * @internal
  22.      */
  23.     public function __construct(
  24.         private readonly Connection $connection,
  25.         private readonly EventDispatcherInterface $eventDispatcher,
  26.         private readonly AbstractCartPersister $cartPersister,
  27.         ?string $lifetimeInterval = 'P1D'
  28.     ) {
  29.         $this->lifetimeInterval = $lifetimeInterval ?? 'P1D';
  30.     }
  32.     /**
  33.      * @param array<string, mixed> $newParameters
  34.      */
  35.     public function save(string $token, array $newParameters, string $salesChannelId, ?string $customerId = null): void
  36.     {
  37.         $existing = $this->load($token, $salesChannelId, $customerId);
  39.         $parameters = array_replace_recursive($existing, $newParameters);
  40.         if (isset($newParameters['permissions']) && $newParameters['permissions'] === []) {
  41.             $parameters['permissions'] = [];
  42.         }
  44.         unset($parameters['token']);
  46.         $this->connection->executeStatement(
  47.             'REPLACE INTO sales_channel_api_context (`token`, `payload`, `sales_channel_id`, `customer_id`, `updated_at`)
  48.                 VALUES (:token, :payload, :salesChannelId, :customerId, :updatedAt)',
  49.             [
  50.                 'token' => $token,
  51.                 'payload' => json_encode($parameters, \JSON_THROW_ON_ERROR),
  52.                 'salesChannelId' => $salesChannelId ? Uuid::fromHexToBytes($salesChannelId) : null,
  53.                 'customerId' => $customerId ? Uuid::fromHexToBytes($customerId) : null,
  54.                 'updatedAt' => (new \DateTimeImmutable())->format(Defaults::STORAGE_DATE_TIME_FORMAT),
  55.             ]
  56.         );
  57.     }
  59.     public function delete(string $token, string $salesChannelId, ?string $customerId = null): void
  60.     {
  61.         $this->connection->executeStatement(
  62.             'DELETE FROM sales_channel_api_context WHERE token = :token',
  63.             [
  64.                 'token' => $token,
  65.             ]
  66.         );
  67.     }
  69.     public function replace(string $oldToken, SalesChannelContext $context): string
  70.     {
  71.         $newToken = Random::getAlphanumericString(32);
  73.         $affected = $this->connection->executeStatement(
  74.             'UPDATE `sales_channel_api_context`
  75.                    SET `token` = :newToken,
  76.                        `updated_at` = :updatedAt
  77.                    WHERE `token` = :oldToken',
  78.             [
  79.                 'newToken' => $newToken,
  80.                 'oldToken' => $oldToken,
  81.                 'updatedAt' => (new \DateTimeImmutable())->format(Defaults::STORAGE_DATE_TIME_FORMAT),
  82.             ]
  83.         );
  85.         if ($affected === 0) {
  86.             $customer = $context->getCustomer();
  88.             $this->connection->insert('sales_channel_api_context', [
  89.                 'token' => $newToken,
  90.                 'payload' => json_encode([]),
  91.                 'sales_channel_id' => Uuid::fromHexToBytes($context->getSalesChannel()->getId()),
  92.                 'customer_id' => $customer ? Uuid::fromHexToBytes($customer->getId()) : null,
  93.                 'updated_at' => (new \DateTimeImmutable())->format(Defaults::STORAGE_DATE_TIME_FORMAT),
  94.             ]);
  95.         }
  97.         $this->cartPersister->replace($oldToken, $newToken, $context);
  99.         $context->assign(['token' => $newToken]);
  100.         $this->eventDispatcher->dispatch(new SalesChannelContextTokenChangeEvent($context, $oldToken, $newToken));
  102.         return $newToken;
  103.     }
  105.     /**
  106.      * @return array<string, mixed>
  107.      */
  108.     public function load(string $token, string $salesChannelId, ?string $customerId = null): array
  109.     {
  110.         $qb = $this->connection->createQueryBuilder();
  112.         $qb->select('*');
  113.         $qb->from('sales_channel_api_context');
  115.         $qb->where('sales_channel_id = :salesChannelId');
  116.         $qb->setParameter('salesChannelId', Uuid::fromHexToBytes($salesChannelId));
  118.         if ($customerId !== null) {
  119.             $qb->andWhere('(token = :token OR customer_id = :customerId)');
  120.             $qb->setParameter('token', $token);
  121.             $qb->setParameter('customerId', Uuid::fromHexToBytes($customerId));
  122.             $qb->setMaxResults(2);
  123.         } else {
  124.             $qb->andWhere('token = :token');
  125.             $qb->setParameter('token', $token);
  126.             $qb->setMaxResults(1);
  127.         }
  129.         $data = $qb->executeQuery()->fetchAllAssociative();
  131.         if (empty($data)) {
  132.             return [];
  133.         }
  135.         $customerContext = $salesChannelId && $customerId ? $this->getCustomerContext($data, $salesChannelId, $customerId) : null;
  137.         $context = $customerContext ?? array_shift($data);
  139.         $updatedAt = new \DateTimeImmutable($context['updated_at']);
  140.         $expiredTime = $updatedAt->add(new \DateInterval($this->lifetimeInterval));
  142.         $payload = array_filter(json_decode((string) $context['payload'], true, 512, \JSON_THROW_ON_ERROR));
  143.         $now = new \DateTimeImmutable();
  144.         if ($expiredTime < $now) {
  145.             // context is expired
  146.             $payload = ['expired' => true];
  147.         } else {
  148.             $payload['expired'] = false;
  149.         }
  151.         if ($customerId) {
  152.             $payload['token'] = $context['token'];
  153.         }
  155.         return $payload;
  156.     }
  158.     public function revokeAllCustomerTokens(string $customerId, string ...$preserveTokens): void
  159.     {
  160.         $revokeParams = [
  161.             'customerId' => null,
  162.             'billingAddressId' => null,
  163.             'shippingAddressId' => null,
  164.         ];
  166.         $qb = $this->connection->createQueryBuilder();
  167.         $qb
  168.             ->update('sales_channel_api_context')
  169.             ->set('payload', ':payload')
  170.             ->set('customer_id', 'NULL')
  171.             ->set('updated_at', ':updatedAt')
  172.             ->where('customer_id = :customerId')
  173.             ->setParameter('updatedAt', (new \DateTime())->format(Defaults::STORAGE_DATE_TIME_FORMAT))
  174.             ->setParameter('payload', json_encode($revokeParams))
  175.             ->setParameter('customerId', Uuid::fromHexToBytes($customerId));
  177.         // keep tokens valid, which are given in $preserveTokens
  178.         if ($preserveTokens) {
  179.             $qb
  180.                 ->andWhere($qb->expr()->notIn('token', ':preserveTokens'))
  181.                 ->setParameter('preserveTokens', $preserveTokens, Connection::PARAM_STR_ARRAY);
  182.         }
  184.         $qb->executeStatement();
  185.     }
  187.     /**
  188.      * @param list<array<string, mixed>> $data
  189.      *
  190.      * @return array<string, mixed>|null
  191.      */
  192.     private function getCustomerContext(array $data, string $salesChannelId, string $customerId): ?array
  193.     {
  194.         foreach ($data as $row) {
  195.             if (!empty($row['customer_id'])
  196.                 && Uuid::fromBytesToHex($row['sales_channel_id']) === $salesChannelId
  197.                 && Uuid::fromBytesToHex($row['customer_id']) === $customerId
  198.             ) {
  199.                 return $row;
  200.             }
  201.         }
  203.         return null;
  204.     }
  205. }