1 | |
package org.apache.maven.script.ant; |
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.artifact.Artifact; |
23 | |
import org.apache.maven.artifact.DependencyResolutionRequiredException; |
24 | |
import org.apache.maven.execution.MavenSession; |
25 | |
import org.apache.maven.plugin.AbstractMojo; |
26 | |
import org.apache.maven.plugin.ContextEnabled; |
27 | |
import org.apache.maven.plugin.MojoExecution; |
28 | |
import org.apache.maven.plugin.MojoExecutionException; |
29 | |
import org.apache.maven.plugin.PluginParameterExpressionEvaluator; |
30 | |
import org.apache.maven.plugin.descriptor.PluginDescriptor; |
31 | |
import org.apache.maven.project.MavenProject; |
32 | |
import org.apache.maven.project.path.PathTranslator; |
33 | |
import org.apache.tools.ant.Project; |
34 | |
import org.apache.tools.ant.PropertyHelper; |
35 | |
import org.apache.tools.ant.types.Path; |
36 | |
import org.codehaus.plexus.archiver.ArchiverException; |
37 | |
import org.codehaus.plexus.archiver.UnArchiver; |
38 | |
import org.codehaus.plexus.archiver.zip.ZipUnArchiver; |
39 | |
import org.codehaus.plexus.component.MapOrientedComponent; |
40 | |
import org.codehaus.plexus.component.configurator.ComponentConfigurationException; |
41 | |
import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator; |
42 | |
import org.codehaus.plexus.component.factory.ant.AntComponentExecutionException; |
43 | |
import org.codehaus.plexus.component.factory.ant.AntScriptInvoker; |
44 | |
import org.codehaus.plexus.component.repository.ComponentRequirement; |
45 | |
import org.codehaus.plexus.logging.LogEnabled; |
46 | |
import org.codehaus.plexus.logging.Logger; |
47 | |
import org.codehaus.plexus.util.StringUtils; |
48 | |
|
49 | |
import java.io.File; |
50 | |
import java.util.ArrayList; |
51 | |
import java.util.Collection; |
52 | |
import java.util.HashMap; |
53 | |
import java.util.List; |
54 | |
import java.util.Map; |
55 | |
|
56 | |
public class AntMojoWrapper |
57 | |
extends AbstractMojo |
58 | |
implements ContextEnabled, MapOrientedComponent, LogEnabled |
59 | |
{ |
60 | |
|
61 | |
private Map<String, Object> pluginContext; |
62 | |
|
63 | |
private final AntScriptInvoker scriptInvoker; |
64 | |
|
65 | |
private Project antProject; |
66 | |
|
67 | |
private MavenProject mavenProject; |
68 | |
|
69 | |
private MojoExecution mojoExecution; |
70 | |
|
71 | |
private MavenSession session; |
72 | |
|
73 | |
private PathTranslator pathTranslator; |
74 | |
|
75 | |
private Logger logger; |
76 | |
|
77 | 2 | private transient List<String> unconstructedParts = new ArrayList<String>(); |
78 | |
|
79 | |
public AntMojoWrapper( AntScriptInvoker scriptInvoker ) |
80 | 2 | { |
81 | 2 | this.scriptInvoker = scriptInvoker; |
82 | 2 | } |
83 | |
|
84 | |
public void execute() |
85 | |
throws MojoExecutionException |
86 | |
{ |
87 | 2 | if ( antProject == null ) |
88 | |
{ |
89 | 0 | antProject = scriptInvoker.getProject(); |
90 | |
} |
91 | |
|
92 | 2 | Map<String, Object> allConfig = new HashMap<String, Object>(); |
93 | 2 | if ( pluginContext != null && !pluginContext.isEmpty() ) |
94 | |
{ |
95 | 0 | allConfig.putAll( pluginContext ); |
96 | |
} |
97 | |
|
98 | |
@SuppressWarnings( "unchecked" ) |
99 | 2 | Map<String, PathTranslator> refs = scriptInvoker.getReferences(); |
100 | 2 | if ( refs != null ) |
101 | |
{ |
102 | 2 | allConfig.putAll( refs ); |
103 | |
|
104 | 2 | for ( Map.Entry<String, PathTranslator> entry : refs.entrySet() ) |
105 | |
{ |
106 | 6 | if ( entry.getKey().startsWith( PathTranslator.class.getName() ) ) |
107 | |
{ |
108 | 1 | pathTranslator = entry.getValue(); |
109 | |
} |
110 | |
} |
111 | |
} |
112 | |
|
113 | 2 | mavenProject = (MavenProject) allConfig.get( "project" ); |
114 | |
|
115 | 2 | mojoExecution = (MojoExecution) allConfig.get( "mojoExecution" ); |
116 | |
|
117 | 2 | session = (MavenSession) allConfig.get( "session" ); |
118 | |
|
119 | 2 | unpackFileBasedResources(); |
120 | |
|
121 | 2 | addClasspathReferences(); |
122 | |
|
123 | 2 | if ( logger.isDebugEnabled() && !unconstructedParts.isEmpty() ) |
124 | |
{ |
125 | 1 | StringBuffer buffer = new StringBuffer(); |
126 | |
|
127 | 1 | buffer.append( "The following standard Maven Ant-mojo support objects could not be created:\n\n" ); |
128 | |
|
129 | 1 | for ( String part : unconstructedParts ) |
130 | |
{ |
131 | 4 | buffer.append( "\n- " ).append( part ); |
132 | |
} |
133 | |
|
134 | 1 | buffer.append( "\n\nMaven project, session, mojo-execution, or path-translation parameter information is " ); |
135 | 1 | buffer.append( "\nmissing from this mojo's plugin descriptor." ); |
136 | 1 | buffer.append( "\n\nPerhaps this Ant-based mojo depends on maven-script-ant < 2.1.0, " ); |
137 | 1 | buffer.append( "or used maven-plugin-tools-ant < 2.2 during release?\n\n" ); |
138 | |
|
139 | 1 | logger.debug( buffer.toString() ); |
140 | |
} |
141 | |
|
142 | |
try |
143 | |
{ |
144 | 2 | scriptInvoker.invoke(); |
145 | |
} |
146 | 0 | catch ( AntComponentExecutionException e ) |
147 | |
{ |
148 | 0 | throw new MojoExecutionException( "Failed to execute: " + e.getMessage(), e ); |
149 | 2 | } |
150 | |
|
151 | 2 | unconstructedParts.clear(); |
152 | 2 | } |
153 | |
|
154 | |
public void setPluginContext( Map pluginContext ) |
155 | |
{ |
156 | 0 | this.pluginContext = pluginContext; |
157 | 0 | } |
158 | |
|
159 | |
public Map getPluginContext() |
160 | |
{ |
161 | 0 | return pluginContext; |
162 | |
} |
163 | |
|
164 | |
public void addComponentRequirement( ComponentRequirement requirementDescriptor, Object requirementValue ) |
165 | |
throws ComponentConfigurationException |
166 | |
{ |
167 | 1 | scriptInvoker.addComponentRequirement( requirementDescriptor, requirementValue ); |
168 | 1 | } |
169 | |
|
170 | |
public void setComponentConfiguration( Map componentConfiguration ) |
171 | |
throws ComponentConfigurationException |
172 | |
{ |
173 | 2 | scriptInvoker.setComponentConfiguration( componentConfiguration ); |
174 | 2 | antProject = scriptInvoker.getProject(); |
175 | 2 | } |
176 | |
|
177 | |
private void unpackFileBasedResources() |
178 | |
throws MojoExecutionException |
179 | |
{ |
180 | 2 | if ( mojoExecution == null || mavenProject == null ) |
181 | |
{ |
182 | 1 | unconstructedParts.add( "Unpacked Ant build scripts (in Maven build directory)." ); |
183 | |
|
184 | 1 | return; |
185 | |
} |
186 | |
|
187 | |
|
188 | |
|
189 | |
|
190 | |
|
191 | |
|
192 | |
|
193 | 1 | PluginDescriptor pluginDescriptor = mojoExecution.getMojoDescriptor().getPluginDescriptor(); |
194 | |
|
195 | 1 | File pluginJar = pluginDescriptor.getPluginArtifact().getFile(); |
196 | |
|
197 | 1 | String resourcesPath = pluginDescriptor.getArtifactId(); |
198 | |
|
199 | 1 | File outputDirectory = new File( mavenProject.getBuild().getDirectory() ); |
200 | |
|
201 | |
try |
202 | |
{ |
203 | 1 | UnArchiver ua = new ZipUnArchiver( pluginJar ); |
204 | |
|
205 | 1 | ua.extract( resourcesPath, outputDirectory ); |
206 | |
} |
207 | 0 | catch ( ArchiverException e ) |
208 | |
{ |
209 | 0 | throw new MojoExecutionException( "Error extracting resources from your Ant-based plugin.", e ); |
210 | 1 | } |
211 | 1 | } |
212 | |
|
213 | |
private void addClasspathReferences() |
214 | |
throws MojoExecutionException |
215 | |
{ |
216 | |
try |
217 | |
{ |
218 | 2 | if ( mavenProject != null && session != null && pathTranslator != null ) |
219 | |
{ |
220 | 1 | ExpressionEvaluator exprEvaluator = |
221 | |
new PluginParameterExpressionEvaluator( session, mojoExecution, pathTranslator, logger, mavenProject, |
222 | |
mavenProject.getProperties() ); |
223 | |
|
224 | 1 | PropertyHelper propertyHelper = PropertyHelper.getPropertyHelper( antProject ); |
225 | 1 | propertyHelper.setNext( new AntPropertyHelper( exprEvaluator, mavenProject.getArtifacts(), getLog() ) ); |
226 | 1 | } |
227 | |
else |
228 | |
{ |
229 | 1 | unconstructedParts.add( "Maven parameter expression evaluator for Ant properties." ); |
230 | |
} |
231 | |
|
232 | |
@SuppressWarnings( "unchecked" ) |
233 | 2 | Map<String, Object> references = scriptInvoker.getReferences(); |
234 | |
|
235 | 2 | if ( mavenProject != null ) |
236 | |
{ |
237 | |
|
238 | |
|
239 | 1 | Path p = new Path( antProject ); |
240 | |
|
241 | 1 | p.setPath( StringUtils.join( mavenProject.getCompileClasspathElements().iterator(), File.pathSeparator ) ); |
242 | |
|
243 | |
|
244 | 1 | references.put( "maven.dependency.classpath", p ); |
245 | 1 | antProject.addReference( "maven.dependency.classpath", p ); |
246 | |
|
247 | 1 | references.put( "maven.compile.classpath", p ); |
248 | 1 | antProject.addReference( "maven.compile.classpath", p ); |
249 | |
|
250 | |
|
251 | 1 | p = new Path( antProject ); |
252 | |
|
253 | 1 | p.setPath( StringUtils.join( mavenProject.getRuntimeClasspathElements().iterator(), File.pathSeparator ) ); |
254 | |
|
255 | 1 | references.put( "maven.runtime.classpath", p ); |
256 | 1 | antProject.addReference( "maven.runtime.classpath", p ); |
257 | |
|
258 | |
|
259 | 1 | p = new Path( antProject ); |
260 | |
|
261 | 1 | p.setPath( StringUtils.join( mavenProject.getTestClasspathElements().iterator(), File.pathSeparator ) ); |
262 | |
|
263 | 1 | references.put( "maven.test.classpath", p ); |
264 | 1 | antProject.addReference( "maven.test.classpath", p ); |
265 | |
|
266 | 1 | } |
267 | |
else |
268 | |
{ |
269 | 1 | unconstructedParts.add( "Maven standard project-based classpath references." ); |
270 | |
} |
271 | |
|
272 | 2 | if ( mojoExecution != null ) |
273 | |
{ |
274 | |
|
275 | |
|
276 | 1 | Path p = getPathFromArtifacts( mojoExecution.getMojoDescriptor().getPluginDescriptor().getArtifacts(), antProject ); |
277 | |
|
278 | 1 | references.put( "maven.plugin.classpath", p ); |
279 | 1 | antProject.addReference( "maven.plugin.classpath", p ); |
280 | 1 | } |
281 | |
else |
282 | |
{ |
283 | 1 | unconstructedParts.add( "Maven standard plugin-based classpath references." ); |
284 | |
} |
285 | |
} |
286 | 0 | catch ( DependencyResolutionRequiredException e ) |
287 | |
{ |
288 | 0 | throw new MojoExecutionException( "Error creating classpath references for Ant-based plugin scripts.", e ); |
289 | 2 | } |
290 | 2 | } |
291 | |
|
292 | |
public Path getPathFromArtifacts( Collection<Artifact> artifacts, Project antProject ) |
293 | |
throws DependencyResolutionRequiredException |
294 | |
{ |
295 | 1 | List<String> list = new ArrayList<String>( artifacts.size() ); |
296 | |
|
297 | 1 | for ( Artifact a : artifacts ) |
298 | |
{ |
299 | 1 | File file = a.getFile(); |
300 | |
|
301 | 1 | if ( file == null ) |
302 | |
{ |
303 | 0 | throw new DependencyResolutionRequiredException( a ); |
304 | |
} |
305 | |
|
306 | 1 | list.add( file.getPath() ); |
307 | 1 | } |
308 | |
|
309 | 1 | Path p = new Path( antProject ); |
310 | |
|
311 | 1 | p.setPath( StringUtils.join( list.iterator(), File.pathSeparator ) ); |
312 | |
|
313 | 1 | return p; |
314 | |
} |
315 | |
|
316 | |
public Project getAntProject() |
317 | |
{ |
318 | 2 | return antProject; |
319 | |
} |
320 | |
|
321 | |
public void setAntProject( Project antProject ) |
322 | |
{ |
323 | 0 | this.antProject = antProject; |
324 | 0 | } |
325 | |
|
326 | |
public MavenProject getMavenProject() |
327 | |
{ |
328 | 0 | return mavenProject; |
329 | |
} |
330 | |
|
331 | |
public void setMavenProject( MavenProject mavenProject ) |
332 | |
{ |
333 | 0 | this.mavenProject = mavenProject; |
334 | 0 | } |
335 | |
|
336 | |
public MojoExecution getMojoExecution() |
337 | |
{ |
338 | 0 | return mojoExecution; |
339 | |
} |
340 | |
|
341 | |
public void setMojoExecution( MojoExecution mojoExecution ) |
342 | |
{ |
343 | 0 | this.mojoExecution = mojoExecution; |
344 | 0 | } |
345 | |
|
346 | |
public MavenSession getSession() |
347 | |
{ |
348 | 0 | return session; |
349 | |
} |
350 | |
|
351 | |
public void setSession( MavenSession session ) |
352 | |
{ |
353 | 0 | this.session = session; |
354 | 0 | } |
355 | |
|
356 | |
public PathTranslator getPathTranslator() |
357 | |
{ |
358 | 0 | return pathTranslator; |
359 | |
} |
360 | |
|
361 | |
public void setPathTranslator( PathTranslator pathTranslator ) |
362 | |
{ |
363 | 0 | this.pathTranslator = pathTranslator; |
364 | 0 | } |
365 | |
|
366 | |
public AntScriptInvoker getScriptInvoker() |
367 | |
{ |
368 | 0 | return scriptInvoker; |
369 | |
} |
370 | |
|
371 | |
public void enableLogging( Logger logger ) |
372 | |
{ |
373 | 2 | this.logger = logger; |
374 | 2 | } |
375 | |
} |