Event handling for custom click actions

fabric-networking-api-v1/src/main/java/net/fabricmc/fabric/api/networking/v1/CustomClickActionEvents.java

@@ -0,0 +1,68 @@
+/*
+ * Copyright (c) 2016, 2017, 2018, 2019 FabricMC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package net.fabricmc.fabric.api.networking.v1;
+
+import java.util.Objects;
+
+import net.minecraft.util.Identifier;
+
+import net.fabricmc.fabric.api.event.Event;
+import net.fabricmc.fabric.impl.networking.CustomClickActionsRegistry;
+
+/**
+ * Events for listening to {@linkplain net.minecraft.text.ClickEvent.Custom custom click actions}, such as from a
+ * dialog.
+ */
+public final class CustomClickActionEvents {
+	/**
+	 * Gets an event that is invoked on the server when a custom click event is received during the PLAY phase. The
+	 * returned event will only be invoked when a click event is received with the given ID.
+	 *
+	 * @param id The of the ID click event to listen to.
+	 * @return Returns an event that will be invoked when a click event with the given ID is received during the PLAY
+	 * phase.
+	 */
+	public static Event<ClickActionReceived<CustomClickEventContext.Play>> playClickActionEvent(Identifier id) {
+		Objects.requireNonNull(id, "ID cannot be null");
+		return CustomClickActionsRegistry.PLAY_REGISTRY.getOrCreateActionEvent(id);
+	}
+
+	/**
+	 * Gets an event that is invoked on the server when a custom click event is received during the CONFIGURATION phase.
+	 * The returned event will only be invoked when a click event is received with the given ID.
+	 *
+	 * @param id The of the ID click event to listen to.
+	 * @return Returns an event that will be invoked when a click event with the given ID is received during the
+	 * CONFIGURATION phase.
+	 */
+	public static Event<ClickActionReceived<CustomClickEventContext.Configuration>> configurationClickActionEvent(Identifier id) {
+		Objects.requireNonNull(id, "ID cannot be null");
+		return CustomClickActionsRegistry.CONFIGURATION_REGISTRY.getOrCreateActionEvent(id);
+	}
+
+	@FunctionalInterface
+	public interface ClickActionReceived<T extends CustomClickEventContext> {
+		/**
+		 * Handles a custom click event on the server from a given context.
+		 * @param context The context of the event, contains the handler responsible for the action and the payload.
+		 */
+		void handleCustomClickAction(T context);
+	}
+
+	private CustomClickActionEvents() {
+	}
+}

fabric-networking-api-v1/src/main/java/net/fabricmc/fabric/api/networking/v1/CustomClickEventContext.java

@@ -0,0 +1,64 @@
+/*
+ * Copyright (c) 2016, 2017, 2018, 2019 FabricMC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package net.fabricmc.fabric.api.networking.v1;
+
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.Nullable;
+
+import net.minecraft.nbt.NbtElement;
+import net.minecraft.server.network.ServerCommonNetworkHandler;
+import net.minecraft.server.network.ServerConfigurationNetworkHandler;
+import net.minecraft.server.network.ServerPlayNetworkHandler;
+
+/**
+ * Contains data about a {@linkplain net.minecraft.text.ClickEvent.Custom custom click event} when one is received on
+ * the server.
+ */
+public sealed interface CustomClickEventContext permits CustomClickEventContext.Play, CustomClickEventContext.Configuration {
+	/**
+	 * The handler responsible for the event.
+	 */
+	ServerCommonNetworkHandler handler();
+
+	/**
+	 * The payload received with this event. If no payload is received, then this payload will be {@code null}.
+	 */
+	@Nullable
+	NbtElement payload();
+
+	/**
+	 * The context data when a custom click event is received during the PLAY phase on the server.
+	 */
+	@ApiStatus.NonExtendable
+	non-sealed interface Play extends CustomClickEventContext {
+		/**
+		 * The play handler responsible for the event.
+		 */
+		ServerPlayNetworkHandler handler();
+	}
+
+	/**
+	 * The context data when a custom click event is received during the CONFIGURATION phase on the server.
+	 */
+	@ApiStatus.NonExtendable
+	non-sealed interface Configuration extends CustomClickEventContext {
+		/**
+		 * The configuration handler responsible for the event.
+		 */
+		ServerConfigurationNetworkHandler handler();
+	}
+}

fabric-networking-api-v1/src/main/java/net/fabricmc/fabric/impl/networking/AbstractNetworkAddon.java

@@ -30,6 +30,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import net.minecraft.nbt.NbtElement;
 import net.minecraft.util.Identifier;
 
 /**
@@ -172,4 +173,7 @@ public final void handleDisconnect() {
 	 * @return whether the channel is reserved
 	 */
 	protected abstract boolean isReservedChannel(Identifier channelName);
