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.restconf.server.api.DataPatchPath;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.patch.rev170222.yang.patch.yang.patch.Edit.Operation;
  25 import org.opendaylight.yangtools.util.xml.UntrustedXML;
  26 import org.opendaylight.yangtools.yang.common.ErrorTag;
  27 import org.opendaylight.yangtools.yang.common.ErrorType;
  28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  29 import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream;
  30 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  31 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizationResultHolder;
  32 import org.slf4j.Logger;
  33 import org.slf4j.LoggerFactory;
  34 import org.w3c.dom.Document;
  35 import org.w3c.dom.Element;
  36 import org.w3c.dom.Node;
  37 import org.xml.sax.SAXException;
  38
  39 public final class XmlPatchBody extends PatchBody {
  40     private static final Logger LOG = LoggerFactory.getLogger(XmlPatchBody.class);
  41
  42     public XmlPatchBody(final InputStream inputStream) {
  43         super(inputStream);
  44     }
  45
  46     @Override
  47     PatchContext toPatchContext(final DataPatchPath path, final InputStream inputStream) throws IOException {
  48         try {
  49             return parse(path, UntrustedXML.newDocumentBuilder().parse(inputStream));
  50         } catch (XMLStreamException | SAXException | URISyntaxException e) {
  51             LOG.debug("Failed to parse YANG Patch XML", e);
  52             throw new RestconfDocumentedException("Error parsing YANG Patch XML: " + e.getMessage(), ErrorType.PROTOCOL,
  53                 ErrorTag.MALFORMED_MESSAGE, e);
  54         }
  55     }
  56
  57     private static @NonNull PatchContext parse(final DataPatchPath path, final Document doc)
  58             throws XMLStreamException, IOException, SAXException, URISyntaxException {
  59         final var entities = ImmutableList.<PatchEntity>builder();
  60         final var patchId = doc.getElementsByTagName("patch-id").item(0).getFirstChild().getNodeValue();
  61         final var editNodes = doc.getElementsByTagName("edit");
  62         final var databind = path.databind();
  63
  64         for (int i = 0; i < editNodes.getLength(); i++) {
  65             final Element element = (Element) editNodes.item(i);
  66             final String operation = element.getElementsByTagName("operation").item(0).getFirstChild().getNodeValue();
  67             final Operation oper = Operation.ofName(operation);
  68             final String editId = element.getElementsByTagName("edit-id").item(0).getFirstChild().getNodeValue();
  69             final String target = element.getElementsByTagName("target").item(0).getFirstChild().getNodeValue();
  70             final List<Element> values = readValueNodes(element, oper);
  71             final Element firstValueElement = values != null ? values.get(0) : null;
  72
  73             // find complete path to target, it can be also empty (only slash)
  74             final var targetII = parsePatchTarget(path, target);
  75             // move schema node
  76             final var lookup = databind.schemaTree().enterPath(targetII).orElseThrow();
  77
  78             final var stack = lookup.stack();
  79             final var inference = stack.toInference();
  80             if (!stack.isEmpty()) {
  81                 stack.exit();
  82             }
  83
  84             if (requiresValue(oper)) {
  85                 final var resultHolder = new NormalizationResultHolder();
  86                 final var writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
  87                 final var xmlParser = XmlParserStream.create(writer, databind.xmlCodecs(), inference);
  88                 xmlParser.traverse(new DOMSource(firstValueElement));
  89
  90                 final var result = resultHolder.getResult().data();
  91                 // for lists allow to manipulate with list items through their parent
  92                 if (targetII.getLastPathArgument() instanceof NodeIdentifierWithPredicates) {
  93                     entities.add(new PatchEntity(editId, oper, targetII.getParent(), result));
  94                 } else {
  95                     entities.add(new PatchEntity(editId, oper, targetII, result));
  96                 }
  97             } else {
  98                 entities.add(new PatchEntity(editId, oper, targetII));
  99             }
 100         }
 101
 102         return new PatchContext(patchId, entities.build());
 103     }
 104
 105     /**
 106      * Read value nodes.
 107      *
 108      * @param element Element of current edit operation
 109      * @param operation Name of current operation
 110      * @return List of value elements
 111      */
 112     private static List<Element> readValueNodes(final @NonNull Element element, final @NonNull Operation operation) {
 113         final Node valueNode = element.getElementsByTagName("value").item(0);
 114
 115         final boolean isWithValue = requiresValue(operation);
 116         if (isWithValue && valueNode == null) {
 117             throw new RestconfDocumentedException("Error parsing input",
 118                     ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 119         }
 120
 121         if (!isWithValue && valueNode != null) {
 122             throw new RestconfDocumentedException("Error parsing input",
 123                     ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
 124         }
 125
 126         if (valueNode == null) {
 127             return null;
 128         }
 129
 130         final var result = new ArrayList<Element>();
 131         final var childNodes = valueNode.getChildNodes();
 132         for (int i = 0; i < childNodes.getLength(); i++) {
 133             if (childNodes.item(i) instanceof Element childElement) {
 134                 result.add(childElement);
 135             }
 136         }
 137
 138         return result;
 139     }
 140 }