opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/datastore/node/utils/stream/NormalizedNodeInputStreamReader.java

   1 /*
   2  * Copyright (c) 2014, 2015 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.controller.cluster.datastore.node.utils.stream;
  10
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.base.Strings;
  13 import java.io.DataInput;
  14 import java.io.IOException;
  15 import java.io.StringReader;
  16 import java.math.BigDecimal;
  17 import java.math.BigInteger;
  18 import java.nio.charset.StandardCharsets;
  19 import java.util.ArrayList;
  20 import java.util.Collection;
  21 import java.util.HashMap;
  22 import java.util.HashSet;
  23 import java.util.List;
  24 import java.util.Map;
  25 import java.util.Set;
  26 import javax.xml.parsers.DocumentBuilderFactory;
  27 import javax.xml.parsers.ParserConfigurationException;
  28 import javax.xml.transform.dom.DOMSource;
  29 import org.opendaylight.controller.cluster.datastore.node.utils.QNameFactory;
  30 import org.opendaylight.yangtools.yang.common.Empty;
  31 import org.opendaylight.yangtools.yang.common.QName;
  32 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  35 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  36 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  37 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  38 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  39 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  40 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  41 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
  42 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeAttrBuilder;
  43 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeContainerBuilder;
  44 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  45 import org.slf4j.Logger;
  46 import org.slf4j.LoggerFactory;
  47 import org.w3c.dom.Element;
  48 import org.xml.sax.InputSource;
  49 import org.xml.sax.SAXException;
  50
  51 /**
  52  * NormalizedNodeInputStreamReader reads the byte stream and constructs the normalized node including its children
  53  * nodes. This process goes in recursive manner, where each NodeTypes object signifies the start of the object, except
  54  * END_NODE. If a node can have children, then that node's end is calculated based on appearance of END_NODE.
  55  */
  56 public class NormalizedNodeInputStreamReader implements NormalizedNodeDataInput {
  57
  58     private static final Logger LOG = LoggerFactory.getLogger(NormalizedNodeInputStreamReader.class);
  59
  60     private static final String REVISION_ARG = "?revision=";
  61
  62     private final DataInput input;
  63
  64     private final Map<Integer, String> codedStringMap = new HashMap<>();
  65
  66     private QName lastLeafSetQName;
  67
  68     private NormalizedNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier,
  69                                       Object, LeafNode<Object>> leafBuilder;
  70
  71     @SuppressWarnings("rawtypes")
  72     private NormalizedNodeAttrBuilder<NodeWithValue, Object, LeafSetEntryNode<Object>> leafSetEntryBuilder;
  73
  74     private final StringBuilder reusableStringBuilder = new StringBuilder(50);
  75
  76     private boolean readSignatureMarker = true;
  77
  78     NormalizedNodeInputStreamReader(final DataInput input, final boolean versionChecked) {
  79         this.input = Preconditions.checkNotNull(input);
  80         readSignatureMarker = !versionChecked;
  81     }
  82
  83     @Override
  84     public NormalizedNode<?, ?> readNormalizedNode() throws IOException {
  85         readSignatureMarkerAndVersionIfNeeded();
  86         return readNormalizedNodeInternal();
  87     }
  88
  89     private void readSignatureMarkerAndVersionIfNeeded() throws IOException {
  90         if (readSignatureMarker) {
  91             readSignatureMarker = false;
  92
  93             final byte marker = input.readByte();
  94             if (marker != TokenTypes.SIGNATURE_MARKER) {
  95                 throw new InvalidNormalizedNodeStreamException(String.format(
  96                         "Invalid signature marker: %d", marker));
  97             }
  98
  99             final short version = input.readShort();
 100             if (version != TokenTypes.LITHIUM_VERSION) {
 101                 throw new InvalidNormalizedNodeStreamException(String.format("Unhandled stream version %s", version));
 102             }
 103         }
 104     }
 105
 106     private NormalizedNode<?, ?> readNormalizedNodeInternal() throws IOException {
 107         // each node should start with a byte
 108         byte nodeType = input.readByte();
 109
 110         if (nodeType == NodeTypes.END_NODE) {
 111             LOG.trace("End node reached. return");
 112             lastLeafSetQName = null;
 113             return null;
 114         }
 115
 116         switch (nodeType) {
 117             case NodeTypes.AUGMENTATION_NODE :
 118                 YangInstanceIdentifier.AugmentationIdentifier augIdentifier =
 119                     new YangInstanceIdentifier.AugmentationIdentifier(readQNameSet());
 120
 121                 LOG.trace("Reading augmentation node {} ", augIdentifier);
 122
 123                 return addDataContainerChildren(Builders.augmentationBuilder()
 124                         .withNodeIdentifier(augIdentifier)).build();
 125
 126             case NodeTypes.LEAF_SET_ENTRY_NODE :
 127                 QName name = lastLeafSetQName;
 128                 if (name == null) {
 129                     name = readQName();
 130                 }
 131
 132                 Object value = readObject();
 133                 NodeWithValue<Object> leafIdentifier = new NodeWithValue<>(name, value);
 134
 135                 LOG.trace("Reading leaf set entry node {}, value {}", leafIdentifier, value);
 136
 137                 return leafSetEntryBuilder().withNodeIdentifier(leafIdentifier).withValue(value).build();
 138
 139             case NodeTypes.MAP_ENTRY_NODE :
 140                 NodeIdentifierWithPredicates entryIdentifier = new NodeIdentifierWithPredicates(
 141                         readQName(), readKeyValueMap());
 142
 143                 LOG.trace("Reading map entry node {} ", entryIdentifier);
 144
 145                 return addDataContainerChildren(Builders.mapEntryBuilder()
 146                         .withNodeIdentifier(entryIdentifier)).build();
 147
 148             default :
 149                 return readNodeIdentifierDependentNode(nodeType, new NodeIdentifier(readQName()));
 150         }
 151     }
 152
 153     private NormalizedNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier,
 154                                       Object, LeafNode<Object>> leafBuilder() {
 155         if (leafBuilder == null) {
 156             leafBuilder = Builders.leafBuilder();
 157         }
 158
 159         return leafBuilder;
 160     }
 161
 162     @SuppressWarnings("rawtypes")
 163     private NormalizedNodeAttrBuilder<NodeWithValue, Object,
 164                                       LeafSetEntryNode<Object>> leafSetEntryBuilder() {
 165         if (leafSetEntryBuilder == null) {
 166             leafSetEntryBuilder = Builders.leafSetEntryBuilder();
 167         }
 168
 169         return leafSetEntryBuilder;
 170     }
 171
 172     private NormalizedNode<?, ?> readNodeIdentifierDependentNode(final byte nodeType, final NodeIdentifier identifier)
 173         throws IOException {
 174
 175         switch (nodeType) {
 176             case NodeTypes.LEAF_NODE :
 177                 LOG.trace("Read leaf node {}", identifier);
 178                 // Read the object value
 179                 return leafBuilder().withNodeIdentifier(identifier).withValue(readObject()).build();
 180
 181             case NodeTypes.ANY_XML_NODE :
 182                 LOG.trace("Read xml node");
 183                 return Builders.anyXmlBuilder().withNodeIdentifier(identifier).withValue(readDOMSource()).build();
 184
 185             case NodeTypes.MAP_NODE :
 186                 LOG.trace("Read map node {}", identifier);
 187                 return addDataContainerChildren(Builders.mapBuilder().withNodeIdentifier(identifier)).build();
 188
 189             case NodeTypes.CHOICE_NODE:
 190                 LOG.trace("Read choice node {}", identifier);
 191                 return addDataContainerChildren(Builders.choiceBuilder().withNodeIdentifier(identifier)).build();
 192
 193             case NodeTypes.ORDERED_MAP_NODE:
 194                 LOG.trace("Reading ordered map node {}", identifier);
 195                 return addDataContainerChildren(Builders.orderedMapBuilder().withNodeIdentifier(identifier)).build();
 196
 197             case NodeTypes.UNKEYED_LIST:
 198                 LOG.trace("Read unkeyed list node {}", identifier);
 199                 return addDataContainerChildren(Builders.unkeyedListBuilder().withNodeIdentifier(identifier)).build();
 200
 201             case NodeTypes.UNKEYED_LIST_ITEM:
 202                 LOG.trace("Read unkeyed list item node {}", identifier);
 203                 return addDataContainerChildren(Builders.unkeyedListEntryBuilder()
 204                         .withNodeIdentifier(identifier)).build();
 205
 206             case NodeTypes.CONTAINER_NODE:
 207                 LOG.trace("Read container node {}", identifier);
 208                 return addDataContainerChildren(Builders.containerBuilder().withNodeIdentifier(identifier)).build();
 209
 210             case NodeTypes.LEAF_SET :
 211                 LOG.trace("Read leaf set node {}", identifier);
 212                 return addLeafSetChildren(identifier.getNodeType(),
 213                         Builders.leafSetBuilder().withNodeIdentifier(identifier)).build();
 214
 215             case NodeTypes.ORDERED_LEAF_SET:
 216                 LOG.trace("Read ordered leaf set node {}", identifier);
 217                 ListNodeBuilder<Object, LeafSetEntryNode<Object>> orderedLeafSetBuilder =
 218                         Builders.orderedLeafSetBuilder().withNodeIdentifier(identifier);
 219                 orderedLeafSetBuilder = addLeafSetChildren(identifier.getNodeType(), orderedLeafSetBuilder);
 220                 return orderedLeafSetBuilder.build();
 221
 222             default :
 223                 return null;
 224         }
 225     }
 226
 227     private DOMSource readDOMSource() throws IOException {
 228         String xml = readObject().toString();
 229         try {
 230             DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
 231             factory.setNamespaceAware(true);
 232             Element node = factory.newDocumentBuilder().parse(
 233                     new InputSource(new StringReader(xml))).getDocumentElement();
 234             return new DOMSource(node);
 235         } catch (SAXException | ParserConfigurationException e) {
 236             throw new IOException("Error parsing XML: " + xml, e);
 237         }
 238     }
 239
 240     private QName readQName() throws IOException {
 241         // Read in the same sequence of writing
 242         String localName = readCodedString();
 243         String namespace = readCodedString();
 244         String revision = readCodedString();
 245
 246         String qname;
 247         if (!Strings.isNullOrEmpty(revision)) {
 248             qname = reusableStringBuilder.append('(').append(namespace).append(REVISION_ARG).append(revision)
 249                     .append(')').append(localName).toString();
 250         } else {
 251             qname = reusableStringBuilder.append('(').append(namespace).append(')').append(localName).toString();
 252         }
 253
 254         reusableStringBuilder.delete(0, reusableStringBuilder.length());
 255         return QNameFactory.create(qname);
 256     }
 257
 258
 259     private String readCodedString() throws IOException {
 260         byte valueType = input.readByte();
 261         if (valueType == TokenTypes.IS_CODE_VALUE) {
 262             return codedStringMap.get(input.readInt());
 263         } else if (valueType == TokenTypes.IS_STRING_VALUE) {
 264             String value = input.readUTF().intern();
 265             codedStringMap.put(codedStringMap.size(), value);
 266             return value;
 267         }
 268
 269         return null;
 270     }
 271
 272     private Set<QName> readQNameSet() throws IOException {
 273         // Read the children count
 274         int count = input.readInt();
 275         Set<QName> children = new HashSet<>(count);
 276         for (int i = 0; i < count; i++) {
 277             children.add(readQName());
 278         }
 279         return children;
 280     }
 281
 282     private Map<QName, Object> readKeyValueMap() throws IOException {
 283         int count = input.readInt();
 284         Map<QName, Object> keyValueMap = new HashMap<>(count);
 285
 286         for (int i = 0; i < count; i++) {
 287             keyValueMap.put(readQName(), readObject());
 288         }
 289
 290         return keyValueMap;
 291     }
 292
 293     private Object readObject() throws IOException {
 294         byte objectType = input.readByte();
 295         switch (objectType) {
 296             case ValueTypes.BITS_TYPE:
 297                 return readObjSet();
 298
 299             case ValueTypes.BOOL_TYPE :
 300                 return input.readBoolean();
 301
 302             case ValueTypes.BYTE_TYPE :
 303                 return input.readByte();
 304
 305             case ValueTypes.INT_TYPE :
 306                 return input.readInt();
 307
 308             case ValueTypes.LONG_TYPE :
 309                 return input.readLong();
 310
 311             case ValueTypes.QNAME_TYPE :
 312                 return readQName();
 313
 314             case ValueTypes.SHORT_TYPE :
 315                 return input.readShort();
 316
 317             case ValueTypes.STRING_TYPE :
 318                 return input.readUTF();
 319
 320             case ValueTypes.STRING_BYTES_TYPE:
 321                 return readStringBytes();
 322
 323             case ValueTypes.BIG_DECIMAL_TYPE :
 324                 return new BigDecimal(input.readUTF());
 325
 326             case ValueTypes.BIG_INTEGER_TYPE :
 327                 return new BigInteger(input.readUTF());
 328
 329             case ValueTypes.BINARY_TYPE :
 330                 byte[] bytes = new byte[input.readInt()];
 331                 input.readFully(bytes);
 332                 return bytes;
 333
 334             case ValueTypes.YANG_IDENTIFIER_TYPE :
 335                 return readYangInstanceIdentifierInternal();
 336
 337             case ValueTypes.EMPTY_TYPE:
 338             // Leaf nodes no longer allow null values and thus we no longer emit null values. Previously, the "empty"
 339             // yang type was represented as null so we translate an incoming null value to Empty. It was possible for
 340             // a BI user to set a string leaf to null and we're rolling the dice here but the chances for that are
 341             // very low. We'd have to know the yang type but, even if we did, we can't let a null value pass upstream
 342             // so we'd have to drop the leaf which might cause other issues.
 343             case ValueTypes.NULL_TYPE:
 344                 return Empty.getInstance();
 345
 346             default :
 347                 return null;
 348         }
 349     }
 350
 351     private String readStringBytes() throws IOException {
 352         byte[] bytes = new byte[input.readInt()];
 353         input.readFully(bytes);
 354         return new String(bytes, StandardCharsets.UTF_8);
 355     }
 356
 357     @Override
 358     public SchemaPath readSchemaPath() throws IOException {
 359         readSignatureMarkerAndVersionIfNeeded();
 360
 361         final boolean absolute = input.readBoolean();
 362         final int size = input.readInt();
 363         final Collection<QName> qnames = new ArrayList<>(size);
 364         for (int i = 0; i < size; ++i) {
 365             qnames.add(readQName());
 366         }
 367
 368         return SchemaPath.create(qnames, absolute);
 369     }
 370
 371     @Override
 372     public YangInstanceIdentifier readYangInstanceIdentifier() throws IOException {
 373         readSignatureMarkerAndVersionIfNeeded();
 374         return readYangInstanceIdentifierInternal();
 375     }
 376
 377     private YangInstanceIdentifier readYangInstanceIdentifierInternal() throws IOException {
 378         int size = input.readInt();
 379
 380         List<PathArgument> pathArguments = new ArrayList<>(size);
 381
 382         for (int i = 0; i < size; i++) {
 383             pathArguments.add(readPathArgument());
 384         }
 385         return YangInstanceIdentifier.create(pathArguments);
 386     }
 387
 388     private Set<String> readObjSet() throws IOException {
 389         int count = input.readInt();
 390         Set<String> children = new HashSet<>(count);
 391         for (int i = 0; i < count; i++) {
 392             children.add(readCodedString());
 393         }
 394         return children;
 395     }
 396
 397     @Override
 398     public PathArgument readPathArgument() throws IOException {
 399         // read Type
 400         int type = input.readByte();
 401
 402         switch (type) {
 403
 404             case PathArgumentTypes.AUGMENTATION_IDENTIFIER :
 405                 return new YangInstanceIdentifier.AugmentationIdentifier(readQNameSet());
 406
 407             case PathArgumentTypes.NODE_IDENTIFIER :
 408                 return new NodeIdentifier(readQName());
 409
 410             case PathArgumentTypes.NODE_IDENTIFIER_WITH_PREDICATES :
 411                 return new NodeIdentifierWithPredicates(readQName(), readKeyValueMap());
 412
 413             case PathArgumentTypes.NODE_IDENTIFIER_WITH_VALUE :
 414                 return new NodeWithValue<>(readQName(), readObject());
 415
 416             default :
 417                 return null;
 418         }
 419     }
 420
 421     @SuppressWarnings("unchecked")
 422     private ListNodeBuilder<Object, LeafSetEntryNode<Object>> addLeafSetChildren(final QName nodeType,
 423             final ListNodeBuilder<Object, LeafSetEntryNode<Object>> builder) throws IOException {
 424
 425         LOG.trace("Reading children of leaf set");
 426
 427         lastLeafSetQName = nodeType;
 428
 429         LeafSetEntryNode<Object> child = (LeafSetEntryNode<Object>)readNormalizedNodeInternal();
 430
 431         while (child != null) {
 432             builder.withChild(child);
 433             child = (LeafSetEntryNode<Object>)readNormalizedNodeInternal();
 434         }
 435         return builder;
 436     }
 437
 438     @SuppressWarnings({ "unchecked", "rawtypes" })
 439     private NormalizedNodeContainerBuilder addDataContainerChildren(
 440             final NormalizedNodeContainerBuilder builder) throws IOException {
 441         LOG.trace("Reading data container (leaf nodes) nodes");
 442
 443         NormalizedNode<?, ?> child = readNormalizedNodeInternal();
 444
 445         while (child != null) {
 446             builder.addChild(child);
 447             child = readNormalizedNodeInternal();
 448         }
 449         return builder;
 450     }
 451
 452     @Override
 453     public void readFully(final byte[] value) throws IOException {
 454         readSignatureMarkerAndVersionIfNeeded();
 455         input.readFully(value);
 456     }
 457
 458     @Override
 459     public void readFully(final byte[] str, final int off, final int len) throws IOException {
 460         readSignatureMarkerAndVersionIfNeeded();
 461         input.readFully(str, off, len);
 462     }
 463
 464     @Override
 465     public int skipBytes(final int num) throws IOException {
 466         readSignatureMarkerAndVersionIfNeeded();
 467         return input.skipBytes(num);
 468     }
 469
 470     @Override
 471     public boolean readBoolean() throws IOException {
 472         readSignatureMarkerAndVersionIfNeeded();
 473         return input.readBoolean();
 474     }
 475
 476     @Override
 477     public byte readByte() throws IOException {
 478         readSignatureMarkerAndVersionIfNeeded();
 479         return input.readByte();
 480     }
 481
 482     @Override
 483     public int readUnsignedByte() throws IOException {
 484         readSignatureMarkerAndVersionIfNeeded();
 485         return input.readUnsignedByte();
 486     }
 487
 488     @Override
 489     public short readShort() throws IOException {
 490         readSignatureMarkerAndVersionIfNeeded();
 491         return input.readShort();
 492     }
 493
 494     @Override
 495     public int readUnsignedShort() throws IOException {
 496         readSignatureMarkerAndVersionIfNeeded();
 497         return input.readUnsignedShort();
 498     }
 499
 500     @Override
 501     public char readChar() throws IOException {
 502         readSignatureMarkerAndVersionIfNeeded();
 503         return input.readChar();
 504     }
 505
 506     @Override
 507     public int readInt() throws IOException {
 508         readSignatureMarkerAndVersionIfNeeded();
 509         return input.readInt();
 510     }
 511
 512     @Override
 513     public long readLong() throws IOException {
 514         readSignatureMarkerAndVersionIfNeeded();
 515         return input.readLong();
 516     }
 517
 518     @Override
 519     public float readFloat() throws IOException {
 520         readSignatureMarkerAndVersionIfNeeded();
 521         return input.readFloat();
 522     }
 523
 524     @Override
 525     public double readDouble() throws IOException {
 526         readSignatureMarkerAndVersionIfNeeded();
 527         return input.readDouble();
 528     }
 529
 530     @Override
 531     public String readLine() throws IOException {
 532         readSignatureMarkerAndVersionIfNeeded();
 533         return input.readLine();
 534     }
 535
 536     @Override
 537     public String readUTF() throws IOException {
 538         readSignatureMarkerAndVersionIfNeeded();
 539         return input.readUTF();
 540     }
 541 }