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

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

ugarit: Significant README improvements, and enabled consistency check of read blocks by default, and removed warning about deletions from backend-cache.

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