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