0.2->0.3
[prosody.git] / core / stanza_router.lua
index fc8cfa92aff4e17170045221848802ff8bfbdf10..844cbf881a9c5d53eada5d5f6f99c00145ec65fa 100644 (file)
@@ -1,9 +1,12 @@
+-- Prosody IM v0.3
+-- Copyright (C) 2008 Matthew Wild
+-- Copyright (C) 2008 Waqas Hussain
+-- 
+-- This project is MIT/X11 licensed. Please see the
+-- COPYING file in the source package for more information.
+--
 
--- The code in this file should be self-explanatory, though the logic is horrible
--- for more info on that, see doc/stanza_routing.txt, which attempts to condense
--- the rules from the RFCs (mainly 3921)
 
-require "core.servermanager"
 
 local log = require "util.logger".init("stanzarouter")
 
@@ -13,20 +16,38 @@ local user_exists = require "core.usermanager".user_exists;
 
 local rostermanager = require "core.rostermanager";
 local sessionmanager = require "core.sessionmanager";
+local offlinemanager = require "core.offlinemanager";
 
 local s2s_verify_dialback = require "core.s2smanager".verify_dialback;
 local s2s_make_authenticated = require "core.s2smanager".make_authenticated;
 
 local modules_handle_stanza = require "core.modulemanager".handle_stanza;
+local component_handle_stanza = require "core.componentmanager".handle_stanza;
+
+local handle_outbound_presence_subscriptions_and_probes = require "core.presencemanager".handle_outbound_presence_subscriptions_and_probes;
+local handle_inbound_presence_subscriptions_and_probes = require "core.presencemanager".handle_inbound_presence_subscriptions_and_probes;
+local handle_normal_presence = require "core.presencemanager".handle_normal_presence;
 
 local format = string.format;
 local tostring = tostring;
+local t_concat = table.concat;
+local t_insert = table.insert;
+local tonumber = tonumber;
+local s_find = string.find;
 
 local jid_split = require "util.jid".split;
+local jid_prepped_split = require "util.jid".prepped_split;
 local print = print;
+local function checked_error_reply(origin, stanza)
+       if (stanza.attr.xmlns == "jabber:client" or stanza.attr.xmlns == "jabber:server") and stanza.attr.type ~= "error" and stanza.attr.type ~= "result" then
+               origin.send(st.error_reply(stanza, "cancel", "service-unavailable")); -- FIXME correct error?
+       end
+end
 
 function core_process_stanza(origin, stanza)
