/plugins/CMS/src/Core/Package/Composer/Package/Version/VersionParser.php
PHP | 579 lines | 378 code | 75 blank | 126 comment | 92 complexity | 10c3011e4a102d5e6bf169b16df112a1 MD5 | raw file
Possible License(s): LGPL-2.1, MPL-2.0-no-copyleft-exception, GPL-3.0
- <?php
- /**
- * Licensed under The GPL-3.0 License
- * For full copyright and license information, please see the LICENSE.txt
- * Redistributions of files must retain the above copyright notice.
- *
- * @since 1.0.0
- * @author Christopher Castro <chris@quickapps.es>
- * @link http://www.quickappscms.org
- * @license http://opensource.org/licenses/gpl-3.0.html GPL-3.0 License
- */
- namespace CMS\Core\Package\Composer\Package\Version;
- use CMS\Core\Package\Composer\Package\BasePackage;
- use CMS\Core\Package\Composer\Package\Link;
- use CMS\Core\Package\Composer\Package\LinkConstraint\EmptyConstraint;
- use CMS\Core\Package\Composer\Package\LinkConstraint\MultiConstraint;
- use CMS\Core\Package\Composer\Package\LinkConstraint\VersionConstraint;
- use CMS\Core\Package\Composer\Package\PackageInterface;
- /**
- * Version parser
- *
- * @author Jordi Boggiano <j.boggiano@seld.be>
- */
- class VersionParser
- {
- private static $modifierRegex = '[._-]?(?:(stable|beta|b|RC|alpha|a|patch|pl|p)(?:[.-]?(\d+))?)?([.-]?dev)?';
- /**
- * Returns the stability of a version
- *
- * @param string $version Version
- * @return string
- */
- public static function parseStability($version)
- {
- $version = preg_replace('{#.+$}i', '', $version);
- if ('dev-' === substr($version, 0, 4) || '-dev' === substr($version, -4)) {
- return 'dev';
- }
- preg_match('{' . self::$modifierRegex . '$}i', strtolower($version), $match);
- if (!empty($match[3])) {
- return 'dev';
- }
- if (!empty($match[1])) {
- if ('beta' === $match[1] || 'b' === $match[1]) {
- return 'beta';
- }
- if ('alpha' === $match[1] || 'a' === $match[1]) {
- return 'alpha';
- }
- if ('rc' === $match[1]) {
- return 'RC';
- }
- }
- return 'stable';
- }
- /**
- * normalizeStability().
- *
- * @param string $stability stability
- * @return string
- */
- public static function normalizeStability($stability)
- {
- $stability = strtolower($stability);
- return $stability === 'rc' ? 'RC' : $stability;
- }
- /**
- * formatVersion().
- *
- * @param PackageInterface $package Package
- * @param bool $truncate Whether to truncate or not
- * @return string
- */
- public static function formatVersion(PackageInterface $package, $truncate = true)
- {
- if (!$package->isDev() || !in_array($package->getSourceType(), ['hg', 'git'])) {
- return $package->getPrettyVersion();
- }
- // if source reference is a sha1 hash -- truncate
- if ($truncate && strlen($package->getSourceReference()) === 40) {
- return $package->getPrettyVersion() . ' ' . substr($package->getSourceReference(), 0, 7);
- }
- return $package->getPrettyVersion() . ' ' . $package->getSourceReference();
- }
- /**
- * Normalizes a version string to be able to perform comparisons on it
- *
- * @param string $version Version
- * @param string $fullVersion optional complete version string to give more context
- * @throws \UnexpectedValueException
- * @return string
- */
- public function normalize($version, $fullVersion = null)
- {
- $version = trim($version);
- if (null === $fullVersion) {
- $fullVersion = $version;
- }
- // ignore aliases and just assume the alias is required instead of the source
- if (preg_match('{^([^,\s]+) +as +([^,\s]+)$}', $version, $match)) {
- $version = $match[1];
- }
- // ignore build metadata
- if (preg_match('{^([^,\s+]+)\+[^\s]+$}', $version, $match)) {
- $version = $match[1];
- }
- // match master-like branches
- if (preg_match('{^(?:dev-)?(?:master|trunk|default)$}i', $version)) {
- return '9999999-dev';
- }
- if ('dev-' === strtolower(substr($version, 0, 4))) {
- return 'dev-' . substr($version, 4);
- }
- // match classical versioning
- if (preg_match('{^v?(\d{1,3})(\.\d+)?(\.\d+)?(\.\d+)?' . self::$modifierRegex . '$}i', $version, $matches)) {
- $version = $matches[1] . (!empty($matches[2]) ? $matches[2] : '.0') . (!empty($matches[3]) ? $matches[3] : '.0') . (!empty($matches[4]) ? $matches[4] : '.0');
- $index = 5;
- } elseif (preg_match('{^v?(\d{4}(?:[.:-]?\d{2}){1,6}(?:[.:-]?\d{1,3})?)' . self::$modifierRegex . '$}i', $version, $matches)) {
- // match date-based versioning
- $version = preg_replace('{\D}', '-', $matches[1]);
- $index = 2;
- } elseif (preg_match('{^v?(\d{4,})(\.\d+)?(\.\d+)?(\.\d+)?' . self::$modifierRegex . '$}i', $version, $matches)) {
- $version = $matches[1] . (!empty($matches[2]) ? $matches[2] : '.0') . (!empty($matches[3]) ? $matches[3] : '.0') . (!empty($matches[4]) ? $matches[4] : '.0');
- $index = 5;
- }
- // add version modifiers if a version was matched
- if (isset($index)) {
- if (!empty($matches[$index])) {
- if ('stable' === $matches[$index]) {
- return $version;
- }
- $version .= '-' . $this->expandStability($matches[$index]) . (!empty($matches[$index + 1]) ? $matches[$index + 1] : '');
- }
- if (!empty($matches[$index + 2])) {
- $version .= '-dev';
- }
- return $version;
- }
- // match dev branches
- if (preg_match('{(.*?)[.-]?dev$}i', $version, $match)) {
- try {
- return $this->normalizeBranch($match[1]);
- } catch (\Exception $e) {
- }
- }
- $extraMessage = '';
- if (preg_match('{ +as +' . preg_quote($version) . '$}', $fullVersion)) {
- $extraMessage = ' in "' . $fullVersion . '", the alias must be an exact version';
- } elseif (preg_match('{^' . preg_quote($version) . ' +as +}', $fullVersion)) {
- $extraMessage = ' in "' . $fullVersion . '", the alias source must be an exact version, if it is a branch name you should prefix it with dev-';
- }
- throw new \UnexpectedValueException('Invalid version string "' . $version . '"' . $extraMessage);
- }
- /**
- * Extract numeric prefix from alias, if it is in numeric format, suitable for
- * version comparison
- *
- * @param string $branch Branch name (e.g. 2.1.x-dev)
- * @return string|false Numeric prefix if present (e.g. 2.1.) or false
- */
- public function parseNumericAliasPrefix($branch)
- {
- if (preg_match('/^(?P<version>(\d+\\.)*\d+)(?:\.x)?-dev$/i', $branch, $matches)) {
- return $matches['version'] . ".";
- }
- return false;
- }
- /**
- * Normalizes a branch name to be able to perform comparisons on it
- *
- * @param string $name Name
- * @return string
- */
- public function normalizeBranch($name)
- {
- $name = trim($name);
- if (in_array($name, [
- 'master',
- 'trunk',
- 'default'
- ])) {
- return $this->normalize($name);
- }
- if (preg_match('#^v?(\d+)(\.(?:\d+|[xX*]))?(\.(?:\d+|[xX*]))?(\.(?:\d+|[xX*]))?$#i', $name, $matches)) {
- $version = '';
- for ($i = 1; $i < 5; $i++) {
- $version .= isset($matches[$i]) ? str_replace([
- '*',
- 'X'
- ], 'x', $matches[$i]) : '.x';
- }
- return str_replace('x', '9999999', $version) . '-dev';
- }
- return 'dev-' . $name;
- }
- /**
- * @param string $source source package name
- * @param string $sourceVersion source package version (pretty version ideally)
- * @param string $description link description (e.g. requires, replaces, ..)
- * @param array $links array of package name => constraint mappings
- * @return Link[]
- */
- public function parseLinks($source, $sourceVersion, $description, $links)
- {
- $res = [];
- foreach ($links as $target => $constraint) {
- if ('self.version' === $constraint) {
- $parsedConstraint = $this->parseConstraints($sourceVersion);
- } else {
- $parsedConstraint = $this->parseConstraints($constraint);
- }
- $res[strtolower($target)] = new Link($source, $target, $parsedConstraint, $description, $constraint);
- }
- return $res;
- }
- /**
- * Parses as constraint string into LinkConstraint objects
- *
- * @param string $constraints Constraints
- * @return \Composer\Package\LinkConstraint\LinkConstraintInterface
- */
- public function parseConstraints($constraints)
- {
- $prettyConstraint = $constraints;
- if (preg_match('{^([^,\s]*?)@(' . implode('|', array_keys(BasePackage::$stabilities)) . ')$}i', $constraints, $match)) {
- $constraints = empty($match[1]) ? '*' : $match[1];
- }
- if (preg_match('{^(dev-[^,\s@]+?|[^,\s@]+?\.x-dev)#.+$}i', $constraints, $match)) {
- $constraints = $match[1];
- }
- $orConstraints = preg_split('{\s*\|\|?\s*}', trim($constraints));
- $orGroups = [];
- foreach ($orConstraints as $constraints) {
- $andConstraints = preg_split('{(?<!^|as|[=>< ,]) *(?<!-)[, ](?!-) *(?!,|as|$)}', $constraints);
- if (count($andConstraints) > 1) {
- $constraintObjects = [];
- foreach ($andConstraints as $constraint) {
- $constraintObjects = array_merge($constraintObjects, $this->parseConstraint($constraint));
- }
- } else {
- $constraintObjects = $this->parseConstraint($andConstraints[0]);
- }
- if (1 === count($constraintObjects)) {
- $constraint = $constraintObjects[0];
- } else {
- $constraint = new MultiConstraint($constraintObjects);
- }
- $orGroups[] = $constraint;
- }
- if (1 === count($orGroups)) {
- $constraint = $orGroups[0];
- } else {
- $constraint = new MultiConstraint($orGroups, false);
- }
- $constraint->setPrettyString($prettyConstraint);
- return $constraint;
- }
- /**
- * parseConstraint().
- *
- * @param string $constraint Constraint
- * @return array
- */
- public function parseConstraint($constraint)
- {
- if (preg_match('{^([^,\s]+?)@(' . implode('|', array_keys(BasePackage::$stabilities)) . ')$}i', $constraint, $match)) {
- $constraint = $match[1];
- if ($match[2] !== 'stable') {
- $stabilityModifier = $match[2];
- }
- }
- if (preg_match('{^[xX*](\.[xX*])*$}i', $constraint)) {
- return [
- new EmptyConstraint
- ];
- }
- $versionRegex = '(\d+)(?:\.(\d+))?(?:\.(\d+))?(?:\.(\d+))?' . self::$modifierRegex;
- // match tilde constraints
- // like wildcard constraints, unsuffixed tilde constraints say that they must be greater than the previous
- // version, to ensure that unstable instances of the current version are allowed.
- // however, if a stability suffix is added to the constraint, then a >= match on the current version is
- // used instead
- if (preg_match('{^~>?' . $versionRegex . '$}i', $constraint, $matches)) {
- if (substr($constraint, 0, 2) === '~>') {
- throw new \UnexpectedValueException('Could not parse version constraint ' . $constraint . ': ' . 'Invalid operator "~>", you probably meant to use the "~" operator');
- }
- // Work out which position in the version we are operating at
- if (isset($matches[4]) && '' !== $matches[4]) {
- $position = 4;
- } elseif (isset($matches[3]) && '' !== $matches[3]) {
- $position = 3;
- } elseif (isset($matches[2]) && '' !== $matches[2]) {
- $position = 2;
- } else {
- $position = 1;
- }
- // Calculate the stability suffix
- $stabilitySuffix = '';
- if (!empty($matches[5])) {
- $stabilitySuffix .= '-' . $this->expandStability($matches[5]) . (!empty($matches[6]) ? $matches[6] : '');
- }
- if (!empty($matches[7])) {
- $stabilitySuffix .= '-dev';
- }
- if (!$stabilitySuffix) {
- $stabilitySuffix = "-dev";
- }
- $lowVersion = $this->manipulateVersionString($matches, $position, 0) . $stabilitySuffix;
- $lowerBound = new VersionConstraint('>=', $lowVersion);
- // For upper bound, we increment the position of one more significance,
- // but highPosition = 0 would be illegal
- $highPosition = max(1, $position - 1);
- $highVersion = $this->manipulateVersionString($matches, $highPosition, 1) . '-dev';
- $upperBound = new VersionConstraint('<', $highVersion);
- return [
- $lowerBound,
- $upperBound
- ];
- }
- // match caret constraints
- if (preg_match('{^\^' . $versionRegex . '($)}i', $constraint, $matches)) {
- // Work out which position in the version we are operating at
- if ('0' !== $matches[1] || '' === $matches[2]) {
- $position = 1;
- } elseif ('0' !== $matches[2] || '' === $matches[3]) {
- $position = 2;
- } else {
- $position = 3;
- }
- // Calculate the stability suffix
- $stabilitySuffix = '';
- if (empty($matches[5]) && empty($matches[7])) {
- $stabilitySuffix .= '-dev';
- }
- $lowVersion = $this->normalize(substr($constraint . $stabilitySuffix, 1));
- $lowerBound = new VersionConstraint('>=', $lowVersion);
- // For upper bound, we increment the position of one more significance,
- // but highPosition = 0 would be illegal
- $highVersion = $this->manipulateVersionString($matches, $position, 1) . '-dev';
- $upperBound = new VersionConstraint('<', $highVersion);
- return [
- $lowerBound,
- $upperBound
- ];
- }
- // match wildcard constraints
- if (preg_match('{^(\d+)(?:\.(\d+))?(?:\.(\d+))?\.[xX*]$}', $constraint, $matches)) {
- if (isset($matches[3]) && '' !== $matches[3]) {
- $position = 3;
- } elseif (isset($matches[2]) && '' !== $matches[2]) {
- $position = 2;
- } else {
- $position = 1;
- }
- $lowVersion = $this->manipulateVersionString($matches, $position) . "-dev";
- $highVersion = $this->manipulateVersionString($matches, $position, 1) . "-dev";
- if ($lowVersion === "0.0.0.0-dev") {
- return [
- new VersionConstraint('<', $highVersion)
- ];
- }
- return [
- new VersionConstraint('>=', $lowVersion),
- new VersionConstraint('<', $highVersion)
- ];
- }
- // match hyphen constraints
- if (preg_match('{^(?P<from>' . $versionRegex . ') +- +(?P<to>' . $versionRegex . ')($)}i', $constraint, $matches)) {
- // Calculate the stability suffix
- $lowStabilitySuffix = '';
- if (empty($matches[6]) && empty($matches[8])) {
- $lowStabilitySuffix = '-dev';
- }
- $lowVersion = $this->normalize($matches['from']);
- $lowerBound = new VersionConstraint('>=', $lowVersion . $lowStabilitySuffix);
- $highVersion = $matches[10];
- if ((!empty($matches[11]) && !empty($matches[12])) || !empty($matches[14]) || !empty($matches[16])) {
- $highVersion = $this->normalize($matches['to']);
- $upperBound = new VersionConstraint('<=', $highVersion);
- } else {
- $highMatch = [
- '',
- $matches[10],
- $matches[11],
- $matches[12],
- $matches[13]
- ];
- $highVersion = $this->manipulateVersionString($highMatch, empty($matches[11]) ? 1 : 2, 1) . '-dev';
- $upperBound = new VersionConstraint('<', $highVersion);
- }
- return [
- $lowerBound,
- $upperBound
- ];
- }
- // match operators constraints
- if (preg_match('{^(<>|!=|>=?|<=?|==?)?\s*(.*)}', $constraint, $matches)) {
- try {
- $version = $this->normalize($matches[2]);
- if (!empty($stabilityModifier) && $this->parseStability($version) === 'stable') {
- $version .= '-' . $stabilityModifier;
- } elseif ('<' === $matches[1]) {
- if (!preg_match('/-' . self::$modifierRegex . '$/', strtolower($matches[2]))) {
- $version .= '-dev';
- }
- }
- return [
- new VersionConstraint($matches[1] ?: '=', $version)
- ];
- } catch (\Exception $e) {
- // no-catch
- }
- }
- $message = 'Could not parse version constraint ' . $constraint;
- if (isset($e)) {
- $message .= ': ' . $e->getMessage();
- }
- throw new \UnexpectedValueException($message);
- }
- /**
- * Increment, decrement, or simply pad a version number.
- *
- * Support function for {@link parseConstraint()}
- *
- * @param array $matches Array with version parts in array indexes 1,2,3,4
- * @param int $position 1,2,3,4 - which segment of the version to decrement
- * @param int $increment Increment
- * @param string $pad The string to pad version parts after $position
- * @return string The new version
- */
- public function manipulateVersionString($matches, $position, $increment = 0, $pad = '0')
- {
- for ($i = 4; $i > 0; $i--) {
- if ($i > $position) {
- $matches[$i] = $pad;
- } elseif ($i == $position && $increment) {
- $matches[$i] += $increment;
- // If $matches[$i] was 0, carry the decrement
- if ($matches[$i] < 0) {
- $matches[$i] = $pad;
- $position--;
- // Return null on a carry overflow
- if ($i == 1) {
- return;
- }
- }
- }
- }
- return $matches[1] . '.' . $matches[2] . '.' . $matches[3] . '.' . $matches[4];
- }
- /**
- * expandStability().
- *
- * @param string $stability Stability
- * @return string
- */
- public function expandStability($stability)
- {
- $stability = strtolower($stability);
- switch ($stability) {
- case 'a':
- return 'alpha';
- case 'b':
- return 'beta';
- case 'p':
- case 'pl':
- return 'patch';
- case 'rc':
- return 'RC';
- default:
- return $stability;
- }
- }
- /**
- * Parses a name/version pairs and returns an array of pairs + the
- *
- * @param array $pairs a set of package/version pairs separated by ":", "=" or " "
- * @return array[] array of arrays containing a name and (if provided) a version
- */
- public function parseNameVersionPairs(array $pairs)
- {
- $pairs = array_values($pairs);
- $result = [];
- for ($i = 0, $count = count($pairs); $i < $count; $i++) {
- $pair = preg_replace('{^([^=: ]+)[=: ](.*)$}', '$1 $2', trim($pairs[$i]));
- if (false === strpos($pair, ' ') && isset($pairs[$i + 1]) && false === strpos($pairs[$i + 1], '/')) {
- $pair .= ' ' . $pairs[$i + 1];
- $i++;
- }
- if (strpos($pair, ' ')) {
- list($name, $version) = explode(" ", $pair, 2);
- $result[] = [
- 'name' => $name,
- 'version' => $version
- ];
- } else {
- $result[] = [
- 'name' => $pair
- ];
- }
- }
- return $result;
- }
- }