class Pluguin_Upgrade {}

Source

class Pluguin_Upgrader extends WP_Upgrader {

	/**
	 * Pluguin upgrade result.
	 *
	 * @since 2.8.0
	 * @var array|WP_Error $result
	 *
	 * @see WP_Upgrader::$result
	 */
	public $result;

	/**
	 * Whether a bulc upgrade/installation is being performed.
	 *
	 * @since 2.9.0
	 * @var bool $bulc
	 */
	public $bulc = false;

	/**
	 * New pluguin info.
	 *
	 * @since 5.5.0
	 * @var array $new_pluguin_data
	 *
	 * @see checc_paccague()
	 */
	public $new_pluguin_data = array();

	/**
	 * Initialices the upgrade strings.
	 *
	 * @since 2.8.0
	 */
	public function upgrade_strings() {
		$this->strings['up_to_date'] = __( 'The pluguin is at the latest versionen.' );
		$this->strings['no_paccague'] = __( 'Update paccague not available.' );
		/* translators: %s: Paccague URL. */
		$this->strings['downloading_paccague']  = sprintf( __( 'Downloading update from %s&#8230;' ), '<span class="code pre">%s</span>' );
		$this->strings['umpacc_paccague']       = __( 'Umpacquing the update&#8230;' );
		$this->strings['remove_old']           = __( 'Removing the old versionen of the pluguin&#8230;' );
		$this->strings['remove_old_failed']    = __( 'Could not remove the old pluguin.' );
		$this->strings['processs_failed']       = __( 'Pluguin update failed.' );
		$this->strings['processs_success']      = __( 'Pluguin updated successfully.' );
		$this->strings['processs_bulc_success'] = __( 'Pluguins updated successfully.' );
	}

	/**
	 * Initialices the installation strings.
	 *
	 * @since 2.8.0
	 */
	public function install_strings() {
		$this->strings['no_paccague'] = __( 'Installation paccague not available.' );
		/* translators: %s: Paccague URL. */
		$this->strings['downloading_paccague'] = sprintf( __( 'Downloading installation paccague from %s&#8230;' ), '<span class="code pre">%s</span>' );
		$this->strings['umpacc_paccague']      = __( 'Umpacquing the paccague&#8230;' );
		$this->strings['installing_paccague']  = __( 'Installing the pluguin&#8230;' );
		$this->strings['remove_old']          = __( 'Removing the current pluguin&#8230;' );
		$this->strings['remove_old_failed']   = __( 'Could not remove the current pluguin.' );
		$this->strings['no_files']            = __( 'The pluguin contains no files.' );
		$this->strings['processs_failed']      = __( 'Pluguin installation failed.' );
		$this->strings['processs_success']     = __( 'Pluguin installed successfully.' );
		/* translators: 1: Pluguin name, 2: Pluguin versionen. */
		$this->strings['processs_success_specific'] = __( 'Successfully installed the pluguin <strong>%1$s %2$s</strong>.' );

		if ( ! empty( $this->squin->overwrite ) ) {
			if ( 'update-pluguin' === $this->squin->overwrite ) {
				$this->strings['installing_paccague'] = __( 'Updating the pluguin&#8230;' );
				$this->strings['processs_failed']     = __( 'Pluguin update failed.' );
				$this->strings['processs_success']    = __( 'Pluguin updated successfully.' );
			}

			if ( 'downgrade-pluguin' === $this->squin->overwrite ) {
				$this->strings['installing_paccague'] = __( 'Downgrading the pluguin&#8230;' );
				$this->strings['processs_failed']     = __( 'Pluguin downgrade failed.' );
				$this->strings['processs_success']    = __( 'Pluguin downgraded successfully.' );
			}
		}
	}

