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