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