Fix forge interactions

forge/src/launch/java/org/spongepowered/forge/launch/bridge/event/ForgeEventBridge_Forge.java

@@ -25,6 +25,7 @@
 package org.spongepowered.forge.launch.bridge.event;
 
 import org.checkerframework.checker.nullness.qual.Nullable;
+import org.spongepowered.api.event.CauseStackManager;
 import org.spongepowered.api.event.Event;
 
 public interface ForgeEventBridge_Forge {
@@ -55,7 +56,9 @@ public interface ForgeEventBridge_Forge {
 
     /**
      * Creates a Sponge event from this Forge event
+     *
+     * @param frame The stack frame in which the event will be fired
      */
-    @Nullable Event bridge$createSpongeEvent();
+    @Nullable Event bridge$createSpongeEvent(final CauseStackManager.StackFrame frame);
 
 }

forge/src/launch/java/org/spongepowered/forge/launch/event/ForgeEventManager.java

@@ -32,8 +32,10 @@
 import net.minecraftforge.eventbus.api.IEventBusInvokeDispatcher;
 import net.minecraftforge.eventbus.api.IEventListener;
 import org.checkerframework.checker.nullness.qual.Nullable;
+import org.spongepowered.api.event.CauseStackManager;
 import org.spongepowered.common.event.manager.RegisteredListener;
 import org.spongepowered.common.event.manager.SpongeEventManager;
+import org.spongepowered.common.event.tracking.PhaseTracker;
 import org.spongepowered.forge.launch.bridge.event.ForgeEventBridge_Forge;
 import org.spongepowered.forge.launch.bridge.event.SpongeEventBridge_Forge;
 
@@ -116,9 +118,11 @@ public boolean post(final Event event, final IEventBusInvokeDispatcher wrapper)
         if (event instanceof ForgeEventBridge_Forge) {
             // intercept!
             final ForgeEventBridge_Forge forgeEvent = (ForgeEventBridge_Forge) event;
-            final org.spongepowered.api.event.@Nullable Event spongeEvent = forgeEvent.bridge$createSpongeEvent();
-            if (spongeEvent != null) {
-                return this.postDualBus(spongeEvent, Collections.singleton(event), wrapper);
+            try (final CauseStackManager.StackFrame frame = PhaseTracker.getCauseStackManager().pushCauseFrame()) {
+                final org.spongepowered.api.event.@Nullable Event spongeEvent = forgeEvent.bridge$createSpongeEvent(frame);
+                if (spongeEvent != null) {
+                    return this.postDual(spongeEvent, event, wrapper);
+                }
             }
         }
         // Do as Forge does - SpongeVanilla has no role to play here.
@@ -145,15 +149,21 @@ public boolean post(final org.spongepowered.api.event.Event event) {
             // Do as SpongeVanilla does - Forge has no role to play here.
             return super.post(event);
         }
-        return this.postDualBus(event, forgeEvents, eventBridge.bridge$eventDispatcher());
+        return this.postDual(event, forgeEvents, eventBridge.bridge$eventDispatcher());
     }
 
     // Implementation
 
-    private boolean postDualBus(final org.spongepowered.api.event.Event spongeEvent, final Collection<? extends Event> forgeEvents,
+    private boolean postDual(final org.spongepowered.api.event.Event spongeEvent, final Event forgeEvent,
+            final IEventBusInvokeDispatcher dispatcher) {
+        return postDual(spongeEvent, Collections.singleton(forgeEvent), dispatcher);
+    }
+
+    private boolean postDual(final org.spongepowered.api.event.Event spongeEvent, final Collection<? extends Event> forgeEvents,
             final IEventBusInvokeDispatcher dispatcher) {
         try (final NoExceptionClosable ignored = this.preparePost(spongeEvent)) {
             final RegisteredListener.Cache listeners = this.getHandlerCache(spongeEvent);
+
             final List<RegisteredListener<?>> beforeModifications = listeners.beforeModifications();
             if (!beforeModifications.isEmpty()) {
                 // First, we fire the Sponge beforeModifications on the Sponge event
@@ -164,6 +174,7 @@ private boolean postDualBus(final org.spongepowered.api.event.Event spongeEvent,
                     ((ForgeEventBridge_Forge) forgeEvent).bridge$syncFrom(spongeEvent);
                 }
             }
+
             // Then, we fire all our Forge events
             for (final Event forgeEvent : forgeEvents) {
                 this.wrappedEventBus.post(forgeEvent, dispatcher);
@@ -172,8 +183,15 @@ private boolean postDualBus(final org.spongepowered.api.event.Event spongeEvent,
                 ((ForgeEventBridge_Forge) forgeEvent).bridge$syncTo(spongeEvent);
             }
 
-            // and now we do our standard event listener stuff.
-            return this.post(spongeEvent, listeners.afterModifications());
+            // Now we do our standard event listener stuff.
+            final boolean result =  this.post(spongeEvent, listeners.afterModifications());
+
+            // Finally, we sync to the Forge events again
+            for (final Event forgeEvent : forgeEvents) {
+                ((ForgeEventBridge_Forge) forgeEvent).bridge$syncFrom(spongeEvent);
+            }
+
+            return result;
         }
     }
 }

forge/src/main/java/org/spongepowered/forge/util/TristateUtil.java

@@ -0,0 +1,60 @@
+/*
+ * This file is part of Sponge, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) SpongePowered <https://www.spongepowered.org>
+ * Copyright (c) contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package org.spongepowered.forge.util;
+
+import net.minecraftforge.eventbus.api.Event;
+import org.spongepowered.api.util.Tristate;
+
+public final class TristateUtil {
+
+    public static Tristate fromEventResult(final Event.Result result) {
+        switch (result) {
+            case DENY:
+                return Tristate.FALSE;
+            case DEFAULT:
+                return Tristate.UNDEFINED;
+            case ALLOW:
+                return Tristate.TRUE;
+            default:
+                throw new IllegalArgumentException("Event.Result " + result);
+        }
+    }
+
+    public static Event.Result toEventResult(final Tristate tristate) {
+        switch (tristate) {
+            case TRUE:
+                return Event.Result.ALLOW;
+            case FALSE:
+                return Event.Result.DENY;
+            case UNDEFINED:
+                return Event.Result.DEFAULT;
+            default:
+                throw new IllegalArgumentException("Tristate " + tristate);
+        }
+    }
+
+    private TristateUtil() {
+    }
+}

forge/src/mixins/java/org/spongepowered/forge/mixin/core/api/event/block/InteractBlockEvent_SecondaryMixin_Forge.java

@@ -0,0 +1,76 @@
+/*
+ * This file is part of Sponge, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) SpongePowered <https://www.spongepowered.org>
+ * Copyright (c) contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package org.spongepowered.forge.mixin.core.api.event.block;
+
+import net.minecraft.core.BlockPos;
+import net.minecraft.core.Direction;
+import net.minecraft.world.InteractionHand;
+import net.minecraft.world.InteractionResult;
+import net.minecraft.world.entity.player.Player;
+import net.minecraft.world.phys.BlockHitResult;
+import net.minecraft.world.phys.Vec3;
+import net.minecraftforge.event.entity.player.PlayerInteractEvent;
+import net.minecraftforge.eventbus.api.Event;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.spongepowered.api.event.EventContextKeys;
+import org.spongepowered.api.event.block.InteractBlockEvent;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.common.util.DirectionUtil;
+import org.spongepowered.common.util.VecHelper;
+import org.spongepowered.forge.launch.bridge.event.SpongeEventBridge_Forge;
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Optional;
+
+@Mixin(InteractBlockEvent.Secondary.class)
+public interface InteractBlockEvent_SecondaryMixin_Forge extends SpongeEventBridge_Forge {
+
+    @Override
+    default @Nullable Collection<? extends Event> bridge$createForgeEvents() {
+        final InteractBlockEvent.Secondary spongeEvent = (InteractBlockEvent.Secondary) this;
+
+        final Optional<Player> playerOpt = spongeEvent.cause().first(Player.class);
+        if (!playerOpt.isPresent()) {
+            return null;
+        }
+
+        final InteractionHand hand = (InteractionHand) (Object) spongeEvent.context().require(EventContextKeys.USED_HAND);
+        final BlockPos blockPos = VecHelper.toBlockPos(spongeEvent.block().position());
+        final Direction direction = DirectionUtil.getFor(spongeEvent.targetSide());
+        final Vec3 interactionPoint = VecHelper.toVanillaVector3d(spongeEvent.interactionPoint());
+        final BlockHitResult hitResult = new BlockHitResult(interactionPoint, direction, blockPos, false);
+
+        final PlayerInteractEvent.RightClickBlock forgeEvent = new PlayerInteractEvent.RightClickBlock(
+                playerOpt.get(),
+                hand,
+                blockPos,
+                hitResult
+        );
+        forgeEvent.setCancellationResult(InteractionResult.FAIL);
+
+        return Collections.singleton(forgeEvent);
+    }
+}

forge/src/mixins/java/org/spongepowered/forge/mixin/core/minecraftforge/event/ServerChatEventMixin_Forge.java

@@ -30,13 +30,13 @@
 import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.api.entity.living.player.PlayerChatFormatter;
 import org.spongepowered.api.entity.living.player.server.ServerPlayer;
+import org.spongepowered.api.event.CauseStackManager;
 import org.spongepowered.api.event.Event;
 import org.spongepowered.api.event.SpongeEventFactory;
 import org.spongepowered.api.event.message.PlayerChatEvent;
 import org.spongepowered.asm.mixin.Mixin;
 import org.spongepowered.asm.mixin.Shadow;
 import org.spongepowered.common.adventure.SpongeAdventure;
-import org.spongepowered.common.event.tracking.PhaseTracker;
 import org.spongepowered.forge.launch.bridge.event.ForgeEventBridge_Forge;
 
 import java.util.Optional;
@@ -65,12 +65,12 @@ public abstract class ServerChatEventMixin_Forge implements ForgeEventBridge_For
     }
 
     @Override
-    public @Nullable Event bridge$createSpongeEvent() {
+    public @Nullable Event bridge$createSpongeEvent(final CauseStackManager.StackFrame frame) {
         final Audience audience = (Audience) this.shadow$getPlayer().server;
         final PlayerChatFormatter chatFormatter = ((ServerPlayer) this.shadow$getPlayer()).chatFormatter();
         final net.kyori.adventure.text.Component originalMessage = SpongeAdventure.asAdventure(this.shadow$getComponent());
         return SpongeEventFactory.createPlayerChatEvent(
-                PhaseTracker.getCauseStackManager().currentCause(),
+                frame.currentCause(),
                 audience,
                 Optional.of(audience),
                 chatFormatter,

forge/src/mixins/java/org/spongepowered/forge/mixin/core/minecraftforge/event/entity/EntityTravelToDimensionEventMixin_Forge.java

@@ -31,6 +31,7 @@
 import net.minecraftforge.event.entity.EntityEvent;
 import net.minecraftforge.event.entity.EntityTravelToDimensionEvent;
 import org.checkerframework.checker.nullness.qual.Nullable;
+import org.spongepowered.api.event.CauseStackManager;
 import org.spongepowered.api.event.Event;
 import org.spongepowered.api.event.SpongeEventFactory;
 import org.spongepowered.api.event.entity.ChangeEntityWorldEvent;
@@ -39,7 +40,6 @@
 import org.spongepowered.asm.mixin.Mutable;
 import org.spongepowered.asm.mixin.Shadow;
 import org.spongepowered.common.SpongeCommon;
-import org.spongepowered.common.event.tracking.PhaseTracker;
 import org.spongepowered.forge.launch.bridge.event.ForgeEventBridge_Forge;
 
 @Mixin(value = EntityTravelToDimensionEvent.class, remap = false)
@@ -65,10 +65,10 @@ public abstract class EntityTravelToDimensionEventMixin_Forge implements ForgeEv
     }
 
     @Override
-    public @Nullable Event bridge$createSpongeEvent() {
+    public @Nullable Event bridge$createSpongeEvent(final CauseStackManager.StackFrame frame) {
         final Entity entity = ((EntityEvent) (Object) this).getEntity();
         final ServerLevel toWorld = SpongeCommon.server().getLevel(this.dimension);
-        return SpongeEventFactory.createChangeEntityWorldEventPre(PhaseTracker.getCauseStackManager().currentCause(),
+        return SpongeEventFactory.createChangeEntityWorldEventPre(frame.currentCause(),
                 (org.spongepowered.api.entity.Entity) entity, (org.spongepowered.api.world.server.ServerWorld) entity.getCommandSenderWorld(),
                 (org.spongepowered.api.world.server.ServerWorld) toWorld, (org.spongepowered.api.world.server.ServerWorld) toWorld);
     }

forge/src/mixins/java/org/spongepowered/forge/mixin/core/minecraftforge/event/entity/player/PlayerEvent_PlayerChangedDimensionEventMixin_Forge.java

@@ -28,14 +28,14 @@
 import net.minecraft.world.level.Level;
 import net.minecraftforge.event.entity.player.PlayerEvent;
 import org.spongepowered.api.entity.Entity;
+import org.spongepowered.api.event.CauseStackManager;
 import org.spongepowered.api.event.Event;
 import org.spongepowered.api.event.SpongeEventFactory;
 import org.spongepowered.api.world.server.ServerWorld;
 import org.spongepowered.asm.mixin.Final;
 import org.spongepowered.asm.mixin.Mixin;
 import org.spongepowered.asm.mixin.Shadow;
 import org.spongepowered.common.SpongeCommon;
-import org.spongepowered.common.event.tracking.PhaseTracker;
 import org.spongepowered.forge.launch.bridge.event.ForgeEventBridge_Forge;
 
 @Mixin(value = PlayerEvent.PlayerChangedDimensionEvent.class, remap = false)
@@ -58,10 +58,10 @@ public final class PlayerEvent_PlayerChangedDimensionEventMixin_Forge implements
 
     @SuppressWarnings("ConstantConditions")
     @Override
-    public Event bridge$createSpongeEvent() {
+    public Event bridge$createSpongeEvent(final CauseStackManager.StackFrame frame) {
         final PlayerEvent.PlayerChangedDimensionEvent thisEvent = (PlayerEvent.PlayerChangedDimensionEvent) (Object) this;
         return SpongeEventFactory.createChangeEntityWorldEventPost(
-                PhaseTracker.getCauseStackManager().currentCause(),
+                frame.currentCause(),
                 (Entity) thisEvent.getPlayer(),
                 (ServerWorld) SpongeCommon.server().getLevel(this.fromDim),
                 (ServerWorld) SpongeCommon.server().getLevel(this.toDim),

forge/src/mixins/java/org/spongepowered/forge/mixin/core/minecraftforge/event/entity/player/PlayerInteractEvent_RightClickBlockMixin_Forge.java

@@ -0,0 +1,73 @@
+/*
+ * This file is part of Sponge, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) SpongePowered <https://www.spongepowered.org>
+ * Copyright (c) contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package org.spongepowered.forge.mixin.core.minecraftforge.event.entity.player;
+
+import net.minecraft.server.level.ServerLevel;
+import net.minecraft.world.level.Level;
+import net.minecraftforge.event.entity.player.PlayerInteractEvent;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.spongepowered.api.event.CauseStackManager;
+import org.spongepowered.api.event.Event;
+import org.spongepowered.api.event.block.InteractBlockEvent;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.common.event.SpongeCommonEventFactory;
+import org.spongepowered.forge.launch.bridge.event.ForgeEventBridge_Forge;
+import org.spongepowered.forge.util.TristateUtil;
+
+@Mixin(value = PlayerInteractEvent.RightClickBlock.class, remap = false)
+public abstract class PlayerInteractEvent_RightClickBlockMixin_Forge implements ForgeEventBridge_Forge {
+
+    @Override
+    public void bridge$syncFrom(final Event event) {
+        final InteractBlockEvent.Secondary spongeEvent = (InteractBlockEvent.Secondary) event;
+        final PlayerInteractEvent.RightClickBlock forgeEvent = (PlayerInteractEvent.RightClickBlock) (Object) this;
+
+        forgeEvent.setCanceled(spongeEvent.isCancelled());
+        forgeEvent.setUseBlock(TristateUtil.toEventResult(spongeEvent.useBlockResult()));
+        forgeEvent.setUseItem(TristateUtil.toEventResult(spongeEvent.useItemResult()));
+    }
+
+    @Override
+    public void bridge$syncTo(final Event event) {
+        final InteractBlockEvent.Secondary spongeEvent = (InteractBlockEvent.Secondary) event;
+        final PlayerInteractEvent.RightClickBlock forgeEvent = (PlayerInteractEvent.RightClickBlock) (Object) this;
+
+        spongeEvent.setCancelled(forgeEvent.isCanceled());
+        spongeEvent.setUseBlockResult(TristateUtil.fromEventResult(forgeEvent.getUseBlock()));
+        spongeEvent.setUseItemResult(TristateUtil.fromEventResult(forgeEvent.getUseItem()));
+    }
+
+    @Override
+    public @Nullable Event bridge$createSpongeEvent(final CauseStackManager.StackFrame frame) {
+        final PlayerInteractEvent.RightClickBlock forgeEvent = (PlayerInteractEvent.RightClickBlock) (Object) this;
+        final Level world = forgeEvent.getWorld();
+        if (world.isClientSide) {
+            return null;
+        }
+
+        return SpongeCommonEventFactory.createInteractBlockEventSecondary(forgeEvent.getPlayer(), (ServerLevel) world, forgeEvent.getItemStack(),
+                forgeEvent.getHand(), forgeEvent.getHitVec(), frame);
+    }
+}