Dev

.env.dist

@@ -24,6 +24,9 @@ APP_POWERED_BY_PHPLIST=0
 PREFERENCEPAGE_SHOW_PRIVATE_LISTS=0
 
 API_BASE_URL=http://api.phplist.local/
+# Website address without scheme (e.g. www.example.com). Used as the default of the "website" setting;
+# the "domain" setting defaults to the same value without a leading "www.". Both are editable in the admin UI.
+APP_WEBSITE=phplist.local
 FRONT_END_BASE_URL=http://frontend.phplist.local
 
 PARALLEL_USE_WITH_PHPLIST3=0

config/parameters.yml

@@ -23,6 +23,7 @@ parameters:
     app.rest_api_base_url: '%env(API_BASE_URL)%/api/v2'
     app.api_base_url: '%env(API_BASE_URL)%'
     app.frontend_base_url: '%env(FRONT_END_BASE_URL)%'
+    app.website: '%env(APP_WEBSITE)%'
 
     app.parallel_use_with_phplist3: '%env(PARALLEL_USE_WITH_PHPLIST3)%'
 

config/services/parameters.yml

@@ -14,3 +14,5 @@ parameters:
     notify_end_default: 'end@example.com'
     always_add_google_tracking: true
     click_track: true
+    # sign click-tracking links with the application secret, see LinkTrackTokenService
+    click_track_sign_with_hmac: false

config/services/providers.yml

@@ -16,6 +16,8 @@ services:
 
   PhpList\Core\Domain\Configuration\Service\Provider\DefaultConfigProvider:
     autowire: true
+    arguments:
+      $website: '%app.website%'
 
   PhpList\Core\Domain\Configuration\Service\Provider\ConfigProvider:
     autowire: true

config/services/repositories.yml

@@ -11,6 +11,14 @@ services:
     parent: PhpList\Core\Domain\Common\Repository\AbstractRepository
     arguments:
       - PhpList\Core\Domain\Analytics\Model\LinkTrackUmlClick
+  PhpList\Core\Domain\Analytics\Repository\LinkTrackForwardRepository:
+    parent: PhpList\Core\Domain\Common\Repository\AbstractRepository
+    arguments:
+      - PhpList\Core\Domain\Analytics\Model\LinkTrackForward
+  PhpList\Core\Domain\Analytics\Repository\LinkTrackMlRepository:
+    parent: PhpList\Core\Domain\Common\Repository\AbstractRepository
+    arguments:
+      - PhpList\Core\Domain\Analytics\Model\LinkTrackMl
 
 
   PhpList\Core\Domain\Configuration\Repository\ConfigRepository:

config/services/services.yml

@@ -61,6 +61,15 @@ services:
     autoconfigure: true
     public: true
 
+  PhpList\Core\Domain\Analytics\Service\LinkTrackTokenService:
+    autowire: true
+    autoconfigure: true
+
+  PhpList\Core\Domain\Analytics\Service\LinkClickService:
+    autowire: true
+    autoconfigure: true
+    public: true
+
   PhpList\Core\Domain\Analytics\Service\AnalyticsService:
     autowire: true
     autoconfigure: true

src/Domain/Analytics/Model/Dto/LinkTrackToken.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\Core\Domain\Analytics\Model\Dto;
+
+/** Identifies one tracked link of one campaign for one subscriber, as carried in a click-tracking URL. */
+final class LinkTrackToken
+{
+    public const TYPE_HTML = 'H';
+    public const TYPE_TEXT = 'T';
+
+    public function __construct(
+        public readonly string $type,
+        public readonly string $forwardUuid,
+        public readonly string $messageUuid,
+        public readonly string $subscriberUuid,
+    ) {
+    }
+
+    public function isHtml(): bool
+    {
+        return $this->type === self::TYPE_HTML;
+    }
+
+    public static function isValidType(string $type): bool
+    {
+        return in_array($type, [self::TYPE_HTML, self::TYPE_TEXT], true);
+    }
+}

src/Domain/Analytics/Model/UserMessageView.php

@@ -15,7 +15,7 @@
 #[ORM\Index(name: 'phplist_user_message_view_msgidx', columns: ['messageid'])]
 #[ORM\Index(name: 'phplist_user_message_view_useridx', columns: ['userid'])]
 #[ORM\Index(name: 'phplist_user_message_view_usermsgidx', columns: ['userid', 'messageid'])]
