WordPress.php
281 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Cron\Triggers; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Config\ServicesChecker; |
| 9 | use MailPoet\Cron\CronHelper; |
| 10 | use MailPoet\Cron\Supervisor; |
| 11 | use MailPoet\Cron\Workers\Bounce as BounceWorker; |
| 12 | use MailPoet\Cron\Workers\KeyCheck\PremiumKeyCheck as PremiumKeyCheckWorker; |
| 13 | use MailPoet\Cron\Workers\KeyCheck\SendingServiceKeyCheck as SendingServiceKeyCheckWorker; |
| 14 | use MailPoet\Cron\Workers\Scheduler as SchedulerWorker; |
| 15 | use MailPoet\Cron\Workers\SendingQueue\SendingQueue as SendingQueueWorker; |
| 16 | use MailPoet\Cron\Workers\SubscribersStatsReport; |
| 17 | use MailPoet\Cron\Workers\WorkersFactory; |
| 18 | use MailPoet\Entities\ScheduledTaskEntity; |
| 19 | use MailPoet\Mailer\MailerLog; |
| 20 | use MailPoet\Newsletter\Sending\ScheduledTasksRepository; |
| 21 | use MailPoet\Services\Bridge; |
| 22 | use MailPoet\Settings\SettingsController; |
| 23 | use MailPoet\Util\Helpers; |
| 24 | use MailPoet\WP\Functions as WPFunctions; |
| 25 | use MailPoetVendor\Doctrine\ORM\EntityManager; |
| 26 | |
| 27 | class WordPress { |
| 28 | const SCHEDULED_IN_THE_PAST = 'past'; |
| 29 | const SCHEDULED_IN_THE_FUTURE = 'future'; |
| 30 | |
| 31 | const RUN_INTERVAL = -1; // seconds |
| 32 | const LAST_RUN_AT_SETTING = 'cron_trigger_wordpress.last_run_at'; |
| 33 | |
| 34 | /** @var array<string, array<string, array<string, int>>> */ |
| 35 | private $tasksCounts = []; |
| 36 | |
| 37 | /** @var CronHelper */ |
| 38 | private $cronHelper; |
| 39 | |
| 40 | /** @var Supervisor */ |
| 41 | private $supervisor; |
| 42 | |
| 43 | /** @var SettingsController */ |
| 44 | private $settings; |
| 45 | |
| 46 | /** @var WPFunctions */ |
| 47 | private $wp; |
| 48 | |
| 49 | /** @var ServicesChecker */ |
| 50 | private $serviceChecker; |
| 51 | |
| 52 | /** @var ScheduledTasksRepository */ |
| 53 | private $scheduledTasksRepository; |
| 54 | |
| 55 | /** @var EntityManager */ |
| 56 | private $entityManager; |
| 57 | |
| 58 | public function __construct( |
| 59 | CronHelper $cronHelper, |
| 60 | Supervisor $supervisor, |
| 61 | SettingsController $settings, |
| 62 | ServicesChecker $serviceChecker, |
| 63 | WPFunctions $wp, |
| 64 | ScheduledTasksRepository $scheduledTasksRepository, |
| 65 | EntityManager $entityManager |
| 66 | ) { |
| 67 | $this->supervisor = $supervisor; |
| 68 | $this->settings = $settings; |
| 69 | $this->wp = $wp; |
| 70 | $this->cronHelper = $cronHelper; |
| 71 | $this->serviceChecker = $serviceChecker; |
| 72 | $this->scheduledTasksRepository = $scheduledTasksRepository; |
| 73 | $this->entityManager = $entityManager; |
| 74 | } |
| 75 | |
| 76 | public function run() { |
| 77 | try { |
| 78 | if (!$this->checkRunInterval()) { |
| 79 | return false; |
| 80 | } |
| 81 | if (!$this->checkExecutionRequirements()) { |
| 82 | $this->stop(); |
| 83 | return; |
| 84 | } |
| 85 | |
| 86 | $this->supervisor->init(); |
| 87 | return $this->supervisor->checkDaemon(); |
| 88 | } catch (\Exception $e) { |
| 89 | $mySqlGoneAwayMessage = Helpers::mySqlGoneAwayExceptionHandler($e); |
| 90 | if ($mySqlGoneAwayMessage) { |
| 91 | throw new \Exception($mySqlGoneAwayMessage, 0, $e); |
| 92 | } |
| 93 | throw $e; |
| 94 | } |
| 95 | } |
| 96 | |
| 97 | private function checkRunInterval(): bool { |
| 98 | $runInterval = $this->wp->applyFilters('mailpoet_cron_trigger_wordpress_run_interval', self::RUN_INTERVAL); |
| 99 | if ($runInterval === -1) { |
| 100 | return true; |
| 101 | } |
| 102 | $lastRunAt = (int)$this->settings->get(self::LAST_RUN_AT_SETTING, 0); |
| 103 | $runIntervalElapsed = (time() - $lastRunAt) >= $runInterval; |
| 104 | if ($runIntervalElapsed) { |
| 105 | $this->settings->set(self::LAST_RUN_AT_SETTING, time()); |
| 106 | return true; |
| 107 | } |
| 108 | return false; |
| 109 | } |
| 110 | |
| 111 | public static function resetRunInterval(): void { |
| 112 | $settings = SettingsController::getInstance(); |
| 113 | $settings->set(self::LAST_RUN_AT_SETTING, 0); |
| 114 | } |
| 115 | |
| 116 | public function checkExecutionRequirements(): bool { |
| 117 | if ($this->wp->wpIsMaintenanceMode()) { |
| 118 | // Skip if WP is currently in maintenance mode |
| 119 | // The maintenance mode is activated when WP core or a plugin update is in progress |
| 120 | return false; |
| 121 | } |
| 122 | |
| 123 | $this->loadTasksCounts(); |
| 124 | |
| 125 | // Because a lot of workers has the same pattern for check if it's active we can use a loop here |
| 126 | $isSimpleWorkerActive = false; |
| 127 | foreach (WorkersFactory::SIMPLE_WORKER_TYPES as $simpleWorkerType) { |
| 128 | $tasksCount = $this->getTasksCount([ |
| 129 | 'type' => $simpleWorkerType, |
| 130 | 'scheduled_in' => [self::SCHEDULED_IN_THE_PAST], |
| 131 | 'status' => ['null', ScheduledTaskEntity::STATUS_SCHEDULED], |
| 132 | ]); |
| 133 | if ($tasksCount) { |
| 134 | $isSimpleWorkerActive = true; |
| 135 | break; |
| 136 | } |
| 137 | } |
| 138 | |
| 139 | return ( |
| 140 | $this->isSendingQueueActive() |
| 141 | || $this->isBounceActive() |
| 142 | || $this->isSendingServiceKeyCheckActive() |
| 143 | || $this->isPremiumKeyCheckActive() |
| 144 | || $this->isSubscriberStatsReportActive() |
| 145 | || $isSimpleWorkerActive |
| 146 | ); |
| 147 | } |
| 148 | |
| 149 | public function stop() { |
| 150 | $cronDaemon = $this->cronHelper->getDaemon(); |
| 151 | if ($cronDaemon) { |
| 152 | $this->cronHelper->deactivateDaemon($cronDaemon); |
| 153 | } |
| 154 | } |
| 155 | |
| 156 | private function isSendingQueueActive(): bool { |
| 157 | $scheduledQueues = $this->scheduledTasksRepository->findScheduledSendingTasks(SchedulerWorker::TASK_BATCH_SIZE); |
| 158 | $runningQueues = $this->scheduledTasksRepository->findRunningSendingTasks(SendingQueueWorker::TASK_BATCH_SIZE); |
| 159 | $sendingLimitReached = MailerLog::isSendingLimitReached(); |
| 160 | $sendingIsPaused = MailerLog::isSendingPaused(); |
| 161 | $sendingWaitingForRetry = MailerLog::isSendingWaitingForRetry(); |
| 162 | |
| 163 | return (($scheduledQueues || $runningQueues) && !$sendingLimitReached && !$sendingIsPaused && !$sendingWaitingForRetry); |
| 164 | } |
| 165 | |
| 166 | private function isBounceActive(): bool { |
| 167 | $mpSendingEnabled = Bridge::isMPSendingServiceEnabled(); |
| 168 | $bounceDueTasks = $this->getTasksCount([ |
| 169 | 'type' => BounceWorker::TASK_TYPE, |
| 170 | 'scheduled_in' => [self::SCHEDULED_IN_THE_PAST], |
| 171 | 'status' => ['null', ScheduledTaskEntity::STATUS_SCHEDULED], |
| 172 | ]); |
| 173 | $bounceFutureTasks = $this->getTasksCount([ |
| 174 | 'type' => BounceWorker::TASK_TYPE, |
| 175 | 'scheduled_in' => [self::SCHEDULED_IN_THE_FUTURE], |
| 176 | 'status' => [ScheduledTaskEntity::STATUS_SCHEDULED], |
| 177 | ]); |
| 178 | |
| 179 | return ($mpSendingEnabled && ($bounceDueTasks || !$bounceFutureTasks)); |
| 180 | } |
| 181 | |
| 182 | private function isSendingServiceKeyCheckActive(): bool { |
| 183 | $mpSendingEnabled = Bridge::isMPSendingServiceEnabled(); |
| 184 | $msskeycheckDueTasks = $this->getTasksCount([ |
| 185 | 'type' => SendingServiceKeyCheckWorker::TASK_TYPE, |
| 186 | 'scheduled_in' => [self::SCHEDULED_IN_THE_PAST], |
| 187 | 'status' => ['null', ScheduledTaskEntity::STATUS_SCHEDULED], |
| 188 | ]); |
| 189 | $msskeycheckFutureTasks = $this->getTasksCount([ |
| 190 | 'type' => SendingServiceKeyCheckWorker::TASK_TYPE, |
| 191 | 'scheduled_in' => [self::SCHEDULED_IN_THE_FUTURE], |
| 192 | 'status' => [ScheduledTaskEntity::STATUS_SCHEDULED], |
| 193 | ]); |
| 194 | |
| 195 | return ($mpSendingEnabled && ($msskeycheckDueTasks || !$msskeycheckFutureTasks)); |
| 196 | } |
| 197 | |
| 198 | private function isPremiumKeyCheckActive(): bool { |
| 199 | $premiumKeySpecified = Bridge::isPremiumKeySpecified(); |
| 200 | $premiumKeycheckDueTasks = $this->getTasksCount([ |
| 201 | 'type' => PremiumKeyCheckWorker::TASK_TYPE, |
| 202 | 'scheduled_in' => [self::SCHEDULED_IN_THE_PAST], |
| 203 | 'status' => ['null', ScheduledTaskEntity::STATUS_SCHEDULED], |
| 204 | ]); |
| 205 | $premiumKeycheckFutureTasks = $this->getTasksCount([ |
| 206 | 'type' => PremiumKeyCheckWorker::TASK_TYPE, |
| 207 | 'scheduled_in' => [self::SCHEDULED_IN_THE_FUTURE], |
| 208 | 'status' => [ScheduledTaskEntity::STATUS_SCHEDULED], |
| 209 | ]); |
| 210 | |
| 211 | return ($premiumKeySpecified && ($premiumKeycheckDueTasks || !$premiumKeycheckFutureTasks)); |
| 212 | } |
| 213 | |
| 214 | private function isSubscriberStatsReportActive(): bool { |
| 215 | $validAccountKey = $this->serviceChecker->getValidAccountKey(); |
| 216 | $statsReportDueTasks = $this->getTasksCount([ |
| 217 | 'type' => SubscribersStatsReport::TASK_TYPE, |
| 218 | 'scheduled_in' => [self::SCHEDULED_IN_THE_PAST], |
| 219 | 'status' => ['null', ScheduledTaskEntity::STATUS_SCHEDULED], |
| 220 | ]); |
| 221 | $statsReportFutureTasks = $this->getTasksCount([ |
| 222 | 'type' => SubscribersStatsReport::TASK_TYPE, |
| 223 | 'scheduled_in' => [self::SCHEDULED_IN_THE_FUTURE], |
| 224 | 'status' => [ScheduledTaskEntity::STATUS_SCHEDULED], |
| 225 | ]); |
| 226 | |
| 227 | return ($validAccountKey && ($statsReportDueTasks || !$statsReportFutureTasks)); |
| 228 | } |
| 229 | |
| 230 | private function loadTasksCounts(): void { |
| 231 | $scheduledTasksTableName = $this->entityManager->getClassMetadata(ScheduledTaskEntity::class)->getTableName(); |
| 232 | $sql = " |
| 233 | SELECT |
| 234 | type, |
| 235 | status, |
| 236 | count(*) AS count, |
| 237 | CASE WHEN scheduled_at <= :now THEN :past ELSE :future END AS scheduled_in |
| 238 | FROM $scheduledTasksTableName |
| 239 | WHERE deleted_at IS NULL AND (status != :statusCompleted OR status IS NULL) |
| 240 | GROUP BY type, status, scheduled_in"; |
| 241 | |
| 242 | $stmt = $this->entityManager->getConnection()->prepare($sql); |
| 243 | $stmt->bindValue('now', date('Y-m-d H:i:s', $this->wp->currentTime('timestamp', true))); |
| 244 | $stmt->bindValue('past', self::SCHEDULED_IN_THE_PAST); |
| 245 | $stmt->bindValue('future', self::SCHEDULED_IN_THE_FUTURE); |
| 246 | $stmt->bindValue('statusCompleted', ScheduledTaskEntity::STATUS_COMPLETED); |
| 247 | $rows = $stmt->executeQuery()->fetchAllAssociative(); |
| 248 | |
| 249 | $this->tasksCounts = []; |
| 250 | foreach ($rows as $r) { |
| 251 | $type = is_string($r['type']) ? $r['type'] : ''; |
| 252 | $scheduledIn = is_string($r['scheduled_in']) ? $r['scheduled_in'] : ''; |
| 253 | $status = is_string($r['status']) && $r['status'] !== '' ? $r['status'] : 'null'; |
| 254 | $count = is_numeric($r['count']) ? (int)$r['count'] : 0; |
| 255 | if (empty($this->tasksCounts[$type])) { |
| 256 | $this->tasksCounts[$type] = []; |
| 257 | } |
| 258 | if (empty($this->tasksCounts[$type][$scheduledIn])) { |
| 259 | $this->tasksCounts[$type][$scheduledIn] = []; |
| 260 | } |
| 261 | $this->tasksCounts[$type][$scheduledIn][$status] = $count; |
| 262 | } |
| 263 | } |
| 264 | |
| 265 | /** |
| 266 | * @param array{type: string, scheduled_in: list<string>, status: list<string>} $options |
| 267 | */ |
| 268 | private function getTasksCount(array $options): int { |
| 269 | $count = 0; |
| 270 | $type = $options['type']; |
| 271 | foreach ($options['scheduled_in'] as $scheduledIn) { |
| 272 | foreach ($options['status'] as $status) { |
| 273 | if (!empty($this->tasksCounts[$type][$scheduledIn][$status])) { |
| 274 | $count += $this->tasksCounts[$type][$scheduledIn][$status]; |
| 275 | } |
| 276 | } |
| 277 | } |
| 278 | return $count; |
| 279 | } |
| 280 | } |
| 281 |