// Copyright (c) 2007-2018 ppy Pty Ltd . // Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE using System; using osu.Framework.IO.Network; 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 { protected override WebRequest CreateWebRequest() => new JsonWebRequest(Uri); public T Result => ((JsonWebRequest)WebRequest).ResponseObject; protected APIRequest() { base.Success += onSuccess; } private void onSuccess() => Success?.Invoke(Result); /// /// 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; } /// /// AN API request with no specified response type. /// public abstract class APIRequest { /// /// The maximum amount of time before this request will fail. /// public int Timeout = WebRequest.DEFAULT_TIMEOUT; protected virtual string Target => string.Empty; protected virtual WebRequest CreateWebRequest() => new WebRequest(Uri); protected virtual string Uri => $@"{API.Endpoint}/api/v2/{Target}"; private double remainingTime => Math.Max(0, Timeout - (DateTimeOffset.UtcNow - (startTime ?? DateTimeOffset.MinValue)).TotalMilliseconds); public bool ExceededTimeout => remainingTime == 0; private DateTimeOffset? startTime; protected APIAccess API; protected WebRequest WebRequest; /// /// 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 bool cancelled; private Action pendingFailure; public void Perform(APIAccess api) { API = api; if (checkAndProcessFailure()) return; if (startTime == null) startTime = DateTimeOffset.UtcNow; if (remainingTime <= 0) throw new TimeoutException(@"API request timeout hit"); WebRequest = CreateWebRequest(); WebRequest.Failed += Fail; WebRequest.AllowRetryOnTimeout = false; WebRequest.AddHeader("Authorization", $"Bearer {api.AccessToken}"); if (checkAndProcessFailure()) return; if (!WebRequest.Aborted) //could have been aborted by a Cancel() call WebRequest.Perform(); if (checkAndProcessFailure()) return; api.Schedule(delegate { Success?.Invoke(); }); } public void Cancel() => Fail(new OperationCanceledException(@"Request cancelled")); public void Fail(Exception e) { cancelled = true; WebRequest?.Abort(); pendingFailure = () => Failure?.Invoke(e); checkAndProcessFailure(); } /// /// Checked for cancellation or error. Also queues up the Failed event if we can. /// /// Whether we are in a failed or cancelled state. private bool checkAndProcessFailure() { if (API == null || pendingFailure == null) return cancelled; API.Schedule(pendingFailure); pendingFailure = null; return true; } } public delegate void APIFailureHandler(Exception e); public delegate void APISuccessHandler(); public delegate void APIProgressHandler(long current, long total); public delegate void APISuccessHandler(T content); }