Editor
3 months ago
Embed
3 months ago
Links
4 months ago
Listing
10 months ago
Options
2 years ago
Preview
2 months ago
Renderer
2 months ago
RestApi
1 month ago
Scheduler
3 months ago
Segment
1 year ago
Sending
1 month ago
Sharing
2 months ago
Shortcodes
3 months ago
Statistics
1 month ago
ViewInBrowser
3 months ago
ApiDataSanitizer.php
3 years ago
AutomatedLatestContent.php
3 months ago
AutomaticEmailsRepository.php
3 years ago
BlockPostQuery.php
3 months ago
BulkActionController.php
3 months ago
BulkActionException.php
3 months ago
DynamicProducts.php
1 year ago
NewsletterCoupon.php
3 months ago
NewsletterDeleteController.php
2 years ago
NewsletterHtmlSanitizer.php
2 years ago
NewsletterPostsRepository.php
2 years ago
NewsletterResendController.php
4 months ago
NewsletterSaveController.php
3 months ago
NewsletterValidator.php
1 year ago
NewslettersRepository.php
1 month ago
StatusController.php
3 months ago
Url.php
3 months ago
index.php
3 years ago
NewsletterResendController.php
316 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Newsletter; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Cron\ActionScheduler\Actions\DaemonTrigger; |
| 9 | use MailPoet\Cron\CronTrigger; |
| 10 | use MailPoet\Cron\Workers\SendingQueue\SendingQueue as SendingQueueWorker; |
| 11 | use MailPoet\Entities\NewsletterEntity; |
| 12 | use MailPoet\Entities\ScheduledTaskEntity; |
| 13 | use MailPoet\Entities\ScheduledTaskSubscriberEntity; |
| 14 | use MailPoet\Entities\SendingQueueEntity; |
| 15 | use MailPoet\Entities\StatisticsNewsletterEntity; |
| 16 | use MailPoet\Entities\StatisticsOpenEntity; |
| 17 | use MailPoet\Entities\SubscriberEntity; |
| 18 | use MailPoet\Mailer\MailerFactory; |
| 19 | use MailPoet\Newsletter\Sending\ScheduledTasksRepository; |
| 20 | use MailPoet\Newsletter\Sending\SendingQueuesRepository; |
| 21 | use MailPoet\Settings\SettingsController; |
| 22 | use MailPoet\Settings\TrackingConfig; |
| 23 | use MailPoet\UnexpectedValueException; |
| 24 | use MailPoet\Util\License\Features\Subscribers as SubscribersFeature; |
| 25 | use MailPoet\WP\Functions as WPFunctions; |
| 26 | use MailPoetVendor\Carbon\Carbon; |
| 27 | use MailPoetVendor\Doctrine\DBAL\ArrayParameterType; |
| 28 | use MailPoetVendor\Doctrine\DBAL\ParameterType; |
| 29 | use MailPoetVendor\Doctrine\ORM\EntityManager; |
| 30 | |
| 31 | class NewsletterResendController { |
| 32 | const MIN_RESEND_DELAY_HOURS = 24; |
| 33 | const MAX_RESEND_DELAY_HOURS = 72; |
| 34 | |
| 35 | /** @var NewsletterSaveController */ |
| 36 | private $newsletterSaveController; |
| 37 | |
| 38 | /** @var NewsletterDeleteController */ |
| 39 | private $newsletterDeleteController; |
| 40 | |
| 41 | /** @var NewslettersRepository */ |
| 42 | private $newslettersRepository; |
| 43 | |
| 44 | /** @var EntityManager */ |
| 45 | private $entityManager; |
| 46 | |
| 47 | /** @var ScheduledTasksRepository */ |
| 48 | private $scheduledTasksRepository; |
| 49 | |
| 50 | /** @var SendingQueuesRepository */ |
| 51 | private $sendingQueuesRepository; |
| 52 | |
| 53 | /** @var WPFunctions */ |
| 54 | private $wp; |
| 55 | |
| 56 | /** @var DaemonTrigger */ |
| 57 | private $daemonTrigger; |
| 58 | |
| 59 | /** @var SettingsController */ |
| 60 | private $settings; |
| 61 | |
| 62 | /** @var SubscribersFeature */ |
| 63 | private $subscribersFeature; |
| 64 | |
| 65 | /** @var MailerFactory */ |
| 66 | private $mailerFactory; |
| 67 | |
| 68 | /** @var TrackingConfig */ |
| 69 | private $trackingConfig; |
| 70 | |
| 71 | public function __construct( |
| 72 | NewsletterSaveController $newsletterSaveController, |
| 73 | NewsletterDeleteController $newsletterDeleteController, |
| 74 | NewslettersRepository $newslettersRepository, |
| 75 | EntityManager $entityManager, |
| 76 | ScheduledTasksRepository $scheduledTasksRepository, |
| 77 | SendingQueuesRepository $sendingQueuesRepository, |
| 78 | WPFunctions $wp, |
| 79 | DaemonTrigger $daemonTrigger, |
| 80 | SettingsController $settings, |
| 81 | SubscribersFeature $subscribersFeature, |
| 82 | MailerFactory $mailerFactory, |
| 83 | TrackingConfig $trackingConfig |
| 84 | ) { |
| 85 | $this->newsletterSaveController = $newsletterSaveController; |
| 86 | $this->newsletterDeleteController = $newsletterDeleteController; |
| 87 | $this->newslettersRepository = $newslettersRepository; |
| 88 | $this->entityManager = $entityManager; |
| 89 | $this->scheduledTasksRepository = $scheduledTasksRepository; |
| 90 | $this->sendingQueuesRepository = $sendingQueuesRepository; |
| 91 | $this->wp = $wp; |
| 92 | $this->daemonTrigger = $daemonTrigger; |
| 93 | $this->settings = $settings; |
| 94 | $this->subscribersFeature = $subscribersFeature; |
| 95 | $this->mailerFactory = $mailerFactory; |
| 96 | $this->trackingConfig = $trackingConfig; |
| 97 | } |
| 98 | |
| 99 | /** |
| 100 | * Extensibility hook for premium/plan restrictions. |
| 101 | * Override or decorate this method to add per-site daily caps, |
| 102 | * plan-based limits, or other restrictions. |
| 103 | */ |
| 104 | public function canResend(NewsletterEntity $newsletter): void { |
| 105 | if (!$this->trackingConfig->isEmailTrackingEnabled()) { |
| 106 | throw UnexpectedValueException::create() |
| 107 | ->withMessage(__('Resend to non-openers requires email tracking to be enabled.', 'mailpoet')); |
| 108 | } |
| 109 | |
| 110 | if ($newsletter->getType() !== NewsletterEntity::TYPE_STANDARD) { |
| 111 | throw UnexpectedValueException::create() |
| 112 | ->withMessage(__('Only standard newsletters can be resent.', 'mailpoet')); |
| 113 | } |
| 114 | |
| 115 | if ($newsletter->getStatus() !== NewsletterEntity::STATUS_SENT) { |
| 116 | throw UnexpectedValueException::create() |
| 117 | ->withMessage(__('Only sent newsletters can be resent.', 'mailpoet')); |
| 118 | } |
| 119 | |
| 120 | $queue = $newsletter->getLatestQueue(); |
| 121 | if ($queue && $queue->getCountToProcess() > 0) { |
| 122 | throw UnexpectedValueException::create() |
| 123 | ->withMessage(__('This email is still being sent. Wait until sending is complete.', 'mailpoet')); |
| 124 | } |
| 125 | |
| 126 | if ($newsletter->getParent() !== null) { |
| 127 | throw UnexpectedValueException::create() |
| 128 | ->withMessage(__('A resent email cannot be resent again.', 'mailpoet')); |
| 129 | } |
| 130 | |
| 131 | if (!$newsletter->getChildren()->isEmpty()) { |
| 132 | throw UnexpectedValueException::create() |
| 133 | ->withMessage(__('This email has already been resent.', 'mailpoet')); |
| 134 | } |
| 135 | |
| 136 | $sentAt = $newsletter->getSentAt(); |
| 137 | if (!$sentAt) { |
| 138 | throw UnexpectedValueException::create() |
| 139 | ->withMessage(__('This email has no sent date and cannot be resent.', 'mailpoet')); |
| 140 | } |
| 141 | |
| 142 | $hoursSinceSent = Carbon::now()->diffInHours(Carbon::createFromTimestamp($sentAt->getTimestamp()), true); |
| 143 | if ($hoursSinceSent < self::MIN_RESEND_DELAY_HOURS) { |
| 144 | throw UnexpectedValueException::create() |
| 145 | ->withMessage(__('You can resend this email at least 1 day after it was sent.', 'mailpoet')); |
| 146 | } |
| 147 | if ($hoursSinceSent > self::MAX_RESEND_DELAY_HOURS) { |
| 148 | throw UnexpectedValueException::create() |
| 149 | ->withMessage(__('You can only resend this email within 3 days of sending it.', 'mailpoet')); |
| 150 | } |
| 151 | |
| 152 | if ($this->subscribersFeature->check()) { |
| 153 | throw UnexpectedValueException::create() |
| 154 | ->withMessage(__('Subscribers limit reached.', 'mailpoet')); |
| 155 | } |
| 156 | |
| 157 | try { |
| 158 | $this->mailerFactory->getDefaultMailer(); |
| 159 | } catch (\Exception $e) { |
| 160 | throw UnexpectedValueException::create() |
| 161 | ->withMessage($e->getMessage()); |
| 162 | } |
| 163 | } |
| 164 | |
| 165 | public function resendToNonOpeners(NewsletterEntity $newsletter, string $subject): NewsletterEntity { |
| 166 | $this->canResend($newsletter); |
| 167 | |
| 168 | $subject = trim($subject); |
| 169 | if ($subject === '') { |
| 170 | throw UnexpectedValueException::create() |
| 171 | ->withMessage(__('Subject line is required.', 'mailpoet')); |
| 172 | } |
| 173 | |
| 174 | $originalSubject = trim($newsletter->getSubject()); |
| 175 | if (strcasecmp($subject, $originalSubject) === 0) { |
| 176 | throw UnexpectedValueException::create() |
| 177 | ->withMessage(__('The subject line must be different from the original email.', 'mailpoet')); |
| 178 | } |
| 179 | |
| 180 | $nonOpenerIds = $this->getNonOpenerIds($newsletter); |
| 181 | if (empty($nonOpenerIds)) { |
| 182 | throw UnexpectedValueException::create() |
| 183 | ->withMessage(__('All recipients have already opened this email.', 'mailpoet')); |
| 184 | } |
| 185 | |
| 186 | $duplicate = $this->newsletterSaveController->duplicate($newsletter); |
| 187 | $duplicate->setParent($newsletter); |
| 188 | $duplicate->setSubject($subject); |
| 189 | |
| 190 | $wpPostId = $duplicate->getWpPostId(); |
| 191 | if ($wpPostId) { |
| 192 | $this->wp->wpUpdatePost([ |
| 193 | 'ID' => $wpPostId, |
| 194 | 'post_title' => $subject, |
| 195 | ]); |
| 196 | } |
| 197 | |
| 198 | $this->newslettersRepository->flush(); |
| 199 | |
| 200 | try { |
| 201 | $scheduledTask = new ScheduledTaskEntity(); |
| 202 | $scheduledTask->setType(SendingQueueWorker::TASK_TYPE); |
| 203 | $scheduledTask->setPriority(ScheduledTaskEntity::PRIORITY_MEDIUM); |
| 204 | $scheduledTask->setStatus(null); |
| 205 | $this->scheduledTasksRepository->persist($scheduledTask); |
| 206 | $this->scheduledTasksRepository->flush(); |
| 207 | |
| 208 | $sendingQueue = new SendingQueueEntity(); |
| 209 | $sendingQueue->setNewsletter($duplicate); |
| 210 | $sendingQueue->setTask($scheduledTask); |
| 211 | $this->sendingQueuesRepository->persist($sendingQueue); |
| 212 | $this->sendingQueuesRepository->flush(); |
| 213 | $this->newslettersRepository->refresh($duplicate); |
| 214 | |
| 215 | $insertedCount = $this->addSubscribersToTask($scheduledTask, $nonOpenerIds); |
| 216 | |
| 217 | if ($insertedCount === 0) { |
| 218 | throw UnexpectedValueException::create() |
| 219 | ->withMessage(__('No eligible recipients found. All non-openers have since unsubscribed, bounced, or left the original segments.', 'mailpoet')); |
| 220 | } |
| 221 | |
| 222 | $this->sendingQueuesRepository->updateCounts($sendingQueue); |
| 223 | $duplicate->setStatus(NewsletterEntity::STATUS_SENDING); |
| 224 | $this->newslettersRepository->flush(); |
| 225 | } catch (\Throwable $e) { |
| 226 | $this->cleanupDuplicate($duplicate, $scheduledTask ?? null, $sendingQueue ?? null); |
| 227 | throw $e; |
| 228 | } |
| 229 | |
| 230 | if ($this->settings->get('cron_trigger.method') === CronTrigger::METHOD_ACTION_SCHEDULER) { |
| 231 | $this->daemonTrigger->process(); |
| 232 | } |
| 233 | |
| 234 | return $duplicate; |
| 235 | } |
| 236 | |
| 237 | private function cleanupDuplicate( |
| 238 | NewsletterEntity $duplicate, |
| 239 | ?ScheduledTaskEntity $task, |
| 240 | ?SendingQueueEntity $queue |
| 241 | ): void { |
| 242 | $duplicateId = $duplicate->getId(); |
| 243 | if ($duplicateId) { |
| 244 | $this->newsletterDeleteController->bulkDelete([$duplicateId]); |
| 245 | return; |
| 246 | } |
| 247 | if ($queue) { |
| 248 | $this->entityManager->remove($queue); |
| 249 | } |
| 250 | if ($task) { |
| 251 | $this->entityManager->remove($task); |
| 252 | } |
| 253 | $this->entityManager->flush(); |
| 254 | } |
| 255 | |
| 256 | /** @return int[] */ |
| 257 | private function getNonOpenerIds(NewsletterEntity $newsletter): array { |
| 258 | $statisticsNewsletterTable = $this->entityManager->getClassMetadata(StatisticsNewsletterEntity::class)->getTableName(); |
| 259 | $statisticsOpenTable = $this->entityManager->getClassMetadata(StatisticsOpenEntity::class)->getTableName(); |
| 260 | |
| 261 | $connection = $this->entityManager->getConnection(); |
| 262 | |
| 263 | $result = $connection->executeQuery( |
| 264 | "SELECT DISTINCT sn.subscriber_id |
| 265 | FROM $statisticsNewsletterTable sn |
| 266 | LEFT JOIN $statisticsOpenTable so |
| 267 | ON so.newsletter_id = sn.newsletter_id |
| 268 | AND so.subscriber_id = sn.subscriber_id |
| 269 | WHERE sn.newsletter_id = ? |
| 270 | AND so.id IS NULL", |
| 271 | [ |
| 272 | $newsletter->getId(), |
| 273 | ], |
| 274 | [ |
| 275 | ParameterType::INTEGER, |
| 276 | ] |
| 277 | ); |
| 278 | |
| 279 | /** @var list<string|int> $column */ |
| 280 | $column = $result->fetchFirstColumn(); |
| 281 | return array_map('intval', $column); |
| 282 | } |
| 283 | |
| 284 | /** @param int[] $subscriberIds */ |
| 285 | private function addSubscribersToTask(ScheduledTaskEntity $task, array $subscriberIds): int { |
| 286 | $scheduledTaskSubscriberTable = $this->entityManager->getClassMetadata(ScheduledTaskSubscriberEntity::class)->getTableName(); |
| 287 | $subscriberTable = $this->entityManager->getClassMetadata(SubscriberEntity::class)->getTableName(); |
| 288 | |
| 289 | $connection = $this->entityManager->getConnection(); |
| 290 | |
| 291 | $result = $connection->executeQuery( |
| 292 | "INSERT IGNORE INTO $scheduledTaskSubscriberTable |
| 293 | (task_id, subscriber_id, processed) |
| 294 | SELECT DISTINCT ? as task_id, subscribers.`id` as subscriber_id, ? as processed |
| 295 | FROM $subscriberTable subscribers |
| 296 | WHERE subscribers.`deleted_at` IS NULL |
| 297 | AND subscribers.`status` = ? |
| 298 | AND subscribers.`id` IN (?)", |
| 299 | [ |
| 300 | $task->getId(), |
| 301 | ScheduledTaskSubscriberEntity::STATUS_UNPROCESSED, |
| 302 | SubscriberEntity::STATUS_SUBSCRIBED, |
| 303 | $subscriberIds, |
| 304 | ], |
| 305 | [ |
| 306 | ParameterType::INTEGER, |
| 307 | ParameterType::INTEGER, |
| 308 | ParameterType::STRING, |
| 309 | ArrayParameterType::INTEGER, |
| 310 | ] |
| 311 | ); |
| 312 | |
| 313 | return $result->rowCount(); |
| 314 | } |
| 315 | } |
| 316 |