From dc986959fd6dfc55732c54be4797e63df76bc9e5 Mon Sep 17 00:00:00 2001 From: Nicolas Dorier Date: Mon, 24 Jul 2023 09:24:32 +0900 Subject: [PATCH] Add reporting feature (#5155) * Add reporting feature * Remove nodatime * Add summaries * work... * Add chart title * Fix error * Allow to set hour in the field * UI updates * Fix fake data * ViewDefinitions can be dynamic * Add items sold * Sticky table headers * Update JS and remove jQuery usages * JS click fix * Handle tag all invoices for app * fix dup row in items report * Can cancel invoice request * Add tests * Fake data for items sold * Rename Items to Products, improve navigation F5 * Use bordered table for summaries --------- Co-authored-by: Dennis Reimann --- .../TagHelpers/PermissionTagHelper.cs | 4 +- .../Models/StoreReportRequest.cs | 62 ++++ .../Models/StoreReportsResponse.cs | 16 ++ .../ApplicationDbContextFactory.cs | 3 + BTCPayServer.Tests/TestAccount.cs | 95 ++++++- BTCPayServer.Tests/ThirdPartyTests.cs | 8 + BTCPayServer.Tests/UnitTest1.cs | 119 ++++++++ BTCPayServer/BTCPayServer.csproj | 4 + .../Components/MainNav/Default.cshtml | 6 + .../GreenField/GreenfieldReportsController.cs | 80 ++++++ .../UIReportsController.CheatMode.cs | 122 ++++++++ .../Controllers/UIReportsController.cs | 91 ++++++ BTCPayServer/Extensions.cs | 9 + BTCPayServer/Extensions/StoreExtensions.cs | 9 + BTCPayServer/Hosting/BTCPayServerServices.cs | 6 + .../StoreReportsViewModel.cs | 16 ++ .../Services/Invoices/InvoiceRepository.cs | 9 +- BTCPayServer/Services/ReportService.cs | 20 ++ .../Reporting/OnChainWalletReportProvider.cs | 122 ++++++++ .../Reporting/PaymentsReportProvider.cs | 187 ++++++++++++ .../Reporting/ProductsReportProvider.cs | 131 +++++++++ .../Services/Reporting/QueryContext.cs | 34 +++ .../Services/Reporting/ReportProvider.cs | 19 ++ .../Services/Reporting/ViewDefinition.cs | 16 ++ BTCPayServer/TagHelpers/CheatModeTagHelper.cs | 30 ++ .../Views/UIReports/StoreReports.cshtml | 128 +++++++++ BTCPayServer/Views/UIStores/StoreNavPages.cs | 1 + BTCPayServer/wwwroot/js/datatable.js | 269 ++++++++++++++++++ BTCPayServer/wwwroot/js/store-reports.js | 212 ++++++++++++++ .../wwwroot/vendor/FileSaver/FileSaver.min.js | 3 + .../wwwroot/vendor/papaparse/papaparse.min.js | 7 + 31 files changed, 1830 insertions(+), 8 deletions(-) create mode 100644 BTCPayServer.Client/Models/StoreReportRequest.cs create mode 100644 BTCPayServer.Client/Models/StoreReportsResponse.cs create mode 100644 BTCPayServer/Controllers/GreenField/GreenfieldReportsController.cs create mode 100644 BTCPayServer/Controllers/UIReportsController.CheatMode.cs create mode 100644 BTCPayServer/Controllers/UIReportsController.cs create mode 100644 BTCPayServer/Models/StoreReportsViewModels/StoreReportsViewModel.cs create mode 100644 BTCPayServer/Services/ReportService.cs create mode 100644 BTCPayServer/Services/Reporting/OnChainWalletReportProvider.cs create mode 100644 BTCPayServer/Services/Reporting/PaymentsReportProvider.cs create mode 100644 BTCPayServer/Services/Reporting/ProductsReportProvider.cs create mode 100644 BTCPayServer/Services/Reporting/QueryContext.cs create mode 100644 BTCPayServer/Services/Reporting/ReportProvider.cs create mode 100644 BTCPayServer/Services/Reporting/ViewDefinition.cs create mode 100644 BTCPayServer/TagHelpers/CheatModeTagHelper.cs create mode 100644 BTCPayServer/Views/UIReports/StoreReports.cshtml create mode 100644 BTCPayServer/wwwroot/js/datatable.js create mode 100644 BTCPayServer/wwwroot/js/store-reports.js create mode 100644 BTCPayServer/wwwroot/vendor/FileSaver/FileSaver.min.js create mode 100644 BTCPayServer/wwwroot/vendor/papaparse/papaparse.min.js diff --git a/BTCPayServer.Abstractions/TagHelpers/PermissionTagHelper.cs b/BTCPayServer.Abstractions/TagHelpers/PermissionTagHelper.cs index 59d454c1a..436405271 100644 --- a/BTCPayServer.Abstractions/TagHelpers/PermissionTagHelper.cs +++ b/BTCPayServer.Abstractions/TagHelpers/PermissionTagHelper.cs @@ -12,13 +12,11 @@ public class PermissionTagHelper : TagHelper { private readonly IAuthorizationService _authorizationService; private readonly IHttpContextAccessor _httpContextAccessor; - private readonly ILogger _logger; - public PermissionTagHelper(IAuthorizationService authorizationService, IHttpContextAccessor httpContextAccessor, ILogger logger) + public PermissionTagHelper(IAuthorizationService authorizationService, IHttpContextAccessor httpContextAccessor) { _authorizationService = authorizationService; _httpContextAccessor = httpContextAccessor; - _logger = logger; } public string Permission { get; set; } diff --git a/BTCPayServer.Client/Models/StoreReportRequest.cs b/BTCPayServer.Client/Models/StoreReportRequest.cs new file mode 100644 index 000000000..f9c7b4ca3 --- /dev/null +++ b/BTCPayServer.Client/Models/StoreReportRequest.cs @@ -0,0 +1,62 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using BTCPayServer.JsonConverters; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; + +namespace BTCPayServer.Client.Models; + +public class StoreReportRequest +{ + public string ViewName { get; set; } + public TimePeriod TimePeriod { get; set; } +} +public class StoreReportResponse +{ + public class Field + { + public Field() + { + + } + public Field(string name, string type) + { + Name = name; + Type = type; + } + public string Name { get; set; } + public string Type { get; set; } + } + public IList Fields { get; set; } = new List(); + public List Data { get; set; } + public DateTimeOffset From { get; set; } + public DateTimeOffset To { get; set; } + public List Charts { get; set; } + + public int GetIndex(string fieldName) + { + return Fields.ToList().FindIndex(f => f.Name == fieldName); + } +} + +public class ChartDefinition +{ + public string Name { get; set; } + + public List Groups { get; set; } = new List(); + public List Totals { get; set; } = new List(); + public bool HasGrandTotal { get; set; } + public List Aggregates { get; set; } = new List(); + public List Filters { get; set; } = new List(); +} + +public class TimePeriod +{ + [JsonConverter(typeof(NBitcoin.JsonConverters.DateTimeToUnixTimeConverter))] + public DateTimeOffset? From { get; set; } + [JsonConverter(typeof(NBitcoin.JsonConverters.DateTimeToUnixTimeConverter))] + public DateTimeOffset? To { get; set; } +} diff --git a/BTCPayServer.Client/Models/StoreReportsResponse.cs b/BTCPayServer.Client/Models/StoreReportsResponse.cs new file mode 100644 index 000000000..514dfbb84 --- /dev/null +++ b/BTCPayServer.Client/Models/StoreReportsResponse.cs @@ -0,0 +1,16 @@ +using System; +using System.Collections.Generic; +using System.Text; + +namespace BTCPayServer.Client.Models +{ + public class StoreReportsResponse + { + public string ViewName { get; set; } + public StoreReportResponse.Field[] Fields + { + get; + set; + } + } +} diff --git a/BTCPayServer.Data/ApplicationDbContextFactory.cs b/BTCPayServer.Data/ApplicationDbContextFactory.cs index fe5dbf569..156f18964 100644 --- a/BTCPayServer.Data/ApplicationDbContextFactory.cs +++ b/BTCPayServer.Data/ApplicationDbContextFactory.cs @@ -1,3 +1,6 @@ +using System; +using System.Runtime.CompilerServices; +using System.Threading.Tasks; using BTCPayServer.Abstractions.Contracts; using BTCPayServer.Abstractions.Models; using Microsoft.EntityFrameworkCore; diff --git a/BTCPayServer.Tests/TestAccount.cs b/BTCPayServer.Tests/TestAccount.cs index 038ea3371..54474e7bd 100644 --- a/BTCPayServer.Tests/TestAccount.cs +++ b/BTCPayServer.Tests/TestAccount.cs @@ -40,6 +40,7 @@ namespace BTCPayServer.Tests public class TestAccount { readonly ServerTester parent; + public string LNAddress; public TestAccount(ServerTester parent) { @@ -242,7 +243,7 @@ namespace BTCPayServer.Tests policies.LockSubscription = false; await account.Register(RegisterDetails); } - + TestLogs.LogInformation($"UserId: {account.RegisteredUserId} Password: {Password}"); UserId = account.RegisteredUserId; Email = RegisterDetails.Email; IsAdmin = account.RegisteredAdmin; @@ -309,8 +310,9 @@ namespace BTCPayServer.Tests Assert.False(true, storeController.ModelState.FirstOrDefault().Value.Errors[0].ErrorMessage); } - public async Task ReceiveUTXO(Money value, BTCPayNetwork network) + public async Task ReceiveUTXO(Money value, BTCPayNetwork network = null) { + network ??= SupportedNetwork; var cashCow = parent.ExplorerNode; var btcPayWallet = parent.PayTester.GetService().GetWallet(network); var address = (await btcPayWallet.ReserveAddressAsync(this.DerivationScheme)).Address; @@ -553,5 +555,94 @@ retry: var repo = this.parent.PayTester.GetService(); await repo.AddStoreUser(StoreId, userId, StoreRoleId.Owner); } + + public async Task PayOnChain(string invoiceId) + { + var cryptoCode = "BTC"; + var client = await CreateClient(); + var methods = await client.GetInvoicePaymentMethods(StoreId, invoiceId); + var method = methods.First(m => m.PaymentMethod == cryptoCode); + var address = method.Destination; + var tx = await client.CreateOnChainTransaction(StoreId, cryptoCode, new CreateOnChainTransactionRequest() + { + Destinations = new List() + { + new () + { + Destination = address, + Amount = method.Due + } + }, + FeeRate = new FeeRate(1.0m) + }); + await WaitInvoicePaid(invoiceId); + return tx.TransactionHash; + } + + public async Task PayOnBOLT11(string invoiceId) + { + var cryptoCode = "BTC"; + var client = await CreateClient(); + var methods = await client.GetInvoicePaymentMethods(StoreId, invoiceId); + var method = methods.First(m => m.PaymentMethod == $"{cryptoCode}-LightningNetwork"); + var bolt11 = method.Destination; + TestLogs.LogInformation("PAYING"); + await parent.CustomerLightningD.Pay(bolt11); + TestLogs.LogInformation("PAID"); + await WaitInvoicePaid(invoiceId); + } + + public async Task PayOnLNUrl(string invoiceId) + { + var cryptoCode = "BTC"; + var network = SupportedNetwork.NBitcoinNetwork; + var client = await CreateClient(); + var methods = await client.GetInvoicePaymentMethods(StoreId, invoiceId); + var method = methods.First(m => m.PaymentMethod == $"{cryptoCode}-LNURLPAY"); + var lnurL = LNURL.LNURL.Parse(method.PaymentLink, out var tag); + var http = new HttpClient(); + var payreq = (LNURL.LNURLPayRequest)await LNURL.LNURL.FetchInformation(lnurL, tag, http); + var resp = await payreq.SendRequest(payreq.MinSendable, network, http); + var bolt11 = resp.Pr; + await parent.CustomerLightningD.Pay(bolt11); + await WaitInvoicePaid(invoiceId); + } + + public Task WaitInvoicePaid(string invoiceId) + { + return TestUtils.EventuallyAsync(async () => + { + var client = await CreateClient(); + var invoice = await client.GetInvoice(StoreId, invoiceId); + if (invoice.Status == InvoiceStatus.Settled) + return; + Assert.Equal(InvoiceStatus.Processing, invoice.Status); + }); + } + + public async Task PayOnLNAddress(string lnAddrUser = null) + { + lnAddrUser ??= LNAddress; + var network = SupportedNetwork.NBitcoinNetwork; + var payReqStr = await (await parent.PayTester.HttpClient.GetAsync($".well-known/lnurlp/{lnAddrUser}")).Content.ReadAsStringAsync(); + var payreq = JsonConvert.DeserializeObject(payReqStr); + var resp = await payreq.SendRequest(payreq.MinSendable, network, parent.PayTester.HttpClient); + var bolt11 = resp.Pr; + await parent.CustomerLightningD.Pay(bolt11); + } + + public async Task CreateLNAddress() + { + var lnAddrUser = Guid.NewGuid().ToString(); + var ctx = parent.PayTester.GetService().CreateContext(); + ctx.LightningAddresses.Add(new() + { + StoreDataId = StoreId, + Username = lnAddrUser + }); + await ctx.SaveChangesAsync(); + LNAddress = lnAddrUser; + return lnAddrUser; + } } } diff --git a/BTCPayServer.Tests/ThirdPartyTests.cs b/BTCPayServer.Tests/ThirdPartyTests.cs index 2d2d69b39..c004f24b1 100644 --- a/BTCPayServer.Tests/ThirdPartyTests.cs +++ b/BTCPayServer.Tests/ThirdPartyTests.cs @@ -391,6 +391,14 @@ retry: expected = (await (await client.GetAsync($"https://cdnjs.cloudflare.com/ajax/libs/bootstrap-vue/{version}/bootstrap-vue.min.js")).Content.ReadAsStringAsync()).Trim(); EqualJsContent(expected, actual); + actual = GetFileContent("BTCPayServer", "wwwroot", "vendor", "FileSaver", "FileSaver.min.js").Trim(); + expected = (await (await client.GetAsync($"https://raw.githubusercontent.com/eligrey/FileSaver.js/43bbd2f0ae6794f8d452cd360e9d33aef6071234/dist/FileSaver.min.js")).Content.ReadAsStringAsync()).Trim(); + EqualJsContent(expected, actual); + + actual = GetFileContent("BTCPayServer", "wwwroot", "vendor", "papaparse", "papaparse.min.js").Trim(); + expected = (await (await client.GetAsync($"https://raw.githubusercontent.com/mholt/PapaParse/5.4.1/papaparse.min.js")).Content.ReadAsStringAsync()).Trim(); + EqualJsContent(expected, actual); + actual = GetFileContent("BTCPayServer", "wwwroot", "vendor", "vue-sanitize-directive", "vue-sanitize-directive.umd.min.js").Trim(); version = Regex.Match(actual, "Original file: /npm/vue-sanitize-directive@([0-9]+.[0-9]+.[0-9]+)").Groups[1].Value; expected = (await (await client.GetAsync($"https://cdn.jsdelivr.net/npm/vue-sanitize-directive@{version}/dist/vue-sanitize-directive.umd.min.js")).Content.ReadAsStringAsync()).Trim(); diff --git a/BTCPayServer.Tests/UnitTest1.cs b/BTCPayServer.Tests/UnitTest1.cs index 8a511f149..dc78784a7 100644 --- a/BTCPayServer.Tests/UnitTest1.cs +++ b/BTCPayServer.Tests/UnitTest1.cs @@ -2936,5 +2936,124 @@ namespace BTCPayServer.Tests Assert.IsType(Assert.IsType(await controller.Files(new string[] { fileId })).Model); Assert.Null(viewFilesViewModel.DirectUrlByFiles); } + + [Fact] + [Trait("Selenium", "Selenium")] + public async Task CanCreateReports() + { + using var tester = CreateServerTester(); + tester.ActivateLightning(); + tester.DeleteStore = false; + await tester.StartAsync(); + await tester.EnsureChannelsSetup(); + var acc = tester.NewAccount(); + await acc.GrantAccessAsync(); + await acc.MakeAdmin(); + acc.RegisterDerivationScheme("BTC", importKeysToNBX: true); + acc.RegisterLightningNode("BTC"); + await acc.ReceiveUTXO(Money.Coins(1.0m)); + + var client = await acc.CreateClient(); + var posController = acc.GetController(); + + var app = await client.CreatePointOfSaleApp(acc.StoreId, new CreatePointOfSaleAppRequest() + { + AppName = "Static", + DefaultView = Client.Models.PosViewType.Static, + Template = new PointOfSaleSettings().Template + }); + var resp = await posController.ViewPointOfSale(app.Id, choiceKey: "green-tea"); + var invoiceId = GetInvoiceId(resp); + await acc.PayOnChain(invoiceId); + + app = await client.CreatePointOfSaleApp(acc.StoreId, new CreatePointOfSaleAppRequest() + { + AppName = "Cart", + DefaultView = Client.Models.PosViewType.Cart, + Template = new PointOfSaleSettings().Template + }); + resp = await posController.ViewPointOfSale(app.Id, posData: new JObject() + { + ["cart"] = new JArray() + { + new JObject() + { + ["id"] = "green-tea", + ["count"] = 2 + }, + new JObject() + { + ["id"] = "black-tea", + ["count"] = 1 + }, + } + }.ToString()); + invoiceId = GetInvoiceId(resp); + await acc.PayOnBOLT11(invoiceId); + + resp = await posController.ViewPointOfSale(app.Id, posData: new JObject() + { + ["cart"] = new JArray() + { + new JObject() + { + ["id"] = "green-tea", + ["count"] = 5 + } + } + }.ToString()); + invoiceId = GetInvoiceId(resp); + await acc.PayOnLNUrl(invoiceId); + + await acc.CreateLNAddress(); + await acc.PayOnLNAddress(); + + var report = await GetReport(acc, new() { ViewName = "Payments" }); + // 1 payment on LN Address + // 1 payment on LNURL + // 1 payment on BOLT11 + // 1 payment on chain + Assert.Equal(4, report.Data.Count); + var lnAddressIndex = report.GetIndex("LightningAddress"); + var paymentTypeIndex = report.GetIndex("PaymentType"); + Assert.Contains(report.Data, d => d[lnAddressIndex]?.Value()?.Contains(acc.LNAddress) is true); + var paymentTypes = report.Data + .GroupBy(d => d[paymentTypeIndex].Value()) + .ToDictionary(d => d.Key); + Assert.Equal(3, paymentTypes["Lightning"].Count()); + Assert.Single(paymentTypes["On-Chain"]); + + // 2 on-chain transactions: It received from the cashcow, then paid its own invoice + report = await GetReport(acc, new() { ViewName = "On-Chain Wallets" }); + var txIdIndex = report.GetIndex("TransactionId"); + var balanceIndex = report.GetIndex("BalanceChange"); + Assert.Equal(2, report.Data.Count); + Assert.Equal(64, report.Data[0][txIdIndex].Value().Length); + Assert.Contains(report.Data, d => d[balanceIndex].Value() == 1.0m); + + // Items sold + report = await GetReport(acc, new() { ViewName = "Products sold" }); + var itemIndex = report.GetIndex("Product"); + var countIndex = report.GetIndex("Quantity"); + var itemsCount = report.Data.GroupBy(d => d[itemIndex].Value()) + .ToDictionary(d => d.Key, r => r.Sum(d => d[countIndex].Value())); + Assert.Equal(8, itemsCount["green-tea"]); + Assert.Equal(1, itemsCount["black-tea"]); + } + + private async Task GetReport(TestAccount acc, StoreReportRequest req) + { + var controller = acc.GetController(); + return (await controller.StoreReportsJson(acc.StoreId, req)).AssertType() + .Value + .AssertType(); + } + + private static string GetInvoiceId(IActionResult resp) + { + var redirect = resp.AssertType(); + Assert.Equal("Checkout", redirect.ActionName); + return (string)redirect.RouteValues["invoiceId"]; + } } } diff --git a/BTCPayServer/BTCPayServer.csproj b/BTCPayServer/BTCPayServer.csproj index cb9cd045c..7766e5156 100644 --- a/BTCPayServer/BTCPayServer.csproj +++ b/BTCPayServer/BTCPayServer.csproj @@ -81,6 +81,7 @@ + @@ -119,6 +120,7 @@ + @@ -135,7 +137,9 @@ + + PreserveNewest $(IncludeRazorContentInPack) diff --git a/BTCPayServer/Components/MainNav/Default.cshtml b/BTCPayServer/Components/MainNav/Default.cshtml index fde0c8720..a531533e8 100644 --- a/BTCPayServer/Components/MainNav/Default.cshtml +++ b/BTCPayServer/Components/MainNav/Default.cshtml @@ -131,6 +131,12 @@ Invoices +
  • + + + Reporting + +
  • diff --git a/BTCPayServer/Controllers/GreenField/GreenfieldReportsController.cs b/BTCPayServer/Controllers/GreenField/GreenfieldReportsController.cs new file mode 100644 index 000000000..bb4faa409 --- /dev/null +++ b/BTCPayServer/Controllers/GreenField/GreenfieldReportsController.cs @@ -0,0 +1,80 @@ +#nullable enable +using BTCPayServer.Lightning; +using BTCPayServer.Models.StoreViewModels; +using BTCPayServer.Services.Invoices; +using System.Collections.Generic; +using System.Threading.Tasks; +using System; +using Microsoft.AspNetCore.Cors; +using Microsoft.AspNetCore.Mvc; +using Microsoft.EntityFrameworkCore.Internal; +using NBitcoin; +using Newtonsoft.Json.Linq; +using BTCPayServer.Data; +using Microsoft.EntityFrameworkCore; +using Dapper; +using Microsoft.AspNetCore.Authorization; +using BTCPayServer.Abstractions.Constants; +using BTCPayServer.Client; +using BTCPayServer.Abstractions.Extensions; +using BTCPayServer.Client.Models; +using BTCPayServer.Services; +using System.Linq; +using System.Threading; + +namespace BTCPayServer.Controllers.GreenField; + +[ApiController] +[Authorize(AuthenticationSchemes = AuthenticationSchemes.Greenfield)] +[EnableCors(CorsPolicies.All)] +public class GreenfieldReportsController : Controller +{ + public GreenfieldReportsController( + ApplicationDbContextFactory dbContextFactory, + ReportService reportService) + { + DBContextFactory = dbContextFactory; + ReportService = reportService; + } + public ApplicationDbContextFactory DBContextFactory { get; } + public ReportService ReportService { get; } + + + [Authorize(Policy = Policies.CanViewStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Greenfield)] + [HttpPost("~/api/v1/stores/{storeId}/reports")] + [NonAction] // Disabling this endpoint as we still need to figure out the request/response model + public async Task StoreReports(string storeId, [FromBody] StoreReportRequest? vm = null, CancellationToken cancellationToken = default) + { + vm ??= new StoreReportRequest(); + vm.ViewName ??= "Payments"; + vm.TimePeriod ??= new TimePeriod(); + vm.TimePeriod.To ??= DateTime.UtcNow; + vm.TimePeriod.From ??= vm.TimePeriod.To.Value.AddMonths(-1); + var from = vm.TimePeriod.From.Value; + var to = vm.TimePeriod.To.Value; + + if (ReportService.ReportProviders.TryGetValue(vm.ViewName, out var report)) + { + if (!report.IsAvailable()) + return this.CreateAPIError(503, "view-unavailable", $"This view is unavailable at this moment"); + + var ctx = new Services.Reporting.QueryContext(storeId, from, to); + await report.Query(ctx, cancellationToken); + var result = new StoreReportResponse() + { + Fields = ctx.ViewDefinition?.Fields ?? new List(), + Charts = ctx.ViewDefinition?.Charts ?? new List(), + Data = ctx.Data.Select(d => new JArray(d)).ToList(), + From = from, + To = to + }; + return Json(result); + } + else + { + ModelState.AddModelError(nameof(vm.ViewName), "View doesn't exist"); + return this.CreateValidationError(ModelState); + } + } +} + diff --git a/BTCPayServer/Controllers/UIReportsController.CheatMode.cs b/BTCPayServer/Controllers/UIReportsController.CheatMode.cs new file mode 100644 index 000000000..786f7409a --- /dev/null +++ b/BTCPayServer/Controllers/UIReportsController.CheatMode.cs @@ -0,0 +1,122 @@ +#nullable enable +using System; +using Dapper; +using System.Linq; +using System.Threading.Tasks; +using BTCPayServer.Abstractions.Constants; +using BTCPayServer.Client; +using BTCPayServer.Client.Models; +using BTCPayServer.Controllers.GreenField; +using BTCPayServer.Data; +using BTCPayServer.Filters; +using BTCPayServer.Models.StoreReportsViewModels; +using BTCPayServer.Models.StoreViewModels; +using BTCPayServer.Services; +using Microsoft.AspNetCore.Authorization; +using Microsoft.AspNetCore.Mvc; +using Microsoft.EntityFrameworkCore; +using Microsoft.EntityFrameworkCore.Internal; +using System.Text.Json.Nodes; +using Org.BouncyCastle.Ocsp; +using System.Threading; +using System.Collections.Generic; +using Newtonsoft.Json.Linq; +using NBitcoin.DataEncoders; +using System.Net; + +namespace BTCPayServer.Controllers; + +public partial class UIReportsController +{ + private IList> Generate(IList fields) + { + var rand = new Random(); + int rowCount = 1_000; + List row = new List(); + List> result = new List>(); + for (int i = 0; i < rowCount; i++) + { + int fi = 0; + foreach (var f in fields) + { + row.Add(GenerateData(fields, f, fi, row, rand)); + fi++; + } + result.Add(row); + row = new List(); + } + return result; + } + + private object? GenerateData(IList fields, StoreReportResponse.Field f, int fi, List row, Random rand) + { + byte[] GenerateBytes(int count) + { + var bytes = new byte[count]; + rand.NextBytes(bytes); + return bytes; + } + T TakeOne(params T[] v) + { + return v[rand.NextInt64(0, v.Length)]; + } + decimal GenerateDecimal(decimal from, decimal to, int precision) + { + decimal range = to - from; + decimal randomValue = ((decimal)rand.NextDouble() * range) + from; + return decimal.Round(randomValue, precision); + } + if (f.Type == "invoice_id") + return Encoders.Base58.EncodeData(GenerateBytes(20)); + if (f.Type == "boolean") + return GenerateBytes(1)[0] % 2 == 0; + if (f.Name == "PaymentType") + return TakeOne("On-Chain", "Lightning"); + if (f.Name == "PaymentId") + if (row[fi -1] is "On-Chain") + return Encoders.Hex.EncodeData(GenerateBytes(32)) + "-" + rand.NextInt64(0, 4); + else + return Encoders.Hex.EncodeData(GenerateBytes(32)); + if (f.Name == "Address") + return Encoders.Bech32("bc1").Encode(0, GenerateBytes(20)); + if (f.Name == "Crypto") + return rand.NextSingle() > 0.2 ? "BTC" : TakeOne("LTC", "DOGE", "DASH"); + if (f.Name == "CryptoAmount") + return GenerateDecimal(0.1m, 5m, 8); + if (f.Name == "LightningAddress") + return TakeOne("satoshi", "satosan", "satoichi") + "@bitcoin.org"; + if (f.Name == "BalanceChange") + return GenerateDecimal(-5.0m, 5.0m, 8); + if (f.Type == "datetime") + return DateTimeOffset.UtcNow - TimeSpan.FromHours(rand.Next(0, 24 * 30 * 6)) - TimeSpan.FromMinutes(rand.Next(0, 60)); + if (f.Name == "Product") + return TakeOne("green-tea", "black-tea", "oolong-tea", "coca-cola"); + if (f.Name == "State") + return TakeOne("Settled", "Processing"); + if (f.Name == "AppId") + return TakeOne("AppA", "AppB"); + if (f.Name == "Quantity") + return TakeOne(1, 2, 3, 4, 5); + if (f.Name == "Currency") + return rand.NextSingle() > 0.2 ? "USD" : TakeOne("JPY", "EUR", "CHF"); + if (f.Name == "CurrencyAmount") + return row[fi - 1] switch + { + "USD" or "EUR" or "CHF" => GenerateDecimal(100.0m, 10_000m, 2), + "JPY" => GenerateDecimal(10_000m, 1000_0000, 0), + _ => GenerateDecimal(100.0m, 10_000m, 2) + }; + if (f.Type == "tx_id") + return Encoders.Hex.EncodeData(GenerateBytes(32)); + if (f.Name == "Rate") + { + return row[fi - 1] switch + { + "USD" or "EUR" or "CHF" => GenerateDecimal(30_000m, 60_000, 2), + "JPY" => GenerateDecimal(400_0000m, 1000_0000m, 0), + _ => GenerateDecimal(30_000m, 60_000, 2) + }; + } + return null; + } +} diff --git a/BTCPayServer/Controllers/UIReportsController.cs b/BTCPayServer/Controllers/UIReportsController.cs new file mode 100644 index 000000000..8af27e60a --- /dev/null +++ b/BTCPayServer/Controllers/UIReportsController.cs @@ -0,0 +1,91 @@ +#nullable enable +using System; +using Dapper; +using System.Linq; +using System.Threading.Tasks; +using BTCPayServer.Abstractions.Constants; +using BTCPayServer.Client; +using BTCPayServer.Client.Models; +using BTCPayServer.Controllers.GreenField; +using BTCPayServer.Data; +using BTCPayServer.Filters; +using BTCPayServer.Models.StoreReportsViewModels; +using BTCPayServer.Models.StoreViewModels; +using BTCPayServer.Services; +using Microsoft.AspNetCore.Authorization; +using Microsoft.AspNetCore.Mvc; +using Microsoft.EntityFrameworkCore; +using Microsoft.EntityFrameworkCore.Internal; +using System.Text.Json.Nodes; +using Org.BouncyCastle.Ocsp; +using System.Threading; +using System.Collections.Generic; +using Newtonsoft.Json.Linq; +using NBitcoin.DataEncoders; + + +namespace BTCPayServer.Controllers; + +[Authorize(Policy = Policies.CanViewStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] +[AutoValidateAntiforgeryToken] +public partial class UIReportsController : Controller +{ + public UIReportsController( + BTCPayNetworkProvider networkProvider, + ApplicationDbContextFactory dbContextFactory, + GreenfieldReportsController api, + ReportService reportService, + BTCPayServerEnvironment env + ) + { + Api = api; + ReportService = reportService; + Env = env; + DBContextFactory = dbContextFactory; + NetworkProvider = networkProvider; + } + private BTCPayNetworkProvider NetworkProvider { get; } + public GreenfieldReportsController Api { get; } + public ReportService ReportService { get; } + public BTCPayServerEnvironment Env { get; } + public ApplicationDbContextFactory DBContextFactory { get; } + + [HttpPost("stores/{storeId}/reports")] + [AcceptMediaTypeConstraint("application/json")] + [Authorize(Policy = Policies.CanViewStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] + [IgnoreAntiforgeryToken] + public async Task StoreReportsJson(string storeId, [FromBody] StoreReportRequest? request = null, bool fakeData = false, CancellationToken cancellation = default) + { + var result = await Api.StoreReports(storeId, request, cancellation); + if (fakeData && Env.CheatMode) + { + var r = (StoreReportResponse)((JsonResult)result!).Value!; + r.Data = Generate(r.Fields).Select(r => new JArray(r)).ToList(); + } + return result; + } + + [HttpGet("stores/{storeId}/reports")] + [AcceptMediaTypeConstraint("text/html")] + [Authorize(Policy = Policies.CanViewStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] + public IActionResult StoreReports( + string storeId, + string ? viewName = null) + { + var vm = new StoreReportsViewModel() + { + InvoiceTemplateUrl = this.Url.Action(nameof(UIInvoiceController.Invoice), "UIInvoice", new { invoiceId = "INVOICE_ID" }), + ExplorerTemplateUrls = NetworkProvider.GetAll().ToDictionary(network => network.CryptoCode, network => network.BlockExplorerLink?.Replace("{0}", "TX_ID")), + Request = new StoreReportRequest() + { + ViewName = viewName ?? "Payments" + } + }; + vm.AvailableViews = ReportService.ReportProviders + .Values + .Where(r => r.IsAvailable()) + .Select(k => k.Name) + .OrderBy(k => k).ToList(); + return View(vm); + } +} diff --git a/BTCPayServer/Extensions.cs b/BTCPayServer/Extensions.cs index e5050a9ad..311207311 100644 --- a/BTCPayServer/Extensions.cs +++ b/BTCPayServer/Extensions.cs @@ -22,6 +22,7 @@ using BTCPayServer.Payments; using BTCPayServer.Payments.Bitcoin; using BTCPayServer.Security; using BTCPayServer.Services.Invoices; +using BTCPayServer.Services.Reporting; using BTCPayServer.Services.Wallets; using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Mvc; @@ -134,6 +135,14 @@ namespace BTCPayServer } } + public static IServiceCollection AddReportProvider(this IServiceCollection services) + where T : ReportProvider + { + services.AddSingleton(); + services.AddSingleton(); + return services; + } + public static IServiceCollection AddScheduledTask(this IServiceCollection services, TimeSpan every) where T : class, IPeriodicTask { diff --git a/BTCPayServer/Extensions/StoreExtensions.cs b/BTCPayServer/Extensions/StoreExtensions.cs index 285273846..67862acb0 100644 --- a/BTCPayServer/Extensions/StoreExtensions.cs +++ b/BTCPayServer/Extensions/StoreExtensions.cs @@ -1,4 +1,5 @@ #nullable enable +using System.Collections.Generic; using System.Linq; using BTCPayServer.Client; using BTCPayServer.Data; @@ -43,5 +44,13 @@ namespace BTCPayServer .FirstOrDefault(p => p.PaymentId.PaymentType == Payments.PaymentTypes.BTCLike && p.PaymentId.CryptoCode == cryptoCode); return paymentMethod; } + public static IEnumerable GetDerivationSchemeSettings(this StoreData store, BTCPayNetworkProvider networkProvider) + { + var paymentMethod = store + .GetSupportedPaymentMethods(networkProvider) + .OfType() + .Where(p => p.PaymentId.PaymentType == Payments.PaymentTypes.BTCLike); + return paymentMethod; + } } } diff --git a/BTCPayServer/Hosting/BTCPayServerServices.cs b/BTCPayServer/Hosting/BTCPayServerServices.cs index f3112e32a..9ae22df4a 100644 --- a/BTCPayServer/Hosting/BTCPayServerServices.cs +++ b/BTCPayServer/Hosting/BTCPayServerServices.cs @@ -65,6 +65,7 @@ using NBXplorer.DerivationStrategy; using Newtonsoft.Json; using NicolasDorier.RateLimits; using Serilog; +using BTCPayServer.Services.Reporting; #if ALTCOINS using BTCPayServer.Services.Altcoins.Monero; using BTCPayServer.Services.Altcoins.Zcash; @@ -325,6 +326,7 @@ namespace BTCPayServer.Hosting services.TryAddSingleton(); services.TryAddSingleton(); + services.TryAddSingleton(); services.TryAddSingleton(); services.AddSingleton(); services.TryAddSingleton(); @@ -354,6 +356,10 @@ namespace BTCPayServer.Hosting services.AddSingleton(); services.AddScheduledTask(TimeSpan.FromHours(6.0)); + services.AddReportProvider(); + services.AddReportProvider(); + services.AddReportProvider(); + services.AddHttpClient(WebhookSender.OnionNamedClient) .ConfigurePrimaryHttpMessageHandler(); services.AddHttpClient(WebhookSender.LoopbackNamedClient) diff --git a/BTCPayServer/Models/StoreReportsViewModels/StoreReportsViewModel.cs b/BTCPayServer/Models/StoreReportsViewModels/StoreReportsViewModel.cs new file mode 100644 index 000000000..d4e80db27 --- /dev/null +++ b/BTCPayServer/Models/StoreReportsViewModels/StoreReportsViewModel.cs @@ -0,0 +1,16 @@ +using System; +using System.Collections.Generic; +using BTCPayServer.Client.Models; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; + +namespace BTCPayServer.Models.StoreReportsViewModels; + +public class StoreReportsViewModel +{ + public string InvoiceTemplateUrl { get; set; } + public Dictionary ExplorerTemplateUrls { get; set; } + public StoreReportRequest Request { get; set; } + public List AvailableViews { get; set; } + public StoreReportResponse Result { get; set; } +} diff --git a/BTCPayServer/Services/Invoices/InvoiceRepository.cs b/BTCPayServer/Services/Invoices/InvoiceRepository.cs index 4c82d2ae1..ce583926f 100644 --- a/BTCPayServer/Services/Invoices/InvoiceRepository.cs +++ b/BTCPayServer/Services/Invoices/InvoiceRepository.cs @@ -721,8 +721,11 @@ namespace BTCPayServer.Services.Invoices query = query.Take(queryObject.Take.Value); return query; } - - public async Task GetInvoices(InvoiceQuery queryObject) + public Task GetInvoices(InvoiceQuery queryObject) + { + return GetInvoices(queryObject, default); + } + public async Task GetInvoices(InvoiceQuery queryObject, CancellationToken cancellationToken) { await using var context = _applicationDbContextFactory.CreateContext(); var query = GetInvoiceQuery(context, queryObject); @@ -733,7 +736,7 @@ namespace BTCPayServer.Services.Invoices query = query.Include(o => o.Events); if (queryObject.IncludeRefunds) query = query.Include(o => o.Refunds).ThenInclude(refundData => refundData.PullPaymentData); - var data = await query.ToArrayAsync().ConfigureAwait(false); + var data = await query.ToArrayAsync(cancellationToken).ConfigureAwait(false); return data.Select(ToEntity).ToArray(); } diff --git a/BTCPayServer/Services/ReportService.cs b/BTCPayServer/Services/ReportService.cs new file mode 100644 index 000000000..d20108209 --- /dev/null +++ b/BTCPayServer/Services/ReportService.cs @@ -0,0 +1,20 @@ +using System.Collections.Generic; +using System.Linq; +using BTCPayServer.Client.Models; +using BTCPayServer.Services.Reporting; + +namespace BTCPayServer.Services +{ + public class ReportService + { + public ReportService(IEnumerable reportProviders) + { + foreach (var r in reportProviders) + { + ReportProviders.Add(r.Name, r); + } + } + + public Dictionary ReportProviders { get; } = new Dictionary(); + } +} diff --git a/BTCPayServer/Services/Reporting/OnChainWalletReportProvider.cs b/BTCPayServer/Services/Reporting/OnChainWalletReportProvider.cs new file mode 100644 index 000000000..2827e10ea --- /dev/null +++ b/BTCPayServer/Services/Reporting/OnChainWalletReportProvider.cs @@ -0,0 +1,122 @@ +#nullable enable +using System; +using System.Linq; +using System.Threading; +using System.Threading.Tasks; +using BTCPayServer.Data; +using BTCPayServer.Services.Stores; +using BTCPayServer.Services.Wallets; +using Dapper; +using Microsoft.EntityFrameworkCore; +using NBitcoin; +using NBXplorer.DerivationStrategy; +using static Microsoft.EntityFrameworkCore.DbLoggerCategory.Database; + +namespace BTCPayServer.Services.Reporting; + +public class OnChainWalletReportProvider : ReportProvider +{ + public OnChainWalletReportProvider( + NBXplorerConnectionFactory NbxplorerConnectionFactory, + StoreRepository storeRepository, + BTCPayNetworkProvider networkProvider, + WalletRepository walletRepository) + { + this.NbxplorerConnectionFactory = NbxplorerConnectionFactory; + StoreRepository = storeRepository; + NetworkProvider = networkProvider; + WalletRepository = walletRepository; + } + public NBXplorerConnectionFactory NbxplorerConnectionFactory { get; } + public StoreRepository StoreRepository { get; } + public BTCPayNetworkProvider NetworkProvider { get; } + public WalletRepository WalletRepository { get; } + public override string Name => "On-Chain Wallets"; + ViewDefinition CreateViewDefinition() + { + return + new() + { + Fields = + { + new ("Date", "datetime"), + new ("Crypto", "string"), + // For proper rendering of explorer links, Crypto should always be before tx_id + new ("TransactionId", "tx_id"), + new ("InvoiceId", "invoice_id"), + new ("Confirmed", "boolean"), + new ("BalanceChange", "decimal") + }, + Charts = + { + new () + { + Name = "Group by Crypto", + Totals = { "Crypto" }, + Groups = { "Crypto", "Confirmed" }, + Aggregates = { "BalanceChange" } + } + } + }; + } + + public override bool IsAvailable() + { + return this.NbxplorerConnectionFactory.Available; + } + + public override async Task Query(QueryContext queryContext, CancellationToken cancellation) + { + queryContext.ViewDefinition = CreateViewDefinition(); + await using var conn = await NbxplorerConnectionFactory.OpenConnection(); + var store = await StoreRepository.FindStore(queryContext.StoreId); + if (store is null) + return; + var interval = DateTimeOffset.UtcNow - queryContext.From; + foreach (var settings in store.GetDerivationSchemeSettings(NetworkProvider)) + { + var walletId = new WalletId(store.Id, settings.Network.CryptoCode); + var command = new CommandDefinition( + commandText: + "SELECT r.tx_id, r.seen_at, t.blk_id, t.blk_height, r.balance_change " + + "FROM get_wallets_recent(@wallet_id, @code, @interval, NULL, NULL) r " + + "JOIN txs t USING (code, tx_id) " + + "ORDER BY r.seen_at", + parameters: new + { + wallet_id = NBXplorer.Client.DBUtils.nbxv1_get_wallet_id(settings.Network.CryptoCode, settings.AccountDerivation.ToString()), + code = settings.Network.CryptoCode, + interval = interval + }, + cancellationToken: cancellation); + + var rows = await conn.QueryAsync(command); + foreach (var r in rows) + { + var date = (DateTimeOffset)r.seen_at; + if (date > queryContext.To) + continue; + var values = queryContext.AddData(); + values.Add((DateTimeOffset)date); + values.Add(settings.Network.CryptoCode); + values.Add((string)r.tx_id); + values.Add(null); + values.Add((long?)r.blk_height is not null); + values.Add(Money.Satoshis((long)r.balance_change).ToDecimal(MoneyUnit.BTC)); + } + var objects = await WalletRepository.GetWalletObjects(new GetWalletObjectsQuery() + { + Ids = queryContext.Data.Select(d => (string)d[2]).ToArray(), + WalletId = walletId, + Type = "tx" + }); + foreach (var row in queryContext.Data) + { + if (!objects.TryGetValue(new WalletObjectId(walletId, "tx", (string)row[2]), out var txObject)) + continue; + var invoiceId = txObject.GetLinks().Where(t => t.type == "invoice").Select(t => t.id).FirstOrDefault(); + row[3] = invoiceId; + } + } + } +} diff --git a/BTCPayServer/Services/Reporting/PaymentsReportProvider.cs b/BTCPayServer/Services/Reporting/PaymentsReportProvider.cs new file mode 100644 index 000000000..141a22941 --- /dev/null +++ b/BTCPayServer/Services/Reporting/PaymentsReportProvider.cs @@ -0,0 +1,187 @@ +using System; +using System.Collections.Generic; +using System.Data.Common; +using System.Threading; +using System.Threading.Tasks; +using BTCPayServer.Client.Models; +using BTCPayServer.Data; +using BTCPayServer.Lightning; +using BTCPayServer.Lightning.LND; +using BTCPayServer.Payments; +using BTCPayServer.Rating; +using BTCPayServer.Services.Invoices; +using BTCPayServer.Services.Rates; +using Dapper; +using Microsoft.EntityFrameworkCore; +using Microsoft.EntityFrameworkCore.Internal; +using NBitcoin; +using NBitpayClient; +using Newtonsoft.Json.Linq; +using static BTCPayServer.HostedServices.PullPaymentHostedService.PayoutApproval; + +namespace BTCPayServer.Services.Reporting; + +public class PaymentsReportProvider : ReportProvider +{ + + public PaymentsReportProvider(ApplicationDbContextFactory dbContextFactory, CurrencyNameTable currencyNameTable) + { + DbContextFactory = dbContextFactory; + CurrencyNameTable = currencyNameTable; + } + public override string Name => "Payments"; + public ApplicationDbContextFactory DbContextFactory { get; } + public CurrencyNameTable CurrencyNameTable { get; } + + ViewDefinition CreateViewDefinition() + { + return + new() + { + Fields = + { + new ("Date", "datetime"), + new ("InvoiceId", "invoice_id"), + new ("OrderId", "string"), + new ("PaymentType", "string"), + new ("PaymentId", "string"), + new ("Confirmed", "boolean"), + new ("Address", "string"), + new ("Crypto", "string"), + new ("CryptoAmount", "decimal"), + new ("NetworkFee", "decimal"), + new ("LightningAddress", "string"), + new ("Currency", "string"), + new ("CurrencyAmount", "decimal"), + new ("Rate", "decimal") + }, + Charts = + { + new () + { + Name = "Aggregated crypto amount", + Groups = { "Crypto", "PaymentType" }, + Totals = { "Crypto" }, + HasGrandTotal = false, + Aggregates = { "CryptoAmount" } + }, + new () + { + Name = "Aggregated currency amount", + Groups = { "Currency" }, + Totals = { "Currency" }, + HasGrandTotal = false, + Aggregates = { "CurrencyAmount" } + }, + new () + { + Name = "Group by Lightning Address (Currency amount)", + Filters = { "typeof this.LightningAddress === 'string' && this.Crypto == \"BTC\"" }, + Groups = { "LightningAddress", "Currency" }, + Aggregates = { "CurrencyAmount" }, + HasGrandTotal = true + }, + new () + { + Name = "Group by Lightning Address (Crypto amount)", + Filters = { "typeof this.LightningAddress === 'string' && this.Crypto == \"BTC\"" }, + Groups = { "LightningAddress" }, + Aggregates = { "CryptoAmount" }, + HasGrandTotal = true + } + } + }; + } + + + public override async Task Query(QueryContext queryContext, CancellationToken cancellation) + { + queryContext.ViewDefinition = CreateViewDefinition(); + await using var ctx = DbContextFactory.CreateContext(); + var conn = ctx.Database.GetDbConnection(); + string[] fields = new[] + { + $"i.\"Created\" created", + "i.\"Id\" invoice_id", + "i.\"OrderId\" order_id", + "p.\"Id\" payment_id", + "p.\"Type\" payment_type", + "i.\"Blob2\" invoice_blob", + "p.\"Blob2\" payment_blob", + }; + string select = "SELECT " + String.Join(", ", fields) + " "; + string body = + "FROM \"Payments\" p " + + "JOIN \"Invoices\" i ON i.\"Id\" = p.\"InvoiceDataId\" " + + $"WHERE p.\"Accounted\" IS TRUE AND i.\"Created\" >= @from AND i.\"Created\" < @to AND i.\"StoreDataId\"=@storeId " + + "ORDER BY i.\"Created\""; + var command = new CommandDefinition( + commandText: select + body, + parameters: new + { + storeId = queryContext.StoreId, + from = queryContext.From, + to = queryContext.To + }, + cancellationToken: cancellation); + var rows = await conn.QueryAsync(command); + foreach (var r in rows) + { + var values = queryContext.CreateData(); + values.Add((DateTime)r.created); + values.Add((string)r.invoice_id); + values.Add((string)r.order_id); + if (PaymentMethodId.TryParse((string)r.payment_type, out var paymentType)) + { + if (paymentType.PaymentType == PaymentTypes.LightningLike || paymentType.PaymentType == PaymentTypes.LNURLPay) + values.Add("Lightning"); + else if (paymentType.PaymentType == PaymentTypes.BTCLike) + values.Add("On-Chain"); + else + values.Add(paymentType.ToStringNormalized()); + } + else + continue; + values.Add((string)r.payment_id); + var invoiceBlob = JObject.Parse((string)r.invoice_blob); + var paymentBlob = JObject.Parse((string)r.payment_blob); + + + var data = JObject.Parse(paymentBlob.SelectToken("$.cryptoPaymentData")?.Value()!); + var conf = data.SelectToken("$.confirmationCount")?.Value(); + values.Add(conf is int o ? o > 0 : + paymentType.PaymentType != PaymentTypes.BTCLike ? true : null); + values.Add(data.SelectToken("$.address")?.Value()); + values.Add(paymentType.CryptoCode); + + decimal cryptoAmount; + if (data.SelectToken("$.amount")?.Value() is long v) + { + cryptoAmount = LightMoney.MilliSatoshis(v).ToDecimal(LightMoneyUnit.BTC); + } + else if (data.SelectToken("$.value")?.Value() is long amount) + { + cryptoAmount = Money.Satoshis(amount).ToDecimal(MoneyUnit.BTC); + } + else + { + continue; + } + values.Add(cryptoAmount); + values.Add(paymentBlob.SelectToken("$.networkFee", false)?.Value()); + values.Add(invoiceBlob.SelectToken("$.cryptoData.BTC_LNURLPAY.paymentMethod.ConsumedLightningAddress", false)?.Value()); + var currency = invoiceBlob.SelectToken("$.currency")?.Value(); + values.Add(currency); + + values.Add(null); // Currency amount + var rate = invoiceBlob.SelectToken($"$.cryptoData.{paymentType}.rate")?.Value(); + values.Add(rate); + if (rate is not null) + { + values[^2] = (rate.Value * cryptoAmount).RoundToSignificant(CurrencyNameTable.GetCurrencyData(currency ?? "USD", true).Divisibility); + } + + queryContext.Data.Add(values); + } + } +} diff --git a/BTCPayServer/Services/Reporting/ProductsReportProvider.cs b/BTCPayServer/Services/Reporting/ProductsReportProvider.cs new file mode 100644 index 000000000..72988b180 --- /dev/null +++ b/BTCPayServer/Services/Reporting/ProductsReportProvider.cs @@ -0,0 +1,131 @@ +using System; +using System.Linq; +using System.Threading; +using System.Threading.Tasks; +using BTCPayServer.Data; +using BTCPayServer.Rating; +using BTCPayServer.Services.Apps; +using BTCPayServer.Services.Invoices; +using BTCPayServer.Services.Rates; +using Dapper; +using Microsoft.EntityFrameworkCore; +using Microsoft.EntityFrameworkCore.Infrastructure; +using Microsoft.EntityFrameworkCore.Internal; +using Newtonsoft.Json; +using Org.BouncyCastle.Crypto.Signers; + +namespace BTCPayServer.Services.Reporting; + +public class ProductsReportProvider : ReportProvider +{ + public ProductsReportProvider(InvoiceRepository invoiceRepository, CurrencyNameTable currencyNameTable, AppService apps) + { + InvoiceRepository = invoiceRepository; + CurrencyNameTable = currencyNameTable; + Apps = apps; + } + + public InvoiceRepository InvoiceRepository { get; } + public CurrencyNameTable CurrencyNameTable { get; } + public AppService Apps { get; } + + public override string Name => "Products sold"; + + public override async Task Query(QueryContext queryContext, CancellationToken cancellation) + { + var appsById = (await Apps.GetApps(queryContext.StoreId)).ToDictionary(o => o.Id); + var tagAllinvoicesApps = appsById.Values.Where(a => a.TagAllInvoices).ToList(); + queryContext.ViewDefinition = CreateDefinition(); + foreach (var i in (await InvoiceRepository.GetInvoices(new InvoiceQuery() + { + IncludeArchived = true, + IncludeAddresses = false, + IncludeEvents = false, + IncludeRefunds = false, + StartDate = queryContext.From, + EndDate = queryContext.To, + StoreId = new[] { queryContext.StoreId } + }, cancellation)).OrderBy(c => c.InvoiceTime)) + { + var values = queryContext.CreateData(); + values.Add(i.InvoiceTime); + values.Add(i.Id); + var status = i.Status.ToModernStatus(); + if (status == Client.Models.InvoiceStatus.Expired && i.ExceptionStatus == Client.Models.InvoiceExceptionStatus.None) + continue; + values.Add(status.ToString()); + + // There are two ways an invoice belong to a particular app. + // 1. The invoice is internally tagged with the app id + // 2. The app is a tag all invoices app + // In both cases, we want to include the invoice in the report + var appIds = tagAllinvoicesApps.Select(a => a.Id); + var taggedAppId = AppService.GetAppInternalTags(i)?.FirstOrDefault(); + if (taggedAppId is string) + appIds = appIds.Concat(new[] { taggedAppId }).Distinct().ToArray(); + + foreach (var appId in appIds) + { + values = values.ToList(); + values.Add(appId); + if (i.Metadata?.ItemCode is string code) + { + values.Add(code); + values.Add(1); + values.Add(i.Currency); + values.Add(i.Price); + queryContext.Data.Add(values); + } + else + { + var posData = i.Metadata.PosData?.ToObject(); + if (posData.Cart is { } cart) + { + foreach (var item in cart) + { + var copy = values.ToList(); + copy.Add(item.Id); + copy.Add(item.Count); + copy.Add(i.Currency); + copy.Add(item.Price * item.Count); + queryContext.Data.Add(copy); + } + } + } + } + } + // Round the currency amount + foreach (var r in queryContext.Data) + { + r[^1] = ((decimal)r[^1]).RoundToSignificant(CurrencyNameTable.GetCurrencyData((string)r[^2] ?? "USD", true).Divisibility); + } + } + + private ViewDefinition CreateDefinition() + { + return new ViewDefinition() + { + Fields = + { + new ("Date", "datetime"), + new ("InvoiceId", "invoice_id"), + new ("State", "string"), + new ("AppId", "string"), + new ("Product", "string"), + new ("Quantity", "decimal"), + new ("Currency", "string"), + new ("CurrencyAmount", "decimal") + }, + Charts = + { + new () + { + Name = "Summary by products", + Groups = { "AppId", "Currency", "State", "Product" }, + Aggregates = { "Quantity", "CurrencyAmount" }, + Totals = { "State" } + } + } + }; + } +} diff --git a/BTCPayServer/Services/Reporting/QueryContext.cs b/BTCPayServer/Services/Reporting/QueryContext.cs new file mode 100644 index 000000000..4f0955531 --- /dev/null +++ b/BTCPayServer/Services/Reporting/QueryContext.cs @@ -0,0 +1,34 @@ +using System; +using System.Collections; +using System.Collections.Generic; + +namespace BTCPayServer.Services.Reporting +{ + public record QueryContext + { + public QueryContext(string storeId, DateTimeOffset from, DateTimeOffset to) + { + StoreId = storeId; + From = from; + To = to; + } + public string StoreId { get; } + public DateTimeOffset From { get; } + public DateTimeOffset To { get; } + public ViewDefinition? ViewDefinition { get; set; } + + public IList AddData() + { + var l = CreateData(); + Data.Add(l); + return l; + } + + public IList CreateData() + { + return new List(ViewDefinition.Fields.Count); + } + + public IList> Data { get; set; } = new List>(); + } +} diff --git a/BTCPayServer/Services/Reporting/ReportProvider.cs b/BTCPayServer/Services/Reporting/ReportProvider.cs new file mode 100644 index 000000000..0a7e49dcf --- /dev/null +++ b/BTCPayServer/Services/Reporting/ReportProvider.cs @@ -0,0 +1,19 @@ +#nullable enable +using System.Threading.Tasks; +using System.Threading; +using BTCPayServer.Data; +using System; +using System.Linq; + +namespace BTCPayServer.Services.Reporting +{ + public abstract class ReportProvider + { + public virtual bool IsAvailable() + { + return true; + } + public abstract string Name { get; } + public abstract Task Query(QueryContext queryContext, CancellationToken cancellation); + } +} diff --git a/BTCPayServer/Services/Reporting/ViewDefinition.cs b/BTCPayServer/Services/Reporting/ViewDefinition.cs new file mode 100644 index 000000000..1380b1422 --- /dev/null +++ b/BTCPayServer/Services/Reporting/ViewDefinition.cs @@ -0,0 +1,16 @@ +using System.Collections.Generic; +using BTCPayServer.Client.Models; + +namespace BTCPayServer.Services.Reporting +{ + public class ViewDefinition + { + public IList Fields + { + get; + set; + } = new List(); + + public List Charts { get; set; } = new List(); + } +} diff --git a/BTCPayServer/TagHelpers/CheatModeTagHelper.cs b/BTCPayServer/TagHelpers/CheatModeTagHelper.cs new file mode 100644 index 000000000..147371780 --- /dev/null +++ b/BTCPayServer/TagHelpers/CheatModeTagHelper.cs @@ -0,0 +1,30 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using Microsoft.AspNetCore.Razor.TagHelpers; +using System.Xml.Linq; +using BTCPayServer.Configuration; + +namespace BTCPayServer.TagHelpers; + + +[HtmlTargetElement(Attributes = "[cheat-mode]")] +public class CheatModeTagHelper +{ + public CheatModeTagHelper(BTCPayServerOptions env) + { + Env = env; + } + + public BTCPayServerOptions Env { get; } + public bool CheatMode { get; set; } + public void Process(TagHelperContext context, TagHelperOutput output) + { + if (Env.CheatMode != CheatMode) + { + output.SuppressOutput(); + } + } +} diff --git a/BTCPayServer/Views/UIReports/StoreReports.cshtml b/BTCPayServer/Views/UIReports/StoreReports.cshtml new file mode 100644 index 000000000..548cc5689 --- /dev/null +++ b/BTCPayServer/Views/UIReports/StoreReports.cshtml @@ -0,0 +1,128 @@ +@using BTCPayServer.Abstractions.Extensions; +@using BTCPayServer.Client.Models; +@using BTCPayServer.Models.StoreReportsViewModels; +@using BTCPayServer.Views.Invoice; +@using BTCPayServer.Views.Stores; +@using BTCPayServer.Abstractions.Services; +@using Microsoft.AspNetCore.Routing; +@inject Safe Safe +@inject BTCPayServer.Security.ContentSecurityPolicies Csp +@model StoreReportsViewModel +@{ + ViewData.SetActivePage(StoreNavPages.Reporting, "Reporting"); + Csp.UnsafeEval(); +} +@section PageHeadContent +{ + @* Set a height for the responsive table container to make it work with the fixed table headers. + Details described here: thttps://uxdesign.cc/position-stuck-96c9f55d9526 *@ + +} + +
    +
    +

    @ViewData["Title"]

    +
    + Create fake date + +
    +
    +
    +
    + +
    + @foreach (var v in Model.AvailableViews) + { + @v + } +
    +
    +
    + + +
    +
    + + +
    +
    +
    + +
    +
    +

    {{ chart.name }}

    +
    + + + + + + + + + + + + + + + +
    {{ group }}{{ agg }}
    {{ group.name }}Total{{ value }}
    Grand total{{ value }}
    +
    +
    + +
    + +@section PageFootContent { + + + + + + +} diff --git a/BTCPayServer/Views/UIStores/StoreNavPages.cs b/BTCPayServer/Views/UIStores/StoreNavPages.cs index 9b43e04da..9e3682482 100644 --- a/BTCPayServer/Views/UIStores/StoreNavPages.cs +++ b/BTCPayServer/Views/UIStores/StoreNavPages.cs @@ -19,6 +19,7 @@ namespace BTCPayServer.Views.Stores Plugins, Webhooks, PullPayments, + Reporting, Payouts, PayoutProcessors, [Obsolete("Use StoreNavPages.Plugins instead")] diff --git a/BTCPayServer/wwwroot/js/datatable.js b/BTCPayServer/wwwroot/js/datatable.js new file mode 100644 index 000000000..557183f9a --- /dev/null +++ b/BTCPayServer/wwwroot/js/datatable.js @@ -0,0 +1,269 @@ +(function () { + // Given sorted data, build a tabular data of given groups and aggregates. + function groupBy(groupIndices, aggregatesIndices, data) { + var summaryRows = []; + var summaryRow = null; + for (var i = 0; i < data.length; i++) { + if (summaryRow) { + for (var gi = 0; gi < groupIndices.length; gi++) { + if (summaryRow[gi] !== data[i][groupIndices[gi]]) { + summaryRows.push(summaryRow); + summaryRow = null; + break; + } + } + } + if (!summaryRow) { + summaryRow = new Array(groupIndices.length + aggregatesIndices.length); + for (var gi = 0; gi < groupIndices.length; gi++) { + summaryRow[gi] = data[i][groupIndices[gi]]; + } + summaryRow.fill(0, groupIndices.length); + } + for (var ai = 0; ai < aggregatesIndices.length; ai++) { + var v = data[i][aggregatesIndices[ai]]; + // TODO: support other aggregate functions + if (v) + summaryRow[groupIndices.length + ai] += v; + } + } + if (summaryRow) { + summaryRows.push(summaryRow); + } + return summaryRows; + } + + // Sort tabular data by the column indices + function byColumns(columnIndices) { + return (a, b) => { + for (var i = 0; i < columnIndices.length; i++) { + var fieldIndex = columnIndices[i]; + if (!a[fieldIndex]) return 1; + if (!b[fieldIndex]) return -1; + + if (a[fieldIndex] < b[fieldIndex]) + return -1; + if (a[fieldIndex] > b[fieldIndex]) + return 1; + } + return 0; + } + } + + // Build a representation of the HTML table's data 'rows' from the tree of nodes. + function buildRows(node, rows) { + if (node.children.length === 0 && node.level !== 0) { + var row = + { + values: node.values, + groups: [], + isTotal: node.isTotal, + rLevel: node.rLevel + }; + // Round the nuber to 8 decimal to avoid weird decimal outputs + for (var i = 0; i < row.values.length; i++) { + if (typeof row.values[i] === 'number') + row.values[i] = new Number(row.values[i].toFixed(8)); + } + if (!node.isTotal) + row.groups.push({ name: node.groups[node.groups.length - 1], rowCount: node.leafCount }) + var parent = node.parent; + var n = node; + while (parent && parent.level != 0 && parent.children[0] === n) { + row.groups.push({ name: parent.groups[parent.groups.length - 1], rowCount: parent.leafCount }) + n = parent; + parent = parent.parent; + } + row.groups.reverse(); + rows.push(row); + } + for (var i = 0; i < node.children.length; i++) { + buildRows(node.children[i], rows); + } + } + + // Add a leafCount property, the number of leaf below each nodes + // Remove total if there is only one child outside of the total + function visitTree(node) { + node.leafCount = 0; + if (node.children.length === 0) { + node.leafCount++; + return; + } + for (var i = 0; i < node.children.length; i++) { + visitTree(node.children[i]); + node.leafCount += node.children[i].leafCount; + } + // Remove total if there is only one child outside of the total + if (node.children.length == 2 && node.children[0].isTotal) { + node.children.shift(); + node.leafCount--; + } + } + + // Build a tree of nodes from all the group levels. + function makeTree(totalLevels, parent, groupLevels, level) { + if (totalLevels.indexOf(level - 1) !== -1) { + parent.children.push({ + parent: parent, + groups: parent.groups, + values: parent.values, + children: [], + level: level, + rLevel: groupLevels.length - level, + isTotal: true + }); + } + for (var i = 0; i < groupLevels[level].length; i++) { + var foundFirst = false; + var groupData = groupLevels[level][i]; + var gotoNextRow = false; + var stop = false; + for (var gi = 0; gi < parent.groups.length; gi++) { + if (parent.groups[gi] !== groupData[gi]) { + if (foundFirst) { + stop = true; + } + else { + gotoNextRow = true; + foundFirst = true; + break; + } + } + } + if (stop) + break; + if (gotoNextRow) + continue; + var node = + { + parent: parent, + groups: groupData.slice(0, level), + values: groupData.slice(level), + children: [], + level: level, + rLevel: groupLevels.length - level + }; + parent.children.push(node); + if (groupLevels.length > level + 1) + makeTree(totalLevels, node, groupLevels, level + 1); + } + } + + function applyFilters(rows, fields, filterStrings) { + if (!filterStrings || filterStrings.length === 0) + return rows; + // filterStrings are aggregated into one filter function: + // filter(){ return filter1 && filter2 && filter3; } + var newData = []; + var o = {}; + eval('function filter() {return ' + filterStrings.join(' && ') + ';}'); + // For each row, build a JSON objects representing it, and evaluate it on the fitler + for (var i = 0; i < rows.length; i++) { + for (var fi = 0; fi < fields.length; fi++) { + o[fields[fi]] = rows[i][fi]; + } + if (!filter.bind(o)()) + continue; + newData.push(rows[i]); + } + return newData; + } + + + function clone(a) { + return Array.from(a, subArray => [...subArray]); + } + + function createTable(summaryDefinition, fields, rows) { + var groupIndices = summaryDefinition.groups.map(g => fields.findIndex((a) => a === g)).filter(g => g !== -1); + var aggregatesIndices = summaryDefinition.aggregates.map(g => fields.findIndex((a) => a === g)).filter(g => g !== -1); + aggregatesIndices = aggregatesIndices.filter(g => g !== -1); + + // Filter rows + rows = applyFilters(rows, fields, summaryDefinition.filters); + + // Sort by group columns + rows.sort(byColumns(groupIndices)); + + // Group data represent tabular data of all the groups and aggregates given the data. + // [Region, Crypto, PaymentType] + var groupRows = groupBy(groupIndices, aggregatesIndices, rows); + + + // There will be several level of aggregation + // For example, if you have 3 groups: [Region, Crypto, PaymentType] then you have 4 group data. + // [Region, Crypto, PaymentType] + // [Region, Crypto] + // [Region] + // [] + var groupLevels = []; + groupLevels.push(groupRows); + + // We build the group rows with less columns + // Those builds the level: + // [Region, Crypto], [Region] and [] + for (var i = 1; i < groupIndices.length + 1; i++) { + + // We are grouping the group data. + // For our example of 3 groups and 2 aggregate2, then: + // First iteration: newGroupIndices = [0, 1], newAggregatesIndices = [3, 4] + // Second iteration: newGroupIndices = [0], newAggregatesIndices = [2, 3] + // Last iteration: newGroupIndices = [], newAggregatesIndices = [1, 2] + var newGroupIndices = []; + for (var gi = 0; gi < groupIndices.length - i; gi++) { + newGroupIndices.push(gi); + } + var newAggregatesIndices = []; + for (var ai = 0; ai < aggregatesIndices.length; ai++) { + newAggregatesIndices.push(newGroupIndices.length + 1 + ai); + } + // Group the group rows + groupRows = groupBy(newGroupIndices, newAggregatesIndices, groupRows); + groupLevels.push(groupRows); + } + + // Put the highest level ([]) on top + groupLevels.reverse(); + + var root = + { + parent: null, + groups: [], + // Note that the top group data always have one row aggregating all + values: groupLevels[0][0], + children: [], + // level=0 means the root, it increments 1 each level + level: 0, + // rlevel is the reverse. It starts from the highest level and goes down to 0 + rLevel: groupLevels.length + }; + + + // Which levels will have a total row + var totalLevels = []; + if (summaryDefinition.totals) { + totalLevels = summaryDefinition.totals.map(g => summaryDefinition.groups.findIndex((a) => a === g) + 1).filter(a => a !== 0); + } + // Build the tree of nodes + makeTree(totalLevels, root, groupLevels, 1); + + // Add a leafCount property to each node, it is the number of leaf below each nodes. + visitTree(root); + + // Create a representation that can easily be binded to VueJS + var rows = []; + buildRows(root, rows); + + return { + groups: summaryDefinition.groups, + aggregates: summaryDefinition.aggregates, + hasGrandTotal: root.values && summaryDefinition.hasGrandTotal, + grandTotalValues: root.values, + rows: rows + }; + } + + window.clone = clone; + window.createTable = createTable; +})(); diff --git a/BTCPayServer/wwwroot/js/store-reports.js b/BTCPayServer/wwwroot/js/store-reports.js new file mode 100644 index 000000000..6a4cb170f --- /dev/null +++ b/BTCPayServer/wwwroot/js/store-reports.js @@ -0,0 +1,212 @@ +let app, origData; +srv.sortBy = function (field) { + for (let key in this.fieldViews) { + if (this.fieldViews.hasOwnProperty(key)) { + const sortedField = field === key; + const fieldView = this.fieldViews[key]; + + if (sortedField && (fieldView.sortBy === "" || fieldView.sortBy === "desc")) { + fieldView.sortByTitle = "asc"; + fieldView.sortBy = "asc"; + fieldView.sortIconClass = "fa fa-sort-alpha-asc"; + } + else if (sortedField && (fieldView.sortByTitle === "asc")) { + fieldView.sortByTitle = "desc"; + fieldView.sortBy = "desc"; + fieldView.sortIconClass = "fa fa-sort-alpha-desc"; + } + else { + fieldView.sortByTitle = ""; + fieldView.sortBy = ""; + fieldView.sortIconClass = "fa fa-sort"; + } + } + } + this.applySort(); +} + +srv.applySort = function () { + let fieldIndex, fieldView; + for (let key in this.fieldViews) { + if (this.fieldViews.hasOwnProperty(key)) { + fieldView = this.fieldViews[key]; + if (fieldView.sortBy !== "") { + fieldIndex = this.result.fields.findIndex((a) => a.name === key); + break; + } + fieldView = null; + } + } + if (!fieldView) + return; + const sortType = fieldView.sortBy === "desc" ? 1 : -1; + srv.result.data.sort(function (a, b) { + const aVal = a[fieldIndex]; + const bVal = b[fieldIndex]; + if (aVal === bVal) return 0; + if (aVal === null) return 1 * sortType; + if (bVal === null) return -1 * sortType; + if (aVal > bVal) return 1 * sortType; + return -1 * sortType; + }); +}; +srv.dataUpdated = function () { + this.updateFieldViews(); + origData = clone(this.result.data); + this.applySort(); +}; +srv.updateFieldViews = function () { + this.fieldViews = this.fieldViews || {}; + + // First we remove the fieldViews that doesn't apply anymore + for (let key in this.fieldViews) { + if (this.fieldViews.hasOwnProperty(key)) { + if (!this.result.fields.find(i => i.name === key)) + delete this.fieldViews[key]; + } + } + + // Then we add those that are missing + for (let i = 0; i < this.result.fields.length; i++) { + const field = this.result.fields[i]; + if (!this.fieldViews.hasOwnProperty(field.name)) { + this.fieldViews[field.name] = + { + sortBy: "", + sortByTitle: "", + sortIconClass: "fa fa-sort" + }; + } + } +}; + +document.addEventListener("DOMContentLoaded", () => { + delegate("input", ".flatdtpicker", function () { + // We don't use vue to bind dates, because VueJS break the flatpickr as soon as binding occurs. + let to = document.getElementById("toDate").value + let from = document.getElementById("fromDate").value + + if (!to || !from) + return; + + from = moment(from).unix(); + to = moment(to).endOf('day').unix(); + + srv.request.timePeriod.from = from; + srv.request.timePeriod.to = to; + fetchStoreReports(); + }); + + delegate("click", "#exportCSV", downloadCSV); + + const $viewNameToggle = document.getElementById("ViewNameToggle") + delegate("click", ".available-view", function (e) { + e.preventDefault(); + const { view } = e.target.dataset; + $viewNameToggle.innerText = view; + document.querySelectorAll(".available-view").forEach($el => $el.classList.remove("custom-active")); + e.target.classList.add("custom-active"); + srv.request.viewName = view; + fetchStoreReports(); + }); + + let to = new Date(); + let from = new Date(to.getTime() - 1000 * 60 * 60 * 24 * 30); + var urlParams = new URLSearchParams(new URL(window.location).search); + if (urlParams.has("from")) { + from = new Date(parseInt(urlParams.get("from")) * 1000); + } + if (urlParams.has("to")) { + to = new Date(parseInt(urlParams.get("to")) * 1000); + } + srv.request = srv.request || {}; + srv.request.timePeriod = srv.request.timePeriod || {}; + srv.request.timePeriod.to = moment(to).unix(); + srv.request.viewName = srv.request.viewName || "Payments"; + srv.request.timePeriod.from = moment(from).unix(); + srv.request.timeZone = Intl.DateTimeFormat().resolvedOptions().timeZone; + srv.result = { fields: [], values: [] }; + updateUIDateRange(); + app = new Vue({ + el: '#app', + data() { return { srv } } + }); + fetchStoreReports(); +}); + +function updateUIDateRange() { + document.getElementById("toDate")._flatpickr.setDate(moment.unix(srv.request.timePeriod.to).toDate()); + document.getElementById("fromDate")._flatpickr.setDate(moment.unix(srv.request.timePeriod.from).toDate()); +} + +// This function modify all the fields of a given type +function modifyFields(fields, data, type, action) { + var fieldIndices = fields.map((f, i) => ({ i: i, type: f.type })).filter(f => f.type == type).map(f => f.i); + if (fieldIndices.length === 0) + return; + for (var i = 0; i < data.length; i++) { + for (var f = 0; f < fieldIndices.length; f++) { + data[i][fieldIndices[f]] = action(data[i][fieldIndices[f]]); + } + } +} +function downloadCSV() { + if (!origData) return; + const data = clone(origData); + + // Convert ISO8601 dates to YYYY-MM-DD HH:mm:ss so the CSV easily integrate with Excel + modifyFields(srv.result.fields, data, 'datetime', v => moment(v).format('YYYY-MM-DD hh:mm:ss')); + const csv = Papa.unparse({ fields: srv.result.fields.map(f => f.name), data }); + const blob = new Blob([csv], { type: 'text/csv;charset=utf-8;' }); + saveAs(blob, "export.csv"); +} + +async function fetchStoreReports() { + const result = await fetch(window.location, { + method: 'POST', + headers: { + 'Accept': 'application/json', + 'Content-Type': 'application/json' + }, + body: JSON.stringify(srv.request) + }); + + srv.result = await result.json(); + srv.dataUpdated(); + + // Dates from API are UTC, convert them to local time + modifyFields(srv.result.fields, srv.result.data, 'datetime', a => moment(a).format()); + var urlParams = new URLSearchParams(new URL(window.location).search); + urlParams.set("viewName", srv.request.viewName); + urlParams.set("from", srv.request.timePeriod.from); + urlParams.set("to", srv.request.timePeriod.to); + history.replaceState(null, null, "?" + urlParams.toString()); + updateUIDateRange(); + + srv.charts = []; + for (let i = 0; i < srv.result.charts.length; i++) { + const chart = srv.result.charts[i]; + const table = createTable(chart, srv.result.fields.map(f => f.name), srv.result.data); + table.name = chart.name; + srv.charts.push(table); + } + + app.srv = srv; +} + +function getInvoiceUrl(value) { + if (!value) + return; + return srv.invoiceTemplateUrl.replace("INVOICE_ID", value); +} +window.getInvoiceUrl = getInvoiceUrl; + +function getExplorerUrl(tx_id, cryptoCode) { + if (!tx_id || !cryptoCode) + return null; + var explorer = srv.explorerTemplateUrls[cryptoCode]; + if (!explorer) + return null; + return explorer.replace("TX_ID", tx_id); +} +window.getExplorerUrl = getExplorerUrl; diff --git a/BTCPayServer/wwwroot/vendor/FileSaver/FileSaver.min.js b/BTCPayServer/wwwroot/vendor/FileSaver/FileSaver.min.js new file mode 100644 index 000000000..6d493b298 --- /dev/null +++ b/BTCPayServer/wwwroot/vendor/FileSaver/FileSaver.min.js @@ -0,0 +1,3 @@ +(function(a,b){if("function"==typeof define&&define.amd)define([],b);else if("undefined"!=typeof exports)b();else{b(),a.FileSaver={exports:{}}.exports}})(this,function(){"use strict";function b(a,b){return"undefined"==typeof b?b={autoBom:!1}:"object"!=typeof b&&(console.warn("Deprecated: Expected third argument to be a object"),b={autoBom:!b}),b.autoBom&&/^\s*(?:text\/\S*|application\/xml|\S*\/\S*\+xml)\s*;.*charset\s*=\s*utf-8/i.test(a.type)?new Blob(["\uFEFF",a],{type:a.type}):a}function c(a,b,c){var d=new XMLHttpRequest;d.open("GET",a),d.responseType="blob",d.onload=function(){g(d.response,b,c)},d.onerror=function(){console.error("could not download file")},d.send()}function d(a){var b=new XMLHttpRequest;b.open("HEAD",a,!1);try{b.send()}catch(a){}return 200<=b.status&&299>=b.status}function e(a){try{a.dispatchEvent(new MouseEvent("click"))}catch(c){var b=document.createEvent("MouseEvents");b.initMouseEvent("click",!0,!0,window,0,0,0,80,20,!1,!1,!1,!1,0,null),a.dispatchEvent(b)}}var f="object"==typeof window&&window.window===window?window:"object"==typeof self&&self.self===self?self:"object"==typeof global&&global.global===global?global:void 0,a=/Macintosh/.test(navigator.userAgent)&&/AppleWebKit/.test(navigator.userAgent)&&!/Safari/.test(navigator.userAgent),g=f.saveAs||("object"!=typeof window||window!==f?function(){}:"download"in HTMLAnchorElement.prototype&&!a?function(b,g,h){var i=f.URL||f.webkitURL,j=document.createElement("a");g=g||b.name||"download",j.download=g,j.rel="noopener","string"==typeof b?(j.href=b,j.origin===location.origin?e(j):d(j.href)?c(b,g,h):e(j,j.target="_blank")):(j.href=i.createObjectURL(b),setTimeout(function(){i.revokeObjectURL(j.href)},4E4),setTimeout(function(){e(j)},0))}:"msSaveOrOpenBlob"in navigator?function(f,g,h){if(g=g||f.name||"download","string"!=typeof f)navigator.msSaveOrOpenBlob(b(f,h),g);else if(d(f))c(f,g,h);else{var i=document.createElement("a");i.href=f,i.target="_blank",setTimeout(function(){e(i)})}}:function(b,d,e,g){if(g=g||open("","_blank"),g&&(g.document.title=g.document.body.innerText="downloading..."),"string"==typeof b)return c(b,d,e);var h="application/octet-stream"===b.type,i=/constructor/i.test(f.HTMLElement)||f.safari,j=/CriOS\/[\d]+/.test(navigator.userAgent);if((j||h&&i||a)&&"undefined"!=typeof FileReader){var k=new FileReader;k.onloadend=function(){var a=k.result;a=j?a:a.replace(/^data:[^;]*;/,"data:attachment/file;"),g?g.location.href=a:location=a,g=null},k.readAsDataURL(b)}else{var l=f.URL||f.webkitURL,m=l.createObjectURL(b);g?g.location=m:location.href=m,g=null,setTimeout(function(){l.revokeObjectURL(m)},4E4)}});f.saveAs=g.saveAs=g,"undefined"!=typeof module&&(module.exports=g)}); + +//# sourceMappingURL=FileSaver.min.js.map \ No newline at end of file diff --git a/BTCPayServer/wwwroot/vendor/papaparse/papaparse.min.js b/BTCPayServer/wwwroot/vendor/papaparse/papaparse.min.js new file mode 100644 index 000000000..eeaf9834a --- /dev/null +++ b/BTCPayServer/wwwroot/vendor/papaparse/papaparse.min.js @@ -0,0 +1,7 @@ +/* @license +Papa Parse +v5.4.1 +https://github.com/mholt/PapaParse +License: MIT +*/ +!function(e,t){"function"==typeof define&&define.amd?define([],t):"object"==typeof module&&"undefined"!=typeof exports?module.exports=t():e.Papa=t()}(this,function s(){"use strict";var f="undefined"!=typeof self?self:"undefined"!=typeof window?window:void 0!==f?f:{};var n=!f.document&&!!f.postMessage,o=f.IS_PAPA_WORKER||!1,a={},u=0,b={parse:function(e,t){var r=(t=t||{}).dynamicTyping||!1;J(r)&&(t.dynamicTypingFunction=r,r={});if(t.dynamicTyping=r,t.transform=!!J(t.transform)&&t.transform,t.worker&&b.WORKERS_SUPPORTED){var i=function(){if(!b.WORKERS_SUPPORTED)return!1;var e=(r=f.URL||f.webkitURL||null,i=s.toString(),b.BLOB_URL||(b.BLOB_URL=r.createObjectURL(new Blob(["var global = (function() { if (typeof self !== 'undefined') { return self; } if (typeof window !== 'undefined') { return window; } if (typeof global !== 'undefined') { return global; } return {}; })(); global.IS_PAPA_WORKER=true; ","(",i,")();"],{type:"text/javascript"})))),t=new f.Worker(e);var r,i;return t.onmessage=_,t.id=u++,a[t.id]=t}();return i.userStep=t.step,i.userChunk=t.chunk,i.userComplete=t.complete,i.userError=t.error,t.step=J(t.step),t.chunk=J(t.chunk),t.complete=J(t.complete),t.error=J(t.error),delete t.worker,void i.postMessage({input:e,config:t,workerId:i.id})}var n=null;b.NODE_STREAM_INPUT,"string"==typeof e?(e=function(e){if(65279===e.charCodeAt(0))return e.slice(1);return e}(e),n=t.download?new l(t):new p(t)):!0===e.readable&&J(e.read)&&J(e.on)?n=new g(t):(f.File&&e instanceof File||e instanceof Object)&&(n=new c(t));return n.stream(e)},unparse:function(e,t){var n=!1,_=!0,m=",",y="\r\n",s='"',a=s+s,r=!1,i=null,o=!1;!function(){if("object"!=typeof t)return;"string"!=typeof t.delimiter||b.BAD_DELIMITERS.filter(function(e){return-1!==t.delimiter.indexOf(e)}).length||(m=t.delimiter);("boolean"==typeof t.quotes||"function"==typeof t.quotes||Array.isArray(t.quotes))&&(n=t.quotes);"boolean"!=typeof t.skipEmptyLines&&"string"!=typeof t.skipEmptyLines||(r=t.skipEmptyLines);"string"==typeof t.newline&&(y=t.newline);"string"==typeof t.quoteChar&&(s=t.quoteChar);"boolean"==typeof t.header&&(_=t.header);if(Array.isArray(t.columns)){if(0===t.columns.length)throw new Error("Option columns is empty");i=t.columns}void 0!==t.escapeChar&&(a=t.escapeChar+s);("boolean"==typeof t.escapeFormulae||t.escapeFormulae instanceof RegExp)&&(o=t.escapeFormulae instanceof RegExp?t.escapeFormulae:/^[=+\-@\t\r].*$/)}();var u=new RegExp(Q(s),"g");"string"==typeof e&&(e=JSON.parse(e));if(Array.isArray(e)){if(!e.length||Array.isArray(e[0]))return h(null,e,r);if("object"==typeof e[0])return h(i||Object.keys(e[0]),e,r)}else if("object"==typeof e)return"string"==typeof e.data&&(e.data=JSON.parse(e.data)),Array.isArray(e.data)&&(e.fields||(e.fields=e.meta&&e.meta.fields||i),e.fields||(e.fields=Array.isArray(e.data[0])?e.fields:"object"==typeof e.data[0]?Object.keys(e.data[0]):[]),Array.isArray(e.data[0])||"object"==typeof e.data[0]||(e.data=[e.data])),h(e.fields||[],e.data||[],r);throw new Error("Unable to serialize unrecognized input");function h(e,t,r){var i="";"string"==typeof e&&(e=JSON.parse(e)),"string"==typeof t&&(t=JSON.parse(t));var n=Array.isArray(e)&&0=this._config.preview;if(o)f.postMessage({results:n,workerId:b.WORKER_ID,finished:a});else if(J(this._config.chunk)&&!t){if(this._config.chunk(n,this._handle),this._handle.paused()||this._handle.aborted())return void(this._halted=!0);n=void 0,this._completeResults=void 0}return this._config.step||this._config.chunk||(this._completeResults.data=this._completeResults.data.concat(n.data),this._completeResults.errors=this._completeResults.errors.concat(n.errors),this._completeResults.meta=n.meta),this._completed||!a||!J(this._config.complete)||n&&n.meta.aborted||(this._config.complete(this._completeResults,this._input),this._completed=!0),a||n&&n.meta.paused||this._nextChunk(),n}this._halted=!0},this._sendError=function(e){J(this._config.error)?this._config.error(e):o&&this._config.error&&f.postMessage({workerId:b.WORKER_ID,error:e,finished:!1})}}function l(e){var i;(e=e||{}).chunkSize||(e.chunkSize=b.RemoteChunkSize),h.call(this,e),this._nextChunk=n?function(){this._readChunk(),this._chunkLoaded()}:function(){this._readChunk()},this.stream=function(e){this._input=e,this._nextChunk()},this._readChunk=function(){if(this._finished)this._chunkLoaded();else{if(i=new XMLHttpRequest,this._config.withCredentials&&(i.withCredentials=this._config.withCredentials),n||(i.onload=v(this._chunkLoaded,this),i.onerror=v(this._chunkError,this)),i.open(this._config.downloadRequestBody?"POST":"GET",this._input,!n),this._config.downloadRequestHeaders){var e=this._config.downloadRequestHeaders;for(var t in e)i.setRequestHeader(t,e[t])}if(this._config.chunkSize){var r=this._start+this._config.chunkSize-1;i.setRequestHeader("Range","bytes="+this._start+"-"+r)}try{i.send(this._config.downloadRequestBody)}catch(e){this._chunkError(e.message)}n&&0===i.status&&this._chunkError()}},this._chunkLoaded=function(){4===i.readyState&&(i.status<200||400<=i.status?this._chunkError():(this._start+=this._config.chunkSize?this._config.chunkSize:i.responseText.length,this._finished=!this._config.chunkSize||this._start>=function(e){var t=e.getResponseHeader("Content-Range");if(null===t)return-1;return parseInt(t.substring(t.lastIndexOf("/")+1))}(i),this.parseChunk(i.responseText)))},this._chunkError=function(e){var t=i.statusText||e;this._sendError(new Error(t))}}function c(e){var i,n;(e=e||{}).chunkSize||(e.chunkSize=b.LocalChunkSize),h.call(this,e);var s="undefined"!=typeof FileReader;this.stream=function(e){this._input=e,n=e.slice||e.webkitSlice||e.mozSlice,s?((i=new FileReader).onload=v(this._chunkLoaded,this),i.onerror=v(this._chunkError,this)):i=new FileReaderSync,this._nextChunk()},this._nextChunk=function(){this._finished||this._config.preview&&!(this._rowCount=this._input.size,this.parseChunk(e.target.result)},this._chunkError=function(){this._sendError(i.error)}}function p(e){var r;h.call(this,e=e||{}),this.stream=function(e){return r=e,this._nextChunk()},this._nextChunk=function(){if(!this._finished){var e,t=this._config.chunkSize;return t?(e=r.substring(0,t),r=r.substring(t)):(e=r,r=""),this._finished=!r,this.parseChunk(e)}}}function g(e){h.call(this,e=e||{});var t=[],r=!0,i=!1;this.pause=function(){h.prototype.pause.apply(this,arguments),this._input.pause()},this.resume=function(){h.prototype.resume.apply(this,arguments),this._input.resume()},this.stream=function(e){this._input=e,this._input.on("data",this._streamData),this._input.on("end",this._streamEnd),this._input.on("error",this._streamError)},this._checkIsFinished=function(){i&&1===t.length&&(this._finished=!0)},this._nextChunk=function(){this._checkIsFinished(),t.length?this.parseChunk(t.shift()):r=!0},this._streamData=v(function(e){try{t.push("string"==typeof e?e:e.toString(this._config.encoding)),r&&(r=!1,this._checkIsFinished(),this.parseChunk(t.shift()))}catch(e){this._streamError(e)}},this),this._streamError=v(function(e){this._streamCleanUp(),this._sendError(e)},this),this._streamEnd=v(function(){this._streamCleanUp(),i=!0,this._streamData("")},this),this._streamCleanUp=v(function(){this._input.removeListener("data",this._streamData),this._input.removeListener("end",this._streamEnd),this._input.removeListener("error",this._streamError)},this)}function r(m){var a,o,u,i=Math.pow(2,53),n=-i,s=/^\s*-?(\d+\.?|\.\d+|\d+\.\d+)([eE][-+]?\d+)?\s*$/,h=/^((\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+([+-][0-2]\d:[0-5]\d|Z))|(\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d([+-][0-2]\d:[0-5]\d|Z))|(\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d([+-][0-2]\d:[0-5]\d|Z)))$/,t=this,r=0,f=0,d=!1,e=!1,l=[],c={data:[],errors:[],meta:{}};if(J(m.step)){var p=m.step;m.step=function(e){if(c=e,_())g();else{if(g(),0===c.data.length)return;r+=e.data.length,m.preview&&r>m.preview?o.abort():(c.data=c.data[0],p(c,t))}}}function y(e){return"greedy"===m.skipEmptyLines?""===e.join("").trim():1===e.length&&0===e[0].length}function g(){return c&&u&&(k("Delimiter","UndetectableDelimiter","Unable to auto-detect delimiting character; defaulted to '"+b.DefaultDelimiter+"'"),u=!1),m.skipEmptyLines&&(c.data=c.data.filter(function(e){return!y(e)})),_()&&function(){if(!c)return;function e(e,t){J(m.transformHeader)&&(e=m.transformHeader(e,t)),l.push(e)}if(Array.isArray(c.data[0])){for(var t=0;_()&&t=l.length?"__parsed_extra":l[r]),m.transform&&(s=m.transform(s,n)),s=v(n,s),"__parsed_extra"===n?(i[n]=i[n]||[],i[n].push(s)):i[n]=s}return m.header&&(r>l.length?k("FieldMismatch","TooManyFields","Too many fields: expected "+l.length+" fields but parsed "+r,f+t):r=i.length/2?"\r\n":"\r"}(e,i)),u=!1,m.delimiter)J(m.delimiter)&&(m.delimiter=m.delimiter(e),c.meta.delimiter=m.delimiter);else{var n=function(e,t,r,i,n){var s,a,o,u;n=n||[",","\t","|",";",b.RECORD_SEP,b.UNIT_SEP];for(var h=0;h=N)return L(!0)}else for(S=W,W++;;){if(-1===(S=i.indexOf(z,S+1)))return r||h.push({type:"Quotes",code:"MissingQuotes",message:"Quoted field unterminated",row:u.length,index:W}),T();if(S===n-1)return T(i.substring(W,S).replace(C,z));if(z!==K||i[S+1]!==K){if(z===K||0===S||i[S-1]!==K){-1!==w&&w=N)return L(!0);break}h.push({type:"Quotes",code:"InvalidQuotes",message:"Trailing quote on quoted field is malformed",row:u.length,index:W}),S++}}else S++}return T();function I(e){u.push(e),d=W}function A(e){var t=0;if(-1!==e){var r=i.substring(S+1,e);r&&""===r.trim()&&(t=r.length)}return t}function T(e){return r||(void 0===e&&(e=i.substring(W)),f.push(e),W=n,I(f),o&&F()),L()}function D(e){W=e,I(f),f=[],R=i.indexOf(P,W)}function L(e){return{data:u,errors:h,meta:{delimiter:M,linebreak:P,aborted:H,truncated:!!e,cursor:d+(t||0)}}}function F(){q(L()),u=[],h=[]}},this.abort=function(){H=!0},this.getCharIndex=function(){return W}}function _(e){var t=e.data,r=a[t.workerId],i=!1;if(t.error)r.userError(t.error,t.file);else if(t.results&&t.results.data){var n={abort:function(){i=!0,m(t.workerId,{data:[],errors:[],meta:{aborted:!0}})},pause:y,resume:y};if(J(r.userStep)){for(var s=0;s