HellionChat/ChatTwo/Plugin.cs

using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.IO;
using ChatTwo.Ipc;
using ChatTwo.Resources;
using ChatTwo.Ui;
using ChatTwo.Util;
using Dalamud.Game.ClientState.Conditions;
using Dalamud.Interface.Windowing;
using Dalamud.IoC;
using Dalamud.Plugin;
using Dalamud.Plugin.Services;
using Dalamud.Bindings.ImGui;
using Dalamud.Interface.ImGuiFileDialog;

namespace ChatTwo;

// ReSharper disable once ClassNeverInstantiated.Global
public sealed class Plugin : IDalamudPlugin
{
    public const string PluginName = "Hellion Chat";

    [PluginService] public static IPluginLog Log { get; private set; } = null!;
    [PluginService] public static IDalamudPluginInterface Interface { get; private set; } = null!;
    [PluginService] public static IChatGui ChatGui { get; private set; } = null!;
    [PluginService] public static IClientState ClientState { get; private set; } = null!;
    [PluginService] public static ICommandManager CommandManager { get; private set; } = null!;
    [PluginService] public static ICondition Condition { get; private set; } = null!;
    [PluginService] public static IDataManager DataManager { get; private set; } = null!;
    [PluginService] public static IFramework Framework { get; private set; } = null!;
    [PluginService] public static IGameGui GameGui { get; private set; } = null!;
    [PluginService] public static IKeyState KeyState { get; private set; } = null!;
    [PluginService] public static IObjectTable ObjectTable { get; private set; } = null!;
    [PluginService] public static IPartyList PartyList { get; private set; } = null!;
    [PluginService] public static ITargetManager TargetManager { get; private set; } = null!;
    [PluginService] public static ITextureProvider TextureProvider { get; private set; } = null!;
    [PluginService] public static IGameInteropProvider GameInteropProvider { get; private set; } = null!;
    [PluginService] public static IGameConfig GameConfig { get; private set; } = null!;
    [PluginService] public static INotificationManager Notification { get; private set; } = null!;
    [PluginService] public static IAddonLifecycle AddonLifecycle { get; private set; } = null!;
    [PluginService] public static IPlayerState PlayerState { get; private set; } = null!;
    [PluginService] public static ISeStringEvaluator Evaluator { get; private set; } = null!;

    public static Configuration Config = null!;
    public static FileDialogManager FileDialogManager { get; private set; } = null!;

    public readonly WindowSystem WindowSystem = new(PluginName);
    public SettingsWindow SettingsWindow { get; }
    public ChatLogWindow ChatLogWindow { get; }
    public DbViewer DbViewer { get; }
    public InputPreview InputPreview { get; }
    public CommandHelpWindow CommandHelpWindow { get; }
    public SeStringDebugger SeStringDebugger { get; }
    public FirstRunWizard FirstRunWizard { get; }
    public DebuggerWindow DebuggerWindow { get; }

    internal Commands Commands { get; }
    internal GameFunctions.GameFunctions Functions { get; }
    internal MessageManager MessageManager { get; }
    internal AutoTellTabsService AutoTellTabsService { get; }
    internal IpcManager Ipc { get; }
    internal ExtraChat ExtraChat { get; }
    internal TypingIpc TypingIpc { get; }
    internal FontManager FontManager { get; }

    internal int DeferredSaveFrames = -1;

    // Serialises retention sweeps. The 24h auto-sweep on plugin load and
    // the manual button in the Privacy tab both run on background threads;
    // without this gate, hitting the manual button moments after a fresh
    // plugin start would launch two sweeps in parallel and the second one
    // would just re-do work the first one already finished. The lock guards
    // the flag — the flag check itself bails before we touch the database.
    // Volatile because the ImGui thread reads the flag outside the lock to
    // gate the manual button; without it the JIT may cache the value in a
    // register and miss the background-thread update.
    internal readonly object RetentionSweepLock = new();
    internal volatile bool RetentionSweepRunning;

    internal DateTime GameStarted { get; }

    // Tab management needs to happen outside the chatlog window class for access reasons
    internal int LastTab { get; set; }
    internal int? WantedTab { get; set; }
    internal Tab CurrentTab
    {
        get
        {
            var i = LastTab;
            return i > -1 && i < Config.Tabs.Count ? Config.Tabs[i] : new Tab();
        }
    }

