net.sourceforge.htmlunit.cyberneko.filters.NamespaceBinder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.liferay.diff.impl
Show all versions of com.liferay.diff.impl
Liferay Diff Implementation
The newest version!
/*
* Copyright 2004-2008 Andy Clark
*
* 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.filters;
import java.util.Enumeration;
import java.util.Locale;
import java.util.Vector;
import org.apache.xerces.xni.Augmentations;
import org.apache.xerces.xni.NamespaceContext;
import org.apache.xerces.xni.QName;
import org.apache.xerces.xni.XMLAttributes;
import org.apache.xerces.xni.XMLLocator;
import org.apache.xerces.xni.XNIException;
import org.apache.xerces.xni.parser.XMLComponentManager;
import org.apache.xerces.xni.parser.XMLConfigurationException;
import net.sourceforge.htmlunit.cyberneko.HTMLConfiguration;
/**
* This filter binds namespaces if namespace processing is turned on
* by setting the feature "http://xml.org/sax/features/namespaces" is
* set to true.
*
* This configuration recognizes the following features:
*
* - http://xml.org/sax/features/namespaces
*
*
* @author Andy Clark
*/
public class NamespaceBinder
extends DefaultFilter {
//
// Constants
//
// namespace uris
/** XHTML 1.0 namespace URI (http://www.w3.org/1999/xhtml). */
public static final String XHTML_1_0_URI = "http://www.w3.org/1999/xhtml";
/** XML namespace URI (http://www.w3.org/XML/1998/namespace). */
public static final String XML_URI = "http://www.w3.org/XML/1998/namespace";
/** XMLNS namespace URI (http://www.w3.org/2000/xmlns/). */
public static final String XMLNS_URI = "http://www.w3.org/2000/xmlns/";
// features
/** Namespaces. */
protected static final String NAMESPACES = "http://xml.org/sax/features/namespaces";
/** Override namespace binding URI. */
protected static final String OVERRIDE_NAMESPACES = "http://cyberneko.org/html/features/override-namespaces";
/** Insert namespace binding URIs. */
protected static final String INSERT_NAMESPACES = "http://cyberneko.org/html/features/insert-namespaces";
/** Recognized features. */
private static final String[] RECOGNIZED_FEATURES = {
NAMESPACES,
OVERRIDE_NAMESPACES,
INSERT_NAMESPACES,
};
/** Feature defaults. */
private static final Boolean[] FEATURE_DEFAULTS = {
null,
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";
/** Namespaces URI. */
protected static final String NAMESPACES_URI = "http://cyberneko.org/html/properties/namespaces-uri";
/** Recognized properties. */
private static final String[] RECOGNIZED_PROPERTIES = new String[] {
NAMES_ELEMS,
NAMES_ATTRS,
NAMESPACES_URI,
};
/** Property defaults. */
private static final Object[] PROPERTY_DEFAULTS = {
null,
null,
XHTML_1_0_URI,
};
// 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;
//
// Data
//
// features
/** Namespaces. */
protected boolean fNamespaces;
/** Namespace prefixes. */
protected boolean fNamespacePrefixes;
/** Override namespaces. */
protected boolean fOverrideNamespaces;
/** Insert namespaces. */
protected boolean fInsertNamespaces;
// properties
/** Modify HTML element names. */
protected short fNamesElems;
/** Modify HTML attribute names. */
protected short fNamesAttrs;
/** Namespaces URI. */
protected String fNamespacesURI;
// state
/** Namespace context. */
protected final NamespaceSupport fNamespaceContext = new NamespaceSupport();
// temp vars
/** QName. */
private final QName fQName = new QName();
private final HTMLConfiguration htmlConfiguration_;
public NamespaceBinder(HTMLConfiguration htmlConfiguration) {
htmlConfiguration_ = htmlConfiguration;
}
//
// HTMLComponent methods
//
/**
* Returns a list of feature identifiers that are recognized by
* this component. This method may return null if no features
* are recognized by this component.
*/
@Override
public String[] getRecognizedFeatures() {
return merge(super.getRecognizedFeatures(), RECOGNIZED_FEATURES);
}
/**
* Returns the default state for a feature, or null if this
* component does not want to report a default value for this
* feature.
*/
@Override
public Boolean getFeatureDefault(String featureId) {
for (int i = 0; i < RECOGNIZED_FEATURES.length; i++) {
if (RECOGNIZED_FEATURES[i].equals(featureId)) {
return FEATURE_DEFAULTS[i];
}
}
return super.getFeatureDefault(featureId);
}
/**
* Returns a list of property identifiers that are recognized by
* this component. This method may return null if no properties
* are recognized by this component.
*/
@Override
public String[] getRecognizedProperties() {
return merge(super.getRecognizedProperties(), RECOGNIZED_PROPERTIES);
}
/**
* Returns the default value for a property, or null if this
* component does not want to report a default value for this
* property.
*/
@Override
public Object getPropertyDefault(String propertyId) {
for (int i = 0; i < RECOGNIZED_PROPERTIES.length; i++) {
if (RECOGNIZED_PROPERTIES[i].equals(propertyId)) {
return PROPERTY_DEFAULTS[i];
}
}
return super.getPropertyDefault(propertyId);
}
/**
* Resets the component. The component can query the component manager
* about any features and properties that affect the operation of the
* component.
*
* @param manager The component manager.
*
* @throws XNIException Thrown by component on initialization error.
*/
@Override
public void reset(XMLComponentManager manager)
throws XMLConfigurationException {
super.reset(manager);
// features
fNamespaces = manager.getFeature(NAMESPACES);
fOverrideNamespaces = manager.getFeature(OVERRIDE_NAMESPACES);
fInsertNamespaces = manager.getFeature(INSERT_NAMESPACES);
// get properties
fNamesElems = getNamesValue(String.valueOf(manager.getProperty(NAMES_ELEMS)));
fNamesAttrs = getNamesValue(String.valueOf(manager.getProperty(NAMES_ATTRS)));
fNamespacesURI = String.valueOf(manager.getProperty(NAMESPACES_URI));
// initialize state
fNamespaceContext.reset();
}
//
// XMLDocumentHandler methods
//
/** Start document. */
@Override
public void startDocument(XMLLocator locator, String encoding,
NamespaceContext nscontext, Augmentations augs)
throws XNIException {
// perform default handling
// NOTE: using own namespace context
super.startDocument(locator,encoding,fNamespaceContext,augs);
}
/** Start element. */
@Override
public void startElement(QName element, XMLAttributes attrs,
Augmentations augs) throws XNIException {
// bind namespaces, if needed
if (fNamespaces) {
fNamespaceContext.pushContext();
bindNamespaces(element, attrs);
}
// perform default handling
super.startElement(element, attrs, augs);
}
/** Empty element. */
@Override
public void emptyElement(QName element, XMLAttributes attrs,
Augmentations augs) throws XNIException {
// bind namespaces, if needed
if (fNamespaces) {
fNamespaceContext.pushContext();
bindNamespaces(element, attrs);
}
// perform default handling
super.emptyElement(element, attrs, augs);
// pop context
if (fNamespaces) {
fNamespaceContext.popContext();
}
}
/** End element. */
@Override
public void endElement(QName element, Augmentations augs)
throws XNIException {
// bind namespaces, if needed
if (fNamespaces) {
bindNamespaces(element, null);
}
// perform default handling
super.endElement(element, augs);
// pop context
if (fNamespaces) {
fNamespaceContext.popContext();
}
}
//
// Protected static methods
//
// Splits a qualified name.
protected static void splitQName(QName qname) {
final int index = qname.rawname.indexOf(':');
if (index != -1) {
qname.prefix = qname.rawname.substring(0,index);
qname.localpart = qname.rawname.substring(index+1);
}
}
//
// Converts HTML names string value to constant value.
//
// @see #NAMES_NO_CHANGE
// @see #NAMES_LOWERCASE
// @see #NAMES_UPPERCASE
protected static final short getNamesValue(String value) {
if (value.equals("lower")) { return NAMES_LOWERCASE; }
if (value.equals("upper")) { return NAMES_UPPERCASE; }
return NAMES_NO_CHANGE;
}
// Modifies the given name based on the specified mode.
protected static final String modifyName(String name, short mode) {
switch (mode) {
case NAMES_UPPERCASE: return name.toUpperCase(Locale.ENGLISH);
case NAMES_LOWERCASE: return name.toLowerCase(Locale.ENGLISH);
}
return name;
}
//
// Protected methods
//
// Binds namespaces.
protected void bindNamespaces(QName element, XMLAttributes attrs) {
// split element qname
splitQName(element);
// declare namespace prefixes
if (attrs != null) {
int attrCount = attrs.getLength();
for (int i = attrCount - 1; i >= 0; i--) {
attrs.getName(i, fQName);
String aname = fQName.rawname;
final String ANAME = aname.toUpperCase(Locale.ENGLISH);
if (ANAME.startsWith("XMLNS:") || ANAME.equals("XMLNS")) {
final int anamelen = aname.length();
// get parts
String aprefix = anamelen > 5 ? aname.substring(0,5) : null;
String alocal = anamelen > 5 ? aname.substring(6) : aname;
final String avalue = attrs.getValue(i);
// re-case parts and set them back into attributes
if (anamelen > 5) {
aprefix = modifyName(aprefix, NAMES_LOWERCASE);
alocal = modifyName(alocal, fNamesElems);
aname = aprefix + ':' + alocal;
}
else {
alocal = modifyName(alocal, NAMES_LOWERCASE);
aname = alocal;
}
fQName.setValues(aprefix, alocal, aname, null);
attrs.setName(i, fQName);
// declare prefix
final String prefix = alocal != aname ? alocal : "";
String uri = avalue.length() > 0 ? avalue : null;
if (fOverrideNamespaces &&
prefix.equals(element.prefix) &&
htmlConfiguration_.htmlElements_.getElement(element.localpart, null) != null) {
uri = fNamespacesURI;
}
fNamespaceContext.declarePrefix(prefix, uri);
}
}
}
// bind element
String prefix = element.prefix != null ? element.prefix : "";
element.uri = fNamespaceContext.getURI(prefix);
// REVISIT: The prefix of a qualified element name that is
// bound to a namespace is passed (as recent as
// Xerces 2.4.0) as "" for start elements and null
// for end elements. Why? One of them is a bug,
// clearly. -Ac
if (element.uri != null && element.prefix == null) {
element.prefix = "";
}
// do we need to insert namespace bindings?
if (fInsertNamespaces && attrs != null &&
htmlConfiguration_.htmlElements_.getElement(element.localpart,null) != null) {
if (element.prefix == null ||
fNamespaceContext.getURI(element.prefix) == null) {
final String xmlns = "xmlns" + ((element.prefix != null)
? ":"+element.prefix : "");
fQName.setValues(null, xmlns, xmlns, null);
attrs.addAttribute(fQName, "CDATA", fNamespacesURI);
bindNamespaces(element, attrs);
return;
}
}
// bind attributes
if (attrs != null) {
final int attrCount = attrs.getLength();
for (int i = 0; i < attrCount; i++) {
attrs.getName(i, fQName);
splitQName(fQName);
prefix = !fQName.rawname.equals("xmlns")
? (fQName.prefix != null ? fQName.prefix : "") : "xmlns";
// PATCH: Joseph Walton
if (!prefix.equals("")) {
fQName.uri = prefix.equals("xml") ? XML_URI : fNamespaceContext.getURI(prefix);
}
// NOTE: You would think the xmlns namespace would be handled
// by NamespaceSupport but it's not. -Ac
if (prefix.equals("xmlns") && fQName.uri == null) {
fQName.uri = XMLNS_URI;
}
attrs.setName(i, fQName);
}
}
}
//
// Classes
//
/**
* This namespace context object implements the old and new XNI
* NamespaceContext interface methods so that it can
* be used across all versions of Xerces2.
*/
public static class NamespaceSupport
implements NamespaceContext {
//
// Data
//
/** Top of the levels list. */
protected int fTop = 0;
/** The levels of the entries. */
protected int[] fLevels = new int[10];
/** The entries. */
protected Entry[] fEntries = new Entry[10];
//
// Constructors
//
/** Default constructor. */
public NamespaceSupport() {
pushContext();
declarePrefix("xml", NamespaceContext.XML_URI);
declarePrefix("xmlns", NamespaceContext.XMLNS_URI);
}
//
// NamespaceContext methods
//
// since Xerces 2.0.0-beta2 (old XNI namespaces)
/** Get URI. */
@Override
public String getURI(String prefix) {
for (int i = fLevels[fTop]-1; i >= 0; i--) {
final Entry entry = fEntries[i];
if (entry.prefix.equals(prefix)) {
return entry.uri;
}
}
return null;
}
/** Get declared prefix count. */
@Override
public int getDeclaredPrefixCount() {
return fLevels[fTop] - fLevels[fTop-1];
}
/** Get declared prefix at. */
@Override
public String getDeclaredPrefixAt(int index) {
return fEntries[fLevels[fTop-1] + index].prefix;
}
// Get parent context.
public NamespaceContext getParentContext() {
return this;
}
// since Xerces #.#.# (new XNI namespaces)
/** Reset. */
@Override
public void reset() {
fLevels[fTop = 1] = fLevels[fTop-1];
}
/** Push context. */
@Override
public void pushContext() {
if (++fTop == fLevels.length) {
final int[] iarray = new int[fLevels.length + 10];
System.arraycopy(fLevels, 0, iarray, 0, fLevels.length);
fLevels = iarray;
}
fLevels[fTop] = fLevels[fTop-1];
}
/** Pop context. */
@Override
public void popContext() {
if (fTop > 1) {
fTop--;
}
}
/** Declare prefix. */
@Override
public boolean declarePrefix(String prefix, String uri) {
final int count = getDeclaredPrefixCount();
for (int i = 0; i < count; i++) {
final String dprefix = getDeclaredPrefixAt(i);
if (dprefix.equals(prefix)) {
return false;
}
}
final Entry entry = new Entry(prefix, uri);
if (fLevels[fTop] == fEntries.length) {
final Entry[] earray = new Entry[fEntries.length + 10];
System.arraycopy(fEntries, 0, earray, 0, fEntries.length);
fEntries = earray;
}
fEntries[fLevels[fTop]++] = entry;
return true;
}
/** Get prefix. */
@Override
public String getPrefix(String uri) {
for (int i = fLevels[fTop]-1; i >= 0; i--) {
final Entry entry = fEntries[i];
if (entry.uri.equals(uri)) {
return entry.prefix;
}
}
return null;
}
/** Get all prefixes. */
@Override
public Enumeration getAllPrefixes() {
final Vector prefixes = new Vector<>();
for (int i = fLevels[1]; i < fLevels[fTop]; i++) {
final String prefix = fEntries[i].prefix;
if (!prefixes.contains(prefix)) {
prefixes.addElement(prefix);
}
}
return prefixes.elements();
}
//
// Classes
//
/** A namespace binding entry. */
static class Entry {
//
// Data
//
/** Prefix. */
public String prefix;
/** URI. */
public String uri;
//
// Constructors
//
/** Constructs an entry. */
public Entry(String prefix, String uri) {
this.prefix = prefix;
this.uri = uri;
}
}
}
}