ckaczor/Common
1
0
Fork 0
mirror of https://github.com/ckaczor/Common.git synced 2026-02-16 10:58:34 -05:00
Code Issues Packages Projects Releases Wiki Activity

Clean up settings provider and provide setting (off by default) to delete old versions on upgrade

Browse Source
This commit is contained in:
Chris Kaczor
2014-12-06 08:40:28 -05:00
parent 1fafa48ff4
commit a26f4686ab
1 changed files with 49 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

95
Settings/GenericSettingsProvider.cs
View File

@@ -3,6 +3,7 @@ using System.Collections.Generic;
using System.Collections.Specialized; using System.Collections.Specialized;
using System.Configuration; using System.Configuration;
using System.Linq; using System.Linq;
using System.Reflection;
namespace Common.Settings namespace Common.Settings
{ {
@@ -44,10 +45,12 @@ namespace Common.Settings
set { _applicationName = value; } set { _applicationName = value; }
} }
public bool DeleteOldVersionsOnUpgrade { get; set; }
public override void Initialize(string name, NameValueCollection config) public override void Initialize(string name, NameValueCollection config)
{ {
if (string.IsNullOrEmpty(name)) if (string.IsNullOrEmpty(name))
name = this.GetType().Name; name = GetType().Name;
base.Initialize(name, config); base.Initialize(name, config);
} }
@@ -55,10 +58,10 @@ namespace Common.Settings
public override SettingsPropertyValueCollection GetPropertyValues(SettingsContext context, SettingsPropertyCollection properties) public override SettingsPropertyValueCollection GetPropertyValues(SettingsContext context, SettingsPropertyCollection properties)
{ {
// Create a new collection for the values // Create a new collection for the values
SettingsPropertyValueCollection values = new SettingsPropertyValueCollection(); var values = new SettingsPropertyValueCollection();
// Get the current version number // Get the current version number
string version = getCurrentVersionNumber(); var version = GetCurrentVersionNumber();
// Open the data store // Open the data store
var dataStore = OpenDataStore(); var dataStore = OpenDataStore();
@@ -67,7 +70,7 @@ namespace Common.Settings
foreach (SettingsProperty property in properties) foreach (SettingsProperty property in properties)
{ {
// Get the setting value for the current version // Get the setting value for the current version
SettingsPropertyValue value = getPropertyValue(dataStore, property, version); var value = GetPropertyValue(dataStore, property, version);
// Add the value to the collection // Add the value to the collection
values.Add(value); values.Add(value);
@@ -82,7 +85,7 @@ namespace Common.Settings
public override void SetPropertyValues(SettingsContext context, SettingsPropertyValueCollection properties) public override void SetPropertyValues(SettingsContext context, SettingsPropertyValueCollection properties)
{ {
// Get the current version number // Get the current version number
string version = getCurrentVersionNumber(); var version = GetCurrentVersionNumber();
// Open the data store // Open the data store
var dataStore = OpenDataStore(); var dataStore = OpenDataStore();
@@ -91,10 +94,11 @@ namespace Common.Settings
foreach (SettingsPropertyValue propertyValue in properties) foreach (SettingsPropertyValue propertyValue in properties)
{ {
// If the property isn't dirty or it is null then we can skip it // If the property isn't dirty or it is null then we can skip it
if (!propertyValue.IsDirty || (propertyValue.SerializedValue == null)) { continue; } if (!propertyValue.IsDirty || (propertyValue.SerializedValue == null))
continue;
// Set the property value // Set the property value
setPropertyValue(dataStore, propertyValue, version); SetPropertyValue(dataStore, propertyValue, version);
} }
// Close the data store // Close the data store
@@ -105,21 +109,18 @@ namespace Common.Settings
#region Version numbers #region Version numbers
private string getCurrentVersionNumber() private static string GetCurrentVersionNumber()
{ {
return System.Reflection.Assembly.GetExecutingAssembly().GetName().Version.ToString(); return Assembly.GetEntryAssembly().GetName().Version.ToString();
} }
private string getPreviousVersionNumber(object dataStore) private string GetPreviousVersionNumber(object dataStore)
{ {
// Get the current version number // Get the current version number
string currentVersion = getCurrentVersionNumber(); var currentVersion = GetCurrentVersionNumber();
// Initialize the previous version number
string previousVersion = null;
// Get a distinct list of version numbers // Get a distinct list of version numbers
List<string> versionList = GetVersionList(dataStore); var versionList = GetVersionList(dataStore);
// Remove the current version // Remove the current version
versionList.Remove(currentVersion); versionList.Remove(currentVersion);
@@ -128,7 +129,7 @@ namespace Common.Settings
versionList.Remove(string.Empty); versionList.Remove(string.Empty);
// Sort the list using the Version object and get the first value // Sort the list using the Version object and get the first value
previousVersion = versionList.OrderByDescending(v => new Version(v)).FirstOrDefault(); var previousVersion = versionList.OrderByDescending(v => new Version(v)).FirstOrDefault();
return previousVersion; return previousVersion;
} }
@@ -137,13 +138,13 @@ namespace Common.Settings
#region Value get and set #region Value get and set
private SettingsPropertyValue getPropertyValue(object dataStore, SettingsProperty property, string version) private SettingsPropertyValue GetPropertyValue(object dataStore, SettingsProperty property, string version)
{ {
// Create the value for the property // Create the value for the property
SettingsPropertyValue value = new SettingsPropertyValue(property); var value = new SettingsPropertyValue(property);
// Try to get the setting that matches the name and version // Try to get the setting that matches the name and version
string setting = GetSettingValue(dataStore, property.Name, version); var setting = GetSettingValue(dataStore, property.Name, version);
// If the setting was found then set the value, otherwise leave as default // If the setting was found then set the value, otherwise leave as default
value.SerializedValue = setting; value.SerializedValue = setting;
@@ -154,7 +155,7 @@ namespace Common.Settings
return value; return value;
} }
private void setPropertyValue(object dataStore, SettingsPropertyValue value, string version) private void SetPropertyValue(object dataStore, SettingsPropertyValue value, string version)
{ {
// Set the value for this version // Set the value for this version
SetSettingValue(dataStore, value.Property.Name, version, value.SerializedValue.ToString()); SetSettingValue(dataStore, value.Property.Name, version, value.SerializedValue.ToString());
@@ -167,7 +168,7 @@ namespace Common.Settings
public void Reset(SettingsContext context) public void Reset(SettingsContext context)
{ {
// Get the current version number // Get the current version number
string version = getCurrentVersionNumber(); var version = GetCurrentVersionNumber();
// Open the data store // Open the data store
var dataStore = OpenDataStore(); var dataStore = OpenDataStore();
@@ -185,24 +186,21 @@ namespace Common.Settings
var dataStore = OpenDataStore(); var dataStore = OpenDataStore();
// Get the previous version number // Get the previous version number
string previousVersion = getPreviousVersionNumber(dataStore); var previousVersion = GetPreviousVersionNumber(dataStore);
SettingsPropertyValue value; SettingsPropertyValue value;
// If there is no previous version we have a return a setting with a null value // If there is no previous version we have a return a setting with a null value
if (string.IsNullOrEmpty(previousVersion)) if (string.IsNullOrEmpty(previousVersion))
{ {
// Create a new property value // Create a new property value with the value set to null
value = new SettingsPropertyValue(property); value = new SettingsPropertyValue(property) { PropertyValue = null };
// Set the property value to null
value.PropertyValue = null;
return value; return value;
} }
// Return the value from the previous version // Return the value from the previous version
value = getPropertyValue(dataStore, property, previousVersion); value = GetPropertyValue(dataStore, property, previousVersion);
// Close the data store // Close the data store
CloseDataStore(dataStore); CloseDataStore(dataStore);
@@ -219,7 +217,7 @@ namespace Common.Settings
return; return;
// Get the previous version number // Get the previous version number
string previousVersion = getPreviousVersionNumber(dataStore); var previousVersion = GetPreviousVersionNumber(dataStore);
// If there is no previous version number just do nothing // If there is no previous version number just do nothing
if (string.IsNullOrEmpty(previousVersion)) if (string.IsNullOrEmpty(previousVersion))
@@ -229,28 +227,31 @@ namespace Common.Settings
Reset(context); Reset(context);
// Get the current version number // Get the current version number
string currentVersion = getCurrentVersionNumber(); var currentVersion = GetCurrentVersionNumber();
// Loop over each property // Loop over each property
foreach (SettingsProperty property in properties) foreach (SettingsProperty property in properties)
{ {
// Get the previous value // Get the previous value
SettingsPropertyValue previousValue = getPropertyValue(dataStore, property, previousVersion); var previousValue = GetPropertyValue(dataStore, property, previousVersion);
// Set the current value if there was a previous value // Set the current value if there was a previous value
if (previousValue.SerializedValue != null) if (previousValue.SerializedValue != null)
setPropertyValue(dataStore, previousValue, currentVersion); SetPropertyValue(dataStore, previousValue, currentVersion);
} }
// Get a distinct list of version numbers if (DeleteOldVersionsOnUpgrade)
List<string> versionList = GetVersionList(dataStore); {
// Get a distinct list of version numbers
var versionList = GetVersionList(dataStore);
// Remove the current version // Remove the current version
versionList.Remove(currentVersion); versionList.Remove(currentVersion);
// Delete settings for anything left // Delete settings for anything left
foreach (string version in versionList) foreach (var version in versionList)
DeleteSettingsForVersion(dataStore, version); DeleteSettingsForVersion(dataStore, version);
}
// Close the data store // Close the data store
CloseDataStore(dataStore); CloseDataStore(dataStore);
@@ -260,23 +261,25 @@ namespace Common.Settings
#region Setting scope helpers #region Setting scope helpers
private bool isApplicationScoped(SettingsProperty property) // ReSharper disable once UnusedMember.Local
private bool IsApplicationScoped(SettingsProperty property)
{ {
return hasSettingScope(property, typeof(ApplicationScopedSettingAttribute)); return HasSettingScope(property, typeof(ApplicationScopedSettingAttribute));
} }
private bool isUserScoped(SettingsProperty property) // ReSharper disable once UnusedMember.Local
private bool IsUserScoped(SettingsProperty property)
{ {
return hasSettingScope(property, typeof(UserScopedSettingAttribute)); return HasSettingScope(property, typeof(UserScopedSettingAttribute));
} }
private bool hasSettingScope(SettingsProperty property, Type attributeType) private bool HasSettingScope(SettingsProperty property, Type attributeType)
{ {
// Check if the setting is application scoped // Check if the setting is application scoped
bool isApplicationScoped = property.Attributes[typeof(ApplicationScopedSettingAttribute)] != null; var isApplicationScoped = property.Attributes[typeof(ApplicationScopedSettingAttribute)] != null;
// Check if the setting is user scoped // Check if the setting is user scoped
bool isUserScoped = property.Attributes[typeof(UserScopedSettingAttribute)] != null; var isUserScoped = property.Attributes[typeof(UserScopedSettingAttribute)] != null;
// Both user and application is not allowed // Both user and application is not allowed
if (isUserScoped && isApplicationScoped) if (isUserScoped && isApplicationScoped)