312 lines
10 KiB
PHP
312 lines
10 KiB
PHP
|
<?php
|
||
|
|
|
||
|
|
/*
|
||
|
|
* This file is part of Composer.
|
||
|
|
*
|
||
|
|
* (c) Nils Adermann <naderman@naderman.de>
|
||
|
|
* Jordi Boggiano <j.boggiano@seld.be>
|
||
|
|
*
|
||
|
|
* For the full copyright and license information, please view the LICENSE
|
||
|
|
* file that was distributed with this source code.
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace Composer;
|
||
|
|
|
||
|
|
use Composer\Autoload\ClassLoader;
|
||
|
|
use Composer\Semver\VersionParser;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This class is copied in every Composer installed project and available to all
|
||
|
|
*
|
||
|
|
* To require it's presence, you can require `composer-runtime-api ^2.0`
|
||
|
|
*/
|
||
|
|
class InstalledVersions
|
||
|
|
{
|
||
|
|
private static $installed = array (
|
||
|
|
'root' =>
|
||
|
|
array (
|
||
|
|
'pretty_version' => 'dev-main',
|
||
|
|
'version' => 'dev-main',
|
||
|
|
'aliases' =>
|
||
|
|
array (
|
||
|
|
),
|
||
|
|
'reference' => '311e243ca5c94983372d3e1f78bd29ffdcdd9eeb',
|
||
|
|
'name' => '__root__',
|
||
|
|
),
|
||
|
|
'versions' =>
|
||
|
|
array (
|
||
|
|
'__root__' =>
|
||
|
|
array (
|
||
|
|
'pretty_version' => 'dev-main',
|
||
|
|
'version' => 'dev-main',
|
||
|
|
'aliases' =>
|
||
|
|
array (
|
||
|
|
),
|
||
|
|
'reference' => '311e243ca5c94983372d3e1f78bd29ffdcdd9eeb',
|
||
|
|
),
|
||
|
|
'mikehaertl/php-shellcommand' =>
|
||
|
|
array (
|
||
|
|
'pretty_version' => '1.6.4',
|
||
|
|
'version' => '1.6.4.0',
|
||
|
|
'aliases' =>
|
||
|
|
array (
|
||
|
|
),
|
||
|
|
'reference' => '3488d7803df1e8f1a343d3d0ca452d527ad8d5e5',
|
||
|
|
),
|
||
|
|
'mikehaertl/php-tmpfile' =>
|
||
|
|
array (
|
||
|
|
'pretty_version' => '1.2.1',
|
||
|
|
'version' => '1.2.1.0',
|
||
|
|
'aliases' =>
|
||
|
|
array (
|
||
|
|
),
|
||
|
|
'reference' => '70a5b70b17bc0d9666388e6a551ecc93d0b40a10',
|
||
|
|
),
|
||
|
|
'mikehaertl/phpwkhtmltopdf' =>
|
||
|
|
array (
|
||
|
|
'pretty_version' => '2.5.0',
|
||
|
|
'version' => '2.5.0.0',
|
||
|
|
'aliases' =>
|
||
|
|
array (
|
||
|
|
),
|
||
|
|
'reference' => '17ee71341591415d942774eda2c98d8ba7ea9e90',
|
||
|
|
),
|
||
|
|
),
|
||
|
|
);
|
||
|
|
private static $canGetVendors;
|
||
|
|
private static $installedByVendor = array();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns a list of all package names which are present, either by being installed, replaced or provided
|
||
|
|
*
|
||
|
|
* @return string[]
|
||
|
|
* @psalm-return list<string>
|
||
|
|
*/
|
||
|
|
public static function getInstalledPackages()
|
||
|
|
{
|
||
|
|
$packages = array();
|
||
|
|
foreach (self::getInstalled() as $installed) {
|
||
|
|
$packages[] = array_keys($installed['versions']);
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
if (1 === \count($packages)) {
|
||
|
|
return $packages[0];
|
||
|
|
}
|
||
|
|
|
||
|
|
return array_keys(array_flip(\call_user_func_array('array_merge', $packages)));
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Checks whether the given package is installed
|
||
|
|
*
|
||
|
|
* This also returns true if the package name is provided or replaced by another package
|
||
|
|
*
|
||
|
|
* @param string $packageName
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public static function isInstalled($packageName)
|
||
|
|
{
|
||
|
|
foreach (self::getInstalled() as $installed) {
|
||
|
|
if (isset($installed['versions'][$packageName])) {
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Checks whether the given package satisfies a version constraint
|
||
|
|
*
|
||
|
|
* e.g. If you want to know whether version 2.3+ of package foo/bar is installed, you would call:
|
||
|
|
*
|
||
|
|
* Composer\InstalledVersions::satisfies(new VersionParser, 'foo/bar', '^2.3')
|
||
|
|
*
|
||
|
|
* @param VersionParser $parser Install composer/semver to have access to this class and functionality
|
||
|
|
* @param string $packageName
|
||
|
|
* @param string|null $constraint A version constraint to check for, if you pass one you have to make sure composer/semver is required by your package
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public static function satisfies(VersionParser $parser, $packageName, $constraint)
|
||
|
|
{
|
||
|
|
$constraint = $parser->parseConstraints($constraint);
|
||
|
|
$provided = $parser->parseConstraints(self::getVersionRanges($packageName));
|
||
|
|
|
||
|
|
return $provided->matches($constraint);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns a version constraint representing all the range(s) which are installed for a given package
|
||
|
|
*
|
||
|
|
* It is easier to use this via isInstalled() with the $constraint argument if you need to check
|
||
|
|
* whether a given version of a package is installed, and not just whether it exists
|
||
|
|
*
|
||
|
|
* @param string $packageName
|
||
|
|
* @return string Version constraint usable with composer/semver
|
||
|
|
*/
|
||
|
|
public static function getVersionRanges($packageName)
|
||
|
|
{
|
||
|
|
foreach (self::getInstalled() as $installed) {
|
||
|
|
if (!isset($installed['versions'][$packageName])) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
$ranges = array();
|
||
|
|
if (isset($installed['versions'][$packageName]['pretty_version'])) {
|
||
|
|
$ranges[] = $installed['versions'][$packageName]['pretty_version'];
|
||
|
|
}
|
||
|
|
if (array_key_exists('aliases', $installed['versions'][$packageName])) {
|
||
|
|
$ranges = array_merge($ranges, $installed['versions'][$packageName]['aliases']);
|
||
|
|
}
|
||
|
|
if (array_key_exists('replaced', $installed['versions'][$packageName])) {
|
||
|
|
$ranges = array_merge($ranges, $installed['versions'][$packageName]['replaced']);
|
||
|
|
}
|
||
|
|
if (array_key_exists('provided', $installed['versions'][$packageName])) {
|
||
|
|
$ranges = array_merge($ranges, $installed['versions'][$packageName]['provided']);
|
||
|
|
}
|
||
|
|
|
||
|
|
return implode(' || ', $ranges);
|
||
|
|
}
|
||
|
|
|
||
|
|
throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed');
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $packageName
|
||
|
|
* @return string|null If the package is being replaced or provided but is not really installed, null will be returned as version, use satisfies or getVersionRanges if you need to know if a given version is present
|
||
|
|
*/
|
||
|
|
public static function getVersion($packageName)
|
||
|
|
{
|
||
|
|
foreach (self::getInstalled() as $installed) {
|
||
|
|
if (!isset($installed['versions'][$packageName])) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!isset($installed['versions'][$packageName]['version'])) {
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
|
||
|
|
return $installed['versions'][$packageName]['version'];
|
||
|
|
}
|
||
|
|
|
||
|
|
throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed');
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $packageName
|
||
|
|
* @return string|null If the package is being replaced or provided but is not really installed, null will be returned as version, use satisfies or getVersionRanges if you need to know if a given version is present
|
||
|
|
*/
|
||
|
|
public static function getPrettyVersion($packageName)
|
||
|
|
{
|
||
|
|
foreach (self::getInstalled() as $installed) {
|
||
|
|
if (!isset($installed['versions'][$packageName])) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!isset($installed['versions'][$packageName]['pretty_version'])) {
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
|
||
|
|
return $installed['versions'][$packageName]['pretty_version'];
|
||
|
|
}
|
||
|
|
|
||
|
|
throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed');
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $packageName
|
||
|
|
* @return string|null If the package is being replaced or provided but is not really installed, null will be returned as reference
|
||
|
|
*/
|
||
|
|
public static function getReference($packageName)
|
||
|
|
{
|
||
|
|
foreach (self::getInstalled() as $installed) {
|
||
|
|
if (!isset($installed['versions'][$packageName])) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!isset($installed['versions'][$packageName]['reference'])) {
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
|
||
|
|
return $installed['versions'][$packageName]['reference'];
|
||
|
|
}
|
||
|
|
|
||
|
|
throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed');
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return array
|
||
|
|
* @psalm-return array{name: string, version: string, reference: string, pretty_version: string, aliases: string[]}
|
||
|
|
*/
|
||
|
|
public static function getRootPackage()
|
||
|
|
{
|
||
|
|
$installed = self::getInstalled();
|
||
|
|
|
||
|
|
return $installed[0]['root'];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the raw installed.php data for custom implementations
|
||
|
|
*
|
||
|
|
* @return array[]
|
||
|
|
* @psalm-return array{root: array{name: string, version: string, reference: string, pretty_version: string, aliases: string[]}, versions: list<string, array{pretty_version: ?string, version: ?string, aliases: ?string[], reference: ?string, replaced: ?string[], provided: ?string[]}>}
|
||
|
|
*/
|
||
|
|
public static function getRawData()
|
||
|
|
{
|
||
|
|
return self::$installed;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Lets you reload the static array from another file
|
||
|
|
*
|
||
|
|
* This is only useful for complex integrations in which a project needs to use
|
||
|
|
* this class but then also needs to execute another project's autoloader in process,
|
||
|
|
* and wants to ensure both projects have access to their version of installed.php.
|
||
|
|
*
|
||
|
|
* A typical case would be PHPUnit, where it would need to make sure it reads all
|
||
|
|
* the data it needs from this class, then call reload() with
|
||
|
|
* `require $CWD/vendor/composer/installed.php` (or similar) as input to make sure
|
||
|
|
* the project in which it runs can then also use this class safely, without
|
||
|
|
* interference between PHPUnit's dependencies and the project's dependencies.
|
||
|
|
*
|
||
|
|
* @param array[] $data A vendor/composer/installed.php data set
|
||
|
|
* @return void
|
||
|
|
*
|
||
|
|
* @psalm-param array{root: array{name: string, version: string, reference: string, pretty_version: string, aliases: string[]}, versions: list<string, array{pretty_version: ?string, version: ?string, aliases: ?string[], reference: ?string, replaced: ?string[], provided: ?string[]}>} $data
|
||
|
|
*/
|
||
|
|
public static function reload($data)
|
||
|
|
{
|
||
|
|
self::$installed = $data;
|
||
|
|
self::$installedByVendor = array();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return array[]
|
||
|
|
*/
|
||
|
|
private static function getInstalled()
|
||
|
|
{
|
||
|
|
if (null === self::$canGetVendors) {
|
||
|
|
self::$canGetVendors = method_exists('Composer\Autoload\ClassLoader', 'getRegisteredLoaders');
|
||
|
|
}
|
||
|
|
|
||
|
|
$installed = array();
|
||
|
|
|
||
|
|
if (self::$canGetVendors) {
|
||
|
|
// @phpstan-ignore-next-line
|
||
|
|
foreach (ClassLoader::getRegisteredLoaders() as $vendorDir => $loader) {
|
||
|
|
if (isset(self::$installedByVendor[$vendorDir])) {
|
||
|
|
$installed[] = self::$installedByVendor[$vendorDir];
|
||
|
|
} elseif (is_file($vendorDir.'/composer/installed.php')) {
|
||
|
|
$installed[] = self::$installedByVendor[$vendorDir] = require $vendorDir.'/composer/installed.php';
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$installed[] = self::$installed;
|
||
|
|
|
||
|
|
return $installed;
|
||
|
|
}
|
||
|
|
}
|