2 -- Copyright (C) 2008-2010 Matthew Wild
3 -- Copyright (C) 2008-2010 Waqas Hussain
5 -- This project is MIT/X11 licensed. Please see the
6 -- COPYING file in the source package for more information.
9 local datamanager = require "util.datamanager";
10 local datetime = require "util.datetime";
12 local jid_split = require "util.jid".split;
13 local jid_bare = require "util.jid".bare;
14 local jid_prep = require "util.jid".prep;
15 local st = require "util.stanza";
16 local log = require "util.logger".init("mod_muc");
17 local multitable_new = require "util.multitable".new;
18 local t_insert, t_remove = table.insert, table.remove;
19 local setmetatable = setmetatable;
20 local base64 = require "util.encodings".base64;
21 local md5 = require "util.hashes".md5;
23 local muc_domain = nil; --module:get_host();
24 local history_length = 20;
27 local function filter_xmlns_from_array(array, filters)
30 local attr = array[i].attr;
31 if filters[attr and attr.xmlns] then
38 local function filter_xmlns_from_stanza(stanza, filters)
40 if filter_xmlns_from_array(stanza.tags, filters) ~= 0 then
41 return stanza, filter_xmlns_from_array(stanza, filters);
46 local presence_filters = {["http://jabber.org/protocol/muc"]=true;["http://jabber.org/protocol/muc#user"]=true};
47 local function get_filtered_presence(stanza)
48 return filter_xmlns_from_stanza(st.clone(stanza):reset(), presence_filters);
50 local kickable_error_conditions = {
52 ["internal-server-error"] = true;
53 ["item-not-found"] = true;
54 ["jid-malformed"] = true;
55 ["recipient-unavailable"] = true;
57 ["remote-server-not-found"] = true;
58 ["remote-server-timeout"] = true;
59 ["service-unavailable"] = true;
60 ["malformed error"] = true;
63 local function get_error_condition(stanza)
64 local _, condition = stanza:get_error();
65 return condition or "malformed error";
68 local function is_kickable_error(stanza)
69 local cond = get_error_condition(stanza);
70 return kickable_error_conditions[cond] and cond;
72 local function getUsingPath(stanza, path, getText)
74 for _, name in ipairs(path) do
75 if type(tag) ~= 'table' then return; end
76 tag = tag:child_with_name(name);
78 if tag and getText then tag = table.concat(tag); end
81 local function getTag(stanza, path) return getUsingPath(stanza, path); end
82 local function getText(stanza, path) return getUsingPath(stanza, path, true); end
86 room_mt.__index = room_mt;
88 function room_mt:get_default_role(affiliation)
89 if affiliation == "owner" or affiliation == "admin" then
91 elseif affiliation == "member" or not affiliation then
96 function room_mt:broadcast_presence(stanza, sid, code, nick)
97 stanza = get_filtered_presence(stanza);
98 local occupant = self._occupants[stanza.attr.from];
99 stanza:tag("x", {xmlns='http://jabber.org/protocol/muc#user'})
100 :tag("item", {affiliation=occupant.affiliation or "none", role=occupant.role or "none", nick=nick}):up();
102 stanza:tag("status", {code=code}):up();
104 self:broadcast_except_nick(stanza, stanza.attr.from);
105 local me = self._occupants[stanza.attr.from];
107 stanza:tag("status", {code='110'});
108 stanza.attr.to = sid;
109 self:_route_stanza(stanza);
112 function room_mt:broadcast_message(stanza, historic)
113 local to = stanza.attr.to;
114 for occupant, o_data in pairs(self._occupants) do
115 for jid in pairs(o_data.sessions) do
116 stanza.attr.to = jid;
117 self:_route_stanza(stanza);
121 if historic then -- add to history
122 local history = self._data['history'];
123 if not history then history = {}; self._data['history'] = history; end
124 stanza = st.clone(stanza);
126 local stamp = datetime.datetime();
127 local chars = #tostring(stanza);
128 stanza:tag("delay", {xmlns = "urn:xmpp:delay", from = muc_domain, stamp = stamp}):up(); -- XEP-0203
129 stanza:tag("x", {xmlns = "jabber:x:delay", from = muc_domain, stamp = datetime.legacy()}):up(); -- XEP-0091 (deprecated)
130 local entry = { stanza = stanza, stamp = stamp };
131 t_insert(history, entry);
132 while #history > history_length do t_remove(history, 1) end
135 function room_mt:broadcast_except_nick(stanza, nick)
136 for rnick, occupant in pairs(self._occupants) do
137 if rnick ~= nick then
138 for jid in pairs(occupant.sessions) do
139 stanza.attr.to = jid;
140 self:_route_stanza(stanza);
146 function room_mt:send_occupant_list(to)
147 local current_nick = self._jid_nick[to];
148 for occupant, o_data in pairs(self._occupants) do
149 if occupant ~= current_nick then
150 local pres = get_filtered_presence(o_data.sessions[o_data.jid]);
151 pres.attr.to, pres.attr.from = to, occupant;
152 pres:tag("x", {xmlns='http://jabber.org/protocol/muc#user'})
153 :tag("item", {affiliation=o_data.affiliation or "none", role=o_data.role or "none"}):up();
154 self:_route_stanza(pres);
158 function room_mt:send_history(to, stanza)
159 local history = self._data['history']; -- send discussion history
161 local x_tag = stanza and stanza:get_child("x", "http://jabber.org/protocol/muc");
162 local history_tag = x_tag and x_tag:get_child("history", "http://jabber.org/protocol/muc");
164 local maxchars = history_tag and tonumber(history_tag.attr.maxchars);
165 if maxchars then maxchars = math.floor(maxchars); end
167 local maxstanzas = math.floor(history_tag and tonumber(history_tag.attr.maxstanzas) or #history);
168 if not history_tag then maxstanzas = 20; end
170 local seconds = history_tag and tonumber(history_tag.attr.seconds);
171 if seconds then seconds = datetime.datetime(os.time() - math.floor(seconds)); end
173 local since = history_tag and history_tag.attr.since;
174 if since and not since:match("^%d%d%d%d%-%d%d%-%d%dT%d%d:%d%d:%d%dZ$") then since = nil; end -- FIXME timezone support
175 if seconds and (not since or since < seconds) then since = seconds; end
179 local stanzacount = 0;
181 for i=#history,1,-1 do
182 local entry = history[i];
184 if not entry.chars then
185 entry.stanza.attr.to = "";
186 entry.chars = #tostring(entry.stanza);
188 charcount = charcount + entry.chars + #to;
189 if charcount > maxchars then break; end
191 if since and since > entry.stamp then break; end
192 if n + 1 > maxstanzas then break; end
195 for i=#history-n+1,#history do
196 local msg = history[i].stanza;
198 self:_route_stanza(msg);
201 if self._data['subject'] then
202 self:_route_stanza(st.message({type='groupchat', from=self.jid, to=to}):tag("subject"):text(self._data['subject']));
206 function room_mt:get_disco_info(stanza)
207 return st.reply(stanza):query("http://jabber.org/protocol/disco#info")
208 :tag("identity", {category="conference", type="text"}):up()
209 :tag("feature", {var="http://jabber.org/protocol/muc"});
211 function room_mt:get_disco_items(stanza)
212 local reply = st.reply(stanza):query("http://jabber.org/protocol/disco#items");
213 for room_jid in pairs(self._occupants) do
214 reply:tag("item", {jid = room_jid, name = room_jid:match("/(.*)")}):up();
218 function room_mt:set_subject(current_nick, subject)
219 -- TODO check nick's authority
220 if subject == "" then subject = nil; end
221 self._data['subject'] = subject;
222 if self.save then self:save(); end
223 local msg = st.message({type='groupchat', from=current_nick})
224 :tag('subject'):text(subject):up();
225 self:broadcast_message(msg, false);
229 local function build_unavailable_presence_from_error(stanza)
230 local type, condition, text = stanza:get_error();
231 local error_message = "Kicked: "..condition:gsub("%-", " ");
233 error_message = error_message..": "..text;
235 return st.presence({type='unavailable', from=stanza.attr.from, to=stanza.attr.to})
236 :tag('status'):text(error_message);
239 function room_mt:set_password(password)
240 if password == "" or type(password) ~= "string" then password = nil; end
241 self._data.password = password;
244 function room_mt:get_password()
245 return self._data.password;
248 function room_mt:handle_to_occupant(origin, stanza) -- PM, vCards, etc
249 local from, to = stanza.attr.from, stanza.attr.to;
250 local room = jid_bare(to);
251 local current_nick = self._jid_nick[from];
252 local type = stanza.attr.type;
253 log("debug", "room: %s, current_nick: %s, stanza: %s", room or "nil", current_nick or "nil", stanza:top_tag());
254 if (select(2, jid_split(from)) == muc_domain) then error("Presence from the MUC itself!!!"); end
255 if stanza.name == "presence" then
256 local pr = get_filtered_presence(stanza);
257 pr.attr.from = current_nick;
258 if type == "error" then -- error, kick em out!
260 log("debug", "kicking %s from %s", current_nick, room);
261 self:handle_to_occupant(origin, build_unavailable_presence_from_error(stanza));
263 elseif type == "unavailable" then -- unavailable
265 log("debug", "%s leaving %s", current_nick, room);
266 local occupant = self._occupants[current_nick];
267 local new_jid = next(occupant.sessions);
268 if new_jid == from then new_jid = next(occupant.sessions, new_jid); end
270 local jid = occupant.jid;
271 occupant.jid = new_jid;
272 occupant.sessions[from] = nil;
274 pr:tag("x", {xmlns='http://jabber.org/protocol/muc#user'})
275 :tag("item", {affiliation=occupant.affiliation or "none", role='none'}):up()
276 :tag("status", {code='110'});
277 self:_route_stanza(pr);
278 if jid ~= new_jid then
279 pr = st.clone(occupant.sessions[new_jid])
280 :tag("x", {xmlns='http://jabber.org/protocol/muc#user'})
281 :tag("item", {affiliation=occupant.affiliation or "none", role=occupant.role or "none"});
282 pr.attr.from = current_nick;
283 self:broadcast_except_nick(pr, current_nick);
286 occupant.role = 'none';
287 self:broadcast_presence(pr, from);
288 self._occupants[current_nick] = nil;
290 self._jid_nick[from] = nil;
292 elseif not type then -- available
294 --if #pr == #stanza or current_nick ~= to then -- commented because google keeps resending directed presence
295 if current_nick == to then -- simple presence
296 log("debug", "%s broadcasted presence", current_nick);
297 self._occupants[current_nick].sessions[from] = pr;
298 self:broadcast_presence(pr, from);
300 local occupant = self._occupants[current_nick];
301 local is_multisession = next(occupant.sessions, next(occupant.sessions));
302 if self._occupants[to] or is_multisession then
303 log("debug", "%s couldn't change nick", current_nick);
304 local reply = st.error_reply(stanza, "cancel", "conflict"):up();
305 reply.tags[1].attr.code = "409";
306 origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
308 local data = self._occupants[current_nick];
309 local to_nick = select(3, jid_split(to));
311 log("debug", "%s (%s) changing nick to %s", current_nick, data.jid, to);
312 local p = st.presence({type='unavailable', from=current_nick});
313 self:broadcast_presence(p, from, '303', to_nick);
314 self._occupants[current_nick] = nil;
315 self._occupants[to] = data;
316 self._jid_nick[from] = to;
318 self._occupants[to].sessions[from] = pr;
319 self:broadcast_presence(pr, from);
325 --else -- possible rejoin
326 -- log("debug", "%s had connection replaced", current_nick);
327 -- self:handle_to_occupant(origin, st.presence({type='unavailable', from=from, to=to})
328 -- :tag('status'):text('Replaced by new connection'):up()); -- send unavailable
329 -- self:handle_to_occupant(origin, stanza); -- resend available
334 if self._occupants[to] then
335 if jid_bare(from) ~= jid_bare(self._occupants[to].jid) then
341 log("debug", "%s couldn't join due to nick conflict: %s", from, to);
342 local reply = st.error_reply(stanza, "cancel", "conflict"):up();
343 reply.tags[1].attr.code = "409";
344 origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
346 log("debug", "%s joining as %s", from, to);
347 if not next(self._affiliations) then -- new room, no owners
348 self._affiliations[jid_bare(from)] = "owner";
350 local affiliation = self:get_affiliation(from);
351 local role = self:get_default_role(affiliation)
352 if role then -- new occupant
354 self._occupants[to] = {affiliation=affiliation, role=role, jid=from, sessions={[from]=get_filtered_presence(stanza)}};
356 self._occupants[to].sessions[from] = get_filtered_presence(stanza);
358 self._jid_nick[from] = to;
359 self:send_occupant_list(from);
362 self:broadcast_presence(pr, from);
365 self:_route_stanza(pr:tag("x", {xmlns='http://jabber.org/protocol/muc#user'})
366 :tag("item", {affiliation=affiliation or "none", role=role or "none"}):up()
367 :tag("status", {code='110'}));
369 self:send_history(from, stanza);
371 local reply = st.error_reply(stanza, "auth", "forbidden"):up();
372 reply.tags[1].attr.code = "403";
373 origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
377 elseif type ~= 'result' then -- bad type
378 if type ~= 'visible' and type ~= 'invisible' then -- COMPAT ejabberd can broadcast or forward XEP-0018 presences
379 origin.send(st.error_reply(stanza, "modify", "bad-request")); -- FIXME correct error?
382 elseif not current_nick then -- not in room
383 if type == "error" or type == "result" then
384 local id = stanza.name == "iq" and stanza.attr.id and base64.decode(stanza.attr.id);
385 local _nick, _id, _hash = (id or ""):match("^(.+)%z(.*)%z(.+)$");
386 local occupant = self._occupants[stanza.attr.to];
387 if occupant and _nick and self._jid_nick[_nick] and _id and _hash then
388 local id, _to = stanza.attr.id;
389 for jid in pairs(occupant.sessions) do
390 if md5(jid) == _hash then
396 stanza.attr.to, stanza.attr.from, stanza.attr.id = _to, self._jid_nick[_nick], _id;
397 self:_route_stanza(stanza);
398 stanza.attr.to, stanza.attr.from, stanza.attr.id = to, from, id;
402 origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));
404 elseif stanza.name == "message" and type == "groupchat" then -- groupchat messages not allowed in PM
405 origin.send(st.error_reply(stanza, "modify", "bad-request"));
406 elseif current_nick and stanza.name == "message" and type == "error" and is_kickable_error(stanza) then
407 log("debug", "%s kicked from %s for sending an error message", current_nick, self.jid);
408 self:handle_to_occupant(origin, build_unavailable_presence_from_error(stanza)); -- send unavailable
409 else -- private stanza
410 local o_data = self._occupants[to];
412 log("debug", "%s sent private stanza to %s (%s)", from, to, o_data.jid);
413 local jid = o_data.jid;
414 local bare = jid_bare(jid);
415 stanza.attr.to, stanza.attr.from = jid, current_nick;
416 local id = stanza.attr.id;
417 if stanza.name=='iq' and type=='get' and stanza.tags[1].attr.xmlns == 'vcard-temp' and bare ~= jid then
418 stanza.attr.to = bare;
419 stanza.attr.id = base64.encode(jid.."\0"..id.."\0"..md5(from));
421 self:_route_stanza(stanza);
422 stanza.attr.to, stanza.attr.from, stanza.attr.id = to, from, id;
423 elseif type ~= "error" and type ~= "result" then -- recipient not in room
424 origin.send(st.error_reply(stanza, "cancel", "item-not-found", "Recipient not in room"));
429 function room_mt:send_form(origin, stanza)
430 local title = "Configuration for "..self.jid;
431 origin.send(st.reply(stanza):query("http://jabber.org/protocol/muc#owner")
432 :tag("x", {xmlns='jabber:x:data', type='form'})
433 :tag("title"):text(title):up()
434 :tag("instructions"):text(title):up()
435 :tag("field", {type='hidden', var='FORM_TYPE'}):tag("value"):text("http://jabber.org/protocol/muc#roomconfig"):up():up()
436 :tag("field", {type='boolean', label='Make Room Persistent?', var='muc#roomconfig_persistentroom'})
437 :tag("value"):text(self._data.persistent and "1" or "0"):up()
439 :tag("field", {type='boolean', label='Make Room Publicly Searchable?', var='muc#roomconfig_publicroom'})
440 :tag("value"):text(self._data.hidden and "0" or "1"):up()
442 :tag("field", {type='list-single', label='Who May Discover Real JIDs?', var='muc#roomconfig_whois'})
443 :tag("value"):text(self._data.whois or 'moderators'):up()
444 :tag("option", {label = 'Moderators Only'})
445 :tag("value"):text('moderators'):up()
447 :tag("option", {label = 'Anyone'})
448 :tag("value"):text('anyone'):up()
454 local valid_whois = {
459 function room_mt:process_form(origin, stanza)
460 local query = stanza.tags[1];
462 for _, tag in ipairs(query.tags) do if tag.name == "x" and tag.attr.xmlns == "jabber:x:data" then form = tag; break; end end
463 if not form then origin.send(st.error_reply(stanza, "cancel", "service-unavailable")); return; end
464 if form.attr.type == "cancel" then origin.send(st.reply(stanza)); return; end
465 if form.attr.type ~= "submit" then origin.send(st.error_reply(stanza, "cancel", "bad-request")); return; end
467 for _, field in pairs(form.tags) do
468 if field.name == "field" and field.attr.var and field.tags[1].name == "value" and #field.tags[1].tags == 0 then
469 fields[field.attr.var] = field.tags[1][1] or "";
472 if fields.FORM_TYPE ~= "http://jabber.org/protocol/muc#roomconfig" then origin.send(st.error_reply(stanza, "cancel", "bad-request")); return; end
476 local persistent = fields['muc#roomconfig_persistentroom'];
477 if persistent == "0" or persistent == "false" then persistent = nil; elseif persistent == "1" or persistent == "true" then persistent = true;
478 else origin.send(st.error_reply(stanza, "cancel", "bad-request")); return; end
479 dirty = dirty or (self._data.persistent ~= persistent)
480 self._data.persistent = persistent;
481 module:log("debug", "persistent=%s", tostring(persistent));
483 local public = fields['muc#roomconfig_publicroom'];
484 if public == "0" or public == "false" then public = nil; elseif public == "1" or public == "true" then public = true;
485 else origin.send(st.error_reply(stanza, "cancel", "bad-request")); return; end
486 dirty = dirty or (self._data.hidden ~= (not public and true or nil))
487 self._data.hidden = not public and true or nil;
489 local whois = fields['muc#roomconfig_whois'];
490 if not valid_whois[whois] then
491 origin.send(st.error_reply(stanza, 'cancel', 'bad-request'));
494 local whois_changed = self._data.whois ~= whois
495 self._data.whois = whois
496 module:log('debug', 'whois=%s', tostring(whois))
498 if self.save then self:save(true); end
499 origin.send(st.reply(stanza));
501 if dirty or whois_changed then
502 local msg = st.message({type='groupchat', from=self.jid})
503 :tag('x', {xmlns='http://jabber.org/protocol/muc#user'}):up()
506 msg.tags[1]:tag('status', {code = '104'})
508 if whois_changed then
509 local code = (whois == 'moderators') and 173 or 172
510 msg.tags[1]:tag('status', {code = code})
513 self:broadcast_message(msg, false)
517 function room_mt:destroy(newjid, reason, password)
518 local pr = st.presence({type = "unavailable"})
519 :tag("x", {xmlns = "http://jabber.org/protocol/muc#user"})
520 :tag("item", { affiliation='none', role='none' }):up()
521 :tag("destroy", {jid=newjid})
522 if reason then pr:tag("reason"):text(reason):up(); end
523 if password then pr:tag("password"):text(password):up(); end
524 for nick, occupant in pairs(self._occupants) do
526 for jid in pairs(occupant.sessions) do
528 self:_route_stanza(pr);
529 self._jid_nick[jid] = nil;
531 self._occupants[nick] = nil;
533 self._data.persistent = nil;
534 if self.save then self:save(true); end
537 function room_mt:handle_to_room(origin, stanza) -- presence changes and groupchat messages, along with disco/etc
538 local type = stanza.attr.type;
539 local xmlns = stanza.tags[1] and stanza.tags[1].attr.xmlns;
540 if stanza.name == "iq" then
541 if xmlns == "http://jabber.org/protocol/disco#info" and type == "get" then
542 origin.send(self:get_disco_info(stanza));
543 elseif xmlns == "http://jabber.org/protocol/disco#items" and type == "get" then
544 origin.send(self:get_disco_items(stanza));
545 elseif xmlns == "http://jabber.org/protocol/muc#admin" then
546 local actor = stanza.attr.from;
547 local affiliation = self:get_affiliation(actor);
548 local current_nick = self._jid_nick[actor];
549 local role = current_nick and self._occupants[current_nick].role or self:get_default_role(affiliation);
550 local item = stanza.tags[1].tags[1];
551 if item and item.name == "item" then
552 if type == "set" then
553 local callback = function() origin.send(st.reply(stanza)); end
554 if item.attr.jid then -- Validate provided JID
555 item.attr.jid = jid_prep(item.attr.jid);
556 if not item.attr.jid then
557 origin.send(st.error_reply(stanza, "modify", "jid-malformed"));
561 if not item.attr.jid and item.attr.nick then -- COMPAT Workaround for Miranda sending 'nick' instead of 'jid' when changing affiliation
562 local occupant = self._occupants[self.jid.."/"..item.attr.nick];
563 if occupant then item.attr.jid = occupant.jid; end
564 elseif not item.attr.nick and item.attr.jid then
565 local nick = self._jid_nick[item.attr.jid];
566 if nick then item.attr.nick = select(3, jid_split(nick)); end
568 local reason = item.tags[1] and item.tags[1].name == "reason" and #item.tags[1] == 1 and item.tags[1][1];
569 if item.attr.affiliation and item.attr.jid and not item.attr.role then
570 local success, errtype, err = self:set_affiliation(actor, item.attr.jid, item.attr.affiliation, callback, reason);
571 if not success then origin.send(st.error_reply(stanza, errtype, err)); end
572 elseif item.attr.role and item.attr.nick and not item.attr.affiliation then
573 local success, errtype, err = self:set_role(actor, self.jid.."/"..item.attr.nick, item.attr.role, callback, reason);
574 if not success then origin.send(st.error_reply(stanza, errtype, err)); end
576 origin.send(st.error_reply(stanza, "cancel", "bad-request"));
578 elseif type == "get" then
579 local _aff = item.attr.affiliation;
580 local _rol = item.attr.role;
581 if _aff and not _rol then
582 if affiliation == "owner" or (affiliation == "admin" and _aff ~= "owner" and _aff ~= "admin") then
583 local reply = st.reply(stanza):query("http://jabber.org/protocol/muc#admin");
584 for jid, affiliation in pairs(self._affiliations) do
585 if affiliation == _aff then
586 reply:tag("item", {affiliation = _aff, jid = jid}):up();
591 origin.send(st.error_reply(stanza, "auth", "forbidden"));
593 elseif _rol and not _aff then
594 if role == "moderator" then
595 -- TODO allow admins and owners not in room? Provide read-only access to everyone who can see the participants anyway?
596 if _rol == "none" then _rol = nil; end
597 local reply = st.reply(stanza):query("http://jabber.org/protocol/muc#admin");
598 for occupant_jid, occupant in pairs(self._occupants) do
599 if occupant.role == _rol then
601 nick = select(3, jid_split(occupant_jid)),
602 role = _rol or "none",
603 affiliation = occupant.affiliation or "none",
610 origin.send(st.error_reply(stanza, "auth", "forbidden"));
613 origin.send(st.error_reply(stanza, "cancel", "bad-request"));
616 elseif type == "set" or type == "get" then
617 origin.send(st.error_reply(stanza, "cancel", "bad-request"));
619 elseif xmlns == "http://jabber.org/protocol/muc#owner" and (type == "get" or type == "set") and stanza.tags[1].name == "query" then
620 if self:get_affiliation(stanza.attr.from) ~= "owner" then
621 origin.send(st.error_reply(stanza, "auth", "forbidden"));
622 elseif stanza.attr.type == "get" then
623 self:send_form(origin, stanza);
624 elseif stanza.attr.type == "set" then
625 local child = stanza.tags[1].tags[1];
627 origin.send(st.error_reply(stanza, "auth", "bad-request"));
628 elseif child.name == "destroy" then
629 local newjid = child.attr.jid;
630 local reason, password;
631 for _,tag in ipairs(child.tags) do
632 if tag.name == "reason" then
633 reason = #tag.tags == 0 and tag[1];
634 elseif tag.name == "password" then
635 password = #tag.tags == 0 and tag[1];
638 self:destroy(newjid, reason, password);
639 origin.send(st.reply(stanza));
641 self:process_form(origin, stanza);
644 elseif type == "set" or type == "get" then
645 origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
647 elseif stanza.name == "message" and type == "groupchat" then
648 local from, to = stanza.attr.from, stanza.attr.to;
649 local room = jid_bare(to);
650 local current_nick = self._jid_nick[from];
651 local occupant = self._occupants[current_nick];
652 if not occupant then -- not in room
653 origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));
654 elseif occupant.role == "visitor" then
655 origin.send(st.error_reply(stanza, "cancel", "forbidden"));
657 local from = stanza.attr.from;
658 stanza.attr.from = current_nick;
659 local subject = getText(stanza, {"subject"});
661 if occupant.role == "moderator" then
662 self:set_subject(current_nick, subject); -- TODO use broadcast_message_stanza
664 stanza.attr.from = from;
665 origin.send(st.error_reply(stanza, "cancel", "forbidden"));
668 self:broadcast_message(stanza, true);
670 stanza.attr.from = from;
672 elseif stanza.name == "message" and type == "error" and is_kickable_error(stanza) then
673 local current_nick = self._jid_nick[stanza.attr.from];
674 log("debug", "%s kicked from %s for sending an error message", current_nick, self.jid);
675 self:handle_to_occupant(origin, build_unavailable_presence_from_error(stanza)); -- send unavailable
676 elseif stanza.name == "presence" then -- hack - some buggy clients send presence updates to the room rather than their nick
677 local to = stanza.attr.to;
678 local current_nick = self._jid_nick[stanza.attr.from];
680 stanza.attr.to = current_nick;
681 self:handle_to_occupant(origin, stanza);
683 elseif type ~= "error" and type ~= "result" then
684 origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
686 elseif stanza.name == "message" and not stanza.attr.type and #stanza.tags == 1 and self._jid_nick[stanza.attr.from]
687 and stanza.tags[1].name == "x" and stanza.tags[1].attr.xmlns == "http://jabber.org/protocol/muc#user" then
688 local x = stanza.tags[1];
689 local payload = (#x.tags == 1 and x.tags[1]);
690 if payload and payload.name == "invite" and payload.attr.to then
691 local _from, _to = stanza.attr.from, stanza.attr.to;
692 local _invitee = jid_prep(payload.attr.to);
694 local _reason = payload.tags[1] and payload.tags[1].name == 'reason' and #payload.tags[1].tags == 0 and payload.tags[1][1];
695 local invite = st.message({from = _to, to = _invitee, id = stanza.attr.id})
696 :tag('x', {xmlns='http://jabber.org/protocol/muc#user'})
697 :tag('invite', {from=_from})
698 :tag('reason'):text(_reason or ""):up()
701 :tag('x', {xmlns="jabber:x:conference", jid=_to}) -- COMPAT: Some older clients expect this
704 :tag('body') -- Add a plain message for clients which don't support invites
705 :text(_from..' invited you to the room '.._to..(_reason and (' ('.._reason..')') or ""))
707 self:_route_stanza(invite);
709 origin.send(st.error_reply(stanza, "cancel", "jid-malformed"));
712 origin.send(st.error_reply(stanza, "cancel", "bad-request"));
715 if type == "error" or type == "result" then return; end
716 origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
720 function room_mt:handle_stanza(origin, stanza)
721 local to_node, to_host, to_resource = jid_split(stanza.attr.to);
723 self:handle_to_occupant(origin, stanza);
725 self:handle_to_room(origin, stanza);
729 function room_mt:route_stanza(stanza) end -- Replace with a routing function, e.g., function(room, stanza) core_route_stanza(origin, stanza); end
731 function room_mt:get_affiliation(jid)
732 local node, host, resource = jid_split(jid);
733 local bare = node and node.."@"..host or host;
734 local result = self._affiliations[bare]; -- Affiliations are granted, revoked, and maintained based on the user's bare JID.
735 if not result and self._affiliations[host] == "outcast" then result = "outcast"; end -- host banned
738 function room_mt:set_affiliation(actor, jid, affiliation, callback, reason)
740 if affiliation == "none" then affiliation = nil; end
741 if affiliation and affiliation ~= "outcast" and affiliation ~= "owner" and affiliation ~= "admin" and affiliation ~= "member" then
742 return nil, "modify", "not-acceptable";
744 if self:get_affiliation(actor) ~= "owner" then return nil, "cancel", "not-allowed"; end
745 if jid_bare(actor) == jid then return nil, "cancel", "not-allowed"; end
746 self._affiliations[jid] = affiliation;
747 local role = self:get_default_role(affiliation);
748 local p = st.presence()
749 :tag("x", {xmlns = "http://jabber.org/protocol/muc#user"})
750 :tag("item", {affiliation=affiliation or "none", role=role or "none"})
751 :tag("reason"):text(reason or ""):up()
754 local item = x.tags[1];
755 if not role then -- getting kicked
756 p.attr.type = "unavailable";
757 if affiliation == "outcast" then
758 x:tag("status", {code="301"}):up(); -- banned
760 x:tag("status", {code="321"}):up(); -- affiliation change
763 local modified_nicks = {};
764 for nick, occupant in pairs(self._occupants) do
765 if jid_bare(occupant.jid) == jid then
766 if not role then -- getting kicked
767 self._occupants[nick] = nil;
769 t_insert(modified_nicks, nick);
770 occupant.affiliation, occupant.role = affiliation, role;
773 for jid in pairs(occupant.sessions) do -- remove for all sessions of the nick
774 if not role then self._jid_nick[jid] = nil; end
776 self:_route_stanza(p);
780 if self.save then self:save(); end
781 if callback then callback(); end
782 for _, nick in ipairs(modified_nicks) do
784 self:broadcast_except_nick(p, nick);
789 function room_mt:get_role(nick)
790 local session = self._occupants[nick];
791 return session and session.role or nil;
793 function room_mt:set_role(actor, occupant_jid, role, callback, reason)
794 if role == "none" then role = nil; end
795 if role and role ~= "moderator" and role ~= "participant" and role ~= "visitor" then return nil, "modify", "not-acceptable"; end
796 if self:get_affiliation(actor) ~= "owner" then return nil, "cancel", "not-allowed"; end
797 local occupant = self._occupants[occupant_jid];
798 if not occupant then return nil, "modify", "not-acceptable"; end
799 if occupant.affiliation == "owner" or occupant.affiliation == "admin" then return nil, "cancel", "not-allowed"; end
800 local p = st.presence({from = occupant_jid})
801 :tag("x", {xmlns = "http://jabber.org/protocol/muc#user"})
802 :tag("item", {affiliation=occupant.affiliation or "none", nick=select(3, jid_split(occupant_jid)), role=role or "none"})
803 :tag("reason"):text(reason or ""):up()
805 if not role then -- kick
806 p.attr.type = "unavailable";
807 self._occupants[occupant_jid] = nil;
808 for jid in pairs(occupant.sessions) do -- remove for all sessions of the nick
809 self._jid_nick[jid] = nil;
811 p:tag("status", {code = "307"}):up();
813 occupant.role = role;
815 for jid in pairs(occupant.sessions) do -- send to all sessions of the nick
817 self:_route_stanza(p);
819 if callback then callback(); end
820 self:broadcast_except_nick(p, occupant_jid);
824 function room_mt:_route_stanza(stanza)
826 local to_occupant = self._occupants[self._jid_nick[stanza.attr.to]];
827 local from_occupant = self._occupants[stanza.attr.from];
828 if stanza.name == "presence" then
829 if to_occupant and from_occupant then
830 if self._data.whois == 'anyone' then
831 muc_child = stanza:get_child("x", "http://jabber.org/protocol/muc#user");
833 if to_occupant.role == "moderator" or jid_bare(to_occupant.jid) == jid_bare(from_occupant.jid) then
834 muc_child = stanza:get_child("x", "http://jabber.org/protocol/muc#user");
840 for _, item in pairs(muc_child.tags) do
841 if item.name == "item" then
842 if from_occupant == to_occupant then
843 item.attr.jid = stanza.attr.to;
845 item.attr.jid = from_occupant.jid;
849 if self._data.whois == 'anyone' then
850 muc_child:tag('status', { code = '100' });
853 self:route_stanza(stanza);
855 for _, item in pairs(muc_child.tags) do
856 if item.name == "item" then
863 local _M = {}; -- module "muc"
865 function _M.new_room(jid)
866 return setmetatable({
871 whois = 'moderators',