cps-service/src/main/java/org/onap/cps/utils/XmlFileUtils.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2022 Deutsche Telekom AG
   4  *  Modifications Copyright (C) 2023 Nordix Foundation.
   5  *  ================================================================================
   6  *  Licensed under the Apache License, Version 2.0 (the "License");
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  *
  18  *  SPDX-License-Identifier: Apache-2.0
  19  *  ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.cps.utils;
  23
  24 import java.io.ByteArrayInputStream;
  25 import java.io.IOException;
  26 import java.io.StringWriter;
  27 import java.nio.charset.StandardCharsets;
  28 import java.util.HashMap;
  29 import java.util.Map;
  30 import java.util.regex.Matcher;
  31 import java.util.regex.Pattern;
  32 import javax.xml.XMLConstants;
  33 import javax.xml.parsers.DocumentBuilder;
  34 import javax.xml.parsers.DocumentBuilderFactory;
  35 import javax.xml.parsers.ParserConfigurationException;
  36 import javax.xml.transform.Transformer;
  37 import javax.xml.transform.TransformerException;
  38 import javax.xml.transform.TransformerFactory;
  39 import javax.xml.transform.dom.DOMSource;
  40 import javax.xml.transform.stream.StreamResult;
  41 import lombok.AccessLevel;
  42 import lombok.NoArgsConstructor;
  43 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  44 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  45 import org.w3c.dom.Document;
  46 import org.w3c.dom.Element;
  47 import org.xml.sax.SAXException;
  48
  49 @NoArgsConstructor(access = AccessLevel.PRIVATE)
  50 public class XmlFileUtils {
  51
  52     private static final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
  53     private static boolean isNewDocumentBuilderFactoryInstance = true;
  54     private static final TransformerFactory transformerFactory = TransformerFactory.newInstance();
  55     private static boolean isNewTransformerFactoryInstance = true;
  56     private static final Pattern XPATH_PROPERTY_REGEX =
  57         Pattern.compile("\\[@(\\S{1,100})=['\\\"](\\S{1,100})['\\\"]\\]");
  58
  59     /**
  60      * Prepare XML content.
  61      *
  62      * @param xmlContent XML content sent to store
  63      * @param schemaContext schema context
  64      *
  65      * @return XML content wrapped by root node (if needed)
  66      */
  67     public static String prepareXmlContent(final String xmlContent, final SchemaContext schemaContext)
  68         throws IOException, ParserConfigurationException, TransformerException, SAXException {
  69         return addRootNodeToXmlContent(xmlContent, schemaContext.getModules().iterator().next().getName(),
  70                 YangUtils.DATA_ROOT_NODE_NAMESPACE);
  71     }
  72
  73     /**
  74      * Prepare XML content.
  75      *
  76      * @param xmlContent XML content sent to store
  77      * @param parentSchemaNode Parent schema node
  78      * @param xpath Parent xpath
  79      *
  80      * @return XML content wrapped by root node (if needed)
  81      */
  82     public static String prepareXmlContent(final String xmlContent,
  83                                            final DataSchemaNode parentSchemaNode,
  84                                            final String xpath)
  85         throws IOException, ParserConfigurationException, TransformerException, SAXException {
  86         final String namespace = parentSchemaNode.getQName().getNamespace().toString();
  87         final String parentXpathPart = xpath.substring(xpath.lastIndexOf('/') + 1);
  88         final Matcher regexMatcher = XPATH_PROPERTY_REGEX.matcher(parentXpathPart);
  89         if (regexMatcher.find()) {
  90             final HashMap<String, String> rootNodePropertyMap = new HashMap<>();
  91             rootNodePropertyMap.put(regexMatcher.group(1), regexMatcher.group(2));
  92             return addRootNodeToXmlContent(xmlContent, parentSchemaNode.getQName().getLocalName(), namespace,
  93                     rootNodePropertyMap);
  94         }
  95
  96         return addRootNodeToXmlContent(xmlContent, parentSchemaNode.getQName().getLocalName(), namespace);
  97     }
  98
  99     private static String addRootNodeToXmlContent(final String xmlContent,
 100                                                  final String rootNodeTagName,
 101                                                  final String namespace,
 102                                                  final Map<String, String> rootNodeProperty)
 103         throws IOException, SAXException, ParserConfigurationException, TransformerException {
 104         final DocumentBuilder documentBuilder = getDocumentBuilderFactory().newDocumentBuilder();
 105         final Document document =
 106             documentBuilder.parse(new ByteArrayInputStream(xmlContent.getBytes(StandardCharsets.UTF_8)));
 107         final Element root = document.getDocumentElement();
 108         if (!root.getTagName().equals(rootNodeTagName)
 109             && !root.getTagName().equals(YangUtils.DATA_ROOT_NODE_TAG_NAME)) {
 110             final Document documentWithRootNode = addDataRootNode(root, rootNodeTagName, namespace, rootNodeProperty);
 111             documentWithRootNode.setXmlStandalone(true);
 112             final Transformer transformer = getTransformerFactory().newTransformer();
 113             final StringWriter stringWriter = new StringWriter();
 114             transformer.transform(new DOMSource(documentWithRootNode), new StreamResult(stringWriter));
 115             return stringWriter.toString();
 116         }
 117         return xmlContent;
 118     }
 119
 120     /**
 121      * Add root node to XML content.
 122      *
 123      * @param xmlContent XML content to add root node into
 124      * @param rootNodeTagName Root node tag name
 125      * @return XML content with root node tag added (if needed)
 126      */
 127     public static String addRootNodeToXmlContent(final String xmlContent,
 128                                                  final String rootNodeTagName,
 129                                                  final String namespace)
 130         throws IOException, ParserConfigurationException, TransformerException, SAXException {
 131         return addRootNodeToXmlContent(xmlContent, rootNodeTagName, namespace, new HashMap<>());
 132     }
 133
 134     /**
 135      * Add root node into DOM element.
 136      *
 137      * @param node DOM element to add root node into
 138      * @param tagName Root tag name to add
 139      * @return DOM element with a root node
 140      */
 141     static Document addDataRootNode(final Element node,
 142                                     final String tagName,
 143                                     final String namespace,
 144                                     final Map<String, String> rootNodeProperty)
 145         throws ParserConfigurationException {
 146         final DocumentBuilder documentBuilder = getDocumentBuilderFactory().newDocumentBuilder();
 147         final Document document = documentBuilder.newDocument();
 148         final Element rootElement = document.createElementNS(namespace, tagName);
 149         for (final Map.Entry<String, String> entry : rootNodeProperty.entrySet()) {
 150             final Element propertyElement = document.createElement(entry.getKey());
 151             propertyElement.setTextContent(entry.getValue());
 152             rootElement.appendChild(propertyElement);
 153         }
 154         rootElement.appendChild(document.adoptNode(node));
 155         document.appendChild(rootElement);
 156         return document;
 157     }
 158
 159     private static DocumentBuilderFactory getDocumentBuilderFactory() {
 160
 161         if (isNewDocumentBuilderFactoryInstance) {
 162             documentBuilderFactory.setAttribute(XMLConstants.ACCESS_EXTERNAL_DTD, "");
 163             documentBuilderFactory.setAttribute(XMLConstants.ACCESS_EXTERNAL_SCHEMA, "");
 164             isNewDocumentBuilderFactoryInstance = false;
 165         }
 166
 167         return documentBuilderFactory;
 168     }
 169
 170     private static TransformerFactory getTransformerFactory() {
 171
 172         if (isNewTransformerFactoryInstance) {
 173             transformerFactory.setAttribute(XMLConstants.ACCESS_EXTERNAL_DTD, "");
 174             transformerFactory.setAttribute(XMLConstants.ACCESS_EXTERNAL_STYLESHEET, "");
 175             isNewTransformerFactoryInstance = false;
 176         }
 177
 178         return transformerFactory;
 179     }
 180 }