22

✏️ Editing: Version_Switch.php

<?php

namespace Code_Snippets\Settings;

use Plugin_Upgrader;
use WP_Ajax_Upgrader_Skin;
use WP_Error;
use WP_Upgrader_Skin;
use function Code_Snippets\code_snippets;

/**
 * Version switching functionality for the Code Snippets plugin.
 *
 * @package    Code_Snippets
 * @subpackage Settings
 */
class Version_Switch {

/**
	 * Transient key where the available version data is cached.
	 */
	private const CACHE_KEY = 'code_snippets_available_versions';

/**
	 * Transient key used to indicate when a version switch is currently taking place.
	 */
	private const PROGRESS_KEY = 'code_snippets_version_switch_progress';

/**
	 * Duration of the version cache transient.
	 */
	private const VERSION_CACHE_DURATION = HOUR_IN_SECONDS;

/**
	 * Duration of the 'in progress' transient.
	 */
	private const PROGRESS_TIMEOUT = 5 * MINUTE_IN_SECONDS;

/**
	 * API endpoint for checking for available plugin versions.
	 */
	private const WORDPRESS_API_ENDPOINT = 'https://api.wordpress.org/plugins/info/1.2/?action=plugin_information&slug=code-snippets';

/**
	 * Initialise class.
	 *
	 * @return void
	 */
	public static function init(): void {
		add_action( 'wp_ajax_code_snippets_switch_version', [ __CLASS__, 'ajax_switch_version' ] );
		add_action( 'wp_ajax_code_snippets_refresh_versions', [ __CLASS__, 'ajax_refresh_versions' ] );
	}

/**
	 * Retrieve a list of plugin versions available for switching.
	 *
	 * @return array
	 */
	public static function get_available_versions(): array {
		$versions = get_transient( self::CACHE_KEY );

if ( false === $versions ) {
			$response = wp_remote_get( self::WORDPRESS_API_ENDPOINT );

if ( is_wp_error( $response ) ) {
				return [];
			}

$body = wp_remote_retrieve_body( $response );
			$data = json_decode( $body, true );

if ( ! $data || ! isset( $data['versions'] ) ) {
				return [];
			}

// Filter out 'trunk' and sort versions.
			$versions = [];
			foreach ( $data['versions'] as $version => $download_url ) {
				if ( 'trunk' !== $version ) {
					$versions[] = [
						'version' => $version,
						'url'     => $download_url,
					];
				}
			}

// Sort versions in descending order.
			usort(
				$versions,
				function ( $a, $b ) {
					return version_compare( $b['version'], $a['version'] );
				}
			);

// Cache for configured duration.
			set_transient( self::CACHE_KEY, $versions, self::VERSION_CACHE_DURATION );
		}

return $versions;
	}

/**
	 * Retrieve the current plugin version.
	 *
	 * @return string
	 */
	public static function get_current_version(): string {
		return defined( 'CODE_SNIPPETS_VERSION' ) ? CODE_SNIPPETS_VERSION : '0.0.0';
	}

/**
	 * Determine if a version switch is currently taking place.
	 *
	 * @return bool
	 */
	public static function is_version_switch_in_progress(): bool {
		return get_transient( self::PROGRESS_KEY ) !== false;
	}

/**
	 * Purge transient data associated with this class.
	 *
	 * @return void
	 */
	public static function clear_version_caches(): void {
		delete_transient( self::CACHE_KEY );
		delete_transient( self::PROGRESS_KEY );
	}

/**
	 * Validate that a target version is valid.
	 *
	 * @param string $target_version     Target version for switching.
	 * @param array  $available_versions List of available versions.
	 *
	 * @return array
	 */
	public static function validate_target_version( string $target_version, array $available_versions ): array {
		if ( empty( $target_version ) ) {
			return [
				'success'      => false,
				'message'      => __( 'No target version specified.', 'code-snippets' ),
				'download_url' => '',
			];
		}

foreach ( $available_versions as $version_info ) {
			if ( $version_info['version'] === $target_version ) {
				return [
					'success'      => true,
					'message'      => '',
					'download_url' => $version_info['url'],
				];
			}
		}

return [
			'success'      => false,
			'message'      => __( 'Invalid version specified.', 'code-snippets' ),
			'download_url' => '',
		];
	}

/**
	 * Create a response indicating an error occurred.
	 *
	 * @param string $message           Error message.
	 * @param string $technical_details Additional details.
	 *
	 * @return array
	 *
	 * phpcs:disable WordPress.PHP.DevelopmentFunctions.error_log_error_log
	 */
	public static function create_error_response( string $message, string $technical_details = '' ): array {
		if ( ! empty( $technical_details ) ) {
			if ( function_exists( 'error_log' ) ) {
				error_log( sprintf( 'Code Snippets version switch error: %s. Details: %s', $message, $technical_details ) );
			}
		}

return [
			'success' => false,
			'message' => $message,
		];
	}

/**
	 * Install a plugin version from a URL.
	 *
	 * @param string $download_url Download URL.
	 *
	 * @return array|bool|WP_Error
	 */
	public static function perform_version_install( string $download_url ) {
		if ( ! function_exists( 'wp_update_plugins' ) ) {
			require_once ABSPATH . 'wp-admin/includes/update.php';
		}
		if ( ! function_exists( 'show_message' ) ) {
			require_once ABSPATH . 'wp-admin/includes/misc.php';
		}
		if ( ! class_exists( 'Plugin_Upgrader' ) ) {
			require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
		}

$update_handler = new WP_Ajax_Upgrader_Skin();
		$upgrader = new Plugin_Upgrader( $update_handler );

global $code_snippets_last_update_handler, $code_snippets_last_upgrader;
		$code_snippets_last_update_handler = $update_handler;
		$code_snippets_last_upgrader = $upgrader;

return $upgrader->install(
			$download_url,
			[
				'overwrite_package'  => true,
				'clear_update_cache' => true,
			]
		);
	}

/**
	 * Extract error message from an upgrade handler.
	 *
	 * @param WP_Upgrader_Skin|null $update_handler Update handler.
	 * @param Plugin_Upgrader|null  $upgrader       Plugin upgrader.
	 *
	 * @return string
	 *
	 * phpcs:disable WordPress.PHP.DevelopmentFunctions.error_log_print_r
	 */
	public static function extract_handler_messages( ?WP_Upgrader_Skin $update_handler, ?Plugin_Upgrader $upgrader ): string {
		$handler_messages = '';

if ( isset( $update_handler ) ) {
			if ( method_exists( $update_handler, 'get_errors' ) ) {
				$errs = $update_handler->get_errors();
				if ( $errs instanceof WP_Error && $errs->has_errors() ) {
					$handler_messages .= implode( "\n", $errs->get_error_messages() );
				}
			}
			if ( method_exists( $update_handler, 'get_error_messages' ) ) {
				$em = $update_handler->get_error_messages();
				if ( $em ) {
					$handler_messages .= "\n" . $em;
				}
			}
			if ( method_exists( $update_handler, 'get_upgrade_messages' ) ) {
				$upgrade_msgs = $update_handler->get_upgrade_messages();
				if ( is_array( $upgrade_msgs ) ) {
					$handler_messages .= "\n" . implode( "\n", $upgrade_msgs );
				} elseif ( $upgrade_msgs ) {
					$handler_messages .= "\n" . $upgrade_msgs;
				}
			}
		}

if ( empty( $handler_messages ) && isset( $upgrader->result ) ) {
			if ( is_wp_error( $upgrader->result ) ) {
				$handler_messages = implode( "\n", $upgrader->result->get_error_messages() );
			} else {
				$handler_messages = is_scalar( $upgrader->result )
					? (string) $upgrader->result
					: print_r( $upgrader->result, true );
			}
		}

return trim( $handler_messages );
	}

/**
	 * Report the failure of a version switch attempt.
	 *
	 * @param string $target_version Version number of attempted upgrade.
	 * @param mixed  $result         Result of upgrade.
	 * @param string $details        Additional details.
	 *
	 * @return void
	 *
	 * phpcs:disable WordPress.PHP.DevelopmentFunctions
	 */
	private static function log_version_switch_attempt( string $target_version, $result, string $details = '' ): void {
		if ( function_exists( 'error_log' ) ) {
			error_log( sprintf( 'Code Snippets version switch failed. target=%s, result=%s, details=%s', $target_version, var_export( $result, true ), $details ) );
		}
	}

/**
	 * Handle the failure to install a new version.
	 *
	 * @param string $target_version Version used for attempted installation.
	 * @param string $download_url   URL used for downloading new version.
	 * @param mixed  $install_result Result of installation attempt.
	 *
	 * @return array
	 */
	private static function handle_installation_failure( string $target_version, string $download_url, $install_result ): array {
		global $code_snippets_last_update_handler, $code_snippets_last_upgrader;

$handler_messages = self::extract_handler_messages( $code_snippets_last_update_handler, $code_snippets_last_upgrader );
		self::log_version_switch_attempt( $target_version, $install_result, "URL: $download_url, Messages: $handler_messages" );

$fallback_message = __( 'Failed to switch versions. Please try again.', 'code-snippets' );

if ( ! empty( $handler_messages ) ) {
			$short = wp_trim_words( wp_strip_all_tags( $handler_messages ), 40 );
			$fallback_message = sprintf( '%s %s', $fallback_message, $short );
		}

return [
			'success' => false,
			'message' => $fallback_message,
		];
	}

/**
	 * Handle switching to a different plugin version.
	 *
	 * @param string $target_version Target version to switch to.
	 *
	 * @return array Result data.
	 */
	public static function handle_version_switch( string $target_version ): array {
		if ( ! current_user_can( 'update_plugins' ) ) {
			return self::create_error_response( __( 'You do not have permission to update plugins.', 'code-snippets' ) );
		}

$available_versions = self::get_available_versions();
		$validation = self::validate_target_version( $target_version, $available_versions );

if ( ! $validation['success'] ) {
			return self::create_error_response( $validation['message'] );
		}

if ( self::get_current_version() === $target_version ) {
			return self::create_error_response( __( 'Already on the specified version.', 'code-snippets' ) );
		}

set_transient( self::PROGRESS_KEY, $target_version, self::PROGRESS_TIMEOUT );

$install_result = self::perform_version_install( $validation['download_url'] );

delete_transient( self::PROGRESS_KEY );

if ( is_wp_error( $install_result ) ) {
			return self::create_error_response( $install_result->get_error_message() );
		}

if ( $install_result ) {
			delete_transient( self::CACHE_KEY );

// translators: %s: new version number.
			$message = esc_html__( 'Successfully switched to version %s. Please refresh the page to see changes.', 'code-snippets' );

return [
				'success' => true,
				'message' => sprintf( $message, $target_version ),
			];
		} else {
			return self::handle_installation_failure( $target_version, $validation['download_url'], $install_result );
		}
	}

/**
	 * Render settings page field for the version switcher.
	 *
	 * @return void
	 */
	public static function render_version_switch_field(): void {
		$current_version = self::get_current_version();
		$available_versions = self::get_available_versions();
		$is_switching = self::is_version_switch_in_progress();

?>
		<div class="code-snippets-version-switch">
		<p>
			<strong><?php esc_html_e( 'Current Version:', 'code-snippets' ); ?></strong>
			<span class="current-version"><?php echo esc_html( $current_version ); ?></span>
		</p>

<?php if ( $is_switching ) : ?>
			<div class="notice code-snippets-notice notice-info inline">
				<p><?php esc_html_e( 'Version switch in progress. Please wait…', 'code-snippets' ); ?></p>
			</div>
		<?php else : ?>
			<p>
				<label for="target_version">
					<?php esc_html_e( 'Switch to Version:', 'code-snippets' ); ?>
				</label>
				<select id="target_version" name="target_version" <?php disabled( empty( $available_versions ) ); ?>>
					<option value=""><?php esc_html_e( 'Select a version…', 'code-snippets' ); ?></option>
					<?php foreach ( $available_versions as $version_info ) { ?>
						<option value="<?php echo esc_attr( $version_info['version'] ); ?>"
							<?php selected( $version_info['version'], $current_version ); ?>>
							<?php

echo esc_html( $version_info['version'] );

if ( $version_info['version'] === $current_version ) {
								esc_html_e( ' (Current)', 'code-snippets' );
							}

?>
						</option>
					<?php } ?>
				</select>
			</p>

<div id="version-switch-result" class="notice code-snippets-notice" style="display: none;"></div>
		<?php endif; ?>
		</div><?php
	}

/**
	 * Handle version switching through AJAX.
	 *
	 * @return void
	 */
	public static function ajax_switch_version(): void {
		check_ajax_referer( 'code_snippets_version_switch', 'nonce' );

if ( ! current_user_can( 'update_plugins' ) ) {
			wp_send_json_error( [ 'message' => __( 'You do not have permission to update plugins.', 'code-snippets' ) ] );
		}

$target_version = sanitize_text_field( wp_unslash( $_POST['target_version'] ?? '' ) );

if ( empty( $target_version ) ) {
			wp_send_json_error( [ 'message' => __( 'No target version specified.', 'code-snippets' ) ] );
		}

$result = self::handle_version_switch( $target_version );

if ( $result['success'] ) {
			wp_send_json_success( $result );
		} else {
			wp_send_json_error( $result );
		}
	}

/**
	 * Render settings page field for the refresh version button.
	 *
	 * @return void
	 */
	public static function render_refresh_versions_field(): void {
		printf(
			'<button type="button" id="refresh-versions-btn" class="button button-secondary">%s</button>',
			esc_html__( 'Refresh Available Versions', 'code-snippets' )
		);

printf(
			'<p class="description">%s</p>',
			esc_html__( 'Check for the latest available plugin versions from WordPress.org.', 'code-snippets' )
		);
	}

/**
	 * AJAX handler for refreshing the installed version.
	 *
	 * @return void
	 */
	public static function ajax_refresh_versions(): void {
		check_ajax_referer( 'code_snippets_refresh_versions', 'nonce' );

if ( ! code_snippets()->current_user_can() ) {
			wp_send_json_error( [ 'message' => __( 'You do not have permission to manage options.', 'code-snippets' ) ] );
		}

delete_transient( self::CACHE_KEY );
		self::get_available_versions();

wp_send_json_success( [ 'message' => __( 'Available versions updated successfully.', 'code-snippets' ) ] );
	}

/**
	 * Render warning notice.
	 *
	 * @return void
	 */
	public static function render_version_switch_warning(): void {
		?>
		<div id="version-switch-warning" class="notice code-snippets-notice notice-warning hidden" role="region">
			<p>
				<strong><?php esc_html_e( 'Warning:', 'code-snippets' ); ?></strong>
				<?php esc_html_e( 'Switching versions may cause compatibility issues. Always backup your site before switching versions.', 'code-snippets' ); ?>
			</p>
		</div>
		<?php
	}
}

MR SKB