/*
* ============LICENSE_START=======================================================
- * Copyright (C) 2020-2022 Nordix Foundation
+ * Copyright (C) 2020-2024 Nordix Foundation
* Modifications Copyright (C) 2021 Bell Canada.
* Modifications Copyright (C) 2021 Pantheon.tech
* Modifications Copyright (C) 2022 TechMahindra Ltd.
package org.onap.cps.utils;
-import com.google.gson.JsonSyntaxException;
-import com.google.gson.stream.JsonReader;
-import java.io.IOException;
-import java.io.StringReader;
-import java.net.URISyntaxException;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Collection;
import java.util.Collections;
-import java.util.HashMap;
-import java.util.Iterator;
import java.util.List;
-import java.util.Map;
-import java.util.Optional;
import java.util.stream.Collectors;
-import javax.xml.stream.XMLInputFactory;
-import javax.xml.stream.XMLStreamException;
-import javax.xml.stream.XMLStreamReader;
import lombok.AccessLevel;
import lombok.NoArgsConstructor;
-import lombok.extern.slf4j.Slf4j;
-import org.onap.cps.spi.exceptions.DataValidationException;
-import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
-import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
-import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
-import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
-import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
-import org.opendaylight.yangtools.yang.data.api.schema.builder.DataContainerNodeBuilder;
-import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
-import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactory;
-import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactorySupplier;
-import org.opendaylight.yangtools.yang.data.codec.gson.JsonParserStream;
-import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream;
-import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
-import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
-import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
-import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
-import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
-import org.opendaylight.yangtools.yang.model.api.EffectiveStatementInference;
-import org.opendaylight.yangtools.yang.model.api.SchemaContext;
-import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
-import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
-import org.xml.sax.SAXException;
-@Slf4j
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public class YangUtils {
- private static final String XPATH_DELIMITER_REGEX = "\\/";
- private static final String XPATH_NODE_KEY_ATTRIBUTES_REGEX = "\\[.*?\\]";
-
- /**
- * Parses data into Collection of NormalizedNode according to given schema context.
- *
- * @param nodeData data string
- * @param schemaContext schema context describing associated data model
- * @return the NormalizedNode object
- */
- public static ContainerNode parseData(final ContentType contentType, final String nodeData,
- final SchemaContext schemaContext) {
- if (contentType == ContentType.JSON) {
- return parseJsonData(nodeData, schemaContext, Optional.empty());
- }
- return parseXmlData(XmlFileUtils.prepareXmlContent(nodeData, schemaContext), schemaContext,
- Optional.empty());
- }
-
- /**
- * Parses data into NormalizedNode according to given schema context.
- *
- * @param nodeData data string
- * @param schemaContext schema context describing associated data model
- * @return the NormalizedNode object
- */
- public static ContainerNode parseData(final ContentType contentType, final String nodeData,
- final SchemaContext schemaContext, final String parentNodeXpath) {
- final DataSchemaNode parentSchemaNode =
- (DataSchemaNode) getDataSchemaNodeAndIdentifiersByXpath(parentNodeXpath, schemaContext)
- .get("dataSchemaNode");
- final Collection<QName> dataSchemaNodeIdentifiers =
- (Collection<QName>) getDataSchemaNodeAndIdentifiersByXpath(parentNodeXpath, schemaContext)
- .get("dataSchemaNodeIdentifiers");
- if (contentType == ContentType.JSON) {
- return parseJsonData(nodeData, schemaContext, Optional.of(dataSchemaNodeIdentifiers));
- }
- return parseXmlData(XmlFileUtils.prepareXmlContent(nodeData, parentSchemaNode, parentNodeXpath), schemaContext,
- Optional.of(dataSchemaNodeIdentifiers));
- }
-
- /**
- * Parses data into Collection of NormalizedNode according to given schema context.
- *
- * @param jsonData json data as string
- * @param schemaContext schema context describing associated data model
- * @return the Collection of NormalizedNode object
- */
- public static ContainerNode parseJsonData(final String jsonData, final SchemaContext schemaContext) {
- return parseJsonData(jsonData, schemaContext, Optional.empty());
- }
-
- /**
- * Parses jsonData into Collection of NormalizedNode according to given schema context.
- *
- * @param jsonData json data fragment as string
- * @param schemaContext schema context describing associated data model
- * @param parentNodeXpath the xpath referencing the parent node current data fragment belong to
- * @return the NormalizedNode object
- */
- public static ContainerNode parseJsonData(final String jsonData, final SchemaContext schemaContext,
- final String parentNodeXpath) {
- final Collection<QName> dataSchemaNodeIdentifiers =
- (Collection<QName>) getDataSchemaNodeAndIdentifiersByXpath(parentNodeXpath, schemaContext)
- .get("dataSchemaNodeIdentifiers");
- return parseJsonData(jsonData, schemaContext, Optional.of(dataSchemaNodeIdentifiers));
- }
-
- private static ContainerNode parseJsonData(final String jsonData, final SchemaContext schemaContext,
- final Optional<Collection<QName>> dataSchemaNodeIdentifiers) {
- final JSONCodecFactory jsonCodecFactory = JSONCodecFactorySupplier.DRAFT_LHOTKA_NETMOD_YANG_JSON_02
- .getShared((EffectiveModelContext) schemaContext);
- final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> dataContainerNodeBuilder =
- Builders.containerBuilder()
- .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(schemaContext.getQName()));
- final NormalizedNodeStreamWriter normalizedNodeStreamWriter = ImmutableNormalizedNodeStreamWriter
- .from(dataContainerNodeBuilder);
- final JsonReader jsonReader = new JsonReader(new StringReader(jsonData));
- final JsonParserStream jsonParserStream;
-
- if (dataSchemaNodeIdentifiers.isPresent()) {
- final EffectiveModelContext effectiveModelContext = ((EffectiveModelContext) schemaContext);
- final EffectiveStatementInference effectiveStatementInference =
- SchemaInferenceStack.of(effectiveModelContext,
- SchemaNodeIdentifier.Absolute.of(dataSchemaNodeIdentifiers.get())).toInference();
- jsonParserStream =
- JsonParserStream.create(normalizedNodeStreamWriter, jsonCodecFactory, effectiveStatementInference);
- } else {
- jsonParserStream = JsonParserStream.create(normalizedNodeStreamWriter, jsonCodecFactory);
- }
-
- try {
- jsonParserStream.parse(jsonReader);
- jsonParserStream.close();
- } catch (final IOException | JsonSyntaxException exception) {
- throw new DataValidationException(
- "Failed to parse json data: " + jsonData, exception.getMessage(), exception);
- } catch (final IllegalStateException | IllegalArgumentException exception) {
- throw new DataValidationException(
- "Failed to parse json data. Unsupported xpath or json data:" + jsonData, exception
- .getMessage(), exception);
- }
- return dataContainerNodeBuilder.build();
- }
-
- private static ContainerNode parseXmlData(final String xmlData, final SchemaContext schemaContext,
- final Optional<Collection<QName>> dataSchemaNodeIdentifiers) {
- final XMLInputFactory factory = XMLInputFactory.newInstance();
- factory.setProperty(XMLInputFactory.SUPPORT_DTD, false);
- final NormalizedNodeResult normalizedNodeResult = new NormalizedNodeResult();
- final NormalizedNodeStreamWriter normalizedNodeStreamWriter = ImmutableNormalizedNodeStreamWriter
- .from(normalizedNodeResult);
-
- final XmlParserStream xmlParser;
- final EffectiveModelContext effectiveModelContext = ((EffectiveModelContext) schemaContext);
-
- if (dataSchemaNodeIdentifiers.isPresent()) {
- final EffectiveStatementInference effectiveStatementInference =
- SchemaInferenceStack.of(effectiveModelContext,
- SchemaNodeIdentifier.Absolute.of(dataSchemaNodeIdentifiers.get())).toInference();
- xmlParser = XmlParserStream.create(normalizedNodeStreamWriter, effectiveStatementInference);
- } else {
- xmlParser = XmlParserStream.create(normalizedNodeStreamWriter, effectiveModelContext);
- }
-
- try {
- final XMLStreamReader reader = factory.createXMLStreamReader(new StringReader(xmlData));
- xmlParser.parse(reader);
- xmlParser.close();
- } catch (final XMLStreamException | URISyntaxException | IOException
- | SAXException | NullPointerException exception) {
- throw new DataValidationException(
- "Failed to parse xml data: " + xmlData, exception.getMessage(), exception);
- }
- final NormalizedNode normalizedNode = getFirstChildXmlRoot(normalizedNodeResult.getResult());
- return Builders.containerBuilder().withChild((DataContainerChild) normalizedNode)
- .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(schemaContext.getQName())).build();
- }
-
/**
* Create an xpath form a Yang Tools NodeIdentifier (i.e. PathArgument).
*
if (nodeIdentifier instanceof YangInstanceIdentifier.NodeIdentifierWithPredicates) {
xpathBuilder.append(getKeyAttributesStatement(
- (YangInstanceIdentifier.NodeIdentifierWithPredicates) nodeIdentifier));
+ (YangInstanceIdentifier.NodeIdentifierWithPredicates) nodeIdentifier));
}
return xpathBuilder.toString();
}
-
private static String getKeyAttributesStatement(
final YangInstanceIdentifier.NodeIdentifierWithPredicates nodeIdentifier) {
final List<String> keyAttributes = nodeIdentifier.entrySet().stream().map(
entry -> {
final String name = entry.getKey().getLocalName();
- final String value = String.valueOf(entry.getValue()).replace("'", "\\'");
+ final String value = String.valueOf(entry.getValue()).replace("'", "''");
return String.format("@%s='%s'", name, value);
}
).collect(Collectors.toList());
}
}
- private static Map<String, Object> getDataSchemaNodeAndIdentifiersByXpath(final String parentNodeXpath,
- final SchemaContext schemaContext) {
- final String[] xpathNodeIdSequence = xpathToNodeIdSequence(parentNodeXpath);
- return findDataSchemaNodeAndIdentifiersByXpathNodeIdSequence(xpathNodeIdSequence, schemaContext.getChildNodes(),
- new ArrayList<>());
- }
-
- private static String[] xpathToNodeIdSequence(final String xpath) {
- final String[] xpathNodeIdSequence = Arrays.stream(xpath
- .replaceAll(XPATH_NODE_KEY_ATTRIBUTES_REGEX, "")
- .split(XPATH_DELIMITER_REGEX))
- .filter(identifier -> !identifier.isEmpty())
- .toArray(String[]::new);
- if (xpathNodeIdSequence.length < 1) {
- throw new DataValidationException("Invalid xpath.", "Xpath contains no node identifiers.");
- }
- return xpathNodeIdSequence;
- }
-
- private static Map<String, Object> findDataSchemaNodeAndIdentifiersByXpathNodeIdSequence(
- final String[] xpathNodeIdSequence,
- final Collection<? extends DataSchemaNode> dataSchemaNodes,
- final Collection<QName> dataSchemaNodeIdentifiers) {
- final String currentXpathNodeId = xpathNodeIdSequence[0];
- final DataSchemaNode currentDataSchemaNode = dataSchemaNodes.stream()
- .filter(dataSchemaNode -> currentXpathNodeId.equals(dataSchemaNode.getQName().getLocalName()))
- .findFirst().orElseThrow(() -> schemaNodeNotFoundException(currentXpathNodeId));
- dataSchemaNodeIdentifiers.add(currentDataSchemaNode.getQName());
- if (xpathNodeIdSequence.length <= 1) {
- final Map<String, Object> dataSchemaNodeAndIdentifiers =
- new HashMap<>();
- dataSchemaNodeAndIdentifiers.put("dataSchemaNode", currentDataSchemaNode);
- dataSchemaNodeAndIdentifiers.put("dataSchemaNodeIdentifiers", dataSchemaNodeIdentifiers);
- return dataSchemaNodeAndIdentifiers;
- }
- if (currentDataSchemaNode instanceof DataNodeContainer) {
- return findDataSchemaNodeAndIdentifiersByXpathNodeIdSequence(
- getNextLevelXpathNodeIdSequence(xpathNodeIdSequence),
- ((DataNodeContainer) currentDataSchemaNode).getChildNodes(),
- dataSchemaNodeIdentifiers);
- }
- throw schemaNodeNotFoundException(xpathNodeIdSequence[1]);
- }
-
- private static String[] getNextLevelXpathNodeIdSequence(final String[] xpathNodeIdSequence) {
- final String[] nextXpathNodeIdSequence = new String[xpathNodeIdSequence.length - 1];
- System.arraycopy(xpathNodeIdSequence, 1, nextXpathNodeIdSequence, 0, nextXpathNodeIdSequence.length);
- return nextXpathNodeIdSequence;
- }
-
- private static DataValidationException schemaNodeNotFoundException(final String schemaNodeIdentifier) {
- return new DataValidationException("Invalid xpath.",
- String.format("No schema node was found for xpath identifier '%s'.", schemaNodeIdentifier));
- }
-
- private static NormalizedNode getFirstChildXmlRoot(final NormalizedNode parent) {
- final String rootNodeType = parent.getIdentifier().getNodeType().getLocalName();
- final Collection<DataContainerChild> children = (Collection<DataContainerChild>) parent.body();
- final Iterator<DataContainerChild> iterator = children.iterator();
- NormalizedNode child = null;
- while (iterator.hasNext()) {
- child = iterator.next();
- if (!child.getIdentifier().getNodeType().getLocalName().equals(rootNodeType)
- && !(child instanceof LeafNode)) {
- return child;
- }
- }
- return getFirstChildXmlRoot(child);
- }
-}
\ No newline at end of file
+}