diff options
Diffstat (limited to 'src/StardewModdingAPI/Framework/ModLoading')
9 files changed, 0 insertions, 907 deletions
diff --git a/src/StardewModdingAPI/Framework/ModLoading/AssemblyDefinitionResolver.cs b/src/StardewModdingAPI/Framework/ModLoading/AssemblyDefinitionResolver.cs deleted file mode 100644 index 4378798c..00000000 --- a/src/StardewModdingAPI/Framework/ModLoading/AssemblyDefinitionResolver.cs +++ /dev/null @@ -1,61 +0,0 @@ -using System.Collections.Generic; -using Mono.Cecil; - -namespace StardewModdingAPI.Framework.ModLoading -{ - /// <summary>A minimal assembly definition resolver which resolves references to known assemblies.</summary> - internal class AssemblyDefinitionResolver : DefaultAssemblyResolver - { - /********* - ** Properties - *********/ - /// <summary>The known assemblies.</summary> - private readonly IDictionary<string, AssemblyDefinition> Loaded = new Dictionary<string, AssemblyDefinition>(); - - - /********* - ** Public methods - *********/ - /// <summary>Add known assemblies to the resolver.</summary> - /// <param name="assemblies">The known assemblies.</param> - public void Add(params AssemblyDefinition[] assemblies) - { - foreach (AssemblyDefinition assembly in assemblies) - { - this.Loaded[assembly.Name.Name] = assembly; - this.Loaded[assembly.Name.FullName] = assembly; - } - } - - /// <summary>Resolve an assembly reference.</summary> - /// <param name="name">The assembly name.</param> - public override AssemblyDefinition Resolve(AssemblyNameReference name) => this.ResolveName(name.Name) ?? base.Resolve(name); - - /// <summary>Resolve an assembly reference.</summary> - /// <param name="name">The assembly name.</param> - /// <param name="parameters">The assembly reader parameters.</param> - public override AssemblyDefinition Resolve(AssemblyNameReference name, ReaderParameters parameters) => this.ResolveName(name.Name) ?? base.Resolve(name, parameters); - - /// <summary>Resolve an assembly reference.</summary> - /// <param name="fullName">The assembly full name (including version, etc).</param> - public override AssemblyDefinition Resolve(string fullName) => this.ResolveName(fullName) ?? base.Resolve(fullName); - - /// <summary>Resolve an assembly reference.</summary> - /// <param name="fullName">The assembly full name (including version, etc).</param> - /// <param name="parameters">The assembly reader parameters.</param> - public override AssemblyDefinition Resolve(string fullName, ReaderParameters parameters) => this.ResolveName(fullName) ?? base.Resolve(fullName, parameters); - - - /********* - ** Private methods - *********/ - /// <summary>Resolve a known assembly definition based on its short or full name.</summary> - /// <param name="name">The assembly's short or full name.</param> - private AssemblyDefinition ResolveName(string name) - { - return this.Loaded.ContainsKey(name) - ? this.Loaded[name] - : null; - } - } -} diff --git a/src/StardewModdingAPI/Framework/ModLoading/AssemblyLoadStatus.cs b/src/StardewModdingAPI/Framework/ModLoading/AssemblyLoadStatus.cs deleted file mode 100644 index 11be19fc..00000000 --- a/src/StardewModdingAPI/Framework/ModLoading/AssemblyLoadStatus.cs +++ /dev/null @@ -1,15 +0,0 @@ -namespace StardewModdingAPI.Framework.ModLoading -{ - /// <summary>Indicates the result of an assembly load.</summary> - internal enum AssemblyLoadStatus - { - /// <summary>The assembly was loaded successfully.</summary> - Okay = 1, - - /// <summary>The assembly could not be loaded.</summary> - Failed = 2, - - /// <summary>The assembly is already loaded.</summary> - AlreadyLoaded = 3 - } -} diff --git a/src/StardewModdingAPI/Framework/ModLoading/AssemblyLoader.cs b/src/StardewModdingAPI/Framework/ModLoading/AssemblyLoader.cs deleted file mode 100644 index 9c642bef..00000000 --- a/src/StardewModdingAPI/Framework/ModLoading/AssemblyLoader.cs +++ /dev/null @@ -1,309 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using System.Linq; -using System.Reflection; -using Mono.Cecil; -using Mono.Cecil.Cil; -using StardewModdingAPI.AssemblyRewriters; -using StardewModdingAPI.Framework.Exceptions; - -namespace StardewModdingAPI.Framework.ModLoading -{ - /// <summary>Preprocesses and loads mod assemblies.</summary> - internal class AssemblyLoader - { - /********* - ** Properties - *********/ - /// <summary>Metadata for mapping assemblies to the current platform.</summary> - private readonly PlatformAssemblyMap AssemblyMap; - - /// <summary>A type => assembly lookup for types which should be rewritten.</summary> - private readonly IDictionary<string, Assembly> TypeAssemblies; - - /// <summary>Encapsulates monitoring and logging.</summary> - private readonly IMonitor Monitor; - - - /********* - ** Public methods - *********/ - /// <summary>Construct an instance.</summary> - /// <param name="targetPlatform">The current game platform.</param> - /// <param name="monitor">Encapsulates monitoring and logging.</param> - public AssemblyLoader(Platform targetPlatform, IMonitor monitor) - { - this.Monitor = monitor; - this.AssemblyMap = Constants.GetAssemblyMap(targetPlatform); - - // generate type => assembly lookup for types which should be rewritten - this.TypeAssemblies = new Dictionary<string, Assembly>(); - foreach (Assembly assembly in this.AssemblyMap.Targets) - { - ModuleDefinition module = this.AssemblyMap.TargetModules[assembly]; - foreach (TypeDefinition type in module.GetTypes()) - { - if (!type.IsPublic) - continue; // no need to rewrite - if (type.Namespace.Contains("<")) - continue; // ignore assembly metadata - this.TypeAssemblies[type.FullName] = assembly; - } - } - } - - /// <summary>Preprocess and load an assembly.</summary> - /// <param name="assemblyPath">The assembly file path.</param> - /// <param name="assumeCompatible">Assume the mod is compatible, even if incompatible code is detected.</param> - /// <returns>Returns the rewrite metadata for the preprocessed assembly.</returns> - /// <exception cref="IncompatibleInstructionException">An incompatible CIL instruction was found while rewriting the assembly.</exception> - public Assembly Load(string assemblyPath, bool assumeCompatible) - { - // get referenced local assemblies - AssemblyParseResult[] assemblies; - { - AssemblyDefinitionResolver resolver = new AssemblyDefinitionResolver(); - HashSet<string> visitedAssemblyNames = new HashSet<string>(AppDomain.CurrentDomain.GetAssemblies().Select(p => p.GetName().Name)); // don't try loading assemblies that are already loaded - assemblies = this.GetReferencedLocalAssemblies(new FileInfo(assemblyPath), visitedAssemblyNames, resolver).ToArray(); - } - - // validate load - if (!assemblies.Any() || assemblies[0].Status == AssemblyLoadStatus.Failed) - { - throw new SAssemblyLoadFailedException(!File.Exists(assemblyPath) - ? $"Could not load '{assemblyPath}' because it doesn't exist." - : $"Could not load '{assemblyPath}'." - ); - } - if (assemblies.Last().Status == AssemblyLoadStatus.AlreadyLoaded) // mod assembly is last in dependency order - throw new SAssemblyLoadFailedException($"Could not load '{assemblyPath}' because it was already loaded. Do you have two copies of this mod?"); - - // rewrite & load assemblies in leaf-to-root order - bool oneAssembly = assemblies.Length == 1; - Assembly lastAssembly = null; - foreach (AssemblyParseResult assembly in assemblies) - { - if (assembly.Status == AssemblyLoadStatus.AlreadyLoaded) - continue; - - bool changed = this.RewriteAssembly(assembly.Definition, assumeCompatible, logPrefix: " "); - if (changed) - { - if (!oneAssembly) - this.Monitor.Log($" Loading {assembly.File.Name} (rewritten in memory)...", LogLevel.Trace); - using (MemoryStream outStream = new MemoryStream()) - { - assembly.Definition.Write(outStream); - byte[] bytes = outStream.ToArray(); - lastAssembly = Assembly.Load(bytes); - } - } - else - { - if (!oneAssembly) - this.Monitor.Log($" Loading {assembly.File.Name}...", LogLevel.Trace); - lastAssembly = Assembly.UnsafeLoadFrom(assembly.File.FullName); - } - } - - // last assembly loaded is the root - return lastAssembly; - } - - /// <summary>Resolve an assembly by its name.</summary> - /// <param name="name">The assembly name.</param> - /// <remarks> - /// This implementation returns the first loaded assembly which matches the short form of - /// the assembly name, to resolve assembly resolution issues when rewriting - /// assemblies (especially with Mono). Since this is meant to be called on <see cref="AppDomain.AssemblyResolve"/>, - /// the implicit assumption is that loading the exact assembly failed. - /// </remarks> - public Assembly ResolveAssembly(string name) - { - string shortName = name.Split(new[] { ',' }, 2).First(); // get simple name (without version and culture) - return AppDomain.CurrentDomain - .GetAssemblies() - .FirstOrDefault(p => p.GetName().Name == shortName); - } - - - /********* - ** Private methods - *********/ - /**** - ** Assembly parsing - ****/ - /// <summary>Get a list of referenced local assemblies starting from the mod assembly, ordered from leaf to root.</summary> - /// <param name="file">The assembly file to load.</param> - /// <param name="visitedAssemblyNames">The assembly names that should be skipped.</param> - /// <param name="assemblyResolver">A resolver which resolves references to known assemblies.</param> - /// <returns>Returns the rewrite metadata for the preprocessed assembly.</returns> - private IEnumerable<AssemblyParseResult> GetReferencedLocalAssemblies(FileInfo file, HashSet<string> visitedAssemblyNames, IAssemblyResolver assemblyResolver) - { - // validate - if (file.Directory == null) - throw new InvalidOperationException($"Could not get directory from file path '{file.FullName}'."); - if (!file.Exists) - yield break; // not a local assembly - - // read assembly - byte[] assemblyBytes = File.ReadAllBytes(file.FullName); - AssemblyDefinition assembly; - using (Stream readStream = new MemoryStream(assemblyBytes)) - assembly = AssemblyDefinition.ReadAssembly(readStream, new ReaderParameters(ReadingMode.Deferred) { AssemblyResolver = assemblyResolver }); - - // skip if already visited - if (visitedAssemblyNames.Contains(assembly.Name.Name)) - yield return new AssemblyParseResult(file, null, AssemblyLoadStatus.AlreadyLoaded); - visitedAssemblyNames.Add(assembly.Name.Name); - - // yield referenced assemblies - foreach (AssemblyNameReference dependency in assembly.MainModule.AssemblyReferences) - { - FileInfo dependencyFile = new FileInfo(Path.Combine(file.Directory.FullName, $"{dependency.Name}.dll")); - foreach (AssemblyParseResult result in this.GetReferencedLocalAssemblies(dependencyFile, visitedAssemblyNames, assemblyResolver)) - yield return result; - } - - // yield assembly - yield return new AssemblyParseResult(file, assembly, AssemblyLoadStatus.Okay); - } - - /**** - ** Assembly rewriting - ****/ - /// <summary>Rewrite the types referenced by an assembly.</summary> - /// <param name="assembly">The assembly to rewrite.</param> - /// <param name="assumeCompatible">Assume the mod is compatible, even if incompatible code is detected.</param> - /// <param name="logPrefix">A string to prefix to log messages.</param> - /// <returns>Returns whether the assembly was modified.</returns> - /// <exception cref="IncompatibleInstructionException">An incompatible CIL instruction was found while rewriting the assembly.</exception> - private bool RewriteAssembly(AssemblyDefinition assembly, bool assumeCompatible, string logPrefix) - { - ModuleDefinition module = assembly.MainModule; - HashSet<string> loggedMessages = new HashSet<string>(); - string filename = $"{assembly.Name.Name}.dll"; - - // swap assembly references if needed (e.g. XNA => MonoGame) - bool platformChanged = false; - for (int i = 0; i < module.AssemblyReferences.Count; i++) - { - // remove old assembly reference - if (this.AssemblyMap.RemoveNames.Any(name => module.AssemblyReferences[i].Name == name)) - { - this.LogOnce(this.Monitor, loggedMessages, $"{logPrefix}Rewriting {filename} for OS..."); - platformChanged = true; - module.AssemblyReferences.RemoveAt(i); - i--; - } - } - if (platformChanged) - { - // add target assembly references - foreach (AssemblyNameReference target in this.AssemblyMap.TargetReferences.Values) - module.AssemblyReferences.Add(target); - - // rewrite type scopes to use target assemblies - IEnumerable<TypeReference> typeReferences = module.GetTypeReferences().OrderBy(p => p.FullName); - foreach (TypeReference type in typeReferences) - this.ChangeTypeScope(type); - } - - // find (and optionally rewrite) incompatible instructions - bool anyRewritten = false; - IInstructionRewriter[] rewriters = Constants.GetRewriters().ToArray(); - foreach (MethodDefinition method in this.GetMethods(module)) - { - // check method definition - foreach (IInstructionRewriter rewriter in rewriters) - { - try - { - if (rewriter.Rewrite(module, method, this.AssemblyMap, platformChanged)) - { - this.LogOnce(this.Monitor, loggedMessages, $"{logPrefix}Rewrote {filename} to fix {rewriter.NounPhrase}..."); - anyRewritten = true; - } - } - catch (IncompatibleInstructionException) - { - if (!assumeCompatible) - throw new IncompatibleInstructionException(rewriter.NounPhrase, $"Found an incompatible CIL instruction ({rewriter.NounPhrase}) while loading assembly {filename}."); - this.LogOnce(this.Monitor, loggedMessages, $"{logPrefix}Found an incompatible CIL instruction ({rewriter.NounPhrase}) while loading assembly {filename}, but SMAPI is configured to allow it anyway. The mod may crash or behave unexpectedly.", LogLevel.Warn); - } - } - - // check CIL instructions - ILProcessor cil = method.Body.GetILProcessor(); - foreach (Instruction instruction in cil.Body.Instructions.ToArray()) - { - foreach (IInstructionRewriter rewriter in rewriters) - { - try - { - if (rewriter.Rewrite(module, cil, instruction, this.AssemblyMap, platformChanged)) - { - this.LogOnce(this.Monitor, loggedMessages, $"{logPrefix}Rewrote {filename} to fix {rewriter.NounPhrase}..."); - anyRewritten = true; - } - } - catch (IncompatibleInstructionException) - { - if (!assumeCompatible) - throw new IncompatibleInstructionException(rewriter.NounPhrase, $"Found an incompatible CIL instruction ({rewriter.NounPhrase}) while loading assembly {filename}."); - this.LogOnce(this.Monitor, loggedMessages, $"{logPrefix}Found an incompatible CIL instruction ({rewriter.NounPhrase}) while loading assembly {filename}, but SMAPI is configured to allow it anyway. The mod may crash or behave unexpectedly.", LogLevel.Warn); - } - } - } - } - - return platformChanged || anyRewritten; - } - - /// <summary>Get the correct reference to use for compatibility with the current platform.</summary> - /// <param name="type">The type reference to rewrite.</param> - private void ChangeTypeScope(TypeReference type) - { - // check skip conditions - if (type == null || type.FullName.StartsWith("System.")) - return; - - // get assembly - Assembly assembly; - if (!this.TypeAssemblies.TryGetValue(type.FullName, out assembly)) - return; - - // replace scope - AssemblyNameReference assemblyRef = this.AssemblyMap.TargetReferences[assembly]; - type.Scope = assemblyRef; - } - - /// <summary>Get all methods in a module.</summary> - /// <param name="module">The module to search.</param> - private IEnumerable<MethodDefinition> GetMethods(ModuleDefinition module) - { - return ( - from type in module.GetTypes() - where type.HasMethods - from method in type.Methods - where method.HasBody - select method - ); - } - - /// <summary>Log a message for the player or developer the first time it occurs.</summary> - /// <param name="monitor">The monitor through which to log the message.</param> - /// <param name="hash">The hash of logged messages.</param> - /// <param name="message">The message to log.</param> - /// <param name="level">The log severity level.</param> - private void LogOnce(IMonitor monitor, HashSet<string> hash, string message, LogLevel level = LogLevel.Trace) - { - if (!hash.Contains(message)) - { - monitor.Log(message, level); - hash.Add(message); - } - } - } -} diff --git a/src/StardewModdingAPI/Framework/ModLoading/AssemblyParseResult.cs b/src/StardewModdingAPI/Framework/ModLoading/AssemblyParseResult.cs deleted file mode 100644 index b56a776c..00000000 --- a/src/StardewModdingAPI/Framework/ModLoading/AssemblyParseResult.cs +++ /dev/null @@ -1,36 +0,0 @@ -using System.IO; -using Mono.Cecil; - -namespace StardewModdingAPI.Framework.ModLoading -{ - /// <summary>Metadata about a parsed assembly definition.</summary> - internal class AssemblyParseResult - { - /********* - ** Accessors - *********/ - /// <summary>The original assembly file.</summary> - public readonly FileInfo File; - - /// <summary>The assembly definition.</summary> - public readonly AssemblyDefinition Definition; - - /// <summary>The result of the assembly load.</summary> - public AssemblyLoadStatus Status; - - - /********* - ** Public methods - *********/ - /// <summary>Construct an instance.</summary> - /// <param name="file">The original assembly file.</param> - /// <param name="assembly">The assembly definition.</param> - /// <param name="status">The result of the assembly load.</param> - public AssemblyParseResult(FileInfo file, AssemblyDefinition assembly, AssemblyLoadStatus status) - { - this.File = file; - this.Definition = assembly; - this.Status = status; - } - } -} diff --git a/src/StardewModdingAPI/Framework/ModLoading/InvalidModStateException.cs b/src/StardewModdingAPI/Framework/ModLoading/InvalidModStateException.cs deleted file mode 100644 index ab11272a..00000000 --- a/src/StardewModdingAPI/Framework/ModLoading/InvalidModStateException.cs +++ /dev/null @@ -1,14 +0,0 @@ -using System; - -namespace StardewModdingAPI.Framework.ModLoading -{ - /// <summary>An exception which indicates that something went seriously wrong while loading mods, and SMAPI should abort outright.</summary> - public class InvalidModStateException : Exception - { - /// <summary>Construct an instance.</summary> - /// <param name="message">The error message.</param> - /// <param name="ex">The underlying exception, if any.</param> - public InvalidModStateException(string message, Exception ex = null) - : base(message, ex) { } - } -} diff --git a/src/StardewModdingAPI/Framework/ModLoading/ModDependencyStatus.cs b/src/StardewModdingAPI/Framework/ModLoading/ModDependencyStatus.cs deleted file mode 100644 index 0774b487..00000000 --- a/src/StardewModdingAPI/Framework/ModLoading/ModDependencyStatus.cs +++ /dev/null @@ -1,18 +0,0 @@ -namespace StardewModdingAPI.Framework.ModLoading -{ - /// <summary>The status of a given mod in the dependency-sorting algorithm.</summary> - internal enum ModDependencyStatus - { - /// <summary>The mod hasn't been visited yet.</summary> - Queued, - - /// <summary>The mod is currently being analysed as part of a dependency chain.</summary> - Checking, - - /// <summary>The mod has already been sorted.</summary> - Sorted, - - /// <summary>The mod couldn't be sorted due to a metadata issue (e.g. missing dependencies).</summary> - Failed - } -} diff --git a/src/StardewModdingAPI/Framework/ModLoading/ModMetadata.cs b/src/StardewModdingAPI/Framework/ModLoading/ModMetadata.cs deleted file mode 100644 index ab590e10..00000000 --- a/src/StardewModdingAPI/Framework/ModLoading/ModMetadata.cs +++ /dev/null @@ -1,68 +0,0 @@ -using StardewModdingAPI.Framework.Models; - -namespace StardewModdingAPI.Framework.ModLoading -{ - /// <summary>Metadata for a mod.</summary> - internal class ModMetadata : IModMetadata - { - /********* - ** Accessors - *********/ - /// <summary>The mod's display name.</summary> - public string DisplayName { get; } - - /// <summary>The mod's full directory path.</summary> - public string DirectoryPath { get; } - - /// <summary>The mod manifest.</summary> - public IManifest Manifest { get; } - - /// <summary>Optional metadata about a mod version that SMAPI should assume is compatible or broken, regardless of whether it detects incompatible code.</summary> - public ModCompatibility Compatibility { get; } - - /// <summary>The metadata resolution status.</summary> - public ModMetadataStatus Status { get; private set; } - - /// <summary>The reason the metadata is invalid, if any.</summary> - public string Error { get; private set; } - - /// <summary>The mod instance (if it was loaded).</summary> - public IMod Mod { get; private set; } - - - /********* - ** Public methods - *********/ - /// <summary>Construct an instance.</summary> - /// <param name="displayName">The mod's display name.</param> - /// <param name="directoryPath">The mod's full directory path.</param> - /// <param name="manifest">The mod manifest.</param> - /// <param name="compatibility">Optional metadata about a mod version that SMAPI should assume is compatible or broken, regardless of whether it detects incompatible code.</param> - public ModMetadata(string displayName, string directoryPath, IManifest manifest, ModCompatibility compatibility) - { - this.DisplayName = displayName; - this.DirectoryPath = directoryPath; - this.Manifest = manifest; - this.Compatibility = compatibility; - } - - /// <summary>Set the mod status.</summary> - /// <param name="status">The metadata resolution status.</param> - /// <param name="error">The reason the metadata is invalid, if any.</param> - /// <returns>Return the instance for chaining.</returns> - public IModMetadata SetStatus(ModMetadataStatus status, string error = null) - { - this.Status = status; - this.Error = error; - return this; - } - - /// <summary>Set the mod instance.</summary> - /// <param name="mod">The mod instance to set.</param> - public IModMetadata SetMod(IMod mod) - { - this.Mod = mod; - return this; - } - } -} diff --git a/src/StardewModdingAPI/Framework/ModLoading/ModMetadataStatus.cs b/src/StardewModdingAPI/Framework/ModLoading/ModMetadataStatus.cs deleted file mode 100644 index 1b2b0b55..00000000 --- a/src/StardewModdingAPI/Framework/ModLoading/ModMetadataStatus.cs +++ /dev/null @@ -1,12 +0,0 @@ -namespace StardewModdingAPI.Framework.ModLoading -{ - /// <summary>Indicates the status of a mod's metadata resolution.</summary> - internal enum ModMetadataStatus - { - /// <summary>The mod has been found, but hasn't been processed yet.</summary> - Found, - - /// <summary>The mod cannot be loaded.</summary> - Failed - } -}
\ No newline at end of file diff --git a/src/StardewModdingAPI/Framework/ModLoading/ModResolver.cs b/src/StardewModdingAPI/Framework/ModLoading/ModResolver.cs deleted file mode 100644 index 6b19db5c..00000000 --- a/src/StardewModdingAPI/Framework/ModLoading/ModResolver.cs +++ /dev/null @@ -1,374 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using System.Linq; -using StardewModdingAPI.Framework.Exceptions; -using StardewModdingAPI.Framework.Models; -using StardewModdingAPI.Framework.Serialisation; - -namespace StardewModdingAPI.Framework.ModLoading -{ - /// <summary>Finds and processes mod metadata.</summary> - internal class ModResolver - { - /********* - ** Public methods - *********/ - /// <summary>Get manifest metadata for each folder in the given root path.</summary> - /// <param name="rootPath">The root path to search for mods.</param> - /// <param name="jsonHelper">The JSON helper with which to read manifests.</param> - /// <param name="compatibilityRecords">Metadata about mods that SMAPI should assume is compatible or broken, regardless of whether it detects incompatible code.</param> - /// <param name="disabledMods">Metadata about mods that SMAPI should consider obsolete and not load.</param> - /// <returns>Returns the manifests by relative folder.</returns> - public IEnumerable<IModMetadata> ReadManifests(string rootPath, JsonHelper jsonHelper, IEnumerable<ModCompatibility> compatibilityRecords, IEnumerable<DisabledMod> disabledMods) - { - compatibilityRecords = compatibilityRecords.ToArray(); - disabledMods = disabledMods.ToArray(); - - foreach (DirectoryInfo modDir in this.GetModFolders(rootPath)) - { - // read file - Manifest manifest = null; - string path = Path.Combine(modDir.FullName, "manifest.json"); - string error = null; - try - { - // read manifest - manifest = jsonHelper.ReadJsonFile<Manifest>(path); - - // validate - if (manifest == null) - { - error = File.Exists(path) - ? "its manifest is invalid." - : "it doesn't have a manifest."; - } - else if (string.IsNullOrWhiteSpace(manifest.EntryDll)) - error = "its manifest doesn't set an entry DLL."; - } - catch (SParseException ex) - { - error = $"parsing its manifest failed: {ex.Message}"; - } - catch (Exception ex) - { - error = $"parsing its manifest failed:\n{ex.GetLogSummary()}"; - } - - // validate metadata - ModCompatibility compatibility = null; - if (manifest != null) - { - // get unique key for lookups - string key = !string.IsNullOrWhiteSpace(manifest.UniqueID) ? manifest.UniqueID : manifest.EntryDll; - - // check if mod should be disabled - DisabledMod disabledMod = disabledMods.FirstOrDefault(mod => mod.ID.Contains(key, StringComparer.InvariantCultureIgnoreCase)); - if (disabledMod != null) - error = $"it's obsolete: {disabledMod.ReasonPhrase}"; - - // get compatibility record - compatibility = ( - from mod in compatibilityRecords - where - mod.ID.Any(p => p.Matches(key, manifest)) - && (mod.LowerVersion == null || !manifest.Version.IsOlderThan(mod.LowerVersion)) - && !manifest.Version.IsNewerThan(mod.UpperVersion) - select mod - ).FirstOrDefault(); - } - - // build metadata - string displayName = !string.IsNullOrWhiteSpace(manifest?.Name) - ? manifest.Name - : modDir.FullName.Replace(rootPath, "").Trim('/', '\\'); - ModMetadataStatus status = error == null - ? ModMetadataStatus.Found - : ModMetadataStatus.Failed; - - yield return new ModMetadata(displayName, modDir.FullName, manifest, compatibility).SetStatus(status, error); - } - } - - /// <summary>Validate manifest metadata.</summary> - /// <param name="mods">The mod manifests to validate.</param> - /// <param name="apiVersion">The current SMAPI version.</param> - public void ValidateManifests(IEnumerable<IModMetadata> mods, ISemanticVersion apiVersion) - { - mods = mods.ToArray(); - - // validate each manifest - foreach (IModMetadata mod in mods) - { - // skip if already failed - if (mod.Status == ModMetadataStatus.Failed) - continue; - - // validate compatibility - { - ModCompatibility compatibility = mod.Compatibility; - if (compatibility?.Compatibility == ModCompatibilityType.AssumeBroken) - { -#if SMAPI_1_x - bool hasOfficialUrl = mod.Compatibility.UpdateUrls.Length > 0; - bool hasUnofficialUrl = mod.Compatibility.UpdateUrls.Length > 1; - - string reasonPhrase = compatibility.ReasonPhrase ?? "it's not compatible with the latest version of the game or SMAPI"; - string error = $"{reasonPhrase}. Please check for a version newer than {compatibility.UpperVersionLabel ?? compatibility.UpperVersion.ToString()} here:"; - if (hasOfficialUrl) - error += !hasUnofficialUrl ? $" {compatibility.UpdateUrls[0]}" : $"{Environment.NewLine}- official mod: {compatibility.UpdateUrls[0]}"; - if (hasUnofficialUrl) - error += $"{Environment.NewLine}- unofficial update: {compatibility.UpdateUrls[1]}"; -#else - string reasonPhrase = compatibility.ReasonPhrase ?? "it's no longer compatible"; - string error = $"{reasonPhrase}. Please check for a "; - if (mod.Manifest.Version.Equals(compatibility.UpperVersion) && compatibility.UpperVersionLabel == null) - error += "newer version"; - else - error += $"version newer than {compatibility.UpperVersionLabel ?? compatibility.UpperVersion.ToString()}"; - error += " at " + string.Join(" or ", compatibility.UpdateUrls); -#endif - - mod.SetStatus(ModMetadataStatus.Failed, error); - continue; - } - } - - // validate SMAPI version - if (mod.Manifest.MinimumApiVersion?.IsNewerThan(apiVersion) == true) - { - mod.SetStatus(ModMetadataStatus.Failed, $"it needs SMAPI {mod.Manifest.MinimumApiVersion} or later. Please update SMAPI to the latest version to use this mod."); - continue; - } - - // validate DLL path - string assemblyPath = Path.Combine(mod.DirectoryPath, mod.Manifest.EntryDll); - if (!File.Exists(assemblyPath)) - { - mod.SetStatus(ModMetadataStatus.Failed, $"its DLL '{mod.Manifest.EntryDll}' doesn't exist."); - continue; - } - - // validate required fields -#if !SMAPI_1_x - { - List<string> missingFields = new List<string>(3); - - if (string.IsNullOrWhiteSpace(mod.Manifest.Name)) - missingFields.Add(nameof(IManifest.Name)); - if (mod.Manifest.Version == null || mod.Manifest.Version.ToString() == "0.0") - missingFields.Add(nameof(IManifest.Version)); - if (string.IsNullOrWhiteSpace(mod.Manifest.UniqueID)) - missingFields.Add(nameof(IManifest.UniqueID)); - - if (missingFields.Any()) - mod.SetStatus(ModMetadataStatus.Failed, $"its manifest is missing required fields ({string.Join(", ", missingFields)})."); - } -#endif - } - - // validate IDs are unique -#if !SMAPI_1_x - { - var duplicatesByID = mods - .GroupBy(mod => mod.Manifest?.UniqueID?.Trim(), mod => mod, StringComparer.InvariantCultureIgnoreCase) - .Where(p => p.Count() > 1); - foreach (var group in duplicatesByID) - { - foreach (IModMetadata mod in group) - { - if (mod.Status == ModMetadataStatus.Failed) - continue; // don't replace metadata error - mod.SetStatus(ModMetadataStatus.Failed, $"its unique ID '{mod.Manifest.UniqueID}' is used by multiple mods ({string.Join(", ", group.Select(p => p.DisplayName))})."); - } - } - } -#endif - } - - /// <summary>Sort the given mods by the order they should be loaded.</summary> - /// <param name="mods">The mods to process.</param> - public IEnumerable<IModMetadata> ProcessDependencies(IEnumerable<IModMetadata> mods) - { - // initialise metadata - mods = mods.ToArray(); - var sortedMods = new Stack<IModMetadata>(); - var states = mods.ToDictionary(mod => mod, mod => ModDependencyStatus.Queued); - - // handle failed mods - foreach (IModMetadata mod in mods.Where(m => m.Status == ModMetadataStatus.Failed)) - { - states[mod] = ModDependencyStatus.Failed; - sortedMods.Push(mod); - } - - // sort mods - foreach (IModMetadata mod in mods) - this.ProcessDependencies(mods.ToArray(), mod, states, sortedMods, new List<IModMetadata>()); - - return sortedMods.Reverse(); - } - - - /********* - ** Private methods - *********/ - /// <summary>Sort a mod's dependencies by the order they should be loaded, and remove any mods that can't be loaded due to missing or conflicting dependencies.</summary> - /// <param name="mods">The full list of mods being validated.</param> - /// <param name="mod">The mod whose dependencies to process.</param> - /// <param name="states">The dependency state for each mod.</param> - /// <param name="sortedMods">The list in which to save mods sorted by dependency order.</param> - /// <param name="currentChain">The current change of mod dependencies.</param> - /// <returns>Returns the mod dependency status.</returns> - private ModDependencyStatus ProcessDependencies(IModMetadata[] mods, IModMetadata mod, IDictionary<IModMetadata, ModDependencyStatus> states, Stack<IModMetadata> sortedMods, ICollection<IModMetadata> currentChain) - { - // check if already visited - switch (states[mod]) - { - // already sorted or failed - case ModDependencyStatus.Sorted: - case ModDependencyStatus.Failed: - return states[mod]; - - // dependency loop - case ModDependencyStatus.Checking: - // This should never happen. The higher-level mod checks if the dependency is - // already being checked, so it can fail without visiting a mod twice. If this - // case is hit, that logic didn't catch the dependency loop for some reason. - throw new InvalidModStateException($"A dependency loop was not caught by the calling iteration ({string.Join(" => ", currentChain.Select(p => p.DisplayName))} => {mod.DisplayName}))."); - - // not visited yet, start processing - case ModDependencyStatus.Queued: - break; - - // sanity check - default: - throw new InvalidModStateException($"Unknown dependency status '{states[mod]}'."); - } - - // no dependencies, mark sorted - if (mod.Manifest.Dependencies == null || !mod.Manifest.Dependencies.Any()) - { - sortedMods.Push(mod); - return states[mod] = ModDependencyStatus.Sorted; - } - - // get dependencies - var dependencies = - ( - from entry in mod.Manifest.Dependencies - let dependencyMod = mods.FirstOrDefault(m => string.Equals(m.Manifest?.UniqueID, entry.UniqueID, StringComparison.InvariantCultureIgnoreCase)) - orderby entry.UniqueID - select new - { - ID = entry.UniqueID, - MinVersion = entry.MinimumVersion, - Mod = dependencyMod, - IsRequired = -#if SMAPI_1_x - true -#else - entry.IsRequired -#endif - } - ) - .ToArray(); - - // missing required dependencies, mark failed - { - string[] failedIDs = (from entry in dependencies where entry.IsRequired && entry.Mod == null select entry.ID).ToArray(); - if (failedIDs.Any()) - { - sortedMods.Push(mod); - mod.SetStatus(ModMetadataStatus.Failed, $"it requires mods which aren't installed ({string.Join(", ", failedIDs)})."); - return states[mod] = ModDependencyStatus.Failed; - } - } - - // dependency min version not met, mark failed - { - string[] failedLabels = - ( - from entry in dependencies - where entry.Mod != null && entry.MinVersion != null && entry.MinVersion.IsNewerThan(entry.Mod.Manifest.Version) - select $"{entry.Mod.DisplayName} (needs {entry.MinVersion} or later)" - ) - .ToArray(); - if (failedLabels.Any()) - { - sortedMods.Push(mod); - mod.SetStatus(ModMetadataStatus.Failed, $"it needs newer versions of some mods: {string.Join(", ", failedLabels)}."); - return states[mod] = ModDependencyStatus.Failed; - } - } - - // process dependencies - { - states[mod] = ModDependencyStatus.Checking; - - // recursively sort dependencies - foreach (var dependency in dependencies) - { - IModMetadata requiredMod = dependency.Mod; - var subchain = new List<IModMetadata>(currentChain) { mod }; - - // ignore missing optional dependency - if (!dependency.IsRequired && requiredMod == null) - continue; - - // detect dependency loop - if (states[requiredMod] == ModDependencyStatus.Checking) - { - sortedMods.Push(mod); - mod.SetStatus(ModMetadataStatus.Failed, $"its dependencies have a circular reference: {string.Join(" => ", subchain.Select(p => p.DisplayName))} => {requiredMod.DisplayName})."); - return states[mod] = ModDependencyStatus.Failed; - } - - // recursively process each dependency - var substatus = this.ProcessDependencies(mods, requiredMod, states, sortedMods, subchain); - switch (substatus) - { - // sorted successfully - case ModDependencyStatus.Sorted: - break; - - // failed, which means this mod can't be loaded either - case ModDependencyStatus.Failed: - sortedMods.Push(mod); - mod.SetStatus(ModMetadataStatus.Failed, $"it needs the '{requiredMod.DisplayName}' mod, which couldn't be loaded."); - return states[mod] = ModDependencyStatus.Failed; - - // unexpected status - case ModDependencyStatus.Queued: - case ModDependencyStatus.Checking: - throw new InvalidModStateException($"Something went wrong sorting dependencies: mod '{requiredMod.DisplayName}' unexpectedly stayed in the '{substatus}' status."); - - // sanity check - default: - throw new InvalidModStateException($"Unknown dependency status '{states[mod]}'."); - } - } - - // all requirements sorted successfully - sortedMods.Push(mod); - return states[mod] = ModDependencyStatus.Sorted; - } - } - - /// <summary>Get all mod folders in a root folder, passing through empty folders as needed.</summary> - /// <param name="rootPath">The root folder path to search.</param> - private IEnumerable<DirectoryInfo> GetModFolders(string rootPath) - { - foreach (string modRootPath in Directory.GetDirectories(rootPath)) - { - DirectoryInfo directory = new DirectoryInfo(modRootPath); - - // if a folder only contains another folder, check the inner folder instead - while (!directory.GetFiles().Any() && directory.GetDirectories().Length == 1) - directory = directory.GetDirectories().First(); - - yield return directory; - } - } - } -} |