Support Form Select option (#4726)

* Support Form Select option

* Add country select

BTCPayServer/Forms/FormDataExtensions.cs

@@ -14,6 +14,7 @@ public static class FormDataExtensions
         serviceCollection.AddSingleton<FormComponentProviders>();
         serviceCollection.AddSingleton<IFormComponentProvider, HtmlInputFormProvider>();
         serviceCollection.AddSingleton<IFormComponentProvider, HtmlFieldsetFormProvider>();
+        serviceCollection.AddSingleton<IFormComponentProvider, HtmlSelectFormProvider>();
     }
     
     public static JObject Deserialize(this FormData form) 

BTCPayServer/Forms/FormDataService.cs

@@ -44,7 +44,15 @@ public class FormDataService
             Field.Create("City", "buyerCity", null, true, null),
             Field.Create("Postcode", "buyerZip", null, false, null),
             Field.Create("State", "buyerState", null, false, null),
-            Field.Create("Country", "buyerCountry", null, true, null)
+            new SelectField()
+            {
+                Name = "buyerCountry", 
+                Label = "Country",
+                Required = true,
+                Type = "select",
+                Options = "Afghanistan, Albania, Algeria, Andorra, Angola, Antigua and Barbuda, Argentina, Armenia, Australia, Austria, Azerbaijan, The Bahamas, Bahrain, Bangladesh, Barbados, Belarus, Belgium, Belize, Benin, Bhutan, Bolivia, Bosnia and Herzegovina, Botswana, Brazil, Brunei, Bulgaria, Burkina Faso, Burundi, Cabo Verde, Cambodia, Cameroon, Canada, Central African Republic (CAR), Chad, Chile, China, Colombia, Comoros, Democratic Republic of the Congo, Republic of the Congo, Costa Rica, Cote d'Ivoire, Croatia, Cuba, Cyprus, Czech Republic, Denmark, Djibouti, Dominica, Dominican Republic, Ecuador, Egypt, El Salvador, Equatorial Guinea, Eritrea, Estonia, Eswatini (formerly Swaziland), Ethiopia, Fiji, Finland, France, Gabon, The Gambia, Georgia, Germany, Ghana, Greece, Grenada, Guatemala, Guinea, Guinea-Bissau, Guyana, Haiti, Honduras, Hungary, Iceland, India, Indonesia, Iran, Iraq, Ireland, Israel, Italy, Jamaica, Japan, Jordan, Kazakhstan, Kenya, Kiribati, Kosovo, Kuwait, Kyrgyzstan, Laos, Latvia, Lebanon, Lesotho, Liberia, Libya, Liechtenstein, Lithuania, Luxembourg, Madagascar, Malawi, Malaysia, Maldives, Mali, Malta, Marshall Islands, Mauritania, Mauritius, Mexico, Micronesia, Moldova, Monaco, Mongolia, Montenegro, Morocco, Mozambique, Myanmar (formerly Burma), Namibia, Nauru, Nepal, Netherlands, New Zealand, Nicaragua, Niger, Nigeria, North Korea, North Macedonia (formerly Macedonia), Norway, Oman, Pakistan, Palau, Palestine, Panama, Papua New Guinea, Paraguay, Peru, Philippines, Poland, Portugal, Qatar, Romania, Russia, Rwanda, Saint Kitts and Nevis, Saint Lucia, Saint Vincent and the Grenadines, Samoa, San Marino, Sao Tome and Principe, Saudi Arabia, Senegal, Serbia, Seychelles, Sierra Leone, Singapore, Slovakia, Slovenia, Solomon Islands, Somalia, South Africa, South Korea, South Sudan, Spain, Sri Lanka, Sudan, Suriname, Sweden, Switzerland, Syria, Taiwan, Tajikistan, Tanzania, Thailand, Timor-Leste (formerly East Timor), Togo, Tonga, Trinidad and Tobago, Tunisia, Turkey, Turkmenistan, Tuvalu, Uganda, Ukraine, United Arab Emirates (UAE), United Kingdom (UK), United States of America (USA), Uruguay, Uzbekistan, Vanuatu, Vatican City (Holy See), Venezuela, Vietnam, Yemen, Zambia, Zimbabwe.".Split(',').Select(s => new SelectListItem(s,s)).ToList()
+                
+            }
         }
     };
     

BTCPayServer/Forms/HtmlSelectFormProvider.cs

@@ -0,0 +1,32 @@
+using System.Collections.Generic;
+using System.ComponentModel.DataAnnotations;
+using System.Linq;
+using BTCPayServer.Abstractions.Form;
+using BTCPayServer.Validation;
+using Microsoft.AspNetCore.Mvc.Rendering;
+
+namespace BTCPayServer.Forms;
+
+public class HtmlSelectFormProvider : FormComponentProviderBase
+{
+    public override void Register(Dictionary<string, IFormComponentProvider> typeToComponentProvider)
+    {
+        foreach (var t in new[] {
+            "select"})
+            typeToComponentProvider.Add(t, this);
+    }
+    public override string View => "Forms/SelectElement";
+
+    public override void Validate(Form form, Field field)
+    {
+        if (field.Required)
+        {
+            ValidateField<RequiredAttribute>(field);
+        }
+    }
+}
+
+public class SelectField: Field
+{
+    public List<SelectListItem> Options { get; set; }
+}

BTCPayServer/Views/Shared/Forms/SelectElement.cshtml

@@ -0,0 +1,28 @@
+@using BTCPayServer.Forms
+@using Newtonsoft.Json.Linq
+@model BTCPayServer.Abstractions.Form.Field
+
+@{
+    var selectField = (SelectField) (Model is not SelectField ? JObject.FromObject(Model).ToObject<SelectField>() : Model);
+    selectField.Options ??= new List<SelectListItem>();
+    selectField.Options.ForEach(item => { item.Selected = item.Value == Model.Value; });
+
+    var isInvalid = ViewContext.ModelState[Model.Name]?.ValidationState is Microsoft.AspNetCore.Mvc.ModelBinding.ModelValidationState.Invalid;
+    var errors = isInvalid ? ViewContext.ModelState[Model.Name].Errors : null;
+}
+<div class="form-group">
+    <label class="form-label" for="@Model.Name"@(Model.Required ? " data-required" : "")>
+        @Model.Label
+    </label>
+
+    <select id="@selectField.Name" asp-items="selectField.Options" class="form-select @(errors is null ? "" : "is-invalid")"
+            name="@selectField.Name" data-val="true" aria-describedby="HelpText-@selectField.Name" required="@selectField.Required"
+            data-val-required="@selectField.Label is required.">
+    </select>
+
+    <span class="text-danger" data-valmsg-for="@selectField.Name" data-valmsg-replace="true">@(isInvalid && errors.Any() ? errors.First().ErrorMessage : string.Empty)</span>
+    @if (!string.IsNullOrEmpty(selectField.HelpText))
+    {
+        <div id="@($"HelpText-{selectField.Name}")" class="form-text">@selectField.HelpText</div>
+    }
+</div>