2009-04-19 15:36:28 -04:00
< ? php
/**
2016-05-10 07:59:27 -04:00
* Upgrade API : WP_Upgrader class
2009-04-19 15:36:28 -04:00
*
2016-05-10 07:59:27 -04:00
* Requires skin classes and WP_Upgrader subclasses for backward compatibility .
2009-04-26 14:17:19 -04:00
*
* @ package WordPress
* @ subpackage Upgrader
* @ since 2.8 . 0
2009-04-19 15:36:28 -04:00
*/
2016-05-10 07:59:27 -04:00
/** WP_Upgrader_Skin class */
require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader-skin.php' ;
/** Plugin_Upgrader_Skin class */
require_once ABSPATH . 'wp-admin/includes/class-plugin-upgrader-skin.php' ;
/** Theme_Upgrader_Skin class */
require_once ABSPATH . 'wp-admin/includes/class-theme-upgrader-skin.php' ;
/** Bulk_Upgrader_Skin class */
require_once ABSPATH . 'wp-admin/includes/class-bulk-upgrader-skin.php' ;
/** Bulk_Plugin_Upgrader_Skin class */
require_once ABSPATH . 'wp-admin/includes/class-bulk-plugin-upgrader-skin.php' ;
/** Bulk_Theme_Upgrader_Skin class */
require_once ABSPATH . 'wp-admin/includes/class-bulk-theme-upgrader-skin.php' ;
/** Plugin_Installer_Skin class */
require_once ABSPATH . 'wp-admin/includes/class-plugin-installer-skin.php' ;
/** Theme_Installer_Skin class */
require_once ABSPATH . 'wp-admin/includes/class-theme-installer-skin.php' ;
/** Language_Pack_Upgrader_Skin class */
require_once ABSPATH . 'wp-admin/includes/class-language-pack-upgrader-skin.php' ;
/** Automatic_Upgrader_Skin class */
require_once ABSPATH . 'wp-admin/includes/class-automatic-upgrader-skin.php' ;
2013-09-04 02:35:10 -04:00
2009-04-26 14:17:19 -04:00
/**
2015-09-24 10:54:25 -04:00
* Core class used for upgrading / installing a local set of files via
* the Filesystem Abstraction classes from a Zip file .
2009-04-26 14:17:19 -04:00
*
* @ since 2.8 . 0
*/
2009-04-19 15:36:28 -04:00
class WP_Upgrader {
2014-12-06 19:26:22 -05:00
/**
* The error / notification strings used to update the user on the progress .
*
* @ since 2.8 . 0
2015-08-21 00:05:25 -04:00
* @ access public
2016-05-18 20:36:27 -04:00
* @ var array $strings
2014-12-06 19:26:22 -05:00
*/
2014-05-18 21:29:15 -04:00
public $strings = array ();
2014-12-06 19:26:22 -05:00
/**
* The upgrader skin being used .
*
* @ since 2.8 . 0
2015-08-21 00:05:25 -04:00
* @ access public
2014-12-06 19:26:22 -05:00
* @ var WP_Upgrader_Skin $skin
*/
2014-05-18 21:29:15 -04:00
public $skin = null ;
2014-12-06 19:26:22 -05:00
/**
* The result of the installation .
*
2016-05-02 00:00:28 -04:00
* This is set by WP_Upgrader :: install_package (), only when the package is installed
* successfully . It will then be an array , unless a WP_Error is returned by the
* { @ see 'upgrader_post_install' } filter . In that case , the WP_Error will be assigned to
2014-12-06 19:26:22 -05:00
* it .
*
* @ since 2.8 . 0
2015-08-21 00:05:25 -04:00
* @ access public
*
2014-12-06 19:26:22 -05:00
* @ var WP_Error | array $result {
* @ type string $source The full path to the source the files were installed from .
* @ type string $source_files List of all the files in the source directory .
* @ type string $destination The full path to the install destination folder .
* @ type string $destination_name The name of the destination folder , or empty if `$destination`
* and `$local_destination` are the same .
* @ type string $local_destination The full local path to the destination folder . This is usually
* the same as `$destination` .
* @ type string $remote_destination The full remote path to the destination folder
* ( i . e . , from `$wp_filesystem` ) .
* @ type bool $clear_destination Whether the destination folder was cleared .
* }
*/
2014-05-18 21:29:15 -04:00
public $result = array ();
2014-12-06 19:26:22 -05:00
/**
* The total number of updates being performed .
*
* Set by the bulk update methods .
*
* @ since 3.0 . 0
2015-08-21 00:05:25 -04:00
* @ access public
2014-12-06 19:26:22 -05:00
* @ var int $update_count
*/
2014-11-01 19:07:23 -04:00
public $update_count = 0 ;
2014-12-06 19:26:22 -05:00
/**
* The current update if multiple updates are being performed .
*
* Used by the bulk update methods , and incremented for each update .
*
* @ since 3.0 . 0
2015-08-21 00:05:25 -04:00
* @ access public
2014-12-06 19:26:22 -05:00
* @ var int
*/
2014-11-01 19:07:23 -04:00
public $update_current = 0 ;
2009-04-20 14:18:39 -04:00
2014-12-06 19:26:22 -05:00
/**
* Construct the upgrader with a skin .
*
* @ since 2.8 . 0
2015-08-21 00:05:25 -04:00
* @ access public
2014-12-06 19:26:22 -05:00
*
2016-05-02 00:00:28 -04:00
* @ param WP_Upgrader_Skin $skin The upgrader skin to use . Default is a WP_Upgrader_Skin .
2014-12-06 19:26:22 -05:00
* instance .
*/
public function __construct ( $skin = null ) {
2009-04-19 15:36:28 -04:00
if ( null == $skin )
$this -> skin = new WP_Upgrader_Skin ();
else
$this -> skin = $skin ;
2009-04-26 14:17:19 -04:00
}
2009-05-24 19:47:49 -04:00
2014-12-06 19:26:22 -05:00
/**
* Initialize the upgrader .
*
* This will set the relationship between the skin being used and this upgrader ,
* and also add the generic strings to `WP_Upgrader::$strings` .
*
* @ since 2.8 . 0
2015-08-21 00:05:25 -04:00
* @ access public
2014-12-06 19:26:22 -05:00
*/
2014-05-18 21:29:15 -04:00
public function init () {
2009-04-19 15:36:28 -04:00
$this -> skin -> set_upgrader ( $this );
2009-04-26 14:17:19 -04:00
$this -> generic_strings ();
2009-04-19 15:36:28 -04:00
}
2009-04-20 14:18:39 -04:00
2014-12-06 19:26:22 -05:00
/**
* Add the generic strings to WP_Upgrader :: $strings .
*
* @ since 2.8 . 0
2015-08-21 00:05:25 -04:00
* @ access public
2014-12-06 19:26:22 -05:00
*/
2014-05-18 21:29:15 -04:00
public function generic_strings () {
2009-04-19 15:36:28 -04:00
$this -> strings [ 'bad_request' ] = __ ( 'Invalid Data provided.' );
$this -> strings [ 'fs_unavailable' ] = __ ( 'Could not access filesystem.' );
2010-01-21 16:37:43 -05:00
$this -> strings [ 'fs_error' ] = __ ( 'Filesystem error.' );
2009-04-19 15:36:28 -04:00
$this -> strings [ 'fs_no_root_dir' ] = __ ( 'Unable to locate WordPress Root directory.' );
$this -> strings [ 'fs_no_content_dir' ] = __ ( 'Unable to locate WordPress Content directory (wp-content).' );
$this -> strings [ 'fs_no_plugins_dir' ] = __ ( 'Unable to locate WordPress Plugin directory.' );
$this -> strings [ 'fs_no_themes_dir' ] = __ ( 'Unable to locate WordPress Theme directory.' );
2010-04-21 06:58:06 -04:00
/* translators: %s: directory name */
2009-04-19 15:36:28 -04:00
$this -> strings [ 'fs_no_folder' ] = __ ( 'Unable to locate needed folder (%s).' );
$this -> strings [ 'download_failed' ] = __ ( 'Download failed.' );
2009-12-24 04:46:57 -05:00
$this -> strings [ 'installing_package' ] = __ ( 'Installing the latest version…' );
2013-05-22 12:57:20 -04:00
$this -> strings [ 'no_files' ] = __ ( 'The package contains no files.' );
2009-04-19 15:36:28 -04:00
$this -> strings [ 'folder_exists' ] = __ ( 'Destination folder already exists.' );
$this -> strings [ 'mkdir_failed' ] = __ ( 'Could not create directory.' );
2011-11-10 14:41:44 -05:00
$this -> strings [ 'incompatible_archive' ] = __ ( 'The package could not be installed.' );
2015-06-18 23:49:25 -04:00
$this -> strings [ 'files_not_writable' ] = __ ( 'The update cannot be installed because we will be unable to copy some files. This is usually due to inconsistent file permissions.' );
2009-04-20 14:18:39 -04:00
2009-12-24 04:46:57 -05:00
$this -> strings [ 'maintenance_start' ] = __ ( 'Enabling Maintenance mode…' );
$this -> strings [ 'maintenance_end' ] = __ ( 'Disabling Maintenance mode…' );
2009-04-19 15:36:28 -04:00
}
2009-04-20 14:18:39 -04:00
2014-12-06 19:26:22 -05:00
/**
* Connect to the filesystem .
*
* @ since 2.8 . 0
2015-08-21 00:05:25 -04:00
* @ access public
2014-12-06 19:26:22 -05:00
*
2015-05-28 17:41:30 -04:00
* @ global WP_Filesystem_Base $wp_filesystem Subclass
*
2014-12-06 19:26:22 -05:00
* @ param array $directories Optional . A list of directories . If any of these do
2016-05-02 00:00:28 -04:00
* not exist , a WP_Error object will be returned .
2014-12-06 19:26:22 -05:00
* Default empty array .
* @ param bool $allow_relaxed_file_ownership Whether to allow relaxed file ownership .
* Default false .
2016-05-02 00:00:28 -04:00
* @ return bool | WP_Error True if able to connect , false or a WP_Error otherwise .
2014-12-06 19:26:22 -05:00
*/
2014-11-19 00:40:23 -05:00
public function fs_connect ( $directories = array (), $allow_relaxed_file_ownership = false ) {
2009-04-19 15:36:28 -04:00
global $wp_filesystem ;
2009-04-20 14:18:39 -04:00
2014-11-19 00:40:23 -05:00
if ( false === ( $credentials = $this -> skin -> request_filesystem_credentials ( false , $directories [ 0 ], $allow_relaxed_file_ownership ) ) ) {
2009-04-19 15:36:28 -04:00
return false ;
2014-11-19 00:40:23 -05:00
}
2009-04-20 14:18:39 -04:00
2014-11-19 00:40:23 -05:00
if ( ! WP_Filesystem ( $credentials , $directories [ 0 ], $allow_relaxed_file_ownership ) ) {
2009-04-19 15:36:28 -04:00
$error = true ;
if ( is_object ( $wp_filesystem ) && $wp_filesystem -> errors -> get_error_code () )
$error = $wp_filesystem -> errors ;
2014-11-19 00:40:23 -05:00
// Failed to connect, Error and request again
$this -> skin -> request_filesystem_credentials ( $error , $directories [ 0 ], $allow_relaxed_file_ownership );
2009-04-19 15:36:28 -04:00
return false ;
}
if ( ! is_object ( $wp_filesystem ) )
return new WP_Error ( 'fs_unavailable' , $this -> strings [ 'fs_unavailable' ] );
2009-04-20 14:18:39 -04:00
2009-04-19 15:36:28 -04:00
if ( is_wp_error ( $wp_filesystem -> errors ) && $wp_filesystem -> errors -> get_error_code () )
return new WP_Error ( 'fs_error' , $this -> strings [ 'fs_error' ], $wp_filesystem -> errors );
foreach ( ( array ) $directories as $dir ) {
2009-08-20 21:36:01 -04:00
switch ( $dir ) {
case ABSPATH :
if ( ! $wp_filesystem -> abspath () )
return new WP_Error ( 'fs_no_root_dir' , $this -> strings [ 'fs_no_root_dir' ]);
break ;
case WP_CONTENT_DIR :
if ( ! $wp_filesystem -> wp_content_dir () )
return new WP_Error ( 'fs_no_content_dir' , $this -> strings [ 'fs_no_content_dir' ]);
break ;
case WP_PLUGIN_DIR :
if ( ! $wp_filesystem -> wp_plugins_dir () )
return new WP_Error ( 'fs_no_plugins_dir' , $this -> strings [ 'fs_no_plugins_dir' ]);
break ;
2013-08-22 00:50:09 -04:00
case get_theme_root () :
if ( ! $wp_filesystem -> wp_themes_dir () )
2009-08-20 21:36:01 -04:00
return new WP_Error ( 'fs_no_themes_dir' , $this -> strings [ 'fs_no_themes_dir' ]);
break ;
default :
if ( ! $wp_filesystem -> find_folder ( $dir ) )
2013-06-21 01:54:40 -04:00
return new WP_Error ( 'fs_no_folder' , sprintf ( $this -> strings [ 'fs_no_folder' ], esc_html ( basename ( $dir ) ) ) );
2009-08-20 21:36:01 -04:00
break ;
}
2009-04-19 15:36:28 -04:00
}
return true ;
} //end fs_connect();
2014-12-06 19:26:22 -05:00
/**
* Download a package .
*
* @ since 2.8 . 0
2015-08-21 00:05:25 -04:00
* @ access public
2014-12-06 19:26:22 -05:00
*
* @ param string $package The URI of the package . If this is the full path to an
* existing local file , it will be returned untouched .
2016-05-02 00:00:28 -04:00
* @ return string | WP_Error The full path to the downloaded package file , or a WP_Error object .
2014-12-06 19:26:22 -05:00
*/
public function download_package ( $package ) {
2009-04-19 15:36:28 -04:00
2013-09-13 08:53:08 -04:00
/**
2016-05-22 14:01:30 -04:00
* Filters whether to return the package .
2013-09-13 08:53:08 -04:00
*
* @ since 3.7 . 0
2015-08-21 00:05:25 -04:00
* @ access public
2013-09-13 08:53:08 -04:00
*
2014-03-23 23:00:15 -04:00
* @ param bool $reply Whether to bail without returning the package .
* Default false .
* @ param string $package The package file name .
* @ param WP_Upgrader $this The WP_Upgrader instance .
2013-09-13 08:53:08 -04:00
*/
$reply = apply_filters ( 'upgrader_pre_download' , false , $package , $this );
if ( false !== $reply )
return $reply ;
2009-04-19 15:36:28 -04:00
if ( ! preg_match ( '!^(http|https|ftp)://!i' , $package ) && file_exists ( $package ) ) //Local file or remote?
return $package ; //must be a local file..
2009-04-20 14:18:39 -04:00
2009-04-19 15:36:28 -04:00
if ( empty ( $package ) )
return new WP_Error ( 'no_package' , $this -> strings [ 'no_package' ]);
$this -> skin -> feedback ( 'downloading_package' , $package );
$download_file = download_url ( $package );
2009-04-20 14:18:39 -04:00
2009-04-19 15:36:28 -04:00
if ( is_wp_error ( $download_file ) )
return new WP_Error ( 'download_failed' , $this -> strings [ 'download_failed' ], $download_file -> get_error_message ());
2009-04-20 14:18:39 -04:00
2009-04-19 15:36:28 -04:00
return $download_file ;
}
2009-04-20 14:18:39 -04:00
2014-12-06 19:26:22 -05:00
/**
* Unpack a compressed package file .
*
* @ since 2.8 . 0
2015-08-21 00:05:25 -04:00
* @ access public
2014-12-06 19:26:22 -05:00
*
2015-05-28 17:41:30 -04:00
* @ global WP_Filesystem_Base $wp_filesystem Subclass
*
2014-12-06 19:26:22 -05:00
* @ param string $package Full path to the package file .
* @ param bool $delete_package Optional . Whether to delete the package file after attempting
* to unpack it . Default true .
2016-05-02 00:00:28 -04:00
* @ return string | WP_Error The path to the unpacked contents , or a WP_Error on failure .
2014-12-06 19:26:22 -05:00
*/
public function unpack_package ( $package , $delete_package = true ) {
2009-04-19 15:36:28 -04:00
global $wp_filesystem ;
2009-04-20 14:18:39 -04:00
2009-04-19 15:36:28 -04:00
$this -> skin -> feedback ( 'unpack_package' );
$upgrade_folder = $wp_filesystem -> wp_content_dir () . 'upgrade/' ;
//Clean up contents of upgrade directory beforehand.
$upgrade_files = $wp_filesystem -> dirlist ( $upgrade_folder );
if ( ! empty ( $upgrade_files ) ) {
foreach ( $upgrade_files as $file )
$wp_filesystem -> delete ( $upgrade_folder . $file [ 'name' ], true );
}
2015-03-23 00:40:27 -04:00
// We need a working directory - Strip off any .tmp or .zip suffixes
$working_dir = $upgrade_folder . basename ( basename ( $package , '.tmp' ), '.zip' );
2009-04-19 15:36:28 -04:00
// Clean up working directory
if ( $wp_filesystem -> is_dir ( $working_dir ) )
$wp_filesystem -> delete ( $working_dir , true );
// Unzip package to working directory
2013-10-14 17:03:09 -04:00
$result = unzip_file ( $package , $working_dir );
2009-04-19 15:36:28 -04:00
// Once extracted, delete the package if required.
if ( $delete_package )
unlink ( $package );
if ( is_wp_error ( $result ) ) {
$wp_filesystem -> delete ( $working_dir , true );
2011-08-28 11:02:48 -04:00
if ( 'incompatible_archive' == $result -> get_error_code () ) {
return new WP_Error ( 'incompatible_archive' , $this -> strings [ 'incompatible_archive' ], $result -> get_error_data () );
}
2009-04-19 15:36:28 -04:00
return $result ;
}
2009-04-20 14:18:39 -04:00
2009-04-19 15:36:28 -04:00
return $working_dir ;
}
2009-04-20 14:18:39 -04:00
2015-06-18 23:49:25 -04:00
/**
* Clears the directory where this item is going to be installed into .
*
* @ since 4.3 . 0
2015-08-21 00:05:25 -04:00
* @ access public
2015-06-18 23:49:25 -04:00
*
* @ global WP_Filesystem_Base $wp_filesystem Subclass
*
* @ param string $remote_destination The location on the remote filesystem to be cleared
2015-07-13 15:46:25 -04:00
* @ return bool | WP_Error True upon success , WP_Error on failure .
2015-06-18 23:49:25 -04:00
*/
2015-06-19 17:53:25 -04:00
public function clear_destination ( $remote_destination ) {
2015-06-18 23:49:25 -04:00
global $wp_filesystem ;
if ( ! $wp_filesystem -> exists ( $remote_destination ) ) {
return true ;
}
2015-07-13 15:46:25 -04:00
// Check all files are writable before attempting to clear the destination.
2015-06-18 23:49:25 -04:00
$unwritable_files = array ();
$_files = $wp_filesystem -> dirlist ( $remote_destination , true , true );
2015-07-13 15:46:25 -04:00
// Flatten the resulting array, iterate using each as we append to the array during iteration.
2015-06-18 23:49:25 -04:00
while ( $f = each ( $_files ) ) {
$file = $f [ 'value' ];
$name = $f [ 'key' ];
if ( ! isset ( $file [ 'files' ] ) ) {
continue ;
}
foreach ( $file [ 'files' ] as $filename => $details ) {
$_files [ $name . '/' . $filename ] = $details ;
}
}
2015-07-13 15:46:25 -04:00
// Check writability.
2015-06-18 23:49:25 -04:00
foreach ( $_files as $filename => $file_details ) {
if ( ! $wp_filesystem -> is_writable ( $remote_destination . $filename ) ) {
2015-07-13 15:46:25 -04:00
// Attempt to alter permissions to allow writes and try again.
2015-06-18 23:49:25 -04:00
$wp_filesystem -> chmod ( $remote_destination . $filename , ( 'd' == $file_details [ 'type' ] ? FS_CHMOD_DIR : FS_CHMOD_FILE ) );
if ( ! $wp_filesystem -> is_writable ( $remote_destination . $filename ) ) {
$unwritable_files [] = $filename ;
}
}
}
if ( ! empty ( $unwritable_files ) ) {
return new WP_Error ( 'files_not_writable' , $this -> strings [ 'files_not_writable' ], implode ( ', ' , $unwritable_files ) );
}
if ( ! $wp_filesystem -> delete ( $remote_destination , true ) ) {
return new WP_Error ( 'remove_old_failed' , $this -> strings [ 'remove_old_failed' ] );
}
return true ;
}
2014-12-06 19:26:22 -05:00
/**
* Install a package .
*
* Copies the contents of a package form a source directory , and installs them in
* a destination directory . Optionally removes the source . It can also optionally
* clear out the destination folder if it already exists .
*
* @ since 2.8 . 0
2015-08-21 00:05:25 -04:00
* @ access public
2014-12-06 19:26:22 -05:00
*
2015-05-28 17:41:30 -04:00
* @ global WP_Filesystem_Base $wp_filesystem Subclass
* @ global array $wp_theme_directories
*
2014-12-06 19:26:22 -05:00
* @ param array | string $args {
* Optional . Array or string of arguments for installing a package . Default empty array .
*
* @ type string $source Required path to the package source . Default empty .
* @ type string $destination Required path to a folder to install the package in .
* Default empty .
* @ type bool $clear_destination Whether to delete any files already in the destination
* folder . Default false .
* @ type bool $clear_working Whether to delete the files form the working directory
* after copying to the destination . Default false .
* @ type bool $abort_if_destination_exists Whether to abort the installation if
* the destination folder already exists . Default true .
* @ type array $hook_extra Extra arguments to pass to the filter hooks called by
2016-05-02 00:00:28 -04:00
* WP_Upgrader :: install_package () . Default empty array .
2014-12-06 19:26:22 -05:00
* }
*
2016-05-02 00:00:28 -04:00
* @ return array | WP_Error The result ( also stored in `WP_Upgrader::$result` ), or a WP_Error on failure .
2014-12-06 19:26:22 -05:00
*/
2014-05-18 21:29:15 -04:00
public function install_package ( $args = array () ) {
2013-08-22 00:50:09 -04:00
global $wp_filesystem , $wp_theme_directories ;
2013-09-05 21:33:09 -04:00
$defaults = array (
'source' => '' , // Please always pass this
'destination' => '' , // and this
'clear_destination' => false ,
'clear_working' => false ,
'abort_if_destination_exists' => true ,
'hook_extra' => array ()
);
2009-04-19 15:36:28 -04:00
$args = wp_parse_args ( $args , $defaults );
2014-07-17 05:14:16 -04:00
// These were previously extract()'d.
2014-05-17 11:40:15 -04:00
$source = $args [ 'source' ];
2014-05-15 01:02:14 -04:00
$destination = $args [ 'destination' ];
$clear_destination = $args [ 'clear_destination' ];
2009-04-19 15:36:28 -04:00
@ set_time_limit ( 300 );
2014-05-15 01:02:14 -04:00
if ( empty ( $source ) || empty ( $destination ) ) {
return new WP_Error ( 'bad_request' , $this -> strings [ 'bad_request' ] );
}
$this -> skin -> feedback ( 'installing_package' );
2009-04-19 15:36:28 -04:00
2014-03-23 23:00:15 -04:00
/**
2016-05-22 14:01:30 -04:00
* Filters the install response before the installation has started .
2014-03-23 23:00:15 -04:00
*
* Returning a truthy value , or one that could be evaluated as a WP_Error
* will effectively short - circuit the installation , returning that value
* instead .
*
* @ since 2.8 . 0
*
* @ param bool | WP_Error $response Response .
* @ param array $hook_extra Extra arguments passed to hooked filters .
*/
2014-05-15 01:02:14 -04:00
$res = apply_filters ( 'upgrader_pre_install' , true , $args [ 'hook_extra' ] );
2015-08-21 00:13:24 -04:00
2014-05-15 01:02:14 -04:00
if ( is_wp_error ( $res ) ) {
2009-04-19 15:36:28 -04:00
return $res ;
2014-05-15 01:02:14 -04:00
}
2009-04-19 15:36:28 -04:00
//Retain the Original source and destinations
2014-05-15 01:02:14 -04:00
$remote_source = $args [ 'source' ];
2009-04-19 15:36:28 -04:00
$local_destination = $destination ;
2009-04-20 14:18:39 -04:00
2014-05-15 01:02:14 -04:00
$source_files = array_keys ( $wp_filesystem -> dirlist ( $remote_source ) );
$remote_destination = $wp_filesystem -> find_folder ( $local_destination );
2009-04-19 15:36:28 -04:00
//Locate which directory to copy to the new folder, This is based on the actual folder holding the files.
2014-05-15 01:02:14 -04:00
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 ) {
2013-10-11 12:06:11 -04:00
return new WP_Error ( 'incompatible_archive_empty' , $this -> strings [ 'incompatible_archive' ], $this -> strings [ 'no_files' ] ); // There are no files?
2015-09-30 00:13:48 -04:00
} else { // It's only a single file, the upgrader will use the folder name of this file as the destination folder. Folder name is based on zip filename.
2014-05-15 01:02:14 -04:00
$source = trailingslashit ( $args [ 'source' ] );
}
2009-04-20 14:18:39 -04:00
2014-03-23 23:00:15 -04:00
/**
2016-05-22 14:01:30 -04:00
* Filters the source file location for the upgrade package .
2014-03-23 23:00:15 -04:00
*
* @ since 2.8 . 0
2015-11-15 21:47:25 -05:00
* @ since 4.4 . 0 The $hook_extra parameter became available .
2014-03-23 23:00:15 -04:00
*
* @ param string $source File source location .
2015-11-08 22:38:26 -05:00
* @ param string $remote_source Remote file source location .
2014-03-23 23:00:15 -04:00
* @ param WP_Upgrader $this WP_Upgrader instance .
2015-11-15 21:47:25 -05:00
* @ param array $hook_extra Extra arguments passed to hooked filters .
2014-03-23 23:00:15 -04:00
*/
2015-11-15 21:47:25 -05:00
$source = apply_filters ( 'upgrader_source_selection' , $source , $remote_source , $this , $args [ 'hook_extra' ] );
2015-08-21 00:13:24 -04:00
2014-05-15 01:02:14 -04:00
if ( is_wp_error ( $source ) ) {
2009-04-19 15:36:28 -04:00
return $source ;
2014-05-15 01:02:14 -04:00
}
2009-04-20 14:18:39 -04:00
2014-07-17 05:14:16 -04:00
// Has the source location changed? If so, we need a new source_files list.
2014-05-15 01:02:14 -04:00
if ( $source !== $remote_source ) {
$source_files = array_keys ( $wp_filesystem -> dirlist ( $source ) );
}
2015-08-21 00:13:24 -04:00
2014-07-17 05:14:16 -04:00
/*
* 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 .
*/
2013-08-30 03:35:09 -04:00
$protected_directories = array ( ABSPATH , WP_CONTENT_DIR , WP_PLUGIN_DIR , WP_CONTENT_DIR . '/themes' );
2014-07-17 05:14:16 -04:00
2014-05-15 01:02:14 -04:00
if ( is_array ( $wp_theme_directories ) ) {
2013-08-30 03:35:09 -04:00
$protected_directories = array_merge ( $protected_directories , $wp_theme_directories );
2014-05-15 01:02:14 -04:00
}
2015-08-21 00:13:24 -04:00
2013-08-30 03:35:09 -04:00
if ( in_array ( $destination , $protected_directories ) ) {
2014-05-15 01:02:14 -04:00
$remote_destination = trailingslashit ( $remote_destination ) . trailingslashit ( basename ( $source ) );
$destination = trailingslashit ( $destination ) . trailingslashit ( basename ( $source ) );
2009-04-19 15:36:28 -04:00
}
2011-04-03 07:54:07 -04:00
if ( $clear_destination ) {
2015-08-21 00:13:24 -04:00
// We're going to clear the destination if there's something there.
2011-04-03 07:54:07 -04:00
$this -> skin -> feedback ( 'remove_old' );
2015-06-18 23:49:25 -04:00
$removed = $this -> clear_destination ( $remote_destination );
2014-03-23 23:00:15 -04:00
/**
2016-05-22 14:01:30 -04:00
* Filters whether the upgrader cleared the destination .
2014-03-23 23:00:15 -04:00
*
* @ since 2.8 . 0
*
2015-06-18 23:49:25 -04:00
* @ param mixed $removed Whether the destination was cleared . true on success , WP_Error on failure
2014-03-23 23:00:15 -04:00
* @ param string $local_destination The local package destination .
* @ param string $remote_destination The remote package destination .
* @ param array $hook_extra Extra arguments passed to hooked filters .
*/
2014-05-15 01:02:14 -04:00
$removed = apply_filters ( 'upgrader_clear_destination' , $removed , $local_destination , $remote_destination , $args [ 'hook_extra' ] );
2011-04-03 07:54:07 -04:00
2015-06-18 23:49:25 -04:00
if ( is_wp_error ( $removed ) ) {
2011-04-03 07:54:07 -04:00
return $removed ;
2014-05-15 01:02:14 -04:00
}
} elseif ( $args [ 'abort_if_destination_exists' ] && $wp_filesystem -> exists ( $remote_destination ) ) {
2011-09-03 10:18:10 -04:00
//If we're not clearing the destination folder and something exists there already, Bail.
2011-04-03 07:54:07 -04:00
//But first check to see if there are actually any files in the folder.
$_files = $wp_filesystem -> dirlist ( $remote_destination );
if ( ! empty ( $_files ) ) {
$wp_filesystem -> delete ( $remote_source , true ); //Clear out the source files.
return new WP_Error ( 'folder_exists' , $this -> strings [ 'folder_exists' ], $remote_destination );
2009-09-13 19:00:45 -04:00
}
2009-04-19 15:36:28 -04:00
}
2009-04-20 14:18:39 -04:00
2009-04-19 15:36:28 -04:00
//Create destination if needed
2014-05-15 01:02:14 -04:00
if ( ! $wp_filesystem -> exists ( $remote_destination ) ) {
if ( ! $wp_filesystem -> mkdir ( $remote_destination , FS_CHMOD_DIR ) ) {
2013-10-11 12:06:11 -04:00
return new WP_Error ( 'mkdir_failed_destination' , $this -> strings [ 'mkdir_failed' ], $remote_destination );
2014-05-15 01:02:14 -04:00
}
}
2009-04-19 15:36:28 -04:00
// Copy new version of item into place.
$result = copy_dir ( $source , $remote_destination );
if ( is_wp_error ( $result ) ) {
2014-05-15 01:02:14 -04:00
if ( $args [ 'clear_working' ] ) {
$wp_filesystem -> delete ( $remote_source , true );
}
2009-04-19 15:36:28 -04:00
return $result ;
}
2009-04-20 14:18:39 -04:00
//Clear the Working folder?
2014-05-15 01:02:14 -04:00
if ( $args [ 'clear_working' ] ) {
$wp_filesystem -> delete ( $remote_source , true );
}
2009-04-20 14:18:39 -04:00
2009-04-19 15:36:28 -04:00
$destination_name = basename ( str_replace ( $local_destination , '' , $destination ) );
2014-05-15 01:02:14 -04:00
if ( '.' == $destination_name ) {
2009-04-19 15:36:28 -04:00
$destination_name = '' ;
2014-05-15 01:02:14 -04:00
}
2009-04-19 15:36:28 -04:00
2015-02-03 01:18:24 -05:00
$this -> result = compact ( 'source' , 'source_files' , 'destination' , 'destination_name' , 'local_destination' , 'remote_destination' , 'clear_destination' );
2009-04-19 15:36:28 -04:00
2014-03-23 23:00:15 -04:00
/**
2016-05-22 14:01:30 -04:00
* Filters the install response after the installation has finished .
2014-03-23 23:00:15 -04:00
*
* @ since 2.8 . 0
*
* @ param bool $response Install response .
* @ param array $hook_extra Extra arguments passed to hooked filters .
* @ param array $result Installation result data .
*/
2014-05-15 01:02:14 -04:00
$res = apply_filters ( 'upgrader_post_install' , true , $args [ 'hook_extra' ], $this -> result );
2014-03-23 23:00:15 -04:00
2009-04-19 15:36:28 -04:00
if ( is_wp_error ( $res ) ) {
$this -> result = $res ;
return $res ;
}
//Bombard the calling function will all the info which we've just used.
return $this -> result ;
}
2009-04-20 14:18:39 -04:00
2014-12-06 19:26:22 -05:00
/**
* Run an upgrade / install .
*
* Attempts to download the package ( if it is not a local file ), unpack it , and
* install it in the destination folder .
*
* @ since 2.8 . 0
2015-08-21 00:05:25 -04:00
* @ access public
2014-12-06 19:26:22 -05:00
*
* @ param array $options {
* Array or string of arguments for upgrading / installing a package .
*
* @ type string $package The full path or URI of the package to install .
* Default empty .
* @ type string $destination The full path to the destination folder .
* Default empty .
* @ type bool $clear_destination Whether to delete any files already in the
* destination folder . Default false .
* @ type bool $clear_working Whether to delete the files form the working
* directory after copying to the destination .
* Default false .
* @ type bool $abort_if_destination_exists Whether to abort the installation if the destination
* folder already exists . When true , `$clear_destination`
* should be false . Default true .
* @ type bool $is_multi Whether this run is one of multiple upgrade / install
* actions being performed in bulk . When true , the skin
2016-05-02 00:00:28 -04:00
* WP_Upgrader :: header () and WP_Upgrader :: footer ()
2014-12-06 19:26:22 -05:00
* aren ' t called . Default false .
* @ type array $hook_extra Extra arguments to pass to the filter hooks called by
2016-05-02 00:00:28 -04:00
* WP_Upgrader :: run () .
2014-12-06 19:26:22 -05:00
* }
* @ return array | false | WP_error The result from self :: install_package () on success , otherwise a WP_Error ,
* or false if unable to connect to the filesystem .
*/
2014-05-18 21:29:15 -04:00
public function run ( $options ) {
2009-04-19 15:36:28 -04:00
2013-09-05 21:33:09 -04:00
$defaults = array (
'package' => '' , // Please always pass this.
'destination' => '' , // And this
'clear_destination' => false ,
'abort_if_destination_exists' => true , // Abort if the Destination directory exists, Pass clear_destination as false please
'clear_working' => true ,
'is_multi' => false ,
'hook_extra' => array () // Pass any extra $hook_extra args here, this will be passed to any hooked filters.
);
2009-04-19 15:36:28 -04:00
2014-05-15 01:02:14 -04:00
$options = wp_parse_args ( $options , $defaults );
2009-04-19 15:36:28 -04:00
2015-06-15 01:35:26 -04:00
/**
2016-05-22 14:01:30 -04:00
* Filters the package options before running an update .
2015-06-15 01:35:26 -04:00
*
2016-05-25 10:45:27 -04:00
* See also { @ see 'upgrader_process_complete' } .
*
2015-06-15 01:35:26 -04:00
* @ since 4.3 . 0
*
* @ param array $options {
* Options used by the upgrader .
*
* @ type string $package Package for update .
* @ type string $destination Update location .
* @ type bool $clear_destination Clear the destination resource .
* @ type bool $clear_working Clear the working resource .
* @ type bool $abort_if_destination_exists Abort if the Destination directory exists .
* @ type bool $is_multi Whether the upgrader is running multiple times .
2016-05-25 10:45:27 -04:00
* @ type array $hook_extra {
* Extra hook arguments .
*
* @ type string $action Type of action . Default 'update' .
* @ type string $type Type of update process . Accepts 'plugin' , 'theme' , or 'core' .
* @ type bool $bulk Whether the update process is a bulk update . Default true .
* @ type string $plugin The base plugin path from the plugins directory .
* @ type string $theme The stylesheet or template name of the theme .
* @ type string $language_update_type The language pack update type . Accepts 'plugin' , 'theme' ,
* or 'core' .
* @ type object $language_update The language pack update offer .
* }
2015-06-15 01:35:26 -04:00
* }
*/
$options = apply_filters ( 'upgrader_package_options' , $options );
2014-05-15 01:02:14 -04:00
if ( ! $options [ 'is_multi' ] ) { // call $this->header separately if running multiple times
2013-09-11 22:43:10 -04:00
$this -> skin -> header ();
2014-05-15 01:02:14 -04:00
}
2013-09-11 22:43:10 -04:00
2013-10-16 00:15:09 -04:00
// Connect to the Filesystem first.
2014-05-15 01:02:14 -04:00
$res = $this -> fs_connect ( array ( WP_CONTENT_DIR , $options [ 'destination' ] ) );
2013-10-16 00:15:09 -04:00
// Mainly for non-connected filesystem.
if ( ! $res ) {
2014-05-15 01:02:14 -04:00
if ( ! $options [ 'is_multi' ] ) {
2013-10-16 00:15:09 -04:00
$this -> skin -> footer ();
2014-05-15 01:02:14 -04:00
}
2013-10-16 00:15:09 -04:00
return false ;
}
2013-09-11 22:43:10 -04:00
$this -> skin -> before ();
2009-04-19 15:36:28 -04:00
if ( is_wp_error ( $res ) ) {
$this -> skin -> error ( $res );
2013-09-11 22:43:10 -04:00
$this -> skin -> after ();
2014-05-15 01:02:14 -04:00
if ( ! $options [ 'is_multi' ] ) {
2013-09-11 22:43:10 -04:00
$this -> skin -> footer ();
2014-05-15 01:02:14 -04:00
}
2009-04-19 15:36:28 -04:00
return $res ;
}
2009-04-20 14:15:08 -04:00
2015-08-21 00:13:24 -04:00
/*
* Download the package ( Note , This just returns the filename
* of the file if the package is a local file )
*/
2014-05-15 01:02:14 -04:00
$download = $this -> download_package ( $options [ 'package' ] );
2009-04-19 15:36:28 -04:00
if ( is_wp_error ( $download ) ) {
$this -> skin -> error ( $download );
2010-03-06 03:39:50 -05:00
$this -> skin -> after ();
2014-05-15 01:02:14 -04:00
if ( ! $options [ 'is_multi' ] ) {
2013-09-11 22:43:10 -04:00
$this -> skin -> footer ();
2014-05-15 01:02:14 -04:00
}
2009-04-19 15:36:28 -04:00
return $download ;
}
2009-04-20 14:18:39 -04:00
2014-05-15 01:02:14 -04:00
$delete_package = ( $download != $options [ 'package' ] ); // Do not delete a "local" file
2011-04-19 01:54:01 -04:00
2015-08-21 00:13:24 -04:00
// Unzips the file into a temporary directory.
2011-04-19 01:54:01 -04:00
$working_dir = $this -> unpack_package ( $download , $delete_package );
2009-04-19 15:36:28 -04:00
if ( is_wp_error ( $working_dir ) ) {
$this -> skin -> error ( $working_dir );
2010-03-06 03:39:50 -05:00
$this -> skin -> after ();
2014-05-15 01:02:14 -04:00
if ( ! $options [ 'is_multi' ] ) {
2013-09-11 22:43:10 -04:00
$this -> skin -> footer ();
2014-05-15 01:02:14 -04:00
}
2009-04-19 15:36:28 -04:00
return $working_dir ;
}
2015-08-21 00:13:24 -04:00
// With the given options, this installs it to the destination directory.
2009-04-20 14:18:39 -04:00
$result = $this -> install_package ( array (
2013-09-05 21:33:09 -04:00
'source' => $working_dir ,
2014-05-15 01:02:14 -04:00
'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' ]
2013-09-05 21:33:09 -04:00
) );
2009-04-19 15:36:28 -04:00
$this -> skin -> set_result ( $result );
if ( is_wp_error ( $result ) ) {
$this -> skin -> error ( $result );
$this -> skin -> feedback ( 'process_failed' );
} else {
2015-08-21 00:13:24 -04:00
// Install succeeded.
2009-04-19 15:36:28 -04:00
$this -> skin -> feedback ( 'process_success' );
}
2013-09-11 22:43:10 -04:00
2009-04-19 15:36:28 -04:00
$this -> skin -> after ();
2009-10-26 03:04:30 -04:00
2014-05-15 01:02:14 -04:00
if ( ! $options [ 'is_multi' ] ) {
2014-03-23 23:00:15 -04:00
2016-05-10 08:20:27 -04:00
/**
* Fires when the upgrader process is complete .
*
2016-05-25 10:45:27 -04:00
* See also { @ see 'upgrader_package_options' } .
*
2016-05-10 08:20:27 -04:00
* @ since 3.6 . 0
* @ since 3.7 . 0 Added to WP_Upgrader :: run () .
2016-06-11 13:44:28 -04:00
* @ since 4.6 . 0 `$translations` was added as a possible argument to `$hook_extra` .
2016-05-10 08:20:27 -04:00
*
* @ param WP_Upgrader $this WP_Upgrader instance . In other contexts , $this , might be a
2016-06-11 13:44:28 -04:00
* Theme_Upgrader , Plugin_Upgrader , Core_Upgrade , or Language_Pack_Upgrader instance .
2016-05-24 13:52:30 -04:00
* @ param array $hook_extra {
2016-05-10 08:20:27 -04:00
* Array of bulk item update data .
*
2016-06-11 13:44:28 -04:00
* @ type string $action Type of action . Default 'update' .
* @ type string $type Type of update process . Accepts 'plugin' , 'theme' , 'translation' , or 'core' .
* @ type bool $bulk Whether the update process is a bulk update . Default true .
* @ type array $plugins Array of the basename paths of the plugins ' main files .
* @ type array $themes The theme slugs .
* @ type array $translations {
* Array of translations update data .
*
* @ type string $language The locale the translation is for .
* @ type string $type Type of translation . Accepts 'plugin' , 'theme' , or 'core' .
* @ type string $slug Text domain the translation is for . The slug of a theme / plugin or
* 'default' for core translations .
* @ type string $version The version of a theme , plugin , or core .
* }
2016-05-10 08:20:27 -04:00
* }
*/
2014-05-15 01:02:14 -04:00
do_action ( 'upgrader_process_complete' , $this , $options [ 'hook_extra' ] );
2016-05-24 13:52:30 -04:00
2009-10-26 03:04:30 -04:00
$this -> skin -> footer ();
2013-10-16 00:15:09 -04:00
}
2009-10-26 03:04:30 -04:00
2009-04-19 15:36:28 -04:00
return $result ;
}
2009-04-20 14:18:39 -04:00
2014-12-06 19:26:22 -05:00
/**
* Toggle maintenance mode for the site .
*
* Creates / deletes the maintenance file to enable / disable maintenance mode .
*
* @ since 2.8 . 0
2015-08-21 00:05:25 -04:00
* @ access public
2014-12-06 19:26:22 -05:00
*
2015-05-28 17:41:30 -04:00
* @ global WP_Filesystem_Base $wp_filesystem Subclass
*
2014-12-06 19:26:22 -05:00
* @ param bool $enable True to enable maintenance mode , false to disable .
*/
public function maintenance_mode ( $enable = false ) {
2009-04-19 15:36:28 -04:00
global $wp_filesystem ;
$file = $wp_filesystem -> abspath () . '.maintenance' ;
if ( $enable ) {
$this -> skin -> feedback ( 'maintenance_start' );
// Create maintenance file to signal that we are upgrading
$maintenance_string = '<?php $upgrading = ' . time () . '; ?>' ;
$wp_filesystem -> delete ( $file );
$wp_filesystem -> put_contents ( $file , $maintenance_string , FS_CHMOD_FILE );
2015-01-08 02:05:25 -05:00
} elseif ( ! $enable && $wp_filesystem -> exists ( $file ) ) {
2009-04-19 15:36:28 -04:00
$this -> skin -> feedback ( 'maintenance_end' );
$wp_filesystem -> delete ( $file );
}
}
2009-04-20 14:18:39 -04:00
2016-01-19 00:07:26 -05:00
/**
2016-03-03 02:08:25 -05:00
* Creates a lock using WordPress options .
2016-01-19 00:07:26 -05:00
*
* @ since 4.5 . 0
* @ access public
2016-01-20 20:22:25 -05:00
* @ static
2016-01-19 00:07:26 -05:00
*
* @ param string $lock_name The name of this unique lock .
2016-03-03 02:08:25 -05:00
* @ param int $release_timeout Optional . The duration in seconds to respect an existing lock .
* Default : 1 hour .
* @ return bool False if a lock couldn ' t be created or if the lock is no longer valid . True otherwise .
2016-01-19 00:07:26 -05:00
*/
2016-01-20 20:22:25 -05:00
public static function create_lock ( $lock_name , $release_timeout = null ) {
2016-01-19 00:07:26 -05:00
global $wpdb ;
if ( ! $release_timeout ) {
$release_timeout = HOUR_IN_SECONDS ;
}
$lock_option = $lock_name . '.lock' ;
2016-03-03 02:08:25 -05:00
// Try to lock.
2016-01-19 00:07:26 -05:00
$lock_result = $wpdb -> query ( $wpdb -> prepare ( " INSERT IGNORE INTO ` $wpdb->options ` ( `option_name`, `option_value`, `autoload` ) VALUES (%s, %s, 'no') /* LOCK */ " , $lock_option , time () ) );
if ( ! $lock_result ) {
$lock_result = get_option ( $lock_option );
2016-03-03 02:08:25 -05:00
// If a lock couldn't be created, and there isn't a lock, bail.
2016-01-19 00:07:26 -05:00
if ( ! $lock_result ) {
return false ;
}
2016-03-03 02:08:25 -05:00
// Check to see if the lock is still valid. If not, bail.
2016-01-19 00:07:26 -05:00
if ( $lock_result > ( time () - $release_timeout ) ) {
return false ;
}
// There must exist an expired lock, clear it and re-gain it.
2016-01-20 20:22:25 -05:00
WP_Upgrader :: release_lock ( $lock_name );
2016-01-19 00:07:26 -05:00
2016-01-20 20:22:25 -05:00
return WP_Upgrader :: create_lock ( $lock_name , $release_timeout );
2016-01-19 00:07:26 -05:00
}
2016-03-03 02:08:25 -05:00
// Update the lock, as by this point we've definitely got a lock, just need to fire the actions.
2016-01-19 00:07:26 -05:00
update_option ( $lock_option , time () );
return true ;
}
/**
2016-03-03 02:11:25 -05:00
* Releases an upgrader lock .
2016-01-19 00:07:26 -05:00
*
* @ since 4.5 . 0
* @ access public
2016-01-20 20:22:25 -05:00
* @ static
2016-03-03 02:11:25 -05:00
*
* @ see WP_Upgrader :: create_lock ()
2016-01-19 00:07:26 -05:00
*
* @ param string $lock_name The name of this unique lock .
2016-03-03 02:11:25 -05:00
* @ return bool True if the lock was successfully released . False on failure .
2016-01-19 00:07:26 -05:00
*/
2016-01-20 20:22:25 -05:00
public static function release_lock ( $lock_name ) {
2016-01-19 00:07:26 -05:00
return delete_option ( $lock_name . '.lock' );
}
2009-04-19 15:36:28 -04:00
}
2016-05-10 07:59:27 -04:00
/** Plugin_Upgrader class */
require_once ABSPATH . 'wp-admin/includes/class-plugin-upgrader.php' ;
2012-03-23 06:10:06 -04:00
2016-05-10 07:59:27 -04:00
/** Theme_Upgrader class */
require_once ABSPATH . 'wp-admin/includes/class-theme-upgrader.php' ;
2012-03-23 06:10:06 -04:00
2016-05-10 07:59:27 -04:00
/** Language_Pack_Upgrader class */
require_once ABSPATH . 'wp-admin/includes/class-language-pack-upgrader.php' ;
2012-03-23 06:10:06 -04:00
2016-05-10 07:59:27 -04:00
/** Core_Upgrader class */
require_once ABSPATH . 'wp-admin/includes/class-core-upgrader.php' ;
2012-03-23 06:10:06 -04:00
2016-05-10 07:59:27 -04:00
/** File_Upload_Upgrader class */
require_once ABSPATH . 'wp-admin/includes/class-file-upload-upgrader.php' ;
2012-03-23 06:10:06 -04:00
2016-05-10 07:59:27 -04:00
/** WP_Automatic_Upgrader class */
require_once ABSPATH . 'wp-admin/includes/class-wp-automatic-upgrader.php' ;