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