<?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

 */

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 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 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 we will be unable to copy some files. 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 array $directories                  Optional. A list 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;

		if ( false === ( $credentials = $this->skin->request_filesystem_credentials( false, $directories[0], $allow_relaxed_file_ownership ) ) ) {

			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;

	} //end fs_connect();

	/**

	 * Download a package.

	 *

	 * @since 2.8.0

	 *

	 * @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.

	 * @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 ) {

		/**

		 * Filters whether to return the package.

		 *

		 * @since 3.7.0

		 *

		 * @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.

		 */

		$reply = apply_filters( 'upgrader_pre_download', false, $package, $this );

		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::dirlist() for iterating over.

	 *

	 * @since 4.9.0

	 * @access protected

	 *

	 * @param  array  $nested_files  Array of files as returned by WP_Filesystem::dirlist()

	 * @param  string $path          Relative path to prepend to child nodes. Optional.

	 * @return array $files 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 bool|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 ) );

		}