File

mod_muc_batched_probe/README.markdown @ 5173:460f78654864

mod_muc_rtbl: also filter messages This was a bit tricky because we don't want to run the JIDs through SHA256 on each message. Took a while to come up with this simple plan of just caching the SHA256 of the JIDs on the occupants. This will leave some dirt in the occupants after unloading the module, but that should be ok; once they cycle the room, the hashes will be gone. This is direly needed, otherwise, there is a tight race between the moderation activities and the actors joining the room.
author Jonas Schäfer <jonas@wielicki.name>
date Tue, 21 Feb 2023 21:37:27 +0100
parent 4000:d56b3c0195a8
line wrap: on
line source

# 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