Form Builder

BTCPayServer.Abstractions/Form/Field.cs

@@ -1,35 +1,34 @@
+using System;
+using System.Collections;
 using System.Collections.Generic;
+using System.Linq;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
 
 namespace BTCPayServer.Abstractions.Form;
 
-public abstract class Field
+public class Field
 {
-    // HTML5 compatible type string like "text", "textarea", "email", "password", etc. Each type is a class and may contain more fields (i.e. "select" would have options).
-    public string Type;
-
     // The name of the HTML5 node. Should be used as the key for the posted data.
     public string Name;
-    
-    // The translated label of the field.
-    public string Label;
-    
+
+    // HTML5 compatible type string like "text", "textarea", "email", "password", etc. Each type is a class and may contain more fields (i.e. "select" would have options).
+    public string Type;
+
     // The value field is what is currently in the DB or what the user entered, but possibly not saved yet due to validation errors.
     // If this is the first the user sees the form, then value and original value are the same. Value changes as the user starts interacting with the form.
     public string Value;
 
-    // The original value is the value that is currently saved in the backend. A "reset" button can be used to revert back to this. Should only be set from the constructor.
-    public string OriginalValue;
-
-    // A useful note shown below the field or via a tooltip / info icon. Should be translated for the user.
-    public string HelpText;
-
     // The field is considered "valid" if there are no validation errors
     public List<string> ValidationErrors = new List<string>();
 
-    public bool Required = false;
-
-    public bool IsValid()
+    public virtual bool IsValid()
     {
-        return ValidationErrors.Count == 0;
+        return ValidationErrors.Count == 0 && Fields.All(field => field.IsValid());
     }
+
+    [JsonExtensionData] public IDictionary<string, JToken> AdditionalData { get; set; }
+    public List<Field> Fields { get; set; } = new();
+
+
 }

BTCPayServer.Abstractions/Form/Fieldset.cs

@@ -1,14 +1,12 @@
-using System.Collections.Generic;
-
 namespace BTCPayServer.Abstractions.Form;
 
-public class Fieldset
+public class Fieldset : Field
 {
+    public bool Hidden { get; set; }
+    public string Label { get; set; }
+
     public Fieldset()
     {
-        this.Fields = new List<Field>();
+        Type = "fieldset";
     }
-
-    public string Label { get; set; }
-    public List<Field> Fields { get; set; }
 }

BTCPayServer.Abstractions/Form/Form.cs

@@ -1,60 +1,148 @@
+using System;
 using System.Collections.Generic;
