Add: validateNoClickTrackLinks

Author: tatevikg1

src/Messaging/Request/Message/MessageContentRequest.php

@@ -7,6 +7,7 @@
 use OpenApi\Attributes as OA;
 use PhpList\Core\Domain\Messaging\Model\Dto\Message\MessageContentDto;
 use Symfony\Component\Validator\Constraints as Assert;
+use Symfony\Component\Validator\Context\ExecutionContextInterface;
 
 #[OA\Schema(
     schema: 'MessageContentRequest',
@@ -20,6 +21,9 @@
 )]
 class MessageContentRequest implements RequestDtoInterface
 {
+    private const CLICKTRACK_MESSAGE = 'You should not paste the results of a test message back into the editor. '
+    . 'This will break the click-track statistics, and overload the server.';
+
     #[Assert\NotBlank]
     public string $subject;
 
@@ -29,6 +33,25 @@ class MessageContentRequest implements RequestDtoInterface
     #[Assert\NotBlank]
     public string $footer;
 
+    #[Assert\Callback('validateNoClickTrackLinks')]
+    public function validateNoClickTrackLinks(ExecutionContextInterface $context): void
+    {
+        if (!isset($this->text)) {
+            return;
+        }
+
+        $hasClickTrackLinks = preg_match('/lt\.php\?id=[\w%]{22}/', $this->text) === 1
+            || preg_match('/lt\.php\?id=[\w%]{16}/', $this->text) === 1
+            || preg_match('#/lt/[\w%]{22}#', $this->text) === 1
+            || preg_match('#/lt/[\w%]{16}#', $this->text) === 1;
+
+        if ($hasClickTrackLinks) {
+            $context->buildViolation(self::CLICKTRACK_MESSAGE)
+                ->atPath('text')
+                ->addViolation();
+        }
+    }
+
     public function getDto(): MessageContentDto
     {
         return  new MessageContentDto(

tests/Unit/Messaging/Request/MessageContentRequestTest.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\RestBundle\Tests\Unit\Messaging\Request;
+
+use PhpList\RestBundle\Messaging\Request\Message\MessageContentRequest;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Validator\Context\ExecutionContextInterface;
+use Symfony\Component\Validator\Violation\ConstraintViolationBuilderInterface;
+
+class MessageContentRequestTest extends TestCase
+{
+    public function testValidateNoClickTrackLinksWithCleanTextDoesNotAddViolation(): void
+    {
+        $request = new MessageContentRequest();
+        $request->text = 'Hello, this is a normal message body.';
+
+        $context = $this->createMock(ExecutionContextInterface::class);
+        $context->expects($this->never())->method('buildViolation');
+
+        $request->validateNoClickTrackLinks($context);
+    }
+
+    public function testValidateNoClickTrackLinksWithLtPhpPatternAddsViolation(): void
+    {
+        $request = new MessageContentRequest();
+        $request->text = 'See this link: https://example.com/lt.php?id=abcdefghijklmnop';
+
+        $builder = $this->createMock(ConstraintViolationBuilderInterface::class);
+        $builder->expects($this->once())->method('atPath')->with('text')->willReturnSelf();
+        $builder->expects($this->once())->method('addViolation');
+
+        $context = $this->createMock(ExecutionContextInterface::class);
+        $context->expects($this->once())
+            ->method('buildViolation')
+            ->willReturn($builder);
+
+        $request->validateNoClickTrackLinks($context);
+    }
+
+    public function testValidateNoClickTrackLinksWithLinkMapPatternAddsViolation(): void
+    {
+        $request = new MessageContentRequest();
+        $request->text = 'Mapped link: https://example.com/lt/abcdefghijklmnopqrstuv';
+
+        $builder = $this->createMock(ConstraintViolationBuilderInterface::class);
+        $builder->expects($this->once())->method('atPath')->with('text')->willReturnSelf();
+        $builder->expects($this->once())->method('addViolation');
+
+        $context = $this->createMock(ExecutionContextInterface::class);
+        $context->expects($this->once())
+            ->method('buildViolation')
+            ->willReturn($builder);
+
+        $request->validateNoClickTrackLinks($context);
+    }
+}