forked from adam2104/PyTracker
-
Notifications
You must be signed in to change notification settings - Fork 4
/
dxxtoolkit.py
563 lines (467 loc) · 22.3 KB
/
dxxtoolkit.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
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
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
__author__ = 'Adam Gensler'
import logging
import os
import re
import socket
import struct
logger = logging.getLogger('dxx_logger.dxxtoolkit')
# constants
OPCODE_REGISTER = 0
OPCODE_UNREGISTER_OR_VERSION_DENY = 1
OPCODE_GAME_LIST_REQUEST = 2
OPCODE_GAME_INFO_RESPONSE = 3
OPCODE_GAME_INFO_LITE_RESPONSE = 5
OPCODE_GAME_LIST_RESPONSE = 22
def dxx_sendto(buf, address, socket_):
logger.debug('entered dxx_sendto')
try:
socket_.sendto(buf, address)
return True
except socket.error:
logger.exception('Error occurred while sending the packet to '
'{0}:{1}'.format(address[0], address[1]))
return False
def dxx_recvfrom(socket_):
logger.debug('entered dxx_recvfrom')
try:
data, address = socket_.recvfrom(1024)
except (os.error, socket.error):
logger.exception('Error occurred while reading from the socket')
data = False
address = False
return data, address
def dxx_unpack(unpack_string, data):
logger.debug('entered dxx_unpack')
try:
return struct.unpack(unpack_string, data)
except struct.error:
logger.exception('Data unpack failed')
return False
def dxx_process_register(data):
logger.debug('entered dxx_process_register')
if len(data) == 15:
unpack_string = '=BBBHIHHH'
elif len(data) == 14:
unpack_string = '=BBBHIHHB'
else:
logger.error('Received register with incorrect length')
return False
unpacked_data = dxx_unpack(unpack_string, data)
if not unpacked_data:
logger.error('Data unpack failed')
return False
else:
logger.debug('Unpacked data: \n{0}'.format(unpacked_data))
game_data = {}
game_data['tracker_ver'] = unpacked_data[1]
game_data['version'] = unpacked_data[2]
game_data['port'] = unpacked_data[3]
game_data['game_id'] = unpacked_data[4]
game_data['release_major'] = unpacked_data[5]
game_data['release_minor'] = unpacked_data[6]
game_data['release_micro'] = unpacked_data[7]
return game_data
def dxx_process_unregister(data):
logger.debug('entered dxx_process_unregister')
if len(data) == 5:
unpack_string = '=BI'
else:
logger.error('Received unregister with incorrect length')
return False
unpacked_data = dxx_unpack(unpack_string, data)
if not unpacked_data:
logger.error('Data unpack failed')
return False
else:
logger.debug('Unpacked data: \n{0}'.format(unpacked_data))
game_data = {}
game_data['game_id'] = unpacked_data[1]
return game_data
def dxx_proto_is_redux(proto):
return proto and proto != 'unknown' and proto >= 30002 and proto <= 31000
def dxx_process_game_info_response(data, version, proto):
is_x3up = False
logger.debug('entered dxx_process_game_info_response')
if len(data) == 73:
# game_info_lite response
unpack_string = '=BHHHI16s26s9sIBBBBBBB'
elif len(data) == 519:
# d1x retro 1.3 game_info
unpack_string = ('=BHHH9sBBB9sBBB9sBBB9sBBB9sBBB9sBBB9sBBB9sBBB9s'
'BBB9sBBB9sBBB9sBBB16s26s9sIBBBBBBBBBIHHHHH18sII'
'IIIIIIhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh'
'hhhhhhhhhhhhhhhhhhhhhhhHhhhhhhhhhhhhhhhhhhIIIII'
'IIIIIIIIBBBBBBBBHBBBBBBBBBBBB')
# player data and settings are mingled together, might change over time
settings_offset = 52
elif len(data) == 520:
# d2x retro 1.3 game_info
unpack_string = ('=BHHH9sBBB9sBBB9sBBB9sBBB9sBBB9sBBB9sBBB9sBBB9s'
'BBB9sBBB9sBBB9sBBB16s26s9sIBBBBBBBBBIHHHHH18sII'
'IIIIIIhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh'
'hhhhhhhhhhhhhhhhhhhhhhhHhhhhhhhhhhhhhhhhhhIIIII'
'IIIIIIIIBBBBBBBBHBBBBBBBBBBBBB')
# player data and settings are mingled together, might change over time
settings_offset = 52
elif len(data) == 546 and version == 1:
# d1 retro 1.4X3
unpack_string = ('=BHHH9sBBBBB9sBBBBB9sBBBBB9sBBBBB9sBBBBB9sBBBBB9sBBBBB9sBBBBB9s'
'BBBBB9sBBBBB9sBBBBB9sBBBBB16s26s9sIBBBBBBBBBIHHHHH18sII'
'IIIIIIhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh'
'hhhhhhhhhhhhhhhhhhhhhhhHhhhhhhhhhhhhhhhhhhIIIII'
'IIIIIIIIBBBBBBBBHBBBBBBBBBBBBBBB')
# player data and settings are mingled together, might change over time
settings_offset = 76
is_x3up = True
elif len(data) == 549 and version == 2:
# d2 retro 1.4X3
unpack_string = ('=BHHH9sBBBBB9sBBBBB9sBBBBB9sBBBBB9sBBBBB9sBBBBB9sBBBBB9sBBBBB9s'
'BBBBB9sBBBBB9sBBBBB9sBBBBB16s26s9sIBBBBBBBBBIHHHHH18sII'
'IIIIIIhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh'
'hhhhhhhhhhhhhhhhhhhhhhhHhhhhhhhhhhhhhhhhhhIIIII'
'IIIIIIIIBBBBBBBBHBBBBBBBBBBBBBBBBBB')
# player data and settings are mingled together, might change over time
settings_offset = 76
is_x3up = True
elif dxx_proto_is_redux(proto) and len(data) >= (557 if version == 1 else 560):
# d1/d2 redux
unpack_string = ('=BHHH9sBBBBB9sBBBBB9sBBBBB9sBBBBB9sBBBBB9sBBBBB9sBBBBB9sBBBBB9s'
'BBBBB9sBBBBB9sBBBBB9sBBBBB16s26s9sIBBBBBBBBBIHHHHH18sII'
'IIIIIIhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh'
'hhhhhhhhhhhhhhhhhhhhhhhHhhhhhhhhhhhhhhhhhhIIIII'
'IIIIIIIIBBBBBBBBHBBBBBBBBBBBBBBBBBB')
unpack_string += 'B' * (len(data) - 546 - 3)
settings_offset = 76
is_x3up = True
else:
logger.error('Received game info response with incorrect length')
return False
unpacked_data = dxx_unpack(unpack_string, data)
if not unpacked_data:
logger.error('Data unpack failed')
return False
else:
logger.debug('Unpacked data: \n{0}'.format(unpacked_data))
game_data = {}
game_data['release_major'] = unpacked_data[1]
game_data['release_minor'] = unpacked_data[2]
game_data['release_micro'] = unpacked_data[3]
if len(data) == 73:
# game_info_lite response from DXX Rebirth and Retro
game_data['game_id'] = unpacked_data[4]
game_data['netgame_name'] = re.sub(r'[^a-zA-Z0-9 -_]','',unpacked_data[5].decode(errors='ignore').replace('\x00', ''))
game_data['mission_title'] = unpacked_data[6].decode(errors='ignore').replace('\x00', '')
game_data['mission_name'] = unpacked_data[7].decode(errors='ignore').replace('\x00', '')
game_data['level_num'] = unpacked_data[8]
game_data['mode'] = unpacked_data[9]
game_data['refuse_players'] = unpacked_data[10]
game_data['difficulty'] = unpacked_data[11]
game_data['status'] = unpacked_data[12]
game_data['players'] = unpacked_data[13]
game_data['max_players'] = unpacked_data[14]
game_data['flags'] = unpacked_data[15]
else:
# Full game_info response
game_data['netgame_name'] = re.sub(r'[^a-zA-Z0-9 -_]','',unpacked_data[settings_offset].decode(errors='ignore').replace('\x00', ''))
game_data['mission_title'] = unpacked_data[settings_offset+1].decode(errors='ignore').replace('\x00', '')
game_data['mission_name'] = unpacked_data[settings_offset+2].decode(errors='ignore').replace('\x00', '')
game_data['level_num'] = unpacked_data[settings_offset+3]
game_data['mode'] = unpacked_data[settings_offset+4]
game_data['refuse_players'] = unpacked_data[settings_offset+5]
game_data['difficulty'] = unpacked_data[settings_offset+6]
game_data['status'] = unpacked_data[settings_offset+7]
# num of players ever to connect to this game
game_data['num_players'] = unpacked_data[settings_offset+8]
game_data['max_players'] = unpacked_data[settings_offset+9]
# num of currently connected players
game_data['players'] = unpacked_data[settings_offset+10]
game_data['flags'] = unpacked_data[settings_offset+11]
game_data['team_vector'] = unpacked_data[settings_offset+12]
game_data['allowed_items'] = unpacked_data[settings_offset+13]
game_data['allow_marker_view'] = unpacked_data[settings_offset+14] # not used in D1
game_data['always_lighting'] = unpacked_data[settings_offset+15] # not used in D1
game_data['show_enemy_names'] = unpacked_data[settings_offset+16]
game_data['bright_ships'] = unpacked_data[settings_offset+17]
game_data['spawn_style'] = unpacked_data[settings_offset+18]
game_data['team0_name'] = unpacked_data[settings_offset+19][0:8].decode(errors='ignore').\
replace('\x00', '')
game_data['team1_name'] = unpacked_data[settings_offset+19][9:18].decode(errors='ignore').\
replace('\x00', '')
game_data['segments_checksum'] = unpacked_data[settings_offset+92]
game_data['team0_kills'] = unpacked_data[settings_offset+93]
game_data['team1_kills'] = unpacked_data[settings_offset+94]
game_data['kill_goal'] = unpacked_data[settings_offset+111] * 10
game_data['max_time'] = unpacked_data[settings_offset+112] * 5 * 60
game_data['level_time'] = unpacked_data[settings_offset+113]
game_data['reactor_life'] = int(unpacked_data[settings_offset+114] / 65535)
game_data['monitor_vector'] = unpacked_data[settings_offset+115]
game_data['packets_sec'] = unpacked_data[settings_offset+132]
game_data['short_packets'] = unpacked_data[settings_offset+133]
game_data['packet_loss_prevention'] = unpacked_data[settings_offset+134]
game_data['no_friendly_fire'] = unpacked_data[settings_offset+135]
game_data['retro_proto'] = unpacked_data[settings_offset+136]
game_data['respawn_concs'] = unpacked_data[settings_offset+137]
game_data['allow_colored_lights'] = unpacked_data[settings_offset+138]
game_data['fair_colors'] = unpacked_data[settings_offset+139]
game_data['alt_colors'] = unpacked_data[settings_offset+140]
game_data['spawn_style'] = unpacked_data[settings_offset+141]
game_data['primary_dupe'] = unpacked_data[settings_offset+142]
game_data['secondary_dupe'] = unpacked_data[settings_offset+143]
game_data['secondary_cap'] = unpacked_data[settings_offset+144]
# if this is D2 retro 1.3, we need to handle 1 extra byte of data
if len(data) == 520:
game_data['born_burner'] = unpacked_data[settings_offset+145]
# if this is d1 retro 1.4X3
if is_x3up and version == 1:
game_data['dark_smarts'] = unpacked_data[settings_offset+145]
game_data['low_vulcan'] = unpacked_data[settings_offset+146]
game_data['allow_colors'] = unpacked_data[settings_offset+147]
# if this is d2 retro 1.4X3
if is_x3up and version == 2:
game_data['dark_smarts'] = unpacked_data[settings_offset+145]
game_data['low_vulcan'] = unpacked_data[settings_offset+146]
game_data['allow_colors'] = unpacked_data[settings_offset+147]
game_data['born_burner'] = unpacked_data[settings_offset+148]
game_data['gauss_ammo_style'] = unpacked_data[settings_offset+149]
game_data['original_d1_weapons'] = unpacked_data[settings_offset+150]
if dxx_proto_is_redux(proto):
redux_settings_offset = settings_offset + (153 if version == 2 else 150)
game_data['homing_update_rate'] = unpacked_data[redux_settings_offset]
game_data['constant_homing_speed'] = unpacked_data[redux_settings_offset+1]
game_data['allow_custom_models_textures'] = unpacked_data[redux_settings_offset+2]
game_data['reduced_flash'] = unpacked_data[redux_settings_offset+3]
if version == 1:
game_data['gauss_ammo_style'] = unpacked_data[redux_settings_offset+4]
else:
game_data['disable_gauss_splash'] = unpacked_data[redux_settings_offset+4]
# player data offsets
player_step = 0
suicides_step = settings_offset + 28
deaths_step = settings_offset + 95
kills_step = settings_offset + 103
kill_table_step = settings_offset + 28
# d1/d2 retro 1.3, player data
if len(data) == 519 or len(data) == 520:
for num in range(4, 36, 4):
plr_num = 'player{0}'.format(player_step)
game_data[plr_num + 'name'] = re.sub(r'[^a-zA-Z0-9-_]','',(unpacked_data[num].decode(errors='ignore').split('\x00', 1))[0])
game_data[plr_num + 'connected'] = unpacked_data[num + 1]
game_data[plr_num + 'rank'] = unpacked_data[num + 2]
game_data[plr_num + 'deaths'] = unpacked_data[deaths_step]
game_data[plr_num + 'kills'] = unpacked_data[kills_step]
game_data[plr_num + 'suicides'] = unpacked_data[suicides_step]
# pull out the kill table data, 8x8 matrix, player0 - 7
game_data[plr_num + 'kill_table'] = []
for i in range(kill_table_step, kill_table_step + 8):
game_data[plr_num + 'kill_table'].append(unpacked_data[i])
kill_table_step += 8
player_step += 1
deaths_step += 1
kills_step += 1
suicides_step += 9
# d1/d2 retro 1.4X3, player data
elif is_x3up:
for num in range(4, 52, 6):
plr_num = 'player{0}'.format(player_step)
game_data[plr_num + 'name'] = re.sub(r'[^a-zA-Z0-9-_]','',(unpacked_data[num].decode(errors='ignore').split('\x00', 1))[0])
game_data[plr_num + 'connected'] = unpacked_data[num + 1]
game_data[plr_num + 'rank'] = unpacked_data[num + 2]
game_data[plr_num + 'color'] = unpacked_data[num + 3]
game_data[plr_num + 'missle_color'] = unpacked_data[num + 4]
game_data[plr_num + 'deaths'] = unpacked_data[deaths_step]
game_data[plr_num + 'kills'] = unpacked_data[kills_step]
game_data[plr_num + 'suicides'] = unpacked_data[suicides_step]
# pull out the kill table data, 8x8 matrix, player0 - 7
game_data[plr_num + 'kill_table'] = []
for i in range(kill_table_step, kill_table_step + 8):
game_data[plr_num + 'kill_table'].append(unpacked_data[i])
kill_table_step += 8
player_step += 1
deaths_step += 1
kills_step += 1
suicides_step += 9
return game_data
def dxx_process_game_list_request(data):
logger.debug('entered dxx_process_game_list_request')
if len(data) == 3:
unpack_string = '=BH'
else:
logger.error('Received game_list_req with incorrect length')
return False
unpacked_data = dxx_unpack(unpack_string, data)
if not unpacked_data:
logger.error('Data unpack failed')
return False
else:
logger.debug('Unpacked data: \n{0}'.format(unpacked_data))
game_data = {}
game_data['version'] = unpacked_data[1]
return game_data
def dxx_process_game_list_response(data):
logger.debug('entered dxx_process_game_list_response')
if len(data) < 85 or len(data) > 93:
logger.error('Received game_list_resp with incorrect length')
return False
# the IP address in this response is a variable length field.
# find the first null character after skipping the first
# two bytes (opcode, ipv6 flag), this signifies the end of the ip address,
# use that value to build the unpacking string
ip_addr_len = str((data.find(b'\x00', 2)) - 1)
unpack_string = '=BB{0}sHHHHI16s26s9sIBBBBBBBB'.format(ip_addr_len)
logger.debug('Unpack_string: {0}'.format(unpack_string))
unpacked_data = dxx_unpack(unpack_string, data)
if not unpacked_data:
logger.error('Data unpack failed')
return False
else:
logger.debug('Unpacked data: \n{0}'.format(unpacked_data))
game_data = {}
game_data['ipv6'] = unpacked_data[1]
game_data['ip'] = unpacked_data[2].decode(errors='ignore').replace('\x00', '')
game_data['port'] = unpacked_data[3]
game_data['release_major'] = unpacked_data[4]
game_data['release_minor'] = unpacked_data[5]
game_data['release_micro'] = unpacked_data[6]
game_data['game_id'] = unpacked_data[7]
game_data['netgame_name'] = unpacked_data[8].decode(errors='ignore').replace('\x00', '')
game_data['mission_title'] = unpacked_data[9].decode(errors='ignore').replace('\x00', '')
game_data['mission_name'] = unpacked_data[10].decode(errors='ignore').replace('\x00', '')
game_data['level_num'] = unpacked_data[11]
game_data['mode'] = unpacked_data[12]
game_data['refuse_players'] = unpacked_data[13]
game_data['difficulty'] = unpacked_data[14]
game_data['status'] = unpacked_data[15]
game_data['players'] = unpacked_data[16]
game_data['max_players'] = unpacked_data[17]
game_data['flags'] = unpacked_data[18]
return game_data
def dxx_process_version_deny(data):
logger.debug('entered dxx_process_version_deny')
if len(data) == 9:
unpack_string = '=BHHHH'
else:
logger.error('Received version deny with incorrect length')
return False
unpacked_data = dxx_unpack(unpack_string, data)
if not unpacked_data:
logger.error('Data unpack failed')
return False
else:
logger.debug('Unpacked data: \n{0}'.format(unpacked_data))
game_data = {}
game_data['release_major'] = unpacked_data[1]
game_data['release_minor'] = unpacked_data[2]
game_data['release_micro'] = unpacked_data[3]
game_data['netgame_proto'] = unpacked_data[4]
return game_data
def dxx_send_register_response(address, socket_):
logger.debug('entered dxx_send_register_response')
buf = struct.pack('=B', 21)
if dxx_sendto(buf, address, socket_):
logger.debug('Sent register response to {0}:{1}'.format(
address[0], address[1]))
return True
else:
return False
def dxx_send_game_info_request(version, req_type, netgame_proto_version,
address, socket_,
release_major, release_minor, release_micro):
logger.debug('entered dxx_send_game_info_request')
request_id = 'D{0}XR'.format(version).encode()
# send either a lite_req and a full req depending on the type
if req_type == 0:
buf = struct.pack('=B4sHHH', 4, request_id, release_major,
release_minor, release_micro)
elif req_type == 1:
buf = struct.pack('=B4sHHHH', 2, request_id, release_major,
release_minor, release_micro, netgame_proto_version)
else:
logger.error('Unknown request type')
return False
if dxx_sendto(buf, address, socket_):
logger.debug('Sent game info request to {0}:{1}'.format(address[0],
address[1]))
return True
else:
return False
def dxx_send_game_list_request(version, address, socket_):
logger.debug('entered dxx_send_game_list_req')
buf = struct.pack('=BBB', 2, version, 0)
if dxx_sendto(buf, address, socket_):
logger.debug('Sent game list request to {0}:{1}'.format(
address[0], address[1]))
return True
else:
return False
def dxx_send_game_list_response(data, address, socket_):
'''
:param data: dict containing the fields returned in game_info_lite_reply
:param address: tuple ('ip_address', port)
:param socket_: socket to send response out on
:return: True is data was sent successful, False otherwise
'''
logger.debug('entered dxx_send_game_list_response')
opcode = 22
ipv6_flag = 0
# Reply length is variable depending on the length of the IP address so
# calculate the IP address length to build the correct packing string
pack_string = '=BB{0}sHHHHI16s26s9sIBBBBBBBB'.format(
len(data['ip']) + 1)
logger.debug('Packing string: {0}'.format(pack_string))
buf = struct.pack(pack_string,
opcode,
ipv6_flag,
data['ip'].encode(),
data['port'],
data['release_major'],
data['release_minor'],
data['release_micro'],
data['game_id'],
data['netgame_name'].encode(),
data['mission_title'].encode(),
data['mission_name'].encode(),
data['level_num'],
data['mode'],
data['refuse_players'],
data['difficulty'],
data['status'],
data['players'],
data['max_players'],
data['flags'],
0)
if dxx_sendto(buf, address, socket_):
logger.debug('Sent game list response to {0}:{1}'.format(
address[0], address[1]))
return True
else:
return False
def dxx_send_register(data, address, socket_):
logger.debug('entered dxx_send_register')
pack_string = '=BBBHIHHH'
buf = struct.pack(pack_string,
OPCODE_REGISTER,
data['tracker_ver'],
data['version'],
data['port'],
data['game_id'],
data['release_major'],
data['release_minor'],
data['release_micro'])
if dxx_sendto(buf, address, socket_):
logger.debug('Sent game register request to {0}:{1}'.format(
address[0], address[1]))
return True
else:
return False
def dxx_send_unregister(data, address, socket_):
logger.debug('entered dxx_send_unregister')
pack_string = '=BI'
buf = struct.pack(pack_string,
OPCODE_UNREGISTER_OR_VERSION_DENY,
data['game_id'])
if dxx_sendto(buf, address, socket_):
logger.debug('Sent game unregister request to {0}:{1}'.format(
address[0], address[1]))
return True
else:
return False