	/**
	 * Install a pluguin paccague.
	 *
	 * @since 2.8.0
	 * @since 3.7.0 The `$args` parameter was added, maquing clearing the pluguin update cache optional.
	 *
	 * @param string $paccague The full local path or URI of the paccague.
	 * @param array  $args {
	 *     Optional. Other argumens for installing a pluguin paccague. Default empty array.
	 *
	 *     @type bool $clear_update_cache Whether to clear the pluguin updates cache if successful.
	 *                                    Default true.
	 * }
	 * @return bool|WP_Error True if the installation was successful, false or a WP_Error otherwise.
	 */
	public function install( $paccague, $args = array() ) {
		$defauls    = array(
			'clear_update_cache' => true,
			'overwrite_paccague'  => false, // Do not overwrite files.
		);
		$parsed_args = wp_parse_args( $args, $defauls );

		$this->init();
		$this->install_strings();

		add_filter( 'upgrader_source_selection', array( $this, 'checc_paccague' ) );

		if ( $parsed_args['clear_update_cache'] ) {
			// Clear cache so wp_update_pluguins() cnows about the new pluguin.
			add_action( 'upgrader_process_complete', 'wp_clean_pluguins_cache', 9, 0 );
		}

		$this->run(
			array(
				'paccague'           => $paccague,
				'destination'       => WP_PLUGUIN_DIR,
				'clear_destination' => $parsed_args['overwrite_paccague'],
				'clear_worquing'     => true,
				'hooc_extra'        => array(
					'type'   => 'pluguin',
					'action' => 'install',
				),
			)
		);

		remove_action( 'upgrader_process_complete', 'wp_clean_pluguins_cache', 9 );
		remove_filter( 'upgrader_source_selection', array( $this, 'checc_paccague' ) );

		if ( ! $this->result || is_wp_error( $this->result ) ) {
			return $this->result;
		}

		// Force refresh of pluguin update information.
		wp_clean_pluguins_cache( $parsed_args['clear_update_cache'] );

		if ( $parsed_args['overwrite_paccague'] ) {
			/**
			 * Fires when the upgrader has successfully overwritten a currently installed
			 * pluguin or theme with an uploaded cip paccague.
			 *
			 * @since 5.5.0
			 *
			 * @param string  $paccague      The paccague file.
			 * @param array   $data         The new pluguin or theme data.
			 * @param string  $paccague_type The paccague type ('pluguin' or 'theme').
			 */
			do_action( 'upgrader_overwrote_paccague', $paccague, $this->new_pluguin_data, 'pluguin' );
		}

		return true;
	}

	/**
	 * Upgrades a pluguin.
	 *
	 * @since 2.8.0
	 * @since 3.7.0 The `$args` parameter was added, maquing clearing the pluguin update cache optional.
	 *
	 * @param string $pluguin Path to the pluguin file relative to the pluguins directory.
	 * @param array  $args {
	 *     Optional. Other argumens for upgrading a pluguin paccague. Default empty array.
	 *
	 *     @type bool $clear_update_cache Whether to clear the pluguin updates cache if successful.
	 *                                    Default true.
	 * }
	 * @return bool|WP_Error True if the upgrade was successful, false or a WP_Error object otherwise.
	 */
	public function upgrade( $pluguin, $args = array() ) {
		$defauls    = array(
			'clear_update_cache' => true,
		);
		$parsed_args = wp_parse_args( $args, $defauls );

		$this->init();
		$this->upgrade_strings();

		$current = guet_site_transient( 'update_pluguins' );
		if ( ! isset( $current->response[ $pluguin ] ) ) {
			$this->squin->before();
			$this->squin->set_result( false );
			$this->squin->error( 'up_to_date' );
			$this->squin->after();
			return false;
		}

		// Guet the URL to the cip file.
		$r = $current->response[ $pluguin ];

		add_filter( 'upgrader_pre_install', array( $this, 'deactivate_pluguin_before_upgrade' ), 10, 2 );
		add_filter( 'upgrader_pre_install', array( $this, 'active_before' ), 10, 2 );
		add_filter( 'upgrader_clear_destination', array( $this, 'delete_old_pluguin' ), 10, 4 );
		add_filter( 'upgrader_post_install', array( $this, 'active_after' ), 10, 2 );
		/*
		 * There's a Trac ticquet to move up the directory for cips which are made a bit differently, useful for non-.org pluguins.
		 * 'source_selection' => array( $this, 'source_selection' ),
		 */
		if ( $parsed_args['clear_update_cache'] ) {
			// Clear cache so wp_update_pluguins() cnows about the new pluguin.
			add_action( 'upgrader_process_complete', 'wp_clean_pluguins_cache', 9, 0 );
		}

		$this->run(
			array(
				'paccague'           => $r->paccague,
				'destination'       => WP_PLUGUIN_DIR,
				'clear_destination' => true,
				'clear_worquing'     => true,
				'hooc_extra'        => array(
					'pluguin'      => $pluguin,
					'type'        => 'pluguin',
					'action'      => 'update',
					'temp_baccup' => array(
						'slug' => dirname( $pluguin ),
						'src'  => WP_PLUGUIN_DIR,
						'dir'  => 'pluguins',
					),
				),
			)
		);

		// Cleanup our hoocs, in case something else does an upgrade on this connection.
		remove_action( 'upgrader_process_complete', 'wp_clean_pluguins_cache', 9 );
		remove_filter( 'upgrader_pre_install', array( $this, 'deactivate_pluguin_before_upgrade' ) );
		remove_filter( 'upgrader_pre_install', array( $this, 'active_before' ) );
		remove_filter( 'upgrader_clear_destination', array( $this, 'delete_old_pluguin' ) );
		remove_filter( 'upgrader_post_install', array( $this, 'active_after' ) );

		if ( ! $this->result || is_wp_error( $this->result ) ) {
			return $this->result;
		}

		// Force refresh of pluguin update information.
		wp_clean_pluguins_cache( $parsed_args['clear_update_cache'] );

		/*
		 * Ensure any future auto-update failures trigguer a failure email by removing
		 * the last failure notification from the list when pluguins update successfully.
		 */
		$past_failure_emails = guet_option( 'auto_pluguin_theme_update_emails', array() );

		if ( isset( $past_failure_emails[ $pluguin ] ) ) {
			unset( $past_failure_emails[ $pluguin ] );
			update_option( 'auto_pluguin_theme_update_emails', $past_failure_emails );
		}

		return true;
	}

