From 0c925d2d7a54153ac788712689eba6c1c81607d9 Mon Sep 17 00:00:00 2001 From: Konicai <71294714+Konicai@users.noreply.github.com> Date: Wed, 21 Aug 2024 18:32:15 -0500 Subject: [PATCH] Allow disconnecting any protocol with a compat codec --- .../bedrock/codec/compat/BedrockCompat.java | 46 ++++++++++++++++--- .../DisconnectSerializerCompat.java | 40 ---------------- 2 files changed, 40 insertions(+), 46 deletions(-) delete mode 100644 bedrock-codec/src/main/java/org/cloudburstmc/protocol/bedrock/codec/compat/serializer/DisconnectSerializerCompat.java diff --git a/bedrock-codec/src/main/java/org/cloudburstmc/protocol/bedrock/codec/compat/BedrockCompat.java b/bedrock-codec/src/main/java/org/cloudburstmc/protocol/bedrock/codec/compat/BedrockCompat.java index aac0a9b60..e073b6b9f 100644 --- a/bedrock-codec/src/main/java/org/cloudburstmc/protocol/bedrock/codec/compat/BedrockCompat.java +++ b/bedrock-codec/src/main/java/org/cloudburstmc/protocol/bedrock/codec/compat/BedrockCompat.java @@ -1,10 +1,14 @@ package org.cloudburstmc.protocol.bedrock.codec.compat; import org.cloudburstmc.protocol.bedrock.codec.BedrockCodec; -import org.cloudburstmc.protocol.bedrock.codec.compat.serializer.DisconnectSerializerCompat; import org.cloudburstmc.protocol.bedrock.codec.compat.serializer.LoginSerializerCompat; import org.cloudburstmc.protocol.bedrock.codec.compat.serializer.PlayStatusSerializerCompat; import org.cloudburstmc.protocol.bedrock.codec.compat.serializer.RequestNetworkSettingsSerializerCompat; +import org.cloudburstmc.protocol.bedrock.codec.v291.serializer.DisconnectSerializer_v291; +import org.cloudburstmc.protocol.bedrock.codec.v622.Bedrock_v622; +import org.cloudburstmc.protocol.bedrock.codec.v622.serializer.DisconnectSerializer_v622; +import org.cloudburstmc.protocol.bedrock.codec.v712.Bedrock_v712; +import org.cloudburstmc.protocol.bedrock.codec.v712.serializer.DisconnectSerializer_v712; import org.cloudburstmc.protocol.bedrock.data.PacketRecipient; import org.cloudburstmc.protocol.bedrock.packet.DisconnectPacket; import org.cloudburstmc.protocol.bedrock.packet.LoginPacket; @@ -14,22 +18,52 @@ public class BedrockCompat { /** * This is for servers when figuring out the protocol of a client joining. + * Certain protocols that are older will need to use {@link #disconnectCompat(int)} before disconnecting, + * in order for the client to see a proper disconnect message. */ public static BedrockCodec CODEC = BedrockCodec.builder() .helper(() -> NoopBedrockCodecHelper.INSTANCE) .registerPacket(LoginPacket::new, LoginSerializerCompat.INSTANCE, 1, PacketRecipient.SERVER) .registerPacket(PlayStatusPacket::new, PlayStatusSerializerCompat.INSTANCE, 2, PacketRecipient.CLIENT) - .registerPacket(DisconnectPacket::new, new DisconnectSerializerCompat(true), 5, PacketRecipient.BOTH) + .registerPacket(DisconnectPacket::new, DisconnectSerializer_v712.INSTANCE, 5, PacketRecipient.BOTH) .registerPacket(RequestNetworkSettingsPacket::new, RequestNetworkSettingsSerializerCompat.INSTANCE, 193, PacketRecipient.SERVER) .protocolVersion(0) .minecraftVersion("0.0.0") .build(); /** - * This is legacy version of the compat codec which does not use DisconnectFailReason in DisconnectPacket. - * Use this for servers that do not support Minecraft: Bedrock Edition 1.20.40 and above. + * A legacy version of the compat codec which does not use DisconnectFailReason in DisconnectPacket. + * Use this for protocols lower than v622 */ - public static BedrockCodec CODEC_LEGACY = CODEC.toBuilder() - .updateSerializer(DisconnectPacket.class, new DisconnectSerializerCompat(false)) + public static BedrockCodec CODEC_v291 = CODEC.toBuilder() + .updateSerializer(DisconnectPacket.class, DisconnectSerializer_v291.INSTANCE) .build(); + + /** + * A legacy version of the compat codec which does not use filteredMessage in DisconnectPacket. + * Use this for protocols equal to or greater than v622, but less than v712 + */ + public static BedrockCodec CODEC_v622 = CODEC.toBuilder() + .updateSerializer(DisconnectPacket.class, DisconnectSerializer_v622.INSTANCE) + .build(); + + /** + * Certain older protocols have outdated {@link DisconnectPacket} formats. + * Using the codec provided by this method before disconnecting a client will always + * ensure they receive a well-formed DisconnectPacket. + *

+ * Note that this compat codec should only be used if disconnecting the client upon receiving + * its protocol version. Otherwise, use a proper codec that targets the specific protocol. + * + * @param protocolVersion the client's protocol version + * @return a compat codec suitable for disconnecting + */ + public static BedrockCodec disconnectCompat(int protocolVersion) { + if (protocolVersion < Bedrock_v622.CODEC.getProtocolVersion()) { + return CODEC_v291; + } else if (protocolVersion < Bedrock_v712.CODEC.getProtocolVersion()) { + return CODEC_v622; + } + return CODEC; // v712 or above + } } diff --git a/bedrock-codec/src/main/java/org/cloudburstmc/protocol/bedrock/codec/compat/serializer/DisconnectSerializerCompat.java b/bedrock-codec/src/main/java/org/cloudburstmc/protocol/bedrock/codec/compat/serializer/DisconnectSerializerCompat.java deleted file mode 100644 index bb9955bb9..000000000 --- a/bedrock-codec/src/main/java/org/cloudburstmc/protocol/bedrock/codec/compat/serializer/DisconnectSerializerCompat.java +++ /dev/null @@ -1,40 +0,0 @@ -package org.cloudburstmc.protocol.bedrock.codec.compat.serializer; - -import io.netty.buffer.ByteBuf; -import lombok.RequiredArgsConstructor; -import org.cloudburstmc.protocol.bedrock.codec.BedrockCodecHelper; -import org.cloudburstmc.protocol.bedrock.codec.BedrockPacketSerializer; -import org.cloudburstmc.protocol.bedrock.data.DisconnectFailReason; -import org.cloudburstmc.protocol.bedrock.packet.DisconnectPacket; -import org.cloudburstmc.protocol.common.util.VarInts; - -@RequiredArgsConstructor -public class DisconnectSerializerCompat implements BedrockPacketSerializer { - private final boolean reasonEnum; - - @Override - public void serialize(ByteBuf buffer, BedrockCodecHelper helper, DisconnectPacket packet) { - if (this.reasonEnum) { - VarInts.writeInt(buffer, packet.getReason().ordinal()); - } - buffer.writeBoolean(packet.isMessageSkipped()); - if (!packet.isMessageSkipped()) { - helper.writeString(buffer, packet.getKickMessage()); - helper.writeString(buffer, packet.getFilteredMessage()); - } - } - - @Override - public void deserialize(ByteBuf buffer, BedrockCodecHelper helper, DisconnectPacket packet) { - if (this.reasonEnum) { - packet.setReason(DisconnectFailReason.values()[VarInts.readInt(buffer)]); - } - packet.setMessageSkipped(buffer.readBoolean()); - if (!packet.isMessageSkipped()) { - packet.setKickMessage(helper.readString(buffer)); - if (buffer.isReadable()) { // backwards compatibility - packet.setFilteredMessage(helper.readString(buffer)); - } - } - } -}