yang/yang-data-codec-xml/src/main/java/org/opendaylight/yangtools/yang/data/codec/xml/XmlParserStream.java

   1 /*
   2  * Copyright (c) 2016 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
   9 package org.opendaylight.yangtools.yang.data.codec.xml;
  10
  11 import com.google.common.annotations.Beta;
  12 import com.google.common.base.Preconditions;
  13 import java.io.Closeable;
  14 import java.io.Flushable;
  15 import java.io.IOException;
  16 import java.io.StringReader;
  17 import java.net.URI;
  18 import java.net.URISyntaxException;
  19 import java.util.Deque;
  20 import java.util.HashSet;
  21 import java.util.Set;
  22 import javax.annotation.concurrent.NotThreadSafe;
  23 import javax.xml.namespace.NamespaceContext;
  24 import javax.xml.parsers.ParserConfigurationException;
  25 import javax.xml.stream.Location;
  26 import javax.xml.stream.XMLStreamConstants;
  27 import javax.xml.stream.XMLStreamException;
  28 import javax.xml.stream.XMLStreamReader;
  29 import javax.xml.transform.dom.DOMSource;
  30 import org.opendaylight.yangtools.util.xml.UntrustedXML;
  31 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  32 import org.opendaylight.yangtools.yang.data.util.AbstractNodeDataWithSchema;
  33 import org.opendaylight.yangtools.yang.data.util.AnyXmlNodeDataWithSchema;
  34 import org.opendaylight.yangtools.yang.data.util.CompositeNodeDataWithSchema;
  35 import org.opendaylight.yangtools.yang.data.util.LeafListEntryNodeDataWithSchema;
  36 import org.opendaylight.yangtools.yang.data.util.LeafListNodeDataWithSchema;
  37 import org.opendaylight.yangtools.yang.data.util.LeafNodeDataWithSchema;
  38 import org.opendaylight.yangtools.yang.data.util.ListEntryNodeDataWithSchema;
  39 import org.opendaylight.yangtools.yang.data.util.ListNodeDataWithSchema;
  40 import org.opendaylight.yangtools.yang.data.util.ParserStreamUtils;
  41 import org.opendaylight.yangtools.yang.data.util.RpcAsContainer;
  42 import org.opendaylight.yangtools.yang.data.util.SimpleNodeDataWithSchema;
  43 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
  44 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  45 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  46 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  47 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  48 import org.opendaylight.yangtools.yang.model.api.YangModeledAnyXmlSchemaNode;
  49 import org.w3c.dom.Document;
  50 import org.xml.sax.InputSource;
  51 import org.xml.sax.SAXException;
  52
  53 /**
  54  * This class provides functionality for parsing an XML source containing YANG-modeled data. It disallows multiple
  55  * instances of the same element except for leaf-list and list entries. It also expects that the YANG-modeled data in
  56  * the XML source are wrapped in a root element.
  57  */
  58 @Beta
  59 @NotThreadSafe
  60 public final class XmlParserStream implements Closeable, Flushable {
  61     private final NormalizedNodeStreamWriter writer;
  62     private final XmlCodecFactory codecs;
  63     private final DataSchemaNode parentNode;
  64
  65     private XmlParserStream(final NormalizedNodeStreamWriter writer, final XmlCodecFactory codecs,
  66             final DataSchemaNode parentNode) {
  67         this.writer = Preconditions.checkNotNull(writer);
  68         this.codecs = Preconditions.checkNotNull(codecs);
  69         this.parentNode = parentNode;
  70     }
  71
  72     /**
  73      * Construct a new {@link XmlParserStream}.
  74      *
  75      * @param writer Output write
  76      * @param codecs Shared codecs
  77      * @param parentNode Parent root node
  78      * @return A new stream instance
  79      */
  80     public static XmlParserStream create(final NormalizedNodeStreamWriter writer, final XmlCodecFactory codecs,
  81             final SchemaNode parentNode) {
  82         if (parentNode instanceof RpcDefinition) {
  83             return new XmlParserStream(writer, codecs, new RpcAsContainer((RpcDefinition) parentNode));
  84         }
  85         Preconditions.checkArgument(parentNode instanceof DataSchemaNode, "Instance of DataSchemaNode class awaited.");
  86         return new XmlParserStream(writer, codecs, (DataSchemaNode) parentNode);
  87     }
  88
  89     /**
  90      * @deprecated Use {@link #create(NormalizedNodeStreamWriter, SchemaContext, SchemaNode)} instead.
  91      */
  92     @Deprecated
  93     public static XmlParserStream create(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext) {
  94         return create(writer, schemaContext, schemaContext);
  95     }
  96
  97     /**
  98      * Utility method for use when caching {@link XmlCodecFactory} is not feasible. Users with high performance
  99      * requirements should use {@link #create(NormalizedNodeStreamWriter, XmlCodecFactory, SchemaNode)} instead and
 100      * maintain a {@link XmlCodecFactory} to match the current {@link SchemaContext}.
 101      */
 102     public static XmlParserStream create(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext,
 103             final SchemaNode parentNode) {
 104         return create(writer, XmlCodecFactory.create(schemaContext), parentNode);
 105     }
 106
 107     /**
 108      * This method parses the XML source and emits node events into a NormalizedNodeStreamWriter based on the
 109      * YANG-modeled data contained in the XML source.
 110      *
 111      * @param reader
 112      *              StAX reader which is to used to walk through the XML source
 113      * @return
 114      *              instance of XmlParserStream
 115      * @throws XMLStreamException
 116      *              if a well-formedness error or an unexpected processing condition occurs while parsing the XML
 117      * @throws URISyntaxException
 118      *              if the namespace URI of an XML element contains a syntax error
 119      * @throws IOException
 120      *              if an error occurs while parsing the value of an anyxml node
 121      * @throws ParserConfigurationException
 122      *              if an error occurs while parsing the value of an anyxml node
 123      * @throws SAXException
 124      *              if an error occurs while parsing the value of an anyxml node
 125      */
 126     public XmlParserStream parse(final XMLStreamReader reader) throws XMLStreamException, URISyntaxException,
 127             IOException, ParserConfigurationException, SAXException {
 128         if (reader.hasNext()) {
 129             final CompositeNodeDataWithSchema compositeNodeDataWithSchema = new CompositeNodeDataWithSchema(parentNode);
 130             reader.nextTag();
 131             read(reader, compositeNodeDataWithSchema, reader.getLocalName());
 132             compositeNodeDataWithSchema.write(writer);
 133         }
 134
 135         return this;
 136     }
 137
 138     private static String readAnyXmlValue(final XMLStreamReader in) throws XMLStreamException {
 139         final StringBuilder sb = new StringBuilder();
 140         final String anyXmlElementName = in.getLocalName();
 141         sb.append('<').append(anyXmlElementName).append(" xmlns=\"").append(in.getNamespaceURI()).append("\">");
 142
 143         while (in.hasNext()) {
 144             final int eventType = in.next();
 145
 146             if (eventType == XMLStreamConstants.START_ELEMENT) {
 147                 sb.append('<').append(in.getLocalName()).append('>');
 148             } else if (eventType == XMLStreamConstants.END_ELEMENT) {
 149                 sb.append("</").append(in.getLocalName()).append('>');
 150
 151                 if (in.getLocalName().equals(anyXmlElementName)) {
 152                     break;
 153                 }
 154
 155             } else if (eventType == XMLStreamConstants.CHARACTERS) {
 156                 sb.append(in.getText());
 157             }
 158         }
 159
 160         return sb.toString();
 161     }
 162
 163     private void read(final XMLStreamReader in, final AbstractNodeDataWithSchema parent, final String rootElement)
 164             throws XMLStreamException, URISyntaxException, ParserConfigurationException, SAXException, IOException {
 165         if (!in.hasNext()) {
 166             return;
 167         }
 168
 169         if (parent instanceof LeafNodeDataWithSchema || parent instanceof LeafListEntryNodeDataWithSchema) {
 170             setValue(parent, in.getElementText().trim(), in.getNamespaceContext());
 171             in.nextTag();
 172             return;
 173         }
 174
 175         if (parent instanceof LeafListNodeDataWithSchema || parent instanceof ListNodeDataWithSchema) {
 176             String xmlElementName = in.getLocalName();
 177             while (xmlElementName.equals(parent.getSchema().getQName().getLocalName())) {
 178                 read(in, newEntryNode(parent), rootElement);
 179                 xmlElementName = in.getLocalName();
 180             }
 181
 182             return;
 183         }
 184
 185         if (parent instanceof AnyXmlNodeDataWithSchema) {
 186             setValue(parent, readAnyXmlValue(in), in.getNamespaceContext());
 187             in.nextTag();
 188             return;
 189         }
 190
 191         switch (in.nextTag()) {
 192             case XMLStreamConstants.START_ELEMENT:
 193                 final Set<String> namesakes = new HashSet<>();
 194                 while (in.hasNext()) {
 195                     final String xmlElementName = in.getLocalName();
 196                     if (rootElement.equals(xmlElementName)) {
 197                         break;
 198                     }
 199
 200                     DataSchemaNode parentSchema = parent.getSchema();
 201
 202                     final String parentSchemaName = parentSchema.getQName().getLocalName();
 203                     if (parentSchemaName.equals(xmlElementName) && in.getEventType() == XMLStreamConstants.END_ELEMENT) {
 204                         in.nextTag();
 205                         break;
 206                     }
 207
 208                     if (parentSchema instanceof YangModeledAnyXmlSchemaNode) {
 209                         parentSchema = ((YangModeledAnyXmlSchemaNode) parentSchema).getSchemaOfAnyXmlData();
 210                     }
 211
 212                     if (!namesakes.add(xmlElementName)) {
 213                         final Location loc = in.getLocation();
 214                         throw new IllegalStateException(String.format(
 215                                 "Duplicate element \"%s\" in XML input at: line %s column %s", xmlElementName,
 216                                 loc.getLineNumber(), loc.getColumnNumber()));
 217                     }
 218
 219                     final String xmlElementNamespace = in.getNamespaceURI();
 220                     final Deque<DataSchemaNode> childDataSchemaNodes =
 221                             ParserStreamUtils.findSchemaNodeByNameAndNamespace(parentSchema, xmlElementName,
 222                                     new URI(xmlElementNamespace));
 223
 224                     Preconditions.checkState(!childDataSchemaNodes.isEmpty(),
 225                             "Schema for node with name %s and namespace %s doesn't exist.",
 226                             xmlElementName, xmlElementNamespace);
 227
 228                     read(in, ((CompositeNodeDataWithSchema) parent).addChild(childDataSchemaNodes), rootElement);
 229                 }
 230                 break;
 231             case XMLStreamConstants.END_ELEMENT:
 232                 in.nextTag();
 233                 break;
 234         }
 235     }
 236
 237     private void setValue(final AbstractNodeDataWithSchema parent, final String value, final NamespaceContext nsContext)
 238             throws ParserConfigurationException, SAXException, IOException {
 239         Preconditions.checkArgument(parent instanceof SimpleNodeDataWithSchema, "Node %s is not a simple type",
 240                 parent.getSchema().getQName());
 241         final SimpleNodeDataWithSchema parentSimpleNode = (SimpleNodeDataWithSchema) parent;
 242         Preconditions.checkArgument(parentSimpleNode.getValue() == null, "Node '%s' has already set its value to '%s'",
 243                 parentSimpleNode.getSchema().getQName(), parentSimpleNode.getValue());
 244
 245         parentSimpleNode.setValue(translateValueByType(value, parentSimpleNode.getSchema(), nsContext));
 246     }
 247
 248     private Object translateValueByType(final String value, final DataSchemaNode node, final NamespaceContext namespaceCtx)
 249             throws IOException, SAXException, ParserConfigurationException {
 250         if (node instanceof AnyXmlSchemaNode) {
 251             /*
 252              *  FIXME: Figure out some YANG extension dispatch, which will
 253              *  reuse JSON parsing or XML parsing - anyxml is not well-defined in
 254              * JSON.
 255              */
 256             final Document doc = UntrustedXML.newDocumentBuilder().parse(new InputSource(new StringReader(value)));
 257             doc.normalize();
 258
 259             return new DOMSource(doc.getDocumentElement());
 260         }
 261
 262         return codecs.codecFor(node, namespaceCtx).deserialize(value);
 263     }
 264
 265     private static AbstractNodeDataWithSchema newEntryNode(final AbstractNodeDataWithSchema parent) {
 266         final AbstractNodeDataWithSchema newChild;
 267         if (parent instanceof ListNodeDataWithSchema) {
 268             newChild = new ListEntryNodeDataWithSchema(parent.getSchema());
 269         } else {
 270             newChild = new LeafListEntryNodeDataWithSchema(parent.getSchema());
 271         }
 272         ((CompositeNodeDataWithSchema) parent).addChild(newChild);
 273         return newChild;
 274     }
 275
 276     @Override
 277     public void close() throws IOException {
 278         writer.flush();
 279         writer.close();
 280     }
 281
 282     @Override
 283     public void flush() throws IOException {
 284         writer.flush();
 285     }
 286 }