Changeset 54143

Timestamp:

09/13/2022 04:56:00 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Upgrade/Install: Remove _copy_dir() function as originally intended.

WordPress 3.2 introduced several enhancements to the copy_dir() function:

• No more re-installing Akismet upon upgrade.
• Respect custom WP_CONTENT_DIR for bundled plugins/theme installation.
• Respect custom WP_CONTENT_DIR/WP_LANG_DIR for language files when upgrading.
• Add an exclusion list to copy_dir() as well as WP_Filesystem_Base::wp_lang_dir().
• Standardize WP_Filesystem path method returns.

However, the version of copy_dir() that runs during the upgrade process is the one from the older install, not the newer, which means that these enhancements would only be available after upgrading to WordPress 3.2 first, e.g. in a subsequent upgrade to WordPress 3.3.

In order to make these enhancements immediately available in WordPress 3.2, specifically to take advantage of skip lists and avoid re-installing Akismet if it was previously deleted, a temporary copy of the function was utilized, with the intention to remove it in WordPress 3.3 or a later release.

With further enhancements made to the Upgrade API to support partial and no-content builds, this temporary copy is no longer relevant and can be safely removed.

Follow-up to [17576], [17580], [17581], [18225].

Props afragen, costdev, dd32, peterwilsoncc, SergeyBiryukov.
Fixes #55712. See #17173.

File:

• trunk/src/wp-admin/includes/update-core.php (modified) (3 diffs)

trunk/src/wp-admin/includes/update-core.php

@@ -1189 +1189 @@
 
     // Copy new versions of WP files into place.
-    $result = _copy_dir( $from . $distro, $to, $skip );
+    $result = copy_dir( $from . $distro, $to, $skip );
 
     if ( is_wp_error( $result ) ) {
@@ -1267 +1267 @@
             $result = new WP_Error( 'disk_full', __( 'There is not enough free disk space to complete the update.' ) );
         } else {
-            $result = _copy_dir( $from . $distro, $to, $skip );
+            $result = copy_dir( $from . $distro, $to, $skip );
 
             if ( is_wp_error( $result ) ) {
@@ -1458 +1458 @@
 
     return $wp_version;
-}
-
-/**
- * Copies a directory from one location to another via the WordPress Filesystem Abstraction.
- *
- * Assumes that WP_Filesystem() has already been called and setup.
- *
- * This is a standalone copy of the `copy_dir()` function that is used to
- * upgrade the core files. It is placed here so that the version of this
- * function from the *new* WordPress version will be called.
- *
- * It was initially added for the 3.1 -> 3.2 upgrade.
- *
- * @ignore
- * @since 3.2.0
- * @since 3.7.0 Updated not to use a regular expression for the skip list.
- *
- * @see copy_dir()
- * @link https://core.trac.wordpress.org/ticket/17173
- *
- * @global WP_Filesystem_Base $wp_filesystem
- *
- * @param string   $from      Source directory.
- * @param string   $to        Destination directory.
- * @param string[] $skip_list Array of files/folders to skip copying.
- * @return true|WP_Error True on success, WP_Error on failure.
- */
-function _copy_dir( $from, $to, $skip_list = array() ) {
-    global $wp_filesystem;
-
-    $dirlist = $wp_filesystem->dirlist( $from );
-
-    if ( false === $dirlist ) {
-        return new WP_Error( 'dirlist_failed__copy_dir', __( 'Directory listing failed.' ), basename( $to ) );
-    }
-
-    $from = trailingslashit( $from );
-    $to   = trailingslashit( $to );
-
-    foreach ( (array) $dirlist as $filename => $fileinfo ) {
-        if ( in_array( $filename, $skip_list, true ) ) {
-            continue;
-        }
-
-        if ( 'f' === $fileinfo['type'] ) {
-            if ( ! $wp_filesystem->copy( $from . $filename, $to . $filename, true, FS_CHMOD_FILE ) ) {
-                // If copy failed, chmod file to 0644 and try again.
-                $wp_filesystem->chmod( $to . $filename, FS_CHMOD_FILE );
-
-                if ( ! $wp_filesystem->copy( $from . $filename, $to . $filename, true, FS_CHMOD_FILE ) ) {
-                    return new WP_Error( 'copy_failed__copy_dir', __( 'Could not copy file.' ), $to . $filename );
-                }
-            }
-
-            /*
-             * `wp_opcache_invalidate()` only exists in WordPress 5.5 or later,
-             * so don't run it when upgrading from older versions.
-             */
-            if ( function_exists( 'wp_opcache_invalidate' ) ) {
-                wp_opcache_invalidate( $to . $filename );
-            }
-        } elseif ( 'd' === $fileinfo['type'] ) {
-            if ( ! $wp_filesystem->is_dir( $to . $filename ) ) {
-                if ( ! $wp_filesystem->mkdir( $to . $filename, FS_CHMOD_DIR ) ) {
-                    return new WP_Error( 'mkdir_failed__copy_dir', __( 'Could not create directory.' ), $to . $filename );
-                }
-            }
-
-            /*
-             * Generate the $sub_skip_list for the subdirectory as a sub-set
-             * of the existing $skip_list.
-             */
-            $sub_skip_list = array();
-
-            foreach ( $skip_list as $skip_item ) {
-                if ( 0 === strpos( $skip_item, $filename . '/' ) ) {
-                    $sub_skip_list[] = preg_replace( '!^' . preg_quote( $filename, '!' ) . '/!i', '', $skip_item );
-                }
-            }
-
-            $result = _copy_dir( $from . $filename, $to . $filename, $sub_skip_list );
-
-            if ( is_wp_error( $result ) ) {
-                return $result;
-            }
-        }
-    }
-
-    return true;
 }