core/stanza_router.lua

   1 -- Prosody IM v0.4
   2 -- Copyright (C) 2008-2009 Matthew Wild
   3 -- Copyright (C) 2008-2009 Waqas Hussain
   4 --
   5 -- This project is MIT/X11 licensed. Please see the
   6 -- COPYING file in the source package for more information.
   7 --
   8
   9
  10
  11 local log = require "util.logger".init("stanzarouter")
  12
  13 local hosts = _G.hosts;
  14
  15 local st = require "util.stanza";
  16 local send_s2s = require "core.s2smanager".send_to_host;
  17 local user_exists = require "core.usermanager".user_exists;
  18
  19 local rostermanager = require "core.rostermanager";
  20 local sessionmanager = require "core.sessionmanager";
  21 local offlinemanager = require "core.offlinemanager";
  22
  23 local s2s_verify_dialback = require "core.s2smanager".verify_dialback;
  24 local s2s_make_authenticated = require "core.s2smanager".make_authenticated;
  25
  26 local modules_handle_stanza = require "core.modulemanager".handle_stanza;
  27 local component_handle_stanza = require "core.componentmanager".handle_stanza;
  28
  29 local handle_outbound_presence_subscriptions_and_probes = function()end;--require "core.presencemanager".handle_outbound_presence_subscriptions_and_probes;
  30 local handle_inbound_presence_subscriptions_and_probes = function()end;--require "core.presencemanager".handle_inbound_presence_subscriptions_and_probes;
  31 local handle_normal_presence = function()end;--require "core.presencemanager".handle_normal_presence;
  32
  33 local format = string.format;
  34 local tostring = tostring;
  35 local t_concat = table.concat;
  36 local t_insert = table.insert;
  37 local tonumber = tonumber;
  38 local s_find = string.find;
  39 local pairs = pairs;
  40 local ipairs = ipairs;
  41
  42 local jid_split = require "util.jid".split;
  43 local jid_prepped_split = require "util.jid".prepped_split;
  44 local print = print;
  45 local fire_event = require "core.eventmanager2".fire_event;
  46 local function checked_error_reply(origin, stanza)
  47         if (stanza.attr.xmlns == "jabber:client" or stanza.attr.xmlns == "jabber:server") and stanza.attr.type ~= "error" and stanza.attr.type ~= "result" then
  48                 origin.send(st.error_reply(stanza, "cancel", "service-unavailable")); -- FIXME correct error?
  49         end
  50 end
  51
  52 function core_process_stanza(origin, stanza)
  53         (origin.log or log)("debug", "Received[%s]: %s", origin.type, stanza:top_tag())
  54
  55         if not stanza.attr.xmlns then stanza.attr.xmlns = "jabber:client"; end -- FIXME Hack. This should be removed when we fix namespace handling.
  56         -- TODO verify validity of stanza (as well as JID validity)
  57         if stanza.attr.xmlns == "error" and #stanza.tags == 0 then return; end -- TODO invalid stanza, log
  58         if stanza.name == "iq" then
  59                 if (stanza.attr.type == "set" or stanza.attr.type == "get") and #stanza.tags ~= 1 then
  60                         origin.send(st.error_reply(stanza, "modify", "bad-request"));
  61                         return;
  62                 end
  63         end
  64
  65         if origin.type == "c2s" and not origin.full_jid
  66                 and not(stanza.name == "iq" and stanza.tags[1].name == "bind"
  67                                 and stanza.tags[1].attr.xmlns == "urn:ietf:params:xml:ns:xmpp-bind") then
  68                 error("Client MUST bind resource after auth");
  69         end
  70
  71         -- TODO also, stanzas should be returned to their original state before the function ends
  72         if origin.type == "c2s" then
  73                 stanza.attr.from = origin.full_jid;
  74         end
  75         local to, xmlns = stanza.attr.to, stanza.attr.xmlns;
  76         local from = stanza.attr.from;
  77         local node, host, resource;
  78         local from_node, from_host, from_resource;
  79         local to_bare, from_bare;
  80         if to then
  81                 node, host, resource = jid_prepped_split(to);
  82                 if not host then
  83                         error("Invalid to JID");
  84                 end
  85                 to_bare = node and (node.."@"..host) or host; -- bare JID
  86                 if resource then to = to_bare.."/"..resource; else to = to_bare; end
  87                 stanza.attr.to = to;
  88         end
  89         if from then
  90                 from_node, from_host, from_resource = jid_prepped_split(from);
  91                 if not from_host then
  92                         error("Invalid from JID");
  93                 end
  94                 from_bare = from_node and (from_node.."@"..from_host) or from_host; -- bare JID
  95                 if from_resource then from = from_bare.."/"..from_resource; else from = from_bare; end
  96                 stanza.attr.from = from;
  97         end
  98
  99         --[[if to and not(hosts[to]) and not(hosts[to_bare]) and (hosts[host] and hosts[host].type ~= "local") then -- not for us?
 100                 log("warn", "stanza recieved for a non-local server");
 101                 return; -- FIXME what should we do here?
 102         end]] -- FIXME
 103
 104         -- FIXME do stanzas not of jabber:client get handled by components?
 105         if (origin.type == "s2sin" or origin.type == "c2s" or origin.type == "component") and (not xmlns or xmlns == "jabber:server" or xmlns == "jabber:client") then
 106                 local event_data = {origin=origin, stanza=stanza};
 107                 fire_event(tostring(host or origin.host).."/"..stanza.name, event_data);
 108                 if origin.type == "s2sin" and not origin.dummy then
 109                         local host_status = origin.hosts[from_host];
 110                         if not host_status or not host_status.authed then -- remote server trying to impersonate some other server?
 111                                 log("warn", "Received a stanza claiming to be from %s, over a conn authed for %s!", from_host, origin.from_host);
 112                                 return; -- FIXME what should we do here? does this work with subdomains?
 113                         end
 114                 end
 115                 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 -- directed presence
 116                         origin.directed = origin.directed or {};
 117                         origin.directed[to] = true;
 118                         --t_insert(origin.directed, to); -- FIXME does it make more sense to add to_bare rather than to?
 119                 end
 120                 if not to then
 121                         core_handle_stanza(origin, stanza);
 122                 elseif hosts[to] and hosts[to].type == "local" then -- directed at a local server
 123                         core_handle_stanza(origin, stanza);
 124                 elseif stanza.attr.xmlns and stanza.attr.xmlns ~= "jabber:client" and stanza.attr.xmlns ~= "jabber:server" then
 125                         modules_handle_stanza(host or origin.host or origin.to_host, origin, stanza);
 126                 elseif hosts[to] and hosts[to].type == "component" then -- hack to allow components to handle node@server/resource and server/resource
 127                         component_handle_stanza(origin, stanza);
 128                 elseif hosts[to_bare] and hosts[to_bare].type == "component" then -- hack to allow components to handle node@server
 129                         component_handle_stanza(origin, stanza);
 130                 elseif hosts[host] and hosts[host].type == "component" then -- directed at a component
 131                         component_handle_stanza(origin, stanza);
 132                 elseif origin.type == "c2s" and stanza.name == "presence" and stanza.attr.type ~= nil and stanza.attr.type ~= "unavailable" and stanza.attr.type ~= "error" then
 133                         handle_outbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare, core_route_stanza);
 134                 elseif hosts[host] and hosts[host].type == "local" and stanza.name == "iq" and not resource then -- directed at bare JID
 135                         core_handle_stanza(origin, stanza);
 136                 else
 137                         core_route_stanza(origin, stanza);
 138                 end
 139         else
 140                 core_handle_stanza(origin, stanza);
 141         end
 142 end
 143
 144 -- This function handles stanzas which are not routed any further,
 145 -- that is, they are handled by this server
 146 function core_handle_stanza(origin, stanza)
 147         -- Handlers
 148         if modules_handle_stanza(select(2, jid_split(stanza.attr.to)) or origin.host, origin, stanza) then return; end
 149         if origin.type == "c2s" or origin.type == "s2sin" then
 150                 if origin.type == "c2s" then
 151                         if stanza.name == "presence" and origin.roster then
 152                                 if stanza.attr.type == nil or stanza.attr.type == "unavailable" and stanza.attr.type ~= "error" then
 153                                         handle_normal_presence(origin, stanza, core_route_stanza);
 154                                 else
 155                                         log("warn", "Unhandled c2s presence: %s", tostring(stanza));
 156                                         checked_error_reply(origin, stanza);
 157                                 end
 158                         else
 159                                 log("warn", "Unhandled c2s stanza: %s", tostring(stanza));
 160                                 checked_error_reply(origin, stanza);
 161                         end
 162                 else -- s2s stanzas
 163                         log("warn", "Unhandled s2s stanza: %s", tostring(stanza));
 164                         checked_error_reply(origin, stanza);
 165                 end
 166         else
 167                 log("warn", "Unhandled %s stanza: %s", origin.type, tostring(stanza));
 168                 checked_error_reply(origin, stanza);
 169         end
 170 end
 171
 172 function core_route_stanza(origin, stanza)
 173         -- Hooks
 174         --- ...later
 175
 176         -- Deliver
 177         local to = stanza.attr.to;
 178         local node, host, resource = jid_split(to);
 179         local to_bare = node and (node.."@"..host) or host; -- bare JID
 180         local from = stanza.attr.from;
 181         local from_node, from_host, from_resource = jid_split(from);
 182         local from_bare = from_node and (from_node.."@"..from_host) or from_host; -- bare JID
 183
 184         -- Auto-detect origin if not specified
 185         origin = origin or hosts[from_host];
 186         if not origin then return false; end
 187
 188         if hosts[to] and hosts[to].type == "component" then -- hack to allow components to handle node@server/resource and server/resource
 189                 return component_handle_stanza(origin, stanza);
 190         elseif hosts[to_bare] and hosts[to_bare].type == "component" then -- hack to allow components to handle node@server
 191                 return component_handle_stanza(origin, stanza);
 192         elseif hosts[host] and hosts[host].type == "component" then -- directed at a component
 193                 return component_handle_stanza(origin, stanza);
 194         end
 195
 196         if stanza.name == "presence" and (stanza.attr.type ~= nil and stanza.attr.type ~= "unavailable" and stanza.attr.type ~= "error") then resource = nil; end
 197
 198         local host_session = hosts[host]
 199         if host_session and host_session.type == "local" then
 200                 -- Local host
 201                 local user = host_session.sessions[node];
 202                 if user then
 203                         local res = user.sessions[resource];
 204                         if not res then
 205                                 -- if we get here, resource was not specified or was unavailable
 206                                 if stanza.name == "presence" then
 207                                         if stanza.attr.type ~= nil and stanza.attr.type ~= "unavailable" and stanza.attr.type ~= "error" then
 208                                                 handle_inbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare, core_route_stanza);
 209                                         elseif not resource then -- sender is available or unavailable or error
 210                                                 for _, session in pairs(user.sessions) do -- presence broadcast to all user resources.
 211                                                         if session.full_jid then -- FIXME should this be just for available resources? Do we need to check subscription?
 212                                                                 stanza.attr.to = session.full_jid; -- reset at the end of function
 213                                                                 session.send(stanza);
 214                                                         end
 215                                                 end
 216                                         end
 217                                 elseif stanza.name == "message" then -- select a resource to recieve message
 218                                         stanza.attr.to = to_bare;
 219                                         if stanza.attr.type == 'headline' then
 220                                                 for _, session in pairs(user.sessions) do -- find resource with greatest priority
 221                                                         if session.presence and session.priority >= 0 then
 222                                                                 session.send(stanza);
 223                                                         end
 224                                                 end
 225                                         elseif resource and stanza.attr.type == 'groupchat' then
 226                                                 -- Groupchat message sent to offline resource
 227                                                 origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
 228                                         else
 229                                                 local priority = 0;
 230                                                 local recipients = {};
 231                                                 for _, session in pairs(user.sessions) do -- find resource with greatest priority
 232                                                         if session.presence then
 233                                                                 local p = session.priority;
 234                                                                 if p > priority then
 235                                                                         priority = p;
 236                                                                         recipients = {session};
 237                                                                 elseif p == priority then
 238                                                                         t_insert(recipients, session);
 239                                                                 end
 240                                                         end
 241                                                 end
 242                                                 local count = 0;
 243                                                 for _, session in ipairs(recipients) do
 244                                                         session.send(stanza);
 245                                                         count = count + 1;
 246                                                 end
 247                                                 if count == 0 and (stanza.attr.type == "chat" or stanza.attr.type == "normal" or not stanza.attr.type) then
 248                                                         offlinemanager.store(node, host, stanza);
 249                                                         -- TODO deal with storage errors
 250                                                 end
 251                                         end
 252                                 elseif stanza.attr.type == "get" or stanza.attr.type == "set" then
 253                                         origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
 254                                 end
 255                         else
 256                                 -- User + resource is online...
 257                                 stanza.attr.to = res.full_jid; -- reset at the end of function
 258                                 res.send(stanza); -- Yay \o/
 259                         end
 260                 else
 261                         -- user not online
 262                         if user_exists(node, host) then
 263                                 if stanza.name == "presence" then
 264                                         if stanza.attr.type ~= nil and stanza.attr.type ~= "unavailable" and stanza.attr.type ~= "error" then
 265                                                 handle_inbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare, core_route_stanza);
 266                                         else
 267                                                 -- TODO send unavailable presence or unsubscribed
 268                                         end
 269                                 elseif stanza.name == "message" then -- FIXME if full jid, then send out to resources with highest priority
 270                                         stanza.attr.to = to_bare; -- TODO not in RFC, but seems obvious. Should discuss on the mailing list.
 271                                         if stanza.attr.type == "chat" or stanza.attr.type == "normal" or not stanza.attr.type then
 272                                                 offlinemanager.store(node, host, stanza);
 273                                                 -- FIXME don't store messages with only chat state notifications
 274                                         elseif stanza.attr.type == "groupchat" then
 275                                                 local reply = st.error_reply(stanza, "cancel", "service-unavailable");
 276                                                 reply.attr.from = to;
 277                                                 origin.send(reply);
 278                                         end
 279                                         -- TODO allow configuration of offline storage
 280                                         -- TODO send error if not storing offline
 281                                 elseif stanza.name == "iq" and (stanza.attr.type == "get" or stanza.attr.type == "set") then
 282                                         origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
 283                                 end
 284                         else -- user does not exist
 285                                 -- TODO we would get here for nodeless JIDs too. Do something fun maybe? Echo service? Let plugins use xmpp:server/resource addresses?
 286                                 if stanza.name == "presence" then
 287                                         local t = stanza.attr.type;
 288                                         if t == "subscribe" or t == "probe" then
 289                                                 origin.send(st.presence({from = to_bare, to = from_bare, type = "unsubscribed"}));
 290                                         end
 291                                         -- else ignore
 292                                 elseif stanza.attr.type ~= "error" and (stanza.name ~= "iq" or stanza.attr.type ~= "result") then
 293                                         origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
 294                                 end
 295                         end
 296                 end
 297         elseif origin.type == "c2s" then
 298                 -- Remote host
 299                 local xmlns = stanza.attr.xmlns;
 300                 --stanza.attr.xmlns = "jabber:server";
 301                 stanza.attr.xmlns = nil;
 302                 log("debug", "sending s2s stanza: %s", tostring(stanza));
 303                 send_s2s(origin.host, host, stanza); -- TODO handle remote routing errors
 304                 stanza.attr.xmlns = xmlns; -- reset
 305         elseif origin.type == "component" or origin.type == "local" then
 306                 -- Route via s2s for components and modules
 307                 log("debug", "Routing outgoing stanza for %s to %s", origin.host, host);
 308                 send_s2s(origin.host, host, stanza);
 309         else
 310                 log("warn", "received stanza from unhandled connection type: %s", origin.type);
 311         end
 312         stanza.attr.to = to; -- reset
 313 end