sfmok · sfmok · Jun 9, 2024 · ostrolucky · Jun 10, 2024 · ostrolucky
diff --git a/src/Symfony/Component/Validator/CHANGELOG.md b/src/Symfony/Component/Validator/CHANGELOG.md
@@ -3,7 +3,7 @@ CHANGELOG
 
 7.2
 ---
-
+ * Add the `Yaml`, `Xml` and `Jwt` constraints
  * Make `PasswordStrengthValidator::estimateStrength()` public
 
 7.1

diff --git a/src/Symfony/Component/Validator/Constraints/AbstractFormat.php b/src/Symfony/Component/Validator/Constraints/AbstractFormat.php
@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Constraints;
+
+use Symfony\Component\Validator\Constraint;
+
+/**
+ * Used for the format of values.
+ *
+ * @author Mokhtar Tlili <tlili.mokhtar@gmail.com>
+ */
+abstract class AbstractFormat extends Constraint
+{
+    public string $format;
+    public string $message = 'This value should be valid {{ format }}.';
+
+    public function __construct(?string $message = null, ?array $options = null, ?array $groups = null, mixed $payload = null)
+    {
+        parent::__construct($options, $groups, $payload);
+
+        $this->message = $message ?? $this->message;
+    }
+}
diff --git a/src/Symfony/Component/Validator/Constraints/AbstractFormatValidator.php b/src/Symfony/Component/Validator/Constraints/AbstractFormatValidator.php
@@ -0,0 +1,58 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Constraints;
+
+
+use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\ConstraintValidator;
+use Symfony\Component\Validator\Exception\UnexpectedTypeException;
+use Symfony\Component\Validator\Exception\UnexpectedValueException;
+
+/**
+ * Provides a base class for the validation of value format.
+ *
+ * @author Mokhtar Tlili <tlili.mokhtar@gmail.com>
+ */
+abstract class AbstractFormatValidator extends ConstraintValidator
+{
+    public function validate(mixed $value, Constraint $constraint): void
+    {
+        if (!$constraint instanceof AbstractFormat) {
+            throw new UnexpectedTypeException($constraint, AbstractFormat::class);
+        }
+
+        if (null === $value || '' === $value) {
+            return;
+        }
+
+        if (!\is_scalar($value) && !$value instanceof \Stringable) {
+            throw new UnexpectedValueException($value, 'string');
+        }
+
+        if ($this->validateFormat((string) $value)) {
+            return;
+        }
+
+        $this->context->buildViolation($constraint->message)
+            ->setParameter('{{ value }}', $this->formatValue($value))
+            ->setParameter('{{ format }}', $constraint->format)
+            ->setCode($this->getErrorCode())
+            ->addViolation();
+    }
+
+    /**
+     * Validate format value
+     */
+    abstract protected function validateFormat(string $value): bool;
+
+    abstract protected function getErrorCode(): string;
+}
diff --git a/src/Symfony/Component/Validator/Constraints/Json.php b/src/Symfony/Component/Validator/Constraints/Json.php
@@ -11,32 +11,28 @@
 
 namespace Symfony\Component\Validator\Constraints;
 
-use Symfony\Component\Validator\Constraint;
-
 /**
  * Validates that a value has valid JSON syntax.
  *
  * @author Imad ZAIRIG <imadzairig@gmail.com>
  */
 #[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
-class Json extends Constraint
+class Json extends AbstractFormat
 {
     public const INVALID_JSON_ERROR = '0789c8ad-2d2b-49a4-8356-e2ce63998504';
 
     protected const ERROR_NAMES = [
         self::INVALID_JSON_ERROR => 'INVALID_JSON_ERROR',
     ];
 
-    public string $message = 'This value should be valid JSON.';
+    public string $format = 'JSON';
 
     /**
      * @param array<string,mixed>|null $options
      * @param string[]|null            $groups
      */
     public function __construct(?array $options = null, ?string $message = null, ?array $groups = null, mixed $payload = null)
     {
-        parent::__construct($options, $groups, $payload);
-
-        $this->message = $message ?? $this->message;
+        parent::__construct($message, $options, $groups, $payload);
     }
 }
diff --git a/src/Symfony/Component/Validator/Constraints/JsonValidator.php b/src/Symfony/Component/Validator/Constraints/JsonValidator.php
@@ -11,37 +11,18 @@
 
 namespace Symfony\Component\Validator\Constraints;
 
-use Symfony\Component\Validator\Constraint;
-use Symfony\Component\Validator\ConstraintValidator;
-use Symfony\Component\Validator\Exception\UnexpectedTypeException;
-use Symfony\Component\Validator\Exception\UnexpectedValueException;
-
 /**
  * @author Imad ZAIRIG <imadzairig@gmail.com>
  */
-class JsonValidator extends ConstraintValidator
+class JsonValidator extends AbstractFormatValidator
 {
-    public function validate(mixed $value, Constraint $constraint): void
+    protected function validateFormat(string $value): bool
     {
-        if (!$constraint instanceof Json) {
-            throw new UnexpectedTypeException($constraint, Json::class);
-        }
-
-        if (null === $value || '' === $value) {
-            return;
-        }
-
-        if (!\is_scalar($value) && !$value instanceof \Stringable) {
-            throw new UnexpectedValueException($value, 'string');
-        }
-
-        $value = (string) $value;
+        return json_validate($value);
+    }
 
-        if (!json_validate($value)) {
-            $this->context->buildViolation($constraint->message)
-                ->setParameter('{{ value }}', $this->formatValue($value))
-                ->setCode(Json::INVALID_JSON_ERROR)
-                ->addViolation();
-        }
+    protected function getErrorCode(): string
+    {
+        return Json::INVALID_JSON_ERROR;
     }
 }
