Remove all trailing whitespace
[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 --
5 -- This project is MIT/X11 licensed. Please see the
6 -- COPYING file in the source package for more information.
7 --
8
9 local select = select;
10 local pairs, ipairs = pairs, ipairs;
11
12 local datetime = require "util.datetime";
13
14 local dataform = require "util.dataforms";
15
16 local jid_split = require "util.jid".split;
17 local jid_bare = require "util.jid".bare;
18 local jid_prep = require "util.jid".prep;
19 local st = require "util.stanza";
20 local log = require "util.logger".init("mod_muc");
21 local t_insert, t_remove = table.insert, table.remove;
22 local setmetatable = setmetatable;
23 local base64 = require "util.encodings".base64;
24 local md5 = require "util.hashes".md5;
25
26 local muc_domain = nil; --module:get_host();
27 local default_history_length, max_history_length = 20, math.huge;
28
29 ------------
30 local presence_filters = {["http://jabber.org/protocol/muc"]=true;["http://jabber.org/protocol/muc#user"]=true};
31 local function presence_filter(tag)
32         if presence_filters[tag.attr.xmlns] then
33                 return nil;
34         end
35         return tag;
36 end
37
38 local function get_filtered_presence(stanza)
39         return st.clone(stanza):maptags(presence_filter);
40 end
41 local kickable_error_conditions = {
42         ["gone"] = true;
43         ["internal-server-error"] = true;
44         ["item-not-found"] = true;
45         ["jid-malformed"] = true;
46         ["recipient-unavailable"] = true;
47         ["redirect"] = true;
48         ["remote-server-not-found"] = true;
49         ["remote-server-timeout"] = true;
50         ["service-unavailable"] = true;
51         ["malformed error"] = true;
52 };
53
54 local function get_error_condition(stanza)
55         local _, condition = stanza:get_error();
56         return condition or "malformed error";
57 end
58
59 local function is_kickable_error(stanza)
60         local cond = get_error_condition(stanza);
61         return kickable_error_conditions[cond] and cond;
62 end
63 -----------
64
65 local room_mt = {};
66 room_mt.__index = room_mt;
67
68 function room_mt:__tostring()
69         return "MUC room ("..self.jid..")";
70 end
71
72 function room_mt:get_default_role(affiliation)
73         if affiliation == "owner" or affiliation == "admin" then
74                 return "moderator";
75         elseif affiliation == "member" then
76                 return "participant";
77         elseif not affiliation then
78                 if not self:get_members_only() then
79                         return self:get_moderated() and "visitor" or "participant";
80                 end
81         end
82 end
83
84 function room_mt:broadcast_presence(stanza, sid, code, nick)
85         stanza = get_filtered_presence(stanza);
86         local occupant = self._occupants[stanza.attr.from];
87         stanza:tag("x", {xmlns='http://jabber.org/protocol/muc#user'})
88                 :tag("item", {affiliation=occupant.affiliation or "none", role=occupant.role or "none", nick=nick}):up();
89         if code then
90                 stanza:tag("status", {code=code}):up();
91         end
92         self:broadcast_except_nick(stanza, stanza.attr.from);
93         local me = self._occupants[stanza.attr.from];
94         if me then
95                 stanza:tag("status", {code='110'}):up();
96                 stanza.attr.to = sid;
97                 self:_route_stanza(stanza);
98         end
99 end
100 function room_mt:broadcast_message(stanza, historic)
101         local to = stanza.attr.to;
102         for occupant, o_data in pairs(self._occupants) do
103                 for jid in pairs(o_data.sessions) do
104                         stanza.attr.to = jid;
105                         self:_route_stanza(stanza);
106                 end
107         end
108         stanza.attr.to = to;
109         if historic then -- add to history
110                 local history = self._data['history'];
111                 if not history then history = {}; self._data['history'] = history; end
112                 stanza = st.clone(stanza);
113                 stanza.attr.to = "";
114                 local stamp = datetime.datetime();
115                 stanza:tag("delay", {xmlns = "urn:xmpp:delay", from = muc_domain, stamp = stamp}):up(); -- XEP-0203
116                 stanza:tag("x", {xmlns = "jabber:x:delay", from = muc_domain, stamp = datetime.legacy()}):up(); -- XEP-0091 (deprecated)
117                 local entry = { stanza = stanza, stamp = stamp };
118                 t_insert(history, entry);
119                 while #history > (self._data.history_length or default_history_length) do t_remove(history, 1) end
120         end
121 end
122 function room_mt:broadcast_except_nick(stanza, nick)
123         for rnick, occupant in pairs(self._occupants) do
124                 if rnick ~= nick then
125                         for jid in pairs(occupant.sessions) do
126                                 stanza.attr.to = jid;
127                                 self:_route_stanza(stanza);
128                         end
129                 end
130         end
131 end
132
133 function room_mt:send_occupant_list(to)
134         local current_nick = self._jid_nick[to];
135         for occupant, o_data in pairs(self._occupants) do
136                 if occupant ~= current_nick then
137                         local pres = get_filtered_presence(o_data.sessions[o_data.jid]);
138                         pres.attr.to, pres.attr.from = to, occupant;
139                         pres:tag("x", {xmlns='http://jabber.org/protocol/muc#user'})
140                                 :tag("item", {affiliation=o_data.affiliation or "none", role=o_data.role or "none"}):up();
141                         self:_route_stanza(pres);
142                 end
143         end
144 end
145 function room_mt:send_history(to, stanza)
146         local history = self._data['history']; -- send discussion history
147         if history then
148                 local x_tag = stanza and stanza:get_child("x", "http://jabber.org/protocol/muc");
149                 local history_tag = x_tag and x_tag:get_child("history", "http://jabber.org/protocol/muc");
150
151                 local maxchars = history_tag and tonumber(history_tag.attr.maxchars);
152                 if maxchars then maxchars = math.floor(maxchars); end
153
154                 local maxstanzas = math.floor(history_tag and tonumber(history_tag.attr.maxstanzas) or #history);
155                 if not history_tag then maxstanzas = 20; end
156
157                 local seconds = history_tag and tonumber(history_tag.attr.seconds);
158                 if seconds then seconds = datetime.datetime(os.time() - math.floor(seconds)); end
159
160                 local since = history_tag and history_tag.attr.since;
161                 if since then since = datetime.parse(since); since = since and datetime.datetime(since); end
162                 if seconds and (not since or since < seconds) then since = seconds; end
163
164                 local n = 0;
165                 local charcount = 0;
166
167                 for i=#history,1,-1 do
168                         local entry = history[i];
169                         if maxchars then
170                                 if not entry.chars then
171                                         entry.stanza.attr.to = "";
172                                         entry.chars = #tostring(entry.stanza);
173                                 end
174                                 charcount = charcount + entry.chars + #to;
175                                 if charcount > maxchars then break; end
176                         end
177                         if since and since > entry.stamp then break; end
178                         if n + 1 > maxstanzas then break; end
179                         n = n + 1;
180                 end
181                 for i=#history-n+1,#history do
182                         local msg = history[i].stanza;
183                         msg.attr.to = to;
184                         self:_route_stanza(msg);
185                 end
186         end
187         if self._data['subject'] then
188                 self:_route_stanza(st.message({type='groupchat', from=self._data['subject_from'] or self.jid, to=to}):tag("subject"):text(self._data['subject']));
189         end
190 end
191
192 function room_mt:get_disco_info(stanza)
193         local count = 0; for _ in pairs(self._occupants) do count = count + 1; end
194         return st.reply(stanza):query("http://jabber.org/protocol/disco#info")
195                 :tag("identity", {category="conference", type="text", name=self:get_name()}):up()
196                 :tag("feature", {var="http://jabber.org/protocol/muc"}):up()
197                 :tag("feature", {var=self:get_password() and "muc_passwordprotected" or "muc_unsecured"}):up()
198                 :tag("feature", {var=self:get_moderated() and "muc_moderated" or "muc_unmoderated"}):up()
199                 :tag("feature", {var=self:get_members_only() and "muc_membersonly" or "muc_open"}):up()
200                 :tag("feature", {var=self:get_persistent() and "muc_persistent" or "muc_temporary"}):up()
201                 :tag("feature", {var=self:get_hidden() and "muc_hidden" or "muc_public"}):up()
202                 :tag("feature", {var=self._data.whois ~= "anyone" and "muc_semianonymous" or "muc_nonanonymous"}):up()
203                 :add_child(dataform.new({
204                         { name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/protocol/muc#roominfo" },
205                         { name = "muc#roominfo_description", label = "Description"},
206                         { name = "muc#roominfo_occupants", label = "Number of occupants", value = tostring(count) }
207                 }):form({["muc#roominfo_description"] = self:get_description()}, 'result'))
208         ;
209 end
210 function room_mt:get_disco_items(stanza)
211         local reply = st.reply(stanza):query("http://jabber.org/protocol/disco#items");
212         for room_jid in pairs(self._occupants) do
213                 reply:tag("item", {jid = room_jid, name = room_jid:match("/(.*)")}):up();
214         end
215         return reply;
216 end
217 function room_mt:set_subject(current_nick, subject)
218         if subject == "" then subject = nil; end
219         self._data['subject'] = subject;
220         self._data['subject_from'] = current_nick;
221         if self.save then self:save(); end
222         local msg = st.message({type='groupchat', from=current_nick})
223                 :tag('subject'):text(subject):up();
224         self:broadcast_message(msg, false);
225         return true;
226 end
227
228 local function build_unavailable_presence_from_error(stanza)
229         local type, condition, text = stanza:get_error();
230         local error_message = "Kicked: "..(condition and condition:gsub("%-", " ") or "presence error");
231         if text then
232                 error_message = error_message..": "..text;
233         end
234         return st.presence({type='unavailable', from=stanza.attr.from, to=stanza.attr.to})
235                 :tag('status'):text(error_message);
236 end
237
238 function room_mt:set_name(name)
239         if name == "" or type(name) ~= "string" or name == (jid_split(self.jid)) then name = nil; end
240         if self._data.name ~= name then
241                 self._data.name = name;
242                 if self.save then self:save(true); end
243         end
244 end
245 function room_mt:get_name()
246         return self._data.name or jid_split(self.jid);
247 end
248 function room_mt:set_description(description)
249         if description == "" or type(description) ~= "string" then description = nil; end
250         if self._data.description ~= description then
251                 self._data.description = description;
252                 if self.save then self:save(true); end
253         end
254 end
255 function room_mt:get_description()
256         return self._data.description;
257 end
258 function room_mt:set_password(password)
259         if password == "" or type(password) ~= "string" then password = nil; end
260         if self._data.password ~= password then
261                 self._data.password = password;
262                 if self.save then self:save(true); end
263         end
264 end
265 function room_mt:get_password()
266         return self._data.password;
267 end
268 function room_mt:set_moderated(moderated)
269         moderated = moderated and true or nil;
270         if self._data.moderated ~= moderated then
271                 self._data.moderated = moderated;
272                 if self.save then self:save(true); end
273         end
274 end
275 function room_mt:get_moderated()
276         return self._data.moderated;
277 end
278 function room_mt:set_members_only(members_only)
279         members_only = members_only and true or nil;
280         if self._data.members_only ~= members_only then
281                 self._data.members_only = members_only;
282                 if self.save then self:save(true); end
283         end
284 end
285 function room_mt:get_members_only()
286         return self._data.members_only;
287 end
288 function room_mt:set_persistent(persistent)
289         persistent = persistent and true or nil;
290         if self._data.persistent ~= persistent then
291                 self._data.persistent = persistent;
292                 if self.save then self:save(true); end
293         end
294 end
295 function room_mt:get_persistent()
296         return self._data.persistent;
297 end
298 function room_mt:set_hidden(hidden)
299         hidden = hidden and true or nil;
300         if self._data.hidden ~= hidden then
301                 self._data.hidden = hidden;
302                 if self.save then self:save(true); end
303         end
304 end
305 function room_mt:get_hidden()
306         return self._data.hidden;
307 end
308 function room_mt:get_public()
309         return not self:get_hidden();
310 end
311 function room_mt:set_public(public)
312         return self:set_hidden(not public);
313 end
314 function room_mt:set_changesubject(changesubject)
315         changesubject = changesubject and true or nil;
316         if self._data.changesubject ~= changesubject then
317                 self._data.changesubject = changesubject;
318                 if self.save then self:save(true); end
319         end
320 end
321 function room_mt:get_changesubject()
322         return self._data.changesubject;
323 end
324 function room_mt:get_historylength()
325         return self._data.history_length or default_history_length;
326 end
327 function room_mt:set_historylength(length)
328         length = math.min(tonumber(length) or default_history_length, max_history_length or math.huge);
329         if length == default_history_length then
330                 length = nil;
331         end
332         self._data.history_length = length;
333 end
334
335
336 local valid_whois = { moderators = true, anyone = true };
337
338 function room_mt:set_whois(whois)
339         if valid_whois[whois] and self._data.whois ~= whois then
340                 self._data.whois = whois;
341                 if self.save then self:save(true); end
342         end
343 end
344
345 function room_mt:get_whois()
346         return self._data.whois;
347 end
348
349 local function construct_stanza_id(room, stanza)
350         local from_jid, to_nick = stanza.attr.from, stanza.attr.to;
351         local from_nick = room._jid_nick[from_jid];
352         local occupant = room._occupants[to_nick];
353         local to_jid = occupant.jid;
354
355         return from_nick, to_jid, base64.encode(to_jid.."\0"..stanza.attr.id.."\0"..md5(from_jid));
356 end
357 local function deconstruct_stanza_id(room, stanza)
358         local from_jid_possiblybare, to_nick = stanza.attr.from, stanza.attr.to;
359         local from_jid, id, to_jid_hash = (base64.decode(stanza.attr.id) or ""):match("^(.+)%z(.*)%z(.+)$");
360         local from_nick = room._jid_nick[from_jid];
361
362         if not(from_nick) then return; end
363         if not(from_jid_possiblybare == from_jid or from_jid_possiblybare == jid_bare(from_jid)) then return; end
364
365         local occupant = room._occupants[to_nick];
366         for to_jid in pairs(occupant and occupant.sessions or {}) do
367                 if md5(to_jid) == to_jid_hash then
368                         return from_nick, to_jid, id;
369                 end
370         end
371 end
372
373
374 function room_mt:handle_to_occupant(origin, stanza) -- PM, vCards, etc
375         local from, to = stanza.attr.from, stanza.attr.to;
376         local room = jid_bare(to);
377         local current_nick = self._jid_nick[from];
378         local type = stanza.attr.type;
379         log("debug", "room: %s, current_nick: %s, stanza: %s", room or "nil", current_nick or "nil", stanza:top_tag());
380         if (select(2, jid_split(from)) == muc_domain) then error("Presence from the MUC itself!!!"); end
381         if stanza.name == "presence" then
382                 local pr = get_filtered_presence(stanza);
383                 pr.attr.from = current_nick;
384                 if type == "error" then -- error, kick em out!
385                         if current_nick then
386                                 log("debug", "kicking %s from %s", current_nick, room);
387                                 self:handle_to_occupant(origin, build_unavailable_presence_from_error(stanza));
388                         end
389                 elseif type == "unavailable" then -- unavailable
390                         if current_nick then
391                                 log("debug", "%s leaving %s", current_nick, room);
392                                 self._jid_nick[from] = nil;
393                                 local occupant = self._occupants[current_nick];
394                                 local new_jid = next(occupant.sessions);
395                                 if new_jid == from then new_jid = next(occupant.sessions, new_jid); end
396                                 if new_jid then
397                                         local jid = occupant.jid;
398                                         occupant.jid = new_jid;
399                                         occupant.sessions[from] = nil;
400                                         pr.attr.to = from;
401                                         pr:tag("x", {xmlns='http://jabber.org/protocol/muc#user'})
402                                                 :tag("item", {affiliation=occupant.affiliation or "none", role='none'}):up()
403                                                 :tag("status", {code='110'}):up();
404                                         self:_route_stanza(pr);
405                                         if jid ~= new_jid then
406                                                 pr = st.clone(occupant.sessions[new_jid])
407                                                         :tag("x", {xmlns='http://jabber.org/protocol/muc#user'})
408                                                         :tag("item", {affiliation=occupant.affiliation or "none", role=occupant.role or "none"});
409                                                 pr.attr.from = current_nick;
410                                                 self:broadcast_except_nick(pr, current_nick);
411                                         end
412                                 else
413                                         occupant.role = 'none';
414                                         self:broadcast_presence(pr, from);
415                                         self._occupants[current_nick] = nil;
416                                 end
417                         end
418                 elseif not type then -- available
419                         if current_nick then
420                                 --if #pr == #stanza or current_nick ~= to then -- commented because google keeps resending directed presence
421                                         if current_nick == to then -- simple presence
422                                                 log("debug", "%s broadcasted presence", current_nick);
423                                                 self._occupants[current_nick].sessions[from] = pr;
424                                                 self:broadcast_presence(pr, from);
425                                         else -- change nick
426                                                 local occupant = self._occupants[current_nick];
427                                                 local is_multisession = next(occupant.sessions, next(occupant.sessions));
428                                                 if self._occupants[to] or is_multisession then
429                                                         log("debug", "%s couldn't change nick", current_nick);
430                                                         local reply = st.error_reply(stanza, "cancel", "conflict"):up();
431                                                         reply.tags[1].attr.code = "409";
432                                                         origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
433                                                 else
434                                                         local data = self._occupants[current_nick];
435                                                         local to_nick = select(3, jid_split(to));
436                                                         if to_nick then
437                                                                 log("debug", "%s (%s) changing nick to %s", current_nick, data.jid, to);
438                                                                 local p = st.presence({type='unavailable', from=current_nick});
439                                                                 self:broadcast_presence(p, from, '303', to_nick);
440                                                                 self._occupants[current_nick] = nil;
441                                                                 self._occupants[to] = data;
442                                                                 self._jid_nick[from] = to;
443                                                                 pr.attr.from = to;
444                                                                 self._occupants[to].sessions[from] = pr;
445                                                                 self:broadcast_presence(pr, from);
446                                                         else
447                                                                 --TODO malformed-jid
448                                                         end
449                                                 end
450                                         end
451                                 --else -- possible rejoin
452                                 --      log("debug", "%s had connection replaced", current_nick);
453                                 --      self:handle_to_occupant(origin, st.presence({type='unavailable', from=from, to=to})
454                                 --              :tag('status'):text('Replaced by new connection'):up()); -- send unavailable
455                                 --      self:handle_to_occupant(origin, stanza); -- resend available
456                                 --end
457                         else -- enter room
458                                 local new_nick = to;
459                                 local is_merge;
460                                 if self._occupants[to] then
461                                         if jid_bare(from) ~= jid_bare(self._occupants[to].jid) then
462                                                 new_nick = nil;
463                                         end
464                                         is_merge = true;
465                                 end
466                                 local password = stanza:get_child("x", "http://jabber.org/protocol/muc");
467                                 password = password and password:get_child("password", "http://jabber.org/protocol/muc");
468                                 password = password and password[1] ~= "" and password[1];
469                                 if self:get_password() and self:get_password() ~= password then
470                                         log("debug", "%s couldn't join due to invalid password: %s", from, to);
471                                         local reply = st.error_reply(stanza, "auth", "not-authorized"):up();
472                                         reply.tags[1].attr.code = "401";
473                                         origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
474                                 elseif not new_nick then
475                                         log("debug", "%s couldn't join due to nick conflict: %s", from, to);
476                                         local reply = st.error_reply(stanza, "cancel", "conflict"):up();
477                                         reply.tags[1].attr.code = "409";
478                                         origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
479                                 else
480                                         log("debug", "%s joining as %s", from, to);
481                                         if not next(self._affiliations) then -- new room, no owners
482                                                 self._affiliations[jid_bare(from)] = "owner";
483                                         end
484                                         local affiliation = self:get_affiliation(from);
485                                         local role = self:get_default_role(affiliation)
486                                         if role then -- new occupant
487                                                 if not is_merge then
488                                                         self._occupants[to] = {affiliation=affiliation, role=role, jid=from, sessions={[from]=get_filtered_presence(stanza)}};
489                                                 else
490                                                         self._occupants[to].sessions[from] = get_filtered_presence(stanza);
491                                                 end
492                                                 self._jid_nick[from] = to;
493                                                 self:send_occupant_list(from);
494                                                 pr.attr.from = to;
495                                                 pr:tag("x", {xmlns='http://jabber.org/protocol/muc#user'})
496                                                         :tag("item", {affiliation=affiliation or "none", role=role or "none"}):up();
497                                                 if not is_merge then
498                                                         self:broadcast_except_nick(pr, to);
499                                                 end
500                                                 pr:tag("status", {code='110'}):up();
501                                                 if self._data.whois == 'anyone' then
502                                                         pr:tag("status", {code='100'}):up();
503                                                 end
504                                                 pr.attr.to = from;
505                                                 self:_route_stanza(pr);
506                                                 self:send_history(from, stanza);
507                                         elseif not affiliation then -- registration required for entering members-only room
508                                                 local reply = st.error_reply(stanza, "auth", "registration-required"):up();
509                                                 reply.tags[1].attr.code = "407";
510                                                 origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
511                                         else -- banned
512                                                 local reply = st.error_reply(stanza, "auth", "forbidden"):up();
513                                                 reply.tags[1].attr.code = "403";
514                                                 origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
515                                         end
516                                 end
517                         end
518                 elseif type ~= 'result' then -- bad type
519                         if type ~= 'visible' and type ~= 'invisible' then -- COMPAT ejabberd can broadcast or forward XEP-0018 presences
520                                 origin.send(st.error_reply(stanza, "modify", "bad-request")); -- FIXME correct error?
521                         end
522                 end
523         elseif not current_nick then -- not in room
524                 if (type == "error" or type == "result") and stanza.name == "iq" then
525                         local id = stanza.attr.id;
526                         stanza.attr.from, stanza.attr.to, stanza.attr.id = deconstruct_stanza_id(self, stanza);
527                         if stanza.attr.id then
528                                 self:_route_stanza(stanza);
529                         end
530                         stanza.attr.from, stanza.attr.to, stanza.attr.id = from, to, id;
531                 elseif type ~= "error" then
532                         origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));
533                 end
534         elseif stanza.name == "message" and type == "groupchat" then -- groupchat messages not allowed in PM
535                 origin.send(st.error_reply(stanza, "modify", "bad-request"));
536         elseif current_nick and stanza.name == "message" and type == "error" and is_kickable_error(stanza) then
537                 log("debug", "%s kicked from %s for sending an error message", current_nick, self.jid);
538                 self:handle_to_occupant(origin, build_unavailable_presence_from_error(stanza)); -- send unavailable
539         else -- private stanza
540                 local o_data = self._occupants[to];
541                 if o_data then
542                         log("debug", "%s sent private stanza to %s (%s)", from, to, o_data.jid);
543                         if stanza.name == "iq" then
544                                 local id = stanza.attr.id;
545                                 if stanza.attr.type == "get" or stanza.attr.type == "set" then
546                                         stanza.attr.from, stanza.attr.to, stanza.attr.id = construct_stanza_id(self, stanza);
547                                 else
548                                         stanza.attr.from, stanza.attr.to, stanza.attr.id = deconstruct_stanza_id(self, stanza);
549                                 end
550                                 if type == 'get' and stanza.tags[1].attr.xmlns == 'vcard-temp' then
551                                         stanza.attr.to = jid_bare(stanza.attr.to);
552                                 end
553                                 if stanza.attr.id then
554                                         self:_route_stanza(stanza);
555                                 end
556                                 stanza.attr.from, stanza.attr.to, stanza.attr.id = from, to, id;
557                         else -- message
558                                 stanza.attr.from = current_nick;
559                                 for jid in pairs(o_data.sessions) do
560                                         stanza.attr.to = jid;
561                                         self:_route_stanza(stanza);
562                                 end
563                                 stanza.attr.from, stanza.attr.to = from, to;
564                         end
565                 elseif type ~= "error" and type ~= "result" then -- recipient not in room
566                         origin.send(st.error_reply(stanza, "cancel", "item-not-found", "Recipient not in room"));
567                 end
568         end
569 end
570
571 function room_mt:send_form(origin, stanza)
572         origin.send(st.reply(stanza):query("http://jabber.org/protocol/muc#owner")
573                 :add_child(self:get_form_layout(stanza.attr.from):form())
574         );
575 end
576
577 function room_mt:get_form_layout(actor)
578         local form = dataform.new({
579                 title = "Configuration for "..self.jid,
580                 instructions = "Complete and submit this form to configure the room.",
581                 {
582                         name = 'FORM_TYPE',
583                         type = 'hidden',
584                         value = 'http://jabber.org/protocol/muc#roomconfig'
585                 },
586                 {
587                         name = 'muc#roomconfig_roomname',
588                         type = 'text-single',
589                         label = 'Name',
590                         value = self:get_name() or "",
591                 },
592                 {
593                         name = 'muc#roomconfig_roomdesc',
594                         type = 'text-single',
595                         label = 'Description',
596                         value = self:get_description() or "",
597                 },
598                 {
599                         name = 'muc#roomconfig_persistentroom',
600                         type = 'boolean',
601                         label = 'Make Room Persistent?',
602                         value = self:get_persistent()
603                 },
604                 {
605                         name = 'muc#roomconfig_publicroom',
606                         type = 'boolean',
607                         label = 'Make Room Publicly Searchable?',
608                         value = not self:get_hidden()
609                 },
610                 {
611                         name = 'muc#roomconfig_changesubject',
612                         type = 'boolean',
613                         label = 'Allow Occupants to Change Subject?',
614                         value = self:get_changesubject()
615                 },
616                 {
617                         name = 'muc#roomconfig_whois',
618                         type = 'list-single',
619                         label = 'Who May Discover Real JIDs?',
620                         value = {
621                                 { value = 'moderators', label = 'Moderators Only', default = self._data.whois == 'moderators' },
622                                 { value = 'anyone',     label = 'Anyone',          default = self._data.whois == 'anyone' }
623                         }
624                 },
625                 {
626                         name = 'muc#roomconfig_roomsecret',
627                         type = 'text-private',
628                         label = 'Password',
629                         value = self:get_password() or "",
630                 },
631                 {
632                         name = 'muc#roomconfig_moderatedroom',
633                         type = 'boolean',
634                         label = 'Make Room Moderated?',
635                         value = self:get_moderated()
636                 },
637                 {
638                         name = 'muc#roomconfig_membersonly',
639                         type = 'boolean',
640                         label = 'Make Room Members-Only?',
641                         value = self:get_members_only()
642                 },
643                 {
644                         name = 'muc#roomconfig_historylength',
645                         type = 'text-single',
646                         label = 'Maximum Number of History Messages Returned by Room',
647                         value = tostring(self:get_historylength())
648                 }
649         });
650         return module:fire_event("muc-config-form", { room = self, actor = actor, form = form }) or form;
651 end
652
653 function room_mt:process_form(origin, stanza)
654         local query = stanza.tags[1];
655         local form;
656         for _, tag in ipairs(query.tags) do if tag.name == "x" and tag.attr.xmlns == "jabber:x:data" then form = tag; break; end end
657         if not form then origin.send(st.error_reply(stanza, "cancel", "service-unavailable")); return; end
658         if form.attr.type == "cancel" then origin.send(st.reply(stanza)); return; end
659         if form.attr.type ~= "submit" then origin.send(st.error_reply(stanza, "cancel", "bad-request", "Not a submitted form")); return; end
660
661         local fields = self:get_form_layout(stanza.attr.from):data(form);
662         if fields.FORM_TYPE ~= "http://jabber.org/protocol/muc#roomconfig" then origin.send(st.error_reply(stanza, "cancel", "bad-request", "Form is not of type room configuration")); return; end
663
664
665         local changed = {};
666
667         local function handle_option(name, field, allowed)
668                 local new = fields[field];
669                 if new == nil then return; end
670                 if allowed and not allowed[new] then return; end
671                 if new == self["get_"..name](self) then return; end
672                 changed[name] = true;
673                 self["set_"..name](self, new);
674         end
675
676         local event = { room = self, fields = fields, changed = changed, stanza = stanza, origin = origin, update_option = handle_option };
677         module:fire_event("muc-config-submitted", event);
678
679         handle_option("name", "muc#roomconfig_roomname");
680         handle_option("description", "muc#roomconfig_roomdesc");
681         handle_option("persistent", "muc#roomconfig_persistentroom");
682         handle_option("moderated", "muc#roomconfig_moderatedroom");
683         handle_option("members_only", "muc#roomconfig_membersonly");
684         handle_option("public", "muc#roomconfig_publicroom");
685         handle_option("changesubject", "muc#roomconfig_changesubject");
686         handle_option("historylength", "muc#roomconfig_historylength");
687         handle_option("whois", "muc#roomconfig_whois", valid_whois);
688         handle_option("password", "muc#roomconfig_roomsecret");
689
690         if self.save then self:save(true); end
691         origin.send(st.reply(stanza));
692
693         if next(changed) then
694                 local msg = st.message({type='groupchat', from=self.jid})
695                         :tag('x', {xmlns='http://jabber.org/protocol/muc#user'}):up()
696                                 :tag('status', {code = '104'}):up();
697                 if changed.whois then
698                         local code = (self:get_whois() == 'moderators') and "173" or "172";
699                         msg.tags[1]:tag('status', {code = code}):up();
700                 end
701                 self:broadcast_message(msg, false)
702         end
703 end
704
705 function room_mt:destroy(newjid, reason, password)
706         local pr = st.presence({type = "unavailable"})
707                 :tag("x", {xmlns = "http://jabber.org/protocol/muc#user"})
708                         :tag("item", { affiliation='none', role='none' }):up()
709                         :tag("destroy", {jid=newjid})
710         if reason then pr:tag("reason"):text(reason):up(); end
711         if password then pr:tag("password"):text(password):up(); end
712         for nick, occupant in pairs(self._occupants) do
713                 pr.attr.from = nick;
714                 for jid in pairs(occupant.sessions) do
715                         pr.attr.to = jid;
716                         self:_route_stanza(pr);
717                         self._jid_nick[jid] = nil;
718                 end
719                 self._occupants[nick] = nil;
720         end
721         self:set_persistent(false);
722         module:fire_event("muc-room-destroyed", { room = self });
723 end
724
725 function room_mt:handle_to_room(origin, stanza) -- presence changes and groupchat messages, along with disco/etc
726         local type = stanza.attr.type;
727         local xmlns = stanza.tags[1] and stanza.tags[1].attr.xmlns;
728         if stanza.name == "iq" then
729                 if xmlns == "http://jabber.org/protocol/disco#info" and type == "get" and not stanza.tags[1].attr.node then
730                         origin.send(self:get_disco_info(stanza));
731                 elseif xmlns == "http://jabber.org/protocol/disco#items" and type == "get" and not stanza.tags[1].attr.node then
732                         origin.send(self:get_disco_items(stanza));
733                 elseif xmlns == "http://jabber.org/protocol/muc#admin" then
734                         local actor = stanza.attr.from;
735                         local affiliation = self:get_affiliation(actor);
736                         local current_nick = self._jid_nick[actor];
737                         local role = current_nick and self._occupants[current_nick].role or self:get_default_role(affiliation);
738                         local item = stanza.tags[1].tags[1];
739                         if item and item.name == "item" then
740                                 if type == "set" then
741                                         local callback = function() origin.send(st.reply(stanza)); end
742                                         if item.attr.jid then -- Validate provided JID
743                                                 item.attr.jid = jid_prep(item.attr.jid);
744                                                 if not item.attr.jid then
745                                                         origin.send(st.error_reply(stanza, "modify", "jid-malformed"));
746                                                         return;
747                                                 end
748                                         end
749                                         if not item.attr.jid and item.attr.nick then -- COMPAT Workaround for Miranda sending 'nick' instead of 'jid' when changing affiliation
750                                                 local occupant = self._occupants[self.jid.."/"..item.attr.nick];
751                                                 if occupant then item.attr.jid = occupant.jid; end
752                                         elseif not item.attr.nick and item.attr.jid then
753                                                 local nick = self._jid_nick[item.attr.jid];
754                                                 if nick then item.attr.nick = select(3, jid_split(nick)); end
755                                         end
756                                         local reason = item.tags[1] and item.tags[1].name == "reason" and #item.tags[1] == 1 and item.tags[1][1];
757                                         if item.attr.affiliation and item.attr.jid and not item.attr.role then
758                                                 local success, errtype, err = self:set_affiliation(actor, item.attr.jid, item.attr.affiliation, callback, reason);
759                                                 if not success then origin.send(st.error_reply(stanza, errtype, err)); end
760                                         elseif item.attr.role and item.attr.nick and not item.attr.affiliation then
761                                                 local success, errtype, err = self:set_role(actor, self.jid.."/"..item.attr.nick, item.attr.role, callback, reason);
762                                                 if not success then origin.send(st.error_reply(stanza, errtype, err)); end
763                                         else
764                                                 origin.send(st.error_reply(stanza, "cancel", "bad-request"));
765                                         end
766                                 elseif type == "get" then
767                                         local _aff = item.attr.affiliation;
768                                         local _rol = item.attr.role;
769                                         if _aff and not _rol then
770                                                 if affiliation == "owner" or (affiliation == "admin" and _aff ~= "owner" and _aff ~= "admin") then
771                                                         local reply = st.reply(stanza):query("http://jabber.org/protocol/muc#admin");
772                                                         for jid, affiliation in pairs(self._affiliations) do
773                                                                 if affiliation == _aff then
774                                                                         reply:tag("item", {affiliation = _aff, jid = jid}):up();
775                                                                 end
776                                                         end
777                                                         origin.send(reply);
778                                                 else
779                                                         origin.send(st.error_reply(stanza, "auth", "forbidden"));
780                                                 end
781                                         elseif _rol and not _aff then
782                                                 if role == "moderator" then
783                                                         -- TODO allow admins and owners not in room? Provide read-only access to everyone who can see the participants anyway?
784                                                         if _rol == "none" then _rol = nil; end
785                                                         local reply = st.reply(stanza):query("http://jabber.org/protocol/muc#admin");
786                                                         for occupant_jid, occupant in pairs(self._occupants) do
787                                                                 if occupant.role == _rol then
788                                                                         reply:tag("item", {
789                                                                                 nick = select(3, jid_split(occupant_jid)),
790                                                                                 role = _rol or "none",
791                                                                                 affiliation = occupant.affiliation or "none",
792                                                                                 jid = occupant.jid
793                                                                                 }):up();
794                                                                 end
795                                                         end
796                                                         origin.send(reply);
797                                                 else
798                                                         origin.send(st.error_reply(stanza, "auth", "forbidden"));
799                                                 end
800                                         else
801                                                 origin.send(st.error_reply(stanza, "cancel", "bad-request"));
802                                         end
803                                 end
804                         elseif type == "set" or type == "get" then
805                                 origin.send(st.error_reply(stanza, "cancel", "bad-request"));
806                         end
807                 elseif xmlns == "http://jabber.org/protocol/muc#owner" and (type == "get" or type == "set") and stanza.tags[1].name == "query" then
808                         if self:get_affiliation(stanza.attr.from) ~= "owner" then
809                                 origin.send(st.error_reply(stanza, "auth", "forbidden", "Only owners can configure rooms"));
810                         elseif stanza.attr.type == "get" then
811                                 self:send_form(origin, stanza);
812                         elseif stanza.attr.type == "set" then
813                                 local child = stanza.tags[1].tags[1];
814                                 if not child then
815                                         origin.send(st.error_reply(stanza, "modify", "bad-request"));
816                                 elseif child.name == "destroy" then
817                                         local newjid = child.attr.jid;
818                                         local reason, password;
819                                         for _,tag in ipairs(child.tags) do
820                                                 if tag.name == "reason" then
821                                                         reason = #tag.tags == 0 and tag[1];
822                                                 elseif tag.name == "password" then
823                                                         password = #tag.tags == 0 and tag[1];
824                                                 end
825                                         end
826                                         self:destroy(newjid, reason, password);
827                                         origin.send(st.reply(stanza));
828                                 else
829                                         self:process_form(origin, stanza);
830                                 end
831                         end
832                 elseif type == "set" or type == "get" then
833                         origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
834                 end
835         elseif stanza.name == "message" and type == "groupchat" then
836                 local from = stanza.attr.from;
837                 local current_nick = self._jid_nick[from];
838                 local occupant = self._occupants[current_nick];
839                 if not occupant then -- not in room
840                         origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));
841                 elseif occupant.role == "visitor" then
842                         origin.send(st.error_reply(stanza, "auth", "forbidden"));
843                 else
844                         local from = stanza.attr.from;
845                         stanza.attr.from = current_nick;
846                         local subject = stanza:get_child_text("subject");
847                         if subject then
848                                 if occupant.role == "moderator" or
849                                         ( self._data.changesubject and occupant.role == "participant" ) then -- and participant
850                                         self:set_subject(current_nick, subject);
851                                 else
852                                         stanza.attr.from = from;
853                                         origin.send(st.error_reply(stanza, "auth", "forbidden"));
854                                 end
855                         else
856                                 self:broadcast_message(stanza, self:get_historylength() > 0 and stanza:get_child("body"));
857                         end
858                         stanza.attr.from = from;
859                 end
860         elseif stanza.name == "message" and type == "error" and is_kickable_error(stanza) then
861                 local current_nick = self._jid_nick[stanza.attr.from];
862                 log("debug", "%s kicked from %s for sending an error message", current_nick, self.jid);
863                 self:handle_to_occupant(origin, build_unavailable_presence_from_error(stanza)); -- send unavailable
864         elseif stanza.name == "presence" then -- hack - some buggy clients send presence updates to the room rather than their nick
865                 local to = stanza.attr.to;
866                 local current_nick = self._jid_nick[stanza.attr.from];
867                 if current_nick then
868                         stanza.attr.to = current_nick;
869                         self:handle_to_occupant(origin, stanza);
870                         stanza.attr.to = to;
871                 elseif type ~= "error" and type ~= "result" then
872                         origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
873                 end
874         elseif stanza.name == "message" and not(type == "chat" or type == "error" or type == "groupchat" or type == "headline") and #stanza.tags == 1
875                 and self._jid_nick[stanza.attr.from] and stanza.tags[1].name == "x" and stanza.tags[1].attr.xmlns == "http://jabber.org/protocol/muc#user" then
876                 local x = stanza.tags[1];
877                 local payload = (#x.tags == 1 and x.tags[1]);
878                 if payload and payload.name == "invite" and payload.attr.to then
879                         local _from, _to = stanza.attr.from, stanza.attr.to;
880                         local _invitee = jid_prep(payload.attr.to);
881                         if _invitee then
882                                 local _reason = payload.tags[1] and payload.tags[1].name == 'reason' and #payload.tags[1].tags == 0 and payload.tags[1][1];
883                                 local invite = st.message({from = _to, to = _invitee, id = stanza.attr.id})
884                                         :tag('x', {xmlns='http://jabber.org/protocol/muc#user'})
885                                                 :tag('invite', {from=_from})
886                                                         :tag('reason'):text(_reason or ""):up()
887                                                 :up();
888                                                 if self:get_password() then
889                                                         invite:tag("password"):text(self:get_password()):up();
890                                                 end
891                                         invite:up()
892                                         :tag('x', {xmlns="jabber:x:conference", jid=_to}) -- COMPAT: Some older clients expect this
893                                                 :text(_reason or "")
894                                         :up()
895                                         :tag('body') -- Add a plain message for clients which don't support invites
896                                                 :text(_from..' invited you to the room '.._to..(_reason and (' ('.._reason..')') or ""))
897                                         :up();
898                                 if self:get_members_only() and not self:get_affiliation(_invitee) then
899                                         log("debug", "%s invited %s into members only room %s, granting membership", _from, _invitee, _to);
900                                         self:set_affiliation(_from, _invitee, "member", nil, "Invited by " .. self._jid_nick[_from])
901                                 end
902                                 self:_route_stanza(invite);
903                         else
904                                 origin.send(st.error_reply(stanza, "cancel", "jid-malformed"));
905                         end
906                 else
907                         origin.send(st.error_reply(stanza, "cancel", "bad-request"));
908                 end
909         else
910                 if type == "error" or type == "result" then return; end
911                 origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
912         end
913 end
914
915 function room_mt:handle_stanza(origin, stanza)
916         local to_node, to_host, to_resource = jid_split(stanza.attr.to);
917         if to_resource then
918                 self:handle_to_occupant(origin, stanza);
919         else
920                 self:handle_to_room(origin, stanza);
921         end
922 end
923
924 function room_mt:route_stanza(stanza) end -- Replace with a routing function, e.g., function(room, stanza) core_route_stanza(origin, stanza); end
925
926 function room_mt:get_affiliation(jid)
927         local node, host, resource = jid_split(jid);
928         local bare = node and node.."@"..host or host;
929         local result = self._affiliations[bare]; -- Affiliations are granted, revoked, and maintained based on the user's bare JID.
930         if not result and self._affiliations[host] == "outcast" then result = "outcast"; end -- host banned
931         return result;
932 end
933 function room_mt:set_affiliation(actor, jid, affiliation, callback, reason)
934         jid = jid_bare(jid);
935         if affiliation == "none" then affiliation = nil; end
936         if affiliation and affiliation ~= "outcast" and affiliation ~= "owner" and affiliation ~= "admin" and affiliation ~= "member" then
937                 return nil, "modify", "not-acceptable";
938         end
939         if actor ~= true then
940                 local actor_affiliation = self:get_affiliation(actor);
941                 local target_affiliation = self:get_affiliation(jid);
942                 if target_affiliation == affiliation then -- no change, shortcut
943                         if callback then callback(); end
944                         return true;
945                 end
946                 if actor_affiliation ~= "owner" then
947                         if affiliation == "owner" or affiliation == "admin" or actor_affiliation ~= "admin" or target_affiliation == "owner" or target_affiliation == "admin" then
948                                 return nil, "cancel", "not-allowed";
949                         end
950                 elseif target_affiliation == "owner" and jid_bare(actor) == jid then -- self change
951                         local is_last = true;
952                         for j, aff in pairs(self._affiliations) do if j ~= jid and aff == "owner" then is_last = false; break; end end
953                         if is_last then
954                                 return nil, "cancel", "conflict";
955                         end
956                 end
957         end
958         self._affiliations[jid] = affiliation;
959         local role = self:get_default_role(affiliation);
960         local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"})
961                         :tag("item", {affiliation=affiliation or "none", role=role or "none"})
962                                 :tag("reason"):text(reason or ""):up()
963                         :up();
964         local presence_type = nil;
965         if not role then -- getting kicked
966                 presence_type = "unavailable";
967                 if affiliation == "outcast" then
968                         x:tag("status", {code="301"}):up(); -- banned
969                 else
970                         x:tag("status", {code="321"}):up(); -- affiliation change
971                 end
972         end
973         local modified_nicks = {};
974         for nick, occupant in pairs(self._occupants) do
975                 if jid_bare(occupant.jid) == jid then
976                         if not role then -- getting kicked
977                                 self._occupants[nick] = nil;
978                         else
979                                 occupant.affiliation, occupant.role = affiliation, role;
980                         end
981                         for jid,pres in pairs(occupant.sessions) do -- remove for all sessions of the nick
982                                 if not role then self._jid_nick[jid] = nil; end
983                                 local p = st.clone(pres);
984                                 p.attr.from = nick;
985                                 p.attr.type = presence_type;
986                                 p.attr.to = jid;
987                                 p:add_child(x);
988                                 self:_route_stanza(p);
989                                 if occupant.jid == jid then
990                                         modified_nicks[nick] = p;
991                                 end
992                         end
993                 end
994         end
995         if self.save then self:save(); end
996         if callback then callback(); end
997         for nick,p in pairs(modified_nicks) do
998                 p.attr.from = nick;
999                 self:broadcast_except_nick(p, nick);
1000         end
1001         return true;
1002 end
1003
1004 function room_mt:get_role(nick)
1005         local session = self._occupants[nick];
1006         return session and session.role or nil;
1007 end
1008 function room_mt:can_set_role(actor_jid, occupant_jid, role)
1009         local occupant = self._occupants[occupant_jid];
1010         if not occupant or not actor_jid then return nil, "modify", "not-acceptable"; end
1011
1012         if actor_jid == true then return true; end
1013
1014         local actor = self._occupants[self._jid_nick[actor_jid]];
1015         if actor.role == "moderator" then
1016                 if occupant.affiliation ~= "owner" and occupant.affiliation ~= "admin" then
1017                         if actor.affiliation == "owner" or actor.affiliation == "admin" then
1018                                 return true;
1019                         elseif occupant.role ~= "moderator" and role ~= "moderator" then
1020                                 return true;
1021                         end
1022                 end
1023         end
1024         return nil, "cancel", "not-allowed";
1025 end
1026 function room_mt:set_role(actor, occupant_jid, role, callback, reason)
1027         if role == "none" then role = nil; end
1028         if role and role ~= "moderator" and role ~= "participant" and role ~= "visitor" then return nil, "modify", "not-acceptable"; end
1029         local allowed, err_type, err_condition = self:can_set_role(actor, occupant_jid, role);
1030         if not allowed then return allowed, err_type, err_condition; end
1031         local occupant = self._occupants[occupant_jid];
1032         local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"})
1033                         :tag("item", {affiliation=occupant.affiliation or "none", nick=select(3, jid_split(occupant_jid)), role=role or "none"})
1034                                 :tag("reason"):text(reason or ""):up()
1035                         :up();
1036         local presence_type = nil;
1037         if not role then -- kick
1038                 presence_type = "unavailable";
1039                 self._occupants[occupant_jid] = nil;
1040                 for jid in pairs(occupant.sessions) do -- remove for all sessions of the nick
1041                         self._jid_nick[jid] = nil;
1042                 end
1043                 x:tag("status", {code = "307"}):up();
1044         else
1045                 occupant.role = role;
1046         end
1047         local bp;
1048         for jid,pres in pairs(occupant.sessions) do -- send to all sessions of the nick
1049                 local p = st.clone(pres);
1050                 p.attr.from = occupant_jid;
1051                 p.attr.type = presence_type;
1052                 p.attr.to = jid;
1053                 p:add_child(x);
1054                 self:_route_stanza(p);
1055                 if occupant.jid == jid then
1056                         bp = p;
1057                 end
1058         end
1059         if callback then callback(); end
1060         if bp then
1061                 self:broadcast_except_nick(bp, occupant_jid);
1062         end
1063         return true;
1064 end
1065
1066 function room_mt:_route_stanza(stanza)
1067         local muc_child;
1068         local to_occupant = self._occupants[self._jid_nick[stanza.attr.to]];
1069         local from_occupant = self._occupants[stanza.attr.from];
1070         if stanza.name == "presence" then
1071                 if to_occupant and from_occupant then
1072                         if self._data.whois == 'anyone' then
1073                             muc_child = stanza:get_child("x", "http://jabber.org/protocol/muc#user");
1074                         else
1075                                 if to_occupant.role == "moderator" or jid_bare(to_occupant.jid) == jid_bare(from_occupant.jid) then
1076                                         muc_child = stanza:get_child("x", "http://jabber.org/protocol/muc#user");
1077                                 end
1078                         end
1079                 end
1080         end
1081         if muc_child then
1082                 for _, item in pairs(muc_child.tags) do
1083                         if item.name == "item" then
1084                                 if from_occupant == to_occupant then
1085                                         item.attr.jid = stanza.attr.to;
1086                                 else
1087                                         item.attr.jid = from_occupant.jid;
1088                                 end
1089                         end
1090                 end
1091         end
1092         self:route_stanza(stanza);
1093         if muc_child then
1094                 for _, item in pairs(muc_child.tags) do
1095                         if item.name == "item" then
1096                                 item.attr.jid = nil;
1097                         end
1098                 end
1099         end
1100 end
1101
1102 local _M = {}; -- module "muc"
1103
1104 function _M.new_room(jid, config)
1105         return setmetatable({
1106                 jid = jid;
1107                 _jid_nick = {};
1108                 _occupants = {};
1109                 _data = {
1110                     whois = 'moderators';
1111                     history_length = math.min((config and config.history_length)
1112                         or default_history_length, max_history_length);
1113                 };
1114                 _affiliations = {};
1115         }, room_mt);
1116 end
1117
1118 function _M.set_max_history_length(_max_history_length)
1119         max_history_length = _max_history_length or math.huge;
1120 end
1121
1122 _M.room_mt = room_mt;
1123
1124 return _M;