Skip to content

Add chat message classes #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aontas wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add chat message classes #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
768c95f
Add chat message classes
aontas Jul 15, 2024
c8734cb
Slightly updated code
aontas Jul 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions BloodstonePlugin.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
using BepInEx.Logging;
using BepInEx.Unity.IL2CPP;
using Bloodstone.API;
using Bloodstone.Network;

namespace Bloodstone
{
Expand Down Expand Up @@ -41,11 +42,13 @@ public override void Load()
{
API.KeybindManager.Load();
// Hooks.Keybindings.Initialize();
Hooks.ClientChat.Initialize();
}

Hooks.OnInitialize.Initialize();
Hooks.GameFrame.Initialize();
Network.SerializationHooks.Initialize();
MessageUtils.RegisterClientInitialisationType();

Logger.LogInfo($"Bloodstone v{MyPluginInfo.PLUGIN_VERSION} loaded.");

Expand All @@ -68,11 +71,13 @@ public override bool Unload()
{
API.KeybindManager.Save();
Hooks.Keybindings.Uninitialize();
Hooks.ClientChat.Uninitialize();
}

Hooks.OnInitialize.Uninitialize();
Hooks.GameFrame.Uninitialize();
Network.SerializationHooks.Uninitialize();
MessageUtils.UnregisterClientInitialisationType();

return true;
}
Expand Down
45 changes: 45 additions & 0 deletions Hooks/ClientChat.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
using System;
using Bloodstone.Network;
using HarmonyLib;
using ProjectM.Network;
using ProjectM.UI;
using Unity.Collections;

namespace Bloodstone.Hooks;

public static class ClientChat
{
private static Harmony? _harmony;

public static void Initialize()
{
if (_harmony != null)
throw new Exception("Detour already initialized. You don't need to call this. The Bloodstone plugin will do it for you.");

_harmony = Harmony.CreateAndPatchAll(typeof(ClientChat), MyPluginInfo.PLUGIN_GUID);
}

public static void Uninitialize()
{
if (_harmony == null)
throw new Exception("Detour wasn't initialized. Are you trying to unload Bloodstone twice?");

_harmony.UnpatchSelf();
}

[HarmonyPrefix]
[HarmonyPatch(typeof(ClientChatSystem), nameof(ClientChatSystem.OnUpdate))]
private static void OnUpdatePrefix(ClientChatSystem __instance)
{
var entities = __instance.__query_172511197_1.ToEntityArray(Allocator.Temp);
foreach (var entity in entities)
{
var ev = __instance.EntityManager.GetComponentData<ChatMessageServerEvent>(entity);
if (ev.MessageType == ServerChatMessageType.System && MessageUtils.DeserialiseMessage(ev.MessageText.ToString()))
{
// Remove this as it is an internal message that the user is unlikely wanting to see in their chat
__instance.EntityManager.DestroyEntity(entity);
}
}
}
}
36 changes: 36 additions & 0 deletions Network/MessageChatRegistry.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
using System;
using System.Collections.Generic;
using System.IO;

namespace Bloodstone.Network;

// Tracks internal registered message types and their event handlers.
internal class MessageChatRegistry
{
internal static Dictionary<string, RegisteredChatEventHandler> _eventHandlers = new();

internal static void Register<T>(RegisteredChatEventHandler handler)
{
var key = MessageRegistry.DeriveKey(typeof(T));

if (_eventHandlers.ContainsKey(key))
throw new Exception($"Network event {key} is already registered");

_eventHandlers.Add(key, handler);
}

internal static void Unregister<T>()
{
var key = MessageRegistry.DeriveKey(typeof(T));

// don't throw if it doesn't exist
_eventHandlers.Remove(key);
}
}

internal class RegisteredChatEventHandler
{
#nullable disable
internal Action<BinaryReader> OnReceiveFromServer { get; init; }
#nullable enable
}
151 changes: 151 additions & 0 deletions Network/MessageUtils.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
using System;
using System.Collections.Generic;
using System.IO;
using Bloodstone.API;
using ProjectM;
using ProjectM.Network;

namespace Bloodstone.Network;

public delegate void ClientConnectionMessageHandler(User fromCharacter);

