diff --git src/wp-includes/class-wp-restore-siteurl.php src/wp-includes/class-wp-restore-siteurl.php new file mode 100644 index 0000000000..b7bc274346 --- /dev/null +++ src/wp-includes/class-wp-restore-siteurl.php @@ -0,0 +1,291 @@ +restore_key ) { + $this->restore_key = wp_generate_password( 16, false ); + } + + return $this->restore_key; + } + + /** + * Listen to updates for 'home' and 'siteurl' options. + * + * This function performs the following tasks when either 'home' and 'siteurl' options are updated: + * 1. Caches the old 'home' value if it's the option updated. + * 2. Creates a 'siteurl_restore_key' transient that will be used to authenticate the restore operation. + * 3. Backups the old 'home' or 'siteurl' values. + * 4. Sends an email to the admin with the restore link. + * + * @since 5.3.0 + * + * @param string $option Name of the updated option. + * @param string $old_value The old option value. + * @param string $value The new option value. + */ + public function setup_siteurl_restore( $option, $old_value, $value ) { + if ( 'siteurl' === $option || 'home' === $option ) { + // Prevent Restore Siteurl protocol if the update is the restoration. + $backup_value = get_transient( "old_{$option}" ); + if ( $value === $backup_value ) { + return; + } + + // Backup the old 'home' option value. + if ( 'home' === $option ) { + $this->old_home_value = $old_value; + } + + $restore_key_transient = get_transient( 'siteurl_restore_key' ); + $set_restore_key_transient = false; + if ( $this->generate_restore_key() != $restore_key_transient ) { + // Create a restore key transient. + $set_restore_key_transient = set_transient( 'siteurl_restore_key', $this->generate_restore_key(), self::RESTORE_TRANSIENTS_EXPIRY_IN_SECONDS ); + } + + // Keep a backup of the old `siteurl` and `home`. + delete_transient( "old_{$option}" ); + $set_backup_transient = set_transient( "old_{$option}", $old_value, self::RESTORE_TRANSIENTS_EXPIRY_IN_SECONDS ); + + if ( $set_restore_key_transient && $set_backup_transient ) { + $this->send_restore_link_email_to_admin(); + } + } + } + + /** + * Send restore link email to admin. + * + * @since 5.3.0 + */ + private function send_restore_link_email_to_admin() { + if ( ! $this->is_restore_siteurl_email_sent ) { + $restore_link = add_query_arg( [ + 'srk' => $this->generate_restore_key(), + ], $this->get_old_home_value() ); + + $admin_email = get_option( 'admin_email' ); + /** + * Filters the subject of the restore siteurl email. + * + * @since 5.3.0 + * + * @param string $email_subject The subject of the restore siteurl email. + */ + $email_subject = apply_filters( 'restore_siteurl_email_subject', __( 'Your WordPress site url was changed.' ) ); + /** + * Filters the content body of the restore siteurl email. + * + * @since 5.3.0 + * + * @param string $email_content The content body of the restore siteurl email. + */ + $email_content = apply_filters( + 'restore_siteurl_email_message', + __( 'You can undo this change by clicking this link ###restore_link###' ) + ); + + // Replace placeholder with actual restore link. + $email_content = str_replace( '###restore_link###', $restore_link, $email_content ); + + $email = wp_mail( $admin_email, $email_subject, $email_content ); + + if ( $email ) { + $this->is_restore_siteurl_email_sent = true; + } + + /** + * Fires after the attempt to send restore link email to admin. + * + * @since 5.3.0 + * + * @param boolean $email Whether the email is sent successfully. + */ + do_action( 'send_restore_link_email', $email ); + } + } + + /** + * Get the old 'home' option value. + * + * @since 5.3.0 + * + * @return string $old_home_value Old 'home' value. + */ + public function get_old_home_value() { + if ( null !== $this->old_home_value ) { + return esc_url( $this->old_home_value ); + } + + $old_home_transient = get_transient( 'old_home' ); + if ( $old_home_transient !== false ) { + $this->old_home_value = $old_home_transient; + } + else { + $this->old_home_value = get_option( 'home' ); + } + + return esc_url( $this->old_home_value ); + } + + /** + * Perform the siteurl restore operation. + * + * If the provided restore key is invalid, the process is terminated using `wp_die()`. + * Else if the restore key is valid, then it will perform the restore siteurl operation. + * + * If the restore siteurl operation is a success, it will perform the following. + * 1. Delete the backup transients. + * 2. Create a success-tracker transient named 'siteurl_restore_success'. + * 3. Redirect the user to the old admin dashboard url. + * + * @since 5.3.0 + */ + public function perform_siteurl_restore() { + if ( isset( $_GET['srk'] ) && ! empty( $_GET['srk'] ) ) { + $restore_key = get_transient( 'siteurl_restore_key' ); + + if ( $_GET['srk'] === $restore_key ) { + $old_siteurl = get_transient( 'old_siteurl' ); + $old_home = get_transient( 'old_home' ); + + $is_restore_success = false; + + if ( $old_siteurl ) { + $update_siteurl = update_option( 'siteurl', $old_siteurl ); + + if ( $update_siteurl ) { + delete_transient( 'old_siteurl' ); + + $is_restore_success = true; + } + } + + if ( $old_home ) { + $update_home = update_option( 'home', $old_home ); + + if ( $update_home ) { + delete_transient( 'old_home' ); + + $is_restore_success = true; + } + } + + if ( $is_restore_success ) { + delete_transient( 'siteurl_restore_key' ); + + // Track success. + set_transient( 'siteurl_restore_success', '1', 300 ); + + $this->success_redirect(); + } + } + else { + wp_die( __( 'Restore key is invalid.' ) ); + exit; + } + } + } + + /** + * Redirect the user to admin dashboard with restore siteurl success $_GET param. + * + * @since 5.3.0 + */ + protected function success_redirect() { + $restored_site_admin_url = trailingslashit( get_option( 'home' ) ) . 'wp-admin'; + + // Success redirect url. + $success_redirect_url = add_query_arg( 'srsuccess', '1', $restored_site_admin_url ); + + wp_redirect( $success_redirect_url ); + exit; + } + + /** + * Display success notice if the restore siteurl operation is a success. + * + * @since 5.3.0 + */ + public function restore_siteurl_success_notice() { + if ( isset( $_GET['srsuccess'] ) && '1' === $_GET['srsuccess'] ) { + $restore_success = get_transient( 'siteurl_restore_success' ); + + if ( '1' === $restore_success ) { + add_action( 'admin_notices', [ $this, 'restore_siteurl_success_notice__success' ] ); + + delete_transient( 'siteurl_restore_success' ); + } + } + } + + /** + * Restore siteurl success notice. + * + * @since 5.3.0 + */ + public function restore_siteurl_success_notice__success() { + $class = 'notice notice-success'; + $message = __( 'Your WordPress site url was successfully restored.' ); + + printf( '

%2$s

', esc_attr( $class ), esc_html( $message ) ); + } +} \ No newline at end of file diff --git src/wp-includes/functions.php src/wp-includes/functions.php index f32e236778..6be7a39db7 100644 --- src/wp-includes/functions.php +++ src/wp-includes/functions.php @@ -7316,3 +7316,20 @@ function is_wp_version_compatible( $required ) { function is_php_version_compatible( $required ) { return empty( $required ) || version_compare( phpversion(), $required, '>=' ); } + +/** + * Access the WP Restore Siteurl instance. + * + * @since 5.3.0 + * + * @return WP_Restore_Siteurl + */ +function wp_restore_siteurl() { + static $wp_restore_siteurl; + + if ( ! $wp_restore_siteurl ) { + $wp_restore_siteurl = new WP_Restore_Siteurl(); + } + + return $wp_restore_siteurl; +} \ No newline at end of file diff --git src/wp-settings.php src/wp-settings.php index 681053a0d4..70e0965d89 100644 --- src/wp-settings.php +++ src/wp-settings.php @@ -151,6 +151,7 @@ require_once( ABSPATH . WPINC . '/class-wp-locale-switcher.php' ); wp_not_installed(); // Load most of WordPress. +require( ABSPATH . WPINC . '/class-wp-restore-siteurl.php' ); require( ABSPATH . WPINC . '/class-wp-walker.php' ); require( ABSPATH . WPINC . '/class-wp-ajax-response.php' ); require( ABSPATH . WPINC . '/capabilities.php' ); @@ -373,6 +374,9 @@ unset( $plugin ); require( ABSPATH . WPINC . '/pluggable.php' ); require( ABSPATH . WPINC . '/pluggable-deprecated.php' ); +// Load the WP Restore Siteurl instance. +wp_restore_siteurl(); + // Set internal encoding. wp_set_internal_encoding(); diff --git tests/phpunit/tests/restore-siteurl/restore-siteurl.php tests/phpunit/tests/restore-siteurl/restore-siteurl.php new file mode 100644 index 0000000000..f151037c3e --- /dev/null +++ tests/phpunit/tests/restore-siteurl/restore-siteurl.php @@ -0,0 +1,140 @@ +test_opt_ctr`. + * Then function `$this->change_test_opt_value()` that increments the value of `test_opt` + * is hooked in `send_restore_link_email` action. + * + * Since it is expected that the email will only be sent once, then `send_restore_link_email` + * action should only be invoked once. Hence the expected value of `test_opt` value should + * be 1. + */ + public function test_restore_link_email_should_only_be_sent_once() { + update_option( 'test_opt', $this->test_opt_ctr ); + + add_action( 'send_restore_link_email', array( $this, 'change_test_opt_value' ) ); + + update_option( 'home', 'http://wp.org' ); + update_option( 'site_url', 'http://wp.org' ); + + $test_opt = get_option( 'test_opt' ); + + $this->assertEquals( '1', $test_opt ); + } + + public function change_test_opt_value( $email ) { + update_option( 'test_opt', $this->test_opt_ctr ); + $this->test_opt_ctr += 1; + } + + public function test_updating_home_option_should_create_backup_transient() { + update_option( 'home', 'http://wp.org' ); + $a = get_option( 'home' ); + $actual = get_transient( 'old_home' ); + $this->assertNotFalse( $actual ); + } + + public function test_updating_siteurl_option_should_create_backup_transient() { + update_option( 'siteurl', 'http://wp.org' ); + $a = get_option( 'siteurl' ); + $actual = get_transient( 'old_siteurl' ); + $this->assertNotFalse( $actual ); + } + + public function test_restore_key_should_not_change_when_both_options_are_updated() { + update_option( 'home', 'http://wp.org' ); + + $wp_restore_siteurl = wp_restore_siteurl(); + + $reflection = new ReflectionClass( $wp_restore_siteurl ); + $method = $reflection->getMethod( 'generate_restore_key' ); + $method->setAccessible( true ); + + $restore_key = $method->invokeArgs( $wp_restore_siteurl, array() ); + $transient_restore_key = get_transient( 'siteurl_restore_key' ); + + update_option( 'siteurl', 'http://wp.org' ); + + $this->assertEquals( $restore_key, $transient_restore_key ); + } + + /** + * @expectedException WPDieException + * @expectedExceptionMessage Restore key is invalid. + */ + public function test_invalid_restore_key_should_be_blocked() { + update_option( 'home', 'http://wp.org' ); + update_option( 'siteurl', 'http://wp.org' ); + + // Use invalid restore key. + $_GET['srk'] = 'this-is-invalid.'; + + $wp_restore_siteurl = wp_restore_siteurl(); + $wp_restore_siteurl->perform_siteurl_restore(); + } + + public function test_success_perform_siteurl_restore() { + update_option( 'home', 'http://wp.org' ); + update_option( 'siteurl', 'http://wp.org' ); + + // Use the correct restore keys. + $_GET = array(); + $_GET['srk'] = get_transient( 'siteurl_restore_key' ); + + // Test that success restore will perform redirection. + $wp_restore_siteurl = $this->getMockBuilder( 'WP_Restore_Siteurl' ) + ->setMethods( array( 'success_redirect' ) ) + ->getMock(); + $wp_restore_siteurl->expects( $this->once() ) + ->method( 'success_redirect' ); + + $wp_restore_siteurl->perform_siteurl_restore(); + + $this->assertFalse( get_transient( 'old_home' ) ); + $this->assertFalse( get_transient( 'old_siteurl' ) ); + $this->assertFalse( get_transient( 'siteurl_restore_key' ) ); + + $this->assertEquals( '1', get_transient( 'siteurl_restore_success' ) ); + } + + public function test_restore_siteurl_success_notice() { + update_option( 'home', 'http://wp.org' ); + update_option( 'siteurl', 'http://wp.org' ); + + // Use the correct restore keys. + $_GET = array(); + $_GET['srk'] = get_transient( 'siteurl_restore_key' ); + + // Perform the siteurl restore. + $wp_restore_siteurl = $this->getMockBuilder( 'WP_Restore_Siteurl' ) + ->setMethods( array( 'success_redirect' ) ) + ->getMock(); + $wp_restore_siteurl->perform_siteurl_restore(); + + // Simulate click to success url. + $_GET = array(); + $_GET['srsuccess'] = '1'; + $wp_restore_siteurl->restore_siteurl_success_notice(); + + $is_success_notice_hooked = has_action( 'admin_notices', [ $wp_restore_siteurl, 'restore_siteurl_success_notice__success'] ); + + $this->assertEquals( 10, $is_success_notice_hooked ); + + $success_transient = get_transient( 'siteurl_restore_success' ); + + $this->assertFalse( $success_transient ); + } +} \ No newline at end of file