Blocks
1 day ago
Coupons
2 months ago
Endpoints
3 months ago
Patterns
2 months ago
PersonalizationTags
1 day ago
ProductCollection
2 months ago
Templates
2 weeks ago
AutomationEmailContextProvider.php
3 months ago
AutomationEmailPreviewOrderProvider.php
3 months ago
BlockEmailContentDetector.php
3 months ago
Cli.php
1 month ago
DependencyNotice.php
1 year ago
EditorPageRenderer.php
1 day ago
EmailApiController.php
1 month ago
EmailEditor.php
1 day ago
EmailEditorPreviewEmail.php
10 months ago
Logger.php
11 months ago
MailPoetCssInliner.php
9 months ago
MailpoetCssInlinerFactory.php
1 year ago
PersonalizationTagManager.php
1 day ago
index.php
2 years ago
EmailEditor.php
198 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\EmailEditor\Integrations\MailPoet; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\API\REST\API; |
| 9 | use MailPoet\EmailEditor\Integrations\MailPoet\Endpoints\GenerateSubjectSuggestionsEndpoint; |
| 10 | use MailPoet\EmailEditor\Integrations\MailPoet\Patterns\PatternsController; |
| 11 | use MailPoet\EmailEditor\Integrations\MailPoet\Templates\TemplatesController; |
| 12 | use MailPoet\Newsletter\NewslettersRepository; |
| 13 | use MailPoet\WP\Functions as WPFunctions; |
| 14 | use MailPoet\WPCOM\DotcomHelperFunctions; |
| 15 | |
| 16 | class EmailEditor { |
| 17 | const MAILPOET_EMAIL_POST_TYPE = 'mailpoet_email'; |
| 18 | |
| 19 | private WPFunctions $wp; |
| 20 | |
| 21 | private EmailApiController $emailApiController; |
| 22 | |
| 23 | private EditorPageRenderer $editorPageRenderer; |
| 24 | |
| 25 | private PatternsController $patternsController; |
| 26 | |
| 27 | private Cli $cli; |
| 28 | |
| 29 | private EmailEditorPreviewEmail $emailEditorPreviewEmail; |
| 30 | |
| 31 | private PersonalizationTagManager $personalizationTagManager; |
| 32 | |
| 33 | private TemplatesController $templatesController; |
| 34 | |
| 35 | private DotcomHelperFunctions $dotcomHelperFunctions; |
| 36 | |
| 37 | private NewslettersRepository $newslettersRepository; |
| 38 | |
| 39 | private bool $editorAlreadyRendered = false; |
| 40 | |
| 41 | public function __construct( |
| 42 | WPFunctions $wp, |
| 43 | EmailApiController $emailApiController, |
| 44 | EditorPageRenderer $editorPageRenderer, |
| 45 | EmailEditorPreviewEmail $emailEditorPreviewEmail, |
| 46 | PatternsController $patternsController, |
| 47 | TemplatesController $templatesController, |
| 48 | Cli $cli, |
| 49 | DotcomHelperFunctions $dotcomHelperFunctions, |
| 50 | PersonalizationTagManager $personalizationTagManager, |
| 51 | NewslettersRepository $newslettersRepository |
| 52 | ) { |
| 53 | $this->wp = $wp; |
| 54 | $this->emailApiController = $emailApiController; |
| 55 | $this->editorPageRenderer = $editorPageRenderer; |
| 56 | $this->patternsController = $patternsController; |
| 57 | $this->templatesController = $templatesController; |
| 58 | $this->cli = $cli; |
| 59 | $this->dotcomHelperFunctions = $dotcomHelperFunctions; |
| 60 | $this->emailEditorPreviewEmail = $emailEditorPreviewEmail; |
| 61 | $this->personalizationTagManager = $personalizationTagManager; |
| 62 | $this->newslettersRepository = $newslettersRepository; |
| 63 | } |
| 64 | |
| 65 | public function initialize(): void { |
| 66 | $this->cli->initialize(); |
| 67 | $this->wp->addFilter('woocommerce_email_editor_post_types', [$this, 'addEmailPostType']); |
| 68 | $this->wp->addAction('rest_delete_mailpoet_email', [$this->emailApiController, 'trashEmail'], 10, 1); |
| 69 | $this->wp->addFilter('woocommerce_is_email_editor_page', [$this, 'isEditorPage'], 10, 1); |
| 70 | $this->wp->addFilter('replace_editor', [$this, 'replaceEditor'], 10, 2); |
| 71 | $this->wp->addFilter('woocommerce_email_editor_send_preview_email', [$this->emailEditorPreviewEmail, 'sendPreviewEmail'], 10, 1); |
| 72 | $this->wp->addFilter('woocommerce_email_editor_send_preview_email_personalizer_context', [$this, 'extendPreviewPersonalizerContext'], 10, 1); |
| 73 | $this->wp->addFilter('rest_pre_insert_mailpoet_email', [$this, 'preserveAutomationEmailStatus'], 10, 2); |
| 74 | $this->patternsController->registerPatterns(); |
| 75 | // Skip classic templates in Garden environment. |
| 76 | if (!$this->dotcomHelperFunctions->isGarden()) { |
| 77 | $this->templatesController->initialize(); |
| 78 | } |
| 79 | $this->extendEmailPostApi(); |
| 80 | $this->registerApiRoutes(); |
| 81 | $this->personalizationTagManager->initialize(); |
| 82 | } |
| 83 | |
| 84 | public function addEmailPostType(array $postTypes): array { |
| 85 | $postTypes[] = [ |
| 86 | 'name' => self::MAILPOET_EMAIL_POST_TYPE, |
| 87 | 'args' => [ |
| 88 | 'labels' => [ |
| 89 | 'name' => __('Emails', 'mailpoet'), |
| 90 | 'singular_name' => __('Email', 'mailpoet'), |
| 91 | ], |
| 92 | 'rewrite' => ['slug' => self::MAILPOET_EMAIL_POST_TYPE], |
| 93 | ], |
| 94 | ]; |
| 95 | return $postTypes; |
| 96 | } |
| 97 | |
| 98 | public function isEditorPage(bool $isEditorPage): bool { |
| 99 | if ($isEditorPage) { |
| 100 | return $isEditorPage; |
| 101 | } |
| 102 | // We need to check early if we are on the email editor page. The check runs early so we can't use current_screen() here. |
| 103 | if ($this->wp->isAdmin() && isset($_GET['post']) && isset($_GET['action']) && $_GET['action'] === 'edit' && is_numeric($_GET['post'])) { |
| 104 | $post = $this->wp->getPost((int)$_GET['post']); |
| 105 | return $post && $post->post_type === self::MAILPOET_EMAIL_POST_TYPE; // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps |
| 106 | } |
| 107 | return false; |
| 108 | } |
| 109 | |
| 110 | private function registerApiRoutes(): void { |
| 111 | $this->wp->addAction(API::REST_API_INIT_ACTION, function (API $api) { |
| 112 | $api->registerPostRoute( |
| 113 | 'email/generate-subject-suggestions', |
| 114 | GenerateSubjectSuggestionsEndpoint::class |
| 115 | ); |
| 116 | }); |
| 117 | } |
| 118 | |
| 119 | public function extendEmailPostApi() { |
| 120 | $this->wp->registerRestField(self::MAILPOET_EMAIL_POST_TYPE, 'mailpoet_data', [ |
| 121 | 'get_callback' => [$this->emailApiController, 'getEmailData'], |
| 122 | 'update_callback' => [$this->emailApiController, 'saveEmailData'], |
| 123 | 'schema' => $this->emailApiController->getEmailDataSchema(), |
| 124 | ]); |
| 125 | } |
| 126 | |
| 127 | public function replaceEditor($replace, $post) { |
| 128 | $currentScreen = $this->wp->getCurrentScreen(); |
| 129 | if ($post->post_type === self::MAILPOET_EMAIL_POST_TYPE && $currentScreen) { // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps |
| 130 | // The no-arg WP_Screen::get() re-fires this filter, and some plugins (e.g. Yoast SEO |
| 131 | // Premium) call it during admin_enqueue_scripts — while render() is still printing |
| 132 | // the admin header. Rendering again would echo a second editor container into <head> |
| 133 | // and leave the editor unresponsive, so only report that the editor was replaced. |
| 134 | if ($this->editorAlreadyRendered) { |
| 135 | return true; |
| 136 | } |
| 137 | $this->editorAlreadyRendered = true; |
| 138 | $this->editorPageRenderer->render(); |
| 139 | return true; |
| 140 | } |
| 141 | return $replace; |
| 142 | } |
| 143 | |
| 144 | /** |
| 145 | * Extend preview personalizer context with automation sample data. |
| 146 | * This is called by WooCommerce Email Editor when rendering preview in browser. |
| 147 | * |
| 148 | * @param array<string, mixed> $context |
| 149 | * @return array<string, mixed> |
| 150 | */ |
| 151 | public function extendPreviewPersonalizerContext(array $context): array { |
| 152 | // Get the current post being previewed |
| 153 | $post = $this->wp->getPost(); |
| 154 | if (!$post || $post->post_type !== self::MAILPOET_EMAIL_POST_TYPE) { // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps |
| 155 | return $context; |
| 156 | } |
| 157 | |
| 158 | $newsletter = $this->newslettersRepository->findOneBy(['wpPost' => $post->ID]); |
| 159 | if (!$newsletter || (!$newsletter->isAutomation() && !$newsletter->isAutomationTransactional())) { |
| 160 | return $context; |
| 161 | } |
| 162 | |
| 163 | // Get automation ID and extend tags |
| 164 | $automationId = $newsletter->getOptionValue('automationId'); |
| 165 | if (!$automationId) { |
| 166 | return $context; |
| 167 | } |
| 168 | |
| 169 | // Extend personalization tags based on automation subjects |
| 170 | $this->personalizationTagManager->extendPersonalizationTagsByAutomationSubjects((int)$automationId); |
| 171 | |
| 172 | // Context is populated via woocommerce_email_editor_send_preview_email_personalizer_context filter |
| 173 | // which extensions can hook into to add their sample data |
| 174 | return $context; |
| 175 | } |
| 176 | |
| 177 | /** |
| 178 | * Preserve the 'private' status for automation emails when updating via REST API. |
| 179 | * This prevents the block editor from changing the status to 'draft' during autosave. |
| 180 | * |
| 181 | * @param \stdClass $preparedPost The prepared post data for insertion. |
| 182 | * @param \WP_REST_Request $request The REST request object. |
| 183 | * @return \stdClass The modified post data. |
| 184 | */ |
| 185 | public function preserveAutomationEmailStatus($preparedPost, $request) { |
| 186 | if (empty($preparedPost->ID)) { |
| 187 | return $preparedPost; |
| 188 | } |
| 189 | |
| 190 | $newsletter = $this->newslettersRepository->findOneBy(['wpPost' => $preparedPost->ID]); |
| 191 | if ($newsletter && ($newsletter->isAutomation() || $newsletter->isAutomationTransactional())) { |
| 192 | $preparedPost->post_status = 'private'; // phpcs:ignore Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps |
| 193 | } |
| 194 | |
| 195 | return $preparedPost; |
| 196 | } |
| 197 | } |
| 198 |