[Validator] String normalization options for string-based validators

symfony · fabpot · Mar 31, 2019 · Mar 11, 2018 · Mar 13, 2019 · 708d759b8dd1bc8a2fc1f18c49f510cc5069bb97
commit 708d759b8dd1bc8a2fc1f18c49f510cc5069bb97
diff --git a/src/Symfony/Component/Validator/CHANGELOG.md b/src/Symfony/Component/Validator/CHANGELOG.md
@@ -8,7 +8,8 @@ CHANGELOG
  * added UATP cards support to `CardSchemeValidator`
  * added option `allowNull` to NotBlank constraint
  * added `Json` constraint
-
+ * added a new `normalizer` option to the string constraints and to the `NotBlank` constraint
+
 4.2.0
 -----
 

diff --git a/src/Symfony/Component/Validator/Constraints/Email.php b/src/Symfony/Component/Validator/Constraints/Email.php
@@ -13,6 +13,7 @@
 
 use Egulias\EmailValidator\EmailValidator as StrictEmailValidator;
 use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\Exception\InvalidArgumentException;
 use Symfony\Component\Validator\Exception\LogicException;
 
 /**
@@ -73,6 +74,7 @@ class Email extends Constraint
      */
     public $strict;
     public $mode;
+    public $normalizer;
 
     public function __construct($options = null)
     {
@@ -89,7 +91,7 @@ public function __construct($options = null)
         }
 
         if (\is_array($options) && \array_key_exists('mode', $options) && !\in_array($options['mode'], self::$validationModes, true)) {
-            throw new \InvalidArgumentException('The "mode" parameter value is not valid.');
+            throw new InvalidArgumentException('The "mode" parameter value is not valid.');
         }
 
         parent::__construct($options);
@@ -98,5 +100,9 @@ public function __construct($options = null)
             // throw new LogicException(sprintf('The "egulias/email-validator" component is required to use the "%s" constraint in strict mode.', __CLASS__));
             @trigger_error(sprintf('Using the "%s" constraint in strict mode without the "egulias/email-validator" component installed is deprecated since Symfony 4.2.', __CLASS__), E_USER_DEPRECATED);
         }
+
+        if (null !== $this->normalizer && !\is_callable($this->normalizer)) {
+            throw new InvalidArgumentException(sprintf('The "normalizer" option must be a valid callable ("%s" given).', \is_object($this->normalizer) ? \get_class($this->normalizer) : \gettype($this->normalizer)));
+        }
     }
 }
diff --git a/src/Symfony/Component/Validator/Constraints/EmailValidator.php b/src/Symfony/Component/Validator/Constraints/EmailValidator.php
@@ -81,6 +81,10 @@ public function validate($value, Constraint $constraint)
 
         $value = (string) $value;
 
+        if (null !== $constraint->normalizer) {
+            $value = ($constraint->normalizer)($value);
+        }
+
         if (null !== $constraint->strict) {
             @trigger_error(sprintf('The %s::$strict property is deprecated since Symfony 4.1. Use %s::mode="%s" instead.', Email::class, Email::class, Email::VALIDATION_MODE_STRICT), E_USER_DEPRECATED);
 

diff --git a/src/Symfony/Component/Validator/Constraints/Ip.php b/src/Symfony/Component/Validator/Constraints/Ip.php
@@ -13,6 +13,7 @@
 
 use Symfony\Component\Validator\Constraint;
 use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
+use Symfony\Component\Validator\Exception\InvalidArgumentException;
 
 /**
  * Validates that a value is a valid IP address.
@@ -72,6 +73,8 @@ class Ip extends Constraint
 
     public $message = 'This is not a valid IP address.';
 
+    public $normalizer;
+
     /**
      * {@inheritdoc}
      */
@@ -82,5 +85,9 @@ public function __construct($options = null)
         if (!\in_array($this->version, self::$versions)) {
             throw new ConstraintDefinitionException(sprintf('The option "version" must be one of "%s"', implode('", "', self::$versions)));
         }
+
+        if (null !== $this->normalizer && !\is_callable($this->normalizer)) {
+            throw new InvalidArgumentException(sprintf('The "normalizer" option must be a valid callable ("%s" given).', \is_object($this->normalizer) ? \get_class($this->normalizer) : \gettype($this->normalizer)));
+        }
     }
 }
