Software /
code /
prosody-modules
Changeset
4019:221b6bee26e2
mod_muc_local_only: New module to restrict a list of MUCs to local users
author | Matthew Wild <mwild1@gmail.com> |
---|---|
date | Wed, 13 May 2020 11:43:27 +0100 |
parents | 4018:f27becd421bd |
children | 4020:4b47c8eeca22 |
files | mod_muc_local_only/README.markdown mod_muc_local_only/mod_muc_local_only.lua |
diffstat | 2 files changed, 55 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_muc_local_only/README.markdown Wed May 13 11:43:27 2020 +0100 @@ -0,0 +1,36 @@ +# Introduction + +This module allows you to make one or more MUCs as accessible to local users only. + +# Details + +Local users (anyone on the same server as the MUC) are granted automatic +membership when they first join the room. Users from other servers are +denied access (even if the room is otherwise configured to be open). + +# Configuring + +## Enabling + +``` {.lua} +Component "rooms.example.net" "muc" +modules_enabled = { + "muc_local_only"; +} +``` + +## Settings + +Specify a list of MUCs in your config like so: + +``` +muc_local_only = { "my-local-chat@conference.example.com" } +``` + +# Compatibility + +Requires Prosody 0.11.0 or later. + +# Future + +It would be good to add a room configuration option.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_muc_local_only/mod_muc_local_only.lua Wed May 13 11:43:27 2020 +0100 @@ -0,0 +1,19 @@ +local jid = require "util.jid"; +local st = require "util.stanza"; + +local local_rooms = module:get_option_inherited_set("muc_local_only", {}); + +module:hook("muc-occupant-pre-join", function (event) + local room = event.room; + if not local_rooms:contains(room.jid) then + return; -- Not a protected room, ignore + end + local user_jid = event.occupant.bare_jid; + local user_host = jid.host(user_jid); + if not prosody.hosts[user_host] then + local error_reply = st.error_reply(event.stanza, "cancel", "forbidden", "This group is only available to local users", room.jid); + event.origin.send(error_reply); + return true; + end + room:set_affiliation(true, user_jid, "member", "Granting access to local user"); +end);