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;
11 local pairs, ipairs = pairs, ipairs;
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 st = require "util.stanza";
21 local log = require "util.logger".init("mod_muc");
22 local base64 = require "util.encodings".base64;
23 local md5 = require "util.hashes".md5;
25 local occupant_lib = module:require "muc/occupant"
26 local muc_util = module:require "muc/util";
27 local is_kickable_error = muc_util.is_kickable_error;
28 local valid_roles, valid_affiliations = muc_util.valid_roles, muc_util.valid_affiliations;
31 room_mt.__index = room_mt;
33 function room_mt:__tostring()
34 return "MUC room ("..self.jid..")";
37 function room_mt:get_occupant_jid(real_jid)
38 return self._jid_nick[real_jid]
41 function room_mt:get_default_role(affiliation)
42 local role = module:fire_event("muc-get-default-role", {
44 affiliation = affiliation;
45 affiliation_rank = valid_affiliations[affiliation or "none"];
47 return role, valid_roles[role or "none"];
49 module:hook("muc-get-default-role", function(event)
50 if event.affiliation_rank >= valid_affiliations.admin then
52 elseif event.affiliation_rank >= valid_affiliations.none then
57 --- Occupant functions
58 function room_mt:new_occupant(bare_real_jid, nick)
59 local occupant = occupant_lib.new(bare_real_jid, nick);
60 local affiliation = self:get_affiliation(bare_real_jid);
61 occupant.role = self:get_default_role(affiliation);
65 function room_mt:get_occupant_by_nick(nick)
66 local occupant = self._occupants[nick];
67 if occupant == nil then return nil end
68 return occupant_lib.copy(occupant);
72 local function next_copied_occupant(occupants, occupant_jid)
73 local next_occupant_jid, raw_occupant = next(occupants, occupant_jid);
74 if next_occupant_jid == nil then return nil end
75 return next_occupant_jid, occupant_lib.copy(raw_occupant);
77 function room_mt:each_occupant(read_only)
78 return next_copied_occupant, self._occupants, nil;
82 function room_mt:has_occupant()
83 return next(self._occupants, nil) ~= nil
86 function room_mt:get_occupant_by_real_jid(real_jid)
87 local occupant_jid = self:get_occupant_jid(real_jid);
88 if occupant_jid == nil then return nil end
89 return self:get_occupant_by_nick(occupant_jid);
92 function room_mt:save_occupant(occupant)
93 occupant = occupant_lib.copy(occupant); -- So that occupant can be modified more
94 local id = occupant.nick
96 -- Need to maintain _jid_nick secondary index
97 local old_occupant = self._occupants[id];
99 for real_jid in pairs(old_occupant.sessions) do
100 self._jid_nick[real_jid] = nil;
104 local has_live_session = false
105 if occupant.role ~= nil then
106 for real_jid, presence in occupant:each_session() do
107 if presence.attr.type == nil then
108 has_live_session = true
109 self._jid_nick[real_jid] = occupant.nick;
112 if not has_live_session then
113 -- Has no live sessions left; they have left the room.
117 if not has_live_session then
120 self._occupants[id] = occupant
123 function room_mt:route_to_occupant(occupant, stanza)
124 local to = stanza.attr.to;
125 for jid, pr in occupant:each_session() do
126 stanza.attr.to = jid;
127 self:route_stanza(stanza);
132 -- actor is the attribute table
133 local function add_item(x, affiliation, role, jid, nick, actor, reason)
134 x:tag("item", {affiliation = affiliation; role = role; jid = jid; nick = nick;})
136 x:tag("actor", actor):up()
139 x:tag("reason"):text(reason):up()
145 -- actor is (real) jid
146 function room_mt:build_item_list(occupant, x, is_anonymous, nick, actor, reason)
147 local affiliation = self:get_affiliation(occupant.bare_jid) or "none";
148 local role = occupant.role or "none";
151 actor_attr = {nick = select(3,jid_split(self:get_occupant_jid(actor)))};
154 add_item(x, affiliation, role, nil, nick, actor_attr, reason);
157 actor_attr.jid = actor;
159 for real_jid, session in occupant:each_session() do
160 add_item(x, affiliation, role, real_jid, nick, actor_attr, reason);
166 function room_mt:broadcast_message(stanza)
167 module:fire_event("muc-broadcast-message", {room = self, stanza = stanza});
168 self:broadcast(stanza);
171 -- Broadcast a stanza to all occupants in the room.
172 -- optionally checks conditional called with (nick, occupant)
173 function room_mt:broadcast(stanza, cond_func)
174 for nick, occupant in self:each_occupant() do
175 if cond_func == nil or cond_func(nick, occupant) then
176 self:route_to_occupant(occupant, stanza)
181 local function can_see_real_jids(whois, occupant)
182 if whois == "anyone" then
184 elseif whois == "moderators" then
185 return valid_roles[occupant.role or "none"] >= valid_roles.moderator;
189 -- Broadcasts an occupant's presence to the whole room
190 -- Takes the x element that goes into the stanzas
191 function room_mt:publicise_occupant_status(occupant, base_x, nick, actor, reason)
192 -- Build real jid and (optionally) occupant jid template presences
194 if occupant.role ~= nil then
195 -- Try to use main jid's presence
196 local pr = occupant:get_presence();
198 base_presence = st.clone(pr);
201 base_presence = base_presence or st.presence {from = occupant.nick; type = "unavailable";};
203 -- Fire event (before full_p and anon_p are created)
204 module:fire_event("muc-broadcast-presence", {
205 room = self; stanza = base_presence; x = base_x;
206 occupant = occupant; nick = nick; actor = actor;
210 local function get_presence(is_anonymous)
211 local x = st.clone(base_x);
212 self:build_item_list(occupant, x, is_anonymous, nick, actor, reason);
213 return st.clone(base_presence):add_child(x), x;
216 local full_p, full_x = get_presence(false);
218 -- Create anon_p lazily
219 local anon_p, anon_x;
220 local function get_anon_p()
221 if anon_p == nil then
222 anon_p, anon_x = get_presence(true);
224 return anon_p, anon_x;
227 local whois = self:get_whois();
230 for nick, n_occupant in self:each_occupant() do
231 if nick ~= occupant.nick then
233 if can_see_real_jids(whois, n_occupant) or occupant.bare_jid == n_occupant.bare_jid then
238 self:route_to_occupant(n_occupant, pr);
242 -- Presences for occupant itself
243 full_x:tag("status", {code = "110";}):up();
244 if occupant.role == nil then
245 -- They get an unavailable
246 self:route_to_occupant(occupant, full_p);
248 -- use their own presences as templates
249 for full_jid, pr in occupant:each_session() do
251 pr.attr.to = full_jid;
252 -- You can always see your own full jids
253 pr:add_child(full_x);
254 self:route_stanza(pr);
259 function room_mt:send_occupant_list(to, filter)
260 local to_bare = jid_bare(to);
261 local is_anonymous = false;
262 local whois = self:get_whois();
263 if whois ~= "anyone" then
264 local affiliation = self:get_affiliation(to);
265 if affiliation ~= "admin" and affiliation ~= "owner" then
266 local occupant = self:get_occupant_by_real_jid(to);
267 if not (occupant and can_see_real_jids(whois, occupant)) then
272 for occupant_jid, occupant in self:each_occupant() do
273 if filter == nil or filter(occupant_jid, occupant) then
274 local x = st.stanza("x", {xmlns='http://jabber.org/protocol/muc#user'});
275 self:build_item_list(occupant, x, is_anonymous and to_bare ~= occupant.bare_jid); -- can always see your own jids
276 local pres = st.clone(occupant:get_presence());
279 self:route_stanza(pres);
284 function room_mt:get_disco_info(stanza)
285 local reply = st.reply(stanza):query("http://jabber.org/protocol/disco#info");
286 local form = dataform.new {
287 { name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/protocol/muc#roominfo" };
289 module:fire_event("muc-disco#info", {room = self; reply = reply; form = form;});
290 reply:add_child(form:form(nil, "result"));
293 module:hook("muc-disco#info", function(event)
294 event.reply:tag("feature", {var = "http://jabber.org/protocol/muc"}):up();
296 module:hook("muc-disco#info", function(event)
297 local count = iterators.count(event.room:each_occupant());
298 table.insert(event.form, { name = "muc#roominfo_occupants", label = "Number of occupants", value = tostring(count) });
301 function room_mt:get_disco_items(stanza)
302 local reply = st.reply(stanza):query("http://jabber.org/protocol/disco#items");
303 for room_jid in self:each_occupant() do
304 reply:tag("item", {jid = room_jid, name = room_jid:match("/(.*)")}):up();
309 function room_mt:handle_kickable(origin, stanza)
310 local real_jid = stanza.attr.from;
311 local occupant = self:get_occupant_by_real_jid(real_jid);
312 if occupant == nil then return nil; end
313 local type, condition, text = stanza:get_error();
314 local error_message = "Kicked: "..(condition and condition:gsub("%-", " ") or "presence error");
316 error_message = error_message..": "..text;
318 occupant:set_session(real_jid, st.presence({type="unavailable"})
319 :tag('status'):text(error_message));
320 self:save_occupant(occupant);
321 local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";})
322 :tag("status", {code = "307"})
323 self:publicise_occupant_status(occupant, x);
327 -- Give the room creator owner affiliation
328 module:hook("muc-room-pre-create", function(event)
329 event.room:set_affiliation(true, jid_bare(event.stanza.attr.from), "owner");
332 -- check if user is banned
333 module:hook("muc-occupant-pre-join", function(event)
334 local room, stanza = event.room, event.stanza;
335 local affiliation = room:get_affiliation(stanza.attr.from);
336 if affiliation == "outcast" then
337 local reply = st.error_reply(stanza, "auth", "forbidden"):up();
338 reply.tags[1].attr.code = "403";
339 event.origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
344 function room_mt:handle_presence_to_occupant(origin, stanza)
345 local type = stanza.attr.type;
346 if type == "error" then -- error, kick em out!
347 return self:handle_kickable(origin, stanza)
348 elseif type == nil or type == "unavailable" then
349 local real_jid = stanza.attr.from;
350 local bare_jid = jid_bare(real_jid);
351 local orig_occupant, dest_occupant;
352 local is_new_room = next(self._affiliations) == nil;
354 if type == "unavailable" then return true; end -- Unavailable from someone not in the room
355 if module:fire_event("muc-room-pre-create", {
359 }) then return true; end
361 orig_occupant = self:get_occupant_by_real_jid(real_jid);
362 if type == "unavailable" and orig_occupant == nil then return true; end -- Unavailable from someone not in the room
364 local is_first_dest_session;
365 if type == "unavailable" then
366 -- dest_occupant = nil
367 elseif orig_occupant and orig_occupant.nick == stanza.attr.to then -- Just a presence update
368 log("debug", "presence update for %s from session %s", orig_occupant.nick, real_jid);
369 dest_occupant = orig_occupant;
371 local dest_jid = stanza.attr.to;
372 dest_occupant = self:get_occupant_by_nick(dest_jid);
373 if dest_occupant == nil then
374 log("debug", "no occupant found for %s; creating new occupant object for %s", dest_jid, real_jid);
375 is_first_dest_session = true;
376 dest_occupant = self:new_occupant(bare_jid, dest_jid);
378 is_first_dest_session = false;
381 local is_last_orig_session;
382 if orig_occupant ~= nil then
383 -- Is there are least 2 sessions?
384 local iter, ob, last = orig_occupant:each_session();
385 is_last_orig_session = iter(ob, iter(ob, last)) == nil;
388 local event, event_name = {
392 is_first_session = is_first_dest_session;
393 is_last_session = is_last_orig_session;
395 if orig_occupant == nil then
396 event_name = "muc-occupant-pre-join";
397 event.is_new_room = is_new_room;
398 elseif dest_occupant == nil then
399 event_name = "muc-occupant-pre-leave";
401 event_name = "muc-occupant-pre-change";
403 if module:fire_event(event_name, event) then return true; end
405 -- Check for nick conflicts
406 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
407 log("debug", "%s couldn't join due to nick conflict: %s", real_jid, dest_occupant.nick);
408 local reply = st.error_reply(stanza, "cancel", "conflict"):up();
409 reply.tags[1].attr.code = "409";
410 origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
414 -- Send presence stanza about original occupant
415 if orig_occupant ~= nil and orig_occupant ~= dest_occupant then
416 local orig_x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";});
418 if dest_occupant == nil then -- Session is leaving
419 log("debug", "session %s is leaving occupant %s", real_jid, orig_occupant.nick);
420 if is_last_orig_session then
421 orig_occupant.role = nil;
423 orig_occupant:set_session(real_jid, stanza);
425 log("debug", "session %s is changing from occupant %s to %s", real_jid, orig_occupant.nick, dest_occupant.nick);
426 local generated_unavail = st.presence {from = orig_occupant.nick, to = real_jid, type = "unavailable"};
427 orig_occupant:set_session(real_jid, generated_unavail);
428 dest_nick = select(3, jid_split(dest_occupant.nick));
429 if not is_first_dest_session then -- User is swapping into another pre-existing session
430 log("debug", "session %s is swapping into multisession %s, showing it leave.", real_jid, dest_occupant.nick);
431 -- Show the other session leaving
432 local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";})
433 :tag("status"):text("you are joining pre-existing session " .. dest_nick):up();
434 add_item(x, self:get_affiliation(bare_jid), "none");
435 local pr = st.presence{from = dest_occupant.nick, to = real_jid, type = "unavailable"}
437 self:route_stanza(pr);
439 if is_first_dest_session and is_last_orig_session then -- Normal nick change
440 log("debug", "no sessions in %s left; publically marking as nick change", orig_occupant.nick);
441 orig_x:tag("status", {code = "303";}):up();
442 else -- The session itself always needs to see a nick change
443 -- don't want to get our old nick's available presence,
444 -- so remove our session from there, and manually generate an unavailable
445 orig_occupant:remove_session(real_jid);
446 log("debug", "generating nick change for %s", real_jid);
447 local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";});
448 -- self:build_item_list(orig_occupant, x, false, dest_nick); -- COMPAT: clients get confused if they see other items besides their own
449 add_item(x, self:get_affiliation(bare_jid), orig_occupant.role, real_jid, dest_nick);
450 x:tag("status", {code = "303";}):up();
451 x:tag("status", {code = "110";}):up();
452 self:route_stanza(generated_unavail:add_child(x));
453 dest_nick = nil; -- set dest_nick to nil; so general populance doesn't see it for whole orig_occupant
456 self:save_occupant(orig_occupant);
457 self:publicise_occupant_status(orig_occupant, orig_x, dest_nick);
459 if is_last_orig_session then
460 module:fire_event("muc-occupant-left", {room = self; nick = orig_occupant.nick;});
464 if dest_occupant ~= nil then
465 dest_occupant:set_session(real_jid, stanza);
466 local dest_x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";});
468 dest_x:tag("status", {code = "201"}):up();
470 if orig_occupant == nil and self:get_whois() == "anyone" then
471 dest_x:tag("status", {code = "100"}):up();
473 self:save_occupant(dest_occupant);
475 if orig_occupant == nil then
476 -- Send occupant list to newly joined user
477 self:send_occupant_list(real_jid, function(nick, occupant)
478 -- Don't include self
479 return occupant:get_presence(real_jid) == nil;
482 self:publicise_occupant_status(dest_occupant, dest_x);
484 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
485 log("debug", "session %s split nicks; showing %s rejoining", real_jid, orig_occupant.nick);
486 -- Show the original nick joining again
487 local pr = st.clone(orig_occupant:get_presence());
488 pr.attr.to = real_jid;
489 local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";});
490 self:build_item_list(orig_occupant, x, false);
491 -- TODO: new status code to inform client this was the multi-session it left?
493 self:route_stanza(pr);
496 if orig_occupant == nil then
497 if is_first_dest_session then
498 module:fire_event("muc-occupant-joined", {room = self; nick = dest_occupant.nick; stanza = stanza;});
500 module:fire_event("muc-occupant-session-new", {room = self; nick = dest_occupant.nick; stanza = stanza; jid = real_jid;});
503 elseif type ~= 'result' then -- bad type
504 if type ~= 'visible' and type ~= 'invisible' then -- COMPAT ejabberd can broadcast or forward XEP-0018 presences
505 origin.send(st.error_reply(stanza, "modify", "bad-request")); -- FIXME correct error?
511 function room_mt:handle_iq_to_occupant(origin, stanza)
512 local from, to = stanza.attr.from, stanza.attr.to;
513 local type = stanza.attr.type;
514 local id = stanza.attr.id;
515 local occupant = self:get_occupant_by_nick(to);
516 if (type == "error" or type == "result") then
517 do -- deconstruct_stanza_id
518 if not occupant then return nil; end
519 local from_jid, id, to_jid_hash = (base64.decode(stanza.attr.id) or ""):match("^(.+)%z(.*)%z(.+)$");
520 if not(from == from_jid or from == jid_bare(from_jid)) then return nil; end
521 local from_occupant_jid = self:get_occupant_jid(from_jid);
522 if from_occupant_jid == nil then return nil; end
524 for to_jid in occupant:each_session() do
525 if md5(to_jid) == to_jid_hash then
526 session_jid = to_jid;
530 if session_jid == nil then return nil; end
531 stanza.attr.from, stanza.attr.to, stanza.attr.id = from_jid, session_jid, id;
533 log("debug", "%s sent private iq stanza to %s (%s)", from, to, stanza.attr.to);
534 self:route_stanza(stanza);
535 stanza.attr.from, stanza.attr.to, stanza.attr.id = from, to, id;
537 else -- Type is "get" or "set"
538 local current_nick = self:get_occupant_jid(from);
539 if not current_nick then
540 origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));
543 if not occupant then -- recipient not in room
544 origin.send(st.error_reply(stanza, "cancel", "item-not-found", "Recipient not in room"));
547 do -- construct_stanza_id
548 stanza.attr.id = base64.encode(occupant.jid.."\0"..stanza.attr.id.."\0"..md5(from));
550 stanza.attr.from, stanza.attr.to = current_nick, occupant.jid;
551 log("debug", "%s sent private iq stanza to %s (%s)", from, to, occupant.jid);
552 if stanza.tags[1].attr.xmlns == 'vcard-temp' then
553 stanza.attr.to = jid_bare(stanza.attr.to);
555 self:route_stanza(stanza);
556 stanza.attr.from, stanza.attr.to, stanza.attr.id = from, to, id;
561 function room_mt:handle_message_to_occupant(origin, stanza)
562 local from, to = stanza.attr.from, stanza.attr.to;
563 local current_nick = self:get_occupant_jid(from);
564 local type = stanza.attr.type;
565 if not current_nick then -- not in room
566 if type ~= "error" then
567 origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));
571 if type == "groupchat" then -- groupchat messages not allowed in PM
572 origin.send(st.error_reply(stanza, "modify", "bad-request"));
574 elseif type == "error" and is_kickable_error(stanza) then
575 log("debug", "%s kicked from %s for sending an error message", current_nick, self.jid);
576 return self:handle_kickable(origin, stanza); -- send unavailable
579 local o_data = self:get_occupant_by_nick(to);
581 origin.send(st.error_reply(stanza, "cancel", "item-not-found", "Recipient not in room"));
584 log("debug", "%s sent private message stanza to %s (%s)", from, to, o_data.jid);
585 stanza:tag("x", { xmlns = "http://jabber.org/protocol/muc#user" }):up();
586 stanza.attr.from = current_nick;
587 self:route_to_occupant(o_data, stanza)
588 -- TODO: Remove x tag?
589 stanza.attr.from = from;
593 function room_mt:send_form(origin, stanza)
594 origin.send(st.reply(stanza):query("http://jabber.org/protocol/muc#owner")
595 :add_child(self:get_form_layout(stanza.attr.from):form())
599 function room_mt:get_form_layout(actor)
600 local form = dataform.new({
601 title = "Configuration for "..self.jid,
602 instructions = "Complete and submit this form to configure the room.",
606 value = 'http://jabber.org/protocol/muc#roomconfig'
609 return module:fire_event("muc-config-form", { room = self, actor = actor, form = form }) or form;
612 function room_mt:process_form(origin, stanza)
613 local form = stanza.tags[1]:get_child("x", "jabber:x:data");
614 if form.attr.type == "cancel" then
615 origin.send(st.reply(stanza));
616 elseif form.attr.type == "submit" then
617 local fields = self:get_form_layout(stanza.attr.from):data(form);
618 if fields.FORM_TYPE ~= "http://jabber.org/protocol/muc#roomconfig" then
619 origin.send(st.error_reply(stanza, "cancel", "bad-request", "Form is not of type room configuration"));
623 local event = {room = self; origin = origin; stanza = stanza; fields = fields; status_codes = {};};
624 function event.update_option(name, field, allowed)
625 local new = fields[field];
626 if new == nil then return; end
627 if allowed and not allowed[new] then return; end
628 if new == self["get_"..name](self) then return; end
629 event.status_codes["104"] = true;
630 self["set_"..name](self, new);
633 module:fire_event("muc-config-submitted", event);
635 if self.save then self:save(true); end
636 origin.send(st.reply(stanza));
638 if next(event.status_codes) then
639 local msg = st.message({type='groupchat', from=self.jid})
640 :tag('x', {xmlns='http://jabber.org/protocol/muc#user'})
641 for code in pairs(event.status_codes) do
642 msg:tag("status", {code = code;}):up();
645 self:broadcast_message(msg);
648 origin.send(st.error_reply(stanza, "cancel", "bad-request", "Not a submitted form"));
653 -- Removes everyone from the room
654 function room_mt:clear(x)
655 x = x or st.stanza("x", {xmlns='http://jabber.org/protocol/muc#user'});
656 local occupants_updated = {};
657 for nick, occupant in self:each_occupant() do
659 self:save_occupant(occupant);
660 occupants_updated[occupant] = true;
662 for occupant in pairs(occupants_updated) do
663 self:publicise_occupant_status(occupant, x);
664 module:fire_event("muc-occupant-left", { room = self; nick = occupant.nick; });
668 function room_mt:destroy(newjid, reason, password)
669 local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"})
670 :tag("item", { affiliation='none', role='none' }):up()
671 :tag("destroy", {jid=newjid});
672 if reason then x:tag("reason"):text(reason):up(); end
673 if password then x:tag("password"):text(password):up(); end
676 module:fire_event("muc-room-destroyed", { room = self });
679 function room_mt:handle_disco_info_get_query(origin, stanza)
680 origin.send(self:get_disco_info(stanza));
684 function room_mt:handle_disco_items_get_query(origin, stanza)
685 origin.send(self:get_disco_items(stanza));
689 function room_mt:handle_admin_query_set_command(origin, stanza)
690 local item = stanza.tags[1].tags[1];
691 if item.attr.jid then -- Validate provided JID
692 item.attr.jid = jid_prep(item.attr.jid);
693 if not item.attr.jid then
694 origin.send(st.error_reply(stanza, "modify", "jid-malformed"));
698 if not item.attr.jid and item.attr.nick then -- COMPAT Workaround for Miranda sending 'nick' instead of 'jid' when changing affiliation
699 local occupant = self:get_occupant_by_nick(self.jid.."/"..item.attr.nick);
700 if occupant then item.attr.jid = occupant.jid; end
701 elseif not item.attr.nick and item.attr.jid then
702 local nick = self:get_occupant_jid(item.attr.jid);
703 if nick then item.attr.nick = select(3, jid_split(nick)); end
705 local actor = stanza.attr.from;
706 local reason = item:get_child_text("reason");
707 local success, errtype, err
708 if item.attr.affiliation and item.attr.jid and not item.attr.role then
709 success, errtype, err = self:set_affiliation(actor, item.attr.jid, item.attr.affiliation, reason);
710 elseif item.attr.role and item.attr.nick and not item.attr.affiliation then
711 success, errtype, err = self:set_role(actor, self.jid.."/"..item.attr.nick, item.attr.role, reason);
713 success, errtype, err = nil, "cancel", "bad-request";
715 if not success then origin.send(st.error_reply(stanza, errtype, err)); end
716 origin.send(st.reply(stanza));
720 function room_mt:handle_admin_query_get_command(origin, stanza)
721 local actor = stanza.attr.from;
722 local affiliation = self:get_affiliation(actor);
723 local item = stanza.tags[1].tags[1];
724 local _aff = item.attr.affiliation;
725 local _rol = item.attr.role;
726 if _aff and not _rol then
727 if affiliation == "owner" or (affiliation == "admin" and _aff ~= "owner" and _aff ~= "admin") then
728 local reply = st.reply(stanza):query("http://jabber.org/protocol/muc#admin");
729 for jid, affiliation in pairs(self._affiliations) do
730 if affiliation == _aff then
731 reply:tag("item", {affiliation = _aff, jid = jid}):up();
737 origin.send(st.error_reply(stanza, "auth", "forbidden"));
740 elseif _rol and not _aff then
741 local role = self:get_role(self:get_occupant_jid(actor)) or self:get_default_role(affiliation);
742 if valid_roles[role or "none"] >= valid_roles.moderator then
743 if _rol == "none" then _rol = nil; end
744 local reply = st.reply(stanza):query("http://jabber.org/protocol/muc#admin");
745 -- TODO: whois check here? (though fully anonymous rooms are not supported)
746 for occupant_jid, occupant in self:each_occupant() do
747 if occupant.role == _rol then
748 local nick = select(3,jid_split(occupant_jid));
749 self:build_item_list(occupant, reply, false, nick);
752 origin.send(reply:up());
755 origin.send(st.error_reply(stanza, "auth", "forbidden"));
759 origin.send(st.error_reply(stanza, "cancel", "bad-request"));
764 function room_mt:handle_owner_query_get_to_room(origin, stanza)
765 if self:get_affiliation(stanza.attr.from) ~= "owner" then
766 origin.send(st.error_reply(stanza, "auth", "forbidden", "Only owners can configure rooms"));
770 self:send_form(origin, stanza);
773 function room_mt:handle_owner_query_set_to_room(origin, stanza)
774 if self:get_affiliation(stanza.attr.from) ~= "owner" then
775 origin.send(st.error_reply(stanza, "auth", "forbidden", "Only owners can configure rooms"));
779 local child = stanza.tags[1].tags[1];
781 origin.send(st.error_reply(stanza, "modify", "bad-request"));
783 elseif child.name == "destroy" then
784 local newjid = child.attr.jid;
785 local reason = child:get_child_text("reason");
786 local password = child:get_child_text("password");
787 self:destroy(newjid, reason, password);
788 origin.send(st.reply(stanza));
790 elseif child.name == "x" and child.attr.xmlns == "jabber:x:data" then
791 return self:process_form(origin, stanza);
793 origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
798 function room_mt:handle_groupchat_to_room(origin, stanza)
799 -- Prosody has made the decision that messages with <subject/> are exclusively subject changes
800 -- e.g. body will be ignored; even if the subject change was not allowed
801 if stanza:get_child("subject") then
802 return module:fire_event("muc-subject-change", {room = self, origin = origin, stanza = stanza});
804 local from = stanza.attr.from;
805 local occupant = self:get_occupant_by_real_jid(from);
806 if not occupant then -- not in room
807 origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));
809 elseif occupant.role == "visitor" then
810 origin.send(st.error_reply(stanza, "auth", "forbidden"));
813 stanza.attr.from = occupant.nick;
814 self:broadcast_message(stanza);
815 stanza.attr.from = from;
819 -- hack - some buggy clients send presence updates to the room rather than their nick
820 function room_mt:handle_presence_to_room(origin, stanza)
821 local current_nick = self:get_occupant_jid(stanza.attr.from);
824 local to = stanza.attr.to;
825 stanza.attr.to = current_nick;
826 handled = self:handle_presence_to_occupant(origin, stanza);
832 -- Need visitor role or higher to invite
833 module:hook("muc-pre-invite", function(event)
834 local room, stanza = event.room, event.stanza;
835 local _from, _to = stanza.attr.from, stanza.attr.to;
836 local inviter = room:get_occupant_by_real_jid(_from);
837 local role = inviter and inviter.role or room:get_default_role(room:get_affiliation(_from));
838 if valid_roles[role or "none"] <= valid_roles.visitor then
839 event.origin.send(st.error_reply(stanza, "auth", "forbidden"));
844 function room_mt:handle_mediated_invite(origin, stanza)
845 local payload = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("invite");
846 local invitee = jid_prep(payload.attr.to);
848 origin.send(st.error_reply(stanza, "cancel", "jid-malformed"));
850 elseif module:fire_event("muc-pre-invite", {room = self, origin = origin, stanza = stanza}) then
853 local invite = muc_util.filter_muc_x(st.clone(stanza));
854 invite.attr.from = self.jid;
855 invite.attr.to = invitee;
856 invite:tag('x', {xmlns='http://jabber.org/protocol/muc#user'})
857 :tag('invite', {from = stanza.attr.from;})
858 :tag('reason'):text(payload:get_child_text("reason")):up()
861 if not module:fire_event("muc-invite", {room = self, stanza = invite, origin = origin, incoming = stanza}) then
862 self:route_stanza(invite);
867 -- COMPAT: Some older clients expect this
868 module:hook("muc-invite", function(event)
869 local room, stanza = event.room, event.stanza;
870 local invite = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("invite");
871 local reason = invite:get_child_text("reason");
872 stanza:tag('x', {xmlns = "jabber:x:conference"; jid = room.jid;})
877 -- Add a plain message for clients which don't support invites
878 module:hook("muc-invite", function(event)
879 local room, stanza = event.room, event.stanza;
880 if not stanza:get_child("body") then
881 local invite = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("invite");
882 local reason = invite:get_child_text("reason") or "";
884 :text(invite.attr.from.." invited you to the room "..room.jid..(reason == "" and (" ("..reason..")") or ""))
889 function room_mt:handle_mediated_decline(origin, stanza)
890 local payload = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("decline");
891 local declinee = jid_prep(payload.attr.to);
893 origin.send(st.error_reply(stanza, "cancel", "jid-malformed"));
895 elseif module:fire_event("muc-pre-decline", {room = self, origin = origin, stanza = stanza}) then
898 local decline = muc_util.filter_muc_x(st.clone(stanza));
899 decline.attr.from = self.jid;
900 decline.attr.to = declinee;
901 decline:tag("x", {xmlns = "http://jabber.org/protocol/muc#user"})
902 :tag("decline", {from = stanza.attr.from})
903 :tag("reason"):text(payload:get_child_text("reason")):up()
906 if not module:fire_event("muc-decline", {room = self, stanza = decline, origin = origin, incoming = stanza}) then
907 local declinee = decline.attr.to; -- re-fetch, in case event modified it
909 if jid_bare(declinee) == self.jid then -- declinee jid is already an in-room jid
910 occupant = self:get_occupant_by_nick(declinee);
913 self:route_to_occupant(occupant, decline);
915 self:route_stanza(decline);
921 -- Add a plain message for clients which don't support declines
922 module:hook("muc-decline", function(event)
923 local room, stanza = event.room, event.stanza;
924 if not stanza:get_child("body") then
925 local decline = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("decline");
926 local reason = decline:get_child_text("reason") or "";
928 :text(decline.attr.from.." declined your invite to the room "..room.jid..(reason == "" and (" ("..reason..")") or ""))
933 function room_mt:handle_message_to_room(origin, stanza)
934 local type = stanza.attr.type;
935 if type == "groupchat" then
936 return self:handle_groupchat_to_room(origin, stanza)
937 elseif type == "error" and is_kickable_error(stanza) then
938 return self:handle_kickable(origin, stanza)
939 elseif type == nil then
940 local x = stanza:get_child("x", "http://jabber.org/protocol/muc#user");
942 local payload = x.tags[1];
943 if payload == nil then
945 elseif payload.name == "invite" and payload.attr.to then
946 return self:handle_mediated_invite(origin, stanza)
947 elseif payload.name == "decline" and payload.attr.to then
948 return self:handle_mediated_decline(origin, stanza)
950 origin.send(st.error_reply(stanza, "cancel", "bad-request"));
956 function room_mt:route_stanza(stanza)
960 function room_mt:get_affiliation(jid)
961 local node, host, resource = jid_split(jid);
962 local bare = node and node.."@"..host or host;
963 local result = self._affiliations[bare]; -- Affiliations are granted, revoked, and maintained based on the user's bare JID.
964 if not result and self._affiliations[host] == "outcast" then result = "outcast"; end -- host banned
968 function room_mt:set_affiliation(actor, jid, affiliation, reason)
969 if not actor then return nil, "modify", "not-acceptable"; end;
973 if valid_affiliations[affiliation or "none"] == nil then
974 return nil, "modify", "not-acceptable";
976 affiliation = affiliation ~= "none" and affiliation or nil; -- coerces `affiliation == false` to `nil`
978 local target_affiliation = self._affiliations[jid]; -- Raw; don't want to check against host
979 local is_downgrade = valid_affiliations[target_affiliation or "none"] > valid_affiliations[affiliation or "none"];
981 if actor ~= true then
982 local actor_bare = jid_bare(actor);
983 local actor_affiliation = self._affiliations[actor_bare];
984 if actor_affiliation == "owner" then
985 if actor_bare == jid then -- self change
986 -- need at least one owner
987 local is_last = true;
988 for j, aff in pairs(self._affiliations) do if j ~= jid and aff == "owner" then is_last = false; break; end end
990 return nil, "cancel", "conflict";
993 -- owners can do anything else
994 elseif affiliation == "owner" or affiliation == "admin"
995 or actor_affiliation ~= "admin"
996 or target_affiliation == "owner" or target_affiliation == "admin" then
997 -- Can't demote owners or other admins
998 return nil, "cancel", "not-allowed";
1002 -- Set in 'database'
1003 self._affiliations[jid] = affiliation;
1006 local role = self:get_default_role(affiliation);
1007 local role_rank = valid_roles[role or "none"];
1008 local occupants_updated = {}; -- Filled with old roles
1009 for nick, occupant in self:each_occupant() do
1010 if occupant.bare_jid == jid then
1011 -- need to publcize in all cases; as affiliation in <item/> has changed.
1012 occupants_updated[occupant] = occupant.role;
1013 if occupant.role ~= role and (
1015 valid_roles[occupant.role or "none"] < role_rank -- upgrade
1017 occupant.role = role;
1018 self:save_occupant(occupant);
1023 -- Tell the room of the new occupant affiliations+roles
1024 local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"});
1025 if not role then -- getting kicked
1026 if affiliation == "outcast" then
1027 x:tag("status", {code="301"}):up(); -- banned
1029 x:tag("status", {code="321"}):up(); -- affiliation change
1032 local is_semi_anonymous = self:get_whois() == "moderators";
1033 for occupant, old_role in pairs(occupants_updated) do
1034 self:publicise_occupant_status(occupant, x, nil, actor, reason);
1035 if is_semi_anonymous and
1036 (old_role == "moderator" and occupant.role ~= "moderator") or
1037 (old_role ~= "moderator" and occupant.role == "moderator") then -- Has gained or lost moderator status
1038 -- Send everyone else's presences (as jid visibility has changed)
1039 for real_jid in occupant:each_session() do
1040 self:send_occupant_list(real_jid, function(occupant_jid, occupant)
1041 return occupant.bare_jid ~= jid;
1047 if self.save then self:save(); end
1051 function room_mt:get_role(nick)
1052 local occupant = self:get_occupant_by_nick(nick);
1053 return occupant and occupant.role or nil;
1056 function room_mt:set_role(actor, occupant_jid, role, reason)
1057 if not actor then return nil, "modify", "not-acceptable"; end
1059 local occupant = self:get_occupant_by_nick(occupant_jid);
1060 if not occupant then return nil, "modify", "not-acceptable"; end
1062 if valid_roles[role or "none"] == nil then
1063 return nil, "modify", "not-acceptable";
1065 role = role ~= "none" and role or nil; -- coerces `role == false` to `nil`
1067 if actor ~= true then
1068 -- Can't do anything to other owners or admins
1069 local occupant_affiliation = self:get_affiliation(occupant.bare_jid);
1070 if occupant_affiliation == "owner" and occupant_affiliation == "admin" then
1071 return nil, "cancel", "not-allowed";
1074 -- If you are trying to give or take moderator role you need to be an owner or admin
1075 if occupant.role == "moderator" or role == "moderator" then
1076 local actor_affiliation = self:get_affiliation(actor);
1077 if actor_affiliation ~= "owner" and actor_affiliation ~= "admin" then
1078 return nil, "cancel", "not-allowed";
1082 -- Need to be in the room and a moderator
1083 local actor_occupant = self:get_occupant_by_real_jid(actor);
1084 if not actor_occupant or actor_occupant.role ~= "moderator" then
1085 return nil, "cancel", "not-allowed";
1089 local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"});
1091 x:tag("status", {code = "307"}):up();
1093 occupant.role = role;
1094 self:save_occupant(occupant);
1095 self:publicise_occupant_status(occupant, x, nil, actor, reason);
1099 local name = module:require "muc/name";
1100 room_mt.get_name = name.get;
1101 room_mt.set_name = name.set;
1103 local description = module:require "muc/description";
1104 room_mt.get_description = description.get;
1105 room_mt.set_description = description.set;
1107 local hidden = module:require "muc/hidden";
1108 room_mt.get_hidden = hidden.get;
1109 room_mt.set_hidden = hidden.set;
1110 function room_mt:get_public()
1111 return not self:get_hidden();
1113 function room_mt:set_public(public)
1114 return self:set_hidden(not public);
1117 local password = module:require "muc/password";
1118 room_mt.get_password = password.get;
1119 room_mt.set_password = password.set;
1121 local whois = module:require "muc/whois";
1122 room_mt.get_whois = whois.get;
1123 room_mt.set_whois = whois.set;
1125 local members_only = module:require "muc/members_only";
1126 room_mt.get_members_only = members_only.get;
1127 room_mt.set_members_only = members_only.set;
1129 local moderated = module:require "muc/moderated";
1130 room_mt.get_moderated = moderated.get;
1131 room_mt.set_moderated = moderated.set;
1133 local persistent = module:require "muc/persistent";
1134 room_mt.get_persistent = persistent.get;
1135 room_mt.set_persistent = persistent.set;
1137 local subject = module:require "muc/subject";
1138 room_mt.get_changesubject = subject.get_changesubject;
1139 room_mt.set_changesubject = subject.set_changesubject;
1140 room_mt.get_subject = subject.get;
1141 room_mt.set_subject = subject.set;
1142 room_mt.send_subject = subject.send;
1144 local history = module:require "muc/history";
1145 room_mt.send_history = history.send;
1146 room_mt.get_historylength = history.get_length;
1147 room_mt.set_historylength = history.set_length;
1149 local _M = {}; -- module "muc"
1151 function _M.new_room(jid, config)
1152 return setmetatable({
1162 _M.room_mt = room_mt;