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 = pairs;
  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 jid_join = require "util.jid".join;
  21 local st = require "util.stanza";
  22 local base64 = require "util.encodings".base64;
  23 local md5 = require "util.hashes".md5;
  24
  25 local log = module._log;
  26
  27 local occupant_lib = module:require "muc/occupant"
  28 local muc_util = module:require "muc/util";
  29 local is_kickable_error = muc_util.is_kickable_error;
  30 local valid_roles, valid_affiliations = muc_util.valid_roles, muc_util.valid_affiliations;
  31
  32 local room_mt = {};
  33 room_mt.__index = room_mt;
  34
  35 function room_mt:__tostring()
  36         return "MUC room ("..self.jid..")";
  37 end
  38
  39 function room_mt.save()
  40         -- overriden by mod_muc.lua
  41 end
  42
  43 function room_mt:get_occupant_jid(real_jid)
  44         return self._jid_nick[real_jid]
  45 end
  46
  47 function room_mt:get_default_role(affiliation)
  48         local role = module:fire_event("muc-get-default-role", {
  49                 room = self;
  50                 affiliation = affiliation;
  51                 affiliation_rank = valid_affiliations[affiliation or "none"];
  52         });
  53         return role, valid_roles[role or "none"];
  54 end
  55 module:hook("muc-get-default-role", function(event)
  56         if event.affiliation_rank >= valid_affiliations.admin then
  57                 return "moderator";
  58         elseif event.affiliation_rank >= valid_affiliations.none then
  59                 return "participant";
  60         end
  61 end);
  62
  63 --- Occupant functions
  64 function room_mt:new_occupant(bare_real_jid, nick)
  65         local occupant = occupant_lib.new(bare_real_jid, nick);
  66         local affiliation = self:get_affiliation(bare_real_jid);
  67         occupant.role = self:get_default_role(affiliation);
  68         return occupant;
  69 end
  70
  71 function room_mt:get_occupant_by_nick(nick)
  72         local occupant = self._occupants[nick];
  73         if occupant == nil then return nil end
  74         return occupant_lib.copy(occupant);
  75 end
  76
  77 do
  78         local function next_copied_occupant(occupants, occupant_jid)
  79                 local next_occupant_jid, raw_occupant = next(occupants, occupant_jid);
  80                 if next_occupant_jid == nil then return nil end
  81                 return next_occupant_jid, occupant_lib.copy(raw_occupant);
  82         end
  83         -- FIXME Explain what 'read_only' is supposed to be
  84         function room_mt:each_occupant(read_only) -- luacheck: ignore 212
  85                 return next_copied_occupant, self._occupants, nil;
  86         end
  87 end
  88
  89 function room_mt:has_occupant()
  90         return next(self._occupants, nil) ~= nil
  91 end
  92
  93 function room_mt:get_occupant_by_real_jid(real_jid)
  94         local occupant_jid = self:get_occupant_jid(real_jid);
  95         if occupant_jid == nil then return nil end
  96         return self:get_occupant_by_nick(occupant_jid);
  97 end
  98
  99 function room_mt:save_occupant(occupant)
 100         occupant = occupant_lib.copy(occupant); -- So that occupant can be modified more
 101         local id = occupant.nick
 102
 103         -- Need to maintain _jid_nick secondary index
 104         local old_occupant = self._occupants[id];
 105         if old_occupant then
 106                 for real_jid in old_occupant:each_session() do
 107                         self._jid_nick[real_jid] = nil;
 108                 end
 109         end
 110
 111         local has_live_session = false
 112         if occupant.role ~= nil then
 113                 for real_jid, presence in occupant:each_session() do
 114                         if presence.attr.type == nil then
 115                                 has_live_session = true
 116                                 self._jid_nick[real_jid] = occupant.nick;
 117                         end
 118                 end
 119                 if not has_live_session then
 120                         -- Has no live sessions left; they have left the room.
 121                         occupant.role = nil
 122                 end
 123         end
 124         if not has_live_session then
 125                 occupant = nil
 126         end
 127         self._occupants[id] = occupant
 128 end
 129
 130 function room_mt:route_to_occupant(occupant, stanza)
 131         local to = stanza.attr.to;
 132         for jid in occupant:each_session() do
 133                 stanza.attr.to = jid;
 134                 self:route_stanza(stanza);
 135         end
 136         stanza.attr.to = to;
 137 end
 138
 139 -- actor is the attribute table
 140 local function add_item(x, affiliation, role, jid, nick, actor_nick, actor_jid, reason)
 141         x:tag("item", {affiliation = affiliation; role = role; jid = jid; nick = nick;})
 142         if actor_nick or actor_jid then
 143                 x:tag("actor", {nick = actor_nick; jid = actor_jid;}):up()
 144         end
 145         if reason then
 146                 x:tag("reason"):text(reason):up()
 147         end
 148         x:up();
 149         return x
 150 end
 151
 152 -- actor is (real) jid
 153 function room_mt:build_item_list(occupant, x, is_anonymous, nick, actor_nick, actor_jid, reason)
 154         local affiliation = self:get_affiliation(occupant.bare_jid) or "none";
 155         local role = occupant.role or "none";
 156         if is_anonymous then
 157                 add_item(x, affiliation, role, nil, nick, actor_nick, actor_jid, reason);
 158         else
 159                 for real_jid in occupant:each_session() do
 160                         add_item(x, affiliation, role, real_jid, nick, actor_nick, actor_jid, reason);
 161                 end
 162         end
 163         return x
 164 end
 165
 166 function room_mt:broadcast_message(stanza)
 167         if module:fire_event("muc-broadcast-message", {room = self, stanza = stanza}) then
 168                 return true;
 169         end
 170         self:broadcast(stanza);
 171         return true;
 172 end
 173
 174 -- Broadcast a stanza to all occupants in the room.
 175 -- optionally checks conditional called with (nick, occupant)
 176 function room_mt:broadcast(stanza, cond_func)
 177         for nick, occupant in self:each_occupant() do
 178                 if cond_func == nil or cond_func(nick, occupant) then
 179                         self:route_to_occupant(occupant, stanza)
 180                 end
 181         end
 182 end
 183
 184 local function can_see_real_jids(whois, occupant)
 185         if whois == "anyone" then
 186                 return true;
 187         elseif whois == "moderators" then
 188                 return valid_roles[occupant.role or "none"] >= valid_roles.moderator;
 189         end
 190 end
 191
 192 -- Broadcasts an occupant's presence to the whole room
 193 -- Takes the x element that goes into the stanzas
 194 function room_mt:publicise_occupant_status(occupant, base_x, nick, actor, reason)
 195         -- Build real jid and (optionally) occupant jid template presences
 196         local base_presence do
 197                 -- Try to use main jid's presence
 198                 local pr = occupant:get_presence();
 199                 if pr and (pr.attr.type ~= "unavailable" and occupant.role ~= nil) then
 200                         base_presence = st.clone(pr);
 201                 else -- user is leaving but didn't send a leave presence. make one for them
 202                         base_presence = st.presence {from = occupant.nick; type = "unavailable";};
 203                 end
 204         end
 205
 206         -- Fire event (before full_p and anon_p are created)
 207         local event = {
 208                 room = self; stanza = base_presence; x = base_x;
 209                 occupant = occupant; nick = nick; actor = actor;
 210                 reason = reason;
 211         }
 212         module:fire_event("muc-broadcast-presence", event);
 213
 214         -- Allow muc-broadcast-presence listeners to change things
 215         nick = event.nick;
 216         actor = event.actor;
 217         reason = event.reason;
 218
 219         local whois = self:get_whois();
 220
 221         local actor_nick;
 222         if actor then
 223                 actor_nick = select(3, jid_split(self:get_occupant_jid(actor)));
 224         end
 225
 226         local full_p, full_x;
 227         local function get_full_p()
 228                 if full_p == nil then
 229                         full_x = st.clone(base_x);
 230                         self:build_item_list(occupant, full_x, false, nick, actor_nick, actor, reason);
 231                         full_p = st.clone(base_presence):add_child(full_x);
 232                 end
 233                 return full_p, full_x;
 234         end
 235
 236         local anon_p, anon_x;
 237         local function get_anon_p()
 238                 if anon_p == nil then
 239                         anon_x = st.clone(base_x);
 240                         self:build_item_list(occupant, anon_x, true, nick, actor_nick, nil, reason);
 241                         anon_p = st.clone(base_presence):add_child(anon_x);
 242                 end
 243                 return anon_p, anon_x;
 244         end
 245
 246         local self_p, self_x;
 247         if can_see_real_jids(whois, occupant) then
 248                 self_p, self_x = get_full_p();
 249         else
 250                 -- Can always see your own full jids
 251                 -- But not allowed to see actor's
 252                 self_x = st.clone(base_x);
 253                 self:build_item_list(occupant, self_x, false, nick, actor_nick, nil, reason);
 254                 self_p = st.clone(base_presence):add_child(self_x);
 255         end
 256
 257         -- General populance
 258         for occupant_nick, n_occupant in self:each_occupant() do
 259                 if occupant_nick ~= occupant.nick then
 260                         local pr;
 261                         if can_see_real_jids(whois, n_occupant) then
 262                                 pr = get_full_p();
 263                         elseif occupant.bare_jid == n_occupant.bare_jid then
 264                                 pr = self_p;
 265                         else
 266                                 pr = get_anon_p();
 267                         end
 268                         self:route_to_occupant(n_occupant, pr);
 269                 end
 270         end
 271
 272         -- Presences for occupant itself
 273         self_x:tag("status", {code = "110";}):up();
 274         if occupant.role == nil then
 275                 -- They get an unavailable
 276                 self:route_to_occupant(occupant, self_p);
 277         else
 278                 -- use their own presences as templates
 279                 for full_jid, pr in occupant:each_session() do
 280                         pr = st.clone(pr);
 281                         pr.attr.to = full_jid;
 282                         pr:add_child(self_x);
 283                         self:route_stanza(pr);
 284                 end
 285         end
 286 end
 287
 288 function room_mt:send_occupant_list(to, filter)
 289         local to_bare = jid_bare(to);
 290         local is_anonymous = false;
 291         local whois = self:get_whois();
 292         if whois ~= "anyone" then
 293                 local affiliation = self:get_affiliation(to);
 294                 if affiliation ~= "admin" and affiliation ~= "owner" then
 295                         local occupant = self:get_occupant_by_real_jid(to);
 296                         if not (occupant and can_see_real_jids(whois, occupant)) then
 297                                 is_anonymous = true;
 298                         end
 299                 end
 300         end
 301         for occupant_jid, occupant in self:each_occupant() do
 302                 if filter == nil or filter(occupant_jid, occupant) then
 303                         local x = st.stanza("x", {xmlns='http://jabber.org/protocol/muc#user'});
 304                         self:build_item_list(occupant, x, is_anonymous and to_bare ~= occupant.bare_jid); -- can always see your own jids
 305                         local pres = st.clone(occupant:get_presence());
 306                         pres.attr.to = to;
 307                         pres:add_child(x);
 308                         self:route_stanza(pres);
 309                 end
 310         end
 311 end
 312
 313 function room_mt:get_disco_info(stanza)
 314         local reply = st.reply(stanza):query("http://jabber.org/protocol/disco#info");
 315         local form = dataform.new {
 316                 { name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/protocol/muc#roominfo" };
 317         };
 318         local formdata = {};
 319         module:fire_event("muc-disco#info", {room = self; reply = reply; form = form, formdata = formdata ;});
 320         reply:add_child(form:form(formdata, "result"));
 321         return reply;
 322 end
 323 module:hook("muc-disco#info", function(event)
 324         event.reply:tag("feature", {var = "http://jabber.org/protocol/muc"}):up();
 325 end);
 326 module:hook("muc-disco#info", function(event)
 327         table.insert(event.form, { name = "muc#roominfo_occupants", label = "Number of occupants" });
 328         event.formdata["muc#roominfo_occupants"] = tostring(iterators.count(event.room:each_occupant()));
 329 end);
 330
 331 function room_mt:get_disco_items(stanza)
 332         local reply = st.reply(stanza):query("http://jabber.org/protocol/disco#items");
 333         for room_jid in self:each_occupant() do
 334                 reply:tag("item", {jid = room_jid, name = room_jid:match("/(.*)")}):up();
 335         end
 336         return reply;
 337 end
 338
 339 function room_mt:handle_kickable(origin, stanza) -- luacheck: ignore 212
 340         local real_jid = stanza.attr.from;
 341         local occupant = self:get_occupant_by_real_jid(real_jid);
 342         if occupant == nil then return nil; end
 343         local type, condition, text = stanza:get_error();
 344         local error_message = "Kicked: "..(condition and condition:gsub("%-", " ") or "presence error");
 345         if text then
 346                 error_message = error_message..": "..text;
 347         end
 348         occupant:set_session(real_jid, st.presence({type="unavailable"})
 349                 :tag('status'):text(error_message));
 350         self:save_occupant(occupant);
 351         local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";})
 352                 :tag("status", {code = "307"})
 353         self:publicise_occupant_status(occupant, x);
 354         if occupant.jid == real_jid then -- Was last session
 355                 module:fire_event("muc-occupant-left", {room = self; nick = occupant.nick; occupant = occupant;});
 356         end
 357         return true;
 358 end
 359
 360 if not module:get_option_boolean("muc_compat_create", true) then
 361         module:hook("muc-room-pre-create", function(event)
 362                 local origin, stanza = event.origin, event.stanza;
 363                 if not stanza:get_child("x", "http://jabber.org/protocol/muc") then
 364                         origin.send(st.error_reply(stanza, "cancel", "item-not-found"));
 365                         return true;
 366                 end
 367         end, -1);
 368 end
 369
 370 -- Give the room creator owner affiliation
 371 module:hook("muc-room-pre-create", function(event)
 372         event.room:set_affiliation(true, jid_bare(event.stanza.attr.from), "owner");
 373 end, -1);
 374
 375 -- check if user is banned
 376 module:hook("muc-occupant-pre-join", function(event)
 377         local room, stanza = event.room, event.stanza;
 378         local affiliation = room:get_affiliation(stanza.attr.from);
 379         if affiliation == "outcast" then
 380                 local reply = st.error_reply(stanza, "auth", "forbidden"):up();
 381                 reply.tags[1].attr.code = "403";
 382                 event.origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
 383                 return true;
 384         end
 385 end, -10);
 386
 387 function room_mt:handle_first_presence(origin, stanza)
 388         local real_jid = stanza.attr.from;
 389         local dest_jid = stanza.attr.to;
 390         local bare_jid = jid_bare(real_jid);
 391         if module:fire_event("muc-room-pre-create", {
 392                         room = self;
 393                         origin = origin;
 394                         stanza = stanza;
 395                 }) then return true; end
 396         local is_first_dest_session = true;
 397         local dest_occupant = self:new_occupant(bare_jid, dest_jid);
 398
 399         -- TODO Handle this case sensibly
 400         if not stanza:get_child("x", "http://jabber.org/protocol/muc") then
 401                 module:log("debug", "Room creation without <x>, possibly desynced");
 402         end
 403
 404         if module:fire_event("muc-occupant-pre-join", {
 405                 room = self;
 406                 origin = origin;
 407                 stanza = stanza;
 408                 is_first_session = is_first_dest_session;
 409                 is_new_room = true;
 410                 occupant = dest_occupant;
 411         }) then return true; end
 412
 413         dest_occupant:set_session(real_jid, stanza);
 414         local dest_x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";});
 415         dest_x:tag("status", {code = "201"}):up();
 416         if self:get_whois() == "anyone" then
 417                 dest_x:tag("status", {code = "100"}):up();
 418         end
 419         self:save_occupant(dest_occupant);
 420
 421         self:publicise_occupant_status(dest_occupant, dest_x);
 422
 423         module:fire_event("muc-occupant-joined", {
 424                 room = self;
 425                 nick = dest_occupant.nick;
 426                 occupant = dest_occupant;
 427                 stanza = stanza;
 428                 origin = origin;
 429         });
 430         module:fire_event("muc-occupant-session-new", {
 431                 room = self;
 432                 nick = dest_occupant.nick;
 433                 occupant = dest_occupant;
 434                 stanza = stanza;
 435                 origin = origin;
 436                 jid = real_jid;
 437         });
 438         module:fire_event("muc-room-created", {
 439                 room = self;
 440                 creator = dest_occupant;
 441                 stanza = stanza;
 442                 origin = origin;
 443         });
 444         return true;
 445 end
 446
 447 function room_mt:handle_normal_presence(origin, stanza)
 448         local type = stanza.attr.type;
 449         local real_jid = stanza.attr.from;
 450         local bare_jid = jid_bare(real_jid);
 451         local orig_occupant = self:get_occupant_by_real_jid(real_jid);
 452         if type == "unavailable" and orig_occupant == nil then return true; end -- Unavailable from someone not in the room
 453         local is_first_dest_session;
 454         local dest_occupant;
 455         if type == "unavailable" then -- luacheck: ignore 542
 456                 -- FIXME Why the empty if branch?
 457                 -- dest_occupant = nil
 458         elseif orig_occupant and orig_occupant.nick == stanza.attr.to then -- Just a presence update
 459                 log("debug", "presence update for %s from session %s", orig_occupant.nick, real_jid);
 460                 dest_occupant = orig_occupant;
 461         else
 462                 local dest_jid = stanza.attr.to;
 463                 dest_occupant = self:get_occupant_by_nick(dest_jid);
 464                 if dest_occupant == nil then
 465                         log("debug", "no occupant found for %s; creating new occupant object for %s", dest_jid, real_jid);
 466                         is_first_dest_session = true;
 467                         dest_occupant = self:new_occupant(bare_jid, dest_jid);
 468                 else
 469                         is_first_dest_session = false;
 470                 end
 471         end
 472         local is_last_orig_session;
 473         if orig_occupant ~= nil then
 474                 -- Is there are least 2 sessions?
 475                 local iter, ob, last = orig_occupant:each_session();
 476                 is_last_orig_session = iter(ob, iter(ob, last)) == nil;
 477         end
 478
 479         -- TODO Handle these cases sensibly
 480         local muc_x = stanza:get_child("x", "http://jabber.org/protocol/muc");
 481         if orig_occupant == nil and not muc_x then
 482                 module:log("debug", "Join without <x>, possibly desynced");
 483         elseif orig_occupant ~= nil and muc_x then
 484                 module:log("debug", "Presence update with <x>, possibly desynced");
 485         end
 486
 487         local event, event_name = {
 488                 room = self;
 489                 origin = origin;
 490                 stanza = stanza;
 491                 is_first_session = is_first_dest_session;
 492                 is_last_session = is_last_orig_session;
 493         };
 494         if orig_occupant == nil then
 495                 event_name = "muc-occupant-pre-join";
 496                 event.occupant = dest_occupant;
 497         elseif dest_occupant == nil then
 498                 event_name = "muc-occupant-pre-leave";
 499                 event.occupant = orig_occupant;
 500         else
 501                 event_name = "muc-occupant-pre-change";
 502                 event.orig_occupant = orig_occupant;
 503                 event.dest_occupant = dest_occupant;
 504         end
 505         if module:fire_event(event_name, event) then return true; end
 506
 507         -- Check for nick conflicts
 508         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
 509                 log("debug", "%s couldn't join due to nick conflict: %s", real_jid, dest_occupant.nick);
 510                 local reply = st.error_reply(stanza, "cancel", "conflict"):up();
 511                 reply.tags[1].attr.code = "409";
 512                 origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
 513                 return true;
 514         end
 515
 516         -- Send presence stanza about original occupant
 517         if orig_occupant ~= nil and orig_occupant ~= dest_occupant then
 518                 local orig_x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";});
 519                 local dest_nick;
 520                 if dest_occupant == nil then -- Session is leaving
 521                         log("debug", "session %s is leaving occupant %s", real_jid, orig_occupant.nick);
 522                         if is_last_orig_session then
 523                                 orig_occupant.role = nil;
 524                         end
 525                         orig_occupant:set_session(real_jid, stanza);
 526                 else
 527                         log("debug", "session %s is changing from occupant %s to %s", real_jid, orig_occupant.nick, dest_occupant.nick);
 528                         local generated_unavail = st.presence {from = orig_occupant.nick, to = real_jid, type = "unavailable"};
 529                         orig_occupant:set_session(real_jid, generated_unavail);
 530                         dest_nick = select(3, jid_split(dest_occupant.nick));
 531                         if not is_first_dest_session then -- User is swapping into another pre-existing session
 532                                 log("debug", "session %s is swapping into multisession %s, showing it leave.", real_jid, dest_occupant.nick);
 533                                 -- Show the other session leaving
 534                                 local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";});
 535                                 add_item(x, self:get_affiliation(bare_jid), "none");
 536                                 local pr = st.presence{from = dest_occupant.nick, to = real_jid, type = "unavailable"}
 537                                         :tag("status"):text("you are joining pre-existing session " .. dest_nick):up()
 538                                         :add_child(x);
 539                                 self:route_stanza(pr);
 540                         end
 541                         if is_first_dest_session and is_last_orig_session then -- Normal nick change
 542                                 log("debug", "no sessions in %s left; publically marking as nick change", orig_occupant.nick);
 543                                 orig_x:tag("status", {code = "303";}):up();
 544                         else -- The session itself always needs to see a nick change
 545                                 -- don't want to get our old nick's available presence,
 546                                 -- so remove our session from there, and manually generate an unavailable
 547                                 orig_occupant:remove_session(real_jid);
 548                                 log("debug", "generating nick change for %s", real_jid);
 549                                 local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";});
 550                                 -- self:build_item_list(orig_occupant, x, false, dest_nick); -- COMPAT: clients get confused if they see other items besides their own
 551                                 add_item(x, self:get_affiliation(bare_jid), orig_occupant.role, real_jid, dest_nick);
 552                                 x:tag("status", {code = "303";}):up();
 553                                 x:tag("status", {code = "110";}):up();
 554                                 self:route_stanza(generated_unavail:add_child(x));
 555                                 dest_nick = nil; -- set dest_nick to nil; so general populance doesn't see it for whole orig_occupant
 556                         end
 557                 end
 558                 self:save_occupant(orig_occupant);
 559                 self:publicise_occupant_status(orig_occupant, orig_x, dest_nick);
 560
 561                 if is_last_orig_session then
 562                         module:fire_event("muc-occupant-left", {
 563                                 room = self;
 564                                 nick = orig_occupant.nick;
 565                                 occupant = orig_occupant;
 566                                 origin = origin;
 567                                 stanza = stanza;
 568                         });
 569                 end
 570         end
 571
 572         if dest_occupant ~= nil then
 573                 dest_occupant:set_session(real_jid, stanza);
 574                 local dest_x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";});
 575                 if orig_occupant == nil and self:get_whois() == "anyone" then
 576                         dest_x:tag("status", {code = "100"}):up();
 577                 end
 578                 self:save_occupant(dest_occupant);
 579
 580                 if orig_occupant == nil then
 581                         -- Send occupant list to newly joined user
 582                         self:send_occupant_list(real_jid, function(nick, occupant) -- luacheck: ignore 212
 583                                 -- Don't include self
 584                                 return occupant:get_presence(real_jid) == nil;
 585                         end)
 586                 end
 587                 self:publicise_occupant_status(dest_occupant, dest_x);
 588
 589                 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
 590                         log("debug", "session %s split nicks; showing %s rejoining", real_jid, orig_occupant.nick);
 591                         -- Show the original nick joining again
 592                         local pr = st.clone(orig_occupant:get_presence());
 593                         pr.attr.to = real_jid;
 594                         local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";});
 595                         self:build_item_list(orig_occupant, x, false);
 596                         -- TODO: new status code to inform client this was the multi-session it left?
 597                         pr:add_child(x);
 598                         self:route_stanza(pr);
 599                 end
 600
 601                 if orig_occupant == nil then
 602                         if is_first_dest_session then
 603                                 module:fire_event("muc-occupant-joined", {
 604                                         room = self;
 605                                         nick = dest_occupant.nick;
 606                                         occupant = dest_occupant;
 607                                         stanza = stanza;
 608                                         origin = origin;
 609                                 });
 610                         end
 611                         module:fire_event("muc-occupant-session-new", {
 612                                 room = self;
 613                                 nick = dest_occupant.nick;
 614                                 occupant = dest_occupant;
 615                                 stanza = stanza;
 616                                 origin = origin;
 617                                 jid = real_jid;
 618                         });
 619                 end
 620         end
 621         return true;
 622 end
 623
 624 function room_mt:handle_presence_to_occupant(origin, stanza)
 625         local type = stanza.attr.type;
 626         if type == "error" then -- error, kick em out!
 627                 return self:handle_kickable(origin, stanza)
 628         elseif type == nil or type == "unavailable" then
 629                 return self:handle_normal_presence(origin, stanza);
 630         elseif type ~= 'result' then -- bad type
 631                 if type ~= 'visible' and type ~= 'invisible' then -- COMPAT ejabberd can broadcast or forward XEP-0018 presences
 632                         origin.send(st.error_reply(stanza, "modify", "bad-request")); -- FIXME correct error?
 633                 end
 634         end
 635         return true;
 636 end
 637
 638 function room_mt:handle_iq_to_occupant(origin, stanza)
 639         local from, to = stanza.attr.from, stanza.attr.to;
 640         local type = stanza.attr.type;
 641         local id = stanza.attr.id;
 642         local occupant = self:get_occupant_by_nick(to);
 643         if (type == "error" or type == "result") then
 644                 do -- deconstruct_stanza_id
 645                         if not occupant then return nil; end
 646                         local from_jid, orig_id, to_jid_hash = (base64.decode(id) or ""):match("^(%Z+)%z(%Z*)%z(.+)$");
 647                         if not(from == from_jid or from == jid_bare(from_jid)) then return nil; end
 648                         local from_occupant_jid = self:get_occupant_jid(from_jid);
 649                         if from_occupant_jid == nil then return nil; end
 650                         local session_jid
 651                         for to_jid in occupant:each_session() do
 652                                 if md5(to_jid) == to_jid_hash then
 653                                         session_jid = to_jid;
 654                                         break;
 655                                 end
 656                         end
 657                         if session_jid == nil then return nil; end
 658                         stanza.attr.from, stanza.attr.to, stanza.attr.id = from_occupant_jid, session_jid, orig_id;
 659                 end
 660                 log("debug", "%s sent private iq stanza to %s (%s)", from, to, stanza.attr.to);
 661                 self:route_stanza(stanza);
 662                 stanza.attr.from, stanza.attr.to, stanza.attr.id = from, to, id;
 663                 return true;
 664         else -- Type is "get" or "set"
 665                 local current_nick = self:get_occupant_jid(from);
 666                 if not current_nick then
 667                         origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));
 668                         return true;
 669                 end
 670                 if not occupant then -- recipient not in room
 671                         origin.send(st.error_reply(stanza, "cancel", "item-not-found", "Recipient not in room"));
 672                         return true;
 673                 end
 674                 do -- construct_stanza_id
 675                         stanza.attr.id = base64.encode(occupant.jid.."\0"..stanza.attr.id.."\0"..md5(from));
 676                 end
 677                 stanza.attr.from, stanza.attr.to = current_nick, occupant.jid;
 678                 log("debug", "%s sent private iq stanza to %s (%s)", from, to, occupant.jid);
 679                 if stanza.tags[1].attr.xmlns == 'vcard-temp' then
 680                         stanza.attr.to = jid_bare(stanza.attr.to);
 681                 end
 682                 self:route_stanza(stanza);
 683                 stanza.attr.from, stanza.attr.to, stanza.attr.id = from, to, id;
 684                 return true;
 685         end
 686 end
 687
 688 function room_mt:handle_message_to_occupant(origin, stanza)
 689         local from, to = stanza.attr.from, stanza.attr.to;
 690         local current_nick = self:get_occupant_jid(from);
 691         local type = stanza.attr.type;
 692         if not current_nick then -- not in room
 693                 if type ~= "error" then
 694                         origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));
 695                 end
 696                 return true;
 697         end
 698         if type == "groupchat" then -- groupchat messages not allowed in PM
 699                 origin.send(st.error_reply(stanza, "modify", "bad-request"));
 700                 return true;
 701         elseif type == "error" and is_kickable_error(stanza) then
 702                 log("debug", "%s kicked from %s for sending an error message", current_nick, self.jid);
 703                 return self:handle_kickable(origin, stanza); -- send unavailable
 704         end
 705
 706         local o_data = self:get_occupant_by_nick(to);
 707         if not o_data then
 708                 origin.send(st.error_reply(stanza, "cancel", "item-not-found", "Recipient not in room"));
 709                 return true;
 710         end
 711         log("debug", "%s sent private message stanza to %s (%s)", from, to, o_data.jid);
 712         stanza:tag("x", { xmlns = "http://jabber.org/protocol/muc#user" }):up();
 713         stanza.attr.from = current_nick;
 714         self:route_to_occupant(o_data, stanza)
 715         -- TODO: Remove x tag?
 716         stanza.attr.from = from;
 717         return true;
 718 end
 719
 720 function room_mt:send_form(origin, stanza)
 721         origin.send(st.reply(stanza):query("http://jabber.org/protocol/muc#owner")
 722                 :add_child(self:get_form_layout(stanza.attr.from):form())
 723         );
 724 end
 725
 726 function room_mt:get_form_layout(actor)
 727         local form = dataform.new({
 728                 title = "Configuration for "..self.jid,
 729                 instructions = "Complete and submit this form to configure the room.",
 730                 {
 731                         name = 'FORM_TYPE',
 732                         type = 'hidden',
 733                         value = 'http://jabber.org/protocol/muc#roomconfig'
 734                 }
 735         });
 736         return module:fire_event("muc-config-form", { room = self, actor = actor, form = form }) or form;
 737 end
 738
 739 function room_mt:process_form(origin, stanza)
 740         local form = stanza.tags[1]:get_child("x", "jabber:x:data");
 741         if form.attr.type == "cancel" then
 742                 origin.send(st.reply(stanza));
 743         elseif form.attr.type == "submit" then
 744                 local fields, errors, present;
 745                 if form.tags[1] == nil then -- Instant room
 746                         fields, present = {}, {};
 747                 else
 748                         fields, errors, present = self:get_form_layout(stanza.attr.from):data(form);
 749                         if fields.FORM_TYPE ~= "http://jabber.org/protocol/muc#roomconfig" then
 750                                 origin.send(st.error_reply(stanza, "cancel", "bad-request", "Form is not of type room configuration"));
 751                                 return true;
 752                         end
 753                 end
 754
 755                 local event = {room = self; origin = origin; stanza = stanza; fields = fields; status_codes = {};};
 756                 function event.update_option(name, field, allowed)
 757                         local new = fields[field];
 758                         if new == nil then return; end
 759                         if allowed and not allowed[new] then return; end
 760                         if new == self["get_"..name](self) then return; end
 761                         event.status_codes["104"] = true;
 762                         self["set_"..name](self, new);
 763                         return true;
 764                 end
 765                 module:fire_event("muc-config-submitted", event);
 766                 for submitted_field in pairs(present) do
 767                         event.field, event.value = submitted_field, fields[submitted_field];
 768                         module:fire_event("muc-config-submitted/"..submitted_field, event);
 769                 end
 770                 event.field, event.value = nil, nil;
 771
 772                 self:save(true);
 773                 origin.send(st.reply(stanza));
 774
 775                 if next(event.status_codes) then
 776                         local msg = st.message({type='groupchat', from=self.jid})
 777                                 :tag('x', {xmlns='http://jabber.org/protocol/muc#user'})
 778                         for code in pairs(event.status_codes) do
 779                                 msg:tag("status", {code = code;}):up();
 780                         end
 781                         msg:up();
 782                         self:broadcast_message(msg);
 783                 end
 784         else
 785                 origin.send(st.error_reply(stanza, "cancel", "bad-request", "Not a submitted form"));
 786         end
 787         return true;
 788 end
 789
 790 -- Removes everyone from the room
 791 function room_mt:clear(x)
 792         x = x or st.stanza("x", {xmlns='http://jabber.org/protocol/muc#user'});
 793         local occupants_updated = {};
 794         for nick, occupant in self:each_occupant() do -- luacheck: ignore 213
 795                 occupant.role = nil;
 796                 self:save_occupant(occupant);
 797                 occupants_updated[occupant] = true;
 798         end
 799         for occupant in pairs(occupants_updated) do
 800                 self:publicise_occupant_status(occupant, x);
 801                 module:fire_event("muc-occupant-left", { room = self; nick = occupant.nick; occupant = occupant;});
 802         end
 803 end
 804
 805 function room_mt:destroy(newjid, reason, password)
 806         local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"})
 807                 :tag("item", { affiliation='none', role='none' }):up()
 808                 :tag("destroy", {jid=newjid});
 809         if reason then x:tag("reason"):text(reason):up(); end
 810         if password then x:tag("password"):text(password):up(); end
 811         x:up();
 812         self:clear(x);
 813         module:fire_event("muc-room-destroyed", { room = self });
 814 end
 815
 816 function room_mt:handle_disco_info_get_query(origin, stanza)
 817         origin.send(self:get_disco_info(stanza));
 818         return true;
 819 end
 820
 821 function room_mt:handle_disco_items_get_query(origin, stanza)
 822         origin.send(self:get_disco_items(stanza));
 823         return true;
 824 end
 825
 826 function room_mt:handle_admin_query_set_command(origin, stanza)
 827         local item = stanza.tags[1].tags[1];
 828         if not item then
 829                 origin.send(st.error_reply(stanza, "cancel", "bad-request"));
 830         end
 831         if item.attr.jid then -- Validate provided JID
 832                 item.attr.jid = jid_prep(item.attr.jid);
 833                 if not item.attr.jid then
 834                         origin.send(st.error_reply(stanza, "modify", "jid-malformed"));
 835                         return true;
 836                 end
 837         end
 838         if not item.attr.jid and item.attr.nick then -- COMPAT Workaround for Miranda sending 'nick' instead of 'jid' when changing affiliation
 839                 local occupant = self:get_occupant_by_nick(self.jid.."/"..item.attr.nick);
 840                 if occupant then item.attr.jid = occupant.jid; end
 841         elseif not item.attr.nick and item.attr.jid then
 842                 local nick = self:get_occupant_jid(item.attr.jid);
 843                 if nick then item.attr.nick = select(3, jid_split(nick)); end
 844         end
 845         local actor = stanza.attr.from;
 846         local reason = item:get_child_text("reason");
 847         local success, errtype, err
 848         if item.attr.affiliation and item.attr.jid and not item.attr.role then
 849                 success, errtype, err = self:set_affiliation(actor, item.attr.jid, item.attr.affiliation, reason);
 850         elseif item.attr.role and item.attr.nick and not item.attr.affiliation then
 851                 success, errtype, err = self:set_role(actor, self.jid.."/"..item.attr.nick, item.attr.role, reason);
 852         else
 853                 success, errtype, err = nil, "cancel", "bad-request";
 854         end
 855         self:save(true);
 856         if not success then
 857                 origin.send(st.error_reply(stanza, errtype, err));
 858         else
 859                 origin.send(st.reply(stanza));
 860         end
 861         return true;
 862 end
 863
 864 function room_mt:handle_admin_query_get_command(origin, stanza)
 865         local actor = stanza.attr.from;
 866         local affiliation = self:get_affiliation(actor);
 867         local item = stanza.tags[1].tags[1];
 868         local _aff = item.attr.affiliation;
 869         local _aff_rank = valid_affiliations[_aff or "none"];
 870         local _rol = item.attr.role;
 871         if _aff and _aff_rank and not _rol then
 872                 -- You need to be at least an admin, and be requesting info about your affifiliation or lower
 873                 -- e.g. an admin can't ask for a list of owners
 874                 local affiliation_rank = valid_affiliations[affiliation or "none"];
 875                 if affiliation_rank >= valid_affiliations.admin and affiliation_rank >= _aff_rank then
 876                         local reply = st.reply(stanza):query("http://jabber.org/protocol/muc#admin");
 877                         for jid in self:each_affiliation(_aff or "none") do
 878                                 reply:tag("item", {affiliation = _aff, jid = jid}):up();
 879                         end
 880                         origin.send(reply:up());
 881                         return true;
 882                 else
 883                         origin.send(st.error_reply(stanza, "auth", "forbidden"));
 884                         return true;
 885                 end
 886         elseif _rol and valid_roles[_rol or "none"] and not _aff then
 887                 local role = self:get_role(self:get_occupant_jid(actor)) or self:get_default_role(affiliation);
 888                 if valid_roles[role or "none"] >= valid_roles.moderator then
 889                         if _rol == "none" then _rol = nil; end
 890                         local reply = st.reply(stanza):query("http://jabber.org/protocol/muc#admin");
 891                         -- TODO: whois check here? (though fully anonymous rooms are not supported)
 892                         for occupant_jid, occupant in self:each_occupant() do
 893                                 if occupant.role == _rol then
 894                                         local nick = select(3,jid_split(occupant_jid));
 895                                         self:build_item_list(occupant, reply, false, nick);
 896                                 end
 897                         end
 898                         origin.send(reply:up());
 899                         return true;
 900                 else
 901                         origin.send(st.error_reply(stanza, "auth", "forbidden"));
 902                         return true;
 903                 end
 904         else
 905                 origin.send(st.error_reply(stanza, "cancel", "bad-request"));
 906                 return true;
 907         end
 908 end
 909
 910 function room_mt:handle_owner_query_get_to_room(origin, stanza)
 911         if self:get_affiliation(stanza.attr.from) ~= "owner" then
 912                 origin.send(st.error_reply(stanza, "auth", "forbidden", "Only owners can configure rooms"));
 913                 return true;
 914         end
 915
 916         self:send_form(origin, stanza);
 917         return true;
 918 end
 919 function room_mt:handle_owner_query_set_to_room(origin, stanza)
 920         if self:get_affiliation(stanza.attr.from) ~= "owner" then
 921                 origin.send(st.error_reply(stanza, "auth", "forbidden", "Only owners can configure rooms"));
 922                 return true;
 923         end
 924
 925         local child = stanza.tags[1].tags[1];
 926         if not child then
 927                 origin.send(st.error_reply(stanza, "modify", "bad-request"));
 928                 return true;
 929         elseif child.name == "destroy" then
 930                 local newjid = child.attr.jid;
 931                 local reason = child:get_child_text("reason");
 932                 local password = child:get_child_text("password");
 933                 self:destroy(newjid, reason, password);
 934                 origin.send(st.reply(stanza));
 935                 return true;
 936         elseif child.name == "x" and child.attr.xmlns == "jabber:x:data" then
 937                 return self:process_form(origin, stanza);
 938         else
 939                 origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
 940                 return true;
 941         end
 942 end
 943
 944 function room_mt:handle_groupchat_to_room(origin, stanza)
 945         local from = stanza.attr.from;
 946         local occupant = self:get_occupant_by_real_jid(from);
 947         if module:fire_event("muc-occupant-groupchat", {
 948                 room = self; origin = origin; stanza = stanza; from = from; occupant = occupant;
 949         }) then return true; end
 950         stanza.attr.from = occupant.nick;
 951         self:broadcast_message(stanza);
 952         stanza.attr.from = from;
 953         return true;
 954 end
 955
 956 -- Role check
 957 module:hook("muc-occupant-groupchat", function(event)
 958         local role_rank = valid_roles[event.occupant and event.occupant.role or "none"];
 959         if role_rank <= valid_roles.none then
 960                 event.origin.send(st.error_reply(event.stanza, "cancel", "not-acceptable"));
 961                 return true;
 962         elseif role_rank <= valid_roles.visitor then
 963                 event.origin.send(st.error_reply(event.stanza, "auth", "forbidden"));
 964                 return true;
 965         end
 966 end, 50);
 967
 968 -- hack - some buggy clients send presence updates to the room rather than their nick
 969 function room_mt:handle_presence_to_room(origin, stanza)
 970         local current_nick = self:get_occupant_jid(stanza.attr.from);
 971         local handled
 972         if current_nick then
 973                 local to = stanza.attr.to;
 974                 stanza.attr.to = current_nick;
 975                 handled = self:handle_presence_to_occupant(origin, stanza);
 976                 stanza.attr.to = to;
 977         end
 978         return handled;
 979 end
 980
 981 -- Need visitor role or higher to invite
 982 module:hook("muc-pre-invite", function(event)
 983         local room, stanza = event.room, event.stanza;
 984         local _from = stanza.attr.from;
 985         local inviter = room:get_occupant_by_real_jid(_from);
 986         local role = inviter and inviter.role or room:get_default_role(room:get_affiliation(_from));
 987         if valid_roles[role or "none"] <= valid_roles.visitor then
 988                 event.origin.send(st.error_reply(stanza, "auth", "forbidden"));
 989                 return true;
 990         end
 991 end);
 992
 993 function room_mt:handle_mediated_invite(origin, stanza)
 994         local payload = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("invite");
 995         local invitee = jid_prep(payload.attr.to);
 996         if not invitee then
 997                 origin.send(st.error_reply(stanza, "cancel", "jid-malformed"));
 998                 return true;
 999         elseif module:fire_event("muc-pre-invite", {room = self, origin = origin, stanza = stanza}) then
