2 -- Copyright (C) 2008-2010 Matthew Wild
3 -- Copyright (C) 2008-2010 Waqas Hussain
4 -- Copyright (C) 2014 Daurnimator
6 -- This project is MIT/X11 licensed. Please see the
7 -- COPYING file in the source package for more information.
10 local select = select;
13 local setmetatable = setmetatable;
15 local dataform = require "util.dataforms";
16 local iterators = require "util.iterators";
17 local jid_split = require "util.jid".split;
18 local jid_bare = require "util.jid".bare;
19 local jid_prep = require "util.jid".prep;
20 local jid_join = require "util.jid".join;
21 local st = require "util.stanza";
22 local base64 = require "util.encodings".base64;
23 local md5 = require "util.hashes".md5;
25 local log = module._log;
27 local occupant_lib = module:require "muc/occupant"
28 local muc_util = module:require "muc/util";
29 local is_kickable_error = muc_util.is_kickable_error;
30 local valid_roles, valid_affiliations = muc_util.valid_roles, muc_util.valid_affiliations;
33 room_mt.__index = room_mt;
35 function room_mt:__tostring()
36 return "MUC room ("..self.jid..")";
39 function room_mt.save()
40 -- overriden by mod_muc.lua
43 function room_mt:get_occupant_jid(real_jid)
44 return self._jid_nick[real_jid]
47 function room_mt:get_default_role(affiliation)
48 local role = module:fire_event("muc-get-default-role", {
50 affiliation = affiliation;
51 affiliation_rank = valid_affiliations[affiliation or "none"];
53 return role, valid_roles[role or "none"];
55 module:hook("muc-get-default-role", function(event)
56 if event.affiliation_rank >= valid_affiliations.admin then
58 elseif event.affiliation_rank >= valid_affiliations.none then
63 --- Occupant functions
64 function room_mt:new_occupant(bare_real_jid, nick)
65 local occupant = occupant_lib.new(bare_real_jid, nick);
66 local affiliation = self:get_affiliation(bare_real_jid);
67 occupant.role = self:get_default_role(affiliation);
71 function room_mt:get_occupant_by_nick(nick)
72 local occupant = self._occupants[nick];
73 if occupant == nil then return nil end
74 return occupant_lib.copy(occupant);
78 local function next_copied_occupant(occupants, occupant_jid)
79 local next_occupant_jid, raw_occupant = next(occupants, occupant_jid);
80 if next_occupant_jid == nil then return nil end
81 return next_occupant_jid, occupant_lib.copy(raw_occupant);
83 -- FIXME Explain what 'read_only' is supposed to be
84 function room_mt:each_occupant(read_only) -- luacheck: ignore 212
85 return next_copied_occupant, self._occupants, nil;
89 function room_mt:has_occupant()
90 return next(self._occupants, nil) ~= nil
93 function room_mt:get_occupant_by_real_jid(real_jid)
94 local occupant_jid = self:get_occupant_jid(real_jid);
95 if occupant_jid == nil then return nil end
96 return self:get_occupant_by_nick(occupant_jid);
99 function room_mt:save_occupant(occupant)
100 occupant = occupant_lib.copy(occupant); -- So that occupant can be modified more
101 local id = occupant.nick
103 -- Need to maintain _jid_nick secondary index
104 local old_occupant = self._occupants[id];
106 for real_jid in old_occupant:each_session() do
107 self._jid_nick[real_jid] = nil;
111 local has_live_session = false
112 if occupant.role ~= nil then
113 for real_jid, presence in occupant:each_session() do
114 if presence.attr.type == nil then
115 has_live_session = true
116 self._jid_nick[real_jid] = occupant.nick;
119 if not has_live_session then
120 -- Has no live sessions left; they have left the room.
124 if not has_live_session then
127 self._occupants[id] = occupant
130 function room_mt:route_to_occupant(occupant, stanza)
131 local to = stanza.attr.to;
132 for jid in occupant:each_session() do
133 stanza.attr.to = jid;
134 self:route_stanza(stanza);
139 -- actor is the attribute table
140 local function add_item(x, affiliation, role, jid, nick, actor_nick, actor_jid, reason)
141 x:tag("item", {affiliation = affiliation; role = role; jid = jid; nick = nick;})
142 if actor_nick or actor_jid then
143 x:tag("actor", {nick = actor_nick; jid = actor_jid;}):up()
146 x:tag("reason"):text(reason):up()
152 -- actor is (real) jid
153 function room_mt:build_item_list(occupant, x, is_anonymous, nick, actor_nick, actor_jid, reason)
154 local affiliation = self:get_affiliation(occupant.bare_jid) or "none";
155 local role = occupant.role or "none";
157 add_item(x, affiliation, role, nil, nick, actor_nick, actor_jid, reason);
159 for real_jid in occupant:each_session() do
160 add_item(x, affiliation, role, real_jid, nick, actor_nick, actor_jid, reason);
166 function room_mt:broadcast_message(stanza)
167 if module:fire_event("muc-broadcast-message", {room = self, stanza = stanza}) then
170 self:broadcast(stanza);
174 -- Broadcast a stanza to all occupants in the room.
175 -- optionally checks conditional called with (nick, occupant)
176 function room_mt:broadcast(stanza, cond_func)
177 for nick, occupant in self:each_occupant() do
178 if cond_func == nil or cond_func(nick, occupant) then
179 self:route_to_occupant(occupant, stanza)
184 local function can_see_real_jids(whois, occupant)
185 if whois == "anyone" then
187 elseif whois == "moderators" then
188 return valid_roles[occupant.role or "none"] >= valid_roles.moderator;
192 -- Broadcasts an occupant's presence to the whole room
193 -- Takes the x element that goes into the stanzas
194 function room_mt:publicise_occupant_status(occupant, base_x, nick, actor, reason)
195 -- Build real jid and (optionally) occupant jid template presences
196 local base_presence do
197 -- Try to use main jid's presence
198 local pr = occupant:get_presence();
199 if pr and (pr.attr.type ~= "unavailable" and occupant.role ~= nil) then
200 base_presence = st.clone(pr);
201 else -- user is leaving but didn't send a leave presence. make one for them
202 base_presence = st.presence {from = occupant.nick; type = "unavailable";};
206 -- Fire event (before full_p and anon_p are created)
208 room = self; stanza = base_presence; x = base_x;
209 occupant = occupant; nick = nick; actor = actor;
212 module:fire_event("muc-broadcast-presence", event);
214 -- Allow muc-broadcast-presence listeners to change things
217 reason = event.reason;
219 local whois = self:get_whois();
223 actor_nick = select(3, jid_split(self:get_occupant_jid(actor)));
226 local full_p, full_x;
227 local function get_full_p()
228 if full_p == nil then
229 full_x = st.clone(base_x);
230 self:build_item_list(occupant, full_x, false, nick, actor_nick, actor, reason);
231 full_p = st.clone(base_presence):add_child(full_x);
233 return full_p, full_x;
236 local anon_p, anon_x;
237 local function get_anon_p()
238 if anon_p == nil then
239 anon_x = st.clone(base_x);
240 self:build_item_list(occupant, anon_x, true, nick, actor_nick, nil, reason);
241 anon_p = st.clone(base_presence):add_child(anon_x);
243 return anon_p, anon_x;
246 local self_p, self_x;
247 if can_see_real_jids(whois, occupant) then
248 self_p, self_x = get_full_p();
250 -- Can always see your own full jids
251 -- But not allowed to see actor's
252 self_x = st.clone(base_x);
253 self:build_item_list(occupant, self_x, false, nick, actor_nick, nil, reason);
254 self_p = st.clone(base_presence):add_child(self_x);
258 for occupant_nick, n_occupant in self:each_occupant() do
259 if occupant_nick ~= occupant.nick then
261 if can_see_real_jids(whois, n_occupant) then
263 elseif occupant.bare_jid == n_occupant.bare_jid then
268 self:route_to_occupant(n_occupant, pr);
272 -- Presences for occupant itself
273 self_x:tag("status", {code = "110";}):up();
274 if occupant.role == nil then
275 -- They get an unavailable
276 self:route_to_occupant(occupant, self_p);
278 -- use their own presences as templates
279 for full_jid, pr in occupant:each_session() do
281 pr.attr.to = full_jid;
282 pr:add_child(self_x);
283 self:route_stanza(pr);
288 function room_mt:send_occupant_list(to, filter)
289 local to_bare = jid_bare(to);
290 local is_anonymous = false;
291 local whois = self:get_whois();
292 if whois ~= "anyone" then
293 local affiliation = self:get_affiliation(to);
294 if affiliation ~= "admin" and affiliation ~= "owner" then
295 local occupant = self:get_occupant_by_real_jid(to);
296 if not (occupant and can_see_real_jids(whois, occupant)) then
301 for occupant_jid, occupant in self:each_occupant() do
302 if filter == nil or filter(occupant_jid, occupant) then
303 local x = st.stanza("x", {xmlns='http://jabber.org/protocol/muc#user'});
304 self:build_item_list(occupant, x, is_anonymous and to_bare ~= occupant.bare_jid); -- can always see your own jids
305 local pres = st.clone(occupant:get_presence());
308 self:route_stanza(pres);
313 function room_mt:get_disco_info(stanza)
314 local reply = st.reply(stanza):query("http://jabber.org/protocol/disco#info");
315 local form = dataform.new {
316 { name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/protocol/muc#roominfo" };
319 module:fire_event("muc-disco#info", {room = self; reply = reply; form = form, formdata = formdata ;});
320 reply:add_child(form:form(formdata, "result"));
323 module:hook("muc-disco#info", function(event)
324 event.reply:tag("feature", {var = "http://jabber.org/protocol/muc"}):up();
326 module:hook("muc-disco#info", function(event)
327 table.insert(event.form, { name = "muc#roominfo_occupants", label = "Number of occupants" });
328 event.formdata["muc#roominfo_occupants"] = tostring(iterators.count(event.room:each_occupant()));
331 function room_mt:get_disco_items(stanza)
332 local reply = st.reply(stanza):query("http://jabber.org/protocol/disco#items");
333 for room_jid in self:each_occupant() do
334 reply:tag("item", {jid = room_jid, name = room_jid:match("/(.*)")}):up();
339 function room_mt:handle_kickable(origin, stanza) -- luacheck: ignore 212
340 local real_jid = stanza.attr.from;
341 local occupant = self:get_occupant_by_real_jid(real_jid);
342 if occupant == nil then return nil; end
343 local type, condition, text = stanza:get_error();
344 local error_message = "Kicked: "..(condition and condition:gsub("%-", " ") or "presence error");
346 error_message = error_message..": "..text;
348 occupant:set_session(real_jid, st.presence({type="unavailable"})
349 :tag('status'):text(error_message));
350 self:save_occupant(occupant);
351 local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";})
352 :tag("status", {code = "307"})
353 self:publicise_occupant_status(occupant, x);
354 if occupant.jid == real_jid then -- Was last session
355 module:fire_event("muc-occupant-left", {room = self; nick = occupant.nick; occupant = occupant;});
360 if not module:get_option_boolean("muc_compat_create", true) then
361 module:hook("muc-room-pre-create", function(event)
362 local origin, stanza = event.origin, event.stanza;
363 if not stanza:get_child("x", "http://jabber.org/protocol/muc") then
364 origin.send(st.error_reply(stanza, "cancel", "item-not-found"));
370 -- Give the room creator owner affiliation
371 module:hook("muc-room-pre-create", function(event)
372 event.room:set_affiliation(true, jid_bare(event.stanza.attr.from), "owner");
375 -- check if user is banned
376 module:hook("muc-occupant-pre-join", function(event)
377 local room, stanza = event.room, event.stanza;
378 local affiliation = room:get_affiliation(stanza.attr.from);
379 if affiliation == "outcast" then
380 local reply = st.error_reply(stanza, "auth", "forbidden"):up();
381 reply.tags[1].attr.code = "403";
382 event.origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
387 function room_mt:handle_presence_to_occupant(origin, stanza)
388 local type = stanza.attr.type;
389 if type == "error" then -- error, kick em out!
390 return self:handle_kickable(origin, stanza)
391 elseif type == nil or type == "unavailable" then
392 local real_jid = stanza.attr.from;
393 local bare_jid = jid_bare(real_jid);
394 local orig_occupant, dest_occupant;
395 local is_new_room = next(self._affiliations) == nil;
397 if type == "unavailable" then return true; end -- Unavailable from someone not in the room
398 if module:fire_event("muc-room-pre-create", {
402 }) then return true; end
404 orig_occupant = self:get_occupant_by_real_jid(real_jid);
405 if type == "unavailable" and orig_occupant == nil then return true; end -- Unavailable from someone not in the room
407 local is_first_dest_session;
408 if type == "unavailable" then -- luacheck: ignore 542
409 -- FIXME Why the empty if branch?
410 -- dest_occupant = nil
411 elseif orig_occupant and orig_occupant.nick == stanza.attr.to then -- Just a presence update
412 log("debug", "presence update for %s from session %s", orig_occupant.nick, real_jid);
413 dest_occupant = orig_occupant;
415 local dest_jid = stanza.attr.to;
416 dest_occupant = self:get_occupant_by_nick(dest_jid);
417 if dest_occupant == nil then
418 log("debug", "no occupant found for %s; creating new occupant object for %s", dest_jid, real_jid);
419 is_first_dest_session = true;
420 dest_occupant = self:new_occupant(bare_jid, dest_jid);
422 is_first_dest_session = false;
425 local is_last_orig_session;
426 if orig_occupant ~= nil then
427 -- Is there are least 2 sessions?
428 local iter, ob, last = orig_occupant:each_session();
429 is_last_orig_session = iter(ob, iter(ob, last)) == nil;
432 local event, event_name = {
436 is_first_session = is_first_dest_session;
437 is_last_session = is_last_orig_session;
439 if orig_occupant == nil then
440 event_name = "muc-occupant-pre-join";
441 event.is_new_room = is_new_room;
442 event.occupant = dest_occupant;
443 elseif dest_occupant == nil then
444 event_name = "muc-occupant-pre-leave";
445 event.occupant = orig_occupant;
447 event_name = "muc-occupant-pre-change";
448 event.orig_occupant = orig_occupant;
449 event.dest_occupant = dest_occupant;
451 if module:fire_event(event_name, event) then return true; end
453 -- Check for nick conflicts
454 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
455 log("debug", "%s couldn't join due to nick conflict: %s", real_jid, dest_occupant.nick);
456 local reply = st.error_reply(stanza, "cancel", "conflict"):up();
457 reply.tags[1].attr.code = "409";
458 origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
462 -- Send presence stanza about original occupant
463 if orig_occupant ~= nil and orig_occupant ~= dest_occupant then
464 local orig_x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";});
466 if dest_occupant == nil then -- Session is leaving
467 log("debug", "session %s is leaving occupant %s", real_jid, orig_occupant.nick);
468 if is_last_orig_session then
469 orig_occupant.role = nil;
471 orig_occupant:set_session(real_jid, stanza);
473 log("debug", "session %s is changing from occupant %s to %s", real_jid, orig_occupant.nick, dest_occupant.nick);
474 local generated_unavail = st.presence {from = orig_occupant.nick, to = real_jid, type = "unavailable"};
475 orig_occupant:set_session(real_jid, generated_unavail);
476 dest_nick = select(3, jid_split(dest_occupant.nick));
477 if not is_first_dest_session then -- User is swapping into another pre-existing session
478 log("debug", "session %s is swapping into multisession %s, showing it leave.", real_jid, dest_occupant.nick);
479 -- Show the other session leaving
480 local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";})
481 :tag("status"):text("you are joining pre-existing session " .. dest_nick):up();
482 add_item(x, self:get_affiliation(bare_jid), "none");
483 local pr = st.presence{from = dest_occupant.nick, to = real_jid, type = "unavailable"}
485 self:route_stanza(pr);
487 if is_first_dest_session and is_last_orig_session then -- Normal nick change
488 log("debug", "no sessions in %s left; publically marking as nick change", orig_occupant.nick);
489 orig_x:tag("status", {code = "303";}):up();
490 else -- The session itself always needs to see a nick change
491 -- don't want to get our old nick's available presence,
492 -- so remove our session from there, and manually generate an unavailable
493 orig_occupant:remove_session(real_jid);
494 log("debug", "generating nick change for %s", real_jid);
495 local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";});
496 -- self:build_item_list(orig_occupant, x, false, dest_nick); -- COMPAT: clients get confused if they see other items besides their own
497 add_item(x, self:get_affiliation(bare_jid), orig_occupant.role, real_jid, dest_nick);
498 x:tag("status", {code = "303";}):up();
499 x:tag("status", {code = "110";}):up();
500 self:route_stanza(generated_unavail:add_child(x));
501 dest_nick = nil; -- set dest_nick to nil; so general populance doesn't see it for whole orig_occupant
504 self:save_occupant(orig_occupant);
505 self:publicise_occupant_status(orig_occupant, orig_x, dest_nick);
507 if is_last_orig_session then
508 module:fire_event("muc-occupant-left", {
510 nick = orig_occupant.nick;
511 occupant = orig_occupant;
518 if dest_occupant ~= nil then
519 dest_occupant:set_session(real_jid, stanza);
520 local dest_x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";});
522 dest_x:tag("status", {code = "201"}):up();
524 if orig_occupant == nil and self:get_whois() == "anyone" then
525 dest_x:tag("status", {code = "100"}):up();
527 self:save_occupant(dest_occupant);
529 if orig_occupant == nil then
530 -- Send occupant list to newly joined user
531 self:send_occupant_list(real_jid, function(nick, occupant) -- luacheck: ignore 212
532 -- Don't include self
533 return occupant:get_presence(real_jid) == nil;
536 self:publicise_occupant_status(dest_occupant, dest_x);
538 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
539 log("debug", "session %s split nicks; showing %s rejoining", real_jid, orig_occupant.nick);
540 -- Show the original nick joining again
541 local pr = st.clone(orig_occupant:get_presence());
542 pr.attr.to = real_jid;
543 local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";});
544 self:build_item_list(orig_occupant, x, false);
545 -- TODO: new status code to inform client this was the multi-session it left?
547 self:route_stanza(pr);
550 if orig_occupant == nil then
551 if is_first_dest_session then
552 module:fire_event("muc-occupant-joined", {
554 nick = dest_occupant.nick;
555 occupant = dest_occupant;
560 module:fire_event("muc-occupant-session-new", {
562 nick = dest_occupant.nick;
563 occupant = dest_occupant;
570 elseif type ~= 'result' then -- bad type
571 if type ~= 'visible' and type ~= 'invisible' then -- COMPAT ejabberd can broadcast or forward XEP-0018 presences
572 origin.send(st.error_reply(stanza, "modify", "bad-request")); -- FIXME correct error?
578 function room_mt:handle_iq_to_occupant(origin, stanza)
579 local from, to = stanza.attr.from, stanza.attr.to;
580 local type = stanza.attr.type;
581 local id = stanza.attr.id;
582 local occupant = self:get_occupant_by_nick(to);
583 if (type == "error" or type == "result") then
584 do -- deconstruct_stanza_id
585 if not occupant then return nil; end
586 local from_jid, orig_id, to_jid_hash = (base64.decode(id) or ""):match("^(%Z+)%z(%Z*)%z(.+)$");
587 if not(from == from_jid or from == jid_bare(from_jid)) then return nil; end
588 local from_occupant_jid = self:get_occupant_jid(from_jid);
589 if from_occupant_jid == nil then return nil; end
591 for to_jid in occupant:each_session() do
592 if md5(to_jid) == to_jid_hash then
593 session_jid = to_jid;
597 if session_jid == nil then return nil; end
598 stanza.attr.from, stanza.attr.to, stanza.attr.id = from_occupant_jid, session_jid, orig_id;
600 log("debug", "%s sent private iq stanza to %s (%s)", from, to, stanza.attr.to);
601 self:route_stanza(stanza);
602 stanza.attr.from, stanza.attr.to, stanza.attr.id = from, to, id;
604 else -- Type is "get" or "set"
605 local current_nick = self:get_occupant_jid(from);
606 if not current_nick then
607 origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));
610 if not occupant then -- recipient not in room
611 origin.send(st.error_reply(stanza, "cancel", "item-not-found", "Recipient not in room"));
614 do -- construct_stanza_id
615 stanza.attr.id = base64.encode(occupant.jid.."\0"..stanza.attr.id.."\0"..md5(from));
617 stanza.attr.from, stanza.attr.to = current_nick, occupant.jid;
618 log("debug", "%s sent private iq stanza to %s (%s)", from, to, occupant.jid);
619 if stanza.tags[1].attr.xmlns == 'vcard-temp' then
620 stanza.attr.to = jid_bare(stanza.attr.to);
622 self:route_stanza(stanza);
623 stanza.attr.from, stanza.attr.to, stanza.attr.id = from, to, id;
628 function room_mt:handle_message_to_occupant(origin, stanza)
629 local from, to = stanza.attr.from, stanza.attr.to;
630 local current_nick = self:get_occupant_jid(from);
631 local type = stanza.attr.type;
632 if not current_nick then -- not in room
633 if type ~= "error" then
634 origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));
638 if type == "groupchat" then -- groupchat messages not allowed in PM
639 origin.send(st.error_reply(stanza, "modify", "bad-request"));
641 elseif type == "error" and is_kickable_error(stanza) then
642 log("debug", "%s kicked from %s for sending an error message", current_nick, self.jid);
643 return self:handle_kickable(origin, stanza); -- send unavailable
646 local o_data = self:get_occupant_by_nick(to);
648 origin.send(st.error_reply(stanza, "cancel", "item-not-found", "Recipient not in room"));
651 log("debug", "%s sent private message stanza to %s (%s)", from, to, o_data.jid);
652 stanza:tag("x", { xmlns = "http://jabber.org/protocol/muc#user" }):up();
653 stanza.attr.from = current_nick;
654 self:route_to_occupant(o_data, stanza)
655 -- TODO: Remove x tag?
656 stanza.attr.from = from;
660 function room_mt:send_form(origin, stanza)
661 origin.send(st.reply(stanza):query("http://jabber.org/protocol/muc#owner")
662 :add_child(self:get_form_layout(stanza.attr.from):form())
666 function room_mt:get_form_layout(actor)
667 local form = dataform.new({
668 title = "Configuration for "..self.jid,
669 instructions = "Complete and submit this form to configure the room.",
673 value = 'http://jabber.org/protocol/muc#roomconfig'
676 return module:fire_event("muc-config-form", { room = self, actor = actor, form = form }) or form;
679 function room_mt:process_form(origin, stanza)
680 local form = stanza.tags[1]:get_child("x", "jabber:x:data");
681 if form.attr.type == "cancel" then
682 origin.send(st.reply(stanza));
683 elseif form.attr.type == "submit" then
684 local fields, errors, present;
685 if form.tags[1] == nil then -- Instant room
686 fields, present = {}, {};
688 fields, errors, present = self:get_form_layout(stanza.attr.from):data(form);
689 if fields.FORM_TYPE ~= "http://jabber.org/protocol/muc#roomconfig" then
690 origin.send(st.error_reply(stanza, "cancel", "bad-request", "Form is not of type room configuration"));
695 local event = {room = self; origin = origin; stanza = stanza; fields = fields; status_codes = {};};
696 function event.update_option(name, field, allowed)
697 local new = fields[field];
698 if new == nil then return; end
699 if allowed and not allowed[new] then return; end
700 if new == self["get_"..name](self) then return; end
701 event.status_codes["104"] = true;
702 self["set_"..name](self, new);
705 module:fire_event("muc-config-submitted", event);
706 for submitted_field in pairs(present) do
707 event.field, event.value = submitted_field, fields[submitted_field];
708 module:fire_event("muc-config-submitted/"..submitted_field, event);
710 event.field, event.value = nil, nil;
713 origin.send(st.reply(stanza));
715 if next(event.status_codes) then
716 local msg = st.message({type='groupchat', from=self.jid})
717 :tag('x', {xmlns='http://jabber.org/protocol/muc#user'})
718 for code in pairs(event.status_codes) do
719 msg:tag("status", {code = code;}):up();
722 self:broadcast_message(msg);
725 origin.send(st.error_reply(stanza, "cancel", "bad-request", "Not a submitted form"));
730 -- Removes everyone from the room
731 function room_mt:clear(x)
732 x = x or st.stanza("x", {xmlns='http://jabber.org/protocol/muc#user'});
733 local occupants_updated = {};
734 for nick, occupant in self:each_occupant() do -- luacheck: ignore 213
736 self:save_occupant(occupant);
737 occupants_updated[occupant] = true;
739 for occupant in pairs(occupants_updated) do
740 self:publicise_occupant_status(occupant, x);
741 module:fire_event("muc-occupant-left", { room = self; nick = occupant.nick; occupant = occupant;});
745 function room_mt:destroy(newjid, reason, password)
746 local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"})
747 :tag("item", { affiliation='none', role='none' }):up()
748 :tag("destroy", {jid=newjid});
749 if reason then x:tag("reason"):text(reason):up(); end
750 if password then x:tag("password"):text(password):up(); end
753 module:fire_event("muc-room-destroyed", { room = self });
756 function room_mt:handle_disco_info_get_query(origin, stanza)
757 origin.send(self:get_disco_info(stanza));
761 function room_mt:handle_disco_items_get_query(origin, stanza)
762 origin.send(self:get_disco_items(stanza));
766 function room_mt:handle_admin_query_set_command(origin, stanza)
767 local item = stanza.tags[1].tags[1];
769 origin.send(st.error_reply(stanza, "cancel", "bad-request"));
771 if item.attr.jid then -- Validate provided JID
772 item.attr.jid = jid_prep(item.attr.jid);
773 if not item.attr.jid then
774 origin.send(st.error_reply(stanza, "modify", "jid-malformed"));
778 if not item.attr.jid and item.attr.nick then -- COMPAT Workaround for Miranda sending 'nick' instead of 'jid' when changing affiliation
779 local occupant = self:get_occupant_by_nick(self.jid.."/"..item.attr.nick);
780 if occupant then item.attr.jid = occupant.jid; end
781 elseif not item.attr.nick and item.attr.jid then
782 local nick = self:get_occupant_jid(item.attr.jid);
783 if nick then item.attr.nick = select(3, jid_split(nick)); end
785 local actor = stanza.attr.from;
786 local reason = item:get_child_text("reason");
787 local success, errtype, err
788 if item.attr.affiliation and item.attr.jid and not item.attr.role then
789 success, errtype, err = self:set_affiliation(actor, item.attr.jid, item.attr.affiliation, reason);
790 elseif item.attr.role and item.attr.nick and not item.attr.affiliation then
791 success, errtype, err = self:set_role(actor, self.jid.."/"..item.attr.nick, item.attr.role, reason);
793 success, errtype, err = nil, "cancel", "bad-request";
797 origin.send(st.error_reply(stanza, errtype, err));
799 origin.send(st.reply(stanza));
804 function room_mt:handle_admin_query_get_command(origin, stanza)
805 local actor = stanza.attr.from;
806 local affiliation = self:get_affiliation(actor);
807 local item = stanza.tags[1].tags[1];
808 local _aff = item.attr.affiliation;
809 local _aff_rank = valid_affiliations[_aff or "none"];
810 local _rol = item.attr.role;
811 if _aff and _aff_rank and not _rol then
812 -- You need to be at least an admin, and be requesting info about your affifiliation or lower
813 -- e.g. an admin can't ask for a list of owners
814 local affiliation_rank = valid_affiliations[affiliation or "none"];
815 if affiliation_rank >= valid_affiliations.admin and affiliation_rank >= _aff_rank then
816 local reply = st.reply(stanza):query("http://jabber.org/protocol/muc#admin");
817 for jid in self:each_affiliation(_aff or "none") do
818 reply:tag("item", {affiliation = _aff, jid = jid}):up();
820 origin.send(reply:up());
823 origin.send(st.error_reply(stanza, "auth", "forbidden"));
826 elseif _rol and valid_roles[_rol or "none"] and not _aff then
827 local role = self:get_role(self:get_occupant_jid(actor)) or self:get_default_role(affiliation);
828 if valid_roles[role or "none"] >= valid_roles.moderator then
829 if _rol == "none" then _rol = nil; end
830 local reply = st.reply(stanza):query("http://jabber.org/protocol/muc#admin");
831 -- TODO: whois check here? (though fully anonymous rooms are not supported)
832 for occupant_jid, occupant in self:each_occupant() do
833 if occupant.role == _rol then
834 local nick = select(3,jid_split(occupant_jid));
835 self:build_item_list(occupant, reply, false, nick);
838 origin.send(reply:up());
841 origin.send(st.error_reply(stanza, "auth", "forbidden"));
845 origin.send(st.error_reply(stanza, "cancel", "bad-request"));
850 function room_mt:handle_owner_query_get_to_room(origin, stanza)
851 if self:get_affiliation(stanza.attr.from) ~= "owner" then
852 origin.send(st.error_reply(stanza, "auth", "forbidden", "Only owners can configure rooms"));
856 self:send_form(origin, stanza);
859 function room_mt:handle_owner_query_set_to_room(origin, stanza)
860 if self:get_affiliation(stanza.attr.from) ~= "owner" then
861 origin.send(st.error_reply(stanza, "auth", "forbidden", "Only owners can configure rooms"));
865 local child = stanza.tags[1].tags[1];
867 origin.send(st.error_reply(stanza, "modify", "bad-request"));
869 elseif child.name == "destroy" then
870 local newjid = child.attr.jid;
871 local reason = child:get_child_text("reason");
872 local password = child:get_child_text("password");
873 self:destroy(newjid, reason, password);
874 origin.send(st.reply(stanza));
876 elseif child.name == "x" and child.attr.xmlns == "jabber:x:data" then
877 return self:process_form(origin, stanza);
879 origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
884 function room_mt:handle_groupchat_to_room(origin, stanza)
885 local from = stanza.attr.from;
886 local occupant = self:get_occupant_by_real_jid(from);
887 if module:fire_event("muc-occupant-groupchat", {
888 room = self; origin = origin; stanza = stanza; from = from; occupant = occupant;
889 }) then return true; end
890 stanza.attr.from = occupant.nick;
891 self:broadcast_message(stanza);
892 stanza.attr.from = from;
897 module:hook("muc-occupant-groupchat", function(event)
898 local role_rank = valid_roles[event.occupant and event.occupant.role or "none"];
899 if role_rank <= valid_roles.none then
900 event.origin.send(st.error_reply(event.stanza, "cancel", "not-acceptable"));
902 elseif role_rank <= valid_roles.visitor then
903 event.origin.send(st.error_reply(event.stanza, "auth", "forbidden"));
908 -- hack - some buggy clients send presence updates to the room rather than their nick
909 function room_mt:handle_presence_to_room(origin, stanza)
910 local current_nick = self:get_occupant_jid(stanza.attr.from);
913 local to = stanza.attr.to;
914 stanza.attr.to = current_nick;
915 handled = self:handle_presence_to_occupant(origin, stanza);
921 -- Need visitor role or higher to invite
922 module:hook("muc-pre-invite", function(event)
923 local room, stanza = event.room, event.stanza;
924 local _from = stanza.attr.from;
925 local inviter = room:get_occupant_by_real_jid(_from);
926 local role = inviter and inviter.role or room:get_default_role(room:get_affiliation(_from));
927 if valid_roles[role or "none"] <= valid_roles.visitor then
928 event.origin.send(st.error_reply(stanza, "auth", "forbidden"));
933 function room_mt:handle_mediated_invite(origin, stanza)
934 local payload = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("invite");
935 local invitee = jid_prep(payload.attr.to);
937 origin.send(st.error_reply(stanza, "cancel", "jid-malformed"));
939 elseif module:fire_event("muc-pre-invite", {room = self, origin = origin, stanza = stanza}) then
942 local invite = muc_util.filter_muc_x(st.clone(stanza));
943 invite.attr.from = self.jid;
944 invite.attr.to = invitee;
945 invite:tag('x', {xmlns='http://jabber.org/protocol/muc#user'})
946 :tag('invite', {from = stanza.attr.from;})
947 :tag('reason'):text(payload:get_child_text("reason")):up()
950 if not module:fire_event("muc-invite", {room = self, stanza = invite, origin = origin, incoming = stanza}) then
951 self:route_stanza(invite);
956 -- COMPAT: Some older clients expect this
957 module:hook("muc-invite", function(event)
958 local room, stanza = event.room, event.stanza;
959 local invite = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("invite");
960 local reason = invite:get_child_text("reason");
961 stanza:tag('x', {xmlns = "jabber:x:conference"; jid = room.jid;})
966 -- Add a plain message for clients which don't support invites
967 module:hook("muc-invite", function(event)
968 local room, stanza = event.room, event.stanza;
969 if not stanza:get_child("body") then
970 local invite = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("invite");
971 local reason = invite:get_child_text("reason") or "";
973 :text(invite.attr.from.." invited you to the room "..room.jid..(reason == "" and (" ("..reason..")") or ""))
978 function room_mt:handle_mediated_decline(origin, stanza)
979 local payload = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("decline");
980 local declinee = jid_prep(payload.attr.to);
982 origin.send(st.error_reply(stanza, "cancel", "jid-malformed"));
984 elseif module:fire_event("muc-pre-decline", {room = self, origin = origin, stanza = stanza}) then
987 local decline = muc_util.filter_muc_x(st.clone(stanza));
988 decline.attr.from = self.jid;
989 decline.attr.to = declinee;
990 decline:tag("x", {xmlns = "http://jabber.org/protocol/muc#user"})
991 :tag("decline", {from = stanza.attr.from})
992 :tag("reason"):text(payload:get_child_text("reason")):up()
995 if not module:fire_event("muc-decline", {room = self, stanza = decline, origin = origin, incoming = stanza}) then
996 declinee = decline.attr.to; -- re-fetch, in case event modified it
998 if jid_bare(declinee) == self.jid then -- declinee jid is already an in-room jid
999 occupant = self:get_occupant_by_nick(declinee);
1002 self:route_to_occupant(occupant, decline);
1004 self:route_stanza(decline);
1010 -- Add a plain message for clients which don't support declines
1011 module:hook("muc-decline", function(event)
1012 local room, stanza = event.room, event.stanza;
1013 if not stanza:get_child("body") then
1014 local decline = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("decline");
1015 local reason = decline:get_child_text("reason") or "";
1017 :text(decline.attr.from.." declined your invite to the room "..room.jid..(reason == "" and (" ("..reason..")") or ""))
1022 function room_mt:handle_message_to_room(origin, stanza)
1023 local type = stanza.attr.type;
1024 if type == "groupchat" then
1025 return self:handle_groupchat_to_room(origin, stanza)
1026 elseif type == "error" and is_kickable_error(stanza) then
1027 return self:handle_kickable(origin, stanza)
1028 elseif type == nil then
1029 local x = stanza:get_child("x", "http://jabber.org/protocol/muc#user");
1031 local payload = x.tags[1];
1032 if payload == nil then --luacheck: ignore 542
1034 elseif payload.name == "invite" and payload.attr.to then
1035 return self:handle_mediated_invite(origin, stanza)
1036 elseif payload.name == "decline" and payload.attr.to then
1037 return self:handle_mediated_decline(origin, stanza)
1039 origin.send(st.error_reply(stanza, "cancel", "bad-request"));
1045 function room_mt:route_stanza(stanza) -- luacheck: ignore 212
1046 module:send(stanza);
1049 function room_mt:get_affiliation(jid)
1050 local node, host, resource = jid_split(jid);
1051 local bare = node and node.."@"..host or host;
1052 local result = self._affiliations[bare]; -- Affiliations are granted, revoked, and maintained based on the user's bare JID.
1053 if not result and self._affiliations[host] == "outcast" then result = "outcast"; end -- host banned
1057 -- Iterates over jid, affiliation pairs
1058 function room_mt:each_affiliation(with_affiliation)
1059 if not with_affiliation then
1060 return pairs(self._affiliations);
1062 return function(_affiliations, jid)
1064 repeat -- Iterate until we get a match
1065 jid, affiliation = next(_affiliations, jid);
1066 until jid == nil or affiliation == with_affiliation
1067 return jid, affiliation;
1068 end, self._affiliations, nil
1072 function room_mt:set_affiliation(actor, jid, affiliation, reason)
1073 if not actor then return nil, "modify", "not-acceptable"; end;
1075 local node, host, resource = jid_split(jid);
1076 if not host then return nil, "modify", "not-acceptable"; end
1077 jid = jid_join(node, host); -- Bare
1078 local is_host_only = node == nil;
1080 if valid_affiliations[affiliation or "none"] == nil then
1081 return nil, "modify", "not-acceptable";
1083 affiliation = affiliation ~= "none" and affiliation or nil; -- coerces `affiliation == false` to `nil`
1085 local target_affiliation = self._affiliations[jid]; -- Raw; don't want to check against host
1086 local is_downgrade = valid_affiliations[target_affiliation or "none"] > valid_affiliations[affiliation or "none"];
1088 if actor == true then
1089 actor = nil -- So we can pass it safely to 'publicise_occupant_status' below
1091 local actor_affiliation = self:get_affiliation(actor);
1092 if actor_affiliation == "owner" then
1093 if jid_bare(actor) == jid then -- self change
1094 -- need at least one owner
1095 local is_last = true;
1096 for j in self:each_affiliation("owner") do
1097 if j ~= jid then is_last = false; break; end
1100 return nil, "cancel", "conflict";
1103 -- owners can do anything else
1104 elseif affiliation == "owner" or affiliation == "admin"
1105 or actor_affiliation ~= "admin"
1106 or target_affiliation == "owner" or target_affiliation == "admin" then
1107 -- Can't demote owners or other admins
1108 return nil, "cancel", "not-allowed";
1112 -- Set in 'database'
1113 self._affiliations[jid] = affiliation;
1116 local role = self:get_default_role(affiliation);
1117 local role_rank = valid_roles[role or "none"];
1118 local occupants_updated = {}; -- Filled with old roles
1119 for nick, occupant in self:each_occupant() do -- luacheck: ignore 213
1120 if occupant.bare_jid == jid or (
1121 -- Outcast can be by host.
1122 is_host_only and affiliation == "outcast" and select(2, jid_split(occupant.bare_jid)) == host
1124 -- need to publcize in all cases; as affiliation in <item/> has changed.
1125 occupants_updated[occupant] = occupant.role;
1126 if occupant.role ~= role and (
1128 valid_roles[occupant.role or "none"] < role_rank -- upgrade
1130 occupant.role = role;
1131 self:save_occupant(occupant);
1136 -- Tell the room of the new occupant affiliations+roles
1137 local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"});
1138 if not role then -- getting kicked
1139 if affiliation == "outcast" then
1140 x:tag("status", {code="301"}):up(); -- banned
1142 x:tag("status", {code="321"}):up(); -- affiliation change
1145 local is_semi_anonymous = self:get_whois() == "moderators";
1146 for occupant, old_role in pairs(occupants_updated) do
1147 self:publicise_occupant_status(occupant, x, nil, actor, reason);
1148 if occupant.role == nil then
1149 module:fire_event("muc-occupant-left", {room = self; nick = occupant.nick; occupant = occupant;});
1150 elseif is_semi_anonymous and
1151 (old_role == "moderator" and occupant.role ~= "moderator") or
1152 (old_role ~= "moderator" and occupant.role == "moderator") then -- Has gained or lost moderator status
1153 -- Send everyone else's presences (as jid visibility has changed)
1154 for real_jid in occupant:each_session() do
1155 self:send_occupant_list(real_jid, function(occupant_jid, occupant) --luacheck: ignore 212 433
1156 return occupant.bare_jid ~= jid;
1164 module:fire_event("muc-set-affiliation", {
1168 affiliation = affiliation or "none";
1170 previous_affiliation = target_affiliation;
1171 in_room = next(occupants_updated) ~= nil;
1177 function room_mt:get_role(nick)
1178 local occupant = self:get_occupant_by_nick(nick);
1179 return occupant and occupant.role or nil;
1182 function room_mt:set_role(actor, occupant_jid, role, reason)
1183 if not actor then return nil, "modify", "not-acceptable"; end
1185 local occupant = self:get_occupant_by_nick(occupant_jid);
1186 if not occupant then return nil, "modify", "item-not-found"; end
1188 if valid_roles[role or "none"] == nil then
1189 return nil, "modify", "not-acceptable";
1191 role = role ~= "none" and role or nil; -- coerces `role == false` to `nil`
1193 if actor == true then
1194 actor = nil -- So we can pass it safely to 'publicise_occupant_status' below
1196 -- Can't do anything to other owners or admins
1197 local occupant_affiliation = self:get_affiliation(occupant.bare_jid);
1198 if occupant_affiliation == "owner" or occupant_affiliation == "admin" then
1199 return nil, "cancel", "not-allowed";
1202 -- If you are trying to give or take moderator role you need to be an owner or admin
1203 if occupant.role == "moderator" or role == "moderator" then
1204 local actor_affiliation = self:get_affiliation(actor);
1205 if actor_affiliation ~= "owner" and actor_affiliation ~= "admin" then
1206 return nil, "cancel", "not-allowed";
1210 -- Need to be in the room and a moderator
1211 local actor_occupant = self:get_occupant_by_real_jid(actor);
1212 if not actor_occupant or actor_occupant.role ~= "moderator" then
1213 return nil, "cancel", "not-allowed";
1217 local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"});
1219 x:tag("status", {code = "307"}):up();
1221 occupant.role = role;
1222 self:save_occupant(occupant);
1223 self:publicise_occupant_status(occupant, x, nil, actor, reason);
1225 module:fire_event("muc-occupant-left", {room = self; nick = occupant.nick; occupant = occupant;});
1230 local whois = module:require "muc/whois";
1231 room_mt.get_whois = whois.get;
1232 room_mt.set_whois = whois.set;
1234 local _M = {}; -- module "muc"
1236 function _M.new_room(jid, config)
1237 return setmetatable({
1241 _data = config or {};
1246 function room_mt:freeze(live)
1251 for user, affiliation in pairs(self._affiliations) do
1252 frozen[user] = affiliation;
1255 for nick, occupant in self:each_occupant() do
1257 bare_jid = occupant.bare_jid;
1258 role = occupant.role;
1261 for jid, presence in occupant:each_session() do
1262 frozen[jid] = st.preserialize(presence);
1269 function _M.restore_room(frozen)
1271 if frozen.jid and frozen._affiliations then
1272 local room = _M.new_room(frozen.jid, frozen._data);
1273 room._affiliations = frozen._affiliations;
1277 local room_jid = frozen._jid;
1278 local room = _M.new_room(room_jid, frozen._data);
1280 local occupants = {};
1281 local occupant_sessions = {};
1282 local room_name, room_host = jid_split(room_jid);
1283 for jid, data in pairs(frozen) do
1284 local node, host, resource = jid_split(jid);
1285 if node or host:sub(1,1) ~= "_" then
1286 if not resource then
1287 -- bare jid: affiliation
1288 room._affiliations[jid] = data;
1289 elseif host == room_host and node == room_name then
1290 -- full room jid: bare real jid and role
1291 local bare_jid = data.bare_jid;
1292 local occupant = occupant_lib.new(bare_jid, jid);
1293 occupant.jid = data.jid;
1294 occupant.role = data.role;
1295 occupants[bare_jid] = occupant;
1296 local sessions = occupant_sessions[bare_jid];
1298 for full_jid, presence in pairs(sessions) do
1299 occupant:set_session(full_jid, presence);
1302 occupant_sessions[bare_jid] = nil;
1304 -- full user jid: presence
1305 local presence = st.deserialize(data);
1306 local bare_jid = jid_bare(jid);
1307 local occupant = occupants[bare_jid];
1308 local sessions = occupant_sessions[bare_jid];
1310 occupant:set_session(jid, presence);
1311 elseif sessions then
1312 sessions[jid] = presence;
1314 occupant_sessions[bare_jid] = {
1322 for _, occupant in pairs(occupants) do
1323 room:save_occupant(occupant);
1329 _M.room_mt = room_mt;