1 files changed, 313 insertions, 0 deletions
diff --git a/netconf/restconf/restconf-nb-bierman02/src/main/java/org/opendaylight/netconf/sal/rest/impl/XmlToPatchBodyReader.java b/netconf/restconf/restconf-nb-bierman02/src/main/java/org/opendaylight/netconf/sal/rest/impl/XmlToPatchBodyReader.java
new file mode 100644
index 0000000..9cc4766
--- /dev/null
+++ b/netconf/restconf/restconf-nb-bierman02/src/main/java/org/opendaylight/netconf/sal/rest/impl/XmlToPatchBodyReader.java
@@ -0,0 +1,313 @@
+/*
+ * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.netconf.sal.rest.impl;
+
+import static com.google.common.base.Verify.verify;
+
+import com.google.common.base.Splitter;
+import com.google.common.collect.ImmutableList;
+import java.io.IOException;
+import java.io.InputStream;
+import java.lang.annotation.Annotation;
+import java.lang.reflect.Type;
+import java.net.URISyntaxException;
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Locale;
+import java.util.Optional;
+import javax.ws.rs.Consumes;
+import javax.ws.rs.WebApplicationException;
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.MultivaluedMap;
+import javax.ws.rs.ext.MessageBodyReader;
+import javax.ws.rs.ext.Provider;
+import javax.xml.parsers.ParserConfigurationException;
+import javax.xml.stream.XMLStreamException;
+import javax.xml.transform.dom.DOMSource;
+import org.eclipse.jdt.annotation.NonNull;
+import org.opendaylight.netconf.sal.rest.api.Draft02;
+import org.opendaylight.netconf.sal.rest.api.RestconfService;
+import org.opendaylight.netconf.sal.restconf.impl.ControllerContext;
+import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
+import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
+import org.opendaylight.restconf.common.patch.PatchContext;
+import org.opendaylight.restconf.common.patch.PatchEditOperation;
+import org.opendaylight.restconf.common.patch.PatchEntity;
+import org.opendaylight.restconf.common.util.RestUtil;
+import org.opendaylight.yangtools.util.xml.UntrustedXML;
+import org.opendaylight.yangtools.yang.common.ErrorTag;
+import org.opendaylight.yangtools.yang.common.ErrorType;
+import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.common.Revision;
+import org.opendaylight.yangtools.yang.common.XMLNamespace;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
+import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream;
+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.ContainerSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
+import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.Module;
+import org.opendaylight.yangtools.yang.model.api.SchemaNode;
+import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
+import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.Inference;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
+import org.xml.sax.SAXException;
+
+/**
+ * Yang PATCH Reader for XML.
+ *
+ * @deprecated This class will be replaced by XmlToPatchBodyReader from restconf-nb-rfc8040
+ */
+@Deprecated
+@Provider
+@Consumes({Draft02.MediaTypes.PATCH + RestconfService.XML})
+public class XmlToPatchBodyReader extends AbstractIdentifierAwareJaxRsProvider implements
+        MessageBodyReader<PatchContext> {
+
+    private static final Logger LOG = LoggerFactory.getLogger(XmlToPatchBodyReader.class);
+
+    public XmlToPatchBodyReader(final ControllerContext controllerContext) {
+        super(controllerContext);
+    }
+
+    @Override
+    public boolean isReadable(final Class<?> type, final Type genericType,
+                              final Annotation[] annotations, final MediaType mediaType) {
+        return true;
+    }
+
+    @SuppressWarnings("checkstyle:IllegalCatch")
+    @Override
+    public PatchContext readFrom(final Class<PatchContext> type, final Type genericType,
+                                 final Annotation[] annotations, final MediaType mediaType,
+                                 final MultivaluedMap<String, String> httpHeaders, final InputStream entityStream)
+            throws WebApplicationException {
+
+        try {
+            final InstanceIdentifierContext path = getInstanceIdentifierContext();
+            final Optional<InputStream> nonEmptyInputStreamOptional = RestUtil.isInputStreamEmpty(entityStream);
+            if (nonEmptyInputStreamOptional.isEmpty()) {
+                // represent empty nopayload input
+                return new PatchContext(path, null, null);
+            }
+
+            final Document doc = UntrustedXML.newDocumentBuilder().parse(nonEmptyInputStreamOptional.get());
+            return parse(path, doc);
+        } catch (final RestconfDocumentedException e) {
+            throw e;
+        } catch (final Exception e) {
+            LOG.debug("Error parsing xml input", e);
+            RestconfDocumentedException.throwIfYangError(e);
+            throw new RestconfDocumentedException("Error parsing input: " + e.getMessage(), ErrorType.PROTOCOL,
+                    ErrorTag.MALFORMED_MESSAGE, e);
+        }
+    }
+
+    private static PatchContext parse(final InstanceIdentifierContext pathContext, final Document doc)
+            throws XMLStreamException, IOException, ParserConfigurationException, SAXException, URISyntaxException {
+        final List<PatchEntity> resultCollection = new ArrayList<>();
+        final String patchId = doc.getElementsByTagName("patch-id").item(0).getFirstChild().getNodeValue();
+        final NodeList editNodes = doc.getElementsByTagName("edit");
+
+        for (int i = 0; i < editNodes.getLength(); i++) {
+            DataSchemaNode schemaNode = (DataSchemaNode) pathContext.getSchemaNode();
+            final Element element = (Element) editNodes.item(i);
+            final String operation = element.getElementsByTagName("operation").item(0).getFirstChild().getNodeValue();
+            final PatchEditOperation oper = PatchEditOperation.valueOf(operation.toUpperCase(Locale.ROOT));
+
+            final String editId = element.getElementsByTagName("edit-id").item(0).getFirstChild().getNodeValue();
+            final String target = element.getElementsByTagName("target").item(0).getFirstChild().getNodeValue();
+            final List<Element> values = readValueNodes(element, oper);
+            final Element firstValueElement = values != null ? values.get(0) : null;
+
+            // get namespace according to schema node from path context or value
+            final String namespace = firstValueElement == null
+                    ? schemaNode.getQName().getNamespace().toString() : firstValueElement.getNamespaceURI();
+
+            // find module according to namespace
+            final Module module = pathContext.getSchemaContext().findModules(XMLNamespace.of(namespace)).iterator()
+                .next();
+
+            // initialize codec + set default prefix derived from module name
+            final StringModuleInstanceIdentifierCodec codec = new StringModuleInstanceIdentifierCodec(
+                    pathContext.getSchemaContext(), module.getName());
+
+            // find complete path to target and target schema node
+            // target can be also empty (only slash)
+            YangInstanceIdentifier targetII;
+            final SchemaNode targetNode;
+            final Inference inference;
+            if (target.equals("/")) {
+                targetII = pathContext.getInstanceIdentifier();
+                targetNode = pathContext.getSchemaContext();
+                inference = pathContext.inference();
+            } else {
+                targetII = codec.deserialize(codec.serialize(pathContext.getInstanceIdentifier())
+                        .concat(prepareNonCondXpath(schemaNode, target.replaceFirst("/", ""), firstValueElement,
+                                namespace,
+                                module.getQNameModule().getRevision().map(Revision::toString).orElse(null))));
+                // move schema node
+                final var result = codec.getDataContextTree().enterPath(targetII).orElseThrow();
+                schemaNode = result.node().getDataSchemaNode();
+
+                final var stack = result.stack();
+                inference = stack.toInference();
+
+                stack.exit();
+                final EffectiveStatement<?, ?> parentStmt = stack.currentStatement();
+                verify(parentStmt instanceof SchemaNode, "Unexpected parent %s", parentStmt);
+                targetNode = (SchemaNode) parentStmt;
+            }
+
+            if (targetNode == null) {
+                LOG.debug("Target node {} not found in path {} ", target, pathContext.getSchemaNode());
+                throw new RestconfDocumentedException("Error parsing input", ErrorType.PROTOCOL,
+                        ErrorTag.MALFORMED_MESSAGE);
+            }
+
+            if (oper.isWithValue()) {
+                final NormalizedNode parsed;
+                if (schemaNode instanceof ContainerSchemaNode || schemaNode instanceof ListSchemaNode) {
+                    final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
+                    final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
+                    final XmlParserStream xmlParser = XmlParserStream.create(writer, inference);
+                    xmlParser.traverse(new DOMSource(firstValueElement));
+                    parsed = resultHolder.getResult();
+                } else {
+                    parsed = null;
+                }
+
+                // for lists allow to manipulate with list items through their parent
+                if (targetII.getLastPathArgument() instanceof NodeIdentifierWithPredicates) {
+                    targetII = targetII.getParent();
+                }
+
+                resultCollection.add(new PatchEntity(editId, oper, targetII, parsed));
+            } else {
+                resultCollection.add(new PatchEntity(editId, oper, targetII));
+            }
+        }
+
+        return new PatchContext(pathContext, ImmutableList.copyOf(resultCollection), patchId);
+    }
+
+    /**
+     * Read value nodes.
+     *
+     * @param element Element of current edit operation
+     * @param operation Name of current operation
+     * @return List of value elements
+     */
+    private static List<Element> readValueNodes(final @NonNull Element element,
+            final @NonNull PatchEditOperation operation) {
+        final Node valueNode = element.getElementsByTagName("value").item(0);
+
+        if (operation.isWithValue() && valueNode == null) {
+            throw new RestconfDocumentedException("Error parsing input",
+                    ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
+        }
+
+        if (!operation.isWithValue() && valueNode != null) {
+            throw new RestconfDocumentedException("Error parsing input",
+                    ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE);
+        }
+
+        if (valueNode == null) {
+            return null;
+        }
+
+        final List<Element> result = new ArrayList<>();
+        final NodeList childNodes = valueNode.getChildNodes();
+        for (int i = 0; i < childNodes.getLength(); i++) {
+            if (childNodes.item(i) instanceof Element) {
+                result.add((Element) childNodes.item(i));
+            }
+        }
+
+        return result;
+    }
+
+    /**
+     * Prepare non-conditional XPath suitable for deserialization with {@link StringModuleInstanceIdentifierCodec}.
+     *
+     * @param schemaNode Top schema node
+     * @param target Edit operation target
+     * @param value Element with value
+     * @param namespace Module namespace
+     * @param revision Module revision
+     * @return Non-conditional XPath
+     */
+    private static String prepareNonCondXpath(final @NonNull DataSchemaNode schemaNode, final @NonNull String target,
+            final @NonNull Element value, final @NonNull String namespace, final @NonNull String revision) {
+        final Iterator<String> args = Splitter.on("/").split(target.substring(target.indexOf(':') + 1)).iterator();
+
+        final StringBuilder nonCondXpath = new StringBuilder();
+        SchemaNode childNode = schemaNode;
+
+        while (args.hasNext()) {
+            final String s = args.next();
+            nonCondXpath.append('/').append(s);
+            childNode = ((DataNodeContainer) childNode).getDataChildByName(QName.create(namespace, revision, s));
+
+            if (childNode instanceof ListSchemaNode && args.hasNext()) {
+                appendKeys(nonCondXpath, ((ListSchemaNode) childNode).getKeyDefinition().iterator(), args);
+            }
+        }
+
+        if (childNode instanceof ListSchemaNode && value != null) {
+            final Iterator<String> keyValues = readKeyValues(value,
+                    ((ListSchemaNode) childNode).getKeyDefinition().iterator());
+            appendKeys(nonCondXpath, ((ListSchemaNode) childNode).getKeyDefinition().iterator(), keyValues);
+        }
+
+        return nonCondXpath.toString();
+    }
+
+    /**
+     * Read value for every list key.
+     *
+     * @param value Value element
+     * @param keys Iterator of list keys names
+     * @return Iterator of list keys values
+     */
+    private static Iterator<String> readKeyValues(final @NonNull Element value, final @NonNull Iterator<QName> keys) {
+        final List<String> result = new ArrayList<>();
+
+        while (keys.hasNext()) {
+            result.add(value.getElementsByTagName(keys.next().getLocalName()).item(0).getFirstChild().getNodeValue());
+        }
+
+        return result.iterator();
+    }
+
+    /**
+     * Append key name - key value pairs for every list key to {@code nonCondXpath}.
+     *
+     * @param nonCondXpath Builder for creating non-conditional XPath
+     * @param keyNames Iterator of list keys names
+     * @param keyValues Iterator of list keys values
+     */
+    private static void appendKeys(final @NonNull StringBuilder nonCondXpath, final @NonNull Iterator<QName> keyNames,
+            final @NonNull Iterator<String> keyValues) {
+        while (keyNames.hasNext()) {
+            nonCondXpath.append("[").append(keyNames.next().getLocalName()).append("='").append(keyValues.next())
+                .append("']");
+        }
+    }
+}