harden IL patch

guard against unfounded load order assumtions

Author: DoctorVanGogh

Source/ModSwitch/ModSwitch.cs

@@ -1,4 +1,5 @@
-using System.Linq;
+using System.Collections.Generic;
+using System.Linq;
 using System.Reflection;
 
 using HarmonyLib;
@@ -28,6 +29,16 @@ public ModSwitch(ModContentPack content) : base(content) {
             Log.Message($"ModSwitch {assembly.GetName().Version} - initialized patches...");
 
             CustomSettings = GetSettings<Settings>();
+
+            if (ModsConfigUI.Helpers.PreInitTSUpdateCache.Count != null) {
+                var entries = ModsConfigUI.Helpers.PreInitTSUpdateCache.ToArray();
+                ModsConfigUI.Helpers.PreInitTSUpdateCache.Clear();
+                Log.Message($"ModSwitch - copying cached steam TS values.");
+
+                foreach (KeyValuePair<string, uint> cachedTSValue in entries) {
+                    CustomSettings.Attributes[cachedTSValue.Key].LastUpdateTS = cachedTSValue.Value;
+                }
+            }
         }
 
         public Settings CustomSettings { get; }

Source/ModSwitch/ModSwitch.csproj

@@ -90,7 +90,7 @@
     <Compile Include="[Util]\Position.cs" />
     <Compile Include="[Util]\Scribe.cs" />
     <Compile Include="[Util]\Util.cs" />
-    <None Include="[Patches]\Patches.cs" />
+    <Compile Include="[Patches]\Patches.cs" />
     <Compile Include="[Util]\Linq.cs" />
     <Compile Include="[Util]\Widgets.cs" />
   </ItemGroup>

Source/ModSwitch/Properties/AssemblyInfo.cs

@@ -12,6 +12,6 @@
 [assembly: System.Reflection.AssemblyCopyright("Copyright © DoctorVanGogh 2017")]
 [assembly: System.Runtime.InteropServices.ComVisible(false)]
 [assembly: System.Runtime.InteropServices.Guid("ab2e8e89-3d1d-4e36-a0ae-489b6ebc84a6")]
-[assembly: System.Reflection.AssemblyVersion("2.0.3.294")]
+[assembly: System.Reflection.AssemblyVersion("2.0.3.299")]
 
 

Source/ModSwitch/Properties/version.txt

@@ -1 +1 @@
-2.0.3.294
+2.0.3.299

Source/ModSwitch/[Patches]/Patches.cs

@@ -5,6 +5,7 @@
 using System.Reflection.Emit;
 using HarmonyLib;
 using RimWorld;
+using Steamworks;
 using UnityEngine;
 using Verse;
 using Verse.Steam;
@@ -235,6 +236,7 @@ public static IEnumerable<CodeInstruction> Transpiler(IEnumerable<CodeInstructio
                 List<CodeInstruction> instructions = new List<CodeInstruction>(instr);
 
                 ConstructorInfo ciTarget = AccessTools.Constructor(typeof(WorkshopItem_Mod));
+                MethodInfo miAnchor = AccessTools.DeclaredMethod(typeof(SteamUGC), nameof(SteamUGC.GetItemInstallInfo));
 
                 int idxAnchor = instructions.FirstIndexOf(ci => ci.opcode == OpCodes.Newobj && ci.operand == ciTarget);
 
@@ -243,18 +245,43 @@ public static IEnumerable<CodeInstruction> Transpiler(IEnumerable<CodeInstructio
                     return instructions;
                 }
 
+
+
+                int idxGetItemInstallInfo = instructions.FirstIndexOf(ci => ci.opcode == OpCodes.Call && ci.operand == miAnchor);
+                if (idxGetItemInstallInfo == -1) {
+                    Util.Warning("Could not find SteamUGC.GetItemInstallInfo transpiler anchor - not injecting code");
+                    return instructions;
+                }
+
+                Log.Message($"operand: {instructions[idxGetItemInstallInfo - 1].operand.GetType()}");
+
+                LocalBuilder lbTS = null;
+                var opcode = instructions[idxGetItemInstallInfo - 1].opcode;
+                if (opcode == OpCodes.Ldloca || opcode == OpCodes.Ldloca_S) {
+                    lbTS = (LocalBuilder) instructions[idxGetItemInstallInfo - 1].operand;
+                } else {
+                    Util.Warning("Could not find SteamUGC.GetItemInstallInfo TS local - not injecting code");
+                    return instructions;
+                }
+
                 /* Transform
+                 *      ...
+                 *      SteamUGC.GetItemInstallInfo(..., out [foo]);
+                 * 
+                 *      ...
                  * 
                  * 		if (workshopItem == null)
                  * 		{
                  * 			workshopItem = new WorkshopItem_Mod();
                  * 		}
                  * 
                  * into
-                 * 
+                 *      ...
+                 *      SteamUGC.GetItemInstallInfo(..., out [foo]);
+                 *      ....
                  * 		if (workshopItem == null)
                  * 		{
-                 * 		    ModsConfigUI.UpdateSteamTS(pfid, num2);
+                 * 		    ModsConfigUI.UpdateSteamTS(pfid, [foo]);
                  * 			workshopItem = new WorkshopItem_Mod();
                  * 		}
                  * 
@@ -264,7 +291,7 @@ public static IEnumerable<CodeInstruction> Transpiler(IEnumerable<CodeInstructio
                     idxAnchor,
                     new[] {
                               new CodeInstruction(OpCodes.Ldarg_0),
-                              new CodeInstruction(OpCodes.Ldloc_2),
+                              new CodeInstruction(OpCodes.Ldloc, lbTS),
                               new CodeInstruction(OpCodes.Call, AccessTools.Method(typeof(ModsConfigUI.Helpers), nameof(ModsConfigUI.Helpers.UpdateSteamTS)))
                           }
                 );

Source/ModSwitch/[UI]/ModsConfigUI.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.IO;
@@ -379,6 +380,9 @@ private static void UpdateSteamAttributes(string name, ModMetaData original, Str
 
 
         public static class Helpers {
+
+            public static IDictionary<string, uint> PreInitTSUpdateCache = new ConcurrentDictionary<string, uint>();
+
             public static string ExplainError(string label, string error) {
                 return $"{label} *{error}*";
             }
@@ -404,7 +408,16 @@ public static Color SetGUIColorMod(ModMetaData mod) {
             }
 
             public static void UpdateSteamTS(PublishedFileId_t pfid, uint ts) {
-                LoadedModManager.GetMod<ModSwitch>().CustomSettings.Attributes[pfid.ToString()].LastUpdateTS = ts;
+                var modModSwitch = LoadedModManager.GetMod<ModSwitch>();
+
+                if (modModSwitch != null) {
+                    modModSwitch.CustomSettings.Attributes[pfid.ToString()].LastUpdateTS = ts;
+                } else {
+                    if (PreInitTSUpdateCache.Count == 0) {
+                        Log.Message("ModSwitch: Mod yet loaded, but already getting steam update values - caching until mod initialization.");
+                    }
+                    PreInitTSUpdateCache[pfid.ToString()] = ts;
+                }
             }
 
             public static string WrapTimestamp(long? timestamp) {