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