Dalamud/Dalamud/Plugin/Internal/Profiles/PluginManagementCommandHandler.cs

using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

using CheapLoc;
using Dalamud.Game;
using Dalamud.Game.Command;
using Dalamud.Game.Gui;
using Dalamud.Plugin.Services;
using Dalamud.Utility;
using Serilog;

namespace Dalamud.Plugin.Internal.Profiles;

/// <summary>
/// Service responsible for profile-related chat commands.
/// </summary>
[ServiceManager.EarlyLoadedService]
internal class PluginManagementCommandHandler : IInternalDisposableService
{
#pragma warning disable SA1600
    public const string CommandEnable = "/xlenablecollection";
    public const string CommandDisable = "/xldisablecollection";
    public const string CommandToggle = "/xltogglecollection";
#pragma warning restore SA1600
    
    private static readonly string LegacyCommandEnable = CommandEnable.Replace("collection", "profile");
    private static readonly string LegacyCommandDisable = CommandDisable.Replace("collection", "profile");
    private static readonly string LegacyCommandToggle = CommandToggle.Replace("collection", "profile");
    
    private readonly CommandManager cmd;
    private readonly ProfileManager profileManager;
    private readonly ChatGui chat;
    private readonly Framework framework;

    private List<(string, ProfileOp)> queue = new();

    /// <summary>
    /// Initializes a new instance of the <see cref="PluginManagementCommandHandler"/> class.
    /// </summary>
    /// <param name="cmd">Command handler.</param>
    /// <param name="profileManager">Profile manager.</param>
    /// <param name="chat">Chat handler.</param>
    /// <param name="framework">Framework.</param>
    [ServiceManager.ServiceConstructor]
    public PluginManagementCommandHandler(CommandManager cmd, ProfileManager profileManager, ChatGui chat, Framework framework)
    {
        this.cmd = cmd;
        this.profileManager = profileManager;
        this.chat = chat;
        this.framework = framework;

        this.cmd.AddHandler(CommandEnable, new CommandInfo(this.OnEnableProfile)
        {
            HelpMessage = Loc.Localize("ProfileCommandsEnableHint", "Enable a collection. Usage: /xlenablecollection \"Collection Name\""),
            ShowInHelp = true,
        });

        this.cmd.AddHandler(CommandDisable, new CommandInfo(this.OnDisableProfile)
        {
            HelpMessage = Loc.Localize("ProfileCommandsDisableHint", "Disable a collection. Usage: /xldisablecollection \"Collection Name\""),
            ShowInHelp = true,
        });

        this.cmd.AddHandler(CommandToggle, new CommandInfo(this.OnToggleProfile)
        {
            HelpMessage = Loc.Localize("ProfileCommandsToggleHint", "Toggle a collection. Usage: /xltogglecollection \"Collection Name\""),
            ShowInHelp = true,
        });
        
        this.cmd.AddHandler(LegacyCommandEnable, new CommandInfo(this.OnEnableProfile)
        {
            ShowInHelp = false,
        });

        this.cmd.AddHandler(LegacyCommandDisable, new CommandInfo(this.OnDisableProfile)
        {
            ShowInHelp = true,
        });

        this.cmd.AddHandler(LegacyCommandToggle, new CommandInfo(this.OnToggleProfile)
        {
            ShowInHelp = true,
        });

        this.framework.Update += this.FrameworkOnUpdate;
    }

    private enum ProfileOp
    {
        Enable,
        Disable,
        Toggle,
    }
    
    /// <inheritdoc/>
    void IInternalDisposableService.DisposeService()
    {
        this.cmd.RemoveHandler(CommandEnable);
        this.cmd.RemoveHandler(CommandDisable);
        this.cmd.RemoveHandler(CommandToggle);
        this.cmd.RemoveHandler(LegacyCommandEnable);
        this.cmd.RemoveHandler(LegacyCommandDisable);
        this.cmd.RemoveHandler(LegacyCommandToggle);

        this.framework.Update += this.FrameworkOnUpdate;
    }

    private void FrameworkOnUpdate(IFramework framework1)
    {
        if (this.profileManager.IsBusy)
            return;

        if (this.queue.Count > 0)
        {
            var op = this.queue[0];
            this.queue.RemoveAt(0);

            var profile = this.profileManager.Profiles.FirstOrDefault(x => x.Name == op.Item1);
            if (profile == null || profile.IsDefaultProfile)
                return;

            switch (op.Item2)
            {
                case ProfileOp.Enable:
                    if (!profile.IsEnabled)
                        Task.Run(() => profile.SetStateAsync(true, false)).GetAwaiter().GetResult();
                    break;
                case ProfileOp.Disable:
                    if (profile.IsEnabled)
                        Task.Run(() => profile.SetStateAsync(false, false)).GetAwaiter().GetResult();
                    break;
                case ProfileOp.Toggle:
                    Task.Run(() => profile.SetStateAsync(!profile.IsEnabled, false)).GetAwaiter().GetResult();
                    break;
                default:
                    throw new ArgumentOutOfRangeException();
            }

            if (profile.IsEnabled)
            {
                this.chat.Print(Loc.Localize("ProfileCommandsEnabling", "Enabling collection \"{0}\"...").Format(profile.Name));
            }
            else
            {
                this.chat.Print(Loc.Localize("ProfileCommandsDisabling", "Disabling collection \"{0}\"...").Format(profile.Name));
            }

            Task.Run(this.profileManager.ApplyAllWantStatesAsync).ContinueWith(t =>
            {
                if (!t.IsCompletedSuccessfully && t.Exception != null)
                {
                    Log.Error(t.Exception, "Could not apply profiles through commands");
                    this.chat.PrintError(Loc.Localize("ProfileCommandsApplyFailed", "Failed to apply your collections. Please check the console for errors."));
                }
                else
                {
                    this.chat.Print(Loc.Localize("ProfileCommandsApplySuccess", "Collections applied."));
                }
            });
        }
    }

    private void OnEnableProfile(string command, string arguments)
    {
        var name = this.ValidateName(arguments);
        if (name == null)
            return;

        this.queue = this.queue.Where(x => x.Item1 != name).ToList();
        this.queue.Add((name, ProfileOp.Enable));
    }

    private void OnDisableProfile(string command, string arguments)
    {
        var name = this.ValidateName(arguments);
        if (name == null)
            return;

        this.queue = this.queue.Where(x => x.Item1 != name).ToList();
        this.queue.Add((name, ProfileOp.Disable));
    }

    private void OnToggleProfile(string command, string arguments)
    {
        var name = this.ValidateName(arguments);
        if (name == null)
            return;

        this.queue.Add((name, ProfileOp.Toggle));
    }

    private string? ValidateName(string arguments)
    {
        var name = arguments.Replace("\"", string.Empty);
        if (this.profileManager.Profiles.All(x => x.Name != name))
        {
            this.chat.PrintError($"No collection like \"{name}\".");
            return null;
        }

        return name;
    }
}