Chris@0: Chris@0: * Chris@0: * For the full copyright and license information, please view the LICENSE Chris@0: * file that was distributed with this source code. Chris@0: */ Chris@0: Chris@0: namespace Symfony\Component\Validator\Constraints; Chris@0: Chris@0: use Symfony\Component\Validator\Constraint; Chris@0: use Symfony\Component\Validator\ConstraintValidator; Chris@0: use Symfony\Component\Validator\Exception\UnexpectedTypeException; Chris@0: Chris@0: /** Chris@14: * Validates whether the value is a valid UUID (also known as GUID). Chris@14: * Chris@14: * Strict validation will allow a UUID as specified per RFC 4122. Chris@14: * Loose validation will allow any type of UUID. Chris@14: * Chris@14: * For better compatibility, both loose and strict, you should consider using a specialized UUID library like "ramsey/uuid" instead. Chris@0: * Chris@0: * @author Colin O'Dell Chris@0: * @author Bernhard Schussek Chris@0: * Chris@0: * @see http://tools.ietf.org/html/rfc4122 Chris@0: * @see https://en.wikipedia.org/wiki/Universally_unique_identifier Chris@14: * @see https://github.com/ramsey/uuid Chris@0: */ Chris@0: class UuidValidator extends ConstraintValidator Chris@0: { Chris@0: // The strict pattern matches UUIDs like this: Chris@0: // xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx Chris@0: Chris@0: // Roughly speaking: Chris@0: // x = any hexadecimal character Chris@0: // M = any allowed version {1..5} Chris@0: // N = any allowed variant {8, 9, a, b} Chris@0: Chris@0: const STRICT_LENGTH = 36; Chris@0: const STRICT_FIRST_HYPHEN_POSITION = 8; Chris@0: const STRICT_LAST_HYPHEN_POSITION = 23; Chris@0: const STRICT_VERSION_POSITION = 14; Chris@0: const STRICT_VARIANT_POSITION = 19; Chris@0: Chris@0: // The loose pattern validates similar yet non-compliant UUIDs. Chris@0: // Hyphens are completely optional. If present, they should only appear Chris@0: // between every fourth character: Chris@0: // xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx Chris@0: // xxxxxxxxxxxx-xxxx-xxxx-xxxx-xxxx-xxxx Chris@0: // xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Chris@0: Chris@0: // The value can also be wrapped with characters like []{}: Chris@0: // {xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx} Chris@0: Chris@0: // Neither the version nor the variant is validated by this pattern. Chris@0: Chris@0: const LOOSE_MAX_LENGTH = 39; Chris@0: const LOOSE_FIRST_HYPHEN_POSITION = 4; Chris@0: Chris@0: /** Chris@0: * {@inheritdoc} Chris@0: */ Chris@0: public function validate($value, Constraint $constraint) Chris@0: { Chris@17: if (!$constraint instanceof Uuid) { Chris@17: throw new UnexpectedTypeException($constraint, __NAMESPACE__.'\Uuid'); Chris@17: } Chris@17: Chris@0: if (null === $value || '' === $value) { Chris@0: return; Chris@0: } Chris@0: Chris@17: if (!is_scalar($value) && !(\is_object($value) && method_exists($value, '__toString'))) { Chris@0: throw new UnexpectedTypeException($value, 'string'); Chris@0: } Chris@0: Chris@0: $value = (string) $value; Chris@0: Chris@0: if ($constraint->strict) { Chris@0: $this->validateStrict($value, $constraint); Chris@0: Chris@0: return; Chris@0: } Chris@0: Chris@0: $this->validateLoose($value, $constraint); Chris@0: } Chris@0: Chris@0: private function validateLoose($value, Uuid $constraint) Chris@0: { Chris@0: // Error priority: Chris@0: // 1. ERROR_INVALID_CHARACTERS Chris@0: // 2. ERROR_INVALID_HYPHEN_PLACEMENT Chris@0: // 3. ERROR_TOO_SHORT/ERROR_TOO_LONG Chris@0: Chris@0: // Trim any wrapping characters like [] or {} used by some legacy systems Chris@0: $trimmed = trim($value, '[]{}'); Chris@0: Chris@0: // Position of the next expected hyphen Chris@0: $h = self::LOOSE_FIRST_HYPHEN_POSITION; Chris@0: Chris@0: // Expected length Chris@0: $l = self::LOOSE_MAX_LENGTH; Chris@0: Chris@0: for ($i = 0; $i < $l; ++$i) { Chris@0: // Check length Chris@0: if (!isset($trimmed[$i])) { Chris@0: $this->context->buildViolation($constraint->message) Chris@0: ->setParameter('{{ value }}', $this->formatValue($value)) Chris@0: ->setCode(Uuid::TOO_SHORT_ERROR) Chris@0: ->addViolation(); Chris@0: Chris@0: return; Chris@0: } Chris@0: Chris@0: // Hyphens must occur every fifth position Chris@0: // xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx Chris@0: // ^ ^ ^ ^ ^ ^ ^ Chris@0: if ('-' === $trimmed[$i]) { Chris@0: if ($i !== $h) { Chris@0: $this->context->buildViolation($constraint->message) Chris@0: ->setParameter('{{ value }}', $this->formatValue($value)) Chris@0: ->setCode(Uuid::INVALID_HYPHEN_PLACEMENT_ERROR) Chris@0: ->addViolation(); Chris@0: Chris@0: return; Chris@0: } Chris@0: Chris@0: $h += 5; Chris@0: Chris@0: continue; Chris@0: } Chris@0: Chris@0: // Missing hyphens are ignored Chris@0: if ($i === $h) { Chris@0: $h += 4; Chris@0: --$l; Chris@0: } Chris@0: Chris@0: // Check characters Chris@0: if (!ctype_xdigit($trimmed[$i])) { Chris@0: $this->context->buildViolation($constraint->message) Chris@0: ->setParameter('{{ value }}', $this->formatValue($value)) Chris@0: ->setCode(Uuid::INVALID_CHARACTERS_ERROR) Chris@0: ->addViolation(); Chris@0: Chris@0: return; Chris@0: } Chris@0: } Chris@0: Chris@0: // Check length again Chris@0: if (isset($trimmed[$i])) { Chris@0: $this->context->buildViolation($constraint->message) Chris@0: ->setParameter('{{ value }}', $this->formatValue($value)) Chris@0: ->setCode(Uuid::TOO_LONG_ERROR) Chris@0: ->addViolation(); Chris@0: } Chris@0: } Chris@0: Chris@0: private function validateStrict($value, Uuid $constraint) Chris@0: { Chris@0: // Error priority: Chris@0: // 1. ERROR_INVALID_CHARACTERS Chris@0: // 2. ERROR_INVALID_HYPHEN_PLACEMENT Chris@0: // 3. ERROR_TOO_SHORT/ERROR_TOO_LONG Chris@0: // 4. ERROR_INVALID_VERSION Chris@0: // 5. ERROR_INVALID_VARIANT Chris@0: Chris@0: // Position of the next expected hyphen Chris@0: $h = self::STRICT_FIRST_HYPHEN_POSITION; Chris@0: Chris@0: for ($i = 0; $i < self::STRICT_LENGTH; ++$i) { Chris@0: // Check length Chris@0: if (!isset($value[$i])) { Chris@0: $this->context->buildViolation($constraint->message) Chris@0: ->setParameter('{{ value }}', $this->formatValue($value)) Chris@0: ->setCode(Uuid::TOO_SHORT_ERROR) Chris@0: ->addViolation(); Chris@0: Chris@0: return; Chris@0: } Chris@0: Chris@0: // Check hyphen placement Chris@0: // xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Chris@0: // ^ ^ ^ ^ Chris@0: if ('-' === $value[$i]) { Chris@0: if ($i !== $h) { Chris@0: $this->context->buildViolation($constraint->message) Chris@0: ->setParameter('{{ value }}', $this->formatValue($value)) Chris@0: ->setCode(Uuid::INVALID_HYPHEN_PLACEMENT_ERROR) Chris@0: ->addViolation(); Chris@0: Chris@0: return; Chris@0: } Chris@0: Chris@0: // xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Chris@0: // ^ Chris@0: if ($h < self::STRICT_LAST_HYPHEN_POSITION) { Chris@0: $h += 5; Chris@0: } Chris@0: Chris@0: continue; Chris@0: } Chris@0: Chris@0: // Check characters Chris@0: if (!ctype_xdigit($value[$i])) { Chris@0: $this->context->buildViolation($constraint->message) Chris@0: ->setParameter('{{ value }}', $this->formatValue($value)) Chris@0: ->setCode(Uuid::INVALID_CHARACTERS_ERROR) Chris@0: ->addViolation(); Chris@0: Chris@0: return; Chris@0: } Chris@0: Chris@0: // Missing hyphen Chris@0: if ($i === $h) { Chris@0: $this->context->buildViolation($constraint->message) Chris@0: ->setParameter('{{ value }}', $this->formatValue($value)) Chris@0: ->setCode(Uuid::INVALID_HYPHEN_PLACEMENT_ERROR) Chris@0: ->addViolation(); Chris@0: Chris@0: return; Chris@0: } Chris@0: } Chris@0: Chris@0: // Check length again Chris@0: if (isset($value[$i])) { Chris@0: $this->context->buildViolation($constraint->message) Chris@0: ->setParameter('{{ value }}', $this->formatValue($value)) Chris@0: ->setCode(Uuid::TOO_LONG_ERROR) Chris@0: ->addViolation(); Chris@0: } Chris@0: Chris@0: // Check version Chris@17: if (!\in_array($value[self::STRICT_VERSION_POSITION], $constraint->versions)) { Chris@0: $this->context->buildViolation($constraint->message) Chris@0: ->setParameter('{{ value }}', $this->formatValue($value)) Chris@0: ->setCode(Uuid::INVALID_VERSION_ERROR) Chris@0: ->addViolation(); Chris@0: } Chris@0: Chris@0: // Check variant - first two bits must equal "10" Chris@0: // 0b10xx Chris@0: // & 0b1100 (12) Chris@0: // = 0b1000 (8) Chris@14: if (8 !== (hexdec($value[self::STRICT_VARIANT_POSITION]) & 12)) { Chris@0: $this->context->buildViolation($constraint->message) Chris@0: ->setParameter('{{ value }}', $this->formatValue($value)) Chris@0: ->setCode(Uuid::INVALID_VARIANT_ERROR) Chris@0: ->addViolation(); Chris@0: } Chris@0: } Chris@0: }