Emails
3 months ago
Integrations
3 months ago
MultichannelMarketing
2 years ago
TransactionalEmails
11 months ago
WooCommerceBookings
2 months ago
WooCommerceSubscriptions
3 months ago
CouponPreProcessor.php
3 months ago
Emails.php
9 months ago
Helper.php
2 months ago
MailPoetTask.php
2 years ago
NonPersistablePreviewData.php
2 months ago
OrderAttributionFields.php
2 months ago
OrderAttributionRevenueReader.php
1 month ago
OrderAttributionWriter.php
2 months ago
RandomCouponCodeGenerator.php
3 months ago
Settings.php
2 years ago
SubscriberEngagement.php
3 years ago
Subscription.php
2 days ago
Tracker.php
2 years ago
TransactionalEmailHooks.php
2 years ago
TransactionalEmails.php
1 year ago
WooSystemInfo.php
2 months ago
WooSystemInfoController.php
2 years ago
index.php
3 years ago
Subscription.php
338 lines
| 1 | <?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing |
| 2 | |
| 3 | namespace MailPoet\WooCommerce; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Entities\SubscriberEntity; |
| 9 | use MailPoet\Segments\SegmentsRepository; |
| 10 | use MailPoet\Segments\WooCommerce as WooCommerceSegment; |
| 11 | use MailPoet\Settings\SettingsController; |
| 12 | use MailPoet\Subscribers\ConfirmationEmailMailer; |
| 13 | use MailPoet\Subscribers\Source; |
| 14 | use MailPoet\Subscribers\SubscriberSegmentRepository; |
| 15 | use MailPoet\Subscribers\SubscribersRepository; |
| 16 | use MailPoet\Subscribers\TrackingConsentCapture; |
| 17 | use MailPoet\Util\Helpers; |
| 18 | use MailPoet\WP\Functions as WPFunctions; |
| 19 | use MailPoetVendor\Carbon\Carbon; |
| 20 | |
| 21 | class Subscription { |
| 22 | const CHECKOUT_OPTIN_INPUT_NAME = 'mailpoet_woocommerce_checkout_optin'; |
| 23 | const CHECKOUT_OPTIN_PRESENCE_CHECK_INPUT_NAME = 'mailpoet_woocommerce_checkout_optin_present'; |
| 24 | const CHECKOUT_TRACKING_CONSENT_INPUT_NAME = 'mailpoet_woocommerce_checkout_tracking_consent'; |
| 25 | const OPTIN_ENABLED_SETTING_NAME = 'woocommerce.optin_on_checkout.enabled'; |
| 26 | const OPTIN_SEGMENTS_SETTING_NAME = 'woocommerce.optin_on_checkout.segments'; |
| 27 | const OPTIN_MESSAGE_SETTING_NAME = 'woocommerce.optin_on_checkout.message'; |
| 28 | const OPTIN_POSITION_SETTING_NAME = 'woocommerce.optin_on_checkout.position'; |
| 29 | |
| 30 | private $allowedHtml = [ |
| 31 | 'input' => [ |
| 32 | 'type' => true, |
| 33 | 'name' => true, |
| 34 | 'id' => true, |
| 35 | 'class' => true, |
| 36 | 'value' => true, |
| 37 | 'checked' => true, |
| 38 | ], |
| 39 | 'span' => [ |
| 40 | 'class' => true, |
| 41 | ], |
| 42 | 'label' => [ |
| 43 | 'class' => true, |
| 44 | 'data-automation-id' => true, |
| 45 | 'for' => true, |
| 46 | ], |
| 47 | 'p' => [ |
| 48 | 'class' => true, |
| 49 | 'id' => true, |
| 50 | 'data-priority' => true, |
| 51 | ], |
| 52 | ]; |
| 53 | |
| 54 | /** @var SettingsController */ |
| 55 | private $settings; |
| 56 | |
| 57 | /** @var WPFunctions */ |
| 58 | private $wp; |
| 59 | |
| 60 | /** @var Helper */ |
| 61 | private $wcHelper; |
| 62 | |
| 63 | /** @var ConfirmationEmailMailer */ |
| 64 | private $confirmationEmailMailer; |
| 65 | |
| 66 | /** @var SubscribersRepository */ |
| 67 | private $subscribersRepository; |
| 68 | |
| 69 | /** @var SegmentsRepository */ |
| 70 | private $segmentsRepository; |
| 71 | |
| 72 | /** @var SubscriberSegmentRepository */ |
| 73 | private $subscriberSegmentRepository; |
| 74 | |
| 75 | /** @var TrackingConsentCapture */ |
| 76 | private $trackingConsentCapture; |
| 77 | |
| 78 | /** @var WooCommerceSegment */ |
| 79 | private $woocommerceSegment; |
| 80 | |
| 81 | public function __construct( |
| 82 | SettingsController $settings, |
| 83 | ConfirmationEmailMailer $confirmationEmailMailer, |
| 84 | WPFunctions $wp, |
| 85 | Helper $wcHelper, |
| 86 | SubscribersRepository $subscribersRepository, |
| 87 | SegmentsRepository $segmentsRepository, |
| 88 | SubscriberSegmentRepository $subscriberSegmentRepository, |
| 89 | TrackingConsentCapture $trackingConsentCapture, |
| 90 | WooCommerceSegment $woocommerceSegment |
| 91 | ) { |
| 92 | $this->settings = $settings; |
| 93 | $this->wp = $wp; |
| 94 | $this->wcHelper = $wcHelper; |
| 95 | $this->confirmationEmailMailer = $confirmationEmailMailer; |
| 96 | $this->subscribersRepository = $subscribersRepository; |
| 97 | $this->segmentsRepository = $segmentsRepository; |
| 98 | $this->subscriberSegmentRepository = $subscriberSegmentRepository; |
| 99 | $this->trackingConsentCapture = $trackingConsentCapture; |
| 100 | $this->woocommerceSegment = $woocommerceSegment; |
| 101 | } |
| 102 | |
| 103 | public function extendWooCommerceCheckoutForm() { |
| 104 | $inputName = self::CHECKOUT_OPTIN_INPUT_NAME; |
| 105 | $checked = false; |
| 106 | if (!empty($_POST[self::CHECKOUT_OPTIN_INPUT_NAME])) { |
| 107 | $checked = true; |
| 108 | } |
| 109 | $labelString = $this->settings->get(self::OPTIN_MESSAGE_SETTING_NAME); |
| 110 | $defaultTemplate = wp_kses( |
| 111 | $this->getSubscriptionField($inputName, $checked, $labelString), |
| 112 | $this->allowedHtml |
| 113 | ); |
| 114 | $filtered = $this->wp->applyFilters( |
| 115 | 'mailpoet_woocommerce_checkout_optin_template', |
| 116 | $defaultTemplate, |
| 117 | $inputName, |
| 118 | $checked, |
| 119 | $labelString |
| 120 | ); |
| 121 | $template = is_string($filtered) ? $filtered : $defaultTemplate; |
| 122 | // The template has been sanitized above and can be considered safe. |
| 123 | // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped |
| 124 | echo $template; |
| 125 | if ($template) { |
| 126 | $field = $this->getSubscriptionPresenceCheckField(); |
| 127 | echo wp_kses($field, $this->allowedHtml); |
| 128 | // A second, independent control. Consent to open and click tracking can |
| 129 | // never be bundled with the marketing opt-in above it. |
| 130 | echo wp_kses($this->getTrackingConsentField(), $this->allowedHtml); |
| 131 | } |
| 132 | } |
| 133 | |
| 134 | /** |
| 135 | * The tracking-consent checkbox, shown only on sites that chose to ask. It is |
| 136 | * never pre-ticked: a pre-ticked consent box is not valid consent (CJEU |
| 137 | * Planet49). |
| 138 | */ |
| 139 | private function getTrackingConsentField(): string { |
| 140 | if (!$this->trackingConsentCapture->isCaptureEnabled()) { |
| 141 | return ''; |
| 142 | } |
| 143 | $inputName = self::CHECKOUT_TRACKING_CONSENT_INPUT_NAME; |
| 144 | $copy = $this->trackingConsentCapture->getCopy( |
| 145 | SubscriberEntity::TRACKING_CONSENT_METHOD_WOOCOMMERCE_CHECKOUT |
| 146 | ); |
| 147 | |
| 148 | return '<label class="woocommerce-form__label woocommerce-form__label-for-checkbox checkbox" data-automation-id="woo-commerce-tracking-consent"> |
| 149 | <input id="' . $this->wp->escAttr($inputName) . '" class="woocommerce-form__input woocommerce-form__input-checkbox input-checkbox" type="checkbox" name="' . $this->wp->escAttr($inputName) . '" value="1" /> |
| 150 | <span>' . $this->wp->escHtml($copy) . '</span> |
| 151 | </label>'; |
| 152 | } |
| 153 | |
| 154 | private function getSubscriptionField($inputName, $checked, $labelString) { |
| 155 | $checked = checked($checked, true, false); |
| 156 | |
| 157 | return '<label class="woocommerce-form__label woocommerce-form__label-for-checkbox checkbox" data-automation-id="woo-commerce-subscription-opt-in"> |
| 158 | <input id="mailpoet_woocommerce_checkout_optin" class="woocommerce-form__input woocommerce-form__input-checkbox input-checkbox" ' . $checked . ' type="checkbox" name="' . $this->wp->escAttr($inputName) . '" value="1" /> |
| 159 | <span>' . $this->wp->escHtml($labelString) . '</span> |
| 160 | </label>'; |
| 161 | } |
| 162 | |
| 163 | private function getSubscriptionPresenceCheckField() { |
| 164 | $field = $this->wcHelper->woocommerceFormField( |
| 165 | self::CHECKOUT_OPTIN_PRESENCE_CHECK_INPUT_NAME, |
| 166 | [ |
| 167 | 'type' => 'hidden', |
| 168 | 'return' => true, |
| 169 | ], |
| 170 | 1 |
| 171 | ); |
| 172 | if ($field) { |
| 173 | return $field; |
| 174 | } |
| 175 | // Workaround for older WooCommerce versions (below 4.6.0) that don't support hidden fields |
| 176 | // We can remove it after we drop support of older WooCommerce |
| 177 | $field = $this->wcHelper->woocommerceFormField( |
| 178 | self::CHECKOUT_OPTIN_PRESENCE_CHECK_INPUT_NAME, |
| 179 | [ |
| 180 | 'type' => 'text', |
| 181 | 'return' => true, |
| 182 | ], |
| 183 | 1 |
| 184 | ); |
| 185 | return str_replace('type="text"', 'type="hidden"', $field); |
| 186 | } |
| 187 | |
| 188 | public function subscribeOnOrderPay($orderId) { |
| 189 | $wcOrder = $this->wcHelper->wcGetOrder($orderId); |
| 190 | if (!$wcOrder instanceof \WC_Order) { |
| 191 | return null; |
| 192 | } |
| 193 | |
| 194 | $data['billing_email'] = $wcOrder->get_billing_email(); |
| 195 | $this->subscribeOnCheckout($orderId, $data); |
| 196 | } |
| 197 | |
| 198 | public function subscribeOnCheckout($orderId, $data) { |
| 199 | $this->triggerAutomateWooOptin(); |
| 200 | if (empty($data['billing_email'])) { |
| 201 | // no email in posted order data |
| 202 | return null; |
| 203 | } |
| 204 | |
| 205 | $subscriber = $this->subscribersRepository->findOneBy( |
| 206 | ['email' => $data['billing_email'], 'isWoocommerceUser' => 1] |
| 207 | ); |
| 208 | |
| 209 | if (!$subscriber) { |
| 210 | // no subscriber: WooCommerce sync didn't work |
| 211 | return null; |
| 212 | } |
| 213 | |
| 214 | $checkoutOptin = !empty($_POST[self::CHECKOUT_OPTIN_INPUT_NAME]); |
| 215 | $trackingConsent = !empty($_POST[self::CHECKOUT_TRACKING_CONSENT_INPUT_NAME]); |
| 216 | // Classic checkout has no pre-sync lookup of its own: the guest sync runs on |
| 217 | // this same hook three priorities earlier, so by now a brand new guest's row |
| 218 | // is already there. Ask the sync what it actually inserted. |
| 219 | $isNewSubscriber = $this->woocommerceSegment->wasNewlyCreatedByGuestSync($data['billing_email']); |
| 220 | |
| 221 | return $this->handleSubscriberOptin($subscriber, $checkoutOptin, $trackingConsent, $isNewSubscriber); |
| 222 | } |
| 223 | |
| 224 | /** |
| 225 | * Subscribe a subscriber. |
| 226 | * |
| 227 | * @param SubscriberEntity $subscriber Subscriber object |
| 228 | * @param bool $shouldSubscribe Whether the subscriber should be subscribed |
| 229 | * @param bool $trackingConsent Whether the separate tracking-consent box was ticked |
| 230 | */ |
| 231 | public function handleSubscriberOptin(SubscriberEntity $subscriber, bool $shouldSubscribe, bool $trackingConsent = false, bool $isNewSubscriber = false): bool { |
| 232 | // Recorded before the opt-in branch, and independently of it: consenting to |
| 233 | // tracking and subscribing are two separate decisions, so a customer who |
| 234 | // declines the newsletter can still allow tracking and vice versa. |
| 235 | $this->applyTrackingConsent($subscriber, $trackingConsent, $isNewSubscriber); |
| 236 | |
| 237 | $wcSegment = $this->segmentsRepository->getWooCommerceSegment(); |
| 238 | |
| 239 | $segmentIds = (array)$this->settings->get(self::OPTIN_SEGMENTS_SETTING_NAME, []); |
| 240 | $moreSegmentsToSubscribe = []; |
| 241 | if (!empty($segmentIds)) { |
| 242 | $moreSegmentsToSubscribe = $this->segmentsRepository->findByIds($segmentIds); |
| 243 | } |
| 244 | $signupConfirmation = $this->settings->get('signup_confirmation'); |
| 245 | |
| 246 | if ($shouldSubscribe) { |
| 247 | $subscriber->setSource(Source::WOOCOMMERCE_CHECKOUT); |
| 248 | |
| 249 | if ( |
| 250 | ($subscriber->getStatus() === SubscriberEntity::STATUS_SUBSCRIBED) |
| 251 | || ((bool)$signupConfirmation['enabled'] === false) |
| 252 | ) { |
| 253 | $this->subscribe($subscriber); |
| 254 | } else { |
| 255 | $this->requireSubscriptionConfirmation($subscriber); |
| 256 | } |
| 257 | |
| 258 | $this->subscriberSegmentRepository->subscribeToSegments($subscriber, array_merge([$wcSegment], $moreSegmentsToSubscribe)); |
| 259 | |
| 260 | return true; |
| 261 | } else { |
| 262 | return false; |
| 263 | } |
| 264 | } |
| 265 | |
| 266 | /** |
| 267 | * Checkout always acts on a subscriber row that already exists (the |
| 268 | * WooCommerce customer sync creates it), so an unticked box leaves an earlier |
| 269 | * choice alone rather than revoking it. Persisted here because this path |
| 270 | * writes the entity itself instead of going through SubscriberSaveController. |
| 271 | */ |
| 272 | private function applyTrackingConsent(SubscriberEntity $subscriber, bool $granted, bool $isNewSubscriber = false): void { |
| 273 | $method = SubscriberEntity::TRACKING_CONSENT_METHOD_WOOCOMMERCE_CHECKOUT; |
| 274 | $before = $subscriber->getTrackingConsent(); |
| 275 | |
| 276 | $this->trackingConsentCapture->applyToSubscriber( |
| 277 | $subscriber, |
| 278 | $granted, |
| 279 | $method, |
| 280 | $this->trackingConsentCapture->getCopy($method), |
| 281 | $isNewSubscriber |
| 282 | ); |
| 283 | |
| 284 | if ($subscriber->getTrackingConsent() !== $before) { |
| 285 | $this->subscribersRepository->persist($subscriber); |
| 286 | $this->subscribersRepository->flush(); |
| 287 | } |
| 288 | } |
| 289 | |
| 290 | public function hideAutomateWooOptinCheckbox(): void { |
| 291 | if (!$this->wp->isPluginActive('automatewoo/automatewoo.php')) { |
| 292 | return; |
| 293 | } |
| 294 | // Hide AutomateWoo checkout opt-in so we won't end up with two opt-ins |
| 295 | $this->wp->removeAction( |
| 296 | 'woocommerce_checkout_after_terms_and_conditions', |
| 297 | ['AutomateWoo\Frontend', 'output_checkout_optin_checkbox'] |
| 298 | ); |
| 299 | } |
| 300 | |
| 301 | private function triggerAutomateWooOptin(): void { |
| 302 | if ( |
| 303 | !$this->wp->isPluginActive('automatewoo/automatewoo.php') |
| 304 | || empty($_POST[self::CHECKOUT_OPTIN_INPUT_NAME]) |
| 305 | ) { |
| 306 | return; |
| 307 | } |
| 308 | // Emulate checkout opt-in triggering for AutomateWoo |
| 309 | $_POST['automatewoo_optin'] = 'On'; |
| 310 | } |
| 311 | |
| 312 | private function subscribe(SubscriberEntity $subscriber) { |
| 313 | $subscriber->setStatus(SubscriberEntity::STATUS_SUBSCRIBED); |
| 314 | if (empty($subscriber->getConfirmedIp()) && empty($subscriber->getConfirmedAt())) { |
| 315 | $subscriber->setConfirmedIp(Helpers::getIP()); |
| 316 | $subscriber->setConfirmedAt(new Carbon()); |
| 317 | } |
| 318 | |
| 319 | $this->subscribersRepository->persist($subscriber); |
| 320 | $this->subscribersRepository->flush(); |
| 321 | } |
| 322 | |
| 323 | private function requireSubscriptionConfirmation(SubscriberEntity $subscriber) { |
| 324 | $subscriber->setStatus(SubscriberEntity::STATUS_UNCONFIRMED); |
| 325 | $this->subscribersRepository->persist($subscriber); |
| 326 | $this->subscribersRepository->flush(); |
| 327 | |
| 328 | try { |
| 329 | // Per-list confirmation settings are not resolved here because this path |
| 330 | // subscribes to the WooCommerce Customers segment (TYPE_WC_USERS), |
| 331 | // which does not support custom confirmation overrides. |
| 332 | $this->confirmationEmailMailer->sendConfirmationEmailOnce($subscriber, null, null, true); |
| 333 | } catch (\Exception $e) { |
| 334 | // ignore errors |
| 335 | } |
| 336 | } |
| 337 | } |
| 338 |