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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2022 Deutsche Telekom AG
* ================================================================================
* 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.
*
* SPDX-License-Identifier: Apache-2.0
* ============LICENSE_END=========================================================
*/
package org.onap.cps.utils;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.StringWriter;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.xml.XMLConstants;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import lombok.AccessLevel;
import lombok.NoArgsConstructor;
import org.onap.cps.spi.exceptions.DataValidationException;
import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
import org.opendaylight.yangtools.yang.model.api.SchemaContext;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.xml.sax.SAXException;
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public class XmlFileUtils {
private static final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
private static boolean isNewDocumentBuilderFactoryInstance = true;
private static final Pattern XPATH_PROPERTY_REGEX =
Pattern.compile("\\[@(\\S{1,100})=['\\\"](\\S{1,100})['\\\"]\\]");
/**
* Prepare XML content.
*
* @param xmlContent XML content sent to store
* @param schemaContext schema context
*
* @return XML content wrapped by root node (if needed)
*/
public static String prepareXmlContent(final String xmlContent, final SchemaContext schemaContext)
throws IOException, ParserConfigurationException, TransformerException, SAXException {
return addRootNodeToXmlContent(xmlContent, schemaContext.getModules().iterator().next().getName(),
YangUtils.DATA_ROOT_NODE_NAMESPACE);
}
/**
* Prepare XML content.
*
* @param xmlContent XML content sent to store
* @param parentSchemaNode Parent schema node
* @param xpath Parent xpath
*
* @return XML content wrapped by root node (if needed)
*/
public static String prepareXmlContent(final String xmlContent,
final DataSchemaNode parentSchemaNode,
final String xpath)
throws IOException, ParserConfigurationException, TransformerException, SAXException {
final String namespace = parentSchemaNode.getQName().getNamespace().toString();
final String parentXpathPart = xpath.substring(xpath.lastIndexOf('/') + 1);
final Matcher regexMatcher = XPATH_PROPERTY_REGEX.matcher(parentXpathPart);
if (regexMatcher.find()) {
final HashMap<String, String> rootNodePropertyMap = new HashMap<>();
rootNodePropertyMap.put(regexMatcher.group(1), regexMatcher.group(2));
return addRootNodeToXmlContent(xmlContent, parentSchemaNode.getQName().getLocalName(), namespace,
rootNodePropertyMap);
}
return addRootNodeToXmlContent(xmlContent, parentSchemaNode.getQName().getLocalName(), namespace);
}
private static String addRootNodeToXmlContent(final String xmlContent,
final String rootNodeTagName,
final String namespace,
final Map<String, String> rootNodeProperty)
throws IOException, SAXException, ParserConfigurationException, TransformerException {
final DocumentBuilder documentBuilder = getDocumentBuilderFactory().newDocumentBuilder();
final StringBuilder xmlStringBuilder = new StringBuilder();
xmlStringBuilder.append(xmlContent);
final Document document = documentBuilder.parse(
new ByteArrayInputStream(xmlStringBuilder.toString().getBytes(StandardCharsets.UTF_8)));
final Element root = document.getDocumentElement();
if (!root.getTagName().equals(rootNodeTagName)
&& !root.getTagName().equals(YangUtils.DATA_ROOT_NODE_TAG_NAME)) {
final Document documentWithRootNode = addDataRootNode(root, rootNodeTagName, namespace, rootNodeProperty);
documentWithRootNode.setXmlStandalone(true);
final TransformerFactory transformerFactory = TransformerFactory.newInstance();
transformerFactory.setAttribute(XMLConstants.ACCESS_EXTERNAL_DTD, "");
transformerFactory.setAttribute(XMLConstants.ACCESS_EXTERNAL_STYLESHEET, "");
final Transformer transformer = transformerFactory.newTransformer();
final StringWriter stringWriter = new StringWriter();
transformer.transform(new DOMSource(documentWithRootNode), new StreamResult(stringWriter));
return stringWriter.toString();
}
return xmlContent;
}
/**
* Add root node to XML content.
*
* @param xmlContent XML content to add root node into
* @param rootNodeTagName Root node tag name
* @return XML content with root node tag added (if needed)
*/
public static String addRootNodeToXmlContent(final String xmlContent,
final String rootNodeTagName,
final String namespace)
throws IOException, ParserConfigurationException, TransformerException, SAXException {
return addRootNodeToXmlContent(xmlContent, rootNodeTagName, namespace, new HashMap<>());
}
/**
* Add root node into DOM element.
*
* @param node DOM element to add root node into
* @param tagName Root tag name to add
* @return DOM element with a root node
*/
static Document addDataRootNode(final Element node,
final String tagName,
final String namespace,
final Map<String, String> rootNodeProperty) {
try {
final DocumentBuilder documentBuilder = getDocumentBuilderFactory().newDocumentBuilder();
final Document document = documentBuilder.newDocument();
final Element rootElement = document.createElementNS(namespace, tagName);
for (final Map.Entry<String, String> entry : rootNodeProperty.entrySet()) {
final Element propertyElement = document.createElement(entry.getKey());
propertyElement.setTextContent(entry.getValue());
rootElement.appendChild(propertyElement);
}
rootElement.appendChild(document.adoptNode(node));
document.appendChild(rootElement);
return document;
} catch (final ParserConfigurationException exception) {
throw new DataValidationException("Can't parse XML", "XML can't be parsed", exception);
}
}
private static DocumentBuilderFactory getDocumentBuilderFactory() {
if (isNewDocumentBuilderFactoryInstance) {
documentBuilderFactory.setAttribute(XMLConstants.ACCESS_EXTERNAL_DTD, "");
documentBuilderFactory.setAttribute(XMLConstants.ACCESS_EXTERNAL_SCHEMA, "");
isNewDocumentBuilderFactoryInstance = false;
}
return documentBuilderFactory;
}
}
|
