vendor/shopware/core/System/SalesChannel/Context/SalesChannelContextPersister.php line 55

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