mailpoet
/
vendor
/
woocommerce
/
email-editor
/
src
/
Engine
/
Renderer
/
ContentRenderer
/
class-content-renderer.php
mailpoet
/
vendor
/
woocommerce
/
email-editor
/
src
/
Engine
/
Renderer
/
ContentRenderer
Last commit date
Layout
3 months ago
Postprocessors
11 months ago
Preprocessors
3 months ago
class-block-renderer.php
1 year ago
class-blocks-parser.php
1 year ago
class-content-renderer.php
3 months ago
class-preset-variable-resolver.php
4 months ago
class-process-manager.php
3 months ago
class-rendering-context.php
3 months ago
content.css
1 year ago
index.php
1 year ago
class-content-renderer.php
336 lines
| 1 | <?php |
| 2 | declare(strict_types = 1); |
| 3 | namespace Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer; |
| 4 | if (!defined('ABSPATH')) exit; |
| 5 | use Automattic\WooCommerce\EmailEditor\Engine\Logger\Email_Editor_Logger; |
| 6 | use Automattic\WooCommerce\EmailEditor\Engine\Renderer\Css_Inliner; |
| 7 | use Automattic\WooCommerce\EmailEditor\Engine\Theme_Controller; |
| 8 | use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Fallback; |
| 9 | use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Post_Content; |
| 10 | use Automattic\WooCommerce\EmailEditor\Integrations\Utils\Table_Wrapper_Helper; |
| 11 | use WP_Block_Template; |
| 12 | use WP_Block_Type_Registry; |
| 13 | use WP_Post; |
| 14 | use WP_Style_Engine; |
| 15 | class Content_Renderer { |
| 16 | private Process_Manager $process_manager; |
| 17 | private Theme_Controller $theme_controller; |
| 18 | const CONTENT_STYLES_FILE = 'content.css'; |
| 19 | private WP_Block_Type_Registry $block_type_registry; |
| 20 | private $backup_template_content; |
| 21 | private $backup_template_id; |
| 22 | private $backup_post; |
| 23 | private $backup_query; |
| 24 | private Fallback $fallback_renderer; |
| 25 | private Email_Editor_Logger $logger; |
| 26 | private $backup_post_content_callback; |
| 27 | private ?string $post_content_width = null; |
| 28 | private array $container_padding = array(); |
| 29 | private Css_Inliner $css_inliner; |
| 30 | private ?Rendering_Context $rendering_context = null; |
| 31 | public function __construct( |
| 32 | Process_Manager $preprocess_manager, |
| 33 | Css_Inliner $css_inliner, |
| 34 | Theme_Controller $theme_controller, |
| 35 | Email_Editor_Logger $logger |
| 36 | ) { |
| 37 | $this->process_manager = $preprocess_manager; |
| 38 | $this->css_inliner = $css_inliner; |
| 39 | $this->theme_controller = $theme_controller; |
| 40 | $this->logger = $logger; |
| 41 | $this->block_type_registry = WP_Block_Type_Registry::get_instance(); |
| 42 | $this->fallback_renderer = new Fallback(); |
| 43 | } |
| 44 | private function initialize() { |
| 45 | add_filter( 'render_block', array( $this, 'render_block' ), 10, 2 ); |
| 46 | add_filter( 'block_parser_class', array( $this, 'block_parser' ) ); |
| 47 | add_filter( 'woocommerce_email_blocks_renderer_parsed_blocks', array( $this, 'preprocess_parsed_blocks' ) ); |
| 48 | // Swap core/post-content render callback for email rendering. |
| 49 | // This prevents issues with WordPress's static $seen_ids array when rendering |
| 50 | // multiple emails in a single request (e.g., MailPoet batch processing). |
| 51 | $post_content_type = $this->block_type_registry->get_registered( 'core/post-content' ); |
| 52 | if ( $post_content_type ) { |
| 53 | // Save the original callback (may be null or WordPress's default). |
| 54 | $this->backup_post_content_callback = $post_content_type->render_callback; |
| 55 | // Replace with our stateless renderer. |
| 56 | $post_content_renderer = new Post_Content(); |
| 57 | $post_content_type->render_callback = array( $post_content_renderer, 'render_stateless' ); |
| 58 | } |
| 59 | } |
| 60 | public function set_rendering_context( Rendering_Context $rendering_context ): void { |
| 61 | $this->rendering_context = $rendering_context; |
| 62 | } |
| 63 | public function get_current_rendering_context(): ?Rendering_Context { |
| 64 | return $this->rendering_context; |
| 65 | } |
| 66 | public function restore_rendering_context( ?Rendering_Context $rendering_context ): void { |
| 67 | $this->rendering_context = $rendering_context; |
| 68 | } |
| 69 | public function render( WP_Post $post, WP_Block_Template $template ): string { |
| 70 | $result = $this->render_without_css_inline( $post, $template ); |
| 71 | $styles = '<style>' . $result['styles'] . '</style>'; |
| 72 | $html = $this->css_inliner->from_html( $styles . $result['html'] )->inline_css()->render(); |
| 73 | return $this->process_manager->postprocess( $html ); |
| 74 | } |
| 75 | public function render_without_css_inline( WP_Post $post, WP_Block_Template $template ): array { |
| 76 | if ( null === $this->rendering_context ) { |
| 77 | $this->rendering_context = $this->create_rendering_context( null, $post, $template ); |
| 78 | } |
| 79 | $this->set_template_globals( $post, $template ); |
| 80 | $this->initialize(); |
| 81 | try { |
| 82 | do_action( 'woocommerce_email_editor_render_start' ); |
| 83 | $rendered_html = get_the_block_template_html(); |
| 84 | } finally { |
| 85 | $this->reset(); |
| 86 | } |
| 87 | return array( |
| 88 | 'html' => $rendered_html, |
| 89 | 'styles' => $this->collect_styles( $post, $template ), |
| 90 | ); |
| 91 | } |
| 92 | public function block_parser() { |
| 93 | return 'Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Blocks_Parser'; |
| 94 | } |
| 95 | public function preprocess_parsed_blocks( array $parsed_blocks ): array { |
| 96 | $styles = $this->theme_controller->get_styles(); |
| 97 | $layout = $this->theme_controller->get_layout_settings(); |
| 98 | // Pass the CSS variables map so preprocessors can resolve preset |
| 99 | // references (e.g. var:preset|spacing|20) in block attributes. |
| 100 | $styles['__variables_map'] = $this->theme_controller->get_variables_values_map(); |
| 101 | // Second pass (user blocks inside post-content): if root padding was |
| 102 | // applied to a container above post-content in the first pass (indicated |
| 103 | // by post_content_width < contentSize), remove root padding from styles |
| 104 | // to prevent double application. If the template delegates root padding |
| 105 | // (post_content_width == contentSize), keep it for user blocks. |
| 106 | if ( null !== $this->post_content_width ) { |
| 107 | $post_content_num = (float) str_replace( 'px', '', $this->post_content_width ); |
| 108 | $content_size_num = (float) str_replace( 'px', '', $layout['contentSize'] ); |
| 109 | // Use epsilon tolerance for floating-point comparison since width |
| 110 | // calculations involve round() and division that may produce imprecision. |
| 111 | if ( $post_content_num < $content_size_num - 0.01 ) { |
| 112 | unset( $styles['spacing']['padding']['left'], $styles['spacing']['padding']['right'] ); |
| 113 | } |
| 114 | // Pass container padding from the first pass so the |
| 115 | // Spacing_Preprocessor can distribute it to user blocks. |
| 116 | if ( ! empty( $this->container_padding ) ) { |
| 117 | $styles['__container_padding'] = $this->container_padding; |
| 118 | } |
| 119 | } |
| 120 | $result = $this->process_manager->preprocess( $parsed_blocks, $layout, $styles, $this->get_rendering_context() ); |
| 121 | // After the first pass: find the post-content block's width and container padding. |
| 122 | if ( null === $this->post_content_width ) { |
| 123 | $this->post_content_width = $this->find_post_content_width( $result ); |
| 124 | $this->container_padding = $this->find_container_padding( $result ); |
| 125 | } |
| 126 | return $result; |
| 127 | } |
| 128 | private function find_post_content_width( array $blocks, ?array $post_content_block_names = null ): ?string { |
| 129 | if ( null === $post_content_block_names ) { |
| 130 | $post_content_block_names = (array) apply_filters( |
| 131 | 'woocommerce_email_editor_post_content_block_names', |
| 132 | array( 'core/post-content' ) |
| 133 | ); |
| 134 | } |
| 135 | foreach ( $blocks as $block ) { |
| 136 | $block_name = $block['blockName'] ?? ''; |
| 137 | if ( in_array( $block_name, $post_content_block_names, true ) ) { |
| 138 | return $block['email_attrs']['width'] ?? null; |
| 139 | } |
| 140 | if ( ! empty( $block['innerBlocks'] ) ) { |
| 141 | $found = $this->find_post_content_width( $block['innerBlocks'], $post_content_block_names ); |
| 142 | if ( null !== $found ) { |
| 143 | return $found; |
| 144 | } |
| 145 | } |
| 146 | } |
| 147 | return null; |
| 148 | } |
| 149 | private function find_container_padding( array $blocks ): array { |
| 150 | $variables_map = $this->theme_controller->get_variables_values_map(); |
| 151 | foreach ( $blocks as $block ) { |
| 152 | $email_attrs = $block['email_attrs'] ?? array(); |
| 153 | if ( ! empty( $email_attrs['suppress-horizontal-padding'] ) ) { |
| 154 | $padding = $block['attrs']['style']['spacing']['padding'] ?? array(); |
| 155 | $result = array(); |
| 156 | if ( isset( $padding['left'] ) && is_string( $padding['left'] ) ) { |
| 157 | $result['left'] = Preset_Variable_Resolver::resolve( $padding['left'], $variables_map ); |
| 158 | } |
| 159 | if ( isset( $padding['right'] ) && is_string( $padding['right'] ) ) { |
| 160 | $result['right'] = Preset_Variable_Resolver::resolve( $padding['right'], $variables_map ); |
| 161 | } |
| 162 | if ( ! empty( $result ) ) { |
| 163 | return $result; |
| 164 | } |
| 165 | } |
| 166 | if ( ! empty( $block['innerBlocks'] ) ) { |
| 167 | $found = $this->find_container_padding( $block['innerBlocks'] ); |
| 168 | if ( ! empty( $found ) ) { |
| 169 | return $found; |
| 170 | } |
| 171 | } |
| 172 | } |
| 173 | return array(); |
| 174 | } |
| 175 | public function render_block( string $block_content, array $parsed_block ): string { |
| 176 | $context = $this->get_rendering_context(); |
| 177 | $block_type = $this->block_type_registry->get_registered( $parsed_block['blockName'] ); |
| 178 | $result = null; |
| 179 | try { |
| 180 | if ( $block_type && isset( $block_type->render_email_callback ) && is_callable( $block_type->render_email_callback ) ) { |
| 181 | $result = call_user_func( $block_type->render_email_callback, $block_content, $parsed_block, $context ); |
| 182 | } |
| 183 | } catch ( \Exception $error ) { |
| 184 | $this->logger->error( |
| 185 | 'Error thrown while rendering block.', |
| 186 | array( |
| 187 | 'exception' => $error, |
| 188 | 'block_name' => $parsed_block['blockName'], |
| 189 | 'parsed_block' => $parsed_block, |
| 190 | 'message' => $error->getMessage(), |
| 191 | ) |
| 192 | ); |
| 193 | // Returning the original content. |
| 194 | return $block_content; |
| 195 | } |
| 196 | if ( null === $result ) { |
| 197 | $result = $this->fallback_renderer->render( $block_content, $parsed_block, $context ); |
| 198 | } |
| 199 | return $this->add_root_horizontal_padding( $result, $parsed_block['email_attrs'] ?? array() ); |
| 200 | } |
| 201 | private function add_root_horizontal_padding( string $content, array $email_attrs ): string { |
| 202 | $padding_left = $this->sum_padding_values( |
| 203 | $email_attrs['root-padding-left'] ?? null, |
| 204 | $email_attrs['container-padding-left'] ?? null |
| 205 | ); |
| 206 | $padding_right = $this->sum_padding_values( |
| 207 | $email_attrs['root-padding-right'] ?? null, |
| 208 | $email_attrs['container-padding-right'] ?? null |
| 209 | ); |
| 210 | $css_attrs = array(); |
| 211 | if ( $padding_left > 0 ) { |
| 212 | $css_attrs['padding-left'] = $padding_left . 'px'; |
| 213 | } |
| 214 | if ( $padding_right > 0 ) { |
| 215 | $css_attrs['padding-right'] = $padding_right . 'px'; |
| 216 | } |
| 217 | if ( empty( $css_attrs ) ) { |
| 218 | return $content; |
| 219 | } |
| 220 | $padding_style = WP_Style_Engine::compile_css( $css_attrs, '' ); |
| 221 | if ( empty( $padding_style ) ) { |
| 222 | return $content; |
| 223 | } |
| 224 | $table_attrs = array( |
| 225 | 'align' => $this->get_rendering_context()->get_default_text_align(), |
| 226 | 'width' => '100%', |
| 227 | ); |
| 228 | $cell_attrs = array( |
| 229 | 'style' => $padding_style, |
| 230 | ); |
| 231 | $div_content = sprintf( |
| 232 | '<div class="email-root-padding" style="%1$s">%2$s</div>', |
| 233 | esc_attr( $padding_style ), |
| 234 | $content |
| 235 | ); |
| 236 | return Table_Wrapper_Helper::render_outlook_table_wrapper( $div_content, $table_attrs, $cell_attrs ); |
| 237 | } |
| 238 | private function sum_padding_values( ?string $value1, ?string $value2 ): float { |
| 239 | $sum = 0.0; |
| 240 | if ( null !== $value1 ) { |
| 241 | $sum += (float) str_replace( 'px', '', $value1 ); |
| 242 | } |
| 243 | if ( null !== $value2 ) { |
| 244 | $sum += (float) str_replace( 'px', '', $value2 ); |
| 245 | } |
| 246 | return $sum; |
| 247 | } |
| 248 | private function set_template_globals( WP_Post $email_post, WP_Block_Template $template ) { |
| 249 | global $_wp_current_template_content, $_wp_current_template_id, $wp_query, $post; |
| 250 | // Backup current values of globals. |
| 251 | // Because overriding the globals can affect rendering of the page itself, we need to backup the current values. |
| 252 | $this->backup_template_content = $_wp_current_template_content; |
| 253 | $this->backup_template_id = $_wp_current_template_id; |
| 254 | $this->backup_query = $wp_query; |
| 255 | $this->backup_post = $post; |
| 256 | $_wp_current_template_id = $template->id; |
| 257 | $_wp_current_template_content = $template->content; |
| 258 | $wp_query = new \WP_Query( array( 'p' => $email_post->ID ) ); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited -- We need to set the query for correct rendering the blocks. |
| 259 | $post = $email_post; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited -- We need to set the post for correct rendering the blocks. |
| 260 | } |
| 261 | private function reset(): void { |
| 262 | remove_filter( 'render_block', array( $this, 'render_block' ) ); |
| 263 | remove_filter( 'block_parser_class', array( $this, 'block_parser' ) ); |
| 264 | remove_filter( 'woocommerce_email_blocks_renderer_parsed_blocks', array( $this, 'preprocess_parsed_blocks' ) ); |
| 265 | $this->post_content_width = null; |
| 266 | $this->container_padding = array(); |
| 267 | $this->rendering_context = null; |
| 268 | // Restore the original core/post-content render callback. |
| 269 | // Note: We always restore it, even if it was null originally. |
| 270 | $post_content_type = $this->block_type_registry->get_registered( 'core/post-content' ); |
| 271 | if ( $post_content_type ) { |
| 272 | // @phpstan-ignore-next-line -- WordPress core allows null for render_callback despite type definition. |
| 273 | $post_content_type->render_callback = $this->backup_post_content_callback; |
| 274 | } |
| 275 | // Restore globals to their original values. |
| 276 | global $_wp_current_template_content, $_wp_current_template_id, $wp_query, $post; |
| 277 | $_wp_current_template_content = $this->backup_template_content; |
| 278 | $_wp_current_template_id = $this->backup_template_id; |
| 279 | $wp_query = $this->backup_query; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited -- Restoring of the query. |
| 280 | $post = $this->backup_post; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited -- Restoring of the post. |
| 281 | } |
| 282 | private function get_rendering_context(): Rendering_Context { |
| 283 | if ( null === $this->rendering_context ) { |
| 284 | $this->rendering_context = $this->create_rendering_context(); |
| 285 | } |
| 286 | return $this->rendering_context; |
| 287 | } |
| 288 | public function create_rendering_context( ?string $language = null, ?WP_Post $post = null, ?WP_Block_Template $template = null ): Rendering_Context { |
| 289 | $email_context = apply_filters( 'woocommerce_email_editor_rendering_email_context', array(), $post, $template ); |
| 290 | if ( ! is_array( $email_context ) ) { |
| 291 | $email_context = array(); |
| 292 | } |
| 293 | return new Rendering_Context( $this->theme_controller->get_theme(), $email_context, $language ); |
| 294 | } |
| 295 | private function collect_styles( WP_Post $post, $template = null ): string { |
| 296 | $styles = (string) file_get_contents( __DIR__ . '/' . self::CONTENT_STYLES_FILE ); |
| 297 | $styles .= (string) file_get_contents( __DIR__ . '/../../content-shared.css' ); |
| 298 | // Apply default contentWidth to constrained blocks. |
| 299 | $layout = $this->theme_controller->get_layout_settings(); |
| 300 | $styles .= sprintf( |
| 301 | ' |
| 302 | .is-layout-constrained > *:not(.alignleft):not(.alignright):not(.alignfull) { |
| 303 | max-width: %1$s; |
| 304 | margin-left: auto !important; |
| 305 | margin-right: auto !important; |
| 306 | } |
| 307 | .is-layout-constrained > .alignwide { |
| 308 | max-width: %2$s; |
| 309 | margin-left: auto !important; |
| 310 | margin-right: auto !important; |
| 311 | } |
| 312 | ', |
| 313 | $layout['contentSize'], |
| 314 | $layout['wideSize'] ?? $layout['contentSize'] |
| 315 | ); |
| 316 | // Get styles from theme. |
| 317 | $styles .= $this->theme_controller->get_stylesheet_for_rendering( $post, $template ); |
| 318 | $block_support_styles = $this->theme_controller->get_stylesheet_from_context( 'block-supports', array() ); |
| 319 | // Get styles from block-supports stylesheet. This includes rules such as layout (contentWidth) that some blocks use. |
| 320 | // @see https://github.com/WordPress/WordPress/blob/3c5da9c74344aaf5bf8097f2e2c6a1a781600e03/wp-includes/script-loader.php#L3134 |
| 321 | // @internal :where is not supported by emogrifier, so we need to replace it with *. |
| 322 | $block_support_styles = str_replace( |
| 323 | ':where(:not(.alignleft):not(.alignright):not(.alignfull))', |
| 324 | '*:not(.alignleft):not(.alignright):not(.alignfull)', |
| 325 | $block_support_styles |
| 326 | ); |
| 327 | $block_support_styles = preg_replace( |
| 328 | '/group-is-layout-(\d+) >/', |
| 329 | 'group-is-layout-$1 > tbody tr td >', |
| 330 | $block_support_styles |
| 331 | ); |
| 332 | $styles .= $block_support_styles; |
| 333 | return wp_strip_all_tags( (string) apply_filters( 'woocommerce_email_content_renderer_styles', $styles, $post ) ); |
| 334 | } |
| 335 | } |
| 336 |