Merge with 0.4
[prosody.git] / plugins / mod_muc.lua
index 602fb5bc6293ac291e8e789a6330f7f76783a112..38f21b4a43db28ef68d86396bb400edd9d95a2db 100644 (file)
@@ -1,4 +1,13 @@
+-- Prosody IM v0.4
+-- Copyright (C) 2008-2009 Matthew Wild
+-- Copyright (C) 2008-2009 Waqas Hussain
+-- 
+-- This project is MIT/X11 licensed. Please see the
+-- COPYING file in the source package for more information.
+--
 
+local datamanager = require "util.datamanager";
+local datetime = require "util.datetime";
 
 local register_component = require "core.componentmanager".register_component;
 local deregister_component = require "core.componentmanager".deregister_component;
@@ -7,14 +16,15 @@ local jid_bare = require "util.jid".bare;
 local st = require "util.stanza";
 local log = require "util.logger".init("mod_muc");
 local multitable_new = require "util.multitable".new;
+local t_insert, t_remove = table.insert, table.remove;
 
 if module:get_host_type() ~= "component" then
        error("MUC should be loaded as a component, please see http://prosody.im/doc/components", 0);
 end
 
 local muc_domain = module:get_host();
-
-local muc_name = "MUCMUCMUC!!!";
+local muc_name = "Chatrooms";
+local history_length = 20;
 
 -- room_name -> room
        -- occupant_room_nick -> data
@@ -30,6 +40,7 @@ local jid_nick = multitable_new(); -- real jid -> room's jid -> room nick
        -- subject - the room's subject
        -- non-anonymous = true|nil
        -- persistent = true|nil
+       -- history = {preserialized stanzas}
 local rooms_info = multitable_new();
 
 local persist_list = datamanager.load(nil, muc_domain, 'room_list') or {};
@@ -39,6 +50,53 @@ end
 
 local component;
 
+function filter_xmlns_from_array(array, filters)
+       local count = 0;
+       for i=#array,1,-1 do
+               local attr = array[i].attr;
+               if filters[attr and attr.xmlns] then
+                       t_remove(array, i);
+                       count = count + 1;
+               end
+       end
+       return count;
+end
+function filter_xmlns_from_stanza(stanza, filters)
+       if filters then
+               if filter_xmlns_from_array(stanza.tags, filters) ~= 0 then
+                       return stanza, filter_xmlns_from_array(stanza, filters);
+               end
+       end
+       return stanza, 0;
+end
+local presence_filters = {["http://jabber.org/protocol/muc"]=true;["http://jabber.org/protocol/muc#user"]=true};
+function get_filtered_presence(stanza)
+       return filter_xmlns_from_stanza(st.clone(stanza), presence_filters);
+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;
+};
+function get_kickable_error(stanza)
+       for _, tag in ipairs(stanza.tags) do
+               if tag.name == "error" and tag.attr.xmlns == "jabber:client" then
+                       for _, cond in ipairs(tag.tags) do
+                               if cond.attr.xmlns == "urn:ietf:params:xml:ns:xmpp-stanzas" then
+                                       return kickable_error_conditions[cond.name] and cond.name;
+                               end
+                       end
+                       return true; -- malformed error message
+               end
+       end
+       return true; -- malformed error message
+end
 function getUsingPath(stanza, path, getText)
        local tag = stanza;
        for _, name in ipairs(path) do
@@ -91,15 +149,37 @@ function set_subject(current_nick, room, subject)
        if subject == "" then subject = nil; end
        rooms_info:set(room, 'subject', subject);
        save_room();
-       broadcast_message(current_nick, room, subject or "", nil);
+       local msg = st.message({type='groupchat', from=current_nick})
+               :tag('subject'):text(subject):up();
+       broadcast_message_stanza(room, msg, false);
        return true;
 end
 
-function broadcast_presence(type, from, room, code, newnick)
-       local data = rooms:get(room, from);
-       local stanza = st.presence({type=type, from=from})
-               :tag("x", {xmlns='http://jabber.org/protocol/muc#user'})
-               :tag("item", {affiliation=data.affiliation, role=data.role, nick = newnick}):up();
+function broadcast_message_stanza(room, stanza, historic)
+       local r = rooms:get(room);
+       if r then
+               for occupant, o_data in pairs(r) do
+                       for jid in pairs(o_data.sessions) do
+                               stanza.attr.to = jid;
+                               core_route_stanza(component, stanza);
+                       end
+               end
+               if historic then -- add to history
+                       local history = rooms_info:get(room, 'history');
+                       if not history then history = {}; rooms_info:set(room, 'history', history); end
+                       -- stanza = st.clone(stanza);
+                       stanza:tag("delay", {xmlns = "urn:xmpp:delay", from = muc_domain, stamp = datetime.datetime()}):up(); -- XEP-0203
+                       stanza:tag("x", {xmlns = "jabber:x:delay", from = muc_domain, stamp = datetime.legacy()}):up(); -- XEP-0091 (deprecated)
+                       t_insert(history, st.clone(st.preserialize(stanza)));
+                       while #history > history_length do t_remove(history, 1) end
+               end
+       end
+end
+function broadcast_presence_stanza(room, stanza, code, nick)
+       stanza = get_filtered_presence(stanza);
+       local data = rooms:get(room, stanza.attr.from);
+       stanza:tag("x", {xmlns='http://jabber.org/protocol/muc#user'})
+               :tag("item", {affiliation=data.affiliation, role=data.role, nick=nick}):up();
        if code then
                stanza:tag("status", {code=code}):up();
        end
