Blacklist (#352)

* Blacklisted

* user repository methods

* fix configs

* add test

* fix: phpmd

* fix: repo configs

* return a created resource

---------

Co-authored-by: Tatevik <tatevikg1@gmail.com>

Author: TatevikGr

config/services/managers.yml

@@ -67,3 +67,7 @@ services:
   PhpList\Core\Domain\Messaging\Service\Manager\ListMessageManager:
     autowire: true
     autoconfigure: true
+
+  PhpList\Core\Domain\Subscription\Service\Manager\SubscriberBlacklistManager:
+    autowire: true
+    autoconfigure: true

config/services/repositories.yml

@@ -110,3 +110,13 @@ services:
         parent: PhpList\Core\Domain\Common\Repository\AbstractRepository
         arguments:
             - PhpList\Core\Domain\Messaging\Model\ListMessage
+
+    PhpList\Core\Domain\Subscription\Repository\UserBlacklistRepository:
+      parent: PhpList\Core\Domain\Common\Repository\AbstractRepository
+      arguments:
+        - PhpList\Core\Domain\Subscription\Model\UserBlacklist
+
+    PhpList\Core\Domain\Subscription\Repository\UserBlacklistDataRepository:
+      parent: PhpList\Core\Domain\Common\Repository\AbstractRepository
+      arguments:
+        - PhpList\Core\Domain\Subscription\Model\UserBlacklistData

src/Domain/Identity/Repository/UserBlacklistDataRepository.php

@@ -2,12 +2,12 @@
 
 declare(strict_types=1);
 
-namespace PhpList\Core\Domain\Identity\Model;
+namespace PhpList\Core\Domain\Subscription\Model;
 
 use DateTime;
 use Doctrine\ORM\Mapping as ORM;
 use PhpList\Core\Domain\Common\Model\Interfaces\DomainModel;
-use PhpList\Core\Domain\Identity\Repository\UserBlacklistRepository;
+use PhpList\Core\Domain\Subscription\Repository\UserBlacklistRepository;
 
 #[ORM\Entity(repositoryClass: UserBlacklistRepository::class)]
 #[ORM\Table(name: 'phplist_user_blacklist')]
@@ -21,6 +21,9 @@ class UserBlacklist implements DomainModel
     #[ORM\Column(name: 'added', type: 'datetime', nullable: true)]
     private ?DateTime $added = null;
 
+    #[ORM\OneToOne(targetEntity: UserBlacklistData::class, mappedBy: 'email')]
+    private ?UserBlacklistData $blacklistData = null;
+
     public function getEmail(): string
     {
         return $this->email;
@@ -42,4 +45,9 @@ public function setAdded(?DateTime $added): self
         $this->added = $added;
         return $this;
     }
+
+    public function getBlacklistData(): ?UserBlacklistData
+    {
+        return $this->blacklistData;
+    }
 }

src/Domain/Identity/Repository/UserBlacklistRepository.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace PhpList\Core\Domain\Identity\Model;
+namespace PhpList\Core\Domain\Subscription\Model;
 
 use Doctrine\ORM\Mapping as ORM;
 use PhpList\Core\Domain\Common\Model\Interfaces\DomainModel;
-use PhpList\Core\Domain\Identity\Repository\UserBlacklistDataRepository;
+use PhpList\Core\Domain\Subscription\Repository\UserBlacklistDataRepository;
 
 #[ORM\Entity(repositoryClass: UserBlacklistDataRepository::class)]
 #[ORM\Table(name: 'phplist_user_blacklist_data')]

src/Domain/Identity/Model/UserBlacklist.php renamed to src/Domain/Subscription/Model/UserBlacklist.php

@@ -127,4 +127,18 @@ public function findSubscriberWithSubscriptions(int $id): ?Subscriber
             ->getQuery()
             ->getOneOrNullResult();
     }
+
+    public function isEmailBlacklisted(string $email): bool
+    {
+        $queryBuilder = $this->getEntityManager()->createQueryBuilder();
+
+        $queryBuilder->select('u.email')
+            ->from(Subscriber::class, 'u')
+            ->where('u.email = :email')
+            ->andWhere('u.blacklisted = 1')
+            ->setParameter('email', $email)
+            ->setMaxResults(1);
+
+        return !($queryBuilder->getQuery()->getOneOrNullResult() === null);
+    }
 }

