1 package org.apache.maven.tools.plugin.extractor.annotations.scanner;
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22 import java.io.BufferedInputStream;
23 import java.io.File;
24 import java.io.FileInputStream;
25 import java.io.IOException;
26 import java.io.InputStream;
27 import java.util.HashMap;
28 import java.util.List;
29 import java.util.Map;
30 import java.util.regex.Pattern;
31 import java.util.zip.ZipEntry;
32 import java.util.zip.ZipInputStream;
33
34 import org.apache.maven.artifact.Artifact;
35 import org.apache.maven.plugins.annotations.Component;
36 import org.apache.maven.plugins.annotations.Execute;
37 import org.apache.maven.plugins.annotations.Mojo;
38 import org.apache.maven.plugins.annotations.Parameter;
39 import org.apache.maven.tools.plugin.extractor.ExtractionException;
40 import org.apache.maven.tools.plugin.extractor.annotations.datamodel.ComponentAnnotationContent;
41 import org.apache.maven.tools.plugin.extractor.annotations.datamodel.ExecuteAnnotationContent;
42 import org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent;
43 import org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent;
44 import org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoAnnotationVisitor;
45 import org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor;
46 import org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoFieldVisitor;
47 import org.codehaus.plexus.logging.AbstractLogEnabled;
48 import org.codehaus.plexus.util.DirectoryScanner;
49 import org.codehaus.plexus.util.IOUtil;
50 import org.codehaus.plexus.util.StringUtils;
51 import org.codehaus.plexus.util.reflection.Reflector;
52 import org.codehaus.plexus.util.reflection.ReflectorException;
53 import org.objectweb.asm.ClassReader;
54 import org.objectweb.asm.Type;
55
56
57
58
59
60 @org.codehaus.plexus.component.annotations.Component( role = MojoAnnotationsScanner.class )
61 public class DefaultMojoAnnotationsScanner
62 extends AbstractLogEnabled
63 implements MojoAnnotationsScanner
64 {
65
66 private static final Pattern SCANNABLE_CLASS = Pattern.compile( "[^-]+\\.class" );
67
68 private Reflector reflector = new Reflector();
69
70 public Map<String, MojoAnnotatedClass> scan( MojoAnnotationsScannerRequest request )
71 throws ExtractionException
72 {
73 Map<String, MojoAnnotatedClass> mojoAnnotatedClasses = new HashMap<String, MojoAnnotatedClass>();
74
75 try
76 {
77 for ( Artifact dependency : request.getDependencies() )
78 {
79 scan( mojoAnnotatedClasses, dependency.getFile(), request.getIncludePatterns(), dependency, true );
80 }
81
82 for ( File classDirectory : request.getClassesDirectories() )
83 {
84 scan( mojoAnnotatedClasses, classDirectory, request.getIncludePatterns(),
85 request.getProject().getArtifact(), false );
86 }
87 }
88 catch ( IOException e )
89 {
90 throw new ExtractionException( e.getMessage(), e );
91 }
92
93 return mojoAnnotatedClasses;
94 }
95
96 protected void scan( Map<String, MojoAnnotatedClass> mojoAnnotatedClasses, File source,
97 List<String> includePatterns, Artifact artifact, boolean excludeMojo )
98 throws IOException, ExtractionException
99 {
100 if ( source == null || ! source.exists() )
101 {
102 return;
103 }
104
105 Map<String, MojoAnnotatedClass> scanResult;
106 if ( source.isDirectory() )
107 {
108 scanResult = scanDirectory( source, includePatterns, artifact, excludeMojo );
109 }
110 else
111 {
112 scanResult = scanArchive( source, artifact, excludeMojo );
113 }
114
115 mojoAnnotatedClasses.putAll( scanResult );
116 }
117
118
119
120
121
122
123
124
125
126 protected Map<String, MojoAnnotatedClass> scanArchive( File archiveFile, Artifact artifact, boolean excludeMojo )
127 throws IOException, ExtractionException
128 {
129 Map<String, MojoAnnotatedClass> mojoAnnotatedClasses = new HashMap<String, MojoAnnotatedClass>();
130
131 ZipInputStream archiveStream = new ZipInputStream( new FileInputStream( archiveFile ) );
132
133 String zipEntryName = null;
134 try
135 {
136 String archiveFilename = archiveFile.getAbsolutePath();
137 for ( ZipEntry zipEntry = archiveStream.getNextEntry(); zipEntry != null;
138 zipEntry = archiveStream.getNextEntry() )
139 {
140 zipEntryName = zipEntry.getName();
141 if ( !SCANNABLE_CLASS.matcher( zipEntryName ).matches() )
142 {
143 continue;
144 }
145 analyzeClassStream( mojoAnnotatedClasses, archiveStream, artifact, excludeMojo, archiveFilename,
146 zipEntry.getName() );
147 }
148 }
149 catch ( IllegalArgumentException e )
150 {
151
152 getLogger().error( "Failed to analyze " + archiveFile.getAbsolutePath() + "!/" + zipEntryName );
153
154 throw e;
155 }
156 finally
157 {
158 IOUtil.close( archiveStream );
159 }
160
161 return mojoAnnotatedClasses;
162 }
163
164
165
166
167
168
169
170
171
172
173 protected Map<String, MojoAnnotatedClass> scanDirectory( File classDirectory, List<String> includePatterns,
174 Artifact artifact, boolean excludeMojo )
175 throws IOException, ExtractionException
176 {
177 Map<String, MojoAnnotatedClass> mojoAnnotatedClasses = new HashMap<String, MojoAnnotatedClass>();
178
179 DirectoryScanner scanner = new DirectoryScanner();
180 scanner.setBasedir( classDirectory );
181 scanner.addDefaultExcludes();
182 if ( includePatterns != null )
183 {
184 scanner.setIncludes( includePatterns.toArray( new String[includePatterns.size()] ) );
185 }
186 scanner.scan();
187 String[] classFiles = scanner.getIncludedFiles();
188 String classDirname = classDirectory.getAbsolutePath();
189
190 for ( String classFile : classFiles )
191 {
192 if ( !SCANNABLE_CLASS.matcher( classFile ).matches() )
193 {
194 continue;
195 }
196
197 InputStream is = new BufferedInputStream( new FileInputStream( new File( classDirectory, classFile ) ) );
198 try
199 {
200 analyzeClassStream( mojoAnnotatedClasses, is, artifact, excludeMojo, classDirname, classFile );
201 }
202 finally
203 {
204 IOUtil.close( is );
205 }
206 }
207 return mojoAnnotatedClasses;
208 }
209
210 private void analyzeClassStream( Map<String, MojoAnnotatedClass> mojoAnnotatedClasses, InputStream is,
211 Artifact artifact, boolean excludeMojo, String source, String file )
212 throws IOException, ExtractionException
213 {
214 MojoClassVisitor mojoClassVisitor = new MojoClassVisitor( getLogger() );
215
216 try
217 {
218 ClassReader rdr = new ClassReader( is );
219 rdr.accept( mojoClassVisitor, ClassReader.SKIP_FRAMES | ClassReader.SKIP_CODE | ClassReader.SKIP_DEBUG );
220 }
221 catch ( ArrayIndexOutOfBoundsException aiooe )
222 {
223 getLogger().warn( "Error analyzing class " + file + " in " + source + ": ignoring class",
224 getLogger().isDebugEnabled() ? aiooe : null );
225 return;
226 }
227
228 analyzeVisitors( mojoClassVisitor );
229
230 MojoAnnotatedClass mojoAnnotatedClass = mojoClassVisitor.getMojoAnnotatedClass();
231
232 if ( excludeMojo )
233 {
234 mojoAnnotatedClass.setMojo( null );
235 }
236
237 if ( mojoAnnotatedClass != null )
238 {
239 if ( getLogger().isDebugEnabled() && mojoAnnotatedClass.hasAnnotations() )
240 {
241 getLogger().debug( "found MojoAnnotatedClass:" + mojoAnnotatedClass.getClassName() + ":"
242 + mojoAnnotatedClass );
243 }
244 mojoAnnotatedClass.setArtifact( artifact );
245 mojoAnnotatedClasses.put( mojoAnnotatedClass.getClassName(), mojoAnnotatedClass );
246 }
247 }
248
249 protected void populateAnnotationContent( Object content, MojoAnnotationVisitor mojoAnnotationVisitor )
250 throws ReflectorException
251 {
252 for ( Map.Entry<String, Object> entry : mojoAnnotationVisitor.getAnnotationValues().entrySet() )
253 {
254 reflector.invoke( content, entry.getKey(), new Object[] { entry.getValue() } );
255 }
256 }
257
258 protected void analyzeVisitors( MojoClassVisitor mojoClassVisitor )
259 throws ExtractionException
260 {
261 final MojoAnnotatedClass mojoAnnotatedClass = mojoClassVisitor.getMojoAnnotatedClass();
262
263 try
264 {
265
266 MojoAnnotationVisitor mojoAnnotationVisitor = mojoClassVisitor.getAnnotationVisitor( Mojo.class );
267 if ( mojoAnnotationVisitor != null )
268 {
269 MojoAnnotationContent mojoAnnotationContent = new MojoAnnotationContent();
270 populateAnnotationContent( mojoAnnotationContent, mojoAnnotationVisitor );
271 mojoAnnotatedClass.setMojo( mojoAnnotationContent );
272 }
273
274
275 mojoAnnotationVisitor = mojoClassVisitor.getAnnotationVisitor( Execute.class );
276 if ( mojoAnnotationVisitor != null )
277 {
278 ExecuteAnnotationContent executeAnnotationContent = new ExecuteAnnotationContent();
279 populateAnnotationContent( executeAnnotationContent, mojoAnnotationVisitor );
280 mojoAnnotatedClass.setExecute( executeAnnotationContent );
281 }
282
283
284 List<MojoFieldVisitor> mojoFieldVisitors = mojoClassVisitor.findFieldWithAnnotation( Parameter.class );
285 for ( MojoFieldVisitor mojoFieldVisitor : mojoFieldVisitors )
286 {
287 ParameterAnnotationContent parameterAnnotationContent =
288 new ParameterAnnotationContent( mojoFieldVisitor.getFieldName(), mojoFieldVisitor.getClassName() );
289 if ( mojoFieldVisitor.getMojoAnnotationVisitor() != null )
290 {
291 populateAnnotationContent( parameterAnnotationContent,
292 mojoFieldVisitor.getMojoAnnotationVisitor() );
293 }
294
295 mojoAnnotatedClass.getParameters().put( parameterAnnotationContent.getFieldName(),
296 parameterAnnotationContent );
297 }
298
299
300 mojoFieldVisitors = mojoClassVisitor.findFieldWithAnnotation( Component.class );
301 for ( MojoFieldVisitor mojoFieldVisitor : mojoFieldVisitors )
302 {
303 ComponentAnnotationContent componentAnnotationContent =
304 new ComponentAnnotationContent( mojoFieldVisitor.getFieldName() );
305
306 MojoAnnotationVisitor annotationVisitor = mojoFieldVisitor.getMojoAnnotationVisitor();
307 if ( annotationVisitor != null )
308 {
309 for ( Map.Entry<String, Object> entry : annotationVisitor.getAnnotationValues().entrySet() )
310 {
311 String methodName = entry.getKey();
312 if ( StringUtils.equals( "role", methodName ) )
313 {
314 Type type = (Type) entry.getValue();
315 componentAnnotationContent.setRoleClassName( type.getClassName() );
316 }
317 else
318 {
319 reflector.invoke( componentAnnotationContent, entry.getKey(),
320 new Object[]{ entry.getValue() } );
321 }
322 }
323
324 if ( StringUtils.isEmpty( componentAnnotationContent.getRoleClassName() ) )
325 {
326 componentAnnotationContent.setRoleClassName( mojoFieldVisitor.getClassName() );
327 }
328 }
329 mojoAnnotatedClass.getComponents().put( componentAnnotationContent.getFieldName(),
330 componentAnnotationContent );
331 }
332 }
333 catch ( ReflectorException e )
334 {
335 throw new ExtractionException( e.getMessage(), e );
336 }
337 }
338 }