Merge pull request #165 from SubnauticaModding/devQ3

QModManager 4.0.1 - Hotfix for version dependency issues

Author: PrimeSonic

Build/InstallerExtensions.dll

@@ -1 +1 @@
-4.0.0.0
+4.0.1.0

Build/QModInstaller.dll

@@ -12,5 +12,5 @@
 
 [assembly: ComVisible(false)]
 
-[assembly: AssemblyVersion("4.0.0.0")]
-[assembly: AssemblyFileVersion("4.0.0.0")]
+[assembly: AssemblyVersion("4.0.1.0")]
+[assembly: AssemblyFileVersion("4.0.1.0")]

Build/QModInstaller.xml

@@ -14,5 +14,5 @@
 
 [assembly: Guid("8c6c9a0b-80c4-43d2-89f2-749e6f09fdda")]
 
-[assembly: AssemblyVersion("4.0.0.0")]
-[assembly: AssemblyFileVersion("4.0.0.0")]
+[assembly: AssemblyVersion("4.0.1.0")]
+[assembly: AssemblyFileVersion("4.0.1.0")]

Build/QModManager.QMMHarmonyShimmer.dll

@@ -5,7 +5,7 @@
 #endif
 
 #define Name "QModManager" ; The name of the game will be added after it
-#define Version "4.0.0"
+#define Version "4.0.1"
 #define Author "QModManager"
 #define URL "https://github.com/QModManager/QModManager"
 #define SupportURL "https://discord.gg/UpWuWwq"
@@ -70,6 +70,9 @@ Source: "..\Dependencies\cldb.dat"; DestDir: "{app}\BepInEx\patchers\QModManager
 Source: "..\Build\QModManager.exe"; DestDir: "{app}\BepInEx\patchers\QModManager"; Flags: ignoreversion;
 ; BepInEx
 Source: "..\Dependencies\BepInEx\*"; DestDir: "{app}"; Flags: recursesubdirs createallsubdirs replacesameversion sharedfile uninsnosharedfileprompt;
+
+[Dirs]
+Name: "{app}\QMods"
 
 [UninstallRun]
 Filename: "{app}\BepInEx\patchers\QModManager\QModManager.exe"; Parameters: "-u";

Build/QModManager.QMMLoader.dll

@@ -33,6 +33,6 @@
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("4.0.0.0")]
-[assembly: AssemblyFileVersion("4.0.0.0")]
+[assembly: AssemblyVersion("4.0.1.0")]
+[assembly: AssemblyFileVersion("4.0.1.0")]
 [assembly: NeutralResourcesLanguage("en")]

Build/QModManager.QModPluginGenerator.dll

@@ -33,6 +33,6 @@
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("4.0.0.0")]
-[assembly: AssemblyFileVersion("4.0.0.0")]
+[assembly: AssemblyVersion("4.0.1.0")]
+[assembly: AssemblyFileVersion("4.0.1.0")]
 [assembly: NeutralResourcesLanguage("en")]

Build/QModManager.UnityAudioFixer.dll