-       log("debug", "Received["..origin.type.."]: "..tostring(stanza))
+       (origin.log or log)("debug", "Received[%s]: %s", origin.type, stanza:top_tag())
+
+       if not stanza.attr.xmlns then stanza.attr.xmlns = "jabber:client"; end -- FIXME Hack. This should be removed when we fix namespace handling.
        -- TODO verify validity of stanza (as well as JID validity)
        if stanza.name == "iq" and not(#stanza.tags == 1 and stanza.tags[1].attr.xmlns) then
                if stanza.attr.type == "set" or stanza.attr.type == "get" then
@@ -42,28 +63,73 @@ function core_process_stanza(origin, stanza)
                error("Client MUST bind resource after auth");
        end
 
-       local to = stanza.attr.to;
-       -- TODO also, stazas should be returned to their original state before the function ends
+       -- TODO also, stanzas should be returned to their original state before the function ends
        if origin.type == "c2s" then
-               stanza.attr.from = origin.full_jid; -- quick fix to prevent impersonation (FIXME this would be incorrect when the origin is not c2s)
+               stanza.attr.from = origin.full_jid;
        end
-       
-       if not to then
-               core_handle_stanza(origin, stanza);
-       elseif origin.type == "c2s" and stanza.name == "presence" and stanza.attr.type ~= nil and stanza.attr.type ~= "unavailable" then
-               local node, host = jid_split(stanza.attr.to);
-               local to_bare = node and (node.."@"..host) or host; -- bare JID
-               local from_node, from_host = jid_split(stanza.attr.from);
-               local from_bare = from_node and (from_node.."@"..from_host) or from_host; -- bare JID
-               handle_outbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare);
-       elseif hosts[to] and hosts[to].type == "local" then
-               core_handle_stanza(origin, stanza);
-       elseif stanza.name == "iq" and not select(3, jid_split(to)) then
+       local to, xmlns = stanza.attr.to, stanza.attr.xmlns;
+       local from = stanza.attr.from;
+       local node, host, resource;
+       local from_node, from_host, from_resource;
+       local to_bare, from_bare;
+       if to then
+               node, host, resource = jid_prepped_split(to);
+               if not host then
+                       error("Invalid to JID");
+               end
+               to_bare = node and (node.."@"..host) or host; -- bare JID
+               if resource then to = to_bare.."/"..resource; else to = to_bare; end
+               stanza.attr.to = to;
+       end
+       if from then
+               from_node, from_host, from_resource = jid_prepped_split(from);
+               if not from_host then
+                       error("Invalid from JID");
+               end
+               from_bare = from_node and (from_node.."@"..from_host) or from_host; -- bare JID
+               if from_resource then from = from_bare.."/"..from_resource; else from = from_bare; end
+               stanza.attr.from = from;
+       end
+
+       --[[if to and not(hosts[to]) and not(hosts[to_bare]) and (hosts[host] and hosts[host].type ~= "local") then -- not for us?
+               log("warn", "stanza recieved for a non-local server");
+               return; -- FIXME what should we do here?
+       end]] -- FIXME
+
+       -- FIXME do stanzas not of jabber:client get handled by components?
+       if (origin.type == "s2sin" or origin.type == "c2s") and (not xmlns or xmlns == "jabber:server" or xmlns == "jabber:client") then                        
+               if origin.type == "s2sin" and not origin.dummy then
+                       local host_status = origin.hosts[from_host];
+                       if not host_status or not host_status.authed then -- remote server trying to impersonate some other server?
+                               log("warn", "Received a stanza claiming to be from %s, over a conn authed for %s!", from_host, origin.from_host);
+                               return; -- FIXME what should we do here? does this work with subdomains?
+                       end
+               end
+               if not to then
+                       core_handle_stanza(origin, stanza);
+               elseif hosts[to] and hosts[to].type == "local" then -- directed at a local server
+                       core_handle_stanza(origin, stanza);
+               elseif stanza.attr.xmlns and stanza.attr.xmlns ~= "jabber:client" and stanza.attr.xmlns ~= "jabber:server" then
+                       modules_handle_stanza(host or origin.host or origin.to_host, origin, stanza);
+               elseif hosts[to] and hosts[to].type == "component" then -- hack to allow components to handle node@server/resource and server/resource
+                       component_handle_stanza(origin, stanza);
+               elseif hosts[to_bare] and hosts[to_bare].type == "component" then -- hack to allow components to handle node@server
+                       component_handle_stanza(origin, stanza);
+               elseif hosts[host] and hosts[host].type == "component" then -- directed at a component
+                       component_handle_stanza(origin, stanza);
+               elseif origin.type == "c2s" and stanza.name == "presence" and stanza.attr.type ~= nil and stanza.attr.type ~= "unavailable" then
+                       handle_outbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare, core_route_stanza);
+               elseif origin.type ~= "c2s" and stanza.name == "iq" and not resource then -- directed at bare JID
+                       core_handle_stanza(origin, stanza);
+               else
+                       if origin.type == "c2s" and stanza.name == "presence" and to ~= nil and not(origin.roster[to_bare] and (origin.roster[to_bare].subscription == "both" or origin.roster[to_bare].subscription == "from")) then
+                               origin.directed = origin.directed or {};
+                               t_insert(origin.directed, to); -- FIXME does it make more sense to add to_bare rather than to?
+                       end
+                       core_route_stanza(origin, stanza);
+               end
+       else
                core_handle_stanza(origin, stanza);
-       elseif stanza.attr.xmlns ~= "jabber:client" and stanza.attr.xmlns ~= "jabber:server" then
-               modules_handle_stanza(origin, stanza);
-       elseif origin.type == "c2s" or origin.type == "s2sin" then
-               core_route_stanza(origin, stanza);
        end
 end
 
@@ -71,165 +137,34 @@ end
 -- that is, they are handled by this server
 function core_handle_stanza(origin, stanza)
        -- Handlers
