2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.model.util;
10 import static org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil.DEFAULT_DATE_REV;
12 import com.google.common.annotations.Beta;
13 import com.google.common.collect.HashBasedTable;
14 import com.google.common.collect.Lists;
15 import com.google.common.collect.Table;
17 import java.util.Collection;
18 import java.util.Date;
19 import java.util.HashMap;
20 import java.util.HashSet;
21 import java.util.List;
23 import java.util.Objects;
24 import org.opendaylight.yangtools.util.TopologicalSort;
25 import org.opendaylight.yangtools.util.TopologicalSort.Node;
26 import org.opendaylight.yangtools.util.TopologicalSort.NodeImpl;
27 import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
28 import org.opendaylight.yangtools.yang.common.YangVersion;
29 import org.opendaylight.yangtools.yang.model.api.Module;
30 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
31 import org.slf4j.Logger;
32 import org.slf4j.LoggerFactory;
35 * Creates a module dependency graph from provided {@link Module}s and provides a {@link #sort(Collection)} method.
36 * It is topological sort and returns modules in order in which they should be processed (e.g. if A imports B, sort
40 public final class ModuleDependencySort {
41 private static final Logger LOG = LoggerFactory.getLogger(ModuleDependencySort.class);
44 * It is not desirable to instance this class.
46 private ModuleDependencySort() {
47 throw new UnsupportedOperationException();
51 * Topological sort of module dependency graph.
53 * @param modules YANG modules
54 * @return Sorted list of Modules. Modules can be further processed in returned order.
55 * @throws IllegalArgumentException when provided modules are not consistent.
57 public static List<Module> sort(final Collection<Module> modules) {
58 return sort((Iterable<Module>)modules);
62 * Topological sort of module dependency graph.
64 * @param modules YANG modules
65 * @return Sorted list of Modules. Modules can be further processed in
67 * @throws IllegalArgumentException when provided modules are not consistent.
69 * @deprecated Use {@link #sort(Collection)} instead.
72 public static List<Module> sort(final Iterable<Module> modules) {
73 final List<Node> sorted = sortInternal(modules);
74 // Cast to Module from Node and return
75 return Lists.transform(sorted, input -> input == null ? null : ((ModuleNodeImpl) input).getReference());
78 private static List<Node> sortInternal(final Iterable<Module> modules) {
79 final Table<String, Date, ModuleNodeImpl> moduleGraph = createModuleGraph(modules);
80 return TopologicalSort.sort(new HashSet<>(moduleGraph.values()));
83 private static Table<String, Date, ModuleNodeImpl> createModuleGraph(final Iterable<Module> builders) {
84 final Table<String, Date, ModuleNodeImpl> moduleGraph = HashBasedTable.create();
86 processModules(moduleGraph, builders);
87 processDependencies(moduleGraph, builders);
93 * Extract module:revision from modules.
95 private static void processDependencies(final Table<String, Date, ModuleNodeImpl> moduleGraph,
96 final Iterable<Module> mmbs) {
97 final Map<URI, Module> allNS = new HashMap<>();
99 // Create edges in graph
100 for (final Module module : mmbs) {
101 final Map<String, Date> imported = new HashMap<>();
102 final String fromName = module.getName();
103 final URI ns = module.getNamespace();
104 Date fromRevision = module.getRevision();
106 // check for existence of module with same namespace
107 final Module prev = allNS.putIfAbsent(ns, module);
109 final String name = prev.getName();
110 if (!fromName.equals(name)) {
111 LOG.warn("Error while sorting module [{}, {}]: module with same namespace ({}) already loaded:"
112 + " [{}, {}]", fromName, fromRevision, ns, name, prev.getRevision());
116 // no need to check if other Type of object, check is performed in
119 if (fromRevision == null) {
120 fromRevision = DEFAULT_DATE_REV;
123 for (final ModuleImport imprt : module.getImports()) {
124 final String toName = imprt.getModuleName();
125 final Date toRevision = imprt.getRevision() == null ? DEFAULT_DATE_REV : imprt.getRevision();
127 final ModuleNodeImpl from = moduleGraph.get(fromName, fromRevision);
129 final ModuleNodeImpl to = getModuleByNameAndRevision(moduleGraph, fromName, fromRevision, toName,
133 * If it is an yang 1 module, check imports: If module is imported twice with different
134 * revisions then throw exception
136 if (YangVersion.VERSION_1.toString().equals(module.getYangVersion())) {
137 final Date impRevision = imported.get(toName);
138 if (impRevision != null && !impRevision.equals(toRevision)
139 && !DEFAULT_DATE_REV.equals(impRevision) && !DEFAULT_DATE_REV.equals(toRevision)) {
140 throw new IllegalArgumentException(String.format(
141 "Module:%s imported twice with different revisions:%s, %s", toName,
142 formatRevDate(impRevision), formatRevDate(toRevision)));
146 imported.put(toName, toRevision);
154 * Get imported module by its name and revision from moduleGraph.
156 private static ModuleNodeImpl getModuleByNameAndRevision(final Table<String, Date, ModuleNodeImpl> moduleGraph,
157 final String fromName, final Date fromRevision, final String toName, final Date toRevision) {
159 final ModuleNodeImpl exact = moduleGraph.get(toName, toRevision);
164 // If revision is not specified in import, but module exists with different revisions, take first one
165 if (DEFAULT_DATE_REV.equals(toRevision)) {
166 final Map<Date, ModuleNodeImpl> modulerevs = moduleGraph.row(toName);
168 if (!modulerevs.isEmpty()) {
169 final ModuleNodeImpl first = modulerevs.values().iterator().next();
170 if (LOG.isTraceEnabled()) {
171 LOG.trace("Import:{}:{} by module:{}:{} does not specify revision, using:{}:{}"
172 + " for module dependency sort", toName, formatRevDate(toRevision), fromName,
173 formatRevDate(fromRevision), first.getName(), formatRevDate(first.getRevision()));
179 LOG.warn("Not existing module imported:{}:{} by:{}:{}", toName, formatRevDate(toRevision), fromName,
180 formatRevDate(fromRevision));
181 LOG.warn("Available models: {}", moduleGraph);
182 throw new IllegalArgumentException(String.format("Not existing module imported:%s:%s by:%s:%s", toName,
183 formatRevDate(toRevision), fromName, formatRevDate(fromRevision)));
187 * Extract dependencies from modules to fill dependency graph.
189 private static void processModules(final Table<String, Date, ModuleNodeImpl> moduleGraph,
190 final Iterable<Module> modules) {
193 for (final Module momb : modules) {
195 final String name = momb.getName();
196 Date rev = momb.getRevision();
198 rev = DEFAULT_DATE_REV;
201 final Map<Date, ModuleNodeImpl> revs = moduleGraph.row(name);
202 if (revs.containsKey(rev)) {
203 throw new IllegalArgumentException(String.format("Module:%s with revision:%s declared twice", name,
204 formatRevDate(rev)));
207 revs.put(rev, new ModuleNodeImpl(name, rev, momb));
211 private static String formatRevDate(final Date rev) {
212 return rev.equals(DEFAULT_DATE_REV) ? "default" : SimpleDateFormatUtil.getRevisionFormat().format(rev);
215 private static final class ModuleNodeImpl extends NodeImpl {
216 private final String name;
217 private final Date revision;
218 private final Module originalObject;
220 ModuleNodeImpl(final String name, final Date revision, final Module module) {
222 this.revision = revision;
223 this.originalObject = module;
235 public int hashCode() {
236 final int prime = 31;
238 result = prime * result + Objects.hashCode(name);
239 result = prime * result + Objects.hashCode(revision);
244 public boolean equals(final Object obj) {
251 if (getClass() != obj.getClass()) {
254 final ModuleNodeImpl other = (ModuleNodeImpl) obj;
256 if (other.name != null) {
259 } else if (!name.equals(other.name)) {
262 if (revision == null) {
263 if (other.revision != null) {
266 } else if (!revision.equals(other.revision)) {
273 public String toString() {
274 return "Module [name=" + name + ", revision=" + formatRevDate(revision) + "]";
277 public Module getReference() {
278 return originalObject;