-
-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathDeobfuscationHelper.cs
More file actions
361 lines (310 loc) · 13.6 KB
/
DeobfuscationHelper.cs
File metadata and controls
361 lines (310 loc) · 13.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
// ==============================
// DeobfuscationHelper - Translates obfuscated names to friendly names
// ==============================
// Integrates with MappingDatabase to provide friendly name lookup
// for display in the Explorer UI while keeping IL2CPP internals using
// the original obfuscated names.
using System;
using System.IO;
using GameSDK.Deobfuscation;
using GameSDK.ModHost;
namespace MDB.Explorer.ImGui
{
/// <summary>
/// Provides deobfuscation name translation for the Explorer UI.
/// </summary>
public static class DeobfuscationHelper
{
private const string LOG_TAG = "DeobfuscationHelper";
private static MappingDatabase _database;
private static bool _initialized;
private static bool _enabled = true;
/// <summary>
/// Whether deobfuscation is enabled.
/// </summary>
public static bool Enabled
{
get => _enabled;
set => _enabled = value;
}
/// <summary>
/// Number of loaded mappings.
/// </summary>
public static int MappingCount => _database?.Count ?? 0;
/// <summary>
/// Whether the helper is initialized with a mapping database.
/// </summary>
public static bool IsInitialized => _initialized && _database != null;
/// <summary>
/// Initialize the deobfuscation helper with a mappings file.
/// </summary>
public static bool Initialize(string mappingsPath = null)
{
if (_initialized) return true;
try
{
// Get the folder where this assembly (the mod DLL) is located
// Structure: Game/MDB/Mods/MDB_Explorer.dll
var assemblyLocation = typeof(DeobfuscationHelper).Assembly.Location;
var modsFolder = !string.IsNullOrEmpty(assemblyLocation)
? Path.GetDirectoryName(assemblyLocation)
: null;
// MDB folder is parent of Mods folder
var mdbFolder = !string.IsNullOrEmpty(modsFolder)
? Path.GetDirectoryName(modsFolder)
: null;
// Game folder is parent of MDB folder
var gameFolder = !string.IsNullOrEmpty(mdbFolder)
? Path.GetDirectoryName(mdbFolder)
: null;
// Default path for creating new mappings file
var defaultMappingsPath = !string.IsNullOrEmpty(mdbFolder)
? Path.Combine(mdbFolder, "Dump", "mappings.json")
: Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "MDB", "Dump", "mappings.json");
// Try default paths if not specified
if (string.IsNullOrEmpty(mappingsPath))
{
// Try common locations based on folder structure:
// Game/MDB/Dump/dump.cs, wrapper_generator.py, mappings.json
// Game/MDB/Mods/MDB_Explorer.dll
var possiblePaths = new System.Collections.Generic.List<string>();
// 1. MDB/Dump folder (where dump.cs and wrapper_generator.py are)
if (!string.IsNullOrEmpty(mdbFolder))
{
possiblePaths.Add(Path.Combine(mdbFolder, "Dump", "mappings.json"));
}
// 2. MDB folder root
if (!string.IsNullOrEmpty(mdbFolder))
{
possiblePaths.Add(Path.Combine(mdbFolder, "mappings.json"));
}
// 3. Same folder as the mod DLL (Mods folder)
if (!string.IsNullOrEmpty(modsFolder))
{
possiblePaths.Add(Path.Combine(modsFolder, "mappings.json"));
}
// 4. Game root folder
if (!string.IsNullOrEmpty(gameFolder))
{
possiblePaths.Add(Path.Combine(gameFolder, "mappings.json"));
}
// 5. Fallback to AppDomain base (may be game folder)
possiblePaths.Add(Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "MDB", "Dump", "mappings.json"));
possiblePaths.Add(Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "mappings.json"));
foreach (var path in possiblePaths)
{
if (File.Exists(path))
{
mappingsPath = path;
ModLogger.LogInternal(LOG_TAG, $"[INFO] Found mappings at: {path}");
break;
}
}
}
// If no mappings file found, create an empty one at the default location
if (string.IsNullOrEmpty(mappingsPath) || !File.Exists(mappingsPath))
{
mappingsPath = defaultMappingsPath;
// Ensure directory exists
var dir = Path.GetDirectoryName(mappingsPath);
if (!string.IsNullOrEmpty(dir) && !Directory.Exists(dir))
{
Directory.CreateDirectory(dir);
}
// Create empty mappings file
File.WriteAllText(mappingsPath, "[]");
ModLogger.LogInternal(LOG_TAG, $"[INFO] Created new mappings file at: {mappingsPath}");
}
_database = new MappingDatabase(mappingsPath);
_database.Load();
_initialized = true;
ModLogger.LogInternal(LOG_TAG, $"[INFO] Loaded {_database.Count} deobfuscation mappings from {mappingsPath}");
return true;
}
catch (Exception ex)
{
ModLogger.LogInternal(LOG_TAG, $"[ERROR] Failed to initialize: {ex.Message}");
_initialized = true;
return false;
}
}
/// <summary>
/// Reload mappings from file.
/// </summary>
public static void Reload()
{
if (_database != null)
{
_database.Load();
ModLogger.LogInternal(LOG_TAG, $"[INFO] Reloaded {_database.Count} mappings");
}
}
/// <summary>
/// Get the display name for a type (class name).
/// Returns the friendly name if mapped, otherwise the original name.
/// </summary>
public static string GetTypeName(string obfuscatedName)
{
if (!_enabled || _database == null || string.IsNullOrEmpty(obfuscatedName))
return obfuscatedName;
var mapping = _database.GetByObfuscatedName(obfuscatedName);
if (mapping != null && !string.IsNullOrEmpty(mapping.FriendlyName))
{
return mapping.FriendlyName;
}
return obfuscatedName;
}
/// <summary>
/// Get the display name for a type, with optional suffix showing the obfuscated name.
/// </summary>
public static string GetTypeNameWithHint(string obfuscatedName, bool showObfuscatedHint = true)
{
if (!_enabled || _database == null || string.IsNullOrEmpty(obfuscatedName))
return obfuscatedName;
var mapping = _database.GetByObfuscatedName(obfuscatedName);
if (mapping != null && !string.IsNullOrEmpty(mapping.FriendlyName))
{
if (showObfuscatedHint && IsObfuscatedName(obfuscatedName))
{
return $"{mapping.FriendlyName} [{obfuscatedName}]";
}
return mapping.FriendlyName;
}
return obfuscatedName;
}
/// <summary>
/// Get the display name for a field.
/// Looks up "TypeName.FieldName" pattern.
/// </summary>
public static string GetFieldName(string typeName, string fieldName)
{
if (!_enabled || _database == null || string.IsNullOrEmpty(fieldName))
return fieldName;
// Try fully qualified lookup first
if (!string.IsNullOrEmpty(typeName))
{
var mapping = _database.GetByObfuscatedName($"{typeName}.{fieldName}");
if (mapping != null && !string.IsNullOrEmpty(mapping.FriendlyName))
{
return mapping.FriendlyName;
}
}
// Try just the field name
var fieldMapping = _database.GetByObfuscatedName(fieldName);
if (fieldMapping != null &&
fieldMapping.SymbolType == SymbolType.Field &&
!string.IsNullOrEmpty(fieldMapping.FriendlyName))
{
return fieldMapping.FriendlyName;
}
return fieldName;
}
/// <summary>
/// Get the display name for a property.
/// </summary>
public static string GetPropertyName(string typeName, string propertyName)
{
if (!_enabled || _database == null || string.IsNullOrEmpty(propertyName))
return propertyName;
// Try fully qualified lookup first
if (!string.IsNullOrEmpty(typeName))
{
var mapping = _database.GetByObfuscatedName($"{typeName}.{propertyName}");
if (mapping != null && !string.IsNullOrEmpty(mapping.FriendlyName))
{
return mapping.FriendlyName;
}
}
// Try just the property name
var propMapping = _database.GetByObfuscatedName(propertyName);
if (propMapping != null &&
propMapping.SymbolType == SymbolType.Property &&
!string.IsNullOrEmpty(propMapping.FriendlyName))
{
return propMapping.FriendlyName;
}
return propertyName;
}
/// <summary>
/// Get the display name for a method.
/// </summary>
public static string GetMethodName(string typeName, string methodName)
{
if (!_enabled || _database == null || string.IsNullOrEmpty(methodName))
return methodName;
// Try fully qualified lookup first
if (!string.IsNullOrEmpty(typeName))
{
var mapping = _database.GetByObfuscatedName($"{typeName}.{methodName}");
if (mapping != null && !string.IsNullOrEmpty(mapping.FriendlyName))
{
return mapping.FriendlyName;
}
}
// Try just the method name
var methodMapping = _database.GetByObfuscatedName(methodName);
if (methodMapping != null &&
methodMapping.SymbolType == SymbolType.Method &&
!string.IsNullOrEmpty(methodMapping.FriendlyName))
{
return methodMapping.FriendlyName;
}
return methodName;
}
/// <summary>
/// Check if a name appears to be obfuscated (Beebyte pattern: 8-15 uppercase letters).
/// </summary>
public static bool IsObfuscatedName(string name)
{
if (string.IsNullOrEmpty(name)) return false;
if (name.Length < 8 || name.Length > 15) return false;
foreach (char c in name)
{
if (c < 'A' || c > 'Z') return false;
}
return true;
}
/// <summary>
/// Get the mapping database for direct access.
/// </summary>
public static MappingDatabase GetDatabase() => _database;
/// <summary>
/// Add or update a mapping and save to disk.
/// </summary>
public static void SetMapping(SymbolMapping mapping)
{
if (_database == null) return;
_database.AddOrUpdate(mapping);
_database.Save();
ModLogger.LogInternal(LOG_TAG, $"[INFO] Saved mapping: {mapping.ObfuscatedName} → {mapping.FriendlyName}");
}
/// <summary>
/// Remove a mapping by obfuscated name and save.
/// </summary>
public static bool RemoveMapping(string obfuscatedName)
{
if (_database == null) return false;
bool removed = _database.Remove(obfuscatedName);
if (removed)
{
_database.Save();
ModLogger.LogInternal(LOG_TAG, $"[INFO] Removed mapping: {obfuscatedName}");
}
return removed;
}
/// <summary>
/// Save the current database to disk.
/// </summary>
public static void Save()
{
_database?.Save();
}
/// <summary>
/// Get the path to the mappings file.
/// </summary>
public static string GetMappingsPath()
{
return _database?.FilePath;
}
}
}