123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969 |
- <?php
- /**
- * Upgrade API: WP_Upgrader class
- *
- * Requires skin classes and WP_Upgrader subclasses for backward compatibility.
- *
- * @package WordPress
- * @subpackage Upgrader
- * @since 2.8.0
- */
- /** 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';
- /** WP_Ajax_Upgrader_Skin class */
- require_once ABSPATH . 'wp-admin/includes/class-wp-ajax-upgrader-skin.php';
- /**
- * Core class used for upgrading/installing a local set of files via
- * the Filesystem Abstraction classes from a Zip file.
- *
- * @since 2.8.0
- */
- #[AllowDynamicProperties]
- class WP_Upgrader {
- /**
- * The error/notification strings used to update the user on the progress.
- *
- * @since 2.8.0
- * @var array $strings
- */
- public $strings = array();
- /**
- * The upgrader skin being used.
- *
- * @since 2.8.0
- * @var Automatic_Upgrader_Skin|WP_Upgrader_Skin $skin
- */
- public $skin = null;
- /**
- * The result of the installation.
- *
- * 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
- * it.
- *
- * @since 2.8.0
- *
- * @var array|WP_Error $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 installation 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.
- * }
- */
- public $result = array();
- /**
- * The total number of updates being performed.
- *
- * Set by the bulk update methods.
- *
- * @since 3.0.0
- * @var int $update_count
- */
- public $update_count = 0;
- /**
- * The current update if multiple updates are being performed.
- *
- * Used by the bulk update methods, and incremented for each update.
- *
- * @since 3.0.0
- * @var int
- */
- public $update_current = 0;
- /**
- * Construct the upgrader with a skin.
- *
- * @since 2.8.0
- *
- * @param WP_Upgrader_Skin $skin The upgrader skin to use. Default is a WP_Upgrader_Skin
- * instance.
- */
- public function __construct( $skin = null ) {
- if ( null === $skin ) {
- $this->skin = new WP_Upgrader_Skin();
- } else {
- $this->skin = $skin;
- }
- }
- /**
- * 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
- */
- public function init() {
- $this->skin->set_upgrader( $this );
- $this->generic_strings();
- }
- /**
- * Add the generic strings to WP_Upgrader::$strings.
- *
- * @since 2.8.0
- */
- public function generic_strings() {
- $this->strings['bad_request'] = __( 'Invalid data provided.' );
- $this->strings['fs_unavailable'] = __( 'Could not access filesystem.' );
- $this->strings['fs_error'] = __( 'Filesystem error.' );
- $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.' );
- /* translators: %s: Directory name. */
- $this->strings['fs_no_folder'] = __( 'Unable to locate needed folder (%s).' );
- $this->strings['download_failed'] = __( 'Download failed.' );
- $this->strings['installing_package'] = __( 'Installing the latest version…' );
- $this->strings['no_files'] = __( 'The package contains no files.' );
- $this->strings['folder_exists'] = __( 'Destination folder already exists.' );
- $this->strings['mkdir_failed'] = __( 'Could not create directory.' );
- $this->strings['incompatible_archive'] = __( 'The package could not be installed.' );
- $this->strings['files_not_writable'] = __( 'The update cannot be installed because some files could not be copied. This is usually due to inconsistent file permissions.' );
- $this->strings['maintenance_start'] = __( 'Enabling Maintenance mode…' );
- $this->strings['maintenance_end'] = __( 'Disabling Maintenance mode…' );
- }
- /**
- * Connect to the filesystem.
- *
- * @since 2.8.0
- *
- * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
- *
- * @param string[] $directories Optional. Array of directories. If any of these do
- * not exist, a WP_Error object will be returned.
- * Default empty array.
- * @param bool $allow_relaxed_file_ownership Whether to allow relaxed file ownership.
- * Default false.
- * @return bool|WP_Error True if able to connect, false or a WP_Error otherwise.
- */
- public function fs_connect( $directories = array(), $allow_relaxed_file_ownership = false ) {
- global $wp_filesystem;
- $credentials = $this->skin->request_filesystem_credentials( false, $directories[0], $allow_relaxed_file_ownership );
- if ( false === $credentials ) {
- return false;
- }
- if ( ! WP_Filesystem( $credentials, $directories[0], $allow_relaxed_file_ownership ) ) {
- $error = true;
- if ( is_object( $wp_filesystem ) && $wp_filesystem->errors->has_errors() ) {
- $error = $wp_filesystem->errors;
- }
- // Failed to connect. Error and request again.
- $this->skin->request_filesystem_credentials( $error, $directories[0], $allow_relaxed_file_ownership );
- return false;
- }
- if ( ! is_object( $wp_filesystem ) ) {
- return new WP_Error( 'fs_unavailable', $this->strings['fs_unavailable'] );
- }
- if ( is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->has_errors() ) {
- return new WP_Error( 'fs_error', $this->strings['fs_error'], $wp_filesystem->errors );
- }
- foreach ( (array) $directories as $dir ) {
- 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;
- case get_theme_root():
- if ( ! $wp_filesystem->wp_themes_dir() ) {
- return new WP_Error( 'fs_no_themes_dir', $this->strings['fs_no_themes_dir'] );
- }
- break;
- default:
- if ( ! $wp_filesystem->find_folder( $dir ) ) {
- return new WP_Error( 'fs_no_folder', sprintf( $this->strings['fs_no_folder'], esc_html( basename( $dir ) ) ) );
- }
- break;
- }
- }
- return true;
- }
- /**
- * Download a package.
- *
- * @since 2.8.0
- * @since 5.2.0 Added the `$check_signatures` parameter.
- * @since 5.5.0 Added the `$hook_extra` parameter.
- *
- * @param string $package The URI of the package. If this is the full path to an
- * existing local file, it will be returned untouched.
- * @param bool $check_signatures Whether to validate file signatures. Default false.
- * @param array $hook_extra Extra arguments to pass to the filter hooks. Default empty array.
- * @return string|WP_Error The full path to the downloaded package file, or a WP_Error object.
- */
- public function download_package( $package, $check_signatures = false, $hook_extra = array() ) {
- /**
- * Filters whether to return the package.
- *
- * @since 3.7.0
- * @since 5.5.0 Added the `$hook_extra` parameter.
- *
- * @param bool $reply Whether to bail without returning the package.
- * Default false.
- * @param string $package The package file name.
- * @param WP_Upgrader $upgrader The WP_Upgrader instance.
- * @param array $hook_extra Extra arguments passed to hooked filters.
- */
- $reply = apply_filters( 'upgrader_pre_download', false, $package, $this, $hook_extra );
- if ( false !== $reply ) {
- return $reply;
- }
- if ( ! preg_match( '!^(http|https|ftp)://!i', $package ) && file_exists( $package ) ) { // Local file or remote?
- return $package; // Must be a local file.
- }
- if ( empty( $package ) ) {
- return new WP_Error( 'no_package', $this->strings['no_package'] );
- }
- $this->skin->feedback( 'downloading_package', $package );
- $download_file = download_url( $package, 300, $check_signatures );
- if ( is_wp_error( $download_file ) && ! $download_file->get_error_data( 'softfail-filename' ) ) {
- return new WP_Error( 'download_failed', $this->strings['download_failed'], $download_file->get_error_message() );
- }
- return $download_file;
- }
- /**
- * Unpack a compressed package file.
- *
- * @since 2.8.0
- *
- * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
- *
- * @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.
- * @return string|WP_Error The path to the unpacked contents, or a WP_Error on failure.
- */
- public function unpack_package( $package, $delete_package = true ) {
- global $wp_filesystem;
- $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 );
- }
- }
- // We need a working directory - strip off any .tmp or .zip suffixes.
- $working_dir = $upgrade_folder . basename( basename( $package, '.tmp' ), '.zip' );
- // Clean up working directory.
- if ( $wp_filesystem->is_dir( $working_dir ) ) {
- $wp_filesystem->delete( $working_dir, true );
- }
- // Unzip package to working directory.
- $result = unzip_file( $package, $working_dir );
- // Once extracted, delete the package if required.
- if ( $delete_package ) {
- unlink( $package );
- }
- if ( is_wp_error( $result ) ) {
- $wp_filesystem->delete( $working_dir, true );
- if ( 'incompatible_archive' === $result->get_error_code() ) {
- return new WP_Error( 'incompatible_archive', $this->strings['incompatible_archive'], $result->get_error_data() );
- }
- return $result;
- }
- return $working_dir;
- }
- /**
- * Flatten the results of WP_Filesystem_Base::dirlist() for iterating over.
- *
- * @since 4.9.0
- * @access protected
- *
- * @param array $nested_files Array of files as returned by WP_Filesystem_Base::dirlist().
- * @param string $path Relative path to prepend to child nodes. Optional.
- * @return array A flattened array of the $nested_files specified.
- */
- protected function flatten_dirlist( $nested_files, $path = '' ) {
- $files = array();
- foreach ( $nested_files as $name => $details ) {
- $files[ $path . $name ] = $details;
- // Append children recursively.
- if ( ! empty( $details['files'] ) ) {
- $children = $this->flatten_dirlist( $details['files'], $path . $name . '/' );
- // Merge keeping possible numeric keys, which array_merge() will reindex from 0..n.
- $files = $files + $children;
- }
- }
- return $files;
- }
- /**
- * Clears the directory where this item is going to be installed into.
- *
- * @since 4.3.0
- *
- * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
- *
- * @param string $remote_destination The location on the remote filesystem to be cleared.
- * @return true|WP_Error True upon success, WP_Error on failure.
- */
- public function clear_destination( $remote_destination ) {
- global $wp_filesystem;
- $files = $wp_filesystem->dirlist( $remote_destination, true, true );
- // False indicates that the $remote_destination doesn't exist.
- if ( false === $files ) {
- return true;
- }
- // Flatten the file list to iterate over.
- $files = $this->flatten_dirlist( $files );
- // Check all files are writable before attempting to clear the destination.
- $unwritable_files = array();
- // Check writability.
- foreach ( $files as $filename => $file_details ) {
- if ( ! $wp_filesystem->is_writable( $remote_destination . $filename ) ) {
- // Attempt to alter permissions to allow writes and try again.
- $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;
- }
- /**
- * Install a package.
- *
- * Copies the contents of a package from 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
- *
- * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
- * @global array $wp_theme_directories
- *
- * @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 from the working directory
- * after copying them 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
- * WP_Upgrader::install_package(). Default empty array.
- * }
- *
- * @return array|WP_Error The result (also stored in `WP_Upgrader::$result`), or a WP_Error on failure.
- */
- public function install_package( $args = array() ) {
- global $wp_filesystem, $wp_theme_directories;
- $defaults = array(
- 'source' => '', // Please always pass this.
- 'destination' => '', // ...and this.
- 'clear_destination' => false,
- 'clear_working' => false,
- 'abort_if_destination_exists' => true,
- 'hook_extra' => array(),
- );
- $args = wp_parse_args( $args, $defaults );
- // These were previously extract()'d.
- $source = $args['source'];
- $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' );
- /**
- * Filters the installation response before the installation has started.
- *
- * Returning a value 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 Installation response.
- * @param array $hook_extra Extra arguments passed to hooked filters.
- */
- $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 = $args['source'];
- $local_destination = $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( $args['source'] ) . $source_files[0] . '/' ) ) {
- // Only one folder? Then we want its contents.
- $source = trailingslashit( $args['source'] ) . trailingslashit( $source_files[0] );
- } elseif ( 0 === count( $source_files ) ) {
- // There are no files?
- return new WP_Error( 'incompatible_archive_empty', $this->strings['incompatible_archive'], $this->strings['no_files'] );
- } 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.
- $source = trailingslashit( $args['source'] );
- }
- /**
- * Filters the source file location for the upgrade package.
- *
- * @since 2.8.0
- * @since 4.4.0 The $hook_extra parameter became available.
- *
- * @param string $source File source location.
- * @param string $remote_source Remote file source location.
- * @param WP_Upgrader $upgrader WP_Upgrader instance.
- * @param array $hook_extra Extra arguments passed to hooked filters.
- */
- $source = apply_filters( 'upgrader_source_selection', $source, $remote_source, $this, $args['hook_extra'] );
- 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 ) );
- }
- /*
- * 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 ) ) {
- $protected_directories = array_merge( $protected_directories, $wp_theme_directories );
- }
- if ( in_array( $destination, $protected_directories, true ) ) {
- $remote_destination = trailingslashit( $remote_destination ) . trailingslashit( basename( $source ) );
- $destination = trailingslashit( $destination ) . trailingslashit( basename( $source ) );
- }
- if ( $clear_destination ) {
- // We're going to clear the destination if there's something there.
- $this->skin->feedback( 'remove_old' );
- $removed = $this->clear_destination( $remote_destination );
- /**
- * Filters whether the upgrader cleared the destination.
- *
- * @since 2.8.0
- *
- * @param true|WP_Error $removed Whether the destination was cleared.
- * True upon success, WP_Error on failure.
- * @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.
- */
- $removed = apply_filters( 'upgrader_clear_destination', $removed, $local_destination, $remote_destination, $args['hook_extra'] );
- if ( is_wp_error( $removed ) ) {
- return $removed;
- }
- } 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.
- $_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 );
- }
- }
- // Create destination if needed.
- 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 ( $args['clear_working'] ) {
- $wp_filesystem->delete( $remote_source, true );
- }
- return $result;
- }
- // Clear the working folder?
- if ( $args['clear_working'] ) {
- $wp_filesystem->delete( $remote_source, true );
- }
- $destination_name = basename( str_replace( $local_destination, '', $destination ) );
- if ( '.' === $destination_name ) {
- $destination_name = '';
- }
- $this->result = compact( 'source', 'source_files', 'destination', 'destination_name', 'local_destination', 'remote_destination', 'clear_destination' );
- /**
- * Filters the installation response after the installation has finished.
- *
- * @since 2.8.0
- *
- * @param bool $response Installation response.
- * @param array $hook_extra Extra arguments passed to hooked filters.
- * @param array $result Installation result data.
- */
- $res = apply_filters( 'upgrader_post_install', true, $args['hook_extra'], $this->result );
- 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;
- }
- /**
- * Run an upgrade/installation.
- *
- * 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
- *
- * @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 from the working
- * directory after copying them to the destination.
- * Default true.
- * @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/installation
- * actions being performed in bulk. When true, the skin
- * WP_Upgrader::header() and WP_Upgrader::footer()
- * aren't called. Default false.
- * @type array $hook_extra Extra arguments to pass to the filter hooks called by
- * WP_Upgrader::run().
- * }
- * @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.
- */
- public function run( $options ) {
- $defaults = array(
- 'package' => '', // Please always pass this.
- 'destination' => '', // ...and this.
- 'clear_destination' => false,
- 'clear_working' => true,
- 'abort_if_destination_exists' => true, // Abort if the destination directory exists. Pass clear_destination as false please.
- 'is_multi' => false,
- 'hook_extra' => array(), // Pass any extra $hook_extra args here, this will be passed to any hooked filters.
- );
- $options = wp_parse_args( $options, $defaults );
- /**
- * Filters the package options before running an update.
- *
- * See also {@see 'upgrader_process_complete'}.
- *
- * @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.
- * @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 Path to the plugin file relative to 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.
- * }
- * }
- */
- $options = apply_filters( 'upgrader_package_options', $options );
- 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, $options['destination'] ) );
- // Mainly for non-connected filesystem.
- if ( ! $res ) {
- if ( ! $options['is_multi'] ) {
- $this->skin->footer();
- }
- return false;
- }
- $this->skin->before();
- if ( is_wp_error( $res ) ) {
- $this->skin->error( $res );
- $this->skin->after();
- if ( ! $options['is_multi'] ) {
- $this->skin->footer();
- }
- return $res;
- }
- /*
- * Download the package. Note: If the package is the full path
- * to an existing local file, it will be returned untouched.
- */
- $download = $this->download_package( $options['package'], true, $options['hook_extra'] );
- // Allow for signature soft-fail.
- // WARNING: This may be removed in the future.
- if ( is_wp_error( $download ) && $download->get_error_data( 'softfail-filename' ) ) {
- // Don't output the 'no signature could be found' failure message for now.
- if ( 'signature_verification_no_signature' !== $download->get_error_code() || WP_DEBUG ) {
- // Output the failure error as a normal feedback, and not as an error.
- $this->skin->feedback( $download->get_error_message() );
- // Report this failure back to WordPress.org for debugging purposes.
- wp_version_check(
- array(
- 'signature_failure_code' => $download->get_error_code(),
- 'signature_failure_data' => $download->get_error_data(),
- )
- );
- }
- // Pretend this error didn't happen.
- $download = $download->get_error_data( 'softfail-filename' );
- }
- if ( is_wp_error( $download ) ) {
- $this->skin->error( $download );
- $this->skin->after();
- if ( ! $options['is_multi'] ) {
- $this->skin->footer();
- }
- return $download;
- }
- $delete_package = ( $download !== $options['package'] ); // Do not delete a "local" file.
- // Unzips the file into a temporary directory.
- $working_dir = $this->unpack_package( $download, $delete_package );
- if ( is_wp_error( $working_dir ) ) {
- $this->skin->error( $working_dir );
- $this->skin->after();
- if ( ! $options['is_multi'] ) {
- $this->skin->footer();
- }
- return $working_dir;
- }
- // With the given options, this installs it to the destination directory.
- $result = $this->install_package(
- array(
- 'source' => $working_dir,
- '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'],
- )
- );
- /**
- * Filters the result of WP_Upgrader::install_package().
- *
- * @since 5.7.0
- *
- * @param array|WP_Error $result Result from WP_Upgrader::install_package().
- * @param array $hook_extra Extra arguments passed to hooked filters.
- */
- $result = apply_filters( 'upgrader_install_package_result', $result, $options['hook_extra'] );
- $this->skin->set_result( $result );
- if ( is_wp_error( $result ) ) {
- $this->skin->error( $result );
- if ( ! method_exists( $this->skin, 'hide_process_failed' ) || ! $this->skin->hide_process_failed( $result ) ) {
- $this->skin->feedback( 'process_failed' );
- }
- } else {
- // Installation succeeded.
- $this->skin->feedback( 'process_success' );
- }
- $this->skin->after();
- if ( ! $options['is_multi'] ) {
- /**
- * Fires when the upgrader process is complete.
- *
- * See also {@see 'upgrader_package_options'}.
- *
- * @since 3.6.0
- * @since 3.7.0 Added to WP_Upgrader::run().
- * @since 4.6.0 `$translations` was added as a possible argument to `$hook_extra`.
- *
- * @param WP_Upgrader $upgrader WP_Upgrader instance. In other contexts this might be a
- * Theme_Upgrader, Plugin_Upgrader, Core_Upgrade, or Language_Pack_Upgrader instance.
- * @param array $hook_extra {
- * Array of bulk item update data.
- *
- * @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.
- * }
- * }
- */
- do_action( 'upgrader_process_complete', $this, $options['hook_extra'] );
- $this->skin->footer();
- }
- return $result;
- }
- /**
- * Toggle maintenance mode for the site.
- *
- * Creates/deletes the maintenance file to enable/disable maintenance mode.
- *
- * @since 2.8.0
- *
- * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
- *
- * @param bool $enable True to enable maintenance mode, false to disable.
- */
- public function maintenance_mode( $enable = false ) {
- 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 );
- } elseif ( ! $enable && $wp_filesystem->exists( $file ) ) {
- $this->skin->feedback( 'maintenance_end' );
- $wp_filesystem->delete( $file );
- }
- }
- /**
- * Creates a lock using WordPress options.
- *
- * @since 4.5.0
- *
- * @param string $lock_name The name of this unique lock.
- * @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 still valid. True otherwise.
- */
- public static function create_lock( $lock_name, $release_timeout = null ) {
- global $wpdb;
- if ( ! $release_timeout ) {
- $release_timeout = HOUR_IN_SECONDS;
- }
- $lock_option = $lock_name . '.lock';
- // Try to lock.
- $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 );
- // If a lock couldn't be created, and there isn't a lock, bail.
- if ( ! $lock_result ) {
- return false;
- }
- // Check to see if the lock is still valid. If it is, bail.
- if ( $lock_result > ( time() - $release_timeout ) ) {
- return false;
- }
- // There must exist an expired lock, clear it and re-gain it.
- WP_Upgrader::release_lock( $lock_name );
- return WP_Upgrader::create_lock( $lock_name, $release_timeout );
- }
- // Update the lock, as by this point we've definitely got a lock, just need to fire the actions.
- update_option( $lock_option, time() );
- return true;
- }
- /**
- * Releases an upgrader lock.
- *
- * @since 4.5.0
- *
- * @see WP_Upgrader::create_lock()
- *
- * @param string $lock_name The name of this unique lock.
- * @return bool True if the lock was successfully released. False on failure.
- */
- public static function release_lock( $lock_name ) {
- return delete_option( $lock_name . '.lock' );
- }
- }
- /** Plugin_Upgrader class */
- require_once ABSPATH . 'wp-admin/includes/class-plugin-upgrader.php';
- /** Theme_Upgrader class */
- require_once ABSPATH . 'wp-admin/includes/class-theme-upgrader.php';
- /** Language_Pack_Upgrader class */
- require_once ABSPATH . 'wp-admin/includes/class-language-pack-upgrader.php';
- /** Core_Upgrader class */
- require_once ABSPATH . 'wp-admin/includes/class-core-upgrader.php';
- /** File_Upload_Upgrader class */
- require_once ABSPATH . 'wp-admin/includes/class-file-upload-upgrader.php';
- /** WP_Automatic_Updater class */
- require_once ABSPATH . 'wp-admin/includes/class-wp-automatic-updater.php';
|