2021-03-23 06:00:02 +00:00
// 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.
2021-03-23 07:41:36 +00:00
using System ;
2021-05-11 02:24:55 +00:00
using System.Linq ;
2021-03-23 06:00:02 +00:00
using System.Threading.Tasks ;
2021-03-24 04:17:13 +00:00
using JetBrains.Annotations ;
2021-03-23 06:00:02 +00:00
using osu.Framework.Allocation ;
using osu.Framework.Logging ;
using osu.Framework.Screens ;
using osu.Game.Online.API ;
using osu.Game.Online.Rooms ;
2021-07-04 06:14:25 +00:00
using osu.Game.Rulesets.Scoring ;
2021-03-23 06:00:02 +00:00
using osu.Game.Scoring ;
namespace osu.Game.Screens.Play
{
2021-03-23 06:33:31 +00:00
/// <summary>
/// A player instance which supports submitting scores to an online store.
/// </summary>
2021-03-23 06:00:02 +00:00
public abstract class SubmittingPlayer : Player
{
2021-03-24 04:02:17 +00:00
/// <summary>
2021-03-24 04:02:37 +00:00
/// The token to be used for the current submission. This is fetched via a request created by <see cref="CreateTokenRequest"/>.
2021-03-24 04:02:17 +00:00
/// </summary>
2021-03-24 04:20:44 +00:00
private long? token ;
2021-03-23 06:00:02 +00:00
[Resolved]
private IAPIProvider api { get ; set ; }
2021-07-01 08:02:33 +00:00
private TaskCompletionSource < bool > scoreSubmissionSource ;
2021-03-23 06:35:06 +00:00
protected SubmittingPlayer ( PlayerConfiguration configuration = null )
2021-03-23 06:00:02 +00:00
: base ( configuration )
{
}
2021-03-23 07:05:40 +00:00
protected override void LoadAsyncComplete ( )
2021-03-25 04:48:41 +00:00
{
base . LoadAsyncComplete ( ) ;
2021-05-11 02:24:35 +00:00
handleTokenRetrieval ( ) ;
2021-03-25 04:48:41 +00:00
}
private bool handleTokenRetrieval ( )
2021-03-23 06:00:02 +00:00
{
2021-03-23 07:05:40 +00:00
// Token request construction should happen post-load to allow derived classes to potentially prepare DI backings that are used to create the request.
2021-03-23 07:41:36 +00:00
var tcs = new TaskCompletionSource < bool > ( ) ;
2021-03-23 06:00:02 +00:00
2021-06-09 05:32:48 +00:00
if ( Mods . Value . Any ( m = > ! m . UserPlayable ) )
2021-05-11 02:24:55 +00:00
{
2021-06-09 05:32:48 +00:00
handleTokenFailure ( new InvalidOperationException ( "Non-user playable mod selected." ) ) ;
2021-05-11 02:24:55 +00:00
return false ;
}
2021-03-23 07:41:36 +00:00
if ( ! api . IsLoggedIn )
2021-03-23 06:00:02 +00:00
{
2021-03-24 04:20:44 +00:00
handleTokenFailure ( new InvalidOperationException ( "API is not online." ) ) ;
2021-03-25 04:48:41 +00:00
return false ;
2021-03-23 07:41:36 +00:00
}
2021-03-23 06:00:02 +00:00
2021-03-24 04:02:37 +00:00
var req = CreateTokenRequest ( ) ;
2021-03-23 06:00:02 +00:00
2021-03-23 07:41:36 +00:00
if ( req = = null )
{
2021-03-24 04:20:44 +00:00
handleTokenFailure ( new InvalidOperationException ( "Request could not be constructed." ) ) ;
2021-03-25 04:48:41 +00:00
return false ;
2021-03-23 07:41:36 +00:00
}
req . Success + = r = >
{
2021-03-24 04:20:44 +00:00
token = r . ID ;
2021-03-23 07:41:36 +00:00
tcs . SetResult ( true ) ;
2021-03-23 06:00:02 +00:00
} ;
2021-03-24 04:20:44 +00:00
req . Failure + = handleTokenFailure ;
2021-03-23 06:00:02 +00:00
api . Queue ( req ) ;
2021-03-23 07:41:36 +00:00
tcs . Task . Wait ( ) ;
2021-03-25 04:48:41 +00:00
return true ;
2021-03-24 04:20:44 +00:00
void handleTokenFailure ( Exception exception )
2021-03-23 07:41:36 +00:00
{
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 ) ;
}
2021-03-23 06:00:02 +00:00
}
2021-03-23 07:41:36 +00:00
/// <summary>
/// Called when a token could not be retrieved for submission.
/// </summary>
/// <param name="exception">The error causing the failure.</param>
/// <returns>Whether gameplay should be immediately exited as a result. Returning false allows the gameplay session to continue. Defaults to true.</returns>
protected virtual bool HandleTokenRetrievalFailure ( Exception exception ) = > true ;
2021-07-01 08:02:33 +00:00
protected override async Task PrepareScoreForResultsAsync ( Score score )
{
await base . PrepareScoreForResultsAsync ( score ) . ConfigureAwait ( false ) ;
await submitScore ( score ) . ConfigureAwait ( false ) ;
}
2021-06-30 11:23:48 +00:00
public override bool OnExiting ( IScreen next )
{
2021-07-01 08:38:28 +00:00
var exiting = base . OnExiting ( next ) ;
2021-07-01 08:02:33 +00:00
submitScore ( Score ) ;
2021-07-01 08:38:28 +00:00
return exiting ;
2021-06-30 11:23:48 +00:00
}
2021-07-01 08:02:33 +00:00
/// <summary>
/// Construct a request to be used for retrieval of the score token.
/// Can return null, at which point <see cref="HandleTokenRetrievalFailure"/> will be fired.
/// </summary>
[CanBeNull]
protected abstract APIRequest < APIScoreToken > CreateTokenRequest ( ) ;
2021-03-23 06:00:02 +00:00
2021-07-01 08:02:33 +00:00
/// <summary>
/// Construct a request to submit the score.
/// Will only be invoked if the request constructed via <see cref="CreateTokenRequest"/> was successful.
/// </summary>
/// <param name="score">The score to be submitted.</param>
/// <param name="token">The submission token.</param>
protected abstract APIRequest < MultiplayerScore > CreateSubmissionRequest ( Score score , long token ) ;
private Task submitScore ( Score score )
{
2021-03-23 07:41:36 +00:00
// token may be null if the request failed but gameplay was still allowed (see HandleTokenRetrievalFailure).
2021-03-24 04:20:44 +00:00
if ( token = = null )
2021-07-01 08:02:33 +00:00
return Task . CompletedTask ;
2021-03-23 06:00:02 +00:00
2021-07-01 08:02:33 +00:00
if ( scoreSubmissionSource ! = null )
return scoreSubmissionSource . Task ;
2021-07-04 06:14:25 +00:00
// if the user never hit anything, this score should not be counted in any way.
2021-07-04 07:41:09 +00:00
if ( ! score . ScoreInfo . Statistics . Any ( s = > s . Key . IsHit ( ) & & s . Value > 0 ) )
2021-07-04 06:14:25 +00:00
return Task . CompletedTask ;
2021-07-01 08:02:33 +00:00
scoreSubmissionSource = new TaskCompletionSource < bool > ( ) ;
2021-03-24 04:20:44 +00:00
var request = CreateSubmissionRequest ( score , token . Value ) ;
2021-03-23 06:00:02 +00:00
request . Success + = s = >
{
2021-05-18 12:17:33 +00:00
score . ScoreInfo . OnlineScoreID = s . ID ;
2021-07-01 08:02:33 +00:00
scoreSubmissionSource . SetResult ( true ) ;
2021-03-23 06:00:02 +00:00
} ;
request . Failure + = e = >
{
Logger . Error ( e , "Failed to submit score" ) ;
2021-07-01 08:02:33 +00:00
scoreSubmissionSource . SetResult ( false ) ;
2021-03-23 06:00:02 +00:00
} ;
api . Queue ( request ) ;
2021-07-01 08:02:33 +00:00
return scoreSubmissionSource . Task ;
2021-03-23 06:00:02 +00:00
}
}
}