1/* Part of SWI-Prolog 2 3 Author: Jan Wielemaker 4 E-mail: J.Wielemaker@vu.nl 5 WWW: http://www.swi-prolog.org 6 Copyright (c) 2012-2024, VU University Amsterdam 7 SWI-Prolog Solutions b.v. 8 All rights reserved. 9 10 Redistribution and use in source and binary forms, with or without 11 modification, are permitted provided that the following conditions 12 are met: 13 14 1. Redistributions of source code must retain the above copyright 15 notice, this list of conditions and the following disclaimer. 16 17 2. Redistributions in binary form must reproduce the above copyright 18 notice, this list of conditions and the following disclaimer in 19 the documentation and/or other materials provided with the 20 distribution. 21 22 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 23 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 24 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 25 FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 26 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 27 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 28 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 29 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 30 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 32 ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 33 POSSIBILITY OF SUCH DAMAGE. 34*/ 35 36:- module(uuid, 37 [ uuid/1, % -UUID 38 uuid/2, % -UUID, +Options 39 is_uuid/1, % @UUID 40 uuid_property/2 % +UUID, ?Property 41 ]). 42:- autoload(library(apply), [maplist/2]). 43:- if(exists_source(library(shlib))). 44:- autoload(library(shlib), [load_foreign_library/1]). 45:- endif.
66link_uuid :- 67 catch(load_foreign_library(foreign(uuid)), error(_,_), true). 68 69:- initialization(link_uuid, now).
uuid(UUID, []). See uuid/2 for options.
76uuid(UUID) :-
77 uuid(UUID, []).atom, yielding atoms
such as 8304efdd-bd6e-5b7c-a27f-83f3f05c64e0. The
alternative is integer, returning a large integer that
represents the 128 bits of the UUID.
If SWI-Prolog was not built with the OSSP UUID dependency library a
simple Prolog alternative that only implements version 4 random
UUIDs is provided. In this case the default version is 4 and the
only admissible options are version(4) and format(Format).
Note that the default version 1 UUIDs contain the time and MAC address and the Prolog fallback uses random/1, which is not a cryptographically secure random generator. UUIDs should not be used as secrets, e.g., session keys.
112:- if(current_predicate(ossp_uuid/2)). 113uuid(UUID, Options) :- 114 ossp_uuid(UUID, Options). 115 116:- else. 117 118uuid(UUID, []) :- 119 !, 120 random_uuid(UUID). 121uuid(UUID, Options) :- 122 option(version(4), Options, 4), 123 option(format(Format), Options, atom), 124 ( Format == atom 125 -> !, random_uuid(UUID) 126 ; Format == integer 127 -> !, random_int_uuid(UUID) 128 ). 129uuid(_UUID, Options) :- 130 domain_error(uuid_options, Options). 131 132random_uuid(UUID) :- 133 Version = 4, 134 A is random(0x100000000), 135 B is random(0x10000), 136 C is random(0x1000) \/ Version<<12, 137 D is random(0x4000) \/ 0x8000, 138 E is random(0x1000000000000), 139 format(atom(UUID), 140 '~`0t~16r~8+-~|\c 141 ~`0t~16r~4+-~|\c 142 ~`0t~16r~4+-~|\c 143 ~`0t~16r~4+-~|\c 144 ~`0t~16r~12+', [A,B,C,D,E]). 145 146random_int_uuid(UUID) :- 147 Version = 4, 148 A is random(0x100000000), 149 B is random(0x10000), 150 C is random(0x1000) \/ Version<<12, 151 D is random(0x4000) \/ 0x8000, 152 E is random(0x1000000000000), 153 UUID is (A<<96)+(B<<80)+(C<<64)+(D<<48)+E. 154 155:- endif.
171uuid_property(UUID, P) :- 172 property_uuid(P, UUID). 173 174property_uuid(version(V), UUID) :- 175 split_string(UUID, "-", "", [_A,_B,C,_D,_E]), 176 sub_string(C, 0, 1, _, F), 177 char_type(F, xdigit(V)). 178property_uuid(time(Time), UUID) :- 179 split_string(UUID, "-", "", [A,B,C,_D,_E]), 180 sub_atom(C, 0, 1, _, F), 181 has_time(F), 182 sub_string(C, 1, _, 0, T), 183 atomics_to_string(["0x",T,B,A], Hex), 184 number_string(Nanos, Hex), 185 Offset is 24*60*60*141427*10 000 000, 186 Time is (Nanos-Offset)/10000000.0. 187 188has_time('1'). 189has_time('2').
- at the right place
and all other characters are hexadecimal.197is_uuid(UUID) :- 198 atom(UUID), 199 atom_length(UUID, 36), 200 atom_codes(UUID, Codes), 201 Codes = [ _,_,_,_,_,_,_,_, 0'-, 202 _,_,_,_, 0'-, 203 _,_,_,_, 0'-, 204 _,_,_,_, 0'-, 205 _,_,_,_,_,_,_,_,_,_,_,_ 206 ], 207 maplist(hex_or_minus, Codes). 208 209hex_or_minus(0'-) :- 210 !. 211hex_or_minus(Code) :- 212 code_type(Code, xdigit(_))
Universally Unique Identifier (UUID) Library
The library provides operations on UUIDs. Please consult other sources for understanding UUIDs and the implications of the different UUID versions. Some typical calls are given below:
?- uuid(X). X = 'ea6589fa-19dd-11e2-8a49-001d92e1879d'. ?- uuid(X, [url('http://www.swi-prolog.org')]). X = '73a07870-6a90-3f2e-ae2b-ffa538dc7c2c'.