Dalamud/Dalamud/Plugin/Internal/PluginManager.cs

using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Diagnostics;
using System.IO;
using System.IO.Compression;
using System.Linq;
using System.Reflection;
using System.Threading;
using System.Threading.Tasks;

using CheapLoc;
using Dalamud.Configuration;
using Dalamud.Configuration.Internal;
using Dalamud.Game;
using Dalamud.Game.Gui;
using Dalamud.Game.Gui.Dtr;
using Dalamud.Game.Text;
using Dalamud.Game.Text.SeStringHandling;
using Dalamud.Game.Text.SeStringHandling.Payloads;
using Dalamud.Interface.Internal;
using Dalamud.Logging.Internal;
using Dalamud.Plugin.Internal.Exceptions;
using Dalamud.Plugin.Internal.Types;
using Dalamud.Utility;
using Dalamud.Utility.Timing;
using Newtonsoft.Json;

namespace Dalamud.Plugin.Internal;

/// <summary>
/// Class responsible for loading and unloading plugins.
/// </summary>
[ServiceManager.EarlyLoadedService]
internal partial class PluginManager : IDisposable, IServiceType
{
    /// <summary>
    /// The current Dalamud API level, used to handle breaking changes. Only plugins with this level will be loaded.
    /// </summary>
    public const int DalamudApiLevel = 6;

    /// <summary>
    /// Default time to wait between plugin unload and plugin assembly unload.
    /// </summary>
    public const int PluginWaitBeforeFreeDefault = 500;

    private static readonly ModuleLog Log = new("PLUGINM");

    private readonly object pluginListLock = new();
    private readonly DirectoryInfo pluginDirectory;
    private readonly DirectoryInfo devPluginDirectory;
    private readonly BannedPlugin[]? bannedPlugins;

    private readonly DalamudLinkPayload openInstallerWindowPluginChangelogsLink;

    [ServiceManager.ServiceDependency]
    private readonly DalamudConfiguration configuration = Service<DalamudConfiguration>.Get();

    [ServiceManager.ServiceDependency]
    private readonly DalamudStartInfo startInfo = Service<DalamudStartInfo>.Get();

    [ServiceManager.ServiceConstructor]
    private PluginManager()
    {
        this.pluginDirectory = new DirectoryInfo(this.startInfo.PluginDirectory!);
        this.devPluginDirectory = new DirectoryInfo(this.startInfo.DefaultPluginDirectory!);

        if (!this.pluginDirectory.Exists)
            this.pluginDirectory.Create();

        if (!this.devPluginDirectory.Exists)
            this.devPluginDirectory.Create();

        this.SafeMode = EnvironmentConfiguration.DalamudNoPlugins || this.configuration.PluginSafeMode || this.startInfo.NoLoadPlugins;

        try
        {
            var appdata = Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData);
            var safeModeFile = Path.Combine(appdata, "XIVLauncher", ".dalamud_safemode");

            if (File.Exists(safeModeFile))
            {
                this.SafeMode = true;
                File.Delete(safeModeFile);
            }
        }
        catch (Exception ex)
        {
            Log.Error(ex, "Couldn't check safe mode file");
        }

        if (this.SafeMode)
        {
            this.configuration.PluginSafeMode = false;
            this.configuration.Save();
        }

        this.PluginConfigs = new PluginConfigurations(Path.Combine(Path.GetDirectoryName(this.startInfo.ConfigurationPath) ?? string.Empty, "pluginConfigs"));

        var bannedPluginsJson = File.ReadAllText(Path.Combine(this.startInfo.AssetDirectory!, "UIRes", "bannedplugin.json"));
        this.bannedPlugins = JsonConvert.DeserializeObject<BannedPlugin[]>(bannedPluginsJson);
        if (this.bannedPlugins == null)
        {
            throw new InvalidDataException("Couldn't deserialize banned plugins manifest.");
        }

        this.openInstallerWindowPluginChangelogsLink = Service<ChatGui>.Get().AddChatLinkHandler("Dalamud", 1003, (i, m) =>
        {
            Service<DalamudInterface>.GetNullable()?.OpenPluginInstallerPluginChangelogs();
        });

