* Jordi Boggiano * * 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' => 'f3966c99fc2c3438c875e2ef7ff5fafecc6c8cd4', 'name' => 'kanboard/kanboard', ), 'versions' => array ( 'christian-riesen/base32' => array ( 'pretty_version' => '1.6.0', 'version' => '1.6.0.0', 'aliases' => array ( ), 'reference' => '2e82dab3baa008e24a505649b0d583c31d31e894', ), 'christian-riesen/otp' => array ( 'pretty_version' => '1.4.3', 'version' => '1.4.3.0', 'aliases' => array ( ), 'reference' => '20a539ce6280eb029030f4e7caefd5709a75e1ad', ), 'erusev/parsedown' => array ( 'pretty_version' => '1.7.4', 'version' => '1.7.4.0', 'aliases' => array ( ), 'reference' => 'cb17b6477dfff935958ba01325f2e8a2bfa6dab3', ), 'kanboard/kanboard' => array ( 'pretty_version' => 'dev-main', 'version' => 'dev-main', 'aliases' => array ( ), 'reference' => 'f3966c99fc2c3438c875e2ef7ff5fafecc6c8cd4', ), 'pimple/pimple' => array ( 'pretty_version' => 'v3.5.0', 'version' => '3.5.0.0', 'aliases' => array ( ), 'reference' => 'a94b3a4db7fb774b3d78dad2315ddc07629e1bed', ), 'psr/container' => array ( 'pretty_version' => '2.0.2', 'version' => '2.0.2.0', 'aliases' => array ( ), 'reference' => 'c71ecc56dfe541dbd90c5360474fbc405f8d5963', ), 'psr/event-dispatcher-implementation' => array ( 'provided' => array ( 0 => '1.0', ), ), 'psr/log' => array ( 'pretty_version' => '1.1.4', 'version' => '1.1.4.0', 'aliases' => array ( ), 'reference' => 'd49695b909c3b7628b6289db5479a1c204601f11', ), 'psr/log-implementation' => array ( 'provided' => array ( 0 => '1.0|2.0', ), ), 'symfony/console' => array ( 'pretty_version' => 'v4.4.37', 'version' => '4.4.37.0', 'aliases' => array ( ), 'reference' => '0259f01dbf9d77badddbbf4c2abb681f24c9cac6', ), 'symfony/deprecation-contracts' => array ( 'pretty_version' => 'v2.5.2', 'version' => '2.5.2.0', 'aliases' => array ( ), 'reference' => 'e8b495ea28c1d97b5e0c121748d6f9b53d075c66', ), 'symfony/event-dispatcher' => array ( 'pretty_version' => 'v4.4.37', 'version' => '4.4.37.0', 'aliases' => array ( ), 'reference' => '3ccfcfb96ecce1217d7b0875a0736976bc6e63dc', ), 'symfony/event-dispatcher-contracts' => array ( 'pretty_version' => 'v1.1.11', 'version' => '1.1.11.0', 'aliases' => array ( ), 'reference' => '01e9a4efac0ee33a05dfdf93b346f62e7d0e998c', ), 'symfony/event-dispatcher-implementation' => array ( 'provided' => array ( 0 => '1.1', ), ), 'symfony/finder' => array ( 'pretty_version' => 'v5.4.11', 'version' => '5.4.11.0', 'aliases' => array ( ), 'reference' => '7872a66f57caffa2916a584db1aa7f12adc76f8c', ), 'symfony/polyfill-mbstring' => array ( 'pretty_version' => 'v1.24.0', 'version' => '1.24.0.0', 'aliases' => array ( ), 'reference' => '0abb51d2f102e00a4eefcf46ba7fec406d245825', ), 'symfony/polyfill-php73' => array ( 'pretty_version' => 'v1.24.0', 'version' => '1.24.0.0', 'aliases' => array ( ), 'reference' => 'cc5db0e22b3cb4111010e48785a97f670b350ca5', ), 'symfony/polyfill-php80' => array ( 'pretty_version' => 'v1.26.0', 'version' => '1.26.0.0', 'aliases' => array ( ), 'reference' => 'cfa0ae98841b9e461207c13ab093d76b0fa7bace', ), 'symfony/service-contracts' => array ( 'pretty_version' => 'v1.1.2', 'version' => '1.1.2.0', 'aliases' => array ( ), 'reference' => '191afdcb5804db960d26d8566b7e9a2843cab3a0', ), ), ); 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 */ 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} */ 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} $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; } }