Merge pull request mautic#15564 from aarohiprasad/prevent-duplicate-project-names

escopecz · web-flow · commit 2e17cb64d29f · 2025-10-31T13:51:24.000+01:00
Prevent duplicate project names
diff --git a/app/bundles/CoreBundle/Form/Extension/NormalizeFormExtension.php b/app/bundles/CoreBundle/Form/Extension/NormalizeFormExtension.php
@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Mautic\CoreBundle\Form\Extension;
+
+use Symfony\Component\Form\AbstractTypeExtension;
+use Symfony\Component\Form\Extension\Core\Type\FormType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\Form\FormEvent;
+use Symfony\Component\Form\FormEvents;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+class NormalizeFormExtension extends AbstractTypeExtension
+{
+    /**
+     * @param array<mixed> $options
+     */
+    public function buildForm(FormBuilderInterface $builder, array $options): void
+    {
+        if (!$options['normalize_whitespaces']) {
+            return;
+        }
+
+        $builder->addEventListener(FormEvents::PRE_SUBMIT, function (FormEvent $event) {
+            $data = $event->getData();
+
+            if (!\is_string($data)) {
+                return;
+            }
+
+            $event->setData(preg_replace('/\s+/', ' ', $data));
+        });
+    }
+
+    public function configureOptions(OptionsResolver $resolver): void
+    {
+        $resolver->setDefaults([
+            'normalize_whitespaces' => false,
+        ]);
+    }
+
+    /**
+     * @return iterable<class-string>
+     */
+    public static function getExtendedTypes(): iterable
+    {
+        return [FormType::class];
+    }
+}
diff --git a/app/bundles/ProjectBundle/Controller/AjaxController.php b/app/bundles/ProjectBundle/Controller/AjaxController.php
@@ -59,8 +59,8 @@ public function addProjectsAction(Request $request, ProjectModel $projectModel,
             foreach ($newProjectNames as $projectName) {
                 $project = new Project();
                 $project->setName($projectName);
-                $projectModel->saveEntity($project);
-                $existingProjectIds[] = $project->getId();
+
+                $existingProjectIds[] = $this->createProjectIfNotExists(trim($projectName), $projectModel, $projectRepository);
             }
         }
 
@@ -75,4 +75,17 @@ public function addProjectsAction(Request $request, ProjectModel $projectModel,
 
         return $this->sendJsonResponse(['projects' => $projectOptions]);
     }
+
+    private function createProjectIfNotExists(string $name, ProjectModel $projectModel, ProjectRepository $projectRepository): int
+    {
+        if ($project = $projectRepository->findOneBy(['name' => $name])) {
+            return $project->getId();
+        }
+
+        $project = new Project();
+        $project->setName($name);
+        $projectModel->saveEntity($project);
+
+        return $project->getId();
+    }
 }
diff --git a/app/bundles/ProjectBundle/Entity/Project.php b/app/bundles/ProjectBundle/Entity/Project.php
@@ -12,6 +12,7 @@
 use Mautic\CoreBundle\Entity\FormEntity;
 use Mautic\CoreBundle\Entity\UuidInterface;
 use Mautic\CoreBundle\Entity\UuidTrait;
+use Mautic\ProjectBundle\Validator\Constraints\UniqueName;
 use Symfony\Component\Serializer\Annotation\Groups;
 use Symfony\Component\Validator\Constraints\NotBlank;
 use Symfony\Component\Validator\Mapping\ClassMetadata;
@@ -82,7 +83,7 @@ public static function loadMetadata(OrmClassMetadata $metadata): void
 
         $builder->setTable(self::TABLE_NAME)
             ->setCustomRepositoryClass(ProjectRepository::class)
-            ->addIndex(['name'], 'project_name');
+            ->addUniqueConstraint(['name'], 'unique_project_name');
 
         $builder->addIdColumns();
 
@@ -115,6 +116,7 @@ public static function loadValidatorMetadata(ClassMetadata $metadata): void
             'name',
             new NotBlank(['message' => 'mautic.core.name.required'])
         );
+        $metadata->addConstraint(new UniqueName());
     }
 
     public function getId(): ?int
diff --git a/app/bundles/ProjectBundle/Entity/ProjectRepository.php b/app/bundles/ProjectBundle/Entity/ProjectRepository.php
@@ -22,4 +22,20 @@ public function getTableAlias(): string
     {
         return 'p';
     }