    public Plugin()
    {
        try
        {
            GameStarted = Process.GetCurrentProcess().StartTime.ToUniversalTime();

            // Hellion Chat: take over config + database from upstream ChatTwo
            // before Dalamud loads our plugin config. Idempotent: only acts on
            // the first start where the legacy paths exist and ours don't.
            MigrateFromChatTwoLayout();

            Config = Interface.GetPluginConfig() as Configuration ?? new Configuration();

            // Hellion Chat — Auto-Tell-Tabs Defense-in-Depth. SaveConfig
            // already strips temp tabs before persistence, but a previous
            // crash or external write could have left them in the JSON.
            // Drop them on load to guarantee the session-only invariant.
            Config.Tabs.RemoveAll(t => t.IsTempTab);

            // Hellion Chat v9 → v10 — wipes the configuration so the new 8-tab
            // layout starts from defaults instead of mapping every previous setting
            // to its new position. Backup-Failure ist non-fatal, der Wipe läuft
            // trotzdem; dem User fehlt dann nur das manuelle Restore-Sicherheitsnetz.
            if (Config.Version < 10)
            {
                var pluginConfigsDir = Interface.ConfigDirectory.Parent?.FullName;
                if (pluginConfigsDir is not null)
                {
                    var liveConfigPath = Path.Combine(pluginConfigsDir, $"{Interface.InternalName}.json");
                    var backupPath = Path.Combine(pluginConfigsDir, $"{Interface.InternalName}.json.pre-v10-backup");

                    try
                    {
                        if (File.Exists(liveConfigPath))
                        {
                            File.Copy(liveConfigPath, backupPath, overwrite: true);
                        }
                    }
                    catch (Exception ex)
                    {
                        Log.Warning(ex, "HellionChat: pre-v10 config backup failed");
                    }
                }

                Config = new Configuration
                {
                    Version = 10,
                    FirstRunCompleted = true,
                };
                SaveConfig();

                Notification.AddNotification(new Dalamud.Interface.ImGuiNotification.Notification
                {
                    Title = HellionStrings.SettingsRefactor_Migration_Title,
                    Content = HellionStrings.SettingsRefactor_Migration_Content,
                    Type = Dalamud.Interface.ImGuiNotification.NotificationType.Info,
                    InitialDuration = TimeSpan.FromSeconds(25),
                });
            }

            // Hellion Chat v10 → v11 — adds the global Configuration.PopOutInputEnabled
            // master switch and SeenPopOutInputHint flag for the v0.6.0 pop-out
            // input feature. Lightweight migration: defaults both fields,
            // no user-facing notification because the change is opt-in only.
            if (Config.Version < 11)
            {
                Config.PopOutInputEnabled = false;
                Config.SeenPopOutInputHint = false;
                Config.Version = 11;
                SaveConfig();
                Log.Information(
                    "Migrated config v10 → v11: PopOutInputEnabled added (global, default off), " +
                    "SeenPopOutInputHint added (default false)");
            }

            // Hellion Chat v11 → v12 — flips Configuration.PopOutInputEnabled from
            // the v0.6.0 opt-in default (false) to opt-out (true) per v0.6.1 UX
            // polish. Tester feedback: users found the manual toggle "umständlich,
            // wirkt unfertig". Hard-flip applies to all existing users — small active
            // tester pool means few have made a deliberate opt-out choice yet.
            // Communicated via the v0.6.1 hint banner (SeenPopOutHeaderHint reset).
            if (Config.Version < 12)
            {
                Config.PopOutInputEnabled = true;
                Config.SeenPopOutHeaderHint = false;
                Config.Version = 12;
                SaveConfig();
                Log.Information(
                    "Migrated config v11 → v12: PopOutInputEnabled hard-flipped to true (v0.6.1 default), " +
                    "SeenPopOutHeaderHint added (default false)");
            }

            // Hellion default tab layout for first-run and v10-wipe.
            // General catches player chat plus active gameplay events; the
            // System tab takes the technical noise so it does not bury real
            // conversation. Beginner tab only appears when the Novice
            // Network is enabled in Audio and Notifications, otherwise it
            // would just sit empty.
            if (Config.Tabs.Count == 0)
            {
                Config.Tabs.Add(TabsUtil.VanillaGeneral);
                Config.Tabs.Add(TabsUtil.HellionSystem);
                Config.Tabs.Add(TabsUtil.HellionFreeCompany);
                Config.Tabs.Add(TabsUtil.HellionParty);
                if (Config.ShowNoviceNetwork)
                    Config.Tabs.Add(TabsUtil.HellionBeginner);
                Config.Tabs.Add(TabsUtil.HellionLinkshell);
                Config.Tabs.Add(TabsUtil.VanillaTellExclusive);
            }

            LanguageChanged(Interface.UiLanguage);
            ImGuiUtil.Initialize(this);

            FileDialogManager = new FileDialogManager();

            Commands = new Commands();
            Functions = new GameFunctions.GameFunctions(this);
            Ipc = new IpcManager();
            TypingIpc = new TypingIpc(this);
            ExtraChat = new ExtraChat();
            FontManager = new FontManager();

            MessageManager = new MessageManager(this); // Does it require UI?

            // Hellion Chat — Auto-Tell-Tabs service. Subscribes to the
            // MessageManager's MessageProcessed event for live tells and
            // to ClientState.Logout for the cleanup pass. Created after
            // MessageManager so the constructor can hand off the live
            // store and event source.
            AutoTellTabsService = new AutoTellTabsService(this, MessageManager, MessageManager.Store);
            AutoTellTabsService.Initialize();

            // Hellion Chat — daily retention sweep, off-thread so it never
            // blocks plugin load. Skips itself when disabled or already ran
            // within the past 24 hours.
            RunRetentionSweepIfDue();

            ChatLogWindow = new ChatLogWindow(this);
            SettingsWindow = new SettingsWindow(this);
            DbViewer = new DbViewer(this);
            InputPreview = new InputPreview(ChatLogWindow);
            CommandHelpWindow = new CommandHelpWindow(ChatLogWindow);
            SeStringDebugger = new SeStringDebugger(this);
            DebuggerWindow = new DebuggerWindow(this);
            FirstRunWizard = new FirstRunWizard(this);

            WindowSystem.AddWindow(ChatLogWindow);
            WindowSystem.AddWindow(SettingsWindow);
            WindowSystem.AddWindow(DbViewer);
            WindowSystem.AddWindow(InputPreview);
            WindowSystem.AddWindow(CommandHelpWindow);
            WindowSystem.AddWindow(SeStringDebugger);
            WindowSystem.AddWindow(DebuggerWindow);
            WindowSystem.AddWindow(FirstRunWizard);

            // Open the wizard on a fresh install. Existing ChatTwo users have
            // FirstRunCompleted set to true by the v6→v7 migration above.
            if (!Config.FirstRunCompleted)
                FirstRunWizard.IsOpen = true;

            FontManager.BuildFonts();

            Interface.UiBuilder.DisableCutsceneUiHide = true;
            Interface.UiBuilder.DisableGposeUiHide = true;

            // let all the other components register, then initialize commands
            Commands.Initialise();

            if (Interface.Reason is not PluginLoadReason.Boot)
                MessageManager.FilterAllTabsAsync();

            Framework.Update += FrameworkUpdate;
            Interface.UiBuilder.Draw += Draw;
            Interface.LanguageChanged += LanguageChanged;
            // Hellion Chat — surface a "main UI" entry point so Dalamud's
            // plugin list shows the Open-Plugin button. Settings is the
            // most useful landing place; OpenConfigUi is already wired to
            // the same toggle inside SettingsWindow.
            Interface.UiBuilder.OpenMainUi += OpenMainUi;

            if (Config.ShowEmotes)
                _ = EmoteCache.LoadData(); // Fire-and-forget intentional, exceptions are caught inside

            #if !DEBUG
            // Avoid 300ms hitch when sending first message by preloading the
            // auto-translate cache. Don't do this in debug because it makes
            // profiling difficult.
            AutoTranslate.PreloadCache();
            #endif
        }
        catch (Exception ex)
        {
            Log.Error(ex, "Plugin load threw an error, turning off plugin");
            Dispose();

            // Re-throw the exception to fail the plugin load.
            throw;
        }
    }