public static class MessageUtils
{
/// <summary>
/// This function initialises the client to enable the server to send VNetworkChatMessage messages via the in-game chat mechanism.
/// This should only be called once the client is ready to receive messages from the server. A suggestion for this is
/// once the `GameDataManager.GameDataInitialized` is true.
///
/// This gives the client a chance to register any appropriate VNetworkChatMessage types to support reading different
/// data types.
/// </summary>
/// <exception cref="Exception"></exception>
public static void InitialiseClient()
{
if (VWorld.IsServer) throw new System.Exception("InitialiseClient can only be called on the client.");
VNetwork.SendToServerStruct(new ClientRegister() { clientNonce = ClientNonce });
}

/// <summary>
/// The server should add an action on this event to be able to respond with any start-up requests now that the user
/// is ready for messages.
/// </summary>
public static event ClientConnectionMessageHandler? OnClientConnectionEvent;

/// <summary>
/// Send a VNetworkChatMessage message to the client via the in-game chat mechanism.
/// If the client has not yet been initialised (via `InitialiseClient`) then this will not send any message.
///
/// Note: If the client has not registered the VNetworkChatMessage type that we are sending, then they will not
/// receive that message.
/// </summary>
/// <param name="toCharacter">This is the user that the message will be sent to</param>
/// <param name="msg">This is the data packet that will be sent to the user</param>
/// <typeparam name="T"></typeparam>
public static void SendToClient<T>(User toCharacter, T msg) where T : VNetworkChatMessage
{
BloodstonePlugin.Logger.LogDebug("[SERVER] [SEND] VNetworkChatMessage");

// Note: Bloodstone currently doesn't support sending custom server messages to the client :(
// VNetwork.SendToClient(toCharacter, msg);

// ... instead we are going to send the user a chat message, as long as we have them in our initialised list.
if (SupportedUsers.TryGetValue(toCharacter.PlatformId, out var clientNonce))
{
ServerChatUtils.SendSystemMessageToClient(VWorld.Server.EntityManager, toCharacter, $"{SerialiseMessage(msg, clientNonce)}");
}
else
{
BloodstonePlugin.Logger.LogDebug("user nonce not present in supportedUsers");
}
}

private static readonly int ClientNonce = Random.Shared.Next();
private static readonly Dictionary<ulong, int> SupportedUsers = new();

private struct ClientRegister
{
public int clientNonce;
}

internal static void RegisterClientInitialisationType()
{
VNetworkRegistry.RegisterServerboundStruct((FromCharacter from, ClientRegister register) =>
{
var user = VWorld.Server.EntityManager.GetComponentData<User>(from.User);
SupportedUsers[user.PlatformId] = register.clientNonce;

OnClientConnectionEvent?.Invoke(user);
});
}

internal static void UnregisterClientInitialisationType()
{
VNetworkRegistry.UnregisterStruct<ClientRegister>();
}

public static void RegisterType<T>(Action<T> onServerMessageEvent) where T : VNetworkChatMessage, new()
{
MessageChatRegistry.Register<T>(new()
{
OnReceiveFromServer = br =>
{
var msg = new T();
msg.Deserialize(br);
onServerMessageEvent.Invoke(msg);
}
});
}

private static string SerialiseMessage<T>(T msg, int clientNonce) where T : VNetworkChatMessage
{
using var stream = new MemoryStream();
using var bw = new BinaryWriter(stream);

VNetworkChatMessage.WriteHeader(bw, MessageRegistry.DeriveKey(msg.GetType()), clientNonce);

msg.Serialize(bw);
return Convert.ToBase64String(stream.ToArray());
}

internal static bool DeserialiseMessage(string message)
{
var type = "";
try
{
var bytes = Convert.FromBase64String(message);

using var stream = new MemoryStream(bytes);
using var br = new BinaryReader(stream);

// If we can't read the header, it is likely not a VNetworkChatMessage
if (!VNetworkChatMessage.ReadHeader(br, out var clientNonce, out type)) return false;

// This is a valid message, but not intended for us.
if (clientNonce != ClientNonce)
{
BloodstonePlugin.Logger.LogWarning($"ClientNonce did not match: [actual: {clientNonce}, expected: {ClientNonce}]");
return true;
}

if (MessageChatRegistry._eventHandlers.TryGetValue(type, out var handler))
{
handler.OnReceiveFromServer(br);
}

return true;
}
catch (FormatException)
{
BloodstonePlugin.Logger.LogDebug("Invalid base64");
return false;
}
catch (Exception ex)
{
BloodstonePlugin.Logger.LogError($"Error handling incoming network event {type}:");
BloodstonePlugin.Logger.LogError(ex);

return false;
}
}
}
39 changes: 39 additions & 0 deletions Network/VNetworkChatMessage.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
using System;
using System.IO;

namespace Bloodstone.Network;

public interface VNetworkChatMessage
{
internal static void WriteHeader(BinaryWriter writer, string type, int clientNonce)
{
writer.Write(SerializationHooks.BLOODSTONE_NETWORK_EVENT_ID);
writer.Write(clientNonce);
writer.Write(type);
}

internal static bool ReadHeader(BinaryReader reader, out int clientNonce, out string type)
{
type = "";
clientNonce = 0;

try
{
var eventId = reader.ReadInt32();
clientNonce = reader.ReadInt32();
type = reader.ReadString();

return eventId == SerializationHooks.BLOODSTONE_NETWORK_EVENT_ID;
}
catch (Exception e)
{
BloodstonePlugin.Logger.LogDebug($"Failed to read chat message header: {e.Message}");

return false;
}
}

public void Serialize(BinaryWriter writer);

public void Deserialize(BinaryReader reader);
}