Implement action handler to support command execution and bungeecord proxy

build.gradle

@@ -15,6 +15,10 @@ repositories {
         name = 'benthecat'
         url = uri('https://repo.c0ding.party/multiverse-beta')
     }
+    maven {
+        name = "helpchatRepoReleases"
+        url = uri("https://repo.helpch.at/releases/")
+    }
 }
 
 configure(apiDependencies) {
@@ -32,6 +36,9 @@ dependencies {
         exclude group: 'org.bukkit', module: 'bukkit'
     }
 
+    // PlaceholderAPI
+    externalPlugin 'me.clip:placeholderapi:2.11.6'
+
     // Utils
     shadowed('com.dumptruckman.minecraft:Logging:1.1.1') {
         exclude group: 'junit', module: 'junit'

src/main/java/org/mvplugins/multiverse/portals/MVPortal.java

@@ -9,16 +9,22 @@
 
 import java.util.Arrays;
 import java.util.Collection;
+import java.util.Date;
 import java.util.HashSet;
 import java.util.List;
+import java.util.Objects;
 import java.util.Set;
 import java.util.Stack;
 import java.util.regex.Pattern;
 
 import com.dumptruckman.minecraft.util.Logging;
+import org.bukkit.Bukkit;
+import org.bukkit.command.CommandSender;
 import org.bukkit.configuration.ConfigurationSection;
+import org.bukkit.entity.Entity;
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.Nullable;
+import org.mvplugins.multiverse.core.command.MVCommandManager;
 import org.mvplugins.multiverse.core.config.handle.MemoryConfigurationHandle;
 import org.mvplugins.multiverse.core.config.handle.StringPropertyHandle;
 import org.mvplugins.multiverse.core.config.migration.ConfigMigrator;
@@ -27,9 +33,16 @@
 import org.mvplugins.multiverse.core.destination.DestinationInstance;
 import org.mvplugins.multiverse.core.destination.DestinationsProvider;
 import org.mvplugins.multiverse.core.teleportation.BlockSafety;
+import org.mvplugins.multiverse.core.utils.result.Attempt;
+import org.mvplugins.multiverse.core.utils.text.ChatTextFormatter;
 import org.mvplugins.multiverse.core.world.LoadedMultiverseWorld;
 import org.mvplugins.multiverse.core.world.WorldManager;
+import org.mvplugins.multiverse.external.vavr.control.Option;
 import org.mvplugins.multiverse.external.vavr.control.Try;
+import org.mvplugins.multiverse.portals.action.ActionFailureReason;
+import org.mvplugins.multiverse.portals.action.ActionHandler;
+import org.mvplugins.multiverse.portals.action.ActionHandlerProvider;
+import org.mvplugins.multiverse.portals.action.ActionHandlerType;
 import org.mvplugins.multiverse.portals.config.PortalsConfig;
 import org.mvplugins.multiverse.portals.enums.PortalType;
 import org.bukkit.Location;
@@ -62,6 +75,8 @@
     private final WorldManager worldManager;
     private final DestinationsProvider destinationsProvider;
     private final BlockSafety blockSafety;
+    private final ActionHandlerProvider actionHandlerProvider;
+    private final MVCommandManager commandManager;
 
     private final String name;
     private final MVPortalNodes configNodes;
@@ -94,16 +109,24 @@
         this.worldManager = this.plugin.getServiceLocator().getService(WorldManager.class);
         this.destinationsProvider = this.plugin.getServiceLocator().getService(DestinationsProvider.class);
         this.blockSafety = this.plugin.getServiceLocator().getService(BlockSafety.class);
+        this.actionHandlerProvider = this.plugin.getServiceLocator().getService(ActionHandlerProvider.class);
+        this.commandManager = this.plugin.getServiceLocator().getService(MVCommandManager.class);
 
         this.name = name;
 
         var config = this.plugin.getPortalsConfig();
         this.configNodes = new MVPortalNodes(plugin, this);
-        var portalSection = config.getConfigurationSection("portals." + this.name);
-        if (portalSection == null) {
-            portalSection = config.createSection("portals." + this.name);
-        }
-        this.configHandle = MemoryConfigurationHandle.builder(portalSection, configNodes.getNodes())
+        var portalSection = Option.of(config.getConfigurationSection("portals." + this.name))
+                .getOrElse(() -> config.createSection("portals." + this.name));
+        this.configHandle = setUpConfigHandle(portalSection);
+        this.stringPropertyHandle = new StringPropertyHandle(this.configHandle);
+        configHandle.load();
+
+        setUpPermissions();
+    }
+
+    private MemoryConfigurationHandle setUpConfigHandle(ConfigurationSection portalSection) {
+        return MemoryConfigurationHandle.builder(portalSection, configNodes.getNodes())
                 .migrator(ConfigMigrator.builder(configNodes.version)
                         .addVersionMigrator(VersionMigrator.builder(1.0)
                                 .addAction(MoveMigratorAction.of("safeteleport", "safe-teleport"))
@@ -119,11 +142,14 @@
                                     }
                                 })
                                 .build())
