Divi compatibility: show admin notice to clear the used CSS when a template is updated

inc/ThirdParty/Themes/Divi.php

@@ -70,6 +70,10 @@ public static function get_subscribed_events() {
 
 		$events['wp']                = 'disable_dynamic_css_on_rucss';
 		$events['after_setup_theme'] = 'remove_assets_generated';
+		$events['et_save_post']      = 'handle_save_template';
+		$events['admin_notices']     = 'handle_divi_admin_notice';
+
+		$events['rocket_after_clean_used_css'] = 'clear_divi_notice';
 
 		return $events;
 	}
@@ -214,4 +218,130 @@ public function disable_dynamic_css_on_rucss() {
 	public function remove_assets_generated() {
 		remove_all_actions( 'et_dynamic_late_assets_generated' );
 	}
+
+	/**
+	 * Get layout IDs for a template.
+	 *
+	 * @param int $template_post_id Template post ID.
+	 *
+	 * @return array
+	 */
+	private function get_layout_ids( $template_post_id ) {
+		$allowed_post_types = [
+			'et_header_layout',
+			'et_footer_layout',
+			'et_body_layout',
+		];
+		$current_post_type  = get_post_type( $template_post_id );
+
+		if ( ! in_array( $current_post_type, $allowed_post_types, true ) ) {
+			return [];
+		}
+
+		global $wpdb;
+
+		// phpcs:ignore WordPress.DB.DirectDatabaseQuery
+		return (array) $wpdb->get_col(
+			$wpdb->prepare(
+				'SELECT post_id from ' . $wpdb->postmeta . ' WHERE meta_key = %s AND meta_value = %d',
+				'_' . $current_post_type . '_id',
+				$template_post_id
+			)
+		);
+	}
+
+	/**
+	 * Is allowed for RUCSS notice functionality when saving templates.
+	 *
+	 * @return bool
+	 */
+	private function is_allowed_for_rucss() {
+		return $this->options->get( 'remove_unused_css', 0 )
+			&&
+			current_user_can( 'rocket_manage_options' );
+	}
+
+	/**
+	 * Save template handler.
+	 *
+	 * @param int $template_post_id Template post ID.
+	 *
+	 * @return void
+	 */
+	public function handle_save_template( $template_post_id ) {
+		if ( ! $this->is_allowed_for_rucss() ) {
+			return;
+		}
+
+		/**
+		 * Filters Bypassing saving template functionality.
+		 *
+		 * @param bool $bypass Bypass save template functionality.
+		 * @param int  $template_post_id Currently saved template post id.
+		 */
+		if ( apply_filters( 'rocket_divi_bypass_save_template', false, $template_post_id ) ) {
+			return;
+		}
+
+		// If the transient is there, we don't need to do the check again as the admin notice will be there already.
+		if ( false !== get_transient( 'rocket_divi_notice' ) ) {
+			return;
+		}
+
+		$layout_post_ids = $this->get_layout_ids( $template_post_id );
+
+		if ( empty( $layout_post_ids ) ) {
+			return;
+		}
+
+		foreach ( $layout_post_ids as $layout_post_id ) {
+			if ( 'publish' !== get_post_status( $layout_post_id ) ) {
+				continue;
+			}
+
+			$used_on = get_post_meta( $layout_post_id, '_et_use_on' );
+			if ( empty( $used_on ) ) {
+				continue;
+			}
+
+			set_transient( 'rocket_divi_notice', true );
+			return;
+		}
+	}
+
+	/**
+	 * Admin notices handler.
+	 *
+	 * @return void
+	 */
+	public function handle_divi_admin_notice() {
+		if ( ! $this->is_allowed_for_rucss() ) {
+			return;
+		}
+
+		$notice = get_transient( 'rocket_divi_notice' );
+
+		if ( ! $notice ) {
+			return;
+		}
+
+		rocket_notice_html(
+			[
+				'status'         => 'info',
+				'dismiss_button' => 'rocket_divi_notice',
+				'message'        =>
+					sprintf( '%1$sWP Rocket:%2$s ', '<strong>', '</strong>' ) . // Splitting it because I think the plugin name is not a translatable string.
+					esc_html__( 'Your Divi template was updated. Clear the Used CSS if the layout, design or CSS styles were changed.', 'rocket' ),
+			]
+		);
+	}
+
+	/**
+	 * Clear divi notice.
+	 *
+	 * @return void
+	 */
+	public function clear_divi_notice() {
+		delete_transient( 'rocket_divi_notice' );
+	}
 }

tests/Fixtures/inc/ThirdParty/Themes/Divi/handleDiviAdminNotice.php

