plugins/muc/muc.lib.lua

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