Merge 0.10->trunk
[prosody.git] / plugins / muc / muc.lib.lua
index 4e461df6ce84fde761ea1e0922c8b7a72d32412e..75caa233938f49d627df9aefae1c84d2d67935f7 100644 (file)
@@ -17,6 +17,7 @@ local iterators = require "util.iterators";
 local jid_split = require "util.jid".split;
 local jid_bare = require "util.jid".bare;
 local jid_prep = require "util.jid".prep;
+local jid_join = require "util.jid".join;
 local st = require "util.stanza";
 local log = require "util.logger".init("mod_muc");
 local base64 = require "util.encodings".base64;
@@ -96,7 +97,7 @@ function room_mt:save_occupant(occupant)
        -- Need to maintain _jid_nick secondary index
        local old_occupant = self._occupants[id];
        if old_occupant then
-               for real_jid in pairs(old_occupant.sessions) do
+               for real_jid in old_occupant:each_session() do
                        self._jid_nick[real_jid] = nil;
                end
        end
@@ -130,10 +131,10 @@ function room_mt:route_to_occupant(occupant, stanza)
 end
 
 -- actor is the attribute table
-local function add_item(x, affiliation, role, jid, nick, actor, reason)
+local function add_item(x, affiliation, role, jid, nick, actor_nick, actor_jid, reason)
        x:tag("item", {affiliation = affiliation; role = role; jid = jid; nick = nick;})
-       if actor then
-               x:tag("actor", actor):up()
+       if actor_nick or actor_jid then
+               x:tag("actor", {nick = actor_nick; jid = actor_jid;}):up()
        end
        if reason then
                x:tag("reason"):text(reason):up()
@@ -143,29 +144,25 @@ local function add_item(x, affiliation, role, jid, nick, actor, reason)
 end
 
 -- actor is (real) jid
-function room_mt:build_item_list(occupant, x, is_anonymous, nick, actor, reason)
+function room_mt:build_item_list(occupant, x, is_anonymous, nick, actor_nick, actor_jid, reason)
        local affiliation = self:get_affiliation(occupant.bare_jid) or "none";
        local role = occupant.role or "none";
-       local actor_attr;
-       if actor then
-               actor_attr = {nick = select(3,jid_split(self:get_occupant_jid(actor)))};
-       end
        if is_anonymous then
-               add_item(x, affiliation, role, nil, nick, actor_attr, reason);
+               add_item(x, affiliation, role, nil, nick, actor_nick, actor_jid, reason);
        else
-               if actor_attr then
-                       actor_attr.jid = actor;
-               end
                for real_jid, session in occupant:each_session() do
-                       add_item(x, affiliation, role, real_jid, nick, actor_attr, reason);
+                       add_item(x, affiliation, role, real_jid, nick, actor_nick, actor_jid, reason);
                end
        end
        return x
 end
 
 function room_mt:broadcast_message(stanza)
-       module:fire_event("muc-broadcast-message", {room = self, stanza = stanza});
+       if module:fire_event("muc-broadcast-message", {room = self, stanza = stanza}) then
+               return true;
+       end
        self:broadcast(stanza);
+       return true;
 end
 
 -- Broadcast a stanza to all occupants in the room.
