/*
* Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.yangtools.yang.model.util;
import com.google.common.base.Function;
import com.google.common.base.Preconditions;
import com.google.common.base.Splitter;
import com.google.common.collect.Iterables;
import java.util.Arrays;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
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.ListSchemaNode;
import org.opendaylight.yangtools.yang.model.api.Module;
import org.opendaylight.yangtools.yang.model.api.ModuleImport;
import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath;
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.TypeDefinition;
import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* The Schema Context Util contains support methods for searching through Schema
* Context modules for specified schema nodes via Schema Path or Revision Aware
* XPath. The Schema Context Util is designed as mixin, so it is not
* instantiable.
*
*/
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('/');
private SchemaContextUtil() {
}
/**
* Method attempts to find DataSchemaNode in Schema Context via specified
* Schema Path. The returned DataSchemaNode from method will be the node at
* the end of the SchemaPath. If the DataSchemaNode is not present in the
* Schema Context the method will return null.
* In case that Schema Context or Schema Path are not specified correctly
* (i.e. contains null values) the method will return
* IllegalArgumentException.
*
* @throws IllegalArgumentException
*
* @param context
* Schema Context
* @param schemaPath
* Schema Path to search for
* @return SchemaNode from the end of the Schema Path or null
* if the Node is not present.
*/
public static SchemaNode findDataSchemaNode(final SchemaContext context, final SchemaPath schemaPath) {
Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL");
Preconditions.checkArgument(schemaPath != null, "Schema Path reference cannot be NULL");
final Iterable prefixedPath = schemaPath.getPathFromRoot();
if (prefixedPath == null) {
LOG.debug("Schema path {} has null path", schemaPath);
return null;
}
LOG.trace("Looking for path {} in context {}", schemaPath, context);
return findNodeInSchemaContext(context, prefixedPath);
}
/**
* Method attempts to find DataSchemaNode inside of provided Schema Context
* and Yang Module accordingly to Non-conditional Revision Aware XPath. The
* specified Module MUST be present in Schema Context otherwise the
* operation would fail and return null.
* The Revision Aware XPath MUST be specified WITHOUT the conditional
* statement (i.e. without [cond]) in path, because in this state the Schema
* Context is completely unaware of data state and will be not able to
* properly resolve XPath. If the XPath contains condition the method will
* return IllegalArgumentException.
* In case that Schema Context or Module or Revision Aware XPath contains
* null references the method will throw
* IllegalArgumentException
* If the Revision Aware XPath is correct and desired Data Schema Node is
* present in Yang module or in depending module in Schema Context the
* method will return specified Data Schema Node, otherwise the operation
* will fail and method will return null.
*
* @throws IllegalArgumentException
*
* @param context
* Schema Context
* @param module
* Yang Module
* @param nonCondXPath
* Non Conditional Revision Aware XPath
* @return Returns Data Schema Node for specified Schema Context for given
* Non-conditional Revision Aware XPath, or null if the
* DataSchemaNode is not present in Schema Context.
*/
public static SchemaNode findDataSchemaNode(final SchemaContext context, final Module module, final RevisionAwareXPath nonCondXPath) {
Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL");
Preconditions.checkArgument(module != null, "Module reference cannot be NULL");
Preconditions.checkArgument(nonCondXPath != null, "Non Conditional Revision Aware XPath cannot be NULL");
String strXPath = nonCondXPath.toString();
if (strXPath != null) {
Preconditions.checkArgument(strXPath.indexOf('[') == -1, "Revision Aware XPath may not contain a condition");
if (nonCondXPath.isAbsolute()) {
List qnamedPath = xpathToQNamePath(context, module, strXPath);
if (qnamedPath != null) {
return findNodeInSchemaContext(context, qnamedPath);
}
}
}
return null;
}
/**
* Method attempts to find DataSchemaNode inside of provided Schema Context
* and Yang Module accordingly to Non-conditional relative Revision Aware
* XPath. The specified Module MUST be present in Schema Context otherwise
* the operation would fail and return null.
* The relative Revision Aware XPath MUST be specified WITHOUT the
* conditional statement (i.e. without [cond]) in path, because in this
* state the Schema Context is completely unaware of data state and will be
* not able to properly resolve XPath. If the XPath contains condition the
* method will return IllegalArgumentException.
* The Actual Schema Node MUST be specified correctly because from this
* Schema Node will search starts. If the Actual Schema Node is not correct
* the operation will simply fail, because it will be unable to find desired
* DataSchemaNode.
* In case that Schema Context or Module or Actual Schema Node or relative
* Revision Aware XPath contains null references the method
* will throw IllegalArgumentException
* If the Revision Aware XPath doesn't have flag
* isAbsolute == false the method will throw
* IllegalArgumentException.
* If the relative Revision Aware XPath is correct and desired Data Schema
* Node is present in Yang module or in depending module in Schema Context
* the method will return specified Data Schema Node, otherwise the
* operation will fail and method will return null.
*
* @throws IllegalArgumentException
*
* @param context
* Schema Context
* @param module
* Yang Module
* @param actualSchemaNode
* Actual Schema Node
* @param relativeXPath
* Relative Non Conditional Revision Aware XPath
* @return DataSchemaNode if is present in specified Schema Context for
* given relative Revision Aware XPath, otherwise will return
* null.
*/
public static SchemaNode findDataSchemaNodeForRelativeXPath(final SchemaContext context, final Module module,
final SchemaNode actualSchemaNode, final RevisionAwareXPath relativeXPath) {
Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL");
Preconditions.checkArgument(module != null, "Module reference cannot be NULL");
Preconditions.checkArgument(actualSchemaNode != null, "Actual Schema Node reference cannot be NULL");
Preconditions.checkArgument(relativeXPath != null, "Non Conditional Revision Aware XPath cannot be NULL");
Preconditions.checkState(!relativeXPath.isAbsolute(),
"Revision Aware XPath MUST be relative i.e. MUST contains ../, "
+ "for non relative Revision Aware XPath use findDataSchemaNode method");
SchemaPath actualNodePath = actualSchemaNode.getPath();
if (actualNodePath != null) {
Iterable qnamePath = resolveRelativeXPath(context, module, relativeXPath, actualSchemaNode);
if (qnamePath != null) {
return findNodeInSchemaContext(context, qnamePath);
}
}
return null;
}
/**
* Returns parent Yang Module for specified Schema Context in which Schema
* Node is declared. If the Schema Node is not present in Schema Context the
* operation will return null.
* If Schema Context or Schema Node contains null references
* the method will throw IllegalArgumentException
*
* @throws IllegalArgumentException
*
* @param context
* Schema Context
* @param schemaNode
* Schema Node
* @return Yang Module for specified Schema Context and Schema Node, if
* Schema Node is NOT present, the method will returns
* null
*/
public static Module findParentModule(final SchemaContext context, final SchemaNode schemaNode) {
Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL!");
Preconditions.checkArgument(schemaNode != null, "Schema Node cannot be NULL!");
Preconditions.checkState(schemaNode.getPath() != null, "Schema Path for Schema Node is not "
+ "set properly (Schema Path is NULL)");
final QName qname = Iterables.getFirst(schemaNode.getPath().getPathTowardsRoot(), null);
Preconditions.checkState(qname != null,
"Schema Path contains invalid state of path parts. " +
"The Schema Path MUST contain at least ONE QName which defines namespace and Local name of path.");
return context.findModuleByNamespaceAndRevision(qname.getNamespace(), qname.getRevision());
}
public static SchemaNode findNodeInSchemaContext(final SchemaContext context, final Iterable path) {
final QName current = path.iterator().next();
LOG.trace("Looking up module {} in context {}", current, path);
final Module module = context.findModuleByNamespaceAndRevision(current.getNamespace(), current.getRevision());
if (module == null) {
LOG.debug("Module {} not found", current);
return null;
}
return findNodeInModule(module, path);
}
private static SchemaNode findNodeInModule(final Module module, final Iterable path) {
final QName current = path.iterator().next();
LOG.trace("Looking for data container {} in module {}", current, module);
SchemaNode parent = module.getDataChildByName(current);
if (parent != null) {
final SchemaNode ret = findNode((DataSchemaNode) parent, nextLevel(path));
if (ret != null) {
return ret;
}
}
LOG.trace("Looking for RPC {} in module {}", current, module);
parent = getRpcByName(module, current);
if (parent != null) {
final SchemaNode ret = findNodeInRpc((RpcDefinition) parent, nextLevel(path));
if (ret != null) {
return ret;
}
}
LOG.trace("Looking for notification {} in module {}", current, module);
parent = getNotificationByName(module, current);
if (parent != null) {
final SchemaNode ret = findNodeInNotification((NotificationDefinition) parent, nextLevel(path));
if (ret != null) {
return ret;
}
}
LOG.trace("Looking for grouping {} in module {}", current, module);
parent = getGroupingByName(module, current);
if (parent != null) {
final SchemaNode ret = findNodeInGrouping((GroupingDefinition) parent, nextLevel(path));
if (ret != null) {
return ret;
}
}
LOG.debug("No node matching {} found in module {}", path, module);
return null;
}
private static SchemaNode findNodeInGrouping(
final GroupingDefinition grouping, final Iterable path) {
final QName current = Iterables.getFirst(path, null);
if (current == null) {
LOG.debug("Found grouping {}", grouping);
return grouping;
}
LOG.trace("Looking for path {} in grouping {}", path, grouping);
final DataSchemaNode node = grouping.getDataChildByName(current);
if (node != null)
return findNode(node, nextLevel(path));
for (GroupingDefinition groupingDefinition : grouping.getGroupings()) {
if (groupingDefinition.getQName().equals(current))
return findNodeInGrouping(groupingDefinition, nextLevel(path));
}
LOG.debug("No node matching {} found in grouping {}", current, grouping);
return null;
}
private static SchemaNode findNodeInRpc(final RpcDefinition rpc, final Iterable path) {
final QName current = Iterables.getFirst(path, null);
if (current == null) {
LOG.debug("Found RPC {}", rpc);
return rpc;
}
LOG.trace("Looking for path {} in rpc {}", path, rpc);
switch (current.getLocalName()) {
case "input":
return findNode(rpc.getInput(), nextLevel(path));
case "output":
return findNode(rpc.getOutput(), nextLevel(path));
default:
LOG.debug("Invalid component {} of path {} in RPC {}", current, path, rpc);
return null;
}
}
private static SchemaNode findNodeInNotification(final NotificationDefinition ntf, final Iterable path) {
final QName current = Iterables.getFirst(path, null);
if (current == null) {
LOG.debug("Found notification {}", ntf);
return ntf;
}
LOG.trace("Looking for path {} in notification {}", path, ntf);
DataSchemaNode node = ntf.getDataChildByName(current);
if (node == null) {
LOG.debug("No node matching {} found in notification {}", current, ntf);
return null;
}
return findNode(node, nextLevel(path));
}
private static SchemaNode findNode(final ChoiceNode parent, final Iterable path) {
final QName current = Iterables.getFirst(path, null);
if (current == null) {
return parent;
}
ChoiceCaseNode node = parent.getCaseNodeByName(current);
if (node != null) {
return findNodeInCase(node, nextLevel(path));
}
return null;
}
private static SchemaNode findNode(final ContainerSchemaNode parent, final Iterable path) {
final QName current = Iterables.getFirst(path, null);
if (current == null) {
return parent;
}
final DataSchemaNode node = parent.getDataChildByName(current);
if (node == null) {
LOG.debug("Failed to find {} in parent {}", path, parent);
return null;
}
return findNode(node, nextLevel(path));
}
private static SchemaNode findNode(final ListSchemaNode parent, final Iterable path) {
final QName current = Iterables.getFirst(path, null);
if (current == null) {
return parent;
}
DataSchemaNode node = parent.getDataChildByName(current);
if (node == null) {
LOG.debug("Failed to find {} in parent {}", path, parent);
return null;
}
return findNode(node, nextLevel(path));
}
private static SchemaNode findNode(final DataSchemaNode parent, final Iterable path) {
final SchemaNode node;
if (!Iterables.isEmpty(path)) {
if (parent instanceof ContainerSchemaNode) {
node = findNode((ContainerSchemaNode) parent, path);
} else if (parent instanceof ListSchemaNode) {
node = findNode((ListSchemaNode) parent, path);
} else if (parent instanceof ChoiceNode) {
node = findNode((ChoiceNode) parent, path);
} else {
throw new IllegalArgumentException(
String.format("Path nesting violation in parent %s path %s", parent, path));
}
} else {
node = parent;
}
if (node == null) {
LOG.debug("Failed to find {} in parent {}", path, parent);
return null;
}
return node;
}
private static SchemaNode findNodeInCase(final ChoiceCaseNode parent, final Iterable path) {
final QName current = Iterables.getFirst(path, null);
if (current == null) {
return parent;
}
DataSchemaNode node = parent.getDataChildByName(current);
if (node == null) {
LOG.debug("Failed to find {} in parent {}", path, parent);
return null;
}
return findNode(node, nextLevel(path));
}
private static RpcDefinition getRpcByName(final Module module, final QName name) {
for (RpcDefinition rpc : module.getRpcs()) {
if (rpc.getQName().equals(name)) {
return rpc;
}
}
return null;
}
private static Iterable nextLevel(final Iterable path) {
return Iterables.skip(path, 1);
}
private static NotificationDefinition getNotificationByName(final Module module, final QName name) {
for (NotificationDefinition notification : module.getNotifications()) {
if (notification.getQName().equals(name)) {
return notification;
}
}
return null;
}
private static GroupingDefinition getGroupingByName(final Module module, final QName name) {
for (GroupingDefinition grouping : module.getGroupings()) {
if (grouping.getQName().equals(name)) {
return grouping;
}
}
return null;
}
/**
* Transforms string representation of XPath to Queue of QNames. The XPath
* is split by "/" and for each part of XPath is assigned correct module in
* Schema Path.
* If Schema Context, Parent Module or XPath string contains
* null values, the method will throws IllegalArgumentException
*
* @throws IllegalArgumentException
*
* @param context
* Schema Context
* @param parentModule
* Parent Module
* @param xpath
* XPath String
* @return return a list of QName
*/
private static List xpathToQNamePath(final SchemaContext context, final Module parentModule, final String xpath) {
Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL");
Preconditions.checkArgument(parentModule != null, "Parent Module reference cannot be NULL");
Preconditions.checkArgument(xpath != null, "XPath string reference cannot be NULL");
List path = new LinkedList();
for (String pathComponent : SLASH_SPLITTER.split(xpath)) {
if (!pathComponent.isEmpty()) {
path.add(stringPathPartToQName(context, parentModule, pathComponent));
}
}
return path;
}
/**
* Transforms part of Prefixed Path as java String to QName.
* If the string contains module prefix separated by ":" (i.e.
* mod:container) this module is provided from from Parent Module list of
* imports. If the Prefixed module is present in Schema Context the QName
* can be constructed.
* If the Prefixed Path Part does not contains prefix the Parent's Module
* namespace is taken for construction of QName.
* If Schema Context, Parent Module or Prefixed Path Part refers to
* null the method will throw IllegalArgumentException
*
* @throws IllegalArgumentException
*
* @param context
* Schema Context
* @param parentModule
* Parent Module
* @param prefixedPathPart
* Prefixed Path Part string
* @return QName from prefixed Path Part String.
*/
private static QName stringPathPartToQName(final SchemaContext context, final Module parentModule, final String prefixedPathPart) {
Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL");
Preconditions.checkArgument(parentModule != null, "Parent Module reference cannot be NULL");
Preconditions.checkArgument(prefixedPathPart != null, "Prefixed Path Part cannot be NULL!");
if (prefixedPathPart.indexOf(':') != -1) {
final Iterator prefixedName = COLON_SPLITTER.split(prefixedPathPart).iterator();
final String modulePrefix = prefixedName.next();
Module module = resolveModuleForPrefix(context, parentModule, modulePrefix);
Preconditions.checkArgument(module != null, "Failed to resolve xpath: no module found for prefix %s in module %s",
modulePrefix, parentModule.getName());
// FIXME: Module should have a QNameModule handle
return QName.create(module.getNamespace(), module.getRevision(), prefixedName.next());
} else {
return QName.create(parentModule.getNamespace(), parentModule.getRevision(), prefixedPathPart);
}
}
/**
* Method will attempt to resolve and provide Module reference for specified
* module prefix. Each Yang module could contains multiple imports which
* MUST be associated with corresponding module prefix. The method simply
* looks into module imports and returns the module that is bounded with
* specified prefix. If the prefix is not present in module or the prefixed
* module is not present in specified Schema Context, the method will return
* null.
* If String prefix is the same as prefix of the specified Module the
* reference to this module is returned.
* If Schema Context, Module or Prefix are referring to null
* the method will return IllegalArgumentException
*
* @throws IllegalArgumentException
*
* @param context
* Schema Context
* @param module
* Yang Module
* @param prefix
* Module Prefix
* @return Module for given prefix in specified Schema Context if is
* present, otherwise returns null
*/
private static Module resolveModuleForPrefix(final SchemaContext context, final Module module, final String prefix) {
Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL");
Preconditions.checkArgument(module != null, "Module reference cannot be NULL");
Preconditions.checkArgument(prefix != null, "Prefix string cannot be NULL");
if (prefix.equals(module.getPrefix())) {
return module;
}
Set imports = module.getImports();
for (ModuleImport mi : imports) {
if (prefix.equals(mi.getPrefix())) {
return context.findModuleByName(mi.getModuleName(), mi.getRevision());
}
}
return null;
}
/**
* @throws IllegalArgumentException
*
* @param context
* Schema Context
* @param module
* Yang Module
* @param relativeXPath
* Non conditional Revision Aware Relative XPath
* @param leafrefSchemaPath
* Schema Path for Leafref
* @return list of QName
*/
private static Iterable resolveRelativeXPath(final SchemaContext context, final Module module,
final RevisionAwareXPath relativeXPath, final SchemaNode leafrefParentNode) {
Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL");
Preconditions.checkArgument(module != null, "Module reference cannot be NULL");
Preconditions.checkArgument(relativeXPath != null, "Non Conditional Revision Aware XPath cannot be NULL");
Preconditions.checkState(!relativeXPath.isAbsolute(),
"Revision Aware XPath MUST be relative i.e. MUST contains ../, "
+ "for non relative Revision Aware XPath use findDataSchemaNode method");
Preconditions.checkState(leafrefParentNode.getPath() != null,
"Schema Path reference for Leafref cannot be NULL");
final Iterable xpaths = SLASH_SPLITTER.split(relativeXPath.toString());
// Find out how many "parent" components there are
// FIXME: is .contains() the right check here?
int colCount = 0;
for (Iterator it = xpaths.iterator(); it.hasNext() && it.next().contains(".."); ) {
++colCount;
}
final Iterable parent = leafrefParentNode.getPath().getPathFromRoot();
return Iterables.concat(Iterables.limit(parent, Iterables.size(parent) - colCount),
Iterables.transform(Iterables.skip(xpaths, colCount), new Function() {
@Override
public QName apply(final String input) {
return stringPathPartToQName(context, module, input);
}
}));
}
/**
* Extracts the base type of node on which schema node points to. If target node is again of type LeafrefTypeDefinition, methods will be call recursively until it reach concrete
* type definition.
*
* @param typeDefinition
* type of node which will be extracted
* @param schemaContext
* Schema Context
* @param schema
* Schema Node
* @return
*/
public static TypeDefinition getBaseTypeForLeafRef(final LeafrefTypeDefinition typeDefinition, final SchemaContext schemaContext, final SchemaNode schema) {
RevisionAwareXPath pathStatement = typeDefinition.getPathStatement();
pathStatement = new RevisionAwareXPathImpl(stripConditionsFromXPathString(pathStatement), pathStatement.isAbsolute());
final Module parentModule = SchemaContextUtil.findParentModule(schemaContext, schema);
final DataSchemaNode dataSchemaNode;
if(pathStatement.isAbsolute()) {
dataSchemaNode = (DataSchemaNode) SchemaContextUtil.findDataSchemaNode(schemaContext, parentModule, pathStatement);
} else {
SchemaPath parentSchemaPath = schema.getPath().getParent();
SchemaNode parentSchemaNode = SchemaContextUtil.findDataSchemaNode(schemaContext, parentSchemaPath);
dataSchemaNode = (DataSchemaNode) SchemaContextUtil.findDataSchemaNodeForRelativeXPath(schemaContext, parentModule, parentSchemaNode, pathStatement);
}
final TypeDefinition targetTypeDefinition = typeDefinition(dataSchemaNode);
if(targetTypeDefinition instanceof LeafrefTypeDefinition) {
return getBaseTypeForLeafRef(((LeafrefTypeDefinition) targetTypeDefinition), schemaContext, dataSchemaNode);
} else {
return targetTypeDefinition;
}
}
/**
* Removes conditions from xPath pointed to target node.
*
* @param pathStatement
* xPath to target node
* @return string representation of xPath without conditions
*
*/
private static String stripConditionsFromXPathString(final RevisionAwareXPath pathStatement) {
return pathStatement.toString().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.
*
* @param node
* a node representing DataSchemaNode
* @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 types: " + Arrays.