UuidValidator.php — MailPoet – Newsletters, Email Marketing, and Automation 5.36.0

mailpoet / vendor-prefixed / symfony / validator / Constraints / UuidValidator.php

mailpoet / vendor-prefixed / symfony / validator / Constraints Last commit date

UuidValidator.php

157 lines

1	<?php
2	namespace MailPoetVendor\Symfony\Component\Validator\Constraints;
3	if (!defined('ABSPATH')) exit;
4	use MailPoetVendor\Symfony\Component\Validator\Constraint;
5	use MailPoetVendor\Symfony\Component\Validator\ConstraintValidator;
6	use MailPoetVendor\Symfony\Component\Validator\Exception\UnexpectedTypeException;
7	use MailPoetVendor\Symfony\Component\Validator\Exception\UnexpectedValueException;
8	class UuidValidator extends ConstraintValidator
9	{
10	// The strict pattern matches UUIDs like this:
11	// xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx
12	// Roughly speaking:
13	// x = any hexadecimal character
14	// M = any allowed version {1..6}
15	// N = any allowed variant {8, 9, a, b}
16	public const STRICT_LENGTH = 36;
17	public const STRICT_FIRST_HYPHEN_POSITION = 8;
18	public const STRICT_LAST_HYPHEN_POSITION = 23;
19	public const STRICT_VERSION_POSITION = 14;
20	public const STRICT_VARIANT_POSITION = 19;
21	// The loose pattern validates similar yet non-compliant UUIDs.
22	// Hyphens are completely optional. If present, they should only appear
23	// between every fourth character:
24	// xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx
25	// xxxxxxxxxxxx-xxxx-xxxx-xxxx-xxxx-xxxx
26	// xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
27	// The value can also be wrapped with characters like []{}:
28	// {xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx}
29	// Neither the version nor the variant is validated by this pattern.
30	public const LOOSE_MAX_LENGTH = 39;
31	public const LOOSE_FIRST_HYPHEN_POSITION = 4;
32	public function validate($value, Constraint $constraint)
33	{
34	if (!$constraint instanceof Uuid) {
35	throw new UnexpectedTypeException($constraint, Uuid::class);
36	}
37	if (null === $value \|\| '' === $value) {
38	return;
39	}
40	if (!\is_scalar($value) && !(\is_object($value) && \method_exists($value, '__toString'))) {
41	throw new UnexpectedValueException($value, 'string');
42	}
43	$value = (string) $value;
44	if (null !== $constraint->normalizer) {
45	$value = ($constraint->normalizer)($value);
46	}
47	if ($constraint->strict) {
48	$this->validateStrict($value, $constraint);
49	return;
50	}
51	$this->validateLoose($value, $constraint);
52	}
53	private function validateLoose(string $value, Uuid $constraint)
54	{
55	// Error priority:
56	// 1. ERROR_INVALID_CHARACTERS
57	// 2. ERROR_INVALID_HYPHEN_PLACEMENT
58	// 3. ERROR_TOO_SHORT/ERROR_TOO_LONG
59	// Trim any wrapping characters like [] or {} used by some legacy systems
60	$trimmed = \trim($value, '[]{}');
61	// Position of the next expected hyphen
62	$h = self::LOOSE_FIRST_HYPHEN_POSITION;
63	// Expected length
64	$l = self::LOOSE_MAX_LENGTH;
65	for ($i = 0; $i < $l; ++$i) {
66	// Check length
67	if (!isset($trimmed[$i])) {
68	$this->context->buildViolation($constraint->message)->setParameter('{{ value }}', $this->formatValue($value))->setCode(Uuid::TOO_SHORT_ERROR)->addViolation();
69	return;
70	}
71	// Hyphens must occur every fifth position
72	// xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx
73	// ^ ^ ^ ^ ^ ^ ^
74	if ('-' === $trimmed[$i]) {
75	if ($i !== $h) {
76	$this->context->buildViolation($constraint->message)->setParameter('{{ value }}', $this->formatValue($value))->setCode(Uuid::INVALID_HYPHEN_PLACEMENT_ERROR)->addViolation();
77	return;
78	}
79	$h += 5;
80	continue;
81	}
82	// Missing hyphens are ignored
83	if ($i === $h) {
84	$h += 4;
85	--$l;
86	}
87	// Check characters
88	if (!\ctype_xdigit($trimmed[$i])) {
89	$this->context->buildViolation($constraint->message)->setParameter('{{ value }}', $this->formatValue($value))->setCode(Uuid::INVALID_CHARACTERS_ERROR)->addViolation();
90	return;
91	}
92	}
93	// Check length again
94	if (isset($trimmed[$i])) {
95	$this->context->buildViolation($constraint->message)->setParameter('{{ value }}', $this->formatValue($value))->setCode(Uuid::TOO_LONG_ERROR)->addViolation();
96	}
97	}
98	private function validateStrict(string $value, Uuid $constraint)
99	{
100	// Error priority:
101	// 1. ERROR_INVALID_CHARACTERS
102	// 2. ERROR_INVALID_HYPHEN_PLACEMENT
103	// 3. ERROR_TOO_SHORT/ERROR_TOO_LONG
104	// 4. ERROR_INVALID_VERSION
105	// 5. ERROR_INVALID_VARIANT
106	// Position of the next expected hyphen
107	$h = self::STRICT_FIRST_HYPHEN_POSITION;
108	for ($i = 0; $i < self::STRICT_LENGTH; ++$i) {
109	// Check length
110	if (!isset($value[$i])) {
111	$this->context->buildViolation($constraint->message)->setParameter('{{ value }}', $this->formatValue($value))->setCode(Uuid::TOO_SHORT_ERROR)->addViolation();
112	return;
113	}
114	// Check hyphen placement
115	// xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
116	// ^ ^ ^ ^
117	if ('-' === $value[$i]) {
118	if ($i !== $h) {
119	$this->context->buildViolation($constraint->message)->setParameter('{{ value }}', $this->formatValue($value))->setCode(Uuid::INVALID_HYPHEN_PLACEMENT_ERROR)->addViolation();
120	return;
121	}
122	// xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
123	// ^
124	if ($h < self::STRICT_LAST_HYPHEN_POSITION) {
125	$h += 5;
126	}
127	continue;
128	}
129	// Check characters
130	if (!\ctype_xdigit($value[$i])) {
131	$this->context->buildViolation($constraint->message)->setParameter('{{ value }}', $this->formatValue($value))->setCode(Uuid::INVALID_CHARACTERS_ERROR)->addViolation();
132	return;
133	}
134	// Missing hyphen
135	if ($i === $h) {
136	$this->context->buildViolation($constraint->message)->setParameter('{{ value }}', $this->formatValue($value))->setCode(Uuid::INVALID_HYPHEN_PLACEMENT_ERROR)->addViolation();
137	return;
138	}
139	}
140	// Check length again
141	if (isset($value[$i])) {
142	$this->context->buildViolation($constraint->message)->setParameter('{{ value }}', $this->formatValue($value))->setCode(Uuid::TOO_LONG_ERROR)->addViolation();
143	}
144	// Check version
145	if (!\in_array($value[self::STRICT_VERSION_POSITION], $constraint->versions)) {
146	$this->context->buildViolation($constraint->message)->setParameter('{{ value }}', $this->formatValue($value))->setCode(Uuid::INVALID_VERSION_ERROR)->addViolation();
147	}
148	// Check variant - first two bits must equal "10"
149	// 0b10xx
150	// & 0b1100 (12)
151	// = 0b1000 (8)
152	if (8 !== (\hexdec($value[self::STRICT_VARIANT_POSITION]) & 12)) {
153	$this->context->buildViolation($constraint->message)->setParameter('{{ value }}', $this->formatValue($value))->setCode(Uuid::INVALID_VARIANT_ERROR)->addViolation();
154	}
155	}
156	}
157