X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=yang%2Fyang-model-util%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fyangtools%2Fyang%2Fmodel%2Futil%2FSchemaContextUtil.java;h=73bd1765d1d0cc121702ee110b85075647bec6e5;hb=bb60da5fe2d1928defb46ed92b290cfff93dcd81;hp=4564784738a58f0d3555733d679e88b2d9d992bc;hpb=fb51bb5aaa4caaa862995a61447f91a4fe6bf08c;p=yangtools.git diff --git a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/SchemaContextUtil.java b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/SchemaContextUtil.java index 4564784738..73bd1765d1 100644 --- a/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/SchemaContextUtil.java +++ b/yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/SchemaContextUtil.java @@ -15,6 +15,7 @@ import com.google.common.annotations.Beta; import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Splitter; import com.google.common.collect.Iterables; +import com.google.common.collect.Lists; import java.util.ArrayDeque; import java.util.ArrayList; import java.util.Arrays; @@ -35,15 +36,15 @@ import org.opendaylight.yangtools.yang.common.UnqualifiedQName; import org.opendaylight.yangtools.yang.model.api.ActionNodeContainer; import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode; import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode; -import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode; +import org.opendaylight.yangtools.yang.model.api.ContainerLike; import org.opendaylight.yangtools.yang.model.api.DataNodeContainer; import org.opendaylight.yangtools.yang.model.api.DataSchemaNode; import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode; import org.opendaylight.yangtools.yang.model.api.GroupingDefinition; -import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode; import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode; import org.opendaylight.yangtools.yang.model.api.Module; import org.opendaylight.yangtools.yang.model.api.ModuleImport; +import org.opendaylight.yangtools.yang.model.api.ModuleLike; import org.opendaylight.yangtools.yang.model.api.NotificationDefinition; import org.opendaylight.yangtools.yang.model.api.NotificationNodeContainer; import org.opendaylight.yangtools.yang.model.api.OperationDefinition; @@ -55,6 +56,7 @@ 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.opendaylight.yangtools.yang.model.api.SchemaPath; +import org.opendaylight.yangtools.yang.model.api.Submodule; import org.opendaylight.yangtools.yang.model.api.TypeDefinition; import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode; import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition; @@ -64,9 +66,7 @@ import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier; import org.opendaylight.yangtools.yang.xpath.api.YangLocationPath; import org.opendaylight.yangtools.yang.xpath.api.YangLocationPath.AxisStep; import org.opendaylight.yangtools.yang.xpath.api.YangLocationPath.QNameStep; -import org.opendaylight.yangtools.yang.xpath.api.YangLocationPath.ResolvedQNameStep; import org.opendaylight.yangtools.yang.xpath.api.YangLocationPath.Step; -import org.opendaylight.yangtools.yang.xpath.api.YangLocationPath.UnresolvedQNameStep; import org.opendaylight.yangtools.yang.xpath.api.YangXPathAxis; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -80,6 +80,7 @@ public final class SchemaContextUtil { private static final Logger LOG = LoggerFactory.getLogger(SchemaContextUtil.class); private static final Splitter COLON_SPLITTER = Splitter.on(':'); private static final Splitter SLASH_SPLITTER = Splitter.on('/').omitEmptyStrings(); + private static final Pattern GROUPS_PATTERN = Pattern.compile("\\[(.*?)\\]"); private SchemaContextUtil() { // Hidden on purpose @@ -267,7 +268,12 @@ public final class SchemaContextUtil { final SchemaNode actualSchemaNode, final PathExpression relativeXPath) { checkState(!relativeXPath.isAbsolute(), "Revision Aware XPath MUST be relative i.e. MUST contains ../, " + "for non relative Revision Aware XPath use findDataSchemaNode method"); - return resolveRelativeXPath(context, module, relativeXPath, actualSchemaNode); + return resolveRelativeXPath(context, module, removePredicatesFromXpath(relativeXPath.getOriginalString()), + actualSchemaNode); + } + + private static String removePredicatesFromXpath(final String xpath) { + return GROUPS_PATTERN.matcher(xpath).replaceAll(""); } /** @@ -329,7 +335,7 @@ public final class SchemaContextUtil { * @return Notification schema or null, if notification is not present in schema context. */ @Beta - public static @Nullable ContainerSchemaNode getRpcDataSchema(final @NonNull SchemaContext schema, + public static @Nullable ContainerLike getRpcDataSchema(final @NonNull SchemaContext schema, final @NonNull SchemaPath path) { requireNonNull(schema, "Schema context must not be null."); requireNonNull(path, "Schema path must not be null."); @@ -358,7 +364,7 @@ public final class SchemaContextUtil { for (Module module : context.getModules()) { ret.add(moduleToIdentifier(module)); - for (Module submodule : module.getSubmodules()) { + for (Submodule submodule : module.getSubmodules()) { ret.add(moduleToIdentifier(submodule)); } } @@ -366,7 +372,7 @@ public final class SchemaContextUtil { return ret; } - private static SourceIdentifier moduleToIdentifier(final Module module) { + private static SourceIdentifier moduleToIdentifier(final ModuleLike module) { return RevisionSourceIdentifier.create(module.getName(), module.getRevision()); } @@ -382,7 +388,7 @@ public final class SchemaContextUtil { SchemaNode foundNode = null; final Iterable nextPath = nextLevel(path); - foundNode = module.getDataChildByName(current); + foundNode = module.dataChildByName(current); if (foundNode != null && nextPath.iterator().hasNext()) { foundNode = findNodeIn(foundNode, nextPath); } @@ -430,7 +436,7 @@ public final class SchemaContextUtil { if (parent instanceof DataNodeContainer) { final DataNodeContainer parentDataNodeContainer = (DataNodeContainer) parent; - foundNode = parentDataNodeContainer.getDataChildByName(current); + foundNode = parentDataNodeContainer.dataChildByName(current); if (foundNode != null && nextPath.iterator().hasNext()) { foundNode = findNodeIn(foundNode, nextPath); } @@ -444,10 +450,10 @@ public final class SchemaContextUtil { } if (foundNode == null && parent instanceof ActionNodeContainer) { - foundNode = ((ActionNodeContainer) parent).getActions().stream() - .filter(act -> current.equals(act.getQName())).findFirst().orElse(null); - if (foundNode != null && nextPath.iterator().hasNext()) { - foundNode = findNodeIn(foundNode, nextPath); + final Optional next = ((ActionNodeContainer) parent).getActions().stream() + .filter(act -> current.equals(act.getQName())).findFirst(); + if (next.isPresent() && nextPath.iterator().hasNext()) { + foundNode = findNodeIn(next.orElseThrow(), nextPath); } } @@ -485,7 +491,7 @@ public final class SchemaContextUtil { } if (foundNode == null && parent instanceof ChoiceSchemaNode) { - foundNode = ((ChoiceSchemaNode) parent).getCaseNodeByName(current); + foundNode = ((ChoiceSchemaNode) parent).findCase(current).orElse(null); if (foundNode != null && nextPath.iterator().hasNext()) { foundNode = findNodeIn(foundNode, nextPath); @@ -493,8 +499,8 @@ public final class SchemaContextUtil { if (foundNode == null) { // fallback that tries to map into one of the child cases - for (final CaseSchemaNode caseNode : ((ChoiceSchemaNode) parent).getCases().values()) { - final DataSchemaNode maybeChild = caseNode.getDataChildByName(current); + for (final CaseSchemaNode caseNode : ((ChoiceSchemaNode) parent).getCases()) { + final DataSchemaNode maybeChild = caseNode.dataChildByName(current); if (maybeChild != null) { foundNode = findNodeIn(maybeChild, nextPath); break; @@ -605,7 +611,7 @@ public final class SchemaContextUtil { return QName.create(module.getQNameModule(), prefixedName.next()); } - return QName.create(parentModule.getNamespace(), parentModule.getRevision(), prefixedPathPart); + return QName.create(parentModule.getQNameModule(), prefixedPathPart); } /** @@ -630,8 +636,7 @@ public final class SchemaContextUtil { return module; } - final Set imports = module.getImports(); - for (final ModuleImport mi : imports) { + for (final ModuleImport mi : module.getImports()) { if (prefix.equals(mi.getPrefix())) { return context.findModule(mi.getModuleName(), mi.getRevision()).orElse(null); } @@ -646,22 +651,20 @@ public final class SchemaContextUtil { * Schema Context * @param module * Yang Module - * @param relativeXPath - * Non conditional Revision Aware Relative XPath + * @param pathStr + * xPath of leafref * @param actualSchemaNode * actual schema node * @return target schema node * @throws IllegalArgumentException if any arguments are null */ private static @Nullable SchemaNode resolveRelativeXPath(final SchemaContext context, final Module module, - final PathExpression relativeXPath, final SchemaNode actualSchemaNode) { - checkState(!relativeXPath.isAbsolute(), "Revision Aware XPath MUST be relative i.e. MUST contains ../, " - + "for non relative Revision Aware XPath use findDataSchemaNode method"); + final String pathStr, final SchemaNode actualSchemaNode) { checkState(actualSchemaNode.getPath() != null, "Schema Path reference for Leafref cannot be NULL"); - final String orig = relativeXPath.getOriginalString(); - return orig.startsWith("deref(") ? resolveDerefPath(context, module, actualSchemaNode, orig) - : findTargetNode(context, resolveRelativePath(context, module, actualSchemaNode, doSplitXPath(orig))); + return pathStr.startsWith("deref(") ? resolveDerefPath(context, module, actualSchemaNode, pathStr) + : findTargetNode(context, resolveRelativePath(context, module, actualSchemaNode, + doSplitXPath(pathStr))); } private static Iterable resolveRelativePath(final SchemaContext context, final Module module, @@ -670,15 +673,47 @@ public final class SchemaContextUtil { final int colCount = normalizeXPath(steps); final List xpaths = colCount == 0 ? steps : steps.subList(colCount, steps.size()); - final Iterable schemaNodePath = actualSchemaNode.getPath().getPathFromRoot(); - if (Iterables.size(schemaNodePath) - colCount >= 0) { - return Iterables.concat(Iterables.limit(schemaNodePath, Iterables.size(schemaNodePath) - colCount), - Iterables.transform(xpaths, input -> stringPathPartToQName(context, module, input))); + final List walkablePath = createWalkablePath(actualSchemaNode.getPath().getPathFromRoot(), + context, colCount); + + if (walkablePath.size() - colCount >= 0) { + return Iterables.concat(Iterables.limit(walkablePath, walkablePath.size() - colCount), + Iterables.transform(xpaths, input -> stringPathPartToQName(context, module, input))); } - return Iterables.concat(schemaNodePath, + return Iterables.concat(walkablePath, Iterables.transform(xpaths, input -> stringPathPartToQName(context, module, input))); } + /** + * Return List of qNames that are walkable using xPath. When getting a path from schema node it will return path + * with parents like CaseSchemaNode and ChoiceSchemaNode as well if they are parents of the node. We need to get + * rid of these in order to find the node that xPath is pointing to. Also we can not remove any node beyond the + * amount of "../" because we will not be able to find the correct schema node from schema context + * + * @param schemaNodePath list of qNames as a path to the leaf of type leafref + * @param context create schema context + * @param colCount amount of "../" in the xPath expression + * @return list of QNames as a path where we should be able to find referenced node + */ + private static List createWalkablePath(final Iterable schemaNodePath, final SchemaContext context, + final int colCount) { + final List indexToRemove = new ArrayList<>(); + List schemaNodePathRet = Lists.newArrayList(schemaNodePath); + for (int j = 0, i = schemaNodePathRet.size() - 1; i >= 0 && j != colCount; i--, j++) { + final SchemaNode nodeIn = findTargetNode(context, schemaNodePathRet); + if (nodeIn instanceof CaseSchemaNode || nodeIn instanceof ChoiceSchemaNode) { + indexToRemove.add(i); + j--; + } + schemaNodePathRet.remove(i); + } + schemaNodePathRet = Lists.newArrayList(schemaNodePath); + for (int i : indexToRemove) { + schemaNodePathRet.remove(i); + } + return schemaNodePathRet; + } + private static SchemaNode resolveDerefPath(final SchemaContext context, final Module module, final SchemaNode actualSchemaNode, final String xpath) { final int paren = xpath.indexOf(')', 6); @@ -722,7 +757,7 @@ public final class SchemaContextUtil { return findTargetNode(context, resolveRelativePath(context, module, deref, qnames)); } - private static @Nullable SchemaNode findTargetNode(final SchemaContext context, final QNameModule defaultModule, + private static @Nullable SchemaNode findTargetNode(final SchemaContext context, final QNameModule localNamespace, final YangLocationPath path) { final Deque ret = new ArrayDeque<>(); for (Step step : path.getSteps()) { @@ -736,19 +771,7 @@ public final class SchemaContextUtil { // This has to be a QNameStep checkState(step instanceof QNameStep, "Unhandled step %s in %s", step, path); - final QName qname; - if (step instanceof ResolvedQNameStep) { - qname = ((ResolvedQNameStep) step).getQName(); - } else if (step instanceof UnresolvedQNameStep) { - final AbstractQName toResolve = ((UnresolvedQNameStep) step).getQName(); - // TODO: should handle qualified QNames, too? parser should have resolved them when we get here... - checkState(toResolve instanceof UnqualifiedQName, "Unhandled qname %s in %s", toResolve, path); - qname = QName.create(defaultModule, toResolve.getLocalName()); - } else { - throw new IllegalStateException("Unhandled step " + step); - } - - ret.addLast(qname); + ret.addLast(resolve(((QNameStep) step).getQName(), localNamespace)); } return findTargetNode(context, ret); @@ -761,6 +784,16 @@ public final class SchemaContextUtil { return pureData.isPresent() ? pureData.get() : findNodeInSchemaContext(context, qnamePath); } + private static QName resolve(final AbstractQName toResolve, final QNameModule localNamespace) { + if (toResolve instanceof QName) { + return (QName) toResolve; + } else if (toResolve instanceof UnqualifiedQName) { + return ((UnqualifiedQName) toResolve).bindTo(localNamespace); + } else { + throw new IllegalStateException("Unhandled step " + toResolve); + } + } + @VisibleForTesting static int normalizeXPath(final List xpath) { LOG.trace("Normalize {}", xpath); @@ -804,7 +837,11 @@ public final class SchemaContextUtil { } private static List doSplitXPath(final String xpath) { - return SLASH_SPLITTER.splitToList(xpath); + final List ret = new ArrayList<>(); + for (String str : SLASH_SPLITTER.split(xpath)) { + ret.add(str); + } + return ret; } /** @@ -822,9 +859,8 @@ public final class SchemaContextUtil { */ public static TypeDefinition getBaseTypeForLeafRef(final LeafrefTypeDefinition typeDefinition, final SchemaContext schemaContext, final SchemaNode schema) { - PathExpression pathStatement = typeDefinition.getPathStatement(); - pathStatement = new PathExpressionImpl(stripConditionsFromXPathString(pathStatement), - pathStatement.isAbsolute()); + final PathExpression pathStatement = typeDefinition.getPathStatement(); + final String pathStr = stripConditionsFromXPathString(pathStatement); final DataSchemaNode dataSchemaNode; if (pathStatement.isAbsolute()) { @@ -838,12 +874,12 @@ public final class SchemaContextUtil { } } - Module parentModule = findParentModuleOfReferencingType(schemaContext, baseSchema); - dataSchemaNode = (DataSchemaNode) findDataSchemaNode(schemaContext, parentModule, pathStatement); + final Module parentModule = findParentModuleOfReferencingType(schemaContext, baseSchema); + dataSchemaNode = (DataSchemaNode) findTargetNode(schemaContext, + xpathToQNamePath(schemaContext, parentModule, pathStr)); } else { Module parentModule = findParentModule(schemaContext, schema); - dataSchemaNode = (DataSchemaNode) findDataSchemaNodeForRelativeXPath(schemaContext, parentModule, schema, - pathStatement); + dataSchemaNode = (DataSchemaNode) resolveRelativeXPath(schemaContext, parentModule, pathStr, schema); } // FIXME this is just to preserve backwards compatibility since yangtools do not mind wrong leafref xpaths @@ -873,17 +909,15 @@ public final class SchemaContextUtil { public static TypeDefinition getBaseTypeForLeafRef(final LeafrefTypeDefinition typeDefinition, final SchemaContext schemaContext, final QName qname) { final PathExpression pathStatement = typeDefinition.getPathStatement(); - final PathExpression strippedPathStatement = new PathExpressionImpl( - stripConditionsFromXPathString(pathStatement), pathStatement.isAbsolute()); - if (!strippedPathStatement.isAbsolute()) { + if (!pathStatement.isAbsolute()) { return null; } final Optional parentModule = schemaContext.findModule(qname.getModule()); checkArgument(parentModule.isPresent(), "Failed to find parent module for %s", qname); - final DataSchemaNode dataSchemaNode = (DataSchemaNode) findDataSchemaNode(schemaContext, parentModule.get(), - strippedPathStatement); + final DataSchemaNode dataSchemaNode = (DataSchemaNode) findTargetNode(schemaContext, + xpathToQNamePath(schemaContext, parentModule.get(), stripConditionsFromXPathString(pathStatement))); final TypeDefinition targetTypeDefinition = typeDefinition(dataSchemaNode); if (targetTypeDefinition instanceof LeafrefTypeDefinition) { return getBaseTypeForLeafRef((LeafrefTypeDefinition) targetTypeDefinition, schemaContext, dataSchemaNode); @@ -923,36 +957,6 @@ public final class SchemaContextUtil { return STRIP_PATTERN.matcher(pathStatement.getOriginalString()).replaceAll(""); } - /** - * Extracts the base type of leaf schema node until it reach concrete type of TypeDefinition. - * - * @param node - * a node representing LeafSchemaNode - * @return concrete type definition of node value - */ - private static TypeDefinition typeDefinition(final LeafSchemaNode node) { - TypeDefinition baseType = node.getType(); - while (baseType.getBaseType() != null) { - baseType = baseType.getBaseType(); - } - return baseType; - } - - /** - * Extracts the base type of leaf schema node until it reach concrete type of TypeDefinition. - * - * @param node - * a node representing LeafListSchemaNode - * @return concrete type definition of node value - */ - private static TypeDefinition typeDefinition(final LeafListSchemaNode node) { - TypeDefinition baseType = node.getType(); - while (baseType.getBaseType() != null) { - baseType = baseType.getBaseType(); - } - return baseType; - } - /** * Gets the base type of DataSchemaNode value. * @@ -961,12 +965,15 @@ public final class SchemaContextUtil { * @return concrete type definition of node value */ private static TypeDefinition typeDefinition(final DataSchemaNode node) { - if (node instanceof LeafListSchemaNode) { - return typeDefinition((LeafListSchemaNode) node); - } else if (node instanceof LeafSchemaNode) { - return typeDefinition((LeafSchemaNode) node); - } else { - throw new IllegalArgumentException("Unhandled parameter type: " + node); + checkArgument(node instanceof TypedDataSchemaNode, "Unhandled parameter type %s", node); + + TypeDefinition current = ((TypedDataSchemaNode) node).getType(); + // TODO: don't we have a utility for this? + TypeDefinition base = current.getBaseType(); + while (base != null) { + current = base; + base = current.getBaseType(); } + return current; } }