vendor/shopware/core/System/SalesChannel/Validation/SalesChannelValidator.php line 57

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\System\SalesChannel\Validation;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\Defaults;
  7. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\DeleteCommand;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\InsertCommand;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\UpdateCommand;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\WriteCommand;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Write\Validation\PreWriteValidationEvent;
  12. use Shopware\Core\Framework\Log\Package;
  13. use Shopware\Core\Framework\Uuid\Uuid;
  14. use Shopware\Core\Framework\Validation\WriteConstraintViolationException;
  15. use Shopware\Core\System\SalesChannel\Aggregate\SalesChannelLanguage\SalesChannelLanguageDefinition;
  16. use Shopware\Core\System\SalesChannel\SalesChannelDefinition;
  17. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  18. use Symfony\Component\Validator\ConstraintViolation;
  19. use Symfony\Component\Validator\ConstraintViolationList;
  21. /**
  22. * @deprecated tag:v6.5.0 - reason:becomes-internal - EventSubscribers will become internal in v6.5.0
  23. */
  24. #[Package('sales-channel')]
  25. class SalesChannelValidator implements EventSubscriberInterface
  26. {
  27. private const INSERT_VALIDATION_MESSAGE = 'The sales channel with id "%s" does not have a default sales channel language id in the language list.';
  28. private const INSERT_VALIDATION_CODE = 'SYSTEM__NO_GIVEN_DEFAULT_LANGUAGE_ID';
  30. private const DUPLICATED_ENTRY_VALIDATION_MESSAGE = 'The sales channel language "%s" for the sales channel "%s" already exists.';
  31. private const DUPLICATED_ENTRY_VALIDATION_CODE = 'SYSTEM__DUPLICATED_SALES_CHANNEL_LANGUAGE';
  33. private const UPDATE_VALIDATION_MESSAGE = 'Cannot update default language id because the given id is not in the language list of sales channel with id "%s"';
  34. private const UPDATE_VALIDATION_CODE = 'SYSTEM__CANNOT_UPDATE_DEFAULT_LANGUAGE_ID';
  36. private const DELETE_VALIDATION_MESSAGE = 'Cannot delete default language id from language list of the sales channel with id "%s".';
  37. private const DELETE_VALIDATION_CODE = 'SYSTEM__CANNOT_DELETE_DEFAULT_LANGUAGE_ID';
  39. private Connection $connection;
  41. /**
  42. * @internal
  43. */
  44. public function __construct(
  45. Connection $connection
  46. ) {
  47. $this->connection = $connection;
  48. }
  50. public static function getSubscribedEvents(): array
  51. {
  52. return [
  53. PreWriteValidationEvent::class => 'handleSalesChannelLanguageIds',
  54. ];
  55. }
  57. public function handleSalesChannelLanguageIds(PreWriteValidationEvent $event): void
  58. {
  59. $mapping = $this->extractMapping($event);
  61. if (!$mapping) {
  62. return;
  63. }
  65. $salesChannelIds = array_keys($mapping);
  66. $states = $this->fetchCurrentLanguageStates($salesChannelIds);
  68. $mapping = $this->mergeCurrentStatesWithMapping($mapping, $states);
  70. $this->validateLanguages($mapping, $event);
  71. }
  73. /**
  74. * Build a key map with the following data structure:
  75. *
  76. * 'sales_channel_id' => [
  77. * 'current_default' => 'en',
  78. * 'new_default' => 'de',
  79. * 'inserts' => ['de', 'en'],
  80. * 'updates' => ['de', 'de'],
  81. * 'deletions' => ['gb'],
  82. * 'state' => ['en', 'gb']
  83. * ]
  84. *
  85. * @return array<string, array<string, list<string>>>
  86. */
  87. private function extractMapping(PreWriteValidationEvent $event): array
  88. {
  89. $mapping = [];
  90. foreach ($event->getCommands() as $command) {
  91. if ($command->getDefinition() instanceof SalesChannelDefinition) {
  92. $this->handleSalesChannelMapping($mapping, $command);
  94. continue;
  95. }
  97. if ($command->getDefinition() instanceof SalesChannelLanguageDefinition) {
  98. $this->handleSalesChannelLanguageMapping($mapping, $command);
  99. }
  100. }
  102. return $mapping;
  103. }
  105. /**
  106. * @param array<string, array<string, list<string>>> $mapping
  107. */
  108. private function handleSalesChannelMapping(array &$mapping, WriteCommand $command): void
  109. {
  110. if (!isset($command->getPayload()['language_id'])) {
  111. return;
  112. }
  114. if ($command instanceof UpdateCommand) {
  115. $id = Uuid::fromBytesToHex($command->getPrimaryKey()['id']);
  116. $mapping[$id]['updates'] = Uuid::fromBytesToHex($command->getPayload()['language_id']);
  118. return;
  119. }
  121. if (!$command instanceof InsertCommand || !$this->isSupportedSalesChannelType($command)) {
  122. return;
  123. }
  125. $id = Uuid::fromBytesToHex($command->getPrimaryKey()['id']);
  126. $mapping[$id]['new_default'] = Uuid::fromBytesToHex($command->getPayload()['language_id']);
  127. $mapping[$id]['inserts'] = [];
  128. $mapping[$id]['state'] = [];
  129. }
  131. private function isSupportedSalesChannelType(WriteCommand $command): bool
  132. {
  133. $typeId = Uuid::fromBytesToHex($command->getPayload()['type_id']);
  135. return $typeId === Defaults::SALES_CHANNEL_TYPE_STOREFRONT
  136. || $typeId === Defaults::SALES_CHANNEL_TYPE_API;
  137. }
  139. /**
  140. * @param array<string, list<string>> $mapping
  141. */
  142. private function handleSalesChannelLanguageMapping(array &$mapping, WriteCommand $command): void
  143. {
  144. $language = Uuid::fromBytesToHex($command->getPrimaryKey()['language_id']);
  145. $id = Uuid::fromBytesToHex($command->getPrimaryKey()['sales_channel_id']);
  146. $mapping[$id]['state'] = [];
  148. if ($command instanceof DeleteCommand) {
  149. $mapping[$id]['deletions'][] = $language;
  151. return;
  152. }
  154. if ($command instanceof InsertCommand) {
  155. $mapping[$id]['inserts'][] = $language;
  156. }
  157. }
  159. /**
  160. * @param array<string, list<string>> $mapping
  161. */
  162. private function validateLanguages(array $mapping, PreWriteValidationEvent $event): void
  163. {
  164. $inserts = [];
  165. $duplicates = [];
  166. $deletions = [];
  167. $updates = [];
  169. foreach ($mapping as $id => $channel) {
  170. if (isset($channel['inserts'])) {
  171. if (!$this->validInsertCase($channel)) {
  172. $inserts[$id] = $channel['new_default'];
  173. }
  175. $duplicatedIds = $this->getDuplicates($channel);
  177. if ($duplicatedIds) {
  178. $duplicates[$id] = $duplicatedIds;
  179. }
  180. }
  182. if (isset($channel['deletions']) && !$this->validDeleteCase($channel)) {
  183. $deletions[$id] = $channel['current_default'];
  184. }
  186. if (isset($channel['updates']) && !$this->validUpdateCase($channel)) {
  187. $updates[$id] = $channel['updates'];
  188. }
  189. }
  191. $this->writeInsertViolationExceptions($inserts, $event);
  192. $this->writeDuplicateViolationExceptions($duplicates, $event);
  193. $this->writeDeleteViolationExceptions($deletions, $event);
  194. $this->writeUpdateViolationExceptions($updates, $event);
  195. }
  197. /**
  198. * @param array<string, mixed> $channel
  199. */
  200. private function validInsertCase(array $channel): bool
  201. {
  202. return empty($channel['new_default'])
  203. || \in_array($channel['new_default'], $channel['inserts'], true);
  204. }
  206. /**
  207. * @param array<string, mixed> $channel
  208. */
  209. private function validUpdateCase(array $channel): bool
  210. {
  211. $updateId = $channel['updates'];
  213. return \in_array($updateId, $channel['state'], true)
  214. || empty($channel['new_default']) && $updateId === $channel['current_default']
  215. || isset($channel['inserts']) && \in_array($updateId, $channel['inserts'], true);
  216. }
  218. /**
  219. * @param array<string, mixed> $channel
  220. */
  221. private function validDeleteCase(array $channel): bool
  222. {
  223. return !\in_array($channel['current_default'], $channel['deletions'], true);
  224. }
  226. /**
  227. * @param array<string, mixed> $channel
  228. *
  229. * @return array<string, mixed>
  230. */
  231. private function getDuplicates(array $channel): array
  232. {
  233. return array_intersect($channel['state'], $channel['inserts']);
  234. }
  236. /**
  237. * @param array<string, mixed> $inserts
  238. */
  239. private function writeInsertViolationExceptions(array $inserts, PreWriteValidationEvent $event): void
  240. {
  241. if (!$inserts) {
  242. return;
  243. }
  245. $violations = new ConstraintViolationList();
  246. $salesChannelIds = array_keys($inserts);
  248. foreach ($salesChannelIds as $id) {
  249. $violations->add(new ConstraintViolation(
  250. sprintf(self::INSERT_VALIDATION_MESSAGE, $id),
  251. sprintf(self::INSERT_VALIDATION_MESSAGE, '{{ salesChannelId }}'),
  252. ['{{ salesChannelId }}' => $id],
  253. null,
  254. '/',
  255. null,
  256. null,
  257. self::INSERT_VALIDATION_CODE
  258. ));
  259. }
  261. $this->writeViolationException($violations, $event);
  262. }
  264. /**
  265. * @param array<string, mixed> $duplicates
  266. */
  267. private function writeDuplicateViolationExceptions(array $duplicates, PreWriteValidationEvent $event): void
  268. {
  269. if (!$duplicates) {
  270. return;
  271. }
  273. $violations = new ConstraintViolationList();
  275. foreach ($duplicates as $id => $duplicateLanguages) {
  276. foreach ($duplicateLanguages as $languageId) {
  277. $violations->add(new ConstraintViolation(
  278. sprintf(self::DUPLICATED_ENTRY_VALIDATION_MESSAGE, $languageId, $id),
  279. sprintf(self::DUPLICATED_ENTRY_VALIDATION_MESSAGE, '{{ languageId }}', '{{ salesChannelId }}'),
  280. [
  281. '{{ salesChannelId }}' => $id,
  282. '{{ languageId }}' => $languageId,
  283. ],
  284. null,
  285. '/',
  286. null,
  287. null,
  288. self::DUPLICATED_ENTRY_VALIDATION_CODE
  289. ));
  290. }
  291. }
  293. $this->writeViolationException($violations, $event);
  294. }
  296. /**
  297. * @param array<string, mixed> $deletions
  298. */
  299. private function writeDeleteViolationExceptions(array $deletions, PreWriteValidationEvent $event): void
  300. {
  301. if (!$deletions) {
  302. return;
  303. }
  305. $violations = new ConstraintViolationList();
  306. $salesChannelIds = array_keys($deletions);
  308. foreach ($salesChannelIds as $id) {
  309. $violations->add(new ConstraintViolation(
  310. sprintf(self::DELETE_VALIDATION_MESSAGE, $id),
  311. sprintf(self::DELETE_VALIDATION_MESSAGE, '{{ salesChannelId }}'),
  312. ['{{ salesChannelId }}' => $id],
  313. null,
  314. '/',
  315. null,
  316. null,
  317. self::DELETE_VALIDATION_CODE
  318. ));
  319. }
  321. $this->writeViolationException($violations, $event);
  322. }
  324. /**
  325. * @param array<string, mixed> $updates
  326. */
  327. private function writeUpdateViolationExceptions(array $updates, PreWriteValidationEvent $event): void
  328. {
  329. if (!$updates) {
  330. return;
  331. }
  333. $violations = new ConstraintViolationList();
  334. $salesChannelIds = array_keys($updates);
  336. foreach ($salesChannelIds as $id) {
  337. $violations->add(new ConstraintViolation(
  338. sprintf(self::UPDATE_VALIDATION_MESSAGE, $id),
  339. sprintf(self::UPDATE_VALIDATION_MESSAGE, '{{ salesChannelId }}'),
  340. ['{{ salesChannelId }}' => $id],
  341. null,
  342. '/',
  343. null,
  344. null,
  345. self::UPDATE_VALIDATION_CODE
  346. ));
  347. }
  349. $this->writeViolationException($violations, $event);
  350. }
  352. /**
  353. * @param array<string> $salesChannelIds
  354. *
  355. * @return array<string, string>
  356. */
  357. private function fetchCurrentLanguageStates(array $salesChannelIds): array
  358. {
  359. /** @var array<string, mixed> $result */
  360. $result = $this->connection->fetchAllAssociative(
  361. 'SELECT LOWER(HEX(sales_channel.id)) AS sales_channel_id,
  362. LOWER(HEX(sales_channel.language_id)) AS current_default,
  363. LOWER(HEX(mapping.language_id)) AS language_id
  364. FROM sales_channel
  365. LEFT JOIN sales_channel_language mapping
  366. ON mapping.sales_channel_id = sales_channel.id
  367. WHERE sales_channel.id IN (:ids)',
  368. ['ids' => Uuid::fromHexToBytesList($salesChannelIds)],
  369. ['ids' => Connection::PARAM_STR_ARRAY]
  370. );
  372. return $result;
  373. }
  375. /**
  376. * @param array<string, mixed> $mapping
  377. * @param array<string, mixed> $states
  378. *
  379. * @return array<string, mixed>
  380. */
  381. private function mergeCurrentStatesWithMapping(array $mapping, array $states): array
  382. {
  383. foreach ($states as $record) {
  384. $id = (string) $record['sales_channel_id'];
  385. $mapping[$id]['current_default'] = $record['current_default'];
  386. $mapping[$id]['state'][] = $record['language_id'];
  387. }
  389. return $mapping;
  390. }
  392. private function writeViolationException(ConstraintViolationList $violations, PreWriteValidationEvent $event): void
  393. {
  394. $event->getExceptions()->add(new WriteConstraintViolationException($violations));
  395. }
  396. }