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