[Validator] Html5 Email Validation

PurpleBooth · PurpleBooth · commit 8843696d52c9 · 2017-10-29T09:28:51.000Z
Currently we only support a very loose validation. There is now a
standard HTML5 element with matching regex. This will add the ability
to set a `mode` on the email validator. The mode will change the
validation that is applied to the field as a whole.

These modes are:

* loose: The pattern from previous Symfony versions (default)
* strict: Strictly matching the RFC
* html5: The regex used for the HTML5 Element

Deprecates the `strict=true` parameter in favour of `mode='strict'`
diff --git a/UPGRADE-3.4.md b/UPGRADE-3.4.md
@@ -413,6 +413,53 @@ Validator
  * Not setting the `strict` option of the `Choice` constraint to `true` is
    deprecated and will throw an exception in Symfony 4.0.
 
+ * The `strict` option of the `Email` constraint is deprecated and will
+   be removed in Symfony 4.0, use the `mode` option instead.
+
+   Before:
+
+   ```php
+   use Symfony\Component\Validator\Constraints as Assert;
+
+   /**
+    * @Assert\Email(strict=true)
+    */
+   private $property;
+   ```
+
+   After:
+
+   ```php
+   use Symfony\Component\Validator\Constraints as Assert;
+
+   /**
+    * @Assert\Email(mode="strict")
+    */
+   private $property;
+   ```
+
+ * Calling the `EmailValidator` with a boolean constructor argument is deprecated and will
+   be removed in Symfony 4.0.
+
+   Before:
+
+   ```php
+   use Symfony\Component\Validator\Constraints\EmailValidator;
+
+   $strictValidator = new EmailValidator(true);
+   $looseValidator = new EmailValidator(false);
+   ```
+
+   After:
+
+   ```php
+   use Symfony\Component\Validator\Constraints\Email;
+   use Symfony\Component\Validator\Constraints\EmailValidator;
+
+   $strictValidator = new EmailValidator(Email::VALIDATION_MODE_STRICT);
+   $looseValidator = new EmailValidator(Email::VALIDATION_MODE_LOOSE);
+   ```
+
 Yaml
 ----
 
diff --git a/src/Symfony/Component/Validator/Constraints/Email.php b/src/Symfony/Component/Validator/Constraints/Email.php
@@ -21,6 +21,10 @@
  */
 class Email extends Constraint
 {
+    const VALIDATION_MODE_HTML5 = 'html5';
+    const VALIDATION_MODE_STRICT = 'strict';
+    const VALIDATION_MODE_LOOSE = 'loose';
+
     const INVALID_FORMAT_ERROR = 'bd79c0ab-ddba-46cc-a703-a7a4b08de310';
     const MX_CHECK_FAILED_ERROR = 'bf447c1c-0266-4e10-9c6c-573df282e413';
     const HOST_CHECK_FAILED_ERROR = '7da53a8b-56f3-4288-bb3e-ee9ede4ef9a1';
@@ -31,8 +35,37 @@ class Email extends Constraint
         self::HOST_CHECK_FAILED_ERROR => 'HOST_CHECK_FAILED_ERROR',
     );
 
+    /**
+     * @var string[]
+     *
+     * @internal
+     */
+    public static $validationModes = array(
+        self::VALIDATION_MODE_HTML5,
+        self::VALIDATION_MODE_STRICT,
+        self::VALIDATION_MODE_LOOSE,
+    );
+
     public $message = 'This value is not a valid email address.';
     public $checkMX = false;
     public $checkHost = false;
+
+    /**
+     * @deprecated since version 3.4, to be removed in 4.0. Set mode to "strict" instead.
+     */
     public $strict;
+    public $mode;
+
+    public function __construct($options = null)
+    {
+        if (is_array($options) && array_key_exists('strict', $options)) {
+            @trigger_error(sprintf('The \'strict\' property is deprecated since version 3.4 and will be removed in 4.0. Use \'mode\'=>"%s" instead.', self::VALIDATION_MODE_STRICT), E_USER_DEPRECATED);
+        }
+
+        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.');
+        }
+
+        parent::__construct($options);
+    }
 }
