CouponBlock.php
3 months ago
CouponBlockAttributeParser.php
3 months ago
CouponBlockDetector.php
3 months ago
CouponBlockFailureTranslator.php
3 months ago
CouponBlockGenerationFailureCollector.php
3 months ago
CouponBlockGenerator.php
3 months ago
CouponBlockValidationException.php
3 months ago
CouponBlockValidator.php
3 months ago
EmailContextBuilder.php
1 month ago
index.php
3 months ago
CouponBlockGenerator.php
274 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\EmailEditor\Integrations\MailPoet\Coupons; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context; |
| 9 | use MailPoet\Entities\NewsletterEntity; |
| 10 | use MailPoet\WooCommerce\Helper; |
| 11 | use MailPoet\WooCommerce\RandomCouponCodeGenerator; |
| 12 | use MailPoet\WP\Functions as WPFunctions; |
| 13 | |
| 14 | /** |
| 15 | * Generates coupon codes only while WooCommerce renders a MailPoet block email. |
| 16 | * |
| 17 | * Renderer clears the failure collector before each render and reads it |
| 18 | * immediately after rendering, so failures recorded here stop that send without |
| 19 | * leaking details into later renders. |
| 20 | */ |
| 21 | class CouponBlockGenerator { |
| 22 | const SAFE_PLACEHOLDER = CouponBlock::SAFE_PLACEHOLDER; |
| 23 | const MAX_CODE_RETRIES = 5; |
| 24 | |
| 25 | /** @var Helper */ |
| 26 | private $wcHelper; |
| 27 | |
| 28 | /** @var CouponBlockValidator */ |
| 29 | private $validator; |
| 30 | |
| 31 | /** @var CouponBlockGenerationFailureCollector */ |
| 32 | private $failureCollector; |
| 33 | |
| 34 | /** @var WPFunctions */ |
| 35 | private $wp; |
| 36 | |
| 37 | private RandomCouponCodeGenerator $randomCouponCodeGenerator; |
| 38 | |
| 39 | public function __construct( |
| 40 | Helper $wcHelper, |
| 41 | CouponBlockValidator $validator, |
| 42 | CouponBlockGenerationFailureCollector $failureCollector, |
| 43 | WPFunctions $wp, |
| 44 | RandomCouponCodeGenerator $randomCouponCodeGenerator |
| 45 | ) { |
| 46 | $this->wcHelper = $wcHelper; |
| 47 | $this->validator = $validator; |
| 48 | $this->failureCollector = $failureCollector; |
| 49 | $this->wp = $wp; |
| 50 | $this->randomCouponCodeGenerator = $randomCouponCodeGenerator; |
| 51 | } |
| 52 | |
| 53 | public function init(): void { |
| 54 | if (!class_exists(Rendering_Context::class)) { |
| 55 | return; |
| 56 | } |
| 57 | |
| 58 | $this->wp->addFilter( |
| 59 | 'woocommerce_coupon_code_block_auto_generate', |
| 60 | [$this, 'generate'], |
| 61 | 5, |
| 62 | 3 |
| 63 | ); |
| 64 | $this->wp->addAction('woocommerce_email_editor_render_start', [$this, 'registerEmailRenderer']); |
| 65 | } |
| 66 | |
| 67 | public function generate($couponCode, array $attrs, Rendering_Context $renderingContext): string { |
| 68 | $couponCode = (string)$couponCode; |
| 69 | if ($couponCode !== '') { |
| 70 | return $couponCode; |
| 71 | } |
| 72 | |
| 73 | $context = $renderingContext->get_email_context(); |
| 74 | if (($context['integration'] ?? null) !== 'mailpoet') { |
| 75 | return $couponCode; |
| 76 | } |
| 77 | |
| 78 | if (!CouponBlock::isCreateNew($attrs)) { |
| 79 | return self::SAFE_PLACEHOLDER; |
| 80 | } |
| 81 | $attrs = CouponBlock::withCreateNewDefaults($attrs); |
| 82 | |
| 83 | if (!($context['is_real_send'] ?? false)) { |
| 84 | return self::SAFE_PLACEHOLDER; |
| 85 | } |
| 86 | |
| 87 | $unsupportedContextMessage = $this->getUnsupportedRealSendContextMessage($attrs, $renderingContext); |
| 88 | if ($unsupportedContextMessage !== null) { |
| 89 | $this->recordFailure('invalid_real_send_context', $unsupportedContextMessage, $attrs, $context); |
| 90 | return self::SAFE_PLACEHOLDER; |
| 91 | } |
| 92 | |
| 93 | if (!$this->wcHelper->isWooCommerceActive()) { |
| 94 | $this->recordFailure('woocommerce_unavailable', 'WooCommerce is not available.', $attrs, $context); |
| 95 | return self::SAFE_PLACEHOLDER; |
| 96 | } |
| 97 | |
| 98 | try { |
| 99 | $recipientEmail = (string)$renderingContext->get_recipient_email(); |
| 100 | $validatedAttrs = $this->validator->validate($attrs, $recipientEmail); |
| 101 | $code = $this->generateUniqueCode(); |
| 102 | $coupon = $this->wcHelper->createWcCoupon(''); |
| 103 | $coupon->set_code($code); |
| 104 | $coupon->set_description($this->getCouponDescription($context)); |
| 105 | $coupon->set_discount_type($validatedAttrs['discountType']); |
| 106 | $coupon->set_amount($validatedAttrs['amount']); |
| 107 | |
| 108 | if ($validatedAttrs['expiryDay'] > 0) { |
| 109 | $coupon->set_date_expires(time() + ($validatedAttrs['expiryDay'] * (defined('DAY_IN_SECONDS') ? DAY_IN_SECONDS : 86400))); |
| 110 | } |
| 111 | |
| 112 | $coupon->set_free_shipping($validatedAttrs['freeShipping']); |
| 113 | $coupon->set_minimum_amount($validatedAttrs['minimumAmount']); |
| 114 | $coupon->set_maximum_amount($validatedAttrs['maximumAmount']); |
| 115 | $coupon->set_individual_use($validatedAttrs['individualUse']); |
| 116 | $coupon->set_exclude_sale_items($validatedAttrs['excludeSaleItems']); |
| 117 | $coupon->set_product_ids($validatedAttrs['productIds']); |
| 118 | $coupon->set_excluded_product_ids($validatedAttrs['excludedProductIds']); |
| 119 | $coupon->set_product_categories($validatedAttrs['productCategoryIds']); |
| 120 | $coupon->set_excluded_product_categories($validatedAttrs['excludedProductCategoryIds']); |
| 121 | $coupon->set_email_restrictions($validatedAttrs['emailRestrictions']); |
| 122 | $coupon->set_usage_limit($validatedAttrs['usageLimit']); |
| 123 | $coupon->set_usage_limit_per_user($validatedAttrs['usageLimitPerUser']); |
| 124 | |
| 125 | $couponId = $coupon->save(); |
| 126 | if (!$couponId) { |
| 127 | throw new \RuntimeException('WooCommerce did not save the generated coupon.'); |
| 128 | } |
| 129 | |
| 130 | return $code; |
| 131 | } catch (\Throwable $e) { |
| 132 | $this->recordFailure('generation_failed', $e->getMessage(), $attrs, $context); |
| 133 | return self::SAFE_PLACEHOLDER; |
| 134 | } |
| 135 | } |
| 136 | |
| 137 | public function registerEmailRenderer(): void { |
| 138 | if (!class_exists('\WP_Block_Type_Registry')) { |
| 139 | return; |
| 140 | } |
| 141 | |
| 142 | $blockType = \WP_Block_Type_Registry::get_instance()->get_registered(CouponBlock::NAME); |
| 143 | $renderEmailCallbackProperty = 'render_email_callback'; |
| 144 | $currentCallback = $blockType ? (get_object_vars($blockType)[$renderEmailCallbackProperty] ?? null) : null; |
| 145 | if (!$blockType || $this->usesWooCommerceEmailEditorRenderer($currentCallback)) { |
| 146 | return; |
| 147 | } |
| 148 | |
| 149 | // WooCommerce 10.8 development builds can expose the block attributes |
| 150 | // without wiring the matching email renderer. Patch only that gap. |
| 151 | // @phpstan-ignore-next-line -- WooCommerce email editor reads this dynamic block setting. |
| 152 | $blockType->{$renderEmailCallbackProperty} = [$this, 'renderEmailCouponBlock']; |
| 153 | } |
| 154 | |
| 155 | public function renderEmailCouponBlock(string $blockContent, array $parsedBlock, Rendering_Context $renderingContext): string { |
| 156 | $attrs = $parsedBlock['attrs'] ?? []; |
| 157 | if (!is_array($attrs)) { |
| 158 | $attrs = []; |
| 159 | } |
| 160 | |
| 161 | if (!CouponBlock::isCreateNew($attrs, strpos($blockContent, self::SAFE_PLACEHOLDER) !== false)) { |
| 162 | return $blockContent; |
| 163 | } |
| 164 | |
| 165 | $couponCode = $this->wp->applyFilters( |
| 166 | 'woocommerce_coupon_code_block_auto_generate', |
| 167 | '', |
| 168 | $attrs, |
| 169 | $renderingContext |
| 170 | ); |
| 171 | $couponCode = is_scalar($couponCode) ? (string)$couponCode : ''; |
| 172 | |
| 173 | if ($couponCode === '') { |
| 174 | return ''; |
| 175 | } |
| 176 | |
| 177 | return str_replace(self::SAFE_PLACEHOLDER, $this->wp->escHtml($couponCode), $blockContent); |
| 178 | } |
| 179 | |
| 180 | private function usesWooCommerceEmailEditorRenderer($callback): bool { |
| 181 | if (!is_array($callback) || !isset($callback[0]) || !is_object($callback[0])) { |
| 182 | return false; |
| 183 | } |
| 184 | |
| 185 | return strpos(get_class($callback[0]), 'Automattic\\WooCommerce\\EmailEditor\\Integrations\\WooCommerce\\') === 0; |
| 186 | } |
| 187 | |
| 188 | private function getUnsupportedRealSendContextMessage(array $attrs, Rendering_Context $renderingContext): ?string { |
| 189 | $requiresRecipientEmail = CouponBlockAttributeParser::toBoolean($attrs['restrictToSubscriber'] ?? false); |
| 190 | if ($this->isSupportedAutomationContext($renderingContext, $requiresRecipientEmail)) { |
| 191 | return null; |
| 192 | } |
| 193 | |
| 194 | if ($requiresRecipientEmail) { |
| 195 | return 'Recipient-restricted generated coupons are only supported in automation emails sent to one subscriber at a time.'; |
| 196 | } |
| 197 | |
| 198 | if ($this->isSupportedStandardContext($renderingContext)) { |
| 199 | return null; |
| 200 | } |
| 201 | |
| 202 | return 'Auto-generated coupon codes are only supported in regular newsletters and automation emails sent to one subscriber at a time.'; |
| 203 | } |
| 204 | |
| 205 | private function isSupportedAutomationContext(Rendering_Context $renderingContext, bool $requiresRecipientEmail): bool { |
| 206 | $context = $renderingContext->get_email_context(); |
| 207 | $recipientEmail = $renderingContext->get_recipient_email(); |
| 208 | $automationTypes = [ |
| 209 | NewsletterEntity::TYPE_AUTOMATION, |
| 210 | NewsletterEntity::TYPE_AUTOMATION_NOTIFICATION, |
| 211 | NewsletterEntity::TYPE_AUTOMATION_TRANSACTIONAL, |
| 212 | ]; |
| 213 | |
| 214 | return ($context['integration'] ?? null) === 'mailpoet' |
| 215 | && ($context['is_real_send'] ?? null) === true |
| 216 | && ($context['is_preview'] ?? null) === false |
| 217 | && ($context['is_single_recipient'] ?? null) === true |
| 218 | && is_numeric($context['subscriber_count'] ?? null) |
| 219 | && (int)$context['subscriber_count'] === 1 |
| 220 | && ($context['mailpoet_is_automation'] ?? null) === true |
| 221 | && in_array($context['email_type'] ?? '', $automationTypes, true) |
| 222 | && ( |
| 223 | !$requiresRecipientEmail |
| 224 | || (is_string($recipientEmail) && (bool)$this->wp->isEmail($recipientEmail)) |
| 225 | ); |
| 226 | } |
| 227 | |
| 228 | private function isSupportedStandardContext(Rendering_Context $renderingContext): bool { |
| 229 | $context = $renderingContext->get_email_context(); |
| 230 | return ($context['integration'] ?? null) === 'mailpoet' |
| 231 | && ($context['is_real_send'] ?? null) === true |
| 232 | && ($context['is_preview'] ?? null) === false |
| 233 | && ($context['email_type'] ?? '') === NewsletterEntity::TYPE_STANDARD |
| 234 | && ($context['mailpoet_is_automation'] ?? null) === false |
| 235 | && is_numeric($context['subscriber_count'] ?? null) |
| 236 | && (int)$context['subscriber_count'] >= 1; |
| 237 | } |
| 238 | |
| 239 | private function generateUniqueCode(): string { |
| 240 | for ($i = 0; $i < self::MAX_CODE_RETRIES; $i++) { |
| 241 | $code = $this->randomCouponCodeGenerator->generate(); |
| 242 | if (!$this->wcHelper->wcGetCouponIdByCode($code)) { |
| 243 | return $code; |
| 244 | } |
| 245 | } |
| 246 | |
| 247 | throw new \RuntimeException('Failed to generate a unique coupon code.'); |
| 248 | } |
| 249 | |
| 250 | private function getCouponDescription(array $context): string { |
| 251 | return sprintf( |
| 252 | // translators: %1$d is the MailPoet email ID. |
| 253 | _x('Auto-generated coupon by MailPoet for email: %1$d', 'Coupon block code generation', 'mailpoet'), |
| 254 | (int)($context['newsletter_id'] ?? 0) |
| 255 | ); |
| 256 | } |
| 257 | |
| 258 | private function recordFailure(string $code, string $message, array $attrs, array $context): void { |
| 259 | $safeContext = array_intersect_key($context, array_flip([ |
| 260 | 'integration', |
| 261 | 'newsletter_id', |
| 262 | 'queue_id', |
| 263 | 'email_type', |
| 264 | 'is_real_send', |
| 265 | 'is_preview', |
| 266 | 'is_single_recipient', |
| 267 | 'subscriber_count', |
| 268 | 'mailpoet_is_automation', |
| 269 | ])); |
| 270 | |
| 271 | $this->failureCollector->record($code, $message, $attrs, $safeContext); |
| 272 | } |
| 273 | } |
| 274 |