Clicks.php
2 days ago
Opens.php
1 month ago
PageViewCookie.php
3 months ago
SubscriberActivityTracker.php
1 month ago
SubscriberCookie.php
3 months ago
SubscriberHandler.php
1 year ago
Unsubscribes.php
3 months ago
WooCommercePurchases.php
2 years ago
index.php
3 years ago
Clicks.php
246 lines
| 1 | <?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing |
| 2 | |
| 3 | namespace MailPoet\Statistics\Track; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\EmailEditor\Integrations\MailPoet\PersonalizationTags\PersonalizationTagLinkResolver; |
| 9 | use MailPoet\Entities\NewsletterEntity; |
| 10 | use MailPoet\Entities\NewsletterLinkEntity; |
| 11 | use MailPoet\Entities\SendingQueueEntity; |
| 12 | use MailPoet\Entities\StatisticsClickEntity; |
| 13 | use MailPoet\Entities\SubscriberEntity; |
| 14 | use MailPoet\Entities\UserAgentEntity; |
| 15 | use MailPoet\Newsletter\Shortcodes\Categories\Link as LinkShortcodeCategory; |
| 16 | use MailPoet\Newsletter\Shortcodes\Shortcodes; |
| 17 | use MailPoet\Settings\TrackingConfig; |
| 18 | use MailPoet\Statistics\StatisticsClicksRepository; |
| 19 | use MailPoet\Statistics\UserAgentsRepository; |
| 20 | use MailPoet\Subscribers\SubscribersRepository; |
| 21 | use MailPoet\Subscribers\TrackingConsentController; |
| 22 | use MailPoet\Util\Cookies; |
| 23 | use MailPoet\Util\Request; |
| 24 | use MailPoet\WP\Functions as WPFunctions; |
| 25 | |
| 26 | class Clicks { |
| 27 | |
| 28 | /** The link whose whole purpose is to switch tracking off. Its own click is never recorded. */ |
| 29 | const TRACKING_OPT_OUT_SHORTCODE = '[link:subscription_tracking_opt_out_url]'; |
| 30 | |
| 31 | const REVENUE_TRACKING_COOKIE_NAME = 'mailpoet_revenue_tracking'; |
| 32 | const REVENUE_TRACKING_COOKIE_EXPIRY = 60 * 60 * 24 * 14; |
| 33 | |
| 34 | /** @var Cookies */ |
| 35 | private $cookies; |
| 36 | |
| 37 | /** @var SubscriberCookie */ |
| 38 | private $subscriberCookie; |
| 39 | |
| 40 | /** @var Shortcodes */ |
| 41 | private $shortcodes; |
| 42 | |
| 43 | /** @var LinkShortcodeCategory */ |
| 44 | private $linkShortcodeCategory; |
| 45 | |
| 46 | /** @var Opens */ |
| 47 | private $opens; |
| 48 | |
| 49 | /** @var StatisticsClicksRepository */ |
| 50 | private $statisticsClicksRepository; |
| 51 | |
| 52 | /** @var UserAgentsRepository */ |
| 53 | private $userAgentsRepository; |
| 54 | |
| 55 | /** @var SubscribersRepository */ |
| 56 | private $subscribersRepository; |
| 57 | |
| 58 | /** @var TrackingConfig */ |
| 59 | private $trackingConfig; |
| 60 | |
| 61 | /** @var Request */ |
| 62 | private $request; |
| 63 | |
| 64 | /** @var TrackingConsentController */ |
| 65 | private $trackingConsentController; |
| 66 | |
| 67 | private PersonalizationTagLinkResolver $linkResolver; |
| 68 | |
| 69 | public function __construct( |
| 70 | Cookies $cookies, |
| 71 | SubscriberCookie $subscriberCookie, |
| 72 | Shortcodes $shortcodes, |
| 73 | Opens $opens, |
| 74 | StatisticsClicksRepository $statisticsClicksRepository, |
| 75 | UserAgentsRepository $userAgentsRepository, |
| 76 | LinkShortcodeCategory $linkShortcodeCategory, |
| 77 | SubscribersRepository $subscribersRepository, |
| 78 | TrackingConfig $trackingConfig, |
| 79 | Request $request, |
| 80 | TrackingConsentController $trackingConsentController, |
| 81 | PersonalizationTagLinkResolver $linkResolver |
| 82 | ) { |
| 83 | $this->cookies = $cookies; |
| 84 | $this->subscriberCookie = $subscriberCookie; |
| 85 | $this->shortcodes = $shortcodes; |
| 86 | $this->linkShortcodeCategory = $linkShortcodeCategory; |
| 87 | $this->opens = $opens; |
| 88 | $this->statisticsClicksRepository = $statisticsClicksRepository; |
| 89 | $this->userAgentsRepository = $userAgentsRepository; |
| 90 | $this->subscribersRepository = $subscribersRepository; |
| 91 | $this->trackingConfig = $trackingConfig; |
| 92 | $this->request = $request; |
| 93 | $this->trackingConsentController = $trackingConsentController; |
| 94 | $this->linkResolver = $linkResolver; |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * @param \stdClass|null $data |
| 99 | */ |
| 100 | public function track($data) { |
| 101 | if (!$data || empty($data->link)) { |
| 102 | return $this->abort(); |
| 103 | } |
| 104 | /** @var SubscriberEntity $subscriber */ |
| 105 | $subscriber = $data->subscriber; |
| 106 | /** @var SendingQueueEntity $queue */ |
| 107 | $queue = $data->queue; |
| 108 | /** @var NewsletterEntity $newsletter */ |
| 109 | $newsletter = $data->newsletter; |
| 110 | /** @var NewsletterLinkEntity $link */ |
| 111 | $link = $data->link; |
| 112 | $wpUserPreview = ($data->preview && ($subscriber->isWPUser())); |
| 113 | $trackingAllowed = $this->trackingConsentController->isTrackingAllowed($subscriber); |
| 114 | // The opt-out link exists to stop tracking, so clicking it is never itself |
| 115 | // recorded, even for a subscriber we are otherwise allowed to track. Only |
| 116 | // the recording is skipped; the redirect below still runs. |
| 117 | $isTrackingOptOutLink = $link->getUrl() === self::TRACKING_OPT_OUT_SHORTCODE; |
| 118 | // log statistics only if the action did not come from |
| 119 | // a WP user previewing the newsletter |
| 120 | // No tracking consent (CNIL/Garante): skip all recording (stats, cookies, |
| 121 | // engagement) but keep the redirect below. |
| 122 | if (!$wpUserPreview && $trackingAllowed && !$isTrackingOptOutLink) { |
| 123 | $userAgent = !empty($data->userAgent) ? $this->userAgentsRepository->findOrCreate($data->userAgent) : null; |
| 124 | $statisticsClicks = $this->statisticsClicksRepository->createOrUpdateClickCount( |
| 125 | $link, |
| 126 | $subscriber, |
| 127 | $newsletter, |
| 128 | $queue, |
| 129 | $userAgent |
| 130 | ); |
| 131 | if ( |
| 132 | $userAgent instanceof UserAgentEntity && |
| 133 | ($userAgent->getUserAgentType() === UserAgentEntity::USER_AGENT_TYPE_HUMAN |
| 134 | || $statisticsClicks->getUserAgentType() === UserAgentEntity::USER_AGENT_TYPE_MACHINE) |
| 135 | ) { |
| 136 | $statisticsClicks->setUserAgent($userAgent); |
| 137 | $statisticsClicks->setUserAgentType($userAgent->getUserAgentType()); |
| 138 | } |
| 139 | $this->statisticsClicksRepository->flush(); |
| 140 | $this->sendRevenueCookie($statisticsClicks); |
| 141 | |
| 142 | $subscriberId = $subscriber->getId(); |
| 143 | if ($subscriberId) { |
| 144 | $this->subscriberCookie->setSubscriberId($subscriberId); |
| 145 | } |
| 146 | |
| 147 | // track open event |
| 148 | $this->opens->track($data, $displayImage = false); |
| 149 | // Update engagement date |
| 150 | $this->subscribersRepository->maybeUpdateLastClickAt($subscriber); |
| 151 | } |
| 152 | $url = $this->processUrl($link->getUrl(), $newsletter, $subscriber, $queue, $wpUserPreview); |
| 153 | if ($trackingAllowed) { |
| 154 | // Consumers of this hook (e.g. automation "clicked link" triggers) use |
| 155 | // clicks for follow-up personalization — exactly what consent covers. |
| 156 | do_action('mailpoet_link_clicked', $link, $subscriber, $wpUserPreview); |
| 157 | } |
| 158 | $this->redirectToUrl($url); |
| 159 | } |
| 160 | |
| 161 | private function sendRevenueCookie(StatisticsClickEntity $clicks) { |
| 162 | if ($this->trackingConfig->isCookieTrackingEnabled()) { |
| 163 | $this->cookies->set( |
| 164 | self::REVENUE_TRACKING_COOKIE_NAME, |
| 165 | [ |
| 166 | 'statistics_clicks' => $clicks->getId(), |
| 167 | 'created_at' => time(), |
| 168 | ], |
| 169 | [ |
| 170 | 'expires' => time() + self::REVENUE_TRACKING_COOKIE_EXPIRY, |
| 171 | 'path' => '/', |
| 172 | ] |
| 173 | ); |
| 174 | } |
| 175 | } |
| 176 | |
| 177 | public function processUrl( |
| 178 | string $url, |
| 179 | NewsletterEntity $newsletter, |
| 180 | SubscriberEntity $subscriber, |
| 181 | SendingQueueEntity $queue, |
| 182 | bool $wpUserPreview |
| 183 | ) { |
| 184 | if ($this->linkResolver->isTokenUrl($url)) { |
| 185 | // A link stored as a personalization tag token; its destination only exists per recipient. |
| 186 | $resolvedUrl = $this->linkResolver->resolve($url, $newsletter, $subscriber, $queue, $wpUserPreview); |
| 187 | if ($resolvedUrl === null) { |
| 188 | $this->abort(); |
| 189 | return $url; |
| 190 | } |
| 191 | return $this->appendRequestMethod($resolvedUrl); |
| 192 | } |
| 193 | if (preg_match('/\[link:(?P<action>.*?)\]/', $url, $shortcode)) { |
| 194 | if (empty($shortcode['action'])) $this->abort(); |
| 195 | $processedUrl = $this->linkShortcodeCategory->processShortcodeAction( |
| 196 | $shortcode[0], |
| 197 | $newsletter, |
| 198 | $subscriber, |
| 199 | $queue, |
| 200 | $wpUserPreview |
| 201 | ); |
| 202 | // If shortcode was not processed, return original shortcode unchanged |
| 203 | if ($processedUrl === null) { |
| 204 | return $shortcode[0]; |
| 205 | } |
| 206 | $url = $this->appendRequestMethod($processedUrl); |
| 207 | } else { |
| 208 | $this->shortcodes->setQueue($queue); |
| 209 | $this->shortcodes->setNewsletter($newsletter); |
| 210 | $this->shortcodes->setSubscriber($subscriber); |
| 211 | $this->shortcodes->setWpUserPreview($wpUserPreview); |
| 212 | $url = $this->shortcodes->replace($url); |
| 213 | } |
| 214 | return $url; |
| 215 | } |
| 216 | |
| 217 | /** |
| 218 | * The unsubscribe actions need to know the original request method. |
| 219 | */ |
| 220 | private function appendRequestMethod(string $url): string { |
| 221 | if (!$this->request->isPost() || !$url) { |
| 222 | return $url; |
| 223 | } |
| 224 | $fragment = ''; |
| 225 | $hashPosition = strpos($url, '#'); |
| 226 | if ($hashPosition !== false) { |
| 227 | $fragment = substr($url, $hashPosition); |
| 228 | $url = substr($url, 0, $hashPosition); |
| 229 | } |
| 230 | return $url . (parse_url($url, PHP_URL_QUERY) ? '&' : '?') . 'request_method=POST' . $fragment; |
| 231 | } |
| 232 | |
| 233 | public function abort() { |
| 234 | global $wp_query;// phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps |
| 235 | WPFunctions::get()->statusHeader(404); |
| 236 | $wp_query->set_404();// phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps |
| 237 | WPFunctions::get()->getTemplatePart((string)404); |
| 238 | exit; |
| 239 | } |
| 240 | |
| 241 | public function redirectToUrl($url) { |
| 242 | header('Location: ' . $url, true, 302); |
| 243 | exit; |
| 244 | } |
| 245 | } |
| 246 |