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