Move SchemaExportContext
[netconf.git] / restconf / restconf-nb-rfc8040 / src / main / java / org / opendaylight / restconf / nb / rfc8040 / utils / parser / ParserIdentifier.java
index 4f8e1e0cb0b1e6c086f85ed03c795dc3b6634fdf..8f28be15278c63b96c9e9cebd8742b177f8f7ae4 100644 (file)
@@ -7,7 +7,7 @@
  */
 package org.opendaylight.restconf.nb.rfc8040.utils.parser;
 
-import static com.google.common.base.Verify.verifyNotNull;
+import static com.google.common.base.Preconditions.checkState;
 
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Splitter;
@@ -23,27 +23,22 @@ import java.util.Optional;
 import org.eclipse.jdt.annotation.Nullable;
 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
+import org.opendaylight.mdsal.dom.api.DOMSchemaService;
 import org.opendaylight.mdsal.dom.api.DOMYangTextSourceProvider;
+import org.opendaylight.restconf.common.ErrorTags;
 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
-import org.opendaylight.restconf.common.errors.RestconfError.ErrorTag;
-import org.opendaylight.restconf.common.errors.RestconfError.ErrorType;
-import org.opendaylight.restconf.common.schema.SchemaExportContext;
+import org.opendaylight.restconf.nb.rfc8040.rests.services.api.SchemaExportContext;
 import org.opendaylight.restconf.nb.rfc8040.utils.RestconfConstants;
-import org.opendaylight.restconf.nb.rfc8040.utils.parser.builder.ParserBuilderConstants;
+import org.opendaylight.yangtools.yang.common.ErrorTag;
+import org.opendaylight.yangtools.yang.common.ErrorType;
 import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.common.Revision;
+import org.opendaylight.yangtools.yang.common.YangNames;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
-import org.opendaylight.yangtools.yang.data.util.DataSchemaContextNode;
-import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
-import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
-import org.opendaylight.yangtools.yang.model.api.ActionNodeContainer;
-import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
 import org.opendaylight.yangtools.yang.model.api.Module;
