ViewInBrowserController.php
1 month ago
ViewInBrowserRenderer.php
2 months ago
index.php
3 years ago
ViewInBrowserRenderer.php
237 lines
| 1 | <?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing |
| 2 | |
| 3 | namespace MailPoet\Newsletter\ViewInBrowser; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use Automattic\WooCommerce\EmailEditor\Email_Editor_Container; |
| 9 | use Automattic\WooCommerce\EmailEditor\Engine\Personalizer; |
| 10 | use MailPoet\Entities\NewsletterEntity; |
| 11 | use MailPoet\Entities\SendingQueueEntity; |
| 12 | use MailPoet\Entities\SubscriberEntity; |
| 13 | use MailPoet\Newsletter\Links\Links; |
| 14 | use MailPoet\Newsletter\Renderer\Renderer; |
| 15 | use MailPoet\Newsletter\Shortcodes\Shortcodes; |
| 16 | use MailPoet\Newsletter\Url as NewsletterUrl; |
| 17 | use MailPoet\Settings\TrackingConfig; |
| 18 | use MailPoet\WP\Emoji; |
| 19 | |
| 20 | class ViewInBrowserRenderer { |
| 21 | private const OPTION_RENDER_AS_PREVIEW = 'renderAsPreview'; |
| 22 | private const OPTION_SANITIZE_RENDERED_QUEUE_LINKS = 'sanitizeRenderedQueueLinks'; |
| 23 | private const OPTION_SHORTCODES_PREVIEW = 'shortcodesPreview'; |
| 24 | private const OPTION_REPLACE_SUBSCRIBER_TRACKING = 'replaceSubscriberTracking'; |
| 25 | private const OPTION_PERSONALIZER_PREVIEW = 'personalizerPreview'; |
| 26 | private const OPTION_REPLACE_VIEW_IN_BROWSER_URL = 'replaceViewInBrowserUrlWithPublicShareUrl'; |
| 27 | |
| 28 | /** @var Emoji */ |
| 29 | private $emoji; |
| 30 | |
| 31 | /** @var TrackingConfig */ |
| 32 | private $trackingConfig; |
| 33 | |
| 34 | /** @var Renderer */ |
| 35 | private $renderer; |
| 36 | |
| 37 | /** @var Shortcodes */ |
| 38 | private $shortcodes; |
| 39 | |
| 40 | /** @var Links */ |
| 41 | private $links; |
| 42 | |
| 43 | /** @var NewsletterUrl */ |
| 44 | private $newsletterUrl; |
| 45 | |
| 46 | private Personalizer $personalizer; |
| 47 | |
| 48 | public function __construct( |
| 49 | Emoji $emoji, |
| 50 | TrackingConfig $trackingConfig, |
| 51 | Shortcodes $shortcodes, |
| 52 | Renderer $renderer, |
| 53 | Links $links, |
| 54 | NewsletterUrl $newsletterUrl |
| 55 | ) { |
| 56 | $this->emoji = $emoji; |
| 57 | $this->trackingConfig = $trackingConfig; |
| 58 | $this->renderer = $renderer; |
| 59 | $this->shortcodes = $shortcodes; |
| 60 | $this->links = $links; |
| 61 | $this->newsletterUrl = $newsletterUrl; |
| 62 | $this->personalizer = Email_Editor_Container::container()->get(Personalizer::class); |
| 63 | } |
| 64 | |
| 65 | public function render( |
| 66 | bool $isPreview, |
| 67 | NewsletterEntity $newsletter, |
| 68 | ?SubscriberEntity $subscriber = null, |
| 69 | ?SendingQueueEntity $queue = null |
| 70 | ) { |
| 71 | return $this->renderWithContext( |
| 72 | $newsletter, |
| 73 | $subscriber, |
| 74 | $queue, |
| 75 | $this->buildRenderOptionsForPreview($isPreview) |
| 76 | ); |
| 77 | } |
| 78 | |
| 79 | public function renderPublicShare( |
| 80 | NewsletterEntity $newsletter, |
| 81 | ?SendingQueueEntity $queue = null |
| 82 | ): string { |
| 83 | // An empty SubscriberEntity (not null) is intentional: the subscriber |
| 84 | // shortcode handler treats null as "leave the shortcode in place" but |
| 85 | // resolves `default:` arguments against any SubscriberEntity instance. |
| 86 | return $this->renderWithContext( |
| 87 | $newsletter, |
| 88 | new SubscriberEntity(), |
| 89 | $queue, |
| 90 | $this->buildRenderOptionsForPublicShare() |
| 91 | ); |
| 92 | } |
| 93 | |
| 94 | /** |
| 95 | * @param array{ |
| 96 | * renderAsPreview: bool, |
| 97 | * sanitizeRenderedQueueLinks: bool, |
| 98 | * shortcodesPreview: bool, |
| 99 | * replaceSubscriberTracking: bool, |
| 100 | * personalizerPreview: bool, |
| 101 | * replaceViewInBrowserUrlWithPublicShareUrl: bool |
| 102 | * } $options |
| 103 | */ |
| 104 | private function renderWithContext( |
| 105 | NewsletterEntity $newsletter, |
| 106 | ?SubscriberEntity $subscriber, |
| 107 | ?SendingQueueEntity $queue, |
| 108 | array $options |
| 109 | ): string { |
| 110 | $renderAsPreview = $options[self::OPTION_RENDER_AS_PREVIEW]; |
| 111 | $sanitizeRenderedQueueLinks = $options[self::OPTION_SANITIZE_RENDERED_QUEUE_LINKS]; |
| 112 | $shortcodesPreview = $options[self::OPTION_SHORTCODES_PREVIEW]; |
| 113 | $replaceSubscriberTracking = $options[self::OPTION_REPLACE_SUBSCRIBER_TRACKING]; |
| 114 | $personalizerPreview = $options[self::OPTION_PERSONALIZER_PREVIEW]; |
| 115 | $replaceViewInBrowserUrlWithPublicShareUrl = $options[self::OPTION_REPLACE_VIEW_IN_BROWSER_URL]; |
| 116 | |
| 117 | $isTrackingEnabled = $this->trackingConfig->isEmailTrackingEnabled(); |
| 118 | |
| 119 | if ($queue && $queue->getNewsletterRenderedBody()) { |
| 120 | $body = $queue->getNewsletterRenderedBody(); |
| 121 | if (is_array($body)) { |
| 122 | $newsletterBody = $body['html']; |
| 123 | } else { |
| 124 | $newsletterBody = ''; |
| 125 | } |
| 126 | $newsletterBody = $this->emoji->decodeEmojisInBody($newsletterBody); |
| 127 | // rendered newsletter body has shortcodes converted to links; we need to |
| 128 | // isolate "view in browser", "unsubscribe" and "manage subscription" links |
| 129 | // and convert them to shortcodes, which later will be replaced with "#" when |
| 130 | // newsletter is previewed |
| 131 | if ($sanitizeRenderedQueueLinks && preg_match($this->links->getLinkRegex(), $newsletterBody)) { |
| 132 | $newsletterBody = $this->links->convertHashedLinksToShortcodesAndUrls( |
| 133 | $newsletterBody, |
| 134 | $queue->getId(), |
| 135 | $convertAll = true |
| 136 | ); |
| 137 | // remove open tracking link |
| 138 | $newsletterBody = str_replace(Links::DATA_TAG_OPEN, '', $newsletterBody); |
| 139 | } |
| 140 | } else { |
| 141 | if ($renderAsPreview) { |
| 142 | $newsletterBody = $this->renderer->renderAsPreview($newsletter, 'html'); |
| 143 | } else { |
| 144 | $newsletterBody = $this->renderer->render($newsletter, $sendingTask = null, 'html'); |
| 145 | } |
| 146 | } |
| 147 | $this->prepareShortcodes( |
| 148 | $newsletter, |
| 149 | $subscriber, |
| 150 | $queue, |
| 151 | $shortcodesPreview |
| 152 | ); |
| 153 | $renderedNewsletter = $this->shortcodes->replace($newsletterBody); |
| 154 | if ($replaceViewInBrowserUrlWithPublicShareUrl) { |
| 155 | $renderedNewsletter = str_replace( |
| 156 | $this->newsletterUrl->getViewInBrowserUrl($newsletter, null, $queue, true), |
| 157 | $this->newsletterUrl->getPublicShareUrl($newsletter), |
| 158 | $renderedNewsletter |
| 159 | ); |
| 160 | } |
| 161 | if ($replaceSubscriberTracking && $queue && $subscriber && $isTrackingEnabled) { |
| 162 | $renderedNewsletter = $this->links->replaceSubscriberData( |
| 163 | $subscriber->getId(), |
| 164 | $queue->getId(), |
| 165 | $renderedNewsletter |
| 166 | ); |
| 167 | } |
| 168 | if ($newsletter->getWpPostId() !== null) { |
| 169 | $this->personalizer->set_context([ |
| 170 | 'recipient_email' => $subscriber ? $subscriber->getEmail() : null, |
| 171 | 'is_user_preview' => $personalizerPreview, |
| 172 | 'newsletter_id' => $newsletter->getId(), |
| 173 | 'queue_id' => $queue ? $queue->getId() : null, |
| 174 | ]); |
| 175 | $renderedNewsletter = $this->personalizer->personalize_content($renderedNewsletter); |
| 176 | } |
| 177 | return $renderedNewsletter; |
| 178 | } |
| 179 | |
| 180 | /** |
| 181 | * @return array{ |
| 182 | * renderAsPreview: bool, |
| 183 | * sanitizeRenderedQueueLinks: bool, |
| 184 | * shortcodesPreview: bool, |
| 185 | * replaceSubscriberTracking: bool, |
| 186 | * personalizerPreview: bool, |
| 187 | * replaceViewInBrowserUrlWithPublicShareUrl: bool |
| 188 | * } |
| 189 | */ |
| 190 | private function buildRenderOptionsForPreview(bool $isPreview): array { |
| 191 | return [ |
| 192 | self::OPTION_RENDER_AS_PREVIEW => $isPreview, |
| 193 | self::OPTION_SANITIZE_RENDERED_QUEUE_LINKS => $isPreview, |
| 194 | self::OPTION_SHORTCODES_PREVIEW => $isPreview, |
| 195 | self::OPTION_REPLACE_SUBSCRIBER_TRACKING => !$isPreview, |
| 196 | self::OPTION_PERSONALIZER_PREVIEW => $isPreview, |
| 197 | self::OPTION_REPLACE_VIEW_IN_BROWSER_URL => false, |
| 198 | ]; |
| 199 | } |
| 200 | |
| 201 | /** |
| 202 | * @return array{ |
| 203 | * renderAsPreview: bool, |
| 204 | * sanitizeRenderedQueueLinks: bool, |
| 205 | * shortcodesPreview: bool, |
| 206 | * replaceSubscriberTracking: bool, |
| 207 | * personalizerPreview: bool, |
| 208 | * replaceViewInBrowserUrlWithPublicShareUrl: bool |
| 209 | * } |
| 210 | */ |
| 211 | private function buildRenderOptionsForPublicShare(): array { |
| 212 | return [ |
| 213 | // Keep no-queue public share fallback in preview mode to avoid |
| 214 | // send-time preprocessing side effects and keep shortcode behavior |
| 215 | // consistent with the rendering mode. |
| 216 | self::OPTION_RENDER_AS_PREVIEW => true, |
| 217 | self::OPTION_SANITIZE_RENDERED_QUEUE_LINKS => true, |
| 218 | self::OPTION_SHORTCODES_PREVIEW => true, |
| 219 | self::OPTION_REPLACE_SUBSCRIBER_TRACKING => false, |
| 220 | self::OPTION_PERSONALIZER_PREVIEW => true, |
| 221 | self::OPTION_REPLACE_VIEW_IN_BROWSER_URL => true, |
| 222 | ]; |
| 223 | } |
| 224 | |
| 225 | private function prepareShortcodes( |
| 226 | NewsletterEntity $newsletter, |
| 227 | ?SubscriberEntity $subscriber, |
| 228 | ?SendingQueueEntity $queue, |
| 229 | bool $wpUserPreview |
| 230 | ) { |
| 231 | $this->shortcodes->setQueue($queue); |
| 232 | $this->shortcodes->setNewsletter($newsletter); |
| 233 | $this->shortcodes->setWpUserPreview($wpUserPreview); |
| 234 | $this->shortcodes->setSubscriber($subscriber); |
| 235 | } |
| 236 | } |
| 237 |