@@ -0,0 +1,68 @@
+<?php
+
+return [
+	'vfs_dir' => 'wp-content/themes/',
+
+	'test_data' => [
+		'bailoutWhenRUCSSDisabled' => [
+			'config'   => [
+				'rucss_option' => false,
+			],
+			'expected' => [
+				'notice_show' => false,
+			],
+		],
+
+		'bailoutWhenUserDoesnotHaveCapability' => [
+			'config'   => [
+				'rucss_option' => true,
+				'capability'   => false,
+			],
+			'expected' => [
+				'notice_show' => false,
+			],
+		],
+
+		'bailoutWhenTransientIsNotThere' => [
+			'config'   => [
+				'rucss_option'     => true,
+				'capability'       => true,
+				'transient_return' => false,
+			],
+			'expected' => [
+				'notice_show' => false,
+			],
+		],
+
+		'success' => [
+			'config'   => [
+				'rucss_option'     => true,
+				'capability'       => true,
+				'transient_return' => true,
+			],
+			'expected' => [
+				'notice_show' => true,
+				'notice_details' => [
+					'status'         => 'info',
+					'dismiss_button' => 'rocket_divi_notice',
+					'message'        =>
+						'<strong>WP Rocket:</strong> Your Divi template was updated. Clear the Used CSS if the layout, design or CSS styles were changed.'
+				],
+				'notice_html' => <<<HTML
+<div class="notice notice-info is-dismissible">
+	<p>
+		<strong>WP Rocket:</strong>
+		Your Divi template was updated. Clear the Used CSS if the layout, design or CSS styles were changed.
+	</p>
+	<p>
+		<a class="rocket-dismiss " href="http://example.org/wp-admin/admin-post.php?action=rocket_ignore&amp;box=rocket_divi_notice&amp;_wpnonce=12345">
+			Dismiss this notice
+		</a>
+	</p>
+</div>
+HTML
+			],
+		],
+	],
+
+];

tests/Fixtures/inc/ThirdParty/Themes/Divi/handleSaveTemplate.php

@@ -0,0 +1,154 @@
+<?php
+
+return [
+	'vfs_dir' => 'wp-content/themes/',
+
+	'test_data' => [
+		'bailoutWhenRUCSSDisabled' => [
+			'config'   => [
+				'rucss_option' => false,
+				'template_post' => [
+					'post_type' => 'et_header_layout',
+				]
+			],
+			'expected' => [
+				'transient_set' => false,
+			],
+		],
+
+		'bailoutWhenUserDoesnotHaveCapability' => [
+			'config'   => [
+				'rucss_option' => true,
+				'capability'   => false,
+				'template_post' => [
+					'post_type' => 'et_header_layout',
+				]
+			],
+			'expected' => [
+				'transient_set' => false,
+			],
+		],
+
+		'bailoutWhenFilterReturnsTrue' => [
+			'config'   => [
+				'rucss_option'   => true,
+				'capability'     => false,
+				'filter_return'  => true,
+				'template_post' => [
+					'post_type' => 'et_header_layout',
+				]
+			],
+			'expected' => [
+				'transient_set' => false,
+			],
+		],
+
+		'bailoutWhenTransientIsThere' => [
+			'config'   => [
+				'rucss_option'     => true,
+				'capability'       => true,
+				'filter_return'    => false,
+				'transient_return' => true,
+				'template_post' => [
+					'post_type' => 'et_header_layout',
+				]
+			],
+			'expected' => [
+				'transient_set' => true,
+			],
+		],
+
+		'bailoutWhenAnotherPostType' => [
+			'config'   => [
+				'rucss_option'     => true,
+				'capability'       => true,
+				'filter_return'    => false,
+				'transient_return' => false,
+				'template_post' => [
+					'post_type' => 'test',
+				]
+			],
+			'expected' => [
+				'transient_set' => false,
+			],
+		],
+
+		'bailoutWhenPostStatusNotPublish' => [
+			'config'   => [
+				'rucss_option'     => true,
+				'capability'       => true,
+				'filter_return'    => false,
+				'transient_return' => false,
+				'template_post' => [
+					'post_type' => 'et_header_layout',
+					'post_status' => 'trash',
+				]
+			],
+			'expected' => [
+				'transient_set' => false,
+			],
+		],
+
+		'bailoutWhenNoLayoutInDB' => [
+			'config'   => [
+				'rucss_option'     => true,
+				'capability'       => true,
+				'filter_return'    => false,
+				'transient_return' => false,
+				'template_post' => [
+					'post_type' => 'et_header_layout',
+				]
+			],
+			'expected' => [
+				'transient_set' => false,
+			],
+		],
+
+		'bailoutWhenLayoutIsnotUsedByPages' => [
+			'config'   => [
+				'rucss_option'     => true,
+				'capability'       => true,
+				'filter_return'    => false,
+				'transient_return' => false,
+				'template_post' => [
+					'post_type' => 'et_header_layout',
+					'post_status' => 'publish',
+				],
+				'layout_post' => [
+					'post_type' => 'et_template',
+					'post_status' => 'publish',
+				],
+			],
+			'expected' => [
+				'transient_set' => false,
+			],
+		],
+
+		'success' => [
+			'config'   => [
+				'rucss_option'     => true,
+				'capability'       => true,
+				'filter_return'    => false,
+				'transient_return' => false,
+				'template_post' => [
+					'post_type' => 'et_header_layout',
+					'post_status' => 'publish',
+				],
+				'layout_post' => [
+					'post_type' => 'et_template',
+					'post_status' => 'publish',
+					'metas' => [
+						[
+							'meta_key'   => '_et_use_on',
+							'meta_value' => 'anyvalue',
+						],
+					],
+				],
+			],
+			'expected' => [
+				'transient_set' => true,
+			],
+		],
+	],
+
+];

tests/Fixtures/wpdb.php

@@ -3,6 +3,7 @@
 if ( ! class_exists( 'wpdb' ) ) {
 	class wpdb {
 		public $posts         = 'posts';
+		public $postmeta      = 'postmeta';
 		public $term_taxonomy = 'terms';
 		public $posts_results = [];
 		public $terms_results = [];