diff --git a/src/Symfony/Component/Validator/Constraints/IpValidator.php b/src/Symfony/Component/Validator/Constraints/IpValidator.php
@@ -43,6 +43,10 @@ public function validate($value, Constraint $constraint)
 
         $value = (string) $value;
 
+        if (null !== $constraint->normalizer) {
+            $value = ($constraint->normalizer)($value);
+        }
+
         switch ($constraint->version) {
             case Ip::V4:
                $flag = FILTER_FLAG_IPV4;

diff --git a/src/Symfony/Component/Validator/Constraints/Length.php b/src/Symfony/Component/Validator/Constraints/Length.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Validator\Constraints;
 
 use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\Exception\InvalidArgumentException;
 use Symfony\Component\Validator\Exception\MissingOptionsException;
 
 /**
@@ -39,6 +40,7 @@ class Length extends Constraint
     public $max;
     public $min;
     public $charset = 'UTF-8';
+    public $normalizer;
 
     public function __construct($options = null)
     {
@@ -54,5 +56,9 @@ public function __construct($options = null)
         if (null === $this->min && null === $this->max) {
             throw new MissingOptionsException(sprintf('Either option "min" or "max" must be given for constraint %s', __CLASS__), ['min', 'max']);
         }
+
+        if (null !== $this->normalizer && !\is_callable($this->normalizer)) {
+            throw new InvalidArgumentException(sprintf('The "normalizer" option must be a valid callable ("%s" given).', \is_object($this->normalizer) ? \get_class($this->normalizer) : \gettype($this->normalizer)));
+        }
     }
 }
diff --git a/src/Symfony/Component/Validator/Constraints/LengthValidator.php b/src/Symfony/Component/Validator/Constraints/LengthValidator.php
@@ -40,6 +40,10 @@ public function validate($value, Constraint $constraint)
 
         $stringValue = (string) $value;
 
+        if (null !== $constraint->normalizer) {
+            $stringValue = ($constraint->normalizer)($stringValue);
+        }
+
         if (!$invalidCharset = !@mb_check_encoding($stringValue, $constraint->charset)) {
             $length = mb_strlen($stringValue, $constraint->charset);
         }

diff --git a/src/Symfony/Component/Validator/Constraints/NotBlank.php b/src/Symfony/Component/Validator/Constraints/NotBlank.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Validator\Constraints;
 
 use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\Exception\InvalidArgumentException;
 
 /**
  * @Annotation
@@ -30,4 +31,14 @@ class NotBlank extends Constraint
 
     public $message = 'This value should not be blank.';
     public $allowNull = false;
+    public $normalizer;
+
+    public function __construct($options = null)
+    {
+        parent::__construct($options);
+
+        if (null !== $this->normalizer && !\is_callable($this->normalizer)) {
+            throw new InvalidArgumentException(sprintf('The "normalizer" option must be a valid callable ("%s" given).', \is_object($this->normalizer) ? \get_class($this->normalizer) : \gettype($this->normalizer)));
+        }
+    }
 }
diff --git a/src/Symfony/Component/Validator/Constraints/NotBlankValidator.php b/src/Symfony/Component/Validator/Constraints/NotBlankValidator.php
@@ -34,6 +34,10 @@ public function validate($value, Constraint $constraint)
             return;
         }
 
+        if (\is_string($value) && null !== $constraint->normalizer) {
+            $value = ($constraint->normalizer)($value);
+        }
+
         if (false === $value || (empty($value) && '0' != $value)) {
             $this->context->buildViolation($constraint->message)
                 ->setParameter('{{ value }}', $this->formatValue($value))

diff --git a/src/Symfony/Component/Validator/Constraints/Regex.php b/src/Symfony/Component/Validator/Constraints/Regex.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Validator\Constraints;
 
 use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\Exception\InvalidArgumentException;
 
 /**
  * @Annotation
@@ -31,6 +32,16 @@ class Regex extends Constraint
     public $pattern;
     public $htmlPattern;
     public $match = true;
+    public $normalizer;
+
+    public function __construct($options = null)
+    {
+        parent::__construct($options);
+
+        if (null !== $this->normalizer && !\is_callable($this->normalizer)) {
+            throw new InvalidArgumentException(sprintf('The "normalizer" option must be a valid callable ("%s" given).', \is_object($this->normalizer) ? \get_class($this->normalizer) : \gettype($this->normalizer)));
+        }
+    }
 
     /**
      * {@inheritdoc}

diff --git a/src/Symfony/Component/Validator/Constraints/RegexValidator.php b/src/Symfony/Component/Validator/Constraints/RegexValidator.php
@@ -43,6 +43,10 @@ public function validate($value, Constraint $constraint)
 
         $value = (string) $value;
 
+        if (null !== $constraint->normalizer) {
+            $value = ($constraint->normalizer)($value);
+        }
+
         if ($constraint->match xor preg_match($constraint->pattern, $value)) {
             $this->context->buildViolation($constraint->message)
                 ->setParameter('{{ value }}', $this->formatValue($value))

diff --git a/src/Symfony/Component/Validator/Constraints/Url.php b/src/Symfony/Component/Validator/Constraints/Url.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Validator\Constraints;
 
 use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\Exception\InvalidArgumentException;
 
 /**
  * @Annotation
@@ -105,6 +106,7 @@ class Url extends Constraint
      */
     public $checkDNS = self::CHECK_DNS_TYPE_NONE;
     public $relativeProtocol = false;
+    public $normalizer;
 
     public function __construct($options = null)
     {
@@ -118,5 +120,9 @@ public function __construct($options = null)
         }
 
         parent::__construct($options);
+
+        if (null !== $this->normalizer && !\is_callable($this->normalizer)) {
+            throw new InvalidArgumentException(sprintf('The "normalizer" option must be a valid callable ("%s" given).', \is_object($this->normalizer) ? \get_class($this->normalizer) : \gettype($this->normalizer)));
+        }
     }
 }
