1 package org.apache.maven.plugins.site.render;
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.doxia.site.decoration.DecorationModel;
24 import org.apache.maven.doxia.site.decoration.Menu;
25 import org.apache.maven.doxia.site.decoration.MenuItem;
26 import org.apache.maven.doxia.siterenderer.DocumentRenderer;
27 import org.apache.maven.doxia.siterenderer.Renderer;
28 import org.apache.maven.doxia.siterenderer.RendererException;
29 import org.apache.maven.doxia.siterenderer.RenderingContext;
30 import org.apache.maven.doxia.siterenderer.SiteRenderingContext;
31 import org.apache.maven.doxia.tools.SiteToolException;
32 import org.apache.maven.execution.MavenSession;
33 import org.apache.maven.model.ReportPlugin;
34 import org.apache.maven.model.Reporting;
35 import org.apache.maven.plugin.MojoExecutionException;
36 import org.apache.maven.plugin.MojoFailureException;
37 import org.apache.maven.plugin.descriptor.PluginDescriptor;
38 import org.apache.maven.plugins.annotations.Component;
39 import org.apache.maven.plugins.annotations.Parameter;
40 import org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo;
41 import org.apache.maven.reporting.MavenReport;
42 import org.apache.maven.reporting.exec.MavenReportExecution;
43 import org.apache.maven.reporting.exec.MavenReportExecutor;
44 import org.apache.maven.reporting.exec.MavenReportExecutorRequest;
45 import org.codehaus.plexus.util.ReaderFactory;
46 import org.codehaus.plexus.util.StringUtils;
47
48 import java.io.File;
49 import java.io.IOException;
50 import java.util.ArrayList;
51 import java.util.Collection;
52 import java.util.HashMap;
53 import java.util.Iterator;
54 import java.util.LinkedHashMap;
55 import java.util.List;
56 import java.util.Locale;
57 import java.util.Map;
58
59 import static org.apache.maven.shared.utils.logging.MessageUtils.buffer;
60
61
62
63
64
65
66
67 public abstract class AbstractSiteRenderingMojo extends AbstractSiteDescriptorMojo
68 {
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85 @Parameter
86 private Map<String, String> moduleExcludes;
87
88
89
90
91
92 @Parameter
93 private Map<String, Object> attributes;
94
95
96
97
98 @Component
99 protected Renderer siteRenderer;
100
101
102
103
104 @Parameter( defaultValue = "${reports}", required = true, readonly = true )
105 protected List<MavenReport> reports;
106
107
108
109
110
111
112 @Parameter( defaultValue = "${basedir}/xdocs" )
113 private File xdocDirectory;
114
115
116
117
118
119
120
121
122
123
124
125 @Parameter( alias = "workingDirectory", defaultValue = "${project.build.directory}/generated-site" )
126 protected File generatedSiteDirectory;
127
128
129
130
131 @Parameter( defaultValue = "${session}", readonly = true, required = true )
132 protected MavenSession mavenSession;
133
134
135
136
137
138
139
140 @Parameter( defaultValue = "${project.reporting}", readonly = true )
141 private Reporting reporting;
142
143
144
145
146
147
148 @Parameter( property = "generateProjectInfo", defaultValue = "true" )
149 private boolean generateProjectInfo;
150
151
152
153
154
155
156 @Parameter( property = "encoding", defaultValue = "${project.build.sourceEncoding}" )
157 private String inputEncoding;
158
159
160
161
162
163
164 @Parameter( property = "outputEncoding", defaultValue = "${project.reporting.outputEncoding}" )
165 private String outputEncoding;
166
167 @Component
168 protected MavenReportExecutor mavenReportExecutor;
169
170
171
172
173
174
175 protected String getInputEncoding()
176 {
177 return ( StringUtils.isEmpty( inputEncoding ) ) ? ReaderFactory.FILE_ENCODING : inputEncoding;
178 }
179
180
181
182
183
184
185 protected String getOutputEncoding()
186 {
187 return ( outputEncoding == null ) ? ReaderFactory.UTF_8 : outputEncoding;
188 }
189
190
191
192
193
194
195
196 @Parameter
197 private boolean saveProcessedContent;
198
199 protected void checkInputEncoding()
200 {
201 if ( StringUtils.isEmpty( inputEncoding ) )
202 {
203 getLog().warn( "Input file encoding has not been set, using platform encoding "
204 + ReaderFactory.FILE_ENCODING + ", i.e. build is platform dependent!" );
205 }
206 }
207
208 protected List<MavenReportExecution> getReports()
209 throws MojoExecutionException
210 {
211 MavenReportExecutorRequest mavenReportExecutorRequest = new MavenReportExecutorRequest();
212 mavenReportExecutorRequest.setLocalRepository( localRepository );
213 mavenReportExecutorRequest.setMavenSession( mavenSession );
214 mavenReportExecutorRequest.setProject( project );
215 mavenReportExecutorRequest.setReportPlugins( getReportingPlugins() );
216
217 List<MavenReportExecution> allReports = mavenReportExecutor.buildMavenReports( mavenReportExecutorRequest );
218
219
220 List<MavenReportExecution> reportExecutions = new ArrayList<>( allReports.size() );
221 for ( MavenReportExecution exec : allReports )
222 {
223 if ( exec.canGenerateReport() )
224 {
225 reportExecutions.add( exec );
226 }
227 }
228 return reportExecutions;
229 }
230
231
232
233
234
235
236
237
238 private ReportPlugin[] getReportingPlugins()
239 {
240 List<ReportPlugin> reportingPlugins = reporting.getPlugins();
241
242
243 boolean hasMavenProjectInfoReportsPlugin = false;
244 for ( ReportPlugin plugin : reportingPlugins )
245 {
246 if ( "org.apache.maven.plugins".equals( plugin.getGroupId() )
247 && "maven-project-info-reports-plugin".equals( plugin.getArtifactId() ) )
248 {
249 hasMavenProjectInfoReportsPlugin = true;
250 break;
251 }
252 }
253
254 if ( !reporting.isExcludeDefaults() && !hasMavenProjectInfoReportsPlugin )
255 {
256 ReportPlugin mpir = new ReportPlugin();
257 mpir.setArtifactId( "maven-project-info-reports-plugin" );
258 reportingPlugins.add( mpir );
259 }
260 return reportingPlugins.toArray( new ReportPlugin[reportingPlugins.size()] );
261 }
262
263 protected SiteRenderingContext createSiteRenderingContext( Locale locale )
264 throws MojoExecutionException, IOException, MojoFailureException
265 {
266 DecorationModel decorationModel = prepareDecorationModel( locale );
267 if ( attributes == null )
268 {
269 attributes = new HashMap<>();
270 }
271
272 if ( attributes.get( "project" ) == null )
273 {
274 attributes.put( "project", project );
275 }
276
277 if ( attributes.get( "inputEncoding" ) == null )
278 {
279 attributes.put( "inputEncoding", getInputEncoding() );
280 }
281
282 if ( attributes.get( "outputEncoding" ) == null )
283 {
284 attributes.put( "outputEncoding", getOutputEncoding() );
285 }
286
287
288 for ( Map.Entry<Object, Object> entry : project.getProperties().entrySet() )
289 {
290 attributes.put( (String) entry.getKey(), entry.getValue() );
291 }
292
293 SiteRenderingContext context;
294 try
295 {
296 Artifact skinArtifact =
297 siteTool.getSkinArtifactFromRepository( localRepository, repositories, decorationModel );
298
299 getLog().info( buffer().a( "Rendering content with " ).strong( skinArtifact.getId()
300 + " skin" ).a( '.' ).toString() );
301
302 context = siteRenderer.createContextForSkin( skinArtifact, attributes, decorationModel,
303 project.getName(), locale );
304 }
305 catch ( SiteToolException e )
306 {
307 throw new MojoExecutionException( "SiteToolException while preparing skin: " + e.getMessage(), e );
308 }
309 catch ( RendererException e )
310 {
311 throw new MojoExecutionException( "RendererException while preparing context for skin: "
312 + e.getMessage(), e );
313 }
314
315
316 context.setRootDirectory( project.getBasedir() );
317 if ( !locale.getLanguage().equals( Locale.getDefault().getLanguage() ) )
318 {
319 context.addSiteDirectory( new File( siteDirectory, locale.getLanguage() ) );
320 context.addModuleDirectory( new File( xdocDirectory, locale.getLanguage() ), "xdoc" );
321 context.addModuleDirectory( new File( xdocDirectory, locale.getLanguage() ), "fml" );
322 }
323 else
324 {
325 context.addSiteDirectory( siteDirectory );
326 context.addModuleDirectory( xdocDirectory, "xdoc" );
327 context.addModuleDirectory( xdocDirectory, "fml" );
328 }
329
330 if ( moduleExcludes != null )
331 {
332 context.setModuleExcludes( moduleExcludes );
333 }
334
335 if ( saveProcessedContent )
336 {
337 context.setProcessedContentOutput( new File( generatedSiteDirectory, "processed" ) );
338 }
339
340 return context;
341 }
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356 protected Map<String, MavenReport> locateReports( List<MavenReportExecution> reports,
357 Map<String, DocumentRenderer> documents, Locale locale )
358 {
359
360 List<MavenReportExecution> filtered = new ArrayList<>( reports );
361
362 Map<String, MavenReport> reportsByOutputName = new LinkedHashMap<>();
363 for ( MavenReportExecution mavenReportExecution : filtered )
364 {
365 MavenReport report = mavenReportExecution.getMavenReport();
366
367 String outputName = report.getOutputName() + ".html";
368
369
370 reportsByOutputName.put( report.getOutputName(), report );
371
372 if ( documents.containsKey( outputName ) )
373 {
374 String reportMojoInfo =
375 ( mavenReportExecution.getGoal() == null ) ? "" : ( " ("
376 + mavenReportExecution.getPlugin().getArtifactId() + ':'
377 + mavenReportExecution.getPlugin().getVersion() + ':' + mavenReportExecution.getGoal() + ')' );
378
379 getLog().info( "Skipped \"" + report.getName( locale ) + "\" report" + reportMojoInfo + ", file \""
380 + outputName + "\" already exists." );
381
382 reports.remove( mavenReportExecution );
383 }
384 else
385 {
386 String reportMojoInfo = mavenReportExecution.getPlugin().getGroupId() + ':'
387 + mavenReportExecution.getPlugin().getArtifactId() + ':'
388 + mavenReportExecution.getPlugin().getVersion() + ':' + mavenReportExecution.getGoal();
389 RenderingContext renderingContext = new RenderingContext( siteDirectory, outputName, reportMojoInfo );
390 DocumentRenderer renderer =
391 new ReportDocumentRenderer( mavenReportExecution, renderingContext, getLog() );
392 documents.put( outputName, renderer );
393 }
394 }
395 return reportsByOutputName;
396 }
397
398
399
400
401
402
403
404
405 protected Map<String, List<MavenReport>> categoriseReports( Collection<MavenReport> reports )
406 {
407 Map<String, List<MavenReport>> categories = new LinkedHashMap<>();
408 for ( MavenReport report : reports )
409 {
410 List<MavenReport> categoryReports = categories.get( report.getCategoryName() );
411 if ( categoryReports == null )
412 {
413 categoryReports = new ArrayList<>();
414 categories.put( report.getCategoryName(), categoryReports );
415 }
416 categoryReports.add( report );
417 }
418 return categories;
419 }
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436 protected Map<String, DocumentRenderer> locateDocuments( SiteRenderingContext context,
437 List<MavenReportExecution> reports, Locale locale )
438 throws IOException, RendererException
439 {
440 Map<String, DocumentRenderer> documents = siteRenderer.locateDocumentFiles( context, true );
441
442 Map<String, MavenReport> reportsByOutputName = locateReports( reports, documents, locale );
443
444
445 Map<String, List<MavenReport>> categories = categoriseReports( reportsByOutputName.values() );
446
447 siteTool.populateReportsMenu( context.getDecoration(), locale, categories );
448 populateReportItems( context.getDecoration(), locale, reportsByOutputName );
449
450 if ( categories.containsKey( MavenReport.CATEGORY_PROJECT_INFORMATION ) && generateProjectInfo )
451 {
452
453 List<MavenReport> categoryReports = categories.get( MavenReport.CATEGORY_PROJECT_INFORMATION );
454
455 RenderingContext renderingContext =
456 new RenderingContext( siteDirectory, "project-info.html",
457 getSitePluginInfo() + ":CategorySummaryDocumentRenderer" );
458 String title = i18n.getString( "site-plugin", locale, "report.information.title" );
459 String desc1 = i18n.getString( "site-plugin", locale, "report.information.description1" );
460 String desc2 = i18n.getString( "site-plugin", locale, "report.information.description2" );
461 DocumentRenderer renderer = new CategorySummaryDocumentRenderer( renderingContext, title, desc1, desc2,
462 i18n, categoryReports, getLog() );
463
464 if ( !documents.containsKey( renderer.getOutputName() ) )
465 {
466 documents.put( renderer.getOutputName(), renderer );
467 }
468 else
469 {
470 getLog().info( "Category summary '" + renderer.getOutputName() + "' skipped; already exists" );
471 }
472 }
473
474 if ( categories.containsKey( MavenReport.CATEGORY_PROJECT_REPORTS ) )
475 {
476
477 List<MavenReport> categoryReports = categories.get( MavenReport.CATEGORY_PROJECT_REPORTS );
478 RenderingContext renderingContext =
479 new RenderingContext( siteDirectory, "project-reports.html",
480 getSitePluginInfo() + ":CategorySummaryDocumentRenderer" );
481 String title = i18n.getString( "site-plugin", locale, "report.project.title" );
482 String desc1 = i18n.getString( "site-plugin", locale, "report.project.description1" );
483 String desc2 = i18n.getString( "site-plugin", locale, "report.project.description2" );
484 DocumentRenderer renderer = new CategorySummaryDocumentRenderer( renderingContext, title, desc1, desc2,
485 i18n, categoryReports, getLog() );
486
487 if ( !documents.containsKey( renderer.getOutputName() ) )
488 {
489 documents.put( renderer.getOutputName(), renderer );
490 }
491 else
492 {
493 getLog().info( "Category summary '" + renderer.getOutputName() + "' skipped; already exists" );
494 }
495 }
496 return documents;
497 }
498
499 private String getSitePluginInfo()
500 {
501 PluginDescriptor pluginDescriptor = (PluginDescriptor) getPluginContext().get( "pluginDescriptor" );
502 return pluginDescriptor.getId();
503 }
504 protected void populateReportItems( DecorationModel decorationModel, Locale locale,
505 Map<String, MavenReport> reportsByOutputName )
506 {
507 for ( Menu menu : decorationModel.getMenus() )
508 {
509 populateItemRefs( menu.getItems(), locale, reportsByOutputName );
510 }
511 }
512
513 private void populateItemRefs( List<MenuItem> items, Locale locale, Map<String, MavenReport> reportsByOutputName )
514 {
515 for ( Iterator<MenuItem> i = items.iterator(); i.hasNext(); )
516 {
517 MenuItem item = i.next();
518
519 if ( item.getRef() != null )
520 {
521 MavenReport report = reportsByOutputName.get( item.getRef() );
522
523 if ( report != null )
524 {
525 if ( item.getName() == null )
526 {
527 item.setName( report.getName( locale ) );
528 }
529
530 if ( item.getHref() == null || item.getHref().length() == 0 )
531 {
532 item.setHref( report.getOutputName() + ".html" );
533 }
534 }
535 else
536 {
537 getLog().warn( "Unrecognised reference: '" + item.getRef() + "'" );
538 i.remove();
539 }
540 }
541
542 populateItemRefs( item.getItems(), locale, reportsByOutputName );
543 }
544 }
545 }