Fix 1.18 registerCustomArgumentType

CommandAPI · willkroboth · Nov 19, 2022 · Nov 19, 2022 · Nov 19, 2022 · Nov 20, 2022
commit 537cf5af4642bb06770de0035c2af29b35e1f802
diff --git a/...2/src/main/java/dev/jorel/commandapi/nms/ExceptionHandlingArgumentSerializer_1_18_R2.java b/...2/src/main/java/dev/jorel/commandapi/nms/ExceptionHandlingArgumentSerializer_1_18_R2.java
@@ -0,0 +1,92 @@
+package dev.jorel.commandapi.nms;
+
+import com.google.gson.JsonObject;
+import com.mojang.brigadier.arguments.ArgumentType;
+import dev.jorel.commandapi.CommandAPIHandler;
+import dev.jorel.commandapi.arguments.ExceptionHandlingArgumentType;
+import dev.jorel.commandapi.preprocessor.Differs;
+import net.minecraft.commands.synchronization.ArgumentSerializer;
+import net.minecraft.commands.synchronization.ArgumentTypes;
+import net.minecraft.network.FriendlyByteBuf;
+
+import java.lang.reflect.Field;
+import java.lang.reflect.Method;
+import java.nio.charset.StandardCharsets;
+
+public class ExceptionHandlingArgumentSerializer_1_18_R2<T> implements ArgumentSerializer<ExceptionHandlingArgumentType<T>> {
+	private static Method getInfo = null;
+
+	@Override
+	@Differs(from = {"1.13", "1.14", "1.15", "1.16", "1.17", "1.18", "1.18.1"},
+		by = "ArgumentType.Entry.c -> ArgumentType.Entry.b, ArgumentType.Entry.b -> ArgumentType.Entry.a")
+	public void serializeToNetwork(ExceptionHandlingArgumentType<T> argument, FriendlyByteBuf friendlyByteBuf) {
+		try {
+			// Remove this key from packet
+			if(getInfo == null) {
+				getInfo = ArgumentTypes.class.getDeclaredMethod("b", ArgumentType.class);
+				getInfo.setAccessible(true);
+			}
+			Object myInfo = getInfo.invoke(null, argument);
+
+			Field keyField = CommandAPIHandler.getInstance().getField(myInfo.getClass(), "b");
+			String myKey = keyField.get(myInfo).toString();
+			byte[] myKeyBytes = myKey.getBytes(StandardCharsets.UTF_8);
+			// Removing length and size of string, assuming length is always written as 1 byte
+			friendlyByteBuf.writerIndex(friendlyByteBuf.writerIndex() - myKeyBytes.length - 1);
+
+			// Add baseType key instead
+			ArgumentType<T> baseType = argument.baseType();
+			Object baseInfo = getInfo.invoke(null, baseType);
+			String baseKey = keyField.get(baseInfo).toString();
+			friendlyByteBuf.writeUtf(baseKey);
+
+			// Serialize baseType
+			Field subSerializerField = CommandAPIHandler.getInstance().getField(baseInfo.getClass(), "a");
+			ArgumentSerializer<ArgumentType<T>> subSerializer = (ArgumentSerializer<ArgumentType<T>>) subSerializerField.get(baseInfo);
+			subSerializer.serializeToNetwork(baseType, friendlyByteBuf);
+		} catch (ReflectiveOperationException e) {
+			e.printStackTrace();
+		}
+	}
+
+	@Override
+	@Differs(from = {"1.13", "1.14", "1.15", "1.16", "1.17", "1.18", "1.18.1"},
+		by = "ArgumentType.Entry.c -> ArgumentType.Entry.b, ArgumentType.Entry.b -> ArgumentType.Entry.a")
+	public void serializeToJson(ExceptionHandlingArgumentType<T> argument, JsonObject properties) {
+		try {
+			ArgumentType<T> baseType = argument.baseType();
+
+			if(getInfo == null) {
+				getInfo = ArgumentTypes.class.getDeclaredMethod("b", ArgumentType.class);
+				getInfo.setAccessible(true);
+			}
+			Object baseInfo = getInfo.invoke(null, baseType);
+
+			Field keyField = CommandAPIHandler.getInstance().getField(baseInfo.getClass(), "b");
+			properties.addProperty("baseType", keyField.get(baseInfo).toString());
+
+			Field subSerializerField = CommandAPIHandler.getInstance().getField(baseInfo.getClass(), "a");
+			ArgumentSerializer<ArgumentType<T>> subSerializer = (ArgumentSerializer<ArgumentType<T>>) subSerializerField.get(baseInfo);
+
+			JsonObject subProperties = new JsonObject();
+			subSerializer.serializeToJson(baseType, subProperties);
+			if (subProperties.size() > 0) {
+				properties.add("baseProperties", subProperties);
+			}
+		} catch (ReflectiveOperationException e) {
+			e.printStackTrace();
+		}
+	}
+
+	@Override
+	public ExceptionHandlingArgumentType<T> deserializeFromNetwork(FriendlyByteBuf friendlyByteBuf) {
+		// Since this class overrides its ArgumentRegistry key with the baseType's,
+		// this class's key should never show up in a packet and this method should never
+		// be called to deserialize the ArgumentType info that wasn't put into the packet
+		// anyway. Also, the server shouldn't ever deserialize a PacketPlay*Out*Commands
+		// either. If this method ever gets called, either you or I are doing something very wrong!
+		throw new IllegalStateException("This shouldn't happen! See dev.jorel.commandapi.nms.ExceptionHandlingArgumentSerializer_1_18_R2#deserializeFromNetwork for more information");
+		// Including a mini-stacktrace here in case this exception shows up
+		// on a client-disconnected screen, which is not very helpful
+	}
+}
diff --git a/commandapi-nms/commandapi-1.18.2/src/main/java/dev/jorel/commandapi/nms/NMS_1_18_R2.java b/commandapi-nms/commandapi-1.18.2/src/main/java/dev/jorel/commandapi/nms/NMS_1_18_R2.java
@@ -39,8 +39,7 @@
 import java.util.function.ToIntFunction;
 
 import com.mojang.brigadier.Message;
