[Api13] Update ChatLinkHandler functions (#2322)

* Update ChatLinkHandler functions

- Move functions to IChatGui
- Switch CommandId to type Guid and generate them automatically

* Remove unused field

Dalamud/Game/ChatHandlers.cs

@@ -119,8 +119,6 @@ internal partial class ChatHandlers : IServiceType
         if (string.IsNullOrEmpty(this.configuration.LastVersion) || !Util.AssemblyVersion.StartsWith(this.configuration.LastVersion))
         {
             var linkPayload = chatGui.AddChatLinkHandler(
-                "dalamud",
-                8459324,
                 (_, _) => dalamudInterface.OpenPluginInstallerTo(PluginInstallerOpenKind.Changelogs));
 
             var updateMessage = new SeStringBuilder()

Dalamud/Game/Gui/ChatGui.cs

@@ -12,6 +12,7 @@ using Dalamud.IoC;
 using Dalamud.IoC.Internal;
 using Dalamud.Logging.Internal;
 using Dalamud.Memory;
+using Dalamud.Plugin.Internal.Types;
 using Dalamud.Plugin.Services;
 using Dalamud.Utility;
 
@@ -40,7 +41,7 @@ internal sealed unsafe class ChatGui : IInternalDisposableService, IChatGui
     private static readonly ModuleLog Log = new("ChatGui");
 
     private readonly Queue<XivChatEntry> chatQueue = new();
-    private readonly Dictionary<(string PluginName, uint CommandId), Action<uint, SeString>> dalamudLinkHandlers = new();
+    private readonly Dictionary<(string PluginName, Guid CommandId), Action<Guid, SeString>> dalamudLinkHandlers = new();
 
     private readonly Hook<PrintMessageDelegate> printMessageHook;
     private readonly Hook<InventoryItem.Delegates.Copy> inventoryItemCopyHook;
@@ -49,7 +50,7 @@ internal sealed unsafe class ChatGui : IInternalDisposableService, IChatGui
     [ServiceManager.ServiceDependency]
     private readonly DalamudConfiguration configuration = Service<DalamudConfiguration>.Get();
 
-    private ImmutableDictionary<(string PluginName, uint CommandId), Action<uint, SeString>>? dalamudLinkHandlersCopy;
+    private ImmutableDictionary<(string PluginName, Guid CommandId), Action<Guid, SeString>>? dalamudLinkHandlersCopy;
 
     [ServiceManager.ServiceConstructor]
     private ChatGui()
@@ -85,7 +86,7 @@ internal sealed unsafe class ChatGui : IInternalDisposableService, IChatGui
     public byte LastLinkedItemFlags { get; private set; }
 
     /// <inheritdoc/>
-    public IReadOnlyDictionary<(string PluginName, uint CommandId), Action<uint, SeString>> RegisteredLinkHandlers
+    public IReadOnlyDictionary<(string PluginName, Guid CommandId), Action<Guid, SeString>> RegisteredLinkHandlers
     {
         get
         {
@@ -161,6 +162,28 @@ internal sealed unsafe class ChatGui : IInternalDisposableService, IChatGui
 
     #endregion
 
+    #region Chat Links
+
+    /// <inheritdoc/>
+    public DalamudLinkPayload AddChatLinkHandler(Action<Guid, SeString> commandAction)
+    {
+        return this.AddChatLinkHandler("Dalamud", commandAction);
+    }
+
+    /// <inheritdoc/>
+    public void RemoveChatLinkHandler(Guid commandId)
+    {
+        this.RemoveChatLinkHandler("Dalamud", commandId);
+    }
+
+    /// <inheritdoc/>
+    public void RemoveChatLinkHandler()
+    {
+        this.RemoveChatLinkHandler("Dalamud");
+    }
+
+    #endregion
+
     /// <summary>
     /// Process a chat queue.
     /// </summary>
@@ -217,12 +240,11 @@ internal sealed unsafe class ChatGui : IInternalDisposableService, IChatGui
     /// Create a link handler.
     /// </summary>
     /// <param name="pluginName">The name of the plugin handling the link.</param>
-    /// <param name="commandId">The ID of the command to run.</param>
     /// <param name="commandAction">The command action itself.</param>
     /// <returns>A payload for handling.</returns>
-    [Api13ToDo("Plugins should not specify their own command IDs here. We should assign them ourselves.")]
+    internal DalamudLinkPayload AddChatLinkHandler(string pluginName, Action<Guid, SeString> commandAction)
-    internal DalamudLinkPayload AddChatLinkHandler(string pluginName, uint commandId, Action<uint, SeString> commandAction)
     {
+        var commandId = Guid.CreateVersion7();
         var payload = new DalamudLinkPayload { Plugin = pluginName, CommandId = commandId };
         lock (this.dalamudLinkHandlers)
         {
@@ -255,7 +277,7 @@ internal sealed unsafe class ChatGui : IInternalDisposableService, IChatGui
     /// </summary>
     /// <param name="pluginName">The name of the plugin handling the link.</param>
     /// <param name="commandId">The ID of the command to be removed.</param>
-    internal void RemoveChatLinkHandler(string pluginName, uint commandId)
+    internal void RemoveChatLinkHandler(string pluginName, Guid commandId)
     {
         lock (this.dalamudLinkHandlers)
         {
@@ -478,11 +500,15 @@ internal class ChatGuiPluginScoped : IInternalDisposableService, IChatGui
     [ServiceManager.ServiceDependency]
     private readonly ChatGui chatGuiService = Service<ChatGui>.Get();
 
+    private readonly LocalPlugin plugin;
+
     /// <summary>
     /// Initializes a new instance of the <see cref="ChatGuiPluginScoped"/> class.
     /// </summary>
-    internal ChatGuiPluginScoped()
+    /// <param name="plugin">The plugin.</param>
+    internal ChatGuiPluginScoped(LocalPlugin plugin)
     {
+        this.plugin = plugin;
         this.chatGuiService.ChatMessage += this.OnMessageForward;
         this.chatGuiService.CheckMessageHandled += this.OnCheckMessageForward;
         this.chatGuiService.ChatMessageHandled += this.OnMessageHandledForward;
@@ -508,7 +534,7 @@ internal class ChatGuiPluginScoped : IInternalDisposableService, IChatGui
     public byte LastLinkedItemFlags => this.chatGuiService.LastLinkedItemFlags;
 
     /// <inheritdoc/>
-    public IReadOnlyDictionary<(string PluginName, uint CommandId), Action<uint, SeString>> RegisteredLinkHandlers => this.chatGuiService.RegisteredLinkHandlers;
+    public IReadOnlyDictionary<(string PluginName, Guid CommandId), Action<Guid, SeString>> RegisteredLinkHandlers => this.chatGuiService.RegisteredLinkHandlers;
 
     /// <inheritdoc/>
     void IInternalDisposableService.DisposeService()
@@ -524,6 +550,18 @@ internal class ChatGuiPluginScoped : IInternalDisposableService, IChatGui
         this.ChatMessageUnhandled = null;
     }
 
+    /// <inheritdoc/>
+    public DalamudLinkPayload AddChatLinkHandler(Action<Guid, SeString> commandAction)
+        => this.chatGuiService.AddChatLinkHandler(this.plugin.InternalName, commandAction);
+
+    /// <inheritdoc/>
+    public void RemoveChatLinkHandler(Guid commandId)
+        => this.chatGuiService.RemoveChatLinkHandler(this.plugin.InternalName, commandId);
+
+    /// <inheritdoc/>
+    public void RemoveChatLinkHandler()
+        => this.chatGuiService.RemoveChatLinkHandler(this.plugin.InternalName);
+
     /// <inheritdoc/>
     public void Print(XivChatEntry chat)
         => this.chatGuiService.Print(chat);

Dalamud/Game/Text/SeStringHandling/Payloads/DalamudLinkPayload.cs

@@ -16,7 +16,7 @@ public class DalamudLinkPayload : Payload
     public override PayloadType Type => PayloadType.DalamudLink;
 
     /// <summary>Gets the plugin command ID to be linked.</summary>
-    public uint CommandId { get; internal set; }
+    public Guid CommandId { get; internal set; }
 
     /// <summary>Gets an optional extra integer value 1.</summary>
     public int Extra1 { get; internal set; }
@@ -40,7 +40,7 @@ public class DalamudLinkPayload : Payload
         var ssb = Lumina.Text.SeStringBuilder.SharedPool.Get();
         var res = ssb.BeginMacro(MacroCode.Link)
                      .AppendIntExpression((int)EmbeddedInfoType.DalamudLink - 1)
-                     .AppendUIntExpression(this.CommandId)
+                     .AppendStringExpression(this.CommandId.ToString())
                      .AppendIntExpression(this.Extra1)
                      .AppendIntExpression(this.Extra2)
                      .BeginStringExpression()
@@ -72,15 +72,15 @@ public class DalamudLinkPayload : Payload
             if (!pluginExpression.TryGetString(out var pluginString))
                 return;
 
-            if (!commandIdExpression.TryGetUInt(out var commandId))
+            if (!commandIdExpression.TryGetString(out var commandId))
                 return;
 
             this.Plugin = pluginString.ExtractText();
-            this.CommandId = commandId;
+            this.CommandId = Guid.Parse(commandId.ExtractText());
         }
         else
         {
-            if (!commandIdExpression.TryGetUInt(out var commandId))
+            if (!commandIdExpression.TryGetString(out var commandId))
                 return;
 
             if (!extra1Expression.TryGetInt(out var extra1))
@@ -102,7 +102,7 @@ public class DalamudLinkPayload : Payload
                 return;
             }
 
-            this.CommandId = commandId;
+            this.CommandId = Guid.Parse(commandId.ExtractText());
             this.Extra1 = extra1;
             this.Extra2 = extra2;
             this.Plugin = extraData[0];

Dalamud/Plugin/DalamudPluginInterface.cs

@@ -13,8 +13,6 @@ using Dalamud.Data;
 using Dalamud.Game.Gui;
 using Dalamud.Game.Text;
 using Dalamud.Game.Text.Sanitizer;
-using Dalamud.Game.Text.SeStringHandling;
-using Dalamud.Game.Text.SeStringHandling.Payloads;
 using Dalamud.Interface;
 using Dalamud.Interface.Internal;
 using Dalamud.Interface.Internal.Windows.PluginInstaller;
@@ -427,39 +425,6 @@ internal sealed class DalamudPluginInterface : IDalamudPluginInterface, IDisposa
 
     #endregion
 
-    #region Chat Links
-
-    // TODO API9: Move to chatgui, don't allow passing own commandId
-
-    /// <summary>
-    /// Register a chat link handler.
-    /// </summary>
-    /// <param name="commandId">The ID of the command.</param>
-    /// <param name="commandAction">The action to be executed.</param>
-    /// <returns>Returns an SeString payload for the link.</returns>
-    public DalamudLinkPayload AddChatLinkHandler(uint commandId, Action<uint, SeString> commandAction)
-    {
-        return Service<ChatGui>.Get().AddChatLinkHandler(this.plugin.InternalName, commandId, commandAction);
-    }
-
-    /// <summary>
-    /// Remove a chat link handler.
-    /// </summary>
-    /// <param name="commandId">The ID of the command.</param>
-    public void RemoveChatLinkHandler(uint commandId)
-    {
-        Service<ChatGui>.Get().RemoveChatLinkHandler(this.plugin.InternalName, commandId);
-    }
-
-    /// <summary>
-    /// Removes all chat link handlers registered by the plugin.
-    /// </summary>
-    public void RemoveChatLinkHandler()
-    {
-        Service<ChatGui>.Get().RemoveChatLinkHandler(this.plugin.InternalName);
-    }
-    #endregion
-
     #region Dependency Injection
 
     /// <inheritdoc/>

Dalamud/Plugin/IDalamudPluginInterface.cs

@@ -1,4 +1,4 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Threading.Tasks;
@@ -281,25 +281,6 @@ public interface IDalamudPluginInterface
     /// <returns>directory with path of AppData/XIVLauncher/pluginConfig/PluginInternalName/loc.</returns>
     string GetPluginLocDirectory();
 
-    /// <summary>
-    /// Register a chat link handler.
-    /// </summary>
-    /// <param name="commandId">The ID of the command.</param>
-    /// <param name="commandAction">The action to be executed.</param>
-    /// <returns>Returns an SeString payload for the link.</returns>
-    DalamudLinkPayload AddChatLinkHandler(uint commandId, Action<uint, SeString> commandAction);
-
-    /// <summary>
-    /// Remove a chat link handler.
-    /// </summary>
-    /// <param name="commandId">The ID of the command.</param>
-    void RemoveChatLinkHandler(uint commandId);
-
-    /// <summary>
-    /// Removes all chat link handlers registered by the plugin.
-    /// </summary>
-    void RemoveChatLinkHandler();
-
     /// <summary>
     /// Create a new object of the provided type using its default constructor, then inject objects and properties.
     /// </summary>

Dalamud/Plugin/Internal/AutoUpdate/AutoUpdateManager.cs

@@ -102,8 +102,6 @@ internal class AutoUpdateManager : IServiceType
         this.openInstallerWindowLinkTask =
             Service<ChatGui>.GetAsync().ContinueWith(
                 chatGuiTask => chatGuiTask.Result.AddChatLinkHandler(
-                    "Dalamud",
-                    1001,
                     (_, _) =>
                      {
                          Service<DalamudInterface>.GetNullable()?.OpenPluginInstallerTo(PluginInstallerOpenKind.InstalledPlugins);

Dalamud/Plugin/Internal/PluginManager.cs

@@ -125,8 +125,6 @@ internal class PluginManager : IInternalDisposableService
         this.openInstallerWindowPluginChangelogsLink =
             Service<ChatGui>.GetAsync().ContinueWith(
                 chatGuiTask => chatGuiTask.Result.AddChatLinkHandler(
-                    "Dalamud",
-                    1003,
                     (_, _) =>
                     {
                         Service<DalamudInterface>.GetNullable()?.OpenPluginInstallerTo(

Dalamud/Plugin/Services/IChatGui.cs

@@ -3,6 +3,7 @@ using System.Collections.Generic;
 using Dalamud.Game.Gui;
 using Dalamud.Game.Text;
 using Dalamud.Game.Text.SeStringHandling;
+using Dalamud.Game.Text.SeStringHandling.Payloads;
 
 namespace Dalamud.Plugin.Services;
 
@@ -82,7 +83,25 @@ public interface IChatGui
     /// <summary>
     /// Gets the dictionary of Dalamud Link Handlers.
     /// </summary>
-    public IReadOnlyDictionary<(string PluginName, uint CommandId), Action<uint, SeString>> RegisteredLinkHandlers { get; }
+    public IReadOnlyDictionary<(string PluginName, Guid CommandId), Action<Guid, SeString>> RegisteredLinkHandlers { get; }
+
+    /// <summary>
+    /// Register a chat link handler.
+    /// </summary>
+    /// <param name="commandAction">The action to be executed.</param>
+    /// <returns>Returns an SeString payload for the link.</returns>
+    public DalamudLinkPayload AddChatLinkHandler(Action<Guid, SeString> commandAction);
+
+    /// <summary>
+    /// Remove a chat link handler.
+    /// </summary>
+    /// <param name="commandId">The ID of the command.</param>
+    public void RemoveChatLinkHandler(Guid commandId);
+
+    /// <summary>
+    /// Removes all chat link handlers registered by the plugin.
+    /// </summary>
+    public void RemoveChatLinkHandler();
 
     /// <summary>
     /// Queue a chat message. Dalamud will send queued messages on the next framework event.