Merge pull request #10607 from EVAST9919/beatmap-listing-search-options

Add more search options to Beatmap Listing

osu.Game.Tests/Visual/UserInterface/TestSceneBeatmapListingSearchControl.cs

@@ -1,6 +1,7 @@
 // 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.Linq;
 using NUnit.Framework;
 using osu.Framework.Allocation;
 using osu.Framework.Graphics;
@@ -27,6 +28,9 @@ namespace osu.Game.Tests.Visual.UserInterface
             OsuSpriteText category;
             OsuSpriteText genre;
             OsuSpriteText language;
+            OsuSpriteText extra;
+            OsuSpriteText ranks;
+            OsuSpriteText played;
 
             Add(control = new BeatmapListingSearchControl
             {
@@ -46,6 +50,9 @@ namespace osu.Game.Tests.Visual.UserInterface
                     category = new OsuSpriteText(),
                     genre = new OsuSpriteText(),
                     language = new OsuSpriteText(),
+                    extra = new OsuSpriteText(),
+                    ranks = new OsuSpriteText(),
+                    played = new OsuSpriteText()
                 }
             });
 
@@ -54,6 +61,9 @@ namespace osu.Game.Tests.Visual.UserInterface
             control.Category.BindValueChanged(c => category.Text = $"Category: {c.NewValue}", true);
             control.Genre.BindValueChanged(g => genre.Text = $"Genre: {g.NewValue}", true);
             control.Language.BindValueChanged(l => language.Text = $"Language: {l.NewValue}", true);
+            control.Extra.BindCollectionChanged((u, v) => extra.Text = $"Extra: {(control.Extra.Any() ? string.Join('.', control.Extra.Select(i => i.ToString().ToLowerInvariant())) : "")}", true);
+            control.Ranks.BindCollectionChanged((u, v) => ranks.Text = $"Ranks: {(control.Ranks.Any() ? string.Join('.', control.Ranks.Select(i => i.ToString())) : "")}", true);
+            control.Played.BindValueChanged(p => played.Text = $"Played: {p.NewValue}", true);
         }
 
         [Test]

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

@@ -1,11 +1,15 @@
 // 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.Collections.Generic;
+using System.Linq;
+using JetBrains.Annotations;
 using osu.Framework.IO.Network;
 using osu.Game.Extensions;
 using osu.Game.Overlays;
 using osu.Game.Overlays.BeatmapListing;
 using osu.Game.Rulesets;
+using osu.Game.Scoring;
 
 namespace osu.Game.Online.API.Requests
 {
@@ -21,6 +25,14 @@ namespace osu.Game.Online.API.Requests
 
         public SearchLanguage Language { get; }
 
+        [CanBeNull]
+        public IReadOnlyCollection<SearchExtra> Extra { get; }
+
+        public SearchPlayed Played { get; }
+
+        [CanBeNull]
+        public IReadOnlyCollection<ScoreRank> Ranks { get; }
+
         private readonly string query;
         private readonly RulesetInfo ruleset;
         private readonly Cursor cursor;
@@ -35,7 +47,10 @@ namespace osu.Game.Online.API.Requests
             SortCriteria sortCriteria = SortCriteria.Ranked,
             SortDirection sortDirection = SortDirection.Descending,
             SearchGenre genre = SearchGenre.Any,
-            SearchLanguage language = SearchLanguage.Any)
+            SearchLanguage language = SearchLanguage.Any,
+            IReadOnlyCollection<SearchExtra> extra = null,
+            IReadOnlyCollection<ScoreRank> ranks = null,
+            SearchPlayed played = SearchPlayed.Any)
         {
             this.query = string.IsNullOrEmpty(query) ? string.Empty : System.Uri.EscapeDataString(query);
             this.ruleset = ruleset;
@@ -46,6 +61,9 @@ namespace osu.Game.Online.API.Requests
             SortDirection = sortDirection;
             Genre = genre;
             Language = language;
+            Extra = extra;
+            Ranks = ranks;
+            Played = played;
         }
 
         protected override WebRequest CreateWebRequest()
