Merge 0.10->trunk
[prosody.git] / plugins / muc / muc.lib.lua
index 39240b16d3ac954ee217d1c254e17f146ba179bf..5debb4a36ada98541951e43ce976fd3878c5f432 100644 (file)
@@ -1,6 +1,7 @@
 -- Prosody IM
 -- Copyright (C) 2008-2010 Matthew Wild
 -- Copyright (C) 2008-2010 Waqas Hussain
+-- Copyright (C) 2014 Daurnimator
 --
 -- This project is MIT/X11 licensed. Please see the
 -- COPYING file in the source package for more information.
@@ -24,44 +25,42 @@ local setmetatable = setmetatable;
 local base64 = require "util.encodings".base64;
 local md5 = require "util.hashes".md5;
 
-local muc_domain = nil; --module:get_host();
 local default_history_length, max_history_length = 20, math.huge;
 
-------------
-local presence_filters = {["http://jabber.org/protocol/muc"]=true;["http://jabber.org/protocol/muc#user"]=true};
-local function presence_filter(tag)
-       if presence_filters[tag.attr.xmlns] then
-               return nil;
+local get_filtered_presence do
+       local presence_filters = {
+               ["http://jabber.org/protocol/muc"] = true;
+               ["http://jabber.org/protocol/muc#user"] = true;
+       }
+       local function presence_filter(tag)
+               if presence_filters[tag.attr.xmlns] then
+                       return nil;
+               end
+               return tag;
+       end
+       function get_filtered_presence(stanza)
+               return st.clone(stanza):maptags(presence_filter);
        end
-       return tag;
-end
-
-local function get_filtered_presence(stanza)
-       return st.clone(stanza):maptags(presence_filter);
-end
-local kickable_error_conditions = {
-       ["gone"] = true;
-       ["internal-server-error"] = true;
-       ["item-not-found"] = true;
-       ["jid-malformed"] = true;
-       ["recipient-unavailable"] = true;
-       ["redirect"] = true;
-       ["remote-server-not-found"] = true;
-       ["remote-server-timeout"] = true;
-       ["service-unavailable"] = true;
-       ["malformed error"] = true;
-};
-
-local function get_error_condition(stanza)
-       local _, condition = stanza:get_error();
-       return condition or "malformed error";
 end
 
-local function is_kickable_error(stanza)
-       local cond = get_error_condition(stanza);
-       return kickable_error_conditions[cond] and cond;
+local is_kickable_error do
+       local kickable_error_conditions = {
+               ["gone"] = true;
+               ["internal-server-error"] = true;
+               ["item-not-found"] = true;
+               ["jid-malformed"] = true;
+               ["recipient-unavailable"] = true;
+               ["redirect"] = true;
+               ["remote-server-not-found"] = true;
+               ["remote-server-timeout"] = true;
+               ["service-unavailable"] = true;
+               ["malformed error"] = true;
+       };
+       function is_kickable_error(stanza)
+               local cond = select(2, stanza:get_error()) or "malformed error";
+               return kickable_error_conditions[cond];
+       end
 end
------------
 
 local room_mt = {};
 room_mt.__index = room_mt;
@@ -70,6 +69,10 @@ function room_mt:__tostring()
        return "MUC room ("..self.jid..")";
 end
 
+function room_mt:get_occupant_jid(real_jid)
+       return self._jid_nick[real_jid]
+end
+
 function room_mt:get_default_role(affiliation)
        if affiliation == "owner" or affiliation == "admin" then
                return "moderator";
@@ -82,6 +85,26 @@ function room_mt:get_default_role(affiliation)
        end
 end
 
+function room_mt:lock()
+       self.locked = true
+end
+function room_mt:unlock()
+       module:fire_event("muc-room-unlocked", { room = self });
+       self.locked = nil
+end
+function room_mt:is_locked()
+       return not not self.locked
+end
+
+function room_mt:route_to_occupant(o_data, stanza)
+       local to = stanza.attr.to;
+       for jid in pairs(o_data.sessions) do
+               stanza.attr.to = jid;
+               self:_route_stanza(stanza);
+       end
+       stanza.attr.to = to;
+end
+
 function room_mt:broadcast_presence(stanza, sid, code, nick)
        stanza = get_filtered_presence(stanza);
        local occupant = self._occupants[stanza.attr.from];
@@ -91,51 +114,49 @@ function room_mt:broadcast_presence(stanza, sid, code, nick)
                stanza:tag("status", {code=code}):up();
        end
        self:broadcast_except_nick(stanza, stanza.attr.from);
-       local me = self._occupants[stanza.attr.from];
-       if me then
-               stanza:tag("status", {code='110'}):up();
-               stanza.attr.to = sid;
-               self:_route_stanza(stanza);
-       end
+       stanza:tag("status", {code='110'}):up();
+       stanza.attr.to = sid;
+       self:_route_stanza(stanza);
 end
 function room_mt:broadcast_message(stanza, historic)
