Closes 5667 detect domain change (#5688)

Co-authored-by: Vasilis Manthos <[email protected]>
Co-authored-by: Rémy Perona <[email protected]>

inc/Engine/Admin/Beacon/Beacon.php

@@ -771,6 +771,16 @@ public function get_suggest( $doc_id ) {
 					'url' => 'https://fr.docs.wp-rocket.me/article/1327-problemes-critical-css-fouc#critical-path-css-de-secours',
 				],
 			],
+			'domain_change'              => [
+				'en' => [
+					'id'  => '577578b1903360258a10d8ba',
+					'url' => 'https://docs.wp-rocket.me/article/705-changing-domains-migrating-sites-with-wp-rocket?utm_source=wp_plugin&utm_medium=wp_rocket',
+				],
+				'fr' => [
+					'id'  => '57868414c697912dee72a98a',
+					'url' => 'https://fr.docs.wp-rocket.me/article/837-changer-de-domaine-migrer-un-site-avec-wp-rocket?utm_source=wp_plugin&utm_medium=wp_rocket',
+				],
+			],
 			'rucss_firewall_ips'         => [
 				'en' => [
 					'id'  => '6076083ff8c0ef2d98df1f97',

inc/Engine/Admin/DomainChange/ServiceProvider.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace WP_Rocket\Engine\Admin\DomainChange;
+
+use WP_Rocket\Dependencies\League\Container\ServiceProvider\AbstractServiceProvider;
+use WP_Rocket\Engine\Common\Ajax\AjaxHandler;
+
+class ServiceProvider extends AbstractServiceProvider {
+
+	/**
+	 * The provides array is a way to let the container
+	 * know that a service is provided by this service
+	 * provider. Every service that is registered via
+	 * this service provider must have an alias added
+	 * to this array or it will be ignored.
+	 *
+	 * @var array
+	 */
+	protected $provides = [
+		'domain_change_subscriber',
+		'ajax_handler',
+	];
+
+	/**
+	 * Registers items with the container
+	 *
+	 * @return void
+	 */
+	public function register() {
+		$this->getContainer()->add( 'ajax_handler', AjaxHandler::class );
+		$this->getContainer()->add( 'domain_change_subscriber', Subscriber::class )
+			->addArgument( $this->getContainer()->get( 'ajax_handler' ) )
+			->addArgument( $this->getContainer()->get( 'beacon' ) );
+	}
+}

inc/Engine/Admin/DomainChange/Subscriber.php

@@ -0,0 +1,225 @@
+<?php
+
+namespace WP_Rocket\Engine\Admin\DomainChange;
+
+use WP_Rocket\Engine\Admin\Beacon\Beacon;
+use WP_Rocket\Engine\Common\Ajax\AjaxHandler;
+use WP_Rocket\Event_Management\Subscriber_Interface;
+
+class Subscriber implements Subscriber_Interface {
+
+	/**
+	 * Handle basic ajax operations.
+	 *
+	 * @var AjaxHandler
+	 */
+	protected $ajax_handler;
+
+	/**
+	 * Beacon instance
+	 *
+	 * @var Beacon
+	 */
+	protected $beacon;
+
+	/**
+	 * Name of the option saving the last base URL.
+	 *
+	 * @string
+	 */
+	const LAST_BASE_URL_OPTION = 'wp_rocket_last_base_url';
+	const LAST_OPTION_HASH     = 'wp_rocket_last_option_hash';
+
+	/**
+	 * Instantiate the class.
+	 *
+	 * @param AjaxHandler $ajax_handler Handle basic ajax operations.
+	 * @param Beacon      $beacon Beacon instance.
+	 */
+	public function __construct( AjaxHandler $ajax_handler, Beacon $beacon ) {
+		$this->ajax_handler = $ajax_handler;
+		$this->beacon       = $beacon;
+	}
+
+	/**
+	 * Return an array of events that this subscriber wants to listen to.
+	 *
+	 * @return string[]
+	 */
+	public static function get_subscribed_events() {
+		return [
+			'admin_init'                                 => 'maybe_launch_domain_changed',
+			'admin_notices'                              => 'maybe_display_domain_change_notice',
+			'rocket_domain_changed'                      => 'maybe_clean_cache_domain_change',
+			'update_option_' . rocket_get_constant( 'WP_ROCKET_SLUG' ) => [ 'save_hash_on_update_options', 10, 2 ],
+			'rocket_notice_args'                         => 'add_regenerate_configuration_action',
+			'admin_post_rocket_regenerate_configuration' => 'regenerate_configuration',
+		];
+	}
+
+	/**
+	 * Maybe launch the domain changed event.
+	 *
+	 * @return void
+	 */
+	public function maybe_launch_domain_changed() {
+		$base_url         = trailingslashit( home_url() );
+		$base_url_encoded = base64_encode( $base_url ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode
+
+		if ( ! get_option( self::LAST_BASE_URL_OPTION ) ) {
+			update_option( self::LAST_BASE_URL_OPTION, $base_url_encoded );
+			return;
+		}
+
+		$last_base_url_encoded = get_option( self::LAST_BASE_URL_OPTION );
+
+		if ( $base_url_encoded === $last_base_url_encoded ) {
+			return;
+		}
+
+		update_option( self::LAST_BASE_URL_OPTION, $base_url_encoded );
+
+		$last_base_url = base64_decode( $last_base_url_encoded ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode
+
+		set_transient( 'rocket_domain_changed', $last_base_url_encoded, 2 * rocket_get_constant( 'WEEK_IN_SECONDS', 604800 ) );
+
+		/**
+		 * Fires when the domain of the website has been changed.
+		 *
+		 * @param string $current_url current URL from the website.
+		 * @param string $old_url old URL from the website.
+		 */
+		do_action( 'rocket_detected_domain_changed', $base_url, $last_base_url );
+	}
+
+	/**
+	 * Save the hash when options are saved.
+	 *
+	 * @param array $oldvalue old options.
+	 * @param array $value new options.
+	 * @return array|void
+	 */
+	public function save_hash_on_update_options( $oldvalue, $value ) {
+		if ( ! is_array( $value ) ) {
+			return;
+		}
+
+		$hash = rocket_create_options_hash( $value );
+
+		update_option( self::LAST_OPTION_HASH, $hash );
+	}
+
+	/**
+	 * Maybe clean cache on domain change.
+	 *
+	 * @return void
+	 */
+	public function maybe_clean_cache_domain_change() {
+
+		$options = get_option( rocket_get_constant( 'WP_ROCKET_SLUG' ) );
+
+		if ( ! $options ) {
+			return;
+		}
+
+		/**
+		 * Fires after WP Rocket options that require a cache purge have changed
+		 *
+		 * @param array $value An array of submitted values for the settings.
+		 */
+		do_action( 'rocket_options_changed', $options );
+	}
+
+	/**
+	 * Maybe display a notice when domain change.
+	 *
+	 * @return void
+	 */
+	public function maybe_display_domain_change_notice() {
+
+		if ( ! current_user_can( 'rocket_manage_options' ) ) {
+			return;
+		}
+
+		$notice = get_transient( 'rocket_domain_changed' );
+
+		if ( ! $notice || is_multisite() ) {
+			return;
+		}
+
+		$beacon = $this->beacon->get_suggest( 'domain_change' );
+
+		$args = [
+			'status'         => 'warning',
+			'dismissible'    => '',
+			'dismiss_button' => false,
+			'message'        => sprintf(
+			// translators: %1$s = <strong>, %2$s = </strong>, %3$s = <a>, %4$s = </a>.
+				__( '%1$sWP Rocket:%2$s We detected that the website domain has changed. The configuration files must be regenerated for the page cache and all other optimizations to work as intended. %3$sLearn More%4$s', 'rocket' ),
+				'<strong>',
+				'</strong>',
+				'<a href="' . esc_url( $beacon['url'] ) . '" data-beacon-article="' . esc_attr( $beacon['id'] ) . '" target="_blank" rel="noopener noreferrer">',
+				'</a>'
+			),
+			'action'         => 'regenerate_configuration',
+		];
+
+		rocket_notice_html( $args );
+	}
+
+	/**
+	 * Add mapping on notice.
+	 *
+	 * @param array $args Arguments from the notice.
+	 *
+	 * @return array
+	 */
+	public function add_regenerate_configuration_action( $args ) {
+		if ( ! key_exists( 'action', $args ) || 'regenerate_configuration' !== $args['action'] ) {
+			return $args;
+		}
+
+		$params = [
+			'action' => 'rocket_regenerate_configuration',
+		];
+
+		$args['action'] = '<a class="wp-core-ui button" href="' . add_query_arg( $params, wp_nonce_url( admin_url( 'admin-post.php' ), 'rocket_regenerate_configuration' ) ) . '">' . __( 'Regenerate WP Rocket configuration files now', 'rocket' ) . '</a>';
+
+		return $args;
+	}
+
+	/**
+	 * Regenerate configurations.
+	 *
+	 * @return void
+	 */
+	public function regenerate_configuration() {
+		if ( ! $this->ajax_handler->validate_referer(
+			'rocket_regenerate_configuration',
+			'rocket_manage_options'
+			) ) {
+			return;
+		}
+
+		$last_base_url_encoded = get_transient( 'rocket_domain_changed' );
+
+		if ( ! $last_base_url_encoded ) {
+			return;
+		}
+
+		$last_base_url = base64_decode( $last_base_url_encoded ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode
+		$base_url      = trailingslashit( home_url() );
+
+		/**
+		 * Fires when the domain of the website has been changed and user clicked on notice.
+		 *
+		 * @param string $current_url current URL from the website.
+		 * @param string $old_url old URL from the website.
+		 */
+		do_action( 'rocket_domain_changed', $base_url, $last_base_url );
+
+		delete_transient( 'rocket_domain_changed' );
+
+		$this->ajax_handler->redirect();
+	}
+}