AutomaticEmailScheduler.php
2 years ago
AutomationEmailScheduler.php
1 year ago
LatestNewsletterScheduler.php
2 months ago
PostNotificationScheduler.php
2 months ago
ReEngagementScheduler.php
5 days ago
Scheduler.php
1 year ago
WelcomeScheduler.php
2 years ago
index.php
3 years ago
PostNotificationScheduler.php
240 lines
| 1 | <?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing |
| 2 | |
| 3 | namespace MailPoet\Newsletter\Scheduler; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Cron\Workers\SendingQueue\SendingQueue; |
| 9 | use MailPoet\Entities\NewsletterEntity; |
| 10 | use MailPoet\Entities\NewsletterOptionEntity; |
| 11 | use MailPoet\Entities\NewsletterOptionFieldEntity; |
| 12 | use MailPoet\Entities\ScheduledTaskEntity; |
| 13 | use MailPoet\Entities\SendingQueueEntity; |
| 14 | use MailPoet\Logging\LoggerFactory; |
| 15 | use MailPoet\Newsletter\NewsletterPostsRepository; |
| 16 | use MailPoet\Newsletter\NewslettersRepository; |
| 17 | use MailPoet\Newsletter\Options\NewsletterOptionFieldsRepository; |
| 18 | use MailPoet\Newsletter\Options\NewsletterOptionsRepository; |
| 19 | use MailPoet\Newsletter\Sending\ScheduledTasksRepository; |
| 20 | use MailPoet\Newsletter\Sending\SendingQueuesRepository; |
| 21 | use MailPoet\WP\DateTime; |
| 22 | use MailPoet\WP\Posts; |
| 23 | |
| 24 | class PostNotificationScheduler { |
| 25 | |
| 26 | const SECONDS_IN_MINUTE = 60; |
| 27 | const SECONDS_IN_HOUR = 3600; |
| 28 | const LAST_WEEKDAY_FORMAT = 'L'; |
| 29 | const INTERVAL_DAILY = 'daily'; |
| 30 | const INTERVAL_IMMEDIATELY = 'immediately'; |
| 31 | const INTERVAL_NTHWEEKDAY = 'nthWeekDay'; |
| 32 | const INTERVAL_WEEKLY = 'weekly'; |
| 33 | const INTERVAL_IMMEDIATE = 'immediate'; |
| 34 | const INTERVAL_MONTHLY = 'monthly'; |
| 35 | |
| 36 | /** @var LoggerFactory */ |
| 37 | private $loggerFactory; |
| 38 | |
| 39 | /** @var NewslettersRepository */ |
| 40 | private $newslettersRepository; |
| 41 | |
| 42 | /** @var NewsletterOptionsRepository */ |
| 43 | private $newsletterOptionsRepository; |
| 44 | |
| 45 | /** @var NewsletterOptionFieldsRepository */ |
| 46 | private $newsletterOptionFieldsRepository; |
| 47 | |
| 48 | /** @var NewsletterPostsRepository */ |
| 49 | private $newsletterPostsRepository; |
| 50 | |
| 51 | /** @var Scheduler */ |
| 52 | private $scheduler; |
| 53 | |
| 54 | /*** @var ScheduledTasksRepository */ |
| 55 | private $scheduledTasksRepository; |
| 56 | |
| 57 | /*** @var SendingQueuesRepository */ |
| 58 | private $sendingQueuesRepository; |
| 59 | |
| 60 | public function __construct( |
| 61 | NewslettersRepository $newslettersRepository, |
| 62 | NewsletterOptionsRepository $newsletterOptionsRepository, |
| 63 | NewsletterOptionFieldsRepository $newsletterOptionFieldsRepository, |
| 64 | NewsletterPostsRepository $newsletterPostsRepository, |
| 65 | Scheduler $scheduler, |
| 66 | ScheduledTasksRepository $scheduledTasksRepository, |
| 67 | SendingQueuesRepository $sendingQueuesRepository |
| 68 | ) { |
| 69 | $this->loggerFactory = LoggerFactory::getInstance(); |
| 70 | $this->newslettersRepository = $newslettersRepository; |
| 71 | $this->newsletterOptionsRepository = $newsletterOptionsRepository; |
| 72 | $this->newsletterOptionFieldsRepository = $newsletterOptionFieldsRepository; |
| 73 | $this->newsletterPostsRepository = $newsletterPostsRepository; |
| 74 | $this->scheduler = $scheduler; |
| 75 | $this->scheduledTasksRepository = $scheduledTasksRepository; |
| 76 | $this->sendingQueuesRepository = $sendingQueuesRepository; |
| 77 | } |
| 78 | |
| 79 | public function transitionHook($newStatus, $oldStatus, $post) { |
| 80 | $this->loggerFactory->getLogger(LoggerFactory::TOPIC_POST_NOTIFICATIONS)->info( |
| 81 | 'transition post notification hook initiated', |
| 82 | [ |
| 83 | 'post_id' => $post->ID, |
| 84 | 'new_status' => $newStatus, |
| 85 | 'old_status' => $oldStatus, |
| 86 | ] |
| 87 | ); |
| 88 | $types = Posts::getTypes(); |
| 89 | if (($newStatus !== 'publish') || $oldStatus === 'publish' || !isset($types[$post->post_type])) { // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps |
| 90 | return; |
| 91 | } |
| 92 | $this->schedulePostNotification($post->ID); |
| 93 | } |
| 94 | |
| 95 | public function schedulePostNotification($postId) { |
| 96 | $this->loggerFactory->getLogger(LoggerFactory::TOPIC_POST_NOTIFICATIONS)->info( |
| 97 | 'schedule post notification hook', |
| 98 | ['post_id' => $postId] |
| 99 | ); |
| 100 | $newsletters = $this->newslettersRepository->findActiveByTypes([NewsletterEntity::TYPE_NOTIFICATION]); |
| 101 | $this->newslettersRepository->prefetchOptions($newsletters); |
| 102 | if (!count($newsletters)) { |
| 103 | return false; |
| 104 | } |
| 105 | foreach ($newsletters as $newsletter) { |
| 106 | $post = $this->newsletterPostsRepository->findOneBy([ |
| 107 | 'newsletter' => $newsletter, |
| 108 | 'postId' => $postId, |
| 109 | ]); |
| 110 | if ($post === null) { |
| 111 | $this->createPostNotificationSendingTask($newsletter); |
| 112 | } |
| 113 | } |
| 114 | } |
| 115 | |
| 116 | public function createPostNotificationSendingTask(NewsletterEntity $newsletter): ?ScheduledTaskEntity { |
| 117 | $notificationHistory = $this->newslettersRepository->findSendingNotificationHistoryWithoutPausedOrInvalidTask($newsletter); |
| 118 | if (count($notificationHistory) > 0) { |
| 119 | return null; |
| 120 | } |
| 121 | |
| 122 | $scheduleOption = $newsletter->getOption(NewsletterOptionFieldEntity::NAME_SCHEDULE); |
| 123 | if (!$scheduleOption) { |
| 124 | return null; |
| 125 | } |
| 126 | $nextRunDate = $this->scheduler->getNextRunDateTime($scheduleOption->getValue()); |
| 127 | if (!$nextRunDate) { |
| 128 | return null; |
| 129 | } |
| 130 | |
| 131 | // do not schedule duplicate queues for the same time |
| 132 | $lastQueue = $newsletter->getLatestQueue(); |
| 133 | $task = $lastQueue !== null ? $lastQueue->getTask() : null; |
| 134 | $scheduledAt = $task !== null ? $task->getScheduledAt() : null; |
| 135 | if ($scheduledAt && $scheduledAt->format('Y-m-d H:i:s') === $nextRunDate->format('Y-m-d H:i:s')) { |
| 136 | return null; |
| 137 | } |
| 138 | |
| 139 | $scheduledTask = new ScheduledTaskEntity(); |
| 140 | $scheduledTask->setType(SendingQueue::TASK_TYPE); |
| 141 | $scheduledTask->setStatus(ScheduledTaskEntity::STATUS_SCHEDULED); |
| 142 | $scheduledTask->setScheduledAt($nextRunDate); |
| 143 | $scheduledTask->setPriority(ScheduledTaskEntity::PRIORITY_MEDIUM); |
| 144 | $this->scheduledTasksRepository->persist($scheduledTask); |
| 145 | $this->scheduledTasksRepository->flush(); |
| 146 | |
| 147 | $sendingQueue = new SendingQueueEntity(); |
| 148 | $sendingQueue->setNewsletter($newsletter); |
| 149 | $sendingQueue->setTask($scheduledTask); |
| 150 | $this->sendingQueuesRepository->persist($sendingQueue); |
| 151 | $this->sendingQueuesRepository->flush(); |
| 152 | $scheduledTask->setSendingQueue($sendingQueue); |
| 153 | |
| 154 | $this->loggerFactory->getLogger(LoggerFactory::TOPIC_POST_NOTIFICATIONS)->info( |
| 155 | 'schedule post notification', |
| 156 | [ |
| 157 | 'sending_task' => $scheduledTask->getId(), |
| 158 | 'scheduled_at' => $nextRunDate->format(DateTime::DEFAULT_DATE_TIME_FORMAT), |
| 159 | ] |
| 160 | ); |
| 161 | return $scheduledTask; |
| 162 | } |
| 163 | |
| 164 | public function processPostNotificationSchedule(NewsletterEntity $newsletter) { |
| 165 | $intervalTypeOption = $newsletter->getOption(NewsletterOptionFieldEntity::NAME_INTERVAL_TYPE); |
| 166 | $intervalType = $intervalTypeOption ? $intervalTypeOption->getValue() : null; |
| 167 | |
| 168 | $timeOfDayOption = $newsletter->getOption(NewsletterOptionFieldEntity::NAME_TIME_OF_DAY); |
| 169 | $hour = $timeOfDayOption ? (int)floor((int)$timeOfDayOption->getValue() / self::SECONDS_IN_HOUR) : null; |
| 170 | $minute = $timeOfDayOption ? ((int)$timeOfDayOption->getValue() - (int)($hour * self::SECONDS_IN_HOUR)) / self::SECONDS_IN_MINUTE : null; |
| 171 | |
| 172 | $weekDayOption = $newsletter->getOption(NewsletterOptionFieldEntity::NAME_WEEK_DAY); |
| 173 | $weekDay = $weekDayOption ? $weekDayOption->getValue() : null; |
| 174 | $weekDay = $this->normalizeCronList($weekDay, range(0, 6), '1'); |
| 175 | |
| 176 | $monthDayOption = $newsletter->getOption(NewsletterOptionFieldEntity::NAME_MONTH_DAY); |
| 177 | $monthDay = $monthDayOption ? $monthDayOption->getValue() : null; |
| 178 | $monthDay = $this->normalizeCronList($monthDay, range(1, 28), '1'); |
| 179 | |
| 180 | $nthWeekDayOption = $newsletter->getOption(NewsletterOptionFieldEntity::NAME_NTH_WEEK_DAY); |
| 181 | $nthWeekDay = $nthWeekDayOption ? $nthWeekDayOption->getValue() : null; |
| 182 | $nthWeekDay = ($nthWeekDay === self::LAST_WEEKDAY_FORMAT) ? $nthWeekDay : '#' . $nthWeekDay; |
| 183 | switch ($intervalType) { |
| 184 | case self::INTERVAL_IMMEDIATE: |
| 185 | case self::INTERVAL_DAILY: |
| 186 | $schedule = sprintf('%s %s * * *', $minute, $hour); |
| 187 | break; |
| 188 | case self::INTERVAL_WEEKLY: |
| 189 | $schedule = sprintf('%s %s * * %s', $minute, $hour, $weekDay); |
| 190 | break; |
| 191 | case self::INTERVAL_NTHWEEKDAY: |
| 192 | // nthWeekDay schedules a single weekday (e.g. "every 1st Monday"), |
| 193 | // so reduce the normalized list to its first entry. |
| 194 | $firstWeekDay = explode(',', $weekDay)[0]; |
| 195 | $schedule = sprintf('%s %s ? * %s%s', $minute, $hour, $firstWeekDay, $nthWeekDay); |
| 196 | break; |
| 197 | case self::INTERVAL_MONTHLY: |
| 198 | $schedule = sprintf('%s %s %s * *', $minute, $hour, $monthDay); |
| 199 | break; |
| 200 | case self::INTERVAL_IMMEDIATELY: |
| 201 | default: |
| 202 | $schedule = '* * * * *'; |
| 203 | break; |
| 204 | } |
| 205 | $optionField = $this->newsletterOptionFieldsRepository->findOneBy([ |
| 206 | 'name' => NewsletterOptionFieldEntity::NAME_SCHEDULE, |
| 207 | ]); |
| 208 | if (!$optionField instanceof NewsletterOptionFieldEntity) { |
| 209 | throw new \Exception('NewsletterOptionField for schedule doesn’t exist.'); |
| 210 | } |
| 211 | $scheduleOption = $newsletter->getOption(NewsletterOptionFieldEntity::NAME_SCHEDULE); |
| 212 | if ($scheduleOption === null) { |
| 213 | $scheduleOption = new NewsletterOptionEntity($newsletter, $optionField); |
| 214 | $newsletter->getOptions()->add($scheduleOption); |
| 215 | } |
| 216 | $scheduleOption->setValue($schedule); |
| 217 | $this->newsletterOptionsRepository->persist($scheduleOption); |
| 218 | $this->newsletterOptionsRepository->flush(); |
| 219 | return $scheduleOption->getValue(); |
| 220 | } |
| 221 | |
| 222 | private function normalizeCronList($value, array $allowedValues, string $defaultValue): string { |
| 223 | $allowedValues = array_map('strval', $allowedValues); |
| 224 | $selectedValues = array_filter( |
| 225 | array_map('trim', explode(',', (string)$value)), |
| 226 | function ($selectedValue) use ($allowedValues) { |
| 227 | return in_array($selectedValue, $allowedValues, true); |
| 228 | } |
| 229 | ); |
| 230 | $selectedValues = array_unique($selectedValues); |
| 231 | sort($selectedValues, SORT_NUMERIC); |
| 232 | |
| 233 | if (empty($selectedValues)) { |
| 234 | return $defaultValue; |
| 235 | } |
| 236 | |
| 237 | return implode(',', $selectedValues); |
| 238 | } |
| 239 | } |
| 240 |