restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/utils/parser/YangInstanceIdentifierDeserializer.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 package org.opendaylight.restconf.nb.rfc8040.utils.parser;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.base.CharMatcher;
  13 import com.google.common.collect.ImmutableList;
  14 import com.google.common.collect.ImmutableMap;
  15 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  16 import java.util.ArrayList;
  17 import java.util.Iterator;
  18 import java.util.List;
  19 import java.util.Optional;
  20 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  21 import org.opendaylight.restconf.common.util.RestUtil;
  22 import org.opendaylight.restconf.common.util.RestconfSchemaUtil;
  23 import org.opendaylight.restconf.nb.rfc8040.codecs.RestCodec;
  24 import org.opendaylight.yangtools.yang.common.ErrorTag;
  25 import org.opendaylight.yangtools.yang.common.ErrorType;
  26 import org.opendaylight.yangtools.yang.common.QName;
  27 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  29 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  30 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextNode;
  31 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
  32 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
  33 import org.opendaylight.yangtools.yang.model.api.ActionNodeContainer;
  34 import org.opendaylight.yangtools.yang.model.api.ContainerLike;
  35 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  36 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  37 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  38 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
  39 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  40 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  41 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  42 import org.opendaylight.yangtools.yang.model.api.Module;
  43 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  44 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  45 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  46 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  47 import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
  48 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
  49 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  50
  51 /**
  52  * Deserializer for {@link String} to {@link YangInstanceIdentifier} for restconf.
  53  */
  54 public final class YangInstanceIdentifierDeserializer {
  55     private static final CharMatcher IDENTIFIER_PREDICATE =
  56             CharMatcher.noneOf(ParserConstants.RFC3986_RESERVED_CHARACTERS).precomputed();
  57     private static final CharMatcher PERCENT_ENCODING = CharMatcher.is('%');
  58     // position of the first encoded char after percent sign in percent encoded string
  59     private static final int FIRST_ENCODED_CHAR = 1;
  60     // position of the last encoded char after percent sign in percent encoded string
  61     private static final int LAST_ENCODED_CHAR = 3;
  62     // percent encoded radix for parsing integers
  63     private static final int PERCENT_ENCODED_RADIX = 16;
  64
  65     private final EffectiveModelContext schemaContext;
  66     private final String data;
  67
  68     private DataSchemaContextNode<?> current;
  69     private int offset;
  70
  71     private YangInstanceIdentifierDeserializer(final EffectiveModelContext schemaContext, final String data) {
  72         this.schemaContext = requireNonNull(schemaContext);
  73         this.data = requireNonNull(data);
  74         current = DataSchemaContextTree.from(schemaContext).getRoot();
  75     }
  76
  77     /**
  78      * Method to create {@link Iterable} from {@link PathArgument} which are parsing from data by {@link SchemaContext}.
  79      *
  80      * @param schemaContext for validate of parsing path arguments
  81      * @param data path to data, in URL string form
  82      * @return {@link Iterable} of {@link PathArgument}
  83      */
  84     public static List<PathArgument> create(final EffectiveModelContext schemaContext, final String data) {
  85         return new YangInstanceIdentifierDeserializer(schemaContext, data).parse();
  86     }
  87
  88     private List<PathArgument> parse() {
  89         final List<PathArgument> path = new ArrayList<>();
  90
  91         while (!allCharsConsumed()) {
  92             validArg();
  93             final QName qname = prepareQName();
  94
  95             // this is the last identifier (input is consumed) or end of identifier (slash)
  96             if (allCharsConsumed() || currentChar() == '/') {
  97                 prepareIdentifier(qname, path);
  98                 path.add(current == null ? NodeIdentifier.create(qname) : current.getIdentifier());
  99             } else if (currentChar() == '=') {
 100                 if (nextContextNode(qname, path).getDataSchemaNode() instanceof ListSchemaNode) {
 101                     prepareNodeWithPredicates(qname, path, (ListSchemaNode) current.getDataSchemaNode());
 102                 } else {
 103                     prepareNodeWithValue(qname, path);
 104                 }
 105             } else {
 106                 throw getParsingCharFailedException();
 107             }
 108         }
 109
 110         return ImmutableList.copyOf(path);
 111     }
 112
 113     private void prepareNodeWithPredicates(final QName qname, final List<PathArgument> path,
 114             final ListSchemaNode listSchemaNode) {
 115         checkValid(listSchemaNode != null, ErrorTag.MALFORMED_MESSAGE, "Data schema node is null");
 116
 117         final Iterator<QName> keys = listSchemaNode.getKeyDefinition().iterator();
 118         final ImmutableMap.Builder<QName, Object> values = ImmutableMap.builder();
 119
 120         // skip already expected equal sign
 121         skipCurrentChar();
 122
 123         // read key value separated by comma
 124         while (keys.hasNext() && !allCharsConsumed() && currentChar() != '/') {
 125
 126             // empty key value
 127             if (currentChar() == ',') {
 128                 values.put(keys.next(), "");
 129                 skipCurrentChar();
 130                 continue;
 131             }
 132
 133             // check if next value is parsable
 134             checkValid(IDENTIFIER_PREDICATE.matches(currentChar()), ErrorTag.MALFORMED_MESSAGE,
 135                     "Value that starts with character %c is not parsable.", currentChar());
 136
 137             // parse value
 138             final QName key = keys.next();
 139             Optional<DataSchemaNode> leafSchemaNode = listSchemaNode.findDataChildByName(key);
 140             RestconfDocumentedException.throwIf(leafSchemaNode.isEmpty(), ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT,
 141                     "Schema not found for %s", key);
 142
 143             final String value = findAndParsePercentEncoded(nextIdentifierFromNextSequence(IDENTIFIER_PREDICATE));
 144             final Object valueByType = prepareValueByType(leafSchemaNode.get(), value);
 145             values.put(key, valueByType);
 146
 147             // skip comma
 148             if (keys.hasNext() && !allCharsConsumed() && currentChar() == ',') {
 149                 skipCurrentChar();
 150             }
 151         }
 152
 153         // the last key is considered to be empty
 154         if (keys.hasNext()) {
 155             // at this point, it must be true that current char is '/' or all chars have already been consumed
 156             values.put(keys.next(), "");
 157
 158             // there should be no more missing keys
 159             RestconfDocumentedException.throwIf(keys.hasNext(), ErrorType.PROTOCOL, ErrorTag.MISSING_ATTRIBUTE,
 160                     "Cannot parse input identifier '%s'. Key value is missing for QName: %s", data, qname);
 161         }
 162
 163         path.add(YangInstanceIdentifier.NodeIdentifierWithPredicates.of(qname, values.build()));
 164     }
 165
 166     private Object prepareValueByType(final DataSchemaNode schemaNode, final String value) {
 167         Object decoded;
 168
 169         TypeDefinition<? extends TypeDefinition<?>> typedef;
 170         if (schemaNode instanceof LeafListSchemaNode) {
 171             typedef = ((LeafListSchemaNode) schemaNode).getType();
 172         } else {
 173             typedef = ((LeafSchemaNode) schemaNode).getType();
 174         }
 175         final TypeDefinition<?> baseType = RestUtil.resolveBaseTypeFrom(typedef);
 176         if (baseType instanceof LeafrefTypeDefinition) {
 177             typedef = SchemaInferenceStack.ofInstantiatedPath(schemaContext, schemaNode.getPath())
 178                 .resolveLeafref((LeafrefTypeDefinition) baseType);
 179         }
 180         decoded = RestCodec.from(typedef, null, schemaContext).deserialize(value);
 181         if (decoded == null && typedef instanceof IdentityrefTypeDefinition) {
 182             decoded = toIdentityrefQName(value, schemaNode);
 183         }
 184         return decoded;
 185     }
 186
 187     private QName prepareQName() {
 188         checkValidIdentifierStart();
 189         final String preparedPrefix = nextIdentifierFromNextSequence(ParserConstants.YANG_IDENTIFIER_PART);
 190         final String prefix;
 191         final String localName;
 192
 193         if (allCharsConsumed()) {
 194             return getQNameOfDataSchemaNode(preparedPrefix);
 195         }
 196
 197         switch (currentChar()) {
 198             case '/':
 199             case '=':
 200                 prefix = preparedPrefix;
 201                 return getQNameOfDataSchemaNode(prefix);
 202             case ':':
 203                 prefix = preparedPrefix;
 204                 skipCurrentChar();
 205                 checkValidIdentifierStart();
 206                 localName = nextIdentifierFromNextSequence(ParserConstants.YANG_IDENTIFIER_PART);
 207
 208                 if (!allCharsConsumed() && currentChar() == '=') {
 209                     return getQNameOfDataSchemaNode(localName);
 210                 } else {
 211                     final Module module = moduleForPrefix(prefix);
 212                     RestconfDocumentedException.throwIf(module == null, ErrorType.PROTOCOL, ErrorTag.UNKNOWN_ELEMENT,
 213                             "Failed to lookup for module with name '%s'.", prefix);
 214                     return QName.create(module.getQNameModule(), localName);
 215                 }
 216             default:
 217                 throw getParsingCharFailedException();
 218         }
 219     }
 220
 221     private void prepareNodeWithValue(final QName qname, final List<PathArgument> path) {
 222         skipCurrentChar();
 223         final String value = nextIdentifierFromNextSequence(IDENTIFIER_PREDICATE);
 224
 225         // exception if value attribute is missing
 226         RestconfDocumentedException.throwIf(value.isEmpty(), ErrorType.PROTOCOL, ErrorTag.MISSING_ATTRIBUTE,
 227                 "Cannot parse input identifier '%s' - value is missing for QName: %s.", data, qname);
 228         final DataSchemaNode dataSchemaNode = current.getDataSchemaNode();
 229         final Object valueByType = prepareValueByType(dataSchemaNode, findAndParsePercentEncoded(value));
 230         path.add(new YangInstanceIdentifier.NodeWithValue<>(qname, valueByType));
 231     }
 232
 233     private void prepareIdentifier(final QName qname, final List<PathArgument> path) {
 234         final DataSchemaContextNode<?> currentNode = nextContextNode(qname, path);
 235         if (currentNode != null) {
 236             checkValid(!currentNode.isKeyedEntry(), ErrorTag.MISSING_ATTRIBUTE,
 237                     "Entry '%s' requires key or value predicate to be present.", qname);
 238         }
 239     }
 240
 241     @SuppressFBWarnings(value = "NP_NULL_ON_SOME_PATH",
 242             justification = "code does check for null 'current' but FB doesn't recognize it")
 243     private DataSchemaContextNode<?> nextContextNode(final QName qname, final List<PathArgument> path) {
 244         final DataSchemaContextNode<?> initialContext = current;
 245         final DataSchemaNode initialDataSchema = initialContext.getDataSchemaNode();
 246
 247         current = initialContext.getChild(qname);
 248
 249         if (current == null) {
 250             final Optional<Module> module = schemaContext.findModule(qname.getModule());
 251             if (module.isPresent()) {
 252                 for (final RpcDefinition rpcDefinition : module.get().getRpcs()) {
 253                     if (rpcDefinition.getQName().getLocalName().equals(qname.getLocalName())) {
 254                         return null;
 255                     }
 256                 }
 257             }
 258             if (findActionDefinition(initialDataSchema, qname.getLocalName()).isPresent()) {
 259                 return null;
 260             }
 261         }
 262         checkValid(current != null, ErrorTag.MALFORMED_MESSAGE, "'%s' is not correct schema node identifier.", qname);
 263         while (current.isMixin()) {
 264             path.add(current.getIdentifier());
 265             current = current.getChild(qname);
 266         }
 267         return current;
 268     }
 269
 270     private Module moduleForPrefix(final String prefix) {
 271         return schemaContext.findModules(prefix).stream().findFirst().orElse(null);
 272     }
 273
 274     private boolean allCharsConsumed() {
 275         return offset == data.length();
 276     }
 277
 278     private void checkValid(final boolean condition, final ErrorTag errorTag, final String errorMsg) {
 279         if (!condition) {
 280             throw createParsingException(errorTag, errorMsg);
 281         }
 282     }
 283
 284     private void checkValid(final boolean condition, final ErrorTag errorTag, final String fmt, final Object arg) {
 285         if (!condition) {
 286             throw createParsingException(errorTag, String.format(fmt, arg));
 287         }
 288     }
 289
 290     private void checkValidIdentifierStart() {
 291         checkValid(ParserConstants.YANG_IDENTIFIER_START.matches(currentChar()), ErrorTag.MALFORMED_MESSAGE,
 292             "Identifier must start with character from set 'a-zA-Z_'");
 293     }
 294
 295     private RestconfDocumentedException getParsingCharFailedException() {
 296         return createParsingException(ErrorTag.MALFORMED_MESSAGE,
 297             "Bad char '" + currentChar() + "' on the current position.");
 298     }
 299
 300     private RestconfDocumentedException createParsingException(final ErrorTag errorTag, final String messagePart) {
 301         return new RestconfDocumentedException(String.format(
 302             "Could not parse Instance Identifier '%s'. Offset: '%d' : Reason: %s", data, offset, messagePart),
 303             ErrorType.PROTOCOL, errorTag);
 304     }
 305
 306     private char currentChar() {
 307         return data.charAt(offset);
 308     }
 309
 310     private void skipCurrentChar() {
 311         offset++;
 312     }
 313
 314     private String nextIdentifierFromNextSequence(final CharMatcher matcher) {
 315         final int start = offset;
 316         while (!allCharsConsumed() && matcher.matches(currentChar())) {
 317             skipCurrentChar();
 318         }
 319         return data.substring(start, offset);
 320     }
 321
 322     private void validArg() {
 323         // every identifier except of the first MUST start with slash
 324         if (offset != 0) {
 325             checkValid('/' == currentChar(), ErrorTag.MALFORMED_MESSAGE, "Identifier must start with '/'.");
 326
 327             // skip consecutive slashes, users often assume restconf URLs behave just as HTTP does by squashing
 328             // multiple slashes into a single one
 329             while (!allCharsConsumed() && '/' == currentChar()) {
 330                 skipCurrentChar();
 331             }
 332
 333             // check if slash is not also the last char in identifier
 334             checkValid(!allCharsConsumed(), ErrorTag.MALFORMED_MESSAGE, "Identifier cannot end with '/'.");
 335         }
 336     }
 337
 338     private QName getQNameOfDataSchemaNode(final String nodeName) {
 339         final DataSchemaNode dataSchemaNode = current.getDataSchemaNode();
 340         if (dataSchemaNode instanceof ContainerLike) {
 341             return getQNameOfDataSchemaNode((ContainerLike) dataSchemaNode, nodeName);
 342         } else if (dataSchemaNode instanceof ListSchemaNode) {
 343             return getQNameOfDataSchemaNode((ListSchemaNode) dataSchemaNode, nodeName);
 344         }
 345
 346         throw new UnsupportedOperationException("Unsupported schema node " + dataSchemaNode);
 347     }
 348
 349     private static <T extends DataNodeContainer & SchemaNode & ActionNodeContainer> QName getQNameOfDataSchemaNode(
 350             final T parent, final String nodeName) {
 351         final Optional<? extends ActionDefinition> actionDef = findActionDefinition(parent, nodeName);
 352         final SchemaNode node;
 353         if (actionDef.isPresent()) {
 354             node = actionDef.get();
 355         } else {
 356             node = RestconfSchemaUtil.findSchemaNodeInCollection(parent.getChildNodes(), nodeName);
 357         }
 358         return node.getQName();
 359     }
 360
 361     private static Optional<? extends ActionDefinition> findActionDefinition(final SchemaNode dataSchemaNode,
 362             final String nodeName) {
 363         requireNonNull(dataSchemaNode, "DataSchema Node must not be null.");
 364         if (dataSchemaNode instanceof ActionNodeContainer) {
 365             return ((ActionNodeContainer) dataSchemaNode).getActions().stream()
 366                     .filter(actionDef -> actionDef.getQName().getLocalName().equals(nodeName)).findFirst();
 367         }
 368         return Optional.empty();
 369     }
 370
 371     private static String findAndParsePercentEncoded(final String preparedPrefix) {
 372         if (preparedPrefix.indexOf('%') == -1) {
 373             return preparedPrefix;
 374         }
 375
 376         // FIXME: this is extremely inefficient: we should be converting ranges of characters, not driven by
 377         //        CharMatcher, but by String.indexOf()
 378         final StringBuilder parsedPrefix = new StringBuilder(preparedPrefix);
 379         while (PERCENT_ENCODING.matchesAnyOf(parsedPrefix)) {
 380             final int percentCharPosition = PERCENT_ENCODING.indexIn(parsedPrefix);
 381             parsedPrefix.replace(percentCharPosition, percentCharPosition + LAST_ENCODED_CHAR,
 382                     String.valueOf((char) Integer.parseInt(parsedPrefix.substring(
 383                             percentCharPosition + FIRST_ENCODED_CHAR, percentCharPosition + LAST_ENCODED_CHAR),
 384                             PERCENT_ENCODED_RADIX)));
 385         }
 386
 387         return parsedPrefix.toString();
 388     }
 389
 390     private QName toIdentityrefQName(final String value, final DataSchemaNode schemaNode) {
 391         final String moduleName = toModuleName(value);
 392         final String nodeName = toNodeName(value);
 393         final Iterator<? extends Module> modulesIterator = schemaContext.findModules(moduleName).iterator();
 394         if (!modulesIterator.hasNext()) {
 395             throw new RestconfDocumentedException(String.format("Cannot decode value '%s' for identityref type "
 396                     + "in %s. Make sure reserved characters such as comma, single-quote, double-quote, colon,"
 397                     + " double-quote, space, and forward slash (,'\":\" /) are percent-encoded,"
 398                     + " for example ':' is '%%3A'", value, current.getIdentifier().getNodeType()),
 399                     ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT);
 400         }
 401         for (final IdentitySchemaNode identitySchemaNode : modulesIterator.next().getIdentities()) {
 402             final QName qName = identitySchemaNode.getQName();
 403             if (qName.getLocalName().equals(nodeName)) {
 404                 return qName;
 405             }
 406         }
 407         return QName.create(schemaNode.getQName().getNamespace(), schemaNode.getQName().getRevision(), nodeName);
 408     }
 409
 410     private static String toNodeName(final String str) {
 411         final int idx = str.indexOf(':');
 412         if (idx == -1) {
 413             return str;
 414         }
 415
 416         if (str.indexOf(':', idx + 1) != -1) {
 417             return str;
 418         }
 419
 420         return str.substring(idx + 1);
 421     }
 422
 423     private static String toModuleName(final String str) {
 424         final int idx = str.indexOf(':');
 425         if (idx == -1) {
 426             return null;
 427         }
 428
 429         if (str.indexOf(':', idx + 1) != -1) {
 430             return null;
 431         }
 432
 433         return str.substring(0, idx);
 434     }
 435 }