Abilities.php
1 month ago
WooCommerceAutomationTemplates.php
1 month ago
WooCommerceMarketingStatus.php
1 month ago
index.php
1 month ago
WooCommerceMarketingStatus.php
267 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Abilities; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use Automattic\WooCommerce\Abilities\AbilityDefinition; |
| 9 | use MailPoet\AutomaticEmails\WooCommerce\Events\AbandonedCart; |
| 10 | use MailPoet\AutomaticEmails\WooCommerce\Events\FirstPurchase; |
| 11 | use MailPoet\AutomaticEmails\WooCommerce\Events\PurchasedInCategory; |
| 12 | use MailPoet\AutomaticEmails\WooCommerce\Events\PurchasedProduct; |
| 13 | use MailPoet\Automation\Engine\Storage\AutomationStorage; |
| 14 | use MailPoet\Automation\Integrations\MailPoet\Actions\SendEmailAction; |
| 15 | use MailPoet\Automation\Integrations\WooCommerce\Triggers\AbandonedCart\AbandonedCartTrigger; |
| 16 | use MailPoet\Automation\Integrations\WooCommerce\Triggers\BuysAProductTrigger; |
| 17 | use MailPoet\Automation\Integrations\WooCommerce\Triggers\BuysFromACategoryTrigger; |
| 18 | use MailPoet\Automation\Integrations\WooCommerce\Triggers\BuysFromATagTrigger; |
| 19 | use MailPoet\Config\AccessControl; |
| 20 | use MailPoet\Config\Hooks; |
| 21 | use MailPoet\DI\ContainerWrapper; |
| 22 | use MailPoet\Entities\SegmentEntity; |
| 23 | use MailPoet\Newsletter\NewslettersRepository; |
| 24 | use MailPoet\Segments\SegmentsRepository; |
| 25 | use MailPoet\Settings\SettingsController; |
| 26 | use MailPoet\Settings\TrackingConfig; |
| 27 | use MailPoet\WooCommerce\Helper as WooCommerceHelper; |
| 28 | use MailPoet\WooCommerce\Subscription; |
| 29 | use MailPoet\WooCommerce\TransactionalEmails; |
| 30 | use MailPoet\WP\Functions as WPFunctions; |
| 31 | |
| 32 | if (!defined('ABSPATH')) exit; |
| 33 | |
| 34 | if (!interface_exists(AbilityDefinition::class)) { |
| 35 | return; |
| 36 | } |
| 37 | |
| 38 | class WooCommerceMarketingStatus implements AbilityDefinition { |
| 39 | private const TRACKING_LEVELS = [ |
| 40 | TrackingConfig::LEVEL_FULL, |
| 41 | TrackingConfig::LEVEL_PARTIAL, |
| 42 | TrackingConfig::LEVEL_BASIC, |
| 43 | ]; |
| 44 | |
| 45 | public static function get_name(): string { // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps -- Required by WooCommerce's AbilityDefinition interface. |
| 46 | return 'mailpoet/get-woocommerce-marketing-status'; |
| 47 | } |
| 48 | |
| 49 | public static function get_registration_args(): array { // phpcs:ignore PSR1.Methods.CamelCapsMethodName.NotCamelCaps -- Required by WooCommerce's AbilityDefinition interface. |
| 50 | return [ |
| 51 | 'label' => __('Get MailPoet WooCommerce marketing status', 'mailpoet'), |
| 52 | 'description' => __('Read MailPoet WooCommerce marketing, checkout opt-in, and email editor status.', 'mailpoet'), |
| 53 | 'category' => 'woocommerce', |
| 54 | 'output_schema' => self::getOutputSchema(), |
| 55 | 'execute_callback' => [self::class, 'execute'], |
| 56 | 'permission_callback' => [self::class, 'canReadStatus'], |
| 57 | 'meta' => [ |
| 58 | 'show_in_rest' => true, |
| 59 | 'mcp' => [ |
| 60 | 'public' => true, |
| 61 | 'type' => 'tool', |
| 62 | ], |
| 63 | 'annotations' => [ |
| 64 | 'readonly' => true, |
| 65 | 'destructive' => false, |
| 66 | 'idempotent' => true, |
| 67 | ], |
| 68 | ], |
| 69 | ]; |
| 70 | } |
| 71 | |
| 72 | public static function execute(): array { |
| 73 | $container = ContainerWrapper::getInstance(); |
| 74 | |
| 75 | /** @var SettingsController $settings */ |
| 76 | $settings = $container->get(SettingsController::class); |
| 77 | /** @var WooCommerceHelper $woocommerceHelper */ |
| 78 | $woocommerceHelper = $container->get(WooCommerceHelper::class); |
| 79 | /** @var NewslettersRepository $newslettersRepository */ |
| 80 | $newslettersRepository = $container->get(NewslettersRepository::class); |
| 81 | /** @var SegmentsRepository $segmentsRepository */ |
| 82 | $segmentsRepository = $container->get(SegmentsRepository::class); |
| 83 | /** @var AutomationStorage $automationStorage */ |
| 84 | $automationStorage = $container->get(AutomationStorage::class); |
| 85 | |
| 86 | $checkoutSegmentIds = array_values(array_unique(array_map('absint', (array)$settings->get(Subscription::OPTIN_SEGMENTS_SETTING_NAME, [])))); |
| 87 | $position = $settings->get(Subscription::OPTIN_POSITION_SETTING_NAME, Hooks::DEFAULT_OPTIN_POSITION); |
| 88 | if (!is_string($position) || !array_key_exists($position, Hooks::OPTIN_HOOKS)) { |
| 89 | $position = Hooks::DEFAULT_OPTIN_POSITION; |
| 90 | } |
| 91 | $trackingLevel = $settings->get('tracking.level', TrackingConfig::LEVEL_FULL); |
| 92 | if (!is_string($trackingLevel) || !in_array($trackingLevel, self::TRACKING_LEVELS, true)) { |
| 93 | $trackingLevel = TrackingConfig::LEVEL_FULL; |
| 94 | } |
| 95 | |
| 96 | return [ |
| 97 | 'checkout_optin' => [ |
| 98 | 'enabled' => (bool)$settings->get(Subscription::OPTIN_ENABLED_SETTING_NAME, false), |
| 99 | 'message' => wp_strip_all_tags((string)$settings->get(Subscription::OPTIN_MESSAGE_SETTING_NAME, '')), |
| 100 | 'position' => $position, |
| 101 | 'segments' => self::formatSegments($segmentsRepository, $checkoutSegmentIds), |
| 102 | ], |
| 103 | 'transactional_email_editor' => [ |
| 104 | 'enabled' => (bool)$settings->get('woocommerce.use_mailpoet_editor', false), |
| 105 | 'template_configured' => absint($settings->get(TransactionalEmails::SETTING_EMAIL_ID, 0)) > 0, |
| 106 | ], |
| 107 | 'legacy_automatic_emails' => [ |
| 108 | 'active_counts' => [ |
| 109 | 'abandoned_cart' => $newslettersRepository->getCountOfActiveAutomaticEmailsForEvent(AbandonedCart::SLUG), |
| 110 | 'first_purchase' => $newslettersRepository->getCountOfActiveAutomaticEmailsForEvent(FirstPurchase::SLUG), |
| 111 | 'purchased_in_category' => $newslettersRepository->getCountOfActiveAutomaticEmailsForEvent(PurchasedInCategory::SLUG), |
| 112 | 'purchased_product' => $newslettersRepository->getCountOfActiveAutomaticEmailsForEvent(PurchasedProduct::SLUG), |
| 113 | ], |
| 114 | ], |
| 115 | 'automations' => [ |
| 116 | 'active_email_counts' => self::getAutomationEmailCounts($automationStorage), |
| 117 | ], |
| 118 | 'measurement' => [ |
| 119 | 'tracking_level' => $trackingLevel, |
| 120 | 'analytics_enabled' => (bool)$settings->get('analytics.enabled', false), |
| 121 | 'revenue_attribution_order_statuses' => $woocommerceHelper->getPurchaseStates(), |
| 122 | ], |
| 123 | ]; |
| 124 | } |
| 125 | |
| 126 | public static function canReadStatus(): bool { |
| 127 | return WPFunctions::get()->currentUserCan(AccessControl::PERMISSION_MANAGE_SETTINGS); |
| 128 | } |
| 129 | |
| 130 | private static function getOutputSchema(): array { |
| 131 | return [ |
| 132 | 'type' => 'object', |
| 133 | 'properties' => [ |
| 134 | 'checkout_optin' => [ |
| 135 | 'type' => 'object', |
| 136 | 'properties' => [ |
| 137 | 'enabled' => ['type' => 'boolean'], |
| 138 | 'message' => ['type' => 'string'], |
| 139 | 'position' => [ |
| 140 | 'type' => 'string', |
| 141 | 'enum' => array_keys(Hooks::OPTIN_HOOKS), |
| 142 | ], |
| 143 | 'segments' => [ |
| 144 | 'type' => 'array', |
| 145 | 'items' => [ |
| 146 | 'type' => 'object', |
| 147 | 'properties' => [ |
| 148 | 'id' => ['type' => 'integer'], |
| 149 | 'name' => ['type' => 'string'], |
| 150 | ], |
| 151 | 'required' => ['id', 'name'], |
| 152 | 'additionalProperties' => false, |
| 153 | ], |
| 154 | ], |
| 155 | ], |
| 156 | 'required' => ['enabled', 'message', 'position', 'segments'], |
| 157 | 'additionalProperties' => false, |
| 158 | ], |
| 159 | 'transactional_email_editor' => [ |
| 160 | 'type' => 'object', |
| 161 | 'properties' => [ |
| 162 | 'enabled' => ['type' => 'boolean'], |
| 163 | 'template_configured' => ['type' => 'boolean'], |
| 164 | ], |
| 165 | 'required' => ['enabled', 'template_configured'], |
| 166 | 'additionalProperties' => false, |
| 167 | ], |
| 168 | 'legacy_automatic_emails' => [ |
| 169 | 'type' => 'object', |
| 170 | 'properties' => [ |
| 171 | 'active_counts' => [ |
| 172 | 'type' => 'object', |
| 173 | 'properties' => [ |
| 174 | 'abandoned_cart' => ['type' => 'integer'], |
| 175 | 'first_purchase' => ['type' => 'integer'], |
| 176 | 'purchased_in_category' => ['type' => 'integer'], |
| 177 | 'purchased_product' => ['type' => 'integer'], |
| 178 | ], |
| 179 | 'required' => ['abandoned_cart', 'first_purchase', 'purchased_in_category', 'purchased_product'], |
| 180 | 'additionalProperties' => false, |
| 181 | ], |
| 182 | ], |
| 183 | 'required' => ['active_counts'], |
| 184 | 'additionalProperties' => false, |
| 185 | ], |
| 186 | 'automations' => [ |
| 187 | 'type' => 'object', |
| 188 | 'properties' => [ |
| 189 | 'active_email_counts' => [ |
| 190 | 'type' => 'object', |
| 191 | 'properties' => [ |
| 192 | 'abandoned_cart' => ['type' => 'integer'], |
| 193 | 'order_completed' => ['type' => 'integer'], |
| 194 | 'order_created' => ['type' => 'integer'], |
| 195 | 'order_status_changed' => ['type' => 'integer'], |
| 196 | 'purchased_in_category' => ['type' => 'integer'], |
| 197 | 'purchased_product' => ['type' => 'integer'], |
| 198 | 'purchased_with_tag' => ['type' => 'integer'], |
| 199 | ], |
| 200 | 'required' => ['abandoned_cart', 'order_completed', 'order_created', 'order_status_changed', 'purchased_in_category', 'purchased_product', 'purchased_with_tag'], |
| 201 | 'additionalProperties' => false, |
| 202 | ], |
| 203 | ], |
| 204 | 'required' => ['active_email_counts'], |
| 205 | 'additionalProperties' => false, |
| 206 | ], |
| 207 | 'measurement' => [ |
| 208 | 'type' => 'object', |
| 209 | 'properties' => [ |
| 210 | 'tracking_level' => [ |
| 211 | 'type' => 'string', |
| 212 | 'enum' => self::TRACKING_LEVELS, |
| 213 | ], |
| 214 | 'analytics_enabled' => ['type' => 'boolean'], |
| 215 | 'revenue_attribution_order_statuses' => [ |
| 216 | 'type' => 'array', |
| 217 | 'items' => ['type' => 'string'], |
| 218 | ], |
| 219 | ], |
| 220 | 'required' => ['tracking_level', 'analytics_enabled', 'revenue_attribution_order_statuses'], |
| 221 | 'additionalProperties' => false, |
| 222 | ], |
| 223 | ], |
| 224 | 'required' => ['checkout_optin', 'transactional_email_editor', 'legacy_automatic_emails', 'automations', 'measurement'], |
| 225 | 'additionalProperties' => false, |
| 226 | ]; |
| 227 | } |
| 228 | |
| 229 | private static function formatSegments(SegmentsRepository $segmentsRepository, array $segmentIds): array { |
| 230 | if (!$segmentIds) { |
| 231 | return []; |
| 232 | } |
| 233 | |
| 234 | $segmentsById = []; |
| 235 | foreach ($segmentsRepository->findByIds($segmentIds) as $segment) { |
| 236 | if (!$segment instanceof SegmentEntity || $segment->getId() === null) { |
| 237 | continue; |
| 238 | } |
| 239 | $segmentsById[(int)$segment->getId()] = [ |
| 240 | 'id' => (int)$segment->getId(), |
| 241 | 'name' => $segment->getName(), |
| 242 | ]; |
| 243 | } |
| 244 | |
| 245 | $selectedSegments = []; |
| 246 | foreach ($segmentIds as $segmentId) { |
| 247 | if (isset($segmentsById[$segmentId])) { |
| 248 | $selectedSegments[] = $segmentsById[$segmentId]; |
| 249 | } |
| 250 | } |
| 251 | |
| 252 | return $selectedSegments; |
| 253 | } |
| 254 | |
| 255 | private static function getAutomationEmailCounts(AutomationStorage $automationStorage): array { |
| 256 | return [ |
| 257 | 'abandoned_cart' => $automationStorage->getCountOfActiveByTriggerKeysAndAction([AbandonedCartTrigger::KEY], SendEmailAction::KEY), |
| 258 | 'order_completed' => $automationStorage->getCountOfActiveByTriggerKeysAndAction(['woocommerce:order-completed'], SendEmailAction::KEY), |
| 259 | 'order_created' => $automationStorage->getCountOfActiveByTriggerKeysAndAction(['woocommerce:order-created'], SendEmailAction::KEY), |
| 260 | 'order_status_changed' => $automationStorage->getCountOfActiveByTriggerKeysAndAction(['woocommerce:order-status-changed'], SendEmailAction::KEY), |
| 261 | 'purchased_in_category' => $automationStorage->getCountOfActiveByTriggerKeysAndAction([BuysFromACategoryTrigger::KEY], SendEmailAction::KEY), |
| 262 | 'purchased_product' => $automationStorage->getCountOfActiveByTriggerKeysAndAction([BuysAProductTrigger::KEY], SendEmailAction::KEY), |
| 263 | 'purchased_with_tag' => $automationStorage->getCountOfActiveByTriggerKeysAndAction([BuysFromATagTrigger::KEY], SendEmailAction::KEY), |
| 264 | ]; |
| 265 | } |
| 266 | } |
| 267 |