diff --git a/src/Symfony/Component/Validator/Constraints/UrlValidator.php b/src/Symfony/Component/Validator/Constraints/UrlValidator.php
@@ -62,6 +62,10 @@ public function validate($value, Constraint $constraint)
             return;
         }
 
+        if (null !== $constraint->normalizer) {
+            $value = ($constraint->normalizer)($value);
+        }
+
         $pattern = $constraint->relativeProtocol ? str_replace('(%s):', '(?:(%s):)?', static::PATTERN) : static::PATTERN;
         $pattern = sprintf($pattern, implode('|', $constraint->protocols));
 

diff --git a/src/Symfony/Component/Validator/Constraints/Uuid.php b/src/Symfony/Component/Validator/Constraints/Uuid.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Validator\Constraints;
 
 use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\Exception\InvalidArgumentException;
 
 /**
  * @Annotation
@@ -74,4 +75,15 @@ class Uuid extends Constraint
         self::V4_RANDOM,
         self::V5_SHA1,
     ];
+
+    public $normalizer;
+
+    public function __construct($options = null)
+    {
+        parent::__construct($options);
+
+        if (null !== $this->normalizer && !\is_callable($this->normalizer)) {
+            throw new InvalidArgumentException(sprintf('The "normalizer" option must be a valid callable ("%s" given).', \is_object($this->normalizer) ? \get_class($this->normalizer) : \gettype($this->normalizer)));
+        }
+    }
 }
diff --git a/src/Symfony/Component/Validator/Constraints/UuidValidator.php b/src/Symfony/Component/Validator/Constraints/UuidValidator.php
@@ -81,6 +81,10 @@ public function validate($value, Constraint $constraint)
 
         $value = (string) $value;
 
+        if (null !== $constraint->normalizer) {
+            $value = ($constraint->normalizer)($value);
+        }
+
         if ($constraint->strict) {
             $this->validateStrict($value, $constraint);
 

diff --git a/src/Symfony/Component/Validator/Tests/Constraints/EmailTest.php b/src/Symfony/Component/Validator/Tests/Constraints/EmailTest.php
@@ -35,11 +35,36 @@ public function testConstructorStrict()
     }
 
     /**
-     * @expectedException \InvalidArgumentException
+     * @expectedException \Symfony\Component\Validator\Exception\InvalidArgumentException
      * @expectedExceptionMessage The "mode" parameter value is not valid.
      */
     public function testUnknownModesTriggerException()
     {
         new Email(['mode' => 'Unknown Mode']);
     }
