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
|
/*
* SonarQube, open source software quality management tool.
* Copyright (C) 2008-2014 SonarSource
* mailto:contact AT sonarsource DOT com
*
* SonarQube 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 3 of the License, or (at your option) any later version.
*
* SonarQube 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 program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.api.utils;
import com.ctc.wstx.stax.WstxInputFactory;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang.StringUtils;
import org.codehaus.staxmate.SMInputFactory;
import org.codehaus.staxmate.in.SMHierarchicCursor;
import java.io.*;
import java.net.URL;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLResolver;
import javax.xml.stream.XMLStreamException;
/**
* @since 1.10
*/
public class StaxParser {
private SMInputFactory inf;
private XmlStreamHandler streamHandler;
private boolean isoControlCharsAwareParser;
/**
* Stax parser for a given stream handler and iso control chars set awarness to off
*
* @param streamHandler the xml stream handler
*/
public StaxParser(XmlStreamHandler streamHandler) {
this(streamHandler, false);
}
/**
* Stax parser for a given stream handler and iso control chars set awarness to on.
* The iso control chars in the xml file will be replaced by simple spaces, usefull for
* potentially bogus XML files to parse, this has a small perfs overhead so use it only when necessary
*
* @param streamHandler the xml stream handler
* @param isoControlCharsAwareParser true or false
*/
public StaxParser(XmlStreamHandler streamHandler, boolean isoControlCharsAwareParser) {
this.streamHandler = streamHandler;
XMLInputFactory xmlFactory = XMLInputFactory.newInstance();
if (xmlFactory instanceof WstxInputFactory) {
WstxInputFactory wstxInputfactory = (WstxInputFactory) xmlFactory;
wstxInputfactory.configureForLowMemUsage();
wstxInputfactory.getConfig().setUndeclaredEntityResolver(new UndeclaredEntitiesXMLResolver());
}
xmlFactory.setProperty(XMLInputFactory.IS_VALIDATING, false);
xmlFactory.setProperty(XMLInputFactory.SUPPORT_DTD, false);
xmlFactory.setProperty(XMLInputFactory.IS_NAMESPACE_AWARE, false);
this.isoControlCharsAwareParser = isoControlCharsAwareParser;
inf = new SMInputFactory(xmlFactory);
}
public void parse(File xmlFile) throws XMLStreamException {
FileInputStream input=null;
try {
input = new FileInputStream(xmlFile);
parse(input);
} catch (FileNotFoundException e) {
throw new XMLStreamException(e);
} finally {
IOUtils.closeQuietly(input);
}
}
public void parse(InputStream xmlInput) throws XMLStreamException {
xmlInput = isoControlCharsAwareParser ? new ISOControlCharAwareInputStream(xmlInput) : xmlInput;
parse(inf.rootElementCursor(xmlInput));
}
public void parse(Reader xmlReader) throws XMLStreamException {
if (isoControlCharsAwareParser) {
throw new SonarException("Method call not supported when isoControlCharsAwareParser=true");
}
parse(inf.rootElementCursor(xmlReader));
}
public void parse(URL xmlUrl) throws XMLStreamException {
try {
parse(xmlUrl.openStream());
} catch (IOException e) {
throw new XMLStreamException(e);
}
}
private void parse(SMHierarchicCursor rootCursor) throws XMLStreamException {
try {
streamHandler.stream(rootCursor);
} finally {
rootCursor.getStreamReader().closeCompletely();
}
}
private static class UndeclaredEntitiesXMLResolver implements XMLResolver {
@Override
public Object resolveEntity(String arg0, String arg1, String fileName, String undeclaredEntity) throws XMLStreamException {
// avoid problems with XML docs containing undeclared entities.. return the entity under its raw form if not an unicode expression
if (StringUtils.startsWithIgnoreCase(undeclaredEntity, "u") && undeclaredEntity.length() == 5) {
int unicodeCharHexValue = Integer.parseInt(undeclaredEntity.substring(1), 16);
if (Character.isDefined(unicodeCharHexValue)) {
undeclaredEntity = new String(new char[]{(char) unicodeCharHexValue});
}
}
return undeclaredEntity;
}
}
/**
* Simple interface for handling XML stream to parse
*/
public interface XmlStreamHandler {
void stream(SMHierarchicCursor rootCursor) throws XMLStreamException;
}
private static class ISOControlCharAwareInputStream extends InputStream {
private InputStream inputToCheck;
public ISOControlCharAwareInputStream(InputStream inputToCheck) {
super();
this.inputToCheck = inputToCheck;
}
@Override
public int read() throws IOException {
return inputToCheck.read();
}
@Override
public int available() throws IOException {
return inputToCheck.available();
}
@Override
public void close() throws IOException {
inputToCheck.close();
}
@Override
public synchronized void mark(int readlimit) {
inputToCheck.mark(readlimit);
}
@Override
public boolean markSupported() {
return inputToCheck.markSupported();
}
@Override
public int read(byte[] b, int off, int len) throws IOException {
int readen = inputToCheck.read(b, off, len);
checkBufferForISOControlChars(b, off, len);
return readen;
}
@Override
public int read(byte[] b) throws IOException {
int readen = inputToCheck.read(b);
checkBufferForISOControlChars(b, 0, readen);
return readen;
}
@Override
public synchronized void reset() throws IOException {
inputToCheck.reset();
}
@Override
public long skip(long n) throws IOException {
return inputToCheck.skip(n);
}
private void checkBufferForISOControlChars(byte[] buffer, int off, int len) {
for (int i = off; i < len; i++) {
char streamChar = (char) buffer[i];
if (Character.isISOControl(streamChar) && streamChar != '\n') {
// replace control chars by a simple space
buffer[i] = ' ';
}
}
}
}
}
|
