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