PKHeX/PKHeX.WinForms/Util/Plugins/PluginLoader.cs

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.IO;
using System.Linq;
using System.Reflection;

namespace PKHeX.WinForms;

/// <summary>
/// Provides functionality to load plugins from assemblies at runtime.
/// </summary>
public static class PluginLoader
{
    /// <summary>
    /// Loads plugin assemblies from the given directory using the provided load setting.
    /// </summary>
    /// <param name="pluginPath">The directory path to search for plugin assemblies.</param>
    /// <param name="loadMerged">The plugin load setting to use.</param>
    /// <returns>A PluginLoadResult containing contexts and assemblies.</returns>
    [RequiresUnreferencedCode("Plugin loading depends on runtime-discovered assemblies and types.")]
    [RequiresAssemblyFiles("Plugin loading reads assemblies from disk.")]
    public static PluginLoadResult LoadPluginAssemblies(string pluginPath, bool loadMerged)
    {
        var result = new PluginLoadResult();
        var dllFileNames = !Directory.Exists(pluginPath)
            ? []
            : Directory.EnumerateFiles(pluginPath, "*.dll", SearchOption.AllDirectories);
        foreach (var file in dllFileNames)
        {
            try
            {
                result.Load(file);
            }
            catch (Exception ex)
            {
                Debug.WriteLine($"Unable to load plugin from file: {file}");
                Debug.WriteLine(ex.Message);
            }
        }
        if (loadMerged)
            result.LoadFromAssembly(typeof(PluginLoader).Assembly);
        return result;
    }

    /// <summary>
    /// Loads plugins of the specified type from the given directory using the provided load setting.
    /// </summary>
    /// <typeparam name="T">The type of plugin to load.</typeparam>
    /// <param name="pluginPath">The directory path to search for plugin assemblies.</param>
    /// <param name="list">Reference to the list to populate with loaded plugins.</param>
    /// <param name="loadMerged">The plugin load setting to use.</param>
    /// <returns>Plugin source information for the loaded plugin instances of type <typeparamref name="T"/>.</returns>
    [RequiresUnreferencedCode("Plugin loading depends on runtime-discovered assemblies and types.")]
    [RequiresAssemblyFiles("Plugin loading reads assemblies from disk.")]
    public static PluginLoadResult LoadPlugins<T>(string pluginPath, List<T> list, bool loadMerged) where T : class
    {
        var result = LoadPluginAssemblies(pluginPath, loadMerged);
        var pluginTypes = GetPluginsOfType<T>(result.GetAssemblies());
        list.AddRange(LoadPlugins<T>(pluginTypes));
        return result;
    }

    /// <summary>
    /// Loads plugin instances of the specified type from the given plugin types.
    /// </summary>
    /// <typeparam name="T">The type of plugin to load.</typeparam>
    /// <param name="pluginTypes">The types of plugins to instantiate.</param>
    /// <returns>An enumerable of loaded plugin instances of type <typeparamref name="T"/>.</returns>
    [RequiresUnreferencedCode("Plugin instantiation depends on runtime-discovered types.")]
    private static IEnumerable<T> LoadPlugins<T>(IEnumerable<Type> pluginTypes) where T : class
    {
        foreach (var t in pluginTypes)
        {
            T? activate;
            try { activate = (T?)Activator.CreateInstance(t); }
            catch (Exception ex)
            {
                Debug.WriteLine($"Unable to load plugin [{t.Name}]: {t.FullName}");
                Debug.WriteLine(ex.Message);
                continue;
            }
            if (activate is not null)
                yield return activate;
        }
    }

    /// <summary>
    /// Gets all plugin types of the specified type from the given assemblies.
    /// </summary>
    /// <typeparam name="T">The type of plugin to search for.</typeparam>
    /// <param name="assemblies">The assemblies to search for plugins.</param>
    /// <returns>An enumerable of plugin types.</returns>
    [RequiresUnreferencedCode("Plugin discovery depends on runtime-discovered types.")]
    private static IEnumerable<Type> GetPluginsOfType<T>(IEnumerable<Assembly> assemblies)
    {
        var pluginType = typeof(T);
        return assemblies.SelectMany(z => GetPluginTypes(z, pluginType));
    }

    /// <summary>
    /// Gets all types from the specified assembly that match the given plugin type.
    /// </summary>
    /// <param name="z">The assembly to search.</param>
    /// <param name="plugin">The plugin type to match.</param>
    /// <returns>An enumerable of matching types.</returns>
    [RequiresUnreferencedCode("Plugin discovery depends on runtime-discovered types and members.")]
    private static IEnumerable<Type> GetPluginTypes(Assembly z, Type plugin)
    {
        TryAttachMergedAssemblyLoader(z);

        IEnumerable<Type> types;
        try
        {
            types = z.GetExportedTypes();
        }
        // User plugins can be out of date, with mismatching API surfaces.
        catch (ReflectionTypeLoadException ex)
        {
            Debug.WriteLine($"Unable to load plugin [{plugin.FullName}]: {z.FullName}");
            Debug.WriteLine(ex.Message);
            foreach (var le in ex.LoaderExceptions)
            {
                if (le is not null)
                    Debug.WriteLine(le.Message);
            }

            types = ex.Types.OfType<Type>();
        }
        catch (Exception ex)
        {
            Debug.WriteLine($"Unable to load plugin [{plugin.FullName}]: {z.FullName}");
            Debug.WriteLine(ex.Message);
            return [];
        }

        return types.Where(type => IsTypePlugin(type, plugin));
    }

    private static void TryAttachMergedAssemblyLoader(Assembly assembly)
    {
        try
        {
            // Handle Costura merged plugin dll's; need to Attach for them to correctly retrieve their dependencies.
            var assemblyLoaderType = assembly.GetType("Costura.AssemblyLoader", false);
            var attachMethod = assemblyLoaderType?.GetMethod("Attach", BindingFlags.Static | BindingFlags.Public);
            attachMethod?.Invoke(null, []);
        }
        catch (Exception ex)
        {
            Debug.WriteLine($"Unable to attach merged assembly loader: {assembly.FullName}");
            Debug.WriteLine(ex.Message);
        }
    }

    /// <summary>
    /// Determines whether the specified type is a valid plugin type.
    /// </summary>
    /// <param name="type">The type to check.</param>
    /// <param name="plugin">The plugin type to match.</param>
    /// <returns><see langword="true"/> if the type is a valid plugin type; otherwise, <see langword="false"/>.</returns>
    private static bool IsTypePlugin(Type type, Type plugin)
    {
        if (type.IsInterface || type.IsAbstract)
            return false;
        if (!plugin.IsAssignableFrom(type))
            return false;
        return type.GetConstructor(Type.EmptyTypes) is not null;
    }
}