+using System.Linq;
+using Microsoft.AspNetCore.Http;
+using Newtonsoft.Json.Linq;
 
 namespace BTCPayServer.Abstractions.Form;
 
 public class Form
 {
-
     // Messages to be shown at the top of the form indicating user feedback like "Saved successfully" or "Please change X because of Y." or a warning, etc...
     public List<AlertMessage> TopMessages { get; set; } = new();
 
     // Groups of fields in the form
-    public List<Fieldset> Fieldsets { get; set; } = new();
+    public List<Field> Fields { get; set; } = new();
 
-
     // Are all the fields valid in the form?
     public bool IsValid()
     {
-        foreach (var fieldset in Fieldsets)
-        {
-            foreach (var field in fieldset.Fields)
-            {
-                if (!field.IsValid())
-                {
-                    return false;
-                }
-            }
-        }
-
-        return true;
+        return Fields.All(field => field.IsValid());
     }
 
     public Field GetFieldByName(string name)
     {
-        foreach (var fieldset in Fieldsets)
+        return GetFieldByName(name, Fields, null);
+    }
+
+    private static Field GetFieldByName(string name, List<Field> fields, string prefix)
+    {
+        prefix ??= string.Empty;
+        foreach (var field in fields)
         {
-            foreach (var field in fieldset.Fields)
+            var currentPrefix = prefix;
+            if (!string.IsNullOrEmpty(field.Name))
             {
-                if (name.Equals(field.Name))
+
+                currentPrefix = $"{prefix}{field.Name}";
+                if (currentPrefix.Equals(name, StringComparison.InvariantCultureIgnoreCase))
                 {
                     return field;
                 }
+
+                currentPrefix += "_";
             }
+
+            var subFieldResult = GetFieldByName(name, field.Fields, currentPrefix);
+            if (subFieldResult is not null)
+            {
+                return subFieldResult;
+            }
+
         }
         return null;
     }
-
     public List<string> GetAllNames()
+    {
+        return GetAllNames(Fields);
+    }
+
+    private static List<string> GetAllNames(List<Field> fields)
     {
         var names = new List<string>();
-        foreach (var fieldset in Fieldsets)
+
+        foreach (var field in fields)
         {
-            foreach (var field in fieldset.Fields)
+            string prefix = string.Empty;
+            if (!string.IsNullOrEmpty(field.Name))
             {
                 names.Add(field.Name);
+                prefix = $"{field.Name}_";
+            }
+
+            if (field.Fields.Any())
+            {
+                names.AddRange(GetAllNames(field.Fields).Select(s => $"{prefix}{s}" ));
             }
         }
 
         return names;
     }
+
+    public void ApplyValuesFromOtherForm(Form form)
+    {
+        foreach (var fieldset in Fields)
+        {
+            foreach (var field in fieldset.Fields)
+            {
+                field.Value = form
+                    .GetFieldByName(
+                        $"{(string.IsNullOrEmpty(fieldset.Name) ? string.Empty : fieldset.Name + "_")}{field.Name}")
+                    ?.Value;
+            }
+        }
+    }
+
+    public void ApplyValuesFromForm(IFormCollection form, string ignorePrefix = null)
+    {
+        var names = GetAllNames();
+        foreach (var name in names)
+        {
+            if (ignorePrefix is not null && name.StartsWith(ignorePrefix))
+            {
+                continue;
+            }
+
+            var field = GetFieldByName(name);
+            if (field is null || !form.TryGetValue(name, out var val))
+            {
+                continue;
+            }
+
+            field.Value = val;
+        }
+    }
+
+    public Dictionary<string, object> GetValues()
+    {
+        return GetValues(Fields);
+    }
+
+    private static Dictionary<string, object> GetValues(List<Field> fields)
+    {
+        var result = new Dictionary<string, object>();
+        foreach (Field field in fields)
+        {
+            var name = field.Name ?? string.Empty;
+            if (field.Fields.Any())
+            {
+                var values = GetValues(fields);
+                values.Remove(string.Empty, out var keylessValue);
+
+                result.TryAdd(name, values);
+
+                if (keylessValue is not Dictionary<string, object> dict) continue;
+                foreach (KeyValuePair<string,object> keyValuePair in dict)
+                {
+                    result.TryAdd(keyValuePair.Key, keyValuePair.Value);
+                }
+            }
+            else
+            {
+                result.TryAdd(name, field.Value);
+            }
+        }
+
+        return result;
+    }
 }

BTCPayServer.Abstractions/Form/HtmlInputField.cs

@@ -0,0 +1,27 @@
+namespace BTCPayServer.Abstractions.Form;
+
+public class HtmlInputField : Field
+{
+    // The translated label of the field.
+    public string Label;
+
+    // The original value is the value that is currently saved in the backend. A "reset" button can be used to revert back to this. Should only be set from the constructor.
+    public string OriginalValue;
+
+    // A useful note shown below the field or via a tooltip / info icon. Should be translated for the user.
+    public string HelpText;
+
+    public bool Required;
+    public HtmlInputField(string label, string name, string value, bool required, string helpText, string type = "text")
+    {
+        Label = label;
+        Name = name;
+        Value = value;
+        OriginalValue = value;
+        Required = required;
+        HelpText = helpText;
+        Type = type;
+    }
+
+    // TODO JSON parsing from string to objects again probably won't work out of the box because of the different field types.
+}

BTCPayServer.Client/Models/CreateAppRequest.cs

@@ -37,7 +37,7 @@ public class CreatePointOfSaleAppRequest : CreateAppRequest
         public string RedirectUrl { get; set; } = null;
         public bool? RedirectAutomatically { get; set; } = null;
         public bool? RequiresRefundEmail { get; set; } = null;
-        public string CheckoutFormId { get; set; } = null;
+        public string FormId { get; set; } = null;
         public string EmbeddedCSS { get; set; } = null;
         public CheckoutType? CheckoutType { get; set; } = null;
     }

