Changeset 51815 for trunk/src/wp-admin/includes/class-wp-upgrader.php

Timestamp:

09/15/2021 06:39:09 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Upgrade/Install: Create a temporary backup of plugins and themes before updating.

This aims to make the update process more reliable and ensures that if a plugin or theme update fails, the previous version can be safely restored.

• When updating a plugin or theme, the old version is moved to a temporary backup directory:
  • wp-content/upgrade/temp-backup/plugins/[plugin-slug] for plugins
  • wp-content/upgrade/temp-backup/themes/[theme-slug] for themes.

• If the update fails, then the temporary backup kept in the upgrade/temp-backup directory is restored to its original location.
• If the update succeeds, the temporary backup is deleted.

To further help troubleshoot plugin and theme updates, two new checks were added to the Site Health screen:

• A check to make sure that the temp-backup directory is writable.
• A check that there is enough disk space available to safely perform updates.

To avoid confusion: The temp-backup directory will NOT be used to "roll back" a plugin to a previous version after a completed update. This directory will simply contain a transient backup of the previous version of a plugin or theme being updated, and as soon as the update process finishes, the directory will be empty.

Props aristath, afragen, pbiron, dd32, poena, TimothyBlynJacobs, audrasjb, mikeschroder, a2hosting, hellofromTonya, KZeni, galbaras, richards1052, Boniu91, mai21, francina, SergeyBiryukov.
See #51857.

File:

• trunk/src/wp-admin/includes/class-wp-upgrader.php (modified) (7 diffs)

trunk/src/wp-admin/includes/class-wp-upgrader.php

@@ -134 +134 @@
      * and also add the generic strings to `WP_Upgrader::$strings`.
      *
+     * Additionally, it will schedule a weekly task to clean up the temp-backup directory.
+     *
      * @since 2.8.0
+     * @since 5.9.0 Added the `schedule_temp_backup_cleanup()` task.
      */
     public function init() {
         $this->skin->set_upgrader( $this );
         $this->generic_strings();
+        $this->schedule_temp_backup_cleanup();
+    }
+
+    /**
+     * Schedule cleanup of the temp-backup directory.
+     *
+     * @since 5.9.0
+     */
+    protected function schedule_temp_backup_cleanup() {
+        wp_schedule_event( time(), 'weekly', 'delete_temp_updater_backups' );
+        add_action( 'delete_temp_updater_backups', array( $this, 'delete_all_temp_backups' ) );
     }
 
@@ -167 +181 @@
         $this->strings['maintenance_start'] = __( 'Enabling Maintenance mode…' );
         $this->strings['maintenance_end']   = __( 'Disabling Maintenance mode…' );
+
+        /* translators: %s: temp-backup */
+        $this->strings['temp_backup_mkdir_failed'] = sprintf( __( 'Could not create the %s directory.' ), 'temp-backup' );
+        /* translators: %s: temp-backup */
+        $this->strings['temp_backup_move_failed']    = sprintf( __( 'Could not move old version to the %s directory.' ), 'temp-backup' );
+        $this->strings['temp_backup_restore_failed'] = __( 'Could not restore original version.' );
+
     }
 
