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 = prosody.events.fire_event;
  46
  47 local select_best_resources;
  48
  49 function core_process_stanza(origin, stanza)
  50         (origin.log or log)("debug", "Received[%s]: %s", origin.type, stanza:top_tag())
  51
  52         -- Currently we guarantee every stanza to have an xmlns, should we keep this rule?
  53         if not stanza.attr.xmlns then stanza.attr.xmlns = "jabber:client"; end
  54
  55         -- TODO verify validity of stanza (as well as JID validity)
  56         if stanza.attr.type == "error" and #stanza.tags == 0 then return; end -- TODO invalid stanza, log
  57         if stanza.name == "iq" then
  58                 if (stanza.attr.type == "set" or stanza.attr.type == "get") and #stanza.tags ~= 1 then
  59                         origin.send(st.error_reply(stanza, "modify", "bad-request"));
  60                         return;
  61                 end
  62         end
  63
  64         if origin.type == "c2s" and not origin.full_jid
  65                 and not(stanza.name == "iq" and stanza.attr.type == "set" and stanza.tags[1] and stanza.tags[1].name == "bind"
  66                                 and stanza.tags[1].attr.xmlns == "urn:ietf:params:xml:ns:xmpp-bind") then
  67                 -- authenticated client isn't bound and current stanza is not a bind request
  68                 origin.send(st.error_reply(stanza, "auth", "not-authorized")); -- FIXME maybe allow stanzas to account or server
  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                         log("warn", "Received stanza with invalid destination JID: %s", to);
  84                         origin.send(st.error_reply(stanza, "modify", "jid-malformed", "The destination address is invalid: "..to));
  85                         return;
  86                 end
  87                 to_bare = node and (node.."@"..host) or host; -- bare JID
  88                 if resource then to = to_bare.."/"..resource; else to = to_bare; end
  89                 stanza.attr.to = to;
  90         end
  91         if from then
  92                 -- We only stamp the 'from' on c2s stanzas, so we still need to check validity
  93                 from_node, from_host, from_resource = jid_prepped_split(from);
  94                 if not from_host then
  95                         log("warn", "Received stanza with invalid source JID: %s", from);
  96                         origin.send(st.error_reply(stanza, "modify", "jid-malformed", "The source address is invalid: "..from));
  97                         return;
  98                 end
  99                 from_bare = from_node and (from_node.."@"..from_host) or from_host; -- bare JID
 100                 if from_resource then from = from_bare.."/"..from_resource; else from = from_bare; end
 101                 stanza.attr.from = from;
 102         end
 103
 104         --[[if to and not(hosts[to]) and not(hosts[to_bare]) and (hosts[host] and hosts[host].type ~= "local") then -- not for us?
 105                 log("warn", "stanza recieved for a non-local server");
 106                 return; -- FIXME what should we do here?
 107         end]] -- FIXME
 108
 109         if (origin.type == "s2sin" or origin.type == "c2s" or origin.type == "component") and xmlns == "jabber:client" then
 110                 if origin.type == "s2sin" and not origin.dummy then
 111                         local host_status = origin.hosts[from_host];
 112                         if not host_status or not host_status.authed then -- remote server trying to impersonate some other server?
 113                                 log("warn", "Received a stanza claiming to be from %s, over a stream authed for %s!", from_host, origin.from_host);
 114                                 return; -- FIXME what should we do here? does this work with subdomains?
 115                         end
 116                 end
 117                 core_post_stanza(origin, stanza);
 118         else
 119                 local h = hosts[stanza.attr.to or origin.host or origin.to_host];
 120                 if h then
 121                         local event;
 122                         if stanza.attr.xmlns == "jabber:client" then
 123                                 if stanza.name == "iq" and (stanza.attr.type == "set" or stanza.attr.type == "get") then
 124                                         event = "stanza/iq/"..stanza.tags[1].attr.xmlns..":"..stanza.tags[1].name;
 125                                 else
 126                                         event = "stanza/"..stanza.name;
 127                                 end
 128                         else
 129                                 event = "stanza/"..stanza.attr.xmlns..":"..stanza.name;
 130                         end
 131                         if h.events.fire_event(event, {origin = origin, stanza = stanza}) then return; end
 132                 end
 133                 modules_handle_stanza(host or origin.host or origin.to_host, origin, stanza);
 134         end
 135 end
 136
 137 function core_post_stanza(origin, stanza)
 138         local to = stanza.attr.to;
 139         local node, host, resource = jid_split(to);
 140         local to_bare = node and (node.."@"..host) or host; -- bare JID
 141
 142         local to_type;
 143         if node then
 144                 if resource then
 145                         to_type = '/full';
 146                 else
 147                         to_type = '/bare';
 148                 end
 149         else
 150                 if host then
 151                         to_type = '/host';
 152                 else
 153                         to_type = '/bare';
 154                 end
 155         end
 156
 157         local event_data = {origin=origin, stanza=stanza};
 158         if origin.full_jid then -- c2s connection
 159                 if hosts[origin.host].events.fire_event('pre-'..stanza.name..to_type, event_data) then return; end -- do preprocessing
 160         end
 161         local h = hosts[to_bare] or hosts[host or origin.host];
 162         if h then
 163                 if h.type == "component" then
 164                         component_handle_stanza(origin, stanza);
 165                         return;
 166                 else
 167                         if h.events.fire_event(stanza.name..to_type, event_data) then return; end -- do processing
 168                 end
 169         end
 170
 171         if host and fire_event(host.."/"..stanza.name, event_data) then
 172                 -- event handled
 173         elseif stanza.name == "presence" and origin.host and fire_event(origin.host.."/"..stanza.name, event_data) then
 174                 -- event handled
 175         elseif not to then
 176                 modules_handle_stanza(host or origin.host or origin.to_host, origin, stanza);
 177         elseif hosts[to] and hosts[to].type == "local" then -- directed at a local server
 178                 modules_handle_stanza(host or origin.host or origin.to_host, origin, stanza);
 179         elseif hosts[to_bare] and hosts[to_bare].type == "component" then -- hack to allow components to handle node@server
 180                 component_handle_stanza(origin, stanza);
 181         elseif hosts[host] and hosts[host].type == "component" then -- directed at a component
 182                 component_handle_stanza(origin, stanza);
 183         elseif hosts[host] and hosts[host].type == "local" and stanza.name == "iq" and not resource then -- directed at bare JID
 184                 modules_handle_stanza(host or origin.host or origin.to_host, origin, stanza);
 185         else
 186                 core_route_stanza(origin, stanza);
 187         end
 188 end
 189
 190 function core_route_stanza(origin, stanza)
 191         -- Hooks
 192         --- ...later
 193
 194         -- Deliver
 195         local to = stanza.attr.to;
 196         local node, host, resource = jid_split(to);
 197         local to_bare = node and (node.."@"..host) or host; -- bare JID
 198         local from = stanza.attr.from;
 199         local from_node, from_host, from_resource = jid_split(from);
 200         local from_bare = from_node and (from_node.."@"..from_host) or from_host; -- bare JID
 201
 202         -- Auto-detect origin if not specified
 203         origin = origin or hosts[from_host];
 204         if not origin then return false; end
 205
 206         if hosts[to_bare] and hosts[to_bare].type == "component" then -- hack to allow components to handle node@server
 207                 return component_handle_stanza(origin, stanza);
 208         elseif hosts[host] and hosts[host].type == "component" then -- directed at a component
 209                 return component_handle_stanza(origin, stanza);
 210         end
 211
 212         if stanza.name == "presence" and (stanza.attr.type ~= nil and stanza.attr.type ~= "unavailable" and stanza.attr.type ~= "error") then resource = nil; end
 213
 214         local host_session = hosts[host]
 215         if host_session and host_session.type == "local" then
 216                 -- Local host
 217                 local user = host_session.sessions[node];
 218                 if user then
 219                         local res = user.sessions[resource];
 220                         if res then -- resource is online...
 221                                 res.send(stanza); -- Yay \o/
 222                         else
 223                                 -- if we get here, resource was not specified or was unavailable
 224                                 if stanza.name == "presence" then
 225                                         if stanza.attr.type ~= nil and stanza.attr.type ~= "unavailable" and stanza.attr.type ~= "error" then
 226                                                 handle_inbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare, core_route_stanza);
 227                                         elseif not resource then -- sender is available or unavailable or error
 228                                                 for _, session in pairs(user.sessions) do -- presence broadcast to all user resources.
 229                                                         if session.full_jid then -- FIXME should this be just for available resources? Do we need to check subscription?
 230                                                                 stanza.attr.to = session.full_jid; -- reset at the end of function
 231                                                                 session.send(stanza);
 232                                                         end
 233                                                 end
 234                                         end
 235                                 elseif stanza.name == "message" then -- select a resource to recieve message
 236                                         stanza.attr.to = to_bare;
 237                                         if stanza.attr.type == 'headline' then
 238                                                 for _, session in pairs(user.sessions) do -- find resource with greatest priority
 239                                                         if session.presence and session.priority >= 0 then
 240                                                                 session.send(stanza);
 241                                                         end
 242                                                 end
 243                                         elseif resource and stanza.attr.type == 'groupchat' then
 244                                                 -- Groupchat message sent to offline resource
 245                                                 origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
 246                                         else
 247                                                 local count = 0;
 248                                                 for _, session in ipairs(select_best_resources(user)) do
 249                                                         session.send(stanza);
 250                                                         count = count + 1;
 251                                                 end
 252                                                 if count == 0 and (stanza.attr.type == "chat" or stanza.attr.type == "normal" or not stanza.attr.type) then
 253                                                         offlinemanager.store(node, host, stanza);
 254                                                         -- TODO deal with storage errors
 255                                                 end
 256                                         end
 257                                 elseif stanza.attr.type == "get" or stanza.attr.type == "set" then
 258                                         origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
 259                                 end
 260                         end
 261                 else
 262                         -- user not online
 263                         if user_exists(node, host) then
 264                                 if stanza.name == "presence" then
 265                                         if stanza.attr.type ~= nil and stanza.attr.type ~= "unavailable" and stanza.attr.type ~= "error" then
 266                                                 handle_inbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare, core_route_stanza);
 267                                         else
 268                                                 -- TODO send unavailable presence or unsubscribed
 269                                         end
 270                                 elseif stanza.name == "message" then -- FIXME if full jid, then send out to resources with highest priority
 271                                         stanza.attr.to = to_bare; -- TODO not in RFC, but seems obvious. Should discuss on the mailing list.
 272                                         if stanza.attr.type == "chat" or stanza.attr.type == "normal" or not stanza.attr.type then
 273                                                 offlinemanager.store(node, host, stanza);
 274                                                 -- FIXME don't store messages with only chat state notifications
 275                                         elseif stanza.attr.type == "groupchat" then
 276                                                 local reply = st.error_reply(stanza, "cancel", "service-unavailable");
 277                                                 reply.attr.from = to;
 278                                                 origin.send(reply);
 279                                         end
 280                                         -- TODO allow configuration of offline storage
 281                                         -- TODO send error if not storing offline
 282                                 elseif stanza.name == "iq" and (stanza.attr.type == "get" or stanza.attr.type == "set") then
 283                                         origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
 284                                 end
 285                         else -- user does not exist
 286                                 -- TODO we would get here for nodeless JIDs too. Do something fun maybe? Echo service? Let plugins use xmpp:server/resource addresses?
 287                                 if stanza.name == "presence" then
 288                                         local t = stanza.attr.type;
 289                                         if t == "subscribe" or t == "probe" then
 290                                                 origin.send(st.presence({from = to_bare, to = from_bare, type = "unsubscribed"}));
 291                                         end
 292                                         -- else ignore
 293                                 elseif stanza.attr.type ~= "error" and (stanza.name ~= "iq" or stanza.attr.type ~= "result") then
 294                                         origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
 295                                 end
 296                         end
 297                 end
 298         elseif origin.type == "c2s" then
 299                 -- Remote host
 300                 local xmlns = stanza.attr.xmlns;
 301                 --stanza.attr.xmlns = "jabber:server";
 302                 stanza.attr.xmlns = nil;
 303                 log("debug", "sending s2s stanza: %s", tostring(stanza));
 304                 send_s2s(origin.host, host, stanza); -- TODO handle remote routing errors
 305                 stanza.attr.xmlns = xmlns; -- reset
 306         elseif origin.type == "component" or origin.type == "local" then
 307                 -- Route via s2s for components and modules
 308                 log("debug", "Routing outgoing stanza for %s to %s", origin.host, host);
 309                 send_s2s(origin.host, host, stanza);
 310         else
 311                 log("warn", "received stanza from unhandled connection type: %s", origin.type);
 312         end
 313         stanza.attr.to = to; -- reset
 314 end
 315
 316 function select_best_resources(user)
 317         local priority = 0;
 318         local recipients = {};
 319         for _, session in pairs(user.sessions) do -- find resource with greatest priority
 320                 if session.presence then
 321                         local p = session.priority;
 322                         if p > priority then
 323                                 priority = p;
 324                                 recipients = {session};
 325                         elseif p == priority then
 326                                 t_insert(recipients, session);
 327                         end
 328                 end
 329         end
 330         return recipients;
 331 end