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