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 java.net.URI;
  16 import java.util.Collection;
  17 import java.util.Optional;
  18 import org.opendaylight.yangtools.concepts.SemVer;
  19 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  20 import org.opendaylight.yangtools.yang.model.api.stmt.ImportStatement;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.NamespaceStatement;
  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.URIStringToImportPrefix;
  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.ModuleCtxToSourceIdentifier;
  40
  41 final class SemanticVersionImport {
  42
  43     private abstract static class CompatibleCriterion extends NamespaceKeyCriterion<SemVerSourceIdentifier> {
  44         private final String moduleName;
  45
  46         CompatibleCriterion(final String moduleName) {
  47             this.moduleName = requireNonNull(moduleName);
  48         }
  49
  50         @Override
  51         public boolean match(final SemVerSourceIdentifier key) {
  52             return moduleName.equals(key.getName());
  53         }
  54
  55         @Override
  56         protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
  57             return toStringHelper.add("moduleName", moduleName);
  58         }
  59     }
  60
  61     private static final class NoVerCompatibleCriterion extends SemanticVersionImport.CompatibleCriterion {
  62         NoVerCompatibleCriterion(final String moduleName) {
  63             super(moduleName);
  64         }
  65
  66         @Override
  67         public SemVerSourceIdentifier select(final SemVerSourceIdentifier first,
  68                 final SemVerSourceIdentifier second) {
  69             // TODO Auto-generated method stub
  70             return null;
  71         }
  72     }
  73
  74     private static final class SemVerCompatibleCriterion extends SemanticVersionImport.CompatibleCriterion {
  75         private final SemVer semVer;
  76
  77         SemVerCompatibleCriterion(final String moduleName, final SemVer semVer) {
  78             super(moduleName);
  79             this.semVer = requireNonNull(semVer);
  80         }
  81
  82         @Override
  83         public boolean match(final SemVerSourceIdentifier key) {
  84             if (!super.match(key)) {
  85                 return false;
  86             }
  87             final Optional<SemVer> optKeyVer = key.getSemanticVersion();
  88             if (!optKeyVer.isPresent()) {
  89                 return false;
  90             }
  91
  92             final SemVer keyVer = optKeyVer.get();
  93             if (semVer.getMajor() != keyVer.getMajor()) {
  94                 return false;
  95             }
  96             if (semVer.getMinor() > keyVer.getMinor()) {
  97                 return false;
  98             }
  99             return semVer.getMinor() < keyVer.getMinor() || semVer.getPatch() <= keyVer.getPatch();
 100         }
 101
 102         @Override
 103         public SemVerSourceIdentifier select(final SemVerSourceIdentifier first,
 104                 final SemVerSourceIdentifier second) {
 105             return first.getSemanticVersion().get().compareTo(second.getSemanticVersion().get()) >= 0 ? first
 106                     : second;
 107         }
 108
 109         @Override
 110         protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 111             return super.addToStringAttributes(toStringHelper).add("version", semVer);
 112         }
 113     }
 114
 115
 116     private SemanticVersionImport() {
 117         throw new UnsupportedOperationException("Utility class");
 118     }
 119
 120     static void onLinkageDeclared(
 121             final Mutable<String, ImportStatement, EffectiveStatement<String, ImportStatement>> stmt) {
 122         final ModelActionBuilder importAction = stmt.newInferenceAction(SOURCE_LINKAGE);
 123         final String moduleName = stmt.getStatementArgument();
 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(),
 132             SOURCE_LINKAGE);
 133
 134         importAction.apply(new InferenceAction() {
 135             @Override
 136             public void apply(final InferenceContext ctx) {
 137                 final StmtContext<?, ?, ?> importedModule = imported.resolve(ctx);
 138                 final SemVer importedVersion = stmt.getFromNamespace(SemanticVersionNamespace.class, stmt);
 139                 final SourceIdentifier importedModuleIdentifier = importedModule.getFromNamespace(
 140                     ModuleCtxToSourceIdentifier.class, importedModule);
 141                 final SemVerSourceIdentifier semVerModuleIdentifier = createSemVerModuleIdentifier(
 142                     importedModuleIdentifier, importedVersion);
 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 URI modNs = firstAttributeOf(importedModule.declaredSubstatements(),
 151                     NamespaceStatement.class);
 152                 stmt.addToNs(URIStringToImportPrefix.class, modNs.toString(), impPrefix);
 153             }
 154
 155             @Override
 156             public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
 157                 if (failed.contains(imported)) {
 158                     throw new InferenceException(stmt.getStatementSourceReference(),
 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     private static String getRequestedImportVersionString(final StmtContext<?, ?, ?> stmt) {
 171         return getRequestedImportVersion(stmt).map(SemVer::toString).orElse("<any>");
 172     }
 173
 174     private static SemVerSourceIdentifier createSemVerModuleIdentifier(
 175             final SourceIdentifier importedModuleIdentifier, final SemVer semVer) {
 176         return SemVerSourceIdentifier.create(importedModuleIdentifier.getName(),
 177             importedModuleIdentifier.getRevision(), semVer);
 178     }
 179 }