// Copyright (c) 2007-2017 ppy Pty Ltd . // Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE using System; using System.Collections.Generic; using System.IO; using System.Linq; using Ionic.Zip; using osu.Framework.Extensions; using osu.Framework.Logging; using osu.Framework.Platform; using osu.Game.Beatmaps.Formats; using osu.Game.Beatmaps.IO; using osu.Game.IO; using osu.Game.IPC; using osu.Game.Rulesets; using SQLite.Net; using FileInfo = osu.Game.IO.FileInfo; namespace osu.Game.Beatmaps { /// /// Handles the storage and retrieval of Beatmaps/WorkingBeatmaps. /// public class BeatmapStore { // todo: make this private public readonly BeatmapDatabase Database; /// /// Fired when a new becomes available in the database. /// public event Action BeatmapSetAdded; /// /// Fired when a is removed from the database. /// public event Action BeatmapSetRemoved; /// /// A default representation of a WorkingBeatmap to use when no beatmap is available. /// public WorkingBeatmap DefaultBeatmap { private get; set; } private readonly Storage storage; private readonly FileDatabase files; private readonly RulesetDatabase rulesets; // ReSharper disable once NotAccessedField.Local (we should keep a reference to this so it is not finalised) private BeatmapIPCChannel ipc; public BeatmapStore(Storage storage, FileDatabase files, SQLiteConnection connection, RulesetDatabase rulesets, IIpcHost importHost = null) { Database = new BeatmapDatabase(connection); Database.BeatmapSetAdded += s => BeatmapSetAdded?.Invoke(s); Database.BeatmapSetRemoved += s => BeatmapSetRemoved?.Invoke(s); this.storage = storage; this.files = files; this.rulesets = rulesets; if (importHost != null) ipc = new BeatmapIPCChannel(importHost, this); } /// /// Import multiple from filesystem . /// /// Multiple locations on disk. public void Import(params string[] paths) { foreach (string path in paths) { try { using (ArchiveReader reader = getReaderFrom(path)) Import(reader); // We may or may not want to delete the file depending on where it is stored. // e.g. reconstructing/repairing database with beatmaps from default storage. // Also, not always a single file, i.e. for LegacyFilesystemReader // TODO: Add a check to prevent files from storage to be deleted. try { File.Delete(path); } catch (Exception e) { Logger.Error(e, $@"Could not delete file at {path}"); } } catch (Exception e) { e = e.InnerException ?? e; Logger.Error(e, @"Could not import beatmap set"); } } } /// /// Import a beatmap from an . /// /// The beatmap to be imported. public BeatmapSetInfo Import(ArchiveReader archiveReader) { BeatmapSetInfo set = importToStorage(archiveReader); //If we have an ID then we already exist in the database. if (set.ID == 0) Database.Add(set); return set; } /// /// Delete a beatmap from the store. /// Is a no-op for already deleted beatmaps. /// /// The beatmap to delete. public void Delete(BeatmapSetInfo beatmapSet) { if (!Database.Delete(beatmapSet)) return; if (!beatmapSet.Protected) files.Dereference(beatmapSet.Files); } /// /// Returns a to a usable state if it has previously been deleted but not yet purged. /// Is a no-op for already usable beatmaps. /// /// The beatmap to restore. public void Undelete(BeatmapSetInfo beatmapSet) { if (!Database.Undelete(beatmapSet)) return; files.Reference(beatmapSet.Files); } /// /// Retrieve a instance for the provided /// /// The beatmap to lookup. /// The currently loaded . Allows for optimisation where elements are shared with the new beatmap. /// A instance correlating to the provided . public WorkingBeatmap GetWorkingBeatmap(BeatmapInfo beatmapInfo, WorkingBeatmap previous = null) { if (beatmapInfo == null || beatmapInfo == DefaultBeatmap?.BeatmapInfo) return DefaultBeatmap; beatmapInfo = Database.GetChildren(beatmapInfo, true); Database.GetChildren(beatmapInfo.BeatmapSet, true); if (beatmapInfo.BeatmapSet == null) throw new InvalidOperationException($@"Beatmap set {beatmapInfo.BeatmapSetInfoID} is not in the local database."); if (beatmapInfo.Metadata == null) beatmapInfo.Metadata = beatmapInfo.BeatmapSet.Metadata; WorkingBeatmap working = new BeatmapStoreWorkingBeatmap(files.Store, beatmapInfo); previous?.TransferTo(working); return working; } /// /// Reset the store to an empty state. /// public void Reset() { Database.Reset(); } /// /// Perform a lookup query on available s. /// /// The query. /// The first result for the provided query, or null if no results were found. public BeatmapSetInfo QueryBeatmapSet(Func query) { BeatmapSetInfo set = Database.Query().FirstOrDefault(query); if (set != null) Database.GetChildren(set, true); return set; } /// /// Creates an from a valid storage path. /// /// A file or folder path resolving the beatmap content. /// A reader giving access to the beatmap's content. private ArchiveReader getReaderFrom(string path) { if (ZipFile.IsZipFile(path)) return new OszArchiveReader(storage.GetStream(path)); else return new LegacyFilesystemReader(path); } /// /// Import a beamap into our local storage. /// If the beatmap is already imported, the existing instance will be returned. /// /// The beatmap archive to be read. /// The imported beatmap, or an existing instance if it is already present. private BeatmapSetInfo importToStorage(ArchiveReader reader) { BeatmapMetadata metadata; using (var stream = new StreamReader(reader.GetStream(reader.Filenames.First(f => f.EndsWith(".osu"))))) metadata = BeatmapDecoder.GetDecoder(stream).Decode(stream).Metadata; MemoryStream hashable = new MemoryStream(); List fileInfos = new List(); foreach (string file in reader.Filenames) { using (Stream s = reader.GetStream(file)) { fileInfos.Add(files.Add(s, file)); s.CopyTo(hashable); } } var overallHash = hashable.GetMd5Hash(); var existing = Database.Query().FirstOrDefault(b => b.Hash == overallHash); if (existing != null) { Database.GetChildren(existing); Undelete(existing); return existing; } var beatmapSet = new BeatmapSetInfo { OnlineBeatmapSetID = metadata.OnlineBeatmapSetID, Beatmaps = new List(), Hash = overallHash, Files = fileInfos, Metadata = metadata }; var mapNames = reader.Filenames.Where(f => f.EndsWith(".osu")); foreach (var name in mapNames) { using (var raw = reader.GetStream(name)) using (var ms = new MemoryStream()) //we need a memory stream so we can seek and shit using (var sr = new StreamReader(ms)) { raw.CopyTo(ms); ms.Position = 0; var decoder = BeatmapDecoder.GetDecoder(sr); Beatmap beatmap = decoder.Decode(sr); beatmap.BeatmapInfo.Path = name; beatmap.BeatmapInfo.Hash = ms.GetMd5Hash(); // TODO: Diff beatmap metadata with set metadata and leave it here if necessary beatmap.BeatmapInfo.Metadata = null; // TODO: this should be done in a better place once we actually need to dynamically update it. beatmap.BeatmapInfo.Ruleset = rulesets.Query().FirstOrDefault(r => r.ID == beatmap.BeatmapInfo.RulesetID); beatmap.BeatmapInfo.StarDifficulty = rulesets.Query().FirstOrDefault(r => r.ID == beatmap.BeatmapInfo.RulesetID)?.CreateInstance()?.CreateDifficultyCalculator(beatmap) .Calculate() ?? 0; beatmapSet.Beatmaps.Add(beatmap.BeatmapInfo); } } return beatmapSet; } } }