yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/import_/SemanticVersionImport.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies, s.r.o. 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.rfc7950.stmt.import_;
   9
  10 import static java.util.Objects.requireNonNull;
  11 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.SOURCE_LINKAGE;
  12 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.firstAttributeOf;
  13
  14 import com.google.common.base.MoreObjects.ToStringHelper;
  15 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  16 import java.net.URI;
  17 import java.util.Collection;
  18 import java.util.Optional;
  19 import org.opendaylight.yangtools.concepts.SemVer;
  20 import org.opendaylight.yangtools.yang.common.QNameModule;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.ImportEffectiveStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.ImportStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.NamespaceStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
  25 import org.opendaylight.yangtools.yang.model.repo.api.SemVerSourceIdentifier;
  26 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  27 import org.opendaylight.yangtools.yang.parser.rfc7950.namespace.ModuleQNameToPrefix;
  28 import org.opendaylight.yangtools.yang.parser.rfc7950.namespace.URIStringToImportPrefix;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceKeyCriterion;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.SemanticVersionModuleNamespace;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.SemanticVersionNamespace;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  39 import org.opendaylight.yangtools.yang.parser.spi.source.ImportPrefixToModuleCtx;
  40 import org.opendaylight.yangtools.yang.parser.spi.source.ImportPrefixToSemVerSourceIdentifier;
  41 import org.opendaylight.yangtools.yang.parser.spi.source.ImportedModuleContext;
  42 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName;
  43 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToSourceIdentifier;
  44
  45 final class SemanticVersionImport {
  46
  47     private abstract static class CompatibleCriterion extends NamespaceKeyCriterion<SemVerSourceIdentifier> {
  48         private final String moduleName;
  49
  50         CompatibleCriterion(final String moduleName) {
  51             this.moduleName = requireNonNull(moduleName);
  52         }
  53
  54         @Override
  55         public boolean match(final SemVerSourceIdentifier key) {
  56             return moduleName.equals(key.getName());
  57         }
  58
  59         @Override
  60         protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
  61             return toStringHelper.add("moduleName", moduleName);
  62         }
  63     }
  64
  65     private static final class NoVerCompatibleCriterion extends SemanticVersionImport.CompatibleCriterion {
  66         NoVerCompatibleCriterion(final String moduleName) {
  67             super(moduleName);
  68         }
  69
  70         @Override
  71         public SemVerSourceIdentifier select(final SemVerSourceIdentifier first,
  72                 final SemVerSourceIdentifier second) {
  73             // TODO Auto-generated method stub
  74             return null;
  75         }
  76     }
  77
  78     private static final class SemVerCompatibleCriterion extends SemanticVersionImport.CompatibleCriterion {
  79         private final SemVer semVer;
  80
  81         SemVerCompatibleCriterion(final String moduleName, final SemVer semVer) {
  82             super(moduleName);
  83             this.semVer = requireNonNull(semVer);
  84         }
  85
  86         @Override
  87         public boolean match(final SemVerSourceIdentifier key) {
  88             if (!super.match(key)) {
  89                 return false;
  90             }
  91             final Optional<SemVer> optKeyVer = key.getSemanticVersion();
  92             if (!optKeyVer.isPresent()) {
  93                 return false;
  94             }
  95
  96             final SemVer keyVer = optKeyVer.get();
  97             if (semVer.getMajor() != keyVer.getMajor()) {
  98                 return false;
  99             }
 100             if (semVer.getMinor() > keyVer.getMinor()) {
 101                 return false;
 102             }
 103             return semVer.getMinor() < keyVer.getMinor() || semVer.getPatch() <= keyVer.getPatch();
 104         }
 105
 106         @Override
 107         public SemVerSourceIdentifier select(final SemVerSourceIdentifier first,
 108                 final SemVerSourceIdentifier second) {
 109             return first.getSemanticVersion().get().compareTo(second.getSemanticVersion().get()) >= 0 ? first
 110                     : second;
 111         }
 112
 113         @Override
 114         protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 115             return super.addToStringAttributes(toStringHelper).add("version", semVer);
 116         }
 117     }
 118
 119     private SemanticVersionImport() {
 120         // Hidden on purpose
 121     }
 122
 123     static void onLinkageDeclared(final Mutable<String, ImportStatement, ImportEffectiveStatement> stmt) {
 124         final ModelActionBuilder importAction = stmt.newInferenceAction(SOURCE_LINKAGE);
 125         final String moduleName = stmt.getArgument();
 126         final SemVer semanticVersion = stmt.getFromNamespace(SemanticVersionNamespace.class, stmt);
 127         final SemanticVersionImport.CompatibleCriterion criterion = semanticVersion == null
 128                 ? new NoVerCompatibleCriterion(moduleName)
 129                         : new SemVerCompatibleCriterion(moduleName, semanticVersion);
 130
 131         final Prerequisite<StmtContext<?, ?, ?>> imported = importAction.requiresCtx(stmt,
 132             SemanticVersionModuleNamespace.class, criterion, SOURCE_LINKAGE);
 133         final Prerequisite<Mutable<?, ?, ?>> linkageTarget = importAction.mutatesCtx(stmt.getRoot(),
 134             SOURCE_LINKAGE);
 135
 136         importAction.apply(new InferenceAction() {
 137             @Override
 138             public void apply(final InferenceContext ctx) {
 139                 final StmtContext<?, ?, ?> importedModule = imported.resolve(ctx);
 140                 final SemVer importedVersion = stmt.getFromNamespace(SemanticVersionNamespace.class, stmt);
 141                 final SourceIdentifier importedModuleIdentifier = importedModule.getFromNamespace(
 142                     ModuleCtxToSourceIdentifier.class, importedModule);
 143                 final SemVerSourceIdentifier semVerModuleIdentifier = createSemVerModuleIdentifier(
 144                     importedModuleIdentifier, importedVersion);
 145
 146                 linkageTarget.resolve(ctx).addToNs(ImportedModuleContext.class, importedModuleIdentifier,
 147                     importedModule);
 148                 final String impPrefix = firstAttributeOf(stmt.declaredSubstatements(), PrefixStatement.class);
 149                 stmt.addToNs(ImportPrefixToModuleCtx.class, impPrefix, importedModule);
 150                 stmt.addToNs(ImportPrefixToSemVerSourceIdentifier.class, impPrefix, semVerModuleIdentifier);
 151
 152                 final QNameModule mod = InferenceException.throwIfNull(stmt.getFromNamespace(
 153                     ModuleCtxToModuleQName.class, importedModule), stmt.sourceReference(),
 154                     "Failed to find module of %s", importedModule);
 155
 156                 final URI modNs = firstAttributeOf(importedModule.declaredSubstatements(),
 157                     NamespaceStatement.class);
 158                 stmt.addToNs(ModuleQNameToPrefix.class, mod, impPrefix);
 159                 stmt.addToNs(URIStringToImportPrefix.class, modNs.toString(), impPrefix);
 160             }
 161
 162             @Override
 163             public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
 164                 if (failed.contains(imported)) {
 165                     throw new InferenceException(stmt.sourceReference(),
 166                             "Unable to find module compatible with requested import [%s(%s)].", moduleName,
 167                             getRequestedImportVersionString(stmt));
 168                 }
 169             }
 170         });
 171     }
 172
 173     private static Optional<SemVer> getRequestedImportVersion(final StmtContext<?, ?, ?> stmt) {
 174         return Optional.ofNullable(stmt.getFromNamespace(SemanticVersionNamespace.class, stmt));
 175     }
 176
 177     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
 178             justification = "https://github.com/spotbugs/spotbugs/issues/811")
 179     private static String getRequestedImportVersionString(final StmtContext<?, ?, ?> stmt) {
 180         return getRequestedImportVersion(stmt).map(SemVer::toString).orElse("<any>");
 181     }
 182
 183     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
 184             justification = "https://github.com/spotbugs/spotbugs/issues/811")
 185     private static SemVerSourceIdentifier createSemVerModuleIdentifier(
 186             final SourceIdentifier importedModuleIdentifier, final SemVer semVer) {
 187         return SemVerSourceIdentifier.create(importedModuleIdentifier.getName(),
 188             importedModuleIdentifier.getRevision(), semVer);
 189     }
 190 }