Bridge
4 days ago
Release
2 years ago
AuthorizedEmailsController.php
2 months ago
AuthorizedSenderDomainController.php
5 months ago
Bridge.php
4 months ago
CongratulatoryMssEmailController.php
4 months ago
SubscribersCountReporter.php
3 years ago
Validator.php
3 years ago
index.php
3 years ago
AuthorizedSenderDomainController.php
342 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Services; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Mailer\Mailer; |
| 9 | use MailPoet\Newsletter\Statistics\NewsletterStatisticsRepository; |
| 10 | use MailPoet\Services\Bridge\API; |
| 11 | use MailPoet\Settings\SettingsController; |
| 12 | use MailPoet\Util\License\Features\Subscribers; |
| 13 | use MailPoet\WP\Functions as WPFunctions; |
| 14 | |
| 15 | class AuthorizedSenderDomainController { |
| 16 | const DOMAIN_STATUS_VERIFIED = 'verified'; |
| 17 | const DOMAIN_STATUS_PARTIALLY_VERIFIED = 'partially-verified'; |
| 18 | const DOMAIN_STATUS_UNVERIFIED = 'unverified'; |
| 19 | |
| 20 | const AUTHORIZED_SENDER_DOMAIN_ERROR_ALREADY_CREATED = 'Sender domain exist'; |
| 21 | const AUTHORIZED_SENDER_DOMAIN_ERROR_NOT_CREATED = 'Sender domain does not exist'; |
| 22 | const AUTHORIZED_SENDER_DOMAIN_ERROR_ALREADY_VERIFIED = 'Sender domain already verified'; |
| 23 | |
| 24 | const LOWER_LIMIT = 100; |
| 25 | const UPPER_LIMIT = 200; |
| 26 | |
| 27 | const INSTALLED_AFTER_NEW_RESTRICTIONS_OPTION = 'installed_after_new_domain_restrictions'; |
| 28 | |
| 29 | const SENDER_DOMAINS_KEY = 'mailpoet_sender_domains'; |
| 30 | |
| 31 | /** @var Bridge */ |
| 32 | private $bridge; |
| 33 | |
| 34 | /** @var NewsletterStatisticsRepository */ |
| 35 | private $newsletterStatisticsRepository; |
| 36 | |
| 37 | /** @var SettingsController */ |
| 38 | private $settingsController; |
| 39 | |
| 40 | /** @var null|array Cached response for with authorized domains */ |
| 41 | private $currentRecords = null; |
| 42 | |
| 43 | /** @var null|array */ |
| 44 | private $currentRawData = null; |
| 45 | |
| 46 | /** @var Subscribers */ |
| 47 | private $subscribers; |
| 48 | |
| 49 | /** @var WPFunctions */ |
| 50 | private $wp; |
| 51 | |
| 52 | public function __construct( |
| 53 | Bridge $bridge, |
| 54 | NewsletterStatisticsRepository $newsletterStatisticsRepository, |
| 55 | SettingsController $settingsController, |
| 56 | Subscribers $subscribers, |
| 57 | WPFunctions $wp |
| 58 | ) { |
| 59 | $this->bridge = $bridge; |
| 60 | $this->newsletterStatisticsRepository = $newsletterStatisticsRepository; |
| 61 | $this->settingsController = $settingsController; |
| 62 | $this->subscribers = $subscribers; |
| 63 | $this->wp = $wp; |
| 64 | } |
| 65 | |
| 66 | /** |
| 67 | * Get record of Bridge::getAuthorizedSenderDomains |
| 68 | */ |
| 69 | public function getDomainRecords(string $domain = ''): array { |
| 70 | $records = $this->getAllRecords(); |
| 71 | if ($domain) { |
| 72 | return $records[$domain] ?? []; |
| 73 | } |
| 74 | return $records; |
| 75 | } |
| 76 | |
| 77 | /** |
| 78 | * Get all Authorized Sender Domains |
| 79 | * |
| 80 | * Note: This includes both verified and unverified domains |
| 81 | */ |
| 82 | public function getAllSenderDomains(): array { |
| 83 | return $this->returnAllDomains($this->getAllRecords()); |
| 84 | } |
| 85 | |
| 86 | /** |
| 87 | * Get all Verified Sender Domains. |
| 88 | * |
| 89 | * Note: This includes partially or fully verified domains. |
| 90 | */ |
| 91 | public function getVerifiedSenderDomains(): array { |
| 92 | return $this->getFullyOrPartiallyVerifiedSenderDomains(true); |
| 93 | } |
| 94 | |
| 95 | public function getVerifiedSenderDomainsIgnoringCache(): array { |
| 96 | $this->reloadCache(); |
| 97 | return $this->getFullyOrPartiallyVerifiedSenderDomains(true); |
| 98 | } |
| 99 | |
| 100 | /** |
| 101 | * Create new Sender Domain |
| 102 | * |
| 103 | * Throws an InvalidArgumentException if domain already exist |
| 104 | * |
| 105 | * returns an Array of DNS response or array of error |
| 106 | */ |
| 107 | public function createAuthorizedSenderDomain(string $domain): array { |
| 108 | $allDomains = $this->getAllSenderDomains(); |
| 109 | |
| 110 | $alreadyExist = in_array($domain, $allDomains); |
| 111 | |
| 112 | if ($alreadyExist) { |
| 113 | // sender domain already created. skip making new request |
| 114 | throw new \InvalidArgumentException(self::AUTHORIZED_SENDER_DOMAIN_ERROR_ALREADY_CREATED); |
| 115 | } |
| 116 | |
| 117 | $response = $this->bridge->createAuthorizedSenderDomain($domain); |
| 118 | |
| 119 | if (isset($response['status']) && $response['status'] === API::RESPONSE_STATUS_ERROR) { |
| 120 | throw new \InvalidArgumentException($response['message']); |
| 121 | } |
| 122 | |
| 123 | // Reset cached value since a new domain was added |
| 124 | $this->currentRecords = null; |
| 125 | $this->reloadCache(); |
| 126 | |
| 127 | return $response; |
| 128 | } |
| 129 | |
| 130 | public function getRewrittenEmailAddress(string $email): string { |
| 131 | return sprintf('%s@replies.sendingservice.net', str_replace('@', '=', $email)); |
| 132 | } |
| 133 | |
| 134 | /** |
| 135 | * Verify Sender Domain |
| 136 | * |
| 137 | * Throws an InvalidArgumentException if domain does not exist or domain is already verified |
| 138 | * |
| 139 | * * returns [ok: bool, dns: array] if domain verification is successful |
| 140 | * * or [ok: bool, error: string, dns: array] if domain verification failed |
| 141 | * * or [error: string, status: bool] for other errors |
| 142 | */ |
| 143 | public function verifyAuthorizedSenderDomain(string $domain): array { |
| 144 | $records = $this->bridge->getAuthorizedSenderDomains(); |
| 145 | |
| 146 | $allDomains = $this->returnAllDomains($records); |
| 147 | $alreadyExist = in_array($domain, $allDomains); |
| 148 | |
| 149 | if (!$alreadyExist) { |
| 150 | // can't verify a domain that does not exist |
| 151 | throw new \InvalidArgumentException(self::AUTHORIZED_SENDER_DOMAIN_ERROR_NOT_CREATED); |
| 152 | } |
| 153 | |
| 154 | $verifiedDomains = $this->getFullyVerifiedSenderDomains(true); |
| 155 | $alreadyVerified = in_array($domain, $verifiedDomains); |
| 156 | |
| 157 | if ($alreadyVerified) { |
| 158 | // no need to reverify an already verified domain |
| 159 | throw new \InvalidArgumentException(self::AUTHORIZED_SENDER_DOMAIN_ERROR_ALREADY_VERIFIED); |
| 160 | } |
| 161 | |
| 162 | $response = $this->bridge->verifyAuthorizedSenderDomain($domain); |
| 163 | |
| 164 | // API response contains status, but we need to check that dns array is not included |
| 165 | if ($response['status'] === API::RESPONSE_STATUS_ERROR && !isset($response['dns'])) { |
| 166 | throw new \InvalidArgumentException($response['message']); |
| 167 | } |
| 168 | |
| 169 | $this->currentRecords = null; |
| 170 | $this->reloadCache(); |
| 171 | |
| 172 | return $response; |
| 173 | } |
| 174 | |
| 175 | public function getSenderDomainsByStatus(array $status): array { |
| 176 | return array_filter($this->getAllRawData(), function(array $senderDomainData) use ($status) { |
| 177 | return in_array($senderDomainData['domain_status'] ?? null, $status); |
| 178 | }); |
| 179 | } |
| 180 | |
| 181 | /** |
| 182 | * Returns sender domains that have all required records, including DMARC. |
| 183 | */ |
| 184 | public function getFullyVerifiedSenderDomains($domainsOnly = false): array { |
| 185 | $domainData = $this->getSenderDomainsByStatus([self::DOMAIN_STATUS_VERIFIED]); |
| 186 | return $domainsOnly ? $this->extractDomains($domainData) : $domainData; |
| 187 | } |
| 188 | |
| 189 | /** |
| 190 | * Returns sender domains that were verified before DMARC record was required. |
| 191 | */ |
| 192 | public function getPartiallyVerifiedSenderDomains($domainsOnly = false): array { |
| 193 | $domainData = $this->getSenderDomainsByStatus([self::DOMAIN_STATUS_PARTIALLY_VERIFIED]); |
| 194 | return $domainsOnly ? $this->extractDomains($domainData) : $domainData; |
| 195 | } |
| 196 | |
| 197 | public function getUnverifiedSenderDomains($domainsOnly = false): array { |
| 198 | $domainData = $this->getSenderDomainsByStatus([self::DOMAIN_STATUS_UNVERIFIED]); |
| 199 | return $domainsOnly ? $this->extractDomains($domainData) : $domainData; |
| 200 | } |
| 201 | |
| 202 | public function getFullyOrPartiallyVerifiedSenderDomains($domainsOnly = false): array { |
| 203 | $domainData = $this->getSenderDomainsByStatus([self::DOMAIN_STATUS_PARTIALLY_VERIFIED, self::DOMAIN_STATUS_VERIFIED]); |
| 204 | return $domainsOnly ? $this->extractDomains($domainData) : $domainData; |
| 205 | } |
| 206 | |
| 207 | private function extractDomains(array $domainData): array { |
| 208 | $extractedDomains = []; |
| 209 | foreach ($domainData as $data) { |
| 210 | $extractedDomains[] = $this->domainExtractor($data); |
| 211 | } |
| 212 | return $extractedDomains; |
| 213 | } |
| 214 | |
| 215 | private function domainExtractor(array $domainData): string { |
| 216 | return $domainData['domain'] ?? ''; |
| 217 | } |
| 218 | |
| 219 | public function getSenderDomainsGroupedByStatus(): array { |
| 220 | $groupedDomains = []; |
| 221 | foreach ($this->getAllRawData() as $senderDomainData) { |
| 222 | $status = $senderDomainData['domain_status'] ?? 'unknown'; |
| 223 | if (!isset($groupedDomains[$status])) { |
| 224 | $groupedDomains[$status] = []; |
| 225 | } |
| 226 | $groupedDomains[$status][] = $senderDomainData; |
| 227 | } |
| 228 | return $groupedDomains; |
| 229 | } |
| 230 | |
| 231 | /** |
| 232 | * Little helper function to return All Domains. alias to `array_keys` |
| 233 | * |
| 234 | * The domain is the key returned from the Bridge::getAuthorizedSenderDomains |
| 235 | */ |
| 236 | private function returnAllDomains(array $records): array { |
| 237 | $domains = array_keys($records); |
| 238 | return $domains; |
| 239 | } |
| 240 | |
| 241 | private function reloadCache() { |
| 242 | $currentRawData = $this->bridge->getRawSenderDomainData(); |
| 243 | if (!$currentRawData) return; // Do not modify cache if there is no data from the API |
| 244 | |
| 245 | $this->currentRawData = $currentRawData; |
| 246 | $this->wp->setTransient(self::SENDER_DOMAINS_KEY, $this->currentRawData, 60 * 60 * 24 * 7); |
| 247 | } |
| 248 | |
| 249 | public function isCacheAvailable(): bool { |
| 250 | return is_array($this->wp->getTransient(self::SENDER_DOMAINS_KEY)); |
| 251 | } |
| 252 | |
| 253 | private function getAllRawData(): array { |
| 254 | if ($this->currentRawData === null) { |
| 255 | $currentData = $this->wp->getTransient(self::SENDER_DOMAINS_KEY); |
| 256 | if (is_array($currentData)) { |
| 257 | $this->currentRawData = $currentData; |
| 258 | } else { |
| 259 | $this->reloadCache(); |
| 260 | } |
| 261 | } |
| 262 | return is_array($this->currentRawData) ? $this->currentRawData : []; |
| 263 | } |
| 264 | |
| 265 | private function getAllRecords(): array { |
| 266 | if ($this->currentRecords === null) { |
| 267 | $this->currentRecords = $this->bridge->getAuthorizedSenderDomains(); |
| 268 | } |
| 269 | return $this->currentRecords; |
| 270 | } |
| 271 | |
| 272 | public function isNewUser(): bool { |
| 273 | $installedVersion = $this->settingsController->get('version'); |
| 274 | |
| 275 | // Setup wizard has not been completed |
| 276 | if ($installedVersion === null) { |
| 277 | return true; |
| 278 | } |
| 279 | |
| 280 | $installedAfterNewDomainRestrictions = $this->settingsController->get(self::INSTALLED_AFTER_NEW_RESTRICTIONS_OPTION, false); |
| 281 | |
| 282 | if ($installedAfterNewDomainRestrictions) { |
| 283 | return true; |
| 284 | } |
| 285 | |
| 286 | return $this->newsletterStatisticsRepository->countBy([]) === 0; |
| 287 | } |
| 288 | |
| 289 | public function isSmallSender(): bool { |
| 290 | return $this->subscribers->getSubscribersCount() <= self::LOWER_LIMIT; |
| 291 | } |
| 292 | |
| 293 | public function isBigSender(): bool { |
| 294 | return $this->subscribers->getSubscribersCount() > self::UPPER_LIMIT; |
| 295 | } |
| 296 | |
| 297 | public function isBundledSubscription(): bool { |
| 298 | return $this->settingsController->get(Bridge::SUBSCRIPTION_TYPE_SETTING_NAME) === Bridge::WPCOM_BUNDLE_SUBSCRIPTION_TYPE; |
| 299 | } |
| 300 | |
| 301 | /** |
| 302 | * Bundled subscription users who are small senders |
| 303 | * can skip email/domain authorization requirements. |
| 304 | */ |
| 305 | public function shouldSkipAuthorization(): bool { |
| 306 | return $this->isBundledSubscription() && $this->isSmallSender(); |
| 307 | } |
| 308 | |
| 309 | public function isAuthorizedDomainRequiredForNewCampaigns(): bool { |
| 310 | if ($this->shouldSkipAuthorization()) { |
| 311 | return false; |
| 312 | } |
| 313 | return $this->settingsController->get('mta.method') === Mailer::METHOD_MAILPOET && !$this->isSmallSender(); |
| 314 | } |
| 315 | |
| 316 | public function isAuthorizedDomainRequiredForExistingCampaigns(): bool { |
| 317 | if ($this->shouldSkipAuthorization()) { |
| 318 | return false; |
| 319 | } |
| 320 | return $this->settingsController->get('mta.method') === Mailer::METHOD_MAILPOET && $this->isBigSender(); |
| 321 | } |
| 322 | |
| 323 | public function getContextData(): array { |
| 324 | return [ |
| 325 | 'verifiedSenderDomains' => $this->getFullyVerifiedSenderDomains(true), |
| 326 | 'partiallyVerifiedSenderDomains' => $this->getPartiallyVerifiedSenderDomains(true), |
| 327 | 'allSenderDomains' => $this->getAllSenderDomains(), |
| 328 | 'senderRestrictions' => [ |
| 329 | 'lowerLimit' => self::LOWER_LIMIT, |
| 330 | 'alwaysRewrite' => false, |
| 331 | 'skipAuthorization' => $this->shouldSkipAuthorization(), |
| 332 | ], |
| 333 | ]; |
| 334 | } |
| 335 | |
| 336 | public function getContextDataForAutomations(): array { |
| 337 | $data = $this->getContextData(); |
| 338 | $data['senderRestrictions']['alwaysRewrite'] = true; |
| 339 | return $data; |
| 340 | } |
| 341 | } |
| 342 |