src/main/java/org/apache/maven/plugin/assembly/filter/AssemblyIncludesArtifactFilter.java

package org.apache.maven.plugin.assembly.filter;

/*
 * Copyright 2001-2005 The Apache Software Foundation.
 *
 * Licensed 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.ArtifactUtils;
import org.apache.maven.artifact.resolver.filter.ArtifactFilter;
import org.codehaus.plexus.logging.Logger;
import org.codehaus.plexus.util.StringUtils;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Set;

/**
 * TODO: include in maven-artifact in future
 *
 * @author <a href="mailto:brett@apache.org">Brett Porter</a>
 */
public class AssemblyIncludesArtifactFilter
    implements ArtifactFilter, StatisticsReportingFilter
{
    private final List patterns;
    private final boolean actTransitively;
    
    private Set patternsTriggered = new HashSet();
    private List filteredArtifactIds = new ArrayList();

    public AssemblyIncludesArtifactFilter( List patterns )
    {
        this.actTransitively = false;
        this.patterns = Collections.unmodifiableList( patterns );
    }

    public AssemblyIncludesArtifactFilter( List patterns, boolean actTransitively )
    {
        this.actTransitively = actTransitively;
        this.patterns = Collections.unmodifiableList( patterns );
    }

    public boolean include( Artifact artifact )
    {
        boolean shouldInclude = patternMatches( artifact );
        
        if ( !shouldInclude )
        {
            addFilteredArtifactId( artifact.getId() );
        }
        
        return shouldInclude;
    }

    protected void addFilteredArtifactId( String artifactId )
    {
        filteredArtifactIds.add( artifactId );
    }
    
    protected boolean patternMatches( Artifact artifact )
    {
        String shortId = ArtifactUtils.versionlessKey( artifact );
        String id = artifact.getDependencyConflictId();
        
        boolean matched = false;
        for ( Iterator i = patterns.iterator(); i.hasNext() && !matched; )
        {
            // TODO: what about wildcards? Just specifying groups? versions?
            String pattern = (String) i.next();
            
            if ( id.equals( pattern ) )
            {
                matched = true;
            }
            else if ( shortId.equals( pattern ) )
            {
                matched = true;
            }
            
            if ( matched )
            {
                patternsTriggered.add( pattern );
                break;
            }
        }
        
        if ( !matched && actTransitively )
        {
            List depTrail = artifact.getDependencyTrail();
            if ( depTrail != null && !depTrail.isEmpty() )
            {
                String trailStr = StringUtils.join( depTrail.iterator(), "," );
                
                for ( Iterator it = patterns.iterator(); it.hasNext(); )
                {
                    String pattern = (String) it.next();
                    
                    if ( trailStr.indexOf( pattern ) > -1 )
                    {
                        matched = true;
                        
                        patternsTriggered.add( pattern );
                        break;
                    }
                }
            }
        }
        
        return matched;
    }

    public void reportMissedCriteria( Logger logger )
    {
        // if there are no patterns, there is nothing to report.
        if ( !patterns.isEmpty() )
        {
            List missed = new ArrayList( patterns );
            missed.removeAll( patternsTriggered );
            
            if ( !missed.isEmpty() && logger.isWarnEnabled() )
            {
                StringBuffer buffer = new StringBuffer();
                
                buffer.append( "The following patterns were never triggered in this " );
                buffer.append( getFilterDescription() );
                buffer.append( ':' );
                
                for ( Iterator it = missed.iterator(); it.hasNext(); )
                {
                    String pattern = (String) it.next();
                    
                    buffer.append( "\no  \'" ).append( pattern ).append( "\'" );
                }
                
                buffer.append( "\n" );
                
                logger.warn( buffer.toString() );
            }
        }
    }
    
    public String toString()
    {
        return "Includes filter:" + getPatternsAsString();
    }
    
    protected String getPatternsAsString()
    {
        StringBuffer buffer = new StringBuffer();
        for ( Iterator it = patterns.iterator(); it.hasNext(); )
        {
            String pattern = ( String ) it.next();
            
            buffer.append( "\no \'" ).append( pattern ).append( "\'" );
        }
        
        return buffer.toString();
    }

    protected String getFilterDescription()
    {
        return "artifact inclusion filter";
    }

    public void reportFilteredArtifacts( Logger logger )
    {
        if ( !filteredArtifactIds.isEmpty() && logger.isDebugEnabled() )
        {
            StringBuffer buffer = new StringBuffer( "The following artifacts were removed by this filter: " );
            
            for ( Iterator it = filteredArtifactIds.iterator(); it.hasNext(); )
            {
                String artifactId = ( String ) it.next();
                
                buffer.append( '\n' ).append( artifactId );
            }
            
            logger.debug( buffer.toString() );
        }
    }

}