File: unzip.rkt

package info (click to toggle)
racket 7.9%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 178,684 kB
  • sloc: ansic: 282,112; lisp: 234,887; pascal: 70,954; sh: 27,112; asm: 16,268; makefile: 4,613; cpp: 2,715; ada: 1,681; javascript: 1,244; cs: 879; exp: 499; csh: 422; python: 274; xml: 106; perl: 104
file content (418 lines) | stat: -rw-r--r-- 17,404 bytes parent folder | download | duplicates (4)
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
#lang racket/base
(require racket/contract/base
         racket/port
         racket/file
         racket/date
         file/gunzip
         "private/strip-prefix.rkt"
         "private/check-path.rkt")

(provide
 (struct-out exn:fail:unzip:no-such-entry)

 (contract-out
  [unzip (((or/c path-string? input-port?))
          ((or/c (procedure-arity-includes/c 2) (procedure-arity-includes/c 3))
           ;; More precisely (but unimplementable):
           #;
           (or/c (bytes? boolean? input-port? (or/c #f exact-integer?) . -> . any)
                 (bytes? boolean? input-port? . -> . any))
           #:preserve-timestamps? any/c
           #:utc-timestamps? any/c)
          . ->* . any)]
  
  [make-filesystem-entry-reader (() (#:dest 
                                     (or/c #f path-string?)
                                     #:strip-count
                                     exact-nonnegative-integer?
                                     #:permissive?
                                     any/c
                                     #:exists
                                     (or/c 'skip
                                           'error 'replace 'truncate 'truncate/replace 'append 'update
                                           'can-update 'must-truncate))
                                 . ->* .
                                 ((bytes? boolean? input-port?)
                                  ((or/c #f exact-integer?))
                                  . ->* . any))]

  [read-zip-directory ((or/c path-string? input-port?) . -> . zip-directory?)]
  [zip-directory? (any/c . -> . boolean?)]
  [zip-directory-entries (zip-directory? . -> . (listof bytes?))]
  [zip-directory-contains? (zip-directory? (or/c path-string? bytes?) . -> . boolean?)]
  [zip-directory-includes-directory? (zip-directory? (or/c path-string? input-port?) . -> . boolean?)]
  [unzip-entry (((or/c path-string? input-port?) zip-directory? bytes?)
                ((or/c (procedure-arity-includes/c 2) (procedure-arity-includes/c 3))
                 #:preserve-timestamps? any/c
                 #:utc-timestamps? any/c)
                . ->* .
                any)]

  [call-with-unzip (-> (or/c path-string? input-port?)
                       (-> path-string? any)
                       any)]
  [call-with-unzip-entry (-> (or/c path-string? input-port?)
                             path-string?
                             (-> path-string? any)
                             any)]

  [path->zip-path (path-string? . -> . bytes?)]))

;; ===========================================================================
;; CONSTANTS
;; ===========================================================================

(define *local-file-header*                      #x04034b50)
(define *archive-extra-record*                   #x08064b50)
(define *central-file-header*                    #x02014b50)
(define *digital-signature*                      #x05054b50)
(define *zip64-end-of-central-directory-record*  #x06064b50)
(define *zip64-end-of-central-directory-locator* #x07064b50)
(define *end-of-central-directory-record*        #x06054b50)

;; ===========================================================================
;; DATATYPES AND UTILITIES
;; ===========================================================================

(define-struct (exn:fail:unzip:no-such-entry exn:fail) (entry)
  #:guard (lambda (msg cm entry who)
            (unless (bytes? entry)
              (raise-argument-error who "bytes?" entry))
            (values msg cm entry)))

;; (alistof bytes zip-entry)
(define-struct zip-directory (contents))

;; nat * boolean
(define-struct zip-entry (offset dir?))

(define (raise-unzip-error message)
  (error 'unzip "~a" message))
  
(define (raise-entry-not-found entry)
  (raise
   (make-exn:fail:unzip:no-such-entry
    (string->immutable-string
     (format "unzip: entry not found: \"~a\"" (bytes->string/latin-1 entry)))
    (current-continuation-marks)
    entry)))

;; zip-directory-entries : zip-directory -> (listof bytes)
(define (zip-directory-entries zipdir)
  (map car (zip-directory-contents zipdir)))

;; zip-directory-lookup : bytes zip-directory -> (option zip-entry)
(define (zip-directory-lookup entry zipdir)
  (let loop ([contents (zip-directory-contents zipdir)])
    (cond
     [(null? contents) #f]
     [(or (bytes=? entry (caar contents))
          (bytes=? (bytes-append entry #"/") (caar contents)))
      (cdar contents)]
     [else (loop (cdr contents))])))

;; zip-directory-contains? : zip-directory (union string path bytes) -> boolean
(define (zip-directory-contains? zipdir entry)
  (if (bytes? entry)
      (and (zip-directory-lookup entry zipdir) #t)
      (zip-directory-contains? zipdir (path->zip-path entry))))

;; matches-directory? : bytes bytes -> boolean
(define (bytes-prefix? dirname entry-name)
  (let ([dirname-len (bytes-length dirname)]
        [entry-name-len (bytes-length entry-name)])
    (and (>= entry-name-len dirname-len)
         (bytes=? (subbytes entry-name 0 dirname-len) dirname))))

;; zip-directory-includes-directory? : zip-directory (union string path bytes) -> boolean
(define (zip-directory-includes-directory? zipdir dirname)
  (if (bytes? dirname)
      (ormap (lambda (pair)
               (bytes-prefix? dirname (car pair)))
             (zip-directory-contents zipdir))
      (zip-directory-includes-directory? zipdir (path->zip-path dirname))))

;; path->zip-path : (union path string) -> bytes
(define (path->zip-path p)
  (let ([p (simplify-path p #f)])
    (if (path? p)
        (bytes->zip-bytes (path->bytes p))
        (bytes->zip-bytes (string->bytes/latin-1 p)))))

(define (bytes->zip-bytes b)
  (case (system-path-convention-type)
    [(windows) (regexp-replace* #rx#"\\\\" b #"/")]
    [else b]))

;; ===========================================================================
;; UNZIPPING ENGINE
;; ===========================================================================

(define *slash-byte* (char->integer #\/))

(define (directory-entry? name)
  (= (bytes-ref name (sub1 (bytes-length name))) *slash-byte*))

(define (read-integer count signed? in big-endian?)
  (define bstr (read-bytes count in))
  (unless (and (bytes? bstr) (= count (bytes-length bstr)))
    (error 'unzip "unexpected EOF"))
  (integer-bytes->integer bstr signed? big-endian?))

(define (peek-integer count signed? in big-endian?)
  (define bstr (peek-bytes count 0 in))
  (unless (and (bytes? bstr) (= count (bytes-length bstr)))
    (error 'unzip "unexpected EOF"))
  (integer-bytes->integer bstr signed? big-endian?))

(define (make-filter-input-port inflate orig-in)
  (define-values (in out) (make-pipe 4096))
  (values
   in
   (thread (lambda () 
             (inflate orig-in out)
             (close-output-port out)))))

(define (skip-bytes amt in)
  (read-bytes amt in)
  (void))

;; unzip-one-entry : input-port (bytes boolean input-port [exact-integer?] -> a) -> a
(define (unzip-one-entry in read-entry preserve-timestamps? utc?)
  (let ([read-int (lambda (count) (read-integer count #f in #f))])
    (let* ([signature            (read-int 4)]
           [version              (read-bytes 2 in)]
           [bits                 (read-int 2)]
           [compression          (read-int 2)]
           [time                 (read-int 2)]
           [date                 (read-int 2)]
           [crc-32               (read-int 4)]
           [compressed           (read-int 4)]
           [uncompressed         (read-int 4)]
           [filename-length      (read-int 2)]
           [extra-length         (read-int 2)]
           [filename             (read-bytes filename-length in)]
           [extra                (read-bytes extra-length in)])
      (let* ([mark (file-position in)]
             [dir? (directory-entry? filename)]
             ;; appnote VI-J : if bit 3 is set, the fields crc-32,
             ;; compressed size, and uncompressed size are set to
             ;; zero in the local header
             [in0 (if (bitwise-bit-set? bits 3)
                      in
                      (make-limited-input-port in compressed #f))])
        (dynamic-wind
            void
            (lambda ()
              (define-values (in t)
                (if (zero? compression)
                    (values in0 #f)
                    (make-filter-input-port inflate in0)))
              
              (if preserve-timestamps?
                  (read-entry filename dir? in (and (not dir?)
                                                    (msdos-date+time->seconds date time utc?)))
                  (read-entry filename dir? in))

              ;; Read until the end of the deflated stream when compressed size unknown
              (when (bitwise-bit-set? bits 3)
                (let loop () (unless (eof-object? (read-bytes 1024 in)) (loop))))

              (when t (kill-thread t)))

            (lambda ()
              ;; appnote VI-C : if bit 3 is set, then the file data
              ;; is immediately followed by a data descriptor
              ;; appnote 4.3.9.3 : the value 0x08074b50 may appear
              ;; as a data descriptor signature immediately
              ;; following the file data
              (if (bitwise-bit-set? bits 3)
                  ;; Read possibly signed data descriptor
                  (let ([maybe-signature (read-int 4)])
                    (skip-bytes (if (= maybe-signature #x08074b50) 12 8)
                                in))
                  (skip-bytes (- (+ mark compressed) (file-position in)) in)))))
      (void))))

;; find-central-directory : input-port nat -> nat nat nat
(define (find-central-directory in size)
  (let loop ([pos (- size 18)])
    (unless (positive? pos)
      (raise-unzip-error "no central directory"))
    (file-position in pos)
    (let* ([read-int (lambda (count) (read-integer count #f in #f))]
           [signature (read-int 4)])
      (if (= signature *end-of-central-directory-record*)
          (let ([disk-number       (read-int 2)]
                [directory-disk    (read-int 2)]
                [disk-entries      (read-int 2)]
                [entry-count       (read-int 2)]
                [directory-length  (read-int 4)]
                [directory-offset  (read-int 4)]
                [comment-length    (read-int 2)])
            (if (= (- size (file-position in)) comment-length)
                (values directory-offset directory-length entry-count)
                (loop (sub1 pos))))
          (loop (sub1 pos))))))

;; read-central-directory : input-port nat -> (alistof bytes zip-entry)
(define (read-central-directory in size)
  (let-values ([(offset length count) (find-central-directory in size)])
    (file-position in offset)
    (build-list count
                (lambda (i)
                  (let* ([read-int (lambda (count)
                                     (read-integer count #f in #f))]
                         [signature (read-int 4)])
                    (unless (= signature *central-file-header*)
                      (raise-unzip-error
                       (format "bad central file header signature: ~a"
                               signature)))
                    (let ([version             (read-int 2)]
                          [required            (read-int 2)]
                          [bits                (read-int 2)]
                          [compression         (read-int 2)]
                          [time                (read-int 2)]
                          [date                (read-int 2)]
                          [crc-32              (read-int 4)]
                          [compressed          (read-int 4)]
                          [uncompressed        (read-int 4)]
                          [filename-length     (read-int 2)]
                          [extra-length        (read-int 2)]
                          [comment-length      (read-int 2)]
                          [disk-number         (read-int 2)]
                          [internal-attributes (read-int 2)]
                          [external-attributes (read-int 4)]
                          [relative-offset     (read-int 4)])
                      (let* ([filename (read-bytes filename-length in)]
                             [dir? (directory-entry? filename)])
                        (skip-bytes (+ extra-length comment-length) in)
                        (cons filename (make-zip-entry relative-offset dir?)))))))))

(define (msdos-date+time->seconds date time utc?)
  (with-handlers ([exn:fail? (lambda (exn) #f)])
    (find-seconds (* 2 (bitwise-and #x1F time))
                  (bitwise-and #x3F (arithmetic-shift time -5))
                  (bitwise-and #x1F (arithmetic-shift time -11))
                  (bitwise-and #x1F date)
                  (bitwise-and #xF (arithmetic-shift date -5))
                  (+ (bitwise-and #x7F (arithmetic-shift date -9)) 1980)
                  (not utc?))))

;; ===========================================================================
;; FRONT END
;; ===========================================================================

(define (call-with-input in proc)
  ((if (input-port? in)
       (lambda (in f) (f in))
       call-with-input-file*)
   in
   proc))

;; unzip : [(or/c path-string? input-port) (bytes boolean input-port -> any)] -> any
(define unzip
  (lambda (in [read-entry (make-filesystem-entry-reader)]
              #:preserve-timestamps? [preserve-timestamps? #f]
              #:utc-timestamps? [utc? #f])
    (call-with-input
     in
     (lambda (in)
       (when (= (peek-integer 4 #f in #f) *local-file-header*)
         (unzip-one-entry in read-entry preserve-timestamps? utc?)
         (unzip in read-entry
                #:preserve-timestamps? preserve-timestamps?
                #:utc-timestamps? utc?))))))

(define (input-size in)
  (file-position in eof)
  (begin0
   (file-position in)
   (file-position in 0)))

;; read-zip-directory : (union string path) -> zip-directory
(define (read-zip-directory in)
  (make-zip-directory
   (call-with-input
    in
    (lambda (in)
      (read-central-directory in
                              (input-size in))))))

;; unzip-entry : (union string path) zip-directory bytes [(bytes boolean input-port -> a)] -> a
(define unzip-entry
  (lambda (in dir entry-name [read-entry (make-filesystem-entry-reader)]
              #:preserve-timestamps? [preserve-timestamps? #f]
              #:utc-timestamps? [utc? #f])
    (cond
     [(zip-directory-lookup entry-name dir)
      => (lambda (entry)
           (call-with-input
            in
            (lambda (in)
              (file-position in (zip-entry-offset entry))
              (unzip-one-entry in read-entry preserve-timestamps? utc?))))]
     [else (raise-entry-not-found entry-name)])))

;; ===========================================================================
;; ENTRY PARSERS
;; ===========================================================================

;; make-filesystem-entry-reader : [output-flag] -> (bytes boolean input-port -> any)
(define make-filesystem-entry-reader
  (lambda (#:dest [dest-dir #f] #:strip-count [strip-count 0] #:permissive? [permissive? #f] #:exists [flag 'error])
    (lambda (name dir? in [timestamp #f])
      (define path (bytes->path name))
      (check-unpack-path 'unzip path #:allow-up? permissive?)
      (let* ([base-path (strip-prefix path strip-count)]
             [path (and base-path
                        (if dest-dir
                            (build-path dest-dir base-path)
                            base-path))])
        (when path
          (if dir?
              (unless (directory-exists? path)
                (make-directory* path))
              (let ([parent (dirname path)])
                (unless (directory-exists? parent)
                  (make-directory* parent))
                (unless (and (eq? flag 'skip)
                             (file-exists? path))
                  (with-output-to-file path
                    #:exists flag
                    (lambda ()
                      (copy-port in (current-output-port))))
                  (when timestamp
                    (file-or-directory-modify-seconds path timestamp))))))))))

(define (dirname p)
  (define-values (base name dir?) (split-path p))
  (if (path? base)
      base
      (current-directory)))

(define (call-with-unzip-entry zip-file entry-file user-proc)
  (let ([temp-dir #f])
    (dynamic-wind
        (lambda ()
          (set! temp-dir (make-temporary-file "ziptmp~a" 'directory)))
        (lambda ()
          (let ([directory-entries (read-zip-directory zip-file)])
            (unzip-entry zip-file
                         directory-entries 
                         (path->zip-path entry-file) 
                         (make-filesystem-entry-reader #:dest temp-dir #:exists 'replace))
            (user-proc (build-path temp-dir entry-file))))
        (lambda ()
          (delete-directory/files temp-dir)))))

(define (call-with-unzip zip-file user-proc)
  (let ([temp-dir #f])
    (dynamic-wind
        (lambda ()
          (set! temp-dir (make-temporary-file "ziptmp~a" 'directory)))
        (lambda ()
          (unzip zip-file (make-filesystem-entry-reader #:dest temp-dir #:exists 'replace))
          (user-proc temp-dir))
        (lambda ()
          (delete-directory/files temp-dir)))))