Merge pull request #2550 from RedworkDE/logmessage

Add event for LogMessages being added to the chat

Dalamud/Game/Chat/LogMessage.cs

@@ -0,0 +1,221 @@
+using System.Diagnostics.CodeAnalysis;
+
+using Dalamud.Data;
+using Dalamud.Utility;
+
+using FFXIVClientStructs.FFXIV.Client.System.String;
+using FFXIVClientStructs.FFXIV.Client.UI.Agent;
+using FFXIVClientStructs.FFXIV.Client.UI.Misc;
+using FFXIVClientStructs.FFXIV.Component.Text;
+using FFXIVClientStructs.Interop;
+
+using Lumina.Excel;
+using Lumina.Text.ReadOnly;
+
+namespace Dalamud.Game.Chat;
+
+/// <summary>
+/// Interface representing a log message.
+/// </summary>
+public interface ILogMessage : IEquatable<ILogMessage>
+{
+    /// <summary>
+    /// Gets the address of the log message in memory.
+    /// </summary>
+    nint Address { get; }
+
+    /// <summary>
+    /// Gets the ID of this log message.
+    /// </summary>
+    uint LogMessageId { get; }
+
+    /// <summary>
+    /// Gets the GameData associated with this log message.
+    /// </summary>
+    RowRef<Lumina.Excel.Sheets.LogMessage> GameData { get; }
+
+    /// <summary>
+    /// Gets the entity that is the source of this log message, if any.
+    /// </summary>
+    ILogMessageEntity? SourceEntity { get; }
+
+    /// <summary>
+    /// Gets the entity that is the target of this log message, if any.
+    /// </summary>
+    ILogMessageEntity? TargetEntity { get; }
+
+    /// <summary>
+    /// Gets the number of parameters.
+    /// </summary>
+    int ParameterCount { get; }
+
+    /// <summary>
+    /// Retrieves the value of a parameter for the log message if it is an int.
+    /// </summary>
+    /// <param name="index">The index of the parameter to retrieve.</param>
+    /// <param name="value">The value of the parameter.</param>
+    /// <returns><see langword="true"/> if the parameter was retrieved successfully.</returns>
+    bool TryGetIntParameter(int index, out int value);
+
+    /// <summary>
+    /// Retrieves the value of a parameter for the log message if it is a string.
+    /// </summary>
+    /// <param name="index">The index of the parameter to retrieve.</param>
+    /// <param name="value">The value of the parameter.</param>
+    /// <returns><see langword="true"/> if the parameter was retrieved successfully.</returns>
+    bool TryGetStringParameter(int index, out ReadOnlySeString value);
+
+    /// <summary>
+    /// Formats this log message into an approximation of the string that will eventually be shown in the log.
+    /// </summary>
+    /// <remarks>This can cause side effects such as playing sound effects and thus should only be used for debugging.</remarks>
+    /// <returns>The formatted string.</returns>
+    ReadOnlySeString FormatLogMessageForDebugging();
+}
+
+/// <summary>
+/// This struct represents log message in the queue to be added to the chat.
+/// </summary>
+/// <param name="ptr">A pointer to the log message.</param>
+internal unsafe readonly struct LogMessage(LogMessageQueueItem* ptr) : ILogMessage
+{
+    /// <inheritdoc/>
+    public nint Address => (nint)ptr;
+
+    /// <inheritdoc/>
+    public uint LogMessageId => ptr->LogMessageId;
+
+    /// <inheritdoc/>
+    public RowRef<Lumina.Excel.Sheets.LogMessage> GameData => LuminaUtils.CreateRef<Lumina.Excel.Sheets.LogMessage>(ptr->LogMessageId);
+
+    /// <inheritdoc/>
+    ILogMessageEntity? ILogMessage.SourceEntity => ptr->SourceKind == EntityRelationKind.None ? null : this.SourceEntity;
+
+    /// <inheritdoc/>
+    ILogMessageEntity? ILogMessage.TargetEntity => ptr->TargetKind == EntityRelationKind.None ? null : this.TargetEntity;
+
+    /// <inheritdoc/>
+    public int ParameterCount => ptr->Parameters.Count;
+
+    private LogMessageEntity SourceEntity => new(ptr, true);
+
+    private LogMessageEntity TargetEntity => new(ptr, false);
+
+    public static bool operator ==(LogMessage x, LogMessage y) => x.Equals(y);
+
+    public static bool operator !=(LogMessage x, LogMessage y) => !(x == y);
+
+    /// <inheritdoc/>
+    public bool Equals(ILogMessage? other)
+    {
+        return other is LogMessage logMessage && this.Equals(logMessage);
+    }
+
+    /// <inheritdoc/>
+    public override bool Equals([NotNullWhen(true)] object? obj)
+    {
+        return obj is LogMessage logMessage && this.Equals(logMessage);
+    }
+
+    /// <inheritdoc/>
+    public override int GetHashCode()
+    {
+        return HashCode.Combine(this.LogMessageId, this.SourceEntity, this.TargetEntity);
+    }
+    
+    /// <inheritdoc/>
+    public bool TryGetIntParameter(int index, out int value)
+    {
+        value = 0;
+        if (!this.TryGetParameter(index, out var parameter)) return false;
+        if (parameter.Type != TextParameterType.Integer) return false;
+        value = parameter.IntValue;
+        return true;
+    }
+
+    /// <inheritdoc/>
+    public bool TryGetStringParameter(int index, out ReadOnlySeString value)
+    {
+        value = default;
+        if (!this.TryGetParameter(index, out var parameter)) return false;
+        if (parameter.Type == TextParameterType.String)
+        {
+            value = new(parameter.StringValue.AsSpan());
+            return true;
+        }
+
+        if (parameter.Type == TextParameterType.ReferencedUtf8String)
+        {
+            value = new(parameter.ReferencedUtf8StringValue->Utf8String.AsSpan());
+            return true;
+        }
+
+        return false;
+    }
+
+    /// <inheritdoc/>
+    public ReadOnlySeString FormatLogMessageForDebugging()
+    {
+        var logModule = RaptureLogModule.Instance();
+
+        // the formatting logic is taken from RaptureLogModule_Update
+
+        using var utf8 = new Utf8String();
+        SetName(logModule, this.SourceEntity);
+        SetName(logModule, this.TargetEntity);
+
+        using var rssb = new RentedSeStringBuilder();
+        logModule->RaptureTextModule->FormatString(rssb.Builder.Append(this.GameData.Value.Text).GetViewAsSpan(), &ptr->Parameters, &utf8);
+
+        return new ReadOnlySeString(utf8.AsSpan());
+
+        static void SetName(RaptureLogModule* self, LogMessageEntity item)
+        {
+            var name = item.NameSpan.GetPointer(0);
+
+            if (item.IsPlayer)
+            {
+                var str = self->TempParseMessage.GetPointer(item.IsSourceEntity ? 8 : 9);
+                self->FormatPlayerLink(name, str, null, 0, item.Kind != 1 /* LocalPlayer */, item.HomeWorldId, false, null, false);
+
+                if (item.HomeWorldId != 0 && item.HomeWorldId != AgentLobby.Instance()->LobbyData.HomeWorldId)
+                {
+                    var crossWorldSymbol = self->RaptureTextModule->UnkStrings0.GetPointer(3);
+                    if (!crossWorldSymbol->StringPtr.HasValue)
+                        self->RaptureTextModule->ProcessMacroCode(crossWorldSymbol, "<icon(88)>\0"u8);
+                    str->Append(crossWorldSymbol);
+                    if (self->UIModule->GetWorldHelper()->AllWorlds.TryGetValuePointer(item.HomeWorldId, out var world))
+                        str->ConcatCStr(world->Name);
+                }
+
+                name = str->StringPtr;
+            }
+
+            if (item.IsSourceEntity)
+            {
+                self->RaptureTextModule->SetGlobalTempEntity1(name, item.Sex, item.ObjStrId);
+            }
+            else
+            {
+                self->RaptureTextModule->SetGlobalTempEntity2(name, item.Sex, item.ObjStrId);
+            }
+        }
+    }
+
+    private bool TryGetParameter(int index, out TextParameter value)
+    {
+        if (index < 0 || index >= ptr->Parameters.Count)
+        {
+            value = default;
+            return false;
+        }
+
+        value = ptr->Parameters[index];
+        return true;
+    }
+
+    private bool Equals(LogMessage other)
+    {
+        return this.LogMessageId == other.LogMessageId && this.SourceEntity == other.SourceEntity && this.TargetEntity == other.TargetEntity;
+    }
+}

