aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/muc
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/muc')
-rw-r--r--plugins/muc/affiliation_notify.lib.lua64
-rw-r--r--plugins/muc/description.lib.lua41
-rw-r--r--plugins/muc/hidden.lib.lua43
-rw-r--r--plugins/muc/history.lib.lua204
-rw-r--r--plugins/muc/lock.lib.lua62
-rw-r--r--plugins/muc/members_only.lib.lua128
-rw-r--r--plugins/muc/mod_muc.lua550
-rw-r--r--plugins/muc/moderated.lib.lua51
-rw-r--r--plugins/muc/muc.lib.lua2345
-rw-r--r--plugins/muc/name.lib.lua45
-rw-r--r--plugins/muc/occupant.lib.lua85
-rw-r--r--plugins/muc/password.lib.lua70
-rw-r--r--plugins/muc/persistent.lib.lua47
-rw-r--r--plugins/muc/subject.lib.lua101
-rw-r--r--plugins/muc/util.lib.lua58
-rw-r--r--plugins/muc/whois.lib.lua65
16 files changed, 2611 insertions, 1348 deletions
diff --git a/plugins/muc/affiliation_notify.lib.lua b/plugins/muc/affiliation_notify.lib.lua
new file mode 100644
index 00000000..4343f3db
--- /dev/null
+++ b/plugins/muc/affiliation_notify.lib.lua
@@ -0,0 +1,64 @@
+-- Prosody IM
+-- Copyright (C) 2014 Daurnimator
+--
+-- This project is MIT/X11 licensed. Please see the
+-- COPYING file in the source package for more information.
+--
+
+--[[
+Out of courtesy, a MUC service MAY send an out-of-room <message/>
+if a user's affiliation changes while the user is not in the room;
+the message SHOULD be sent from the room to the user's bare JID,
+MAY contain a <body/> element describing the affiliation change,
+and MUST contain a status code of 101.
+]]
+
+
+local st = require "util.stanza";
+
+local function get_affiliation_notify(room)
+ return room._data.affiliation_notify;
+end
+
+local function set_affiliation_notify(room, affiliation_notify)
+ affiliation_notify = affiliation_notify and true or nil;
+ if room._data.affiliation_notify == affiliation_notify then return false; end
+ room._data.affiliation_notify = affiliation_notify;
+ return true;
+end
+
+module:hook("muc-config-form", function(event)
+ table.insert(event.form, {
+ name = "muc#roomconfig_affiliationnotify";
+ type = "boolean";
+ label = "Notify absent users when their affiliation changes?";
+ value = get_affiliation_notify(event.room);
+ });
+end, 100-11);
+
+module:hook("muc-config-submitted/muc#roomconfig_affiliationnotify", function(event)
+ if set_affiliation_notify(event.room, event.value) then
+ event.status_codes["104"] = true;
+ end
+end);
+
+module:hook("muc-set-affiliation", function(event)
+ local room = event.room;
+ if not event.in_room and get_affiliation_notify(room) then
+ local body = string.format("Your affiliation in room %s is now %s.", room.jid, event.affiliation);
+ local stanza = st.message({
+ type = "headline";
+ from = room.jid;
+ to = event.jid;
+ }, body)
+ :tag("x", {xmlns = "http://jabber.org/protocol/muc#user"})
+ :tag("status", {code="101"}):up()
+ :up();
+ room:route_stanza(stanza);
+ end
+end);
+
+return {
+ get = get_affiliation_notify;
+ set = set_affiliation_notify;
+};
diff --git a/plugins/muc/description.lib.lua b/plugins/muc/description.lib.lua
new file mode 100644
index 00000000..d4bc1a71
--- /dev/null
+++ b/plugins/muc/description.lib.lua
@@ -0,0 +1,41 @@
+-- Prosody IM
+-- Copyright (C) 2008-2010 Matthew Wild
+-- Copyright (C) 2008-2010 Waqas Hussain
+-- Copyright (C) 2014 Daurnimator
+--
+-- This project is MIT/X11 licensed. Please see the
+-- COPYING file in the source package for more information.
+--
+
+local function get_description(room)
+ return room._data.description;
+end
+
+local function set_description(room, description)
+ if description == "" then description = nil; end
+ if get_description(room) == description then return false; end
+ room._data.description = description;
+ return true;
+end
+
+local function add_form_option(event)
+ table.insert(event.form, {
+ name = "muc#roomconfig_roomdesc";
+ type = "text-single";
+ label = "Description";
+ value = get_description(event.room) or "";
+ });
+end
+module:hook("muc-disco#info", add_form_option);
+module:hook("muc-config-form", add_form_option, 100-2);
+
+module:hook("muc-config-submitted/muc#roomconfig_roomdesc", function(event)
+ if set_description(event.room, event.value) then
+ event.status_codes["104"] = true;
+ end
+end);
+
+return {
+ get = get_description;
+ set = set_description;
+};
diff --git a/plugins/muc/hidden.lib.lua b/plugins/muc/hidden.lib.lua
new file mode 100644
index 00000000..b2fe6216
--- /dev/null
+++ b/plugins/muc/hidden.lib.lua
@@ -0,0 +1,43 @@
+-- Prosody IM
+-- Copyright (C) 2008-2010 Matthew Wild
+-- Copyright (C) 2008-2010 Waqas Hussain
+-- Copyright (C) 2014 Daurnimator
+--
+-- This project is MIT/X11 licensed. Please see the
+-- COPYING file in the source package for more information.
+--
+
+local function get_hidden(room)
+ return room._data.hidden;
+end
+
+local function set_hidden(room, hidden)
+ hidden = hidden and true or nil;
+ if get_hidden(room) == hidden then return false; end
+ room._data.hidden = hidden;
+ return true;
+end
+
+module:hook("muc-config-form", function(event)
+ table.insert(event.form, {
+ name = "muc#roomconfig_publicroom";
+ type = "boolean";
+ label = "Make Room Publicly Searchable?";
+ value = not get_hidden(event.room);
+ });
+end, 100-5);
+
+module:hook("muc-config-submitted/muc#roomconfig_publicroom", function(event)
+ if set_hidden(event.room, not event.value) then
+ event.status_codes["104"] = true;
+ end
+end);
+
+module:hook("muc-disco#info", function(event)
+ event.reply:tag("feature", {var = get_hidden(event.room) and "muc_hidden" or "muc_public"}):up();
+end);
+
+return {
+ get = get_hidden;
+ set = set_hidden;
+};
diff --git a/plugins/muc/history.lib.lua b/plugins/muc/history.lib.lua
new file mode 100644
index 00000000..100ab720
--- /dev/null
+++ b/plugins/muc/history.lib.lua
@@ -0,0 +1,204 @@
+-- Prosody IM
+-- Copyright (C) 2008-2010 Matthew Wild
+-- Copyright (C) 2008-2010 Waqas Hussain
+-- Copyright (C) 2014 Daurnimator
+--
+-- This project is MIT/X11 licensed. Please see the
+-- COPYING file in the source package for more information.
+--
+
+local gettime = os.time;
+local datetime = require "util.datetime";
+local st = require "util.stanza";
+
+local default_history_length = 20;
+local max_history_length = module:get_option_number("max_history_messages", math.huge);
+
+local function set_max_history_length(_max_history_length)
+ max_history_length = _max_history_length or math.huge;
+end
+
+local function get_historylength(room)
+ return math.min(room._data.history_length or default_history_length, max_history_length);
+end
+
+local function set_historylength(room, length)
+ if length then
+ length = assert(tonumber(length), "Length not a valid number");
+ end
+ if length == default_history_length then length = nil; end
+ room._data.history_length = length;
+ return true;
+end
+
+-- Fix for clients who don't support XEP-0045 correctly
+-- Default number of history messages the room returns
+local function get_defaulthistorymessages(room)
+ return room._data.default_history_messages or default_history_length;
+end
+local function set_defaulthistorymessages(room, number)
+ number = math.min(tonumber(number) or default_history_length, room._data.history_length or default_history_length);
+ if number == default_history_length then
+ number = nil;
+ end
+ room._data.default_history_messages = number;
+end
+
+module:hook("muc-config-form", function(event)
+ table.insert(event.form, {
+ name = "muc#roomconfig_historylength";
+ type = "text-single";
+ label = "Maximum Number of History Messages Returned by Room";
+ value = tostring(get_historylength(event.room));
+ });
+ table.insert(event.form, {
+ name = 'muc#roomconfig_defaulthistorymessages',
+ type = 'text-single',
+ label = 'Default Number of History Messages Returned by Room',
+ value = tostring(get_defaulthistorymessages(event.room))
+ });
+end, 100-10);
+
+module:hook("muc-config-submitted/muc#roomconfig_historylength", function(event)
+ if set_historylength(event.room, event.value) then
+ event.status_codes["104"] = true;
+ end
+end);
+
+module:hook("muc-config-submitted/muc#roomconfig_defaulthistorymessages", function(event)
+ if set_defaulthistorymessages(event.room, event.value) then
+ event.status_codes["104"] = true;
+ end
+end);
+
+local function parse_history(stanza)
+ local x_tag = stanza:get_child("x", "http://jabber.org/protocol/muc");
+ local history_tag = x_tag and x_tag:get_child("history", "http://jabber.org/protocol/muc");
+ if not history_tag then
+ return nil, nil, nil;
+ end
+
+ local maxchars = tonumber(history_tag.attr.maxchars);
+
+ local maxstanzas = tonumber(history_tag.attr.maxstanzas);
+
+ -- messages received since the UTC datetime specified
+ local since = history_tag.attr.since;
+ if since then
+ since = datetime.parse(since);
+ end
+
+ -- messages received in the last "X" seconds.
+ local seconds = tonumber(history_tag.attr.seconds);
+ if seconds then
+ seconds = gettime() - seconds;
+ if since then
+ since = math.max(since, seconds);
+ else
+ since = seconds;
+ end
+ end
+
+ return maxchars, maxstanzas, since;
+end
+
+module:hook("muc-get-history", function(event)
+ local room = event.room;
+ local history = room._history; -- send discussion history
+ if not history then return nil end
+ local history_len = #history;
+
+ local to = event.to;
+ local maxchars = event.maxchars;
+ local maxstanzas = event.maxstanzas or history_len;
+ local since = event.since;
+ local n = 0;
+ local charcount = 0;
+ for i=history_len,1,-1 do
+ local entry = history[i];
+ if maxchars then
+ if not entry.chars then
+ entry.stanza.attr.to = "";
+ entry.chars = #tostring(entry.stanza);
+ end
+ charcount = charcount + entry.chars + #to;
+ if charcount > maxchars then break; end
+ end
+ if since and since > entry.timestamp then break; end
+ if n + 1 > maxstanzas then break; end
+ n = n + 1;
+ end
+
+ local i = history_len-n+1
+ function event.next_stanza()
+ if i > history_len then return nil end
+ local entry = history[i];
+ local msg = entry.stanza;
+ msg.attr.to = to;
+ i = i + 1;
+ return msg;
+ end
+ return true;
+end, -1);
+
+local function send_history(room, stanza)
+ local maxchars, maxstanzas, since = parse_history(stanza);
+ if not(maxchars or maxstanzas or since) then
+ maxstanzas = get_defaulthistorymessages(room);
+ end
+ local event = {
+ room = room;
+ stanza = stanza;
+ to = stanza.attr.from; -- `to` is required to calculate the character count for `maxchars`
+ maxchars = maxchars,
+ maxstanzas = maxstanzas,
+ since = since;
+ next_stanza = function() end; -- events should define this iterator
+ };
+ module:fire_event("muc-get-history", event);
+ for msg in event.next_stanza, event do
+ room:route_stanza(msg);
+ end
+end
+
+-- Send history on join
+module:hook("muc-occupant-session-new", function(event)
+ send_history(event.room, event.stanza);
+end, 50); -- Before subject(20)
+
+-- add to history
+module:hook("muc-add-history", function(event)
+ local room = event.room
+ local history = room._history;
+ if not history then history = {}; room._history = history; end
+ local stanza = st.clone(event.stanza);
+ stanza.attr.to = "";
+ local ts = gettime();
+ local stamp = datetime.datetime(ts);
+ stanza:tag("delay", {xmlns = "urn:xmpp:delay", from = module.host, stamp = stamp}):up(); -- XEP-0203
+ stanza:tag("x", {xmlns = "jabber:x:delay", from = module.host, stamp = datetime.legacy()}):up(); -- XEP-0091 (deprecated)
+ local entry = { stanza = stanza, timestamp = ts };
+ table.insert(history, entry);
+ while #history > get_historylength(room) do table.remove(history, 1) end
+ return true;
+end, -1);
+
+-- Have a single muc-add-history event, so that plugins can mark it
+-- as handled without stopping other muc-broadcast-message handlers
+module:hook("muc-broadcast-message", function(event)
+ if module:fire_event("muc-message-is-historic", event) then
+ module:fire_event("muc-add-history", event);
+ end
+end);
+
+module:hook("muc-message-is-historic", function (event)
+ return event.stanza:get_child("body");
+end, -1);
+
+return {
+ set_max_length = set_max_history_length;
+ parse_history = parse_history;
+ send = send_history;
+ get_length = get_historylength;
+ set_length = set_historylength;
+};
diff --git a/plugins/muc/lock.lib.lua b/plugins/muc/lock.lib.lua
new file mode 100644
index 00000000..764142db
--- /dev/null
+++ b/plugins/muc/lock.lib.lua
@@ -0,0 +1,62 @@
+-- Prosody IM
+-- Copyright (C) 2008-2010 Matthew Wild
+-- Copyright (C) 2008-2010 Waqas Hussain
+-- Copyright (C) 2014 Daurnimator
+--
+-- This project is MIT/X11 licensed. Please see the
+-- COPYING file in the source package for more information.
+--
+
+local st = require "util.stanza";
+
+local lock_rooms = module:get_option_boolean("muc_room_locking", false);
+local lock_room_timeout = module:get_option_number("muc_room_lock_timeout", 300);
+
+local function lock(room)
+ module:fire_event("muc-room-locked", {room = room;});
+ room._data.locked = os.time() + lock_room_timeout;
+end
+local function unlock(room)
+ module:fire_event("muc-room-unlocked", {room = room;});
+ room._data.locked = nil;
+end
+local function is_locked(room)
+ local ts = room._data.locked;
+ if ts then
+ if os.time() < ts then return true; end
+ unlock(room);
+ end
+ return false;
+end
+
+if lock_rooms then
+ module:hook("muc-room-pre-create", function(event)
+ -- Older groupchat protocol doesn't lock
+ if not event.stanza:get_child("x", "http://jabber.org/protocol/muc") then return end
+ -- Lock room at creation
+ local room = event.room;
+ lock(room);
+ end, 10);
+end
+
+-- Don't let users into room while it is locked
+module:hook("muc-occupant-pre-join", function(event)
+ if not event.is_new_room and is_locked(event.room) then -- Deny entry
+ module:log("debug", "Room is locked, denying entry");
+ event.origin.send(st.error_reply(event.stanza, "cancel", "item-not-found"));
+ return true;
+ end
+end, -30);
+
+-- When config is submitted; unlock the room
+module:hook("muc-config-submitted", function(event)
+ if is_locked(event.room) then
+ unlock(event.room);
+ end
+end, -1);
+
+return {
+ lock = lock;
+ unlock = unlock;
+ is_locked = is_locked;
+};
diff --git a/plugins/muc/members_only.lib.lua b/plugins/muc/members_only.lib.lua
new file mode 100644
index 00000000..1e5e6a56
--- /dev/null
+++ b/plugins/muc/members_only.lib.lua
@@ -0,0 +1,128 @@
+-- Prosody IM
+-- Copyright (C) 2008-2010 Matthew Wild
+-- Copyright (C) 2008-2010 Waqas Hussain
+-- Copyright (C) 2014 Daurnimator
+--
+-- This project is MIT/X11 licensed. Please see the
+-- COPYING file in the source package for more information.
+--
+
+local st = require "util.stanza";
+
+local muc_util = module:require "muc/util";
+local valid_affiliations = muc_util.valid_affiliations;
+
+local function get_members_only(room)
+ return room._data.members_only;
+end
+
+local function set_members_only(room, members_only)
+ members_only = members_only and true or nil;
+ if room._data.members_only == members_only then return false; end
+ room._data.members_only = members_only;
+ if members_only then
+ --[[
+ If as a result of a change in the room configuration the room type is
+ changed to members-only but there are non-members in the room,
+ the service MUST remove any non-members from the room and include a
+ status code of 322 in the presence unavailable stanzas sent to those users
+ as well as any remaining occupants.
+ ]]
+ local occupants_changed = {};
+ for _, occupant in room:each_occupant() do
+ local affiliation = room:get_affiliation(occupant.bare_jid);
+ if valid_affiliations[affiliation or "none"] <= valid_affiliations.none then
+ occupant.role = nil;
+ room:save_occupant(occupant);
+ occupants_changed[occupant] = true;
+ end
+ end
+ local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"})
+ :tag("status", {code="322"}):up();
+ for occupant in pairs(occupants_changed) do
+ room:publicise_occupant_status(occupant, x);
+ module:fire_event("muc-occupant-left", {room = room; nick = occupant.nick; occupant = occupant;});
+ end
+ end
+ return true;
+end
+
+module:hook("muc-disco#info", function(event)
+ event.reply:tag("feature", {var = get_members_only(event.room) and "muc_membersonly" or "muc_open"}):up();
+end);
+
+module:hook("muc-config-form", function(event)
+ table.insert(event.form, {
+ name = "muc#roomconfig_membersonly";
+ type = "boolean";
+ label = "Make Room Members-Only?";
+ value = get_members_only(event.room);
+ });
+end, 100-6);
+
+module:hook("muc-config-submitted/muc#roomconfig_membersonly", function(event)
+ if set_members_only(event.room, event.value) then
+ event.status_codes["104"] = true;
+ end
+end);
+
+-- No affiliation => role of "none"
+module:hook("muc-get-default-role", function(event)
+ if not event.affiliation and get_members_only(event.room) then
+ return false;
+ end
+end);
+
+-- registration required for entering members-only room
+module:hook("muc-occupant-pre-join", function(event)
+ local room = event.room;
+ if get_members_only(room) then
+ local stanza = event.stanza;
+ local affiliation = room:get_affiliation(stanza.attr.from);
+ if valid_affiliations[affiliation or "none"] <= valid_affiliations.none then
+ local reply = st.error_reply(stanza, "auth", "registration-required"):up();
+ reply.tags[1].attr.code = "407";
+ event.origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
+ return true;
+ end
+ end
+end, -5);
+
+-- Invitation privileges in members-only rooms SHOULD be restricted to room admins;
+-- if a member without privileges to edit the member list attempts to invite another user
+-- the service SHOULD return a <forbidden/> error to the occupant
+module:hook("muc-pre-invite", function(event)
+ local room = event.room;
+ if get_members_only(room) then
+ local stanza = event.stanza;
+ local affiliation = room:get_affiliation(stanza.attr.from);
+ if valid_affiliations[affiliation or "none"] < valid_affiliations.admin then
+ event.origin.send(st.error_reply(stanza, "auth", "forbidden"));
+ return true;
+ end
+ end
+end);
+
+-- When an invite is sent; add an affiliation for the invitee
+module:hook("muc-invite", function(event)
+ local room = event.room;
+ if get_members_only(room) then
+ local stanza = event.stanza;
+ local invitee = stanza.attr.to;
+ local affiliation = room:get_affiliation(invitee);
+ if valid_affiliations[affiliation or "none"] <= valid_affiliations.none then
+ local from = stanza:get_child("x", "http://jabber.org/protocol/muc#user")
+ :get_child("invite").attr.from;
+ module:log("debug", "%s invited %s into members only room %s, granting membership",
+ from, invitee, room.jid);
+ -- This might fail; ignore for now
+ room:set_affiliation(from, invitee, "member", "Invited by " .. from);
+ room:save();
+ end
+ end
+end);
+
+return {
+ get = get_members_only;
+ set = set_members_only;
+};
diff --git a/plugins/muc/mod_muc.lua b/plugins/muc/mod_muc.lua
index 7304b5b1..979aed8c 100644
--- a/plugins/muc/mod_muc.lua
+++ b/plugins/muc/mod_muc.lua
@@ -6,285 +6,387 @@
-- COPYING file in the source package for more information.
--
-local array = require "util.array";
+-- Exposed functions:
+--
+-- create_room(jid) -> room
+-- track_room(room)
+-- delete_room(room)
+-- forget_room(room)
+-- get_room_from_jid(jid) -> room
+-- each_room(local_only) -> () -> room
+-- shutdown_component()
if module:get_host_type() ~= "component" then
- error("MUC should be loaded as a component, please see http://prosody.im/doc/components", 0);
+ error("MUC should be loaded as a component, please see https://prosody.im/doc/components", 0);
end
-local muc_host = module:get_host();
-local muc_name = module:get_option_string("name", "Prosody Chatrooms");
-local restrict_room_creation = module:get_option("restrict_room_creation");
-if restrict_room_creation then
- if restrict_room_creation == true then
- restrict_room_creation = "admin";
- elseif restrict_room_creation ~= "admin" and restrict_room_creation ~= "local" then
- restrict_room_creation = nil;
- end
+local muclib = module:require "muc";
+room_mt = muclib.room_mt; -- Yes, global.
+
+local affiliation_notify = module:require "muc/affiliation_notify"; -- luacheck: ignore 211
+
+local name = module:require "muc/name";
+room_mt.get_name = name.get;
+room_mt.set_name = name.set;
+
+local description = module:require "muc/description";
+room_mt.get_description = description.get;
+room_mt.set_description = description.set;
+
+local hidden = module:require "muc/hidden";
+room_mt.get_hidden = hidden.get;
+room_mt.set_hidden = hidden.set;
+function room_mt:get_public()
+ return not self:get_hidden();
+end
+function room_mt:set_public(public)
+ return self:set_hidden(not public);
end
-local lock_rooms = module:get_option_boolean("muc_room_locking", false);
-local lock_room_timeout = module:get_option_number("muc_room_lock_timeout", 300);
-local muclib = module:require "muc";
-local muc_new_room = muclib.new_room;
+local password = module:require "muc/password";
+room_mt.get_password = password.get;
+room_mt.set_password = password.set;
+
+local members_only = module:require "muc/members_only";
+room_mt.get_members_only = members_only.get;
+room_mt.set_members_only = members_only.set;
+
+local moderated = module:require "muc/moderated";
+room_mt.get_moderated = moderated.get;
+room_mt.set_moderated = moderated.set;
+
+local persistent = module:require "muc/persistent";
+room_mt.get_persistent = persistent.get;
+room_mt.set_persistent = persistent.set;
+
+local subject = module:require "muc/subject";
+room_mt.get_changesubject = subject.get_changesubject;
+room_mt.set_changesubject = subject.set_changesubject;
+room_mt.get_subject = subject.get;
+room_mt.set_subject = subject.set;
+room_mt.send_subject = subject.send;
+
+local history = module:require "muc/history";
+room_mt.send_history = history.send;
+room_mt.get_historylength = history.get_length;
+room_mt.set_historylength = history.set_length;
+
local jid_split = require "util.jid".split;
local jid_bare = require "util.jid".bare;
local st = require "util.stanza";
-local uuid_gen = require "util.uuid".generate;
+local cache = require "util.cache";
local um_is_admin = require "core.usermanager".is_admin;
-local hosts = prosody.hosts;
-
-rooms = {};
-local rooms = rooms;
-local persistent_rooms_storage = module:open_store("persistent");
-local persistent_rooms, err = persistent_rooms_storage:get();
-if not persistent_rooms then
- module:log("error", "Error loading list of persistent rooms from storage. Reload mod_muc or restart to recover.");
- assert(not err, err);
- persistent_rooms = {};
-end
-local room_configs = module:open_store("config");
-
--- Configurable options
-muclib.set_max_history_length(module:get_option_number("max_history_messages"));
module:depends("disco");
-module:add_identity("conference", "text", muc_name);
+module:add_identity("conference", "text", module:get_option_string("name", "Prosody Chatrooms"));
module:add_feature("http://jabber.org/protocol/muc");
+module:depends "muc_unique"
+module:require "muc/lock";
local function is_admin(jid)
return um_is_admin(jid, module.host);
end
-room_mt = muclib.room_mt; -- Yes, global.
-local _set_affiliation = room_mt.set_affiliation;
-local _get_affiliation = room_mt.get_affiliation;
-function muclib.room_mt:get_affiliation(jid)
- if is_admin(jid) then return "owner"; end
- return _get_affiliation(self, jid);
-end
-function muclib.room_mt:set_affiliation(actor, jid, affiliation, callback, reason)
- if affiliation ~= "owner" and is_admin(jid) then return nil, "modify", "not-acceptable"; end
- return _set_affiliation(self, actor, jid, affiliation, callback, reason);
+do -- Monkey patch to make server admins room owners
+ local _get_affiliation = room_mt.get_affiliation;
+ function room_mt:get_affiliation(jid)
+ if is_admin(jid) then return "owner"; end
+ return _get_affiliation(self, jid);
+ end
+
+ local _set_affiliation = room_mt.set_affiliation;
+ function room_mt:set_affiliation(actor, jid, affiliation, reason)
+ if affiliation ~= "owner" and is_admin(jid) then return nil, "modify", "not-acceptable"; end
+ return _set_affiliation(self, actor, jid, affiliation, reason);
+ end
end
-local function room_route_stanza(room, stanza) module:send(stanza); end
-local function room_save(room, forced)
+local persistent_rooms_storage = module:open_store("persistent");
+local persistent_rooms = module:open_store("persistent", "map");
+local room_configs = module:open_store("config");
+local room_state = module:open_store("state");
+
+local room_items_cache = {};
+
+local function room_save(room, forced, savestate)
local node = jid_split(room.jid);
- persistent_rooms[room.jid] = room._data.persistent;
- if room._data.persistent then
- local history = room._data.history;
- room._data.history = nil;
- local data = {
- jid = room.jid;
- _data = room._data;
- _affiliations = room._affiliations;
- };
- room_configs:set(node, data);
- room._data.history = history;
+ local is_persistent = persistent.get(room);
+ room_items_cache[room.jid] = room:get_public() and room:get_name() or nil;
+ if is_persistent or savestate then
+ persistent_rooms:set(nil, room.jid, true);
+ local data, state = room:freeze(savestate);
+ room_state:set(node, state);
+ return room_configs:set(node, data);
elseif forced then
- room_configs:set(node, nil);
- if not next(room._occupants) then -- Room empty
- rooms[room.jid] = nil;
- end
+ persistent_rooms:set(nil, room.jid, nil);
+ room_state:set(node, nil);
+ return room_configs:set(node, nil);
end
- if forced then persistent_rooms_storage:set(nil, persistent_rooms); end
end
-function create_room(jid, locked)
- local room = muc_new_room(jid);
- room.route_stanza = room_route_stanza;
- room.save = room_save;
- rooms[jid] = room;
- if locked then
- room.locked = true;
- if lock_room_timeout and lock_room_timeout > 0 then
- module:add_timer(lock_room_timeout, function ()
- if room.locked then
- room:destroy(); -- Not unlocked in time
- end
- end);
- end
+local eviction_hit_rate = module:measure("room_eviction", "rate");
+local rooms = cache.new(module:get_option_number("muc_room_cache_size", 100), function (jid, room)
+ module:log("debug", "Evicting room %s", jid);
+ eviction_hit_rate();
+ room_items_cache[room.jid] = room:get_public() and room:get_name() or nil;
+ local ok, err = room_save(room, nil, true); -- Force to disk
+ if not ok then
+ module:log("error", "Failed to swap inactive room %s to disk: %s", jid, err);
+ return false;
end
- module:fire_event("muc-room-created", { room = room });
- return room;
+end);
+
+-- Automatically destroy empty non-persistent rooms
+module:hook("muc-occupant-left",function(event)
+ local room = event.room
+ if not room:has_occupant() and not persistent.get(room) then -- empty, non-persistent room
+ module:fire_event("muc-room-destroyed", { room = room });
+ end
+end, -1);
+
+function track_room(room)
+ if rooms:set(room.jid, room) then
+ -- When room is created, over-ride 'save' method
+ room.save = room_save;
+ return room;
+ end
+ return false;
+end
+
+local function handle_broken_room(room, origin, stanza)
+ module:log("debug", "Returning error from broken room %s", room.jid);
+ origin.send(st.error_reply(stanza, "wait", "internal-server-error"));
+ return true;
end
-local persistent_errors = false;
-for jid in pairs(persistent_rooms) do
+local function restore_room(jid)
local node = jid_split(jid);
local data, err = room_configs:get(node);
if data then
- local room = create_room(jid);
- room._data = data._data;
- room._affiliations = data._affiliations;
- elseif not err then -- missing room data
- persistent_rooms[jid] = nil;
- module:log("error", "Missing data for room '%s', removing from persistent room list", jid);
- persistent_errors = true;
- else -- error
- module:log("error", "Error loading data for room '%s', locking it until service restart. Error was: %s", jid, err);
- local room = muc_new_room(jid);
- room.locked = true;
- room._affiliations = { [muc_host] = "owner" }; -- To prevent unlocking
- rooms[jid] = room;
+ module:log("debug", "Restoring room %s from storage", jid);
+ local state, s_err = room_state:get(node);
+ if not state and s_err then
+ module:log("debug", "Could not restore state of room %s: %s", jid, s_err);
+ end
+ local room = muclib.restore_room(data, state);
+ return track_room(room);
+ elseif err then
+ module:log("error", "Error restoring room %s from storage: %s", jid, err);
+ local room = muclib.new_room(jid, { locked = math.huge });
+ room.handle_normal_presence = handle_broken_room;
+ room.handle_first_presence = handle_broken_room;
+ return room;
end
end
-if persistent_errors then persistent_rooms_storage:set(nil, persistent_rooms); end
-local host_room = muc_new_room(muc_host);
-host_room.route_stanza = room_route_stanza;
-host_room.save = room_save;
+function forget_room(room)
+ module:log("debug", "Forgetting %s", room.jid);
+ rooms.save = nil;
+ rooms:set(room.jid, nil);
+end
-module:hook("host-disco-items", function(event)
- local reply = event.reply;
- module:log("debug", "host-disco-items called");
- for jid, room in pairs(rooms) do
- if not room:get_hidden() then
- reply:tag("item", {jid=jid, name=room:get_name()}):up();
- end
+function delete_room(room)
+ module:log("debug", "Deleting %s", room.jid);
+ room_configs:set(jid_split(room.jid), nil);
+ persistent_rooms:set(nil, room.jid, nil);
+ room_items_cache[room.jid] = nil;
+end
+
+function module.unload()
+ for room in rooms:values() do
+ room:save(nil, true);
+ forget_room(room);
end
-end);
+end
-local function handle_to_domain(event)
- local origin, stanza = event.origin, event.stanza;
- local type = stanza.attr.type;
- if type == "error" or type == "result" then return; end
- if stanza.name == "iq" and type == "get" then
- local xmlns = stanza.tags[1].attr.xmlns;
- local node = stanza.tags[1].attr.node;
- if xmlns == "http://jabber.org/protocol/muc#unique" then
- origin.send(st.reply(stanza):tag("unique", {xmlns = xmlns}):text(uuid_gen())); -- FIXME Random UUIDs can theoretically have collisions
- else
- origin.send(st.error_reply(stanza, "cancel", "service-unavailable")); -- TODO disco/etc
- end
- else
- host_room:handle_stanza(origin, stanza);
- --origin.send(st.error_reply(stanza, "cancel", "service-unavailable", "The muc server doesn't deal with messages and presence directed at it"));
+function get_room_from_jid(room_jid)
+ local room = rooms:get(room_jid);
+ if room then
+ rooms:set(room_jid, room); -- bump to top;
+ return room;
end
- return true;
+ return restore_room(room_jid);
end
-function stanza_handler(event)
- local origin, stanza = event.origin, event.stanza;
- local bare = jid_bare(stanza.attr.to);
- local room = rooms[bare];
- if not room then
- if stanza.name ~= "presence" or stanza.attr.type ~= nil then
- if stanza.attr.type ~= "error" then
- origin.send(st.error_reply(stanza, "cancel", "item-not-found"));
+function create_room(room_jid)
+ local exists = get_room_from_jid(room_jid);
+ if exists then
+ return nil, "room-exists";
+ end
+ local room = muclib.new_room(room_jid);
+ module:fire_event("muc-room-created", {
+ room = room;
+ });
+ return room;
+end
+
+function each_room(local_only)
+ if local_only then
+ return rooms:values();
+ end
+ return coroutine.wrap(function ()
+ local seen = {}; -- Don't iterate over persistent rooms twice
+ for room in rooms:values() do
+ coroutine.yield(room);
+ seen[room.jid] = true;
+ end
+ local all_persistent_rooms, err = persistent_rooms_storage:get(nil);
+ if not all_persistent_rooms then
+ if err then
+ module:log("error", "Error loading list of persistent rooms, only rooms live in memory were iterated over");
+ module:log("debug", "%s", debug.traceback(err));
end
- return true;
+ return nil;
end
- if not(restrict_room_creation) or
- is_admin(stanza.attr.from) or
- (restrict_room_creation == "local" and select(2, jid_split(stanza.attr.from)) == module.host:gsub("^[^%.]+%.", "")) then
- room = create_room(bare, lock_rooms);
+ for room_jid in pairs(all_persistent_rooms) do
+ if not seen[room_jid] then
+ local room = restore_room(room_jid);
+ if room then
+ coroutine.yield(room);
+ else
+ module:log("error", "Missing data for room '%s', omitting from iteration", room_jid);
+ end
+ end
end
- end
- if room then
- room:handle_stanza(origin, stanza);
- if not next(room._occupants) and not persistent_rooms[room.jid] then -- empty, non-persistent room
- module:fire_event("muc-room-destroyed", { room = room });
- rooms[bare] = nil; -- discard room
+ end);
+end
+
+module:hook("host-disco-items", function(event)
+ local reply = event.reply;
+ module:log("debug", "host-disco-items called");
+ if next(room_items_cache) ~= nil then
+ for jid, room_name in pairs(room_items_cache) do
+ reply:tag("item", { jid = jid, name = room_name }):up();
end
else
- origin.send(st.error_reply(stanza, "cancel", "not-allowed"));
+ for room in each_room() do
+ if not room:get_hidden() then
+ local jid, room_name = room.jid, room:get_name();
+ room_items_cache[jid] = room_name;
+ reply:tag("item", { jid = jid, name = room_name }):up();
+ end
+ end
end
- return true;
-end
-module:hook("iq/bare", stanza_handler, -1);
-module:hook("message/bare", stanza_handler, -1);
-module:hook("presence/bare", stanza_handler, -1);
-module:hook("iq/full", stanza_handler, -1);
-module:hook("message/full", stanza_handler, -1);
-module:hook("presence/full", stanza_handler, -1);
-module:hook("iq/host", handle_to_domain, -1);
-module:hook("message/host", handle_to_domain, -1);
-module:hook("presence/host", handle_to_domain, -1);
-
-hosts[module.host].send = function(stanza) -- FIXME do a generic fix
- if stanza.attr.type == "result" or stanza.attr.type == "error" then
- module:send(stanza);
- else error("component.send only supports result and error stanzas at the moment"); end
-end
+end);
-hosts[module:get_host()].muc = { rooms = rooms };
+module:hook("muc-room-pre-create", function(event)
+ local origin, stanza = event.origin, event.stanza;
+ if not track_room(event.room) then
+ origin.send(st.error_reply(stanza, "wait", "resource-constraint"));
+ return true;
+ end
+end, -1000);
-local saved = false;
-module.save = function()
- saved = true;
- return {rooms = rooms};
-end
-module.restore = function(data)
- for jid, oldroom in pairs(data.rooms or {}) do
- local room = create_room(jid);
- room._jid_nick = oldroom._jid_nick;
- room._occupants = oldroom._occupants;
- room._data = oldroom._data;
- room._affiliations = oldroom._affiliations;
+module:hook("muc-room-destroyed",function(event)
+ local room = event.room;
+ forget_room(room);
+ delete_room(room);
+end);
+
+do
+ local restrict_room_creation = module:get_option("restrict_room_creation");
+ if restrict_room_creation == true then
+ restrict_room_creation = "admin";
+ end
+ if restrict_room_creation then
+ local host_suffix = module.host:gsub("^[^%.]+%.", "");
+ module:hook("muc-room-pre-create", function(event)
+ local origin, stanza = event.origin, event.stanza;
+ local user_jid = stanza.attr.from;
+ if not is_admin(user_jid) and not (
+ restrict_room_creation == "local" and
+ select(2, jid_split(user_jid)) == host_suffix
+ ) then
+ origin.send(st.error_reply(stanza, "cancel", "not-allowed", "Room creation is restricted"));
+ return true;
+ end
+ end);
end
- hosts[module:get_host()].muc = { rooms = rooms };
end
-function shutdown_room(room, stanza)
- for nick, occupant in pairs(room._occupants) do
- stanza.attr.from = nick;
- for jid in pairs(occupant.sessions) do
- stanza.attr.to = jid;
- room:_route_stanza(stanza);
- room._jid_nick[jid] = nil;
+for event_name, method in pairs {
+ -- Normal room interactions
+ ["iq-get/bare/http://jabber.org/protocol/disco#info:query"] = "handle_disco_info_get_query" ;
+ ["iq-get/bare/http://jabber.org/protocol/disco#items:query"] = "handle_disco_items_get_query" ;
+ ["iq-set/bare/http://jabber.org/protocol/muc#admin:query"] = "handle_admin_query_set_command" ;
+ ["iq-get/bare/http://jabber.org/protocol/muc#admin:query"] = "handle_admin_query_get_command" ;
+ ["iq-set/bare/http://jabber.org/protocol/muc#owner:query"] = "handle_owner_query_set_to_room" ;
+ ["iq-get/bare/http://jabber.org/protocol/muc#owner:query"] = "handle_owner_query_get_to_room" ;
+ ["message/bare"] = "handle_message_to_room" ;
+ ["presence/bare"] = "handle_presence_to_room" ;
+ -- Host room
+ ["iq-get/host/http://jabber.org/protocol/disco#info:query"] = "handle_disco_info_get_query" ;
+ ["iq-get/host/http://jabber.org/protocol/disco#items:query"] = "handle_disco_items_get_query" ;
+ ["iq-set/host/http://jabber.org/protocol/muc#admin:query"] = "handle_admin_query_set_command" ;
+ ["iq-get/host/http://jabber.org/protocol/muc#admin:query"] = "handle_admin_query_get_command" ;
+ ["iq-set/host/http://jabber.org/protocol/muc#owner:query"] = "handle_owner_query_set_to_room" ;
+ ["iq-get/host/http://jabber.org/protocol/muc#owner:query"] = "handle_owner_query_get_to_room" ;
+ ["message/host"] = "handle_message_to_room" ;
+ ["presence/host"] = "handle_presence_to_room" ;
+ -- Direct to occupant (normal rooms and host room)
+ ["presence/full"] = "handle_presence_to_occupant" ;
+ ["iq/full"] = "handle_iq_to_occupant" ;
+ ["message/full"] = "handle_message_to_occupant" ;
+} do
+ module:hook(event_name, function (event)
+ local origin, stanza = event.origin, event.stanza;
+ local room_jid = jid_bare(stanza.attr.to);
+ local room = get_room_from_jid(room_jid);
+ if room == nil then
+ -- Watch presence to create rooms
+ if stanza.attr.type == nil and stanza.name == "presence" then
+ room = muclib.new_room(room_jid);
+ return room:handle_first_presence(origin, stanza);
+ elseif stanza.attr.type ~= "error" then
+ origin.send(st.error_reply(stanza, "cancel", "item-not-found"));
+ return true;
+ else
+ return;
+ end
end
- room._occupants[nick] = nil;
- end
+ return room[method](room, origin, stanza);
+ end, -2)
end
+
function shutdown_component()
- if not saved then
- local stanza = st.presence({type = "unavailable"})
- :tag("x", {xmlns = "http://jabber.org/protocol/muc#user"})
- :tag("item", { affiliation='none', role='none' }):up()
- :tag("status", { code = "332"}):up();
- for roomjid, room in pairs(rooms) do
- shutdown_room(room, stanza);
- end
- shutdown_room(host_room, stanza);
+ for room in each_room(true) do
+ room:save(nil, true);
end
end
-module.unload = shutdown_component;
-module:hook_global("server-stopping", shutdown_component);
-
--- Ad-hoc commands
-module:depends("adhoc")
-local t_concat = table.concat;
-local keys = require "util.iterators".keys;
-local adhoc_new = module:require "adhoc".new;
-local adhoc_initial = require "util.adhoc".new_initial_data_form;
-local dataforms_new = require "util.dataforms".new;
-
-local destroy_rooms_layout = dataforms_new {
- title = "Destroy rooms";
- instructions = "Select the rooms to destroy";
-
- { name = "FORM_TYPE", type = "hidden", value = "http://prosody.im/protocol/muc#destroy" };
- { name = "rooms", type = "list-multi", required = true, label = "Rooms to destroy:"};
-};
-
-local destroy_rooms_handler = adhoc_initial(destroy_rooms_layout, function()
- return { rooms = array.collect(keys(rooms)):sort() };
-end, function(fields, errors)
- if errors then
- local errmsg = {};
- for name, err in pairs(errors) do
- errmsg[#errmsg + 1] = name .. ": " .. err;
+module:hook_global("server-stopping", shutdown_component, -300);
+
+do -- Ad-hoc commands
+ module:depends "adhoc";
+ local t_concat = table.concat;
+ local adhoc_new = module:require "adhoc".new;
+ local adhoc_initial = require "util.adhoc".new_initial_data_form;
+ local array = require "util.array";
+ local dataforms_new = require "util.dataforms".new;
+
+ local destroy_rooms_layout = dataforms_new {
+ title = "Destroy rooms";
+ instructions = "Select the rooms to destroy";
+
+ { name = "FORM_TYPE", type = "hidden", value = "http://prosody.im/protocol/muc#destroy" };
+ { name = "rooms", type = "list-multi", required = true, label = "Rooms to destroy:"};
+ };
+
+ local destroy_rooms_handler = adhoc_initial(destroy_rooms_layout, function()
+ return { rooms = array.collect(each_room()):pluck("jid"):sort(); };
+ end, function(fields, errors)
+ if errors then
+ local errmsg = {};
+ for field, err in pairs(errors) do
+ errmsg[#errmsg + 1] = field .. ": " .. err;
+ end
+ return { status = "completed", error = { message = t_concat(errmsg, "\n") } };
end
- return { status = "completed", error = { message = t_concat(errmsg, "\n") } };
- end
- for _, room in ipairs(fields.rooms) do
- rooms[room]:destroy();
- rooms[room] = nil;
- end
- return { status = "completed", info = "The following rooms were destroyed:\n"..t_concat(fields.rooms, "\n") };
-end);
-local destroy_rooms_desc = adhoc_new("Destroy Rooms", "http://prosody.im/protocol/muc#destroy", destroy_rooms_handler, "admin");
+ for _, room in ipairs(fields.rooms) do
+ get_room_from_jid(room):destroy();
+ end
+ return { status = "completed", info = "The following rooms were destroyed:\n"..t_concat(fields.rooms, "\n") };
+ end);
+ local destroy_rooms_desc = adhoc_new("Destroy Rooms", "http://prosody.im/protocol/muc#destroy", destroy_rooms_handler, "admin");
-module:provides("adhoc", destroy_rooms_desc);
+ module:provides("adhoc", destroy_rooms_desc);
+end
diff --git a/plugins/muc/moderated.lib.lua b/plugins/muc/moderated.lib.lua
new file mode 100644
index 00000000..8354c585
--- /dev/null
+++ b/plugins/muc/moderated.lib.lua
@@ -0,0 +1,51 @@
+-- Prosody IM
+-- Copyright (C) 2008-2010 Matthew Wild
+-- Copyright (C) 2008-2010 Waqas Hussain
+-- Copyright (C) 2014 Daurnimator
+--
+-- This project is MIT/X11 licensed. Please see the
+-- COPYING file in the source package for more information.
+--
+
+local function get_moderated(room)
+ return room._data.moderated;
+end
+
+local function set_moderated(room, moderated)
+ moderated = moderated and true or nil;
+ if get_moderated(room) == moderated then return false; end
+ room._data.moderated = moderated;
+ return true;
+end
+
+module:hook("muc-disco#info", function(event)
+ event.reply:tag("feature", {var = get_moderated(event.room) and "muc_moderated" or "muc_unmoderated"}):up();
+end);
+
+module:hook("muc-config-form", function(event)
+ table.insert(event.form, {
+ name = "muc#roomconfig_moderatedroom";
+ type = "boolean";
+ label = "Make Room Moderated?";
+ value = get_moderated(event.room);
+ });
+end, 100-4);
+
+module:hook("muc-config-submitted/muc#roomconfig_moderatedroom", function(event)
+ if set_moderated(event.room, event.value) then
+ event.status_codes["104"] = true;
+ end
+end);
+
+module:hook("muc-get-default-role", function(event)
+ if event.affiliation == nil then
+ if get_moderated(event.room) then
+ return "visitor"
+ end
+ end
+end, 1);
+
+return {
+ get = get_moderated;
+ set = set_moderated;
+};
diff --git a/plugins/muc/muc.lib.lua b/plugins/muc/muc.lib.lua
index a1b42c87..7c3d3af9 100644
--- a/plugins/muc/muc.lib.lua
+++ b/plugins/muc/muc.lib.lua
@@ -1,66 +1,33 @@
-- Prosody IM
-- Copyright (C) 2008-2010 Matthew Wild
-- Copyright (C) 2008-2010 Waqas Hussain
+-- Copyright (C) 2014 Daurnimator
--
-- This project is MIT/X11 licensed. Please see the
-- COPYING file in the source package for more information.
--
local select = select;
-local pairs, ipairs = pairs, ipairs;
-
-local datetime = require "util.datetime";
+local pairs = pairs;
+local next = next;
+local setmetatable = setmetatable;
local dataform = require "util.dataforms";
-
+local iterators = require "util.iterators";
local jid_split = require "util.jid".split;
local jid_bare = require "util.jid".bare;
local jid_prep = require "util.jid".prep;
+local jid_join = require "util.jid".join;
local st = require "util.stanza";
-local log = require "util.logger".init("mod_muc");
-local t_insert, t_remove = table.insert, table.remove;
-local setmetatable = setmetatable;
local base64 = require "util.encodings".base64;
local md5 = require "util.hashes".md5;
-local muc_domain = nil; --module:get_host();
-local default_history_length, max_history_length = 20, math.huge;
+local log = module._log;
-------------
-local presence_filters = {["http://jabber.org/protocol/muc"]=true;["http://jabber.org/protocol/muc#user"]=true};
-local function presence_filter(tag)
- if presence_filters[tag.attr.xmlns] then
- return nil;
- end
- return tag;
-end
-
-local function get_filtered_presence(stanza)
- return st.clone(stanza):maptags(presence_filter);
-end
-local kickable_error_conditions = {
- ["gone"] = true;
- ["internal-server-error"] = true;
- ["item-not-found"] = true;
- ["jid-malformed"] = true;
- ["recipient-unavailable"] = true;
- ["redirect"] = true;
- ["remote-server-not-found"] = true;
- ["remote-server-timeout"] = true;
- ["service-unavailable"] = true;
- ["malformed error"] = true;
-};
-
-local function get_error_condition(stanza)
- local _, condition = stanza:get_error();
- return condition or "malformed error";
-end
-
-local function is_kickable_error(stanza)
- local cond = get_error_condition(stanza);
- return kickable_error_conditions[cond] and cond;
-end
------------
+local occupant_lib = module:require "muc/occupant"
+local muc_util = module:require "muc/util";
+local is_kickable_error = muc_util.is_kickable_error;
+local valid_roles, valid_affiliations = muc_util.valid_roles, muc_util.valid_affiliations;
local room_mt = {};
room_mt.__index = room_mt;
@@ -69,37 +36,146 @@ function room_mt:__tostring()
return "MUC room ("..self.jid..")";
end
+function room_mt.save()
+ -- overriden by mod_muc.lua
+end
+
+function room_mt:get_occupant_jid(real_jid)
+ return self._jid_nick[real_jid]
+end
+
function room_mt:get_default_role(affiliation)
- if affiliation == "owner" or affiliation == "admin" then
+ local role = module:fire_event("muc-get-default-role", {
+ room = self;
+ affiliation = affiliation;
+ affiliation_rank = valid_affiliations[affiliation or "none"];
+ });
+ return role, valid_roles[role or "none"];
+end
+module:hook("muc-get-default-role", function(event)
+ if event.affiliation_rank >= valid_affiliations.admin then
return "moderator";
- elseif affiliation == "member" then
+ elseif event.affiliation_rank >= valid_affiliations.none then
return "participant";
- elseif not affiliation then
- if not self:get_members_only() then
- return self:get_moderated() and "visitor" or "participant";
- end
end
+end);
+
+--- Occupant functions
+function room_mt:new_occupant(bare_real_jid, nick)
+ local occupant = occupant_lib.new(bare_real_jid, nick);
+ local affiliation = self:get_affiliation(bare_real_jid);
+ occupant.role = self:get_default_role(affiliation);
+ return occupant;
+end
+
+function room_mt:get_occupant_by_nick(nick)
+ local occupant = self._occupants[nick];
+ if occupant == nil then return nil end
+ return occupant_lib.copy(occupant);
end
-function room_mt:broadcast_presence(stanza, sid, code, nick)
- stanza = get_filtered_presence(stanza);
- local occupant = self._occupants[stanza.attr.from];
- stanza:tag("x", {xmlns='http://jabber.org/protocol/muc#user'})
- :tag("item", {affiliation=occupant.affiliation or "none", role=occupant.role or "none", nick=nick}):up();
- if code then
- stanza:tag("status", {code=code}):up();
- end
- self:broadcast_except_nick(stanza, stanza.attr.from);
- local me = self._occupants[stanza.attr.from];
- if me then
- stanza:tag("status", {code='110'}):up();
- stanza.attr.to = sid;
- self:_route_stanza(stanza);
+do
+ local function next_copied_occupant(occupants, occupant_jid)
+ local next_occupant_jid, raw_occupant = next(occupants, occupant_jid);
+ if next_occupant_jid == nil then return nil end
+ return next_occupant_jid, occupant_lib.copy(raw_occupant);
end
+ -- FIXME Explain what 'read_only' is supposed to be
+ function room_mt:each_occupant(read_only) -- luacheck: ignore 212
+ return next_copied_occupant, self._occupants, nil;
+ end
+end
+
+function room_mt:has_occupant()
+ return next(self._occupants, nil) ~= nil
end
-function room_mt:broadcast_message(stanza, historic)
+
+function room_mt:get_occupant_by_real_jid(real_jid)
+ local occupant_jid = self:get_occupant_jid(real_jid);
+ if occupant_jid == nil then return nil end
+ return self:get_occupant_by_nick(occupant_jid);
+end
+
+function room_mt:save_occupant(occupant)
+ occupant = occupant_lib.copy(occupant); -- So that occupant can be modified more
+ local id = occupant.nick
+
+ -- Need to maintain _jid_nick secondary index
+ local old_occupant = self._occupants[id];
+ if old_occupant then
+ for real_jid in old_occupant:each_session() do
+ self._jid_nick[real_jid] = nil;
+ end
+ end
+
+ local has_live_session = false
+ if occupant.role ~= nil then
+ for real_jid, presence in occupant:each_session() do
+ if presence.attr.type == nil then
+ has_live_session = true
+ self._jid_nick[real_jid] = occupant.nick;
+ end
+ end
+ if not has_live_session then
+ -- Has no live sessions left; they have left the room.
+ occupant.role = nil
+ end
+ end
+ if not has_live_session then
+ occupant = nil
+ end
+ self._occupants[id] = occupant
+end
+
+function room_mt:route_to_occupant(occupant, stanza)
local to = stanza.attr.to;
- local room_jid = self.jid;
+ for jid in occupant:each_session() do
+ stanza.attr.to = jid;
+ self:route_stanza(stanza);
+ end
+ stanza.attr.to = to;
+end
+
+-- actor is the attribute table
+local function add_item(x, affiliation, role, jid, nick, actor_nick, actor_jid, reason)
+ x:tag("item", {affiliation = affiliation; role = role; jid = jid; nick = nick;})
+ if actor_nick or actor_jid then
+ x:tag("actor", {nick = actor_nick; jid = actor_jid;}):up()
+ end
+ if reason then
+ x:tag("reason"):text(reason):up()
+ end
+ x:up();
+ return x
+end
+
+-- actor is (real) jid
+function room_mt:build_item_list(occupant, x, is_anonymous, nick, actor_nick, actor_jid, reason)
+ local affiliation = self:get_affiliation(occupant.bare_jid) or "none";
+ local role = occupant.role or "none";
+ if is_anonymous then
+ add_item(x, affiliation, role, nil, nick, actor_nick, actor_jid, reason);
+ else
+ for real_jid in occupant:each_session() do
+ add_item(x, affiliation, role, real_jid, nick, actor_nick, actor_jid, reason);
+ end
+ end
+ return x
+end
+
+function room_mt:broadcast_message(stanza)
+ if module:fire_event("muc-broadcast-message", {room = self, stanza = stanza}) then
+ return true;
+ end
+ self:broadcast(stanza);
+ return true;
+end
+
+-- Strip delay tags claiming to be from us
+module:hook("muc-occupant-groupchat", function (event)
+ local stanza = event.stanza;
+ local room = event.room;
+ local room_jid = room.jid;
stanza:maptags(function (child)
if child.name == "delay" and child.attr["xmlns"] == "urn:xmpp:delay" then
@@ -114,525 +190,573 @@ function room_mt:broadcast_message(stanza, historic)
end
return child;
end)
-
- for occupant, o_data in pairs(self._occupants) do
- for jid in pairs(o_data.sessions) do
- stanza.attr.to = jid;
- self:_route_stanza(stanza);
+end);
+
+-- Broadcast a stanza to all occupants in the room.
+-- optionally checks conditional called with (nick, occupant)
+function room_mt:broadcast(stanza, cond_func)
+ for nick, occupant in self:each_occupant() do
+ if cond_func == nil or cond_func(nick, occupant) then
+ self:route_to_occupant(occupant, stanza)
end
end
- stanza.attr.to = to;
- if historic then -- add to history
- return self:save_to_history(stanza)
- end
end
-function room_mt:save_to_history(stanza)
- local history = self._data['history'];
- if not history then history = {}; self._data['history'] = history; end
- stanza = st.clone(stanza);
- stanza.attr.to = "";
- local stamp = datetime.datetime();
- stanza:tag("delay", {xmlns = "urn:xmpp:delay", from = self.jid, stamp = stamp}):up(); -- XEP-0203
- stanza:tag("x", {xmlns = "jabber:x:delay", from = self.jid, stamp = datetime.legacy()}):up(); -- XEP-0091 (deprecated)
- local entry = { stanza = stanza, stamp = stamp };
- t_insert(history, entry);
- while #history > (self._data.history_length or default_history_length) do t_remove(history, 1) end
+
+local function can_see_real_jids(whois, occupant)
+ if whois == "anyone" then
+ return true;
+ elseif whois == "moderators" then
+ return valid_roles[occupant.role or "none"] >= valid_roles.moderator;
+ end
end
-function room_mt:broadcast_except_nick(stanza, nick)
- for rnick, occupant in pairs(self._occupants) do
- if rnick ~= nick then
- for jid in pairs(occupant.sessions) do
- stanza.attr.to = jid;
- self:_route_stanza(stanza);
+
+-- Broadcasts an occupant's presence to the whole room
+-- Takes the x element that goes into the stanzas
+function room_mt:publicise_occupant_status(occupant, x, nick, actor, reason)
+ local base_x = x.base or x;
+ -- Build real jid and (optionally) occupant jid template presences
+ local base_presence do
+ -- Try to use main jid's presence
+ local pr = occupant:get_presence();
+ if pr and (pr.attr.type ~= "unavailable" and occupant.role ~= nil) then
+ base_presence = st.clone(pr);
+ else -- user is leaving but didn't send a leave presence. make one for them
+ base_presence = st.presence {from = occupant.nick; type = "unavailable";};
+ end
+ end
+
+ -- Fire event (before full_p and anon_p are created)
+ local event = {
+ room = self; stanza = base_presence; x = base_x;
+ occupant = occupant; nick = nick; actor = actor;
+ reason = reason;
+ }
+ module:fire_event("muc-broadcast-presence", event);
+
+ -- Allow muc-broadcast-presence listeners to change things
+ nick = event.nick;
+ actor = event.actor;
+ reason = event.reason;
+
+ local whois = self:get_whois();
+
+ local actor_nick;
+ if actor then
+ actor_nick = select(3, jid_split(self:get_occupant_jid(actor)));
+ end
+
+ local full_p, full_x;
+ local function get_full_p()
+ if full_p == nil then
+ full_x = st.clone(x.full or base_x);
+ self:build_item_list(occupant, full_x, false, nick, actor_nick, actor, reason);
+ full_p = st.clone(base_presence):add_child(full_x);
+ end
+ return full_p, full_x;
+ end
+
+ local anon_p, anon_x;
+ local function get_anon_p()
+ if anon_p == nil then
+ anon_x = st.clone(x.anon or base_x);
+ self:build_item_list(occupant, anon_x, true, nick, actor_nick, nil, reason);
+ anon_p = st.clone(base_presence):add_child(anon_x);
+ end
+ return anon_p, anon_x;
+ end
+
+ local self_p, self_x;
+ if can_see_real_jids(whois, occupant) then
+ self_p, self_x = get_full_p();
+ else
+ -- Can always see your own full jids
+ -- But not allowed to see actor's
+ self_x = st.clone(x.self or base_x);
+ self:build_item_list(occupant, self_x, false, nick, actor_nick, nil, reason);
+ self_p = st.clone(base_presence):add_child(self_x);
+ end
+
+ -- General populance
+ for occupant_nick, n_occupant in self:each_occupant() do
+ if occupant_nick ~= occupant.nick then
+ local pr;
+ if can_see_real_jids(whois, n_occupant) then
+ pr = get_full_p();
+ elseif occupant.bare_jid == n_occupant.bare_jid then
+ pr = self_p;
+ else
+ pr = get_anon_p();
end
+ self:route_to_occupant(n_occupant, pr);
end
end
-end
-function room_mt:send_occupant_list(to)
- local current_nick = self._jid_nick[to];
- for occupant, o_data in pairs(self._occupants) do
- if occupant ~= current_nick then
- local pres = get_filtered_presence(o_data.sessions[o_data.jid]);
- pres.attr.to, pres.attr.from = to, occupant;
- pres:tag("x", {xmlns='http://jabber.org/protocol/muc#user'})
- :tag("item", {affiliation=o_data.affiliation or "none", role=o_data.role or "none"}):up();
- self:_route_stanza(pres);
+ -- Presences for occupant itself
+ self_x:tag("status", {code = "110";}):up();
+ if occupant.role == nil then
+ -- They get an unavailable
+ self:route_to_occupant(occupant, self_p);
+ else
+ -- use their own presences as templates
+ for full_jid, pr in occupant:each_session() do
+ pr = st.clone(pr);
+ pr.attr.to = full_jid;
+ pr:add_child(self_x);
+ self:route_stanza(pr);
end
end
end
-function room_mt:send_history(to, stanza)
- local history = self._data['history']; -- send discussion history
- if history then
- local x_tag = stanza and stanza:get_child("x", "http://jabber.org/protocol/muc");
- local history_tag = x_tag and x_tag:get_child("history", "http://jabber.org/protocol/muc");
-
- local maxchars = history_tag and tonumber(history_tag.attr.maxchars);
- if maxchars then maxchars = math.floor(maxchars); end
-
- local maxstanzas = math.floor(history_tag and tonumber(history_tag.attr.maxstanzas) or #history);
- if not history_tag then maxstanzas = self._data.default_history_messages; end
-
- local seconds = history_tag and tonumber(history_tag.attr.seconds);
- if seconds then seconds = datetime.datetime(os.time() - math.floor(seconds)); end
-
- local since = history_tag and history_tag.attr.since;
- if since then since = datetime.parse(since); since = since and datetime.datetime(since); end
- if seconds and (not since or since < seconds) then since = seconds; end
-
- local n = 0;
- local charcount = 0;
-
- for i=#history,1,-1 do
- local entry = history[i];
- if maxchars then
- if not entry.chars then
- entry.stanza.attr.to = "";
- entry.chars = #tostring(entry.stanza);
- end
- charcount = charcount + entry.chars + #to;
- if charcount > maxchars then break; end
+
+function room_mt:send_occupant_list(to, filter)
+ local to_bare = jid_bare(to);
+ local is_anonymous = false;
+ local whois = self:get_whois();
+ if whois ~= "anyone" then
+ local affiliation = self:get_affiliation(to);
+ if affiliation ~= "admin" and affiliation ~= "owner" then
+ local occupant = self:get_occupant_by_real_jid(to);
+ if not (occupant and can_see_real_jids(whois, occupant)) then
+ is_anonymous = true;
end
- if since and since > entry.stamp then break; end
- if n + 1 > maxstanzas then break; end
- n = n + 1;
end
- for i=#history-n+1,#history do
- local msg = history[i].stanza;
- msg.attr.to = to;
- self:_route_stanza(msg);
+ end
+ for occupant_jid, occupant in self:each_occupant() do
+ if filter == nil or filter(occupant_jid, occupant) then
+ local x = st.stanza("x", {xmlns='http://jabber.org/protocol/muc#user'});
+ self:build_item_list(occupant, x, is_anonymous and to_bare ~= occupant.bare_jid); -- can always see your own jids
+ local pres = st.clone(occupant:get_presence());
+ pres.attr.to = to;
+ pres:add_child(x);
+ self:route_stanza(pres);
end
end
end
-function room_mt:send_subject(to)
- self:_route_stanza(st.message({type='groupchat', from=self._data['subject_from'] or self.jid, to=to}):tag("subject"):text(self._data['subject']));
-end
function room_mt:get_disco_info(stanza)
- local count = 0; for _ in pairs(self._occupants) do count = count + 1; end
- local reply = st.reply(stanza):query("http://jabber.org/protocol/disco#info")
- :tag("identity", {category="conference", type="text", name=self:get_name()}):up()
- :tag("feature", {var="http://jabber.org/protocol/muc"}):up()
- :tag("feature", {var="http://jabber.org/protocol/muc#stable_id"}):up()
- :tag("feature", {var=self:get_password() and "muc_passwordprotected" or "muc_unsecured"}):up()
- :tag("feature", {var=self:get_moderated() and "muc_moderated" or "muc_unmoderated"}):up()
- :tag("feature", {var=self:get_members_only() and "muc_membersonly" or "muc_open"}):up()
- :tag("feature", {var=self:get_persistent() and "muc_persistent" or "muc_temporary"}):up()
- :tag("feature", {var=self:get_hidden() and "muc_hidden" or "muc_public"}):up()
- :tag("feature", {var=self._data.whois ~= "anyone" and "muc_semianonymous" or "muc_nonanonymous"}):up()
- ;
- local dataform = dataform.new({
- { name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/protocol/muc#roominfo" },
- { name = "muc#roominfo_description", label = "Description", value = "" },
- { name = "muc#roominfo_occupants", label = "Number of occupants", value = "" }
- });
- local formdata = {
- ["muc#roominfo_description"] = self:get_description(),
- ["muc#roominfo_occupants"] = tostring(count),
+ local reply = st.reply(stanza):query("http://jabber.org/protocol/disco#info");
+ local form = dataform.new {
+ { name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/protocol/muc#roominfo" };
};
- module:fire_event("muc-disco#info", { room = self, reply = reply, form = dataform, formdata = formdata });
- reply:add_child(dataform:form(formdata, 'result'))
+ local formdata = {};
+ module:fire_event("muc-disco#info", {room = self; reply = reply; form = form, formdata = formdata ;});
+ reply:add_child(form:form(formdata, "result"));
return reply;
end
+module:hook("muc-disco#info", function(event)
+ event.reply:tag("feature", {var = "http://jabber.org/protocol/muc"}):up();
+ event.reply:tag("feature", {var = "http://jabber.org/protocol/muc#stable_id"}):up();
+end);
+module:hook("muc-disco#info", function(event)
+ table.insert(event.form, { name = "muc#roominfo_occupants", label = "Number of occupants" });
+ event.formdata["muc#roominfo_occupants"] = tostring(iterators.count(event.room:each_occupant()));
+end);
+
function room_mt:get_disco_items(stanza)
local reply = st.reply(stanza):query("http://jabber.org/protocol/disco#items");
- for room_jid in pairs(self._occupants) do
+ for room_jid in self:each_occupant() do
reply:tag("item", {jid = room_jid, name = room_jid:match("/(.*)")}):up();
end
return reply;
end
-function room_mt:set_subject(current_nick, subject)
- if subject == "" then subject = nil; end
- self._data['subject'] = subject;
- self._data['subject_from'] = current_nick;
- if self.save then self:save(); end
- local msg = st.message({type='groupchat', from=current_nick})
- :tag('subject'):text(subject):up();
- self:broadcast_message(msg, false);
- return true;
-end
-local function build_unavailable_presence_from_error(stanza)
+function room_mt:handle_kickable(origin, stanza) -- luacheck: ignore 212
+ local real_jid = stanza.attr.from;
+ local occupant = self:get_occupant_by_real_jid(real_jid);
+ if occupant == nil then return nil; end
local type, condition, text = stanza:get_error();
local error_message = "Kicked: "..(condition and condition:gsub("%-", " ") or "presence error");
if text then
error_message = error_message..": "..text;
end
- return st.presence({type='unavailable', from=stanza.attr.from, to=stanza.attr.to})
- :tag('status'):text(error_message);
-end
-
-function room_mt:set_name(name)
- if name == "" or type(name) ~= "string" or name == (jid_split(self.jid)) then name = nil; end
- if self._data.name ~= name then
- self._data.name = name;
- if self.save then self:save(true); end
- end
-end
-function room_mt:get_name()
- return self._data.name or jid_split(self.jid);
-end
-function room_mt:set_description(description)
- if description == "" or type(description) ~= "string" then description = nil; end
- if self._data.description ~= description then
- self._data.description = description;
- if self.save then self:save(true); end
- end
-end
-function room_mt:get_description()
- return self._data.description;
-end
-function room_mt:set_password(password)
- if password == "" or type(password) ~= "string" then password = nil; end
- if self._data.password ~= password then
- self._data.password = password;
- if self.save then self:save(true); end
+ occupant:set_session(real_jid, st.presence({type="unavailable"})
+ :tag('status'):text(error_message));
+ self:save_occupant(occupant);
+ local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";})
+ :tag("status", {code = "307"}):up()
+ :tag("status", {code = "333"})
+ self:publicise_occupant_status(occupant, x);
+ if occupant.jid == real_jid then -- Was last session
+ module:fire_event("muc-occupant-left", {room = self; nick = occupant.nick; occupant = occupant;});
end
+ return true;
end
-function room_mt:get_password()
- return self._data.password;
+
+if not module:get_option_boolean("muc_compat_create", true) then
+ module:hook("muc-room-pre-create", function(event)
+ local origin, stanza = event.origin, event.stanza;
+ if not stanza:get_child("x", "http://jabber.org/protocol/muc") then
+ origin.send(st.error_reply(stanza, "cancel", "item-not-found"));
+ return true;
+ end
+ end, -1);
end
-function room_mt:set_moderated(moderated)
- moderated = moderated and true or nil;
- if self._data.moderated ~= moderated then
- self._data.moderated = moderated;
- if self.save then self:save(true); end
+
+-- Give the room creator owner affiliation
+module:hook("muc-room-pre-create", function(event)
+ event.room:set_affiliation(true, jid_bare(event.stanza.attr.from), "owner");
+end, -1);
+
+-- check if user is banned
+module:hook("muc-occupant-pre-join", function(event)
+ local room, stanza = event.room, event.stanza;
+ local affiliation = room:get_affiliation(stanza.attr.from);
+ if affiliation == "outcast" then
+ local reply = st.error_reply(stanza, "auth", "forbidden"):up();
+ reply.tags[1].attr.code = "403";
+ event.origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
+ return true;
end
-end
-function room_mt:get_moderated()
- return self._data.moderated;
-end
-function room_mt:set_members_only(members_only)
- members_only = members_only and true or nil;
- if self._data.members_only ~= members_only then
- self._data.members_only = members_only;
- if self.save then self:save(true); end
+end, -10);
+
+function room_mt:handle_first_presence(origin, stanza)
+ local real_jid = stanza.attr.from;
+ local dest_jid = stanza.attr.to;
+ local bare_jid = jid_bare(real_jid);
+ if module:fire_event("muc-room-pre-create", {
+ room = self;
+ origin = origin;
+ stanza = stanza;
+ }) then return true; end
+ local is_first_dest_session = true;
+ local dest_occupant = self:new_occupant(bare_jid, dest_jid);
+
+ -- TODO Handle this case sensibly
+ if not stanza:get_child("x", "http://jabber.org/protocol/muc") then
+ module:log("debug", "Room creation without <x>, possibly desynced");
end
-end
-function room_mt:get_members_only()
- return self._data.members_only;
-end
-function room_mt:set_persistent(persistent)
- persistent = persistent and true or nil;
- if self._data.persistent ~= persistent then
- self._data.persistent = persistent;
- if self.save then self:save(true); end
+
+ local orig_nick = dest_occupant.nick;
+ if module:fire_event("muc-occupant-pre-join", {
+ room = self;
+ origin = origin;
+ stanza = stanza;
+ is_first_session = is_first_dest_session;
+ is_new_room = true;
+ occupant = dest_occupant;
+ }) then return true; end
+ local nick_changed = orig_nick ~= dest_occupant.nick;
+
+ dest_occupant:set_session(real_jid, stanza);
+ local dest_x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";});
+ dest_x:tag("status", {code = "201"}):up();
+ if self:get_whois() == "anyone" then
+ dest_x:tag("status", {code = "100"}):up();
end
-end
-function room_mt:get_persistent()
- return self._data.persistent;
-end
-function room_mt:set_hidden(hidden)
- hidden = hidden and true or nil;
- if self._data.hidden ~= hidden then
- self._data.hidden = hidden;
- if self.save then self:save(true); end
+ local self_x;
+ if nick_changed then
+ self_x = st.clone(dest_x);
+ self_x:tag("status", {code = "210"}):up();
end
+ self:save_occupant(dest_occupant);
+
+ self:publicise_occupant_status(dest_occupant, {base = dest_x, self = self_x});
+
+ module:fire_event("muc-occupant-joined", {
+ room = self;
+ nick = dest_occupant.nick;
+ occupant = dest_occupant;
+ stanza = stanza;
+ origin = origin;
+ });
+ module:fire_event("muc-occupant-session-new", {
+ room = self;
+ nick = dest_occupant.nick;
+ occupant = dest_occupant;
+ stanza = stanza;
+ origin = origin;
+ jid = real_jid;
+ });
+ module:fire_event("muc-room-created", {
+ room = self;
+ creator = dest_occupant;
+ stanza = stanza;
+ origin = origin;
+ });
+ return true;
end
-function room_mt:get_hidden()
- return self._data.hidden;
-end
-function room_mt:get_public()
- return not self:get_hidden();
-end
-function room_mt:set_public(public)
- return self:set_hidden(not public);
-end
-function room_mt:set_changesubject(changesubject)
- changesubject = changesubject and true or nil;
- if self._data.changesubject ~= changesubject then
- self._data.changesubject = changesubject;
- if self.save then self:save(true); end
+
+function room_mt:handle_normal_presence(origin, stanza)
+ local type = stanza.attr.type;
+ local real_jid = stanza.attr.from;
+ local bare_jid = jid_bare(real_jid);
+ local orig_occupant = self:get_occupant_by_real_jid(real_jid);
+ local is_first_dest_session;
+ local dest_occupant;
+ if type == "unavailable" then
+ if orig_occupant == nil then return true; end -- Unavailable from someone not in the room
+ -- dest_occupant = nil
+ elseif orig_occupant and orig_occupant.nick == stanza.attr.to then -- Just a presence update
+ log("debug", "presence update for %s from session %s", orig_occupant.nick, real_jid);
+ dest_occupant = orig_occupant;
+ else
+ local dest_jid = stanza.attr.to;
+ dest_occupant = self:get_occupant_by_nick(dest_jid);
+ if dest_occupant == nil then
+ log("debug", "no occupant found for %s; creating new occupant object for %s", dest_jid, real_jid);
+ is_first_dest_session = true;
+ dest_occupant = self:new_occupant(bare_jid, dest_jid);
+ else
+ is_first_dest_session = false;
+ end
end
-end
-function room_mt:get_changesubject()
- return self._data.changesubject;
-end
-function room_mt:get_historylength()
- return self._data.history_length or default_history_length;
-end
-function room_mt:set_historylength(length)
- length = math.min(tonumber(length) or default_history_length, max_history_length or math.huge);
- if length == default_history_length then
- length = nil;
+ local is_last_orig_session;
+ if orig_occupant ~= nil then
+ -- Is there are least 2 sessions?
+ local iter, ob, last = orig_occupant:each_session();
+ is_last_orig_session = iter(ob, iter(ob, last)) == nil;
end
- self._data.history_length = length;
-end
--- Fix for clients who don't support XEP-0045 correctly
--- Default number of history messages the room returns
-function room_mt:get_defaulthistorymessages()
- return self._data.default_history_messages or default_history_length;
-end
-function room_mt:set_defaulthistorymessages(number)
- number = math.min(tonumber(number) or default_history_length, self._data.history_length);
- if number == default_history_length then
- number = nil;
- end
- self._data.default_history_messages = number;
-end
+ -- TODO Handle these cases sensibly
+ local muc_x = stanza:get_child("x", "http://jabber.org/protocol/muc");
+ if orig_occupant == nil and not muc_x then
+ module:log("debug", "Join without <x>, possibly desynced");
+ elseif orig_occupant ~= nil and muc_x then
+ module:log("debug", "Presence update with <x>, possibly desynced");
+ end
+ local orig_nick = dest_occupant and dest_occupant.nick;
+ local event, event_name = {
+ room = self;
+ origin = origin;
+ stanza = stanza;
+ is_first_session = is_first_dest_session;
+ is_last_session = is_last_orig_session;
+ };
+ if orig_occupant == nil then
+ event_name = "muc-occupant-pre-join";
+ event.occupant = dest_occupant;
+ elseif dest_occupant == nil then
+ event_name = "muc-occupant-pre-leave";
+ event.occupant = orig_occupant;
+ else
+ event_name = "muc-occupant-pre-change";
+ event.orig_occupant = orig_occupant;
+ event.dest_occupant = dest_occupant;
+ end
+ if module:fire_event(event_name, event) then return true; end
+
+ local nick_changed = dest_occupant and orig_nick ~= dest_occupant.nick;
+
+ -- Check for nick conflicts
+ if dest_occupant ~= nil and not is_first_dest_session
+ and bare_jid ~= jid_bare(dest_occupant.bare_jid) then
+ -- new nick or has different bare real jid
+ log("debug", "%s couldn't join due to nick conflict: %s", real_jid, dest_occupant.nick);
+ local reply = st.error_reply(stanza, "cancel", "conflict"):up();
+ reply.tags[1].attr.code = "409";
+ origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
+ return true;
+ end
-local valid_whois = { moderators = true, anyone = true };
+ -- Send presence stanza about original occupant
+ if orig_occupant ~= nil and orig_occupant ~= dest_occupant then
+ local orig_x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";});
+ local dest_nick;
+ if dest_occupant == nil then -- Session is leaving
+ log("debug", "session %s is leaving occupant %s", real_jid, orig_occupant.nick);
+ if is_last_orig_session then
+ orig_occupant.role = nil;
+ end
+ orig_occupant:set_session(real_jid, stanza);
+ else
+ log("debug", "session %s is changing from occupant %s to %s", real_jid, orig_occupant.nick, dest_occupant.nick);
+ local generated_unavail = st.presence {from = orig_occupant.nick, to = real_jid, type = "unavailable"};
+ orig_occupant:set_session(real_jid, generated_unavail);
+ dest_nick = select(3, jid_split(dest_occupant.nick));
+ if not is_first_dest_session then -- User is swapping into another pre-existing session
+ log("debug", "session %s is swapping into multisession %s, showing it leave.", real_jid, dest_occupant.nick);
+ -- Show the other session leaving
+ local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";});
+ add_item(x, self:get_affiliation(bare_jid), "none");
+ local pr = st.presence{from = dest_occupant.nick, to = real_jid, type = "unavailable"}
+ :tag("status"):text("you are joining pre-existing session " .. dest_nick):up()
+ :add_child(x);
+ self:route_stanza(pr);
+ end
+ if is_first_dest_session and is_last_orig_session then -- Normal nick change
+ log("debug", "no sessions in %s left; publicly marking as nick change", orig_occupant.nick);
+ orig_x:tag("status", {code = "303";}):up();
+ else -- The session itself always needs to see a nick change
+ -- don't want to get our old nick's available presence,
+ -- so remove our session from there, and manually generate an unavailable
+ orig_occupant:remove_session(real_jid);
+ log("debug", "generating nick change for %s", real_jid);
+ local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";});
+ -- self:build_item_list(orig_occupant, x, false, dest_nick); -- COMPAT: clients get confused if they see other items besides their own
+ add_item(x, self:get_affiliation(bare_jid), orig_occupant.role, real_jid, dest_nick);
+ x:tag("status", {code = "303";}):up();
+ x:tag("status", {code = "110";}):up();
+ self:route_stanza(generated_unavail:add_child(x));
+ dest_nick = nil; -- set dest_nick to nil; so general populance doesn't see it for whole orig_occupant
+ end
+ end
-function room_mt:set_whois(whois)
- if valid_whois[whois] and self._data.whois ~= whois then
- self._data.whois = whois;
- if self.save then self:save(true); end
+ self:save_occupant(orig_occupant);
+ self:publicise_occupant_status(orig_occupant, orig_x, dest_nick);
+
+ if is_last_orig_session then
+ module:fire_event("muc-occupant-left", {
+ room = self;
+ nick = orig_occupant.nick;
+ occupant = orig_occupant;
+ origin = origin;
+ stanza = stanza;
+ });
+ end
end
-end
-
-function room_mt:get_whois()
- return self._data.whois;
-end
-local function construct_stanza_id(room, stanza)
- local from_jid, to_nick = stanza.attr.from, stanza.attr.to;
- local from_nick = room._jid_nick[from_jid];
- local occupant = room._occupants[to_nick];
- local to_jid = occupant.jid;
+ if dest_occupant ~= nil then
+ dest_occupant:set_session(real_jid, stanza);
+ local dest_x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";});
+ if orig_occupant == nil and self:get_whois() == "anyone" then
+ dest_x:tag("status", {code = "100"}):up();
+ end
+ self:save_occupant(dest_occupant);
+
+ if orig_occupant == nil or muc_x then
+ -- Send occupant list to newly joined user
+ self:send_occupant_list(real_jid, function(nick, occupant) -- luacheck: ignore 212
+ -- Don't include self
+ return occupant:get_presence(real_jid) == nil;
+ end)
+ end
+ local self_x;
+ if nick_changed then
+ self_x = st.clone(dest_x);
+ self_x:tag("status", {code="210"}):up();
+ end
+ self:publicise_occupant_status(dest_occupant, {base=dest_x,self=self_x});
+
+ if orig_occupant ~= nil and orig_occupant ~= dest_occupant and not is_last_orig_session then -- If user is swapping and wasn't last original session
+ log("debug", "session %s split nicks; showing %s rejoining", real_jid, orig_occupant.nick);
+ -- Show the original nick joining again
+ local pr = st.clone(orig_occupant:get_presence());
+ pr.attr.to = real_jid;
+ local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";});
+ self:build_item_list(orig_occupant, x, false);
+ -- TODO: new status code to inform client this was the multi-session it left?
+ pr:add_child(x);
+ self:route_stanza(pr);
+ end
- return from_nick, to_jid, base64.encode(to_jid.."\0"..stanza.attr.id.."\0"..md5(from_jid));
-end
-local function deconstruct_stanza_id(room, stanza)
- local from_jid_possiblybare, to_nick = stanza.attr.from, stanza.attr.to;
- local from_jid, id, to_jid_hash = (base64.decode(stanza.attr.id) or ""):match("^(%Z+)%z(%Z*)%z(.+)$");
- local from_nick = room._jid_nick[from_jid];
-
- if not(from_nick) then return; end
- if not(from_jid_possiblybare == from_jid or from_jid_possiblybare == jid_bare(from_jid)) then return; end
-
- local occupant = room._occupants[to_nick];
- for to_jid in pairs(occupant and occupant.sessions or {}) do
- if md5(to_jid) == to_jid_hash then
- return from_nick, to_jid, id;
+ if orig_occupant == nil or muc_x then
+ if is_first_dest_session then
+ module:fire_event("muc-occupant-joined", {
+ room = self;
+ nick = dest_occupant.nick;
+ occupant = dest_occupant;
+ stanza = stanza;
+ origin = origin;
+ });
+ end
+ module:fire_event("muc-occupant-session-new", {
+ room = self;
+ nick = dest_occupant.nick;
+ occupant = dest_occupant;
+ stanza = stanza;
+ origin = origin;
+ jid = real_jid;
+ });
end
end
+ return true;
end
+function room_mt:handle_presence_to_occupant(origin, stanza)
+ local type = stanza.attr.type;
+ if type == "error" then -- error, kick em out!
+ return self:handle_kickable(origin, stanza)
+ elseif type == nil or type == "unavailable" then
+ return self:handle_normal_presence(origin, stanza);
+ elseif type ~= 'result' then -- bad type
+ if type ~= 'visible' and type ~= 'invisible' then -- COMPAT ejabberd can broadcast or forward XEP-0018 presences
+ origin.send(st.error_reply(stanza, "modify", "bad-request")); -- FIXME correct error?
+ end
+ end
+ return true;
+end
-function room_mt:handle_to_occupant(origin, stanza) -- PM, vCards, etc
+function room_mt:handle_iq_to_occupant(origin, stanza)
local from, to = stanza.attr.from, stanza.attr.to;
- local room = jid_bare(to);
- local current_nick = self._jid_nick[from];
local type = stanza.attr.type;
- log("debug", "room: %s, current_nick: %s, stanza: %s", room or "nil", current_nick or "nil", stanza:top_tag());
- if (select(2, jid_split(from)) == muc_domain) then error("Presence from the MUC itself!!!"); end
- if stanza.name == "presence" then
- local pr = get_filtered_presence(stanza);
- pr.attr.from = current_nick;
- if type == "error" then -- error, kick em out!
- if current_nick then
- log("debug", "kicking %s from %s", current_nick, room);
- self:handle_to_occupant(origin, build_unavailable_presence_from_error(stanza));
- end
- elseif type == "unavailable" then -- unavailable
- if current_nick then
- log("debug", "%s leaving %s", current_nick, room);
- self._jid_nick[from] = nil;
- local occupant = self._occupants[current_nick];
- local new_jid = next(occupant.sessions);
- if new_jid == from then new_jid = next(occupant.sessions, new_jid); end
- if new_jid then
- local jid = occupant.jid;
- occupant.jid = new_jid;
- occupant.sessions[from] = nil;
- pr.attr.to = from;
- pr:tag("x", {xmlns='http://jabber.org/protocol/muc#user'})
- :tag("item", {affiliation=occupant.affiliation or "none", role='none'}):up()
- :tag("status", {code='110'}):up();
- self:_route_stanza(pr);
- if jid ~= new_jid then
- pr = st.clone(occupant.sessions[new_jid])
- :tag("x", {xmlns='http://jabber.org/protocol/muc#user'})
- :tag("item", {affiliation=occupant.affiliation or "none", role=occupant.role or "none"});
- pr.attr.from = current_nick;
- self:broadcast_except_nick(pr, current_nick);
- end
- else
- occupant.role = 'none';
- self:broadcast_presence(pr, from);
- self._occupants[current_nick] = nil;
+ local id = stanza.attr.id;
+ local occupant = self:get_occupant_by_nick(to);
+ if (type == "error" or type == "result") then
+ do -- deconstruct_stanza_id
+ if not occupant then return nil; end
+ local from_jid, orig_id, to_jid_hash = (base64.decode(id) or ""):match("^(%Z+)%z(%Z*)%z(.+)$");
+ if not(from == from_jid or from == jid_bare(from_jid)) then return nil; end
+ local from_occupant_jid = self:get_occupant_jid(from_jid);
+ if from_occupant_jid == nil then return nil; end
+ local session_jid
+ for to_jid in occupant:each_session() do
+ if md5(to_jid) == to_jid_hash then
+ session_jid = to_jid;
+ break;
end
end
- elseif not type then -- available
- if current_nick then
- --if #pr == #stanza or current_nick ~= to then -- commented because google keeps resending directed presence
- if current_nick == to then -- simple presence
- log("debug", "%s broadcasted presence", current_nick);
- self._occupants[current_nick].sessions[from] = pr;
- self:broadcast_presence(pr, from);
- else -- change nick
- -- a MUC service MUST NOT allow empty or invisible Room Nicknames
- -- (i.e., Room Nicknames that consist only of one or more space characters).
- if not select(3, jid_split(to)):find("[^ ]") then -- resourceprep turns all whitespace into 0x20
- module:log("debug", "Rejecting invisible nickname");
- origin.send(st.error_reply(stanza, "cancel", "not-allowed"));
- return;
- end
- local occupant = self._occupants[current_nick];
- local is_multisession = next(occupant.sessions, next(occupant.sessions));
- if self._occupants[to] or is_multisession then
- log("debug", "%s couldn't change nick", current_nick);
- local reply = st.error_reply(stanza, "cancel", "conflict"):up();
- reply.tags[1].attr.code = "409";
- origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
- else
- local data = self._occupants[current_nick];
- local to_nick = select(3, jid_split(to));
- if to_nick then
- log("debug", "%s (%s) changing nick to %s", current_nick, data.jid, to);
- local p = st.presence({type='unavailable', from=current_nick});
- self:broadcast_presence(p, from, '303', to_nick);
- self._occupants[current_nick] = nil;
- self._occupants[to] = data;
- self._jid_nick[from] = to;
- pr.attr.from = to;
- self._occupants[to].sessions[from] = pr;
- self:broadcast_presence(pr, from);
- else
- --TODO malformed-jid
- end
- end
- end
- --else -- possible rejoin
- -- log("debug", "%s had connection replaced", current_nick);
- -- self:handle_to_occupant(origin, st.presence({type='unavailable', from=from, to=to})
- -- :tag('status'):text('Replaced by new connection'):up()); -- send unavailable
- -- self:handle_to_occupant(origin, stanza); -- resend available
- --end
- else -- enter room
- -- a MUC service MUST NOT allow empty or invisible Room Nicknames
- -- (i.e., Room Nicknames that consist only of one or more space characters).
- if not select(3, jid_split(to)):find("[^ ]") then -- resourceprep turns all whitespace into 0x20
- module:log("debug", "Rejecting invisible nickname");
- origin.send(st.error_reply(stanza, "cancel", "not-allowed"));
- return;
- end
- local new_nick = to;
- local is_merge;
- if self._occupants[to] then
- if jid_bare(from) ~= jid_bare(self._occupants[to].jid) then
- new_nick = nil;
- end
- is_merge = true;
- end
- local password = stanza:get_child("x", "http://jabber.org/protocol/muc");
- password = password and password:get_child("password", "http://jabber.org/protocol/muc");
- password = password and password[1] ~= "" and password[1];
- if self:get_password() and self:get_password() ~= password then
- log("debug", "%s couldn't join due to invalid password: %s", from, to);
- local reply = st.error_reply(stanza, "auth", "not-authorized"):up();
- reply.tags[1].attr.code = "401";
- origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
- elseif not new_nick then
- log("debug", "%s couldn't join due to nick conflict: %s", from, to);
- local reply = st.error_reply(stanza, "cancel", "conflict"):up();
- reply.tags[1].attr.code = "409";
- origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
- else
- log("debug", "%s joining as %s", from, to);
- if not next(self._affiliations) then -- new room, no owners
- self._affiliations[jid_bare(from)] = "owner";
- if self.locked and not stanza:get_child("x", "http://jabber.org/protocol/muc") then
- self.locked = nil; -- Older groupchat protocol doesn't lock
- end
- elseif self.locked then -- Deny entry
- module:log("debug", "Room is locked, denying entry");
- origin.send(st.error_reply(stanza, "cancel", "item-not-found"));
- return;
- end
- local affiliation = self:get_affiliation(from);
- local role = self:get_default_role(affiliation)
- if role then -- new occupant
- if not is_merge then
- self._occupants[to] = {affiliation=affiliation, role=role, jid=from, sessions={[from]=get_filtered_presence(stanza)}};
- else
- self._occupants[to].sessions[from] = get_filtered_presence(stanza);
- end
- self._jid_nick[from] = to;
- self:send_occupant_list(from);
- pr.attr.from = to;
- pr:tag("x", {xmlns='http://jabber.org/protocol/muc#user'})
- :tag("item", {affiliation=affiliation or "none", role=role or "none"}):up();
- if not is_merge then
- self:broadcast_except_nick(pr, to);
- end
- pr:tag("status", {code='110'}):up();
- if self._data.whois == 'anyone' then
- pr:tag("status", {code='100'}):up();
- end
- if self.locked then
- pr:tag("status", {code='201'}):up();
- end
- pr.attr.to = from;
- self:_route_stanza(pr);
- self:send_history(from, stanza);
- self:send_subject(from);
- elseif not affiliation then -- registration required for entering members-only room
- local reply = st.error_reply(stanza, "auth", "registration-required"):up();
- reply.tags[1].attr.code = "407";
- origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
- else -- banned
- local reply = st.error_reply(stanza, "auth", "forbidden"):up();
- reply.tags[1].attr.code = "403";
- origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
- end
- end
- end
- elseif type ~= 'result' then -- bad type
- if type ~= 'visible' and type ~= 'invisible' then -- COMPAT ejabberd can broadcast or forward XEP-0018 presences
- origin.send(st.error_reply(stanza, "modify", "bad-request")); -- FIXME correct error?
- end
+ if session_jid == nil then return nil; end
+ stanza.attr.from, stanza.attr.to, stanza.attr.id = from_occupant_jid, session_jid, orig_id;
end
- elseif not current_nick then -- not in room
- if (type == "error" or type == "result") and stanza.name == "iq" then
- local id = stanza.attr.id;
- stanza.attr.from, stanza.attr.to, stanza.attr.id = deconstruct_stanza_id(self, stanza);
- if stanza.attr.id then
- self:_route_stanza(stanza);
- end
- stanza.attr.from, stanza.attr.to, stanza.attr.id = from, to, id;
- elseif type ~= "error" then
+ log("debug", "%s sent private iq stanza to %s (%s)", from, to, stanza.attr.to);
+ self:route_stanza(stanza);
+ stanza.attr.from, stanza.attr.to, stanza.attr.id = from, to, id;
+ return true;
+ else -- Type is "get" or "set"
+ local current_nick = self:get_occupant_jid(from);
+ if not current_nick then
origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));
+ return true;
end
- elseif stanza.name == "message" and type == "groupchat" then -- groupchat messages not allowed in PM
- origin.send(st.error_reply(stanza, "modify", "bad-request"));
- elseif current_nick and stanza.name == "message" and type == "error" and is_kickable_error(stanza) then
- log("debug", "%s kicked from %s for sending an error message", current_nick, self.jid);
- self:handle_to_occupant(origin, build_unavailable_presence_from_error(stanza)); -- send unavailable
- else -- private stanza
- local o_data = self._occupants[to];
- if o_data then
- log("debug", "%s sent private stanza to %s (%s)", from, to, o_data.jid);
- if stanza.name == "iq" then
- local id = stanza.attr.id;
- if stanza.attr.type == "get" or stanza.attr.type == "set" then
- stanza.attr.from, stanza.attr.to, stanza.attr.id = construct_stanza_id(self, stanza);
- else
- stanza.attr.from, stanza.attr.to, stanza.attr.id = deconstruct_stanza_id(self, stanza);
- end
- if type == 'get' and stanza.tags[1].attr.xmlns == 'vcard-temp' then
- stanza.attr.to = jid_bare(stanza.attr.to);
- end
- if stanza.attr.id then
- self:_route_stanza(stanza);
- end
- stanza.attr.from, stanza.attr.to, stanza.attr.id = from, to, id;
- else -- message
- stanza:tag("x", { xmlns = "http://jabber.org/protocol/muc#user" }):up();
- stanza.attr.from = current_nick;
- for jid in pairs(o_data.sessions) do
- stanza.attr.to = jid;
- self:_route_stanza(stanza);
- end
- stanza.attr.from, stanza.attr.to = from, to;
- end
- elseif type ~= "error" and type ~= "result" then -- recipient not in room
+ if not occupant then -- recipient not in room
origin.send(st.error_reply(stanza, "cancel", "item-not-found", "Recipient not in room"));
+ return true;
+ end
+ do -- construct_stanza_id
+ stanza.attr.id = base64.encode(occupant.jid.."\0"..stanza.attr.id.."\0"..md5(from));
+ end
+ stanza.attr.from, stanza.attr.to = current_nick, occupant.jid;
+ log("debug", "%s sent private iq stanza to %s (%s)", from, to, occupant.jid);
+ if stanza.tags[1].attr.xmlns == 'vcard-temp' then
+ stanza.attr.to = jid_bare(stanza.attr.to);
+ end
+ self:route_stanza(stanza);
+ stanza.attr.from, stanza.attr.to, stanza.attr.id = from, to, id;
+ return true;
+ end
+end
+
+function room_mt:handle_message_to_occupant(origin, stanza)
+ local from, to = stanza.attr.from, stanza.attr.to;
+ local current_nick = self:get_occupant_jid(from);
+ local type = stanza.attr.type;
+ if not current_nick then -- not in room
+ if type ~= "error" then
+ origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));
end
+ return true;
end
+ if type == "groupchat" then -- groupchat messages not allowed in PM
+ origin.send(st.error_reply(stanza, "modify", "bad-request"));
+ return true;
+ elseif type == "error" and is_kickable_error(stanza) then
+ log("debug", "%s kicked from %s for sending an error message", current_nick, self.jid);
+ return self:handle_kickable(origin, stanza); -- send unavailable
+ end
+
+ local o_data = self:get_occupant_by_nick(to);
+ if not o_data then
+ origin.send(st.error_reply(stanza, "cancel", "item-not-found", "Recipient not in room"));
+ return true;
+ end
+ log("debug", "%s sent private message stanza to %s (%s)", from, to, o_data.jid);
+ stanza:tag("x", { xmlns = "http://jabber.org/protocol/muc#user" }):up();
+ stanza.attr.from = current_nick;
+ self:route_to_occupant(o_data, stanza)
+ -- TODO: Remove x tag?
+ stanza.attr.from = from;
+ return true;
end
function room_mt:send_form(origin, stanza)
@@ -649,412 +773,382 @@ function room_mt:get_form_layout(actor)
name = 'FORM_TYPE',
type = 'hidden',
value = 'http://jabber.org/protocol/muc#roomconfig'
- },
- {
- name = 'muc#roomconfig_roomname',
- type = 'text-single',
- label = 'Name',
- value = self:get_name() or "",
- },
- {
- name = 'muc#roomconfig_roomdesc',
- type = 'text-single',
- label = 'Description',
- value = self:get_description() or "",
- },
- {
- name = 'muc#roomconfig_persistentroom',
- type = 'boolean',
- label = 'Make Room Persistent?',
- value = self:get_persistent()
- },
- {
- name = 'muc#roomconfig_publicroom',
- type = 'boolean',
- label = 'Make Room Publicly Searchable?',
- value = not self:get_hidden()
- },
- {
- name = 'muc#roomconfig_changesubject',
- type = 'boolean',
- label = 'Allow Occupants to Change Subject?',
- value = self:get_changesubject()
- },
- {
- name = 'muc#roomconfig_whois',
- type = 'list-single',
- label = 'Who May Discover Real JIDs?',
- value = {
- { value = 'moderators', label = 'Moderators Only', default = self._data.whois == 'moderators' },
- { value = 'anyone', label = 'Anyone', default = self._data.whois == 'anyone' }
- }
- },
- {
- name = 'muc#roomconfig_roomsecret',
- type = 'text-private',
- label = 'Password',
- value = self:get_password() or "",
- },
- {
- name = 'muc#roomconfig_moderatedroom',
- type = 'boolean',
- label = 'Make Room Moderated?',
- value = self:get_moderated()
- },
- {
- name = 'muc#roomconfig_membersonly',
- type = 'boolean',
- label = 'Make Room Members-Only?',
- value = self:get_members_only()
- },
- {
- name = 'muc#roomconfig_historylength',
- type = 'text-single',
- label = 'Maximum Number of History Messages Returned by Room',
- value = tostring(self:get_historylength())
- },
- {
- name = 'muc#roomconfig_defaulthistorymessages',
- type = 'text-single',
- label = 'Default Number of History Messages Returned by Room',
- value = tostring(self:get_defaulthistorymessages())
}
});
return module:fire_event("muc-config-form", { room = self, actor = actor, form = form }) or form;
end
function room_mt:process_form(origin, stanza)
- local query = stanza.tags[1];
- local form;
- for _, tag in ipairs(query.tags) do if tag.name == "x" and tag.attr.xmlns == "jabber:x:data" then form = tag; break; end end
- if not form then origin.send(st.error_reply(stanza, "cancel", "service-unavailable")); return; end
- if form.attr.type == "cancel" then origin.send(st.reply(stanza)); return; end
- if form.attr.type ~= "submit" then origin.send(st.error_reply(stanza, "cancel", "bad-request", "Not a submitted form")); return; end
-
- if form.tags[1] == nil then
- -- instant room
- if self.save then self:save(true); end
+ local form = stanza.tags[1]:get_child("x", "jabber:x:data");
+ if form.attr.type == "cancel" then
origin.send(st.reply(stanza));
- return true;
- end
+ elseif form.attr.type == "submit" then
+ local fields, errors, present;
+ if form.tags[1] == nil then -- Instant room
+ fields, present = {}, {};
+ else
+ fields, errors, present = self:get_form_layout(stanza.attr.from):data(form);
+ if fields.FORM_TYPE ~= "http://jabber.org/protocol/muc#roomconfig" then
+ origin.send(st.error_reply(stanza, "cancel", "bad-request", "Form is not of type room configuration"));
+ return true;
+ end
+ end
- local fields, errors, present = self:get_form_layout(stanza.attr.from):data(form);
- if fields.FORM_TYPE ~= "http://jabber.org/protocol/muc#roomconfig" then
- origin.send(st.error_reply(stanza, "cancel", "bad-request", "Form is not of type room configuration"));
- return;
- end
-
- local changed = {};
-
- local function handle_option(name, field, allowed)
- if not present[field] then return; end
- local new = fields[field];
- if allowed and not allowed[new] then return; end
- if new == self["get_"..name](self) then return; end
- changed[name] = true;
- self["set_"..name](self, new);
- end
-
- local event = { room = self, fields = fields, changed = changed, stanza = stanza, origin = origin, update_option = handle_option };
- module:fire_event("muc-config-submitted", event);
-
- handle_option("name", "muc#roomconfig_roomname");
- handle_option("description", "muc#roomconfig_roomdesc");
- handle_option("persistent", "muc#roomconfig_persistentroom");
- handle_option("moderated", "muc#roomconfig_moderatedroom");
- handle_option("members_only", "muc#roomconfig_membersonly");
- handle_option("public", "muc#roomconfig_publicroom");
- handle_option("changesubject", "muc#roomconfig_changesubject");
- handle_option("historylength", "muc#roomconfig_historylength");
- handle_option("defaulthistorymessages", "muc#roomconfig_defaulthistorymessages");
- handle_option("whois", "muc#roomconfig_whois", valid_whois);
- handle_option("password", "muc#roomconfig_roomsecret");
-
- if self.save then self:save(true); end
- if self.locked then
- module:fire_event("muc-room-unlocked", { room = self });
- self.locked = nil;
- end
- origin.send(st.reply(stanza));
-
- if next(changed) then
- local msg = st.message({type='groupchat', from=self.jid})
- :tag('x', {xmlns='http://jabber.org/protocol/muc#user'})
- :tag('status', {code = '104'}):up();
- if changed.whois then
- local code = (self:get_whois() == 'moderators') and "173" or "172";
- msg.tags[1]:tag('status', {code = code}):up();
+ local event = {room = self; origin = origin; stanza = stanza; fields = fields; status_codes = {};};
+ function event.update_option(name, field, allowed)
+ local new = fields[field];
+ if new == nil then return; end
+ if allowed and not allowed[new] then return; end
+ if new == self["get_"..name](self) then return; end
+ event.status_codes["104"] = true;
+ self["set_"..name](self, new);
+ return true;
+ end
+ module:fire_event("muc-config-submitted", event);
+ for submitted_field in pairs(present) do
+ event.field, event.value = submitted_field, fields[submitted_field];
+ module:fire_event("muc-config-submitted/"..submitted_field, event);
end
- self:broadcast_message(msg, false)
+ event.field, event.value = nil, nil;
+
+ self:save(true);
+ origin.send(st.reply(stanza));
+
+ if next(event.status_codes) then
+ local msg = st.message({type='groupchat', from=self.jid})
+ :tag('x', {xmlns='http://jabber.org/protocol/muc#user'})
+ for code in pairs(event.status_codes) do
+ msg:tag("status", {code = code;}):up();
+ end
+ msg:up();
+ self:broadcast_message(msg);
+ end
+ else
+ origin.send(st.error_reply(stanza, "cancel", "bad-request", "Not a submitted form"));
end
+ return true;
end
-function room_mt:destroy(newjid, reason, password)
- local pr = st.presence({type = "unavailable"})
- :tag("x", {xmlns = "http://jabber.org/protocol/muc#user"})
- :tag("item", { affiliation='none', role='none' }):up()
- :tag("destroy", {jid=newjid})
- if reason then pr:tag("reason"):text(reason):up(); end
- if password then pr:tag("password"):text(password):up(); end
- for nick, occupant in pairs(self._occupants) do
- pr.attr.from = nick;
- for jid in pairs(occupant.sessions) do
- pr.attr.to = jid;
- self:_route_stanza(pr);
- self._jid_nick[jid] = nil;
- end
- self._occupants[nick] = nil;
+-- Removes everyone from the room
+function room_mt:clear(x)
+ x = x or st.stanza("x", {xmlns='http://jabber.org/protocol/muc#user'});
+ local occupants_updated = {};
+ for nick, occupant in self:each_occupant() do -- luacheck: ignore 213
+ occupant.role = nil;
+ self:save_occupant(occupant);
+ occupants_updated[occupant] = true;
+ end
+ for occupant in pairs(occupants_updated) do
+ self:publicise_occupant_status(occupant, x);
+ module:fire_event("muc-occupant-left", { room = self; nick = occupant.nick; occupant = occupant;});
end
- self:set_persistent(false);
+end
+
+function room_mt:destroy(newjid, reason, password)
+ local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"})
+ :tag("item", { affiliation='none', role='none' }):up()
+ :tag("destroy", {jid=newjid});
+ if reason then x:tag("reason"):text(reason):up(); end
+ if password then x:tag("password"):text(password):up(); end
+ x:up();
+ self:clear(x);
module:fire_event("muc-room-destroyed", { room = self });
return true;
end
-function room_mt:handle_to_room(origin, stanza) -- presence changes and groupchat messages, along with disco/etc
- local type = stanza.attr.type;
- local xmlns = stanza.tags[1] and stanza.tags[1].attr.xmlns;
- if stanza.name == "iq" then
- if xmlns == "http://jabber.org/protocol/disco#info" and type == "get" and not stanza.tags[1].attr.node then
- origin.send(self:get_disco_info(stanza));
- elseif xmlns == "http://jabber.org/protocol/disco#items" and type == "get" and not stanza.tags[1].attr.node then
- origin.send(self:get_disco_items(stanza));
- elseif xmlns == "http://jabber.org/protocol/muc#admin" then
- local actor = stanza.attr.from;
- local affiliation = self:get_affiliation(actor);
- local current_nick = self._jid_nick[actor];
- local role = current_nick and self._occupants[current_nick].role or self:get_default_role(affiliation);
- if type == "set" then
- local at_least_one_item_provided = false;
- local callback = function() origin.send(st.reply(stanza)); end
-
- -- Gather all changes to affiliations and roles
- local jid_affiliation = {};
- local jidnick_role = {};
- for item in stanza.tags[1]:childtags("item") do
- at_least_one_item_provided = true;
-
- if item.attr.jid then -- Validate provided JID
- item.attr.jid = jid_prep(item.attr.jid);
- if not item.attr.jid then
- origin.send(st.error_reply(stanza, "modify", "jid-malformed"));
- return;
- end
- end
- if not item.attr.jid and item.attr.nick then -- COMPAT Workaround for Miranda sending 'nick' instead of 'jid' when changing affiliation
- local occupant = self._occupants[self.jid.."/"..item.attr.nick];
- if occupant then item.attr.jid = occupant.jid; end
- elseif not item.attr.nick and item.attr.jid then
- local nick = self._jid_nick[item.attr.jid];
- if nick then item.attr.nick = select(3, jid_split(nick)); end
- end
-
- local reason = item.tags[1] and item.tags[1].name == "reason" and #item.tags[1] == 1 and item.tags[1][1];
- if item.attr.affiliation and item.attr.jid and not item.attr.role then
- jid_affiliation[item.attr.jid] = { ["affiliation"] = item.attr.affiliation, ["reason"] = reason };
- elseif item.attr.role and item.attr.nick and not item.attr.affiliation then
- jidnick_role[item.attr.jid.."/"..item.attr.nick] = { ["role"] = item.attr.role, ["reason"] = reason };
- else
- origin.send(st.error_reply(stanza, "cancel", "bad-request"));
- return;
- end
- end
+function room_mt:handle_disco_info_get_query(origin, stanza)
+ origin.send(self:get_disco_info(stanza));
+ return true;
+end
- if not at_least_one_item_provided then
- origin.send(st.error_reply(stanza, "cancel", "bad-request"));
- return;
- else
- local can_set_affiliations, errtype_aff, err_aff = self:can_set_affiliations(actor, jid_affiliation)
- local can_set_roles, errtype_role, err_role = self:can_set_roles(actor, jidnick_role)
-
- if can_set_affiliations and can_set_roles then
- local nb_affiliation_changes = 0;
- for _ in pairs(jid_affiliation) do nb_affiliation_changes = nb_affiliation_changes + 1; end
- local nb_role_changes = 0;
- for _ in pairs(jidnick_role) do nb_role_changes = nb_role_changes + 1; end
-
- if nb_affiliation_changes > 0 and nb_role_changes > 0 then
- origin.send(st.error_reply(stanza, "cancel", "bad-request"));
- end
- if nb_affiliation_changes > 0 then
- self:set_affiliations(actor, jid_affiliation, callback);
- end
- if nb_role_changes > 0 then
- self:set_roles(actor, jidnick_role, callback);
- end
- else
- if not can_set_affiliations then
- origin.send(st.error_reply(stanza, errtype_aff, err_aff));
- elseif not can_set_roles then
- origin.send(st.error_reply(stanza, errtype_role, err_role));
- else
- origin.send(st.error_reply(stanza, "cancel", "bad-request"));
- end
-
- return;
- end
- end
- elseif type == "get" then
- local item = stanza.tags[1].tags[1];
- if item and item.name == "item" then
- local _aff = item.attr.affiliation;
- local _rol = item.attr.role;
- if _aff and not _rol then
- if affiliation == "owner" or (affiliation == "admin" and _aff ~= "owner" and _aff ~= "admin")
- or (affiliation and affiliation ~= "outcast" and self:get_members_only() and self:get_whois() == "anyone") then
- local reply = st.reply(stanza):query("http://jabber.org/protocol/muc#admin");
- for jid, affiliation in pairs(self._affiliations) do
- if affiliation == _aff then
- reply:tag("item", {affiliation = _aff, jid = jid}):up();
- end
- end
- origin.send(reply);
- else
- origin.send(st.error_reply(stanza, "auth", "forbidden"));
- end
- elseif _rol and not _aff then
- if role == "moderator" then
- -- TODO allow admins and owners not in room? Provide read-only access to everyone who can see the participants anyway?
- if _rol == "none" then _rol = nil; end
- local reply = st.reply(stanza):query("http://jabber.org/protocol/muc#admin");
- for occupant_jid, occupant in pairs(self._occupants) do
- if occupant.role == _rol then
- reply:tag("item", {
- nick = select(3, jid_split(occupant_jid)),
- role = _rol or "none",
- affiliation = occupant.affiliation or "none",
- jid = occupant.jid
- }):up();
- end
- end
- origin.send(reply);
- else
- origin.send(st.error_reply(stanza, "auth", "forbidden"));
- end
- else
- origin.send(st.error_reply(stanza, "cancel", "bad-request"));
- end
- else
- origin.send(st.error_reply(stanza, "cancel", "bad-request"));
- end
- end
- elseif xmlns == "http://jabber.org/protocol/muc#owner" and (type == "get" or type == "set") and stanza.tags[1].name == "query" then
- if self:get_affiliation(stanza.attr.from) ~= "owner" then
- origin.send(st.error_reply(stanza, "auth", "forbidden", "Only owners can configure rooms"));
- elseif stanza.attr.type == "get" then
- self:send_form(origin, stanza);
- elseif stanza.attr.type == "set" then
- local child = stanza.tags[1].tags[1];
- if not child then
- origin.send(st.error_reply(stanza, "modify", "bad-request"));
- elseif child.name == "destroy" then
- local newjid = child.attr.jid;
- local reason, password;
- for _,tag in ipairs(child.tags) do
- if tag.name == "reason" then
- reason = #tag.tags == 0 and tag[1];
- elseif tag.name == "password" then
- password = #tag.tags == 0 and tag[1];
- end
- end
- self:destroy(newjid, reason, password);
- origin.send(st.reply(stanza));
- else
- self:process_form(origin, stanza);
- end
- end
- elseif type == "set" or type == "get" then
- origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
+function room_mt:handle_disco_items_get_query(origin, stanza)
+ origin.send(self:get_disco_items(stanza));
+ return true;
+end
+
+function room_mt:handle_admin_query_set_command(origin, stanza)
+ local item = stanza.tags[1].tags[1];
+ if not item then
+ origin.send(st.error_reply(stanza, "cancel", "bad-request"));
+ end
+ if item.attr.jid then -- Validate provided JID
+ item.attr.jid = jid_prep(item.attr.jid);
+ if not item.attr.jid then
+ origin.send(st.error_reply(stanza, "modify", "jid-malformed"));
+ return true;
end
- elseif stanza.name == "message" and type == "groupchat" then
- local from = stanza.attr.from;
- local current_nick = self._jid_nick[from];
- local occupant = self._occupants[current_nick];
- if not occupant then -- not in room
- origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));
- elseif occupant.role == "visitor" then
- origin.send(st.error_reply(stanza, "auth", "forbidden"));
- else
- local from = stanza.attr.from;
- stanza.attr.from = current_nick;
- local subject = stanza:get_child_text("subject");
- if subject then
- if occupant.role == "moderator" or
- ( self._data.changesubject and occupant.role == "participant" ) then -- and participant
- self:set_subject(current_nick, subject);
- else
- stanza.attr.from = from;
- origin.send(st.error_reply(stanza, "auth", "forbidden"));
- end
- else
- self:broadcast_message(stanza, self:get_historylength() > 0 and stanza:get_child("body"));
+ end
+ if not item.attr.jid and item.attr.nick then -- COMPAT Workaround for Miranda sending 'nick' instead of 'jid' when changing affiliation
+ local occupant = self:get_occupant_by_nick(self.jid.."/"..item.attr.nick);
+ if occupant then item.attr.jid = occupant.jid; end
+ elseif not item.attr.nick and item.attr.jid then
+ local nick = self:get_occupant_jid(item.attr.jid);
+ if nick then item.attr.nick = select(3, jid_split(nick)); end
+ end
+ local actor = stanza.attr.from;
+ local reason = item:get_child_text("reason");
+ local success, errtype, err
+ if item.attr.affiliation and item.attr.jid and not item.attr.role then
+ success, errtype, err = self:set_affiliation(actor, item.attr.jid, item.attr.affiliation, reason);
+ elseif item.attr.role and item.attr.nick and not item.attr.affiliation then
+ success, errtype, err = self:set_role(actor, self.jid.."/"..item.attr.nick, item.attr.role, reason);
+ else
+ success, errtype, err = nil, "cancel", "bad-request";
+ end
+ self:save(true);
+ if not success then
+ origin.send(st.error_reply(stanza, errtype, err));
+ else
+ origin.send(st.reply(stanza));
+ end
+ return true;
+end
+
+function room_mt:handle_admin_query_get_command(origin, stanza)
+ local actor = stanza.attr.from;
+ local affiliation = self:get_affiliation(actor);
+ local item = stanza.tags[1].tags[1];
+ local _aff = item.attr.affiliation;
+ local _aff_rank = valid_affiliations[_aff or "none"];
+ local _rol = item.attr.role;
+ if _aff and _aff_rank and not _rol then
+ -- You need to be at least an admin, and be requesting info about your affifiliation or lower
+ -- e.g. an admin can't ask for a list of owners
+ local affiliation_rank = valid_affiliations[affiliation or "none"];
+ if affiliation_rank >= valid_affiliations.admin and affiliation_rank >= _aff_rank
+ or self:get_members_only() and self:get_whois() == "anyone" and affiliation_rank >= valid_affiliations.member then
+ local reply = st.reply(stanza):query("http://jabber.org/protocol/muc#admin");
+ for jid in self:each_affiliation(_aff or "none") do
+ reply:tag("item", {affiliation = _aff, jid = jid}):up();
end
- stanza.attr.from = from;
- end
- elseif stanza.name == "message" and type == "error" and is_kickable_error(stanza) then
- local current_nick = self._jid_nick[stanza.attr.from];
- log("debug", "%s kicked from %s for sending an error message", current_nick, self.jid);
- self:handle_to_occupant(origin, build_unavailable_presence_from_error(stanza)); -- send unavailable
- elseif stanza.name == "presence" then -- hack - some buggy clients send presence updates to the room rather than their nick
- local to = stanza.attr.to;
- local current_nick = self._jid_nick[stanza.attr.from];
- if current_nick then
- stanza.attr.to = current_nick;
- self:handle_to_occupant(origin, stanza);
- stanza.attr.to = to;
- elseif type ~= "error" and type ~= "result" then
- origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
+ origin.send(reply:up());
+ return true;
+ else
+ origin.send(st.error_reply(stanza, "auth", "forbidden"));
+ return true;
end
- elseif stanza.name == "message" and not(type == "chat" or type == "error" or type == "groupchat" or type == "headline") and #stanza.tags == 1
- and self._jid_nick[stanza.attr.from] and stanza.tags[1].name == "x" and stanza.tags[1].attr.xmlns == "http://jabber.org/protocol/muc#user" then
- local x = stanza.tags[1];
- local payload = (#x.tags == 1 and x.tags[1]);
- if payload and payload.name == "invite" and payload.attr.to then
- local _from, _to = stanza.attr.from, stanza.attr.to;
- local _invitee = jid_prep(payload.attr.to);
- if _invitee then
- local _reason = payload.tags[1] and payload.tags[1].name == 'reason' and #payload.tags[1].tags == 0 and payload.tags[1][1];
- local invite = st.message({from = _to, to = _invitee, id = stanza.attr.id})
- :tag('x', {xmlns='http://jabber.org/protocol/muc#user'})
- :tag('invite', {from=_from})
- :tag('reason'):text(_reason or ""):up()
- :up();
- if self:get_password() then
- invite:tag("password"):text(self:get_password()):up();
- end
- invite:up()
- :tag('x', {xmlns="jabber:x:conference", jid=_to}) -- COMPAT: Some older clients expect this
- :text(_reason or "")
- :up()
- :tag('body') -- Add a plain message for clients which don't support invites
- :text(_from..' invited you to the room '.._to..(_reason and (' ('.._reason..')') or ""))
- :up();
- if self:get_members_only() and not self:get_affiliation(_invitee) then
- log("debug", "%s invited %s into members only room %s, granting membership", _from, _invitee, _to);
- self:set_affiliation(_from, _invitee, "member", nil, "Invited by " .. self._jid_nick[_from])
+ elseif _rol and valid_roles[_rol or "none"] and not _aff then
+ local role = self:get_role(self:get_occupant_jid(actor)) or self:get_default_role(affiliation);
+ if valid_roles[role or "none"] >= valid_roles.moderator then
+ if _rol == "none" then _rol = nil; end
+ local reply = st.reply(stanza):query("http://jabber.org/protocol/muc#admin");
+ -- TODO: whois check here? (though fully anonymous rooms are not supported)
+ for occupant_jid, occupant in self:each_occupant() do
+ if occupant.role == _rol then
+ local nick = select(3,jid_split(occupant_jid));
+ self:build_item_list(occupant, reply, false, nick);
end
- self:_route_stanza(invite);
- else
- origin.send(st.error_reply(stanza, "cancel", "jid-malformed"));
end
+ origin.send(reply:up());
+ return true;
else
- origin.send(st.error_reply(stanza, "cancel", "bad-request"));
+ origin.send(st.error_reply(stanza, "auth", "forbidden"));
+ return true;
end
else
- if type == "error" or type == "result" then return; end
- origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
+ origin.send(st.error_reply(stanza, "cancel", "bad-request"));
+ return true;
end
end
-function room_mt:handle_stanza(origin, stanza)
- local to_node, to_host, to_resource = jid_split(stanza.attr.to);
- if to_resource then
- self:handle_to_occupant(origin, stanza);
+function room_mt:handle_owner_query_get_to_room(origin, stanza)
+ if self:get_affiliation(stanza.attr.from) ~= "owner" then
+ origin.send(st.error_reply(stanza, "auth", "forbidden", "Only owners can configure rooms"));
+ return true;
+ end
+
+ self:send_form(origin, stanza);
+ return true;
+end
+function room_mt:handle_owner_query_set_to_room(origin, stanza)
+ if self:get_affiliation(stanza.attr.from) ~= "owner" then
+ origin.send(st.error_reply(stanza, "auth", "forbidden", "Only owners can configure rooms"));
+ return true;
+ end
+
+ local child = stanza.tags[1].tags[1];
+ if not child then
+ origin.send(st.error_reply(stanza, "modify", "bad-request"));
+ return true;
+ elseif child.name == "destroy" then
+ local newjid = child.attr.jid;
+ local reason = child:get_child_text("reason");
+ local password = child:get_child_text("password");
+ self:destroy(newjid, reason, password);
+ origin.send(st.reply(stanza));
+ return true;
+ elseif child.name == "x" and child.attr.xmlns == "jabber:x:data" then
+ return self:process_form(origin, stanza);
else
- self:handle_to_room(origin, stanza);
+ origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
+ return true;
end
end
-function room_mt:route_stanza(stanza) end -- Replace with a routing function, e.g., function(room, stanza) core_route_stanza(origin, stanza); end
+function room_mt:handle_groupchat_to_room(origin, stanza)
+ local from = stanza.attr.from;
+ local occupant = self:get_occupant_by_real_jid(from);
+ if module:fire_event("muc-occupant-groupchat", {
+ room = self; origin = origin; stanza = stanza; from = from; occupant = occupant;
+ }) then return true; end
+ stanza.attr.from = occupant.nick;
+ self:broadcast_message(stanza);
+ stanza.attr.from = from;
+ return true;
+end
+
+-- Role check
+module:hook("muc-occupant-groupchat", function(event)
+ local role_rank = valid_roles[event.occupant and event.occupant.role or "none"];
+ if role_rank <= valid_roles.none then
+ event.origin.send(st.error_reply(event.stanza, "cancel", "not-acceptable"));
+ return true;
+ elseif role_rank <= valid_roles.visitor then
+ event.origin.send(st.error_reply(event.stanza, "auth", "forbidden"));
+ return true;
+ end
+end, 50);
+
+-- hack - some buggy clients send presence updates to the room rather than their nick
+function room_mt:handle_presence_to_room(origin, stanza)
+ local current_nick = self:get_occupant_jid(stanza.attr.from);
+ local handled
+ if current_nick then
+ local to = stanza.attr.to;
+ stanza.attr.to = current_nick;
+ handled = self:handle_presence_to_occupant(origin, stanza);
+ stanza.attr.to = to;
+ end
+ return handled;
+end
+
+-- Need visitor role or higher to invite
+module:hook("muc-pre-invite", function(event)
+ local room, stanza = event.room, event.stanza;
+ local _from = stanza.attr.from;
+ local inviter = room:get_occupant_by_real_jid(_from);
+ local role = inviter and inviter.role or room:get_default_role(room:get_affiliation(_from));
+ if valid_roles[role or "none"] <= valid_roles.visitor then
+ event.origin.send(st.error_reply(stanza, "auth", "forbidden"));
+ return true;
+ end
+end);
+
+function room_mt:handle_mediated_invite(origin, stanza)
+ local payload = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("invite");
+ local invitee = jid_prep(payload.attr.to);
+ if not invitee then
+ origin.send(st.error_reply(stanza, "cancel", "jid-malformed"));
+ return true;
+ elseif module:fire_event("muc-pre-invite", {room = self, origin = origin, stanza = stanza}) then
+ return true;
+ end
+ local invite = muc_util.filter_muc_x(st.clone(stanza));
+ invite.attr.from = self.jid;
+ invite.attr.to = invitee;
+ invite:tag('x', {xmlns='http://jabber.org/protocol/muc#user'})
+ :tag('invite', {from = stanza.attr.from;})
+ :tag('reason'):text(payload:get_child_text("reason")):up()
+ :up()
+ :up();
+ if not module:fire_event("muc-invite", {room = self, stanza = invite, origin = origin, incoming = stanza}) then
+ self:route_stanza(invite);
+ end
+ return true;
+end
+
+-- COMPAT: Some older clients expect this
+module:hook("muc-invite", function(event)
+ local room, stanza = event.room, event.stanza;
+ local invite = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("invite");
+ local reason = invite:get_child_text("reason");
+ stanza:tag('x', {xmlns = "jabber:x:conference"; jid = room.jid;})
+ :text(reason or "")
+ :up();
+end);
+
+-- Add a plain message for clients which don't support invites
+module:hook("muc-invite", function(event)
+ local room, stanza = event.room, event.stanza;
+ if not stanza:get_child("body") then
+ local invite = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("invite");
+ local reason = invite:get_child_text("reason") or "";
+ stanza:tag("body")
+ :text(invite.attr.from.." invited you to the room "..room.jid..(reason == "" and (" ("..reason..")") or ""))
+ :up();
+ end
+end);
+
+function room_mt:handle_mediated_decline(origin, stanza)
+ local payload = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("decline");
+ local declinee = jid_prep(payload.attr.to);
+ if not declinee then
+ origin.send(st.error_reply(stanza, "cancel", "jid-malformed"));
+ return true;
+ elseif module:fire_event("muc-pre-decline", {room = self, origin = origin, stanza = stanza}) then
+ return true;
+ end
+ local decline = muc_util.filter_muc_x(st.clone(stanza));
+ decline.attr.from = self.jid;
+ decline.attr.to = declinee;
+ decline:tag("x", {xmlns = "http://jabber.org/protocol/muc#user"})
+ :tag("decline", {from = stanza.attr.from})
+ :tag("reason"):text(payload:get_child_text("reason")):up()
+ :up()
+ :up();
+ if not module:fire_event("muc-decline", {room = self, stanza = decline, origin = origin, incoming = stanza}) then
+ declinee = decline.attr.to; -- re-fetch, in case event modified it
+ local occupant
+ if jid_bare(declinee) == self.jid then -- declinee jid is already an in-room jid
+ occupant = self:get_occupant_by_nick(declinee);
+ end
+ if occupant then
+ self:route_to_occupant(occupant, decline);
+ else
+ self:route_stanza(decline);
+ end
+ end
+ return true;
+end
+
+-- Add a plain message for clients which don't support declines
+module:hook("muc-decline", function(event)
+ local room, stanza = event.room, event.stanza;
+ if not stanza:get_child("body") then
+ local decline = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("decline");
+ local reason = decline:get_child_text("reason") or "";
+ stanza:tag("body")
+ :text(decline.attr.from.." declined your invite to the room "..room.jid..(reason == "" and (" ("..reason..")") or ""))
+ :up();
+ end
+end);
+
+function room_mt:handle_message_to_room(origin, stanza)
+ local type = stanza.attr.type;
+ if type == "groupchat" then
+ return self:handle_groupchat_to_room(origin, stanza)
+ elseif type == "error" and is_kickable_error(stanza) then
+ return self:handle_kickable(origin, stanza)
+ elseif type == nil or type == "normal" then
+ local x = stanza:get_child("x", "http://jabber.org/protocol/muc#user");
+ if x then
+ local payload = x.tags[1];
+ if payload == nil then --luacheck: ignore 542
+ -- fallthrough
+ elseif payload.name == "invite" and payload.attr.to then
+ return self:handle_mediated_invite(origin, stanza)
+ elseif payload.name == "decline" and payload.attr.to then
+ return self:handle_mediated_decline(origin, stanza)
+ end
+ origin.send(st.error_reply(stanza, "cancel", "bad-request"));
+ return true;
+ end
+ end
+end
+
+function room_mt:route_stanza(stanza) -- luacheck: ignore 212
+ module:send(stanza);
+end
function room_mt:get_affiliation(jid)
local node, host, resource = jid_split(jid);
@@ -1063,266 +1157,183 @@ function room_mt:get_affiliation(jid)
if not result and self._affiliations[host] == "outcast" then result = "outcast"; end -- host banned
return result;
end
---- Checks whether the given affiliation changes in jid_affiliation can be applied by actor.
--- Note: Empty tables can always be applied and won't have any effect.
-function room_mt:can_set_affiliations(actor, jid_affiliation)
- local actor_affiliation;
- if actor ~= true then
- actor_affiliation = self:get_affiliation(actor);
- end
-
- -- First let's see if there are any problems with the affiliations given
- -- in jid_affiliation
- for jid, value in pairs(jid_affiliation) do
- local affiliation = value["affiliation"];
-
- jid = jid_bare(jid);
- if affiliation == "none" then affiliation = nil; end
- if affiliation and affiliation ~= "outcast" and affiliation ~= "owner" and affiliation ~= "admin" and affiliation ~= "member" then
- return false, "modify", "not-acceptable";
- end
- local target_affiliation = self:get_affiliation(jid);
- if target_affiliation == affiliation then
- -- no change, no error checking necessary
- else
- if actor ~= true and actor_affiliation ~= "owner" then
- if affiliation == "owner" or affiliation == "admin" or actor_affiliation ~= "admin" or target_affiliation == "owner" or target_affiliation == "admin" then
- return false, "cancel", "not-allowed";
- end
- elseif target_affiliation == "owner" and jid_bare(actor) == jid then -- self change
+-- Iterates over jid, affiliation pairs
+function room_mt:each_affiliation(with_affiliation)
+ if not with_affiliation then
+ return pairs(self._affiliations);
+ else
+ return function(_affiliations, jid)
+ local affiliation;
+ repeat -- Iterate until we get a match
+ jid, affiliation = next(_affiliations, jid);
+ until jid == nil or affiliation == with_affiliation
+ return jid, affiliation;
+ end, self._affiliations, nil
+ end
+end
+
+function room_mt:set_affiliation(actor, jid, affiliation, reason)
+ if not actor then return nil, "modify", "not-acceptable"; end;
+
+ local node, host, resource = jid_split(jid);
+ if not host then return nil, "modify", "not-acceptable"; end
+ jid = jid_join(node, host); -- Bare
+ local is_host_only = node == nil;
+
+ if valid_affiliations[affiliation or "none"] == nil then
+ return nil, "modify", "not-acceptable";
+ end
+ affiliation = affiliation ~= "none" and affiliation or nil; -- coerces `affiliation == false` to `nil`
+
+ local target_affiliation = self._affiliations[jid]; -- Raw; don't want to check against host
+ local is_downgrade = valid_affiliations[target_affiliation or "none"] > valid_affiliations[affiliation or "none"];
+
+ if actor == true then
+ actor = nil -- So we can pass it safely to 'publicise_occupant_status' below
+ else
+ local actor_affiliation = self:get_affiliation(actor);
+ if actor_affiliation == "owner" then
+ if jid_bare(actor) == jid then -- self change
+ -- need at least one owner
local is_last = true;
- for j, aff in pairs(self._affiliations) do if j ~= jid and aff == "owner" then is_last = false; break; end end
+ for j in self:each_affiliation("owner") do
+ if j ~= jid then is_last = false; break; end
+ end
if is_last then
- return false, "cancel", "conflict";
+ return nil, "cancel", "conflict";
end
end
+ -- owners can do anything else
+ elseif affiliation == "owner" or affiliation == "admin"
+ or actor_affiliation ~= "admin"
+ or target_affiliation == "owner" or target_affiliation == "admin" then
+ -- Can't demote owners or other admins
+ return nil, "cancel", "not-allowed";
end
end
- return true;
-end
---- Updates the room affiliations by applying the ones given here.
--- Takes the affiliations given in jid_affiliation and applies them to
--- the room, overwriting a potentially existing affiliation for any given
--- jid.
--- @param jid_affiliation A table associating a jid with a table consisting
--- of two subkeys: `affilation` and `reason`. The jids
--- within must not be malformed.
-function room_mt:set_affiliations(actor, jid_affiliation, callback)
- local can_set, err_type, err_condition = self:can_set_affiliations(actor, jid_affiliation)
-
- if not can_set then
- return false, err_type, err_condition;
- end
- -- Your own presence should have status 110
- local modified_nicks = {};
- local nb_modified_nicks = 0;
- -- Now we can be sure that jid_affiliation causes no problems
- -- We can actually set them
- for jid, value in pairs(jid_affiliation) do
- local affiliation = value["affiliation"];
- local reason = value["reason"];
-
- self._affiliations[jid] = affiliation;
- local role = self:get_default_role(affiliation);
- local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"})
- :tag("item", {affiliation=affiliation or "none", role=role or "none"})
- :tag("reason"):text(reason or ""):up()
- :up();
- local self_x = st.clone(x);
- self_x:tag("status", {code="110"});
- local presence_type = nil;
- if not role then -- getting kicked
- presence_type = "unavailable";
- if affiliation == "outcast" then
- -- banned
- x:tag("status", {code="301"}):up();
- self_x:tag("status", {code="301"}):up();
- else
- -- affiliation change
- x:tag("status", {code="321"}):up();
- self_x:tag("status", {code="321"}):up();
- end
- end
- for nick, occupant in pairs(self._occupants) do
- if jid_bare(occupant.jid) == jid then
- if not role then -- getting kicked
- self._occupants[nick] = nil;
- else
- occupant.affiliation, occupant.role = affiliation, role;
- end
- for jid,pres in pairs(occupant.sessions) do -- remove for all sessions of the nick
- if not role then self._jid_nick[jid] = nil; end
- local p = st.clone(pres);
- p.attr.from = nick;
- p.attr.type = presence_type;
- p.attr.to = jid;
- self:_route_stanza(p);
- if occupant.jid == jid then
- -- Broadcast this presence to everyone else later, with the public <x> variant
- local bp = st.clone(p);
- bp:add_child(x);
- modified_nicks[nick] = bp;
- nb_modified_nicks = nb_modified_nicks + 1;
- end
- p:add_child(self_x);
- self:_route_stanza(p);
- end
+ -- Set in 'database'
+ self._affiliations[jid] = affiliation;
+
+ -- Update roles
+ local role = self:get_default_role(affiliation);
+ local role_rank = valid_roles[role or "none"];
+ local occupants_updated = {}; -- Filled with old roles
+ for nick, occupant in self:each_occupant() do -- luacheck: ignore 213
+ if occupant.bare_jid == jid or (
+ -- Outcast can be by host.
+ is_host_only and affiliation == "outcast" and select(2, jid_split(occupant.bare_jid)) == host
+ ) then
+ -- need to publcize in all cases; as affiliation in <item/> has changed.
+ occupants_updated[occupant] = occupant.role;
+ if occupant.role ~= role and (
+ is_downgrade or
+ valid_roles[occupant.role or "none"] < role_rank -- upgrade
+ ) then
+ occupant.role = role;
+ self:save_occupant(occupant);
end
end
end
- if nb_modified_nicks > 0 then
- if self.save then self:save(); end
- if callback then callback(); end
+ -- Tell the room of the new occupant affiliations+roles
+ local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"});
+ if not role then -- getting kicked
+ if affiliation == "outcast" then
+ x:tag("status", {code="301"}):up(); -- banned
+ else
+ x:tag("status", {code="321"}):up(); -- affiliation change
+ end
end
- for nick,p in pairs(modified_nicks) do
- p.attr.from = nick;
- self:broadcast_except_nick(p, nick);
+ local is_semi_anonymous = self:get_whois() == "moderators";
+ for occupant, old_role in pairs(occupants_updated) do
+ self:publicise_occupant_status(occupant, x, nil, actor, reason);
+ if occupant.role == nil then
+ module:fire_event("muc-occupant-left", {room = self; nick = occupant.nick; occupant = occupant;});
+ elseif is_semi_anonymous and
+ (old_role == "moderator" and occupant.role ~= "moderator") or
+ (old_role ~= "moderator" and occupant.role == "moderator") then -- Has gained or lost moderator status
+ -- Send everyone else's presences (as jid visibility has changed)
+ for real_jid in occupant:each_session() do
+ self:send_occupant_list(real_jid, function(occupant_jid, occupant) --luacheck: ignore 212 433
+ return occupant.bare_jid ~= jid;
+ end);
+ end
+ end
end
+
+ self:save(true);
+
+ module:fire_event("muc-set-affiliation", {
+ room = self;
+ actor = actor;
+ jid = jid;
+ affiliation = affiliation or "none";
+ reason = reason;
+ previous_affiliation = target_affiliation;
+ in_room = next(occupants_updated) ~= nil;
+ });
+
return true;
end
-function room_mt:set_affiliation(actor, jid, affiliation, callback, reason)
- return self.set_affiliations(actor, { [jid] = { ["affiliation"] = affiliation, ["reason"] = reason } }, callback)
-end
function room_mt:get_role(nick)
- local session = self._occupants[nick];
- return session and session.role or nil;
+ local occupant = self:get_occupant_by_nick(nick);
+ return occupant and occupant.role or nil;
end
-function room_mt:can_set_role(actor_jid, occupant_jid, role)
- local occupant = self._occupants[occupant_jid];
- if not occupant or not actor_jid then return nil, "modify", "not-acceptable"; end
- if actor_jid == true then return true; end
+function room_mt:set_role(actor, occupant_jid, role, reason)
+ if not actor then return nil, "modify", "not-acceptable"; end
- local actor = self._occupants[self._jid_nick[actor_jid]];
- if actor and actor.role == "moderator" then
- if occupant.affiliation ~= "owner" and occupant.affiliation ~= "admin" then
- if actor.affiliation == "owner" or actor.affiliation == "admin" then
- return true;
- elseif occupant.role ~= "moderator" and role ~= "moderator" then
- return true;
- end
- end
- end
- return nil, "cancel", "not-allowed";
-end
+ local occupant = self:get_occupant_by_nick(occupant_jid);
+ if not occupant then return nil, "modify", "item-not-found"; end
---- Checks whether the given role changes in jidnick_role can be applied by actor.
--- Note: Empty tables can always be applied and won't have any effect.
-function room_mt:can_set_roles(actor, jidnick_role)
- for jidnick, role in pairs(jidnick_role) do
- if role == "none" then role = nil; end
- if role and role ~= "moderator" and role ~= "participant" and role ~= "visitor" then return false, "modify", "not-acceptable"; end
- local can_set, err_type, err_condition = self:can_set_role(actor, jidnick, role)
- if not can_set then
- return false, err_type, err_condition;
- end
+ if valid_roles[role or "none"] == nil then
+ return nil, "modify", "not-acceptable";
end
+ role = role ~= "none" and role or nil; -- coerces `role == false` to `nil`
- return true;
-end
+ if actor == true then
+ actor = nil -- So we can pass it safely to 'publicise_occupant_status' below
+ else
+ -- Can't do anything to other owners or admins
+ local occupant_affiliation = self:get_affiliation(occupant.bare_jid);
+ if occupant_affiliation == "owner" or occupant_affiliation == "admin" then
+ return nil, "cancel", "not-allowed";
+ end
---- Updates the room roles by applying the ones given here.
--- Takes the roles given in jidnick_role and applies them to
--- the room, overwriting a potentially existing role for any given
--- jid.
--- @param jidnick_role A table associating a jid/nick with a table consisting
--- of two subkeys: `role` and `reason`. The jids within
--- must not be malformed.
-function room_mt:set_roles(actor, jidnick_role, callback)
- local allowed, err_type, err_condition = self:can_set_roles(actor, jidnick_role);
- if not allowed then return allowed, err_type, err_condition; end
-
- local modified_nicks = {};
- local nb_modified_nicks = 0;
- for jidnick, value in pairs(jidnick_role) do
- local occupant_jid = jidnick;
- local role = value["role"];
- local reason = value["reason"];
-
- local occupant = self._occupants[occupant_jid];
- local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"})
- :tag("item", {affiliation=occupant.affiliation or "none", nick=select(3, jid_split(occupant_jid)), role=role or "none"})
- :tag("reason"):text(reason or ""):up()
- :up();
- local presence_type = nil;
- if not role then -- kick
- presence_type = "unavailable";
- self._occupants[occupant_jid] = nil;
- for jid in pairs(occupant.sessions) do -- remove for all sessions of the nick
- self._jid_nick[jid] = nil;
+ -- If you are trying to give or take moderator role you need to be an owner or admin
+ if occupant.role == "moderator" or role == "moderator" then
+ local actor_affiliation = self:get_affiliation(actor);
+ if actor_affiliation ~= "owner" and actor_affiliation ~= "admin" then
+ return nil, "cancel", "not-allowed";
end
- x:tag("status", {code = "307"}):up();
- else
- occupant.role = role;
end
- local self_x = st.clone(x);
- self_x:tag("status", {code = "110"}):up();
- local bp;
- for jid,pres in pairs(occupant.sessions) do -- send to all sessions of the nick
- local p = st.clone(pres);
- p.attr.from = occupant_jid;
- p.attr.type = presence_type;
- p.attr.to = jid;
- self:_route_stanza(p);
- if occupant.jid == jid then
- bp = st.clone(p);
- bp:add_child(x);
- modified_nicks[occupant_jid] = p;
- nb_modified_nicks = nb_modified_nicks + 1;
- end
- p:add_child(self_x);
- self:route_stanza(p);
+
+ -- Need to be in the room and a moderator
+ local actor_occupant = self:get_occupant_by_real_jid(actor);
+ if not actor_occupant or actor_occupant.role ~= "moderator" then
+ return nil, "cancel", "not-allowed";
end
end
- if nb_modified_nicks > 0 then
- if callback then callback(); end
+ local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"});
+ if not role then
+ x:tag("status", {code = "307"}):up();
end
- for nick,p in pairs(modified_nicks) do
- self:broadcast_except_nick(p, nick);
+ occupant.role = role;
+ self:save_occupant(occupant);
+ self:publicise_occupant_status(occupant, x, nil, actor, reason);
+ if role == nil then
+ module:fire_event("muc-occupant-left", {room = self; nick = occupant.nick; occupant = occupant;});
end
return true;
end
-function room_mt:_route_stanza(stanza)
- local muc_child;
- local to_occupant = self._occupants[self._jid_nick[stanza.attr.to]];
- local from_occupant = self._occupants[stanza.attr.from];
- if stanza.name == "presence" then
- if to_occupant and from_occupant then
- if self._data.whois == 'anyone' then
- muc_child = stanza:get_child("x", "http://jabber.org/protocol/muc#user");
- else
- if to_occupant.role == "moderator" or jid_bare(to_occupant.jid) == jid_bare(from_occupant.jid) then
- muc_child = stanza:get_child("x", "http://jabber.org/protocol/muc#user");
- end
- end
- end
- end
- if muc_child then
- for _, item in pairs(muc_child.tags) do
- if item.name == "item" then
- if from_occupant == to_occupant then
- item.attr.jid = stanza.attr.to;
- else
- item.attr.jid = from_occupant.jid;
- end
- end
- end
- end
- self:route_stanza(stanza);
- if muc_child then
- for _, item in pairs(muc_child.tags) do
- if item.name == "item" then
- item.attr.jid = nil;
- end
- end
- end
-end
+local whois = module:require "muc/whois";
+room_mt.get_whois = whois.get;
+room_mt.set_whois = whois.set;
local _M = {}; -- module "muc"
@@ -1331,17 +1342,103 @@ function _M.new_room(jid, config)
jid = jid;
_jid_nick = {};
_occupants = {};
- _data = {
- whois = 'moderators';
- history_length = math.min((config and config.history_length)
- or default_history_length, max_history_length);
- };
+ _data = config or {};
_affiliations = {};
}, room_mt);
end
-function _M.set_max_history_length(_max_history_length)
- max_history_length = _max_history_length or math.huge;
+local new_format = module:get_option_boolean("new_muc_storage_format", false);
+
+function room_mt:freeze(live)
+ local frozen, state;
+ if new_format then
+ frozen = {
+ _jid = self.jid;
+ _data = self._data;
+ };
+ for user, affiliation in pairs(self._affiliations) do
+ frozen[user] = affiliation;
+ end
+ else
+ frozen = {
+ jid = self.jid;
+ _data = self._data;
+ _affiliations = self._affiliations;
+ };
+ end
+ if live then
+ state = {};
+ for nick, occupant in self:each_occupant() do
+ state[nick] = {
+ bare_jid = occupant.bare_jid;
+ role = occupant.role;
+ jid = occupant.jid;
+ }
+ for jid, presence in occupant:each_session() do
+ state[jid] = st.preserialize(presence);
+ end
+ end
+ local history = self._history;
+ if history and history[1] ~= nil then
+ state._last_message = st.preserialize(history[#history].stanza);
+ state._last_message_at = history[#history].timestamp;
+ end
+ end
+ return frozen, state;
+end
+
+function _M.restore_room(frozen, state)
+ local room_jid = frozen._jid or frozen.jid;
+ local room = _M.new_room(room_jid, frozen._data);
+
+ if state and state._last_message and state._last_message_at then
+ room._history = {
+ { stanza = st.deserialize(state._last_message),
+ timestamp = state._last_message_at, },
+ };
+ end
+
+ local occupants = {};
+ local room_name, room_host = jid_split(room_jid);
+
+ if frozen.jid and frozen._affiliations then
+ room._affiliations = frozen._affiliations;
+ else
+ for jid, data in pairs(frozen) do
+ local node, host, resource = jid_split(jid);
+ if host:sub(1,1) ~= "_" and not resource and type(data) == "string" then
+ -- bare jid: affiliation
+ room._affiliations[jid] = data;
+ end
+ end
+ end
+ for jid, data in pairs(state or frozen) do
+ local node, host, resource = jid_split(jid);
+ if node or host:sub(1,1) ~= "_" then
+ if host == room_host and node == room_name and resource and type(data) == "table" then
+ -- full room jid: bare real jid and role
+ local nick = jid;
+ local occupant = occupants[nick] or occupant_lib.new(data.bare_jid, nick);
+ occupant.bare_jid = data.bare_jid;
+ occupant.role = data.role;
+ occupant.jid = data.jid; -- Primary session JID
+ occupants[nick] = occupant;
+ elseif type(data) == "table" and data.name == "presence" then
+ -- full user jid: presence
+ local nick = data.attr.from;
+ local occupant = occupants[nick] or occupant_lib.new(nil, nick);
+ local presence = st.deserialize(data);
+ occupant:set_session(jid, presence);
+ occupants[nick] = occupant;
+ end
+ end
+ end
+
+ for _, occupant in pairs(occupants) do
+ room:save_occupant(occupant);
+ end
+
+ return room;
end
_M.room_mt = room_mt;
diff --git a/plugins/muc/name.lib.lua b/plugins/muc/name.lib.lua
new file mode 100644
index 00000000..2dcb979a
--- /dev/null
+++ b/plugins/muc/name.lib.lua
@@ -0,0 +1,45 @@
+-- Prosody IM
+-- Copyright (C) 2008-2010 Matthew Wild
+-- Copyright (C) 2008-2010 Waqas Hussain
+-- Copyright (C) 2014 Daurnimator
+--
+-- This project is MIT/X11 licensed. Please see the
+-- COPYING file in the source package for more information.
+--
+
+local jid_split = require "util.jid".split;
+
+local function get_name(room)
+ return room._data.name or jid_split(room.jid);
+end
+
+local function set_name(room, name)
+ if name == "" or name == (jid_split(room.jid)) then name = nil; end
+ if room._data.name == name then return false; end
+ room._data.name = name;
+ return true;
+end
+
+module:hook("muc-disco#info", function(event)
+ event.reply:tag("identity", {category="conference", type="text", name=get_name(event.room)}):up();
+end);
+
+module:hook("muc-config-form", function(event)
+ table.insert(event.form, {
+ name = "muc#roomconfig_roomname";
+ type = "text-single";
+ label = "Name";
+ value = get_name(event.room) or "";
+ });
+end, 100-1);
+
+module:hook("muc-config-submitted/muc#roomconfig_roomname", function(event)
+ if set_name(event.room, event.value) then
+ event.status_codes["104"] = true;
+ end
+end);
+
+return {
+ get = get_name;
+ set = set_name;
+};
diff --git a/plugins/muc/occupant.lib.lua b/plugins/muc/occupant.lib.lua
new file mode 100644
index 00000000..8fe4bbdf
--- /dev/null
+++ b/plugins/muc/occupant.lib.lua
@@ -0,0 +1,85 @@
+local pairs = pairs;
+local setmetatable = setmetatable;
+local st = require "util.stanza";
+local util = module:require "muc/util";
+
+local function get_filtered_presence(stanza)
+ return util.filter_muc_x(st.clone(stanza));
+end
+
+local occupant_mt = {};
+occupant_mt.__index = occupant_mt;
+
+local function new_occupant(bare_real_jid, nick)
+ return setmetatable({
+ bare_jid = bare_real_jid;
+ nick = nick; -- in-room jid
+ sessions = {}; -- hash from real_jid to presence stanzas. stanzas should not be modified
+ role = nil;
+ jid = nil; -- Primary session
+ }, occupant_mt);
+end
+
+-- Deep copy an occupant
+local function copy_occupant(occupant)
+ local sessions = {};
+ for full_jid, presence_stanza in pairs(occupant.sessions) do
+ -- Don't keep unavailable presences, as they'll accumulate; unless they're the primary session
+ if presence_stanza.attr.type ~= "unavailable" or full_jid == occupant.jid then
+ sessions[full_jid] = presence_stanza;
+ end
+ end
+ return setmetatable({
+ bare_jid = occupant.bare_jid;
+ nick = occupant.nick;
+ sessions = sessions;
+ role = occupant.role;
+ jid = occupant.jid;
+ }, occupant_mt);
+end
+
+-- finds another session to be the primary (there might not be one)
+function occupant_mt:choose_new_primary()
+ for jid, pr in self:each_session() do
+ if pr.attr.type == nil then
+ return jid;
+ end
+ end
+ return nil;
+end
+
+function occupant_mt:set_session(real_jid, presence_stanza, replace_primary)
+ local pr = get_filtered_presence(presence_stanza);
+ pr.attr.from = self.nick;
+ pr.attr.to = real_jid;
+
+ self.sessions[real_jid] = pr;
+ if replace_primary then
+ self.jid = real_jid;
+ elseif self.jid == nil or (pr.attr.type == "unavailable" and self.jid == real_jid) then
+ -- Only leave an unavailable presence as primary when there are no other options
+ self.jid = self:choose_new_primary() or real_jid;
+ end
+end
+
+function occupant_mt:remove_session(real_jid)
+ -- Delete original session
+ self.sessions[real_jid] = nil;
+ if self.jid == real_jid then
+ self.jid = self:choose_new_primary();
+ end
+end
+
+function occupant_mt:each_session()
+ return pairs(self.sessions)
+end
+
+function occupant_mt:get_presence(real_jid)
+ return self.sessions[real_jid or self.jid]
+end
+
+return {
+ new = new_occupant;
+ copy = copy_occupant;
+ mt = occupant_mt;
+}
diff --git a/plugins/muc/password.lib.lua b/plugins/muc/password.lib.lua
new file mode 100644
index 00000000..02ecdc1a
--- /dev/null
+++ b/plugins/muc/password.lib.lua
@@ -0,0 +1,70 @@
+-- Prosody IM
+-- Copyright (C) 2008-2010 Matthew Wild
+-- Copyright (C) 2008-2010 Waqas Hussain
+-- Copyright (C) 2014 Daurnimator
+--
+-- This project is MIT/X11 licensed. Please see the
+-- COPYING file in the source package for more information.
+--
+
+local st = require "util.stanza";
+
+local function get_password(room)
+ return room._data.password;
+end
+
+local function set_password(room, password)
+ if password == "" then password = nil; end
+ if room._data.password == password then return false; end
+ room._data.password = password;
+ return true;
+end
+
+module:hook("muc-disco#info", function(event)
+ event.reply:tag("feature", {var = get_password(event.room) and "muc_passwordprotected" or "muc_unsecured"}):up();
+end);
+
+module:hook("muc-config-form", function(event)
+ table.insert(event.form, {
+ name = "muc#roomconfig_roomsecret";
+ type = "text-private";
+ label = "Password";
+ value = get_password(event.room) or "";
+ });
+end, 100-7);
+
+module:hook("muc-config-submitted/muc#roomconfig_roomsecret", function(event)
+ if set_password(event.room, event.value) then
+ event.status_codes["104"] = true;
+ end
+end);
+
+-- Don't allow anyone to join room unless they provide the password
+module:hook("muc-occupant-pre-join", function(event)
+ local room, stanza = event.room, event.stanza;
+ local password = stanza:get_child("x", "http://jabber.org/protocol/muc");
+ password = password and password:get_child_text("password", "http://jabber.org/protocol/muc");
+ if not password or password == "" then password = nil; end
+ if get_password(room) ~= password then
+ local from, to = stanza.attr.from, stanza.attr.to;
+ module:log("debug", "%s couldn't join due to invalid password: %s", from, to);
+ local reply = st.error_reply(stanza, "auth", "not-authorized"):up();
+ reply.tags[1].attr.code = "401";
+ event.origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
+ return true;
+ end
+end, -20);
+
+-- Add password to outgoing invite
+module:hook("muc-invite", function(event)
+ local password = get_password(event.room);
+ if password then
+ local x = event.stanza:get_child("x", "http://jabber.org/protocol/muc#user");
+ x:tag("password"):text(password):up();
+ end
+end);
+
+return {
+ get = get_password;
+ set = set_password;
+};
diff --git a/plugins/muc/persistent.lib.lua b/plugins/muc/persistent.lib.lua
new file mode 100644
index 00000000..abceafe1
--- /dev/null
+++ b/plugins/muc/persistent.lib.lua
@@ -0,0 +1,47 @@
+-- Prosody IM
+-- Copyright (C) 2008-2010 Matthew Wild
+-- Copyright (C) 2008-2010 Waqas Hussain
+-- Copyright (C) 2014 Daurnimator
+--
+-- This project is MIT/X11 licensed. Please see the
+-- COPYING file in the source package for more information.
+--
+
+local function get_persistent(room)
+ return room._data.persistent;
+end
+
+local function set_persistent(room, persistent)
+ persistent = persistent and true or nil;
+ if get_persistent(room) == persistent then return false; end
+ room._data.persistent = persistent;
+ return true;
+end
+
+module:hook("muc-config-form", function(event)
+ table.insert(event.form, {
+ name = "muc#roomconfig_persistentroom";
+ type = "boolean";
+ label = "Make Room Persistent?";
+ value = get_persistent(event.room);
+ });
+end, 100-3);
+
+module:hook("muc-config-submitted/muc#roomconfig_persistentroom", function(event)
+ if set_persistent(event.room, event.value) then
+ event.status_codes["104"] = true;
+ end
+end);
+
+module:hook("muc-disco#info", function(event)
+ event.reply:tag("feature", {var = get_persistent(event.room) and "muc_persistent" or "muc_temporary"}):up();
+end);
+
+module:hook("muc-room-destroyed", function(event)
+ set_persistent(event.room, false);
+end);
+
+return {
+ get = get_persistent;
+ set = set_persistent;
+};
diff --git a/plugins/muc/subject.lib.lua b/plugins/muc/subject.lib.lua
new file mode 100644
index 00000000..200b262d
--- /dev/null
+++ b/plugins/muc/subject.lib.lua
@@ -0,0 +1,101 @@
+-- Prosody IM
+-- Copyright (C) 2008-2010 Matthew Wild
+-- Copyright (C) 2008-2010 Waqas Hussain
+-- Copyright (C) 2014 Daurnimator
+--
+-- This project is MIT/X11 licensed. Please see the
+-- COPYING file in the source package for more information.
+--
+
+local st = require "util.stanza";
+
+local muc_util = module:require "muc/util";
+local valid_roles = muc_util.valid_roles;
+
+local function create_subject_message(from, subject)
+ return st.message({from = from; type = "groupchat"})
+ :tag("subject"):text(subject or ""):up();
+end
+
+local function get_changesubject(room)
+ return room._data.changesubject;
+end
+
+local function set_changesubject(room, changesubject)
+ changesubject = changesubject and true or nil;
+ if get_changesubject(room) == changesubject then return false; end
+ room._data.changesubject = changesubject;
+ return true;
+end
+
+module:hook("muc-config-form", function(event)
+ table.insert(event.form, {
+ name = "muc#roomconfig_changesubject";
+ type = "boolean";
+ label = "Allow Occupants to Change Subject?";
+ value = get_changesubject(event.room);
+ });
+end, 100-8);
+
+module:hook("muc-config-submitted/muc#roomconfig_changesubject", function(event)
+ if set_changesubject(event.room, event.value) then
+ event.status_codes["104"] = true;
+ end
+end);
+
+local function get_subject(room)
+ -- a <message/> stanza from the room JID (or from the occupant JID of the entity that set the subject)
+ return room._data.subject_from or room.jid, room._data.subject;
+end
+
+local function send_subject(room, to)
+ local msg = create_subject_message(get_subject(room));
+ msg.attr.to = to;
+ room:route_stanza(msg);
+end
+
+local function set_subject(room, from, subject)
+ if subject == "" then subject = nil; end
+ local old_from, old_subject = get_subject(room);
+ if old_subject == subject and old_from == from then return false; end
+ room._data.subject_from = from;
+ room._data.subject = subject;
+ local msg = create_subject_message(from, subject);
+ room:broadcast_message(msg);
+ return true;
+end
+
+-- Send subject to joining user
+module:hook("muc-occupant-session-new", function(event)
+ send_subject(event.room, event.stanza.attr.from);
+end, 20);
+
+-- Prosody has made the decision that messages with <subject/> are exclusively subject changes
+-- e.g. body will be ignored; even if the subject change was not allowed
+module:hook("muc-occupant-groupchat", function(event)
+ local stanza = event.stanza;
+ local subject = stanza:get_child("subject");
+ if subject then
+ local room = event.room;
+ local occupant = event.occupant;
+ -- Role check for subject changes
+ local role_rank = valid_roles[occupant and occupant.role or "none"];
+ if role_rank >= valid_roles.moderator or
+ ( role_rank >= valid_roles.participant and get_changesubject(room) ) then -- and participant
+ set_subject(room, occupant.nick, subject:get_text());
+ room:save();
+ return true;
+ else
+ event.origin.send(st.error_reply(stanza, "auth", "forbidden"));
+ return true;
+ end
+ end
+end, 20);
+
+return {
+ get_changesubject = get_changesubject;
+ set_changesubject = set_changesubject;
+ get = get_subject;
+ set = set_subject;
+ send = send_subject;
+};
diff --git a/plugins/muc/util.lib.lua b/plugins/muc/util.lib.lua
new file mode 100644
index 00000000..16deb543
--- /dev/null
+++ b/plugins/muc/util.lib.lua
@@ -0,0 +1,58 @@
+-- Prosody IM
+-- Copyright (C) 2008-2010 Matthew Wild
+-- Copyright (C) 2008-2010 Waqas Hussain
+-- Copyright (C) 2014 Daurnimator
+--
+-- This project is MIT/X11 licensed. Please see the
+-- COPYING file in the source package for more information.
+--
+
+local _M = {};
+
+_M.valid_affiliations = {
+ outcast = -1;
+ none = 0;
+ member = 1;
+ admin = 2;
+ owner = 3;
+};
+
+_M.valid_roles = {
+ none = 0;
+ visitor = 1;
+ participant = 2;
+ moderator = 3;
+};
+
+local kickable_error_conditions = {
+ ["gone"] = true;
+ ["internal-server-error"] = true;
+ ["item-not-found"] = true;
+ ["jid-malformed"] = true;
+ ["recipient-unavailable"] = true;
+ ["redirect"] = true;
+ ["remote-server-not-found"] = true;
+ ["remote-server-timeout"] = true;
+ ["service-unavailable"] = true;
+ ["malformed error"] = true;
+};
+function _M.is_kickable_error(stanza)
+ local cond = select(2, stanza:get_error()) or "malformed error";
+ return kickable_error_conditions[cond];
+end
+
+local muc_x_filters = {
+ ["http://jabber.org/protocol/muc"] = true;
+ ["http://jabber.org/protocol/muc#user"] = true;
+}
+local function muc_x_filter(tag)
+ if muc_x_filters[tag.attr.xmlns] then
+ return nil;
+ end
+ return tag;
+end
+function _M.filter_muc_x(stanza)
+ return stanza:maptags(muc_x_filter);
+end
+
+return _M;
diff --git a/plugins/muc/whois.lib.lua b/plugins/muc/whois.lib.lua
new file mode 100644
index 00000000..4acf288c
--- /dev/null
+++ b/plugins/muc/whois.lib.lua
@@ -0,0 +1,65 @@
+-- Prosody IM
+-- Copyright (C) 2008-2010 Matthew Wild
+-- Copyright (C) 2008-2010 Waqas Hussain
+-- Copyright (C) 2014 Daurnimator
+--
+-- This project is MIT/X11 licensed. Please see the
+-- COPYING file in the source package for more information.
+--
+
+local valid_whois = {
+ moderators = true;
+ anyone = true;
+};
+
+local function get_whois(room)
+ return room._data.whois or "moderators";
+end
+
+local function set_whois(room, whois)
+ assert(valid_whois[whois], "Invalid whois value")
+ if get_whois(room) == whois then return false; end
+ room._data.whois = whois;
+ return true;
+end
+
+module:hook("muc-disco#info", function(event)
+ event.reply:tag("feature", {var = get_whois(event.room) ~= "anyone" and "muc_semianonymous" or "muc_nonanonymous"}):up();
+end);
+
+module:hook("muc-config-form", function(event)
+ local whois = get_whois(event.room);
+ table.insert(event.form, {
+ name = 'muc#roomconfig_whois',
+ type = 'list-single',
+ label = 'Who May Discover Real JIDs?',
+ value = {
+ { value = 'moderators', label = 'Moderators Only', default = whois == 'moderators' },
+ { value = 'anyone', label = 'Anyone', default = whois == 'anyone' }
+ }
+ });
+end, 100-9);
+
+module:hook("muc-config-submitted/muc#roomconfig_whois", function(event)
+ if set_whois(event.room, event.value) then
+ local code = (event.value == 'moderators') and "173" or "172";
+ event.status_codes[code] = true;
+ end
+end);
+
+-- Mask 'from' jid as occupant jid if room is anonymous
+module:hook("muc-invite", function(event)
+ local room, stanza = event.room, event.stanza;
+ if get_whois(room) == "moderators" and room:get_default_role(room:get_affiliation(stanza.attr.to)) ~= "moderator" then
+ local invite = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("invite");
+ local occupant_jid = room:get_occupant_jid(invite.attr.from);
+ if occupant_jid ~= nil then -- FIXME: This will expose real jid if inviter is not in room
+ invite.attr.from = occupant_jid;
+ end
+ end
+end, 50);
+
+return {
+ get = get_whois;
+ set = set_whois;
+};