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