Merge pull request #9701 from abpframework/liangshiwei/emailing

Provide a feature to allow tenants to change email settings

modules/setting-management/src/Volo.Abp.SettingManagement.Application.Contracts/Volo/Abp/SettingManagement/AllowTenantsToChangeEmailSettingsFeatureSimpleStateChecker.cs

@@ -0,0 +1,25 @@
+using System.Threading.Tasks;
+using Microsoft.Extensions.DependencyInjection;
+using Volo.Abp.Authorization.Permissions;
+using Volo.Abp.Features;
+using Volo.Abp.MultiTenancy;
+using Volo.Abp.SimpleStateChecking;
+
+namespace Volo.Abp.SettingManagement
+{
+    public class AllowTenantsToChangeEmailSettingsFeatureSimpleStateChecker : ISimpleStateChecker<PermissionDefinition>
+    {
+        public async Task<bool> IsEnabledAsync(SimpleStateCheckerContext<PermissionDefinition> context)
+        {
+            var currentTenant = context.ServiceProvider.GetRequiredService<ICurrentTenant>();
+
+            if (!currentTenant.IsAvailable)
+            {
+                return true;
+            }
+
+            var featureChecker = context.ServiceProvider.GetRequiredService<IFeatureChecker>();
+            return await featureChecker.IsEnabledAsync(SettingManagementFeatures.AllowTenantsToChangeEmailSettings);
+        }
+    }
+}

modules/setting-management/src/Volo.Abp.SettingManagement.Application.Contracts/Volo/Abp/SettingManagement/SettingManagementPermissionDefinitionProvider.cs

@@ -1,6 +1,5 @@
 using Volo.Abp.Authorization.Permissions;
 using Volo.Abp.Localization;
-using Volo.Abp.MultiTenancy;
 using Volo.Abp.SettingManagement.Localization;
 
 namespace Volo.Abp.SettingManagement
@@ -10,7 +9,10 @@ namespace Volo.Abp.SettingManagement
         public override void Define(IPermissionDefinitionContext context)
         {
             var moduleGroup = context.AddGroup(SettingManagementPermissions.GroupName, L("Permission:SettingManagement"));
-            moduleGroup.AddPermission(SettingManagementPermissions.Emailing, L("Permission:Emailing"), multiTenancySide: MultiTenancySides.Host);
+
+            moduleGroup
+                .AddPermission(SettingManagementPermissions.Emailing, L("Permission:Emailing"))
+                .StateCheckers.Add(new AllowTenantsToChangeEmailSettingsFeatureSimpleStateChecker());
         }
 
         private static LocalizableString L(string name)

modules/setting-management/src/Volo.Abp.SettingManagement.Application/Volo/Abp/SettingManagement/EmailSettingsAppService.cs

@@ -2,6 +2,8 @@
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Authorization;
 using Volo.Abp.Emailing;
