Feat: user message tracking

config/parameters.yml.dist

@@ -33,8 +33,8 @@ parameters:
     env(APP_POWERED_BY_PHPLIST): '0'
     app.preference_page_show_private_lists: '%%env(PREFERENCEPAGE_SHOW_PRIVATE_LISTS)%%'
     env(PREFERENCEPAGE_SHOW_PRIVATE_LISTS): '0'
-    app.rest_api_domain: '%%env(REST_API_DOMAIN)%%'
-    env(REST_API_DOMAIN): 'example.com'
+    app.rest_api_base_url: '%%env(REST_API_BASE_URL)%%'
+    env(REST_API_BASE_URL): 'https://example.com/api/v2'
 
     # Email configuration
     app.mailer_from: '%%env(MAILER_FROM)%%'

config/services/services.yml

@@ -53,6 +53,10 @@ services:
     autoconfigure: true
     public: true
 
+  PhpList\Core\Domain\Analytics\Service\UserMessageService:
+    autowire: true
+    autoconfigure: true
+
   PhpList\Core\Domain\Messaging\Service\SendRateLimiter:
     autowire: true
     autoconfigure: true

src/Domain/Analytics/Model/UserMessageView.php

@@ -85,6 +85,11 @@ public function setViewed(?DateTime $viewed): self
         return $this;
     }
 