BTCPayServer.Client/Models/InvoiceData.cs

@@ -85,8 +85,6 @@ public class CheckoutOptions
             public bool? RedirectAutomatically { get; set; }
             public bool? RequiresRefundEmail { get; set; } = null;
             public string DefaultLanguage { get; set; }
-            [JsonProperty("checkoutFormId")]
-            public string CheckoutFormId { get; set; }
             public CheckoutType? CheckoutType { get; set; }
         }
     }

BTCPayServer.Client/Models/PaymentRequestBaseData.cs

@@ -24,5 +24,9 @@ public class PaymentRequestBaseData
 
         [JsonExtensionData]
         public IDictionary<string, JToken> AdditionalData { get; set; }
+
+        public string FormId { get; set; }
+
+        public string FormResponse { get; set; }
     }
 }

BTCPayServer.Client/Models/PaymentRequestData.cs

@@ -12,7 +12,6 @@ public class PaymentRequestData : PaymentRequestBaseData
         public DateTimeOffset CreatedTime { get; set; }
         public string Id { get; set; }
         public bool Archived { get; set; }
-
         public enum PaymentRequestStatus
         {
             Pending = 0,

BTCPayServer.Client/Models/StoreBaseData.cs

@@ -31,8 +31,6 @@ public abstract class StoreBaseData
         public bool AnyoneCanCreateInvoice { get; set; }
         public string DefaultCurrency { get; set; }
         public bool RequiresRefundEmail { get; set; }
-
-        public string CheckoutFormId { get; set; }
         [JsonConverter(typeof(StringEnumConverter))]
         public CheckoutType CheckoutType { get; set; }
         public bool LightningAmountInSatoshi { get; set; }

BTCPayServer.Data/ApplicationDbContext.cs

@@ -69,6 +69,7 @@ public ApplicationDbContext(DbContextOptions<ApplicationDbContext> options, bool
         public DbSet<WebhookData> Webhooks { get; set; }
         public DbSet<LightningAddressData> LightningAddresses{ get; set; }
         public DbSet<PayoutProcessorData> PayoutProcessors { get; set; }
+        public DbSet<FormData> Forms { get; set; }
 
         protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
         {
@@ -122,6 +123,7 @@ protected override void OnModelCreating(ModelBuilder builder)
             LightningAddressData.OnModelCreating(builder);
             PayoutProcessorData.OnModelCreating(builder);
             //WebhookData.OnModelCreating(builder);
+            FormData.OnModelCreating(builder, Database);
 
 
             if (Database.IsSqlite() && !_designTime)

BTCPayServer.Data/Data/FormData.cs

@@ -0,0 +1,30 @@
+using System.ComponentModel.DataAnnotations.Schema;
+using Microsoft.EntityFrameworkCore;
+using Microsoft.EntityFrameworkCore.Infrastructure;
+
+namespace BTCPayServer.Data.Data;
+
+public class FormData
+{
+    [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
+    public string Id { get; set; }
+    public string Name { get; set; }
+    public string StoreId { get; set; }
+    public StoreData Store { get; set; }
+    public string Config { get; set; }
+
+    internal static void OnModelCreating(ModelBuilder builder, DatabaseFacade databaseFacade)
+    {
+        builder.Entity<FormData>()
+            .HasOne(o => o.Store)
+            .WithMany(o => o.Forms).OnDelete(DeleteBehavior.Cascade);
+        builder.Entity<FormData>().HasIndex(o => o.StoreId);
+
+        if (databaseFacade.IsNpgsql())
+        {
+            builder.Entity<FormData>()
+                .Property(o => o.Config)
+                .HasColumnType("JSONB");
+        }
+    }
+}

BTCPayServer.Data/Data/StoreData.cs

@@ -48,5 +48,6 @@ public class StoreData
         public IEnumerable<PayoutData> Payouts { get; set; }
         public IEnumerable<CustodianAccountData> CustodianAccounts { get; set; }
         public IEnumerable<StoreSettingData> Settings { get; set; }
+        public IEnumerable<FormData> Forms { get; set; }
     }
 }