forked from K0lb3/UnityPy
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathEndianBinaryReader.py
More file actions
349 lines (277 loc) · 12.1 KB
/
EndianBinaryReader.py
File metadata and controls
349 lines (277 loc) · 12.1 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
from __future__ import annotations
import builtins
import re
import sys
from io import BufferedReader, IOBase
from struct import Struct, unpack
from types import MethodType
from typing import Any, Callable, ClassVar, Dict, List, Literal, Optional, Tuple, Union
reNot0 = re.compile(b"(.*?)\x00", re.S)
SYS_ENDIAN = "<" if sys.byteorder == "little" else ">"
Endianess = Literal["<", ">"]
# generate unpack and unpack_from functions
TYPE_PARAM_SIZE_LIST = [
("short", "h"),
("u_short", "H"),
("int", "i"),
("u_int", "I"),
("long", "q"),
("u_long", "Q"),
("half", "e"),
("float", "f"),
("double", "d"),
]
MEMORY_FUNCTIONS: Dict[Endianess, Dict[str, Callable[["EndianBinaryReader_Memoryview"], Any]]] = {"<": {}, ">": {}}
STREAM_FUNCTIONS: Dict[Endianess, Dict[str, Callable[["EndianBinaryReader_Streamable"], Any]]] = {"<": {}, ">": {}}
class EndianBinaryReader:
Length: int
Position: int
BaseOffset: int
_endian: Endianess
_function_map: ClassVar[Dict[Endianess, Dict[str, Callable]]]
def __new__(
cls,
item: Union[bytes, bytearray, memoryview, IOBase, str],
endian: Endianess = ">",
offset: int = 0,
):
if isinstance(item, (bytes, bytearray, memoryview)):
obj = super(EndianBinaryReader, cls).__new__(EndianBinaryReader_Memoryview) # type: ignore
elif isinstance(item, IOBase):
obj = super(EndianBinaryReader, cls).__new__(EndianBinaryReader_Streamable) # type: ignore
elif isinstance(item, str):
obj = super(EndianBinaryReader, cls).__new__(EndianBinaryReader_Streamable_LocalFile) # type: ignore
elif isinstance(item, EndianBinaryReader):
item = item.stream if isinstance(item, EndianBinaryReader_Streamable) else item.view
return EndianBinaryReader(item, endian, offset)
elif hasattr(item, "read"):
if hasattr(item, "seek") and hasattr(item, "tell"):
obj = super(EndianBinaryReader, cls).__new__(EndianBinaryReader_Streamable)
else:
item = item.read()
obj = super(EndianBinaryReader, cls).__new__(EndianBinaryReader_Memoryview)
else:
raise TypeError("Unsupported type for EndianBinaryReader: %s" % type(item))
return obj
def __init__(self, item, endian: Endianess = ">", offset: int = 0):
self._endian = "" # type: ignore
self.endian = endian
self.BaseOffset = offset
self.Position = 0
@property
def endian(self) -> Endianess:
return self._endian
@endian.setter
def endian(self, value: Endianess):
if value not in ("<", ">"):
raise ValueError("Invalid endian")
if value != self._endian:
for func_name, func in self._function_map[value].items():
setattr(self, func_name, MethodType(func, self))
self._endian = value
@property
def bytes(self) -> builtins.bytes:
# implemented by Streamable and Memoryview versions
return b""
def read(self, size: Optional[int] = -1, /) -> builtins.bytes:
# implemented by Streamable and Memoryview versions
return b""
def read_byte(self) -> int:
return unpack(self.endian + "b", self.read(1))[0]
def read_u_byte(self) -> int:
return unpack(self.endian + "B", self.read(1))[0]
def read_bytes(self, num: int) -> builtins.bytes:
return self.read(num)
def read_short(self) -> int:
return unpack(self.endian + "h", self.read(2))[0]
def read_int(self) -> int:
return unpack(self.endian + "i", self.read(4))[0]
def read_long(self) -> int:
return unpack(self.endian + "q", self.read(8))[0]
def read_u_short(self) -> int:
return unpack(self.endian + "H", self.read(2))[0]
def read_u_int(self) -> int:
return unpack(self.endian + "I", self.read(4))[0]
def read_u_long(self) -> int:
return unpack(self.endian + "Q", self.read(8))[0]
def read_float(self) -> float:
return unpack(self.endian + "f", self.read(4))[0]
def read_double(self) -> float:
return unpack(self.endian + "d", self.read(8))[0]
def read_boolean(self) -> bool:
return bool(unpack(self.endian + "?", self.read(1))[0])
def read_string(self, size: Optional[int] = None) -> str:
if size is None:
return self.read_string_to_null()
else:
raw = self.read_bytes(size)
return raw.decode("utf8", "surrogateescape")
def read_string_to_null(self, max_length: int = 32767) -> str:
ret = []
c = b""
while c != b"\0" and len(ret) < max_length and self.Position != self.Length:
ret.append(c)
c = self.read(1)
if not c:
raise ValueError("Unterminated string: %r" % ret)
return b"".join(ret).decode("utf8", "surrogateescape")
def read_aligned_string(self) -> str:
length = self.read_int()
if 0 < length <= self.Length - self.Position:
string_data = bytes(self.read_bytes(length))
result = string_data.decode("utf8", "surrogateescape")
self.align_stream()
return result
return ""
def align_stream(self, alignment=4):
self.Position += (alignment - self.Position % alignment) % alignment
def read_byte_array(self) -> builtins.bytes:
return self.read(self.read_int())
def read_array(self, command: Callable, length: int) -> list:
return [command() for _ in range(length)]
def read_array_struct(self, param: str, length: Optional[int] = None) -> tuple:
if length is None:
length = self.read_int()
struct = Struct(f"{self.endian}{length}{param}")
return struct.unpack(self.read(struct.size))
def read_boolean_array(self, length: Optional[int] = None) -> Tuple[bool, ...]:
return self.read_array_struct("?", length)
def read_u_byte_array(self, length: Optional[int] = None) -> Tuple[int, ...]:
return self.read_array_struct("B", length)
def read_u_short_array(self, length: Optional[int] = None) -> Tuple[int, ...]:
return self.read_array_struct("h", length)
def read_short_array(self, length: Optional[int] = None) -> Tuple[int, ...]:
return self.read_array_struct("H", length)
def read_int_array(self, length: Optional[int] = None) -> Tuple[int, ...]:
return self.read_array_struct("i", length)
def read_u_int_array(self, length: Optional[int] = None) -> Tuple[int, ...]:
return self.read_array_struct("I", length)
def read_long_array(self, length: Optional[int] = None) -> Tuple[int, ...]:
return self.read_array_struct("q", length)
def read_u_long_array(self, length: Optional[int] = None) -> Tuple[int, ...]:
return self.read_array_struct("Q", length)
def read_float_array(self, length: Optional[int] = None) -> Tuple[float, ...]:
return self.read_array_struct("f", length)
def read_double_array(self, length: Optional[int] = None) -> Tuple[float, ...]:
return self.read_array_struct("d", length)
def read_string_array(self) -> List[str]:
return self.read_array(self.read_aligned_string, self.read_int())
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, obj_start: int, obj_size: int) -> builtins.bytes:
"""Returns the rest of the current reader bytes."""
return self.read_bytes(obj_size - (self.Position - obj_start))
def seek(self, offset: int, whence: int = 0) -> int:
if whence == 0:
new_pos = offset
elif whence == 1:
new_pos = self.Position + offset
elif whence == 2:
new_pos = self.Length + offset
else:
raise ValueError("Invalid whence value")
if new_pos < 0:
raise ValueError("New position is before the start of the stream")
self.Position = new_pos
return self.Position
def tell(self) -> int:
return self.Position
class EndianBinaryReader_Memoryview(EndianBinaryReader):
__slots__ = ("view", "_endian", "BaseOffset", "Position", "Length")
_endian: Endianess
view: memoryview
_function_map = MEMORY_FUNCTIONS
def __init__(self, view, endian: Endianess = ">", offset: int = 0):
super().__init__(view, endian=endian, offset=offset)
self.view = memoryview(view)
self.Length = len(view)
@property
def bytes(self):
return self.view.tobytes()
def dispose(self) -> None:
self.view.release()
def read(self, size: Optional[int] = -1, /):
if not size:
return b""
if size == -1:
size = self.Length - self.Position
ret = self.view[self.Position : self.Position + size]
self.Position += size
return ret.tobytes()
def read_array_struct(self, param: str, length: Optional[int] = None) -> tuple:
if length is None:
length = self.read_int()
struct = Struct(f"{self.endian}{length}{param}")
value = struct.unpack_from(self.view, self.Position)
self.Position += struct.size
return value
def read_aligned_string(self) -> str:
length = self.read_int()
if 0 < length <= self.Length - self.Position:
string_data = self.read_bytes(length)
result = bytes(string_data).decode("utf8", "surrogateescape")
self.align_stream()
return result
return ""
def read_string_to_null(self, max_length: int = 32767) -> str:
match = reNot0.search(self.view, self.Position, self.Position + max_length)
if not match:
if self.Position + max_length >= self.Length:
raise Exception("String not terminated")
else:
return bytes(self.read_bytes(max_length)).decode("utf8", "surrogateescape")
ret = match[1].decode("utf8", "surrogateescape")
self.Position = match.end()
return ret
class EndianBinaryReader_Streamable(EndianBinaryReader):
__slots__ = ("stream", "_endian", "BaseOffset")
stream: BufferedReader
_function_map = STREAM_FUNCTIONS
def __init__(self, stream: BufferedReader, endian: Endianess = ">", offset: int = 0):
self.stream = stream
super().__init__(stream, endian=endian, offset=offset)
self.read = self.stream.read
@property
def Position(self) -> int:
return self.stream.tell() - self.BaseOffset
@Position.setter
def Position(self, value: int):
if value < 0:
raise ValueError("Position cannot be negative")
self.stream.seek(value + self.BaseOffset)
@property
def Length(self): # type: ignore
pos = self.Position
length = self.stream.seek(0, 2) - self.BaseOffset
self.Position = pos
return length
@property
def bytes(self):
last_pos = self.Position
self.Position = 0
ret = self.read(self.Length)
self.Position = last_pos # type: ignore
return ret
def dispose(self):
self.stream.close()
pass
class EndianBinaryReader_Streamable_LocalFile(EndianBinaryReader_Streamable):
def __init__(self, path: str, endian: Endianess = ">", offset: int = 0):
super().__init__(open(path, "rb"), endian=endian, offset=offset)
def __del__(self):
self.stream.close()
for endian_s in ("<", ">"):
for reader_type_name, struct_type_char in TYPE_PARAM_SIZE_LIST:
func_name = f"read_{reader_type_name}"
struct = Struct(f"{endian_s}{struct_type_char}")
def memory_read_func(self: EndianBinaryReader_Memoryview, /, struct=struct):
value = struct.unpack_from(self.view, self.Position)[0]
self.Position += struct.size
return value
def stream_read_func(self: EndianBinaryReader_Streamable, /, struct=struct):
return struct.unpack(self.stream.read(struct.size))[0]
MEMORY_FUNCTIONS[endian_s][func_name] = memory_read_func
STREAM_FUNCTIONS[endian_s][func_name] = stream_read_func