aboutsummaryrefslogtreecommitdiffstats
path: root/searchlib/src/main/java/com/yahoo/searchlib/gbdt/XmlHelper.java
blob: d50a2e9773d9786e8f49a8ef6b2c8f513f2631d0 (plain) (blame)
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
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.searchlib.gbdt;

import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import java.io.ByteArrayInputStream;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.Charset;
import java.util.LinkedList;
import java.util.List;
import java.util.Optional;

/**
 * @author Simon Thoresen Hult
 */
abstract class XmlHelper {

    private static final Charset UTF8 = Charset.forName("UTF-8");

    public static Element parseXml(String xml)
            throws ParserConfigurationException, IOException, SAXException
    {
        return parseXmlStream(new ByteArrayInputStream(xml.getBytes(UTF8)));
    }

    public static Element parseXmlFile(String fileName)
            throws ParserConfigurationException, IOException, SAXException
    {
        return parseXmlStream(new FileInputStream(fileName));
    }

    public static Element parseXmlStream(InputStream in)
            throws ParserConfigurationException, IOException, SAXException
    {
        DocumentBuilderFactory factory = createDocumentBuilderFactory();
        DocumentBuilder builder = factory.newDocumentBuilder();
        Document doc = builder.parse(in);
        return doc.getDocumentElement();
    }

    private static DocumentBuilderFactory createDocumentBuilderFactory() throws ParserConfigurationException {
        DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
        factory.setNamespaceAware(true);
        factory.setXIncludeAware(false);

        // 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;
    }

    public static String getAttributeText(Node node, String name) {
        Node valueNode = node.getAttributes().getNamedItem(name);
        if (valueNode == null) {
            throw new IllegalArgumentException("Missing '" + name + "' attribute in element '" +
                                               node.getNodeName() + "'.");
        }
        String valueText = valueNode.getTextContent();
        if (valueText == null || valueText.isEmpty()) {
            throw new IllegalArgumentException("Attribute '" + name + "' in element '" +
                                               node.getNodeName() + "' is empty.");
        }
        return valueText;
    }

    public static String getAttributeTextOrNull(Node node, String name) {
        Node valueNode = node.getAttributes().getNamedItem(name);
        if (valueNode == null) return null;
        return valueNode.getTextContent();
    }

    public static Optional<String> getOptionalAttributeText(Node node, String name) {
        Node valueNode = node.getAttributes().getNamedItem(name);
        if (valueNode == null) return Optional.empty();
        return Optional.of(valueNode.getTextContent());
    }

    public static Element getSingleElement(Node node, String name) {
        List<Element> children = getChildElements(node, name);
        if (children.isEmpty()) {
            if (name != null) {
                throw new IllegalArgumentException("Node '" + node.getNodeName() + "' has no '" + name + "' children.");
            } else {
                throw new IllegalArgumentException("Node '" + node.getNodeName() + "' has no children.");
            }
        }
        if (children.size() != 1) {
            if (name != null) {
                throw new IllegalArgumentException("Expected 1 '" + name + "' child, got " + children.size() + ".");
            } else {
                throw new IllegalArgumentException("Expected 1 child, got " + children.size() + ".");
            }
        }
        return children.get(0);
    }

    public static List<Element> getChildElements(Node node, String name) {
        NodeList children = node.getChildNodes();
        List<Element> lst = new LinkedList<>();
        for (int i = 0, len = children.getLength(); i < len; ++i) {
            Node child = children.item(i);
            if (!(child instanceof Element)) {
                continue;
            }
            if (name != null && !child.getNodeName().equalsIgnoreCase(name)) {
                continue;
            }
            lst.add((Element)child);
        }
        return lst;
    }
}