Comparison

mod_muc_markers/mod_muc_markers.lua @ 3972:45c5603a6c07

mod_muc_markers: New module for server-side receipt tracking in MUCs
author Matthew Wild <mwild1@gmail.com>
date Mon, 13 Apr 2020 15:48:58 +0100
child 4024:95882b487ed2
comparison
equal deleted inserted replaced
3971:ae5ac41c391d 3972:45c5603a6c07
1 -- Track messages received by users of the MUC
2
3 -- We rewrite the 'id' attribute of outgoing stanzas to match the stanza (archive) id
4 -- This module is therefore incompatible with the muc#stable_id feature
5 -- We rewrite the id because XEP-0333 doesn't tell clients explicitly which id to use
6 -- in marker reports. However it implies the 'id' attribute through examples, and this
7 -- is what some clients implement.
8 -- Notably Conversations will ack the origin-id instead. We need to update the XEP to
9 -- clarify the correct behaviour.
10
11 local xmlns_markers = "urn:xmpp:chat-markers:0";
12
13 local muc_marker_map_store = module:open_store("muc_markers", "map");
14
15 local function get_stanza_id(stanza, by_jid)
16 for tag in stanza:childtags("stanza-id", "urn:xmpp:sid:0") do
17 if tag.attr.by == by_jid then
18 return tag.attr.id;
19 end
20 end
21 return nil;
22 end
23
24 module:hook("muc-broadcast-message", function (event)
25 local stanza = event.stanza;
26
27 local archive_id = get_stanza_id(stanza, event.room.jid);
28 -- We are not interested in stanzas that didn't get archived
29 if not archive_id then return; end
30
31 -- Add stanza id as id attribute
32 stanza.attr.id = archive_id;
33 -- Add markable element to request markers from clients
34 stanza:tag("markable", { xmlns = xmlns_markers }):up();
35 end, -1);
36
37 module:hook("muc-occupant-groupchat", function (event)
38 local marker = event.stanza:get_child("received", xmlns_markers);
39 if not marker then return; end
40
41 -- Store the id that the user has received to
42 module:log("warn", "New marker for %s: %s", event.occupant.bare_jid, marker.attr.id);
43 muc_marker_map_store:set(event.occupant.bare_jid, event.room.jid, marker.attr.id);
44
45 -- Prevent stanza from reaching the room (it's just noise)
46 return true;
47 end);
48
49 -- Public API
50
51 function get_user_read_marker(user_jid, room_jid)
52 return muc_marker_map_store:get(user_jid, room_jid);
53 end