-
Notifications
You must be signed in to change notification settings - Fork 71
Expand file tree
/
Copy pathSerializedFileTool.cs
More file actions
305 lines (263 loc) · 11.7 KB
/
Copy pathSerializedFileTool.cs
File metadata and controls
305 lines (263 loc) · 11.7 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
using System;
using System.IO;
using System.Linq;
using System.Text.Json;
using UnityDataTools.BinaryFormat;
using UnityDataTools.FileSystem;
namespace UnityDataTools.SerializedFile;
public static class SerializedFileTool
{
public enum OutputFormat
{
Text,
Json
}
public static int ListExternalRefs(FileInfo filename, OutputFormat format)
{
// External references are read directly from the parsed metadata rather than via UnityFileSystemApi.
//
// Advantages: works for any modern SerializedFile (version >= 19), including Player builds
// that were compiled without TypeTrees — files that UnityFileSystemApi cannot open at all.
//
// Trade-offs: Files older than version 19 (Unity 2019.1) are not supported by the metadata parser.
//
// These trade-offs are minor compared to the benefit of handling the common no-TypeTree case,
// so there is no need to keep the UnityFileSystemApi code path.
if (!ValidateSerializedFile(filename.FullName, out var fileInfo))
return 1;
if (!SerializedFileDetector.TryParseMetadata(filename.FullName, fileInfo, out var metadata, out var errorMessage))
{
Console.Error.WriteLine($"Error: Failed to parse external references for: {filename.FullName}");
Console.Error.WriteLine(errorMessage);
return 1;
}
if (metadata.ExternalReferences == null)
{
Console.Error.WriteLine($"Error: External references could not be parsed for: {filename.FullName}");
return 1;
}
if (format == OutputFormat.Json)
OutputExternalRefsJson(metadata.ExternalReferences);
else
OutputExternalRefsText(metadata.ExternalReferences);
return 0;
}
public static int ListObjects(FileInfo filename, OutputFormat format)
{
// The object list is read directly from the parsed metadata rather than via UnityFileSystemApi.
// (See comment in ListExternalRefs() for the reasons for doing it that way)
if (!ValidateSerializedFile(filename.FullName, out var fileInfo))
return 1;
if (!SerializedFileDetector.TryParseMetadata(filename.FullName, fileInfo, out var metadata, out var errorMessage))
{
Console.Error.WriteLine($"Error: Failed to parse object list for: {filename.FullName}");
Console.Error.WriteLine(errorMessage);
return 1;
}
if (metadata.ObjectList == null)
{
Console.Error.WriteLine($"Error: Object list could not be parsed for: {filename.FullName}");
return 1;
}
if (format == OutputFormat.Json)
OutputObjectListJson(metadata.ObjectList);
else
OutputObjectListText(metadata.ObjectList);
return 0;
}
public static int PrintHeader(FileInfo filename, OutputFormat format)
{
if (!ValidateSerializedFile(filename.FullName, out var fileInfo))
return 1;
if (format == OutputFormat.Json)
OutputHeaderJson(fileInfo);
else
OutputHeaderText(fileInfo);
return 0;
}
public static int PrintMetadata(FileInfo filename, OutputFormat format)
{
if (!ValidateSerializedFile(filename.FullName, out var fileInfo))
return 1;
if (!SerializedFileDetector.TryParseMetadata(filename.FullName, fileInfo, out var metadata, out var errorMessage))
{
Console.Error.WriteLine($"Error: Failed to parse metadata for: {filename.FullName}");
Console.Error.WriteLine(errorMessage);
return 1;
}
if (format == OutputFormat.Json)
OutputMetadataJson(metadata);
else
OutputMetadataText(metadata);
return 0;
}
/// <summary>
/// Validates that a file is a SerializedFile and provides helpful error messages if not.
/// </summary>
/// <param name="filePath">Path to the file to validate</param>
/// <param name="fileInfo">SerializedFile header information if valid, null otherwise</param>
/// <returns>True if valid SerializedFile, false otherwise</returns>
private static bool ValidateSerializedFile(string filePath, out SerializedFileInfo fileInfo)
{
fileInfo = null;
if (!File.Exists(filePath))
{
Console.Error.WriteLine($"Error: File not found: {filePath}");
return false;
}
if (ArchiveDetector.IsUnityArchive(filePath))
{
Console.Error.WriteLine($"Error: The file is an AssetBundle or other Unity Archive, not a SerializedFile.");
Console.Error.WriteLine($"File: {filePath}");
Console.Error.WriteLine();
Console.Error.WriteLine("Unity Archives contain SerializedFiles inside them.");
Console.Error.WriteLine("To access the SerializedFiles, first extract the archive using:");
Console.Error.WriteLine($" UnityDataTool archive extract \"{filePath}\" -o <output-directory>");
Console.Error.WriteLine();
Console.Error.WriteLine("Then you can run serialized-file commands on the extracted files.");
return false;
}
if (YamlSerializedFileDetector.IsYamlSerializedFile(filePath))
{
Console.Error.WriteLine($"Error: The file is a YAML-format SerializedFile, which is not supported.");
Console.Error.WriteLine($"File: {filePath}");
Console.Error.WriteLine();
Console.Error.WriteLine("UnityDataTool only supports binary-format SerializedFiles.");
return false;
}
if (!SerializedFileDetector.TryDetectSerializedFile(filePath, out fileInfo))
{
Console.Error.WriteLine($"Error: The file does not appear to be a valid Unity SerializedFile.");
Console.Error.WriteLine($"File: {filePath}");
return false;
}
return true;
}
private static void OutputExternalRefsText(ExternalReference[] refs)
{
for (int i = 0; i < refs.Length; i++)
{
var extRef = refs[i];
var displayValue = !string.IsNullOrEmpty(extRef.Path) ? extRef.Path : extRef.Guid;
Console.WriteLine($"Index: {i + 1}, Path: {displayValue}");
}
}
private static void OutputExternalRefsJson(ExternalReference[] refs)
{
var jsonArray = new object[refs.Length];
for (int i = 0; i < refs.Length; i++)
{
var extRef = refs[i];
jsonArray[i] = new
{
index = i + 1,
path = extRef.Path,
guid = extRef.Guid,
type = extRef.Type.ToString()
};
}
var json = JsonSerializer.Serialize(jsonArray, new JsonSerializerOptions { WriteIndented = true });
Console.WriteLine(json);
}
private static void OutputObjectListText(ObjectInfo[] objects)
{
Console.WriteLine($"{"Id",-20} {"Type",-40} {"Offset",-15} {"Size",-15}");
Console.WriteLine(new string('-', 90));
foreach (var obj in objects)
Console.WriteLine($"{obj.Id,-20} {TypeIdRegistry.GetTypeName(obj.TypeId),-40} {obj.Offset,-15} {obj.Size,-15}");
}
private static void OutputObjectListJson(ObjectInfo[] objects)
{
var jsonArray = new object[objects.Length];
for (int i = 0; i < objects.Length; i++)
{
var obj = objects[i];
jsonArray[i] = new
{
id = obj.Id,
typeId = obj.TypeId,
typeName = TypeIdRegistry.GetTypeName(obj.TypeId),
offset = obj.Offset,
size = obj.Size
};
}
var json = JsonSerializer.Serialize(jsonArray, new JsonSerializerOptions { WriteIndented = true });
Console.WriteLine(json);
}
private static void OutputHeaderText(SerializedFileInfo info)
{
Console.WriteLine($"{"Version",-20} {info.Version}");
Console.WriteLine($"{"Format",-20} {(info.IsLegacyFormat ? "Legacy (32-bit)" : "Modern (64-bit)")}");
Console.WriteLine($"{"File Size",-20} {info.FileSize:N0} bytes");
Console.WriteLine($"{"Metadata Size",-20} {info.MetadataSize:N0} bytes");
Console.WriteLine($"{"Data Offset",-20} {info.DataOffset:N0}");
Console.WriteLine($"{"Endianness",-20} {(info.Endianness == 0 ? "Little Endian" : "Big Endian")}");
}
private static void OutputHeaderJson(SerializedFileInfo info)
{
var jsonObject = new
{
version = info.Version,
format = info.IsLegacyFormat ? "Legacy (32-bit)" : "Modern (64-bit)",
fileSize = info.FileSize,
metadataSize = info.MetadataSize,
dataOffset = info.DataOffset,
endianness = info.Endianness == 0 ? "Little Endian" : "Big Endian"
};
var json = JsonSerializer.Serialize(jsonObject, new JsonSerializerOptions { WriteIndented = true });
Console.WriteLine(json);
}
private static void OutputMetadataText(SerializedFileMetadata metadata)
{
string typeTreeDefinitions;
if (!metadata.EnableTypeTree)
typeTreeDefinitions = "No";
else if (metadata.TypeTrees == null || metadata.TypeTrees.Length == 0)
typeTreeDefinitions = "Unknown";
else if (metadata.TypeTrees.All(t => t.InlineTypeTree))
typeTreeDefinitions = "Inline";
else if (metadata.TypeTrees.Any(t => t.InlineTypeTree))
typeTreeDefinitions = "Mixed"; // unexpected: entries disagree on inline vs external
else
typeTreeDefinitions = "External";
Console.WriteLine($"{"Unity Version",-20} {metadata.UnityVersion}");
Console.WriteLine($"{"Target Platform",-20} {metadata.TargetPlatform}");
Console.WriteLine($"{"TypeTree Definitions",-20} {typeTreeDefinitions}");
Console.WriteLine($"{"TypeTree Count",-20} {metadata.TypeTreeCount}");
Console.WriteLine($"{"RefType Count",-20} {metadata.SerializedReferenceTypeTreeCount}");
}
private static void OutputMetadataJson(SerializedFileMetadata metadata)
{
var jsonObject = new
{
unityVersion = metadata.UnityVersion,
targetPlatform = metadata.TargetPlatform,
enableTypeTree = metadata.EnableTypeTree,
typeTreeCount = metadata.TypeTreeCount,
serializedReferenceTypeTreeCount = metadata.SerializedReferenceTypeTreeCount,
typeTrees = metadata.TypeTrees?.Select(TypeTreeInfoToJson).ToArray(),
serializedReferenceTypeTrees = metadata.SerializedReferenceTypeTrees?.Select(TypeTreeInfoToJson).ToArray(),
scriptTypes = metadata.ScriptTypes?.Select(s => new { fileID = s.FileID, pathID = s.PathID }).ToArray(),
};
var json = JsonSerializer.Serialize(jsonObject, new JsonSerializerOptions { WriteIndented = true });
Console.WriteLine(json);
}
private static object TypeTreeInfoToJson(BinaryFormat.TypeTreeInfo info)
{
return new
{
persistentTypeID = info.PersistentTypeID,
isStrippedType = info.IsStrippedType,
scriptTypeIndex = info.ScriptTypeIndex,
scriptID = info.ScriptID.ToString(),
typeTreeStructureHash = info.TypeTreeStructureHash.ToString(),
typeTreeContentHash = info.TypeTreeContentHash.ToString(),
typeTreeSerializedSize = info.TypeTreeSerializedSize,
inlineTypeTree = info.InlineTypeTree,
className = info.ClassName,
namespaceName = info.Namespace,
assemblyName = info.AssemblyName,
typeDependencies = info.TypeDependencies,
};
}
}