1 | |
package org.apache.maven.report.projectinfo.dependencies.renderer; |
2 | |
|
3 | |
|
4 | |
|
5 | |
|
6 | |
|
7 | |
|
8 | |
|
9 | |
|
10 | |
|
11 | |
|
12 | |
|
13 | |
|
14 | |
|
15 | |
|
16 | |
|
17 | |
|
18 | |
|
19 | |
|
20 | |
|
21 | |
|
22 | |
import java.util.Collections; |
23 | |
import java.util.Comparator; |
24 | |
import java.util.Iterator; |
25 | |
import java.util.List; |
26 | |
import java.util.Locale; |
27 | |
import java.util.Map; |
28 | |
|
29 | |
import org.apache.maven.artifact.Artifact; |
30 | |
import org.apache.maven.artifact.factory.ArtifactFactory; |
31 | |
import org.apache.maven.artifact.repository.ArtifactRepository; |
32 | |
import org.apache.maven.doxia.sink.Sink; |
33 | |
import org.apache.maven.model.Dependency; |
34 | |
import org.apache.maven.model.License; |
35 | |
import org.apache.maven.plugin.logging.Log; |
36 | |
import org.apache.maven.project.MavenProject; |
37 | |
import org.apache.maven.project.MavenProjectBuilder; |
38 | |
import org.apache.maven.project.ProjectBuildingException; |
39 | |
import org.apache.maven.report.projectinfo.AbstractProjectInfoRenderer; |
40 | |
import org.apache.maven.report.projectinfo.ProjectInfoReportUtils; |
41 | |
import org.apache.maven.report.projectinfo.dependencies.ManagementDependencies; |
42 | |
import org.apache.maven.report.projectinfo.dependencies.RepositoryUtils; |
43 | |
import org.codehaus.plexus.i18n.I18N; |
44 | |
import org.codehaus.plexus.util.StringUtils; |
45 | |
|
46 | |
|
47 | |
|
48 | |
|
49 | |
|
50 | |
|
51 | |
public class DependencyManagementRenderer |
52 | |
extends AbstractProjectInfoRenderer |
53 | |
{ |
54 | |
private final ManagementDependencies dependencies; |
55 | |
|
56 | |
private final Log log; |
57 | |
|
58 | |
private final ArtifactFactory artifactFactory; |
59 | |
|
60 | |
private final MavenProjectBuilder mavenProjectBuilder; |
61 | |
|
62 | |
private final List<ArtifactRepository> remoteRepositories; |
63 | |
|
64 | |
private final ArtifactRepository localRepository; |
65 | |
|
66 | |
private final RepositoryUtils repoUtils; |
67 | |
|
68 | |
|
69 | |
|
70 | |
|
71 | |
|
72 | |
|
73 | |
|
74 | |
|
75 | |
|
76 | |
|
77 | |
|
78 | |
|
79 | |
|
80 | |
|
81 | |
|
82 | |
public DependencyManagementRenderer( Sink sink, Locale locale, I18N i18n, Log log, |
83 | |
ManagementDependencies dependencies, ArtifactFactory artifactFactory, |
84 | |
MavenProjectBuilder mavenProjectBuilder, |
85 | |
List<ArtifactRepository> remoteRepositories, |
86 | |
ArtifactRepository localRepository, RepositoryUtils repoUtils ) |
87 | |
{ |
88 | 1 | super( sink, i18n, locale ); |
89 | |
|
90 | 1 | this.log = log; |
91 | 1 | this.dependencies = dependencies; |
92 | 1 | this.artifactFactory = artifactFactory; |
93 | 1 | this.mavenProjectBuilder = mavenProjectBuilder; |
94 | 1 | this.remoteRepositories = remoteRepositories; |
95 | 1 | this.localRepository = localRepository; |
96 | 1 | this.repoUtils = repoUtils; |
97 | 1 | } |
98 | |
|
99 | |
|
100 | |
|
101 | |
|
102 | |
|
103 | |
@Override |
104 | |
protected String getI18Nsection() |
105 | |
{ |
106 | 9 | return "dependencyManagement"; |
107 | |
} |
108 | |
|
109 | |
@Override |
110 | |
public void renderBody() |
111 | |
{ |
112 | |
|
113 | |
|
114 | 1 | if ( !dependencies.hasDependencies() ) |
115 | |
{ |
116 | 0 | startSection( getTitle() ); |
117 | |
|
118 | 0 | paragraph( getI18nString( "nolist" ) ); |
119 | |
|
120 | 0 | endSection(); |
121 | |
|
122 | 0 | return; |
123 | |
} |
124 | |
|
125 | |
|
126 | 1 | renderSectionProjectDependencies(); |
127 | 1 | } |
128 | |
|
129 | |
|
130 | |
|
131 | |
|
132 | |
|
133 | |
private void renderSectionProjectDependencies() |
134 | |
{ |
135 | 1 | startSection( getTitle() ); |
136 | |
|
137 | |
|
138 | 1 | Map<String, List<Dependency>> dependenciesByScope = dependencies.getManagementDependenciesByScope(); |
139 | |
|
140 | 1 | renderDependenciesForAllScopes( dependenciesByScope ); |
141 | |
|
142 | 1 | endSection(); |
143 | 1 | } |
144 | |
|
145 | |
private void renderDependenciesForAllScopes( Map<String, List<Dependency>> dependenciesByScope ) |
146 | |
{ |
147 | 1 | renderDependenciesForScope( Artifact.SCOPE_COMPILE, dependenciesByScope.get( Artifact.SCOPE_COMPILE ) ); |
148 | 1 | renderDependenciesForScope( Artifact.SCOPE_RUNTIME, dependenciesByScope.get( Artifact.SCOPE_RUNTIME ) ); |
149 | 1 | renderDependenciesForScope( Artifact.SCOPE_TEST, dependenciesByScope.get( Artifact.SCOPE_TEST ) ); |
150 | 1 | renderDependenciesForScope( Artifact.SCOPE_PROVIDED, dependenciesByScope.get( Artifact.SCOPE_PROVIDED ) ); |
151 | 1 | renderDependenciesForScope( Artifact.SCOPE_SYSTEM, dependenciesByScope.get( Artifact.SCOPE_SYSTEM ) ); |
152 | 1 | } |
153 | |
|
154 | |
private String[] getDependencyTableHeader( boolean hasClassifier ) |
155 | |
{ |
156 | 1 | String groupId = getI18nString( "column.groupId" ); |
157 | 1 | String artifactId = getI18nString( "column.artifactId" ); |
158 | 1 | String version = getI18nString( "column.version" ); |
159 | 1 | String classifier = getI18nString( "column.classifier" ); |
160 | 1 | String type = getI18nString( "column.type" ); |
161 | 1 | String license = getI18nString( "column.license" ); |
162 | |
|
163 | 1 | if ( hasClassifier ) |
164 | |
{ |
165 | 0 | return new String[] { groupId, artifactId, version, classifier, type, license }; |
166 | |
} |
167 | |
|
168 | 1 | return new String[] { groupId, artifactId, version, type, license }; |
169 | |
} |
170 | |
|
171 | |
private void renderDependenciesForScope( String scope, List<Dependency> artifacts ) |
172 | |
{ |
173 | 5 | if ( artifacts != null ) |
174 | |
{ |
175 | |
|
176 | 1 | Collections.sort( artifacts, getDependencyComparator() ); |
177 | |
|
178 | 1 | startSection( scope ); |
179 | |
|
180 | 1 | paragraph( getI18nString( "intro." + scope ) ); |
181 | 1 | startTable(); |
182 | |
|
183 | 1 | boolean hasClassifier = false; |
184 | 1 | for ( Dependency dependency : artifacts ) |
185 | |
{ |
186 | 1 | if ( StringUtils.isNotEmpty( dependency.getClassifier() ) ) |
187 | |
{ |
188 | 0 | hasClassifier = true; |
189 | 0 | break; |
190 | |
} |
191 | |
} |
192 | |
|
193 | 1 | String[] tableHeader = getDependencyTableHeader( hasClassifier ); |
194 | 1 | tableHeader( tableHeader ); |
195 | |
|
196 | 1 | for ( Dependency dependency : artifacts ) |
197 | |
{ |
198 | 1 | tableRow( getDependencyRow( dependency, hasClassifier ) ); |
199 | |
} |
200 | 1 | endTable(); |
201 | |
|
202 | 1 | endSection(); |
203 | |
} |
204 | 5 | } |
205 | |
|
206 | |
private String[] getDependencyRow( Dependency dependency, boolean hasClassifier ) |
207 | |
{ |
208 | 1 | Artifact artifact = artifactFactory.createParentArtifact( dependency.getGroupId(), dependency.getArtifactId(), |
209 | |
dependency.getVersion() ); |
210 | 1 | String url = |
211 | |
ProjectInfoReportUtils.getArtifactUrl( artifactFactory, artifact, mavenProjectBuilder, remoteRepositories, |
212 | |
localRepository ); |
213 | 1 | String artifactIdCell = ProjectInfoReportUtils.getArtifactIdCell( artifact.getArtifactId(), url ); |
214 | |
|
215 | |
MavenProject artifactProject; |
216 | 1 | StringBuffer sb = new StringBuffer(); |
217 | |
try |
218 | |
{ |
219 | 1 | artifactProject = repoUtils.getMavenProjectFromRepository( artifact ); |
220 | |
@SuppressWarnings( "unchecked" ) |
221 | 1 | List<License> licenses = artifactProject.getLicenses(); |
222 | 1 | for ( Iterator<License> iterator = licenses.iterator(); iterator.hasNext(); ) |
223 | |
{ |
224 | 1 | License license = iterator.next(); |
225 | 1 | String artifactIdCell2 = ProjectInfoReportUtils.getArtifactIdCell( license.getName(), license.getUrl() ); |
226 | 1 | sb.append( artifactIdCell2 ); |
227 | 1 | } |
228 | |
} |
229 | 0 | catch ( ProjectBuildingException e ) |
230 | |
{ |
231 | 0 | log.warn( "Unable to create Maven project from repository.", e ); |
232 | 1 | } |
233 | |
|
234 | 1 | if ( hasClassifier ) |
235 | |
{ |
236 | 0 | return new String[] { dependency.getGroupId(), artifactIdCell, dependency.getVersion(), |
237 | |
dependency.getClassifier(), dependency.getType(), sb.toString() }; |
238 | |
} |
239 | |
|
240 | 1 | return new String[] { dependency.getGroupId(), artifactIdCell, dependency.getVersion(), |
241 | |
dependency.getType(), sb.toString() }; |
242 | |
} |
243 | |
|
244 | |
private Comparator<Dependency> getDependencyComparator() |
245 | |
{ |
246 | 1 | return new Comparator<Dependency>() |
247 | 1 | { |
248 | |
public int compare( Dependency a1, Dependency a2 ) |
249 | |
{ |
250 | 0 | int result = a1.getGroupId().compareTo( a2.getGroupId() ); |
251 | 0 | if ( result == 0 ) |
252 | |
{ |
253 | 0 | result = a1.getArtifactId().compareTo( a2.getArtifactId() ); |
254 | 0 | if ( result == 0 ) |
255 | |
{ |
256 | 0 | result = a1.getType().compareTo( a2.getType() ); |
257 | 0 | if ( result == 0 ) |
258 | |
{ |
259 | 0 | if ( a1.getClassifier() == null ) |
260 | |
{ |
261 | 0 | if ( a2.getClassifier() != null ) |
262 | |
{ |
263 | 0 | result = 1; |
264 | |
} |
265 | |
} |
266 | |
else |
267 | |
{ |
268 | 0 | if ( a2.getClassifier() != null ) |
269 | |
{ |
270 | 0 | result = a1.getClassifier().compareTo( a2.getClassifier() ); |
271 | |
} |
272 | |
else |
273 | |
{ |
274 | 0 | result = -1; |
275 | |
} |
276 | |
} |
277 | 0 | if ( result == 0 ) |
278 | |
{ |
279 | |
|
280 | 0 | result = a1.getVersion().compareTo( a2.getVersion() ); |
281 | |
} |
282 | |
} |
283 | |
} |
284 | |
} |
285 | |
|
286 | 0 | return result; |
287 | |
} |
288 | |
}; |
289 | |
} |
290 | |
} |