Prevent deleting a list if attached to a form

[MAILPOET-3661]

lib/API/JSON/v1/Segments.php

@@ -12,6 +12,7 @@ use MailPoet\Config\AccessControl;
 use MailPoet\Doctrine\Validator\ValidationException;
 use MailPoet\Entities\SegmentEntity;
 use MailPoet\Entities\SubscriberEntity;
+use MailPoet\Form\FormsRepository;
 use MailPoet\Listing;
 use MailPoet\Newsletter\Segment\NewsletterSegmentRepository;
 use MailPoet\Segments\SegmentListingRepository;
@@ -55,6 +56,9 @@ class Segments extends APIEndpoint {
   /** @var NewsletterSegmentRepository */
   private $newsletterSegmentRepository;
 
+  /** @var FormsRepository */
+  private $formsRepository;
+
   public function __construct(
     Listing\Handler $listingHandler,
     SegmentsRepository $segmentsRepository,
@@ -64,7 +68,8 @@ class Segments extends APIEndpoint {
     SubscribersRepository $subscribersRepository,
     WooCommerce $wooCommerce,
     WP $wpSegment,
-    NewsletterSegmentRepository $newsletterSegmentRepository
+    NewsletterSegmentRepository $newsletterSegmentRepository,
+    FormsRepository $formsRepository
   ) {
     $this->listingHandler = $listingHandler;
     $this->wooCommerceSync = $wooCommerce;
@@ -75,6 +80,7 @@ class Segments extends APIEndpoint {
     $this->wpSegment = $wpSegment;
     $this->segmentListingRepository = $segmentListingRepository;
     $this->newsletterSegmentRepository = $newsletterSegmentRepository;
+    $this->formsRepository = $formsRepository;
   }
 
   public function get($data = []) {
@@ -177,6 +183,23 @@ class Segments extends APIEndpoint {
       ]);
     }
 
+    $activelyUsedFormNames = $this->formsRepository->getNamesOfFormsForSegments();
+    if (isset($activelyUsedFormNames[$segment->getId()])) {
+      return $this->badRequest([
+        APIError::BAD_REQUEST => str_replace(
+          '%$1s',
+          "'" . join("', '", $activelyUsedFormNames[$segment->getId()] ) . "'",
+          _nx(
+            'List cannot be deleted because it’s used for %$1s form',
+            'List cannot be deleted because it’s used for %$1s forms',
+            count($activelyUsedFormNames[$segment->getId()]),
+            'Alert shown when trying to delete segment, when it is assigned to a form.',
+            'mailpoet'
+          )
+        ),
+      ]);
+    }
+
     // When the segment is of type WP_USERS we want to trash all subscribers who aren't subscribed in another list
     if ($segment->getType() === SegmentEntity::TYPE_WP_USERS) {
       $subscribers = $this->subscribersRepository->findExclusiveSubscribersBySegment((int)$segment->getId());

lib/Form/FormsRepository.php

@@ -27,6 +27,20 @@ class FormsRepository extends Repository {
       ->getResult();
   }
 
+  public function getNamesOfFormsForSegments(): array {
+    $allNonDeletedForms = $this->findAllNotDeleted();
+
+    $nameMap = [];
+    foreach ($allNonDeletedForms as $form) {
+      $blockSegmentsIds = $form->getSettingsSegmentIds();
+      foreach ($blockSegmentsIds as $blockSegmentId) {
+        $nameMap[(string)$blockSegmentId][] = $form->getName();
+      }
+    }
+
+    return $nameMap;
+  }
+
   public function count(): int {
     return (int)$this->doctrineRepository
       ->createQueryBuilder('f')

lib/Segments/SegmentsRepository.php

@@ -8,6 +8,7 @@ use MailPoet\Entities\DynamicSegmentFilterData;
 use MailPoet\Entities\DynamicSegmentFilterEntity;
 use MailPoet\Entities\SegmentEntity;
 use MailPoet\Entities\SubscriberSegmentEntity;
+use MailPoet\Form\FormsRepository;
 use MailPoet\Newsletter\Segment\NewsletterSegmentRepository;
 use MailPoet\NotFoundException;
 use MailPoet\WP\Functions as WPFunctions;
@@ -23,12 +24,17 @@ class SegmentsRepository extends Repository {
   /** @var NewsletterSegmentRepository */
   private $newsletterSegmentRepository;
 
+  /** @var FormsRepository */
+  private $formsRepository;
+
   public function __construct(
     EntityManager $entityManager,
-    NewsletterSegmentRepository $newsletterSegmentRepository
+    NewsletterSegmentRepository $newsletterSegmentRepository,
+    FormsRepository $formsRepository
   ) {
     parent::__construct($entityManager);
     $this->newsletterSegmentRepository = $newsletterSegmentRepository;
+    $this->formsRepository = $formsRepository;
   }
 
   protected function getEntityClassName() {
@@ -171,8 +177,10 @@ class SegmentsRepository extends Repository {
   }
 
   public function bulkTrash(array $ids, string $type = SegmentEntity::TYPE_DEFAULT): int {
-    $activelyUsed = $this->newsletterSegmentRepository->getSubjectsOfActivelyUsedEmailsForSegments($ids);
-    $ids = array_diff($ids, array_keys($activelyUsed));
+    $activelyUsedInNewsletters = $this->newsletterSegmentRepository->getSubjectsOfActivelyUsedEmailsForSegments($ids);
+    $activelyUsedInForms = $this->formsRepository->getNamesOfFormsForSegments();
+    $activelyUsed = array_unique(array_merge(array_keys($activelyUsedInNewsletters), array_keys($activelyUsedInForms)));
+    $ids = array_diff($ids, $activelyUsed);
     return $this->updateDeletedAt($ids, new Carbon(), $type);
   }
 

tests/integration/API/JSON/v1/SegmentsTest.php

@@ -7,6 +7,7 @@ use MailPoet\API\JSON\Response as APIResponse;
 use MailPoet\API\JSON\ResponseBuilders\SegmentsResponseBuilder;
 use MailPoet\API\JSON\v1\Segments;
 use MailPoet\DI\ContainerWrapper;
+use MailPoet\Entities\FormEntity;
 use MailPoet\Entities\NewsletterEntity;
 use MailPoet\Entities\NewsletterSegmentEntity;
 use MailPoet\Entities\SegmentEntity;
@@ -162,6 +163,62 @@ class SegmentsTest extends \MailPoetTest {
     expect($response->errors[0]['message'])->equals("List cannot be deleted because it’s used for 'Subject' email");
   }
 
+  public function testItReturnsErrorWhenTrashingSegmentWithActiveForm() {
+    $form = new FormEntity('My Form');
+    $form->setSettings([
+      'segments' => [(string)$this->segment3->getId()],
+    ]);
+    $this->entityManager->persist($form);
+    $this->entityManager->flush();
+
+    $response = $this->endpoint->trash(['id' => $this->segment3->getId()]);
+    $this->entityManager->refresh($this->segment3);
+    expect($response->status)->equals(APIResponse::STATUS_BAD_REQUEST);
+    expect($response->errors[0]['message'])->equals("List cannot be deleted because it’s used for 'My Form' form");
+  }
+
+  public function testItReturnsPluralErrorWhenTrashingSegmentWithActiveForms() {
+    $form1 = new FormEntity('My Form');
+    $form1->setSettings([
+      'segments' => [(string)$this->segment3->getId()],
+    ]);
+    $this->entityManager->persist($form1);
+    $this->entityManager->flush();
+
+    $form2 = new FormEntity('My other Form');
+    $form2->setSettings([
+      'segments' => [(string)$this->segment3->getId()],
+    ]);
+    $this->entityManager->persist($form2);
+    $this->entityManager->flush();
+
+    $response = $this->endpoint->trash(['id' => $this->segment3->getId()]);
+    $this->entityManager->refresh($this->segment3);
+    expect($response->status)->equals(APIResponse::STATUS_BAD_REQUEST);
+    expect($response->errors[0]['message'])->equals("List cannot be deleted because it’s used for 'My Form', 'My other Form' forms");
+  }
+
+  public function testItCanTrashSegmentWithoutActiveForm() {
+    $form1 = new FormEntity('My Form');
+    $form1->setSettings([
+      'segments' => [(string)$this->segment3->getId()],
+    ]);
+    $this->entityManager->persist($form1);
+    $this->entityManager->flush();
+
+    $response = $this->endpoint->trash(['id' => $this->segment2->getId()]);
+    $this->entityManager->clear();
+    $segment = $this->segmentRepository->findOneById($this->segment2->getId());
+    assert($segment instanceof SegmentEntity);
+
+    expect($response->status)->equals(APIResponse::STATUS_OK);
+    expect($response->data)->equals(
+      $this->responseBuilder->build($segment)
+    );
+    expect($response->data['deleted_at'])->notNull();
+    expect($response->meta['count'])->equals(1);
+  }
+
   public function testItCanDeleteASegment() {
     $response = $this->endpoint->delete(['id' => $this->segment3->getId()]);
     expect($response->data)->isEmpty();
@@ -232,5 +289,6 @@ class SegmentsTest extends \MailPoetTest {
     $this->truncateEntity(SubscriberSegmentEntity::class);
     $this->truncateEntity(NewsletterEntity::class);
     $this->truncateEntity(NewsletterSegmentEntity::class);
+    $this->truncateEntity(FormEntity::class);
   }
 }