-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
XMLLogger.java
executable file
·237 lines (215 loc) · 7.37 KB
/
XMLLogger.java
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
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2013 Oliver Burn
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.io.UnsupportedEncodingException;
import java.util.ResourceBundle;
import com.puppycrawl.tools.checkstyle.api.AuditEvent;
import com.puppycrawl.tools.checkstyle.api.AuditListener;
import com.puppycrawl.tools.checkstyle.api.AutomaticBean;
import com.puppycrawl.tools.checkstyle.api.SeverityLevel;
/**
* Simple XML logger.
* It outputs everything in UTF-8 (default XML encoding is UTF-8) in case
* we want to localize error messages or simply that filenames are
* localized and takes care about escaping as well.
* @author <a href="mailto:stephane.bailliez@wanadoo.fr">Stephane Bailliez</a>
*/
public class XMLLogger
extends AutomaticBean
implements AuditListener
{
/** decimal radix */
private static final int BASE_10 = 10;
/** hex radix */
private static final int BASE_16 = 16;
/** close output stream in auditFinished */
private boolean mCloseStream;
/** helper writer that allows easy encoding and printing */
private PrintWriter mWriter;
/** some known entities to detect */
private static final String[] ENTITIES = {"gt", "amp", "lt", "apos",
"quot", };
/**
* Creates a new <code>XMLLogger</code> instance.
* Sets the output to a defined stream.
* @param aOS the stream to write logs to.
* @param aCloseStream close aOS in auditFinished
*/
public XMLLogger(OutputStream aOS, boolean aCloseStream)
{
setOutputStream(aOS);
mCloseStream = aCloseStream;
}
/**
* sets the OutputStream
* @param aOS the OutputStream to use
**/
private void setOutputStream(OutputStream aOS)
{
try {
final OutputStreamWriter osw = new OutputStreamWriter(aOS, "UTF-8");
mWriter = new PrintWriter(osw);
}
catch (final UnsupportedEncodingException e) {
// unlikely to happen...
throw new ExceptionInInitializerError(e);
}
}
/** {@inheritDoc} */
public void auditStarted(AuditEvent aEvt)
{
mWriter.println("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
final ResourceBundle compilationProperties =
ResourceBundle.getBundle("checkstylecompilation");
final String version =
compilationProperties.getString("checkstyle.compile.version");
mWriter.println("<checkstyle version=\"" + version + "\">");
}
/** {@inheritDoc} */
public void auditFinished(AuditEvent aEvt)
{
mWriter.println("</checkstyle>");
if (mCloseStream) {
mWriter.close();
}
else {
mWriter.flush();
}
}
/** {@inheritDoc} */
public void fileStarted(AuditEvent aEvt)
{
mWriter.println("<file name=\"" + encode(aEvt.getFileName()) + "\">");
}
/** {@inheritDoc} */
public void fileFinished(AuditEvent aEvt)
{
mWriter.println("</file>");
}
/** {@inheritDoc} */
public void addError(AuditEvent aEvt)
{
if (!SeverityLevel.IGNORE.equals(aEvt.getSeverityLevel())) {
mWriter.print("<error" + " line=\"" + aEvt.getLine() + "\"");
if (aEvt.getColumn() > 0) {
mWriter.print(" column=\"" + aEvt.getColumn() + "\"");
}
mWriter.print(" severity=\""
+ aEvt.getSeverityLevel().getName()
+ "\"");
mWriter.print(" message=\""
+ encode(aEvt.getMessage())
+ "\"");
mWriter.println(" source=\""
+ encode(aEvt.getSourceName())
+ "\"/>");
}
}
/** {@inheritDoc} */
public void addException(AuditEvent aEvt, Throwable aThrowable)
{
final StringWriter sw = new StringWriter();
final PrintWriter pw = new PrintWriter(sw);
pw.println("<exception>");
pw.println("<![CDATA[");
aThrowable.printStackTrace(pw);
pw.println("]]>");
pw.println("</exception>");
pw.flush();
mWriter.println(encode(sw.toString()));
}
/**
* Escape <, > & ' and " as their entities.
* @param aValue the value to escape.
* @return the escaped value if necessary.
*/
public String encode(String aValue)
{
final StringBuffer sb = new StringBuffer();
for (int i = 0; i < aValue.length(); i++) {
final char c = aValue.charAt(i);
switch (c) {
case '<':
sb.append("<");
break;
case '>':
sb.append(">");
break;
case '\'':
sb.append("'");
break;
case '\"':
sb.append(""");
break;
case '&':
final int nextSemi = aValue.indexOf(";", i);
if ((nextSemi < 0)
|| !isReference(aValue.substring(i, nextSemi + 1)))
{
sb.append("&");
}
else {
sb.append('&');
}
break;
default:
sb.append(c);
break;
}
}
return sb.toString();
}
/**
* @return whether the given argument a character or entity reference
* @param aEnt the possible entity to look for.
*/
public boolean isReference(String aEnt)
{
if (!(aEnt.charAt(0) == '&') || !aEnt.endsWith(";")) {
return false;
}
if (aEnt.charAt(1) == '#') {
int prefixLength = 2; // "&#"
int radix = BASE_10;
if (aEnt.charAt(2) == 'x') {
prefixLength++;
radix = BASE_16;
}
try {
Integer.parseInt(
aEnt.substring(prefixLength, aEnt.length() - 1), radix);
return true;
}
catch (final NumberFormatException nfe) {
return false;
}
}
final String name = aEnt.substring(1, aEnt.length() - 1);
for (String element : ENTITIES) {
if (name.equals(element)) {
return true;
}
}
return false;
}
}