1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.config.application;
import com.yahoo.config.application.api.ApplicationPackage;
import com.yahoo.io.reader.NamedReader;
import java.util.logging.Level;
import com.yahoo.path.Path;
import com.yahoo.text.XML;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import java.io.*;
import javax.xml.transform.dom.DOMResult;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import java.util.ArrayList;
import java.util.List;
import java.util.logging.Logger;
/**
* Utilities for XML.
*
* @author hmusum
*/
public class Xml {
private static final Logger log = Logger.getLogger(Xml.class.getPackage().toString());
// Access to this needs to be synchronized (as it is in getDocumentBuilder() below)
private static final DocumentBuilderFactory factory = createDocumentBuilderFactory();
public static Document getDocument(Reader reader) {
try {
return getDocumentBuilder().parse(new InputSource(reader));
} catch (SAXException | IOException e) {
throw new IllegalArgumentException(e);
}
}
private static DocumentBuilderFactory createDocumentBuilderFactory() {
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
factory.setNamespaceAware(true);
factory.setXIncludeAware(false);
try {
// XXE prevention
factory.setFeature("http://xml.org/sax/features/external-general-entities", false);
factory.setFeature("http://xml.org/sax/features/external-parameter-entities", false);
factory.setFeature("http://apache.org/xml/features/nonvalidating/load-external-dtd", false);
return factory;
} catch (ParserConfigurationException e) {
log.log(Level.SEVERE, "Could not initialize XML parser", e);
throw new RuntimeException(e);
}
}
/**
* Creates a new XML document builder.
*
* @return a new DocumentBuilder instance, or null if we fail to get one.
*/
private static synchronized DocumentBuilder getDocumentBuilder() {
try {
return factory.newDocumentBuilder();
} catch (ParserConfigurationException e) {
log.log(Level.WARNING, "No XML parser available - " + e);
return null;
}
}
static DocumentBuilder getPreprocessDocumentBuilder() throws ParserConfigurationException {
DocumentBuilderFactory factory = createDocumentBuilderFactory();
factory.setValidating(false);
return factory.newDocumentBuilder();
}
static Document copyDocument(Document input) throws TransformerException {
Transformer transformer = TransformerFactory.newInstance().newTransformer();
DOMSource source = new DOMSource(input);
DOMResult result = new DOMResult();
transformer.transform(source, result);
return (Document) result.getNode();
}
static String documentAsString(Document document, boolean prettyPrint) throws TransformerException {
Transformer transformer = TransformerFactory.newInstance().newTransformer();
if (prettyPrint) {
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
} else {
transformer.setOutputProperty(OutputKeys.INDENT, "no");
}
StringWriter writer = new StringWriter();
transformer.transform(new DOMSource(document), new StreamResult(writer));
String[] lines = writer.toString().split("\n");
var b = new StringBuilder();
for (String line : lines)
if ( ! line.isBlank())
b.append(line).append("\n");
return b.toString();
}
static String documentAsString(Document document) throws TransformerException {
return documentAsString(document, false);
}
/**
* Utility method to get an XML element from a reader.
*
* @param reader the {@link Reader} to get an xml element from
*/
public static Element getElement(Reader reader) {
return XML.getDocument(reader).getDocumentElement();
}
/** Returns the root element of each xml file under pathFromAppRoot/ in the app package. */
public static List<Element> allElemsFromPath(ApplicationPackage app, String pathFromAppRoot) {
List<Element> ret = new ArrayList<>();
List<NamedReader> files = null;
try {
files = app.getFiles(Path.fromString(pathFromAppRoot), ".xml", true);
for (NamedReader reader : files)
ret.add(getElement(reader));
} finally {
NamedReader.closeAll(files);
}
return ret;
}
/**
* Will get all sub-elements under parent named "name", just like XML.getChildren(). Then look under
* pathFromAppRoot/ in the app package for XML files, parse them and append elements of the same name.
*
* @param parent parent XML node
* @param name name of elements to merge
* @param app an {@link ApplicationPackage}
* @param pathFromAppRoot path from application root
* @return list of all sub-elements with given name
*/
public static List<Element> mergeElems(Element parent, String name, ApplicationPackage app, String pathFromAppRoot) {
List<Element> children = XML.getChildren(parent, name);
List<Element> allFromFiles = allElemsFromPath(app, pathFromAppRoot);
for (Element fromFile : allFromFiles) {
children.addAll(XML.getChildren(fromFile, name));
}
return children;
}
}
|
