Mercurial > prosody-modules
changeset 4000:d56b3c0195a8
mod_muc_batched_probe: New module
author | JC Brand <jc@opkode.com> |
---|---|
date | Wed, 29 Apr 2020 13:00:22 +0200 |
parents | 22784f001b7f |
children | 0cb0605f3f38 845d13ab0dc0 |
files | mod_muc_batched_probe/README.markdown mod_muc_batched_probe/mod_muc_batched_probe.lua |
diffstat | 2 files changed, 84 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_muc_batched_probe/README.markdown Wed Apr 29 13:00:22 2020 +0200 @@ -0,0 +1,49 @@ +# mod_muc_batched_probe + +This module allows you to probe the presences of multiple MUC occupants or members. + +XEP-0045 makes provision for MUC presence probes, which allows an entity to +probe for the presence information of a MUC occupant (or offline member). + +See here: https://xmpp.org/extensions/xep-0045.html#bizrules-presence + +This module creates the possibility to probe with a single IQ stanza the +presence information of multiple JIDs, instead of having to send out a presence +probe stanza per JID. + +The IQ stanza needs to look as follows: + +``` + <iq from="hag66@shakespeare.lit/pda" + id="zb8q41f4" + to="chat.shakespeare.lit" + type="get"> + + <query xmlns="http://jabber.org/protocol/muc#user"> + <item jid="hecate@shakespeare.lit"/> + <item jid="crone1@shakespeare.lit"/> + <item jid="wiccarocks@shakespeare.lit"/> + <item jid="hag66@shakespeare.lit"/> + </query> + </iq> +``` + + + +## Configuration + +Under your MUC component, add `muc_batched_probe` to `modules_enabled` + +``` + Component "conference.example.org" "muc" + modules_enabled = { + "muc_batched_probe"; + } +``` + + +## Client Support + +Converse.js has a plugin which supports this feature. + +https://www.npmjs.com/package/@converse-plugins/muc-presence-probe
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_muc_batched_probe/mod_muc_batched_probe.lua Wed Apr 29 13:00:22 2020 +0200 @@ -0,0 +1,35 @@ +-- This module allows you to probe the MUC presences for multiple occupants. +-- Copyright (C) 2020 JC Brand + +local st = require "util.stanza"; +local mod_muc = module:depends"muc"; +local get_room_from_jid = rawget(mod_muc, "get_room_from_jid") or + function (jid) + local rooms = rawget(mod_muc, "rooms"); + return rooms[jid]; + end + +module:log("debug", "Module loaded"); + + +local function respondToBatchedProbe(event) + local stanza = event.stanza; + if stanza.attr.type ~= "get" then + return; + end + local query = stanza:get_child("query", "http://jabber.org/protocol/muc#user"); + if not query then + return; + end; + + local room = get_room_from_jid(stanza.attr.to); + for item in query.get_children() do + local probed_jid = item.attr.jid; + room:respond_to_probe(stanza.attr.from, probed_jid); + end + event.origin.send(st.reply(stanza)); + return true; +end + + +module:hook("iq/bare", respondToBatchedProbe, 1);