Integrate Configurator External Service (#1190)

.gitignore

@@ -293,3 +293,4 @@ BTCPayServer/wwwroot/bundles/*
 !BTCPayServer/wwwroot/bundles/.gitignore
 
 .vscode
+BTCPayServer/testpwd

BTCPayServer/Configuration/BTCPayServerOptions.cs

@@ -141,6 +141,7 @@ namespace BTCPayServer.Configuration
                 ExternalServices.Load(net.CryptoCode, conf);
             }
 
+            ExternalServices.LoadNonCryptoServices(conf);
             Logs.Configuration.LogInformation("Supported chains: " + String.Join(',', supportedChains.ToArray()));
 
             var services = conf.GetOrDefault<string>("externalservices", null);

BTCPayServer/Configuration/ExternalConnectionString.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.IO;
 using System.Linq;
 using System.Threading.Tasks;
 using BTCPayServer.Controllers;
@@ -77,7 +78,7 @@ namespace BTCPayServer.Configuration
                 }
             }
 
-            if (serviceType == ExternalServiceTypes.Charge || serviceType == ExternalServiceTypes.RTL || serviceType == ExternalServiceTypes.Spark)
+            if (new []{ExternalServiceTypes.Charge, ExternalServiceTypes.RTL,  ExternalServiceTypes.Spark, ExternalServiceTypes.Configurator}.Contains(serviceType))
             {
                 // Read access key from cookie file
                 if (connectionString.CookieFilePath != null)

BTCPayServer/Configuration/ExternalService.cs

@@ -41,11 +41,20 @@ namespace BTCPayServer.Configuration
                                 $"lightning charge server: 'type=charge;server=https://charge.example.com;cookiefilepath=/root/.charge/.cookie'" + Environment.NewLine +
                                 "Error: {1}",
                                 "C-Lightning (Charge server)");
+            
+        }
+
+        public void LoadNonCryptoServices(IConfiguration configuration)
+        {
+            Load(configuration, null, "configurator", ExternalServiceTypes.Configurator, "Invalid setting {0}, " + Environment.NewLine +
+                                                                                   $"configurator: 'passwordfile=/etc/configurator/password'" + Environment.NewLine +
+                                                                                   "Error: {1}",
+                "Configurator");
         }
 
         void Load(IConfiguration configuration, string cryptoCode, string serviceName, ExternalServiceTypes type, string errorMessage, string displayName)
         {
-            var setting = $"{cryptoCode}.external.{serviceName}";
+            var setting = $"{(!string.IsNullOrEmpty(cryptoCode)? $"{cryptoCode}.": string.Empty)}external.{serviceName}";
             var connStr = configuration.GetOrDefault<string>(setting, string.Empty);
             if (connStr.Length != 0)
             {
@@ -65,8 +74,11 @@ namespace BTCPayServer.Configuration
 
         public ExternalService GetService(string serviceName, string cryptoCode)
         {
-            return this.FirstOrDefault(o => o.CryptoCode.Equals(cryptoCode, StringComparison.OrdinalIgnoreCase) &&
+            return this.FirstOrDefault(o =>
-                                                                                    o.ServiceName.Equals(serviceName, StringComparison.OrdinalIgnoreCase));
+                (cryptoCode == null && o.CryptoCode == null) ||
+                (o.CryptoCode != null && o.CryptoCode.Equals(cryptoCode, StringComparison.OrdinalIgnoreCase))
+                &&
+                o.ServiceName.Equals(serviceName, StringComparison.OrdinalIgnoreCase));
         }
     }
 
@@ -88,6 +100,7 @@ namespace BTCPayServer.Configuration
         RTL,
         Charge,
         P2P,
-        RPC
+        RPC,
+        Configurator
     }
 }

BTCPayServer/Controllers/ServerController.cs

@@ -528,10 +528,12 @@ namespace BTCPayServer.Controllers
             return null;
         }
 
-        [Route("server/services/{serviceName}/{cryptoCode}")]
+
+        
+        [Route("server/services/{serviceName}/{cryptoCode?}")]
         public async Task<IActionResult> Service(string serviceName, string cryptoCode, bool showQR = false, uint? nonce = null)
         {
-            if (!_dashBoard.IsFullySynched(cryptoCode, out _))
+            if (!string.IsNullOrEmpty(cryptoCode) && !_dashBoard.IsFullySynched(cryptoCode, out _))
             {
                 TempData[WellKnownTempData.ErrorMessage] = $"{cryptoCode} is not fully synched";
                 return RedirectToAction(nameof(Services));
@@ -542,6 +544,7 @@ namespace BTCPayServer.Controllers
 
             try
             {
+                
                 if (service.Type == ExternalServiceTypes.P2P)
                 {
                     return View("P2PService", new LightningWalletServices()
@@ -595,6 +598,14 @@ namespace BTCPayServer.Controllers
                     case ExternalServiceTypes.LNDGRPC:
                     case ExternalServiceTypes.LNDRest:
                         return LndServices(service, connectionString, nonce);
+                    case ExternalServiceTypes.Configurator:
+                        return View("ConfiguratorService",
+                            new LightningWalletServices()
+                            {
+                                ShowQR = showQR,
+                                WalletName = service.ServiceName,
+                                ServiceLink = $"{connectionString.Server}?password={connectionString.AccessKey}"
+                            });
                     default:
                         throw new NotSupportedException(service.Type.ToString());
                 }

BTCPayServer/Properties/launchSettings.json

@@ -40,6 +40,7 @@
                 "BTCPAY_BTCEXTERNALLNDSEEDBACKUP": "../BTCPayServer.Tests/TestData/LndSeedBackup/walletunlock.json",
                 "BTCPAY_BTCEXTERNALSPARK": "server=/spark/btc/;cookiefile=fake",
                 "BTCPAY_BTCEXTERNALCHARGE": "server=https://127.0.0.1:53280/mycharge/btc/;cookiefilepath=fake",
+                "BTCPAY_EXTERNALCONFIGURATOR": "passwordfile=testpwd;server=/configurator",
                 "BTCPAY_BTCEXPLORERURL": "http://127.0.0.1:32838/",
                 "BTCPAY_ALLOW-ADMIN-REGISTRATION": "true",
                 "BTCPAY_DISABLE-REGISTRATION": "false",

BTCPayServer/Views/Server/ConfiguratorService.cshtml

@@ -0,0 +1,33 @@
+@model LightningWalletServices
+@{
+    ViewData.SetActivePageAndTitle(ServerNavPages.Services);
+}
+
+<h4>BTCPay Server Configurator</h4>
+<partial name="_StatusMessage" />
+
+<div class="row">
+    <div class="col-md-6">
+        <div asp-validation-summary="All" class="text-danger"></div>
+    </div>
+</div>
+
+<div class="row">
+    <div class="col-md-8">
+        <div class="form-group">
+            <p>
+                <span>This page exposes information to use the configured BTCPay Server Configurator to modify this setup.</span>
+            </p>
+        </div>
+       
+            <a href="@Model.ServiceLink" target="_blank" class="form-group">
+                <label>Service</label>
+                <input asp-for="ServiceLink" readonly class="form-control" />
+            </a>
+    </div>
+</div>
+
+@section Scripts {
+    @await Html.PartialAsync("_ValidationScriptsPartial")
+
+}

BTCPayServer/Views/Server/Services.cshtml

@@ -29,7 +29,7 @@
                 </tr>
                 </thead>
                 <tbody>
-                @foreach (var s in Model.ExternalServices)
+                @foreach (var s in Model.ExternalServices.Where(service => !string.IsNullOrEmpty(service.CryptoCode)))
                 {
                     <tr>
                         <td>@s.CryptoCode</td>
@@ -52,7 +52,7 @@
     </div>
 </div>
 
-@if (Model.OtherExternalServices.Count != 0)
+@if (Model.OtherExternalServices.Count != 0 || Model.ExternalServices.Any(service => string.IsNullOrEmpty(service.CryptoCode)))
 {
     <div class="row">
         <div class="col-md-8">
@@ -69,6 +69,15 @@
                     </tr>
                     </thead>
                     <tbody>
+                    @foreach (var s in Model.ExternalServices.Where(service => string.IsNullOrEmpty(service.CryptoCode)))
+                    {
+                        <tr>
+                            <td>@s.DisplayName</td>
+                            <td style="text-align: right">
+                                <a asp-action="Service" asp-route-serviceName="@s.ServiceName">See information</a>
+                            </td>
+                        </tr>
+                    }
                     @foreach (var s in Model.OtherExternalServices)
                     {
                         <tr>