-       if modules_handle_stanza(origin, stanza) then return; end
-       if origin.type == "c2s" or origin.type == "c2s_unauthed" then
-               local session = origin;
-               
-               if stanza.name == "presence" and origin.roster then
-                       if stanza.attr.type == nil or stanza.attr.type == "unavailable" then
-                               for jid in pairs(origin.roster) do -- broadcast to all interested contacts
-                                       local subscription = origin.roster[jid].subscription;
-                                       if subscription == "both" or subscription == "from" then
-                                               stanza.attr.to = jid;
-                                               core_route_stanza(origin, stanza);
-                                       end
-                               end
-                               local node, host = jid_split(stanza.attr.from);
-                               for _, res in pairs(hosts[host].sessions[node].sessions) do -- broadcast to all resources
-                                       if res ~= origin and res.full_jid then -- to resource. FIXME is res.full_jid the correct check? Maybe it should be res.presence
-                                               stanza.attr.to = res.full_jid;
-                                               core_route_stanza(origin, stanza);
-                                       end
-                               end
-                               if not origin.presence then -- presence probes on initial presence -- FIXME does unavailable qualify as initial presence?
-                                       local probe = st.presence({from = origin.full_jid, type = "probe"});
-                                       for jid in pairs(origin.roster) do -- probe all contacts we are subscribed to
-                                               local subscription = origin.roster[jid].subscription;
-                                               if subscription == "both" or subscription == "to" then
-                                                       probe.attr.to = jid;
-                                                       core_route_stanza(origin, probe);
-                                               end
-                                       end
-                                       for _, res in pairs(hosts[host].sessions[node].sessions) do -- broadcast from all resources
-                                               if res ~= origin and stanza.attr.type ~= "unavailable" and res.presence then -- FIXME does unavailable qualify as initial presence?
-                                                       res.presence.attr.to = origin.full_jid;
-                                                       core_route_stanza(res, res.presence);
-                                                       res.presence.attr.to = nil;
-                                               end
-                                       end
-                                       -- TODO resend subscription requests
+       if modules_handle_stanza(select(2, jid_split(stanza.attr.to)) or origin.host, origin, stanza) then return; end
+       if origin.type == "c2s" or origin.type == "s2sin" then
+               if origin.type == "c2s" then
+                       if stanza.name == "presence" and origin.roster then
+                               if stanza.attr.type == nil or stanza.attr.type == "unavailable" then
+                                       handle_normal_presence(origin, stanza, core_route_stanza);
+                               else
+                                       log("warn", "Unhandled c2s presence: %s", tostring(stanza));
+                                       checked_error_reply(origin, stanza);
                                end
-                               origin.presence = stanza;
-                               stanza.attr.to = nil; -- reset it
                        else
-                               -- TODO error, bad type
+                               log("warn", "Unhandled c2s stanza: %s", tostring(stanza));
+                               checked_error_reply(origin, stanza);
                        end
+               else -- s2s stanzas
+                       log("warn", "Unhandled s2s stanza: %s", tostring(stanza));
+                       checked_error_reply(origin, stanza);
                end
        else
-               log("warn", "Unhandled origin: %s", origin.type);
+               log("warn", "Unhandled %s stanza: %s", origin.type, tostring(stanza));
+               checked_error_reply(origin, stanza);
        end
 end
 