    // Suppressing this warning because Dispose() is called in Plugin() if the
    // load fails, so some values may not be initialized.
    [SuppressMessage("ReSharper", "ConditionalAccessQualifierIsNonNullableAccordingToAPIContract")]
    public void Dispose()
    {
        Interface.UiBuilder.OpenMainUi -= OpenMainUi;
        Interface.LanguageChanged -= LanguageChanged;
        Interface.UiBuilder.Draw -= Draw;
        Framework.Update -= FrameworkUpdate;
        GameFunctions.GameFunctions.SetChatInteractable(true);

        WindowSystem?.RemoveAllWindows();
        ChatLogWindow?.Dispose();
        DbViewer?.Dispose();
        InputPreview?.Dispose();
        SettingsWindow?.Dispose();
        DebuggerWindow?.Dispose();
        SeStringDebugger?.Dispose();

        TypingIpc?.Dispose();
        ExtraChat?.Dispose();
        Ipc?.Dispose();
        // Dispose the Auto-Tell-Tabs service before MessageManager so it
        // can cleanly unsubscribe from the MessageProcessed event before
        // its source goes away.
        AutoTellTabsService?.Dispose();
        MessageManager?.DisposeAsync().AsTask().Wait();
        Functions?.Dispose();
        Commands?.Dispose();

        EmoteCache.Dispose();
    }

