1 package org.apache.maven.plugins.enforcer;
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22 import org.apache.maven.artifact.Artifact;
23 import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
24 import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;
25 import org.apache.maven.plugin.logging.Log;
26 import org.apache.maven.plugins.enforcer.utils.ArtifactUtils;
27 import org.apache.maven.project.MavenProject;
28 import org.apache.maven.shared.dependency.graph.DependencyGraphBuilder;
29 import org.apache.maven.shared.dependency.graph.DependencyGraphBuilderException;
30 import org.apache.maven.shared.dependency.graph.DependencyNode;
31 import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;
32 import org.codehaus.plexus.component.repository.exception.ComponentLookupException;
33 import java.util.HashSet;
34 import java.util.Set;
35
36
37
38
39
40
41 public abstract class AbstractBanDependencies
42 extends AbstractNonCacheableEnforcerRule
43 {
44
45
46 private boolean searchTransitive = true;
47
48 private transient DependencyGraphBuilder graphBuilder;
49
50 @Override
51 public void execute( EnforcerRuleHelper helper )
52 throws EnforcerRuleException
53 {
54
55
56 MavenProject project = null;
57 try
58 {
59 project = (MavenProject) helper.evaluate( "${project}" );
60 }
61 catch ( ExpressionEvaluationException eee )
62 {
63 throw new EnforcerRuleException( "Unable to retrieve the MavenProject: ", eee );
64 }
65
66 try
67 {
68 graphBuilder = (DependencyGraphBuilder) helper.getComponent( DependencyGraphBuilder.class );
69 }
70 catch ( ComponentLookupException e )
71 {
72
73
74 try
75 {
76 graphBuilder =
77 (DependencyGraphBuilder) helper.getComponent( DependencyGraphBuilder.class.getName(), "maven2" );
78 }
79 catch ( ComponentLookupException e1 )
80 {
81 throw new EnforcerRuleException( "Unable to lookup DependencyGraphBuilder: ", e );
82 }
83 }
84
85
86 Set<Artifact> dependencies = getDependenciesToCheck( project );
87
88
89 Set<Artifact> foundExcludes = checkDependencies( dependencies, helper.getLog() );
90
91
92 if ( foundExcludes != null && !foundExcludes.isEmpty() )
93 {
94 String message = getMessage();
95
96 StringBuilder buf = new StringBuilder();
97 if ( message != null )
98 {
99 buf.append( message + System.lineSeparator() );
100 }
101 for ( Artifact artifact : foundExcludes )
102 {
103 buf.append( getErrorMessage( artifact ) );
104 }
105 message = buf.toString() + "Use 'mvn dependency:tree' to locate the source of the banned dependencies.";
106
107 throw new EnforcerRuleException( message );
108 }
109
110 }
111
112 protected CharSequence getErrorMessage( Artifact artifact )
113 {
114 return "Found Banned Dependency: " + artifact.getId() + System.lineSeparator();
115 }
116
117 protected Set<Artifact> getDependenciesToCheck( MavenProject project )
118 {
119 Set<Artifact> dependencies = null;
120 try
121 {
122 DependencyNode node = graphBuilder.buildDependencyGraph( project, null );
123 if ( searchTransitive )
124 {
125 dependencies = ArtifactUtils.getAllDescendants( node );
126 }
127 else if ( node.getChildren() != null )
128 {
129 dependencies = new HashSet<Artifact>();
130 for ( DependencyNode depNode : node.getChildren() )
131 {
132 dependencies.add( depNode.getArtifact() );
133 }
134 }
135 }
136 catch ( DependencyGraphBuilderException e )
137 {
138
139 throw new RuntimeException( e );
140 }
141 return dependencies;
142 }
143
144
145
146
147
148
149
150
151
152 protected abstract Set<Artifact> checkDependencies( Set<Artifact> dependencies, Log log )
153 throws EnforcerRuleException;
154
155
156
157
158
159
160 public boolean isSearchTransitive()
161 {
162 return this.searchTransitive;
163 }
164
165
166
167
168
169
170 public void setSearchTransitive( boolean theSearchTransitive )
171 {
172 this.searchTransitive = theSearchTransitive;
173 }
174
175 }