initial work on api migration 7 => 8

edewit · edewit · commit 55f270a814bc · 2023-03-31T19:00:32.000+02:00
diff --git a/api-jvm-impl/build.gradle b/api-jvm-impl/build.gradle
@@ -1,7 +1,6 @@
 
 dependencies {
     api project(':api-jvm')
-    implementation 'ch.vorburger.minecraft.osgi:api:1.0.0'
     implementation('com.spotify:futures-extra:4.0.0') {
         exclude group: 'com.google.guava'
     }
diff --git a/api-jvm-impl/src/main/java/ch/vorburger/minecraft/storeys/japi/impl/Scripts.java b/api-jvm-impl/src/main/java/ch/vorburger/minecraft/storeys/japi/impl/Scripts.java
@@ -18,7 +18,6 @@
  */
 package ch.vorburger.minecraft.storeys.japi.impl;
 
-import ch.vorburger.minecraft.osgi.api.PluginInstance;
 import ch.vorburger.minecraft.storeys.japi.Script;
 import ch.vorburger.minecraft.storeys.japi.impl.events.EventService;
 import java.util.Collection;
diff --git a/api-jvm-impl/src/main/java/ch/vorburger/minecraft/storeys/japi/impl/actions/ActionContextImpl.java b/api-jvm-impl/src/main/java/ch/vorburger/minecraft/storeys/japi/impl/actions/ActionContextImpl.java
@@ -20,20 +20,20 @@
 
 import ch.vorburger.minecraft.storeys.japi.ActionContext;
 import ch.vorburger.minecraft.storeys.japi.ReadingSpeed;
-import org.spongepowered.api.command.CommandSource;
+import org.spongepowered.api.command.CommandCause;
 
 public final class ActionContextImpl implements ActionContext {
 
-    private final CommandSource commandSource;
+    private final CommandCause commandSource;
     private final ReadingSpeed readingSpeed;
 
-    public ActionContextImpl(CommandSource commandSource, ReadingSpeed readingSpeed) {
+    public ActionContextImpl(CommandCause commandSource, ReadingSpeed readingSpeed) {
         super();
         this.commandSource = commandSource;
         this.readingSpeed = readingSpeed;
     }
 
-    public CommandSource getCommandSource() {
+    public CommandCause getCommandCause() {
         return commandSource;
     }
 
diff --git a/api-jvm-impl/src/main/java/ch/vorburger/minecraft/storeys/japi/impl/actions/CommandAction.java b/api-jvm-impl/src/main/java/ch/vorburger/minecraft/storeys/japi/impl/actions/CommandAction.java
@@ -56,9 +56,9 @@ public CommandAction setCommand(String commandLine) {
     }
 
     @Override protected CommandResult executeInMainThread(ActionContext context) throws ActionException {
-        CommandResult result = Sponge.getCommandManager().process(context.getCommandSource(),
+        CommandResult result = Sponge.getCommandManager().process(context.getCommandCause(),
                 requireNonNull(commandLineWithoutSlash, "commandLineWithoutSlash"));
-        LOG.info("processed command \"/{}\" from source {} with result {}", commandLineWithoutSlash, context.getCommandSource(),
+        LOG.info("processed command \"/{}\" from source {} with result {}", commandLineWithoutSlash, context.getCommandCause(),
                 toString(result));
         return result;
     }
diff --git a/api-jvm-impl/src/main/java/ch/vorburger/minecraft/storeys/japi/impl/actions/NarrateAction.java b/api-jvm-impl/src/main/java/ch/vorburger/minecraft/storeys/japi/impl/actions/NarrateAction.java
@@ -55,7 +55,7 @@ public NarrateAction setEntity(String entityName) {
     }
 
     @Override public CompletionStage<Void> execute(ActionContext context) {
-        Locatable locatable = (Locatable) context.getCommandSource();
+        Locatable locatable = (Locatable) context.getCommandCause();
         World world = locatable.getWorld();
 
         return narrator.narrate(world, requireNonNull(entityName, "entityName"), getText().toPlain(), context.getReadingSpeed());
diff --git a/api-jvm-impl/src/main/java/ch/vorburger/minecraft/storeys/japi/impl/actions/TitleAction.java b/api-jvm-impl/src/main/java/ch/vorburger/minecraft/storeys/japi/impl/actions/TitleAction.java
@@ -61,7 +61,7 @@ public class TitleAction extends TextAction<Void> {
         int msToRead = context.getReadingSpeed().msToRead(bothTexts) + FADE_IN_MS + FADE_OUT_MS;
 
         return actionWaitHelper.executeAndWait(msToRead, () -> {
-            CommandSource commandSource = context.getCommandSource();
+            CommandSource commandSource = context.getCommandCause();
             if (commandSource instanceof Viewer) {
                 Viewer srcAsViewer = (Viewer) commandSource;
 
diff --git a/api-jvm-impl/src/main/java/ch/vorburger/minecraft/storeys/japi/impl/events/EventService.java b/api-jvm-impl/src/main/java/ch/vorburger/minecraft/storeys/japi/impl/events/EventService.java
@@ -18,7 +18,6 @@
  */
 package ch.vorburger.minecraft.storeys.japi.impl.events;
 
-import ch.vorburger.minecraft.osgi.api.PluginInstance;
 import ch.vorburger.minecraft.storeys.japi.PlayerInsideEvent;
 import ch.vorburger.minecraft.storeys.japi.impl.Unregisterable;
 import java.util.Collection;
@@ -39,6 +38,7 @@
 import org.spongepowered.api.event.item.inventory.ChangeInventoryEvent;
 import org.spongepowered.api.event.network.ClientConnectionEvent.Join;
 import org.spongepowered.api.text.Text;
+import org.spongepowered.plugin.PluginContainer;
 
 @Singleton public class EventService implements AutoCloseable {
 
@@ -56,8 +56,8 @@
     }
 
     // @Inject PluginInstance cannot work, so we use explicit "setter injection"
-    public void setPluginInstance(PluginInstance plugin) {
-        eventManager.registerListeners(plugin, this);
+    public void setPluginContainer(PluginContainer pluginContainer) {
+        eventManager.registerListeners(pluginContainer, this);
         // TODO InteractItemEvent ?
     }
 
diff --git a/api-jvm/src/main/java/ch/vorburger/minecraft/storeys/japi/ActionContext.java b/api-jvm/src/main/java/ch/vorburger/minecraft/storeys/japi/ActionContext.java
@@ -18,11 +18,11 @@
  */
 package ch.vorburger.minecraft.storeys.japi;
 
-import org.spongepowered.api.command.CommandSource;
+import org.spongepowered.api.command.CommandCause;
 
 public interface ActionContext {
 
-    CommandSource getCommandSource();
+    CommandCause getCommandCause();
 
     ReadingSpeed getReadingSpeed();
 }
diff --git a/build.gradle b/build.gradle
@@ -59,7 +59,7 @@ subprojects {
         // errorprone 'com.google.errorprone:error_prone_core:2.3.1'
         // implementation 'com.google.errorprone:error_prone_annotations:2.3.1'
 
-        implementation('org.spongepowered:spongeapi:7.3.0') {
+        implementation('org.spongepowered:spongeapi:8.1.0') {
             exclude group: 'com.google.guava'
             exclude group: 'com.google.inject'
             exclude group: 'com.google.code.gson'
diff --git a/storeys/build.gradle b/storeys/build.gradle
@@ -6,7 +6,6 @@ repositories {
 
 dependencies {
     api project(':api-jvm-impl')
-    api 'ch.vorburger.minecraft.osgi:api:1.0.0'
     implementation 'ch.vorburger:fswatch:1.3.0'
 
     implementation project(':example')
diff --git a/storeys/src/main/java/ch/vorburger/minecraft/storeys/commands/StoryCommand.java b/storeys/src/main/java/ch/vorburger/minecraft/storeys/commands/StoryCommand.java
@@ -41,6 +41,8 @@
 import org.spongepowered.api.command.CommandResult;
 import org.spongepowered.api.command.CommandSource;
 import org.spongepowered.api.command.args.CommandContext;
+import org.spongepowered.api.command.exception.CommandException;
+import org.spongepowered.api.command.parameter.CommandContext;
 import org.spongepowered.api.command.spec.CommandSpec;
 import org.spongepowered.api.text.Text;
 
@@ -73,7 +75,7 @@ public class StoryCommand implements Command {
                 ).executor(this).build();
     }
 
-    @Override public CommandResult execute(CommandSource commandSource, CommandContext commandContext) throws CommandException {
+    @Override public CommandResult execute(CommandContext commandContext) throws CommandException {
         String storyName = commandContext.<String>getOne(ARG_STORY).get();
 
         CommandExceptions.doOrThrow("Failed to load & play '" + storyName + "' story, due to: ", () -> {
diff --git a/storeys/src/main/java/ch/vorburger/minecraft/storeys/guard/GuardGameModeJoinListener.java b/storeys/src/main/java/ch/vorburger/minecraft/storeys/guard/GuardGameModeJoinListener.java
@@ -20,37 +20,38 @@
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.spongepowered.api.data.key.Keys;
-import org.spongepowered.api.entity.living.player.Player;
+import org.spongepowered.api.data.Keys;
 import org.spongepowered.api.entity.living.player.gamemode.GameMode;
 import org.spongepowered.api.entity.living.player.gamemode.GameModes;
-import org.spongepowered.api.event.EventListener;
-import org.spongepowered.api.event.network.ClientConnectionEvent.Join;
+import org.spongepowered.api.entity.living.player.server.ServerPlayer;
+import org.spongepowered.api.event.Listener;
+import org.spongepowered.api.event.network.ServerSideConnectionEvent.Join;
+import org.spongepowered.api.registry.DefaultedRegistryReference;
 
 /**
  * Listener which sets player game mode based on permission (if any) on join.
  *
  * @author Michael Vorburger.ch
  */
-public class GuardGameModeJoinListener implements EventListener<Join> {
+public class GuardGameModeJoinListener {
 
     private static final Logger LOG = LoggerFactory.getLogger(GuardGameModeJoinListener.class);
 
-    @Override public void handle(Join joinEvent) throws Exception {
-        GameMode newGameMode = null;
-        Player player = joinEvent.getTargetEntity();
+    @Listener public void handle(Join joinEvent) throws Exception {
+        DefaultedRegistryReference<GameMode> newGameMode = null;
+        ServerPlayer player = joinEvent.player();
         // NB: Order and use of if and not else if - because higher permission overrides lower...
         // But beware that OPS on servers without permissions plugin (such as LuckPerms) have all permissions;
-        // therefore the last permission must be the one which we wants an OPS to have!
+        // therefore the last permission must be the one which we want an OPS to have!
         if (player.hasPermission("storeys.guard.adventure")) {
             newGameMode = GameModes.ADVENTURE;
         }
         if (player.hasPermission("storeys.guard.creative")) {
             newGameMode = GameModes.CREATIVE;
         }
         if (newGameMode != null) {
-            player.offer(Keys.GAME_MODE, newGameMode);
-            LOG.info("Setting Player {} game mode to {} due to their storeys.guard.* permissions", player.getName(), newGameMode);
+            player.offer(Keys.GAME_MODE, newGameMode.get());
+            LOG.info("Setting Player {} game mode to {} due to their storeys.guard.* permissions", player.user().name(), newGameMode);
         }
     }
 
diff --git a/storeys/src/main/java/ch/vorburger/minecraft/storeys/model/DynamicAction.java b/storeys/src/main/java/ch/vorburger/minecraft/storeys/model/DynamicAction.java
@@ -53,7 +53,7 @@ public class DynamicAction implements Action<Void> {
 
         ScriptEngineManager manager = new ScriptEngineManager();
         ScriptEngine engine = manager.getEngineByName("JavaScript");
-        engine.put("player", context.getCommandSource());
+        engine.put("player", context.getCommandCause());
 
         try {
             String storyText = (String) engine.eval(PREFIX + script + POSTFIX);
diff --git a/storeys/src/main/java/ch/vorburger/minecraft/storeys/model/LocationAction.java b/storeys/src/main/java/ch/vorburger/minecraft/storeys/model/LocationAction.java
@@ -47,7 +47,7 @@ public LocationAction() {
     @Override public CompletionStage<Void> execute(ActionContext context) {
         CompletableFuture<Void> future = new CompletableFuture<>();
         try {
-            Locatable locatable = (Locatable) context.getCommandSource();
+            Locatable locatable = (Locatable) context.getCommandCause();
             LocatableInBoxCondition condition = new LocatableInBoxCondition(locatable.getWorld(), coordinates);
 
             conditionService.register(condition, (Player p) -> future.complete(null));
diff --git a/storeys/src/main/java/ch/vorburger/minecraft/storeys/model/LocationToolAction.java b/storeys/src/main/java/ch/vorburger/minecraft/storeys/model/LocationToolAction.java
@@ -42,7 +42,7 @@ public LocationToolAction(String name) {
     }
 
     @Override public CompletionStage<Void> execute(ActionContext context) {
-        final CommandSource source = context.getCommandSource();
+        final CommandSource source = context.getCommandCause();
         if (source instanceof Player) {
             createTool((Player) source);
         }
diff --git a/storeys/src/main/java/ch/vorburger/minecraft/storeys/model/MessageAction.java b/storeys/src/main/java/ch/vorburger/minecraft/storeys/model/MessageAction.java
@@ -19,7 +19,6 @@
 package ch.vorburger.minecraft.storeys.model;
 
 import ch.vorburger.minecraft.storeys.japi.ActionContext;
-import ch.vorburger.minecraft.storeys.japi.impl.actions.ActionContextImpl;
 import ch.vorburger.minecraft.storeys.japi.impl.actions.ActionWaitHelper;
 import ch.vorburger.minecraft.storeys.japi.impl.actions.TextAction;
 import java.util.concurrent.CompletionStage;
@@ -36,7 +35,7 @@ public class MessageAction extends TextAction<Void> {
 
     @Override public CompletionStage<Void> execute(ActionContext context) {
         return actionWaitHelper.executeAndWait(context.getReadingSpeed().msToRead(getText()), () -> {
-            context.getCommandSource().sendMessage(getText());
+            context.getCommandCause().sendMessage(getText());
             return null;
         });
     }
diff --git a/storeys/src/main/java/ch/vorburger/minecraft/storeys/plugin/AbstractPlugin.java b/storeys/src/main/java/ch/vorburger/minecraft/storeys/plugin/AbstractPlugin.java
@@ -0,0 +1,39 @@
+/**
+ * ch.vorburger.minecraft.osgi
+ *
+ * Copyright (C) 2016 - 2017 Michael Vorburger.ch <mike@vorburger.ch>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package ch.vorburger.minecraft.storeys.plugin;
+
+import com.google.inject.Inject;
+import org.spongepowered.plugin.PluginContainer;
+import org.spongepowered.plugin.builtin.jvm.Plugin;
+
+/**
+ * Convenience base class for your own {@link Plugin} annotated class.
+ * <p>
+ * You do not have to use this, it's just for convenience.
+ *
+ * @author Michael Vorburger.ch
+ */
+public abstract class AbstractPlugin implements PluginInstance {
+
+    @Inject protected PluginContainer pluginContainer;
+
+    public final PluginContainer getPluginContainer() {
+        return pluginContainer;
+    }
+}
diff --git a/storeys/src/main/java/ch/vorburger/minecraft/storeys/plugin/AbstractStoreysPlugin.java b/storeys/src/main/java/ch/vorburger/minecraft/storeys/plugin/AbstractStoreysPlugin.java
@@ -18,8 +18,6 @@
  */
 package ch.vorburger.minecraft.storeys.plugin;
 
-import ch.vorburger.minecraft.osgi.api.AbstractPlugin;
-import ch.vorburger.minecraft.osgi.api.PluginInstance;
 import ch.vorburger.minecraft.storeys.ScriptsLoader;
 import ch.vorburger.minecraft.storeys.commands.NarrateCommand;
 import ch.vorburger.minecraft.storeys.commands.StoryCommand;
@@ -33,14 +31,13 @@
 import javax.inject.Inject;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.spongepowered.api.command.CommandManager;
-import org.spongepowered.api.command.CommandMapping;
+import org.spongepowered.api.command.manager.CommandManager;
+import org.spongepowered.api.command.manager.CommandMapping;
 import org.spongepowered.api.config.ConfigDir;
 import org.spongepowered.api.event.EventManager;
 import org.spongepowered.api.event.Listener;
-import org.spongepowered.api.event.game.state.GameStartingServerEvent;
-import org.spongepowered.api.event.game.state.GameStoppingServerEvent;
-import org.spongepowered.api.event.network.ClientConnectionEvent.Join;
+import org.spongepowered.api.event.lifecycle.StartingEngineEvent;
+import org.spongepowered.api.event.lifecycle.StoppingEngineEvent;
 
 // Do *NOT* annotate this class with @Plugin
 public abstract class AbstractStoreysPlugin extends AbstractPlugin {
@@ -51,6 +48,7 @@ public abstract class AbstractStoreysPlugin extends AbstractPlugin {
     @ConfigDir(sharedRoot = false) private Path configDir;
 
     @Inject protected Injector pluginInjector;
+
     private Injector childInjector;
 
     @Inject private EventManager eventManager;
@@ -59,17 +57,15 @@ public abstract class AbstractStoreysPlugin extends AbstractPlugin {
 
     @Inject private CommandManager commandManager;
 
-    private CommandMapping narrateCommandMapping;
-    private CommandMapping storyCommandMapping;
 
-    @Listener public final void onGameStartingServer(GameStartingServerEvent event) throws Exception {
+    @Listener public final void onGameStartingServer(StartingEngineEvent event) throws Exception {
         LOG.info("See https://github.com/OASIS-learn-study/minecraft-storeys-maker for how to use /story and /narrate commands");
         start(this, configDir);
     }
 
     protected void start(PluginInstance plugin, Path configDir) throws Exception {
-        eventManager.registerListener(plugin, Join.class, new GuardGameModeJoinListener());
-        eventService.setPluginInstance(plugin);
+        eventManager.registerListeners(plugin.getPluginContainer(), new GuardGameModeJoinListener());
+        eventService.setPluginContainer(plugin.getPluginContainer());
 
         // TODO(vorburger) child injector might not actually be required, could possibly just use only pluginInjector?
         childInjector = pluginInjector.createChildInjector(binder -> {
@@ -78,23 +74,7 @@ protected void start(PluginInstance plugin, Path configDir) throws Exception {
             binder.bind(Scripts.class);
             binder.bind(ScriptsLoader.class);
         });
-        storyCommandMapping = Commands.register(plugin, pluginInjector.getInstance(StoryCommand.class));
-        narrateCommandMapping = Commands.register(plugin, pluginInjector.getInstance(NarrateCommand.class));
-    }
-
-    @Listener public final void onGameStoppingServer(GameStoppingServerEvent event) throws Exception {
-        stop();
-    }
-
-    protected void stop() throws Exception {
-        childInjector.getInstance(Scripts.class).getUnregisterables().forEach(Unregisterable::unregister);
-        childInjector.getInstance(ScriptsLoader.class).close();
-
-        if (narrateCommandMapping != null) {
-            commandManager.removeMapping(narrateCommandMapping);
-        }
-        if (storyCommandMapping != null) {
-            commandManager.removeMapping(storyCommandMapping);
-        }
+        Commands.register(plugin, pluginInjector.getInstance(StoryCommand.class));
+        Commands.register(plugin, pluginInjector.getInstance(NarrateCommand.class));
     }
 }
diff --git a/storeys/src/main/java/ch/vorburger/minecraft/storeys/plugin/PluginInstance.java b/storeys/src/main/java/ch/vorburger/minecraft/storeys/plugin/PluginInstance.java
diff --git a/storeys/src/main/java/ch/vorburger/minecraft/storeys/util/Command.java b/storeys/src/main/java/ch/vorburger/minecraft/storeys/util/Command.java
diff --git a/storeys/src/main/java/ch/vorburger/minecraft/storeys/util/Commands.java b/storeys/src/main/java/ch/vorburger/minecraft/storeys/util/Commands.java
diff --git a/web/build.gradle b/web/build.gradle
diff --git a/web/src/main/java/ch/vorburger/minecraft/storeys/web/LocationToolListener.java b/web/src/main/java/ch/vorburger/minecraft/storeys/web/LocationToolListener.java
diff --git a/web/src/main/java/ch/vorburger/minecraft/storeys/web/LoginCommand.java b/web/src/main/java/ch/vorburger/minecraft/storeys/web/LoginCommand.java
diff --git a/web/src/main/java/ch/vorburger/minecraft/storeys/web/StoreysWebPlugin.java b/web/src/main/java/ch/vorburger/minecraft/storeys/web/StoreysWebPlugin.java
diff --git a/web/src/main/java/ch/vorburger/minecraft/storeys/web/location/LocationPairSerializer.java b/web/src/main/java/ch/vorburger/minecraft/storeys/web/location/LocationPairSerializer.java

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,6 @@`
`1`	`1`
`2`	`2`	`dependencies {`
`3`	`3`	`api project(':api-jvm')`
`4`		`- implementation 'ch.vorburger.minecraft.osgi:api:1.0.0'`
`5`	`4`	`implementation('com.spotify:futures-extra:4.0.0') {`
`6`	`5`	`exclude group: 'com.google.guava'`
`7`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -56,9 +56,9 @@ public CommandAction setCommand(String commandLine) {`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`@Override protected CommandResult executeInMainThread(ActionContext context) throws ActionException {`
`59`		`- CommandResult result = Sponge.getCommandManager().process(context.getCommandSource(),`
	`59`	`+ CommandResult result = Sponge.getCommandManager().process(context.getCommandCause(),`
`60`	`60`	`requireNonNull(commandLineWithoutSlash, "commandLineWithoutSlash"));`
`61`		`- LOG.info("processed command \"/{}\" from source {} with result {}", commandLineWithoutSlash, context.getCommandSource(),`
	`61`	`+ LOG.info("processed command \"/{}\" from source {} with result {}", commandLineWithoutSlash, context.getCommandCause(),`
`62`	`62`	`toString(result));`
`63`	`63`	`return result;`
`64`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ public NarrateAction setEntity(String entityName) {`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`@Override public CompletionStage<Void> execute(ActionContext context) {`
`58`		`- Locatable locatable = (Locatable) context.getCommandSource();`
	`58`	`+ Locatable locatable = (Locatable) context.getCommandCause();`
`59`	`59`	`World world = locatable.getWorld();`
`60`	`60`
`61`	`61`	`return narrator.narrate(world, requireNonNull(entityName, "entityName"), getText().toPlain(), context.getReadingSpeed());`