@@ -1,24 +1,35 @@
 namespace QModManager.API
 {
     using System;
+    using QModManager.Utility;
 
     /// <summary>
     /// Identifies a required mod and an optional minimum version.
     /// </summary>
     public class RequiredQMod
     {
-        internal RequiredQMod(string id)
+        internal static IVersionParser VersionParserService { get; set; } = new VersionParser();
+
+        private RequiredQMod(string id, bool requiresMinVersion, Version version)
         {
             this.Id = id;
-            this.RequiresMinimumVersion = false;
-            this.MinimumVersion = new Version();            
+            this.RequiresMinimumVersion = requiresMinVersion;
+            this.MinimumVersion = version;
+        }
+
+        internal RequiredQMod(string id)
+            : this(id, false, VersionParserService.NoVersionParsed)
+        {
         }
 
         internal RequiredQMod(string id, Version minimumVersion)
+            : this(id, !VersionParserService.IsAllZeroVersion(minimumVersion), minimumVersion)
+        {
+        }
+
+        internal RequiredQMod(string id, string minimumVersion)
+            : this(id, !string.IsNullOrEmpty(minimumVersion), VersionParserService.GetVersion(minimumVersion))
         {
-            this.Id = id;
-            this.RequiresMinimumVersion = true;
-            this.MinimumVersion = minimumVersion;            
         }
 
         /// <summary>

Build/QModManager.exe

@@ -12,7 +12,7 @@
 
     internal class ManifestValidator : IManifestValidator
     {
-        internal static readonly Regex VersionRegex = new Regex(@"(((\d+)\.?)+)");
+        internal static IVersionParser VersionParserService { get; set; } = new VersionParser();
 
         internal static readonly Dictionary<string, ModStatus> ProhibitedModIDs = new Dictionary<string, ModStatus>()
         {
@@ -29,7 +29,7 @@ public void ValidateManifest(QMod mod)
             if (mod.PatchMethods.Count > 0)
                 return;
 
-            Logger.Debug($"Validating mod in '{mod.SubDirectory}'");
+            Logger.Debug($"Validating mod '{mod.Id}'");
             if (string.IsNullOrEmpty(mod.Id) ||
                 string.IsNullOrEmpty(mod.DisplayName) ||
                 string.IsNullOrEmpty(mod.Author))
@@ -70,8 +70,7 @@ public void ValidateManifest(QMod mod)
 
             try
             {
-                if (Version.TryParse(mod.Version, out Version version))
-                    mod.ParsedVersion = version;
+                mod.ParsedVersion = VersionParserService.GetVersion(mod.Version);
             }
             catch (Exception vEx)
             {
@@ -135,26 +134,27 @@ public void CheckRequiredMods(QMod mod)
                 foreach (KeyValuePair<string, string> item in mod.VersionDependencies)
                 {
                     string id = item.Key;
-                    string cleanVersion = VersionRegex.Matches(item.Value)?[0]?.Value;
+                    string versionString = item.Value;
 
-                    if (string.IsNullOrEmpty(cleanVersion))
-                    {
-                        requiredMods[id] = new RequiredQMod(id);
-                    }
-                    else if (Version.TryParse(cleanVersion, out Version version))
-                    {
-                        requiredMods[id] = new RequiredQMod(id, version);
-                    }
-                    else if (!requiredMods.ContainsKey(id))
-                    {
-                        requiredMods[id] = new RequiredQMod(id);
-                    }
+                    Version version = VersionParserService.GetVersion(versionString);
+
+                    requiredMods[id] = new RequiredQMod(id, version);
 
                     mod.RequiredDependencies.Add(id);
                 }
             }
 
             mod.RequiredMods = requiredMods.Values;
+            if (Logger.DebugLogsEnabled && requiredMods.Count > 0)
+            {
+                string msg = $"{mod.Id} has required mods: ";
+                foreach (var required in requiredMods.Values)
+                {
+                    msg += $"{required.Id} ";
+                }
+
+                Logger.Debug(msg);
+            }
         }
 
         internal ModStatus FindPatchMethods(QMod qMod)

Build/QModManager_Setup.exe

@@ -141,6 +141,11 @@ private void ValidateDependencies(List<QMod> modsToLoad, QMod mod)
                     continue;
                 }
 
+                if (dependencyQMod.HasDependencies)
+                {
+                    ValidateDependencies(modsToLoad, dependencyQMod);
+                }
+
                 if (dependencyQMod.LoadedAssembly == null)
                 {
                     // Dependency hasn't been validated yet

Build/VortexPackage.zip

@@ -13,8 +13,8 @@
 
 [assembly: ComVisible(false)]
 
-[assembly: AssemblyVersion("4.0.0.0")]
-[assembly: AssemblyFileVersion("4.0.0.0")]
+[assembly: AssemblyVersion("4.0.1.0")]
+[assembly: AssemblyFileVersion("4.0.1.0")]
 
 [assembly: InternalsVisibleTo("QMMTests")]
 [assembly: InternalsVisibleTo("QModManager")]

Data/latest-version.txt

@@ -183,6 +183,7 @@
     <Compile Include="Utility\NetworkUtilities.cs" />
     <Compile Include="Utility\ReflectionHelper.cs" />
     <Compile Include="Checks\VersionCheck.cs" />
+    <Compile Include="Utility\VersionParser.cs" />
   </ItemGroup>
   <ItemGroup />
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />

Executable/Properties/AssemblyInfo.cs

@@ -25,7 +25,11 @@ internal class Button
             internal static readonly Button Disabled = new Button();
             internal static readonly Button SeeLog = new Button("See Log", () =>
             {
-                string logPath = Application.consoleLogPath;
+                string gameSuffix = "Subnautica";
+                if (Patcher.CurrentlyRunningGame == QModGame.BelowZero)
+                    gameSuffix += "Zero";
+
+                string logPath = Path.Combine(Environment.CurrentDirectory, $"qmodmanager_log-{gameSuffix}.txt");
 
                 Logger.Debug($"Opening log file located in: \"{logPath}\"");
 

Installer/Properties/AssemblyInfo.cs

@@ -0,0 +1,90 @@
+namespace QModManager.Utility
+{
+    using System;
+    using System.Text.RegularExpressions;
+
+    /// <summary>
+    /// Defines a service for parsing version strings.
+    /// </summary>
+    public interface IVersionParser
+    {
+        /// <summary>
+        /// The default version zero used when no version could be parsed.
+        /// </summary>
+        Version NoVersionParsed { get; }
+
+        /// <summary>
+        /// Returns a new <see cref="Version"/> based on the provided string value, with all 4 groups populated.
+        /// </summary>
+        /// <param name="versionString">The version string to parse.</param>
+        /// <returns>A new <see cref="Version"/> with all empty groups populated with 0.</returns>
+        Version GetVersion(string versionString);
+
+        /// <summary>
+        /// Checks if the provided version is all zeros.
+        /// </summary>
+        /// <param name="version">The version to check.</param>
+        /// <returns>True if this matches version 0.0.0.0</returns>
+        bool IsAllZeroVersion(Version version);
+    }
+
+    /// <summary>
+    /// A service that handles parsing <see cref="string"/> values into <see cref="Version"/> objects.
+    /// </summary>
+    public class VersionParser : IVersionParser
+    {
+        private static readonly Version VersionZeroSingleton = new Version(0, 0, 0, 0);
+
+        /// <summary>
+        /// The regex used to sanitize incoming version strings.
+        /// ^(((\d+)\.?){0,3}\d+)$
+        /// </summary>
+        public static readonly Regex VersionRegex = new Regex(@"^(((\d+)\.?){0,3}\d+)$");
+
+        /// <summary>
+        /// The default version zero used when no version could be parsed.
+        /// </summary>
+        public Version NoVersionParsed => new Version(0, 0, 0, 0);
+
+        /// <summary>
+        /// Returns a new <see cref="Version"/> based on the provided string value, with all 4 groups populated.
+        /// </summary>
+        /// <param name="versionString">The version string to parse. This must match <seealso cref="VersionRegex"/>.</param>
+        /// <returns>A new <see cref="Version"/> with all empty groups populated with 0.</returns>
+        /// <example>
+        /// "2.8" will be parsed as "2.8.0.0"
+        /// </example>
+        public Version GetVersion(string versionString)
+        {
+            if (!VersionRegex.IsMatch(versionString))
+            {
+                return NoVersionParsed;
+            }
+
+            versionString = VersionRegex.Matches(versionString)?[0]?.Value;
+
+            int groups = versionString.Split('.').Length;
+            while (groups++ < 4)
+            {
+                versionString += ".0";
+            }
+
+            if (Version.TryParse(versionString, out Version parsedVersion))
+            {
+                return parsedVersion;
+            }
+
+            return NoVersionParsed;
+        }
+
+        /// <summary>
+        /// Checks if the provided version is all zeros.
+        /// </summary>
+        /// <param name="version">The version to check.</param>
+        /// <returns>True if this matches version 0.0.0.0</returns>
+        public bool IsAllZeroVersion(Version version)
+        {
+            return version == VersionZeroSingleton;
+        }
+    }
+}

Installer/QModsInstallerScript.iss

@@ -33,8 +33,8 @@
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("4.0.0.0")]
-[assembly: AssemblyFileVersion("4.0.0.0")]
+[assembly: AssemblyVersion("4.0.1.0")]
+[assembly: AssemblyFileVersion("4.0.1.0")]
 [assembly: NeutralResourcesLanguage("en")]
 
 [assembly: InternalsVisibleTo("QModManager.QMMLoader")]