package org.opendaylight.yangtools.yang.parser.stmt.rfc6020;
import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.firstAttributeOf;
-
-import java.net.URI;
-import java.net.URISyntaxException;
+import com.google.common.base.CharMatcher;
+import com.google.common.base.Preconditions;
+import com.google.common.base.Splitter;
+import com.google.common.base.Strings;
+import com.google.common.collect.Iterables;
import java.util.ArrayList;
import java.util.Arrays;
+import java.util.Collection;
import java.util.Date;
-import java.util.Iterator;
-import java.util.LinkedList;
+import java.util.HashSet;
import java.util.List;
-
+import java.util.Objects;
+import java.util.Set;
+import java.util.regex.Pattern;
import javax.annotation.Nullable;
import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathExpressionException;
import javax.xml.xpath.XPathFactory;
-
import org.antlr.v4.runtime.tree.TerminalNode;
import org.opendaylight.yangtools.antlrv4.code.gen.YangStatementParser;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.common.QNameModule;
+import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
+import org.opendaylight.yangtools.yang.model.api.Deviation;
import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
-import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath;
+import org.opendaylight.yangtools.yang.model.api.Status;
import org.opendaylight.yangtools.yang.model.api.stmt.BelongsToStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.ModuleStatement;
-import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.RevisionStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
+import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Relative;
import org.opendaylight.yangtools.yang.model.api.stmt.SubmoduleStatement;
+import org.opendaylight.yangtools.yang.model.util.RevisionAwareXPathImpl;
+import org.opendaylight.yangtools.yang.parser.spi.meta.QNameCacheNamespace;
import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToPrefixToModuleName;
import org.opendaylight.yangtools.yang.parser.spi.source.ImpPrefixToModuleIdentifier;
+import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName;
import org.opendaylight.yangtools.yang.parser.spi.source.ModuleIdentifierToModuleQName;
import org.opendaylight.yangtools.yang.parser.spi.source.ModuleNameToModuleQName;
import org.opendaylight.yangtools.yang.parser.spi.source.PrefixToModule;
+import org.opendaylight.yangtools.yang.parser.spi.source.QNameToStatementDefinition;
import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
-
-import com.google.common.base.CharMatcher;
-import com.google.common.base.Splitter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public final class Utils {
+ private static final Logger LOG = LoggerFactory.getLogger(Utils.class);
+ private static final CharMatcher DOUBLE_QUOTE_MATCHER = CharMatcher.is('"');
+ private static final CharMatcher SINGLE_QUOTE_MATCHER = CharMatcher.is('\'');
+ private static final Splitter SLASH_SPLITTER = Splitter.on('/').omitEmptyStrings().trimResults();
+ private static final Splitter SPACE_SPLITTER = Splitter.on(' ').omitEmptyStrings().trimResults();
+ private static final Pattern PATH_ABS = Pattern.compile("/[^/].*");
+
+ private static final ThreadLocal<XPathFactory> XPATH_FACTORY = new ThreadLocal<XPathFactory>() {
+ @Override
+ protected XPathFactory initialValue() {
+ return XPathFactory.newInstance();
+ }
+ };
private Utils() {
+ throw new UnsupportedOperationException();
}
- private static final Logger LOG = LoggerFactory.getLogger(Utils.class);
- private static final CharMatcher DOUBLE_QUOTE_MATCHER = CharMatcher.is('"');
- private static final CharMatcher SINGLE_QUOTE_MATCHER = CharMatcher.is('\'');
+ /**
+ * Cleanup any resources attached to the current thread. Threads interacting with this class can cause thread-local
+ * caches to them. Invoke this method if you want to detach those resources.
+ */
+ public static void detachFromCurrentThread() {
+ XPATH_FACTORY.remove();
+ }
+
+ public static Collection<SchemaNodeIdentifier.Relative> transformKeysStringToKeyNodes(final StmtContext<?, ?, ?> ctx,
+ final String value) {
+ List<String> keyTokens = SPACE_SPLITTER.splitToList(value);
+
+ // to detect if key contains duplicates
+ if ((new HashSet<>(keyTokens)).size() < keyTokens.size()) {
+ // FIXME: report all duplicate keys
+ throw new IllegalArgumentException();
+ }
- private static final char SEPARATOR_NODENAME = '/';
+ Set<SchemaNodeIdentifier.Relative> keyNodes = new HashSet<>();
- private static final String REGEX_PATH_ABS = "/[^/].+";
+ for (String keyToken : keyTokens) {
- public static List<String> splitPathToNodeNames(String path) {
+ SchemaNodeIdentifier.Relative keyNode = (Relative) SchemaNodeIdentifier.Relative.create(false,
+ Utils.qNameFromArgument(ctx, keyToken));
+ keyNodes.add(keyNode);
+ }
- Splitter keySplitter = Splitter.on(SEPARATOR_NODENAME).omitEmptyStrings().trimResults();
- return keySplitter.splitToList(path);
+ return keyNodes;
}
- public static void validateXPath(String path) {
+ private static String trimSingleLastSlashFromXPath(final String path) {
+ return path.endsWith("/") ? path.substring(0, path.length() - 1) : path;
+ }
- final XPath xPath = XPathFactory.newInstance().newXPath();
+ static RevisionAwareXPath parseXPath(final StmtContext<?, ?, ?> ctx, final String path) {
+ final XPath xPath = XPATH_FACTORY.get().newXPath();
+ xPath.setNamespaceContext(StmtNamespaceContext.create(ctx));
+ final String trimmed = trimSingleLastSlashFromXPath(path);
try {
- xPath.compile(path);
+ // TODO: we could capture the result and expose its 'evaluate' method
+ xPath.compile(trimmed);
} catch (XPathExpressionException e) {
- throw new IllegalArgumentException("Argument is not valid XPath string", e);
+ LOG.warn("Argument \"{}\" is not valid XPath string at \"{}\"", path, ctx.getStatementSourceReference(), e);
}
+
+ return new RevisionAwareXPathImpl(path, PATH_ABS.matcher(path).matches());
}
- public static boolean isXPathAbsolute(String path) {
+ public static QName trimPrefix(final QName identifier) {
+ String prefixedLocalName = identifier.getLocalName();
+ String[] namesParts = prefixedLocalName.split(":");
- validateXPath(path);
+ if (namesParts.length == 2) {
+ String localName = namesParts[1];
+ return QName.create(identifier.getModule(), localName);
+ }
- return path.matches(REGEX_PATH_ABS);
+ return identifier;
}
- public static Iterable<QName> parseXPath(StmtContext<?, ?, ?> ctx, String path) {
-
- validateXPath(path);
-
- List<String> nodeNames = splitPathToNodeNames(path);
- List<QName> qNames = new ArrayList<>();
+ /**
+ *
+ * Based on identifier read from source and collections of relevant prefixes and statement definitions mappings
+ * provided for actual phase, method resolves and returns valid QName for declared statement to be written.
+ * This applies to any declared statement, including unknown statements.
+ *
+ * @param prefixes - collection of all relevant prefix mappings supplied for actual parsing phase
+ * @param stmtDef - collection of all relevant statement definition mappings provided for actual parsing phase
+ * @param identifier - statement to parse from source
+ * @return valid QName for declared statement to be written
+ *
+ */
+ public static QName getValidStatementDefinition(final PrefixToModule prefixes, final QNameToStatementDefinition
+ stmtDef, final QName identifier) {
+ if (stmtDef.get(identifier) != null) {
+ return stmtDef.get(identifier).getStatementName();
+ } else {
+ String prefixedLocalName = identifier.getLocalName();
+ String[] namesParts = prefixedLocalName.split(":");
+
+ if (namesParts.length == 2) {
+ String prefix = namesParts[0];
+ String localName = namesParts[1];
+ if (prefixes != null && prefixes.get(prefix) != null
+ && stmtDef.get(QName.create(prefixes.get(prefix), localName)) != null) {
+ return QName.create(prefixes.get(prefix), localName);
+ }
+ }
+ }
+ return null;
+ }
- for (String nodeName : nodeNames) {
+ static SchemaNodeIdentifier nodeIdentifierFromPath(final StmtContext<?, ?, ?> ctx, final String path) {
+ // FIXME: is the path trimming really necessary??
+ final List<QName> qNames = new ArrayList<>();
+ for (String nodeName : SLASH_SPLITTER.split(trimSingleLastSlashFromXPath(path))) {
try {
final QName qName = Utils.qNameFromArgument(ctx, nodeName);
qNames.add(qName);
} catch (Exception e) {
- throw new IllegalArgumentException(e);
+ throw new IllegalArgumentException(
+ String.format("Failed to parse node '%s' in path '%s'", nodeName, path), e);
}
}
- return qNames;
+ return SchemaNodeIdentifier.create(qNames, PATH_ABS.matcher(path).matches());
}
public static String stringFromStringContext(final YangStatementParser.ArgumentContext context) {
StringBuilder sb = new StringBuilder();
List<TerminalNode> strings = context.STRING();
- if (strings.size() == 0) {
+ if (strings.isEmpty()) {
strings = Arrays.asList(context.IDENTIFIER());
}
for (TerminalNode stringNode : strings) {
return sb.toString();
}
- public static QName qNameFromArgument(StmtContext<?, ?, ?> ctx, String value) {
+ public static QName qNameFromArgument(StmtContext<?, ?, ?> ctx, final String value) {
+ if (Strings.isNullOrEmpty(value)) {
+ return ctx.getPublicDefinition().getStatementName();
+ }
- String prefix = null;
+ String prefix;
QNameModule qNameModule = null;
- try {
- qNameModule = QNameModule.create(new URI(""), new Date(0));
- } catch (URISyntaxException e) {
- LOG.warn(e.getMessage(), e);
- }
String localName = null;
String[] namesParts = value.split(":");
switch (namesParts.length) {
case 1:
localName = namesParts[0];
-
- if (StmtContextUtils.producesDeclared(ctx.getRoot(), ModuleStatement.class)) {
- prefix = firstAttributeOf(ctx.getRoot().declaredSubstatements(), PrefixStatement.class);
- qNameModule = ctx.getFromNamespace(PrefixToModule.class, prefix);
-
- } else if (StmtContextUtils.producesDeclared(ctx.getRoot(), SubmoduleStatement.class)) {
- String belongsToModuleName = firstAttributeOf(ctx.getRoot().declaredSubstatements(),
- BelongsToStatement.class);
- qNameModule = ctx.getFromNamespace(ModuleNameToModuleQName.class, belongsToModuleName);
- }
+ qNameModule = getRootModuleQName(ctx);
break;
- case 2:
+ default:
prefix = namesParts[0];
localName = namesParts[1];
-
- ModuleIdentifier impModIdentifier = ctx.getRoot().getFromNamespace(ImpPrefixToModuleIdentifier.class,
- prefix);
- qNameModule = ctx.getFromNamespace(ModuleIdentifierToModuleQName.class, impModIdentifier);
-
- if (qNameModule == null && StmtContextUtils.producesDeclared(ctx.getRoot(), SubmoduleStatement.class)) {
- String moduleName = ctx.getRoot().getFromNamespace(BelongsToPrefixToModuleName.class, prefix);
- qNameModule = ctx.getFromNamespace(ModuleNameToModuleQName.class, moduleName);
+ qNameModule = getModuleQNameByPrefix(ctx, prefix);
+ // in case of unknown statement argument, we're not going to parse it
+ if (qNameModule == null
+ && ctx.getPublicDefinition().getDeclaredRepresentationClass()
+ .isAssignableFrom(UnknownStatementImpl.class)) {
+ localName = value;
+ qNameModule = getRootModuleQName(ctx);
+ }
+ if (qNameModule == null
+ && Iterables.getLast(ctx.getCopyHistory()) == StmtContext.TypeOfCopy.ADDED_BY_AUGMENTATION) {
+ ctx = ctx.getOriginalCtx();
+ qNameModule = getModuleQNameByPrefix(ctx, prefix);
}
-
- break;
- default:
break;
}
- return QName.create(qNameModule, localName);
- }
-
- @Nullable
- public static StatementContextBase<?, ?, ?> findCtxOfNodeInRoot(StatementContextBase<?, ?, ?> rootStmtCtx,
- final SchemaNodeIdentifier node) {
-
- StatementContextBase<?, ?, ?> parent = rootStmtCtx;
- final Iterator<QName> pathIter = node.getPathFromRoot().iterator();
+ Preconditions.checkArgument(qNameModule != null, "Error in module '%s': can not resolve QNameModule for '%s'.",
+ ctx.getRoot().rawStatementArgument(), value);
+ final QNameModule resultQNameModule;
+ if (qNameModule.getRevision() == null) {
+ resultQNameModule = QNameModule.create(qNameModule.getNamespace(), SimpleDateFormatUtil.DEFAULT_DATE_REV)
+ .intern();
+ } else {
+ resultQNameModule = qNameModule;
+ }
- QName targetNode = pathIter.next();
+ return ctx.getFromNamespace(QNameCacheNamespace.class, QName.create(resultQNameModule, localName));
+ }
- while (pathIter.hasNext()) {
+ public static QNameModule getModuleQNameByPrefix(final StmtContext<?, ?, ?> ctx, final String prefix) {
+ final ModuleIdentifier modId = ctx.getRoot().getFromNamespace(ImpPrefixToModuleIdentifier.class, prefix);
+ final QNameModule qNameModule = ctx.getFromNamespace(ModuleIdentifierToModuleQName.class, modId);
- for (StatementContextBase<?, ?, ?> child : parent.declaredSubstatements()) {
+ if (qNameModule == null && StmtContextUtils.producesDeclared(ctx.getRoot(), SubmoduleStatement.class)) {
+ String moduleName = ctx.getRoot().getFromNamespace(BelongsToPrefixToModuleName.class, prefix);
+ return ctx.getFromNamespace(ModuleNameToModuleQName.class, moduleName);
+ }
+ return qNameModule;
+ }
- if (targetNode.equals(child.getStatementArgument())) {
- parent = child;
- targetNode = pathIter.next();
- }
- }
+ public static QNameModule getRootModuleQName(final StmtContext<?, ?, ?> ctx) {
+ if (ctx == null) {
+ return null;
+ }
- if (parent.equals(rootStmtCtx)) {
+ final StmtContext<?, ?, ?> rootCtx = ctx.getRoot();
+ final QNameModule qNameModule;
- return null;
- }
+ if (StmtContextUtils.producesDeclared(rootCtx, ModuleStatement.class)) {
+ qNameModule = rootCtx.getFromNamespace(ModuleCtxToModuleQName.class, rootCtx);
+ } else if (StmtContextUtils.producesDeclared(rootCtx, SubmoduleStatement.class)) {
+ final String belongsToModuleName = firstAttributeOf(rootCtx.substatements(), BelongsToStatement.class);
+ qNameModule = rootCtx.getFromNamespace(ModuleNameToModuleQName.class, belongsToModuleName);
+ } else {
+ qNameModule = null;
}
- StatementContextBase<?, ?, ?> targetCtx = null;
+ Preconditions.checkArgument(qNameModule != null, "Failed to look up root QNameModule for %s", ctx);
+ if (qNameModule.getRevision() != null) {
+ return qNameModule;
+ }
- for (StatementContextBase<?, ?, ?> child : parent.declaredSubstatements()) {
+ return QNameModule.create(qNameModule.getNamespace(), SimpleDateFormatUtil.DEFAULT_DATE_REV).intern();
+ }
- if (targetNode.equals(child.getStatementArgument())) {
- targetCtx = child;
- }
- }
+ @Nullable
+ public static StatementContextBase<?, ?, ?> findNode(final StmtContext<?, ?, ?> rootStmtCtx,
+ final SchemaNodeIdentifier node) {
+ return (StatementContextBase<?, ?, ?>) rootStmtCtx.getFromNamespace(SchemaNodeIdentifierBuildNamespace.class, node);
+ }
- return targetCtx;
+ public static boolean isUnknownNode(final StmtContext<?, ?, ?> stmtCtx) {
+ return stmtCtx.getPublicDefinition().getDeclaredRepresentationClass()
+ .isAssignableFrom(UnknownStatementImpl.class);
}
- public static SchemaPath getSchemaPath(StmtContext<?, ?, ?> ctx) {
+ public static Deviation.Deviate parseDeviateFromString(final String deviate) {
+
+ // Yang constants should be lowercase so we have throw if value does not
+ // suit this
+ String deviateUpper = deviate.toUpperCase();
+ Preconditions.checkArgument(!Objects.equals(deviate, deviateUpper),
+ "String %s is not valid deviate argument", deviate);
- Iterator<Object> argumentsIterator = ctx.getArgumentsFromRoot().iterator();
- argumentsIterator.next(); // skip root argument
+ // but Java enum is uppercase so we cannot use lowercase here
+ try {
+ return Deviation.Deviate.valueOf(deviateUpper);
+ } catch (IllegalArgumentException e) {
+ throw new IllegalArgumentException(String.format("String %s is not valid deviate argument", deviate), e);
+ }
+ }
- List<QName> qNamesFromRoot = new LinkedList<>();
+ public static Status parseStatus(final String value) {
+ switch (value) {
+ case "current":
+ return Status.CURRENT;
+ case "deprecated":
+ return Status.DEPRECATED;
+ case "obsolete":
+ return Status.OBSOLETE;
+ default:
+ LOG.warn("Invalid 'status' statement: {}", value);
+ return null;
+ }
+ }
- while (argumentsIterator.hasNext()) {
- Object argument = argumentsIterator.next();
- if (argument instanceof QName) {
- QName qname = (QName) argument;
- qNamesFromRoot.add(qname);
- } else {
- return SchemaPath.SAME;
+ public static Date getLatestRevision(final Iterable<? extends StmtContext<?, ?, ?>> subStmts) {
+ Date revision = null;
+ for (StmtContext<?, ?, ?> subStmt : subStmts) {
+ if (subStmt.getPublicDefinition().getDeclaredRepresentationClass().isAssignableFrom(RevisionStatement
+ .class)) {
+ if (revision == null && subStmt.getStatementArgument() != null) {
+ revision = (Date) subStmt.getStatementArgument();
+ } else if (subStmt.getStatementArgument() != null && ((Date) subStmt.getStatementArgument()).compareTo
+ (revision) > 0) {
+ revision = (Date) subStmt.getStatementArgument();
+ }
}
}
+ return revision;
+ }
- return SchemaPath.create(qNamesFromRoot, true);
+ public static boolean isModuleIdentifierWithoutSpecifiedRevision(final Object o) {
+ return (o instanceof ModuleIdentifier)
+ && (((ModuleIdentifier) o).getRevision() == SimpleDateFormatUtil.DEFAULT_DATE_IMP ||
+ ((ModuleIdentifier) o).getRevision() == SimpleDateFormatUtil.DEFAULT_BELONGS_TO_DATE);
}
}
Code Review / yangtools.git / blobdiff