btcpayserver/BTCPayServer/Plugins/PluginService.cs

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Threading.Tasks;
using BTCPayServer.Abstractions.Contracts;
using BTCPayServer.Configuration;
using BTCPayServer.Services;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;

namespace BTCPayServer.Plugins
{
    public class PluginService
    {
        private readonly IOptions<DataDirectories> _dataDirectories;
        private readonly PoliciesSettings _policiesSettings;
        private readonly PluginBuilderClient _pluginBuilderClient;
        private static readonly HashSet<string> _builtInPluginIdentifiers = new(StringComparer.OrdinalIgnoreCase)
        {
            "BTCPayServer",
            "BTCPayServer.Plugins.Altcoins",
            "BTCPayServer.Plugins.Bitcoin",
            "BTCPayServer.Plugins.Crowdfund",
            "BTCPayServer.Plugins.NFC",
            "BTCPayServer.Plugins.PayButton",
            "BTCPayServer.Plugins.PointOfSale",
            "BTCPayServer.Plugins.Shopify"
        };

        public PluginService(
            IEnumerable<IBTCPayServerPlugin> btcPayServerPlugins,
            PluginBuilderClient pluginBuilderClient,
            IOptions<DataDirectories> dataDirectories,
            PoliciesSettings policiesSettings,
            BTCPayServerEnvironment env)
        {
            LoadedPlugins = btcPayServerPlugins;
            Installed = btcPayServerPlugins.ToDictionary(p => p.Identifier, p => p.Version, StringComparer.OrdinalIgnoreCase);
            _pluginBuilderClient = pluginBuilderClient;
            _dataDirectories = dataDirectories;
            _policiesSettings = policiesSettings;
            Env = env;
        }

        public Dictionary<string, Version> Installed { get; set; }

        public IEnumerable<IBTCPayServerPlugin> LoadedPlugins { get; }
        public BTCPayServerEnvironment Env { get; }

        public Version GetVersionOfPendingInstall(string plugin)
        {
            var dirName = Path.Combine(_dataDirectories.Value.PluginDir, plugin);
            var manifestFileName = dirName + ".json";
            if (!File.Exists(manifestFileName)) return null;
            var pluginManifest =  JObject.Parse(File.ReadAllText(manifestFileName)).ToObject<AvailablePlugin>();
            return pluginManifest.Version;
        }

        public async Task<AvailablePlugin[]> GetRemotePlugins(string searchPluginName)
        {
            string btcpayVersion = Env.Version.TrimStart('v').Split('+')[0];
            var versions = await _pluginBuilderClient.GetPublishedVersions(
                btcpayVersion, _policiesSettings.PluginPreReleases, searchPluginName);

            var plugins = versions.Select(v =>
            {
                var p = v.ManifestInfo.ToObject<AvailablePlugin>();
                p.Documentation = v.Documentation;
                var github = v.BuildInfo.GetGithubRepository();
                if (github != null)
                {
                    p.Source = github.GetSourceUrl(v.BuildInfo.gitCommit, v.BuildInfo.pluginDir);
                    p.Author = github.Owner;
                    p.AuthorLink = $"https://github.com/{github.Owner}";
                }
                p.SystemPlugin = false;
                return p;
            }).ToList();

            var unlistedUpdates = await GetUpdatesForUnlistedInstalledAsync(plugins, btcpayVersion);
            plugins.AddRange(unlistedUpdates);

            return plugins.ToArray();
        }

        private async Task<List<AvailablePlugin>> GetUpdatesForUnlistedInstalledAsync(
            List<AvailablePlugin> publishedPlugins,
            string btcpayVersion)
        {
            var updatables = new List<AvailablePlugin>();
            var presentIdentifiers = new HashSet<string>(
                publishedPlugins.Select(p => p.Identifier),
                StringComparer.OrdinalIgnoreCase);

            foreach (var (installedIdentifier, installedVersion) in Installed)
            {
                if (_builtInPluginIdentifiers.Contains(installedIdentifier))
                    continue;

                if (presentIdentifiers.Contains(installedIdentifier))
                    continue;

                var publishedVersions = await _pluginBuilderClient.GetPluginVersionsForDownload(
                    installedIdentifier,
                    btcpayVersion,
                    _policiesSettings.PluginPreReleases,
                    includeAllVersions: true);

                if (publishedVersions == null || !publishedVersions.Any())
                    continue;

                var candidates = publishedVersions
                    .Select(versionInfo => new
                    {
                        VersionInfo = versionInfo,
                        Available = versionInfo.ManifestInfo?.ToObject<AvailablePlugin>()
                    })
                    .Where(candidate => candidate.Available != null &&
                                        candidate.Available.Identifier.Equals(installedIdentifier, StringComparison.OrdinalIgnoreCase))
                    .ToList();

                if (candidates.Count == 0)
                    continue;

                var latestCandidate = candidates
                    .OrderByDescending(candidate => candidate.Available!.Version)
                    .First();

                var latestAvailable = latestCandidate.Available!;


                if (latestAvailable.Version <= installedVersion)
                    continue;

                latestAvailable.Documentation = latestCandidate.VersionInfo.Documentation;

                var githubRepository = latestCandidate.VersionInfo.BuildInfo.GetGithubRepository();
                if (githubRepository != null)
                {
                    latestAvailable.Source = githubRepository.GetSourceUrl(
                        latestCandidate.VersionInfo.BuildInfo.gitCommit,
                        latestCandidate.VersionInfo.BuildInfo.pluginDir);
                    latestAvailable.Author = githubRepository.Owner;
                    latestAvailable.AuthorLink = $"https://github.com/{githubRepository.Owner}";
                }

                latestAvailable.SystemPlugin = false;

                updatables.Add(latestAvailable);
            }

            return updatables;
        }

