Subscribers bulk actions refactored to Doctrine

[MAILPOET-3033]

lib/API/JSON/v1/Subscribers.php

@@ -7,6 +7,7 @@ use MailPoet\API\JSON\Error as APIError;
 use MailPoet\API\JSON\Response as APIResponse;
 use MailPoet\API\JSON\ResponseBuilders\SubscribersResponseBuilder;
 use MailPoet\Config\AccessControl;
+use MailPoet\Entities\SegmentEntity;
 use MailPoet\Entities\StatisticsUnsubscribeEntity;
 use MailPoet\Entities\SubscriberEntity;
 use MailPoet\Form\Util\FieldNameObfuscator;
@@ -17,7 +18,7 @@ use MailPoet\Models\StatisticsForms;
 use MailPoet\Models\Subscriber;
 use MailPoet\Models\SubscriberSegment;
 use MailPoet\Newsletter\Scheduler\WelcomeScheduler;
-use MailPoet\Segments\BulkAction;
+use MailPoet\Segments\SegmentsRepository;
 use MailPoet\Settings\SettingsController;
 use MailPoet\Statistics\Track\Unsubscribes;
 use MailPoet\Subscribers\ConfirmationEmailMailer;
@@ -30,6 +31,7 @@ use MailPoet\Subscription\Captcha;
 use MailPoet\Subscription\CaptchaSession;
 use MailPoet\Subscription\SubscriptionUrlFactory;
 use MailPoet\Subscription\Throttling as SubscriptionThrottling;
