568 lines
20 KiB
PHP
568 lines
20 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\Repository\Vcs;
|
|
|
|
use Composer\Config;
|
|
use Composer\Downloader\TransportException;
|
|
use Composer\Json\JsonFile;
|
|
use Composer\Cache;
|
|
use Composer\IO\IOInterface;
|
|
use Composer\Util\GitHub;
|
|
|
|
/**
|
|
* @author Jordi Boggiano <j.boggiano@seld.be>
|
|
*/
|
|
class GitHubDriver extends VcsDriver
|
|
{
|
|
protected $cache;
|
|
protected $owner;
|
|
protected $repository;
|
|
protected $tags;
|
|
protected $branches;
|
|
protected $rootIdentifier;
|
|
protected $repoData;
|
|
protected $hasIssues;
|
|
protected $infoCache = array();
|
|
protected $isPrivate = false;
|
|
private $isArchived = false;
|
|
private $fundingInfo;
|
|
|
|
/**
|
|
* Git Driver
|
|
*
|
|
* @var GitDriver
|
|
*/
|
|
protected $gitDriver;
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function initialize()
|
|
{
|
|
preg_match('#^(?:(?:https?|git)://([^/]+)/|git@([^:]+):/?)([^/]+)/(.+?)(?:\.git|/)?$#', $this->url, $match);
|
|
$this->owner = $match[3];
|
|
$this->repository = $match[4];
|
|
$this->originUrl = strtolower(!empty($match[1]) ? $match[1] : $match[2]);
|
|
if ($this->originUrl === 'www.github.com') {
|
|
$this->originUrl = 'github.com';
|
|
}
|
|
$this->cache = new Cache($this->io, $this->config->get('cache-repo-dir').'/'.$this->originUrl.'/'.$this->owner.'/'.$this->repository);
|
|
|
|
if ( $this->config->get('use-github-api') === false || (isset($this->repoConfig['no-api']) && $this->repoConfig['no-api'] ) ){
|
|
$this->setupGitDriver($this->url);
|
|
|
|
return;
|
|
}
|
|
|
|
$this->fetchRootIdentifier();
|
|
}
|
|
|
|
public function getRepositoryUrl()
|
|
{
|
|
return 'https://'.$this->originUrl.'/'.$this->owner.'/'.$this->repository;
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function getRootIdentifier()
|
|
{
|
|
if ($this->gitDriver) {
|
|
return $this->gitDriver->getRootIdentifier();
|
|
}
|
|
|
|
return $this->rootIdentifier;
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function getUrl()
|
|
{
|
|
if ($this->gitDriver) {
|
|
return $this->gitDriver->getUrl();
|
|
}
|
|
|
|
return 'https://' . $this->originUrl . '/'.$this->owner.'/'.$this->repository.'.git';
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
protected function getApiUrl()
|
|
{
|
|
if ('github.com' === $this->originUrl) {
|
|
$apiUrl = 'api.github.com';
|
|
} else {
|
|
$apiUrl = $this->originUrl . '/api/v3';
|
|
}
|
|
|
|
return 'https://' . $apiUrl;
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function getSource($identifier)
|
|
{
|
|
if ($this->gitDriver) {
|
|
return $this->gitDriver->getSource($identifier);
|
|
}
|
|
if ($this->isPrivate) {
|
|
// Private GitHub repositories should be accessed using the
|
|
// SSH version of the URL.
|
|
$url = $this->generateSshUrl();
|
|
} else {
|
|
$url = $this->getUrl();
|
|
}
|
|
|
|
return array('type' => 'git', 'url' => $url, 'reference' => $identifier);
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function getDist($identifier)
|
|
{
|
|
$url = $this->getApiUrl() . '/repos/'.$this->owner.'/'.$this->repository.'/zipball/'.$identifier;
|
|
|
|
return array('type' => 'zip', 'url' => $url, 'reference' => $identifier, 'shasum' => '');
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function getComposerInformation($identifier)
|
|
{
|
|
if ($this->gitDriver) {
|
|
return $this->gitDriver->getComposerInformation($identifier);
|
|
}
|
|
|
|
if (!isset($this->infoCache[$identifier])) {
|
|
if ($this->shouldCache($identifier) && $res = $this->cache->read($identifier)) {
|
|
$composer = JsonFile::parseJson($res);
|
|
} else {
|
|
$composer = $this->getBaseComposerInformation($identifier);
|
|
|
|
if ($this->shouldCache($identifier)) {
|
|
$this->cache->write($identifier, json_encode($composer));
|
|
}
|
|
}
|
|
|
|
if ($composer) {
|
|
// specials for github
|
|
if (!isset($composer['support']['source'])) {
|
|
$label = array_search($identifier, $this->getTags()) ?: array_search($identifier, $this->getBranches()) ?: $identifier;
|
|
$composer['support']['source'] = sprintf('https://%s/%s/%s/tree/%s', $this->originUrl, $this->owner, $this->repository, $label);
|
|
}
|
|
if (!isset($composer['support']['issues']) && $this->hasIssues) {
|
|
$composer['support']['issues'] = sprintf('https://%s/%s/%s/issues', $this->originUrl, $this->owner, $this->repository);
|
|
}
|
|
if (!isset($composer['abandoned']) && $this->isArchived) {
|
|
$composer['abandoned'] = true;
|
|
}
|
|
if (!isset($composer['funding']) && $funding = $this->getFundingInfo()) {
|
|
$composer['funding'] = $funding;
|
|
}
|
|
}
|
|
|
|
$this->infoCache[$identifier] = $composer;
|
|
}
|
|
|
|
return $this->infoCache[$identifier];
|
|
}
|
|
|
|
private function getFundingInfo()
|
|
{
|
|
if (null !== $this->fundingInfo) {
|
|
return $this->fundingInfo;
|
|
}
|
|
|
|
if ($this->originUrl !== 'github.com') {
|
|
return $this->fundingInfo = false;
|
|
}
|
|
|
|
foreach (array($this->getApiUrl() . '/repos/'.$this->owner.'/'.$this->repository.'/contents/.github/FUNDING.yml', $this->getApiUrl() . '/repos/'.$this->owner.'/.github/contents/FUNDING.yml') as $file) {
|
|
|
|
try {
|
|
$result = $this->remoteFilesystem->getContents($this->originUrl, $file, false, array(
|
|
'retry-auth-failure' => false,
|
|
));
|
|
$response = json_decode($result, true);
|
|
} catch (TransportException $e) {
|
|
continue;
|
|
}
|
|
if (empty($response['content']) || $response['encoding'] !== 'base64' || !($funding = base64_decode($response['content']))) {
|
|
continue;
|
|
}
|
|
break;
|
|
}
|
|
if (empty($funding)) {
|
|
return $this->fundingInfo = false;
|
|
}
|
|
|
|
$result = array();
|
|
$key = null;
|
|
foreach (preg_split('{\r?\n}', $funding) as $line) {
|
|
$line = trim($line);
|
|
if (preg_match('{^(\w+)\s*:\s*(.+)$}', $line, $match)) {
|
|
if (preg_match('{^\[(.*)\](?:\s*#.*)?$}', $match[2], $match2)) {
|
|
foreach (array_map('trim', preg_split('{[\'"]?\s*,\s*[\'"]?}', $match2[1])) as $item) {
|
|
$result[] = array('type' => $match[1], 'url' => trim($item, '"\' '));
|
|
}
|
|
} elseif (preg_match('{^([^#].*?)(\s+#.*)?$}', $match[2], $match2)) {
|
|
$result[] = array('type' => $match[1], 'url' => trim($match2[1], '"\' '));
|
|
}
|
|
$key = null;
|
|
} elseif (preg_match('{^(\w+)\s*:\s*#\s*$}', $line, $match)) {
|
|
$key = $match[1];
|
|
} elseif ($key && preg_match('{^-\s*(.+)(\s+#.*)?$}', $line, $match)) {
|
|
$result[] = array('type' => $key, 'url' => trim($match[1], '"\' '));
|
|
}
|
|
}
|
|
|
|
foreach ($result as $key => $item) {
|
|
switch ($item['type']) {
|
|
case 'tidelift':
|
|
$result[$key]['url'] = 'https://tidelift.com/funding/github/' . $item['url'];
|
|
break;
|
|
case 'github':
|
|
$result[$key]['url'] = 'https://github.com/' . basename($item['url']);
|
|
break;
|
|
case 'patreon':
|
|
$result[$key]['url'] = 'https://www.patreon.com/' . basename($item['url']);
|
|
break;
|
|
case 'otechie':
|
|
$result[$key]['url'] = 'https://otechie.com/' . basename($item['url']);
|
|
break;
|
|
case 'open_collective':
|
|
$result[$key]['url'] = 'https://opencollective.com/' . basename($item['url']);
|
|
break;
|
|
case 'liberapay':
|
|
$result[$key]['url'] = 'https://liberapay.com/' . basename($item['url']);
|
|
break;
|
|
case 'ko_fi':
|
|
$result[$key]['url'] = 'https://ko-fi.com/' . basename($item['url']);
|
|
break;
|
|
case 'issuehunt':
|
|
$result[$key]['url'] = 'https://issuehunt.io/r/' . $item['url'];
|
|
break;
|
|
case 'community_bridge':
|
|
$result[$key]['url'] = 'https://funding.communitybridge.org/projects/' . basename($item['url']);
|
|
break;
|
|
}
|
|
}
|
|
|
|
return $this->fundingInfo = $result;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getFileContent($file, $identifier)
|
|
{
|
|
if ($this->gitDriver) {
|
|
return $this->gitDriver->getFileContent($file, $identifier);
|
|
}
|
|
|
|
$resource = $this->getApiUrl() . '/repos/'.$this->owner.'/'.$this->repository.'/contents/' . $file . '?ref='.urlencode($identifier);
|
|
$resource = JsonFile::parseJson($this->getContents($resource));
|
|
if (empty($resource['content']) || $resource['encoding'] !== 'base64' || !($content = base64_decode($resource['content']))) {
|
|
throw new \RuntimeException('Could not retrieve ' . $file . ' for '.$identifier);
|
|
}
|
|
|
|
return $content;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getChangeDate($identifier)
|
|
{
|
|
if ($this->gitDriver) {
|
|
return $this->gitDriver->getChangeDate($identifier);
|
|
}
|
|
|
|
$resource = $this->getApiUrl() . '/repos/'.$this->owner.'/'.$this->repository.'/commits/'.urlencode($identifier);
|
|
$commit = JsonFile::parseJson($this->getContents($resource), $resource);
|
|
|
|
return new \DateTime($commit['commit']['committer']['date']);
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function getTags()
|
|
{
|
|
if ($this->gitDriver) {
|
|
return $this->gitDriver->getTags();
|
|
}
|
|
if (null === $this->tags) {
|
|
$this->tags = array();
|
|
$resource = $this->getApiUrl() . '/repos/'.$this->owner.'/'.$this->repository.'/tags?per_page=100';
|
|
|
|
do {
|
|
$tagsData = JsonFile::parseJson($this->getContents($resource), $resource);
|
|
foreach ($tagsData as $tag) {
|
|
$this->tags[$tag['name']] = $tag['commit']['sha'];
|
|
}
|
|
|
|
$resource = $this->getNextPage();
|
|
} while ($resource);
|
|
}
|
|
|
|
return $this->tags;
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function getBranches()
|
|
{
|
|
if ($this->gitDriver) {
|
|
return $this->gitDriver->getBranches();
|
|
}
|
|
if (null === $this->branches) {
|
|
$this->branches = array();
|
|
$resource = $this->getApiUrl() . '/repos/'.$this->owner.'/'.$this->repository.'/git/refs/heads?per_page=100';
|
|
|
|
do {
|
|
$branchData = JsonFile::parseJson($this->getContents($resource), $resource);
|
|
foreach ($branchData as $branch) {
|
|
$name = substr($branch['ref'], 11);
|
|
if ($name !== 'gh-pages') {
|
|
$this->branches[$name] = $branch['object']['sha'];
|
|
}
|
|
}
|
|
|
|
$resource = $this->getNextPage();
|
|
} while ($resource);
|
|
}
|
|
|
|
return $this->branches;
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public static function supports(IOInterface $io, Config $config, $url, $deep = false)
|
|
{
|
|
if (!preg_match('#^((?:https?|git)://([^/]+)/|git@([^:]+):/?)([^/]+)/(.+?)(?:\.git|/)?$#', $url, $matches)) {
|
|
return false;
|
|
}
|
|
|
|
$originUrl = !empty($matches[2]) ? $matches[2] : $matches[3];
|
|
if (!in_array(strtolower(preg_replace('{^www\.}i', '', $originUrl)), $config->get('github-domains'))) {
|
|
return false;
|
|
}
|
|
|
|
if (!extension_loaded('openssl')) {
|
|
$io->writeError('Skipping GitHub driver for '.$url.' because the OpenSSL PHP extension is missing.', true, IOInterface::VERBOSE);
|
|
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Gives back the loaded <github-api>/repos/<owner>/<repo> result
|
|
*
|
|
* @return array|null
|
|
*/
|
|
public function getRepoData()
|
|
{
|
|
$this->fetchRootIdentifier();
|
|
|
|
return $this->repoData;
|
|
}
|
|
|
|
/**
|
|
* Generate an SSH URL
|
|
*
|
|
* @return string
|
|
*/
|
|
protected function generateSshUrl()
|
|
{
|
|
if (false !== strpos($this->originUrl, ':')) {
|
|
return 'ssh://git@' . $this->originUrl . '/'.$this->owner.'/'.$this->repository.'.git';
|
|
}
|
|
|
|
return 'git@' . $this->originUrl . ':'.$this->owner.'/'.$this->repository.'.git';
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
protected function getContents($url, $fetchingRepoData = false)
|
|
{
|
|
try {
|
|
return parent::getContents($url);
|
|
} catch (TransportException $e) {
|
|
$gitHubUtil = new GitHub($this->io, $this->config, $this->process, $this->remoteFilesystem);
|
|
|
|
switch ($e->getCode()) {
|
|
case 401:
|
|
case 404:
|
|
// try to authorize only if we are fetching the main /repos/foo/bar data, otherwise it must be a real 404
|
|
if (!$fetchingRepoData) {
|
|
throw $e;
|
|
}
|
|
|
|
if ($gitHubUtil->authorizeOAuth($this->originUrl)) {
|
|
return parent::getContents($url);
|
|
}
|
|
|
|
if (!$this->io->isInteractive()) {
|
|
return $this->attemptCloneFallback();
|
|
}
|
|
|
|
$scopesIssued = array();
|
|
$scopesNeeded = array();
|
|
if ($headers = $e->getHeaders()) {
|
|
if ($scopes = $this->remoteFilesystem->findHeaderValue($headers, 'X-OAuth-Scopes')) {
|
|
$scopesIssued = explode(' ', $scopes);
|
|
}
|
|
if ($scopes = $this->remoteFilesystem->findHeaderValue($headers, 'X-Accepted-OAuth-Scopes')) {
|
|
$scopesNeeded = explode(' ', $scopes);
|
|
}
|
|
}
|
|
$scopesFailed = array_diff($scopesNeeded, $scopesIssued);
|
|
// non-authenticated requests get no scopesNeeded, so ask for credentials
|
|
// authenticated requests which failed some scopes should ask for new credentials too
|
|
if (!$headers || !count($scopesNeeded) || count($scopesFailed)) {
|
|
$gitHubUtil->authorizeOAuthInteractively($this->originUrl, 'Your GitHub credentials are required to fetch private repository metadata (<info>'.$this->url.'</info>)');
|
|
}
|
|
|
|
return parent::getContents($url);
|
|
|
|
case 403:
|
|
if (!$this->io->hasAuthentication($this->originUrl) && $gitHubUtil->authorizeOAuth($this->originUrl)) {
|
|
return parent::getContents($url);
|
|
}
|
|
|
|
if (!$this->io->isInteractive() && $fetchingRepoData) {
|
|
return $this->attemptCloneFallback();
|
|
}
|
|
|
|
$rateLimited = $gitHubUtil->isRateLimited($e->getHeaders());
|
|
|
|
if (!$this->io->hasAuthentication($this->originUrl)) {
|
|
if (!$this->io->isInteractive()) {
|
|
$this->io->writeError('<error>GitHub API limit exhausted. Failed to get metadata for the '.$this->url.' repository, try running in interactive mode so that you can enter your GitHub credentials to increase the API limit</error>');
|
|
throw $e;
|
|
}
|
|
|
|
$gitHubUtil->authorizeOAuthInteractively($this->originUrl, 'API limit exhausted. Enter your GitHub credentials to get a larger API limit (<info>'.$this->url.'</info>)');
|
|
|
|
return parent::getContents($url);
|
|
}
|
|
|
|
if ($rateLimited) {
|
|
$rateLimit = $gitHubUtil->getRateLimit($e->getHeaders());
|
|
$this->io->writeError(sprintf(
|
|
'<error>GitHub API limit (%d calls/hr) is exhausted. You are already authorized so you have to wait until %s before doing more requests</error>',
|
|
$rateLimit['limit'],
|
|
$rateLimit['reset']
|
|
));
|
|
}
|
|
|
|
throw $e;
|
|
|
|
default:
|
|
throw $e;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Fetch root identifier from GitHub
|
|
*
|
|
* @throws TransportException
|
|
*/
|
|
protected function fetchRootIdentifier()
|
|
{
|
|
if ($this->repoData) {
|
|
return;
|
|
}
|
|
|
|
$repoDataUrl = $this->getApiUrl() . '/repos/'.$this->owner.'/'.$this->repository;
|
|
|
|
$this->repoData = JsonFile::parseJson($this->getContents($repoDataUrl, true), $repoDataUrl);
|
|
if (null === $this->repoData && null !== $this->gitDriver) {
|
|
return;
|
|
}
|
|
|
|
$this->owner = $this->repoData['owner']['login'];
|
|
$this->repository = $this->repoData['name'];
|
|
|
|
$this->isPrivate = !empty($this->repoData['private']);
|
|
if (isset($this->repoData['default_branch'])) {
|
|
$this->rootIdentifier = $this->repoData['default_branch'];
|
|
} elseif (isset($this->repoData['master_branch'])) {
|
|
$this->rootIdentifier = $this->repoData['master_branch'];
|
|
} else {
|
|
$this->rootIdentifier = 'master';
|
|
}
|
|
$this->hasIssues = !empty($this->repoData['has_issues']);
|
|
$this->isArchived = !empty($this->repoData['archived']);
|
|
}
|
|
|
|
protected function attemptCloneFallback()
|
|
{
|
|
$this->isPrivate = true;
|
|
|
|
try {
|
|
// If this repository may be private (hard to say for sure,
|
|
// GitHub returns 404 for private repositories) and we
|
|
// cannot ask for authentication credentials (because we
|
|
// are not interactive) then we fallback to GitDriver.
|
|
$this->setupGitDriver($this->generateSshUrl());
|
|
|
|
return;
|
|
} catch (\RuntimeException $e) {
|
|
$this->gitDriver = null;
|
|
|
|
$this->io->writeError('<error>Failed to clone the '.$this->generateSshUrl().' repository, try running in interactive mode so that you can enter your GitHub credentials</error>');
|
|
throw $e;
|
|
}
|
|
}
|
|
|
|
protected function setupGitDriver($url)
|
|
{
|
|
$this->gitDriver = new GitDriver(
|
|
array('url' => $url),
|
|
$this->io,
|
|
$this->config,
|
|
$this->process,
|
|
$this->remoteFilesystem
|
|
);
|
|
$this->gitDriver->initialize();
|
|
}
|
|
|
|
protected function getNextPage()
|
|
{
|
|
$headers = $this->remoteFilesystem->getLastHeaders();
|
|
foreach ($headers as $header) {
|
|
if (preg_match('{^link:\s*(.+?)\s*$}i', $header, $match)) {
|
|
$links = explode(',', $match[1]);
|
|
foreach ($links as $link) {
|
|
if (preg_match('{<(.+?)>; *rel="next"}', $link, $match)) {
|
|
return $match[1];
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|