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