btcpayserver/BTCPayServer/Services/Apps/AppService.cs

469 lines
18 KiB
C#
Raw Normal View History

2020-06-28 21:44:35 -05:00
using System;
2019-02-19 13:04:58 +09:00
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
2019-02-19 13:04:58 +09:00
using System.Globalization;
using System.IO;
using System.Linq;
using System.Threading.Tasks;
2023-05-26 16:49:32 +02:00
using BTCPayServer.Client;
2019-02-19 13:04:58 +09:00
using BTCPayServer.Data;
using BTCPayServer.Models.AppViewModels;
using BTCPayServer.Plugins.Crowdfund;
using BTCPayServer.Plugins.PointOfSale;
2022-07-18 20:51:53 +02:00
using BTCPayServer.Plugins.PointOfSale.Models;
2019-02-19 13:04:58 +09:00
using BTCPayServer.Services.Invoices;
using BTCPayServer.Services.Rates;
using BTCPayServer.Services.Stores;
2019-02-19 13:04:58 +09:00
using Ganss.XSS;
using Microsoft.EntityFrameworkCore;
using NBitcoin;
using NBitcoin.DataEncoders;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
2020-07-24 09:40:37 +02:00
using StoreData = BTCPayServer.Data.StoreData;
2019-02-19 13:04:58 +09:00
namespace BTCPayServer.Services.Apps
{
public class AppService
{
private readonly Dictionary<string, AppBaseType> _appTypes;
2023-05-23 02:18:57 +02:00
static AppService()
{
_defaultSerializer = new JsonSerializerSettings()
{
ContractResolver = new Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver(),
Formatting = Formatting.None
};
}
private static JsonSerializerSettings _defaultSerializer;
readonly ApplicationDbContextFactory _ContextFactory;
2019-02-19 13:04:58 +09:00
private readonly InvoiceRepository _InvoiceRepository;
readonly CurrencyNameTable _Currencies;
private readonly DisplayFormatter _displayFormatter;
private readonly StoreRepository _storeRepository;
2019-02-19 13:04:58 +09:00
private readonly HtmlSanitizer _HtmlSanitizer;
public CurrencyNameTable Currencies => _Currencies;
public AppService(
IEnumerable<AppBaseType> apps,
ApplicationDbContextFactory contextFactory,
InvoiceRepository invoiceRepository,
CurrencyNameTable currencies,
DisplayFormatter displayFormatter,
StoreRepository storeRepository,
HtmlSanitizer htmlSanitizer)
2019-02-19 13:04:58 +09:00
{
2023-04-10 11:07:03 +09:00
_appTypes = apps.ToDictionary(a => a.Type, a => a);
2019-02-19 13:04:58 +09:00
_ContextFactory = contextFactory;
_InvoiceRepository = invoiceRepository;
_Currencies = currencies;
_storeRepository = storeRepository;
2019-02-19 13:04:58 +09:00
_HtmlSanitizer = htmlSanitizer;
_displayFormatter = displayFormatter;
2019-02-19 13:04:58 +09:00
}
#nullable enable
public Dictionary<string, string> GetAvailableAppTypes()
2019-02-19 13:04:58 +09:00
{
return _appTypes.ToDictionary(app => app.Key, app => app.Value.Description);
}
public AppBaseType? GetAppType(string appType)
{
_appTypes.TryGetValue(appType, out var a);
return a;
}
public async Task<object?> GetInfo(string appId)
{
var appData = await GetApp(appId, null);
if (appData is null)
return null;
var appType = GetAppType(appData.AppType);
if (appType is null)
return null;
return appType.GetInfo(appData);
}
public async Task<IEnumerable<ItemStats>> GetItemStats(AppData appData)
{
if (GetAppType(appData.AppType) is not IHasItemStatsAppType salesType)
throw new InvalidOperationException("This app isn't a SalesAppBaseType");
2023-04-10 11:07:03 +09:00
var paidInvoices = await GetInvoicesForApp(_InvoiceRepository, appData,
null, new[]
{
InvoiceState.ToString(InvoiceStatusLegacy.Paid),
InvoiceState.ToString(InvoiceStatusLegacy.Confirmed),
InvoiceState.ToString(InvoiceStatusLegacy.Complete)
});
return await salesType.GetItemStats(appData, paidInvoices);
}
public static Task<SalesStats> GetSalesStatswithPOSItems(ViewPointOfSaleViewModel.Item[] items,
2023-04-10 11:07:03 +09:00
InvoiceEntity[] paidInvoices, int numberOfDays)
{
var series = paidInvoices
.Aggregate(new List<InvoiceStatsItem>(), AggregateInvoiceEntitiesForStats(items))
.GroupBy(entity => entity.Date)
.Select(entities => new SalesStatsItem
{
Date = entities.Key,
Label = entities.Key.ToString("MMM dd", CultureInfo.InvariantCulture),
SalesCount = entities.Count()
});
// fill up the gaps
foreach (var i in Enumerable.Range(0, numberOfDays))
{
var date = (DateTimeOffset.UtcNow - TimeSpan.FromDays(i)).Date;
if (!series.Any(e => e.Date == date))
{
series = series.Append(new SalesStatsItem
{
Date = date,
Label = date.ToString("MMM dd", CultureInfo.InvariantCulture)
});
}
}
return Task.FromResult(new SalesStats
{
SalesCount = series.Sum(i => i.SalesCount),
Series = series.OrderBy(i => i.Label)
});
}
2023-04-10 11:07:03 +09:00
public async Task<SalesStats> GetSalesStats(AppData app, int numberOfDays = 7)
{
if (GetAppType(app.AppType) is not IHasSaleStatsAppType salesType)
throw new InvalidOperationException("This app isn't a SalesAppBaseType");
var paidInvoices = await GetInvoicesForApp(_InvoiceRepository, app, DateTimeOffset.UtcNow - TimeSpan.FromDays(numberOfDays),
2023-04-10 11:07:03 +09:00
new[]
{
InvoiceState.ToString(InvoiceStatusLegacy.Paid),
InvoiceState.ToString(InvoiceStatusLegacy.Confirmed),
InvoiceState.ToString(InvoiceStatusLegacy.Complete)
});
2023-04-10 11:07:03 +09:00
return await salesType.GetSalesStats(app, paidInvoices, numberOfDays);
}
public class InvoiceStatsItem
{
public string ItemCode { get; set; } = string.Empty;
public decimal FiatPrice { get; set; }
public DateTime Date { get; set; }
}
public static Func<List<InvoiceStatsItem>, InvoiceEntity, List<InvoiceStatsItem>> AggregateInvoiceEntitiesForStats(ViewPointOfSaleViewModel.Item[] items)
{
return (res, e) =>
{
if (e.Metadata.PosData != null)
{
// flatten single items from POS data
var data = e.Metadata.PosData.ToObject<PosAppData>();
if (data is not { Cart.Length: > 0 })
return res;
foreach (var lineItem in data.Cart)
{
var item = items.FirstOrDefault(p => p.Id == lineItem.Id);
if (item == null)
continue;
for (var i = 0; i < lineItem.Count; i++)
{
res.Add(new InvoiceStatsItem
{
ItemCode = item.Id,
FiatPrice = lineItem.Price,
Date = e.InvoiceTime.Date
});
}
}
}
else
{;
res.Add(new InvoiceStatsItem
{
ItemCode = e.Metadata.ItemCode,
FiatPrice = e.PaidAmount.Net,
Date = e.InvoiceTime.Date
});
}
return res;
};
}
2023-04-10 11:07:03 +09:00
public static string GetAppOrderId(AppData app) => GetAppOrderId(app.AppType, app.Id);
public static string GetAppOrderId(string appType, string appId) =>
appType switch
{
CrowdfundAppType.AppType => $"crowdfund-app_{appId}",
PointOfSaleAppType.AppType => $"pos-app_{appId}",
_ => $"{appType}_{appId}"
};
2019-02-19 13:04:58 +09:00
public static string GetAppInternalTag(string appId) => $"APP#{appId}";
public static string[] GetAppInternalTags(InvoiceEntity invoice)
2019-02-19 13:04:58 +09:00
{
return invoice.GetInternalTags("APP#");
2019-02-19 13:04:58 +09:00
}
2023-04-10 11:07:03 +09:00
public static async Task<InvoiceEntity[]> GetInvoicesForApp(InvoiceRepository invoiceRepository, AppData appData, DateTimeOffset? startDate = null, string[]? status = null)
2019-02-19 13:04:58 +09:00
{
var invoices = await invoiceRepository.GetInvoices(new InvoiceQuery
2019-02-19 13:04:58 +09:00
{
StoreId = new[] { appData.StoreDataId },
OrderId = appData.TagAllInvoices ? null : new[] { GetAppOrderId(appData) },
2023-04-10 11:07:03 +09:00
Status = status ?? new[]{
InvoiceState.ToString(InvoiceStatusLegacy.New),
InvoiceState.ToString(InvoiceStatusLegacy.Paid),
InvoiceState.ToString(InvoiceStatusLegacy.Confirmed),
InvoiceState.ToString(InvoiceStatusLegacy.Complete)},
2019-02-19 13:04:58 +09:00
StartDate = startDate
});
// Old invoices may have invoices which were not tagged
2021-12-31 16:59:02 +09:00
invoices = invoices.Where(inv => appData.TagAllInvoices || inv.Version < InvoiceEntity.InternalTagSupport_Version ||
2019-02-19 13:04:58 +09:00
inv.InternalTags.Contains(GetAppInternalTag(appData.Id))).ToArray();
return invoices;
}
public async Task<bool> DeleteApp(AppData appData)
{
await using var ctx = _ContextFactory.CreateContext();
2022-01-14 17:50:29 +09:00
ctx.Apps.Add(appData);
ctx.Entry(appData).State = EntityState.Deleted;
return await ctx.SaveChangesAsync() == 1;
2019-02-19 13:04:58 +09:00
}
public async Task<ListAppsViewModel.ListAppViewModel[]> GetAllApps(string? userId, bool allowNoUser = false, string? storeId = null)
2019-02-19 13:04:58 +09:00
{
await using var ctx = _ContextFactory.CreateContext();
2023-05-26 16:49:32 +02:00
var listApps = (await ctx.UserStore
2022-01-14 17:50:29 +09:00
.Where(us =>
(allowNoUser && string.IsNullOrEmpty(userId) || us.ApplicationUserId == userId) &&
(storeId == null || us.StoreDataId == storeId))
2023-05-26 16:49:32 +02:00
.Include(store => store.StoreRole)
.Include(store => store.StoreData)
.Join(ctx.Apps, us => us.StoreDataId, app => app.StoreDataId, (us, app) => new { us, app })
.OrderBy(b => b.app.Created)
.ToArrayAsync()).Select(arg => new ListAppsViewModel.ListAppViewModel
{
Role = StoreRepository.ToStoreRole(arg.us.StoreRole),
StoreId = arg.us.StoreDataId,
StoreName = arg.us.StoreData.StoreName,
AppName = arg.app.Name,
AppType = arg.app.AppType,
Id = arg.app.Id,
Created = arg.app.Created,
App = arg.app
}).ToArray();
2023-04-10 11:07:03 +09:00
// allowNoUser can lead to apps being included twice, unify them with distinct
if (allowNoUser)
{
listApps = listApps.DistinctBy(a => a.Id).ToArray();
}
2022-01-14 17:50:29 +09:00
foreach (ListAppsViewModel.ListAppViewModel app in listApps)
2019-02-19 13:04:58 +09:00
{
app.ViewStyle = GetAppViewStyle(app.App, app.AppType);
2019-02-19 13:04:58 +09:00
}
2022-01-14 17:50:29 +09:00
return listApps;
2019-02-19 13:04:58 +09:00
}
2021-12-31 16:59:02 +09:00
public string GetAppViewStyle(AppData app, string appType)
2021-11-02 14:55:31 -04:00
{
string style;
switch (appType)
2021-11-02 14:55:31 -04:00
{
case PointOfSaleAppType.AppType:
var settings = app.GetSettings<PointOfSaleSettings>();
2021-11-02 14:55:31 -04:00
string posViewStyle = (settings.EnableShoppingCart ? PosViewType.Cart : settings.DefaultView).ToString();
style = typeof(PosViewType).DisplayName(posViewStyle);
break;
2023-04-10 11:07:03 +09:00
2021-11-02 14:55:31 -04:00
default:
style = string.Empty;
break;
}
return style;
}
2020-06-28 17:55:27 +09:00
public async Task<List<AppData>> GetApps(string[] appIds, bool includeStore = false)
{
await using var ctx = _ContextFactory.CreateContext();
2022-01-14 17:50:29 +09:00
var query = ctx.Apps
.Where(app => appIds.Contains(app.Id));
2022-01-14 17:50:29 +09:00
if (includeStore)
{
query = query.Include(data => data.StoreData);
}
2022-01-14 17:50:29 +09:00
return await query.ToListAsync();
}
2019-02-19 13:04:58 +09:00
public async Task<List<AppData>> GetApps(string appType)
2019-02-19 13:04:58 +09:00
{
await using var ctx = _ContextFactory.CreateContext();
var query = ctx.Apps
.Where(app => app.AppType == appType);
return await query.ToListAsync();
}
public async Task<AppData?> GetApp(string appId, string? appType, bool includeStore = false)
{
await using var ctx = _ContextFactory.CreateContext();
2022-01-14 17:50:29 +09:00
var query = ctx.Apps
.Where(us => us.Id == appId &&
(appType == null || us.AppType == appType));
2019-02-19 13:04:58 +09:00
2022-01-14 17:50:29 +09:00
if (includeStore)
{
query = query.Include(data => data.StoreData);
2019-02-19 13:04:58 +09:00
}
2022-01-14 17:50:29 +09:00
return await query.FirstOrDefaultAsync();
2019-02-19 13:04:58 +09:00
}
public Task<StoreData?> GetStore(AppData app)
2019-02-19 13:04:58 +09:00
{
return _storeRepository.FindStore(app.StoreDataId);
2019-02-19 13:04:58 +09:00
}
2023-05-23 02:18:57 +02:00
2019-02-19 13:04:58 +09:00
2023-05-23 02:18:57 +02:00
public static string SerializeTemplate(ViewPointOfSaleViewModel.Item[] items)
{
2023-05-23 02:18:57 +02:00
return JsonConvert.SerializeObject(items, Formatting.Indented, _defaultSerializer);
}
2023-05-23 02:18:57 +02:00
public static ViewPointOfSaleViewModel.Item[] Parse(string template, bool includeDisabled = true)
2019-02-19 13:04:58 +09:00
{
if (string.IsNullOrWhiteSpace(template))
return Array.Empty<ViewPointOfSaleViewModel.Item>();
2023-05-23 02:18:57 +02:00
return JsonConvert.DeserializeObject<ViewPointOfSaleViewModel.Item[]>(template, _defaultSerializer)!.Where(item => includeDisabled || !item.Disabled).ToArray();
2019-02-19 13:04:58 +09:00
}
#nullable restore
#nullable enable
public async Task<AppData?> GetAppDataIfOwner(string userId, string appId, string? type = null)
2019-02-19 13:04:58 +09:00
{
if (userId == null || appId == null)
return null;
await using var ctx = _ContextFactory.CreateContext();
2022-01-14 17:50:29 +09:00
var app = await ctx.UserStore
2023-05-26 16:49:32 +02:00
.Include(store => store.StoreRole)
.Where(us => us.ApplicationUserId == userId && us.StoreRole.Permissions.Contains(Policies.CanModifyStoreSettings))
2022-01-14 17:50:29 +09:00
.SelectMany(us => us.StoreData.Apps.Where(a => a.Id == appId))
.FirstOrDefaultAsync();
if (app == null)
return null;
if (type != null && type != app.AppType)
2022-01-14 17:50:29 +09:00
return null;
return app;
2019-02-19 13:04:58 +09:00
}
public async Task UpdateOrCreateApp(AppData app)
{
await using var ctx = _ContextFactory.CreateContext();
2022-01-14 17:50:29 +09:00
if (string.IsNullOrEmpty(app.Id))
{
2022-01-14 17:50:29 +09:00
app.Id = Encoders.Base58.EncodeData(RandomUtils.GetBytes(20));
app.Created = DateTimeOffset.UtcNow;
await ctx.Apps.AddAsync(app);
}
else
{
ctx.Apps.Update(app);
ctx.Entry(app).Property(data => data.Created).IsModified = false;
ctx.Entry(app).Property(data => data.Id).IsModified = false;
ctx.Entry(app).Property(data => data.AppType).IsModified = false;
}
2022-01-14 17:50:29 +09:00
await ctx.SaveChangesAsync();
}
2020-06-28 17:55:27 +09:00
private static bool TryParseJson(string json, [MaybeNullWhen(false)] out JObject result)
{
result = null;
try
{
result = JObject.Parse(json);
return true;
}
catch
{
return false;
}
}
#nullable enable
public static bool TryParsePosCartItems(JObject? posData, [MaybeNullWhen(false)] out Dictionary<string, int> cartItems)
{
cartItems = null;
if (posData is null)
return false;
if (!posData.TryGetValue("cart", out var cartObject))
return false;
if (cartObject is null)
2020-06-28 17:55:27 +09:00
return false;
cartItems = new();
foreach (var o in cartObject.OfType<JObject>())
{
var id = o.GetValue("id", StringComparison.InvariantCulture)?.ToString();
if (id != null)
{
var countStr = o.GetValue("count", StringComparison.InvariantCulture)?.ToString() ?? string.Empty;
if (int.TryParse(countStr, out var count))
{
cartItems.TryAdd(id, count);
}
}
}
return true;
}
public async Task SetDefaultSettings(AppData appData, string defaultCurrency)
{
var app = GetAppType(appData.AppType);
if (app is null)
{
appData.SetSettings(null);
}
else
{
await app.SetDefaultSettings(appData, defaultCurrency);
}
}
public async Task<string?> ViewLink(AppData app)
{
var appType = GetAppType(app.AppType);
return await appType?.ViewLink(app)!;
}
#nullable restore
2019-02-19 13:04:58 +09:00
}
public class ItemStats
{
public string ItemCode { get; set; }
public string Title { get; set; }
public int SalesCount { get; set; }
public decimal Total { get; set; }
public string TotalFormatted { get; set; }
}
public class SalesStats
{
public int SalesCount { get; set; }
public IEnumerable<SalesStatsItem> Series { get; set; }
}
public class SalesStatsItem
{
public DateTime Date { get; set; }
public string Label { get; set; }
public int SalesCount { get; set; }
}
2019-02-19 13:04:58 +09:00
}