#792 added ISettingProvider service

framework/src/Volo.Abp.AspNetCore.Mvc.UI/Volo/Abp/AspNetCore/Mvc/UI/RazorPages/AbpPageModel.cs

@@ -60,7 +60,7 @@ namespace Volo.Abp.AspNetCore.Mvc.UI.RazorPages
 
         public ICurrentTenant CurrentTenant { get; set; }
 
-        public ISettingManager SettingManager { get; set; }
+        public ISettingProvider SettingProvider { get; set; }
 
         public IModelStateValidator ModelValidator { get; set; }
 

framework/src/Volo.Abp.AspNetCore/Microsoft/AspNetCore/Builder/AbpApplicationBuilderExtensions.cs

@@ -48,10 +48,10 @@ namespace Microsoft.AspNetCore.Builder
             using (var scope = app.ApplicationServices.CreateScope())
             {
                 var languageProvider = scope.ServiceProvider.GetRequiredService<ILanguageProvider>();
-                var settingManager = scope.ServiceProvider.GetRequiredService<ISettingManager>();
+                languages = languageProvider.GetLanguages();
 
-                languages = AsyncHelper.RunSync(() => languageProvider.GetLanguagesAsync());
-                defaultLanguage = settingManager.GetOrNull(LocalizationSettingNames.DefaultLanguage);
+                var settingProvider = scope.ServiceProvider.GetRequiredService<ISettingProvider>();
+                defaultLanguage = settingProvider.GetOrNull(LocalizationSettingNames.DefaultLanguage);
             }
 
             if (!languages.Any())

framework/src/Volo.Abp.Authorization/Volo/Abp/Authorization/Permissions/PermissionDefinition.cs

@@ -18,6 +18,10 @@ namespace Volo.Abp.Authorization.Permissions
         /// </summary>
         public PermissionDefinition Parent { get; private set; }
 
+        /// <summary>
+        /// A list of allowed providers to get value of this permission.
+        /// An empty list indicates that all providers are allowed.
+        /// </summary>
         public List<string> Providers { get; }
 
         public ILocalizableString DisplayName

framework/src/Volo.Abp.Ddd.Application/Volo/Abp/Application/Services/ApplicationService.cs

@@ -45,7 +45,7 @@ namespace Volo.Abp.Application.Services
 
         public ICurrentUser CurrentUser { get; set; }
 
-        public ISettingManager SettingManager { get; set; }
+        public ISettingProvider SettingProvider { get; set; }
 
         public IClock Clock { get; set; }
 

framework/src/Volo.Abp.Emailing/Volo/Abp/Emailing/EmailSenderConfiguration.cs