+                        .addVersionMigrator(VersionMigrator.builder(1.2)
+                                .addAction(MoveMigratorAction.of("destination", "action"))
+                                .build())
                         .build())
                 .build();
-        this.stringPropertyHandle = new StringPropertyHandle(this.configHandle);
-        configHandle.load();
+    }
 
+    private void setUpPermissions() {
         this.permission = this.plugin.getServer().getPluginManager().getPermission("multiverse.portal.access." + this.name);
         if (this.permission == null) {
             this.permission = new Permission("multiverse.portal.access." + this.name, "Allows access to the " + this.name + " portal", PermissionDefault.OP);
@@ -142,6 +168,10 @@
         }
     }
 
+    /**
+     *
+     * @return
+     */
     public String getName() {
         return this.name;
     }
@@ -271,24 +301,53 @@
         return this.location;
     }
 
-    public boolean setDestination(String destinationString) {
-        DestinationInstance<?, ?> newDestination = this.destinationsProvider.parseDestination(destinationString).getOrNull();
-        return setDestination(newDestination);
+    @ApiStatus.AvailableSince("5.2")
+    public Try<Void> setActionType(ActionHandlerType<?, ?> actionType) {
+        return configHandle.set(configNodes.actionType, actionType.getName());
     }
 
-    public boolean setDestination(DestinationInstance<?, ?> newDestination) {
-        if (newDestination == null) {
-            Logging.warning("Portal " + this.name + " has an invalid DESTINATION!");
-            return false;
-        }
-        return this.configHandle.set(configNodes.destination, newDestination.toString()).isSuccess();
+    @ApiStatus.AvailableSince("5.2")
+    public Try<Void> setActionType(String actionType) {
+        return configHandle.set(configNodes.actionType, actionType);
     }
 
-    public DestinationInstance<?, ?> getDestination() {
-        return this.destinationsProvider.parseDestination(this.configHandle.get(configNodes.destination))
-                .onFailure(f ->
-                        Logging.warning("Portal " + this.name + " has an invalid DESTINATION! " + f.getFailureMessage().formatted()))
-                .getOrNull();
+    @ApiStatus.AvailableSince("5.2")
+    public String getActionType() {
+        return this.configHandle.get(configNodes.actionType);
+    }
+
+    @ApiStatus.AvailableSince("5.2")
+    public Try<Void> setAction(String action) {
+        return configHandle.set(configNodes.action, action);
+    }
+
+    @ApiStatus.AvailableSince("5.2")
+    public String getAction() {
+        return configHandle.get(configNodes.action);
+    }
+
+    @ApiStatus.AvailableSince("5.2")
+    public Attempt<? extends ActionHandler<?, ?>, ActionFailureReason> getActionHandler() {
+        return actionHandlerProvider.parseHandler(getActionType(), getAction());
+    }
+
+    @ApiStatus.AvailableSince("5.2")
+    public Attempt<? extends ActionHandler<?, ?>, ActionFailureReason> getActionHandler(CommandSender sender) {
+        return actionHandlerProvider.parseHandler(sender, getActionType(), getAction());
+    }
+
+    @ApiStatus.AvailableSince("5.2")
+    public Attempt<Void, ActionFailureReason> runActionFor(Entity entity) {
+        return getActionHandler(entity)
+                .mapAttempt(actionHandler -> actionHandler.runAction(this, entity))
+                .onSuccess(() -> {
+                    if (entity instanceof Player player) {
+                        plugin.getPortalSession(player).setTeleportTime(new Date());
+                    }
+                })
+                .onFailure(failure ->
+                        Logging.warning(ChatTextFormatter.removeColor("Invalid Portal Action: " +
+                                failure.getFailureMessage().formatted(commandManager.getCommandIssuer(Bukkit.getConsoleSender())))));
     }
 
     /**
@@ -598,4 +657,52 @@
     public PortalLocation getLocation() {
         return getPortalLocation();
     }
+
+    /**
+     * @deprecated Portals now have new types of action. Hence, the portal's destination (now called action) may not
+     *             always be a multiverse destination. It can be a command or server name as well.
+     *             Please see {@link MVPortal#getActionHandler()} instead.
+     */
+    @Deprecated(since = "5.2", forRemoval = true)
+    @ApiStatus.ScheduledForRemoval(inVersion = "6.0")
+    public boolean setDestination(String destinationString) {
+        DestinationInstance<?, ?> newDestination = this.destinationsProvider.parseDestination(destinationString).getOrNull();
+        return setDestination(newDestination);
+    }
+
+    /**
+     * @deprecated Portals now have new types of action. Hence, the portal's destination (now called action) may not
+     *             always be a multiverse destination. It can be a command or server name as well.
+     *             Please see {@link MVPortal#getActionHandler()} instead.
+     */
+    @Deprecated(since = "5.2", forRemoval = true)
+    @ApiStatus.ScheduledForRemoval(inVersion = "6.0")
+    public boolean setDestination(DestinationInstance<?, ?> newDestination) {
+        if (newDestination == null) {
+            Logging.warning("Portal " + this.name + " has an invalid DESTINATION!");
+            return false;
+        }
+        if (!Objects.equals(getActionType(), "multiverse-destination")) {
+           Logging.warning("Portal " + this.name + " is not set to use multiverse destination!");
+            return false;
+        }
+        return this.configHandle.set(configNodes.action, newDestination.toString()).isSuccess();
+    }
+
+    /**
+     * @deprecated Portals now have new types of action. Hence, the portal's destination (now called action) may not
+     *             always be a multiverse destination. It can be a command or server name as well.
+     *             Please see {@link MVPortal#getActionHandler()} instead.
+     */
+    @Deprecated(since = "5.2", forRemoval = true)
+    @ApiStatus.ScheduledForRemoval(inVersion = "6.0")
+    public DestinationInstance<?, ?> getDestination() {
+        return this.destinationsProvider.parseDestination(getAction())
+                .onFailure(f -> {
+                    if (getAction().equals("multiverse-destination")) {
+                        Logging.warning("Portal " + this.name + " has an invalid DESTINATION! " + f.getFailureMessage().formatted());
+                    }
+                })
+                .getOrNull();
+    }
 }

src/main/java/org/mvplugins/multiverse/portals/MVPortalNodes.java

@@ -6,10 +6,11 @@
 import org.mvplugins.multiverse.core.config.node.ConfigNode;
 import org.mvplugins.multiverse.core.config.node.Node;
 import org.mvplugins.multiverse.core.config.node.NodeGroup;
-import org.mvplugins.multiverse.core.destination.DestinationInstance;
 import org.mvplugins.multiverse.core.destination.DestinationsProvider;
 import org.mvplugins.multiverse.core.exceptions.MultiverseException;
 import org.mvplugins.multiverse.external.vavr.control.Try;
+import org.mvplugins.multiverse.portals.action.ActionHandler;
+import org.mvplugins.multiverse.portals.action.ActionHandlerProvider;
 import org.mvplugins.multiverse.portals.utils.MultiverseRegion;
 
 import java.util.Collections;
@@ -21,12 +22,12 @@ final class MVPortalNodes {
 
     private MultiversePortals plugin;
     private MVPortal portal;
-    private DestinationsProvider destinationsProvider;
+    private ActionHandlerProvider actionHandlerProvider;
 
     MVPortalNodes(MultiversePortals plugin, MVPortal portal) {
         this.plugin = plugin;
         this.portal = portal;
-        this.destinationsProvider = MultiverseCoreApi.get().getDestinationsProvider();
+        this.actionHandlerProvider = plugin.getServiceLocator().getService(ActionHandlerProvider.class);
     }
 
     NodeGroup getNodes() {
@@ -90,13 +91,23 @@ private <N extends Node> N node(N node) {
             .onSetValue((oldValue, newValue) -> portal.setPortalLocationInternal(PortalLocation.parseLocation(newValue)))
             .build());
 
-    final ConfigNode<String> destination = node(ConfigNode.builder("destination", String.class)
+    final ConfigNode<String> actionType = node(ConfigNode.builder("action-type", String.class)
+            .suggester(input -> actionHandlerProvider.getAllHandlerTypeNames())
+            .defaultValue("multiverse-destination")
+            .build());
+
+    final ConfigNode<String> action = node(ConfigNode.builder("action", String.class)
             .defaultValue("")
-            .aliases("dest")
-            .suggester((sender, input) -> destinationsProvider.suggestDestinationStrings(sender, input))
-            .stringParser((sender, input, type) -> destinationsProvider.parseDestination(sender, input)
-                    .map(DestinationInstance::toString)
-                    .toTry())
+            .aliases("destination", "dest")
+            .suggester((sender, input) -> actionHandlerProvider.getHandlerType(portal.getActionType())
+                    .map(actionHandlerType -> actionHandlerType.suggestActions(sender, input))
+                    .getOrElse(Collections.emptyList()))
+            .stringParser((sender, input, type) ->
+                    Try.of(() -> actionHandlerProvider.getHandlerType(portal.getActionType())
+                            .mapAttempt(actionHandlerType -> actionHandlerType.parseHandler(sender, input))
+                            .map(ActionHandler::serialise)
+                            .getOrThrow(failure ->
+                                    new MultiverseException(failure.getFailureMessage()))))
             .build());
 
     final ConfigNode<Boolean> checkDestinationSafety = node(ConfigNode.builder("check-destination-safety", Boolean.class)

src/main/java/org/mvplugins/multiverse/portals/MultiversePortals.java

@@ -16,6 +16,8 @@
 import java.util.logging.Level;
 
 import com.dumptruckman.minecraft.util.Logging;
+import com.google.common.io.ByteArrayDataInput;
+import com.google.common.io.ByteStreams;
 import org.jetbrains.annotations.ApiStatus;
 import org.mvplugins.multiverse.core.config.CoreConfig;
 import org.mvplugins.multiverse.core.destination.DestinationsProvider;
@@ -26,6 +28,8 @@
 import org.mvplugins.multiverse.external.jakarta.inject.Provider;
 import org.jvnet.hk2.annotations.Service;
 import org.mvplugins.multiverse.external.vavr.control.Try;
+import org.mvplugins.multiverse.portals.action.ActionHandlerProvider;
+import org.mvplugins.multiverse.portals.action.ActionHandlerType;
 import org.mvplugins.multiverse.portals.commands.PortalsCommand;
 import org.mvplugins.multiverse.portals.command.PortalsCommandCompletions;
 import org.mvplugins.multiverse.portals.command.PortalsCommandContexts;
@@ -70,6 +74,8 @@ public class MultiversePortals extends MultiverseModule {
     private Provider<PortalsConfig> portalsConfigProvider;
     @Inject
     private Provider<BstatsMetricsConfigurator> metricsConfiguratorProvider;
+    @Inject
+    private Provider<ActionHandlerProvider> actionHandlerProvider;
 
     private FileConfiguration MVPPortalConfig;
     private WorldEditConnection worldEditConnection;
@@ -104,6 +110,7 @@ public void onEnable() {
             this.getServer().getPluginManager().disablePlugin(this);
             return;
         }
+        this.setUpActionHandlers();
         this.loadPortals();
         this.setupMetrics();
 
@@ -112,6 +119,9 @@ public void onEnable() {
         getServer().getPluginManager().registerEvents(new WorldEditPluginListener(), this);
         MultiversePortalsApi.init(this);
 
+        // for teleporting between servers
+        getServer().getMessenger().registerOutgoingPluginChannel(this, "BungeeCord");
+
         Logging.log(true, Level.INFO, " Enabled - By %s", StringFormatter.joinAnd(getDescription().getAuthors()));
     }
 
@@ -180,6 +190,12 @@ public void destroyPortalSession(Player p) {
         this.portalSessions.remove(p.getName());
     }
 
+    private void setUpActionHandlers() {
+        serviceLocator.getAllServices(ActionHandlerType.class).forEach(handler -> {
+            actionHandlerProvider.get().registerHandlerType(handler);
+        });
+    }
+
     private void loadPortals() {
         this.MVPPortalConfig = YamlConfiguration.loadConfiguration(new File(getDataFolder(), "portals.yml"));
         if (!this.MVPPortalConfig.isConfigurationSection("portals")) {

src/main/java/org/mvplugins/multiverse/portals/PortalPlayerSession.java

@@ -252,17 +252,14 @@ public boolean showDebugInfo() {
         }
 
         displayUtils.showStaticInfo(this.player, this.standingIn, "You are currently standing in ");
-        displayUtils.showPortalPriceInfo(this.standingIn, this.player);
         return true;
     }
 
     public boolean showDebugInfo(MVPortal portal) {
         if (portal.playerCanEnterPortal(this.player)) {
             displayUtils.showStaticInfo(this.player, portal, "Portal Info ");
-            displayUtils.showPortalPriceInfo(portal, this.player);
-        } else {
-            Logging.info("Player " + this.player.getName() + " walked through" + portal.getName() + " with debug on.");
         }
+        Logging.info("Player " + this.player.getName() + " walked through" + portal.getName() + " with debug on.");
         return true;
     }
 

src/main/java/org/mvplugins/multiverse/portals/action/ActionFailureReason.java

@@ -0,0 +1,14 @@
+package org.mvplugins.multiverse.portals.action;
+
+import org.mvplugins.multiverse.core.utils.result.FailureReason;
+import org.mvplugins.multiverse.external.jetbrains.annotations.ApiStatus;
+
+/**
+ * Parent class for all reasons for a failure when trying to parse an action handler.
+ *
+ * @since 5.2
+ */
+@ApiStatus.AvailableSince("5.2")
+public interface ActionFailureReason extends FailureReason {
+    ActionFailureReason INSTANCE = new ActionFailureReason() {};
+}