Closes #5848: Elementor templates clearing cache in full

inc/Engine/Optimization/RUCSS/Admin/Subscriber.php

@@ -218,13 +218,7 @@ public function truncate_used_css() {
 	 * @return void
 	 */
 	private function delete_used_css_rows() {
-		$this->used_css->delete_all_used_css();
-
-		if ( 0 < $this->used_css->get_not_completed_count() ) {
-			$this->database->remove_all_completed_rows();
-		} else {
-			$this->database->truncate_used_css_table();
-		}
+		$this->used_css->delete_used_css_rows();
 
 		/**
 		 * Fires after the used CSS has been cleaned in the database

inc/Engine/Optimization/RUCSS/Controller/UsedCSS.php

@@ -8,6 +8,7 @@
 use WP_Rocket\Engine\Optimization\CSSTrait;
 use WP_Rocket\Engine\Optimization\DynamicLists\DefaultLists\DataManager;
 use WP_Rocket\Engine\Optimization\RegexTrait;
+use WP_Rocket\Engine\Optimization\RUCSS\Admin\Database;
 use WP_Rocket\Engine\Optimization\RUCSS\Database\Queries\UsedCSS as UsedCSS_Query;
 use WP_Rocket\Engine\Optimization\RUCSS\Frontend\APIClient;
 use WP_Rocket\Logger\Logger;
@@ -59,6 +60,14 @@ class UsedCSS {
 	 */
 	private $filesystem;
 
+	/**
+	 * Database instance
+	 *
+	 * @var Database
+	 */
+	private $database;
+
+
 	/**
 	 * External exclusions list, can be urls or attributes.
 	 *
@@ -89,21 +98,24 @@ class UsedCSS {
 	 * @param QueueInterface $queue Queue instance.
 	 * @param DataManager    $data_manager DataManager instance.
 	 * @param Filesystem     $filesystem Filesystem instance.
+	 * @param Database       $database Database instance.
 	 */
 	public function __construct(
 		Options_Data $options,
 		UsedCSS_Query $used_css_query,
 		APIClient $api,
 		QueueInterface $queue,
 		DataManager $data_manager,
-		Filesystem $filesystem
+		Filesystem $filesystem,
+		Database $database
 	) {
 		$this->options        = $options;
 		$this->used_css_query = $used_css_query;
 		$this->api            = $api;
 		$this->queue          = $queue;
 		$this->data_manager   = $data_manager;
 		$this->filesystem     = $filesystem;
+		$this->database       = $database;
 	}
 
 	/**
@@ -1100,4 +1112,20 @@ static function ( $item ) {
 	public function has_one_completed_row_at_least() {
 		return $this->used_css_query->get_completed_count() > 0;
 	}
+
+	/**
+	 * Delete RUCSS rows.
+	 *
+	 * @return void
+	 */
+	public function delete_used_css_rows() {
+		$this->delete_all_used_css();
+
+		if ( 0 < $this->get_not_completed_count() ) {
+			$this->database->remove_all_completed_rows();
+			return;
+		}
+
+		$this->database->truncate_used_css_table();
+	}
 }

inc/Engine/Optimization/RUCSS/ServiceProvider.php

@@ -37,6 +37,7 @@ class ServiceProvider extends AbstractServiceProvider {
 		'rucss_frontend_api_client',
 		'rucss_used_css',
 		'rucss_used_css_query',
+		'rucss_used_css_controller',
 		'rucss_frontend_subscriber',
 		'rucss_queue',
 		'rucss_filesystem',
@@ -73,7 +74,8 @@ public function register() {
 			->addArgument( $this->getContainer()->get( 'rucss_frontend_api_client' ) )
 			->addArgument( $this->getContainer()->get( 'rucss_queue' ) )
 			->addArgument( $this->getContainer()->get( 'dynamic_lists_defaultlists_data_manager' ) )
-			->addArgument( $this->getContainer()->get( 'rucss_filesystem' ) );
+			->addArgument( $this->getContainer()->get( 'rucss_filesystem' ) )
+			->addArgument( $this->getContainer()->get( 'rucss_database' ) );
 
 		$this->getContainer()->share( 'rucss_option_subscriber', OptionSubscriber::class )
 			->addArgument( $this->getContainer()->get( 'rucss_settings' ) );

inc/ThirdParty/Plugins/PageBuilder/Elementor.php

@@ -4,13 +4,16 @@
 namespace WP_Rocket\ThirdParty\Plugins\PageBuilder;
 
 use WP_Rocket\Admin\Options_Data;
+use WP_Rocket\Engine\Common\Ajax\AjaxHandler;
 use WP_Rocket\Event_Management\Subscriber_Interface;
 use WP_Rocket\Engine\Optimization\DelayJS\HTML;
+use WP_Rocket\Engine\Optimization\RUCSS\Controller\UsedCSS;
 
 /**
  * Compatibility file for Elementor plugin
  */
 class Elementor implements Subscriber_Interface {
+
 	/**
 	 * WP Rocket options.
 	 *
@@ -32,17 +35,35 @@
 	 */
 	private $delayjs_html;
 
+	/**
+	 * UsedCSS instance
+	 *
+	 * @var UsedCSS
+	 */
+	private $used_css;
+
+	/**
+	 * Handle basic Ajax operations.
+	 *
+	 * @var AjaxHandler
+	 */
+	protected $ajax_handler;
+
 	/**
 	 * Constructor
 	 *
 	 * @param Options_Data          $options WP Rocket options.
 	 * @param \WP_Filesystem_Direct $filesystem The Filesystem object.
 	 * @param HTML                  $delayjs_html DelayJS HTML class.
+	 * @param UsedCSS               $used_css UsedCSS class.
+	 * @param AjaxHandler           $ajax_handler Handle basic Ajax operations.
 	 */
-	public function __construct( Options_Data $options, $filesystem, HTML $delayjs_html ) {
+	public function __construct( Options_Data $options, $filesystem, HTML $delayjs_html, UsedCSS $used_css, AjaxHandler $ajax_handler ) {
 		$this->options      = $options;
 		$this->filesystem   = $filesystem;
 		$this->delayjs_html = $delayjs_html;
+		$this->used_css     = $used_css;
+		$this->ajax_handler = $ajax_handler;
 	}
 
 	/**
@@ -69,6 +90,12 @@
 			'rocket_skip_admin_bar_cache_purge_option'    => [ 'skip_admin_bar_option', 1, 2 ],
 			'rocket_submitbox_options_post_types'         => 'remove_rocket_option',
 			'rocket_skip_admin_bar_clear_used_css_option' => [ 'skip_admin_bar_option', 1, 2 ],
+			'rocket_pre_clean_post'                       => [ 'exclude_post_type_cache_clearing', 10, 2 ],
+			'elementor/editor/after_save'                 => 'clear_related_post_cache',
+			'admin_notices'                               => 'maybe_clear_cache_change_notice',
+			'update_post_metadata'                        => [ 'setup_transient', 10, 5 ],
+			'rocket_notice_args'                          => 'add_clear_action',
+			'admin_post_rocket_elementor_clear_usedcss'   => 'clear_action',
 		];
 	}
 
@@ -205,4 +232,182 @@
 
 		return $should_skip;
 	}
+
+	/**
+	 * Exclude elementor library post type from cache clearing.
+	 *
+	 * @param mixed $clear_post A preemptive return value. Default null.
+	 * @param Post  $post Post Object.
+	 * @return boolean
+	 */
+	public function exclude_post_type_cache_clearing( $clear_post, $post ) {
+		if ( 'elementor_library' === $post->post_type ) {
+			return true;
+		}
+
+		return $clear_post;
+	}
+
+	/**
+	 * Clear cache of related posts.
+	 *
+	 * @param integer $post_id Post ID.
+	 * @return void
+	 */
+	public function clear_related_post_cache( int $post_id ) {
+		global $wpdb;
+
+		$template_id = '%' . $wpdb->esc_like( $post_id ) . '%';
+
+		// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared, WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
+		$results = $wpdb->get_results(
+			$wpdb->prepare(
+				"SELECT post_id FROM `$wpdb->postmeta` WHERE `meta_key` = %s AND `meta_value` LIKE %s",
+				[ '_elementor_data', $template_id ]
+			)
+		);
+
+		if ( ! $results ) {
+			return;
+		}
+
+		foreach ( $results as $result ) {
+			if ( 'publish' !== get_post_status( $result->post_id ) ) {
+				continue;
+			}
+
+			rocket_clean_post( $result->post_id );
+
+			if ( ! $this->options->get( 'remove_unused_css', 0 ) ) {
+				continue;
+			}
+
+			$url = get_permalink( $result->post_id );
+			$this->used_css->delete_used_css( $url );
+		}
+	}
+
+	/**
+	 * Display a notice when clear is needed.
+	 *
+	 * @return void
+	 */
+	public function maybe_clear_cache_change_notice() {
+
+		$boxes = get_user_meta( get_current_user_id(), 'rocket_boxes', true );
+
+		if ( in_array( __FUNCTION__, (array) $boxes, true ) ) {
+			return;
+		}
+
+		if ( ! current_user_can( 'rocket_manage_options' ) ) {
+			return;
+		}
+
+		$notice = get_transient( 'wpr_elementor_need_purge' );
+		if ( ! $notice ) {
+			return;
+		}
+
+		$message = $this->options->get( 'remove_unused_css', false ) ?
+			// translators: %1$s = <strong>, %2$s = </strong>, %3$s = <a>, %4$s = </a>.
+			__( '%1$sWP Rocket:%2$s Your Elementor template was updated. Clear the Used CSS if the layout, design or CSS styles were changed.', 'rocket' )
+			:
+			// translators: %1$s = <strong>, %2$s = </strong>, %3$s = <a>, %4$s = </a>.
+			__( '%1$sWP Rocket:%2$s Your Elementor template was updated. Clear the cache if the display conditions were changed.', 'rocket' );
+
+		$args = [
+			'status'         => 'warning',
+			'dismissible'    => '',
+			'dismiss_button' => __FUNCTION__,
+			'message'        => sprintf(
+				$message,
+				'<strong>',
+				'</strong>',
+				'</a>'
+			),
+			'action'         => 'elementor_clear_usedcss',
+		];
+
+		rocket_notice_html( $args );
+	}
+
+	/**
+	 * Set up the transient when needed.
+	 *
+	 * @param bool   $check Check the filed.
+	 * @param int    $object_id Id from the object.
+	 * @param string $meta_key Key from the meta.
+	 * @param string $meta_value Current value from the meta.
+	 * @param string $prev_value Previous value from the meta.
+	 * @return void
+	 */
+	public function setup_transient( $check, $object_id, $meta_key, $meta_value, $prev_value ) {
+		if ( '_elementor_conditions' !== $meta_key || $meta_value === $prev_value ) {
+			return;
+		}
+		set_transient( 'wpr_elementor_need_purge', true );
+
+		$boxes = get_user_meta( get_current_user_id(), 'rocket_boxes', true );
+		$boxes = array_filter(
+			$boxes,
+			function ( $box ) {
+				return 'maybe_clear_cache_change_notice' !== $box;
+			}
+			);
+		update_user_meta( get_current_user_id(), 'rocket_boxes', $boxes );
+	}
+
+	/**
+	 * Add an action to clear the RUCSS.
+	 *
+	 * @param array $args Arguments to pass to the view.
+	 * @return array
+	 */
+	public function add_clear_action( $args ) {
+
+		if ( ! key_exists( 'action', $args ) || 'elementor_clear_usedcss' !== $args['action'] ) {
+			return $args;
+		}
+
+		$params = [
+			'action' => 'rocket_elementor_clear_usedcss',
+		];
+
+		if ( ! empty( $_SERVER['REQUEST_URI'] ) ) {
+			$referer_url                = filter_var( wp_unslash( $_SERVER['REQUEST_URI'] ), FILTER_SANITIZE_URL );
+			$params['_wp_http_referer'] = rawurlencode( $referer_url );
+		}
+
+		$message = $this->options->get( 'remove_unused_css', false ) ? __( 'Clear Used CSS', 'rocket' ) : __( 'Clear cache', 'rocket' );
+
+		$args['action'] = '<a class="wp-core-ui button" href="' . add_query_arg( $params, wp_nonce_url( admin_url( 'admin-post.php' ), $params['action'] ) ) . '">' . $message . '</a>';
+
+		return $args;
+	}
+
+	/**
+	 * Clear the cache and RUCSS.
+	 *
+	 * @return void
+	 */
+	public function clear_action() {
+
+		if ( ! $this->ajax_handler->validate_referer( 'rocket_elementor_clear_usedcss', 'rocket_remove_unused_css' ) ) {
+			wp_nonce_ays( '' );
+			return;
+		}
+
+		if ( $this->options->get( 'remove_unused_css', false ) ) {
+			$this->used_css->delete_used_css_rows();
+		}
+
+		rocket_clean_domain();
+
+		$boxes   = get_user_meta( get_current_user_id(), 'rocket_boxes', true );
+		$boxes[] = 'maybe_clear_cache_change_notice';
+		update_user_meta( get_current_user_id(), 'rocket_boxes', $boxes );
+
+		$this->ajax_handler->redirect();
+	}
 }

inc/ThirdParty/ServiceProvider.php

@@ -2,6 +2,7 @@
 namespace WP_Rocket\ThirdParty;
 
 use WP_Rocket\Dependencies\League\Container\ServiceProvider\AbstractServiceProvider;
+use WP_Rocket\Engine\Common\Ajax\AjaxHandler;
 use WP_Rocket\Subscriber\Third_Party\Plugins\Images\Webp\EWWW_Subscriber;
 use WP_Rocket\Subscriber\Third_Party\Plugins\Images\Webp\Imagify_Subscriber;
 use WP_Rocket\Subscriber\Third_Party\Plugins\Images\Webp\Optimus_Subscriber;
@@ -113,6 +114,8 @@ class ServiceProvider extends AbstractServiceProvider {
 	public function register() {
 		$options = $this->getContainer()->get( 'options' );
 
+		$this->getContainer()->add( 'ajax_handler', AjaxHandler::class );
+
 		$this->getContainer()
 			->share( 'mobile_subscriber', Mobile_Subscriber::class )
 			->addTag( 'common_subscriber' );
@@ -121,6 +124,8 @@ public function register() {
 			->addArgument( $options )
 			->addArgument( rocket_direct_filesystem() )
 			->addArgument( $this->getContainer()->get( 'delay_js_html' ) )
+			->addArgument( $this->getContainer()->get( 'rucss_used_css_controller' ) )
+			->addArgument( $this->getContainer()->get( 'ajax_handler' ) )
 			->addTag( 'common_subscriber' );
 		$this->getContainer()
 			->share( 'woocommerce_subscriber', WooCommerceSubscriber::class )

inc/common/purge.php

@@ -196,6 +196,18 @@ function rocket_clean_post( $post_id, $post = null ) {
 		return false;
 	}
 
+	/**
+	 * Filters the preemptive return value of clean post
+	 *
+	 * @param mixed $clear_post $clear_post A preemptive return value. Default null.
+	 * @param  $post Post Object.
+	 */
+	$pre = apply_filters( 'rocket_pre_clean_post', null, $post );
+
+	if ( null !== $pre ) {
+		return $pre;
+	}
+
 	// No purge for specific conditions.
 	if ( 'auto-draft' === $post->post_status || 'draft' === $post->post_status || empty( $post->post_type ) || 'nav_menu_item' === $post->post_type || 'attachment' === $post->post_type ) {
 		return false;