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
|
/*******************************************************************************
* Copyright (c) 2004, 2006 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.wst.html.core.internal.validate;
import java.util.Iterator;
import org.eclipse.wst.sse.core.internal.provisional.IndexedRegion;
import org.eclipse.wst.sse.core.internal.provisional.text.ITextRegion;
import org.eclipse.wst.sse.core.internal.provisional.text.ITextRegionContainer;
import org.eclipse.wst.sse.core.internal.provisional.text.ITextRegionList;
import org.eclipse.wst.xml.core.internal.contentmodel.CMAttributeDeclaration;
import org.eclipse.wst.xml.core.internal.contentmodel.CMDataType;
import org.eclipse.wst.xml.core.internal.contentmodel.CMElementDeclaration;
import org.eclipse.wst.xml.core.internal.contentmodel.CMNamedNodeMap;
import org.eclipse.wst.xml.core.internal.provisional.document.IDOMAttr;
import org.eclipse.wst.xml.core.internal.provisional.document.IDOMElement;
import org.eclipse.wst.xml.core.internal.provisional.document.IDOMNode;
import org.eclipse.wst.xml.core.internal.regions.DOMRegionContext;
import org.w3c.dom.Attr;
import org.w3c.dom.Element;
import org.w3c.dom.NamedNodeMap;
public class HTMLAttributeValidator extends PrimeValidator {
private static final int REGION_NAME = 1;
private static final int REGION_VALUE = 2;
// <<D210422
private static final char SINGLE_QUOTE = '\'';
private static final char DOUBLE_QUOTE = '\"';
// D210422
/**
* HTMLAttributeValidator constructor comment.
*/
public HTMLAttributeValidator() {
super();
}
/**
*/
private Segment getErrorSegment(IDOMNode errorNode, int regionType) {
ITextRegion rgn = null;
switch (regionType) {
case REGION_NAME :
rgn = errorNode.getNameRegion();
break;
case REGION_VALUE :
rgn = errorNode.getValueRegion();
break;
default :
// nothing to do.
break;
}
if (rgn != null) {
if (errorNode instanceof IDOMAttr) {
IDOMElement ownerElement = (IDOMElement) ((IDOMAttr) errorNode).getOwnerElement();
if (ownerElement != null) {
int regionStartOffset = ownerElement.getFirstStructuredDocumentRegion().getStartOffset(rgn);
int regionLength = rgn.getLength();
return new Segment(regionStartOffset, regionLength);
}
}
}
return new Segment(errorNode.getStartOffset(), 0);
}
/**
* Allowing the INodeAdapter to compare itself against the type allows it
* to return true in more than one case.
*/
public boolean isAdapterForType(Object type) {
return ((type == HTMLAttributeValidator.class) || super.isAdapterForType(type));
}
/**
*/
public void validate(IndexedRegion node) {
Element target = (Element) node;
if (CMUtil.isForeign(target))
return;
CMElementDeclaration edec = CMUtil.getDeclaration(target);
if (edec == null)
return;
CMNamedNodeMap declarations = edec.getAttributes();
NamedNodeMap attrs = target.getAttributes();
for (int i = 0; i < attrs.getLength(); i++) {
int rgnType = REGION_NAME;
int state = ErrorState.NONE_ERROR;
Attr a = (Attr) attrs.item(i);
// D203637; If the target attr has prefix, the validator should
// not
// warn about it. That is, just ignore. It is able to check
// whether
// an attr has prefix or not by calling XMLAttr#isGlobalAttr().
// When a attr has prefix (not global), it returns false.
boolean isXMLAttr = a instanceof IDOMAttr;
if (isXMLAttr) {
IDOMAttr xmlattr = (IDOMAttr) a;
if (!xmlattr.isGlobalAttr())
continue; // skip futher validation and begin next loop.
}
CMAttributeDeclaration adec = (CMAttributeDeclaration) declarations.getNamedItem(a.getName());
if (adec == null) {
// No attr declaration was found. That is, the attr name is
// undefined.
// but not regard it as undefined name if it includes JSP
if (!hasJSPRegion(((IDOMNode) a).getNameRegion())) {
rgnType = REGION_NAME;
state = ErrorState.UNDEFINED_NAME_ERROR;
}
}
else {
// The attr declaration was found.
// At 1st, the name should be checked.
if (CMUtil.isHTML(edec) && (!CMUtil.isXHTML(edec))) {
// If the target element is pure HTML (not XHTML), some
// attributes
// might be written in boolean format. It should be check
// specifically.
if (CMUtil.isBooleanAttr(adec) && ((IDOMAttr) a).hasNameOnly())
continue; // OK, keep going. No more check is needed
// against this attr.
}
else {
// If the target is other than pure HTML (JSP or XHTML),
// the name
// must be checked exactly (ie in case sensitive way).
String actual = a.getName();
String desired = adec.getAttrName();
if (!actual.equals(desired)) { // case mismatch
rgnType = REGION_NAME;
state = ErrorState.MISMATCHED_ERROR;
}
}
// Then, the value must be checked.
if (state == ErrorState.NONE_ERROR) { // Need more check.
// Now, the value should be checked, if the type is ENUM.
CMDataType attrType = adec.getAttrType();
String actualValue = a.getValue();
if (attrType.getImpliedValueKind() == CMDataType.IMPLIED_VALUE_FIXED) {
// Check FIXED value.
String validValue = attrType.getImpliedValue();
if (!actualValue.equals(validValue)) {
rgnType = REGION_VALUE;
state = ErrorState.UNDEFINED_VALUE_ERROR;
}
}
else {
String[] candidates = attrType.getEnumeratedValues();
if (candidates != null && candidates.length > 0) {
// several candidates are found.
boolean found = false;
for (int index = 0; index < candidates.length; index++) {
String candidate = candidates[index];
// At 1st, compare ignoring case.
if (actualValue.equalsIgnoreCase(candidate)) {
found = true;
if (CMUtil.isCaseSensitive(edec) && (!actualValue.equals(candidate))) {
rgnType = REGION_VALUE;
state = ErrorState.MISMATCHED_VALUE_ERROR;
}
break; // exit the loop.
}
}
if (!found) {
// No candidate was found. That is,
// actualValue is invalid.
// but not regard it as undefined value if it
// includes JSP.
if (!hasJSPRegion(((IDOMNode) a).getValueRegion())) {
rgnType = REGION_VALUE;
state = ErrorState.UNDEFINED_VALUE_ERROR;
}
}
}
}
}
// <<D210422
if (state == ErrorState.NONE_ERROR) { // Need more check.
if (isXMLAttr) {
String source = ((IDOMAttr) a).getValueRegionText();
if (source != null) {
char firstChar = source.charAt(0);
char lastChar = source.charAt(source.length() - 1);
if (isQuote(firstChar) || isQuote(lastChar)) {
if (lastChar != firstChar) {
rgnType = REGION_VALUE;
state = ErrorState.UNCLOSED_ATTR_VALUE;
}
}
}
}
}
// D210422
}
if (state != ErrorState.NONE_ERROR) {
Segment seg = getErrorSegment((IDOMNode) a, rgnType);
if (seg != null)
reporter.report(MessageFactory.createMessage(new ErrorInfoImpl(state, seg, a)));
}
}
}
/**
*/
private boolean hasJSPRegion(ITextRegion container) {
if (!(container instanceof ITextRegionContainer))
return false;
ITextRegionList regions = ((ITextRegionContainer) container).getRegions();
if (regions == null)
return false;
Iterator e = regions.iterator();
while (e.hasNext()) {
ITextRegion region = (ITextRegion) e.next();
if (region == null)
continue;
String regionType = region.getType();
if (regionType == DOMRegionContext.XML_TAG_OPEN || (isNestedTagName(regionType)))
return true;
}
return false;
}
/**
* ISSUE: this is a bit of hidden JSP knowledge that was implemented this
* way for expedency. Should be evolved in future to depend on "nestedContext".
*/
private boolean isNestedTagName(String regionType) {
final String JSP_SCRIPTLET_OPEN = "JSP_SCRIPTLET_OPEN"; //$NON-NLS-1$
final String JSP_EXPRESSION_OPEN = "JSP_EXPRESSION_OPEN"; //$NON-NLS-1$
final String JSP_DECLARATION_OPEN = "JSP_DECLARATION_OPEN"; //$NON-NLS-1$
final String JSP_DIRECTIVE_OPEN = "JSP_DIRECTIVE_OPEN"; //$NON-NLS-1$
boolean result = regionType.equals(JSP_SCRIPTLET_OPEN) || regionType.equals(JSP_EXPRESSION_OPEN) || regionType.equals(JSP_DECLARATION_OPEN) || regionType.equals(JSP_DIRECTIVE_OPEN);
return result;
}
// <<D214022
private boolean isQuote(char c) {
return (c == SINGLE_QUOTE) || (c == DOUBLE_QUOTE);
}
// D210422
}
|
