Emails
2 months ago
Integrations
2 months ago
MultichannelMarketing
2 years ago
TransactionalEmails
10 months ago
WooCommerceBookings
1 month ago
WooCommerceSubscriptions
2 months ago
CouponPreProcessor.php
2 months ago
Emails.php
8 months ago
Helper.php
1 month ago
MailPoetTask.php
2 years ago
NonPersistablePreviewData.php
1 month ago
OrderAttributionFields.php
1 month ago
OrderAttributionRevenueReader.php
2 weeks ago
OrderAttributionWriter.php
1 month ago
RandomCouponCodeGenerator.php
2 months ago
Settings.php
1 year ago
SubscriberEngagement.php
3 years ago
Subscription.php
2 months ago
Tracker.php
2 years ago
TransactionalEmailHooks.php
1 year ago
TransactionalEmails.php
1 year ago
WooSystemInfo.php
1 month ago
WooSystemInfoController.php
1 year ago
index.php
3 years ago
OrderAttributionWriter.php
280 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\WooCommerce; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use Automattic\WooCommerce\Utilities\FeaturesUtil; |
| 9 | use MailPoet\Entities\StatisticsClickEntity; |
| 10 | use MailPoet\Entities\SubscriberEntity; |
| 11 | use MailPoet\Settings\TrackingConfig; |
| 12 | use MailPoet\Statistics\StatisticsClicksRepository; |
| 13 | use MailPoet\Statistics\Track\Clicks; |
| 14 | use MailPoet\Statistics\Track\WooCommercePurchases; |
| 15 | use MailPoet\Subscribers\SubscribersRepository; |
| 16 | use MailPoet\Util\Cookies; |
| 17 | use MailPoet\WP\Functions as WPFunctions; |
| 18 | use WC_Order; |
| 19 | |
| 20 | class OrderAttributionWriter { |
| 21 | const WRITES_STARTED_AT_OPTION = 'mailpoet_woo_attribution_writes_started_at'; |
| 22 | |
| 23 | // 'typein' is Woo's source type for direct traffic. A clear non-MailPoet source |
| 24 | // (organic, referral, non-MailPoet utm, admin, mobile_app) is never overwritten. |
| 25 | const OVERWRITABLE_SOURCE_TYPES = ['', 'typein', 'unknown']; |
| 26 | |
| 27 | /** @var WPFunctions */ |
| 28 | private $wp; |
| 29 | |
| 30 | /** @var Helper */ |
| 31 | private $wooHelper; |
| 32 | |
| 33 | /** @var TrackingConfig */ |
| 34 | private $trackingConfig; |
| 35 | |
| 36 | /** @var StatisticsClicksRepository */ |
| 37 | private $statisticsClicksRepository; |
| 38 | |
| 39 | /** @var SubscribersRepository */ |
| 40 | private $subscribersRepository; |
| 41 | |
| 42 | /** @var Cookies */ |
| 43 | private $cookies; |
| 44 | |
| 45 | public function __construct( |
| 46 | WPFunctions $wp, |
| 47 | Helper $wooHelper, |
| 48 | TrackingConfig $trackingConfig, |
| 49 | StatisticsClicksRepository $statisticsClicksRepository, |
| 50 | SubscribersRepository $subscribersRepository, |
| 51 | Cookies $cookies |
| 52 | ) { |
| 53 | $this->wp = $wp; |
| 54 | $this->wooHelper = $wooHelper; |
| 55 | $this->trackingConfig = $trackingConfig; |
| 56 | $this->statisticsClicksRepository = $statisticsClicksRepository; |
| 57 | $this->subscribersRepository = $subscribersRepository; |
| 58 | $this->cookies = $cookies; |
| 59 | } |
| 60 | |
| 61 | /** |
| 62 | * @param int|WC_Order $order |
| 63 | */ |
| 64 | public function writeForOrder($order): void { |
| 65 | if (!$this->isWritePathActive()) { |
| 66 | return; |
| 67 | } |
| 68 | if (!$order instanceof WC_Order) { |
| 69 | $order = $this->wooHelper->wcGetOrder($order); |
| 70 | } |
| 71 | if (!$order instanceof WC_Order) { |
| 72 | return; |
| 73 | } |
| 74 | $this->markWritesStarted(); |
| 75 | |
| 76 | $click = $this->resolveCanonicalClick($order); |
| 77 | if (!$click) { |
| 78 | return; |
| 79 | } |
| 80 | $this->writeStandardSourceFields($order, $click); |
| 81 | $order->save_meta_data(); |
| 82 | } |
| 83 | |
| 84 | /** |
| 85 | * woocommerce_new_order also fires during storefront checkout, before WooCommerce |
| 86 | * captures its attribution data. Writing MailPoet meta at that point would make |
| 87 | * Woo's has_attribution() check skip its own capture, so this path handles only |
| 88 | * admin and (non-Store-API) REST requests; checkout orders are covered by the |
| 89 | * woocommerce_order_save_attribution_data and order-status-changed paths. |
| 90 | * |
| 91 | * @param int|WC_Order $order |
| 92 | */ |
| 93 | public function writeForNewOrder($order): void { |
| 94 | if (!$this->isAdminOrRestApiRequest()) { |
| 95 | return; |
| 96 | } |
| 97 | $this->writeForOrder($order); |
| 98 | } |
| 99 | |
| 100 | private function isWritePathActive(): bool { |
| 101 | return $this->wooHelper->isWooCommerceActive() |
| 102 | && $this->isWooAttributionAvailable() |
| 103 | && $this->trackingConfig->isEmailTrackingEnabled(); |
| 104 | } |
| 105 | |
| 106 | private function isWooAttributionAvailable(): bool { |
| 107 | return class_exists(FeaturesUtil::class) && FeaturesUtil::feature_is_enabled('order_attribution'); |
| 108 | } |
| 109 | |
| 110 | private function isAdminOrRestApiRequest(): bool { |
| 111 | if ($this->wp->isAdmin()) { |
| 112 | return true; |
| 113 | } |
| 114 | return $this->wooHelper->isWooCommerceRestApiRequest() && !$this->wooHelper->isWooCommerceStoreApiRequest(); |
| 115 | } |
| 116 | |
| 117 | /** |
| 118 | * Persists the historical read boundary defined by the migration contract |
| 119 | * (STOMAIL-8135): set once when the write path first activates and never |
| 120 | * moved. Runs on init so the boundary predates every post-activation order; |
| 121 | * if it were first persisted inside writeForOrder, the triggering order's |
| 122 | * date_created would fall before the boundary and the reconciler would skip |
| 123 | * the first post-activation orders. |
| 124 | */ |
| 125 | public function markWritesStartedIfActive(): void { |
| 126 | if (!$this->isWritePathActive()) { |
| 127 | return; |
| 128 | } |
| 129 | $this->markWritesStarted(); |
| 130 | } |
| 131 | |
| 132 | // Backstop for the order-save paths; normally already persisted on init. |
| 133 | private function markWritesStarted(): void { |
| 134 | if ($this->wp->getOption(self::WRITES_STARTED_AT_OPTION)) { |
| 135 | return; |
| 136 | } |
| 137 | $this->wp->addOption(self::WRITES_STARTED_AT_OPTION, gmdate('Y-m-d H:i:s')); |
| 138 | } |
| 139 | |
| 140 | /** |
| 141 | * Last click wins (STOMAIL-8135): the most recent eligible click before order |
| 142 | * creation, across billing-email-matched and cookie-matched candidates. The |
| 143 | * candidate set mirrors WooCommercePurchases::trackPurchase; the legacy engine |
| 144 | * is intentionally left untouched while both run in parallel for reconciliation. |
| 145 | */ |
| 146 | private function resolveCanonicalClick(WC_Order $order): ?StatisticsClickEntity { |
| 147 | $to = $order->get_date_created(); |
| 148 | if (is_null($to)) { |
| 149 | return null; |
| 150 | } |
| 151 | $from = clone $to; |
| 152 | $from->modify(-WooCommercePurchases::USE_CLICKS_SINCE_DAYS_AGO . ' days'); |
| 153 | |
| 154 | $candidates = $this->getClicks($order->get_billing_email(), $from, $to); |
| 155 | if ($this->trackingConfig->isCookieTrackingEnabled()) { |
| 156 | $cookieEmail = $this->getSubscriberEmailFromCookie(); |
| 157 | if ($cookieEmail && $cookieEmail !== $order->get_billing_email()) { |
| 158 | $candidates = array_merge($candidates, $this->getClicks($cookieEmail, $from, $to)); |
| 159 | } |
| 160 | } |
| 161 | |
| 162 | if (!$candidates) { |
| 163 | return null; |
| 164 | } |
| 165 | $latest = array_shift($candidates); |
| 166 | foreach ($candidates as $click) { |
| 167 | if ($this->isMoreRecent($click, $latest)) { |
| 168 | $latest = $click; |
| 169 | } |
| 170 | } |
| 171 | return $latest; |
| 172 | } |
| 173 | |
| 174 | private function isMoreRecent(StatisticsClickEntity $click, StatisticsClickEntity $other): bool { |
| 175 | $clickUpdatedAt = $click->getUpdatedAt(); |
| 176 | $otherUpdatedAt = $other->getUpdatedAt(); |
| 177 | if ($clickUpdatedAt->getTimestamp() === $otherUpdatedAt->getTimestamp()) { |
| 178 | return (int)$click->getId() > (int)$other->getId(); |
| 179 | } |
| 180 | return $clickUpdatedAt > $otherUpdatedAt; |
| 181 | } |
| 182 | |
| 183 | /** |
| 184 | * @return StatisticsClickEntity[] |
| 185 | */ |
| 186 | private function getClicks(?string $email, \DateTimeInterface $from, \DateTimeInterface $to): array { |
| 187 | if (!$email) { |
| 188 | return []; |
| 189 | } |
| 190 | $subscriber = $this->subscribersRepository->findOneBy(['email' => $email]); |
| 191 | if (!$subscriber instanceof SubscriberEntity) { |
| 192 | return []; |
| 193 | } |
| 194 | return $this->statisticsClicksRepository->findLatestPerNewsletterBySubscriber($subscriber, $from, $to); |
| 195 | } |
| 196 | |
| 197 | private function getSubscriberEmailFromCookie(): ?string { |
| 198 | $cookieData = $this->cookies->get(Clicks::REVENUE_TRACKING_COOKIE_NAME); |
| 199 | if (!$cookieData || !isset($cookieData['statistics_clicks'])) { |
| 200 | return null; |
| 201 | } |
| 202 | try { |
| 203 | $click = $this->statisticsClicksRepository->findOneById($cookieData['statistics_clicks']); |
| 204 | } catch (\Exception $e) { |
| 205 | return null; |
| 206 | } |
| 207 | if (!$click instanceof StatisticsClickEntity) { |
| 208 | return null; |
| 209 | } |
| 210 | $subscriber = $click->getSubscriber(); |
| 211 | return $subscriber instanceof SubscriberEntity ? $subscriber->getEmail() : null; |
| 212 | } |
| 213 | |
| 214 | private function writeStandardSourceFields(WC_Order $order, StatisticsClickEntity $click): void { |
| 215 | $sourceType = $this->getMetaString($order, OrderAttributionFields::getMetaKey('source_type')); |
| 216 | $utmSource = $this->getMetaString($order, OrderAttributionFields::getMetaKey('utm_source')); |
| 217 | $sessionStartTime = $this->getMetaString($order, OrderAttributionFields::getMetaKey('session_start_time')); |
| 218 | if (!self::shouldWriteStandardSourceFields($sourceType, $utmSource, $sessionStartTime, $click->getUpdatedAt(), $this->wp->wpTimezone())) { |
| 219 | return; |
| 220 | } |
| 221 | $values = [ |
| 222 | 'source_type' => 'utm', |
| 223 | 'utm_source' => 'mailpoet', |
| 224 | 'utm_medium' => 'email', |
| 225 | 'utm_source_platform' => 'mailpoet', |
| 226 | ]; |
| 227 | $newsletter = $click->getNewsletter(); |
| 228 | if ($newsletter) { |
| 229 | $subject = (string)$newsletter->getSubject(); |
| 230 | $values['utm_campaign'] = $subject !== '' ? $subject : 'newsletter-' . $newsletter->getId(); |
| 231 | } |
| 232 | foreach ($values as $fieldName => $value) { |
| 233 | $order->update_meta_data(OrderAttributionFields::getMetaKey($fieldName), $this->wp->sanitizeTextField($value)); |
| 234 | } |
| 235 | } |
| 236 | |
| 237 | public static function shouldWriteStandardSourceFields( |
| 238 | string $sourceType, |
| 239 | string $utmSource, |
| 240 | string $sessionStartTime, |
| 241 | \DateTimeInterface $clickUpdatedAt, |
| 242 | \DateTimeZone $wooSessionTimeZone |
| 243 | ): bool { |
| 244 | if (in_array($sourceType, self::OVERWRITABLE_SOURCE_TYPES, true) || $utmSource === 'mailpoet') { |
| 245 | return true; |
| 246 | } |
| 247 | $wooSessionStart = self::parseWooSessionStartTime($sessionStartTime, $wooSessionTimeZone); |
| 248 | return $wooSessionStart && $clickUpdatedAt->getTimestamp() >= $wooSessionStart->getTimestamp(); |
| 249 | } |
| 250 | |
| 251 | /** |
| 252 | * Woo stores session_start_time as sourcebuster's `current_add.fd`, a wall-clock |
| 253 | * string with no timezone. It is the visitor's browser-local time, which the server |
| 254 | * cannot recover exactly, so we interpret it in the site timezone as the best |
| 255 | * single-region approximation. Multi-region skew is accepted within the documented |
| 256 | * last-click tolerance (STOMAIL-8186). |
| 257 | */ |
| 258 | private static function parseWooSessionStartTime(string $sessionStartTime, \DateTimeZone $timeZone): ?\DateTimeImmutable { |
| 259 | $sessionStartTime = trim($sessionStartTime); |
| 260 | if ($sessionStartTime === '') { |
| 261 | return null; |
| 262 | } |
| 263 | $date = \DateTimeImmutable::createFromFormat( |
| 264 | '!Y-m-d H:i:s', |
| 265 | $sessionStartTime, |
| 266 | $timeZone |
| 267 | ); |
| 268 | $errors = \DateTimeImmutable::getLastErrors(); |
| 269 | if (!$date || ($errors !== false && ((int)$errors['warning_count'] > 0 || (int)$errors['error_count'] > 0))) { |
| 270 | return null; |
| 271 | } |
| 272 | return $date; |
| 273 | } |
| 274 | |
| 275 | private function getMetaString(WC_Order $order, string $metaKey): string { |
| 276 | $value = $order->get_meta($metaKey); |
| 277 | return is_scalar($value) ? (string)$value : ''; |
| 278 | } |
| 279 | } |
| 280 |