Captcha.php
5 months ago
CronDaemon.php
3 years ago
ExportDownload.php
3 months ago
FormPreview.php
2 years ago
Subscription.php
3 months ago
TemplateImage.php
3 months ago
Track.php
3 months ago
ViewInBrowser.php
2 months ago
index.php
3 years ago
Subscription.php
157 lines
| 1 | <?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing |
| 2 | |
| 3 | namespace MailPoet\Router\Endpoints; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Config\AccessControl; |
| 9 | use MailPoet\Entities\StatisticsUnsubscribeEntity; |
| 10 | use MailPoet\Subscription as UserSubscription; |
| 11 | use MailPoet\Util\Request; |
| 12 | use MailPoet\WP\Functions as WPFunctions; |
| 13 | |
| 14 | class Subscription { |
| 15 | const ENDPOINT = 'subscription'; |
| 16 | const ACTION_CONFIRM = 'confirm'; |
| 17 | const ACTION_MANAGE = 'manage'; |
| 18 | const ACTION_UNSUBSCRIBE = 'unsubscribe'; |
| 19 | const ACTION_UNSUBSCRIBE_REASON = 'unsubscribeReason'; |
| 20 | const ACTION_CONFIRM_UNSUBSCRIBE = 'confirmUnsubscribe'; |
| 21 | const ACTION_RE_ENGAGEMENT = 'reEngagement'; |
| 22 | |
| 23 | public $allowedActions = [ |
| 24 | self::ACTION_CONFIRM, |
| 25 | self::ACTION_MANAGE, |
| 26 | self::ACTION_UNSUBSCRIBE, |
| 27 | self::ACTION_UNSUBSCRIBE_REASON, |
| 28 | self::ACTION_CONFIRM_UNSUBSCRIBE, |
| 29 | self::ACTION_RE_ENGAGEMENT, |
| 30 | ]; |
| 31 | |
| 32 | public $permissions = [ |
| 33 | 'global' => AccessControl::NO_ACCESS_RESTRICTION, |
| 34 | ]; |
| 35 | |
| 36 | /** @var UserSubscription\Pages */ |
| 37 | private $subscriptionPages; |
| 38 | |
| 39 | /** @var WPFunctions */ |
| 40 | private $wp; |
| 41 | |
| 42 | /*** @var Request */ |
| 43 | private $request; |
| 44 | |
| 45 | public function __construct( |
| 46 | UserSubscription\Pages $subscriptionPages, |
| 47 | WPFunctions $wp, |
| 48 | Request $request |
| 49 | ) { |
| 50 | $this->subscriptionPages = $subscriptionPages; |
| 51 | $this->wp = $wp; |
| 52 | $this->request = $request; |
| 53 | } |
| 54 | |
| 55 | public function confirm($data) { |
| 56 | $subscription = $this->initSubscriptionPage(UserSubscription\Pages::ACTION_CONFIRM, $data); |
| 57 | $subscription->confirm(); |
| 58 | } |
| 59 | |
| 60 | public function confirmUnsubscribe($data) { |
| 61 | $enableUnsubscribeConfirmation = $this->wp->applyFilters('mailpoet_unsubscribe_confirmation_enabled', true); |
| 62 | if ($this->isPostRequest()) { |
| 63 | $this->performUnsubscribe($data, StatisticsUnsubscribeEntity::METHOD_ONE_CLICK); |
| 64 | exit; |
| 65 | } |
| 66 | |
| 67 | if ($enableUnsubscribeConfirmation) { |
| 68 | $this->initSubscriptionPage(UserSubscription\Pages::ACTION_CONFIRM_UNSUBSCRIBE, $data); |
| 69 | } else { |
| 70 | $this->performUnsubscribe($data, StatisticsUnsubscribeEntity::METHOD_LINK); |
| 71 | } |
| 72 | } |
| 73 | |
| 74 | public function manage($data) { |
| 75 | $this->initSubscriptionPage(UserSubscription\Pages::ACTION_MANAGE, $data); |
| 76 | } |
| 77 | |
| 78 | public function unsubscribe($data) { |
| 79 | if ($this->isPostRequest()) { |
| 80 | if ($this->request->getStringParam('type') === 'confirmation') { |
| 81 | // POST from confirmation page |
| 82 | $this->performUnsubscribe($data, StatisticsUnsubscribeEntity::METHOD_LINK); |
| 83 | } else { |
| 84 | // POST from one click unsubscribe |
| 85 | $this->performUnsubscribe($data, StatisticsUnsubscribeEntity::METHOD_ONE_CLICK); |
| 86 | exit; |
| 87 | } |
| 88 | } else { |
| 89 | // For GET requests, we render the confirmUnsubscribe page, unless it is preview request of successful unsubscribe |
| 90 | // or the subscriber is already unsubscribed. |
| 91 | if (isset($data['preview']) && $data['preview'] && !isset($data['token'])) { |
| 92 | $this->performUnsubscribe($data, StatisticsUnsubscribeEntity::METHOD_LINK); |
| 93 | } elseif ($this->renderUnsubscribePageForAlreadyUnsubscribedSubscriber($data)) { |
| 94 | return; |
| 95 | } else { |
| 96 | $this->confirmUnsubscribe($data); |
| 97 | } |
| 98 | } |
| 99 | } |
| 100 | |
| 101 | public function unsubscribeReason($data) { |
| 102 | if (!$this->request->isPost()) { |
| 103 | $this->wp->wpSafeRedirect($this->wp->homeUrl()); |
| 104 | exit; |
| 105 | } |
| 106 | |
| 107 | $nonce = $this->request->getStringParam('_wpnonce'); |
| 108 | if (!$this->wp->wpVerifyNonce($nonce, 'mailpoet_unsubscribe_reason')) { |
| 109 | $this->wp->wpDie(__('Security check failed.', 'mailpoet'), '', ['response' => 403]); |
| 110 | exit; |
| 111 | } |
| 112 | |
| 113 | $subscription = $this->initSubscriptionPage(UserSubscription\Pages::ACTION_UNSUBSCRIBE, $data); |
| 114 | $reason = strtolower($this->wp->sanitizeKey((string)$this->request->getStringParam('reason'))); |
| 115 | $reasonText = $this->request->getTextareaParam('reason_text'); |
| 116 | |
| 117 | $saved = $reason !== '' && $subscription->saveUnsubscribeReason($reason, $reasonText); |
| 118 | $this->wp->wpSafeRedirect($subscription->getUnsubscribeReasonRedirectUrl($saved)); |
| 119 | exit; |
| 120 | } |
| 121 | |
| 122 | public function reEngagement($data) { |
| 123 | $this->initSubscriptionPage(UserSubscription\Pages::ACTION_RE_ENGAGEMENT, $data); |
| 124 | } |
| 125 | |
| 126 | private function initSubscriptionPage($action, $data) { |
| 127 | return $this->subscriptionPages->init($action, $data, true, true); |
| 128 | } |
| 129 | |
| 130 | private function renderUnsubscribePageForAlreadyUnsubscribedSubscriber($data): bool { |
| 131 | $subscription = $this->subscriptionPages->init(UserSubscription\Pages::ACTION_UNSUBSCRIBE, $data, false, false); |
| 132 | if (!$subscription->isSubscriberUnsubscribed()) { |
| 133 | return false; |
| 134 | } |
| 135 | |
| 136 | $this->initSubscriptionPage(UserSubscription\Pages::ACTION_UNSUBSCRIBE, $data); |
| 137 | return true; |
| 138 | } |
| 139 | |
| 140 | private function performUnsubscribe($data, string $method): void { |
| 141 | $subscription = $this->initSubscriptionPage(UserSubscription\Pages::ACTION_UNSUBSCRIBE, $data); |
| 142 | $subscription->unsubscribe($method); |
| 143 | } |
| 144 | |
| 145 | private function isPostRequest(): bool { |
| 146 | if ($this->request->isPost()) { |
| 147 | return true; |
| 148 | } |
| 149 | // For tracking redirects we store original method in the query string |
| 150 | $requestMethod = $this->request->getStringParam('request_method'); |
| 151 | if (!$requestMethod) { |
| 152 | return false; |
| 153 | } |
| 154 | return strtoupper($requestMethod) === 'POST'; |
| 155 | } |
| 156 | } |
| 157 |