src/Domain/Identity/Model/UserBlacklistData.php renamed to src/Domain/Subscription/Model/UserBlacklistData.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\Core\Domain\Subscription\Repository;
+
+use PhpList\Core\Domain\Common\Repository\AbstractRepository;
+use PhpList\Core\Domain\Subscription\Model\UserBlacklistData;
+
+class UserBlacklistDataRepository extends AbstractRepository
+{
+    public function findOneByEmail(string $email): ?UserBlacklistData
+    {
+        return $this->findOneBy(['email' => $email]);
+    }
+}

src/Domain/Subscription/Repository/SubscriberRepository.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\Core\Domain\Subscription\Repository;
+
+use PhpList\Core\Domain\Common\Repository\AbstractRepository;
+use PhpList\Core\Domain\Subscription\Model\UserBlacklist;
+use PhpList\Core\Domain\Subscription\Model\UserBlacklistData;
+
+class UserBlacklistRepository extends AbstractRepository
+{
+    public function findBlacklistInfoByEmail(string $email): ?UserBlacklist
+    {
+        $queryBuilder = $this->getEntityManager()->createQueryBuilder();
+
+        $queryBuilder->select('ub.email, ub.added, ubd.data AS reason')
+            ->from(UserBlacklist::class, 'ub')
+            ->innerJoin(UserBlacklistData::class, 'ubd', 'WITH', 'ub.email = ubd.email')
+            ->where('ub.email = :email')
+            ->setParameter('email', $email)
+            ->setMaxResults(1);
+
+        return $queryBuilder->getQuery()->getOneOrNullResult();
+    }
+
+    public function findOneByEmail(string $email): ?UserBlacklist
+    {
+        return $this->findOneBy([
+            'email' => $email,
+        ]);
+    }
+}

src/Domain/Subscription/Repository/UserBlacklistDataRepository.php

@@ -0,0 +1,86 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\Core\Domain\Subscription\Service\Manager;
+
+use DateTime;
+use Doctrine\ORM\EntityManagerInterface;
+use PhpList\Core\Domain\Subscription\Model\UserBlacklist;
+use PhpList\Core\Domain\Subscription\Model\UserBlacklistData;
+use PhpList\Core\Domain\Subscription\Repository\SubscriberRepository;
+use PhpList\Core\Domain\Subscription\Repository\UserBlacklistDataRepository;
+use PhpList\Core\Domain\Subscription\Repository\UserBlacklistRepository;
+
+class SubscriberBlacklistManager
+{
+    public function __construct(
+        private readonly SubscriberRepository $subscriberRepository,
+        private readonly UserBlacklistRepository $userBlacklistRepository,
+        private readonly UserBlacklistDataRepository $blacklistDataRepository,
+        private readonly EntityManagerInterface $entityManager,
+    ) {
+    }
+
+    public function isEmailBlacklisted(string $email): bool
+    {
+        return $this->subscriberRepository->isEmailBlacklisted($email);
+    }
+
+    public function getBlacklistInfo(string $email): ?UserBlacklist
+    {
+        return $this->userBlacklistRepository->findBlacklistInfoByEmail($email);
+    }
+
+    public function addEmailToBlacklist(string $email, ?string $reasonData = null): UserBlacklist
+    {
+        $existing = $this->subscriberRepository->isEmailBlacklisted($email);
+        if ($existing) {
+            return $this->getBlacklistInfo($email);
+        }
+
+        $blacklistEntry = new UserBlacklist();
+        $blacklistEntry->setEmail($email);
+        $blacklistEntry->setAdded(new DateTime());
+
+        $this->entityManager->persist($blacklistEntry);
+
+        if ($reasonData !== null) {
+            $blacklistData = new UserBlacklistData();
+            $blacklistData->setEmail($email);
+            $blacklistData->setName('reason');
+            $blacklistData->setData($reasonData);
+            $this->entityManager->persist($blacklistData);
+        }
+
+        $this->entityManager->flush();
+
+        return $blacklistEntry;
+    }
+
+    public function removeEmailFromBlacklist(string $email): void
+    {
+        $blacklistEntry = $this->userBlacklistRepository->findOneByEmail($email);
+        if ($blacklistEntry) {
+            $this->entityManager->remove($blacklistEntry);
+        }
+
+        $blacklistData = $this->blacklistDataRepository->findOneByEmail($email);
+        if ($blacklistData) {
+            $this->entityManager->remove($blacklistData);
+        }
+
+        $subscriber = $this->subscriberRepository->findOneByEmail($email);
+        if ($subscriber) {
+            $subscriber->setBlacklisted(false);
+        }
+
+        $this->entityManager->flush();
+    }
+
+    public function getBlacklistReason(string $email): ?string
+    {
+        $data = $this->blacklistDataRepository->findOneByEmail($email);
+        return $data ? $data->getData() : null;
+    }
+}