Create SubscriberSaveController

[MAILPOET-3031]

lib/DI/ContainerConfigurator.php

@@ -246,6 +246,7 @@ class ContainerConfigurator implements IContainerConfigurator {
     $container->autowire(\MailPoet\Subscribers\SubscriberListingRepository::class)->setPublic(true);
     $container->autowire(\MailPoet\Subscribers\SubscriberSegmentRepository::class)->setPublic(true);
     $container->autowire(\MailPoet\Subscribers\SubscriberCustomFieldRepository::class)->setPublic(true);
+    $container->autowire(\MailPoet\Subscribers\SubscriberSaveController::class)->setPublic(true);
     $container->autowire(\MailPoet\Subscribers\ImportExport\ImportExportRepository::class)->setPublic(true);
     $container->autowire(\MailPoet\Subscribers\Statistics\SubscriberStatisticsRepository::class);
     // Segments

lib/Subscribers/SubscriberSaveController.php

@@ -0,0 +1,218 @@
+<?php
+
+namespace MailPoet\Subscribers;
+
+use MailPoet\CustomFields\CustomFieldsRepository;
+use MailPoet\Entities\StatisticsUnsubscribeEntity;
+use MailPoet\Entities\SubscriberEntity;
+use MailPoet\Entities\SubscriberSegmentEntity;
+use MailPoet\Newsletter\Scheduler\WelcomeScheduler;
+use MailPoet\Segments\SegmentsRepository;
+use MailPoet\Settings\SettingsController;
+use MailPoet\Statistics\Track\Unsubscribes;
+use MailPoet\Util\Security;
+use MailPoet\WP\Functions as WPFunctions;
+
+class SubscriberSaveController {
+  /** @var CustomFieldsRepository */
+  private $customFieldsRepository;
+
+  /** @var Security */
+  private $security;
+
+  /** @var SettingsController */
+  private $settings;
+
+  /** @var SegmentsRepository */
+  private $segmentsRepository;
+
+  /** @var SubscriberCustomFieldRepository */
+  private $subscriberCustomFieldRepository;
+
+  /** @var SubscribersRepository */
+  private $subscribersRepository;
+
+  /** @var SubscriberSegmentRepository */
+  private $subscriberSegmentRepository;
+
+  /** @var Unsubscribes */
+  private $unsubscribesTracker;
+
+  /** @var WelcomeScheduler */
+  private $welcomeScheduler;
+
+  /** @var WPFunctions */
+  private $wp;
+
+  public function __construct(
+    CustomFieldsRepository $customFieldsRepository,
+    Security $security,
+    SettingsController $settings,
+    SegmentsRepository $segmentsRepository,
+    SubscriberCustomFieldRepository $subscriberCustomFieldRepository,
+    SubscribersRepository $subscribersRepository,
+    SubscriberSegmentRepository $subscriberSegmentRepository,
+    Unsubscribes $unsubscribesTracker,
+    WelcomeScheduler $welcomeScheduler,
+    WPFunctions $wp
+  ) {
+    $this->customFieldsRepository = $customFieldsRepository;
+    $this->security = $security;
+    $this->settings = $settings;
+    $this->segmentsRepository = $segmentsRepository;
+    $this->subscriberSegmentRepository = $subscriberSegmentRepository;
+    $this->subscribersRepository = $subscribersRepository;
+    $this->subscriberCustomFieldRepository = $subscriberCustomFieldRepository;
+    $this->unsubscribesTracker = $unsubscribesTracker;
+    $this->welcomeScheduler = $welcomeScheduler;
+    $this->wp = $wp;
+  }
+
+  public function save(array $data): SubscriberEntity {
+    if (is_array($data) && !empty($data)) {
+      $data = WPFunctions::get()->stripslashesDeep($data);
+    }
+
+    if (empty($data['segments'])) {
+      $data['segments'] = [];
+    }
+    $data['segments'] = array_merge($data['segments'], $this->getNonDefaultSubscribedSegments($data));
+    $newSegments = $this->findNewSegments($data);
+
+    $oldSubscriber = $this->findSubscriber($data);
+    $oldStatus = $oldSubscriber ? $oldSubscriber->getStatus() : null;
+    if (
+      $oldSubscriber instanceof SubscriberEntity
+      && isset($data['status'])
+      && ($data['status'] === SubscriberEntity::STATUS_UNSUBSCRIBED)
+      && ($oldSubscriber->getStatus() !== SubscriberEntity::STATUS_UNSUBSCRIBED)
+    ) {
+      $currentUser = $this->wp->wpGetCurrentUser();
+      $this->unsubscribesTracker->track(
+        (int)$oldSubscriber->getId(),
+        StatisticsUnsubscribeEntity::SOURCE_ADMINISTRATOR,
+        null,
+        $currentUser->display_name // phpcs:ignore Squiz.NamingConventions.ValidVariableName.NotCamelCaps
+      );
+    }
+
+    $subscriber = $this->createOrUpdate($data, $oldSubscriber);
+
+    $this->updateCustomFields($data, $subscriber);
+
+    $segments = isset($data['segments']) ? $this->findSegments($data['segments']) : null;
+    // check for status change
+    if (
+      $oldStatus === SubscriberEntity::STATUS_SUBSCRIBED
+      && $subscriber->getStatus() === SubscriberEntity::STATUS_UNSUBSCRIBED
+    ) {
+      // make sure we unsubscribe the user from all segments
+      $this->subscriberSegmentRepository->unsubscribeFromSegments($subscriber);
+    } elseif ($segments !== null) {
+      $this->subscriberSegmentRepository->resetSubscriptions($subscriber, $segments);
+    }
+
+    if (!empty($newSegments)) {
+      $this->welcomeScheduler->scheduleSubscriberWelcomeNotification($subscriber->getId(), $newSegments);
+    }
+
+    return $subscriber;
+  }
+
+  private function getNonDefaultSubscribedSegments(array $data): array {
+    if (!isset($data['id']) || (int)$data['id'] <= 0) {
+      return [];
+    }
+
+    $subscribedSegments = $this->subscriberSegmentRepository->getNonDefaultSubscribedSegments($data['id']);
+    return array_filter(array_map(function(SubscriberSegmentEntity $subscriberSegment): int {
+      $segment = $subscriberSegment->getSegment();
+      if (!$segment) {
+        return 0;
+      }
+      return (int)$segment->getId();
+    }, $subscribedSegments));
+  }
+
+  private function findSegments(array $segmentIds): array {
+    return $this->segmentsRepository->findBy(['id' => $segmentIds]);
+  }
+
+  private function findNewSegments(array $data): array {
+    $oldSegmentIds = [];
+    if (isset($data['id']) && (int)$data['id'] > 0) {
+      $subscribersSegments = $this->subscriberSegmentRepository->findBy(['subscriber' => $data['id']]);
+      foreach ($subscribersSegments as $subscribersSegment) {
+        $segment = $subscribersSegment->getSegment();
+        if (!$segment) {
+          continue;
+        }
+        $oldSegmentIds[] = (int)$segment->getId();
+      }
+    }
+
+    return array_diff($data['segments'], $oldSegmentIds);
+  }
+
+  private function createOrUpdate(array $data, ?SubscriberEntity $subscriber): SubscriberEntity {
+    if (!$subscriber) {
+      $subscriber = $this->createSubscriber();
+      if (!isset($data['source'])) $data['source'] = Source::ADMINISTRATOR;
+    }
+
+    if (isset($data['email'])) $subscriber->setEmail($data['email']);
+    if (isset($data['first_name'])) $subscriber->setFirstName($data['first_name']);
+    if (isset($data['last_name'])) $subscriber->setLastName($data['last_name']);
+    if (isset($data['status'])) $subscriber->setStatus($data['status']);
+    if (isset($data['source'])) $subscriber->setSource($data['source']);
+
+    $this->subscribersRepository->persist($subscriber);
+    $this->subscribersRepository->flush();
+
+    return $subscriber;
+  }
+
+  private function createSubscriber(): SubscriberEntity {
+    $subscriber = new SubscriberEntity();
+    $subscriber->setUnsubscribeToken($this->security->generateUnsubscribeTokenByEntity($subscriber));
+    $subscriber->setLinkToken(Security::generateHash(SubscriberEntity::LINK_TOKEN_LENGTH));
+    $subscriber->setStatus($this->settings->get('signup_confirmation.enabled') ? SubscriberEntity::STATUS_SUBSCRIBED : SubscriberEntity::STATUS_UNCONFIRMED);
+
+    return $subscriber;
+  }
+
+  private function findSubscriber(array &$data): ?SubscriberEntity {
+    $subscriber = null;
+    if (isset($data['id']) && (int)$data['id'] > 0) {
+      $subscriber = $this->subscribersRepository->findOneById(((int)$data['id']));
+      unset($data['id']);
+    }
+
+    if (!$subscriber && !empty($data['email'])) {
+      $subscriber = $this->subscribersRepository->findOneBy(['email' => $data['email']]);
+      if ($subscriber) {
+        unset($data['email']);
+      }
+    }
+
+    return $subscriber;
+  }
+
+  private function updateCustomFields(array $data, SubscriberEntity $subscriber): void {
+    $customFieldsMap = [];
+    foreach ($data as $key => $value) {
+      if (strpos($key, 'cf_') === 0) {
+        $customFieldsMap[(int)substr($key, 3)] = $value;
+      }
+    }
+
+    if (empty($customFieldsMap)) {
+      return;
+    }
+
+    $customFields = $this->customFieldsRepository->findBy(['id' => array_keys($customFieldsMap)]);
+    foreach ($customFields as $customField) {
+      $this->subscriberCustomFieldRepository->createOrUpdate($subscriber, $customField, $customFieldsMap[$customField->getId()]);
+    }
+  }
+}