From ec0c3e612ab7e9fc9d0cf09486db572783996a3b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=98yvind=20R=C3=B8nningstad?= <ronningstad@gmail.com>
Date: Sat, 13 Jan 2024 22:15:39 +0100
Subject: [PATCH] Introduce linkRegExpHandlers
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

A map of capture groups to functions for producing the href of a
link. By default, it is e.g. used to prepend https:// to links
matching on www. so they are not interpreted as relative.
The user can add their own handlers if modifying linkRegExp.

Signed-off-by: Øyvind Rønningstad <ronningstad@gmail.com>
---
 README.md           |  6 +++++-
 source/Editor.ts    | 17 +++++++++--------
 test/squire.spec.ts |  4 ++++
 3 files changed, 18 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index a42f94e..89e5e8b 100644
--- a/README.md
+++ b/README.md
@@ -475,4 +475,8 @@ This is useful when the document needs to be changed programmatically, but those
 
 ### linkRegExp
 
-This is the regular expression used to automatically mark up links when inserting HTML or after pressing space. You can change it if you want to use a custom regular expression for detecting links, or set to `/[]/` to turn off link detection. To append to the existing regex, set it to `linkRegExp.source + '|' + newLinkRegExp`.
+This is the regular expression used to automatically mark up links when inserting HTML or after pressing space. You can change it if you want to use a custom regular expression for detecting links, or set to `/[]/` to turn off link detection. To append to the existing regex, set it to `linkRegExp.source + '|' + newLinkRegExp`. For compatibility with linkRegExpHandlers use named capture groups (`?<name>`).
+
+### linkRegExpHandlers
+
+This is a map of handlers for different types of matches in linkRegExp. For example, linkRegExp has a named group 'url' that matches urls, and a named group 'email' that matches emails. linkRegExpHandler['url'] and linkRegExpHandler['email'] are functions that take in the matching string and returns what the link should have in its 'href'.
diff --git a/source/Editor.ts b/source/Editor.ts
index cbc0b3f..c97ba76 100644
--- a/source/Editor.ts
+++ b/source/Editor.ts
@@ -1789,7 +1789,11 @@ class Squire {
     */
     linkRegExp =
         /\b(?:(?<url>(?:(?:[a-z+]+:)?\/\/|www\d{0,3}[.]|[a-z0-9][a-z0-9.\-]*[.][a-z]{2,}\/)(?:[^\s()<>]+|\([^\s()<>]+\))+(?:[^\s?&`!()\[\]{};:'".,<>«»“”‘’]|\([^\s()<>]+\)))|(?<email>[\w\-.%+]+@(?:[\w\-]+\.)+[a-z]{2,}\b(?:[?][^&?\s]+=[^\s?&`!()\[\]{};:'".,<>«»“”‘’]+(?:&[^&?\s]+=[^\s?&`!()\[\]{};:'".,<>«»“”‘’]+)*)?))/i;
-    linkRegExpHandlers = {}
+    linkRegExpHandlers = {
+        'url': (m) => {return /^(?:[a-z+]+:)?\/\//i.test(m)
+                                ? m : 'https://' + m},
+        'email': (m) => {return 'mailto:' + m},
+        'default': (m) => {return m}};
     addDetectedLinks(
         searchInNode: DocumentFragment | Node,
         root?: DocumentFragment | HTMLElement,
@@ -1815,17 +1819,14 @@ class Squire {
                         node,
                     );
                 }
+                let handler = Object.keys(this.linkRegExpHandlers).filter(
+                    key => Object.keys(match.groups).includes(key) && match.groups[key])[0]
+                    || 'default';
                 const child = createElement(
                     'A',
                     Object.assign(
                         {
-                            href: match.groups['url']
-                                ? /^(?:[a-z+]+:)?\/\//i.test(match[0])
-                                    ? match[0]
-                                    : 'https://' + match[0]
-                                : match.groups['email']
-                                ? 'mailto:' + match[0]
-                                : match[0],
+                            href: this.linkRegExpHandlers[handler](match[0])
                         },
                         defaultAttributes,
                     ),
diff --git a/test/squire.spec.ts b/test/squire.spec.ts
index 7fbc2bf..38f7251 100644
--- a/test/squire.spec.ts
+++ b/test/squire.spec.ts
@@ -487,10 +487,14 @@ describe('Squire RTE', () => {
             'https://google.com?a=b&c=d&e=': 'https://google.com/?a=b&c=d&e=',
             'https://google.com?a=b&c=d&e=f': 'https://google.com/?a=b&c=d&e=f',
             'www.google.com': 'https://www.google.com/', // Test prepending protocol
+            'foobar': 'http://localhost/foobar', // Test default handler
+            'search': 'http://localhost/replace', // Test custom handler
         };
 
         Object.keys(LINK_MAP).forEach((input) => {
             it('should auto convert links to anchor: ' + input, () => {
+                editor.linkRegExp = new RegExp(editor.linkRegExp.source + "|(foobar)|(?<extra>search)", editor.linkRegExp.flags);
+                editor.linkRegExpHandlers['extra'] = (m) => {return 'replace'};
                 editor.insertHTML(input);
                 const link = document.querySelector('a')!;
                 expect(link.href).toBe(LINK_MAP[input]);