@@ -314 +335 @@
         if ( ! empty( $upgrade_files ) ) {
             foreach ( $upgrade_files as $file ) {
+                if ( 'temp-backup' === $file['name'] ) {
+                    continue;
+                }
                 $wp_filesystem->delete( $upgrade_folder . $file['name'], true );
             }
@@ -492 +516 @@
         if ( is_wp_error( $res ) ) {
             return $res;
+        }
+
+        if ( ! empty( $args['hook_extra']['temp_backup'] ) ) {
+            $temp_backup = $this->move_to_temp_backup_dir( $args['hook_extra']['temp_backup'] );
+            if ( is_wp_error( $temp_backup ) ) {
+                return $temp_backup;
+            }
         }
 
@@ -812 +843 @@
         $this->skin->set_result( $result );
         if ( is_wp_error( $result ) ) {
+            if ( ! empty( $options['hook_extra']['temp_backup'] ) ) {
+                $this->restore_temp_backup( $options['hook_extra']['temp_backup'] );
+            }
             $this->skin->error( $result );
 
@@ -823 +857 @@
 
         $this->skin->after();
+
+        // Clean up the backup kept in the temp-backup directory.
+        if ( ! empty( $options['hook_extra']['temp_backup'] ) ) {
+            $this->delete_temp_backup( $options['hook_extra']['temp_backup'] );
+        }
 
         if ( ! $options['is_multi'] ) {
@@ -949 +988 @@
     }
 
+    /**
+     * Moves the plugin/theme being updated into a temp-backup directory.
+     *
+     * @since 5.9.0
+     *
+     * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
+     *
+     * @param array $args Array of data for the temp-backup. Must include a slug, the source, and directory.
+     * @return bool|WP_Error
+     */
+    public function move_to_temp_backup_dir( $args ) {
+        global $wp_filesystem;
+
+        if ( empty( $args['slug'] ) || empty( $args['src'] ) || empty( $args['dir'] ) ) {
+            return false;
+        }
+
+        $dest_dir = $wp_filesystem->wp_content_dir() . 'upgrade/temp-backup/';
+        // Create the temp-backup directory if it doesn't exist.
+        if ( (
+                ! $wp_filesystem->is_dir( $dest_dir )
+                && ! $wp_filesystem->mkdir( $dest_dir )
+            ) || (
+                ! $wp_filesystem->is_dir( $dest_dir . $args['dir'] . '/' )
+                && ! $wp_filesystem->mkdir( $dest_dir . $args['dir'] . '/' )
+            )
+        ) {
+            return new WP_Error( 'fs_temp_backup_mkdir', $this->strings['temp_backup_mkdir_failed'] );
+        }
+
+        $src  = trailingslashit( $args['src'] ) . $args['slug'];
+        $dest = $dest_dir . $args['dir'] . '/' . $args['slug'];
+
+        // Delete the temp-backup directory if it already exists.
+        if ( $wp_filesystem->is_dir( $dest ) ) {
+            $wp_filesystem->delete( $dest, true );
+        }
+
+        // Move to the temp-backup directory.
+        if ( ! $wp_filesystem->move( $src, $dest, true ) ) {
+            return new WP_Error( 'fs_temp_backup_move', $this->strings['temp_backup_move_failed'] );
+        }
+
+        return true;
+    }
+
+    /**
+     * Restores the plugin/theme from the temp-backup directory.
+     *
+     * @since 5.9.0
+     *
+     * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
+     *
+     * @param array $args Array of data for the temp-backup. Must include a slug, the source, and directory.
+     * @return bool|WP_Error
+     */
+    public function restore_temp_backup( $args ) {
+        global $wp_filesystem;
+
+        if ( empty( $args['slug'] ) || empty( $args['src'] ) || empty( $args['dir'] ) ) {
+            return false;
+        }
+
+        $src  = $wp_filesystem->wp_content_dir() . 'upgrade/temp-backup/' . $args['dir'] . '/' . $args['slug'];
+        $dest = trailingslashit( $args['src'] ) . $args['slug'];
+
+        if ( $wp_filesystem->is_dir( $src ) ) {
+            // Cleanup.
+            if ( $wp_filesystem->is_dir( $dest ) && ! $wp_filesystem->delete( $dest, true ) ) {
+                return new WP_Error( 'fs_temp_backup_delete', $this->strings['temp_backup_restore_failed'] );
+            }
+
+            // Move it.
+            if ( ! $wp_filesystem->move( $src, $dest, true ) ) {
+                return new WP_Error( 'fs_temp_backup_delete', $this->strings['temp_backup_restore_failed'] );
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Deletes a temp-backup.
+     *
+     * @since 5.9.0
+     *
+     * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
+     *
+     * @param array $args Array of data for the temp-backup. Must include a slug, the source, and directory.
+     * @return bool
+     */
+    public function delete_temp_backup( $args ) {
+        global $wp_filesystem;
+
+        if ( empty( $args['slug'] ) || empty( $args['dir'] ) ) {
+            return false;
+        }
+
+        return $wp_filesystem->delete(
+            $wp_filesystem->wp_content_dir() . "upgrade/temp-backup/{$args['dir']}/{$args['slug']}",
+            true
+        );
+    }
+
+    /**
+     * Deletes all contents of the temp-backup directory.
+     *
+     * @since 5.9.0
+     *
+     * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
+     */
+    public function delete_all_temp_backups() {
+        /*
+         * Check if there's a lock, or if currently performing an Ajax request,
+         * in which case there's a chance we're doing an update.
+         * Reschedule for an hour from now and exit early.
+         */
+        if ( get_option( 'core_updater.lock' ) || get_option( 'auto_updater.lock' ) || wp_doing_ajax() ) {
+            wp_schedule_single_event( time() + HOUR_IN_SECONDS, 'delete_temp_updater_backups' );
+            return;
+        }
+
+        add_action(
+            'shutdown',
+            /*
+             * This action runs on shutdown to make sure there's no plugin updates currently running.
+             * Using a closure in this case is OK since the action can be removed by removing the parent hook.
+             */
+            function() {
+                global $wp_filesystem;
+
+                if ( ! $wp_filesystem ) {
+                    include_once ABSPATH . '/wp-admin/includes/file.php';
+                    WP_Filesystem();
+                }
+
+                $dirlist = $wp_filesystem->dirlist( $wp_filesystem->wp_content_dir() . 'upgrade/temp-backup/' );
+
+                foreach ( array_keys( $dirlist ) as $dir ) {
+                    if ( '.' === $dir || '..' === $dir ) {
+                        continue;
+                    }
+
+                    $wp_filesystem->delete( $wp_filesystem->wp_content_dir() . 'upgrade/temp-backup/' . $dir, true );
+                }
+            }
+        );
+    }
 }