Changeset 28418

Timestamp:

05/15/2014 05:01:02 AM (9 years ago)

Author:

wonderboymusic

Message:

Eliminate the use of extract() in WP_Upgrader.

See #22400.

File:

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

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

@@ -191 +191 @@
 
         $args = wp_parse_args($args, $defaults);
-        extract($args);
+        $destination = $args['destination'];
+        $clear_destination = $args['clear_destination'];
 
         @set_time_limit( 300 );
 
-        if ( empty($source) || empty($destination) )
-            return new WP_Error('bad_request', $this->strings['bad_request']);
-
-        $this->skin->feedback('installing_package');
+        if ( empty( $source ) || empty( $destination ) ) {
+            return new WP_Error( 'bad_request', $this->strings['bad_request'] );
+        }
+        $this->skin->feedback( 'installing_package' );
 
         /**
@@ -212 +213 @@
          * @param array         $hook_extra Extra arguments passed to hooked filters.
          */
-        $res = apply_filters( 'upgrader_pre_install', true, $hook_extra );
-        if ( is_wp_error($res) )
+        $res = apply_filters( 'upgrader_pre_install', true, $args['hook_extra'] );
+        if ( is_wp_error( $res ) ) {
             return $res;
+        }
 
         //Retain the Original source and destinations
-        $remote_source = $source;
+        $remote_source = $args['source'];
         $local_destination = $destination;
 
-        $source_files = array_keys( $wp_filesystem->dirlist($remote_source) );
-        $remote_destination = $wp_filesystem->find_folder($local_destination);
+        $source_files = array_keys( $wp_filesystem->dirlist( $remote_source ) );
+        $remote_destination = $wp_filesystem->find_folder( $local_destination );
 
         //Locate which directory to copy to the new folder, This is based on the actual folder holding the files.
-        if ( 1 == count($source_files) && $wp_filesystem->is_dir( trailingslashit($source) . $source_files[0] . '/') ) //Only one folder? Then we want its contents.
-            $source = trailingslashit($source) . trailingslashit($source_files[0]);
-        elseif ( count($source_files) == 0 )
+        if ( 1 == count( $source_files ) && $wp_filesystem->is_dir( trailingslashit( $args['source'] ) . $source_files[0] . '/' ) ) { //Only one folder? Then we want its contents.
+            $source = trailingslashit( $args['source'] ) . trailingslashit( $source_files[0] );
+        } elseif ( count( $source_files ) == 0 ) {
             return new WP_Error( 'incompatible_archive_empty', $this->strings['incompatible_archive'], $this->strings['no_files'] ); // There are no files?
-        else //It's only a single file, the upgrader will use the foldername of this file as the destination folder. foldername is based on zip filename.
-            $source = trailingslashit($source);
+        } else { //It's only a single file, the upgrader will use the foldername of this file as the destination folder. foldername is based on zip filename.
+            $source = trailingslashit( $args['source'] );
+        }
 
         /**
@@ -241 +244 @@
          */
         $source = apply_filters( 'upgrader_source_selection', $source, $remote_source, $this );
-        if ( is_wp_error($source) )
+        if ( is_wp_error( $source ) ) {
             return $source;
+        }
 
         //Has the source location changed? If so, we need a new source_files list.
-        if ( $source !== $remote_source )
-            $source_files = array_keys( $wp_filesystem->dirlist($source) );
-
+        if ( $source !== $remote_source ) {
+            $source_files = array_keys( $wp_filesystem->dirlist( $source ) );
+        }
         // Protection against deleting files in any important base directories.
         // Theme_Upgrader & Plugin_Upgrader also trigger this, as they pass the destination directory (WP_PLUGIN_DIR / wp-content/themes)
         // intending to copy the directory into the directory, whilst they pass the source as the actual files to copy.
         $protected_directories = array( ABSPATH, WP_CONTENT_DIR, WP_PLUGIN_DIR, WP_CONTENT_DIR . '/themes' );
-        if ( is_array( $wp_theme_directories ) )
+        if ( is_array( $wp_theme_directories ) ) {
             $protected_directories = array_merge( $protected_directories, $wp_theme_directories );
+        }
         if ( in_array( $destination, $protected_directories ) ) {
-            $remote_destination = trailingslashit($remote_destination) . trailingslashit(basename($source));
-            $destination = trailingslashit($destination) . trailingslashit(basename($source));
+            $remote_destination = trailingslashit( $remote_destination ) . trailingslashit( basename( $source ) );
+            $destination = trailingslashit( $destination ) . trailingslashit( basename( $source ) );
         }
 
@@ -263 +268 @@
             $this->skin->feedback('remove_old');
             $removed = true;
-            if ( $wp_filesystem->exists($remote_destination) )
-                $removed = $wp_filesystem->delete($remote_destination, true);
+            if ( $wp_filesystem->exists( $remote_destination ) ) {
+                $removed = $wp_filesystem->delete( $remote_destination, true );
+            }
 
             /**
@@ -276 +282 @@
              * @param array  $hook_extra         Extra arguments passed to hooked filters.
              */
