Improved Wrapping of PlayerInfoData and support chat session data (#2361)

* Improved Wrapping of PlayerInfoData and support chat session data
* added constructor for unambiguous creation of playerinfodata without signature

Author: lukalt

src/main/java/com/comphenix/protocol/events/AbstractStructure.java

@@ -961,7 +961,7 @@ public StructureModifier<Instant> getInstants() {
     }
 
     /**
-     * Retrieve a read/write structure for profile public keys in 1.9
+     * Retrieve a read/write structure for profile public keys in 1.19
      * @return The Structure Modifier
      */
     public StructureModifier<WrappedProfilePublicKey> getProfilePublicKeys() {
@@ -971,13 +971,24 @@ public StructureModifier<WrappedProfilePublicKey> getProfilePublicKeys() {
     }
 
     /**
-     * Retrieve a read/write structure for profile public key data in 1.9
+     * Retrieve a read/write structure for profile public key data in 1.19
      * @return The Structure Modifier
      */
     public StructureModifier<WrappedProfileKeyData> getProfilePublicKeyData() {
         return structureModifier.withType(
-            MinecraftReflection.getProfilePublicKeyDataClass(),
-            BukkitConverters.getWrappedPublicKeyDataConverter());
+                MinecraftReflection.getProfilePublicKeyDataClass(),
+                BukkitConverters.getWrappedPublicKeyDataConverter());
+    }
+
+    /**
+     * Retrieves read/write structure for remote chat session data in 1.19.3
+     * @return The Structure Modifier
+     */
+    public StructureModifier<WrappedRemoteChatSessionData> getRemoteChatSessionData() {
+        return structureModifier.withType(
+                MinecraftReflection.getRemoteChatSessionDataClass(),
+                BukkitConverters.getWrappedRemoteChatSessionDataConverter()
+        );
     }
 
     /**

src/main/java/com/comphenix/protocol/utility/MinecraftReflection.java

@@ -1621,6 +1621,10 @@ public static Class<?> getRemoteChatSessionClass() {
 		return getMinecraftClass("network.chat.RemoteChatSession");
 	}
 
+	public static Class<?> getRemoteChatSessionDataClass() {
+		return getRemoteChatSessionClass().getClasses()[0];
+	}
+
 	public static Class<?> getFastUtilClass(String className) {
 		return getLibraryClass("it.unimi.dsi.fastutil." + className);
 	}

src/main/java/com/comphenix/protocol/wrappers/BukkitConverters.java

@@ -604,6 +604,10 @@ public static EquivalentConverter<WrappedProfileKeyData> getWrappedPublicKeyData
 		return ignoreNull(handle(WrappedProfileKeyData::getHandle, WrappedProfileKeyData::new, WrappedProfileKeyData.class));
 	}
 
+	public static EquivalentConverter<WrappedRemoteChatSessionData> getWrappedRemoteChatSessionDataConverter() {
+		return ignoreNull(handle(WrappedRemoteChatSessionData::getHandle, WrappedRemoteChatSessionData::new, WrappedRemoteChatSessionData.class));
+	}
+
 	/**
 	 * @return converter for cryptographic signature data that are used in login and chat packets
 	 */

src/main/java/com/comphenix/protocol/wrappers/PlayerInfoData.java

@@ -30,6 +30,8 @@
 import com.comphenix.protocol.utility.MinecraftVersion;
 import com.comphenix.protocol.wrappers.EnumWrappers.NativeGameMode;
 
+import javax.annotation.Nullable;
+
 /**
  * Represents an immutable PlayerInfoData in the PLAYER_INFO packet.
  * @author dmulloy2
@@ -43,6 +45,9 @@ public class PlayerInfoData {
 	private final NativeGameMode gameMode;
 	private final WrappedGameProfile profile;
 	private final WrappedChatComponent displayName;
+	@Nullable
+	private final WrappedRemoteChatSessionData remoteChatSessionData;
+	@Nullable
 	private final WrappedProfileKeyData profileKeyData;
 
 	// This is the same order as the NMS class, minus the packet (which isn't a field)
@@ -54,21 +59,75 @@ public PlayerInfoData(WrappedGameProfile profile, int latency, NativeGameMode ga
 		this(profile.getUUID(), latency, true, gameMode, profile, displayName, keyData);
 	}
 
-	public PlayerInfoData(UUID profileId, int latency, boolean listed, NativeGameMode gameMode, WrappedGameProfile profile, WrappedChatComponent displayName, WrappedProfileKeyData profileKeyData) {
+	/**
+	 * Constructs a new PlayerInfoData for Minecraft 1.19 or later without signature data
+	 * @see PlayerInfoData#PlayerInfoData(UUID, int, boolean, NativeGameMode, WrappedGameProfile, WrappedChatComponent, WrappedRemoteChatSessionData)
+	 *
+	 * @param profileId the id of the profile (has to be non-null)
+	 * @param latency the latency in milliseconds
+	 * @param listed whether the player is listed in the tab list
+	 * @param gameMode the game mode
+	 * @param profile the game profile
+	 * @param displayName display name in tab list (optional)
+	 */
+	public PlayerInfoData(UUID profileId, int latency, boolean listed, NativeGameMode gameMode, WrappedGameProfile profile, WrappedChatComponent displayName) {
+		this(profileId, latency, listed, gameMode, profile, displayName, (WrappedRemoteChatSessionData) null);
+	}
+
+	/**
+	 * Constructs a new PlayerInfoData for Minecraft 1.19. This is incompatible on 1.19.3.
+	 * @see PlayerInfoData#PlayerInfoData(UUID, int, boolean, NativeGameMode, WrappedGameProfile, WrappedChatComponent, WrappedRemoteChatSessionData)
+	 *
+	 * @param profileId the id of the profile (has to be non-null)
+	 * @param latency the latency in milliseconds
+	 * @param listed whether the player is listed in the tab list
+	 * @param gameMode the game mode
+	 * @param profile the game profile
+	 * @param displayName display name in tab list (optional)
+	 * @param profileKeyData the public key for the profile or null
+	 */
+	@Deprecated
+	public PlayerInfoData(UUID profileId, int latency, boolean listed, NativeGameMode gameMode, WrappedGameProfile profile, WrappedChatComponent displayName, @Nullable WrappedProfileKeyData profileKeyData) {
 		this.profileId = profileId;
 		this.latency = latency;
 		this.listed = listed;
 		this.gameMode = gameMode;
 		this.profile = profile;
 		this.displayName = displayName;
 		this.profileKeyData = profileKeyData;
+		this.remoteChatSessionData = null;
+	}
+
+	/**
+	 * Constructs a new PlayerInfoData for Minecraft 1.19.3 or later.
+	 *
+	 * @param profileId the id of the profile (has to be non-null)
+	 * @param latency the latency in milliseconds
+	 * @param listed whether the player is listed in the tab list
+	 * @param gameMode the game mode
+	 * @param profile the game profile
+	 * @param displayName display name in tab list (optional)
+	 * @param remoteChatSession the remote chat session for this profile or null
+	 */
+	public PlayerInfoData(UUID profileId, int latency, boolean listed, NativeGameMode gameMode, WrappedGameProfile profile, WrappedChatComponent displayName, @Nullable WrappedRemoteChatSessionData remoteChatSession) {
+		this.profileId = profileId;
+		this.latency = latency;
+		this.listed = listed;
+		this.gameMode = gameMode;
+		this.profile = profile;
+		this.displayName = displayName;
+		this.profileKeyData = null;
+		this.remoteChatSessionData = remoteChatSession;
 	}
 
 	/**
 	 * Get the id of the affected profile (since 1.19.3)
 	 * @return the id of the profile
 	 */
 	public UUID getProfileId() {
+		if(profileId == null && profile != null) {
+			return profile.getUUID(); // Ensure forward compatability
+		}
 		return profileId;
 	}
 
@@ -97,7 +156,7 @@ public int getLatency() {
 	}
 
 	/**
-	 * Gets if the player is listed on the client.
+	 * Gets if the player is listed on the client (since 1.19.3)
 	 * @return if the player is listed
 	 */
 	public boolean isListed() {
@@ -121,11 +180,21 @@ public WrappedChatComponent getDisplayName() {
 	}
 
 	/**
-	 * Gets the profile key data of the player represented by this data, null if not present.
-	 * @return The profile key data
+	 * Returns the public key of the profile (since 1.19). Returns the public key of the remote chat session since 1.19.3
+	 * @return The public key of the profile.
 	 */
+	@Nullable
 	public WrappedProfileKeyData getProfileKeyData() {
-		return this.profileKeyData;
+		return this.profileKeyData != null ? this.profileKeyData : (this.remoteChatSessionData != null ? this.remoteChatSessionData.getProfilePublicKey() : null);
+	}
+
+	/**
+	 * Returns the remoteChatSessionData (since 1.19.3)
+ 	 * @return The remote chat sesion data or null
+	 */
+	@Nullable
+	public WrappedRemoteChatSessionData getRemoteChatSessionData() {
+		return this.remoteChatSessionData;
 	}
 
 	/**
@@ -157,8 +226,7 @@ public Object getGeneric(PlayerInfoData specific) {
 						args.add(MinecraftReflection.getIChatBaseComponentClass());
 
 						if (MinecraftVersion.FEATURE_PREVIEW_UPDATE.atOrAbove()) {
-							// RemoteChatSession$a...
-							args.add(MinecraftReflection.getRemoteChatSessionClass().getClasses()[0]);
+							args.add(MinecraftReflection.getRemoteChatSessionDataClass());
 						} else if (MinecraftVersion.WILD_UPDATE.atOrAbove()) {
 							args.add(MinecraftReflection.getProfilePublicKeyDataClass());
 						}
@@ -175,26 +243,28 @@ public Object getGeneric(PlayerInfoData specific) {
 					Object gameMode = EnumWrappers.getGameModeConverter().getGeneric(specific.gameMode);
 					Object displayName = specific.displayName != null ? specific.displayName.handle : null;
 
+					Object profile = specific.profile != null ? specific.profile.handle : null;
 					if (MinecraftVersion.FEATURE_PREVIEW_UPDATE.atOrAbove()) {
 						return constructor.newInstance(
 								specific.profileId,
-								specific.profile.handle,
+								profile,
 								specific.listed,
 								specific.latency,
 								gameMode,
 								displayName,
-								 null); // TODO: do we want to support this?
+								specific.remoteChatSessionData != null ? BukkitConverters.getWrappedRemoteChatSessionDataConverter().getGeneric(specific.remoteChatSessionData) : null
+						);
 					} else if (MinecraftVersion.WILD_UPDATE.atOrAbove()) {
 						return constructor.newInstance(
-								specific.profile.handle,
+								profile,
 								specific.latency,
 								gameMode,
 								displayName,
 								specific.profileKeyData == null ? null : specific.profileKeyData.handle);
 					} else if (MinecraftVersion.CAVES_CLIFFS_1.atOrAbove()) {
-						return constructor.newInstance(specific.profile.handle, specific.latency, gameMode, displayName);
+						return constructor.newInstance(profile, specific.latency, gameMode, displayName);
 					} else {
-						return constructor.newInstance(null, specific.profile.handle, specific.latency, gameMode, displayName);
+						return constructor.newInstance(null, profile, specific.latency, gameMode, displayName);
 					}
 				} catch (Exception e) {
 					throw new RuntimeException("Failed to construct PlayerInfoData.", e);
@@ -222,8 +292,18 @@ public PlayerInfoData getSpecific(Object generic) {
 							MinecraftReflection.getIChatBaseComponentClass(), BukkitConverters.getWrappedChatComponentConverter());
 					WrappedChatComponent displayName = displayNames.read(0);
 
+					if(MinecraftVersion.FEATURE_PREVIEW_UPDATE.atOrAbove()) {
+						return new PlayerInfoData(modifier.<UUID>withType(UUID.class).read(0),
+								latency,
+								modifier.<Boolean>withType(boolean.class).read(0),
+								gameMode,
+								gameProfile,
+								displayName,
+								modifier.withType(MinecraftReflection.getRemoteChatSessionDataClass(), BukkitConverters.getWrappedRemoteChatSessionDataConverter()).read(0)
+								);
+					}
 					WrappedProfileKeyData key = null;
-					if (MinecraftVersion.WILD_UPDATE.atOrAbove() && !MinecraftVersion.FEATURE_PREVIEW_UPDATE.atOrAbove()) {
+					if (MinecraftVersion.WILD_UPDATE.atOrAbove()) {
 						StructureModifier<WrappedProfileKeyData> keyData = modifier.withType(
 								MinecraftReflection.getProfilePublicKeyDataClass(), BukkitConverters.getWrappedPublicKeyDataConverter());
 						key = keyData.read(0);
@@ -253,20 +333,34 @@ public boolean equals(Object obj) {
 		// Only compare objects of similar type
 		if (obj instanceof PlayerInfoData) {
 			PlayerInfoData other = (PlayerInfoData) obj;
-			return profile.equals(other.profile) && latency == other.latency && gameMode == other.gameMode
-					&& Objects.equals(displayName, other.displayName);
+			return Objects.equals(profile, other.profile)
+					&& Objects.equals(profileId, other.profileId)
+					&& latency == other.latency
+					&& gameMode == other.gameMode
+					&& Objects.equals(displayName, other.displayName)
+					&& listed == other.listed
+					&& Objects.equals(remoteChatSessionData, other.remoteChatSessionData)
+					&& Objects.equals(profileKeyData, other.profileKeyData);
 		}
 		return false;
 	}
 
 	@Override
 	public int hashCode() {
-		return Objects.hash(latency, gameMode, profile, displayName);
+		return Objects.hash(latency, gameMode, profile, displayName, profileKeyData, remoteChatSessionData, listed);
 	}
 
 	@Override
 	public String toString() {
+		if(MinecraftVersion.FEATURE_PREVIEW_UPDATE.atOrAbove()) {
+			return String.format("PlayerInfoData[latency=%s, listed=%b, gameMode=%s, profile=%s, displayName=%s, remoteChatSession=%s]",
+					latency, listed, gameMode, profile, displayName, remoteChatSessionData);
+		}
+		if(MinecraftVersion.WILD_UPDATE.atOrAbove()) {
+			return String.format("PlayerInfoData[latency=%s, listed=%b, gameMode=%s, profile=%s, displayName=%s, profilePublicKey=%s]",
+					latency, listed, gameMode, profile, displayName, profileKeyData);
+		}
 		return String.format("PlayerInfoData[latency=%s, gameMode=%s, profile=%s, displayName=%s]",
-				latency, gameMode, profile, displayName);
+			latency, gameMode, profile, displayName);
 	}
 }

src/main/java/com/comphenix/protocol/wrappers/WrappedRemoteChatSessionData.java

@@ -0,0 +1,96 @@
+package com.comphenix.protocol.wrappers;
+
+import com.comphenix.protocol.reflect.StructureModifier;
+import com.comphenix.protocol.reflect.accessors.Accessors;
+import com.comphenix.protocol.reflect.accessors.ConstructorAccessor;
+import com.comphenix.protocol.utility.MinecraftReflection;
+
+import java.util.UUID;
+
+/**
+ * A wrapper around the remote chat session.
+ *
+ * @since 1.19.3
+ */
+public class WrappedRemoteChatSessionData extends AbstractWrapper {
+	private final static Class<?> HANDLE_TYPE = MinecraftReflection.getRemoteChatSessionDataClass();
+	private static ConstructorAccessor CONSTRUCTOR;
+	private StructureModifier<Object> modifier;
+
+	/**
+	 * Constructs a new profile public key wrapper directly from a nms RemoteChatSession.Data/RemoteChatSession.a object.
+	 *
+	 * @param handle the handle to create the wrapper from.
+	 */
+	public WrappedRemoteChatSessionData(Object handle) {
+		super(HANDLE_TYPE);
+		this.setHandle(handle);
+	}
+
+	public WrappedRemoteChatSessionData(UUID sessionId, WrappedProfilePublicKey.WrappedProfileKeyData profilePublicKey) {
+		super(HANDLE_TYPE);
+		if (CONSTRUCTOR == null) {
+			CONSTRUCTOR = Accessors.getConstructorAccessor(
+					this.getHandleType(),
+					UUID.class, MinecraftReflection.getProfilePublicKeyDataClass());
+		}
+
+		this.setHandle(CONSTRUCTOR.invoke(sessionId, profilePublicKey.getHandle()));
+	}
+
+	/**
+	 * Retrieves the id of the current session
+	 * @return session id
+	 */
+	public UUID getSessionID() {
+		return this.modifier.<UUID>withType(UUID.class).read(0);
+	}
+
+	/**
+	 * Set the id for this session
+	 * @param sessionId new session id
+	 */
+	public void setSessionID(UUID sessionId) {
+		this.modifier.<UUID>withType(UUID.class).write(0, sessionId);
+	}
+
+	/**
+	 * Retrieves the ProfileKeyData
+	 * @return the public key data for this session
+	 */
+	public WrappedProfilePublicKey.WrappedProfileKeyData getProfilePublicKey() {
+		return this.modifier.withType(MinecraftReflection.getProfilePublicKeyDataClass(), BukkitConverters.getWrappedPublicKeyDataConverter()).read(0);
+	}
+
+	/**
+	 * Set the profile key data for this session
+	 * @param data ProfileKeyData
+	 */
+	public void setProfilePublicKey(WrappedProfilePublicKey.WrappedProfileKeyData data) {
+		this.modifier.withType(MinecraftReflection.getProfilePublicKeyDataClass(), BukkitConverters.getWrappedPublicKeyDataConverter()).write(0, data);
+	}
+
+	@Override
+	protected void setHandle(Object handle) {
+		super.setHandle(handle);
+		this.modifier = new StructureModifier<>(HANDLE_TYPE).withTarget(handle);
+	}
+
+	@Override
+	public boolean equals(Object obj) {
+		if(obj instanceof WrappedRemoteChatSessionData) {
+			return handle.equals(((WrappedRemoteChatSessionData) obj).getHandle());
+		}
+		return false;
+	}
+
+	@Override
+	public String toString() {
+		return handle.toString();
+	}
+
+	@Override
+	public int hashCode() {
+		return handle.hashCode();
+	}
+}