commit 3134a6729eda096dbc14cd0deb505edd6da54c77 Author: Chris Kaczor Date: Fri Apr 7 18:23:10 2023 -0400 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..dfcfd56 --- /dev/null +++ b/.gitignore @@ -0,0 +1,350 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ +[Ll]ogs/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# NuGet Symbol Packages +*.snupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ diff --git a/GenericSettingsProvider.cs b/GenericSettingsProvider.cs new file mode 100644 index 0000000..4e6fdab --- /dev/null +++ b/GenericSettingsProvider.cs @@ -0,0 +1,245 @@ +using System.Collections.Specialized; +using System.Configuration; +using System.Reflection; + +namespace ChrisKaczor.GenericSettingsProvider +{ + public class GenericSettingsProvider : SettingsProvider, IApplicationSettingsProvider + { + #region Delegates + + public delegate object OpenDataStoreDelegate(); + + public delegate void CloseDataStoreDelegate(object dataStore); + + public delegate string GetSettingValueDelegate(object dataStore, string name, Version version); + + public delegate void SetSettingValueDelegate(object dataStore, string name, Version version, string value); + + public delegate List GetVersionListDelegate(object dataStore); + + public delegate void DeleteSettingsForVersionDelegate(object dataStore, Version version); + + #endregion + + #region Callbacks + + public OpenDataStoreDelegate? OpenDataStore = null; + public CloseDataStoreDelegate? CloseDataStore = null; + public GetSettingValueDelegate? GetSettingValue = null; + public SetSettingValueDelegate? SetSettingValue = null; + public GetVersionListDelegate? GetVersionList = null; + public DeleteSettingsForVersionDelegate? DeleteSettingsForVersion = null; + + #endregion + + #region SettingsProvider members + + public override string ApplicationName { get; set; } = string.Empty; + + public bool DeleteOldVersionsOnUpgrade { get; set; } + + public override void Initialize(string name, NameValueCollection config) + { + if (string.IsNullOrEmpty(name)) + name = GetType().Name; + + base.Initialize(name, config); + } + + public override SettingsPropertyValueCollection GetPropertyValues(SettingsContext context, SettingsPropertyCollection properties) + { + // Create a new collection for the values + var values = new SettingsPropertyValueCollection(); + + // Get the current version number + var version = GetCurrentVersion(); + + // Open the data store + var dataStore = OpenDataStore!(); + + // Loop over each property + foreach (SettingsProperty property in properties) + { + // Get the setting value for the current version + var value = GetPropertyValue(dataStore, property, version); + + // Add the value to the collection + values.Add(value); + } + + // Close the data store + CloseDataStore!(dataStore); + + return values; + } + + public override void SetPropertyValues(SettingsContext context, SettingsPropertyValueCollection properties) + { + // Get the current version number + var version = GetCurrentVersion(); + + // Open the data store + var dataStore = OpenDataStore!(); + + // Loop over each property + foreach (SettingsPropertyValue propertyValue in properties) + { + // If the property isn't dirty or it is null then we can skip it + if (!propertyValue.IsDirty || (propertyValue.SerializedValue == null)) + continue; + + // Set the property value + SetPropertyValue(dataStore, propertyValue, version); + } + + // Close the data store + CloseDataStore!(dataStore); + } + + #endregion + + #region Version numbers + + private static Version GetCurrentVersion() + { + return Assembly.GetEntryAssembly()!.GetName().Version ?? new Version(); + } + + private Version? GetPreviousVersion(object dataStore) + { + // Get the current version number + var currentVersion = GetCurrentVersion(); + + // Get a distinct list of version numbers + var versionList = GetVersionList!(dataStore); + + // Sort the list using the Version object and get the first value + var previousVersion = versionList.Where(v => v < currentVersion).MaxBy(v => v); + + return previousVersion; + } + + #endregion + + #region Value get and set + + private SettingsPropertyValue GetPropertyValue(object dataStore, SettingsProperty property, Version version) + { + // Create the value for the property + var value = new SettingsPropertyValue(property); + + // Try to get the setting that matches the name and version + var setting = GetSettingValue!(dataStore, property.Name, version); + + // If the setting was found then set the value, otherwise leave as default + value.SerializedValue = setting; + + // Value is not dirty since we just read it + value.IsDirty = false; + + return value; + } + + private void SetPropertyValue(object dataStore, SettingsPropertyValue value, Version version) + { + // Set the value for this version + SetSettingValue!(dataStore, value.Property.Name, version, value.SerializedValue.ToString() ?? string.Empty); + } + + #endregion + + #region IApplicationSettingsProvider members + + public void Reset(SettingsContext context) + { + // Get the current version number + var version = GetCurrentVersion(); + + // Open the data store + var dataStore = OpenDataStore!(); + + // Delete all settings for this version + DeleteSettingsForVersion!(dataStore, version); + + // Close the data store + CloseDataStore!(dataStore); + } + + public SettingsPropertyValue GetPreviousVersion(SettingsContext context, SettingsProperty property) + { + // Open the data store + var dataStore = OpenDataStore!(); + + // Get the previous version number + var previousVersion = GetPreviousVersion(dataStore); + + SettingsPropertyValue value; + + // If there is no previous version we have a return a setting with a null value + if (previousVersion == null) + { + // Create a new property value with the value set to null + value = new SettingsPropertyValue(property) { PropertyValue = null }; + + return value; + } + + // Return the value from the previous version + value = GetPropertyValue(dataStore, property, previousVersion); + + // Close the data store + CloseDataStore!(dataStore); + + return value; + } + + public void Upgrade(SettingsContext context, SettingsPropertyCollection properties) + { + // Open the data store + var dataStore = OpenDataStore!(); + + // Get the previous version number + var previousVersion = GetPreviousVersion(dataStore); + + // If there is no previous version number just do nothing + if (previousVersion == null) + return; + + // Delete everything for the current version + Reset(context); + + // Get the current version number + var currentVersion = GetCurrentVersion(); + + // Loop over each property + foreach (SettingsProperty property in properties) + { + // Get the previous value + var previousValue = GetPropertyValue(dataStore, property, previousVersion); + + // Set the current value if there was a previous value + if (previousValue.SerializedValue != null) + SetPropertyValue(dataStore, previousValue, currentVersion); + } + + if (DeleteOldVersionsOnUpgrade) + { + // Get a distinct list of version numbers + var versionList = GetVersionList!(dataStore); + + // Get everything before the current version + versionList = versionList.Where(v => v < currentVersion).ToList(); + + // Delete settings for anything in the list + foreach (var version in versionList) + DeleteSettingsForVersion!(dataStore, version); + } + + // Close the data store + CloseDataStore!(dataStore); + } + + #endregion + } +} \ No newline at end of file diff --git a/GenericSettingsProvider.csproj b/GenericSettingsProvider.csproj new file mode 100644 index 0000000..1ac844f --- /dev/null +++ b/GenericSettingsProvider.csproj @@ -0,0 +1,25 @@ + + + net7.0 + enable + enable + ChrisKaczor.GenericSettingsProvider + ChrisKaczor.GenericSettingsProvider + Chris Kaczor + ChrisKaczor.GenericSettingsProvider + https://github.com/ckaczor/ChrisKaczor.GenericSettingsProvider + README.md + A custom settings provider with hooks that allow settings to be stored outside of the typical settings file such as a database. + ChrisKaczor.GenericSettingsProvider + README.md + + + + + + + True + \ + + + \ No newline at end of file diff --git a/GenericSettingsProvider.sln b/GenericSettingsProvider.sln new file mode 100644 index 0000000..8f36ae0 --- /dev/null +++ b/GenericSettingsProvider.sln @@ -0,0 +1,25 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.5.33516.290 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GenericSettingsProvider", "GenericSettingsProvider.csproj", "{E50A4847-D018-464C-A565-D1838176DD32}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {E50A4847-D018-464C-A565-D1838176DD32}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {E50A4847-D018-464C-A565-D1838176DD32}.Debug|Any CPU.Build.0 = Debug|Any CPU + {E50A4847-D018-464C-A565-D1838176DD32}.Release|Any CPU.ActiveCfg = Release|Any CPU + {E50A4847-D018-464C-A565-D1838176DD32}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {02D44727-3676-4822-9601-6359EEB02F6B} + EndGlobalSection +EndGlobal diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9bb69bc --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Chris Kaczor + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..1ffe43a --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# ChrisKaczor.GenericSettingsProvider + +A custom settings provider with hooks that allow settings to be stored outside of the typical settings file such as a database. + +## Authors + +* **Chris Kaczor** - *Initial work* - https://github.com/ckaczor - https://chriskaczor.com + +## License + +This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details. + +## Disclaimer + +This code is used by my various personal projects and may not be useful or work in all use cases. \ No newline at end of file diff --git a/azure-pipelines.yml b/azure-pipelines.yml new file mode 100644 index 0000000..b3ae354 --- /dev/null +++ b/azure-pipelines.yml @@ -0,0 +1,45 @@ +name: 1.0.$(Rev:r) + +pr: none + +trigger: + batch: 'true' + branches: + include: + - main + +pool: + vmImage: 'windows-latest' + +variables: + buildConfiguration: 'Release' + +steps: + +- task: DotNetCoreCLI@2 + displayName: 'dotnet build' + inputs: + command: 'build' + arguments: '--configuration $(buildConfiguration)' + projects: 'GenericSettingsProvider.csproj' + +- task: DotNetCoreCLI@2 + displayName: "dotnet pack" + inputs: + command: 'pack' + arguments: '--configuration $(buildConfiguration)' + packagesToPack: 'GenericSettingsProvider.csproj' + nobuild: true + versioningScheme: 'byBuildNumber' + +- task: NuGetCommand@2 + displayName: 'nuget push' + inputs: + command: 'push' + feedsToUse: 'select' + packagesToPush: '$(Build.ArtifactStagingDirectory)/**/*.nupkg;!$(Build.ArtifactStagingDirectory)/**/*.symbols.nupkg' + nuGetFeedType: external + publishFeedCredentials: 'NuGet' + publishVstsFeed: 'Packages' + versioningScheme: 'byBuildNumber' + allowPackageConflicts: true \ No newline at end of file