-import net.md_5.bungee.api.chat.BaseComponent;
-import net.md_5.bungee.chat.ComponentSerializer;
+import dev.jorel.commandapi.arguments.ExceptionHandlingArgumentType;
 import org.bukkit.Bukkit;
 import org.bukkit.Color;
 import org.bukkit.Keyed;
@@ -708,6 +707,11 @@ public void resendPackets(Player player) {
 		MINECRAFT_SERVER.getCommands().sendCommands(((CraftPlayer) player).getHandle());
 	}
 
+	@Override
+	public void registerCustomArgumentType() {
+		ArgumentTypes.register("commandapi:exception_handler", ExceptionHandlingArgumentType.class, new ExceptionHandlingArgumentSerializer_1_18_R2());
+	}
+
 	@Override
 	public Message generateMessageFromJson(String json) {
 		return Serializer.fromJson(json);

diff --git a/...8/src/main/java/dev/jorel/commandapi/nms/ExceptionHandlingArgumentSerializer_1_18_R1.java b/...8/src/main/java/dev/jorel/commandapi/nms/ExceptionHandlingArgumentSerializer_1_18_R1.java
@@ -0,0 +1,87 @@
+package dev.jorel.commandapi.nms;
+
+import com.google.gson.JsonObject;
+import com.mojang.brigadier.arguments.ArgumentType;
+import dev.jorel.commandapi.CommandAPIHandler;
+import dev.jorel.commandapi.arguments.ExceptionHandlingArgumentType;
+import net.minecraft.commands.synchronization.ArgumentSerializer;
+import net.minecraft.commands.synchronization.ArgumentTypes;
+import net.minecraft.network.FriendlyByteBuf;
+
+import java.lang.reflect.Field;
+import java.lang.reflect.Method;
+import java.nio.charset.StandardCharsets;
+
+public class ExceptionHandlingArgumentSerializer_1_18_R1<T> implements ArgumentSerializer<ExceptionHandlingArgumentType<T>> {
+	private static Method getInfo = null;
+
+	@Override
+	public void serializeToNetwork(ExceptionHandlingArgumentType<T> argument, FriendlyByteBuf friendlyByteBuf) {
+		try {
+			// Remove this key from packet
+			if(getInfo == null) {
+				getInfo = ArgumentTypes.class.getDeclaredMethod("b", ArgumentType.class);
+				getInfo.setAccessible(true);
+			}
+			Object myInfo = getInfo.invoke(null, argument);
+
+			Field keyField = CommandAPIHandler.getInstance().getField(myInfo.getClass(), "c");
+			String myKey = keyField.get(myInfo).toString();
+			byte[] myKeyBytes = myKey.getBytes(StandardCharsets.UTF_8);
+			// Removing length and size of string, assuming length is always written as 1 byte
+			friendlyByteBuf.writerIndex(friendlyByteBuf.writerIndex() - myKeyBytes.length - 1);
+
+			// Add baseType key instead
+			ArgumentType<T> baseType = argument.baseType();
+			Object baseInfo = getInfo.invoke(null, baseType);
+			String baseKey = keyField.get(baseInfo).toString();
+			friendlyByteBuf.writeUtf(baseKey);
+
+			// Serialize baseType
+			Field subSerializerField = CommandAPIHandler.getInstance().getField(baseInfo.getClass(), "b");
+			ArgumentSerializer<ArgumentType<T>> subSerializer = (ArgumentSerializer<ArgumentType<T>>) subSerializerField.get(baseInfo);
+			subSerializer.serializeToNetwork(baseType, friendlyByteBuf);
+		} catch (ReflectiveOperationException e) {
+			e.printStackTrace();
+		}
+	}
+
+	@Override
+	public void serializeToJson(ExceptionHandlingArgumentType<T> argument, JsonObject properties) {
+		try {
+			ArgumentType<T> baseType = argument.baseType();
+
+			if(getInfo == null) {
+				getInfo = ArgumentTypes.class.getDeclaredMethod("b", ArgumentType.class);
+				getInfo.setAccessible(true);
+			}
+			Object baseInfo = getInfo.invoke(null, baseType);
+
+			Field keyField = CommandAPIHandler.getInstance().getField(baseInfo.getClass(), "c");
+			properties.addProperty("baseType", keyField.get(baseInfo).toString());
+
+			Field subSerializerField = CommandAPIHandler.getInstance().getField(baseInfo.getClass(), "b");
+			ArgumentSerializer<ArgumentType<T>> subSerializer = (ArgumentSerializer<ArgumentType<T>>) subSerializerField.get(baseInfo);
+
+			JsonObject subProperties = new JsonObject();
+			subSerializer.serializeToJson(baseType, subProperties);
+			if (subProperties.size() > 0) {
+				properties.add("baseProperties", subProperties);
+			}
+		} catch (ReflectiveOperationException e) {
+			e.printStackTrace();
+		}
+	}
+
+	@Override
+	public ExceptionHandlingArgumentType<T> deserializeFromNetwork(FriendlyByteBuf friendlyByteBuf) {
+		// Since this class overrides its ArgumentRegistry key with the baseType's,
+		// this class's key should never show up in a packet and this method should never
+		// be called to deserialize the ArgumentType info that wasn't put into the packet
+		// anyway. Also, the server shouldn't ever deserialize a PacketPlay*Out*Commands
+		// either. If this method ever gets called, either you or I are doing something very wrong!
+		throw new IllegalStateException("This shouldn't happen! See dev.jorel.commandapi.nms.ExceptionHandlingArgumentSerializer_1_18_R1#deserializeFromNetwork for more information");
+		// Including a mini-stacktrace here in case this exception shows up
+		// on a client-disconnected screen, which is not very helpful
+	}
+}
diff --git a/commandapi-nms/commandapi-1.18/src/main/java/dev/jorel/commandapi/nms/NMS_1_18_R1.java b/commandapi-nms/commandapi-1.18/src/main/java/dev/jorel/commandapi/nms/NMS_1_18_R1.java
@@ -37,6 +37,7 @@
 import java.util.function.ToIntFunction;
 
 import com.mojang.brigadier.Message;
+import dev.jorel.commandapi.arguments.ExceptionHandlingArgumentType;
 import net.md_5.bungee.api.chat.BaseComponent;
 import net.md_5.bungee.chat.ComponentSerializer;
 import org.bukkit.Bukkit;
@@ -585,6 +586,11 @@ public void resendPackets(Player player) {
 		MINECRAFT_SERVER.getCommands().sendCommands(((CraftPlayer) player).getHandle());
 	}
 
+	@Override
+	public void registerCustomArgumentType() {
+		ArgumentTypes.register("commandapi:exception_handler", ExceptionHandlingArgumentType.class, new ExceptionHandlingArgumentSerializer_1_18_R1());
+	}
+
 	@Override
 	public Message generateMessageFromJson(String json) {
 		return Serializer.fromJson(json);

diff --git a/...pi-nms/commandapi-1.19-common/src/main/java/dev/jorel/commandapi/nms/NMS_1_19_Common.java b/...pi-nms/commandapi-1.19-common/src/main/java/dev/jorel/commandapi/nms/NMS_1_19_Common.java
@@ -771,6 +771,8 @@ public final void resendPackets(Player player) {
 	}
 
 	@Override
+	@Differs(from = {"1.14, 1.15, 1.16", "1.17", "1.18"},
+		by = "Using ArgumentTypeInfos and Registry.COMMAND_ARGUMENT_TYPE instead of ArgumentRegistry")
 	public void registerCustomArgumentType() {
 		try {
 			// Unfreeze registry

diff --git a/commandapi-nms/commandapi-nms-common/src/main/java/dev/jorel/commandapi/nms/NMS_Common.java b/commandapi-nms/commandapi-nms-common/src/main/java/dev/jorel/commandapi/nms/NMS_Common.java
@@ -728,7 +728,6 @@ public final UUID getUUID(CommandContext<CommandSourceStack> cmdCtx, String key)
 	public abstract void resendPackets(Player player);
 
 	@Override
-	@Differs(from = {"1.14, 1.15, 1.16"}, by = "Using ArgumentTypeInfos and Registry.COMMAND_ARGUMENT_TYPE instead of ArgumentRegistry")
 	@Unimplemented(because = VERSION_SPECIFIC_IMPLEMENTATION)
-	public void registerCustomArgumentType() {}; // TODO: Make abstract
+	public abstract void registerCustomArgumentType();
 }