Mirror/Grasscutter
1
0
Fork 0
mirror of https://github.com/Grasscutters/Grasscutter.git synced 2026-03-25 00:53:47 +01:00
Code Issues Packages Projects Releases Wiki Activity

Require plugins to specify an API version and match with the server

Browse Source
This commit is contained in:
KingRainbow44
2023-05-31 22:20:01 -04:00
parent 44a557a1dc
commit e7f30f4d43
14 changed files with 153 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/main/java/emu/grasscutter/plugin/PluginConfig.java
View File

@@ -4,6 +4,7 @@ package emu.grasscutter.plugin;
public final class PluginConfig {
public String name, description, version;
public String mainClass;
public Integer api;
public String[] authors;
public String[] loadAfter;
@@ -14,6 +15,7 @@ public final class PluginConfig {
*/
@SuppressWarnings("BooleanMethodIsAlwaysInverted")
public boolean validate() {
return name != null && description != null && mainClass != null;
return name != null && description != null &&
mainClass != null && api != null;
}
}

48
src/main/java/emu/grasscutter/plugin/PluginManager.java
View File

@@ -1,28 +1,28 @@
package emu.grasscutter.plugin;
import emu.grasscutter.Grasscutter;
import emu.grasscutter.server.event.*;
import emu.grasscutter.utils.*;
import lombok.*;
import javax.annotation.Nullable;
import java.io.*;
import java.lang.reflect.Method;
import java.net.*;
import java.util.*;
import java.util.jar.*;
import static emu.grasscutter.utils.lang.Language.translate;
import emu.grasscutter.Grasscutter;
import emu.grasscutter.server.event.Event;
import emu.grasscutter.server.event.EventHandler;
import emu.grasscutter.utils.FileUtils;
import emu.grasscutter.utils.JsonUtils;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.InputStreamReader;
import java.lang.reflect.Method;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.*;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import javax.annotation.Nullable;
import lombok.AllArgsConstructor;
import lombok.Getter;
/** Manages the server's plugins and the event system. */
public final class PluginManager {
/*
* This should only be changed when a breaking change is made to the plugin API.
* A 'breaking change' is something which changes the existing logic of the API.
*/
@SuppressWarnings("FieldCanBeLocal")
private static int API_VERSION = 2;
/* All loaded plugins. */
private final Map<String, Plugin> plugins = new LinkedHashMap<>();
/* All currently registered listeners per plugin. */
@@ -78,6 +78,16 @@ public final class PluginManager {
// Create a plugin config instance from the config file.
PluginConfig pluginConfig = JsonUtils.loadToClass(fileReader, PluginConfig.class);
// Check the plugin's API version.
if (pluginConfig.api == null) {
Grasscutter.getLogger().warn(translate("plugin.invalid_api.not_present", plugin.getName()));
return;
} else if (pluginConfig.api != API_VERSION) {
Grasscutter.getLogger().warn(translate("plugin.invalid_api.lower",
plugin.getName(), pluginConfig.api, API_VERSION));
return;
}
// Check if the plugin config is valid.
if (!pluginConfig.validate()) {
Grasscutter.getLogger().warn(translate("plugin.invalid_config", plugin.getName()));