    private static void MigrateFromChatTwoLayout()
    {
        var pluginConfigsDir = Interface.ConfigDirectory.Parent?.FullName;
        if (pluginConfigsDir is null)
            return;

        var legacyConfigFile = Path.Combine(pluginConfigsDir, "ChatTwo.json");
        var legacyConfigDir = Path.Combine(pluginConfigsDir, "ChatTwo");
        var ourConfigFile = Path.Combine(pluginConfigsDir, "HellionChat.json");
        var ourConfigDir = Interface.ConfigDirectory.FullName;

        // Track whether anything legitimately blocked us. The most common
        // cause is upstream Chat 2 still being loaded — its SQLite handle
        // keeps chat-sqlite.db locked and File.Move throws IOException.
        var lockedBlocker = false;

        try
        {
            if (!File.Exists(ourConfigFile) && File.Exists(legacyConfigFile))
            {
                File.Move(legacyConfigFile, ourConfigFile);
                Log.Information($"HellionChat: migrated config file {legacyConfigFile} → {ourConfigFile}");
            }
        }
        catch (IOException e)
        {
            Log.Warning(e, $"HellionChat: config file move blocked, leaving {legacyConfigFile} in place");
            lockedBlocker = true;
        }

        // The plugin's ConfigDirectory may already exist on first load
        // (Dalamud creates it), so check at the file level instead of
        // skipping when the directory is present. Move every legacy
        // entry whose target name is not occupied yet, then remove the
        // source dir if it ends up empty. Each move is wrapped on its
        // own so a single locked file (the SQLite db while ChatTwo still
        // runs) does not abandon the rest of the migration.
        if (!Directory.Exists(legacyConfigDir))
            return;

        try
        {
            Directory.CreateDirectory(ourConfigDir);

            foreach (var file in Directory.EnumerateFiles(legacyConfigDir))
            {
                var target = Path.Combine(ourConfigDir, Path.GetFileName(file));
                if (File.Exists(target))
                    continue;
                try
                {
                    File.Move(file, target);
                    Log.Information($"HellionChat: migrated file {file} → {target}");
                }
                catch (IOException e)
                {
                    Log.Warning(e, $"HellionChat: file move blocked for {file}, will retry on next load");
                    lockedBlocker = true;
                }
            }

            foreach (var dir in Directory.EnumerateDirectories(legacyConfigDir))
            {
                var target = Path.Combine(ourConfigDir, Path.GetFileName(dir));
                if (Directory.Exists(target))
                    continue;
                try
                {
                    Directory.Move(dir, target);
                    Log.Information($"HellionChat: migrated subdir {dir} → {target}");
                }
                catch (IOException e)
                {
                    Log.Warning(e, $"HellionChat: subdir move blocked for {dir}, will retry on next load");
                    lockedBlocker = true;
                }
            }

            if (!Directory.EnumerateFileSystemEntries(legacyConfigDir).Any())
            {
                Directory.Delete(legacyConfigDir);
                Log.Information($"HellionChat: removed empty legacy dir {legacyConfigDir}");
            }
        }
        catch (Exception e)
        {
            Log.Error(e, "HellionChat: layout migration failed, continuing with whatever exists");
        }

        if (lockedBlocker)
        {
            // Surface the most common cause to the user as a notification
            // so they don't think Hellion Chat lost their history when in
            // fact upstream Chat 2 was still holding the database file.
            Notification.AddNotification(new Dalamud.Interface.ImGuiNotification.Notification
            {
                Title = "Hellion Chat",
                Content = "Could not migrate the Chat 2 database — the file appears to be in use. " +
                          "Disable Chat 2, fully close the game, then start it again. " +
                          "See the README troubleshooting section if the issue persists.",
                Type = Dalamud.Interface.ImGuiNotification.NotificationType.Warning,
                InitialDuration = TimeSpan.FromSeconds(30),
            });
        }
    }

    private void OpenMainUi()
    {
        // Settings is the most useful landing surface — same target as the
        // Configure button. SettingsWindow.Toggle is internal and already
        // wired to OpenConfigUi, so re-using IsOpen keeps both entry points
        // behaviourally identical.
        SettingsWindow.IsOpen = !SettingsWindow.IsOpen;
    }

