Merge pull request #6287 from btcpayserver/feat/plugin-search

Support for searching plugins by name

BTCPayServer/Controllers/UIServerController.Plugins.cs

@@ -18,12 +18,13 @@ namespace BTCPayServer.Controllers
         [HttpGet("server/plugins")]
         public async Task<IActionResult> ListPlugins(
             [FromServices] PluginService pluginService,
-            [FromServices] BTCPayServerOptions btcPayServerOptions)
+            [FromServices] BTCPayServerOptions btcPayServerOptions,
+            string search = null)
         {
             IEnumerable<PluginService.AvailablePlugin> availablePlugins;
             try
             {
-                availablePlugins = await pluginService.GetRemotePlugins();
+                availablePlugins = await pluginService.GetRemotePlugins(search);
             }
             catch (Exception)
             {

BTCPayServer/HostedServices/PluginUpdateFetcher.cs

@@ -82,7 +82,7 @@ namespace BTCPayServer.HostedServices
 
             var installedPlugins =
                 pluginService.LoadedPlugins.ToDictionary(plugin => plugin.Identifier, plugin => plugin.Version);
-            var remotePlugins = await pluginService.GetRemotePlugins();
+            var remotePlugins = await pluginService.GetRemotePlugins(null);
             //take the latest version of each plugin
             var remotePluginsList = remotePlugins
                 .GroupBy(plugin => plugin.Identifier)

BTCPayServer/Plugins/PluginBuilderClient.cs

@@ -55,11 +55,13 @@ namespace BTCPayServer.Plugins
             this.httpClient = httpClient;
         }
         static JsonSerializerSettings serializerSettings = new() { ContractResolver = new Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver() };
-        public async Task<PublishedVersion[]> GetPublishedVersions(string btcpayVersion, bool includePreRelease)
+        public async Task<PublishedVersion[]> GetPublishedVersions(string btcpayVersion, bool includePreRelease, string searchPluginName = null)
         {
             var queryString = $"?includePreRelease={includePreRelease}";
             if (btcpayVersion is not null)
-                queryString += $"&btcpayVersion={btcpayVersion}&";
+                queryString += $"&btcpayVersion={btcpayVersion}";
+            if (searchPluginName is not null)
+                queryString += $"&searchPluginName={searchPluginName}";
             var result = await httpClient.GetStringAsync($"api/v1/plugins{queryString}");
             return JsonConvert.DeserializeObject<PublishedVersion[]>(result, serializerSettings) ?? throw new InvalidOperationException();
         }

BTCPayServer/Plugins/PluginService.cs

@@ -46,9 +46,11 @@ namespace BTCPayServer.Plugins
             return pluginManifest.Version;
         }
 
-        public async Task<AvailablePlugin[]> GetRemotePlugins()
+        public async Task<AvailablePlugin[]> GetRemotePlugins(string searchPluginName)
         {
-            var versions = await _pluginBuilderClient.GetPublishedVersions(null, _policiesSettings.PluginPreReleases);
+            string btcpayVersion = Env.Version.TrimStart('v').Split('+')[0];
+            var versions = await _pluginBuilderClient.GetPublishedVersions(
+                btcpayVersion, _policiesSettings.PluginPreReleases, searchPluginName);
             return versions.Select(v =>
             {
                 var p = v.ManifestInfo.ToObject<AvailablePlugin>();

BTCPayServer/Views/UIServer/ListPlugins.cshtml

@@ -308,7 +308,45 @@
     </div>
 }
 
-@if (availableAndNotInstalled.Any())
+<form method="get" asp-action="ListPlugins" class="row mb-4" id="searchForm">
+    <div class="col-12 col-lg-6">
+        <div class="input-group">
+            <input type="text" name="search" class="form-control" placeholder="Search for plugins..."
+                   value="@ViewContext.HttpContext.Request.Query["search"]" />
+            <button type="submit" class="btn btn-primary">
+                <vc:icon symbol="actions-search" />
+            </button>
+        </div>
+    </div>
+</form>
+<script>
+    // if we search using form, scroll to it
+    document.addEventListener("DOMContentLoaded", function() {
+        const searchForm = document.getElementById('searchForm');
+
+        // Set session storage flag on form submit
+        searchForm.addEventListener('submit', function() {
+            sessionStorage.setItem('formSubmitted', 'true');
+        });
+
+        // Check session storage to see if form was submitted, and scroll + clear it
+        if (sessionStorage.getItem('formSubmitted') === 'true') {
+            sessionStorage.removeItem('formSubmitted');
+            if (searchForm) {
+                searchForm.scrollIntoView();
+            }
+        }
+    });
+
+</script>
+
+@if (!availableAndNotInstalled.Any())
+{
+    <div class="row mb-4">
+        <div class="col mb-4" style="margin-left:10px;">No plugins found</div>
+    </div>
+}
+else 
 {
     <h3 class="mb-4">Available Plugins</h3>
     <div class="row mb-4">