summaryrefslogtreecommitdiffstats
path: root/src/java/net/sf/antcontrib/design/VerifyDesignDelegate.java
blob: 1c2fb01fe959188b0b3113eb2c49f8a4bf4a6c01 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
/*
 * Copyright (c) 2004-2005 Ant-Contrib project.  All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package net.sf.antcontrib.design;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Enumeration;
import java.util.HashSet;
import java.util.Vector;
import java.util.jar.JarFile;
import java.util.zip.ZipEntry;

import org.apache.bcel.Constants;
import org.apache.bcel.classfile.ClassFormatException;
import org.apache.bcel.classfile.ClassParser;
import org.apache.bcel.classfile.Constant;
import org.apache.bcel.classfile.ConstantClass;
import org.apache.bcel.classfile.ConstantPool;
import org.apache.bcel.classfile.ConstantUtf8;
import org.apache.bcel.classfile.DescendingVisitor;
import org.apache.bcel.classfile.JavaClass;
import org.apache.bcel.classfile.Utility;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.DirectoryScanner;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.types.FileSet;
import org.apache.tools.ant.types.Path;
import org.apache.tools.ant.types.PatternSet;
import org.apache.tools.ant.util.JAXPUtils;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;
import org.xml.sax.XMLReader;

/**
 * 
 * 
 * 
 * @author dhiller
 * 
 */

public class VerifyDesignDelegate implements Log {

    private File designFile;
    private Vector paths = new Vector();
    private boolean isCircularDesign = false;
    private boolean deleteFiles = false;
    private boolean fillInBuildException = false;
    private boolean needDeclarationsDefault = true;
    private boolean needDependsDefault = true;
    
    private Task task;
    private Design design;
    private HashSet primitives = new HashSet();
    private Vector designErrors = new Vector();
    private boolean verifiedAtLeastOne = false;

    public VerifyDesignDelegate(Task task) {
        this.task = task;
        primitives.add("B");
        primitives.add("C");
        primitives.add("D");
        primitives.add("F");
        primitives.add("I");
        primitives.add("J");
        primitives.add("S");
        primitives.add("Z");
    }

    public void addConfiguredPath(Path path) {
//    	Path newPath = new Path(task.getProject());
//    	path.
    	
    	
        paths.add(path);
    }

    public void setJar(File f) {
        Path p = (Path)task.getProject().createDataType("path");
        p.createPathElement().setLocation(f.getAbsoluteFile());
        addConfiguredPath(p);
    }

    public void setDesign(File f) {
        this.designFile = f;          
    }

    public void setCircularDesign(boolean isCircularDesign) {
        this.isCircularDesign = isCircularDesign;
    }

    public void setDeleteFiles(boolean deleteFiles) {
        this.deleteFiles = deleteFiles;
    }

	public void setFillInBuildException(boolean b) {
		fillInBuildException = b;
	}
	
	public void setNeedDeclarationsDefault(boolean b) {
		needDeclarationsDefault = b;
	}
	
	public void setNeedDependsDefault(boolean b) {
		needDependsDefault = b;
	}