    private void RunRetentionSweepIfDue()
    {
        if (!Config.RetentionEnabled)
            return;
        if (DateTimeOffset.UtcNow - Config.RetentionLastRunAt < TimeSpan.FromHours(24))
            return;

        // Snapshot the policy so the user can edit settings while we run.
        // Spec defaults form the baseline; explicit user overrides win.
        var policy = new Dictionary<int, int>();
        foreach (var (type, days) in Privacy.PrivacyDefaults.DefaultRetentionDays)
            policy[(int)(ushort)type] = days;
        foreach (var (type, days) in Config.RetentionPerChannelDays)
            policy[(int)(ushort)type] = days;
        var defaultDays = Config.RetentionDefaultDays;

        new Thread(() =>
        {
            // Bail out cheaply if a manual sweep is already in flight; the
            // lock around the actual work would queue us up otherwise and
            // we would just re-do whatever the manual run already did.
            lock (RetentionSweepLock)
            {
                if (RetentionSweepRunning)
                    return;
                RetentionSweepRunning = true;
            }

            try
            {
                var deleted = MessageManager.Store.DeleteByRetentionPolicy(policy, defaultDays);
                Config.RetentionLastRunAt = DateTimeOffset.UtcNow;
                SaveConfig();

                if (deleted > 0)
                {
                    Log.Information($"Retention sweep deleted {deleted} expired messages.");
                    Framework.Run(() =>
                    {
                        MessageManager.ClearAllTabs();
                        MessageManager.FilterAllTabsAsync();
                    }).Wait();
                }
                else
                {
                    Log.Information("Retention sweep ran, nothing expired.");
                }
            }
            catch (Exception e)
            {
                Log.Error(e, "Retention sweep failed");
            }
            finally
            {
                lock (RetentionSweepLock)
                    RetentionSweepRunning = false;
            }
        }) { IsBackground = true }.Start();
    }

    private void Draw()
    {
        // Hellion theme is pushed once per frame here so every plugin window
        // (chat log, settings, viewers, wizard, file dialog) renders with
        // the same palette. Skipping the push leaves the upstream Dalamud
        // look untouched for users who flipped the toggle off.
        using IDisposable? _style = Config.HellionThemeEnabled
            ? HellionStyle.PushGlobal(Config.HellionThemeWindowOpacity)
            : null;

        ChatLogWindow.BeginFrame();

        if (Config.HideInLoadingScreens && Condition[ConditionFlag.BetweenAreas])
        {
            ChatLogWindow.FinalizeFrame();
            TypingIpc.Update();
            return;
        }

        ChatLogWindow.HideStateCheck();

        Interface.UiBuilder.DisableUserUiHide = !Config.HideWhenUiHidden;
        ChatLogWindow.DefaultText = ImGui.GetStyle().Colors[(int) ImGuiCol.Text];

        using ((Config.FontsEnabled ? FontManager.RegularFont : FontManager.Axis).Push())
            WindowSystem.Draw();

        ChatLogWindow.FinalizeFrame();
        TypingIpc.Update();

        FileDialogManager.Draw();
    }

    internal void SaveConfig()
    {
        // Hellion Chat — Auto-Tell-Tabs are session-only. Strip them out
        // before serialization so a crash mid-session can never persist
        // them. We snapshot the full tab list first and restore it after
        // the save, preserving the user's order and open conversations.
        var snapshot = Config.Tabs.ToList();
        Config.Tabs.RemoveAll(t => t.IsTempTab);

        Interface.SavePluginConfig(Config);

        Config.Tabs.Clear();
        Config.Tabs.AddRange(snapshot);
    }

    internal void LanguageChanged(string langCode)
    {
        var info = Config.LanguageOverride is LanguageOverride.None
            ? new CultureInfo(langCode)
            : new CultureInfo(Config.LanguageOverride.Code());

        Language.Culture = info;
        HellionStrings.Culture = info;
    }

    private static readonly string[] ChatAddonNames =
    [
        "ChatLog",
        "ChatLogPanel_0",
        "ChatLogPanel_1",
        "ChatLogPanel_2",
        "ChatLogPanel_3"
    ];

    private void FrameworkUpdate(IFramework framework)
    {
        if (DeferredSaveFrames >= 0 && DeferredSaveFrames-- == 0)
            SaveConfig();

        if (!Config.HideChat)
            return;

        foreach (var name in ChatAddonNames)
            if (GameFunctions.GameFunctions.IsAddonInteractable(name))
                GameFunctions.GameFunctions.SetAddonInteractable(name, false);
    }

    public static bool InBattle => Condition[ConditionFlag.InCombat];
    public static bool GposeActive => Condition[ConditionFlag.WatchingCutscene];
    public static bool CutsceneActive => Condition[ConditionFlag.OccupiedInCutSceneEvent] || Condition[ConditionFlag.WatchingCutscene78];
}