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