diff --git a/src/Symfony/Component/Validator/Constraints/Jwt.php b/src/Symfony/Component/Validator/Constraints/Jwt.php
@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Constraints;
+
+/**
+ * Validates that a value is a valid jwt format.
+ *
+ * @author Mokhtar Tlili <tlili.mokhtar@gmail.com>
+ */
+#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
+class Jwt extends AbstractFormat
+{
+    public const INVALID_JWT_ERROR = '8f14e45f-e6e5-4c6c-9c17-68f22a1f3dff';
+
+    protected const ERROR_NAMES = [
+        self::INVALID_JWT_ERROR => 'INVALID_JWT_ERROR',
+    ];
+
+    public string $format = 'JWT';
+}
diff --git a/src/Symfony/Component/Validator/Constraints/JwtValidator.php b/src/Symfony/Component/Validator/Constraints/JwtValidator.php
@@ -0,0 +1,48 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Constraints;
+
+/**
+ * @author Mokhtar Tlili <tlili.mokhtar@gmail.com>
+ */
+class JwtValidator extends AbstractFormatValidator
+{
+    protected function validateFormat(string $value): bool
+    {
+        // Split the JWT into its three parts
+        $parts = explode('.', $value);
+
+        // JWT should have exactly three parts
+        if (count($parts) !== 3) {
+            return false;
+        }
+
+        [$header, $payload, $signature] = $parts;
-        [$header, $payload, $signature] = $parts;
+        [$header, $payload] = $parts;
-        [$header, $payload, $signature] = $parts;
+        [$header, $payload] = $parts;
+
+        // Replace URL-safe characters with standard Base64 characters and decode
+        $decodedHeader = base64_decode(strtr($header, '-_', '+/'));
+        $decodedPayload = base64_decode(strtr($payload, '-_', '+/'));
+
+        // Check if the decoded header and payload are valid JSON
+        if (!json_validate($decodedHeader) || !json_validate($decodedPayload)) {
+            return false;
+        }
+
+        // At this point, it looks like a JWT
+        return true;
-        // Check if the decoded header and payload are valid JSON
-        if (!json_validate($decodedHeader) || !json_validate($decodedPayload)) {
-            return false;
-        }
-
-        // At this point, it looks like a JWT
-        return true;
+        return json_validate($decodedHeader) && json_validate($decodedPayload)
-        // Check if the decoded header and payload are valid JSON
-        if (!json_validate($decodedHeader) || !json_validate($decodedPayload)) {
-            return false;
-        }
-
-        // At this point, it looks like a JWT
-        return true;
+        return json_validate($decodedHeader) && json_validate($decodedPayload)
+    }
+
+    protected function getErrorCode(): string
+    {
+        return Jwt::INVALID_JWT_ERROR;
+    }
+}
diff --git a/src/Symfony/Component/Validator/Constraints/Xml.php b/src/Symfony/Component/Validator/Constraints/Xml.php
@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Constraints;
+
+/**
+ * Validates that a value is a valid xml format.
+ *
+ * @author Mokhtar Tlili <tlili.mokhtar@gmail.com>
+ */
+#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
+class Xml extends AbstractFormat
+{
+    public const INVALID_XML_ERROR = '0355230a-97b8-49da-b8cd-985bf3345bcf';
+
+    protected const ERROR_NAMES = [
+        self::INVALID_XML_ERROR => 'INVALID_XML_ERROR',
+    ];
+
+    public string $format = 'XML';
+}
diff --git a/src/Symfony/Component/Validator/Constraints/XmlValidator.php b/src/Symfony/Component/Validator/Constraints/XmlValidator.php
@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Constraints;
+
+/**
+ * @author Mokhtar Tlili <tlili.mokhtar@gmail.com>
+ */
+class XmlValidator extends AbstractFormatValidator
+{
+    protected function validateFormat(string $value): bool
+    {
+        return false !== @simplexml_load_string($value);
+    }
+
+    protected function getErrorCode(): string
+    {
+        return Xml::INVALID_XML_ERROR;
+    }
+}
diff --git a/src/Symfony/Component/Validator/Constraints/Yaml.php b/src/Symfony/Component/Validator/Constraints/Yaml.php
@@ -0,0 +1,45 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Constraints;
+
+use Symfony\Component\Validator\Exception\LogicException;
+use Symfony\Component\Yaml\Yaml as SymfonyYaml;
+
+/**
+ * Validates that a value is a valid yaml format.
+ *
+ * @author Mokhtar Tlili <tlili.mokhtar@gmail.com>
+ */
+#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
+class Yaml extends AbstractFormat
+{
+    public const INVALID_YAML_ERROR = '8f14e45f-e6e5-4c6c-9c17-68f22a1f3dff';
+
+    protected const ERROR_NAMES = [
+        self::INVALID_YAML_ERROR => 'INVALID_YAML_ERROR',
+    ];
+
+    public string $format = 'YAML';
+
+    /**
+     * @param string[]|null                            $groups
+     * @param array<string,mixed>                      $options
+     */
+    public function __construct(?array $options = null, ?string $message = null, ?array $groups = null, mixed $payload = null)
+    {
+        if (!class_exists(SymfonyYaml::class)) {
+            throw new LogicException('The Yaml component is required to use the Yaml constraint. Try running "composer require symfony/yaml".');
+        }
+
+        parent::__construct($message, $options, $groups, $payload);
+    }
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,7 +3,7 @@ CHANGELOG @@
 .2
     ---
+     * Add the `Yaml`, `Xml` and `Jwt` constraints
      * Make `PasswordStrengthValidator::estimateStrength()` public
 .1
@@ Expand Down @@