+
+    public function checkProjectNameExists(string $name, ?int $ignoredId = null): bool
+    {
+        $q = $this->createQueryBuilder($this->getTableAlias());
+        $q->select('1');
+        $q->where($this->getTableAlias().'.name = :name');
+        $q->setParameter('name', $name);
+        $q->setMaxResults(1);
+
+        if (null !== $ignoredId) {
+            $q->andWhere($q->expr()->neq($this->getTableAlias().'.id', ':ignoredId'));
+            $q->setParameter('ignoredId', $ignoredId);
+        }
+
+        return !empty($q->getQuery()->getResult());
+    }
 }
diff --git a/app/bundles/ProjectBundle/Form/Type/ProjectEntityType.php b/app/bundles/ProjectBundle/Form/Type/ProjectEntityType.php
@@ -20,9 +20,10 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             'name',
             TextType::class,
             [
-                'label'       => 'mautic.core.name',
-                'label_attr'  => ['class' => 'control-label'],
-                'attr'        => ['class' => 'form-control'],
+                'label'                 => 'mautic.core.name',
+                'label_attr'            => ['class' => 'control-label'],
+                'attr'                  => ['class' => 'form-control'],
+                'normalize_whitespaces' => true,
             ]
         );
 
diff --git a/app/bundles/ProjectBundle/Tests/Functional/Controller/AjaxControllerTest.php b/app/bundles/ProjectBundle/Tests/Functional/Controller/AjaxControllerTest.php
@@ -60,4 +60,56 @@ static function (string $projectName) use ($projectModel) {
             $payload['projects']
         );
     }
+
+    public function testCreatingDuplicateProject(): void
+    {
+        $projectModel = self::getContainer()->get('mautic.project.model.project');
+        \assert($projectModel instanceof ProjectModel);
+
+        $this->assertCount(
+            0,
+            $this->em->getRepository(Project::class)->findAll(),
+            'There should be no projects at the beginning of the test.'
+        );
+
+        $project = new Project();
+        $project->setName('Yellow Project');
+        $projectModel->saveEntity($project);
+
+        $this->assertCount(
+            1,
+            $this->em->getRepository(Project::class)->findAll(),
+            'There should be 1 project after creating the first one.'
+        );
+
+        $this->client->request(
+            'POST',
+            '/s/ajax?action=project:addProjects',
+            [
+                'newProjectNames'    => json_encode(['yellow project']),
+                'existingProjectIds' => json_encode([$project->getId()]),
+            ]
+        );
+
+        $this->assertCount(
+            1,
+            $this->em->getRepository(Project::class)->findAll(),
+            'There should be still 1 project after an attempt to create a duplicate project.'
+        );
+
+        $this->client->request(
+            'POST',
+            '/s/ajax?action=project:addProjects',
+            [
+                'newProjectNames'    => json_encode(['green project']),
+                'existingProjectIds' => json_encode([$project->getId()]),
+            ]
+        );
+
+        $this->assertCount(
+            2,
+            $this->em->getRepository(Project::class)->findAll(),
+            'There should be 2 projects after an attempt to create a unique project.'
+        );
+    }
 }