@@ -11,16 +11,16 @@ namespace Volo.Abp.Emailing
     {
         public virtual string DefaultFromAddress => GetNotEmptySettingValue(EmailSettingNames.DefaultFromAddress);
 
-        public virtual string DefaultFromDisplayName => SettingManager.GetOrNull(EmailSettingNames.DefaultFromDisplayName);
+        public virtual string DefaultFromDisplayName => SettingProvider.GetOrNull(EmailSettingNames.DefaultFromDisplayName);
 
-        protected readonly ISettingManager SettingManager;
+        protected readonly ISettingProvider SettingProvider;
 
         /// <summary>
         /// Creates a new <see cref="EmailSenderConfiguration"/>.
         /// </summary>
-        protected EmailSenderConfiguration(ISettingManager settingManager)
+        protected EmailSenderConfiguration(ISettingProvider settingProvider)
         {
-            SettingManager = settingManager;
+            SettingProvider = settingProvider;
         }
 
         /// <summary>
@@ -30,7 +30,7 @@ namespace Volo.Abp.Emailing
         /// <returns>Value of the setting</returns>
         protected string GetNotEmptySettingValue(string name)
         {
-            var value = SettingManager.GetOrNull(name);
+            var value = SettingProvider.GetOrNull(name);
 
             if (value.IsNullOrEmpty())
             {

framework/src/Volo.Abp.Emailing/Volo/Abp/Emailing/Smtp/SmtpEmailSenderConfiguration.cs

@@ -18,14 +18,14 @@ namespace Volo.Abp.Emailing.Smtp
 
         public virtual string Password => GetNotEmptySettingValue(EmailSettingNames.Smtp.Password);
 
-        public virtual string Domain => SettingManager.GetOrNull(EmailSettingNames.Smtp.Domain);
+        public virtual string Domain => SettingProvider.GetOrNull(EmailSettingNames.Smtp.Domain);
 
-        public virtual bool EnableSsl => SettingManager.GetOrNull(EmailSettingNames.Smtp.EnableSsl).To<bool>();
+        public virtual bool EnableSsl => SettingProvider.GetOrNull(EmailSettingNames.Smtp.EnableSsl).To<bool>();
 
-        public virtual bool UseDefaultCredentials => SettingManager.GetOrNull(EmailSettingNames.Smtp.UseDefaultCredentials).To<bool>();
+        public virtual bool UseDefaultCredentials => SettingProvider.GetOrNull(EmailSettingNames.Smtp.UseDefaultCredentials).To<bool>();
 
-        public SmtpEmailSenderConfiguration(ISettingManager settingManager)
-            : base(settingManager)
+        public SmtpEmailSenderConfiguration(ISettingProvider settingProvider)
+            : base(settingProvider)
         {
 
         }

framework/src/Volo.Abp.Localization/Volo/Abp/Localization/LanguageProviderExtensions.cs

@@ -7,7 +7,7 @@ namespace Volo.Abp.Localization
     {
         public static IReadOnlyList<LanguageInfo> GetLanguages(this ILanguageProvider languageProvider)
         {
-            return AsyncHelper.RunSync(() => languageProvider.GetLanguagesAsync());
+            return AsyncHelper.RunSync(languageProvider.GetLanguagesAsync);
         }
     }
 }

framework/src/Volo.Abp.Settings/Volo/Abp/Settings/ISettingProvider.cs

@@ -0,0 +1,13 @@
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using JetBrains.Annotations;
+
+namespace Volo.Abp.Settings
+{
+    public interface ISettingProvider
+    {
+        Task<string> GetOrNullAsync([NotNull]string name);
+
+        Task<List<SettingValue>> GetAllAsync();
+    }
+}

framework/src/Volo.Abp.Settings/Volo/Abp/Settings/SettingDefinition.cs

@@ -36,6 +36,12 @@ namespace Volo.Abp.Settings
         /// </summary>
         public bool IsVisibleToClients { get; set; }
 
+        /// <summary>
+        /// A list of allowed providers to get value of this permission.
+        /// An empty list indicates that all providers are allowed.
+        /// </summary>
+        public List<string> Providers { get; }
+
         /// <summary>
         /// Is this setting inherited from parent scopes.
         /// Default: True.
@@ -72,6 +78,31 @@ namespace Volo.Abp.Settings
             IsEncrypted = isEncrypted;
 
             Properties = new Dictionary<string, object>();
+            Providers = new List<string>();
+        }
+
+        /// <summary>
+        /// Sets a property in the <see cref="Properties"/> dictionary.
+        /// This is a shortcut for nested calls on this object.
+        /// </summary>
+        public virtual SettingDefinition WithProperty(string key, object value)
+        {
+            Properties[key] = value;
+            return this;
+        }
+
+        /// <summary>
+        /// Sets a property in the <see cref="Properties"/> dictionary.
+        /// This is a shortcut for nested calls on this object.
+        /// </summary>
+        public virtual SettingDefinition WithProviders(params string[] providers)
+        {
+            if (!providers.IsNullOrEmpty())
+            {
+                Providers.AddRange(providers);
+            }
+
+            return this;
         }
     }
 }

framework/src/Volo.Abp.Settings/Volo/Abp/Settings/SettingProvider.cs

@@ -0,0 +1,102 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Options;
+using Volo.Abp.DependencyInjection;
+
+namespace Volo.Abp.Settings
+{
+    public class SettingProvider : ISettingProvider, ITransientDependency
+    {
+        protected ISettingDefinitionManager SettingDefinitionManager { get; }
+        protected Lazy<List<ISettingValueProvider>> Providers { get; }
+        protected ISettingEncryptionService SettingEncryptionService { get; }
+        protected SettingOptions Options { get; }
+
+        public SettingProvider(
+            IOptions<SettingOptions> options,
+            IServiceProvider serviceProvider,
+            ISettingDefinitionManager settingDefinitionManager, 
+            ISettingEncryptionService settingEncryptionService)
+        {
+            SettingDefinitionManager = settingDefinitionManager;
+            SettingEncryptionService = settingEncryptionService;
+
+            Options = options.Value;
+
+            Providers = new Lazy<List<ISettingValueProvider>>(
+                () => Options
+                    .ValueProviders
+                    .Select(c => serviceProvider.GetRequiredService(c) as ISettingValueProvider)
+                    .ToList(),
+                true
+            );
+        }
+
+        public virtual async Task<string> GetOrNullAsync(string name)
+        {
+            var setting = SettingDefinitionManager.Get(name);
+            var providers = Enumerable
+                .Reverse(Providers.Value);
+
+            if (setting.Providers.Any())
+            {
+                providers = providers.Where(p => setting.Providers.Contains(p.Name));
+            }
+
+            //TODO: How to implement setting.IsInherited?
+
+            var value = await GetOrNullValueFromProvidersAsync(null, providers, setting);
+            if (setting.IsEncrypted)
+            {
+                value = SettingEncryptionService.Decrypt(setting, value);
+            }
+
+            return value;
+        }
+
+        public virtual async Task<List<SettingValue>> GetAllAsync()
+        {
+            var settingValues = new Dictionary<string, SettingValue>();
+            var settingDefinitions = SettingDefinitionManager.GetAll();
+
+            foreach (var provider in Providers.Value)
+            {
+                foreach (var setting in settingDefinitions)
+                {
+                    var value = await provider.GetOrNullAsync(setting, null);
+                    if (value != null)
+                    {
+                        if (setting.IsEncrypted)
+                        {
+                            value = SettingEncryptionService.Decrypt(setting, value);
+                        }
+
+                        settingValues[setting.Name] = new SettingValue(setting.Name, value);
+                    }
+                }
+            }
+
+            return settingValues.Values.ToList();
+        }
+
+        protected virtual async Task<string> GetOrNullValueFromProvidersAsync(
+            string providerKey,
+            IEnumerable<ISettingValueProvider> providers,
+            SettingDefinition setting)
+        {
+            foreach (var provider in providers)
+            {
+                var value = await provider.GetOrNullAsync(setting, providerKey);
+                if (value != null)
+                {
+                    return value;
+                }
+            }
+
+            return null;
+        }
+    }
+}

