Adding endpoint to set server email settings (#6601)

* Adding endpoint in Greenfield to allow server email settings * Adding related swagger file * Refactoring EmailSettingsData to be more readable * Adding server email masking * Adding tests * Update BTCPayServer/wwwroot/swagger/v1/swagger.template.serveremail.json Co-authored-by: d11n <mail@dennisreimann.de> * Masking smtp server email returned over greenfield api and test * Retaining password if password mask is used * Remove magic string ***** * Flatten request for server's settings. Fix bug on shared setting instances * Remove useless doc * Simplify code * Fix Store Email settings page --------- Co-authored-by: d11n <mail@dennisreimann.de> Co-authored-by: nicolas.dorier <nicolas.dorier@gmail.com>
2025-12-17 22:14:26 +01:00 · 2025-02-27 01:59:17 -05:00
parent 8b5c5895f0
commit a7e3cbb105
16 changed files with 412 additions and 117 deletions
--- a/BTCPayServer/Controllers/GreenField/GreenfieldServerEmailController.cs
+++ b/BTCPayServer/Controllers/GreenField/GreenfieldServerEmailController.cs
@@ -0,0 +1,89 @@
+#nullable enable
+using System.Threading.Tasks;
+using BTCPayServer.Abstractions.Constants;
+using BTCPayServer.Abstractions.Extensions;
+using BTCPayServer.Client;
+using BTCPayServer.Client.Models;
+using BTCPayServer.Models.ServerViewModels;
+using BTCPayServer.Services;
+using BTCPayServer.Services.Mails;
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Cors;
+using Microsoft.AspNetCore.Mvc;
+
+namespace BTCPayServer.Controllers.GreenField
+{
+    [ApiController]
+    [Authorize(AuthenticationSchemes = AuthenticationSchemes.Greenfield)]
+    [EnableCors(CorsPolicies.All)]
+    public class GreenfieldServerEmailController : Controller
+    {
+        private readonly EmailSenderFactory _emailSenderFactory;
+        private readonly PoliciesSettings _policiesSettings;
+        readonly SettingsRepository _settingsRepository;
+
+        public GreenfieldServerEmailController(EmailSenderFactory emailSenderFactory, PoliciesSettings policiesSettings, SettingsRepository settingsRepository)
+        {
+            _emailSenderFactory = emailSenderFactory;
+            _policiesSettings = policiesSettings;
+            _settingsRepository = settingsRepository;
+        }
+
+        [Authorize(Policy = Policies.CanModifyServerSettings, AuthenticationSchemes = AuthenticationSchemes.Greenfield)]
+        [HttpGet("~/api/v1/server/email")]
+        public async Task<IActionResult> ServerEmailSettings()
+        {
+            var email = await _emailSenderFactory.GetSettings() ?? new EmailSettings();
+            var model = new ServerEmailSettingsData
+            {
+                EnableStoresToUseServerEmailSettings = !_policiesSettings.DisableStoresToUseServerEmailSettings,
+                From = email.From,
+                Server = email.Server,
+                Port = email.Port,
+                Login = email.Login,
+                DisableCertificateCheck = email.DisableCertificateCheck,
+                // Password is not returned
+                Password = null
+            };
+            return Ok(model);
+        }
+
+        [Authorize(Policy = Policies.CanModifyServerSettings, AuthenticationSchemes = AuthenticationSchemes.Greenfield)]
+        [HttpPut("~/api/v1/server/email")]
+        public async Task<IActionResult> ServerEmailSettings(ServerEmailSettingsData request)
+        {
+            if (_policiesSettings.DisableStoresToUseServerEmailSettings == request.EnableStoresToUseServerEmailSettings)
+            {
+                _policiesSettings.DisableStoresToUseServerEmailSettings = !request.EnableStoresToUseServerEmailSettings;
+                await _settingsRepository.UpdateSetting(_policiesSettings);
+            }
+            
+            // save
+            if (request.From is not null && !MailboxAddressValidator.IsMailboxAddress(request.From))
+            {
+                 request.AddModelError(e => e.From,
+                     "Invalid email address", this);
+                 return this.CreateValidationError(ModelState);
+            }
+            
+            var oldSettings = await _emailSenderFactory.GetSettings() ?? new EmailSettings();
+            // retaining the password if it exists and was not provided in request
+            if (string.IsNullOrEmpty(request.Password) &&
+                !string.IsNullOrEmpty(oldSettings?.Password))
+                request.Password = oldSettings.Password;
+            
+            // important to save as EmailSettings otherwise it won't be able to be fetched
+            await _settingsRepository.UpdateSetting(new EmailSettings
+            {
+                Server = request.Server,
+                Port = request.Port,
+                Login = request.Login,
+                Password = request.Password,
+                From = request.From,
+                DisableCertificateCheck = request.DisableCertificateCheck
+            });
+            
+            return Ok(true);
+        }
+    }
+}