From f27ce7521d69295e7af78478118e436db6f400ba Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Max=20H=C3=BCbner?= <maxshuebner@gmail.com>
Date: Fri, 30 Oct 2020 10:27:43 +0100
Subject: [PATCH] Make "Sometimes" setting depend on season end date, rather
 than chance

---
 osu.Game/Configuration/SessionStatics.cs                  | 5 ++++-
 osu.Game/Graphics/Backgrounds/SeasonalBackgroundLoader.cs | 8 ++++++++
 .../API/Requests/Responses/APISeasonalBackgrounds.cs      | 4 ++++
 osu.Game/Screens/Backgrounds/BackgroundScreenDefault.cs   | 2 +-
 4 files changed, 17 insertions(+), 2 deletions(-)

diff --git a/osu.Game/Configuration/SessionStatics.cs b/osu.Game/Configuration/SessionStatics.cs
index 326abed8fe..8100e0fb12 100644
--- a/osu.Game/Configuration/SessionStatics.cs
+++ b/osu.Game/Configuration/SessionStatics.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 System;
 using System.Collections.Generic;
 using osu.Game.Online.API.Requests.Responses;
 
@@ -15,6 +16,7 @@ protected override void InitialiseDefaults()
         {
             Set(Static.LoginOverlayDisplayed, false);
             Set(Static.MutedAudioNotificationShownOnce, false);
+            Set(Static.SeasonEndDate, DateTimeOffset.MinValue);
             Set(Static.SeasonalBackgrounds, new List<APISeasonalBackground>());
         }
     }
@@ -23,6 +25,7 @@ public enum Static
     {
         LoginOverlayDisplayed,
         MutedAudioNotificationShownOnce,
-        SeasonalBackgrounds
+        SeasonEndDate,
+        SeasonalBackgrounds,
     }
 }
diff --git a/osu.Game/Graphics/Backgrounds/SeasonalBackgroundLoader.cs b/osu.Game/Graphics/Backgrounds/SeasonalBackgroundLoader.cs
index abd9664106..d806c62650 100644
--- a/osu.Game/Graphics/Backgrounds/SeasonalBackgroundLoader.cs
+++ b/osu.Game/Graphics/Backgrounds/SeasonalBackgroundLoader.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 System;
 using System.Collections.Generic;
 using System.Linq;
 using osu.Framework.Allocation;
@@ -18,19 +19,24 @@ namespace osu.Game.Graphics.Backgrounds
     [LongRunningLoad]
     public class SeasonalBackgroundLoader : Component
     {
+        private Bindable<DateTimeOffset> endDate;
         private Bindable<List<APISeasonalBackground>> backgrounds;
         private int current;
 
         [BackgroundDependencyLoader]
         private void load(SessionStatics sessionStatics, IAPIProvider api)
         {
+            endDate = sessionStatics.GetBindable<DateTimeOffset>(Static.SeasonEndDate);
             backgrounds = sessionStatics.GetBindable<List<APISeasonalBackground>>(Static.SeasonalBackgrounds);
+
             if (backgrounds.Value.Any()) return;
 
             var request = new GetSeasonalBackgroundsRequest();
             request.Success += response =>
             {
+                endDate.Value = response.EndDate;
                 backgrounds.Value = response.Backgrounds ?? backgrounds.Value;
+
                 current = RNG.Next(0, backgrounds.Value.Count);
             };
 
@@ -46,6 +52,8 @@ public SeasonalBackground LoadBackground()
 
             return new SeasonalBackground(url);
         }
+
+        public bool IsInSeason() => DateTimeOffset.Now < endDate.Value;
     }
 
     [LongRunningLoad]
diff --git a/osu.Game/Online/API/Requests/Responses/APISeasonalBackgrounds.cs b/osu.Game/Online/API/Requests/Responses/APISeasonalBackgrounds.cs
index 6996ac4d9b..8e395f7397 100644
--- a/osu.Game/Online/API/Requests/Responses/APISeasonalBackgrounds.cs
+++ b/osu.Game/Online/API/Requests/Responses/APISeasonalBackgrounds.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 System;
 using System.Collections.Generic;
 using Newtonsoft.Json;
 
@@ -8,6 +9,9 @@ namespace osu.Game.Online.API.Requests.Responses
 {
     public class APISeasonalBackgrounds
     {
+        [JsonProperty("ends_at")]
+        public DateTimeOffset EndDate;
+
         [JsonProperty("backgrounds")]
         public List<APISeasonalBackground> Backgrounds { get; set; }
     }
diff --git a/osu.Game/Screens/Backgrounds/BackgroundScreenDefault.cs b/osu.Game/Screens/Backgrounds/BackgroundScreenDefault.cs
index 70eafd4aff..de73c82d5c 100644
--- a/osu.Game/Screens/Backgrounds/BackgroundScreenDefault.cs
+++ b/osu.Game/Screens/Backgrounds/BackgroundScreenDefault.cs
@@ -109,7 +109,7 @@ private Background createBackground()
             switch (showSeasonalBackgrounds.Value)
             {
                 case SeasonalBackgrounds.Sometimes:
-                    if (RNG.NextBool())
+                    if (seasonalBackgroundLoader.IsInSeason())
                         goto case SeasonalBackgrounds.Always;
                     break;