Re-add ability to convert OSM URLs into geo-uris

Author: ChaosKid42

CHANGES.md

@@ -8,6 +8,7 @@
 - Remove call to `api.confirm` in `@converse/headless`
 - Generate TypeScript declaration files into `dist/types`
 - #3156: Add function to prevent drag stutter effect over iframes when resize is called in overlay mode
+- #3161: Re-add ability to convert OpenStreetMap URLs into `geo:` URIs in sent messages
 
 - New config option [stanza_timeout](https://conversejs.org/docs/html/configuration.html#stanza-timeout)
 

docs/source/configuration.rst

@@ -934,9 +934,14 @@ logged in user, otherwise the user's vCard will be fetched.
 geouri_regex
 ------------
 
-* Default:  ``/https:\/\/www.openstreetmap.org\/.*#map=[0-9]+\/([\-0-9.]+)\/([\-0-9.]+)\S*/g``
+* Default:  ``undefined``
+
+Regular expression used to extract geo coordinates from links to OpenStreetMap and similar services.
+It allows to convert OpenStreetMap URLs into `geo:` URIs in sent messages.
+
+The default ``undefined`` means that no conversion is done.
 
-Regular expression used to extract geo coordinates from links to openstreetmap.
+E.g. ``/https\:\/\/www.openstreetmap.org\/.*#map=[0-9]+\/([\-0-9.]+)\/([\-0-9.]+)\S*/g``
 
 geouri_replacement
 ------------------

src/headless/plugins/chat/model.js

@@ -840,7 +840,7 @@ const ChatBox = ModelWithContact.extend({
         const is_spoiler = !!this.get('composing_spoiler');
         const origin_id = u.getUniqueId();
         const text = attrs?.body;
-        const body = text ? u.shortnamesToUnicode(text) : undefined;
+        const body = text ? u.httpToGeoUri(u.shortnamesToUnicode(text), _converse) : undefined;
         attrs = Object.assign({}, attrs, {
             'from': _converse.bare_jid,
             'fullname': _converse.xmppstatus.get('fullname'),

src/headless/plugins/muc/muc.js

@@ -1007,7 +1007,7 @@ const ChatRoomMixin = {
             [text, references] = this.parseTextForReferences(attrs.body);
         }
         const origin_id = getUniqueId();
-        const body = text ? u.shortnamesToUnicode(text) : undefined;
+        const body = text ? u.httpToGeoUri(u.shortnamesToUnicode(text), _converse) : undefined;
         attrs = Object.assign({}, attrs, {
             body,
             is_spoiler,

src/headless/shared/settings/constants.js

@@ -45,7 +45,7 @@ export const DEFAULT_SETTINGS = {
     connection_options: {},
     credentials_url: null, // URL from where login credentials can be fetched
     discover_connection_methods: true,
-    geouri_regex: /https\:\/\/www.openstreetmap.org\/.*#map=[0-9]+\/([\-0-9.]+)\/([\-0-9.]+)\S*/g,
+    geouri_regex: undefined,
     geouri_replacement: 'https://www.openstreetmap.org/?mlat=$1&mlon=$2#map=18/$1/$2',
     i18n: undefined,
     jid: undefined,

src/headless/utils/core.js

@@ -484,6 +484,11 @@ export function getUniqueId (suffix) {
     }
 }
 
+u.httpToGeoUri = function(text) {
+    const replacement = 'geo:$1,$2';
+    const geouri_regex = settings_api.get("geouri_regex");
+    return geouri_regex ? text.replace(geouri_regex, replacement) : text;
+};
 
 /**
  * Clears the specified timeout and interval.

src/plugins/chatview/tests/messages.js

@@ -280,6 +280,42 @@ describe("A Chat Message", function () {
             'mlon=-122.399677#map=18/37.786971/-122.399677">https://www.openstreetmap.org/?mlat=37.786971&amp;mlon=-122.399677#map=18/37.786971/-122.399677</a>');
     }));
 
+    it("will not render geo-URI from Openstreetmap-URL",
+            mock.initConverse(['chatBoxesFetched'], {}, async function (_converse) {
+
+        await mock.waitForRoster(_converse, 'current', 1);
+        const message = "https://www.openstreetmap.org/#map=18/68.24920/13.61230";
+        const contact_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
+        await mock.openChatBoxFor(_converse, contact_jid);
+        const view = _converse.chatboxviews.get(contact_jid);
+        spyOn(view.model, 'sendMessage').and.callThrough();
+        await mock.sendMessage(view, message);
+        await u.waitUntil(() => view.querySelectorAll('.chat-content .chat-msg').length, 1000);
+        expect(view.model.sendMessage).toHaveBeenCalled();
+        const msg = sizzle('.chat-content .chat-msg:last .chat-msg__text', view).pop();
+        await u.waitUntil(() => msg.innerHTML.replace(/\<!-.*?-\>/g, '') ===
+            '<a target="_blank" rel="noopener" href='+
+            '"https://www.openstreetmap.org/#map=18/68.24920/13.61230">https://www.openstreetmap.org/#map=18/68.24920/13.61230</a>');
+    }));
+
+    it("will render geo-URI from Openstreetmap-URL",
+            mock.initConverse(['chatBoxesFetched'], {'geouri_regex': /https\:\/\/www.openstreetmap.org\/.*#map=[0-9]+\/([\-0-9.]+)\/([\-0-9.]+)\S*/g},
+                async function (_converse) {
+
+        await mock.waitForRoster(_converse, 'current', 1);
+        const message = "https://www.openstreetmap.org/#map=18/68.24920/13.61230";
+        const contact_jid = mock.cur_names[0].replace(/ /g,'.').toLowerCase() + '@montague.lit';
+        await mock.openChatBoxFor(_converse, contact_jid);
+        const view = _converse.chatboxviews.get(contact_jid);
+        spyOn(view.model, 'sendMessage').and.callThrough();
+        await mock.sendMessage(view, message);
+        await u.waitUntil(() => view.querySelectorAll('.chat-content .chat-msg').length, 1000);
+        expect(view.model.sendMessage).toHaveBeenCalled();
+        const msg = sizzle('.chat-content .chat-msg:last .chat-msg__text', view).pop();
+        await u.waitUntil(() => msg.innerHTML.replace(/\<!-.*?-\>/g, '') ===
+            'geo:68.24920,13.61230');
+    }));
+
     it("can be a carbon message, as defined in XEP-0280",
             mock.initConverse([], {}, async function (_converse) {