UnityInjectUtils.cs 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371
  1. using System;
  2. using System.Reflection;
  3. using System.Text;
  4. using Mono.Cecil;
  5. using Mono.Cecil.Cil;
  6. using UnityEditor;
  7. using UnityEditorInternal;
  8. using System.Linq;
  9. using System.IO;
  10. using UnityEngine;
  11. using System.Collections.Generic;
  12. using UnityEditor.Compilation;
  13. using Assembly = System.Reflection.Assembly;
  14. using FieldAttributes = Mono.Cecil.FieldAttributes;
  15. using MethodAttributes = Mono.Cecil.MethodAttributes;
  16. namespace com.bbbirder.injection.editor
  17. {
  18. public static class UnityInjectUtils
  19. {
  20. const string BACKUP_EXT = ".backup";
  21. [InitializeOnLoadMethod]
  22. static void Install()
  23. {
  24. CompilationPipeline.compilationStarted += (o) =>
  25. {
  26. var settings = GetScriptAssemblySettings();
  27. if (settings is null)
  28. {
  29. Debug.LogError("cannot get BeeScriptCompilationState, Unity Version" + Application.unityVersion);
  30. return;
  31. }
  32. var BuildingForEditor = (bool)settings?.GetMemberValue("BuildingForEditor", true);
  33. var OutputDirectory = (string)settings?.GetMemberValue("OutputDirectory", true);
  34. if (!BuildingForEditor)
  35. {
  36. runtimeOutputDirectory = OutputDirectory;
  37. }
  38. };
  39. CompilationPipeline.assemblyCompilationFinished += (path, msg) =>
  40. {
  41. var fullPath = Path.GetFullPath(path);
  42. var hasError = msg.Any(m => m.type == CompilerMessageType.Error);
  43. if (hasError)
  44. {
  45. var list = InjectionSettings.instance.compilationErrorAssemblies;
  46. if (!list.Contains(fullPath)) list.Add(fullPath);
  47. }
  48. else
  49. {
  50. InjectionSettings.instance.compilationErrorAssemblies.RemoveAll(p => p.Equals(fullPath));
  51. }
  52. EditorUtility.SetDirty(InjectionSettings.instance);
  53. AssetDatabase.SaveAssetIfDirty(InjectionSettings.instance);
  54. };
  55. CompilationPipeline.compilationFinished += (o) =>
  56. {
  57. var settings = GetScriptAssemblySettings();
  58. if (settings is null)
  59. {
  60. Debug.LogError("cannot get BeeScriptCompilationState, Unity Version" + Application.unityVersion);
  61. return;
  62. }
  63. var BuildingForEditor = (bool)settings.GetMemberValue("BuildingForEditor", true);
  64. if (!BuildingForEditor && InjectionSettings.instance.ShouldAutoInjectBuild)
  65. {
  66. InjectRuntime();
  67. }
  68. };
  69. if (InjectionSettings.instance.ShouldAutoInjectEditor)
  70. {
  71. EditorApplication.delayCall += InjectEditorDelayed;
  72. }
  73. void InjectEditorDelayed()
  74. {
  75. // wait while editor is busy
  76. var IsEditorBusy = false;
  77. IsEditorBusy |= EditorApplication.isCompiling;
  78. IsEditorBusy |= EditorApplication.isUpdating;
  79. if (IsEditorBusy)
  80. {
  81. EditorApplication.delayCall -= InjectEditorDelayed;
  82. EditorApplication.delayCall += InjectEditorDelayed;
  83. return;
  84. }
  85. var injectionSources = FixHelper.GetAllInjectionSources();
  86. var outdatedSources = new List<string>();
  87. // DebugHelper.Log($"injectionSources :\n {string.Join("\n",injectionSources)}");
  88. InjectionSettings.instance.GetOutdatedSources(injectionSources, outdatedSources);
  89. if (outdatedSources.Count == 0)
  90. {
  91. return;
  92. }
  93. // filter out assemblies who has compilation error
  94. var injectingSources = outdatedSources.Distinct().Where(p =>
  95. {
  96. var fullPath = Path.GetFullPath(p);
  97. var hasError = InjectionSettings.instance.compilationErrorAssemblies
  98. .Contains(fullPath)
  99. ;
  100. if (hasError)
  101. {
  102. Debug.LogWarning($"ignore target {p} due to compilation error");
  103. }
  104. return !hasError;
  105. }).ToList();
  106. var assemblies = GetAssemblies(injectingSources.ToHashSet());
  107. if (assemblies.Length > 0)
  108. {
  109. InjectEditor(assemblies);
  110. }
  111. InjectionSettings.instance.SetInjectionSources(injectionSources);
  112. }
  113. static Assembly[] GetAssemblies(HashSet<string> assemblyPathes)
  114. {
  115. var hashset = assemblyPathes
  116. .Select(p => p.Replace('\\', '/'))
  117. .ToHashSet();
  118. return AppDomain.CurrentDomain.GetAssemblies()
  119. .Where(a => hashset.Contains(a.GetAssemblyPath()))
  120. .ToArray();
  121. }
  122. }
  123. public static void InjectEditor(Assembly[] assemblies)
  124. {
  125. var allInjections = FixHelper.allInjections;
  126. var freshInjections = FixHelper.GetAllInjections(assemblies);
  127. var freshAssemblies = freshInjections
  128. .Where(inj => inj.InjectedMethod != null)
  129. .Select(inj => inj.InjectedMethod.DeclaringType.Assembly)
  130. .Distinct().
  131. ToHashSet();
  132. var outcomeInjections = allInjections
  133. .Where(inj => inj.InjectedMethod != null)
  134. .Where(inj => freshAssemblies.Contains(inj.InjectedMethod.DeclaringType.Assembly))
  135. .ToArray();
  136. DebugHelper.Log($"auto inject {allInjections.Length} injections, {outcomeInjections.Length} to inject");
  137. bool isWritten = false;
  138. if (outcomeInjections.Length > 0)
  139. {
  140. isWritten = InjectTargetMode(outcomeInjections, true, activeBuildTarget);
  141. }
  142. var group = freshInjections
  143. .Where(inj => inj.DryInjectAssmemble != null)
  144. .GroupBy(inj => inj.DryInjectAssmemble.Assembly);
  145. foreach (var g in group)
  146. {
  147. isWritten |= VisitAssembly(g.Key.GetAssemblyPath(), g.ToArray(), true, activeBuildTarget);
  148. }
  149. if (isWritten)
  150. {
  151. DebugHelper.Log($"reload scripts {EditorApplication.isCompiling}");
  152. #if UNITY_2019_3_OR_NEWER
  153. EditorUtility.RequestScriptReload();
  154. #else
  155. UnityEditorInternal.InternalEditorUtility.RequestScriptReload();
  156. #endif
  157. }
  158. }
  159. public static void InjectRuntime()
  160. {
  161. InjectTargetMode(FixHelper.allInjections, false, activeBuildTarget);
  162. }
  163. static bool InjectTargetMode(InjectionInfo[] injections, bool isEditor, BuildTarget buildTarget)
  164. {
  165. var group = injections
  166. .Where(inj => inj.InjectedMethod != null)
  167. .GroupBy(inj => inj.InjectedMethod.DeclaringType.Assembly);
  168. var isWritten = false;
  169. foreach (var g in group)
  170. {
  171. var assemblyPath = GetResolvedAssemblyPath(g.Key.GetAssemblyPath(), isEditor, buildTarget);
  172. isWritten |= VisitAssembly(assemblyPath, g.ToArray(), isEditor, buildTarget);
  173. }
  174. return isWritten;
  175. }
  176. static string GetResolvedAssemblyPath(string assemblyPath, bool isEditor, BuildTarget buildTarget)
  177. {
  178. var fileName = Path.GetFileName(assemblyPath);
  179. if (!isEditor)
  180. {
  181. var preloads = GetPreloadAssemblies(isEditor, buildTarget);
  182. var matchedAssembly = preloads.FirstOrDefault(path => Path.GetFileName(path) == fileName);
  183. if (matchedAssembly is not null)
  184. {
  185. return matchedAssembly;
  186. }
  187. var playerAssemblyPath = Path.Join(runtimeOutputDirectory, fileName);
  188. if (File.Exists(playerAssemblyPath))
  189. {
  190. return playerAssemblyPath;
  191. }
  192. }
  193. return assemblyPath;
  194. }
  195. static string GetEditorAssemblyPath(string assemblyPath)
  196. => assemblyPath;
  197. static bool VisitAssembly(string assemblyPath, InjectionInfo[] injections, bool isEditor, BuildTarget buildTarget)
  198. {
  199. var backPath = assemblyPath + BACKUP_EXT;
  200. var IsEngineAssembly = Path.GetFullPath(assemblyPath)
  201. .StartsWith(Path.GetFullPath(EditorApplication.applicationContentsPath));
  202. // engine dlls should be backed up
  203. if (IsEngineAssembly && !File.Exists(backPath))
  204. {
  205. if (!IsFileAvaliable(assemblyPath))
  206. {
  207. LogError($"cannot access file: {assemblyPath}, make sure you has access rights to target");
  208. return false;
  209. }
  210. File.Copy(assemblyPath, backPath, true);
  211. }
  212. else
  213. {
  214. // File.Copy(backPath, assemblyPath, true);
  215. }
  216. // var assemblySearchFolders = GetAssemblySearchFolders(isEditor, buildTarget);
  217. // var replaceAssemblyPath = miReplace.DeclaringType.Assembly.Location;
  218. try
  219. {
  220. var inputPath = IsEngineAssembly ? backPath : assemblyPath;
  221. var isWritten = InjectHelper.InjectAssembly(injections, inputPath, assemblyPath, isEditor, buildTarget);
  222. if (isWritten)
  223. DebugHelper.Log($"Inject success: {assemblyPath}");
  224. return isWritten;
  225. }
  226. catch (Exception e)
  227. {
  228. Debug.LogException(e);
  229. if (IsEngineAssembly)
  230. {
  231. File.Copy(backPath, assemblyPath, true);
  232. }
  233. throw e;
  234. }
  235. }
  236. static bool IsFileAvaliable(string path)
  237. {
  238. try
  239. {
  240. var fs = File.Open(path, FileMode.Open);
  241. fs?.Close();
  242. fs?.Dispose();
  243. }
  244. catch
  245. {
  246. return false;
  247. }
  248. return true;
  249. }
  250. //TODO : Restore
  251. //TODO : Partial restore on inject
  252. // public static void RestoreEditor() {
  253. // // var backPath = assemblyPath+".backup";
  254. // // var existsBacked = File.Exists(backPath);
  255. // RestoreTargetMode(true);
  256. // RestoreTargetMode(false);
  257. // void RestoreTargetMode(bool isEditor){
  258. // var folders = GetAssemblySearchFolders(isEditor,activeBuildTarget);
  259. // foreach(var folder in folders){
  260. // var backupFiles = Directory.GetFiles(folder,"*"+BACKUP_EXT);
  261. // }
  262. // }
  263. // }
  264. internal static string[] GetAssemblySearchFolders(bool isEditor, BuildTarget buildTarget)
  265. {
  266. return GetPreloadAssemblies(isEditor, buildTarget)
  267. .Select(Path.GetDirectoryName)
  268. .Distinct()
  269. .ToArray();
  270. }
  271. internal static string[] GetPreloadAssemblies(bool isEditor, BuildTarget buildTarget)
  272. {
  273. var miGetUnityAssemblies = typeof(InternalEditorUtility).GetMethod("GetUnityAssembliesInternal", bindingFlags);
  274. var assemblies = (Array)miGetUnityAssemblies.Invoke(null, new object[] { isEditor, buildTarget, });
  275. var fiPath = miGetUnityAssemblies.ReturnType.GetElementType().GetField("Path", bindingFlags);
  276. return assemblies.OfType<object>()
  277. .Select(a => fiPath.GetValue(a))
  278. .OfType<string>()
  279. .ToArray();
  280. }
  281. static object GetScriptAssemblySettings()
  282. {
  283. var t = t_EditorCompilationInterface ??= GetType("UnityEditor.CoreModule", "EditorCompilationInterface");
  284. var editorCompilation = t.GetProperty("Instance", bindingFlags).GetValue(null);
  285. if (editorCompilation is null)
  286. throw new("cannot get editorCompilation,Unity:" + Application.unityVersion);
  287. var state = editorCompilation.GetMemberValue("activeBeeBuild")
  288. ?? editorCompilation.GetMemberValue("_currentBeeScriptCompilationState");
  289. if (state is null)
  290. throw new("cannot get compile state from editorCompilation,Unity:" + Application.unityVersion);
  291. return state.GetMemberValue("Settings", true);
  292. }
  293. static object GetMemberValue(this object obj, string name, bool IgnoreCase = false)
  294. {
  295. var flags = bindingFlags;
  296. if (IgnoreCase) flags |= BindingFlags.IgnoreCase;
  297. var memberInfo = obj.GetType().GetMember(name, flags).FirstOrDefault();
  298. if (memberInfo is null)
  299. return null;
  300. // {
  301. // var fields = obj.GetType().GetFields(flags).Select(f=>"field:"+f.Name);
  302. // var props = obj.GetType().GetProperties(flags).Select(f=>"prop:"+f.Name);
  303. // DebugHelper.Log(string.Join("\n",fields)+"\n"+string.Join("\n",props));
  304. // throw new($"cannot find member {name} in {obj}");
  305. // }
  306. if (memberInfo is FieldInfo fi)
  307. return fi.GetValue(obj);
  308. if (memberInfo is PropertyInfo pi)
  309. return pi.GetValue(obj);
  310. if (memberInfo is MethodInfo mi)
  311. return mi.Invoke(obj, null);
  312. return null;
  313. }
  314. static Type GetType(string moduleName, string typeName)
  315. {
  316. return System.AppDomain.CurrentDomain.GetAssemblies()
  317. .Where(a => a.FullName.StartsWith(moduleName + ","))
  318. .SelectMany(a => a.GetTypes())
  319. .Where(t => t.Name.Equals(typeName))
  320. .Single();
  321. }
  322. static Type t_EditorCompilationInterface;
  323. static string runtimeOutputDirectory;
  324. // static BuildTargetGroup activeBuildTargetGroup => EditorUserBuildSettings.selectedBuildTargetGroup;
  325. static BuildTarget activeBuildTarget => EditorUserBuildSettings.activeBuildTarget;
  326. static BindingFlags bindingFlags = 0
  327. | BindingFlags.Static
  328. | BindingFlags.Instance
  329. | BindingFlags.Public
  330. | BindingFlags.NonPublic
  331. ;
  332. static void LogError(string message)
  333. {
  334. Debug.LogError(message);
  335. }
  336. }
  337. }