yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/ImportStatementDefinition.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.stmt.rfc6020;
   9
  10 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.SOURCE_LINKAGE;
  11 import static org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils.firstAttributeOf;
  12 import com.google.common.base.Optional;
  13 import java.net.URI;
  14 import java.util.Collection;
  15 import java.util.Date;
  16 import java.util.Map;
  17 import java.util.Map.Entry;
  18 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
  19 import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
  20 import org.opendaylight.yangtools.yang.model.api.Rfc6020Mapping;
  21 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.ImportStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.NamespaceStatement;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.PrefixStatement;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.RevisionDateStatement;
  27 import org.opendaylight.yangtools.yang.parser.builder.impl.ModuleIdentifierImpl;
  28 import org.opendaylight.yangtools.yang.parser.spi.ModuleNamespace;
  29 import org.opendaylight.yangtools.yang.parser.spi.SubstatementValidator;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  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.ImpPrefixToModuleIdentifier;
  38 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.ImportEffectiveStatementImpl;
  39
  40 public class ImportStatementDefinition
  41         extends AbstractStatementSupport<String, ImportStatement, EffectiveStatement<String, ImportStatement>> {
  42     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR =
  43             SubstatementValidator.builder(Rfc6020Mapping.IMPORT)
  44             .add(Rfc6020Mapping.PREFIX, 1, 1).add(Rfc6020Mapping.REVISION_DATE, 0, 1).build();
  45
  46     public ImportStatementDefinition() {
  47         super(Rfc6020Mapping.IMPORT);
  48     }
  49
  50     @Override
  51     public String parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  52         return value;
  53     }
  54
  55     @Override
  56     public ImportStatement createDeclared(final StmtContext<String, ImportStatement, ?> ctx) {
  57         return new ImportStatementImpl(ctx);
  58     }
  59
  60     @Override
  61     public EffectiveStatement<String, ImportStatement> createEffective(
  62             final StmtContext<String, ImportStatement, EffectiveStatement<String, ImportStatement>> ctx) {
  63         return new ImportEffectiveStatementImpl(ctx);
  64     }
  65
  66     @Override
  67     public void onFullDefinitionDeclared(
  68             final Mutable<String, ImportStatement, EffectiveStatement<String, ImportStatement>> stmt) {
  69         super.onFullDefinitionDeclared(stmt);
  70         SUBSTATEMENT_VALIDATOR.validate(stmt);
  71     }
  72
  73     @Override
  74     public void onLinkageDeclared(
  75             final Mutable<String, ImportStatement, EffectiveStatement<String, ImportStatement>> stmt) {
  76         final ModuleIdentifier impIdentifier = getImportedModuleIdentifier(stmt);
  77         final ModelActionBuilder importAction = stmt.newInferenceAction(SOURCE_LINKAGE);
  78         final Prerequisite<StmtContext<?, ?, ?>> imported = importAction.requiresCtx(stmt, ModuleNamespace.class,
  79             impIdentifier, SOURCE_LINKAGE);
  80         final Prerequisite<Mutable<?, ?, ?>> linkageTarget = importAction.mutatesCtx(stmt.getRoot(), SOURCE_LINKAGE);
  81
  82         importAction.apply(new InferenceAction() {
  83             @Override
  84             public void apply() {
  85                 StmtContext<?, ?, ?> importedModule = null;
  86                 ModuleIdentifier importedModuleIdentifier = null;
  87                 if (impIdentifier.getRevision() == SimpleDateFormatUtil.DEFAULT_DATE_IMP) {
  88                     Entry<ModuleIdentifier, StmtContext<?, ModuleStatement, EffectiveStatement<String, ModuleStatement>>> recentModuleEntry =
  89                             findRecentModule(impIdentifier, stmt.getAllFromNamespace(ModuleNamespace.class));
  90                     if (recentModuleEntry != null) {
  91                         importedModuleIdentifier = recentModuleEntry.getKey();
  92                         importedModule = recentModuleEntry.getValue();
  93                     }
  94                 }
  95
  96                 if (importedModule == null || importedModuleIdentifier == null) {
  97                     importedModule = imported.get();
  98                     importedModuleIdentifier = impIdentifier;
  99                 }
 100
 101                 linkageTarget.get().addToNs(ImportedModuleContext.class, importedModuleIdentifier, importedModule);
 102                 String impPrefix = firstAttributeOf(stmt.declaredSubstatements(), PrefixStatement.class);
 103                 stmt.addToNs(ImpPrefixToModuleIdentifier.class, impPrefix, importedModuleIdentifier);
 104
 105                 final URI modNs = firstAttributeOf(importedModule.declaredSubstatements(), NamespaceStatement.class);
 106                 stmt.addToNs(URIStringToImpPrefix.class, modNs.toString(), impPrefix);
 107             }
 108
 109             private Entry<ModuleIdentifier, StmtContext<?, ModuleStatement, EffectiveStatement<String, ModuleStatement>>> findRecentModule(
 110                     final ModuleIdentifier impIdentifier,
 111                     final Map<ModuleIdentifier, StmtContext<?, ModuleStatement, EffectiveStatement<String, ModuleStatement>>> allModules) {
 112
 113                 ModuleIdentifier recentModuleIdentifier = impIdentifier;
 114                 Entry<ModuleIdentifier, StmtContext<?, ModuleStatement, EffectiveStatement<String, ModuleStatement>>> recentModuleEntry = null;
 115
 116                 for (Entry<ModuleIdentifier, StmtContext<?, ModuleStatement, EffectiveStatement<String, ModuleStatement>>> moduleEntry : allModules.entrySet()) {
 117                     final ModuleIdentifier id = moduleEntry.getKey();
 118
 119                     if (id.getName().equals(impIdentifier.getName())
 120                             && id.getRevision().compareTo(recentModuleIdentifier.getRevision()) > 0) {
 121                         recentModuleIdentifier = id;
 122                         recentModuleEntry = moduleEntry;
 123                     }
 124                 }
 125
 126                 return recentModuleEntry;
 127             }
 128
 129             @Override
 130             public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed)  {
 131                 if (failed.contains(imported)) {
 132                     throw new InferenceException(stmt.getStatementSourceReference(),
 133                         "Imported module [%s] was not found.", impIdentifier);
 134                 }
 135             }
 136         });
 137
 138
 139     }
 140
 141     private static ModuleIdentifier getImportedModuleIdentifier(final Mutable<String, ImportStatement, ?> stmt) {
 142         Date revision = firstAttributeOf(stmt.declaredSubstatements(), RevisionDateStatement.class);
 143         if (revision == null) {
 144             revision = SimpleDateFormatUtil.DEFAULT_DATE_IMP;
 145         }
 146
 147         return new ModuleIdentifierImpl(stmt.getStatementArgument(), Optional.<URI> absent(),
 148                 Optional.<Date> of(revision));
 149     }
 150
 151 }