@@ -201,37 +198,64 @@ function room_mt:publicise_occupant_status(occupant, base_x, nick, actor, reason
        base_presence = base_presence or st.presence {from = occupant.nick; type = "unavailable";};
 
        -- Fire event (before full_p and anon_p are created)
-       module:fire_event("muc-broadcast-presence", {
+       local event = {
                room = self; stanza = base_presence; x = base_x;
                occupant = occupant; nick = nick; actor = actor;
                reason = reason;
-       });
+       }
+       module:fire_event("muc-broadcast-presence", event);
 
-       local function get_presence(is_anonymous)
-               local x = st.clone(base_x);
-               self:build_item_list(occupant, x, is_anonymous, nick, actor, reason);
-               return st.clone(base_presence):add_child(x), x;
+       -- Allow muc-broadcast-presence listeners to change things
+       nick = event.nick;
+       actor = event.actor;
+       reason = event.reason;
+
+       local whois = self:get_whois();
+
+       local actor_nick;
+       if actor then
+               actor_nick = select(3, jid_split(self:get_occupant_jid(actor)));
        end
 
-       local full_p, full_x = get_presence(false);
+       local full_p, full_x;
+       local function get_full_p()
+               if full_p == nil then
+                       full_x = st.clone(base_x);
+                       self:build_item_list(occupant, full_x, false, nick, actor_nick, actor, reason);
+                       full_p = st.clone(base_presence):add_child(full_x);
+               end
+               return full_p, full_x;
+       end
 
-       -- Create anon_p lazily
        local anon_p, anon_x;
        local function get_anon_p()
                if anon_p == nil then
-                       anon_p, anon_x = get_presence(true);
+                       anon_x = st.clone(base_x);
+                       self:build_item_list(occupant, anon_x, true, nick, actor_nick, nil, reason);
+                       anon_p = st.clone(base_presence):add_child(anon_x);
                end
                return anon_p, anon_x;
        end
 
-       local whois = self:get_whois();
+       local self_p, self_x;
+       if can_see_real_jids(whois, occupant) then
+               self_p, self_x = get_full_p();
+       else
+               -- Can always see your own full jids
+               -- But not allowed to see actor's
+               self_x = st.clone(base_x);
+               self:build_item_list(occupant, self_x, false, nick, actor_nick, nil, reason);
+               self_p = st.clone(base_presence):add_child(self_x);
+       end
 
        -- General populance
        for nick, n_occupant in self:each_occupant() do
                if nick ~= occupant.nick then
                        local pr;
-                       if can_see_real_jids(whois, n_occupant) or occupant.bare_jid == n_occupant.bare_jid then
-                               pr = full_p;
+                       if can_see_real_jids(whois, n_occupant) then
+                               pr = get_full_p();
+                       elseif occupant.bare_jid == n_occupant.bare_jid then
+                               pr = self_p;
                        else
                                pr = get_anon_p();
                        end
@@ -240,17 +264,16 @@ function room_mt:publicise_occupant_status(occupant, base_x, nick, actor, reason
        end
 
        -- Presences for occupant itself
-       full_x:tag("status", {code = "110";}):up();
+       self_x:tag("status", {code = "110";}):up();
        if occupant.role == nil then
                -- They get an unavailable
-               self:route_to_occupant(occupant, full_p);
+               self:route_to_occupant(occupant, self_p);
        else
                -- use their own presences as templates
                for full_jid, pr in occupant:each_session() do
                        pr = st.clone(pr);
                        pr.attr.to = full_jid;
-                       -- You can always see your own full jids
-                       pr:add_child(full_x);
+                       pr:add_child(self_x);
                        self:route_stanza(pr);
                end
        end
@@ -321,6 +344,9 @@ function room_mt:handle_kickable(origin, stanza)
        local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user";})
                :tag("status", {code = "307"})
        self:publicise_occupant_status(occupant, x);
+       if occupant.jid == real_jid then -- Was last session
+               module:fire_event("muc-occupant-left", {room = self; nick = occupant.nick; occupant = occupant;});
+       end
        return true;
 end
 
@@ -395,10 +421,14 @@ function room_mt:handle_presence_to_occupant(origin, stanza)
                if orig_occupant == nil then
                        event_name = "muc-occupant-pre-join";
                        event.is_new_room = is_new_room;
+                       event.occupant = dest_occupant;
                elseif dest_occupant == nil then
                        event_name = "muc-occupant-pre-leave";
+                       event.occupant = orig_occupant;
                else
                        event_name = "muc-occupant-pre-change";
+                       event.orig_occupant = orig_occupant;
+                       event.dest_occupant = dest_occupant;
                end
                if module:fire_event(event_name, event) then return true; end
 
@@ -457,7 +487,7 @@ function room_mt:handle_presence_to_occupant(origin, stanza)
                        self:publicise_occupant_status(orig_occupant, orig_x, dest_nick);
 
                        if is_last_orig_session then
-                               module:fire_event("muc-occupant-left", {room = self; nick = orig_occupant.nick;});
+                               module:fire_event("muc-occupant-left", {room = self; nick = orig_occupant.nick; occupant = orig_occupant;});
                        end
                end
 
@@ -495,9 +525,9 @@ function room_mt:handle_presence_to_occupant(origin, stanza)
 
                        if orig_occupant == nil then
                                if is_first_dest_session then
-                                       module:fire_event("muc-occupant-joined", {room = self; nick = dest_occupant.nick; stanza = stanza;});
+                                       module:fire_event("muc-occupant-joined", {room = self; nick = dest_occupant.nick; occupant = dest_occupant;});
                                end
-                               module:fire_event("muc-occupant-session-new", {room = self; nick = dest_occupant.nick; stanza = stanza; jid = real_jid;});
+                               module:fire_event("muc-occupant-session-new", {room = self; nick = dest_occupant.nick; occupant = dest_occupant; stanza = stanza; jid = real_jid;});
                        end
                end
        elseif type ~= 'result' then -- bad type
@@ -528,7 +558,7 @@ function room_mt:handle_iq_to_occupant(origin, stanza)
                                end
                        end
                        if session_jid == nil then return nil; end
-                       stanza.attr.from, stanza.attr.to, stanza.attr.id = from_jid, session_jid, id;
+                       stanza.attr.from, stanza.attr.to, stanza.attr.id = from_occupant_jid, session_jid, id;
                end
                log("debug", "%s sent private iq stanza to %s (%s)", from, to, stanza.attr.to);
                self:route_stanza(stanza);
@@ -666,7 +696,7 @@ function room_mt:clear(x)
        end
        for occupant in pairs(occupants_updated) do
                self:publicise_occupant_status(occupant, x);
-               module:fire_event("muc-occupant-left", { room = self; nick = occupant.nick; });
+               module:fire_event("muc-occupant-left", { room = self; nick = occupant.nick; occupant = occupant;});
        end
 end
 
@@ -727,22 +757,24 @@ function room_mt:handle_admin_query_get_command(origin, stanza)
        local affiliation = self:get_affiliation(actor);
        local item = stanza.tags[1].tags[1];
        local _aff = item.attr.affiliation;
+       local _aff_rank = valid_affiliations[_aff or "none"];
        local _rol = item.attr.role;
-       if _aff and not _rol then
-               if affiliation == "owner" or (affiliation == "admin" and _aff ~= "owner" and _aff ~= "admin") then
+       if _aff and _aff_rank and not _rol then
+               -- You need to be at least an admin, and be requesting info about your affifiliation or lower
+               -- e.g. an admin can't ask for a list of owners
+               local affiliation_rank = valid_affiliations[affiliation];
+               if affiliation_rank >= valid_affiliations.admin and affiliation_rank >= _aff_rank then
                        local reply = st.reply(stanza):query("http://jabber.org/protocol/muc#admin");
-                       for jid, affiliation in pairs(self._affiliations) do
-                               if affiliation == _aff then
-                                       reply:tag("item", {affiliation = _aff, jid = jid}):up();
-                               end
+                       for jid in self:each_affiliation(_aff or "none") do
+                               reply:tag("item", {affiliation = _aff, jid = jid}):up();
                        end
-                       origin.send(reply);
+                       origin.send(reply:up());
                        return true;
                else
                        origin.send(st.error_reply(stanza, "auth", "forbidden"));
                        return true;
                end
-       elseif _rol and not _aff then
+       elseif _rol and valid_roles[_rol or "none"] and not _aff then
                local role = self:get_role(self:get_occupant_jid(actor)) or self:get_default_role(affiliation);
                if valid_roles[role or "none"] >= valid_roles.moderator then
                        if _rol == "none" then _rol = nil; end
@@ -801,26 +833,29 @@ function room_mt:handle_owner_query_set_to_room(origin, stanza)
 end
 
 function room_mt:handle_groupchat_to_room(origin, stanza)
-       -- Prosody has made the decision that messages with <subject/> are exclusively subject changes
-       -- e.g. body will be ignored; even if the subject change was not allowed
-       if stanza:get_child("subject") then
-               return module:fire_event("muc-subject-change", {room = self, origin = origin, stanza = stanza});
-       end
        local from = stanza.attr.from;
        local occupant = self:get_occupant_by_real_jid(from);
-       if not occupant then -- not in room
-               origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));
-               return true;
-       elseif occupant.role == "visitor" then
-               origin.send(st.error_reply(stanza, "auth", "forbidden"));
-               return true;
-       end
+       if module:fire_event("muc-occupant-groupchat", {
+               room = self; origin = origin; stanza = stanza; from = from; occupant = occupant;
+       }) then return true; end
        stanza.attr.from = occupant.nick;
        self:broadcast_message(stanza);
        stanza.attr.from = from;
        return true;
 end
 
