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