BUG-7983: unify JSONCodec and XmlCodec methods
[yangtools.git] / yang / yang-data-codec-gson / src / main / java / org / opendaylight / yangtools / yang / data / codec / gson / JsonParserStream.java
index 7922b95197b63badb9676c4e95286677017ad9ab..a05fb34c1961904dc1019eedf7b47d86e81ef4db 100644 (file)
@@ -20,15 +20,24 @@ import java.io.Flushable;
 import java.io.IOException;
 import java.net.URI;
 import java.util.ArrayDeque;
-import java.util.ArrayList;
 import java.util.Collections;
 import java.util.Deque;
 import java.util.HashSet;
-import java.util.List;
 import java.util.Set;
-import org.opendaylight.yangtools.yang.common.QName;
+import javax.xml.transform.dom.DOMSource;
+import org.opendaylight.yangtools.util.xml.UntrustedXML;
 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
-import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
+import org.opendaylight.yangtools.yang.data.util.AbstractNodeDataWithSchema;
+import org.opendaylight.yangtools.yang.data.util.AnyXmlNodeDataWithSchema;
+import org.opendaylight.yangtools.yang.data.util.CompositeNodeDataWithSchema;
+import org.opendaylight.yangtools.yang.data.util.LeafListEntryNodeDataWithSchema;
+import org.opendaylight.yangtools.yang.data.util.LeafListNodeDataWithSchema;
+import org.opendaylight.yangtools.yang.data.util.LeafNodeDataWithSchema;
+import org.opendaylight.yangtools.yang.data.util.ListEntryNodeDataWithSchema;
+import org.opendaylight.yangtools.yang.data.util.ListNodeDataWithSchema;
+import org.opendaylight.yangtools.yang.data.util.ParserStreamUtils;
+import org.opendaylight.yangtools.yang.data.util.RpcAsContainer;
+import org.opendaylight.yangtools.yang.data.util.SimpleNodeDataWithSchema;
 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
@@ -37,6 +46,11 @@ import org.opendaylight.yangtools.yang.model.api.Module;
 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