+-- Role check
+module:hook("muc-occupant-groupchat", function(event)
+       local role_rank = valid_roles[event.occupant and event.occupant.role or "none"];
+       if role_rank <= valid_roles.none then
+               event.origin.send(st.error_reply(event.stanza, "cancel", "not-acceptable"));
+               return true;
+       elseif role_rank <= valid_roles.visitor then
+               event.origin.send(st.error_reply(event.stanza, "auth", "forbidden"));
+               return true;
+       end
+end, 50);
+
 -- 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:get_occupant_jid(stanza.attr.from);
@@ -970,10 +1005,28 @@ function room_mt:get_affiliation(jid)
        return result;
 end
 
+-- Iterates over jid, affiliation pairs
+function room_mt:each_affiliation(with_affiliation)
+       if not with_affiliation then
+               return pairs(self._affiliations);
+       else
+               return function(_affiliations, jid)
+                       local affiliation;
+                       repeat -- Iterate until we get a match
+                               jid, affiliation = next(_affiliations, jid);
+                       until jid == nil or affiliation == with_affiliation
+                       return jid, affiliation;
+               end, self._affiliations, nil
+       end
+end
+
 function room_mt:set_affiliation(actor, jid, affiliation, reason)
        if not actor then return nil, "modify", "not-acceptable"; end;
 
