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
|
/*
* Copyright (C) 2011 The Android Open Source Project
*
* 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 com.android.ide.common.resources;
import com.android.annotations.NonNull;
import org.kxml2.io.KXmlParser;
import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlPullParserException;
import java.io.BufferedInputStream;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
/**
* Parser for scanning an XML resource file and validating all framework
* attribute references in it. If an error is found, the associated context
* is marked as needing a full AAPT run.
*/
public class ValidatingResourceParser {
private final boolean mIsFramework;
private ScanningContext mContext;
/**
* Creates a new {@link ValidatingResourceParser}
*
* @param context a context object with state for the current update, such
* as a place to stash errors encountered
* @param isFramework true if scanning a framework resource
*/
public ValidatingResourceParser(
@NonNull ScanningContext context,
boolean isFramework) {
mContext = context;
mIsFramework = isFramework;
}
/**
* Parse the given input and return false if it contains errors, <b>or</b> if
* the context is already tagged as needing a full aapt run.
*
* @param path the full OS path to the file being parsed
* @param input the input stream of the XML to be parsed
* @return true if parsing succeeds and false if it fails
* @throws IOException if reading the contents fails
*/
public boolean parse(final String path, InputStream input)
throws IOException {
// No need to validate framework files
if (mIsFramework) {
return true;
}
if (mContext.needsFullAapt()) {
return false;
}
KXmlParser parser = new KXmlParser();
try {
parser.setFeature(XmlPullParser.FEATURE_PROCESS_NAMESPACES, true);
if (input instanceof FileInputStream) {
input = new BufferedInputStream(input);
}
parser.setInput(input, "UTF-8"); //$NON-NLS-1$
return parse(path, parser);
} catch (XmlPullParserException e) {
String message = e.getMessage();
// Strip off position description
int index = message.indexOf("(position:"); //$NON-NLS-1$ (Hardcoded in KXml)
if (index != -1) {
message = message.substring(0, index);
}
String error = String.format("%1$s:%2$d: Error: %3$s", //$NON-NLS-1$
path, parser.getLineNumber(), message);
mContext.addError(error);
return false;
} catch (RuntimeException e) {
// Some exceptions are thrown by the KXmlParser that are not XmlPullParserExceptions,
// such as this one:
// java.lang.RuntimeException: Undefined Prefix: w in org.kxml2.io.KXmlParser@...
// at org.kxml2.io.KXmlParser.adjustNsp(Unknown Source)
// at org.kxml2.io.KXmlParser.parseStartTag(Unknown Source)
String message = e.getMessage();
String error = String.format("%1$s:%2$d: Error: %3$s", //$NON-NLS-1$
path, parser.getLineNumber(), message);
mContext.addError(error);
return false;
}
}
private boolean parse(String path, KXmlParser parser)
throws XmlPullParserException, IOException {
boolean checkForErrors = !mIsFramework && !mContext.needsFullAapt();
while (true) {
int event = parser.next();
if (event == XmlPullParser.START_TAG) {
for (int i = 0, n = parser.getAttributeCount(); i < n; i++) {
String attribute = parser.getAttributeName(i);
String value = parser.getAttributeValue(i);
assert value != null : attribute;
if (checkForErrors) {
String uri = parser.getAttributeNamespace(i);
if (!mContext.checkValue(uri, attribute, value)) {
mContext.requestFullAapt();
return false;
}
}
}
} else if (event == XmlPullParser.END_DOCUMENT) {
break;
}
}
return true;
}
}
|
