Merge pull request #5778 from EVAST9919/kudosu-info

Add kudosu history to UserProfileOverlay

osu.Game.Tests/Visual/Online/TestSceneKudosuHistory.cs

@@ -0,0 +1,246 @@
+// 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.
+
+using osu.Game.Overlays.Profile.Sections.Kudosu;
+using System.Collections.Generic;
+using System;
+using osu.Framework.Graphics.Containers;
+using osu.Game.Graphics;
+using osu.Framework.Allocation;
+using osu.Framework.Graphics.Shapes;
+using osu.Framework.Graphics;
+using osu.Game.Online.API.Requests.Responses;
+using osu.Framework.Extensions.IEnumerableExtensions;
+
+namespace osu.Game.Tests.Visual.Online
+{
+    public class TestSceneKudosuHistory : OsuTestScene
+    {
+        public override IReadOnlyList<Type> RequiredTypes => new[]
+        {
+            typeof(DrawableKudosuHistoryItem),
+        };
+
+        private readonly Box background;
+
+        public TestSceneKudosuHistory()
+        {
+            FillFlowContainer<DrawableKudosuHistoryItem> content;
+
+            AddRange(new Drawable[]
+            {
+                background = new Box
+                {
+                    RelativeSizeAxes = Axes.Both,
+                },
+                content = new FillFlowContainer<DrawableKudosuHistoryItem>
+                {
+                    Anchor = Anchor.Centre,
+                    Origin = Anchor.Centre,
+                    RelativeSizeAxes = Axes.X,
+                    Width = 0.7f,
+                    AutoSizeAxes = Axes.Y,
+                }
+            });
+
+            items.ForEach(t => content.Add(new DrawableKudosuHistoryItem(t)));
+        }
+
+        [BackgroundDependencyLoader]
+        private void load(OsuColour colours)
+        {
+            background.Colour = colours.GreySeafoam;
+        }
+
+        private readonly IEnumerable<APIKudosuHistory> items = new[]
+        {
+            new APIKudosuHistory
+            {
+                Amount = 10,
+                CreatedAt = new DateTimeOffset(new DateTime(2011, 11, 11)),
+                Source = KudosuSource.DenyKudosu,
+                Action = KudosuAction.Reset,
+                Post = new APIKudosuHistory.ModdingPost
+                {
+                    Title = @"Random post 1",
+                    Url = @"https://osu.ppy.sh/b/1234",
+                },
+                Giver = new APIKudosuHistory.KudosuGiver
+                {
+                    Username = @"Username1",
+                    Url = @"https://osu.ppy.sh/u/1234"
+                }
+            },
+            new APIKudosuHistory
+            {
+                Amount = 5,
+                CreatedAt = new DateTimeOffset(new DateTime(2012, 10, 11)),
+                Source = KudosuSource.Forum,
+                Action = KudosuAction.Give,
+                Post = new APIKudosuHistory.ModdingPost
+                {
+                    Title = @"Random post 2",
+                    Url = @"https://osu.ppy.sh/b/1234",
+                },
+                Giver = new APIKudosuHistory.KudosuGiver
+                {
+                    Username = @"Username2",
+                    Url = @"https://osu.ppy.sh/u/1234"
+                }
+            },
+            new APIKudosuHistory
+            {
+                Amount = 8,
+                CreatedAt = new DateTimeOffset(new DateTime(2013, 9, 11)),
+                Source = KudosuSource.Forum,
+                Action = KudosuAction.Reset,
+                Post = new APIKudosuHistory.ModdingPost
+                {
+                    Title = @"Random post 3",
+                    Url = @"https://osu.ppy.sh/b/1234",
+                },
+                Giver = new APIKudosuHistory.KudosuGiver
+                {
+                    Username = @"Username3",
+                    Url = @"https://osu.ppy.sh/u/1234"
+                }
+            },
+            new APIKudosuHistory
+            {
+                Amount = 7,
+                CreatedAt = new DateTimeOffset(new DateTime(2014, 8, 11)),
+                Source = KudosuSource.Forum,
+                Action = KudosuAction.Revoke,
+                Post = new APIKudosuHistory.ModdingPost
+                {
+                    Title = @"Random post 4",
+                    Url = @"https://osu.ppy.sh/b/1234",
+                },
+                Giver = new APIKudosuHistory.KudosuGiver
+                {
+                    Username = @"Username4",
+                    Url = @"https://osu.ppy.sh/u/1234"
+                }
+            },
+            new APIKudosuHistory
+            {
+                Amount = 100,
+                CreatedAt = new DateTimeOffset(new DateTime(2015, 7, 11)),
+                Source = KudosuSource.Vote,
+                Action = KudosuAction.Give,
+                Post = new APIKudosuHistory.ModdingPost
+                {
+                    Title = @"Random post 5",
+                    Url = @"https://osu.ppy.sh/b/1234",
+                },
+                Giver = new APIKudosuHistory.KudosuGiver
+                {
+                    Username = @"Username5",
+                    Url = @"https://osu.ppy.sh/u/1234"
+                }
+            },
+            new APIKudosuHistory
+            {
+                Amount = 20,
+                CreatedAt = new DateTimeOffset(new DateTime(2016, 6, 11)),
+                Source = KudosuSource.Vote,
+                Action = KudosuAction.Reset,
+                Post = new APIKudosuHistory.ModdingPost
+                {
+                    Title = @"Random post 6",
+                    Url = @"https://osu.ppy.sh/b/1234",
+                },
+                Giver = new APIKudosuHistory.KudosuGiver
+                {
+                    Username = @"Username6",
+                    Url = @"https://osu.ppy.sh/u/1234"
+                }
+            },
+            new APIKudosuHistory
+            {
+                Amount = 11,
+                CreatedAt = new DateTimeOffset(new DateTime(2016, 6, 11)),
+                Source = KudosuSource.AllowKudosu,
+                Action = KudosuAction.Give,
+                Post = new APIKudosuHistory.ModdingPost
+                {
+                    Title = @"Random post 7",
+                    Url = @"https://osu.ppy.sh/b/1234",
+                },
+                Giver = new APIKudosuHistory.KudosuGiver
+                {
+                    Username = @"Username7",
+                    Url = @"https://osu.ppy.sh/u/1234"
+                }
+            },
+            new APIKudosuHistory
+            {
+                Amount = 24,
+                CreatedAt = new DateTimeOffset(new DateTime(2014, 6, 11)),
+                Source = KudosuSource.Delete,
+                Action = KudosuAction.Reset,
+                Post = new APIKudosuHistory.ModdingPost
+                {
+                    Title = @"Random post 8",
+                    Url = @"https://osu.ppy.sh/b/1234",
+                },
+                Giver = new APIKudosuHistory.KudosuGiver
+                {
+                    Username = @"Username8",
+                    Url = @"https://osu.ppy.sh/u/1234"
+                }
+            },
+            new APIKudosuHistory
+            {
+                Amount = 12,
+                CreatedAt = new DateTimeOffset(new DateTime(2016, 6, 11)),
+                Source = KudosuSource.Restore,
+                Action = KudosuAction.Give,
+                Post = new APIKudosuHistory.ModdingPost
+                {
+                    Title = @"Random post 9",
+                    Url = @"https://osu.ppy.sh/b/1234",
+                },
+                Giver = new APIKudosuHistory.KudosuGiver
+                {
+                    Username = @"Username9",
+                    Url = @"https://osu.ppy.sh/u/1234"
+                }
+            },
+            new APIKudosuHistory
+            {
+                Amount = 2,
+                CreatedAt = new DateTimeOffset(new DateTime(2012, 6, 11)),
+                Source = KudosuSource.Recalculate,
+                Action = KudosuAction.Give,
+                Post = new APIKudosuHistory.ModdingPost
+                {
+                    Title = @"Random post 10",
+                    Url = @"https://osu.ppy.sh/b/1234",
+                },
+                Giver = new APIKudosuHistory.KudosuGiver
+                {
+                    Username = @"Username10",
+                    Url = @"https://osu.ppy.sh/u/1234"
+                }
+            },
+            new APIKudosuHistory
+            {
+                Amount = 32,
+                CreatedAt = new DateTimeOffset(new DateTime(2019, 8, 11)),
+                Source = KudosuSource.Recalculate,
+                Action = KudosuAction.Reset,
+                Post = new APIKudosuHistory.ModdingPost
+                {
+                    Title = @"Random post 11",
+                    Url = @"https://osu.ppy.sh/b/1234",
+                },
+                Giver = new APIKudosuHistory.KudosuGiver
+                {
+                    Username = @"Username11",
+                    Url = @"https://osu.ppy.sh/u/1234"
+                }
+            }
+        };
+    }
+}

