From 127858d39855c7670377b3ff4e32af02fa864966 Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Sat, 25 May 2019 15:00:53 +0900
Subject: [PATCH] Store databased settings based on string keys rather than
 ints

Allows for rearranging/removal from enums without consequence.
---
 .../Configuration/DatabasedConfigManager.cs   | 19 +++++++++++++++++--
 osu.Game/Configuration/DatabasedSetting.cs    | 11 +++--------
 osu.Game/Configuration/SettingsStore.cs       |  6 ++++++
 .../Migrations/20180125143340_Settings.cs     |  2 +-
 .../Migrations/OsuDbContextModelSnapshot.cs   |  4 ++--
 5 files changed, 29 insertions(+), 13 deletions(-)

diff --git a/osu.Game/Configuration/DatabasedConfigManager.cs b/osu.Game/Configuration/DatabasedConfigManager.cs
index 8f1780cab5..d5cdd7e4bc 100644
--- a/osu.Game/Configuration/DatabasedConfigManager.cs
+++ b/osu.Game/Configuration/DatabasedConfigManager.cs
@@ -2,6 +2,7 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using System.Collections.Generic;
+using System.Linq;
 using osu.Framework.Bindables;
 using osu.Framework.Configuration;
 using osu.Game.Rulesets;
@@ -19,6 +20,8 @@ namespace osu.Game.Configuration
 
         private readonly RulesetInfo ruleset;
 
+        private readonly bool legacySettingsExist;
+
         protected DatabasedConfigManager(SettingsStore settings, RulesetInfo ruleset = null, int? variant = null)
         {
             this.settings = settings;
@@ -26,6 +29,7 @@ namespace osu.Game.Configuration
             this.variant = variant;
 
             databasedSettings = settings.Query(ruleset?.ID, variant);
+            legacySettingsExist = databasedSettings.Any(s => int.TryParse(s.Key, out var _));
 
             InitialiseDefaults();
         }
@@ -43,7 +47,18 @@ namespace osu.Game.Configuration
         {
             base.AddBindable(lookup, bindable);
 
-            var setting = databasedSettings.Find(s => (int)s.Key == (int)(object)lookup);
+            if (legacySettingsExist)
+            {
+                var legacySetting = databasedSettings.Find(s => s.Key == ((int)(object)lookup).ToString());
+
+                if (legacySetting != null)
+                {
+                    bindable.Parse(legacySetting.Value);
+                    settings.Delete(legacySetting);
+                }
+            }
+
+            var setting = databasedSettings.Find(s => s.Key == lookup.ToString());
 
             if (setting != null)
             {
@@ -53,7 +68,7 @@ namespace osu.Game.Configuration
             {
                 settings.Update(setting = new DatabasedSetting
                 {
-                    Key = lookup,
+                    Key = lookup.ToString(),
                     Value = bindable.Value,
                     RulesetID = ruleset?.ID,
                     Variant = variant,
diff --git a/osu.Game/Configuration/DatabasedSetting.cs b/osu.Game/Configuration/DatabasedSetting.cs
index d56ac49358..3e0a9ecd28 100644
--- a/osu.Game/Configuration/DatabasedSetting.cs
+++ b/osu.Game/Configuration/DatabasedSetting.cs
@@ -1,4 +1,4 @@
-// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
+// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
 // See the LICENCE file in the repository root for full licence text.
 
 using System.ComponentModel.DataAnnotations.Schema;
@@ -16,11 +16,7 @@ namespace osu.Game.Configuration
         public int? Variant { get; set; }
 
         [Column("Key")]
-        public int IntKey
-        {
-            get => (int)Key;
-            private set => Key = value;
-        }
+        public string Key { get; set; }
 
         [Column("Value")]
         public string StringValue
@@ -29,10 +25,9 @@ namespace osu.Game.Configuration
             set => Value = value;
         }
 
-        public object Key;
         public object Value;
 
-        public DatabasedSetting(object key, object value)
+        public DatabasedSetting(string key, object value)
         {
             Key = key;
             Value = value;
diff --git a/osu.Game/Configuration/SettingsStore.cs b/osu.Game/Configuration/SettingsStore.cs
index f15fd1f17b..f8c9bdeaf8 100644
--- a/osu.Game/Configuration/SettingsStore.cs
+++ b/osu.Game/Configuration/SettingsStore.cs
@@ -37,5 +37,11 @@ namespace osu.Game.Configuration
 
             SettingChanged?.Invoke();
         }
+
+        public void Delete(DatabasedSetting setting)
+        {
+            using (var usage = ContextFactory.GetForWrite())
+                usage.Context.Remove(setting);
+        }
     }
 }
diff --git a/osu.Game/Migrations/20180125143340_Settings.cs b/osu.Game/Migrations/20180125143340_Settings.cs
index 2e2768dc7c..166d3c086d 100644
--- a/osu.Game/Migrations/20180125143340_Settings.cs
+++ b/osu.Game/Migrations/20180125143340_Settings.cs
@@ -16,7 +16,7 @@ namespace osu.Game.Migrations
                 {
                     ID = table.Column<int>(type: "INTEGER", nullable: false)
                         .Annotation("Sqlite:Autoincrement", true),
-                    Key = table.Column<int>(type: "INTEGER", nullable: false),
+                    Key = table.Column<int>(type: "TEXT", nullable: false),
                     RulesetID = table.Column<int>(type: "INTEGER", nullable: true),
                     Value = table.Column<string>(type: "TEXT", nullable: true),
                     Variant = table.Column<int>(type: "INTEGER", nullable: true)
diff --git a/osu.Game/Migrations/OsuDbContextModelSnapshot.cs b/osu.Game/Migrations/OsuDbContextModelSnapshot.cs
index 8430e00e4f..f942d357e8 100644
--- a/osu.Game/Migrations/OsuDbContextModelSnapshot.cs
+++ b/osu.Game/Migrations/OsuDbContextModelSnapshot.cs
@@ -14,7 +14,7 @@ namespace osu.Game.Migrations
         {
 #pragma warning disable 612, 618
             modelBuilder
-                .HasAnnotation("ProductVersion", "2.2.1-servicing-10028");
+                .HasAnnotation("ProductVersion", "2.2.4-servicing-10062");
 
             modelBuilder.Entity("osu.Game.Beatmaps.BeatmapDifficulty", b =>
                 {
@@ -198,7 +198,7 @@ namespace osu.Game.Migrations
                     b.Property<int>("ID")
                         .ValueGeneratedOnAdd();
 
-                    b.Property<int>("IntKey")
+                    b.Property<string>("Key")
                         .HasColumnName("Key");
 
                     b.Property<int?>("RulesetID");