net.sourceforge.htmlunit.cyberneko.HTMLScanner Maven / Gradle / Ivy
Show all versions of neko-htmlunit Show documentation
/*
* Copyright 2002-2009 Andy Clark, Marc Guillemot
*
* 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 net.sourceforge.htmlunit.cyberneko;
import java.io.EOFException;
import java.io.FilterInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.io.UnsupportedEncodingException;
import java.net.URL;
import java.util.Locale;
import java.util.Stack;
import net.sourceforge.htmlunit.xerces.util.EncodingMap;
import net.sourceforge.htmlunit.xerces.util.NamespaceSupport;
import net.sourceforge.htmlunit.xerces.util.URI;
import net.sourceforge.htmlunit.xerces.util.XMLAttributesImpl;
import net.sourceforge.htmlunit.xerces.util.XMLStringBuffer;
import net.sourceforge.htmlunit.xerces.xni.Augmentations;
import net.sourceforge.htmlunit.xerces.xni.NamespaceContext;
import net.sourceforge.htmlunit.xerces.xni.QName;
import net.sourceforge.htmlunit.xerces.xni.XMLAttributes;
import net.sourceforge.htmlunit.xerces.xni.XMLDocumentHandler;
import net.sourceforge.htmlunit.xerces.xni.XMLLocator;
import net.sourceforge.htmlunit.xerces.xni.XMLString;
import net.sourceforge.htmlunit.xerces.xni.XNIException;
import net.sourceforge.htmlunit.xerces.xni.parser.XMLComponentManager;
import net.sourceforge.htmlunit.xerces.xni.parser.XMLConfigurationException;
import net.sourceforge.htmlunit.xerces.xni.parser.XMLDocumentScanner;
import net.sourceforge.htmlunit.xerces.xni.parser.XMLInputSource;
/**
* A simple HTML scanner. This scanner makes no attempt to balance tags
* or fix other problems in the source document — it just scans what
* it can and generates XNI document "events", ignoring errors of all
* kinds.
*
* This component recognizes the following features:
*
* - http://cyberneko.org/html/features/augmentations
*
- http://cyberneko.org/html/features/report-errors
*
- http://apache.org/xml/features/scanner/notify-char-refs
*
- http://apache.org/xml/features/scanner/notify-builtin-refs
*
- http://cyberneko.org/html/features/scanner/notify-builtin-refs
*
- http://cyberneko.org/html/features/scanner/fix-mswindows-refs
*
- http://cyberneko.org/html/features/scanner/script/strip-cdata-delims
*
- http://cyberneko.org/html/features/scanner/script/strip-comment-delims
*
- http://cyberneko.org/html/features/scanner/style/strip-cdata-delims
*
- http://cyberneko.org/html/features/scanner/style/strip-comment-delims
*
- http://cyberneko.org/html/features/scanner/ignore-specified-charset
*
- http://cyberneko.org/html/features/scanner/cdata-sections
*
- http://cyberneko.org/html/features/override-doctype
*
- http://cyberneko.org/html/features/insert-doctype
*
- http://cyberneko.org/html/features/parse-noscript-content
*
- http://cyberneko.org/html/features/scanner/allow-selfclosing-iframe
*
- http://cyberneko.org/html/features/scanner/allow-selfclosing-tags
*
*
* This component recognizes the following properties:
*
* - http://cyberneko.org/html/properties/names/elems
*
- http://cyberneko.org/html/properties/names/attrs
*
- http://cyberneko.org/html/properties/default-encoding
*
- http://cyberneko.org/html/properties/error-reporter
*
- http://cyberneko.org/html/properties/doctype/pubid
*
- http://cyberneko.org/html/properties/doctype/sysid
*
*
* @see HTMLElements
*
* @author Andy Clark
* @author Marc Guillemot
* @author Ahmed Ashour
*/
public class HTMLScanner
implements XMLDocumentScanner, XMLLocator, HTMLComponent {
//
// Constants
//
// doctype info: HTML 4.01 strict
/** HTML 4.01 strict public identifier ("-//W3C//DTD HTML 4.01//EN"). */
public static final String HTML_4_01_STRICT_PUBID = "-//W3C//DTD HTML 4.01//EN";
/** HTML 4.01 strict system identifier ("http://www.w3.org/TR/html4/strict.dtd"). */
public static final String HTML_4_01_STRICT_SYSID = "http://www.w3.org/TR/html4/strict.dtd";
// doctype info: HTML 4.01 loose
/** HTML 4.01 transitional public identifier ("-//W3C//DTD HTML 4.01 Transitional//EN"). */
public static final String HTML_4_01_TRANSITIONAL_PUBID = "-//W3C//DTD HTML 4.01 Transitional//EN";
/** HTML 4.01 transitional system identifier ("http://www.w3.org/TR/html4/loose.dtd"). */
public static final String HTML_4_01_TRANSITIONAL_SYSID = "http://www.w3.org/TR/html4/loose.dtd";
// doctype info: HTML 4.01 frameset
/** HTML 4.01 frameset public identifier ("-//W3C//DTD HTML 4.01 Frameset//EN"). */
public static final String HTML_4_01_FRAMESET_PUBID = "-//W3C//DTD HTML 4.01 Frameset//EN";
/** HTML 4.01 frameset system identifier ("http://www.w3.org/TR/html4/frameset.dtd"). */
public static final String HTML_4_01_FRAMESET_SYSID = "http://www.w3.org/TR/html4/frameset.dtd";
// features
/** Include infoset augmentations. */
protected static final String AUGMENTATIONS = "http://cyberneko.org/html/features/augmentations";
/** Report errors. */
protected static final String REPORT_ERRORS = "http://cyberneko.org/html/features/report-errors";
/** Notify character entity references (e.g.  ,  , etc). */
public static final String NOTIFY_CHAR_REFS = "http://apache.org/xml/features/scanner/notify-char-refs";
/**
* Notify handler of built-in entity references (e.g. &,
* <, etc).
*
* Note:
* This only applies to the five pre-defined XML general entities.
* Specifically, "amp", "lt", "gt", "quot", and "apos". This is done
* for compatibility with the Xerces feature.
*
* To be notified of the built-in entity references in HTML, set the
* http://cyberneko.org/html/features/scanner/notify-builtin-refs
* feature to true.
*/
public static final String NOTIFY_XML_BUILTIN_REFS = "http://apache.org/xml/features/scanner/notify-builtin-refs";
/**
* Notify handler of built-in entity references (e.g. &nobr;,
* ©, etc).
*
* Note:
* This includes the five pre-defined XML general entities.
*/
public static final String NOTIFY_HTML_BUILTIN_REFS = "http://cyberneko.org/html/features/scanner/notify-builtin-refs";
/** Fix Microsoft Windows® character entity references. */
public static final String FIX_MSWINDOWS_REFS = "http://cyberneko.org/html/features/scanner/fix-mswindows-refs";
/**
* Strip HTML comment delimiters ("<!−−" and
* "−−>") from SCRIPT tag contents.
*/
public static final String SCRIPT_STRIP_COMMENT_DELIMS = "http://cyberneko.org/html/features/scanner/script/strip-comment-delims";
/**
* Strip XHTML CDATA delimiters ("<![CDATA[" and "]]>") from
* SCRIPT tag contents.
*/
public static final String SCRIPT_STRIP_CDATA_DELIMS = "http://cyberneko.org/html/features/scanner/script/strip-cdata-delims";
/**
* Strip HTML comment delimiters ("<!−−" and
* "−−>") from STYLE tag contents.
*/
public static final String STYLE_STRIP_COMMENT_DELIMS = "http://cyberneko.org/html/features/scanner/style/strip-comment-delims";
/**
* Strip XHTML CDATA delimiters ("<![CDATA[" and "]]>") from
* STYLE tag contents.
*/
public static final String STYLE_STRIP_CDATA_DELIMS = "http://cyberneko.org/html/features/scanner/style/strip-cdata-delims";
/**
* Ignore specified charset found in the <meta equiv='Content-Type'
* content='text/html;charset=…'> tag or in the <?xml … encoding='…'> processing instruction
*/
public static final String IGNORE_SPECIFIED_CHARSET = "http://cyberneko.org/html/features/scanner/ignore-specified-charset";
/** Scan CDATA sections. */
public static final String CDATA_SECTIONS = "http://cyberneko.org/html/features/scanner/cdata-sections";
/** Override doctype declaration public and system identifiers. */
public static final String OVERRIDE_DOCTYPE = "http://cyberneko.org/html/features/override-doctype";
/** Insert document type declaration. */
public static final String INSERT_DOCTYPE = "http://cyberneko.org/html/features/insert-doctype";
/** Parse <noscript>...</noscript> content */
public static final String PARSE_NOSCRIPT_CONTENT = "http://cyberneko.org/html/features/parse-noscript-content";
/** Allows self closing <iframe/> tag */
public static final String ALLOW_SELFCLOSING_IFRAME = "http://cyberneko.org/html/features/scanner/allow-selfclosing-iframe";
/** Allows self closing tags e.g. <div/> (XHTML) */
public static final String ALLOW_SELFCLOSING_TAGS = "http://cyberneko.org/html/features/scanner/allow-selfclosing-tags";
/** Normalize attribute values. */
protected static final String NORMALIZE_ATTRIBUTES = "http://cyberneko.org/html/features/scanner/normalize-attrs";
/** Recognized features. */
private static final String[] RECOGNIZED_FEATURES = {
AUGMENTATIONS,
REPORT_ERRORS,
NOTIFY_CHAR_REFS,
NOTIFY_XML_BUILTIN_REFS,
NOTIFY_HTML_BUILTIN_REFS,
FIX_MSWINDOWS_REFS,
SCRIPT_STRIP_CDATA_DELIMS,
SCRIPT_STRIP_COMMENT_DELIMS,
STYLE_STRIP_CDATA_DELIMS,
STYLE_STRIP_COMMENT_DELIMS,
IGNORE_SPECIFIED_CHARSET,
CDATA_SECTIONS,
OVERRIDE_DOCTYPE,
INSERT_DOCTYPE,
NORMALIZE_ATTRIBUTES,
PARSE_NOSCRIPT_CONTENT,
ALLOW_SELFCLOSING_IFRAME,
ALLOW_SELFCLOSING_TAGS,
};
/** Recognized features defaults. */
private static final Boolean[] RECOGNIZED_FEATURES_DEFAULTS = {
null,
null,
Boolean.FALSE,
Boolean.FALSE,
Boolean.FALSE,
Boolean.FALSE,
Boolean.FALSE,
Boolean.FALSE,
Boolean.FALSE,
Boolean.FALSE,
Boolean.FALSE,
Boolean.FALSE,
Boolean.FALSE,
Boolean.FALSE,
Boolean.FALSE,
Boolean.TRUE,
Boolean.FALSE,
Boolean.FALSE,
};
// properties
/** Modify HTML element names: { "upper", "lower", "default" }. */
protected static final String NAMES_ELEMS = "http://cyberneko.org/html/properties/names/elems";
/** Modify HTML attribute names: { "upper", "lower", "default" }. */
protected static final String NAMES_ATTRS = "http://cyberneko.org/html/properties/names/attrs";
/** Default encoding. */
protected static final String DEFAULT_ENCODING = "http://cyberneko.org/html/properties/default-encoding";
/** Error reporter. */
protected static final String ERROR_REPORTER = "http://cyberneko.org/html/properties/error-reporter";
/** Doctype declaration public identifier. */
protected static final String DOCTYPE_PUBID = "http://cyberneko.org/html/properties/doctype/pubid";
/** Doctype declaration system identifier. */
protected static final String DOCTYPE_SYSID = "http://cyberneko.org/html/properties/doctype/sysid";
/** Recognized properties. */
private static final String[] RECOGNIZED_PROPERTIES = {
NAMES_ELEMS,
NAMES_ATTRS,
DEFAULT_ENCODING,
ERROR_REPORTER,
DOCTYPE_PUBID,
DOCTYPE_SYSID,
};
/** Recognized properties defaults. */
private static final Object[] RECOGNIZED_PROPERTIES_DEFAULTS = {
null,
null,
"Windows-1252",
null,
HTML_4_01_TRANSITIONAL_PUBID,
HTML_4_01_TRANSITIONAL_SYSID,
};
// states
/** State: content. */
protected static final short STATE_CONTENT = 0;
/** State: markup bracket. */
protected static final short STATE_MARKUP_BRACKET = 1;
/** State: start document. */
protected static final short STATE_START_DOCUMENT = 10;
/** State: end document. */
protected static final short STATE_END_DOCUMENT = 11;
// modify HTML names
/** Don't modify HTML names. */
protected static final short NAMES_NO_CHANGE = 0;
/** Uppercase HTML names. */
protected static final short NAMES_UPPERCASE = 1;
/** Lowercase HTML names. */
protected static final short NAMES_LOWERCASE = 2;
// defaults
/** Default buffer size. */
protected static final int DEFAULT_BUFFER_SIZE = 2048;
// debugging
/** Set to true to debug changes in the scanner. */
private static final boolean DEBUG_SCANNER = false;
/** Set to true to debug changes in the scanner state. */
private static final boolean DEBUG_SCANNER_STATE = false;
/** Set to true to debug the buffer. */
private static final boolean DEBUG_BUFFER = false;
/** Set to true to debug character encoding handling. */
private static final boolean DEBUG_CHARSET = false;
/** Set to true to debug callbacks. */
protected static final boolean DEBUG_CALLBACKS = false;
// static vars
/** Synthesized event info item. */
protected static final HTMLEventInfo SYNTHESIZED_ITEM =
new HTMLEventInfo.SynthesizedItem();
// features
/** Augmentations. */
protected boolean fAugmentations;
/** Report errors. */
protected boolean fReportErrors;
/** Notify character entity references. */
protected boolean fNotifyCharRefs;
/** Notify XML built-in general entity references. */
protected boolean fNotifyXmlBuiltinRefs;
/** Notify HTML built-in general entity references. */
protected boolean fNotifyHtmlBuiltinRefs;
/** Fix Microsoft Windows® character entity references. */
protected boolean fFixWindowsCharRefs;
/** Strip CDATA delimiters from SCRIPT tags. */
protected boolean fScriptStripCDATADelims;
/** Strip comment delimiters from SCRIPT tags. */
protected boolean fScriptStripCommentDelims;
/** Strip CDATA delimiters from STYLE tags. */
protected boolean fStyleStripCDATADelims;
/** Strip comment delimiters from STYLE tags. */
protected boolean fStyleStripCommentDelims;
/** Ignore specified character set. */
protected boolean fIgnoreSpecifiedCharset;
/** CDATA sections. */
protected boolean fCDATASections;
/** Override doctype declaration public and system identifiers. */
protected boolean fOverrideDoctype;
/** Insert document type declaration. */
protected boolean fInsertDoctype;
/** Normalize attribute values. */
protected boolean fNormalizeAttributes;
/** Parse noscript content. */
protected boolean fParseNoScriptContent;
/** Parse noframes content. */
protected boolean fParseNoFramesContent;
/** Allows self closing iframe tags. */
protected boolean fAllowSelfclosingIframe;
/** Allows self closing tags. */
protected boolean fAllowSelfclosingTags;
// properties
/** Modify HTML element names. */
protected short fNamesElems;
/** Modify HTML attribute names. */
protected short fNamesAttrs;
/** Default encoding. */
protected String fDefaultIANAEncoding;
/** Error reporter. */
protected HTMLErrorReporter fErrorReporter;
/** Doctype declaration public identifier. */
protected String fDoctypePubid;
/** Doctype declaration system identifier. */
protected String fDoctypeSysid;
// boundary locator information
/** Beginning line number. */
protected int fBeginLineNumber;
/** Beginning column number. */
protected int fBeginColumnNumber;
/** Beginning character offset in the file. */
protected int fBeginCharacterOffset;
/** Ending line number. */
protected int fEndLineNumber;
/** Ending column number. */
protected int fEndColumnNumber;
/** Ending character offset in the file. */
protected int fEndCharacterOffset;
// state
/** The playback byte stream. */
protected PlaybackInputStream fByteStream;
/** Current entity. */
protected CurrentEntity fCurrentEntity;
/** The current entity stack. */
protected final Stack fCurrentEntityStack = new Stack<>();
/** The current scanner. */
protected Scanner fScanner;
/** The current scanner state. */
protected short fScannerState;
/** The document handler. */
protected XMLDocumentHandler fDocumentHandler;
/** Auto-detected IANA encoding. */
protected String fIANAEncoding;
/** Auto-detected Java encoding. */
protected String fJavaEncoding;
/** True if the encoding matches "ISO-8859-*". */
protected boolean fIso8859Encoding;
/** Element count. */
protected int fElementCount;
/** Element depth. */
protected int fElementDepth;
// scanners
/** Content scanner. */
protected Scanner fContentScanner = new ContentScanner();
/**
* Special scanner used for elements whose content needs to be scanned
* as plain text, ignoring markup such as elements and entity references.
* For example: <SCRIPT> and <COMMENT>.
*/
protected final SpecialScanner fSpecialScanner = new SpecialScanner();
// temp vars
/** String buffer. */
protected final XMLStringBuffer fStringBuffer = new XMLStringBuffer(1024);
/** String buffer. */
private final XMLStringBuffer fStringBuffer2 = new XMLStringBuffer(1024);
/** Non-normalized attribute string buffer. */
private final XMLStringBuffer fNonNormAttr = new XMLStringBuffer(128);
/** Augmentations. */
private final HTMLAugmentations fInfosetAugs = new HTMLAugmentations();
/** Location infoset item. */
private final LocationItem fLocationItem = new LocationItem();
/** Single boolean array. */
private final boolean[] fSingleBoolean = { false };
private final char REPLACEMENT_CHARACTER = '\uFFFD'; // the � character
private final HTMLConfiguration htmlConfiguration_;
HTMLScanner(HTMLConfiguration htmlConfiguration) {
htmlConfiguration_ = htmlConfiguration;
}
//
// Public methods
//
/**
* Pushes an input source onto the current entity stack. This
* enables the scanner to transparently scan new content (e.g.
* the output written by an embedded script). At the end of the
* current entity, the scanner returns where it left off at the
* time this entity source was pushed.
*
* Note:
* This functionality is experimental at this time and is
* subject to change in future releases of NekoHTML.
*
* @param inputSource The new input source to start scanning.
* @see #evaluateInputSource(XMLInputSource)
*/
public void pushInputSource(XMLInputSource inputSource) {
final Reader reader = getReader(inputSource);
fCurrentEntityStack.push(fCurrentEntity);
final String encoding = inputSource.getEncoding();
final String publicId = inputSource.getPublicId();
final String baseSystemId = inputSource.getBaseSystemId();
final String literalSystemId = inputSource.getSystemId();
final String expandedSystemId = expandSystemId(literalSystemId, baseSystemId);
fCurrentEntity = new CurrentEntity(reader, encoding,
publicId, baseSystemId,
literalSystemId, expandedSystemId);
}
private Reader getReader(final XMLInputSource inputSource) {
final Reader reader = inputSource.getCharacterStream();
if (reader == null) {
try {
return new InputStreamReader(inputSource.getByteStream(), fJavaEncoding);
}
catch (final UnsupportedEncodingException e) {
// should not happen as this encoding is already used to parse the "main" source
}
}
return reader;
}
/**
* Immediately evaluates an input source and add the new content (e.g.
* the output written by an embedded script).
*
* @param inputSource The new input source to start evaluating.
* @see #pushInputSource(XMLInputSource)
*/
public void evaluateInputSource(XMLInputSource inputSource) {
final Scanner previousScanner = fScanner;
final short previousScannerState = fScannerState;
final CurrentEntity previousEntity = fCurrentEntity;
final Reader reader = getReader(inputSource);
final String encoding = inputSource.getEncoding();
final String publicId = inputSource.getPublicId();
final String baseSystemId = inputSource.getBaseSystemId();
final String literalSystemId = inputSource.getSystemId();
final String expandedSystemId = expandSystemId(literalSystemId, baseSystemId);
fCurrentEntity = new CurrentEntity(reader, encoding,
publicId, baseSystemId,
literalSystemId, expandedSystemId);
setScanner(fContentScanner);
setScannerState(STATE_CONTENT);
try {
do {
fScanner.scan(false);
} while (fScannerState != STATE_END_DOCUMENT);
}
catch (final IOException e) {
// ignore
}
setScanner(previousScanner);
setScannerState(previousScannerState);
fCurrentEntity = previousEntity;
}
/**
* Cleans up used resources. For example, if scanning is terminated
* early, then this method ensures all remaining open streams are
* closed.
*
* @param closeall Close all streams, including the original.
* This is used in cases when the application has
* opened the original document stream and should
* be responsible for closing it.
*/
public void cleanup(boolean closeall) {
final int size = fCurrentEntityStack.size();
if (size > 0) {
// current entity is not the original, so close it
if (fCurrentEntity != null) {
fCurrentEntity.closeQuietly();
}
// close remaining streams
for (int i = closeall ? 0 : 1; i < size; i++) {
fCurrentEntity = fCurrentEntityStack.pop();
fCurrentEntity.closeQuietly();
}
}
else if (closeall && fCurrentEntity != null) {
fCurrentEntity.closeQuietly();
}
}
//
// XMLLocator methods
//
/** Returns the encoding. */
@Override
public String getEncoding() {
return fCurrentEntity != null ? fCurrentEntity.encoding : null;
}
/** Returns the public identifier. */
@Override
public String getPublicId() {
return fCurrentEntity != null ? fCurrentEntity.publicId : null;
}
/** Returns the base system identifier. */
@Override
public String getBaseSystemId() {
return fCurrentEntity != null ? fCurrentEntity.baseSystemId : null;
}
/** Returns the literal system identifier. */
@Override
public String getLiteralSystemId() {
return fCurrentEntity != null ? fCurrentEntity.literalSystemId : null;
}
/** Returns the expanded system identifier. */
@Override
public String getExpandedSystemId() {
return fCurrentEntity != null ? fCurrentEntity.expandedSystemId : null;
}
/** Returns the current line number. */
@Override
public int getLineNumber() {
return fCurrentEntity != null ? fCurrentEntity.getLineNumber() : -1;
}
/** Returns the current column number. */
@Override
public int getColumnNumber() {
return fCurrentEntity != null ? fCurrentEntity.getColumnNumber() : -1;
}
/** Returns the XML version. */
@Override
public String getXMLVersion() {
return fCurrentEntity != null ? fCurrentEntity.version : null;
}
/** Returns the character offset. */
@Override
public int getCharacterOffset() {
return fCurrentEntity != null ? fCurrentEntity.getCharacterOffset() : -1;
}
//
// HTMLComponent methods
//
/** Returns the default state for a feature. */
@Override
public Boolean getFeatureDefault(String featureId) {
final int length = RECOGNIZED_FEATURES != null ? RECOGNIZED_FEATURES.length : 0;
for (int i = 0; i < length; i++) {
if (RECOGNIZED_FEATURES[i].equals(featureId)) {
return RECOGNIZED_FEATURES_DEFAULTS[i];
}
}
return null;
}
/** Returns the default state for a property. */
@Override
public Object getPropertyDefault(String propertyId) {
final int length = RECOGNIZED_PROPERTIES != null ? RECOGNIZED_PROPERTIES.length : 0;
for (int i = 0; i < length; i++) {
if (RECOGNIZED_PROPERTIES[i].equals(propertyId)) {
return RECOGNIZED_PROPERTIES_DEFAULTS[i];
}
}
return null;
}
//
// XMLComponent methods
//
/** Returns recognized features. */
@Override
public String[] getRecognizedFeatures() {
return RECOGNIZED_FEATURES;
}
/** Returns recognized properties. */
@Override
public String[] getRecognizedProperties() {
return RECOGNIZED_PROPERTIES;
}
/** Resets the component. */
@Override
public void reset(XMLComponentManager manager)
throws XMLConfigurationException {
// get features
fAugmentations = manager.getFeature(AUGMENTATIONS);
fReportErrors = manager.getFeature(REPORT_ERRORS);
fNotifyCharRefs = manager.getFeature(NOTIFY_CHAR_REFS);
fNotifyXmlBuiltinRefs = manager.getFeature(NOTIFY_XML_BUILTIN_REFS);
fNotifyHtmlBuiltinRefs = manager.getFeature(NOTIFY_HTML_BUILTIN_REFS);
fFixWindowsCharRefs = manager.getFeature(FIX_MSWINDOWS_REFS);
fScriptStripCDATADelims = manager.getFeature(SCRIPT_STRIP_CDATA_DELIMS);
fScriptStripCommentDelims = manager.getFeature(SCRIPT_STRIP_COMMENT_DELIMS);
fStyleStripCDATADelims = manager.getFeature(STYLE_STRIP_CDATA_DELIMS);
fStyleStripCommentDelims = manager.getFeature(STYLE_STRIP_COMMENT_DELIMS);
fIgnoreSpecifiedCharset = manager.getFeature(IGNORE_SPECIFIED_CHARSET);
fCDATASections = manager.getFeature(CDATA_SECTIONS);
fOverrideDoctype = manager.getFeature(OVERRIDE_DOCTYPE);
fInsertDoctype = manager.getFeature(INSERT_DOCTYPE);
fNormalizeAttributes = manager.getFeature(NORMALIZE_ATTRIBUTES);
fParseNoScriptContent = manager.getFeature(PARSE_NOSCRIPT_CONTENT);
fAllowSelfclosingIframe = manager.getFeature(ALLOW_SELFCLOSING_IFRAME);
fAllowSelfclosingTags = manager.getFeature(ALLOW_SELFCLOSING_TAGS);
// get properties
fNamesElems = getNamesValue(String.valueOf(manager.getProperty(NAMES_ELEMS)));
fNamesAttrs = getNamesValue(String.valueOf(manager.getProperty(NAMES_ATTRS)));
fDefaultIANAEncoding = String.valueOf(manager.getProperty(DEFAULT_ENCODING));
fErrorReporter = (HTMLErrorReporter)manager.getProperty(ERROR_REPORTER);
fDoctypePubid = String.valueOf(manager.getProperty(DOCTYPE_PUBID));
fDoctypeSysid = String.valueOf(manager.getProperty(DOCTYPE_SYSID));
}
/** Sets a feature. */
@Override
public void setFeature(final String featureId, final boolean state) {
if (featureId.equals(AUGMENTATIONS)) {
fAugmentations = state;
}
else if (featureId.equals(IGNORE_SPECIFIED_CHARSET)) {
fIgnoreSpecifiedCharset = state;
}
else if (featureId.equals(NOTIFY_CHAR_REFS)) {
fNotifyCharRefs = state;
}
else if (featureId.equals(NOTIFY_XML_BUILTIN_REFS)) {
fNotifyXmlBuiltinRefs = state;
}
else if (featureId.equals(NOTIFY_HTML_BUILTIN_REFS)) {
fNotifyHtmlBuiltinRefs = state;
}
else if (featureId.equals(FIX_MSWINDOWS_REFS)) {
fFixWindowsCharRefs = state;
}
else if (featureId.equals(SCRIPT_STRIP_CDATA_DELIMS)) {
fScriptStripCDATADelims = state;
}
else if (featureId.equals(SCRIPT_STRIP_COMMENT_DELIMS)) {
fScriptStripCommentDelims = state;
}
else if (featureId.equals(STYLE_STRIP_CDATA_DELIMS)) {
fStyleStripCDATADelims = state;
}
else if (featureId.equals(STYLE_STRIP_COMMENT_DELIMS)) {
fStyleStripCommentDelims = state;
}
else if (featureId.equals(PARSE_NOSCRIPT_CONTENT)) {
fParseNoScriptContent = state;
}
else if (featureId.equals(ALLOW_SELFCLOSING_IFRAME)) {
fAllowSelfclosingIframe = state;
}
else if (featureId.equals(ALLOW_SELFCLOSING_TAGS)) {
fAllowSelfclosingTags = state;
}
}
/** Sets a property. */
@Override
public void setProperty(String propertyId, Object value)
throws XMLConfigurationException {
if (propertyId.equals(NAMES_ELEMS)) {
fNamesElems = getNamesValue(String.valueOf(value));
return;
}
if (propertyId.equals(NAMES_ATTRS)) {
fNamesAttrs = getNamesValue(String.valueOf(value));
return;
}
if (propertyId.equals(DEFAULT_ENCODING)) {
fDefaultIANAEncoding = String.valueOf(value);
return;
}
}
//
// XMLDocumentScanner methods
//
/** Sets the input source. */
@Override
public void setInputSource(XMLInputSource source) throws IOException {
// reset state
fElementCount = 0;
fElementDepth = -1;
fByteStream = null;
fCurrentEntityStack.removeAllElements();
fBeginLineNumber = 1;
fBeginColumnNumber = 1;
fBeginCharacterOffset = 0;
fEndLineNumber = fBeginLineNumber;
fEndColumnNumber = fBeginColumnNumber;
fEndCharacterOffset = fBeginCharacterOffset;
// reset encoding information
fIANAEncoding = fDefaultIANAEncoding;
fJavaEncoding = fIANAEncoding;
// get location information
String encoding = source.getEncoding();
final String publicId = source.getPublicId();
final String baseSystemId = source.getBaseSystemId();
final String literalSystemId = source.getSystemId();
final String expandedSystemId = expandSystemId(literalSystemId, baseSystemId);
// open stream
Reader reader = source.getCharacterStream();
if (reader == null) {
InputStream inputStream = source.getByteStream();
if (inputStream == null) {
final URL url = new URL(expandedSystemId);
inputStream = url.openStream();
}
fByteStream = new PlaybackInputStream(inputStream);
final String[] encodings = new String[2];
if (encoding == null) {
fByteStream.detectEncoding(encodings);
}
else {
encodings[0] = encoding;
}
if (encodings[0] == null) {
encodings[0] = fDefaultIANAEncoding;
if (fReportErrors) {
fErrorReporter.reportWarning("HTML1000", null);
}
}
if (encodings[1] == null) {
encodings[1] = EncodingMap.getIANA2JavaMapping(encodings[0].toUpperCase(Locale.ROOT));
if (encodings[1] == null) {
encodings[1] = encodings[0];
if (fReportErrors) {
fErrorReporter.reportWarning("HTML1001", new Object[]{encodings[0]});
}
}
}
fIANAEncoding = encodings[0];
fJavaEncoding = encodings[1];
/* PATCH: Asgeir Asgeirsson */
fIso8859Encoding = fIANAEncoding == null
|| fIANAEncoding.toUpperCase(Locale.ROOT).startsWith("ISO-8859")
|| fIANAEncoding.equalsIgnoreCase(fDefaultIANAEncoding);
encoding = fIANAEncoding;
reader = new InputStreamReader(fByteStream, fJavaEncoding);
}
fCurrentEntity = new CurrentEntity(reader, encoding,
publicId, baseSystemId,
literalSystemId, expandedSystemId);
// set scanner and state
setScanner(fContentScanner);
setScannerState(STATE_START_DOCUMENT);
}
/** Scans the document. */
@Override
public boolean scanDocument(boolean complete) throws XNIException, IOException {
do {
if (!fScanner.scan(complete)) {
return false;
}
} while (complete);
return true;
}
/** Sets the document handler. */
@Override
public void setDocumentHandler(XMLDocumentHandler handler) {
fDocumentHandler = handler;
}
/** Returns the document handler. */
@Override
public XMLDocumentHandler getDocumentHandler() {
return fDocumentHandler;
}
//
// Protected static methods
//
// Returns the value of the specified attribute, ignoring case.
protected static String getValue(XMLAttributes attrs, String aname) {
if (attrs != null) {
final int length = attrs.getLength();
for (int i = 0; i < length; i++) {
if (attrs.getQName(i).equalsIgnoreCase(aname)) {
return attrs.getValue(i);
}
}
}
return null;
}
/**
* Expands a system id and returns the system id as a URI, if
* it can be expanded. A return value of null means that the
* identifier is already expanded. An exception thrown
* indicates a failure to expand the id.
*
* @param systemId The systemId to be expanded.
* @param baseSystemId baseSystemId
*
* @return Returns the URI string representing the expanded system
* identifier. A null value indicates that the given
* system identifier is already expanded.
*
*/
@SuppressWarnings("unused")
public static String expandSystemId(String systemId, String baseSystemId) {
// check for bad parameters id
if (systemId == null || systemId.length() == 0) {
return systemId;
}
// if id already expanded, return
try {
new URI(systemId);
return systemId;
}
catch (final URI.MalformedURIException e) {
// continue on...
}
// normalize id
final String id = fixURI(systemId);
// normalize base
URI base;
URI uri = null;
try {
if (baseSystemId == null || baseSystemId.length() == 0 ||
baseSystemId.equals(systemId)) {
String dir;
try {
dir = fixURI(System.getProperty("user.dir"))
// deal with blanks in paths; maybe we have to do better uri encoding here
.replaceAll(" ", "%20");
}
catch (final SecurityException se) {
dir = "";
}
if (!dir.endsWith("/")) {
dir = dir + "/";
}
base = new URI("file", "", dir, null, null);
}
else {
try {
base = new URI(fixURI(baseSystemId));
}
catch (final URI.MalformedURIException e) {
String dir;
try {
dir = fixURI(System.getProperty("user.dir"))
// deal with blanks in paths; maybe we have to do better uri encoding here
.replaceAll(" ", "%20");
}
catch (final SecurityException se) {
dir = "";
}
if (baseSystemId.indexOf(':') != -1) {
// for xml schemas we might have baseURI with
// a specified drive
base = new URI("file", "", fixURI(baseSystemId), null, null);
}
else {
if (!dir.endsWith("/")) {
dir = dir + "/";
}
dir = dir + fixURI(baseSystemId);
base = new URI("file", "", dir, null, null);
}
}
}
// expand id
uri = new URI(base, id);
}
catch (final URI.MalformedURIException e) {
// let it go through
}
if (uri == null) {
return systemId;
}
return uri.toString();
}
/**
* Fixes a platform dependent filename to standard URI form.
*
* @param str The string to fix.
*
* @return Returns the fixed URI string.
*/
protected static String fixURI(String str) {
// handle platform dependent strings
str = str.replace(java.io.File.separatorChar, '/');
// Windows fix
if (str.length() >= 2) {
final char ch1 = str.charAt(1);
// change "C:blah" to "/C:blah"
if (ch1 == ':') {
final char ch0 = String.valueOf(str.charAt(0)).toUpperCase(Locale.ROOT).charAt(0);
if (ch0 >= 'A' && ch0 <= 'Z') {
str = "/" + str;
}
}
// change "//blah" to "file://blah"
else if (ch1 == '/' && str.charAt(0) == '/') {
str = "file:" + str;
}
}
// done
return str;
}
// Modifies the given name based on the specified mode.
protected static String modifyName(String name, short mode) {
switch (mode) {
case NAMES_UPPERCASE: return name.toUpperCase(Locale.ROOT);
case NAMES_LOWERCASE: return name.toLowerCase(Locale.ROOT);
}
return name;
}
// Converts HTML names string value to constant value.
//
// @see #NAMES_NO_CHANGE
// @see #NAMES_LOWERCASE
// @see #NAMES_UPPERCASE
protected static short getNamesValue(String value) {
if (value.equals("lower")) {
return NAMES_LOWERCASE;
}
if (value.equals("upper")) {
return NAMES_UPPERCASE;
}
return NAMES_NO_CHANGE;
}
// Fixes Microsoft Windows® specific characters.
//
// Details about this common problem can be found at
// http://www.cs.tut.fi/~jkorpela/www/windows-chars.html
protected int fixWindowsCharacter(int origChar) {
/* PATCH: Asgeir Asgeirsson */
switch(origChar) {
case 130: return 8218;
case 131: return 402;
case 132: return 8222;
case 133: return 8230;
case 134: return 8224;
case 135: return 8225;
case 136: return 710;
case 137: return 8240;
case 138: return 352;
case 139: return 8249;
case 140: return 338;
case 145: return 8216;
case 146: return 8217;
case 147: return 8220;
case 148: return 8221;
case 149: return 8226;
case 150: return 8211;
case 151: return 8212;
case 152: return 732;
case 153: return 8482;
case 154: return 353;
case 155: return 8250;
case 156: return 339;
case 159: return 376;
}
return origChar;
}
//
// Protected methods
//
// debugging
// Sets the scanner.
protected void setScanner(Scanner scanner) {
fScanner = scanner;
if (DEBUG_SCANNER) {
System.out.print("$$$ setScanner(");
System.out.print(scanner!=null?scanner.getClass().getName():"null");
System.out.println(");");
}
}
// Sets the scanner state.
protected void setScannerState(short state) {
fScannerState = state;
if (DEBUG_SCANNER_STATE) {
System.out.print("$$$ setScannerState(");
switch (fScannerState) {
case STATE_CONTENT: { System.out.print("STATE_CONTENT"); break; }
case STATE_MARKUP_BRACKET: { System.out.print("STATE_MARKUP_BRACKET"); break; }
case STATE_START_DOCUMENT: { System.out.print("STATE_START_DOCUMENT"); break; }
case STATE_END_DOCUMENT: { System.out.print("STATE_END_DOCUMENT"); break; }
}
System.out.println(");");
}
}
// scanning
// Scans a DOCTYPE line.
protected void scanDoctype() throws IOException {
String root = null;
String pubid = null;
String sysid = null;
if (skipSpaces()) {
root = scanName(true);
if (root == null) {
if (fReportErrors) {
fErrorReporter.reportError("HTML1014", null);
}
}
else {
root = modifyName(root, fNamesElems);
}
if (skipSpaces()) {
if (skip("PUBLIC", false)) {
skipSpaces();
pubid = scanLiteral();
if (skipSpaces()) {
sysid = scanLiteral();
}
}
else if (skip("SYSTEM", false)) {
skipSpaces();
sysid = scanLiteral();
}
}
}
int c;
while ((c = fCurrentEntity.read()) != -1) {
if (c == '<') {
fCurrentEntity.rewind();
break;
}
if (c == '>') {
break;
}
if (c == '[') {
skipMarkup(true);
break;
}
}
if (fDocumentHandler != null) {
if (fOverrideDoctype) {
pubid = fDoctypePubid;
sysid = fDoctypeSysid;
}
fEndLineNumber = fCurrentEntity.getLineNumber();
fEndColumnNumber = fCurrentEntity.getColumnNumber();
fEndCharacterOffset = fCurrentEntity.getCharacterOffset();
fDocumentHandler.doctypeDecl(root, pubid, sysid, locationAugs());
}
}
// Scans a quoted literal.
protected String scanLiteral() throws IOException {
final int quote = fCurrentEntity.read();
if (quote == '\'' || quote == '"') {
final StringBuilder str = new StringBuilder();
int c;
while ((c = fCurrentEntity.read()) != -1) {
if (c == quote) {
break;
}
if (c == '\r' || c == '\n') {
fCurrentEntity.rewind();
// NOTE: This collapses newlines to a single space.
// [Q] Is this the right thing to do here? -Ac
skipNewlines();
str.append(' ');
}
else if (c == '<') {
fCurrentEntity.rewind();
break;
}
else {
appendChar(str, c, null);
}
}
if (c == -1) {
if (fReportErrors) {
fErrorReporter.reportError("HTML1007", null);
}
throw new EOFException();
}
return str.toString();
}
fCurrentEntity.rewind();
return null;
}
// Scans a name.
protected String scanName(final boolean strict) throws IOException {
if (DEBUG_BUFFER) {
fCurrentEntity.debugBufferIfNeeded("(scanName: ");
}
if (fCurrentEntity.offset == fCurrentEntity.length) {
if (fCurrentEntity.load(0) == -1) {
if (DEBUG_BUFFER) {
fCurrentEntity.debugBufferIfNeeded(")scanName: ");
}
return null;
}
}
int offset = fCurrentEntity.offset;
while (true) {
while (fCurrentEntity.hasNext()) {
final char c = fCurrentEntity.getNextChar();
if ((strict && (!Character.isLetterOrDigit(c) && c != '-' && c != '.' && c != ':' && c != '_'))
|| (!strict && (Character.isWhitespace(c) || c == '=' || c == '/' || c == '>'))) {
fCurrentEntity.rewind();
break;
}
}
if (fCurrentEntity.offset == fCurrentEntity.length) {
final int length = fCurrentEntity.length - offset;
System.arraycopy(fCurrentEntity.buffer, offset, fCurrentEntity.buffer, 0, length);
final int count = fCurrentEntity.load(length);
offset = 0;
if (count == -1) {
break;
}
}
else {
break;
}
}
final int length = fCurrentEntity.offset - offset;
final String name = length > 0 ? new String(fCurrentEntity.buffer, offset, length) : null;
if (DEBUG_BUFFER) {
fCurrentEntity.debugBufferIfNeeded(")scanName: ", " -> \"" + name + '"');
}
return name;
}
// Scans an entity reference.
protected int scanEntityRef(final XMLStringBuffer str, final boolean content)
throws IOException {
str.clear();
str.append('&');
// use readPreservingBufferContent inside this method to be sure we can rewind
int nextChar = readPreservingBufferContent();
if (nextChar == -1) { return returnEntityRefString(str, content); }
str.append((char) nextChar);
HTMLEntitiesParser parser = new HTMLEntitiesParser();
if ('#' == nextChar) {
nextChar = readPreservingBufferContent();
if (nextChar != -1) {
str.append((char) nextChar);
}
while(nextChar != -1 && parser.parseNumeric(nextChar)) {
nextChar = readPreservingBufferContent();
if (nextChar != -1) {
str.append((char) nextChar);
}
}
final String match = parser.getMatch();
if (match == null) {
final String consumed = str.toString();
fCurrentEntity.rewind(consumed.length() - 1);
str.clear();
str.append('&');
}
else {
fCurrentEntity.rewind(parser.getRewindCount());
str.clear();
str.append(match);
}
return returnEntityRefString(str, content);
}
while(nextChar != -1 && parser.parse(nextChar)) {
nextChar = readPreservingBufferContent();
if (nextChar != -1) {
str.append((char) nextChar);
}
}
final String match = parser.getMatch();
if (match == null) {
final String consumed = str.toString();
fCurrentEntity.rewind(consumed.length() - 1);
str.clear();
str.append('&');
}
else {
fCurrentEntity.rewind(parser.getRewindCount());
if (parser.endsWithSemicolon()) {
str.clear();
str.append(match);
}
else {
if (fReportErrors) {
fErrorReporter.reportWarning("HTML1004", null);
}
if (content) {
str.clear();
str.append(match);
}
else {
// look ahead
final String consumed = str.toString();
final int matchLength = parser.getMatchLength() + 1;
if (matchLength < consumed.length()) {
nextChar = consumed.charAt(matchLength);
if ('=' == nextChar
|| '0' <= nextChar && nextChar <= '9'
|| 'A' <= nextChar && nextChar <= 'Z'
|| 'a' <= nextChar && nextChar <= 'z') {
str.clear();
str.append(consumed.substring(0, parser.getMatchLength() + 1));
}
else {
str.clear();
str.append(match);
}
}
else {
str.clear();
str.append(match);
}
}
}
}
return returnEntityRefString(str, content);
}
private int returnEntityRefString(final XMLStringBuffer str, final boolean content) {
if (content && fDocumentHandler != null && fElementCount >= fElementDepth) {
fEndLineNumber = fCurrentEntity.getLineNumber();
fEndColumnNumber = fCurrentEntity.getColumnNumber();
fEndCharacterOffset = fCurrentEntity.getCharacterOffset();
fDocumentHandler.characters(str, locationAugs());
}
return -1;
}
// Returns true if the specified text is present and is skipped.
protected boolean skip(String s, boolean caseSensitive) throws IOException {
final int length = s != null ? s.length() : 0;
for (int i = 0; i < length; i++) {
if (fCurrentEntity.offset == fCurrentEntity.length) {
System.arraycopy(fCurrentEntity.buffer, fCurrentEntity.offset - i, fCurrentEntity.buffer, 0, i);
if (fCurrentEntity.load(i) == -1) {
fCurrentEntity.offset = 0;
return false;
}
}
char c0 = s.charAt(i);
char c1 = fCurrentEntity.getNextChar();
if (!caseSensitive) {
c0 = String.valueOf(c0).toUpperCase(Locale.ROOT).charAt(0);
c1 = String.valueOf(c1).toUpperCase(Locale.ROOT).charAt(0);
}
if (c0 != c1) {
fCurrentEntity.rewind(i + 1);
return false;
}
}
return true;
}
// Skips markup.
protected boolean skipMarkup(boolean balance) throws IOException {
if (DEBUG_BUFFER) {
fCurrentEntity.debugBufferIfNeeded("(skipMarkup: ");
}
int depth = 1;
boolean slashgt = false;
OUTER: while (true) {
if (fCurrentEntity.offset == fCurrentEntity.length) {
if (fCurrentEntity.load(0) == -1) {
break OUTER;
}
}
while (fCurrentEntity.hasNext()) {
char c = fCurrentEntity.getNextChar();
if (balance && c == '<') {
depth++;
}
else if (c == '>') {
depth--;
if (depth == 0) {
break OUTER;
}
}
else if (c == '/') {
if (fCurrentEntity.offset == fCurrentEntity.length) {
if (fCurrentEntity.load(0) == -1) {
break OUTER;
}
}
c = fCurrentEntity.getNextChar();
if (c == '>') {
slashgt = true;
depth--;
if (depth == 0) {
break OUTER;
}
}
else {
fCurrentEntity.rewind();
}
}
else if (c == '\r' || c == '\n') {
fCurrentEntity.rewind();
skipNewlines();
}
}
}
if (DEBUG_BUFFER) {
fCurrentEntity.debugBufferIfNeeded(")skipMarkup: ", " -> " + slashgt);
}
return slashgt;
}
// Skips whitespace.
protected boolean skipSpaces() throws IOException {
if (DEBUG_BUFFER) {
fCurrentEntity.debugBufferIfNeeded("(skipSpaces: ");
}
boolean spaces = false;
while (true) {
if (fCurrentEntity.offset == fCurrentEntity.length) {
if (fCurrentEntity.load(0) == -1) {
break;
}
}
final char c = fCurrentEntity.getNextChar();
if (!Character.isWhitespace(c)) {
fCurrentEntity.rewind();
break;
}
spaces = true;
if (c == '\r' || c == '\n') {
fCurrentEntity.rewind();
skipNewlines();
continue;
}
}
if (DEBUG_BUFFER) {
fCurrentEntity.debugBufferIfNeeded(")skipSpaces: ", " -> " + spaces);
}
return spaces;
}
// Skips newlines and returns the number of newlines skipped.
protected int skipNewlines() throws IOException {
if (DEBUG_BUFFER) {
fCurrentEntity.debugBufferIfNeeded("(skipNewlines: ");
}
if (!fCurrentEntity.hasNext()) {
if (fCurrentEntity.load(0) == -1) {
if (DEBUG_BUFFER) {
fCurrentEntity.debugBufferIfNeeded(")skipNewlines: ");
}
return 0;
}
}
char c = fCurrentEntity.getCurrentChar();
int newlines = 0;
if (c == '\n' || c == '\r') {
do {
c = fCurrentEntity.getNextChar();
if (c == '\r') {
newlines++;
if (fCurrentEntity.offset == fCurrentEntity.length) {
fCurrentEntity.offset = newlines;
if (fCurrentEntity.load(newlines) == -1) {
break;
}
}
if (fCurrentEntity.getCurrentChar() == '\n') {
fCurrentEntity.offset++;
fCurrentEntity.characterOffset_++;
}
}
else if (c == '\n') {
newlines++;
if (fCurrentEntity.offset == fCurrentEntity.length) {
fCurrentEntity.offset = newlines;
if (fCurrentEntity.load(newlines) == -1) {
break;
}
}
}
else {
fCurrentEntity.rewind();
break;
}
} while (fCurrentEntity.offset < fCurrentEntity.length - 1);
fCurrentEntity.incLine(newlines);
}
if (DEBUG_BUFFER) {
fCurrentEntity.debugBufferIfNeeded(")skipNewlines: ", " -> " + newlines);
}
return newlines;
}
// infoset utility methods
// Returns an augmentations object with a location item added.
protected final Augmentations locationAugs() {
HTMLAugmentations augs = null;
if (fAugmentations) {
fLocationItem.setValues(fBeginLineNumber, fBeginColumnNumber,
fBeginCharacterOffset, fEndLineNumber,
fEndColumnNumber, fEndCharacterOffset);
augs = fInfosetAugs;
augs.clear();
augs.put(AUGMENTATIONS, fLocationItem);
}
return augs;
}
// Returns an augmentations object with a synthesized item added.
protected final Augmentations synthesizedAugs() {
HTMLAugmentations augs = null;
if (fAugmentations) {
augs = fInfosetAugs;
augs.clear();
augs.put(AUGMENTATIONS, SYNTHESIZED_ITEM);
}
return augs;
}
//
// Protected static methods
//
// Returns true if the name is a built-in XML general entity reference.
protected static boolean builtinXmlRef(String name) {
return name.equals("amp") || name.equals("lt") || name.equals("gt") ||
name.equals("quot") || name.equals("apos");
}
//
// Private methods
//
/**
* Append a character to an XMLStringBuffer. The character is an int value, and can either be a
* single UTF-16 character or a supplementary character represented by two UTF-16 code points.
*
* @param str The XMLStringBuffer to append to.
* @param value The character value.
* @param name to be used for error reporting
*/
private void appendChar( XMLStringBuffer str, int value, String name )
{
if ( value > Character.MAX_VALUE )
{
try {
final char[] chars = Character.toChars( value );
str.append( chars, 0, chars.length );
}
catch (final IllegalArgumentException e) { // when value is not valid as UTF-16
if (fReportErrors) {
if (name == null) {
name = "&#" + value + ';';
}
fErrorReporter.reportError("HTML1005", new Object[]{name});
}
str.append(REPLACEMENT_CHARACTER);
}
}
else
{
str.append( (char) value );
}
}
/**
* Append a character to a StringBuffer. The character is an int value, and can either be a
* single UTF-16 character or a supplementary character represented by two UTF-16 code points.
*
* @param str The StringBuffer to append to.
* @param value The character value.
* @param name to be used for error reporting
*/
private void appendChar( StringBuilder str, int value, String name )
{
if ( value > Character.MAX_VALUE )
{
try {
final char[] chars = Character.toChars( value );
str.append( chars, 0, chars.length );
}
catch (final IllegalArgumentException e) { // when value is not valid as UTF-16
if (fReportErrors) {
if (name == null) {
name = "&#" + value + ';';
}
fErrorReporter.reportError("HTML1005", new Object[]{name});
}
fStringBuffer.append(REPLACEMENT_CHARACTER);
}
}
else
{
str.append( (char) value );
}
}
//
// Interfaces
//
/**
* Basic scanner interface.
*
* @author Andy Clark
*/
public interface Scanner {
//
// Scanner methods
//
/**
* Scans part of the document. This interface allows scanning to
* be performed in a pulling manner.
*
* @param complete True if the scanner should not return until
* scanning is complete.
*
* @return True if additional scanning is required.
*
* @throws IOException Thrown if I/O error occurs.
*/
boolean scan(boolean complete) throws IOException;
}
//
// Classes
//
/**
* Current entity.
*
* @author Andy Clark
*/
public static class CurrentEntity {
//
// Data
//
/** Character stream. */
private Reader stream_;
/** Encoding. */
private String encoding;
/** Public identifier. */
public final String publicId;
/** Base system identifier. */
public final String baseSystemId;
/** Literal system identifier. */
public final String literalSystemId;
/** Expanded system identifier. */
public final String expandedSystemId;
/** XML version. */
public final String version = "1.0";
/** Line number. */
private int lineNumber_ = 1;
/** Column number. */
private int columnNumber_ = 1;
/** Character offset in the file. */
public int characterOffset_ = 0;
// buffer
/** Character buffer. */
public char[] buffer = new char[DEFAULT_BUFFER_SIZE];
/** Offset into character buffer. */
public int offset = 0;
/** Length of characters read into character buffer. */
public int length = 0;
private boolean endReached_ = false;
//
// Constructors
//
// Constructs an entity from the specified stream.
public CurrentEntity(Reader stream, String encoding,
String publicId, String baseSystemId,
String literalSystemId, String expandedSystemId) {
stream_ = stream;
this.encoding = encoding;
this.publicId = publicId;
this.baseSystemId = baseSystemId;
this.literalSystemId = literalSystemId;
this.expandedSystemId = expandedSystemId;
}
private char getCurrentChar() {
return buffer[offset];
}
/**
* @return the current character and moves to next one.
*/
private char getNextChar() {
characterOffset_++;
columnNumber_++;
return buffer[offset++];
}
private void closeQuietly() {
try {
stream_.close();
}
catch (final IOException e) {
// ignore
}
}
/**
* Indicates if there are characters left.
*/
boolean hasNext() {
return offset < length;
}
/**
* Loads a new chunk of data into the buffer and returns the number of
* characters loaded or -1 if no additional characters were loaded.
*
* @param loadOffset The offset at which new characters should be loaded.
* @return count
* @throws IOException in case of io problems
*/
protected int load(int loadOffset) throws IOException {
if (DEBUG_BUFFER) {
debugBufferIfNeeded("(load: ");
}
// resize buffer, if needed
if (loadOffset == buffer.length) {
final int adjust = buffer.length / 4;
final char[] array = new char[buffer.length + adjust];
System.arraycopy(buffer, 0, array, 0, length);
buffer = array;
}
// read a block of characters
final int count = stream_.read(buffer, loadOffset, buffer.length - loadOffset);
if (count == -1) {
endReached_ = true;
}
length = count != -1 ? count + loadOffset : loadOffset;
this.offset = loadOffset;
if (DEBUG_BUFFER) {
debugBufferIfNeeded(")load: ", " -> " + count);
}
return count;
}
// Reads a single character.
protected int read() throws IOException {
if (DEBUG_BUFFER) {
debugBufferIfNeeded("(read: ");
}
if (offset == length) {
if (endReached_) {
return -1;
}
if (load(0) == -1) {
if (DEBUG_BUFFER) {
System.out.println(")read: -> -1");
}
return -1;
}
}
final char c = buffer[offset++];
characterOffset_++;
columnNumber_++;
if (DEBUG_BUFFER) {
debugBufferIfNeeded(")read: ", " -> " + c);
}
return c;
}
/** Prints the contents of the character buffer to standard out. */
private void debugBufferIfNeeded(final String prefix) {
debugBufferIfNeeded(prefix, "");
}
/** Prints the contents of the character buffer to standard out. */
private void debugBufferIfNeeded(final String prefix, final String suffix) {
if (DEBUG_BUFFER) {
System.out.print(prefix);
System.out.print('[');
System.out.print(length);
System.out.print(' ');
System.out.print(offset);
if (length > 0) {
System.out.print(" \"");
for (int i = 0; i < length; i++) {
if (i == offset) {
System.out.print('^');
}
final char c = buffer[i];
switch (c) {
case '\r': {
System.out.print("\\r");
break;
}
case '\n': {
System.out.print("\\n");
break;
}
case '\t': {
System.out.print("\\t");
break;
}
case '"': {
System.out.print("\\\"");
break;
}
default: {
System.out.print(c);
}
}
}
if (offset == length) {
System.out.print('^');
}
System.out.print('"');
}
System.out.print(']');
System.out.print(suffix);
System.out.println();
}
}
private void setStream(final InputStreamReader inputStreamReader) {
stream_ = inputStreamReader;
offset = length = characterOffset_ = 0;
lineNumber_ = columnNumber_ = 1;
encoding = inputStreamReader.getEncoding();
}
/**
* Goes back, cancelling the effect of the previous read() call.
*/
private void rewind() {
offset--;
characterOffset_--;
columnNumber_--;
}
private void rewind(int i) {
offset -= i;
characterOffset_ -= i;
columnNumber_ -= i;
}
private void incLine() {
lineNumber_++;
columnNumber_ = 1;
}
private void incLine(int nbLines) {
lineNumber_ += nbLines;
columnNumber_ = 1;
}
public int getLineNumber() {
return lineNumber_;
}
private void resetBuffer(final XMLStringBuffer xmlBuffer, final int lineNumber,
final int columnNumber, final int characterOffset) {
lineNumber_ = lineNumber;
columnNumber_ = columnNumber;
this.characterOffset_ = characterOffset;
this.buffer = xmlBuffer.ch;
this.offset = xmlBuffer.offset;
this.length = xmlBuffer.length;
}
private int getColumnNumber() {
return columnNumber_;
}
private void restorePosition(int originalOffset,
int originalColumnNumber, int originalCharacterOffset) {
this.offset = originalOffset;
this.columnNumber_ = originalColumnNumber;
this.characterOffset_ = originalCharacterOffset;
}
private int getCharacterOffset() {
return characterOffset_;
}
}
/**
* The primary HTML document scanner.
*
* @author Andy Clark
*/
public class ContentScanner
implements Scanner {
//
// Data
//
// temp vars
/** A qualified name. */
private final QName fQName = new QName();
/** Attributes. */
private final XMLAttributesImpl fAttributes = new XMLAttributesImpl();
//
// Scanner methods
//
/** Scan. */
@Override
public boolean scan(boolean complete) throws IOException {
boolean next;
do {
try {
next = false;
switch (fScannerState) {
case STATE_CONTENT: {
fBeginLineNumber = fCurrentEntity.getLineNumber();
fBeginColumnNumber = fCurrentEntity.getColumnNumber();
fBeginCharacterOffset = fCurrentEntity.getCharacterOffset();
final int c = fCurrentEntity.read();
if (c == -1) {
throw new EOFException();
}
if (c == '<') {
setScannerState(STATE_MARKUP_BRACKET);
next = true;
}
else if (c == '&') {
scanEntityRef(fStringBuffer, true);
}
else {
fCurrentEntity.rewind();
scanCharacters();
}
break;
}
case STATE_MARKUP_BRACKET: {
final int c = fCurrentEntity.read();
if (c == -1) {
if (fReportErrors) {
fErrorReporter.reportError("HTML1003", null);
}
if (fDocumentHandler != null && fElementCount >= fElementDepth) {
fStringBuffer.clear();
fStringBuffer.append('<');
fDocumentHandler.characters(fStringBuffer, null);
}
throw new EOFException();
}
if (c == '!') {
// process some strange self closing comments first
if (skip("--->", false)
|| skip("-->", false)
|| skip("->", false)
|| skip(">", false)) {
fEndLineNumber = fCurrentEntity.getLineNumber();
fEndColumnNumber = fCurrentEntity.getColumnNumber();
fEndCharacterOffset = fCurrentEntity.getCharacterOffset();
fDocumentHandler.comment(new XMLStringBuffer(), locationAugs());
}
else if (skip("--", false)) {
scanComment();
}
else if (skip("[CDATA[", false)) {
scanCDATA();
}
else if (skip("DOCTYPE", false)) {
scanDoctype();
}
else {
if (fReportErrors) {
fErrorReporter.reportError("HTML1002", null);
}
skipMarkup(true);
}
}
else if (c == '?') {
scanPI();
}
else if (c == '/') {
scanEndElement();
}
else {
fCurrentEntity.rewind();
fElementCount++;
fSingleBoolean[0] = false;
final String ename = scanStartElement(fSingleBoolean);
final String enameLC = ename == null ? null : ename.toLowerCase(Locale.ROOT);
fBeginLineNumber = fCurrentEntity.getLineNumber();
fBeginColumnNumber = fCurrentEntity.getColumnNumber();
fBeginCharacterOffset = fCurrentEntity.getCharacterOffset();
if ("script".equals(enameLC)) {
scanScriptContent();
}
else if (!fAllowSelfclosingTags && !fAllowSelfclosingIframe && "iframe".equals(enameLC)) {
scanUntilEndTag("iframe");
}
else if (!fParseNoScriptContent && "noscript".equals(enameLC)) {
scanUntilEndTag("noscript");
}
else if (!fParseNoFramesContent && "noframes".equals(enameLC)) {
scanUntilEndTag("noframes");
}
else if (ename != null && !fSingleBoolean[0]
&& htmlConfiguration_.htmlElements_.getElement(enameLC).isSpecial()
&& (!ename.equalsIgnoreCase("TITLE") || isEnded(enameLC))) {
if (ename.equalsIgnoreCase("PLAINTEXT")) {
setScanner(new PlainTextScanner());
}
else {
setScanner(fSpecialScanner.setElementName(ename));
setScannerState(STATE_CONTENT);
}
return true;
}
}
setScannerState(STATE_CONTENT);
break;
}
case STATE_START_DOCUMENT: {
if (fDocumentHandler != null && fElementCount >= fElementDepth) {
if (DEBUG_CALLBACKS) {
System.out.println("startDocument()");
}
final XMLLocator locator = HTMLScanner.this;
final String encoding = fIANAEncoding;
final Augmentations augs = locationAugs();
final NamespaceContext nscontext = new NamespaceSupport();
fDocumentHandler.startDocument(locator, encoding, nscontext, augs);
}
if (fInsertDoctype && fDocumentHandler != null) {
String root = htmlConfiguration_.htmlElements_.getElement(HTMLElements.HTML).name;
root = modifyName(root, fNamesElems);
final String pubid = fDoctypePubid;
final String sysid = fDoctypeSysid;
fDocumentHandler.doctypeDecl(root, pubid, sysid,
synthesizedAugs());
}
setScannerState(STATE_CONTENT);
break;
}
case STATE_END_DOCUMENT: {
if (fDocumentHandler != null && fElementCount >= fElementDepth && complete) {
if (DEBUG_CALLBACKS) {
System.out.println("endDocument()");
}
fEndLineNumber = fCurrentEntity.getLineNumber();
fEndColumnNumber = fCurrentEntity.getColumnNumber();
fEndCharacterOffset = fCurrentEntity.getCharacterOffset();
fDocumentHandler.endDocument(locationAugs());
}
return false;
}
default: {
throw new RuntimeException("unknown scanner state: "+fScannerState);
}
}
}
catch (final EOFException e) {
if (fCurrentEntityStack.empty()) {
setScannerState(STATE_END_DOCUMENT);
}
else {
fCurrentEntity = fCurrentEntityStack.pop();
}
next = true;
}
} while (next || complete);
return true;
}
/**
* Scans the content of