Mirror von
https://github.com/GeyserMC/Geyser.git
synchronisiert 2024-12-26 16:12:46 +01:00
Refactor extension description
Dieser Commit ist enthalten in:
Ursprung
40fde6b046
Commit
a5dc70a3b5
@ -50,13 +50,35 @@ public interface ExtensionDescription {
|
|||||||
@NonNull
|
@NonNull
|
||||||
String main();
|
String main();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the extension's major api version
|
||||||
|
*
|
||||||
|
* @return the extension's major api version
|
||||||
|
*/
|
||||||
|
int majorApiVersion();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the extension's minor api version
|
||||||
|
*
|
||||||
|
* @return the extension's minor api version
|
||||||
|
*/
|
||||||
|
int minorApiVersion();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the extension's patch api version
|
||||||
|
*
|
||||||
|
* @return the extension's patch api version
|
||||||
|
*/
|
||||||
|
int patchApiVersion();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the extension's api version
|
* Gets the extension's api version
|
||||||
*
|
*
|
||||||
* @return the extension's api version
|
* @return the extension's api version
|
||||||
*/
|
*/
|
||||||
@NonNull
|
default String apiVersion() {
|
||||||
String apiVersion();
|
return majorApiVersion() + "." + minorApiVersion() + "." + patchApiVersion();
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the extension's description
|
* Gets the extension's description
|
||||||
|
@ -25,53 +25,75 @@
|
|||||||
|
|
||||||
package org.geysermc.geyser.extension;
|
package org.geysermc.geyser.extension;
|
||||||
|
|
||||||
|
import org.checkerframework.checker.nullness.qual.NonNull;
|
||||||
import org.geysermc.geyser.api.extension.ExtensionDescription;
|
import org.geysermc.geyser.api.extension.ExtensionDescription;
|
||||||
import org.geysermc.geyser.api.extension.exception.InvalidDescriptionException;
|
import org.geysermc.geyser.api.extension.exception.InvalidDescriptionException;
|
||||||
import org.yaml.snakeyaml.DumperOptions;
|
import org.geysermc.geyser.text.GeyserLocale;
|
||||||
import org.yaml.snakeyaml.Yaml;
|
import org.yaml.snakeyaml.Yaml;
|
||||||
|
|
||||||
import java.io.Reader;
|
import java.io.Reader;
|
||||||
import java.util.*;
|
import java.util.*;
|
||||||
|
import java.util.regex.Pattern;
|
||||||
|
|
||||||
public record GeyserExtensionDescription(String name, String main, String apiVersion, String version, List<String> authors) implements ExtensionDescription {
|
public record GeyserExtensionDescription(@NonNull String name,
|
||||||
|
@NonNull String main,
|
||||||
|
int majorApiVersion,
|
||||||
|
int minorApiVersion,
|
||||||
|
int patchApiVersion,
|
||||||
|
@NonNull String version,
|
||||||
|
@NonNull List<String> authors) implements ExtensionDescription {
|
||||||
|
|
||||||
|
private static final Yaml YAML = new Yaml();
|
||||||
|
public static final Pattern NAME_PATTERN = Pattern.compile("^[A-Za-z_.-]*$");
|
||||||
|
public static final Pattern API_VERSION_PATTERN = Pattern.compile("^\\d+\\.\\d+\\.\\d+$");
|
||||||
|
|
||||||
|
@NonNull
|
||||||
@SuppressWarnings("unchecked")
|
@SuppressWarnings("unchecked")
|
||||||
public static GeyserExtensionDescription fromYaml(Reader reader) throws InvalidDescriptionException {
|
public static GeyserExtensionDescription fromYaml(Reader reader) throws InvalidDescriptionException {
|
||||||
DumperOptions dumperOptions = new DumperOptions();
|
Map<String, Object> map;
|
||||||
dumperOptions.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK);
|
try {
|
||||||
|
map = YAML.loadAs(reader, HashMap.class);
|
||||||
Yaml yaml = new Yaml(dumperOptions);
|
} catch (Exception e) {
|
||||||
Map<String, Object> yamlMap = yaml.loadAs(reader, LinkedHashMap.class);
|
throw new InvalidDescriptionException(e);
|
||||||
|
|
||||||
String name = ((String) yamlMap.get("name")).replaceAll("[^A-Za-z0-9 _.-]", "");
|
|
||||||
if (name.isBlank()) {
|
|
||||||
throw new InvalidDescriptionException("Invalid extension name, cannot be empty");
|
|
||||||
}
|
}
|
||||||
|
|
||||||
name = name.replace(" ", "_");
|
String name = require(map, "name");
|
||||||
String version = String.valueOf(yamlMap.get("version"));
|
if (!NAME_PATTERN.matcher(name).matches()) {
|
||||||
String main = (String) yamlMap.get("main");
|
throw new InvalidDescriptionException("Invalid extension name, must match: " + NAME_PATTERN.pattern());
|
||||||
String apiVersion;
|
|
||||||
|
|
||||||
Object api = yamlMap.get("api");
|
|
||||||
if (api instanceof String) {
|
|
||||||
apiVersion = (String) api;
|
|
||||||
} else {
|
|
||||||
throw new InvalidDescriptionException("Invalid api version format, should be a string: major.minor.patch");
|
|
||||||
}
|
}
|
||||||
|
String version = String.valueOf(map.get("version"));
|
||||||
|
String main = require(map, "main");
|
||||||
|
|
||||||
|
String apiVersion = require(map, "api");
|
||||||
|
if (!API_VERSION_PATTERN.matcher(apiVersion).matches()) {
|
||||||
|
throw new InvalidDescriptionException(GeyserLocale.getLocaleStringLog("geyser.extensions.load.failed_api_format", name, apiVersion));
|
||||||
|
}
|
||||||
|
String[] api = apiVersion.split("\\.");
|
||||||
|
int majorApi = Integer.parseUnsignedInt(api[0]);
|
||||||
|
int minorApi = Integer.parseUnsignedInt(api[1]);
|
||||||
|
int patchApi = Integer.parseUnsignedInt(api[2]);
|
||||||
|
|
||||||
List<String> authors = new ArrayList<>();
|
List<String> authors = new ArrayList<>();
|
||||||
if (yamlMap.containsKey("author")) {
|
if (map.containsKey("author")) {
|
||||||
authors.add((String) yamlMap.get("author"));
|
authors.add(String.valueOf(map.get("author")));
|
||||||
}
|
}
|
||||||
|
if (map.containsKey("authors")) {
|
||||||
if (yamlMap.containsKey("authors")) {
|
|
||||||
try {
|
try {
|
||||||
authors.addAll((Collection<? extends String>) yamlMap.get("authors"));
|
authors.addAll((Collection<? extends String>) map.get("authors"));
|
||||||
} catch (Exception e) {
|
} catch (Exception e) {
|
||||||
throw new InvalidDescriptionException("Invalid authors format, should be a list of strings", e);
|
throw new InvalidDescriptionException("Invalid authors format, should be a list of strings", e);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return new GeyserExtensionDescription(name, main, apiVersion, version, authors);
|
return new GeyserExtensionDescription(name, main, majorApi, minorApi, patchApi, version, authors);
|
||||||
|
}
|
||||||
|
|
||||||
|
@NonNull
|
||||||
|
private static String require(Map<String, Object> desc, String key) throws InvalidDescriptionException {
|
||||||
|
Object value = desc.get(key);
|
||||||
|
if (value instanceof String) {
|
||||||
|
return (String) value;
|
||||||
|
}
|
||||||
|
throw new InvalidDescriptionException("Extension description is missing string property '" + key + "'");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -39,25 +39,24 @@ import org.geysermc.geyser.extension.event.GeyserExtensionEventBus;
|
|||||||
import org.geysermc.geyser.text.GeyserLocale;
|
import org.geysermc.geyser.text.GeyserLocale;
|
||||||
|
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
|
import java.io.Reader;
|
||||||
import java.nio.file.*;
|
import java.nio.file.*;
|
||||||
import java.util.HashMap;
|
import java.util.HashMap;
|
||||||
import java.util.LinkedHashMap;
|
import java.util.LinkedHashMap;
|
||||||
import java.util.Map;
|
import java.util.Map;
|
||||||
import java.util.Objects;
|
|
||||||
import java.util.regex.Pattern;
|
import java.util.regex.Pattern;
|
||||||
import java.util.stream.Stream;
|
import java.util.stream.Stream;
|
||||||
|
|
||||||
@RequiredArgsConstructor
|
@RequiredArgsConstructor
|
||||||
public class GeyserExtensionLoader extends ExtensionLoader {
|
public class GeyserExtensionLoader extends ExtensionLoader {
|
||||||
private static final Path EXTENSION_DIRECTORY = Paths.get("extensions");
|
private static final Path EXTENSION_DIRECTORY = Paths.get("extensions");
|
||||||
private static final Pattern API_VERSION_PATTERN = Pattern.compile("^\\d+\\.\\d+\\.\\d+$");
|
|
||||||
private static final Pattern[] EXTENSION_FILTERS = new Pattern[] { Pattern.compile("^.+\\.jar$") };
|
private static final Pattern[] EXTENSION_FILTERS = new Pattern[] { Pattern.compile("^.+\\.jar$") };
|
||||||
|
|
||||||
private final Object2ReferenceMap<String, Class<?>> classes = new Object2ReferenceOpenHashMap<>();
|
private final Object2ReferenceMap<String, Class<?>> classes = new Object2ReferenceOpenHashMap<>();
|
||||||
private final Map<String, GeyserExtensionClassLoader> classLoaders = new HashMap<>();
|
private final Map<String, GeyserExtensionClassLoader> classLoaders = new HashMap<>();
|
||||||
private final Map<Extension, GeyserExtensionContainer> extensionContainers = new HashMap<>();
|
private final Map<Extension, GeyserExtensionContainer> extensionContainers = new HashMap<>();
|
||||||
|
|
||||||
public GeyserExtensionContainer loadExtension(Path path, GeyserExtensionDescription description) throws InvalidExtensionException, InvalidDescriptionException {
|
public GeyserExtensionContainer loadExtension(Path path, GeyserExtensionDescription description) throws InvalidExtensionException {
|
||||||
if (path == null) {
|
if (path == null) {
|
||||||
throw new InvalidExtensionException("Path is null");
|
throw new InvalidExtensionException("Path is null");
|
||||||
}
|
}
|
||||||
@ -94,7 +93,9 @@ public class GeyserExtensionLoader extends ExtensionLoader {
|
|||||||
Map<String, String> environment = new HashMap<>();
|
Map<String, String> environment = new HashMap<>();
|
||||||
try (FileSystem fileSystem = FileSystems.newFileSystem(path, environment, null)) {
|
try (FileSystem fileSystem = FileSystems.newFileSystem(path, environment, null)) {
|
||||||
Path extensionYml = fileSystem.getPath("extension.yml");
|
Path extensionYml = fileSystem.getPath("extension.yml");
|
||||||
return GeyserExtensionDescription.fromYaml(Files.newBufferedReader(extensionYml));
|
try (Reader reader = Files.newBufferedReader(extensionYml)) {
|
||||||
|
return GeyserExtensionDescription.fromYaml(reader);
|
||||||
|
}
|
||||||
} catch (IOException ex) {
|
} catch (IOException ex) {
|
||||||
throw new InvalidDescriptionException("Failed to load extension description for " + path, ex);
|
throw new InvalidDescriptionException("Failed to load extension description for " + path, ex);
|
||||||
}
|
}
|
||||||
@ -149,9 +150,6 @@ public class GeyserExtensionLoader extends ExtensionLoader {
|
|||||||
|
|
||||||
try {
|
try {
|
||||||
GeyserExtensionDescription description = this.extensionDescription(path);
|
GeyserExtensionDescription description = this.extensionDescription(path);
|
||||||
if (description == null) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
String name = description.name();
|
String name = description.name();
|
||||||
if (extensions.containsKey(name) || extensionManager.extension(name) != null) {
|
if (extensions.containsKey(name) || extensionManager.extension(name) != null) {
|
||||||
@ -159,30 +157,15 @@ public class GeyserExtensionLoader extends ExtensionLoader {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
int majorVersion = Geyser.api().majorApiVersion();
|
|
||||||
int minorVersion = Geyser.api().minorApiVersion();
|
|
||||||
|
|
||||||
try {
|
|
||||||
// Check the format: majorVersion.minorVersion.patch
|
|
||||||
if (!API_VERSION_PATTERN.matcher(description.apiVersion()).matches()) {
|
|
||||||
throw new IllegalArgumentException();
|
|
||||||
}
|
|
||||||
} catch (NullPointerException | IllegalArgumentException e) {
|
|
||||||
GeyserImpl.getInstance().getLogger().error(GeyserLocale.getLocaleStringLog("geyser.extensions.load.failed_api_format", name, majorVersion + "." + minorVersion));
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
String[] versionArray = description.apiVersion().split("\\.");
|
|
||||||
|
|
||||||
// Completely different API version
|
// Completely different API version
|
||||||
if (Integer.parseInt(versionArray[0]) != majorVersion) {
|
if (description.majorApiVersion() != Geyser.api().majorApiVersion()) {
|
||||||
GeyserImpl.getInstance().getLogger().error(GeyserLocale.getLocaleStringLog("geyser.extensions.load.failed_api_version", name, majorVersion + "." + minorVersion));
|
GeyserImpl.getInstance().getLogger().error(GeyserLocale.getLocaleStringLog("geyser.extensions.load.failed_api_version", name, description.apiVersion()));
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
// If the extension requires new API features, being backwards compatible
|
// If the extension requires new API features, being backwards compatible
|
||||||
if (Integer.parseInt(versionArray[1]) > minorVersion) {
|
if (description.minorApiVersion() > Geyser.api().minorApiVersion()) {
|
||||||
GeyserImpl.getInstance().getLogger().error(GeyserLocale.getLocaleStringLog("geyser.extensions.load.failed_api_version", name, majorVersion + "." + minorVersion));
|
GeyserImpl.getInstance().getLogger().error(GeyserLocale.getLocaleStringLog("geyser.extensions.load.failed_api_version", name, description.apiVersion()));
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
Laden…
In neuem Issue referenzieren
Einen Benutzer sperren