Split out IModelDownloader and also split apart ScoreManager

osu.Game/Database/ModelDownloader.cs

@@ -0,0 +1,130 @@
+// 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 System.Threading.Tasks;
+using Humanizer;
+using osu.Framework.Bindables;
+using osu.Framework.Logging;
+using osu.Framework.Platform;
+using osu.Game.Online.API;
+using osu.Game.Overlays.Notifications;
+
+namespace osu.Game.Database
+{
+    public abstract class ModelDownloader<TModel> : IModelDownloader<TModel>
+        where TModel : class, IHasPrimaryKey, ISoftDelete, IEquatable<TModel>
+    {
+        public Action<Notification> PostNotification { protected get; set; }
+
+        public IBindable<WeakReference<ArchiveDownloadRequest<TModel>>> DownloadBegan => downloadBegan;
+
+        private readonly Bindable<WeakReference<ArchiveDownloadRequest<TModel>>> downloadBegan = new Bindable<WeakReference<ArchiveDownloadRequest<TModel>>>();
+
+        public IBindable<WeakReference<ArchiveDownloadRequest<TModel>>> DownloadFailed => downloadFailed;
+
+        private readonly Bindable<WeakReference<ArchiveDownloadRequest<TModel>>> downloadFailed = new Bindable<WeakReference<ArchiveDownloadRequest<TModel>>>();
+
+        private readonly IModelManager<TModel> modelManager;
+        private readonly IAPIProvider api;
+
+        private readonly List<ArchiveDownloadRequest<TModel>> currentDownloads = new List<ArchiveDownloadRequest<TModel>>();
+
+        protected ModelDownloader(IModelManager<TModel> modelManager, IAPIProvider api, IIpcHost importHost = null)
+        {
+            this.modelManager = modelManager;
+            this.api = api;
+        }
+
+        /// <summary>
+        /// Creates the download request for this <typeparamref name="TModel"/>.
+        /// </summary>
+        /// <param name="model">The <typeparamref name="TModel"/> to be downloaded.</param>
+        /// <param name="minimiseDownloadSize">Whether this download should be optimised for slow connections. Generally means extras are not included in the download bundle.</param>
+        /// <returns>The request object.</returns>
+        protected abstract ArchiveDownloadRequest<TModel> CreateDownloadRequest(TModel model, bool minimiseDownloadSize);
+
+        public bool Download(TModel model, bool minimiseDownloadSize = false)
+        {
+            if (!canDownload(model)) return false;
+
+            var request = CreateDownloadRequest(model, minimiseDownloadSize);
+
+            DownloadNotification notification = new DownloadNotification
+            {
+                Text = $"Downloading {request.Model}",
+            };
+
+            request.DownloadProgressed += progress =>
+            {
+                notification.State = ProgressNotificationState.Active;
+                notification.Progress = progress;
+            };
+
+            request.Success += filename =>
+            {
+                Task.Factory.StartNew(async () =>
+                {
+                    // This gets scheduled back to the update thread, but we want the import to run in the background.
+                    var imported = await modelManager.Import(notification, new ImportTask(filename)).ConfigureAwait(false);
+
+                    // for now a failed import will be marked as a failed download for simplicity.
+                    if (!imported.Any())
+                        downloadFailed.Value = new WeakReference<ArchiveDownloadRequest<TModel>>(request);
+
+                    currentDownloads.Remove(request);
+                }, TaskCreationOptions.LongRunning);
+            };
+
+            request.Failure += triggerFailure;
+
+            notification.CancelRequested += () =>
+            {
+                request.Cancel();
+                return true;
+            };
+
+            currentDownloads.Add(request);
+            PostNotification?.Invoke(notification);
+
+            api.PerformAsync(request);
+
+            downloadBegan.Value = new WeakReference<ArchiveDownloadRequest<TModel>>(request);
+            return true;
+
+            void triggerFailure(Exception error)
+            {
+                currentDownloads.Remove(request);
+
+                downloadFailed.Value = new WeakReference<ArchiveDownloadRequest<TModel>>(request);
+
+                notification.State = ProgressNotificationState.Cancelled;
+
+                if (!(error is OperationCanceledException))
+                    Logger.Error(error, $"{modelManager.HumanisedModelName.Titleize()} download failed!");
+            }
+        }
+
+        public ArchiveDownloadRequest<TModel> GetExistingDownload(TModel model) => currentDownloads.Find(r => r.Model.Equals(model));
+
+        private bool canDownload(TModel model) => GetExistingDownload(model) == null && api != null;
+
+        private class DownloadNotification : ProgressNotification
+        {
+            public override bool IsImportant => false;
+
+            protected override Notification CreateCompletionNotification() => new SilencedProgressCompletionNotification
+            {
+                Activated = CompletionClickAction,
+                Text = CompletionText
+            };
+
+            private class SilencedProgressCompletionNotification : ProgressCompletionNotification
+            {
+                public override bool IsImportant => false;
+            }
+        }
+    }
+}