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 try {
229 if (exec.canGenerateReport()) {
230 reportExecutions.add(exec);
231 }
232 } catch (MavenReportException e) {
233 String reportMojoInfo = exec.getPlugin().getId() + ":" + exec.getGoal();
234 throw new MojoExecutionException(
235 "Failed to determine whether report '" + reportMojoInfo + "' can be generated", e);
236 }
237 }
238 return reportExecutions;
239 }
240
241
242
243
244
245
246
247
248 private ReportPlugin[] getReportingPlugins() {
249 List<ReportPlugin> reportingPlugins = reporting.getPlugins();
250
251
252 boolean hasMavenProjectInfoReportsPlugin = false;
253 for (ReportPlugin plugin : reportingPlugins) {
254 if ("org.apache.maven.plugins".equals(plugin.getGroupId())
255 && "maven-project-info-reports-plugin".equals(plugin.getArtifactId())) {
256 hasMavenProjectInfoReportsPlugin = true;
257 break;
258 }
259 }
260
261 if (!reporting.isExcludeDefaults() && !hasMavenProjectInfoReportsPlugin) {
262 ReportPlugin mpir = new ReportPlugin();
263 mpir.setArtifactId("maven-project-info-reports-plugin");
264 reportingPlugins.add(mpir);
265 }
266 return reportingPlugins.toArray(new ReportPlugin[0]);
267 }
268
269 protected SiteRenderingContext createSiteRenderingContext(Locale locale)
270 throws MojoExecutionException, IOException, MojoFailureException {
271 SiteModel siteModel = prepareSiteModel(locale);
272 Map<String, Object> templateProperties = new HashMap<>();
273 templateProperties.put("project", project);
274 templateProperties.put("inputEncoding", getInputEncoding());
275 templateProperties.put("outputEncoding", getOutputEncoding());
276
277
278 for (Map.Entry<Object, Object> entry : project.getProperties().entrySet()) {
279 templateProperties.put((String) entry.getKey(), entry.getValue());
280 }
281
282
283 if (attributes != null) {
284 templateProperties.putAll(attributes);
285 }
286
287 SiteRenderingContext context;
288 try {
289 Artifact skinArtifact =
290 siteTool.getSkinArtifactFromRepository(repoSession, remoteProjectRepositories, siteModel.getSkin());
291
292 getLog().info(buffer().a("Rendering content with ")
293 .strong(skinArtifact.getId() + " skin")
294 .toString());
295
296 context = siteRenderer.createContextForSkin(
297 skinArtifact, templateProperties, siteModel, project.getName(), locale);
298 } catch (SiteToolException e) {
299 throw new MojoExecutionException("Failed to retrieve skin artifact from repository", e);
300 } catch (RendererException e) {
301 throw new MojoExecutionException("Failed to create context for skin", e);
302 }
303
304
305 MavenArchiver.parseBuildOutputTimestamp(outputTimestamp).ifPresent(v -> {
306 context.setPublishDate(Date.from(v));
307 });
308
309
310 context.setRootDirectory(project.getBasedir());
311 if (!locale.equals(SiteTool.DEFAULT_LOCALE)) {
312 context.addSiteDirectory(new File(siteDirectory, locale.toString()));
313 } else {
314 context.addSiteDirectory(siteDirectory);
315 }
316
317 if (moduleExcludes != null) {
318 context.setModuleExcludes(moduleExcludes);
319 }
320
321 if (saveProcessedContent) {
322 File processedDir = new File(generatedSiteDirectory, "processed");
323 if (!locale.equals(SiteTool.DEFAULT_LOCALE)) {
324 context.setProcessedContentOutput(new File(processedDir, locale.toString()));
325 } else {
326 context.setProcessedContentOutput(processedDir);
327 }
328 }
329
330 return context;
331 }
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346 protected Map<String, MavenReport> locateReports(
347 List<MavenReportExecution> reports, Map<String, DocumentRenderer> documents, Locale locale) {
348 Map<String, MavenReport> reportsByOutputName = new LinkedHashMap<>();
349 for (MavenReportExecution mavenReportExecution : reports) {
350 MavenReport report = mavenReportExecution.getMavenReport();
351
352 String outputName = report.getOutputName();
353 String filename = outputName + ".html";
354
355
356 reportsByOutputName.put(outputName, report);
357
358 if (documents.containsKey(filename)) {
359 String reportMojoInfo = mavenReportExecution.getGoal() == null
360 ? ""
361 : (" (" + mavenReportExecution.getPlugin().getArtifactId() + ':'
362 + mavenReportExecution.getPlugin().getVersion() + ':' + mavenReportExecution.getGoal()
363 + ')');
364
365 getLog().info("Skipped \"" + report.getName(locale) + "\" report" + reportMojoInfo + ", file \""
366 + filename + "\" already exists.");
367 } else {
368 String generator = mavenReportExecution.getGoal() == null
369 ? null
370 : mavenReportExecution.getPlugin().getId() + ':' + mavenReportExecution.getGoal();
371 DocumentRenderingContext docRenderingContext =
372 new DocumentRenderingContext(siteDirectory, outputName, generator);
373 DocumentRenderer docRenderer =
374 new ReportDocumentRenderer(mavenReportExecution, docRenderingContext, getLog());
375 documents.put(filename, docRenderer);
376 }
377 }
378 return reportsByOutputName;
379 }
380
381
382
383
384
385
386
387
388 protected Map<String, List<MavenReport>> categoriseReports(Collection<MavenReport> reports) {
389 Map<String, List<MavenReport>> categories = new LinkedHashMap<>();
390 for (MavenReport report : reports) {
391 List<MavenReport> categoryReports = categories.get(report.getCategoryName());
392 if (categoryReports == null) {
393 categoryReports = new ArrayList<>();
394 categories.put(report.getCategoryName(), categoryReports);
395 }
396 categoryReports.add(report);
397 }
398 return categories;
399 }
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416 protected Map<String, DocumentRenderer> locateDocuments(
417 SiteRenderingContext context, List<MavenReportExecution> reports, Locale locale)
418 throws IOException, RendererException {
419 Map<String, DocumentRenderer> documents = siteRenderer.locateDocumentFiles(context, true);
420
421 Map<String, MavenReport> reportsByOutputName = locateReports(reports, documents, locale);
422
423
424 Map<String, List<MavenReport>> categories = categoriseReports(reportsByOutputName.values());
425
426 siteTool.populateReportsMenu(context.getSiteModel(), locale, categories);
427 populateReportItems(context.getSiteModel(), locale, reportsByOutputName);
428
429 if (categories.containsKey(MavenReport.CATEGORY_PROJECT_INFORMATION) && generateProjectInfo) {
430
431 List<MavenReport> categoryReports = categories.get(MavenReport.CATEGORY_PROJECT_INFORMATION);
432 MojoExecution subMojoExecution =
433 new MojoExecution(mojoExecution.getPlugin(), "project-info", mojoExecution.getExecutionId());
434 DocumentRenderingContext docRenderingContext = new DocumentRenderingContext(
435 siteDirectory,
436 subMojoExecution.getGoal(),
437 subMojoExecution.getPlugin().getId() + ':' + subMojoExecution.getGoal());
438 String title = i18n.getString("site-plugin", locale, "report.information.title");
439 String desc1 = i18n.getString("site-plugin", locale, "report.information.description1");
440 String desc2 = i18n.getString("site-plugin", locale, "report.information.description2");
441 DocumentRenderer docRenderer = new CategorySummaryDocumentRenderer(
442 subMojoExecution, docRenderingContext, title, desc1, desc2, i18n, categoryReports, getLog());
443
444 String filename = docRenderer.getOutputName();
445 if (!documents.containsKey(filename)) {
446 documents.put(filename, docRenderer);
447 } else {
448 getLog().info("Skipped \"" + title + "\" report; file \"" + filename + "\" already exists.");
449 }
450 }
451
452 if (categories.containsKey(MavenReport.CATEGORY_PROJECT_REPORTS)) {
453
454 List<MavenReport> categoryReports = categories.get(MavenReport.CATEGORY_PROJECT_REPORTS);
455 MojoExecution subMojoExecution =
456 new MojoExecution(mojoExecution.getPlugin(), "project-reports", mojoExecution.getExecutionId());
457 DocumentRenderingContext docRenderingContext = new DocumentRenderingContext(
458 siteDirectory,
459 subMojoExecution.getGoal(),
460 subMojoExecution.getPlugin().getId() + ':' + subMojoExecution.getGoal());
461 String title = i18n.getString("site-plugin", locale, "report.project.title");
462 String desc1 = i18n.getString("site-plugin", locale, "report.project.description1");
463 String desc2 = i18n.getString("site-plugin", locale, "report.project.description2");
464 DocumentRenderer docRenderer = new CategorySummaryDocumentRenderer(
465 subMojoExecution, docRenderingContext, title, desc1, desc2, i18n, categoryReports, getLog());
466
467 String filename = docRenderer.getOutputName();
468 if (!documents.containsKey(filename)) {
469 documents.put(filename, docRenderer);
470 } else {
471 getLog().info("Skipped \"" + title + "\" report; file \"" + filename + "\" already exists.");
472 }
473 }
474
475 if (generateSitemap) {
476 MojoExecution subMojoExecution =
477 new MojoExecution(mojoExecution.getPlugin(), "sitemap", mojoExecution.getExecutionId());
478 DocumentRenderingContext docRenderingContext = new DocumentRenderingContext(
479 siteDirectory,
480 subMojoExecution.getGoal(),
481 subMojoExecution.getPlugin().getId() + ':' + subMojoExecution.getGoal());
482 String title = i18n.getString("site-plugin", locale, "site.sitemap.title");
483 DocumentRenderer docRenderer = new SitemapDocumentRenderer(
484 subMojoExecution, docRenderingContext, title, context.getSiteModel(), i18n, getLog());
485
486 String filename = docRenderer.getOutputName();
487 if (!documents.containsKey(filename)) {
488 documents.put(filename, docRenderer);
489 } else {
490 getLog().info("Skipped \"" + title + "\" report; file \"" + filename + "\" already exists.");
491 }
492 }
493
494 return documents;
495 }
496
497 protected void populateReportItems(
498 SiteModel siteModel, Locale locale, Map<String, MavenReport> reportsByOutputName) {
499 for (Menu menu : siteModel.getMenus()) {
500 populateItemRefs(menu.getItems(), locale, reportsByOutputName);
501 }
502 }
503
504 private void populateItemRefs(List<MenuItem> items, Locale locale, Map<String, MavenReport> reportsByOutputName) {
505 for (Iterator<MenuItem> i = items.iterator(); i.hasNext(); ) {
506 MenuItem item = i.next();
507
508 if (item.getRef() != null) {
509 MavenReport report = reportsByOutputName.get(item.getRef());
510
511 if (report != null) {
512 if (item.getName() == null) {
513 item.setName(report.getName(locale));
514 }
515
516 if (item.getHref() == null || item.getHref().length() == 0) {
517 item.setHref(report.getOutputName() + ".html");
518 }
519 } else {
520 getLog().warn("Unrecognised reference: '" + item.getRef() + "'");
521 i.remove();
522 }
523 }
524
525 populateItemRefs(item.getItems(), locale, reportsByOutputName);
526 }
527 }
528 }