From 17ee7adff412736af5bbd89f6cb3b8344a172cb6 Mon Sep 17 00:00:00 2001
From: donnchawp <donnchawp@users.noreply.github.com>
Date: Thu, 20 Jun 2024 08:24:43 +0000
Subject: [PATCH] Super Cache: add an admin notice to encourage migration to
 Jetpack Boost (#37933)

* Add an admin notice to encourage migration to Jetpack Boost

* changelog

* Boost age check only applies if Boost is installed.

* Add boost error and spinner to admin notice

* Rename banner error to migration error.

* Update animations so they work on any migration button

* Place JS in a function to avoid polluting global variables

* Add a MINIMUM_BOOST_VERSION cosntant for that Boost version

* Fixes for static analysis checks

* Updated phan baseline

* Put it in an anon function

* Update the button handling code.

Yes, that's a terrible commit message, but it's a huge overhaul of the
JavaScript, thank you Nauris.

* Remove this class, it's not needed any more

* Dismiss the admin notice if Jetpack Boost is activated by migration

* Move the supercache settings page check into the notice.

Committed via a GitHub action: https://github.com/Automattic/jetpack/actions/runs/9593905304

Upstream-Ref: Automattic/jetpack@191638562fe81f2e94173a1b2836d555a7b569b6
---
 CHANGELOG.md          |   1 +
 inc/boost.php         | 171 ++++++++++++++++++++++++++++++
 js/admin.js           | 240 +++++++++++++++++++++++-------------------
 styling/dashboard.css |  11 ++
 wp-cache.php          |  11 +-
 5 files changed, 321 insertions(+), 113 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 667bc779..55b17437 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 This is an alpha version! The changes listed here are not final.
 
 ### Added
+- Super Cache: add an admin notice to encourage migration to Jetpack Boost
 - Super Cache: modify boost install code so it can be used by multiple buttons
 - Super Cache: notify Boost of migration to that plugin
 
diff --git a/inc/boost.php b/inc/boost.php
index ea3bf37e..ae000a82 100644
--- a/inc/boost.php
+++ b/inc/boost.php
@@ -1,4 +1,14 @@
 <?php
+/**
+ * Code to handle migration from WP Super Cache to Jetpack Boost.
+ *
+ * @package WP_Super_Cache
+ */
+
+// Minimum version of Jetpack Boost required for compatibility.
+if ( ! defined( 'MINIMUM_BOOST_VERSION' ) ) {
+	define( 'MINIMUM_BOOST_VERSION', '3.4.0' );
+}
 
 /**
  * Get shared configuration for each migration button.
@@ -11,6 +21,83 @@ function wpsc_get_boost_migration_config() {
 	);
 }
 
+/**
+ * Display an admin notice to install Jetpack Boost.
+ */
+function wpsc_jetpack_boost_notice() {
+	if ( ! isset( $_GET['page'] ) || $_GET['page'] !== 'wpsupercache' ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		return;
+	}
+
+	// Don't show the banner if the banner has been dismissed.
+	$is_dismissed = '1' === get_user_option( 'wpsc_dismissed_boost_admin_notice' );
+	if ( $is_dismissed ) {
+		return;
+	}
+
+	// Don't show the admin notice if Jetpack Boost is too old.
+	if ( ! wpsc_is_boost_current() ) {
+		return;
+	}
+
+	// Don't show the banner if Super Cache is using features that Boost doesn't support.
+	if ( ! wpsc_is_boost_compatible() ) {
+		return;
+	}
+
+	$config       = wpsc_get_boost_migration_config();
+	$button_url   = $config['is_installed'] ? $config['activate_url'] : $config['install_url'];
+	$button_class = $config['is_installed'] ? 'wpsc-activate-boost-button' : 'wpsc-install-boost-button';
+
+	?>
+	<div id="wpsc-notice-boost-migrate" class="notice boost-notice notice-success is-dismissible">
+	<h3>
+		<?php esc_html_e( 'Migrate to Jetpack Boost', 'wp-super-cache' ); ?>
+	</h3>
+	<p>
+		<?php esc_html_e( 'Your WP Super Cache setup is compatible with Boost\'s new caching feature. Continue to cache as you currently do and enhance your site\'s speed using our highly-rated performance solutions.', 'wp-super-cache' ); ?>
+	</p>
+
+	<p>
+		<div class="wpsc-boost-migration-error" style="display:none; color:red; margin-bottom: 20px;"></div>
+		<a data-source='notice' class='wpsc-boost-migration-button button button-primary <?php echo esc_attr( $button_class ); ?>' href="<?php echo esc_url( $button_url ); ?>">
+			<div class="spinner" style="display:none; margin-top: 8px"></div>
+			<label><?php esc_html_e( 'Migrate now', 'wp-super-cache' ); ?></label>
+		</a>
+	</p>
+	</div>
+	<?php
+}
+add_action( 'admin_notices', 'wpsc_jetpack_boost_notice' );
+
+/**
+ * Dismiss the migration admin notice by setting a user option flag.
+ */
+function wpsc_dismiss_boost_notice() {
+	update_user_option( get_current_user_id(), 'wpsc_dismissed_boost_admin_notice', '1' );
+}
+
+/**
+ * Handler called by AJAX to dismiss the admin notice.
+ */
+function wpsc_dismiss_boost_notice_ajax_handler() {
+	check_ajax_referer( 'wpsc_dismiss_boost_notice', 'nonce' );
+	wpsc_dismiss_boost_notice();
+	wp_die();
+}
+add_action( 'wp_ajax_wpsc_dismiss_boost_notice', 'wpsc_dismiss_boost_notice_ajax_handler' );
+
+/**
+ * Dismiss the admin notice if the Jetpack Boost plugin is activated.
+ */
+function wpsc_dismiss_notice_on_activation() {
+	if ( ! current_user_can( 'activate_plugins' ) ) {
+		return;
+	}
+
+	wpsc_dismiss_boost_notice();
+}
+add_action( 'wp_ajax_wpsc_activate_boost', 'wpsc_dismiss_notice_on_activation' );
 /**
  * Add a notice to the settings page if the Jetpack Boost cache module is detected.
  * The notice contains instructions on how to disable the Boost Cache module.
@@ -56,4 +143,88 @@ function wpsc_notify_migration_to_boost( $source ) {
 		return;
 	}
 	set_transient( 'jb_cache_moved_to_boost', $source, WEEK_IN_SECONDS );
+}
+
+/**
+ * Check if Jetpack Boost is compatible with WP Super Cache.
+ *
+ * @return bool
+ */
+function wpsc_is_boost_compatible() {
+	if ( ! empty( $GLOBALS['wp_cache_mobile_enabled'] ) ) {
+		return false;
+	}
+
+	if ( isset( $GLOBALS['wp_super_cache_late_init'] ) && $GLOBALS['wp_super_cache_late_init'] === 1 ) {
+		return false;
+	}
+
+	if ( ! empty( $GLOBALS['wpsc_rejected_cookies'] ) ) {
+		return false;
+	}
+
+	if ( isset( $GLOBALS['wp_cache_not_logged_in'] ) && $GLOBALS['wp_cache_not_logged_in'] !== 2 ) {
+		return false;
+	}
+
+	if ( isset( $GLOBALS['wp_cache_preload_on'] ) && $GLOBALS['wp_cache_preload_on'] === 1 ) {
+		return false;
+	}
+
+	if ( ! empty( $GLOBALS['wp_cache_no_cache_for_get'] ) ) {
+		return false;
+	}
+
+	if ( ! empty( $GLOBALS['wpsc_save_headers'] ) ) {
+		return false;
+	}
+
+	if ( isset( $GLOBALS['wp_cache_make_known_anon'] ) && $GLOBALS['wp_cache_make_known_anon'] === 1 ) {
+		return false;
+	}
+
+	if ( ! empty( $GLOBALS['wp_cache_mfunc_enabled'] ) ) {
+		return false;
+	}
+
+	if ( isset( $GLOBALS['wp_cache_clear_on_post_edit'] ) && $GLOBALS['wp_cache_clear_on_post_edit'] === 1 ) {
+		return false;
+	}
+
+	if ( ! empty( $GLOBALS['wp_cache_front_page_checks'] ) ) {
+		return false;
+	}
+
+	if ( is_array( $GLOBALS['wp_cache_pages'] ) && array_sum( $GLOBALS['wp_cache_pages'] ) ) {
+		return false;
+	}
+
+	$default_cache_acceptable_files = array( 'wp-comments-popup.php', 'wp-links-opml.php', 'wp-locations.php' );
+	if ( is_array( $GLOBALS['cache_acceptable_files'] ) && array_diff( $GLOBALS['cache_acceptable_files'], $default_cache_acceptable_files ) ) {
+		return false;
+	}
+
+	$default_cache_rejected_uri = array( 'wp-.*\\.php', 'index\\.php' );
+	if ( is_array( $GLOBALS['cache_rejected_uri'] ) && array_diff( $GLOBALS['cache_rejected_uri'], $default_cache_rejected_uri ) ) {
+		return false;
+	}
+
+	if ( is_array( $GLOBALS['cache_rejected_user_agent'] ) && array_diff( $GLOBALS['cache_rejected_user_agent'], array( '' ) ) ) {
+		return false;
+	}
+
+	return true;
+}
+
+/**
+ * Check if the Jetpack Boost that is installed is current.
+ *
+ * @return bool True if Jetpack Boost is same as or newer than version 3.4.0
+ */
+function wpsc_is_boost_current() {
+	if ( defined( 'JETPACK_BOOST_VERSION' ) ) {
+		return version_compare( (string) JETPACK_BOOST_VERSION, MINIMUM_BOOST_VERSION, '>=' );
+	} else {
+		return true; // don't care if Boost is not installed
+	}
 }
\ No newline at end of file
diff --git a/js/admin.js b/js/admin.js
index 7d1715a1..f6621f22 100644
--- a/js/admin.js
+++ b/js/admin.js
@@ -1,122 +1,146 @@
-jQuery( document ).ready( () => {
-	// Don't run on versions of WordPress too old for the block editor and the translation methods it brings.
-	// All the install / activate options are plain links with meaningful destinations anyway.
-	if ( ! window.wp || ! window.wp.i18n ) {
-		return;
-	}
+/**
+ * Handle the buttons for the Boost migration.
+ * @param {jQuery} $ - jQuery
+ */
+( $ => {
+	$( document ).ready( function () {
+		// Don't run on versions of WordPress too old for the block editor and the translation methods it brings.
+		// All the install / activate options are plain links with meaningful destinations anyway.
+		if ( ! window.wp || ! window.wp.i18n ) {
+			return;
+		}
 
-	const { __, sprintf } = window.wp.i18n;
-	const ajaxurl = window.ajaxurl;
-	const wpscAdmin = window.wpscAdmin;
+		const { __, sprintf } = window.wp.i18n;
+		const ajaxurl = window.ajaxurl;
+		const wpscAdmin = window.wpscAdmin;
 
-	const link = jQuery( '.wpsc-install-action-button' );
-	const label = link.find( 'label' );
-	const spinner = link.find( '.spinner' );
+		const setupBoostButton = $target => {
+			if ( ! $target.hasClass( 'wpsc-boost-migration-button' ) ) {
+				// eslint-disable-next-line no-console
+				console.warn( 'Unexpected button clicked for Boost migration.' );
+				return;
+			}
+			const $label = $target.find( 'label' );
+			const $spinner = $target.find( '.spinner' );
+			const $errorMessage = $target.prev( '.wpsc-boost-migration-error' );
+			const source = $target.attr( 'data-source' );
+			const originalText = $label.text();
 
-	// Dismiss Boost banner.
-	jQuery( '.wpsc-boost-dismiss' ).on( 'click', function () {
-		jQuery( '.wpsc-boost-banner' ).fadeOut( 'slow' );
+			// Helper function to show an error.
+			const showError = err => {
+				reset();
 
-		jQuery.post( ajaxurl, {
-			action: 'wpsc-hide-boost-banner',
-			nonce: wpscAdmin.boostDismissNonce,
-		} );
-	} );
+				$errorMessage
+					.text(
+						err ||
+							__( 'An error occurred while trying to activate Jetpack Boost', 'wp-super-cache' )
+					)
+					.show();
+			};
+			// Helper function to show Boost Banner work in progress.
+			const showBusy = action => {
+				$target.attr( 'disabled', true );
+				$label.text( action );
+				$spinner.addClass( 'is-active' ).show();
+			};
 
-	// One-click install for Boost.
-	jQuery( '.wpsc-install-boost-button' ).on( 'click', event => {
-		const source = jQuery( event.currentTarget ).attr( 'data-source' );
-		event.preventDefault();
-		showBoostBannerBusy( __( 'Installing…', 'wp-super-cache' ) );
+			// Helper function to reset Boost Banner button.
+			const reset = () => {
+				$target.attr( 'disabled', false );
+				$label.text( originalText );
+				$spinner.removeClass( 'is-active' ).hide();
+			};
 
-		jQuery
-			.post( ajaxurl, {
-				action: 'wpsc_install_plugin',
-				_ajax_nonce: wpscAdmin.boostInstallNonce,
-				slug: 'jetpack-boost',
-			} )
-			.done( response => {
-				if ( response.success ) {
-					activateBoost( source );
-				} else {
-					showBoostBannerError( response.data );
-				}
-			} )
-			.fail( response => {
-				showBoostBannerError(
-					sprintf(
-						/* translators: %d is an HTTP error code */
-						__( 'Failed to install Jetpack Boost: HTTP %d error received', 'wp-super-cache' ),
-						response.status
-					)
-				);
-			} );
-	} );
+			// Activate Jetpack Boost.
+			const activateBoost = () => {
+				showBusy( __( 'Activating…', 'wp-super-cache' ) );
 
-	// Handle activate button click.
-	jQuery( '.wpsc-activate-boost-button' ).on( 'click', event => {
-		const source = jQuery( event.currentTarget ).attr( 'data-source' );
-		event.preventDefault();
-		activateBoost( source );
-	} );
+				$.post( ajaxurl, {
+					action: 'wpsc_activate_boost',
+					_ajax_nonce: wpscAdmin.boostActivateNonce,
+					source: source,
+				} )
+					.done( response => {
+						if ( response.success ) {
+							$label.text( 'Success! Sending you to Jetpack Boost...' );
+							$spinner.hide();
+							window.location.href = 'admin.php?page=jetpack-boost';
+						} else {
+							showError( response.data );
+						}
+					} )
+					.fail( response => {
+						showError(
+							sprintf(
+								/* translators: %d is an HTTP error code */
+								__( 'Failed to activate Jetpack Boost: HTTP %d error received', 'wp-super-cache' ),
+								response.status
+							)
+						);
+					} );
+			};
 
-	// Helper function to show Boost Banner work in progress.
-	const showBoostBannerBusy = action => {
-		link.attr( 'disabled', true );
-		label.text( action );
-		spinner.addClass( 'is-active' ).show();
-	};
+			const installBoost = () => {
+				showBusy( __( 'Installing…', 'wp-super-cache' ) );
+				$.post( ajaxurl, {
+					action: 'wpsc_install_plugin',
+					_ajax_nonce: wpscAdmin.boostInstallNonce,
+					slug: 'jetpack-boost',
+				} )
+					.done( response => {
+						if ( response.success ) {
+							activateBoost();
+						} else {
+							showError( response.data );
+						}
+					} )
+					.fail( response => {
+						showError(
+							sprintf(
+								/* translators: %d is an HTTP error code */
+								__( 'Failed to install Jetpack Boost: HTTP %d error received', 'wp-super-cache' ),
+								response.status
+							)
+						);
+					} );
+			};
 
-	// Helper function to reset Boost Banner button.
-	const resetBoostBannerButton = () => {
-		link.attr( 'disabled', false );
-		jQuery( '#wpsc-activate-boost-button' )
-			.find( 'label' )
-			.text( __( 'Activate Jetpack Boost', 'wp-super-cache' ) );
-		jQuery( '#wpsc-install-boost-button' )
-			.find( 'label' )
-			.text( __( 'Install Jetpack Boost', 'wp-super-cache' ) );
-		spinner.removeClass( 'is-active' ).hide();
-	};
+			return {
+				installBoost,
+				activateBoost,
+			};
+		};
 
-	// Helper function to show an error.
-	const showBoostBannerError = err => {
-		resetBoostBannerButton();
+		// One-click install for Boost.
+		$( '.wpsc-install-boost-button' ).on( 'click', event => {
+			event.preventDefault();
+			const boostActivation = setupBoostButton( $( event.currentTarget ) );
+			boostActivation.installBoost();
+		} );
 
-		jQuery( '#wpsc-boost-banner-error' )
-			.text(
-				err || __( 'An error occurred while trying to activate Jetpack Boost', 'wp-super-cache' )
-			)
-			.show();
-	};
+		// Handle activate button click.
+		$( '.wpsc-activate-boost-button' ).on( 'click', event => {
+			event.preventDefault();
+			const boostActivation = setupBoostButton( $( event.currentTarget ) );
+			boostActivation.activateBoost();
+		} );
 
-	// Activate Jetpack Boost.
-	const activateBoost = source => {
-		showBoostBannerBusy( __( 'Activating…', 'wp-super-cache' ) );
+		// Dismiss Boost banner.
+		$( '.wpsc-boost-dismiss' ).on( 'click', () => {
+			$( '.wpsc-boost-banner' ).fadeOut( 'slow' );
+			$.post( ajaxurl, {
+				action: 'wpsc-hide-boost-banner',
+				nonce: wpscAdmin.boostDismissNonce,
+			} );
+		} );
 
-		jQuery
-			.post( ajaxurl, {
-				action: 'wpsc_activate_boost',
-				_ajax_nonce: wpscAdmin.boostActivateNonce,
-				source: source,
-			} )
-			.done( response => {
-				if ( response.success ) {
-					label.text( 'Success! Sending you to Jetpack Boost...' );
-					spinner.hide();
-					window.location.href = 'admin.php?page=jetpack-boost';
-				} else {
-					showBoostBannerError( response.data );
-				}
-			} )
-			.fail( response => {
-				showBoostBannerError(
-					sprintf(
-						/* translators: %d is an HTTP error code */
-						__( 'Failed to activate Jetpack Boost: HTTP %d error received', 'wp-super-cache' ),
-						response.status
-					)
-				);
+		// Dismiss admin notice
+		$( '.boost-notice' ).on( 'click', '.notice-dismiss', event => {
+			event.preventDefault();
+			$.post( ajaxurl, {
+				action: 'wpsc_dismiss_boost_notice',
+				_ajax_nonce: wpscAdmin.boostNoticeDismissNonce,
 			} );
-	};
-} );
+		} );
+	} );
+} )( jQuery );
diff --git a/styling/dashboard.css b/styling/dashboard.css
index 6c108591..406f4380 100644
--- a/styling/dashboard.css
+++ b/styling/dashboard.css
@@ -173,3 +173,14 @@
 	width: 190px;
 	height: auto;
 }
+
+#wpsc-notice-boost-migrate {
+	width: 80%;
+	margin: 0 auto;
+	margin-top: 10px;
+
+	a.button.button-primary {
+		background-color: var(--jp-black);
+		color: var(--jp-white);
+	}
+}
diff --git a/wp-cache.php b/wp-cache.php
index ee74b811..23dcce0a 100644
--- a/wp-cache.php
+++ b/wp-cache.php
@@ -319,9 +319,10 @@ function wp_super_cache_admin_enqueue_scripts( $hook ) {
 		'wp-super-cache-admin',
 		'wpscAdmin',
 		array(
-			'boostDismissNonce'  => wp_create_nonce( 'wpsc_dismiss_boost_banner' ),
-			'boostInstallNonce'  => wp_create_nonce( 'updates' ),
-			'boostActivateNonce' => wp_create_nonce( 'activate-boost' ),
+			'boostNoticeDismissNonce' => wp_create_nonce( 'wpsc_dismiss_boost_notice' ),
+			'boostDismissNonce'       => wp_create_nonce( 'wpsc_dismiss_boost_banner' ),
+			'boostInstallNonce'       => wp_create_nonce( 'updates' ),
+			'boostActivateNonce'      => wp_create_nonce( 'activate-boost' ),
 		)
 	);
 }
@@ -422,9 +423,9 @@ function wpsc_jetpack_boost_install_banner() {
 						?>
 					</p>
 
-					<div id="wpsc-boost-banner-error" style="display:none; color:red; margin-bottom: 20px;"></div>
+					<div class="wpsc-boost-migration-error" style="display:none; color:red; margin-bottom: 20px;"></div>
 
-					<a data-source='banner' href="<?php echo esc_url( $button_url ); ?>" class="button button-primary wpsc-install-action-button <?php echo esc_attr( $button_class ); ?>">
+					<a data-source='banner' href="<?php echo esc_url( $button_url ); ?>" class="wpsc-boost-migration-button button button-primary <?php echo esc_attr( $button_class ); ?>">
 						<div class="spinner" style="display:none; margin-top: 8px"></div>
 						<label><?php echo esc_html( $button_label ); ?></label>
 					</a>