        this.ApplyPatches();
    }

    /// <summary>
    /// An event that fires when the installed plugins have changed.
    /// </summary>
    public event Action? OnInstalledPluginsChanged;

    /// <summary>
    /// An event that fires when the available plugins have changed.
    /// </summary>
    public event Action? OnAvailablePluginsChanged;

    /// <summary>
    /// Gets a list of all loaded plugins.
    /// </summary>
    public ImmutableList<LocalPlugin> InstalledPlugins { get; private set; } = ImmutableList.Create<LocalPlugin>();

    /// <summary>
    /// Gets a list of all available plugins.
    /// </summary>
    public ImmutableList<RemotePluginManifest> AvailablePlugins { get; private set; } = ImmutableList.Create<RemotePluginManifest>();

    /// <summary>
    /// Gets a list of all plugins with an available update.
    /// </summary>
    public ImmutableList<AvailablePluginUpdate> UpdatablePlugins { get; private set; } = ImmutableList.Create<AvailablePluginUpdate>();

    /// <summary>
    /// Gets a list of all plugin repositories. The main repo should always be first.
    /// </summary>
    public List<PluginRepository> Repos { get; private set; } = new();

    /// <summary>
    /// Gets a value indicating whether plugins are not still loading from boot.
    /// </summary>
    public bool PluginsReady { get; private set; }

    /// <summary>
    /// Gets a value indicating whether all added repos are not in progress.
    /// </summary>
    public bool ReposReady => this.Repos.All(repo => repo.State != PluginRepositoryState.InProgress || repo.State != PluginRepositoryState.Fail);

    /// <summary>
    /// Gets a value indicating whether the plugin manager started in safe mode.
    /// </summary>
    public bool SafeMode { get; init; }

    /// <summary>
    /// Gets the <see cref="PluginConfigurations"/> object used when initializing plugins.
    /// </summary>
    public PluginConfigurations PluginConfigs { get; }

    /// <summary>
    /// Gets or sets a value indicating whether plugins of all API levels will be loaded.
    /// </summary>
    public bool LoadAllApiLevels { get; set; }

    /// <summary>
    /// Gets or sets a value indicating whether banned plugins will be loaded.
    /// </summary>
    public bool LoadBannedPlugins { get; set; }

    /// <summary>
    /// Print to chat any plugin updates and whether they were successful.
    /// </summary>
    /// <param name="updateMetadata">The list of updated plugin metadata.</param>
    /// <param name="header">The header text to send to chat prior to any update info.</param>
    public void PrintUpdatedPlugins(List<PluginUpdateStatus>? updateMetadata, string header)
    {
        var chatGui = Service<ChatGui>.Get();

        if (updateMetadata is { Count: > 0 })
        {
            chatGui.PrintChat(new XivChatEntry
            {
                Message = new SeString(new List<Payload>()
                {
                    new TextPayload(header),
                    new TextPayload("  ["),
                    new UIForegroundPayload(500),
                    this.openInstallerWindowPluginChangelogsLink,
                    new TextPayload(Loc.Localize("DalamudInstallerPluginChangelogHelp", "Open plugin changelogs") + " "),
                    RawPayload.LinkTerminator,
                    new UIForegroundPayload(0),
                    new TextPayload("]"),
                }),
            });

            foreach (var metadata in updateMetadata)
            {
                if (metadata.WasUpdated)
                {
                    chatGui.Print(Locs.DalamudPluginUpdateSuccessful(metadata.Name, metadata.Version) + (metadata.HasChangelog ? " " : string.Empty));
                }
                else
                {
                    chatGui.PrintChat(new XivChatEntry
                    {
                        Message = Locs.DalamudPluginUpdateFailed(metadata.Name, metadata.Version) + (metadata.HasChangelog ? " " : string.Empty),
                        Type = XivChatType.Urgent,
                    });
                }
            }
        }
    }

    /// <summary>
    /// For a given manifest, determine if the testing version should be used over the normal version.
    /// The higher of the two versions is calculated after checking other settings.
    /// </summary>
    /// <param name="manifest">Manifest to check.</param>
    /// <returns>A value indicating whether testing should be used.</returns>
    public static bool UseTesting(PluginManifest manifest)
    {
        var configuration = Service<DalamudConfiguration>.Get();

        if (!configuration.DoPluginTest)
            return false;

        if (manifest.IsTestingExclusive)
            return true;

        var av = manifest.AssemblyVersion;
        var tv = manifest.TestingAssemblyVersion;
        var hasTv = tv != null;

        if (hasTv)
        {
            return tv > av;
        }

        return false;
    }

    /// <summary>
    /// Gets a value indicating whether the given repo manifest should be visible to the user.
    /// </summary>
    /// <param name="manifest">Repo manifest.</param>
    /// <returns>If the manifest is visible.</returns>
    public static bool IsManifestVisible(RemotePluginManifest manifest)
    {
        var configuration = Service<DalamudConfiguration>.Get();

        // Hidden by user
        if (configuration.HiddenPluginInternalName.Contains(manifest.InternalName))
            return false;

        // Hidden by manifest
        return !manifest.IsHide;
    }

    /// <inheritdoc/>
    public void Dispose()
    {
        var disposablePlugins =
            this.InstalledPlugins.Where(plugin => plugin.State is PluginState.Loaded or PluginState.LoadError).ToArray();
        if (disposablePlugins.Any())
        {
            // Unload them first, just in case some of plugin codes are still running via callbacks initiated externally.
            foreach (var plugin in disposablePlugins.Where(plugin => !plugin.Manifest.CanUnloadAsync))
            {
                try
                {
                    plugin.UnloadAsync(true, false).Wait();
                }
                catch (Exception ex)
                {
                    Log.Error(ex, $"Error unloading {plugin.Name}");
                }
            }

            Task.WaitAll(disposablePlugins
                             .Where(plugin => plugin.Manifest.CanUnloadAsync)
                             .Select(plugin => Task.Run(async () =>
                             {
                                 try
                                 {
                                     await plugin.UnloadAsync(true, false);
                                 }
                                 catch (Exception ex)
                                 {
                                     Log.Error(ex, $"Error unloading {plugin.Name}");
                                 }
                             })).ToArray());

            // Just in case plugins still have tasks running that they didn't cancel when they should have,
            // give them some time to complete it.
            Thread.Sleep(this.configuration.PluginWaitBeforeFree ?? PluginWaitBeforeFreeDefault);

            // Now that we've waited enough, dispose the whole plugin.
            // Since plugins should have been unloaded above, this should be done quickly.
            foreach (var plugin in disposablePlugins)
                plugin.ExplicitDisposeIgnoreExceptions($"Error disposing {plugin.Name}", Log);
        }

        this.assemblyLocationMonoHook?.Dispose();
        this.assemblyCodeBaseMonoHook?.Dispose();
    }

    /// <summary>
    /// Set the list of repositories to use and downloads their contents.
    /// Should be called when the Settings window has been updated or at instantiation.
    /// </summary>
    /// <param name="notify">Whether the available plugins changed event should be sent after.</param>
    /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
    public async Task SetPluginReposFromConfigAsync(bool notify)
    {
        var repos = new List<PluginRepository>() { PluginRepository.MainRepo };
        repos.AddRange(this.configuration.ThirdRepoList
                           .Where(repo => repo.IsEnabled)
                           .Select(repo => new PluginRepository(repo.Url, repo.IsEnabled)));

        this.Repos = repos;
        await this.ReloadPluginMastersAsync(notify);
    }

    /// <summary>
    /// Load all plugins, sorted by priority. Any plugins with no explicit definition file or a negative priority
    /// are loaded asynchronously.
    /// </summary>
    /// <remarks>
    /// This should only be called during Dalamud startup.
    /// </remarks>
    public void LoadAllPlugins()
    {
        var pluginDefs = new List<PluginDef>();
        var devPluginDefs = new List<PluginDef>();

        if (!this.pluginDirectory.Exists)
            this.pluginDirectory.Create();

        if (!this.devPluginDirectory.Exists)
            this.devPluginDirectory.Create();

        // Add installed plugins. These are expected to be in a specific format so we can look for exactly that.
        foreach (var pluginDir in this.pluginDirectory.GetDirectories())
        {
            var versionsDefs = new List<PluginDef>();
            foreach (var versionDir in pluginDir.GetDirectories())
            {
                var dllFile = new FileInfo(Path.Combine(versionDir.FullName, $"{pluginDir.Name}.dll"));
                var manifestFile = LocalPluginManifest.GetManifestFile(dllFile);

                if (!manifestFile.Exists)
                    continue;

                var manifest = LocalPluginManifest.Load(manifestFile);

                versionsDefs.Add(new PluginDef(dllFile, manifest, false));
            }

            try
            {
                pluginDefs.Add(versionsDefs.OrderByDescending(x => x.Manifest!.EffectiveVersion).First());
            }
            catch (Exception ex)
            {
                Log.Error(ex, "Couldn't choose best version for plugin: {Name}", pluginDir.Name);
            }
        }

        // devPlugins are more freeform. Look for any dll and hope to get lucky.
        var devDllFiles = this.devPluginDirectory.GetFiles("*.dll", SearchOption.AllDirectories).ToList();

        foreach (var setting in this.configuration.DevPluginLoadLocations)
        {
            if (!setting.IsEnabled)
                continue;

            if (Directory.Exists(setting.Path))
            {
                devDllFiles.AddRange(new DirectoryInfo(setting.Path).GetFiles("*.dll", SearchOption.AllDirectories));
            }
            else if (File.Exists(setting.Path))
            {
                devDllFiles.Add(new FileInfo(setting.Path));
            }
        }

        foreach (var dllFile in devDllFiles)
        {
            // Manifests are not required for devPlugins. the Plugin type will handle any null manifests.
            var manifestFile = LocalPluginManifest.GetManifestFile(dllFile);
            var manifest = manifestFile.Exists ? LocalPluginManifest.Load(manifestFile) : null;
            devPluginDefs.Add(new PluginDef(dllFile, manifest, true));
        }

        // Sort for load order - unloaded definitions have default priority of 0
        pluginDefs.Sort(PluginDef.Sorter);
        devPluginDefs.Sort(PluginDef.Sorter);

        // Dev plugins should load first.
        pluginDefs.InsertRange(0, devPluginDefs);

        async Task LoadPluginOnBoot(string logPrefix, PluginDef pluginDef)
        {
            using (Timings.Start($"{pluginDef.DllFile.Name}: {logPrefix}Boot"))
            {
                try
                {
                    await this.LoadPluginAsync(
                        pluginDef.DllFile,
                        pluginDef.Manifest,
                        PluginLoadReason.Boot,
                        pluginDef.IsDev,
                        isBoot: true);
                }
                catch (InvalidPluginException)
                {
                    // Not a plugin
                }
                catch (Exception ex)
                {
                    Log.Error(ex, "{0}: During boot plugin load, an unexpected error occurred", logPrefix);
                }
            }
        }

        void LoadPluginsSync(string logPrefix, IEnumerable<PluginDef> pluginDefsList)
        {
            foreach (var pluginDef in pluginDefsList)
                LoadPluginOnBoot(logPrefix, pluginDef).Wait();
        }

        Task LoadPluginsAsync(string logPrefix, IEnumerable<PluginDef> pluginDefsList)
        {
            return Task.WhenAll(
                pluginDefsList
                    .Select(pluginDef => Task.Run(Timings.AttachTimingHandle(
                                                      () => LoadPluginOnBoot(logPrefix, pluginDef))))
                    .ToArray());
        }

        var syncPlugins = pluginDefs.Where(def => def.Manifest?.LoadSync == true).ToList();
        var asyncPlugins = pluginDefs.Where(def => def.Manifest?.LoadSync != true).ToList();
        var loadTasks = new List<Task>();

        // Load plugins that can be loaded anytime
        LoadPluginsSync(
            "AnytimeSync",
            syncPlugins.Where(def => def.Manifest?.LoadRequiredState == 2));
        loadTasks.Add(
            LoadPluginsAsync(
                "AnytimeAsync",
                asyncPlugins.Where(def => def.Manifest?.LoadRequiredState == 2)));

        // Load plugins that want to be loaded during Framework.Tick
        loadTasks.Add(
            Service<Framework>
                .GetAsync()
                .ContinueWith(
                    x => x.Result.RunOnTick(
                        () => LoadPluginsSync(
                            "FrameworkTickSync",
                            syncPlugins.Where(def => def.Manifest?.LoadRequiredState == 1))),
                    TaskContinuationOptions.RunContinuationsAsynchronously)
                .Unwrap()
                .ContinueWith(
                    _ => LoadPluginsAsync(
                        "FrameworkTickAsync",
                        asyncPlugins.Where(def => def.Manifest?.LoadRequiredState == 1)),
                    TaskContinuationOptions.RunContinuationsAsynchronously)
                .Unwrap());

        // Load plugins that want to be loaded during Framework.Tick, when drawing facilities are available
        loadTasks.Add(
            Service<InterfaceManager.InterfaceManagerWithScene>
                .GetAsync()
                .ContinueWith(
                    _ => Service<Framework>.Get().RunOnTick(
                        () => LoadPluginsSync(
                            "DrawAvailableSync",
                            syncPlugins.Where(def => def.Manifest?.LoadRequiredState is 0 or null))))
                .Unwrap()
                .ContinueWith(
                    _ => LoadPluginsAsync(
                        "DrawAvailableAsync",
                        asyncPlugins.Where(def => def.Manifest?.LoadRequiredState is 0 or null)))
                .Unwrap());

        // Save signatures when all plugins are done loading, successful or not.
        _ = Task
            .WhenAll(loadTasks)
            .ContinueWith(
                _ => Service<SigScanner>.GetAsync(),
                TaskContinuationOptions.RunContinuationsAsynchronously)
            .Unwrap()
            .ContinueWith(
                sigScannerTask =>
                {
                    this.PluginsReady = true;
                    this.NotifyInstalledPluginsChanged();

                    sigScannerTask.Result.Save();
                },
                TaskContinuationOptions.RunContinuationsAsynchronously)
            .ConfigureAwait(false);
    }

    /// <summary>
    /// Reload all loaded plugins.
    /// </summary>
    /// <returns>A task.</returns>
    public Task ReloadAllPluginsAsync()
    {
        lock (this.pluginListLock)
        {
            return Task.WhenAll(this.InstalledPlugins
                                    .Where(x => x.IsLoaded)
                                    .ToList()
                                    .Select(x => Task.Run(async () => await x.ReloadAsync()))
                                    .ToList());
        }
    }

    /// <summary>
    /// Reload the PluginMaster for each repo, filter, and event that the list has updated.
    /// </summary>
    /// <param name="notify">Whether to notify that available plugins have changed afterwards.</param>
    /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
    public async Task ReloadPluginMastersAsync(bool notify = true)
    {
        Log.Information("Now reloading all PluginMasters...");
        await Task.WhenAll(this.Repos.Select(repo => repo.ReloadPluginMasterAsync()));
        Log.Information("PluginMasters reloaded, now refiltering...");

        this.RefilterPluginMasters(notify);
    }

    /// <summary>
    /// Apply visibility and eligibility filters to the available plugins, then event that the list has updated.
    /// </summary>
    /// <param name="notify">Whether to notify that available plugins have changed afterwards.</param>
    public void RefilterPluginMasters(bool notify = true)
    {
        this.AvailablePlugins = this.Repos
                                    .SelectMany(repo => repo.PluginMaster)
                                    .Where(this.IsManifestEligible)
                                    .Where(IsManifestVisible)
                                    .ToImmutableList();

        if (notify)
        {
            this.NotifyAvailablePluginsChanged();
        }
    }

    /// <summary>
    /// Scan the devPlugins folder for new DLL files that are not already loaded into the manager. They are not loaded,
    /// only shown as disabled in the installed plugins window. This is a modified version of LoadAllPlugins that works
    /// a little differently.
    /// </summary>
    public void ScanDevPlugins()
    {
        if (!this.devPluginDirectory.Exists)
            this.devPluginDirectory.Create();

        // devPlugins are more freeform. Look for any dll and hope to get lucky.
        var devDllFiles = this.devPluginDirectory.GetFiles("*.dll", SearchOption.AllDirectories).ToList();

        foreach (var setting in this.configuration.DevPluginLoadLocations)
        {
            if (!setting.IsEnabled)
                continue;

            if (Directory.Exists(setting.Path))
            {
                devDllFiles.AddRange(new DirectoryInfo(setting.Path).GetFiles("*.dll", SearchOption.AllDirectories));
            }
            else if (File.Exists(setting.Path))
            {
                devDllFiles.Add(new FileInfo(setting.Path));
            }
        }

        var listChanged = false;

        foreach (var dllFile in devDllFiles)
        {
            // This file is already known to us
            lock (this.pluginListLock)
            {
                if (this.InstalledPlugins.Any(lp => lp.DllFile.FullName == dllFile.FullName))
                    continue;
            }

            // Manifests are not required for devPlugins. the Plugin type will handle any null manifests.
            var manifestFile = LocalPluginManifest.GetManifestFile(dllFile);
            var manifest = manifestFile.Exists ? LocalPluginManifest.Load(manifestFile) : null;

            try
            {
                // Add them to the list and let the user decide, nothing is auto-loaded.
                this.LoadPluginAsync(dllFile, manifest, PluginLoadReason.Installer, isDev: true, doNotLoad: true)
                    .Wait();
                listChanged = true;
            }
            catch (InvalidPluginException)
            {
                // Not a plugin
            }
            catch (Exception ex)
            {
                Log.Error(ex, $"During devPlugin scan, an unexpected error occurred");
            }
        }

        if (listChanged)
            this.NotifyInstalledPluginsChanged();
    }

    /// <summary>
    /// Install a plugin from a repository and load it.
    /// </summary>
    /// <param name="repoManifest">The plugin definition.</param>
    /// <param name="useTesting">If the testing version should be used.</param>
    /// <param name="reason">The reason this plugin was loaded.</param>
    /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
    public async Task<LocalPlugin> InstallPluginAsync(RemotePluginManifest repoManifest, bool useTesting, PluginLoadReason reason)
    {
        Log.Debug($"Installing plugin {repoManifest.Name} (testing={useTesting})");

        var downloadUrl = useTesting ? repoManifest.DownloadLinkTesting : repoManifest.DownloadLinkInstall;
        var version = useTesting ? repoManifest.TestingAssemblyVersion : repoManifest.AssemblyVersion;

        var response = await Util.HttpClient.GetAsync(downloadUrl);
        response.EnsureSuccessStatusCode();

        var outputDir = new DirectoryInfo(Path.Combine(this.pluginDirectory.FullName, repoManifest.InternalName, version?.ToString() ?? string.Empty));

        try
        {
            if (outputDir.Exists)
                outputDir.Delete(true);

            outputDir.Create();
        }
        catch
        {
            // ignored, since the plugin may be loaded already
        }

        Log.Debug($"Extracting to {outputDir}");
        // This throws an error, even with overwrite=false
        // ZipFile.ExtractToDirectory(tempZip.FullName, outputDir.FullName, false);
        using (var archive = new ZipArchive(await response.Content.ReadAsStreamAsync()))
        {
            foreach (var zipFile in archive.Entries)
            {
                var outputFile = new FileInfo(Path.GetFullPath(Path.Combine(outputDir.FullName, zipFile.FullName)));

                if (!outputFile.FullName.StartsWith(outputDir.FullName, StringComparison.OrdinalIgnoreCase))
                {
                    throw new IOException("Trying to extract file outside of destination directory. See this link for more info: https://snyk.io/research/zip-slip-vulnerability");
                }

                if (outputFile.Directory == null)
                {
                    throw new IOException("Output directory invalid.");
                }

                if (zipFile.Name.IsNullOrEmpty())
                {
                    // Assuming Empty for Directory
                    Log.Verbose($"ZipFile name is null or empty, treating as a directory: {outputFile.Directory.FullName}");
                    Directory.CreateDirectory(outputFile.Directory.FullName);
                    continue;
                }

                // Ensure directory is created
                Directory.CreateDirectory(outputFile.Directory.FullName);

                try
                {
                    zipFile.ExtractToFile(outputFile.FullName, true);
                }
                catch (Exception ex)
                {
                    if (outputFile.Extension.EndsWith("dll"))
                    {
                        throw new IOException($"Could not overwrite {zipFile.Name}: {ex.Message}");
                    }

                    Log.Error($"Could not overwrite {zipFile.Name}: {ex.Message}");
                }
            }
        }

        var dllFile = LocalPluginManifest.GetPluginFile(outputDir, repoManifest);
        var manifestFile = LocalPluginManifest.GetManifestFile(dllFile);

        // We need to save the repoManifest due to how the repo fills in some fields that authors are not expected to use.
        File.WriteAllText(manifestFile.FullName, JsonConvert.SerializeObject(repoManifest, Formatting.Indented));

        // Reload as a local manifest, add some attributes, and save again.
        var manifest = LocalPluginManifest.Load(manifestFile);

        if (useTesting)
        {
            manifest.Testing = true;
        }

        // Document the url the plugin was installed from
        manifest.InstalledFromUrl = repoManifest.SourceRepo.PluginMasterUrl;

        manifest.Save(manifestFile);

        Log.Information($"Installed plugin {manifest.Name} (testing={useTesting})");

        var plugin = await this.LoadPluginAsync(dllFile, manifest, reason);

        this.NotifyInstalledPluginsChanged();
        return plugin;
    }

    /// <summary>
    /// Load a plugin.
    /// </summary>
    /// <param name="dllFile">The <see cref="FileInfo"/> associated with the main assembly of this plugin.</param>
    /// <param name="manifest">The already loaded definition, if available.</param>
    /// <param name="reason">The reason this plugin was loaded.</param>
    /// <param name="isDev">If this plugin should support development features.</param>
    /// <param name="isBoot">If this plugin is being loaded at boot.</param>
    /// <param name="doNotLoad">Don't load the plugin, just don't do it.</param>
    /// <returns>The loaded plugin.</returns>
    public async Task<LocalPlugin> LoadPluginAsync(FileInfo dllFile, LocalPluginManifest? manifest, PluginLoadReason reason, bool isDev = false, bool isBoot = false, bool doNotLoad = false)
    {
        var name = manifest?.Name ?? dllFile.Name;
        var loadPlugin = !doNotLoad;

        LocalPlugin plugin;

        if (isDev)
        {
            Log.Information($"Loading dev plugin {name}");
            var devPlugin = new LocalDevPlugin(dllFile, manifest);
            loadPlugin &= !isBoot || devPlugin.StartOnBoot;

            // If we're not loading it, make sure it's disabled
            if (!loadPlugin && !devPlugin.IsDisabled)
                devPlugin.Disable();

            plugin = devPlugin;
        }
        else
        {
            Log.Information($"Loading plugin {name}");
            plugin = new LocalPlugin(dllFile, manifest);
        }

        if (loadPlugin)
        {
            try
            {
                if (!plugin.IsDisabled)
                {
                    await plugin.LoadAsync(reason);
                }
                else
                {
                    Log.Verbose($"{name} was disabled");
                }
            }
            catch (InvalidPluginException)
            {
                PluginLocations.Remove(plugin.AssemblyName?.FullName ?? string.Empty, out _);
                throw;
            }
            catch (BannedPluginException)
            {
                // Out of date plugins get added so they can be updated.
                Log.Information($"Plugin was banned, adding anyways: {dllFile.Name}");
            }
            catch (Exception ex)
            {
                if (plugin.IsDev)
                {
                    // Dev plugins always get added to the list so they can be fiddled with in the UI
                    Log.Information(ex, $"Dev plugin failed to load, adding anyways: {dllFile.Name}");

                    // NOTE(goat): This can't work - plugins don't "unload" if they fail to load.
                    // plugin.Disable(); // Disable here, otherwise you can't enable+load later
                }
                else if (plugin.IsOutdated)
                {
                    // Out of date plugins get added, so they can be updated.
                    Log.Information(ex, $"Plugin was outdated, adding anyways: {dllFile.Name}");
                }
                else if (plugin.IsOrphaned)
                {
                    // Orphaned plugins get added, so that users aren't confused.
                    Log.Information(ex, $"Plugin was orphaned, adding anyways: {dllFile.Name}");
                }
                else if (isBoot)
                {
                    // During boot load, plugins always get added to the list so they can be fiddled with in the UI
                    Log.Information(ex, $"Regular plugin failed to load, adding anyways: {dllFile.Name}");

                    // NOTE(goat): This can't work - plugins don't "unload" if they fail to load.
                    // plugin.Disable(); // Disable here, otherwise you can't enable+load later
                }
                else if (!plugin.CheckPolicy())
                {
                    // During boot load, plugins always get added to the list so they can be fiddled with in the UI
                    Log.Information(ex, $"Plugin not loaded due to policy, adding anyways: {dllFile.Name}");

                    // NOTE(goat): This can't work - plugins don't "unload" if they fail to load.
                    // plugin.Disable(); // Disable here, otherwise you can't enable+load later
                }
                else
                {
                    PluginLocations.Remove(plugin.AssemblyName?.FullName ?? string.Empty, out _);
                    throw;
                }
            }
        }

        lock (this.pluginListLock)
        {
            this.InstalledPlugins = this.InstalledPlugins.Add(plugin);
        }

        return plugin;
    }

    /// <summary>
    /// Remove a plugin.
    /// </summary>
    /// <param name="plugin">Plugin to remove.</param>
    public void RemovePlugin(LocalPlugin plugin)
    {
        if (plugin.State != PluginState.Unloaded && plugin.HasEverStartedLoad)
            throw new InvalidPluginOperationException($"Unable to remove {plugin.Name}, not unloaded and had loaded before");

        lock (this.pluginListLock)
        {
            this.InstalledPlugins = this.InstalledPlugins.Remove(plugin);
        }

        PluginLocations.Remove(plugin.AssemblyName?.FullName ?? string.Empty, out _);

        this.NotifyInstalledPluginsChanged();
        this.NotifyAvailablePluginsChanged();
    }

    /// <summary>
    /// Cleanup disabled plugins. Does not target devPlugins.
    /// </summary>
    public void CleanupPlugins()
    {
        foreach (var pluginDir in this.pluginDirectory.GetDirectories())
        {
            try
            {
                var versionDirs = pluginDir.GetDirectories();

                versionDirs = versionDirs
                              .OrderByDescending(dir =>
                              {
                                  var isVersion = Version.TryParse(dir.Name, out var version);

                                  if (!isVersion)
                                  {
                                      Log.Debug($"Not a version, cleaning up {dir.FullName}");
                                      dir.Delete(true);
                                  }

                                  return version;
                              })
                              .ToArray();

                if (versionDirs.Length == 0)
                {
                    Log.Information($"No versions: cleaning up {pluginDir.FullName}");
                    pluginDir.Delete(true);
                }
                else
                {
                    for (var i = 0; i < versionDirs.Length; i++)
                    {
                        var versionDir = versionDirs[i];
                        try
                        {
                            if (i != 0)
                            {
                                Log.Information($"Old version: cleaning up {versionDir.FullName}");
                                versionDir.Delete(true);
                                continue;
                            }
                            var dllFile = new FileInfo(Path.Combine(versionDir.FullName, $"{pluginDir.Name}.dll"));
                            if (!dllFile.Exists)
                            {
                                Log.Information($"Missing dll: cleaning up {versionDir.FullName}");
                                versionDir.Delete(true);
                                continue;
                            }

                            var manifestFile = LocalPluginManifest.GetManifestFile(dllFile);
                            if (!manifestFile.Exists)
                            {
                                Log.Information($"Missing manifest: cleaning up {versionDir.FullName}");
                                versionDir.Delete(true);
                                continue;
                            }

                            if (manifestFile.Length == 0)
                            {
                                Log.Information($"Manifest empty: cleaning up {versionDir.FullName}");
                                versionDir.Delete(true);
                                continue;
                            }

                            var manifest = LocalPluginManifest.Load(manifestFile);
                            if (manifest.ScheduledForDeletion)
                            {
                                Log.Information($"Scheduled deletion: cleaning up {versionDir.FullName}");
                                versionDir.Delete(true);
                            }
                        }
                        catch (Exception ex)
                        {
                            Log.Error(ex, $"Could not clean up {versionDir.FullName}");
                        }
                    }
                }
            }
            catch (Exception ex)
            {
                Log.Error(ex, $"Could not clean up {pluginDir.FullName}");
            }
        }
    }

    /// <summary>
    /// Update all non-dev plugins.
    /// </summary>
    /// <param name="dryRun">Perform a dry run, don't install anything.</param>
    /// <returns>Success or failure and a list of updated plugin metadata.</returns>
    public async Task<List<PluginUpdateStatus>> UpdatePluginsAsync(bool ignoreDisabled, bool dryRun)
    {
        Log.Information("Starting plugin update");

        var updatedList = new List<PluginUpdateStatus>();

        // Prevent collection was modified errors
        foreach (var plugin in this.UpdatablePlugins)
        {
            // Can't update that!
            if (plugin.InstalledPlugin.IsDev)
                continue;

            if (plugin.InstalledPlugin.Manifest.Disabled && ignoreDisabled)
                continue;

            if (plugin.InstalledPlugin.Manifest.ScheduledForDeletion)
                continue;

            var result = await this.UpdateSinglePluginAsync(plugin, false, dryRun);
            if (result != null)
                updatedList.Add(result);
        }

        this.NotifyInstalledPluginsChanged();

        Log.Information("Plugin update OK.");

        return updatedList;
    }

    /// <summary>
    /// Update a single plugin, provided a valid <see cref="AvailablePluginUpdate"/>.
    /// </summary>
    /// <param name="metadata">The available plugin update.</param>
    /// <param name="notify">Whether to notify that installed plugins have changed afterwards.</param>
    /// <param name="dryRun">Whether or not to actually perform the update, or just indicate success.</param>
    /// <returns>The status of the update.</returns>
    public async Task<PluginUpdateStatus?> UpdateSinglePluginAsync(AvailablePluginUpdate metadata, bool notify, bool dryRun)
    {
        var plugin = metadata.InstalledPlugin;

        var updateStatus = new PluginUpdateStatus
        {
            InternalName = plugin.Manifest.InternalName,
            Name = plugin.Manifest.Name,
            Version = (metadata.UseTesting
                           ? metadata.UpdateManifest.TestingAssemblyVersion
                           : metadata.UpdateManifest.AssemblyVersion)!,
            WasUpdated = true,
            HasChangelog = !metadata.UpdateManifest.Changelog.IsNullOrWhitespace(),
        };

        if (!dryRun)
        {
            // Unload if loaded
            if (plugin.State is PluginState.Loaded or PluginState.LoadError or PluginState.DependencyResolutionFailed)
            {
                try
                {
                    await plugin.UnloadAsync();
                }
                catch (Exception ex)
                {
                    Log.Error(ex, "Error during unload (update)");
                    updateStatus.WasUpdated = false;
                    return updateStatus;
                }
            }

            if (plugin.IsDev)
            {
                try
                {
                    plugin.DllFile.Delete();
                    lock (this.pluginListLock)
                    {
                        this.InstalledPlugins = this.InstalledPlugins.Remove(plugin);
                    }
                }
                catch (Exception ex)
                {
                    Log.Error(ex, "Error during delete (update)");
                    updateStatus.WasUpdated = false;
                    return updateStatus;
                }
            }
            else
            {
                try
                {
                    if (!plugin.IsDisabled)
                        plugin.Disable();

                    lock (this.pluginListLock)
                    {
                        this.InstalledPlugins = this.InstalledPlugins.Remove(plugin);
                    }
                }
                catch (Exception ex)
                {
                    Log.Error(ex, "Error during disable (update)");
                    updateStatus.WasUpdated = false;
                    return updateStatus;
                }
            }

            // We need to handle removed DTR nodes here, as otherwise, plugins will not be able to re-add their bar entries after updates.
            var dtr = Service<DtrBar>.Get();
            dtr.HandleRemovedNodes();

            try
            {
                await this.InstallPluginAsync(metadata.UpdateManifest, metadata.UseTesting, PluginLoadReason.Update);
            }
            catch (Exception ex)
            {
                Log.Error(ex, "Error during install (update)");
                updateStatus.WasUpdated = false;
                return updateStatus;
            }
        }

        if (notify && updateStatus.WasUpdated)
            this.NotifyInstalledPluginsChanged();

        return updateStatus;
    }

    /// <summary>
    /// Unload the plugin, delete its configuration, and reload it.
    /// </summary>
    /// <param name="plugin">The plugin.</param>
    /// <exception cref="Exception">Throws if the plugin is still loading/unloading.</exception>
    /// <returns>The task.</returns>
    public async Task DeleteConfigurationAsync(LocalPlugin plugin)
    {
        if (plugin.State == PluginState.Loading || plugin.State == PluginState.Unloaded)
            throw new Exception("Cannot delete configuration for a loading/unloading plugin");

        if (plugin.IsLoaded)
            await plugin.UnloadAsync();

        for (var waitUntil = Environment.TickCount64 + 1000; Environment.TickCount64 < waitUntil;)
        {
            try
            {
                this.PluginConfigs.Delete(plugin.Name);
                break;
            }
            catch (IOException)
            {
                await Task.Delay(100);
            }
        }

        // Let's indicate "installer" here since this is supposed to be a fresh install
        await plugin.LoadAsync(PluginLoadReason.Installer);
    }

    /// <summary>
    /// Gets a value indicating whether the given manifest is eligible for ANYTHING. These are hard
    /// checks that should not allow installation or loading.
    /// </summary>
    /// <param name="manifest">Plugin manifest.</param>
    /// <returns>If the manifest is eligible.</returns>
    public bool IsManifestEligible(PluginManifest manifest)
    {
        // Testing exclusive
        if (manifest.IsTestingExclusive && !this.configuration.DoPluginTest)
        {
            Log.Verbose($"Testing exclusivity: {manifest.InternalName} - {manifest.AssemblyVersion} - {manifest.TestingAssemblyVersion}");
            return false;
        }

        // Applicable version
        if (manifest.ApplicableVersion < this.startInfo.GameVersion)
        {
            Log.Verbose($"Game version: {manifest.InternalName} - {manifest.AssemblyVersion} - {manifest.TestingAssemblyVersion}");
            return false;
        }

        // API level
        if (manifest.DalamudApiLevel < DalamudApiLevel && !this.LoadAllApiLevels)
        {
            Log.Verbose($"API Level: {manifest.InternalName} - {manifest.AssemblyVersion} - {manifest.TestingAssemblyVersion}");
            return false;
        }

        // Banned
        if (this.IsManifestBanned(manifest))
        {
            Log.Verbose($"Banned: {manifest.InternalName} - {manifest.AssemblyVersion} - {manifest.TestingAssemblyVersion}");
            return false;
        }

        return true;
    }

    /// <summary>
    /// Determine if a plugin has been banned by inspecting the manifest.
    /// </summary>
    /// <param name="manifest">Manifest to inspect.</param>
    /// <returns>A value indicating whether the plugin/manifest has been banned.</returns>
    public bool IsManifestBanned(PluginManifest manifest)
    {
        Debug.Assert(this.bannedPlugins != null, "this.bannedPlugins != null");

        if (this.LoadBannedPlugins)
            return true;

        var config = Service<DalamudConfiguration>.Get();

        var versionToCheck = manifest.AssemblyVersion;
        if (config.DoPluginTest && manifest.TestingAssemblyVersion > manifest.AssemblyVersion)
        {
            versionToCheck = manifest.TestingAssemblyVersion;
        }

        return this.bannedPlugins.Any(ban => (ban.Name == manifest.InternalName || ban.Name == Hash.GetStringSha256Hash(manifest.InternalName))
                                                                        && ban.AssemblyVersion >= versionToCheck);
    }

    /// <summary>
    /// Get the reason of a banned plugin by inspecting the manifest.
    /// </summary>
    /// <param name="manifest">Manifest to inspect.</param>
    /// <returns>The reason of the ban, if any.</returns>
    public string GetBanReason(PluginManifest manifest)
    {
        Debug.Assert(this.bannedPlugins != null, "this.bannedPlugins != null");

        return this.bannedPlugins.LastOrDefault(ban => ban.Name == manifest.InternalName).Reason;
    }

    private void DetectAvailablePluginUpdates()
    {
        var updatablePlugins = new List<AvailablePluginUpdate>();

        foreach (var plugin in this.InstalledPlugins)
        {
            var installedVersion = plugin.IsTesting
                                       ? plugin.Manifest.TestingAssemblyVersion
                                       : plugin.Manifest.AssemblyVersion;

            var updates = this.AvailablePlugins
                              .Where(remoteManifest => plugin.Manifest.InternalName == remoteManifest.InternalName)
                              .Select(remoteManifest =>
                              {
                                  var useTesting = UseTesting(remoteManifest);
                                  var candidateVersion = useTesting
                                                             ? remoteManifest.TestingAssemblyVersion
                                                             : remoteManifest.AssemblyVersion;
                                  var isUpdate = candidateVersion > installedVersion;

                                  return (isUpdate, useTesting, candidateVersion, remoteManifest);
                              })
                              .Where(tpl => tpl.isUpdate)
                              .ToList();

            if (updates.Count > 0)
            {
                var update = updates.Aggregate((t1, t2) => t1.candidateVersion > t2.candidateVersion ? t1 : t2);
                updatablePlugins.Add(new AvailablePluginUpdate(plugin, update.remoteManifest, update.useTesting));
            }
        }

        this.UpdatablePlugins = updatablePlugins.ToImmutableList();
    }

    private void NotifyAvailablePluginsChanged()
    {
        this.DetectAvailablePluginUpdates();

        try
        {
            this.OnAvailablePluginsChanged?.Invoke();
        }
        catch (Exception ex)
        {
            Log.Error(ex, $"Error notifying {nameof(this.OnAvailablePluginsChanged)}");
        }
    }

    private void NotifyInstalledPluginsChanged()
    {
        this.DetectAvailablePluginUpdates();

        try
        {
            this.OnInstalledPluginsChanged?.Invoke();
        }
        catch (Exception ex)
        {
            Log.Error(ex, $"Error notifying {nameof(this.OnInstalledPluginsChanged)}");
        }
    }

    private static class Locs
    {
        public static string DalamudPluginUpdateSuccessful(string name, Version version) => Loc.Localize("DalamudPluginUpdateSuccessful", "    》 {0} updated to v{1}.").Format(name, version);

        public static string DalamudPluginUpdateFailed(string name, Version version) => Loc.Localize("DalamudPluginUpdateFailed", "    》 {0} update to v{1} failed.").Format(name, version);
    }
}