-function send_presence_of_available_resources(user, host, jid, recipient_session)
-       local h = hosts[host];
-       local count = 0;
-       if h and h.type == "local" then
-               local u = h.sessions[user];
-               if u then
-                       for k, session in pairs(u.sessions) do
-                               local pres = session.presence;
-                               if pres then
-                                       pres.attr.to = jid;
-                                       pres.attr.from = session.full_jid;
-                                       recipient_session.send(pres);
-                                       pres.attr.to = nil;
-                                       pres.attr.from = nil;
-                                       count = count + 1;
-                               end
-                       end
-               end
-       end
-       return count;
-end
-
-function handle_outbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare)
-       local node, host = jid_split(from_bare);
-       local st_from, st_to = stanza.attr.from, stanza.attr.to;
-       stanza.attr.from, stanza.attr.to = from_bare, to_bare;
-       if stanza.attr.type == "subscribe" then
-               log("debug", "outbound subscribe from "..from_bare.." for "..to_bare);
-               -- 1. route stanza
-               -- 2. roster push (subscription = none, ask = subscribe)
-               if rostermanager.set_contact_pending_out(node, host, to_bare) then
-                       rostermanager.roster_push(node, host, to_bare);
-               end -- else file error
-               core_route_stanza(origin, stanza);
-       elseif stanza.attr.type == "unsubscribe" then
-               log("debug", "outbound unsubscribe from "..from_bare.." for "..to_bare);
-               -- 1. route stanza
-               -- 2. roster push (subscription = none or from)
-               if rostermanager.unsubscribe(node, host, to_bare) then
-                       rostermanager.roster_push(node, host, to_bare); -- FIXME do roster push when roster has in fact not changed?
-               end -- else file error
-               core_route_stanza(origin, stanza);
-       elseif stanza.attr.type == "subscribed" then
-               log("debug", "outbound subscribed from "..from_bare.." for "..to_bare);
-               -- 1. route stanza
-               -- 2. roster_push ()
-               -- 3. send_presence_of_available_resources
-               if rostermanager.subscribed(node, host, to_bare) then
-                       rostermanager.roster_push(node, host, to_bare);
-                       core_route_stanza(origin, stanza);
-                       send_presence_of_available_resources(node, host, to_bare, origin);
-               end
-       elseif stanza.attr.type == "unsubscribed" then
-               log("debug", "outbound unsubscribed from "..from_bare.." for "..to_bare);
-               -- 1. route stanza
-               -- 2. roster push (subscription = none or to)
-               if rostermanager.unsubscribed(node, host, to_bare) then
-                       rostermanager.roster_push(node, host, to_bare);
-                       core_route_stanza(origin, stanza);
-               end
-       end
-       stanza.attr.from, stanza.attr.to = st_from, st_to;
-end
-
-function handle_inbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare)
-       local node, host = jid_split(to_bare);
-       local st_from, st_to = stanza.attr.from, stanza.attr.to;
-       stanza.attr.from, stanza.attr.to = from_bare, to_bare;
-       if stanza.attr.type == "probe" then
-               if rostermanager.is_contact_subscribed(node, host, from_bare) then
-                       if 0 == send_presence_of_available_resources(node, host, from_bare, origin) then
-                               -- TODO send last recieved unavailable presence (or we MAY do nothing, which is fine too)
-                       end
-               else
-                       core_route_stanza(origin, st.presence({from=to_bare, to=from_bare, type="unsubscribed"}));
-               end
-       elseif stanza.attr.type == "subscribe" then
-               log("debug", "inbound subscribe from "..from_bare.." for "..to_bare);
-               if rostermanager.is_contact_subscribed(node, host, from_bare) then
-                       core_route_stanza(origin, st.presence({from=to_bare, to=from_bare, type="subscribed"})); -- already subscribed
-               else
-                       if not rostermanager.is_contact_pending_in(node, host, from_bare) then
-                               if rostermanager.set_contact_pending_in(node, host, from_bare) then
-                                       sessionmanager.send_to_available_resources(node, host, stanza);
-                               end -- TODO else return error, unable to save
-                       end
-               end
-       elseif stanza.attr.type == "unsubscribe" then
-               log("debug", "inbound unsubscribe from "..from_bare.." for "..to_bare);
-               if rostermanager.process_inbound_unsubscribe(node, host, from_bare) then
-                       rostermanager.roster_push(node, host, from_bare);
-               end
-       elseif stanza.attr.type == "subscribed" then
-               log("debug", "inbound subscribed from "..from_bare.." for "..to_bare);
-               if rostermanager.process_inbound_subscription_approval(node, host, from_bare) then
-                       rostermanager.roster_push(node, host, from_bare);
-               end
-       elseif stanza.attr.type == "unsubscribed" then
-               log("debug", "inbound unsubscribed from "..from_bare.." for "..to_bare);
-               if rostermanager.process_inbound_subscription_approval(node, host, from_bare) then
-                       rostermanager.roster_push(node, host, from_bare);
-               end
-       end -- discard any other type
-       stanza.attr.from, stanza.attr.to = st_from, st_to;
-end
-
 function core_route_stanza(origin, stanza)
        -- Hooks
        --- ...later
-       
+
        -- Deliver
        local to = stanza.attr.to;
        local node, host, resource = jid_split(to);
@@ -238,6 +173,10 @@ function core_route_stanza(origin, stanza)
        local from_node, from_host, from_resource = jid_split(from);
        local from_bare = from_node and (from_node.."@"..from_host) or from_host; -- bare JID
 
+       -- Auto-detect origin if not specified
+       origin = origin or hosts[from_host];
+       if not origin then return false; end
+       
        if stanza.name == "presence" and (stanza.attr.type ~= nil and stanza.attr.type ~= "unavailable") then resource = nil; end
 
        local host_session = hosts[host]
