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
BulkConfirmationEmailResender.php
210 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Subscribers; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Cron\Workers\BulkConfirmationEmailResend; |
| 9 | use MailPoet\Entities\LogEntity; |
| 10 | use MailPoet\Entities\ScheduledTaskEntity; |
| 11 | use MailPoet\Entities\ScheduledTaskSubscriberEntity; |
| 12 | use MailPoet\Entities\SubscriberEntity; |
| 13 | use MailPoet\Listing\ListingDefinition; |
| 14 | use MailPoet\Logging\LoggerFactory; |
| 15 | use MailPoet\Logging\LogRepository; |
| 16 | use MailPoet\Settings\SettingsController; |
| 17 | use MailPoet\Util\Helpers; |
| 18 | use MailPoet\WP\Functions as WPFunctions; |
| 19 | use MailPoetVendor\Carbon\Carbon; |
| 20 | use MailPoetVendor\Doctrine\ORM\EntityManager; |
| 21 | |
| 22 | class BulkConfirmationEmailResender { |
| 23 | public const BULK_CONFIRMATION_RESEND_LIMIT = 20; |
| 24 | public const RECENT_CONFIRMATION_RESEND_INTERVAL_DAYS = 7; |
| 25 | public const BULK_CONFIRMATION_MAX_SUBSCRIBER_AGE_DAYS = 90; |
| 26 | |
| 27 | private const AUDIT_LOG_MESSAGE_QUEUED = 'Bulk confirmation email resend queued.'; |
| 28 | private const LOG_LEVEL_INFO = 200; |
| 29 | |
| 30 | /** @var WPFunctions */ |
| 31 | private $wp; |
| 32 | |
| 33 | /** @var SettingsController */ |
| 34 | private $settings; |
| 35 | |
| 36 | /** @var SubscriberListingRepository */ |
| 37 | private $subscriberListingRepository; |
| 38 | |
| 39 | /** @var LogRepository */ |
| 40 | private $logRepository; |
| 41 | |
| 42 | /** @var EntityManager */ |
| 43 | private $entityManager; |
| 44 | |
| 45 | public function __construct( |
| 46 | WPFunctions $wp, |
| 47 | SettingsController $settings, |
| 48 | SubscriberListingRepository $subscriberListingRepository, |
| 49 | LogRepository $logRepository, |
| 50 | EntityManager $entityManager |
| 51 | ) { |
| 52 | $this->wp = $wp; |
| 53 | $this->settings = $settings; |
| 54 | $this->subscriberListingRepository = $subscriberListingRepository; |
| 55 | $this->logRepository = $logRepository; |
| 56 | $this->entityManager = $entityManager; |
| 57 | } |
| 58 | |
| 59 | public function canCurrentUserResend(): bool { |
| 60 | return $this->wp->currentUserCan('manage_options'); |
| 61 | } |
| 62 | |
| 63 | public function isSignupConfirmationEnabled(): bool { |
| 64 | return (bool)$this->settings->get('signup_confirmation.enabled', true); |
| 65 | } |
| 66 | |
| 67 | public function getConfirmationDisabledMessage(): string { |
| 68 | $errorMessage = __('Sign-up confirmation is disabled in your [link]MailPoet settings[/link]. Please enable it to resend confirmation emails or update your subscriber’s status manually.', 'mailpoet'); |
| 69 | return Helpers::replaceLinkTags($errorMessage, 'admin.php?page=mailpoet-settings#/signup'); |
| 70 | } |
| 71 | |
| 72 | /** |
| 73 | * @param array<string, mixed> $requestData |
| 74 | * @return array{selected_count: int, eligible_count: int, queued_count: int, skipped_count: int, skipped_by_reason: array<string, int>, task_id: int|null, message: string} |
| 75 | */ |
| 76 | public function queue(ListingDefinition $definition, array $requestData): array { |
| 77 | $now = Carbon::now()->millisecond(0); |
| 78 | $queueData = $this->subscriberListingRepository->getConfirmationEmailResendQueueData( |
| 79 | $definition, |
| 80 | (clone $now)->subDays(self::RECENT_CONFIRMATION_RESEND_INTERVAL_DAYS), |
| 81 | (clone $now)->subDays(self::BULK_CONFIRMATION_MAX_SUBSCRIBER_AGE_DAYS), |
| 82 | ConfirmationEmailMailer::MAX_CONFIRMATION_EMAILS, |
| 83 | self::BULK_CONFIRMATION_RESEND_LIMIT, |
| 84 | $this->hasExplicitSelection($requestData) |
| 85 | ); |
| 86 | |
| 87 | $queuedIds = $queueData['queued_ids']; |
| 88 | $task = null; |
| 89 | if ($queuedIds) { |
| 90 | $task = $this->createTask($queuedIds, $queueData, $requestData, $now); |
| 91 | } else { |
| 92 | $this->saveQueueAuditLog(null, $queueData, $requestData); |
| 93 | } |
| 94 | |
| 95 | $queuedCount = count($queuedIds); |
| 96 | return [ |
| 97 | 'selected_count' => $queueData['selected_count'], |
| 98 | 'eligible_count' => $queueData['eligible_count'], |
| 99 | 'queued_count' => $queuedCount, |
| 100 | 'skipped_count' => max(0, $queueData['selected_count'] - $queuedCount), |
| 101 | 'skipped_by_reason' => $queueData['skipped_by_reason'], |
| 102 | 'task_id' => $task instanceof ScheduledTaskEntity ? $task->getId() : null, |
| 103 | 'message' => $queuedCount > 0 |
| 104 | ? __('Confirmation emails are being resent.', 'mailpoet') |
| 105 | : __( |
| 106 | 'No confirmation emails were resent. The selected subscribers could not receive another confirmation email right now.', |
| 107 | 'mailpoet' |
| 108 | ), |
| 109 | ]; |
| 110 | } |
| 111 | |
| 112 | /** |
| 113 | * @param int[] $queuedIds |
| 114 | * @param array{selected_count: int, eligible_count: int, queued_ids: int[], skipped_by_reason: array<string, int>} $queueData |
| 115 | * @param array<string, mixed> $requestData |
| 116 | */ |
| 117 | private function createTask(array $queuedIds, array $queueData, array $requestData, Carbon $now): ScheduledTaskEntity { |
| 118 | $task = new ScheduledTaskEntity(); |
| 119 | $this->entityManager->transactional(function (EntityManager $entityManager) use ($task, $queuedIds, $queueData, $requestData, $now) { |
| 120 | $task->setType(BulkConfirmationEmailResend::TASK_TYPE); |
| 121 | $task->setStatus(ScheduledTaskEntity::STATUS_SCHEDULED); |
| 122 | $task->setScheduledAt($now); |
| 123 | $task->setPriority(ScheduledTaskEntity::PRIORITY_HIGH); |
| 124 | $task->setMeta([ |
| 125 | 'requested_by' => (int)$this->wp->getCurrentUserId(), |
| 126 | 'selected_count' => $queueData['selected_count'], |
| 127 | 'eligible_count' => $queueData['eligible_count'], |
| 128 | 'queued_count' => count($queuedIds), |
| 129 | 'skipped_by_reason' => $queueData['skipped_by_reason'], |
| 130 | 'constants' => $this->getAuditConstants(), |
| 131 | 'request' => $this->getRequestSummary($requestData), |
| 132 | ]); |
| 133 | $entityManager->persist($task); |
| 134 | |
| 135 | foreach ($queuedIds as $subscriberId) { |
| 136 | /** @var SubscriberEntity $subscriberReference */ |
| 137 | $subscriberReference = $entityManager->getReference(SubscriberEntity::class, $subscriberId); |
| 138 | $entityManager->persist(new ScheduledTaskSubscriberEntity( |
| 139 | $task, |
| 140 | $subscriberReference |
| 141 | )); |
| 142 | } |
| 143 | |
| 144 | $entityManager->flush(); |
| 145 | $this->saveQueueAuditLog($task, $queueData, $requestData); |
| 146 | }); |
| 147 | |
| 148 | return $task; |
| 149 | } |
| 150 | |
| 151 | /** |
| 152 | * @param array{selected_count: int, eligible_count: int, queued_ids: int[], skipped_by_reason: array<string, int>} $queueData |
| 153 | * @param array<string, mixed> $requestData |
| 154 | */ |
| 155 | private function saveQueueAuditLog(?ScheduledTaskEntity $task, array $queueData, array $requestData): void { |
| 156 | $log = new LogEntity(); |
| 157 | $log->setName(LoggerFactory::TOPIC_API); |
| 158 | $log->setLevel(self::LOG_LEVEL_INFO); |
| 159 | $log->setMessage(self::AUDIT_LOG_MESSAGE_QUEUED); |
| 160 | $log->setRawMessage(self::AUDIT_LOG_MESSAGE_QUEUED); |
| 161 | $log->setContext([ |
| 162 | 'action' => 'bulk_confirmation_email_resend_queued', |
| 163 | 'requested_by' => (int)$this->wp->getCurrentUserId(), |
| 164 | 'task_id' => $task instanceof ScheduledTaskEntity ? $task->getId() : null, |
| 165 | 'selected_count' => $queueData['selected_count'], |
| 166 | 'eligible_count' => $queueData['eligible_count'], |
| 167 | 'queued_count' => count($queueData['queued_ids']), |
| 168 | 'skipped_by_reason' => $queueData['skipped_by_reason'], |
| 169 | 'constants' => $this->getAuditConstants(), |
| 170 | 'request' => $this->getRequestSummary($requestData), |
| 171 | ]); |
| 172 | $this->logRepository->saveLog($log); |
| 173 | } |
| 174 | |
| 175 | /** |
| 176 | * @return array<string, int> |
| 177 | */ |
| 178 | private function getAuditConstants(): array { |
| 179 | return [ |
| 180 | 'bulk_confirmation_resend_limit' => self::BULK_CONFIRMATION_RESEND_LIMIT, |
| 181 | 'recent_confirmation_resend_interval_days' => self::RECENT_CONFIRMATION_RESEND_INTERVAL_DAYS, |
| 182 | 'bulk_confirmation_max_subscriber_age_days' => self::BULK_CONFIRMATION_MAX_SUBSCRIBER_AGE_DAYS, |
| 183 | 'max_confirmation_emails' => ConfirmationEmailMailer::MAX_CONFIRMATION_EMAILS, |
| 184 | ]; |
| 185 | } |
| 186 | |
| 187 | /** |
| 188 | * @param array<string, mixed> $requestData |
| 189 | * @return array<string, mixed> |
| 190 | */ |
| 191 | private function getRequestSummary(array $requestData): array { |
| 192 | $listing = isset($requestData['listing']) && is_array($requestData['listing']) ? $requestData['listing'] : []; |
| 193 | return [ |
| 194 | 'group' => $listing['group'] ?? null, |
| 195 | 'has_selection' => !empty($listing['selection']), |
| 196 | 'selection_count' => isset($listing['selection']) && is_array($listing['selection']) ? count($listing['selection']) : 0, |
| 197 | 'has_search' => !empty($listing['search']), |
| 198 | 'filter_keys' => isset($listing['filter']) && is_array($listing['filter']) ? array_keys($listing['filter']) : [], |
| 199 | ]; |
| 200 | } |
| 201 | |
| 202 | /** |
| 203 | * @param array<string, mixed> $requestData |
| 204 | */ |
| 205 | private function hasExplicitSelection(array $requestData): bool { |
| 206 | $listing = isset($requestData['listing']) && is_array($requestData['listing']) ? $requestData['listing'] : []; |
| 207 | return array_key_exists('selection', $listing); |
| 208 | } |
| 209 | } |
| 210 |