restconf/sal-rest-connector/src/main/java/org/opendaylight/netconf/sal/rest/impl/XmlNormalizedNodeBodyReader.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.netconf.sal.rest.impl;
   9
  10 import com.google.common.collect.Iterables;
  11 import java.io.IOException;
  12 import java.io.InputStream;
  13 import java.lang.annotation.Annotation;
  14 import java.lang.reflect.Type;
  15 import java.util.ArrayDeque;
  16 import java.util.ArrayList;
  17 import java.util.Collection;
  18 import java.util.Collections;
  19 import java.util.Deque;
  20 import java.util.List;
  21 import javax.ws.rs.Consumes;
  22 import javax.ws.rs.WebApplicationException;
  23 import javax.ws.rs.core.MediaType;
  24 import javax.ws.rs.core.MultivaluedMap;
  25 import javax.ws.rs.ext.MessageBodyReader;
  26 import javax.ws.rs.ext.Provider;
  27 import javax.xml.parsers.DocumentBuilder;
  28 import javax.xml.parsers.DocumentBuilderFactory;
  29 import javax.xml.parsers.ParserConfigurationException;
  30 import org.opendaylight.netconf.sal.rest.api.Draft02;
  31 import org.opendaylight.netconf.sal.rest.api.RestconfService;
  32 import org.opendaylight.netconf.sal.restconf.impl.InstanceIdentifierContext;
  33 import org.opendaylight.netconf.sal.restconf.impl.NormalizedNodeContext;
  34 import org.opendaylight.netconf.sal.restconf.impl.RestconfDocumentedException;
  35 import org.opendaylight.netconf.sal.restconf.impl.RestconfError.ErrorTag;
  36 import org.opendaylight.netconf.sal.restconf.impl.RestconfError.ErrorType;
  37 import org.opendaylight.restconf.Draft11;
  38 import org.opendaylight.restconf.utils.RestconfConstants;
  39 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  40 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  41 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XmlUtils;
  42 import org.opendaylight.yangtools.yang.data.impl.schema.SchemaUtils;
  43 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.parser.DomToNormalizedNodeParserFactory;
  44 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
  45 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget;
  46 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
  47 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  48 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  49 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  50 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  51 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  52 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  53 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  54 import org.slf4j.Logger;
  55 import org.slf4j.LoggerFactory;
  56 import org.w3c.dom.Document;
  57 import org.w3c.dom.Element;
  58
  59 @Provider
  60 @Consumes({ Draft02.MediaTypes.DATA + RestconfService.XML, Draft11.MediaTypes.DATA + RestconfConstants.XML,
  61         Draft02.MediaTypes.OPERATION + RestconfService.XML, Draft11.MediaTypes.OPERATION + RestconfConstants.XML,
  62     MediaType.APPLICATION_XML, MediaType.TEXT_XML })
  63 public class XmlNormalizedNodeBodyReader extends AbstractIdentifierAwareJaxRsProvider implements MessageBodyReader<NormalizedNodeContext> {
  64
  65     private final static Logger LOG = LoggerFactory.getLogger(XmlNormalizedNodeBodyReader.class);
  66     private static final DocumentBuilderFactory BUILDERFACTORY;
  67
  68     static {
  69         final DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
  70         try {
  71             factory.setFeature("http://apache.org/xml/features/disallow-doctype-decl", true);
  72             factory.setFeature("http://xml.org/sax/features/external-general-entities", false);
  73             factory.setFeature("http://xml.org/sax/features/external-parameter-entities", false);
  74             factory.setXIncludeAware(false);
  75             factory.setExpandEntityReferences(false);
  76         } catch (final ParserConfigurationException e) {
  77             throw new ExceptionInInitializerError(e);
  78         }
  79         factory.setNamespaceAware(true);
  80         factory.setCoalescing(true);
  81         factory.setIgnoringElementContentWhitespace(true);
  82         factory.setIgnoringComments(true);
  83         BUILDERFACTORY = factory;
  84     }
  85
  86     @Override
  87     public boolean isReadable(final Class<?> type, final Type genericType, final Annotation[] annotations,
  88             final MediaType mediaType) {
  89         return true;
  90     }
  91
  92     @Override
  93     public NormalizedNodeContext readFrom(final Class<NormalizedNodeContext> type, final Type genericType,
  94             final Annotation[] annotations, final MediaType mediaType,
  95             final MultivaluedMap<String, String> httpHeaders, final InputStream entityStream) throws IOException,
  96             WebApplicationException {
  97         try {
  98             final InstanceIdentifierContext<?> path = getInstanceIdentifierContext();
  99
 100             if (entityStream.available() < 1) {
 101                 // represent empty nopayload input
 102                 return new NormalizedNodeContext(path, null);
 103             }
 104
 105             final DocumentBuilder dBuilder;
 106             try {
 107                 dBuilder = BUILDERFACTORY.newDocumentBuilder();
 108             } catch (final ParserConfigurationException e) {
 109                 throw new RuntimeException("Failed to parse XML document", e);
 110             }
 111             final Document doc = dBuilder.parse(entityStream);
 112
 113             return parse(path,doc);
 114         } catch (final RestconfDocumentedException e){
 115             throw e;
 116         } catch (final Exception e) {
 117             LOG.debug("Error parsing xml input", e);
 118
 119             throw new RestconfDocumentedException("Error parsing input: " + e.getMessage(), ErrorType.PROTOCOL,
 120                     ErrorTag.MALFORMED_MESSAGE);
 121         }
 122     }
 123
 124     private NormalizedNodeContext parse(final InstanceIdentifierContext<?> pathContext,final Document doc) {
 125
 126         final List<Element> elements = Collections.singletonList(doc.getDocumentElement());
 127         final SchemaNode schemaNodeContext = pathContext.getSchemaNode();
 128         DataSchemaNode schemaNode;
 129         boolean isRpc = false;
 130         if (schemaNodeContext instanceof RpcDefinition) {
 131             schemaNode = ((RpcDefinition) schemaNodeContext).getInput();
 132             isRpc = true;
 133         } else if (schemaNodeContext instanceof DataSchemaNode) {
 134             schemaNode = (DataSchemaNode) schemaNodeContext;
 135         } else {
 136             throw new IllegalStateException("Unknow SchemaNode");
 137         }
 138
 139         final String docRootElm = doc.getDocumentElement().getLocalName();
 140         final List<YangInstanceIdentifier.PathArgument> iiToDataList = new ArrayList<>();
 141         InstanceIdentifierContext<? extends SchemaNode> outIIContext;
 142
 143
 144         // FIXME the factory instance should be cached if the schema context is the same
 145         final DomToNormalizedNodeParserFactory parserFactory =
 146                 DomToNormalizedNodeParserFactory.getInstance(XmlUtils.DEFAULT_XML_CODEC_PROVIDER, pathContext.getSchemaContext());
 147
 148         if (isPost() && !isRpc) {
 149             final Deque<Object> foundSchemaNodes = findPathToSchemaNodeByName(schemaNode, docRootElm);
 150             if (foundSchemaNodes.isEmpty()) {
 151                 throw new IllegalStateException(String.format("Child \"%s\" was not found in parent schema node \"%s\"",
 152                         docRootElm, schemaNode.getQName()));
 153             }
 154             while (!foundSchemaNodes.isEmpty()) {
 155                 final Object child = foundSchemaNodes.pop();
 156                 if (child instanceof AugmentationSchema) {
 157                     final AugmentationSchema augmentSchemaNode = (AugmentationSchema) child;
 158                     iiToDataList.add(SchemaUtils.getNodeIdentifierForAugmentation(augmentSchemaNode));
 159                 } else if (child instanceof DataSchemaNode) {
 160                     schemaNode = (DataSchemaNode) child;
 161                     iiToDataList.add(new YangInstanceIdentifier.NodeIdentifier(schemaNode.getQName()));
 162                 }
 163             }
 164         }
 165
 166         NormalizedNode<?, ?> parsed = null;
 167
 168         if(schemaNode instanceof ContainerSchemaNode) {
 169             parsed = parserFactory.getContainerNodeParser().parse(Collections.singletonList(doc.getDocumentElement()), (ContainerSchemaNode) schemaNode);
 170         } else if(schemaNode instanceof ListSchemaNode) {
 171             final ListSchemaNode casted = (ListSchemaNode) schemaNode;
 172             parsed = parserFactory.getMapEntryNodeParser().parse(elements, casted);
 173             if (isPost()) {
 174                 iiToDataList.add(parsed.getIdentifier());
 175             }
 176         }
 177         // FIXME : add another DataSchemaNode extensions e.g. LeafSchemaNode
 178
 179         final YangInstanceIdentifier fullIIToData = YangInstanceIdentifier.create(Iterables.concat(
 180                 pathContext.getInstanceIdentifier().getPathArguments(), iiToDataList));
 181
 182         outIIContext = new InstanceIdentifierContext<>(fullIIToData, pathContext.getSchemaNode(), pathContext.getMountPoint(),
 183                 pathContext.getSchemaContext());
 184
 185         return new NormalizedNodeContext(outIIContext, parsed);
 186     }
 187
 188     private static Deque<Object> findPathToSchemaNodeByName(final DataSchemaNode schemaNode, final String elementName) {
 189         final Deque<Object> result = new ArrayDeque<>();
 190         final ArrayList<ChoiceSchemaNode> choiceSchemaNodes = new ArrayList<>();
 191         final Collection<DataSchemaNode> children = ((DataNodeContainer) schemaNode).getChildNodes();
 192         for (final DataSchemaNode child : children) {
 193             if (child instanceof ChoiceSchemaNode) {
 194                 choiceSchemaNodes.add((ChoiceSchemaNode) child);
 195             } else if (child.getQName().getLocalName().equalsIgnoreCase(elementName)) {
 196                 result.push(child);
 197                 if (child.isAugmenting()) {
 198                     final AugmentationSchema augment = findCorrespondingAugment(schemaNode, child);
 199                     if (augment != null) {
 200                         result.push(augment);
 201                     }
 202                 }
 203                 return result;
 204             }
 205         }
 206
 207         for (final ChoiceSchemaNode choiceNode : choiceSchemaNodes) {
 208             for (final ChoiceCaseNode caseNode : choiceNode.getCases()) {
 209                 final Deque<Object> resultFromRecursion = findPathToSchemaNodeByName(caseNode, elementName);
 210                 if (!resultFromRecursion.isEmpty()) {
 211                     resultFromRecursion.push(choiceNode);
 212                     if (choiceNode.isAugmenting()) {
 213                         final AugmentationSchema augment = findCorrespondingAugment(schemaNode, choiceNode);
 214                         if (augment != null) {
 215                             resultFromRecursion.push(augment);
 216                         }
 217                     }
 218                     return resultFromRecursion;
 219                 }
 220             }
 221         }
 222         return result;
 223     }
 224
 225     private static AugmentationSchema findCorrespondingAugment(final DataSchemaNode parent, final DataSchemaNode child) {
 226         if ((parent instanceof AugmentationTarget) && !(parent instanceof ChoiceSchemaNode)) {
 227             for (final AugmentationSchema augmentation : ((AugmentationTarget) parent).getAvailableAugmentations()) {
 228                 final DataSchemaNode childInAugmentation = augmentation.getDataChildByName(child.getQName());
 229                 if (childInAugmentation != null) {
 230                     return augmentation;
 231                 }
 232             }
 233         }
 234         return null;
 235     }
 236 }
 237