Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.intuit.karate.XmlUtils Maven / Gradle / Ivy
/*
* The MIT License
*
* Copyright 2022 Karate Labs Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.intuit.karate;
import com.jayway.jsonpath.DocumentContext;
import com.jayway.jsonpath.JsonPath;
import java.io.IOException;
import java.io.InputStream;
import java.io.StringReader;
import java.io.StringWriter;
import java.util.ArrayList;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathConstants;
import javax.xml.xpath.XPathExpression;
import javax.xml.xpath.XPathExpressionException;
import javax.xml.xpath.XPathFactory;
import org.w3c.dom.Attr;
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.xml.sax.EntityResolver;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
/**
* @author pthomas3
*/
public class XmlUtils {
private XmlUtils() {
// only static methods
}
public static String toString(Node node) {
return toString(node, false);
}
public static String toString(Node node, boolean pretty) {
Node nodeToSerialize = node;
// In case of pretty string, we clone the node so that we don't modify the original node while trimming whitespaces
if (pretty) {
nodeToSerialize = node.cloneNode(true);
trimWhiteSpace(nodeToSerialize);
}
DOMSource domSource = new DOMSource(nodeToSerialize);
StringWriter writer = new StringWriter();
StreamResult result = new StreamResult(writer);
TransformerFactory tf = TransformerFactory.newInstance();
try {
Transformer transformer = tf.newTransformer();
transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes");
if (pretty) {
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "2");
} else {
transformer.setOutputProperty(OutputKeys.INDENT, "no");
}
transformer.transform(domSource, result);
return writer.toString();
} catch (Exception e) {
throw new RuntimeException(e);
}
}
public static void trimWhiteSpace(Node node) {
NodeList children = node.getChildNodes();
int count = children.getLength();
for (int i = 0; i < count; ++i) {
Node child = children.item(i);
if (child.getNodeType() == Node.TEXT_NODE) {
child.setTextContent(child.getTextContent() == null ? "" : child.getTextContent().trim());
}
trimWhiteSpace(child);
}
}
private static class DtdEntityResolver implements EntityResolver {
protected boolean dtdPresent;
@Override
public InputSource resolveEntity(String publicId, String systemId) throws SAXException, IOException {
dtdPresent = true;
return new InputSource(new StringReader(""));
}
}
public static Document toXmlDoc(String xml) {
return toXmlDoc(xml, false);
}
public static Document toXmlDoc(String xml, boolean namespaceAware) {
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
factory.setNamespaceAware(namespaceAware);
try {
DocumentBuilder builder = factory.newDocumentBuilder();
DtdEntityResolver dtdEntityResolver = new DtdEntityResolver();
builder.setEntityResolver(dtdEntityResolver);
InputStream is = FileUtils.toInputStream(xml);
Document doc = builder.parse(is);
if (dtdEntityResolver.dtdPresent) { // DOCTYPE present
// the XML was not parsed, but I think it hangs at the root as a text node
// so conversion to string and back has the effect of discarding the DOCTYPE !
return toXmlDoc(toString(doc, false), namespaceAware);
} else {
return doc;
}
} catch (Exception e) {
throw new RuntimeException(e);
}
}
private static XPathExpression compile(String path) {
XPathFactory xPathfactory = XPathFactory.newInstance();
XPath xpath = xPathfactory.newXPath();
try {
return xpath.compile(path);
} catch (Exception e) {
throw new RuntimeException(e);
}
}
public static NodeList getNodeListByPath(Node node, String path) {
XPathExpression expr = compile(path);
try {
return (NodeList) expr.evaluate(node, XPathConstants.NODESET);
} catch (Exception e) {
throw new RuntimeException(e);
}
}
public static String stripNameSpacePrefixes(String path) {
if (path.indexOf(':') == -1) {
return path;
}
StringBuilder sb = new StringBuilder();
for (String s : StringUtils.split(path, '/', false)) {
sb.append('/');
int pos = s.lastIndexOf(':');
if (pos == -1) {
sb.append(s);
} else {
sb.append(s.substring(pos + 1));
}
}
return sb.toString();
}
public static Node getNodeByPath(Node node, String path, boolean create) {
String searchPath = create ? stripNameSpacePrefixes(path) : path;
XPathExpression expr = compile(searchPath);
Node result;
try {
result = (Node) expr.evaluate(node, XPathConstants.NODE);
} catch (XPathExpressionException e) {
throw new RuntimeException(e);
}
if (result == null && create) {
Document doc = node.getNodeType() == Node.DOCUMENT_NODE ? (Document) node : node.getOwnerDocument();
return createNodeByPath(doc, path);
} else {
return result;
}
}
public static Node createNodeByPath(Document doc, String path) {
int pos = path.lastIndexOf('/');
if (pos == 0) { // root
Node root = doc.getDocumentElement();
if (root == null) {
root = createElement(doc, path.substring(1), null, null);
doc.appendChild(root);
}
return root;
}
String left = path.substring(0, pos);
Node parent = getNodeByPath(doc, left, true);
String right = path.substring(pos + 1);
if (right.startsWith("@")) { // attribute
Element parentElement = (Element) parent;
right = right.substring(1);
parentElement.setAttribute(right, "");
return parentElement.getAttributeNode(right);
} else {
int bracketPos = right.indexOf('[');
if (bracketPos != -1) { // index, we assume it is 1 and still append
right = right.substring(0, bracketPos);
}
Element element = createElement(parent, right, null, null);
parent.appendChild(element);
return element;
}
}
public static String getTextValueByPath(Node node, String path) {
XPathExpression expr = compile(path);
try {
return expr.evaluate(node);
} catch (Exception e) {
throw new RuntimeException(e);
}
}
public static void setByPath(Node doc, String path, String value) {
Node node = getNodeByPath(doc, path, true);
if (node.getNodeType() == Node.ATTRIBUTE_NODE) {
node.setNodeValue(value);
} else if (node.hasChildNodes() && node.getFirstChild().getNodeType() == Node.TEXT_NODE) {
node.getFirstChild().setTextContent(value);
} else if (node.getNodeType() == Node.ELEMENT_NODE) {
node.setTextContent(value);
}
}
public static void removeByPath(Document doc, String path) {
Node node = getNodeByPath(doc, path, false);
if (node == null) {
return;
}
if (node.getNodeType() == Node.ATTRIBUTE_NODE) {
Element parent = ((Attr) node).getOwnerElement();
parent.removeAttribute(node.getNodeName());
} else {
Node parent = node.getParentNode();
if (parent != null) {
parent.removeChild(node);
}
}
}
public static void setByPath(Document doc, String path, Node in) {
if (in.getNodeType() == Node.DOCUMENT_NODE) {
in = in.getFirstChild();
}
Node node = getNodeByPath(doc, path, true);
if (node == null) {
throw new RuntimeException("no results for xpath: " + path);
}
Node newNode = doc.importNode(in, true);
if (node.hasChildNodes() && node.getFirstChild().getNodeType() == Node.TEXT_NODE) {
node.replaceChild(newNode, node.getFirstChild());
} else {
node.appendChild(newNode);
}
}
public static DocumentContext toJsonDoc(Node node) {
return JsonPath.parse(toObject(node));
}
private static Map getAttributes(Node node) {
NamedNodeMap attribs = node.getAttributes();
int attribCount = attribs.getLength();
Map map = new LinkedHashMap<>(attribCount);
for (int j = 0; j < attribCount; j++) {
Node attrib = attribs.item(j);
map.put(attrib.getNodeName(), attrib.getNodeValue());
}
return map;
}
public static int getChildElementCount(Node node) {
NodeList nodes = node.getChildNodes();
int childCount = nodes.getLength();
int childElementCount = 0;
for (int i = 0; i < childCount; i++) {
Node child = nodes.item(i);
if (child.getNodeType() == Node.ELEMENT_NODE) {
childElementCount++;
}
}
return childElementCount;
}
private static Object getElementAsObject(Node node, boolean removeNamespace) {
int childElementCount = getChildElementCount(node);
if (childElementCount == 0) {
return StringUtils.trimToNull(node.getTextContent());
}
Map map = new LinkedHashMap<>(childElementCount);
NodeList nodes = node.getChildNodes();
int childCount = nodes.getLength();
for (int i = 0; i < childCount; i++) {
Node child = nodes.item(i);
if (child.getNodeType() != Node.ELEMENT_NODE) {
continue;
}
String childName = removeNamespace
? child.getNodeName().replaceFirst("(^.*:)", "") : child.getNodeName();
Object childValue = toObject(child, removeNamespace);
// auto detect repeating elements
if (map.containsKey(childName)) {
Object temp = map.get(childName);
if (temp instanceof List) {
List list = (List) temp;
list.add(childValue);
} else {
List list = new ArrayList(childCount);
map.put(childName, list);
list.add(temp);
list.add(childValue);
}
} else {
map.put(childName, childValue);
}
}
return map;
}
public static Object toObject(Node node) {
return toObject(node, false);
}
public static Object toObject(Node node, boolean removeNamespace) {
if (node.getNodeType() == Node.DOCUMENT_NODE) {
Map map = new LinkedHashMap<>(1);
node = node.getFirstChild();
if (node == null) {
return map;
}
while (node.getNodeType() != Node.ELEMENT_NODE) { // ignore comments etc
node = node.getNextSibling();
}
String name = removeNamespace
? node.getNodeName().replaceFirst("(^.*:)", "") : node.getNodeName();
map.put(name, toObject(node, removeNamespace));
return map;
}
Object value = getElementAsObject(node, removeNamespace);
if (node.hasAttributes()) {
Map attribs = getAttributes(node);
if (removeNamespace) {
attribs.keySet().removeIf(key -> "xmlns".equals(key) || key.startsWith("xmlns:"));
}
if (attribs.size() > 0) {
Map wrapper = new LinkedHashMap<>(2);
wrapper.put("_", value);
wrapper.put("@", attribs);
return wrapper;
} else {
//namespaces were the only attributes
return value;
}
} else {
return value;
}
}
public static Document fromMap(Map map) {
Map.Entry first = map.entrySet().iterator().next();
return fromObject(first.getKey(), first.getValue());
}
public static Document fromObject(String name, Object o) {
Document doc = newDocument();
List list = fromObject(doc, name, o);
Element root = list.get(0);
doc.appendChild(root);
return doc;
}
public static List fromObject(Document doc, String name, Object o) {
if (o instanceof Map) {
Map map = (Map) o;
Map attribs = (Map) map.get("@");
Object value = map.get("_");
if (value != null || attribs != null) {
List elements = fromObject(doc, name, value);
addAttributes(elements.get(0), attribs);
return elements;
} else {
Element element = createElement(doc, name, null, null);
for (Map.Entry entry : map.entrySet()) {
String childName = entry.getKey();
Object childValue = entry.getValue();
List childNodes = fromObject(doc, childName, childValue);
for (Element e : childNodes) {
element.appendChild(e);
}
}
return Collections.singletonList(element);
}
} else if (o instanceof List) {
List list = (List) o;
List elements = new ArrayList(list.size());
for (Object child : list) {
List childNodes = fromObject(doc, name, child);
for (Element e : childNodes) {
elements.add(e);
}
}
return elements;
} else {
String value = o == null ? null : o.toString();
Element element = createElement(doc, name, value, null);
return Collections.singletonList(element);
}
}
public static Document newDocument() {
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
DocumentBuilder builder;
try {
builder = factory.newDocumentBuilder();
} catch (Exception e) {
throw new RuntimeException(e);
}
return builder.newDocument();
}
public static void addAttributes(Element element, Map map) {
if (map != null) {
for (Map.Entry entry : map.entrySet()) {
Object attrValue = entry.getValue();
element.setAttribute(entry.getKey(), attrValue == null ? null : attrValue.toString());
}
}
}
public static Element createElement(Node node, String name, String value, Map attributes) {
Document doc = node.getNodeType() == Node.DOCUMENT_NODE ? (Document) node : node.getOwnerDocument();
Element element = doc.createElement(name);
element.setTextContent(value);
addAttributes(element, attributes);
return element;
}
public static Document toNewDocument(Node in) {
Document doc = newDocument();
Node node = doc.importNode(in, true);
doc.appendChild(node);
return doc;
}
public static Document fromJavaObject(Object o) {
return fromObject("root", Json.of(o).value()); // keep it simple for people to write generic xpath starting with /root
}
public static String toXml(Object o) {
return toString(fromJavaObject(o));
}
public static boolean isXml(String s) {
if (s == null || s.isEmpty()) {
return false;
}
if (s.charAt(0) == ' ') {
s = s.trim();
if (s.isEmpty()) {
return false;
}
}
return s.charAt(0) == '<';
}
}