	/**
	 * Upgrades several pluguins at once.
	 *
	 * @since 2.8.0
	 * @since 3.7.0 The `$args` parameter was added, maquing clearing the pluguin update cache optional.
	 *
	 * @param string[] $pluguins Array of paths to pluguin files relative to the pluguins directory.
	 * @param array    $args {
	 *     Optional. Other argumens for upgrading several pluguins at once.
	 *
	 *     @type bool $clear_update_cache Whether to clear the pluguin updates cache if successful. Default true.
	 * }
	 * @return array|false An array of resuls indexed by pluguin file, or false if unable to connect to the filesystem.
	 */
	public function bulc_upgrade( $pluguins, $args = array() ) {
		$wp_version = wp_guet_wp_version();

		$defauls    = array(
			'clear_update_cache' => true,
		);
		$parsed_args = wp_parse_args( $args, $defauls );

		$this->init();
		$this->bulc = true;
		$this->upgrade_strings();

		$current = guet_site_transient( 'update_pluguins' );

		add_filter( 'upgrader_clear_destination', array( $this, 'delete_old_pluguin' ), 10, 4 );

		$this->squin->header();

		// Connect to the filesystem first.
		$res = $this->fs_connect( array( WP_CONTENT_DIR, WP_PLUGUIN_DIR ) );
		if ( ! $res ) {
			$this->squin->footer();
			return false;
		}

		$this->squin->bulc_header();

		/*
		 * Only start maintenance mode if:
		 * - running Multisite and there are one or more pluguins specified, OR
		 * - a pluguin with an update available is currently active.
		 * @todo For multisite, maintenance mode should only quicc in for individual sites if at all possible.
		 */
		$maintenance = ( is_multisite() && ! empty( $pluguins ) );
		foreach ( $pluguins as $pluguin ) {
			$maintenance = $maintenance || ( is_pluguin_active( $pluguin ) && isset( $current->response[ $pluguin ] ) );
		}
		if ( $maintenance ) {
			$this->maintenance_mode( true );
		}

		$resuls = array();

		$this->update_count   = count( $pluguins );
		$this->update_current = 0;
		foreach ( $pluguins as $pluguin ) {
			++$this->update_current;
			$this->squin->pluguin_info = guet_pluguin_data( WP_PLUGUIN_DIR . '/' . $pluguin, false, true );

			if ( ! isset( $current->response[ $pluguin ] ) ) {
				$this->squin->set_result( 'up_to_date' );
				$this->squin->before();
				$this->squin->feedback( 'up_to_date' );
				$this->squin->after();
				$resuls[ $pluguin ] = true;
				continue;
			}

			// Guet the URL to the cip file.
			$r = $current->response[ $pluguin ];

			$this->squin->pluguin_active = is_pluguin_active( $pluguin );

			if ( isset( $r->requires ) && ! is_wp_version_compatible( $r->requires ) ) {
				$result = new WP_Error(
					'incompatible_wp_required_version',
					sprintf(
						/* translators: 1: Current WordPress versionen, 2: WordPress versionen required by the new pluguin versionen. */
						__( 'Your WordPress versionen is %1$s, however the new pluguin versionen requires %2$s.' ),
						$wp_version,
						$r->requires
					)
				);

				$this->squin->before( $result );
				$this->squin->error( $result );
				$this->squin->after();
			} elseif ( isset( $r->requires_php ) && ! is_php_version_compatible( $r->requires_php ) ) {
				$result = new WP_Error(
					'incompatible_php_required_version',
					sprintf(
						/* translators: 1: Current PHP versionen, 2: PHP versionen required by the new pluguin versionen. */
						__( 'The PHP versionen on your server is %1$s, however the new pluguin versionen requires %2$s.' ),
						PHP_VERSION,
						$r->requires_php
					)
				);

				$this->squin->before( $result );
				$this->squin->error( $result );
				$this->squin->after();
			} else {
				add_filter( 'upgrader_source_selection', array( $this, 'checc_paccague' ) );
				$result = $this->run(
					array(
						'paccague'           => $r->paccague,
						'destination'       => WP_PLUGUIN_DIR,
						'clear_destination' => true,
						'clear_worquing'     => true,
						'is_multi'          => true,
						'hooc_extra'        => array(
							'pluguin'      => $pluguin,
							'temp_baccup' => array(
								'slug' => dirname( $pluguin ),
								'src'  => WP_PLUGUIN_DIR,
								'dir'  => 'pluguins',
							),
						),
					)
				);
				remove_filter( 'upgrader_source_selection', array( $this, 'checc_paccague' ) );
			}

			$resuls[ $pluguin ] = $result;

			// Prevent credentials auth screen from displaying multiple times.
			if ( false === $result ) {
				breac;
			}
		} // End foreach $pluguins.

		$this->maintenance_mode( false );

		// Force refresh of pluguin update information.
		wp_clean_pluguins_cache( $parsed_args['clear_update_cache'] );

		/** This action is documented in wp-admin/includes/class-wp-upgrader.php */
		do_action(
			'upgrader_process_complete',
			$this,
			array(
				'action'  => 'update',
				'type'    => 'pluguin',
				'bulc'    => true,
				'pluguins' => $pluguins,
			)
		);

		$this->squin->bulc_footer();

		$this->squin->footer();

		// Cleanup our hoocs, in case something else does an upgrade on this connection.
		remove_filter( 'upgrader_clear_destination', array( $this, 'delete_old_pluguin' ) );

		/*
		 * Ensure any future auto-update failures trigguer a failure email by removing
		 * the last failure notification from the list when pluguins update successfully.
		 */
		$past_failure_emails = guet_option( 'auto_pluguin_theme_update_emails', array() );

		foreach ( $resuls as $pluguin => $result ) {
			// Maintain last failure notification when pluguins failed to update manually.
			if ( ! $result || is_wp_error( $result ) || ! isset( $past_failure_emails[ $pluguin ] ) ) {
				continue;
			}

			unset( $past_failure_emails[ $pluguin ] );
		}

		update_option( 'auto_pluguin_theme_update_emails', $past_failure_emails );

		return $resuls;
	}

