2 -- Copyright (C) 2008-2010 Matthew Wild
3 -- Copyright (C) 2008-2010 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(user)
60 user.top_resources = select_top_resources(user);
61 if #user.top_resources == 0 then user.top_resources = nil; end
65 local ignore_presence_priority = module:get_option("ignore_presence_priority");
67 function handle_normal_presence(origin, stanza, core_route_stanza)
68 if ignore_presence_priority then
69 local priority = stanza:child_with_name("priority");
70 if priority and priority[1] ~= "0" then
71 for i=#priority.tags,1,-1 do priority.tags[i] = nil; end
72 for i=#priority,1,-1 do priority[i] = nil; end
76 if full_sessions[origin.full_jid] then -- if user is still connected
77 origin.send(stanza); -- reflect their presence back to them
79 local roster = origin.roster;
80 local node, host = origin.username, origin.host;
81 local user = bare_sessions[node.."@"..host];
82 for _, res in pairs(user and user.sessions or NULL) do -- broadcast to all resources
83 if res ~= origin and res.presence then -- to resource
84 stanza.attr.to = res.full_jid;
85 core_route_stanza(origin, stanza);
88 for jid, item in pairs(roster) do -- broadcast to all interested contacts
89 if item.subscription == "both" or item.subscription == "from" then
91 core_route_stanza(origin, stanza);
94 if stanza.attr.type == nil and not origin.presence then -- initial presence
95 origin.presence = stanza; -- FIXME repeated later
96 local probe = st.presence({from = origin.full_jid, type = "probe"});
97 for jid, item in pairs(roster) do -- probe all contacts we are subscribed to
98 if item.subscription == "both" or item.subscription == "to" then
100 core_route_stanza(origin, probe);
103 for _, res in pairs(user and user.sessions or NULL) do -- broadcast from all available resources
104 if res ~= origin and res.presence then
105 res.presence.attr.to = origin.full_jid;
106 core_route_stanza(res, res.presence);
107 res.presence.attr.to = nil;
110 if roster.pending then -- resend incoming subscription requests
111 for jid in pairs(roster.pending) do
112 origin.send(st.presence({type="subscribe", from=jid})); -- TODO add to attribute? Use original?
115 local request = st.presence({type="subscribe", from=origin.username.."@"..origin.host});
116 for jid, item in pairs(roster) do -- resend outgoing subscription requests
118 request.attr.to = jid;
119 core_route_stanza(origin, request);
122 local offline = offlinemanager.load(node, host);
124 for _, msg in ipairs(offline) do
125 origin.send(msg); -- FIXME do we need to modify to/from in any way?
127 offlinemanager.deleteAll(node, host);
130 if stanza.attr.type == "unavailable" then
131 origin.presence = nil;
132 if origin.priority then
133 origin.priority = nil;
134 recalc_resource_map(user);
136 if origin.directed then
137 for jid in pairs(origin.directed) do
138 stanza.attr.to = jid;
139 core_route_stanza(origin, stanza);
141 origin.directed = nil;
144 origin.presence = stanza;
145 local priority = stanza:child_with_name("priority");
146 if priority and #priority > 0 then
147 priority = t_concat(priority);
148 if s_find(priority, "^[+-]?[0-9]+$") then
149 priority = tonumber(priority);
150 if priority < -128 then priority = -128 end
151 if priority > 127 then priority = 127 end
152 else priority = 0; end
153 else priority = 0; end
154 if origin.priority ~= priority then
155 origin.priority = priority;
156 recalc_resource_map(user);
159 stanza.attr.to = nil; -- reset it
162 function send_presence_of_available_resources(user, host, jid, recipient_session, core_route_stanza, stanza)
163 local h = hosts[host];
165 if h and h.type == "local" then
166 local u = h.sessions[user];
168 for k, session in pairs(u.sessions) do
169 local pres = session.presence;
171 if stanza then pres = stanza; pres.attr.from = session.full_jid; end
173 core_route_stanza(session, pres);
180 log("debug", "broadcasted presence of "..count.." resources from "..user.."@"..host.." to "..jid);
184 function handle_outbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare, core_route_stanza)
185 local node, host = jid_split(from_bare);
186 if to_bare == origin.username.."@"..origin.host then return; end -- No self contacts
187 local st_from, st_to = stanza.attr.from, stanza.attr.to;
188 stanza.attr.from, stanza.attr.to = from_bare, to_bare;
189 log("debug", "outbound presence "..stanza.attr.type.." from "..from_bare.." for "..to_bare);
190 if stanza.attr.type == "subscribe" then
192 -- 2. roster push (subscription = none, ask = subscribe)
193 if rostermanager.set_contact_pending_out(node, host, to_bare) then
194 rostermanager.roster_push(node, host, to_bare);
195 end -- else file error
196 core_route_stanza(origin, stanza);
197 elseif stanza.attr.type == "unsubscribe" then
199 -- 2. roster push (subscription = none or from)
200 if rostermanager.unsubscribe(node, host, to_bare) then
201 rostermanager.roster_push(node, host, to_bare); -- FIXME do roster push when roster has in fact not changed?
202 end -- else file error
203 core_route_stanza(origin, stanza);
204 elseif stanza.attr.type == "subscribed" then
207 -- 3. send_presence_of_available_resources
208 if rostermanager.subscribed(node, host, to_bare) then
209 rostermanager.roster_push(node, host, to_bare);
211 core_route_stanza(origin, stanza);
212 send_presence_of_available_resources(node, host, to_bare, origin, core_route_stanza);
213 elseif stanza.attr.type == "unsubscribed" then
215 -- 2. roster push (subscription = none or to)
216 if rostermanager.unsubscribed(node, host, to_bare) then
217 rostermanager.roster_push(node, host, to_bare);
219 core_route_stanza(origin, stanza);
221 stanza.attr.from, stanza.attr.to = st_from, st_to;
224 function handle_inbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare, core_route_stanza)
225 local node, host = jid_split(to_bare);
226 local st_from, st_to = stanza.attr.from, stanza.attr.to;
227 stanza.attr.from, stanza.attr.to = from_bare, to_bare;
228 log("debug", "inbound presence "..stanza.attr.type.." from "..from_bare.." for "..to_bare);
231 log("debug", "dropping presence sent to host or invalid address '%s'", tostring(to_bare));
234 if stanza.attr.type == "probe" then
235 if rostermanager.is_contact_subscribed(node, host, from_bare) then
236 if 0 == send_presence_of_available_resources(node, host, st_from, origin, core_route_stanza) then
237 core_route_stanza(hosts[host], st.presence({from=to_bare, to=from_bare, type="unavailable"})); -- TODO send last activity
240 core_route_stanza(hosts[host], st.presence({from=to_bare, to=from_bare, type="unsubscribed"}));
242 elseif stanza.attr.type == "subscribe" then
243 if rostermanager.is_contact_subscribed(node, host, from_bare) then
244 core_route_stanza(hosts[host], st.presence({from=to_bare, to=from_bare, type="subscribed"})); -- already subscribed
245 -- Sending presence is not clearly stated in the RFC, but it seems appropriate
246 if 0 == send_presence_of_available_resources(node, host, from_bare, origin, core_route_stanza) then
247 core_route_stanza(hosts[host], st.presence({from=to_bare, to=from_bare, type="unavailable"})); -- TODO send last activity
250 core_route_stanza(hosts[host], st.presence({from=to_bare, to=from_bare, type="unavailable"})); -- acknowledging receipt
251 if not rostermanager.is_contact_pending_in(node, host, from_bare) then
252 if rostermanager.set_contact_pending_in(node, host, from_bare) then
253 sessionmanager.send_to_available_resources(node, host, stanza);
254 end -- TODO else return error, unable to save
257 elseif stanza.attr.type == "unsubscribe" then
258 if rostermanager.process_inbound_unsubscribe(node, host, from_bare) then
259 sessionmanager.send_to_interested_resources(node, host, stanza);
260 rostermanager.roster_push(node, host, from_bare);
262 elseif stanza.attr.type == "subscribed" then
263 if rostermanager.process_inbound_subscription_approval(node, host, from_bare) then
264 sessionmanager.send_to_interested_resources(node, host, stanza);
265 rostermanager.roster_push(node, host, from_bare);
267 elseif stanza.attr.type == "unsubscribed" then
268 if rostermanager.process_inbound_subscription_cancellation(node, host, from_bare) then
269 sessionmanager.send_to_interested_resources(node, host, stanza);
270 rostermanager.roster_push(node, host, from_bare);
272 end -- discard any other type
273 stanza.attr.from, stanza.attr.to = st_from, st_to;
276 local outbound_presence_handler = function(data)
277 -- outbound presence recieved
278 local origin, stanza = data.origin, data.stanza;
280 local to = stanza.attr.to;
282 local t = stanza.attr.type;
283 if t ~= nil and t ~= "unavailable" and t ~= "error" then -- check for subscriptions and probes
284 handle_outbound_presence_subscriptions_and_probes(origin, stanza, jid_bare(stanza.attr.from), jid_bare(stanza.attr.to), core_route_stanza);
288 local to_bare = jid_bare(to);
289 if not(origin.roster[to_bare] and (origin.roster[to_bare].subscription == "both" or origin.roster[to_bare].subscription == "from")) then -- directed presence
290 origin.directed = origin.directed or {};
291 if t then -- removing from directed presence list on sending an error or unavailable
292 origin.directed[to] = nil; -- FIXME does it make more sense to add to_bare rather than to?
294 origin.directed[to] = true; -- FIXME does it make more sense to add to_bare rather than to?
297 end -- TODO maybe handle normal presence here, instead of letting it pass to incoming handlers?
300 module:hook("pre-presence/full", outbound_presence_handler);
301 module:hook("pre-presence/bare", outbound_presence_handler);
302 module:hook("pre-presence/host", outbound_presence_handler);
304 module:hook("presence/bare", function(data)
305 -- inbound presence to bare JID recieved
306 local origin, stanza = data.origin, data.stanza;
308 local to = stanza.attr.to;
309 local t = stanza.attr.type;
311 if t ~= nil and t ~= "unavailable" and t ~= "error" then -- check for subscriptions and probes sent to bare JID
312 handle_inbound_presence_subscriptions_and_probes(origin, stanza, jid_bare(stanza.attr.from), jid_bare(stanza.attr.to), core_route_stanza);
316 local user = bare_sessions[to];
318 for _, session in pairs(user.sessions) do
319 if session.presence then -- only send to available resources
320 session.send(stanza);
323 end -- no resources not online, discard
324 elseif not t or t == "unavailable" then
325 handle_normal_presence(origin, stanza, core_route_stanza);
329 module:hook("presence/full", function(data)
330 -- inbound presence to full JID recieved
331 local origin, stanza = data.origin, data.stanza;
333 local t = stanza.attr.type;
334 if t ~= nil and t ~= "unavailable" and t ~= "error" then -- check for subscriptions and probes sent to full JID
335 handle_inbound_presence_subscriptions_and_probes(origin, stanza, jid_bare(stanza.attr.from), jid_bare(stanza.attr.to), core_route_stanza);
339 local session = full_sessions[stanza.attr.to];
341 -- TODO fire post processing event
342 session.send(stanza);
343 end -- resource not online, discard
346 module:hook("presence/host", function(data)
347 -- inbound presence to the host
348 local origin, stanza = data.origin, data.stanza;
350 local from_bare = jid_bare(stanza.attr.from);
351 local t = stanza.attr.type;
353 core_route_stanza(hosts[module.host], st.presence({ from = module.host, to = from_bare, id = stanza.attr.id }));
354 elseif t == "subscribe" then
355 core_route_stanza(hosts[module.host], st.presence({ from = module.host, to = from_bare, id = stanza.attr.id, type = "subscribed" }));
356 core_route_stanza(hosts[module.host], st.presence({ from = module.host, to = from_bare, id = stanza.attr.id }));
361 module:hook("resource-unbind", function(event)
362 local session, err = event.session, event.error;
363 -- Send unavailable presence
364 if session.presence then
365 local pres = st.presence{ type = "unavailable" };
366 if not(err) or err == "closed" then err = "connection closed"; end
367 pres:tag("status"):text("Disconnected: "..err):up();
368 session:dispatch_stanza(pres);
369 elseif session.directed then
370 local pres = st.presence{ type = "unavailable", from = session.full_jid };
371 if not(err) or err == "closed" then err = "connection closed"; end
372 pres:tag("status"):text("Disconnected: "..err):up();
373 for jid in pairs(session.directed) do
375 core_route_stanza(session, pres);
377 session.directed = nil;