-       local to = stanza.attr.to;
-       for occupant, o_data in pairs(self._occupants) do
-               for jid in pairs(o_data.sessions) do
-                       stanza.attr.to = jid;
-                       self:_route_stanza(stanza);
-               end
-       end
-       stanza.attr.to = to;
-       if historic then -- add to history
-               return self:save_to_history(stanza)
-       end
-end
-function room_mt:save_to_history(stanza)
-       local history = self._data['history'];
-       if not history then history = {}; self._data['history'] = history; end
-       stanza = st.clone(stanza);
-       stanza.attr.to = "";
-       local stamp = datetime.datetime();
-       stanza:tag("delay", {xmlns = "urn:xmpp:delay", from = muc_domain, stamp = stamp}):up(); -- XEP-0203
-       stanza:tag("x", {xmlns = "jabber:x:delay", from = muc_domain, stamp = datetime.legacy()}):up(); -- XEP-0091 (deprecated)
-       local entry = { stanza = stanza, stamp = stamp };
-       t_insert(history, entry);
-       while #history > (self._data.history_length or default_history_length) do t_remove(history, 1) end
-end
+       module:fire_event("muc-broadcast-message", {room = self, stanza = stanza, historic = historic});
+       self:broadcast(stanza);
+end
+
+-- add to history
+module:hook("muc-broadcast-message", function(event)
+       if event.historic then
+               local room = event.room
+               local history = room._data['history'];
+               if not history then history = {}; room._data['history'] = history; end
+               local stanza = st.clone(event.stanza);
+               stanza.attr.to = "";
+               local ts = gettime();
+               local stamp = datetime.datetime(ts);
+               stanza:tag("delay", {xmlns = "urn:xmpp:delay", from = module.host, stamp = stamp}):up(); -- XEP-0203
+               stanza:tag("x", {xmlns = "jabber:x:delay", from = module.host, stamp = datetime.legacy()}):up(); -- XEP-0091 (deprecated)
+               local entry = { stanza = stanza, timestamp = ts };
+               t_insert(history, entry);
+               while #history > room:get_historylength() do t_remove(history, 1) end
+       end
+end)
+
 function room_mt:broadcast_except_nick(stanza, nick)
-       for rnick, occupant in pairs(self._occupants) do
-               if rnick ~= nick then
-                       for jid in pairs(occupant.sessions) do
-                               stanza.attr.to = jid;
-                               self:_route_stanza(stanza);
-                       end
+       return self:broadcast(stanza, function(rnick, occupant) return rnick ~= nick end)
+end
+
+-- Broadcast a stanza to all occupants in the room.
+-- optionally checks conditional called with nicl
+function room_mt:broadcast(stanza, cond_func)
+       for nick, occupant in pairs(self._occupants) do
+               if cond_func == nil or cond_func(nick, occupant) then
+                       self:route_to_occupant(occupant, stanza)
                end
        end
 end
 
 function room_mt:send_occupant_list(to)
-       local current_nick = self._jid_nick[to];
+       local current_nick = self:get_occupant_jid(to);
        for occupant, o_data in pairs(self._occupants) do
                if occupant ~= current_nick then
                        local pres = get_filtered_presence(o_data.sessions[o_data.jid]);
@@ -177,13 +198,17 @@ local function parse_history(stanza)
 
        return maxchars, maxstanzas, since
 end
--- Get history for 'to'
-function room_mt:get_history(to, maxchars, maxstanzas, since)
-       local history = self._data['history']; -- send discussion history
-       if not history then return end
+
+module:hook("muc-get-history", function(event)
+       local room = event.room
+       local history = room._data['history']; -- send discussion history
+       if not history then return nil end
        local history_len = #history
 
-       maxstanzas = maxstanzas or history_len
+       local to = event.to
+       local maxchars = event.maxchars
+       local maxstanzas = event.maxstanzas or history_len
+       local since = event.since
        local n = 0;
        local charcount = 0;
        for i=history_len,1,-1 do
@@ -196,13 +221,13 @@ function room_mt:get_history(to, maxchars, maxstanzas, since)
                        charcount = charcount + entry.chars + #to;
                        if charcount > maxchars then break; end
                end
-               if since and since > entry.stamp then break; end
+               if since and since > entry.timestamp then break; end
                if n + 1 > maxstanzas then break; end
                n = n + 1;
        end
 
        local i = history_len-n+1
-       return function()
+       function event:next_stanza()
                if i > history_len then return nil end
                local entry = history[i]
                local msg = entry.stanza
@@ -210,18 +235,22 @@ function room_mt:get_history(to, maxchars, maxstanzas, since)
                i = i + 1
                return msg
        end
-end
-function room_mt:send_history(to, stanza)
+       return true;
+end)
+
+function room_mt:send_history(stanza)
        local maxchars, maxstanzas, since = parse_history(stanza)
-       for msg in self:get_history(to, maxchars, maxstanzas, since) do
+       local event = {
+               room = self;
+               to = stanza.attr.from; -- `to` is required to calculate the character count for `maxchars`
+               maxchars = maxchars, maxstanzas = maxstanzas, since = since;
+               next_stanza = function() end; -- events should define this iterator
+       }
+       module:fire_event("muc-get-history", event)
+       for msg in event.next_stanza , event do
                self:_route_stanza(msg);
        end
 end
-function room_mt:send_subject(to)
-       if self._data['subject'] then
-               self:_route_stanza(st.message({type='groupchat', from=self._data['subject_from'] or self.jid, to=to}):tag("subject"):text(self._data['subject']));
-       end
-end
 
 function room_mt:get_disco_info(stanza)
        local count = 0; for _ in pairs(self._occupants) do count = count + 1; end
