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