dev: Provide a Url class to sanitize domains

src/Utils/Url.php

@@ -0,0 +1,27 @@
+<?php
+
+// This file is part of Bileto.
+// Copyright 2022-2024 Probesys
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+namespace App\Utils;
+
+class Url
+{
+    public static function sanitizeDomain(string $domain): string
+    {
+        // idn_to_ascii allows to transform an unicode domain to an
+        // ASCII representation
+        // @see https://en.wikipedia.org/wiki/Punycode
+        // It also lowercases the string.
+        $domain = idn_to_ascii($domain, IDNA_DEFAULT, INTL_IDNA_VARIANT_UTS46);
+
+        if ($domain === false) {
+            $domain = '';
+        }
+
+        $domain = trim($domain);
+
+        return $domain;
+    }
+}

tests/Utils/UrlTest.php

@@ -0,0 +1,49 @@
+<?php
+
+// This file is part of Bileto.
+// Copyright 2022-2024 Probesys
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+namespace App\Tests\Utils;
+
+use App\Utils\Url;
+use PHPUnit\Framework\TestCase;
+
+class UrlTest extends TestCase
+{
+    public function testSanitizeDomain(): void
+    {
+        $domain = 'example.com';
+
+        $sanitizedDomain = Url::sanitizeDomain($domain);
+
+        $this->assertEquals('example.com', $sanitizedDomain);
+    }
+
+    public function testSanitizeDomainTrimsSpaces(): void
+    {
+        $domain = ' example.com ';
+
+        $sanitizedDomain = Url::sanitizeDomain($domain);
+
+        $this->assertEquals('example.com', $sanitizedDomain);
+    }
+
+    public function testSanitizeDomainLowercasesTheDomain(): void
+    {
+        $domain = 'EXAMPLE.com';
+
+        $sanitizedDomain = Url::sanitizeDomain($domain);
+
+        $this->assertEquals('example.com', $sanitizedDomain);
+    }
+
+    public function testSanitizeDomainConvertsDomainToAscii(): void
+    {
+        $domain = 'éxample.com';
+
+        $sanitizedDomain = Url::sanitizeDomain($domain);
+
+        $this->assertEquals('xn--xample-9ua.com', $sanitizedDomain);
+    }
+}