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.ImmutableMap;
16 import com.google.common.collect.ImmutableMap.Builder;
17 import com.google.common.collect.Iterables;
18 import java.util.ArrayList;
19 import java.util.Arrays;
20 import java.util.Collection;
21 import java.util.Date;
22 import java.util.HashSet;
23 import java.util.List;
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.model.api.Deviation;
37 import org.opendaylight.yangtools.yang.model.api.Deviation.Deviate;
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.Status;
41 import org.opendaylight.yangtools.yang.model.api.stmt.BelongsToStatement;
42 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleStatement;
43 import org.opendaylight.yangtools.yang.model.api.stmt.RevisionStatement;
44 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
45 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Relative;
46 import org.opendaylight.yangtools.yang.model.api.stmt.SubmoduleStatement;
47 import org.opendaylight.yangtools.yang.model.util.RevisionAwareXPathImpl;
48 import org.opendaylight.yangtools.yang.parser.spi.meta.QNameCacheNamespace;
49 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
50 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
51 import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToPrefixToModuleName;
52 import org.opendaylight.yangtools.yang.parser.spi.source.ImpPrefixToModuleIdentifier;
53 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName;
54 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleIdentifierToModuleQName;
55 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleNameToModuleQName;
56 import org.opendaylight.yangtools.yang.parser.spi.source.PrefixToModule;
57 import org.opendaylight.yangtools.yang.parser.spi.source.QNameToStatementDefinition;
58 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
59 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
60 import org.slf4j.Logger;
61 import org.slf4j.LoggerFactory;
63 public final class Utils {
64 private static final Logger LOG = LoggerFactory.getLogger(Utils.class);
65 private static final CharMatcher DOUBLE_QUOTE_MATCHER = CharMatcher.is('"');
66 private static final CharMatcher SINGLE_QUOTE_MATCHER = CharMatcher.is('\'');
67 private static final CharMatcher LEFT_PARENTHESIS_MATCHER = CharMatcher.is('(');
68 private static final CharMatcher RIGHT_PARENTHESIS_MATCHER = CharMatcher.is(')');
69 private static final CharMatcher AMPERSAND_MATCHER = CharMatcher.is('&');
70 private static final CharMatcher QUESTION_MARK_MATCHER = CharMatcher.is('?');
71 private static final Splitter SLASH_SPLITTER = Splitter.on('/').omitEmptyStrings().trimResults();
72 private static final Splitter SPACE_SPLITTER = Splitter.on(' ').omitEmptyStrings().trimResults();
73 private static final Pattern PATH_ABS = Pattern.compile("/[^/].*");
75 private static final Map<String, Deviate> KEYWORD_TO_DEVIATE_MAP;
77 Builder<String, Deviate> keywordToDeviateMapBuilder = ImmutableMap.builder();
78 for (Deviate deviate : Deviation.Deviate.values()) {
79 keywordToDeviateMapBuilder.put(deviate.getKeyword(), deviate);
81 KEYWORD_TO_DEVIATE_MAP = keywordToDeviateMapBuilder.build();
84 private static final ThreadLocal<XPathFactory> XPATH_FACTORY = new ThreadLocal<XPathFactory>() {
86 protected XPathFactory initialValue() {
87 return XPathFactory.newInstance();
92 throw new UnsupportedOperationException();
96 * Cleanup any resources attached to the current thread. Threads interacting with this class can cause thread-local
97 * caches to them. Invoke this method if you want to detach those resources.
99 public static void detachFromCurrentThread() {
100 XPATH_FACTORY.remove();
103 public static Collection<SchemaNodeIdentifier.Relative> transformKeysStringToKeyNodes(final StmtContext<?, ?, ?> ctx,
104 final String value) {
105 List<String> keyTokens = SPACE_SPLITTER.splitToList(value);
107 // to detect if key contains duplicates
108 if ((new HashSet<>(keyTokens)).size() < keyTokens.size()) {
109 // FIXME: report all duplicate keys
110 throw new SourceException(String.format("Duplicate value in list key: %s", value),
111 ctx.getStatementSourceReference());
114 Set<SchemaNodeIdentifier.Relative> keyNodes = new HashSet<>();
116 for (String keyToken : keyTokens) {
118 SchemaNodeIdentifier.Relative keyNode = (Relative) SchemaNodeIdentifier.Relative.create(false,
119 Utils.qNameFromArgument(ctx, keyToken));
120 keyNodes.add(keyNode);
126 private static String trimSingleLastSlashFromXPath(final String path) {
127 return path.endsWith("/") ? path.substring(0, path.length() - 1) : path;
130 static RevisionAwareXPath parseXPath(final StmtContext<?, ?, ?> ctx, final String path) {
131 final XPath xPath = XPATH_FACTORY.get().newXPath();
132 xPath.setNamespaceContext(StmtNamespaceContext.create(ctx));
134 final String trimmed = trimSingleLastSlashFromXPath(path);
136 // TODO: we could capture the result and expose its 'evaluate' method
137 xPath.compile(trimmed);
138 } catch (XPathExpressionException e) {
139 LOG.warn("Argument \"{}\" is not valid XPath string at \"{}\"", path, ctx.getStatementSourceReference(), e);
142 return new RevisionAwareXPathImpl(path, PATH_ABS.matcher(path).matches());
145 public static QName trimPrefix(final QName identifier) {
146 String prefixedLocalName = identifier.getLocalName();
147 String[] namesParts = prefixedLocalName.split(":");
149 if (namesParts.length == 2) {
150 String localName = namesParts[1];
151 return QName.create(identifier.getModule(), localName);
159 * Based on identifier read from source and collections of relevant prefixes and statement definitions mappings
160 * provided for actual phase, method resolves and returns valid QName for declared statement to be written.
161 * This applies to any declared statement, including unknown statements.
163 * @param prefixes - collection of all relevant prefix mappings supplied for actual parsing phase
164 * @param stmtDef - collection of all relevant statement definition mappings provided for actual parsing phase
165 * @param identifier - statement to parse from source
166 * @return valid QName for declared statement to be written
169 public static QName getValidStatementDefinition(final PrefixToModule prefixes, final QNameToStatementDefinition
170 stmtDef, final QName identifier) {
171 if (stmtDef.get(identifier) != null) {
172 return stmtDef.get(identifier).getStatementName();
174 String prefixedLocalName = identifier.getLocalName();
175 String[] namesParts = prefixedLocalName.split(":");
177 if (namesParts.length == 2) {
178 String prefix = namesParts[0];
179 String localName = namesParts[1];
180 if (prefixes != null && prefixes.get(prefix) != null
181 && stmtDef.get(QName.create(prefixes.get(prefix), localName)) != null) {
182 return QName.create(prefixes.get(prefix), localName);
189 static SchemaNodeIdentifier nodeIdentifierFromPath(final StmtContext<?, ?, ?> ctx, final String path) {
190 // FIXME: is the path trimming really necessary??
191 final List<QName> qNames = new ArrayList<>();
192 for (String nodeName : SLASH_SPLITTER.split(trimSingleLastSlashFromXPath(path))) {
194 final QName qName = Utils.qNameFromArgument(ctx, nodeName);
196 } catch (Exception e) {
197 throw new IllegalArgumentException(
198 String.format("Failed to parse node '%s' in path '%s'", nodeName, path), e);
202 return SchemaNodeIdentifier.create(qNames, PATH_ABS.matcher(path).matches());
205 public static String stringFromStringContext(final YangStatementParser.ArgumentContext context) {
206 StringBuilder sb = new StringBuilder();
207 List<TerminalNode> strings = context.STRING();
208 if (strings.isEmpty()) {
209 strings = Arrays.asList(context.IDENTIFIER());
211 for (TerminalNode stringNode : strings) {
212 final String str = stringNode.getText();
213 char firstChar = str.charAt(0);
214 final CharMatcher quoteMatcher;
215 if (SINGLE_QUOTE_MATCHER.matches(firstChar)) {
216 quoteMatcher = SINGLE_QUOTE_MATCHER;
217 } else if (DOUBLE_QUOTE_MATCHER.matches(firstChar)) {
218 quoteMatcher = DOUBLE_QUOTE_MATCHER;
223 sb.append(quoteMatcher.removeFrom(str.substring(1, str.length() - 1)));
225 return sb.toString();
228 public static QName qNameFromArgument(StmtContext<?, ?, ?> ctx, final String value) {
229 if (Strings.isNullOrEmpty(value)) {
230 return ctx.getPublicDefinition().getStatementName();
234 QNameModule qNameModule = null;
235 String localName = null;
237 String[] namesParts = value.split(":");
238 switch (namesParts.length) {
240 localName = namesParts[0];
241 qNameModule = getRootModuleQName(ctx);
244 prefix = namesParts[0];
245 localName = namesParts[1];
246 qNameModule = getModuleQNameByPrefix(ctx, prefix);
247 // in case of unknown statement argument, we're not going to parse it
248 if (qNameModule == null
249 && ctx.getPublicDefinition().getDeclaredRepresentationClass()
250 .isAssignableFrom(UnknownStatementImpl.class)) {
252 qNameModule = getRootModuleQName(ctx);
254 if (qNameModule == null
255 && Iterables.getLast(ctx.getCopyHistory()) == StmtContext.TypeOfCopy.ADDED_BY_AUGMENTATION) {
256 ctx = ctx.getOriginalCtx();
257 qNameModule = getModuleQNameByPrefix(ctx, prefix);
262 Preconditions.checkArgument(qNameModule != null,
263 "Error in module '%s': can not resolve QNameModule for '%s'. Statement source at %s",
264 ctx.getRoot().rawStatementArgument(), value, ctx.getStatementSourceReference());
265 final QNameModule resultQNameModule;
266 if (qNameModule.getRevision() == null) {
267 resultQNameModule = QNameModule.create(qNameModule.getNamespace(), SimpleDateFormatUtil.DEFAULT_DATE_REV)
270 resultQNameModule = qNameModule;
273 return ctx.getFromNamespace(QNameCacheNamespace.class, QName.create(resultQNameModule, localName));
276 public static QNameModule getModuleQNameByPrefix(final StmtContext<?, ?, ?> ctx, final String prefix) {
277 final ModuleIdentifier modId = ctx.getRoot().getFromNamespace(ImpPrefixToModuleIdentifier.class, prefix);
278 final QNameModule qNameModule = ctx.getFromNamespace(ModuleIdentifierToModuleQName.class, modId);
280 if (qNameModule == null && StmtContextUtils.producesDeclared(ctx.getRoot(), SubmoduleStatement.class)) {
281 String moduleName = ctx.getRoot().getFromNamespace(BelongsToPrefixToModuleName.class, prefix);
282 return ctx.getFromNamespace(ModuleNameToModuleQName.class, moduleName);
287 public static QNameModule getRootModuleQName(final StmtContext<?, ?, ?> ctx) {
292 final StmtContext<?, ?, ?> rootCtx = ctx.getRoot();
293 final QNameModule qNameModule;
295 if (StmtContextUtils.producesDeclared(rootCtx, ModuleStatement.class)) {
296 qNameModule = rootCtx.getFromNamespace(ModuleCtxToModuleQName.class, rootCtx);
297 } else if (StmtContextUtils.producesDeclared(rootCtx, SubmoduleStatement.class)) {
298 final String belongsToModuleName = firstAttributeOf(rootCtx.substatements(), BelongsToStatement.class);
299 qNameModule = rootCtx.getFromNamespace(ModuleNameToModuleQName.class, belongsToModuleName);
304 Preconditions.checkArgument(qNameModule != null, "Failed to look up root QNameModule for %s", ctx);
305 if (qNameModule.getRevision() != null) {
309 return QNameModule.create(qNameModule.getNamespace(), SimpleDateFormatUtil.DEFAULT_DATE_REV).intern();
313 public static StatementContextBase<?, ?, ?> findNode(final StmtContext<?, ?, ?> rootStmtCtx,
314 final SchemaNodeIdentifier node) {
315 return (StatementContextBase<?, ?, ?>) rootStmtCtx.getFromNamespace(SchemaNodeIdentifierBuildNamespace.class, node);
318 public static boolean isUnknownNode(final StmtContext<?, ?, ?> stmtCtx) {
319 return stmtCtx.getPublicDefinition().getDeclaredRepresentationClass()
320 .isAssignableFrom(UnknownStatementImpl.class);
323 public static Deviation.Deviate parseDeviateFromString(final StmtContext<?, ?, ?> ctx, final String deviateKeyword) {
324 return Preconditions.checkNotNull(KEYWORD_TO_DEVIATE_MAP.get(deviateKeyword),
325 "String '%s' is not valid deviate argument. Statement source at %s", deviateKeyword,
326 ctx.getStatementSourceReference());
329 public static Status parseStatus(final String value) {
332 return Status.CURRENT;
334 return Status.DEPRECATED;
336 return Status.OBSOLETE;
338 LOG.warn("Invalid 'status' statement: {}", value);
343 public static Date getLatestRevision(final Iterable<? extends StmtContext<?, ?, ?>> subStmts) {
344 Date revision = null;
345 for (StmtContext<?, ?, ?> subStmt : subStmts) {
346 if (subStmt.getPublicDefinition().getDeclaredRepresentationClass().isAssignableFrom(RevisionStatement
348 if (revision == null && subStmt.getStatementArgument() != null) {
349 revision = (Date) subStmt.getStatementArgument();
350 } else if (subStmt.getStatementArgument() != null && ((Date) subStmt.getStatementArgument()).compareTo
352 revision = (Date) subStmt.getStatementArgument();
359 public static boolean isModuleIdentifierWithoutSpecifiedRevision(final Object o) {
360 return (o instanceof ModuleIdentifier)
361 && (((ModuleIdentifier) o).getRevision() == SimpleDateFormatUtil.DEFAULT_DATE_IMP || ((ModuleIdentifier) o)
362 .getRevision() == SimpleDateFormatUtil.DEFAULT_BELONGS_TO_DATE);
366 * Replaces illegal characters of QName by the name of the character (e.g.
367 * '?' is replaced by "QuestionMark" etc.).
371 * @return result String
373 public static String replaceIllegalCharsForQName(String string) {
374 string = LEFT_PARENTHESIS_MATCHER.replaceFrom(string, "LeftParenthesis");
375 string = RIGHT_PARENTHESIS_MATCHER.replaceFrom(string, "RightParenthesis");
376 string = AMPERSAND_MATCHER.replaceFrom(string, "Ampersand");
377 string = QUESTION_MARK_MATCHER.replaceFrom(string, "QuestionMark");