/// <summary>
/// Class responsible for loading and unloading plugins.
/// This contains the assembly patching functionality to resolve assembly locations.
/// </summary>
internal partial class PluginManager
{
    /// <summary>
    /// A mapping of plugin assembly name to patch data. Used to fill in missing data due to loading
    /// plugins via byte[].
    /// </summary>
    internal static readonly ConcurrentDictionary<string, PluginPatchData> PluginLocations = new();

    private MonoMod.RuntimeDetour.Hook? assemblyLocationMonoHook;
    private MonoMod.RuntimeDetour.Hook? assemblyCodeBaseMonoHook;

    /// <summary>
    /// Patch method for internal class RuntimeAssembly.Location, also known as Assembly.Location.
    /// This patch facilitates resolving the assembly location for plugins that are loaded via byte[].
    /// It should never be called manually.
    /// </summary>
    /// <param name="orig">A delegate that acts as the original method.</param>
    /// <param name="self">The equivalent of `this`.</param>
    /// <returns>The plugin location, or the result from the original method.</returns>
    private static string AssemblyLocationPatch(Func<Assembly, string?> orig, Assembly self)
    {
        var result = orig(self);

        if (string.IsNullOrEmpty(result))
        {
            foreach (var assemblyName in GetStackFrameAssemblyNames())
            {
                if (PluginLocations.TryGetValue(assemblyName, out var data))
                {
                    result = data.Location;
                    break;
                }
            }
        }

        result ??= string.Empty;

        Log.Verbose($"Assembly.Location // {self.FullName} // {result}");
        return result;
    }

