h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2025-01-28 02:43:19 +08:00
Code Issues Releases Wiki Activity

Add basic check for correct ruleset API version

Browse Source
This commit is contained in:
Dean Herbert 2022-08-22 16:31:25 +09:00
parent f5710d8000
commit 758a554180
1 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
osu.Game/Rulesets/RealmRulesetStore.cs
View File

@ -77,9 +77,16 @@ namespace osu.Game.Rulesets
continue; continue;
} }
var instanceInfo = (Activator.CreateInstance(resolvedType) as Ruleset)?.RulesetInfo var instance = (Activator.CreateInstance(resolvedType) as Ruleset);
var instanceInfo = instance?.RulesetInfo
?? throw new RulesetLoadException(@"Instantiation failure"); ?? throw new RulesetLoadException(@"Instantiation failure");
if (!checkRulesetUpToDate(instance))
{
throw new ArgumentOutOfRangeException(nameof(instance.RulesetAPIVersionSupported),
$"Ruleset API version is too old (was {instance.RulesetAPIVersionSupported}, expected {Ruleset.CURRENT_RULESET_API_VERSION})");
}
// If a ruleset isn't up-to-date with the API, it could cause a crash at an arbitrary point of execution. // If a ruleset isn't up-to-date with the API, it could cause a crash at an arbitrary point of execution.
// To eagerly handle cases of missing implementations, enumerate all types here and mark as non-available on throw. // To eagerly handle cases of missing implementations, enumerate all types here and mark as non-available on throw.
resolvedType.Assembly.GetTypes(); resolvedType.Assembly.GetTypes();
@ -104,6 +111,25 @@ namespace osu.Game.Rulesets
}); });
} }
private bool checkRulesetUpToDate(Ruleset instance)
{
switch (instance.RulesetAPIVersionSupported)
{
// The default `virtual` implementation leaves the version string empty.
// Consider rulesets which haven't override the version as up-to-date for now.
// At some point (once ruleset devs add versioning), we'll probably want to disallow this for deployed builds.
case @"":
// Rulesets which are bundled with the game. Saves having to update their versions each bump.
case @"internal":
// Ruleset is up-to-date, all good.
case Ruleset.CURRENT_RULESET_API_VERSION:
return true;
default:
return false;
}
}
private void testRulesetCompatibility(RulesetInfo rulesetInfo) private void testRulesetCompatibility(RulesetInfo rulesetInfo)
{ {
// do various operations to ensure that we are in a good state. // do various operations to ensure that we are in a good state.