1000                 return true;
1001         end
1002         local invite = muc_util.filter_muc_x(st.clone(stanza));
1003         invite.attr.from = self.jid;
1004         invite.attr.to = invitee;
1005         invite:tag('x', {xmlns='http://jabber.org/protocol/muc#user'})
1006                         :tag('invite', {from = stanza.attr.from;})
1007                                 :tag('reason'):text(payload:get_child_text("reason")):up()
1008                         :up()
1009                 :up();
1010         if not module:fire_event("muc-invite", {room = self, stanza = invite, origin = origin, incoming = stanza}) then
1011                 self:route_stanza(invite);
1012         end
1013         return true;
1014 end
1015
1016 -- COMPAT: Some older clients expect this
1017 module:hook("muc-invite", function(event)
1018         local room, stanza = event.room, event.stanza;
1019         local invite = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("invite");
1020         local reason = invite:get_child_text("reason");
1021         stanza:tag('x', {xmlns = "jabber:x:conference"; jid = room.jid;})
1022                 :text(reason or "")
1023         :up();
1024 end);
1025
1026 -- Add a plain message for clients which don't support invites
1027 module:hook("muc-invite", function(event)
1028         local room, stanza = event.room, event.stanza;
1029         if not stanza:get_child("body") then
1030                 local invite = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("invite");
1031                 local reason = invite:get_child_text("reason") or "";
1032                 stanza:tag("body")
1033                         :text(invite.attr.from.." invited you to the room "..room.jid..(reason == "" and (" ("..reason..")") or ""))
1034                 :up();
1035         end
1036 end);
1037
1038 function room_mt:handle_mediated_decline(origin, stanza)
1039         local payload = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("decline");
1040         local declinee = jid_prep(payload.attr.to);
1041         if not declinee then
1042                 origin.send(st.error_reply(stanza, "cancel", "jid-malformed"));
1043                 return true;
1044         elseif module:fire_event("muc-pre-decline", {room = self, origin = origin, stanza = stanza}) then
1045                 return true;
1046         end
1047         local decline = muc_util.filter_muc_x(st.clone(stanza));
1048         decline.attr.from = self.jid;
1049         decline.attr.to = declinee;
1050         decline:tag("x", {xmlns = "http://jabber.org/protocol/muc#user"})
1051                         :tag("decline", {from = stanza.attr.from})
1052                                 :tag("reason"):text(payload:get_child_text("reason")):up()
1053                         :up()
1054                 :up();
1055         if not module:fire_event("muc-decline", {room = self, stanza = decline, origin = origin, incoming = stanza}) then
1056                 declinee = decline.attr.to; -- re-fetch, in case event modified it
1057                 local occupant
1058                 if jid_bare(declinee) == self.jid then -- declinee jid is already an in-room jid
1059                         occupant = self:get_occupant_by_nick(declinee);
1060                 end
1061                 if occupant then
1062                         self:route_to_occupant(occupant, decline);
1063                 else
1064                         self:route_stanza(decline);
1065                 end
1066         end
1067         return true;
1068 end
1069
1070 -- Add a plain message for clients which don't support declines
1071 module:hook("muc-decline", function(event)
1072         local room, stanza = event.room, event.stanza;
1073         if not stanza:get_child("body") then
1074                 local decline = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("decline");
1075                 local reason = decline:get_child_text("reason") or "";
1076                 stanza:tag("body")
1077                         :text(decline.attr.from.." declined your invite to the room "..room.jid..(reason == "" and (" ("..reason..")") or ""))
1078                 :up();
1079         end
1080 end);
1081
1082 function room_mt:handle_message_to_room(origin, stanza)
1083         local type = stanza.attr.type;
1084         if type == "groupchat" then
1085                 return self:handle_groupchat_to_room(origin, stanza)
1086         elseif type == "error" and is_kickable_error(stanza) then
1087                 return self:handle_kickable(origin, stanza)
1088         elseif type == nil then
1089                 local x = stanza:get_child("x", "http://jabber.org/protocol/muc#user");
1090                 if x then
1091                         local payload = x.tags[1];
1092                         if payload == nil then --luacheck: ignore 542
1093                                 -- fallthrough
1094                         elseif payload.name == "invite" and payload.attr.to then
1095                                 return self:handle_mediated_invite(origin, stanza)
1096                         elseif payload.name == "decline" and payload.attr.to then
1097                                 return self:handle_mediated_decline(origin, stanza)
1098                         end
1099                         origin.send(st.error_reply(stanza, "cancel", "bad-request"));
1100                         return true;
1101                 end
1102         end
1103 end
1104
1105 function room_mt:route_stanza(stanza) -- luacheck: ignore 212
1106         module:send(stanza);
1107 end
1108
1109 function room_mt:get_affiliation(jid)
1110         local node, host, resource = jid_split(jid);
1111         local bare = node and node.."@"..host or host;
1112         local result = self._affiliations[bare]; -- Affiliations are granted, revoked, and maintained based on the user's bare JID.
1113         if not result and self._affiliations[host] == "outcast" then result = "outcast"; end -- host banned
1114         return result;
1115 end
1116
1117 -- Iterates over jid, affiliation pairs
1118 function room_mt:each_affiliation(with_affiliation)
1119         if not with_affiliation then
1120                 return pairs(self._affiliations);
1121         else
1122                 return function(_affiliations, jid)
1123                         local affiliation;
1124                         repeat -- Iterate until we get a match
1125                                 jid, affiliation = next(_affiliations, jid);
1126                         until jid == nil or affiliation == with_affiliation
1127                         return jid, affiliation;
1128                 end, self._affiliations, nil
1129         end
1130 end
1131
1132 function room_mt:set_affiliation(actor, jid, affiliation, reason)
1133         if not actor then return nil, "modify", "not-acceptable"; end;
1134
1135         local node, host, resource = jid_split(jid);
1136         if not host then return nil, "modify", "not-acceptable"; end
1137         jid = jid_join(node, host); -- Bare
1138         local is_host_only = node == nil;
1139
1140         if valid_affiliations[affiliation or "none"] == nil then
1141                 return nil, "modify", "not-acceptable";
1142         end
1143         affiliation = affiliation ~= "none" and affiliation or nil; -- coerces `affiliation == false` to `nil`
1144
1145         local target_affiliation = self._affiliations[jid]; -- Raw; don't want to check against host
1146         local is_downgrade = valid_affiliations[target_affiliation or "none"] > valid_affiliations[affiliation or "none"];
1147
1148         if actor == true then
1149                 actor = nil -- So we can pass it safely to 'publicise_occupant_status' below
1150         else
1151                 local actor_affiliation = self:get_affiliation(actor);
1152                 if actor_affiliation == "owner" then
1153                         if jid_bare(actor) == jid then -- self change
1154                                 -- need at least one owner
1155                                 local is_last = true;
1156                                 for j in self:each_affiliation("owner") do
1157                                         if j ~= jid then is_last = false; break; end
1158                                 end
1159                                 if is_last then
1160                                         return nil, "cancel", "conflict";
1161                                 end
1162                         end
1163                         -- owners can do anything else
1164                 elseif affiliation == "owner" or affiliation == "admin"
1165                         or actor_affiliation ~= "admin"
1166                         or target_affiliation == "owner" or target_affiliation == "admin" then
1167                         -- Can't demote owners or other admins
1168                         return nil, "cancel", "not-allowed";
1169                 end
1170         end
1171
1172         -- Set in 'database'
1173         self._affiliations[jid] = affiliation;
1174
1175         -- Update roles
1176         local role = self:get_default_role(affiliation);
1177         local role_rank = valid_roles[role or "none"];
1178         local occupants_updated = {}; -- Filled with old roles
1179         for nick, occupant in self:each_occupant() do -- luacheck: ignore 213
1180                 if occupant.bare_jid == jid or (
1181                         -- Outcast can be by host.
1182                         is_host_only and affiliation == "outcast" and select(2, jid_split(occupant.bare_jid)) == host
1183                 ) then
1184                         -- need to publcize in all cases; as affiliation in <item/> has changed.
1185                         occupants_updated[occupant] = occupant.role;
1186                         if occupant.role ~= role and (
1187                                 is_downgrade or
1188                                 valid_roles[occupant.role or "none"] < role_rank -- upgrade
1189                         ) then
1190                                 occupant.role = role;
1191                                 self:save_occupant(occupant);
1192                         end
1193                 end
1194         end
1195
1196         -- Tell the room of the new occupant affiliations+roles
1197         local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"});
1198         if not role then -- getting kicked
1199                 if affiliation == "outcast" then
1200                         x:tag("status", {code="301"}):up(); -- banned
1201                 else
1202                         x:tag("status", {code="321"}):up(); -- affiliation change
1203                 end
1204         end
1205         local is_semi_anonymous = self:get_whois() == "moderators";
1206         for occupant, old_role in pairs(occupants_updated) do
1207                 self:publicise_occupant_status(occupant, x, nil, actor, reason);
1208                 if occupant.role == nil then
1209                         module:fire_event("muc-occupant-left", {room = self; nick = occupant.nick; occupant = occupant;});
1210                 elseif is_semi_anonymous and
1211                         (old_role == "moderator" and occupant.role ~= "moderator") or
1212                         (old_role ~= "moderator" and occupant.role == "moderator") then -- Has gained or lost moderator status
1213                         -- Send everyone else's presences (as jid visibility has changed)
1214                         for real_jid in occupant:each_session() do
1215                                 self:send_occupant_list(real_jid, function(occupant_jid, occupant) --luacheck: ignore 212 433
1216                                         return occupant.bare_jid ~= jid;
1217                                 end);
1218                         end
1219                 end
1220         end
1221
1222         self:save(true);
1223
1224         module:fire_event("muc-set-affiliation", {
1225                 room = self;
1226                 actor = actor;
1227                 jid = jid;
1228                 affiliation = affiliation or "none";
1229                 reason = reason;
1230                 previous_affiliation = target_affiliation;
1231                 in_room = next(occupants_updated) ~= nil;
1232         });
1233
1234         return true;
1235 end
1236
1237 function room_mt:get_role(nick)
1238         local occupant = self:get_occupant_by_nick(nick);
1239         return occupant and occupant.role or nil;
1240 end
1241
1242 function room_mt:set_role(actor, occupant_jid, role, reason)
1243         if not actor then return nil, "modify", "not-acceptable"; end
1244
1245         local occupant = self:get_occupant_by_nick(occupant_jid);
1246         if not occupant then return nil, "modify", "item-not-found"; end
1247
1248         if valid_roles[role or "none"] == nil then
1249                 return nil, "modify", "not-acceptable";
1250         end
1251         role = role ~= "none" and role or nil; -- coerces `role == false` to `nil`
1252
1253         if actor == true then
1254                 actor = nil -- So we can pass it safely to 'publicise_occupant_status' below
1255         else
1256                 -- Can't do anything to other owners or admins
1257                 local occupant_affiliation = self:get_affiliation(occupant.bare_jid);
1258                 if occupant_affiliation == "owner" or occupant_affiliation == "admin" then
1259                         return nil, "cancel", "not-allowed";
1260                 end
1261
1262                 -- If you are trying to give or take moderator role you need to be an owner or admin
1263                 if occupant.role == "moderator" or role == "moderator" then
1264                         local actor_affiliation = self:get_affiliation(actor);
1265                         if actor_affiliation ~= "owner" and actor_affiliation ~= "admin" then
1266                                 return nil, "cancel", "not-allowed";
1267                         end
1268                 end
1269
1270                 -- Need to be in the room and a moderator
1271                 local actor_occupant = self:get_occupant_by_real_jid(actor);
1272                 if not actor_occupant or actor_occupant.role ~= "moderator" then
1273                         return nil, "cancel", "not-allowed";
1274                 end
1275         end
1276
1277         local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"});
1278         if not role then
1279                 x:tag("status", {code = "307"}):up();
1280         end
1281         occupant.role = role;
1282         self:save_occupant(occupant);
1283         self:publicise_occupant_status(occupant, x, nil, actor, reason);
1284         if role == nil then
1285                 module:fire_event("muc-occupant-left", {room = self; nick = occupant.nick; occupant = occupant;});
1286         end
1287         return true;
1288 end
1289
1290 local whois = module:require "muc/whois";
1291 room_mt.get_whois = whois.get;
1292 room_mt.set_whois = whois.set;
1293
1294 local _M = {}; -- module "muc"
1295
1296 function _M.new_room(jid, config)
1297         return setmetatable({
1298                 jid = jid;
1299                 _jid_nick = {};
1300                 _occupants = {};
1301                 _data = config or {};
1302                 _affiliations = {};
1303         }, room_mt);
1304 end
1305
1306 function room_mt:freeze(live)
1307         local frozen, state = {
1308                 _jid = self.jid;
1309                 _data = self._data;
1310         };
1311         for user, affiliation in pairs(self._affiliations) do
1312                 frozen[user] = affiliation;
1313         end
1314         if live then
1315                 state = {};
1316                 for nick, occupant in self:each_occupant() do
1317                         state[nick] = {
1318                                 bare_jid = occupant.bare_jid;
1319                                 role = occupant.role;
1320                                 jid = occupant.jid;
1321                         }
1322                         for jid, presence in occupant:each_session() do
1323                                 state[jid] = st.preserialize(presence);
1324                         end
1325                 end
1326                 local history = self._history;
1327                 if history then
1328                         state._last_message = st.preserialize(history[#history].stanza);
1329                         state._last_message_at = history[#history].timestamp;
1330                 end
1331         end
1332         return frozen, state;
1333 end
1334
1335 function _M.restore_room(frozen, state)
1336         -- COMPAT
1337         if frozen.jid and frozen._affiliations then
1338                 local room = _M.new_room(frozen.jid, frozen._data);
1339                 room._affiliations = frozen._affiliations;
1340                 return room;
1341         end
1342
1343         local room_jid = frozen._jid;
1344         local room = _M.new_room(room_jid, frozen._data);
1345
1346         if state and state._last_message and state._last_message_at then
1347                 room._history = {
1348                         { stanza = st.deserialize(state._last_message),
1349                           timestamp = state._last_message_at, },
1350                 };
1351         end
1352
1353         local occupants = {};
1354         local occupant_sessions = {};
1355         local room_name, room_host = jid_split(room_jid);
1356         for jid, data in pairs(frozen) do
1357                 local node, host, resource = jid_split(jid);
1358                 if host:sub(1,1) ~= "_" and not resource and type(data) == "string" then
1359                         -- bare jid: affiliation
1360                         room._affiliations[jid] = data;
1361                 end
1362         end
1363         for jid, data in pairs(state or frozen) do
1364                 local node, host, resource = jid_split(jid);
1365                 if node or host:sub(1,1) ~= "_" then
1366                         if host == room_host and node == room_name and resource and type(data) == "table" then
1367                                 -- full room jid: bare real jid and role
1368                                 local bare_jid = data.bare_jid;
1369                                 local   occupant = occupant_lib.new(bare_jid, jid);
1370                                 occupant.jid = data.jid;
1371                                 occupant.role = data.role;
1372                                 occupants[bare_jid] = occupant;
1373                                 local sessions = occupant_sessions[bare_jid];
1374                                 if sessions then
1375                                         for full_jid, presence in pairs(sessions) do
1376                                                 occupant:set_session(full_jid, presence);
1377                                         end
1378                                 end
1379                                 occupant_sessions[bare_jid] = nil;
1380                         elseif type(data) == "table" and data.name then
1381                                 -- full user jid: presence
1382                                 local presence = st.deserialize(data);
1383                                 local bare_jid = jid_bare(jid);
1384                                 local occupant = occupants[bare_jid];
1385                                 local sessions = occupant_sessions[bare_jid];
1386                                 if occupant then
1387                                         occupant:set_session(jid, presence);
1388                                 elseif sessions then
1389                                         sessions[jid] = presence;
1390                                 else
1391                                         occupant_sessions[bare_jid] = {
1392                                                 [jid] = presence;
1393                                         };
1394                                 end
1395                         end
1396                 end
1397         end
1398
1399         for _, occupant in pairs(occupants) do
1400                 room:save_occupant(occupant);
1401         end
1402
1403         return room;
1404 end
1405
1406 _M.room_mt = room_mt;
1407
1408 return _M;