Bug 6931 - Fix unsupported specific type of leaf
[netconf.git] / restconf / sal-rest-connector / src / main / java / org / opendaylight / restconf / parser / builder / YangInstanceIdentifierDeserializer.java
index aaf887058ba1305ec66e81bfd7d2d340a1c29597..89315be51594feae743a08ce1719fde50dac154d 100644 (file)
@@ -11,11 +11,17 @@ import com.google.common.base.CharMatcher;
 import com.google.common.base.Preconditions;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableMap;
+import java.util.Iterator;
 import java.util.LinkedList;
 import java.util.List;
+import org.opendaylight.netconf.md.sal.rest.common.RestconfValidationUtils;
+import org.opendaylight.netconf.sal.rest.impl.RestUtil;
+import org.opendaylight.netconf.sal.restconf.impl.RestCodec;
+import org.opendaylight.netconf.sal.restconf.impl.RestconfError;
 import org.opendaylight.restconf.utils.RestconfConstants;
 import org.opendaylight.restconf.utils.parser.builder.ParserBuilderConstants;
 import org.opendaylight.restconf.utils.schema.context.RestconfSchemaUtil;
+import org.opendaylight.yangtools.concepts.Codec;
 import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
@@ -23,9 +29,16 @@ import org.opendaylight.yangtools.yang.data.util.DataSchemaContextNode;
 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
+import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.Module;
 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
