From d5ac97ece849f46711e97e5e0e290119a4370ef2 Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Thu, 7 Jan 2021 14:35:15 +0900
Subject: [PATCH] Add realm store / key binding implementations

---
 osu.Game/Input/Bindings/RealmKeyBinding.cs | 33 ++++++++
 osu.Game/Input/RealmKeyBindingStore.cs     | 92 ++++++++++++++++++++++
 osu.Game/OsuGameBase.cs                    |  1 +
 3 files changed, 126 insertions(+)
 create mode 100644 osu.Game/Input/Bindings/RealmKeyBinding.cs
 create mode 100644 osu.Game/Input/RealmKeyBindingStore.cs

diff --git a/osu.Game/Input/Bindings/RealmKeyBinding.cs b/osu.Game/Input/Bindings/RealmKeyBinding.cs
new file mode 100644
index 0000000000..a8cd1c3fb6
--- /dev/null
+++ b/osu.Game/Input/Bindings/RealmKeyBinding.cs
@@ -0,0 +1,33 @@
+// 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;
+using osu.Framework.Input.Bindings;
+using osu.Game.Database;
+using Realms;
+
+namespace osu.Game.Input.Bindings
+{
+    [MapTo("KeyBinding")]
+    public class RealmKeyBinding : RealmObject, IHasGuidPrimaryKey
+    {
+        public Guid ID { get; set; }
+
+        public int? RulesetID { get; set; }
+
+        public int? Variant { get; set; }
+
+        [Ignored]
+        public KeyBinding KeyBinding
+        {
+            get
+            {
+                var split = KeyBindingString.Split(':');
+                return new KeyBinding(split[0], int.Parse(split[1]));
+            }
+            set => KeyBindingString = $"{value.KeyCombination}:{(int)value.Action}";
+        }
+
+        public string KeyBindingString { get; set; }
+    }
+}
diff --git a/osu.Game/Input/RealmKeyBindingStore.cs b/osu.Game/Input/RealmKeyBindingStore.cs
new file mode 100644
index 0000000000..471a25dd0d
--- /dev/null
+++ b/osu.Game/Input/RealmKeyBindingStore.cs
@@ -0,0 +1,92 @@
+// 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;
+using System.Collections.Generic;
+using System.Linq;
+using osu.Framework.Input.Bindings;
+using osu.Framework.Platform;
+using osu.Game.Database;
+using osu.Game.Input.Bindings;
+using osu.Game.Rulesets;
+
+namespace osu.Game.Input
+{
+    public class RealmKeyBindingStore : RealmBackedStore
+    {
+        public event Action KeyBindingChanged;
+
+        public RealmKeyBindingStore(RealmContextFactory contextFactory, RulesetStore rulesets, Storage storage = null)
+            : base(contextFactory, storage)
+        {
+            using (ContextFactory.GetForWrite())
+            {
+                foreach (RulesetInfo info in rulesets.AvailableRulesets)
+                {
+                    var ruleset = info.CreateInstance();
+                    foreach (var variant in ruleset.AvailableVariants)
+                        insertDefaults(ruleset.GetDefaultKeyBindings(variant), info.ID, variant);
+                }
+            }
+        }
+
+        public void Register(KeyBindingContainer manager) => insertDefaults(manager.DefaultKeyBindings);
+
+        private void insertDefaults(IEnumerable<KeyBinding> defaults, int? rulesetId = null, int? variant = null)
+        {
+            using (var usage = ContextFactory.GetForWrite())
+            {
+                // compare counts in database vs defaults
+                foreach (var group in defaults.GroupBy(k => k.Action))
+                {
+                    int count = Query(rulesetId, variant).Count(k => k.KeyBinding.Action == group.Key);
+                    int aimCount = group.Count();
+
+                    if (aimCount <= count)
+                        continue;
+
+                    foreach (var insertable in group.Skip(count).Take(aimCount - count))
+                    {
+                        // insert any defaults which are missing.
+                        usage.Context.Add(new RealmKeyBinding
+                        {
+                            KeyBinding = new KeyBinding
+                            {
+                                KeyCombination = insertable.KeyCombination,
+                                Action = insertable.Action,
+                            },
+                            RulesetID = rulesetId,
+                            Variant = variant
+                        });
+                    }
+                }
+            }
+        }
+
+        /// <summary>
+        /// Retrieve <see cref="RealmKeyBinding"/>s for a specified ruleset/variant content.
+        /// </summary>
+        /// <param name="rulesetId">The ruleset's internal ID.</param>
+        /// <param name="variant">An optional variant.</param>
+        /// <returns></returns>
+        public List<RealmKeyBinding> Query(int? rulesetId = null, int? variant = null) =>
+            ContextFactory.Get().All<RealmKeyBinding>().Where(b => b.RulesetID == rulesetId && b.Variant == variant).ToList();
+
+        public void Update(KeyBinding keyBinding)
+        {
+            using (ContextFactory.GetForWrite())
+            {
+                //todo: fix
+                // var dbKeyBinding = (RealmKeyBinding)keyBinding;
+                // Refresh(ref dbKeyBinding);
+                //
+                // if (dbKeyBinding.KeyCombination.Equals(keyBinding.KeyCombination))
+                //     return;
+                //
+                // dbKeyBinding.KeyCombination = keyBinding.KeyCombination;
+            }
+
+            KeyBindingChanged?.Invoke();
+        }
+    }
+}
diff --git a/osu.Game/OsuGameBase.cs b/osu.Game/OsuGameBase.cs
index 8ec6976c63..95b1d3100c 100644
--- a/osu.Game/OsuGameBase.cs
+++ b/osu.Game/OsuGameBase.cs
@@ -266,6 +266,7 @@ namespace osu.Game
             AddInternal(scorePerformanceManager);
 
             dependencies.Cache(KeyBindingStore = new KeyBindingStore(contextFactory, RulesetStore));
+            dependencies.Cache(new RealmKeyBindingStore(realmFactory, RulesetStore));
             dependencies.Cache(SettingsStore = new SettingsStore(contextFactory));
             dependencies.Cache(RulesetConfigCache = new RulesetConfigCache(SettingsStore));
             dependencies.Cache(new SessionStatics());