package org.apache.maven.plugins.enforcer;
   
   /*
    * 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 java.util.Set;
  
  import org.apache.maven.artifact.Artifact;
  import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
  import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;
  import org.apache.maven.plugin.logging.Log;
  import org.apache.maven.project.MavenProject;
  import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;
  
  /**
   * Abstract Rule for banning dependencies.
   *
   * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
   * @version $Id: AbstractBanDependencies.java 1345332 2012-06-01 20:14:13Z rfscholte $
   */
  public abstract class AbstractBanDependencies
      extends AbstractNonCacheableEnforcerRule
  {
  
      /** Specify if transitive dependencies should be searched (default) or only look at direct dependencies. */
      private boolean searchTransitive = true;
  
      /**
       * Execute the rule.
       *
       * @param helper the helper
       * @throws EnforcerRuleException the enforcer rule exception
       */
      public void execute( EnforcerRuleHelper helper )
          throws EnforcerRuleException
      {
  
          // get the project
          MavenProject project = null;
          try
          {
              project = (MavenProject) helper.evaluate( "${project}" );
          }
          catch ( ExpressionEvaluationException eee )
          {
              throw new EnforcerRuleException( "Unable to retrieve the MavenProject: ", eee );
          }
  
          // get the correct list of dependencies
          Set<Artifact> dependencies = getDependenciesToCheck( project );
  
          // look for banned dependencies
          Set<Artifact> foundExcludes = checkDependencies( dependencies, helper.getLog() );
  
          // if any are found, fail the check but list all of them
          if ( foundExcludes != null && !foundExcludes.isEmpty() )
          {
              StringBuilder buf = new StringBuilder();
              if ( message != null )
              {
                  buf.append( message + "\n" );
              }
              for ( Artifact artifact : foundExcludes )
              {
                  buf.append( getErrorMessage( artifact ) );
              }
              message = buf.toString()+ "Use 'mvn dependency:tree' to locate the source of the banned dependencies.";
  
              throw new EnforcerRuleException( message );
          }
  
      }
  
      protected CharSequence getErrorMessage( Artifact artifact )
      {
          return "Found Banned Dependency: " + artifact.getId() + "\n";
      }
  
      @SuppressWarnings( "unchecked" )
      protected Set<Artifact> getDependenciesToCheck( MavenProject project )
      {
          Set<Artifact> dependencies = null;
          if ( searchTransitive )
         {
             dependencies = project.getArtifacts();
         }
         else
         {
             dependencies = project.getDependencyArtifacts();
         }
         return dependencies;
     }
 
     /**
      * Checks the set of dependencies against the list of excludes.
      *
      * @param dependencies the dependencies
      * @param log the log
      * @return the sets the
      * @throws EnforcerRuleException the enforcer rule exception
      */
     abstract protected Set<Artifact> checkDependencies( Set<Artifact> dependencies, Log log )
         throws EnforcerRuleException;
 
     /**
      * Gets the message.
      *
      * @return the message
      */
     public String getMessage()
     {
         return this.message;
     }
 
     /**
      * Sets the message.
      *
      * @param theMessage the message to set
      */
     public void setMessage( String theMessage )
     {
         this.message = theMessage;
     }
 
     /**
      * Checks if is search transitive.
      *
      * @return the searchTransitive
      */
     public boolean isSearchTransitive()
     {
         return this.searchTransitive;
     }
 
     /**
      * Sets the search transitive.
      *
      * @param theSearchTransitive the searchTransitive to set
      */
     public void setSearchTransitive( boolean theSearchTransitive )
     {
         this.searchTransitive = theSearchTransitive;
     }
 
 }