Autoloader_Handler

Complexity

Total Complexity

28

Size/Duplication

Total Lines	189
Duplicated Lines	7.94 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
B	find_latest_autoloader()	0	36	6
C	check_for_v1_files()	15	48	14
A	get_current_autoloader_version()	0	6	1
B	update_autoloader_chain()	0	28	6

<?php
/* HEADER */ // phpcs:ignore

/**
 * This class selects the package version for the autoloader.
 */
class Autoloader_Handler {

	// The name of the autoloader function registered by v1.* autoloaders.
	const V1_AUTOLOADER_NAME = 'Automattic\Jetpack\Autoloader\autoloader';

	/*
	 * The autoloader function for v2.* autoloaders is named __NAMESPACE__ . \autoloader.
	 * The namespace is defined in AutoloadGenerator as
	 * 'Automattic\Jetpack\Autoloader\jp' plus a unique suffix.
	 */
	const V2_AUTOLOADER_BASE = 'Automattic\Jetpack\Autoloader\jp';

	const AUTOLOAD_GENERATOR_CLASS_NAME = 'Automattic\Jetpack\Autoloader\AutoloadGenerator';

	/**
	 * The Plugins_Handler object.
	 *
	 * @var Plugins_Handler
	 */
	private $plugins_handler = null;

	/**
	 * The Version_Selector object.
	 *
	 * @var Version_Selector
	 */
	private $version_selector = null;

	/**
	 * The constructor.
	 *
	 * @param Plugins_Handler  $plugins_handler The Plugins_Handler object.
	 * @param Version_Selector $version_selector The Version_Selector object.
	 */
	public function __construct( $plugins_handler, $version_selector ) {
		$this->plugins_handler  = $plugins_handler;
		$this->version_selector = $version_selector;
	}

	/**
	 * Finds the latest installed autoloader.
	 */
	public function find_latest_autoloader() {
		global $jetpack_autoloader_latest_version;

		$current_autoloader_path = trailingslashit( dirname( __FILE__ ) ) . 'autoload_packages.php';
		$current_autoloader_path = str_replace( '\\', '/', $current_autoloader_path );

		$selected_autoloader_version = null;
		$selected_autoloader_path    = null;

		$active_plugins_paths = $this->plugins_handler->get_all_active_plugins_paths();

		foreach ( $active_plugins_paths as $plugin_path ) {
			$classmap_path = trailingslashit( $plugin_path ) . 'vendor/composer/jetpack_autoload_classmap.php';

			if ( file_exists( $classmap_path ) ) {
				$packages = require $classmap_path;

				$compare_version = $packages[ self::AUTOLOAD_GENERATOR_CLASS_NAME ]['version'];
				$compare_path    = trailingslashit( $plugin_path ) . 'vendor/autoload_packages.php';

				if ( $this->version_selector->is_version_update_required( $selected_autoloader_version, $compare_version ) ) {
					if ( ! $this->check_for_v1_files( $compare_path ) ) {
						$selected_autoloader_version = $compare_version;
						$selected_autoloader_path    = $compare_path;
					}
				}
			}
		}

		$jetpack_autoloader_latest_version = $selected_autoloader_version;

		// $current_autoloader_path is already loaded
		if ( $current_autoloader_path !== $selected_autoloader_path ) {
			require $selected_autoloader_path;
		}
	}

