Analytics.php
3 years ago
AutomatedLatestContent.php
2 months ago
AutomaticEmails.php
3 years ago
Captcha.php
1 year ago
Coupons.php
2 years ago
CustomFields.php
2 months ago
DynamicProducts.php
1 year ago
DynamicSegments.php
2 months ago
FeatureFlags.php
3 years ago
Forms.php
2 months ago
Help.php
1 year ago
ImportExport.php
2 months ago
Mailer.php
1 year ago
NewsletterLinks.php
2 months ago
NewsletterTemplates.php
2 months ago
Newsletters.php
2 months ago
Premium.php
10 months ago
RedirectResponse.php
1 year ago
Segments.php
2 months ago
SendingQueue.php
2 months ago
Services.php
6 months ago
Settings.php
2 months ago
Setup.php
1 year ago
StatisticsExport.php
3 months ago
SubscriberStats.php
1 month ago
Subscribers.php
2 months ago
Tags.php
3 years ago
UserFlags.php
2 years ago
WoocommerceProductVariations.php
2 months ago
WoocommerceSettings.php
3 years ago
index.php
3 years ago
SendingQueue.php
329 lines
| 1 | <?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing |
| 2 | |
| 3 | namespace MailPoet\API\JSON\v1; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\API\JSON\Endpoint as APIEndpoint; |
| 9 | use MailPoet\API\JSON\Error as APIError; |
| 10 | use MailPoet\API\JSON\Response; |
| 11 | use MailPoet\API\JSON\ResponseBuilders\SendingQueuesResponseBuilder; |
| 12 | use MailPoet\Config\AccessControl; |
| 13 | use MailPoet\Cron\ActionScheduler\Actions\DaemonTrigger; |
| 14 | use MailPoet\Cron\CronHelper; |
| 15 | use MailPoet\Cron\CronTrigger; |
| 16 | use MailPoet\Cron\Triggers\WordPress; |
| 17 | use MailPoet\Cron\Workers\SendingQueue\SendingQueue as SendingQueueWorker; |
| 18 | use MailPoet\Entities\NewsletterEntity; |
| 19 | use MailPoet\Entities\ScheduledTaskEntity; |
| 20 | use MailPoet\Entities\SendingQueueEntity; |
| 21 | use MailPoet\Mailer\MailerFactory; |
| 22 | use MailPoet\Newsletter\NewslettersRepository; |
| 23 | use MailPoet\Newsletter\NewsletterValidator; |
| 24 | use MailPoet\Newsletter\Sending\ScheduledTasksRepository; |
| 25 | use MailPoet\Newsletter\Sending\SendingQueuesRepository; |
| 26 | use MailPoet\Newsletter\Sending\TimeZoneCampaignScheduler; |
| 27 | use MailPoet\Segments\SubscribersFinder; |
| 28 | use MailPoet\Settings\SettingsController; |
| 29 | use MailPoet\Util\License\Features\Subscribers as SubscribersFeature; |
| 30 | use MailPoetVendor\Carbon\Carbon; |
| 31 | |
| 32 | class SendingQueue extends APIEndpoint { |
| 33 | public $permissions = [ |
| 34 | 'global' => AccessControl::PERMISSION_MANAGE_EMAILS, |
| 35 | ]; |
| 36 | |
| 37 | /** @var SubscribersFeature */ |
| 38 | private $subscribersFeature; |
| 39 | |
| 40 | /** @var SubscribersFinder */ |
| 41 | private $subscribersFinder; |
| 42 | |
| 43 | /** @var NewslettersRepository */ |
| 44 | private $newsletterRepository; |
| 45 | |
| 46 | /** @var SendingQueuesRepository */ |
| 47 | private $sendingQueuesRepository; |
| 48 | |
| 49 | /** @var ScheduledTasksRepository */ |
| 50 | private $scheduledTasksRepository; |
| 51 | |
| 52 | /** @var MailerFactory */ |
| 53 | private $mailerFactory; |
| 54 | |
| 55 | /** @var NewsletterValidator */ |
| 56 | private $newsletterValidator; |
| 57 | |
| 58 | /** @var SettingsController */ |
| 59 | private $settings; |
| 60 | |
| 61 | /** @var DaemonTrigger */ |
| 62 | private $actionSchedulerDaemonTriggerAction; |
| 63 | |
| 64 | /** @var SendingQueuesResponseBuilder */ |
| 65 | private $sendingQueuesResponseBuilder; |
| 66 | |
| 67 | /** @var CronHelper */ |
| 68 | private $cronHelper; |
| 69 | |
| 70 | /** @var TimeZoneCampaignScheduler */ |
| 71 | private $timeZoneCampaignScheduler; |
| 72 | |
| 73 | public function __construct( |
| 74 | SubscribersFeature $subscribersFeature, |
| 75 | NewslettersRepository $newsletterRepository, |
| 76 | SendingQueuesRepository $sendingQueuesRepository, |
| 77 | SubscribersFinder $subscribersFinder, |
| 78 | ScheduledTasksRepository $scheduledTasksRepository, |
| 79 | MailerFactory $mailerFactory, |
| 80 | SettingsController $settings, |
| 81 | DaemonTrigger $actionSchedulerDaemonTriggerAction, |
| 82 | NewsletterValidator $newsletterValidator, |
| 83 | SendingQueuesResponseBuilder $sendingQueuesResponseBuilder, |
| 84 | CronHelper $cronHelper, |
| 85 | TimeZoneCampaignScheduler $timeZoneCampaignScheduler |
| 86 | ) { |
| 87 | $this->subscribersFeature = $subscribersFeature; |
| 88 | $this->subscribersFinder = $subscribersFinder; |
| 89 | $this->newsletterRepository = $newsletterRepository; |
| 90 | $this->sendingQueuesRepository = $sendingQueuesRepository; |
| 91 | $this->scheduledTasksRepository = $scheduledTasksRepository; |
| 92 | $this->mailerFactory = $mailerFactory; |
| 93 | $this->settings = $settings; |
| 94 | $this->actionSchedulerDaemonTriggerAction = $actionSchedulerDaemonTriggerAction; |
| 95 | $this->newsletterValidator = $newsletterValidator; |
| 96 | $this->sendingQueuesResponseBuilder = $sendingQueuesResponseBuilder; |
| 97 | $this->cronHelper = $cronHelper; |
| 98 | $this->timeZoneCampaignScheduler = $timeZoneCampaignScheduler; |
| 99 | } |
| 100 | |
| 101 | public function add($data = []) { |
| 102 | if ($this->subscribersFeature->check()) { |
| 103 | return $this->errorResponse([ |
| 104 | APIError::FORBIDDEN => __('Subscribers limit reached.', 'mailpoet'), |
| 105 | ], [], Response::STATUS_FORBIDDEN); |
| 106 | } |
| 107 | $newsletterId = (isset($data['newsletter_id']) |
| 108 | ? (int)$data['newsletter_id'] |
| 109 | : false |
| 110 | ); |
| 111 | |
| 112 | // check that the newsletter exists |
| 113 | $newsletter = $this->newsletterRepository->findOneById($newsletterId); |
| 114 | $this->newsletterRepository->prefetchOptions([$newsletter]); |
| 115 | |
| 116 | if (!$newsletter instanceof NewsletterEntity) { |
| 117 | return $this->errorResponse([ |
| 118 | APIError::NOT_FOUND => __('This newsletter does not exist.', 'mailpoet'), |
| 119 | ]); |
| 120 | } |
| 121 | |
| 122 | $validationError = $this->newsletterValidator->validate($newsletter); |
| 123 | if ($validationError) { |
| 124 | return $this->errorResponse([ |
| 125 | APIError::BAD_REQUEST => $validationError, |
| 126 | ]); |
| 127 | } |
| 128 | |
| 129 | try { |
| 130 | // check that the sending method has been configured properly by verifying that default mailer can be build |
| 131 | $this->mailerFactory->getDefaultMailer(); |
| 132 | |
| 133 | $isScheduled = (bool)$newsletter->getOptionValue('isScheduled'); |
| 134 | if ($isScheduled && $this->timeZoneCampaignScheduler->isSubscriberTimeZoneMode($newsletter)) { |
| 135 | $sendingQueue = $this->timeZoneCampaignScheduler->schedule($newsletter); |
| 136 | WordPress::resetRunInterval(); |
| 137 | $this->triggerSending($newsletter); |
| 138 | return $this->successResponse($this->sendingQueuesResponseBuilder->build($sendingQueue)); |
| 139 | } |
| 140 | // Existing time zone batches must be reconciled regardless of the new send mode (scheduled or |
| 141 | // immediate). Otherwise orphaned time zone queues survive in the DB and may later be picked up |
| 142 | // by the scheduler cron, causing duplicate sends. Both calls are no-ops when the newsletter |
| 143 | // has no time zone queues. |
| 144 | if (!$this->timeZoneCampaignScheduler->canReplaceScheduledCampaign($newsletter)) { |
| 145 | throw new \Exception( |
| 146 | __('This email can no longer be edited because one or more time zone batches have already started.', 'mailpoet'), |
| 147 | Response::STATUS_BAD_REQUEST |
| 148 | ); |
| 149 | } |
| 150 | $this->timeZoneCampaignScheduler->deleteScheduledCampaignQueues($newsletter); |
| 151 | |
| 152 | $sendingQueue = $this->sendingQueuesRepository->findOneByNewsletterAndTaskStatus($newsletter, null); |
| 153 | |
| 154 | if ($sendingQueue instanceof SendingQueueEntity) { |
| 155 | return $this->errorResponse([ |
| 156 | APIError::NOT_FOUND => __('This newsletter is already being sent.', 'mailpoet'), |
| 157 | ]); |
| 158 | } |
| 159 | |
| 160 | $sendingQueue = $this->sendingQueuesRepository->findOneByNewsletterAndTaskStatus($newsletter, ScheduledTaskEntity::STATUS_SCHEDULED); |
| 161 | |
| 162 | if (is_null($sendingQueue)) { |
| 163 | $scheduledTask = new ScheduledTaskEntity(); |
| 164 | $scheduledTask->setType(SendingQueueWorker::TASK_TYPE); |
| 165 | $sendingQueue = new SendingQueueEntity(); |
| 166 | $sendingQueue->setNewsletter($newsletter); |
| 167 | $sendingQueue->setTask($scheduledTask); |
| 168 | |
| 169 | $this->sendingQueuesRepository->persist($sendingQueue); |
| 170 | $this->newsletterRepository->refresh($newsletter); |
| 171 | } else { |
| 172 | $scheduledTask = $sendingQueue->getTask(); |
| 173 | } |
| 174 | |
| 175 | if (!$scheduledTask instanceof ScheduledTaskEntity) { |
| 176 | return $this->errorResponse([ |
| 177 | APIError::NOT_FOUND => __('Unable to find scheduled task associated with this newsletter.', 'mailpoet'), |
| 178 | ]); |
| 179 | } |
| 180 | |
| 181 | $scheduledTask->setPriority(ScheduledTaskEntity::PRIORITY_MEDIUM); |
| 182 | $this->scheduledTasksRepository->persist($scheduledTask); |
| 183 | $this->scheduledTasksRepository->flush(); |
| 184 | |
| 185 | WordPress::resetRunInterval(); |
| 186 | if ($isScheduled) { |
| 187 | // set newsletter status |
| 188 | $newsletter->setStatus(NewsletterEntity::STATUS_SCHEDULED); |
| 189 | |
| 190 | // set scheduled task status |
| 191 | $scheduledTask->setStatus(ScheduledTaskEntity::STATUS_SCHEDULED); |
| 192 | $scheduledTask->setScheduledAt(new Carbon($newsletter->getOptionValue('scheduledAt'))); |
| 193 | } else { |
| 194 | $segments = $newsletter->getSegmentIds(); |
| 195 | |
| 196 | $this->scheduledTasksRepository->refresh($scheduledTask); |
| 197 | $this->subscribersFinder->addSubscribersToTaskFromSegments($scheduledTask, $segments, $newsletter->getFilterSegmentId()); |
| 198 | $subscribersCount = $scheduledTask->getSubscribers()->count(); |
| 199 | |
| 200 | if (!$subscribersCount) { |
| 201 | return $this->errorResponse([ |
| 202 | APIError::UNKNOWN => __('There are no subscribers in that list!', 'mailpoet'), |
| 203 | ]); |
| 204 | } |
| 205 | |
| 206 | $this->sendingQueuesRepository->updateCounts($sendingQueue); |
| 207 | $scheduledTask->setStatus(null); |
| 208 | $scheduledTask->setScheduledAt(null); |
| 209 | |
| 210 | // set newsletter status |
| 211 | $newsletter->setStatus(NewsletterEntity::STATUS_SENDING); |
| 212 | } |
| 213 | $this->scheduledTasksRepository->persist($scheduledTask); |
| 214 | $this->newsletterRepository->flush(); |
| 215 | |
| 216 | $this->triggerSending($newsletter); |
| 217 | return $this->successResponse( |
| 218 | ($newsletter->getLatestQueue() instanceof SendingQueueEntity) ? $this->sendingQueuesResponseBuilder->build($newsletter->getLatestQueue()) : null |
| 219 | ); |
| 220 | } catch (\Exception $e) { |
| 221 | $errorCode = APIError::UNKNOWN; |
| 222 | $statusCode = Response::STATUS_NOT_FOUND; |
| 223 | if ($e->getCode() === Response::STATUS_FORBIDDEN) { |
| 224 | $errorCode = APIError::FORBIDDEN; |
| 225 | $statusCode = Response::STATUS_FORBIDDEN; |
| 226 | } elseif ($e->getCode() === Response::STATUS_BAD_REQUEST) { |
| 227 | $errorCode = APIError::BAD_REQUEST; |
| 228 | $statusCode = Response::STATUS_BAD_REQUEST; |
| 229 | } |
| 230 | return $this->errorResponse([ |
| 231 | $errorCode => $e->getMessage(), |
| 232 | ], [], $statusCode); |
| 233 | } |
| 234 | } |
| 235 | |
| 236 | public function pause($data = []) { |
| 237 | $newsletterId = (isset($data['newsletter_id']) |
| 238 | ? (int)$data['newsletter_id'] |
| 239 | : false |
| 240 | ); |
| 241 | $newsletter = $this->newsletterRepository->findOneById($newsletterId); |
| 242 | |
| 243 | if ($newsletter instanceof NewsletterEntity) { |
| 244 | $queue = $newsletter->getLastUpdatedQueue(); |
| 245 | |
| 246 | if (!$queue instanceof SendingQueueEntity) { |
| 247 | return $this->errorResponse([ |
| 248 | APIError::UNKNOWN => __('This newsletter has not been sent yet.', 'mailpoet'), |
| 249 | ]); |
| 250 | } else { |
| 251 | if ($this->timeZoneCampaignScheduler->isTimeZoneQueue($queue)) { |
| 252 | $this->timeZoneCampaignScheduler->pauseCampaign($queue); |
| 253 | } else { |
| 254 | $this->sendingQueuesRepository->pause($queue); |
| 255 | } |
| 256 | return $this->successResponse(); |
| 257 | } |
| 258 | } else { |
| 259 | return $this->errorResponse([ |
| 260 | APIError::NOT_FOUND => __('This newsletter does not exist.', 'mailpoet'), |
| 261 | ]); |
| 262 | } |
| 263 | } |
| 264 | |
| 265 | public function resume($data = []) { |
| 266 | if ($this->subscribersFeature->check()) { |
| 267 | return $this->errorResponse([ |
| 268 | APIError::FORBIDDEN => __('Subscribers limit reached.', 'mailpoet'), |
| 269 | ], [], Response::STATUS_FORBIDDEN); |
| 270 | } |
| 271 | $newsletterId = (isset($data['newsletter_id']) |
| 272 | ? (int)$data['newsletter_id'] |
| 273 | : false |
| 274 | ); |
| 275 | $newsletter = $this->newsletterRepository->findOneById($newsletterId); |
| 276 | |
| 277 | if ($newsletter instanceof NewsletterEntity) { |
| 278 | $queue = $newsletter->getLastUpdatedQueue(); |
| 279 | |
| 280 | if (!$queue instanceof SendingQueueEntity) { |
| 281 | return $this->errorResponse([ |
| 282 | APIError::UNKNOWN => __('This newsletter has not been sent yet.', 'mailpoet'), |
| 283 | ]); |
| 284 | } else { |
| 285 | if ($this->timeZoneCampaignScheduler->isTimeZoneQueue($queue)) { |
| 286 | $this->timeZoneCampaignScheduler->resumeCampaign($queue); |
| 287 | } else { |
| 288 | $this->sendingQueuesRepository->resume($queue); |
| 289 | } |
| 290 | $this->triggerSending($newsletter); |
| 291 | return $this->successResponse(); |
| 292 | } |
| 293 | } else { |
| 294 | return $this->errorResponse([ |
| 295 | APIError::NOT_FOUND => __('This newsletter does not exist.', 'mailpoet'), |
| 296 | ]); |
| 297 | } |
| 298 | } |
| 299 | |
| 300 | public function pingCron() { |
| 301 | try { |
| 302 | $cronPingResponse = $this->cronHelper->pingDaemon(); |
| 303 | } catch (\Exception $e) { |
| 304 | return $this->errorResponse([ |
| 305 | APIError::UNKNOWN => $e->getMessage(), |
| 306 | ]); |
| 307 | } |
| 308 | if (!$this->cronHelper->validatePingResponse($cronPingResponse)) { |
| 309 | return $this->errorResponse([ |
| 310 | APIError::UNKNOWN => $cronPingResponse, |
| 311 | ]); |
| 312 | } |
| 313 | return $this->successResponse(); |
| 314 | } |
| 315 | |
| 316 | /** |
| 317 | * In case the newsletter was switched to sending trigger the background job immediately. |
| 318 | * This is done so that user immediately sees that email is sending and doesn't have to wait on WP Cron to start it. |
| 319 | */ |
| 320 | private function triggerSending(NewsletterEntity $newsletter): void { |
| 321 | if ( |
| 322 | $newsletter->getStatus() === NewsletterEntity::STATUS_SENDING |
| 323 | && $this->settings->get('cron_trigger.method') === CronTrigger::METHOD_ACTION_SCHEDULER |
| 324 | ) { |
| 325 | $this->actionSchedulerDaemonTriggerAction->process(); |
| 326 | } |
| 327 | } |
| 328 | } |
| 329 |