Merge pull request #98 from Multiverse/ben/mv5/core-support

Initial support for MV5 core and hk2 injection

Author: benwoo1110

build.gradle

@@ -6,10 +6,14 @@ plugins {
 }
 
 version = System.getenv('GITHUB_VERSION') ?: 'local'
-group = 'com.onarandombox.multiversesignportals'
+group = 'org.mvplugins.multiverse.signportals'
 description = 'Multiverse-SignPortals'
 
-java.sourceCompatibility = JavaVersion.VERSION_11
+java {
+    toolchain {
+        languageVersion.set(JavaLanguageVersion.of(17))
+    }
+}
 
 repositories {
     mavenLocal()
@@ -24,16 +28,22 @@ repositories {
         name = 'onarandombox'
         url = uri('https://repo.onarandombox.com/content/groups/public/')
     }
+
+    maven {
+        // todo: remove before mv5 release
+        name = 'benwoo1110'
+        url = uri('https://repo.c0ding.party/multiverse-beta')
+    }
 }
 
 dependencies {
     // Spigot
-    implementation('org.bukkit:bukkit:1.13.2-R0.1-SNAPSHOT') {
+    implementation('org.spigotmc:spigot-api:1.18.2-R0.1-SNAPSHOT') {
         exclude group: 'junit', module: 'junit'
     }
 
     // Core
-    implementation 'com.onarandombox.multiversecore:Multiverse-Core:4.2.2'
+    implementation 'org.mvplugins.multiverse.core:multiverse-core:5.0.0-SNAPSHOT'
 
     // Utils
     api('com.dumptruckman.minecraft:Logging:1.1.1') {
@@ -55,7 +65,6 @@ tasks.withType(Javadoc).configureEach {
     options.encoding = 'UTF-8'
 }
 
-
 configurations {
     [apiElements, runtimeElements].each {
         it.outgoing.artifacts.removeIf { it.buildDependencies.getDependencies(null).contains(jar) }
@@ -112,8 +121,8 @@ javadoc {
 project.configurations.api.canBeResolved = true
 
 shadowJar {
-    relocate 'com.dumptruckman.minecraft.util.Logging', 'com.onarandombox.MultiverseSignPortals.util.MVSPLogging'
-    relocate 'com.dumptruckman.minecraft.util.DebugLog', 'com.onarandombox.MultiverseSignPortals.util.DebugFileLogger'
+    relocate 'com.dumptruckman.minecraft.util.Logging', 'org.mvplugins.multiverse.signportals.util.MVSPLogging'
+    relocate 'com.dumptruckman.minecraft.util.DebugLog', 'org.mvplugins.multiverse.signportals.util.DebugFileLogger'
 
     configurations = [project.configurations.api]
 
@@ -122,3 +131,14 @@ shadowJar {
 
 build.dependsOn shadowJar
 jar.enabled = false
+
+tasks.register('runHabitatGenerator', JavaExec) {
+    classpath = configurations["compileClasspath"]
+    main = 'org.mvplugins.multiverse.external.jvnet.hk2.generator.HabitatGenerator'
+
+    args = [
+            '--file', "build/libs/multiverse-signportals-$version" + ".jar",
+            '--locator', 'Multiverse-SignPortals',
+    ]
+}
+tasks.named("build") { finalizedBy("runHabitatGenerator") }

src/main/java/com/onarandombox/MultiverseSignPortals/listeners/MVSPTravelAgent.java

@@ -5,30 +5,35 @@
  * with this project.
  */
 
-package com.onarandombox.MultiverseSignPortals;
+package org.mvplugins.multiverse.signportals;
 
 import com.dumptruckman.minecraft.util.Logging;
-import com.onarandombox.MultiverseCore.MultiverseCore;
-import com.onarandombox.MultiverseCore.api.MVPlugin;
-import com.onarandombox.MultiverseSignPortals.listeners.MVSPBlockListener;
-import com.onarandombox.MultiverseSignPortals.listeners.MVSPPlayerListener;
-import com.onarandombox.MultiverseSignPortals.listeners.MVSPPluginListener;
-import com.onarandombox.MultiverseSignPortals.listeners.MVSPVersionListener;
-import com.onarandombox.MultiverseSignPortals.utils.PortalDetector;
-import org.bukkit.plugin.PluginManager;
+import org.mvplugins.multiverse.core.MultiverseCore;
+import org.mvplugins.multiverse.core.api.config.MVCoreConfig;
+import org.mvplugins.multiverse.core.inject.PluginServiceLocator;
+import org.mvplugins.multiverse.core.submodules.MVCore;
+import org.mvplugins.multiverse.core.submodules.MVPlugin;
+import org.mvplugins.multiverse.external.jvnet.hk2.annotations.Service;
+import org.mvplugins.multiverse.external.vavr.control.Option;
+import org.mvplugins.multiverse.external.vavr.control.Try;
 import org.bukkit.plugin.java.JavaPlugin;
+import org.mvplugins.multiverse.signportals.listeners.SignPortalsListener;
 
 import java.util.logging.Level;
 
+@Service
 public class MultiverseSignPortals extends JavaPlugin implements MVPlugin {
 
-    protected MultiverseCore core;
-    protected MVSPPlayerListener playerListener;
-    protected MVSPPluginListener pluginListener;
-    protected MVSPBlockListener blockListener;
-    private final static int requiresProtocol = 24;
+    private MultiverseCore core;
+    private PluginServiceLocator serviceLocator;
 
-    private PortalDetector portalDetector;
+    private final static int requiresProtocol = 50;
+
+    /** This fires before I get Enabled. */
+    public void onLoad() {
+        Logging.init(this);
+        this.getDataFolder().mkdirs();
+    }
 
     public void onEnable() {
         Logging.init(this);
@@ -50,44 +55,60 @@ public void onEnable() {
             return;
         }
 
-        Logging.setDebugLevel(core.getMVConfig().getGlobalDebug());
+        initializeDependencyInjection();
+        registerEvents();
+        Logging.setDebugLevel(serviceLocator.getActiveService(MVCoreConfig.class).getGlobalDebug());
 
         this.core.incrementPluginCount();
-
-        // Init our listeners
-        this.pluginListener = new MVSPPluginListener(this);
-        this.playerListener = new MVSPPlayerListener(this);
-        this.blockListener = new MVSPBlockListener(this);
-
-        // Init our events
-        PluginManager pm = this.getServer().getPluginManager();
-        pm.registerEvents(this.pluginListener, this);
-        pm.registerEvents(this.playerListener, this);
-        pm.registerEvents(this.blockListener, this);
-        pm.registerEvents(new MVSPVersionListener(this), this);
-
-        this.portalDetector = new PortalDetector(this);
-
         Logging.log(true, Level.INFO, " Enabled - By %s", getAuthors());
     }
 
     public void onDisable() {
         // The Usual
+        shutdownDependencyInjection();
         Logging.info("- Disabled");
     }
 
-    /** This fires before I get Enabled. */
-    public void onLoad() {
-        Logging.init(this);
-        this.getDataFolder().mkdirs();
+    private void initializeDependencyInjection() {
+        serviceLocator = core.getServiceLocatorFactory()
+                .registerPlugin(new MultiverseSignPortalsPluginBinder(this), core.getServiceLocator())
+                .flatMap(PluginServiceLocator::enable)
+                .getOrElseThrow(exception -> {
+                    Logging.severe("Failed to initialize dependency injection!");
+                    getServer().getPluginManager().disablePlugin(this);
+                    return new RuntimeException(exception);
+                });
+    }
+
+    private void shutdownDependencyInjection() {
+        Option.of(serviceLocator)
+                .peek(PluginServiceLocator::disable)
+                .peek(ignore -> serviceLocator = null);
+    }
+
+    /**
+     * Function to Register all the Events needed.
+     */
+    private void registerEvents() {
+        var pluginManager = getServer().getPluginManager();
+
+        Try.run(() -> serviceLocator.getAllServices(SignPortalsListener.class).forEach(
+                        listener -> {
+                            Logging.info(listener.toString());
+                            pluginManager.registerEvents(listener, this);
+                        }))
+                .onFailure(e -> {
+                    throw new RuntimeException("Failed to register listeners. Terminating...", e);
+                });
     }
 
     /**
      * Parse the Authors Array into a readable String with ',' and 'and'.
      *
      * @return An comma separated string of authors
      */
-    private String getAuthors() {
+    @Override
+    public String getAuthors() {
         String authors = "";
         for (int i = 0; i < this.getDescription().getAuthors().size(); i++) {
             if (i == this.getDescription().getAuthors().size() - 1) {
@@ -99,55 +120,22 @@ private String getAuthors() {
         return authors.substring(2);
     }
 
-    /**
-     * {@inheritDoc}
-     *
-     * @deprecated This is now deprecated, nobody needs it any longer.
-     * All logging is now done with {@link Logging}.
-     */
-    @Override
-    @Deprecated
-    public void log(Level level, String msg) {
-        Logging.log(level, msg);
-    }
-
-    // No longer using, use getVersionInfo instead.
     @Override
-    @Deprecated
-    public String dumpVersionInfo(String buffer) {
-        buffer += logAndAddToPasteBinBuffer(this.getVersionInfo());
-        return buffer;
+    public PluginServiceLocator getServiceLocator() {
+        return serviceLocator;
     }
 
     public String getVersionInfo() {
         return "[Multiverse-SignPortals] Multiverse-SignPortals Version: " + this.getDescription().getVersion() + '\n';
     }
 
-    // No longer using, use getVersionInfo instead.
-    @Deprecated
-    private String logAndAddToPasteBinBuffer(String string) {
-        Logging.info(string);
-        return Logging.getPrefixedMessage(string, false);
-    }
-
     @Override
-    public MultiverseCore getCore() {
+    public MVCore getCore() {
         return this.core;
     }
 
-    @Override
-    public void setCore(MultiverseCore core) {
-        this.core = core;
-    }
-
     @Override
     public int getProtocolVersion() {
         return 1;
     }
-
-    public PortalDetector getPortalDetector() {
-        return this.portalDetector;
-    }
-
-
 }

src/main/java/com/onarandombox/MultiverseSignPortals/utils/PortalLocation.java

@@ -0,0 +1,19 @@
+package org.mvplugins.multiverse.signportals;
+
+import org.mvplugins.multiverse.core.inject.binder.JavaPluginBinder;
+import org.mvplugins.multiverse.core.submodules.MVPlugin;
+import org.mvplugins.multiverse.external.glassfish.hk2.utilities.binding.ScopedBindingBuilder;
+import org.mvplugins.multiverse.external.jetbrains.annotations.NotNull;
+
+public class MultiverseSignPortalsPluginBinder extends JavaPluginBinder<MultiverseSignPortals> {
+
+    protected MultiverseSignPortalsPluginBinder(@NotNull MultiverseSignPortals plugin) {
+        super(plugin);
+    }
+
+    @Override
+    protected ScopedBindingBuilder<MultiverseSignPortals> bindPluginClass(
+            ScopedBindingBuilder<MultiverseSignPortals> bindingBuilder) {
+        return super.bindPluginClass(bindingBuilder).to(MVPlugin.class).to(MultiverseSignPortals.class);
+    }
+}

…seSignPortals/MultiverseSignPortals.java …e/signportals/MultiverseSignPortals.javasrc/main/java/com/onarandombox/MultiverseSignPortals/MultiverseSignPortals.java renamed to src/main/java/org/mvplugins/multiverse/signportals/MultiverseSignPortals.java src/main/java/com/onarandombox/MultiverseSignPortals/MultiverseSignPortals.java renamed to src/main/java/org/mvplugins/multiverse/signportals/MultiverseSignPortals.java

@@ -1,17 +1,17 @@
-/*
- * Multiverse 2 Copyright (c) the Multiverse Team 2011.
- * Multiverse 2 is licensed under the BSD License.
- * For more information please check the README.md file included
- * with this project.
- */
-
-package com.onarandombox.MultiverseSignPortals.enums;
-
-/**
- * Multiverse 2
- *
- * @author fernferret
- */
-public enum Axis {
-    X, Z
-}
+/*
+ * Multiverse 2 Copyright (c) the Multiverse Team 2011.
+ * Multiverse 2 is licensed under the BSD License.
+ * For more information please check the README.md file included
+ * with this project.
+ */
+
+package org.mvplugins.multiverse.signportals.enums;
+
+/**
+ * Multiverse 2
+ *
+ * @author fernferret
+ */
+public enum Axis {
+    X, Z
+}

src/main/java/org/mvplugins/multiverse/signportals/MultiverseSignPortalsPluginBinder.java

@@ -1,11 +1,11 @@
-/*
- * Multiverse 2 Copyright (c) the Multiverse Team 2011.
- * Multiverse 2 is licensed under the BSD License.
- * For more information please check the README.md file included
- * with this project.
- */
-
-package com.onarandombox.MultiverseSignPortals.exceptions;
-
-public class MoreThanOneSignFoundException extends Exception {
-}
+/*
+ * Multiverse 2 Copyright (c) the Multiverse Team 2011.
+ * Multiverse 2 is licensed under the BSD License.
+ * For more information please check the README.md file included
+ * with this project.
+ */
+
+package org.mvplugins.multiverse.signportals.exceptions;
+
+public class MoreThanOneSignFoundException extends Exception {
+}