forked from K0lb3/UnityPy
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathEndianBinaryReader.py
More file actions
416 lines (355 loc) · 13.8 KB
/
Copy pathEndianBinaryReader.py
File metadata and controls
416 lines (355 loc) · 13.8 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
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
from struct import Struct, unpack
import re
from typing import Type, List, Union, Callable, TYPE_CHECKING
from io import BytesIO, IOBase, SEEK_END, SEEK_SET, SEEK_CUR
from sys import byteorder
from ..exceptions import sanity_check, ReadingPastObject
import weakref
if TYPE_CHECKING:
from ..files.ObjectReader import ObjectReader
from .. import config
DEBUG = config.DEBUG
#if DEBUG:
#import traceback
SYS_ENDIAN = "<" if byteorder == "little" else ">"
RE_NOT_0 = re.compile(b"(.*?)\0", re.S)
from ..math import Color, Matrix4x4, Quaternion, Vector2, Vector3, Vector4, Rectangle
# generate unpack and unpack_from functions
TYPE_PARAM_SIZE_LIST = [
# TYPE_NAME, STRUCT_TYPE_ID, TYPE_SIZE, NATIVE_TYPE
("bool", "?", 1, bool),
("boolean", "?", 1, bool),
("byte", "b", 1, None),
("u_byte", "B", 1, None),
("short", "h", 2, None),
("u_short", "H", 2, None),
("int", "i", 4, None),
("u_int", "I", 4, None),
("long", "q", 8, None),
("u_long", "Q", 8, None),
("half", "e", 2, None),
("float", "f", 4, None),
("double", "d", 8, None),
("quaternion", "4f", 4 * 4, Quaternion),
("color3", "3f", 3 * 4, Color),
("color4", "4f", 4 * 4, Color),
("rectangle_f", "4f", 4 * 4, Rectangle),
("matrix", "16f", 16 * 4, Matrix4x4),
("vector2", "2f", 2 * 4, Vector2),
("vector3", "3f", 3 * 4, Vector3),
("vector4", "4f", 4 * 4, Vector4),
]
class EndianBinaryReader:
Length: int
Position: int
BaseOffset: int
Crypto: Callable
def __new__(
cls,
item: Union[bytes, bytearray, memoryview, BytesIO, str],
endian=">",
offset=0,
size=-1,
crypto_func=None
):
in_memory = False
if isinstance(item, (bytes, bytearray, memoryview)):
in_memory = True
elif isinstance(item, str):
item = open(item, "rb")
elif issubclass(item.__class__, EndianBinaryReader):
item = (
item.stream if isinstance(item, EndianBinaryReader_Streamable) else item.view
)
if in_memory:
obj = super(EndianBinaryReader, cls).__new__(EndianBinaryReader_Memoryview)
setattr(obj, "view", memoryview(item))
else:
#assert issubclass(item.__calss__, IOBase), "Must be IOBase for streams"
obj = super(EndianBinaryReader, cls).__new__(EndianBinaryReader_Streamable)
setattr(obj, "stream", item)
return obj
def __init__(self, item, endian:str=None, offset:int=0, size:int=0, crypto_func:Callable=None):
self.Crypto = crypto_func
self._endian = ""
self.BaseOffset = offset
self.Position = 0
def read(self, *args):
# implemented by Streamable and Memoryview versions
raise NotImplementedError("read not implemented")
def within_size(self):
return self.Position - self.BaseOffset < self._size
def read_bytes(self, num) -> bytes:
return self.read(num)
def read_string(self, size=None, encoding="utf-8") -> str:
if size is None:
ret = self.read_string_to_null()
else:
ret = unpack(f"{self.endian}{size}is", self.read(size))[0]
try:
return ret.decode(encoding)
except UnicodeDecodeError:
return ret
def read_string_to_null(self, max_length=32767) -> str:
ret = []
c = b""
length = 0
while c != b"\0" and len(ret) <= max_length and self.Position != self.Length:
ret.append(c)
c = self.read(1)
length += 1
if False and DEBUG:
sanity_check("read_string_to_null length", length, max_length)
if not c:
raise ValueError("Unterminated string: %r" % ret)
return b"".join(ret).decode("utf-8", "surrogateescape")
def read_aligned_string(self) -> str:
length = self.read_int()
if DEBUG:
sanity_check("read_aligned_string length", length, self.Length)
if 0 < length <= self.Length - self.Position:
string_data = bytes(self.read_bytes(length))
result = string_data.decode("utf-8", "surrogateescape")
self.align_stream()
return result
return ""
def align_stream(self, alignment=4):
self.Position += (alignment - self.Position % alignment) % alignment
def read_color_uint(self):
r = self.read_u_byte()
g = self.read_u_byte()
b = self.read_u_byte()
a = self.read_u_byte()
return Color(r / 255.0, g / 255.0, b / 255.0, a / 255.0)
def read_byte_array(self) -> bytes:
return self.read(self.read_int())
def read_array(self, command, length: int = None) -> list:
if length is None:
length = self.read_u_int()
return [command() for _ in range(length)]
def read_vector(self, command) -> list:
length = self.read_u_int()
sanity_check("read_vector", length)
if command is None: # byte/char vector
return self.read(length)
return [command() for _ in range(length)]
def read_map(self, command1, command2) -> dict:
length = self.read_u_int()
sanity_check("read_map", length)
result = {}
for _ in range(length):
key = command1() # this is possible since Object impl. __hash__ and __eq__
result[key] = command2()
return result
def read_array_struct(self, param: str, length: int = None) -> list:
if not length:
length = self.read_int()
struct = Struct(f"{self.endian}{length}{param}")
return struct.unpack(self.read(struct.size))
def read_string_array(self, length: int = None) -> List[str]:
if not length:
length = self.read_int()
return self.read_array(self.read_aligned_string, length)
def real_offset(self) -> int:
"""Returns offset in the underlying file.
(Not working with unpacked streams.)
"""
return self.BaseOffset + self.Position
def read_the_rest(self):
return self.read(self.Length - self.Position)
class EndianBinaryReader_Memoryview(EndianBinaryReader):
__slots__ = ("view", "_endian", "BaseOffset", "Position", "Length", "Crypto")
view: memoryview
endian: str
def __init__(self, view, endian=">", offset=0, size=None, crypto_func: Callable = None):
super().__init__(view, endian=endian, offset=offset, size=size, crypto_func=crypto_func)
self.Length = len(view)
self.endian = endian
@property
def endian(self):
return self._endian
def set_endian_be(self):
if ">" != self._endian:
setattr(self,"__class__", EndianBinaryReader_Memoryview_BigEndian)
self._endian = ">"
def set_endian_le(self):
if "<" != self._endian:
setattr(self,"__class__", EndianBinaryReader_Memoryview_LittleEndian)
self._endian = "<"
@endian.setter
def endian(self, value: str):
if value not in ("<", ">", "little", "big"):
raise ValueError("Invalid endian")
self.set_endian_le() if value in (
"<", "little") else self.set_endian_be()
@property
def bytes(self) -> memoryview:
return self.save()
def save(self) -> memoryview:
if self.Crypto is not None:
return self.Crypto(self.view, self.Position)
return self.view
def close(self):
if self.view:
if hasattr(self.view, "release"):
self.view.release()
if hasattr(self.view, "close"):
self.view.close()
self.view = None
def seek(self, value):
if value < self.Length:
self.Position = value
else:
self.Position = self.Length
return self.Position
def seek_relative(self, value):
new_position = self.Position + value
if new_position < self.Length:
self.Position = new_position
else:
self.Position = self.Length
return self.Position
def read(self, length: int):
if not length:
return b""
ret = self.view[self.Position : self.Position + length]
if self.Crypto is not None:
ret = self.Crypto(ret, self.Position)
self.Position += length
return ret
def read_aligned_string(self):
length = self.read_int()
if 0 < length <= self.Length - self.Position:
string_data = self.read_bytes(length)
self.align_stream()
return bytes(string_data).decode("utf-8", "surrogateescape")
return ""
class EndianBinaryReader_Memoryview_LittleEndian(EndianBinaryReader_Memoryview):
pass
class EndianBinaryReader_Memoryview_BigEndian(EndianBinaryReader_Memoryview):
pass
class EndianBinaryReader_Streamable(EndianBinaryReader):
__slots__ = ("stream", "_endian", "BaseOffset", "Crypto")
stream: IOBase
endian: str
def __init__(self, stream, endian=">", offset=0, size=-1, crypto_func: Callable = None):
super().__init__(stream, endian=endian, offset=offset, size=size, crypto_func=crypto_func)
self.endian = endian
self._size = size
self._size_checked = False
self._finalizer = weakref.finalize(self, self.close, self.stream)
def get_position(self):
return self.stream.tell() - self.BaseOffset
def set_position(self, value):
self.stream.seek(value + self.BaseOffset, SEEK_SET)
def seek(self, value):
self.stream.seek(value + self.BaseOffset, SEEK_SET)
return self.Position
def seek_relative(self, value):
self.stream.seek(value, SEEK_CUR)
return self.Position
def set_endian_be(self):
if ">" != self._endian:
setattr(self,"__class__", EndianBinaryReader_Streamable_BigEndian)
self._endian = ">"
def set_endian_le(self):
if "<" != self._endian:
setattr(self,"__class__", EndianBinaryReader_Streamable_LittleEndian)
self._endian = "<"
@property
def endian(self):
return self._endian
@endian.setter
def endian(self, value):
if value not in ("<", ">", "little", "big"):
raise ValueError(f"Invalid endianness: {value}")
self.set_endian_le() if value in (
"<", "little") else self.set_endian_be()
@property
def Length(self):
if self._size <= 0:
pos = self.Position
self._size = self.stream.seek(0, SEEK_END) - self.BaseOffset
self.Position = pos
elif not self._size_checked and self._size > 0:
pos = self.Position
self._size = min(self.stream.seek(0, SEEK_END) - self.BaseOffset, self._size)
self.Position = pos
self._size_checked = True
return self._size
Position = property(get_position, set_position)
def save(self) -> bytes:
last_pos = self.Position
self.Position = 0
ret = self.read(self.Length)
self.Position = last_pos
if self.Crypto is not None:
return self.Crypto(ret, last_pos)
return ret
def close(self, stream=None):
#print_debug(f"Closing stream {stream}")
if stream is None:
if self.stream:
self.stream.close()
self.stream = None
else:
stream.close()
def read(self, length: int):
if not length:
return b""
pos = self.Position
ret = self.stream.read(length)
if self.Crypto is not None:
return self.Crypto(ret, pos)
return ret
class EndianBinaryReader_Streamable_LittleEndian(EndianBinaryReader_Streamable):
pass
class EndianBinaryReader_Streamable_BigEndian(EndianBinaryReader_Streamable):
pass
def generate_streamable_read_method(endian, type_id, native_type):
data_format = Struct(f"{endian}{type_id}")
size = data_format.size
if native_type is not None:
def _method_body(self):
return native_type(*data_format.unpack(self.read(size)))
else:
def _method_body(self):
return data_format.unpack(self.read(size))[0]
return _method_body
def generate_memoryview_read_method(endian, type_id, native_type):
data_format = Struct(f"{endian}{type_id}")
size = data_format.size
if native_type is not None:
def _method_body(self):
ret = data_format.unpack_from(self.view, self.Position)
self.Position += size
return native_type(*ret)
else:
def _method_body(self):
ret = data_format.unpack_from(self.view, self.Position)
self.Position += size
return ret[0]
return _method_body
def generate_array_read_method(type_name):
reader_method = f"read_{type_name}"
def _method_body(self, length=None):
if not length:
length = self.read_int()
if DEBUG:
sanity_check(f"{type_name} array", length)
return self.read_array(getattr(self, reader_method), length)
return _method_body
# generate methods for reading each type
for endian_s, endian_l in (("<", "little"), (">", "big")):
for type_name, type_id, size, native_type in TYPE_PARAM_SIZE_LIST:
if type_name != "byte":
setattr(EndianBinaryReader, f"read_{type_name}_array", generate_array_read_method(type_name))
if endian_l == "big":
clsm = EndianBinaryReader_Memoryview_BigEndian
clss = EndianBinaryReader_Streamable_BigEndian
else:
clsm = EndianBinaryReader_Memoryview_LittleEndian
clss = EndianBinaryReader_Streamable_LittleEndian
setattr(clsm, f"read_{type_name}", generate_memoryview_read_method(endian_s, type_id, native_type))
setattr(clss, f"read_{type_name}", generate_streamable_read_method(endian_s, type_id, native_type))
pass