+import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
+import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
 
 /**
  * Deserializer for {@link String} to {@link YangInstanceIdentifier} for
@@ -50,56 +63,171 @@ public final class YangInstanceIdentifierDeserializer {
      */
     public static Iterable<PathArgument> create(final SchemaContext schemaContext, final String data) {
         final List<PathArgument> path = new LinkedList<>();
-        DataSchemaContextNode<?> current = DataSchemaContextTree.from(schemaContext).getRoot();
-        final int offset = 0;
-        final MainVarsWrapper variables = new YangInstanceIdentifierDeserializer.MainVarsWrapper(data,
-                current, offset, schemaContext);
+        final MainVarsWrapper variables = new YangInstanceIdentifierDeserializer.MainVarsWrapper(
+                data, DataSchemaContextTree.from(schemaContext).getRoot(),
+                YangInstanceIdentifierDeserializer.MainVarsWrapper.STARTING_OFFSET, schemaContext);
 
         while (!allCharsConsumed(variables)) {
             validArg(variables);
             final QName qname = prepareQName(variables);
 
-            if (!allCharsConsumed(variables)
-                    && (currentChar(variables.getOffset(), variables.getData()) == RestconfConstants.SLASH)) {
+            // this is the last identifier (input is consumed) or end of identifier (slash)
+            if (allCharsConsumed(variables)
+                    || (currentChar(variables.getOffset(), variables.getData()) == RestconfConstants.SLASH)) {
                 prepareIdentifier(qname, path, variables);
                 path.add(variables.getCurrent().getIdentifier());
-            } else if (!allCharsConsumed(variables)
-                    && (currentChar(variables.getOffset(),
-                            variables.getData()) == ParserBuilderConstants.Deserializer.EQUAL)) {
-                current = nextContextNode(qname, path, variables);
-                if (!current.isKeyedEntry()) {
-                    prepareNodeWithValue(qname, path, variables);
-                } else {
+            } else if (currentChar(variables.getOffset(),
+                    variables.getData()) == ParserBuilderConstants.Deserializer.EQUAL) {
+                if (nextContextNode(qname, path, variables).getDataSchemaNode() instanceof ListSchemaNode) {
                     prepareNodeWithPredicates(qname, path, variables);
+                } else {
+                    prepareNodeWithValue(qname, path, variables);
                 }
             } else {
                 throw new IllegalArgumentException(
-                        "Bad char " + currentChar(offset, data) + " on position " + offset + ".");
+                        "Bad char " + currentChar(variables.getOffset(), variables.getData()) + " on position "
+                                + variables.getOffset() + ".");
             }
         }
+
         return ImmutableList.copyOf(path);
     }
 
     private static void prepareNodeWithPredicates(final QName qname, final List<PathArgument> path,
-            final MainVarsWrapper variables) {
-        final List<QName> keyDefinitions = ((ListSchemaNode) variables.getCurrent().getDataSchemaNode())
-                .getKeyDefinition();
-        final ImmutableMap.Builder<QName, Object> keyValues = ImmutableMap.builder();
+                                                  final MainVarsWrapper variables) {
 
-        for (final QName keyQName : keyDefinitions) {
-            skipCurrentChar(variables);
-            String value = null;
-            if ((currentChar(variables.getOffset(), variables.getData()) == ParserBuilderConstants.Deserializer.COMMA)
+        final DataSchemaNode dataSchemaNode = variables.getCurrent().getDataSchemaNode();
+        checkValid((dataSchemaNode != null), "Data schema node is null", variables.getData(), variables.getOffset());
+
+        final Iterator<QName> keys = ((ListSchemaNode) dataSchemaNode).getKeyDefinition().iterator();
+        final ImmutableMap.Builder<QName, Object> values = ImmutableMap.builder();
+
+        // skip already expected equal sign
+        skipCurrentChar(variables);
+
+        // read key value separated by comma
+        while (keys.hasNext() && !allCharsConsumed(variables) && (currentChar(variables.getOffset(),
+                variables.getData()) != RestconfConstants.SLASH)) {
+
+            // empty key value
+            if (currentChar(variables.getOffset(), variables.getData()) == ParserBuilderConstants.Deserializer.COMMA) {
+                values.put(keys.next(), ParserBuilderConstants.Deserializer.EMPTY_STRING);
+                skipCurrentChar(variables);
+                continue;
+            }
+
+            // check if next value is parsable
+            RestconfValidationUtils.checkDocumentedError(
+                    ParserBuilderConstants.Deserializer.IDENTIFIER_PREDICATE
+                            .matches(currentChar(variables.getOffset(), variables.getData())),
+                    RestconfError.ErrorType.PROTOCOL,
+                    RestconfError.ErrorTag.MALFORMED_MESSAGE,
+                    ""
+            );
+
+            // parse value
+            final QName key = keys.next();
+            DataSchemaNode leafSchemaNode = null;
+            if (dataSchemaNode instanceof ListSchemaNode) {
+                leafSchemaNode = ((ListSchemaNode) dataSchemaNode).getDataChildByName(key);
+            } else if (dataSchemaNode instanceof LeafListSchemaNode) {
+                leafSchemaNode = dataSchemaNode;
+            }
+            final String value = findAndParsePercentEncoded(nextIdentifierFromNextSequence(
+                    ParserBuilderConstants.Deserializer.IDENTIFIER_PREDICATE, variables));
+            final Object valueByType = prepareValueByType(leafSchemaNode, value, variables);
+            values.put(key, valueByType);
+
+
+            // skip comma
+            if (keys.hasNext() && !allCharsConsumed(variables) && (currentChar(
+                    variables.getOffset(), variables.getData()) == ParserBuilderConstants.Deserializer.COMMA)) {
+                skipCurrentChar(variables);
+            }
+        }
+
+        // the last key is considered to be empty
+        if (keys.hasNext()) {
+            if (allCharsConsumed(variables)
                     || (currentChar(variables.getOffset(), variables.getData()) == RestconfConstants.SLASH)) {
-                value = ParserBuilderConstants.Deserializer.EMPTY_STRING;
-            } else {
-                value = nextIdentifierFromNextSequence(ParserBuilderConstants.Deserializer.IDENTIFIER_PREDICATE,
-                        variables);
+                values.put(keys.next(), ParserBuilderConstants.Deserializer.EMPTY_STRING);
             }
-            value = findAndParsePercentEncoded(value);
-            keyValues.put(keyQName, value);
+
+            // there should be no more missing keys
+            RestconfValidationUtils.checkDocumentedError(
+                    !keys.hasNext(),
+                    RestconfError.ErrorType.PROTOCOL,
+                    RestconfError.ErrorTag.MISSING_ATTRIBUTE,
+                    "Key value missing for: " + qname
+            );
         }
-        path.add(new YangInstanceIdentifier.NodeIdentifierWithPredicates(qname, keyValues.build()));
+
+        path.add(new YangInstanceIdentifier.NodeIdentifierWithPredicates(qname, values.build()));
+    }
+
+    private static Object prepareValueByType(final DataSchemaNode schemaNode, final String value,
+            final MainVarsWrapper vars) {
+        Object decoded = null;
+
+        TypeDefinition<? extends TypeDefinition<?>> typedef = null;
+        if (schemaNode instanceof LeafListSchemaNode) {
+            typedef = ((LeafListSchemaNode) schemaNode).getType();
+        } else {
+            typedef = ((LeafSchemaNode) schemaNode).getType();
+        }
+        final TypeDefinition<?> baseType = RestUtil.resolveBaseTypeFrom(typedef);
+        if (baseType instanceof LeafrefTypeDefinition) {
+            typedef = SchemaContextUtil.getBaseTypeForLeafRef((LeafrefTypeDefinition) baseType, vars.getSchemaContext(),
+                    schemaNode);
+        }
+        final Codec<Object, Object> codec = RestCodec.from(typedef, null);
+        decoded = codec.deserialize(value);
+        if (decoded == null) {
+            if ((baseType instanceof IdentityrefTypeDefinition)) {
+                decoded = toQName(value, schemaNode, vars.getSchemaContext());
+            }
+        }
+        return decoded;
+    }
+
+    private static Object toQName(final String value, final DataSchemaNode schemaNode,
+            final SchemaContext schemaContext) {
+        final String moduleName = toModuleName(value);
+        final String nodeName = toNodeName(value);
+        final Module module = schemaContext.findModuleByName(moduleName, null);
+        for (final IdentitySchemaNode identitySchemaNode : module.getIdentities()) {
+            final QName qName = identitySchemaNode.getQName();
+            if (qName.getLocalName().equals(nodeName)) {
+                return qName;
+            }
+        }
+        return QName.create(schemaNode.getQName().getNamespace(), schemaNode.getQName().getRevision(), value);
+    }
+
+    private static String toNodeName(final String str) {
+        final int idx = str.indexOf(':');
+        if (idx == -1) {
+            return str;
+        }
+
+        if (str.indexOf(':', idx + 1) != -1) {
+            return str;
+        }
+
+        return str.substring(idx + 1);
+    }
+
+    private static String toModuleName(final String str) {
+        final int idx = str.indexOf(':');
+        if (idx == -1) {
+            return null;
+        }
+
+        if (str.indexOf(':', idx + 1) != -1) {
+            return null;
+        }
+
+        return str.substring(0, idx);
     }
 
     private static QName prepareQName(final MainVarsWrapper variables) {
@@ -107,10 +235,18 @@ public final class YangInstanceIdentifierDeserializer {
                 ParserBuilderConstants.Deserializer.IDENTIFIER_FIRST_CHAR
                         .matches(currentChar(variables.getOffset(), variables.getData())),
                 "Identifier must start with character from set 'a-zA-Z_'", variables.getData(), variables.getOffset());
-        final String preparedPrefix = nextIdentifierFromNextSequence(ParserBuilderConstants.Deserializer.IDENTIFIER, variables);
+        final String preparedPrefix = nextIdentifierFromNextSequence(
+                ParserBuilderConstants.Deserializer.IDENTIFIER, variables);
         final String prefix, localName;
 
+        if (allCharsConsumed(variables)) {
+            return getQNameOfDataSchemaNode(preparedPrefix, variables);
+        }
+
         switch (currentChar(variables.getOffset(), variables.getData())) {
+            case RestconfConstants.SLASH:
+                prefix = preparedPrefix;
+                return getQNameOfDataSchemaNode(prefix, variables);
             case ParserBuilderConstants.Deserializer.COLON:
                 prefix = preparedPrefix;
                 skipCurrentChar(variables);
@@ -121,10 +257,14 @@ public final class YangInstanceIdentifierDeserializer {
                         variables.getOffset());
                 localName = nextIdentifierFromNextSequence(ParserBuilderConstants.Deserializer.IDENTIFIER, variables);
 
-                final Module module = moduleForPrefix(prefix, variables.getSchemaContext());
-                Preconditions.checkArgument(module != null, "Failed to lookup prefix %s", prefix);
-
-                return QName.create(module.getQNameModule(), localName);
+                if (!allCharsConsumed(variables) && (currentChar
+                        (variables.getOffset(), variables.getData()) == ParserBuilderConstants.Deserializer.EQUAL)) {
+                    return getQNameOfDataSchemaNode(localName, variables);
+                } else {
+                    final Module module = moduleForPrefix(prefix, variables.getSchemaContext());
+                    Preconditions.checkArgument(module != null, "Failed to lookup prefix %s", prefix);
+                    return QName.create(module.getQNameModule(), localName);
+                }
             case ParserBuilderConstants.Deserializer.EQUAL:
                 prefix = preparedPrefix;
                 return getQNameOfDataSchemaNode(prefix, variables);
@@ -149,9 +289,19 @@ public final class YangInstanceIdentifierDeserializer {
     private static void prepareNodeWithValue(final QName qname, final List<PathArgument> path,
             final MainVarsWrapper variables) {
         skipCurrentChar(variables);
-        String value = nextIdentifierFromNextSequence(ParserBuilderConstants.Deserializer.IDENTIFIER, variables);
-        value = findAndParsePercentEncoded(value);
-        path.add(new YangInstanceIdentifier.NodeWithValue<>(qname, value));
+        final String value = nextIdentifierFromNextSequence(
+                ParserBuilderConstants.Deserializer.IDENTIFIER_PREDICATE, variables);
+
+        // exception if value attribute is missing
+        RestconfValidationUtils.checkDocumentedError(
+                !value.isEmpty(),
+                RestconfError.ErrorType.PROTOCOL,
+                RestconfError.ErrorTag.MISSING_ATTRIBUTE,
+                "Value missing for: " + qname
+        );
+        final DataSchemaNode dataSchemaNode = variables.getCurrent().getDataSchemaNode();
+        final Object valueByType = prepareValueByType(dataSchemaNode, findAndParsePercentEncoded(value), variables);
+        path.add(new YangInstanceIdentifier.NodeWithValue<>(qname, valueByType));
     }
 
     private static void prepareIdentifier(final QName qname, final List<PathArgument> path,
@@ -175,26 +325,26 @@ public final class YangInstanceIdentifierDeserializer {
         return current;
     }
 
-    private static String findAndParsePercentEncoded(String preparedPrefix) {
+    private static String findAndParsePercentEncoded(final String preparedPrefix) {
         if (!preparedPrefix.contains(String.valueOf(ParserBuilderConstants.Deserializer.PERCENT_ENCODING))) {
             return preparedPrefix;
         }
-        final StringBuilder newPrefix = new StringBuilder();
-        int i = 0;
-        int startPoint = 0;
-        int endPoint = preparedPrefix.length();
-        while ((i = preparedPrefix.indexOf(ParserBuilderConstants.Deserializer.PERCENT_ENCODING)) != -1) {
-            newPrefix.append(preparedPrefix.substring(startPoint, i));
-            startPoint = i;
-            startPoint++;
-            final String hex = preparedPrefix.substring(startPoint, startPoint + 2);
-            startPoint += 2;
-            newPrefix.append((char) Integer.parseInt(hex, 16));
-            preparedPrefix = preparedPrefix.substring(startPoint, endPoint);
-            startPoint = 0;
-            endPoint = preparedPrefix.length();
+
+        final StringBuilder parsedPrefix = new StringBuilder(preparedPrefix);
+        final CharMatcher matcher = CharMatcher.is(ParserBuilderConstants.Deserializer.PERCENT_ENCODING);
+
+        while (matcher.matchesAnyOf(parsedPrefix)) {
+            final int percentCharPosition = matcher.indexIn(parsedPrefix);
+            parsedPrefix.replace(
+                    percentCharPosition,
+                    percentCharPosition + ParserBuilderConstants.Deserializer.LAST_ENCODED_CHAR,
+                    String.valueOf((char) Integer.parseInt(parsedPrefix.substring(
+                            percentCharPosition + ParserBuilderConstants.Deserializer.FIRST_ENCODED_CHAR,
+                            percentCharPosition + ParserBuilderConstants.Deserializer.LAST_ENCODED_CHAR),
+                            ParserBuilderConstants.Deserializer.PERCENT_ENCODED_RADIX)));
         }
-        return newPrefix.toString();
+
+        return parsedPrefix.toString();
     }
 
     private static QName getQNameOfDataSchemaNode(final String nodeName, final MainVarsWrapper variables) {
@@ -218,11 +368,18 @@ public final class YangInstanceIdentifierDeserializer {
     }
 
     private static void validArg(final MainVarsWrapper variables) {
-        checkValid(RestconfConstants.SLASH == currentChar(variables.getOffset(), variables.getData()),
-                "Identifier must start with '/'.", variables.getData(), variables.getOffset());
-        skipCurrentChar(variables);
-        checkValid(!allCharsConsumed(variables), "Identifier cannot end with '/'.",
-                variables.getData(), variables.getOffset());
+        // every identifier except of the first MUST start with slash
+        if (variables.getOffset() != MainVarsWrapper.STARTING_OFFSET) {
+            checkValid(RestconfConstants.SLASH == currentChar(variables.getOffset(), variables.getData()),
+                    "Identifier must start with '/'.", variables.getData(), variables.getOffset());
+
+            // skip slash
+            skipCurrentChar(variables);
+
+            // check if slash is not also the last char in identifier
+            checkValid(!allCharsConsumed(variables), "Identifier cannot end with '/'.",
+                    variables.getData(), variables.getOffset());
+        }
     }
 
     private static void skipCurrentChar(final MainVarsWrapper variables) {
@@ -243,7 +400,8 @@ public final class YangInstanceIdentifierDeserializer {
         return variables.getOffset() == variables.getData().length();
     }
 
-    private static class MainVarsWrapper {
+    private final static class MainVarsWrapper {
+        private static final int STARTING_OFFSET = 0;
 
         private final SchemaContext schemaContext;
         private final String data;
@@ -253,9 +411,9 @@ public final class YangInstanceIdentifierDeserializer {
         public MainVarsWrapper(final String data, final DataSchemaContextNode<?> current, final int offset,
                 final SchemaContext schemaContext) {
             this.data = data;
-            this.schemaContext = schemaContext;
             this.setCurrent(current);
             this.setOffset(offset);
+            this.schemaContext = schemaContext;
         }
 
         public String getData() {
@@ -281,6 +439,5 @@ public final class YangInstanceIdentifierDeserializer {
         public SchemaContext getSchemaContext() {
             return this.schemaContext;
         }
-
     }
 }