@@ -107,29 +187,49 @@ function broadcast_presence(type, from, room, code, newnick)
        local r = rooms:get(room);
        if r then
                for occupant, o_data in pairs(r) do
-                       if occupant ~= from then
-                               stanza.attr.to = o_data.jid;
-                               core_route_stanza(component, stanza);
+                       if occupant ~= stanza.attr.from then
+                               for jid in pairs(o_data.sessions) do
+                                       stanza.attr.to = jid;
+                                       core_route_stanza(component, stanza);
+                               end
                        else
-                               me = o_data.jid;
+                               me = o_data;
                        end
                end
        end
        if me then
                stanza:tag("status", {code='110'});
-               stanza.attr.to = me;
-               core_route_stanza(component, stanza);
+               for jid in pairs(me.sessions) do
+                       stanza.attr.to = jid;
+                       core_route_stanza(component, stanza);
+               end
        end
 end
-function broadcast_message(from, room, subject, body)
-       local stanza = st.message({type='groupchat', from=from});
-       if subject then stanza:tag('subject'):text(subject):up(); end
-       if body then stanza:tag('body'):text(body):up(); end
+function send_history(room, to)
+       local history = rooms_info:get(room, 'history'); -- send discussion history
+       if history then
+               for _, msg in ipairs(history) do
+                       msg = st.deserialize(msg);
+                       msg.attr.to=to;
+                       core_route_stanza(component, msg);
+               end
+       end
+       if rooms_info:get(room, 'subject') then
+               core_route_stanza(component, st.message({type='groupchat', from=room, to=to}):tag("subject"):text(rooms_info:get(room, 'subject')));
+       end
+end
+function send_occupant_list(room, to)
        local r = rooms:get(room);
        if r then
+               local current_nick = jid_nick:get(to, room);
                for occupant, o_data in pairs(r) do
-                       stanza.attr.to = o_data.jid;
-                       core_route_stanza(component, stanza);
+                       if occupant ~= current_nick then
+                               local pres = get_filtered_presence(o_data.sessions[o_data.jid]);
+                               pres.attr.to, pres.attr.from = to, occupant;
+                               pres:tag("x", {xmlns='http://jabber.org/protocol/muc#user'})
+                                       :tag("item", {affiliation=o_data.affiliation, role=o_data.role}):up();
+                               core_route_stanza(component, pres);
+                       end
                end
        end
 end
@@ -139,81 +239,106 @@ function handle_to_occupant(origin, stanza) -- PM, vCards, etc
        local room = jid_bare(to);
        local current_nick = jid_nick:get(from, room);
        local type = stanza.attr.type;
+       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
+               local pr = get_filtered_presence(stanza);
+               pr.attr.from = current_nick;
                if type == "error" then -- error, kick em out!
-                       local data = rooms:get(room, to);
-                       data.role = 'none';
-                       broadcast_presence('unavailable', to, room); -- TODO also add <status>This participant is kicked from the room because he sent an error presence: badformed error stanza</status>
-                       rooms:remove(room, to);
-                       jid_nick:remove(from, room);
+                       if current_nick then
+                               log("debug", "kicking %s from %s", current_nick, room);
+                               handle_to_occupant(origin, st.presence({type='unavailable', from=from, to=to}):tag('status'):text('This participant is kicked from the room because he sent an error presence')); -- send unavailable
+                       end
                elseif type == "unavailable" then -- unavailable
-                       if current_nick == to then
-                               local data = rooms:get(room, to);
+                       if current_nick then
+                               log("debug", "%s leaving %s", current_nick, room);
+                               local data = rooms:get(room, current_nick);
                                data.role = 'none';
-                               broadcast_presence('unavailable', to, room);
-                               rooms:remove(room, to);
+                               broadcast_presence_stanza(room, pr);
+                               rooms:remove(room, current_nick);
                                jid_nick:remove(from, room);
-                       end -- TODO else do nothing?
+                       end
                elseif not type then -- available
                        if current_nick then