Dalamud/Game/Chat/LogMessageEntity.cs

@@ -0,0 +1,113 @@
+using System.Diagnostics.CodeAnalysis;
+
+using Dalamud.Data;
+using Dalamud.Plugin.Services;
+
+using FFXIVClientStructs.FFXIV.Client.UI.Misc;
+
+using Lumina.Excel;
+using Lumina.Excel.Sheets;
+using Lumina.Text.ReadOnly;
+
+namespace Dalamud.Game.Chat;
+
+/// <summary>
+/// Interface representing an entity related to a log message.
+/// </summary>
+public interface ILogMessageEntity : IEquatable<ILogMessageEntity>
+{
+    /// <summary>
+    /// Gets the name of this entity.
+    /// </summary>
+    ReadOnlySeString Name { get; }
+
+    /// <summary>
+    /// Gets the ID of the homeworld of this entity, if it is a player.
+    /// </summary>
+    ushort HomeWorldId { get; }
+
+    /// <summary>
+    /// Gets the homeworld of this entity, if it is a player.
+    /// </summary>
+    RowRef<World> HomeWorld { get; }
+
+    /// <summary>
+    /// Gets the ObjStr ID of this entity, if not a player. See <seealso cref="ISeStringEvaluator.EvaluateObjStr"/>.
+    /// </summary>
+    uint ObjStrId { get; }
+
+    /// <summary>
+    /// Gets a value indicating whether this entity is a player.
+    /// </summary>
+    bool IsPlayer { get; }
+}
+
+/// <summary>
+/// This struct represents an entity related to a log message.
+/// </summary>
+/// <param name="ptr">A pointer to the log message item.</param>
+/// <param name="source">If <see langword="true"/> represents the source entity of the log message, otherwise represents the target entity.</param>
+internal unsafe readonly struct LogMessageEntity(LogMessageQueueItem* ptr, bool source) : ILogMessageEntity
+{
+    /// <inheritdoc/>
+    public ReadOnlySeString Name => new(this.NameSpan[..this.NameSpan.IndexOf((byte)0)]);
+
+    /// <inheritdoc/>
+    public ushort HomeWorldId => source ? ptr->SourceHomeWorld : ptr->TargetHomeWorld;
+
+    /// <inheritdoc/>
+    public RowRef<World> HomeWorld => LuminaUtils.CreateRef<World>(this.HomeWorldId);
+
+    /// <inheritdoc/>
+    public uint ObjStrId => source ? ptr->SourceObjStrId : ptr->TargetObjStrId;
+
+    /// <inheritdoc/>
+    public bool IsPlayer => source ? ptr->SourceIsPlayer : ptr->TargetIsPlayer;
+
+    /// <summary>
+    /// Gets the Span containing the raw name of this entity.
+    /// </summary>
+    internal Span<byte> NameSpan => source ? ptr->SourceName : ptr->TargetName;
+
+    /// <summary>
+    /// Gets the kind of the entity.
+    /// </summary>
+    internal byte Kind => source ? (byte)ptr->SourceKind : (byte)ptr->TargetKind;
+
+    /// <summary>
+    /// Gets the Sex of this entity.
+    /// </summary>
+    internal byte Sex => source ? ptr->SourceSex : ptr->TargetSex;
+
+    /// <summary>
+    /// Gets a value indicating whether this entity is the source entity of a log message.
+    /// </summary>
+    internal bool IsSourceEntity => source;
+
+    public static bool operator ==(LogMessageEntity x, LogMessageEntity y) => x.Equals(y);
+
+    public static bool operator !=(LogMessageEntity x, LogMessageEntity y) => !(x == y);
+
+    /// <inheritdoc/>
+    public bool Equals(ILogMessageEntity other)
+    {
+        return other is LogMessageEntity entity && this.Equals(entity);
+    }
+
+    /// <inheritdoc/>
+    public override bool Equals([NotNullWhen(true)] object? obj)
+    {
+        return obj is LogMessageEntity entity && this.Equals(entity);
+    }
+
+    /// <inheritdoc/>
+    public override int GetHashCode()
+    {
+        return HashCode.Combine(this.Name, this.HomeWorldId, this.ObjStrId, this.Sex, this.IsPlayer);
+    }
+
+    private bool Equals(LogMessageEntity other)
+    {
+        return this.Name == other.Name && this.HomeWorldId == other.HomeWorldId && this.ObjStrId == other.ObjStrId && this.Kind == other.Kind && this.Sex == other.Sex && this.IsPlayer == other.IsPlayer;
+    }
+}