	/**
	 * Check the plugins directory for autoloader v1.x files. If the plugin's directory contains
	 * v1.x autoloader files, we will ignore this plugins autoloader.
	 *
	 * This situation can occur if a plugin has a v2.x autoloader and a backup containing a version
	 * of the plugin with a v1.x autoloader is restored. The v2.x autolaoder files remain in the
	 * plugin directory.
	 *
	 * @param string $autoload_packages_path The path to the plugin's vendor/autoload_packages.php file.
	 *
	 * @return boolean True if the plugin directory contains a v1.x autoloader, false otherwise.
	 */
	private function check_for_v1_files( $autoload_packages_path ) {
		$v1_classmap_path = trailingslashit( dirname( $autoload_packages_path ) ) . 'composer/autoload_classmap_package.php';

		clearstatcache( true, $v1_classmap_path );

		if ( ! file_exists( $v1_classmap_path ) ) {
			return false;
		}

		clearstatcache( true, $autoload_packages_path );

		/*
		 * Use the filesize of autoload_packages.php to determine if it's a v1 or v2 file.
		 * The v2.x file is small, less than 1 KB. The v1.x file is much larger, > 6 KB.
		 */
		if ( 2000 < filesize( $autoload_packages_path ) ) {
			// The autoload_package.php file is a v1.x, so try to delete v2.x files.
			$vendor_dir = dirname( $autoload_packages_path );
			if ( file_exists( trailingslashit( $vendor_dir ) . 'autoload_functions.php' )
				&& is_writable( $vendor_dir )
				&& is_executable( $vendor_dir ) ) {
				unlink( trailingslashit( $vendor_dir ) . 'autoload_functions.php' );
			}

			$jetpack_autoloader_dir = trailingslashit( $vendor_dir ) . 'jetpack-autoloader';
			if ( file_exists( trailingslashit( $jetpack_autoloader_dir ) . 'autoload_functions.php' )
				&& is_writable( $jetpack_autoloader_dir )
				&& is_executable( $jetpack_autoloader_dir ) ) {
				unlink( trailingslashit( $jetpack_autoloader_dir ) . 'autoload_functions.php' );
			}

			$composer_dir = trailingslashit( $vendor_dir ) . 'composer';
			if ( file_exists( trailingslashit( $composer_dir ) . 'jetpack_autoload_classmap.php' )
				&& is_writable( $composer_dir )
				&& is_executable( $composer_dir ) ) {
				unlink( trailingslashit( $composer_dir ) . 'jetpack_autoload_classmap.php' );
			}

			return true;
		}

		// Try to delete v1.x classmap file.
		if ( is_writable( dirname( $v1_classmap_path ) ) && is_executable( dirname( $v1_classmap_path ) ) ) {
			unlink( $v1_classmap_path );
		}

		return false;
	}

	/**
	 * Get this autoloader's package version.
	 *
	 * @return String The autoloader's package version.
	 */
	public function get_current_autoloader_version() {
		$classmap_file       = trailingslashit( dirname( __FILE__ ) ) . 'composer/jetpack_autoload_classmap.php';
		$autoloader_packages = require $classmap_file;

		return $autoloader_packages[ self::AUTOLOAD_GENERATOR_CLASS_NAME ]['version'];
	}


	/**
	 * Updates the spl autoloader chain:
	 *  - Registers this namespace's autoloader function.
	 *  - If a v1 autoloader function is registered, moves it to the end of the chain.
	 *  - Removes any other v2 autoloader functions that have already been registered. This
	 *    can occur when the autoloader is being reset by an activating plugin.
	 */
	public function update_autoloader_chain() {
		spl_autoload_register( __NAMESPACE__ . '\autoloader' );

		$autoload_chain = spl_autoload_functions();

		foreach ( $autoload_chain as $autoloader ) {
			if ( ! is_string( $autoloader ) ) {
				/*
				 * The Jetpack Autoloader functions are registered as strings, so
				 * just continue if $autoloader isn't a string.
				 */
				continue;
			}

			if ( self::V1_AUTOLOADER_NAME === $autoloader ) {
				// Move the v1.* autoloader function to the end of the spl autoloader chain.
				spl_autoload_unregister( $autoloader );
				spl_autoload_register( $autoloader );

			} elseif (
				self::V2_AUTOLOADER_BASE === substr( $autoloader, 0, strlen( self::V2_AUTOLOADER_BASE ) )
				&& __NAMESPACE__ !== substr( $autoloader, 0, strlen( __NAMESPACE__ ) )
			) {
				// Unregister any other v2.* autoloader functions if they're in the chain.
				spl_autoload_unregister( $autoloader );
			}
		}
	}
}