-                               if current_nick == to then -- simple presence
-                                       -- TODO broadcast
-                               else -- change nick
-                                       if rooms:get(room, to) then
-                                               origin.send(st.error_reply(stanza, "cancel", "conflict"));
-                                       else
-                                               local data = rooms:get(room, current_nick);
-                                               local to_nick = select(3, jid_split(to));
-                                               if to_nick then
-                                                       broadcast_presence('unavailable', current_nick, room, '303', to_nick);
-                                                       rooms:remove(room, current_nick);
-                                                       rooms:set(room, to, data);
-                                                       jid_nick:set(from, room, to);
-                                                       broadcast_presence(nil, to, room, nil);
+                               --if #pr == #stanza or current_nick ~= to then -- commented because google keeps resending directed presence
+                                       if current_nick == to then -- simple presence
+                                               log("debug", "%s broadcasted presence", current_nick);
+                                               rooms:get(room, current_nick).sessions[from] = pr;
+                                               broadcast_presence_stanza(room, pr);
+                                       else -- change nick
+                                               if rooms:get(room, to) then
+                                                       log("debug", "%s couldn't change nick", current_nick);
+                                                       origin.send(st.error_reply(stanza, "cancel", "conflict"));
                                                else
-                                                       --TODO: malformed-jid
+                                                       local data = rooms:get(room, current_nick);
+                                                       local to_nick = select(3, jid_split(to));
+                                                       if to_nick then
+                                                               log("debug", "%s (%s) changing nick to %s", current_nick, data.jid, to);
+                                                               local p = st.presence({type='unavailable', from=current_nick});
+                                                               broadcast_presence_stanza(room, p, '303', to_nick);
+                                                               rooms:remove(room, current_nick);
+                                                               rooms:set(room, to, data);
+                                                               jid_nick:set(from, room, to);
+                                                               pr.attr.from = to;
+                                                               rooms:get(room, to).sessions[from] = pr;
+                                                               broadcast_presence_stanza(room, pr);
+                                                       else
+                                                               --TODO malformed-jid
+                                                       end
                                                end
                                        end
-                               end
+                               --else -- possible rejoin
+                               --      log("debug", "%s had connection replaced", current_nick);
+                               --      handle_to_occupant(origin, st.presence({type='unavailable', from=from, to=to}):tag('status'):text('Replaced by new connection'):up()); -- send unavailable
+                               --      handle_to_occupant(origin, stanza); -- resend available
+                               --end
                        else -- enter room
+                               local new_nick = to;
                                if rooms:get(room, to) then
+                                       new_nick = nil;
+                               end
+                               if not new_nick then
+                                       log("debug", "%s couldn't join due to nick conflict: %s", from, to);
                                        origin.send(st.error_reply(stanza, "cancel", "conflict"));
                                else
+                                       log("debug", "%s joining as %s", from, to);
                                        local data;
                                        if not rooms:get(room) and not rooms_info:get(room) then -- new room
-                                               data = {affiliation='owner', role='moderator', jid=from};
+                                               rooms_info:set(room, 'name', (jid_split(room)));
+                                               data = {affiliation='owner', role='moderator', jid=from, sessions={[from]=get_filtered_presence(stanza)}};
                                        end
                                        if not data then -- new occupant
-                                               data = {affiliation='none', role='participant', jid=from};
+                                               data = {affiliation='none', role='participant', jid=from, sessions={[from]=get_filtered_presence(stanza)}};
                                        end
                                        rooms:set(room, to, data);
                                        jid_nick:set(from, room, to);
-                                       local r = rooms:get(room);
-                                       if r then
-                                               for occupant, o_data in pairs(r) do
-                                                       if occupant ~= from then
-                                                               local pres = st.presence({to=from, from=occupant})
-                                                                       :tag("x", {xmlns='http://jabber.org/protocol/muc#user'})
-                                                                       :tag("item", {affiliation=o_data.affiliation, role=o_data.role}):up();
-                                                               core_route_stanza(component, pres);
-                                                       end
-                                               end
-                                       end
-                                       broadcast_presence(nil, to, room);
-                                       -- TODO send discussion history
-                                       if rooms_info:get(room, 'subject') then
-                                               core_route_stanza(component, st.message({type='groupchat', from=room, to=from}):tag("subject"):text(rooms_info:get(room, 'subject')));
-                                       end
+                                       send_occupant_list(room, from);
+                                       pr.attr.from = to;
+                                       broadcast_presence_stanza(room, pr);
+                                       send_history(room, from);
                                end
                        end
                elseif type ~= 'result' then -- bad type
                        origin.send(st.error_reply(stanza, "modify", "bad-request")); -- FIXME correct error?
                end
-       elseif stanza.name == "message" and type == "groupchat" then
-               -- groupchat messages not allowed in PM
+       elseif not current_nick and type ~= "error" then -- not in room
+               origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));
+       elseif stanza.name == "message" and type == "groupchat" then -- groupchat messages not allowed in PM
                origin.send(st.error_reply(stanza, "modify", "bad-request"));
