Adding support for the XEP-0147 (Protocol handler)

Author: marcellintacite

src/headless/plugins/chat/utils.js

@@ -22,16 +22,7 @@ export function routeToChat (event) {
         return;
     }
     event?.preventDefault();
-    let jid = location.hash.split('=').pop();
-    // decodeURIComponent is needed in case the JID contains special characters
-    // that were URL-encoded, e.g. `user%40domain` instead of `user@domain`.
-    jid = decodeURIComponent(jid);
-
-    // Remove xmpp: prefix if present
-    if (jid.startsWith('xmpp:')) {
-        jid = jid.slice(5);
-    }
-    
+    const jid = location.hash.split('=').pop();
     if (!u.isValidJID(jid)) {
         return log.warn(`Invalid JID "${jid}" provided in URL fragment`);
     }

src/plugins/chatview/index.js

@@ -8,7 +8,7 @@ import 'shared/chat/help-messages.js';
 import 'shared/chat/toolbar.js';
 import ChatView from './chat.js';
 import { _converse, api, converse } from '@converse/headless';
-import { clearHistory } from './utils.js';
+import { clearHistory,routeToQueryAction } from './utils.js';
 
 import './styles/index.scss';
 
@@ -66,13 +66,14 @@ converse.plugins.add('converse-chatview', {
         Object.assign(_converse.exports, exports);
 
         if ('registerProtocolHandler' in navigator) {
-        try {
-            const handlerUrl = `${window.location.origin}${window.location.pathname}#converse/chat?jid=%s`;
-            navigator.registerProtocolHandler('xmpp', handlerUrl);
-        } catch (error) {
-            console.warn('Failed to register protocol handler:', error);
+            try {
+                const handlerUrl = `${window.location.origin}${window.location.pathname}#converse/action?uri=%s`;
+                navigator.registerProtocolHandler('xmpp', handlerUrl);
+            } catch (error) {
+                console.warn('Failed to register protocol handler:', error);
+            }
         }
-    }
+        routeToQueryAction();
         api.listen.on('connected', () => api.disco.own.features.add(Strophe.NS.SPOILER));
         api.listen.on('chatBoxClosed', (model) => clearHistory(model.get('jid')));
     }

src/plugins/chatview/utils.js

@@ -1,5 +1,7 @@
 import { __ } from 'i18n';
 import { _converse, api } from '@converse/headless';
+import log from "@converse/log";
+
 
 export function clearHistory (jid) {
     if (location.hash === `converse/chat?jid=${jid}`) {
@@ -71,3 +73,121 @@ export function resetElementHeight (ev) {
         ev.target.style = '';
     }
 }
+
+
+/**
+ * Handle XEP-0147 "query actions" invoked via xmpp: URIs.
+ * Supports message sending, roster management, and future actions.
+ *
+ * Example URIs:
+ *   xmpp:user@example.com?action=message&body=Hello
+ *   xmpp:user@example.com?action=add-roster&name=John&group=Friends
+ */
+export async function routeToQueryAction(event) {
+    const { u } = _converse.env;
+
+    try {
+        const uri = extractXMPPURI(event);
+        if (!uri) return;
+
+        const { jid, queryParams } = parseXMPPURI(uri);
+        if (!u.isValidJID(jid)) {
+            return log.warn(`Invalid JID: "${jid}"`);
+        }
+
+        const action = queryParams.get('action');
+        if (!action) {
+            log.debug(`No action specified, opening chat for "${jid}"`);
+            return api.chats.open(jid);
+        }
+
+        switch (action) {
+            case 'message':
+                await handleMessageAction(jid, queryParams);
+                break;
+
+            case 'add-roster':
+                await handleRosterAction(jid, queryParams);
+                break;
+
+            default:
+                log.warn(`Unsupported XEP-0147 action: "${action}"`);
+                await api.chats.open(jid);
+        }
+    } catch (error) {
+        log.error('Failed to process XMPP query action:', error);
+    }
+}
+
+/**
+ * Extracts and decodes the xmpp: URI from the window location or hash.
+ */
+function extractXMPPURI(event) {
+    let uri = null;
+
+    // Case 1: protocol handler (?uri=...)
+    const searchParams = new URLSearchParams(window.location.search);
+    uri = searchParams.get('uri');
+
+    // Case 2: hash-based (#converse/action?uri=...)
+    if (!uri && location.hash.startsWith('#converse/action?uri=')) {
+        event?.preventDefault();
+        uri = location.hash.split('uri=').pop();
+    }
+
+    if (!uri) return null;
+
+    // Decode URI and remove xmpp: prefix
+    uri = decodeURIComponent(uri);
+    if (uri.startsWith('xmpp:')) uri = uri.slice(5);
+
+    // Clean up URL (remove ?uri=... for a clean view)
+    const cleanUrl = `${window.location.origin}${window.location.pathname}`;
+    window.history.replaceState({}, document.title, cleanUrl);
+
+    return uri;
+}
+
+/**
+ * Splits an xmpp: URI into a JID and query parameters.
+ */
+function parseXMPPURI(uri) {
+    const [jid, query] = uri.split('?');
+    const queryParams = new URLSearchParams(query);
+    return { jid, queryParams };
+}
+
+/**
+ * Handles the `action=message` case.
+ */
+async function handleMessageAction(jid, params) {
+    const body = params.get('body') || '';
+    const chat = await api.chats.open(jid);
+
+    if (body && chat) {
+        await chat.sendMessage({ body });
+    }
+}
+
+/**
+ * Handles the `action=add-roster` case.
+ */
+async function handleRosterAction(jid, params) {
+    await api.waitUntil('connected');
+    await api.waitUntil('rosterContactsFetched');
+
+    const name = params.get('name') || jid.split('@')[0];
+    const group = params.get('group');
+    const groups = group ? [group] : [];
+
+    try {
+        await api.contacts.add(
+            { jid, name, groups },
+            true,   // persist on server
+            true,   // subscribe to presence
+            ''      // no custom message
+        );
+    } catch (err) {
+        log.error(`Failed to add "${jid}" to roster:`, err);
+    }
+}