Dalamud/Game/Gui/ChatGui.cs

@@ -1,6 +1,7 @@
 using System.Collections.Generic;
 using System.Collections.Immutable;
 using System.Linq;
+using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
 
 using Dalamud.Configuration.Internal;
@@ -41,10 +42,12 @@ internal sealed unsafe class ChatGui : IInternalDisposableService, IChatGui
 
     private readonly Queue<XivChatEntry> chatQueue = new();
     private readonly Dictionary<(string PluginName, uint CommandId), Action<uint, SeString>> dalamudLinkHandlers = [];
+    private readonly List<nint> seenLogMessageObjects = [];
 
     private readonly Hook<PrintMessageDelegate> printMessageHook;
     private readonly Hook<InventoryItem.Delegates.Copy> inventoryItemCopyHook;
     private readonly Hook<LogViewer.Delegates.HandleLinkClick> handleLinkClickHook;
+    private readonly Hook<RaptureLogModule.Delegates.Update> handleLogModuleUpdate;
 
     [ServiceManager.ServiceDependency]
     private readonly DalamudConfiguration configuration = Service<DalamudConfiguration>.Get();
@@ -58,10 +61,12 @@ internal sealed unsafe class ChatGui : IInternalDisposableService, IChatGui
         this.printMessageHook = Hook<PrintMessageDelegate>.FromAddress(RaptureLogModule.Addresses.PrintMessage.Value, this.HandlePrintMessageDetour);
         this.inventoryItemCopyHook = Hook<InventoryItem.Delegates.Copy>.FromAddress((nint)InventoryItem.StaticVirtualTablePointer->Copy, this.InventoryItemCopyDetour);
         this.handleLinkClickHook = Hook<LogViewer.Delegates.HandleLinkClick>.FromAddress(LogViewer.Addresses.HandleLinkClick.Value, this.HandleLinkClickDetour);
