ShowCommand.php 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994
  1. <?php
  2. /*
  3. * This file is part of Composer.
  4. *
  5. * (c) Nils Adermann <naderman@naderman.de>
  6. * Jordi Boggiano <j.boggiano@seld.be>
  7. *
  8. * For the full copyright and license information, please view the LICENSE
  9. * file that was distributed with this source code.
  10. */
  11. namespace Composer\Command;
  12. use Composer\Composer;
  13. use Composer\DependencyResolver\DefaultPolicy;
  14. use Composer\DependencyResolver\Pool;
  15. use Composer\Json\JsonFile;
  16. use Composer\Package\BasePackage;
  17. use Composer\Package\CompletePackageInterface;
  18. use Composer\Package\PackageInterface;
  19. use Composer\Package\Version\VersionParser;
  20. use Composer\Package\Version\VersionSelector;
  21. use Composer\Plugin\CommandEvent;
  22. use Composer\Plugin\PluginEvents;
  23. use Composer\Repository\ArrayRepository;
  24. use Composer\Repository\ComposerRepository;
  25. use Composer\Repository\CompositeRepository;
  26. use Composer\Repository\PlatformRepository;
  27. use Composer\Repository\RepositoryFactory;
  28. use Composer\Repository\RepositoryInterface;
  29. use Composer\Repository\RepositorySet;
  30. use Composer\Semver\Constraint\ConstraintInterface;
  31. use Composer\Semver\Semver;
  32. use Composer\Spdx\SpdxLicenses;
  33. use Composer\Util\Platform;
  34. use Symfony\Component\Console\Formatter\OutputFormatterStyle;
  35. use Symfony\Component\Console\Input\InputArgument;
  36. use Symfony\Component\Console\Input\InputInterface;
  37. use Symfony\Component\Console\Input\InputOption;
  38. use Symfony\Component\Console\Output\OutputInterface;
  39. use Symfony\Component\Console\Terminal;
  40. /**
  41. * @author Robert Schönthal <seroscho@googlemail.com>
  42. * @author Jordi Boggiano <j.boggiano@seld.be>
  43. * @author Jérémy Romey <jeremyFreeAgent>
  44. * @author Mihai Plasoianu <mihai@plasoianu.de>
  45. */
  46. class ShowCommand extends BaseCommand
  47. {
  48. /** @var VersionParser */
  49. protected $versionParser;
  50. protected $colors;
  51. /** @var RepositorySet */
  52. private $repositorySet;
  53. protected function configure()
  54. {
  55. $this
  56. ->setName('show')
  57. ->setAliases(array('info'))
  58. ->setDescription('Shows information about packages.')
  59. ->setDefinition(array(
  60. new InputArgument('package', InputArgument::OPTIONAL, 'Package to inspect. Or a name including a wildcard (*) to filter lists of packages instead.'),
  61. new InputArgument('version', InputArgument::OPTIONAL, 'Version or version constraint to inspect'),
  62. new InputOption('all', null, InputOption::VALUE_NONE, 'List all packages'),
  63. new InputOption('installed', 'i', InputOption::VALUE_NONE, 'List installed packages only (enabled by default, only present for BC).'),
  64. new InputOption('platform', 'p', InputOption::VALUE_NONE, 'List platform packages only'),
  65. new InputOption('available', 'a', InputOption::VALUE_NONE, 'List available packages only'),
  66. new InputOption('self', 's', InputOption::VALUE_NONE, 'Show the root package information'),
  67. new InputOption('name-only', 'N', InputOption::VALUE_NONE, 'List package names only'),
  68. new InputOption('path', 'P', InputOption::VALUE_NONE, 'Show package paths'),
  69. new InputOption('tree', 't', InputOption::VALUE_NONE, 'List the dependencies as a tree'),
  70. new InputOption('latest', 'l', InputOption::VALUE_NONE, 'Show the latest version'),
  71. new InputOption('outdated', 'o', InputOption::VALUE_NONE, 'Show the latest version but only for packages that are outdated'),
  72. new InputOption('minor-only', 'm', InputOption::VALUE_NONE, 'Show only packages that have minor SemVer-compatible updates. Use with the --outdated option.'),
  73. new InputOption('direct', 'D', InputOption::VALUE_NONE, 'Shows only packages that are directly required by the root package'),
  74. new InputOption('strict', null, InputOption::VALUE_NONE, 'Return a non-zero exit code when there are outdated packages'),
  75. new InputOption('format', 'f', InputOption::VALUE_REQUIRED, 'Format of the output: text or json', 'text'),
  76. ))
  77. ->setHelp(
  78. <<<EOT
  79. The show command displays detailed information about a package, or
  80. lists all packages available.
  81. EOT
  82. )
  83. ;
  84. }
  85. protected function execute(InputInterface $input, OutputInterface $output)
  86. {
  87. $this->versionParser = new VersionParser;
  88. if ($input->getOption('tree')) {
  89. $this->initStyles($output);
  90. }
  91. $composer = $this->getComposer(false);
  92. $io = $this->getIO();
  93. if ($input->getOption('installed')) {
  94. $io->writeError('<warning>You are using the deprecated option "installed". Only installed packages are shown by default now. The --all option can be used to show all packages.</warning>');
  95. }
  96. if ($input->getOption('outdated')) {
  97. $input->setOption('latest', true);
  98. }
  99. if ($input->getOption('direct') && ($input->getOption('all') || $input->getOption('available') || $input->getOption('platform'))) {
  100. $io->writeError('The --direct (-D) option is not usable in combination with --all, --platform (-p) or --available (-a)');
  101. return 1;
  102. }
  103. if ($input->getOption('tree') && ($input->getOption('all') || $input->getOption('available'))) {
  104. $io->writeError('The --tree (-t) option is not usable in combination with --all or --available (-a)');
  105. return 1;
  106. }
  107. if ($input->getOption('tree') && $input->getOption('latest')) {
  108. $io->writeError('The --tree (-t) option is not usable in combination with --latest (-l)');
  109. return 1;
  110. }
  111. $format = $input->getOption('format');
  112. if (!in_array($format, array('text', 'json'))) {
  113. $io->writeError(sprintf('Unsupported format "%s". See help for supported formats.', $format));
  114. return 1;
  115. }
  116. // init repos
  117. $platformOverrides = array();
  118. if ($composer) {
  119. $platformOverrides = $composer->getConfig()->get('platform') ?: array();
  120. }
  121. $platformRepo = new PlatformRepository(array(), $platformOverrides);
  122. $phpVersion = $platformRepo->findPackage('php', '*')->getVersion();
  123. if ($input->getOption('self')) {
  124. $package = $this->getComposer()->getPackage();
  125. $repos = $installedRepo = new ArrayRepository(array($package));
  126. } elseif ($input->getOption('platform')) {
  127. $repos = $installedRepo = $platformRepo;
  128. } elseif ($input->getOption('available')) {
  129. $installedRepo = $platformRepo;
  130. if ($composer) {
  131. $repos = new CompositeRepository($composer->getRepositoryManager()->getRepositories());
  132. } else {
  133. $defaultRepos = RepositoryFactory::defaultRepos($io);
  134. $repos = new CompositeRepository($defaultRepos);
  135. $io->writeError('No composer.json found in the current directory, showing available packages from ' . implode(', ', array_keys($defaultRepos)));
  136. }
  137. } elseif ($input->getOption('all') && $composer) {
  138. $localRepo = $composer->getRepositoryManager()->getLocalRepository();
  139. $installedRepo = new CompositeRepository(array($localRepo, $platformRepo));
  140. $repos = new CompositeRepository(array_merge(array($installedRepo), $composer->getRepositoryManager()->getRepositories()));
  141. } elseif ($input->getOption('all')) {
  142. $defaultRepos = RepositoryFactory::defaultRepos($io);
  143. $io->writeError('No composer.json found in the current directory, showing available packages from ' . implode(', ', array_keys($defaultRepos)));
  144. $installedRepo = $platformRepo;
  145. $repos = new CompositeRepository(array_merge(array($installedRepo), $defaultRepos));
  146. } else {
  147. $repos = $installedRepo = $this->getComposer()->getRepositoryManager()->getLocalRepository();
  148. $rootPkg = $this->getComposer()->getPackage();
  149. if (!$installedRepo->getPackages() && ($rootPkg->getRequires() || $rootPkg->getDevRequires())) {
  150. $io->writeError('<warning>No dependencies installed. Try running composer install or update.</warning>');
  151. }
  152. }
  153. if ($composer) {
  154. $commandEvent = new CommandEvent(PluginEvents::COMMAND, 'show', $input, $output);
  155. $composer->getEventDispatcher()->dispatch($commandEvent->getName(), $commandEvent);
  156. }
  157. if ($input->getOption('latest') && null === $composer) {
  158. $io->writeError('No composer.json found in the current directory, disabling "latest" option');
  159. $input->setOption('latest', false);
  160. }
  161. $packageFilter = $input->getArgument('package');
  162. // show single package or single version
  163. if (($packageFilter && false === strpos($packageFilter, '*')) || !empty($package)) {
  164. if (empty($package)) {
  165. list($package, $versions) = $this->getPackage($installedRepo, $repos, $input->getArgument('package'), $input->getArgument('version'));
  166. if (empty($package)) {
  167. $options = $input->getOptions();
  168. if (!isset($options['working-dir']) || !file_exists('composer.json')) {
  169. throw new \InvalidArgumentException('Package ' . $packageFilter . ' not found');
  170. }
  171. $io->writeError('Package ' . $packageFilter . ' not found in ' . $options['working-dir'] . '/composer.json');
  172. return 1;
  173. }
  174. } else {
  175. $versions = array($package->getPrettyVersion() => $package->getVersion());
  176. }
  177. $exitCode = 0;
  178. if ($input->getOption('tree')) {
  179. $arrayTree = $this->generatePackageTree($package, $installedRepo, $repos);
  180. if ('json' === $format) {
  181. $io->write(JsonFile::encode(array('installed' => array($arrayTree))));
  182. } else {
  183. $this->displayPackageTree(array($arrayTree));
  184. }
  185. } else {
  186. $latestPackage = null;
  187. if ($input->getOption('latest')) {
  188. $latestPackage = $this->findLatestPackage($package, $composer, $phpVersion);
  189. }
  190. if ($input->getOption('outdated') && $input->getOption('strict') && $latestPackage && $latestPackage->getFullPrettyVersion() !== $package->getFullPrettyVersion() && !$latestPackage->isAbandoned()) {
  191. $exitCode = 1;
  192. }
  193. $this->printMeta($package, $versions, $installedRepo, $latestPackage ?: null);
  194. $this->printLinks($package, 'requires');
  195. $this->printLinks($package, 'devRequires', 'requires (dev)');
  196. if ($package->getSuggests()) {
  197. $io->write("\n<info>suggests</info>");
  198. foreach ($package->getSuggests() as $suggested => $reason) {
  199. $io->write($suggested . ' <comment>' . $reason . '</comment>');
  200. }
  201. }
  202. $this->printLinks($package, 'provides');
  203. $this->printLinks($package, 'conflicts');
  204. $this->printLinks($package, 'replaces');
  205. }
  206. return $exitCode;
  207. }
  208. // show tree view if requested
  209. if ($input->getOption('tree')) {
  210. $rootRequires = $this->getRootRequires();
  211. $packages = $installedRepo->getPackages();
  212. usort($packages, 'strcmp');
  213. $arrayTree = array();
  214. foreach ($packages as $package) {
  215. if (in_array($package->getName(), $rootRequires, true)) {
  216. $arrayTree[] = $this->generatePackageTree($package, $installedRepo, $repos);
  217. }
  218. }
  219. if ('json' === $format) {
  220. $io->write(JsonFile::encode(array('installed' => $arrayTree)));
  221. } else {
  222. $this->displayPackageTree($arrayTree);
  223. }
  224. return 0;
  225. }
  226. if ($repos instanceof CompositeRepository) {
  227. $repos = $repos->getRepositories();
  228. } elseif (!is_array($repos)) {
  229. $repos = array($repos);
  230. }
  231. // list packages
  232. $packages = array();
  233. if (null !== $packageFilter) {
  234. $packageFilter = '{^'.str_replace('\\*', '.*?', preg_quote($packageFilter)).'$}i';
  235. }
  236. $packageListFilter = array();
  237. if ($input->getOption('direct')) {
  238. $packageListFilter = $this->getRootRequires();
  239. }
  240. if (class_exists('Symfony\Component\Console\Terminal')) {
  241. $terminal = new Terminal();
  242. $width = $terminal->getWidth();
  243. } else {
  244. // For versions of Symfony console before 3.2
  245. list($width) = $this->getApplication()->getTerminalDimensions();
  246. }
  247. if (null === $width) {
  248. // In case the width is not detected, we're probably running the command
  249. // outside of a real terminal, use space without a limit
  250. $width = PHP_INT_MAX;
  251. }
  252. if (Platform::isWindows()) {
  253. $width--;
  254. } else {
  255. $width = max(80, $width);
  256. }
  257. if ($input->getOption('path') && null === $composer) {
  258. $io->writeError('No composer.json found in the current directory, disabling "path" option');
  259. $input->setOption('path', false);
  260. }
  261. foreach ($repos as $repo) {
  262. if ($repo === $platformRepo) {
  263. $type = 'platform';
  264. } elseif (
  265. $repo === $installedRepo
  266. || ($installedRepo instanceof CompositeRepository && in_array($repo, $installedRepo->getRepositories(), true))
  267. ) {
  268. $type = 'installed';
  269. } else {
  270. $type = 'available';
  271. }
  272. if ($repo instanceof ComposerRepository && $repo->hasProviders()) {
  273. foreach ($repo->getProviderNames() as $name) {
  274. if (!$packageFilter || preg_match($packageFilter, $name)) {
  275. $packages[$type][$name] = $name;
  276. }
  277. }
  278. } else {
  279. foreach ($repo->getPackages() as $package) {
  280. if (!isset($packages[$type][$package->getName()])
  281. || !is_object($packages[$type][$package->getName()])
  282. || version_compare($packages[$type][$package->getName()]->getVersion(), $package->getVersion(), '<')
  283. ) {
  284. if (!$packageFilter || preg_match($packageFilter, $package->getName())) {
  285. if (!$packageListFilter || in_array($package->getName(), $packageListFilter, true)) {
  286. $packages[$type][$package->getName()] = $package;
  287. }
  288. }
  289. }
  290. }
  291. }
  292. }
  293. $showAllTypes = $input->getOption('all');
  294. $showLatest = $input->getOption('latest');
  295. $showMinorOnly = $input->getOption('minor-only');
  296. $indent = $showAllTypes ? ' ' : '';
  297. $latestPackages = array();
  298. $exitCode = 0;
  299. $viewData = array();
  300. $viewMetaData = array();
  301. foreach (array('platform' => true, 'available' => false, 'installed' => true) as $type => $showVersion) {
  302. if (isset($packages[$type])) {
  303. ksort($packages[$type]);
  304. $nameLength = $versionLength = $latestLength = 0;
  305. if ($showLatest && $showVersion) {
  306. foreach ($packages[$type] as $package) {
  307. if (is_object($package)) {
  308. $latestPackage = $this->findLatestPackage($package, $composer, $phpVersion, $showMinorOnly);
  309. if ($latestPackage === false) {
  310. continue;
  311. }
  312. $latestPackages[$package->getPrettyName()] = $latestPackage;
  313. }
  314. }
  315. }
  316. $writePath = !$input->getOption('name-only') && $input->getOption('path');
  317. $writeVersion = !$input->getOption('name-only') && !$input->getOption('path') && $showVersion;
  318. $writeLatest = $writeVersion && $showLatest;
  319. $writeDescription = !$input->getOption('name-only') && !$input->getOption('path');
  320. $hasOutdatedPackages = false;
  321. $viewData[$type] = array();
  322. foreach ($packages[$type] as $package) {
  323. $packageViewData = array();
  324. if (is_object($package)) {
  325. $latestPackage = null;
  326. if ($showLatest && isset($latestPackages[$package->getPrettyName()])) {
  327. $latestPackage = $latestPackages[$package->getPrettyName()];
  328. }
  329. if ($input->getOption('outdated') && $latestPackage && $latestPackage->getFullPrettyVersion() === $package->getFullPrettyVersion() && !$latestPackage->isAbandoned()) {
  330. continue;
  331. } elseif ($input->getOption('outdated') || $input->getOption('strict')) {
  332. $hasOutdatedPackages = true;
  333. }
  334. $packageViewData['name'] = $package->getPrettyName();
  335. $nameLength = max($nameLength, strlen($package->getPrettyName()));
  336. if ($writeVersion) {
  337. $packageViewData['version'] = $package->getFullPrettyVersion();
  338. $versionLength = max($versionLength, strlen($package->getFullPrettyVersion()));
  339. }
  340. if ($writeLatest && $latestPackage) {
  341. $packageViewData['latest'] = $latestPackage->getFullPrettyVersion();
  342. $packageViewData['latest-status'] = $this->getUpdateStatus($latestPackage, $package);
  343. $latestLength = max($latestLength, strlen($latestPackage->getFullPrettyVersion()));
  344. }
  345. if ($writeDescription) {
  346. $packageViewData['description'] = $package->getDescription();
  347. }
  348. if ($writePath) {
  349. $packageViewData['path'] = strtok(realpath($composer->getInstallationManager()->getInstallPath($package)), "\r\n");
  350. }
  351. if ($latestPackage && $latestPackage->isAbandoned()) {
  352. $replacement = is_string($latestPackage->getReplacementPackage())
  353. ? 'Use ' . $latestPackage->getReplacementPackage() . ' instead'
  354. : 'No replacement was suggested';
  355. $packageWarning = sprintf(
  356. 'Package %s is abandoned, you should avoid using it. %s.',
  357. $package->getPrettyName(),
  358. $replacement
  359. );
  360. $packageViewData['warning'] = $packageWarning;
  361. }
  362. } else {
  363. $packageViewData['name'] = $package;
  364. $nameLength = max($nameLength, strlen($package));
  365. }
  366. $viewData[$type][] = $packageViewData;
  367. }
  368. $viewMetaData[$type] = array(
  369. 'nameLength' => $nameLength,
  370. 'versionLength' => $versionLength,
  371. 'latestLength' => $latestLength,
  372. );
  373. if ($input->getOption('strict') && $hasOutdatedPackages) {
  374. $exitCode = 1;
  375. break;
  376. }
  377. }
  378. }
  379. if ('json' === $format) {
  380. $io->write(JsonFile::encode($viewData));
  381. } else {
  382. foreach ($viewData as $type => $packages) {
  383. $nameLength = $viewMetaData[$type]['nameLength'];
  384. $versionLength = $viewMetaData[$type]['versionLength'];
  385. $latestLength = $viewMetaData[$type]['latestLength'];
  386. $writeVersion = $nameLength + $versionLength + 3 <= $width;
  387. $writeLatest = $nameLength + $versionLength + $latestLength + 3 <= $width;
  388. $writeDescription = $nameLength + $versionLength + $latestLength + 24 <= $width;
  389. if ($writeLatest && !$io->isDecorated()) {
  390. $latestLength += 2;
  391. }
  392. if ($showAllTypes) {
  393. if ('available' === $type) {
  394. $io->write('<comment>' . $type . '</comment>:');
  395. } else {
  396. $io->write('<info>' . $type . '</info>:');
  397. }
  398. }
  399. foreach ($packages as $package) {
  400. $io->write($indent . str_pad($package['name'], $nameLength, ' '), false);
  401. if (isset($package['version']) && $writeVersion) {
  402. $io->write(' ' . str_pad($package['version'], $versionLength, ' '), false);
  403. }
  404. if (isset($package['latest']) && $writeLatest) {
  405. $latestVersion = $package['latest'];
  406. $updateStatus = $package['latest-status'];
  407. $style = $this->updateStatusToVersionStyle($updateStatus);
  408. if (!$io->isDecorated()) {
  409. $latestVersion = str_replace(array('up-to-date', 'semver-safe-update', 'update-possible'), array('=', '!', '~'), $updateStatus) . ' ' . $latestVersion;
  410. }
  411. $io->write(' <' . $style . '>' . str_pad($latestVersion, $latestLength, ' ') . '</' . $style . '>', false);
  412. }
  413. if (isset($package['description']) && $writeDescription) {
  414. $description = strtok($package['description'], "\r\n");
  415. $remaining = $width - $nameLength - $versionLength - 4;
  416. if ($writeLatest) {
  417. $remaining -= $latestLength;
  418. }
  419. if (strlen($description) > $remaining) {
  420. $description = substr($description, 0, $remaining - 3) . '...';
  421. }
  422. $io->write(' ' . $description, false);
  423. }
  424. if (isset($package['path'])) {
  425. $io->write(' ' . $package['path'], false);
  426. }
  427. $io->write('');
  428. if (isset($package['warning'])) {
  429. $io->writeError('<warning>' . $package['warning'] . '</warning>');
  430. }
  431. }
  432. if ($showAllTypes) {
  433. $io->write('');
  434. }
  435. }
  436. }
  437. return $exitCode;
  438. }
  439. protected function getRootRequires()
  440. {
  441. $rootPackage = $this->getComposer()->getPackage();
  442. return array_map(
  443. 'strtolower',
  444. array_keys(array_merge($rootPackage->getRequires(), $rootPackage->getDevRequires()))
  445. );
  446. }
  447. protected function getVersionStyle(PackageInterface $latestPackage, PackageInterface $package)
  448. {
  449. return $this->updateStatusToVersionStyle($this->getUpdateStatus($latestPackage, $package));
  450. }
  451. /**
  452. * finds a package by name and version if provided
  453. *
  454. * @param RepositoryInterface $installedRepo
  455. * @param RepositoryInterface $repos
  456. * @param string $name
  457. * @param ConstraintInterface|string $version
  458. * @throws \InvalidArgumentException
  459. * @return array array(CompletePackageInterface, array of versions)
  460. */
  461. protected function getPackage(RepositoryInterface $installedRepo, RepositoryInterface $repos, $name, $version = null)
  462. {
  463. $name = strtolower($name);
  464. $constraint = is_string($version) ? $this->versionParser->parseConstraints($version) : $version;
  465. $policy = new DefaultPolicy();
  466. $repositorySet = new RepositorySet(new Pool('dev'));
  467. $repositorySet->addRepository($repos);
  468. $matchedPackage = null;
  469. $versions = array();
  470. $matches = $repositorySet->findPackages($name, $constraint);
  471. foreach ($matches as $index => $package) {
  472. // select an exact match if it is in the installed repo and no specific version was required
  473. if (null === $version && $installedRepo->hasPackage($package)) {
  474. $matchedPackage = $package;
  475. }
  476. $versions[$package->getPrettyVersion()] = $package->getVersion();
  477. $matches[$index] = $package->getId();
  478. }
  479. // select preferred package according to policy rules
  480. if (!$matchedPackage && $matches && $preferred = $policy->selectPreferredPackages($repositorySet->getPoolTemp(), array(), $matches)) { // TODO get rid of the pool call
  481. $matchedPackage = $repositorySet->getPoolTemp()->literalToPackage($preferred[0]);
  482. }
  483. return array($matchedPackage, $versions);
  484. }
  485. /**
  486. * Prints package metadata.
  487. *
  488. * @param CompletePackageInterface $package
  489. * @param array $versions
  490. * @param RepositoryInterface $installedRepo
  491. */
  492. protected function printMeta(CompletePackageInterface $package, array $versions, RepositoryInterface $installedRepo, PackageInterface $latestPackage = null)
  493. {
  494. $io = $this->getIO();
  495. $io->write('<info>name</info> : ' . $package->getPrettyName());
  496. $io->write('<info>descrip.</info> : ' . $package->getDescription());
  497. $io->write('<info>keywords</info> : ' . implode(', ', $package->getKeywords() ?: array()));
  498. $this->printVersions($package, $versions, $installedRepo);
  499. if ($latestPackage) {
  500. $style = $this->getVersionStyle($latestPackage, $package);
  501. $io->write('<info>latest</info> : <'.$style.'>' . $latestPackage->getPrettyVersion() . '</'.$style.'>');
  502. } else {
  503. $latestPackage = $package;
  504. }
  505. $io->write('<info>type</info> : ' . $package->getType());
  506. $this->printLicenses($package);
  507. $io->write('<info>source</info> : ' . sprintf('[%s] <comment>%s</comment> %s', $package->getSourceType(), $package->getSourceUrl(), $package->getSourceReference()));
  508. $io->write('<info>dist</info> : ' . sprintf('[%s] <comment>%s</comment> %s', $package->getDistType(), $package->getDistUrl(), $package->getDistReference()));
  509. $io->write('<info>names</info> : ' . implode(', ', $package->getNames()));
  510. if ($latestPackage->isAbandoned()) {
  511. $replacement = ($latestPackage->getReplacementPackage() !== null)
  512. ? ' The author suggests using the ' . $latestPackage->getReplacementPackage(). ' package instead.'
  513. : null;
  514. $io->writeError(
  515. sprintf('<warning>Attention: This package is abandoned and no longer maintained.%s</warning>', $replacement)
  516. );
  517. }
  518. if ($package->getSupport()) {
  519. $io->write("\n<info>support</info>");
  520. foreach ($package->getSupport() as $type => $value) {
  521. $io->write('<comment>' . $type . '</comment> : '.$value);
  522. }
  523. }
  524. if ($package->getAutoload()) {
  525. $io->write("\n<info>autoload</info>");
  526. foreach ($package->getAutoload() as $type => $autoloads) {
  527. $io->write('<comment>' . $type . '</comment>');
  528. if ($type === 'psr-0') {
  529. foreach ($autoloads as $name => $path) {
  530. $io->write(($name ?: '*') . ' => ' . (is_array($path) ? implode(', ', $path) : ($path ?: '.')));
  531. }
  532. } elseif ($type === 'psr-4') {
  533. foreach ($autoloads as $name => $path) {
  534. $io->write(($name ?: '*') . ' => ' . (is_array($path) ? implode(', ', $path) : ($path ?: '.')));
  535. }
  536. } elseif ($type === 'classmap') {
  537. $io->write(implode(', ', $autoloads));
  538. }
  539. }
  540. if ($package->getIncludePaths()) {
  541. $io->write('<comment>include-path</comment>');
  542. $io->write(implode(', ', $package->getIncludePaths()));
  543. }
  544. }
  545. }
  546. /**
  547. * Prints all available versions of this package and highlights the installed one if any.
  548. *
  549. * @param CompletePackageInterface $package
  550. * @param array $versions
  551. * @param RepositoryInterface $installedRepo
  552. */
  553. protected function printVersions(CompletePackageInterface $package, array $versions, RepositoryInterface $installedRepo)
  554. {
  555. uasort($versions, 'version_compare');
  556. $versions = array_keys(array_reverse($versions));
  557. // highlight installed version
  558. if ($installedRepo->hasPackage($package)) {
  559. $installedVersion = $package->getPrettyVersion();
  560. $key = array_search($installedVersion, $versions);
  561. if (false !== $key) {
  562. $versions[$key] = '<info>* ' . $installedVersion . '</info>';
  563. }
  564. }
  565. $versions = implode(', ', $versions);
  566. $this->getIO()->write('<info>versions</info> : ' . $versions);
  567. }
  568. /**
  569. * print link objects
  570. *
  571. * @param CompletePackageInterface $package
  572. * @param string $linkType
  573. * @param string $title
  574. */
  575. protected function printLinks(CompletePackageInterface $package, $linkType, $title = null)
  576. {
  577. $title = $title ?: $linkType;
  578. $io = $this->getIO();
  579. if ($links = $package->{'get'.ucfirst($linkType)}()) {
  580. $io->write("\n<info>" . $title . "</info>");
  581. foreach ($links as $link) {
  582. $io->write($link->getTarget() . ' <comment>' . $link->getPrettyConstraint() . '</comment>');
  583. }
  584. }
  585. }
  586. /**
  587. * Prints the licenses of a package with metadata
  588. *
  589. * @param CompletePackageInterface $package
  590. */
  591. protected function printLicenses(CompletePackageInterface $package)
  592. {
  593. $spdxLicenses = new SpdxLicenses();
  594. $licenses = $package->getLicense();
  595. $io = $this->getIO();
  596. foreach ($licenses as $licenseId) {
  597. $license = $spdxLicenses->getLicenseByIdentifier($licenseId); // keys: 0 fullname, 1 osi, 2 url
  598. if (!$license) {
  599. $out = $licenseId;
  600. } else {
  601. // is license OSI approved?
  602. if ($license[1] === true) {
  603. $out = sprintf('%s (%s) (OSI approved) %s', $license[0], $licenseId, $license[2]);
  604. } else {
  605. $out = sprintf('%s (%s) %s', $license[0], $licenseId, $license[2]);
  606. }
  607. }
  608. $io->write('<info>license</info> : ' . $out);
  609. }
  610. }
  611. /**
  612. * Init styles for tree
  613. *
  614. * @param OutputInterface $output
  615. */
  616. protected function initStyles(OutputInterface $output)
  617. {
  618. $this->colors = array(
  619. 'green',
  620. 'yellow',
  621. 'cyan',
  622. 'magenta',
  623. 'blue',
  624. );
  625. foreach ($this->colors as $color) {
  626. $style = new OutputFormatterStyle($color);
  627. $output->getFormatter()->setStyle($color, $style);
  628. }
  629. }
  630. /**
  631. * Display the tree
  632. *
  633. * @param $arrayTree
  634. */
  635. protected function displayPackageTree(array $arrayTree)
  636. {
  637. $io = $this->getIO();
  638. foreach ($arrayTree as $package) {
  639. $io->write(sprintf('<info>%s</info>', $package['name']), false);
  640. $io->write(' ' . $package['version'], false);
  641. $io->write(' ' . strtok($package['description'], "\r\n"));
  642. if (isset($package['requires'])) {
  643. $requires = $package['requires'];
  644. $treeBar = '├';
  645. $j = 0;
  646. $total = count($requires);
  647. foreach ($requires as $require) {
  648. $requireName = $require['name'];
  649. $j++;
  650. if ($j === $total) {
  651. $treeBar = '└';
  652. }
  653. $level = 1;
  654. $color = $this->colors[$level];
  655. $info = sprintf(
  656. '%s──<%s>%s</%s> %s',
  657. $treeBar,
  658. $color,
  659. $requireName,
  660. $color,
  661. $require['version']
  662. );
  663. $this->writeTreeLine($info);
  664. $treeBar = str_replace('└', ' ', $treeBar);
  665. $packagesInTree = array($package['name'], $requireName);
  666. $this->displayTree($require, $packagesInTree, $treeBar, $level + 1);
  667. }
  668. }
  669. }
  670. }
  671. /**
  672. * Generate the package tree
  673. *
  674. * @param PackageInterface|string $package
  675. * @param RepositoryInterface $installedRepo
  676. * @param RepositoryInterface $distantRepos
  677. * @return array
  678. */
  679. protected function generatePackageTree(
  680. PackageInterface $package,
  681. RepositoryInterface $installedRepo,
  682. RepositoryInterface $distantRepos
  683. ) {
  684. if (is_object($package)) {
  685. $requires = $package->getRequires();
  686. ksort($requires);
  687. $children = array();
  688. foreach ($requires as $requireName => $require) {
  689. $packagesInTree = array($package->getName(), $requireName);
  690. $treeChildDesc = array(
  691. 'name' => $requireName,
  692. 'version' => $require->getPrettyConstraint(),
  693. );
  694. $deepChildren = $this->addTree($requireName, $require, $installedRepo, $distantRepos, $packagesInTree);
  695. if ($deepChildren) {
  696. $treeChildDesc['requires'] = $deepChildren;
  697. }
  698. $children[] = $treeChildDesc;
  699. }
  700. $tree = array(
  701. 'name' => $package->getPrettyName(),
  702. 'version' => $package->getPrettyVersion(),
  703. 'description' => $package->getDescription(),
  704. );
  705. if ($children) {
  706. $tree['requires'] = $children;
  707. }
  708. return $tree;
  709. }
  710. }
  711. /**
  712. * Display a package tree
  713. *
  714. * @param PackageInterface|string $package
  715. * @param array $packagesInTree
  716. * @param string $previousTreeBar
  717. * @param int $level
  718. */
  719. protected function displayTree(
  720. $package,
  721. array $packagesInTree,
  722. $previousTreeBar = '├',
  723. $level = 1
  724. ) {
  725. $previousTreeBar = str_replace('├', '│', $previousTreeBar);
  726. if (isset($package['requires'])) {
  727. $requires = $package['requires'];
  728. $treeBar = $previousTreeBar . ' ├';
  729. $i = 0;
  730. $total = count($requires);
  731. foreach ($requires as $require) {
  732. $currentTree = $packagesInTree;
  733. $i++;
  734. if ($i === $total) {
  735. $treeBar = $previousTreeBar . ' └';
  736. }
  737. $colorIdent = $level % count($this->colors);
  738. $color = $this->colors[$colorIdent];
  739. $circularWarn = in_array(
  740. $require['name'],
  741. $currentTree,
  742. true
  743. ) ? '(circular dependency aborted here)' : '';
  744. $info = rtrim(sprintf(
  745. '%s──<%s>%s</%s> %s %s',
  746. $treeBar,
  747. $color,
  748. $require['name'],
  749. $color,
  750. $require['version'],
  751. $circularWarn
  752. ));
  753. $this->writeTreeLine($info);
  754. $treeBar = str_replace('└', ' ', $treeBar);
  755. $currentTree[] = $require['name'];
  756. $this->displayTree($require, $currentTree, $treeBar, $level + 1);
  757. }
  758. }
  759. }
  760. /**
  761. * Display a package tree
  762. *
  763. * @param string $name
  764. * @param PackageInterface|string $package
  765. * @param RepositoryInterface $installedRepo
  766. * @param RepositoryInterface $distantRepos
  767. * @param array $packagesInTree
  768. * @return array
  769. */
  770. protected function addTree(
  771. $name,
  772. $package,
  773. RepositoryInterface $installedRepo,
  774. RepositoryInterface $distantRepos,
  775. array $packagesInTree
  776. ) {
  777. $children = array();
  778. list($package, $versions) = $this->getPackage(
  779. $installedRepo,
  780. $distantRepos,
  781. $name,
  782. $package->getPrettyConstraint() === 'self.version' ? $package->getConstraint() : $package->getPrettyConstraint()
  783. );
  784. if (is_object($package)) {
  785. $requires = $package->getRequires();
  786. ksort($requires);
  787. foreach ($requires as $requireName => $require) {
  788. $currentTree = $packagesInTree;
  789. $treeChildDesc = array(
  790. 'name' => $requireName,
  791. 'version' => $require->getPrettyConstraint(),
  792. );
  793. if (!in_array($requireName, $currentTree, true)) {
  794. $currentTree[] = $requireName;
  795. $deepChildren = $this->addTree($requireName, $require, $installedRepo, $distantRepos, $currentTree);
  796. if ($deepChildren) {
  797. $treeChildDesc['requires'] = $deepChildren;
  798. }
  799. }
  800. $children[] = $treeChildDesc;
  801. }
  802. }
  803. return $children;
  804. }
  805. private function updateStatusToVersionStyle($updateStatus)
  806. {
  807. // 'up-to-date' is printed green
  808. // 'semver-safe-update' is printed red
  809. // 'update-possible' is printed yellow
  810. return str_replace(array('up-to-date', 'semver-safe-update', 'update-possible'), array('info', 'highlight', 'comment'), $updateStatus);
  811. }
  812. private function getUpdateStatus(PackageInterface $latestPackage, PackageInterface $package)
  813. {
  814. if ($latestPackage->getFullPrettyVersion() === $package->getFullPrettyVersion()) {
  815. return 'up-to-date';
  816. }
  817. $constraint = $package->getVersion();
  818. if (0 !== strpos($constraint, 'dev-')) {
  819. $constraint = '^'.$constraint;
  820. }
  821. if ($latestPackage->getVersion() && Semver::satisfies($latestPackage->getVersion(), $constraint)) {
  822. // it needs an immediate semver-compliant upgrade
  823. return 'semver-safe-update';
  824. }
  825. // it needs an upgrade but has potential BC breaks so is not urgent
  826. return 'update-possible';
  827. }
  828. private function writeTreeLine($line)
  829. {
  830. $io = $this->getIO();
  831. if (!$io->isDecorated()) {
  832. $line = str_replace(array('└', '├', '──', '│'), array('`-', '|-', '-', '|'), $line);
  833. }
  834. $io->write($line);
  835. }
  836. /**
  837. * Given a package, this finds the latest package matching it
  838. *
  839. * @param PackageInterface $package
  840. * @param Composer $composer
  841. * @param string $phpVersion
  842. * @param bool $minorOnly
  843. *
  844. * @return PackageInterface|null
  845. */
  846. private function findLatestPackage(PackageInterface $package, Composer $composer, $phpVersion, $minorOnly = false)
  847. {
  848. // find the latest version allowed in this repo set
  849. $name = $package->getName();
  850. $versionSelector = new VersionSelector($this->getRepositorySet($composer));
  851. $stability = $composer->getPackage()->getMinimumStability();
  852. $flags = $composer->getPackage()->getStabilityFlags();
  853. if (isset($flags[$name])) {
  854. $stability = array_search($flags[$name], BasePackage::$stabilities, true);
  855. }
  856. $bestStability = $stability;
  857. if ($composer->getPackage()->getPreferStable()) {
  858. $bestStability = $package->getStability();
  859. }
  860. $targetVersion = null;
  861. if (0 === strpos($package->getVersion(), 'dev-')) {
  862. $targetVersion = $package->getVersion();
  863. }
  864. if ($targetVersion === null && $minorOnly) {
  865. $targetVersion = '^' . $package->getVersion();
  866. }
  867. return $versionSelector->findBestCandidate($name, $targetVersion, $phpVersion, $bestStability);
  868. }
  869. private function getRepositorySet(Composer $composer)
  870. {
  871. if (!$this->repositorySet) {
  872. $this->repositorySet = new RepositorySet(new Pool($composer->getPackage()->getMinimumStability(), $composer->getPackage()->getStabilityFlags()));
  873. $this->repositorySet->addRepository(new CompositeRepository($composer->getRepositoryManager()->getRepositories()));
  874. }
  875. return $this->repositorySet;
  876. }
  877. }