Merge pull request #16638 from noone-silent/T16637-allow-utf8-email-i…

…n-local-part [#16637] - refactor: allow utf8 in email local part.
phalcon · Aug 19, 2024 · a733278 · a733278
2 parents c6539d7 + 8409a7e
commit a733278
Show file tree

Hide file tree

Showing 3 changed files with 166 additions and 3 deletions.
diff --git a/CHANGELOG-5.0.md b/CHANGELOG-5.0.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## [5.8.x](https://github.com/phalcon/cphalcon/releases/tag/v5.8.x) (xxxx-xx-xx)
+
+### Changed
+
+- Changed `Phalcon\Filter\Validation\Validator\Email` to allow UTF8 in local part. [#16637](https://github.com/phalcon/cphalcon/issues/16637)
+
 ## [5.8.0](https://github.com/phalcon/cphalcon/releases/tag/v5.8.0) (2024-07-09)
 
 ### Changed

diff --git a/phalcon/Filter/Validation/Validator/Email.zep b/phalcon/Filter/Validation/Validator/Email.zep
@@ -46,6 +46,16 @@ use Phalcon\Filter\Validation\AbstractValidator;
  *         ]
  *     )
  * );
+ *
+ * $validator->add(
+ *     "tä[email protected]",
+ *     new EmailValidator(
+ *         [
+ *             "message" => "The e-mail is not valid",
+ *             "allowUTF8" => true,
+ *         ]
+ *     )
+ * );
  * ```
  */
 class Email extends AbstractValidator
@@ -58,7 +68,8 @@ class Email extends AbstractValidator
      * @param array options = [
      *     'message' => '',
      *     'template' => '',
-     *     'allowEmpty' => false
+     *     'allowEmpty' => false,
+     *     'allowUTF8' => false,
      * ]
      */
     public function __construct(array! options = [])
@@ -71,12 +82,19 @@ class Email extends AbstractValidator
      */
     public function validate(<Validation> validation, var field) -> bool
     {
-        var value = validation->getValue(field);
+        var value, flags;
+
+        let value = validation->getValue(field);
         if this->allowEmpty(field, value) {
             return true;
         }
 
-        if !filter_var(value, FILTER_VALIDATE_EMAIL) {
+        let flags = FILTER_DEFAULT;
+        if (this->getOption("allowUTF8")) {
+            let flags = FILTER_FLAG_EMAIL_UNICODE;
+        }
+
+        if !filter_var(value, FILTER_VALIDATE_EMAIL, flags) {
             validation->appendMessage(
                 this->messageFactory(validation, field)
             );

diff --git a/tests/unit/Filter/Validation/Validator/EmailCest.php b/tests/unit/Filter/Validation/Validator/EmailCest.php
@@ -0,0 +1,139 @@
+<?php
+
+/**
+ * This file is part of the Phalcon Framework.
+ *
+ * (c) Phalcon Team <[email protected]>
+ *
+ * For the full copyright and license information, please view the
+ * LICENSE.txt file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Phalcon\Tests\Unit\Filter\Validation\Validator;
+
+use Phalcon\Filter\Validation;
+use UnitTester;
+
+class EmailCest
+{
+    /**
+     * Tests Filter\Validation\Validator\Email :: validate
+     *
+     * @param UnitTester $I
+     *
+     * @author n[oO]ne <[email protected]>
+     * @since  2024-08-19
+     */
+    public function validEmail(UnitTester $I)
+    {
+        $I->wantToTest('Filter\Validation\Validator\Email - valid email');
+
+        $validation = new Validation();
+        $validation->add('email', new Validation\Validator\Email());
+        $I->assertEmpty($validation->validate(['email' => '[email protected]']));
+    }
+
+    /**
+     * Tests Filter\Validation\Validator\Email :: validate
+     *
+     * @param UnitTester $I
+     *
+     * @author n[oO]ne <[email protected]>
+     * @since  2024-08-19
+     */
+    public function invalidEmail(UnitTester $I)
+    {
+        $I->wantToTest('Filter\Validation\Validator\Email - invalid email');
+
+        $validation = new Validation();
+        $validation->add('email', new Validation\Validator\Email());
+        $I->assertNotEmpty($validation->validate(['email' => '[email protected]']));
+    }
+
+    /**
+     * Tests Filter\Validation\Validator\Email :: validate
+     *
+     * @param UnitTester $I
+     *
+     * @author n[oO]ne <[email protected]>
+     * @since  2024-08-19
+     */
+    public function emailWithoutUTF8Success(UnitTester $I)
+    {
+        $I->wantToTest('Filter\Validation\Validator\Email - without utf8 is ok');
+
+        $validation = new Validation();
+        $validation->add('email', new Validation\Validator\Email());
+        $I->assertEmpty($validation->validate(['email' => '[email protected]']));
+    }
+
+    /**
+     * Tests Filter\Validation\Validator\Email :: validate
+     *
+     * @param UnitTester $I
+     *
+     * @author n[oO]ne <[email protected]>
+     * @since  2024-08-19
+     */
+    public function emailAllowEmptyFails(UnitTester $I)
+    {
+        $I->wantToTest('Filter\Validation\Validator\Email - empty is not ok');
+
+        $validation = new Validation();
+        $validation->add('email', new Validation\Validator\Email());
+        $I->assertNotEmpty($validation->validate(['email' => '']));
+    }
+
+    /**
+     * Tests Filter\Validation\Validator\Email :: validate
+     *
+     * @param UnitTester $I
+     *
+     * @author n[oO]ne <[email protected]>
+     * @since  2024-08-19
+     */
+    public function emailAllowEmptySuccess(UnitTester $I)
+    {
+        $I->wantToTest('Filter\Validation\Validator\Email - empty is ok');
+
+        $validation = new Validation();
+        $validation->add('email', new Validation\Validator\Email(['allowEmpty' => true]));
+        $I->assertEmpty($validation->validate(['email' => '']));
+    }
+
+    /**
+     * Tests Filter\Validation\Validator\Email :: validate
+     *
+     * @param UnitTester $I
+     *
+     * @author n[oO]ne <[email protected]>
+     * @since  2024-08-19
+     */
+    public function emailWithUTF8Fail(UnitTester $I)
+    {
+        $I->wantToTest('Filter\Validation\Validator\Email - with utf8 fails');
+
+        $validation = new Validation();
+        $validation->add('email', new Validation\Validator\Email());
+        $I->assertNotEmpty($validation->validate(['email' => 'tä[email protected]']));
+    }
+
+    /**
+     * Tests Filter\Validation\Validator\Email :: validate
+     *
+     * @param UnitTester $I
+     *
+     * @author n[oO]ne <[email protected]>
+     * @since  2024-08-19
+     */
+    public function emailWithUTF8Success(UnitTester $I)
+    {
+        $I->wantToTest('Filter\Validation\Validator\Email - with utf8 success');
+
+        $validation = new Validation();
+        $validation->add('email', new Validation\Validator\Email(['allowUTF8' => true]));
+        $I->assertEmpty($validation->validate(['email' => 'tä[email protected]']));
+    }
+}