Add phpstan-symfony to get type info about console InputInterface, fix many errors (#10476)
Extract common init/require commands functionality into PackageDiscoveryTrait Extract some helper methods into BaseCommand for better typesmain
Jordi Boggiano
2 years ago
committed by
GitHub
parent
48758c0207
commit
5c98a2cf8e
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,424 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Composer\Command;
|
||||||
|
|
||||||
|
use Composer\Factory;
|
||||||
|
use Composer\Filter\PlatformRequirementFilter\IgnoreAllPlatformRequirementFilter;
|
||||||
|
use Composer\Filter\PlatformRequirementFilter\PlatformRequirementFilterFactory;
|
||||||
|
use Composer\Package\CompletePackageInterface;
|
||||||
|
use Composer\Package\PackageInterface;
|
||||||
|
use Composer\Package\Version\VersionParser;
|
||||||
|
use Composer\Package\Version\VersionSelector;
|
||||||
|
use Composer\Pcre\Preg;
|
||||||
|
use Composer\Repository\CompositeRepository;
|
||||||
|
use Composer\Repository\PlatformRepository;
|
||||||
|
use Composer\Repository\RepositoryFactory;
|
||||||
|
use Composer\Repository\RepositorySet;
|
||||||
|
use Composer\Semver\Constraint\Constraint;
|
||||||
|
use Composer\Util\Filesystem;
|
||||||
|
use Symfony\Component\Console\Input\InputInterface;
|
||||||
|
use Symfony\Component\Console\Output\OutputInterface;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @internal
|
||||||
|
*/
|
||||||
|
trait PackageDiscoveryTrait
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @return CompositeRepository
|
||||||
|
*/
|
||||||
|
protected function getRepos()
|
||||||
|
{
|
||||||
|
if (null === $this->repos) {
|
||||||
|
$this->repos = new CompositeRepository(array_merge(
|
||||||
|
array(new PlatformRepository),
|
||||||
|
RepositoryFactory::defaultRepos($this->getIO())
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
return $this->repos;
|
||||||
|
}
|
||||||
|
|
||||||
|
private function getRepositorySet(InputInterface $input, ?string $minimumStability = null): RepositorySet
|
||||||
|
{
|
||||||
|
$key = $minimumStability ?? 'default';
|
||||||
|
|
||||||
|
if (!isset($this->repositorySets[$key])) {
|
||||||
|
$this->repositorySets[$key] = $repositorySet = new RepositorySet($minimumStability ?? $this->getMinimumStability($input));
|
||||||
|
$repositorySet->addRepository($this->getRepos());
|
||||||
|
}
|
||||||
|
|
||||||
|
return $this->repositorySets[$key];
|
||||||
|
}
|
||||||
|
|
||||||
|
private function getMinimumStability(InputInterface $input): string
|
||||||
|
{
|
||||||
|
if ($input->hasOption('stability')) { // @phpstan-ignore-line as InitCommand does have this option but not all classes using this trait do
|
||||||
|
return VersionParser::normalizeStability($input->getOption('stability') ?? 'stable');
|
||||||
|
}
|
||||||
|
|
||||||
|
// @phpstan-ignore-next-line as RequireCommand does not have the option above so this code is reachable there
|
||||||
|
$file = Factory::getComposerFile();
|
||||||
|
if (is_file($file) && Filesystem::isReadable($file) && is_array($composer = json_decode((string) file_get_contents($file), true))) {
|
||||||
|
if (!empty($composer['minimum-stability'])) {
|
||||||
|
return VersionParser::normalizeStability($composer['minimum-stability']);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return 'stable';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param array<string> $requires
|
||||||
|
*
|
||||||
|
* @return array<string>
|
||||||
|
* @throws \Exception
|
||||||
|
*/
|
||||||
|
final protected function determineRequirements(InputInterface $input, OutputInterface $output, array $requires = array(), ?PlatformRepository $platformRepo = null, string $preferredStability = 'stable', bool $checkProvidedVersions = true, bool $fixed = false): array
|
||||||
|
{
|
||||||
|
if (count($requires) > 0) {
|
||||||
|
$requires = $this->normalizeRequirements($requires);
|
||||||
|
$result = array();
|
||||||
|
$io = $this->getIO();
|
||||||
|
|
||||||
|
foreach ($requires as $requirement) {
|
||||||
|
if (!isset($requirement['version'])) {
|
||||||
|
// determine the best version automatically
|
||||||
|
list($name, $version) = $this->findBestVersionAndNameForPackage($input, $requirement['name'], $platformRepo, $preferredStability, null, null, $fixed);
|
||||||
|
$requirement['version'] = $version;
|
||||||
|
|
||||||
|
// replace package name from packagist.org
|
||||||
|
$requirement['name'] = $name;
|
||||||
|
|
||||||
|
$io->writeError(sprintf(
|
||||||
|
'Using version <info>%s</info> for <info>%s</info>',
|
||||||
|
$requirement['version'],
|
||||||
|
$requirement['name']
|
||||||
|
));
|
||||||
|
} else {
|
||||||
|
// check that the specified version/constraint exists before we proceed
|
||||||
|
list($name) = $this->findBestVersionAndNameForPackage($input, $requirement['name'], $platformRepo, $preferredStability, $checkProvidedVersions ? $requirement['version'] : null, 'dev', $fixed);
|
||||||
|
|
||||||
|
// replace package name from packagist.org
|
||||||
|
$requirement['name'] = $name;
|
||||||
|
}
|
||||||
|
|
||||||
|
$result[] = $requirement['name'] . ' ' . $requirement['version'];
|
||||||
|
}
|
||||||
|
|
||||||
|
return $result;
|
||||||
|
}
|
||||||
|
|
||||||
|
$versionParser = new VersionParser();
|
||||||
|
|
||||||
|
// Collect existing packages
|
||||||
|
$composer = $this->tryComposer();
|
||||||
|
$installedRepo = null;
|
||||||
|
if (null !== $composer) {
|
||||||
|
$installedRepo = $composer->getRepositoryManager()->getLocalRepository();
|
||||||
|
}
|
||||||
|
$existingPackages = array();
|
||||||
|
if (null !== $installedRepo) {
|
||||||
|
foreach ($installedRepo->getPackages() as $package) {
|
||||||
|
$existingPackages[] = $package->getName();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
unset($composer, $installedRepo);
|
||||||
|
|
||||||
|
$io = $this->getIO();
|
||||||
|
while (null !== $package = $io->ask('Search for a package: ')) {
|
||||||
|
$matches = $this->getRepos()->search($package);
|
||||||
|
|
||||||
|
if (count($matches) > 0) {
|
||||||
|
// Remove existing packages from search results.
|
||||||
|
foreach ($matches as $position => $foundPackage) {
|
||||||
|
if (in_array($foundPackage['name'], $existingPackages, true)) {
|
||||||
|
unset($matches[$position]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
$matches = array_values($matches);
|
||||||
|
|
||||||
|
$exactMatch = false;
|
||||||
|
$choices = array();
|
||||||
|
foreach ($matches as $position => $foundPackage) {
|
||||||
|
$abandoned = '';
|
||||||
|
if (isset($foundPackage['abandoned'])) {
|
||||||
|
if (is_string($foundPackage['abandoned'])) {
|
||||||
|
$replacement = sprintf('Use %s instead', $foundPackage['abandoned']);
|
||||||
|
} else {
|
||||||
|
$replacement = 'No replacement was suggested';
|
||||||
|
}
|
||||||
|
$abandoned = sprintf('<warning>Abandoned. %s.</warning>', $replacement);
|
||||||
|
}
|
||||||
|
|
||||||
|
$choices[] = sprintf(' <info>%5s</info> %s %s', "[$position]", $foundPackage['name'], $abandoned);
|
||||||
|
if ($foundPackage['name'] === $package) {
|
||||||
|
$exactMatch = true;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// no match, prompt which to pick
|
||||||
|
if (!$exactMatch) {
|
||||||
|
$io->writeError(array(
|
||||||
|
'',
|
||||||
|
sprintf('Found <info>%s</info> packages matching <info>%s</info>', count($matches), $package),
|
||||||
|
'',
|
||||||
|
));
|
||||||
|
|
||||||
|
$io->writeError($choices);
|
||||||
|
$io->writeError('');
|
||||||
|
|
||||||
|
$validator = function ($selection) use ($matches, $versionParser) {
|
||||||
|
if ('' === $selection) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (is_numeric($selection) && isset($matches[(int) $selection])) {
|
||||||
|
$package = $matches[(int) $selection];
|
||||||
|
|
||||||
|
return $package['name'];
|
||||||
|
}
|
||||||
|
|
||||||
|
if (Preg::isMatch('{^\s*(?P<name>[\S/]+)(?:\s+(?P<version>\S+))?\s*$}', $selection, $packageMatches)) {
|
||||||
|
if (isset($packageMatches['version'])) {
|
||||||
|
// parsing `acme/example ~2.3`
|
||||||
|
|
||||||
|
// validate version constraint
|
||||||
|
$versionParser->parseConstraints($packageMatches['version']);
|
||||||
|
|
||||||
|
return $packageMatches['name'].' '.$packageMatches['version'];
|
||||||
|
}
|
||||||
|
|
||||||
|
// parsing `acme/example`
|
||||||
|
return $packageMatches['name'];
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new \Exception('Not a valid selection');
|
||||||
|
};
|
||||||
|
|
||||||
|
$package = $io->askAndValidate(
|
||||||
|
'Enter package # to add, or the complete package name if it is not listed: ',
|
||||||
|
$validator,
|
||||||
|
3,
|
||||||
|
false
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// no constraint yet, determine the best version automatically
|
||||||
|
if (false !== $package && false === strpos($package, ' ')) {
|
||||||
|
$validator = function ($input) {
|
||||||
|
$input = trim($input);
|
||||||
|
|
||||||
|
return strlen($input) > 0 ? $input : false;
|
||||||
|
};
|
||||||
|
|
||||||
|
$constraint = $io->askAndValidate(
|
||||||
|
'Enter the version constraint to require (or leave blank to use the latest version): ',
|
||||||
|
$validator,
|
||||||
|
3,
|
||||||
|
false
|
||||||
|
);
|
||||||
|
|
||||||
|
if (false === $constraint) {
|
||||||
|
list(, $constraint) = $this->findBestVersionAndNameForPackage($input, $package, $platformRepo, $preferredStability);
|
||||||
|
|
||||||
|
$io->writeError(sprintf(
|
||||||
|
'Using version <info>%s</info> for <info>%s</info>',
|
||||||
|
$constraint,
|
||||||
|
$package
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
$package .= ' '.$constraint;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (false !== $package) {
|
||||||
|
$requires[] = $package;
|
||||||
|
$existingPackages[] = explode(' ', $package)[0];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return $requires;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Given a package name, this determines the best version to use in the require key.
|
||||||
|
*
|
||||||
|
* This returns a version with the ~ operator prefixed when possible.
|
||||||
|
*
|
||||||
|
* @throws \InvalidArgumentException
|
||||||
|
* @return array{string, string} name version
|
||||||
|
*/
|
||||||
|
private function findBestVersionAndNameForPackage(InputInterface $input, string $name, ?PlatformRepository $platformRepo = null, string $preferredStability = 'stable', ?string $requiredVersion = null, ?string $minimumStability = null, bool $fixed = false): array
|
||||||
|
{
|
||||||
|
// handle ignore-platform-reqs flag if present
|
||||||
|
$platformRequirementFilter = $this->getPlatformRequirementFilter($input);
|
||||||
|
|
||||||
|
// find the latest version allowed in this repo set
|
||||||
|
$versionSelector = new VersionSelector($this->getRepositorySet($input, $minimumStability), $platformRepo);
|
||||||
|
$effectiveMinimumStability = $minimumStability ?? $this->getMinimumStability($input);
|
||||||
|
|
||||||
|
$package = $versionSelector->findBestCandidate($name, $requiredVersion, $preferredStability, $platformRequirementFilter);
|
||||||
|
|
||||||
|
if (false === $package) {
|
||||||
|
// platform packages can not be found in the pool in versions other than the local platform's has
|
||||||
|
// so if platform reqs are ignored we just take the user's word for it
|
||||||
|
if ($platformRequirementFilter->isIgnored($name)) {
|
||||||
|
return array($name, $requiredVersion ?: '*');
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check whether the package requirements were the problem
|
||||||
|
if (!($platformRequirementFilter instanceof IgnoreAllPlatformRequirementFilter) && false !== ($candidate = $versionSelector->findBestCandidate($name, $requiredVersion, $preferredStability, PlatformRequirementFilterFactory::ignoreAll()))) {
|
||||||
|
throw new \InvalidArgumentException(sprintf(
|
||||||
|
'Package %s%s has requirements incompatible with your PHP version, PHP extensions and Composer version' . $this->getPlatformExceptionDetails($candidate, $platformRepo),
|
||||||
|
$name,
|
||||||
|
is_string($requiredVersion) ? ' at version '.$requiredVersion : ''
|
||||||
|
));
|
||||||
|
}
|
||||||
|
// Check whether the minimum stability was the problem but the package exists
|
||||||
|
if (false !== ($package = $versionSelector->findBestCandidate($name, $requiredVersion, $preferredStability, $platformRequirementFilter, RepositorySet::ALLOW_UNACCEPTABLE_STABILITIES))) {
|
||||||
|
// we must first verify if a valid package would be found in a lower priority repository
|
||||||
|
if (false !== ($allReposPackage = $versionSelector->findBestCandidate($name, $requiredVersion, $preferredStability, $platformRequirementFilter, RepositorySet::ALLOW_SHADOWED_REPOSITORIES))) {
|
||||||
|
throw new \InvalidArgumentException(
|
||||||
|
'Package '.$name.' exists in '.$allReposPackage->getRepository()->getRepoName().' and '.$package->getRepository()->getRepoName().' which has a higher repository priority. The packages from the higher priority repository do not match your minimum-stability and are therefore not installable. That repository is canonical so the lower priority repo\'s packages are not installable. See https://getcomposer.org/repoprio for details and assistance.'
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new \InvalidArgumentException(sprintf(
|
||||||
|
'Could not find a version of package %s matching your minimum-stability (%s). Require it with an explicit version constraint allowing its desired stability.',
|
||||||
|
$name,
|
||||||
|
$effectiveMinimumStability
|
||||||
|
));
|
||||||
|
}
|
||||||
|
// Check whether the required version was the problem
|
||||||
|
if (is_string($requiredVersion) && false !== ($package = $versionSelector->findBestCandidate($name, null, $preferredStability, $platformRequirementFilter))) {
|
||||||
|
// we must first verify if a valid package would be found in a lower priority repository
|
||||||
|
if (false !== ($allReposPackage = $versionSelector->findBestCandidate($name, $requiredVersion, $preferredStability, PlatformRequirementFilterFactory::ignoreNothing(), RepositorySet::ALLOW_SHADOWED_REPOSITORIES))) {
|
||||||
|
throw new \InvalidArgumentException(
|
||||||
|
'Package '.$name.' exists in '.$allReposPackage->getRepository()->getRepoName().' and '.$package->getRepository()->getRepoName().' which has a higher repository priority. The packages from the higher priority repository do not match your constraint and are therefore not installable. That repository is canonical so the lower priority repo\'s packages are not installable. See https://getcomposer.org/repoprio for details and assistance.'
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new \InvalidArgumentException(sprintf(
|
||||||
|
'Could not find package %s in a version matching "%s" and a stability matching "'.$effectiveMinimumStability.'".',
|
||||||
|
$name,
|
||||||
|
$requiredVersion
|
||||||
|
));
|
||||||
|
}
|
||||||
|
// Check whether the PHP version was the problem for all versions
|
||||||
|
if (!$platformRequirementFilter instanceof IgnoreAllPlatformRequirementFilter && false !== ($candidate = $versionSelector->findBestCandidate($name, null, $preferredStability, PlatformRequirementFilterFactory::ignoreAll(), RepositorySet::ALLOW_UNACCEPTABLE_STABILITIES))) {
|
||||||
|
$additional = '';
|
||||||
|
if (false === $versionSelector->findBestCandidate($name, null, $preferredStability, PlatformRequirementFilterFactory::ignoreAll())) {
|
||||||
|
$additional = PHP_EOL.PHP_EOL.'Additionally, the package was only found with a stability of "'.$candidate->getStability().'" while your minimum stability is "'.$effectiveMinimumStability.'".';
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new \InvalidArgumentException(sprintf(
|
||||||
|
'Could not find package %s in any version matching your PHP version, PHP extensions and Composer version' . $this->getPlatformExceptionDetails($candidate, $platformRepo) . '%s',
|
||||||
|
$name,
|
||||||
|
$additional
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check for similar names/typos
|
||||||
|
$similar = $this->findSimilar($name);
|
||||||
|
if (count($similar) > 0) {
|
||||||
|
if (in_array($name, $similar, true)) {
|
||||||
|
throw new \InvalidArgumentException(sprintf(
|
||||||
|
"Could not find package %s. It was however found via repository search, which indicates a consistency issue with the repository.",
|
||||||
|
$name
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new \InvalidArgumentException(sprintf(
|
||||||
|
"Could not find package %s.\n\nDid you mean " . (count($similar) > 1 ? 'one of these' : 'this') . "?\n %s",
|
||||||
|
$name,
|
||||||
|
implode("\n ", $similar)
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new \InvalidArgumentException(sprintf(
|
||||||
|
'Could not find a matching version of package %s. Check the package spelling, your version constraint and that the package is available in a stability which matches your minimum-stability (%s).',
|
||||||
|
$name,
|
||||||
|
$effectiveMinimumStability
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
return array(
|
||||||
|
$package->getPrettyName(),
|
||||||
|
$fixed ? $package->getPrettyVersion() : $versionSelector->findRecommendedRequireVersion($package),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return array<string>
|
||||||
|
*/
|
||||||
|
private function findSimilar(string $package): array
|
||||||
|
{
|
||||||
|
try {
|
||||||
|
if (null === $this->repos) {
|
||||||
|
throw new \LogicException('findSimilar was called before $this->repos was initialized');
|
||||||
|
}
|
||||||
|
$results = $this->repos->search($package);
|
||||||
|
} catch (\Throwable $e) {
|
||||||
|
if ($e instanceof \LogicException) {
|
||||||
|
throw $e;
|
||||||
|
}
|
||||||
|
|
||||||
|
// ignore search errors
|
||||||
|
return array();
|
||||||
|
}
|
||||||
|
$similarPackages = array();
|
||||||
|
|
||||||
|
$installedRepo = $this->requireComposer()->getRepositoryManager()->getLocalRepository();
|
||||||
|
|
||||||
|
foreach ($results as $result) {
|
||||||
|
if (null !== $installedRepo->findPackage($result['name'], '*')) {
|
||||||
|
// Ignore installed package
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
$similarPackages[$result['name']] = levenshtein($package, $result['name']);
|
||||||
|
}
|
||||||
|
asort($similarPackages);
|
||||||
|
|
||||||
|
return array_keys(array_slice($similarPackages, 0, 5));
|
||||||
|
}
|
||||||
|
|
||||||
|
private function getPlatformExceptionDetails(PackageInterface $candidate, ?PlatformRepository $platformRepo = null): string
|
||||||
|
{
|
||||||
|
$details = array();
|
||||||
|
if (null === $platformRepo) {
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach ($candidate->getRequires() as $link) {
|
||||||
|
if (!PlatformRepository::isPlatformPackage($link->getTarget())) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
$platformPkg = $platformRepo->findPackage($link->getTarget(), '*');
|
||||||
|
if (null === $platformPkg) {
|
||||||
|
if ($platformRepo->isPlatformPackageDisabled($link->getTarget())) {
|
||||||
|
$details[] = $candidate->getPrettyName().' '.$candidate->getPrettyVersion().' requires '.$link->getTarget().' '.$link->getPrettyConstraint().' but it is disabled by your platform config. Enable it again with "composer config platform.'.$link->getTarget().' --unset".';
|
||||||
|
} else {
|
||||||
|
$details[] = $candidate->getPrettyName().' '.$candidate->getPrettyVersion().' requires '.$link->getTarget().' '.$link->getPrettyConstraint().' but it is not present.';
|
||||||
|
}
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if (!$link->getConstraint()->matches(new Constraint('==', $platformPkg->getVersion()))) {
|
||||||
|
$platformPkgVersion = $platformPkg->getPrettyVersion();
|
||||||
|
$platformExtra = $platformPkg->getExtra();
|
||||||
|
if (isset($platformExtra['config.platform']) && $platformPkg instanceof CompletePackageInterface) {
|
||||||
|
$platformPkgVersion .= ' ('.$platformPkg->getDescription().')';
|
||||||
|
}
|
||||||
|
$details[] = $candidate->getPrettyName().' '.$candidate->getPrettyVersion().' requires '.$link->getTarget().' '.$link->getPrettyConstraint().' which does not match your installed version '.$platformPkgVersion.'.';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (count($details) === 0) {
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
|
||||||
|
return ':'.PHP_EOL.' - ' . implode(PHP_EOL.' - ', $details);
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,5 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
require __DIR__ . '/../vendor/autoload.php';
|
||||||
|
|
||||||
|
return new \Composer\Console\Application();
|
||||||
Loading…
Reference in New Issue