Make mods filter on beatmap leaderboards functional (#5253)

Make mods filter on beatmap leaderboards functional

Co-authored-by: Dean Herbert <pe@ppy.sh>

osu.Game/Online/API/Requests/GetScoresRequest.cs

@@ -5,8 +5,10 @@ using System;
 using osu.Game.Beatmaps;
 using osu.Game.Rulesets;
 using osu.Game.Screens.Select.Leaderboards;
-using osu.Framework.IO.Network;
 using osu.Game.Online.API.Requests.Responses;
+using osu.Game.Rulesets.Mods;
+using System.Text;
+using System.Collections.Generic;
 
 namespace osu.Game.Online.API.Requests
 {
@@ -15,8 +17,9 @@ namespace osu.Game.Online.API.Requests
         private readonly BeatmapInfo beatmap;
         private readonly BeatmapLeaderboardScope scope;
         private readonly RulesetInfo ruleset;
+        private readonly IEnumerable<Mod> mods;
 
-        public GetScoresRequest(BeatmapInfo beatmap, RulesetInfo ruleset, BeatmapLeaderboardScope scope = BeatmapLeaderboardScope.Global)
+        public GetScoresRequest(BeatmapInfo beatmap, RulesetInfo ruleset, BeatmapLeaderboardScope scope = BeatmapLeaderboardScope.Global, IEnumerable<Mod> mods = null)
         {
             if (!beatmap.OnlineBeatmapID.HasValue)
                 throw new InvalidOperationException($"Cannot lookup a beatmap's scores without having a populated {nameof(BeatmapInfo.OnlineBeatmapID)}.");
@@ -27,6 +30,7 @@ namespace osu.Game.Online.API.Requests
             this.beatmap = beatmap;
             this.scope = scope;
             this.ruleset = ruleset ?? throw new ArgumentNullException(nameof(ruleset));
+            this.mods = mods ?? Array.Empty<Mod>();
 
             Success += onSuccess;
         }
@@ -40,17 +44,19 @@ namespace osu.Game.Online.API.Requests
             }
         }
 
-        protected override WebRequest CreateWebRequest()
+        protected override string Target => $@"beatmaps/{beatmap.OnlineBeatmapID}/scores{createQueryParameters()}";
+
+        private string createQueryParameters()
         {
-            var req = base.CreateWebRequest();
+            StringBuilder query = new StringBuilder(@"?");
 
-            req.Timeout = 30000;
+            query.Append($@"type={scope.ToString().ToLowerInvariant()}");
-            req.AddParameter(@"type", scope.ToString().ToLowerInvariant());
+            query.Append($@"&mode={ruleset.ShortName}");
-            req.AddParameter(@"mode", ruleset.ShortName);
 
-            return req;
+            foreach (var mod in mods)
-        }
+                query.Append($@"&mods[]={mod.Acronym}");
 
-        protected override string Target => $@"beatmaps/{beatmap.OnlineBeatmapID}/scores";
+            return query.ToString();
+        }
     }
 }

osu.Game/Screens/Select/BeatmapDetailArea.cs

@@ -41,6 +41,8 @@ namespace osu.Game.Screens.Select
                     RelativeSizeAxes = Axes.X,
                     OnFilter = (tab, mods) =>
                     {
+                        Leaderboard.FilterMods = mods;
+
                         switch (tab)
                         {
                             case BeatmapDetailTab.Details:

osu.Game/Screens/Select/Leaderboards/BeatmapLeaderboard.cs

@@ -11,6 +11,7 @@ using osu.Game.Online.API;
 using osu.Game.Online.API.Requests;
 using osu.Game.Online.Leaderboards;
 using osu.Game.Rulesets;
+using osu.Game.Rulesets.Mods;
 using osu.Game.Scoring;
 
 namespace osu.Game.Screens.Select.Leaderboards
@@ -36,12 +37,34 @@ namespace osu.Game.Screens.Select.Leaderboards
             }
         }
 
+        private bool filterMods;
+
+        /// <summary>
+        /// Whether to apply the game's currently selected mods as a filter when retrieving scores.
+        /// </summary>
+        public bool FilterMods
+        {
+            get => filterMods;
+            set
+            {
+                if (value == filterMods)
+                    return;
+
+                filterMods = value;
+
+                UpdateScores();
+            }
+        }
+
         [Resolved]
         private ScoreManager scoreManager { get; set; }
 
         [Resolved]
         private IBindable<RulesetInfo> ruleset { get; set; }
 
+        [Resolved]
+        private IBindable<IReadOnlyList<Mod>> mods { get; set; }
+
         [Resolved]
         private IAPIProvider api { get; set; }
 
@@ -49,16 +72,36 @@ namespace osu.Game.Screens.Select.Leaderboards
         private void load()
         {
             ruleset.ValueChanged += _ => UpdateScores();
+            mods.ValueChanged += _ =>
+            {
+                if (filterMods)
+                    UpdateScores();
+            };
         }
 
         protected override APIRequest FetchScores(Action<IEnumerable<ScoreInfo>> scoresCallback)
         {
             if (Scope == BeatmapLeaderboardScope.Local)
             {
-                Scores = scoreManager
+                var scores = scoreManager
-                         .QueryScores(s => !s.DeletePending && s.Beatmap.ID == Beatmap.ID && s.Ruleset.ID == ruleset.Value.ID)
+                    .QueryScores(s => !s.DeletePending && s.Beatmap.ID == Beatmap.ID && s.Ruleset.ID == ruleset.Value.ID);
-                         .OrderByDescending(s => s.TotalScore).ToArray();
+
+                if (filterMods && !mods.Value.Any())
+                {
+                    // we need to filter out all scores that have any mods to get all local nomod scores
+                    scores = scores.Where(s => !s.Mods.Any());
+                }
+                else if (filterMods)
+                {
+                    // otherwise find all the scores that have *any* of the currently selected mods (similar to how web applies mod filters)
+                    // we're creating and using a string list representation of selected mods so that it can be translated into the DB query itself
+                    var selectedMods = mods.Value.Select(m => m.Acronym);
+                    scores = scores.Where(s => s.Mods.Any(m => selectedMods.Contains(m.Acronym)));
+                }
+
+                Scores = scores.OrderByDescending(s => s.TotalScore).ToArray();
                 PlaceholderState = Scores.Any() ? PlaceholderState.Successful : PlaceholderState.NoScores;
+
                 return null;
             }
 
@@ -74,13 +117,21 @@ namespace osu.Game.Screens.Select.Leaderboards
                 return null;
             }
 
-            if (Scope != BeatmapLeaderboardScope.Global && !api.LocalUser.Value.IsSupporter)
+            if (!api.LocalUser.Value.IsSupporter && (Scope != BeatmapLeaderboardScope.Global || filterMods))
             {
                 PlaceholderState = PlaceholderState.NotSupporter;
                 return null;
             }
 
-            var req = new GetScoresRequest(Beatmap, ruleset.Value ?? Beatmap.Ruleset, Scope);
+            IReadOnlyList<Mod> requestMods = null;
+
+            if (filterMods && !mods.Value.Any())
+                // add nomod for the request
+                requestMods = new Mod[] { new ModNoMod() };
+            else if (filterMods)
+                requestMods = mods.Value;
+
+            var req = new GetScoresRequest(Beatmap, ruleset.Value ?? Beatmap.Ruleset, Scope, requestMods);
 
             req.Success += r => scoresCallback?.Invoke(r.Scores);