framework/src/Volo.Abp.Settings/Volo/Abp/Settings/SettingProviderExtensions.cs

@@ -0,0 +1,56 @@
+using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using JetBrains.Annotations;
+using Volo.Abp.Threading;
+
+namespace Volo.Abp.Settings
+{
+    public static class SettingProviderExtensions
+    {
+        public static async Task<bool> IsTrueAsync([NotNull] this ISettingProvider settingProvider, [NotNull] string name)
+        {
+            Check.NotNull(settingProvider, nameof(settingProvider));
+            Check.NotNull(name, nameof(name));
+
+            return string.Equals(
+                await settingProvider.GetOrNullAsync(name),
+                "true",
+                StringComparison.OrdinalIgnoreCase
+            );
+        }
+
+        public static async Task<T> GetAsync<T>([NotNull] this ISettingProvider settingProvider, [NotNull] string name, T defaultValue = default)
+            where T : struct
+        {
+            Check.NotNull(settingProvider, nameof(settingProvider));
+            Check.NotNull(name, nameof(name));
+
+            var value = await settingProvider.GetOrNullAsync(name);
+            return value?.To<T>() ?? defaultValue;
+        }
+
+        public static string GetOrNull([NotNull] this ISettingProvider settingProvider, [NotNull] string name)
+        {
+            Check.NotNull(settingProvider, nameof(settingProvider));
+            return AsyncHelper.RunSync(() => settingProvider.GetOrNullAsync(name));
+        }
+
+        public static List<SettingValue> GetAll([NotNull] this ISettingProvider settingProvider)
+        {
+            Check.NotNull(settingProvider, nameof(settingProvider));
+            return AsyncHelper.RunSync(settingProvider.GetAllAsync);
+        }
+
+        public static T Get<T>([NotNull] this ISettingProvider settingProvider, [NotNull] string name, T defaultValue = default)
+            where T : struct
+        {
+            return AsyncHelper.RunSync(() => settingProvider.GetAsync(name, defaultValue));
+        }
+
+        public static bool IsTrue([NotNull] this ISettingProvider settingProvider, [NotNull] string name)
+        {
+            return AsyncHelper.RunSync(() => settingProvider.IsTrueAsync(name));
+        }
+    }
+}

framework/src/Volo.Abp.Settings/Volo/Abp/Settings/SettingValue.cs

@@ -1,5 +1,8 @@
-namespace Volo.Abp.Settings
+using System;
+
+namespace Volo.Abp.Settings
 {
+    [Serializable]
     public class SettingValue : NameValue
     {
         /// <summary>

framework/test/Volo.Abp.Settings.Tests/Volo/Abp/Settings/SettingProvider_Tests.cs

@@ -0,0 +1,30 @@
+using System.Threading.Tasks;
+using Shouldly;
+using Xunit;
+
+namespace Volo.Abp.Settings
+{
+    public class SettingProvider_Tests : AbpIntegratedTest<AbpSettingsTestModule>
+    {
+        private readonly ISettingProvider _settingProvider;
+
+        public SettingProvider_Tests()
+        {
+            _settingProvider = GetRequiredService<ISettingProvider>();
+        }
+
+        [Fact]
+        public async Task Should_Get_Null_If_No_Value_Provided_And_No_Default_Value()
+        {
+            (await _settingProvider.GetOrNullAsync(TestSettingNames.TestSettingWithoutDefaultValue))
+                .ShouldBeNull();
+        }
+
+        [Fact]
+        public async Task Should_Get_Default_Value_If_No_Value_Provided_And_There_Is_A_Default_Value()
+        {
+            (await _settingProvider.GetOrNullAsync(TestSettingNames.TestSettingWithDefaultValue))
+                .ShouldBe("default-value");
+        }
+    }
+}