AutomatedEmails.php
3 months ago
NewsletterLinkRepository.php
3 months ago
Scheduler.php
3 months ago
StatsNotificationsRepository.php
2 years ago
Worker.php
1 day ago
index.php
3 years ago
Worker.php
255 lines
| 1 | <?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing |
| 2 | |
| 3 | namespace MailPoet\Cron\Workers\StatsNotifications; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Config\Renderer; |
| 9 | use MailPoet\Config\ServicesChecker; |
| 10 | use MailPoet\Cron\CronHelper; |
| 11 | use MailPoet\EmailEditor\Integrations\MailPoet\PersonalizationTags\PersonalizationTagLinkResolver; |
| 12 | use MailPoet\Entities\NewsletterEntity; |
| 13 | use MailPoet\Entities\NewsletterLinkEntity; |
| 14 | use MailPoet\Entities\ScheduledTaskEntity; |
| 15 | use MailPoet\Entities\SendingQueueEntity; |
| 16 | use MailPoet\Entities\StatsNotificationEntity; |
| 17 | use MailPoet\Mailer\MailerFactory; |
| 18 | use MailPoet\Mailer\MetaInfo; |
| 19 | use MailPoet\Newsletter\Statistics\NewsletterStatisticsRepository; |
| 20 | use MailPoet\Settings\SettingsController; |
| 21 | use MailPoet\Subscribers\SubscribersRepository; |
| 22 | use MailPoet\Util\License\Features\Subscribers as SubscribersFeature; |
| 23 | use MailPoet\WP\Functions as WPFunctions; |
| 24 | use MailPoet\WPCOM\DotcomHelperFunctions; |
| 25 | use MailPoetVendor\Carbon\Carbon; |
| 26 | use MailPoetVendor\Doctrine\ORM\EntityManager; |
| 27 | |
| 28 | class Worker { |
| 29 | |
| 30 | const TASK_TYPE = 'stats_notification'; |
| 31 | const SETTINGS_KEY = 'stats_notifications'; |
| 32 | const BATCH_SIZE = 5; |
| 33 | |
| 34 | /** @var Renderer */ |
| 35 | private $renderer; |
| 36 | |
| 37 | /** @var MailerFactory */ |
| 38 | private $mailerFactory; |
| 39 | |
| 40 | /** @var SettingsController */ |
| 41 | private $settings; |
| 42 | |
| 43 | /** @var CronHelper */ |
| 44 | private $cronHelper; |
| 45 | |
| 46 | /** @var MetaInfo */ |
| 47 | private $mailerMetaInfo; |
| 48 | |
| 49 | /** @var StatsNotificationsRepository */ |
| 50 | private $repository; |
| 51 | |
| 52 | /** @var EntityManager */ |
| 53 | private $entityManager; |
| 54 | |
| 55 | /** @var NewsletterLinkRepository */ |
| 56 | private $newsletterLinkRepository; |
| 57 | |
| 58 | /** @var NewsletterStatisticsRepository */ |
| 59 | private $newsletterStatisticsRepository; |
| 60 | |
| 61 | /** @var SubscribersFeature */ |
| 62 | private $subscribersFeature; |
| 63 | |
| 64 | /** @var SubscribersRepository */ |
| 65 | private $subscribersRepository; |
| 66 | |
| 67 | /** @var ServicesChecker */ |
| 68 | private $servicesChecker; |
| 69 | |
| 70 | /** @var DotcomHelperFunctions */ |
| 71 | private $dotcomHelperFunctions; |
| 72 | |
| 73 | private PersonalizationTagLinkResolver $personalizationTagLinkResolver; |
| 74 | |
| 75 | public function __construct( |
| 76 | MailerFactory $mailerFactory, |
| 77 | Renderer $renderer, |
| 78 | SettingsController $settings, |
| 79 | CronHelper $cronHelper, |
| 80 | MetaInfo $mailerMetaInfo, |
| 81 | StatsNotificationsRepository $repository, |
| 82 | NewsletterLinkRepository $newsletterLinkRepository, |
| 83 | NewsletterStatisticsRepository $newsletterStatisticsRepository, |
| 84 | EntityManager $entityManager, |
| 85 | SubscribersFeature $subscribersFeature, |
| 86 | SubscribersRepository $subscribersRepository, |
| 87 | ServicesChecker $servicesChecker, |
| 88 | DotcomHelperFunctions $dotcomHelperFunctions, |
| 89 | PersonalizationTagLinkResolver $personalizationTagLinkResolver |
| 90 | ) { |
| 91 | $this->renderer = $renderer; |
| 92 | $this->mailerFactory = $mailerFactory; |
| 93 | $this->settings = $settings; |
| 94 | $this->cronHelper = $cronHelper; |
| 95 | $this->mailerMetaInfo = $mailerMetaInfo; |
| 96 | $this->repository = $repository; |
| 97 | $this->entityManager = $entityManager; |
| 98 | $this->newsletterLinkRepository = $newsletterLinkRepository; |
| 99 | $this->newsletterStatisticsRepository = $newsletterStatisticsRepository; |
| 100 | $this->subscribersFeature = $subscribersFeature; |
| 101 | $this->subscribersRepository = $subscribersRepository; |
| 102 | $this->servicesChecker = $servicesChecker; |
| 103 | $this->dotcomHelperFunctions = $dotcomHelperFunctions; |
| 104 | $this->personalizationTagLinkResolver = $personalizationTagLinkResolver; |
| 105 | } |
| 106 | |
| 107 | /** @throws \Exception */ |
| 108 | public function process($timer = false) { |
| 109 | $timer = $timer ?: microtime(true); |
| 110 | $settings = $this->settings->get(self::SETTINGS_KEY); |
| 111 | // Cleanup potential orphaned task created due bug MAILPOET-3015 |
| 112 | $this->repository->deleteOrphanedScheduledTasks(); |
| 113 | foreach ($this->repository->findScheduled(self::BATCH_SIZE) as $statsNotificationEntity) { |
| 114 | try { |
| 115 | $extraParams = [ |
| 116 | 'meta' => $this->mailerMetaInfo->getStatsNotificationMetaInfo(), |
| 117 | ]; |
| 118 | $this->mailerFactory->getDefaultMailer()->send($this->constructNewsletter($statsNotificationEntity, $settings), $settings['address'], $extraParams); |
| 119 | } catch (\Exception $e) { |
| 120 | if (WP_DEBUG) { |
| 121 | throw $e; |
| 122 | } |
| 123 | } finally { |
| 124 | $task = $statsNotificationEntity->getTask(); |
| 125 | if ($task instanceof ScheduledTaskEntity) { |
| 126 | $this->markTaskAsFinished($task); |
| 127 | } |
| 128 | } |
| 129 | $this->cronHelper->enforceExecutionLimit($timer); |
| 130 | } |
| 131 | } |
| 132 | |
| 133 | private function constructNewsletter(StatsNotificationEntity $statsNotificationEntity, array $settings) { |
| 134 | $newsletter = $statsNotificationEntity->getNewsletter(); |
| 135 | if (!$newsletter instanceof NewsletterEntity) { |
| 136 | throw new \RuntimeException('Missing newsletter entity for statistic notification.'); |
| 137 | } |
| 138 | $link = $this->newsletterLinkRepository->findTopLinkForNewsletter((int)$newsletter->getId()); |
| 139 | $sendingQueue = $newsletter->getLatestQueue(); |
| 140 | if (!$sendingQueue instanceof SendingQueueEntity) { |
| 141 | throw new \RuntimeException('Missing sending queue entity for statistic notification.'); |
| 142 | } |
| 143 | $context = $this->prepareContext($newsletter, $sendingQueue, $link, $settings); |
| 144 | $subject = $sendingQueue->getNewsletterRenderedSubject(); |
| 145 | if ($this->dotcomHelperFunctions->isGarden()) { |
| 146 | // translators: %s is the name of the email campaign. |
| 147 | $emailSubject = sprintf(__('Campaign performance summary: %s', 'mailpoet'), $subject); |
| 148 | } else { |
| 149 | // translators: %s is the subject of the email. |
| 150 | $emailSubject = sprintf(_x('Stats for email %s', 'title of an automatic email containing statistics (newsletter open rate, click rate, etc)', 'mailpoet'), $subject); |
| 151 | } |
| 152 | return [ |
| 153 | 'subject' => $emailSubject, |
| 154 | 'body' => [ |
| 155 | 'html' => $this->renderer->render('emails/statsNotification.html', $context), |
| 156 | 'text' => $this->renderer->render('emails/statsNotification.txt', $context), |
| 157 | ], |
| 158 | ]; |
| 159 | } |
| 160 | |
| 161 | private function prepareContext(NewsletterEntity $newsletter, SendingQueueEntity $sendingQueue, ?NewsletterLinkEntity $link = null, array $settings = []) { |
| 162 | $statistics = $this->newsletterStatisticsRepository->getStatistics($newsletter); |
| 163 | $totalSentCount = $statistics->getTotalSentCount() ?: 1; |
| 164 | $clicked = ($statistics->getClickCount() * 100) / $totalSentCount; |
| 165 | $opened = ($statistics->getOpenCount() * 100) / $totalSentCount; |
| 166 | $machineOpened = ($statistics->getMachineOpenCount() * 100) / $totalSentCount; |
| 167 | $unsubscribed = ($statistics->getUnsubscribeCount() * 100) / $totalSentCount; |
| 168 | $bounced = ($statistics->getBounceCount() * 100) / $totalSentCount; |
| 169 | $subject = $sendingQueue->getNewsletterRenderedSubject(); |
| 170 | $subscribersCount = $this->subscribersRepository->getTotalSubscribers(); |
| 171 | $hasValidApiKey = $this->subscribersFeature->hasValidApiKey(); |
| 172 | $context = [ |
| 173 | 'subject' => $subject, |
| 174 | 'preheader' => sprintf( |
| 175 | // translators: %1$s is the percentage of clicks, %2$s the percentage of opens and %3$s the number of unsubscribes. |
| 176 | _x( |
| 177 | '%1$s%% clicks, %2$s%% opens, %3$s%% unsubscribes in a nutshell.', |
| 178 | 'newsletter open rate, click rate and unsubscribe rate', |
| 179 | 'mailpoet' |
| 180 | ), |
| 181 | number_format($clicked, 2), |
| 182 | number_format($opened, 2), |
| 183 | number_format($unsubscribed, 2) |
| 184 | ), |
| 185 | 'topLinkClicks' => 0, |
| 186 | 'linkSettings' => WPFunctions::get()->applyFilters( |
| 187 | 'mailpoet_stats_notification_link_settings', |
| 188 | WPFunctions::get()->getSiteUrl(null, '/wp-admin/admin.php?page=mailpoet-settings#basics') |
| 189 | ), |
| 190 | 'linkStats' => WPFunctions::get()->applyFilters( |
| 191 | 'mailpoet_stats_notification_link_stats', |
| 192 | WPFunctions::get()->getSiteUrl(null, '/wp-admin/admin.php?page=mailpoet-newsletters&stats=' . $newsletter->getId()), |
| 193 | $newsletter->getId() |
| 194 | ), |
| 195 | 'clicked' => $clicked, |
| 196 | 'opened' => $opened, |
| 197 | 'machineOpened' => $machineOpened, |
| 198 | 'unsubscribed' => $unsubscribed, |
| 199 | 'bounced' => $bounced, |
| 200 | 'subscribersLimitReached' => $this->subscribersFeature->check(), |
| 201 | 'hasValidApiKey' => $hasValidApiKey, |
| 202 | 'subscribersLimit' => $this->subscribersFeature->getSubscribersLimit(), |
| 203 | 'upgradeNowLink' => $hasValidApiKey |
| 204 | ? 'https://account.mailpoet.com/orders/upgrade/' . $this->servicesChecker->generatePartialApiKey() |
| 205 | : 'https://account.mailpoet.com/?s=' . ($subscribersCount + 1), |
| 206 | ]; |
| 207 | if ($link) { |
| 208 | $context['topLinkClicks'] = $link->getTotalClicksCount(); |
| 209 | $mappings = self::getShortcodeLinksMapping(); |
| 210 | $context['topLink'] = $mappings[$link->getUrl()] |
| 211 | ?? $this->personalizationTagLinkResolver->getDisplayName($link->getUrl()) |
| 212 | ?? $link->getUrl(); |
| 213 | } |
| 214 | $context['blogName'] = WPFunctions::get()->getBloginfo('name'); |
| 215 | $context['recipientFirstName'] = $this->getRecipientFirstName($settings['address'] ?? ''); |
| 216 | return $context; |
| 217 | } |
| 218 | |
| 219 | private function getRecipientFirstName(string $email): string { |
| 220 | if (empty($email)) { |
| 221 | return ''; |
| 222 | } |
| 223 | $user = WPFunctions::get()->getUserBy('email', $email); |
| 224 | if (!$user) { |
| 225 | return ''; |
| 226 | } |
| 227 | $firstName = $user->first_name; // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps |
| 228 | if (!empty($firstName)) { |
| 229 | return $firstName; |
| 230 | } |
| 231 | $displayName = $user->display_name; // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps |
| 232 | return !empty($displayName) ? $displayName : ''; |
| 233 | } |
| 234 | |
| 235 | private function markTaskAsFinished(ScheduledTaskEntity $task) { |
| 236 | $task->setStatus(ScheduledTaskEntity::STATUS_COMPLETED); |
| 237 | $task->setProcessedAt(Carbon::now()->millisecond(0)); |
| 238 | $task->setScheduledAt(null); |
| 239 | $this->entityManager->flush(); |
| 240 | } |
| 241 | |
| 242 | /** |
| 243 | * Labels for legacy shortcode system links. Block-email system links are stored as |
| 244 | * personalization tag tokens and labelled with the tag name instead. |
| 245 | */ |
| 246 | public static function getShortcodeLinksMapping() { |
| 247 | return [ |
| 248 | NewsletterLinkEntity::UNSUBSCRIBE_LINK_SHORT_CODE => __('Unsubscribe link', 'mailpoet'), |
| 249 | NewsletterLinkEntity::INSTANT_UNSUBSCRIBE_LINK_SHORT_CODE => __('Unsubscribe link (without confirmation)', 'mailpoet'), |
| 250 | '[link:subscription_manage_url]' => __('Manage subscription link', 'mailpoet'), |
| 251 | '[link:newsletter_view_in_browser_url]' => __('View in browser link', 'mailpoet'), |
| 252 | ]; |
| 253 | } |
| 254 | } |
| 255 |