    public void execute() {
        if(!designFile.exists() || designFile.isDirectory())
            throw new BuildException("design attribute in verifydesign element specified an invalid file="+designFile);
        
        verifyJarFilesExist();

        try {
            XMLReader reader = JAXPUtils.getXMLReader();
            DesignFileHandler ch = new DesignFileHandler(this, designFile, isCircularDesign, task.getLocation());
            ch.setNeedDeclarationsDefault(needDeclarationsDefault);
            ch.setNeedDependsDefault(needDependsDefault);
            reader.setContentHandler(ch);
            //reader.setEntityResolver(ch);
            //reader.setErrorHandler(ch);
            //reader.setDTDHandler(ch);

            log("about to start parsing file='"+designFile+"'", Project.MSG_INFO);
            FileInputStream fileInput = new FileInputStream(designFile);
            InputSource src = new InputSource(fileInput);
            reader.parse(src);
            design = ch.getDesign();

            Enumeration pathsEnum = paths.elements();
            Path p = null;
            while (pathsEnum.hasMoreElements()) {
                p = (Path)pathsEnum.nextElement();
                verifyPathAdheresToDesign(design, p);
            }

            if (! designErrors.isEmpty()) {
            	log(designErrors.size()+"Errors.", Project.MSG_WARN);
            	if(!fillInBuildException)
            		throw new BuildException("Design check failed due to previous errors");
            	throwAllErrors();
            }

        } catch (SAXException e) {
        	maybeDeleteFiles();
			if (e.getException() != null
					&& e.getException() instanceof RuntimeException)
				throw (RuntimeException) e.getException();
			else if (e instanceof SAXParseException) {
				SAXParseException pe = (SAXParseException) e;
				throw new BuildException("\nProblem parsing design file='"
						+ designFile + "'.  \nline=" + pe.getLineNumber()
						+ " column=" + pe.getColumnNumber() + " Reason:\n"
						+ e.getMessage() + "\n", e);
			}
			throw new BuildException("\nProblem parsing design file='"
					+ designFile + "'. Reason:\n" + e, e);
        } catch (IOException e) {
        	maybeDeleteFiles();
			throw new RuntimeException("See attached exception", e);
			// throw new BuildException("IOException on design file='"
			// + designFile + "'. attached:", e);
        } catch(RuntimeException e) {
        	maybeDeleteFiles();
            throw e;
        } finally {

        }
        
        if(!verifiedAtLeastOne) 
        	throw new BuildException("Did not find any class or jar files to verify");
    }
    //some auto builds like cruisecontrol can only report all the
    //standard ant task errors and the build exceptions so here
    //we need to fill in the buildexception so the errors are reported
    //correctly through those tools....though, you think ant has a hook
    //in that cruisecontrol is not using like LogListeners or something
    private void throwAllErrors() {
    	String result = "Design check failed due to following errors";
    	Enumeration exceptions = designErrors.elements();
    	while(exceptions.hasMoreElements()) {
    		BuildException be = (BuildException)exceptions.nextElement();
    		String message = be.getMessage();
    		result += "\n" + message;
    	}
    	throw new BuildException(result);
    }

    private void verifyJarFilesExist() {
        Enumeration pathsEnum = paths.elements();
        Path p = null;
        while (pathsEnum.hasMoreElements()) {
            p = (Path)pathsEnum.nextElement();
            String files[] = p.list();
            for (int i=0;i<files.length;i++) {
                File file = new File(files[i]);

                if (!file.exists())
        			throw new BuildException(VisitorImpl.getNoFileMsg(file));
            }            
        }
    }
    
    private void maybeDeleteFiles() {
        if (deleteFiles) {
			log("Deleting all class and jar files so you do not get tempted to\n" +
					"use a jar that doesn't abide by the design(This option can\n" +
					"be turned off if you really want)", Project.MSG_INFO);
			
            Enumeration pathsEnum = paths.elements();
            Path p = null;
            while (pathsEnum.hasMoreElements()) {
                p = (Path)pathsEnum.nextElement();
                deleteFilesInPath(p);
            }			
        }
    }
    
    private void deleteFilesInPath(Path p) {
        String files[] = p.list();
        for (int i=0;i<files.length;i++) {
            File file = new File(files[i]);

            boolean deleted = file.delete();
            if (! deleted) {
                file.deleteOnExit();
            }
        }    	
    }
    
    private void verifyPathAdheresToDesign(Design d, Path p) throws ClassFormatException, IOException {
        String files[] = p.list();
        for (int i=0;i<files.length;i++) {
            File file = new File(files[i]);
            if(file.isDirectory()) {
            	FileSet set = new FileSet();
				set.setDir(file);
            	set.setProject(task.getProject());
            	PatternSet.NameEntry entry1 = set.createInclude();
            	PatternSet.NameEntry entry2 = set.createInclude();
            	PatternSet.NameEntry entry3 = set.createInclude();
				entry1.setName("**/*.class");
				entry2.setName("**/*.jar");
				entry3.setName("**/*.war");
				DirectoryScanner scanner = set.getDirectoryScanner(task.getProject());
				scanner.setBasedir(file);
				String[] scannerFiles = scanner.getIncludedFiles();
				for(int j = 0; j < scannerFiles.length; j++) {
					verifyPartOfPath(scannerFiles[j], new File(file, scannerFiles[j]), d);
				}
            } else
            	verifyPartOfPath(files[i], file, d);
        }
    }
    
    private void verifyPartOfPath(String fileName, File file, Design d) throws IOException {
        if (fileName.endsWith(".jar") || fileName.endsWith(".war")) {
            JarFile jarFile = new JarFile(file);
            verifyJarAdheresToDesign(d, jarFile, file);
        } else if (fileName.endsWith(".class")) {
            verifyClassAdheresToDesign(d, file);
        } else
        	throw new BuildException("Only directories, jars, wars, and class files can be supplied to verify design, not file="+file.getAbsolutePath());
    }

