1
|
|
/*
|
2
|
|
* The Apache Software License, Version 1.1
|
3
|
|
*
|
4
|
|
* Copyright (c) 2002 The Apache Software Foundation. All rights
|
5
|
|
* reserved.
|
6
|
|
*
|
7
|
|
* Redistribution and use in source and binary forms, with or without
|
8
|
|
* modification, are permitted provided that the following conditions
|
9
|
|
* are met:
|
10
|
|
*
|
11
|
|
* 1. Redistributions of source code must retain the above copyright
|
12
|
|
* notice, this list of conditions and the following disclaimer.
|
13
|
|
*
|
14
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
15
|
|
* notice, this list of conditions and the following disclaimer in
|
16
|
|
* the documentation and/or other materials provided with the
|
17
|
|
* distribution.
|
18
|
|
*
|
19
|
|
* 3. The end-user documentation included with the redistribution, if
|
20
|
|
* any, must include the following acknowlegement:
|
21
|
|
* "This product includes software developed by the
|
22
|
|
* Apache Software Foundation (http://www.apache.org/)."
|
23
|
|
* Alternately, this acknowlegement may appear in the software itself,
|
24
|
|
* if and wherever such third-party acknowlegements normally appear.
|
25
|
|
*
|
26
|
|
* 4. The names "Ant" and "Apache Software
|
27
|
|
* Foundation" must not be used to endorse or promote products derived
|
28
|
|
* from this software without prior written permission. For written
|
29
|
|
* permission, please contact apache@apache.org.
|
30
|
|
*
|
31
|
|
* 5. Products derived from this software may not be called "Apache"
|
32
|
|
* nor may "Apache" appear in their names without prior written
|
33
|
|
* permission of the Apache Group.
|
34
|
|
*
|
35
|
|
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
|
36
|
|
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
37
|
|
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
38
|
|
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
|
39
|
|
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
40
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
41
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
42
|
|
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
43
|
|
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
44
|
|
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
45
|
|
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
46
|
|
* SUCH DAMAGE.
|
47
|
|
* ====================================================================
|
48
|
|
*
|
49
|
|
* This software consists of voluntary contributions made by many
|
50
|
|
* individuals on behalf of the Apache Software Foundation. For more
|
51
|
|
* information on the Apache Software Foundation, please see
|
52
|
|
* <http://www.apache.org/>.
|
53
|
|
*/
|
54
|
|
package org.apache.tools.ant.taskdefs.optional.metamata;
|
55
|
|
|
56
|
|
import java.io.File;
|
57
|
|
import java.util.Vector;
|
58
|
|
import org.apache.tools.ant.util.StringUtils;
|
59
|
|
import org.apache.tools.ant.util.regexp.RegexpMatcher;
|
60
|
|
import org.apache.tools.ant.util.regexp.RegexpMatcherFactory;
|
61
|
|
|
62
|
|
/**
|
63
|
|
* Parser that will parse an output line of MAudit and return an
|
64
|
|
* interpreted violation if any.
|
65
|
|
*
|
66
|
|
* <p>
|
67
|
|
* MAudit is supposed to be configured with -fullpath so that it can
|
68
|
|
* correctly locate the file and attribute violation to the appropriate
|
69
|
|
* file (there might be several classes with the same name in
|
70
|
|
* different packages)
|
71
|
|
* </p>
|
72
|
|
*
|
73
|
|
* @author <a href="mailto:sbailliez@apache.org">Stephane Bailliez</a>
|
74
|
|
*/
|
75
|
|
final class MAuditParser {
|
76
|
|
|
77
|
|
/** pattern used by maudit to report the error for a file */
|
78
|
|
/** RE does not seems to support regexp pattern with comments so i'm stripping it*/
|
79
|
|
// (?:file:)?((?#filepath).+):((?#line)\\d+)\\s*:\\s+((?#message).*)
|
80
|
|
private static final String AUDIT_PATTERN = "(?:file:)?(.+):(\\d+)\\s*:\\s+(.*)";
|
81
|
|
|
82
|
|
/** matcher that will be used to extract the info from the line */
|
83
|
|
private final RegexpMatcher matcher;
|
84
|
|
|
85
|
0
|
MAuditParser(){
|
86
|
|
/** the matcher should be the Oro one. I don't know about the other one */
|
87
|
0
|
matcher = (new RegexpMatcherFactory()).newRegexpMatcher();
|
88
|
0
|
matcher.setPattern(AUDIT_PATTERN);
|
89
|
|
}
|
90
|
|
|
91
|
|
/**
|
92
|
|
* Parse a line obtained from MAudit.
|
93
|
|
* @param line a line obtained from the MAudit output.
|
94
|
|
* @return the violation corresponding to the displayed line
|
95
|
|
* or <tt>null</tt> if it could not parse it. (might be a
|
96
|
|
* message info or copyright or summary).
|
97
|
|
*/
|
98
|
0
|
Violation parseLine(String line){
|
99
|
0
|
Vector matches = matcher.getGroups(line);
|
100
|
0
|
if (matches == null){
|
101
|
0
|
return null;
|
102
|
|
}
|
103
|
0
|
final String file = (String) matches.elementAt(1);
|
104
|
0
|
Violation violation = new Violation();
|
105
|
0
|
violation.file = file;
|
106
|
0
|
violation.line = (String) matches.elementAt(2);
|
107
|
0
|
violation.error = (String) matches.elementAt(3);
|
108
|
|
// remove the pathname from any messages and let the classname only.
|
109
|
0
|
final int pos = file.lastIndexOf(File.separatorChar);
|
110
|
0
|
if ((pos != -1) && (pos != file.length() - 1)) {
|
111
|
0
|
String filename = file.substring(pos + 1);
|
112
|
0
|
violation.error = StringUtils.replace(violation.error,
|
113
|
|
"file:" + file, filename);
|
114
|
|
}
|
115
|
0
|
return violation;
|
116
|
|
}
|
117
|
|
|
118
|
|
/** the inner class used to report violation information */
|
119
|
|
static final class Violation {
|
120
|
|
String file;
|
121
|
|
String line;
|
122
|
|
String error;
|
123
|
|
}
|
124
|
|
}
|
125
|
|
|