diff --git a/src/Symfony/Component/Validator/Constraints/EmailValidator.php b/src/Symfony/Component/Validator/Constraints/EmailValidator.php
@@ -24,13 +24,40 @@
 class EmailValidator extends ConstraintValidator
 {
     /**
-     * @var bool
+     * @internal
      */
-    private $isStrict;
+    const PATTERN_HTML5 = '/^[a-zA-Z0-9.!#$%&\'*+\\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)+$/';
+    /**
+     * @internal
+     */
+    const PATTERN_LOOSE = '/^.+\@\S+\.\S+$/';
+
+    private static $emailPatterns = array(
+        Email::VALIDATION_MODE_LOOSE => self::PATTERN_LOOSE,
+        Email::VALIDATION_MODE_HTML5 => self::PATTERN_HTML5,
+    );
+
+    /**
+     * @var string
+     */
+    private $defaultMode;
 
-    public function __construct($strict = false)
+    /**
+     * @param string $defaultMode
+     */
+    public function __construct($defaultMode = Email::VALIDATION_MODE_LOOSE)
     {
-        $this->isStrict = $strict;
+        if (is_bool($defaultMode)) {
+            @trigger_error(sprintf('Calling `new %s(%s)` is deprecated since version 3.4 and will be removed in 4.0, use `new %s("%s")` instead.', self::class, $defaultMode ? 'true' : 'false', self::class, $defaultMode ? Email::VALIDATION_MODE_STRICT : Email::VALIDATION_MODE_LOOSE), E_USER_DEPRECATED);
+
+            $defaultMode = $defaultMode ? Email::VALIDATION_MODE_STRICT : Email::VALIDATION_MODE_LOOSE;
+        }
+
+        if (!in_array($defaultMode, Email::$validationModes, true)) {
+            throw new \InvalidArgumentException('The "defaultMode" parameter value is not valid.');
+        }
+
+        $this->defaultMode = $defaultMode;
     }
 
     /**
@@ -52,11 +79,25 @@ public function validate($value, Constraint $constraint)
 
         $value = (string) $value;
 
-        if (null === $constraint->strict) {
-            $constraint->strict = $this->isStrict;
+        if (null !== $constraint->strict) {
+            @trigger_error(sprintf('The %s::$strict property is deprecated since version 3.4 and will be removed in 4.0. Use %s::mode="%s" instead.', Email::class, Email::class, Email::VALIDATION_MODE_STRICT), E_USER_DEPRECATED);
+
+            if ($constraint->strict) {
+                $constraint->mode = Email::VALIDATION_MODE_STRICT;
+            } else {
+                $constraint->mode = Email::VALIDATION_MODE_LOOSE;
+            }
+        }
+
+        if (null === $constraint->mode) {
+            $constraint->mode = $this->defaultMode;
+        }
+
+        if (!in_array($constraint->mode, Email::$validationModes, true)) {
+            throw new \InvalidArgumentException(sprintf('The %s::$mode parameter value is not valid.', get_class($constraint)));
         }
 
-        if ($constraint->strict) {
+        if (Email::VALIDATION_MODE_STRICT === $constraint->mode) {
             if (!class_exists('\Egulias\EmailValidator\EmailValidator')) {
                 throw new RuntimeException('Strict email validation requires egulias/email-validator ~1.2|~2.0');
             }
@@ -78,7 +119,7 @@ public function validate($value, Constraint $constraint)
 
                 return;
             }
-        } elseif (!preg_match('/^.+\@\S+\.\S+$/', $value)) {
+        } elseif (!preg_match(self::$emailPatterns[$constraint->mode], $value)) {
             $this->context->buildViolation($constraint->message)
                 ->setParameter('{{ value }}', $this->formatValue($value))
                 ->setCode(Email::INVALID_FORMAT_ERROR)
diff --git a/src/Symfony/Component/Validator/Tests/Constraints/EmailTest.php b/src/Symfony/Component/Validator/Tests/Constraints/EmailTest.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\Email;
+use Symfony\Component\Validator\Constraints\File;
+
+class EmailTest extends TestCase
+{
+    /**
+     * @expectedDeprecation The 'strict' property is deprecated since version 3.4 and will be removed in 4.0. Use 'mode'=>"strict" instead.
+     * @group legacy
+     */
+    public function testLegacyConstructorStrict()
+    {
+        $subject = new Email(array('strict' => true));
+
+        $this->assertTrue($subject->strict);
+    }
+
+    public function testConstructorStrict()
+    {
+        $subject = new Email(array('mode' => Email::VALIDATION_MODE_STRICT));
+
+        $this->assertEquals(Email::VALIDATION_MODE_STRICT, $subject->mode);
+    }
+
+    /**
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage The 'mode' parameter value is not valid.
+     */
+    public function testUnknownModesTriggerException()
+    {
+        new Email(array('mode' => 'Unknown Mode'));
+    }
+}
diff --git a/src/Symfony/Component/Validator/Tests/Constraints/EmailValidatorTest.php b/src/Symfony/Component/Validator/Tests/Constraints/EmailValidatorTest.php