-import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
-import org.opendaylight.yangtools.yang.model.api.SchemaNode;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -51,12 +46,11 @@ import org.slf4j.LoggerFactory;
  * Util class for parsing identifier.
  */
 public final class ParserIdentifier {
-
     private static final Logger LOG = LoggerFactory.getLogger(ParserIdentifier.class);
     private static final Splitter MP_SPLITTER = Splitter.on("/" + RestconfConstants.MOUNT);
 
     private ParserIdentifier() {
-        throw new UnsupportedOperationException("Util class.");
+        // Hidden on purpose
     }
 
     /**
@@ -78,12 +72,16 @@ public final class ParserIdentifier {
      *           - mount point service
      * @return {@link InstanceIdentifierContext}
      */
-    public static InstanceIdentifierContext<?> toInstanceIdentifier(final String identifier,
+    // FIXME: NETCONF-631: this method should not be here, it should be a static factory in InstanceIdentifierContext:
+    //
+    //        @NonNull InstanceIdentifierContext forUrl(identifier, schemaContexxt, mountPointService)
+    //
+    public static InstanceIdentifierContext toInstanceIdentifier(final String identifier,
             final EffectiveModelContext schemaContext, final Optional<DOMMountPointService> mountPointService) {
         if (identifier == null || !identifier.contains(RestconfConstants.MOUNT)) {
             return createIIdContext(schemaContext, identifier, null);
         }
-        if (!mountPointService.isPresent()) {
+        if (mountPointService.isEmpty()) {
             throw new RestconfDocumentedException("Mount point service is not available");
         }
 
@@ -92,9 +90,9 @@ public final class ParserIdentifier {
         final YangInstanceIdentifier mountPath = IdentifierCodec.deserialize(mountPointId, schemaContext);
         final DOMMountPoint mountPoint = mountPointService.get().getMountPoint(mountPath)
                 .orElseThrow(() -> new RestconfDocumentedException("Mount point does not exist.",
-                    ErrorType.PROTOCOL, ErrorTag.DATA_MISSING));
+                    ErrorType.PROTOCOL, ErrorTags.RESOURCE_DENIED_TRANSPORT));
 
-        final EffectiveModelContext mountSchemaContext = mountPoint.getEffectiveModelContext();
+        final EffectiveModelContext mountSchemaContext = coerceModelContext(mountPoint);
         final String pathId = pathsIt.next().replaceFirst("/", "");
         return createIIdContext(mountSchemaContext, pathId, mountPoint);
     }
@@ -109,68 +107,16 @@ public final class ParserIdentifier {
      * @return {@link InstanceIdentifierContext}
      * @throws RestconfDocumentedException if the path cannot be resolved
      */
-    private static InstanceIdentifierContext<?> createIIdContext(final EffectiveModelContext schemaContext,
+    private static InstanceIdentifierContext createIIdContext(final EffectiveModelContext schemaContext,
             final String url, final @Nullable DOMMountPoint mountPoint) {
-        final YangInstanceIdentifier urlPath = IdentifierCodec.deserialize(url, schemaContext);
-        return new InstanceIdentifierContext<>(urlPath, getPathSchema(schemaContext, urlPath), mountPoint,
-                schemaContext);
-    }
-
-    private static SchemaNode getPathSchema(final SchemaContext schemaContext, final YangInstanceIdentifier urlPath) {
         // First things first: an empty path means data invocation on SchemaContext
-        if (urlPath.isEmpty()) {
-            return schemaContext;
-        }
-
-        // Peel the last component and locate the parent data node, empty path resolves to SchemaContext
-        final DataSchemaContextNode<?> parent = DataSchemaContextTree.from(schemaContext)
-                .findChild(verifyNotNull(urlPath.getParent()))
-                .orElseThrow(
-                    // Parent data node is not present, this is not a valid location.
-                    () -> new RestconfDocumentedException("Parent of " + urlPath + " not found",
-                        ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE));
-
-        // Now try to resolve the last component as a data item...
-        final DataSchemaContextNode<?> data = parent.getChild(urlPath.getLastPathArgument());
-        if (data != null) {
-            return data.getDataSchemaNode();
-        }
-
-        // ... otherwise this has to be an operation invocation. RPCs cannot be defined anywhere but schema root,
-        // actions can reside everywhere else (and SchemaContext reports them empty)
-        final QName qname = urlPath.getLastPathArgument().getNodeType();
-        final DataSchemaNode parentSchema = parent.getDataSchemaNode();
-        if (parentSchema instanceof SchemaContext) {
-            for (final RpcDefinition rpc : ((SchemaContext) parentSchema).getOperations()) {
-                if (qname.equals(rpc.getQName())) {
-                    return rpc;
-                }
-            }
-        }
-        if (parentSchema instanceof ActionNodeContainer) {
-            for (final ActionDefinition action : ((ActionNodeContainer) parentSchema).getActions()) {
-                if (qname.equals(action.getQName())) {
-                    return action;
-                }
-            }
+        if (url == null) {
+            return mountPoint != null ? InstanceIdentifierContext.ofMountPointRoot(mountPoint, schemaContext)
+                : InstanceIdentifierContext.ofLocalRoot(schemaContext);
         }
 
-        // No luck: even if we found the parent, we did not locate a data, nor RPC, nor action node, hence the URL
-        //          is deemed invalid
-        throw new RestconfDocumentedException("Context for " + urlPath + " not found", ErrorType.PROTOCOL,
-            ErrorTag.INVALID_VALUE);
-    }
-
-    /**
-     * Make {@link String} from {@link YangInstanceIdentifier}.
-     *
-     * @param instanceIdentifier    Instance identifier
-     * @param schemaContext         Schema context
-     * @return                      Yang instance identifier serialized to String
-     */
-    public static String stringFromYangInstanceIdentifier(final YangInstanceIdentifier instanceIdentifier,
-            final SchemaContext schemaContext) {
-        return IdentifierCodec.serialize(instanceIdentifier, schemaContext);
+        final var result = YangInstanceIdentifierDeserializer.create(schemaContext, url);
+        return InstanceIdentifierContext.ofPath(result.stack, result.node, result.path, mountPoint);
     }
 
     /**
@@ -180,10 +126,10 @@ public final class ParserIdentifier {
      *             path parameter
      * @return {@link QName}
      */
-    public static Entry<String, Revision> makeQNameFromIdentifier(final String identifier) {
+    @VisibleForTesting
+    static Entry<String, Revision> makeQNameFromIdentifier(final String identifier) {
         // check if more than one slash is not used as path separator
-        if (identifier.contains(
-                String.valueOf(RestconfConstants.SLASH).concat(String.valueOf(RestconfConstants.SLASH)))) {
+        if (identifier.contains("//")) {
             LOG.debug("URI has bad format. It should be \'moduleName/yyyy-MM-dd\' {}", identifier);
             throw new RestconfDocumentedException(
                     "URI has bad format. End of URI should be in format \'moduleName/yyyy-MM-dd\'", ErrorType.PROTOCOL,
@@ -194,7 +140,7 @@ public final class ParserIdentifier {
         final String moduleNameAndRevision;
         if (mountIndex >= 0) {
             moduleNameAndRevision = identifier.substring(mountIndex + RestconfConstants.MOUNT.length())
-                    .replaceFirst(String.valueOf(RestconfConstants.SLASH), "");
+                    .replaceFirst("/", "");
         } else {
             moduleNameAndRevision = identifier;
         }
@@ -248,27 +194,40 @@ public final class ParserIdentifier {
                 final String current = componentIter.next();
 
                 if (RestconfConstants.MOUNT.equals(current)) {
-                    pathBuilder.append("/");
-                    pathBuilder.append(RestconfConstants.MOUNT);
+                    pathBuilder.append('/').append(RestconfConstants.MOUNT);
                     break;
                 }
 
                 if (pathBuilder.length() != 0) {
-                    pathBuilder.append("/");
+                    pathBuilder.append('/');
                 }
 
                 pathBuilder.append(current);
             }
-            final InstanceIdentifierContext<?> point = toInstanceIdentifier(pathBuilder.toString(), schemaContext,
+            final InstanceIdentifierContext point = toInstanceIdentifier(pathBuilder.toString(), schemaContext,
                 Optional.of(domMountPointService));
             final String moduleName = validateAndGetModulName(componentIter);
             final Revision revision = validateAndGetRevision(componentIter);
-            final Module module = point.getMountPoint().getSchemaContext().findModule(moduleName, revision)
-                    .orElse(null);
-            return new SchemaExportContext(point.getMountPoint().getSchemaContext(), module, sourceProvider);
+            final EffectiveModelContext context = coerceModelContext(point.getMountPoint());
+            final Module module = context.findModule(moduleName, revision).orElse(null);
+            return new SchemaExportContext(context, module, sourceProvider);
         }
     }
 
+    public static YangInstanceIdentifier parserPatchTarget(final InstanceIdentifierContext context,
+            final String target) {
+        final var schemaContext = context.getSchemaContext();
+        final var urlPath = context.getInstanceIdentifier();
+        final String targetUrl;
+        if (urlPath.isEmpty()) {
+            targetUrl = target.startsWith("/") ? target.substring(1) : target;
+        } else {
+            targetUrl = IdentifierCodec.serialize(urlPath, schemaContext) + target;
+        }
+
+        return toInstanceIdentifier(targetUrl, schemaContext, Optional.empty()).getInstanceIdentifier();
+    }
+
     /**
      * Validation and parsing of revision.
      *
@@ -299,14 +258,26 @@ public final class ParserIdentifier {
         final String name = moduleName.next();
 
         RestconfDocumentedException.throwIf(
-            name.isEmpty() || !ParserBuilderConstants.Deserializer.IDENTIFIER_FIRST_CHAR.matches(name.charAt(0)),
+            name.isEmpty() || !YangNames.IDENTIFIER_START.matches(name.charAt(0)),
             "Identifier must start with character from set 'a-zA-Z_", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
         RestconfDocumentedException.throwIf(name.toUpperCase(Locale.ROOT).startsWith("XML"),
             "Identifier must NOT start with XML ignore case.", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
         RestconfDocumentedException.throwIf(
-            !ParserBuilderConstants.Deserializer.IDENTIFIER.matchesAllOf(name.substring(1)),
+            YangNames.NOT_IDENTIFIER_PART.matchesAnyOf(name.substring(1)),
             "Supplied name has not expected identifier format.", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
 
         return name;
     }
+
+    private static EffectiveModelContext coerceModelContext(final DOMMountPoint mountPoint) {
+        final EffectiveModelContext context = modelContext(mountPoint);
+        checkState(context != null, "Mount point %s does not have a model context", mountPoint);
+        return context;
+    }
+
+    private static EffectiveModelContext modelContext(final DOMMountPoint mountPoint) {
+        return mountPoint.getService(DOMSchemaService.class)
+            .flatMap(svc -> Optional.ofNullable(svc.getGlobalContext()))
+            .orElse(null);
+    }
 }