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