-       else
-               origin.send(st.error_reply(stanza, "cancel", "not-implemented", "Private stanzas not implemented")); -- TODO route private stanza
+       elseif stanza.name == "message" and type == "error" and get_kickable_error(stanza) then
+               log("debug", "%s kicked from %s for sending an error message", current_nick, room);
+               handle_to_occupant(origin, st.presence({type='unavailable', from=from, to=to}):tag('status'):text('This participant is kicked from the room because he sent an error message to another occupant')); -- send unavailable
+       else -- private stanza
+               local o_data = rooms:get(room, to);
+               if o_data then
+                       log("debug", "%s sent private stanza to %s (%s)", from, to, o_data.jid);
+                       local jid = o_data.jid;
+                       if stanza.name=='iq' and type=='get' and stanza.tags[1].attr.xmlns == 'vcard-temp' then jid = jid_bare(jid); end
+                       stanza.attr.to, stanza.attr.from = jid, current_nick;
+                       core_route_stanza(component, stanza);
+               elseif type ~= "error" and type ~= "result" then -- recipient not in room
+                       origin.send(st.error_reply(stanza, "cancel", "item-not-found", "Recipient not in room"));
+               end
        end
 end
 
@@ -235,14 +360,35 @@ function handle_to_room(origin, stanza) -- presence changes and groupchat messag
                if not current_nick then -- not in room
                        origin.send(st.error_reply(stanza, "cancel", "not-acceptable"));
                else
+                       local from = stanza.attr.from;
+                       stanza.attr.from = current_nick;
                        local subject = getText(stanza, {"subject"});
                        if subject then
-                               set_subject(current_nick, room, subject);
+                               set_subject(current_nick, room, subject); -- TODO use broadcast_message_stanza
                        else
-                               broadcast_message(current_nick, room, nil, getText(stanza, {"body"}));
-                               -- TODO add to discussion history
+                               broadcast_message_stanza(room, stanza, true);
                        end
                end
+       elseif stanza.name == "presence" then -- hack - some buggy clients send presence updates to the room rather than their nick
+               local to = stanza.attr.to;
+               local current_nick = jid_nick:get(stanza.attr.from, to);
+               if current_nick then
+                       stanza.attr.to = current_nick;
+                       handle_to_occupant(origin, stanza);
+                       stanza.attr.to = to;
+               elseif type ~= "error" and type ~= "result" then
+                       origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
+               end
+       elseif stanza.name == "message" and not stanza.attr.type and #stanza.tags == 1 and jid_nick:get(stanza.attr.from, stanza.attr.to)
+               and stanza.tags[1].name == "x" and stanza.tags[1].attr.xmlns == "http://jabber.org/protocol/muc#user" and #stanza.tags[1].tags == 1
+               and stanza.tags[1].tags[1].name == "invite" and stanza.tags[1].tags[1].attr.to then
+               local _from, _to = stanza.attr.from, stanza.attr.to;
+               local _invitee = stanza.tags[1].tags[1].attr.to;
+               stanza.attr.from, stanza.attr.to = _to, _invitee;
+               stanza.tags[1].tags[1].attr.from, stanza.tags[1].tags[1].attr.to = _from, nil;
+               core_route_stanza(component, stanza);
+               stanza.tags[1].tags[1].attr.from, stanza.tags[1].tags[1].attr.to = nil, _invitee;
+               stanza.attr.from, stanza.attr.to = _from, _to;
        else
                if type == "error" or type == "result" then return; end
                origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
@@ -266,12 +412,9 @@ function handle_to_domain(origin, stanza)
        end
 end
 
-function handle_stanza(origin, stanza)
+register_component(muc_domain, function(origin, stanza)
        local to_node, to_host, to_resource = jid_split(stanza.attr.to);
-       if stanza.name == "presence" and stanza.attr.type ~= nil and stanza.attr.type ~= "unavailable" then
-               if type == "error" or type == "result" then return; end
-               origin.send(st.error_reply(stanza, "cancel", "service-unavailable")); -- FIXME what's appropriate?
-       elseif to_resource and not to_node then
+       if to_resource and not to_node then
                if type == "error" or type == "result" then return; end
                origin.send(st.error_reply(stanza, "cancel", "service-unavailable")); -- host/resource
        elseif to_resource then
@@ -282,11 +425,7 @@ function handle_stanza(origin, stanza)
                if type == "error" or type == "result" then return; end
                handle_to_domain(origin, stanza);
        end
-end
-
-module.load_component = function()
-       return handle_stanza; -- Return the function that we want to handle incoming stanzas
-end
+end);
 
 module.unload = function()
        deregister_component(muc_domain);