+    public function setViewedNow(): self
+    {
+        return $this->setViewed(new DateTime());
+    }
+
     public function setIp(?string $ip): self
     {
         $this->ip = $ip;

src/Domain/Analytics/Service/UserMessageService.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\Core\Domain\Analytics\Service;
+
+use Doctrine\ORM\EntityManagerInterface;
+use PhpList\Core\Domain\Analytics\Model\UserMessageView;
+use PhpList\Core\Domain\Messaging\Repository\MessageRepository;
+use PhpList\Core\Domain\Messaging\Repository\UserMessageRepository;
+use PhpList\Core\Domain\Subscription\Repository\SubscriberRepository;
+
+class UserMessageService
+{
+    public function __construct(
+        private readonly UserMessageRepository $userMessageRepository,
+        private readonly SubscriberRepository $subscriberRepository,
+        private readonly MessageRepository $messageRepository,
+        private readonly EntityManagerInterface $entityManager
+    ) {
+    }
+
+    public function trackUserMessageView(string $uid, int $messageId, array $metadata): void
+    {
+        $subscriber = $this->subscriberRepository->findOneByUniqueId($uid);
+        $message = $this->messageRepository->findById($messageId);
+
+        if ($subscriber === null || $message === null) {
+            return;
+        }
+
+        $userMessage = $this->userMessageRepository->findByUserAndMessage($subscriber, $message);
+        if ($userMessage === null) {
+            return;
+        }
+
+        $userMessage->setViewedNow();
+        $message->getMetadata()->incrementViews();
+
+        $data = [];
+        foreach (['HTTP_USER_AGENT', 'HTTP_REFERER'] as $key) {
+            if (isset($metadata[$key])) {
+                $data[$key] = htmlspecialchars(strip_tags($metadata[$key]));
+            }
+        }
+
+        $userMessageView = new UserMessageView();
+        $userMessageView->setUserId($subscriber->getId());
+        $userMessageView->setMessageId($messageId);
+        $userMessageView->setViewedNow();
+        $userMessageView->setIp($metadata['client_ip'] ?? null);
+        $userMessageView->setData(serialize($data));
+
+        $this->entityManager->persist($userMessageView);
+    }
+}

src/Domain/Configuration/Service/Placeholder/UserTrackValueResolver.php

@@ -13,7 +13,7 @@ final class UserTrackValueResolver implements PlaceholderValueResolverInterface
 {
     public function __construct(
         private readonly ConfigProvider $config,
-        #[Autowire('%rest_api_domain%')] private readonly string $restApiDomain,
+        #[Autowire('%app.rest_api_base_url%')] private readonly string $restApiBaseUrl,
     ) {
     }
 
@@ -24,7 +24,7 @@ public function name(): string
 
     public function __invoke(PlaceholderContext $ctx): string
     {
-        $base = $this->config->getValue(ConfigOption::Domain) ?? $this->restApiDomain;
+        $base = $this->config->getValue(ConfigOption::Domain) ?? $this->restApiBaseUrl;
 
         if ($ctx->isText() || empty($base)) {
             return '';
@@ -33,7 +33,7 @@ public function __invoke(PlaceholderContext $ctx): string
 
         return '<img src="'
             . $base
-            . '/ut.php?u='
+            . '/t/open.gif?u='
             . $uid
             . '&amp;m='
             . $ctx->messageId()

src/Domain/Messaging/MessageHandler/CampaignProcessorMessageHandler.php

@@ -320,7 +320,7 @@ private function processSubscribersForCampaign(Message $campaign, array $subscri
                 break;
             }
 
-            $existing = $this->userMessageRepository->findOneByUserAndMessage($subscriber, $campaign);
+            $existing = $this->userMessageRepository->findByUserAndMessage($subscriber, $campaign);
             if ($existing && $existing->getStatus() !== UserMessageStatus::Todo) {
                 continue;
             }

src/Domain/Messaging/Model/Message/MessageMetadata.php

@@ -81,6 +81,13 @@ public function setViews(int $viewed): self
         return $this;
     }
 
+    public function incrementViews(): self
+    {
+        $this->viewed += 1;
+
+        return $this;
+    }
+
     public function getViews(): int
     {
         return $this->viewed;

src/Domain/Messaging/Model/UserMessage.php

@@ -82,4 +82,14 @@ public function setStatus(?UserMessageStatus $status): self
         $this->status = $status->value;
         return $this;
     }
+
+    public function isViewed(): bool
+    {
+        return $this->viewed !== null;
+    }
+
+    public function setViewedNow(): self
+    {
+        return $this->setViewed(new DateTime());
+    }
 }

src/Domain/Messaging/Repository/MessageRepository.php

@@ -27,6 +27,7 @@ public function findCampaignsWithoutUuid(): array
             ->getResult();
     }
 
+    /** @return Message[] */
     public function getByOwnerId(int $ownerId): array
     {
         return $this->createQueryBuilder('m')
@@ -36,6 +37,15 @@ public function getByOwnerId(int $ownerId): array
             ->getResult();
     }
 
+    public function findById(int $id): ?Message
+    {
+        return $this->createQueryBuilder('m')
+            ->where('m.id = :id')
+            ->setParameter('id', $id)
+            ->getQuery()
+            ->getOneOrNullResult();
+    }
+
     /** @return Message[] */
     public function getFilteredAfterId(int $lastId, int $limit, ?FilterRequestInterface $filter = null): array
     {

src/Domain/Messaging/Repository/UserMessageRepository.php

@@ -13,7 +13,7 @@
 
 class UserMessageRepository extends AbstractRepository
 {
-    public function findOneByUserAndMessage(Subscriber $subscriber, Message $campaign): ?UserMessage
+    public function findByUserAndMessage(Subscriber $subscriber, Message $campaign): ?UserMessage
     {
         return $this->findOneBy(['user' => $subscriber, 'message' => $campaign]);
     }

src/Domain/Messaging/Service/Builder/HttpReceivedStampBuilder.php

@@ -12,7 +12,7 @@ class HttpReceivedStampBuilder
 {
     public function __construct(
         private readonly RequestStack $requestStack,
-        #[Autowire('%app.rest_api_domain%')] private readonly string $hostname,
+        #[Autowire('%app.rest_api_base_url%')] private readonly string $restApiBaseUrl,
     ) {
     }
 
@@ -40,7 +40,7 @@ public function buildStamp(): ?string
         $requestTime = $request->server->get('REQUEST_TIME') ?? time();
         $date = (new DateTimeImmutable('@' . $requestTime))->format(\DATE_RFC2822);
 
-        return sprintf('from %s by %s with HTTP; %s', $from, $this->hostname, $date);
+        return sprintf('from %s by %s with HTTP; %s', $from, $this->restApiBaseUrl, $date);
     }
 
     private function getHostByAddr(string $ipAddress): ?string

src/Domain/Messaging/Service/ForwardingGuard.php

@@ -31,7 +31,7 @@ public function assertCanForward(string $uid, Message $campaign): Subscriber
         if ($subscriber === null) {
             throw new MessageNotReceivedException();
         }
-        $receivedMessage = $this->userMessageRepository->findOneByUserAndMessage($subscriber, $campaign);
+        $receivedMessage = $this->userMessageRepository->findByUserAndMessage($subscriber, $campaign);
 
         if ($receivedMessage === null) {
             throw new MessageNotReceivedException();