@@ -66,6 +84,15 @@ namespace osu.Game.Online.API.Requests
 
             req.AddParameter("sort", $"{SortCriteria.ToString().ToLowerInvariant()}_{directionString}");
 
+            if (Extra != null && Extra.Any())
+                req.AddParameter("e", string.Join('.', Extra.Select(e => e.ToString().ToLowerInvariant())));
+
+            if (Ranks != null && Ranks.Any())
+                req.AddParameter("r", string.Join('.', Ranks.Select(r => r.ToString())));
+
+            if (Played != SearchPlayed.Any)
+                req.AddParameter("played", Played.ToString().ToLowerInvariant());
+
             req.AddCursor(cursor);
 
             return req;

osu.Game/Overlays/BeatmapListing/BeatmapListingFilterControl.cs

@@ -130,6 +130,9 @@ namespace osu.Game.Overlays.BeatmapListing
             searchControl.Category.BindValueChanged(_ => queueUpdateSearch());
             searchControl.Genre.BindValueChanged(_ => queueUpdateSearch());
             searchControl.Language.BindValueChanged(_ => queueUpdateSearch());
+            searchControl.Extra.CollectionChanged += (_, __) => queueUpdateSearch();
+            searchControl.Ranks.CollectionChanged += (_, __) => queueUpdateSearch();
+            searchControl.Played.BindValueChanged(_ => queueUpdateSearch());
 
             sortCriteria.BindValueChanged(_ => queueUpdateSearch());
             sortDirection.BindValueChanged(_ => queueUpdateSearch());
@@ -179,7 +182,10 @@ namespace osu.Game.Overlays.BeatmapListing
                 sortControl.Current.Value,
                 sortControl.SortDirection.Value,
                 searchControl.Genre.Value,
-                searchControl.Language.Value);
+                searchControl.Language.Value,
+                searchControl.Extra,
+                searchControl.Ranks,
+                searchControl.Played.Value);
 
             getSetsRequest.Success += response =>
             {

osu.Game/Overlays/BeatmapListing/BeatmapListingSearchControl.cs

@@ -13,6 +13,7 @@ using osu.Game.Graphics.Containers;
 using osu.Game.Graphics.UserInterface;
 using osuTK.Graphics;
 using osu.Game.Rulesets;
+using osu.Game.Scoring;
 
 namespace osu.Game.Overlays.BeatmapListing
 {
@@ -28,6 +29,12 @@ namespace osu.Game.Overlays.BeatmapListing
 
         public Bindable<SearchLanguage> Language => languageFilter.Current;
 
+        public BindableList<SearchExtra> Extra => extraFilter.Current;
+
+        public BindableList<ScoreRank> Ranks => ranksFilter.Current;
+
+        public Bindable<SearchPlayed> Played => playedFilter.Current;
+
         public BeatmapSetInfo BeatmapSet
         {
             set
@@ -48,6 +55,9 @@ namespace osu.Game.Overlays.BeatmapListing
         private readonly BeatmapSearchFilterRow<SearchCategory> categoryFilter;
         private readonly BeatmapSearchFilterRow<SearchGenre> genreFilter;
         private readonly BeatmapSearchFilterRow<SearchLanguage> languageFilter;
+        private readonly BeatmapSearchMultipleSelectionFilterRow<SearchExtra> extraFilter;
+        private readonly BeatmapSearchScoreFilterRow ranksFilter;
+        private readonly BeatmapSearchFilterRow<SearchPlayed> playedFilter;
 
         private readonly Box background;
         private readonly UpdateableBeatmapSetCover beatmapCover;
@@ -105,6 +115,9 @@ namespace osu.Game.Overlays.BeatmapListing
                                     categoryFilter = new BeatmapSearchFilterRow<SearchCategory>(@"Categories"),
                                     genreFilter = new BeatmapSearchFilterRow<SearchGenre>(@"Genre"),
                                     languageFilter = new BeatmapSearchFilterRow<SearchLanguage>(@"Language"),
+                                    extraFilter = new BeatmapSearchMultipleSelectionFilterRow<SearchExtra>(@"Extra"),
+                                    ranksFilter = new BeatmapSearchScoreFilterRow(),
+                                    playedFilter = new BeatmapSearchFilterRow<SearchPlayed>(@"Played")
                                 }
                             }
                         }

