1 package org.apache.maven.model.plugin;
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.model.Build;
23 import org.apache.maven.model.Model;
24 import org.apache.maven.model.Plugin;
25 import org.apache.maven.model.PluginManagement;
26 import org.apache.maven.model.ReportPlugin;
27 import org.apache.maven.model.ReportSet;
28 import org.apache.maven.model.Reporting;
29 import org.apache.maven.model.building.ModelBuildingRequest;
30 import org.apache.maven.model.building.ModelProblemCollector;
31 import org.apache.maven.model.building.ModelProblem.Severity;
32 import org.codehaus.plexus.component.annotations.Component;
33 import org.codehaus.plexus.util.StringUtils;
34 import org.codehaus.plexus.util.xml.Xpp3Dom;
35
36
37
38
39
40
41 @Component( role = ReportingConverter.class )
42 public class DefaultReportingConverter
43 implements ReportingConverter
44 {
45
46 public void convertReporting( Model model, ModelBuildingRequest request, ModelProblemCollector problems )
47 {
48 Reporting reporting = model.getReporting();
49
50 if ( reporting == null )
51 {
52 return;
53 }
54
55 Build build = model.getBuild();
56
57 if ( build == null )
58 {
59 build = new Build();
60 model.setBuild( build );
61 }
62
63 Plugin sitePlugin = findSitePlugin( build );
64
65 if ( sitePlugin == null )
66 {
67 sitePlugin = new Plugin();
68 sitePlugin.setArtifactId( "maven-site-plugin" );
69 PluginManagement pluginManagement = build.getPluginManagement();
70 if ( pluginManagement == null )
71 {
72 pluginManagement = new PluginManagement();
73 build.setPluginManagement( pluginManagement );
74 }
75 pluginManagement.addPlugin( sitePlugin );
76 }
77
78 Xpp3Dom configuration = (Xpp3Dom) sitePlugin.getConfiguration();
79
80 if ( configuration == null )
81 {
82 configuration = new Xpp3Dom( "configuration" );
83 sitePlugin.setConfiguration( configuration );
84 }
85
86 Xpp3Dom reportPlugins = configuration.getChild( "reportPlugins" );
87
88 if ( reportPlugins != null )
89 {
90
91 return;
92 }
93
94 if ( configuration.getChild( "outputDirectory" ) == null )
95 {
96 addDom( configuration, "outputDirectory", reporting.getOutputDirectory() );
97 }
98
99 reportPlugins = new Xpp3Dom( "reportPlugins" );
100 configuration.addChild( reportPlugins );
101
102 boolean hasMavenProjectInfoReportsPlugin = false;
103
104 if ( !reporting.getPlugins().isEmpty()
105 && request.getValidationLevel() >= ModelBuildingRequest.VALIDATION_LEVEL_MAVEN_3_1 )
106 {
107
108 problems.add( Severity.WARNING, "The <reporting> section is deprecated"
109 + ", please move the reports to the <configuration> section of the new Maven Site Plugin.",
110 reporting.getLocation( "" ), null );
111 }
112
113 for ( ReportPlugin plugin : reporting.getPlugins() )
114 {
115 Xpp3Dom reportPlugin = convert( plugin );
116 reportPlugins.addChild( reportPlugin );
117
118 if ( !reporting.isExcludeDefaults() && !hasMavenProjectInfoReportsPlugin
119 && "org.apache.maven.plugins".equals( reportPlugin.getChild( "groupId" ).getValue() )
120 && "maven-project-info-reports-plugin".equals( reportPlugin.getChild( "artifactId" ).getValue() ) )
121 {
122 hasMavenProjectInfoReportsPlugin = true;
123 }
124 }
125
126 if ( !reporting.isExcludeDefaults() && !hasMavenProjectInfoReportsPlugin )
127 {
128 Xpp3Dom dom = new Xpp3Dom( "reportPlugin" );
129
130 addDom( dom, "groupId", "org.apache.maven.plugins" );
131 addDom( dom, "artifactId", "maven-project-info-reports-plugin" );
132
133 reportPlugins.addChild( dom );
134 }
135 }
136
137 private Plugin findSitePlugin( Build build )
138 {
139 for ( Plugin plugin : build.getPlugins() )
140 {
141 if ( isSitePlugin( plugin ) )
142 {
143 return plugin;
144 }
145 }
146
147 PluginManagement pluginManagement = build.getPluginManagement();
148 if ( pluginManagement != null )
149 {
150 for ( Plugin plugin : pluginManagement.getPlugins() )
151 {
152 if ( isSitePlugin( plugin ) )
153 {
154 return plugin;
155 }
156 }
157 }
158
159 return null;
160 }
161
162 private boolean isSitePlugin( Plugin plugin )
163 {
164 return "maven-site-plugin".equals( plugin.getArtifactId() )
165 && "org.apache.maven.plugins".equals( plugin.getGroupId() );
166 }
167
168 private Xpp3Dom convert( ReportPlugin plugin )
169 {
170 Xpp3Dom dom = new Xpp3Dom( "reportPlugin" );
171
172 addDom( dom, "groupId", plugin.getGroupId() );
173 addDom( dom, "artifactId", plugin.getArtifactId() );
174 addDom( dom, "version", plugin.getVersion() );
175
176 Xpp3Dom configuration = (Xpp3Dom) plugin.getConfiguration();
177 if ( configuration != null )
178 {
179 configuration = new Xpp3Dom( configuration );
180 dom.addChild( configuration );
181 }
182
183 if ( !plugin.getReportSets().isEmpty() )
184 {
185 Xpp3Dom reportSets = new Xpp3Dom( "reportSets" );
186 for ( ReportSet reportSet : plugin.getReportSets() )
187 {
188 Xpp3Dom rs = convert( reportSet );
189 reportSets.addChild( rs );
190 }
191 dom.addChild( reportSets );
192 }
193
194 return dom;
195 }
196
197 private Xpp3Dom convert( ReportSet reportSet )
198 {
199 Xpp3Dom dom = new Xpp3Dom( "reportSet" );
200
201 addDom( dom, "id", reportSet.getId() );
202
203 Xpp3Dom configuration = (Xpp3Dom) reportSet.getConfiguration();
204 if ( configuration != null )
205 {
206 configuration = new Xpp3Dom( configuration );
207 dom.addChild( configuration );
208 }
209
210 if ( !reportSet.getReports().isEmpty() )
211 {
212 Xpp3Dom reports = new Xpp3Dom( "reports" );
213 for ( String report : reportSet.getReports() )
214 {
215 addDom( reports, "report", report );
216 }
217 dom.addChild( reports );
218 }
219
220 return dom;
221 }
222
223 private void addDom( Xpp3Dom parent, String childName, String childValue )
224 {
225 if ( StringUtils.isNotEmpty( childValue ) )
226 {
227 parent.addChild( newDom( childName, childValue ) );
228 }
229 }
230
231 private Xpp3Dom newDom( String name, String value )
232 {
233 Xpp3Dom dom = new Xpp3Dom( name );
234 dom.setValue( value );
235 return dom;
236 }
237
238 }