Exceptions + translations (#361)

* MissingMessageIdException

* MailboxConnectionException

* BadMethodCallException (style fix)

* Translate user facing messages

* Translate

* Translate PasswordResetMessageHandler texts

* Translate SubscriberConfirmationMessageHandler texts

* MessageBuilder exceptions

* BlacklistEmailAndDeleteBounceHandler

* BlacklistEmailHandler - AdvancedBounceRulesProcessor

* AdvancedBounceRulesProcessor

* BounceStatus

* CampaignProcessor

* UnidentifiedBounceReprocessor

* Style fix

* Test fix

* ConsecutiveBounceHandler

---------

Co-authored-by: Tatevik <[email protected]>

Author: TatevikGr

resources/translations/messages.en.xlf

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\Core\Domain\Analytics\Exception;
+
+use LogicException;
+
+class MissingMessageIdException extends LogicException
+{
+    public function __construct()
+    {
+        parent::__construct('Message must have an ID');
+    }
+}

src/Domain/Analytics/Exception/MissingMessageIdException.php

@@ -4,8 +4,8 @@
 
 namespace PhpList\Core\Domain\Analytics\Service;
 
-use InvalidArgumentException;
 use PhpList\Core\Core\ConfigProvider;
+use PhpList\Core\Domain\Analytics\Exception\MissingMessageIdException;
 use PhpList\Core\Domain\Analytics\Model\LinkTrack;
 use PhpList\Core\Domain\Analytics\Repository\LinkTrackRepository;
 use PhpList\Core\Domain\Messaging\Model\Message;
@@ -36,7 +36,7 @@ public function isExtractAndSaveLinksApplicable(): bool
      * Extract links from message content and save them to the LinkTrackRepository
      *
      * @return LinkTrack[] The saved LinkTrack entities
-     * @throws InvalidArgumentException if the message doesn't have an ID
+     * @throws MissingMessageIdException
      */
     public function extractAndSaveLinks(Message $message, int $userId): array
     {
@@ -48,7 +48,7 @@ public function extractAndSaveLinks(Message $message, int $userId): array
         $messageId = $message->getId();
 
         if ($messageId === null) {
-            throw new InvalidArgumentException('Message must have an ID');
+            throw new MissingMessageIdException();
         }
 
         $links = $this->extractLinksFromHtml($content->getText() ?? '');

src/Domain/Analytics/Service/LinkTrackService.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\Core\Domain\Common\Exception;
+
+use RuntimeException;
+use Throwable;
+
+class MailboxConnectionException extends RuntimeException
+{
+    public function __construct(string $mailbox, ?string $message = null, ?Throwable $previous = null)
+    {
+        if ($message === null) {
+            $message = sprintf(
+                'Cannot open mailbox "%s": %s',
+                $mailbox,
+                imap_last_error() ?: 'unknown error'
+            );
+        }
+        parent::__construct($message, 0, $previous);
+    }
+}

src/Domain/Common/Exception/MailboxConnectionException.php

@@ -37,8 +37,10 @@ private function readConfigFile(): ?string
         $contents = file_get_contents($this->confPath);
         if ($contents === false) {
             $this->logger->warning('Cannot read ISP restrictions file', ['path' => $this->confPath]);
+
             return null;
         }
+
         return $contents;
     }
 
@@ -106,20 +108,24 @@ private function applyKeyValue(
             if ($val !== '' && ctype_digit($val)) {
                 $maxBatch = (int) $val;
             }
+
             return [$maxBatch, $minBatchPeriod, $lockFile];
         }
         if ($key === 'minbatchperiod') {
             if ($val !== '' && ctype_digit($val)) {
                 $minBatchPeriod = (int) $val;
             }
+
             return [$maxBatch, $minBatchPeriod, $lockFile];
         }
         if ($key === 'lockfile') {
             if ($val !== '') {
                 $lockFile = $val;
             }
+
             return [$maxBatch, $minBatchPeriod, $lockFile];
         }
+
         return [$maxBatch, $minBatchPeriod, $lockFile];
     }
 

src/Domain/Common/I18n/Messages.php

@@ -6,7 +6,7 @@
 
 use DateTimeImmutable;
 use IMAP\Connection;
-use RuntimeException;
+use PhpList\Core\Domain\Common\Exception\MailboxConnectionException;
 
 class NativeImapMailReader
 {
@@ -24,7 +24,7 @@ public function open(string $mailbox, int $options = 0): Connection
         $link = imap_open($mailbox, $this->username, $this->password, $options);
 
         if ($link === false) {
-            throw new RuntimeException('Cannot open mailbox: '.(imap_last_error() ?: 'unknown error'));
+            throw new MailboxConnectionException($mailbox);
         }
 
         return $link;

src/Domain/Common/IspRestrictionsProvider.php

@@ -4,9 +4,9 @@
 
 namespace PhpList\Core\Domain\Common\Repository;
 
+use BadMethodCallException;
 use PhpList\Core\Domain\Common\Model\Filter\FilterRequestInterface;
 use PhpList\Core\Domain\Common\Model\Interfaces\DomainModel;
-use RuntimeException;
 
 trait CursorPaginationTrait
 {
@@ -30,14 +30,14 @@ public function getAfterId(int $lastId, int $limit): array
      * Get filtered + paginated messages for a given owner and status.
      *
      * @return DomainModel[]
-     * @throws RuntimeException
-     */
+     * @throws BadMethodCallException
+     * */
     public function getFilteredAfterId(int $lastId, int $limit, ?FilterRequestInterface $filter = null): array
     {
         if ($filter === null) {
             return $this->getAfterId($lastId, $limit);
         }
 
-        throw new RuntimeException('Filter method not implemented');
+        throw new BadMethodCallException('getFilteredAfterId method not implemented');
     }
 }

src/Domain/Common/Mail/NativeImapMailReader.php

@@ -16,10 +16,8 @@ class SystemInfoCollector
     /**
      * @param string[] $configuredKeys keys to include (empty => use defaults)
      */
-    public function __construct(
-        RequestStack $requestStack,
-        array $configuredKeys = []
-    ) {
+    public function __construct(RequestStack $requestStack, array $configuredKeys = [])
+    {
         $this->requestStack = $requestStack;
         $this->configuredKeys = $configuredKeys;
     }
@@ -72,6 +70,7 @@ public function collectAsString(): string
         foreach ($pairs as $k => $v) {
             $lines[] = sprintf('%s = %s', $k, $v);
         }
+
         return "\n" . implode("\n", $lines);
     }
 }

src/Domain/Common/Repository/CursorPaginationTrait.php

@@ -44,6 +44,7 @@ public function get(
         ?DateTimeInterface $dateTo = null
     ): array {
         $filter = new EventLogFilter($page, $dateFrom, $dateTo);
+
         return $this->repository->getFilteredAfterId($lastId, $limit, $filter);
     }