+
+	public void invokeCustomClickActionEvent(Identifier id, @Nullable NbtElement payload) {
+	}
 }

fabric-networking-api-v1/src/main/java/net/fabricmc/fabric/impl/networking/CustomClickActionsRegistry.java

@@ -0,0 +1,78 @@
+/*
+ * Copyright (c) 2016, 2017, 2018, 2019 FabricMC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package net.fabricmc.fabric.impl.networking;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import org.jetbrains.annotations.Nullable;
+
+import net.minecraft.nbt.NbtElement;
+import net.minecraft.server.network.ServerConfigurationNetworkHandler;
+import net.minecraft.server.network.ServerPlayNetworkHandler;
+import net.minecraft.util.Identifier;
+
+import net.fabricmc.fabric.api.event.Event;
+import net.fabricmc.fabric.api.event.EventFactory;
+import net.fabricmc.fabric.api.networking.v1.CustomClickActionEvents;
+import net.fabricmc.fabric.api.networking.v1.CustomClickEventContext;
+
+public final class CustomClickActionsRegistry<T extends CustomClickEventContext> {
+	public static final CustomClickActionsRegistry<CustomClickEventContext.Play> PLAY_REGISTRY = new CustomClickActionsRegistry<>();
+	public static final CustomClickActionsRegistry<CustomClickEventContext.Configuration> CONFIGURATION_REGISTRY = new CustomClickActionsRegistry<>();
+
+	private final Map<Identifier, Event<CustomClickActionEvents.ClickActionReceived<T>>> registry = new HashMap<>();
+
+	public Event<CustomClickActionEvents.ClickActionReceived<T>> getOrCreateActionEvent(Identifier id) {
+		return this.registry.computeIfAbsent(
+				id,
+				idx -> {
+					return EventFactory.createArrayBacked(
+							CustomClickActionEvents.ClickActionReceived.class,
+							listeners -> context -> {
+								for (CustomClickActionEvents.ClickActionReceived<T> listener : listeners) {
+									listener.handleCustomClickAction(context);
+								}
+							}
+					);
+				}
+		);
+	}
+
+	public void invokeListenerEvent(Identifier id, T context) {
+		Event<CustomClickActionEvents.ClickActionReceived<T>> event = this.registry.get(id);
+
+		if (event != null) {
+			event.invoker().handleCustomClickAction(context);
+		}
+	}
+
+	public record PlayContextImpl(
+			ServerPlayNetworkHandler handler,
+			@Nullable NbtElement payload
+	) implements CustomClickEventContext.Play {
+	}
+
+	public record ConfigurationContextImpl(
+			ServerConfigurationNetworkHandler handler,
+			@Nullable NbtElement payload
+	) implements CustomClickEventContext.Configuration {
+	}
+
+	private CustomClickActionsRegistry() {
+	}
+}

fabric-networking-api-v1/src/main/java/net/fabricmc/fabric/impl/networking/server/ServerConfigurationNetworkAddon.java

@@ -23,6 +23,7 @@
 import io.netty.channel.ChannelFutureListener;
 import org.jetbrains.annotations.Nullable;
 
+import net.minecraft.nbt.NbtElement;
 import net.minecraft.network.NetworkPhase;
 import net.minecraft.network.packet.BrandCustomPayload;
 import net.minecraft.network.packet.CustomPayload;
@@ -38,6 +39,7 @@
 import net.fabricmc.fabric.api.networking.v1.ServerConfigurationNetworking;
 import net.fabricmc.fabric.impl.networking.AbstractChanneledNetworkAddon;
 import net.fabricmc.fabric.impl.networking.ChannelInfoHolder;
+import net.fabricmc.fabric.impl.networking.CustomClickActionsRegistry;
 import net.fabricmc.fabric.impl.networking.NetworkingImpl;
 import net.fabricmc.fabric.impl.networking.RegistrationPayload;
 import net.fabricmc.fabric.mixin.networking.accessor.ServerCommonNetworkHandlerAccessor;
@@ -197,6 +199,14 @@ public void setReconfiguring() {
 		isReconfiguring = true;
 	}
 
+	@Override
+	public void invokeCustomClickActionEvent(Identifier id, @Nullable NbtElement payload) {
+		CustomClickActionsRegistry.CONFIGURATION_REGISTRY.invokeListenerEvent(
+				id,
+				new CustomClickActionsRegistry.ConfigurationContextImpl(this.handler, payload)
+		);
+	}
+
 	private enum RegisterState {
 		NOT_SENT,
 		SENT,

fabric-networking-api-v1/src/main/java/net/fabricmc/fabric/impl/networking/server/ServerPlayNetworkAddon.java

@@ -20,6 +20,9 @@
 import java.util.List;
 import java.util.Objects;
 
+import org.jetbrains.annotations.Nullable;
+
+import net.minecraft.nbt.NbtElement;
 import net.minecraft.network.ClientConnection;
 import net.minecraft.network.NetworkPhase;
 import net.minecraft.network.packet.CustomPayload;
@@ -35,6 +38,7 @@
 import net.fabricmc.fabric.api.networking.v1.ServerPlayNetworking;
 import net.fabricmc.fabric.impl.networking.AbstractChanneledNetworkAddon;
 import net.fabricmc.fabric.impl.networking.ChannelInfoHolder;
+import net.fabricmc.fabric.impl.networking.CustomClickActionsRegistry;
 import net.fabricmc.fabric.impl.networking.NetworkingImpl;
 import net.fabricmc.fabric.impl.networking.RegistrationPayload;
 
@@ -144,6 +148,14 @@ public boolean requestedReconfigure() {
 		return requestedReconfigure;
 	}
 
+	@Override
+	public void invokeCustomClickActionEvent(Identifier id, @Nullable NbtElement payload) {
+		CustomClickActionsRegistry.PLAY_REGISTRY.invokeListenerEvent(
+				id,
+				new CustomClickActionsRegistry.PlayContextImpl(this.handler, payload)
+		);
+	}
+
 	private record ContextImpl(MinecraftServer server, ServerPlayNetworkHandler handler, PacketSender responseSender) implements ServerPlayNetworking.Context {
 		private ContextImpl {
 			Objects.requireNonNull(server, "server");

fabric-networking-api-v1/src/main/java/net/fabricmc/fabric/mixin/networking/ServerCommonNetworkHandlerMixin.java

@@ -23,6 +23,7 @@
 
 import net.minecraft.network.packet.CustomPayload;
 import net.minecraft.network.packet.c2s.common.CommonPongC2SPacket;
+import net.minecraft.network.packet.c2s.common.CustomClickActionC2SPacket;
 import net.minecraft.network.packet.c2s.common.CustomPayloadC2SPacket;
 import net.minecraft.server.network.ServerCommonNetworkHandler;
 
@@ -55,4 +56,9 @@ private void onPlayPong(CommonPongC2SPacket packet, CallbackInfo ci) {
 			addon.onPong(packet.getParameter());
 		}
 	}
+
+	@Inject(method = "onCustomClickAction", at = @At("TAIL"))
+	protected void hookCustomClickActionEvent(CustomClickActionC2SPacket packet, CallbackInfo ci) {
+		getAddon().invokeCustomClickActionEvent(packet.id(), packet.payload().orElse(null));
+	}
 }

fabric-networking-api-v1/src/main/java/net/fabricmc/fabric/mixin/networking/SignBlockEntityMixin.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2016, 2017, 2018, 2019 FabricMC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package net.fabricmc.fabric.mixin.networking;
+
+import java.util.Optional;
+
+import com.llamalad7.mixinextras.injector.wrapoperation.Operation;
+import com.llamalad7.mixinextras.injector.wrapoperation.WrapOperation;
+import com.llamalad7.mixinextras.sugar.Local;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.injection.At;
+
+import net.minecraft.block.entity.SignBlockEntity;
+import net.minecraft.entity.player.PlayerEntity;
+import net.minecraft.nbt.NbtElement;
+import net.minecraft.server.MinecraftServer;
+import net.minecraft.server.network.ServerPlayerEntity;
+import net.minecraft.util.Identifier;
+
+import net.fabricmc.fabric.impl.networking.CustomClickActionsRegistry;
+
+@Mixin(SignBlockEntity.class)
+public class SignBlockEntityMixin {
+	@WrapOperation(
+			method = "runCommandClickEvent",
+			at = @At(
+					value = "INVOKE",
+					target = "Lnet/minecraft/server/MinecraftServer;handleCustomClickAction(Lnet/minecraft/util/Identifier;Ljava/util/Optional;)V"
+			)
+	)
+	private void hookCustomClickActionListener(MinecraftServer instance, Identifier id, Optional<NbtElement> payload, Operation<Void> original, @Local(argsOnly = true) PlayerEntity player) {
+		original.call(instance, id, payload);
+
+		if (player instanceof ServerPlayerEntity serverPlayer) {
+			CustomClickActionsRegistry.PLAY_REGISTRY.invokeListenerEvent(
+					id,
+					new CustomClickActionsRegistry.PlayContextImpl(serverPlayer.networkHandler, payload.orElse(null))
+			);
+		}
+	}
+}

fabric-networking-api-v1/src/main/resources/fabric-networking-api-v1.mixins.json

@@ -19,6 +19,7 @@
     "ServerConfigurationNetworkHandlerMixin",
     "ServerLoginNetworkHandlerMixin",
     "ServerPlayNetworkHandlerMixin",
+    "SignBlockEntityMixin",
     "accessor.EntityTrackerAccessor",
     "accessor.ServerCommonNetworkHandlerAccessor",
     "accessor.ServerLoginNetworkHandlerAccessor",