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.List;
  22 import java.util.Objects;
  23 import java.util.Set;
  24 import java.util.regex.Pattern;
  25 import javax.annotation.Nullable;
  26 import javax.xml.xpath.XPath;
  27 import javax.xml.xpath.XPathExpressionException;
  28 import javax.xml.xpath.XPathFactory;
  29 import org.antlr.v4.runtime.tree.TerminalNode;
  30 import org.opendaylight.yangtools.antlrv4.code.gen.YangStatementParser;
  31 import org.opendaylight.yangtools.yang.common.QName;
  32 import org.opendaylight.yangtools.yang.common.QNameModule;
  33 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
  34 import org.opendaylight.yangtools.yang.common.YangConstants;
  35 import org.opendaylight.yangtools.yang.model.api.Deviation;
  36 import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
  37 import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath;
  38 import org.opendaylight.yangtools.yang.model.api.Status;
  39 import org.opendaylight.yangtools.yang.model.api.stmt.BelongsToStatement;
  40 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleStatement;
  41 import org.opendaylight.yangtools.yang.model.api.stmt.RevisionStatement;
  42 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
  43 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Relative;
  44 import org.opendaylight.yangtools.yang.model.api.stmt.SubmoduleStatement;
  45 import org.opendaylight.yangtools.yang.model.util.RevisionAwareXPathImpl;
  46 import org.opendaylight.yangtools.yang.parser.spi.meta.QNameCacheNamespace;
  47 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  48 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  49 import org.opendaylight.yangtools.yang.parser.spi.source.BelongsToPrefixToModuleName;
  50 import org.opendaylight.yangtools.yang.parser.spi.source.ImpPrefixToModuleIdentifier;
  51 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName;
  52 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleIdentifierToModuleQName;
  53 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleNameToModuleQName;
  54 import org.opendaylight.yangtools.yang.parser.spi.source.PrefixToModule;
  55 import org.opendaylight.yangtools.yang.parser.spi.source.QNameToStatementDefinition;
  56 import org.opendaylight.yangtools.yang.parser.stmt.reactor.RootStatementContext;
  57 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
  58 import org.slf4j.Logger;
  59 import org.slf4j.LoggerFactory;
  60
  61 public final class Utils {
  62     private static final Logger LOG = LoggerFactory.getLogger(Utils.class);
  63     private static final CharMatcher DOUBLE_QUOTE_MATCHER = CharMatcher.is('"');
  64     private static final CharMatcher SINGLE_QUOTE_MATCHER = CharMatcher.is('\'');
  65     private static final Splitter SLASH_SPLITTER = Splitter.on('/').omitEmptyStrings().trimResults();
  66     private static final Splitter SPACE_SPLITTER = Splitter.on(' ').omitEmptyStrings().trimResults();
  67     private static final Pattern PATH_ABS = Pattern.compile("/[^/].*");
  68
  69     private static final ThreadLocal<XPathFactory> XPATH_FACTORY = new ThreadLocal<XPathFactory>() {
  70         @Override
  71         protected XPathFactory initialValue() {
  72             return XPathFactory.newInstance();
  73         }
  74     };
  75
  76     private Utils() {
  77         throw new UnsupportedOperationException();
  78     }
  79
  80     /**
  81      * Cleanup any resources attached to the current thread. Threads interacting with this class can cause thread-local
  82      * caches to them. Invoke this method if you want to detach those resources.
  83      */
  84     public static void detachFromCurrentThread() {
  85         XPATH_FACTORY.remove();
  86     }
  87
  88     public static Collection<SchemaNodeIdentifier.Relative> transformKeysStringToKeyNodes(final StmtContext<?, ?, ?> ctx,
  89             final String value) {
  90         List<String> keyTokens = SPACE_SPLITTER.splitToList(value);
  91
  92         // to detect if key contains duplicates
  93         if ((new HashSet<>(keyTokens)).size() < keyTokens.size()) {
  94             // FIXME: report all duplicate keys
  95             throw new IllegalArgumentException();
  96         }
  97
  98         Set<SchemaNodeIdentifier.Relative> keyNodes = new HashSet<>();
  99
 100         for (String keyToken : keyTokens) {
 101
 102             SchemaNodeIdentifier.Relative keyNode = (Relative) SchemaNodeIdentifier.Relative.create(false,
 103                     Utils.qNameFromArgument(ctx, keyToken));
 104             keyNodes.add(keyNode);
 105         }
 106
 107         return keyNodes;
 108     }
 109
 110     private static String trimSingleLastSlashFromXPath(final String path) {
 111         return path.endsWith("/") ? path.substring(0, path.length() - 1) : path;
 112     }
 113
 114     static RevisionAwareXPath parseXPath(final StmtContext<?, ?, ?> ctx, final String path) {
 115         final XPath xPath = XPATH_FACTORY.get().newXPath();
 116         xPath.setNamespaceContext(StmtNamespaceContext.create(ctx));
 117
 118         final String trimmed = trimSingleLastSlashFromXPath(path);
 119         try {
 120             // TODO: we could capture the result and expose its 'evaluate' method
 121             xPath.compile(trimmed);
 122         } catch (XPathExpressionException e) {
 123             LOG.warn("Argument \"{}\" is not valid XPath string at \"{}\"", path, ctx.getStatementSourceReference(), e);
 124         }
 125
 126         return new RevisionAwareXPathImpl(path, PATH_ABS.matcher(path).matches());
 127     }
 128
 129     public static QName trimPrefix(final QName identifier) {
 130         String prefixedLocalName = identifier.getLocalName();
 131         String[] namesParts = prefixedLocalName.split(":");
 132
 133         if (namesParts.length == 2) {
 134             String localName = namesParts[1];
 135             return QName.create(identifier.getModule(), localName);
 136         }
 137
 138         return identifier;
 139     }
 140
 141     public static String getPrefixFromArgument(final String prefixedLocalName) {
 142         String[] namesParts = prefixedLocalName.split(":");
 143         if (namesParts.length == 2) {
 144             return namesParts[0];
 145         }
 146         return null;
 147     }
 148
 149     public static boolean isValidStatementDefinition(final PrefixToModule prefixes, final QNameToStatementDefinition stmtDef,
 150             final QName identifier) {
 151         if (stmtDef.get(identifier) != null) {
 152             return true;
 153         } else {
 154             String prefixedLocalName = identifier.getLocalName();
 155             String[] namesParts = prefixedLocalName.split(":");
 156
 157             if (namesParts.length == 2) {
 158                 String prefix = namesParts[0];
 159                 String localName = namesParts[1];
 160                 if (prefixes != null && prefixes.get(prefix) != null
 161                         && stmtDef.get(QName.create(YangConstants.RFC6020_YIN_MODULE, localName)) != null) {
 162                     return true;
 163                 } else {
 164                     if (stmtDef.get(QName.create(YangConstants.RFC6020_YIN_MODULE, localName)) != null) {
 165                         return true;
 166                     }
 167                 }
 168             }
 169         }
 170         return false;
 171     }
 172
 173     static SchemaNodeIdentifier nodeIdentifierFromPath(final StmtContext<?, ?, ?> ctx, final String path) {
 174         // FIXME: is the path trimming really necessary??
 175         final List<QName> qNames = new ArrayList<>();
 176         for (String nodeName : SLASH_SPLITTER.split(trimSingleLastSlashFromXPath(path))) {
 177             try {
 178                 final QName qName = Utils.qNameFromArgument(ctx, nodeName);
 179                 qNames.add(qName);
 180             } catch (Exception e) {
 181                 throw new IllegalArgumentException(
 182                     String.format("Failed to parse node '%s' in path '%s'", nodeName, path), e);
 183             }
 184         }
 185
 186         return SchemaNodeIdentifier.create(qNames, PATH_ABS.matcher(path).matches());
 187     }
 188
 189     public static String stringFromStringContext(final YangStatementParser.ArgumentContext context) {
 190         StringBuilder sb = new StringBuilder();
 191         List<TerminalNode> strings = context.STRING();
 192         if (strings.isEmpty()) {
 193             strings = Arrays.asList(context.IDENTIFIER());
 194         }
 195         for (TerminalNode stringNode : strings) {
 196             final String str = stringNode.getText();
 197             char firstChar = str.charAt(0);
 198             final CharMatcher quoteMatcher;
 199             if (SINGLE_QUOTE_MATCHER.matches(firstChar)) {
 200                 quoteMatcher = SINGLE_QUOTE_MATCHER;
 201             } else if (DOUBLE_QUOTE_MATCHER.matches(firstChar)) {
 202                 quoteMatcher = DOUBLE_QUOTE_MATCHER;
 203             } else {
 204                 sb.append(str);
 205                 continue;
 206             }
 207             sb.append(quoteMatcher.removeFrom(str.substring(1, str.length() - 1)));
 208         }
 209         return sb.toString();
 210     }
 211
 212     public static QName qNameFromArgument(StmtContext<?, ?, ?> ctx, final String value) {
 213         if (Strings.isNullOrEmpty(value)) {
 214             return ctx.getPublicDefinition().getStatementName();
 215         }
 216
 217         String prefix;
 218         QNameModule qNameModule = null;
 219         String localName = null;
 220
 221         String[] namesParts = value.split(":");
 222         switch (namesParts.length) {
 223         case 1:
 224             localName = namesParts[0];
 225             qNameModule = getRootModuleQName(ctx);
 226             break;
 227         default:
 228             prefix = namesParts[0];
 229             localName = namesParts[1];
 230             qNameModule = getModuleQNameByPrefix(ctx, prefix);
 231             // in case of unknown statement argument, we're not going to parse it
 232             if (qNameModule == null
 233                     && ctx.getPublicDefinition().getDeclaredRepresentationClass()
 234                     .isAssignableFrom(UnknownStatementImpl.class)) {
 235                 localName = value;
 236                 qNameModule = getRootModuleQName(ctx);
 237             }
 238             if (qNameModule == null
 239                     && Iterables.getLast(ctx.getCopyHistory()) == StmtContext.TypeOfCopy.ADDED_BY_AUGMENTATION) {
 240                 ctx = ctx.getOriginalCtx();
 241                 qNameModule = getModuleQNameByPrefix(ctx, prefix);
 242             }
 243             break;
 244         }
 245
 246         Preconditions.checkArgument(qNameModule != null, "Error in module '%s': can not resolve QNameModule for '%s'.",
 247                 ctx.getRoot().rawStatementArgument(), value);
 248         final QNameModule resultQNameModule;
 249         if (qNameModule.getRevision() == null) {
 250             resultQNameModule = QNameModule.cachedReference(
 251                 QNameModule.create(qNameModule.getNamespace(), SimpleDateFormatUtil.DEFAULT_DATE_REV));
 252         } else {
 253             resultQNameModule = qNameModule;
 254         }
 255
 256         return ctx.getFromNamespace(QNameCacheNamespace.class, QName.create(resultQNameModule, localName));
 257     }
 258
 259     public static QNameModule getModuleQNameByPrefix(final StmtContext<?, ?, ?> ctx, final String prefix) {
 260         final ModuleIdentifier modId = ctx.getRoot().getFromNamespace(ImpPrefixToModuleIdentifier.class, prefix);
 261         final QNameModule qNameModule = ctx.getFromNamespace(ModuleIdentifierToModuleQName.class, modId);
 262
 263         if (qNameModule == null && StmtContextUtils.producesDeclared(ctx.getRoot(), SubmoduleStatement.class)) {
 264             String moduleName = ctx.getRoot().getFromNamespace(BelongsToPrefixToModuleName.class, prefix);
 265             return ctx.getFromNamespace(ModuleNameToModuleQName.class, moduleName);
 266         }
 267         return qNameModule;
 268     }
 269
 270     public static QNameModule getRootModuleQName(final StmtContext<?, ?, ?> ctx) {
 271         if (ctx == null) {
 272             return null;
 273         }
 274
 275         final StmtContext<?, ?, ?> rootCtx = ctx.getRoot();
 276         final QNameModule qNameModule;
 277
 278         if (StmtContextUtils.producesDeclared(rootCtx, ModuleStatement.class)) {
 279             qNameModule = rootCtx.getFromNamespace(ModuleCtxToModuleQName.class, rootCtx);
 280         } else if (StmtContextUtils.producesDeclared(rootCtx, SubmoduleStatement.class)) {
 281             final String belongsToModuleName = firstAttributeOf(rootCtx.substatements(), BelongsToStatement.class);
 282             qNameModule = rootCtx.getFromNamespace(ModuleNameToModuleQName.class, belongsToModuleName);
 283         } else {
 284             qNameModule = null;
 285         }
 286
 287         Preconditions.checkArgument(qNameModule != null, "Failed to look up root QNameModule for %s", ctx);
 288         if (qNameModule.getRevision() != null) {
 289             return qNameModule;
 290         }
 291
 292         return QNameModule.cachedReference(
 293             QNameModule.create(qNameModule.getNamespace(), SimpleDateFormatUtil.DEFAULT_DATE_REV));
 294     }
 295
 296     @Nullable
 297     public static StatementContextBase<?, ?, ?> findNode(final StmtContext<?, ?, ?> rootStmtCtx,
 298             final SchemaNodeIdentifier node) {
 299         return (StatementContextBase<?, ?, ?>) rootStmtCtx.getFromNamespace(SchemaNodeIdentifierBuildNamespace.class, node);
 300     }
 301
 302     public static boolean isUnknownNode(final StmtContext<?, ?, ?> stmtCtx) {
 303         return stmtCtx.getPublicDefinition().getDeclaredRepresentationClass()
 304                 .isAssignableFrom(UnknownStatementImpl.class);
 305     }
 306
 307     public static Deviation.Deviate parseDeviateFromString(final String deviate) {
 308
 309         // Yang constants should be lowercase so we have throw if value does not
 310         // suit this
 311         String deviateUpper = deviate.toUpperCase();
 312         Preconditions.checkArgument(!Objects.equals(deviate, deviateUpper),
 313             "String %s is not valid deviate argument", deviate);
 314
 315         // but Java enum is uppercase so we cannot use lowercase here
 316         try {
 317             return Deviation.Deviate.valueOf(deviateUpper);
 318         } catch (IllegalArgumentException e) {
 319             throw new IllegalArgumentException(String.format("String %s is not valid deviate argument", deviate), e);
 320         }
 321     }
 322
 323     public static Status parseStatus(final String value) {
 324
 325         Status status = null;
 326         switch (value) {
 327         case "current":
 328             status = Status.CURRENT;
 329             break;
 330         case "deprecated":
 331             status = Status.DEPRECATED;
 332             break;
 333         case "obsolete":
 334             status = Status.OBSOLETE;
 335             break;
 336         default:
 337             LOG.warn("Invalid 'status' statement: " + value);
 338         }
 339
 340         return status;
 341     }
 342
 343     public static Date getLatestRevision(final RootStatementContext<?, ?, ?> root) {
 344         return getLatestRevision(root.declaredSubstatements());
 345     }
 346
 347     public static Date getLatestRevision(final Iterable<? extends StmtContext<?, ?, ?>> subStmts) {
 348         Date revision = null;
 349         for (StmtContext<?, ?, ?> subStmt : subStmts) {
 350             if (subStmt.getPublicDefinition().getDeclaredRepresentationClass().isAssignableFrom(RevisionStatement
 351                     .class)) {
 352                 if (revision == null && subStmt.getStatementArgument() != null) {
 353                     revision = (Date) subStmt.getStatementArgument();
 354                 } else if (subStmt.getStatementArgument() != null && ((Date) subStmt.getStatementArgument()).compareTo
 355                         (revision) > 0) {
 356                     revision = (Date) subStmt.getStatementArgument();
 357                 }
 358             }
 359         }
 360         return revision;
 361     }
 362
 363     public static boolean isModuleIdentifierWithoutSpecifiedRevision(final Object o) {
 364         return (o instanceof ModuleIdentifier)
 365                 && (((ModuleIdentifier) o).getRevision() == SimpleDateFormatUtil.DEFAULT_DATE_IMP ||
 366                         ((ModuleIdentifier) o).getRevision() == SimpleDateFormatUtil.DEFAULT_BELONGS_TO_DATE);
 367     }
 368 }