/
GUID.pm
360 lines (244 loc) · 8.2 KB
/
GUID.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
use strict;
use warnings;
package Data::GUID;
# ABSTRACT: globally unique identifiers
use Carp ();
use Data::UUID 1.148;
use Sub::Install 0.03;
=head1 SYNOPSIS
use Data::GUID;
my $guid = Data::GUID->new;
my $string = $guid->as_string; # or "$guid"
my $other_guid = Data::GUID->from_string($string);
if (($guid <=> $other_guid) == 0) {
print "They're the same!\n";
}
=head1 DESCRIPTION
Data::GUID provides a simple interface for generating and using globally unique
identifiers.
=head1 GETTING A NEW GUID
=head2 new
my $guid = Data::GUID->new;
This method returns a new globally unique identifier.
=cut
my $_uuid_gen = Data::UUID->new;
sub new {
my ($class) = @_;
return $class->from_data_uuid($_uuid_gen->create);
}
=head1 GUIDS FROM EXISTING VALUES
These method returns a new Data::GUID object for the given GUID value. In all
cases, these methods throw an exception if given invalid input.
=head2 from_string
my $guid = Data::GUID->from_string("B0470602-A64B-11DA-8632-93EBF1C0E05A");
=head2 from_hex
# note that a hex guid is a guid string without hyphens and with a leading 0x
my $guid = Data::GUID->from_hex("0xB0470602A64B11DA863293EBF1C0E05A");
=head2 from_base64
my $guid = Data::GUID->from_base64("sEcGAqZLEdqGMpPr8cDgWg==");
=head2 from_data_uuid
This method returns a new Data::GUID object if given a Data::UUID value.
Because Data::UUID values are not blessed and because Data::UUID provides no
validation method, this method will only throw an exception if the given data
is of the wrong size.
=cut
sub from_data_uuid {
my ($class, $value) = @_;
my $length = do { use bytes; defined $value ? length $value : 0; };
Carp::croak "given value is not a valid Data::UUID value" if $length != 16;
bless \$value => $class;
}
=head1 IDENTIFYING GUIDS
=head2 string_guid_regex
=head2 hex_guid_regex
=head2 base64_guid_regex
These methods return regex objects that match regex strings of the appropriate
type.
=cut
my ($hex, $base64, %type);
BEGIN { # because %type must be populated for method/exporter generation
$hex = qr/[0-9A-F]/i;
$base64 = qr{[A-Z0-9+/=]}i;
%type = ( # uuid_method validation_regex
string => [ 'string', qr/\A$hex{8}-?(?:$hex{4}-?){3}$hex{12}\z/, ],
hex => [ 'hexstring', qr/\A0x$hex{32}\z/, ],
base64 => [ 'b64string', qr/\A$base64{24}\z/, ],
);
for my $key (keys %type) {
no strict 'refs';
my $subname = "$key\_guid_regex";
*$subname = sub { $type{ $key }[1] }
}
}
# provided for test scripts
sub __type_regex { shift; $type{$_[0]}[1] }
sub _install_from_method {
my ($type, $alien_method, $regex) = @_;
my $alien_from_method = "from_$alien_method";
my $our_from_code = sub {
my ($class, $string) = @_;
$string ||= q{}; # to avoid (undef =~) warning
Carp::croak qq{"$string" is not a valid $type GUID} if $string !~ $regex;
$class->from_data_uuid( $_uuid_gen->$alien_from_method($string) );
};
Sub::Install::install_sub({ code => $our_from_code, as => "from_$type" });
}
sub _install_as_method {
my ($type, $alien_method) = @_;
my $alien_to_method = "to_$alien_method";
my $our_to_method = sub {
my ($self) = @_;
$_uuid_gen->$alien_to_method( $self->as_binary );
};
Sub::Install::install_sub({ code => $our_to_method, as => "as_$type" });
}
BEGIN { # possibly unnecessary -- rjbs, 2006-03-11
do {
while (my ($type, $profile) = each %type) {
_install_from_method($type, @$profile);
_install_as_method ($type, @$profile);
}
};
}
sub _from_multitype {
my ($class, $what, $types) = @_;
sub {
my ($class, $value) = @_;
return $value if eval { $value->isa('Data::GUID') };
my $value_string = defined $value ? qq{"$value"} : 'undef';
# The only good ref is a blessed ref, and only into our denomination!
if (my $ref = ref $value) {
Carp::croak "a $ref reference is not a valid GUID $what"
}
for my $type (@$types) {
my $from = "from_$type";
my $guid = eval { $class->$from($value); };
return $guid if $guid;
}
Carp::croak "$value_string is not a valid GUID $what";
}
}
=head2 from_any_string
my $string = get_string_from_ether;
my $guid = Data::GUID->from_any_string($string);
This method returns a Data::GUID object for the given string, trying all known
string interpretations. An exception is thrown if the value is not a valid
GUID string.
=cut
BEGIN { # possibly unnecessary -- rjbs, 2006-03-11
Sub::Install::install_sub({
code => __PACKAGE__->_from_multitype('string', [ keys %type ]),
as => 'from_any_string',
});
}
=head2 best_guess
my $value = get_value_from_ether;
my $guid = Data::GUID->best_guess($value);
This method returns a Data::GUID object for the given value, trying everything
it can. It works like C<L</from_any_string>>, but will also accept Data::UUID
values. (In effect, this means that any sixteen byte value is acceptable.)
=cut
BEGIN { # possibly unnecessary -- rjbs, 2006-03-11
Sub::Install::install_sub({
code => __PACKAGE__->_from_multitype('value', [(keys %type), 'data_uuid']),
as => 'best_guess',
});
}
=head1 GUIDS INTO STRINGS
These methods return various string representations of a GUID.
=head2 as_string
This method returns a "traditional" GUID/UUID string representation. This is
five hexadecimal strings, delimited by hyphens. For example:
B0470602-A64B-11DA-8632-93EBF1C0E05A
This method is also used to stringify Data::GUID objects.
=head2 as_hex
This method returns a plain hexadecimal representation of the GUID, with a
leading C<0x>. For example:
0xB0470602A64B11DA863293EBF1C0E05A
=head2 as_base64
This method returns a base-64 string representation of the GUID. For example:
sEcGAqZLEdqGMpPr8cDgWg==
=cut
=head1 OTHER METHODS
=head2 compare_to_guid
This method compares a GUID to another GUID and returns -1, 0, or 1, as do
other comparison routines.
=cut
sub compare_to_guid {
my ($self, $other) = @_;
my $other_binary
= eval { $other->isa('Data::GUID') } ? $other->as_binary : $other;
$_uuid_gen->compare($self->as_binary, $other_binary);
}
=head2 as_binary
This method returns the packed binary representation of the GUID. At present
this method relies on Data::GUID's underlying use of Data::UUID. It is not
guaranteed to continue to work the same way, or at all. I<Caveat invocator>.
=cut
sub as_binary {
my ($self) = @_;
$$self;
}
use overload
q{""} => 'as_string',
'<=>' => sub { ($_[2] ? -1 : 1) * $_[0]->compare_to_guid($_[1]) },
fallback => 1;
=head1 IMPORTING
Data::GUID does not export any subroutines by default, but it provides a few
routines which will be imported on request. These routines may be called as
class methods, or may be imported to be called as subroutines. Calling them by
fully qualified name is incorrect.
use Data::GUID qw(guid);
my $guid = guid; # OK
my $guid = Data::GUID->guid; # OK
my $guid = Data::GUID::guid; # NOT OK
=cut
=head2 guid
This routine returns a new Data::GUID object.
=head2 guid_string
This returns the string representation of a new GUID.
=head2 guid_hex
This returns the hex representation of a new GUID.
=head2 guid_base64
This returns the base64 representation of a new GUID.
=head2 guid_from_anything
This returns the result of calling the C<L</from_any_string>> method.
=cut
BEGIN {
Sub::Install::install_sub({ code => 'new', as => 'guid' });
for my $type (keys %type) {
my $method = "guid_$type";
my $as = "as_$type";
Sub::Install::install_sub({
as => $method,
code => sub {
my ($class) = @_;
$class->new->$as;
},
});
}
}
sub _curry_class {
my ($class, $subname, $eval) = @_;
return $eval ? sub { eval { $class->$subname(@_) } }
: sub { $class->$subname(@_) };
}
my %exports;
BEGIN {
%exports
= map { my $method = $_; $_ => sub { _curry_class($_[0], $method) } }
((map { "guid_$_" } keys %type), 'guid');
}
use Sub::Exporter 0.90 -setup => {
exports => {
%exports, # defined just above
guid_from_anything => sub { _curry_class($_[0], 'from_any_string', 1) },
}
};
=head1 TODO
=for :list
* add namespace support
* remove dependency on wretched Data::UUID
* make it work on 5.005
=cut
1;