// Copyright (c) ppy Pty Ltd . 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 System.Threading; using osu.Framework.Allocation; using osu.Framework.Bindables; using osu.Framework.Extensions.Color4Extensions; using osu.Framework.Graphics; using osu.Framework.Graphics.Colour; using osu.Framework.Graphics.Containers; using osu.Framework.Graphics.Sprites; using osu.Framework.Threading; using osu.Game.Graphics.Containers; using osu.Game.Graphics.Cursor; using osu.Game.Graphics.UserInterface; using osu.Game.Online.API; using osu.Game.Online.Placeholders; using osuTK; using osuTK.Graphics; namespace osu.Game.Online.Leaderboards { /// /// A leaderboard which displays a scrolling list of top scores, along with a single "user best" /// for the local user. /// /// The scope of the leaderboard (ie. global or local). /// The score model class. public abstract class Leaderboard : CompositeDrawable { private const double fade_duration = 300; private readonly OsuScrollContainer scrollContainer; private readonly Container placeholderContainer; private readonly UserTopScoreContainer topScoreContainer; private FillFlowContainer scrollFlow; private readonly LoadingSpinner loading; private ScheduledDelegate showScoresDelegate; private CancellationTokenSource showScoresCancellationSource; private bool scoresLoadedOnce; private APIRequest getScoresRequest; private ScheduledDelegate getScoresRequestCallback; protected abstract bool IsOnlineScope { get; } [Resolved(CanBeNull = true)] private IAPIProvider api { get; set; } private ScheduledDelegate pendingUpdateScores; private readonly IBindable apiState = new Bindable(); private ICollection scores; public ICollection Scores { get => scores; set { scores = value; scoresLoadedOnce = true; scrollFlow?.FadeOut(fade_duration, Easing.OutQuint).Expire(); scrollFlow = null; showScoresDelegate?.Cancel(); showScoresCancellationSource?.Cancel(); if (scores == null || !scores.Any()) { loading.Hide(); return; } // ensure placeholder is hidden when displaying scores PlaceholderState = PlaceholderState.Successful; var scoreFlow = CreateScoreFlow(); scoreFlow.ChildrenEnumerable = scores.Select((s, index) => CreateDrawableScore(s, index + 1)); // schedule because we may not be loaded yet (LoadComponentAsync complains). showScoresDelegate = Schedule(() => LoadComponentAsync(scoreFlow, _ => { scrollContainer.Add(scrollFlow = scoreFlow); int i = 0; foreach (var s in scrollFlow.Children) { using (s.BeginDelayedSequence(i++ * 50)) s.Show(); } scrollContainer.ScrollTo(0f, false); loading.Hide(); }, (showScoresCancellationSource = new CancellationTokenSource()).Token)); } } public TScoreInfo TopScore { get => topScoreContainer.Score.Value; set { topScoreContainer.Score.Value = value; if (value == null) topScoreContainer.Hide(); else topScoreContainer.Show(); } } protected virtual FillFlowContainer CreateScoreFlow() => new FillFlowContainer { RelativeSizeAxes = Axes.X, AutoSizeAxes = Axes.Y, Spacing = new Vector2(0f, 5f), Padding = new MarginPadding { Top = 10, Bottom = 5 }, }; private TScope scope; public TScope Scope { get => scope; set { if (EqualityComparer.Default.Equals(value, scope)) return; scope = value; RefetchScores(); } } private PlaceholderState placeholderState; /// /// Update the placeholder visibility. /// Setting this to anything other than PlaceholderState.Successful will cancel all existing retrieval requests and hide scores. /// protected PlaceholderState PlaceholderState { get => placeholderState; set { if (value != PlaceholderState.Successful) { Reset(); } if (value == placeholderState) return; switch (placeholderState = value) { case PlaceholderState.NetworkFailure: replacePlaceholder(new ClickablePlaceholder(@"Couldn't fetch scores!", FontAwesome.Solid.Sync) { Action = RefetchScores }); break; case PlaceholderState.NoneSelected: replacePlaceholder(new MessagePlaceholder(@"Please select a beatmap!")); break; case PlaceholderState.Unavailable: replacePlaceholder(new MessagePlaceholder(@"Leaderboards are not available for this beatmap!")); break; case PlaceholderState.NoScores: replacePlaceholder(new MessagePlaceholder(@"No records yet!")); break; case PlaceholderState.NotLoggedIn: replacePlaceholder(new LoginPlaceholder(@"Please sign in to view online leaderboards!")); break; case PlaceholderState.NotSupporter: replacePlaceholder(new MessagePlaceholder(@"Please invest in an osu!supporter tag to view this leaderboard!")); break; default: replacePlaceholder(null); break; } } } protected Leaderboard() { InternalChildren = new Drawable[] { new OsuContextMenuContainer { RelativeSizeAxes = Axes.Both, Masking = true, Child = new GridContainer { RelativeSizeAxes = Axes.Both, RowDimensions = new[] { new Dimension(), new Dimension(GridSizeMode.AutoSize), }, Content = new[] { new Drawable[] { scrollContainer = new OsuScrollContainer { RelativeSizeAxes = Axes.Both, ScrollbarVisible = false, } }, new Drawable[] { new Container { AutoSizeAxes = Axes.Y, RelativeSizeAxes = Axes.X, Child = topScoreContainer = new UserTopScoreContainer(CreateDrawableTopScore) }, }, }, }, }, loading = new LoadingSpinner(), placeholderContainer = new Container { RelativeSizeAxes = Axes.Both }, }; } protected virtual void Reset() { cancelPendingWork(); Scores = null; } protected override void LoadComplete() { base.LoadComplete(); if (api != null) { apiState.BindTo(api.State); apiState.BindValueChanged(state => { switch (state.NewValue) { case APIState.Online: case APIState.Offline: if (IsOnlineScope) RefetchScores(); break; } }); } RefetchScores(); } public void RefetchScores() => Scheduler.AddOnce(refetchScores); private void refetchScores() { // don't display any scores or placeholder until the first Scores_Set has been called. // this avoids scope changes flickering a "no scores" placeholder before initialisation of song select is finished. if (!scoresLoadedOnce) return; cancelPendingWork(); pendingUpdateScores = Schedule(() => { PlaceholderState = PlaceholderState.Retrieving; loading.Show(); getScoresRequest = FetchScores(scores => getScoresRequestCallback = Schedule(() => { Scores = scores.ToArray(); PlaceholderState = Scores.Any() ? PlaceholderState.Successful : PlaceholderState.NoScores; })); if (getScoresRequest == null) return; getScoresRequest.Failure += e => getScoresRequestCallback = Schedule(() => { if (e is OperationCanceledException) return; PlaceholderState = PlaceholderState.NetworkFailure; }); api?.Queue(getScoresRequest); }); } private void cancelPendingWork() { getScoresRequest?.Cancel(); getScoresRequest = null; getScoresRequestCallback?.Cancel(); getScoresRequestCallback = null; pendingUpdateScores?.Cancel(); pendingUpdateScores = null; } /// /// Performs a fetch/refresh of scores to be displayed. /// /// A callback which should be called when fetching is completed. Scheduling is not required. /// An responsible for the fetch operation. This will be queued and performed automatically. protected abstract APIRequest FetchScores(Action> scoresCallback); private Placeholder currentPlaceholder; private void replacePlaceholder(Placeholder placeholder) { if (placeholder != null && placeholder.Equals(currentPlaceholder)) return; currentPlaceholder?.FadeOut(150, Easing.OutQuint).Expire(); if (placeholder == null) { currentPlaceholder = null; return; } placeholderContainer.Child = placeholder; placeholder.ScaleTo(0.8f).Then().ScaleTo(1, fade_duration * 3, Easing.OutQuint); placeholder.FadeInFromZero(fade_duration, Easing.OutQuint); currentPlaceholder = placeholder; } protected virtual bool FadeBottom => true; protected virtual bool FadeTop => false; protected override void UpdateAfterChildren() { base.UpdateAfterChildren(); float fadeBottom = scrollContainer.Current + scrollContainer.DrawHeight; float fadeTop = scrollContainer.Current + LeaderboardScore.HEIGHT; if (!scrollContainer.IsScrolledToEnd()) fadeBottom -= LeaderboardScore.HEIGHT; if (scrollFlow == null) return; foreach (var c in scrollFlow.Children) { float topY = c.ToSpaceOfOtherDrawable(Vector2.Zero, scrollFlow).Y; float bottomY = topY + LeaderboardScore.HEIGHT; bool requireTopFade = FadeTop && topY <= fadeTop; bool requireBottomFade = FadeBottom && bottomY >= fadeBottom; if (!requireTopFade && !requireBottomFade) c.Colour = Color4.White; else if (topY > fadeBottom + LeaderboardScore.HEIGHT || bottomY < fadeTop - LeaderboardScore.HEIGHT) c.Colour = Color4.Transparent; else { if (bottomY - fadeBottom > 0 && FadeBottom) { c.Colour = ColourInfo.GradientVertical( Color4.White.Opacity(Math.Min(1 - (topY - fadeBottom) / LeaderboardScore.HEIGHT, 1)), Color4.White.Opacity(Math.Min(1 - (bottomY - fadeBottom) / LeaderboardScore.HEIGHT, 1))); } else if (FadeTop) { c.Colour = ColourInfo.GradientVertical( Color4.White.Opacity(Math.Min(1 - (fadeTop - topY) / LeaderboardScore.HEIGHT, 1)), Color4.White.Opacity(Math.Min(1 - (fadeTop - bottomY) / LeaderboardScore.HEIGHT, 1))); } } } } protected abstract LeaderboardScore CreateDrawableScore(TScoreInfo model, int index); protected abstract LeaderboardScore CreateDrawableTopScore(TScoreInfo model); } }