php-phpbb/phpBB/phpbb/composer/installer.php

<?php
/**
 *
 * This file is part of the phpBB Forum Software package.
 *
 * @copyright (c) phpBB Limited <https://www.phpbb.com>
 * @license GNU General Public License, version 2 (GPL-2.0)
 *
 * For full copyright and license information, please see
 * the docs/CREDITS.txt file.
 *
 */

namespace phpbb\composer;

use Composer\Composer;
use Composer\Factory;
use Composer\IO\BufferIO;
use Composer\IO\NullIO;
use Composer\Json\JsonFile;
use Composer\Package\CompletePackage;
use Composer\Package\PackageInterface;
use Composer\Repository\ComposerRepository;
use Composer\Repository\RepositoryInterface;
use Composer\Util\RemoteFilesystem;
use phpbb\config\config;
use phpbb\exception\runtime_exception;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * Class to install packages through composer while freezing core dependencies.
 */
class installer
{
	const PHPBB_TYPES = ['phpbb-extension', 'phpbb-style', 'phpbb-language'];

	/**
	 * @var array Repositories to look packages from
	 */
	protected $repositories = [];

	/**
	 * @var bool Indicates whether packagist usage is allowed or not
	 */
	protected $packagist = false;

	/**
	 * @var string Composer filename used to manage the packages
	 */
	protected $composer_filename = 'composer-ext.json';

	/**
	 * @var string Directory where to install packages vendors
	 */
	protected $packages_vendor_dir = 'vendor-ext/';

	/**
	 * @var string phpBB root path
	 */
	protected $root_path;

	/**
	 * @param \phpbb\config\config	$config		Config object
	 * @param string				$root_path	phpBB root path
	 */
	public function __construct($root_path, config $config = null)
	{
		if ($config)
		{
			$this->repositories        = (array) unserialize($config['exts_composer_repositories']);
			$this->packagist           = (bool) $config['exts_composer_packagist'];
			$this->composer_filename   = $config['exts_composer_json_file'];
			$this->packages_vendor_dir = $config['exts_composer_vendor_dir'];
		}

		$this->repositories = ['http://phpbb.local/ext/phpbb/titania/composer/'];
		$this->packagist = true;

		$this->root_path = $root_path;
	}

	/**
	 * Update the current installed set of packages
	 *
	 * @param array $packages Packages to install.
	 *        Each entry may be a name or an array associating a version constraint to a name
	 * @param array $whitelist White-listed packages (packages that can be installed/updated/removed)
	 * @throws runtime_exception
	 */
	public function install(array $packages, $whitelist)
	{
		$this->generate_ext_json_file($packages);

		$original_vendor_dir = getenv('COMPOSER_VENDOR_DIR');
		putenv('COMPOSER_VENDOR_DIR=' . $this->root_path . $this->packages_vendor_dir);

		$io = new BufferIO('', OutputInterface::VERBOSITY_DEBUG);
		$composer = Factory::create($io, $this->get_composer_ext_json_filename(), false);
		$install = \Composer\Installer::create($io, $composer);

		$install
			->setVerbose(true)
			->setPreferSource(false)
			->setPreferDist(true)
			->setDevMode(false)
			->setUpdate(true)
			->setUpdateWhitelist($whitelist)
			->setWhitelistDependencies(false)
			->setIgnorePlatformRequirements(false)
			->setDumpAutoloader(false)
			->setPreferStable(true)
			->setRunScripts(false)
			->setDryRun(false);

		try
		{
			$install->run();
			$output = $io->getOutput();
			$error_pos = strpos($output, 'Your requirements could not be resolved to an installable set of packages.');

			if ($error_pos)
			{
				// TODO Extract the precise error and use language string
				throw new \RuntimeException(substr($output, $error_pos));
			}
		}
		catch (\Exception $e)
		{
			throw new runtime_exception('Cannot install packages', [], $e);
		}
		finally
		{
			putenv('COMPOSER_VENDOR_DIR=' . $original_vendor_dir);
		}
	}

	/**
	 * Returns the list of currently installed packages
	 *
	 * @param string|array $types Returns only the packages with the given type(s)
	 *
	 * @return array The installed packages associated to their version.
	 */
	public function get_installed_packages($types)
	{
		$types = (array) $types;

		$original_vendor_dir = getenv('COMPOSER_VENDOR_DIR');

		try
		{
			$io = new NullIO();
			putenv('COMPOSER_VENDOR_DIR=' . $this->root_path . $this->packages_vendor_dir);
			$composer = Factory::create($io, $this->get_composer_ext_json_filename(), false);

			$installed = [];
			$packages = $composer->getRepositoryManager()->getLocalRepository()->getCanonicalPackages();

			foreach ($packages as $package)
			{
				if (in_array($package->getType(), $types, true))
				{
					$installed[$package->getName()] = $package->getPrettyVersion();
				}
			}

			return $installed;
		}
		catch (\Exception $e)
		{
			return [];
		}
		finally
		{
			putenv('COMPOSER_VENDOR_DIR=' . $original_vendor_dir);
		}
	}

