1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
/** |
4
|
|
|
* Linna Framework. |
5
|
|
|
* |
6
|
|
|
* @author Sebastian Rapetti <[email protected]> |
7
|
|
|
* @copyright (c) 2018, Sebastian Rapetti |
8
|
|
|
* @license http://opensource.org/licenses/MIT MIT License |
9
|
|
|
*/ |
10
|
|
|
declare(strict_types=1); |
11
|
|
|
|
12
|
|
|
namespace Linna\DataMapper; |
13
|
|
|
|
14
|
|
|
use InvalidArgumentException; |
15
|
|
|
|
16
|
|
|
/** |
17
|
|
|
* Universally Unique Identifier Version 4 utility. |
18
|
|
|
* https://en.wikipedia.org/wiki/Universally_unique_identifier |
19
|
|
|
* https://tools.ietf.org/html/rfc4122 |
20
|
|
|
* |
21
|
|
|
*/ |
22
|
|
|
class UUID4 |
23
|
|
|
{ |
24
|
|
|
/** |
25
|
|
|
* @var string UUID in hex form. |
26
|
|
|
*/ |
27
|
|
|
private string $hexUUID = ''; |
28
|
|
|
|
29
|
|
|
/** |
30
|
|
|
* @var string UUID in bin form. |
31
|
|
|
*/ |
32
|
|
|
private string $binUUID = ''; |
33
|
|
|
|
34
|
|
|
/** |
35
|
|
|
* Constructor. |
36
|
|
|
*/ |
37
|
9 |
|
public function __construct(string $uuid = '') |
38
|
|
|
{ |
39
|
9 |
|
if (empty($uuid)) { |
40
|
6 |
|
$this->generate(); |
41
|
6 |
|
$this->makeBin(); |
42
|
|
|
|
43
|
6 |
|
return; |
44
|
|
|
} |
45
|
|
|
|
46
|
7 |
|
$this->check($uuid); |
47
|
6 |
|
$this->makeBin(); |
48
|
6 |
|
} |
49
|
|
|
|
50
|
|
|
/** |
51
|
|
|
* Check UUID. |
52
|
|
|
* |
53
|
|
|
* @param string $uuid |
54
|
|
|
* |
55
|
|
|
* @return void |
56
|
|
|
*/ |
57
|
7 |
|
private function check(string $uuid): void |
58
|
|
|
{ |
59
|
7 |
|
$uuid32 = \str_replace('-', '', $uuid); |
60
|
|
|
|
61
|
7 |
|
if (\preg_match('/^[0-9a-f]{8}[0-9a-f]{4}[4][0-9a-f]{3}[89ab][0-9a-f]{3}[0-9a-f]{12}$/i', $uuid32) !== 1) { |
62
|
1 |
|
throw new InvalidArgumentException('Invalid UUID version 4 provided.'); |
63
|
|
|
} |
64
|
|
|
|
65
|
6 |
|
$this->hexUUID = $uuid; |
66
|
6 |
|
} |
67
|
|
|
|
68
|
|
|
/** |
69
|
|
|
* Get UUID in hex format (36 chars). |
70
|
|
|
* |
71
|
|
|
* @return string |
72
|
|
|
*/ |
73
|
6 |
|
public function getHex(): string |
74
|
|
|
{ |
75
|
6 |
|
return $this->hexUUID; |
76
|
|
|
} |
77
|
|
|
|
78
|
|
|
/** |
79
|
|
|
* Get UUID in binary format (16 byte). |
80
|
|
|
* |
81
|
|
|
* @return string |
82
|
|
|
*/ |
83
|
2 |
|
public function getBin(): string |
84
|
|
|
{ |
85
|
2 |
|
return $this->binUUID; |
86
|
|
|
} |
87
|
|
|
|
88
|
|
|
/** |
89
|
|
|
* Return UUID in 16 byte binary format. |
90
|
|
|
* |
91
|
|
|
* @return void |
92
|
|
|
*/ |
93
|
8 |
|
private function makeBin(): void |
94
|
|
|
{ |
95
|
8 |
|
$this->binUUID = \hex2bin(\str_replace('-', '', $this->hexUUID)); |
96
|
8 |
|
} |
97
|
|
|
|
98
|
|
|
/** |
99
|
|
|
* Generate a random UUID v4 in hex format. |
100
|
|
|
* |
101
|
|
|
* @codeCoverageIgnore |
102
|
|
|
* |
103
|
|
|
* @return void |
104
|
|
|
*/ |
105
|
|
|
private function generate(): void |
106
|
|
|
{ |
107
|
|
|
$this->hexUUID = \sprintf( |
108
|
|
|
'%s-%s-%s-%s-%s', |
109
|
|
|
// 8 hex characters |
110
|
|
|
\bin2hex(\random_bytes(4)), |
111
|
|
|
// 4 hex characters |
112
|
|
|
\bin2hex(\random_bytes(2)), |
113
|
|
|
// "4" for the UUID version + 3 hex characters |
114
|
|
|
// 0x4000 is 16384 in int |
115
|
|
|
// 0x4fff is 20479 in int |
116
|
|
|
\dechex(\random_int(16384, 20479)), |
117
|
|
|
// (8, 9, a, or b) for the UUID variant 1 plus 3 hex characters |
118
|
|
|
// 0x8000 is 32768 in int |
119
|
|
|
// 0xbfff is 49151 in int |
120
|
|
|
\dechex(\random_int(32768, 49151)), |
121
|
|
|
// 12 hex characters |
122
|
|
|
\bin2hex(\random_bytes(6)) |
123
|
|
|
); |
124
|
|
|
} |
125
|
|
|
} |
126
|
|
|
|