35dd9eac6ca4c94d6ced53e468d84a66e09b0201
[prosody.git] / plugins / muc / muc.lib.lua
1 -- Prosody IM
2 -- Copyright (C) 2008-2010 Matthew Wild
3 -- Copyright (C) 2008-2010 Waqas Hussain
4 -- Copyright (C) 2014 Daurnimator
5 --
6 -- This project is MIT/X11 licensed. Please see the
7 -- COPYING file in the source package for more information.
8 --
9
10 local select = select;
11 local pairs, ipairs = pairs, ipairs;
12 local next = next;
13 local setmetatable = setmetatable;
14
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;
24
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;
29
30 local room_mt = {};
31 room_mt.__index = room_mt;
32
33 function room_mt:__tostring()
34         return "MUC room ("..self.jid..")";
35 end
36
37 function room_mt:get_occupant_jid(real_jid)
38         return self._jid_nick[real_jid]
39 end
40
41 function room_mt:get_default_role(affiliation)
42         local role = module:fire_event("muc-get-default-role", {
43                 room = self;
44                 affiliation = affiliation;
45                 affiliation_rank = valid_affiliations[affiliation or "none"];
46         });
47         return role, valid_roles[role or "none"];
48 end
49 module:hook("muc-get-default-role", function(event)
50         if event.affiliation_rank >= valid_affiliations.admin then
51                 return "moderator";
52         elseif event.affiliation_rank >= valid_affiliations.none then
53                 return "participant";
54         end
55 end);
56
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);
62         return occupant;
63 end
64
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);
69 end
70
71 do
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);
76         end
77         function room_mt:each_occupant(read_only)
78                 return next_copied_occupant, self._occupants, nil;
79         end
80 end
81
82 function room_mt:has_occupant()
83         return next(self._occupants, nil) ~= nil
84 end
85
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);
90 end
91
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
95
96         -- Need to maintain _jid_nick secondary index
97         local old_occupant = self._occupants[id];
98         if old_occupant then
99                 for real_jid in pairs(old_occupant.sessions) do
100                         self._jid_nick[real_jid] = nil;
101                 end
102         end
103
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;
110                         end
111                 end
112                 if not has_live_session then
113                         -- Has no live sessions left; they have left the room.
114                         occupant.role = nil
115                 end
116         end
117         if not has_live_session then
118                 occupant = nil
119         end
120         self._occupants[id] = occupant
121 end
122
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);
128         end
129         stanza.attr.to = to;
130 end
131
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;})
135         if actor then
136                 x:tag("actor", actor):up()
137         end
138         if reason then
139                 x:tag("reason"):text(reason):up()
140         end
141         x:up();
142         return x
143 end
144
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";
149         local actor_attr;
150         if actor then
151                 actor_attr = {nick = select(3,jid_split(self:get_occupant_jid(actor)))};
152         end
153         if is_anonymous then
154                 add_item(x, affiliation, role, nil, nick, actor_attr, reason);
155         else
156                 if actor_attr then
157                         actor_attr.jid = actor;
158                 end
159                 for real_jid, session in occupant:each_session() do
160                         add_item(x, affiliation, role, real_jid, nick, actor_attr, reason);
161                 end
162         end
163         return x
164 end
165
166 function room_mt:broadcast_message(stanza)
167         if module:fire_event("muc-broadcast-message", {room = self, stanza = stanza}) then
168                 return true;
169         end
170         self:broadcast(stanza);
171         return true;
172 end
173
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)
180                 end
181         end
182 end
183
184 local function can_see_real_jids(whois, occupant)
185         if whois == "anyone" then
186                 return true;
187         elseif whois == "moderators" then
188                 return valid_roles[occupant.role or "none"] >= valid_roles.moderator;
189         end
190 end
191
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;
197         if occupant.role ~= nil then
198                 -- Try to use main jid's presence
199                 local pr = occupant:get_presence();
200                 if pr ~= nil then
201                         base_presence = st.clone(pr);
202                 end
203         end
204         base_presence = base_presence or st.presence {from = occupant.nick; type = "unavailable";};
205
206         -- Fire event (before full_p and anon_p are created)
207         module:fire_event("muc-broadcast-presence", {
208                 room = self; stanza = base_presence; x = base_x;
209                 occupant = occupant; nick = nick; actor = actor;
210                 reason = reason;
211         });
212
213         local function get_presence(is_anonymous)
214                 local x = st.clone(base_x);
215                 self:build_item_list(occupant, x, is_anonymous, nick, actor, reason);
216                 return st.clone(base_presence):add_child(x), x;
217         end
218
219         local full_p, full_x = get_presence(false);
220
221         -- Create anon_p lazily
222         local anon_p, anon_x;
223         local function get_anon_p()
224                 if anon_p == nil then
225                         anon_p, anon_x = get_presence(true);
226                 end
227                 return anon_p, anon_x;
228         end
229
230         local whois = self:get_whois();
231
232         -- General populance
233         for nick, n_occupant in self:each_occupant() do
234                 if nick ~= occupant.nick then
235                         local pr;
236                         if can_see_real_jids(whois, n_occupant) or occupant.bare_jid == n_occupant.bare_jid then
237                                 pr = full_p;
238                         else
239                                 pr = get_anon_p();
240                         end
241                         self:route_to_occupant(n_occupant, pr);
242                 end
243         end
244
245         -- Presences for occupant itself
246         full_x:tag("status", {code = "110";}):up();
247         if occupant.role == nil then
248                 -- They get an unavailable
249                 self:route_to_occupant(occupant, full_p);
250         else
251                 -- use their own presences as templates
252                 for full_jid, pr in occupant:each_session() do
253                         pr = st.clone(pr);
254                         pr.attr.to = full_jid;
255                         -- You can always see your own full jids
256                         pr:add_child(full_x);
257                         self:route_stanza(pr);
258                 end
259         end
260 end
261
262 function room_mt:send_occupant_list(to, filter)
263         local to_bare = jid_bare(to);
264         local is_anonymous = false;
265         local whois = self:get_whois();
266         if whois ~= "anyone" then
267                 local affiliation = self:get_affiliation(to);
268                 if affiliation ~= "admin" and affiliation ~= "owner" then
269                         local occupant = self:get_occupant_by_real_jid(to);
270                         if not (occupant and can_see_real_jids(whois, occupant)) then
271                                 is_anonymous = true;
272                         end
273                 end
274         end
275         for occupant_jid, occupant in self:each_occupant() do
276                 if filter == nil or filter(occupant_jid, occupant) then
277                         local x = st.stanza("x", {xmlns='http://jabber.org/protocol/muc#user'});
278                         self:build_item_list(occupant, x, is_anonymous and to_bare ~= occupant.bare_jid); -- can always see your own jids
279                         local pres = st.clone(occupant:get_presence());
280                         pres.attr.to = to;
281                         pres:add_child(x);
282                         self:route_stanza(pres);
283                 end
284         end
285 end
286
287 function room_mt:get_disco_info(stanza)
288         local reply = st.reply(stanza):query("http://jabber.org/protocol/disco#info");
289         local form = dataform.new {
290                 { name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/protocol/muc#roominfo" };
291         };
292         module:fire_event("muc-disco#info", {room = self; reply = reply; form = form;});
293         reply:add_child(form:form(nil, "result"));
294         return reply;
295 end
296 module:hook("muc-disco#info", function(event)
297         event.reply:tag("feature", {var = "http://jabber.org/protocol/muc"}):up();
298 end);
299 module:hook("muc-disco#info", function(event)
300         local count = iterators.count(event.room:each_occupant());
301         table.insert(event.form, { name = "muc#roominfo_occupants", label = "Number of occupants", value = tostring(count) });
302 end);
303
304 function room_mt:get_disco_items(stanza)
305         local reply = st.reply(stanza):query("http://jabber.org/protocol/disco#items");
306         for room_jid in self:each_occupant() do
307                 reply:tag("item", {jid = room_jid, name = room_jid:match("/(.*)")}):up();
308         end
309         return reply;
310 end
311
312 function room_mt:handle_kickable(origin, stanza)
313         local real_jid = stanza.attr.from;
314         local occupant = self:get_occupant_by_real_jid(real_jid);
315         if occupant == nil then return nil; end
316         local type, condition, text = stanza:get_error();
317         local error_message = "Kicked: "..(condition and condition:gsub("%-", " ") or "presence error");
318         if text then
319                 error_message = error_message..": "..text;
320         end
321         occupant:set_session(real_jid, st.presence({type="unavailable"})
322                 :tag('status'):text(error_message));
323         self:save_occupant(occupant);
324         local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";})
325                 :tag("status", {code = "307"})
326         self:publicise_occupant_status(occupant, x);
327         return true;
328 end
329
330 -- Give the room creator owner affiliation
331 module:hook("muc-room-pre-create", function(event)
332         event.room:set_affiliation(true, jid_bare(event.stanza.attr.from), "owner");
333 end, -1);
334
335 -- check if user is banned
336 module:hook("muc-occupant-pre-join", function(event)
337         local room, stanza = event.room, event.stanza;
338         local affiliation = room:get_affiliation(stanza.attr.from);
339         if affiliation == "outcast" then
340                 local reply = st.error_reply(stanza, "auth", "forbidden"):up();
341                 reply.tags[1].attr.code = "403";
342                 event.origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
343                 return true;
344         end
345 end, -10);
346
347 function room_mt:handle_presence_to_occupant(origin, stanza)
348         local type = stanza.attr.type;
349         if type == "error" then -- error, kick em out!
350                 return self:handle_kickable(origin, stanza)
351         elseif type == nil or type == "unavailable" then
352                 local real_jid = stanza.attr.from;
353                 local bare_jid = jid_bare(real_jid);
354                 local orig_occupant, dest_occupant;
355                 local is_new_room = next(self._affiliations) == nil;
356                 if is_new_room then
357                         if type == "unavailable" then return true; end -- Unavailable from someone not in the room
358                         if module:fire_event("muc-room-pre-create", {
359                                         room = self;
360                                         origin = origin;
361                                         stanza = stanza;
362                                 }) then return true; end
363                 else
364                         orig_occupant = self:get_occupant_by_real_jid(real_jid);
365                         if type == "unavailable" and orig_occupant == nil then return true; end -- Unavailable from someone not in the room
366                 end
367                 local is_first_dest_session;
368                 if type == "unavailable" then
369                         -- dest_occupant = nil
370                 elseif orig_occupant and orig_occupant.nick == stanza.attr.to then -- Just a presence update
371                         log("debug", "presence update for %s from session %s", orig_occupant.nick, real_jid);
372                         dest_occupant = orig_occupant;
373                 else
374                         local dest_jid = stanza.attr.to;
375                         dest_occupant = self:get_occupant_by_nick(dest_jid);
376                         if dest_occupant == nil then
377                                 log("debug", "no occupant found for %s; creating new occupant object for %s", dest_jid, real_jid);
378                                 is_first_dest_session = true;
379                                 dest_occupant = self:new_occupant(bare_jid, dest_jid);
380                         else
381                                 is_first_dest_session = false;
382                         end
383                 end
384                 local is_last_orig_session;
385                 if orig_occupant ~= nil then
386                         -- Is there are least 2 sessions?
387                         local iter, ob, last = orig_occupant:each_session();
388                         is_last_orig_session = iter(ob, iter(ob, last)) == nil;
389                 end
390
391                 local event, event_name = {
392                         room = self;
393                         origin = origin;
394                         stanza = stanza;
395                         is_first_session = is_first_dest_session;
396                         is_last_session = is_last_orig_session;
397                 };
398                 if orig_occupant == nil then
399                         event_name = "muc-occupant-pre-join";
400                         event.is_new_room = is_new_room;
401                 elseif dest_occupant == nil then
402                         event_name = "muc-occupant-pre-leave";
403                 else
404                         event_name = "muc-occupant-pre-change";
405                 end
406                 if module:fire_event(event_name, event) then return true; end
407
408                 -- Check for nick conflicts
409                 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
410                         log("debug", "%s couldn't join due to nick conflict: %s", real_jid, dest_occupant.nick);
411                         local reply = st.error_reply(stanza, "cancel", "conflict"):up();
412                         reply.tags[1].attr.code = "409";
413                         origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
414                         return true;
415                 end
416
417                 -- Send presence stanza about original occupant
418                 if orig_occupant ~= nil and orig_occupant ~= dest_occupant then
419                         local orig_x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";});
420                         local dest_nick;
421                         if dest_occupant == nil then -- Session is leaving
422                                 log("debug", "session %s is leaving occupant %s", real_jid, orig_occupant.nick);
423                                 if is_last_orig_session then
424                                         orig_occupant.role = nil;
425                                 end
426                                 orig_occupant:set_session(real_jid, stanza);
427                         else
428                                 log("debug", "session %s is changing from occupant %s to %s", real_jid, orig_occupant.nick, dest_occupant.nick);
429                                 local generated_unavail = st.presence {from = orig_occupant.nick, to = real_jid, type = "unavailable"};
430                                 orig_occupant:set_session(real_jid, generated_unavail);
431                                 dest_nick = select(3, jid_split(dest_occupant.nick));
432                                 if not is_first_dest_session then -- User is swapping into another pre-existing session
433                                         log("debug", "session %s is swapping into multisession %s, showing it leave.", real_jid, dest_occupant.nick);
434                                         -- Show the other session leaving
435                                         local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";})
436                                                 :tag("status"):text("you are joining pre-existing session " .. dest_nick):up();
437                                         add_item(x, self:get_affiliation(bare_jid), "none");
438                                         local pr = st.presence{from = dest_occupant.nick, to = real_jid, type = "unavailable"}
439                                                 :add_child(x);
440                                         self:route_stanza(pr);
441                                 end
442                                 if is_first_dest_session and is_last_orig_session then -- Normal nick change
443                                         log("debug", "no sessions in %s left; publically marking as nick change", orig_occupant.nick);
444                                         orig_x:tag("status", {code = "303";}):up();
445                                 else -- The session itself always needs to see a nick change
446                                         -- don't want to get our old nick's available presence,
447                                         -- so remove our session from there, and manually generate an unavailable
448                                         orig_occupant:remove_session(real_jid);
449                                         log("debug", "generating nick change for %s", real_jid);
450                                         local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";});
451                                         -- self:build_item_list(orig_occupant, x, false, dest_nick); -- COMPAT: clients get confused if they see other items besides their own
452                                         add_item(x, self:get_affiliation(bare_jid), orig_occupant.role, real_jid, dest_nick);
453                                         x:tag("status", {code = "303";}):up();
454                                         x:tag("status", {code = "110";}):up();
455                                         self:route_stanza(generated_unavail:add_child(x));
456                                         dest_nick = nil; -- set dest_nick to nil; so general populance doesn't see it for whole orig_occupant
457                                 end
458                         end
459                         self:save_occupant(orig_occupant);
460                         self:publicise_occupant_status(orig_occupant, orig_x, dest_nick);
461
462                         if is_last_orig_session then
463                                 module:fire_event("muc-occupant-left", {room = self; nick = orig_occupant.nick;});
464                         end
465                 end
466
467                 if dest_occupant ~= nil then
468                         dest_occupant:set_session(real_jid, stanza);
469                         local dest_x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";});
470                         if is_new_room then
471                                 dest_x:tag("status", {code = "201"}):up();
472                         end
473                         if orig_occupant == nil and self:get_whois() == "anyone" then
474                                 dest_x:tag("status", {code = "100"}):up();
475                         end
476                         self:save_occupant(dest_occupant);
477
478                         if orig_occupant == nil then
479                                 -- Send occupant list to newly joined user
480                                 self:send_occupant_list(real_jid, function(nick, occupant)
481                                         -- Don't include self
482                                         return occupant:get_presence(real_jid) == nil;
483                                 end)
484                         end
485                         self:publicise_occupant_status(dest_occupant, dest_x);
486
487                         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
488                                 log("debug", "session %s split nicks; showing %s rejoining", real_jid, orig_occupant.nick);
489                                 -- Show the original nick joining again
490                                 local pr = st.clone(orig_occupant:get_presence());
491                                 pr.attr.to = real_jid;
492                                 local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";});
493                                 self:build_item_list(orig_occupant, x, false);
494                                 -- TODO: new status code to inform client this was the multi-session it left?
495                                 pr:add_child(x);
496                                 self:route_stanza(pr);
497                         end
498
499                         if orig_occupant == nil then
500                                 if is_first_dest_session then
501                                         module:fire_event("muc-occupant-joined", {room = self; nick = dest_occupant.nick; stanza = stanza;});
502                                 end
503                                 module:fire_event("muc-occupant-session-new", {room = self; nick = dest_occupant.nick; stanza = stanza; jid = real_jid;});
504                         end
505                 end
506         elseif type ~= 'result' then -- bad type
507                 if type ~= 'visible' and type ~= 'invisible' then -- COMPAT ejabberd can broadcast or forward XEP-0018 presences
508                         origin.send(st.error_reply(stanza, "modify", "bad-request")); -- FIXME correct error?
509                 end
510         end
511         return true;
512 end
513
514 function room_mt:handle_iq_to_occupant(origin, stanza)
515         local from, to = stanza.attr.from, stanza.attr.to;
516         local type = stanza.attr.type;
517         local id = stanza.attr.id;
518         local occupant = self:get_occupant_by_nick(to);
519         if (type == "error" or type == "result") then
520                 do -- deconstruct_stanza_id
521                         if not occupant then return nil; end
522                         local from_jid, id, to_jid_hash = (base64.decode(stanza.attr.id) or ""):match("^(.+)%z(.*)%z(.+)$");
523                         if not(from == from_jid or from == jid_bare(from_jid)) then return nil; end
524                         local from_occupant_jid = self:get_occupant_jid(from_jid);
525                         if from_occupant_jid == nil then return nil; end
526                         local session_jid
527                         for to_jid in occupant:each_session() do
528                                 if md5(to_jid) == to_jid_hash then
529                                         session_jid = to_jid;
530                                         break;
531                                 end
532                         end
533                         if session_jid == nil then return nil; end
534                         stanza.attr.from, stanza.attr.to, stanza.attr.id = from_occupant_jid, session_jid, id;
535                 end
536                 log("debug", "%s sent private iq stanza to %s (%s)", from, to, stanza.attr.to);
537                 self:route_stanza(stanza);
538                 stanza.attr.from, stanza.attr.to, stanza.attr.id = from, to, id;
539                 return true;
540         else -- Type is "get" or "set"
541                 local current_nick = self:get_occupant_jid(from);
542                 if not current_nick then
543                         origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));
544                         return true;
545                 end
546                 if not occupant then -- recipient not in room
547                         origin.send(st.error_reply(stanza, "cancel", "item-not-found", "Recipient not in room"));
548                         return true;
549                 end
550                 do -- construct_stanza_id
551                         stanza.attr.id = base64.encode(occupant.jid.."\0"..stanza.attr.id.."\0"..md5(from));
552                 end
553                 stanza.attr.from, stanza.attr.to = current_nick, occupant.jid;
554                 log("debug", "%s sent private iq stanza to %s (%s)", from, to, occupant.jid);
555                 if stanza.tags[1].attr.xmlns == 'vcard-temp' then
556                         stanza.attr.to = jid_bare(stanza.attr.to);
557                 end
558                 self:route_stanza(stanza);
559                 stanza.attr.from, stanza.attr.to, stanza.attr.id = from, to, id;
560                 return true;
561         end
562 end
563
564 function room_mt:handle_message_to_occupant(origin, stanza)
565         local from, to = stanza.attr.from, stanza.attr.to;
566         local current_nick = self:get_occupant_jid(from);
567         local type = stanza.attr.type;
568         if not current_nick then -- not in room
569                 if type ~= "error" then
570                         origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));
571                 end
572                 return true;
573         end
574         if type == "groupchat" then -- groupchat messages not allowed in PM
575                 origin.send(st.error_reply(stanza, "modify", "bad-request"));
576                 return true;
577         elseif type == "error" and is_kickable_error(stanza) then
578                 log("debug", "%s kicked from %s for sending an error message", current_nick, self.jid);
579                 return self:handle_kickable(origin, stanza); -- send unavailable
580         end
581
582         local o_data = self:get_occupant_by_nick(to);
583         if not o_data then
584                 origin.send(st.error_reply(stanza, "cancel", "item-not-found", "Recipient not in room"));
585                 return true;
586         end
587         log("debug", "%s sent private message stanza to %s (%s)", from, to, o_data.jid);
588         stanza:tag("x", { xmlns = "http://jabber.org/protocol/muc#user" }):up();
589         stanza.attr.from = current_nick;
590         self:route_to_occupant(o_data, stanza)
591         -- TODO: Remove x tag?
592         stanza.attr.from = from;
593         return true;
594 end
595
596 function room_mt:send_form(origin, stanza)
597         origin.send(st.reply(stanza):query("http://jabber.org/protocol/muc#owner")
598                 :add_child(self:get_form_layout(stanza.attr.from):form())
599         );
600 end
601
602 function room_mt:get_form_layout(actor)
603         local form = dataform.new({
604                 title = "Configuration for "..self.jid,
605                 instructions = "Complete and submit this form to configure the room.",
606                 {
607                         name = 'FORM_TYPE',
608                         type = 'hidden',
609                         value = 'http://jabber.org/protocol/muc#roomconfig'
610                 }
611         });
612         return module:fire_event("muc-config-form", { room = self, actor = actor, form = form }) or form;
613 end
614
615 function room_mt:process_form(origin, stanza)
616         local form = stanza.tags[1]:get_child("x", "jabber:x:data");
617         if form.attr.type == "cancel" then
618                 origin.send(st.reply(stanza));
619         elseif form.attr.type == "submit" then
620                 local fields;
621                 if form.tags[1] == nil then -- Instant room
622                         fields = {};
623                 else
624                         fields = self:get_form_layout(stanza.attr.from):data(form);
625                         if fields.FORM_TYPE ~= "http://jabber.org/protocol/muc#roomconfig" then
626                                 origin.send(st.error_reply(stanza, "cancel", "bad-request", "Form is not of type room configuration"));
627                                 return true;
628                         end
629                 end
630
631                 local event = {room = self; origin = origin; stanza = stanza; fields = fields; status_codes = {};};
632                 function event.update_option(name, field, allowed)
633                         local new = fields[field];
634                         if new == nil then return; end
635                         if allowed and not allowed[new] then return; end
636                         if new == self["get_"..name](self) then return; end
637                         event.status_codes["104"] = true;
638                         self["set_"..name](self, new);
639                         return true;
640                 end
641                 module:fire_event("muc-config-submitted", event);
642
643                 if self.save then self:save(true); end
644                 origin.send(st.reply(stanza));
645
646                 if next(event.status_codes) then
647                         local msg = st.message({type='groupchat', from=self.jid})
648                                 :tag('x', {xmlns='http://jabber.org/protocol/muc#user'})
649                         for code in pairs(event.status_codes) do
650                                 msg:tag("status", {code = code;}):up();
651                         end
652                         msg:up();
653                         self:broadcast_message(msg);
654                 end
655         else
656                 origin.send(st.error_reply(stanza, "cancel", "bad-request", "Not a submitted form"));
657         end
658         return true;
659 end
660
661 -- Removes everyone from the room
662 function room_mt:clear(x)
663         x = x or st.stanza("x", {xmlns='http://jabber.org/protocol/muc#user'});
664         local occupants_updated = {};
665         for nick, occupant in self:each_occupant() do
666                 occupant.role = nil;
667                 self:save_occupant(occupant);
668                 occupants_updated[occupant] = true;
669         end
670         for occupant in pairs(occupants_updated) do
671                 self:publicise_occupant_status(occupant, x);
672                 module:fire_event("muc-occupant-left", { room = self; nick = occupant.nick; });
673         end
674 end
675
676 function room_mt:destroy(newjid, reason, password)
677         local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"})
678                 :tag("item", { affiliation='none', role='none' }):up()
679                 :tag("destroy", {jid=newjid});
680         if reason then x:tag("reason"):text(reason):up(); end
681         if password then x:tag("password"):text(password):up(); end
682         x:up();
683         self:clear(x);
684         module:fire_event("muc-room-destroyed", { room = self });
685 end
686
687 function room_mt:handle_disco_info_get_query(origin, stanza)
688         origin.send(self:get_disco_info(stanza));
689         return true;
690 end
691
692 function room_mt:handle_disco_items_get_query(origin, stanza)
693         origin.send(self:get_disco_items(stanza));
694         return true;
695 end
696
697 function room_mt:handle_admin_query_set_command(origin, stanza)
698         local item = stanza.tags[1].tags[1];
699         if item.attr.jid then -- Validate provided JID
700                 item.attr.jid = jid_prep(item.attr.jid);
701                 if not item.attr.jid then
702                         origin.send(st.error_reply(stanza, "modify", "jid-malformed"));
703                         return true;
704                 end
705         end
706         if not item.attr.jid and item.attr.nick then -- COMPAT Workaround for Miranda sending 'nick' instead of 'jid' when changing affiliation
707                 local occupant = self:get_occupant_by_nick(self.jid.."/"..item.attr.nick);
708                 if occupant then item.attr.jid = occupant.jid; end
709         elseif not item.attr.nick and item.attr.jid then
710                 local nick = self:get_occupant_jid(item.attr.jid);
711                 if nick then item.attr.nick = select(3, jid_split(nick)); end
712         end
713         local actor = stanza.attr.from;
714         local reason = item:get_child_text("reason");
715         local success, errtype, err
716         if item.attr.affiliation and item.attr.jid and not item.attr.role then
717                 success, errtype, err = self:set_affiliation(actor, item.attr.jid, item.attr.affiliation, reason);
718         elseif item.attr.role and item.attr.nick and not item.attr.affiliation then
719                 success, errtype, err = self:set_role(actor, self.jid.."/"..item.attr.nick, item.attr.role, reason);
720         else
721                 success, errtype, err = nil, "cancel", "bad-request";
722         end
723         if not success then origin.send(st.error_reply(stanza, errtype, err)); end
724         origin.send(st.reply(stanza));
725         return true;
726 end
727
728 function room_mt:handle_admin_query_get_command(origin, stanza)
729         local actor = stanza.attr.from;
730         local affiliation = self:get_affiliation(actor);
731         local item = stanza.tags[1].tags[1];
732         local _aff = item.attr.affiliation;
733         local _rol = item.attr.role;
734         if _aff and not _rol then
735                 if affiliation == "owner" or (affiliation == "admin" and _aff ~= "owner" and _aff ~= "admin") then
736                         local reply = st.reply(stanza):query("http://jabber.org/protocol/muc#admin");
737                         for jid, affiliation in pairs(self._affiliations) do
738                                 if affiliation == _aff then
739                                         reply:tag("item", {affiliation = _aff, jid = jid}):up();
740                                 end
741                         end
742                         origin.send(reply);
743                         return true;
744                 else
745                         origin.send(st.error_reply(stanza, "auth", "forbidden"));
746                         return true;
747                 end
748         elseif _rol and not _aff then
749                 local role = self:get_role(self:get_occupant_jid(actor)) or self:get_default_role(affiliation);
750                 if valid_roles[role or "none"] >= valid_roles.moderator then
751                         if _rol == "none" then _rol = nil; end
752                         local reply = st.reply(stanza):query("http://jabber.org/protocol/muc#admin");
753                         -- TODO: whois check here? (though fully anonymous rooms are not supported)
754                         for occupant_jid, occupant in self:each_occupant() do
755                                 if occupant.role == _rol then
756                                         local nick = select(3,jid_split(occupant_jid));
757                                         self:build_item_list(occupant, reply, false, nick);
758                                 end
759                         end
760                         origin.send(reply:up());
761                         return true;
762                 else
763                         origin.send(st.error_reply(stanza, "auth", "forbidden"));
764                         return true;
765                 end
766         else
767                 origin.send(st.error_reply(stanza, "cancel", "bad-request"));
768                 return true;
769         end
770 end
771
772 function room_mt:handle_owner_query_get_to_room(origin, stanza)
773         if self:get_affiliation(stanza.attr.from) ~= "owner" then
774                 origin.send(st.error_reply(stanza, "auth", "forbidden", "Only owners can configure rooms"));
775                 return true;
776         end
777
778         self:send_form(origin, stanza);
779         return true;
780 end
781 function room_mt:handle_owner_query_set_to_room(origin, stanza)
782         if self:get_affiliation(stanza.attr.from) ~= "owner" then
783                 origin.send(st.error_reply(stanza, "auth", "forbidden", "Only owners can configure rooms"));
784                 return true;
785         end
786
787         local child = stanza.tags[1].tags[1];
788         if not child then
789                 origin.send(st.error_reply(stanza, "modify", "bad-request"));
790                 return true;
791         elseif child.name == "destroy" then
792                 local newjid = child.attr.jid;
793                 local reason = child:get_child_text("reason");
794                 local password = child:get_child_text("password");
795                 self:destroy(newjid, reason, password);
796                 origin.send(st.reply(stanza));
797                 return true;
798         elseif child.name == "x" and child.attr.xmlns == "jabber:x:data" then
799                 return self:process_form(origin, stanza);
800         else
801                 origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
802                 return true;
803         end
804 end
805
806 function room_mt:handle_groupchat_to_room(origin, stanza)
807         local from = stanza.attr.from;
808         local occupant = self:get_occupant_by_real_jid(from);
809         if module:fire_event("muc-occupant-groupchat", {
810                 room = self; origin = origin; stanza = stanza; from = from; occupant = occupant;
811         }) then return true; end
812         stanza.attr.from = occupant.nick;
813         self:broadcast_message(stanza);
814         stanza.attr.from = from;
815         return true;
816 end
817
818 -- Role check
819 module:hook("muc-occupant-groupchat", function(event)
820         local role_rank = valid_roles[event.occupant and event.occupant.role or "none"];
821         if role_rank <= valid_roles.none then
822                 event.origin.send(st.error_reply(event.stanza, "cancel", "not-acceptable"));
823                 return true;
824         elseif role_rank <= valid_roles.visitor then
825                 event.origin.send(st.error_reply(event.stanza, "auth", "forbidden"));
826                 return true;
827         end
828 end, 50);
829
830 -- hack - some buggy clients send presence updates to the room rather than their nick
831 function room_mt:handle_presence_to_room(origin, stanza)
832         local current_nick = self:get_occupant_jid(stanza.attr.from);
833         local handled
834         if current_nick then
835                 local to = stanza.attr.to;
836                 stanza.attr.to = current_nick;
837                 handled = self:handle_presence_to_occupant(origin, stanza);
838                 stanza.attr.to = to;
839         end
840         return handled;
841 end
842
843 -- Need visitor role or higher to invite
844 module:hook("muc-pre-invite", function(event)
845         local room, stanza = event.room, event.stanza;
846         local _from, _to = stanza.attr.from, stanza.attr.to;
847         local inviter = room:get_occupant_by_real_jid(_from);
848         local role = inviter and inviter.role or room:get_default_role(room:get_affiliation(_from));
849         if valid_roles[role or "none"] <= valid_roles.visitor then
850                 event.origin.send(st.error_reply(stanza, "auth", "forbidden"));
851                 return true;
852         end
853 end);
854
855 function room_mt:handle_mediated_invite(origin, stanza)
856         local payload = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("invite");
857         local invitee = jid_prep(payload.attr.to);
858         if not invitee then
859                 origin.send(st.error_reply(stanza, "cancel", "jid-malformed"));
860                 return true;
861         elseif module:fire_event("muc-pre-invite", {room = self, origin = origin, stanza = stanza}) then
862                 return true;
863         end
864         local invite = muc_util.filter_muc_x(st.clone(stanza));
865         invite.attr.from = self.jid;
866         invite.attr.to = invitee;
867         invite:tag('x', {xmlns='http://jabber.org/protocol/muc#user'})
868                         :tag('invite', {from = stanza.attr.from;})
869                                 :tag('reason'):text(payload:get_child_text("reason")):up()
870                         :up()
871                 :up();
872         if not module:fire_event("muc-invite", {room = self, stanza = invite, origin = origin, incoming = stanza}) then
873                 self:route_stanza(invite);
874         end
875         return true;
876 end
877
878 -- COMPAT: Some older clients expect this
879 module:hook("muc-invite", function(event)
880         local room, stanza = event.room, event.stanza;
881         local invite = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("invite");
882         local reason = invite:get_child_text("reason");
883         stanza:tag('x', {xmlns = "jabber:x:conference"; jid = room.jid;})
884                 :text(reason or "")
885         :up();
886 end);
887
888 -- Add a plain message for clients which don't support invites
889 module:hook("muc-invite", function(event)
890         local room, stanza = event.room, event.stanza;
891         if not stanza:get_child("body") then
892                 local invite = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("invite");
893                 local reason = invite:get_child_text("reason") or "";
894                 stanza:tag("body")
895                         :text(invite.attr.from.." invited you to the room "..room.jid..(reason == "" and (" ("..reason..")") or ""))
896                 :up();
897         end
898 end);
899
900 function room_mt:handle_mediated_decline(origin, stanza)
901         local payload = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("decline");
902         local declinee = jid_prep(payload.attr.to);
903         if not declinee then
904                 origin.send(st.error_reply(stanza, "cancel", "jid-malformed"));
905                 return true;
906         elseif module:fire_event("muc-pre-decline", {room = self, origin = origin, stanza = stanza}) then
907                 return true;
908         end
909         local decline = muc_util.filter_muc_x(st.clone(stanza));
910         decline.attr.from = self.jid;
911         decline.attr.to = declinee;
912         decline:tag("x", {xmlns = "http://jabber.org/protocol/muc#user"})
913                         :tag("decline", {from = stanza.attr.from})
914                                 :tag("reason"):text(payload:get_child_text("reason")):up()
915                         :up()
916                 :up();
917         if not module:fire_event("muc-decline", {room = self, stanza = decline, origin = origin, incoming = stanza}) then
918                 local declinee = decline.attr.to; -- re-fetch, in case event modified it
919                 local occupant
920                 if jid_bare(declinee) == self.jid then -- declinee jid is already an in-room jid
921                         occupant = self:get_occupant_by_nick(declinee);
922                 end
923                 if occupant then
924                         self:route_to_occupant(occupant, decline);
925                 else
926                         self:route_stanza(decline);
927                 end
928         end
929         return true;
930 end
931
932 -- Add a plain message for clients which don't support declines
933 module:hook("muc-decline", function(event)
934         local room, stanza = event.room, event.stanza;
935         if not stanza:get_child("body") then
936                 local decline = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("decline");
937                 local reason = decline:get_child_text("reason") or "";
938                 stanza:tag("body")
939                         :text(decline.attr.from.." declined your invite to the room "..room.jid..(reason == "" and (" ("..reason..")") or ""))
940                 :up();
941         end
942 end);
943
944 function room_mt:handle_message_to_room(origin, stanza)
945         local type = stanza.attr.type;
946         if type == "groupchat" then
947                 return self:handle_groupchat_to_room(origin, stanza)
948         elseif type == "error" and is_kickable_error(stanza) then
949                 return self:handle_kickable(origin, stanza)
950         elseif type == nil then
951                 local x = stanza:get_child("x", "http://jabber.org/protocol/muc#user");
952                 if x then
953                         local payload = x.tags[1];
954                         if payload == nil then
955                                 -- fallthrough
956                         elseif payload.name == "invite" and payload.attr.to then
957                                 return self:handle_mediated_invite(origin, stanza)
958                         elseif payload.name == "decline" and payload.attr.to then
959                                 return self:handle_mediated_decline(origin, stanza)
960                         end
961                         origin.send(st.error_reply(stanza, "cancel", "bad-request"));
962                         return true;
963                 end
964         end
965 end
966
967 function room_mt:route_stanza(stanza)
968         module:send(stanza);
969 end
970
971 function room_mt:get_affiliation(jid)
972         local node, host, resource = jid_split(jid);
973         local bare = node and node.."@"..host or host;
974         local result = self._affiliations[bare]; -- Affiliations are granted, revoked, and maintained based on the user's bare JID.
975         if not result and self._affiliations[host] == "outcast" then result = "outcast"; end -- host banned
976         return result;
977 end
978
979 function room_mt:set_affiliation(actor, jid, affiliation, reason)
980         if not actor then return nil, "modify", "not-acceptable"; end;
981
982         jid = jid_bare(jid);
983
984         if valid_affiliations[affiliation or "none"] == nil then
985                 return nil, "modify", "not-acceptable";
986         end
987         affiliation = affiliation ~= "none" and affiliation or nil; -- coerces `affiliation == false` to `nil`
988
989         local target_affiliation = self._affiliations[jid]; -- Raw; don't want to check against host
990         local is_downgrade = valid_affiliations[target_affiliation or "none"] > valid_affiliations[affiliation or "none"];
991
992         if actor ~= true then
993                 local actor_affiliation = self:get_affiliation(actor);
994                 if actor_affiliation == "owner" then
995                         if jid_bare(actor) == jid then -- self change
996                                 -- need at least one owner
997                                 local is_last = true;
998                                 for j, aff in pairs(self._affiliations) do if j ~= jid and aff == "owner" then is_last = false; break; end end
999                                 if is_last then
1000                                         return nil, "cancel", "conflict";
1001                                 end
1002                         end
1003                         -- owners can do anything else
1004                 elseif affiliation == "owner" or affiliation == "admin"
1005                         or actor_affiliation ~= "admin"
1006                         or target_affiliation == "owner" or target_affiliation == "admin" then
1007                         -- Can't demote owners or other admins
1008                         return nil, "cancel", "not-allowed";
1009                 end
1010         end
1011
1012         -- Set in 'database'
1013         self._affiliations[jid] = affiliation;
1014
1015         -- Update roles
1016         local role = self:get_default_role(affiliation);
1017         local role_rank = valid_roles[role or "none"];
1018         local occupants_updated = {}; -- Filled with old roles
1019         for nick, occupant in self:each_occupant() do
1020                 if occupant.bare_jid == jid then
1021                         -- need to publcize in all cases; as affiliation in <item/> has changed.
1022                         occupants_updated[occupant] = occupant.role;
1023                         if occupant.role ~= role and (
1024                                 is_downgrade or
1025                                 valid_roles[occupant.role or "none"] < role_rank -- upgrade
1026                         ) then
1027                                 occupant.role = role;
1028                                 self:save_occupant(occupant);
1029                         end
1030                 end
1031         end
1032
1033         -- Tell the room of the new occupant affiliations+roles
1034         local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"});
1035         if not role then -- getting kicked
1036                 if affiliation == "outcast" then
1037                         x:tag("status", {code="301"}):up(); -- banned
1038                 else
1039                         x:tag("status", {code="321"}):up(); -- affiliation change
1040                 end
1041         end
1042         local is_semi_anonymous = self:get_whois() == "moderators";
1043         for occupant, old_role in pairs(occupants_updated) do
1044                 self:publicise_occupant_status(occupant, x, nil, actor, reason);
1045                 if is_semi_anonymous and
1046                         (old_role == "moderator" and occupant.role ~= "moderator") or
1047                         (old_role ~= "moderator" and occupant.role == "moderator") then -- Has gained or lost moderator status
1048                         -- Send everyone else's presences (as jid visibility has changed)
1049                         for real_jid in occupant:each_session() do
1050                                 self:send_occupant_list(real_jid, function(occupant_jid, occupant)
1051                                         return occupant.bare_jid ~= jid;
1052                                 end);
1053                         end
1054                 end
1055         end
1056
1057         if self.save then self:save(); end
1058
1059         module:fire_event("muc-set-affiliation", {
1060                 room = self;
1061                 actor = actor;
1062                 jid = jid;
1063                 affiliation = affiliation or "none";
1064                 reason = reason;
1065                 previous_affiliation = target_affiliation;
1066                 in_room = next(occupants_updated) ~= nil;
1067         });
1068
1069         return true;
1070 end
1071
1072 function room_mt:get_role(nick)
1073         local occupant = self:get_occupant_by_nick(nick);
1074         return occupant and occupant.role or nil;
1075 end
1076
1077 function room_mt:set_role(actor, occupant_jid, role, reason)
1078         if not actor then return nil, "modify", "not-acceptable"; end
1079
1080         local occupant = self:get_occupant_by_nick(occupant_jid);
1081         if not occupant then return nil, "modify", "not-acceptable"; end
1082
1083         if valid_roles[role or "none"] == nil then
1084                 return nil, "modify", "not-acceptable";
1085         end
1086         role = role ~= "none" and role or nil; -- coerces `role == false` to `nil`
1087
1088         if actor ~= true then
1089                 -- Can't do anything to other owners or admins
1090                 local occupant_affiliation = self:get_affiliation(occupant.bare_jid);
1091                 if occupant_affiliation == "owner" and occupant_affiliation == "admin" then
1092                         return nil, "cancel", "not-allowed";
1093                 end
1094
1095                 -- If you are trying to give or take moderator role you need to be an owner or admin
1096                 if occupant.role == "moderator" or role == "moderator" then
1097                         local actor_affiliation = self:get_affiliation(actor);
1098                         if actor_affiliation ~= "owner" and actor_affiliation ~= "admin" then
1099                                 return nil, "cancel", "not-allowed";
1100                         end
1101                 end
1102
1103                 -- Need to be in the room and a moderator
1104                 local actor_occupant = self:get_occupant_by_real_jid(actor);
1105                 if not actor_occupant or actor_occupant.role ~= "moderator" then
1106                         return nil, "cancel", "not-allowed";
1107                 end
1108         end
1109
1110         local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"});
1111         if not role then
1112                 x:tag("status", {code = "307"}):up();
1113         end
1114         occupant.role = role;
1115         self:save_occupant(occupant);
1116         self:publicise_occupant_status(occupant, x, nil, actor, reason);
1117         return true;
1118 end
1119
1120 local affiliation_notify = module:require "muc/affiliation_notify";
1121
1122 local name = module:require "muc/name";
1123 room_mt.get_name = name.get;
1124 room_mt.set_name = name.set;
1125
1126 local description = module:require "muc/description";
1127 room_mt.get_description = description.get;
1128 room_mt.set_description = description.set;
1129
1130 local hidden = module:require "muc/hidden";
1131 room_mt.get_hidden = hidden.get;
1132 room_mt.set_hidden = hidden.set;
1133 function room_mt:get_public()
1134         return not self:get_hidden();
1135 end
1136 function room_mt:set_public(public)
1137         return self:set_hidden(not public);
1138 end
1139
1140 local password = module:require "muc/password";
1141 room_mt.get_password = password.get;
1142 room_mt.set_password = password.set;
1143
1144 local whois = module:require "muc/whois";
1145 room_mt.get_whois = whois.get;
1146 room_mt.set_whois = whois.set;
1147
1148 local members_only = module:require "muc/members_only";
1149 room_mt.get_members_only = members_only.get;
1150 room_mt.set_members_only = members_only.set;
1151
1152 local moderated = module:require "muc/moderated";
1153 room_mt.get_moderated = moderated.get;
1154 room_mt.set_moderated = moderated.set;
1155
1156 local persistent = module:require "muc/persistent";
1157 room_mt.get_persistent = persistent.get;
1158 room_mt.set_persistent = persistent.set;
1159
1160 local subject = module:require "muc/subject";
1161 room_mt.get_changesubject = subject.get_changesubject;
1162 room_mt.set_changesubject = subject.set_changesubject;
1163 room_mt.get_subject = subject.get;
1164 room_mt.set_subject = subject.set;
1165 room_mt.send_subject = subject.send;
1166
1167 local history = module:require "muc/history";
1168 room_mt.send_history = history.send;
1169 room_mt.get_historylength = history.get_length;
1170 room_mt.set_historylength = history.set_length;
1171
1172 local _M = {}; -- module "muc"
1173
1174 function _M.new_room(jid, config)
1175         return setmetatable({
1176                 jid = jid;
1177                 _jid_nick = {};
1178                 _occupants = {};
1179                 _data = {
1180                 };
1181                 _affiliations = {};
1182         }, room_mt);
1183 end
1184
1185 _M.room_mt = room_mt;
1186
1187 return _M;