source: project/release/4/ugarit/trunk/ugarit-core.scm @ 25555

Last change on this file since 25555 was 25555, checked in by Alaric Snell-Pym, 9 years ago

ugarit: Many minor improvements to crash safety (see README.txt)

File size: 47.4 KB
Line 
1(module ugarit-core
2        (open-archive
3         archive?
4         archive-hash
5         archive-global-directory-rules
6         archive-snapshot-blocks-stored
7         archive-snapshot-bytes-stored
8         archive-snapshot-blocks-skipped
9         archive-snapshot-bytes-skipped
10         archive-file-cache-hits
11         archive-file-cache-bytes
12         archive-writable?
13         archive-unlinkable?
14         archive-exists?
15         archive-get
16         archive-put!
17         archive-flush!
18         archive-remove-tag!
19         archive-set-tag!
20         archive-tag
21         archive-all-tags
22         archive-lock-tag!
23         archive-unlock-tag!
24         archive-tag-locked?
25         archive-link!
26         archive-unlink!
27         archive-close!
28
29         archive-store-block!
30
31         make-key-stream-writer*
32         key-stream-writer?
33         key-stream-writer-write!
34         key-stream-writer-finish!
35         unlink-key-stream!
36         fold-key-stream
37
38         make-sexpr-stream-writer*
39         sexpr-stream-writer?
40         sexpr-stream-writer-write!
41         sexpr-stream-writer-finish!
42         unlink-sexpr-stream!
43         fold-sexpr-stream
44
45         store-sexpr!
46         read-sexpr
47
48         epochtime->string
49
50         store-file!
51         write-file-contents
52         unlink-file!
53         
54         store-directory!
55         unlink-directory!
56         extract-directory!
57         extract-object!
58         ; FIXME: These two will be useful in future
59         ;verify-directory!
60         ;verify-object!
61         snapshot-directory-tree!
62         tag-snapshot!
63         fold-history
64         fold-archive-node)
65
66(import scheme)
67(import chicken)
68
69(use autoload)
70
71(define ((deny-autoload module)) (error (sprintf "Autoload does not seem to be working, so optional components from module ~s are not working" module) module))
72
73(define-syntax no-autoload
74  (er-macro-transformer
75   (lambda (expr rename compare)
76     (let ((module (cadr expr))
77           (procs (cddr expr))
78           (_begin (rename 'begin))
79           (_define (rename 'define))
80           (_deny-autoload (rename 'deny-autoload)))
81           (cons _begin
82                 (map (lambda (x)
83                        (let ((orig-binding (if (pair? x) (car x) x))
84                              (new-binding (if (pair? x) (cadr x) x)))
85                          `(,_define ,new-binding (,_deny-autoload ',module))))
86                      procs))))))
87
88(no-autoload lzma (compress lzma:compress) (decompress lzma:decompress))
89(no-autoload z3 z3:encode-buffer z3:decode-buffer)
90(autoload tiger-hash tiger192-digest tiger192-binary-digest)
91(no-autoload sha2 sha256-digest sha384-digest sha512-digest sha512-binary-digest)
92(no-autoload aes make-aes128-encryptor make-aes128-decryptor make-aes192-encryptor make-aes192-decryptor make-aes256-encryptor make-aes256-decryptor)
93
94(use srfi-1)
95(use srfi-4)
96(use srfi-13)
97(use srfi-18)
98(use extras)
99(use ports)
100(use files)
101(use lolevel)
102(use data-structures)
103(use directory-rules)
104(use miscmacros)
105(use posix)
106(use posix-extras)
107(use crypto-tools)
108(use stty)
109(use matchable)
110(use regex)
111(use ugarit-backend)
112(use sql-de-lite)
113
114
115;;
116;; THE ARCHIVE
117;; This thing is becoming a bit of a God Object. Figure out how to
118;; refactor it a bit, perhaps?
119;;
120
121(define-record archive
122  storage ; The storage instance we use
123  check-correctness? ; boolean flag
124  store-atime? ; boolean flag
125  store-ctime? ; boolean flag
126  hash ; the hash function, u8vector+type symbol->hex string
127  compress ; the compressor, u8vector->smaller u8vector
128  decompress ; the decompressor, inverse of the above
129  encrypt ; the encryptor, u8vector -> u8vector
130  decrypt ; the decryptor, inverse of the above
131  global-directory-rules ; top-level directory rules
132
133  ; Snapshot counters
134  (setter snapshot-blocks-stored)              ; Blocks written to storage
135  (setter snapshot-bytes-stored)               ; Bytes written to storage
136  (setter snapshot-blocks-skipped)             ; Blocks already in storage and reused (not including file cache wins)
137  (setter snapshot-bytes-skipped)              ; Bytes already in storage and reused (not including file cache wins)
138
139  ; File cache
140  file-cache ; sqlite db storing filesystem cache (see store-file! procedure); #f if not enabled
141  file-cache-get-query ; sqlite stored procedure
142  file-cache-set-query ; sqlite stored procedure
143  (setter file-cache-updates-uncommitted) ; count of updates since last commit
144  (setter file-cache-hits)              ; count of file cache hits
145  (setter file-cache-bytes)                 ; count of file cache bytes saved
146  )
147
148(define file-cache-commit-interval 1000)
149
150(define (file-cache-put! archive file-path mtime size key)
151  (when (> file-cache-commit-interval (archive-file-cache-updates-uncommitted archive))
152        ((storage-flush! (archive-storage archive))) ; Flush the storage before we commit our cache, for crash safety
153        (exec (sql (archive-file-cache archive) "commit;"))
154        (exec (sql (archive-file-cache archive) "begin;"))
155        (set! (archive-file-cache-updates-uncommitted archive) 0))
156  (exec (archive-file-cache-set-query archive)
157        file-path mtime size key)
158  (inc! (archive-file-cache-updates-uncommitted archive)))
159
160(define (file-cache-get archive file-path mtime size)
161  (let ((data (query fetch
162                     (archive-file-cache-get-query archive)
163                    file-path mtime size)))
164    (if (pair? data)
165        (car data)
166        #f)))
167
168(define (prepend-type-byte b v)
169  (let* ((v-len (u8vector-length v))
170         (v2 (make-u8vector (+ 1 v-len))))
171    (set! (u8vector-ref v2 0) b)
172
173    (move-memory! v v2 v-len 0 1)
174    v2))
175
176(define (choose-compression-function config)
177  (match config
178         (#f (lambda (block) (prepend-type-byte 0 block))) ; No compression
179         (('deflate) (lambda (block) (prepend-type-byte 1 (blob->u8vector/shared (string->blob (z3:encode-buffer (blob->string (u8vector->blob/shared block)))))))) ; deflate compression
180         (('lzma) (lambda (block) (prepend-type-byte 2 (blob->u8vector/shared (lzma:compress (u8vector->blob/shared block))))))
181         (else (signal (make-property-condition 'exn 'location 'open-archive 'message "Unknown compression type" 'arguments (list config))))))
182
183(define (decompress block)
184  (case (u8vector-ref block 0)
185    ((0) (subu8vector block 1 (u8vector-length block))) ; No compression
186    ((1) (blob->u8vector/shared (string->blob (z3:decode-buffer (blob->string (u8vector->blob/shared (subu8vector block 1 (u8vector-length block)))))))) ; deflate
187    ((2) (blob->u8vector/shared (lzma:decompress (u8vector->blob/shared (subu8vector block 1 (u8vector-length block)))))))) ; lzma
188
189(define (choose-hash-function config)
190  (let ((make-basic-hash (lambda (hash) (lambda (block type) (string-append (hash block) (symbol->string type)))))
191        (make-keyed-hash (lambda (hash key) (lambda (block type) (hash (string-append key (hash block) (symbol->string type)))))))
192    (match config
193           ((or #f ('tiger)) (make-basic-hash tiger192-digest))
194           (('tiger key) (make-keyed-hash tiger192-digest key))
195           (('sha256) (make-basic-hash sha256-digest))
196           (('sha256 key) (make-keyed-hash sha256-digest key))
197           (('sha384) (make-basic-hash sha384-digest))
198           (('sha384 key) (make-keyed-hash sha384-digest key))
199           (('sha512) (make-basic-hash sha512-digest))
200           (('sha512 key) (make-keyed-hash sha512-digest key))
201           (else (signal (make-property-condition 'exn 'location 'open-archive 'message "Unknown hash algorithm" 'arguments (list config)))))))
202
203(define (read-password prompt)
204  (display prompt)
205  (with-stty '(not echo) read-line))
206
207                                        ; Key specs are "hexhexhex" or (number-of-bytes "passphrase")
208(define (key->blob keyspec)
209  (cond
210   ((string? keyspec)
211    (hexstring->blob keyspec))
212   ((pair? keyspec)
213    (let* ((get-passphrase (lambda (maybe-passphrase)
214                             (if (eq? maybe-passphrase 'prompt)
215                                 (read-password "Passphrase: ")
216                                 maybe-passphrase)))
217           (length (car keyspec))
218           (passphrase (get-passphrase (cadr keyspec)))
219           (key (sha512-binary-digest passphrase)))
220      (if (> length 64) ; 512 bits = 64 bytes
221          (signal (make-property-condition 'exn 'location 'open-archive  'message "Cannot generate a key that large due to a shortage of a big enough hash function (max 64)" 'arguments (list keyspec)))
222          (string->blob (substring/shared key 0 length)))))))
223
224
225(define (choose-crypto-functions config)
226  (match config
227         (#f (values
228              (lambda (block) block)
229              (lambda (block) block))) ; No encryption
230         (('aes keyspec)
231          (let ((key (key->blob keyspec))
232                (iv (make-blob 16)) ; IV is pseudo-randomly generated based on the blocks we are fed as an entropy source
233                (stir-iv! (lambda (iv block)
234                            (move-memory! (string->blob
235                                           (tiger192-binary-digest (string-append (tiger192-binary-digest block) (blob->string iv))))
236                                          iv 16))))
237
238                                        ; Generate initial IV from the key and current time
239            (move-memory! (string->blob (tiger192-binary-digest
240                                         (string-append (blob->string key) (number->string (current-seconds))))) iv 16)
241
242            (let-values (((encryptor decryptor)
243                          (case (blob-size key)
244                            ((16) (values
245                                   (make-aes128-encryptor key)
246                                   (make-aes128-decryptor key)))
247                            ((24) (values
248                                   (make-aes192-encryptor key)
249                                   (make-aes192-decryptor key)))
250                            ((32) (values
251                                   (make-aes256-encryptor key)
252                                   (make-aes256-decryptor key)))
253                            (else
254                             (signal (make-property-condition 'exn 'location 'open-archive 'message "AES keys must be 16, 24, or 32 bytes long" 'arguments (list keyspec)))))))
255              (let ((cbc-encryptor (make-cbc*-encryptor encryptor 16))
256                    (cbc-decryptor (make-cbc*-decryptor decryptor 16)))
257                (values
258                 (lambda (block)
259                   (stir-iv! iv block)
260                   (blob->u8vector/shared (cbc-encryptor (u8vector->blob/shared block) iv)))
261                 (lambda (block) (blob->u8vector/shared (cbc-decryptor (u8vector->blob/shared block)))))))))
262         (else (signal (make-property-condition 'exn 'location 'open-archive 'message "Unknown encryption type" 'arguments (list config))))))
263
264                                        ; A config is an sexpr of the form:
265                                        ; ((<key> <value>)|<flag>...)
266                                        ; Valid keys:
267                                        ; storage (expression to create a storage backend)
268                                        ; compression algorithm name
269                                        ; encryption (algorithm-name "key")
270                                        ; Valid flags:
271                                        ; double-check - check correctness lots, even if it costs efficiency
272(define (open-archive config store-atime? store-ctime?)
273  (let ((*storage* #f)
274        (*compression* #f)
275        (*crypto* #f)
276        (*hash* #f)
277        (*double-check?* #f)
278        (*file-cache* #f)
279        (*global-rules* '()))
280
281    (for-each (lambda (confentry)
282                (match confentry
283                       ('double-check (set! *double-check?* #t))
284                       (('storage command-line)
285                        (set! *storage* (import-storage command-line)))
286                       (('hash . conf) (set! *hash* conf))
287                       (('compression . conf) (set! *compression* conf))
288                       (('encryption . conf) (set! *crypto* conf))
289                       (('file-cache path)
290                        (set! *file-cache* (open-database path))
291                        (change-file-mode path (bitwise-ior perm/irusr perm/iwusr))
292                        (when (null? (schema *file-cache*))
293                              (exec (sql *file-cache* "CREATE TABLE files (path TEXT PRIMARY KEY, mtime INTEGER, size INTEGER, key TEXT);")))
294                        (exec (sql *file-cache* "begin;")))
295                       (('rule . conf) (set! *global-rules* (cons conf *global-rules*)))
296                       (_ (signal (make-property-condition 'exn 'location 'open-archive 'message "Unknown configuration entry" 'arguments (list confentry))))))
297              config)
298
299    (if (not *storage*)
300        (signal (make-property-condition 'exn 'location 'open-archive 'message "No archive storage was specified in the configuration!" 'arguments (list config))))
301
302    (let-values
303        (((compress) (choose-compression-function *compression*))
304         ((hash) (choose-hash-function *hash*))
305         ((encrypt decrypt) (choose-crypto-functions *crypto*)))
306
307      (make-archive
308       *storage*
309       *double-check?*
310       store-atime?
311       store-ctime?
312       hash
313       compress
314       decompress
315       encrypt
316       decrypt
317       *global-rules*
318       ; Snapshot counters
319       0 0 0 0
320       ; File cache
321       *file-cache*
322       (if *file-cache* (sql *file-cache* "SELECT key FROM files WHERE path = ? AND mtime = ? AND size = ?") #f)
323       (if *file-cache* (sql *file-cache* "INSERT OR REPLACE INTO files (path,mtime,size,key) VALUES (?,?,?,?)") #f)
324       0 0 0))))
325
326                                        ; Take a block, and return a compressed and encrypted block
327(define (wrap-block archive block)
328  ((archive-encrypt archive)
329   ((archive-compress archive) block)))
330
331;; Take a compressed and encrypted block, and recover the original data
332(define (unwrap-block archive block)
333  ((archive-decompress archive)
334   ((archive-decrypt archive) block)))
335
336(define (archive-max-block-size archive)
337  (storage-max-block-size (archive-storage archive)))
338
339(define (archive-writable? archive)
340  (storage-writable? (archive-storage archive)))
341
342(define (archive-unlinkable? archive)
343  (storage-unlinkable? (archive-storage archive)))
344
345(define (check-archive-writable archive)
346  (if (not (archive-writable? archive))
347      (signal (make-property-condition 'exn 'location 'check-archive-writable 'message "This isn't a writable archive"))))
348
349(define (check-archive-unlinkable archive)
350  (if (not (archive-writable? archive))
351      (signal (make-property-condition 'exn 'location 'check-archive-unlinkable 'message "This isn't an unlinkable archive - it's append-only"))))
352
353(define (archive-log-reuse! archive data)
354  (inc! (archive-snapshot-blocks-skipped archive))
355  (inc! (archive-snapshot-bytes-skipped archive) (u8vector-length data)))
356
357(define (archive-put! archive key data type)
358  (when (not (archive-writable? archive))
359      (signal (make-property-condition 'exn 'location 'archive-put! 'message "This isn't a writable archive")))
360  ((storage-put! (archive-storage archive)) key (wrap-block archive data) type)
361  (inc! (archive-snapshot-blocks-stored archive))
362  (inc! (archive-snapshot-bytes-stored archive) (u8vector-length data))
363  (void))
364
365(define (archive-flush! archive)
366  ((storage-flush! (archive-storage archive))) ; Flush the storage first, to ensure crash safety
367  (when (archive-file-cache archive)
368        (exec (sql (archive-file-cache archive) "commit;"))
369        (exec (sql (archive-file-cache archive) "begin;"))
370        (set! (archive-file-cache-updates-uncommitted archive) 0)))
371
372(define (archive-exists? archive key)
373  ((storage-exists? (archive-storage archive)) key))
374
375(define (archive-get archive key) ;; FIXME: Avoid fetching type. Pass in expected type from caller?
376  (let ((data (unwrap-block archive ((storage-get (archive-storage archive)) key))))
377    (assert (string=? key ((archive-hash archive) data (archive-exists? archive key)))
378            (sprintf "CONSISTENCY CHECK FAILURE: Block ~A comes back with hash ~A\n" key ((archive-hash archive) data (archive-exists? archive key))))
379    data))
380
381(define (archive-link! archive key)
382  (if (not (archive-writable? archive))
383      (signal (make-property-condition 'exn 'location 'archive-link! 'message "This isn't a writable archive")))
384  ((storage-link! (archive-storage archive)) key))
385
386(define (archive-unlink! archive key)
387  (if (not (archive-writable? archive))
388      (signal (make-property-condition 'exn 'location 'archive-link! 'message "This isn't an unlinkable archive - it's append-only")))
389  (let ((result ((storage-unlink! (archive-storage archive)) key)))
390    (if result
391        (unwrap-block archive result)
392        #f)))
393
394(define (archive-set-tag! archive tag key)
395  (if (not (archive-writable? archive))
396      (signal (make-property-condition 'exn 'location 'archive-set-tag! 'message "This isn't a writable archive")))
397  ((storage-set-tag! (archive-storage archive)) tag key))
398
399(define (archive-tag archive tag)
400  ((storage-tag (archive-storage archive)) tag))
401
402(define (archive-all-tags archive)
403  ((storage-all-tags (archive-storage archive))))
404
405(define (archive-remove-tag! archive tag)
406  (if (not (archive-writable? archive))
407      (signal (make-property-condition 'exn 'location 'archive-remove-tag! 'message "This isn't a writable archive")))
408  ((storage-remove-tag! (archive-storage archive)) tag))
409
410(define (archive-lock-tag! archive tag)
411  (if (not (archive-writable? archive))
412      (signal (make-property-condition 'exn 'location 'archive-lock-tag! 'message "This isn't a writable archive")))
413  ((storage-lock-tag! (archive-storage archive)) tag))
414
415(define (archive-tag-locked? archive tag)
416  (if (not (archive-writable? archive))
417      #f)
418  ((storage-tag-locked? (archive-storage archive)) tag))
419
420(define (archive-unlock-tag! archive tag)
421  (if (not (archive-writable? archive))
422      (signal (make-property-condition 'exn 'location 'archive-unlock-tag! 'message "This isn't a writable archive")))
423  ((storage-unlock-tag! (archive-storage archive)) tag))
424
425(define (archive-close! archive)
426  ((storage-close! (archive-storage archive))) ;; This flushes the backend before we flush the file cache, for crash safety
427  (when (archive-file-cache archive)
428        (exec (sql (archive-file-cache archive) "commit;"))
429        (close-database (archive-file-cache archive)))
430  (void))
431
432;;
433;; CORE ALGORITHMS
434;;
435
436;; Philosophy: insertion routines
437
438;; Insertion routines insert an object into the archive, correctly
439;; managing reference counts.  In order to do this, they all return
440;; two values: the key the object went in under, and a boolean flag
441;; that is true if the object was already in the archive.  This is so
442;; that a parent object that calls that function can construct its
443;; data block from the supplied child keys, then do an exists? check
444;; to see if it already exists in the archive itself, if all of its
445;; children were already in the archive.  If it was, then it in turn
446;; can just return the key and #t But if not, then it can link! every
447;; child that WAS already in the archive, and then put! its own value
448;; into the archive and return that with #f Thus, the reference counts
449;; are maintained correctly.
450
451(define (reusing hash)
452                                        ;   (printf "REUSING: ~A\n" hash)
453  hash)
454
455(define (virgin hash)
456                                        ;   (printf "CREATED: ~A\n" hash)
457  hash)
458
459;; BLOCKS OF RAW DATA THAT CANNOT CONTAIN CHILD KEYS
460;; We never have any child keys to link!, so the not-reused case is simple.
461(define (archive-store-block! archive data type)
462  (check-archive-writable archive)
463
464  (let ((hash ((archive-hash archive) data type)))
465
466    (if (archive-exists? archive hash)
467        (begin
468          (archive-log-reuse! archive data)
469          (values (reusing hash) #t))
470        (begin
471          (archive-put! archive hash data type)
472          (values (virgin hash) #f)))))
473
474;; GENERIC STREAMS OF KEYS
475;; Both file and directory storage involve storing an arbitrary list of keys, in order
476;; to string together a load of data blocks into one.
477;; If they all fit into one block, then so be it. Otherwise, we have to split them
478;; into blocks then create a higher-level stream of keys to store the keys of those blocks...
479
480(define-record key-stream-writer
481  write! ;; Write a single string key to the stream. Accepts the key, and the already-existed boolean for proper reference counting.
482  finish!) ;; Terminate the stream. Returns two values: key of the stream, and an already-existed boolean.
483
484(define (copy-string-into-place! u8v offset string string-offs string-len)
485  (move-memory! string u8v (- string-len string-offs) string-offs offset)
486  (void))
487
488(define (serialise-strings! u8v offset strings)
489  (if (null? strings)
490      (void)
491      (begin
492        (let* ((string (blob->u8vector/shared (string->blob (string-append (car strings) "\n"))))
493               (string-len (u8vector-length string)))
494          (copy-string-into-place! u8v (- offset string-len) string 0 string-len)
495          (serialise-strings! u8v (- offset string-len) (cdr strings))))))
496
497(define (make-key-stream-writer* archive type)
498  (check-archive-writable archive)
499
500  (let* ((*key-buffer* '())
501         (*key-buffer-bytes* 0)
502         (*key-buffer-reused?* #t)
503         (*parent-stream* #f)
504
505         (next-write-will-overflow? (lambda (key)
506                                      (assert (< (string-length key) (archive-max-block-size archive)))
507                                      (> (+ *key-buffer-bytes* (string-length key) 1) (archive-max-block-size archive))))
508
509         (flush! (lambda ()
510                   (let ((keys-serialised (make-u8vector *key-buffer-bytes*)))
511                     (serialise-strings! keys-serialised *key-buffer-bytes* (map car *key-buffer*))
512
513                     (let ((hash ((archive-hash archive) keys-serialised type)))
514
515                       (if (and *key-buffer-reused?* (archive-exists? archive hash))
516                           (begin
517                             (set! *key-buffer* '())
518                             (set! *key-buffer-bytes* 0)
519                             (set! *key-buffer-reused?* #t)
520                             (archive-log-reuse! archive keys-serialised)
521                             (values (reusing hash) #t)) ; We, too, are reused
522                           (begin ; We are unique and new and precious!
523                             (for-each (lambda (x) ; link! all reused children
524                                         (let ((key (car x))
525                                               (reused? (cdr x)))
526                                           (if reused?
527                                               (archive-link! archive key))))
528                                       *key-buffer*)
529
530                             (archive-put! archive hash keys-serialised type)
531
532                             (set! *key-buffer* '())
533                             (set! *key-buffer-bytes* 0)
534                             (set! *key-buffer-reused?* #t)
535
536                             (values (virgin hash) #f)))))))
537
538         (write! (lambda (key reused?)
539                   (if (next-write-will-overflow? key)
540                       (let-values (((flush-key flush-reused?) (flush!)))
541                         (if (not *parent-stream*)
542                             (set! *parent-stream* (make-key-stream-writer* archive type)))
543                         ((key-stream-writer-write! *parent-stream*) flush-key flush-reused?)))
544
545                   ;; What happens if the same key comes up twice, eh?
546                   (set! *key-buffer* (cons (cons key reused?) *key-buffer*))
547                   (set! *key-buffer-reused?* (and *key-buffer-reused?* reused?))
548                   (set! *key-buffer-bytes* (+ *key-buffer-bytes* (string-length key) 1))
549                   (void)))
550
551         (finish! (lambda ()
552                    (cond
553                     (*parent-stream*
554                      (begin
555                        (if (not (null? *key-buffer*))
556                            (let-values (((flush-key flush-reused?) (flush!)))
557                              ((key-stream-writer-write! *parent-stream*) flush-key flush-reused?)))
558                        ((key-stream-writer-finish! *parent-stream*))))
559                     ((null? *key-buffer*) ; Empty stream
560                      (archive-store-block! archive (make-u8vector 0) type))
561                     ((null? (cdr *key-buffer*)) ; Single-element stream
562                      (values (caar *key-buffer*) (cdar *key-buffer*))) ; Just return the one element!
563                     (else ; More than one key, but not enough to have flushed before
564                      (flush!))))))
565
566    (make-key-stream-writer
567     write!
568     finish!)))
569
570(define (deserialise-key-stream block) ; Convert a key stream block to a list of key strings
571  (string-split (blob->string (u8vector->blob/shared block)) "\n"))
572
573;; kons is called on (key type accumulator) for every key in the stream, in order
574(define (fold-key-stream archive key ks-type kons knil)
575  (let ((type (archive-exists? archive key)))
576    (if (eq? ks-type type)
577                                        ; Recurse
578        (begin
579          (let ((subkeys (deserialise-key-stream (archive-get archive key))))
580            (fold
581             (lambda (subkey acc) (fold-key-stream archive subkey ks-type kons acc))
582             knil
583             subkeys)))
584                                        ; Leaf node
585        (kons key type knil))))
586
587                                        ; (child-unlink! archive key type) is called on every child key of a deleted block
588(define (unlink-key-stream! archive key type child-unlink!)
589  (check-archive-unlinkable archive)
590
591  (let ((result (archive-unlink! archive key)))
592    (if result ; result is now list of keys, \n separated, to recursively unlink
593        (for-each (lambda (subkey)
594                    (let ((child-type (archive-exists? archive subkey)))
595                      (if child-type ; The child may not actually exist any more, in which case, job done!
596                          (if (eq? child-type type)
597                              (unlink-key-stream! archive subkey type child-unlink!)
598                              (child-unlink! archive subkey child-type)))))
599                  (deserialise-key-stream result)))))
600
601;; FILE STORAGE
602;; Files are stored as either:
603;; 1) A direct block of type "f" containing the file data
604;; 2) An indirect block of type "fi" that's a keystream of keys of direct or indirect blocks
605
606;; Uses standard input port for the file data
607;; Returns key and reused?
608;; FIXME: Needs much refactoring, the file cache was hacked in willy-nilly.
609(define (store-file! archive file-path file-stat)
610  (let* ((store-file-without-caching!
611          (lambda ()
612            ;; Actually upload the file
613            ;; FIXME: memory-map the file in 1MB chunks, and copy them into u8vectors?
614            (letrec ((blocksize (archive-max-block-size archive))
615                     (*buffer* (make-u8vector blocksize))
616                     (ksw (make-key-stream-writer* archive 'fi))
617                     (upload-file (lambda ()
618                                    (let ((bytes-read (read-u8vector! blocksize *buffer*)))
619                                      (if (not (zero? bytes-read))
620                                          (let-values (((data-key data-reused?)
621                                                        (archive-store-block! archive (subu8vector *buffer* 0 bytes-read) 'f)))
622                                            ((key-stream-writer-write! ksw) data-key data-reused?)
623                                            (upload-file))
624                                          ((key-stream-writer-finish! ksw)))))))
625              (upload-file))))
626         (store-file-and-cache!
627          (lambda (mtime size)
628            (let-values (((key reused?) (store-file-without-caching!)))
629              (file-cache-put! archive file-path mtime size key)
630              (values key reused?)))))
631
632    (check-archive-writable archive)
633
634    ;; Firstly, if we have an mtime cache, use it to see if the file is already in the archive
635    ;; The cache is keyed on file paths, and the contents are
636    ;; sexprs of the form (mtime hash)
637    (if (archive-file-cache archive)
638        (let* ((mtime (vector-ref file-stat 8)) ; Should have used and-let*
639               (size (vector-ref file-stat 5))
640               (cache-result (file-cache-get archive file-path mtime size)))
641          (if (and cache-result (archive-exists? archive cache-result))
642              (begin
643                (inc! (archive-file-cache-hits archive))
644                (inc! (archive-file-cache-bytes archive) size)
645                (values cache-result #t)) ; Found in cache! Woot!
646              (store-file-and-cache! mtime size))) ; not in cache
647        (store-file-without-caching!)))) ; no mtime cache
648
649;; Call kons on each u8vector block of the file in turn
650;; with an accumulator that starts as knil as a second argument
651(define (fold-file archive key kons knil)
652  (fold-key-stream archive key 'fi
653                   (lambda (key type acc)
654                     (kons (archive-get archive key) acc))
655                   knil))
656
657;; Write the contents of the file to the standard output port
658(define (write-file-contents archive key)
659  (fold-file archive key
660             (lambda (block acc)
661               (begin
662                 (write-u8vector block)
663                 #f))
664             #f))
665
666(define (unlink-file! archive key)
667  (check-archive-unlinkable archive)
668
669  (unlink-key-stream! archive key 'fi (lambda (archive key type)
670                                        (archive-unlink! archive key))))
671
672;; GENERIC STREAMS OF S-EXPRESSIONS
673;; These are to be used to implement directories
674;; But might be useful for other complex structures in future
675
676(define-record sexpr-stream-writer
677  write! ;; Write an sexpr to the stream. Second argument is a list of pairs, one per key mentioned in the sexpr, car is the key and cdr is the reused? flag.
678  finish!) ;; Return the key and reused? flag for the whole thing
679
680;; FIXME: Examine this and make-key-stream-writer*
681;; and try and merge them to use a common string-stream-writer abstraction
682;; if it's worth it. They share a lot, yet also differ a lot.
683(define (make-sexpr-stream-writer* archive type ks-type)
684  (check-archive-writable archive)
685  (let* ((*sexpr-buffer* '()) ; List of strings
686         (*sexpr-buffer-bytes* 0) ; Bytes used so far
687         (*key-buffer* '()) ; List of key-reused? pairs
688         (*key-buffer-reused?* #t) ; All reused in the buffer so far?
689         (*parent-stream* #f) ; Key stream
690
691         (flush! (lambda ()
692                   (let ((serialised-buffer (make-u8vector *sexpr-buffer-bytes*)))
693                     (begin
694                       (serialise-strings! serialised-buffer *sexpr-buffer-bytes* *sexpr-buffer*)
695                       (let ((hash ((archive-hash archive) serialised-buffer type)))
696                         (begin
697
698                           (if (archive-check-correctness? archive)
699                               (if *key-buffer-reused?*
700                                   (assert (every cdr *key-buffer*) "Key buffer thinks it's all reused, but it isn't:" *key-buffer*)
701                                        ; else
702                                   (assert (not (every cdr *key-buffer*)) "Key buffer thinks it's not all reused, but it is:" *key-buffer*)))
703
704                           (if (and *key-buffer-reused?* (archive-exists? archive hash))
705                               (begin
706                                 (set! *sexpr-buffer* '())
707                                 (set! *sexpr-buffer-bytes* 0)
708                                 (set! *key-buffer* '())
709                                 (set! *key-buffer-reused?* #t)
710                                 (archive-log-reuse! archive serialised-buffer)
711                                 (values (reusing hash) #t)) ; We, too, are reused
712                               (begin ; We are unique and new and precious!
713                                 (for-each (lambda (x) ; link! all reused children
714                                             (let ((key (car x))
715                                                   (reused? (cdr x)))
716                                               (if reused?
717                                                   (archive-link! archive key))))
718                                           *key-buffer*)
719
720                                 (archive-put! archive hash serialised-buffer type)
721
722                                 (set! *sexpr-buffer* '())
723                                 (set! *sexpr-buffer-bytes* 0)
724                                 (set! *key-buffer* '())
725                                 (set! *key-buffer-reused?* #t)
726
727                                 (values (virgin hash) #f)))))))))
728
729         (write! (lambda (sexpr keys)
730                   (let* ((sexpr-string
731                           (with-output-to-string (lambda ()
732                                                    (write sexpr))))
733                          (sexpr-len (string-length sexpr-string)))
734
735                     (assert (< sexpr-len (archive-max-block-size archive)))
736
737                     (if (> (+ *sexpr-buffer-bytes* sexpr-len 1) (archive-max-block-size archive))
738                         (let-values (((flush-key flush-reused?) (flush!)))
739                           (if (not *parent-stream*)
740                               (set! *parent-stream* (make-key-stream-writer* archive ks-type)))
741                           ((key-stream-writer-write! *parent-stream*) flush-key flush-reused?)))
742
743                     (set! *sexpr-buffer* (cons sexpr-string *sexpr-buffer*))
744                     (set! *key-buffer* (append keys *key-buffer*))
745                     (set! *key-buffer-reused?* (and *key-buffer-reused?* (every cdr keys)))
746                     (set! *sexpr-buffer-bytes* (+ *sexpr-buffer-bytes* sexpr-len 1))
747                     (void))))
748
749         (finish! (lambda ()
750                    (cond
751                     (*parent-stream*
752                      (begin
753                        (if (not (null? *sexpr-buffer*))
754                            (let-values (((flush-key flush-reused?) (flush!)))
755                              ((key-stream-writer-write! *parent-stream*) flush-key flush-reused?)))
756                        ((key-stream-writer-finish! *parent-stream*))))
757                     ((null? *sexpr-buffer*) ; Empty stream
758                      (archive-store-block! archive (make-u8vector 0) type))
759                     (else ; Some sexprs, but not enough to have flushed before
760                      (flush!))))))
761
762    (make-sexpr-stream-writer write! finish!)))
763
764(define (deserialise-sexpr-stream block) ; Convert a sexpr stream block to a list of sexprs
765  (map
766   (lambda (string)
767     (with-input-from-string string read))
768   (string-split (blob->string (u8vector->blob/shared block)) "\n")))
769
770(define (fold-sexpr-stream archive key leaf-type ks-type kons knil)
771  (fold-key-stream archive key ks-type
772                   (lambda (key found-leaf-type acc)
773                     (assert (eq? found-leaf-type leaf-type))
774                     (let ((sexprs (deserialise-sexpr-stream (archive-get archive key))))
775                       (fold
776                        kons
777                        acc
778                        sexprs)))
779                   knil))
780
781(define (unlink-sexpr-stream-block! archive key sexpr-unlink!)
782  (let ((result (archive-unlink! archive key)))
783    (if result
784        (for-each sexpr-unlink! (deserialise-sexpr-stream result)))))
785
786(define (unlink-sexpr-stream! archive key leaf-type ks-type sexpr-unlink!)
787  (check-archive-unlinkable archive)
788  (let ((type (archive-exists? archive key)))
789    (cond
790     ((eq? type ks-type)
791      (unlink-key-stream! archive key ks-type
792                          (lambda (archive leaf-key found-leaf-type)
793                            (assert (eq? found-leaf-type leaf-type))
794                            (unlink-sexpr-stream-block! archive leaf-key sexpr-unlink!))))
795     ((eq? type leaf-type)
796      (unlink-sexpr-stream-block! archive key sexpr-unlink!))
797     (else
798      (assert (or (eq? type leaf-type) (eq? type ks-type)) (sprintf "unlink-sexpr-stream!: Invalid block type (expected ~a)" (list leaf-type ks-type)) type)))))
799
800;; DIRECTORY STORAGE
801;; Directories are stored as either;
802;; 1) A direct block of type "d" containing a list of file/directory entries, each of which is an s-expr
803;;    The car of the s-expr is the file name
804;;    The cadr is a type symbol - file, dir, symlink, chardev, blockdev, fifo, socket
805;;    The cddr is an alist of other properties
806;;    Regular files have a 'content entry containing a key, for example.
807;;    Also look out for 'mode 'uid 'gid 'atime 'mtime 'ctime
808;;    Symlinks have 'target
809;;    Directories have 'content, too
810;;    Files with streams or forks or whatnot can have more than one content key, of course...
811;; 2) An indirect block of type "di" that's a keystream of keys to direct or indirect blocks
812
813;; Look for a .ugarit file in the given directory
814;; If one is found, return its contents
815(define (read-local-rules archive path)
816  (let ((conf-file (make-pathname path ".ugarit")))
817    (if (file-exists? conf-file)
818        (with-input-from-file conf-file read-file)
819        '())))
820
821;; Do the rules list say to ignore the file?
822;; Statements towards the head of the list take priority
823;; And we want to accept the most recent 'ignore' or 'include',
824;; defaulting to 'include' if neither is found
825(define (rules-say-ignore rules)
826  (match rules
827         ('() #f)
828         ((('exclude) . _) #t)
829         ((('include) . _) #f)
830         ((_ . more) (rules-say-ignore more))))
831
832;; Store a directory
833;; Returns the usual key and reused? values
834(define (store-directory! archive path)
835  (call-with-context
836   (read-local-rules archive path)
837   path
838   (lambda ()
839     (check-archive-writable archive)
840
841     (let ((ssw (make-sexpr-stream-writer* archive 'd 'di))
842           (rules-checker (make-filesystem-object-pattern-checker path)))
843
844       (for-each (lambda (filename)
845                   (handle-exceptions exn
846                                      (printf "ERROR: Could not store ~a into the archive, skipping it...\n" (make-pathname path filename))
847                                      (let* ((file-path (make-pathname path filename))
848                                             (stats (file-stat file-path #t))
849                                             (mode (bitwise-and (vector-ref stats 1) (bitwise-not stat/ifmt)))
850                                             (uid (vector-ref stats 3))
851                                             (gid (vector-ref stats 4))
852                                             (atime (vector-ref stats 6))
853                                             (ctime (vector-ref stats 7))
854                                             (mtime (vector-ref stats 8))
855                                             (type (bitwise-and (vector-ref stats 1) stat/ifmt))
856                                             (standard-file-attributes
857                                              (list (cons 'mode mode) (cons 'uid uid) (cons 'gid gid) (cons 'mtime mtime)))
858                                             (file-rules
859                                              (object-matches filename rules-checker)))
860                                        (if (archive-store-ctime? archive)
861                                            (set! standard-file-attributes (cons (cons 'ctime ctime) standard-file-attributes)))
862                                        (if (archive-store-atime? archive)
863                                            (set! standard-file-attributes (cons (cons 'atime atime) standard-file-attributes)))
864                                        (if (not (rules-say-ignore file-rules))
865                                            (cond
866                                             ((eq? type stat/ifsock)
867                                              (printf "WARNING: ~A is a socket, ignoring...\n" file-path))
868                                             ((eq? type stat/ifreg)
869                                              (let-values (((content-key content-reused?) (with-input-from-file file-path (lambda () (store-file! archive file-path stats)))))
870                                                ((sexpr-stream-writer-write! ssw)
871                                                 (append (list filename 'file (cons 'contents content-key) (cons 'size (vector-ref stats 5))) standard-file-attributes)
872                                                 (list (cons content-key content-reused?)))))
873                                             ((eq? type stat/ifdir)
874                                              (let-values (((content-key content-reused?) (store-directory! archive file-path)))
875                                                ((sexpr-stream-writer-write! ssw)
876                                                 (append (list filename 'dir (cons 'contents content-key)) standard-file-attributes)
877                                                 (list (cons content-key content-reused?)))))
878                                             ((eq? type stat/iflnk)
879                                              ((sexpr-stream-writer-write! ssw)
880                                               (append (list filename 'symlink (cons 'target (read-symbolic-link file-path))) standard-file-attributes)
881                                               '()))
882                                             ((eq? type stat/ifblk)
883                                              (let ((devnum (vector-ref stats 10)))
884                                                ((sexpr-stream-writer-write! ssw)
885                                                 (append (list filename 'block-device (cons 'number devnum)) standard-file-attributes)
886                                                 '())))
887                                             ((eq? type stat/ifchr)
888                                              (let ((devnum (vector-ref stats 10)))
889                                                ((sexpr-stream-writer-write! ssw)
890                                                 (append (list filename 'character-device (cons 'number devnum)) standard-file-attributes)
891                                                 '())))
892                                             ((eq? type stat/ififo)
893                                              ((sexpr-stream-writer-write! ssw)
894                                               (append (list filename 'fifo) standard-file-attributes)
895                                               '()))
896                                             (else
897                                        ; WTF?
898                                              (printf "ERROR: I can't ascertain the type of ~A. Skipping it...\n" file-path)))))))
899                 (sort! (directory path #t) string>?))
900
901       ((sexpr-stream-writer-finish! ssw))))))
902
903(define (unlink-directory! archive key)
904  (check-archive-unlinkable archive)
905
906  (unlink-sexpr-stream! archive key 'd 'di
907                        (lambda (dirent)
908                          (let ((type (cadr dirent))
909                                (name (car dirent))
910                                (props (cddr dirent)))
911                            (cond
912                             ((eq? type 'file)
913                              (unlink-file! archive (cdr (assq 'contents props))))
914                             ((eq? type 'dir)
915                              (unlink-directory! archive (cdr (assq 'contents props)))))))))
916
917(define (set-standard-file-metadata! path props)
918  (let ((mode (assq 'mode props))
919        (uid (assq 'uid props))
920        (gid (assq 'gid props))
921        (mtime (assq 'mtime props))
922        (atime (assq 'atime props)))
923
924    (if mode
925        (change-file-mode path (cdr mode)))
926
927    (if (or uid gid)
928        (handle-exceptions exn
929                           (printf "WARNING: It was not possible to set the uid/gid of ~a\n" path)
930         (change-file-owner path
931                            (if uid (cdr uid) (current-user-id))
932                            (if gid (cdr gid) (current-group-id)))))
933
934    (if (or mtime atime)
935        (change-file-times path
936                           (if atime (cdr atime) (current-seconds))
937                           (if mtime (cdr mtime) (current-seconds))))
938
939    (void)))
940
941(define (extract-file! archive props path)
942  (let ((contents-key (cdr (assq 'contents props))))
943    (with-output-to-file path
944      (lambda ()
945        (write-file-contents archive contents-key)))
946    (set-standard-file-metadata! path props)))
947
948(define (extract-subdirectory! archive props path)
949  (if (not (directory? path))
950      (create-directory path))
951
952  (let ((contents-key (cdr (assq 'contents props))))
953
954    (extract-directory! archive contents-key path)
955
956    (set-standard-file-metadata! path props)))
957
958(define (extract-symlink! archive props path)
959  (let ((target (cdr (assq 'target props)))
960        (mode (assq 'mode props))
961        (uid (assq 'uid props))
962        (gid (assq 'gid props))
963        (mtime (assq 'mtime props))
964        (atime (assq 'atime props)))
965
966    (create-symbolic-link target path)
967    ;; Alas, there is no portable way to set the atime/mtime on a link.
968    ;; I think, somehow, we will manage to live our lives without the atime and mtime on links...
969    (if mode
970        (change-link-mode path (cdr mode)))
971
972    (if (or uid gid)
973        (handle-exceptions exn
974                           (printf "WARNING: It was not possible to set the uid/gid of ~a\n" path)
975         (change-link-owner path
976                            (if uid (cdr uid) (current-user-id))
977                            (if gid (cdr gid) (current-group-id)))))))
978
979(define (extract-fifo! archive props path)
980
981  (create-fifo path)
982
983  (set-standard-file-metadata! path props))
984
985(define (extract-block-device! archive props path)
986  (let ((number (cdr (assq 'number props))))
987
988    (handle-exceptions exn
989                       (printf "WARNING: It was not possible to recreate block device ~a\n" path)
990
991     (create-special-file path stat/ifblk number)
992     (set-standard-file-metadata! path props))))
993
994(define (extract-character-device! archive props path)
995  (let ((number (cdr (assq 'number props))))
996
997    (handle-exceptions exn
998                       (printf "WARNING: It was not possible to recreate character device ~a\n" path)
999
1000     (create-special-file path stat/ifchr number)
1001     (set-standard-file-metadata! path props))))
1002
1003(define (extract-object! archive dirent target-path)
1004  (let ((type (cadr dirent))
1005        (name (car dirent))
1006        (props (cddr dirent)))
1007    (cond
1008     ((eq? type 'file)
1009      (extract-file! archive props (make-pathname target-path name)))
1010     ((eq? type 'dir)
1011      (extract-subdirectory! archive props (make-pathname target-path name)))
1012     ((eq? type 'symlink)
1013      (extract-symlink! archive props (make-pathname target-path name)))
1014     ((eq? type 'fifo)
1015      (extract-fifo! archive props (make-pathname target-path name)))
1016     ((eq? type 'block-device)
1017      (extract-block-device! archive props (make-pathname target-path name)))
1018     ((eq? type 'character-device)
1019      (extract-character-device! archive props (make-pathname target-path name)))
1020     (else
1021      (printf "ERROR: Found an object (~A) of unknown type (~A), skipping...\n" name type)))))
1022
1023(define (extract-directory! archive key target-path)
1024  (fold-sexpr-stream archive key 'd 'di
1025                     (lambda (dirent acc)
1026                       (extract-object! archive dirent target-path)
1027                       (void))
1028                     '()))
1029
1030;; SINGLE SEXPRS
1031;; A sexpr in a block. Simple, really.
1032;; Given an sexpr, a type and a list of (key . reused?) pairs, returns a key and a reused? flag.
1033(define (store-sexpr! archive sexpr type keys)
1034  (let* ((data (blob->u8vector/shared (string->blob (with-output-to-string (lambda () (write sexpr))))))
1035         (hash ((archive-hash archive) data type)))
1036
1037    (if (archive-exists? archive hash)
1038        (begin
1039          (archive-log-reuse! archive data)
1040          (values (reusing hash) #t))
1041        (begin
1042          (for-each (lambda (key)
1043                      (if (cdr key) ; reused?
1044                          (archive-link! archive (car key))))
1045                    keys)
1046          (archive-put! archive hash data type)
1047          (values (virgin hash) #f)))))
1048
1049(define (read-sexpr archive key)
1050  (let ((data (archive-get archive key)))
1051    (with-input-from-string
1052        (blob->string (u8vector->blob/shared data))
1053      (lambda ()
1054        (read)))))
1055
1056;; SNAPSHOT STORAGE
1057;; A snapshot is a single block containing an alist
1058;; Keys are 'ctime (in seconds since the epoch),
1059;; 'contents (hash of root directory),
1060;; 'hostname (name of host snapshotted)
1061;; 'prefix (prefix of filesystem on host)
1062;; 'notes (user-supplied notes)
1063;; 'previous (hash of previous snapshot)
1064;; 'stats (alist of stats:
1065;;         'blocks-stored
1066;;         'bytes-stored
1067;;         'blocks-skipped
1068;;         'bytes-skipped
1069;;         'file-cache-hits
1070;;         'file-cache-bytes
1071;; Returns the snapshot's key.
1072(define (tag-snapshot! archive tag contents-key contents-reused? snapshot-properties)
1073  (check-archive-writable archive)
1074  (archive-lock-tag! archive tag)
1075  (let* ((previous (archive-tag archive tag))
1076         (stats (list
1077                 (cons 'blocks-stored (archive-snapshot-blocks-stored archive))
1078                 (cons 'bytes-stored (archive-snapshot-bytes-stored archive))
1079                 (cons 'blocks-skipped (archive-snapshot-blocks-skipped archive))
1080                 (cons 'bytes-skipped (archive-snapshot-bytes-skipped archive))
1081                 (cons 'file-cache-hits (archive-file-cache-hits archive))
1082                 (cons 'file-cache-bytes (archive-file-cache-bytes archive))))
1083         (snapshot
1084          (append
1085           (list
1086            (cons 'mtime (current-seconds))
1087            (cons 'contents contents-key)
1088            (cons 'stats stats))
1089           snapshot-properties))
1090         (keys
1091          (list ; We do not list the previous snapshot - since we are about to overwrite the tag that points to it, which would be a decrement.
1092           (cons contents-key contents-reused?))))
1093    (if previous
1094        (begin
1095          (set! snapshot (cons
1096                          (cons 'previous previous)
1097                          snapshot))))
1098    (let-values (((snapshot-key snapshot-reused?)
1099                  (store-sexpr! archive snapshot 'snapshot keys)))
1100      (archive-flush! archive) ; After this point we can be sure that the snapshot and all blocks it refers to are stably stored
1101      (archive-set-tag! archive tag snapshot-key) ; Therefore, we can be confident in saving it in a tag.
1102      (archive-unlock-tag! archive tag)
1103      snapshot-key)))
1104
1105(define (fold-history archive snapshot-key kons knil)
1106  (let ((snapshot (read-sexpr archive snapshot-key)))
1107    (if (assq 'previous snapshot)
1108        (kons snapshot-key snapshot
1109              (fold-history archive (cdr (assq 'previous snapshot)) kons knil))
1110        (kons snapshot-key snapshot knil))))
1111
1112;; BRING IT ALL TOGETHER
1113
1114(define (snapshot-directory-tree! archive tag path props)
1115  (check-archive-writable archive)
1116  (let-values (((root-key root-reused?)
1117                (call-with-context-support
1118                 (archive-global-directory-rules archive)
1119                 (lambda () (store-directory! archive path)))))
1120    (tag-snapshot! archive tag root-key root-reused?
1121                   (append
1122                    (list
1123                     (cons 'hostname (get-host-name))
1124                     (cons 'prefix path))
1125                    props))))
1126
1127(define (epochtime->string e)
1128  (let ((localtime (seconds->local-time e)))
1129    (string-append
1130     (string-pad (number->string (+ 1900 (vector-ref localtime 5))) 4 #\0)
1131     "-"
1132     (string-pad (number->string (+ 1 (vector-ref localtime 4))) 2 #\0)
1133     "-"
1134     (string-pad (number->string (vector-ref localtime 3)) 2 #\0)
1135     " "
1136     (string-pad (number->string (vector-ref localtime 2)) 2 #\0)
1137     ":"
1138     (string-pad (number->string (vector-ref localtime 1)) 2 #\0)
1139     ":"
1140     (string-pad (number->string (vector-ref localtime 0)) 2 #\0))))
1141
1142
1143                                        ; If given '() as the directory-key, makes a list of all tags
1144                                        ; If given '(tag . "tag-name"), makes a list of snapshots of that tag
1145                                        ; If given a key, if that key points to a directory, makes a list of the contents of that directory
1146                                        ; Either way, the list of results are folded into the provided kons and knil functions
1147                                        ; kons is called with three arguments: a directory-key for the object, a directory entry in the usual format, and the accumulator.
1148(define (fold-archive-node archive directory-key kons knil)
1149  (cond
1150   ((null? directory-key)
1151                                        ; List tags
1152    (fold (lambda (tag acc)
1153            (kons (cons 'tag tag) (list tag 'tag (cons 'current (archive-tag archive tag))) acc))
1154          knil (archive-all-tags archive)))
1155   ((and (pair? directory-key) (eq? (car directory-key) 'tag))
1156                                        ; List a tag's snapshots
1157    (let* ((tag (cdr directory-key))
1158           (current (archive-tag archive tag))
1159           (current-contents (read-sexpr archive current)))
1160      (kons
1161       (cdr (assq 'contents current-contents))
1162       (cons "current" (cons 'snapshot current-contents))
1163       (fold-history archive current
1164                     (lambda (key snapshot acc)
1165                       (kons
1166                        (cdr (assq 'contents snapshot))
1167                        (append
1168                         (list (epochtime->string (cdr (assq 'mtime snapshot)))
1169                               'snapshot)
1170                         snapshot)
1171                        acc))
1172                     knil))))
1173   ((string? directory-key)
1174                                        ; List directory
1175    (fold-sexpr-stream archive directory-key 'd 'di
1176                       (lambda (dirent acc)
1177                         (let ((name (car dirent))
1178                               (type (cadr dirent))
1179                               (props (cddr dirent)))
1180                           (cond
1181                            ((eq? type 'file)
1182                             (kons #f dirent acc))
1183                            ((eq? type 'dir)
1184                             (kons (cdr (assq 'contents props)) dirent acc))
1185                            ((eq? type 'symlink)
1186                             (kons #f dirent acc))
1187                            (else
1188                             (kons #f dirent acc)))))
1189                       knil)))))
1190
Note: See TracBrowser for help on using the repository browser.