Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ConfigurationManager #55338

Merged
merged 6 commits into from
Jul 13, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,21 @@ public partial class ChainedConfigurationSource : Microsoft.Extensions.Configura
public bool ShouldDisposeConfiguration { get { throw null; } set { } }
public Microsoft.Extensions.Configuration.IConfigurationProvider Build(Microsoft.Extensions.Configuration.IConfigurationBuilder builder) { throw null; }
}
public sealed partial class Config : Microsoft.Extensions.Configuration.IConfigurationBuilder, Microsoft.Extensions.Configuration.IConfigurationRoot, System.IDisposable
{
public Config() { }
public string this[string key] { get { throw null; } set { throw null; } }
public IConfigurationSection GetSection(string key) { throw null; }
public System.Collections.Generic.IEnumerable<IConfigurationSection> GetChildren() { throw null; }
public void Dispose() { throw null; }
System.Collections.Generic.IDictionary<string, object> IConfigurationBuilder.Properties { get { throw null; } }
System.Collections.Generic.IList<Microsoft.Extensions.Configuration.IConfigurationSource> IConfigurationBuilder.Sources { get { throw null; } }
Microsoft.Extensions.Configuration.IConfigurationBuilder IConfigurationBuilder.Add(Microsoft.Extensions.Configuration.IConfigurationSource source) { throw null; }
Microsoft.Extensions.Configuration.IConfigurationRoot IConfigurationBuilder.Build() { throw null; }
System.Collections.Generic.IEnumerable<IConfigurationProvider> IConfigurationRoot.Providers { get { throw null; } }
void IConfigurationRoot.Reload() { throw null; }
Primitives.IChangeToken IConfiguration.GetReloadToken() { throw null; }
}
public partial class ConfigurationBuilder : Microsoft.Extensions.Configuration.IConfigurationBuilder
{
public ConfigurationBuilder() { }
Expand Down
376 changes: 376 additions & 0 deletions src/libraries/Microsoft.Extensions.Configuration/src/Config.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,376 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System;
using System.Collections;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using Microsoft.Extensions.Primitives;

namespace Microsoft.Extensions.Configuration
{
/// <summary>
/// Configuration is mutable configuration object. It is both an <see cref="IConfigurationBuilder"/> and an <see cref="IConfigurationRoot"/>.
/// As sources are added, it updates its current view of configuration. Once Build is called, configuration is frozen.
/// </summary>
public sealed class Config : IConfigurationBuilder, IConfigurationRoot, IDisposable
{
private readonly ConfigurationSources _sources;
private readonly ConfigurationBuilderProperties _properties;

private readonly object _providerLock = new();
private readonly List<IConfigurationProvider> _providers = new();
private readonly List<IDisposable> _changeTokenRegistrations = new();
private ConfigurationReloadToken _changeToken = new();

/// <summary>
/// Creates an empty mutable configuration object that is both an <see cref="IConfigurationBuilder"/> and an <see cref="IConfigurationRoot"/>.
/// </summary>
public Config()
{
_sources = new ConfigurationSources(this);
_properties = new ConfigurationBuilderProperties(this);

// Make sure there's some default storage since there are no default providers.
this.AddInMemoryCollection();

AddSource(_sources[0]);
}

/// <inheritdoc/>
public string this[string key]
{
get
{
lock (_providerLock)
{
for (int i = _providers.Count - 1; i >= 0; i--)
halter73 marked this conversation as resolved.
Show resolved Hide resolved
{
var provider = _providers[i];

if (provider.TryGet(key, out string value))
{
return value;
}
}

return null;
}
}
set
{
lock (_providerLock)
{
if (_providers.Count == 0)
{
throw new InvalidOperationException(SR.Error_NoSources);
}

foreach (var provider in _providers)
{
provider.Set(key, value);
}
}
}
}

/// <inheritdoc/>
public IConfigurationSection GetSection(string key) => new ConfigurationSection(this, key);

/// <inheritdoc/>
public IEnumerable<IConfigurationSection> GetChildren()
{
lock (_providerLock)
{
// ToList() to eagerly evaluate inside lock.
return _providers
.Aggregate(Enumerable.Empty<string>(),
static (seed, source) => source.GetChildKeys(seed, parentPath: null))
.Distinct(StringComparer.OrdinalIgnoreCase)
.Select(GetSection)
.ToList();
}
}

IDictionary<string, object> IConfigurationBuilder.Properties => _properties;

IList<IConfigurationSource> IConfigurationBuilder.Sources => _sources;

IEnumerable<IConfigurationProvider> IConfigurationRoot.Providers
{
get
{
lock (_providerLock)
{
return new List<IConfigurationProvider>(_providers);
}
}
}

/// <inheritdoc/>
public void Dispose()
{
lock (_providerLock)
{
DisposeRegistrationsAndProvidersUnsynchronized();
}
}

IConfigurationBuilder IConfigurationBuilder.Add(IConfigurationSource source)
{
_sources.Add(source ?? throw new ArgumentNullException(nameof(source)));
return this;
}

IConfigurationRoot IConfigurationBuilder.Build() => this;

IChangeToken IConfiguration.GetReloadToken() => _changeToken;

void IConfigurationRoot.Reload()
{
lock (_providerLock)
{
foreach (var provider in _providers)
{
provider.Load();
}
}

RaiseChanged();
}

private void RaiseChanged()
{
var previousToken = Interlocked.Exchange(ref _changeToken, new ConfigurationReloadToken());
previousToken.OnReload();
}

// Don't rebuild and reload all providers in the common case when a source is simply added to the IList.
private void AddSource(IConfigurationSource source)
{
lock (_providerLock)
{
var provider = source.Build(this);
_providers.Add(provider);

provider.Load();
_changeTokenRegistrations.Add(ChangeToken.OnChange(() => provider.GetReloadToken(), () => RaiseChanged()));
}

RaiseChanged();
}

// Something other than Add was called on IConfigurationBuilder.Sources or IConfigurationBuilder.Properties has changed.
private void ReloadSources()
{
lock (_providerLock)
{
DisposeRegistrationsAndProvidersUnsynchronized();

_changeTokenRegistrations.Clear();
_providers.Clear();

foreach (var source in _sources)
{
_providers.Add(source.Build(this));
}

foreach (var p in _providers)
{
p.Load();
_changeTokenRegistrations.Add(ChangeToken.OnChange(() => p.GetReloadToken(), () => RaiseChanged()));
}
}

RaiseChanged();
}

private void DisposeRegistrationsAndProvidersUnsynchronized()
{
// dispose change token registrations
foreach (var registration in _changeTokenRegistrations)
{
registration.Dispose();
}

// dispose providers
foreach (var provider in _providers)
{
(provider as IDisposable)?.Dispose();
}
}

private class ConfigurationSources : IList<IConfigurationSource>
{
private readonly List<IConfigurationSource> _sources = new();
private readonly Config _config;

public ConfigurationSources(Config config)
{
_config = config;
}

public IConfigurationSource this[int index]
{
get => _sources[index];
set
{
_sources[index] = value;
_config.ReloadSources();
}
}

public int Count => _sources.Count;

public bool IsReadOnly => false;

public void Add(IConfigurationSource source)
{
_sources.Add(source);
_config.AddSource(source);
}

public void Clear()
{
_sources.Clear();
_config.ReloadSources();
}

public bool Contains(IConfigurationSource source)
{
return _sources.Contains(source);
}

public void CopyTo(IConfigurationSource[] array, int arrayIndex)
{
_sources.CopyTo(array, arrayIndex);
}

public IEnumerator<IConfigurationSource> GetEnumerator()
{
return _sources.GetEnumerator();
}

public int IndexOf(IConfigurationSource source)
{
return _sources.IndexOf(source);
}

public void Insert(int index, IConfigurationSource source)
{
_sources.Insert(index, source);
_config.ReloadSources();
}

public bool Remove(IConfigurationSource source)
{
var removed = _sources.Remove(source);
_config.ReloadSources();
return removed;
}

public void RemoveAt(int index)
{
_sources.RemoveAt(index);
_config.ReloadSources();
}

IEnumerator IEnumerable.GetEnumerator()
{
return GetEnumerator();
}
}

private class ConfigurationBuilderProperties : IDictionary<string, object>
{
private readonly Dictionary<string, object> _properties = new();
private readonly Config _config;

public ConfigurationBuilderProperties(Config config)
{
_config = config;
}

public object this[string key]
{
get => _properties[key];
set
{
_properties[key] = value;
_config.ReloadSources();
}
}

public ICollection<string> Keys => _properties.Keys;

public ICollection<object> Values => _properties.Values;

public int Count => _properties.Count;

public bool IsReadOnly => false;

public void Add(string key, object value)
{
_properties.Add(key, value);
_config.ReloadSources();
}

public void Add(KeyValuePair<string, object> item)
{
((IDictionary<string, object>)_properties).Add(item);
_config.ReloadSources();
}

public void Clear()
{
_properties.Clear();
_config.ReloadSources();
}

public bool Contains(KeyValuePair<string, object> item)
{
return _properties.Contains(item);
}

public bool ContainsKey(string key)
{
return _properties.ContainsKey(key);
}

public void CopyTo(KeyValuePair<string, object>[] array, int arrayIndex)
{
((IDictionary<string, object>)_properties).CopyTo(array, arrayIndex);
}

public IEnumerator<KeyValuePair<string, object>> GetEnumerator()
{
return _properties.GetEnumerator();
}

public bool Remove(string key)
{
var wasRemoved = _properties.Remove(key);
_config.ReloadSources();
return wasRemoved;
}

public bool Remove(KeyValuePair<string, object> item)
{
var wasRemoved = ((IDictionary<string, object>)_properties).Remove(item);
_config.ReloadSources();
return wasRemoved;
}

public bool TryGetValue(string key, out object value)
{
return _properties.TryGetValue(key, out value);
}

IEnumerator IEnumerable.GetEnumerator()
{
return _properties.GetEnumerator();
}
}
}
}
Loading