;;; ;;; data.ulid - ULID ;;; ;; This is Gauche-specific port of https://github.com/shirok/scheme-ulid ;; Copyright 2022-2024 by Shiro Kawai ;; Permission is hereby granted, free of charge, to any person obtaining ;; a copy of this software and associated documentation files (the ;; "Software"), to deal in the Software without restriction, including ;; without limitation the rights to use, copy, modify, merge, publish, ;; distribute, sublicense, and/or sell copies of the Software, and to ;; permit persons to whom the Software is furnished to do so, subject to ;; the following conditions: ;; The above copyright notice and this permission notice shall be ;; included in all copies or substantial portions of the Software. ;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, ;; EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF ;; MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND ;; NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE ;; LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION ;; OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION ;; WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. (define-module data.ulid (use gauche.record) (use gauche.uvector) (use scheme.bitwise) (use scheme.vector) (use srfi.13) (use srfi.19) (use srfi.27) (export make-ulid-generator ulid? ulid-timestamp ulid-randomness ulid=? ulidstring ulid->integer ulid->bytevector string->ulid integer->ulid bytevector->ulid)) (select-module data.ulid) (define (milliseconds-from-epoch) (receive (secs usecs) (sys-gettimeofday) (+ (* secs 1000) (quotient usecs 1000)))) (define (wait-a-bit ri) (sys-nanosleep 500000)) (define *randomness-range* (expt 2 80)) (define *digits* (string->vector "0123456789ABCDEFGHJKMNPQRSTVWXYZ")) ;; Ulid record (define-record-type ulid %make-ulid ulid? (timestamp ulid-timestamp) (randomness ulid-randomness)) (define ulid-random-source (rlet1 s (make-random-source) (random-source-randomize! s))) ;; API ;; NB: The ULID spec says ULID generation may fail if randomness is very close ;; to 2^80 and lots of ULIDs are generated in the same millisecond, causing ;; randomness field to overflow. We can, however, wait just one millisecond ;; to overcome that situation. (define (make-ulid-generator :optional (random-source ulid-random-source)) (let ((randomness (random-source-make-integers random-source)) (last-ts 0) (last-rn 0)) (define (make-it ts rn) (set! last-ts ts) (set! last-rn rn) (%make-ulid ts rn)) (^(:optional (timestamp #f)) (let retry () (let ((ts (or timestamp (milliseconds-from-epoch)))) (if (not (= ts last-ts)) (make-it ts (randomness *randomness-range*)) (if (< last-rn (- *randomness-range* 1)) (make-it ts (+ last-rn 1)) (begin (wait-a-bit randomness) (retry))))))))) ;; API (define (ulid=? u1 u2) (assume (ulid? u1)) (assume (ulid? u2)) (and (= (ulid-timestamp u1) (ulid-timestamp u2)) (= (ulid-randomness u1) (ulid-randomness u2)))) ;; API (define (ulidbytevector ulid) (assume (ulid? ulid)) (let ((uv (make-u8vector 16)) (ts (ulid-timestamp ulid)) (rn (ulid-randomness ulid))) (u8vector-set! uv 0 (arithmetic-shift ts -40)) (u8vector-set! uv 1 (bitwise-and (arithmetic-shift ts -32) #xff)) (u8vector-set! uv 2 (bitwise-and (arithmetic-shift ts -24) #xff)) (u8vector-set! uv 3 (bitwise-and (arithmetic-shift ts -16) #xff)) (u8vector-set! uv 4 (bitwise-and (arithmetic-shift ts -8) #xff)) (u8vector-set! uv 5 (bitwise-and ts #xff)) (u8vector-set! uv 6 (arithmetic-shift rn -72)) (u8vector-set! uv 7 (bitwise-and (arithmetic-shift rn -64) #xff)) (u8vector-set! uv 8 (bitwise-and (arithmetic-shift rn -56) #xff)) (u8vector-set! uv 9 (bitwise-and (arithmetic-shift rn -48) #xff)) (u8vector-set! uv 10 (bitwise-and (arithmetic-shift rn -40) #xff)) (u8vector-set! uv 11 (bitwise-and (arithmetic-shift rn -32) #xff)) (u8vector-set! uv 12 (bitwise-and (arithmetic-shift rn -24) #xff)) (u8vector-set! uv 13 (bitwise-and (arithmetic-shift rn -16) #xff)) (u8vector-set! uv 14 (bitwise-and (arithmetic-shift rn -8) #xff)) (u8vector-set! uv 15 (bitwise-and rn #xff)) uv)) ;; API (define (ulid->integer ulid) (+ (arithmetic-shift (ulid-timestamp ulid) 80) (ulid-randomness ulid))) ;; API (define (ulid->string ulid) (do ((i 0 (+ i 1)) (v (ulid->integer ulid) (arithmetic-shift v -5)) (cs '() (cons (vector-ref *digits* (bitwise-and v #x1f)) cs))) ((= i 26) (list->string cs)))) ;; API (define (bytevector->ulid uv) (define (get-uint start size) (do ((i start (+ i 1)) (size size (- size 1)) (v 0 (+ (arithmetic-shift v 8) (u8vector-ref uv i)))) ((zero? size) v))) (assume (and (u8vector? uv) (= (bytevector-length uv) 16))) (%make-ulid (get-uint 0 6) (get-uint 6 10))) ;; API (define (integer->ulid n) (assume (and (exact? n) (positive? n) (< n (expt 2 128)))) (%make-ulid (arithmetic-shift n -80) (bitwise-and n (- (expt 2 80) 1)))) ;; API (define (string->ulid s) (assume (and (string? s) (= (string-length s) 26))) (let ((val (string-fold (lambda (ch n) (let ((d (vector-index (lambda (c) (char-ci=? ch c)) *digits*))) (unless d (error "Invalid character as ULID:" ch)) (+ (arithmetic-shift n 5) d))) 0 s))) (when (>= val (expt 2 128)) (error "ULID string representation out of range:" s)) (integer->ulid val))) ;; Fancier printing, if possible (define-method write-object ((u ulid) port) (format port "#" (ulid->string u)))