-       jid = jid_bare(jid);
+       local node, host, resource = jid_split(jid);
+       if not host then return nil, "modify", "not-acceptable"; end
+       jid = jid_join(node, host); -- Bare
+       local is_host_only = node == nil;
 
        if valid_affiliations[affiliation or "none"] == nil then
                return nil, "modify", "not-acceptable";
@@ -983,13 +1036,17 @@ function room_mt:set_affiliation(actor, jid, affiliation, reason)
        local target_affiliation = self._affiliations[jid]; -- Raw; don't want to check against host
        local is_downgrade = valid_affiliations[target_affiliation or "none"] > valid_affiliations[affiliation or "none"];
 
-       if actor ~= true then
+       if actor == true then
+               actor = nil -- So we can pass it safely to 'publicise_occupant_status' below
+       else
                local actor_affiliation = self:get_affiliation(actor);
                if actor_affiliation == "owner" then
                        if jid_bare(actor) == jid then -- self change
                                -- need at least one owner
                                local is_last = true;
-                               for j, aff in pairs(self._affiliations) do if j ~= jid and aff == "owner" then is_last = false; break; end end
+                               for j in self:each_affiliation("owner") do
+                                       if j ~= jid then is_last = false; break; end
+                               end
                                if is_last then
                                        return nil, "cancel", "conflict";
                                end
@@ -1011,7 +1068,10 @@ function room_mt:set_affiliation(actor, jid, affiliation, reason)
        local role_rank = valid_roles[role or "none"];
        local occupants_updated = {}; -- Filled with old roles
        for nick, occupant in self:each_occupant() do
-               if occupant.bare_jid == jid then
+               if occupant.bare_jid == jid or (
+                       -- Outcast can be by host.
+                       is_host_only and affiliation == "outcast" and select(2, jid_split(occupant.bare_jid)) == host
+               ) then
                        -- need to publcize in all cases; as affiliation in <item/> has changed.
                        occupants_updated[occupant] = occupant.role;
                        if occupant.role ~= role and (
@@ -1036,7 +1096,9 @@ function room_mt:set_affiliation(actor, jid, affiliation, reason)
        local is_semi_anonymous = self:get_whois() == "moderators";
        for occupant, old_role in pairs(occupants_updated) do
                self:publicise_occupant_status(occupant, x, nil, actor, reason);
-               if is_semi_anonymous and
+               if occupant.role == nil then
+                       module:fire_event("muc-occupant-left", {room = self; nick = occupant.nick; occupant = occupant;});
+               elseif is_semi_anonymous and
                        (old_role == "moderator" and occupant.role ~= "moderator") or
                        (old_role ~= "moderator" and occupant.role == "moderator") then -- Has gained or lost moderator status
                        -- Send everyone else's presences (as jid visibility has changed)
@@ -1079,7 +1141,9 @@ function room_mt:set_role(actor, occupant_jid, role, reason)
        end
        role = role ~= "none" and role or nil; -- coerces `role == false` to `nil`
 
-       if actor ~= true then
+       if actor == true then
+               actor = nil -- So we can pass it safely to 'publicise_occupant_status' below
+       else
                -- Can't do anything to other owners or admins
                local occupant_affiliation = self:get_affiliation(occupant.bare_jid);
                if occupant_affiliation == "owner" and occupant_affiliation == "admin" then
@@ -1108,9 +1172,14 @@ function room_mt:set_role(actor, occupant_jid, role, reason)
        occupant.role = role;
        self:save_occupant(occupant);
        self:publicise_occupant_status(occupant, x, nil, actor, reason);
+       if role == nil then
+               module:fire_event("muc-occupant-left", {room = self; nick = occupant.nick; occupant = occupant;});
+       end
        return true;
 end
 
+local affiliation_notify = module:require "muc/affiliation_notify";
+
 local name = module:require "muc/name";
 room_mt.get_name = name.get;
 room_mt.set_name = name.set;