org.xwiki.extension.version.internal.DefaultVersionConstraint Maven / Gradle / Ivy
Show all versions of xwiki-commons-extension-api Show documentation
/*
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.xwiki.extension.version.internal;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import org.apache.commons.lang3.builder.HashCodeBuilder;
import org.xwiki.extension.version.IncompatibleVersionConstraintException;
import org.xwiki.extension.version.InvalidVersionConstraintException;
import org.xwiki.extension.version.InvalidVersionRangeException;
import org.xwiki.extension.version.Version;
import org.xwiki.extension.version.VersionConstraint;
import org.xwiki.extension.version.VersionRange;
import org.xwiki.extension.version.VersionRangeCollection;
/**
* Default implementation of {@link VersionConstraint}.
*
* Mostly based on AETHER implementation which is itself based on Maven specifications. The main difference is that it
* can contains a list of ranges OR collection instead of just a OR collection to allow combining several constraints in
* one.
*
* {(,1.0],[2.0,)},{[3.0)}
*
* @see org.sonatype.aether.util.version.GenericVersionConstraint
* @version $Id: be7fe595e6f898ae2a483bd0b1ef28bf70407901 $
* @since 4.0M1
*/
public class DefaultVersionConstraint implements VersionConstraint
{
/**
* Serialization identifier.
*/
private static final long serialVersionUID = 1L;
/**
* The character used to separated version ranges.
*/
private static final char RANGE_SEPARATOR = ',';
/**
* @see #getRanges()
*/
private List ranges;
/**
* @see #getVersion()
*/
private Version version;
/**
* @see #getValue()
*/
private String value;
/**
* @param rawConstraint the version range to parse
*/
public DefaultVersionConstraint(String rawConstraint)
{
setConstraint(rawConstraint);
}
/**
* Created a new {@link DefaultVersionConstraint} by cloning the provided version constraint.
*
* @param versionConstraint the version constrain to copy
*/
public DefaultVersionConstraint(VersionConstraint versionConstraint)
{
this(versionConstraint.getRanges(), versionConstraint.getVersion());
}
/**
* @param ranges the ranges of versions
* @param version the recommended version
*/
public DefaultVersionConstraint(Collection ranges, Version version)
{
if (ranges != null && !ranges.isEmpty()) {
this.ranges = new ArrayList(ranges);
} else {
this.ranges = Collections.emptyList();
}
this.version = version;
}
/**
* @param version the recommended version
*/
public DefaultVersionConstraint(Version version)
{
this.ranges = Collections.emptyList();
this.version = version;
}
/**
* @param rawConstraint the constraint to parse
*/
private void setConstraint(String rawConstraint)
{
this.value = rawConstraint;
// Parse
List newRanges = null;
try {
newRanges = parseRanges(rawConstraint);
} catch (InvalidVersionConstraintException e) {
// Invalid range syntax, lets use it as version
}
// Version
if (newRanges == null || newRanges.isEmpty()) {
this.version = new DefaultVersion(rawConstraint);
this.ranges = Collections.emptyList();
} else {
this.ranges = newRanges;
}
}
/**
* @param rawConstraint the constraint to parse
* @return the list of version ranges
* @throws InvalidVersionConstraintException invalid constraint range syntax
*/
private List parseRanges(String rawConstraint) throws InvalidVersionConstraintException
{
String constraint = rawConstraint;
List newRanges = new ArrayList();
while (VersionUtils.startsWith(constraint, '{')) {
int index = constraint.indexOf('}');
if (index < 0) {
throw new InvalidVersionConstraintException(String.format("Unbounded version range [{%s}]",
rawConstraint));
}
String range = constraint.substring(1, index);
try {
newRanges.add(new DefaultVersionRangeCollection(range));
} catch (InvalidVersionRangeException e) {
throw new InvalidVersionConstraintException(String.format(
"Failed to parse version range [%s] in constraint [%s]", range, rawConstraint), e);
}
constraint = constraint.substring(index + 1).trim();
if (VersionUtils.startsWith(constraint, RANGE_SEPARATOR)) {
constraint = constraint.substring(1).trim();
}
}
if (!constraint.isEmpty()) {
if (newRanges.isEmpty()) {
try {
newRanges.add(new DefaultVersionRangeCollection(constraint));
} catch (InvalidVersionRangeException e) {
throw new InvalidVersionConstraintException(String.format("Failed to parse version range [{%s}]",
constraint), e);
}
} else {
throw new InvalidVersionConstraintException(String.format(
"Invalid version range [{%s}], expected [ or ( but got [{%s}]", rawConstraint, constraint));
}
}
return newRanges;
}
@Override
public Collection getRanges()
{
return this.ranges;
}
@Override
public Version getVersion()
{
return this.version;
}
@Override
public boolean containsVersion(Version version)
{
if (this.ranges.isEmpty()) {
return this.version != null && this.version.equals(version);
} else {
for (VersionRange range : this.ranges) {
if (!range.containsVersion(version)) {
return false;
}
}
}
return true;
}
@Override
public boolean isCompatible(Version version)
{
boolean compatible = true;
if (getVersion() == null) {
compatible = containsVersion(version);
} else {
compatible = version.compareTo(getVersion()) >= 0;
}
return compatible;
}
@Override
public VersionConstraint merge(VersionConstraint versionConstraint) throws IncompatibleVersionConstraintException
{
if (equals(versionConstraint)) {
return this;
} else {
VersionConstraint mergedConstraint = mergeVersions(versionConstraint);
return mergedConstraint == null ? mergeRanges(versionConstraint.getRanges()) : mergedConstraint;
}
}
/**
* @param versionConstraint the version constraint to merge
* @return the version constraint with the upper version or null if both are ranges based
* @throws IncompatibleVersionConstraintException version constraints are incompatible
*/
private VersionConstraint mergeVersions(VersionConstraint versionConstraint)
throws IncompatibleVersionConstraintException
{
if (this.version != null) {
return mergeVersions(this, versionConstraint);
} else if (versionConstraint.getVersion() != null) {
return mergeVersions(versionConstraint, this);
}
return null;
}
/**
* @param versionConstraintWithVersion the version constraint based on version
* @param versionConstraint the version constraint for which we don't know yet if it's based on version or ranges
* @return the merged version constraint
* @throws IncompatibleVersionConstraintException version constraints are incompatible
*/
private VersionConstraint mergeVersions(VersionConstraint versionConstraintWithVersion,
VersionConstraint versionConstraint) throws IncompatibleVersionConstraintException
{
if (versionConstraint.getVersion() != null) {
return versionConstraintWithVersion.getVersion().compareTo(versionConstraint.getVersion()) >= 0
? versionConstraintWithVersion : versionConstraint;
} else {
if (!versionConstraint.containsVersion(versionConstraintWithVersion.getVersion())) {
throw new IncompatibleVersionConstraintException("Version ["
+ versionConstraintWithVersion.getVersion() + "] is not part of version constraint ["
+ versionConstraint + "]");
}
return versionConstraintWithVersion;
}
}
/**
* Create a new {@link DefaultVersionConstraint} instance which is the combination of the provided version ranges
* and this version ranges.
*
* @param otherRanges the version ranges to merge with this version ranges
* @return the new {@link DefaultVersionConstraint}
* @throws IncompatibleVersionConstraintException the provided version and version ranges are not compatible with
* this version constraint
*/
// TODO: some optimizations to do like removing unnecessary ranges and avoid validating twice the same ranges
private DefaultVersionConstraint mergeRanges(Collection otherRanges)
throws IncompatibleVersionConstraintException
{
// Validate
validateCompatibility(otherRanges);
Collection newRanges =
new ArrayList(this.ranges.size() + otherRanges.size());
newRanges.addAll(this.ranges);
newRanges.addAll(otherRanges);
return new DefaultVersionConstraint(newRanges, null);
}
/**
* @param otherRanges the ranges to validate with this ranges
* @throws IncompatibleVersionConstraintException the provided ranges is not compatible with this ranges
*/
private void validateCompatibility(Collection otherRanges)
throws IncompatibleVersionConstraintException
{
for (VersionRange otherRange : otherRanges) {
for (VersionRange range : this.ranges) {
if (!range.isCompatible(otherRange)) {
throw new IncompatibleVersionConstraintException("Ranges [" + range + "] and [" + otherRange
+ "] are incompatibles");
}
}
}
}
@Override
public String getValue()
{
if (this.value == null) {
StringBuilder builder = new StringBuilder();
if (getVersion() != null) {
builder.append(getVersion());
} else {
if (this.ranges.size() == 1) {
builder.append(this.ranges.get(0).getValue());
} else {
for (VersionRange range : getRanges()) {
if (builder.length() > 0) {
builder.append(RANGE_SEPARATOR);
}
builder.append('{');
builder.append(range.getValue());
builder.append('}');
}
}
}
this.value = builder.toString();
}
return this.value;
}
// Object
@Override
public String toString()
{
return getValue();
}
@Override
public boolean equals(Object obj)
{
if (this == obj) {
return true;
}
if (obj == null || !(obj instanceof VersionConstraint)) {
return false;
}
VersionConstraint versionConstraint = (VersionConstraint) obj;
return this.ranges.equals(versionConstraint.getRanges())
&& Objects.equals(this.version, versionConstraint.getVersion());
}
@Override
public int hashCode()
{
HashCodeBuilder builder = new HashCodeBuilder(17, 31);
builder.append(getRanges());
builder.append(getVersion());
return builder.toHashCode();
}
// Serializable
/**
* @param out the stream
* @throws IOException error when serializing the version
*/
private void writeObject(ObjectOutputStream out) throws IOException
{
out.writeObject(getValue());
}
/**
* @param in the stream
* @throws IOException error when unserializing the version
* @throws ClassNotFoundException error when unserializing the version
*/
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException
{
setConstraint((String) in.readObject());
}
}