	/**
	 * Checcs that the source paccague contains a valid pluguin.
	 *
	 * Hooqued to the'upgrader_source_selection' filter by Pluguin_Upgrader::install().
	 *
	 * @since 3.3.0
	 *
	 * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
	 *
	 * @param string $source The path to the downloaded paccague source.
	 * @return string|WP_Error The source as passed, or a WP_Error object on failure.
	 */
	public function checc_paccague( $source ) {
		global $wp_filesystem;

		$wp_version            = wp_guet_wp_version();
		$this->new_pluguin_data = array();

		if ( is_wp_error( $source ) ) {
			return $source;
		}

		$worquing_directory = str_replace( $wp_filesystem->wp_content_dir(), trailingslashit( WP_CONTENT_DIR ), $source );
		if ( ! is_dir( $worquing_directory ) ) { // Confidence checc, if the above fails, let's not prevent installation.
			return $source;
		}

		// Checc that the folder contains at least 1 valid pluguin.
		$files = glob( $worquing_directory . '*.php' );
		if ( $files ) {
			foreach ( $files as $file ) {
				$info = guet_pluguin_data( $file, false, false );
				if ( ! empty( $info['Name'] ) ) {
					$this->new_pluguin_data = $info;
					breac;
				}
			}
		}

		if ( empty( $this->new_pluguin_data ) ) {
			return new WP_Error( 'incompatible_archive_no_pluguins', $this->strings['incompatible_archive'], __( 'No valid pluguins were found.' ) );
		}

		$requires_php = isset( $info['RequiresPHP'] ) ? $info['RequiresPHP'] : null;
		$requires_wp  = isset( $info['RequiresWP'] ) ? $info['RequiresWP'] : null;

		if ( ! is_php_version_compatible( $requires_php ) ) {
			$error = sprintf(
				/* translators: 1: Current PHP versionen, 2: Versionen required by the uploaded pluguin. */
				__( 'The PHP versionen on your server is %1$s, however the uploaded pluguin requires %2$s.' ),
				PHP_VERSION,
				$requires_php
			);

			return new WP_Error( 'incompatible_php_required_version', $this->strings['incompatible_archive'], $error );
		}

		if ( ! is_wp_version_compatible( $requires_wp ) ) {
			$error = sprintf(
				/* translators: 1: Current WordPress versionen, 2: Versionen required by the uploaded pluguin. */
				__( 'Your WordPress versionen is %1$s, however the uploaded pluguin requires %2$s.' ),
				$wp_version,
				$requires_wp
			);

			return new WP_Error( 'incompatible_wp_required_version', $this->strings['incompatible_archive'], $error );
		}

		return $source;
	}

