package org.apache.maven.shared.artifact.filter;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.resolver.filter.ArtifactFilter;
import org.apache.maven.artifact.versioning.DefaultArtifactVersion;
import org.apache.maven.artifact.versioning.InvalidVersionSpecificationException;
import org.apache.maven.artifact.versioning.VersionRange;
import java.util.Iterator;
import java.util.List;
/**
* Filter to include or exclude artifacts from a list of patterns. The artifact pattern syntax is of the form:
*
* <pre>
* [groupId]:[artifactId]:[type]:[version]
* </pre>
*
* <p>
* Where each pattern segment is optional and supports full and partial <code>*</code> wildcards. An empty pattern
* segment is treated as an implicit wildcard.
* </p>
*
* <p>
* For example, <code>org.apache.*</code> would match all artifacts whose group id started with
* <code>org.apache.</code>, and <code>:::*-SNAPSHOT</code> would match all snapshot artifacts.
* </p>
*
* @author <a href="mailto:markhobson@gmail.com">Mark Hobson</a>
* @version $Id: AbstractStrictPatternArtifactFilter.java 803321 2009-08-11 23:09:24Z aheritier $
*/
public abstract class AbstractStrictPatternArtifactFilter implements ArtifactFilter
{
// fields -----------------------------------------------------------------
/**
* The list of artifact patterns to match, as described above.
*/
private final List patterns;
/**
* Whether this filter should include or exclude artifacts that match the patterns.
*/
private final boolean include;
// constructors -----------------------------------------------------------
/**
* Creates a new filter that matches the specified artifact patterns and includes or excludes them according to the
* specified flag.
*
* @param patterns
* the list of artifact patterns to match, as described above
* @param include
* <code>true</code> to include artifacts that match the patterns, or <code>false</code> to exclude
* them
*/
public AbstractStrictPatternArtifactFilter( List patterns, boolean include )
{
this.patterns = patterns;
this.include = include;
}
// ArtifactFilter methods -------------------------------------------------
/*
* @see org.apache.maven.artifact.resolver.filter.ArtifactFilter#include(org.apache.maven.artifact.Artifact)
*/
public boolean include( Artifact artifact )
{
boolean matched = false;
for ( Iterator i = patterns.iterator(); i.hasNext() & !matched; )
{
String pattern = (String) i.next();
if ( include( artifact, pattern ) )
{
matched = true;
}
}
return include ? matched : !matched;
}
// private methods --------------------------------------------------------
/**
* Gets whether the specified artifact matches the specified pattern.
*
* @param artifact
* the artifact to check
* @param pattern
* the pattern to match, as defined above
* @return <code>true</code> if the specified artifact is matched by the specified pattern
*/
private boolean include( Artifact artifact, String pattern )
{
String[] tokens = new String[] {
artifact.getGroupId(),
artifact.getArtifactId(),
artifact.getType(),
artifact.getBaseVersion()
};
String[] patternTokens = pattern.split( ":" );
// fail immediately if pattern tokens outnumber tokens to match
boolean matched = ( patternTokens.length <= tokens.length );
for ( int i = 0; matched && i < patternTokens.length; i++ )
{
matched = matches( tokens[i], patternTokens[i] );
}
return matched;
}
/**
* Gets whether the specified token matches the specified pattern segment.
*
* @param token
* the token to check
* @param pattern
* the pattern segment to match, as defined above
* @return <code>true</code> if the specified token is matched by the specified pattern segment
*/
private boolean matches( String token, String pattern )
{
boolean matches;
// support full wildcard and implied wildcard
if ( "*".equals( pattern ) || pattern.length() == 0 )
{
matches = true;
}
// support contains wildcard
else if ( pattern.startsWith( "*" ) && pattern.endsWith( "*" ) )
{
String contains = pattern.substring( 1, pattern.length() - 1 );
matches = ( token.indexOf( contains ) != -1 );
}
// support leading wildcard
else if ( pattern.startsWith( "*" ) )
{
String suffix = pattern.substring( 1, pattern.length() );
matches = token.endsWith( suffix );
}
// support trailing wildcard
else if ( pattern.endsWith( "*" ) )
{
String prefix = pattern.substring( 0, pattern.length() - 1 );
matches = token.startsWith( prefix );
}
// support versions range
else if ( pattern.startsWith( "[" ) || pattern.startsWith( "(" ))
{
matches = isVersionIncludedInRange(token, pattern);
}
// support exact match
else
{
matches = token.equals( pattern );
}
return matches;
}
private boolean isVersionIncludedInRange(final String version, final String range) {
try {
return VersionRange.createFromVersionSpec(range).containsVersion(new DefaultArtifactVersion(version));
} catch (InvalidVersionSpecificationException e) {
return false;
}
}
}