        public async Task<AvailablePlugin> DownloadRemotePlugin(string pluginIdentifier, string version, VersionCondition condition = null)
        {
            if (version is null)
            {
                string btcpayVersion = Env.Version.TrimStart('v').Split('+')[0];
                var versions = await _pluginBuilderClient.GetPluginVersionsForDownload(pluginIdentifier,
                    btcpayVersion, _policiesSettings.PluginPreReleases, includeAllVersions: true);
                var potentialVersions = versions
                    .Select(v => v.ManifestInfo?.ToObject<AvailablePlugin>())
                    .Where(v => v is not null)
                    .Where(v => v.Identifier == pluginIdentifier)
                    .Select(v => v.Version)
                    .ToList();
                if (potentialVersions.Count == 0)
                {
                    throw new InvalidOperationException($"Plugin {pluginIdentifier} not found");
                }

                if (condition is not null)
                {
                    version = potentialVersions
                        .OrderDescending()
                        .FirstOrDefault(condition.IsFulfilled)?.ToString();
                    if (version is null)
                    {
                        throw new InvalidOperationException($"No version of plugin {pluginIdentifier} can satisfy condition {condition}");
                    }
                }
            }

            var dest = _dataDirectories.Value.PluginDir;
            var filedest = Path.Join(dest, pluginIdentifier + ".btcpay");
            var filemanifestdest = Path.Join(dest, pluginIdentifier + ".json");
            var pluginSelector = $"[{Uri.EscapeDataString(pluginIdentifier)}]";
            version = Uri.EscapeDataString(version);
            Directory.CreateDirectory(Path.GetDirectoryName(filedest));
            var url = $"api/v1/plugins/{pluginSelector}/versions/{version}/download";
            var manifest = (await _pluginBuilderClient.GetPlugin(pluginSelector, version))?.ManifestInfo?.ToObject<AvailablePlugin>();
            await File.WriteAllTextAsync(filemanifestdest, JsonConvert.SerializeObject(manifest, Formatting.Indented));
            using var resp2 = await _pluginBuilderClient.HttpClient.GetAsync(url);
            await using var fs = new FileStream(filedest, FileMode.Create, FileAccess.ReadWrite);
            await resp2.Content.CopyToAsync(fs);
            await fs.FlushAsync();
            return manifest;
        }

        public void InstallPlugin(string plugin)
        {
            PluginManager.QueueCommands(_dataDirectories.Value.PluginDir, ("install", plugin));
        }

        public async Task UploadPlugin(IFormFile plugin)
        {
            var dest = _dataDirectories.Value.PluginDir;
            var filedest = Path.Combine(dest, plugin.FileName);
            Directory.CreateDirectory(Path.GetDirectoryName(filedest));
            if (Path.GetExtension(filedest) == PluginManager.BTCPayPluginSuffix)
            {
                await using var stream = new FileStream(filedest, FileMode.Create);
                await plugin.CopyToAsync(stream);
            }
        }

        public void UninstallPlugin(string plugin)
        {
            var dest = _dataDirectories.Value.PluginDir;
            PluginManager.CancelCommands(dest, plugin);
            PluginManager.QueueCommands(dest, ("delete", plugin));
        }

        public class AvailablePlugin
        {
            public string Identifier { get; set; }
            public string Name { get; set; }
            public Version Version { get; set; }
            public string Description { get; set; }
            public bool SystemPlugin { get; set; } = false;

            public IBTCPayServerPlugin.PluginDependency[] Dependencies { get; set; } = Array.Empty<IBTCPayServerPlugin.PluginDependency>();
            public string Documentation { get; set; }
            public string Source { get; set; }
            public string Author { get; set; }
            public string AuthorLink { get; set; }

            public void Execute(IApplicationBuilder applicationBuilder, IServiceProvider applicationBuilderApplicationServices)
            {
            }

            public void Execute(IServiceCollection applicationBuilder)
            {
            }
        }

        class GithubFile
        {
            [JsonProperty("name")] public string Name { get; set; }

            [JsonProperty("sha")] public string Sha { get; set; }
            [JsonProperty("type")] public string Type { get; set; }
            [JsonProperty("path")] public string Path { get; set; }

            [JsonProperty("download_url")] public string DownloadUrl { get; set; }
        }

        public (string command, string plugin)[] GetPendingCommands()
        {
            return PluginManager.GetPendingCommands(_dataDirectories.Value.PluginDir);
        }

        public void CancelCommands(string plugin)
        {
            PluginManager.CancelCommands(_dataDirectories.Value.PluginDir, plugin);
        }

        public Dictionary<string, Version> GetDisabledPlugins()
        {
            return PluginManager.GetDisabledPlugins(_dataDirectories.Value.PluginDir);
        }
    }
}