@@ -233,7 +262,7 @@ function room_mt:get_disco_info(stanza)
                :tag("feature", {var=self:get_members_only() and "muc_membersonly" or "muc_open"}):up()
                :tag("feature", {var=self:get_persistent() and "muc_persistent" or "muc_temporary"}):up()
                :tag("feature", {var=self:get_hidden() and "muc_hidden" or "muc_public"}):up()
-               :tag("feature", {var=self._data.whois ~= "anyone" and "muc_semianonymous" or "muc_nonanonymous"}):up()
+               :tag("feature", {var=self:get_whois() ~= "anyone" and "muc_semianonymous" or "muc_nonanonymous"}):up()
                :add_child(dataform.new({
                        { name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/protocol/muc#roominfo" },
                        { name = "muc#roominfo_description", label = "Description", value = "" },
@@ -248,13 +277,30 @@ function room_mt:get_disco_items(stanza)
        end
        return reply;
 end
+
+function room_mt:get_subject()
+       return self._data['subject'], self._data['subject_from']
+end
+local function create_subject_message(subject)
+       return st.message({type='groupchat'})
+               :tag('subject'):text(subject):up();
+end
+function room_mt:send_subject(to)
+       local from, subject = self:get_subject()
+       if subject then
+               local msg = create_subject_message(subject)
+               msg.attr.from = from
+               msg.attr.to = to
+               self:_route_stanza(msg);
+       end
+end
 function room_mt:set_subject(current_nick, subject)
        if subject == "" then subject = nil; end
        self._data['subject'] = subject;
        self._data['subject_from'] = current_nick;
        if self.save then self:save(); end
-       local msg = st.message({type='groupchat', from=current_nick})
-               :tag('subject'):text(subject):up();
+       local msg = create_subject_message(subject)
+       msg.attr.from = current_nick
        self:broadcast_message(msg, false);
        return true;
 end
@@ -384,7 +430,7 @@ end
 
 function room_mt:handle_unavailable_to_occupant(origin, stanza)
        local from = stanza.attr.from;
-       local current_nick = self._jid_nick[from];
+       local current_nick = self:get_occupant_jid(from);
        if not current_nick then
                return true; -- discard
        end
@@ -415,6 +461,7 @@ function room_mt:handle_unavailable_to_occupant(origin, stanza)
                occupant.role = 'none';
                self:broadcast_presence(pr, from);
                self._occupants[current_nick] = nil;
+               module:fire_event("muc-occupant-left", { room = self; nick = current_nick; });
        end
        return true;
 end
@@ -441,13 +488,12 @@ function room_mt:handle_change_nick(origin, stanza, current_nick, to)
                origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
                return true;
        else
-               local data = self._occupants[current_nick];
                local to_nick = select(3, jid_split(to));
-               log("debug", "%s (%s) changing nick to %s", current_nick, data.jid, to);
+               log("debug", "%s (%s) changing nick to %s", current_nick, occupant.jid, to);
                local p = st.presence({type='unavailable', from=current_nick});
                self:broadcast_presence(p, from, '303', to_nick);
                self._occupants[current_nick] = nil;
-               self._occupants[to] = data;
+               self._occupants[to] = occupant;
                self._jid_nick[from] = to;
                local pr = get_filtered_presence(stanza);
                pr.attr.from = to;
@@ -457,19 +503,68 @@ function room_mt:handle_change_nick(origin, stanza, current_nick, to)
        end
 end
 
-function room_mt:handle_join(origin, stanza)
+module:hook("muc-occupant-pre-join", function(event)
+       return module:fire_event("muc-occupant-pre-join/affiliation", event)
+               or module:fire_event("muc-occupant-pre-join/password", event)
+               or module:fire_event("muc-occupant-pre-join/locked", event)
+               or module:fire_event("muc-occupant-pre-join/nick-conflict", event)
+end, -1)
+
+module:hook("muc-occupant-pre-join/password", function(event)
+       local room, stanza = event.room, event.stanza;
        local from, to = stanza.attr.from, stanza.attr.to;
-       log("debug", "%s joining as %s", from, to);
-       if not next(self._affiliations) then -- new room, no owners
-               self._affiliations[jid_bare(from)] = "owner";
-               if self.locked and not stanza:get_child("x", "http://jabber.org/protocol/muc") then
-                       self.locked = nil; -- Older groupchat protocol doesn't lock
-               end
-       elseif self.locked then -- Deny entry
-               origin.send(st.error_reply(stanza, "cancel", "item-not-found"));
+       local password = stanza:get_child("x", "http://jabber.org/protocol/muc");
+       password = password and password:get_child_text("password", "http://jabber.org/protocol/muc");
+       if not password or password == "" then password = nil; end
+       if room:get_password() ~= password then
+               local from, to = stanza.attr.from, stanza.attr.to;
+               log("debug", "%s couldn't join due to invalid password: %s", from, to);
+               local reply = st.error_reply(stanza, "auth", "not-authorized"):up();
+               reply.tags[1].attr.code = "401";
+               event.origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
+               return true;
+       end
+end, -1)
+
+module:hook("muc-occupant-pre-join/nick-conflict", function(event)
+       local room, stanza = event.room, event.stanza;
+       local from, to = stanza.attr.from, stanza.attr.to;
+       local occupant = room._occupants[to]
+       if occupant -- occupant already exists
+               and jid_bare(from) ~= jid_bare(occupant.jid) then -- and has different bare real jid
+               log("debug", "%s couldn't join due to nick conflict: %s", from, to);
+               local reply = st.error_reply(stanza, "cancel", "conflict"):up();
+               reply.tags[1].attr.code = "409";
+               event.origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
+               return true;
+       end
+end, -1)
+
+module:hook("muc-occupant-pre-join/locked", function(event)
+       if event.room:is_locked() then -- Deny entry
+               event.origin.send(st.error_reply(event.stanza, "cancel", "item-not-found"));
                return true;
        end
+end, -1)
+
+function room_mt:handle_join(origin, stanza)
+       local from, to = stanza.attr.from, stanza.attr.to;
        local affiliation = self:get_affiliation(from);
+       if affiliation == nil and next(self._affiliations) == nil then -- new room, no owners
+               affiliation = "owner";
+               self._affiliations[jid_bare(from)] = affiliation;
+               if self:is_locked() and not stanza:get_child("x", "http://jabber.org/protocol/muc") then
+                       self:unlock(); -- Older groupchat protocol doesn't lock
+               end
+       end
+       if module:fire_event("muc-occupant-pre-join", {
+               room = self;
+               origin = origin;
+               stanza = stanza;
+               affiliation = affiliation;
+       }) then return true; end
+       log("debug", "%s joining as %s", from, to);
+
        local role = self:get_default_role(affiliation)
        if role then -- new occupant
                local is_merge = not not self._occupants[to]
@@ -488,10 +583,10 @@ function room_mt:handle_join(origin, stanza)
                        self:broadcast_except_nick(pr, to);
                end
                pr:tag("status", {code='110'}):up();
-               if self._data.whois == 'anyone' then
+               if self:get_whois() == 'anyone' then
                        pr:tag("status", {code='100'}):up();
                end
-               if self.locked then
+               if self:is_locked() then
                        pr:tag("status", {code='201'}):up();
                end
                pr.attr.to = from;
@@ -499,22 +594,32 @@ function room_mt:handle_join(origin, stanza)
                self:send_history(from, stanza);
                self:send_subject(from);
                return true;
-       elseif not affiliation then -- registration required for entering members-only room
-               local reply = st.error_reply(stanza, "auth", "registration-required"):up();
+       end
+end
+
+-- registration required for entering members-only room
+module:hook("muc-occupant-pre-join/affiliation", function(event)
+       if event.affiliation == nil and event.room:get_members_only() then
+               local reply = st.error_reply(event.stanza, "auth", "registration-required"):up();
                reply.tags[1].attr.code = "407";
-               origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
+               event.origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
                return true;
-       else -- banned
-               local reply = st.error_reply(stanza, "auth", "forbidden"):up();
+       end
+end, -1)
+
+-- banned
+module:hook("muc-occupant-pre-join/affiliation", function(event)
+       if event.affiliation == "outcast" then
+               local reply = st.error_reply(event.stanza, "auth", "forbidden"):up();
                reply.tags[1].attr.code = "403";
-               origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
+               event.origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
                return true;
        end
-end
+end, -1)
 
 function room_mt:handle_available_to_occupant(origin, stanza)
        local from, to = stanza.attr.from, stanza.attr.to;
-       local current_nick = self._jid_nick[from];
+       local current_nick = self:get_occupant_jid(from);
        if current_nick then
                --if #pr == #stanza or current_nick ~= to then -- commented because google keeps resending directed presence
                        if current_nick == to then -- simple presence
@@ -529,30 +634,7 @@ function room_mt:handle_available_to_occupant(origin, stanza)
                --      self:handle_to_occupant(origin, stanza); -- resend available
                --end
        else -- enter room
-               local new_nick = to;
-               if self._occupants[to] then
-                       if jid_bare(from) ~= jid_bare(self._occupants[to].jid) then
-                               new_nick = nil;
-                       end
-               end
-               local password = stanza:get_child("x", "http://jabber.org/protocol/muc");
-               password = password and password:get_child("password", "http://jabber.org/protocol/muc");
-               password = password and password[1] ~= "" and password[1];
-               if self:get_password() and self:get_password() ~= password then
-                       log("debug", "%s couldn't join due to invalid password: %s", from, to);
-                       local reply = st.error_reply(stanza, "auth", "not-authorized"):up();
-                       reply.tags[1].attr.code = "401";
-                       origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
-                       return true;
-               elseif not new_nick then
-                       log("debug", "%s couldn't join due to nick conflict: %s", from, to);
-                       local reply = st.error_reply(stanza, "cancel", "conflict"):up();
-                       reply.tags[1].attr.code = "409";
-                       origin.send(reply:tag("x", {xmlns = "http://jabber.org/protocol/muc"}));
-                       return true;
-               else
-                       return self:handle_join(origin, stanza)
-               end
+               return self:handle_join(origin, stanza)
        end
 end
 
@@ -576,7 +658,7 @@ function room_mt:handle_iq_to_occupant(origin, stanza)
        local from, to = stanza.attr.from, stanza.attr.to;
        local type = stanza.attr.type;
        local id = stanza.attr.id;
-       local current_nick = self._jid_nick[from];
+       local current_nick = self:get_occupant_jid(from);
        local o_data = self._occupants[to];
        if (type == "error" or type == "result") then
                do -- deconstruct_stanza_id
@@ -607,7 +689,7 @@ function room_mt:handle_iq_to_occupant(origin, stanza)
                        return true;
                end
                do -- construct_stanza_id
-                       stanza.attr.id = base64.encode(to_jid.."\0"..stanza.attr.id.."\0"..md5(from));
+                       stanza.attr.id = base64.encode(o_data.jid.."\0"..stanza.attr.id.."\0"..md5(from));
                end
                stanza.attr.from, stanza.attr.to = current_nick, o_data.jid;
                log("debug", "%s sent private iq stanza to %s (%s)", from, to, o_data.jid);
@@ -622,7 +704,7 @@ end
 
 function room_mt:handle_message_to_occupant(origin, stanza)
        local from, to = stanza.attr.from, stanza.attr.to;
-       local current_nick = self._jid_nick[from];
+       local current_nick = self:get_occupant_jid(from);
        local type = stanza.attr.type;
        if not current_nick then -- not in room
                if type ~= "error" then
@@ -646,29 +728,11 @@ function room_mt:handle_message_to_occupant(origin, stanza)
        log("debug", "%s sent private message stanza to %s (%s)", from, to, o_data.jid);
        stanza:tag("x", { xmlns = "http://jabber.org/protocol/muc#user" }):up();
        stanza.attr.from = current_nick;
-       for jid in pairs(o_data.sessions) do
-               stanza.attr.to = jid;
-               self:_route_stanza(stanza);
-       end
-       stanza.attr.from, stanza.attr.to = from, to;
+       self:route_to_occupant(o_data, stanza)
+       stanza.attr.from = from;
        return true;
 end
 
-function room_mt:handle_to_occupant(origin, stanza) -- PM, vCards, etc
-       local from, to = stanza.attr.from, stanza.attr.to;
-       local room = jid_bare(to);
-       local current_nick = self._jid_nick[from];
-       log("debug", "room: %s, current_nick: %s, stanza: %s", room or "nil", current_nick or "nil", stanza:top_tag());
-       if (select(2, jid_split(from)) == muc_domain) then error("Presence from the MUC itself!!!"); end
-       if stanza.name == "presence" then
-               return self:handle_presence_to_occupant(origin, stanza)
-       elseif stanza.name == "iq" then
-               return self:handle_iq_to_occupant(origin, stanza)
-       elseif stanza.name == "message" then
-               return self:handle_message_to_occupant(origin, stanza)
-       end
-end
-
 function room_mt:send_form(origin, stanza)
        origin.send(st.reply(stanza):query("http://jabber.org/protocol/muc#owner")
                :add_child(self:get_form_layout(stanza.attr.from):form())
@@ -676,6 +740,7 @@ function room_mt:send_form(origin, stanza)
 end
 
 function room_mt:get_form_layout(actor)
+       local whois = self:get_whois()
        local form = dataform.new({
                title = "Configuration for "..self.jid,
                instructions = "Complete and submit this form to configure the room.",
@@ -719,8 +784,8 @@ function room_mt:get_form_layout(actor)
                        type = 'list-single',
                        label = 'Who May Discover Real JIDs?',
                        value = {
-                               { value = 'moderators', label = 'Moderators Only', default = self._data.whois == 'moderators' },
-                               { value = 'anyone',     label = 'Anyone',          default = self._data.whois == 'anyone' }
+                               { value = 'moderators', label = 'Moderators Only', default = whois == 'moderators' },
+                               { value = 'anyone',     label = 'Anyone',          default = whois == 'anyone' }
                        }
                },
                {
@@ -753,8 +818,7 @@ end
 
 function room_mt:process_form(origin, stanza)
        local query = stanza.tags[1];
-       local form;
-       for _, tag in ipairs(query.tags) do if tag.name == "x" and tag.attr.xmlns == "jabber:x:data" then form = tag; break; end end
+       local form = query:get_child("x", "jabber:x:data")
        if not form then origin.send(st.error_reply(stanza, "cancel", "service-unavailable")); return; end
        if form.attr.type == "cancel" then origin.send(st.reply(stanza)); return; end
        if form.attr.type ~= "submit" then origin.send(st.error_reply(stanza, "cancel", "bad-request", "Not a submitted form")); return; end
@@ -789,9 +853,8 @@ function room_mt:process_form(origin, stanza)
        handle_option("password", "muc#roomconfig_roomsecret");
 
        if self.save then self:save(true); end
-       if self.locked then
-               module:fire_event("muc-room-unlocked", { room = self });
-               self.locked = nil;
+       if self:is_locked() then
+               self:unlock();
        end
        origin.send(st.reply(stanza));
 
@@ -822,12 +885,23 @@ function room_mt:destroy(newjid, reason, password)
                        self._jid_nick[jid] = nil;
                end
                self._occupants[nick] = nil;
+               module:fire_event("muc-occupant-left", { room = self; nick = nick; });
        end
        self:set_persistent(false);
        module:fire_event("muc-room-destroyed", { room = self });
 end
 
-function room_mt:handle_admin_item_set_command(origin, stanza)
+function room_mt:handle_disco_info_get_query(origin, stanza)
+       origin.send(self:get_disco_info(stanza));
+       return true;
+end
+
+function room_mt:handle_disco_items_get_query(origin, stanza)
+       origin.send(self:get_disco_items(stanza));
+       return true;
+end
+
+function room_mt:handle_admin_query_set_command(origin, stanza)
        local item = stanza.tags[1].tags[1];
        if item.attr.jid then -- Validate provided JID
                item.attr.jid = jid_prep(item.attr.jid);
@@ -840,12 +914,12 @@ function room_mt:handle_admin_item_set_command(origin, stanza)
                local occupant = self._occupants[self.jid.."/"..item.attr.nick];
                if occupant then item.attr.jid = occupant.jid; end
        elseif not item.attr.nick and item.attr.jid then
-               local nick = self._jid_nick[item.attr.jid];
+               local nick = self:get_occupant_jid(item.attr.jid);
                if nick then item.attr.nick = select(3, jid_split(nick)); end
        end
        local actor = stanza.attr.from;
        local callback = function() origin.send(st.reply(stanza)); end
-       local reason = item.tags[1] and item.tags[1].name == "reason" and #item.tags[1] == 1 and item.tags[1][1];
+       local reason = item:get_child_text("reason");
        if item.attr.affiliation and item.attr.jid and not item.attr.role then
                local success, errtype, err = self:set_affiliation(actor, item.attr.jid, item.attr.affiliation, callback, reason);
                if not success then origin.send(st.error_reply(stanza, errtype, err)); end
@@ -860,11 +934,9 @@ function room_mt:handle_admin_item_set_command(origin, stanza)
        end
 end
 
-function room_mt:handle_admin_item_get_command(origin, stanza)
+function room_mt:handle_admin_query_get_command(origin, stanza)
        local actor = stanza.attr.from;
        local affiliation = self:get_affiliation(actor);
-       local current_nick = self._jid_nick[actor];
-       local role = current_nick and self._occupants[current_nick].role or self:get_default_role(affiliation);
        local item = stanza.tags[1].tags[1];
        local _aff = item.attr.affiliation;
        local _rol = item.attr.role;
@@ -883,8 +955,8 @@ function room_mt:handle_admin_item_get_command(origin, stanza)
                        return true;
                end
        elseif _rol and not _aff then
+               local role = self:get_role(self:get_occupant_jid(actor)) or self:get_default_role(affiliation);
                if role == "moderator" then
-                       -- TODO allow admins and owners not in room? Provide read-only access to everyone who can see the participants anyway?
                        if _rol == "none" then _rol = nil; end
                        local reply = st.reply(stanza):query("http://jabber.org/protocol/muc#admin");
                        for occupant_jid, occupant in pairs(self._occupants) do
@@ -930,14 +1002,8 @@ function room_mt:handle_owner_query_set_to_room(origin, stanza)
                return true;
        elseif child.name == "destroy" then
                local newjid = child.attr.jid;
-               local reason, password;
-               for _,tag in ipairs(child.tags) do
-                       if tag.name == "reason" then
-                               reason = #tag.tags == 0 and tag[1];
-                       elseif tag.name == "password" then
-                               password = #tag.tags == 0 and tag[1];
-                       end
-               end
+               local reason = child:get_child_text("reason");
+               local password = child:get_child_text("password");
                self:destroy(newjid, reason, password);
                origin.send(st.reply(stanza));
                return true;
@@ -947,41 +1013,9 @@ function room_mt:handle_owner_query_set_to_room(origin, stanza)
        end
 end
 
-function room_mt:handle_iq_to_room(origin, stanza)
-       local type = stanza.attr.type;
-       local xmlns = stanza.tags[1] and stanza.tags[1].attr.xmlns;
-       if xmlns == "http://jabber.org/protocol/disco#info" and type == "get" and not stanza.tags[1].attr.node then
-               origin.send(self:get_disco_info(stanza));
-               return true;
-       elseif xmlns == "http://jabber.org/protocol/disco#items" and type == "get" and not stanza.tags[1].attr.node then
-               origin.send(self:get_disco_items(stanza));
-               return true;
-       elseif xmlns == "http://jabber.org/protocol/muc#admin" then
-               local item = stanza.tags[1].tags[1];
-               if item and item.name == "item" then
-                       if type == "set" then
-                               return self:handle_admin_item_set_command(origin, stanza)
-                       elseif type == "get" then
-                               return self:handle_admin_item_get_command(origin, stanza)
-                       end
-               elseif type == "set" or type == "get" then
-                       origin.send(st.error_reply(stanza, "cancel", "bad-request"));
-                       return true;
-               end
-       elseif xmlns == "http://jabber.org/protocol/muc#owner" and (type == "get" or type == "set") and stanza.tags[1].name == "query" then
-               if stanza.attr.type == "get" then
-                       return self:handle_owner_query_get_to_room(origin, stanza)
-               elseif stanza.attr.type == "set" then
-                       return self:handle_owner_query_set_to_room(origin, stanza)
-               end
-       else
-               return nil;
-       end
-end
-
 function room_mt:handle_groupchat_to_room(origin, stanza)
        local from = stanza.attr.from;
-       local current_nick = self._jid_nick[from];
+       local current_nick = self:get_occupant_jid(from);
        local occupant = self._occupants[current_nick];
        if not occupant then -- not in room
                origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));
@@ -995,7 +1029,7 @@ function room_mt:handle_groupchat_to_room(origin, stanza)
                local subject = stanza:get_child_text("subject");
                if subject then
                        if occupant.role == "moderator" or
-                               ( self._data.changesubject and occupant.role == "participant" ) then -- and participant
+                               ( self:get_changesubject() and occupant.role == "participant" ) then -- and participant
                                self:set_subject(current_nick, subject);
                        else
                                stanza.attr.from = from;
@@ -1011,7 +1045,7 @@ end
 
 -- hack - some buggy clients send presence updates to the room rather than their nick
 function room_mt:handle_presence_to_room(origin, stanza)
-       local current_nick = self._jid_nick[stanza.attr.from];
+       local current_nick = self:get_occupant_jid(stanza.attr.from);
        local handled
        if current_nick then
                local to = stanza.attr.to;
@@ -1022,19 +1056,30 @@ function room_mt:handle_presence_to_room(origin, stanza)
        return handled;
 end
 
-function room_mt:handle_invite_to_room(origin, stanza, payload)
+function room_mt:handle_mediated_invite(origin, stanza)
+       local payload = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("invite")
        local _from, _to = stanza.attr.from, stanza.attr.to;
+       local current_nick = self:get_occupant_jid(_from)
+       -- Need visitor role or higher to invite
+       if not self:get_role(current_nick) or not self:get_default_role(self:get_affiliation(_from)) then
+               origin.send(st.error_reply(stanza, "auth", "forbidden"));
+               return true;
+       end
        local _invitee = jid_prep(payload.attr.to);
        if _invitee then
-               local _reason = payload.tags[1] and payload.tags[1].name == 'reason' and #payload.tags[1].tags == 0 and payload.tags[1][1];
+               if self:get_whois() == "moderators" then
+                       _from = current_nick;
+               end
+               local _reason = payload:get_child_text("reason")
                local invite = st.message({from = _to, to = _invitee, id = stanza.attr.id})
                        :tag('x', {xmlns='http://jabber.org/protocol/muc#user'})
                                :tag('invite', {from=_from})
                                        :tag('reason'):text(_reason or ""):up()
                                :up();
-                               if self:get_password() then
-                                       invite:tag("password"):text(self:get_password()):up();
-                               end
+               local password = self:get_password()
+               if password then
+                       invite:tag("password"):text(password):up();
+               end
                        invite:up()
                        :tag('x', {xmlns="jabber:x:conference", jid=_to}) -- COMPAT: Some older clients expect this
                                :text(_reason or "")
@@ -1042,11 +1087,48 @@ function room_mt:handle_invite_to_room(origin, stanza, payload)
                        :tag('body') -- Add a plain message for clients which don't support invites
                                :text(_from..' invited you to the room '.._to..(_reason and (' ('.._reason..')') or ""))
                        :up();
-               if self:get_members_only() and not self:get_affiliation(_invitee) then
-                       log("debug", "%s invited %s into members only room %s, granting membership", _from, _invitee, _to);
-                       self:set_affiliation(_from, _invitee, "member", nil, "Invited by " .. self._jid_nick[_from])
-               end
-               self:_route_stanza(invite);
+               module:fire_event("muc-invite", { room = self, stanza = invite, origin = origin, incoming = stanza });
+               return true;
+       else
+               origin.send(st.error_reply(stanza, "cancel", "jid-malformed"));
+               return true;
+       end
+end
+
+module:hook("muc-invite", function(event)
+       event.room:_route_stanza(event.stanza);
+       return true;
+end, -1)
+
+-- When an invite is sent; add an affiliation for the invitee
+module:hook("muc-invite", function(event)
+       local room, stanza = event.room, event.stanza
+       local invitee = stanza.attr.to
+       if room:get_members_only() and not room:get_affiliation(invitee) then
+               local from = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("invite").attr.from
+               local current_nick = room:get_occupant_jid(from)
+               log("debug", "%s invited %s into members only room %s, granting membership", from, invitee, room.jid);
+               room:set_affiliation(from, invitee, "member", nil, "Invited by " .. current_nick)
+       end
+end)
+
+function room_mt:handle_mediated_decline(origin, stanza)
+       local payload = stanza:get_child("x", "http://jabber.org/protocol/muc#user"):get_child("decline")
+       local declinee = jid_prep(payload.attr.to);
+       if declinee then
+               local from, to = stanza.attr.from, stanza.attr.to;
+               -- TODO: Validate declinee
+               local reason = payload:get_child_text("reason")
+               local decline = st.message({from = to, to = declinee, id = stanza.attr.id})
+                       :tag('x', {xmlns='http://jabber.org/protocol/muc#user'})
+                               :tag('decline', {from=from})
+                                       :tag('reason'):text(reason or ""):up()
+                               :up()
+                       :up()
+                       :tag('body') -- Add a plain message for clients which don't support declines
+                               :text(from..' declined your invite to the room '..to..(reason and (' ('..reason..')') or ""))
+                       :up();
+               module:fire_event("muc-decline", { room = self, stanza = decline, origin = origin, incoming = stanza });
                return true;
        else
                origin.send(st.error_reply(stanza, "cancel", "jid-malformed"));
@@ -1054,19 +1136,34 @@ function room_mt:handle_invite_to_room(origin, stanza, payload)
        end
 end
 
+module:hook("muc-decline", function(event)
+       local room, stanza = event.room, event.stanza
+       local occupant = room:get_occupant_by_real_jid(stanza.attr.to);
+       if occupant then
+               room:route_to_occupant(occupant, stanza)
+       else
+               room:route_stanza(stanza);
+       end
+       return true;
+end, -1)
+
 function room_mt:handle_message_to_room(origin, stanza)
        local type = stanza.attr.type;
        if type == "groupchat" then
                return self:handle_groupchat_to_room(origin, stanza)
        elseif type == "error" and is_kickable_error(stanza) then
                return self:handle_kickable(origin, stanza)
-       elseif not(type == "chat" or type == "error" or type == "groupchat" or type == "headline") and #stanza.tags == 1
-               and self._jid_nick[stanza.attr.from] and stanza.tags[1].name == "x" and stanza.tags[1].attr.xmlns == "http://jabber.org/protocol/muc#user" then
-               local x = stanza.tags[1];
-               local payload = (#x.tags == 1 and x.tags[1]);
-               if payload and payload.name == "invite" and payload.attr.to then
-                       return self:handle_invite_to_room(origin, stanza, payload)
-               else
+       elseif type == nil then
+               local x = stanza:get_child("x", "http://jabber.org/protocol/muc#user");
+               if x then
+                       local payload = x.tags[1];
+                       if payload == nil then
+                               -- fallthrough
+                       elseif payload.name == "invite" and payload.attr.to then
+                               return self:handle_mediated_invite(origin, stanza)
+                       elseif payload.name == "decline" and payload.attr.to then
+                               return self:handle_mediated_decline(origin, stanza)
+                       end
                        origin.send(st.error_reply(stanza, "cancel", "bad-request"));
                        return true;
                end
@@ -1075,35 +1172,10 @@ function room_mt:handle_message_to_room(origin, stanza)
        end
 end
 
-function room_mt:handle_to_room(origin, stanza) -- presence changes and groupchat messages, along with disco/etc
-       if stanza.name == "iq" then
-               return self:handle_iq_to_room(origin, stanza)
-       elseif stanza.name == "message" then
-               return self:handle_message_to_room(origin, stanza)
-       elseif stanza.name == "presence" then
-               return self:handle_presence_to_room(origin, stanza)
-       end
+function room_mt:route_stanza(stanza)
+       module:send(stanza)
 end
 
-function room_mt:handle_stanza(origin, stanza)
-       local to_node, to_host, to_resource = jid_split(stanza.attr.to);
-       local handled
-       if to_resource then
-               handled = self:handle_to_occupant(origin, stanza);
-       else
-               handled = self:handle_to_room(origin, stanza);
-       end
-
-       if not handled then
-               local type = stanza.attr.type
-               if stanza.name ~= "iq" or type == "get" or type == "set" then
-                       origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
-               end
-       end
-end
-
-function room_mt:route_stanza(stanza) end -- Replace with a routing function, e.g., function(room, stanza) core_route_stanza(origin, stanza); end
-
 function room_mt:get_affiliation(jid)
        local node, host, resource = jid_split(jid);
        local bare = node and node.."@"..host or host;
@@ -1192,8 +1264,8 @@ function room_mt:can_set_role(actor_jid, occupant_jid, role)
 
        if actor_jid == true then return true; end
 
-       local actor = self._occupants[self._jid_nick[actor_jid]];
-       if actor.role == "moderator" then
+       local actor = self._occupants[self:get_occupant_jid(actor_jid)];
+       if actor and actor.role == "moderator" then
                if occupant.affiliation ~= "owner" and occupant.affiliation ~= "admin" then
                        if actor.affiliation == "owner" or actor.affiliation == "admin" then
                                return true;
@@ -1246,11 +1318,11 @@ end
 
 function room_mt:_route_stanza(stanza)
        local muc_child;
-       local to_occupant = self._occupants[self._jid_nick[stanza.attr.to]];
-       local from_occupant = self._occupants[stanza.attr.from];
        if stanza.name == "presence" then
+               local to_occupant = self._occupants[self:get_occupant_jid(stanza.attr.to)];
+               local from_occupant = self._occupants[stanza.attr.from];
                if to_occupant and from_occupant then
-                       if self._data.whois == 'anyone' then
+                       if self:get_whois() == 'anyone' then
                            muc_child = stanza:get_child("x", "http://jabber.org/protocol/muc#user");
                        else
                                if to_occupant.role == "moderator" or jid_bare(to_occupant.jid) == jid_bare(from_occupant.jid) then
@@ -1258,10 +1330,8 @@ function room_mt:_route_stanza(stanza)
                                end
                        end
                end
-       end
-       if muc_child then
-               for _, item in pairs(muc_child.tags) do
-                       if item.name == "item" then
+               if muc_child then
+                       for item in muc_child:childtags("item") do
                                if from_occupant == to_occupant then
                                        item.attr.jid = stanza.attr.to;
                                else
@@ -1272,10 +1342,8 @@ function room_mt:_route_stanza(stanza)
        end
        self:route_stanza(stanza);
        if muc_child then
-               for _, item in pairs(muc_child.tags) do
-                       if item.name == "item" then
-                               item.attr.jid = nil;
-                       end
+               for item in muc_child:childtags("item") do
+                       item.attr.jid = nil;
                end
        end
 end
@@ -1285,6 +1353,7 @@ local _M = {}; -- module "muc"
 function _M.new_room(jid, config)
        return setmetatable({
                jid = jid;
+               locked = nil;
                _jid_nick = {};
                _occupants = {};
                _data = {