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