mirror of https://github.com/ppy/osu
72 lines
2.5 KiB
C#
72 lines
2.5 KiB
C#
// 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.
|
|
|
|
#nullable disable
|
|
|
|
using System.Collections.Generic;
|
|
using System.IO;
|
|
using osu.Framework.Platform;
|
|
using osu.Game.Extensions;
|
|
using osu.Game.Utils;
|
|
using SharpCompress.Archives.Zip;
|
|
|
|
namespace osu.Game.Database
|
|
{
|
|
/// <summary>
|
|
/// A class which handles exporting legacy user data of a single type from osu-stable.
|
|
/// </summary>
|
|
public abstract class LegacyExporter<TModel>
|
|
where TModel : class, IHasNamedFiles
|
|
{
|
|
/// <summary>
|
|
/// The file extension for exports (including the leading '.').
|
|
/// </summary>
|
|
protected abstract string FileExtension { get; }
|
|
|
|
protected readonly Storage UserFileStorage;
|
|
|
|
private readonly Storage exportStorage;
|
|
|
|
protected LegacyExporter(Storage storage)
|
|
{
|
|
exportStorage = storage.GetStorageForDirectory(@"exports");
|
|
UserFileStorage = storage.GetStorageForDirectory(@"files");
|
|
}
|
|
|
|
protected virtual string GetFilename(TModel item) => item.GetDisplayString();
|
|
|
|
/// <summary>
|
|
/// Exports an item to a legacy (.zip based) package.
|
|
/// </summary>
|
|
/// <param name="item">The item to export.</param>
|
|
public void Export(TModel item)
|
|
{
|
|
string itemFilename = GetFilename(item).GetValidFilename();
|
|
|
|
IEnumerable<string> existingExports = exportStorage.GetFiles("", $"{itemFilename}*{FileExtension}");
|
|
|
|
string filename = NamingUtils.GetNextBestFilename(existingExports, $"{itemFilename}{FileExtension}");
|
|
using (var stream = exportStorage.CreateFileSafely(filename))
|
|
ExportModelTo(item, stream);
|
|
|
|
exportStorage.PresentFileExternally(filename);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Exports an item to the given output stream.
|
|
/// </summary>
|
|
/// <param name="model">The item to export.</param>
|
|
/// <param name="outputStream">The output stream to export to.</param>
|
|
public virtual void ExportModelTo(TModel model, Stream outputStream)
|
|
{
|
|
using (var archive = ZipArchive.Create())
|
|
{
|
|
foreach (var file in model.Files)
|
|
archive.AddEntry(file.Filename, UserFileStorage.GetStream(file.File.GetStoragePath()));
|
|
|
|
archive.SaveTo(outputStream);
|
|
}
|
|
}
|
|
}
|
|
}
|