Merge pull request #36121 from smoogipoo/mp-fix-availability-tracker

peppy · web-flow · commit 2d06c2b1a6f4 · 2025-12-24T20:32:46.000+09:00
Fix potentially incorrect online play beatmap availability
diff --git a/osu.Game.Tests/Online/TestSceneMultiplayerBeatmapAvailabilityTracker.cs b/osu.Game.Tests/Online/TestSceneMultiplayerBeatmapAvailabilityTracker.cs
@@ -44,7 +44,13 @@ private void load(GameHost host)
             availableBeatmap = importedSet.Beatmaps[0];
             unavailableBeatmap = importedSet.Beatmaps[1];
 
-            Realm.Write(r => r.Remove(r.Find<BeatmapInfo>(unavailableBeatmap.ID)!));
+            Realm.Write(r =>
+            {
+                BeatmapInfo available = r.Find<BeatmapInfo>(availableBeatmap.ID)!;
+                available.OnlineMD5Hash = available.MD5Hash;
+
+                r.Remove(r.Find<BeatmapInfo>(unavailableBeatmap.ID)!);
+            });
         }
 
         public override void SetUpSteps()
diff --git a/osu.Game.Tests/Online/TestScenePlaylistsBeatmapAvailabilityTracker.cs b/osu.Game.Tests/Online/TestScenePlaylistsBeatmapAvailabilityTracker.cs
@@ -27,6 +27,7 @@
 using osu.Game.Screens.OnlinePlay.Playlists;
 using osu.Game.Tests.Resources;
 using osu.Game.Tests.Visual;
+using Realms;
 
 namespace osu.Game.Tests.Online
 {
@@ -229,6 +230,14 @@ public TestBeatmapImporter(TestBeatmapManager testBeatmapManager, Storage storag
 
                     return testBeatmapManager.CurrentImport = base.ImportModel(item, archive, parameters, cancellationToken);
                 }
+
+                protected override void PostImport(BeatmapSetInfo model, Realm realm, ImportParameters parameters)
+                {
+                    foreach (var beatmap in model.Beatmaps)
+                        beatmap.OnlineMD5Hash = beatmap.MD5Hash;
+
+                    base.PostImport(model, realm, parameters);
+                }
             }
         }
 
diff --git a/osu.Game/Beatmaps/BeatmapManager.cs b/osu.Game/Beatmaps/BeatmapManager.cs
@@ -328,6 +328,14 @@ public List<BeatmapSetInfo> GetAllUsableBeatmapSets()
              .Filter(query, arguments)
              .FirstOrDefault()?.Detach());
 
+        /// <summary>
+        /// Perform a lookup query on available <see cref="BeatmapInfo"/>s for a specific online ID.
+        /// </summary>
+        /// <returns>A matching local beatmap info if existing and in a valid state.</returns>
+        public BeatmapInfo? QueryOnlineBeatmapId(int id) => Realm.Run(r =>
+            r.All<BeatmapInfo>()
+             .ForOnlineId(id).SingleOrDefault()?.Detach());
+
         /// <summary>
         /// A default representation of a WorkingBeatmap to use when no beatmap is available.
         /// </summary>
diff --git a/osu.Game/Database/RealmExtensions.cs b/osu.Game/Database/RealmExtensions.cs
@@ -2,7 +2,9 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using System;
+using System.Linq;
 using osu.Framework.Logging;
+using osu.Game.Beatmaps;
 using Realms;
 
 namespace osu.Game.Database
@@ -102,5 +104,13 @@ public static T Write<T>(this Realm realm, Func<Realm, T> function)
         /// Quite often we only care about changes at a collection level. This can be used to guard and early-return when no such changes are in a callback.
         /// </remarks>
         public static bool HasCollectionChanges(this ChangeSet changes) => changes.InsertedIndices.Length > 0 || changes.DeletedIndices.Length > 0 || changes.Moves.Length > 0;
