AfterMigrationNotice.php
2 years ago
BlackFridayNotice.php
2 months ago
ChangedTrackingNotice.php
3 years ago
DatabaseEngineNotice.php
1 year ago
DeprecatedFilterNotice.php
4 years ago
DisabledMailFunctionNotice.php
2 months ago
DisabledWPCronNotice.php
1 year ago
EmailWithInvalidSegmentNotice.php
3 years ago
HeadersAlreadySentNotice.php
2 months ago
InactiveSubscribersNotice.php
2 years ago
PHPVersionWarnings.php
2 months ago
PendingApprovalNotice.php
2 years ago
PermanentNotices.php
2 months ago
PremiumFeaturesAvailableNotice.php
2 years ago
SenderDomainAuthenticationNotices.php
5 months ago
SendingQueueBodyCleanupNotice.php
2 months ago
StuckPostNotificationNotice.php
2 months ago
UnauthorizedEmailInNewslettersNotice.php
5 months ago
UnauthorizedEmailNotice.php
5 months ago
WooCommerceVersionWarning.php
1 year ago
WordPressPlaygroundNotice.php
1 year ago
index.php
3 years ago
DisabledMailFunctionNotice.php
242 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Util\Notices; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Cron\Workers\SendingQueue\Tasks\Shortcodes; |
| 9 | use MailPoet\Doctrine\WPDB\Connection; |
| 10 | use MailPoet\Mailer\Mailer; |
| 11 | use MailPoet\Mailer\MailerFactory; |
| 12 | use MailPoet\Settings\SettingsController; |
| 13 | use MailPoet\Util\Helpers; |
| 14 | use MailPoet\Util\License\Features\Subscribers as SubscribersFeature; |
| 15 | use MailPoet\WP\Functions as WPFunctions; |
| 16 | use MailPoet\WP\Notice; |
| 17 | |
| 18 | class DisabledMailFunctionNotice { |
| 19 | |
| 20 | const DISABLED_MAIL_FUNCTION_CHECK = 'disabled_mail_function_check'; |
| 21 | |
| 22 | const QUEUE_DISABLED_MAIL_FUNCTION_CHECK = 'queue_disabled_mail_function_check'; |
| 23 | |
| 24 | /** @var SettingsController */ |
| 25 | private $settings; |
| 26 | |
| 27 | /** @var WPFunctions */ |
| 28 | private $wp; |
| 29 | |
| 30 | /** @var SubscribersFeature */ |
| 31 | private $subscribersFeature; |
| 32 | |
| 33 | /** @var MailerFactory */ |
| 34 | private $mailerFactory; |
| 35 | |
| 36 | private $isInQueueForChecking = false; |
| 37 | |
| 38 | public function __construct( |
| 39 | WPFunctions $wp, |
| 40 | SettingsController $settings, |
| 41 | SubscribersFeature $subscribersFeature, |
| 42 | MailerFactory $mailerFactory |
| 43 | ) { |
| 44 | $this->settings = $settings; |
| 45 | $this->wp = $wp; |
| 46 | $this->subscribersFeature = $subscribersFeature; |
| 47 | $this->mailerFactory = $mailerFactory; |
| 48 | } |
| 49 | |
| 50 | public function init($shouldDisplay): ?string { |
| 51 | $shouldDisplay = $shouldDisplay && !Connection::isSQLite() && $this->shouldCheckMisconfiguredFunction() && $this->checkRequirements(); |
| 52 | if (!$shouldDisplay) { |
| 53 | return null; |
| 54 | } |
| 55 | |
| 56 | return $this->display(); |
| 57 | } |
| 58 | |
| 59 | private function checkRequirements(): bool { |
| 60 | if ($this->isInQueueForChecking) { |
| 61 | $this->settings->set(self::QUEUE_DISABLED_MAIL_FUNCTION_CHECK, false); |
| 62 | } |
| 63 | |
| 64 | $sendingMethod = $this->settings->get('mta.method', SettingsController::DEFAULT_SENDING_METHOD); |
| 65 | $isPhpMailSendingMethod = $sendingMethod === Mailer::METHOD_PHPMAIL; |
| 66 | |
| 67 | if (!$isPhpMailSendingMethod) { |
| 68 | return false; // fails requirements check |
| 69 | } |
| 70 | |
| 71 | $functionName = 'mail'; |
| 72 | $isMailFunctionDisabled = $this->isFunctionDisabled($functionName); |
| 73 | |
| 74 | if ($isMailFunctionDisabled) { |
| 75 | $this->settings->set(DisabledMailFunctionNotice::DISABLED_MAIL_FUNCTION_CHECK, true); |
| 76 | return true; |
| 77 | } |
| 78 | |
| 79 | $isMailFunctionProperlyConfigured = $this->testMailFunctionIsCorrectlyConfigured(); |
| 80 | |
| 81 | return !$isMailFunctionProperlyConfigured; |
| 82 | } |
| 83 | |
| 84 | /* |
| 85 | * Check MisConfigured Function |
| 86 | * |
| 87 | * This method will cause this class to only display the notice if the settings option |
| 88 | * |
| 89 | * disabled_mail_function_check === true |
| 90 | * or |
| 91 | * queue_disabled_mail_function_check === true |
| 92 | * or |
| 93 | * Totally disabled when wp filter `mailpoet_display_disabled_mail_function_notice` === false |
| 94 | * |
| 95 | */ |
| 96 | public function shouldCheckMisconfiguredFunction(): bool { |
| 97 | $shouldCheck = $this->wp->applyFilters('mailpoet_display_disabled_mail_function_notice', true); |
| 98 | $this->isInQueueForChecking = $this->settings->get(self::QUEUE_DISABLED_MAIL_FUNCTION_CHECK, false); |
| 99 | |
| 100 | return $shouldCheck && ( |
| 101 | $this->settings->get(self::DISABLED_MAIL_FUNCTION_CHECK, false) || |
| 102 | $this->isInQueueForChecking |
| 103 | ); |
| 104 | } |
| 105 | |
| 106 | public function isFunctionDisabled(string $function): bool { |
| 107 | // is_callable() returns false when the function is listed in disable_functions, which PHPStan can't see statically. |
| 108 | // @phpstan-ignore-next-line function.alreadyNarrowedType |
| 109 | $result = function_exists($function) && is_callable($function, false); |
| 110 | return !$result; |
| 111 | } |
| 112 | |
| 113 | private function display(): string { |
| 114 | $header = $this->getHeader(); |
| 115 | |
| 116 | $body = $this->getBody(); |
| 117 | |
| 118 | $button = $this->getConnectMailPoetButton(); |
| 119 | |
| 120 | $message = $header . $body . $button; |
| 121 | |
| 122 | Notice::displayWarning($message, '', self::DISABLED_MAIL_FUNCTION_CHECK, false); |
| 123 | |
| 124 | return $message; |
| 125 | } |
| 126 | |
| 127 | private function getHeader(): string { |
| 128 | return '<h4>' . __('Get ready to send your first campaign.', 'mailpoet') . '</h4>'; |
| 129 | } |
| 130 | |
| 131 | private function getBody(): string { |
| 132 | $bodyText = __('Connect your website with MailPoet, and start sending for free. Reach inboxes, not spam boxes. [link]Why am I seeing this?[/link]', 'mailpoet'); |
| 133 | |
| 134 | $bodyWithReplacedLink = Helpers::replaceLinkTags($bodyText, 'https://kb.mailpoet.com/article/396-disabled-mail-function', [ |
| 135 | 'target' => '_blank', |
| 136 | ]); |
| 137 | |
| 138 | return '<p>' . $bodyWithReplacedLink . '</p>'; |
| 139 | } |
| 140 | |
| 141 | private function getConnectMailPoetButton(): string { |
| 142 | $subscribersCount = $this->subscribersFeature->getSubscribersCount(); |
| 143 | $buttonLink = "https://account.mailpoet.com/?s={$subscribersCount}&utm_source=mailpoet&utm_medium=plugin&utm_campaign=disabled_mail_function"; |
| 144 | $link = $this->wp->escAttr($buttonLink); |
| 145 | return '<p><a target="_blank" href="' . $link . '" class="button button-primary">' . __('Connect MailPoet', 'mailpoet') . '</a></p>'; |
| 146 | } |
| 147 | |
| 148 | /* |
| 149 | * Test Mail Function Is Correctly Configured |
| 150 | * |
| 151 | * This is a workaround for detecting the user PHP mail() function is Correctly Configured and not disabled by the host |
| 152 | */ |
| 153 | private function testMailFunctionIsCorrectlyConfigured(): bool { |
| 154 | if ($this->settings->get(DisabledMailFunctionNotice::DISABLED_MAIL_FUNCTION_CHECK, false)) { |
| 155 | return false; // skip sending mail again |
| 156 | } |
| 157 | |
| 158 | $replyToAddress = $this->settings->get('reply_to.address'); |
| 159 | $senderAddress = $this->settings->get('sender.address'); |
| 160 | |
| 161 | $mailBody = "Hi there! \n |
| 162 | |
| 163 | Your website ([site:homepage_link]) sent you this email to confirm that it can send emails. |
| 164 | If you're reading this email, then it works! You can now continue sending marketing emails with MailPoet! \n |
| 165 | |
| 166 | MailPoet on [site:homepage_link]"; |
| 167 | |
| 168 | $body = Shortcodes::process($mailBody, null, null, null, null); |
| 169 | |
| 170 | $sendTestMailData = [ |
| 171 | 'mailer' => $this->settings->get('mta'), |
| 172 | 'newsletter' => [ |
| 173 | 'subject' => 'MailPoet can deliver your marketing emails!', |
| 174 | 'body' => [ |
| 175 | 'html' => nl2br($body), |
| 176 | 'text' => $body, |
| 177 | ], |
| 178 | ], |
| 179 | 'subscriber' => empty($replyToAddress) ? $senderAddress : $replyToAddress, |
| 180 | ]; |
| 181 | |
| 182 | $sendMailResult = $this->sendTestMail($sendTestMailData); |
| 183 | |
| 184 | if (!$sendMailResult) { |
| 185 | // Error with PHP mail() function |
| 186 | // keep displaying notice |
| 187 | $this->settings->set(DisabledMailFunctionNotice::DISABLED_MAIL_FUNCTION_CHECK, true); |
| 188 | } |
| 189 | |
| 190 | return $sendMailResult; |
| 191 | } |
| 192 | |
| 193 | /* |
| 194 | * Send Test Mail |
| 195 | * used to check for valid PHP mail() |
| 196 | * |
| 197 | * returns true if valid and okay |
| 198 | * else returns false if invalid. |
| 199 | * |
| 200 | * We determine the mail function is invalid by checking against the Exception error thrown by PHPMailer |
| 201 | * error message: Could not instantiate mail function. |
| 202 | * |
| 203 | * if the error is not equal to error message, we consider it okay. |
| 204 | */ |
| 205 | public function sendTestMail($data = []): bool { |
| 206 | try { |
| 207 | $mailer = $this->mailerFactory->buildMailer( |
| 208 | $data['mailer'] ?? null, |
| 209 | $data['sender'] ?? null, |
| 210 | $data['reply_to'] ?? null |
| 211 | ); |
| 212 | // report this as 'sending_test' in metadata since this endpoint is only used to test sending methods for now |
| 213 | $extraParams = [ |
| 214 | 'meta' => [ |
| 215 | 'email_type' => 'sending_test', |
| 216 | 'subscriber_status' => 'unknown', |
| 217 | 'subscriber_source' => 'administrator', |
| 218 | ], |
| 219 | ]; |
| 220 | $result = $mailer->send($data['newsletter'], $data['subscriber'], $extraParams); |
| 221 | |
| 222 | if ($result['response'] === false) { |
| 223 | $errorMessage = $result['error']->getMessage(); |
| 224 | return !$this->checkForErrorMessage($errorMessage); |
| 225 | } |
| 226 | |
| 227 | } catch (\Exception $e) { |
| 228 | $errorMessage = $e->getMessage(); |
| 229 | return !$this->checkForErrorMessage($errorMessage); |
| 230 | } |
| 231 | |
| 232 | return true; |
| 233 | } |
| 234 | |
| 235 | private function checkForErrorMessage($errorMessage): bool { |
| 236 | $phpmailerError = 'Could not instantiate mail function'; |
| 237 | $substringIndex = stripos($errorMessage, $phpmailerError); |
| 238 | |
| 239 | return $substringIndex !== false; |
| 240 | } |
| 241 | } |
| 242 |