@@ -250,24 +189,36 @@ function core_route_stanza(origin, stanza)
                                -- if we get here, resource was not specified or was unavailable
                                if stanza.name == "presence" then
                                        if stanza.attr.type ~= nil and stanza.attr.type ~= "unavailable" then
-                                               handle_inbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare);
+                                               handle_inbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare, core_route_stanza);
                                        else -- sender is available or unavailable
-                                               for k in pairs(user.sessions) do -- presence broadcast to all user resources. FIXME should this be just for available resources? Do we need to check subscription?
-                                                       if user.sessions[k].full_jid then
-                                                               stanza.attr.to = user.sessions[k].full_jid; -- reset at the end of function
-                                                               user.sessions[k].send(stanza);
+                                               for _, session in pairs(user.sessions) do -- presence broadcast to all user resources.
+                                                       if session.full_jid then -- FIXME should this be just for available resources? Do we need to check subscription?
+                                                               stanza.attr.to = session.full_jid; -- reset at the end of function
+                                                               session.send(stanza);
                                                        end
                                                end
                                        end
                                elseif stanza.name == "message" then -- select a resource to recieve message
-                                       for k in pairs(user.sessions) do
-                                               if user.sessions[k].full_jid then
-                                                       res = user.sessions[k];
-                                                       break;
+                                       local priority = 0;
+                                       local recipients = {};
+                                       for _, session in pairs(user.sessions) do -- find resource with greatest priority
+                                               local p = session.priority;
+                                               if p > priority then
+                                                       priority = p;
+                                                       recipients = {session};
+                                               elseif p == priority then
+                                                       t_insert(recipients, session);
                                                end
                                        end
-                                       -- TODO find resource with greatest priority
-                                       res.send(stanza);
+                                       local count = 0;
+                                       for _, session in pairs(recipients) do
+                                               session.send(stanza);
+                                               count = count + 1;
+                                       end
+                                       if count == 0 then
+                                               offlinemanager.store(node, host, stanza);
+                                               -- TODO deal with storage errors
+                                       end
                                else
                                        -- TODO send IQ error
                                end
@@ -281,19 +232,25 @@ function core_route_stanza(origin, stanza)
                        if user_exists(node, host) then
                                if stanza.name == "presence" then
                                        if stanza.attr.type ~= nil and stanza.attr.type ~= "unavailable" then
-                                               handle_inbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare);
+                                               handle_inbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare, core_route_stanza);
                                        else
                                                -- TODO send unavailable presence or unsubscribed
                                        end
-                               elseif stanza.name == "message" then
-                                       -- TODO send message error, or store offline messages
+                               elseif stanza.name == "message" then -- FIXME if full jid, then send out to resources with highest priority
+                                       if stanza.attr.type == "chat" or stanza.attr.type == "normal" or not stanza.attr.type then
+                                               offlinemanager.store(node, host, stanza);
+                                               -- FIXME don't store messages with only chat state notifications
+                                       end
+                                       -- TODO allow configuration of offline storage
+                                       -- TODO send error if not storing offline
                                elseif stanza.name == "iq" then
-                                       -- TODO send IQ error
+                                       origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
                                end
                        else -- user does not exist
                                -- TODO we would get here for nodeless JIDs too. Do something fun maybe? Echo service? Let plugins use xmpp:server/resource addresses?
                                if stanza.name == "presence" then
-                                       if stanza.attr.type == "probe" then
+                                       local t = stanza.attr.type;
+                                       if t == "subscribe" or t == "probe" then
                                                origin.send(st.presence({from = to_bare, to = from_bare, type = "unsubscribed"}));
                                        end
                                        -- else ignore
@@ -310,12 +267,12 @@ function core_route_stanza(origin, stanza)
                log("debug", "sending s2s stanza: %s", tostring(stanza));
                send_s2s(origin.host, host, stanza); -- TODO handle remote routing errors
                stanza.attr.xmlns = xmlns; -- reset
+       elseif origin.type == "component" or origin.type == "local" then
+               -- Route via s2s for components and modules
+               log("debug", "Routing outgoing stanza for %s to %s", origin.host, host);
+               send_s2s(origin.host, host, stanza);
        else
                log("warn", "received stanza from unhandled connection type: %s", origin.type);
        end
        stanza.attr.to = to; -- reset
 end
-
-function handle_stanza_toremote(stanza)
-       log("error", "Stanza bound for remote host, but s2s is not implemented");
-end