view mod_track_muc_joins/README.markdown @ 4954:e8a487c42b36 default tip

merge upstream
author Goffi <goffi@goffi.org>
date Sat, 28 May 2022 16:43:04 +0200
parents e327b06b9a1b
children
line wrap: on
line source

---
summary: Keep track of joined chat rooms
...

# Introduction

This module attempts to keep track of what MUC chat rooms users have
joined. It's not very useful on its own, but can be used by other
modules to influence decisions.

# Usage

Rooms joined and the associated nickname is kept in a table field
`rooms_joined` on the users session.

An example:

``` lua
local jid_bare = require"util.jid".bare;

module:hook("message/full", function (event)
    local stanza = event.stanza;
    local session = prosody.full_sessions[stanza.attr.to];
    if not session then
        return -- No such session
    end

    local joined_rooms = session.joined_rooms;
    if not joined_rooms then
        return -- This session hasn't joined any rooms at all
    end

    -- joined_rooms is a map of room JID -> room nickname
    local nickname = joined_rooms[jid_bare(stanza.attr.from)];
    if nickname then
        session.log("info", "Got a MUC message from %s", stanza.attr.from);

        local body = stanza:get_child_text("body");
        if body and body:find(nickname, 1, true) then
            session.log("info", "The message contains my nickname!");
        end
    end
end);
```

# Known issues

[XEP 45 ยง 7.2.3 Presence Broadcast][enter-pres] has the following text:

> In particular, if roomnicks are locked down then the service MUST do
> one of the following.
>
> \[...\]
>
> If the user has connected using a MUC client (...), then the service
> MUST allow the client to enter the room, modify the nick in accordance
> with the lockdown policy, and **include a status code of "210"** in
> the presence broadcast that it sends to the new occupant.

This case is not yet handled.

[enter-pres]: http://xmpp.org/extensions/xep-0045.html#enter-pres