ConfirmationEmailTemplate
1 month ago
ImportExport
2 weeks ago
RestApi
3 days ago
Statistics
1 month ago
BulkActionController.php
3 days ago
BulkActionException.php
1 month ago
BulkConfirmationEmailResender.php
2 months ago
ConfirmationEmailCustomizer.php
2 months ago
ConfirmationEmailMailer.php
2 months ago
ConfirmationEmailResolver.php
2 months ago
EngagementDataBackfiller.php
2 months ago
InactiveSubscribersController.php
4 days ago
LinkTokens.php
2 months ago
NewSubscriberNotificationMailer.php
2 months ago
RequiredCustomFieldValidator.php
2 months ago
SegmentsCountRecalculator.php
2 weeks ago
Source.php
2 months ago
SubscriberActions.php
2 months ago
SubscriberCustomFieldRepository.php
3 years ago
SubscriberIPsRepository.php
2 years ago
SubscriberLimitNotificationEvaluator.php
2 months ago
SubscriberLimitNotificationMailer.php
2 months ago
SubscriberLimitNotificationScheduler.php
2 months ago
SubscriberListingRepository.php
2 weeks ago
SubscriberPersonalDataEraser.php
2 months ago
SubscriberSaveController.php
3 days ago
SubscriberSegmentRepository.php
2 weeks ago
SubscriberSubscribeController.php
2 weeks ago
SubscriberTagRepository.php
4 years ago
SubscribersCountsController.php
2 weeks ago
SubscribersEmailCountsController.php
2 weeks ago
SubscribersRepository.php
3 days ago
TrackingConsentController.php
4 days ago
index.php
3 years ago
SubscriberActions.php
168 lines
| 1 | <?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing |
| 2 | |
| 3 | namespace MailPoet\Subscribers; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Entities\SubscriberEntity; |
| 9 | use MailPoet\Newsletter\Scheduler\WelcomeScheduler; |
| 10 | use MailPoet\Segments\SegmentsRepository; |
| 11 | use MailPoet\Settings\SettingsController; |
| 12 | use MailPoet\Subscribers\ConfirmationEmailResolver; |
| 13 | use MailPoet\Util\Helpers; |
| 14 | use MailPoetVendor\Carbon\Carbon; |
| 15 | |
| 16 | class SubscriberActions { |
| 17 | /** @var SettingsController */ |
| 18 | private $settings; |
| 19 | |
| 20 | /** @var NewSubscriberNotificationMailer */ |
| 21 | private $newSubscriberNotificationMailer; |
| 22 | |
| 23 | /** @var ConfirmationEmailMailer */ |
| 24 | private $confirmationEmailMailer; |
| 25 | |
| 26 | /** @var WelcomeScheduler */ |
| 27 | private $welcomeScheduler; |
| 28 | |
| 29 | /** @var SubscriberSaveController */ |
| 30 | private $subscriberSaveController; |
| 31 | |
| 32 | /** @var SubscribersRepository */ |
| 33 | private $subscribersRepository; |
| 34 | |
| 35 | /** @var SubscriberSegmentRepository */ |
| 36 | private $subscriberSegmentRepository; |
| 37 | |
| 38 | /** @var SegmentsRepository */ |
| 39 | private $segmentsRepository; |
| 40 | |
| 41 | /** @var ConfirmationEmailResolver */ |
| 42 | private $confirmationEmailResolver; |
| 43 | |
| 44 | public function __construct( |
| 45 | SettingsController $settings, |
| 46 | NewSubscriberNotificationMailer $newSubscriberNotificationMailer, |
| 47 | ConfirmationEmailMailer $confirmationEmailMailer, |
| 48 | WelcomeScheduler $welcomeScheduler, |
| 49 | SegmentsRepository $segmentsRepository, |
| 50 | SubscriberSaveController $subscriberSaveController, |
| 51 | SubscribersRepository $subscribersRepository, |
| 52 | SubscriberSegmentRepository $subscriberSegmentRepository, |
| 53 | ConfirmationEmailResolver $confirmationEmailResolver |
| 54 | ) { |
| 55 | $this->settings = $settings; |
| 56 | $this->newSubscriberNotificationMailer = $newSubscriberNotificationMailer; |
| 57 | $this->confirmationEmailMailer = $confirmationEmailMailer; |
| 58 | $this->welcomeScheduler = $welcomeScheduler; |
| 59 | $this->subscriberSaveController = $subscriberSaveController; |
| 60 | $this->subscribersRepository = $subscribersRepository; |
| 61 | $this->subscriberSegmentRepository = $subscriberSegmentRepository; |
| 62 | $this->segmentsRepository = $segmentsRepository; |
| 63 | $this->confirmationEmailResolver = $confirmationEmailResolver; |
| 64 | } |
| 65 | |
| 66 | /** |
| 67 | * Returns SubscriberEntity and associative array with some metadata related to the subscription (e.g. ['confirmationEmailResult' => $exception]) |
| 68 | * @param array $subscriberData Subscriber data (email, first_name, last_name, etc.) |
| 69 | * @param array $segmentIds IDs of segments to subscribe to |
| 70 | * @return array{0: SubscriberEntity, 1: array{confirmationEmailResult: bool|\Exception, error?: string}} |
| 71 | */ |
| 72 | public function subscribe($subscriberData = [], $segmentIds = []): array { |
| 73 | // filter out keys from the subscriber_data array |
| 74 | // that should not be editable when subscribing |
| 75 | $subscriberData = $this->subscriberSaveController->filterOutReservedColumns($subscriberData); |
| 76 | |
| 77 | $signupConfirmationEnabled = (bool)$this->settings->get( |
| 78 | 'signup_confirmation.enabled' |
| 79 | ); |
| 80 | |
| 81 | $subscriberData['subscribed_ip'] = Helpers::getIP(); |
| 82 | |
| 83 | $subscriber = $this->subscribersRepository->findOneBy(['email' => $subscriberData['email']]); |
| 84 | $previousStatus = $subscriber instanceof SubscriberEntity ? $subscriber->getStatus() : null; |
| 85 | $wasAlreadySubscribed = $previousStatus === SubscriberEntity::STATUS_SUBSCRIBED; |
| 86 | $isUnconfirmedResubscription = ( |
| 87 | $subscriber instanceof SubscriberEntity |
| 88 | && $subscriber->getStatus() === SubscriberEntity::STATUS_UNCONFIRMED |
| 89 | ); |
| 90 | if (!$subscriber && !isset($subscriberData['source'])) { |
| 91 | $subscriberData['source'] = Source::FORM; |
| 92 | } |
| 93 | |
| 94 | if (!$subscriber || !$signupConfirmationEnabled) { |
| 95 | // create new subscriber or update if no confirmation is required |
| 96 | $subscriber = $this->subscriberSaveController->createOrUpdate($subscriberData, $subscriber); |
| 97 | // custom fields should use the same approach as the subscriber main data that means to wait on confirmation |
| 98 | $this->subscriberSaveController->updateCustomFields($subscriberData, $subscriber); |
| 99 | } else if ($wasAlreadySubscribed) { |
| 100 | $subscriber->setUnconfirmedData(null); |
| 101 | } else { |
| 102 | // store subscriber data to be updated after confirmation |
| 103 | $unconfirmedData = $this->subscriberSaveController->filterOutReservedColumns($subscriberData); |
| 104 | $unconfirmedData = json_encode($unconfirmedData); |
| 105 | $subscriber->setUnconfirmedData($unconfirmedData ?: null); |
| 106 | } |
| 107 | |
| 108 | // restore trashed subscriber |
| 109 | if ($subscriber->getDeletedAt()) { |
| 110 | $subscriber->setDeletedAt(null); |
| 111 | } |
| 112 | |
| 113 | // set status depending on signup confirmation setting |
| 114 | if ($subscriber->getStatus() !== SubscriberEntity::STATUS_SUBSCRIBED) { |
| 115 | if ($signupConfirmationEnabled === true) { |
| 116 | $subscriber->setStatus(SubscriberEntity::STATUS_UNCONFIRMED); |
| 117 | if ($previousStatus !== SubscriberEntity::STATUS_UNCONFIRMED) { |
| 118 | $subscriber->setConfirmationsCount(0); |
| 119 | $subscriber->setLastConfirmationEmailSentAt(null); |
| 120 | $subscriber->setLastSubscribedAt(Carbon::now()->millisecond(0)); |
| 121 | } |
| 122 | } else { |
| 123 | $subscriber->setStatus(SubscriberEntity::STATUS_SUBSCRIBED); |
| 124 | } |
| 125 | } |
| 126 | |
| 127 | $this->subscribersRepository->flush(); |
| 128 | |
| 129 | $metaData = ['confirmationEmailResult' => false]; |
| 130 | // link subscriber to segments |
| 131 | $segments = $this->segmentsRepository->findByIds($segmentIds); |
| 132 | $this->subscriberSegmentRepository->subscribeToSegments($subscriber, $segments); |
| 133 | |
| 134 | // resolve confirmation settings from segment-level overrides |
| 135 | [$confirmationEmailId, $confirmationPageId] = $this->confirmationEmailResolver->resolveFromSegments($segments); |
| 136 | |
| 137 | try { |
| 138 | if ( |
| 139 | $signupConfirmationEnabled |
| 140 | && $isUnconfirmedResubscription |
| 141 | && $subscriber->getConfirmationsCount() >= ConfirmationEmailMailer::MAX_CONFIRMATION_EMAILS |
| 142 | ) { |
| 143 | $metaData['error'] = $this->getMaxConfirmationEmailsReachedError(); |
| 144 | } else if (!$wasAlreadySubscribed) { |
| 145 | $metaData['confirmationEmailResult'] = $this->confirmationEmailMailer->sendConfirmationEmailOnce($subscriber, $confirmationEmailId, $confirmationPageId, true); |
| 146 | } |
| 147 | } catch (\Exception $e) { |
| 148 | $metaData['confirmationEmailResult'] = $e; |
| 149 | } |
| 150 | |
| 151 | // We want to send the notification on subscribe only when signupConfirmation is disabled |
| 152 | if ($signupConfirmationEnabled === false && $subscriber->getStatus() === SubscriberEntity::STATUS_SUBSCRIBED) { |
| 153 | $this->newSubscriberNotificationMailer->send($subscriber, $this->segmentsRepository->findByIds($segmentIds)); |
| 154 | |
| 155 | $this->welcomeScheduler->scheduleSubscriberWelcomeNotification( |
| 156 | $subscriber->getId(), |
| 157 | $segmentIds |
| 158 | ); |
| 159 | } |
| 160 | |
| 161 | return [$subscriber, $metaData]; |
| 162 | } |
| 163 | |
| 164 | private function getMaxConfirmationEmailsReachedError(): string { |
| 165 | return __('We\'ve already sent you a confirmation email. Please check your inbox or spam folder.', 'mailpoet'); |
| 166 | } |
| 167 | } |
| 168 |