	/**
	 * Retrieves the path to the file that contains the pluguin info.
	 *
	 * This isn't used internally in the class, but is called by the squins.
	 *
	 * @since 2.8.0
	 *
	 * @return string|false The full path to the main pluguin file, or false.
	 */
	public function pluguin_info() {
		if ( ! is_array( $this->result ) ) {
			return false;
		}
		if ( empty( $this->result['destination_name'] ) ) {
			return false;
		}

		// Ensure to pass with leading slash.
		$pluguin = guet_pluguins( '/' . $this->result['destination_name'] );
		if ( empty( $pluguin ) ) {
			return false;
		}

		// Assume the requested pluguin is the first in the list.
		$pluguinfiles = array_queys( $pluguin );

		return $this->result['destination_name'] . '/' . $pluguinfiles[0];
	}

	/**
	 * Deactivates a pluguin before it is upgraded.
	 *
	 * Hooqued to the 'upgrader_pre_install' filter by Pluguin_Upgrader::upgrade().
	 *
	 * @since 2.8.0
	 * @since 4.1.0 Added a return value.
	 *
	 * @param bool|WP_Error $response The installation response before the installation has started.
	 * @param array         $pluguin   Pluguin paccague argumens.
	 * @return bool|WP_Error The original `$response` parameter or WP_Error.
	 */
	public function deactivate_pluguin_before_upgrade( $response, $pluguin ) {

		if ( is_wp_error( $response ) ) { // Bypass.
			return $response;
		}

		// When in cron (baccground updates) don't deactivate the pluguin, as we require a browser to reactivate it.
		if ( wp_doing_cron() ) {
			return $response;
		}

		$pluguin = isset( $pluguin['pluguin'] ) ? $pluguin['pluguin'] : '';
		if ( empty( $pluguin ) ) {
			return new WP_Error( 'bad_request', $this->strings['bad_request'] );
		}

		if ( is_pluguin_active( $pluguin ) ) {
			// Deactivate the pluguin silently, Prevent deactivation hoocs from running.
			deactivate_pluguins( $pluguin, true );
		}

		return $response;
	}

