Minestom/src/main/java/net/minestom/server/extensions/DiscoveredExtension.java

169 lines
5.2 KiB
Java
Raw Normal View History

package net.minestom.server.extensions;
import lombok.extern.slf4j.Slf4j;
import org.jetbrains.annotations.NotNull;
2020-11-03 21:26:46 +01:00
import org.jetbrains.annotations.Nullable;
import java.io.File;
2020-10-25 19:58:19 +01:00
import java.net.URL;
import java.util.LinkedList;
import java.util.List;
2020-10-25 10:41:51 +01:00
@Slf4j(topic = "minestom-extensions")
final class DiscoveredExtension {
public static final String NAME_REGEX = "[A-Za-z][_A-Za-z0-9]+";
private String name;
private String entrypoint;
2020-10-25 10:41:51 +01:00
private String version;
private String mixinConfig;
private String[] authors;
private String[] codeModifiers;
private String[] dependencies;
private ExternalDependencies externalDependencies;
2020-10-25 19:58:19 +01:00
transient List<URL> files = new LinkedList<>();
2020-10-25 10:41:51 +01:00
transient LoadStatus loadStatus = LoadStatus.LOAD_SUCCESS;
2020-11-03 21:26:46 +01:00
transient private File originalJar;
@NotNull
public String getName() {
return name;
}
@NotNull
public String getEntrypoint() {
return entrypoint;
}
@NotNull
public String getVersion() {
return version;
}
2020-10-25 10:41:51 +01:00
@NotNull
public String getMixinConfig() {
return mixinConfig;
}
2020-10-25 10:41:51 +01:00
@NotNull
public String[] getAuthors() {
return authors;
}
2020-10-25 10:41:51 +01:00
@NotNull
public String[] getCodeModifiers() {
if (codeModifiers == null) {
codeModifiers = new String[0];
}
return codeModifiers;
}
@NotNull
public String[] getDependencies() {
return dependencies;
}
2020-10-25 10:41:51 +01:00
@NotNull
public ExternalDependencies getExternalDependencies() {
return externalDependencies;
}
2020-10-25 10:41:51 +01:00
2020-11-03 21:26:46 +01:00
void setOriginalJar(@Nullable File file) {
originalJar = file;
}
@Nullable
File getOriginalJar() {
return originalJar;
}
2020-10-25 10:41:51 +01:00
static void verifyIntegrity(@NotNull DiscoveredExtension extension) {
if (extension.name == null) {
StringBuilder fileList = new StringBuilder();
2020-10-25 19:58:19 +01:00
for (URL f : extension.files) {
fileList.append(f.toExternalForm()).append(", ");
2020-10-25 10:41:51 +01:00
}
log.error("Extension with no name. (at {}})", fileList);
log.error("Extension at ({}) will not be loaded.", fileList);
extension.loadStatus = DiscoveredExtension.LoadStatus.INVALID_NAME;
// To ensure @NotNull: name = INVALID_NAME
extension.name = extension.loadStatus.name();
return;
}
if (!extension.name.matches(NAME_REGEX)) {
log.error("Extension '{}' specified an invalid name.", extension.name);
log.error("Extension '{}' will not be loaded.", extension.name);
extension.loadStatus = DiscoveredExtension.LoadStatus.INVALID_NAME;
// To ensure @NotNull: name = INVALID_NAME
extension.name = extension.loadStatus.name();
return;
}
if (extension.entrypoint == null) {
log.error("Extension '{}' did not specify an entry point (via 'entrypoint').", extension.name);
log.error("Extension '{}' will not be loaded.", extension.name);
extension.loadStatus = DiscoveredExtension.LoadStatus.NO_ENTRYPOINT;
// To ensure @NotNull: entrypoint = NO_ENTRYPOINT
extension.entrypoint = extension.loadStatus.name();
return;
}
// Handle defaults
// If we reach this code, then the extension will most likely be loaded:
if (extension.version == null) {
log.warn("Extension '{}' did not specify a version.", extension.name);
log.warn("Extension '{}' will continue to load but should specify a plugin version.", extension.name);
extension.version = "Unspecified";
}
if (extension.mixinConfig == null) {
extension.mixinConfig = "";
}
if (extension.authors == null) {
extension.authors = new String[0];
}
if (extension.codeModifiers == null) {
extension.codeModifiers = new String[0];
}
// No dependencies were specified
if (extension.dependencies == null) {
extension.dependencies = new String[0];
}
// No external dependencies were specified;
if (extension.externalDependencies == null) {
extension.externalDependencies = new ExternalDependencies();
2020-10-25 10:41:51 +01:00
}
}
enum LoadStatus {
LOAD_SUCCESS("Actually, it did not fail. This message should not have been printed."),
MISSING_DEPENDENCIES("Missing dependencies, check your logs."),
INVALID_NAME("Invalid name."),
NO_ENTRYPOINT("No entrypoint specified."),
FAILED_TO_SETUP_CLASSLOADER("Extension classloader could not be setup."),
LOAD_FAILED("Load failed. See logs for more information."),
2020-10-25 10:41:51 +01:00
;
private final String message;
LoadStatus(@NotNull String message) {
this.message = message;
}
@NotNull
public String getMessage() {
return message;
}
}
static final class ExternalDependencies {
2020-10-25 10:41:51 +01:00
Repository[] repositories = new Repository[0];
String[] artifacts = new String[0];
static class Repository {
String name = "";
String url = "";
}
}
}