ContentPreprocessor.php
1 year ago
FontFamilyValidator.php
10 months ago
Renderer.php
10 months ago
Template.php
1 year ago
index.php
3 years ago
Renderer.php
264 lines
| 1 | <?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing |
| 2 | |
| 3 | namespace MailPoet\WooCommerce\TransactionalEmails; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Entities\NewsletterEntity; |
| 9 | use MailPoet\Newsletter\Renderer\Renderer as NewsletterRenderer; |
| 10 | use MailPoet\Newsletter\Shortcodes\Shortcodes; |
| 11 | use MailPoetVendor\csstidy; |
| 12 | use MailPoetVendor\csstidy_print; |
| 13 | |
| 14 | class Renderer { |
| 15 | const CONTENT_CONTAINER_ID = 'mailpoet_woocommerce_container'; |
| 16 | |
| 17 | /** @var csstidy */ |
| 18 | private $cssParser; |
| 19 | |
| 20 | /** @var NewsletterRenderer */ |
| 21 | private $renderer; |
| 22 | |
| 23 | /** @var string */ |
| 24 | private $htmlBeforeContent; |
| 25 | |
| 26 | /** @var string */ |
| 27 | private $htmlAfterContent; |
| 28 | |
| 29 | /** @var Shortcodes */ |
| 30 | private $shortcodes; |
| 31 | |
| 32 | /** @var FontFamilyValidator */ |
| 33 | private $fontFamilyValidator; |
| 34 | |
| 35 | public function __construct( |
| 36 | csstidy $cssParser, |
| 37 | NewsletterRenderer $renderer, |
| 38 | Shortcodes $shortcodes, |
| 39 | FontFamilyValidator $fontFamilyValidator |
| 40 | ) { |
| 41 | $this->cssParser = $cssParser; |
| 42 | $this->htmlBeforeContent = ''; |
| 43 | $this->htmlAfterContent = ''; |
| 44 | $this->renderer = $renderer; |
| 45 | $this->shortcodes = $shortcodes; |
| 46 | $this->fontFamilyValidator = $fontFamilyValidator; |
| 47 | } |
| 48 | |
| 49 | public function render(NewsletterEntity $newsletter, ?string $subject = null) { |
| 50 | $preparedNewsletter = $this->prepareNewsletterForRendering($newsletter); |
| 51 | $renderedNewsletter = $this->renderer->renderAsPreview($preparedNewsletter, 'html', $subject); |
| 52 | $headingText = $subject ?? ''; |
| 53 | |
| 54 | $renderedHtml = $this->processShortcodes($preparedNewsletter, $renderedNewsletter); |
| 55 | |
| 56 | $renderedHtml = str_replace(ContentPreprocessor::WC_HEADING_PLACEHOLDER, $headingText, $renderedHtml); |
| 57 | $html = explode(ContentPreprocessor::WC_CONTENT_PLACEHOLDER, $renderedHtml); |
| 58 | $this->htmlBeforeContent = $html[0]; |
| 59 | $this->htmlAfterContent = $html[1]; |
| 60 | } |
| 61 | |
| 62 | public function getHTMLBeforeContent() { |
| 63 | if (empty($this->htmlBeforeContent)) { |
| 64 | throw new \Exception("You should call 'render' before 'getHTMLBeforeContent'"); |
| 65 | } |
| 66 | return $this->htmlBeforeContent . '<!--WooContent--><div id="' . self::CONTENT_CONTAINER_ID . '"><div id="body_content"><div id="body_content_inner"><table style="width: 100%"><tr><td style="padding: 10px 20px;">'; |
| 67 | } |
| 68 | |
| 69 | public function getHTMLAfterContent() { |
| 70 | if (empty($this->htmlAfterContent)) { |
| 71 | throw new \Exception("You should call 'render' before 'getHTMLAfterContent'"); |
| 72 | } |
| 73 | return '<!--WooContent--></td></tr></table></div></div></div>' . $this->htmlAfterContent; |
| 74 | } |
| 75 | |
| 76 | /** |
| 77 | * In this method we alter the rendered content that is output when processing the WooCommerce email template. |
| 78 | * - We update inlined font-family rules in the content block generated by Woo |
| 79 | */ |
| 80 | public function updateRenderedContent(NewsletterEntity $newsletter, string $content): string { |
| 81 | $isSavedWithStyledWooBlock = $newsletter->getGlobalStyle('woocommerce', 'isSavedWithUpdatedStyles'); |
| 82 | // For Backward compatibility do not apply styles for content unless the template was edited with the editor |
| 83 | // and user visually checked and is aware of updated styles feature. |
| 84 | if (!$isSavedWithStyledWooBlock) { |
| 85 | return $content; |
| 86 | } |
| 87 | $contentParts = explode('<!--WooContent-->', $content); |
| 88 | if (count($contentParts) !== 3) { |
| 89 | return $content; |
| 90 | } |
| 91 | [$beforeWooContent, $wooContent, $afterWooContent] = $contentParts; |
| 92 | $fontFamily = $newsletter->getGlobalStyle('text', 'fontFamily'); |
| 93 | |
| 94 | // Only replace font family if user provided a custom font |
| 95 | if (!empty($fontFamily)) { |
| 96 | // Validate and sanitize font family |
| 97 | $safeFontFamily = $this->fontFamilyValidator->validateFontFamily($fontFamily); |
| 98 | $wooContent = $this->replaceFontFamily($wooContent, $safeFontFamily); |
| 99 | } |
| 100 | |
| 101 | return implode('', [$beforeWooContent, $wooContent, $afterWooContent]); |
| 102 | } |
| 103 | |
| 104 | private function replaceFontFamily(string $content, string $fontFamily): string { |
| 105 | $processor = new \WP_HTML_Tag_Processor($content); |
| 106 | |
| 107 | // Process all tags that might have style attributes |
| 108 | while ($processor->next_tag()) { |
| 109 | $styleAttr = $processor->get_attribute('style'); |
| 110 | if (empty($styleAttr)) { |
| 111 | continue; |
| 112 | } |
| 113 | |
| 114 | // Fast path: avoid parsing when no font-family present |
| 115 | if (stripos($styleAttr, 'font-family') === false) { |
| 116 | continue; |
| 117 | } |
| 118 | |
| 119 | // Use CSS parser for CSS manipulation |
| 120 | // Wrap inline style in a selector so csstidy can parse it properly |
| 121 | $cssParser = new csstidy(); |
| 122 | $cssParser->settings['compress_colors'] = false; |
| 123 | $cssParser->settings['remove_last_;'] = false; |
| 124 | $cssParser->parse('x { ' . $styleAttr . ' }'); |
| 125 | |
| 126 | // Update font-family in parsed CSS |
| 127 | $updated = false; |
| 128 | foreach ($cssParser->css as $index => $rules) { |
| 129 | foreach ($rules as $selector => $properties) { |
| 130 | if (isset($properties['font-family'])) { |
| 131 | $properties['font-family'] = $fontFamily; |
| 132 | $cssParser->css[$index][$selector] = $properties; |
| 133 | $updated = true; |
| 134 | } |
| 135 | } |
| 136 | } |
| 137 | |
| 138 | // Only update the attribute if we made changes |
| 139 | if ($updated) { |
| 140 | /** @var csstidy_print $print */ |
| 141 | $print = $cssParser->print; |
| 142 | $fullCss = $print->plain(); |
| 143 | // Extract the properties from "x { ... }" format |
| 144 | if (preg_match('/x\s*{\s*(.*)\s*}/s', $fullCss, $matches)) { |
| 145 | $updatedStyle = trim($matches[1]); |
| 146 | $processor->set_attribute('style', $updatedStyle); |
| 147 | } |
| 148 | } |
| 149 | } |
| 150 | |
| 151 | return $processor->get_updated_html(); |
| 152 | } |
| 153 | |
| 154 | /** |
| 155 | * In this method we alter CSS that is later inlined into the WooCommerce email template. WooCommerce use Emogrifier to inline CSS. |
| 156 | * The inlining is called after the rendering and after the modifications we apply to the rendered content in self::updateRenderedContent |
| 157 | * - We prefix the original selectors to avoid inlining those rules into content added int the MailPoet's editor. |
| 158 | * - We update the font-family in the original CSS if it's set in the editor. |
| 159 | * - We update the font-size for the inner content if it's set in the editor. |
| 160 | */ |
| 161 | public function enhanceCss(string $css, NewsletterEntity $newsletter): string { |
| 162 | $this->cssParser->settings['compress_colors'] = false; |
| 163 | $this->cssParser->parse($css); |
| 164 | foreach ($this->cssParser->css as $index => $rules) { |
| 165 | $this->cssParser->css[$index] = []; |
| 166 | foreach ($rules as $selectors => $properties) { |
| 167 | $properties = $this->updateStyleDefinition($selectors, $newsletter, $properties); |
| 168 | $selectors = explode(',', $selectors); |
| 169 | $selectors = array_map(function($selector) { |
| 170 | return '#' . self::CONTENT_CONTAINER_ID . ' ' . $selector; |
| 171 | }, $selectors); |
| 172 | $selectors = implode(',', $selectors); |
| 173 | |
| 174 | $this->cssParser->css[$index][$selectors] = $properties; |
| 175 | } |
| 176 | } |
| 177 | |
| 178 | /** @var csstidy_print */ |
| 179 | $print = $this->cssParser->print; |
| 180 | $css = $print->plain(); |
| 181 | |
| 182 | // Enforce the special heading color for the WooCommerce email header |
| 183 | $wooHeadingColor = $newsletter->getGlobalStyle('woocommerce', 'headingFontColor'); |
| 184 | if ($wooHeadingColor) { |
| 185 | $css .= "#mailpoet-woo-email-header { color: $wooHeadingColor !important; }"; |
| 186 | } |
| 187 | return $css; |
| 188 | } |
| 189 | |
| 190 | private function processShortcodes(NewsletterEntity $newsletter, $content) { |
| 191 | $this->shortcodes->setQueue(null); |
| 192 | $this->shortcodes->setSubscriber(null); |
| 193 | $this->shortcodes->setNewsletter($newsletter); |
| 194 | return $this->shortcodes->replace($content); |
| 195 | } |
| 196 | |
| 197 | /** |
| 198 | * This method prepares the newsletter for rendering |
| 199 | * - We ensure that the font-family and branding color are used as default for all headings |
| 200 | */ |
| 201 | private function prepareNewsletterForRendering(NewsletterEntity $newsletter): NewsletterEntity { |
| 202 | $newsletterClone = clone($newsletter); |
| 203 | $headingFontFamily = $this->fontFamilyValidator->validateFontFamily($newsletter->getGlobalStyle('woocommerce', 'headingFontFamily')); |
| 204 | if ($headingFontFamily !== FontFamilyValidator::DEFAULT_FONT_FAMILY) { |
| 205 | $newsletterClone->setGlobalStyle('h1', 'fontFamily', $headingFontFamily); |
| 206 | $newsletterClone->setGlobalStyle('h2', 'fontFamily', $headingFontFamily); |
| 207 | $newsletterClone->setGlobalStyle('h3', 'fontFamily', $headingFontFamily); |
| 208 | } |
| 209 | $brandingColor = $newsletter->getGlobalStyle('woocommerce', 'brandingColor'); |
| 210 | $contentHeadingColor = $newsletter->getGlobalStyle('woocommerce', 'contentHeadingFontColor') ?? $brandingColor; |
| 211 | if ($contentHeadingColor) { |
| 212 | $newsletterClone->setGlobalStyle('h1', 'color', $contentHeadingColor); |
| 213 | $newsletterClone->setGlobalStyle('h2', 'color', $contentHeadingColor); |
| 214 | $newsletterClone->setGlobalStyle('h3', 'color', $contentHeadingColor); |
| 215 | } |
| 216 | return $newsletterClone; |
| 217 | } |
| 218 | |
| 219 | private function updateStyleDefinition(string $selectors, NewsletterEntity $newsletter, $properties) { |
| 220 | // For Backward compatibility do not apply styles for content unless the template was edited with the editor |
| 221 | // and user visually checked and is aware of updated styles feature. |
| 222 | $isSavedWithStyledWooBlock = $newsletter->getGlobalStyle('woocommerce', 'isSavedWithUpdatedStyles'); |
| 223 | if (!$isSavedWithStyledWooBlock) { |
| 224 | return $properties; |
| 225 | } |
| 226 | |
| 227 | if (!is_array($properties)) { |
| 228 | $properties = []; |
| 229 | } |
| 230 | $fontFamilyRaw = $newsletter->getGlobalStyle('text', 'fontFamily'); |
| 231 | $headingFontFamilyRaw = $newsletter->getGlobalStyle('woocommerce', 'headingFontFamily'); |
| 232 | $fontFamily = $fontFamilyRaw !== null ? $this->fontFamilyValidator->validateFontFamily($fontFamilyRaw) : null; |
| 233 | $headingFontFamily = $headingFontFamilyRaw !== null ? $this->fontFamilyValidator->validateFontFamily($headingFontFamilyRaw) : null; |
| 234 | $fontSize = $newsletter->getGlobalStyle('text', 'fontSize'); |
| 235 | $brandingColor = $newsletter->getGlobalStyle('woocommerce', 'brandingColor'); |
| 236 | $contentHeadingColor = $newsletter->getGlobalStyle('woocommerce', 'contentHeadingFontColor') ?? $brandingColor; |
| 237 | |
| 238 | // Update font family if it's set in the editor |
| 239 | if (!empty($fontFamilyRaw) && !empty($properties['font-family'])) { |
| 240 | $properties['font-family'] = $fontFamily; |
| 241 | } |
| 242 | // Update font size for inner content |
| 243 | if ($fontSize && ($selectors === '#body_content_inner')) { |
| 244 | $properties['font-size'] = $fontSize; |
| 245 | } |
| 246 | |
| 247 | // Update heading font sizes and font family |
| 248 | $supportedHeadings = ['h1', 'h2', 'h3']; |
| 249 | foreach ($supportedHeadings as $heading) { |
| 250 | $headingFontSize = $newsletter->getGlobalStyle($heading, 'fontSize'); |
| 251 | if ($headingFontSize && ($selectors === $heading)) { |
| 252 | $properties['font-size'] = $headingFontSize; |
| 253 | } |
| 254 | if (!empty($headingFontFamilyRaw) && ($selectors === $heading)) { |
| 255 | $properties['font-family'] = $headingFontFamily; |
| 256 | } |
| 257 | if ($contentHeadingColor && ($selectors === $heading)) { |
| 258 | $properties['color'] = $contentHeadingColor; |
| 259 | } |
| 260 | } |
| 261 | return $properties; |
| 262 | } |
| 263 | } |
| 264 |