<?php declare(strict_types=1);
/*
* (c) shopware AG <info@shopware.com>
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Shopware\Core\Content\Category\Validation;
use Doctrine\DBAL\Connection;
use Doctrine\DBAL\Driver\ResultStatement;
use Shopware\Core\Content\Category\CategoryDefinition;
use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\InsertCommand;
use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\UpdateCommand;
use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\WriteCommand;
use Shopware\Core\Framework\DataAbstractionLayer\Write\Validation\PostWriteValidationEvent;
use Shopware\Core\Framework\Validation\WriteConstraintViolationException;
use Shopware\Core\System\SalesChannel\SalesChannelDefinition;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\Validator\ConstraintViolation;
use Symfony\Component\Validator\ConstraintViolationList;
use Symfony\Component\Validator\ConstraintViolationListInterface;
class EntryPointValidator implements EventSubscriberInterface
{
private const ERROR_CODE = 'CONTENT__INVALID_CATEGORY_TYPE_AS_ENTRY_POINT';
private const ALLOWED_TYPE_CHANGE = [
CategoryDefinition::TYPE_PAGE,
CategoryDefinition::TYPE_FOLDER,
];
/**
* @var Connection
*/
private $connection;
/**
* @internal
*/
public function __construct(Connection $connection)
{
$this->connection = $connection;
}
public static function getSubscribedEvents(): array
{
return [
PostWriteValidationEvent::class => 'postValidate',
];
}
public function postValidate(PostWriteValidationEvent $event): void
{
$violationList = new ConstraintViolationList();
foreach ($event->getCommands() as $command) {
if (!($command instanceof InsertCommand || $command instanceof UpdateCommand)) {
continue;
}
if ($command->getDefinition()->getClass() !== CategoryDefinition::class) {
continue;
}
if (!isset($command->getPayload()['type'])) {
continue;
}
$violationList->addAll($this->checkTypeChange($command, $event));
}
if ($violationList->count() > 0) {
$event->getExceptions()->add(new WriteConstraintViolationException($violationList));
return;
}
}
private function checkTypeChange(WriteCommand $command, PostWriteValidationEvent $event): ConstraintViolationListInterface
{
$violationList = new ConstraintViolationList();
$payload = $command->getPayload();
if (\in_array($payload['type'], self::ALLOWED_TYPE_CHANGE, true)) {
return $violationList;
}
if ($this->isCategoryEntryPoint($command->getPrimaryKey()['id'], $event)) {
return $violationList;
}
$messageTemplate = 'The type can not be assigned while category is entry point.';
$parameters = ['{{ value }}' => $payload['type']];
$violationList->add(new ConstraintViolation(
str_replace(array_keys($parameters), $parameters, $messageTemplate),
$messageTemplate,
$parameters,
null,
sprintf('%s/type', $command->getPath()),
$payload['type'],
null,
self::ERROR_CODE
));
return $violationList;
}
private function isCategoryEntryPoint(string $categoryId, PostWriteValidationEvent $event): bool
{
foreach ($event->getCommands() as $salesChannelCommand) {
if ($salesChannelCommand->getDefinition()->getClass() !== SalesChannelDefinition::class) {
continue;
}
$payload = $salesChannelCommand->getPayload();
if ((isset($payload['navigation_category_id']) && $payload['navigation_category_id'] === $categoryId)
|| (isset($payload['footer_category_id']) && $payload['footer_category_id'] === $categoryId)
|| (isset($payload['service_category_id']) && $payload['service_category_id'] === $categoryId)
) {
return false;
}
}
$query = $this->connection->createQueryBuilder()
->select('id')
->from(SalesChannelDefinition::ENTITY_NAME)
->where('navigation_category_id = :navigation_id')
->orWhere('footer_category_id = :footer_id')
->orWhere('service_category_id = :service_id')
->setParameter('navigation_id', $categoryId)
->setParameter('footer_id', $categoryId)
->setParameter('service_id', $categoryId)
->setMaxResults(1)
->execute();
if (!($query instanceof ResultStatement)) {
return true;
}
return !(bool) $query->fetchColumn();
}
}