Add reporting feature

BTCPayServer.Abstractions/TagHelpers/PermissionTagHelper.cs

@@ -12,13 +12,11 @@ public class PermissionTagHelper : TagHelper
 {
     private readonly IAuthorizationService _authorizationService;
     private readonly IHttpContextAccessor _httpContextAccessor;
-    private readonly ILogger<PermissionTagHelper> _logger;
 
-    public PermissionTagHelper(IAuthorizationService authorizationService, IHttpContextAccessor httpContextAccessor, ILogger<PermissionTagHelper> logger)
+    public PermissionTagHelper(IAuthorizationService authorizationService, IHttpContextAccessor httpContextAccessor)
     {
         _authorizationService = authorizationService;
         _httpContextAccessor = httpContextAccessor;
-        _logger = logger;
     }
 
     public string Permission { get; set; }

BTCPayServer.Client/Models/StoreReportRequest.cs

@@ -0,0 +1,56 @@
+using System;
+using System.Collections.Generic;
+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<Field> Fields { get; set; } = new List<Field>();
+    public List<JArray> Data { get; set; }
+    public DateTimeOffset From { get; set; }
+    public DateTimeOffset To { get; set; }
+    public List<ChartDefinition> Charts { get; set; }
+}
+
+public class ChartDefinition
+{
+    public string Name { get; set; }
+
+    public List<string> Groups { get; set; } = new List<string>();
+    public List<string> Totals { get; set; } = new List<string>();
+    public bool HasGrandTotal { get; set; }
+    public List<string> Aggregates { get; set; } = new List<string>();
+    public List<string> Filters { get; set; } = new List<string>();
+}
+
+public class TimePeriod
+{
+    [JsonConverter(typeof(NBitcoin.JsonConverters.DateTimeToUnixTimeConverter))]
+    public DateTimeOffset? From { get; set; }
+    [JsonConverter(typeof(NBitcoin.JsonConverters.DateTimeToUnixTimeConverter))]
+    public DateTimeOffset? To { get; set; }
+}

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;
+        }
+    }
+}

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;

BTCPayServer.Tests/ThirdPartyTests.cs

@@ -391,6 +391,14 @@ public async Task CheckJsContent()
             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();

BTCPayServer/BTCPayServer.csproj

@@ -81,6 +81,7 @@
   </ItemGroup>
 
 	<ItemGroup>
+	  <None Include="Views\UIReports\StoreReports.cshtml" />
 	  <None Include="wwwroot\vendor\font-awesome\fonts\fontawesome-webfont.svg" />
 	  <None Include="wwwroot\vendor\font-awesome\fonts\fontawesome-webfont.woff2" />
 	  <None Include="wwwroot\vendor\font-awesome\less\animated.less" />
@@ -119,6 +120,7 @@
 	  <Folder Include="wwwroot\vendor\bootstrap" />
 	  <Folder Include="wwwroot\vendor\clipboard.js\" />
 	  <Folder Include="wwwroot\vendor\highlightjs\" />
+	  <Folder Include="wwwroot\vendor\pivottable\" />
 	  <Folder Include="wwwroot\vendor\summernote" />
 	  <Folder Include="wwwroot\vendor\tom-select" />
 	  <Folder Include="wwwroot\vendor\ur-registry" />
@@ -135,7 +137,9 @@
 
 	<ItemGroup>
     <Watch Include="Views\**\*.*"></Watch>
+    <Content Remove="Views\UIReports\StoreReports.cshtml" />
     <Watch Remove="Views\UIAccount\CheatPermissions.cshtml" />
+    <Watch Remove="Views\UIReports\StoreReports.cshtml" />
     <Content Update="Views\UIApps\_ViewImports.cshtml">
       <CopyToPublishDirectory>PreserveNewest</CopyToPublishDirectory>
       <Pack>$(IncludeRazorContentInPack)</Pack>

BTCPayServer/Components/MainNav/Default.cshtml

@@ -131,6 +131,12 @@
                                             <span>Invoices</span>
                                         </a>
                                     </li>
+									<li class="nav-item" permission="@Policies.CanViewInvoices">
+										<a asp-area="" asp-controller="UIReports" asp-action="StoreReports" asp-route-storeId="@Model.Store.Id" class="nav-link @ViewData.IsActivePage(StoreNavPages.Reporting)" id="StoreNav-Reporting">
+											<vc:icon symbol="invoice" />
+											<span>Reporting</span>
+										</a>
+									</li>
                                     <li class="nav-item" permission="@Policies.CanModifyStoreSettings">
                                         <a asp-area="" asp-controller="UIPaymentRequest" asp-action="GetPaymentRequests" asp-route-storeId="@Model.Store.Id" class="nav-link @ViewData.IsActiveCategory(typeof(PaymentRequestsNavPages))" id="StoreNav-PaymentRequests">
                                             <vc:icon symbol="payment-requests"/>

BTCPayServer/Controllers/GreenField/GreenfieldReportsController.cs

@@ -0,0 +1,79 @@
+#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")]
+    public async Task<IActionResult> 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<StoreReportResponse.Field>(),
+                Charts = ctx.ViewDefinition?.Charts ?? new List<ChartDefinition>(),
+                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);
+        }
+    }
+}
+

BTCPayServer/Controllers/UIReportsController.CheatMode.cs

@@ -0,0 +1,114 @@
+#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<IList<object?>> Generate(IList<StoreReportResponse.Field> fields)
+    {
+        var rand = new Random();
+        int rowCount = 1_000;
+        List<object?> row = new List<object?>();
+        List<IList<object?>> result = new List<IList<object?>>();
+        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<object?>();
+        }
+        return result;
+    }
+
+    private object? GenerateData(IList<StoreReportResponse.Field> fields, StoreReportResponse.Field f, int fi, List<object?> row, Random rand)
+    {
+        byte[] GenerateBytes(int count)
+        {
+            var bytes = new byte[count];
+            rand.NextBytes(bytes);
+            return bytes;
+        }
+        T TakeOne<T>(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 == "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;
+    }
+}