yang/yang-data-codec-gson/src/main/java/org/opendaylight/yangtools/yang/data/codec/gson/JsonParserStream.java

   1 /*
   2  * Copyright (c) 2014 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 package org.opendaylight.yangtools.yang.data.codec.gson;
   9
  10 import com.google.common.annotations.Beta;
  11 import com.google.common.base.Preconditions;
  12 import com.google.gson.JsonIOException;
  13 import com.google.gson.JsonParseException;
  14 import com.google.gson.JsonSyntaxException;
  15 import com.google.gson.stream.JsonReader;
  16 import com.google.gson.stream.MalformedJsonException;
  17 import java.io.Closeable;
  18 import java.io.EOFException;
  19 import java.io.Flushable;
  20 import java.io.IOException;
  21 import java.net.URI;
  22 import java.util.ArrayDeque;
  23 import java.util.Collections;
  24 import java.util.Deque;
  25 import java.util.HashSet;
  26 import java.util.Set;
  27 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  28 import org.opendaylight.yangtools.yang.data.util.AbstractNodeDataWithSchema;
  29 import org.opendaylight.yangtools.yang.data.util.AnyXmlNodeDataWithSchema;
  30 import org.opendaylight.yangtools.yang.data.util.CompositeNodeDataWithSchema;
  31 import org.opendaylight.yangtools.yang.data.util.LeafListEntryNodeDataWithSchema;
  32 import org.opendaylight.yangtools.yang.data.util.LeafListNodeDataWithSchema;
  33 import org.opendaylight.yangtools.yang.data.util.LeafNodeDataWithSchema;
  34 import org.opendaylight.yangtools.yang.data.util.ListEntryNodeDataWithSchema;
  35 import org.opendaylight.yangtools.yang.data.util.ListNodeDataWithSchema;
  36 import org.opendaylight.yangtools.yang.data.util.ParserStreamUtils;
  37 import org.opendaylight.yangtools.yang.data.util.RpcAsContainer;
  38 import org.opendaylight.yangtools.yang.data.util.SimpleNodeDataWithSchema;
  39 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
  40 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
  41 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  42 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  43 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  44 import org.opendaylight.yangtools.yang.model.api.Module;
  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
  50 /**
  51  * This class parses JSON elements from a GSON JsonReader. It disallows multiple elements of the same name unlike the
  52  * default GSON JsonParser.
  53  */
  54 @Beta
  55 public final class JsonParserStream implements Closeable, Flushable {
  56     private final Deque<URI> namespaces = new ArrayDeque<>();
  57     private final NormalizedNodeStreamWriter writer;
  58     private final JSONCodecFactory codecs;
  59     private final SchemaContext schema;
  60     private final DataSchemaNode parentNode;
  61
  62     private JsonParserStream(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext,
  63             final DataSchemaNode parentNode) {
  64         this.schema = Preconditions.checkNotNull(schemaContext);
  65         this.writer = Preconditions.checkNotNull(writer);
  66         this.codecs = JSONCodecFactory.create(schemaContext);
  67         this.parentNode = parentNode;
  68     }
  69
  70     public static JsonParserStream create(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext,
  71             final SchemaNode parentNode ) {
  72         if (parentNode instanceof RpcDefinition) {
  73             return new JsonParserStream(writer, schemaContext, new RpcAsContainer((RpcDefinition) parentNode));
  74         }
  75         Preconditions.checkArgument(parentNode instanceof DataSchemaNode, "Instance of DataSchemaNode class awaited.");
  76         return new JsonParserStream(writer, schemaContext, (DataSchemaNode) parentNode);
  77     }
  78
  79     public static JsonParserStream create(final NormalizedNodeStreamWriter writer, final SchemaContext schemaContext) {
  80         return new JsonParserStream(writer, schemaContext, schemaContext);
  81     }
  82
  83     public JsonParserStream parse(final JsonReader reader) {
  84         // code copied from gson's JsonParser and Stream classes
  85
  86         final boolean lenient = reader.isLenient();
  87         reader.setLenient(true);
  88         boolean isEmpty = true;
  89         try {
  90             reader.peek();
  91             isEmpty = false;
  92             final CompositeNodeDataWithSchema compositeNodeDataWithSchema = new CompositeNodeDataWithSchema(parentNode);
  93             read(reader, compositeNodeDataWithSchema);
  94             compositeNodeDataWithSchema.write(writer);
  95
  96             return this;
  97         } catch (final EOFException e) {
  98             if (isEmpty) {
  99                 return this;
 100             }
 101             // The stream ended prematurely so it is likely a syntax error.
 102             throw new JsonSyntaxException(e);
 103         } catch (final MalformedJsonException | NumberFormatException e) {
 104             throw new JsonSyntaxException(e);
 105         } catch (final IOException e) {
 106             throw new JsonIOException(e);
 107         } catch (StackOverflowError | OutOfMemoryError e) {
 108             throw new JsonParseException("Failed parsing JSON source: " + reader + " to Json", e);
 109         } finally {
 110             reader.setLenient(lenient);
 111         }
 112     }
 113
 114     private void setValue(final AbstractNodeDataWithSchema parent, final String value) {
 115         Preconditions.checkArgument(parent instanceof SimpleNodeDataWithSchema, "Node %s is not a simple type",
 116                 parent.getSchema().getQName());
 117         final SimpleNodeDataWithSchema parentSimpleNode = (SimpleNodeDataWithSchema) parent;
 118         Preconditions.checkArgument(parentSimpleNode.getValue() == null, "Node '%s' has already set its value to '%s'",
 119                 parentSimpleNode.getSchema().getQName(), parentSimpleNode.getValue());
 120
 121         final Object translatedValue = translateValueByType(value, parentSimpleNode.getSchema());
 122         parentSimpleNode.setValue(translatedValue);
 123     }
 124
 125     public void read(final JsonReader in, AbstractNodeDataWithSchema parent) throws IOException {
 126         switch (in.peek()) {
 127         case STRING:
 128         case NUMBER:
 129             setValue(parent, in.nextString());
 130             break;
 131         case BOOLEAN:
 132             setValue(parent, Boolean.toString(in.nextBoolean()));
 133             break;
 134         case NULL:
 135             in.nextNull();
 136             setValue(parent, null);
 137             break;
 138         case BEGIN_ARRAY:
 139             in.beginArray();
 140             while (in.hasNext()) {
 141                 if (parent instanceof LeafNodeDataWithSchema) {
 142                     read(in, parent);
 143                 } else {
 144                     final AbstractNodeDataWithSchema newChild = newArrayEntry(parent);
 145                     read(in, newChild);
 146                 }
 147             }
 148             in.endArray();
 149             return;
 150         case BEGIN_OBJECT:
 151             final Set<String> namesakes = new HashSet<>();
 152             in.beginObject();
 153             /*
 154              * This allows parsing of incorrectly /as showcased/
 155              * in testconf nesting of list items - eg.
 156              * lists with one value are sometimes serialized
 157              * without wrapping array.
 158              *
 159              */
 160             if (isArray(parent)) {
 161                 parent = newArrayEntry(parent);
 162             }
 163             while (in.hasNext()) {
 164                 final String jsonElementName = in.nextName();
 165                 DataSchemaNode parentSchema = parent.getSchema();
 166                 if (parentSchema instanceof YangModeledAnyXmlSchemaNode) {
 167                     parentSchema = ((YangModeledAnyXmlSchemaNode) parentSchema).getSchemaOfAnyXmlData();
 168                 }
 169                 final NamespaceAndName namespaceAndName = resolveNamespace(jsonElementName, parentSchema);
 170                 final String localName = namespaceAndName.getName();
 171                 addNamespace(namespaceAndName.getUri());
 172                 if (namesakes.contains(jsonElementName)) {
 173                     throw new JsonSyntaxException("Duplicate name " + jsonElementName + " in JSON input.");
 174                 }
 175                 namesakes.add(jsonElementName);
 176
 177                 final Deque<DataSchemaNode> childDataSchemaNodes =
 178                         ParserStreamUtils.findSchemaNodeByNameAndNamespace(parentSchema, localName, getCurrentNamespace());
 179                 if (childDataSchemaNodes.isEmpty()) {
 180                     throw new IllegalStateException("Schema for node with name " + localName + " and namespace "
 181                             + getCurrentNamespace() + " doesn't exist.");
 182                 }
 183
 184                 final AbstractNodeDataWithSchema newChild = ((CompositeNodeDataWithSchema) parent).addChild(childDataSchemaNodes);
 185                 /*
 186                  * FIXME:anyxml data shouldn't be skipped but should be loaded somehow.
 187                  * will be able to load anyxml which conforms to YANG data using these
 188                  * parser, for other anyxml will be harder.
 189                  */
 190                 if (newChild instanceof AnyXmlNodeDataWithSchema) {
 191                     in.skipValue();
 192                 } else {
 193                     read(in, newChild);
 194                 }
 195                 removeNamespace();
 196             }
 197             in.endObject();
 198             return;
 199         case END_DOCUMENT:
 200         case NAME:
 201         case END_OBJECT:
 202         case END_ARRAY:
 203             break;
 204         }
 205     }
 206
 207     private static boolean isArray(final AbstractNodeDataWithSchema parent) {
 208         return parent instanceof ListNodeDataWithSchema || parent instanceof LeafListNodeDataWithSchema;
 209     }
 210
 211     private static AbstractNodeDataWithSchema newArrayEntry(final AbstractNodeDataWithSchema parent) {
 212         AbstractNodeDataWithSchema newChild;
 213         if (parent instanceof ListNodeDataWithSchema) {
 214             newChild = new ListEntryNodeDataWithSchema(parent.getSchema());
 215         } else if (parent instanceof LeafListNodeDataWithSchema) {
 216             newChild = new LeafListEntryNodeDataWithSchema(parent.getSchema());
 217         } else {
 218             throw new IllegalStateException("Found an unexpected array nested under "+ parent.getSchema().getQName());
 219         }
 220         ((CompositeNodeDataWithSchema) parent).addChild(newChild);
 221         return newChild;
 222     }
 223
 224     private Object translateValueByType(final String value, final DataSchemaNode node) {
 225         if (node instanceof AnyXmlSchemaNode) {
 226             /*
 227              *  FIXME: Figure out some YANG extension dispatch, which will
 228              *  reuse JSON parsing or XML parsing - anyxml is not well-defined in
 229              * JSON.
 230              */
 231             return value;
 232         }
 233         return codecs.codecFor(node).deserialize(value);
 234     }
 235
 236     private void removeNamespace() {
 237         namespaces.pop();
 238     }
 239
 240     private void addNamespace(final URI namespace) {
 241         namespaces.push(namespace);
 242     }
 243
 244     private NamespaceAndName resolveNamespace(final String childName, final DataSchemaNode dataSchemaNode) {
 245         final int lastIndexOfColon = childName.lastIndexOf(':');
 246         String moduleNamePart = null;
 247         String nodeNamePart = null;
 248         URI namespace = null;
 249         if (lastIndexOfColon != -1) {
 250             moduleNamePart = childName.substring(0, lastIndexOfColon);
 251             nodeNamePart = childName.substring(lastIndexOfColon + 1);
 252
 253             final Module m = schema.findModuleByName(moduleNamePart, null);
 254             namespace = m == null ? null : m.getNamespace();
 255         } else {
 256             nodeNamePart = childName;
 257         }
 258
 259         if (namespace == null) {
 260             Set<URI> potentialUris = Collections.emptySet();
 261             potentialUris = resolveAllPotentialNamespaces(nodeNamePart, dataSchemaNode);
 262             if (potentialUris.contains(getCurrentNamespace())) {
 263                 namespace = getCurrentNamespace();
 264             } else if (potentialUris.size() == 1) {
 265                 namespace = potentialUris.iterator().next();
 266             } else if (potentialUris.size() > 1) {
 267                 throw new IllegalStateException("Choose suitable module name for element "+nodeNamePart+":"+toModuleNames(potentialUris));
 268             } else if (potentialUris.isEmpty()) {
 269                 throw new IllegalStateException("Schema node with name "+nodeNamePart+" wasn't found under "+dataSchemaNode.getQName()+".");
 270             }
 271         }
 272
 273         return new NamespaceAndName(nodeNamePart, namespace);
 274     }
 275
 276     private String toModuleNames(final Set<URI> potentialUris) {
 277         final StringBuilder builder = new StringBuilder();
 278         for (final URI potentialUri : potentialUris) {
 279             builder.append("\n");
 280             //FIXME how to get information about revision from JSON input? currently first available is used.
 281             builder.append(schema.findModuleByNamespace(potentialUri).iterator().next().getName());
 282         }
 283         return builder.toString();
 284     }
 285
 286     private Set<URI> resolveAllPotentialNamespaces(final String elementName, final DataSchemaNode dataSchemaNode) {
 287         final Set<URI> potentialUris = new HashSet<>();
 288         final Set<ChoiceSchemaNode> choices = new HashSet<>();
 289         if (dataSchemaNode instanceof DataNodeContainer) {
 290             for (final DataSchemaNode childSchemaNode : ((DataNodeContainer) dataSchemaNode).getChildNodes()) {
 291                 if (childSchemaNode instanceof ChoiceSchemaNode) {
 292                     choices.add((ChoiceSchemaNode)childSchemaNode);
 293                 } else if (childSchemaNode.getQName().getLocalName().equals(elementName)) {
 294                     potentialUris.add(childSchemaNode.getQName().getNamespace());
 295                 }
 296             }
 297
 298             for (final ChoiceSchemaNode choiceNode : choices) {
 299                 for (final ChoiceCaseNode concreteCase : choiceNode.getCases()) {
 300                     potentialUris.addAll(resolveAllPotentialNamespaces(elementName, concreteCase));
 301                 }
 302             }
 303         }
 304         return potentialUris;
 305     }
 306
 307     private URI getCurrentNamespace() {
 308         return namespaces.peek();
 309     }
 310
 311
 312
 313     private static class NamespaceAndName {
 314         private final URI uri;
 315         private final String name;
 316
 317         public NamespaceAndName(final String name, final URI uri) {
 318             this.name = name;
 319             this.uri = uri;
 320         }
 321
 322         public String getName() {
 323             return name;
 324         }
 325
 326         public URI getUri() {
 327             return uri;
 328         }
 329     }
 330
 331     @Override
 332     public void flush() throws IOException {
 333         writer.flush();
 334     }
 335
 336     @Override
 337     public void close() throws IOException {
 338         writer.flush();
 339         writer.close();
 340     }
 341 }