+        this.handleLogModuleUpdate = Hook<RaptureLogModule.Delegates.Update>.FromAddress(RaptureLogModule.Addresses.Update.Value, this.UpdateDetour);
 
         this.printMessageHook.Enable();
         this.inventoryItemCopyHook.Enable();
         this.handleLinkClickHook.Enable();
+        this.handleLogModuleUpdate.Enable();
     }
 
     [UnmanagedFunctionPointer(CallingConvention.ThisCall)]
@@ -79,6 +84,9 @@ internal sealed unsafe class ChatGui : IInternalDisposableService, IChatGui
     /// <inheritdoc/>
     public event IChatGui.OnMessageUnhandledDelegate? ChatMessageUnhandled;
 
+    /// <inheritdoc/>
+    public event IChatGui.OnLogMessageDelegate? LogMessage;
+
     /// <inheritdoc/>
     public uint LastLinkedItemId { get; private set; }
 
@@ -110,6 +118,7 @@ internal sealed unsafe class ChatGui : IInternalDisposableService, IChatGui
         this.printMessageHook.Dispose();
         this.inventoryItemCopyHook.Dispose();
         this.handleLinkClickHook.Dispose();
+        this.handleLogModuleUpdate.Dispose();
     }
 
     #region DalamudSeString
@@ -493,6 +502,46 @@ internal sealed unsafe class ChatGui : IInternalDisposableService, IChatGui
             Log.Error(ex, "Exception in HandleLinkClickDetour");
         }
     }
