IBX-10978: Added tel/mailto options to urlType (#106)

For more details see https://ibexa.atlassian.net/browse/IBX-10978 and #106

Key changes:

* Added tel/mailto options to URL field type's form type

* Implemented FixUrlProtocolListener

* [Tests] Added coverage for FixUrlProtocolListener

---------

Co-Authored-By: Paweł Niedzielski <Steveb-p@users.noreply.github.com>

Author: reithor

src/lib/Form/EventSubscriber/FixUrlProtocolListener.php

@@ -0,0 +1,74 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\ContentForms\Form\EventSubscriber;
+
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\Form\Extension\Core\EventListener\FixUrlProtocolListener as BaseFixUrlProtocolListener;
+use Symfony\Component\Form\FormEvent;
+use Symfony\Component\Form\FormEvents;
+
+/**
+ * @internal
+ */
+final class FixUrlProtocolListener implements EventSubscriberInterface
+{
+    private ?string $defaultProtocol;
+
+    private BaseFixUrlProtocolListener $fixUrlProtocolListener;
+
+    /**
+     * @param string|null $defaultProtocol The URL scheme to add when there is none or null to not modify the data
+     */
+    public function __construct(?string $defaultProtocol = 'http')
+    {
+        $this->defaultProtocol = $defaultProtocol;
+        $this->fixUrlProtocolListener = new BaseFixUrlProtocolListener($defaultProtocol);
+    }
+
+    public function onSubmit(FormEvent $event): void
+    {
+        $data = $event->getData();
+        if (null === $this->defaultProtocol || empty($data) || !\is_string($data)) {
+            return;
+        }
+
+        $protocol = explode(':', $data, 2)[0];
+        if ($this->hasAuthority($protocol) && $this->hasAuthority($this->defaultProtocol)) {
+            $this->fixUrlProtocolListener->onSubmit($event);
+
+            return;
+        }
+
+        if (!$this->hasAuthority($protocol) && preg_match('~^(?:[/.]|[\w+.-]+:|[^:/?@#]++@)~', $data)) {
+            return;
+        }
+
+        if ($this->hasAuthority($this->defaultProtocol)) {
+            $schemaSeparator = '://';
+            $regExp = '~^(?:[/.]|[\w+.-]+//|[^:/?@#]++@)~';
+        } else {
+            $schemaSeparator = ':';
+            $regExp = '~^[\w+.-]+:~'; // allowing emails for non-http/https/file
+        }
+
+        if (!preg_match($regExp, $data)) {
+            $event->setData($this->defaultProtocol . $schemaSeparator . $data);
+        }
+    }
+
+    private function hasAuthority(string $protocol): bool
+    {
+        return !in_array($protocol, ['mailto', 'tel'], true);
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [FormEvents::SUBMIT => 'onSubmit'];
+    }
+}

src/lib/Form/Type/FieldType/UrlFieldType.php

@@ -9,6 +9,7 @@
 namespace Ibexa\ContentForms\Form\Type\FieldType;
 
 use Ibexa\ContentForms\FieldType\DataTransformer\FieldValueTransformer;
+use Ibexa\ContentForms\Form\EventSubscriber\FixUrlProtocolListener;
 use Ibexa\Contracts\Core\Repository\FieldTypeService;
 use JMS\TranslationBundle\Annotation\Desc;
 use Symfony\Component\Form\AbstractType;
@@ -49,6 +50,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
                 [
                     'label' => /** @Desc("URL") */ 'content.field_type.ezurl.link',
                     'required' => $options['required'],
+                    'default_protocol' => null,
                 ]
             )
             ->add(
@@ -60,6 +62,8 @@ public function buildForm(FormBuilderInterface $builder, array $options)
                 ]
             )
             ->addModelTransformer(new FieldValueTransformer($this->fieldTypeService->getFieldType('ezurl')));
+
+        $builder->get('link')->addEventSubscriber(new FixUrlProtocolListener());
     }
 
     public function configureOptions(OptionsResolver $resolver)

tests/lib/Form/EventSubscriber/FixUrlProtocolListenerTest.php

@@ -0,0 +1,101 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Tests\ContentForms\Form\EventSubscriber;
+
+use Ibexa\ContentForms\Form\EventSubscriber\FixUrlProtocolListener;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Form\FormEvent;
+use Symfony\Component\Form\FormInterface;
+
+final class FixUrlProtocolListenerTest extends TestCase
+{
+    private const DOMAIN = 'example.com';
+    private const MAIL = 'foo@' . self::DOMAIN;
+    private const TEL = '+123456';
+    private const URL_HTTP = 'http://' . self::DOMAIN;
+    private const URL_HTTPS = 'https://' . self::DOMAIN;
+    private const URL_MAILTO = 'mailto:' . self::MAIL;
+    private const URL_RELATIVE = '/foo/bar/';
+    private const URL_SFTP = 'sftp://' . self::DOMAIN;
+    private const URL_TEL = 'tel:' . self::TEL;
+
+    /**
+     * @dataProvider provideUrlCases
+     */
+    public function testUrlProtocolHandling(?string $inputData, ?string $expectedData, string $defaultProtocol = 'http'): void
+    {
+        $form = $this->createMock(FormInterface::class);
+        $listener = new FixUrlProtocolListener($defaultProtocol);
+
+        $event = new FormEvent($form, $inputData);
+
+        $listener->onSubmit($event);
+
+        self::assertSame($expectedData, $event->getData());
+    }
+
+    /**
+     * @return iterable<string, array{
+     *     0: string|null,
+     *     1: string|null,
+     *     2?: string
+     * }>
+     */
+    public static function provideUrlCases(): iterable
+    {
+        return [
+            'adds http when protocol missing' => [
+                self::DOMAIN,
+                self::URL_HTTP,
+            ],
+            'does not modify https url' => [
+                self::URL_HTTPS,
+                self::URL_HTTPS,
+            ],
+            'does not modify http url' => [
+                self::URL_HTTP,
+                self::URL_HTTP,
+            ],
+            'keep relative url with leading / intact' => [
+                self::URL_RELATIVE,
+                self::URL_RELATIVE,
+            ],
+            'keeps ftp intact' => [
+                self::URL_SFTP,
+                self::URL_SFTP,
+            ],
+            'keeps tel intact' => [
+                self::URL_TEL,
+                self::URL_TEL,
+            ],
+            'adds default tel' => [
+                self::TEL,
+                self::URL_TEL,
+                'tel',
+            ],
+            'keeps mailto intact' => [
+                self::URL_MAILTO,
+                self::URL_MAILTO,
+            ],
+            'adds default mailto' => [
+                self::MAIL,
+                self::URL_MAILTO,
+                'mailto',
+            ],
+            'does nothing when link is empty string' => [
+                '',
+                '',
+            ],
+            'does nothing when data is null' => [
+                null,
+                null,
+            ],
+        ];
+    }
+}