osu.Game/Online/API/Requests/GetUserKudosuHistoryRequest.cs

@@ -0,0 +1,21 @@
+// 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.
+
+using System.Collections.Generic;
+using osu.Game.Online.API.Requests.Responses;
+
+namespace osu.Game.Online.API.Requests
+{
+    public class GetUserKudosuHistoryRequest : PaginatedAPIRequest<List<APIKudosuHistory>>
+    {
+        private readonly long userId;
+
+        public GetUserKudosuHistoryRequest(long userId, int page = 0, int itemsPerPage = 5)
+            : base(page, itemsPerPage)
+        {
+            this.userId = userId;
+        }
+
+        protected override string Target => $"users/{userId}/kudosu";
+    }
+}

osu.Game/Online/API/Requests/Responses/APIKudosuHistory.cs

@@ -0,0 +1,83 @@
+// 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.
+
+using System;
+using System.Linq;
+using Newtonsoft.Json;
+
+namespace osu.Game.Online.API.Requests.Responses
+{
+    public class APIKudosuHistory
+    {
+        [JsonProperty("created_at")]
+        public DateTimeOffset CreatedAt;
+
+        [JsonProperty("amount")]
+        public int Amount;
+
+        [JsonProperty("post")]
+        public ModdingPost Post;
+
+        public class ModdingPost
+        {
+            [JsonProperty("url")]
+            public string Url;
+
+            [JsonProperty("title")]
+            public string Title;
+        }
+
+        [JsonProperty("giver")]
+        public KudosuGiver Giver;
+
+        public class KudosuGiver
+        {
+            [JsonProperty("url")]
+            public string Url;
+
+            [JsonProperty("username")]
+            public string Username;
+        }
+
+        public KudosuSource Source;
+
+        public KudosuAction Action;
+
+        [JsonProperty("action")]
+        private string action
+        {
+            set
+            {
+                // incoming action may contain a prefix. if it doesn't, it's a legacy forum event.
+
+                string[] split = value.Split('.');
+
+                if (split.Length > 1)
+                    Enum.TryParse(split.First().Replace("_", ""), true, out Source);
+                else
+                    Source = KudosuSource.Forum;
+
+                Enum.TryParse(split.Last(), true, out Action);
+            }
+        }
+    }
+
+    public enum KudosuSource
+    {
+        Unknown,
+        AllowKudosu,
+        Delete,
+        DenyKudosu,
+        Forum,
+        Recalculate,
+        Restore,
+        Vote
+    }
+
+    public enum KudosuAction
+    {
+        Give,
+        Reset,
+        Revoke,
+    }
+}