+
+    public function testNormalizerCanBeSet()
+    {
+        $email = new Email(['normalizer' => 'trim']);
+
+        $this->assertEquals('trim', $email->normalizer);
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Validator\Exception\InvalidArgumentException
+     * @expectedExceptionMessage The "normalizer" option must be a valid callable ("string" given).
+     */
+    public function testInvalidNormalizerThrowsException()
+    {
+        new Email(['normalizer' => 'Unknown Callable']);
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Validator\Exception\InvalidArgumentException
+     * @expectedExceptionMessage The "normalizer" option must be a valid callable ("stdClass" given).
+     */
+    public function testInvalidNormalizerObjectThrowsException()
+    {
+        new Email(['normalizer' => new \stdClass()]);
+    }
 }
diff --git a/src/Symfony/Component/Validator/Tests/Constraints/EmailValidatorTest.php b/src/Symfony/Component/Validator/Tests/Constraints/EmailValidatorTest.php
@@ -94,6 +94,28 @@ public function getValidEmails()
         ];
     }
 
+    /**
+     * @dataProvider getValidEmailsWithWhitespaces
+     */
+    public function testValidNormalizedEmails($email)
+    {
+        $this->validator->validate($email, new Email(['normalizer' => 'trim']));
+
+        $this->assertNoViolation();
+    }
+
+    public function getValidEmailsWithWhitespaces()
+    {
+        return [
+            ["\x20example@example.co.uk\x20"],
+            ["\x09\x09example@example.co..uk\x09\x09"],
+            ["\x0A{}~!@!@£$%%^&*().!@£$%^&*()\x0A"],
+            ["\x0D\x0Dexample@example.co..uk\x0D\x0D"],
+            ["\x00example@-example.com"],
+            ["example@example.com\x0B\x0B"],
+        ];
+    }
+
     /**
      * @dataProvider getValidEmailsHtml5
      */

diff --git a/src/Symfony/Component/Validator/Tests/Constraints/IpTest.php b/src/Symfony/Component/Validator/Tests/Constraints/IpTest.php
@@ -0,0 +1,46 @@
+<?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\Tests\Constraints;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Validator\Constraints\Ip;
+
+/**
+ * @author Renan Taranto <renantaranto@gmail.com>
+ */
+class IpTest extends TestCase
+{
+    public function testNormalizerCanBeSet()
+    {
+        $ip = new Ip(['normalizer' => 'trim']);
+
+        $this->assertEquals('trim', $ip->normalizer);
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Validator\Exception\InvalidArgumentException
+     * @expectedExceptionMessage The "normalizer" option must be a valid callable ("string" given).
+     */
+    public function testInvalidNormalizerThrowsException()
+    {
+        new Ip(['normalizer' => 'Unknown Callable']);
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Validator\Exception\InvalidArgumentException
+     * @expectedExceptionMessage The "normalizer" option must be a valid callable ("stdClass" given).
+     */
+    public function testInvalidNormalizerObjectThrowsException()
+    {
+        new Ip(['normalizer' => new \stdClass()]);
+    }
+}