yang/yang-model-util/src/main/java/org/opendaylight/yangtools/yang/model/util/FilteringSchemaContextProxy.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
   9 package org.opendaylight.yangtools.yang.model.util;
  10
  11 import com.google.common.base.Function;
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.base.Strings;
  14 import com.google.common.collect.Collections2;
  15 import com.google.common.collect.ImmutableMap;
  16 import com.google.common.collect.ImmutableSet.Builder;
  17 import com.google.common.collect.ImmutableSetMultimap;
  18 import com.google.common.collect.Lists;
  19 import com.google.common.collect.Maps;
  20 import com.google.common.collect.Multimap;
  21 import com.google.common.collect.Multimaps;
  22 import com.google.common.collect.SetMultimap;
  23 import com.google.common.collect.TreeMultimap;
  24 import java.net.URI;
  25 import java.util.Collection;
  26 import java.util.Collections;
  27 import java.util.Date;
  28 import java.util.List;
  29 import java.util.Map;
  30 import java.util.Set;
  31 import java.util.TreeMap;
  32 import javax.annotation.concurrent.Immutable;
  33 import org.opendaylight.yangtools.yang.model.api.Module;
  34 import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
  35 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
  36 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  37
  38 @Immutable
  39 public final class FilteringSchemaContextProxy extends AbstractSchemaContext {
  40
  41     //collection to be filled with filtered modules
  42     private final Set<Module> filteredModules;
  43
  44     //collections to be filled in with filtered data
  45     private final Map<ModuleIdentifier, String> identifiersToSources;
  46     private final SetMultimap<URI, Module> namespaceToModules;
  47     private final SetMultimap<String, Module> nameToModules;
  48
  49     /**
  50      * Filters SchemaContext for yang modules
  51      *
  52      * @param delegate original SchemaContext
  53      * @param rootModules modules (yang schemas) to be available and all their dependencies (modules importing rootModule and whole chain of their imports)
  54      * @param additionalModuleIds (additional) modules (yang schemas) to be available and whole chain of their imports
  55      *
  56      */
  57     public FilteringSchemaContextProxy(final SchemaContext delegate, final Collection<ModuleId> rootModules, final Set<ModuleId> additionalModuleIds) {
  58
  59         Preconditions.checkArgument(rootModules!=null,"Base modules cannot be null.");
  60         Preconditions.checkArgument(additionalModuleIds!=null,"Additional modules cannot be null.");
  61
  62         final Builder<Module> filteredModulesBuilder = new Builder<>();
  63
  64         final SetMultimap<URI, Module> nsMap = Multimaps.newSetMultimap(new TreeMap<>(), MODULE_SET_SUPPLIER);
  65         final SetMultimap<String, Module> nameMap = Multimaps.newSetMultimap(new TreeMap<>(), MODULE_SET_SUPPLIER);
  66
  67         ImmutableMap.Builder<ModuleIdentifier, String> identifiersToSourcesBuilder = ImmutableMap.builder();
  68
  69         //preparing map to get all modules with one name but difference in revision
  70         final TreeMultimap<String, Module> nameToModulesAll = getStringModuleTreeMultimap();
  71
  72         nameToModulesAll.putAll(getStringModuleMap(delegate));
  73
  74         //in case there is a particular dependancy to view filteredModules/yang models
  75         //dependancy is checked for module name and imports
  76         processForRootModules(delegate, rootModules, filteredModulesBuilder);
  77
  78         //adding additional modules
  79         processForAdditionalModules(delegate, additionalModuleIds, filteredModulesBuilder);
  80
  81         filteredModulesBuilder.addAll(getImportedModules(
  82                 Maps.uniqueIndex(delegate.getModules(), ModuleId.MODULE_TO_MODULE_ID), filteredModulesBuilder.build(), nameToModulesAll));
  83
  84         /**
  85          * Instead of doing this on each invocation of getModules(), pre-compute
  86          * it once and keep it around -- better than the set we got in.
  87          */
  88         this.filteredModules = filteredModulesBuilder.build();
  89
  90         for (final Module module :filteredModules) {
  91             nameMap.put(module.getName(), module);
  92             nsMap.put(module.getNamespace(), module);
  93             identifiersToSourcesBuilder.put(module, module.getSource());
  94         }
  95
  96         namespaceToModules = ImmutableSetMultimap.copyOf(nsMap);
  97         nameToModules = ImmutableSetMultimap.copyOf(nameMap);
  98         identifiersToSources = identifiersToSourcesBuilder.build();
  99     }
 100
 101     private static TreeMultimap<String, Module> getStringModuleTreeMultimap() {
 102         return TreeMultimap.create((o1, o2) -> o1.compareTo(o2), REVISION_COMPARATOR);
 103     }
 104
 105     private static void processForAdditionalModules(final SchemaContext delegate,
 106             final Set<ModuleId> additionalModuleIds, final Builder<Module> filteredModulesBuilder) {
 107         filteredModulesBuilder.addAll(Collections2.filter(delegate.getModules(),
 108             module -> selectAdditionalModules(module, additionalModuleIds)));
 109     }
 110
 111     private void processForRootModules(final SchemaContext delegate, final Collection<ModuleId> rootModules,
 112             final Builder<Module> filteredModulesBuilder) {
 113         filteredModulesBuilder.addAll(Collections2.filter(delegate.getModules(),
 114             module -> checkModuleDependency(module, rootModules)));
 115     }
 116
 117     private static Multimap<String, Module> getStringModuleMap(final SchemaContext delegate) {
 118         return Multimaps.index(delegate.getModules(), Module::getName);
 119     }
 120
 121     //dealing with imported module other than root and directly importing root
 122     private static Collection<Module> getImportedModules(final Map<ModuleId, Module> allModules, final Set<Module> baseModules, final TreeMultimap<String, Module> nameToModulesAll) {
 123
 124         List<Module> relatedModules = Lists.newLinkedList();
 125
 126         for (Module module : baseModules) {
 127             for (ModuleImport moduleImport : module.getImports()) {
 128
 129                 Date revisionDate = moduleImport.getRevision() == null ?
 130                         nameToModulesAll.get(moduleImport.getModuleName()).first().getRevision() : moduleImport.getRevision();
 131
 132                 ModuleId key = new ModuleId(moduleImport.getModuleName(),revisionDate);
 133                 Module importedModule = allModules.get(key);
 134
 135                 Preconditions.checkArgument(importedModule != null,  "Invalid schema, cannot find imported module: %s from module: %s, %s, modules:%s", key, module.getQNameModule(), module.getName() );
 136                 relatedModules.add(importedModule);
 137
 138                 //calling imports recursive
 139                 relatedModules.addAll(getImportedModules(allModules, Collections.singleton(importedModule), nameToModulesAll));
 140
 141             }
 142         }
 143
 144         return relatedModules;
 145     }
 146
 147     @Override
 148     protected Map<ModuleIdentifier, String> getIdentifiersToSources() {
 149         return identifiersToSources;
 150     }
 151
 152     @Override
 153     public Set<Module> getModules() {
 154         return filteredModules;
 155     }
 156
 157     @Override
 158     protected SetMultimap<URI, Module> getNamespaceToModules() {
 159         return namespaceToModules;
 160     }
 161
 162     @Override
 163     protected SetMultimap<String, Module> getNameToModules() {
 164         return nameToModules;
 165     }
 166
 167     private static boolean selectAdditionalModules(final Module module, final Set<ModuleId> additionalModules){
 168         return additionalModules.contains(new ModuleId(module.getName(), module.getRevision()));
 169     }
 170
 171     //check for any dependency regarding given string
 172     private boolean checkModuleDependency(final Module module, final Collection<ModuleId> rootModules) {
 173
 174         for (ModuleId rootModule : rootModules) {
 175
 176             if (rootModule.equals(new ModuleId(module.getName(), module.getRevision()))) {
 177                 return true;
 178             }
 179
 180             //handling/checking imports regarding root modules
 181             for (ModuleImport moduleImport : module.getImports()) {
 182
 183                 if (moduleImport.getModuleName().equals(rootModule.getName())) {
 184
 185                     if (moduleImport.getRevision() != null && !moduleImport.getRevision().equals(rootModule.getRev())) {
 186                         return false;
 187                     }
 188
 189                     return true;
 190                 }
 191             }
 192
 193             //submodules handling
 194             for (Module moduleSub : module.getSubmodules()) {
 195                 return checkModuleDependency(moduleSub, rootModules);
 196             }
 197         }
 198
 199         return false;
 200     }
 201
 202     @Override
 203     public String toString() {
 204         return String.format("SchemaContextProxyImpl{filteredModules=%s}", filteredModules);
 205     }
 206
 207     public static final class ModuleId {
 208         private final String name;
 209         private final Date rev;
 210
 211         public ModuleId(final String name, final Date rev) {
 212             Preconditions.checkArgument(!Strings.isNullOrEmpty(name), "No module dependency name given. Nothing to do.");
 213             this.name = name;
 214             this.rev = Preconditions.checkNotNull(rev, "No revision date given. Nothing to do.");
 215         }
 216
 217         public String getName() {
 218             return name;
 219         }
 220
 221         public Date getRev() {
 222             return rev;
 223         }
 224
 225         public static final Function<Module, ModuleId> MODULE_TO_MODULE_ID = input -> new ModuleId(input.getName(),
 226             input.getRevision());
 227
 228         @Override
 229         public boolean equals(final Object o) {
 230             if (this == o) {
 231                 return true;
 232             }
 233             if (!(o instanceof ModuleId)) {
 234                 return false;
 235             }
 236
 237             ModuleId moduleId = (ModuleId) o;
 238             if (name != null ? !name.equals(moduleId.name) : moduleId.name != null) {
 239                 return false;
 240             }
 241             if (rev != null ? !rev.equals(moduleId.rev) : moduleId.rev != null) {
 242                 return false;
 243             }
 244
 245             return true;
 246         }
 247
 248         @Override
 249         public int hashCode() {
 250             int result = name != null ? name.hashCode() : 0;
 251             result = 31 * result + (rev != null ? rev.hashCode() : 0);
 252             return result;
 253         }
 254
 255         @Override
 256         public String toString() {
 257
 258             return String.format("ModuleId{name='%s', rev=%s}",name,rev);
 259         }
 260     }
 261 }