osu.Game/Overlays/BeatmapListing/BeatmapSearchFilterRow.cs

@@ -1,20 +1,16 @@
 // 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 JetBrains.Annotations;
 using osu.Framework.Allocation;
 using osu.Framework.Bindables;
-using osu.Framework.Extensions;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Graphics.UserInterface;
-using osu.Framework.Input.Events;
 using osu.Game.Graphics;
 using osu.Game.Graphics.Sprites;
 using osu.Game.Graphics.UserInterface;
 using osuTK;
-using osuTK.Graphics;
 using Humanizer;
 using osu.Game.Utils;
 
@@ -32,6 +28,7 @@ namespace osu.Game.Overlays.BeatmapListing
 
         public BeatmapSearchFilterRow(string headerName)
         {
+            Drawable filter;
             AutoSizeAxes = Axes.Y;
             RelativeSizeAxes = Axes.X;
             AddInternal(new GridContainer
@@ -49,7 +46,7 @@ namespace osu.Game.Overlays.BeatmapListing
                 },
                 Content = new[]
                 {
-                    new Drawable[]
+                    new[]
                     {
                         new OsuSpriteText
                         {
@@ -58,17 +55,17 @@ namespace osu.Game.Overlays.BeatmapListing
                             Font = OsuFont.GetFont(size: 13),
                             Text = headerName.Titleize()
                         },
-                        CreateFilter().With(f =>
+                        filter = CreateFilter()
-                        {
-                            f.Current = current;
-                        })
                     }
                 }
             });
+
+            if (filter is IHasCurrentValue<T> filterWithValue)
+                Current = filterWithValue.Current;
         }
 
         [NotNull]