+
+    private void UpdateDetour(RaptureLogModule* thisPtr)
+    {
+        try
+        {
+            foreach (ref var item in thisPtr->LogMessageQueue)
+            {
+                var logMessage = new Chat.LogMessage((LogMessageQueueItem*)Unsafe.AsPointer(ref item));
+
+                // skip any entries that survived the previous Update call as the event was already called for them
+                if (this.seenLogMessageObjects.Contains(logMessage.Address))
+                    continue;
+
+                foreach (var action in Delegate.EnumerateInvocationList(this.LogMessage))
+                {
+                    try
+                    {
+                        action(logMessage);
+                    }
+                    catch (Exception e)
+                    {
+                        Log.Error(e, "Could not invoke registered OnLogMessageDelegate for {Name}", action.Method);
+                    }
+                }
+            }
+
+            this.handleLogModuleUpdate.Original(thisPtr);
+
+            // record the log messages for that we already called the event, but are still in the queue
+            this.seenLogMessageObjects.Clear();
+            foreach (ref var item in thisPtr->LogMessageQueue)
+            {
+                this.seenLogMessageObjects.Add((nint)Unsafe.AsPointer(ref item));
+            }
+        }
+        catch (Exception ex)
+        {
+            Log.Error(ex, "Exception in UpdateDetour");
+        }
+    }
 }
 
 /// <summary>
@@ -521,6 +570,7 @@ internal class ChatGuiPluginScoped : IInternalDisposableService, IChatGui
         this.chatGuiService.CheckMessageHandled += this.OnCheckMessageForward;
         this.chatGuiService.ChatMessageHandled += this.OnMessageHandledForward;
         this.chatGuiService.ChatMessageUnhandled += this.OnMessageUnhandledForward;
+        this.chatGuiService.LogMessage += this.OnLogMessageForward;
     }
 
     /// <inheritdoc/>
@@ -535,6 +585,9 @@ internal class ChatGuiPluginScoped : IInternalDisposableService, IChatGui
     /// <inheritdoc/>
     public event IChatGui.OnMessageUnhandledDelegate? ChatMessageUnhandled;
 
+    /// <inheritdoc/>
+    public event IChatGui.OnLogMessageDelegate? LogMessage;
+
     /// <inheritdoc/>
     public uint LastLinkedItemId => this.chatGuiService.LastLinkedItemId;
 
@@ -551,11 +604,13 @@ internal class ChatGuiPluginScoped : IInternalDisposableService, IChatGui
         this.chatGuiService.CheckMessageHandled -= this.OnCheckMessageForward;
         this.chatGuiService.ChatMessageHandled -= this.OnMessageHandledForward;
         this.chatGuiService.ChatMessageUnhandled -= this.OnMessageUnhandledForward;
+        this.chatGuiService.LogMessage -= this.OnLogMessageForward;
 
         this.ChatMessage = null;
         this.CheckMessageHandled = null;
         this.ChatMessageHandled = null;
         this.ChatMessageUnhandled = null;
+        this.LogMessage = null;
     }
 
     /// <inheritdoc/>
@@ -609,4 +664,7 @@ internal class ChatGuiPluginScoped : IInternalDisposableService, IChatGui
 
     private void OnMessageUnhandledForward(XivChatType type, int timestamp, SeString sender, SeString message)
         => this.ChatMessageUnhandled?.Invoke(type, timestamp, sender, message);
+
+    private void OnLogMessageForward(Chat.ILogMessage message)
+        => this.LogMessage?.Invoke(message);
 }