class GitBitbucketDriver
@author Per Bernhardt <plb@webfactory.de>
Hierarchy
- class \Composer\Repository\Vcs\VcsDriver implements \Composer\Repository\Vcs\VcsDriverInterface
- class \Composer\Repository\Vcs\GitBitbucketDriver extends \Composer\Repository\Vcs\VcsDriver
Expanded class hierarchy of GitBitbucketDriver
File
-
vendor/
composer/ composer/ src/ Composer/ Repository/ Vcs/ GitBitbucketDriver.php, line 27
Namespace
Composer\Repository\VcsView source
class GitBitbucketDriver extends VcsDriver {
/** @var string */
protected $owner;
/** @var string */
protected $repository;
/** @var bool */
private $hasIssues = false;
/** @var ?string */
private $rootIdentifier;
/** @var array<int|string, string> Map of tag name to identifier */
private $tags;
/** @var array<int|string, string> Map of branch name to identifier */
private $branches;
/** @var string */
private $branchesUrl = '';
/** @var string */
private $tagsUrl = '';
/** @var string */
private $homeUrl = '';
/** @var string */
private $website = '';
/** @var string */
private $cloneHttpsUrl = '';
/** @var array<string, mixed> */
private $repoData;
/**
* @var ?VcsDriver
*/
protected $fallbackDriver = null;
/** @var string|null if set either git or hg */
private $vcsType;
/**
* @inheritDoc
*/
public function initialize() : void {
if (!Preg::isMatchStrictGroups('#^https?://bitbucket\\.org/([^/]+)/([^/]+?)(?:\\.git|/?)?$#i', $this->url, $match)) {
throw new \InvalidArgumentException(sprintf('The Bitbucket repository URL %s is invalid. It must be the HTTPS URL of a Bitbucket repository.', $this->url));
}
$this->owner = $match[1];
$this->repository = $match[2];
$this->originUrl = 'bitbucket.org';
$this->cache = new Cache($this->io, implode('/', [
$this->config
->get('cache-repo-dir'),
$this->originUrl,
$this->owner,
$this->repository,
]));
$this->cache
->setReadOnly($this->config
->get('cache-read-only'));
}
/**
* @inheritDoc
*/
public function getUrl() : string {
if ($this->fallbackDriver) {
return $this->fallbackDriver
->getUrl();
}
return $this->cloneHttpsUrl;
}
/**
* Attempts to fetch the repository data via the BitBucket API and
* sets some parameters which are used in other methods
*
* @phpstan-impure
*/
protected function getRepoData() : bool {
$resource = sprintf('https://api.bitbucket.org/2.0/repositories/%s/%s?%s', $this->owner, $this->repository, http_build_query([
'fields' => '-project,-owner',
], '', '&'));
$repoData = $this->fetchWithOAuthCredentials($resource, true)
->decodeJson();
if ($this->fallbackDriver) {
return false;
}
$this->parseCloneUrls($repoData['links']['clone']);
$this->hasIssues = !empty($repoData['has_issues']);
$this->branchesUrl = $repoData['links']['branches']['href'];
$this->tagsUrl = $repoData['links']['tags']['href'];
$this->homeUrl = $repoData['links']['html']['href'];
$this->website = $repoData['website'];
$this->vcsType = $repoData['scm'];
$this->repoData = $repoData;
return true;
}
/**
* @inheritDoc
*/
public function getComposerInformation(string $identifier) : ?array {
if ($this->fallbackDriver) {
return $this->fallbackDriver
->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 !== null) {
// specials for bitbucket
if (isset($composer['support']) && !is_array($composer['support'])) {
$composer['support'] = [];
}
if (!isset($composer['support']['source'])) {
$label = (array_search($identifier, $this->getTags()) ?: array_search($identifier, $this->getBranches())) ?: $identifier;
if (array_key_exists($label, $tags = $this->getTags())) {
$hash = $tags[$label];
}
elseif (array_key_exists($label, $branches = $this->getBranches())) {
$hash = $branches[$label];
}
if (!isset($hash)) {
$composer['support']['source'] = sprintf('https://%s/%s/%s/src', $this->originUrl, $this->owner, $this->repository);
}
else {
$composer['support']['source'] = sprintf('https://%s/%s/%s/src/%s/?at=%s', $this->originUrl, $this->owner, $this->repository, $hash, $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['homepage'])) {
$composer['homepage'] = empty($this->website) ? $this->homeUrl : $this->website;
}
}
$this->infoCache[$identifier] = $composer;
}
return $this->infoCache[$identifier];
}
/**
* @inheritDoc
*/
public function getFileContent(string $file, string $identifier) : ?string {
if ($this->fallbackDriver) {
return $this->fallbackDriver
->getFileContent($file, $identifier);
}
if (strpos($identifier, '/') !== false) {
$branches = $this->getBranches();
if (isset($branches[$identifier])) {
$identifier = $branches[$identifier];
}
}
$resource = sprintf('https://api.bitbucket.org/2.0/repositories/%s/%s/src/%s/%s', $this->owner, $this->repository, $identifier, $file);
return $this->fetchWithOAuthCredentials($resource)
->getBody();
}
/**
* @inheritDoc
*/
public function getChangeDate(string $identifier) : ?\DateTimeImmutable {
if ($this->fallbackDriver) {
return $this->fallbackDriver
->getChangeDate($identifier);
}
if (strpos($identifier, '/') !== false) {
$branches = $this->getBranches();
if (isset($branches[$identifier])) {
$identifier = $branches[$identifier];
}
}
$resource = sprintf('https://api.bitbucket.org/2.0/repositories/%s/%s/commit/%s?fields=date', $this->owner, $this->repository, $identifier);
$commit = $this->fetchWithOAuthCredentials($resource)
->decodeJson();
return new \DateTimeImmutable($commit['date']);
}
/**
* @inheritDoc
*/
public function getSource(string $identifier) : array {
if ($this->fallbackDriver) {
return $this->fallbackDriver
->getSource($identifier);
}
return [
'type' => $this->vcsType,
'url' => $this->getUrl(),
'reference' => $identifier,
];
}
/**
* @inheritDoc
*/
public function getDist(string $identifier) : ?array {
if ($this->fallbackDriver) {
return $this->fallbackDriver
->getDist($identifier);
}
$url = sprintf('https://bitbucket.org/%s/%s/get/%s.zip', $this->owner, $this->repository, $identifier);
return [
'type' => 'zip',
'url' => $url,
'reference' => $identifier,
'shasum' => '',
];
}
/**
* @inheritDoc
*/
public function getTags() : array {
if ($this->fallbackDriver) {
return $this->fallbackDriver
->getTags();
}
if (null === $this->tags) {
$tags = [];
$resource = sprintf('%s?%s', $this->tagsUrl, http_build_query([
'pagelen' => 100,
'fields' => 'values.name,values.target.hash,next',
'sort' => '-target.date',
], '', '&'));
$hasNext = true;
while ($hasNext) {
$tagsData = $this->fetchWithOAuthCredentials($resource)
->decodeJson();
foreach ($tagsData['values'] as $data) {
$tags[$data['name']] = $data['target']['hash'];
}
if (empty($tagsData['next'])) {
$hasNext = false;
}
else {
$resource = $tagsData['next'];
}
}
$this->tags = $tags;
}
return $this->tags;
}
/**
* @inheritDoc
*/
public function getBranches() : array {
if ($this->fallbackDriver) {
return $this->fallbackDriver
->getBranches();
}
if (null === $this->branches) {
$branches = [];
$resource = sprintf('%s?%s', $this->branchesUrl, http_build_query([
'pagelen' => 100,
'fields' => 'values.name,values.target.hash,values.heads,next',
'sort' => '-target.date',
], '', '&'));
$hasNext = true;
while ($hasNext) {
$branchData = $this->fetchWithOAuthCredentials($resource)
->decodeJson();
foreach ($branchData['values'] as $data) {
$branches[$data['name']] = $data['target']['hash'];
}
if (empty($branchData['next'])) {
$hasNext = false;
}
else {
$resource = $branchData['next'];
}
}
$this->branches = $branches;
}
return $this->branches;
}
/**
* Get the remote content.
*
* @param string $url The URL of content
*
* @return Response The result
*
* @phpstan-impure
*/
protected function fetchWithOAuthCredentials(string $url, bool $fetchingRepoData = false) : Response {
try {
return parent::getContents($url);
} catch (TransportException $e) {
$bitbucketUtil = new Bitbucket($this->io, $this->config, $this->process, $this->httpDownloader);
if (in_array($e->getCode(), [
403,
404,
], true) || 401 === $e->getCode() && strpos($e->getMessage(), 'Could not authenticate against') === 0) {
if (!$this->io
->hasAuthentication($this->originUrl) && $bitbucketUtil->authorizeOAuth($this->originUrl)) {
return parent::getContents($url);
}
if (!$this->io
->isInteractive() && $fetchingRepoData) {
$this->attemptCloneFallback();
return new Response([
'url' => 'dummy',
], 200, [], 'null');
}
}
throw $e;
}
}
/**
* Generate an SSH URL
*/
protected function generateSshUrl() : string {
return 'git@' . $this->originUrl . ':' . $this->owner . '/' . $this->repository . '.git';
}
/**
* @phpstan-impure
*
* @return true
* @throws \RuntimeException
*/
protected function attemptCloneFallback() : bool {
try {
$this->setupFallbackDriver($this->generateSshUrl());
return true;
} catch (\RuntimeException $e) {
$this->fallbackDriver = null;
$this->io
->writeError('<error>Failed to clone the ' . $this->generateSshUrl() . ' repository, try running in interactive mode' . ' so that you can enter your Bitbucket OAuth consumer credentials</error>');
throw $e;
}
}
protected function setupFallbackDriver(string $url) : void {
$this->fallbackDriver = new GitDriver([
'url' => $url,
], $this->io, $this->config, $this->httpDownloader, $this->process);
$this->fallbackDriver
->initialize();
}
/**
* @param array<array{name: string, href: string}> $cloneLinks
*/
protected function parseCloneUrls(array $cloneLinks) : void {
foreach ($cloneLinks as $cloneLink) {
if ($cloneLink['name'] === 'https') {
// Format: https://(user@)bitbucket.org/{user}/{repo}
// Strip username from URL (only present in clone URL's for private repositories)
$this->cloneHttpsUrl = Preg::replace('/https:\\/\\/([^@]+@)?/', 'https://', $cloneLink['href']);
}
}
}
/**
* @inheritDoc
*/
public function getRootIdentifier() : string {
if ($this->fallbackDriver) {
return $this->fallbackDriver
->getRootIdentifier();
}
if (null === $this->rootIdentifier) {
if (!$this->getRepoData()) {
if (!$this->fallbackDriver) {
throw new \LogicException('A fallback driver should be setup if getRepoData returns false');
}
return $this->fallbackDriver
->getRootIdentifier();
}
if ($this->vcsType !== 'git') {
throw new \RuntimeException($this->url . ' does not appear to be a git repository, use ' . $this->cloneHttpsUrl . ' but remember that Bitbucket no longer supports the mercurial repositories. ' . 'https://bitbucket.org/blog/sunsetting-mercurial-support-in-bitbucket');
}
$this->rootIdentifier = $this->repoData['mainbranch']['name'] ?? 'master';
}
return $this->rootIdentifier;
}
/**
* @inheritDoc
*/
public static function supports(IOInterface $io, Config $config, string $url, bool $deep = false) : bool {
if (!Preg::isMatch('#^https?://bitbucket\\.org/([^/]+)/([^/]+?)(\\.git|/?)?$#i', $url)) {
return false;
}
if (!extension_loaded('openssl')) {
$io->writeError('Skipping Bitbucket git driver for ' . $url . ' because the OpenSSL PHP extension is missing.', true, IOInterface::VERBOSE);
return false;
}
return true;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
GitBitbucketDriver::$branches | private | property | @var array<int|string, string> Map of branch name to identifier | ||
GitBitbucketDriver::$branchesUrl | private | property | @var string | ||
GitBitbucketDriver::$cloneHttpsUrl | private | property | @var string | ||
GitBitbucketDriver::$fallbackDriver | protected | property | |||
GitBitbucketDriver::$hasIssues | private | property | @var bool | ||
GitBitbucketDriver::$homeUrl | private | property | @var string | ||
GitBitbucketDriver::$owner | protected | property | @var string | ||
GitBitbucketDriver::$repoData | private | property | @var array<string, mixed> | ||
GitBitbucketDriver::$repository | protected | property | @var string | ||
GitBitbucketDriver::$rootIdentifier | private | property | @var ?string | ||
GitBitbucketDriver::$tags | private | property | @var array<int|string, string> Map of tag name to identifier | ||
GitBitbucketDriver::$tagsUrl | private | property | @var string | ||
GitBitbucketDriver::$vcsType | private | property | @var string|null if set either git or hg | ||
GitBitbucketDriver::$website | private | property | @var string | ||
GitBitbucketDriver::attemptCloneFallback | protected | function | @phpstan-impure | ||
GitBitbucketDriver::fetchWithOAuthCredentials | protected | function | Get the remote content. | ||
GitBitbucketDriver::generateSshUrl | protected | function | Generate an SSH URL | ||
GitBitbucketDriver::getBranches | public | function | @inheritDoc | Overrides VcsDriverInterface::getBranches | |
GitBitbucketDriver::getChangeDate | public | function | @inheritDoc | Overrides VcsDriverInterface::getChangeDate | |
GitBitbucketDriver::getComposerInformation | public | function | @inheritDoc | Overrides VcsDriver::getComposerInformation | |
GitBitbucketDriver::getDist | public | function | @inheritDoc | Overrides VcsDriverInterface::getDist | |
GitBitbucketDriver::getFileContent | public | function | @inheritDoc | Overrides VcsDriverInterface::getFileContent | |
GitBitbucketDriver::getRepoData | protected | function | Attempts to fetch the repository data via the BitBucket API and sets some parameters which are used in other methods |
||
GitBitbucketDriver::getRootIdentifier | public | function | @inheritDoc | Overrides VcsDriverInterface::getRootIdentifier | |
GitBitbucketDriver::getSource | public | function | @inheritDoc | Overrides VcsDriverInterface::getSource | |
GitBitbucketDriver::getTags | public | function | @inheritDoc | Overrides VcsDriverInterface::getTags | |
GitBitbucketDriver::getUrl | public | function | @inheritDoc | Overrides VcsDriverInterface::getUrl | |
GitBitbucketDriver::initialize | public | function | @inheritDoc | Overrides VcsDriverInterface::initialize | |
GitBitbucketDriver::parseCloneUrls | protected | function | |||
GitBitbucketDriver::setupFallbackDriver | protected | function | |||
GitBitbucketDriver::supports | public static | function | @inheritDoc | Overrides VcsDriverInterface::supports | |
VcsDriver::$cache | protected | property | @var ?Cache | ||
VcsDriver::$config | protected | property | @var Config | ||
VcsDriver::$httpDownloader | protected | property | @var HttpDownloader | ||
VcsDriver::$infoCache | protected | property | @var array<int|string, mixed> | ||
VcsDriver::$io | protected | property | @var IOInterface | ||
VcsDriver::$originUrl | protected | property | @var string | ||
VcsDriver::$process | protected | property | @var ProcessExecutor | ||
VcsDriver::$repoConfig | protected | property | @var array<string, mixed> | ||
VcsDriver::$url | protected | property | @var string | ||
VcsDriver::cleanup | public | function | @inheritDoc | Overrides VcsDriverInterface::cleanup | 1 |
VcsDriver::getBaseComposerInformation | protected | function | |||
VcsDriver::getContents | protected | function | Get the remote content. | 3 | |
VcsDriver::getScheme | protected | function | Get the https or http protocol depending on SSL support. | ||
VcsDriver::hasComposerFile | public | function | @inheritDoc | Overrides VcsDriverInterface::hasComposerFile | 1 |
VcsDriver::shouldCache | protected | function | Returns whether or not the given $identifier should be cached or not. | 1 | |
VcsDriver::__construct | final public | function | Constructor. |