-        protected virtual BeatmapSearchFilter CreateFilter() => new BeatmapSearchFilter();
+        protected virtual Drawable CreateFilter() => new BeatmapSearchFilter();
 
         protected class BeatmapSearchFilter : TabControl<T>
         {
@@ -97,63 +94,7 @@ namespace osu.Game.Overlays.BeatmapListing
 
             protected override Dropdown<T> CreateDropdown() => new FilterDropdown();
 
-            protected override TabItem<T> CreateTabItem(T value) => new FilterTabItem(value);
+            protected override TabItem<T> CreateTabItem(T value) => new FilterTabItem<T>(value);
-
-            protected class FilterTabItem : TabItem<T>
-            {
-                protected virtual float TextSize => 13;
-
-                [Resolved]
-                private OverlayColourProvider colourProvider { get; set; }
-
-                private readonly OsuSpriteText text;
-
-                public FilterTabItem(T value)
-                    : base(value)
-                {
-                    AutoSizeAxes = Axes.Both;
-                    Anchor = Anchor.BottomLeft;
-                    Origin = Anchor.BottomLeft;
-                    AddRangeInternal(new Drawable[]
-                    {
-                        text = new OsuSpriteText
-                        {
-                            Font = OsuFont.GetFont(size: TextSize, weight: FontWeight.Regular),
-                            Text = (value as Enum)?.GetDescription() ?? value.ToString()
-                        },
-                        new HoverClickSounds()
-                    });
-
-                    Enabled.Value = true;
-                }
-
-                [BackgroundDependencyLoader]
-                private void load()
-                {
-                    updateState();
-                }
-
-                protected override bool OnHover(HoverEvent e)
-                {
-                    base.OnHover(e);
-                    updateState();
-                    return true;
-                }
-
-                protected override void OnHoverLost(HoverLostEvent e)
-                {
-                    base.OnHoverLost(e);
-                    updateState();
-                }
-
-                protected override void OnActivated() => updateState();
-
-                protected override void OnDeactivated() => updateState();
-
-                private void updateState() => text.FadeColour(Active.Value ? Color4.White : getStateColour(), 200, Easing.OutQuint);
-
-                private Color4 getStateColour() => IsHovered ? colourProvider.Light1 : colourProvider.Light3;
-            }
 
             private class FilterDropdown : OsuTabDropdown<T>
             {

osu.Game/Overlays/BeatmapListing/BeatmapSearchMultipleSelectionFilterRow.cs

@@ -0,0 +1,93 @@
+// 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.Allocation;
+using osu.Framework.Bindables;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Input.Events;
+using osuTK;
+
+namespace osu.Game.Overlays.BeatmapListing
+{
+    public class BeatmapSearchMultipleSelectionFilterRow<T> : BeatmapSearchFilterRow<List<T>>
+    {
+        public new readonly BindableList<T> Current = new BindableList<T>();
+
+        private MultipleSelectionFilter filter;
+
+        public BeatmapSearchMultipleSelectionFilterRow(string headerName)
+            : base(headerName)
+        {
+            Current.BindTo(filter.Current);
+        }
+
+        protected sealed override Drawable CreateFilter() => filter = CreateMultipleSelectionFilter();
+
+        /// <summary>
+        /// Creates a filter control that can be used to simultaneously select multiple values of type <typeparamref name="T"/>.
+        /// </summary>
+        protected virtual MultipleSelectionFilter CreateMultipleSelectionFilter() => new MultipleSelectionFilter();
+
+        protected class MultipleSelectionFilter : FillFlowContainer<MultipleSelectionFilterTabItem>
+        {
+            public readonly BindableList<T> Current = new BindableList<T>();
+
+            [BackgroundDependencyLoader]
+            private void load()
+            {
+                Anchor = Anchor.BottomLeft;
+                Origin = Anchor.BottomLeft;
+                RelativeSizeAxes = Axes.X;
+                Height = 15;
+                Spacing = new Vector2(10, 0);
+
+                AddRange(GetValues().Select(CreateTabItem));
+            }
+
+            protected override void LoadComplete()
+            {
+                base.LoadComplete();
+
+                foreach (var item in Children)
+                    item.Active.BindValueChanged(active => toggleItem(item.Value, active.NewValue));
+            }
+
+            /// <summary>
+            /// Returns all values to be displayed in this filter row.
+            /// </summary>
+            protected virtual IEnumerable<T> GetValues() => Enum.GetValues(typeof(T)).Cast<T>();
+
+            /// <summary>
+            /// Creates a <see cref="MultipleSelectionFilterTabItem"/> representing the supplied <paramref name="value"/>.
+            /// </summary>
+            protected virtual MultipleSelectionFilterTabItem CreateTabItem(T value) => new MultipleSelectionFilterTabItem(value);
+
+            private void toggleItem(T value, bool active)
+            {
+                if (active)
+                    Current.Add(value);
+                else
+                    Current.Remove(value);
+            }
+        }
+
+        protected class MultipleSelectionFilterTabItem : FilterTabItem<T>
+        {
+            public MultipleSelectionFilterTabItem(T value)
+                : base(value)
+            {
+            }
+
+            protected override bool OnClick(ClickEvent e)
+            {
+                base.OnClick(e);
+                Active.Toggle();
+                return true;
+            }
+        }
+    }
+}

osu.Game/Overlays/BeatmapListing/BeatmapSearchRulesetFilterRow.cs

@@ -2,6 +2,7 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using osu.Framework.Allocation;
+using osu.Framework.Graphics;
 using osu.Game.Rulesets;
 
 namespace osu.Game.Overlays.BeatmapListing
@@ -13,7 +14,7 @@ namespace osu.Game.Overlays.BeatmapListing
         {
         }
 
-        protected override BeatmapSearchFilter CreateFilter() => new RulesetFilter();
+        protected override Drawable CreateFilter() => new RulesetFilter();
 
         private class RulesetFilter : BeatmapSearchFilter
         {

osu.Game/Overlays/BeatmapListing/BeatmapSearchScoreFilterRow.cs

@@ -0,0 +1,50 @@
+// 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.Collections.Generic;
+using System.Linq;
+using osu.Framework.Extensions;
+using osu.Game.Scoring;
+
+namespace osu.Game.Overlays.BeatmapListing
+{
+    public class BeatmapSearchScoreFilterRow : BeatmapSearchMultipleSelectionFilterRow<ScoreRank>
+    {
+        public BeatmapSearchScoreFilterRow()
+            : base(@"Rank Achieved")
+        {
+        }
+
+        protected override MultipleSelectionFilter CreateMultipleSelectionFilter() => new RankFilter();
+
+        private class RankFilter : MultipleSelectionFilter
+        {
+            protected override MultipleSelectionFilterTabItem CreateTabItem(ScoreRank value) => new RankItem(value);
+
+            protected override IEnumerable<ScoreRank> GetValues() => base.GetValues().Reverse();
+        }
+
+        private class RankItem : MultipleSelectionFilterTabItem
+        {
+            public RankItem(ScoreRank value)
+                : base(value)
+            {
+            }
+
+            protected override string LabelFor(ScoreRank value)
+            {
+                switch (value)
+                {
+                    case ScoreRank.XH:
+                        return @"Silver SS";
+
+                    case ScoreRank.SH:
+                        return @"Silver S";
+
+                    default:
+                        return value.GetDescription();
+                }
+            }
+        }
+    }
+}

osu.Game/Overlays/BeatmapListing/FilterTabItem.cs

@@ -0,0 +1,79 @@
+// 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.Allocation;
+using osu.Framework.Extensions;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.UserInterface;
+using osu.Framework.Input.Events;
+using osu.Game.Graphics;
+using osu.Game.Graphics.Sprites;
+using osu.Game.Graphics.UserInterface;
+using osuTK.Graphics;
+
+namespace osu.Game.Overlays.BeatmapListing
+{
+    public class FilterTabItem<T> : TabItem<T>
+    {
+        [Resolved]
+        private OverlayColourProvider colourProvider { get; set; }
+
+        private OsuSpriteText text;
+
+        public FilterTabItem(T value)
+            : base(value)
+        {
+        }
+
+        [BackgroundDependencyLoader]
+        private void load()
+        {
+            AutoSizeAxes = Axes.Both;
+            Anchor = Anchor.BottomLeft;
+            Origin = Anchor.BottomLeft;
+            AddRangeInternal(new Drawable[]
+            {
+                text = new OsuSpriteText
+                {
+                    Font = OsuFont.GetFont(size: 13, weight: FontWeight.Regular),
+                    Text = LabelFor(Value)
+                },
+                new HoverClickSounds()
+            });
+
+            Enabled.Value = true;
+            updateState();
+        }
+
+        protected override bool OnHover(HoverEvent e)
+        {
+            base.OnHover(e);
+            updateState();
+            return true;
+        }
+
+        protected override void OnHoverLost(HoverLostEvent e)
+        {
+            base.OnHoverLost(e);
+            updateState();
+        }
+
+        protected override void OnActivated() => updateState();
+
+        protected override void OnDeactivated() => updateState();
+
+        /// <summary>
+        /// Returns the label text to be used for the supplied <paramref name="value"/>.
+        /// </summary>
+        protected virtual string LabelFor(T value) => (value as Enum)?.GetDescription() ?? value.ToString();
+
+        private void updateState()
+        {
+            text.FadeColour(IsHovered ? colourProvider.Light1 : getStateColour(), 200, Easing.OutQuint);
+            text.Font = text.Font.With(weight: Active.Value ? FontWeight.SemiBold : FontWeight.Regular);
+        }
+
+        private Color4 getStateColour() => Active.Value ? colourProvider.Content1 : colourProvider.Light2;
+    }
+}

osu.Game/Overlays/BeatmapListing/SearchExtra.cs

@@ -0,0 +1,16 @@
+// 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;
+
+namespace osu.Game.Overlays.BeatmapListing
+{
+    public enum SearchExtra
+    {
+        [Description("Has Video")]
+        Video,
+
+        [Description("Has Storyboard")]
+        Storyboard
+    }
+}

osu.Game/Overlays/BeatmapListing/SearchPlayed.cs

@@ -0,0 +1,12 @@
+// 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.
+
+namespace osu.Game.Overlays.BeatmapListing
+{
+    public enum SearchPlayed
+    {
+        Any,
+        Played,
+        Unplayed
+    }
+}