Automations
1 year ago
KeyCheck
2 years ago
SendingQueue
3 months ago
StatsNotifications
3 months ago
AuthorizedSendingEmailsCheck.php
3 years ago
BackfillEngagementData.php
2 years ago
Bounce.php
2 months ago
BounceTaskSubscribersCleanup.php
2 months ago
BulkConfirmationEmailResend.php
4 months ago
ExportFilesCleanup.php
3 months ago
InactiveSubscribersMaintenance.php
2 months ago
LogCleanup.php
11 months ago
Mixpanel.php
11 months ago
NewsletterTemplateThumbnails.php
2 years ago
ReEngagementEmailsScheduler.php
2 years ago
Scheduler.php
3 months ago
SendingQueueBodyCleanup.php
4 months ago
SendingTaskSubscribersCleanup.php
4 months ago
SimpleWorker.php
2 years ago
StatisticsExport.php
4 months ago
SubscriberLimitNotificationWorker.php
3 months ago
SubscriberLinkTokens.php
2 years ago
SubscribersCountCacheRecalculation.php
2 months ago
SubscribersEngagementScore.php
2 years ago
SubscribersLastEngagement.php
4 months ago
SubscribersSegmentsCountSync.php
2 months ago
SubscribersStatsReport.php
2 years ago
Tracks.php
11 months ago
UnconfirmedSubscribersCleanup.php
4 months ago
UnsubscribeTokens.php
2 months ago
WooCommercePastOrders.php
2 years ago
WooCommerceSync.php
3 years ago
WorkersFactory.php
2 months ago
index.php
3 years ago
Bounce.php
244 lines
| 1 | <?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing |
| 2 | |
| 3 | namespace MailPoet\Cron\Workers; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Entities\NewsletterEntity; |
| 9 | use MailPoet\Entities\ScheduledTaskEntity; |
| 10 | use MailPoet\Entities\StatisticsBounceEntity; |
| 11 | use MailPoet\Entities\SubscriberEntity; |
| 12 | use MailPoet\Mailer\Mailer; |
| 13 | use MailPoet\Newsletter\Sending\SendingQueuesRepository; |
| 14 | use MailPoet\Services\Bridge; |
| 15 | use MailPoet\Services\Bridge\API; |
| 16 | use MailPoet\Settings\SettingsController; |
| 17 | use MailPoet\Statistics\StatisticsBouncesRepository; |
| 18 | use MailPoet\Subscribers\SubscribersRepository; |
| 19 | use MailPoetVendor\Carbon\Carbon; |
| 20 | |
| 21 | class Bounce extends SimpleWorker { |
| 22 | const TASK_TYPE = 'bounce'; |
| 23 | const SUPPORT_MULTIPLE_INSTANCES = false; |
| 24 | |
| 25 | // The sending service never reports bounces older than this. Requests with a |
| 26 | // `from` further back are rejected, so the range is clamped to stay within it. |
| 27 | const MAX_LOOKBACK_DAYS = 14; |
| 28 | |
| 29 | // Stores the `to` of the last fully-processed report so the next daily run |
| 30 | // starts its range exactly there, giving gap-free coverage without querying |
| 31 | // previous tasks. |
| 32 | const LAST_REPORT_TO_SETTING_KEY = 'bounce.last_report_to'; |
| 33 | |
| 34 | // Keys under which the in-progress report range and pagination cursor are |
| 35 | // persisted on the task meta, so a run that hits the execution limit resumes |
| 36 | // the same range from the next page instead of restarting at page 1. |
| 37 | const META_FROM = 'report_from'; |
| 38 | const META_TO = 'report_to'; |
| 39 | const META_PAGE = 'report_page'; |
| 40 | |
| 41 | public $api; |
| 42 | |
| 43 | /** @var SettingsController */ |
| 44 | private $settings; |
| 45 | |
| 46 | /** @var Bridge */ |
| 47 | private $bridge; |
| 48 | |
| 49 | /** @var SubscribersRepository */ |
| 50 | private $subscribersRepository; |
| 51 | |
| 52 | /** @var SendingQueuesRepository */ |
| 53 | private $sendingQueuesRepository; |
| 54 | |
| 55 | /** @var StatisticsBouncesRepository */ |
| 56 | private $statisticsBouncesRepository; |
| 57 | |
| 58 | public function __construct( |
| 59 | SettingsController $settings, |
| 60 | SubscribersRepository $subscribersRepository, |
| 61 | SendingQueuesRepository $sendingQueuesRepository, |
| 62 | StatisticsBouncesRepository $statisticsBouncesRepository, |
| 63 | Bridge $bridge |
| 64 | ) { |
| 65 | $this->settings = $settings; |
| 66 | $this->bridge = $bridge; |
| 67 | parent::__construct(); |
| 68 | $this->subscribersRepository = $subscribersRepository; |
| 69 | $this->sendingQueuesRepository = $sendingQueuesRepository; |
| 70 | $this->statisticsBouncesRepository = $statisticsBouncesRepository; |
| 71 | } |
| 72 | |
| 73 | public function init() { |
| 74 | if (!$this->api) { |
| 75 | $this->api = new API($this->settings->get(Mailer::MAILER_CONFIG_SETTING_NAME)['mailpoet_api_key']); |
| 76 | } |
| 77 | } |
| 78 | |
| 79 | public function checkProcessingRequirements() { |
| 80 | return $this->bridge->isMailpoetSendingServiceEnabled(); |
| 81 | } |
| 82 | |
| 83 | public function processTaskStrategy(ScheduledTaskEntity $task, $timer) { |
| 84 | [$from, $to] = $this->getReportRange($task); |
| 85 | $page = $this->getReportPage($task); |
| 86 | |
| 87 | do { |
| 88 | // abort if execution limit is reached |
| 89 | $this->cronHelper->enforceExecutionLimit($timer); |
| 90 | |
| 91 | $report = $this->api->getBouncesReport($from, $to, $page); |
| 92 | if (!is_array($report)) { |
| 93 | // Transient failure: leave the task running so it retries with the |
| 94 | // same range and page on the next cron tick. |
| 95 | return false; |
| 96 | } |
| 97 | |
| 98 | $recipients = isset($report['recipients']) && is_array($report['recipients']) ? $report['recipients'] : []; |
| 99 | $this->processRecipients($task, $recipients); |
| 100 | |
| 101 | $hasMore = !empty($report['has_more']); |
| 102 | $page++; |
| 103 | // Persist the cursor so a subsequent execution-limit timeout resumes from |
| 104 | // the next unprocessed page instead of replaying the whole range. |
| 105 | $this->saveReportPage($task, $page); |
| 106 | } while ($hasMore); |
| 107 | |
| 108 | // The whole range is consumed; record its `to` as the basis for the next |
| 109 | // daily run's `from` so coverage stays continuous. |
| 110 | $existing = $this->settings->get(self::LAST_REPORT_TO_SETTING_KEY); |
| 111 | $existingTo = null; |
| 112 | if (is_string($existing) && $existing !== '') { |
| 113 | try { |
| 114 | $existingTo = Carbon::parse($existing); |
| 115 | } catch (\Exception $e) { |
| 116 | $existingTo = null; |
| 117 | } |
| 118 | } |
| 119 | if (!$existingTo || $to->greaterThan($existingTo)) { |
| 120 | $this->settings->set(self::LAST_REPORT_TO_SETTING_KEY, $to->format(\DateTimeInterface::ATOM)); |
| 121 | } |
| 122 | return true; |
| 123 | } |
| 124 | |
| 125 | /** |
| 126 | * @return array{0: Carbon, 1: Carbon} |
| 127 | */ |
| 128 | private function getReportRange(ScheduledTaskEntity $task): array { |
| 129 | $meta = $task->getMeta(); |
| 130 | if (is_array($meta) && isset($meta[self::META_FROM], $meta[self::META_TO])) { |
| 131 | return [Carbon::parse($meta[self::META_FROM]), Carbon::parse($meta[self::META_TO])]; |
| 132 | } |
| 133 | |
| 134 | $to = Carbon::now()->millisecond(0); |
| 135 | $from = $this->getReportFromDate($to); |
| 136 | |
| 137 | $meta = is_array($meta) ? $meta : []; |
| 138 | $meta[self::META_FROM] = $from->format(\DateTimeInterface::ATOM); |
| 139 | $meta[self::META_TO] = $to->format(\DateTimeInterface::ATOM); |
| 140 | $meta[self::META_PAGE] = $meta[self::META_PAGE] ?? 1; |
| 141 | $task->setMeta($meta); |
| 142 | $this->scheduledTasksRepository->persist($task); |
| 143 | $this->scheduledTasksRepository->flush(); |
| 144 | |
| 145 | return [$from, $to]; |
| 146 | } |
| 147 | |
| 148 | private function getReportPage(ScheduledTaskEntity $task): int { |
| 149 | $meta = $task->getMeta(); |
| 150 | $page = is_array($meta) && isset($meta[self::META_PAGE]) ? (int)$meta[self::META_PAGE] : 1; |
| 151 | return $page > 0 ? $page : 1; |
| 152 | } |
| 153 | |
| 154 | private function saveReportPage(ScheduledTaskEntity $task, int $page): void { |
| 155 | $meta = $task->getMeta(); |
| 156 | $meta = is_array($meta) ? $meta : []; |
| 157 | $meta[self::META_PAGE] = $page; |
| 158 | $task->setMeta($meta); |
| 159 | $this->scheduledTasksRepository->persist($task); |
| 160 | $this->scheduledTasksRepository->flush(); |
| 161 | } |
| 162 | |
| 163 | public function processRecipients(ScheduledTaskEntity $task, array $recipients): void { |
| 164 | $emails = array_values(array_unique(array_filter( |
| 165 | $recipients, |
| 166 | function ($email): bool { |
| 167 | return is_string($email) && $email !== ''; |
| 168 | } |
| 169 | ))); |
| 170 | if (empty($emails)) { |
| 171 | return; |
| 172 | } |
| 173 | |
| 174 | // Only subscribers currently subscribed/unconfirmed transition to bounced, |
| 175 | // preserving prior behavior. Loading them in one query (instead of one |
| 176 | // lookup per recipient) is the batching this task needed; the status change |
| 177 | // itself stays on the managed entities so the Doctrine lifecycle listeners |
| 178 | // (status-change notifications, subscriber counts) still fire. |
| 179 | $subscribers = $this->subscribersRepository->findBy([ |
| 180 | 'email' => $emails, |
| 181 | 'status' => [SubscriberEntity::STATUS_SUBSCRIBED, SubscriberEntity::STATUS_UNCONFIRMED], |
| 182 | 'deletedAt' => null, |
| 183 | ]); |
| 184 | if (empty($subscribers)) { |
| 185 | return; |
| 186 | } |
| 187 | |
| 188 | $previousTask = $this->scheduledTasksRepository->findPreviousTask($task); |
| 189 | foreach ($subscribers as $subscriber) { |
| 190 | $subscriber->setStatus(SubscriberEntity::STATUS_BOUNCED); |
| 191 | $this->saveBouncedStatistics($subscriber, $task, $previousTask); |
| 192 | } |
| 193 | // A single flush commits the status changes and the new statistics together |
| 194 | // in one transaction, so a failure cannot record statistics without the |
| 195 | // matching status change. A replayed page is then a no-op: the subscribers |
| 196 | // are already bounced and fall outside the status filter above. |
| 197 | $this->subscribersRepository->flush(); |
| 198 | } |
| 199 | |
| 200 | public function getNextRunDate() { |
| 201 | $date = Carbon::now()->millisecond(0); |
| 202 | return $date->startOfDay() |
| 203 | ->addDay() |
| 204 | ->addHours(rand(0, 5)) |
| 205 | ->addMinutes(rand(0, 59)) |
| 206 | ->addSeconds(rand(0, 59)); |
| 207 | } |
| 208 | |
| 209 | private function getReportFromDate(Carbon $now): Carbon { |
| 210 | $lastReportTo = $this->settings->get(self::LAST_REPORT_TO_SETTING_KEY); |
| 211 | // A malformed stored value (corruption, manual edit, older code) would make |
| 212 | // Carbon::parse throw and crash the worker on every run, so guard it the |
| 213 | // same way the persist path above does and fall back to the default `from`. |
| 214 | $from = $now->copy()->subDay(); |
| 215 | if (is_string($lastReportTo) && $lastReportTo !== '') { |
| 216 | try { |
| 217 | $from = Carbon::parse($lastReportTo); |
| 218 | } catch (\Exception $e) { |
| 219 | $from = $now->copy()->subDay(); |
| 220 | } |
| 221 | } |
| 222 | |
| 223 | // Keep an hour of margin inside MAX_LOOKBACK_DAYS so clock skew and request |
| 224 | // latency can't push the `from` past the limit the service enforces. |
| 225 | $earliestAllowed = $now->copy()->subDays(self::MAX_LOOKBACK_DAYS)->addHour(); |
| 226 | return $from->lessThan($earliestAllowed) ? $earliestAllowed : $from; |
| 227 | } |
| 228 | |
| 229 | private function saveBouncedStatistics(SubscriberEntity $subscriber, ScheduledTaskEntity $task, ?ScheduledTaskEntity $previousTask): void { |
| 230 | $dateFrom = null; |
| 231 | if ($previousTask instanceof ScheduledTaskEntity) { |
| 232 | $dateFrom = $previousTask->getScheduledAt(); |
| 233 | } |
| 234 | $queues = $this->sendingQueuesRepository->findAllForSubscriberSentBetween($subscriber, $task->getScheduledAt(), $dateFrom); |
| 235 | foreach ($queues as $queue) { |
| 236 | $newsletter = $queue->getNewsletter(); |
| 237 | if ($newsletter instanceof NewsletterEntity) { |
| 238 | $statistics = new StatisticsBounceEntity($newsletter, $queue, $subscriber); |
| 239 | $this->statisticsBouncesRepository->persist($statistics); |
| 240 | } |
| 241 | } |
| 242 | } |
| 243 | } |
| 244 |