You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

262 lines
9.2 KiB

<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Thanks\Command;
use Composer\Command\BaseCommand;
use Composer\Composer;
use Composer\Downloader\TransportException;
use Composer\Json\JsonFile;
use Composer\Util\RemoteFilesystem;
use Composer\Factory;
use Composer\Plugin\PluginEvents;
use Composer\Plugin\PreFileDownloadEvent;
use Hirak\Prestissimo\CurlRemoteFilesystem;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
/**
* @author Nicolas Grekas <p@tchwork.com>
*/
class ThanksCommand extends BaseCommand
{
// This is a list of projects that should get a star on their main repository
// (when there is one) whenever you use any of their other repositories.
// When a project's main repo is also a dependency of their other repos (like amphp/amp),
// there is no need to list it here, as starring will transitively happen anyway.
private static $mainRepositories = [
'api-platform' => [
'name' => 'api-platform/api-platform',
'url' => 'https://github.com/api-platform/api-platform',
],
'cakephp' => [
'name' => 'cakephp/cakephp',
'url' => 'https://github.com/cakephp/cakephp',
],
'drupal' => [
'name' => 'drupal/drupal',
'url' => 'https://github.com/drupal/drupal',
],
'laravel' => [
'name' => 'laravel/laravel',
'url' => 'https://github.com/laravel/laravel',
],
'illuminate' => [
'name' => 'laravel/laravel',
'url' => 'https://github.com/laravel/laravel',
],
'nette' => [
'name' => 'nette/nette',
'url' => 'https://github.com/nette/nette',
],
'phpDocumentor' => [
'name' => 'phpDocumentor/phpDocumentor2',
'url' => 'https://github.com/phpDocumentor/phpDocumentor2',
],
'piwik' => [
'name' => 'piwik/piwik',
'url' => 'https://github.com/piwik/piwik',
],
'reactphp' => [
'name' => 'reactphp/react',
'url' => 'https://github.com/reactphp/react',
],
'sebastianbergmann' => [
'name' => 'phpunit/phpunit',
'url' => 'https://github.com/sebastianbergmann/phpunit',
],
'slimphp' => [
'name' => 'slimphp/Slim',
'url' => 'https://github.com/slimphp/Slim',
],
'Sylius' => [
'name' => 'Sylius/Sylius',
'url' => 'https://github.com/Sylius/Sylius',
],
'symfony' => [
'name' => 'symfony/symfony',
'url' => 'https://github.com/symfony/symfony',
],
'yiisoft' => [
'name' => 'yiisoft/yii2',
'url' => 'https://github.com/yiisoft/yii2',
],
'zendframework' => [
'name' => 'zendframework/zendframework',
'url' => 'https://github.com/zendframework/zendframework',
],
];
private $star = '★ ';
private $love = '💖 ';
protected function configure()
{
if ('\\' === DIRECTORY_SEPARATOR) {
$this->star = '*';
$this->love = '<3';
}
$this->setName('thanks')
->setDescription(sprintf('Give thanks (in the form of a GitHub %s) to your fellow PHP package maintainers.', $this->star))
->setDefinition([
new InputOption('dry-run', null, InputOption::VALUE_NONE, 'Don\'t actually send the stars'),
])
;
}
protected function execute(InputInterface $input, OutputInterface $output)
{
$composer = $this->getComposer();
$repo = $composer->getRepositoryManager()->getLocalRepository();
$urls = [
'composer/composer' => 'https://github.com/composer/composer',
'php/php-src' => 'https://github.com/php/php-src',
'symfony/thanks' => 'https://github.com/symfony/thanks',
];
$directPackages = $this->getDirectlyRequiredPackageNames();
// symfony/thanks shouldn't trigger thanking symfony/symfony
unset($directPackages['symfony/thanks']);
foreach ($repo->getPackages() as $package) {
$extra = $package->getExtra();
if (isset($extra['thanks']['name'], $extra['thanks']['url'])) {
$urls += [$extra['thanks']['name'] => $extra['thanks']['url']];
}
if (!$url = $package->getSourceUrl()) {
continue;
}
$urls[$package->getName()] = $url;
if (!preg_match('#^https://github.com/([^/]++)#', $url, $url)) {
continue;
}
$owner = $url[1];
// star the main repository, but only if this package is directly
// being required by the user's composer.json
if (isset(self::$mainRepositories[$owner], $directPackages[$package->getName()])) {
$urls[self::$mainRepositories[$owner]['name']] = self::$mainRepositories[$owner]['url'];
}
}
ksort($urls);
$rfs = Factory::createRemoteFilesystem($this->getIo(), $composer->getConfig());
$i = 0;
$template = '_%d: repository(owner:"%s",name:"%s"){id,viewerHasStarred}'."\n";
$graphql = '';
foreach ($urls as $package => $url) {
if (preg_match('#^https://github.com/([^/]++)/([^./]++)#', $url, $url)) {
$graphql .= sprintf($template, ++$i, $url[1], $url[2]);
$aliases['_'.$i] = [$package, $url[0]];
}
}
$failures = [];
$repos = $this->callGitHub($rfs, sprintf("query{\n%s}", $graphql), $failures);
$template = '%1$s: addStar(input:{clientMutationId:"%s",starrableId:"%s"}){clientMutationId}'."\n";
$graphql = '';
$notStarred = [];
foreach ($repos as $alias => $repo) {
if (!$repo['viewerHasStarred']) {
$graphql .= sprintf($template, $alias, $repo['id']);
$notStarred[$alias] = $repo;
}
}
if (!$notStarred) {
$output->writeln('You already starred all your GitHub dependencies.');
} else {
if (!$input->getOption('dry-run')) {
$notStarred = $this->callGitHub($rfs, sprintf("mutation{\n%s}", $graphql));
}
$output->writeln('Stars <comment>sent</> to:');
foreach ($repos as $alias => $repo) {
$output->writeln(sprintf(' %s %s - %s', $this->star, sprintf(isset($notStarred[$alias]) ? '<comment>%s</>' : '%s', $aliases[$alias][0]), $aliases[$alias][1]));
}
}
if ($failures) {
$output->writeln('');
$output->writeln('Some repositories could not be starred, please run <info>composer update</info> and try again:');
foreach ($failures as $alias => $message) {
$output->writeln(sprintf(' * %s - %s', $aliases[$alias][1], $message));
}
}
$output->writeln(sprintf("\nThanks to you! %s", $this->love));
$output->writeln("Please consider contributing back in any way if you can!");
return 0;
}
private function callGitHub(RemoteFilesystem $rfs, $graphql, &$failures = [])
{
if ($eventDispatcher = $this->getComposer()->getEventDispatcher()) {
$preFileDownloadEvent = new PreFileDownloadEvent(PluginEvents::PRE_FILE_DOWNLOAD, $rfs, 'https://api.github.com/graphql');
$eventDispatcher->dispatch($preFileDownloadEvent->getName(), $preFileDownloadEvent);
if (!$preFileDownloadEvent->getRemoteFilesystem() instanceof CurlRemoteFilesystem) {
$rfs = $preFileDownloadEvent->getRemoteFilesystem();
}
}
$result = $rfs->getContents('github.com', 'https://api.github.com/graphql', false, [
'http' => [
'method' => 'POST',
'content' => json_encode(['query' => $graphql]),
'header' => ['Content-Type: application/json'],
],
]);
$result = json_decode($result, true);
if (isset($result['errors'][0]['message'])) {
if (!$result['data']) {
throw new TransportException($result['errors'][0]['message']);
}
foreach ($result['errors'] as $error) {
foreach ($error['path'] as $path) {
$failures += [$path => $error['message']];
unset($result['data'][$path]);
}
}
}
return $result['data'];
}
private function getDirectlyRequiredPackageNames()
{
$file = new JsonFile(Factory::getComposerFile(), null, $this->getIO());
if (!$file->exists()) {
throw new \Exception('Could not find your composer.json file!');
}
$data = $file->read() + ['require' => [], 'require-dev' => []];
$data = array_keys($data['require'] + $data['require-dev']);
return array_combine($data, $data);
}
}