+using Volo.Abp.MultiTenancy;
+using Volo.Abp.Features;
 
 namespace Volo.Abp.SettingManagement
 {
@@ -17,30 +19,52 @@ namespace Volo.Abp.SettingManagement
 
         public virtual async Task<EmailSettingsDto> GetAsync()
         {
-            return new EmailSettingsDto {
-                SmtpHost = await SettingManager.GetOrNullGlobalAsync(EmailSettingNames.Smtp.Host),
-                SmtpPort = Convert.ToInt32(await SettingManager.GetOrNullGlobalAsync(EmailSettingNames.Smtp.Port)),
-                SmtpUserName = await SettingManager.GetOrNullGlobalAsync(EmailSettingNames.Smtp.UserName),
-                SmtpPassword = await SettingManager.GetOrNullGlobalAsync(EmailSettingNames.Smtp.Password),
-                SmtpDomain = await SettingManager.GetOrNullGlobalAsync(EmailSettingNames.Smtp.Domain),
-                SmtpEnableSsl = Convert.ToBoolean(await SettingManager.GetOrNullGlobalAsync(EmailSettingNames.Smtp.EnableSsl)),
-                SmtpUseDefaultCredentials = Convert.ToBoolean(await SettingManager.GetOrNullGlobalAsync(EmailSettingNames.Smtp.UseDefaultCredentials)),
-                DefaultFromAddress = await SettingManager.GetOrNullGlobalAsync(EmailSettingNames.DefaultFromAddress),
-                DefaultFromDisplayName = await SettingManager.GetOrNullGlobalAsync(EmailSettingNames.DefaultFromDisplayName),
+            await CheckFeatureAsync();
+
+            var settingsDto = new EmailSettingsDto {
+                SmtpHost = await SettingProvider.GetOrNullAsync(EmailSettingNames.Smtp.Host),
+                SmtpPort = Convert.ToInt32(await SettingProvider.GetOrNullAsync(EmailSettingNames.Smtp.Port)),
+                SmtpUserName = await SettingProvider.GetOrNullAsync(EmailSettingNames.Smtp.UserName),
+                SmtpPassword = await SettingProvider.GetOrNullAsync(EmailSettingNames.Smtp.Password),
+                SmtpDomain = await SettingProvider.GetOrNullAsync(EmailSettingNames.Smtp.Domain),
+                SmtpEnableSsl = Convert.ToBoolean(await SettingProvider.GetOrNullAsync(EmailSettingNames.Smtp.EnableSsl)),
+                SmtpUseDefaultCredentials = Convert.ToBoolean(await SettingProvider.GetOrNullAsync(EmailSettingNames.Smtp.UseDefaultCredentials)),
+                DefaultFromAddress = await SettingProvider.GetOrNullAsync(EmailSettingNames.DefaultFromAddress),
+                DefaultFromDisplayName = await SettingProvider.GetOrNullAsync(EmailSettingNames.DefaultFromDisplayName),
             };
+
+            if (CurrentTenant.IsAvailable)
+            {
+                settingsDto.SmtpHost = await SettingManager.GetOrNullForTenantAsync(EmailSettingNames.Smtp.Host, CurrentTenant.GetId(), false);
+                settingsDto.SmtpUserName = await SettingManager.GetOrNullForTenantAsync(EmailSettingNames.Smtp.UserName, CurrentTenant.GetId(), false);
+                settingsDto.SmtpPassword = await SettingManager.GetOrNullForTenantAsync(EmailSettingNames.Smtp.Password, CurrentTenant.GetId(), false);
+                settingsDto.SmtpDomain = await SettingManager.GetOrNullForTenantAsync(EmailSettingNames.Smtp.Domain, CurrentTenant.GetId(), false);
+            }
+
+            return settingsDto;
         }
 
         public virtual async Task UpdateAsync(UpdateEmailSettingsDto input)
         {
-            await SettingManager.SetGlobalAsync(EmailSettingNames.Smtp.Host, input.SmtpHost);
-            await SettingManager.SetGlobalAsync(EmailSettingNames.Smtp.Port, input.SmtpPort.ToString());
-            await SettingManager.SetGlobalAsync(EmailSettingNames.Smtp.UserName, input.SmtpUserName);
-            await SettingManager.SetGlobalAsync(EmailSettingNames.Smtp.Password, input.SmtpPassword);
-            await SettingManager.SetGlobalAsync(EmailSettingNames.Smtp.Domain, input.SmtpDomain);
-            await SettingManager.SetGlobalAsync(EmailSettingNames.Smtp.EnableSsl, input.SmtpEnableSsl.ToString());
-            await SettingManager.SetGlobalAsync(EmailSettingNames.Smtp.UseDefaultCredentials, input.SmtpUseDefaultCredentials.ToString().ToLowerInvariant());
-            await SettingManager.SetGlobalAsync(EmailSettingNames.DefaultFromAddress, input.DefaultFromAddress);
-            await SettingManager.SetGlobalAsync(EmailSettingNames.DefaultFromDisplayName, input.DefaultFromDisplayName);
+            await CheckFeatureAsync();
+
+            await SettingManager.SetForTenantOrGlobalAsync(CurrentTenant.Id, EmailSettingNames.Smtp.Host, input.SmtpHost);
+            await SettingManager.SetForTenantOrGlobalAsync(CurrentTenant.Id, EmailSettingNames.Smtp.Port, input.SmtpPort.ToString());
+            await SettingManager.SetForTenantOrGlobalAsync(CurrentTenant.Id, EmailSettingNames.Smtp.UserName, input.SmtpUserName);
+            await SettingManager.SetForTenantOrGlobalAsync(CurrentTenant.Id, EmailSettingNames.Smtp.Password, input.SmtpPassword);
+            await SettingManager.SetForTenantOrGlobalAsync(CurrentTenant.Id, EmailSettingNames.Smtp.Domain, input.SmtpDomain);
+            await SettingManager.SetForTenantOrGlobalAsync(CurrentTenant.Id, EmailSettingNames.Smtp.EnableSsl, input.SmtpEnableSsl.ToString());
+            await SettingManager.SetForTenantOrGlobalAsync(CurrentTenant.Id, EmailSettingNames.Smtp.UseDefaultCredentials, input.SmtpUseDefaultCredentials.ToString().ToLowerInvariant());
+            await SettingManager.SetForTenantOrGlobalAsync(CurrentTenant.Id, EmailSettingNames.DefaultFromAddress, input.DefaultFromAddress);
+            await SettingManager.SetForTenantOrGlobalAsync(CurrentTenant.Id, EmailSettingNames.DefaultFromDisplayName, input.DefaultFromDisplayName);
+        }
+
+        private async Task CheckFeatureAsync()
+        {
+            if (CurrentTenant.IsAvailable)
+            {
+                await FeatureChecker.CheckEnabledAsync(SettingManagementFeatures.AllowTenantsToChangeEmailSettings);
+            }
         }
     }
 }