+
+        public static IQueryable<BeatmapInfo> NotDeleted(this IQueryable<BeatmapInfo> beatmaps) =>
+            beatmaps.Filter($@"{nameof(BeatmapInfo.BeatmapSet)}.{nameof(BeatmapSetInfo.DeletePending)} == false");
+
+        public static IQueryable<BeatmapInfo> ForOnlineId(this IQueryable<BeatmapInfo> beatmaps, int id) =>
+            beatmaps
+                .NotDeleted()
+                .Filter($@"{nameof(BeatmapInfo.OnlineID)} == $0 AND {nameof(BeatmapInfo.MD5Hash)} == {nameof(BeatmapInfo.OnlineMD5Hash)}", id);
     }
 }
diff --git a/osu.Game/Screens/OnlinePlay/DailyChallenge/DailyChallenge.cs b/osu.Game/Screens/OnlinePlay/DailyChallenge/DailyChallenge.cs
@@ -489,7 +489,7 @@ public static void TrySetDailyChallengeBeatmap(OsuScreen screen, BeatmapManager
             if (!screen.IsCurrentScreen())
                 return;
 
-            var beatmap = beatmaps.QueryBeatmap($@"{nameof(BeatmapInfo.OnlineID)} == $0 AND {nameof(BeatmapInfo.MD5Hash)} == {nameof(BeatmapInfo.OnlineMD5Hash)}", item.Beatmap.OnlineID);
+            var beatmap = beatmaps.QueryOnlineBeatmapId(item.Beatmap.OnlineID);
 
             screen.Beatmap.Value = beatmaps.GetWorkingBeatmap(beatmap); // this will gracefully fall back to dummy beatmap if missing locally.
             screen.Ruleset.Value = rulesets.GetRuleset(item.RulesetID);
diff --git a/osu.Game/Screens/OnlinePlay/Matchmaking/Match/ScreenMatchmaking.cs b/osu.Game/Screens/OnlinePlay/Matchmaking/Match/ScreenMatchmaking.cs
@@ -246,7 +246,7 @@ private void updateGameplayState()
 
             // Update global gameplay state to correspond to the new selection.
             // Retrieve the corresponding local beatmap, since we can't directly use the playlist's beatmap info
-            var localBeatmap = beatmapManager.QueryBeatmap($@"{nameof(BeatmapInfo.OnlineID)} == $0 AND {nameof(BeatmapInfo.MD5Hash)} == {nameof(BeatmapInfo.OnlineMD5Hash)}", item.BeatmapID);
+            var localBeatmap = beatmapManager.QueryOnlineBeatmapId(item.BeatmapID);
 
             if (localBeatmap != null)
             {
diff --git a/osu.Game/Screens/OnlinePlay/Multiplayer/MultiplayerMatchSubScreen.cs b/osu.Game/Screens/OnlinePlay/Multiplayer/MultiplayerMatchSubScreen.cs
@@ -510,7 +510,7 @@ private void onActivePlaylistItemChanged()
             {
                 MultiplayerPlaylistItem item = client.Room.CurrentPlaylistItem;
 
-                var newBeatmap = beatmapManager.QueryBeatmap($@"{nameof(BeatmapInfo.OnlineID)} == $0 AND {nameof(BeatmapInfo.MD5Hash)} == {nameof(BeatmapInfo.OnlineMD5Hash)}", item.BeatmapID);
+                var newBeatmap = beatmapManager.QueryOnlineBeatmapId(item.BeatmapID);
 
                 if (!Beatmap.Value.BeatmapSetInfo.Equals(newBeatmap?.BeatmapSet))
                     this.MakeCurrent();
@@ -652,7 +652,7 @@ private void updateGameplayState()
 
             // Update global gameplay state to correspond to the new selection.
             // Retrieve the corresponding local beatmap, since we can't directly use the playlist's beatmap info
-            var localBeatmap = beatmapManager.QueryBeatmap($@"{nameof(BeatmapInfo.OnlineID)} == $0 AND {nameof(BeatmapInfo.MD5Hash)} == {nameof(BeatmapInfo.OnlineMD5Hash)}", gameplayBeatmapId);
+            var localBeatmap = beatmapManager.QueryOnlineBeatmapId(gameplayBeatmapId);
             Beatmap.Value = beatmapManager.GetWorkingBeatmap(localBeatmap);
             Ruleset.Value = ruleset;
             Mods.Value = client.LocalUser.Mods.Concat(item.RequiredMods).Select(m => m.ToMod(rulesetInstance)).ToArray();
diff --git a/osu.Game/Screens/OnlinePlay/OnlinePlayBeatmapAvailabilityTracker.cs b/osu.Game/Screens/OnlinePlay/OnlinePlayBeatmapAvailabilityTracker.cs
@@ -17,7 +17,6 @@
 using osu.Game.Online;
 using osu.Game.Online.API.Requests.Responses;
 using osu.Game.Online.Rooms;
-using Realms;
 
 namespace osu.Game.Screens.OnlinePlay
 {
@@ -154,7 +153,8 @@ void updateAvailability()
             }
 
             IQueryable<BeatmapInfo> queryBeatmap() =>
-                realm.Realm.All<BeatmapInfo>().Filter("OnlineID == $0 && MD5Hash == $1 && BeatmapSet.DeletePending == false", beatmap.OnlineID, beatmap.MD5Hash);
+                realm.Realm.All<BeatmapInfo>()
+                     .ForOnlineId(beatmap.OnlineID);
         }
 
         protected override void Dispose(bool isDisposing)
diff --git a/osu.Game/Screens/OnlinePlay/Playlists/PlaylistItemResultsScreen.cs b/osu.Game/Screens/OnlinePlay/Playlists/PlaylistItemResultsScreen.cs
@@ -62,8 +62,7 @@ protected PlaylistItemResultsScreen(ScoreInfo? score, long roomId, PlaylistItem
         [BackgroundDependencyLoader]
         private void load()
         {
-            var localBeatmap = beatmapManager.QueryBeatmap($@"{nameof(BeatmapInfo.OnlineID)} == $0 AND {nameof(BeatmapInfo.MD5Hash)} == {nameof(BeatmapInfo.OnlineMD5Hash)}",
-                PlaylistItem.Beatmap.OnlineID);
+            var localBeatmap = beatmapManager.QueryOnlineBeatmapId(PlaylistItem.Beatmap.OnlineID);
             itemBeatmap = beatmapManager.GetWorkingBeatmap(localBeatmap);
 
             AddInternal(new Container
diff --git a/osu.Game/Screens/OnlinePlay/Playlists/PlaylistsRoomSubScreen.cs b/osu.Game/Screens/OnlinePlay/Playlists/PlaylistsRoomSubScreen.cs
@@ -609,7 +609,7 @@ private void updateGameplayState()
 
             // Update global gameplay state to correspond to the new selection.
             // Retrieve the corresponding local beatmap, since we can't directly use the playlist's beatmap info
-            var localBeatmap = beatmapManager.QueryBeatmap($@"{nameof(BeatmapInfo.OnlineID)} == $0 AND {nameof(BeatmapInfo.MD5Hash)} == {nameof(BeatmapInfo.OnlineMD5Hash)}", gameplayBeatmap.OnlineID);
+            var localBeatmap = beatmapManager.QueryOnlineBeatmapId(gameplayBeatmap.OnlineID);
             Beatmap.Value = beatmapManager.GetWorkingBeatmap(localBeatmap);
             Ruleset.Value = gameplayRuleset;
             Mods.Value = UserMods.Value.Concat(item.RequiredMods.Select(m => m.ToMod(rulesetInstance))).ToArray();

Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,7 @@`
`27`	`27`	`using osu.Game.Screens.OnlinePlay.Playlists;`
`28`	`28`	`using osu.Game.Tests.Resources;`
`29`	`29`	`using osu.Game.Tests.Visual;`
	`30`	`+using Realms;`
`30`	`31`
`31`	`32`	`namespace osu.Game.Tests.Online`
`32`	`33`	`{`
`@@ -229,6 +230,14 @@ public TestBeatmapImporter(TestBeatmapManager testBeatmapManager, Storage storag`
`229`	`230`
`230`	`231`	`return testBeatmapManager.CurrentImport = base.ImportModel(item, archive, parameters, cancellationToken);`
`231`	`232`	`}`
	`233`	`+`
	`234`	`+ protected override void PostImport(BeatmapSetInfo model, Realm realm, ImportParameters parameters)`
	`235`	`+ {`
	`236`	`+ foreach (var beatmap in model.Beatmaps)`
	`237`	`+ beatmap.OnlineMD5Hash = beatmap.MD5Hash;`
	`238`	`+`
	`239`	`+ base.PostImport(model, realm, parameters);`
	`240`	`+ }`
`232`	`241`	`}`
`233`	`242`	`}`
`234`	`243`
Original file line number	Diff line number	Diff line change
`@@ -246,7 +246,7 @@ private void updateGameplayState()`
`246`	`246`
`247`	`247`	`// Update global gameplay state to correspond to the new selection.`
`248`	`248`	`// Retrieve the corresponding local beatmap, since we can't directly use the playlist's beatmap info`
`249`		`- var localBeatmap = beatmapManager.QueryBeatmap($@"{nameof(BeatmapInfo.OnlineID)} == $0 AND {nameof(BeatmapInfo.MD5Hash)} == {nameof(BeatmapInfo.OnlineMD5Hash)}", item.BeatmapID);`
	`249`	`+ var localBeatmap = beatmapManager.QueryOnlineBeatmapId(item.BeatmapID);`
`250`	`250`
`251`	`251`	`if (localBeatmap != null)`
`252`	`252`	`{`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,6 @@`
`17`	`17`	`using osu.Game.Online;`
`18`	`18`	`using osu.Game.Online.API.Requests.Responses;`
`19`	`19`	`using osu.Game.Online.Rooms;`
`20`		`-using Realms;`
`21`	`20`
`22`	`21`	`namespace osu.Game.Screens.OnlinePlay`
`23`	`22`	`{`
`@@ -154,7 +153,8 @@ void updateAvailability()`
`154`	`153`	`}`
`155`	`154`
`156`	`155`	`IQueryable<BeatmapInfo> queryBeatmap() =>`
`157`		`- realm.Realm.All<BeatmapInfo>().Filter("OnlineID == $0 && MD5Hash == $1 && BeatmapSet.DeletePending == false", beatmap.OnlineID, beatmap.MD5Hash);`
	`156`	`+ realm.Realm.All<BeatmapInfo>()`
	`157`	`+ .ForOnlineId(beatmap.OnlineID);`
`158`	`158`	`}`
`159`	`159`
`160`	`160`	`protected override void Dispose(bool isDisposing)`
Original file line number	Diff line number	Diff line change
`@@ -62,8 +62,7 @@ protected PlaylistItemResultsScreen(ScoreInfo? score, long roomId, PlaylistItem`
`62`	`62`	`[BackgroundDependencyLoader]`
`63`	`63`	`private void load()`
`64`	`64`	`{`
`65`		`- var localBeatmap = beatmapManager.QueryBeatmap($@"{nameof(BeatmapInfo.OnlineID)} == $0 AND {nameof(BeatmapInfo.MD5Hash)} == {nameof(BeatmapInfo.OnlineMD5Hash)}",`
`66`		`- PlaylistItem.Beatmap.OnlineID);`
	`65`	`+ var localBeatmap = beatmapManager.QueryOnlineBeatmapId(PlaylistItem.Beatmap.OnlineID);`
`67`	`66`	`itemBeatmap = beatmapManager.GetWorkingBeatmap(localBeatmap);`
`68`	`67`
`69`	`68`	`AddInternal(new Container`