Initial support for 1.21.5 (#3381)

Author: Ingrim4

build.gradle.kts

@@ -12,7 +12,7 @@ plugins {
 group = "com.comphenix.protocol"
 description = "Provides access to the Minecraft protocol"
 
-val mcVersion = "1.21.4"
+val mcVersion = "1.21.5"
 val isSnapshot = version.toString().endsWith("-SNAPSHOT")
 val buildNumber = System.getenv("BUILD_NUMBER") ?: ""
 val isJenkins = buildNumber.isNotEmpty()
@@ -51,7 +51,7 @@ dependencies {
     compileOnly("org.spigotmc:spigot-api:${mcVersion}-R0.1-SNAPSHOT")
     compileOnly("org.spigotmc:spigot:${mcVersion}-R0.1-SNAPSHOT:remapped-mojang")
     compileOnly("io.netty:netty-all:4.0.23.Final")
-    compileOnly("net.kyori:adventure-text-serializer-gson:4.14.0")
+    compileOnly("net.kyori:adventure-text-serializer-gson:4.19.0")
     compileOnly("com.googlecode.json-simple:json-simple:1.1.1")
 
     testImplementation("org.junit.jupiter:junit-jupiter-engine:5.10.0")

src/main/java/com/comphenix/protocol/PacketType.java

@@ -35,12 +35,13 @@ public class ProtocolLibrary {
     /**
      * The maximum version ProtocolLib has been tested with.
      */
-    public static final String MAXIMUM_MINECRAFT_VERSION = "1.21.1";
+    // TODO(fix): once all tests pass again change this to latest version
+    public static final String MAXIMUM_MINECRAFT_VERSION = "1.21.4";
 
     /**
-     * The date (with ISO 8601 or YYYY-MM-DD) when the most recent version (1.20.4) was released.
+     * The date (with ISO 8601 or YYYY-MM-DD) when the most recent version (1.21.4) was released.
      */
-    public static final String MINECRAFT_LAST_RELEASE_DATE = "2024-08-08";
+    public static final String MINECRAFT_LAST_RELEASE_DATE = "2024-12-03";
 
     private static Plugin plugin;
     private static ProtocolConfig config;

src/main/java/com/comphenix/protocol/ProtocolLibrary.java

@@ -19,8 +19,6 @@
 
 import java.lang.reflect.Field;
 import java.lang.reflect.Modifier;
-import java.lang.reflect.ParameterizedType;
-import java.lang.reflect.Type;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashMap;
@@ -31,18 +29,15 @@
 import java.util.Optional;
 import java.util.Set;
 import java.util.concurrent.ConcurrentHashMap;
-import java.util.function.Function;
 
 import javax.annotation.Nullable;
 
 import com.comphenix.protocol.PacketType;
 import com.comphenix.protocol.PacketType.Sender;
 import com.comphenix.protocol.ProtocolLogger;
+import com.comphenix.protocol.injector.packet.internal.ProtocolRegistry_1_20_5;
 import com.comphenix.protocol.reflect.FuzzyReflection;
 import com.comphenix.protocol.reflect.StructureModifier;
-import com.comphenix.protocol.reflect.accessors.Accessors;
-import com.comphenix.protocol.reflect.accessors.FieldAccessor;
-import com.comphenix.protocol.reflect.accessors.MethodAccessor;
 import com.comphenix.protocol.reflect.fuzzy.FuzzyClassContract;
 import com.comphenix.protocol.reflect.fuzzy.FuzzyFieldContract;
 import com.comphenix.protocol.reflect.fuzzy.FuzzyMethodContract;
@@ -70,7 +65,7 @@ static void reset() {
      * 
      * @author Kristian
      */
-    private static class Register {
+    public static class Register {
         // The main lookup table
         final Map<PacketType, Optional<Class<?>>> typeToClass = new ConcurrentHashMap<>();
 
@@ -82,14 +77,18 @@ private static class Register {
         volatile Set<PacketType> clientPackets = new HashSet<>();
         final List<MapContainer> containers = new ArrayList<>();
 
-        public Register() {
+        private Register() {
         }
 
-        public void registerPacket(PacketType type, Class<?> clazz, Sender sender) {
-            typeToClass.put(type, Optional.of(clazz));
+        public void registerPacket(PacketType type, Class<?> packetClass, Sender sender, WrappedStreamCodec codec) {
+            typeToClass.put(type, Optional.of(packetClass));
+            classToType.put(packetClass, type);
 
-            classToType.put(clazz, type);
-            protocolClassToType.computeIfAbsent(type.getProtocol(), __ -> new ConcurrentHashMap<>()).put(clazz, type);
+            if (codec != null) {
+                classToCodec.put(packetClass, codec);
+            }
+
+            protocolClassToType.computeIfAbsent(type.getProtocol(), __ -> new ConcurrentHashMap<>()).put(packetClass, type);
 
             if (sender == Sender.CLIENT) {
                 clientPackets.add(type);
@@ -293,206 +292,9 @@ private static synchronized Register createRegisterV1_15_0() {
         return result;
     }
 
-    @SuppressWarnings("unchecked")
     private static synchronized Register createRegisterV1_20_5() {
-        Object[] protocols = ENUM_PROTOCOL.getEnumConstants();
-
-        // PacketType<?> to class map
-        final Map<Object, Class<?>> packetTypeMap = new HashMap<>();
-
-        // List of all class containing PacketTypes
-        String[] packetTypesClassNames = new String[] {
-                "common.CommonPacketTypes",
-                "configuration.ConfigurationPacketTypes",
-                "cookie.CookiePacketTypes",
-                "game.GamePacketTypes",
-                "handshake.HandshakePacketTypes",
-                "login.LoginPacketTypes",
-                "ping.PingPacketTypes",
-                "status.StatusPacketTypes"
-        };
-
-        Class<?> packetTypeClass = MinecraftReflection.getMinecraftClass("network.protocol.PacketType");
-
-        for (String packetTypesClassName : packetTypesClassNames) {
-            Class<?> packetTypesClass = MinecraftReflection
-                    .getOptionalNMS("network.protocol." + packetTypesClassName)
-                    .orElse(null);
-            if (packetTypesClass == null) {
-                ProtocolLogger.debug("Can't find PacketType class: {0}, will skip it", packetTypesClassName);
-                continue;
-            }
-
-            // check every field for "static final PacketType<?>"
-            for (Field field : packetTypesClass.getDeclaredFields()) {
-                try {
-                    if (!Modifier.isFinal(field.getModifiers()) || !Modifier.isStatic(field.getModifiers())) {
-                        continue;
-                    }
-
-                    Object packetType = field.get(null);
-                    if (!packetTypeClass.isInstance(packetType)) {
-                        continue;
-                    }
-
-                    // retrieve the generic type T of the PacketType<T> field
-                    Type packet = ((ParameterizedType) field.getGenericType()).getActualTypeArguments()[0];
-                    if (packet instanceof Class<?>) {
-                        packetTypeMap.put(packetType, (Class<?>) packet);
-                    }
-                } catch (Exception e) {
-                    e.printStackTrace();
-                    continue;
-                }
-            }
-        }
-
-        // ID to Packet class maps
-        final Map<Object, Map<Class<?>, Integer>> serverMaps = new LinkedHashMap<>();
-        final Map<Object, Map<Class<?>, Integer>> clientMaps = new LinkedHashMap<>();
-
-        // global registry instance
         final Register result = new Register();
-
-        // List of all class containing ProtocolInfos
-        String[] protocolClassNames = new String[] {
-                "configuration.ConfigurationProtocols",
-                "game.GameProtocols",
-                "handshake.HandshakeProtocols",
-                "login.LoginProtocols",
-                "status.StatusProtocols"
-        };
-
-        Class<?> protocolInfoClass = MinecraftReflection.getProtocolInfoClass();
-        Class<?> protocolInfoUnboundClass = MinecraftReflection.getProtocolInfoUnboundClass();
-        Class<?> streamCodecClass = MinecraftReflection.getStreamCodecClass();
-        Class<?> idCodecClass = MinecraftReflection.getMinecraftClass("network.codec.IdDispatchCodec");
-        Class<?> idCodecEntryClass = MinecraftReflection.getMinecraftClass("network.codec.IdDispatchCodec$Entry", "network.codec.IdDispatchCodec$b");
-        Class<?> protocolDirectionClass = MinecraftReflection.getPacketFlowClass();
-
-        Function<?, ?> emptyFunction = input -> input;
-
-        FuzzyReflection protocolInfoReflection = FuzzyReflection.fromClass(protocolInfoClass);
-
-        MethodAccessor protocolAccessor = Accessors.getMethodAccessor(protocolInfoReflection
-                .getMethodByReturnTypeAndParameters("id", MinecraftReflection.getEnumProtocolClass(), new Class[0]));
-
-        MethodAccessor directionAccessor = Accessors.getMethodAccessor(protocolInfoReflection
-                .getMethodByReturnTypeAndParameters("flow", protocolDirectionClass, new Class[0]));
-
-        MethodAccessor codecAccessor = Accessors.getMethodAccessor(
-                protocolInfoReflection.getMethodByReturnTypeAndParameters("codec", streamCodecClass, new Class[0]));
-
-        MethodAccessor bindAccessor = Accessors.getMethodAccessor(FuzzyReflection.fromClass(protocolInfoUnboundClass)
-                .getMethodByReturnTypeAndParameters("bind", protocolInfoClass, new Class[] { Function.class }));
-
-        FuzzyReflection idCodecReflection = FuzzyReflection.fromClass(idCodecClass, true);
-
-        FieldAccessor byIdAccessor = Accessors.getFieldAccessor(idCodecReflection
-                .getField(FuzzyFieldContract.newBuilder().typeDerivedOf(List.class).build()));
-
-        FieldAccessor toIdAccessor = Accessors.getFieldAccessor(idCodecReflection
-                .getField(FuzzyFieldContract.newBuilder().typeDerivedOf(Map.class).build()));
-
-        FuzzyReflection idCodecEntryReflection = FuzzyReflection.fromClass(idCodecEntryClass, true);
-
-        MethodAccessor idCodecEntryTypeAccessor = Accessors.getMethodAccessor(idCodecEntryReflection
-                .getMethodByReturnTypeAndParameters("type", Object.class, new Class[0]));
-
-        MethodAccessor idCodecEntrySerializerAccessor = Accessors.getMethodAccessor(idCodecEntryReflection
-                .getMethodByReturnTypeAndParameters("serializer", streamCodecClass, new Class[0]));
-
-        for (String protocolClassName : protocolClassNames) {
-            Class<?> protocolClass = MinecraftReflection
-                    .getOptionalNMS("network.protocol." + protocolClassName)
-                    .orElse(null);
-            if (protocolClass == null) {
-                ProtocolLogger.debug("Can't find protocol class: {0}, will skip it", protocolClassName);
-                continue;
-            }
-
-            for (Field field : protocolClass.getDeclaredFields()) {
-                try {
-                    // ignore none static and final fields
-                    if (!Modifier.isFinal(field.getModifiers()) || !Modifier.isStatic(field.getModifiers())) {
-                        continue;
-                    }
-
-                    Object protocolInfo = field.get(null);
-
-                    // bind unbound ProtocolInfo to empty function to get real ProtocolInfo
-                    if (protocolInfoUnboundClass.isInstance(protocolInfo)) {
-                        protocolInfo = bindAccessor.invoke(protocolInfo, new Object[] { emptyFunction });
-                    }
-
-                    // ignore any field that isn't a ProtocolInfo
-                    if (!protocolInfoClass.isInstance(protocolInfo)) {
-                        continue;
-                    }
-
-                    // get codec and check if codec is instance of IdDispatchCodec
-                    // since that is the only support codec as of now
-                    Object codec = codecAccessor.invoke(protocolInfo);
-                    if (!idCodecClass.isInstance(codec)) {
-                        continue;
-                    }
-
-                    // retrieve packetTypeMap and convert it to packetIdMap
-                    Map<Class<?>, Integer> packetMap = new HashMap<>();
-                    List<Object> serializerList = (List<Object>) byIdAccessor.get(codec);
-                    Map<Object, Integer> packetTypeIdMap = (Map<Object, Integer>) toIdAccessor.get(codec);
-
-                    for (Map.Entry<Object, Integer> entry : packetTypeIdMap.entrySet()) {
-                        Class<?> packetClass = packetTypeMap.get(entry.getKey());
-                        if (packetClass == null) {
-                            throw new RuntimeException("packetType missing packet " + entry.getKey());
-                        }
-
-                        packetMap.put(packetClass, entry.getValue());
-                    }
-
-                    // retrieve packet codecs for packet construction and write methods
-                    for (Object entry : serializerList) {
-                        Object packetType = idCodecEntryTypeAccessor.invoke(entry);
-
-                        Class<?> packetClass = packetTypeMap.get(packetType);
-                        if (packetClass == null) {
-                            throw new RuntimeException("packetType missing packet " + packetType);
-                        }
-
-                        Object serializer = idCodecEntrySerializerAccessor.invoke(entry);
-                        result.classToCodec.put(packetClass, new WrappedStreamCodec(serializer));
-                    }
-
-                    // get EnumProtocol and Direction of protocol info
-                    Object protocol = protocolAccessor.invoke(protocolInfo);
-                    String direction = directionAccessor.invoke(protocolInfo).toString();
-
-                    if (direction.contains("CLIENTBOUND")) { // Sent by Server
-                        serverMaps.put(protocol, packetMap);
-                    } else if (direction.contains("SERVERBOUND")) { // Sent by Client
-                        clientMaps.put(protocol, packetMap);
-                    }
-                } catch (Exception e) {
-                    e.printStackTrace();
-                    continue;
-                }
-            }
-        }
-
-        for (Object protocol : protocols) {
-            Enum<?> enumProtocol = (Enum<?>) protocol;
-            PacketType.Protocol equivalent = PacketType.Protocol.fromVanilla(enumProtocol);
-
-            // Associate known types
-            if (serverMaps.containsKey(protocol)) {
-                associatePackets(result, reverse(serverMaps.get(protocol)), equivalent, Sender.SERVER);
-            }
-            if (clientMaps.containsKey(protocol)) {
-                associatePackets(result, reverse(clientMaps.get(protocol)), equivalent, Sender.CLIENT);
-            }
-        }
-
+        ProtocolRegistry_1_20_5.fillRegister(result);
         return result;
     }
 
@@ -517,7 +319,7 @@ protected static void associatePackets(Register register, Map<Integer, Class<?>>
             PacketType type = PacketType.fromCurrent(protocol, sender, packetId, packetClass);
 
             try {
-                register.registerPacket(type, packetClass, sender);
+                register.registerPacket(type, packetClass, sender, null);
             } catch (Exception ex) {
                 ProtocolLogger.debug("Encountered an exception associating packet " + type, ex);
             }

src/main/java/com/comphenix/protocol/injector/packet/PacketRegistry.java

@@ -0,0 +1,71 @@
+package com.comphenix.protocol.injector.packet.internal;
+
+import java.util.Arrays;
+import java.util.List;
+
+import com.comphenix.protocol.reflect.FuzzyReflection;
+import com.comphenix.protocol.reflect.accessors.Accessors;
+import com.comphenix.protocol.reflect.accessors.FieldAccessor;
+import com.comphenix.protocol.reflect.accessors.MethodAccessor;
+import com.comphenix.protocol.reflect.fuzzy.FuzzyFieldContract;
+import com.comphenix.protocol.utility.MinecraftReflection;
+import com.comphenix.protocol.wrappers.AbstractWrapper;
+import com.comphenix.protocol.wrappers.WrappedStreamCodec;
+
+/**
+ * Class only works for version 1.20.5+
+ */
+public class IdCodecWrapper extends AbstractWrapper {
+
+    private static final Class<?> ID_CODEC_CLASS;
+    private static final FieldAccessor BY_ID_ACCESSOR;
+
+    private static final Class<?> ID_CODEC_ENTRY_CLASS;
+    private static final MethodAccessor ENTRY_TYPE_ACCESSOR;
+    private static final MethodAccessor ENTRY_SERIALIZER_ACCESSOR;
+
+    static {
+        ID_CODEC_CLASS = MinecraftReflection.getMinecraftClass("network.codec.IdDispatchCodec");
+        BY_ID_ACCESSOR = Accessors.getFieldAccessor(FuzzyReflection.fromClass(ID_CODEC_CLASS, true)
+                .getField(FuzzyFieldContract.newBuilder().typeDerivedOf(List.class).build()));
+
+        ID_CODEC_ENTRY_CLASS = Arrays.stream(ID_CODEC_CLASS.getNestMembers())
+            .filter(Class::isRecord)
+            .findFirst()
+            .orElseThrow(() -> new RuntimeException("Failed to find entry class for: " + ID_CODEC_CLASS));
+
+        FuzzyReflection entryReflection = FuzzyReflection.fromClass(ID_CODEC_ENTRY_CLASS, true);
+        ENTRY_TYPE_ACCESSOR = Accessors.getMethodAccessor(entryReflection
+                .getMethodByReturnTypeAndParameters("type", Object.class, new Class[0]));
+        ENTRY_SERIALIZER_ACCESSOR = Accessors.getMethodAccessor(entryReflection
+                .getMethodByReturnTypeAndParameters("serializer", MinecraftReflection.getStreamCodecClass(), new Class[0]));
+    }
+
+    public IdCodecWrapper(Object handle) {
+        super(ID_CODEC_CLASS);
+        setHandle(handle);
+    }
+
+    public List<Entry> getById() {
+        // list represents a packet-id to {type, codec} lookup
+        List<?> byId = (List<?>) BY_ID_ACCESSOR.get(this.handle);
+        return byId.stream().map(Entry::new).toList();
+    }
+
+    public class Entry extends AbstractWrapper {
+
+        public Entry(Object handle) {
+            super(ID_CODEC_ENTRY_CLASS);
+            setHandle(handle);
+        }
+
+        public Object type() {
+            return ENTRY_TYPE_ACCESSOR.invoke(this.handle);
+        }
+
+        public WrappedStreamCodec serializer() {
+            Object serializer = ENTRY_SERIALIZER_ACCESSOR.invoke(this.handle);
+            return new WrappedStreamCodec(serializer);
+        }
+    }
+}