2 -- Copyright (C) 2008-2009 Matthew Wild
3 -- Copyright (C) 2008-2009 Waqas Hussain
5 -- This project is MIT/X11 licensed. Please see the
6 -- COPYING file in the source package for more information.
9 local log = module._log;
11 local require = require;
12 local pairs, ipairs = pairs, ipairs;
13 local t_concat, t_insert = table.concat, table.insert;
14 local s_find = string.find;
15 local tonumber = tonumber;
17 local st = require "util.stanza";
18 local jid_split = require "util.jid".split;
19 local jid_bare = require "util.jid".bare;
23 local rostermanager = require "core.rostermanager";
24 local sessionmanager = require "core.sessionmanager";
25 local offlinemanager = require "core.offlinemanager";
27 local _core_route_stanza = core_route_stanza;
28 local core_route_stanza;
29 function core_route_stanza(origin, stanza)
30 if stanza.attr.type ~= nil and stanza.attr.type ~= "unavailable" and stanza.attr.type ~= "error" then
31 local node, host = jid_split(stanza.attr.to);
33 if node and host and host.type == "local" then
34 handle_inbound_presence_subscriptions_and_probes(origin, stanza, jid_bare(stanza.attr.from), jid_bare(stanza.attr.to), core_route_stanza);
38 _core_route_stanza(origin, stanza);
41 local function select_top_resources(user)
43 local recipients = {};
44 for _, session in pairs(user.sessions) do -- find resource with greatest priority
45 if session.presence then
46 -- TODO check active privacy list for session
47 local p = session.priority;
50 recipients = {session};
51 elseif p == priority then
52 t_insert(recipients, session);
58 local function recalc_resource_map(origin)
59 local user = hosts[origin.host].sessions[origin.username];
60 user.top_resources = select_top_resources(user);
61 if #user.top_resources == 0 then user.top_resources = nil; end
64 function handle_normal_presence(origin, stanza, core_route_stanza)
65 local roster = origin.roster;
66 local node, host = origin.username, origin.host;
67 local user = bare_sessions[node.."@"..host];
68 for _, res in pairs(user and user.sessions or NULL) do -- broadcast to all resources
69 if res ~= origin and res.presence then -- to resource
70 stanza.attr.to = res.full_jid;
71 core_route_stanza(origin, stanza);
74 for jid, item in pairs(roster) do -- broadcast to all interested contacts
75 if item.subscription == "both" or item.subscription == "from" then
77 core_route_stanza(origin, stanza);
80 if stanza.attr.type == nil and not origin.presence then -- initial presence
81 origin.presence = stanza; -- FIXME repeated later
82 local probe = st.presence({from = origin.full_jid, type = "probe"});
83 for jid, item in pairs(roster) do -- probe all contacts we are subscribed to
84 if item.subscription == "both" or item.subscription == "to" then
86 core_route_stanza(origin, probe);
89 for _, res in pairs(user and user.sessions or NULL) do -- broadcast from all available resources
90 if res ~= origin and res.presence then
91 res.presence.attr.to = origin.full_jid;
92 core_route_stanza(res, res.presence);
93 res.presence.attr.to = nil;
96 if roster.pending then -- resend incoming subscription requests
97 for jid in pairs(roster.pending) do
98 origin.send(st.presence({type="subscribe", from=jid})); -- TODO add to attribute? Use original?
101 local request = st.presence({type="subscribe", from=origin.username.."@"..origin.host});
102 for jid, item in pairs(roster) do -- resend outgoing subscription requests
104 request.attr.to = jid;
105 core_route_stanza(origin, request);
108 local offline = offlinemanager.load(node, host);
110 for _, msg in ipairs(offline) do
111 origin.send(msg); -- FIXME do we need to modify to/from in any way?
113 offlinemanager.deleteAll(node, host);
116 if stanza.attr.type == "unavailable" then
117 origin.presence = nil;
118 if origin.priority then
119 origin.priority = nil;
120 recalc_resource_map(origin);
122 if origin.directed then
123 for jid in pairs(origin.directed) do
124 stanza.attr.to = jid;
125 core_route_stanza(origin, stanza);
127 origin.directed = nil;
130 origin.presence = stanza;
131 local priority = stanza:child_with_name("priority");
132 if priority and #priority > 0 then
133 priority = t_concat(priority);
134 if s_find(priority, "^[+-]?[0-9]+$") then
135 priority = tonumber(priority);
136 if priority < -128 then priority = -128 end
137 if priority > 127 then priority = 127 end
138 else priority = 0; end
139 else priority = 0; end
140 if origin.priority ~= priority then
141 origin.priority = priority;
142 recalc_resource_map(origin);
145 stanza.attr.to = nil; -- reset it
148 function send_presence_of_available_resources(user, host, jid, recipient_session, core_route_stanza, stanza)
149 local h = hosts[host];
151 if h and h.type == "local" then
152 local u = h.sessions[user];
154 for k, session in pairs(u.sessions) do
155 local pres = session.presence;
157 if stanza then pres = stanza; pres.attr.from = session.full_jid; end
159 core_route_stanza(session, pres);
166 log("debug", "broadcasted presence of "..count.." resources from "..user.."@"..host.." to "..jid);
170 function handle_outbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare, core_route_stanza)
171 local node, host = jid_split(from_bare);
172 if to_bare == origin.username.."@"..origin.host then return; end -- No self contacts
173 local st_from, st_to = stanza.attr.from, stanza.attr.to;
174 stanza.attr.from, stanza.attr.to = from_bare, to_bare;
175 log("debug", "outbound presence "..stanza.attr.type.." from "..from_bare.." for "..to_bare);
176 if stanza.attr.type == "subscribe" then
178 -- 2. roster push (subscription = none, ask = subscribe)
179 if rostermanager.set_contact_pending_out(node, host, to_bare) then
180 rostermanager.roster_push(node, host, to_bare);
181 end -- else file error
182 core_route_stanza(origin, stanza);
183 elseif stanza.attr.type == "unsubscribe" then
185 -- 2. roster push (subscription = none or from)
186 if rostermanager.unsubscribe(node, host, to_bare) then
187 rostermanager.roster_push(node, host, to_bare); -- FIXME do roster push when roster has in fact not changed?
188 end -- else file error
189 core_route_stanza(origin, stanza);
190 elseif stanza.attr.type == "subscribed" then
193 -- 3. send_presence_of_available_resources
194 if rostermanager.subscribed(node, host, to_bare) then
195 rostermanager.roster_push(node, host, to_bare);
197 core_route_stanza(origin, stanza);
198 send_presence_of_available_resources(node, host, to_bare, origin, core_route_stanza);
199 elseif stanza.attr.type == "unsubscribed" then
201 -- 2. roster push (subscription = none or to)
202 if rostermanager.unsubscribed(node, host, to_bare) then
203 rostermanager.roster_push(node, host, to_bare);
205 core_route_stanza(origin, stanza);
207 stanza.attr.from, stanza.attr.to = st_from, st_to;
210 function handle_inbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare, core_route_stanza)
211 local node, host = jid_split(to_bare);
212 local st_from, st_to = stanza.attr.from, stanza.attr.to;
213 stanza.attr.from, stanza.attr.to = from_bare, to_bare;
214 log("debug", "inbound presence "..stanza.attr.type.." from "..from_bare.." for "..to_bare);
217 log("debug", "dropping presence sent to host or invalid address '%s'", tostring(to_bare));
220 if stanza.attr.type == "probe" then
221 if rostermanager.is_contact_subscribed(node, host, from_bare) then
222 if 0 == send_presence_of_available_resources(node, host, st_from, origin, core_route_stanza) then
223 core_route_stanza(hosts[host], st.presence({from=to_bare, to=from_bare, type="unavailable"})); -- TODO send last activity
226 core_route_stanza(hosts[host], st.presence({from=to_bare, to=from_bare, type="unsubscribed"}));
228 elseif stanza.attr.type == "subscribe" then
229 if rostermanager.is_contact_subscribed(node, host, from_bare) then
230 core_route_stanza(hosts[host], st.presence({from=to_bare, to=from_bare, type="subscribed"})); -- already subscribed
231 -- Sending presence is not clearly stated in the RFC, but it seems appropriate
232 if 0 == send_presence_of_available_resources(node, host, from_bare, origin, core_route_stanza) then
233 core_route_stanza(hosts[host], st.presence({from=to_bare, to=from_bare, type="unavailable"})); -- TODO send last activity
236 core_route_stanza(hosts[host], st.presence({from=to_bare, to=from_bare, type="unavailable"})); -- acknowledging receipt
237 if not rostermanager.is_contact_pending_in(node, host, from_bare) then
238 if rostermanager.set_contact_pending_in(node, host, from_bare) then
239 sessionmanager.send_to_available_resources(node, host, stanza);
240 end -- TODO else return error, unable to save
243 elseif stanza.attr.type == "unsubscribe" then
244 if rostermanager.process_inbound_unsubscribe(node, host, from_bare) then
245 sessionmanager.send_to_interested_resources(node, host, stanza);
246 rostermanager.roster_push(node, host, from_bare);
248 elseif stanza.attr.type == "subscribed" then
249 if rostermanager.process_inbound_subscription_approval(node, host, from_bare) then
250 sessionmanager.send_to_interested_resources(node, host, stanza);
251 rostermanager.roster_push(node, host, from_bare);
253 elseif stanza.attr.type == "unsubscribed" then
254 if rostermanager.process_inbound_subscription_cancellation(node, host, from_bare) then
255 sessionmanager.send_to_interested_resources(node, host, stanza);
256 rostermanager.roster_push(node, host, from_bare);
258 end -- discard any other type
259 stanza.attr.from, stanza.attr.to = st_from, st_to;
262 local outbound_presence_handler = function(data)
263 -- outbound presence recieved
264 local origin, stanza = data.origin, data.stanza;
266 local to = stanza.attr.to;
268 local t = stanza.attr.type;
269 if t ~= nil and t ~= "unavailable" and t ~= "error" then -- check for subscriptions and probes
270 handle_outbound_presence_subscriptions_and_probes(origin, stanza, jid_bare(stanza.attr.from), jid_bare(stanza.attr.to), core_route_stanza);
274 local to_bare = jid_bare(to);
275 if not(origin.roster[to_bare] and (origin.roster[to_bare].subscription == "both" or origin.roster[to_bare].subscription == "from")) then -- directed presence
276 origin.directed = origin.directed or {};
277 if t then -- removing from directed presence list on sending an error or unavailable
278 origin.directed[to] = nil; -- FIXME does it make more sense to add to_bare rather than to?
280 origin.directed[to] = true; -- FIXME does it make more sense to add to_bare rather than to?
283 end -- TODO maybe handle normal presence here, instead of letting it pass to incoming handlers?
286 module:hook("pre-presence/full", outbound_presence_handler);
287 module:hook("pre-presence/bare", outbound_presence_handler);
288 module:hook("pre-presence/host", outbound_presence_handler);
290 module:hook("presence/bare", function(data)
291 -- inbound presence to bare JID recieved
292 local origin, stanza = data.origin, data.stanza;
294 local to = stanza.attr.to;
295 local t = stanza.attr.type;
297 if t ~= nil and t ~= "unavailable" and t ~= "error" then -- check for subscriptions and probes sent to bare JID
298 handle_inbound_presence_subscriptions_and_probes(origin, stanza, jid_bare(stanza.attr.from), jid_bare(stanza.attr.to), core_route_stanza);
302 local user = bare_sessions[to];
304 for _, session in pairs(user.sessions) do
305 if session.presence then -- only send to available resources
306 session.send(stanza);
309 end -- no resources not online, discard
310 elseif not t or t == "unavailable" then
311 handle_normal_presence(origin, stanza, core_route_stanza);
315 module:hook("presence/full", function(data)
316 -- inbound presence to full JID recieved
317 local origin, stanza = data.origin, data.stanza;
319 local t = stanza.attr.type;
320 if t ~= nil and t ~= "unavailable" and t ~= "error" then -- check for subscriptions and probes sent to full JID
321 handle_inbound_presence_subscriptions_and_probes(origin, stanza, jid_bare(stanza.attr.from), jid_bare(stanza.attr.to), core_route_stanza);
325 local session = full_sessions[stanza.attr.to];
327 -- TODO fire post processing event
328 session.send(stanza);
329 end -- resource not online, discard
332 module:hook("presence/host", function(data)
333 -- inbound presence to the host
334 local origin, stanza = data.origin, data.stanza;
336 local from_bare = jid_bare(stanza.attr.from);
337 local t = stanza.attr.type;
339 core_route_stanza(hosts[module.host], st.presence({ from = module.host, to = from_bare, id = stanza.attr.id }));
340 elseif t == "subscribe" then
341 core_route_stanza(hosts[module.host], st.presence({ from = module.host, to = from_bare, id = stanza.attr.id, type = "subscribed" }));
342 core_route_stanza(hosts[module.host], st.presence({ from = module.host, to = from_bare, id = stanza.attr.id }));
347 module:hook("resource-unbind", function(event)
348 local session, err = event.session, event.error;
349 -- Send unavailable presence
350 if session.presence then
351 local pres = st.presence{ type = "unavailable" };
352 if not(err) or err == "closed" then err = "connection closed"; end
353 pres:tag("status"):text("Disconnected: "..err):up();
354 session:dispatch_stanza(pres);
355 elseif session.directed then
356 local pres = st.presence{ type = "unavailable", from = session.full_jid };
357 if not(err) or err == "closed" then err = "connection closed"; end
358 pres:tag("status"):text("Disconnected: "..err):up();
359 for jid in pairs(session.directed) do
361 core_route_stanza(session, pres);
363 session.directed = nil;