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