osu.Game/Overlays/Profile/Sections/Kudosu/DrawableKudosuHistoryItem.cs

@@ -0,0 +1,147 @@
+// 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.
+
+using osu.Framework.Allocation;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Game.Graphics;
+using osu.Game.Graphics.Containers;
+using osu.Game.Online.API.Requests.Responses;
+using osu.Game.Online.Chat;
+using System;
+using osuTK;
+
+namespace osu.Game.Overlays.Profile.Sections.Kudosu
+{
+    public class DrawableKudosuHistoryItem : CompositeDrawable
+    {
+        private const int height = 25;
+
+        [Resolved]
+        private OsuColour colours { get; set; }
+
+        private readonly APIKudosuHistory historyItem;
+        private readonly LinkFlowContainer linkFlowContainer;
+        private readonly DrawableDate date;
+
+        public DrawableKudosuHistoryItem(APIKudosuHistory historyItem)
+        {
+            this.historyItem = historyItem;
+
+            Height = height;
+            RelativeSizeAxes = Axes.X;
+            AddRangeInternal(new Drawable[]
+            {
+                linkFlowContainer = new LinkFlowContainer
+                {
+                    Anchor = Anchor.CentreLeft,
+                    Origin = Anchor.CentreLeft,
+                    AutoSizeAxes = Axes.Both,
+                    Spacing = new Vector2(0, 3),
+                },
+                date = new DrawableDate(historyItem.CreatedAt)
+                {
+                    Anchor = Anchor.CentreRight,
+                    Origin = Anchor.CentreRight,
+                }
+            });
+        }
+
+        [BackgroundDependencyLoader]
+        private void load()
+        {
+            date.Colour = colours.GreySeafoamLighter;
+            var formattedSource = MessageFormatter.FormatText(getString(historyItem));
+            linkFlowContainer.AddLinks(formattedSource.Text, formattedSource.Links);
+        }
+
+        private string getString(APIKudosuHistory item)
+        {
+            string amount = $"{Math.Abs(item.Amount)} kudosu";
+            string post = $"[{item.Post.Title}]({item.Post.Url})";
+
+            switch (item.Source)
+            {
+                case KudosuSource.AllowKudosu:
+                    switch (item.Action)
+                    {
+                        case KudosuAction.Give:
+                            return $"Received {amount} from kudosu deny repeal of modding post {post}";
+                    }
+
+                    break;
+
+                case KudosuSource.DenyKudosu:
+                    switch (item.Action)
+                    {
+                        case KudosuAction.Reset:
+                            return $"Denied {amount} from modding post {post}";
+                    }
+
+                    break;
+
+                case KudosuSource.Delete:
+                    switch (item.Action)
+                    {
+                        case KudosuAction.Reset:
+                            return $"Lost {amount} from modding post deletion of {post}";
+                    }
+
+                    break;
+
+                case KudosuSource.Restore:
+                    switch (item.Action)
+                    {
+                        case KudosuAction.Give:
+                            return $"Received {amount} from modding post restoration of {post}";
+                    }
+
+                    break;
+
+                case KudosuSource.Vote:
+                    switch (item.Action)
+                    {
+                        case KudosuAction.Give:
+                            return $"Received {amount} from obtaining votes in modding post of {post}";
+
+                        case KudosuAction.Reset:
+                            return $"Lost {amount} from losing votes in modding post of {post}";
+                    }
+
+                    break;
+
+                case KudosuSource.Recalculate:
+                    switch (item.Action)
+                    {
+                        case KudosuAction.Give:
+                            return $"Received {amount} from votes recalculation in modding post of {post}";
+
+                        case KudosuAction.Reset:
+                            return $"Lost {amount} from votes recalculation in modding post of {post}";
+                    }
+
+                    break;
+
+                case KudosuSource.Forum:
+
+                    string giver = $"[{item.Giver?.Username}]({item.Giver?.Url})";
+
+                    switch (historyItem.Action)
+                    {
+                        case KudosuAction.Give:
+                            return $"Received {amount} from {giver} for a post at {post}";
+
+                        case KudosuAction.Reset:
+                            return $"Kudosu reset by {giver} for the post {post}";
+
+                        case KudosuAction.Revoke:
+                            return $"Denied kudosu by {giver} for the post {post}";
+                    }
+
+                    break;
+            }
+
+            return $"Unknown event ({amount} change)";
+        }
+    }
+}

