Skip to content

Commit

Permalink
Rename Stable to Legacy and add xmldoc
Browse files Browse the repository at this point in the history
  • Loading branch information
peppy committed Nov 25, 2021
1 parent 6cab7b8 commit 9dcb20a
Show file tree
Hide file tree
Showing 8 changed files with 31 additions and 28 deletions.
Expand Up @@ -19,7 +19,10 @@

namespace osu.Game.Database
{
public class StableImportManager : Component
/// <summary>
/// Handles migration of legacy user data from osu-stable.
/// </summary>
public class LeagcyImportManager : Component
{
[Resolved]
private SkinManager skins { get; set; }
Expand Down Expand Up @@ -51,9 +54,9 @@ public async Task ImportFromStableAsync(StableContent content)
var stableStorage = await getStableStorage().ConfigureAwait(false);
var importTasks = new List<Task>();

var beatmapImporter = new StableBeatmapImporter(beatmaps);
var skinImporter = new StableSkinImporter(skins);
var scoreImporter = new StableScoreImporter(scores);
var beatmapImporter = new LegacyBeatmapImporter(beatmaps);
var skinImporter = new LegacySkinImporter(skins);
var scoreImporter = new LegacyScoreImporter(scores);

Task beatmapImportTask = Task.CompletedTask;
if (content.HasFlagFast(StableContent.Beatmaps))
Expand Down
Expand Up @@ -4,15 +4,15 @@

namespace osu.Game.Database
{
public class StableBeatmapImporter : StableImporter<BeatmapSetInfo>
public class LegacyBeatmapImporter : LegacyImporter<BeatmapSetInfo>
{
protected override string ImportFromStablePath => ".";

protected override Storage PrepareStableStorage(StableStorage stableStorage) => stableStorage.GetSongStorage();

public StableBeatmapImporter(IModelImporter<BeatmapSetInfo> importer)
public LegacyBeatmapImporter(IModelImporter<BeatmapSetInfo> importer)
: base(importer)
{
}
}
}
}
Expand Up @@ -11,9 +11,9 @@
namespace osu.Game.Database
{
/// <summary>
/// A class which handled importing various user data from osu-stable.
/// A class which handles importing legacy user data of a single type from osu-stable.
/// </summary>
public class StableImporter<TModel>
public abstract class LegacyImporter<TModel>
where TModel : class
{
/// <summary>
Expand All @@ -29,7 +29,7 @@ protected virtual IEnumerable<string> GetStableImportPaths(Storage storage) => s

protected readonly IModelImporter<TModel> Importer;

public StableImporter(IModelImporter<TModel> importer)
protected LegacyImporter(IModelImporter<TModel> importer)
{
Importer = importer;
}
Expand Down
Expand Up @@ -7,15 +7,15 @@

namespace osu.Game.Database
{
public class StableScoreImporter : StableImporter<ScoreInfo>
public class LegacyScoreImporter : LegacyImporter<ScoreInfo>
{
protected override string ImportFromStablePath => Path.Combine("Data", "r");

protected override IEnumerable<string> GetStableImportPaths(Storage storage)
=> storage.GetFiles(ImportFromStablePath).Where(p => Importer.HandledExtensions.Any(ext => Path.GetExtension(p)?.Equals(ext, StringComparison.OrdinalIgnoreCase) ?? false))
.Select(path => storage.GetFullPath(path));

public StableScoreImporter(IModelImporter<ScoreInfo> importer)
public LegacyScoreImporter(IModelImporter<ScoreInfo> importer)
: base(importer)
{
}
Expand Down
Expand Up @@ -2,11 +2,11 @@

namespace osu.Game.Database
{
public class StableSkinImporter : StableImporter<SkinInfo>
public class LegacySkinImporter : LegacyImporter<SkinInfo>
{
protected override string ImportFromStablePath => "Skins";

public StableSkinImporter(IModelImporter<SkinInfo> importer)
public LegacySkinImporter(IModelImporter<SkinInfo> importer)
: base(importer)
{
}
Expand Down
4 changes: 2 additions & 2 deletions osu.Game/OsuGame.cs
Expand Up @@ -116,7 +116,7 @@ public class OsuGame : OsuGameBase, IKeyBindingHandler<GlobalAction>, ILocalUser
private readonly DifficultyRecommender difficultyRecommender = new DifficultyRecommender();

[Cached]
private readonly StableImportManager stableImportManager = new StableImportManager();
private readonly LeagcyImportManager leagcyImportManager = new LeagcyImportManager();

[Cached]
private readonly ScreenshotManager screenshotManager = new ScreenshotManager();
Expand Down Expand Up @@ -782,7 +782,7 @@ protected override void LoadComplete()
PostNotification = n => Notifications.Post(n),
}, Add, true);

loadComponentSingleFile(stableImportManager, Add);
loadComponentSingleFile(leagcyImportManager, Add);

loadComponentSingleFile(screenshotManager, Add);

Expand Down
Expand Up @@ -31,17 +31,17 @@ public class GeneralSettings : SettingsSubsection
private SettingsButton undeleteButton;

[BackgroundDependencyLoader(permitNulls: true)]
private void load(BeatmapManager beatmaps, ScoreManager scores, SkinManager skins, [CanBeNull] CollectionManager collectionManager, [CanBeNull] StableImportManager stableImportManager, DialogOverlay dialogOverlay)
private void load(BeatmapManager beatmaps, ScoreManager scores, SkinManager skins, [CanBeNull] CollectionManager collectionManager, [CanBeNull] LeagcyImportManager leagcyImportManager, DialogOverlay dialogOverlay)
{
if (stableImportManager?.SupportsImportFromStable == true)
if (leagcyImportManager?.SupportsImportFromStable == true)
{
Add(importBeatmapsButton = new SettingsButton
{
Text = MaintenanceSettingsStrings.ImportBeatmapsFromStable,
Action = () =>
{
importBeatmapsButton.Enabled.Value = false;
stableImportManager.ImportFromStableAsync(StableContent.Beatmaps).ContinueWith(t => Schedule(() => importBeatmapsButton.Enabled.Value = true));
leagcyImportManager.ImportFromStableAsync(StableContent.Beatmaps).ContinueWith(t => Schedule(() => importBeatmapsButton.Enabled.Value = true));
}
});
}
Expand All @@ -59,15 +59,15 @@ private void load(BeatmapManager beatmaps, ScoreManager scores, SkinManager skin
}
});

if (stableImportManager?.SupportsImportFromStable == true)
if (leagcyImportManager?.SupportsImportFromStable == true)
{
Add(importScoresButton = new SettingsButton
{
Text = MaintenanceSettingsStrings.ImportScoresFromStable,
Action = () =>
{
importScoresButton.Enabled.Value = false;
stableImportManager.ImportFromStableAsync(StableContent.Scores).ContinueWith(t => Schedule(() => importScoresButton.Enabled.Value = true));
leagcyImportManager.ImportFromStableAsync(StableContent.Scores).ContinueWith(t => Schedule(() => importScoresButton.Enabled.Value = true));
}
});
}
Expand All @@ -85,15 +85,15 @@ private void load(BeatmapManager beatmaps, ScoreManager scores, SkinManager skin
}
});

if (stableImportManager?.SupportsImportFromStable == true)
if (leagcyImportManager?.SupportsImportFromStable == true)
{
Add(importSkinsButton = new SettingsButton
{
Text = MaintenanceSettingsStrings.ImportSkinsFromStable,
Action = () =>
{
importSkinsButton.Enabled.Value = false;
stableImportManager.ImportFromStableAsync(StableContent.Skins).ContinueWith(t => Schedule(() => importSkinsButton.Enabled.Value = true));
leagcyImportManager.ImportFromStableAsync(StableContent.Skins).ContinueWith(t => Schedule(() => importSkinsButton.Enabled.Value = true));
}
});
}
Expand All @@ -113,15 +113,15 @@ private void load(BeatmapManager beatmaps, ScoreManager scores, SkinManager skin

if (collectionManager != null)
{
if (stableImportManager?.SupportsImportFromStable == true)
if (leagcyImportManager?.SupportsImportFromStable == true)
{
Add(importCollectionsButton = new SettingsButton
{
Text = MaintenanceSettingsStrings.ImportCollectionsFromStable,
Action = () =>
{
importCollectionsButton.Enabled.Value = false;
stableImportManager.ImportFromStableAsync(StableContent.Collections).ContinueWith(t => Schedule(() => importCollectionsButton.Enabled.Value = true));
leagcyImportManager.ImportFromStableAsync(StableContent.Collections).ContinueWith(t => Schedule(() => importCollectionsButton.Enabled.Value = true));
}
});
}
Expand Down
6 changes: 3 additions & 3 deletions osu.Game/Screens/Select/SongSelect.cs
Expand Up @@ -51,7 +51,7 @@ public abstract class SongSelect : ScreenWithBeatmapBackground, IKeyBindingHandl

protected virtual bool ShowFooter => true;

protected virtual bool DisplayStableImportPrompt => stableImportManager?.SupportsImportFromStable == true;
protected virtual bool DisplayStableImportPrompt => leagcyImportManager?.SupportsImportFromStable == true;

public override bool? AllowTrackAdjustments => true;

Expand Down Expand Up @@ -90,7 +90,7 @@ public abstract class SongSelect : ScreenWithBeatmapBackground, IKeyBindingHandl
private BeatmapManager beatmaps { get; set; }

[Resolved(CanBeNull = true)]
private StableImportManager stableImportManager { get; set; }
private LeagcyImportManager leagcyImportManager { get; set; }

protected ModSelectOverlay ModSelect { get; private set; }

Expand Down Expand Up @@ -297,7 +297,7 @@ private void load(AudioManager audio, DialogOverlay dialog, OsuColour colours, M
{
dialogOverlay.Push(new ImportFromStablePopup(() =>
{
Task.Run(() => stableImportManager.ImportFromStableAsync(StableContent.All));
Task.Run(() => leagcyImportManager.ImportFromStableAsync(StableContent.All));
}));
}
});
Expand Down

0 comments on commit 9dcb20a

Please sign in to comment.