diff --git a/app/bundles/ProjectBundle/Tests/Functional/Validator/UniqueNameValidatorFunctionalTest.php b/app/bundles/ProjectBundle/Tests/Functional/Validator/UniqueNameValidatorFunctionalTest.php
@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Mautic\ProjectBundle\Tests\Functional\Validator;
+
+use Mautic\CoreBundle\Test\MauticMysqlTestCase;
+use Mautic\ProjectBundle\Entity\Project;
+use Symfony\Component\HttpFoundation\Request;
+
+final class UniqueNameValidatorFunctionalTest extends MauticMysqlTestCase
+{
+    public function testDuplicateProjectName(): void
+    {
+        $project = new Project();
+        $project->setName('qwerty');
+        $this->em->persist($project);
+        $this->em->flush();
+
+        $this->assertCount(1, $this->em->getRepository(Project::class)->findBy(['name' => $project->getName()]));
+
+        $crawler       = $this->client->request(Request::METHOD_GET, '/s/projects/new');
+        $buttonCrawler = $crawler->selectButton('Save & Close');
+        $form          = $buttonCrawler->form();
+        $form['project_entity[name]']->setValue('QWERTY');
+        $this->client->submit($form);
+        $this->assertTrue($this->client->getResponse()->isOk());
+
+        $this->assertStringContainsString(
+            'A project with this name already exists.',
+            $this->client->getResponse()->getContent()
+        );
+
+        $this->assertCount(1, $this->em->getRepository(Project::class)->findBy(['name' => $project->getName()]));
+    }
+}
diff --git a/app/bundles/ProjectBundle/Translations/en_US/validators.ini b/app/bundles/ProjectBundle/Translations/en_US/validators.ini
@@ -0,0 +1 @@
+project.name.already.exists="A project with this name already exists."
diff --git a/app/bundles/ProjectBundle/Validator/Constraints/UniqueName.php b/app/bundles/ProjectBundle/Validator/Constraints/UniqueName.php
@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Mautic\ProjectBundle\Validator\Constraints;
+
+use Symfony\Component\Validator\Constraint;
+
+final class UniqueName extends Constraint
+{
+    public string $message = 'project.name.already.exists';
+
+    public function getTargets(): string
+    {
+        return self::CLASS_CONSTRAINT;
+    }
+}
diff --git a/app/bundles/ProjectBundle/Validator/Constraints/UniqueNameValidator.php b/app/bundles/ProjectBundle/Validator/Constraints/UniqueNameValidator.php
@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Mautic\ProjectBundle\Validator\Constraints;
+
+use Mautic\ProjectBundle\Entity\Project;
+use Mautic\ProjectBundle\Entity\ProjectRepository;
+use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\ConstraintValidator;
+use Symfony\Component\Validator\Exception\UnexpectedTypeException;
+
+final class UniqueNameValidator extends ConstraintValidator
+{
+    public function __construct(
+        private ProjectRepository $projectRepository,
+    ) {
+    }
+
+    public function validate(mixed $project, Constraint $constraint): void
+    {
+        if (!$project instanceof Project) {
+            throw new UnexpectedTypeException($project, Project::class);
+        }
+
+        if (!$constraint instanceof UniqueName) {
+            throw new UnexpectedTypeException($constraint, UniqueName::class);
+        }
+
+        $projectName = $project->getName();
+
+        if (!$projectName) {
+            return;
+        }
+
+        $ignoredId = $project->isNew() ? null : $project->getId();
+
+        if ($this->projectRepository->checkProjectNameExists($projectName, $ignoredId)) {
+            $this->context->buildViolation($constraint->message)
+                ->atPath('name')
+                ->addViolation();
+        }
+    }
+}
diff --git a/app/migrations/Version20250909202247.php b/app/migrations/Version20250909202247.php
@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Mautic\Migrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Schema\SchemaException;
+use Mautic\CoreBundle\Doctrine\PreUpAssertionMigration;
+use Mautic\ProjectBundle\Entity\Project;
+
+final class Version20250909202247 extends PreUpAssertionMigration
+{
+    protected const TABLE_NAME = Project::TABLE_NAME;
+
+    protected function preUpAssertions(): void
+    {
+        $this->skipAssertion(function (Schema $schema) {
+            return $schema->getTable($this->getPrefixedTableName(self::TABLE_NAME))->hasIndex($this->getIndexName());
+        }, sprintf('Index %s already exists', $this->getIndexName()));
+    }
+
+    public function up(Schema $schema): void
+    {
+        $tableName = $this->getPrefixedTableName(self::TABLE_NAME);
+        $table     = $schema->getTable($tableName);
+
+        $oldIndexName = $this->prefix.'project_name';
+
+        if ($table->hasIndex($oldIndexName)) {
+            $this->addSql("ALTER TABLE {$tableName} DROP INDEX {$oldIndexName};");
+        }
+
+        $table->addUniqueIndex(['name'], $this->getIndexName());
+    }
+
+    /**
+     * @throws SchemaException
+     */
+    public function down(Schema $schema): void
+    {
+        $table = $schema->getTable($this->getPrefixedTableName(self::TABLE_NAME));
+
+        $table->dropIndex($this->getIndexName());
+        $table->addIndex(['name'], $this->prefix.'project_name');
+    }
+
+    private function getIndexName(): string
+    {
+        return $this->prefix.'unique_project_name';
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -20,9 +20,10 @@ public function buildForm(FormBuilderInterface $builder, array $options): void`
`20`	`20`	`'name',`
`21`	`21`	`TextType::class,`
`22`	`22`	`[`
`23`		`- 'label' => 'mautic.core.name',`
`24`		`- 'label_attr' => ['class' => 'control-label'],`
`25`		`- 'attr' => ['class' => 'form-control'],`
	`23`	`+ 'label' => 'mautic.core.name',`
	`24`	`+ 'label_attr' => ['class' => 'control-label'],`
	`25`	`+ 'attr' => ['class' => 'form-control'],`
	`26`	`+ 'normalize_whitespaces' => true,`
`26`	`27`	`]`
`27`	`28`	`);`
`28`	`29`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+project.name.already.exists="A project with this name already exists."`