-
Notifications
You must be signed in to change notification settings - Fork 0
/
sdf.py
1519 lines (1257 loc) · 56.2 KB
/
sdf.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
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python3
'''
This module parses Microsoft SQL CE database file format (SDF).
B-Tree pages are not supported, and only version 3.5 or earlier have been tested.
'''
import sys
import struct
import math
import os
import re
from collections import defaultdict
from functools import cmp_to_key
from datetime import datetime, timedelta
# pip3 install cryptography
from cryptography.hazmat.primitives import hashes
from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
# Trace calls in case of errors
DEBUG_TRACE = True
DEBUG_TRACE_LEN = 20
def QWORD(buf, pos=0):
return (buf[pos]
| (buf[pos + 1] << 8)
| (buf[pos + 2] << 16)
| (buf[pos + 3] << 24)
| (buf[pos + 4] << 32)
| (buf[pos + 5] << 40)
| (buf[pos + 6] << 48)
| (buf[pos + 7] << 56)
)
def DWORD(buf, pos=0):
return (buf[pos]
| (buf[pos + 1] << 8)
| (buf[pos + 2] << 16)
| (buf[pos + 3] << 24)
)
def WORD(buf, pos=0):
return buf[pos] | (buf[pos + 1] << 8)
def BYTE(buf, pos=0):
return buf[pos]
def print_err(msg):
print(str(msg), file=sys.stderr)
def debug_trace(msg, *args):
if not DEBUG_TRACE:
return
debug_trace.history.append(msg % args)
if len(debug_trace.history) > 2 * DEBUG_TRACE_LEN:
debug_trace.history = debug_trace.history[-DEBUG_TRACE_LEN:]
# TODO Use a queue instead?
debug_trace.history = []
debug_trace.lastTable = None
debug_trace.lastPage = None
default_iv = bytearray(16) # 16 zero bytes
def decrypt_bytes(key_hash, data_key, data):
hash1 = key_hash.copy()
hash1.update(data_key)
hash1 = hash1.finalize()
# Wincrypt key derviation for AES
# <https://learn.microsoft.com/en-us/windows/win32/api/wincrypt/nf-wincrypt-cryptderivekey#remarks>
buffer1 = bytearray([0x36] * 64)
# buffer2 = bytearray([0x5c] * 64)
for i in range(len(hash1)):
buffer1[i] ^= hash1[i]
# buffer2[i] ^= hash1[i]
digest = hashes.Hash(hashes.SHA1())
digest.update(buffer1)
key = digest.finalize()
# digest = hashes.Hash(hashes.SHA1())
# digest.update(buffer2)
# key += digest.finalize()
decryptor = Cipher(algorithms.AES(key[:16]), modes.CBC(default_iv)).decryptor()
return decryptor.update(data) + decryptor.finalize()
def check_key(fpath, key):
key_hash = hashes.Hash(hashes.SHA1())
key_hash.update(key)
with open(fpath, 'rb') as fh:
page = fh.read(4096)
if len(page) != 4096:
return False
# Check key from header
data_key = page[188:188+4]
key_check = page[76:76+0x60]
key_check = decrypt_bytes(key_hash, data_key, key_check)
if key != key_check[:len(key)]:
return False
return True
def do_checksum(data):
i = 0
sum1 = 0
sum2 = 0
for i in range(0, len(data) - 1, 2):
word = data[i] | (data[i + 1] << 8)
sum1 += word
sum2 += sum1
if len(data) & 1 != 0:
sum1 += data[-1]
sum2 += sum1
while(sum1 > 0xFFFF): sum1 = (sum1 & 0xFFFF) + (sum1 >> 16)
while(sum2 > 0xFFFF): sum2 = (sum2 & 0xFFFF) + (sum2 >> 16)
if sum1 == 0xFFFF: sum1 = 0
if sum2 == 0xFFFF: sum2 = 0
return sum1 * 0xFFFF + sum2
class PageType:
HEADER = 0
MAPA = 1
MAPB = 2
TABLE = 3
DATA = 4
LV = 5 # LongValue
BTREE = 6 # Not supported
BITMAP = 8
LVMAP = 9
def __init__(self, value):
self.value = value
def __str__(self):
for name in dir(self.__class__):
if name.startswith('_'):
continue
if getattr(self, name) == self.value:
return name
return 'TYPE_%d' % (self.value,)
class Page:
def __init__(self, id, type, data, address=None, decrypted=True):
self.id = id
self.type = type
self.data = data
self.address = address
self.decrypted = decrypted
def __repr__(self):
return 'Page<id=%05x, type=%s, address=%08x>' % (self.id, PageType(self.type), self.address)
def __str__(self):
return repr(self)
class DataPage:
'''
A DATA page stores a list of arbitraty data entries (blocs).
An full entry can be stored on multiple pages.
'''
def __init__(self, page):
'''
DATA table:
After the page header, the data header is 8 bytes:
Offset Size Info
0000 4 tablePageId (first 20 bits), next 12 bits is free size
0004 4 first 12 lsb is entries count, next 12 bits is page data size
At the end of the DATA pages, there is a list of 4 bytes per entries.
For each 4 bytes (starting from last page dword):
Bits 11-00: entry offset from start of data (16+8+data_offset?)
Bits 23-12: entry size
Bits 31-24: flags, only the first 2 bits should be set. If bit 0 is set, entry is empty (free?).
The tables schema is stored in DATA pages as 0x5D bytes+strings for each entry.
'''
debug_trace('DataPage(%s)', page)
debug_trace.lastPage = self
self.page = page
if page.type != PageType.DATA:
raise ValueError('page %05x (at %08x) is not a DATA page' % (page.id, page.address))
dword = DWORD(page.data, 16)
self.tablePageId = dword & 0xFFFFF
self.freeSize = dword >> 20
dword = DWORD(page.data, 16+4)
self.entriesCount = dword & 0xFFF
self.dataSize = (dword >> 12) & 0xFFF
# DEBUG
self.lastEntry = None
self.lastEntryOffset = None
def __repr__(self):
return 'DataPage<page=%s>' % (self.page)
def __str__(self):
return repr(self)
def validate(self, db):
debug_trace('DataPage.validate(%s)', self.page)
debug_trace.lastPage = self
pos = 4096
total_size = 0
for _ in range(self.entriesCount):
pos -= 4
dword = DWORD(self.page.data, pos)
entryOffset = dword & 0xFFF
entrySize = (dword >> 12) & 0xFFF
flags = dword >> 24
if (flags & 0xFC) != 0 or entryOffset + entrySize > self.dataSize:
raise RuntimeError('invalid DATA page content for page %05x (at %08x)'
% (self.page.id, self.page.address))
if (flags & 1) == 0:
total_size += entrySize
if total_size + self.freeSize != self.dataSize:
raise RuntimeError('invalid DATA page content for page %05x (at %08x)'
% (self.page.id, self.page.address))
def __iter__(self):
for i in range(self.entriesCount):
yield self.getEntry(i)
def getEntry(self, i):
debug_trace('DataPage.getEntry(%s, %d)', self.page, i)
debug_trace.lastPage = self
if i < 0 or i >= self.entriesCount:
raise IndexError('index out of range')
pos = 4096 - 4 - 4 * i
if pos < 0:
print_err('Warning: negative offset for entry %d in page %05x (at %08x)'
% (i, self.page.id, self.page.address))
dword = DWORD(self.page.data, pos)
entryOffset = dword & 0xFFF
entrySize = (dword >> 12) & 0xFFF
flags = dword >> 24
if (flags & 1) == 1:
# Empty/Free?
return (flags, None)
if (flags & 2) == 0:
# The entry is the continuation of previous entry
pass
start = entryOffset + 16 + 8
end = start + entrySize
self.lastEntry = i
self.lastEntryOffset = start
return (flags, self.page.data[start:end])
class TablePage:
'''
A TABLE page stores references to DATA pages where the table rows are stored.
They might also be referenced through BITMAP pages.
'''
def __init__(self, page, db):
'''
TABLE page:
After the page header, the data header is 8 bytes:
Offset Size Info
0000 4 number of data pages
0004 4 1 if a list of BITMAP pages follows (the list of DATA pages starts at 0x70 then)
The data pages list follows, 8 bytes for 3 page ID:
Bit 19-00: page ID N
Bit 39-20: page ID N+1
Bit 59-40: page ID N+2
There might be more info at offset 0x130 (from page start)
'''
self.page = page
self.db = db
debug_trace('TablePage(%s)', self.page)
debug_trace.lastPage = self
if page.type != PageType.TABLE:
raise ValueError('page %05x (at %08x) is not a TABLE page' % (page.id, page.address))
self.dataListOffset = 16 + 8
self.dataPageCount = DWORD(page.data, 16)
self.flags = DWORD(page.data, 16 + 4)
self.bmapPageCount = 0
self.bmapListOffset = None
if self.flags == 1:
self.bmapPageCount = self.dataPageCount # Number of DATA pages in bitmap PAGES
self.bmapListOffset = self.dataListOffset
self.dataListOffset += 0x60
self.dataPageCount = DWORD(page.data, self.dataListOffset - 8)
self.flags = DWORD(page.data, self.dataListOffset - 4)
if self.flags != 0:
# It might be a list of free bitmap pages for that table?
self.dataPageCount = 0
print_err('unsupported flags (%08x) for TABLE page %05x (at %08x)'
% (self.flags, self.page.id, self.page.address))
self.lastDataPage = None
self.records = []
self.ready = False
def __repr__(self):
return 'TablePage<page=%s>' % (self.page)
def __str__(self):
return repr(self)
def _initialize(self):
if self.ready:
return
dataPageIds = []
dataPageIdSet = set()
for i in range(self.dataPageCount):
pos = self.dataListOffset + (i // 3) * 8
qword = QWORD(self.page.data, pos)
id = (qword >> (20 * (i % 3))) & 0xFFFFF
if id not in dataPageIdSet:
dataPageIds.append(id)
dataPageIdSet.add(id)
if self.bmapPageCount:
pageFound = 0
i = 0
pageIdBase = 0
while pageFound < self.bmapPageCount:
pos = self.bmapListOffset + (i // 3) * 8
qword = QWORD(self.page.data, pos)
id = (qword >> (20 * (i % 3))) & 0xFFFFF
i += 1
if id == 0:
print_err('Warning: found NULL pageId in BITMAP pages list for %s'
% (repr(self),))
# It means there are no DATA page in the current BITMAP range?
else:
self.lastDataPage = bmapPage = BitmapPage(self.db.readPage(id, validate=True))
for dataPageId in bmapPage:
pageFound += 1
dataPageId += pageIdBase
if dataPageId not in dataPageIdSet:
dataPageIds.append(dataPageId)
dataPageIdSet.add(dataPageId)
pageIdBase += 0x7F00 # (4096 - 32) * 8
if pageFound != self.bmapPageCount:
print_err('Warning: found more pages in BITMAP than expected for %s (%d > %d)'
% (repr(self), pageFound, self.bmapPageCount))
self.records = []
# Visit all the DATA pages to map the records to them
for id in dataPageIds:
self.lastDataPage = DataPage(self.db.readPage(id, validate=True))
for idx, (flags, entry) in enumerate(self.lastDataPage):
if entry is None:
continue
if (flags & 2) == 0:
# Continuation of previous record
continue
self.records.append([(id, idx)])
nextChunk = DWORD(entry)
nextChunk = (nextChunk >> 12, nextChunk & 0xFFF) # pageId, entryId
while nextChunk[0] != 0:
# Data continue in another page/entry
self.records[-1].append(nextChunk)
otherPage = DataPage(self.db.readPage(nextChunk[0], validate=True))
entry = otherPage.getEntry(nextChunk[1])[1]
nextChunk = DWORD(entry)
nextChunk = (nextChunk >> 12, nextChunk & 0xFFF) # pageId, entryId
self.ready = True
def validate(self, db):
debug_trace('TablePage.validate(%s)', self.page)
debug_trace.lastPage = self
if (self.dataPageCount & 0xFFFFFF00) != 0:
raise RuntimeError('dubious page count (%08x) for TABLE page %05x (at %08x)'
% (self.dataPageCount, self.page.id, self.page.address))
for i in range(self.dataPageCount):
pos = self.dataListOffset + (i // 3) * 8
qword = QWORD(self.page.data, pos)
id = (qword >> (20 * (i % 3))) & 0xFFFFF
if not db.checkId(id):
raise RuntimeError('invalid DATA page %05x in TABLE page %05x (at %08x)'
% (id, self.page.id, self.page.address))
if self.bmapPageCount:
# TODO BITMAP pages
pass
def getCount(self):
self._initialize()
return len(self.records)
def __iter__(self):
self._initialize()
for i in range(len(self.records)):
yield self.getRecord(i)
def getRecord(self, i):
debug_trace('TablePage.getRecord(page=%s, i=%s)', self.page, i)
debug_trace.lastPage = self
self._initialize()
record = self.records[i]
data = bytearray()
for (id, idx) in record:
if not (self.lastDataPage is not None and self.lastDataPage.page.id == id):
self.lastDataPage = DataPage(self.db.readPage(id, validate=False))
entry = self.lastDataPage.getEntry(idx)[1]
if len(data) > 0:
# Remove the first 4 bytes when adding continuation entries
entry = entry[4:]
data += entry
return data
class Table:
'''
A class to store a table definition and extract all the rows of that table.
'''
def __init__(self, name, pageId=None, nick=None, trackingType=None, ddlGranted=None,
readOnly=False, compressed=False, columns=None):
self.name = name
self.pageId = pageId
self.nick = nick
self.trackingType = trackingType
self.ddlGranted = ddlGranted
self.readOnly = readOnly
self.compressed = compressed
self.columns = [] if columns is None else columns
self.headerSize = None
self.minRowSize = None
self.bitfieldSize = None
debug_trace('Table(name=%s, pageId=%s)', self.name, self.pageId)
debug_trace.lastTable = self
self._sortedColumns = []
self.sortColumns()
self.needValidate = True
def __repr__(self):
return 'Table<name=%s, pageId=%05x, columns=%s>' % (self.name,
0xFFFFF if self.pageId is None else self.pageId, self.columns)
def __str__(self):
return repr(self)
def addColumn(self, column):
debug_trace('Table.addColumn(name=%s, column=%s)', self.name, column)
debug_trace.lastTable = self
self.columns.append(column)
self.sortColumns()
self.needValidate = True
def sortColumns(self):
# Sort by storage area and then by position
def cmp(cola, colb):
diff = cola.type.storage - colb.type.storage
if diff == 0:
diff = cola.position - colb.position
return diff
self._sortedColumns = sorted(self.columns, key=cmp_to_key(cmp))
# Sorted by column index
self.columns.sort(key=lambda c: c.index)
def validate(self):
debug_trace('Table.validate(name=%s, columns=%s)', self.name, self.columns)
debug_trace.lastTable = self
position = 0
names = set()
indexes = set()
storage = 0
# nextChunk + colCount + colMask
self.headerSize = 4 + 4 + math.ceil(len(self.columns) / 8)
self.minRowSize = self.headerSize
self.bitfieldSize = 0
minBitfieldSize = 0
self.sortColumns()
for col in self._sortedColumns:
if storage != col.type.storage:
if storage > col.type.storage:
debug_trace('column=%s', col)
raise RuntimeError('unexpected storage %d for column %s.%s'
% (col.type.storage, self.name, col.name))
storage = col.type.storage
position = 0
if position != col.position:
print_err(self._sortedColumns)
debug_trace('column=%s', col)
raise RuntimeError('unexpected position %d (/=%d) for column %s.%s'
% (col.position, position, self.name, col.name))
if col.name.lower() in names:
print_err('Warning: %s.%s found multiple times' % (self.name, col.name))
names.add(col.name.lower())
if col.index in indexes:
debug_trace('column=%s', col)
raise RuntimeError('column with index %d found multiple times in %s'
% (col.index, self.name))
indexes.add(col.index)
if storage == 0:
position += 1
minBitfieldSize = position
elif storage == 1:
position += col.size
self.minRowSize += col.size
else:
position += 1
self.minRowSize += 2
index = 0
for i in sorted(indexes):
if i != index:
debug_trace('columns=%s', self.columns)
raise RuntimeError('no column with index %d in %s'
% (i, self.name))
index += 1
self.bitfieldSize = math.ceil(minBitfieldSize / 8)
self.minRowSize += self.bitfieldSize
self.needValidate = False
def extractRow(self, data, sortByIndex=False, keyIndex=False):
debug_trace('Table.extractRow(name=%s, data=%s)', self.name, data)
debug_trace.lastTable = self
if self.needValidate:
self.validate()
if len(data) < 8:
raise RuntimeError('rows size (%d) is too small for table %s record (>=%d)'
% (len(data), self.name, 8))
(nextChunk, colCount) = struct.unpack_from('<LL', data)
nextChunk = (nextChunk >> 12, nextChunk & 0xFFF) # pageId, entry index
if colCount > len(self.columns):
raise RuntimeError('number of columns (%d) is unexpected for table %s record (>=%d)'
% (colCount, self.name, len(self.columns)))
if colCount == len(self.columns):
headerSize = self.headerSize
minRowSize = self.minRowSize
bitfieldSize = self.bitfieldSize
else:
# The last columns are missing
# Re-compute the sizes
headerSize = 4 + 4 + math.ceil(colCount / 8)
minRowSize = headerSize
minBitfieldSize = 0
position = 0
storage = 0
for i, col in enumerate(self._sortedColumns):
if i >= colCount:
break
if storage != col.type.storage:
storage = col.type.storage
position = 0
if storage == 0:
position += 1
minBitfieldSize = position
elif storage == 1:
position += col.size
minRowSize += col.size
else:
position += 1
minRowSize += 2
bitfieldSize = math.ceil(minBitfieldSize / 8)
minRowSize += bitfieldSize
if len(data) < headerSize:
raise RuntimeError('rows size (%d) is too small for table %s record (>=%d)'
% (len(data), self.name, headerSize))
colMaskBytes = data[8:headerSize]
colMask = 0
while len(colMaskBytes) > 0:
# Invert it so 1=present and 0=missing
colMask = (colMask << 8) | (colMaskBytes.pop() ^ 0xFF)
# Columns marked as "missing" are actually present, but their value should be default?
if len(data) < minRowSize:
# FIXME What about compressed rows/columns/tables?
raise RuntimeError('rows size (%d) is too small for table %s record (>=%d)'
% (len(data), self.name, minRowSize))
pos = headerSize
bitfield = 0
if bitfieldSize > 0:
for n in range(bitfieldSize):
bitfield |= BYTE(data, pos) << (n * 8)
pos += 1
binData = data[minRowSize:]
row = {}
for i, col in enumerate(self._sortedColumns):
if i >= colCount:
# Column is missing, use default value
row[col.index if keyIndex else col.name] = col.get_default()
continue
if col.type.storage == 0:
debug_trace('parseBit(col=%s)', col)
row[col.index if keyIndex else col.name] = True if ((bitfield >> col.position) & 1) != 0 else False
elif col.type.storage == 1:
colData = data[pos:pos+col.size]
pos += col.size
row[col.index if keyIndex else col.name] = col.parse(colData)
else:
if col.position == 0:
debug_trace('varmap=%s', data[pos:minRowSize])
start = WORD(data, pos)
ascii = (start & 0x8000) != 0
start &= 0x7FFF
pos += 2
if pos < minRowSize:
end = WORD(data, pos) & 0x7FFF
if end > len(binData):
end = len(binData)
else:
end = len(binData)
if start < end:
# Field is present
if start > len(binData):
raise RuntimeError('start (%d) is too big for table %s record (<=%d)'
% (start, self.name, len(binData)))
colData = binData[start:end]
else:
# Empty
colData = b''
row[col.index if keyIndex else col.name] = col.parse(colData, ascii=ascii)
if sortByIndex:
# TODO Return a list instead?
_row = {}
for col in self.columns:
key = col.index if keyIndex else col.name
_row[key] = row[key]
row = _row
return row
class Column:
'''
Table column definition.
'''
class Type:
def __init__(self, value, maxSize, names, storage, fixed=True):
self.value = value
self.names = names if isinstance(names, list) else [names]
self.maxSize = maxSize
self.fixed = fixed
self.storage = storage
def __repr__(self):
return 'ColumnType<value=%s, names=%s, storage=%s>' % (self.value,
self.names, self.storage)
class NumType(Type):
'''Stored in the numeric area'''
def __init__(self, value, maxSize, names, fixed=True):
super().__init__(value, maxSize, names, 1, fixed=fixed)
class BinType(Type):
'''Stored in the data area'''
def __init__(self, value, maxSize, names, fixed=True):
super().__init__(value, maxSize, names, 2, fixed=fixed)
class BitType(Type):
'''Stored in the bitfield area'''
def __init__(self, value, maxSize, names, fixed=True):
super().__init__(value, maxSize, names, 0, fixed=fixed)
TYPE_TINYINT = NumType(0, 1, 'tinyint')
TYPE_SMALLINT = NumType(1, 2, 'smallint')
TYPE_USHORT = NumType(2, 2, 'ushort')
TYPE_INTEGER = NumType(3, 4, 'integer')
TYPE_ULONG = NumType(4, 4, 'ulong')
TYPE_BIGINT = NumType(5, 8, 'bigint')
TYPE_UBIGINT = NumType(6, 8, 'ubigint')
TYPE_NCHAR = BinType(7, 8000, 'nchar')
TYPE_NVARCHAR = BinType(8, 8000, 'nvarchar', fixed=False)
TYPE_NTEXT = BinType(9, 536870911, 'ntext', fixed=False)
TYPE_BINARY = NumType(10, 8000, 'binary')
TYPE_VARBINARY = BinType(11, 8000, 'varbinary', fixed=False)
TYPE_IMAGE = BinType(12, 1073741823, 'image')
TYPE_DATETIME = NumType(13, 8, 'datetime') # size is 16 instead?
TYPE_UNIQUEIDENTIFIER = NumType(14, 16, 'uniqueidentifier')
TYPE_BIT = BitType(15, 2, 'bit')
TYPE_REAL = NumType(16, 4, 'real')
TYPE_FLOAT = NumType(17, 8, 'float')
TYPE_MONEY = NumType(18, 8, 'money')
TYPE_NUMERIC = NumType(19, 19, ['numeric', 'decimal', 'dec']) # (p,s)
TYPE_ROWVERSION = NumType(20, 8, 'rowversion')
TYPES = {}
DATETIME_REF = datetime.fromisoformat('1900-01-01')
def __init__(self, index, position, name, type, size=None, precision=None, scale=None,
fixed=True, nullable=True, writeable=True, autoType=None, default=None,
compressed=False):
self.index = index
self.name = name
self.type = type
self.size = type.maxSize if size is None else size
self.precision = precision
self.scale = scale
self.fixed = fixed
self.nullable = nullable
self.writeable = writeable
self.autoType = autoType
self.position = position
self.default = default
self.compressed = compressed
self.decWarned = False
def __repr__(self):
return 'Column<index=%s, name=%s, type=%s, size=%s, position=%s, default=%s>' % (self.index,
self.name, self.type, self.size, self.position, self.default)
def parse(self, data, ascii=False):
debug_trace('Column.parse(self=%s, data=%s, ascii=%s)', self, data, ascii)
def clean_string(str):
# Remove extra characters after the first NUL character
return str.split('\0', 1)[0]
# TODO Use a lookup table instead of a big if/elif bloc?
if self.type.value == self.TYPE_TINYINT.value:
return BYTE(data)
elif self.type.value == self.TYPE_SMALLINT.value:
return struct.unpack_from('<h', data)[0]
elif self.type.value == self.TYPE_USHORT.value:
return WORD(data)
elif self.type.value == self.TYPE_INTEGER.value:
return struct.unpack_from('<l', data)[0]
elif self.type.value == self.TYPE_ULONG.value:
return DWORD(data)
elif self.type.value == self.TYPE_BIGINT.value:
return struct.unpack_from('<q', data)[0]
elif self.type.value == self.TYPE_UBIGINT.value:
return QWORD(data)
elif self.type.value == self.TYPE_BINARY.value:
return data
elif self.type.value == self.TYPE_DATETIME.value:
# 300 ticks per second
ticks, days = struct.unpack_from('<ll', data)
dt = self.DATETIME_REF + timedelta(days=days, milliseconds=ticks * 1000 / 300)
return dt
elif self.type.value == self.TYPE_UNIQUEIDENTIFIER.value:
return data
elif self.type.value == self.TYPE_REAL.value:
return struct.unpack_from('<f', data)[0]
elif self.type.value == self.TYPE_FLOAT.value:
return struct.unpack_from('<d', data)[0]
elif self.type.value == self.TYPE_MONEY.value:
return struct.unpack_from('<q', data)[0] / 10000
elif self.type.value == self.TYPE_NUMERIC.value:
# FIXME Support NUMERIC type?
if not self.decWarned:
print_err('Warning: no support for numeric(p, s) in column %s' % (self.name,))
self.decWarned = True
return 0
elif self.type.value == self.TYPE_ROWVERSION.value:
return QWORD(data)
elif self.type.value == self.TYPE_NCHAR.value:
# XXX CP-1252 is a guess, we should probably infer the code page from LCID in DB header
return clean_string(data.decode('cp1252' if ascii else 'utf-16'))
elif self.type.value == self.TYPE_NVARCHAR.value:
# XXX CP-1252 is a guess, we should probably infer the code page from LCID in DB header
return clean_string(data.decode('cp1252' if ascii else 'utf-16'))
elif self.type.value == self.TYPE_VARBINARY.value:
return data
elif self.type.value == self.TYPE_IMAGE.value or self.type.value == self.TYPE_NTEXT.value:
if self.type.value == self.TYPE_NTEXT.value:
# XXX CP-1252 is a guess, we should probably infer the code page from LCID in DB header
encoding = 'cp1252' if ascii else 'utf-16'
else:
encoding = None
if len(data) == 0:
return b'' if encoding is None else ''
size = QWORD(data)
if size > 256-8: # FIXME Might be wrong
# Stored in LV page(s)
pageCount = math.ceil(size / (4096 - 16))
wordCount = math.ceil(pageCount / 3)
if wordCount > (256 - 8) / 8: # FIXME Might be wrong
# Stored in LV page(s) whose list is given in LVMAP page(s)
# FIXME There might be multiple levels of LVMAP to reach the max size
# of 1073741823 bytes?
# Max size for 1 LVMAP is 6230160 bytes
# Max size for 31 LVMAP is 193134960 bytes
# Max size for 31 LVMAP pointing to LVMAP is 294917083920 bytes
lvmapCount = math.ceil(pageCount / ((4096 - 16 - 8) / 8 * 3))
lvmapWordCount = math.ceil(lvmapCount / 3)
if len(data) != 8 + lvmapWordCount * 8:
raise RuntimeError('unexpected LVMAP data size (%d vs %d) for column %s'
% (len(data), 8 + lvmapWordCount * 8, self.name))
lvmapPageIds = []
for n in range(lvmapWordCount):
word = QWORD(data, 8 + n * 8)
for _ in range(3):
if len(lvmapPageIds) == lvmapCount:
break
lvmapPageIds.append(word & 0xFFFFF)
word >>= 20
debug_trace('lvmapCount=%s, lvmapWordCount=%s, lvmapPageIds=%s',
lvmapCount, lvmapWordCount, lvmapPageIds)
return LvMapData(lvmapPageIds, size, encoding)
else:
if len(data) != 8 + wordCount * 8:
raise RuntimeError('unexpected data size (%d vs %d) for column %s'
% (len(data), 8 + wordCount * 8, self.name))
pageIds = []
for n in range(wordCount):
word = QWORD(data, 8 + n * 8)
for _ in range(3):
if len(pageIds) == pageCount:
break
pageIds.append(word & 0xFFFFF)
word >>= 20
return LvData(pageIds, size, encoding)
else:
# Stored in this page
if len(data) != size + 8:
raise RuntimeError('unexpected data size (%d vs %d) for column %s'
% (len(data), size + 8, self.name))
data = data[8:]
if encoding is not None:
data = clean_string(data.decode(encoding))
return data
else:
raise RuntimeError('unknown NumType %d' % (self.type.value,))
def get_default(self):
debug_trace('Column.get_default(self=%s)', self)
# TODO Parse and return self.default is not None
# TODO Use a lookup table instead of a big if/elif bloc?
if self.type.value == self.TYPE_BIT.value:
return False
elif self.type.value == self.TYPE_TINYINT.value:
return 0
elif self.type.value == self.TYPE_SMALLINT.value:
return 0
elif self.type.value == self.TYPE_USHORT.value:
return 0
elif self.type.value == self.TYPE_INTEGER.value:
return 0
elif self.type.value == self.TYPE_ULONG.value:
return 0
elif self.type.value == self.TYPE_BIGINT.value:
return 0
elif self.type.value == self.TYPE_UBIGINT.value:
return 0
elif self.type.value == self.TYPE_BINARY.value:
return b''
elif self.type.value == self.TYPE_DATETIME.value:
return self.DATETIME_REF
elif self.type.value == self.TYPE_UNIQUEIDENTIFIER.value:
return b'\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'
elif self.type.value == self.TYPE_REAL.value:
return 0.0
elif self.type.value == self.TYPE_FLOAT.value:
return 0.0
elif self.type.value == self.TYPE_MONEY.value:
return 0.0
elif self.type.value == self.TYPE_NUMERIC.value:
return 0
elif self.type.value == self.TYPE_ROWVERSION.value:
return 0
elif self.type.value == self.TYPE_NCHAR.value:
return ''
elif self.type.value == self.TYPE_NVARCHAR.value:
return ''
elif self.type.value == self.TYPE_VARBINARY.value:
return b''
elif self.type.value == self.TYPE_IMAGE.value or self.type.value == self.TYPE_NTEXT.value:
if self.type.value == self.TYPE_NTEXT.value:
return ''
else:
return b''
else:
raise RuntimeError('unknown NumType %d' % (self.type.value,))
# FIXME Use an enum instead?
for name in dir(Column):
if not name.startswith('TYPE_'):
continue
t = getattr(Column, name)
Column.TYPES[t.value] = t
class BitmapPage:
'''
A BITMAP page indicates which page is of interest within a range of pages through a big bits map.
'''
def __init__(self, page):
'''
BITMAP table:
After the page header, the data header is 16 bytes:
Offset Size Info
0000 2 pageCount
0002 2 firstPageId
0004 2 lastPageId
The rest of the page is a bitmap of 32256 bits, 1 bit for each pageId from 0 to 0x7DFF.
When a bit is set, the associated page is included.
'''
debug_trace('BitmapPage(%s)', page)
debug_trace.lastPage = self
self.page = page
if page.type != PageType.BITMAP:
raise ValueError('page %05x (at %08x) is not a BITMAP page' % (page.id, page.address))
self.pageCount = WORD(page.data, 16)
self.firstPageId = WORD(page.data, 16+2)
self.lastPageId = WORD(page.data, 16+4)
def __repr__(self):
return 'BitmapPage<page=%s>' % (self.page)
def __str__(self):
return repr(self)
def __iter__(self):
if self.pageCount == 0:
return
id = 0
while id != self.lastPageId:
id = self.getNext(id)
yield id
def getNext(self, id):
debug_trace('BitmapPage.getNext(%s, %d)', self.page, id)
debug_trace.lastPage = self
if id < self.firstPageId: