From e8282ca849c4829cb2b9ae77dee62e7b3715d8f3 Mon Sep 17 00:00:00 2001 From: Nicolas Dorier Date: Sun, 19 Oct 2025 22:31:24 +0900 Subject: [PATCH] Refactoring of Webhooks and Email Rules (#6954) --- BTCPayServer.Common/TextTemplate.cs | 127 +++++++ BTCPayServer.Data/ApplicationDbContext.cs | 4 +- BTCPayServer.Data/Data/BaseEntityData.cs | 82 +++++ BTCPayServer.Data/Data/EmailRuleData.cs | 77 +++++ BTCPayServer.Data/Data/PendingTransaction.cs | 10 +- BTCPayServer.Data/Data/WebhookDeliveryData.cs | 4 + .../Migrations/20251015142818_emailrules.cs | 82 +++++ .../ApplicationDbContextModelSnapshot.cs | 73 ++++ BTCPayServer.Tests/GreenfieldAPITests.cs | 3 +- BTCPayServer.Tests/MailPitClient.cs | 193 +++++++++++ BTCPayServer.Tests/PMO/ConfigureEmailPMO.cs | 48 +++ BTCPayServer.Tests/PMO/EmailRulePMO.cs | 34 ++ BTCPayServer.Tests/PlaywrightTests.cs | 105 ++++-- BTCPayServer.Tests/ServerTester.cs | 21 ++ BTCPayServer.Tests/UnitTest1.cs | 120 ++++++- .../docker-compose.altcoins.yml | 15 + BTCPayServer.Tests/docker-compose.yml | 15 + .../Components/MainNav/Default.cshtml | 5 +- .../GreenfieldPaymentRequestsController.cs | 5 +- .../GreenField/LocalBTCPayServerClient.cs | 1 + .../Controllers/UIInvoiceController.UI.cs | 3 +- .../Controllers/UIInvoiceController.cs | 5 +- .../Controllers/UIPaymentRequestController.cs | 43 ++- .../Controllers/UIServerController.cs | 40 ++- .../UIStoresController.EmailRules.cs | 154 --------- .../Controllers/UIStoresController.cs | 10 +- .../Controllers/UIWalletsController.PSBT.cs | 2 +- .../Controllers/UIWalletsController.cs | 4 +- BTCPayServer/Data/PaymentRequestBlob.cs | 1 + BTCPayServer/Data/StoreBlob.cs | 5 - BTCPayServer/Events/EmailSentEvent.cs | 10 + BTCPayServer/Extensions.cs | 3 - .../Extensions/UrlHelperExtensions.cs | 14 + .../PendingTransactionService.cs | 26 +- .../HostedServices/PluginUpdateFetcher.cs | 2 +- .../StoreEmailRuleProcessorSender.cs | 87 ----- .../Webhooks/IWebhookProvider.cs | 14 - .../Webhooks/InvoiceWebhookDeliveryRequest.cs | 55 --- .../Webhooks/InvoiceWebhookProvider.cs | 113 ------ .../PaymentRequestWebhookDeliveryRequest.cs | 54 --- .../Webhooks/PaymentRequestWebhookProvider.cs | 65 ---- .../Webhooks/PayoutWebhookDeliveryRequest.cs | 39 --- .../Webhooks/PayoutWebhookProvider.cs | 67 ---- .../PendingTransactionDeliveryRequest.cs | 48 --- .../PendingTransactionWebhookProvider.cs | 89 ----- .../Webhooks/WebhookExtensions.cs | 55 --- .../Webhooks/WebhookProvider.cs | 45 --- BTCPayServer/Hosting/BTCPayServerServices.cs | 13 - BTCPayServer/Hosting/Startup.cs | 2 + .../InvoicingModels/InvoiceDetailsModel.cs | 3 +- .../StoreViewModels/TestWebhookViewModel.cs | 9 - .../UIStoreEmailRulesController.cs | 157 +++++++++ .../Controllers/UIStoresEmailController.cs} | 49 ++- .../Plugins/Emails/EmailsExtensions.cs | 14 + BTCPayServer/Plugins/Emails/EmailsPlugin.cs | 21 ++ .../Emails/EmailsTranslationProvider.cs | 18 + .../Plugins/Emails/LinkGeneratorExtensions.cs | 23 ++ .../Emails/StoreEmailRuleProcessorSender.cs | 84 +++++ .../Emails/Views/EmailTriggerViewModel.cs | 23 ++ .../Emails/Views/StoreEmailRuleViewModel.cs | 53 +++ .../StoreEmailRulesList.cshtml | 34 +- .../StoreEmailRulesManage.cshtml | 161 +++++++++ .../UIStoresEmail/StoreEmailSettings.cshtml | 55 +++ .../Plugins/Emails/Views/_ViewImports.cshtml | 9 + .../Plugins/Emails/Views/_ViewStart.cshtml | 3 + BTCPayServer/Plugins/PluginBuilderClient.cs | 12 +- BTCPayServer/Plugins/PluginService.cs | 7 +- .../GreenfieldStoreWebhooksController.cs | 3 +- .../Controllers/UIStoreWebhooksController.cs} | 85 ++--- .../CleanupWebhookDeliveriesTask.cs | 5 +- .../WebhookProviderHostedService.cs | 76 +++++ .../InvoiceTriggerProvider.cs | 91 +++++ .../PaymentRequestTriggerProvider.cs | 79 +++++ .../TriggerProviders/PayoutTriggerProvider.cs | 44 +++ .../PendingTransactionTriggerProvider.cs | 80 +++++ .../Views/AvailableWebhookViewModel.cs | 12 + .../Webhooks/Views}/EditWebhookViewModel.cs | 6 +- .../Webhooks/Views}/ModifyWebhook.cshtml | 9 +- .../Webhooks/Views}/Webhooks.cshtml | 2 - .../Webhooks/Views}/WebhooksViewModel.cs | 2 +- .../Webhooks/Views/_ViewImports.cshtml | 6 + .../Plugins/Webhooks/Views/_ViewStart.cshtml | 3 + .../Webhooks}/WebhookDataExtensions.cs | 8 +- .../Plugins/Webhooks/WebhookExtensions.cs | 32 ++ .../Webhooks/WebhookSender.cs | 123 +------ .../Plugins/Webhooks/WebhookTriggerContext.cs | 19 ++ .../Webhooks/WebhookTriggerProvider.cs | 54 +++ .../Plugins/Webhooks/WebhooksPlugin.cs | 321 ++++++++++++++++++ .../Webhooks/WebhooksTranslationProvider.cs | 15 + .../Services/Invoices/InvoiceEntity.cs | 3 + BTCPayServer/Services/Mails/EmailSender.cs | 11 +- .../Services/Mails/EmailSenderFactory.cs | 7 +- .../Services/Mails/ServerEmailSender.cs | 10 +- .../Services/Mails/StoreEmailSender.cs | 11 +- .../PaymentRequestRepository.cs | 17 +- .../Shared/NotificationEmailWarning.cshtml | 3 +- .../EditPaymentRequest.cshtml | 10 +- BTCPayServer/Views/UIServer/Emails.cshtml | 5 +- .../UIStores/StoreEmailRulesManage.cshtml | 257 -------------- .../Views/UIStores/StoreEmailSettings.cshtml | 49 --- .../Views/UIStores/TestWebhook.cshtml | 26 -- 101 files changed, 2700 insertions(+), 1611 deletions(-) create mode 100644 BTCPayServer.Common/TextTemplate.cs create mode 100644 BTCPayServer.Data/Data/BaseEntityData.cs create mode 100644 BTCPayServer.Data/Data/EmailRuleData.cs create mode 100644 BTCPayServer.Data/Migrations/20251015142818_emailrules.cs create mode 100644 BTCPayServer.Tests/MailPitClient.cs create mode 100644 BTCPayServer.Tests/PMO/ConfigureEmailPMO.cs create mode 100644 BTCPayServer.Tests/PMO/EmailRulePMO.cs delete mode 100644 BTCPayServer/Controllers/UIStoresController.EmailRules.cs create mode 100644 BTCPayServer/Events/EmailSentEvent.cs delete mode 100644 BTCPayServer/HostedServices/StoreEmailRuleProcessorSender.cs delete mode 100644 BTCPayServer/HostedServices/Webhooks/IWebhookProvider.cs delete mode 100644 BTCPayServer/HostedServices/Webhooks/InvoiceWebhookDeliveryRequest.cs delete mode 100644 BTCPayServer/HostedServices/Webhooks/InvoiceWebhookProvider.cs delete mode 100644 BTCPayServer/HostedServices/Webhooks/PaymentRequestWebhookDeliveryRequest.cs delete mode 100644 BTCPayServer/HostedServices/Webhooks/PaymentRequestWebhookProvider.cs delete mode 100644 BTCPayServer/HostedServices/Webhooks/PayoutWebhookDeliveryRequest.cs delete mode 100644 BTCPayServer/HostedServices/Webhooks/PayoutWebhookProvider.cs delete mode 100644 BTCPayServer/HostedServices/Webhooks/PendingTransactionDeliveryRequest.cs delete mode 100644 BTCPayServer/HostedServices/Webhooks/PendingTransactionWebhookProvider.cs delete mode 100644 BTCPayServer/HostedServices/Webhooks/WebhookExtensions.cs delete mode 100644 BTCPayServer/HostedServices/Webhooks/WebhookProvider.cs delete mode 100644 BTCPayServer/Models/StoreViewModels/TestWebhookViewModel.cs create mode 100644 BTCPayServer/Plugins/Emails/Controllers/UIStoreEmailRulesController.cs rename BTCPayServer/{Controllers/UIStoresController.Email.cs => Plugins/Emails/Controllers/UIStoresEmailController.cs} (70%) create mode 100644 BTCPayServer/Plugins/Emails/EmailsExtensions.cs create mode 100644 BTCPayServer/Plugins/Emails/EmailsPlugin.cs create mode 100644 BTCPayServer/Plugins/Emails/EmailsTranslationProvider.cs create mode 100644 BTCPayServer/Plugins/Emails/LinkGeneratorExtensions.cs create mode 100644 BTCPayServer/Plugins/Emails/StoreEmailRuleProcessorSender.cs create mode 100644 BTCPayServer/Plugins/Emails/Views/EmailTriggerViewModel.cs create mode 100644 BTCPayServer/Plugins/Emails/Views/StoreEmailRuleViewModel.cs rename BTCPayServer/{Views/UIStores => Plugins/Emails/Views/UIStoreEmailRules}/StoreEmailRulesList.cshtml (60%) create mode 100644 BTCPayServer/Plugins/Emails/Views/UIStoreEmailRules/StoreEmailRulesManage.cshtml create mode 100644 BTCPayServer/Plugins/Emails/Views/UIStoresEmail/StoreEmailSettings.cshtml create mode 100644 BTCPayServer/Plugins/Emails/Views/_ViewImports.cshtml create mode 100644 BTCPayServer/Plugins/Emails/Views/_ViewStart.cshtml rename BTCPayServer/{Controllers/GreenField => Plugins/Webhooks/Controllers}/GreenfieldStoreWebhooksController.cs (98%) rename BTCPayServer/{Controllers/UIStoresController.Integrations.cs => Plugins/Webhooks/Controllers/UIStoreWebhooksController.cs} (62%) rename BTCPayServer/{ => Plugins/Webhooks}/HostedServices/CleanupWebhookDeliveriesTask.cs (94%) create mode 100644 BTCPayServer/Plugins/Webhooks/HostedServices/WebhookProviderHostedService.cs create mode 100644 BTCPayServer/Plugins/Webhooks/TriggerProviders/InvoiceTriggerProvider.cs create mode 100644 BTCPayServer/Plugins/Webhooks/TriggerProviders/PaymentRequestTriggerProvider.cs create mode 100644 BTCPayServer/Plugins/Webhooks/TriggerProviders/PayoutTriggerProvider.cs create mode 100644 BTCPayServer/Plugins/Webhooks/TriggerProviders/PendingTransactionTriggerProvider.cs create mode 100644 BTCPayServer/Plugins/Webhooks/Views/AvailableWebhookViewModel.cs rename BTCPayServer/{Models/StoreViewModels => Plugins/Webhooks/Views}/EditWebhookViewModel.cs (95%) rename BTCPayServer/{Views/UIStores => Plugins/Webhooks/Views}/ModifyWebhook.cshtml (94%) rename BTCPayServer/{Views/UIStores => Plugins/Webhooks/Views}/Webhooks.cshtml (94%) rename BTCPayServer/{Models/StoreViewModels => Plugins/Webhooks/Views}/WebhooksViewModel.cs (91%) create mode 100644 BTCPayServer/Plugins/Webhooks/Views/_ViewImports.cshtml create mode 100644 BTCPayServer/Plugins/Webhooks/Views/_ViewStart.cshtml rename BTCPayServer/{Data => Plugins/Webhooks}/WebhookDataExtensions.cs (94%) create mode 100644 BTCPayServer/Plugins/Webhooks/WebhookExtensions.cs rename BTCPayServer/{HostedServices => Plugins}/Webhooks/WebhookSender.cs (63%) create mode 100644 BTCPayServer/Plugins/Webhooks/WebhookTriggerContext.cs create mode 100644 BTCPayServer/Plugins/Webhooks/WebhookTriggerProvider.cs create mode 100644 BTCPayServer/Plugins/Webhooks/WebhooksPlugin.cs create mode 100644 BTCPayServer/Plugins/Webhooks/WebhooksTranslationProvider.cs delete mode 100644 BTCPayServer/Views/UIStores/StoreEmailRulesManage.cshtml delete mode 100644 BTCPayServer/Views/UIStores/StoreEmailSettings.cshtml delete mode 100644 BTCPayServer/Views/UIStores/TestWebhook.cshtml diff --git a/BTCPayServer.Common/TextTemplate.cs b/BTCPayServer.Common/TextTemplate.cs new file mode 100644 index 000000000..faddf8408 --- /dev/null +++ b/BTCPayServer.Common/TextTemplate.cs @@ -0,0 +1,127 @@ +#nullable enable +using System; +using System.Collections.Generic; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json.Linq; + +namespace BTCPayServer; + +public class TextTemplate(string template) +{ + static readonly Regex _interpolationRegex = new Regex(@"\{([^}]+)\}", RegexOptions.Compiled | RegexOptions.CultureInvariant); + public string Render(JObject model) + { + model = (JObject)ToLowerCase(model); + return _interpolationRegex.Replace(template, match => + { + var path = match.Groups[1].Value; + var initial = path; + if (!path.StartsWith("$.")) + path = $"$.{path}"; + path = path.ToLowerInvariant(); + try + { + var token = model.SelectToken(path); + return token?.ToString() ?? $""; + } + catch + { + return $""; + } + }); + } + + public List GetPaths(JObject model) + { + var paths = new List>(); + GetAvailablePaths(model, paths, null); + + List result = new List(); + foreach (var path in paths) + { + StringBuilder builder = new StringBuilder(); + builder.Append('{'); + int i = 0; + foreach (var p in path) + { + if (i != 0 && !p.StartsWith("[")) + builder.Append('.'); + + builder.Append(p); + i++; + } + builder.Append('}'); + result.Add(builder.ToString()); + } + return result; + } + + private void GetAvailablePaths(JToken tok, List> paths, List? currentPath) + { + if (tok is JProperty prop) + { + if (currentPath is null) + { + currentPath = new List(); + } + currentPath.Add(prop.Name); + GetAvailablePaths(prop.Value, paths, currentPath); + } + else if (tok is JValue) + { + if (currentPath is not null) + paths.Add(currentPath); + } + if (tok is JObject obj) + { + foreach (var p in obj.Properties()) + { + var newPath = currentPath is null ? new List() : new List(currentPath); + GetAvailablePaths(p, paths, newPath); + } + } + if (tok is JArray arr) + { + int i = 0; + foreach (var tokChild in arr) + { + var newPath = currentPath is null ? new List() : new List(currentPath); + newPath.Add($"[{i++}]"); + GetAvailablePaths(tokChild, paths, newPath); + } + } + } + + private JToken ToLowerCase(JToken model) + { + if (model is JProperty obj) + return new JProperty(obj.Name.ToLowerInvariant(), ToLowerCase(obj.Value)); + if (model is JArray arr) + { + var copy = new JArray(); + foreach (var item in arr) + { + copy.Add(ToLowerCase(item)); + } + return copy; + } + if (model is JObject) + { + var copy = new JObject(); + foreach (var prop in model.Children()) + { + var newProp = (JProperty)ToLowerCase(prop); + if (copy.Property(newProp.Name) is { } existing) + { + if (existing.Value is JObject exJobj) + exJobj.Merge(newProp.Value); + } + else + copy.Add(newProp); + } + return copy; + } + return model.DeepClone(); + } +} diff --git a/BTCPayServer.Data/ApplicationDbContext.cs b/BTCPayServer.Data/ApplicationDbContext.cs index bd3d0e32c..8de6923ad 100644 --- a/BTCPayServer.Data/ApplicationDbContext.cs +++ b/BTCPayServer.Data/ApplicationDbContext.cs @@ -65,12 +65,14 @@ namespace BTCPayServer.Data public DbSet Forms { get; set; } public DbSet PendingTransactions { get; set; } + public DbSet EmailRules { get; set; } + protected override void OnModelCreating(ModelBuilder builder) { base.OnModelCreating(builder); // some of the data models don't have OnModelCreating for now, commenting them - + EmailRuleData.OnModelCreating(builder, Database); ApplicationUser.OnModelCreating(builder, Database); AddressInvoiceData.OnModelCreating(builder); APIKeyData.OnModelCreating(builder, Database); diff --git a/BTCPayServer.Data/Data/BaseEntityData.cs b/BTCPayServer.Data/Data/BaseEntityData.cs new file mode 100644 index 000000000..ba77957ba --- /dev/null +++ b/BTCPayServer.Data/Data/BaseEntityData.cs @@ -0,0 +1,82 @@ +#nullable enable + +using System; +using System.ComponentModel.DataAnnotations.Schema; +using System.IO; +using Microsoft.EntityFrameworkCore; +using Microsoft.EntityFrameworkCore.Infrastructure; +using Microsoft.EntityFrameworkCore.Metadata.Builders; +using NBitcoin; +using NBitcoin.DataEncoders; +using Newtonsoft.Json; +using Newtonsoft.Json.Linq; + +namespace BTCPayServer.Data; + +public class BaseEntityData +{ + static BaseEntityData() + { + Settings = new JsonSerializerSettings() + { + ContractResolver = new Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver(), + DefaultValueHandling = DefaultValueHandling.Ignore + }; + Serializer = JsonSerializer.Create(Settings); + } + public static readonly JsonSerializerSettings Settings; + public static readonly JsonSerializer Serializer; + + /// + /// User-defined custom data + /// + [Column("metadata", TypeName = "jsonb")] + public string Metadata { get; set; } = "{}"; + + /// + /// Data that is not user-defined, but can be used and extended internally by BTCPay Server or plugins. + /// + [Column("additional_data", TypeName = "jsonb")] + public string AdditionalData { get; set; } = "{}"; + + [Column("created_at", TypeName = "timestamptz")] + public DateTimeOffset CreatedAt { get; set; } = DateTimeOffset.UtcNow; + + public T? GetAdditionalData(string key) where T: class + => JObject.Parse(AdditionalData)[key]?.ToObject(Serializer); + + public void SetAdditionalData(string key, T? obj) + { + if (obj is null) + { + RemoveAdditionalData(key); + } + else + { + var w = new StringWriter(); + Serializer.Serialize(w, obj); + w.Flush(); + var jobj = JObject.Parse(AdditionalData); + jobj[key] = JToken.Parse(w.ToString()); + AdditionalData = jobj.ToString(); + } + } + public void RemoveAdditionalData(string key) + { + var jobj = JObject.Parse(AdditionalData); + jobj.Remove(key); + AdditionalData = jobj.ToString(); + } + + public static string GenerateId() => Encoders.Base58.EncodeData(RandomUtils.GetBytes(13)); + + protected static void OnModelCreateBase(EntityTypeBuilder b, ModelBuilder builder, DatabaseFacade databaseFacade) where TEntity : BaseEntityData + { + b.Property(x => x.CreatedAt).HasColumnName("created_at").HasColumnType("timestamptz") + .HasDefaultValueSql("now()"); + b.Property(x => x.Metadata).HasColumnName("metadata").HasColumnType("jsonb") + .HasDefaultValueSql("'{}'::jsonb"); + b.Property(x => x.AdditionalData).HasColumnName("additional_data").HasColumnType("jsonb") + .HasDefaultValueSql("'{}'::jsonb"); + } +} diff --git a/BTCPayServer.Data/Data/EmailRuleData.cs b/BTCPayServer.Data/Data/EmailRuleData.cs new file mode 100644 index 000000000..c874753d7 --- /dev/null +++ b/BTCPayServer.Data/Data/EmailRuleData.cs @@ -0,0 +1,77 @@ +#nullable enable +using System; +using System.ComponentModel.DataAnnotations; +using System.ComponentModel.DataAnnotations.Schema; +using System.Linq; +using System.Threading.Tasks; +using Microsoft.EntityFrameworkCore; +using Microsoft.EntityFrameworkCore.Infrastructure; +using Newtonsoft.Json.Linq; + +namespace BTCPayServer.Data; + +[Table("email_rules")] +public class EmailRuleData : BaseEntityData +{ + public static string GetWebhookTriggerName(string webhookType) => $"WH-{webhookType}"; + [Column("store_id")] + public string? StoreId { get; set; } + + [Key] + public long Id { get; set; } + + [ForeignKey(nameof(StoreId))] + public StoreData? Store { get; set; } + + [Required] + [Column("trigger")] + public string Trigger { get; set; } = null!; + + [Column("condition")] + public string? Condition { get; set; } + + [Required] + [Column("to")] + public string[] To { get; set; } = null!; + + [Required] + [Column("subject")] + public string Subject { get; set; } = null!; + [Required] + [Column("body")] + public string Body { get; set; } = null!; + + public class BTCPayAdditionalData + { + public bool CustomerEmail { get; set; } + } + public BTCPayAdditionalData? GetBTCPayAdditionalData() => this.GetAdditionalData("btcpay"); + public void SetBTCPayAdditionalData(BTCPayAdditionalData? data) => this.SetAdditionalData("btcpay", data); + + internal static void OnModelCreating(ModelBuilder builder, DatabaseFacade databaseFacade) + { + var b = builder.Entity(); + BaseEntityData.OnModelCreateBase(b, builder, databaseFacade); + b.Property(o => o.Id).UseIdentityAlwaysColumn(); + b.HasOne(o => o.Store).WithMany().OnDelete(DeleteBehavior.Cascade); + b.HasIndex(o => o.StoreId); + } +} +public static partial class ApplicationDbContextExtensions +{ + public static IQueryable GetRules(this IQueryable query, string storeId) + => query.Where(o => o.StoreId == storeId) + .OrderBy(o => o.Id); + + public static Task GetMatches(this DbSet set, string? storeId, string trigger, JObject model) + => set + .FromSqlInterpolated($""" + SELECT * FROM email_rules + WHERE store_id IS NOT DISTINCT FROM {storeId} AND trigger = {trigger} AND (condition IS NULL OR jsonb_path_exists({model.ToString()}::JSONB, condition::JSONPATH)) + """) + .ToArrayAsync(); + + public static Task GetRule(this IQueryable query, string storeId, long id) + => query.Where(o => o.StoreId == storeId && o.Id == id) + .FirstOrDefaultAsync(); +} diff --git a/BTCPayServer.Data/Data/PendingTransaction.cs b/BTCPayServer.Data/Data/PendingTransaction.cs index f968087af..ef1e3e80b 100644 --- a/BTCPayServer.Data/Data/PendingTransaction.cs +++ b/BTCPayServer.Data/Data/PendingTransaction.cs @@ -1,8 +1,11 @@ using System; using System.Collections.Generic; using System.ComponentModel.DataAnnotations.Schema; +using System.Text.Json.Serialization; +using BTCPayServer.Abstractions; using Microsoft.EntityFrameworkCore; using Microsoft.EntityFrameworkCore.Infrastructure; +using Newtonsoft.Json; namespace BTCPayServer.Data; @@ -21,8 +24,8 @@ public class PendingTransaction: IHasBlob public byte[] Blob { get; set; } public string Blob2 { get; set; } - - + + internal static void OnModelCreating(ModelBuilder builder, DatabaseFacade databaseFacade) { builder.Entity() @@ -37,7 +40,7 @@ public class PendingTransaction: IHasBlob builder.Entity() .Property(o => o.Blob2) - .HasColumnType("JSONB"); + .HasColumnType("JSONB"); builder.Entity() .Property(o => o.OutpointsUsed) .HasColumnType("text[]"); @@ -56,6 +59,7 @@ public class PendingTransaction: IHasBlob public class PendingTransactionBlob { public string PSBT { get; set; } + public string RequestBaseUrl { get; set; } public List CollectedSignatures { get; set; } = new(); public int? SignaturesCollected { get; set; } diff --git a/BTCPayServer.Data/Data/WebhookDeliveryData.cs b/BTCPayServer.Data/Data/WebhookDeliveryData.cs index 977834f9d..673a1e63a 100644 --- a/BTCPayServer.Data/Data/WebhookDeliveryData.cs +++ b/BTCPayServer.Data/Data/WebhookDeliveryData.cs @@ -2,11 +2,15 @@ using System; using System.ComponentModel.DataAnnotations; using Microsoft.EntityFrameworkCore; using Microsoft.EntityFrameworkCore.Infrastructure; +using NBitcoin; +using NBitcoin.DataEncoders; namespace BTCPayServer.Data { public class WebhookDeliveryData { + public static WebhookDeliveryData Create(string webhookId) + => new WebhookDeliveryData { Id = Encoders.Base58.EncodeData(RandomUtils.GetBytes(16)), Timestamp = DateTimeOffset.UtcNow, WebhookId = webhookId }; [Key] [MaxLength(25)] public string Id { get; set; } diff --git a/BTCPayServer.Data/Migrations/20251015142818_emailrules.cs b/BTCPayServer.Data/Migrations/20251015142818_emailrules.cs new file mode 100644 index 000000000..16a901fb7 --- /dev/null +++ b/BTCPayServer.Data/Migrations/20251015142818_emailrules.cs @@ -0,0 +1,82 @@ +using System; +using BTCPayServer.Data; +using Microsoft.EntityFrameworkCore.Infrastructure; +using Microsoft.EntityFrameworkCore.Migrations; +using Npgsql.EntityFrameworkCore.PostgreSQL.Metadata; + +#nullable disable + +namespace BTCPayServer.Migrations +{ + [DbContext(typeof(ApplicationDbContext))] + [Migration("20251015142818_emailrules")] + public partial class emailrules : Migration + { + /// + protected override void Up(MigrationBuilder migrationBuilder) + { + migrationBuilder.CreateTable( + name: "email_rules", + columns: table => new + { + Id = table.Column(type: "bigint", nullable: false) + .Annotation("Npgsql:ValueGenerationStrategy", NpgsqlValueGenerationStrategy.IdentityAlwaysColumn), + store_id = table.Column(type: "text", nullable: true), + trigger = table.Column(type: "text", nullable: false), + condition = table.Column(type: "text", nullable: true), + to = table.Column(type: "text[]", nullable: false), + subject = table.Column(type: "text", nullable: false, defaultValue: ""), + body = table.Column(type: "text", nullable: false), + metadata = table.Column(type: "jsonb", nullable: false, defaultValueSql: "'{}'::jsonb"), + additional_data = table.Column(type: "jsonb", nullable: false, defaultValueSql: "'{}'::jsonb"), + created_at = table.Column(type: "timestamptz", nullable: false, defaultValueSql: "now()") + }, + constraints: table => + { + table.PrimaryKey("PK_email_rules", x => x.Id); + table.ForeignKey( + name: "FK_email_rules_Stores_store_id", + column: x => x.store_id, + principalTable: "Stores", + principalColumn: "Id", + onDelete: ReferentialAction.Cascade); + }); + + migrationBuilder.CreateIndex( + name: "IX_email_rules_store_id", + table: "email_rules", + column: "store_id"); + + migrationBuilder.Sql( + """ + INSERT INTO email_rules (store_id, "to", subject, body, "trigger", additional_data) + SELECT + s."Id" AS store_id, + COALESCE(string_to_array(x."to", ','), ARRAY[]::text[]), + COALESCE(x.subject, ''), + COALESCE(x.body, ''), + CONCAT('WH-', x."trigger"), + jsonb_build_object('btcpay', jsonb_build_object('customerEmail', COALESCE(x."customerEmail", false))) AS additional_data + FROM "Stores" AS s + CROSS JOIN LATERAL jsonb_to_recordset(s."StoreBlob"->'emailRules') + AS x("to" text, subject text, body text, "trigger" text, "customerEmail" boolean) + WHERE jsonb_typeof(s."StoreBlob"->'emailRules') = 'array' AND x."trigger" IS NOT NULL; + """ + ); + migrationBuilder.Sql( + """ + UPDATE "Stores" + SET "StoreBlob" = "StoreBlob" - 'emailRules' + WHERE jsonb_typeof("StoreBlob"->'emailRules') = 'array'; + """ + ); + } + + /// + protected override void Down(MigrationBuilder migrationBuilder) + { + migrationBuilder.DropTable( + name: "email_rules"); + } + } +} diff --git a/BTCPayServer.Data/Migrations/ApplicationDbContextModelSnapshot.cs b/BTCPayServer.Data/Migrations/ApplicationDbContextModelSnapshot.cs index cc6fbd4cd..9c6f6eb63 100644 --- a/BTCPayServer.Data/Migrations/ApplicationDbContextModelSnapshot.cs +++ b/BTCPayServer.Data/Migrations/ApplicationDbContextModelSnapshot.cs @@ -194,6 +194,69 @@ namespace BTCPayServer.Migrations b.ToTable("AspNetUsers", (string)null); }); + modelBuilder.Entity("BTCPayServer.Data.EmailRuleData", b => + { + b.Property("Id") + .ValueGeneratedOnAdd() + .HasColumnType("bigint"); + + NpgsqlPropertyBuilderExtensions.UseIdentityAlwaysColumn(b.Property("Id")); + + b.Property("AdditionalData") + .IsRequired() + .ValueGeneratedOnAdd() + .HasColumnType("jsonb") + .HasColumnName("additional_data") + .HasDefaultValueSql("'{}'::jsonb"); + + b.Property("Body") + .IsRequired() + .HasColumnType("text") + .HasColumnName("body"); + + b.Property("Condition") + .HasColumnType("text") + .HasColumnName("condition"); + + b.Property("CreatedAt") + .ValueGeneratedOnAdd() + .HasColumnType("timestamptz") + .HasColumnName("created_at") + .HasDefaultValueSql("now()"); + + b.Property("Metadata") + .IsRequired() + .ValueGeneratedOnAdd() + .HasColumnType("jsonb") + .HasColumnName("metadata") + .HasDefaultValueSql("'{}'::jsonb"); + + b.Property("StoreId") + .HasColumnType("text") + .HasColumnName("store_id"); + + b.Property("Subject") + .IsRequired() + .HasColumnType("text") + .HasColumnName("subject"); + + b.Property("To") + .IsRequired() + .HasColumnType("text[]") + .HasColumnName("to"); + + b.Property("Trigger") + .IsRequired() + .HasColumnType("text") + .HasColumnName("trigger"); + + b.HasKey("Id"); + + b.HasIndex("StoreId"); + + b.ToTable("email_rules"); + }); + modelBuilder.Entity("BTCPayServer.Data.Fido2Credential", b => { b.Property("Id") @@ -1240,6 +1303,16 @@ namespace BTCPayServer.Migrations b.Navigation("StoreData"); }); + modelBuilder.Entity("BTCPayServer.Data.EmailRuleData", b => + { + b.HasOne("BTCPayServer.Data.StoreData", "Store") + .WithMany() + .HasForeignKey("StoreId") + .OnDelete(DeleteBehavior.Cascade); + + b.Navigation("Store"); + }); + modelBuilder.Entity("BTCPayServer.Data.Fido2Credential", b => { b.HasOne("BTCPayServer.Data.ApplicationUser", "ApplicationUser") diff --git a/BTCPayServer.Tests/GreenfieldAPITests.cs b/BTCPayServer.Tests/GreenfieldAPITests.cs index 5d0386caf..5a8f96adc 100644 --- a/BTCPayServer.Tests/GreenfieldAPITests.cs +++ b/BTCPayServer.Tests/GreenfieldAPITests.cs @@ -20,6 +20,7 @@ using BTCPayServer.PayoutProcessors; using BTCPayServer.PayoutProcessors.Lightning; using BTCPayServer.Plugins.PointOfSale.Controllers; using BTCPayServer.Plugins.PointOfSale.Models; +using BTCPayServer.Plugins.Webhooks.HostedServices; using BTCPayServer.Rating; using BTCPayServer.Services; using BTCPayServer.Services.Apps; @@ -1957,7 +1958,7 @@ namespace BTCPayServer.Tests TestLogs.LogInformation("Can prune deliveries"); - var cleanup = tester.PayTester.GetService(); + var cleanup = tester.PayTester.GetService(); cleanup.BatchSize = 1; cleanup.PruneAfter = TimeSpan.Zero; await cleanup.Do(default); diff --git a/BTCPayServer.Tests/MailPitClient.cs b/BTCPayServer.Tests/MailPitClient.cs new file mode 100644 index 000000000..dd313533a --- /dev/null +++ b/BTCPayServer.Tests/MailPitClient.cs @@ -0,0 +1,193 @@ +using System; +using System.Collections.Generic; +using System.Globalization; +using System.Net.Http; +using System.Text.RegularExpressions; +using System.Threading.Tasks; +using Newtonsoft.Json; +using Newtonsoft.Json.Linq; + +namespace BTCPayServer.Tests; + +public class MailPitClient +{ + private readonly HttpClient _client; + + public MailPitClient(HttpClient client) + { + _client = client; + } + + public async Task GetMessage(string id) + { + var result = await _client.GetStringAsync($"api/v1/message/{id}"); + var settings = new JsonSerializerSettings + { + DateParseHandling = DateParseHandling.None // let the converter handle "Date" + }; + return JsonConvert.DeserializeObject(result, settings); + } + + public sealed class Message + { + [JsonProperty("Attachments")] + public List Attachments { get; set; } + + [JsonProperty("Bcc")] + public List Bcc { get; set; } + + [JsonProperty("Cc")] + public List Cc { get; set; } + + [JsonProperty("Date")] + [JsonConverter(typeof(Rfc3339NanoDateTimeOffsetConverter))] + public DateTimeOffset? Date { get; set; } + + [JsonProperty("From")] + public MailAddress From { get; set; } + + [JsonProperty("HTML")] + public string Html { get; set; } + + [JsonProperty("ID")] + public string Id { get; set; } + + [JsonProperty("Inline")] + public List Inline { get; set; } + + [JsonProperty("ListUnsubscribe")] + public ListUnsubscribeInfo ListUnsubscribe { get; set; } + + [JsonProperty("MessageID")] + public string MessageId { get; set; } + + [JsonProperty("ReplyTo")] + public List ReplyTo { get; set; } + + [JsonProperty("ReturnPath")] + public string ReturnPath { get; set; } + + [JsonProperty("Size")] + public int? Size { get; set; } + + [JsonProperty("Subject")] + public string Subject { get; set; } + + [JsonProperty("Tags")] + public List Tags { get; set; } + + [JsonProperty("Text")] + public string Text { get; set; } + + [JsonProperty("To")] + public List To { get; set; } + + [JsonProperty("Username")] + public string Username { get; set; } + + // Capture any unexpected fields without breaking deserialization. + [JsonExtensionData] + public IDictionary Extra { get; set; } + } + + public sealed class Attachment + { + [JsonProperty("ContentID")] + public string ContentId { get; set; } + + [JsonProperty("ContentType")] + public string ContentType { get; set; } + + [JsonProperty("FileName")] + public string FileName { get; set; } + + [JsonProperty("PartID")] + public string PartId { get; set; } + + [JsonProperty("Size")] + public int? Size { get; set; } + + [JsonExtensionData] + public IDictionary Extra { get; set; } + } + + public sealed class MailAddress + { + [JsonProperty("Address")] + public string Address { get; set; } + + [JsonProperty("Name")] + public string Name { get; set; } + } + + public sealed class ListUnsubscribeInfo + { + [JsonProperty("Errors")] + public string Errors { get; set; } + + [JsonProperty("Header")] + public string Header { get; set; } + + [JsonProperty("HeaderPost")] + public string HeaderPost { get; set; } + + [JsonProperty("Links")] + public List Links { get; set; } + + [JsonExtensionData] + public IDictionary Extra { get; set; } + } + + /// + /// Permissive RFC3339/RFC3339Nano converter to DateTimeOffset. + /// Trims fractional seconds to 7 digits (the .NET limit). + /// + public sealed class Rfc3339NanoDateTimeOffsetConverter : JsonConverter + { + // Matches fractional seconds if present, e.g., .123456789 + private static readonly Regex FractionRegex = + new Regex(@"\.(\d+)(?=[Zz]|[+\-]\d{2}:\d{2}$)", RegexOptions.Compiled); + + public override void WriteJson(JsonWriter writer, DateTimeOffset? value, JsonSerializer serializer) + { + if (value == null) + { + writer.WriteNull(); + return; + } + + // Use ISO 8601 with offset; keep up to 7 fractional digits if needed. + writer.WriteValue(value.Value.ToString("o", CultureInfo.InvariantCulture)); + } + + public override DateTimeOffset? ReadJson(JsonReader reader, Type objectType, DateTimeOffset? existingValue, bool hasExistingValue, + JsonSerializer serializer) + { + if (reader.TokenType == JsonToken.Null) return null; + + if (reader.TokenType != JsonToken.String) + throw new JsonSerializationException($"Unexpected token {reader.TokenType} when parsing DateTimeOffset."); + + var s = (string)reader.Value; + if (string.IsNullOrWhiteSpace(s)) return null; + + // Trim fractional seconds to max 7 digits for .NET DateTime parsing. + s = FractionRegex.Replace(s, m => + { + var frac = m.Groups[1].Value; + if (frac.Length <= 7) return m.Value; // unchanged + return "." + frac.Substring(0, 7); + }); + + if (DateTimeOffset.TryParse(s, CultureInfo.InvariantCulture, DateTimeStyles.RoundtripKind, out var dto)) + return dto; + + // Fallback: try without colon in offset (some variants exist) + s = s.Replace("Z", "+00:00").Replace("z", "+00:00"); + if (DateTimeOffset.TryParse(s, CultureInfo.InvariantCulture, DateTimeStyles.RoundtripKind, out dto)) + return dto; + + throw new JsonSerializationException($"Unable to parse RFC3339 date-time: '{(string)reader.Value}'."); + } + } +} diff --git a/BTCPayServer.Tests/PMO/ConfigureEmailPMO.cs b/BTCPayServer.Tests/PMO/ConfigureEmailPMO.cs new file mode 100644 index 000000000..27ffa811a --- /dev/null +++ b/BTCPayServer.Tests/PMO/ConfigureEmailPMO.cs @@ -0,0 +1,48 @@ +#nullable enable +using System.Threading.Tasks; + +namespace BTCPayServer.Tests.PMO; + +public class ConfigureEmailPMO(PlaywrightTester s) +{ + public class Form + { + public string? Server { get; set; } + public int? Port { get; set; } + public string? From { get; set; } + public string? Login { get; set; } + public string? Password { get; set; } + public bool? EnabledCertificateCheck { get; set; } + } + + public Task FillMailPit(Form form) + => Fill(new() + { + Server = s.Server.MailPitSettings.Hostname, + Port = s.Server.MailPitSettings.SmtpPort, + From = form.From, + Login = form.Login, + Password = form.Password, + EnabledCertificateCheck = false, + }); + + public async Task Fill(Form form) + { + if (form.Server is not null) + await s.Page.FillAsync("#Settings_Server", form.Server); + if (form.Port is { } p) + await s.Page.FillAsync("#Settings_Port", p.ToString()); + if (form.From is not null) + await s.Page.FillAsync("#Settings_From", form.From); + if (form.Login is not null) + await s.Page.FillAsync("#Settings_Login", form.Login); + if (form.Password is not null) + await s.Page.FillAsync("#Settings_Password", form.Password); + if (form.EnabledCertificateCheck is { } v) + { + await s.Page.ClickAsync("#AdvancedSettingsButton"); + await s.Page.SetCheckedAsync("#Settings_EnabledCertificateCheck", v); + } + await s.ClickPagePrimary(); + } +} diff --git a/BTCPayServer.Tests/PMO/EmailRulePMO.cs b/BTCPayServer.Tests/PMO/EmailRulePMO.cs new file mode 100644 index 000000000..4aabe8ad9 --- /dev/null +++ b/BTCPayServer.Tests/PMO/EmailRulePMO.cs @@ -0,0 +1,34 @@ +#nullable enable +using System.Threading.Tasks; + +namespace BTCPayServer.Tests.PMO; + +public class EmailRulePMO(PlaywrightTester s) +{ + public class Form + { + public string? Trigger { get; set; } + public string? To { get; set; } + public string? Subject { get; set; } + public string? Body { get; set; } + public bool? CustomerEmail { get; set; } + public string? Condition { get; set; } + } + + public async Task Fill(Form form) + { + if (form.Trigger is not null) + await s.Page.SelectOptionAsync("#Trigger", form.Trigger); + if (form.Condition is not null) + await s.Page.FillAsync("#Condition", form.Condition); + if (form.To is not null) + await s.Page.FillAsync("#To", form.To); + if (form.Subject is not null) + await s.Page.FillAsync("#Subject", form.Subject); + if (form.Body is not null) + await s.Page.Locator(".note-editable").FillAsync(form.Body); + if (form.CustomerEmail is {} v) + await s.Page.SetCheckedAsync("#AdditionalData_CustomerEmail", v); + await s.ClickPagePrimary(); + } +} diff --git a/BTCPayServer.Tests/PlaywrightTests.cs b/BTCPayServer.Tests/PlaywrightTests.cs index 4d04ee6d1..53ce83727 100644 --- a/BTCPayServer.Tests/PlaywrightTests.cs +++ b/BTCPayServer.Tests/PlaywrightTests.cs @@ -18,6 +18,7 @@ using BTCPayServer.Services; using BTCPayServer.Services.Invoices; using BTCPayServer.Services.Rates; using BTCPayServer.Services.Wallets; +using BTCPayServer.Tests.PMO; using BTCPayServer.Views.Manage; using BTCPayServer.Views.Server; using BTCPayServer.Views.Stores; @@ -390,12 +391,16 @@ namespace BTCPayServer.Tests Assert.DoesNotContain("You need to configure email settings before this feature works", await s.Page.ContentAsync()); await s.Page.ClickAsync("#CreateEmailRule"); - await s.Page.Locator("#Trigger").SelectOptionAsync(new[] { "InvoicePaymentSettled" }); - await s.Page.FillAsync("#To", "test@gmail.com"); - await s.Page.ClickAsync("#CustomerEmail"); - await s.Page.FillAsync("#Subject", "Thanks!"); - await s.Page.Locator(".note-editable").FillAsync("Your invoice is settled"); - await s.Page.ClickAsync("#SaveEmailRules"); + var pmo = new EmailRulePMO(s); + await pmo.Fill(new() + { + Trigger = "WH-InvoicePaymentSettled", + To = "test@gmail.com", + CustomerEmail = true, + Subject = "Thanks!", + Body = "Your invoice is settled" + }); + await s.FindAlertMessage(); // we now have a rule Assert.DoesNotContain("There are no rules yet.", await s.Page.ContentAsync()); @@ -1404,34 +1409,55 @@ namespace BTCPayServer.Tests [Fact] public async Task CanSetupEmailRules() { - await using var s = CreatePlaywrightTester(); + await using var s = CreatePlaywrightTester(newDb: true); await s.StartAsync(); await s.RegisterNewUser(true); - await s.CreateNewStore(); + var (storeName, _) = await s.CreateNewStore(); await s.GoToStore(StoreNavPages.Emails); await s.Page.ClickAsync("#ConfigureEmailRules"); Assert.Contains("There are no rules yet.", await s.Page.ContentAsync()); Assert.Contains("You need to configure email settings before this feature works", await s.Page.ContentAsync()); + await s.Page.ClickAsync(".configure-email"); + + var mailPMO = new ConfigureEmailPMO(s); + await mailPMO.FillMailPit(new() + { + From = "store@store.com", + Login = "store@store.com", + Password = "password" + }); + + await s.GoToStore(StoreNavPages.Emails); + await s.Page.ClickAsync("#ConfigureEmailRules"); + + var pmo = new EmailRulePMO(s); await s.Page.ClickAsync("#CreateEmailRule"); - await s.Page.SelectOptionAsync("#Trigger", "InvoiceCreated"); - await s.Page.FillAsync("#To", "invoicecreated@gmail.com"); - await s.Page.ClickAsync("#CustomerEmail"); - await s.Page.ClickAsync("#SaveEmailRules"); + + await pmo.Fill(new() { + Trigger = "WH-InvoiceCreated", + To = "invoicecreated@gmail.com", + Subject = "Invoice Created in {Invoice.Currency}!", + Body = "Invoice has been created in {Invoice.Currency} for {Invoice.Price}!", + CustomerEmail = true + }); await s.FindAlertMessage(); - Assert.DoesNotContain("There are no rules yet.", await s.Page.ContentAsync()); - Assert.Contains("invoicecreated@gmail.com", await s.Page.ContentAsync()); - Assert.Contains("Invoice {Invoice.Id} created", await s.Page.ContentAsync()); - Assert.Contains("Yes", await s.Page.ContentAsync()); + var page = await s.Page.ContentAsync(); + Assert.DoesNotContain("There are no rules yet.", page); + Assert.Contains("invoicecreated@gmail.com", page); + Assert.Contains("Invoice Created in {Invoice.Currency}!", page); + Assert.Contains("Yes", page); await s.Page.ClickAsync("#CreateEmailRule"); - await s.Page.SelectOptionAsync("#Trigger", "PaymentRequestStatusChanged"); - await s.Page.FillAsync("#To", "statuschanged@gmail.com"); - await s.Page.FillAsync("#Subject", "Status changed!"); - await s.Page.Locator(".note-editable").FillAsync("Your Payment Request Status is Changed"); - await s.Page.ClickAsync("#SaveEmailRules"); + + await pmo.Fill(new() { + Trigger = "WH-PaymentRequestStatusChanged", + To = "statuschanged@gmail.com", + Subject = "Status changed!", + Body = "Your Payment Request Status is Changed" + }); await s.FindAlertMessage(); Assert.Contains("statuschanged@gmail.com", await s.Page.ContentAsync()); @@ -1441,14 +1467,23 @@ namespace BTCPayServer.Tests Assert.True(await editButtons.CountAsync() >= 2); await editButtons.Nth(1).ClickAsync(); - await s.Page.Locator("#To").ClearAsync(); - await s.Page.FillAsync("#To", "changedagain@gmail.com"); - await s.Page.ClickAsync("#SaveEmailRules"); + await pmo.Fill(new() { + To = "changedagain@gmail.com" + }); await s.FindAlertMessage(); Assert.Contains("changedagain@gmail.com", await s.Page.ContentAsync()); Assert.DoesNotContain("statuschanged@gmail.com", await s.Page.ContentAsync()); + var rulesUrl = s.Page.Url; + + await s.AddDerivationScheme(); + await s.GoToInvoices(); + var sent = await s.Server.WaitForEvent(() => s.CreateInvoice(amount: 10m, currency: "USD")); + var message = await s.Server.AssertHasEmail(sent); + Assert.Equal("Invoice has been created in USD for 10!", message.Text); + + await s.GoToUrl(rulesUrl); var deleteLinks = s.Page.GetByRole(AriaRole.Link, new() { Name = "Remove" }); Assert.Equal(2, await deleteLinks.CountAsync()); @@ -1466,6 +1501,24 @@ namespace BTCPayServer.Tests await s.FindAlertMessage(); Assert.Contains("There are no rules yet.", await s.Page.ContentAsync()); + + await s.Page.ClickAsync("#CreateEmailRule"); + + await pmo.Fill(new() { + Trigger = "WH-InvoiceCreated", + To = "invoicecreated@gmail.com", + Subject = "Invoice Created in {Invoice.Currency} for {Store.Name}!", + Body = "Invoice has been created in {Invoice.Currency} for {Invoice.Price}!", + CustomerEmail = true, + Condition = "$ ?(@.Invoice.Metadata.buyerEmail == \"john@test.com\")" + }); + + await s.GoToInvoices(); + sent = await s.Server.WaitForEvent(() => s.CreateInvoice(amount: 10m, currency: "USD", refundEmail: "john@test.com")); + message = await s.Server.AssertHasEmail(sent); + Assert.Equal("Invoice Created in USD for " + storeName + "!", message.Subject); + Assert.Equal("Invoice has been created in USD for 10!", message.Text); + Assert.Equal("john@test.com", message.To[0].Address); } [Fact] @@ -2034,7 +2087,7 @@ namespace BTCPayServer.Tests var address = await s.Server.ExplorerNode.GetNewAddressAsync(); await newPage.FillAsync("#Destination", address.ToString()); await newPage.PressAsync("#Destination", "Enter"); - + await s.GoToStore(s.StoreId, StoreNavPages.Payouts); await s.Page.ClickAsync("#InProgress-view"); @@ -2049,7 +2102,7 @@ namespace BTCPayServer.Tests await s.Page.ClickAsync(".mass-action-select-all[data-payout-state='InProgress']"); await s.Page.ClickAsync("#InProgress-mark-awaiting-payment"); await s.Page.ClickAsync("#AwaitingPayment-view"); - + var pageContent = await s.Page.ContentAsync(); Assert.Contains("PP1", pageContent); } diff --git a/BTCPayServer.Tests/ServerTester.cs b/BTCPayServer.Tests/ServerTester.cs index cfff82a43..4bb9db08a 100644 --- a/BTCPayServer.Tests/ServerTester.cs +++ b/BTCPayServer.Tests/ServerTester.cs @@ -20,12 +20,14 @@ using NBitpayClient; using NBXplorer; using BTCPayServer.Abstractions.Contracts; using System.Diagnostics.Metrics; +using BTCPayServer.Events; namespace BTCPayServer.Tests { public class ServerTester : IDisposable { public const string DefaultConnectionString = "User ID=postgres;Include Error Detail=true;Host=127.0.0.1;Port=39372;Database=btcpayserver"; + public (string Hostname, int SmtpPort, int HttpPort) MailPitSettings { get; set; } public List Resources = new List(); readonly string _Directory; @@ -43,6 +45,11 @@ namespace BTCPayServer.Tests if (!Directory.Exists(_Directory)) Directory.CreateDirectory(_Directory); + MailPitSettings = ( + GetEnvironment("TESTS_MAILPIT_HOST", "127.0.0.1"), + int.Parse(GetEnvironment("TESTS_MAILPIT_SMTP", "34219")), + int.Parse(GetEnvironment("TESTS_MAILPIT_HTTP", "34218"))); + _NetworkProvider = networkProvider; ExplorerNode = new RPCClient(RPCCredentialString.Parse(GetEnvironment("TESTS_BTCRPCCONNECTION", "server=http://127.0.0.1:43782;ceiwHEbqWI83:DwubwWsoo3")), NetworkProvider.GetNetwork("BTC").NBitcoinNetwork); ExplorerNode.ScanRPCCapabilities(); @@ -286,5 +293,19 @@ namespace BTCPayServer.Tests cryptoCode == "LTC" ? NetworkProvider.GetNetwork("LTC") : cryptoCode == "LBTC" ? NetworkProvider.GetNetwork("LBTC") : throw new NotSupportedException(); + + public async Task AssertHasEmail(EmailSentEvent sent) + { + var mailPitClient = GetMailPitClient(); + return await mailPitClient.GetMessage(sent.ServerResponse.Split(' ').Last()); + } + + public MailPitClient GetMailPitClient() + { + var http = PayTester.GetService().CreateClient("MAIL_PIT"); + http.BaseAddress = new Uri($"http://{MailPitSettings.Hostname}:{MailPitSettings.HttpPort}"); + var mailPitClient = new MailPitClient(http); + return mailPitClient; + } } } diff --git a/BTCPayServer.Tests/UnitTest1.cs b/BTCPayServer.Tests/UnitTest1.cs index 63a781030..68076042a 100644 --- a/BTCPayServer.Tests/UnitTest1.cs +++ b/BTCPayServer.Tests/UnitTest1.cs @@ -76,8 +76,9 @@ using MarkPayoutRequest = BTCPayServer.Client.Models.MarkPayoutRequest; using RatesViewModel = BTCPayServer.Models.StoreViewModels.RatesViewModel; using Microsoft.Extensions.Caching.Memory; using PosViewType = BTCPayServer.Client.Models.PosViewType; -using BTCPayServer.PaymentRequest; +using BTCPayServer.Plugins.Emails.Controllers; using BTCPayServer.Views.Stores; +using MimeKit; using NBXplorer.DerivationStrategy; namespace BTCPayServer.Tests @@ -1599,6 +1600,107 @@ namespace BTCPayServer.Tests }); } + [Fact] + [Trait("UnitTest", "UnitTest")] + public void TestMailTemplate() + { + var template = new TextTemplate("Hello mister {Name.Firstname} {Name.Lastname} !"); + + // Happy path + JObject model = new() + { + ["Name"] = new JObject + { + ["Firstname"] = "John", + ["Lastname"] = "Doe" + } + }; + var result = template.Render(model); + + // Null values are not rendered + Assert.Equal("Hello mister John Doe !", result); + model = new() + { + ["Name"] = new JObject + { + ["Firstname"] = "John", + ["Lastname"] = null + } + }; + result = template.Render(model); + Assert.Equal("Hello mister John !", result); + + // No crash on missing fields + model = new() + { + ["Name"] = new JObject + { + ["Firstname"] = "John", + } + }; + result = template.Render(model); + Assert.Equal("Hello mister John !", result); + + // Is Case insensitive + model = new() + { + ["Name"] = new JObject + { + ["firstname"] = "John", + } + }; + result = template.Render(model); + Assert.Equal("Hello mister John !", result); + + model = new() + { + ["Name"] = new JObject + { + ["Firstname"] = "John", + ["Lastname"] = "Doe", + ["NameInner"] = new JObject + { + ["Ogg"] = 2, + ["Arr"] = new JArray { + new JObject() { ["ItemName"] = "hello" }, + 2, + new JObject() { ["ItemName"] = "world" } } + } + } + }; + var paths = template.GetPaths(model); + Assert.Equal("{Name.Firstname}", paths[0]); + Assert.Equal("{Name.Lastname}", paths[1]); + Assert.Equal("{Name.NameInner.Ogg}", paths[2]); + Assert.Equal("{Name.NameInner.Arr[0].ItemName}", paths[3]); + Assert.Equal("{Name.NameInner.Arr[1]}", paths[4]); + Assert.Equal("{Name.NameInner.Arr[2].ItemName}", paths[5]); + + model = new() + { + ["Name"] = new JObject + { + ["Firstname"] = "John", + ["Lastname"] = "Doe", + ["NameInner"] = new JObject + { + ["Ogg"] = 2, + ["Arr"] = new JArray { + new JObject() { ["ItemName"] = "hello" }, + 2, + new JObject() { ["ItemName"] = "world" } } + }, + ["nameInner"] = new JObject() + { + ["Ogg2"] = 3 + } + } + }; + template = new TextTemplate("Hello mister {Name.NameInner.Ogg} {Name.NameInner.Ogg2} !"); + result = template.Render(model); + Assert.Equal("Hello mister 2 3 !", result); + } + [Fact] [Trait("Integration", "Integration")] public async Task CanUseDefaultCurrency() @@ -3250,16 +3352,26 @@ namespace BTCPayServer.Tests Assert.Equal("admin@admin.com", (await Assert.IsType(await emailSenderFactory.GetEmailSender()).GetEmailSettings()).Login); Assert.Null(await Assert.IsType(await emailSenderFactory.GetEmailSender(acc.StoreId)).GetEmailSettings()); - Assert.IsType(await acc.GetController().StoreEmailSettings(acc.StoreId, new EmailsViewModel(new EmailSettings + Assert.IsType(await acc.GetController().StoreEmailSettings(acc.StoreId, new EmailsViewModel(new EmailSettings { From = "store@store.com", Login = "store@store.com", Password = "store@store.com", - Port = 1234, - Server = "store.com" + Port = tester.MailPitSettings.SmtpPort, + Server = tester.MailPitSettings.Hostname }), "")); Assert.Equal("store@store.com", (await Assert.IsType(await emailSenderFactory.GetEmailSender(acc.StoreId)).GetEmailSettings()).Login); + + var sent = await tester.WaitForEvent( + async () => + { + var sender = await emailSenderFactory.GetEmailSender(acc.StoreId); + sender.SendEmail(MailboxAddress.Parse("destination@test.com"), "test", "hello world"); + }); + var message = await tester.AssertHasEmail(sent); + Assert.Equal("test", message.Subject); + Assert.Equal("hello world", message.Text); } [Fact(Timeout = TestUtils.TestTimeout)] diff --git a/BTCPayServer.Tests/docker-compose.altcoins.yml b/BTCPayServer.Tests/docker-compose.altcoins.yml index beff000cb..17b1df5af 100644 --- a/BTCPayServer.Tests/docker-compose.altcoins.yml +++ b/BTCPayServer.Tests/docker-compose.altcoins.yml @@ -18,6 +18,9 @@ services: TESTS_LTCNBXPLORERURL: http://nbxplorer:32838/ TESTS_POSTGRES: User ID=postgres;Include Error Detail=true;Host=postgres;Port=5432;Database=btcpayserver TESTS_EXPLORER_POSTGRES: User ID=postgres;Include Error Detail=true;Host=postgres;Port=5432;Database=nbxplorer + TESTS_MAILPIT_HOST: mailpit + TESTS_MAILPIT_SMTP: 1025 + TESTS_MAILPIT_HTTP: 8025 TESTS_HOSTNAME: tests TESTS_RUN_EXTERNAL_INTEGRATION: ${TESTS_RUN_EXTERNAL_INTEGRATION:-"false"} TESTS_AzureBlobStorageConnectionString: ${TESTS_AzureBlobStorageConnectionString:-none} @@ -60,6 +63,7 @@ services: - merchant_lnd - sshd - tor + - mailpit sshd: build: @@ -98,6 +102,17 @@ services: default: custom: + mailpit: + image: axllent/mailpit:v1.27 + ports: + # Web UI + - "34218:8025" + # SMTP + - "34219:1025" + environment: + MP_SMTP_AUTH_ACCEPT_ANY: 1 + MP_SMTP_AUTH_ALLOW_INSECURE: 1 + nbxplorer: image: nicolasdorier/nbxplorer:2.5.29 restart: unless-stopped diff --git a/BTCPayServer.Tests/docker-compose.yml b/BTCPayServer.Tests/docker-compose.yml index b05b6f1bb..627b11606 100644 --- a/BTCPayServer.Tests/docker-compose.yml +++ b/BTCPayServer.Tests/docker-compose.yml @@ -16,6 +16,9 @@ services: TESTS_BTCNBXPLORERURL: http://nbxplorer:32838/ TESTS_POSTGRES: User ID=postgres;Include Error Detail=true;Host=postgres;Port=5432;Database=btcpayserver TESTS_EXPLORER_POSTGRES: User ID=postgres;Include Error Detail=true;Host=postgres;Port=5432;Database=nbxplorer + TESTS_MAILPIT_HOST: mailpit + TESTS_MAILPIT_SMTP: 1025 + TESTS_MAILPIT_HTTP: 8025 TESTS_HOSTNAME: tests TESTS_RUN_EXTERNAL_INTEGRATION: ${TESTS_RUN_EXTERNAL_INTEGRATION:-"false"} TESTS_AzureBlobStorageConnectionString: ${TESTS_AzureBlobStorageConnectionString:-none} @@ -56,6 +59,7 @@ services: - merchant_lnd - sshd - tor + - mailpit sshd: build: @@ -94,6 +98,17 @@ services: default: custom: + mailpit: + image: axllent/mailpit:v1.27 + ports: + # Web UI + - "34218:8025" + # SMTP + - "34219:1025" + environment: + MP_SMTP_AUTH_ACCEPT_ANY: 1 + MP_SMTP_AUTH_ALLOW_INSECURE: 1 + nbxplorer: image: nicolasdorier/nbxplorer:2.5.29 restart: unless-stopped diff --git a/BTCPayServer/Components/MainNav/Default.cshtml b/BTCPayServer/Components/MainNav/Default.cshtml index 2233ce141..f29113a6a 100644 --- a/BTCPayServer/Components/MainNav/Default.cshtml +++ b/BTCPayServer/Components/MainNav/Default.cshtml @@ -11,6 +11,7 @@ @using BTCPayServer.Services @using BTCPayServer.Views.Apps @using BTCPayServer.Configuration +@using BTCPayServer.Plugins.Emails @inject Microsoft.AspNetCore.Http.IHttpContextAccessor HttpContext; @inject BTCPayServerOptions BtcPayServerOptions @inject BTCPayServerEnvironment Env @@ -61,13 +62,13 @@ Roles
  • - Webhooks + Webhooks
  • Payout Processors
  • - Emails + Emails
  • Forms diff --git a/BTCPayServer/Controllers/GreenField/GreenfieldPaymentRequestsController.cs b/BTCPayServer/Controllers/GreenField/GreenfieldPaymentRequestsController.cs index 96b66a405..5d27e3011 100644 --- a/BTCPayServer/Controllers/GreenField/GreenfieldPaymentRequestsController.cs +++ b/BTCPayServer/Controllers/GreenField/GreenfieldPaymentRequestsController.cs @@ -182,7 +182,7 @@ namespace BTCPayServer.Controllers.Greenfield new PaymentRequestQuery() { StoreId = storeId, Ids = new[] { paymentRequestId } })).FirstOrDefault(); if (pr is null) return PaymentRequestNotFound(); - if ((pr.Amount != request.Amount && request.Amount != 0.0m) || + if ((pr.Amount != request.Amount && request.Amount != 0.0m) || (pr.Currency != request.Currency && request.Currency != null)) { var prWithInvoices = await this.PaymentRequestService.GetPaymentRequest(paymentRequestId, GetUserId()); @@ -226,7 +226,8 @@ namespace BTCPayServer.Controllers.Greenfield Description = request.Description, Email = request.Email, FormId = request.FormId, - FormResponse = blob.FormId != request.FormId ? null : blob.FormResponse + FormResponse = blob.FormId != request.FormId ? null : blob.FormResponse, + RequestBaseUrl = Request.GetRequestBaseUrl().ToString() }); pr = await _paymentRequestRepository.CreateOrUpdatePaymentRequest(pr); return Ok(FromModel(pr)); diff --git a/BTCPayServer/Controllers/GreenField/LocalBTCPayServerClient.cs b/BTCPayServer/Controllers/GreenField/LocalBTCPayServerClient.cs index 1ef6059c8..125c7d91e 100644 --- a/BTCPayServer/Controllers/GreenField/LocalBTCPayServerClient.cs +++ b/BTCPayServer/Controllers/GreenField/LocalBTCPayServerClient.cs @@ -12,6 +12,7 @@ using BTCPayServer.Client; using BTCPayServer.Client.Models; using BTCPayServer.Controllers.GreenField; using BTCPayServer.Data; +using BTCPayServer.Plugins.Webhooks.Controllers; using BTCPayServer.Security; using BTCPayServer.Security.Greenfield; using BTCPayServer.Services.Mails; diff --git a/BTCPayServer/Controllers/UIInvoiceController.UI.cs b/BTCPayServer/Controllers/UIInvoiceController.UI.cs index e76ce5861..964be9ab4 100644 --- a/BTCPayServer/Controllers/UIInvoiceController.UI.cs +++ b/BTCPayServer/Controllers/UIInvoiceController.UI.cs @@ -20,6 +20,7 @@ using BTCPayServer.Models.PaymentRequestViewModels; using BTCPayServer.Payments; using BTCPayServer.Payments.Lightning; using BTCPayServer.Payouts; +using BTCPayServer.Plugins.Webhooks.Views; using BTCPayServer.Rating; using BTCPayServer.Services; using BTCPayServer.Services.Apps; @@ -154,7 +155,7 @@ namespace BTCPayServer.Controllers ShowCheckout = invoice.Status == InvoiceStatus.New, ShowReceipt = invoice.Status == InvoiceStatus.Settled && (invoice.ReceiptOptions?.Enabled ?? receipt.Enabled is true), Deliveries = (await _InvoiceRepository.GetWebhookDeliveries(invoiceId)) - .Select(c => new Models.StoreViewModels.DeliveryViewModel(c)) + .Select(c => new DeliveryViewModel(c)) .ToList() }; diff --git a/BTCPayServer/Controllers/UIInvoiceController.cs b/BTCPayServer/Controllers/UIInvoiceController.cs index f4f9a3d4d..b5d7d24ec 100644 --- a/BTCPayServer/Controllers/UIInvoiceController.cs +++ b/BTCPayServer/Controllers/UIInvoiceController.cs @@ -12,10 +12,8 @@ using BTCPayServer.Services; using BTCPayServer.Data; using BTCPayServer.Events; using BTCPayServer.HostedServices; -using BTCPayServer.HostedServices.Webhooks; using BTCPayServer.Logging; using BTCPayServer.Payments; -using BTCPayServer.Payments.Bitcoin; using BTCPayServer.Rating; using BTCPayServer.Security; using BTCPayServer.Security.Greenfield; @@ -29,11 +27,10 @@ using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Identity; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.Routing; -using NBitcoin; using Newtonsoft.Json.Linq; using StoreData = BTCPayServer.Data.StoreData; -using Serilog.Filters; using BTCPayServer.Payouts; +using BTCPayServer.Plugins.Webhooks; using Microsoft.Extensions.Localization; namespace BTCPayServer.Controllers diff --git a/BTCPayServer/Controllers/UIPaymentRequestController.cs b/BTCPayServer/Controllers/UIPaymentRequestController.cs index 76d0425d1..a7e725cc4 100644 --- a/BTCPayServer/Controllers/UIPaymentRequestController.cs +++ b/BTCPayServer/Controllers/UIPaymentRequestController.cs @@ -23,6 +23,7 @@ using BTCPayServer.Services.Stores; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Identity; using Microsoft.AspNetCore.Mvc; +using Microsoft.EntityFrameworkCore; using Microsoft.Extensions.Localization; using PaymentRequestData = BTCPayServer.Data.PaymentRequestData; using StoreData = BTCPayServer.Data.StoreData; @@ -38,10 +39,10 @@ namespace BTCPayServer.Controllers private readonly UserManager _UserManager; private readonly PaymentRequestRepository _PaymentRequestRepository; private readonly PaymentRequestService _PaymentRequestService; - private readonly EventAggregator _EventAggregator; private readonly CurrencyNameTable _Currencies; private readonly DisplayFormatter _displayFormatter; private readonly InvoiceRepository _InvoiceRepository; + private readonly ApplicationDbContextFactory _dbContextFactory; private readonly StoreRepository _storeRepository; private readonly UriResolver _uriResolver; private readonly BTCPayNetworkProvider _networkProvider; @@ -56,7 +57,6 @@ namespace BTCPayServer.Controllers UserManager userManager, PaymentRequestRepository paymentRequestRepository, PaymentRequestService paymentRequestService, - EventAggregator eventAggregator, CurrencyNameTable currencies, DisplayFormatter displayFormatter, StoreRepository storeRepository, @@ -65,6 +65,7 @@ namespace BTCPayServer.Controllers FormComponentProviders formProviders, FormDataService formDataService, IStringLocalizer stringLocalizer, + ApplicationDbContextFactory dbContextFactory, BTCPayNetworkProvider networkProvider) { _InvoiceController = invoiceController; @@ -72,12 +73,12 @@ namespace BTCPayServer.Controllers _UserManager = userManager; _PaymentRequestRepository = paymentRequestRepository; _PaymentRequestService = paymentRequestService; - _EventAggregator = eventAggregator; _Currencies = currencies; _displayFormatter = displayFormatter; _storeRepository = storeRepository; _uriResolver = uriResolver; _InvoiceRepository = invoiceRepository; + _dbContextFactory = dbContextFactory; FormProviders = formProviders; FormDataService = formDataService; _networkProvider = networkProvider; @@ -126,11 +127,13 @@ namespace BTCPayServer.Controllers { return NotFound(); } + var paymentRequest = GetCurrentPaymentRequest(); if (paymentRequest == null && !string.IsNullOrEmpty(payReqId)) { return NotFound(); } + if (!store.AnyPaymentMethodAvailable(_handlers)) { return NoPaymentMethodResult(storeId); @@ -145,12 +148,19 @@ namespace BTCPayServer.Controllers }; vm.Currency ??= storeBlob.DefaultCurrency; - vm.HasEmailRules = storeBlob.EmailRules?.Any(rule => - rule.Trigger.Contains("PaymentRequest", StringComparison.InvariantCultureIgnoreCase)); + vm.HasEmailRules = await HasEmailRules(store.Id); return View(nameof(EditPaymentRequest), vm); } + private async Task HasEmailRules(string storeId) + { + await using var ctx = _dbContextFactory.CreateContext(); + return await ctx.Set() + .AsNoTracking() + .AnyAsync(r => r.StoreId == storeId && EF.Functions.Like(r.Trigger, "WH-PaymentRequest%")); + } + [HttpPost("/stores/{storeId}/payment-requests/edit/{payReqId?}")] [Authorize(Policy = Policies.CanModifyPaymentRequests, AuthenticationSchemes = AuthenticationSchemes.Cookie)] public async Task EditPaymentRequest(string payReqId, UpdatePaymentRequestViewModel viewModel) @@ -168,6 +178,7 @@ namespace BTCPayServer.Controllers { return NotFound(); } + if (!store.AnyPaymentMethodAvailable(_handlers)) { return NoPaymentMethodResult(store.Id); @@ -177,6 +188,7 @@ namespace BTCPayServer.Controllers { ModelState.AddModelError(string.Empty, StringLocalizer["You cannot edit an archived payment request."]); } + var data = paymentRequest ?? new PaymentRequestData(); data.StoreDataId = viewModel.StoreId; data.Archived = viewModel.Archived; @@ -194,9 +206,7 @@ namespace BTCPayServer.Controllers if (!ModelState.IsValid) { - var storeBlob = store.GetStoreBlob(); - viewModel.HasEmailRules = storeBlob.EmailRules?.Any(rule => - rule.Trigger.Contains("PaymentRequest", StringComparison.InvariantCultureIgnoreCase)); + viewModel.HasEmailRules = await HasEmailRules(store.Id); return View(nameof(EditPaymentRequest), viewModel); } @@ -209,6 +219,8 @@ namespace BTCPayServer.Controllers data.ReferenceId = viewModel.ReferenceId; blob.AllowCustomPaymentAmounts = viewModel.AllowCustomPaymentAmounts; blob.FormId = viewModel.FormId; + if (payReqId is null || blob.RequestBaseUrl is null) + blob.RequestBaseUrl = Request.GetRequestBaseUrl().ToString(); data.SetBlob(blob); var isNewPaymentRequest = string.IsNullOrEmpty(payReqId); @@ -234,6 +246,7 @@ namespace BTCPayServer.Controllers { return NotFound(); } + var store = await _storeRepository.FindStore(vm.StoreId); if (store == null) { @@ -266,6 +279,7 @@ namespace BTCPayServer.Controllers { return RedirectToAction("PayPaymentRequest", new { payReqId }); } + var prFormId = prBlob.FormId; var formData = await FormDataService.GetForm(prFormId); if (formData is null) @@ -282,21 +296,26 @@ namespace BTCPayServer.Controllers emailField.Value = prBlob.Email; } } + if (Request.Method == "POST" && Request.HasFormContentType) { form.ApplyValuesFromForm(Request.Form); if (FormDataService.Validate(form, ModelState)) { prBlob.FormResponse = FormDataService.GetValues(form); - if(string.IsNullOrEmpty(prBlob.Email) && form.GetFieldByFullName("buyerEmail") is { } emailField) + if (string.IsNullOrEmpty(prBlob.Email) && form.GetFieldByFullName("buyerEmail") is { } emailField) { prBlob.Email = emailField.Value; } + if (prBlob.RequestBaseUrl is null) + prBlob.RequestBaseUrl = Request.GetRequestBaseUrl().ToString(); + result.SetBlob(prBlob); await _PaymentRequestRepository.CreateOrUpdatePaymentRequest(result); return RedirectToAction("PayPaymentRequest", new { payReqId }); } } + viewModel.FormName = formData.Name; viewModel.Form = form; @@ -331,6 +350,7 @@ namespace BTCPayServer.Controllers return BadRequest(StringLocalizer["Payment Request cannot be paid as it has been archived"]); } + if (!result.FormSubmitted && !string.IsNullOrEmpty(result.FormId)) { var formData = await FormDataService.GetForm(result.FormId); @@ -454,7 +474,7 @@ namespace BTCPayServer.Controllers var store = GetCurrentStore(); var result = await _PaymentRequestRepository.ArchivePaymentRequest(payReqId, true); - if(result is not null) + if (result is not null) { TempData[WellKnownTempData.SuccessMessage] = result.Value ? StringLocalizer["The payment request has been archived and will no longer appear in the payment request list by default again."].Value @@ -501,7 +521,8 @@ namespace BTCPayServer.Controllers TempData.SetStatusMessageModel(new StatusMessageModel { Severity = StatusMessageModel.StatusSeverity.Error, - Html = $"To create a payment request, you need to set up a wallet first", + Html = + $"To create a payment request, you need to set up a wallet first", AllowDismiss = false }); return RedirectToAction(nameof(GetPaymentRequests), new { storeId }); diff --git a/BTCPayServer/Controllers/UIServerController.cs b/BTCPayServer/Controllers/UIServerController.cs index b86948786..a0562b905 100644 --- a/BTCPayServer/Controllers/UIServerController.cs +++ b/BTCPayServer/Controllers/UIServerController.cs @@ -1281,21 +1281,39 @@ namespace BTCPayServer.Controllers settings.Password = null; await _SettingsRepository.UpdateSetting(settings); TempData[WellKnownTempData.SuccessMessage] = StringLocalizer["Email server password reset"].Value; - return RedirectToAction(nameof(Emails)); } - - // save if user provided valid email; this will also clear settings if no model.Settings.From - if (model.Settings.From is not null && !MailboxAddressValidator.IsMailboxAddress(model.Settings.From)) + else if (command == "mailpit") { - ModelState.AddModelError("Settings.From", StringLocalizer["Invalid email"]); - return View(model); + model.Settings.Server = "localhost"; + model.Settings.Port = 34219; + model.Settings.EnabledCertificateCheck = false; + model.Settings.Login ??= "store@example.com"; + model.Settings.From ??= "store@example.com"; + model.Settings.Password ??= "password"; + await _SettingsRepository.UpdateSetting(model.Settings); + TempData.SetStatusMessageModel(new StatusMessageModel() + { + Severity = StatusMessageModel.StatusSeverity.Info, + AllowDismiss = true, + Html = "Mailpit is now running on localhost. You can use it to test your SMTP settings." + }); } - var oldSettings = await _emailSenderFactory.GetSettings() ?? new EmailSettings(); - if (!string.IsNullOrEmpty(oldSettings.Password)) - model.Settings.Password = oldSettings.Password; + else + { + // save if user provided valid email; this will also clear settings if no model.Settings.From + if (model.Settings.From is not null && !MailboxAddressValidator.IsMailboxAddress(model.Settings.From)) + { + ModelState.AddModelError("Settings.From", StringLocalizer["Invalid email"]); + return View(model); + } - await _SettingsRepository.UpdateSetting(model.Settings); - TempData[WellKnownTempData.SuccessMessage] = StringLocalizer["Email settings saved"].Value; + var oldSettings = await _emailSenderFactory.GetSettings() ?? new EmailSettings(); + if (!string.IsNullOrEmpty(oldSettings.Password)) + model.Settings.Password = oldSettings.Password; + + await _SettingsRepository.UpdateSetting(model.Settings); + TempData[WellKnownTempData.SuccessMessage] = StringLocalizer["Email settings saved"].Value; + } return RedirectToAction(nameof(Emails)); } diff --git a/BTCPayServer/Controllers/UIStoresController.EmailRules.cs b/BTCPayServer/Controllers/UIStoresController.EmailRules.cs deleted file mode 100644 index 9f960cbad..000000000 --- a/BTCPayServer/Controllers/UIStoresController.EmailRules.cs +++ /dev/null @@ -1,154 +0,0 @@ -using System; -using System.Collections.Generic; -using System.ComponentModel.DataAnnotations; -using System.Globalization; -using System.Linq; -using System.Threading.Tasks; -using BTCPayServer.Abstractions.Constants; -using BTCPayServer.Abstractions.Extensions; -using BTCPayServer.Abstractions.Models; -using BTCPayServer.Client; -using BTCPayServer.Data; -using BTCPayServer.Models; -using BTCPayServer.Services.Mails; -using BTCPayServer.Services.Stores; -using Microsoft.AspNetCore.Authorization; -using Microsoft.AspNetCore.Mvc; - -namespace BTCPayServer.Controllers -{ - public partial class UIStoresController - { - [HttpGet("{storeId}/emails/rules")] - public async Task StoreEmailRulesList(string storeId) - { - var store = HttpContext.GetStoreData(); - if (store == null) return NotFound(); - - var configured = await _emailSenderFactory.IsComplete(store.Id); - if (!configured && !TempData.HasStatusMessage()) - { - TempData.SetStatusMessageModel(new StatusMessageModel - { - Severity = StatusMessageModel.StatusSeverity.Warning, - Html = "You need to configure email settings before this feature works." + - $" Configure store email settings." - }); - } - - var rules = store.GetStoreBlob().EmailRules ?? new List(); - return View("StoreEmailRulesList", rules); - } - - [HttpGet("{storeId}/emails/rules/create")] - [Authorize(Policy = Policies.CanModifyStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] - public IActionResult StoreEmailRulesCreate(string storeId) - { - return View("StoreEmailRulesManage", new StoreEmailRule()); - } - - [HttpPost("{storeId}/emails/rules/create")] - [Authorize(Policy = Policies.CanModifyStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] - public async Task StoreEmailRulesCreate(string storeId, StoreEmailRule model) - { - if (!ModelState.IsValid) - return View("StoreEmailRulesManage", model); - - var store = await _storeRepo.FindStore(storeId); - if (store == null) return NotFound(); - - var blob = store.GetStoreBlob(); - var rulesList = blob.EmailRules ?? new List(); - rulesList.Add(new StoreEmailRule - { - Trigger = model.Trigger, - CustomerEmail = model.CustomerEmail, - To = model.To, - Subject = model.Subject, - Body = model.Body - }); - - blob.EmailRules = rulesList; - store.SetStoreBlob(blob); - await _storeRepo.UpdateStore(store); - - this.TempData.SetStatusSuccess(StringLocalizer["Email rule successfully created"]); - return RedirectToAction(nameof(StoreEmailRulesList), new { storeId }); - } - - [HttpGet("{storeId}/emails/rules/{ruleIndex}/edit")] - [Authorize(Policy = Policies.CanModifyStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] - public IActionResult StoreEmailRulesEdit(string storeId, int ruleIndex) - { - var store = HttpContext.GetStoreData(); - if (store == null) return NotFound(); - - var rules = store.GetStoreBlob().EmailRules; - if (rules == null || ruleIndex >= rules.Count) return NotFound(); - - var rule = rules[ruleIndex]; - return View("StoreEmailRulesManage", rule); - } - - [HttpPost("{storeId}/emails/rules/{ruleIndex}/edit")] - [Authorize(Policy = Policies.CanModifyStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] - public async Task StoreEmailRulesEdit(string storeId, int ruleIndex, StoreEmailRule model) - { - if (!ModelState.IsValid) - return View("StoreEmailRulesManage", model); - - var store = await _storeRepo.FindStore(storeId); - if (store == null) return NotFound(); - - var blob = store.GetStoreBlob(); - if (blob.EmailRules == null || ruleIndex >= blob.EmailRules.Count) return NotFound(); - - var rule = blob.EmailRules[ruleIndex]; - rule.Trigger = model.Trigger; - rule.CustomerEmail = model.CustomerEmail; - rule.To = model.To; - rule.Subject = model.Subject; - rule.Body = model.Body; - store.SetStoreBlob(blob); - await _storeRepo.UpdateStore(store); - - this.TempData.SetStatusSuccess(StringLocalizer["Email rule successfully updated"]); - return RedirectToAction(nameof(StoreEmailRulesList), new { storeId }); - } - - [HttpPost("{storeId}/emails/rules/{ruleIndex}/delete")] - [Authorize(Policy = Policies.CanModifyStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] - public async Task StoreEmailRulesDelete(string storeId, int ruleIndex) - { - var store = await _storeRepo.FindStore(storeId); - if (store == null) return NotFound(); - - var blob = store.GetStoreBlob(); - if (blob.EmailRules == null || ruleIndex >= blob.EmailRules.Count) return NotFound(); - - blob.EmailRules.RemoveAt(ruleIndex); - store.SetStoreBlob(blob); - await _storeRepo.UpdateStore(store); - - this.TempData.SetStatusSuccess(StringLocalizer["Email rule successfully deleted"]); - return RedirectToAction(nameof(StoreEmailRulesList), new { storeId }); - } - - public class StoreEmailRule - { - [Required] - public string Trigger { get; set; } - - public bool CustomerEmail { get; set; } - - public string To { get; set; } - - [Required] - public string Subject { get; set; } - - [Required] - public string Body { get; set; } - } - } - -} diff --git a/BTCPayServer/Controllers/UIStoresController.cs b/BTCPayServer/Controllers/UIStoresController.cs index e8727270e..2615b81c7 100644 --- a/BTCPayServer/Controllers/UIStoresController.cs +++ b/BTCPayServer/Controllers/UIStoresController.cs @@ -6,7 +6,6 @@ using BTCPayServer.Abstractions.Contracts; using BTCPayServer.Client; using BTCPayServer.Configuration; using BTCPayServer.Data; -using BTCPayServer.HostedServices.Webhooks; using BTCPayServer.Models.StoreViewModels; using BTCPayServer.Security.Bitpay; using BTCPayServer.Services; @@ -50,7 +49,6 @@ public partial class UIStoresController : Controller IAuthorizationService authorizationService, AppService appService, IFileService fileService, - WebhookSender webhookNotificationManager, IDataProtectionProvider dataProtector, IOptions lightningNetworkOptions, IOptions externalServiceOptions, @@ -94,7 +92,6 @@ public partial class UIStoresController : Controller _html = html; _defaultRules = defaultRules; _dataProtector = dataProtector.CreateProtector("ConfigProtector"); - _webhookNotificationManager = webhookNotificationManager; _lightningNetworkOptions = lightningNetworkOptions.Value; _lnHistogramService = lnHistogramService; _lightningClientFactory = lightningClientFactory; @@ -127,7 +124,6 @@ public partial class UIStoresController : Controller private readonly UriResolver _uriResolver; private readonly EventAggregator _eventAggregator; private readonly IHtmlHelper _html; - private readonly WebhookSender _webhookNotificationManager; private readonly LightningNetworkOptions _lightningNetworkOptions; private readonly IDataProtector _dataProtector; private readonly LightningHistogramService _lnHistogramService; @@ -138,7 +134,7 @@ public partial class UIStoresController : Controller [TempData] private bool StoreNotConfigured { get; set; } - + [AllowAnonymous] [HttpGet("{storeId}/index")] public async Task Index(string storeId) @@ -146,7 +142,7 @@ public partial class UIStoresController : Controller var userId = _userManager.GetUserId(User); if (string.IsNullOrEmpty(userId)) return Forbid(); - + var store = await _storeRepo.FindStore(storeId); if (store is null) return NotFound(); @@ -161,7 +157,7 @@ public partial class UIStoresController : Controller } return Forbid(); } - + public StoreData CurrentStore => HttpContext.GetStoreData(); public PaymentMethodOptionViewModel.Format[] GetEnabledPaymentMethodChoices(StoreData storeData) diff --git a/BTCPayServer/Controllers/UIWalletsController.PSBT.cs b/BTCPayServer/Controllers/UIWalletsController.PSBT.cs index d5f3fb759..463d79d7a 100644 --- a/BTCPayServer/Controllers/UIWalletsController.PSBT.cs +++ b/BTCPayServer/Controllers/UIWalletsController.PSBT.cs @@ -175,7 +175,7 @@ namespace BTCPayServer.Controllers switch (command) { case "createpending": - await _pendingTransactionService.CreatePendingTransaction(walletId.StoreId, walletId.CryptoCode, psbt); + await _pendingTransactionService.CreatePendingTransaction(walletId.StoreId, walletId.CryptoCode, psbt, Request.GetRequestBaseUrl()); return RedirectToAction(nameof(WalletTransactions), new { walletId = walletId.ToString() }); case "sign": return await WalletSign(walletId, vm); diff --git a/BTCPayServer/Controllers/UIWalletsController.cs b/BTCPayServer/Controllers/UIWalletsController.cs index 68c61bdb1..d376811a8 100644 --- a/BTCPayServer/Controllers/UIWalletsController.cs +++ b/BTCPayServer/Controllers/UIWalletsController.cs @@ -444,7 +444,7 @@ namespace BTCPayServer.Controllers switch (model.Command) { case "createpending": - await _pendingTransactionService.CreatePendingTransaction(walletId.StoreId, walletId.CryptoCode, psbt); + await _pendingTransactionService.CreatePendingTransaction(walletId.StoreId, walletId.CryptoCode, psbt, Request.GetRequestBaseUrl()); return RedirectToWalletList(walletId); default: // case "sign": @@ -1296,7 +1296,7 @@ namespace BTCPayServer.Controllers switch (command) { case "createpending": - await _pendingTransactionService.CreatePendingTransaction(walletId.StoreId, walletId.CryptoCode, psbt); + await _pendingTransactionService.CreatePendingTransaction(walletId.StoreId, walletId.CryptoCode, psbt, Request.GetRequestBaseUrl()); return RedirectToAction(nameof(WalletTransactions), new { walletId = walletId.ToString() }); case "sign": return await WalletSign(walletId, new WalletPSBTViewModel diff --git a/BTCPayServer/Data/PaymentRequestBlob.cs b/BTCPayServer/Data/PaymentRequestBlob.cs index d8d09d873..b08416cf0 100644 --- a/BTCPayServer/Data/PaymentRequestBlob.cs +++ b/BTCPayServer/Data/PaymentRequestBlob.cs @@ -15,5 +15,6 @@ namespace BTCPayServer.Data public string FormId { get; set; } public JObject FormResponse { get; set; } + public string RequestBaseUrl { get; set; } } } diff --git a/BTCPayServer/Data/StoreBlob.cs b/BTCPayServer/Data/StoreBlob.cs index 1279e6f61..b85bdcdad 100644 --- a/BTCPayServer/Data/StoreBlob.cs +++ b/BTCPayServer/Data/StoreBlob.cs @@ -1,17 +1,13 @@ using System; using System.Collections.Generic; using System.ComponentModel; -using System.Globalization; using System.Linq; -using System.Text; using System.Text.RegularExpressions; using BTCPayServer.Client.JsonConverters; using BTCPayServer.Client.Models; -using BTCPayServer.Controllers; using BTCPayServer.JsonConverters; using BTCPayServer.Payments; using BTCPayServer.Rating; -using BTCPayServer.Services.Invoices; using BTCPayServer.Services.Mails; using Newtonsoft.Json; using Newtonsoft.Json.Linq; @@ -221,7 +217,6 @@ namespace BTCPayServer.Data [JsonConverter(typeof(TimeSpanJsonConverter.Days))] public TimeSpan RefundBOLT11Expiration { get; set; } - public List EmailRules { get; set; } public string BrandColor { get; set; } public bool ApplyBrandColorToBackend { get; set; } diff --git a/BTCPayServer/Events/EmailSentEvent.cs b/BTCPayServer/Events/EmailSentEvent.cs new file mode 100644 index 000000000..834447260 --- /dev/null +++ b/BTCPayServer/Events/EmailSentEvent.cs @@ -0,0 +1,10 @@ +using MimeKit; + +namespace BTCPayServer.Events; + +public class EmailSentEvent(string serverResponse, MimeMessage message) +{ + public string ServerResponse { get; } = serverResponse; + public MimeMessage Message { get; } = message; + public override string ToString() => $"Email sent ({Message.Subject})"; +} diff --git a/BTCPayServer/Extensions.cs b/BTCPayServer/Extensions.cs index 5c1fd8cdc..d09967820 100644 --- a/BTCPayServer/Extensions.cs +++ b/BTCPayServer/Extensions.cs @@ -1,6 +1,5 @@ using System; -using System.Collections.Concurrent; using System.Collections.Generic; using System.ComponentModel.DataAnnotations; using System.Globalization; @@ -29,7 +28,6 @@ using BTCPayServer.NTag424; using BTCPayServer.Payments; using BTCPayServer.Payments.Bitcoin; using BTCPayServer.Payments.Lightning; -using BTCPayServer.Payouts; using BTCPayServer.Security; using BTCPayServer.Services; using BTCPayServer.Services.Invoices; @@ -37,7 +35,6 @@ using BTCPayServer.Services.Reporting; using BTCPayServer.Services.Wallets; using Microsoft.AspNetCore.DataProtection; using Microsoft.AspNetCore.Http; -using Microsoft.AspNetCore.HttpOverrides; using Microsoft.AspNetCore.Mvc; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; diff --git a/BTCPayServer/Extensions/UrlHelperExtensions.cs b/BTCPayServer/Extensions/UrlHelperExtensions.cs index 7327e0baa..bb80a2de5 100644 --- a/BTCPayServer/Extensions/UrlHelperExtensions.cs +++ b/BTCPayServer/Extensions/UrlHelperExtensions.cs @@ -39,6 +39,8 @@ namespace Microsoft.AspNetCore.Mvc return urlHelper.GetUriByAction(nameof(UIAccountController.LoginUsingCode), "UIAccount", new { loginCode, returnUrl }, scheme, host, pathbase); } + public static string PaymentRequestLink(this LinkGenerator urlHelper, string paymentRequestId, RequestBaseUrl baseUrl) + => PaymentRequestLink(urlHelper, paymentRequestId, baseUrl.Scheme, baseUrl.Host, baseUrl.PathBase); public static string PaymentRequestLink(this LinkGenerator urlHelper, string paymentRequestId, string scheme, HostString host, string pathbase) { return urlHelper.GetUriByAction( @@ -48,6 +50,16 @@ namespace Microsoft.AspNetCore.Mvc scheme, host, pathbase); } + public static string WalletTransactionsLink(this LinkGenerator urlHelper, WalletId walletId, RequestBaseUrl baseUrl) + { + return urlHelper.GetUriByAction( + action: nameof(UIWalletsController.WalletTransactions), + controller: "UIWallets", + values: new { walletId = walletId.ToString() }, + baseUrl + ); + } + public static string AppLink(this LinkGenerator urlHelper, string appId, string scheme, HostString host, string pathbase) { return urlHelper.GetUriByAction( @@ -57,6 +69,8 @@ namespace Microsoft.AspNetCore.Mvc scheme, host, pathbase); } + public static string InvoiceLink(this LinkGenerator urlHelper, string invoiceId, RequestBaseUrl baseUrl) + => InvoiceLink(urlHelper, invoiceId, baseUrl.Scheme, baseUrl.Host, baseUrl.PathBase); public static string InvoiceLink(this LinkGenerator urlHelper, string invoiceId, string scheme, HostString host, string pathbase) { return urlHelper.GetUriByAction( diff --git a/BTCPayServer/HostedServices/PendingTransactionService.cs b/BTCPayServer/HostedServices/PendingTransactionService.cs index faa8b46b3..722eafe29 100644 --- a/BTCPayServer/HostedServices/PendingTransactionService.cs +++ b/BTCPayServer/HostedServices/PendingTransactionService.cs @@ -1,22 +1,14 @@ #nullable enable using System; -using System.Collections.Generic; using System.Linq; using System.Threading; using System.Threading.Tasks; -using BTCPayServer.Client.Models; -using BTCPayServer.Controllers; +using BTCPayServer.Abstractions; using BTCPayServer.Data; using BTCPayServer.Events; -using BTCPayServer.HostedServices.Webhooks; -using BTCPayServer.Services; using Microsoft.EntityFrameworkCore; using Microsoft.Extensions.Logging; using NBitcoin; -using NBitcoin.DataEncoders; -using Newtonsoft.Json; -using Newtonsoft.Json.Linq; -using WebhookDeliveryData = BTCPayServer.Data.WebhookDeliveryData; namespace BTCPayServer.HostedServices; @@ -32,14 +24,14 @@ public class PendingTransactionService( Subscribe(); base.SubscribeToEvents(); } - + public Task Do(CancellationToken cancellationToken) { PushEvent(new CheckForExpiryEvent()); return Task.CompletedTask; } - public class CheckForExpiryEvent { } + public class CheckForExpiryEvent { } protected override async Task ProcessEvent(object evt, CancellationToken cancellationToken) { @@ -92,6 +84,7 @@ public class PendingTransactionService( } public async Task CreatePendingTransaction(string storeId, string cryptoCode, PSBT psbt, + RequestBaseUrl requestBaseUrl, DateTimeOffset? expiry = null, CancellationToken cancellationToken = default) { var network = networkProvider.GetNetwork(cryptoCode); @@ -135,7 +128,8 @@ public class PendingTransactionService( PSBT = psbt.ToBase64(), SignaturesCollected = 0, SignaturesNeeded = signaturesNeeded, - SignaturesTotal = signaturesTotal + SignaturesTotal = signaturesTotal, + RequestBaseUrl = requestBaseUrl.ToString() }); ctx.PendingTransactions.Add(pendingTransaction); @@ -155,7 +149,7 @@ public class PendingTransactionService( await using var ctx = dbContextFactory.CreateContext(); var pendingTransaction = await ctx.PendingTransactions.FirstOrDefaultAsync(p => p.CryptoCode == id.CryptoCode && p.StoreId == id.StoreId && p.Id == id.Id, cancellationToken); - + if (pendingTransaction?.State is not PendingTransactionState.Pending) { return null; @@ -201,7 +195,7 @@ public class PendingTransactionService( { // TODO: For now we're going with estimation of how many signatures were collected until we find better way // so for example if we have 4 new signatures and only 2 inputs - number of collected signatures will be 2 - blob.SignaturesCollected += newSignatures / newWorkingCopyPsbt.Inputs.Count(); + blob.SignaturesCollected += newSignatures / newWorkingCopyPsbt.Inputs.Count; blob.CollectedSignatures.Add(new CollectedSignature { ReceivedPSBT = newPsbtBase64, @@ -215,7 +209,7 @@ public class PendingTransactionService( // TODO: Better logic here if (blob.SignaturesCollected < blob.SignaturesNeeded) blob.SignaturesCollected = blob.SignaturesNeeded; - + pendingTransaction.State = PendingTransactionState.Signed; } @@ -284,7 +278,7 @@ public class PendingTransactionService( public const string SignatureCollected = nameof(SignatureCollected); public const string Broadcast = nameof(Broadcast); public const string Cancelled = nameof(Cancelled); - + public PendingTransaction Data { get; set; } = null!; public string Type { get; set; } = null!; } diff --git a/BTCPayServer/HostedServices/PluginUpdateFetcher.cs b/BTCPayServer/HostedServices/PluginUpdateFetcher.cs index e20965cfa..3b8ac8e0a 100644 --- a/BTCPayServer/HostedServices/PluginUpdateFetcher.cs +++ b/BTCPayServer/HostedServices/PluginUpdateFetcher.cs @@ -84,7 +84,7 @@ namespace BTCPayServer.HostedServices var disabledPlugins = pluginService.GetDisabledPlugins(); var installedPlugins = pluginService.Installed; - var remotePlugins = await pluginService.GetRemotePlugins(null); + var remotePlugins = await pluginService.GetRemotePlugins(null, cancellationToken); //take the latest version of each plugin var remotePluginsList = remotePlugins .GroupBy(plugin => plugin.Identifier) diff --git a/BTCPayServer/HostedServices/StoreEmailRuleProcessorSender.cs b/BTCPayServer/HostedServices/StoreEmailRuleProcessorSender.cs deleted file mode 100644 index 3bf72cd88..000000000 --- a/BTCPayServer/HostedServices/StoreEmailRuleProcessorSender.cs +++ /dev/null @@ -1,87 +0,0 @@ -using System; -using System.Linq; -using System.Threading; -using System.Threading.Tasks; -using BTCPayServer.Client.Models; -using BTCPayServer.Controllers; -using BTCPayServer.Data; -using BTCPayServer.HostedServices.Webhooks; -using BTCPayServer.Services.Mails; -using BTCPayServer.Services.Stores; -using Microsoft.Extensions.Logging; - -namespace BTCPayServer.HostedServices; - -public class StoreEmailRuleProcessorSender : EventHostedServiceBase -{ - private readonly StoreRepository _storeRepository; - private readonly EmailSenderFactory _emailSenderFactory; - public StoreEmailRuleProcessorSender(StoreRepository storeRepository, EventAggregator eventAggregator, - ILogger logger, - EmailSenderFactory emailSenderFactory) : base( - eventAggregator, logger) - { - _storeRepository = storeRepository; - _emailSenderFactory = emailSenderFactory; - } - - protected override void SubscribeToEvents() - { - Subscribe(); - } - - protected override async Task ProcessEvent(object evt, CancellationToken cancellationToken) - { - if (evt is WebhookSender.WebhookDeliveryRequest webhookDeliveryRequest) - { - var type = webhookDeliveryRequest.WebhookEvent.Type; - if (type is null) - { - return; - } - - if (webhookDeliveryRequest.WebhookEvent is not StoreWebhookEvent storeWebhookEvent || storeWebhookEvent.StoreId is null) - { - return; - } - var store = await _storeRepository.FindStore(storeWebhookEvent.StoreId); - if (store is null) - { - return; - } - - var blob = store.GetStoreBlob(); - if (blob.EmailRules?.Any() is true) - { - var actionableRules = blob.EmailRules.Where(rule => rule.Trigger == type).ToList(); - if (actionableRules.Any()) - { - var sender = await _emailSenderFactory.GetEmailSender(storeWebhookEvent.StoreId); - foreach (UIStoresController.StoreEmailRule actionableRule in actionableRules) - { - var request = new SendEmailRequest - { - Subject = actionableRule.Subject, Body = actionableRule.Body, Email = actionableRule.To - }; - request = await webhookDeliveryRequest.Interpolate(request, actionableRule); - - var recipients = (request?.Email?.Split(",", StringSplitOptions.RemoveEmptyEntries) ?? Array.Empty()) - .Select(o => - { - MailboxAddressValidator.TryParse(o, out var mb); - return mb; - }) - .Where(o => o != null) - .ToArray(); - - if (recipients.Length == 0) - continue; - - sender.SendEmail(recipients.ToArray(), null, null, request.Subject, request.Body); - } - } - } - } - } - -} diff --git a/BTCPayServer/HostedServices/Webhooks/IWebhookProvider.cs b/BTCPayServer/HostedServices/Webhooks/IWebhookProvider.cs deleted file mode 100644 index b0592d52a..000000000 --- a/BTCPayServer/HostedServices/Webhooks/IWebhookProvider.cs +++ /dev/null @@ -1,14 +0,0 @@ -#nullable enable -using System.Collections.Generic; -using BTCPayServer.Client.Models; - -namespace BTCPayServer.HostedServices.Webhooks; - -public interface IWebhookProvider -{ - public bool SupportsCustomerEmail { get; } - - public Dictionary GetSupportedWebhookTypes(); - - public WebhookEvent CreateTestEvent(string type, params object[] args); -} diff --git a/BTCPayServer/HostedServices/Webhooks/InvoiceWebhookDeliveryRequest.cs b/BTCPayServer/HostedServices/Webhooks/InvoiceWebhookDeliveryRequest.cs deleted file mode 100644 index 28dc78d2e..000000000 --- a/BTCPayServer/HostedServices/Webhooks/InvoiceWebhookDeliveryRequest.cs +++ /dev/null @@ -1,55 +0,0 @@ -using System.Globalization; -using System.Threading.Tasks; -using BTCPayServer.Client.Models; -using BTCPayServer.Controllers; -using BTCPayServer.Data; -using BTCPayServer.Services.Invoices; -using WebhookDeliveryData = BTCPayServer.Data.WebhookDeliveryData; - -namespace BTCPayServer.HostedServices.Webhooks; - -public class InvoiceWebhookDeliveryRequest( - InvoiceEntity invoice, - string webhookId, - WebhookEvent webhookEvent, - WebhookDeliveryData delivery, - WebhookBlob webhookBlob) - : WebhookSender.WebhookDeliveryRequest(webhookId, webhookEvent, delivery, webhookBlob) -{ - public InvoiceEntity Invoice { get; } = invoice; - - public override Task Interpolate(SendEmailRequest req, - UIStoresController.StoreEmailRule storeEmailRule) - { - if (storeEmailRule.CustomerEmail && - MailboxAddressValidator.TryParse(Invoice.Metadata.BuyerEmail, out var bmb)) - { - req.Email ??= string.Empty; - req.Email += $",{bmb}"; - } - - req.Subject = Interpolate(req.Subject); - req.Body = Interpolate(req.Body); - return Task.FromResult(req); - } - - private string Interpolate(string str) - { - var res = str.Replace("{Invoice.Id}", Invoice.Id) - .Replace("{Invoice.StoreId}", Invoice.StoreId) - .Replace("{Invoice.Price}", Invoice.Price.ToString(CultureInfo.InvariantCulture)) - .Replace("{Invoice.Currency}", Invoice.Currency) - .Replace("{Invoice.Status}", Invoice.Status.ToString()) - .Replace("{Invoice.AdditionalStatus}", Invoice.ExceptionStatus.ToString()) - .Replace("{Invoice.OrderId}", Invoice.Metadata.OrderId); - - - res = InterpolateJsonField(res, "Invoice.Metadata", Invoice.Metadata.ToJObject()); - return res; - } - - public override string ToString() - { - return $"Webhook delivery request ({WebhookEvent.Type})"; - } -} diff --git a/BTCPayServer/HostedServices/Webhooks/InvoiceWebhookProvider.cs b/BTCPayServer/HostedServices/Webhooks/InvoiceWebhookProvider.cs deleted file mode 100644 index 5a920fc27..000000000 --- a/BTCPayServer/HostedServices/Webhooks/InvoiceWebhookProvider.cs +++ /dev/null @@ -1,113 +0,0 @@ -using System; -using System.Collections.Generic; -using BTCPayServer.Client.Models; -using BTCPayServer.Controllers.Greenfield; -using BTCPayServer.Data; -using BTCPayServer.Events; -using Microsoft.Extensions.Logging; - -namespace BTCPayServer.HostedServices.Webhooks; - -public class InvoiceWebhookProvider( - WebhookSender webhookSender, - EventAggregator eventAggregator, - ILogger logger) - : WebhookProvider(eventAggregator, logger, webhookSender) -{ - public override bool SupportsCustomerEmail { get; } = true; - - public override Dictionary GetSupportedWebhookTypes() - { - return new Dictionary - { - { WebhookEventType.InvoiceCreated, "Invoice - Created" }, - { WebhookEventType.InvoiceReceivedPayment, "Invoice - Received Payment" }, - { WebhookEventType.InvoicePaymentSettled, "Invoice - Payment Settled" }, - { WebhookEventType.InvoiceProcessing, "Invoice - Is Processing" }, - { WebhookEventType.InvoiceExpired, "Invoice - Expired" }, - { WebhookEventType.InvoiceSettled, "Invoice - Is Settled" }, - { WebhookEventType.InvoiceInvalid, "Invoice - Became Invalid" }, - { WebhookEventType.InvoiceExpiredPaidPartial, "Invoice - Expired Paid Partial" }, - { WebhookEventType.InvoicePaidAfterExpiration, "Invoice - Expired Paid Late" } - }; - } - - protected override WebhookSender.WebhookDeliveryRequest CreateDeliveryRequest(InvoiceEvent invoiceEvent, - WebhookData webhook) - { - var webhookEvent = GetWebhookEvent(invoiceEvent)!; - var webhookBlob = webhook?.GetBlob(); - webhookEvent.InvoiceId = invoiceEvent.InvoiceId; - webhookEvent.StoreId = invoiceEvent.Invoice.StoreId; - webhookEvent.Metadata = invoiceEvent.Invoice.Metadata.ToJObject(); - webhookEvent.WebhookId = webhook?.Id; - webhookEvent.IsRedelivery = false; - var delivery = webhook is null ? null : WebhookExtensions.NewWebhookDelivery(webhook.Id); - if (delivery is not null) - { - webhookEvent.DeliveryId = delivery.Id; - webhookEvent.OriginalDeliveryId = delivery.Id; - webhookEvent.Timestamp = delivery.Timestamp; - } - - return new InvoiceWebhookDeliveryRequest(invoiceEvent.Invoice, webhook?.Id, webhookEvent, - delivery, webhookBlob); - } - - public override WebhookEvent CreateTestEvent(string type, params object[] args) - { - var storeId = args[0].ToString(); - return new WebhookInvoiceEvent(type, storeId) { InvoiceId = "__test__" + Guid.NewGuid() + "__test__" }; - } - - protected override WebhookInvoiceEvent GetWebhookEvent(InvoiceEvent invoiceEvent) - { - var eventCode = invoiceEvent.EventCode; - var storeId = invoiceEvent.Invoice.StoreId; - switch (eventCode) - { - case InvoiceEventCode.Confirmed: - case InvoiceEventCode.MarkedCompleted: - return new WebhookInvoiceSettledEvent(storeId) - { - ManuallyMarked = eventCode == InvoiceEventCode.MarkedCompleted, - OverPaid = invoiceEvent.Invoice.ExceptionStatus == InvoiceExceptionStatus.PaidOver - }; - case InvoiceEventCode.Created: - return new WebhookInvoiceEvent(WebhookEventType.InvoiceCreated, storeId); - case InvoiceEventCode.Expired: - return new WebhookInvoiceExpiredEvent(storeId) { PartiallyPaid = invoiceEvent.PaidPartial }; - case InvoiceEventCode.FailedToConfirm: - case InvoiceEventCode.MarkedInvalid: - return new WebhookInvoiceInvalidEvent(storeId) { ManuallyMarked = eventCode == InvoiceEventCode.MarkedInvalid }; - case InvoiceEventCode.PaidInFull: - return new WebhookInvoiceProcessingEvent(storeId) { OverPaid = invoiceEvent.Invoice.ExceptionStatus == InvoiceExceptionStatus.PaidOver }; - case InvoiceEventCode.ReceivedPayment: - return new WebhookInvoiceReceivedPaymentEvent(WebhookEventType.InvoiceReceivedPayment, storeId) - { - AfterExpiration = - invoiceEvent.Invoice.Status == InvoiceStatus.Expired || - invoiceEvent.Invoice.Status == InvoiceStatus.Invalid, - PaymentMethodId = invoiceEvent.Payment.PaymentMethodId.ToString(), - Payment = GreenfieldInvoiceController.ToPaymentModel(invoiceEvent.Invoice, invoiceEvent.Payment), - StoreId = invoiceEvent.Invoice.StoreId - }; - case InvoiceEventCode.PaymentSettled: - return new WebhookInvoiceReceivedPaymentEvent(WebhookEventType.InvoicePaymentSettled, storeId) - { - AfterExpiration = - invoiceEvent.Invoice.Status == InvoiceStatus.Expired || - invoiceEvent.Invoice.Status == InvoiceStatus.Invalid, - PaymentMethodId = invoiceEvent.Payment.PaymentMethodId.ToString(), - Payment = GreenfieldInvoiceController.ToPaymentModel(invoiceEvent.Invoice, invoiceEvent.Payment), - StoreId = invoiceEvent.Invoice.StoreId - }; - case InvoiceEventCode.ExpiredPaidPartial: - return new WebhookInvoiceEvent(WebhookEventType.InvoiceExpiredPaidPartial, storeId); - case InvoiceEventCode.PaidAfterExpiration: - return new WebhookInvoiceEvent(WebhookEventType.InvoicePaidAfterExpiration, storeId); - default: - return null; - } - } -} diff --git a/BTCPayServer/HostedServices/Webhooks/PaymentRequestWebhookDeliveryRequest.cs b/BTCPayServer/HostedServices/Webhooks/PaymentRequestWebhookDeliveryRequest.cs deleted file mode 100644 index 8a1c885a4..000000000 --- a/BTCPayServer/HostedServices/Webhooks/PaymentRequestWebhookDeliveryRequest.cs +++ /dev/null @@ -1,54 +0,0 @@ -#nullable enable -using System.Globalization; -using System.Threading.Tasks; -using BTCPayServer.Client.Models; -using BTCPayServer.Controllers; -using BTCPayServer.Data; -using BTCPayServer.Services.PaymentRequests; -using WebhookDeliveryData = BTCPayServer.Data.WebhookDeliveryData; - -namespace BTCPayServer.HostedServices.Webhooks; - -public class PaymentRequestWebhookDeliveryRequest( - PaymentRequestEvent evt, - string webhookId, - WebhookEvent webhookEvent, - WebhookDeliveryData delivery, - WebhookBlob webhookBlob) - : WebhookSender.WebhookDeliveryRequest(webhookId, webhookEvent, delivery, webhookBlob) -{ - public override Task Interpolate(SendEmailRequest req, - UIStoresController.StoreEmailRule storeEmailRule) - { - var blob = evt.Data.GetBlob(); - if (storeEmailRule.CustomerEmail && - MailboxAddressValidator.TryParse(blob.Email, out var bmb)) - { - req.Email ??= string.Empty; - req.Email += $",{bmb}"; - } - - req.Subject = Interpolate(req.Subject, evt.Data); - req.Body = Interpolate(req.Body, evt.Data); - return Task.FromResult(req)!; - } - - private string Interpolate(string str, PaymentRequestData data) - { - var id = data.Id; - var trimmedId = $"{id.Substring(0, 7)}...{id.Substring(id.Length - 7)}"; - - var blob = data.GetBlob(); - var res = str.Replace("{PaymentRequest.Id}", id) - .Replace("{PaymentRequest.TrimmedId}", trimmedId) - .Replace("{PaymentRequest.Amount}", data.Amount.ToString(CultureInfo.InvariantCulture)) - .Replace("{PaymentRequest.Currency}", data.Currency) - .Replace("{PaymentRequest.Title}", blob.Title) - .Replace("{PaymentRequest.Description}", blob.Description) - .Replace("{PaymentRequest.ReferenceId}", data.ReferenceId) - .Replace("{PaymentRequest.Status}", evt.Data.Status.ToString()); - - res = InterpolateJsonField(res, "PaymentRequest.FormResponse", blob.FormResponse); - return res; - } -} diff --git a/BTCPayServer/HostedServices/Webhooks/PaymentRequestWebhookProvider.cs b/BTCPayServer/HostedServices/Webhooks/PaymentRequestWebhookProvider.cs deleted file mode 100644 index d80c9f265..000000000 --- a/BTCPayServer/HostedServices/Webhooks/PaymentRequestWebhookProvider.cs +++ /dev/null @@ -1,65 +0,0 @@ -using System; -using System.Collections.Generic; -using BTCPayServer.Client.Models; -using BTCPayServer.Data; -using BTCPayServer.Services.PaymentRequests; -using Microsoft.Extensions.Logging; - -namespace BTCPayServer.HostedServices.Webhooks; - -public class PaymentRequestWebhookProvider(EventAggregator eventAggregator, ILogger logger, WebhookSender webhookSender) - : WebhookProvider(eventAggregator, logger, webhookSender) -{ - public override bool SupportsCustomerEmail { get; } = true; - - public override Dictionary GetSupportedWebhookTypes() - { - return new Dictionary - { - { WebhookEventType.PaymentRequestCreated, "Payment Request - Created" }, - { WebhookEventType.PaymentRequestUpdated, "Payment Request - Updated" }, - { WebhookEventType.PaymentRequestArchived, "Payment Request - Archived" }, - { WebhookEventType.PaymentRequestStatusChanged, "Payment Request - Status Changed" }, - { WebhookEventType.PaymentRequestCompleted, "Payment Request - Completed" } - }; - } - - public override WebhookEvent CreateTestEvent(string type, object[] args) - { - var storeId = args[0].ToString(); - return new WebhookPaymentRequestEvent(type, storeId) { PaymentRequestId = "__test__" + Guid.NewGuid() + "__test__" }; - } - - protected override WebhookPaymentRequestEvent GetWebhookEvent(PaymentRequestEvent evt) - { - return evt.Type switch - { - PaymentRequestEvent.Created => new WebhookPaymentRequestEvent(WebhookEventType.PaymentRequestCreated, evt.Data.StoreDataId), - PaymentRequestEvent.Updated => new WebhookPaymentRequestEvent(WebhookEventType.PaymentRequestUpdated, evt.Data.StoreDataId), - PaymentRequestEvent.Archived => new WebhookPaymentRequestEvent(WebhookEventType.PaymentRequestArchived, evt.Data.StoreDataId), - PaymentRequestEvent.StatusChanged => new WebhookPaymentRequestEvent(WebhookEventType.PaymentRequestStatusChanged, evt.Data.StoreDataId), - PaymentRequestEvent.Completed => new WebhookPaymentRequestEvent(WebhookEventType.PaymentRequestCompleted, evt.Data.StoreDataId), - _ => null - }; - } - - protected override WebhookSender.WebhookDeliveryRequest CreateDeliveryRequest(PaymentRequestEvent paymentRequestEvent, WebhookData webhook) - { - var webhookBlob = webhook?.GetBlob(); - var webhookEvent = GetWebhookEvent(paymentRequestEvent)!; - webhookEvent.StoreId = paymentRequestEvent.Data.StoreDataId; - webhookEvent.PaymentRequestId = paymentRequestEvent.Data.Id; - webhookEvent.Status = paymentRequestEvent.Data.Status; - webhookEvent.WebhookId = webhook?.Id; - webhookEvent.IsRedelivery = false; - var delivery = webhook is null ? null : WebhookExtensions.NewWebhookDelivery(webhook.Id); - if (delivery is not null) - { - webhookEvent.DeliveryId = delivery.Id; - webhookEvent.OriginalDeliveryId = delivery.Id; - webhookEvent.Timestamp = delivery.Timestamp; - } - - return new PaymentRequestWebhookDeliveryRequest(paymentRequestEvent, webhook?.Id, webhookEvent, delivery, webhookBlob); - } -} diff --git a/BTCPayServer/HostedServices/Webhooks/PayoutWebhookDeliveryRequest.cs b/BTCPayServer/HostedServices/Webhooks/PayoutWebhookDeliveryRequest.cs deleted file mode 100644 index f4389cb8f..000000000 --- a/BTCPayServer/HostedServices/Webhooks/PayoutWebhookDeliveryRequest.cs +++ /dev/null @@ -1,39 +0,0 @@ -#nullable enable -using System.Threading.Tasks; -using BTCPayServer.Client.Models; -using BTCPayServer.Controllers; -using BTCPayServer.Data; -using BTCPayServer.Services; -using WebhookDeliveryData = BTCPayServer.Data.WebhookDeliveryData; - -namespace BTCPayServer.HostedServices.Webhooks; - -public class PayoutWebhookDeliveryRequest( - PayoutEvent evt, - string? webhookId, - WebhookEvent webhookEvent, - WebhookDeliveryData? delivery, - WebhookBlob? webhookBlob, - BTCPayNetworkJsonSerializerSettings btcPayNetworkJsonSerializerSettings) - : WebhookSender.WebhookDeliveryRequest(webhookId!, webhookEvent, delivery!, webhookBlob!) -{ - public override Task Interpolate(SendEmailRequest req, - UIStoresController.StoreEmailRule storeEmailRule) - { - req.Subject = Interpolate(req.Subject); - req.Body = Interpolate(req.Body); - return Task.FromResult(req)!; - } - - private string Interpolate(string str) - { - var blob = evt.Payout.GetBlob(btcPayNetworkJsonSerializerSettings); - var res = str.Replace("{Payout.Id}", evt.Payout.Id) - .Replace("{Payout.PullPaymentId}", evt.Payout.PullPaymentDataId) - .Replace("{Payout.Destination}", evt.Payout.DedupId ?? blob.Destination) - .Replace("{Payout.State}", evt.Payout.State.ToString()); - - res = InterpolateJsonField(res, "Payout.Metadata", blob.Metadata); - return res; - } -} diff --git a/BTCPayServer/HostedServices/Webhooks/PayoutWebhookProvider.cs b/BTCPayServer/HostedServices/Webhooks/PayoutWebhookProvider.cs deleted file mode 100644 index cea1fd166..000000000 --- a/BTCPayServer/HostedServices/Webhooks/PayoutWebhookProvider.cs +++ /dev/null @@ -1,67 +0,0 @@ -using System; -using System.Collections.Generic; -using BTCPayServer.Client.Models; -using BTCPayServer.Data; -using BTCPayServer.Services; -using Microsoft.Extensions.Logging; - -namespace BTCPayServer.HostedServices.Webhooks; - -public class PayoutWebhookProvider( - EventAggregator eventAggregator, - ILogger logger, - WebhookSender webhookSender, - BTCPayNetworkJsonSerializerSettings btcPayNetworkJsonSerializerSettings) - : WebhookProvider(eventAggregator, logger, webhookSender) -{ - public override bool SupportsCustomerEmail { get; } = false; - - protected override WebhookSender.WebhookDeliveryRequest CreateDeliveryRequest(PayoutEvent payoutEvent, WebhookData webhook) - { - var webhookBlob = webhook?.GetBlob(); - - var webhookEvent = GetWebhookEvent(payoutEvent)!; - webhookEvent.StoreId = payoutEvent.Payout.StoreDataId; - webhookEvent.PayoutId = payoutEvent.Payout.Id; - webhookEvent.PayoutState = payoutEvent.Payout.State; - webhookEvent.PullPaymentId = payoutEvent.Payout.PullPaymentDataId; - webhookEvent.WebhookId = webhook?.Id; - webhookEvent.IsRedelivery = false; - var delivery = webhook is null ? null : WebhookExtensions.NewWebhookDelivery(webhook.Id); - if (delivery is not null) - { - webhookEvent.DeliveryId = delivery.Id; - webhookEvent.OriginalDeliveryId = delivery.Id; - webhookEvent.Timestamp = delivery.Timestamp; - } - - return new PayoutWebhookDeliveryRequest(payoutEvent, webhook?.Id, webhookEvent, delivery, webhookBlob, btcPayNetworkJsonSerializerSettings); - } - - public override Dictionary GetSupportedWebhookTypes() - { - return new Dictionary - { - { WebhookEventType.PayoutCreated, "Payout - Created" }, - { WebhookEventType.PayoutApproved, "Payout - Approved" }, - { WebhookEventType.PayoutUpdated, "Payout - Updated" } - }; - } - - public override WebhookEvent CreateTestEvent(string type, object[] args) - { - var storeId = args[0].ToString(); - return new WebhookPayoutEvent(type, storeId) { PayoutId = "__test__" + Guid.NewGuid() + "__test__" }; - } - - protected override WebhookPayoutEvent GetWebhookEvent(PayoutEvent payoutEvent) - { - return payoutEvent.Type switch - { - PayoutEvent.PayoutEventType.Created => new WebhookPayoutEvent(WebhookEventType.PayoutCreated, payoutEvent.Payout.StoreDataId), - PayoutEvent.PayoutEventType.Approved => new WebhookPayoutEvent(WebhookEventType.PayoutApproved, payoutEvent.Payout.StoreDataId), - PayoutEvent.PayoutEventType.Updated => new WebhookPayoutEvent(WebhookEventType.PayoutUpdated, payoutEvent.Payout.StoreDataId), - _ => null - }; - } -} diff --git a/BTCPayServer/HostedServices/Webhooks/PendingTransactionDeliveryRequest.cs b/BTCPayServer/HostedServices/Webhooks/PendingTransactionDeliveryRequest.cs deleted file mode 100644 index c929061ed..000000000 --- a/BTCPayServer/HostedServices/Webhooks/PendingTransactionDeliveryRequest.cs +++ /dev/null @@ -1,48 +0,0 @@ -using System.Threading.Tasks; -using BTCPayServer.Client.Models; -using BTCPayServer.Controllers; -using BTCPayServer.Data; -using WebhookDeliveryData = BTCPayServer.Data.WebhookDeliveryData; - -namespace BTCPayServer.HostedServices.Webhooks; - -public class PendingTransactionDeliveryRequest( - PendingTransactionService.PendingTransactionEvent evt, - string webhookId, - WebhookEvent webhookEvent, - WebhookDeliveryData delivery, - WebhookBlob webhookBlob) - : WebhookSender.WebhookDeliveryRequest(webhookId, webhookEvent, delivery, webhookBlob) -{ - public override Task Interpolate(SendEmailRequest req, - UIStoresController.StoreEmailRule storeEmailRule) - { - var blob = evt.Data.GetBlob(); - // if (storeEmailRule.CustomerEmail && - // MailboxAddressValidator.TryParse(Invoice.Metadata.BuyerEmail, out var bmb)) - // { - // req.Email ??= string.Empty; - // req.Email += $",{bmb}"; - // } - - req.Subject = Interpolate(req.Subject, blob); - req.Body = Interpolate(req.Body, blob); - return Task.FromResult(req); - } - - private string Interpolate(string str, PendingTransactionBlob blob) - { - var id = evt.Data.TransactionId; - var trimmedId = $"{id.Substring(0, 7)}...{id.Substring(id.Length - 7)}"; - - var res = str.Replace("{PendingTransaction.Id}", id) - .Replace("{PendingTransaction.TrimmedId}", trimmedId) - .Replace("{PendingTransaction.StoreId}", evt.Data.StoreId) - .Replace("{PendingTransaction.SignaturesCollected}", blob.SignaturesCollected?.ToString()) - .Replace("{PendingTransaction.SignaturesNeeded}", blob.SignaturesNeeded?.ToString()) - .Replace("{PendingTransaction.SignaturesTotal}", blob.SignaturesTotal?.ToString()); - - // res = InterpolateJsonField(res, "Invoice.Metadata", Invoice.Metadata.ToJObject()); - return res; - } -} diff --git a/BTCPayServer/HostedServices/Webhooks/PendingTransactionWebhookProvider.cs b/BTCPayServer/HostedServices/Webhooks/PendingTransactionWebhookProvider.cs deleted file mode 100644 index 4a4a25106..000000000 --- a/BTCPayServer/HostedServices/Webhooks/PendingTransactionWebhookProvider.cs +++ /dev/null @@ -1,89 +0,0 @@ -using System; -using System.Collections.Generic; -using BTCPayServer.Client.Models; -using BTCPayServer.Data; -using Microsoft.Extensions.Logging; -using Newtonsoft.Json; - -namespace BTCPayServer.HostedServices.Webhooks; - -public class PendingTransactionWebhookProvider( - WebhookSender webhookSender, - EventAggregator eventAggregator, - ILogger logger) - : WebhookProvider(eventAggregator, logger, webhookSender) -{ - public const string PendingTransactionCreated = nameof(PendingTransactionCreated); - public const string PendingTransactionSignatureCollected = nameof(PendingTransactionSignatureCollected); - public const string PendingTransactionBroadcast = nameof(PendingTransactionBroadcast); - public const string PendingTransactionCancelled = nameof(PendingTransactionCancelled); - - public override bool SupportsCustomerEmail { get; } = false; - - public override Dictionary GetSupportedWebhookTypes() - { - return new Dictionary - { - { PendingTransactionCreated, "Pending Transaction - Created" }, - { PendingTransactionSignatureCollected, "Pending Transaction - Signature Collected" }, - { PendingTransactionBroadcast, "Pending Transaction - Broadcast" }, - { PendingTransactionCancelled, "Pending Transaction - Cancelled" } - }; - } - - protected override WebhookSender.WebhookDeliveryRequest CreateDeliveryRequest(PendingTransactionService.PendingTransactionEvent evt, - WebhookData webhook) - { - var webhookBlob = webhook?.GetBlob(); - - var webhookEvent = GetWebhookEvent(evt)!; - webhookEvent.StoreId = evt.Data.StoreId; - webhookEvent.WebhookId = webhook?.Id; - webhookEvent.IsRedelivery = false; - var delivery = webhook is null ? null : WebhookExtensions.NewWebhookDelivery(webhook.Id); - if (delivery is not null) - { - webhookEvent.DeliveryId = delivery.Id; - webhookEvent.OriginalDeliveryId = delivery.Id; - webhookEvent.Timestamp = delivery.Timestamp; - } - - return new PendingTransactionDeliveryRequest(evt, webhook?.Id, webhookEvent, delivery, webhookBlob); - } - - protected override WebhookPendingTransactionEvent GetWebhookEvent(PendingTransactionService.PendingTransactionEvent evt) - { - return evt.Type switch - { - PendingTransactionService.PendingTransactionEvent.Created => new WebhookPendingTransactionEvent( - PendingTransactionCreated, evt.Data.StoreId), - PendingTransactionService.PendingTransactionEvent.SignatureCollected => new WebhookPendingTransactionEvent( - PendingTransactionSignatureCollected, evt.Data.StoreId), - PendingTransactionService.PendingTransactionEvent.Broadcast => new WebhookPendingTransactionEvent( - PendingTransactionBroadcast, evt.Data.StoreId), - PendingTransactionService.PendingTransactionEvent.Cancelled => new WebhookPendingTransactionEvent( - PendingTransactionCancelled, evt.Data.StoreId), - _ => null - }; - } - - public override WebhookEvent CreateTestEvent(string type, params object[] args) - { - var storeId = args[0].ToString(); - return new WebhookPendingTransactionEvent(type, storeId) { PendingTransactionId = "__test__" + Guid.NewGuid() + "__test__" }; - } - - - public class WebhookPendingTransactionEvent : StoreWebhookEvent - { - public WebhookPendingTransactionEvent(string type, string storeId) - { - if (!type.StartsWith(PendingTransactionCreated.Replace("Created", "").ToLower(), StringComparison.InvariantCultureIgnoreCase)) - throw new ArgumentException("Invalid event type", nameof(type)); - Type = type; - StoreId = storeId; - } - - [JsonProperty(Order = 2)] public string PendingTransactionId { get; set; } - } -} diff --git a/BTCPayServer/HostedServices/Webhooks/WebhookExtensions.cs b/BTCPayServer/HostedServices/Webhooks/WebhookExtensions.cs deleted file mode 100644 index daaf3f467..000000000 --- a/BTCPayServer/HostedServices/Webhooks/WebhookExtensions.cs +++ /dev/null @@ -1,55 +0,0 @@ -using System; -using System.Net.Http; -using BTCPayServer.Data; -using BTCPayServer.Services; -using Microsoft.Extensions.DependencyInjection; -using Microsoft.Extensions.Hosting; -using NBitcoin; -using NBitcoin.DataEncoders; - -namespace BTCPayServer.HostedServices.Webhooks; - -public static class WebhookExtensions -{ - public static WebhookDeliveryData NewWebhookDelivery(string webhookId) - { - return new WebhookDeliveryData { Id = Encoders.Base58.EncodeData(RandomUtils.GetBytes(16)), Timestamp = DateTimeOffset.UtcNow, WebhookId = webhookId }; - } - - public static bool ShouldDeliver(this WebhookBlob wh, string type) - { - return wh.Active && wh.AuthorizedEvents.Match(type); - } - - public static IServiceCollection AddWebhooks(this IServiceCollection services) - { - services.AddSingleton(); - services.AddSingleton(o => o.GetRequiredService()); - services.AddHostedService(o => o.GetRequiredService()); - - services.AddSingleton(); - services.AddSingleton(o => o.GetRequiredService()); - services.AddHostedService(o => o.GetRequiredService()); - - services.AddSingleton(); - services.AddSingleton(o => o.GetRequiredService()); - services.AddHostedService(o => o.GetRequiredService()); - - services.AddSingleton(); - services.AddSingleton(o => o.GetRequiredService()); - services.AddHostedService(o => o.GetRequiredService()); - - services.AddSingleton(); - services.AddSingleton(o => o.GetRequiredService()); - services.AddScheduledTask(TimeSpan.FromHours(6.0)); - services.AddHttpClient(WebhookSender.OnionNamedClient) - .ConfigurePrimaryHttpMessageHandler(); - services.AddHttpClient(WebhookSender.LoopbackNamedClient) - .ConfigurePrimaryHttpMessageHandler(_ => new HttpClientHandler - { - ServerCertificateCustomValidationCallback = - HttpClientHandler.DangerousAcceptAnyServerCertificateValidator - }); - return services; - } -} diff --git a/BTCPayServer/HostedServices/Webhooks/WebhookProvider.cs b/BTCPayServer/HostedServices/Webhooks/WebhookProvider.cs deleted file mode 100644 index 79d89b2cc..000000000 --- a/BTCPayServer/HostedServices/Webhooks/WebhookProvider.cs +++ /dev/null @@ -1,45 +0,0 @@ -using System.Collections.Generic; -using System.Threading; -using System.Threading.Tasks; -using BTCPayServer.Client.Models; -using BTCPayServer.Data; -using Microsoft.Extensions.Logging; - -namespace BTCPayServer.HostedServices.Webhooks; - -public abstract class WebhookProvider(EventAggregator eventAggregator, ILogger logger, WebhookSender webhookSender) - : EventHostedServiceBase(eventAggregator, logger), IWebhookProvider -{ - public abstract bool SupportsCustomerEmail { get; } - - public abstract Dictionary GetSupportedWebhookTypes(); - - public abstract WebhookEvent CreateTestEvent(string type, params object[] args); - - protected abstract WebhookSender.WebhookDeliveryRequest CreateDeliveryRequest(T evt, WebhookData webhook); - - protected abstract StoreWebhookEvent GetWebhookEvent(T evt); - - protected override void SubscribeToEvents() - { - Subscribe(); - base.SubscribeToEvents(); - } - - protected override async Task ProcessEvent(object evt, CancellationToken cancellationToken) - { - if (evt is T tEvt) - { - if (GetWebhookEvent(tEvt) is not { } webhookEvent) - return; - - var webhooks = await webhookSender.GetWebhooks(webhookEvent.StoreId, webhookEvent.Type); - foreach (var webhook in webhooks) - webhookSender.EnqueueDelivery(CreateDeliveryRequest(tEvt, webhook)); - - EventAggregator.Publish(CreateDeliveryRequest(tEvt, null)); - } - - await base.ProcessEvent(evt, cancellationToken); - } -} diff --git a/BTCPayServer/Hosting/BTCPayServerServices.cs b/BTCPayServer/Hosting/BTCPayServerServices.cs index 9e4264011..2c22a35e9 100644 --- a/BTCPayServer/Hosting/BTCPayServerServices.cs +++ b/BTCPayServer/Hosting/BTCPayServerServices.cs @@ -15,7 +15,6 @@ using BTCPayServer.Data; using BTCPayServer.Data.Payouts.LightningLike; using BTCPayServer.Forms; using BTCPayServer.HostedServices; -using BTCPayServer.HostedServices.Webhooks; using BTCPayServer.Lightning; using BTCPayServer.Lightning.Charge; using BTCPayServer.Lightning.CLightning; @@ -384,7 +383,6 @@ namespace BTCPayServer.Hosting services.AddSingleton(o => o.GetRequiredService()); services.AddSingleton(); services.AddSingleton(o => o.GetRequiredService()); - services.AddSingleton(); services.AddSingleton(); services.AddScheduledTask(TimeSpan.FromDays(1)); services.AddScheduledTask(TimeSpan.FromDays(1)); @@ -395,7 +393,6 @@ namespace BTCPayServer.Hosting services.AddReportProvider(); services.AddReportProvider(); services.AddReportProvider(); - services.AddWebhooks(); services.AddSingleton>(o => o.GetRequiredService>().ToDictionary(o => o.PaymentMethodId, o => o)); @@ -516,16 +513,6 @@ o.GetRequiredService>().ToDictionary(o => o.P services.AddSingleton(o => o.GetRequiredService()); } - var userAgent = new System.Net.Http.Headers.ProductInfoHeaderValue("BTCPayServer", BTCPayServerEnvironment.GetInformationalVersion()); - foreach (var clientName in WebhookSender.AllClients.Concat(new[] { BitpayIPNSender.NamedClient })) - { - services.AddHttpClient(clientName) - .ConfigureHttpClient(client => - { - client.DefaultRequestHeaders.UserAgent.Add(userAgent); - }); - } - return services; } diff --git a/BTCPayServer/Hosting/Startup.cs b/BTCPayServer/Hosting/Startup.cs index 988dc3142..fad935308 100644 --- a/BTCPayServer/Hosting/Startup.cs +++ b/BTCPayServer/Hosting/Startup.cs @@ -173,6 +173,8 @@ namespace BTCPayServer.Hosting o.AreaViewLocationFormats.Add("/Plugins/{2}/Views/{1}/{0}.cshtml"); o.AreaViewLocationFormats.Add("/Plugins/{2}/Views/{0}.cshtml"); o.AreaViewLocationFormats.Add("/Plugins/{2}/Views/Shared/{0}.cshtml"); + + o.AreaViewLocationFormats.Add("/{0}.cshtml"); }) .AddNewtonsoftJson() diff --git a/BTCPayServer/Models/InvoicingModels/InvoiceDetailsModel.cs b/BTCPayServer/Models/InvoicingModels/InvoiceDetailsModel.cs index d62d6f6fd..1f6ad651a 100644 --- a/BTCPayServer/Models/InvoicingModels/InvoiceDetailsModel.cs +++ b/BTCPayServer/Models/InvoicingModels/InvoiceDetailsModel.cs @@ -4,6 +4,7 @@ using BTCPayServer.Client.Models; using BTCPayServer.Data; using BTCPayServer.Payments; using BTCPayServer.Payments.Bitcoin; +using BTCPayServer.Plugins.Webhooks.Views; using BTCPayServer.Services.Invoices; using NBitcoin; using Newtonsoft.Json; @@ -85,7 +86,7 @@ namespace BTCPayServer.Models.InvoicingModels get; set; } - public List Deliveries { get; set; } = new List(); + public List Deliveries { get; set; } = new (); public string TaxIncluded { get; set; } public string TransactionSpeed { get; set; } diff --git a/BTCPayServer/Models/StoreViewModels/TestWebhookViewModel.cs b/BTCPayServer/Models/StoreViewModels/TestWebhookViewModel.cs deleted file mode 100644 index d1d05148a..000000000 --- a/BTCPayServer/Models/StoreViewModels/TestWebhookViewModel.cs +++ /dev/null @@ -1,9 +0,0 @@ -using BTCPayServer.Client.Models; - -namespace BTCPayServer.Models.StoreViewModels -{ - public class TestWebhookViewModel - { - public string Type { get; set; } - } -} diff --git a/BTCPayServer/Plugins/Emails/Controllers/UIStoreEmailRulesController.cs b/BTCPayServer/Plugins/Emails/Controllers/UIStoreEmailRulesController.cs new file mode 100644 index 000000000..de73873af --- /dev/null +++ b/BTCPayServer/Plugins/Emails/Controllers/UIStoreEmailRulesController.cs @@ -0,0 +1,157 @@ +using System.Collections.Generic; +using System.Linq; +using System.Threading.Tasks; +using BTCPayServer.Abstractions.Constants; +using BTCPayServer.Abstractions.Extensions; +using BTCPayServer.Abstractions.Models; +using BTCPayServer.Client; +using BTCPayServer.Data; +using BTCPayServer.Plugins.Emails.Views; +using BTCPayServer.Services.Mails; +using Dapper; +using Microsoft.AspNetCore.Authorization; +using Microsoft.AspNetCore.Mvc; +using Microsoft.AspNetCore.Routing; +using Microsoft.EntityFrameworkCore; +using Microsoft.Extensions.Localization; +using Npgsql; + +namespace BTCPayServer.Plugins.Emails.Controllers; + +[Area(EmailsPlugin.Area)] +[Route("stores/{storeId}/emails/rules")] +[Authorize(AuthenticationSchemes = AuthenticationSchemes.Cookie)] +[Authorize(Policy = Policies.CanViewStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] +[AutoValidateAntiforgeryToken] +public class UIStoreEmailRulesController( + EmailSenderFactory emailSenderFactory, + LinkGenerator linkGenerator, + ApplicationDbContextFactory dbContextFactory, + IEnumerable triggers, + IStringLocalizer stringLocalizer) : Controller +{ + public IStringLocalizer StringLocalizer { get; set; } = stringLocalizer; + [HttpGet("")] + public async Task StoreEmailRulesList(string storeId) + { + await using var ctx = dbContextFactory.CreateContext(); + var store = HttpContext.GetStoreData(); + var configured = await emailSenderFactory.IsComplete(store.Id); + if (!configured && !TempData.HasStatusMessage()) + { + TempData.SetStatusMessageModel(new StatusMessageModel + { + Severity = StatusMessageModel.StatusSeverity.Warning, + Html = "You need to configure email settings before this feature works." + + $" Configure store email settings." + }); + } + + var rules = await ctx.EmailRules.GetRules(storeId).ToListAsync(); + return View("StoreEmailRulesList", rules.Select(r => new StoreEmailRuleViewModel(r, triggers)).ToList()); + } + + [HttpGet("create")] + [Authorize(Policy = Policies.CanModifyStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] + public IActionResult StoreEmailRulesCreate(string storeId) + { + return View("StoreEmailRulesManage", new StoreEmailRuleViewModel(null, triggers)); + } + + [HttpPost("create")] + [Authorize(Policy = Policies.CanModifyStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] + public async Task StoreEmailRulesCreate(string storeId, StoreEmailRuleViewModel model) + { + await ValidateCondition(model); + if (!ModelState.IsValid) + return StoreEmailRulesCreate(storeId); + + await using var ctx = dbContextFactory.CreateContext(); + var c = new EmailRuleData() + { + StoreId = storeId, + Trigger = model.Trigger, + Body = model.Body, + Subject = model.Subject, + Condition = string.IsNullOrWhiteSpace(model.Condition) ? null : model.Condition, + To = model.ToAsArray() + }; + c.SetBTCPayAdditionalData(model.AdditionalData); + ctx.EmailRules.Add(c); + await ctx.SaveChangesAsync(); + + this.TempData.SetStatusSuccess(StringLocalizer["Email rule successfully created"]); + return RedirectToAction(nameof(StoreEmailRulesList), new { storeId }); + } + + [HttpGet("{ruleId}/edit")] + [Authorize(Policy = Policies.CanModifyStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] + public async Task StoreEmailRulesEdit(string storeId, long ruleId) + { + await using var ctx = dbContextFactory.CreateContext(); + var r = await ctx.EmailRules.GetRule(storeId, ruleId); + if (r is null) + return NotFound(); + return View("StoreEmailRulesManage", new StoreEmailRuleViewModel(r, triggers)); + } + + [HttpPost("{ruleId}/edit")] + [Authorize(Policy = Policies.CanModifyStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] + public async Task StoreEmailRulesEdit(string storeId, long ruleId, StoreEmailRuleViewModel model) + { + await ValidateCondition(model); + if (!ModelState.IsValid) + return await StoreEmailRulesEdit(storeId, ruleId); + + await using var ctx = dbContextFactory.CreateContext(); + var rule = await ctx.EmailRules.GetRule(storeId, ruleId); + if (rule is null) return NotFound(); + + rule.Trigger = model.Trigger; + rule.SetBTCPayAdditionalData(model.AdditionalData); + rule.To = model.ToAsArray(); + rule.Subject = model.Subject; + rule.Condition = model.Condition; + rule.Body = model.Body; + await ctx.SaveChangesAsync(); + + this.TempData.SetStatusSuccess(StringLocalizer["Email rule successfully updated"]); + return RedirectToAction(nameof(StoreEmailRulesList), new { storeId }); + } + + private async Task ValidateCondition(StoreEmailRuleViewModel model) + { + model.Condition = model.Condition?.Trim() ?? ""; + if (model.Condition.Length == 0) + model.Condition = null; + else + { + await using var ctx = dbContextFactory.CreateContext(); + try + { + ctx.Database + .GetDbConnection() + .ExecuteScalar("SELECT jsonb_path_exists('{}'::JSONB, @path::jsonpath)", new { path = model.Condition }); + } + catch(PostgresException ex) + { + ModelState.AddModelError(nameof(model.Condition), $"Invalid condition ({ex.MessageText})"); + } + } + } + + [HttpPost("{ruleId}/delete")] + [Authorize(Policy = Policies.CanModifyStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] + public async Task StoreEmailRulesDelete(string storeId, long ruleId) + { + await using var ctx = dbContextFactory.CreateContext(); + var r = await ctx.EmailRules.GetRule(storeId, ruleId); + if (r is not null) + { + ctx.EmailRules.Remove(r); + await ctx.SaveChangesAsync(); + this.TempData.SetStatusSuccess(StringLocalizer["Email rule successfully deleted"]); + } + return RedirectToAction(nameof(StoreEmailRulesList), new { storeId }); + } +} diff --git a/BTCPayServer/Controllers/UIStoresController.Email.cs b/BTCPayServer/Plugins/Emails/Controllers/UIStoresEmailController.cs similarity index 70% rename from BTCPayServer/Controllers/UIStoresController.Email.cs rename to BTCPayServer/Plugins/Emails/Controllers/UIStoresEmailController.cs index 1f9d1267d..5436937f4 100644 --- a/BTCPayServer/Controllers/UIStoresController.Email.cs +++ b/BTCPayServer/Plugins/Emails/Controllers/UIStoresEmailController.cs @@ -10,16 +10,30 @@ using BTCPayServer.Abstractions.Models; using BTCPayServer.Client; using BTCPayServer.Data; using BTCPayServer.Models; +using BTCPayServer.Plugins.Emails; using BTCPayServer.Services.Mails; +using BTCPayServer.Services.Stores; using Microsoft.AspNetCore.Authorization; +using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Mvc; +using Microsoft.AspNetCore.Routing; +using Microsoft.Extensions.Localization; using MimeKit; -namespace BTCPayServer.Controllers; +namespace BTCPayServer.Plugins.Emails.Controllers; -public partial class UIStoresController +[Area(EmailsPlugin.Area)] +[Route("stores/{storeId}")] +[Authorize(AuthenticationSchemes = AuthenticationSchemes.Cookie)] +[Authorize(Policy = Policies.CanViewStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] +[AutoValidateAntiforgeryToken] +public class UIStoresEmailController( + EmailSenderFactory emailSenderFactory, + StoreRepository storeRepository, + IStringLocalizer stringLocalizer) : Controller { - [HttpGet("{storeId}/email-settings")] + public IStringLocalizer StringLocalizer { get; set; } = stringLocalizer; + [HttpGet("email-settings")] public async Task StoreEmailSettings(string storeId) { var store = HttpContext.GetStoreData(); @@ -38,7 +52,7 @@ public partial class UIStoresController record AllEmailSettings(EmailSettings Custom, EmailSettings Fallback); private async Task GetCustomSettings(string storeId) { - var sender = await _emailSenderFactory.GetEmailSender(storeId) as StoreEmailSender; + var sender = await emailSenderFactory.GetEmailSender(storeId) as StoreEmailSender; if (sender is null) return new(null, null); var fallback = sender.FallbackSender is { } fb ? await fb.GetEmailSettings() : null; @@ -47,7 +61,7 @@ public partial class UIStoresController return new(await sender.GetCustomSettings(), fallback); } - [HttpPost("{storeId}/email-settings")] + [HttpPost("email-settings")] [Authorize(Policy = Policies.CanModifyStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] public async Task StoreEmailSettings(string storeId, EmailsViewModel model, string command) { @@ -95,26 +109,45 @@ public partial class UIStoresController } return View(model); } + else if (command == "mailpit") + { + + storeBlob.EmailSettings = model.Settings; + storeBlob.EmailSettings.Server = "localhost"; + storeBlob.EmailSettings.Port = 34219; + storeBlob.EmailSettings.EnabledCertificateCheck = false; + storeBlob.EmailSettings.Login ??= "store@example.com"; + storeBlob.EmailSettings.From ??= "store@example.com"; + storeBlob.EmailSettings.Password ??= "password"; + store.SetStoreBlob(storeBlob); + await storeRepository.UpdateStore(store); + TempData.SetStatusMessageModel(new StatusMessageModel() + { + Severity = StatusMessageModel.StatusSeverity.Info, + AllowDismiss = true, + Html = "Mailpit is now running on localhost. You can use it to test your SMTP settings." + }); + } else if (command == "ResetPassword") { if (storeBlob.EmailSettings is not null) storeBlob.EmailSettings.Password = null; store.SetStoreBlob(storeBlob); - await _storeRepo.UpdateStore(store); + await storeRepository.UpdateStore(store); TempData[WellKnownTempData.SuccessMessage] = StringLocalizer["Email server password reset"].Value; } else if (!model.IsCustomSMTP && currentSettings is not null) { storeBlob.EmailSettings = null; store.SetStoreBlob(storeBlob); - await _storeRepo.UpdateStore(store); + await storeRepository.UpdateStore(store); TempData[WellKnownTempData.SuccessMessage] = StringLocalizer["You are now using server's email settings"].Value; } else if (model.IsCustomSMTP) { storeBlob.EmailSettings = model.Settings; store.SetStoreBlob(storeBlob); - await _storeRepo.UpdateStore(store); + await storeRepository.UpdateStore(store); TempData[WellKnownTempData.SuccessMessage] = StringLocalizer["Email settings saved"].Value; } return RedirectToAction(nameof(StoreEmailSettings), new { storeId }); diff --git a/BTCPayServer/Plugins/Emails/EmailsExtensions.cs b/BTCPayServer/Plugins/Emails/EmailsExtensions.cs new file mode 100644 index 000000000..76e51b176 --- /dev/null +++ b/BTCPayServer/Plugins/Emails/EmailsExtensions.cs @@ -0,0 +1,14 @@ +using System.Collections.Generic; +using BTCPayServer.Plugins.Emails.Views; + +namespace BTCPayServer; + +public static class EmailsExtensions +{ + public static List AddStoresPlaceHolders(this List placeholders) + { + placeholders.Insert(0, new("{Store.Name}", "The name of the store")); + placeholders.Insert(0, new("{Store.Id}", "The id of the store")); + return placeholders; + } +} diff --git a/BTCPayServer/Plugins/Emails/EmailsPlugin.cs b/BTCPayServer/Plugins/Emails/EmailsPlugin.cs new file mode 100644 index 000000000..0b8677523 --- /dev/null +++ b/BTCPayServer/Plugins/Emails/EmailsPlugin.cs @@ -0,0 +1,21 @@ +using BTCPayServer.Abstractions.Models; +using BTCPayServer.Plugins.Webhooks; +using BTCPayServer.Services; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Hosting; + +namespace BTCPayServer.Plugins.Emails; + +public class EmailsPlugin : BaseBTCPayServerPlugin +{ + public const string Area = "Emails"; + public override string Identifier => "BTCPayServer.Plugins.Emails"; + public override string Name => "Emails"; + public override string Description => "Allows you to send emails to your customers!"; + + public override void Execute(IServiceCollection services) + { + services.AddSingleton(); + services.AddSingleton(); + } +} diff --git a/BTCPayServer/Plugins/Emails/EmailsTranslationProvider.cs b/BTCPayServer/Plugins/Emails/EmailsTranslationProvider.cs new file mode 100644 index 000000000..95c4ca6d1 --- /dev/null +++ b/BTCPayServer/Plugins/Emails/EmailsTranslationProvider.cs @@ -0,0 +1,18 @@ +#nullable enable + +using System.Collections.Generic; +using System.Linq; +using System.Threading.Tasks; +using BTCPayServer.Plugins.Emails.Views; +using BTCPayServer.Services; + +namespace BTCPayServer.Plugins.Emails; + +public class EmailsTranslationProvider(IEnumerable viewModels) : IDefaultTranslationProvider +{ + public Task[]> GetDefaultTranslations() + => Task.FromResult( + viewModels.Select(vm => KeyValuePair.Create(vm.Description, vm.Description)) + .Concat(viewModels.SelectMany(vm => vm.PlaceHolders).Select(p => KeyValuePair.Create(p.Description, p.Description))) + .ToArray())!; +} diff --git a/BTCPayServer/Plugins/Emails/LinkGeneratorExtensions.cs b/BTCPayServer/Plugins/Emails/LinkGeneratorExtensions.cs new file mode 100644 index 000000000..3bcb4e899 --- /dev/null +++ b/BTCPayServer/Plugins/Emails/LinkGeneratorExtensions.cs @@ -0,0 +1,23 @@ +#nullable enable +using BTCPayServer.Abstractions; +using BTCPayServer.Plugins.Emails; +using BTCPayServer.Plugins.Emails.Controllers; +using Microsoft.AspNetCore.Routing; + +namespace Microsoft.AspNetCore.Mvc; + +public static class EmailsUrlHelperExtensions +{ + public static string GetStoreEmailRulesLink(this LinkGenerator linkGenerator, string storeId, RequestBaseUrl baseUrl) + => linkGenerator.GetUriByAction( + action: nameof(UIStoreEmailRulesController.StoreEmailRulesList), + controller: "UIStoreEmailRules", + values: new { area = EmailsPlugin.Area, storeId }, + baseUrl); + public static string GetStoreEmailSettingsLink(this LinkGenerator linkGenerator, string storeId, RequestBaseUrl baseUrl) + => linkGenerator.GetUriByAction( + action: nameof(UIStoresEmailController.StoreEmailSettings), + controller: "UIStoresEmail", + values: new { area = EmailsPlugin.Area, storeId }, + baseUrl); +} diff --git a/BTCPayServer/Plugins/Emails/StoreEmailRuleProcessorSender.cs b/BTCPayServer/Plugins/Emails/StoreEmailRuleProcessorSender.cs new file mode 100644 index 000000000..2e8a9bc4f --- /dev/null +++ b/BTCPayServer/Plugins/Emails/StoreEmailRuleProcessorSender.cs @@ -0,0 +1,84 @@ +#nullable enable +using System.Collections.Generic; +using System.Linq; +using System.Threading; +using System.Threading.Tasks; +using BTCPayServer.Data; +using BTCPayServer.HostedServices; +using BTCPayServer.Services.Mails; +using Microsoft.Extensions.Logging; +using MimeKit; +using Newtonsoft.Json.Linq; + +namespace BTCPayServer.Plugins.Emails; + +public interface ITriggerOwner +{ + Task BeforeSending(EmailRuleMatchContext context); +} + +public record TriggerEvent(string? StoreId, string Trigger, JObject Model, ITriggerOwner? Owner); + +public class EmailRuleMatchContext( + TriggerEvent triggerEvent, + EmailRuleData matchedRule) +{ + public TriggerEvent TriggerEvent { get; } = triggerEvent; + public EmailRuleData MatchedRule { get; } = matchedRule; + + public List Recipients { get; set; } = new(); + public List Cc { get; set; } = new(); + public List Bcc { get; set; } = new(); +} + +public class StoreEmailRuleProcessorSender( + ApplicationDbContextFactory dbContextFactory, + EventAggregator eventAggregator, + ILogger logger, + EmailSenderFactory emailSenderFactory) + : EventHostedServiceBase(eventAggregator, logger) +{ + protected override void SubscribeToEvents() + { + Subscribe(); + } + + protected override async Task ProcessEvent(object evt, CancellationToken cancellationToken) + { + if (evt is TriggerEvent triggEvent) + { + await using var ctx = dbContextFactory.CreateContext(); + var actionableRules = await ctx.EmailRules + .GetMatches(triggEvent.StoreId, triggEvent.Trigger, triggEvent.Model); + + if (actionableRules.Length > 0) + { + var sender = await emailSenderFactory.GetEmailSender(triggEvent.StoreId); + foreach (var actionableRule in actionableRules) + { + var matchedContext = new EmailRuleMatchContext(triggEvent, actionableRule); + + var body = new TextTemplate(actionableRule.Body ?? ""); + var subject = new TextTemplate(actionableRule.Subject ?? ""); + matchedContext.Recipients.AddRange( + actionableRule.To + .Select(o => + { + if (!MailboxAddressValidator.TryParse(o, out var oo)) + { + MailboxAddressValidator.TryParse(new TextTemplate(o).Render(triggEvent.Model), out oo); + } + return oo; + }) + .Where(o => o != null)!); + + if (triggEvent.Owner is not null) + await triggEvent.Owner.BeforeSending(matchedContext); + if (matchedContext.Recipients.Count == 0) + continue; + sender.SendEmail(matchedContext.Recipients.ToArray(), matchedContext.Cc.ToArray(), matchedContext.Bcc.ToArray(), subject.Render(triggEvent.Model), body.Render(triggEvent.Model)); + } + } + } + } +} diff --git a/BTCPayServer/Plugins/Emails/Views/EmailTriggerViewModel.cs b/BTCPayServer/Plugins/Emails/Views/EmailTriggerViewModel.cs new file mode 100644 index 000000000..6d9a61240 --- /dev/null +++ b/BTCPayServer/Plugins/Emails/Views/EmailTriggerViewModel.cs @@ -0,0 +1,23 @@ +using System.Collections.Generic; + +namespace BTCPayServer.Plugins.Emails.Views; + +/// +/// This view model is used in StoreEmailRulesManage.cshtml, to display the different triggers that can be used to send emails +/// +public class EmailTriggerViewModel +{ + public string Type { get; set; } + public string Description { get; set; } + public string SubjectExample { get; set; } + public string BodyExample { get; set; } + public bool CanIncludeCustomerEmail { get; set; } + + public class PlaceHolder(string name, string description) + { + public string Name { get; set; } = name; + public string Description { get; set; } = description; + } + + public List PlaceHolders { get; set; } = new(); +} diff --git a/BTCPayServer/Plugins/Emails/Views/StoreEmailRuleViewModel.cs b/BTCPayServer/Plugins/Emails/Views/StoreEmailRuleViewModel.cs new file mode 100644 index 000000000..295ca0615 --- /dev/null +++ b/BTCPayServer/Plugins/Emails/Views/StoreEmailRuleViewModel.cs @@ -0,0 +1,53 @@ +using System; +using System.Collections.Generic; +using System.ComponentModel.DataAnnotations; +using System.Linq; +using BTCPayServer.Data; + +namespace BTCPayServer.Plugins.Emails.Views; + +public class StoreEmailRuleViewModel +{ + public StoreEmailRuleViewModel() + { + + } + public StoreEmailRuleViewModel(EmailRuleData data, IEnumerable triggers) + { + if (data is not null) + { + Data = data; + AdditionalData = data.GetBTCPayAdditionalData() ?? new(); + Trigger = data.Trigger; + Subject = data.Subject; + Condition = data.Condition ?? ""; + Body = data.Body; + To = string.Join(",", data.To); + } + else + { + AdditionalData = new(); + } + + Triggers = triggers.ToList(); + } + [Required] + public string Trigger { get; set; } + + public string Condition { get; set; } + + [Required] + public string Subject { get; set; } + + [Required] + public string Body { get; set; } + public EmailRuleData Data { get; set; } + public EmailRuleData.BTCPayAdditionalData AdditionalData { get; set; } + public string To { get; set; } + + public List Triggers { get; set; } + public string[] ToAsArray() + => (To ?? "").Split(',', StringSplitOptions.RemoveEmptyEntries) + .Select(t => t.Trim()) + .ToArray(); +} diff --git a/BTCPayServer/Views/UIStores/StoreEmailRulesList.cshtml b/BTCPayServer/Plugins/Emails/Views/UIStoreEmailRules/StoreEmailRulesList.cshtml similarity index 60% rename from BTCPayServer/Views/UIStores/StoreEmailRulesList.cshtml rename to BTCPayServer/Plugins/Emails/Views/UIStoreEmailRules/StoreEmailRulesList.cshtml index cd86b799c..f24147e3c 100644 --- a/BTCPayServer/Views/UIStores/StoreEmailRulesList.cshtml +++ b/BTCPayServer/Plugins/Emails/Views/UIStoreEmailRules/StoreEmailRulesList.cshtml @@ -1,8 +1,4 @@ -@using BTCPayServer.Abstractions.Models -@using BTCPayServer.Client -@using BTCPayServer.TagHelpers -@using Microsoft.AspNetCore.Mvc.TagHelpers -@model List +@model List @{ var storeId = Context.GetStoreData().Id; @@ -12,14 +8,14 @@ - + Create Email Rule @@ -35,25 +31,25 @@ - - - - + + + + - @foreach (var rule in Model.Select((value, index) => new { value, index })) + @foreach (var rule in Model) { - - - - + + + + diff --git a/BTCPayServer/Plugins/Emails/Views/UIStoreEmailRules/StoreEmailRulesManage.cshtml b/BTCPayServer/Plugins/Emails/Views/UIStoreEmailRules/StoreEmailRulesManage.cshtml new file mode 100644 index 000000000..42ee3979a --- /dev/null +++ b/BTCPayServer/Plugins/Emails/Views/UIStoreEmailRules/StoreEmailRulesManage.cshtml @@ -0,0 +1,161 @@ +@model StoreEmailRuleViewModel + +@{ + var storeId = Context.GetStoreData().Id; + bool isEdit = Model.Trigger != null; + ViewData.SetActivePage(StoreNavPages.Emails, StringLocalizer[isEdit ? "Edit Email Rule" : "Create Email Rule"], storeId); +} + +@section PageHeadContent { + +} + + +
    + +
    + + Cancel +
    +
    + + +
    + + + +
    Choose what event sends the email.
    +
    + +
    + + + +
    Only send email when the specified JSON Path exists
    +
    + +
    + + + +
    Who to send the email to. For multiple emails, separate with a comma.
    +
    + +
    + + + +
    + +
    + + + +
    + +
    + + + +
    +
    Placeholders
    +
    TriggerCustomer EmailToSubjectTriggerCustomer EmailToSubject
    @rule.value.Trigger@(rule.value.CustomerEmail ? "Yes" : "No")@rule.value.To@rule.value.Subject@rule.Trigger@(rule.AdditionalData.CustomerEmail is true ? StringLocalizer["Yes"] : StringLocalizer["No"])@string.Join(", ", rule.To)@rule.Subject
    - Edit - {0}.", Html.Encode(rule.value.Trigger)]" data-confirm-input="@StringLocalizer["REMOVE"]" text-translate="true">Remove + Edit + {0}.", Html.Encode(rule.Trigger)]" data-confirm-input="@StringLocalizer["REMOVE"]" text-translate="true">Remove
    +
    + * These fields are JSON objects. You can access properties within them using this syntax. One example is {Invoice.Metadata.itemCode} + + + + + +@section PageFootContent { + + + + +} diff --git a/BTCPayServer/Plugins/Emails/Views/UIStoresEmail/StoreEmailSettings.cshtml b/BTCPayServer/Plugins/Emails/Views/UIStoresEmail/StoreEmailSettings.cshtml new file mode 100644 index 000000000..d798da405 --- /dev/null +++ b/BTCPayServer/Plugins/Emails/Views/UIStoresEmail/StoreEmailSettings.cshtml @@ -0,0 +1,55 @@ +@using BTCPayServer.Client +@using BTCPayServer.Plugins.Emails +@using Microsoft.AspNetCore.Mvc.TagHelpers +@model BTCPayServer.Models.EmailsViewModel +@{ + var storeId = Context.GetStoreData().Id; + ViewData.SetActivePage(StoreNavPages.Emails, StringLocalizer["Email Rules"], storeId); +} + +
    +
    +

    Email Server

    +
    + + +
    +
    + + @if (Model.IsFallbackSetup) + { + + +
    + +
    + } + else + { + + + } + + + + +
    +

    Email Rules

    +

    Email rules allow BTCPay Server to send customized emails from your store based on events.

    + + Configure + +
    + +@section PageFootContent { + +} diff --git a/BTCPayServer/Plugins/Emails/Views/_ViewImports.cshtml b/BTCPayServer/Plugins/Emails/Views/_ViewImports.cshtml new file mode 100644 index 000000000..9b02192fb --- /dev/null +++ b/BTCPayServer/Plugins/Emails/Views/_ViewImports.cshtml @@ -0,0 +1,9 @@ +@using BTCPayServer.Plugins.Emails +@using BTCPayServer.Abstractions.Models +@using BTCPayServer.Views.Stores +@using BTCPayServer.Client +@using BTCPayServer.TagHelpers +@using Microsoft.AspNetCore.Mvc.TagHelpers + +@namespace BTCPayServer.Plugins.Emails.Views + diff --git a/BTCPayServer/Plugins/Emails/Views/_ViewStart.cshtml b/BTCPayServer/Plugins/Emails/Views/_ViewStart.cshtml new file mode 100644 index 000000000..a5f10045d --- /dev/null +++ b/BTCPayServer/Plugins/Emails/Views/_ViewStart.cshtml @@ -0,0 +1,3 @@ +@{ + Layout = "_Layout"; +} diff --git a/BTCPayServer/Plugins/PluginBuilderClient.cs b/BTCPayServer/Plugins/PluginBuilderClient.cs index 05e7fb23d..bdda7da53 100644 --- a/BTCPayServer/Plugins/PluginBuilderClient.cs +++ b/BTCPayServer/Plugins/PluginBuilderClient.cs @@ -3,6 +3,7 @@ using System.Collections.Generic; using System.Net.Http; using System.Text; using System.Text.RegularExpressions; +using System.Threading; using System.Threading.Tasks; using Newtonsoft.Json; using Newtonsoft.Json.Linq; @@ -59,7 +60,7 @@ namespace BTCPayServer.Plugins _httpClient = httpClient; } static JsonSerializerSettings serializerSettings = new() { ContractResolver = new Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver() }; - public async Task GetPublishedVersions(string btcpayVersion, bool includePreRelease, string searchPluginName = null, bool? includeAllVersions = null) + public async Task GetPublishedVersions(string btcpayVersion, bool includePreRelease, string searchPluginName = null, bool? includeAllVersions = null, CancellationToken cancellationToken = default) { var queryString = $"?includePreRelease={includePreRelease}"; if (btcpayVersion is not null) @@ -68,7 +69,7 @@ namespace BTCPayServer.Plugins queryString += $"&searchPluginName={Uri.EscapeDataString(searchPluginName)}"; if (includeAllVersions is not null) queryString += $"&includeAllVersions={includeAllVersions}"; - var result = await _httpClient.GetStringAsync($"api/v1/plugins{queryString}"); + var result = await _httpClient.GetStringAsync($"api/v1/plugins{queryString}", cancellationToken); return JsonConvert.DeserializeObject(result, serializerSettings) ?? throw new InvalidOperationException(); } public async Task GetPlugin(string pluginSlug, string version) @@ -97,7 +98,8 @@ namespace BTCPayServer.Plugins public async Task GetInstalledPluginsUpdates( string btcpayVersion, bool includePreRelease, - IEnumerable plugins) + IEnumerable plugins, + CancellationToken cancellationToken = default) { var queryString = $"?includePreRelease={includePreRelease}"; if (!string.IsNullOrWhiteSpace(btcpayVersion)) @@ -106,10 +108,10 @@ namespace BTCPayServer.Plugins var json = JsonConvert.SerializeObject(plugins, serializerSettings); using var content = new StringContent(json, Encoding.UTF8, "application/json"); - using var resp = await _httpClient.PostAsync($"api/v1/plugins/updates{queryString}", content); + using var resp = await _httpClient.PostAsync($"api/v1/plugins/updates{queryString}", content, cancellationToken); resp.EnsureSuccessStatusCode(); - var body = await resp.Content.ReadAsStringAsync(); + var body = await resp.Content.ReadAsStringAsync(cancellationToken); var result = JsonConvert.DeserializeObject(body, serializerSettings); if (result is null) diff --git a/BTCPayServer/Plugins/PluginService.cs b/BTCPayServer/Plugins/PluginService.cs index a1802a930..43a067ef9 100644 --- a/BTCPayServer/Plugins/PluginService.cs +++ b/BTCPayServer/Plugins/PluginService.cs @@ -2,6 +2,7 @@ using System; using System.Collections.Generic; using System.IO; using System.Linq; +using System.Threading; using System.Threading.Tasks; using BTCPayServer.Abstractions.Contracts; using BTCPayServer.Configuration; @@ -53,11 +54,11 @@ namespace BTCPayServer.Plugins private string GetShortBtcpayVersion() => Env.Version.TrimStart('v').Split('+')[0]; - public async Task GetRemotePlugins(string searchPluginName) + public async Task GetRemotePlugins(string searchPluginName, CancellationToken cancellationToken = default) { string btcpayVersion = GetShortBtcpayVersion(); var versions = await _pluginBuilderClient.GetPublishedVersions( - btcpayVersion, _policiesSettings.PluginPreReleases, searchPluginName); + btcpayVersion, _policiesSettings.PluginPreReleases, searchPluginName, cancellationToken: cancellationToken); var plugins = versions .Select(MapToAvailablePlugin) @@ -79,7 +80,7 @@ namespace BTCPayServer.Plugins var updates = await _pluginBuilderClient.GetInstalledPluginsUpdates( btcpayVersion, _policiesSettings.PluginPreReleases, - loadedToCheck); + loadedToCheck, cancellationToken: cancellationToken); if (updates is { Length: > 0 }) { diff --git a/BTCPayServer/Controllers/GreenField/GreenfieldStoreWebhooksController.cs b/BTCPayServer/Plugins/Webhooks/Controllers/GreenfieldStoreWebhooksController.cs similarity index 98% rename from BTCPayServer/Controllers/GreenField/GreenfieldStoreWebhooksController.cs rename to BTCPayServer/Plugins/Webhooks/Controllers/GreenfieldStoreWebhooksController.cs index 7d7d793bf..1d0d6515c 100644 --- a/BTCPayServer/Controllers/GreenField/GreenfieldStoreWebhooksController.cs +++ b/BTCPayServer/Plugins/Webhooks/Controllers/GreenfieldStoreWebhooksController.cs @@ -6,14 +6,13 @@ using BTCPayServer.Abstractions.Extensions; using BTCPayServer.Client; using BTCPayServer.Client.Models; using BTCPayServer.Data; -using BTCPayServer.HostedServices.Webhooks; using BTCPayServer.Services.Stores; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Cors; using Microsoft.AspNetCore.Mvc; using Newtonsoft.Json.Linq; -namespace BTCPayServer.Controllers.Greenfield +namespace BTCPayServer.Plugins.Webhooks.Controllers { [ApiController] [Authorize(AuthenticationSchemes = AuthenticationSchemes.Greenfield, diff --git a/BTCPayServer/Controllers/UIStoresController.Integrations.cs b/BTCPayServer/Plugins/Webhooks/Controllers/UIStoreWebhooksController.cs similarity index 62% rename from BTCPayServer/Controllers/UIStoresController.Integrations.cs rename to BTCPayServer/Plugins/Webhooks/Controllers/UIStoreWebhooksController.cs index 9a737b461..e0525e4f8 100644 --- a/BTCPayServer/Controllers/UIStoresController.Integrations.cs +++ b/BTCPayServer/Plugins/Webhooks/Controllers/UIStoreWebhooksController.cs @@ -1,31 +1,42 @@ #nullable enable using System.Linq; -using System.Threading; using System.Threading.Tasks; using BTCPayServer.Abstractions.Constants; using BTCPayServer.Abstractions.Models; using BTCPayServer.Client; using BTCPayServer.Client.Models; using BTCPayServer.Data; -using BTCPayServer.Models.StoreViewModels; +using BTCPayServer.Plugins.Webhooks.Views; +using BTCPayServer.Services.Stores; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; +using Microsoft.Extensions.Localization; using NBitcoin; using NBitcoin.DataEncoders; -namespace BTCPayServer.Controllers; +namespace BTCPayServer.Plugins.Webhooks.Controllers; -public partial class UIStoresController +[Route("stores")] +[Authorize(AuthenticationSchemes = AuthenticationSchemes.Cookie)] +[Authorize(Policy = Policies.CanViewStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] +[AutoValidateAntiforgeryToken] +[Area(WebhooksPlugin.Area)] +public class UIStoreWebhooksController( + StoreRepository storeRepo, + IStringLocalizer stringLocalizer, + WebhookSender webhookSender) : Controller { + public Data.StoreData CurrentStore => HttpContext.GetStoreData(); + public IStringLocalizer StringLocalizer { get; set; } = stringLocalizer; private async Task LastDeliveryForWebhook(string webhookId) { - return (await _storeRepo.GetWebhookDeliveries(CurrentStore.Id, webhookId, 1)).ToList().FirstOrDefault(); + return (await storeRepo.GetWebhookDeliveries(CurrentStore.Id, webhookId, 1)).FirstOrDefault(); } [HttpGet("{storeId}/webhooks")] public async Task Webhooks() { - var webhooks = await _storeRepo.GetWebhooks(CurrentStore.Id); + var webhooks = await storeRepo.GetWebhooks(CurrentStore.Id); return View(nameof(Webhooks), new WebhooksViewModel { Webhooks = webhooks.Select(async w => @@ -59,26 +70,15 @@ public partial class UIStoresController }); } - [HttpGet("{storeId}/webhooks/{webhookId}/remove")] + [HttpPost("{storeId}/webhooks/{webhookId}/remove")] [Authorize(Policy = Policies.CanModifyStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] public async Task DeleteWebhook(string webhookId) { - var webhook = await _storeRepo.GetWebhook(CurrentStore.Id, webhookId); + var webhook = await storeRepo.GetWebhook(CurrentStore.Id, webhookId); if (webhook is null) return NotFound(); - return View("Confirm", new ConfirmModel(StringLocalizer["Delete webhook"], StringLocalizer["This webhook will be removed from this store. Are you sure?"], StringLocalizer["Delete"])); - } - - [HttpPost("{storeId}/webhooks/{webhookId}/remove")] - [Authorize(Policy = Policies.CanModifyStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] - public async Task DeleteWebhookPost(string webhookId) - { - var webhook = await _storeRepo.GetWebhook(CurrentStore.Id, webhookId); - if (webhook is null) - return NotFound(); - - await _storeRepo.DeleteWebhook(CurrentStore.Id, webhookId); + await storeRepo.DeleteWebhook(CurrentStore.Id, webhookId); TempData[WellKnownTempData.SuccessMessage] = StringLocalizer["Webhook successfully deleted"].Value; return RedirectToAction(nameof(Webhooks), new { storeId = CurrentStore.Id }); } @@ -90,7 +90,7 @@ public partial class UIStoresController if (!ModelState.IsValid) return View(nameof(ModifyWebhook), viewModel); - await _storeRepo.CreateWebhook(CurrentStore.Id, viewModel.CreateBlob()); + await storeRepo.CreateWebhook(CurrentStore.Id, viewModel.CreateBlob()); TempData[WellKnownTempData.SuccessMessage] = StringLocalizer["The webhook has been created"].Value; return RedirectToAction(nameof(Webhooks), new { storeId }); } @@ -99,12 +99,12 @@ public partial class UIStoresController [Authorize(Policy = Policies.CanModifyStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] public async Task ModifyWebhook(string webhookId) { - var webhook = await _storeRepo.GetWebhook(CurrentStore.Id, webhookId); + var webhook = await storeRepo.GetWebhook(CurrentStore.Id, webhookId); if (webhook is null) return NotFound(); var blob = webhook.GetBlob(); - var deliveries = await _storeRepo.GetWebhookDeliveries(CurrentStore.Id, webhookId, 20); + var deliveries = await storeRepo.GetWebhookDeliveries(CurrentStore.Id, webhookId, 20); return View(nameof(ModifyWebhook), new EditWebhookViewModel(blob) { Deliveries = deliveries @@ -116,55 +116,26 @@ public partial class UIStoresController [Authorize(Policy = Policies.CanModifyStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] public async Task ModifyWebhook(string webhookId, EditWebhookViewModel viewModel) { - var webhook = await _storeRepo.GetWebhook(CurrentStore.Id, webhookId); + var webhook = await storeRepo.GetWebhook(CurrentStore.Id, webhookId); if (webhook is null) return NotFound(); if (!ModelState.IsValid) return View(nameof(ModifyWebhook), viewModel); - await _storeRepo.UpdateWebhook(CurrentStore.Id, webhookId, viewModel.CreateBlob()); + await storeRepo.UpdateWebhook(CurrentStore.Id, webhookId, viewModel.CreateBlob()); TempData[WellKnownTempData.SuccessMessage] = StringLocalizer["The webhook has been updated"].Value; return RedirectToAction(nameof(Webhooks), new { storeId = CurrentStore.Id }); } - [HttpGet("{storeId}/webhooks/{webhookId}/test")] - [Authorize(Policy = Policies.CanModifyStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] - public async Task TestWebhook(string webhookId) - { - var webhook = await _storeRepo.GetWebhook(CurrentStore.Id, webhookId); - if (webhook is null) - return NotFound(); - - return View(nameof(TestWebhook)); - } - - [HttpPost("{storeId}/webhooks/{webhookId}/test")] - [Authorize(Policy = Policies.CanModifyStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] - public async Task TestWebhook(string webhookId, TestWebhookViewModel viewModel, CancellationToken cancellationToken) - { - var result = await _webhookNotificationManager.TestWebhook(CurrentStore.Id, webhookId, viewModel.Type, cancellationToken); - - if (result.Success) - { - TempData[WellKnownTempData.SuccessMessage] = StringLocalizer["{0} event delivered successfully! Delivery ID is {1}", viewModel.Type, result.DeliveryId!].Value; - } - else - { - TempData[WellKnownTempData.ErrorMessage] = StringLocalizer["{0} event could not be delivered. Error message received: {1}", viewModel.Type, result.ErrorMessage ?? StringLocalizer["unknown"].Value].Value; - } - - return View(nameof(TestWebhook)); - } - [HttpPost("{storeId}/webhooks/{webhookId}/deliveries/{deliveryId}/redeliver")] [Authorize(Policy = Policies.CanModifyStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] public async Task RedeliverWebhook(string webhookId, string deliveryId) { - var delivery = await _storeRepo.GetWebhookDelivery(CurrentStore.Id, webhookId, deliveryId); + var delivery = await storeRepo.GetWebhookDelivery(CurrentStore.Id, webhookId, deliveryId); if (delivery is null) return NotFound(); - var newDeliveryId = await _webhookNotificationManager.Redeliver(deliveryId); + var newDeliveryId = await webhookSender.Redeliver(deliveryId); if (newDeliveryId is null) return NotFound(); @@ -181,7 +152,7 @@ public partial class UIStoresController [Authorize(Policy = Policies.CanModifyStoreSettings, AuthenticationSchemes = AuthenticationSchemes.Cookie)] public async Task WebhookDelivery(string webhookId, string deliveryId) { - var delivery = await _storeRepo.GetWebhookDelivery(CurrentStore.Id, webhookId, deliveryId); + var delivery = await storeRepo.GetWebhookDelivery(CurrentStore.Id, webhookId, deliveryId); if (delivery is null) return NotFound(); diff --git a/BTCPayServer/HostedServices/CleanupWebhookDeliveriesTask.cs b/BTCPayServer/Plugins/Webhooks/HostedServices/CleanupWebhookDeliveriesTask.cs similarity index 94% rename from BTCPayServer/HostedServices/CleanupWebhookDeliveriesTask.cs rename to BTCPayServer/Plugins/Webhooks/HostedServices/CleanupWebhookDeliveriesTask.cs index fb81ff1cc..0f83a1af5 100644 --- a/BTCPayServer/HostedServices/CleanupWebhookDeliveriesTask.cs +++ b/BTCPayServer/Plugins/Webhooks/HostedServices/CleanupWebhookDeliveriesTask.cs @@ -1,14 +1,13 @@ using System; using Dapper; -using System.Data.Common; using System.Linq; using System.Threading; using System.Threading.Tasks; using BTCPayServer.Data; using Microsoft.EntityFrameworkCore; -using System.Collections.Generic; +using BTCPayServer.HostedServices; -namespace BTCPayServer.HostedServices +namespace BTCPayServer.Plugins.Webhooks.HostedServices { public class CleanupWebhookDeliveriesTask : IPeriodicTask { diff --git a/BTCPayServer/Plugins/Webhooks/HostedServices/WebhookProviderHostedService.cs b/BTCPayServer/Plugins/Webhooks/HostedServices/WebhookProviderHostedService.cs new file mode 100644 index 000000000..af6f15df1 --- /dev/null +++ b/BTCPayServer/Plugins/Webhooks/HostedServices/WebhookProviderHostedService.cs @@ -0,0 +1,76 @@ +#nullable enable +using System.Collections.Generic; +using System.Linq; +using System.Threading; +using System.Threading.Tasks; +using BTCPayServer.Client.Models; +using BTCPayServer.Data; +using BTCPayServer.HostedServices; +using BTCPayServer.Plugins.Emails; +using Microsoft.Extensions.Logging; +using Newtonsoft.Json; +using StoreData = BTCPayServer.Data.StoreData; + +namespace BTCPayServer.Plugins.Webhooks.HostedServices; + +/// +/// This class listen to events and create webhook notifications and trigger event from it. +/// +public class WebhookProviderHostedService( + EventAggregator eventAggregator, + ApplicationDbContextFactory dbContextFactory, + IEnumerable webhookTriggerProviders, + WebhookSender webhookSender, + ILogger logger) + : EventHostedServiceBase(eventAggregator, logger) +{ + class WebhookTriggerOwner(WebhookTriggerProvider provider, WebhookTriggerContext ctx) : ITriggerOwner + { + public Task BeforeSending(EmailRuleMatchContext context) + => provider.BeforeSending(context, ctx); + } + + protected override void SubscribeToEvents() + { + SubscribeAny(); + } + + protected override async Task ProcessEvent(object evt, CancellationToken cancellationToken) + { + var (provider, webhookEvent) = webhookTriggerProviders + .Select(o => (o, o.GetWebhookEvent(evt))) + .FirstOrDefault(o => o.Item2 is not null); + if (webhookEvent is null || provider is null) + return; + + var webhooks = await webhookSender.GetWebhooks(webhookEvent.StoreId, webhookEvent.Type); + foreach (var webhook in webhooks) + { + var ev = Clone(webhookEvent); + ev.WebhookId = webhook.Id; + var delivery = Data.WebhookDeliveryData.Create(webhook.Id); + ev.DeliveryId = delivery.Id; + ev.OriginalDeliveryId = delivery.Id; + ev.Timestamp = delivery.Timestamp; + ev.IsRedelivery = false; + webhookSender.EnqueueDelivery(new(webhook.Id, ev, delivery, webhook.GetBlob())); + } + + if (await GetStore(webhookEvent) is {} store) + { + var ctx = provider.CreateWebhookTriggerContext(store, evt, webhookEvent); + var triggerEvent = new TriggerEvent(webhookEvent.StoreId, EmailRuleData.GetWebhookTriggerName(webhookEvent.Type), + await provider.GetEmailModel(ctx), new WebhookTriggerOwner(provider, ctx)); + EventAggregator.Publish(triggerEvent); + } + } + + private StoreWebhookEvent Clone(StoreWebhookEvent webhookEvent) + => (StoreWebhookEvent)JsonConvert.DeserializeObject(JsonConvert.SerializeObject(webhookEvent), webhookEvent.GetType(), WebhookSender.DefaultSerializerSettings)!; + + private async Task GetStore(StoreWebhookEvent webhookEvent) + { + await using var ctx = dbContextFactory.CreateContext(); + return await ctx.Stores.FindAsync(webhookEvent.StoreId); + } +} diff --git a/BTCPayServer/Plugins/Webhooks/TriggerProviders/InvoiceTriggerProvider.cs b/BTCPayServer/Plugins/Webhooks/TriggerProviders/InvoiceTriggerProvider.cs new file mode 100644 index 000000000..1bd661dc4 --- /dev/null +++ b/BTCPayServer/Plugins/Webhooks/TriggerProviders/InvoiceTriggerProvider.cs @@ -0,0 +1,91 @@ +#nullable enable +using System.Threading.Tasks; +using BTCPayServer.Client.Models; +using BTCPayServer.Controllers.Greenfield; +using BTCPayServer.Events; +using BTCPayServer.Plugins.Emails; +using Microsoft.AspNetCore.Mvc; +using Microsoft.AspNetCore.Routing; +using Newtonsoft.Json.Linq; + +namespace BTCPayServer.Plugins.Webhooks.TriggerProviders; + +public class InvoiceTriggerProvider(LinkGenerator linkGenerator) + : WebhookTriggerProvider +{ + protected override async Task GetEmailModel(WebhookTriggerContext webhookTriggerContext) + { + var evt = webhookTriggerContext.Event; + var model = await base.GetEmailModel(webhookTriggerContext); + // Keep for backward compatibility + model["Invoice"] = new JObject() + { + ["Id"] = evt.Invoice.Id, + ["StoreId"] = evt.Invoice.StoreId, + ["Price"] = evt.Invoice.Price, + ["Currency"] = evt.Invoice.Currency, + ["Status"] = evt.Invoice.Status.ToString(), + ["AdditionalStatus"] = evt.Invoice.ExceptionStatus.ToString(), + ["OrderId"] = evt.Invoice.Metadata.OrderId, + ["Metadata"] = evt.Invoice.Metadata.ToJObject(), + ["Link"] = linkGenerator.InvoiceLink(evt.InvoiceId, evt.Invoice.GetRequestBaseUrl()) + }; + return model; + } + + protected override Task BeforeSending(EmailRuleMatchContext context, WebhookTriggerContext webhookTriggerContext) + { + var evt = webhookTriggerContext.Event; + var email = evt.Invoice.Metadata?.BuyerEmail; + if (email != null && + context.MatchedRule.GetBTCPayAdditionalData()?.CustomerEmail is true && + MailboxAddressValidator.TryParse(email, out var mb)) + { + context.Recipients.Insert(0, mb); + } + return Task.CompletedTask; + } + + protected override WebhookInvoiceEvent? GetWebhookEvent(InvoiceEvent invoiceEvent) + { + var eventCode = invoiceEvent.EventCode; + var storeId = invoiceEvent.Invoice.StoreId; + var evt = eventCode switch + { + InvoiceEventCode.Confirmed or InvoiceEventCode.MarkedCompleted => new WebhookInvoiceSettledEvent(storeId) + { + ManuallyMarked = eventCode == InvoiceEventCode.MarkedCompleted, + OverPaid = invoiceEvent.Invoice.ExceptionStatus == InvoiceExceptionStatus.PaidOver + }, + InvoiceEventCode.Created => new WebhookInvoiceEvent(WebhookEventType.InvoiceCreated, storeId), + InvoiceEventCode.Expired => new WebhookInvoiceExpiredEvent(storeId) { PartiallyPaid = invoiceEvent.PaidPartial }, + InvoiceEventCode.FailedToConfirm or InvoiceEventCode.MarkedInvalid => new WebhookInvoiceInvalidEvent(storeId) { ManuallyMarked = eventCode == InvoiceEventCode.MarkedInvalid }, + InvoiceEventCode.PaidInFull => new WebhookInvoiceProcessingEvent(storeId) { OverPaid = invoiceEvent.Invoice.ExceptionStatus == InvoiceExceptionStatus.PaidOver }, + InvoiceEventCode.ReceivedPayment => new WebhookInvoiceReceivedPaymentEvent(WebhookEventType.InvoiceReceivedPayment, storeId) + { + AfterExpiration = + invoiceEvent.Invoice.Status == InvoiceStatus.Expired || + invoiceEvent.Invoice.Status == InvoiceStatus.Invalid, + PaymentMethodId = invoiceEvent.Payment.PaymentMethodId.ToString(), + Payment = GreenfieldInvoiceController.ToPaymentModel(invoiceEvent.Invoice, invoiceEvent.Payment) + }, + InvoiceEventCode.PaymentSettled => new WebhookInvoiceReceivedPaymentEvent(WebhookEventType.InvoicePaymentSettled, storeId) + { + AfterExpiration = + invoiceEvent.Invoice.Status == InvoiceStatus.Expired || + invoiceEvent.Invoice.Status == InvoiceStatus.Invalid, + PaymentMethodId = invoiceEvent.Payment.PaymentMethodId.ToString(), + Payment = GreenfieldInvoiceController.ToPaymentModel(invoiceEvent.Invoice, invoiceEvent.Payment) + }, + InvoiceEventCode.ExpiredPaidPartial => new WebhookInvoiceEvent(WebhookEventType.InvoiceExpiredPaidPartial, storeId), + InvoiceEventCode.PaidAfterExpiration => new WebhookInvoiceEvent(WebhookEventType.InvoicePaidAfterExpiration, storeId), + _ => null + }; + if (evt is null) + return null; + evt.StoreId = storeId; + evt.InvoiceId = invoiceEvent.InvoiceId; + evt.Metadata = invoiceEvent.Invoice.Metadata.ToJObject(); + return evt; + } +} diff --git a/BTCPayServer/Plugins/Webhooks/TriggerProviders/PaymentRequestTriggerProvider.cs b/BTCPayServer/Plugins/Webhooks/TriggerProviders/PaymentRequestTriggerProvider.cs new file mode 100644 index 000000000..bf6431c04 --- /dev/null +++ b/BTCPayServer/Plugins/Webhooks/TriggerProviders/PaymentRequestTriggerProvider.cs @@ -0,0 +1,79 @@ +#nullable enable +using System.Globalization; +using System.Threading.Tasks; +using BTCPayServer.Abstractions; +using BTCPayServer.Client.Models; +using BTCPayServer.Data; +using BTCPayServer.HostedServices; +using BTCPayServer.Plugins.Emails; +using BTCPayServer.Services.PaymentRequests; +using Microsoft.AspNetCore.Mvc; +using Microsoft.AspNetCore.Routing; +using Newtonsoft.Json.Linq; + +namespace BTCPayServer.Plugins.Webhooks.TriggerProviders; + +public class PaymentRequestTriggerProvider(LinkGenerator linkGenerator) + : WebhookTriggerProvider +{ + protected override WebhookPaymentRequestEvent? GetWebhookEvent(PaymentRequestEvent evt) + { + var webhookEvt = evt.Type switch + { + PaymentRequestEvent.Created => new WebhookPaymentRequestEvent(WebhookEventType.PaymentRequestCreated, evt.Data.StoreDataId), + PaymentRequestEvent.Updated => new WebhookPaymentRequestEvent(WebhookEventType.PaymentRequestUpdated, evt.Data.StoreDataId), + PaymentRequestEvent.Archived => new WebhookPaymentRequestEvent(WebhookEventType.PaymentRequestArchived, evt.Data.StoreDataId), + PaymentRequestEvent.StatusChanged => new WebhookPaymentRequestEvent(WebhookEventType.PaymentRequestStatusChanged, evt.Data.StoreDataId), + PaymentRequestEvent.Completed => new WebhookPaymentRequestEvent(WebhookEventType.PaymentRequestCompleted, evt.Data.StoreDataId), + _ => null + }; + if (webhookEvt is null) + return null; + webhookEvt.StoreId = evt.Data.StoreDataId; + webhookEvt.PaymentRequestId = evt.Data.Id; + webhookEvt.Status = evt.Data.Status; + return webhookEvt; + } + + protected override Task BeforeSending(EmailRuleMatchContext context, WebhookTriggerContext webhookTriggerContext) + { + var email = webhookTriggerContext.Event.Data.GetBlob()?.Email; + if (email != null && + context.MatchedRule.GetBTCPayAdditionalData()?.CustomerEmail is true && + MailboxAddressValidator.TryParse(email, out var mb)) + { + context.Recipients.Insert(0, mb); + } + return Task.CompletedTask; + } + + protected override async Task GetEmailModel(WebhookTriggerContext webhookTriggerContext) + { + var model = await base.GetEmailModel(webhookTriggerContext); + var evt = webhookTriggerContext.Event; + var data = evt.Data; + var id = data.Id; + var trimmedId = !string.IsNullOrEmpty(id) && id.Length > 15 ? $"{id.Substring(0, 7)}...{id.Substring(id.Length - 7)}" : id; + var blob = data.GetBlob(); + var o = new JObject() + { + ["Id"] = id, + ["TrimmedId"] = trimmedId, + ["Amount"] = data.Amount.ToString(CultureInfo.InvariantCulture), + ["Currency"] = data.Currency, + ["Title"] = blob.Title, + ["Description"] = blob.Description, + ["ReferenceId"] = data.ReferenceId, + ["Status"] = evt.Data.Status.ToString(), + ["FormResponse"] = blob.FormResponse, + }; + model["PaymentRequest"] = o; + + if (blob.RequestBaseUrl is not null && RequestBaseUrl.TryFromUrl(blob.RequestBaseUrl, out var v)) + { + o["Link"] = linkGenerator.PaymentRequestLink(id, v); + } + + return model; + } +} diff --git a/BTCPayServer/Plugins/Webhooks/TriggerProviders/PayoutTriggerProvider.cs b/BTCPayServer/Plugins/Webhooks/TriggerProviders/PayoutTriggerProvider.cs new file mode 100644 index 000000000..1509a6628 --- /dev/null +++ b/BTCPayServer/Plugins/Webhooks/TriggerProviders/PayoutTriggerProvider.cs @@ -0,0 +1,44 @@ +#nullable enable +using System.Threading.Tasks; +using BTCPayServer.Client.Models; +using BTCPayServer.Data; +using BTCPayServer.HostedServices; +using BTCPayServer.Services; +using Newtonsoft.Json.Linq; + +namespace BTCPayServer.Plugins.Webhooks.TriggerProviders; + +public class PayoutTriggerProvider(BTCPayNetworkJsonSerializerSettings btcPayNetworkJsonSerializerSettings) : WebhookTriggerProvider +{ + protected override async Task GetEmailModel(WebhookTriggerContext webhookTriggerContext) + { + var evt = webhookTriggerContext.Event; + var blob = evt.Payout.GetBlob(btcPayNetworkJsonSerializerSettings); + var model = await base.GetEmailModel(webhookTriggerContext); + model["Payout"] = new JObject() + { + ["Id"] = evt.Payout.Id, + ["PullPaymentId"] = evt.Payout.PullPaymentDataId, + ["Destination"] = evt.Payout.DedupId ?? blob.Destination, + ["State"] = evt.Payout.State.ToString(), + ["Metadata"] = blob.Metadata + }; + return model; + } + protected override StoreWebhookEvent? GetWebhookEvent(PayoutEvent payoutEvent) + { + var webhookEvt = payoutEvent.Type switch + { + PayoutEvent.PayoutEventType.Created => new WebhookPayoutEvent(WebhookEventType.PayoutCreated, payoutEvent.Payout.StoreDataId), + PayoutEvent.PayoutEventType.Approved => new WebhookPayoutEvent(WebhookEventType.PayoutApproved, payoutEvent.Payout.StoreDataId), + PayoutEvent.PayoutEventType.Updated => new WebhookPayoutEvent(WebhookEventType.PayoutUpdated, payoutEvent.Payout.StoreDataId), + _ => null + }; + if (webhookEvt is null) + return null; + webhookEvt.PayoutId = payoutEvent.Payout.Id; + webhookEvt.PayoutState = payoutEvent.Payout.State; + webhookEvt.PullPaymentId = payoutEvent.Payout.PullPaymentDataId; + return webhookEvt; + } +} diff --git a/BTCPayServer/Plugins/Webhooks/TriggerProviders/PendingTransactionTriggerProvider.cs b/BTCPayServer/Plugins/Webhooks/TriggerProviders/PendingTransactionTriggerProvider.cs new file mode 100644 index 000000000..2d8028a7b --- /dev/null +++ b/BTCPayServer/Plugins/Webhooks/TriggerProviders/PendingTransactionTriggerProvider.cs @@ -0,0 +1,80 @@ +#nullable enable +using System.Threading.Tasks; +using BTCPayServer.Abstractions; +using BTCPayServer.Client.Models; +using BTCPayServer.Data; +using BTCPayServer.HostedServices; +using Microsoft.AspNetCore.Mvc; +using Microsoft.AspNetCore.Routing; +using Newtonsoft.Json; +using Newtonsoft.Json.Linq; + +namespace BTCPayServer.Plugins.Webhooks.TriggerProviders; + +public class PendingTransactionTriggerProvider + (LinkGenerator linkGenerator) : WebhookTriggerProvider +{ + public const string PendingTransactionCreated = nameof(PendingTransactionCreated); + public const string PendingTransactionSignatureCollected = nameof(PendingTransactionSignatureCollected); + public const string PendingTransactionBroadcast = nameof(PendingTransactionBroadcast); + public const string PendingTransactionCancelled = nameof(PendingTransactionCancelled); + + protected override async Task GetEmailModel(WebhookTriggerContext webhookTriggerContext) + { + var evt = webhookTriggerContext.Event; + var id = evt.Data.TransactionId; + var trimmedId = !string.IsNullOrEmpty(id) && id.Length > 15 ? $"{id.Substring(0, 7)}...{id.Substring(id.Length - 7)}" : id; + + var blob = evt.Data.GetBlob() ?? new(); + var model = await base.GetEmailModel(webhookTriggerContext); + var o = new JObject() + { + ["Id"] = id, + ["TrimmedId"] = trimmedId, + ["StoreId"] = evt.Data.StoreId, + ["SignaturesCollected"] = blob.SignaturesCollected, + ["SignaturesNeeded"] = blob.SignaturesNeeded, + ["SignaturesTotal"] = blob.SignaturesTotal + }; + model["PendingTransaction"] = o; + if (blob.RequestBaseUrl is not null && RequestBaseUrl.TryFromUrl(blob.RequestBaseUrl, out var v)) + { + o["Link"] = linkGenerator.WalletTransactionsLink(new(webhookTriggerContext.Store.Id, evt.Data.CryptoCode), v); + } + + return model; + } + + protected override WebhookPendingTransactionEvent? GetWebhookEvent(PendingTransactionService.PendingTransactionEvent evt) + { + var webhook = evt.Type switch + { + PendingTransactionService.PendingTransactionEvent.Created => new WebhookPendingTransactionEvent( + PendingTransactionCreated, evt.Data.StoreId, evt.Data.CryptoCode), + PendingTransactionService.PendingTransactionEvent.SignatureCollected => new WebhookPendingTransactionEvent( + PendingTransactionSignatureCollected, evt.Data.StoreId, evt.Data.CryptoCode), + PendingTransactionService.PendingTransactionEvent.Broadcast => new WebhookPendingTransactionEvent( + PendingTransactionBroadcast, evt.Data.StoreId, evt.Data.CryptoCode), + PendingTransactionService.PendingTransactionEvent.Cancelled => new WebhookPendingTransactionEvent( + PendingTransactionCancelled, evt.Data.StoreId, evt.Data.CryptoCode), + _ => null + }; + if (webhook is not null) + webhook.PendingTransactionId = evt.Data.TransactionId; + return webhook; + } + + public class WebhookPendingTransactionEvent : StoreWebhookEvent + { + public WebhookPendingTransactionEvent(string type, string storeId, string cryptoCode) + { + Type = type; + StoreId = storeId; + CryptoCode = cryptoCode; + } + + public string CryptoCode { get; set; } + + [JsonProperty(Order = 2)] public string PendingTransactionId { get; set; } = null!; + } +} diff --git a/BTCPayServer/Plugins/Webhooks/Views/AvailableWebhookViewModel.cs b/BTCPayServer/Plugins/Webhooks/Views/AvailableWebhookViewModel.cs new file mode 100644 index 000000000..56aa83eda --- /dev/null +++ b/BTCPayServer/Plugins/Webhooks/Views/AvailableWebhookViewModel.cs @@ -0,0 +1,12 @@ +namespace BTCPayServer.Plugins.Webhooks.Views; + +/// +/// Used to represent available webhooks with their descriptions in the ModifyWebhook view +/// +/// The webhook type +/// User friendly description +public class AvailableWebhookViewModel(string type, string description) +{ + public string Type { get; } = type; + public string Description { get; } = description; +} diff --git a/BTCPayServer/Models/StoreViewModels/EditWebhookViewModel.cs b/BTCPayServer/Plugins/Webhooks/Views/EditWebhookViewModel.cs similarity index 95% rename from BTCPayServer/Models/StoreViewModels/EditWebhookViewModel.cs rename to BTCPayServer/Plugins/Webhooks/Views/EditWebhookViewModel.cs index 467848687..90252062c 100644 --- a/BTCPayServer/Models/StoreViewModels/EditWebhookViewModel.cs +++ b/BTCPayServer/Plugins/Webhooks/Views/EditWebhookViewModel.cs @@ -1,13 +1,11 @@ using System; using System.Collections.Generic; using System.ComponentModel.DataAnnotations; -using System.Linq; -using System.Threading.Tasks; using BTCPayServer.Client.Models; using BTCPayServer.Data; using BTCPayServer.Validation; -namespace BTCPayServer.Models.StoreViewModels +namespace BTCPayServer.Plugins.Webhooks.Views { public class DeliveryViewModel { @@ -25,7 +23,7 @@ namespace BTCPayServer.Models.StoreViewModels var evt = blob.ReadRequestAs(); Type = evt.Type; Pruned = evt.IsPruned(); - WebhookId = s.Id; + WebhookId = s.WebhookId; PayloadUrl = s.Webhook?.GetBlob().Url; } public string Id { get; set; } diff --git a/BTCPayServer/Views/UIStores/ModifyWebhook.cshtml b/BTCPayServer/Plugins/Webhooks/Views/ModifyWebhook.cshtml similarity index 94% rename from BTCPayServer/Views/UIStores/ModifyWebhook.cshtml rename to BTCPayServer/Plugins/Webhooks/Views/ModifyWebhook.cshtml index 15c85abd3..9c385d80f 100644 --- a/BTCPayServer/Views/UIStores/ModifyWebhook.cshtml +++ b/BTCPayServer/Plugins/Webhooks/Views/ModifyWebhook.cshtml @@ -1,6 +1,5 @@ @model EditWebhookViewModel -@using BTCPayServer.HostedServices.Webhooks -@inject WebhookSender WebhookSender +@inject IEnumerable Webhooks @{ var storeId = Context.GetStoreData().Id; ViewData.SetActivePage(StoreNavPages.Webhooks, StringLocalizer["Webhook"], storeId); @@ -75,11 +74,11 @@
    - @foreach (var evt in WebhookSender.GetSupportedWebhookTypes()) + @foreach (var evt in Webhooks) {
    - - + +
    }
    diff --git a/BTCPayServer/Views/UIStores/Webhooks.cshtml b/BTCPayServer/Plugins/Webhooks/Views/Webhooks.cshtml similarity index 94% rename from BTCPayServer/Views/UIStores/Webhooks.cshtml rename to BTCPayServer/Plugins/Webhooks/Views/Webhooks.cshtml index 76a528c37..ddbcaa1cf 100644 --- a/BTCPayServer/Views/UIStores/Webhooks.cshtml +++ b/BTCPayServer/Plugins/Webhooks/Views/Webhooks.cshtml @@ -1,6 +1,5 @@ @using BTCPayServer.Abstractions.Models @using BTCPayServer.Client -@using Microsoft.AspNetCore.Mvc.TagHelpers @model WebhooksViewModel @{ ViewData.SetActivePage(StoreNavPages.Webhooks, StringLocalizer["Webhooks"], Context.GetStoreData().Id); @@ -53,7 +52,6 @@ @wh.Url - Test - Modify - Delete diff --git a/BTCPayServer/Models/StoreViewModels/WebhooksViewModel.cs b/BTCPayServer/Plugins/Webhooks/Views/WebhooksViewModel.cs similarity index 91% rename from BTCPayServer/Models/StoreViewModels/WebhooksViewModel.cs rename to BTCPayServer/Plugins/Webhooks/Views/WebhooksViewModel.cs index e4c09daff..21d786e5d 100644 --- a/BTCPayServer/Models/StoreViewModels/WebhooksViewModel.cs +++ b/BTCPayServer/Plugins/Webhooks/Views/WebhooksViewModel.cs @@ -1,6 +1,6 @@ using System; -namespace BTCPayServer.Models.StoreViewModels +namespace BTCPayServer.Plugins.Webhooks.Views { public class WebhooksViewModel { diff --git a/BTCPayServer/Plugins/Webhooks/Views/_ViewImports.cshtml b/BTCPayServer/Plugins/Webhooks/Views/_ViewImports.cshtml new file mode 100644 index 000000000..c30743a65 --- /dev/null +++ b/BTCPayServer/Plugins/Webhooks/Views/_ViewImports.cshtml @@ -0,0 +1,6 @@ +@using BTCPayServer.Plugins.Webhooks +@using BTCPayServer.TagHelpers +@using Microsoft.AspNetCore.Mvc.TagHelpers +@using BTCPayServer.Views.Stores +@namespace BTCPayServer.Plugins.Webhooks.Views + diff --git a/BTCPayServer/Plugins/Webhooks/Views/_ViewStart.cshtml b/BTCPayServer/Plugins/Webhooks/Views/_ViewStart.cshtml new file mode 100644 index 000000000..a5f10045d --- /dev/null +++ b/BTCPayServer/Plugins/Webhooks/Views/_ViewStart.cshtml @@ -0,0 +1,3 @@ +@{ + Layout = "_Layout"; +} diff --git a/BTCPayServer/Data/WebhookDataExtensions.cs b/BTCPayServer/Plugins/Webhooks/WebhookDataExtensions.cs similarity index 94% rename from BTCPayServer/Data/WebhookDataExtensions.cs rename to BTCPayServer/Plugins/Webhooks/WebhookDataExtensions.cs index 31fe898e1..3bc2e4780 100644 --- a/BTCPayServer/Data/WebhookDataExtensions.cs +++ b/BTCPayServer/Plugins/Webhooks/WebhookDataExtensions.cs @@ -1,12 +1,8 @@ using System; -using System.Collections.Generic; -using System.ComponentModel; using System.Linq; using System.Text; -using System.Threading.Tasks; using BTCPayServer.Client.Models; -using BTCPayServer.HostedServices.Webhooks; -using Microsoft.CodeAnalysis.CSharp.Syntax; +using BTCPayServer.Plugins.Webhooks; using Newtonsoft.Json; using Newtonsoft.Json.Linq; @@ -61,6 +57,8 @@ namespace BTCPayServer.Data public string Secret { get; set; } public bool AutomaticRedelivery { get; set; } public AuthorizedWebhookEvents AuthorizedEvents { get; set; } + public bool ShouldDeliver(string type) + => Active && AuthorizedEvents.Match(type); } public static class WebhookDataExtensions { diff --git a/BTCPayServer/Plugins/Webhooks/WebhookExtensions.cs b/BTCPayServer/Plugins/Webhooks/WebhookExtensions.cs new file mode 100644 index 000000000..ad46178ca --- /dev/null +++ b/BTCPayServer/Plugins/Webhooks/WebhookExtensions.cs @@ -0,0 +1,32 @@ +using System; +using System.Collections.Generic; +using BTCPayServer.Data; +using BTCPayServer.Plugins.Emails.Views; +using BTCPayServer.Plugins.Webhooks; +using BTCPayServer.Plugins.Webhooks.Views; +using Microsoft.Extensions.DependencyInjection; + +namespace BTCPayServer; + +public static class WebhookExtensions +{ + public static IServiceCollection AddWebhookTriggerProvider(this IServiceCollection services) where T : WebhookTriggerProvider + { + services.AddSingleton(); + services.AddSingleton(o => o.GetRequiredService()); + return services; + } + public static IServiceCollection AddWebhookTriggerViewModels(this IServiceCollection services, IEnumerable viewModels) + { + foreach(var trigger in viewModels) + { + var webhookType = trigger.Type; + if (trigger.Type.StartsWith("WH-")) + throw new ArgumentException("Webhook type cannot start with WH-"); + trigger.Type = EmailRuleData.GetWebhookTriggerName(trigger.Type); + services.AddSingleton(new AvailableWebhookViewModel(webhookType, trigger.Description)); + services.AddSingleton(trigger); + } + return services; + } +} diff --git a/BTCPayServer/HostedServices/Webhooks/WebhookSender.cs b/BTCPayServer/Plugins/Webhooks/WebhookSender.cs similarity index 63% rename from BTCPayServer/HostedServices/Webhooks/WebhookSender.cs rename to BTCPayServer/Plugins/Webhooks/WebhookSender.cs index e7b19a7b8..5070abbaa 100644 --- a/BTCPayServer/HostedServices/Webhooks/WebhookSender.cs +++ b/BTCPayServer/Plugins/Webhooks/WebhookSender.cs @@ -6,23 +6,19 @@ using System.Net.Http; using System.Net.Http.Headers; using System.Security.Cryptography; using System.Text; -using System.Text.RegularExpressions; using System.Threading; using System.Threading.Tasks; using BTCPayServer.Client.Models; -using BTCPayServer.Controllers; using BTCPayServer.Data; using BTCPayServer.Services.Stores; using Microsoft.EntityFrameworkCore; -using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Hosting; using Microsoft.Extensions.Logging; using NBitcoin.DataEncoders; using Newtonsoft.Json; -using Newtonsoft.Json.Linq; using WebhookDeliveryData = BTCPayServer.Data.WebhookDeliveryData; -namespace BTCPayServer.HostedServices.Webhooks; +namespace BTCPayServer.Plugins.Webhooks; /// /// This class sends webhook notifications @@ -32,8 +28,7 @@ public class WebhookSender( StoreRepository storeRepository, IHttpClientFactory httpClientFactory, ApplicationDbContextFactory dbContextFactory, - ILogger logger, - IServiceProvider serviceProvider) + ILogger logger) : IHostedService { public const string OnionNamedClient = "greenfield-webhook.onion"; @@ -93,7 +88,7 @@ public class WebhookSender( if (webhookDelivery is null) return null; var oldDeliveryBlob = webhookDelivery.Delivery.GetBlob(); - var newDelivery = WebhookExtensions.NewWebhookDelivery(webhookDelivery.Webhook.Id); + var newDelivery = WebhookDeliveryData.Create(webhookDelivery.Webhook.Id); WebhookDeliveryBlob newDeliveryBlob = new(); newDeliveryBlob.Request = oldDeliveryBlob.Request; var webhookEvent = newDeliveryBlob.ReadRequestAs(); @@ -110,42 +105,6 @@ public class WebhookSender( webhookDelivery.Webhook.GetBlob()); } - private WebhookEvent GetTestWebHook(string storeId, string webhookId, string webhookEventType, - WebhookDeliveryData delivery) - { - var webhookProvider = serviceProvider.GetServices() - .FirstOrDefault(provider => provider.GetSupportedWebhookTypes().ContainsKey(webhookEventType)); - - if (webhookProvider is null) - throw new ArgumentException($"Unknown webhook event type {webhookEventType}", webhookEventType); - - var webhookEvent = webhookProvider.CreateTestEvent(webhookEventType, storeId); - if (webhookEvent is null) - throw new ArgumentException("Webhook provider does not support tests"); - - webhookEvent.DeliveryId = delivery.Id; - webhookEvent.WebhookId = webhookId; - webhookEvent.OriginalDeliveryId = "__test__" + Guid.NewGuid() + "__test__"; - webhookEvent.IsRedelivery = false; - webhookEvent.Timestamp = delivery.Timestamp; - - return webhookEvent; - } - - public async Task TestWebhook(string storeId, string webhookId, string webhookEventType, - CancellationToken cancellationToken) - { - var delivery = WebhookExtensions.NewWebhookDelivery(webhookId); - var webhook = (await StoreRepository.GetWebhooks(storeId)).FirstOrDefault(w => w.Id == webhookId); - WebhookDeliveryRequest deliveryRequest = new( - webhookId, - GetTestWebHook(storeId, webhookId, webhookEventType, delivery), - delivery, - webhook.GetBlob() - ); - return await SendDelivery(deliveryRequest, cancellationToken); - } - public void EnqueueDelivery(WebhookDeliveryRequest context) { _processingQueue.Enqueue(context.WebhookId, cancellationToken => Process(context, cancellationToken)); @@ -160,8 +119,7 @@ public class WebhookSender( return; var result = await SendAndSaveDelivery(ctx, cancellationToken); if (ctx.WebhookBlob.AutomaticRedelivery && - !result.Success && - result.DeliveryId is not null) + result is { Success: false, DeliveryId: not null }) { var originalDeliveryId = result.DeliveryId; foreach (var wait in new[] @@ -254,89 +212,16 @@ public class WebhookSender( return (await StoreRepository.GetWebhooks(invoiceStoreId)).Where(data => webhookEventType is null || data.GetBlob().ShouldDeliver(webhookEventType)) .ToArray(); } - - public async Task GetEmailRules(string storeId, - string type) - { - return (await StoreRepository.FindStore(storeId))?.GetStoreBlob().EmailRules?.Where(rule => rule.Trigger == type).ToArray() ?? - Array.Empty(); - } - - public Dictionary GetSupportedWebhookTypes() - { - return serviceProvider.GetServices() - .SelectMany(provider => provider.GetSupportedWebhookTypes()).ToDictionary(pair => pair.Key, pair => pair.Value); - } - - public Dictionary GetWebhookTypesSupportedByCustomerEmail() - { - return serviceProvider.GetServices() - .SelectMany(provider => provider.GetSupportedWebhookTypes() - .Select(pair => new { pair.Key, Value = provider.SupportsCustomerEmail })) - .ToDictionary(x => x.Key, x => x.Value); - } - public class WebhookDeliveryRequest( string webhookId, WebhookEvent webhookEvent, WebhookDeliveryData delivery, WebhookBlob webhookBlob) { - // Regex pattern to validate JSONPath: alphanumeric, underscore, dot, hyphen, square brackets, asterisk, single/double quotes - private static readonly Regex _jsonPathRegex = new(@"^[a-zA-Z0-9_\.\-\[\]\*'""]*$", RegexOptions.Compiled); public WebhookEvent WebhookEvent { get; } = webhookEvent; public WebhookDeliveryData Delivery { get; } = delivery; public WebhookBlob WebhookBlob { get; } = webhookBlob; public string WebhookId { get; } = webhookId; - - public virtual Task Interpolate(SendEmailRequest req, - UIStoresController.StoreEmailRule storeEmailRule) - { - return Task.FromResult(req)!; - } - - protected static string InterpolateJsonField(string str, string fieldName, JObject obj) - { - if (string.IsNullOrEmpty(str) || string.IsNullOrEmpty(fieldName) || obj == null) - return str; - - fieldName += "."; - - //find all instance of {fieldName*} in str, then run obj.SelectToken(*) on it - while (true) - { - var start = str.IndexOf($"{{{fieldName}", StringComparison.InvariantCultureIgnoreCase); - if (start == -1) - break; - - start += fieldName.Length + 1; // Move past the { - var end = str.IndexOf("}", start, StringComparison.InvariantCultureIgnoreCase); - if (end == -1) - break; - - var jsonpath = str.Substring(start, end - start); - var result = string.Empty; - - try - { - if (string.IsNullOrEmpty(jsonpath)) - result = obj.ToString(); - else if (_jsonPathRegex.IsMatch(jsonpath)) - // Only process if JSONPath is valid - result = obj.SelectToken(jsonpath)?.ToString() ?? string.Empty; - // If jsonpath doesn't match the pattern, result remains empty string - } - catch (JsonException) - { - // Handle JSON parsing errors (e.g., invalid JSONPath syntax) - result = string.Empty; - } - - str = str.Replace($"{{{fieldName}{jsonpath}}}", result); - } - - return str; - } } public class DeliveryResult diff --git a/BTCPayServer/Plugins/Webhooks/WebhookTriggerContext.cs b/BTCPayServer/Plugins/Webhooks/WebhookTriggerContext.cs new file mode 100644 index 000000000..aac1c7a20 --- /dev/null +++ b/BTCPayServer/Plugins/Webhooks/WebhookTriggerContext.cs @@ -0,0 +1,19 @@ +#nullable enable +using BTCPayServer.Client.Models; +using StoreData = BTCPayServer.Data.StoreData; + +namespace BTCPayServer.Plugins.Webhooks; + +public record WebhookTriggerContext(StoreData Store, object Event, StoreWebhookEvent Webhook) +{ + public object? AdditionalData { get; set; } +} + +public record WebhookTriggerContext : WebhookTriggerContext where T : class +{ + public WebhookTriggerContext(StoreData store, T evt, StoreWebhookEvent webhook) : base(store, evt, webhook) + { + } + + public new T Event => (T)base.Event; +} diff --git a/BTCPayServer/Plugins/Webhooks/WebhookTriggerProvider.cs b/BTCPayServer/Plugins/Webhooks/WebhookTriggerProvider.cs new file mode 100644 index 000000000..db132c128 --- /dev/null +++ b/BTCPayServer/Plugins/Webhooks/WebhookTriggerProvider.cs @@ -0,0 +1,54 @@ +#nullable enable +using System.Threading.Tasks; +using BTCPayServer.Client.Models; +using BTCPayServer.HostedServices; +using BTCPayServer.Plugins.Emails; +using Newtonsoft.Json; +using Newtonsoft.Json.Linq; +using StoreData = BTCPayServer.Data.StoreData; + +namespace BTCPayServer.Plugins.Webhooks; + +public abstract class WebhookTriggerProvider +{ + public abstract StoreWebhookEvent? GetWebhookEvent(object evt); + + public virtual Task GetEmailModel(WebhookTriggerContext webhookTriggerContext) + { + var webhookData = JObject.FromObject(webhookTriggerContext.Webhook, JsonSerializer.Create(WebhookSender.DefaultSerializerSettings)); + var model = new JObject(); + model["Webhook"] = webhookData; + model["Store"] = new JObject() + { + ["Id"] = webhookTriggerContext.Store.Id, + ["Name"] = webhookTriggerContext.Store.StoreName + }; + return Task.FromResult(model); + } + + public virtual Task BeforeSending(EmailRuleMatchContext context, WebhookTriggerContext webhookTriggerContext) + => Task.CompletedTask; + + public virtual WebhookTriggerContext CreateWebhookTriggerContext(StoreData store, object evt, StoreWebhookEvent webhookEvent) + => new (store, evt, webhookEvent); +} + +public abstract class WebhookTriggerProvider : WebhookTriggerProvider where T : class +{ + public sealed override StoreWebhookEvent? GetWebhookEvent(object evt) + => evt is T t ? GetWebhookEvent(t) : null; + protected abstract StoreWebhookEvent? GetWebhookEvent(T evt); + public sealed override Task GetEmailModel(WebhookTriggerContext webhookTriggerContext) + => GetEmailModel((WebhookTriggerContext)webhookTriggerContext); + protected virtual Task GetEmailModel(WebhookTriggerContext webhookTriggerContext) + => base.GetEmailModel(webhookTriggerContext); + + public sealed override Task BeforeSending(EmailRuleMatchContext context, WebhookTriggerContext webhookTriggerContext) + => BeforeSending(context,(WebhookTriggerContext)webhookTriggerContext); + + protected virtual Task BeforeSending(EmailRuleMatchContext context, WebhookTriggerContext webhookTriggerContext) + => Task.CompletedTask; + + public override WebhookTriggerContext CreateWebhookTriggerContext(StoreData store, object evt, StoreWebhookEvent webhookEvent) + => new WebhookTriggerContext(store, (T)evt, webhookEvent); +} diff --git a/BTCPayServer/Plugins/Webhooks/WebhooksPlugin.cs b/BTCPayServer/Plugins/Webhooks/WebhooksPlugin.cs new file mode 100644 index 000000000..88348925d --- /dev/null +++ b/BTCPayServer/Plugins/Webhooks/WebhooksPlugin.cs @@ -0,0 +1,321 @@ +#nullable enable +using System; +using System.Collections.Generic; +using System.Linq; +using System.Net.Http; +using BTCPayServer.Abstractions.Models; +using BTCPayServer.Client.Models; +using BTCPayServer.HostedServices; +using BTCPayServer.Plugins.Emails.Views; +using BTCPayServer.Plugins.Webhooks.HostedServices; +using BTCPayServer.Plugins.Webhooks.TriggerProviders; +using BTCPayServer.Services; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Hosting; + +namespace BTCPayServer.Plugins.Webhooks; + +public class WebhooksPlugin : BaseBTCPayServerPlugin +{ + public const string Area = "Webhooks"; + public override string Identifier => "BTCPayServer.Plugins.Webhooks"; + public override string Name => "Webhooks"; + public override string Description => "Allows you to send webhooks"; + + public override void Execute(IServiceCollection services) + { + services.AddHostedService(); + services.AddSingleton(); + services.AddSingleton(o => o.GetRequiredService()); + services.AddScheduledTask(TimeSpan.FromHours(6.0)); + services.AddHttpClient(WebhookSender.OnionNamedClient) + .ConfigurePrimaryHttpMessageHandler(); + services.AddHttpClient(WebhookSender.LoopbackNamedClient) + .ConfigurePrimaryHttpMessageHandler(_ => new HttpClientHandler + { + ServerCertificateCustomValidationCallback = + HttpClientHandler.DangerousAcceptAnyServerCertificateValidator + }); + var userAgent = new System.Net.Http.Headers.ProductInfoHeaderValue("BTCPayServer", BTCPayServerEnvironment.GetInformationalVersion()); + foreach (var clientName in WebhookSender.AllClients.Concat(new[] { BitpayIPNSender.NamedClient })) + { + services.AddHttpClient(clientName) + .ConfigureHttpClient(client => + { + client.DefaultRequestHeaders.UserAgent.Add(userAgent); + }); + } + + // Add built in webhooks + AddInvoiceWebhooks(services); + AddPayoutWebhooks(services); + AddPaymentRequestWebhooks(services); + AddPendingTransactionWebhooks(services); + } + + private static void AddPendingTransactionWebhooks(IServiceCollection services) + { + services.AddWebhookTriggerProvider(); + var pendingTransactionsPlaceholders = new List() + { + new("{PendingTransaction.Id}", "The id of the pending transaction"), + new("{PendingTransaction.TrimmedId}", "The trimmed id of the pending transaction"), + new("{PendingTransaction.StoreId}", "The store id of the pending transaction"), + new("{PendingTransaction.SignaturesCollected}", "The number of signatures collected"), + new("{PendingTransaction.SignaturesNeeded}", "The number of signatures needed"), + new("{PendingTransaction.SignaturesTotal}", "The total number of signatures"), + new("{PendingTransaction.Link}", "The link to the wallet transaction list") + }.AddStoresPlaceHolders(); + + var pendingTransactionTriggers = new List() + { + new() + { + Type = PendingTransactionTriggerProvider.PendingTransactionCreated, + Description = "Pending Transaction - Created", + SubjectExample = "Pending Transaction {PendingTransaction.TrimmedId} Created", + BodyExample = "Review the transaction {PendingTransaction.Id} and sign it on: {PendingTransaction.Link}", + PlaceHolders = pendingTransactionsPlaceholders + }, + new() + { + Type = PendingTransactionTriggerProvider.PendingTransactionSignatureCollected, + Description = "Pending Transaction - Signature Collected", + SubjectExample = "Signature Collected for Pending Transaction {PendingTransaction.TrimmedId}", + BodyExample = "So far {PendingTransaction.SignaturesCollected} signatures collected out of {PendingTransaction.SignaturesNeeded} signatures needed. ", + PlaceHolders = pendingTransactionsPlaceholders + }, + new() + { + Type = PendingTransactionTriggerProvider.PendingTransactionBroadcast, + Description = "Pending Transaction - Broadcast", + SubjectExample = "Transaction {PendingTransaction.TrimmedId} has been Broadcast", + BodyExample = "Transaction is visible in mempool on: https://mempool.space/tx/{PendingTransaction.Id}. ", + PlaceHolders = pendingTransactionsPlaceholders + }, + new() + { + Type = PendingTransactionTriggerProvider.PendingTransactionCancelled, + Description = "Pending Transaction - Cancelled", + SubjectExample = "Pending Transaction {PendingTransaction.TrimmedId} Cancelled", + BodyExample = "Transaction {PendingTransaction.Id} is cancelled and signatures are no longer being collected. ", + PlaceHolders = pendingTransactionsPlaceholders + } + }; + + services.AddSingleton(); + services.AddWebhookTriggerViewModels(pendingTransactionTriggers); + } + + private static void AddPaymentRequestWebhooks(IServiceCollection services) + { + services.AddWebhookTriggerProvider(); + var paymentRequestPlaceholders = new List() + { + new("{PaymentRequest.Id}", "The id of the payment request"), + new("{PaymentRequest.TrimmedId}", "The trimmed id of the payment request"), + new("{PaymentRequest.Amount}", "The amount of the payment request"), + new("{PaymentRequest.Currency}", "The currency of the payment request"), + new("{PaymentRequest.Title}", "The title of the payment request"), + new("{PaymentRequest.Description}", "The description of the payment request"), + new("{PaymentRequest.Link}", "The link to the payment request"), + new("{PaymentRequest.ReferenceId}", "The reference id of the payment request"), + new("{PaymentRequest.Status}", "The status of the payment request"), + new("{PaymentRequest.FormResponse}*", "The form response associated with the payment request") + }.AddStoresPlaceHolders(); + + var paymentRequestTriggers = new List() + { + new() + { + Type = WebhookEventType.PaymentRequestCreated, + Description = "Payment Request - Created", + SubjectExample = "Payment Request {PaymentRequest.Id} created", + BodyExample = "Payment Request {PaymentRequest.Id} ({PaymentRequest.Title}) created.", + PlaceHolders = paymentRequestPlaceholders, + CanIncludeCustomerEmail = true + }, + new() + { + Type = WebhookEventType.PaymentRequestUpdated, + Description = "Payment Request - Updated", + SubjectExample = "Payment Request {PaymentRequest.Id} updated", + BodyExample = "Payment Request {PaymentRequest.Id} ({PaymentRequest.Title}) updated.", + PlaceHolders = paymentRequestPlaceholders, + CanIncludeCustomerEmail = true + }, + new() + { + Type = WebhookEventType.PaymentRequestArchived, + Description = "Payment Request - Archived", + SubjectExample = "Payment Request {PaymentRequest.Id} archived", + BodyExample = "Payment Request {PaymentRequest.Id} ({PaymentRequest.Title}) archived.", + PlaceHolders = paymentRequestPlaceholders, + CanIncludeCustomerEmail = true + }, + new() + { + Type = WebhookEventType.PaymentRequestStatusChanged, + Description = "Payment Request - Status Changed", + SubjectExample = "Payment Request {PaymentRequest.Id} status changed", + BodyExample = "Payment Request {PaymentRequest.Id} ({PaymentRequest.Title}) status changed to {PaymentRequest.Status}.", + PlaceHolders = paymentRequestPlaceholders, + CanIncludeCustomerEmail = true + }, + new() + { + Type = WebhookEventType.PaymentRequestCompleted, + Description = "Payment Request - Completed", + SubjectExample = "Payment Request {PaymentRequest.Title} {PaymentRequest.ReferenceId} Completed", + BodyExample = "The total of {PaymentRequest.Amount} {PaymentRequest.Currency} has been received and Payment Request {PaymentRequest.Id} is completed.\nReview the payment request: {PaymentRequest.Link}", + PlaceHolders = paymentRequestPlaceholders, + CanIncludeCustomerEmail = true + } + }; + services.AddWebhookTriggerViewModels(paymentRequestTriggers); + } + + private static void AddPayoutWebhooks(IServiceCollection services) + { + services.AddWebhookTriggerProvider(); + var payoutPlaceholders = new List() + { + new("{Payout.Id}", "The id of the payout"), + new("{Payout.PullPaymentId}", "The id of the pull payment"), + new("{Payout.Destination}", "The destination of the payout"), + new("{Payout.State}", "The current state of the payout"), + new("{Payout.Metadata}*", "The metadata associated with the payout") + }.AddStoresPlaceHolders(); + var payoutTriggers = new List() + { + new() + { + Type = WebhookEventType.PayoutCreated, + Description = "Payout - Created", + SubjectExample = "Payout {Payout.Id} created", + BodyExample = "Payout {Payout.Id} (Pull Payment Id: {Payout.PullPaymentId}) created.", + PlaceHolders = payoutPlaceholders + }, + new() + { + Type = WebhookEventType.PayoutApproved, + Description = "Payout - Approved", + SubjectExample = "Payout {Payout.Id} approved", + BodyExample = "Payout {Payout.Id} (Pull Payment Id: {Payout.PullPaymentId}) approved.", + PlaceHolders = payoutPlaceholders + }, + new() + { + Type = WebhookEventType.PayoutUpdated, + Description = "Payout - Updated", + SubjectExample = "Payout {Payout.Id} updated", + BodyExample = "Payout {Payout.Id} (Pull Payment Id: {Payout.PullPaymentId}) updated.", + PlaceHolders = payoutPlaceholders + } + }; + + services.AddWebhookTriggerViewModels(payoutTriggers); + } + + private static void AddInvoiceWebhooks(IServiceCollection services) + { + services.AddWebhookTriggerProvider(); + var invoicePlaceholders = new List() + { + new("{Invoice.Id}", "The id of the invoice"), + new("{Invoice.StoreId}", "The id of the store"), + new("{Invoice.Price}", "The price of the invoice"), + new("{Invoice.Currency}", "The currency of the invoice"), + new("{Invoice.Status}", "The current status of the invoice"), + new("{Invoice.Link}", "The backend link to the invoice"), + new("{Invoice.AdditionalStatus}", "Additional status information of the invoice"), + new("{Invoice.OrderId}", "The order id associated with the invoice"), + new("{Invoice.Metadata}*", "The metadata associated with the invoice") + }.AddStoresPlaceHolders(); + var emailTriggers = new List() + { + new() + { + Type = WebhookEventType.InvoiceCreated, + Description = "Invoice - Created", + SubjectExample = "Invoice {Invoice.Id} created", + BodyExample = "Invoice {Invoice.Id} (Order Id: {Invoice.OrderId}) created.", + PlaceHolders = invoicePlaceholders, + CanIncludeCustomerEmail = true + }, + new() + { + Type = WebhookEventType.InvoiceReceivedPayment, + Description = "Invoice - Received Payment", + SubjectExample = "Invoice {Invoice.Id} received payment", + BodyExample = "Invoice {Invoice.Id} (Order Id: {Invoice.OrderId}) received payment.", + PlaceHolders = invoicePlaceholders, + CanIncludeCustomerEmail = true + }, + new() + { + Type = WebhookEventType.InvoiceProcessing, + Description = "Invoice - Is Processing", + SubjectExample = "Invoice {Invoice.Id} processing", + BodyExample = "Invoice {Invoice.Id} (Order Id: {Invoice.OrderId}) is processing.", + PlaceHolders = invoicePlaceholders, + CanIncludeCustomerEmail = true + }, + new() + { + Type = WebhookEventType.InvoiceExpired, + Description = "Invoice - Expired", + SubjectExample = "Invoice {Invoice.Id} expired", + BodyExample = "Invoice {Invoice.Id} (Order Id: {Invoice.OrderId}) expired.", + PlaceHolders = invoicePlaceholders, + CanIncludeCustomerEmail = true + }, + new() + { + Type = WebhookEventType.InvoiceSettled, + Description = "Invoice - Is Settled", + SubjectExample = "Invoice {Invoice.Id} settled", + BodyExample = "Invoice {Invoice.Id} (Order Id: {Invoice.OrderId}) is settled.", + PlaceHolders = invoicePlaceholders, + CanIncludeCustomerEmail = true + }, + new() + { + Type = WebhookEventType.InvoiceInvalid, + Description = "Invoice - Became Invalid", + SubjectExample = "Invoice {Invoice.Id} invalid", + BodyExample = "Invoice {Invoice.Id} (Order Id: {Invoice.OrderId}) invalid.", + PlaceHolders = invoicePlaceholders, + CanIncludeCustomerEmail = true + }, + new() + { + Type = WebhookEventType.InvoicePaymentSettled, + Description = "Invoice - Payment Settled", + SubjectExample = "Invoice {Invoice.Id} payment settled", + BodyExample = "Invoice {Invoice.Id} (Order Id: {Invoice.OrderId}) payment settled.", + PlaceHolders = invoicePlaceholders, + CanIncludeCustomerEmail = true + }, + new() + { + Type = WebhookEventType.InvoiceExpiredPaidPartial, + Description = "Invoice - Expired Paid Partial", + SubjectExample = "Invoice {Invoice.Id} expired with partial payment", + BodyExample = "Invoice {Invoice.Id} (Order Id: {Invoice.OrderId}) expired with partial payment. \nPlease review and take appropriate action: {Invoice.Link}", + PlaceHolders = invoicePlaceholders, + CanIncludeCustomerEmail = true + }, + new() + { + Type = WebhookEventType.InvoicePaidAfterExpiration, + Description = "Invoice - Expired Paid Late", + SubjectExample = "Invoice {Invoice.Id} paid after expiration", + BodyExample = "Invoice {Invoice.Id} (Order Id: {Invoice.OrderId}) paid after expiration.", + PlaceHolders = invoicePlaceholders, + CanIncludeCustomerEmail = true + } + }; + services.AddWebhookTriggerViewModels(emailTriggers); + } +} diff --git a/BTCPayServer/Plugins/Webhooks/WebhooksTranslationProvider.cs b/BTCPayServer/Plugins/Webhooks/WebhooksTranslationProvider.cs new file mode 100644 index 000000000..0c456b331 --- /dev/null +++ b/BTCPayServer/Plugins/Webhooks/WebhooksTranslationProvider.cs @@ -0,0 +1,15 @@ +#nullable enable + +using System.Collections.Generic; +using System.Linq; +using System.Threading.Tasks; +using BTCPayServer.Plugins.Webhooks.Views; +using BTCPayServer.Services; + +namespace BTCPayServer.Plugins.Webhooks; + +public class WebhooksTranslationProvider(IEnumerable viewModels) : IDefaultTranslationProvider +{ + public Task[]> GetDefaultTranslations() + => Task.FromResult(viewModels.Select(vm => KeyValuePair.Create(vm.Description, vm.Description)).ToArray())!; +} diff --git a/BTCPayServer/Services/Invoices/InvoiceEntity.cs b/BTCPayServer/Services/Invoices/InvoiceEntity.cs index 05888dbba..bbbd2a2c9 100644 --- a/BTCPayServer/Services/Invoices/InvoiceEntity.cs +++ b/BTCPayServer/Services/Invoices/InvoiceEntity.cs @@ -4,6 +4,7 @@ using System.ComponentModel.DataAnnotations.Schema; using System.Globalization; using System.Linq; using System.Text; +using BTCPayServer.Abstractions; using BTCPayServer.Abstractions.Extensions; using BTCPayServer.Client.Models; using BTCPayServer.Data; @@ -756,6 +757,8 @@ namespace BTCPayServer.Services.Invoices public decimal NetSettled { get; private set; } [JsonIgnore] public bool DisableAccounting { get; set; } + + public RequestBaseUrl GetRequestBaseUrl() => RequestBaseUrl.FromUrl(ServerUrl); } public enum InvoiceStatusLegacy diff --git a/BTCPayServer/Services/Mails/EmailSender.cs b/BTCPayServer/Services/Mails/EmailSender.cs index b46441748..4f71794ba 100644 --- a/BTCPayServer/Services/Mails/EmailSender.cs +++ b/BTCPayServer/Services/Mails/EmailSender.cs @@ -9,12 +9,14 @@ namespace BTCPayServer.Services.Mails { public abstract class EmailSender : IEmailSender { + public EventAggregator EventAggregator { get; } public Logs Logs { get; } readonly IBackgroundJobClient _JobClient; - public EmailSender(IBackgroundJobClient jobClient, Logs logs) + public EmailSender(IBackgroundJobClient jobClient, EventAggregator eventAggregator, Logs logs) { + EventAggregator = eventAggregator; Logs = logs; _JobClient = jobClient ?? throw new ArgumentNullException(nameof(jobClient)); } @@ -36,14 +38,13 @@ namespace BTCPayServer.Services.Mails } using var smtp = await emailSettings.CreateSmtpClient(); - var prefixedSubject = await GetPrefixedSubject(subject); - var mail = emailSettings.CreateMailMessage(email, cc, bcc, prefixedSubject, message, true); - await smtp.SendAsync(mail, cancellationToken); + var mail = emailSettings.CreateMailMessage(email, cc, bcc, subject, message, true); + var response = await smtp.SendAsync(mail, cancellationToken); await smtp.DisconnectAsync(true, cancellationToken); + EventAggregator.Publish(new Events.EmailSentEvent(response, mail)); }, TimeSpan.Zero); } public abstract Task GetEmailSettings(); - public abstract Task GetPrefixedSubject(string subject); } } diff --git a/BTCPayServer/Services/Mails/EmailSenderFactory.cs b/BTCPayServer/Services/Mails/EmailSenderFactory.cs index 50b987298..f12e1f22c 100644 --- a/BTCPayServer/Services/Mails/EmailSenderFactory.cs +++ b/BTCPayServer/Services/Mails/EmailSenderFactory.cs @@ -13,10 +13,12 @@ namespace BTCPayServer.Services.Mails private readonly IBackgroundJobClient _jobClient; private readonly SettingsRepository _settingsRepository; + private readonly EventAggregator _eventAggregator; private readonly StoreRepository _storeRepository; public EmailSenderFactory(IBackgroundJobClient jobClient, SettingsRepository settingsSettingsRepository, + EventAggregator eventAggregator, ISettingsAccessor policiesSettings, StoreRepository storeRepository, Logs logs) @@ -24,18 +26,19 @@ namespace BTCPayServer.Services.Mails Logs = logs; _jobClient = jobClient; _settingsRepository = settingsSettingsRepository; + _eventAggregator = eventAggregator; PoliciesSettings = policiesSettings; _storeRepository = storeRepository; } public Task GetEmailSender(string? storeId = null) { - var serverSender = new ServerEmailSender(_settingsRepository, _jobClient, Logs); + var serverSender = new ServerEmailSender(_settingsRepository, _jobClient, _eventAggregator, Logs); if (string.IsNullOrEmpty(storeId)) return Task.FromResult(serverSender); return Task.FromResult(new StoreEmailSender(_storeRepository, !PoliciesSettings.Settings.DisableStoresToUseServerEmailSettings ? serverSender : null, _jobClient, - storeId, Logs)); + _eventAggregator, storeId, Logs)); } public async Task IsComplete(string? storeId = null) diff --git a/BTCPayServer/Services/Mails/ServerEmailSender.cs b/BTCPayServer/Services/Mails/ServerEmailSender.cs index bc9c986ca..e0afb25b1 100644 --- a/BTCPayServer/Services/Mails/ServerEmailSender.cs +++ b/BTCPayServer/Services/Mails/ServerEmailSender.cs @@ -8,7 +8,8 @@ namespace BTCPayServer.Services.Mails { public ServerEmailSender(SettingsRepository settingsRepository, IBackgroundJobClient backgroundJobClient, - Logs logs) : base(backgroundJobClient, logs) + EventAggregator eventAggregator, + Logs logs) : base(backgroundJobClient, eventAggregator, logs) { ArgumentNullException.ThrowIfNull(settingsRepository); SettingsRepository = settingsRepository; @@ -20,12 +21,5 @@ namespace BTCPayServer.Services.Mails { return SettingsRepository.GetSettingAsync(); } - - public override async Task GetPrefixedSubject(string subject) - { - var settings = await SettingsRepository.GetSettingAsync(); - var prefix = string.IsNullOrEmpty(settings?.ServerName) ? "BTCPay Server" : settings.ServerName; - return $"{prefix}: {subject}"; - } } } diff --git a/BTCPayServer/Services/Mails/StoreEmailSender.cs b/BTCPayServer/Services/Mails/StoreEmailSender.cs index e590f7f2e..3d168fea3 100644 --- a/BTCPayServer/Services/Mails/StoreEmailSender.cs +++ b/BTCPayServer/Services/Mails/StoreEmailSender.cs @@ -12,8 +12,9 @@ namespace BTCPayServer.Services.Mails public StoreEmailSender(StoreRepository storeRepository, EmailSender? fallback, IBackgroundJobClient backgroundJobClient, + EventAggregator eventAggregator, string storeId, - Logs logs) : base(backgroundJobClient, logs) + Logs logs) : base(backgroundJobClient, eventAggregator, logs) { StoreId = storeId ?? throw new ArgumentNullException(nameof(storeId)); StoreRepository = storeRepository; @@ -44,7 +45,7 @@ namespace BTCPayServer.Services.Mails return GetCustomSettings(store); } EmailSettings? GetCustomSettings(StoreData store) - { + { var emailSettings = store.GetStoreBlob().EmailSettings; if (emailSettings?.IsComplete() is true) { @@ -52,11 +53,5 @@ namespace BTCPayServer.Services.Mails } return null; } - - public override async Task GetPrefixedSubject(string subject) - { - var store = await StoreRepository.FindStore(StoreId); - return string.IsNullOrEmpty(store?.StoreName) ? subject : $"{store.StoreName}: {subject}"; - } } } diff --git a/BTCPayServer/Services/PaymentRequests/PaymentRequestRepository.cs b/BTCPayServer/Services/PaymentRequests/PaymentRequestRepository.cs index 652235c79..d31d70ef4 100644 --- a/BTCPayServer/Services/PaymentRequests/PaymentRequestRepository.cs +++ b/BTCPayServer/Services/PaymentRequests/PaymentRequestRepository.cs @@ -2,6 +2,7 @@ using System; using System.Linq; using System.Threading; using System.Threading.Tasks; +using BTCPayServer.Abstractions; using BTCPayServer.Client.Models; using BTCPayServer.Data; using BTCPayServer.Services.Invoices; @@ -21,14 +22,14 @@ namespace BTCPayServer.Services.PaymentRequests public PaymentRequestData Data { get; set; } public string Type { get; set; } } - + public class PaymentRequestRepository { private readonly ApplicationDbContextFactory _ContextFactory; private readonly InvoiceRepository _InvoiceRepository; private readonly EventAggregator _eventAggregator; - public PaymentRequestRepository(ApplicationDbContextFactory contextFactory, + public PaymentRequestRepository(ApplicationDbContextFactory contextFactory, InvoiceRepository invoiceRepository, EventAggregator eventAggregator) { _ContextFactory = contextFactory; @@ -68,7 +69,7 @@ namespace BTCPayServer.Services.PaymentRequests return null; if(pr.Archived && !toggle) return pr.Archived; - pr.Archived = !pr.Archived; + pr.Archived = !pr.Archived; await context.SaveChangesAsync(); if (pr.Archived) { @@ -78,7 +79,7 @@ namespace BTCPayServer.Services.PaymentRequests Type = PaymentRequestEvent.Archived }); } - + return pr.Archived; } @@ -105,9 +106,9 @@ namespace BTCPayServer.Services.PaymentRequests if (paymentRequestData == null || paymentRequestData.Status == status) return; paymentRequestData.Status = status; - + await context.SaveChangesAsync(cancellationToken); - + _eventAggregator.Publish(new PaymentRequestEvent() { Data = paymentRequestData, @@ -127,9 +128,9 @@ namespace BTCPayServer.Services.PaymentRequests { using var context = _ContextFactory.CreateContext(); var queryable = context.PaymentRequests.Include(data => data.StoreData).AsQueryable(); - queryable = + queryable = queryable - .Where(data => + .Where(data => (data.Status == Client.Models.PaymentRequestStatus.Pending || data.Status == Client.Models.PaymentRequestStatus.Processing) && data.Expiry != null); return await queryable.ToArrayAsync(cancellationToken); diff --git a/BTCPayServer/Views/Shared/NotificationEmailWarning.cshtml b/BTCPayServer/Views/Shared/NotificationEmailWarning.cshtml index 69c5ebace..d83f1dfc5 100644 --- a/BTCPayServer/Views/Shared/NotificationEmailWarning.cshtml +++ b/BTCPayServer/Views/Shared/NotificationEmailWarning.cshtml @@ -1,7 +1,8 @@ +@using BTCPayServer.Plugins.Emails
    The Email settings have not been configured on this server or store yet. Setting this field will not send emails until then. - Configure store email settings + Configure store email settings
    diff --git a/BTCPayServer/Views/UIPaymentRequest/EditPaymentRequest.cshtml b/BTCPayServer/Views/UIPaymentRequest/EditPaymentRequest.cshtml index 591236f24..0ba212c72 100644 --- a/BTCPayServer/Views/UIPaymentRequest/EditPaymentRequest.cshtml +++ b/BTCPayServer/Views/UIPaymentRequest/EditPaymentRequest.cshtml @@ -3,9 +3,11 @@ @using BTCPayServer.Client @using BTCPayServer.Controllers @using BTCPayServer.Forms +@using BTCPayServer.Plugins.Emails @using BTCPayServer.TagHelpers @using Microsoft.AspNetCore.Mvc.TagHelpers @inject FormDataService FormDataService +@inject LinkGenerator LinkGenerator @model BTCPayServer.Models.PaymentRequestViewModels.UpdatePaymentRequestViewModel @{ var checkoutFormOptions = await FormDataService.GetSelect(Model.StoreId, Model.FormId); @@ -45,7 +47,7 @@ }
    - +
    @@ -105,8 +107,8 @@ "]" class="form-control" />
    - @ViewLocalizer["This will send notification mails to the recipient, as configured by the {0}.", - Html.ActionLink(StringLocalizer["email rules"], nameof(UIStoresController.StoreEmailRulesList), "UIStores", new { storeId = Model.StoreId })] + @ViewLocalizer["This will send notification mails to the recipient, as configured by the email rules.", + LinkGenerator.GetStoreEmailRulesLink(Model.StoreId, Context.Request.GetRequestBaseUrl())] @if (Model.HasEmailRules is not true) { - + @if (Model.FormResponse is not null) {
    diff --git a/BTCPayServer/Views/UIServer/Emails.cshtml b/BTCPayServer/Views/UIServer/Emails.cshtml index abfaf9ac5..48b6377b2 100644 --- a/BTCPayServer/Views/UIServer/Emails.cshtml +++ b/BTCPayServer/Views/UIServer/Emails.cshtml @@ -6,7 +6,10 @@

    @ViewData["Title"]

    - +
    + + +
    diff --git a/BTCPayServer/Views/UIStores/StoreEmailRulesManage.cshtml b/BTCPayServer/Views/UIStores/StoreEmailRulesManage.cshtml deleted file mode 100644 index 38da5879a..000000000 --- a/BTCPayServer/Views/UIStores/StoreEmailRulesManage.cshtml +++ /dev/null @@ -1,257 +0,0 @@ -@using BTCPayServer.Abstractions.TagHelpers -@using BTCPayServer.Client.Models -@using BTCPayServer.HostedServices.Webhooks -@using BTCPayServer.Services -@using BTCPayServer.TagHelpers -@using Microsoft.AspNetCore.Mvc.TagHelpers -@model BTCPayServer.Controllers.UIStoresController.StoreEmailRule -@inject WebhookSender WebhookSender -@inject CallbackGenerator CallbackGenerator - -@{ - var storeId = Context.GetStoreData().Id; - bool isEdit = Model.Trigger != null; - ViewData.SetActivePage(StoreNavPages.Emails, StringLocalizer[isEdit ? "Edit Email Rule" : "Create Email Rule"], storeId); -} - -@section PageHeadContent { - -} - - -
    - -
    - - Cancel -
    -
    - - -
    - - - -
    Choose what event sends the email.
    -
    - -
    - - - -
    Who to send the email to. For multiple emails, separate with a comma.
    -
    - -
    - - - -
    - -
    - - - -
    - -
    - - - -
    - - - - - - - - - - - - - - - - - - - -
    Placeholders
    Invoice - {Invoice.Id}, - {Invoice.StoreId}, - {Invoice.Price}, - {Invoice.Currency}, - {Invoice.Status}, - {Invoice.AdditionalStatus}, - {Invoice.OrderId} - {Invoice.Metadata}* -
    Request - {PaymentRequest.Id}, - {PaymentRequest.TrimmedId}, - {PaymentRequest.Amount}, - {PaymentRequest.Currency}, - {PaymentRequest.Title}, - {PaymentRequest.Description}, - {PaymentRequest.ReferenceId}, - {PaymentRequest.Status} - {PaymentRequest.FormResponse}* -
    Payout - {Payout.Id}, - {Payout.PullPaymentId}, - {Payout.Destination}, - {Payout.State} - {Payout.Metadata}* -
    Pending Transaction - {PendingTransaction.Id}, - {PendingTransaction.TrimmedId}, - {PendingTransaction.StoreId}, - {PendingTransaction.SignaturesCollected}, - {PendingTransaction.SignaturesNeeded}, - {PendingTransaction.SignaturesTotal} -
    * These fields are JSON objects. You can access properties within them using this syntax. One example is {Invoice.Metadata.itemCode}
    -
    -
    - - - -@section PageFootContent { - - - - -} diff --git a/BTCPayServer/Views/UIStores/StoreEmailSettings.cshtml b/BTCPayServer/Views/UIStores/StoreEmailSettings.cshtml deleted file mode 100644 index e228c8503..000000000 --- a/BTCPayServer/Views/UIStores/StoreEmailSettings.cshtml +++ /dev/null @@ -1,49 +0,0 @@ -@using BTCPayServer.Client -@using Microsoft.AspNetCore.Mvc.TagHelpers -@model BTCPayServer.Models.EmailsViewModel -@{ - var storeId = Context.GetStoreData().Id; - ViewData.SetActivePage(StoreNavPages.Emails, StringLocalizer["Email Rules"], storeId); -} - -
    -
    -

    Email Server

    - -
    - - @if (Model.IsFallbackSetup) - { - - -
    - -
    - } - else - { - - - } - - - - -
    -

    Email Rules

    -

    Email rules allow BTCPay Server to send customized emails from your store based on events.

    - - Configure - -
    - -@section PageFootContent { - -} diff --git a/BTCPayServer/Views/UIStores/TestWebhook.cshtml b/BTCPayServer/Views/UIStores/TestWebhook.cshtml deleted file mode 100644 index 5e1ab4ce9..000000000 --- a/BTCPayServer/Views/UIStores/TestWebhook.cshtml +++ /dev/null @@ -1,26 +0,0 @@ -@using BTCPayServer.HostedServices.Webhooks -@model EditWebhookViewModel -@inject WebhookSender WebhookSender -@{ - ViewData.SetActivePage(StoreNavPages.Webhooks, StringLocalizer["Send a test event to a webhook endpoint"], Context.GetStoreData().Id); -} -
    -
    -

    @ViewData["Title"]

    - -
    - -
    -
    -
    - - -
    -
    -
    -