src/QueryCat.Backend.Core/Plugins/PluginInfo.cs - develop - krasninja/querycat

src/QueryCat.Backend.Core/Plugins/PluginInfo.cs
117 строк4 KB
Ivan Kozhin
Add more code comments
22 янв 2024, 18:36
22 янв 2024, 18:36cda3b0a
using System.Text.RegularExpressions;

namespace QueryCat.Backend.Core.Plugins;

/// <summary>
/// Plugin information. Usually we get it from file name. Right now the following patterns are supported:
/// - QCat.Plugins.Yandex-0.1.0-linux-x64.
/// - QCat.Plugins.Yandex-0.1.0-win-x64.exe.
/// - QCat.Plugins.Yandex.0.1.0.nupkg.
/// </summary>
public class PluginInfo
{
    private static readonly Regex KeyRegex = new(
        @"^(?<name>[a-zA-Z\.]+)\.(?<version>\d+\.\d+\.\d+)\.(so|dll|nupkg)$",
        RegexOptions.Compiled);

    private static readonly Regex NewKeyRegex =
        new(@"^(?<name>.+)-(?<version>\d+\.\d+\.\d+)-?(?<platform>[a-z0-9]+)?-?(?<arch>[a-z0-9]+)?(\.so|\.dll|\.exe)?$",
        RegexOptions.Compiled);

    /// <summary>
    /// Plugin name.
    /// </summary>
    public string Name { get; }

    /// <summary>
    /// Full URI to plugin file.
    /// </summary>
    public string Uri { get; set; } = string.Empty;

    /// <summary>
    /// Plugin version. It will be "0.0" if not defined.
    /// </summary>
    public Version Version { get; set; } = new();

    /// <summary>
    /// Plugin platform.
    /// </summary>
    public string Platform { get; set; } = Application.PlatformUnknown;

    /// <summary>
    /// Plugin architecture.
    /// </summary>
    public string Architecture { get; set; } = Application.ArchitectureUnknown;

    /// <summary>
    /// Is plugin installed and ready to use.
    /// </summary>
    public bool IsInstalled { get; set; }

    private PluginInfo(string name)
    {
        Name = name;
    }

    /// <summary>
    /// Create plugin info from plugin name pattern.
    /// </summary>
    /// <param name="name">Plugin name.</param>
    /// <returns>Instance of <see cref="PluginInfo" />.</returns>
    public static PluginInfo CreateFromUniversalName(string name)
    {
        var fileName = Path.GetFileName(name);
        var uri = File.Exists(name) ? name : string.Empty;

        var match = NewKeyRegex.Match(fileName);
        if (match.Success)
        {
            var architecture = match.Groups["arch"].Value;
            var platform = match.Groups["platform"].Value;

            // With certain extensions we can be sure it is Windows.
            var extension = Path.GetExtension(fileName);
            if (string.IsNullOrEmpty(platform)
                && (extension.Equals(".exe", StringComparison.OrdinalIgnoreCase)
                    || extension.Equals(".dll", StringComparison.OrdinalIgnoreCase)))
            {
                platform = Application.PlatformWindows;
            }

            return new PluginInfo(match.Groups["name"].Value)
            {
                Version = new Version(match.Groups["version"].Value),
                Architecture = !string.IsNullOrEmpty(architecture) ? architecture : Application.ArchitectureUnknown,
                Platform = !string.IsNullOrEmpty(platform) ? platform : Application.PlatformUnknown,
                Uri = uri,
            };
        }
        match = KeyRegex.Match(fileName);
        if (match.Success)
        {
            return new PluginInfo(match.Groups["name"].Value)
            {
                Version = new Version(match.Groups["version"].Value),
                Architecture = Application.ArchitectureMsil,
                Platform = Application.PlatformMulti,
                Uri = uri,
            };
        }
        return new PluginInfo(Path.GetFileNameWithoutExtension(name))
        {
            Version = new Version(0, 0),
            Architecture = Application.ArchitectureUnknown,
            Platform = Application.PlatformUnknown,
            Uri = uri,
        };
    }

    public bool IsEqualTo(PluginInfo pluginInfo)
    {
        return pluginInfo.Name == this.Name && pluginInfo.Version == this.Version
            && pluginInfo.Platform.Equals(this.Platform) && pluginInfo.Architecture.Equals(this.Architecture);
    }

    /// <inheritdoc />
    public override string ToString() => $"{Name}-{Version}";
}