+import org.opendaylight.yangtools.yang.model.api.TypedSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.YangModeledAnyXmlSchemaNode;
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+import org.w3c.dom.Text;
 
 /**
  * This class parses JSON elements from a GSON JsonReader. It disallows multiple elements of the same name unlike the
@@ -44,21 +58,25 @@ import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  */
 @Beta
 public final class JsonParserStream implements Closeable, Flushable {
+    static final String ANYXML_ARRAY_ELEMENT_ID = "array-element";
+
     private final Deque<URI> namespaces = new ArrayDeque<>();
     private final NormalizedNodeStreamWriter writer;
     private final JSONCodecFactory codecs;
     private final SchemaContext schema;
     private final DataSchemaNode parentNode;
 
-    private JsonParserStream(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext, final DataSchemaNode parentNode) {
+    private JsonParserStream(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext,
+            final DataSchemaNode parentNode) {
         this.schema = Preconditions.checkNotNull(schemaContext);
         this.writer = Preconditions.checkNotNull(writer);
         this.codecs = JSONCodecFactory.create(schemaContext);
         this.parentNode = parentNode;
     }
 
-    public static JsonParserStream create(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext, final SchemaNode parentNode ) {
-        if(parentNode instanceof RpcDefinition) {
+    public static JsonParserStream create(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext,
+            final SchemaNode parentNode ) {
+        if (parentNode instanceof RpcDefinition) {
             return new JsonParserStream(writer, schemaContext, new RpcAsContainer((RpcDefinition) parentNode));
         }
         Preconditions.checkArgument(parentNode instanceof DataSchemaNode, "Instance of DataSchemaNode class awaited.");
@@ -69,7 +87,7 @@ public final class JsonParserStream implements Closeable, Flushable {
         return new JsonParserStream(writer, schemaContext, schemaContext);
     }
 
-    public JsonParserStream parse(final JsonReader reader) throws JsonIOException, JsonSyntaxException {
+    public JsonParserStream parse(final JsonReader reader) {
         // code copied from gson's JsonParser and Stream classes
 
         final boolean lenient = reader.isLenient();
@@ -83,20 +101,16 @@ public final class JsonParserStream implements Closeable, Flushable {
             compositeNodeDataWithSchema.write(writer);
 
             return this;
-            // return read(reader);
         } catch (final EOFException e) {
             if (isEmpty) {
                 return this;
-                // return JsonNull.INSTANCE;
             }
             // The stream ended prematurely so it is likely a syntax error.
             throw new JsonSyntaxException(e);
-        } catch (final MalformedJsonException e) {
+        } catch (final MalformedJsonException | NumberFormatException e) {
             throw new JsonSyntaxException(e);
         } catch (final IOException e) {
             throw new JsonIOException(e);
-        } catch (final NumberFormatException e) {
-            throw new JsonSyntaxException(e);
         } catch (StackOverflowError | OutOfMemoryError e) {
             throw new JsonParseException("Failed parsing JSON source: " + reader + " to Json", e);
         } finally {
@@ -104,11 +118,58 @@ public final class JsonParserStream implements Closeable, Flushable {
         }
     }
 
-    private final void setValue(final AbstractNodeDataWithSchema parent, final String value) {
-        Preconditions.checkArgument(parent instanceof SimpleNodeDataWithSchema, "Node %s is not a simple type", parent);
+    private void traverseAnyXmlValue(final JsonReader in, final Document doc, final Element parentElement)
+            throws IOException {
+        switch (in.peek()) {
+            case STRING:
+            case NUMBER:
+                Text textNode = doc.createTextNode(in.nextString());
+                parentElement.appendChild(textNode);
+                break;
+            case BOOLEAN:
+                textNode = doc.createTextNode(Boolean.toString(in.nextBoolean()));
+                parentElement.appendChild(textNode);
+                break;
+            case NULL:
+                in.nextNull();
+                textNode = doc.createTextNode("null");
+                parentElement.appendChild(textNode);
+                break;
+            case BEGIN_ARRAY:
+                in.beginArray();
+                while (in.hasNext()) {
+                    final Element childElement = doc.createElement(ANYXML_ARRAY_ELEMENT_ID);
+                    parentElement.appendChild(childElement);
+                    traverseAnyXmlValue(in, doc, childElement);
+                }
+                in.endArray();
+                break;
+            case BEGIN_OBJECT:
+                in.beginObject();
+                while (in.hasNext()) {
+                    final Element childElement = doc.createElement(in.nextName());
+                    parentElement.appendChild(childElement);
+                    traverseAnyXmlValue(in, doc, childElement);
+                }
+                in.endObject();
+            case END_DOCUMENT:
+            case NAME:
+            case END_OBJECT:
+            case END_ARRAY:
+                break;
+        }
+    }
+
+    private void readAnyXmlValue(final JsonReader in, final AnyXmlNodeDataWithSchema parent,
+            final String anyXmlObjectName) throws IOException {
+        final String anyXmlObjectNS = getCurrentNamespace().toString();
+        final Document doc = UntrustedXML.newDocumentBuilder().newDocument();
+        final Element rootElement = doc.createElementNS(anyXmlObjectNS, anyXmlObjectName);
+        doc.appendChild(rootElement);
+        traverseAnyXmlValue(in, doc, rootElement);
 
-        final Object translatedValue = translateValueByType(value, parent.getSchema());
-        ((SimpleNodeDataWithSchema) parent).setValue(translatedValue);
+        final DOMSource domSource = new DOMSource(doc.getDocumentElement());
+        parent.setValue(domSource);
     }
 
     public void read(final JsonReader in, AbstractNodeDataWithSchema parent) throws IOException {
@@ -127,8 +188,12 @@ public final class JsonParserStream implements Closeable, Flushable {
         case BEGIN_ARRAY:
             in.beginArray();
             while (in.hasNext()) {
-                final AbstractNodeDataWithSchema newChild = newArrayEntry(parent);
-                read(in, newChild);
+                if (parent instanceof LeafNodeDataWithSchema) {
+                    read(in, parent);
+                } else {
+                    final AbstractNodeDataWithSchema newChild = newArrayEntry(parent);
+                    read(in, newChild);
+                }
             }
             in.endArray();
             return;
@@ -142,33 +207,33 @@ public final class JsonParserStream implements Closeable, Flushable {
              * without wrapping array.
              *
              */
-            if(isArray(parent)) {
+            if (isArray(parent)) {
                 parent = newArrayEntry(parent);
             }
             while (in.hasNext()) {
                 final String jsonElementName = in.nextName();
-                final NamespaceAndName namespaceAndName = resolveNamespace(jsonElementName, parent.getSchema());
+                DataSchemaNode parentSchema = parent.getSchema();
+                if (parentSchema instanceof YangModeledAnyXmlSchemaNode) {
+                    parentSchema = ((YangModeledAnyXmlSchemaNode) parentSchema).getSchemaOfAnyXmlData();
+                }
+                final NamespaceAndName namespaceAndName = resolveNamespace(jsonElementName, parentSchema);
                 final String localName = namespaceAndName.getName();
                 addNamespace(namespaceAndName.getUri());
                 if (namesakes.contains(jsonElementName)) {
                     throw new JsonSyntaxException("Duplicate name " + jsonElementName + " in JSON input.");
                 }
                 namesakes.add(jsonElementName);
-                final Deque<DataSchemaNode> childDataSchemaNodes = findSchemaNodeByNameAndNamespace(parent.getSchema(),
-                        localName, getCurrentNamespace());
+
+                final Deque<DataSchemaNode> childDataSchemaNodes =
+                        ParserStreamUtils.findSchemaNodeByNameAndNamespace(parentSchema, localName, getCurrentNamespace());
                 if (childDataSchemaNodes.isEmpty()) {
                     throw new IllegalStateException("Schema for node with name " + localName + " and namespace "
                             + getCurrentNamespace() + " doesn't exist.");
                 }
 
                 final AbstractNodeDataWithSchema newChild = ((CompositeNodeDataWithSchema) parent).addChild(childDataSchemaNodes);
-                /*
-                 * FIXME:anyxml data shouldn't be skipped but should be loaded somehow.
-                 * will be able to load anyxml which conforms to YANG data using these
-                 * parser, for other anyxml will be harder.
-                 */
                 if (newChild instanceof AnyXmlNodeDataWithSchema) {
-                    in.skipValue();
+                    readAnyXmlValue(in, (AnyXmlNodeDataWithSchema) newChild, jsonElementName);
                 } else {
                     read(in, newChild);
                 }
@@ -184,33 +249,37 @@ public final class JsonParserStream implements Closeable, Flushable {
         }
     }
 
-    private boolean isArray(final AbstractNodeDataWithSchema parent) {
-        return parent instanceof ListNodeDataWithSchema || parent instanceof ListNodeDataWithSchema;
+    private static boolean isArray(final AbstractNodeDataWithSchema parent) {
+        return parent instanceof ListNodeDataWithSchema || parent instanceof LeafListNodeDataWithSchema;
     }
 
-    private AbstractNodeDataWithSchema newArrayEntry(final AbstractNodeDataWithSchema parent) {
+    private static AbstractNodeDataWithSchema newArrayEntry(final AbstractNodeDataWithSchema parent) {
         AbstractNodeDataWithSchema newChild;
         if (parent instanceof ListNodeDataWithSchema) {
             newChild = new ListEntryNodeDataWithSchema(parent.getSchema());
         } else if (parent instanceof LeafListNodeDataWithSchema) {
             newChild = new LeafListEntryNodeDataWithSchema(parent.getSchema());
         } else {
-            throw new IllegalStateException("Incorrec nesting caused by parser.");
+            throw new IllegalStateException("Found an unexpected array nested under "+ parent.getSchema().getQName());
         }
         ((CompositeNodeDataWithSchema) parent).addChild(newChild);
         return newChild;
     }
 
+    private void setValue(final AbstractNodeDataWithSchema parent, final String value) {
+        Preconditions.checkArgument(parent instanceof SimpleNodeDataWithSchema, "Node %s is not a simple type",
+                parent.getSchema().getQName());
+        final SimpleNodeDataWithSchema parentSimpleNode = (SimpleNodeDataWithSchema) parent;
+        Preconditions.checkArgument(parentSimpleNode.getValue() == null, "Node '%s' has already set its value to '%s'",
+                parentSimpleNode.getSchema().getQName(), parentSimpleNode.getValue());
+
+        final Object translatedValue = translateValueByType(value, parentSimpleNode.getSchema());
+        parentSimpleNode.setValue(translatedValue);
+    }
+
     private Object translateValueByType(final String value, final DataSchemaNode node) {
-        if (node instanceof AnyXmlSchemaNode) {
-            /*
-             *  FIXME: Figure out some YANG extension dispatch, which will
-             *  reuse JSON parsing or XML parsing - anyxml is not well-defined in
-             * JSON.
-             */
-            return value;
-        }
-        return codecs.codecFor(node).deserialize(value);
+        Preconditions.checkArgument(node instanceof TypedSchemaNode);
+        return codecs.codecFor((TypedSchemaNode) node).parseValue(null, value);
     }
 
     private void removeNamespace() {
@@ -246,7 +315,7 @@ public final class JsonParserStream implements Closeable, Flushable {
             } else if (potentialUris.size() > 1) {
                 throw new IllegalStateException("Choose suitable module name for element "+nodeNamePart+":"+toModuleNames(potentialUris));
             } else if (potentialUris.isEmpty()) {
-                throw new IllegalStateException("Schema node with name "+nodeNamePart+" wasn't found.");
+                throw new IllegalStateException("Schema node with name "+nodeNamePart+" wasn't found under "+dataSchemaNode.getQName()+".");
             }
         }
 
@@ -288,57 +357,7 @@ public final class JsonParserStream implements Closeable, Flushable {
         return namespaces.peek();
     }
 
-    /**
-     * Returns stack of schema nodes via which it was necessary to pass to get schema node with specified
-     * {@code childName} and {@code namespace}
-     *
-     * @param dataSchemaNode
-     * @param childName
-     * @param namespace
-     * @return stack of schema nodes via which it was passed through. If found schema node is direct child then stack
-     *         contains only one node. If it is found under choice and case then stack should contains 2*n+1 element
-     *         (where n is number of choices through it was passed)
-     */
-    private Deque<DataSchemaNode> findSchemaNodeByNameAndNamespace(final DataSchemaNode dataSchemaNode,
-            final String childName, final URI namespace) {
-        final Deque<DataSchemaNode> result = new ArrayDeque<>();
-        final List<ChoiceSchemaNode> childChoices = new ArrayList<>();
-        DataSchemaNode potentialChildNode = null;
-        if (dataSchemaNode instanceof DataNodeContainer) {
-            for (final DataSchemaNode childNode : ((DataNodeContainer) dataSchemaNode).getChildNodes()) {
-                if (childNode instanceof ChoiceSchemaNode) {
-                    childChoices.add((ChoiceSchemaNode) childNode);
-                } else {
-                    final QName childQName = childNode.getQName();
-
-                    if (childQName.getLocalName().equals(childName) && childQName.getNamespace().equals(namespace)) {
-                        if (potentialChildNode == null ||
-                                childQName.getRevision().after(potentialChildNode.getQName().getRevision())) {
-                            potentialChildNode = childNode;
-                        }
-                    }
-                }
-            }
-        }
-        if (potentialChildNode != null) {
-            result.push(potentialChildNode);
-            return result;
-        }
 
-        // try to find data schema node in choice (looking for first match)
-        for (final ChoiceSchemaNode choiceNode : childChoices) {
-            for (final ChoiceCaseNode concreteCase : choiceNode.getCases()) {
-                final Deque<DataSchemaNode> resultFromRecursion = findSchemaNodeByNameAndNamespace(concreteCase, childName,
-                        namespace);
-                if (!resultFromRecursion.isEmpty()) {
-                    resultFromRecursion.push(concreteCase);
-                    resultFromRecursion.push(choiceNode);
-                    return resultFromRecursion;
-                }
-            }
-        }
-        return result;
-    }
 
     private static class NamespaceAndName {
         private final URI uri;