This repository has been archived by the owner on Jan 1, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
/
nbt.py
282 lines (233 loc) · 7.79 KB
/
nbt.py
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
from struct import pack, unpack
from gzip import GzipFile
TAG_END = 0
TAG_BYTE = 1
TAG_SHORT = 2
TAG_INT = 3
TAG_LONG = 4
TAG_FLOAT = 5
TAG_DOUBLE = 6
TAG_BYTE_ARRAY = 7
TAG_STRING = 8
TAG_LIST = 9
TAG_COMPOUND = 10
class TAG(object):
"""Each Tag needs to take a buffer, an index into the buffer and return the index that it stops reading at."""
id = None
def __init__(self, value=None, name=None):
if name: self.name = TAG_String(name)
else: self.name = None
self.value = value
#Parsers and Generators
def _parse_buffer(self, buffer):
raise NotImplementedError(self.__class__.__name__)
def _render_buffer(self, buffer, offset=None):
raise NotImplementedError(self.__class__.__name__)
#Printing and Formatting of tree
def tag_info(self):
if self.name:
return self.__class__.__name__ + \
('("%s")'%self.name) + \
": " + self.__repr__()
else:
return self.__class__.__name__ + \
('("%s")'%"") + \
": " + self.__repr__()
def pretty_tree(self, indent=0):
return ("\t"*indent) + self.tag_info()
class _TAG_Numeric(TAG):
def __init__(self, unpack_as, size, buffer=None, value=None, name=None):
super(_TAG_Numeric, self).__init__(value, name)
self.unpack_as = unpack_as
self.size = size
if buffer:
self._parse_buffer(buffer)
#Parsers and Generators
def _parse_buffer(self, buffer, offset=None):
self.value = unpack(self.unpack_as, buffer.read(self.size))[0]
def _render_buffer(self, buffer, offset=None):
buffer.write(pack(self.unpack_as, self.value))
#Printing and Formatting of tree
def __repr__(self):
return str(self.value)
class TAG_Byte(_TAG_Numeric):
id = TAG_BYTE
def __init__(self, value=None, name=None, buffer=None):
super(TAG_Byte, self).__init__(">b", 1, buffer, value, name)
class TAG_Short(_TAG_Numeric):
id = TAG_SHORT
def __init__(self, value=None, name=None, buffer=None):
super(TAG_Short, self).__init__(">h", 2, buffer, value, name)
class TAG_Int(_TAG_Numeric):
id = TAG_INT
def __init__(self, value=None, name=None, buffer=None):
super(TAG_Int, self).__init__(">i", 4, buffer, value, name)
class TAG_Long(_TAG_Numeric):
id = TAG_LONG
def __init__(self, value=None, name=None, buffer=None):
super(TAG_Long, self).__init__(">q", 8, buffer, value, name)
class TAG_Float(_TAG_Numeric):
id = TAG_FLOAT
def __init__(self, value=None, name=None, buffer=None):
super(TAG_Float, self).__init__(">f", 4, buffer, value, name)
class TAG_Double(_TAG_Numeric):
id = TAG_DOUBLE
def __init__(self, value=None, name=None, buffer=None):
super(TAG_Double, self).__init__(">d", 8, buffer, value, name)
class TAG_Byte_Array(TAG):
id = TAG_BYTE_ARRAY
def __init__(self, buffer=None):
super(TAG_Byte_Array, self).__init__()
self.tags = []
if buffer:
self._parse_buffer(buffer)
#Parsers and Generators
def _parse_buffer(self, buffer, offset=None):
self.length = TAG_Int(buffer=buffer)
self.value = buffer.read(self.length.value)
def _render_buffer(self, buffer, offset=None):
self.length._render_buffer(buffer, offset)
buffer.write(self.value)
#Printing and Formatting of tree
def __repr__(self):
return "[%i bytes]" % self.length.value
class TAG_String(TAG):
id = TAG_STRING
def __init__(self, value=None, name=None, buffer=None):
super(TAG_String, self).__init__(value, name)
if buffer:
self._parse_buffer(buffer)
#Parsers and Generators
def _parse_buffer(self, buffer, offset=None):
self.length = TAG_Short(buffer=buffer)
if self.length.value > 0:
self.value = unicode(buffer.read(self.length.value), "utf-8")
else: self.value = None
def _render_buffer(self, buffer, offset=None):
if self.value:
save_val = self.value.encode("utf-8")
self.length.value = len(save_val)
self.length._render_buffer(buffer, offset)
if self.length > 0:
buffer.write(save_val)
else:
self.length.value = 0
self.length._render_buffer(buffer, offset)
#Printing and Formatting of tree
def __repr__(self):
return self.value
class TAG_List(TAG):
id = TAG_LIST
def __init__(self, name=None, type=None, buffer=None):
super(TAG_List, self).__init__(name=name)
if type:
self.tagID = TAG_Byte(value = type.id)
else: self.tagID = None
self.length = None
self.tags = []
if buffer:
self._parse_buffer(buffer)
#Parsers and Generators
def _parse_buffer(self, buffer, offset=None):
self.tagID = TAG_Byte(buffer=buffer)
self.length = TAG_Int(buffer=buffer)
for x in range(self.length.value):
self.tags.append(TAGLIST[self.tagID.value](buffer=buffer))
def _render_buffer(self, buffer, offset=None):
self.tagID._render_buffer(buffer, offset)
self.length._render_buffer(buffer, offset)
for tag in self.tags:
tag._render_buffer(buffer, offset)
#Printing and Formatting of tree
def __repr__(self):
return "%i entries of type %s" % (len(self.tags), TAGLIST[self.tagID.value].__name__)
def pretty_tree(self, indent=0):
output = [super(TAG_List,self).pretty_tree(indent)]
if len(self.tags):
output.append(("\t"*indent) + "{")
output.extend([tag.pretty_tree(indent+1) for tag in self.tags])
output.append(("\t"*indent) + "}")
return '\n'.join(output)
class TAG_Compound(TAG):
id = TAG_COMPOUND
def __init__(self, buffer=None):
super(TAG_Compound, self).__init__()
self.tags = []
if buffer:
self._parse_buffer(buffer)
#Parsers and Generators
def _parse_buffer(self, buffer, offset=None):
while True:
type = TAG_Byte(buffer=buffer)
if type.value == TAG_END:
#print "found tag_end"
break
else:
name = TAG_String(buffer=buffer)
try:
#DEBUG print type, name
tag = TAGLIST[type.value](buffer=buffer)
tag.name = name
self.tags.append(tag)
except KeyError:
raise ValueError("Unrecognised tag type")
def _render_buffer(self, buffer, offset=None):
for tag in self.tags:
TAG_Byte(tag.id)._render_buffer(buffer, offset)
tag.name._render_buffer(buffer, offset)
tag._render_buffer(buffer,offset)
buffer.write('\x00') #write TAG_END
#Accessors
def __getitem__(self, key):
if isinstance(key,int):
return self.tags[key]
elif isinstance(key, str):
for tag in self.tags:
if tag.name.value == key:
return tag
else:
raise KeyError("A tag with this name does not exist")
else:
raise ValueError("key needs to be either name of tag, or index of tag")
#Printing and Formatting of tree
def __repr__(self):
return '%i Entries' % len(self.tags)
def pretty_tree(self, indent=0):
output = [super(TAG_Compound,self).pretty_tree(indent)]
if len(self.tags):
output.append(("\t"*indent) + "{")
output.extend([tag.pretty_tree(indent+1) for tag in self.tags])
output.append(("\t"*indent) + "}")
return '\n'.join(output)
TAGLIST = {TAG_BYTE:TAG_Byte, TAG_SHORT:TAG_Short, TAG_INT:TAG_Int, TAG_LONG:TAG_Long, TAG_FLOAT:TAG_Float, TAG_DOUBLE:TAG_Double, TAG_BYTE_ARRAY:TAG_Byte_Array, TAG_STRING:TAG_String, TAG_LIST:TAG_List, TAG_COMPOUND:TAG_Compound}
class NBTFile(TAG_Compound):
"""Represents an NBT file object"""
def __init__(self, filename=None, mode=None, buffer=None):
super(NBTFile,self).__init__()
self.__class__.__name__ = "TAG_Compound"
if filename:
self.file = GzipFile(filename, mode)
self.parse_file(self.file)
def parse_file(self, file=None):
if not file:
file = self.file
if file:
self.type = TAG_Byte(buffer=file)
if self.type.value == self.id:
name = TAG_String(buffer=file)
self._parse_buffer(file)
self.name = name
self.file.close()
else:
raise ValueError("First record is not a Compound Tag")
def write_file(self, filename=None, file=None):
if file:
self.file = file
elif filename:
self.file = GzipFile(filename, "wb")
else:
raise ValueError("Need to specify either a filename or a file")
#Render tree to file
self.type._render_buffer(file)
self.name._render_buffer(file)
self._render_buffer(file)