h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2025-01-28 07:23:14 +08:00
Code Issues Releases Wiki Activity

Introduce Pagination and simplify paginated API requests

Browse Source
This commit is contained in:
Salman Ahmed 2022-04-19 02:04:23 +03:00
parent f08449e432
commit 96d4369cc8
13 changed files with 73 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
osu.Game/Online/API/Requests/GetUserBeatmapsRequest.cs
View File

@ -13,8 +13,8 @@ namespace osu.Game.Online.API.Requests
private readonly BeatmapSetType type;
public GetUserBeatmapsRequest(long userId, BeatmapSetType type, int page, int itemsPerPage, int initialItems)
: base(page, itemsPerPage, initialItems)
public GetUserBeatmapsRequest(long userId, BeatmapSetType type, Pagination pagination)
: base(pagination)
{
this.userId = userId;
this.type = type;

4
osu.Game/Online/API/Requests/GetUserKudosuHistoryRequest.cs
View File

@ -10,8 +10,8 @@ namespace osu.Game.Online.API.Requests
{
private readonly long userId;
public GetUserKudosuHistoryRequest(long userId, int page, int itemsPerPage, int initialItems)
: base(page, itemsPerPage, initialItems)
public GetUserKudosuHistoryRequest(long userId, Pagination pagination)
: base(pagination)
{
this.userId = userId;
}

4
osu.Game/Online/API/Requests/GetUserMostPlayedBeatmapsRequest.cs
View File

@ -10,8 +10,8 @@ namespace osu.Game.Online.API.Requests
{
private readonly long userId;
public GetUserMostPlayedBeatmapsRequest(long userId, int page, int itemsPerPage, int initialItems)
: base(page, itemsPerPage, initialItems)
public GetUserMostPlayedBeatmapsRequest(long userId, Pagination pagination)
: base(pagination)
{
this.userId = userId;
}

4
osu.Game/Online/API/Requests/GetUserRecentActivitiesRequest.cs
View File

@ -10,8 +10,8 @@ namespace osu.Game.Online.API.Requests
{
private readonly long userId;
public GetUserRecentActivitiesRequest(long userId, int page, int itemsPerPage, int initialItems)
: base(page, itemsPerPage, initialItems)
public GetUserRecentActivitiesRequest(long userId, Pagination pagination)
: base(pagination)
{
this.userId = userId;
}

4
osu.Game/Online/API/Requests/GetUserScoresRequest.cs
View File

@ -14,8 +14,8 @@ namespace osu.Game.Online.API.Requests
private readonly ScoreType type;
private readonly RulesetInfo ruleset;
public GetUserScoresRequest(long userId, ScoreType type, int page, int itemsPerPage, int initialItems, RulesetInfo ruleset = null)
: base(page, itemsPerPage, initialItems)
public GetUserScoresRequest(long userId, ScoreType type, Pagination pagination, RulesetInfo ruleset = null)
: base(pagination)
{
this.userId = userId;
this.type = type;

19
osu.Game/Online/API/Requests/PaginatedAPIRequest.cs
View File

@ -8,28 +8,19 @@ namespace osu.Game.Online.API.Requests
{
public abstract class PaginatedAPIRequest<T> : APIRequest<T> where T : class
{
private readonly int page;
private readonly int initialItems;
private readonly int itemsPerPage;
private readonly Pagination pagination;
protected PaginatedAPIRequest(int page, int itemsPerPage, int initialItems)
protected PaginatedAPIRequest(Pagination pagination)
{
this.page = page;
this.initialItems = initialItems;
this.itemsPerPage = itemsPerPage;
this.pagination = pagination;
}
protected override WebRequest CreateWebRequest()
{
var req = base.CreateWebRequest();
if (page == 0)
req.AddParameter("limit", initialItems.ToString(CultureInfo.InvariantCulture));
else
{
req.AddParameter("offset", (initialItems + (page - 1) * itemsPerPage).ToString(CultureInfo.InvariantCulture));
req.AddParameter("limit", itemsPerPage.ToString(CultureInfo.InvariantCulture));
}
req.AddParameter("offset", pagination.Offset.ToString(CultureInfo.InvariantCulture));
req.AddParameter("limit", pagination.Limit.ToString(CultureInfo.InvariantCulture));
return req;
}

38
osu.Game/Online/API/Requests/Pagination.cs Normal file
View File

@ -0,0 +1,38 @@
// 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.
namespace osu.Game.Online.API.Requests
{
/// <summary>
/// Represents a pagination data used for <see cref="PaginatedAPIRequest{T}"/>.
/// </summary>
public readonly struct Pagination
{
/// <summary>
/// The starting point of the request.
/// </summary>
public int Offset { get; }
/// <summary>
/// The maximum number of items to return in this request.
/// </summary>
public int Limit { get; }
public Pagination(int offset, int limit)
{
Offset = offset;
Limit = limit;
}
public Pagination(int limit)
: this(0, limit)
{
}
/// <summary>
/// Returns a <see cref="Pagination"/> of the next number of items defined by <paramref name="limit"/> after this.
/// </summary>
/// <param name="limit">The limit of the next pagination.</param>
public Pagination TakeNext(int limit) => new Pagination(Offset + Limit, limit);
}
}

4
osu.Game/Overlays/Profile/Sections/Beatmaps/PaginatedBeatmapContainer.cs
View File

@ -58,8 +58,8 @@ namespace osu.Game.Overlays.Profile.Sections.Beatmaps
}
}
protected override APIRequest<List<APIBeatmapSet>> CreateRequest(int itemsPerPage, int initialItems) =>
new GetUserBeatmapsRequest(User.Value.Id, type, VisiblePages++, itemsPerPage, initialItems);
protected override APIRequest<List<APIBeatmapSet>> CreateRequest(Pagination pagination) =>
new GetUserBeatmapsRequest(User.Value.Id, type, pagination);
protected override Drawable CreateDrawableItem(APIBeatmapSet model) => model.OnlineID > 0
? new BeatmapCardNormal(model)

4
osu.Game/Overlays/Profile/Sections/Historical/PaginatedMostPlayedBeatmapContainer.cs
View File

@ -29,8 +29,8 @@ namespace osu.Game.Overlays.Profile.Sections.Historical
protected override int GetCount(APIUser user) => user.BeatmapPlayCountsCount;
protected override APIRequest<List<APIUserMostPlayedBeatmap>> CreateRequest(int itemsPerPage, int initialItems) =>
new GetUserMostPlayedBeatmapsRequest(User.Value.Id, VisiblePages++, itemsPerPage, initialItems);
protected override APIRequest<List<APIUserMostPlayedBeatmap>> CreateRequest(Pagination pagination) =>
new GetUserMostPlayedBeatmapsRequest(User.Value.Id, pagination);
protected override Drawable CreateDrawableItem(APIUserMostPlayedBeatmap mostPlayed) =>
new DrawableMostPlayedBeatmap(mostPlayed);

4
osu.Game/Overlays/Profile/Sections/Kudosu/PaginatedKudosuHistoryContainer.cs
View File

@ -19,8 +19,8 @@ namespace osu.Game.Overlays.Profile.Sections.Kudosu
{
}
protected override APIRequest<List<APIKudosuHistory>> CreateRequest(int itemsPerPage, int initialItems)
=> new GetUserKudosuHistoryRequest(User.Value.Id, VisiblePages++, itemsPerPage, initialItems);
protected override APIRequest<List<APIKudosuHistory>> CreateRequest(Pagination pagination)
=> new GetUserKudosuHistoryRequest(User.Value.Id, pagination);
protected override Drawable CreateDrawableItem(APIKudosuHistory item) => new DrawableKudosuHistoryItem(item);
}

16
osu.Game/Overlays/Profile/Sections/PaginatedProfileSubsection.cs
View File

@ -14,6 +14,7 @@ using osu.Game.Graphics.Sprites;
using osu.Game.Graphics.UserInterface;
using osu.Game.Online.API;
using osu.Game.Graphics.Containers;
using osu.Game.Online.API.Requests;
using osu.Game.Online.API.Requests.Responses;
using osuTK;
@ -34,7 +35,7 @@ namespace osu.Game.Overlays.Profile.Sections
[Resolved]
private IAPIProvider api { get; set; }
protected int VisiblePages;
protected Pagination? CurrentPage { get; private set; }
protected ReverseChildIDFillFlowContainer<Drawable> ItemsContainer { get; private set; }
@ -96,7 +97,7 @@ namespace osu.Game.Overlays.Profile.Sections
loadCancellation?.Cancel();
retrievalRequest?.Cancel();
VisiblePages = 0;
CurrentPage = null;
ItemsContainer.Clear();
if (e.NewValue != null)
@ -110,7 +111,9 @@ namespace osu.Game.Overlays.Profile.Sections
{
loadCancellation = new CancellationTokenSource();
retrievalRequest = CreateRequest(ItemsPerPage, InitialItemsCount);
CurrentPage = CurrentPage?.TakeNext(ItemsPerPage) ?? new Pagination(InitialItemsCount);
retrievalRequest = CreateRequest(CurrentPage.Value);
retrievalRequest.Success += UpdateItems;
api.Queue(retrievalRequest);
@ -120,7 +123,7 @@ namespace osu.Game.Overlays.Profile.Sections
{
OnItemsReceived(items);
if (!items.Any() && VisiblePages == 1)
if (!items.Any() && CurrentPage?.Offset == 0)
{
moreButton.Hide();
moreButton.IsLoading = false;
@ -135,8 +138,7 @@ namespace osu.Game.Overlays.Profile.Sections
{
missing.Hide();
int maxCount = VisiblePages == 1 ? InitialItemsCount : ItemsPerPage;
moreButton.FadeTo(items.Count == maxCount ? 1 : 0);
moreButton.FadeTo(items.Count == CurrentPage?.Limit ? 1 : 0);
moreButton.IsLoading = false;
ItemsContainer.AddRange(drawables);
@ -149,7 +151,7 @@ namespace osu.Game.Overlays.Profile.Sections
{
}
protected abstract APIRequest<List<TModel>> CreateRequest(int itemsPerPage, int initialItems);
protected abstract APIRequest<List<TModel>> CreateRequest(Pagination pagination);
protected abstract Drawable CreateDrawableItem(TModel model);

6
osu.Game/Overlays/Profile/Sections/Ranks/PaginatedScoreContainer.cs
View File

@ -54,14 +54,14 @@ namespace osu.Game.Overlays.Profile.Sections.Ranks
protected override void OnItemsReceived(List<APIScore> items)
{
if (VisiblePages == 0)
if (CurrentPage == null || CurrentPage?.Offset == 0)
drawableItemIndex = 0;
base.OnItemsReceived(items);
}
protected override APIRequest<List<APIScore>> CreateRequest(int itemsPerPage, int initialItems) =>
new GetUserScoresRequest(User.Value.Id, type, VisiblePages++, itemsPerPage, initialItems);
protected override APIRequest<List<APIScore>> CreateRequest(Pagination pagination) =>
new GetUserScoresRequest(User.Value.Id, type, pagination);
private int drawableItemIndex;

4
osu.Game/Overlays/Profile/Sections/Recent/PaginatedRecentActivityContainer.cs
View File

@ -27,8 +27,8 @@ namespace osu.Game.Overlays.Profile.Sections.Recent
ItemsContainer.Spacing = new Vector2(0, 8);
}
protected override APIRequest<List<APIRecentActivity>> CreateRequest(int itemsPerPage, int initialItems) =>
new GetUserRecentActivitiesRequest(User.Value.Id, VisiblePages++, itemsPerPage, initialItems);
protected override APIRequest<List<APIRecentActivity>> CreateRequest(Pagination pagination) =>
new GetUserRecentActivitiesRequest(User.Value.Id, pagination);
protected override Drawable CreateDrawableItem(APIRecentActivity model) => new DrawableRecentActivity(model);
}