2019-01-24 16:43:03 +08:00
// 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.
2018-04-13 17:19:50 +08:00
2021-09-30 15:45:32 +08:00
using System ;
using System.Collections.Generic ;
using System.IO ;
using System.Linq ;
using System.Linq.Expressions ;
using System.Threading ;
using System.Threading.Tasks ;
using JetBrains.Annotations ;
using osu.Framework.Audio ;
using osu.Framework.Bindables ;
using osu.Framework.IO.Stores ;
using osu.Framework.Platform ;
2020-10-16 13:39:02 +08:00
using osu.Framework.Testing ;
2021-09-30 15:45:32 +08:00
using osu.Game.Database ;
using osu.Game.IO ;
using osu.Game.IO.Archives ;
using osu.Game.Online.API ;
using osu.Game.Overlays.Notifications ;
using osu.Game.Rulesets ;
using osu.Game.Skinning ;
using osu.Game.Users ;
2018-04-13 17:19:50 +08:00
namespace osu.Game.Beatmaps
{
/// <summary>
2021-09-30 14:43:49 +08:00
/// Handles general operations related to global beatmap management.
2018-04-13 17:19:50 +08:00
/// </summary>
2020-10-16 13:39:02 +08:00
[ExcludeFromDynamicCompile]
2021-10-01 00:43:57 +08:00
public class BeatmapManager : IModelDownloader < BeatmapSetInfo > , IModelManager < BeatmapSetInfo > , IModelFileManager < BeatmapSetInfo , BeatmapSetFileInfo > , ICanAcceptFiles , IWorkingBeatmapCache , IDisposable
2018-04-13 17:19:50 +08:00
{
2021-09-30 15:45:32 +08:00
private readonly BeatmapModelManager beatmapModelManager ;
2021-09-30 17:21:16 +08:00
private readonly BeatmapModelDownloader beatmapModelDownloader ;
2021-09-30 15:45:32 +08:00
private readonly WorkingBeatmapCache workingBeatmapCache ;
2021-10-02 23:55:29 +08:00
private readonly BeatmapOnlineLookupQueue onlineBeatmapLookupQueue ;
2021-09-30 15:45:32 +08:00
public BeatmapManager ( Storage storage , IDatabaseContextFactory contextFactory , RulesetStore rulesets , IAPIProvider api , [ NotNull ] AudioManager audioManager , IResourceStore < byte [ ] > resources , GameHost host = null ,
WorkingBeatmap defaultBeatmap = null , bool performOnlineLookups = false )
2018-04-13 17:19:50 +08:00
{
2021-09-30 15:45:32 +08:00
beatmapModelManager = CreateBeatmapModelManager ( storage , contextFactory , rulesets , api , host ) ;
2021-09-30 17:21:16 +08:00
beatmapModelDownloader = CreateBeatmapModelDownloader ( beatmapModelManager , api , host ) ;
2021-09-30 15:45:32 +08:00
workingBeatmapCache = CreateWorkingBeatmapCache ( audioManager , resources , new FileStore ( contextFactory , storage ) . Store , defaultBeatmap , host ) ;
workingBeatmapCache . BeatmapManager = beatmapModelManager ;
2021-09-30 16:14:35 +08:00
if ( performOnlineLookups )
{
2021-10-02 23:55:29 +08:00
onlineBeatmapLookupQueue = new BeatmapOnlineLookupQueue ( api , storage ) ;
beatmapModelManager . OnlineLookupQueue = onlineBeatmapLookupQueue ;
2021-09-30 16:14:35 +08:00
}
2018-07-19 12:41:09 +08:00
}
2021-09-30 17:21:16 +08:00
protected virtual BeatmapModelDownloader CreateBeatmapModelDownloader ( BeatmapModelManager modelManager , IAPIProvider api , GameHost host )
{
return new BeatmapModelDownloader ( modelManager , api , host ) ;
}
2021-09-30 15:45:32 +08:00
protected virtual WorkingBeatmapCache CreateWorkingBeatmapCache ( AudioManager audioManager , IResourceStore < byte [ ] > resources , IResourceStore < byte [ ] > storage , WorkingBeatmap defaultBeatmap , GameHost host ) = >
new WorkingBeatmapCache ( audioManager , resources , storage , defaultBeatmap , host ) ;
protected virtual BeatmapModelManager CreateBeatmapModelManager ( Storage storage , IDatabaseContextFactory contextFactory , RulesetStore rulesets , IAPIProvider api , GameHost host ) = >
2021-09-30 17:21:16 +08:00
new BeatmapModelManager ( storage , contextFactory , rulesets , host ) ;
2021-09-30 15:45:32 +08:00
/// <summary>
/// Create a new <see cref="WorkingBeatmap"/>.
/// </summary>
public WorkingBeatmap CreateNew ( RulesetInfo ruleset , User user )
{
var metadata = new BeatmapMetadata
{
Author = user ,
} ;
var set = new BeatmapSetInfo
{
Metadata = metadata ,
Beatmaps = new List < BeatmapInfo >
{
new BeatmapInfo
{
BaseDifficulty = new BeatmapDifficulty ( ) ,
Ruleset = ruleset ,
Metadata = metadata ,
WidescreenStoryboard = true ,
SamplesMatchPlaybackRate = true ,
}
}
} ;
2021-09-30 18:33:12 +08:00
var imported = beatmapModelManager . Import ( set ) . Result . Value ;
return GetWorkingBeatmap ( imported . Beatmaps . First ( ) ) ;
2021-09-30 15:45:32 +08:00
}
#region Delegation to BeatmapModelManager ( methods which previously existed locally ) .
/// <summary>
/// Fired when a single difficulty has been hidden.
/// </summary>
public IBindable < WeakReference < BeatmapInfo > > BeatmapHidden = > beatmapModelManager . BeatmapHidden ;
/// <summary>
/// Fired when a single difficulty has been restored.
/// </summary>
public IBindable < WeakReference < BeatmapInfo > > BeatmapRestored = > beatmapModelManager . BeatmapRestored ;
/// <summary>
/// Saves an <see cref="IBeatmap"/> file against a given <see cref="BeatmapInfo"/>.
/// </summary>
/// <param name="info">The <see cref="BeatmapInfo"/> to save the content against. The file referenced by <see cref="BeatmapInfo.Path"/> will be replaced.</param>
/// <param name="beatmapContent">The <see cref="IBeatmap"/> content to write.</param>
/// <param name="beatmapSkin">The beatmap <see cref="ISkin"/> content to write, null if to be omitted.</param>
public virtual void Save ( BeatmapInfo info , IBeatmap beatmapContent , ISkin beatmapSkin = null ) = > beatmapModelManager . Save ( info , beatmapContent , beatmapSkin ) ;
/// <summary>
/// Returns a list of all usable <see cref="BeatmapSetInfo"/>s.
/// </summary>
/// <returns>A list of available <see cref="BeatmapSetInfo"/>.</returns>
public List < BeatmapSetInfo > GetAllUsableBeatmapSets ( IncludedDetails includes = IncludedDetails . All , bool includeProtected = false ) = > beatmapModelManager . GetAllUsableBeatmapSets ( includes , includeProtected ) ;
/// <summary>
/// Returns a list of all usable <see cref="BeatmapSetInfo"/>s. Note that files are not populated.
/// </summary>
/// <param name="includes">The level of detail to include in the returned objects.</param>
/// <param name="includeProtected">Whether to include protected (system) beatmaps. These should not be included for gameplay playable use cases.</param>
/// <returns>A list of available <see cref="BeatmapSetInfo"/>.</returns>
public IEnumerable < BeatmapSetInfo > GetAllUsableBeatmapSetsEnumerable ( IncludedDetails includes , bool includeProtected = false ) = > beatmapModelManager . GetAllUsableBeatmapSetsEnumerable ( includes , includeProtected ) ;
/// <summary>
/// Perform a lookup query on available <see cref="BeatmapSetInfo"/>s.
/// </summary>
/// <param name="query">The query.</param>
/// <param name="includes">The level of detail to include in the returned objects.</param>
/// <returns>Results from the provided query.</returns>
public IEnumerable < BeatmapSetInfo > QueryBeatmapSets ( Expression < Func < BeatmapSetInfo , bool > > query , IncludedDetails includes = IncludedDetails . All ) = > beatmapModelManager . QueryBeatmapSets ( query , includes ) ;
/// <summary>
/// Perform a lookup query on available <see cref="BeatmapSetInfo"/>s.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>The first result for the provided query, or null if no results were found.</returns>
public BeatmapSetInfo QueryBeatmapSet ( Expression < Func < BeatmapSetInfo , bool > > query ) = > beatmapModelManager . QueryBeatmapSet ( query ) ;
/// <summary>
/// Perform a lookup query on available <see cref="BeatmapInfo"/>s.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>Results from the provided query.</returns>
public IQueryable < BeatmapInfo > QueryBeatmaps ( Expression < Func < BeatmapInfo , bool > > query ) = > beatmapModelManager . QueryBeatmaps ( query ) ;
/// <summary>
/// Perform a lookup query on available <see cref="BeatmapInfo"/>s.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>The first result for the provided query, or null if no results were found.</returns>
public BeatmapInfo QueryBeatmap ( Expression < Func < BeatmapInfo , bool > > query ) = > beatmapModelManager . QueryBeatmap ( query ) ;
/// <summary>
/// A default representation of a WorkingBeatmap to use when no beatmap is available.
/// </summary>
public WorkingBeatmap DefaultBeatmap = > workingBeatmapCache . DefaultBeatmap ;
/// <summary>
/// Fired when a notification should be presented to the user.
/// </summary>
2021-09-30 17:21:16 +08:00
public Action < Notification > PostNotification
{
set
{
beatmapModelManager . PostNotification = value ;
beatmapModelDownloader . PostNotification = value ;
}
}
2021-09-30 15:45:32 +08:00
/// <summary>
/// Fired when the user requests to view the resulting import.
/// </summary>
2021-10-04 15:35:55 +08:00
public Action < IEnumerable < ILive < BeatmapSetInfo > > > PresentImport { set = > beatmapModelManager . PostImport = value ; }
2021-09-30 15:45:32 +08:00
/// <summary>
/// Delete a beatmap difficulty.
/// </summary>
2021-10-02 23:55:29 +08:00
/// <param name="beatmapInfo">The beatmap difficulty to hide.</param>
public void Hide ( BeatmapInfo beatmapInfo ) = > beatmapModelManager . Hide ( beatmapInfo ) ;
2021-09-30 15:45:32 +08:00
/// <summary>
/// Restore a beatmap difficulty.
/// </summary>
2021-10-02 23:55:29 +08:00
/// <param name="beatmapInfo">The beatmap difficulty to restore.</param>
public void Restore ( BeatmapInfo beatmapInfo ) = > beatmapModelManager . Restore ( beatmapInfo ) ;
2020-04-28 20:43:35 +08:00
2021-09-30 15:45:32 +08:00
#endregion
#region Implementation of IModelManager < BeatmapSetInfo >
2021-09-30 17:21:16 +08:00
public bool IsAvailableLocally ( BeatmapSetInfo model )
{
return beatmapModelManager . IsAvailableLocally ( model ) ;
}
2021-09-30 15:45:32 +08:00
public IBindable < WeakReference < BeatmapSetInfo > > ItemUpdated = > beatmapModelManager . ItemUpdated ;
public IBindable < WeakReference < BeatmapSetInfo > > ItemRemoved = > beatmapModelManager . ItemRemoved ;
public Task ImportFromStableAsync ( StableStorage stableStorage )
{
return beatmapModelManager . ImportFromStableAsync ( stableStorage ) ;
}
public void Export ( BeatmapSetInfo item )
{
beatmapModelManager . Export ( item ) ;
}
public void ExportModelTo ( BeatmapSetInfo model , Stream outputStream )
{
beatmapModelManager . ExportModelTo ( model , outputStream ) ;
}
public void Update ( BeatmapSetInfo item )
{
beatmapModelManager . Update ( item ) ;
}
public bool Delete ( BeatmapSetInfo item )
{
return beatmapModelManager . Delete ( item ) ;
}
public void Delete ( List < BeatmapSetInfo > items , bool silent = false )
{
beatmapModelManager . Delete ( items , silent ) ;
}
public void Undelete ( List < BeatmapSetInfo > items , bool silent = false )
{
beatmapModelManager . Undelete ( items , silent ) ;
}
public void Undelete ( BeatmapSetInfo item )
{
beatmapModelManager . Undelete ( item ) ;
}
#endregion
#region Implementation of IModelDownloader < BeatmapSetInfo >
2021-09-30 17:21:16 +08:00
public IBindable < WeakReference < ArchiveDownloadRequest < BeatmapSetInfo > > > DownloadBegan = > beatmapModelDownloader . DownloadBegan ;
2021-09-30 15:45:32 +08:00
2021-09-30 17:21:16 +08:00
public IBindable < WeakReference < ArchiveDownloadRequest < BeatmapSetInfo > > > DownloadFailed = > beatmapModelDownloader . DownloadFailed ;
2021-09-30 15:45:32 +08:00
public bool Download ( BeatmapSetInfo model , bool minimiseDownloadSize = false )
{
2021-09-30 17:21:16 +08:00
return beatmapModelDownloader . Download ( model , minimiseDownloadSize ) ;
2021-09-30 15:45:32 +08:00
}
public ArchiveDownloadRequest < BeatmapSetInfo > GetExistingDownload ( BeatmapSetInfo model )
{
2021-09-30 17:21:16 +08:00
return beatmapModelDownloader . GetExistingDownload ( model ) ;
2021-09-30 15:45:32 +08:00
}
#endregion
#region Implementation of ICanAcceptFiles
public Task Import ( params string [ ] paths )
{
return beatmapModelManager . Import ( paths ) ;
}
public Task Import ( params ImportTask [ ] tasks )
{
return beatmapModelManager . Import ( tasks ) ;
}
2021-09-30 18:33:12 +08:00
public Task < IEnumerable < ILive < BeatmapSetInfo > > > Import ( ProgressNotification notification , params ImportTask [ ] tasks )
2021-09-30 15:45:32 +08:00
{
return beatmapModelManager . Import ( notification , tasks ) ;
}
2021-09-30 18:33:12 +08:00
public Task < ILive < BeatmapSetInfo > > Import ( ImportTask task , bool lowPriority = false , CancellationToken cancellationToken = default )
2021-09-30 15:45:32 +08:00
{
return beatmapModelManager . Import ( task , lowPriority , cancellationToken ) ;
}
2021-09-30 18:33:12 +08:00
public Task < ILive < BeatmapSetInfo > > Import ( ArchiveReader archive , bool lowPriority = false , CancellationToken cancellationToken = default )
2021-09-30 15:45:32 +08:00
{
return beatmapModelManager . Import ( archive , lowPriority , cancellationToken ) ;
}
2021-09-30 18:33:12 +08:00
public Task < ILive < BeatmapSetInfo > > Import ( BeatmapSetInfo item , ArchiveReader archive = null , bool lowPriority = false , CancellationToken cancellationToken = default )
2021-09-30 15:45:32 +08:00
{
return beatmapModelManager . Import ( item , archive , lowPriority , cancellationToken ) ;
}
public IEnumerable < string > HandledExtensions = > beatmapModelManager . HandledExtensions ;
#endregion
#region Implementation of IWorkingBeatmapCache
public WorkingBeatmap GetWorkingBeatmap ( BeatmapInfo importedBeatmap ) = > workingBeatmapCache . GetWorkingBeatmap ( importedBeatmap ) ;
#endregion
#region Implementation of IModelFileManager < in BeatmapSetInfo , in BeatmapSetFileInfo >
public void ReplaceFile ( BeatmapSetInfo model , BeatmapSetFileInfo file , Stream contents , string filename = null )
{
beatmapModelManager . ReplaceFile ( model , file , contents , filename ) ;
}
public void DeleteFile ( BeatmapSetInfo model , BeatmapSetFileInfo file )
{
beatmapModelManager . DeleteFile ( model , file ) ;
}
public void AddFile ( BeatmapSetInfo model , Stream contents , string filename )
{
beatmapModelManager . AddFile ( model , contents , filename ) ;
}
#endregion
2021-10-01 00:43:57 +08:00
#region Implementation of IDisposable
public void Dispose ( )
{
2021-10-02 23:55:29 +08:00
onlineBeatmapLookupQueue ? . Dispose ( ) ;
2021-10-01 00:43:57 +08:00
}
#endregion
2021-09-30 15:45:32 +08:00
}
2018-04-13 17:19:50 +08:00
}