2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.yangtools.yang.parser.stmt.rfc6020;
10 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.firstAttributeOf;
11 import com.google.common.base.CharMatcher;
12 import com.google.common.base.Preconditions;
13 import com.google.common.base.Splitter;
14 import com.google.common.base.Strings;
15 import com.google.common.collect.Iterables;
16 import java.util.ArrayList;
17 import java.util.Arrays;
18 import java.util.Collection;
19 import java.util.Date;
20 import java.util.HashSet;
21 import java.util.Iterator;
22 import java.util.LinkedList;
23 import java.util.List;
24 import java.util.Objects;
26 import java.util.regex.Pattern;
27 import javax.annotation.Nullable;
28 import javax.xml.xpath.XPath;
29 import javax.xml.xpath.XPathExpressionException;
30 import javax.xml.xpath.XPathFactory;
31 import org.antlr.v4.runtime.tree.TerminalNode;
32 import org.opendaylight.yangtools.antlrv4.code.gen.YangStatementParser;
33 import org.opendaylight.yangtools.yang.common.QName;
34 import org.opendaylight.yangtools.yang.common.QNameModule;
35 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
36 import org.opendaylight.yangtools.yang.common.YangConstants;
37 import org.opendaylight.yangtools.yang.model.api.Deviation;
38 import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
39 import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath;
40 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
41 import org.opendaylight.yangtools.yang.model.api.Status;
42 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement;
43 import org.opendaylight.yangtools.yang.model.api.stmt.BelongsToStatement;
44 import org.opendaylight.yangtools.yang.model.api.stmt.ChoiceStatement;
45 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleStatement;
46 import org.opendaylight.yangtools.yang.model.api.stmt.RefineStatement;
47 import org.opendaylight.yangtools.yang.model.api.stmt.RevisionStatement;
48 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
49 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Relative;
50 import org.opendaylight.yangtools.yang.model.api.stmt.SubmoduleStatement;
51 import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
52 import org.opendaylight.yangtools.yang.model.util.RevisionAwareXPathImpl;
53 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
54 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
55 import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToPrefixToModuleName;
56 import org.opendaylight.yangtools.yang.parser.spi.source.ImpPrefixToModuleIdentifier;
57 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName;
58 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleIdentifierToModuleQName;
59 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleNameToModuleQName;
60 import org.opendaylight.yangtools.yang.parser.spi.source.PrefixToModule;
61 import org.opendaylight.yangtools.yang.parser.spi.source.QNameToStatementDefinition;
62 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
63 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
64 import org.opendaylight.yangtools.yang.parser.stmt.reactor.RootStatementContext;
65 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
66 import org.slf4j.Logger;
67 import org.slf4j.LoggerFactory;
69 public final class Utils {
71 private static final Logger LOG = LoggerFactory.getLogger(Utils.class);
72 private static final CharMatcher DOUBLE_QUOTE_MATCHER = CharMatcher.is('"');
73 private static final CharMatcher SINGLE_QUOTE_MATCHER = CharMatcher.is('\'');
74 private static final Splitter SLASH_SPLITTER = Splitter.on('/').omitEmptyStrings().trimResults();
75 private static final Splitter SPACE_SPLITTER = Splitter.on(' ').omitEmptyStrings().trimResults();
76 private static final Pattern PATH_ABS = Pattern.compile("/[^/].*");
78 private static final ThreadLocal<XPathFactory> XPATH_FACTORY = new ThreadLocal<XPathFactory>() {
80 protected XPathFactory initialValue() {
81 return XPathFactory.newInstance();
86 throw new UnsupportedOperationException();
90 * Cleanup any resources attached to the current thread. Threads interacting with this class can cause thread-local
91 * caches to them. Invoke this method if you want to detach those resources.
93 public static void detachFromCurrentThread() {
94 XPATH_FACTORY.remove();
97 public static Collection<SchemaNodeIdentifier.Relative> transformKeysStringToKeyNodes(final StmtContext<?, ?, ?> ctx,
99 List<String> keyTokens = SPACE_SPLITTER.splitToList(value);
101 // to detect if key contains duplicates
102 if ((new HashSet<>(keyTokens)).size() < keyTokens.size()) {
103 // FIXME: report all duplicate keys
104 throw new IllegalArgumentException();
107 Set<SchemaNodeIdentifier.Relative> keyNodes = new HashSet<>();
109 for (String keyToken : keyTokens) {
111 SchemaNodeIdentifier.Relative keyNode = (Relative) SchemaNodeIdentifier.Relative.create(false,
112 Utils.qNameFromArgument(ctx, keyToken));
113 keyNodes.add(keyNode);
119 private static String trimSingleLastSlashFromXPath(final String path) {
120 return path.replaceAll("/$", "");
123 static RevisionAwareXPath parseXPath(final StmtContext<?, ?, ?> ctx, final String path) {
124 final XPath xPath = XPATH_FACTORY.get().newXPath();
126 final String trimmed = trimSingleLastSlashFromXPath(path);
128 // TODO: we could capture the result and expose its 'evaluate' method
129 xPath.compile(trimmed);
130 } catch (XPathExpressionException e) {
131 LOG.warn("Argument \"{}\" is not valid XPath string at \"{}\"", path, ctx.getStatementSourceReference(), e);
134 return new RevisionAwareXPathImpl(path, PATH_ABS.matcher(path).matches());
137 public static QName trimPrefix(final QName identifier) {
138 String prefixedLocalName = identifier.getLocalName();
139 String[] namesParts = prefixedLocalName.split(":");
141 if (namesParts.length == 2) {
142 String localName = namesParts[1];
143 return QName.create(identifier.getModule(), localName);
149 public static String getPrefixFromArgument(final String prefixedLocalName) {
150 String[] namesParts = prefixedLocalName.split(":");
151 if (namesParts.length == 2) {
152 return namesParts[0];
157 public static boolean isValidStatementDefinition(final PrefixToModule prefixes, final QNameToStatementDefinition stmtDef,
158 final QName identifier) {
159 if (stmtDef.get(identifier) != null) {
162 String prefixedLocalName = identifier.getLocalName();
163 String[] namesParts = prefixedLocalName.split(":");
165 if (namesParts.length == 2) {
166 String prefix = namesParts[0];
167 String localName = namesParts[1];
168 if (prefixes != null && prefixes.get(prefix) != null
169 && stmtDef.get(QName.create(YangConstants.RFC6020_YIN_MODULE, localName)) != null) {
172 if (stmtDef.get(QName.create(YangConstants.RFC6020_YIN_MODULE, localName)) != null) {
181 static SchemaNodeIdentifier nodeIdentifierFromPath(final StmtContext<?, ?, ?> ctx, final String path) {
182 // FIXME: is the path trimming really necessary??
183 final List<QName> qNames = new ArrayList<>();
184 for (String nodeName : SLASH_SPLITTER.split(trimSingleLastSlashFromXPath(path))) {
186 final QName qName = Utils.qNameFromArgument(ctx, nodeName);
188 } catch (Exception e) {
189 throw new IllegalArgumentException(
190 String.format("Failed to parse node '%s' in path '%s'", nodeName, path), e);
194 return SchemaNodeIdentifier.create(qNames, PATH_ABS.matcher(path).matches());
197 public static String stringFromStringContext(final YangStatementParser.ArgumentContext context) {
198 StringBuilder sb = new StringBuilder();
199 List<TerminalNode> strings = context.STRING();
200 if (strings.isEmpty()) {
201 strings = Arrays.asList(context.IDENTIFIER());
203 for (TerminalNode stringNode : strings) {
204 final String str = stringNode.getText();
205 char firstChar = str.charAt(0);
206 final CharMatcher quoteMatcher;
207 if (SINGLE_QUOTE_MATCHER.matches(firstChar)) {
208 quoteMatcher = SINGLE_QUOTE_MATCHER;
209 } else if (DOUBLE_QUOTE_MATCHER.matches(firstChar)) {
210 quoteMatcher = DOUBLE_QUOTE_MATCHER;
215 sb.append(quoteMatcher.removeFrom(str.substring(1, str.length() - 1)));
217 return sb.toString();
220 public static QName qNameFromArgument(StmtContext<?, ?, ?> ctx, final String value) {
221 if (Strings.isNullOrEmpty(value)) {
222 return ctx.getPublicDefinition().getStatementName();
226 QNameModule qNameModule = null;
227 String localName = null;
229 String[] namesParts = value.split(":");
230 switch (namesParts.length) {
232 localName = namesParts[0];
233 qNameModule = getRootModuleQName(ctx);
236 prefix = namesParts[0];
237 localName = namesParts[1];
238 qNameModule = getModuleQNameByPrefix(ctx, prefix);
239 // in case of unknown statement argument, we're not going to parse it
240 if (qNameModule == null
241 && ctx.getPublicDefinition().getDeclaredRepresentationClass()
242 .isAssignableFrom(UnknownStatementImpl.class)) {
244 qNameModule = getRootModuleQName(ctx);
246 if (qNameModule == null
247 && Iterables.getLast(ctx.getCopyHistory()) == StmtContext.TypeOfCopy.ADDED_BY_AUGMENTATION) {
248 ctx = ctx.getOriginalCtx();
249 qNameModule = getModuleQNameByPrefix(ctx, prefix);
254 Preconditions.checkArgument(qNameModule != null, "Error in module '%s': can not resolve QNameModule for '%s'.",
255 ctx.getRoot().rawStatementArgument(), value);
257 QNameModule resultQNameModule = qNameModule.getRevision() == null ? QNameModule.create(
258 qNameModule.getNamespace(), SimpleDateFormatUtil.DEFAULT_DATE_REV) : qNameModule;
260 return QName.create(resultQNameModule, localName);
263 public static QNameModule getModuleQNameByPrefix(final StmtContext<?, ?, ?> ctx, final String prefix) {
264 QNameModule qNameModule;
265 ModuleIdentifier impModIdentifier = ctx.getRoot().getFromNamespace(ImpPrefixToModuleIdentifier.class, prefix);
266 qNameModule = ctx.getFromNamespace(ModuleIdentifierToModuleQName.class, impModIdentifier);
268 if (qNameModule == null && StmtContextUtils.producesDeclared(ctx.getRoot(), SubmoduleStatement.class)) {
269 String moduleName = ctx.getRoot().getFromNamespace(BelongsToPrefixToModuleName.class, prefix);
270 qNameModule = ctx.getFromNamespace(ModuleNameToModuleQName.class, moduleName);
275 public static QNameModule getRootModuleQName(final StmtContext<?, ?, ?> ctx) {
281 StmtContext<?, ?, ?> rootCtx = ctx.getRoot();
282 QNameModule qNameModule = null;
284 if (StmtContextUtils.producesDeclared(rootCtx, ModuleStatement.class)) {
285 qNameModule = rootCtx.getFromNamespace(ModuleCtxToModuleQName.class, rootCtx);
286 } else if (StmtContextUtils.producesDeclared(rootCtx, SubmoduleStatement.class)) {
287 String belongsToModuleName = firstAttributeOf(rootCtx.substatements(),
288 BelongsToStatement.class);
289 qNameModule = rootCtx.getFromNamespace(ModuleNameToModuleQName.class, belongsToModuleName);
292 return qNameModule.getRevision() == null ? QNameModule.create(qNameModule.getNamespace(),
293 SimpleDateFormatUtil.DEFAULT_DATE_REV) : qNameModule;
297 public static StatementContextBase<?, ?, ?> findNode(final StmtContext<?, ?, ?> rootStmtCtx,
298 final SchemaNodeIdentifier node) {
299 return (StatementContextBase<?, ?, ?>) rootStmtCtx.getFromNamespace(SchemaNodeIdentifierBuildNamespace.class, node);
302 public static SchemaPath getSchemaPath(final StmtContext<?, ?, ?> ctx) {
308 final Iterator<StmtContext<?, ?, ?>> iteratorFromRoot = ctx.getStmtContextsFromRoot().iterator();
309 // skip root argument
310 if (iteratorFromRoot.hasNext()) {
311 iteratorFromRoot.next();
314 List<QName> qNamesFromRoot = new LinkedList<>();
315 while (iteratorFromRoot.hasNext()) {
316 StmtContext<?, ?, ?> nextStmtCtx = iteratorFromRoot.next();
317 Object nextStmtArgument = nextStmtCtx.getStatementArgument();
318 if (nextStmtArgument instanceof QName) {
319 QName qname = (QName) nextStmtArgument;
320 if (StmtContextUtils.producesDeclared(nextStmtCtx, UsesStatement.class)) {
323 if (StmtContextUtils.producesDeclared(nextStmtCtx.getParentContext(), ChoiceStatement.class)
324 && isSupportedAsShorthandCase(nextStmtCtx)) {
325 qNamesFromRoot.add(qname);
327 qNamesFromRoot.add(qname);
328 } else if (nextStmtArgument instanceof String) {
329 // FIXME: This may yield illegal argument exceptions
330 StatementContextBase<?, ?, ?> originalCtx = ctx
332 final QName qName = (originalCtx != null) ? qNameFromArgument(
333 originalCtx, (String) nextStmtArgument)
334 : qNameFromArgument(ctx, (String) nextStmtArgument);
335 qNamesFromRoot.add(qName);
336 } else if ((StmtContextUtils.producesDeclared(nextStmtCtx, AugmentStatement.class)
337 || StmtContextUtils.producesDeclared(nextStmtCtx, RefineStatement.class))
338 && nextStmtArgument instanceof SchemaNodeIdentifier) {
339 addQNamesFromSchemaNodeIdentifierToList(qNamesFromRoot, (SchemaNodeIdentifier) nextStmtArgument);
340 } else if (isUnknownNode(nextStmtCtx)) {
341 qNamesFromRoot.add(nextStmtCtx.getPublicDefinition().getStatementName());
343 return SchemaPath.SAME;
347 final SchemaPath schemaPath = SchemaPath.create(qNamesFromRoot, true);
351 public static boolean isUnknownNode(final StmtContext<?, ?, ?> stmtCtx) {
352 return stmtCtx.getPublicDefinition().getDeclaredRepresentationClass()
353 .isAssignableFrom(UnknownStatementImpl.class);
356 private static boolean isSupportedAsShorthandCase(final StmtContext<?, ?, ?> statementCtx) {
358 Collection<?> supportedCaseShorthands = statementCtx.getFromNamespace(ValidationBundlesNamespace.class,
359 ValidationBundleType.SUPPORTED_CASE_SHORTHANDS);
361 return supportedCaseShorthands == null || supportedCaseShorthands.contains(statementCtx.getPublicDefinition());
364 private static void addQNamesFromSchemaNodeIdentifierToList(final List<QName> qNamesFromRoot,
365 final SchemaNodeIdentifier augmentTargetPath) {
366 for (QName qname : augmentTargetPath.getPathFromRoot()) {
367 qNamesFromRoot.add(qname);
371 public static Deviation.Deviate parseDeviateFromString(final String deviate) {
373 // Yang constants should be lowercase so we have throw if value does not
375 String deviateUpper = deviate.toUpperCase();
376 Preconditions.checkArgument(!Objects.equals(deviate, deviateUpper),
377 "String %s is not valid deviate argument", deviate);
379 // but Java enum is uppercase so we cannot use lowercase here
381 return Deviation.Deviate.valueOf(deviateUpper);
382 } catch (IllegalArgumentException e) {
383 throw new IllegalArgumentException(String.format("String %s is not valid deviate argument", deviate), e);
387 public static Status parseStatus(final String value) {
389 Status status = null;
392 status = Status.CURRENT;
395 status = Status.DEPRECATED;
398 status = Status.OBSOLETE;
401 LOG.warn("Invalid 'status' statement: " + value);
407 public static Date getLatestRevision(final RootStatementContext<?, ?, ?> root) {
408 return getLatestRevision(root.declaredSubstatements());
411 public static Date getLatestRevision(final Iterable<? extends StmtContext<?, ?, ?>> subStmts) {
412 Date revision = null;
413 for (StmtContext<?, ?, ?> subStmt : subStmts) {
414 if (subStmt.getPublicDefinition().getDeclaredRepresentationClass().isAssignableFrom(RevisionStatement
416 if (revision == null && subStmt.getStatementArgument() != null) {
417 revision = (Date) subStmt.getStatementArgument();
418 } else if (subStmt.getStatementArgument() != null && ((Date) subStmt.getStatementArgument()).compareTo
420 revision = (Date) subStmt.getStatementArgument();
427 public static boolean isModuleIdentifierWithoutSpecifiedRevision(final Object o) {
428 return (o instanceof ModuleIdentifier)
429 && (((ModuleIdentifier) o).getRevision() == SimpleDateFormatUtil.DEFAULT_DATE_IMP ||
430 ((ModuleIdentifier) o).getRevision() == SimpleDateFormatUtil.DEFAULT_BELONGS_TO_DATE);