1 |
| |
2 |
| |
3 |
| |
4 |
| |
5 |
| |
6 |
| |
7 |
| |
8 |
| |
9 |
| |
10 |
| |
11 |
| |
12 |
| |
13 |
| |
14 |
| |
15 |
| package org.apache.tapestry.util.xml; |
16 |
| |
17 |
| import java.io.IOException; |
18 |
| import java.io.InputStream; |
19 |
| import java.net.URL; |
20 |
| import java.util.ArrayList; |
21 |
| import java.util.HashMap; |
22 |
| import java.util.List; |
23 |
| import java.util.Map; |
24 |
| |
25 |
| import javax.xml.parsers.ParserConfigurationException; |
26 |
| import javax.xml.parsers.SAXParser; |
27 |
| import javax.xml.parsers.SAXParserFactory; |
28 |
| |
29 |
| import org.apache.commons.logging.Log; |
30 |
| import org.apache.commons.logging.LogFactory; |
31 |
| import org.apache.hivemind.ApplicationRuntimeException; |
32 |
| import org.apache.hivemind.HiveMind; |
33 |
| import org.apache.hivemind.Location; |
34 |
| import org.apache.hivemind.Resource; |
35 |
| import org.apache.hivemind.impl.LocationImpl; |
36 |
| import org.apache.tapestry.Tapestry; |
37 |
| import org.apache.tapestry.util.RegexpMatcher; |
38 |
| import org.xml.sax.Attributes; |
39 |
| import org.xml.sax.InputSource; |
40 |
| import org.xml.sax.Locator; |
41 |
| import org.xml.sax.SAXException; |
42 |
| import org.xml.sax.SAXParseException; |
43 |
| import org.xml.sax.helpers.DefaultHandler; |
44 |
| |
45 |
| |
46 |
| |
47 |
| |
48 |
| |
49 |
| |
50 |
| |
51 |
| |
52 |
| |
53 |
| |
54 |
| |
55 |
| |
56 |
| |
57 |
| |
58 |
| |
59 |
| |
60 |
| |
61 |
| |
62 |
| |
63 |
| |
64 |
| public class RuleDirectedParser extends DefaultHandler |
65 |
| { |
66 |
| private static final Log LOG = LogFactory.getLog(RuleDirectedParser.class); |
67 |
| |
68 |
| private Resource _documentLocation; |
69 |
| |
70 |
| private List _ruleStack = new ArrayList(); |
71 |
| |
72 |
| private List _objectStack = new ArrayList(); |
73 |
| |
74 |
| private Object _documentObject; |
75 |
| |
76 |
| private Locator _locator; |
77 |
| |
78 |
| private int _line = -1; |
79 |
| |
80 |
| private int _column = -1; |
81 |
| |
82 |
| private Location _location; |
83 |
| |
84 |
| private static SAXParserFactory _parserFactory; |
85 |
| |
86 |
| private SAXParser _parser; |
87 |
| |
88 |
| private RegexpMatcher _matcher; |
89 |
| |
90 |
| private String _uri; |
91 |
| |
92 |
| private String _localName; |
93 |
| |
94 |
| private String _qName; |
95 |
| |
96 |
| |
97 |
| |
98 |
| |
99 |
| private Map _ruleMap = new HashMap(); |
100 |
| |
101 |
| |
102 |
| |
103 |
| |
104 |
| |
105 |
| |
106 |
| private StringBuffer _contentBuffer = new StringBuffer(); |
107 |
| |
108 |
| |
109 |
| |
110 |
| |
111 |
| |
112 |
| private Map _entities = new HashMap(); |
113 |
| |
114 |
32
| public Object parse(Resource documentLocation)
|
115 |
| { |
116 |
32
| if (LOG.isDebugEnabled())
|
117 |
0
| LOG.debug("Parsing: " + documentLocation);
|
118 |
| |
119 |
32
| try
|
120 |
| { |
121 |
32
| _documentLocation = documentLocation;
|
122 |
| |
123 |
32
| URL url = documentLocation.getResourceURL();
|
124 |
| |
125 |
32
| if (url == null)
|
126 |
0
| throw new DocumentParseException(Tapestry.format(
|
127 |
| "RuleDrivenParser.resource-missing", |
128 |
| documentLocation), documentLocation); |
129 |
| |
130 |
32
| return parse(url);
|
131 |
| } |
132 |
| finally |
133 |
| { |
134 |
32
| _documentLocation = null;
|
135 |
32
| _ruleStack.clear();
|
136 |
32
| _objectStack.clear();
|
137 |
32
| _documentObject = null;
|
138 |
| |
139 |
32
| _uri = null;
|
140 |
32
| _localName = null;
|
141 |
32
| _qName = null;
|
142 |
| |
143 |
32
| _line = -1;
|
144 |
32
| _column = -1;
|
145 |
32
| _location = null;
|
146 |
32
| _locator = null;
|
147 |
| |
148 |
32
| _contentBuffer.setLength(0);
|
149 |
| } |
150 |
| } |
151 |
| |
152 |
32
| protected Object parse(URL url)
|
153 |
| { |
154 |
32
| if (_parser == null)
|
155 |
32
| _parser = constructParser();
|
156 |
| |
157 |
32
| InputStream stream = null;
|
158 |
| |
159 |
32
| try
|
160 |
| { |
161 |
32
| stream = url.openStream();
|
162 |
| } |
163 |
| catch (IOException ex) |
164 |
| { |
165 |
0
| throw new DocumentParseException(Tapestry.format(
|
166 |
| "RuleDrivenParser.unable-to-open-resource", |
167 |
| url), _documentLocation, ex); |
168 |
| } |
169 |
| |
170 |
32
| InputSource source = new InputSource(stream);
|
171 |
| |
172 |
32
| try
|
173 |
| { |
174 |
32
| _parser.parse(source, this);
|
175 |
| |
176 |
26
| stream.close();
|
177 |
| } |
178 |
| catch (Exception ex) |
179 |
| { |
180 |
6
| throw new DocumentParseException(Tapestry.format(
|
181 |
| "RuleDrivenParser.parse-error", |
182 |
| url, |
183 |
| ex.getMessage()), getLocation(), ex); |
184 |
| } |
185 |
| |
186 |
26
| if (LOG.isDebugEnabled())
|
187 |
0
| LOG.debug("Document parsed as: " + _documentObject);
|
188 |
| |
189 |
26
| return _documentObject;
|
190 |
| } |
191 |
| |
192 |
| |
193 |
| |
194 |
| |
195 |
| |
196 |
| |
197 |
138
| public Location getLocation()
|
198 |
| { |
199 |
138
| if (_locator == null)
|
200 |
0
| return null;
|
201 |
| |
202 |
138
| int line = _locator.getLineNumber();
|
203 |
138
| int column = _locator.getColumnNumber();
|
204 |
| |
205 |
138
| if (_line != line || _column != column)
|
206 |
| { |
207 |
126
| _location = null;
|
208 |
126
| _line = line;
|
209 |
126
| _column = column;
|
210 |
| } |
211 |
| |
212 |
138
| if (_location == null)
|
213 |
126
| _location = new LocationImpl(_documentLocation, _line, _column);
|
214 |
| |
215 |
138
| return _location;
|
216 |
| } |
217 |
| |
218 |
| |
219 |
| |
220 |
| |
221 |
| |
222 |
70
| public void push(Object object)
|
223 |
| { |
224 |
70
| if (_documentObject == null)
|
225 |
30
| _documentObject = object;
|
226 |
| |
227 |
70
| push(_objectStack, object, "object stack");
|
228 |
| } |
229 |
| |
230 |
| |
231 |
| |
232 |
| |
233 |
98
| public Object peek()
|
234 |
| { |
235 |
98
| return peek(_objectStack, 0);
|
236 |
| } |
237 |
| |
238 |
| |
239 |
| |
240 |
| |
241 |
| |
242 |
| |
243 |
0
| public Object peek(int depth)
|
244 |
| { |
245 |
0
| return peek(_objectStack, depth);
|
246 |
| } |
247 |
| |
248 |
| |
249 |
| |
250 |
| |
251 |
66
| public Object pop()
|
252 |
| { |
253 |
66
| return pop(_objectStack, "object stack");
|
254 |
| } |
255 |
| |
256 |
146
| private Object pop(List list, String name)
|
257 |
| { |
258 |
146
| Object result = list.remove(list.size() - 1);
|
259 |
| |
260 |
146
| if (LOG.isDebugEnabled())
|
261 |
0
| LOG.debug("Popped " + result + " off " + name + " (at " + getLocation() + ")");
|
262 |
| |
263 |
146
| return result;
|
264 |
| } |
265 |
| |
266 |
236
| private Object peek(List list, int depth)
|
267 |
| { |
268 |
236
| return list.get(list.size() - 1 - depth);
|
269 |
| } |
270 |
| |
271 |
158
| private void push(List list, Object object, String name)
|
272 |
| { |
273 |
158
| if (LOG.isDebugEnabled())
|
274 |
0
| LOG.debug("Pushing " + object + " onto " + name + " (at " + getLocation() + ")");
|
275 |
| |
276 |
158
| list.add(object);
|
277 |
| } |
278 |
| |
279 |
| |
280 |
| |
281 |
| |
282 |
| |
283 |
88
| protected void pushRule(IRule rule)
|
284 |
| { |
285 |
88
| push(_ruleStack, rule, "rule stack");
|
286 |
| } |
287 |
| |
288 |
| |
289 |
| |
290 |
| |
291 |
| |
292 |
138
| protected IRule peekRule()
|
293 |
| { |
294 |
138
| return (IRule) peek(_ruleStack, 0);
|
295 |
| } |
296 |
| |
297 |
80
| protected IRule popRule()
|
298 |
| { |
299 |
80
| return (IRule) pop(_ruleStack, "rule stack");
|
300 |
| } |
301 |
| |
302 |
384
| public void addRule(String localElementName, IRule rule)
|
303 |
| { |
304 |
384
| _ruleMap.put(localElementName, rule);
|
305 |
| } |
306 |
| |
307 |
| |
308 |
| |
309 |
| |
310 |
| |
311 |
| |
312 |
| |
313 |
| |
314 |
| |
315 |
| |
316 |
| |
317 |
| |
318 |
| |
319 |
| |
320 |
128
| public void registerEntity(String publicId, String entityPath)
|
321 |
| { |
322 |
128
| if (LOG.isDebugEnabled())
|
323 |
0
| LOG.debug("Registering " + publicId + " as " + entityPath);
|
324 |
| |
325 |
128
| if (_entities == null)
|
326 |
0
| _entities = new HashMap();
|
327 |
| |
328 |
128
| _entities.put(publicId, entityPath);
|
329 |
| } |
330 |
| |
331 |
88
| protected IRule selectRule(String localName, Attributes attributes)
|
332 |
| { |
333 |
88
| IRule rule = (IRule) _ruleMap.get(localName);
|
334 |
| |
335 |
88
| if (rule == null)
|
336 |
0
| throw new DocumentParseException(Tapestry.format(
|
337 |
| "RuleDrivenParser.no-rule-for-element", |
338 |
| localName), getLocation()); |
339 |
| |
340 |
88
| return rule;
|
341 |
| } |
342 |
| |
343 |
| |
344 |
| |
345 |
| |
346 |
| |
347 |
| |
348 |
| |
349 |
| |
350 |
32
| public void setDocumentLocator(Locator locator)
|
351 |
| { |
352 |
32
| _locator = locator;
|
353 |
| } |
354 |
| |
355 |
| |
356 |
| |
357 |
| |
358 |
| |
359 |
78
| public void characters(char[] ch, int start, int length) throws SAXException
|
360 |
| { |
361 |
78
| _contentBuffer.append(ch, start, length);
|
362 |
| } |
363 |
| |
364 |
| |
365 |
| |
366 |
| |
367 |
80
| public void endElement(String uri, String localName, String qName) throws SAXException
|
368 |
| { |
369 |
80
| fireContentRule();
|
370 |
| |
371 |
80
| _uri = uri;
|
372 |
80
| _localName = localName;
|
373 |
80
| _qName = qName;
|
374 |
| |
375 |
80
| popRule().endElement(this);
|
376 |
| } |
377 |
| |
378 |
| |
379 |
| |
380 |
| |
381 |
84
| public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException
|
382 |
| { |
383 |
| } |
384 |
| |
385 |
| |
386 |
| |
387 |
| |
388 |
| |
389 |
88
| public void startElement(String uri, String localName, String qName, Attributes attributes)
|
390 |
| throws SAXException |
391 |
| { |
392 |
88
| fireContentRule();
|
393 |
| |
394 |
88
| _uri = uri;
|
395 |
88
| _localName = localName;
|
396 |
88
| _qName = qName;
|
397 |
| |
398 |
88
| String name = extractName(uri, localName, qName);
|
399 |
| |
400 |
88
| IRule newRule = selectRule(name, attributes);
|
401 |
| |
402 |
88
| pushRule(newRule);
|
403 |
| |
404 |
88
| newRule.startElement(this, attributes);
|
405 |
| } |
406 |
| |
407 |
88
| private String extractName(String uri, String localName, String qName)
|
408 |
| { |
409 |
88
| return HiveMind.isBlank(localName) ? qName : localName;
|
410 |
| } |
411 |
| |
412 |
| |
413 |
| |
414 |
| |
415 |
| |
416 |
32
| protected synchronized SAXParser constructParser()
|
417 |
| { |
418 |
32
| if (_parserFactory == null)
|
419 |
| { |
420 |
2
| _parserFactory = SAXParserFactory.newInstance();
|
421 |
2
| configureParserFactory(_parserFactory);
|
422 |
| } |
423 |
| |
424 |
32
| try
|
425 |
| { |
426 |
32
| return _parserFactory.newSAXParser();
|
427 |
| } |
428 |
| catch (SAXException ex) |
429 |
| { |
430 |
0
| throw new ApplicationRuntimeException(ex);
|
431 |
| } |
432 |
| catch (ParserConfigurationException ex) |
433 |
| { |
434 |
0
| throw new ApplicationRuntimeException(ex);
|
435 |
| } |
436 |
| |
437 |
| } |
438 |
| |
439 |
| |
440 |
| |
441 |
| |
442 |
| |
443 |
| |
444 |
2
| protected void configureParserFactory(SAXParserFactory factory)
|
445 |
| { |
446 |
2
| factory.setValidating(true);
|
447 |
2
| factory.setNamespaceAware(false);
|
448 |
| } |
449 |
| |
450 |
| |
451 |
| |
452 |
| |
453 |
2
| public void error(SAXParseException ex) throws SAXException
|
454 |
| { |
455 |
2
| fatalError(ex);
|
456 |
| } |
457 |
| |
458 |
| |
459 |
| |
460 |
| |
461 |
2
| public void fatalError(SAXParseException ex) throws SAXException
|
462 |
| { |
463 |
| |
464 |
| |
465 |
| |
466 |
| |
467 |
2
| _parser = null;
|
468 |
| |
469 |
2
| throw ex;
|
470 |
| } |
471 |
| |
472 |
| |
473 |
| |
474 |
| |
475 |
0
| public void warning(SAXParseException ex) throws SAXException
|
476 |
| { |
477 |
0
| fatalError(ex);
|
478 |
| } |
479 |
| |
480 |
30
| public InputSource resolveEntity(String publicId, String systemId) throws SAXException
|
481 |
| { |
482 |
30
| String entityPath = null;
|
483 |
| |
484 |
30
| if (LOG.isDebugEnabled())
|
485 |
0
| LOG.debug("Attempting to resolve entity; publicId = " + publicId + " systemId = "
|
486 |
| + systemId); |
487 |
| |
488 |
30
| if (_entities != null)
|
489 |
30
| entityPath = (String) _entities.get(publicId);
|
490 |
| |
491 |
30
| if (entityPath == null)
|
492 |
| { |
493 |
0
| if (LOG.isDebugEnabled())
|
494 |
0
| LOG.debug("Entity not found, using " + systemId);
|
495 |
| |
496 |
0
| return null;
|
497 |
| } |
498 |
| |
499 |
30
| InputStream stream = getClass().getResourceAsStream(entityPath);
|
500 |
| |
501 |
30
| InputSource result = new InputSource(stream);
|
502 |
| |
503 |
30
| if (result != null && LOG.isDebugEnabled())
|
504 |
0
| LOG.debug("Resolved " + publicId + " as " + result + " (for " + entityPath + ")");
|
505 |
| |
506 |
30
| return result;
|
507 |
| } |
508 |
| |
509 |
| |
510 |
| |
511 |
| |
512 |
| |
513 |
| |
514 |
| |
515 |
36
| public void validate(String value, String pattern, String errorKey)
|
516 |
| throws DocumentParseException |
517 |
| { |
518 |
36
| if (_matcher == null)
|
519 |
20
| _matcher = new RegexpMatcher();
|
520 |
| |
521 |
36
| if (_matcher.matches(pattern, value))
|
522 |
32
| return;
|
523 |
| |
524 |
4
| throw new InvalidStringException(Tapestry.format(errorKey, value), value, getLocation());
|
525 |
| } |
526 |
| |
527 |
0
| public Resource getDocumentLocation()
|
528 |
| { |
529 |
0
| return _documentLocation;
|
530 |
| } |
531 |
| |
532 |
| |
533 |
| |
534 |
| |
535 |
| |
536 |
| |
537 |
| |
538 |
0
| public String getLocalName()
|
539 |
| { |
540 |
0
| return _localName;
|
541 |
| } |
542 |
| |
543 |
| |
544 |
| |
545 |
| |
546 |
| |
547 |
| |
548 |
| |
549 |
0
| public String getQName()
|
550 |
| { |
551 |
0
| return _qName;
|
552 |
| } |
553 |
| |
554 |
| |
555 |
| |
556 |
| |
557 |
| |
558 |
| |
559 |
| |
560 |
0
| public String getUri()
|
561 |
| { |
562 |
0
| return _uri;
|
563 |
| } |
564 |
| |
565 |
168
| private void fireContentRule()
|
566 |
| { |
567 |
168
| String content = _contentBuffer.toString();
|
568 |
168
| _contentBuffer.setLength(0);
|
569 |
| |
570 |
168
| if (!_ruleStack.isEmpty())
|
571 |
138
| peekRule().content(this, content);
|
572 |
| } |
573 |
| |
574 |
| } |