Viewing file:  Package.php (13.85 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?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\Package;
use Composer\Package\Version\VersionParser;
use Composer\Util\ComposerMirror;
/**
* Core package definitions that are needed to resolve dependencies and install packages
*
* @author Nils Adermann <naderman@naderman.de>
*/
class Package extends BasePackage
{
protected $type;
protected $targetDir;
protected $installationSource;
protected $sourceType;
protected $sourceUrl;
protected $sourceReference;
protected $sourceMirrors;
protected $distType;
protected $distUrl;
protected $distReference;
protected $distSha1Checksum;
protected $distMirrors;
protected $version;
protected $prettyVersion;
protected $releaseDate;
protected $extra = array();
protected $binaries = array();
protected $dev;
protected $stability;
protected $notificationUrl;
/** @var Link[] */
protected $requires = array();
/** @var Link[] */
protected $conflicts = array();
/** @var Link[] */
protected $provides = array();
/** @var Link[] */
protected $replaces = array();
/** @var Link[] */
protected $devRequires = array();
protected $suggests = array();
protected $autoload = array();
protected $devAutoload = array();
protected $includePaths = array();
protected $archiveName;
protected $archiveExcludes = array();
protected $isDefaultBranch = false;
/**
* Creates a new in memory package.
*
* @param string $name The package's name
* @param string $version The package's version
* @param string $prettyVersion The package's non-normalized version
*/
public function __construct($name, $version, $prettyVersion)
{
parent::__construct($name);
$this->version = $version;
$this->prettyVersion = $prettyVersion;
$this->stability = VersionParser::parseStability($version);
$this->dev = $this->stability === 'dev';
}
/**
* {@inheritDoc}
*/
public function isDev()
{
return $this->dev;
}
/**
* @param string $type
*/
public function setType($type)
{
$this->type = $type;
}
/**
* {@inheritDoc}
*/
public function getType()
{
return $this->type ?: 'library';
}
/**
* {@inheritDoc}
*/
public function getStability()
{
return $this->stability;
}
/**
* @param string $targetDir
*/
public function setTargetDir($targetDir)
{
$this->targetDir = $targetDir;
}
/**
* {@inheritDoc}
*/
public function getTargetDir()
{
if (null === $this->targetDir) {
return;
}
return ltrim(preg_replace('{ (?:^|[\\\\/]+) \.\.? (?:[\\\\/]+|$) (?:\.\.? (?:[\\\\/]+|$) )*}x', '/', $this->targetDir), '/');
}
/**
* @param array $extra
*/
public function setExtra(array $extra)
{
$this->extra = $extra;
}
/**
* {@inheritDoc}
*/
public function getExtra()
{
return $this->extra;
}
/**
* @param array $binaries
*/
public function setBinaries(array $binaries)
{
$this->binaries = $binaries;
}
/**
* {@inheritDoc}
*/
public function getBinaries()
{
return $this->binaries;
}
/**
* {@inheritDoc}
*/
public function setInstallationSource($type)
{
$this->installationSource = $type;
}
/**
* {@inheritDoc}
*/
public function getInstallationSource()
{
return $this->installationSource;
}
/**
* @param string $type
*/
public function setSourceType($type)
{
$this->sourceType = $type;
}
/**
* {@inheritDoc}
*/
public function getSourceType()
{
return $this->sourceType;
}
/**
* @param string $url
*/
public function setSourceUrl($url)
{
$this->sourceUrl = $url;
}
/**
* {@inheritDoc}
*/
public function getSourceUrl()
{
return $this->sourceUrl;
}
/**
* @param string $reference
*/
public function setSourceReference($reference)
{
$this->sourceReference = $reference;
}
/**
* {@inheritDoc}
*/
public function getSourceReference()
{
return $this->sourceReference;
}
/**
* @param array|null $mirrors
*/
public function setSourceMirrors($mirrors)
{
$this->sourceMirrors = $mirrors;
}
/**
* {@inheritDoc}
*/
public function getSourceMirrors()
{
return $this->sourceMirrors;
}
/**
* {@inheritDoc}
*/
public function getSourceUrls()
{
return $this->getUrls($this->sourceUrl, $this->sourceMirrors, $this->sourceReference, $this->sourceType, 'source');
}
/**
* @param string $type
*/
public function setDistType($type)
{
$this->distType = $type;
}
/**
* {@inheritDoc}
*/
public function getDistType()
{
return $this->distType;
}
/**
* @param string $url
*/
public function setDistUrl($url)
{
$this->distUrl = $url;
}
/**
* {@inheritDoc}
*/
public function getDistUrl()
{
return $this->distUrl;
}
/**
* @param string $reference
*/
public function setDistReference($reference)
{
$this->distReference = $reference;
}
/**
* {@inheritDoc}
*/
public function getDistReference()
{
return $this->distReference;
}
/**
* @param string $sha1checksum
*/
public function setDistSha1Checksum($sha1checksum)
{
$this->distSha1Checksum = $sha1checksum;
}
/**
* {@inheritDoc}
*/
public function getDistSha1Checksum()
{
return $this->distSha1Checksum;
}
/**
* @param array|null $mirrors
*/
public function setDistMirrors($mirrors)
{
$this->distMirrors = $mirrors;
}
/**
* {@inheritDoc}
*/
public function getDistMirrors()
{
return $this->distMirrors;
}
/**
* {@inheritDoc}
*/
public function getDistUrls()
{
return $this->getUrls($this->distUrl, $this->distMirrors, $this->distReference, $this->distType, 'dist');
}
/**
* {@inheritDoc}
*/
public function getVersion()
{
return $this->version;
}
/**
* {@inheritDoc}
*/
public function getPrettyVersion()
{
return $this->prettyVersion;
}
/**
* Set the releaseDate
*
* @param \DateTime $releaseDate
*/
public function setReleaseDate(\DateTime $releaseDate)
{
$this->releaseDate = $releaseDate;
}
/**
* {@inheritDoc}
*/
public function getReleaseDate()
{
return $this->releaseDate;
}
/**
* Set the required packages
*
* @param Link[] $requires A set of package links
*/
public function setRequires(array $requires)
{
$this->requires = $requires;
}
/**
* {@inheritDoc}
*/
public function getRequires()
{
return $this->requires;
}
/**
* Set the conflicting packages
*
* @param Link[] $conflicts A set of package links
*/
public function setConflicts(array $conflicts)
{
$this->conflicts = $conflicts;
}
/**
* {@inheritDoc}
*/
public function getConflicts()
{
return $this->conflicts;
}
/**
* Set the provided virtual packages
*
* @param Link[] $provides A set of package links
*/
public function setProvides(array $provides)
{
$this->provides = $provides;
}
/**
* {@inheritDoc}
*/
public function getProvides()
{
return $this->provides;
}
/**
* Set the packages this one replaces
*
* @param Link[] $replaces A set of package links
*/
public function setReplaces(array $replaces)
{
$this->replaces = $replaces;
}
/**
* {@inheritDoc}
*/
public function getReplaces()
{
return $this->replaces;
}
/**
* Set the recommended packages
*
* @param Link[] $devRequires A set of package links
*/
public function setDevRequires(array $devRequires)
{
$this->devRequires = $devRequires;
}
/**
* {@inheritDoc}
*/
public function getDevRequires()
{
return $this->devRequires;
}
/**
* Set the suggested packages
*
* @param array $suggests A set of package names/comments
*/
public function setSuggests(array $suggests)
{
$this->suggests = $suggests;
}
/**
* {@inheritDoc}
*/
public function getSuggests()
{
return $this->suggests;
}
/**
* Set the autoload mapping
*
* @param array $autoload Mapping of autoloading rules
*/
public function setAutoload(array $autoload)
{
$this->autoload = $autoload;
}
/**
* {@inheritDoc}
*/
public function getAutoload()
{
return $this->autoload;
}
/**
* Set the dev autoload mapping
*
* @param array $devAutoload Mapping of dev autoloading rules
*/
public function setDevAutoload(array $devAutoload)
{
$this->devAutoload = $devAutoload;
}
/**
* {@inheritDoc}
*/
public function getDevAutoload()
{
return $this->devAutoload;
}
/**
* Sets the list of paths added to PHP's include path.
*
* @param array $includePaths List of directories.
*/
public function setIncludePaths(array $includePaths)
{
$this->includePaths = $includePaths;
}
/**
* {@inheritDoc}
*/
public function getIncludePaths()
{
return $this->includePaths;
}
/**
* Sets the notification URL
*
* @param string $notificationUrl
*/
public function setNotificationUrl($notificationUrl)
{
$this->notificationUrl = $notificationUrl;
}
/**
* {@inheritDoc}
*/
public function getNotificationUrl()
{
return $this->notificationUrl;
}
/**
* Sets default base filename for archive
*
* @param string $name
*/
public function setArchiveName($name)
{
$this->archiveName = $name;
}
/**
* {@inheritDoc}
*/
public function getArchiveName()
{
return $this->archiveName;
}
/**
* Sets a list of patterns to be excluded from archives
*
* @param array $excludes
*/
public function setArchiveExcludes(array $excludes)
{
$this->archiveExcludes = $excludes;
}
/**
* {@inheritDoc}
*/
public function getArchiveExcludes()
{
return $this->archiveExcludes;
}
/**
* @param bool $defaultBranch
*/
public function setIsDefaultBranch($defaultBranch)
{
$this->isDefaultBranch = $defaultBranch;
}
/**
* {@inheritDoc}
*/
public function isDefaultBranch()
{
return $this->isDefaultBranch;
}
/**
* {@inheritDoc}
*/
public function setSourceDistReferences($reference)
{
$this->setSourceReference($reference);
// only bitbucket, github and gitlab have auto generated dist URLs that easily allow replacing the reference in the dist URL
// TODO generalize this a bit for self-managed/on-prem versions? Some kind of replace token in dist urls which allow this?
if (preg_match('{^https?://(?:(?:www\.)?bitbucket\.org|(api\.)?github\.com|(?:www\.)?gitlab\.com)/}i', $this->getDistUrl())) {
$this->setDistReference($reference);
$this->setDistUrl(preg_replace('{(?<=/|sha=)[a-f0-9]{40}(?=/|$)}i', $reference, $this->getDistUrl()));
} elseif ($this->getDistReference()) { // update the dist reference if there was one, but if none was provided ignore it
$this->setDistReference($reference);
}
}
/**
* Replaces current version and pretty version with passed values.
* It also sets stability.
*
* @param string $version The package's normalized version
* @param string $prettyVersion The package's non-normalized version
*/
public function replaceVersion($version, $prettyVersion)
{
$this->version = $version;
$this->prettyVersion = $prettyVersion;
$this->stability = VersionParser::parseStability($version);
$this->dev = $this->stability === 'dev';
}
protected function getUrls($url, $mirrors, $ref, $type, $urlType)
{
if (!$url) {
return array();
}
$urls = array($url);
if ($mirrors) {
foreach ($mirrors as $mirror) {
if ($urlType === 'dist') {
$mirrorUrl = ComposerMirror::processUrl($mirror['url'], $this->name, $this->version, $ref, $type);
} elseif ($urlType === 'source' && $type === 'git') {
$mirrorUrl = ComposerMirror::processGitUrl($mirror['url'], $this->name, $url, $type);
} elseif ($urlType === 'source' && $type === 'hg') {
$mirrorUrl = ComposerMirror::processHgUrl($mirror['url'], $this->name, $url, $type);
} else {
continue;
}
if (!\in_array($mirrorUrl, $urls)) {
$func = $mirror['preferred'] ? 'array_unshift' : 'array_push';
$func($urls, $mirrorUrl);
}
}
}
return $urls;
}
}
|