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
|
# -*- tcl -*-
# ### ### ### ######### ######### #########
## Copyright (c) 2008-2012 ActiveState Software Inc.
## Andreas Kupries
## BSD License
##
# Package providing commands for the decoding of basic zip-file
# structures.
package require Tcl 8.4
package require fileutil::magic::mimetype ; # Tcllib. File type determination via magic constants
package require fileutil::decode 0.2 ; # Framework for easy decoding of files.
namespace eval ::zipfile::decode {}
if {[package vcompare $tcl_patchLevel "8.6"] < 0} {
# Only needed pre-8.6
package require Trf ; # Wrapper to zlib
package require zlibtcl ; # Zlib usage. No commands, access through Trf
set ::zipfile::decode::native_zip_functs 0
} else {
set ::zipfile::decode::native_zip_functs 1
}
namespace eval ::zipfile::decode {
namespace import ::fileutil::decode::*
}
# ### ### ### ######### ######### #########
## Convenience command, decode and copy to dir
proc ::zipfile::decode::unzipfile {in out} {
zipfile::decode::open $in
set zd [zipfile::decode::archive]
zipfile::decode::unzip $zd $out
zipfile::decode::close
return
}
## Convenience command, decode and return list of contained paths.
proc ::zipfile::decode::content {in} {
zipfile::decode::open $in
set zd [zipfile::decode::archive]
set f [files $zd]
zipfile::decode::close
return $f
}
# ### ### ### ######### ######### #########
##
proc ::zipfile::decode::iszip {fname} {
if {[catch {
LocateEnd $fname
} msg]} {
return 0
}
return 1
}
proc ::zipfile::decode::open {fname} {
variable eoa
if {[catch {
set eoa [LocateEnd $fname]
} msg]} {
return -code error -errorcode {ZIP DECODE BAD ARCHIVE} \
"\"$fname\" is not a zip file"
}
fileutil::decode::open $fname
return
}
proc ::zipfile::decode::close {} {
variable eoa
unset eoa
fileutil::decode::close
return
}
# ### ### ### ######### ######### #########
##
proc ::zipfile::decode::comment {zdict} {
array set _ $zdict
return $_(comment)
}
proc ::zipfile::decode::files {zdict} {
array set _ $zdict
array set f $_(files)
return [array names f]
}
proc ::zipfile::decode::hasfile {zdict fname} {
array set _ $zdict
array set f $_(files)
return [info exists f($fname)]
}
proc ::zipfile::decode::copyfile {zdict src dst} {
array set _ $zdict
array set f $_(files)
if {![info exists f($src)]} {
return -code error -errorcode {ZIP DECODE BAD PATH} \
"File \"$src\" not known"
}
array set fd $f($src)
CopyFile $src fd $dst
return
}
proc ::zipfile::decode::getfile {zdict src} {
array set _ $zdict
array set f $_(files)
if {![info exists f($src)]} {
return -code error -errorcode {ZIP DECODE BAD PATH} \
"File \"$src\" not known"
}
array set fd $f($src)
return [GetFile $src fd]
}
proc ::zipfile::decode::unzip {zdict dst} {
array set _ $zdict
array set f $_(files)
foreach src [array names f] {
array set fd $f($src)
CopyFile $src fd [file join $dst $src]
unset fd
}
return
}
proc ::zipfile::decode::CopyFile {src fdv dst} {
upvar 1 $fdv fd
file mkdir [file dirname $dst]
if {[string match */ $src]} {
# Entry is a directory. Just create.
file mkdir $dst
return
}
# Create files. Empty files are a special case, we have
# nothing to decompress.
if {$fd(ucsize) == 0} {
::close [::open $dst w] ; # touch
return
}
# non-empty files, work depends on type of compression.
switch -exact -- $fd(cm) {
uncompressed {
go $fd(fileloc)
nbytes $fd(csize)
set out [::open $dst w]
fconfigure $out -translation binary -encoding binary -eofchar {}
puts -nonewline $out [getval]
::close $out
}
deflate {
go $fd(fileloc)
nbytes $fd(csize)
set out [::open $dst w]
fconfigure $out -translation binary -encoding binary -eofchar {}
if {$::zipfile::decode::native_zip_functs} {
puts -nonewline $out \
[zlib inflate [getval]]
} else {
puts -nonewline $out \
[zip -mode decompress -nowrap 1 -- \
[getval]]
}
::close $out
}
default {
return -code error -errorcode {ZIP DECODE BAD COMPRESSION} \
"Unable to handle file \"$src\" compressed with method \"$fd(cm)\""
}
}
if {
($::tcl_platform(platform) ne "windows") &&
($fd(efattr) != 0)
} {
# On unix take the permissions encoded in the external
# attributes and apply them to the new file. If there are
# permission. A value of 0 indicates an older teabag where
# the encoder did not yet support permissions. These we do not
# change from the sustem defaults. Permissions are in the
# lower 9 bits of the MSW.
file attributes $dst -permissions \
[string map {0 --- 1 --x 2 -w- 3 -wx 4 r-- 5 r-x 6 rw- 7 rwx} \
[format %03o [expr {($fd(efattr) >> 16) & 0x1ff}]]]
}
# FUTURE: Run crc checksum on created file and compare to the
# ......: stored information.
return
}
proc ::zipfile::decode::GetFile {src fdv} {
upvar 1 $fdv fd
# Entry is a directory.
if {[string match */ $src]} {return {}}
# Empty files are a special case, we have
# nothing to decompress.
if {$fd(ucsize) == 0} {return {}}
# non-empty files, work depends on type of compression.
switch -exact -- $fd(cm) {
uncompressed {
go $fd(fileloc)
nbytes $fd(csize)
return [getval]
}
deflate {
go $fd(fileloc)
nbytes $fd(csize)
return [zip -mode decompress -nowrap 1 -- [getval]]
}
default {
return -code error -errorcode {ZIP DECODE BAD COMPRESSION} \
"Unable to handle file \"$src\" compressed with method \"$fd(cm)\""
}
}
# FUTURE: Run crc checksum on created file and compare to the
# ......: stored information.
return {}
}
# ### ### ### ######### ######### #########
##
proc ::zipfile::decode::tag {etag} {
mark
long-le
return [match 0x${etag}4b50] ; # 'PK x y', little-endian integer.
}
proc ::zipfile::decode::localfileheader {} {
clear
putloc @
if {![tag 0403]} {clear ; return 0}
short-le ; unsigned ; recode VER ; put vnte ; # version needed to extract
short-le ; unsigned ; put gpbf ; # general purpose bitflag
short-le ; unsigned ; recode CM ; put cm ; # compression method
short-le ; unsigned ; put lmft ; # last mod file time
short-le ; unsigned ; put lmfd ; # last mod file date
long-le ; unsigned ; put crc ; # crc32 | zero's here imply non-seekable,
long-le ; unsigned ; put csize ; # compressed file size | data is in a DDS behind the stored
long-le ; unsigned ; put ucsize ; # uncompressed file size | file.
short-le ; unsigned ; put fnamelen ; # file name length
short-le ; unsigned ; put efieldlen ; # extra field length
array set hdr [get]
clear
nbytes $hdr(fnamelen) ; put fname
putloc efieldloc
skip $hdr(efieldlen)
putloc fileloc
array set hdr [get]
clear
set hdr(gpbf) [GPBF $hdr(gpbf) $hdr(cm)]
setbuf [array get hdr]
return 1
}
proc ::zipfile::decode::centralfileheader {} {
clear
putloc @
if {![tag 0201]} {clear ; return 0}
# The items marked with ++ do not exist in the local file
# header. Everything else exists in the local file header as well,
# and has to match that information.
clear
short-le ; unsigned ; recode VER ; put vmb ; # ++ version made by
short-le ; unsigned ; recode VER ; put vnte ; # version needed to extract
short-le ; unsigned ; put gpbf ; # general purpose bitflag
short-le ; unsigned ; recode CM ; put cm ; # compression method
short-le ; unsigned ; put lmft ; # last mod file time
short-le ; unsigned ; put lmfd ; # last mod file date
long-le ; unsigned ; put crc ; # crc32 | zero's here imply non-seekable,
long-le ; unsigned ; put csize ; # compressed file size | data is in a DDS behind the stored
long-le ; unsigned ; put ucsize ; # uncompressed file size | file.
short-le ; unsigned ; put fnamelen ; # file name length
short-le ; unsigned ; put efieldlen2 ; # extra field length
short-le ; unsigned ; put fcommentlen ; # ++ file comment length
short-le ; unsigned ; put dns ; # ++ disk number start
short-le ; unsigned ; recode IFA ; put ifattr ; # ++ internal file attributes
long-le ; unsigned ; put efattr ; # ++ external file attributes
long-le ; unsigned ; put localloc ; # ++ relative offset of local file header
array set hdr [get]
clear
nbytes $hdr(fnamelen) ; put fname
putloc efieldloc2
skip $hdr(efieldlen2)
nbytes $hdr(fcommentlen) ; put comment
array set hdr [get]
clear
set hdr(gpbf) [GPBF $hdr(gpbf) $hdr(cm)]
setbuf [array get hdr]
return 1
}
## NOT USED
proc ::zipfile::decode::datadescriptor {} {
if {![tag 0807]} {return 0}
clear
long-le ; unsigned ; put crc ; # crc32
long-le ; unsigned ; put csize ; # compressed file size
long-le ; unsigned ; put ucsize ; # uncompressed file size
return 1
}
proc ::zipfile::decode::endcentralfiledir {} {
clear
putloc ecdloc
if {![tag 0605]} {clear ; return 0}
short-le ; unsigned ; put nd ; #
short-le ; unsigned ; put ndscd ; #
short-le ; unsigned ; put tnecdd ; #
short-le ; unsigned ; put tnecd ; #
long-le ; unsigned ; put sizecd ; #
long-le ; unsigned ; put ocd ; #
short-le ; unsigned ; put commentlen ; # archive comment length
array set hdr [get] ; clear
nbytes $hdr(commentlen) ; put comment
array set hdr [get] ; clear
setbuf [array get hdr]
return 1
}
## NOT USED
proc ::zipfile::decode::afile {} {
if {![localfileheader]} {return 0}
array set hdr [get]
if {($hdr(ucsize) == 0) || ($hdr(csize) > 0)} {
# The header entry specifies either
# 1. A zero-length file (possibly a directory entry), or
# 2. a non-empty file (compressed size > 0).
# In both cases we can skip the file contents directly.
# In both cases there should be no data descriptor behind
# we contents, but we check nevertheless. If there is its
# data overrides the current size and crc info.
skip $hdr(csize)
if {[datadescriptor]} {
array set hdr [get]
set hdr(ddpresent) 1
setbuf [array get hdr]
}
} else {
return -code error -errorcode {ZIP DECODE INCOMPLETE} \
"Search data descriptor. Not Yet Implementyed"
}
return 1
}
proc ::zipfile::decode::archive {} {
variable eoa
array set cb $eoa
# Position us at the beginning of CFH, using the data provided to
# us by 'LocateEnd', called during 'open'.
go [expr {$cb(base) + $cb(coff)}]
array set fn {}
set nentries 0
while {[centralfileheader]} {
array set _ [set data [get]] ; clear
#parray _
# Use the information found in the CFH entry to locate and
# read the associated LFH. We explicitly remember where we are
# in the file because mark/rewind is only one level and the
# LFH command already used that up.
set here [at]
go [expr {$cb(base) + $_(localloc)}]
if {![localfileheader]} {
return -code error -errorcode {ZIP DECODE BAD ARCHIVE} \
"Bad zip file. Directory entry without file."
}
array set lh [get] ; clear
go $here
# Compare the information in the CFH entry and associated
# LFH. Should match.
if {![hdrmatch lh _]} {
return -code error -errorcode {ZIP DECODE BAD ARCHIVE} \
"Bad zip file. File/Dir Header mismatch."
}
# Merge local and central data.
array set lh $data
set fn($_(fname)) [array get lh]
unset lh _
incr nentries
}
if {![endcentralfiledir]} {
return -code error "Bad zip file. Bad closure."
}
array set _ [get] ; clear
#parray _
#puts \#$nentries
if {$nentries != $_(tnecd)} {
return -code error "Bad zip file. \#Files does match \#Actual files"
}
set _(files) [array get fn]
return [array get _]
}
proc ::zipfile::decode::hdrmatch {lhv chv} {
upvar 1 $lhv lh $chv ch
#puts ______________________________________________
#parray lh
#parray ch
foreach key {
vnte gpbf cm lmft lmfd fnamelen fname
} {
if {$lh($key) != $ch($key)} {return 0}
}
if {[lsearch -exact $lh(gpbf) dd] < 0} {
# Compare the central and local size information only if the
# latter is not provided by a DDS. Which we haven't read.
# Because in that case the LFH information is uniformly 0, not
# known at the time of writing.
foreach key {
crc csize ucsize
} {
if {$lh($key) != $ch($key)} {return 0}
}
}
return 1
}
# ### ### ### ######### ######### #########
##
proc ::zipfile::decode::IFA {v} {
if {$v & 0x1} {
return text
} else {
return binary
}
}
# ### ### ### ######### ######### #########
##
namespace eval ::zipfile::decode {
variable vhost
array set vhost {
0 FAT 1 Amiga
2 VMS 3 Unix
4 VM/CMS 5 Atari
6 HPFS 7 Macintosh
8 Z-System 9 CP/M
10 TOPS-20 11 NTFS
12 SMS/QDOS 13 {Acorn RISC OS}
14 VFAT 15 MVS
16 BeOS 17 Tandem
}
}
proc ::zipfile::decode::VER {v} {
variable vhost
set u [expr {($v & 0xff00) >> 16}]
set l [expr {($v & 0x00ff)}]
set major [expr {$l / 10}]
set minor [expr {$l % 10}]
return [list $vhost($u) ${major}.$minor]
}
# ### ### ### ######### ######### #########
##
namespace eval ::zipfile::decode {
variable cm
array set cm {
0 uncompressed 1 shrink
2 {reduce 1} 3 {reduce 2}
4 {reduce 3} 5 {reduce 4}
6 implode 7 reserved
8 deflate 9 reserved
10 implode-pkware-dcl
}
}
proc ::zipfile::decode::CM {v} {
variable cm
return $cm($v)
}
# ### ### ### ######### ######### #########
##
namespace eval ::zipfile::decode {
variable gbits
array set gbits {
0,1 encrypted
1,0,implode 4k-window
1,1,implode 8k-window
2,0,implode 2fano
2,1,implode 3fano
3,1 dd
5,1 patched
deflate,0 normal
deflate,1 maximum
deflate,2 fast
deflate,3 superfast
}
}
proc ::zipfile::decode::GPBF {v cm} {
variable gbits
set res {}
if {$cm eq "deflate"} {
# bit 1, 2 are treated together for deflate
lappend res $gbits($cm,[expr {($v >> 1) & 0x3}])
}
set bit 0
while {$v > 0} {
set odd [expr {$v % 2 == 1}]
if {[info exists gbits($bit,$odd,$cm)]} {
lappend res $gbits($bit,$odd,$cm)
} elseif {[info exists gbits($bit,$odd)]} {
lappend res $gbits($bit,$odd)
}
set v [expr {$v >> 1}]
incr bit
}
return $res
}
# ### ### ### ######### ######### #########
## Decode the zip file by locating its end (of the central file
## header). The higher levels will then use the information
## inside to locate and read the CFH. No scanning from the beginning
## This piece of code lifted from tclvs/library/zipvfs (v 1.0.3).
proc ::zipfile::decode::LocateEnd {path} {
set fd [::open $path r]
fconfigure $fd -translation binary ;#-buffering none
array set cb {}
# [SF Tclvfs Bug 1003574]. Do not seek over beginning of file.
seek $fd 0 end
# Just looking in the last 512 bytes may be enough to handle zip
# archives without comments, however for archives which have
# comments the chunk may start at an arbitrary distance from the
# end of the file. So if we do not find the header immediately we
# have to extend the range of our search, possibly until we have a
# large part of the archive in memory. We can fail only after the
# whole file has been searched.
set sz [tell $fd]
set len 512
set at 512
while {1} {
if {$sz < $at} {set n -$sz} else {set n -$at}
seek $fd $n end
set hdr [read $fd $len]
# We are using 'string last' as we are searching the first
# from the end, which is the last from the beginning. See [SF
# Bug 2256740]. A zip archive stored in a zip archive can
# confuse the unmodified code, triggering on the magic
# sequence for the inner, uncompressed archive.
set pos [string last "PK\05\06" $hdr]
if {$pos == -1} {
if {$at >= $sz} {
return -code error "no header found"
}
# after the 1st iteration we force an overlap with last
# buffer to ensure that the pattern we look for is not
# split at a buffer boundary, nor the header itself
set len 540
incr at 512
} else {
break
}
}
set hdrlen [string length $hdr]
set hdr [string range $hdr [expr {$pos + 4}] [expr {$pos + 21}]]
set pos [expr {wide([tell $fd]) + $pos - $hdrlen}]
if {$pos < 0} {
set pos 0
}
binary scan $hdr ssssiis _ _ _ _ cb(csize) cb(coff) _
# Compute base for situations where ZIP file has been appended to
# another media (e.g. EXE). We can do this because
# (a) The expected location is stored in ECFH. (-> cb(coff))
# (b) We know the actual location of EFCH. (-> pos)
# (c) We know the size of CFH (-> cb(csize))
# (d) The CFH comes directly before the EFCH.
# (e) Items b...d provide us with the actual location of CFH, as (b)-(c).
# Thus the difference between (e) and (d) is the base in question.
set base [expr { $pos - $cb(csize) - $cb(coff) }]
if {$base < 0} {
set base 0
}
set cb(base) $base
if {$cb(coff) < 0} {
set cb(base) [expr {wide($cb(base)) - 4294967296}]
set cb(coff) [expr {wide($cb(coff)) + 4294967296}]
}
#--------------
::close $fd
return [array get cb]
}
# ### ### ### ######### ######### #########
## Ready
package provide zipfile::decode 0.7
return
|