/
PluginManager.java
165 lines (151 loc) · 7.97 KB
/
PluginManager.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
package de.cubeside.globalserver.plugin;
import com.vdurmont.semver4j.Requirement;
import com.vdurmont.semver4j.Semver;
import de.cubeside.globalserver.GlobalServer;
import de.cubeside.globalserver.plugin.PluginDependency.LoadOrder;
import de.cubeside.globalserver.plugin.PluginDependency.Type;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.function.Function;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
public class PluginManager {
public final static Logger LOGGER = LogManager.getLogger("PluginManager");
private static final Function<PluginContext, HashSet<PluginContext>> HASH_SET_CREATOR = (c) -> new HashSet<>();
private final GlobalServer server;
private LinkedHashMap<String, PluginContext> pluginContexts;
private Collection<Plugin> plugins;
PluginManager(GlobalServer server) {
this.server = server;
}
void loadPlugins() throws PluginLoadException {
LOGGER.info("Resolving plugins..");
LinkedHashMap<String, PluginContext> pluginContexts = new LinkedHashMap<>();
File[] pluginFiles = server.getPluginFolder().listFiles(f -> f.isFile() && f.getName().endsWith(".jar"));
Arrays.sort(pluginFiles, (f1, f2) -> f1.getName().compareTo(f2.getName()));// guarantee a consistent load order
for (File jarFile : pluginFiles) {
PluginDescription description = new PluginDescription(jarFile);
if (pluginContexts.put(description.getName(), new PluginContext(server, description)) != null) {
throw new PluginLoadException("Duplicate plugin " + description.getName());
}
}
// check for missing dependencies
HashMap<PluginContext, HashSet<PluginContext>> allLoadBefore = new HashMap<>();
for (PluginContext context : pluginContexts.values()) {
HashSet<PluginContext> dependencies = new HashSet<>();
for (PluginDependency dependency : context.getDescription().getDependencies()) {
PluginContext resolvedDependency = pluginContexts.get(dependency.plugin());
if (resolvedDependency != null) {
Semver dependencyVersion = resolvedDependency.getDescription().getVersion();
boolean matchesAny = false;
for (Requirement requiredVersion : dependency.version()) {
if (dependencyVersion.satisfies(requiredVersion)) {
matchesAny = true;
break;
}
}
if (!matchesAny) {
throw new PluginLoadException("Plugin " + resolvedDependency.getDescription().getName() + " does not have the required version for " + context.getDescription().getName() + ": " + Arrays.toString(dependency.version()));
}
addDependenciesRecursive(pluginContexts, dependencies, resolvedDependency, dependency.loadOrder(), context, allLoadBefore);
} else if (dependency.type() == Type.REQUIRED) {
throw new PluginLoadException("Plugin " + context.getDescription().getName() + " is missing the required dependency " + dependency.plugin());
}
}
// set classloader alternatives
ArrayList<PluginClassLoader> dependencyLoaders = new ArrayList<>();
for (PluginContext otherContext : dependencies) {
if (otherContext != context) {
dependencyLoaders.add(otherContext.getClassLoader());
}
}
// LOGGER.info("Dependencies for " + context.getDescription().getName() + " " + context.getDescription().getVersion() + ": " + dependencyLoaders.stream().map(d -> d.getPlugin().getName()).toList());
context.getClassLoader().setDependencyClassLoades(dependencyLoaders);
}
// check for circular dependencies
ArrayList<PluginContext> notOrderedIn = new ArrayList<>();
for (PluginContext context : pluginContexts.values()) {
HashSet<PluginContext> deps = allLoadBefore.get(context);
if (deps != null && deps.contains(context)) {
throw new PluginLoadException("Circular dependencies for plugin " + context.getDescription().getName());
}
notOrderedIn.add(context);
}
// reorder plugins
HashSet<PluginContext> orderedIn = new HashSet<>();
LinkedHashMap<String, PluginContext> newPluginContexts = new LinkedHashMap<>();
while (!notOrderedIn.isEmpty()) {
Iterator<PluginContext> it = notOrderedIn.iterator();
nextPlugin: while (it.hasNext()) {
PluginContext plugin = it.next();
HashSet<PluginContext> loadBeforeThis = allLoadBefore.get(plugin);
if (loadBeforeThis != null) {
for (PluginContext e : loadBeforeThis) {
if (!orderedIn.contains(e)) {
continue nextPlugin;
}
}
}
orderedIn.add(plugin);
newPluginContexts.put(plugin.getDescription().getName(), plugin);
it.remove();
}
}
// LOGGER.info("Plugin load order: " + newPluginContexts.keySet());
pluginContexts = newPluginContexts;
// start loading the plugins
for (PluginContext context : pluginContexts.values()) {
try {
LOGGER.info("Loading plugin " + context.getDescription().getName());
context.createMainClassInstance();
} catch (Exception e) {
throw new PluginLoadException("Could not load the plugin " + context.getDescription().getName(), e);
}
}
this.pluginContexts = pluginContexts;
this.plugins = Collections.unmodifiableList(pluginContexts.values().stream().map(c -> c.getMainClassInstance()).toList());
}
void shutdown() {
if (this.pluginContexts != null) {
for (PluginContext context : this.pluginContexts.values()) {
try {
context.getClassLoader().close();
} catch (IOException e) {
LOGGER.error("Could not close ClassLoader for " + context.getDescription().getName(), e);
}
}
}
}
private void addDependenciesRecursive(HashMap<String, PluginContext> pluginContexts, HashSet<PluginContext> dependencies, PluginContext dependency, LoadOrder loadOrder, PluginContext initialPlugin, HashMap<PluginContext, HashSet<PluginContext>> allLoadBefore) {
if (loadOrder == LoadOrder.BEFORE) {
HashSet<PluginContext> set = allLoadBefore.computeIfAbsent(initialPlugin, HASH_SET_CREATOR);
set.add(dependency);
} else if (loadOrder == LoadOrder.AFTER) {
HashSet<PluginContext> set = allLoadBefore.computeIfAbsent(dependency, HASH_SET_CREATOR);
set.add(initialPlugin);
}
if (dependencies.add(dependency)) {
for (PluginDependency nextDependency : dependency.getDescription().getDependencies()) {
PluginContext resolvedDependency = pluginContexts.get(nextDependency.plugin());
if (resolvedDependency != null) {
addDependenciesRecursive(pluginContexts, dependencies, resolvedDependency, nextDependency.loadOrder() == loadOrder ? loadOrder : LoadOrder.ANY, initialPlugin, allLoadBefore);
}
}
}
}
public Collection<Plugin> getPlugins() {
return plugins;
}
public Plugin getPlugin(String name) {
PluginContext context = pluginContexts.get(name);
return context != null ? context.getMainClassInstance() : null;
}
}