modules/setting-management/src/Volo.Abp.SettingManagement.Blazor/Settings/EmailingPageContributor.cs

@@ -2,6 +2,8 @@
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Localization;
+using Volo.Abp.Features;
+using Volo.Abp.MultiTenancy;
 using Volo.Abp.SettingManagement.Blazor.Pages.SettingManagement.EmailSettingGroup;
 using Volo.Abp.SettingManagement.Localization;
 
@@ -33,9 +35,29 @@ namespace Volo.Abp.SettingManagement.Blazor.Settings
 
         private async Task<bool> CheckPermissionsInternalAsync(SettingComponentCreationContext context)
         {
+            if (!await CheckFeatureAsync(context))
+            {
+                return false;
+            }
+
             var authorizationService = context.ServiceProvider.GetRequiredService<IAuthorizationService>();
 
             return await authorizationService.IsGrantedAsync(SettingManagementPermissions.Emailing);
         }
+
+        private async Task<bool> CheckFeatureAsync(SettingComponentCreationContext context)
+        {
+            var currentTenant = context.ServiceProvider.GetRequiredService<ICurrentTenant>();
+
+            if (!currentTenant.IsAvailable)
+            {
+                return true;
+            }
+
+            var featureCheck = context.ServiceProvider.GetRequiredService<IFeatureChecker>();
+
+            return await featureCheck.IsEnabledAsync(SettingManagementFeatures.AllowTenantsToChangeEmailSettings);
+
+        }
     }
 }

modules/setting-management/src/Volo.Abp.SettingManagement.Domain.Shared/Volo/Abp/SettingManagement/Localization/Resources/AbpSettingManagement/en.json

@@ -17,6 +17,8 @@
     "DefaultFromDisplayName": "Default from display name",
     "Feature:SettingManagementGroup": "Setting Management",
     "Feature:SettingManagementEnable": "Enable setting management",
-    "Feature:SettingManagementEnableDescription": "Enable setting management system in the application."
+    "Feature:SettingManagementEnableDescription": "Enable setting management system in the application.",
+    "Feature:AllowTenantsToChangeEmailSettings": "Allow tenants to change email settings.",
+    "Feature:AllowTenantsToChangeEmailSettingsDescription": "Allow tenants to change email settings."
   }
 }

modules/setting-management/src/Volo.Abp.SettingManagement.Domain.Shared/Volo/Abp/SettingManagement/Localization/Resources/AbpSettingManagement/zh-Hans.json

@@ -17,6 +17,8 @@
     "DefaultFromDisplayName": "默认显示名称",
     "Feature:SettingManagementGroup": "设置管理",
     "Feature:SettingManagementEnable": "启用设置管理",
-    "Feature:SettingManagementEnableDescription": "在应用程序中启用设置管理系统."
+    "Feature:SettingManagementEnableDescription": "在应用程序中启用设置管理系统.",
+    "Feature:AllowTenantsToChangeEmailSettings": "允许租户更改邮件设置.",
+    "Feature:AllowTenantsToChangeEmailSettingsDescription": "允许租户更改邮件设置."
   }
 }

