1 #! /usr/bin/env python3
3 """Dump archive contents, test extraction."""
8 from datetime
import datetime
13 dumprar [switches] [ARC1 ARC2 ...] [@ARCLIST]
15 @file read archive names from file
17 -Ccharset set fallback charset
19 -t attempt to read all files
20 -x write read files out
21 -c show archive comment
23 -- stop switch parsing
26 os_list
= ["DOS", "OS2", "WIN", "UNIX", "MACOS", "BEOS"]
28 block_strs
= ["MARK", "MAIN", "FILE", "OLD_COMMENT", "OLD_EXTRA",
29 "OLD_SUB", "OLD_RECOVERY", "OLD_AUTH", "SUB", "ENDARC"]
32 rf
.RAR5_BLOCK_MAIN
: "R5_MAIN",
33 rf
.RAR5_BLOCK_FILE
: "R5_FILE",
34 rf
.RAR5_BLOCK_SERVICE
: "R5_SVC",
35 rf
.RAR5_BLOCK_ENCRYPTION
: "R5_ENC",
36 rf
.RAR5_BLOCK_ENDARC
: "R5_ENDARC",
41 """RAR3 type code as string."""
42 if btype
< rf
.RAR_BLOCK_MARK
or btype
> rf
.RAR_BLOCK_ENDARC
:
44 return block_strs
[btype
- rf
.RAR_BLOCK_MARK
]
48 """RAR5 type code as string."""
49 return r5_block_types
.get(btype
, "*UNKNOWN*")
53 (rf
.RAR_MAIN_VOLUME
, "VOL"),
54 (rf
.RAR_MAIN_COMMENT
, "COMMENT"),
55 (rf
.RAR_MAIN_LOCK
, "LOCK"),
56 (rf
.RAR_MAIN_SOLID
, "SOLID"),
57 (rf
.RAR_MAIN_NEWNUMBERING
, "NEWNR"),
58 (rf
.RAR_MAIN_AUTH
, "AUTH"),
59 (rf
.RAR_MAIN_RECOVERY
, "RECOVERY"),
60 (rf
.RAR_MAIN_PASSWORD
, "PASSWORD"),
61 (rf
.RAR_MAIN_FIRSTVOLUME
, "FIRSTVOL"),
62 (rf
.RAR_SKIP_IF_UNKNOWN
, "SKIP"),
63 (rf
.RAR_LONG_BLOCK
, "LONG"),
67 (rf
.RAR_ENDARC_NEXT_VOLUME
, "NEXTVOL"),
68 (rf
.RAR_ENDARC_DATACRC
, "DATACRC"),
69 (rf
.RAR_ENDARC_REVSPACE
, "REVSPACE"),
70 (rf
.RAR_ENDARC_VOLNR
, "VOLNR"),
71 (rf
.RAR_SKIP_IF_UNKNOWN
, "SKIP"),
72 (rf
.RAR_LONG_BLOCK
, "LONG"),
76 (rf
.RAR_FILE_SPLIT_BEFORE
, "SPLIT_BEFORE"),
77 (rf
.RAR_FILE_SPLIT_AFTER
, "SPLIT_AFTER"),
78 (rf
.RAR_FILE_PASSWORD
, "PASSWORD"),
79 (rf
.RAR_FILE_COMMENT
, "COMMENT"),
80 (rf
.RAR_FILE_SOLID
, "SOLID"),
81 (rf
.RAR_FILE_LARGE
, "LARGE"),
82 (rf
.RAR_FILE_UNICODE
, "UNICODE"),
83 (rf
.RAR_FILE_SALT
, "SALT"),
84 (rf
.RAR_FILE_VERSION
, "VERSION"),
85 (rf
.RAR_FILE_EXTTIME
, "EXTTIME"),
86 (rf
.RAR_FILE_EXTFLAGS
, "EXTFLAGS"),
87 (rf
.RAR_SKIP_IF_UNKNOWN
, "SKIP"),
88 (rf
.RAR_LONG_BLOCK
, "LONG"),
92 (rf
.RAR_SKIP_IF_UNKNOWN
, "SKIP"),
93 (rf
.RAR_LONG_BLOCK
, "LONG"),
96 file_parms
= ("D64", "D128", "D256", "D512",
97 "D1024", "D2048", "D4096", "DIR")
100 (rf
.RAR5_BLOCK_FLAG_EXTRA_DATA
, "EXTRA"),
101 (rf
.RAR5_BLOCK_FLAG_DATA_AREA
, "DATA"),
102 (rf
.RAR5_BLOCK_FLAG_SKIP_IF_UNKNOWN
, "SKIP"),
103 (rf
.RAR5_BLOCK_FLAG_SPLIT_BEFORE
, "SPLIT_BEFORE"),
104 (rf
.RAR5_BLOCK_FLAG_SPLIT_AFTER
, "SPLIT_AFTER"),
105 (rf
.RAR5_BLOCK_FLAG_DEPENDS_PREV
, "DEPENDS"),
106 (rf
.RAR5_BLOCK_FLAG_KEEP_WITH_PARENT
, "KEEP"),
110 (rf
.RAR5_MAIN_FLAG_ISVOL
, "ISVOL"),
111 (rf
.RAR5_MAIN_FLAG_HAS_VOLNR
, "VOLNR"),
112 (rf
.RAR5_MAIN_FLAG_SOLID
, "SOLID"),
113 (rf
.RAR5_MAIN_FLAG_RECOVERY
, "RECOVERY"),
114 (rf
.RAR5_MAIN_FLAG_LOCKED
, "LOCKED"),
118 (rf
.RAR5_FILE_FLAG_ISDIR
, "DIR"),
119 (rf
.RAR5_FILE_FLAG_HAS_MTIME
, "MTIME"),
120 (rf
.RAR5_FILE_FLAG_HAS_CRC32
, "CRC32"),
121 (rf
.RAR5_FILE_FLAG_UNKNOWN_SIZE
, "NOSIZE"),
125 (rf
.RAR5_ENC_FLAG_HAS_CHECKVAL
, "CHECKVAL"),
129 (rf
.RAR5_ENDARC_FLAG_NEXT_VOL
, "NEXTVOL"),
132 r5_file_enc_flags
= (
133 (rf
.RAR5_XENC_CHECKVAL
, "CHECKVAL"),
134 (rf
.RAR5_XENC_TWEAKED
, "TWEAKED"),
137 r5_file_redir_types
= {
138 rf
.RAR5_XREDIR_UNIX_SYMLINK
: "UNIX_SYMLINK",
139 rf
.RAR5_XREDIR_WINDOWS_SYMLINK
: "WINDOWS_SYMLINK",
140 rf
.RAR5_XREDIR_WINDOWS_JUNCTION
: "WINDOWS_JUNCTION",
141 rf
.RAR5_XREDIR_HARD_LINK
: "HARD_LINK",
142 rf
.RAR5_XREDIR_FILE_COPY
: "FILE_COPY",
145 r5_file_redir_flags
= (
146 (rf
.RAR5_XREDIR_ISDIR
, "DIR"),
159 (0x0100, "TEMPORARY"),
160 (0x0200, "SPARSE_FILE"),
161 (0x0400, "REPARSE_POINT"),
162 (0x0800, "COMPRESSED"),
164 (0x2000, "NOT_CONTENT_INDEXED"),
165 (0x4000, "ENCRYPTED"),
166 (0x8000, "INTEGRITY_STREAM"),
167 (0x00010000, "VIRTUAL"),
168 (0x00020000, "NO_SCRUB_DATA"),
169 (0x00040000, "RECALL_ON_OPEN"),
170 (0x00080000, "PINNED"),
171 (0x00100000, "UNPINNED"),
172 (0x00400000, "RECALL_ON_DATA_ACCESS"),
173 (0x20000000, "STRICTLY_SEQUENTIAL"),
177 def xprint(m
, *args
):
178 """Print string to stdout.
180 Format unicode safely.
182 if sys
.hexversion
< 0x3000000:
186 if sys
.hexversion
< 0x3000000:
189 sys
.stdout
.write("\n")
192 def render_flags(flags
, bit_list
):
198 known
= known | bit
[0]
201 unknown
= flags
& ~known
205 res
.append("UNK_%04x" % (1 << n
))
206 unknown
= unknown
>> 1
215 def get_file_flags(flags
):
216 """Show flag names and handle dict size.
218 res
= render_flags(flags
& ~rf
.RAR_FILE_DICTMASK
, file_bits
)
220 xf
= (flags
& rf
.RAR_FILE_DICTMASK
) >> 5
221 res
+= "," + file_parms
[xf
]
230 if isinstance(t
, datetime
):
231 return t
.isoformat("T")
232 return "%04d-%02d-%02d %02d:%02d:%02d" % t
236 """Show any RAR3/5 record.
238 if isinstance(h
, rf
.Rar3Info
):
240 elif isinstance(h
, rf
.Rar5Info
):
243 xprint("Unknown info record")
247 return [v
& 4 and "r" or "-", v
& 2 and "w" or "-", v
& 1 and "x" or "-"]
251 perms
= modex3(mode
>> 6) + modex3(mode
>> 3) + modex3(mode
)
253 perms
[2] = perms
[2] == "x" and "s" or "S"
255 perms
[5] = perms
[5] == "x" and "s" or "S"
257 perms
[8] = perms
[8] == "x" and "t" or "-"
270 perms
.append("(0x%04x)" % rest
)
271 return "".join(perms
)
275 if h
.host_os
in (rf
.RAR_OS_UNIX
, rf
.RAR_OS_BEOS
):
276 s_mode
= unix_mode(h
.mode
)
277 elif h
.host_os
in (rf
.RAR_OS_MSDOS
, rf
.RAR_OS_WIN32
, rf
.RAR_OS_OS2
):
278 s_mode
= render_flags(h
.mode
, dos_mode_bits
)
280 s_mode
= "0x%x" % h
.mode
285 """Show any RAR3 record.
287 st
= rar3_type(h
.type)
288 xprint("%s: hdrlen=%d datlen=%d", st
, h
.header_size
, h
.add_size
)
289 if h
.type in (rf
.RAR_BLOCK_FILE
, rf
.RAR_BLOCK_SUB
):
290 s_mode
= show_mode(h
)
291 xprint(" flags=0x%04x:%s", h
.flags
, get_file_flags(h
.flags
))
292 if h
.host_os
>= 0 and h
.host_os
< len(os_list
):
293 s_os
= os_list
[h
.host_os
]
296 if h
.flags
& rf
.RAR_FILE_UNICODE
:
297 s_namecmp
= " namecmp=%d/%d" % (len(h
.orig_filename
), h
._name
_size
)
300 xprint(" os=%d:%s ver=%d mode=%s meth=%c cmp=%d dec=%d vol=%d%s",
302 h
.extract_version
, s_mode
, h
.compress_type
,
303 h
.compress_size
, h
.file_size
, h
.volume
, s_namecmp
)
304 ucrc
= (h
.CRC
+ (1 << 32)) & ((1 << 32) - 1)
305 xprint(" crc=0x%08x (%d) date_time=%s", ucrc
, h
.CRC
, fmt_time(h
.date_time
))
306 xprint(" name=%s", h
.filename
)
308 xprint(" mtime=%s", fmt_time(h
.mtime
))
310 xprint(" ctime=%s", fmt_time(h
.ctime
))
312 xprint(" atime=%s", fmt_time(h
.atime
))
314 xprint(" arctime=%s", fmt_time(h
.arctime
))
315 elif h
.type == rf
.RAR_BLOCK_MAIN
:
316 xprint(" flags=0x%04x:%s", h
.flags
, render_flags(h
.flags
, main_bits
))
317 elif h
.type == rf
.RAR_BLOCK_ENDARC
:
318 xprint(" flags=0x%04x:%s", h
.flags
, render_flags(h
.flags
, endarc_bits
))
319 if h
.flags
& rf
.RAR_ENDARC_DATACRC
:
320 xprint(" datacrc=0x%08x", h
.endarc_datacrc
)
321 if h
.flags
& rf
.RAR_ENDARC_DATACRC
:
322 xprint(" volnr=%d", h
.endarc_volnr
)
323 elif h
.type == rf
.RAR_BLOCK_MARK
:
324 xprint(" flags=0x%04x:", h
.flags
)
326 xprint(" flags=0x%04x:%s", h
.flags
, render_flags(h
.flags
, generic_bits
))
328 if h
.comment
is not None:
332 xprint(" comment=%s", cm
)
336 """Show any RAR5 record.
338 st
= rar5_type(h
.block_type
)
339 xprint("%s: hdrlen=%d datlen=%d hdr_extra=%d", st
, h
.header_size
,
340 h
.compress_size
, h
.block_extra_size
)
341 xprint(" block_flags=0x%04x:%s", h
.block_flags
, render_flags(h
.block_flags
, r5_block_flags
))
342 if h
.block_type
in (rf
.RAR5_BLOCK_FILE
, rf
.RAR5_BLOCK_SERVICE
):
343 xprint(" name=%s", h
.filename
)
344 s_mode
= show_mode(h
)
345 if h
.file_host_os
== rf
.RAR5_OS_UNIX
:
349 xprint(" file_flags=0x%04x:%s", h
.file_flags
, render_flags(h
.file_flags
, r5_file_flags
))
351 cmp_flags
= h
.file_compress_flags
352 xprint(" cmp_algo=%d cmp_meth=%d dict=%d solid=%r",
354 (cmp_flags
>> 7) & 0x07,
356 cmp_flags
& rf
.RAR5_COMPR_SOLID
> 0)
357 xprint(" os=%d:%s mode=%s cmp=%r dec=%r vol=%r",
358 h
.file_host_os
, s_os
, s_mode
,
359 h
.compress_size
, h
.file_size
, h
.volume
)
360 if h
.CRC
is not None:
361 xprint(" crc=0x%08x (%d)", h
.CRC
, h
.CRC
)
362 if h
.blake2sp_hash
is not None:
363 xprint(" blake2sp=%s", rf
.tohex(h
.blake2sp_hash
))
364 if h
.date_time
is not None:
365 xprint(" date_time=%s", fmt_time(h
.date_time
))
367 xprint(" mtime=%s", fmt_time(h
.mtime
))
369 xprint(" ctime=%s", fmt_time(h
.ctime
))
371 xprint(" atime=%s", fmt_time(h
.atime
))
373 xprint(" arctime=%s", fmt_time(h
.arctime
))
374 if h
.flags
& rf
.RAR_FILE_PASSWORD
:
375 enc_algo
, enc_flags
, kdf_count
, salt
, iv
, checkval
= h
.file_encryption
376 algo_name
= "AES256" if enc_algo
== rf
.RAR5_XENC_CIPHER_AES256
else "UnknownAlgo"
377 xprint(" algo=%d:%s enc_flags=%04x:%s kdf_lg=%d kdf_count=%d salt=%s iv=%s checkval=%s",
378 enc_algo
, algo_name
, enc_flags
, render_flags(enc_flags
, r5_file_enc_flags
),
379 kdf_count
, 1 << kdf_count
, rf
.tohex(salt
), rf
.tohex(iv
),
380 checkval
and rf
.tohex(checkval
) or "-")
382 redir_type
, redir_flags
, redir_name
= h
.file_redir
383 xprint(" redir: type=%s flags=%d:%s destination=%s",
384 r5_file_redir_types
.get(redir_type
, "Unknown"),
385 redir_flags
, render_flags(redir_flags
, r5_file_redir_flags
),
388 uname
, gname
, uid
, gid
= h
.file_owner
389 xprint(" owner: name=%r group=%r uid=%r gid=%r",
390 uname
, gname
, uid
, gid
)
392 flags
, version
= h
.file_version
393 xprint(" version: flags=%r version=%r", flags
, version
)
394 elif h
.block_type
== rf
.RAR5_BLOCK_MAIN
:
395 xprint(" flags=0x%04x:%s", h
.flags
, render_flags(h
.main_flags
, r5_main_flags
))
396 elif h
.block_type
== rf
.RAR5_BLOCK_ENDARC
:
397 xprint(" flags=0x%04x:%s", h
.flags
, render_flags(h
.endarc_flags
, r5_endarc_flags
))
398 elif h
.block_type
== rf
.RAR5_BLOCK_ENCRYPTION
:
399 algo_name
= "AES256" if h
.encryption_algo
== rf
.RAR5_XENC_CIPHER_AES256
else "UnknownAlgo"
400 xprint(" algo=%d:%s flags=0x%04x:%s", h
.encryption_algo
, algo_name
, h
.flags
,
401 render_flags(h
.encryption_flags
, r5_enc_flags
))
402 xprint(" kdf_lg=%d kdf_count=%d", h
.encryption_kdf_count
, 1 << h
.encryption_kdf_count
)
403 xprint(" salt=%s", rf
.tohex(h
.encryption_salt
))
405 xprint(" - missing info -")
407 if h
.comment
is not None:
411 xprint(" comment=%s", cm
)
423 def check_crc(f
, inf
, desc
):
424 """Compare result crc to expected value.
429 ucrc
= f
._md
_context
.digest()
431 print("crc error - %s - exp=%r got=%r" % (desc
, exp
, ucrc
))
434 def test_read_long(r
, inf
):
435 """Test read and readinto.
437 md_class
= inf
._md
_class
or rf
.NoHashContext
439 f
= r
.open(inf
.filename
)
447 if total
!= inf
.file_size
:
448 xprint("\n *** %s has corrupt file: %s ***", r
.rarfile
, inf
.filename
)
449 xprint(" *** short read: got=%d, need=%d ***\n", total
, inf
.file_size
)
450 check_crc(f
, inf
, "read")
451 bhash
= bctx
.hexdigest()
453 if f
._md
_context
.digest() == inf
._md
_expect
:
454 #xprint(" checkhash: %r", bhash)
457 xprint(" checkhash: %r got=%r exp=%r cls=%r\n",
458 bhash
, f
._md
_context
.digest(), inf
._md
_expect
, inf
._md
_class
)
460 # test .seek() & .readinto()
465 buf
= bytearray(1024)
467 res
= f
.readinto(buf
)
471 if inf
.file_size
!= total
:
472 xprint(" *** readinto failed: got=%d, need=%d ***\n", total
, inf
.file_size
)
473 #check_crc(f, inf, "readinto")
477 def test_read(r
, inf
):
478 """Test file read."""
479 test_read_long(r
, inf
)
482 def test_real(fn
, pwd
):
483 """Actual archive processing.
485 xprint("Archive: %s", fn
)
493 rfarg
= io
.BytesIO(open(fn
, "rb").read())
496 if not rf
.is_rarfile(rfarg
):
497 xprint(" --- %s is not a RAR file ---", fn
)
501 r
= rf
.RarFile(rfarg
, charset
=cf_charset
, info_callback
=cb
)
503 if r
.needs_password():
507 xprint(" --- %s requires password ---", fn
)
511 if cf_show_comment
and r
.comment
:
512 for ln
in r
.comment
.split("\n"):
514 elif cf_verbose
> 0 and r
.comment
:
518 xprint(" comment=%s", cm
)
521 for n
in r
.namelist():
532 for inf
in r
.infolist():
540 """Process one archive with error handling.
544 except rf
.NeedFirstVolume
as ex
:
545 xprint(" --- %s is middle part of multi-vol archive (%s)---", fn
, str(ex
))
547 exc
, msg
, tb
= sys
.exc_info()
548 xprint("\n *** %s: %s ***\n", exc
.__name
__, msg
)
551 exc
, msg
, tb
= sys
.exc_info()
552 xprint("\n *** %s: %s ***\n", exc
.__name
__, msg
)
557 """Program entry point.
559 global cf_verbose
, cf_show_comment
, cf_charset
560 global cf_extract
, cf_test_read
, cf_test_unrar
561 global cf_test_memory
567 opts
, args
= getopt
.getopt(sys
.argv
[1:], "p:C:hvcxtRM")
568 except getopt
.error
as ex
:
569 print(str(ex
), file=sys
.stderr
)
593 raise Exception("unhandled switch: " + o
)
598 for ln
in open(a
[1:], "r"):
612 if __name__
== "__main__":
615 except KeyboardInterrupt: