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 com.google.common.collect.ImmutableList;
  14 import com.google.common.collect.ImmutableList.Builder;
  15 import java.io.DataInput;
  16 import java.io.IOException;
  17 import java.io.StringReader;
  18 import java.math.BigDecimal;
  19 import java.math.BigInteger;
  20 import java.nio.charset.StandardCharsets;
  21 import java.util.HashMap;
  22 import java.util.HashSet;
  23 import java.util.Map;
  24 import java.util.Set;
  25 import javax.xml.parsers.DocumentBuilderFactory;
  26 import javax.xml.parsers.ParserConfigurationException;
  27 import javax.xml.transform.dom.DOMSource;
  28 import org.opendaylight.controller.cluster.datastore.node.utils.QNameFactory;
  29 import org.opendaylight.yangtools.util.ImmutableOffsetMapTemplate;
  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 = readNormalizedNodeWithPredicates();
 141
 142                 LOG.trace("Reading map entry node {} ", entryIdentifier);
 143
 144                 return addDataContainerChildren(Builders.mapEntryBuilder()
 145                         .withNodeIdentifier(entryIdentifier)).build();
 146
 147             default :
 148                 return readNodeIdentifierDependentNode(nodeType, new NodeIdentifier(readQName()));
 149         }
 150     }
 151
 152     private NormalizedNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier,
 153                                       Object, LeafNode<Object>> leafBuilder() {
 154         if (leafBuilder == null) {
 155             leafBuilder = Builders.leafBuilder();
 156         }
 157
 158         return leafBuilder;
 159     }
 160
 161     @SuppressWarnings("rawtypes")
 162     private NormalizedNodeAttrBuilder<NodeWithValue, Object,
 163                                       LeafSetEntryNode<Object>> leafSetEntryBuilder() {
 164         if (leafSetEntryBuilder == null) {
 165             leafSetEntryBuilder = Builders.leafSetEntryBuilder();
 166         }
 167
 168         return leafSetEntryBuilder;
 169     }
 170
 171     private NormalizedNode<?, ?> readNodeIdentifierDependentNode(final byte nodeType, final NodeIdentifier identifier)
 172         throws IOException {
 173
 174         switch (nodeType) {
 175             case NodeTypes.LEAF_NODE :
 176                 LOG.trace("Read leaf node {}", identifier);
 177                 // Read the object value
 178                 return leafBuilder().withNodeIdentifier(identifier).withValue(readObject()).build();
 179
 180             case NodeTypes.ANY_XML_NODE :
 181                 LOG.trace("Read xml node");
 182                 return Builders.anyXmlBuilder().withNodeIdentifier(identifier).withValue(readDOMSource()).build();
 183
 184             case NodeTypes.MAP_NODE :
 185                 LOG.trace("Read map node {}", identifier);
 186                 return addDataContainerChildren(Builders.mapBuilder().withNodeIdentifier(identifier)).build();
 187
 188             case NodeTypes.CHOICE_NODE:
 189                 LOG.trace("Read choice node {}", identifier);
 190                 return addDataContainerChildren(Builders.choiceBuilder().withNodeIdentifier(identifier)).build();
 191
 192             case NodeTypes.ORDERED_MAP_NODE:
 193                 LOG.trace("Reading ordered map node {}", identifier);
 194                 return addDataContainerChildren(Builders.orderedMapBuilder().withNodeIdentifier(identifier)).build();
 195
 196             case NodeTypes.UNKEYED_LIST:
 197                 LOG.trace("Read unkeyed list node {}", identifier);
 198                 return addDataContainerChildren(Builders.unkeyedListBuilder().withNodeIdentifier(identifier)).build();
 199
 200             case NodeTypes.UNKEYED_LIST_ITEM:
 201                 LOG.trace("Read unkeyed list item node {}", identifier);
 202                 return addDataContainerChildren(Builders.unkeyedListEntryBuilder()
 203                         .withNodeIdentifier(identifier)).build();
 204
 205             case NodeTypes.CONTAINER_NODE:
 206                 LOG.trace("Read container node {}", identifier);
 207                 return addDataContainerChildren(Builders.containerBuilder().withNodeIdentifier(identifier)).build();
 208
 209             case NodeTypes.LEAF_SET :
 210                 LOG.trace("Read leaf set node {}", identifier);
 211                 return addLeafSetChildren(identifier.getNodeType(),
 212                         Builders.leafSetBuilder().withNodeIdentifier(identifier)).build();
 213
 214             case NodeTypes.ORDERED_LEAF_SET:
 215                 LOG.trace("Read ordered leaf set node {}", identifier);
 216                 return addLeafSetChildren(identifier.getNodeType(),
 217                         Builders.orderedLeafSetBuilder().withNodeIdentifier(identifier)).build();
 218
 219             default:
 220                 return null;
 221         }
 222     }
 223
 224     private DOMSource readDOMSource() throws IOException {
 225         String xml = readObject().toString();
 226         try {
 227             DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
 228             factory.setNamespaceAware(true);
 229             Element node = factory.newDocumentBuilder().parse(
 230                     new InputSource(new StringReader(xml))).getDocumentElement();
 231             return new DOMSource(node);
 232         } catch (SAXException | ParserConfigurationException e) {
 233             throw new IOException("Error parsing XML: " + xml, e);
 234         }
 235     }
 236
 237     private QName readQName() throws IOException {
 238         // Read in the same sequence of writing
 239         String localName = readCodedString();
 240         String namespace = readCodedString();
 241         String revision = readCodedString();
 242
 243         String qname;
 244         if (!Strings.isNullOrEmpty(revision)) {
 245             qname = reusableStringBuilder.append('(').append(namespace).append(REVISION_ARG).append(revision)
 246                     .append(')').append(localName).toString();
 247         } else {
 248             qname = reusableStringBuilder.append('(').append(namespace).append(')').append(localName).toString();
 249         }
 250
 251         reusableStringBuilder.delete(0, reusableStringBuilder.length());
 252         return QNameFactory.create(qname);
 253     }
 254
 255
 256     private String readCodedString() throws IOException {
 257         byte valueType = input.readByte();
 258         if (valueType == TokenTypes.IS_CODE_VALUE) {
 259             return codedStringMap.get(input.readInt());
 260         } else if (valueType == TokenTypes.IS_STRING_VALUE) {
 261             String value = input.readUTF().intern();
 262             codedStringMap.put(codedStringMap.size(), value);
 263             return value;
 264         }
 265
 266         return null;
 267     }
 268
 269     private Set<QName> readQNameSet() throws IOException {
 270         // Read the children count
 271         int count = input.readInt();
 272         Set<QName> children = new HashSet<>(count);
 273         for (int i = 0; i < count; i++) {
 274             children.add(readQName());
 275         }
 276         return children;
 277     }
 278
 279     private NodeIdentifierWithPredicates readNormalizedNodeWithPredicates() throws IOException {
 280         final QName qname = readQName();
 281         final int count = input.readInt();
 282         switch (count) {
 283             case 0:
 284                 return new NodeIdentifierWithPredicates(qname);
 285             case 1:
 286                 return new NodeIdentifierWithPredicates(qname, readQName(), readObject());
 287             default:
 288                 // ImmutableList is used by ImmutableOffsetMapTemplate for lookups, hence we use that.
 289                 final Builder<QName> keys = ImmutableList.builderWithExpectedSize(count);
 290                 final Object[] values = new Object[count];
 291                 for (int i = 0; i < count; i++) {
 292                     keys.add(readQName());
 293                     values[i] = readObject();
 294                 }
 295
 296                 return new NodeIdentifierWithPredicates(qname, ImmutableOffsetMapTemplate.ordered(keys.build())
 297                     .instantiateWithValues(values));
 298         }
 299     }
 300
 301     private Object readObject() throws IOException {
 302         byte objectType = input.readByte();
 303         switch (objectType) {
 304             case ValueTypes.BITS_TYPE:
 305                 return readObjSet();
 306
 307             case ValueTypes.BOOL_TYPE :
 308                 return input.readBoolean();
 309
 310             case ValueTypes.BYTE_TYPE :
 311                 return input.readByte();
 312
 313             case ValueTypes.INT_TYPE :
 314                 return input.readInt();
 315
 316             case ValueTypes.LONG_TYPE :
 317                 return input.readLong();
 318
 319             case ValueTypes.QNAME_TYPE :
 320                 return readQName();
 321
 322             case ValueTypes.SHORT_TYPE :
 323                 return input.readShort();
 324
 325             case ValueTypes.STRING_TYPE :
 326                 return input.readUTF();
 327
 328             case ValueTypes.STRING_BYTES_TYPE:
 329                 return readStringBytes();
 330
 331             case ValueTypes.BIG_DECIMAL_TYPE :
 332                 return new BigDecimal(input.readUTF());
 333
 334             case ValueTypes.BIG_INTEGER_TYPE :
 335                 return new BigInteger(input.readUTF());
 336
 337             case ValueTypes.BINARY_TYPE :
 338                 byte[] bytes = new byte[input.readInt()];
 339                 input.readFully(bytes);
 340                 return bytes;
 341
 342             case ValueTypes.YANG_IDENTIFIER_TYPE :
 343                 return readYangInstanceIdentifierInternal();
 344
 345             case ValueTypes.EMPTY_TYPE:
 346             // Leaf nodes no longer allow null values and thus we no longer emit null values. Previously, the "empty"
 347             // yang type was represented as null so we translate an incoming null value to Empty. It was possible for
 348             // a BI user to set a string leaf to null and we're rolling the dice here but the chances for that are
 349             // very low. We'd have to know the yang type but, even if we did, we can't let a null value pass upstream
 350             // so we'd have to drop the leaf which might cause other issues.
 351             case ValueTypes.NULL_TYPE:
 352                 return Empty.getInstance();
 353
 354             default :
 355                 return null;
 356         }
 357     }
 358
 359     private String readStringBytes() throws IOException {
 360         byte[] bytes = new byte[input.readInt()];
 361         input.readFully(bytes);
 362         return new String(bytes, StandardCharsets.UTF_8);
 363     }
 364
 365     @Override
 366     public SchemaPath readSchemaPath() throws IOException {
 367         readSignatureMarkerAndVersionIfNeeded();
 368
 369         final boolean absolute = input.readBoolean();
 370         final int size = input.readInt();
 371
 372         final Builder<QName> qnames = ImmutableList.builderWithExpectedSize(size);
 373         for (int i = 0; i < size; ++i) {
 374             qnames.add(readQName());
 375         }
 376         return SchemaPath.create(qnames.build(), absolute);
 377     }
 378
 379     @Override
 380     public YangInstanceIdentifier readYangInstanceIdentifier() throws IOException {
 381         readSignatureMarkerAndVersionIfNeeded();
 382         return readYangInstanceIdentifierInternal();
 383     }
 384
 385     private YangInstanceIdentifier readYangInstanceIdentifierInternal() throws IOException {
 386         int size = input.readInt();
 387         final Builder<PathArgument> pathArguments = ImmutableList.builderWithExpectedSize(size);
 388         for (int i = 0; i < size; i++) {
 389             pathArguments.add(readPathArgument());
 390         }
 391         return YangInstanceIdentifier.create(pathArguments.build());
 392     }
 393
 394     private Set<String> readObjSet() throws IOException {
 395         int count = input.readInt();
 396         Set<String> children = new HashSet<>(count);
 397         for (int i = 0; i < count; i++) {
 398             children.add(readCodedString());
 399         }
 400         return children;
 401     }
 402
 403     @Override
 404     public PathArgument readPathArgument() throws IOException {
 405         // read Type
 406         int type = input.readByte();
 407
 408         switch (type) {
 409
 410             case PathArgumentTypes.AUGMENTATION_IDENTIFIER :
 411                 return new YangInstanceIdentifier.AugmentationIdentifier(readQNameSet());
 412
 413             case PathArgumentTypes.NODE_IDENTIFIER :
 414                 return new NodeIdentifier(readQName());
 415
 416             case PathArgumentTypes.NODE_IDENTIFIER_WITH_PREDICATES :
 417                 return readNormalizedNodeWithPredicates();
 418
 419             case PathArgumentTypes.NODE_IDENTIFIER_WITH_VALUE :
 420                 return new NodeWithValue<>(readQName(), readObject());
 421
 422             default :
 423                 return null;
 424         }
 425     }
 426
 427     @SuppressWarnings("unchecked")
 428     private ListNodeBuilder<Object, LeafSetEntryNode<Object>> addLeafSetChildren(final QName nodeType,
 429             final ListNodeBuilder<Object, LeafSetEntryNode<Object>> builder) throws IOException {
 430
 431         LOG.trace("Reading children of leaf set");
 432
 433         lastLeafSetQName = nodeType;
 434
 435         LeafSetEntryNode<Object> child = (LeafSetEntryNode<Object>)readNormalizedNodeInternal();
 436
 437         while (child != null) {
 438             builder.withChild(child);
 439             child = (LeafSetEntryNode<Object>)readNormalizedNodeInternal();
 440         }
 441         return builder;
 442     }
 443
 444     @SuppressWarnings({ "unchecked", "rawtypes" })
 445     private NormalizedNodeContainerBuilder addDataContainerChildren(
 446             final NormalizedNodeContainerBuilder builder) throws IOException {
 447         LOG.trace("Reading data container (leaf nodes) nodes");
 448
 449         NormalizedNode<?, ?> child = readNormalizedNodeInternal();
 450
 451         while (child != null) {
 452             builder.addChild(child);
 453             child = readNormalizedNodeInternal();
 454         }
 455         return builder;
 456     }
 457
 458     @Override
 459     public void readFully(final byte[] value) throws IOException {
 460         readSignatureMarkerAndVersionIfNeeded();
 461         input.readFully(value);
 462     }
 463
 464     @Override
 465     public void readFully(final byte[] str, final int off, final int len) throws IOException {
 466         readSignatureMarkerAndVersionIfNeeded();
 467         input.readFully(str, off, len);
 468     }
 469
 470     @Override
 471     public int skipBytes(final int num) throws IOException {
 472         readSignatureMarkerAndVersionIfNeeded();
 473         return input.skipBytes(num);
 474     }
 475
 476     @Override
 477     public boolean readBoolean() throws IOException {
 478         readSignatureMarkerAndVersionIfNeeded();
 479         return input.readBoolean();
 480     }
 481
 482     @Override
 483     public byte readByte() throws IOException {
 484         readSignatureMarkerAndVersionIfNeeded();
 485         return input.readByte();
 486     }
 487
 488     @Override
 489     public int readUnsignedByte() throws IOException {
 490         readSignatureMarkerAndVersionIfNeeded();
 491         return input.readUnsignedByte();
 492     }
 493
 494     @Override
 495     public short readShort() throws IOException {
 496         readSignatureMarkerAndVersionIfNeeded();
 497         return input.readShort();
 498     }
 499
 500     @Override
 501     public int readUnsignedShort() throws IOException {
 502         readSignatureMarkerAndVersionIfNeeded();
 503         return input.readUnsignedShort();
 504     }
 505
 506     @Override
 507     public char readChar() throws IOException {
 508         readSignatureMarkerAndVersionIfNeeded();
 509         return input.readChar();
 510     }
 511
 512     @Override
 513     public int readInt() throws IOException {
 514         readSignatureMarkerAndVersionIfNeeded();
 515         return input.readInt();
 516     }
 517
 518     @Override
 519     public long readLong() throws IOException {
 520         readSignatureMarkerAndVersionIfNeeded();
 521         return input.readLong();
 522     }
 523
 524     @Override
 525     public float readFloat() throws IOException {
 526         readSignatureMarkerAndVersionIfNeeded();
 527         return input.readFloat();
 528     }
 529
 530     @Override
 531     public double readDouble() throws IOException {
 532         readSignatureMarkerAndVersionIfNeeded();
 533         return input.readDouble();
 534     }
 535
 536     @Override
 537     public String readLine() throws IOException {
 538         readSignatureMarkerAndVersionIfNeeded();
 539         return input.readLine();
 540     }
 541
 542     @Override
 543     public String readUTF() throws IOException {
 544         readSignatureMarkerAndVersionIfNeeded();
 545         return input.readUTF();
 546     }
 547 }