-// todo: #[ORM\Index(name: 'phplist_user_message_view_viewedidx', columns: ['viewed'])]
+// @performance #[ORM\Index(name: 'phplist_user_message_view_viewedidx', columns: ['viewed'])]
 class UserMessageView implements DomainModel, Identity
 {
     #[ORM\Id]

src/Domain/Analytics/Repository/LinkTrackForwardRepository.php

@@ -4,11 +4,88 @@
 
 namespace PhpList\Core\Domain\Analytics\Repository;
 
+use Doctrine\DBAL\Exception\UniqueConstraintViolationException;
+use Doctrine\DBAL\Types\Types;
+use PhpList\Core\Domain\Analytics\Model\LinkTrackForward;
 use PhpList\Core\Domain\Common\Repository\AbstractRepository;
 use PhpList\Core\Domain\Common\Repository\CursorPaginationTrait;
 use PhpList\Core\Domain\Common\Repository\Interfaces\PaginatableRepositoryInterface;
 
 class LinkTrackForwardRepository extends AbstractRepository implements PaginatableRepositoryInterface
 {
     use CursorPaginationTrait;
+
+    public function findOneByUuid(string $uuid): ?LinkTrackForward
+    {
+        return $this->findOneBy(['uuid' => $uuid]);
+    }
+
+    public function findOneByUrlHash(string $urlHash): ?LinkTrackForward
+    {
+        return $this->findOneBy(['urlHash' => $urlHash]);
+    }
+
+    /**
+     * Returns the forward for a (cleaned) URL, creating it when it does not exist yet. Creation uses a plain
+     * insert, so two workers racing on the same URL end up with the one row enforced by the urlhash unique key
+     * instead of a closed entity manager - this is an exception of the usual workflow of creating entities in manager
+     * classes.
+     */
+    public function findOrCreateByUrl(string $url, bool $personalise): LinkTrackForward
+    {
+        $urlHash = md5($url);
+
+        $forward = $this->findOneByUrlHash($urlHash);
+        if ($forward === null) {
+            // false when a concurrent worker created it first, the select then finds that row
+            $this->insert($url, $urlHash, $personalise);
+            $forward = $this->findOneByUrlHash($urlHash);
+        }
+
+        if (empty($forward->getUuid())) {
+            $metadata = $this->getClassMetadata();
+            $uuidColumn = $metadata->getColumnName('uuid');
+            // only fills an empty uuid, so a worker that got there first is never overwritten
+            $this->getEntityManager()->getConnection()->executeStatement(
+                sprintf(
+                    'UPDATE %s SET %s = :uuid WHERE %s = :id AND (%s IS NULL OR %s = \'\')',
+                    $metadata->getTableName(),
+                    $uuidColumn,
+                    $metadata->getColumnName('id'),
+                    $uuidColumn,
+                    $uuidColumn
+                ),
+                ['uuid' => self::generateUuid(), 'id' => $forward->getId()],
+            );
+            $this->getEntityManager()->refresh($forward);
+        }
+
+        return $forward;
+    }
+
+    private function insert(string $url, string $urlHash, bool $personalise): bool
+    {
+        $metadata = $this->getClassMetadata();
+        try {
+            $this->getEntityManager()->getConnection()->insert(
+                $metadata->getTableName(),
+                [
+                    $metadata->getColumnName('url') => $url,
+                    $metadata->getColumnName('urlHash') => $urlHash,
+                    $metadata->getColumnName('personalise') => $personalise,
+                    $metadata->getColumnName('uuid') => self::generateUuid(),
+                ],
+                [$metadata->getColumnName('personalise') => Types::BOOLEAN],
+            );
+        } catch (UniqueConstraintViolationException) {
+            return false;
+        }
+
+        return true;
+    }
+
+    private static function generateUuid(): string
+    {
+        return bin2hex(random_bytes(18));
+    }
 }

src/Domain/Analytics/Repository/LinkTrackMlRepository.php

@@ -4,8 +4,106 @@
 
 namespace PhpList\Core\Domain\Analytics\Repository;
 
+use DateTimeInterface;
+use Doctrine\DBAL\Exception;
+use Doctrine\DBAL\Exception\UniqueConstraintViolationException;
 use PhpList\Core\Domain\Common\Repository\AbstractRepository;
 
+/**
+ * Per campaign and link aggregates. Counters are changed with atomic statements so that concurrent sending
+ * workers and clicking subscribers cannot lose updates. Column names come from the entity mapping.
+ */
 class LinkTrackMlRepository extends AbstractRepository
 {
+    /** Counts one more email of the campaign that contains the link. */
+    public function incrementTotal(int $messageId, int $forwardId): void
+    {
+        $total = $this->column('total');
+
+        $this->upsert(
+            updateSql: sprintf('%1$s = COALESCE(%1$s, 0) + 1', $total),
+            updateParams: [],
+            insertColumns: [$total => 1],
+            messageId: $messageId,
+            forwardId: $forwardId,
+        );
+    }
+
+    public function recordClick(int $messageId, int $forwardId, bool $isHtml, DateTimeInterface $now): void
+    {
+        $timestamp = $now->format('Y-m-d H:i:s');
+        [$clicked, $firstClick, $latestClick, $htmlClicked, $textClicked] = array_map(
+            $this->column(...),
+            ['clicked', 'firstClick', 'latestClick', 'htmlClicked', 'textClicked']
+        );
+
+        $this->upsert(
+            updateSql: sprintf(
+                '%1$s = COALESCE(%1$s, 0) + 1, %2$s = COALESCE(%2$s, :now), %3$s = :now,'
+                . ' %4$s = COALESCE(%4$s, 0) + :html, %5$s = COALESCE(%5$s, 0) + :text',
+                $clicked,
+                $firstClick,
+                $latestClick,
+                $htmlClicked,
+                $textClicked
+            ),
+            updateParams: ['now' => $timestamp, 'html' => (int) $isHtml, 'text' => (int) !$isHtml],
+            insertColumns: [
+                $clicked => 1,
+                $firstClick => $timestamp,
+                $latestClick => $timestamp,
+                $htmlClicked => (int) $isHtml,
+                $textClicked => (int) !$isHtml,
+            ],
+            messageId: $messageId,
+            forwardId: $forwardId,
+        );
+    }
+
+    private function column(string $field): string
+    {
+        return $this->getClassMetadata()->getColumnName($field);
+    }
+
+    /**
+     * @param string $updateSql the assignments of the UPDATE, without SET
+     * @param array<string, int|string> $updateParams
+     * @param array<string, int|string> $insertColumns column => value
+     * @throws Exception
+     */
+    private function upsert(
+        string $updateSql,
+        array $updateParams,
+        array $insertColumns,
+        int $messageId,
+        int $forwardId,
+    ): void {
+        $connection = $this->getEntityManager()->getConnection();
+        $tableName = $this->getClassMetadata()->getTableName();
+        $messageColumn = $this->column('messageId');
+        $forwardColumn = $this->column('forwardId');
+
+        $sql = sprintf(
+            'UPDATE %s SET %s WHERE %s = :messageId AND %s = :forwardId',
+            $connection->quoteIdentifier($tableName),
+            $updateSql,
+            $messageColumn,
+            $forwardColumn
+        );
+        $params = $updateParams + ['messageId' => $messageId, 'forwardId' => $forwardId];
+
+        if ($connection->executeStatement($sql, $params) > 0) {
+            return;
+        }
+
+        try {
+            $connection->insert(
+                $tableName,
+                [$messageColumn => $messageId, $forwardColumn => $forwardId] + $insertColumns
+            );
+        } catch (UniqueConstraintViolationException) {
+            // inserted by a concurrent request in the meantime
+            $connection->executeStatement($sql, $params);
+        }
+    }
 }

src/Domain/Analytics/Repository/LinkTrackUmlClickRepository.php

@@ -4,11 +4,76 @@
 
 namespace PhpList\Core\Domain\Analytics\Repository;
 
+use DateTimeInterface;
+use Doctrine\DBAL\Exception\UniqueConstraintViolationException;
 use PhpList\Core\Domain\Common\Repository\AbstractRepository;
 use PhpList\Core\Domain\Common\Repository\CursorPaginationTrait;
 use PhpList\Core\Domain\Common\Repository\Interfaces\PaginatableRepositoryInterface;
 
 class LinkTrackUmlClickRepository extends AbstractRepository implements PaginatableRepositoryInterface
 {
     use CursorPaginationTrait;
+
+    /**
+     * Counts a click of a subscriber on a link of a campaign, creating the row on the first click. Column names
+     * come from the entity mapping.
+     */
+    public function recordClick(
+        int $messageId,
+        int $userId,
+        int $forwardId,
+        bool $isHtml,
+        DateTimeInterface $now,
+    ): void {
+        $connection = $this->getEntityManager()->getConnection();
+        $metadata = $this->getClassMetadata();
+        $timestamp = $now->format('Y-m-d H:i:s');
+        [$message, $user, $forward, $clicked, $firstClick, $latestClick, $htmlClicked, $textClicked] = array_map(
+            $metadata->getColumnName(...),
+            ['messageId', 'userId', 'forwardId', 'clicked', 'firstClick', 'latestClick', 'htmlClicked', 'textClicked']
+        );
+
+        $sql = sprintf(
+            'UPDATE %4$s SET %5$s = COALESCE(%5$s, 0) + 1, %6$s = COALESCE(%6$s, :now), %7$s = :now,'
+            . ' %8$s = COALESCE(%8$s, 0) + :html, %9$s = COALESCE(%9$s, 0) + :text'
+            . ' WHERE %1$s = :messageId AND %2$s = :userId AND %3$s = :forwardId',
+            $message,
+            $user,
+            $forward,
+            $connection->quoteIdentifier($metadata->getTableName()),
+            $clicked,
+            $firstClick,
+            $latestClick,
+            $htmlClicked,
+            $textClicked
+        );
+        $params = [
+            'now' => $timestamp,
+            'html' => (int) $isHtml,
+            'text' => (int) !$isHtml,
+            'messageId' => $messageId,
+            'userId' => $userId,
+            'forwardId' => $forwardId,
+        ];
+
+        if ($connection->executeStatement($sql, $params) > 0) {
+            return;
+        }
+
+        try {
+            $connection->insert($metadata->getTableName(), [
+                $message => $messageId,
+                $user => $userId,
+                $forward => $forwardId,
+                $firstClick => $timestamp,
+                $latestClick => $timestamp,
+                $clicked => 1,
+                $htmlClicked => (int) $isHtml,
+                $textClicked => (int) !$isHtml,
+            ]);
+        } catch (UniqueConstraintViolationException) {
+            // inserted by a concurrent request in the meantime
+            $connection->executeStatement($sql, $params);
+        }
+    }
 }