+use MailPoet\UnexpectedValueException;
 use MailPoet\WP\Functions as WPFunctions;
 
 class Subscribers extends APIEndpoint {
@@ -40,10 +42,6 @@ class Subscribers extends APIEndpoint {
     'methods' => ['subscribe' => AccessControl::NO_ACCESS_RESTRICTION],
   ];
 
-  /** @var Listing\BulkActionController */
-  private $bulkActionController;
-
-
   /** @var SubscriberActions */
   private $subscriberActions;
 
@@ -86,8 +84,10 @@ class Subscribers extends APIEndpoint {
   /** @var SubscriberListingRepository */
   private $subscriberListingRepository;
 
+  /** @var SegmentsRepository */
+  private $segmentsRepository;
+
   public function __construct(
-    Listing\BulkActionController $bulkActionController,
     SubscriberActions $subscriberActions,
     RequiredCustomFieldValidator $requiredCustomFieldValidator,
     Listing\Handler $listingHandler,
@@ -101,9 +101,9 @@ class Subscribers extends APIEndpoint {
     SubscribersRepository $subscribersRepository,
     SubscribersResponseBuilder $subscribersResponseBuilder,
     SubscriberListingRepository $subscriberListingRepository,
+    SegmentsRepository $segmentsRepository,
     FieldNameObfuscator $fieldNameObfuscator
   ) {
-    $this->bulkActionController = $bulkActionController;
     $this->subscriberActions = $subscriberActions;
     $this->requiredCustomFieldValidator = $requiredCustomFieldValidator;
     $this->listingHandler = $listingHandler;
@@ -118,6 +118,7 @@ class Subscribers extends APIEndpoint {
     $this->subscribersRepository = $subscribersRepository;
     $this->subscribersResponseBuilder = $subscribersResponseBuilder;
     $this->subscriberListingRepository = $subscriberListingRepository;
+    $this->segmentsRepository = $segmentsRepository;
   }
 
   public function get($data = []) {
@@ -425,14 +426,12 @@ class Subscribers extends APIEndpoint {
   }
 
   public function restore($data = []) {
-    $id = (isset($data['id']) ? (int)$data['id'] : false);
+    $subscriber = $this->getSubscriber($data);
-    $subscriber = Subscriber::findOne($id);
+    if ($subscriber instanceof SubscriberEntity) {
-    if ($subscriber instanceof Subscriber) {
+      $this->subscribersRepository->bulkRestore([$subscriber->getId()]);
-      $subscriber->restore();
+      $this->subscribersRepository->refresh($subscriber);
-      $subscriber = Subscriber::findOne($subscriber->id);
-      if(!$subscriber instanceof Subscriber) return $this->errorResponse();
       return $this->successResponse(
-        $subscriber->asArray(),
+        $this->subscribersResponseBuilder->build($subscriber),
         ['count' => 1]
       );
     } else {
@@ -443,14 +442,12 @@ class Subscribers extends APIEndpoint {
   }
 
   public function trash($data = []) {
-    $id = (isset($data['id']) ? (int)$data['id'] : false);
+    $subscriber = $this->getSubscriber($data);
-    $subscriber = Subscriber::findOne($id);
+    if ($subscriber instanceof SubscriberEntity) {
-    if ($subscriber instanceof Subscriber) {
+      $this->subscribersRepository->bulkTrash([$subscriber->getId()]);
-      $subscriber->trash();
+      $this->subscribersRepository->refresh($subscriber);
-      $subscriber = Subscriber::findOne($subscriber->id);
-      if(!$subscriber instanceof Subscriber) return $this->errorResponse();
       return $this->successResponse(
-        $subscriber->asArray(),
+        $this->subscribersResponseBuilder->build($subscriber),
         ['count' => 1]
       );
     } else {
@@ -461,10 +458,9 @@ class Subscribers extends APIEndpoint {
   }
 
   public function delete($data = []) {
-    $id = (isset($data['id']) ? (int)$data['id'] : false);
+    $subscriber = $this->getSubscriber($data);
-    $subscriber = Subscriber::findOne($id);
+    if ($subscriber instanceof SubscriberEntity) {
-    if ($subscriber instanceof Subscriber) {
+      $this->subscribersRepository->bulkDelete([$subscriber->getId()]);
-      $subscriber->delete();
       return $this->successResponse(null, ['count' => 1]);
     } else {
       return $this->errorResponse([
@@ -489,21 +485,46 @@ class Subscribers extends APIEndpoint {
   }
 
   public function bulkAction($data = []) {
-    try {
+    $definition = $this->listingHandler->getListingDefinition($data['listing']);
-      if (!isset($data['listing']['filter']['segment'])) {
+    $ids = $this->subscriberListingRepository->getActionableIds($definition);
-        return $this->successResponse(
+
-          null,
+    $count = 0;
-          $this->bulkActionController->apply('\MailPoet\Models\Subscriber', $data)
+    $segment = null;
-        );
+    if (isset($data['segment_id'])) {
-      } else {
+      $segment = $this->getSegment($data);
-        $bulkAction = new BulkAction($data);
+      if (!$segment) {
-        return $this->successResponse(null, $bulkAction->apply());
+        return $this->errorResponse([
+          APIError::NOT_FOUND => WPFunctions::get()->__('This segment does not exist.', 'mailpoet'),
+        ]);
       }
-    } catch (\Exception $e) {
-      return $this->errorResponse([
-        $e->getCode() => $e->getMessage(),
-      ]);
     }
+
+    if ($data['action'] === 'trash') {
+      $count = $this->subscribersRepository->bulkTrash($ids);
+    } elseif ($data['action'] === 'restore') {
+      $count = $this->subscribersRepository->bulkRestore($ids);
+    } elseif ($data['action'] === 'delete') {
+      $count = $this->subscribersRepository->bulkDelete($ids);
+    } elseif ($data['action'] === 'removeFromAllLists') {
+      $count = $this->subscribersRepository->bulkRemoveFromAllSegments($ids);
+    } elseif ($data['action'] === 'removeFromList' && $segment instanceof SegmentEntity) {
+      $count = $this->subscribersRepository->bulkRemoveFromSegment($segment, $ids);
+    } elseif ($data['action'] === 'addToList' && $segment instanceof SegmentEntity) {
+      $count = $this->subscribersRepository->bulkAddToSegment($segment, $ids);
+    } elseif ($data['action'] === 'moveToList' && $segment instanceof SegmentEntity) {
+      $count = $this->subscribersRepository->bulkMoveToSegment($segment, $ids);
+    } else {
+      throw UnexpectedValueException::create()
+        ->withErrors([APIError::BAD_REQUEST => "Invalid bulk action '{$data['action']}' provided."]);
+    }
+    $meta = [
+      'count' => $count,
+    ];
+
+    if ($segment) {
+      $meta['segment'] = $segment->getName();
+    }
+    return $this->successResponse(null, $meta);
   }
 
   /**
@@ -515,4 +536,10 @@ class Subscribers extends APIEndpoint {
       ? $this->subscribersRepository->findOneById((int)$data['id'])
       : null;
   }
+
+  private function getSegment(array $data): ?SegmentEntity {
+    return isset($data['segment_id'])
+      ? $this->segmentsRepository->findOneById((int)$data['segment_id'])
+      : null;
+  }
 }

lib/Subscribers/SubscribersRepository.php

@@ -3,7 +3,13 @@
 namespace MailPoet\Subscribers;
 
 use MailPoet\Doctrine\Repository;
+use MailPoet\Entities\SegmentEntity;
+use MailPoet\Entities\SubscriberCustomFieldEntity;
 use MailPoet\Entities\SubscriberEntity;
+use MailPoet\Entities\SubscriberSegmentEntity;
+use MailPoetVendor\Doctrine\DBAL\Connection;
+use MailPoetVendor\Doctrine\ORM\EntityManager;
+use MailPoetVendor\Doctrine\ORM\Query\Expr\Join;
 
 /**
  * @extends Repository<SubscriberEntity>
@@ -48,4 +54,147 @@ class SubscribersRepository extends Repository {
       ->getQuery();
     return (int)$query->getSingleScalarResult();
   }
+
+  /**
+   * @return int - number of processed ids
+   */
+  public function bulkTrash(array $ids): int {
+    if (empty($ids)) {
+      return 0;
+    }
+
+    $this->entityManager->createQueryBuilder()
+      ->update(SubscriberEntity::class, 's')
+      ->set('s.deletedAt', 'CURRENT_TIMESTAMP()')
+      ->where('s.id IN (:ids)')
+      ->setParameter('ids', $ids)
+      ->getQuery()->execute();
+
+    return count($ids);
+  }
+
+  /**
+   * @return int - number of processed ids
+   */
+  public function bulkRestore(array $ids): int {
+    if (empty($ids)) {
+      return 0;
+    }
+
+    $this->entityManager->createQueryBuilder()
+      ->update(SubscriberEntity::class, 's')
+      ->set('s.deletedAt', ':deletedAt')
+      ->where('s.id IN (:ids)')
+      ->setParameter('deletedAt', null)
+      ->setParameter('ids', $ids)
+      ->getQuery()->execute();
+
+    return count($ids);
+  }
+
+   /**
+   * @return int - number of processed ids
+   */
+  public function bulkDelete(array $ids): int {
+    if (empty($ids)) {
+      return 0;
+    }
+
+    $this->entityManager->transactional(function (EntityManager $entityManager) use ($ids) {
+      // Delete subscriber segments
+      $this->bulkRemoveFromAllSegments($ids);
+
+      // Delete subscriber custom fields
+      $subscriberCustomFieldTable = $entityManager->getClassMetadata(SubscriberCustomFieldEntity::class)->getTableName();
+      $entityManager->getConnection()->executeUpdate("
+         DELETE scs FROM $subscriberCustomFieldTable scs
+         WHERE scs.`subscriber_id` IN (:ids)
+      ", ['ids' => $ids], ['ids' => Connection::PARAM_INT_ARRAY]);
+
+      $queryBuilder = $entityManager->createQueryBuilder();
+      $queryBuilder->delete(SubscriberEntity::class, 's')
+        ->where('s.id IN (:ids)')
+        ->setParameter('ids', $ids)
+        ->getQuery()->execute();
+    });
+
+    return count($ids);
+  }
+
+  /**
+   * @return int - number of processed ids
+   */
+  public function bulkRemoveFromSegment(SegmentEntity $segment, array $ids): int {
+    if (empty($ids)) {
+      return 0;
+    }
+
+    $subscriberSegmentsTable = $this->entityManager->getClassMetadata(SubscriberSegmentEntity::class)->getTableName();
+    $count = $this->entityManager->getConnection()->executeUpdate("
+       DELETE ss FROM $subscriberSegmentsTable ss
+       WHERE ss.`subscriber_id` IN (:ids)
+       AND ss.`segment_id` = :segment_id
+    ", ['ids' => $ids, 'segment_id' => $segment->getId()], ['ids' => Connection::PARAM_INT_ARRAY]);
+
+    return $count;
+  }
+
+  /**
+   * @return int - number of processed ids
+   */
+  public function bulkRemoveFromAllSegments(array $ids): int {
+    if (empty($ids)) {
+      return 0;
+    }
+
+    $subscriberSegmentsTable = $this->entityManager->getClassMetadata(SubscriberSegmentEntity::class)->getTableName();
+    $count = $this->entityManager->getConnection()->executeUpdate("
+       DELETE ss FROM $subscriberSegmentsTable ss
+       WHERE ss.`subscriber_id` IN (:ids)
+    ", ['ids' => $ids], ['ids' => Connection::PARAM_INT_ARRAY]);
+
+    return $count;
+  }
+
+  /**
+   * @return int - number of processed ids
+   */
+  public function bulkAddToSegment(SegmentEntity $segment, array $ids): int {
+    if (empty($ids)) {
+      return 0;
+    }
+
+    $subscribers = $this->entityManager
+      ->createQueryBuilder()
+      ->select('s')
+      ->from(SubscriberEntity::class, 's')
+      ->leftJoin('s.subscriberSegments', 'ss', Join::WITH, 'ss.segment = :segment')
+      ->where('s.id IN (:ids)')
+      ->andWhere('ss.segment IS NULL')
+      ->setParameter('ids', $ids)
+      ->setParameter('segment', $segment)
+      ->getQuery()->execute();
+    
+    $this->entityManager->transactional(function (EntityManager $entityManager) use ($subscribers, $segment) {
+      foreach ($subscribers as $subscriber) {
+        $subscriberSegment = new SubscriberSegmentEntity($segment, $subscriber, SubscriberEntity::STATUS_SUBSCRIBED);
+        $this->entityManager->persist($subscriberSegment);
+      }
+      $this->entityManager->flush();
+    });
+
+    return count($subscribers);
+  }
+
+   /**
+   * @return int - number of processed ids
+   */
+  public function bulkMoveToSegment(SegmentEntity $segment, array $ids): int {
+    if (empty($ids)) {
+      return 0;
+    }
+
+    $this->bulkRemoveFromAllSegments($ids);
+    return $this->bulkAddToSegment($segment, $ids);
+  } 
 }