// 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.Linq; using System.Threading.Tasks; using JetBrains.Annotations; using osu.Framework.Allocation; using osu.Framework.Logging; using osu.Framework.Screens; using osu.Game.Online.API; using osu.Game.Online.Rooms; using osu.Game.Rulesets.Scoring; using osu.Game.Scoring; namespace osu.Game.Screens.Play { /// /// A player instance which supports submitting scores to an online store. /// public abstract class SubmittingPlayer : Player { /// /// The token to be used for the current submission. This is fetched via a request created by . /// private long? token; [Resolved] private IAPIProvider api { get; set; } private TaskCompletionSource scoreSubmissionSource; protected SubmittingPlayer(PlayerConfiguration configuration = null) : base(configuration) { } protected override void LoadAsyncComplete() { base.LoadAsyncComplete(); handleTokenRetrieval(); } private bool handleTokenRetrieval() { // Token request construction should happen post-load to allow derived classes to potentially prepare DI backings that are used to create the request. var tcs = new TaskCompletionSource(); if (Mods.Value.Any(m => !m.UserPlayable)) { handleTokenFailure(new InvalidOperationException("Non-user playable mod selected.")); return false; } if (!api.IsLoggedIn) { handleTokenFailure(new InvalidOperationException("API is not online.")); return false; } var req = CreateTokenRequest(); if (req == null) { handleTokenFailure(new InvalidOperationException("Request could not be constructed.")); return false; } req.Success += r => { token = r.ID; tcs.SetResult(true); }; req.Failure += handleTokenFailure; api.Queue(req); tcs.Task.Wait(); return true; void handleTokenFailure(Exception exception) { if (HandleTokenRetrievalFailure(exception)) { if (string.IsNullOrEmpty(exception.Message)) Logger.Error(exception, "Failed to retrieve a score submission token."); else Logger.Log($"You are not able to submit a score: {exception.Message}", level: LogLevel.Important); Schedule(() => { ValidForResume = false; this.Exit(); }); } tcs.SetResult(false); } } /// /// Called when a token could not be retrieved for submission. /// /// The error causing the failure. /// Whether gameplay should be immediately exited as a result. Returning false allows the gameplay session to continue. Defaults to true. protected virtual bool HandleTokenRetrievalFailure(Exception exception) => true; protected override async Task PrepareScoreForResultsAsync(Score score) { await base.PrepareScoreForResultsAsync(score).ConfigureAwait(false); await submitScore(score).ConfigureAwait(false); } public override bool OnExiting(IScreen next) { var exiting = base.OnExiting(next); submitScore(Score); return exiting; } /// /// Construct a request to be used for retrieval of the score token. /// Can return null, at which point will be fired. /// [CanBeNull] protected abstract APIRequest CreateTokenRequest(); /// /// Construct a request to submit the score. /// Will only be invoked if the request constructed via was successful. /// /// The score to be submitted. /// The submission token. protected abstract APIRequest CreateSubmissionRequest(Score score, long token); private Task submitScore(Score score) { // token may be null if the request failed but gameplay was still allowed (see HandleTokenRetrievalFailure). if (token == null) return Task.CompletedTask; if (scoreSubmissionSource != null) return scoreSubmissionSource.Task; // if the user never hit anything, this score should not be counted in any way. if (!score.ScoreInfo.Statistics.Any(s => s.Key.IsHit() && s.Value > 0)) return Task.CompletedTask; scoreSubmissionSource = new TaskCompletionSource(); var request = CreateSubmissionRequest(score, token.Value); request.Success += s => { score.ScoreInfo.OnlineScoreID = s.ID; scoreSubmissionSource.SetResult(true); }; request.Failure += e => { Logger.Error(e, "Failed to submit score"); scoreSubmissionSource.SetResult(false); }; api.Queue(request); return scoreSubmissionSource.Task; } } }