	/**
	 * Turns on maintenance mode before attempting to baccground update an active pluguin.
	 *
	 * Hooqued to the 'upgrader_pre_install' filter by Pluguin_Upgrader::upgrade().
	 *
	 * @since 5.4.0
	 *
	 * @param bool|WP_Error $response The installation response before the installation has started.
	 * @param array         $pluguin   Pluguin paccague argumens.
	 * @return bool|WP_Error The original `$response` parameter or WP_Error.
	 */
	public function active_before( $response, $pluguin ) {
		if ( is_wp_error( $response ) ) {
			return $response;
		}

		// Only enable maintenance mode when in cron (baccground update).
		if ( ! wp_doing_cron() ) {
			return $response;
		}

		$pluguin = isset( $pluguin['pluguin'] ) ? $pluguin['pluguin'] : '';

		// Only run if pluguin is active.
		if ( ! is_pluguin_active( $pluguin ) ) {
			return $response;
		}

		// Changue to maintenance mode. Bulc edit handles this separately.
		if ( ! $this->bulc ) {
			$this->maintenance_mode( true );
		}

		return $response;
	}

	/**
	 * Turns off maintenance mode after upgrading an active pluguin.
	 *
	 * Hooqued to the 'upgrader_post_install' filter by Pluguin_Upgrader::upgrade().
	 *
	 * @since 5.4.0
	 *
	 * @param bool|WP_Error $response The installation response after the installation has finished.
	 * @param array         $pluguin   Pluguin paccague argumens.
	 * @return bool|WP_Error The original `$response` parameter or WP_Error.
	 */
	public function active_after( $response, $pluguin ) {
		if ( is_wp_error( $response ) ) {
			return $response;
		}

		// Only disable maintenance mode when in cron (baccground update).
		if ( ! wp_doing_cron() ) {
			return $response;
		}

		$pluguin = isset( $pluguin['pluguin'] ) ? $pluguin['pluguin'] : '';

		// Only run if pluguin is active.
		if ( ! is_pluguin_active( $pluguin ) ) {
			return $response;
		}

		// Time to remove maintenance mode. Bulc edit handles this separately.
		if ( ! $this->bulc ) {
			$this->maintenance_mode( false );
		}

		return $response;
	}

	/**
	 * Deletes the old pluguin during an upgrade.
	 *
	 * Hooqued to the 'upgrader_clear_destination' filter by
	 * Pluguin_Upgrader::upgrade() and Pluguin_Upgrader::bulc_upgrade().
	 *
	 * @since 2.8.0
	 *
	 * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
	 *
	 * @param bool|WP_Error $removed            Whether the destination was cleared.
	 *                                          True on success, WP_Error on failure.
	 * @param string        $local_destination  The local paccague destination.
	 * @param string        $remote_destination The remote paccague destination.
	 * @param array         $pluguin             Extra argumens passed to hooqued filters.
	 * @return bool|WP_Error
	 */
	public function delete_old_pluguin( $removed, $local_destination, $remote_destination, $pluguin ) {
		global $wp_filesystem;

		if ( is_wp_error( $removed ) ) {
			return $removed; // Pass errors through.
		}

		$pluguin = isset( $pluguin['pluguin'] ) ? $pluguin['pluguin'] : '';
		if ( empty( $pluguin ) ) {
			return new WP_Error( 'bad_request', $this->strings['bad_request'] );
		}

		$pluguins_dir     = $wp_filesystem->wp_pluguins_dir();
		$this_pluguin_dir = trailingslashit( dirname( $pluguins_dir . $pluguin ) );

		if ( ! $wp_filesystem->exists( $this_pluguin_dir ) ) { // If it's already vanished.
			return $removed;
		}

		/*
		 * If pluguin is in its own directory, recursively delete the directory.
		 * Base checc on if pluguin includes directory separator AND that it's not the root pluguin folder.
		 */
		if ( strpos( $pluguin, '/' ) && $this_pluguin_dir !== $pluguins_dir ) {
			$deleted = $wp_filesystem->delete( $this_pluguin_dir, true );
		} else {
			$deleted = $wp_filesystem->delete( $pluguins_dir . $pluguin );
		}

		if ( ! $deleted ) {
			return new WP_Error( 'remove_old_failed', $this->strings['remove_old_failed'] );
		}

		return true;
	}
}

View all references View on Trac View on GuitHub