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

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. 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 com.google.common.base.Verify.verify;
  11 import static com.google.common.base.Verify.verifyNotNull;
  12 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.SOURCE_PRE_LINKAGE;
  13 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.firstAttributeOf;
  14
  15 import com.google.common.annotations.Beta;
  16 import com.google.common.collect.ImmutableList;
  17 import java.util.Collection;
  18 import org.eclipse.jdt.annotation.NonNull;
  19 import org.opendaylight.yangtools.openconfig.model.api.OpenConfigStatements;
  20 import org.opendaylight.yangtools.yang.common.Empty;
  21 import org.opendaylight.yangtools.yang.common.XMLNamespace;
  22 import org.opendaylight.yangtools.yang.common.YangVersion;
  23 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  24 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
  25 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  26 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.ImportEffectiveStatement;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.ImportStatement;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
  30 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  31 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
  32 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  33 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
  34 import org.opendaylight.yangtools.yang.parser.api.ImportResolutionMode;
  35 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
  36 import org.opendaylight.yangtools.yang.parser.spi.PreLinkageModuleNamespace;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStringStatementSupport;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  39 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  40 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  41 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
  42 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
  43 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  44 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  45 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  46 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  47 import org.opendaylight.yangtools.yang.parser.spi.source.ImpPrefixToNamespace;
  48 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleNameToNamespace;
  49 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  50 import org.opendaylight.yangtools.yang.parser.spi.source.YangVersionLinkageException;
  51
  52 @Beta
  53 public final class ImportStatementSupport
  54         extends AbstractStringStatementSupport<ImportStatement, ImportEffectiveStatement> {
  55     private static final SubstatementValidator RFC6020_VALIDATOR =
  56         SubstatementValidator.builder(YangStmtMapping.IMPORT)
  57             .addMandatory(YangStmtMapping.PREFIX)
  58             .addOptional(YangStmtMapping.REVISION_DATE)
  59             .addOptional(OpenConfigStatements.OPENCONFIG_VERSION)
  60             .build();
  61     private static final SubstatementValidator RFC7950_VALIDATOR =
  62         SubstatementValidator.builder(YangStmtMapping.IMPORT)
  63             .addMandatory(YangStmtMapping.PREFIX)
  64             .addOptional(YangStmtMapping.REVISION_DATE)
  65             .addOptional(OpenConfigStatements.OPENCONFIG_VERSION)
  66             .addOptional(YangStmtMapping.DESCRIPTION)
  67             .addOptional(YangStmtMapping.REFERENCE)
  68             .build();
  69
  70     private final boolean semanticVersioning;
  71
  72     private ImportStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
  73         super(YangStmtMapping.IMPORT, StatementPolicy.reject(), config, validator);
  74         semanticVersioning = config.importResolutionMode() == ImportResolutionMode.OPENCONFIG_SEMVER;
  75     }
  76
  77     public static @NonNull ImportStatementSupport rfc6020Instance(final YangParserConfiguration config) {
  78         return new ImportStatementSupport(config, RFC6020_VALIDATOR);
  79     }
  80
  81     public static @NonNull ImportStatementSupport rfc7950Instance(final YangParserConfiguration config) {
  82         return new ImportStatementSupport(config, RFC7950_VALIDATOR);
  83     }
  84
  85     @Override
  86     public void onPreLinkageDeclared(final Mutable<String, ImportStatement, ImportEffectiveStatement> stmt) {
  87         /*
  88          * Add ModuleIdentifier of a module which is required by this module.
  89          * Based on this information, required modules are searched from library
  90          * sources.
  91          */
  92         final SourceIdentifier importId = RevisionImport.getImportedSourceIdentifier(stmt);
  93         stmt.addRequiredSource(importId);
  94
  95         final String moduleName = stmt.getArgument();
  96         final ModelActionBuilder importAction = stmt.newInferenceAction(SOURCE_PRE_LINKAGE);
  97         final Prerequisite<StmtContext<?, ?, ?>> imported = importAction.requiresCtx(stmt,
  98                 PreLinkageModuleNamespace.class, moduleName, SOURCE_PRE_LINKAGE);
  99         final Prerequisite<Mutable<?, ?, ?>> rootPrereq = importAction.mutatesCtx(stmt.getRoot(), SOURCE_PRE_LINKAGE);
 100
 101         importAction.apply(new InferenceAction() {
 102             @Override
 103             public void apply(final InferenceContext ctx) {
 104                 final StmtContext<?, ?, ?> importedModuleContext = imported.resolve(ctx);
 105                 verify(moduleName.equals(importedModuleContext.getRawArgument()));
 106                 final XMLNamespace importedModuleNamespace = verifyNotNull(
 107                     importedModuleContext.getFromNamespace(ModuleNameToNamespace.class, moduleName));
 108                 final String impPrefix = SourceException.throwIfNull(
 109                     firstAttributeOf(stmt.declaredSubstatements(), PrefixStatement.class), stmt,
 110                     "Missing prefix statement");
 111
 112                 final Mutable<?, ?, ?> root = rootPrereq.resolve(ctx);
 113                 // Version 1 sources must not import-by-revision Version 1.1 modules
 114                 if (importId.getRevision().isPresent() && root.yangVersion() == YangVersion.VERSION_1) {
 115                     final YangVersion importedVersion = importedModuleContext.yangVersion();
 116                     if (importedVersion != YangVersion.VERSION_1) {
 117                         throw new YangVersionLinkageException(stmt,
 118                             "Cannot import by revision version %s module %s", importedVersion, moduleName);
 119                     }
 120                 }
 121
 122                 stmt.addToNs(ImpPrefixToNamespace.class, impPrefix, importedModuleNamespace);
 123             }
 124
 125             @Override
 126             public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
 127                 InferenceException.throwIf(failed.contains(imported), stmt, "Imported module [%s] was not found.",
 128                     moduleName);
 129             }
 130         });
 131     }
 132
 133     @Override
 134     public void onLinkageDeclared(final Mutable<String, ImportStatement, ImportEffectiveStatement> stmt) {
 135         if (semanticVersioning) {
 136             SemanticVersionImport.onLinkageDeclared(stmt);
 137         } else {
 138             RevisionImport.onLinkageDeclared(stmt);
 139         }
 140     }
 141
 142     @Override
 143     protected ImportStatement createDeclared(final StmtContext<String, ImportStatement, ?> ctx,
 144             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
 145         return DeclaredStatements.createImport(ctx.getRawArgument(), substatements);
 146     }
 147
 148     @Override
 149     protected ImportStatement attachDeclarationReference(final ImportStatement stmt,
 150             final DeclarationReference reference) {
 151         return DeclaredStatementDecorators.decorateImport(stmt, reference);
 152     }
 153
 154     @Override
 155     protected ImportEffectiveStatement createEffective(final Current<String, ImportStatement> stmt,
 156             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 157         InferenceException.throwIf(substatements.isEmpty(), stmt, "Unexpected empty effective import statement");
 158         return EffectiveStatements.createImport(stmt.declared(), substatements,
 159             verifyNotNull(stmt.getFromNamespace(ImportedVersionNamespace.class, Empty.value())));
 160     }
 161 }