DOMNodePointer.java
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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
*
* https://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 org.apache.commons.jxpath.ri.model.dom;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import org.apache.commons.jxpath.JXPathAbstractFactoryException;
import org.apache.commons.jxpath.JXPathContext;
import org.apache.commons.jxpath.JXPathException;
import org.apache.commons.jxpath.Pointer;
import org.apache.commons.jxpath.ri.Compiler;
import org.apache.commons.jxpath.ri.NamespaceResolver;
import org.apache.commons.jxpath.ri.QName;
import org.apache.commons.jxpath.ri.compiler.NodeNameTest;
import org.apache.commons.jxpath.ri.compiler.NodeTest;
import org.apache.commons.jxpath.ri.compiler.NodeTypeTest;
import org.apache.commons.jxpath.ri.compiler.ProcessingInstructionTest;
import org.apache.commons.jxpath.ri.model.NodeIterator;
import org.apache.commons.jxpath.ri.model.NodePointer;
import org.apache.commons.jxpath.ri.model.beans.NullPointer;
import org.apache.commons.jxpath.util.TypeUtils;
import org.w3c.dom.Attr;
import org.w3c.dom.Comment;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.w3c.dom.ProcessingInstruction;
/**
* A Pointer that points to a DOM node. Because a DOM Node is not guaranteed Serializable, a DOMNodePointer instance may likewise not be properly Serializable.
*/
public class DOMNodePointer extends NodePointer {
private static final long serialVersionUID = -8751046933894857319L;
/** XML namespace URI */
public static final String XML_NAMESPACE_URI = "http://www.w3.org/XML/1998/namespace";
/** XMLNS namespace URI */
public static final String XMLNS_NAMESPACE_URI = "http://www.w3.org/2000/xmlns/";
/**
* Test string equality.
*
* @param s1 String 1
* @param s2 String 2
* @return true if == or .equals()
*/
private static boolean equalStrings(String s1, String s2) {
if (s1 == s2) {
return true;
}
s1 = s1 == null ? "" : s1.trim();
s2 = s2 == null ? "" : s2.trim();
return s1.equals(s2);
}
/**
* Find the nearest occurrence of the specified attribute on the specified and enclosing elements.
*
* @param n current node
* @param attrName attribute name
* @return attribute value
*/
protected static String findEnclosingAttribute(Node n, final String attrName) {
while (n != null) {
if (n.getNodeType() == Node.ELEMENT_NODE) {
final Element e = (Element) n;
final String attr = e.getAttribute(attrName);
if (attr != null && !attr.isEmpty()) {
return attr;
}
}
n = n.getParentNode();
}
return null;
}
/**
* Gets the local name of the specified node.
*
* @param node node to check
* @return String local name
*/
public static String getLocalName(final Node node) {
final String localName = node.getLocalName();
if (localName != null) {
return localName;
}
final String name = node.getNodeName();
final int index = name.lastIndexOf(':');
return index < 0 ? name : name.substring(index + 1);
}
/**
* Gets the ns uri of the specified node.
*
* @param node Node to check
* @return String ns uri
*/
public static String getNamespaceURI(Node node) {
if (node instanceof Document) {
node = ((Document) node).getDocumentElement();
}
final Element element = (Element) node;
String uri = element.getNamespaceURI();
if (uri == null) {
final String prefix = getPrefix(node);
final String qname = prefix == null ? "xmlns" : "xmlns:" + prefix;
Node aNode = node;
while (aNode != null) {
if (aNode.getNodeType() == Node.ELEMENT_NODE) {
final Attr attr = ((Element) aNode).getAttributeNode(qname);
if (attr != null) {
uri = attr.getValue();
break;
}
}
aNode = aNode.getParentNode();
}
}
return "".equals(uri) ? null : uri;
}
/**
* Gets any prefix from the specified node.
*
* @param node the node to check
* @return String xml prefix
*/
public static String getPrefix(final Node node) {
final String prefix = node.getPrefix();
if (prefix != null) {
return prefix;
}
final String name = node.getNodeName();
final int index = name.lastIndexOf(':');
return index < 0 ? null : name.substring(0, index);
}
/**
* Test a Node.
*
* @param node to test
* @param test to execute
* @return true if node passes test
*/
public static boolean testNode(final Node node, final NodeTest test) {
if (test == null) {
return true;
}
if (test instanceof NodeNameTest) {
if (node.getNodeType() != Node.ELEMENT_NODE) {
return false;
}
final NodeNameTest nodeNameTest = (NodeNameTest) test;
final QName testName = nodeNameTest.getNodeName();
final String namespaceURI = nodeNameTest.getNamespaceURI();
final boolean wildcard = nodeNameTest.isWildcard();
final String testPrefix = testName.getPrefix();
if (wildcard && testPrefix == null) {
return true;
}
if (wildcard || testName.getName().equals(getLocalName(node))) {
final String nodeNS = getNamespaceURI(node);
return equalStrings(namespaceURI, nodeNS) || nodeNS == null && equalStrings(testPrefix, getPrefix(node));
}
return false;
}
if (test instanceof NodeTypeTest) {
final int nodeType = node.getNodeType();
switch (((NodeTypeTest) test).getNodeType()) {
case Compiler.NODE_TYPE_NODE:
return true;
case Compiler.NODE_TYPE_TEXT:
return nodeType == Node.CDATA_SECTION_NODE || nodeType == Node.TEXT_NODE;
case Compiler.NODE_TYPE_COMMENT:
return nodeType == Node.COMMENT_NODE;
case Compiler.NODE_TYPE_PI:
return nodeType == Node.PROCESSING_INSTRUCTION_NODE;
default:
return false;
}
}
if (test instanceof ProcessingInstructionTest && node.getNodeType() == Node.PROCESSING_INSTRUCTION_NODE) {
final String testPI = ((ProcessingInstructionTest) test).getTarget();
final String nodePI = ((ProcessingInstruction) node).getTarget();
return testPI.equals(nodePI);
}
return false;
}
/**
* A DOM node supporting {@link #getImmediateNode()}.
*/
private final Node node;
/**
* Supports {@link #getDefaultNamespaceURI()}.
*/
private Map<String, String> namespaces;
/**
* Supports {@link #getNamespaceURI(String)}.
*/
private String defaultNamespace;
/**
* Optional ID.
*/
private final String id;
/**
* Supports {@link #getNamespaceResolver()}.
*/
private NamespaceResolver localNamespaceResolver;
/**
* Constructs a new DOMNodePointer.
*
* @param node A node.
* @param locale Locale.
*/
public DOMNodePointer(final Node node, final Locale locale) {
this(node, locale, null);
}
/**
* Constructs a new DOMNodePointer.
*
* @param node A node.
* @param locale Locale.
* @param id String ID.
*/
public DOMNodePointer(final Node node, final Locale locale, final String id) {
super(null, locale);
this.node = node;
this.id = id;
}
/**
* Constructs a new DOMNodePointer.
*
* @param parent pointer
* @param node pointed
*/
public DOMNodePointer(final NodePointer parent, final Node node) {
super(parent);
this.node = node;
this.id = null;
}
@Override
public String asPath() {
if (id != null) {
return "id('" + escape(id) + "')";
}
final StringBuilder buffer = new StringBuilder();
if (parent != null) {
buffer.append(parent.asPath());
}
switch (node.getNodeType()) {
case Node.ELEMENT_NODE:
// If the parent pointer is not a DOMNodePointer, it is
// the parent's responsibility to produce the node test part
// of the path
if (parent instanceof DOMNodePointer) {
if (buffer.length() == 0 || buffer.charAt(buffer.length() - 1) != '/') {
buffer.append('/');
}
final String ln = getLocalName(node);
final String nsURI = getNamespaceURI();
if (nsURI == null) {
buffer.append(ln);
buffer.append('[');
buffer.append(getRelativePositionByQName()).append(']');
} else {
final String prefix = getNamespaceResolver().getPrefix(nsURI);
if (prefix != null) {
buffer.append(prefix);
buffer.append(':');
buffer.append(ln);
buffer.append('[');
buffer.append(getRelativePositionByQName());
} else {
buffer.append("node()");
buffer.append('[');
buffer.append(getRelativePositionOfElement());
}
buffer.append(']');
}
}
break;
case Node.TEXT_NODE:
case Node.CDATA_SECTION_NODE:
buffer.append("/text()");
buffer.append('[');
buffer.append(getRelativePositionOfTextNode()).append(']');
break;
case Node.PROCESSING_INSTRUCTION_NODE:
buffer.append("/processing-instruction(\'");
buffer.append(((ProcessingInstruction) node).getTarget()).append("')");
buffer.append('[');
buffer.append(getRelativePositionOfPI()).append(']');
break;
case Node.DOCUMENT_NODE:
// That'll be empty
break;
default:
break;
}
return buffer.toString();
}
@Override
public NodeIterator attributeIterator(final QName qName) {
return new DOMAttributeIterator(this, qName);
}
@Override
public NodeIterator childIterator(final NodeTest test, final boolean reverse, final NodePointer startWith) {
return new DOMNodeIterator(this, test, reverse, startWith);
}
@Override
public int compareChildNodePointers(final NodePointer pointer1, final NodePointer pointer2) {
final Node node1 = (Node) pointer1.getBaseValue();
final Node node2 = (Node) pointer2.getBaseValue();
if (node1 == node2) {
return 0;
}
final int t1 = node1.getNodeType();
final int t2 = node2.getNodeType();
if (t1 == Node.ATTRIBUTE_NODE && t2 != Node.ATTRIBUTE_NODE) {
return -1;
}
if (t1 != Node.ATTRIBUTE_NODE && t2 == Node.ATTRIBUTE_NODE) {
return 1;
}
if (t1 == Node.ATTRIBUTE_NODE && t2 == Node.ATTRIBUTE_NODE) {
final NamedNodeMap map = ((Node) getNode()).getAttributes();
final int length = map.getLength();
for (int i = 0; i < length; i++) {
final Node n = map.item(i);
if (n == node1) {
return -1;
}
if (n == node2) {
return 1;
}
}
return 0; // Should not happen
}
Node current = node.getFirstChild();
while (current != null) {
if (current == node1) {
return -1;
}
if (current == node2) {
return 1;
}
current = current.getNextSibling();
}
return 0;
}
@Override
public NodePointer createAttribute(final JXPathContext context, final QName qName) {
if (!(node instanceof Element)) {
return super.createAttribute(context, qName);
}
final Element element = (Element) node;
final String prefix = qName.getPrefix();
if (prefix != null) {
String ns = null;
final NamespaceResolver nsr = getNamespaceResolver();
if (nsr != null) {
ns = nsr.getNamespaceURI(prefix);
}
if (ns == null) {
throw new JXPathException("Unknown namespace prefix: " + prefix);
}
element.setAttributeNS(ns, qName.toString(), "");
} else if (!element.hasAttribute(qName.getName())) {
element.setAttribute(qName.getName(), "");
}
final NodeIterator it = attributeIterator(qName);
it.setPosition(1);
return it.getNodePointer();
}
@Override
public NodePointer createChild(final JXPathContext context, final QName qName, int index) {
if (index == WHOLE_COLLECTION) {
index = 0;
}
final boolean success = getAbstractFactory(context).createObject(context, this, node, qName.toString(), index);
if (success) {
NodeTest nodeTest;
final String prefix = qName.getPrefix();
final String namespaceURI = prefix == null ? null : context.getNamespaceURI(prefix);
nodeTest = new NodeNameTest(qName, namespaceURI);
final NodeIterator it = childIterator(nodeTest, false, null);
if (it != null && it.setPosition(index + 1)) {
return it.getNodePointer();
}
}
throw new JXPathAbstractFactoryException("Factory could not create a child node for path: " + asPath() + "/" + qName + "[" + (index + 1) + "]");
}
@Override
public NodePointer createChild(final JXPathContext context, final QName qName, final int index, final Object value) {
final NodePointer ptr = createChild(context, qName, index);
ptr.setValue(value);
return ptr;
}
@Override
public boolean equals(final Object object) {
return object == this || object instanceof DOMNodePointer && node == ((DOMNodePointer) object).node;
}
@Override
public Object getBaseValue() {
return node;
}
@Override
public String getDefaultNamespaceURI() {
if (defaultNamespace == null) {
Node aNode = node;
if (aNode instanceof Document) {
aNode = ((Document) aNode).getDocumentElement();
}
while (aNode != null) {
if (aNode.getNodeType() == Node.ELEMENT_NODE) {
final Attr attr = ((Element) aNode).getAttributeNode("xmlns");
if (attr != null) {
defaultNamespace = attr.getValue();
break;
}
}
aNode = aNode.getParentNode();
}
}
if (defaultNamespace == null) {
defaultNamespace = "";
}
// TBD: We are supposed to resolve relative URIs to absolute ones.
return defaultNamespace.isEmpty() ? null : defaultNamespace;
}
@Override
public Object getImmediateNode() {
return node;
}
/**
* Gets the language attribute for this node.
*
* @return String language name
*/
protected String getLanguage() {
return findEnclosingAttribute(node, "xml:lang");
}
@Override
public int getLength() {
return 1;
}
@Override
public QName getName() {
String ln = null;
String ns = null;
final int type = node.getNodeType();
if (type == Node.ELEMENT_NODE) {
ns = getPrefix(node);
ln = getLocalName(node);
} else if (type == Node.PROCESSING_INSTRUCTION_NODE) {
ln = ((ProcessingInstruction) node).getTarget();
}
return new QName(ns, ln);
}
@Override
public synchronized NamespaceResolver getNamespaceResolver() {
if (localNamespaceResolver == null) {
localNamespaceResolver = new NamespaceResolver(super.getNamespaceResolver());
localNamespaceResolver.setNamespaceContextPointer(this);
}
return localNamespaceResolver;
}
@Override
public String getNamespaceURI() {
return getNamespaceURI(node);
}
@Override
public String getNamespaceURI(final String prefix) {
if (prefix == null || prefix.isEmpty()) {
return getDefaultNamespaceURI();
}
if (prefix.equals("xml")) {
return XML_NAMESPACE_URI;
}
if (prefix.equals("xmlns")) {
return XMLNS_NAMESPACE_URI;
}
String namespace = null;
if (namespaces == null) {
namespaces = new HashMap<>();
} else {
namespace = namespaces.get(prefix);
}
if (namespace == null) {
final String qname = "xmlns:" + prefix;
Node aNode = node;
if (aNode instanceof Document) {
aNode = ((Document) aNode).getDocumentElement();
}
while (aNode != null) {
if (aNode.getNodeType() == Node.ELEMENT_NODE) {
final Attr attr = ((Element) aNode).getAttributeNode(qname);
if (attr != null) {
namespace = attr.getValue();
break;
}
}
aNode = aNode.getParentNode();
}
if (namespace == null || namespace.isEmpty()) {
namespace = UNKNOWN_NAMESPACE;
}
}
namespaces.put(prefix, namespace);
if (namespace == UNKNOWN_NAMESPACE) {
return null;
}
// TBD: We are supposed to resolve relative URIs to absolute ones.
return namespace;
}
/**
* Locates a node by ID.
*
* @param context starting context
* @param id to find
* @return Pointer
*/
@Override
public Pointer getPointerByID(final JXPathContext context, final String id) {
final Document document = node.getNodeType() == Node.DOCUMENT_NODE ? (Document) node : node.getOwnerDocument();
final Element element = document.getElementById(id);
return element == null ? (Pointer) new NullPointer(getLocale(), id) : new DOMNodePointer(element, getLocale(), id);
}
/**
* Gets relative position of this among like-named siblings.
*
* @return 1..n
*/
private int getRelativePositionByQName() {
int count = 1;
Node n = node.getPreviousSibling();
while (n != null) {
if (n.getNodeType() == Node.ELEMENT_NODE && matchesQName(n)) {
count++;
}
n = n.getPreviousSibling();
}
return count;
}
/**
* Gets relative position of this among all siblings.
*
* @return 1..n
*/
private int getRelativePositionOfElement() {
int count = 1;
Node n = node.getPreviousSibling();
while (n != null) {
if (n.getNodeType() == Node.ELEMENT_NODE) {
count++;
}
n = n.getPreviousSibling();
}
return count;
}
/**
* Gets the relative position of this among same-target processing instruction siblings.
*
* @return 1..n
*/
private int getRelativePositionOfPI() {
int count = 1;
final String target = ((ProcessingInstruction) node).getTarget();
Node n = node.getPreviousSibling();
while (n != null) {
if (n.getNodeType() == Node.PROCESSING_INSTRUCTION_NODE && ((ProcessingInstruction) n).getTarget().equals(target)) {
count++;
}
n = n.getPreviousSibling();
}
return count;
}
/**
* Gets the relative position of this among sibling text nodes.
*
* @return 1..n
*/
private int getRelativePositionOfTextNode() {
int count = 1;
Node n = node.getPreviousSibling();
while (n != null) {
if (n.getNodeType() == Node.TEXT_NODE || n.getNodeType() == Node.CDATA_SECTION_NODE) {
count++;
}
n = n.getPreviousSibling();
}
return count;
}
@Override
public Object getValue() {
if (node.getNodeType() == Node.COMMENT_NODE) {
final String text = ((Comment) node).getData();
return text == null ? "" : text.trim();
}
return stringValue(node);
}
@Override
public int hashCode() {
return node.hashCode();
}
@Override
public boolean isActual() {
return true;
}
@Override
public boolean isCollection() {
return false;
}
/**
* Returns true if the xml:lang attribute for the current node or its parent has the specified prefix <em>lang</em>. If no node has this prefix, calls
* {@code super.isLanguage(lang)}.
*
* @param lang ns to test
* @return boolean
*/
@Override
public boolean isLanguage(final String lang) {
final String current = getLanguage();
return current == null ? super.isLanguage(lang) : current.toUpperCase(Locale.ENGLISH).startsWith(lang.toUpperCase(Locale.ENGLISH));
}
@Override
public boolean isLeaf() {
return !node.hasChildNodes();
}
private boolean matchesQName(final Node n) {
if (getNamespaceURI() != null) {
return equalStrings(getNamespaceURI(n), getNamespaceURI()) && equalStrings(node.getLocalName(), n.getLocalName());
}
return equalStrings(node.getNodeName(), n.getNodeName());
}
@Override
public NodeIterator namespaceIterator() {
return new DOMNamespaceIterator(this);
}
@Override
public NodePointer namespacePointer(final String prefix) {
return new NamespacePointer(this, prefix);
}
@Override
public void remove() {
final Node parent = node.getParentNode();
if (parent == null) {
throw new JXPathException("Cannot remove root DOM node");
}
parent.removeChild(node);
}
/**
* Sets contents of the node to the specified value. If the value is a String, the contents of the node are replaced with this text. If the value is an
* Element or Document, the children of the node are replaced with the children of the passed node.
*
* @param value to set
*/
@Override
public void setValue(final Object value) {
if (node.getNodeType() == Node.TEXT_NODE || node.getNodeType() == Node.CDATA_SECTION_NODE) {
final String string = (String) TypeUtils.convert(value, String.class);
if (string != null && !string.isEmpty()) {
node.setNodeValue(string);
} else {
node.getParentNode().removeChild(node);
}
} else {
NodeList children = node.getChildNodes();
final int count = children.getLength();
for (int i = count; --i >= 0;) {
final Node child = children.item(i);
node.removeChild(child);
}
if (value instanceof Node) {
final Node valueNode = (Node) value;
if (valueNode instanceof Element || valueNode instanceof Document) {
children = valueNode.getChildNodes();
for (int i = 0; i < children.getLength(); i++) {
final Node child = children.item(i);
node.appendChild(child.cloneNode(true));
}
} else {
node.appendChild(valueNode.cloneNode(true));
}
} else {
final String string = (String) TypeUtils.convert(value, String.class);
if (string != null && !string.isEmpty()) {
final Node textNode = node.getOwnerDocument().createTextNode(string);
node.appendChild(textNode);
}
}
}
}
/**
* Gets the string value of the specified node.
*
* @param node Node to check
* @return String
*/
private String stringValue(final Node node) {
final int nodeType = node.getNodeType();
if (nodeType == Node.COMMENT_NODE) {
return "";
}
final boolean trim = !"preserve".equals(findEnclosingAttribute(node, "xml:space"));
if (nodeType == Node.TEXT_NODE || nodeType == Node.CDATA_SECTION_NODE) {
final String text = node.getNodeValue();
return text == null ? "" : trim ? text.trim() : text;
}
if (nodeType == Node.PROCESSING_INSTRUCTION_NODE) {
final String text = ((ProcessingInstruction) node).getData();
return text == null ? "" : trim ? text.trim() : text;
}
final NodeList list = node.getChildNodes();
final StringBuilder buf = new StringBuilder();
for (int i = 0; i < list.getLength(); i++) {
final Node child = list.item(i);
buf.append(stringValue(child));
}
return buf.toString();
}
@Override
public boolean testNode(final NodeTest test) {
return testNode(node, test);
}
}