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
|
/*******************************************************************************
* Copyright (c) 2000, 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.help.internal.toc;
import java.io.*;
import com.ibm.icu.text.MessageFormat;
import java.util.ArrayList;
import javax.xml.parsers.*;
import org.eclipse.help.internal.*;
import org.eclipse.help.internal.util.*;
import org.xml.sax.*;
import org.xml.sax.helpers.*;
/**
* Used to create TocFile's Toc object from contributed toc xml file.
*/
class TocFileParser extends DefaultHandler {
protected TocBuilder builder;
protected FastStack elementStack;
protected TocFile tocFile;
static SAXParserFactory factory = SAXParserFactory.newInstance();
private static XMLParserPool parserPool = new XMLParserPool();
/**
* Constructor
*/
public TocFileParser(TocBuilder builder) {
super();
this.builder = builder;
}
/**
* @see ErrorHandler#error(SAXParseException)
*/
public void error(SAXParseException ex) throws SAXException {
HelpPlugin.logError("Error parsing Table of Contents file, " //$NON-NLS-1$
+ getErrorDetails(ex), null);
}
/**
* @see ErrorHandler#fatalError(SAXParseException)
*/
public void fatalError(SAXParseException ex) throws SAXException {
HelpPlugin.logError("Failed to parse Table of Contents file, " //$NON-NLS-1$
+ getErrorDetails(ex), ex);
}
protected String getErrorDetails(SAXParseException ex) {
String param0 = ex.getSystemId();
Integer param1 = new Integer(ex.getLineNumber());
Integer param2 = new Integer(ex.getColumnNumber());
String param3 = ex.getMessage();
String message = MessageFormat
.format(
"URL: {0} at line: {1,number,integer}, column: {2,number,integer}.\r\n{3}", //$NON-NLS-1$
new Object[] { param0, param1, param2, param3 });
return message;
}
/**
* Gets the toc
*/
public void parse(TocFile tocFile) {
this.tocFile = tocFile;
elementStack = new FastStack();
InputStream is = tocFile.getInputStream();
if (is == null)
return;
InputSource inputSource = new InputSource(is);
String file = "/" + tocFile.getPluginID() + "/" + tocFile.getHref(); //$NON-NLS-1$ //$NON-NLS-2$
inputSource.setSystemId(file);
try {
SAXParser parser = parserPool.obtainParser();
try {
parser.parse(inputSource, this);
is.close();
} finally {
parserPool.releaseParser(parser);
}
} catch (ParserConfigurationException pce) {
HelpPlugin.logError(
"SAXParser implementation could not be loaded.", pce); //$NON-NLS-1$
} catch (SAXException se) {
HelpPlugin.logError("Error loading Table of Contents file " + file //$NON-NLS-1$
+ ".", se); //$NON-NLS-1$
} catch (IOException ioe) {
HelpPlugin.logError("Error loading Table of Contents file " + file //$NON-NLS-1$
+ ".", ioe); //$NON-NLS-1$
}
}
/**
* @see ContentHandler#startElement(String, String, String, Attributes)
*/
public final void startElement(String namespaceURI, String localName,
String qName, Attributes atts) throws SAXException {
TocNode node = null;
if (qName.equals("toc")) { //$NON-NLS-1$
node = new Toc(tocFile, atts);
tocFile.setToc((Toc) node);
} else if (qName.equals("topic")) { //$NON-NLS-1$
node = new Topic(tocFile, atts);
} else if (qName.equals("link")) { //$NON-NLS-1$
node = new Link(tocFile, atts);
} else if (qName.equals("anchor")) { //$NON-NLS-1$
node = new Anchor(tocFile, atts);
} else if (qName.equals("filter")) { //$NON-NLS-1$
if (!elementStack.empty()) {
Object parent = elementStack.peek();
if (parent instanceof FilterableUAElement && atts != null) {
FilterableUAElement filterableNode = (FilterableUAElement)parent;
String name = atts.getValue("name"); //$NON-NLS-1$
String value = atts.getValue("value"); //$NON-NLS-1$
if (name != null && value != null) {
filterableNode.addFilter(name, value);
}
}
}
return;
} else
return; // perhaps throw some exception
if (!elementStack.empty())
((TocNode) elementStack.peek()).addChild(node);
elementStack.push(node);
// do any builder specific actions in the node
node.build(builder);
}
/**
* @see ContentHandler#endElement(String, String, String)
*/
public final void endElement(String namespaceURI, String localName,
String qName) throws SAXException {
if (qName.equals("toc") || qName.equals("topic") //$NON-NLS-1$ //$NON-NLS-2$
|| qName.equals("link") || qName.equals("anchor")) { //$NON-NLS-1$ //$NON-NLS-2$
elementStack.pop();
}
}
/**
* @see EntityResolver This method implementation prevents loading external
* entities instead of calling
* org.apache.xerces.parsers.SaxParser.setFeature("http://apache.org/xml/features/nonvalidating/load-external-dtd",false);
*/
public InputSource resolveEntity(String publicId, String systemId) {
InputSource source = new InputSource(new ByteArrayInputStream(
new byte[0]));
source.setPublicId(publicId);
source.setSystemId(systemId);
return source;
}
/**
* This class maintain pool of parsers that can be used for parsing TOC
* files. The parsers should be returned to the pool for reuse.
*/
static class XMLParserPool {
private ArrayList pool = new ArrayList();
SAXParser obtainParser() throws ParserConfigurationException,
SAXException {
SAXParser p;
int free = pool.size();
if (free > 0) {
p = (SAXParser) pool.remove(free - 1);
} else {
p = factory.newSAXParser();
}
return p;
}
void releaseParser(SAXParser parser) {
pool.add(parser);
}
}
}
|