osu.Game/Overlays/Profile/Sections/Kudosu/PaginatedKudosuHistoryContainer.cs

@@ -0,0 +1,27 @@
+// 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.
+
+using osu.Framework.Graphics;
+using osu.Game.Online.API.Requests;
+using osu.Game.Users;
+using osu.Framework.Bindables;
+using osu.Game.Online.API.Requests.Responses;
+using osu.Game.Online.API;
+using System.Collections.Generic;
+
+namespace osu.Game.Overlays.Profile.Sections.Kudosu
+{
+    public class PaginatedKudosuHistoryContainer : PaginatedContainer<APIKudosuHistory>
+    {
+        public PaginatedKudosuHistoryContainer(Bindable<User> user, string header, string missing)
+            : base(user, header, missing)
+        {
+            ItemsPerPage = 5;
+        }
+
+        protected override APIRequest<List<APIKudosuHistory>> CreateRequest()
+            => new GetUserKudosuHistoryRequest(User.Value.Id, VisiblePages++, ItemsPerPage);
+
+        protected override Drawable CreateDrawableItem(APIKudosuHistory item) => new DrawableKudosuHistoryItem(item);
+    }
+}

osu.Game/Overlays/Profile/Sections/KudosuSection.cs

@@ -1,6 +1,7 @@
 // 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.
 
+using osu.Framework.Graphics;
 using osu.Game.Overlays.Profile.Sections.Kudosu;
 
 namespace osu.Game.Overlays.Profile.Sections
@@ -13,9 +14,10 @@ namespace osu.Game.Overlays.Profile.Sections
 
         public KudosuSection()
         {
-            Children = new[]
+            Children = new Drawable[]
             {
                 new KudosuInfo(User),
+                new PaginatedKudosuHistoryContainer(User, null, @"This user hasn't received any kudosu!"),
             };
         }
     }