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