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