modules/setting-management/src/Volo.Abp.SettingManagement.Domain.Shared/Volo/Abp/SettingManagement/SettingManagementFeatureDefinitionProvider.cs

@@ -5,18 +5,27 @@ using Volo.Abp.Validation.StringValues;
 
 namespace Volo.Abp.SettingManagement
 {
-    public class SettingManagementFeatureDefinitionProvider: FeatureDefinitionProvider
+    public class SettingManagementFeatureDefinitionProvider : FeatureDefinitionProvider
     {
         public override void Define(IFeatureDefinitionContext context)
         {
             var group = context.AddGroup(SettingManagementFeatures.GroupName,
                 L("Feature:SettingManagementGroup"));
 
-            group.AddFeature(SettingManagementFeatures.Enable,
+            var settingEnableFeature = group.AddFeature(
+                SettingManagementFeatures.Enable,
                 "true",
                 L("Feature:SettingManagementEnable"),
                 L("Feature:SettingManagementEnableDescription"),
                 new ToggleStringValueType());
+
+            settingEnableFeature.CreateChild(
+                SettingManagementFeatures.AllowTenantsToChangeEmailSettings,
+                "false",
+                L("Feature:AllowTenantsToChangeEmailSettings"),
+                L("AllowTenantsToChangeEmailSettingsDescription"),
+                new ToggleStringValueType(),
+                isAvailableToHost: false);
         }
 
         private static LocalizableString L(string name)

modules/setting-management/src/Volo.Abp.SettingManagement.Domain.Shared/Volo/Abp/SettingManagement/SettingManagementFeatures.cs

@@ -5,5 +5,7 @@
         public const string GroupName = "SettingManagement";
 
         public const string Enable = GroupName + ".Enable";
+
+        public const string AllowTenantsToChangeEmailSettings = GroupName + ".AllowTenantsToChangeEmailSettings";
     }
 }

modules/setting-management/src/Volo.Abp.SettingManagement.Domain/Volo/Abp/SettingManagement/TenantSettingManagerExtensions.cs

@@ -37,5 +37,15 @@ namespace Volo.Abp.SettingManagement
         {
             return settingManager.SetAsync(name, value, TenantSettingValueProvider.ProviderName, null, forceToSet);
         }
+
+        public static Task SetForTenantOrGlobalAsync(this ISettingManager settingManager, Guid? tenantId, [NotNull] string name, [CanBeNull] string value, bool forceToSet = false)
+        {
+            if (tenantId.HasValue)
+            {
+                return settingManager.SetForTenantAsync(tenantId.Value, name, value, forceToSet);
+            }
+
+            return settingManager.SetGlobalAsync(name, value);
+        }
     }
 }

modules/setting-management/src/Volo.Abp.SettingManagement.Web/Settings/EmailingPageContributor.cs

@@ -2,6 +2,8 @@
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Localization;
+using Volo.Abp.Features;
+using Volo.Abp.MultiTenancy;
 using Volo.Abp.SettingManagement.Localization;
 using Volo.Abp.SettingManagement.Web.Pages.SettingManagement;
 using Volo.Abp.SettingManagement.Web.Pages.SettingManagement.Components.EmailSettingGroup;
@@ -34,9 +36,29 @@ namespace Volo.Abp.SettingManagement.Web.Settings
 
         private async Task<bool> CheckPermissionsInternalAsync(SettingPageCreationContext context)
         {
+            if (!await CheckFeatureAsync(context))
+            {
+                return false;
+            }
+
             var authorizationService = context.ServiceProvider.GetRequiredService<IAuthorizationService>();
 
             return await authorizationService.IsGrantedAsync(SettingManagementPermissions.Emailing);
         }
+
+        private async Task<bool> CheckFeatureAsync(SettingPageCreationContext context)
+        {
+            var currentTenant = context.ServiceProvider.GetRequiredService<ICurrentTenant>();
+
+            if (!currentTenant.IsAvailable)
+            {
+                return true;
+            }
+
+            var featureCheck = context.ServiceProvider.GetRequiredService<IFeatureChecker>();
+
+            return await featureCheck.IsEnabledAsync(SettingManagementFeatures.AllowTenantsToChangeEmailSettings);
+
+        }
     }
 }