-            $removed = apply_filters( 'upgrader_clear_destination', $removed, $local_destination, $remote_destination, $hook_extra );
-
-            if ( is_wp_error($removed) )
+            $removed = apply_filters( 'upgrader_clear_destination', $removed, $local_destination, $remote_destination, $args['hook_extra'] );
+
+            if ( is_wp_error($removed) ) {
                 return $removed;
-            else if ( ! $removed )
+            } else if ( ! $removed ) {
                 return new WP_Error('remove_old_failed', $this->strings['remove_old_failed']);
-        } elseif ( $abort_if_destination_exists && $wp_filesystem->exists($remote_destination) ) {
+            }
+        } elseif ( $args['abort_if_destination_exists'] && $wp_filesystem->exists($remote_destination) ) {
             //If we're not clearing the destination folder and something exists there already, Bail.
             //But first check to see if there are actually any files in the folder.
@@ -293 +300 @@
 
         //Create destination if needed
-        if ( !$wp_filesystem->exists($remote_destination) )
-            if ( !$wp_filesystem->mkdir($remote_destination, FS_CHMOD_DIR) )
+        if ( ! $wp_filesystem->exists( $remote_destination ) ) {
+            if ( ! $wp_filesystem->mkdir( $remote_destination, FS_CHMOD_DIR ) ) {
                 return new WP_Error( 'mkdir_failed_destination', $this->strings['mkdir_failed'], $remote_destination );
-
+            }
+        }
         // Copy new version of item into place.
         $result = copy_dir($source, $remote_destination);
         if ( is_wp_error($result) ) {
-            if ( $clear_working )
-                $wp_filesystem->delete($remote_source, true);
+            if ( $args['clear_working'] ) {
+                $wp_filesystem->delete( $remote_source, true );
+            }
             return $result;
         }
 
         //Clear the Working folder?
-        if ( $clear_working )
-            $wp_filesystem->delete($remote_source, true);
+        if ( $args['clear_working'] ) {
+            $wp_filesystem->delete( $remote_source, true );
+        }
 
         $destination_name = basename( str_replace($local_destination, '', $destination) );
-        if ( '.' == $destination_name )
+        if ( '.' == $destination_name ) {
             $destination_name = '';
+        }
 
         $this->result = compact('local_source', 'source', 'source_name', 'source_files', 'destination', 'destination_name', 'local_destination', 'remote_destination', 'clear_destination', 'delete_source_dir');
@@ -324 +335 @@
          * @param array $result     Installation result data.
          */
-        $res = apply_filters( 'upgrader_post_install', true, $hook_extra, $this->result );
+        $res = apply_filters( 'upgrader_post_install', true, $args['hook_extra'], $this->result );
 
         if ( is_wp_error($res) ) {
@@ -335 +346 @@
     }
 
-    function run($options) {
+    function run( $options ) {
 
         $defaults = array(
@@ -347 +358 @@
         );
 
-        $options = wp_parse_args($options, $defaults);
-        extract($options);
-
-        if ( ! $is_multi ) // call $this->header separately if running multiple times
+        $options = wp_parse_args( $options, $defaults );
+
+        if ( ! $options['is_multi'] ) { // call $this->header separately if running multiple times
             $this->skin->header();
+        }
 
         // Connect to the Filesystem first.
-        $res = $this->fs_connect( array(WP_CONTENT_DIR, $destination) );
+        $res = $this->fs_connect( array( WP_CONTENT_DIR, $options['destination'] ) );
         // Mainly for non-connected filesystem.
         if ( ! $res ) {
-            if ( ! $is_multi )
+            if ( ! $options['is_multi'] ) {
                 $this->skin->footer();
+            }
             return false;
         }
@@ -367 +379 @@
             $this->skin->error($res);
             $this->skin->after();
-            if ( ! $is_multi )
+            if ( ! $options['is_multi'] ) {
                 $this->skin->footer();
+            }
             return $res;
         }
 
         //Download the package (Note, This just returns the filename of the file if the package is a local file)
-        $download = $this->download_package( $package );
+        $download = $this->download_package( $options['package'] );
         if ( is_wp_error($download) ) {
             $this->skin->error($download);
             $this->skin->after();
-            if ( ! $is_multi )
+            if ( ! $options['is_multi'] ) {
                 $this->skin->footer();
+            }
             return $download;
         }
 
-        $delete_package = ($download != $package); // Do not delete a "local" file
+        $delete_package = ( $download != $options['package'] ); // Do not delete a "local" file
 
         //Unzips the file into a temporary directory
@@ -389 +403 @@
             $this->skin->error($working_dir);
             $this->skin->after();
-            if ( ! $is_multi )
+            if ( ! $options['is_multi'] ) {
                 $this->skin->footer();
+            }
             return $working_dir;
         }
@@ -397 +412 @@
         $result = $this->install_package( array(
             'source' => $working_dir,
-            'destination' => $destination,
-            'clear_destination' => $clear_destination,
-            'abort_if_destination_exists' => $abort_if_destination_exists,
-            'clear_working' => $clear_working,
-            'hook_extra' => $hook_extra
+            'destination' => $options['destination'],
+            'clear_destination' => $options['clear_destination'],
+            'abort_if_destination_exists' => $options['abort_if_destination_exists'],
+            'clear_working' => $options['clear_working'],
+            'hook_extra' => $options['hook_extra']
         ) );
 
@@ -415 +430 @@
         $this->skin->after();
 
-        if ( ! $is_multi ) {
+        if ( ! $options['is_multi'] ) {
 
             /** This action is documented in wp-admin/includes/class-wp-upgrader.php */
-            do_action( 'upgrader_process_complete', $this, $hook_extra );
+            do_action( 'upgrader_process_complete', $this, $options['hook_extra'] );
             $this->skin->footer();
         }