    private void verifyClassAdheresToDesign(Design d, File classFile)
            throws ClassFormatException, IOException {
        FileInputStream fis = null;
        try {
            fis = new FileInputStream(classFile);
            verifyClassAdheresToDesign(d, fis, classFile.getAbsolutePath(), classFile);
        }
        finally {
            try {
                if (fis != null) {
                    fis.close();
                }
            }
            catch (IOException e) {
                ; //doh!!
            }
        }

    }
	
    private void verifyJarAdheresToDesign(Design d, JarFile jarFile, File original)
            throws ClassFormatException, IOException {

        try {
        Enumeration en = jarFile.entries();
        while(en.hasMoreElements()) {
            ZipEntry entry = (ZipEntry)en.nextElement();
            InputStream in = null;
            if(entry.getName().endsWith(".class")) {
                in = jarFile.getInputStream(entry);
                try {
                    in = jarFile.getInputStream(entry);
                    verifyClassAdheresToDesign(d, in, entry.getName(), original);
                }
                finally {
                    try {
                        if (in != null) {
                            in.close();
                        }
                    }
                    catch (IOException e) {
                        ; // doh!!!
                    }
                }
            }
        }
        }
        finally {
            try {
                jarFile.close();
            }
            catch (IOException e) {
                ; //doh!!!
            }
        }
    }

    private String className = "";

    private void verifyClassAdheresToDesign(Design d, InputStream in, String name, File originalClassOrJarFile) throws ClassFormatException, IOException {
    	try {
    		verifiedAtLeastOne = true;
	        ClassParser parser = new ClassParser(in, name);
	        JavaClass javaClass = parser.parse();
	        className = javaClass.getClassName();
	        
	        if(!d.needEvalCurrentClass(className))
	        	return;
	
	        ConstantPool pool = javaClass.getConstantPool();
	        processConstantPool(pool);
	        VisitorImpl visitor = new VisitorImpl(pool, this, d, task.getLocation());
	        DescendingVisitor desc = new DescendingVisitor(javaClass, visitor);
	        desc.visit();
    	} catch(BuildException e) {
            log(Design.getWrapperMsg(originalClassOrJarFile, e.getMessage()), Project.MSG_ERR);
            designErrors.addElement(e);    		
    	}
    }

    private void processConstantPool(ConstantPool pool) {
        Constant[] constants = pool.getConstantPool();
        if(constants == null) {
            log("      constants=null", Project.MSG_VERBOSE);
            return;
        }
        
        log("      constants len="+constants.length, Project.MSG_VERBOSE);      
        for(int i = 0; i < constants.length; i++) {
            processConstant(pool, constants[i], i);
        }
    }
    
    private void processConstant(ConstantPool pool, Constant c, int i) {
        if(c == null) //don't know why, but constant[0] seems to be always null.
            return;

        log("      const["+i+"]="+pool.constantToString(c)+" inst="+c.getClass().getName(), Project.MSG_DEBUG); 
        byte tag = c.getTag();
        switch(tag) {
            //reverse engineered from ConstantPool.constantToString..
        case Constants.CONSTANT_Class:
            int ind   = ((ConstantClass)c).getNameIndex();
            c   = pool.getConstant(ind, Constants.CONSTANT_Utf8);
            String className = Utility.compactClassName(((ConstantUtf8)c).getBytes(), false);
            log("      classNamePre="+className, Project.MSG_DEBUG);
			className = getRidOfArray(className);
            String firstLetter = className.charAt(0)+"";
            if(primitives.contains(firstLetter))
            	return;
            log("      className="+className, Project.MSG_VERBOSE);
            design.checkClass(className);
            break;
        default:
                
        }
    }
	
	private static String getRidOfArray(String className) {
		while(className.startsWith("["))
			className = className.substring(1, className.length());
		return className;
	}
    
    public static String getPackageName(String className) {
        String packageName = Package.DEFAULT;
        int index = className.lastIndexOf(".");
        if(index > 0)
            packageName = className.substring(0, index);
        //DEANDO: test the else scenario here(it is a corner case)...

        return packageName;
    }
    
    public void log(String msg, int level) {
    	//if(level == Project.MSG_WARN || level == Project.MSG_INFO 
    	//		|| level == Project.MSG_ERR || level == Project.MSG_VERBOSE)
    	//VerifyDesignTest.log(msg);
        task.log(msg, level);
    }
}