yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/Utils.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.yangtools.yang.parser.stmt.rfc6020;
   9
  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;
  25 import java.util.Set;
  26 import java.util.regex.Pattern;
  27 import javax.annotation.Nullable;
  28 import javax.xml.xpath.XPath;
  29 import javax.xml.xpath.XPathExpression;
  30 import javax.xml.xpath.XPathExpressionException;
  31 import javax.xml.xpath.XPathFactory;
  32 import org.antlr.v4.runtime.tree.TerminalNode;
  33 import org.opendaylight.yangtools.antlrv4.code.gen.YangStatementParser;
  34 import org.opendaylight.yangtools.yang.common.QName;
  35 import org.opendaylight.yangtools.yang.common.QNameModule;
  36 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
  37 import org.opendaylight.yangtools.yang.common.YangConstants;
  38 import org.opendaylight.yangtools.yang.model.api.Deviation;
  39 import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
  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.parser.spi.meta.StmtContext;
  53 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  54 import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToPrefixToModuleName;
  55 import org.opendaylight.yangtools.yang.parser.spi.source.ImpPrefixToModuleIdentifier;
  56 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName;
  57 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleIdentifierToModuleQName;
  58 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleNameToModuleQName;
  59 import org.opendaylight.yangtools.yang.parser.spi.source.PrefixToModule;
  60 import org.opendaylight.yangtools.yang.parser.spi.source.QNameToStatementDefinition;
  61 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
  62 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
  63 import org.opendaylight.yangtools.yang.parser.stmt.reactor.RootStatementContext;
  64 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
  65 import org.slf4j.Logger;
  66 import org.slf4j.LoggerFactory;
  67
  68 public final class Utils {
  69
  70     private static final Logger LOG = LoggerFactory.getLogger(Utils.class);
  71     private static final CharMatcher DOUBLE_QUOTE_MATCHER = CharMatcher.is('"');
  72     private static final CharMatcher SINGLE_QUOTE_MATCHER = CharMatcher.is('\'');
  73     private static final Splitter SLASH_SPLITTER = Splitter.on('/').omitEmptyStrings().trimResults();
  74     private static final Splitter SPACE_SPLITTER = Splitter.on(' ').omitEmptyStrings().trimResults();
  75     private static final Pattern PATH_ABS = Pattern.compile("/[^/].*");
  76
  77     private static final ThreadLocal<XPathFactory> XPATH_FACTORY = new ThreadLocal<XPathFactory>() {
  78         @Override
  79         protected XPathFactory initialValue() {
  80             return XPathFactory.newInstance();
  81         }
  82     };
  83
  84     private Utils() {
  85         throw new UnsupportedOperationException();
  86     }
  87
  88     /**
  89      * Cleanup any resources attached to the current thread. Threads interacting with this class can cause thread-local
  90      * caches to them. Invoke this method if you want to detach those resources.
  91      */
  92     public static void detachFromCurrentThread() {
  93         XPATH_FACTORY.remove();
  94     }
  95
  96     public static Collection<SchemaNodeIdentifier.Relative> transformKeysStringToKeyNodes(final StmtContext<?, ?, ?> ctx,
  97             final String value) {
  98         List<String> keyTokens = SPACE_SPLITTER.splitToList(value);
  99
 100         // to detect if key contains duplicates
 101         if ((new HashSet<>(keyTokens)).size() < keyTokens.size()) {
 102             // FIXME: report all duplicate keys
 103             throw new IllegalArgumentException();
 104         }
 105
 106         Set<SchemaNodeIdentifier.Relative> keyNodes = new HashSet<>();
 107
 108         for (String keyToken : keyTokens) {
 109
 110             SchemaNodeIdentifier.Relative keyNode = (Relative) SchemaNodeIdentifier.Relative.create(false,
 111                     Utils.qNameFromArgument(ctx, keyToken));
 112             keyNodes.add(keyNode);
 113         }
 114
 115         return keyNodes;
 116     }
 117
 118     public static List<String> splitPathToNodeNames(final String path) {
 119         return SLASH_SPLITTER.splitToList(path);
 120     }
 121
 122     private static void compileXPath(final StmtContext<?, ?, ?> ctx, final String path) {
 123         final XPath xPath = XPATH_FACTORY.get().newXPath();
 124
 125         try {
 126             xPath.compile(path);
 127         } catch (XPathExpressionException e) {
 128             LOG.warn("Argument {} is not valid XPath string at {}", path, ctx.getStatementSourceReference(), e);
 129         }
 130     }
 131
 132     private static String trimSingleLastSlashFromXPath(final String path) {
 133         return path.replaceAll("/$", "");
 134     }
 135
 136     public static boolean isXPathAbsolute(final StmtContext<?, ?, ?> ctx, final String path) {
 137         // FIXME: this is probably an overkill, as this is called for all XPath objects. If we need this validation,
 138         //        we should wrap the resulting XPath into RevisionAwareXPath.
 139         compileXPath(ctx, trimSingleLastSlashFromXPath(path));
 140
 141         return PATH_ABS.matcher(path).matches();
 142     }
 143
 144     public static QName trimPrefix(final QName identifier) {
 145         String prefixedLocalName = identifier.getLocalName();
 146         String[] namesParts = prefixedLocalName.split(":");
 147
 148         if (namesParts.length == 2) {
 149             String localName = namesParts[1];
 150             return QName.create(identifier.getModule(), localName);
 151         }
 152
 153         return identifier;
 154     }
 155
 156     public static String getPrefixFromArgument(final String prefixedLocalName) {
 157         String[] namesParts = prefixedLocalName.split(":");
 158         if (namesParts.length == 2) {
 159             return namesParts[0];
 160         }
 161         return null;
 162     }
 163
 164     public static boolean isValidStatementDefinition(final PrefixToModule prefixes, final QNameToStatementDefinition stmtDef,
 165             final QName identifier) {
 166         if (stmtDef.get(identifier) != null) {
 167             return true;
 168         } else {
 169             String prefixedLocalName = identifier.getLocalName();
 170             String[] namesParts = prefixedLocalName.split(":");
 171
 172             if (namesParts.length == 2) {
 173                 String prefix = namesParts[0];
 174                 String localName = namesParts[1];
 175                 if (prefixes != null && prefixes.get(prefix) != null
 176                         && stmtDef.get(QName.create(YangConstants.RFC6020_YIN_MODULE, localName)) != null) {
 177                     return true;
 178                 } else {
 179                     if (stmtDef.get(QName.create(YangConstants.RFC6020_YIN_MODULE, localName)) != null) {
 180                         return true;
 181                     }
 182                 }
 183             }
 184         }
 185         return false;
 186     }
 187
 188     public static Iterable<QName> parseXPath(final StmtContext<?, ?, ?> ctx, final String path) {
 189
 190         String trimmedPath = trimSingleLastSlashFromXPath(path);
 191
 192         compileXPath(ctx, trimmedPath);
 193
 194         List<String> nodeNames = splitPathToNodeNames(trimmedPath);
 195         List<QName> qNames = new ArrayList<>(nodeNames.size());
 196
 197         for (String nodeName : nodeNames) {
 198             try {
 199                 final QName qName = Utils.qNameFromArgument(ctx, nodeName);
 200                 qNames.add(qName);
 201             } catch (Exception e) {
 202                 throw new IllegalArgumentException(e);
 203             }
 204         }
 205
 206         return qNames;
 207     }
 208
 209     public static String stringFromStringContext(final YangStatementParser.ArgumentContext context) {
 210         StringBuilder sb = new StringBuilder();
 211         List<TerminalNode> strings = context.STRING();
 212         if (strings.isEmpty()) {
 213             strings = Arrays.asList(context.IDENTIFIER());
 214         }
 215         for (TerminalNode stringNode : strings) {
 216             final String str = stringNode.getText();
 217             char firstChar = str.charAt(0);
 218             final CharMatcher quoteMatcher;
 219             if (SINGLE_QUOTE_MATCHER.matches(firstChar)) {
 220                 quoteMatcher = SINGLE_QUOTE_MATCHER;
 221             } else if (DOUBLE_QUOTE_MATCHER.matches(firstChar)) {
 222                 quoteMatcher = DOUBLE_QUOTE_MATCHER;
 223             } else {
 224                 sb.append(str);
 225                 continue;
 226             }
 227             sb.append(quoteMatcher.removeFrom(str.substring(1, str.length() - 1)));
 228         }
 229         return sb.toString();
 230     }
 231
 232     public static QName qNameFromArgument(StmtContext<?, ?, ?> ctx, final String value) {
 233         if (Strings.isNullOrEmpty(value)) {
 234             return ctx.getPublicDefinition().getStatementName();
 235         }
 236
 237         String prefix;
 238         QNameModule qNameModule = null;
 239         String localName = null;
 240
 241         String[] namesParts = value.split(":");
 242         switch (namesParts.length) {
 243         case 1:
 244             localName = namesParts[0];
 245             qNameModule = getRootModuleQName(ctx);
 246             break;
 247         default:
 248             prefix = namesParts[0];
 249             localName = namesParts[1];
 250             qNameModule = getModuleQNameByPrefix(ctx, prefix);
 251             // in case of unknown statement argument, we're not going to parse it
 252             if (qNameModule == null
 253                     && ctx.getPublicDefinition().getDeclaredRepresentationClass()
 254                     .isAssignableFrom(UnknownStatementImpl.class)) {
 255                 localName = value;
 256                 qNameModule = getRootModuleQName(ctx);
 257             }
 258             if (qNameModule == null
 259                     && Iterables.getLast(ctx.getCopyHistory()) == StmtContext.TypeOfCopy.ADDED_BY_AUGMENTATION) {
 260                 ctx = ctx.getOriginalCtx();
 261                 qNameModule = getModuleQNameByPrefix(ctx, prefix);
 262             }
 263             break;
 264         }
 265
 266         Preconditions.checkArgument(qNameModule != null, "Error in module '%s': can not resolve QNameModule for '%s'.",
 267                 ctx.getRoot().rawStatementArgument(), value);
 268
 269         QNameModule resultQNameModule = qNameModule.getRevision() == null ? QNameModule.create(
 270                 qNameModule.getNamespace(), SimpleDateFormatUtil.DEFAULT_DATE_REV) : qNameModule;
 271
 272         return QName.create(resultQNameModule, localName);
 273     }
 274
 275     public static QNameModule getModuleQNameByPrefix(final StmtContext<?, ?, ?> ctx, final String prefix) {
 276         QNameModule qNameModule;
 277         ModuleIdentifier impModIdentifier = ctx.getRoot().getFromNamespace(ImpPrefixToModuleIdentifier.class, prefix);
 278         qNameModule = ctx.getFromNamespace(ModuleIdentifierToModuleQName.class, impModIdentifier);
 279
 280         if (qNameModule == null && StmtContextUtils.producesDeclared(ctx.getRoot(), SubmoduleStatement.class)) {
 281             String moduleName = ctx.getRoot().getFromNamespace(BelongsToPrefixToModuleName.class, prefix);
 282             qNameModule = ctx.getFromNamespace(ModuleNameToModuleQName.class, moduleName);
 283         }
 284         return qNameModule;
 285     }
 286
 287     public static QNameModule getRootModuleQName(final StmtContext<?, ?, ?> ctx) {
 288
 289         if (ctx == null) {
 290             return null;
 291         }
 292
 293         StmtContext<?, ?, ?> rootCtx = ctx.getRoot();
 294         QNameModule qNameModule = null;
 295
 296         if (StmtContextUtils.producesDeclared(rootCtx, ModuleStatement.class)) {
 297             qNameModule = rootCtx.getFromNamespace(ModuleCtxToModuleQName.class, rootCtx);
 298         } else if (StmtContextUtils.producesDeclared(rootCtx, SubmoduleStatement.class)) {
 299             String belongsToModuleName = firstAttributeOf(rootCtx.substatements(),
 300                     BelongsToStatement.class);
 301             qNameModule = rootCtx.getFromNamespace(ModuleNameToModuleQName.class, belongsToModuleName);
 302         }
 303
 304         return qNameModule.getRevision() == null ? QNameModule.create(qNameModule.getNamespace(),
 305                 SimpleDateFormatUtil.DEFAULT_DATE_REV) : qNameModule;
 306     }
 307
 308     @Nullable
 309     public static StatementContextBase<?, ?, ?> findNode(final StatementContextBase<?, ?, ?> rootStmtCtx,
 310             final SchemaNodeIdentifier node) {
 311         StatementContextBase<?, ?, ?> current = rootStmtCtx;
 312         Iterator<QName> arguments = node.getPathFromRoot().iterator();
 313         while(current != null && arguments.hasNext()) {
 314             current = (StatementContextBase<?, ?, ?>) current.getFromNamespace(ChildSchemaNodes.class, arguments.next());
 315         }
 316         return current;
 317     }
 318
 319     public static SchemaPath getSchemaPath(final StmtContext<?, ?, ?> ctx) {
 320
 321         if (ctx == null) {
 322             return null;
 323         }
 324
 325         final Iterator<StmtContext<?, ?, ?>> iteratorFromRoot = ctx.getStmtContextsFromRoot().iterator();
 326         // skip root argument
 327         if (iteratorFromRoot.hasNext()) {
 328             iteratorFromRoot.next();
 329         }
 330
 331         List<QName> qNamesFromRoot = new LinkedList<>();
 332         while (iteratorFromRoot.hasNext()) {
 333             StmtContext<?, ?, ?> nextStmtCtx = iteratorFromRoot.next();
 334             Object nextStmtArgument = nextStmtCtx.getStatementArgument();
 335             if (nextStmtArgument instanceof QName) {
 336                 QName qname = (QName) nextStmtArgument;
 337                 if (StmtContextUtils.producesDeclared(nextStmtCtx, UsesStatement.class)) {
 338                     continue;
 339                 }
 340                 if (StmtContextUtils.producesDeclared(nextStmtCtx.getParentContext(), ChoiceStatement.class)
 341                         && isSupportedAsShorthandCase(nextStmtCtx)) {
 342                     qNamesFromRoot.add(qname);
 343                 }
 344                 qNamesFromRoot.add(qname);
 345             } else if (nextStmtArgument instanceof String) {
 346                 // FIXME: This may yield illegal argument exceptions
 347                 StatementContextBase<?, ?, ?> originalCtx = ctx
 348                         .getOriginalCtx();
 349                 final QName qName = (originalCtx != null) ? qNameFromArgument(
 350                         originalCtx, (String) nextStmtArgument)
 351                         : qNameFromArgument(ctx, (String) nextStmtArgument);
 352                 qNamesFromRoot.add(qName);
 353             } else if ((StmtContextUtils.producesDeclared(nextStmtCtx, AugmentStatement.class)
 354                        || StmtContextUtils.producesDeclared(nextStmtCtx, RefineStatement.class))
 355                     && nextStmtArgument instanceof SchemaNodeIdentifier) {
 356                 addQNamesFromSchemaNodeIdentifierToList(qNamesFromRoot, (SchemaNodeIdentifier) nextStmtArgument);
 357             } else if (isUnknownNode(nextStmtCtx)) {
 358                 qNamesFromRoot.add(nextStmtCtx.getPublicDefinition().getStatementName());
 359             } else {
 360                 return SchemaPath.SAME;
 361             }
 362         }
 363
 364         final SchemaPath schemaPath = SchemaPath.create(qNamesFromRoot, true);
 365         return schemaPath;
 366     }
 367
 368     public static boolean isUnknownNode(final StmtContext<?, ?, ?> stmtCtx) {
 369         return stmtCtx.getPublicDefinition().getDeclaredRepresentationClass()
 370                 .isAssignableFrom(UnknownStatementImpl.class);
 371     }
 372
 373     private static boolean isSupportedAsShorthandCase(final StmtContext<?, ?, ?> statementCtx) {
 374
 375         Collection<?> supportedCaseShorthands = statementCtx.getFromNamespace(ValidationBundlesNamespace.class,
 376                 ValidationBundleType.SUPPORTED_CASE_SHORTHANDS);
 377
 378         return supportedCaseShorthands == null || supportedCaseShorthands.contains(statementCtx.getPublicDefinition());
 379     }
 380
 381     private static void addQNamesFromSchemaNodeIdentifierToList(final List<QName> qNamesFromRoot,
 382             final SchemaNodeIdentifier augmentTargetPath) {
 383         for (QName qname : augmentTargetPath.getPathFromRoot()) {
 384             qNamesFromRoot.add(qname);
 385         }
 386     }
 387
 388     public static Deviation.Deviate parseDeviateFromString(final String deviate) {
 389
 390         // Yang constants should be lowercase so we have throw if value does not
 391         // suit this
 392         String deviateUpper = deviate.toUpperCase();
 393         Preconditions.checkArgument(!Objects.equals(deviate, deviateUpper),
 394             "String %s is not valid deviate argument", deviate);
 395
 396         // but Java enum is uppercase so we cannot use lowercase here
 397         try {
 398             return Deviation.Deviate.valueOf(deviateUpper);
 399         } catch (IllegalArgumentException e) {
 400             throw new IllegalArgumentException(String.format("String %s is not valid deviate argument", deviate), e);
 401         }
 402     }
 403
 404     public static Status parseStatus(final String value) {
 405
 406         Status status = null;
 407         switch (value) {
 408         case "current":
 409             status = Status.CURRENT;
 410             break;
 411         case "deprecated":
 412             status = Status.DEPRECATED;
 413             break;
 414         case "obsolete":
 415             status = Status.OBSOLETE;
 416             break;
 417         default:
 418             LOG.warn("Invalid 'status' statement: " + value);
 419         }
 420
 421         return status;
 422     }
 423
 424     public static Date getLatestRevision(final RootStatementContext<?, ?, ?> root) {
 425         return getLatestRevision(root.declaredSubstatements());
 426     }
 427
 428     public static Date getLatestRevision(final Iterable<? extends StmtContext<?, ?, ?>> subStmts) {
 429         Date revision = null;
 430         for (StmtContext<?, ?, ?> subStmt : subStmts) {
 431             if (subStmt.getPublicDefinition().getDeclaredRepresentationClass().isAssignableFrom(RevisionStatement
 432                     .class)) {
 433                 if (revision == null && subStmt.getStatementArgument() != null) {
 434                     revision = (Date) subStmt.getStatementArgument();
 435                 } else if (subStmt.getStatementArgument() != null && ((Date) subStmt.getStatementArgument()).compareTo
 436                         (revision) > 0) {
 437                     revision = (Date) subStmt.getStatementArgument();
 438                 }
 439             }
 440         }
 441         return revision;
 442     }
 443
 444     public static boolean isModuleIdentifierWithoutSpecifiedRevision(final Object o) {
 445         return (o instanceof ModuleIdentifier)
 446                 && (((ModuleIdentifier) o).getRevision() == SimpleDateFormatUtil.DEFAULT_DATE_IMP ||
 447                         ((ModuleIdentifier) o).getRevision() == SimpleDateFormatUtil.DEFAULT_BELONGS_TO_DATE);
 448     }
 449 }