    /// <summary>
    /// Patch method for internal class RuntimeAssembly.CodeBase, also known as Assembly.CodeBase.
    /// This patch facilitates resolving the assembly location for plugins that are loaded via byte[].
    /// It should never be called manually.
    /// </summary>
    /// <param name="orig">A delegate that acts as the original method.</param>
    /// <param name="self">The equivalent of `this`.</param>
    /// <returns>The plugin code base, or the result from the original method.</returns>
    private static string AssemblyCodeBasePatch(Func<Assembly, string?> orig, Assembly self)
    {
        var result = orig(self);

        if (string.IsNullOrEmpty(result))
        {
            foreach (var assemblyName in GetStackFrameAssemblyNames())
            {
                if (PluginLocations.TryGetValue(assemblyName, out var data))
                {
                    result = data.CodeBase;
                    break;
                }
            }
        }

        result ??= string.Empty;

        Log.Verbose($"Assembly.CodeBase // {self.FullName} // {result}");
        return result;
    }

    private static IEnumerable<string> GetStackFrameAssemblyNames()
    {
        var stackTrace = new StackTrace();
        var stackFrames = stackTrace.GetFrames();

        foreach (var stackFrame in stackFrames)
        {
            var methodBase = stackFrame.GetMethod();
            if (methodBase == null)
                continue;

            yield return methodBase.Module.Assembly.FullName!;
        }
    }

    private void ApplyPatches()
    {
        var targetType = typeof(PluginManager).Assembly.GetType();

        var locationTarget = targetType.GetProperty(nameof(Assembly.Location))!.GetGetMethod();
        var locationPatch = typeof(PluginManager).GetMethod(nameof(AssemblyLocationPatch), BindingFlags.NonPublic | BindingFlags.Static);
        this.assemblyLocationMonoHook = new MonoMod.RuntimeDetour.Hook(locationTarget, locationPatch);

#pragma warning disable CS0618
#pragma warning disable SYSLIB0012
        var codebaseTarget = targetType.GetProperty(nameof(Assembly.CodeBase))?.GetGetMethod();
#pragma warning restore SYSLIB0012
#pragma warning restore CS0618
        var codebasePatch = typeof(PluginManager).GetMethod(nameof(AssemblyCodeBasePatch), BindingFlags.NonPublic | BindingFlags.Static);
        this.assemblyCodeBaseMonoHook = new MonoMod.RuntimeDetour.Hook(codebaseTarget, codebasePatch);
    }
}