// Copyright (c) ppy Pty Ltd . 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.Diagnostics; using System.Linq; using System.Threading; using Newtonsoft.Json; using osu.Framework.Logging; using osu.Framework.Platform; using osu.Game.Beatmaps; using osu.Game.Database; using osu.Game.IO.Archives; using osu.Game.Rulesets; using osu.Game.Scoring.Legacy; using osu.Game.Online.API; using osu.Game.Online.API.Requests; using osu.Game.Online.API.Requests.Responses; using Realms; namespace osu.Game.Scoring { public class ScoreImporter : RealmArchiveModelImporter { public override IEnumerable HandledExtensions => new[] { ".osr" }; protected override string[] HashableFileTypes => new[] { ".osr" }; private readonly RulesetStore rulesets; private readonly Func beatmaps; private readonly IAPIProvider api; public ScoreImporter(RulesetStore rulesets, Func beatmaps, Storage storage, RealmAccess realm, IAPIProvider api) : base(storage, realm) { this.rulesets = rulesets; this.beatmaps = beatmaps; this.api = api; } protected override ScoreInfo? CreateModel(ArchiveReader archive, ImportParameters parameters) { string name = archive.Filenames.First(f => f.EndsWith(".osr", StringComparison.OrdinalIgnoreCase)); using (var stream = archive.GetStream(name)) { try { return new DatabasedLegacyScoreDecoder(rulesets, beatmaps()).Parse(stream).ScoreInfo; } catch (LegacyScoreDecoder.BeatmapNotFoundException notFound) { Logger.Log($@"Score '{archive.Name}' failed to import: no corresponding beatmap with the hash '{notFound.Hash}' could be found.", LoggingTarget.Database); if (!parameters.Batch) { // In the case of a missing beatmap, let's attempt to resolve it and show a prompt to the user to download the required beatmap. var req = new GetBeatmapRequest(new BeatmapInfo { MD5Hash = notFound.Hash }); req.Success += res => PostNotification?.Invoke(new MissingBeatmapNotification(res, archive, notFound.Hash)); api.Queue(req); } return null; } catch (Exception e) { Logger.Log($@"Failed to parse headers of score '{archive.Name}': {e}.", LoggingTarget.Database); return null; } } } public Score GetScore(ScoreInfo score) => new LegacyDatabasedScore(score, rulesets, beatmaps(), Files.Store); protected override void Populate(ScoreInfo model, ArchiveReader? archive, Realm realm, CancellationToken cancellationToken = default) { Debug.Assert(model.BeatmapInfo != null); // Ensure the beatmap is not detached. if (!model.BeatmapInfo.IsManaged) model.BeatmapInfo = realm.Find(model.BeatmapInfo.ID)!; if (!model.Ruleset.IsManaged) model.Ruleset = realm.Find(model.Ruleset.ShortName)!; // These properties are known to be non-null, but these final checks ensure a null hasn't come from somewhere (or the refetch has failed). // Under no circumstance do we want these to be written to realm as null. ArgumentNullException.ThrowIfNull(model.BeatmapInfo); ArgumentNullException.ThrowIfNull(model.Ruleset); if (string.IsNullOrEmpty(model.StatisticsJson)) model.StatisticsJson = JsonConvert.SerializeObject(model.Statistics); if (string.IsNullOrEmpty(model.MaximumStatisticsJson)) model.MaximumStatisticsJson = JsonConvert.SerializeObject(model.MaximumStatistics); // for pre-ScoreV2 lazer scores, apply a best-effort conversion of total score to ScoreV2. // this requires: max combo, statistics, max statistics (where available), and mods to already be populated on the score. if (StandardisedScoreMigrationTools.ShouldMigrateToNewStandardised(model)) model.TotalScore = StandardisedScoreMigrationTools.GetNewStandardised(model); } // Very naive local caching to improve performance of large score imports (where the username is usually the same for most or all scores). // TODO: `UserLookupCache` cannot currently be used here because of async foibles. // It only supports lookups by user ID (username would require web changes), and even then the ID lookups cannot be used. // That is because that component provides an async interface, and async functions cannot be consumed safely here due to the rigid structure of `RealmArchiveModelImporter`. // The importer has two paths, one async and one sync; the async path runs the sync path in a task. // This means that sometimes `PostImport()` is called from a sync context, and sometimes from an async one, whilst itself being a sync method. // That in turn makes `.GetResultSafely()` not callable inside `PostImport()`, as it will throw when called from an async context, private readonly Dictionary idLookupCache = new Dictionary(); private readonly Dictionary usernameLookupCache = new Dictionary(); protected override void PostImport(ScoreInfo model, Realm realm, ImportParameters parameters) { base.PostImport(model, realm, parameters); populateUserDetails(model); Debug.Assert(model.BeatmapInfo != null); // This needs to be run after user detail population to ensure we have a valid user id. if (api.IsLoggedIn && api.LocalUser.Value.OnlineID == model.UserID && (model.BeatmapInfo.LastPlayed == null || model.Date > model.BeatmapInfo.LastPlayed)) model.BeatmapInfo.LastPlayed = model.Date; } /// /// Legacy replays only store a username. /// This will populate a user ID during import. /// private void populateUserDetails(ScoreInfo model) { if (model.RealmUser.OnlineID == APIUser.SYSTEM_USER_ID) return; if (model.RealmUser.OnlineID > 1) { model.User = lookupUserById(model.RealmUser.OnlineID) ?? model.User; return; } if (model.OnlineID < 0 && model.LegacyOnlineID <= 0) return; model.User = lookupUserByName(model.RealmUser.Username) ?? model.User; } private APIUser? lookupUserById(int id) { if (idLookupCache.TryGetValue(id, out var existing)) { return existing; } var userRequest = new GetUserRequest(id); api.Perform(userRequest); if (userRequest.Response is APIUser user) { APIUser cachedUser; idLookupCache.TryAdd(id, cachedUser = new APIUser { // Because this is a permanent cache, let's only store the pieces we're interested in, // rather than the full API response. If we start to store more than these three fields // in realm, this should be undone. Id = user.Id, Username = user.Username, CountryCode = user.CountryCode, }); return cachedUser; } return null; } private APIUser? lookupUserByName(string username) { if (usernameLookupCache.TryGetValue(username, out var existing)) { return existing; } var userRequest = new GetUserRequest(username); api.Perform(userRequest); if (userRequest.Response is APIUser user) { APIUser cachedUser; usernameLookupCache.TryAdd(username, cachedUser = new APIUser { // Because this is a permanent cache, let's only store the pieces we're interested in, // rather than the full API response. If we start to store more than these three fields // in realm, this should be undone. Id = user.Id, Username = user.Username, CountryCode = user.CountryCode, }); return cachedUser; } return null; } } }