restconf/restconf-nb/src/main/java/org/opendaylight/restconf/nb/rfc8040/databind/XmlPatchBody.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
   3  * Copyright (c) 2023 PANTHEON.tech, s.r.o.
   4  *
   5  * This program and the accompanying materials are made available under the
   6  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   7  * and is available at http://www.eclipse.org/legal/epl-v10.html
   8  */
   9 package org.opendaylight.restconf.nb.rfc8040.databind;
  10
  11 import com.google.common.collect.ImmutableList;
  12 import java.io.IOException;
  13 import java.io.InputStream;
  14 import java.net.URISyntaxException;
  15 import java.util.ArrayList;
  16 import java.util.List;
  17 import javax.xml.stream.XMLStreamException;
  18 import javax.xml.transform.dom.DOMSource;
  19 import org.eclipse.jdt.annotation.NonNull;
  20 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  21 import org.opendaylight.restconf.common.patch.PatchContext;
  22 import org.opendaylight.restconf.common.patch.PatchEntity;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.patch.rev170222.yang.patch.yang.patch.Edit.Operation;
  24 import org.opendaylight.yangtools.util.xml.UntrustedXML;
  25 import org.opendaylight.yangtools.yang.common.ErrorTag;
  26 import org.opendaylight.yangtools.yang.common.ErrorType;
  27 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  29 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  30 import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream;
  31 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  32 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizationResultHolder;
  33 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
  34 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37 import org.w3c.dom.Document;
  38 import org.w3c.dom.Element;
  39 import org.w3c.dom.Node;
  40 import org.xml.sax.SAXException;
  41
  42 public final class XmlPatchBody extends PatchBody {
  43     private static final Logger LOG = LoggerFactory.getLogger(XmlPatchBody.class);
  44
  45     public XmlPatchBody(final InputStream inputStream) {
  46         super(inputStream);
  47     }
  48
  49     @Override
  50     PatchContext toPatchContext(final EffectiveModelContext context, final YangInstanceIdentifier urlPath,
  51             final InputStream inputStream) throws IOException {
  52         try {
  53             return parse(context, urlPath, UntrustedXML.newDocumentBuilder().parse(inputStream));
  54         } catch (XMLStreamException | SAXException | URISyntaxException e) {
  55             LOG.debug("Failed to parse YANG Patch XML", e);
  56             throw new RestconfDocumentedException("Error parsing YANG Patch XML: " + e.getMessage(), ErrorType.PROTOCOL,
  57                 ErrorTag.MALFORMED_MESSAGE, e);
  58         }
  59     }
  60
  61     private static @NonNull PatchContext parse(final EffectiveModelContext context,
  62             final YangInstanceIdentifier urlPath, final Document doc)
  63                 throws XMLStreamException, IOException, SAXException, URISyntaxException {
  64         final var entities = ImmutableList.<PatchEntity>builder();
  65         final var patchId = doc.getElementsByTagName("patch-id").item(0).getFirstChild().getNodeValue();
  66         final var editNodes = doc.getElementsByTagName("edit");
  67         final var schemaTree = DataSchemaContextTree.from(context);
  68
  69         for (int i = 0; i < editNodes.getLength(); i++) {
  70             final Element element = (Element) editNodes.item(i);
  71             final String operation = element.getElementsByTagName("operation").item(0).getFirstChild().getNodeValue();
  72             final Operation oper = Operation.ofName(operation);
  73             final String editId = element.getElementsByTagName("edit-id").item(0).getFirstChild().getNodeValue();
  74             final String target = element.getElementsByTagName("target").item(0).getFirstChild().getNodeValue();
  75             final List<Element> values = readValueNodes(element, oper);
  76             final Element firstValueElement = values != null ? values.get(0) : null;
  77
  78             // find complete path to target, it can be also empty (only slash)
  79             final var targetII = parsePatchTarget(context, urlPath, target);
  80             // move schema node
  81             final var lookup = schemaTree.enterPath(targetII).orElseThrow();
  82
  83             final var stack = lookup.stack();
  84             final var inference = stack.toInference();
  85             if (!stack.isEmpty()) {
  86                 stack.exit();
  87             }
  88
  89             if (requiresValue(oper)) {
  90                 final NormalizationResultHolder resultHolder = new NormalizationResultHolder();
  91                 final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
  92                 final XmlParserStream xmlParser = XmlParserStream.create(writer, inference);
  93                 xmlParser.traverse(new DOMSource(firstValueElement));
  94
  95                 final var result = resultHolder.getResult().data();
  96                 // for lists allow to manipulate with list items through their parent
  97                 if (targetII.getLastPathArgument() instanceof NodeIdentifierWithPredicates) {
  98                     entities.add(new PatchEntity(editId, oper, targetII.getParent(), result));
  99                 } else {
 100                     entities.add(new PatchEntity(editId, oper, targetII, result));
 101                 }
 102             } else {
 103                 entities.add(new PatchEntity(editId, oper, targetII));
 104             }
 105         }
 106
 107         return new PatchContext(patchId, entities.build());
 108     }
 109
 110     /**
 111      * Read value nodes.
 112      *
 113      * @param element Element of current edit operation
 114      * @param operation Name of current operation
 115      * @return List of value elements
 116      */
 117     private static List<Element> readValueNodes(final @NonNull Element element, final @NonNull Operation operation) {
 118         final Node valueNode = element.getElementsByTagName("value").item(0);
 119
 120         final boolean isWithValue = requiresValue(operation);
 121         if (isWithValue && valueNode == null) {
 122             throw new RestconfDocumentedException("Error parsing input",
 123                     ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 124         }
 125
 126         if (!isWithValue && valueNode != null) {
 127             throw new RestconfDocumentedException("Error parsing input",
 128                     ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 129         }
 130
 131         if (valueNode == null) {
 132             return null;
 133         }
 134
 135         final var result = new ArrayList<Element>();
 136         final var childNodes = valueNode.getChildNodes();
 137         for (int i = 0; i < childNodes.getLength(); i++) {
 138             if (childNodes.item(i) instanceof Element childElement) {
 139                 result.add(childElement);
 140             }
 141         }
 142
 143         return result;
 144     }
 145 }