Merge pull request #1228 from naoey/direct-upgrades

Direct results maintain download status between switching views

osu.Desktop.Tests/Visual/TestCaseDirect.cs

@@ -41,12 +41,14 @@ namespace osu.Desktop.Tests.Visual
             {
                 new BeatmapSetInfo
                 {
+                    OnlineBeatmapSetID = 578332,
                     Metadata = new BeatmapMetadata
                     {
                         Title = @"OrVid",
                         Artist = @"An",
                         Author = @"RLC",
                         Source = @"",
+                        Tags = @"acuticnotes an-fillnote revid tear tearvid encrpted encryption axi axivid quad her hervid recoll",
                     },
                     OnlineInfo = new BeatmapSetOnlineInfo
                     {
@@ -71,12 +73,14 @@ namespace osu.Desktop.Tests.Visual
                 },
                 new BeatmapSetInfo
                 {
+                    OnlineBeatmapSetID = 599627,
                     Metadata = new BeatmapMetadata
                     {
                         Title = @"tiny lamp",
                         Artist = @"fhana",
                         Author = @"Sotarks",
                         Source = @"ぎんぎつね",
+                        Tags = @"lantis junichi sato yuxuki waga kevin mitsunaga towana gingitsune opening op full ver version kalibe collab collaboration",
                     },
                     OnlineInfo = new BeatmapSetOnlineInfo
                     {
@@ -101,12 +105,14 @@ namespace osu.Desktop.Tests.Visual
                 },
                 new BeatmapSetInfo
                 {
+                    OnlineBeatmapSetID = 513268,
                     Metadata = new BeatmapMetadata
                     {
                         Title = @"At Gwanghwamun",
                         Artist = @"KYUHYUN",
                         Author = @"Cerulean Veyron",
                         Source = @"",
+                        Tags = @"soul ballad kh super junior sj suju 슈퍼주니어 kt뮤직 sm엔터테인먼트 s.m.entertainment kt music 1st mini album ep",
                     },
                     OnlineInfo = new BeatmapSetOnlineInfo
                     {
@@ -146,12 +152,14 @@ namespace osu.Desktop.Tests.Visual
                 },
                 new BeatmapSetInfo
                 {
+                    OnlineBeatmapSetID = 586841,
                     Metadata = new BeatmapMetadata
                     {
                         Title = @"RHAPSODY OF BLUE SKY",
                         Artist = @"fhana",
                         Author = @"[Kamiya]",
                         Source = @"小林さんちのメイドラゴン",
+                        Tags = @"kobayashi san chi no maidragon aozora no opening anime maid dragon oblivion karen dynamix imoutosan pata-mon gxytcgxytc",
                     },
                     OnlineInfo = new BeatmapSetOnlineInfo
                     {

osu.Desktop.Tests/Visual/TestCasePlaySongSelect.cs

@@ -32,7 +32,7 @@ namespace osu.Desktop.Tests.Visual
                 backingDatabase.CreateTable<StoreVersion>();
 
                 rulesets = new RulesetStore(backingDatabase);
-                manager = new BeatmapManager(storage, null, backingDatabase, rulesets);
+                manager = new BeatmapManager(storage, null, backingDatabase, rulesets, null);
 
                 for (int i = 0; i < 100; i += 10)
                     manager.Import(createTestBeatmapSet(i));

osu.Game/Beatmaps/BeatmapManager.cs

@@ -20,6 +20,9 @@ using osu.Game.IPC;
 using osu.Game.Overlays.Notifications;
 using osu.Game.Rulesets;
 using SQLite.Net;
+using osu.Game.Online.API.Requests;
+using System.Threading.Tasks;
+using osu.Game.Online.API;
 
 namespace osu.Game.Beatmaps
 {
@@ -63,6 +66,10 @@ namespace osu.Game.Beatmaps
 
         private readonly BeatmapStore beatmaps;
 
+        private readonly APIAccess api;
+
+        private readonly List<DownloadBeatmapSetRequest> currentDownloads = new List<DownloadBeatmapSetRequest>();
+
         // ReSharper disable once NotAccessedField.Local (we should keep a reference to this so it is not finalised)
         private BeatmapIPCChannel ipc;
 
@@ -76,7 +83,7 @@ namespace osu.Game.Beatmaps
         /// </summary>
         public Func<Storage> GetStableStorage { private get; set; }
 
-        public BeatmapManager(Storage storage, FileStore files, SQLiteConnection connection, RulesetStore rulesets, IIpcHost importHost = null)
+        public BeatmapManager(Storage storage, FileStore files, SQLiteConnection connection, RulesetStore rulesets, APIAccess api, IIpcHost importHost = null)
         {
             beatmaps = new BeatmapStore(connection);
             beatmaps.BeatmapSetAdded += s => BeatmapSetAdded?.Invoke(s);
@@ -88,6 +95,7 @@ namespace osu.Game.Beatmaps
             this.files = files;
             this.connection = connection;
             this.rulesets = rulesets;
+            this.api = api;
 
             if (importHost != null)
                 ipc = new BeatmapIPCChannel(importHost, this);
@@ -177,6 +185,74 @@ namespace osu.Game.Beatmaps
             beatmaps.Add(beatmapSetInfo);
         }
 
+        /// <summary>
+        /// Downloads a beatmap.
+        /// </summary>
+        /// <param name="beatmapSetInfo">The <see cref="BeatmapSetInfo"/> to be downloaded.</param>
+        /// <returns>A new <see cref="DownloadBeatmapSetRequest"/>, or an existing one if a download is already in progress.</returns>
+        public DownloadBeatmapSetRequest Download(BeatmapSetInfo beatmapSetInfo)
+        {
+            var existing = GetExistingDownload(beatmapSetInfo);
+
+            if (existing != null) return existing;
+
+            if (api == null) return null;
+
+            ProgressNotification downloadNotification = new ProgressNotification
+            {
+                Text = $"Downloading {beatmapSetInfo.Metadata.Artist} - {beatmapSetInfo.Metadata.Title}",
+            };
+
+            var request = new DownloadBeatmapSetRequest(beatmapSetInfo);
+
+            request.DownloadProgressed += progress =>
+            {
+                downloadNotification.State = ProgressNotificationState.Active;
+                downloadNotification.Progress = progress;
+            };
+
+            request.Success += data =>
+            {
+                downloadNotification.State = ProgressNotificationState.Completed;
+
+                using (var stream = new MemoryStream(data))
+                using (var archive = new OszArchiveReader(stream))
+                    Import(archive);
+
+                currentDownloads.Remove(request);
+            };
+
+            request.Failure += data =>
+            {
+                downloadNotification.State = ProgressNotificationState.Completed;
+                Logger.Error(data, "Failed to get beatmap download information");
+                currentDownloads.Remove(request);
+            };
+
+            downloadNotification.CancelRequested += () =>
+            {
+                request.Cancel();
+                currentDownloads.Remove(request);
+                downloadNotification.State = ProgressNotificationState.Cancelled;
+                return true;
+            };
+
+            currentDownloads.Add(request);
+            PostNotification?.Invoke(downloadNotification);
+
+            // don't run in the main api queue as this is a long-running task.
+            Task.Run(() => request.Perform(api));
+
+            return request;
+        }
+
+        /// <summary>
+        /// Get an existing download request if it exists.
+        /// </summary>
+        /// <param name="beatmap">The <see cref="BeatmapSetInfo"/> whose download request is wanted.</param>
+        /// <returns>The <see cref="DownloadBeatmapSetRequest"/> object if it exists, or null.</returns>
+        public DownloadBeatmapSetRequest GetExistingDownload(BeatmapSetInfo beatmap) => currentDownloads.Find(d => d.BeatmapSet.OnlineBeatmapSetID == beatmap.OnlineBeatmapSetID);
+
         /// <summary>
         /// Delete a beatmap from the manager.
         /// Is a no-op for already deleted beatmaps.

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

@@ -0,0 +1,24 @@
+// Copyright (c) 2007-2017 ppy Pty Ltd <contact@ppy.sh>.
+// Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
+
+using osu.Game.Beatmaps;
+using System;
+
+namespace osu.Game.Online.API.Requests
+{
+    public class DownloadBeatmapSetRequest : APIDownloadRequest
+    {
+        public readonly BeatmapSetInfo BeatmapSet;
+
+        public Action<float> DownloadProgressed;
+
+        public DownloadBeatmapSetRequest(BeatmapSetInfo set)
+        {
+            BeatmapSet = set;
+
+            Progress += (current, total) => DownloadProgressed?.Invoke((float) current / total);
+        }
+
+        protected override string Target => $@"beatmapsets/{BeatmapSet.OnlineBeatmapSetID}/download";
+    }
+}

osu.Game/OsuGameBase.cs

@@ -106,9 +106,15 @@ namespace osu.Game
 
             connection.CreateTable<StoreVersion>();
 
+            dependencies.Cache(API = new APIAccess
+            {
+                Username = LocalConfig.Get<string>(OsuSetting.Username),
+                Token = LocalConfig.Get<string>(OsuSetting.Token)
+            });
+
             dependencies.Cache(RulesetStore = new RulesetStore(connection));
             dependencies.Cache(FileStore = new FileStore(connection, Host.Storage));
-            dependencies.Cache(BeatmapManager = new BeatmapManager(Host.Storage, FileStore, connection, RulesetStore, Host));
+            dependencies.Cache(BeatmapManager = new BeatmapManager(Host.Storage, FileStore, connection, RulesetStore, API, Host));
             dependencies.Cache(ScoreStore = new ScoreStore(Host.Storage, connection, Host, BeatmapManager, RulesetStore));
             dependencies.Cache(KeyBindingStore = new KeyBindingStore(connection, RulesetStore));
             dependencies.Cache(new OsuColour());
@@ -144,12 +150,6 @@ namespace osu.Game
             Beatmap = new NonNullableBindable<WorkingBeatmap>(defaultBeatmap);
             BeatmapManager.DefaultBeatmap = defaultBeatmap;
 
-            dependencies.Cache(API = new APIAccess
-            {
-                Username = LocalConfig.Get<string>(OsuSetting.Username),
-                Token = LocalConfig.Get<string>(OsuSetting.Token)
-            });
-
             Beatmap.ValueChanged += b =>
             {
                 // compare to last beatmap as sometimes the two may share a track representation (optimisation, see WorkingBeatmap.TransferTo)

osu.Game/Overlays/Direct/DirectPanel.cs

@@ -4,8 +4,6 @@
 using System.Collections.Generic;
 using osu.Framework.Allocation;
 using osu.Framework.Extensions.Color4Extensions;
-using System.IO;
-using System.Threading.Tasks;
 using OpenTK;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
@@ -20,8 +18,8 @@ using osu.Framework.Input;
 using osu.Game.Graphics.UserInterface;
 using osu.Game.Online.API;
 using osu.Framework.Logging;
-using osu.Game.Beatmaps.IO;
 using osu.Game.Overlays.Notifications;
+using osu.Game.Online.API.Requests;
 
 namespace osu.Game.Overlays.Direct
 {
@@ -97,6 +95,11 @@ namespace osu.Game.Overlays.Direct
                     },
                 }
             });
+
+            var downloadRequest = beatmaps.GetExistingDownload(SetInfo);
+
+            if (downloadRequest != null)
+                attachDownload(downloadRequest);
         }
 
         protected override bool OnHover(InputState state)
@@ -115,23 +118,8 @@ namespace osu.Game.Overlays.Direct
             base.OnHoverLost(state);
         }
 
-        // this should eventually be moved to a more central place, like BeatmapManager.
-        private DownloadBeatmapSetRequest downloadRequest;
-
         protected void StartDownload()
         {
-            if (api == null) return;
-
-            // we already have an active download running.
-            if (downloadRequest != null)
-            {
-                content.MoveToX(-5, 50, Easing.OutSine).Then()
-                       .MoveToX(5, 100, Easing.InOutSine).Then()
-                       .MoveToX(-5, 100, Easing.InOutSine).Then()
-                       .MoveToX(0, 50, Easing.InSine).Then();
-                return;
-            }
-
             if (!api.LocalUser.Value.IsSupporter)
             {
                 notifications.Post(new SimpleNotification
@@ -142,72 +130,43 @@ namespace osu.Game.Overlays.Direct
                 return;
             }
 
+            if (beatmaps.GetExistingDownload(SetInfo) != null)
+            {
+                // we already have an active download running.
+                content.MoveToX(-5, 50, Easing.OutSine).Then()
+                       .MoveToX(5, 100, Easing.InOutSine).Then()
+                       .MoveToX(-5, 100, Easing.InOutSine).Then()
+                       .MoveToX(0, 50, Easing.InSine).Then();
+
+                return;
+            }
+
+            var request = beatmaps.Download(SetInfo);
+
+            attachDownload(request);
+        }
+
+        private void attachDownload(DownloadBeatmapSetRequest request)
+        {
             progressBar.FadeIn(400, Easing.OutQuint);
             progressBar.ResizeHeightTo(4, 400, Easing.OutQuint);
 
             progressBar.Current.Value = 0;
 
-            ProgressNotification downloadNotification = new ProgressNotification
+            request.Failure += e =>
-            {
-                Text = $"Downloading {SetInfo.Metadata.Artist} - {SetInfo.Metadata.Title}",
-            };
-
-            downloadRequest = new DownloadBeatmapSetRequest(SetInfo);
-            downloadRequest.Failure += e =>
             {
                 progressBar.Current.Value = 0;
                 progressBar.FadeOut(500);
-                downloadNotification.State = ProgressNotificationState.Completed;
                 Logger.Error(e, "Failed to get beatmap download information");
-
-                downloadRequest = null;
             };
 
-            downloadRequest.Progress += (current, total) =>
+            request.DownloadProgressed += progress => progressBar.Current.Value = progress;
-            {
-                float progress = (float)current / total;
 
-                progressBar.Current.Value = progress;
+            request.Success += data =>
-
-                downloadNotification.State = ProgressNotificationState.Active;
-                downloadNotification.Progress = progress;
-            };
-
-            downloadRequest.Success += data =>
             {
                 progressBar.Current.Value = 1;
                 progressBar.FadeOut(500);
-
-                downloadNotification.State = ProgressNotificationState.Completed;
-
-                using (var stream = new MemoryStream(data))
-                using (var archive = new OszArchiveReader(stream))
-                    beatmaps.Import(archive);
             };
-
-            downloadNotification.CancelRequested += () =>
-            {
-                downloadRequest.Cancel();
-                downloadRequest = null;
-                return true;
-            };
-
-            notifications.Post(downloadNotification);
-
-            // don't run in the main api queue as this is a long-running task.
-            Task.Run(() => downloadRequest.Perform(api));
-        }
-
-        public class DownloadBeatmapSetRequest : APIDownloadRequest
-        {
-            private readonly BeatmapSetInfo beatmapSet;
-
-            public DownloadBeatmapSetRequest(BeatmapSetInfo beatmapSet)
-            {
-                this.beatmapSet = beatmapSet;
-            }
-
-            protected override string Target => $@"beatmapsets/{beatmapSet.OnlineBeatmapSetID}/download";
         }
 
         protected override void LoadComplete()

osu.Game/Overlays/DirectOverlay.cs

@@ -27,6 +27,7 @@ namespace osu.Game.Overlays
 
         private APIAccess api;
         private RulesetStore rulesets;
+        private BeatmapManager beatmaps;
 
         private readonly FillFlowContainer resultCountsContainer;
         private readonly OsuSpriteText resultCountsText;
@@ -46,9 +47,26 @@ namespace osu.Game.Overlays
             set
             {
                 if (beatmapSets?.Equals(value) ?? false) return;
+
                 beatmapSets = value;
 
-                recreatePanels(Filter.DisplayStyleControl.DisplayStyle.Value);
+                if (beatmapSets == null) return;
+
+                var artists = new List<string>();
+                var songs = new List<string>();
+                var tags = new List<string>();
+                foreach (var s in beatmapSets)
+                {
+                    artists.Add(s.Metadata.Artist);
+                    songs.Add(s.Metadata.Title);
+                    tags.AddRange(s.Metadata.Tags.Split(' '));
+                }
+
+                ResultAmounts = new ResultCounts(distinctCount(artists), distinctCount(songs), distinctCount(tags));
+
+                if (beatmapSets.Any() && panels == null)
+                    // real use case? currently only seems to be for test case
+                    recreatePanels(Filter.DisplayStyleControl.DisplayStyle.Value);
             }
         }
 
@@ -147,6 +165,8 @@ namespace osu.Game.Overlays
         {
             this.api = api;
             this.rulesets = rulesets;
+            this.beatmaps = beatmaps;
+
             resultCountsContainer.Colour = colours.Yellow;
 
             beatmaps.BeatmapSetAdded += setAdded;
@@ -156,6 +176,7 @@ namespace osu.Game.Overlays
         {
             // if a new map was imported, we should remove it from search results (download completed etc.)
             panels?.FirstOrDefault(p => p.SetInfo.OnlineBeatmapSetID == set.OnlineBeatmapSetID)?.FadeOut(400).Expire();
+            BeatmapSets = BeatmapSets?.Where(b => b.OnlineBeatmapSetID != set.OnlineBeatmapSetID);
         }
 
         private void updateResultCounts()
@@ -237,20 +258,11 @@ namespace osu.Game.Overlays
 
             getSetsRequest.Success += r =>
             {
-                BeatmapSets = r?.Select(response => response.ToBeatmapSet(rulesets));
+                BeatmapSets = r?.
-                if (BeatmapSets == null) return;
+                                Select(response => response.ToBeatmapSet(rulesets)).
+                                Where(b => beatmaps.QueryBeatmapSet(q => q.OnlineBeatmapSetID == b.OnlineBeatmapSetID) == null);
 
-                var artists = new List<string>();
+                recreatePanels(Filter.DisplayStyleControl.DisplayStyle.Value);
-                var songs = new List<string>();
-                var tags = new List<string>();
-                foreach (var s in BeatmapSets)
-                {
-                    artists.Add(s.Metadata.Artist);
-                    songs.Add(s.Metadata.Title);
-                    tags.AddRange(s.Metadata.Tags.Split(' '));
-                }
-
-                ResultAmounts = new ResultCounts(distinctCount(artists), distinctCount(songs), distinctCount(tags));
             };
 
             api.Queue(getSetsRequest);

osu.Game/osu.Game.csproj

@@ -98,6 +98,7 @@
     <Compile Include="Input\Bindings\GlobalKeyBindingInputManager.cs" />
     <Compile Include="IO\FileStore.cs" />
     <Compile Include="IO\FileInfo.cs" />
+    <Compile Include="Online\API\Requests\DownloadBeatmapSetRequest.cs" />
     <Compile Include="Online\API\Requests\GetUsersRequest.cs" />
     <Compile Include="Online\API\Requests\PostMessageRequest.cs" />
     <Compile Include="Online\Chat\ErrorMessage.cs" />