	/**
	 * Gets the list of the available packages of the configured type in the configured repositories
	 *
	 * @param string $type Returns only the packages with the given type
	 *
	 * @return array The name of the available packages, associated to their definition. Ordered by name.
	 */
	public function get_available_packages($type)
	{
		try
		{
			$this->generate_ext_json_file($this->get_installed_packages(self::PHPBB_TYPES));

			$io = new NullIO();

			$composer = Factory::create($io, $this->get_composer_ext_json_filename(), false);

			$available = [];
			$repositories = $composer->getRepositoryManager()->getRepositories();

			/** @var RepositoryInterface $repository */
			foreach ($repositories as $repository)
			{
				if ($repository instanceof ComposerRepository && $repository->hasProviders())
				{
					$r = new \ReflectionObject($repository);
					$repo_url = $r->getProperty('url');
					$repo_url->setAccessible(true);

					if ($repo_url->getValue($repository) === 'http://packagist.org')
					{
						$url      = 'https://packagist.org/packages/list.json?type=' . $type;
						$rfs      = new RemoteFilesystem($io);
						$hostname = parse_url($url, PHP_URL_HOST) ?: $url;
						$json     = $rfs->getContents($hostname, $url, false);

						/** @var PackageInterface $package */
						foreach (JsonFile::parseJson($json, $url)['packageNames'] as $package)
						{
							$packages = $repository->findPackages($package);
							$package = array_pop($packages);

							if (isset($available[$package->getName()]))
							{
								continue;
							}

							$available[$package->getName()] = ['name' => $package->getPrettyName()];

							if ($package instanceof CompletePackage)
							{
								$available[$package->getName()]['description'] = $package->getDescription();
								$available[$package->getName()]['url'] = $package->getDistUrl();//getHomepage();
							}
						}
					}
				}
				else
				{
					/** @var PackageInterface $package */
					foreach ($repository->getPackages() as $package)
					{
						if ($package->getType() === $type)
						{
							$available[$package->getName()] = ['name' => $package];

							if ($package instanceof CompletePackage)
							{
								$available[$package->getName()]['description'] = $package->getDescription();
								$available[$package->getName()]['url'] = $package->getDistUrl();//getHomepage();
							}
						}
					}
				}
			}

			ksort($available);

			return $available;
		}
		catch (\Exception $e)
		{
			return [];
		}
	}

	/**
	 * Generates and write the json file used to install the set of packages
	 *
	 * @param array $packages Packages to update.
	 *        Each entry may be a name or an array associating a version constraint to a name
	 */
	protected function generate_ext_json_file(array $packages)
	{
		$io = new NullIO();
		$composer = Factory::create($io, null, false);

		$core_packages = $this->get_core_packages($composer);
		$core_json_data = [
			'require' => array_merge(
				['php' => $this->get_core_php_requirement($composer)],
				$core_packages,
				$this->get_extra_dependencies(),
				$packages),
			'replace' => $core_packages,
			'repositories' => $this->get_composer_repositories(),
		];

		$json_file = new JsonFile($this->get_composer_ext_json_filename());
		$json_file->write($core_json_data);
	}

	/**
	 * Get the core installed packages
	 *
	 * @param Composer $composer Composer object to load the dependencies
	 * @return array The core packages with their version
	 */
	protected function get_core_packages(Composer $composer)
	{
		$core_deps = [];
		$packages = $composer->getRepositoryManager()->getLocalRepository()->getCanonicalPackages();

		foreach ($packages as $package)
		{
			$core_deps[$package->getName()] = $package->getPrettyVersion();
		}

		$core_deps['phpbb/phpbb'] = $composer->getPackage()->getPrettyVersion();

		return $core_deps;
	}

	/**
	 * Get the PHP version required by the core
	 *
	 * @param Composer $composer Composer object to load the dependencies
	 * @return string The PHP version required by the core
	 */
	protected function get_core_php_requirement(Composer $composer)
	{
		return $composer->getLocker()->getLockData()['platform']['php'];
	}

	/**
	 * Generate the repositories entry of the packages json file
	 *
	 * @return array repositories entry
	 */
	protected function get_composer_repositories()
	{
		$repositories = [];

		if (!$this->packagist)
		{
			$repositories[]['packagist'] = false;
		}

		foreach ($this->repositories as $repository)
		{
			$repositories[] = [
				'type'	=> 'composer',
				'url'	=> $repository,
			];
		}

		return $repositories;
	}

	/**
	 * Get the name of the json file used for the packages.
	 *
	 * @return string The json filename
	 */
	protected function get_composer_ext_json_filename()
	{
		return $this->root_path . $this->composer_filename;
	}

	/**
	 * Get extra dependencies required to install the packages
	 *
	 * @return array Array of composer dependencies
	 */
	protected function get_extra_dependencies()
	{
		return [];
	}

	/**
	 * Sets the customs repositories
	 *
	 * @param array $repositories An array of composer repositories to use
	 */
	public function set_repositories($repositories)
	{
		$this->repositories = $repositories;
	}

	/**
	 * Allow or disallow packagist
	 *
	 * @param boolean $packagist
	 */
	public function set_packagist($packagist)
	{
		$this->packagist = $packagist;
	}

	/**
	 * Sets the name of the managed packages' json file
	 *
	 * @param string $composer_filename
	 */
	public function set_composer_filename($composer_filename)
	{
		$this->composer_filename = $composer_filename;
	}

	/**
	 * Sets the location of the managed packages' vendors
	 *
	 * @param string $packages_vendor_dir
	 */
	public function set_packages_vendor_dir($packages_vendor_dir)
	{
		$this->packages_vendor_dir = $packages_vendor_dir;
	}

	/**
	 * Sets the phpBB root path
	 *
	 * @param string $root_path
	 */
	public function set_root_path($root_path)
	{
		$this->root_path = $root_path;
	}
}