/src/Composer/Repository/Vcs/GitLabDriver.php
PHP | 582 lines | 348 code | 100 blank | 134 comment | 70 complexity | f251ba08b35826cc89f3308f121663b9 MD5 | raw file
- <?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\Cache;
- use Composer\IO\IOInterface;
- use Composer\Json\JsonFile;
- use Composer\Downloader\TransportException;
- use Composer\Util\HttpDownloader;
- use Composer\Util\GitLab;
- use Composer\Util\Http\Response;
- /**
- * Driver for GitLab API, use the Git driver for local checkouts.
- *
- * @author Henrik Bjørnskov <henrik@bjrnskov.dk>
- * @author Jérôme Tamarelle <jerome@tamarelle.net>
- */
- class GitLabDriver extends VcsDriver
- {
- private $scheme;
- private $namespace;
- private $repository;
- /**
- * @var array Project data returned by GitLab API
- */
- private $project;
- /**
- * @var array Keeps commits returned by GitLab API
- */
- private $commits = array();
- /**
- * @var array List of tag => reference
- */
- private $tags;
- /**
- * @var array List of branch => reference
- */
- private $branches;
- /**
- * Git Driver
- *
- * @var GitDriver
- */
- protected $gitDriver;
- /**
- * Defaults to true unless we can make sure it is public
- *
- * @var bool defines whether the repo is private or not
- */
- private $isPrivate = true;
- /**
- * @var bool true if the origin has a port number or a path component in it
- */
- private $hasNonstandardOrigin = false;
- const URL_REGEX = '#^(?:(?P<scheme>https?)://(?P<domain>.+?)(?::(?P<port>[0-9]+))?/|git@(?P<domain2>[^:]+):)(?P<parts>.+)/(?P<repo>[^/]+?)(?:\.git|/)?$#';
- /**
- * Extracts information from the repository url.
- *
- * SSH urls use https by default. Set "secure-http": false on the repository config to use http instead.
- *
- * {@inheritDoc}
- */
- public function initialize()
- {
- if (!preg_match(self::URL_REGEX, $this->url, $match)) {
- throw new \InvalidArgumentException('The URL provided is invalid. It must be the HTTP URL of a GitLab project.');
- }
- $guessedDomain = !empty($match['domain']) ? $match['domain'] : $match['domain2'];
- $configuredDomains = $this->config->get('gitlab-domains');
- $urlParts = explode('/', $match['parts']);
- $this->scheme = !empty($match['scheme'])
- ? $match['scheme']
- : (isset($this->repoConfig['secure-http']) && $this->repoConfig['secure-http'] === false ? 'http' : 'https')
- ;
- $this->originUrl = $this->determineOrigin($configuredDomains, $guessedDomain, $urlParts, $match['port']);
- if (false !== strpos($this->originUrl, ':') || false !== strpos($this->originUrl, '/')) {
- $this->hasNonstandardOrigin = true;
- }
- $this->namespace = implode('/', $urlParts);
- $this->repository = preg_replace('#(\.git)$#', '', $match['repo']);
- $this->cache = new Cache($this->io, $this->config->get('cache-repo-dir').'/'.$this->originUrl.'/'.$this->namespace.'/'.$this->repository);
- $this->fetchProject();
- }
- /**
- * Updates the HttpDownloader instance.
- * Mainly useful for tests.
- *
- * @internal
- */
- public function setHttpDownloader(HttpDownloader $httpDownloader)
- {
- $this->httpDownloader = $httpDownloader;
- }
- /**
- * {@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)) {
- return $this->infoCache[$identifier] = JsonFile::parseJson($res);
- }
- $composer = $this->getBaseComposerInformation($identifier);
- if ($composer) {
- // specials for gitlab (this data is only available if authentication is provided)
- if (!isset($composer['support']['issues']) && isset($this->project['_links']['issues'])) {
- $composer['support']['issues'] = $this->project['_links']['issues'];
- }
- if (!isset($composer['abandoned']) && !empty($this->project['archived'])) {
- $composer['abandoned'] = true;
- }
- }
- if ($this->shouldCache($identifier)) {
- $this->cache->write($identifier, json_encode($composer));
- }
- $this->infoCache[$identifier] = $composer;
- }
- return $this->infoCache[$identifier];
- }
- /**
- * {@inheritdoc}
- */
- public function getFileContent($file, $identifier)
- {
- if ($this->gitDriver) {
- return $this->gitDriver->getFileContent($file, $identifier);
- }
- // Convert the root identifier to a cacheable commit id
- if (!preg_match('{[a-f0-9]{40}}i', $identifier)) {
- $branches = $this->getBranches();
- if (isset($branches[$identifier])) {
- $identifier = $branches[$identifier];
- }
- }
- $resource = $this->getApiUrl().'/repository/files/'.$this->urlEncodeAll($file).'/raw?ref='.$identifier;
- try {
- $content = $this->getContents($resource)->getBody();
- } catch (TransportException $e) {
- if ($e->getCode() !== 404) {
- throw $e;
- }
- return null;
- }
- return $content;
- }
- /**
- * {@inheritdoc}
- */
- public function getChangeDate($identifier)
- {
- if ($this->gitDriver) {
- return $this->gitDriver->getChangeDate($identifier);
- }
- if (isset($this->commits[$identifier])) {
- return new \DateTime($this->commits[$identifier]['committed_date']);
- }
- return new \DateTime();
- }
- /**
- * {@inheritDoc}
- */
- public function getRepositoryUrl()
- {
- return $this->isPrivate ? $this->project['ssh_url_to_repo'] : $this->project['http_url_to_repo'];
- }
- /**
- * {@inheritDoc}
- */
- public function getUrl()
- {
- if ($this->gitDriver) {
- return $this->gitDriver->getUrl();
- }
- return $this->project['web_url'];
- }
- /**
- * {@inheritDoc}
- */
- public function getDist($identifier)
- {
- $url = $this->getApiUrl().'/repository/archive.zip?sha='.$identifier;
- return array('type' => 'zip', 'url' => $url, 'reference' => $identifier, 'shasum' => '');
- }
- /**
- * {@inheritDoc}
- */
- public function getSource($identifier)
- {
- if ($this->gitDriver) {
- return $this->gitDriver->getSource($identifier);
- }
- return array('type' => 'git', 'url' => $this->getRepositoryUrl(), 'reference' => $identifier);
- }
- /**
- * {@inheritDoc}
- */
- public function getRootIdentifier()
- {
- if ($this->gitDriver) {
- return $this->gitDriver->getRootIdentifier();
- }
- return $this->project['default_branch'];
- }
- /**
- * {@inheritDoc}
- */
- public function getBranches()
- {
- if ($this->gitDriver) {
- return $this->gitDriver->getBranches();
- }
- if (!$this->branches) {
- $this->branches = $this->getReferences('branches');
- }
- return $this->branches;
- }
- /**
- * {@inheritDoc}
- */
- public function getTags()
- {
- if ($this->gitDriver) {
- return $this->gitDriver->getTags();
- }
- if (!$this->tags) {
- $this->tags = $this->getReferences('tags');
- }
- return $this->tags;
- }
- /**
- * @return string Base URL for GitLab API v3
- */
- public function getApiUrl()
- {
- return $this->scheme.'://'.$this->originUrl.'/api/v4/projects/'.$this->urlEncodeAll($this->namespace).'%2F'.$this->urlEncodeAll($this->repository);
- }
- /**
- * Urlencode all non alphanumeric characters. rawurlencode() can not be used as it does not encode `.`
- *
- * @param string $string
- * @return string
- */
- private function urlEncodeAll($string)
- {
- $encoded = '';
- for ($i = 0; isset($string[$i]); $i++) {
- $character = $string[$i];
- if (!ctype_alnum($character) && !in_array($character, array('-', '_'), true)) {
- $character = '%' . sprintf('%02X', ord($character));
- }
- $encoded .= $character;
- }
- return $encoded;
- }
- /**
- * @param string $type
- *
- * @return string[] where keys are named references like tags or branches and the value a sha
- */
- protected function getReferences($type)
- {
- $perPage = 100;
- $resource = $this->getApiUrl().'/repository/'.$type.'?per_page='.$perPage;
- $references = array();
- do {
- $response = $this->getContents($resource);
- $data = $response->decodeJson();
- foreach ($data as $datum) {
- $references[$datum['name']] = $datum['commit']['id'];
- // Keep the last commit date of a reference to avoid
- // unnecessary API call when retrieving the composer file.
- $this->commits[$datum['commit']['id']] = $datum['commit'];
- }
- if (count($data) >= $perPage) {
- $resource = $this->getNextPage($response);
- } else {
- $resource = false;
- }
- } while ($resource);
- return $references;
- }
- protected function fetchProject()
- {
- // we need to fetch the default branch from the api
- $resource = $this->getApiUrl();
- $this->project = $this->getContents($resource, true)->decodeJson();
- if (isset($this->project['visibility'])) {
- $this->isPrivate = $this->project['visibility'] !== 'public';
- } else {
- // client is not authendicated, therefore repository has to be public
- $this->isPrivate = false;
- }
- }
- protected function attemptCloneFallback()
- {
- if ($this->isPrivate === false) {
- $url = $this->generatePublicUrl();
- } else {
- $url = $this->generateSshUrl();
- }
- try {
- // If this repository may be private and we
- // cannot ask for authentication credentials (because we
- // are not interactive) then we fallback to GitDriver.
- $this->setupGitDriver($url);
- return true;
- } catch (\RuntimeException $e) {
- $this->gitDriver = null;
- $this->io->writeError('<error>Failed to clone the '.$url.' repository, try running in interactive mode so that you can enter your credentials</error>');
- throw $e;
- }
- }
- /**
- * Generate an SSH URL
- *
- * @return string
- */
- protected function generateSshUrl()
- {
- if ($this->hasNonstandardOrigin) {
- return 'ssh://git@'.$this->originUrl.'/'.$this->namespace.'/'.$this->repository.'.git';
- }
- return 'git@' . $this->originUrl . ':'.$this->namespace.'/'.$this->repository.'.git';
- }
- protected function generatePublicUrl()
- {
- return $this->scheme . '://' . $this->originUrl . '/'.$this->namespace.'/'.$this->repository.'.git';
- }
- protected function setupGitDriver($url)
- {
- $this->gitDriver = new GitDriver(
- array('url' => $url),
- $this->io,
- $this->config,
- $this->httpDownloader,
- $this->process
- );
- $this->gitDriver->initialize();
- }
- /**
- * {@inheritDoc}
- */
- protected function getContents($url, $fetchingRepoData = false)
- {
- try {
- $response = parent::getContents($url);
- if ($fetchingRepoData) {
- $json = $response->decodeJson();
- // Accessing the API with a token with Guest (10) access will return
- // more data than unauthenticated access but no default_branch data
- // accessing files via the API will then also fail
- if (!isset($json['default_branch']) && isset($json['permissions'])) {
- $this->isPrivate = $json['visibility'] !== 'public';
- $moreThanGuestAccess = false;
- // Check both access levels (e.g. project, group)
- // - value will be null if no access is set
- // - value will be array with key access_level if set
- foreach ($json['permissions'] as $permission) {
- if ($permission && $permission['access_level'] > 10) {
- $moreThanGuestAccess = true;
- }
- }
- if (!$moreThanGuestAccess) {
- $this->io->writeError('<warning>GitLab token with Guest only access detected</warning>');
- return $this->attemptCloneFallback();
- }
- }
- // force auth as the unauthenticated version of the API is broken
- if (!isset($json['default_branch'])) {
- if (!empty($json['id'])) {
- $this->isPrivate = false;
- }
- throw new TransportException('GitLab API seems to not be authenticated as it did not return a default_branch', 401);
- }
- }
- return $response;
- } catch (TransportException $e) {
- $gitLabUtil = new GitLab($this->io, $this->config, $this->process, $this->httpDownloader);
- 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 ($gitLabUtil->authorizeOAuth($this->originUrl)) {
- return parent::getContents($url);
- }
- if (!$this->io->isInteractive()) {
- if ($this->attemptCloneFallback()) {
- return new Response(array('url' => 'dummy'), 200, array(), 'null');
- }
- }
- $this->io->writeError('<warning>Failed to download ' . $this->namespace . '/' . $this->repository . ':' . $e->getMessage() . '</warning>');
- $gitLabUtil->authorizeOAuthInteractively($this->scheme, $this->originUrl, 'Your credentials are required to fetch private repository metadata (<info>'.$this->url.'</info>)');
- return parent::getContents($url);
- case 403:
- if (!$this->io->hasAuthentication($this->originUrl) && $gitLabUtil->authorizeOAuth($this->originUrl)) {
- return parent::getContents($url);
- }
- if (!$this->io->isInteractive() && $fetchingRepoData) {
- if ($this->attemptCloneFallback()) {
- return new Response(array('url' => 'dummy'), 200, array(), 'null');
- }
- }
- throw $e;
- default:
- throw $e;
- }
- }
- }
- /**
- * Uses the config `gitlab-domains` to see if the driver supports the url for the
- * repository given.
- *
- * {@inheritDoc}
- */
- public static function supports(IOInterface $io, Config $config, $url, $deep = false)
- {
- if (!preg_match(self::URL_REGEX, $url, $match)) {
- return false;
- }
- $scheme = !empty($match['scheme']) ? $match['scheme'] : null;
- $guessedDomain = !empty($match['domain']) ? $match['domain'] : $match['domain2'];
- $urlParts = explode('/', $match['parts']);
- if (false === self::determineOrigin((array) $config->get('gitlab-domains'), $guessedDomain, $urlParts, $match['port'])) {
- return false;
- }
- if ('https' === $scheme && !extension_loaded('openssl')) {
- $io->writeError('Skipping GitLab driver for '.$url.' because the OpenSSL PHP extension is missing.', true, IOInterface::VERBOSE);
- return false;
- }
- return true;
- }
- protected function getNextPage(Response $response)
- {
- $header = $response->getHeader('link');
- $links = explode(',', $header);
- foreach ($links as $link) {
- if (preg_match('{<(.+?)>; *rel="next"}', $link, $match)) {
- return $match[1];
- }
- }
- }
- /**
- * @param array $configuredDomains
- * @param string $guessedDomain
- * @param array $urlParts
- * @return bool|string
- */
- private static function determineOrigin(array $configuredDomains, $guessedDomain, array &$urlParts, $portNumber)
- {
- $guessedDomain = strtolower($guessedDomain);
- if (in_array($guessedDomain, $configuredDomains) || ($portNumber && in_array($guessedDomain.':'.$portNumber, $configuredDomains))) {
- if ($portNumber) {
- return $guessedDomain.':'.$portNumber;
- }
- return $guessedDomain;
- }
- if ($portNumber) {
- $guessedDomain .= ':'.$portNumber;
- }
- while (null !== ($part = array_shift($urlParts))) {
- $guessedDomain .= '/' . $part;
- if (in_array($guessedDomain, $configuredDomains) || ($portNumber && in_array(preg_replace('{:\d+}', '', $guessedDomain), $configuredDomains))) {
- return $guessedDomain;
- }
- }
- return false;
- }
- }