// 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.Diagnostics; using System.Globalization; using Newtonsoft.Json; using osu.Framework.Extensions.TypeExtensions; using osu.Framework.IO.Network; using osu.Framework.Logging; using osu.Game.Extensions; using osu.Game.Online.API.Requests.Responses; namespace osu.Game.Online.API { /// /// An API request with a well-defined response type. /// /// Type of the response (used for deserialisation). public abstract class APIRequest : APIRequest where T : class { protected override WebRequest CreateWebRequest() => new OsuJsonWebRequest(Uri); /// /// The deserialised response object. May be null if the request or deserialisation failed. /// public T? Response { get; private set; } /// /// Invoked on successful completion of an API request. /// This will be scheduled to the API's internal scheduler (run on update thread automatically). /// public new event APISuccessHandler? Success; protected APIRequest() { base.Success += () => Success?.Invoke(Response!); } protected override void PostProcess() { base.PostProcess(); if (WebRequest != null) { Response = ((OsuJsonWebRequest)WebRequest).ResponseObject; Logger.Log($"{GetType().ReadableName()} finished with response size of {WebRequest.ResponseStream.Length:#,0} bytes", LoggingTarget.Network); } if (Response == null) TriggerFailure(new ArgumentNullException(nameof(Response))); } internal void TriggerSuccess(T result) { if (Response != null) throw new InvalidOperationException("Attempted to trigger success more than once"); Response = result; TriggerSuccess(); } } /// /// AN API request with no specified response type. /// public abstract class APIRequest { protected abstract string Target { get; } protected virtual WebRequest CreateWebRequest() => new OsuWebRequest(Uri); protected virtual string Uri => $@"{API!.APIEndpointUrl}/api/v2/{Target}"; protected IAPIProvider? API; protected WebRequest? WebRequest; /// /// The currently logged in user. Note that this will only be populated during . /// protected APIUser? User { get; private set; } /// /// Invoked on successful completion of an API request. /// This will be scheduled to the API's internal scheduler (run on update thread automatically). /// public event APISuccessHandler? Success; /// /// Invoked on failure to complete an API request. /// This will be scheduled to the API's internal scheduler (run on update thread automatically). /// public event APIFailureHandler? Failure; private readonly object completionStateLock = new object(); /// /// The state of this request, from an outside perspective. /// This is used to ensure correct notification events are fired. /// public APIRequestCompletionState CompletionState { get; private set; } /// /// Should be called before to give API context. /// /// /// This allows scheduling of operations back to the correct thread (which may be required before is called). /// public void AttachAPI(IAPIProvider apiAccess) { if (API != null && API != apiAccess) throw new InvalidOperationException("Attached API cannot be changed after initial set."); API = apiAccess; } public void Perform() { if (API == null) { Fail(new NotSupportedException($"A {nameof(APIAccess)} is required to perform requests.")); return; } User = API.LocalUser.Value; if (isFailing) return; WebRequest = CreateWebRequest(); WebRequest.Failed += Fail; WebRequest.AllowRetryOnTimeout = false; WebRequest.AddHeader(@"Accept-Language", API.Language.ToCultureCode()); WebRequest.AddHeader(@"x-api-version", API.APIVersion.ToString(CultureInfo.InvariantCulture)); if (!string.IsNullOrEmpty(API.AccessToken)) WebRequest.AddHeader(@"Authorization", $@"Bearer {API.AccessToken}"); if (isFailing) return; try { Logger.Log($@"Performing request {this}", LoggingTarget.Network); WebRequest.Perform(); } catch (OperationCanceledException) { // ignore this. internally Perform is running async and the fail state may have changed since // the last check of `isFailing` above. } if (isFailing) return; PostProcess(); if (isFailing) return; TriggerSuccess(); } /// /// Perform any post-processing actions after a successful request. /// protected virtual void PostProcess() { } internal void TriggerSuccess() { Debug.Assert(API != null); lock (completionStateLock) { if (CompletionState != APIRequestCompletionState.Waiting) return; CompletionState = APIRequestCompletionState.Completed; } API.Schedule(() => Success?.Invoke()); } internal void TriggerFailure(Exception e) { Debug.Assert(API != null); lock (completionStateLock) { if (CompletionState != APIRequestCompletionState.Waiting) return; CompletionState = APIRequestCompletionState.Failed; } API.Schedule(() => Failure?.Invoke(e)); } public void Cancel() => Fail(new OperationCanceledException(@"Request cancelled")); public void Fail(Exception e) { lock (completionStateLock) { if (CompletionState != APIRequestCompletionState.Waiting) return; WebRequest?.Abort(); // in the case of a cancellation we don't care about whether there's an error in the response. if (!(e is OperationCanceledException)) { string? responseString = WebRequest?.GetResponseString(); // naive check whether there's an error in the response to avoid unnecessary JSON deserialisation. if (!string.IsNullOrEmpty(responseString) && responseString.Contains(@"""error""")) { try { // attempt to decode a displayable error string. var error = JsonConvert.DeserializeObject(responseString); if (error != null) e = new APIException(error.ErrorMessage, e); } catch { } } } Logger.Log($@"Failing request {this} ({e})", LoggingTarget.Network); TriggerFailure(e); } } /// /// Whether this request is in a failing or failed state. /// private bool isFailing { get { lock (completionStateLock) return CompletionState == APIRequestCompletionState.Failed; } } private class DisplayableError { [JsonProperty("error")] public string ErrorMessage { get; set; } = string.Empty; } } public delegate void APIFailureHandler(Exception e); public delegate void APISuccessHandler(); public delegate void APIProgressHandler(long current, long total); public delegate void APISuccessHandler(T content); }