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;
22 local rostermanager = require "core.rostermanager";
23 local sessionmanager = require "core.sessionmanager";
24 local offlinemanager = require "core.offlinemanager";
26 local _core_route_stanza = core_route_stanza;
27 local core_route_stanza;
28 function core_route_stanza(origin, stanza)
29 if stanza.attr.type ~= nil and stanza.attr.type ~= "unavailable" and stanza.attr.type ~= "error" then
30 local node, host = jid_split(stanza.attr.to);
32 if host and host.type == "local" then
33 handle_inbound_presence_subscriptions_and_probes(origin, stanza, jid_bare(stanza.attr.from), jid_bare(stanza.attr.to), core_route_stanza);
37 _core_route_stanza(origin, stanza);
40 local function select_top_resources(user)
42 local recipients = {};
43 for _, session in pairs(user.sessions) do -- find resource with greatest priority
44 if session.presence then
45 -- TODO check active privacy list for session
46 local p = session.priority;
49 recipients = {session};
50 elseif p == priority then
51 t_insert(recipients, session);
57 local function recalc_resource_map(origin)
58 local user = hosts[origin.host].sessions[origin.username];
59 user.top_resources = select_top_resources(user);
60 if #user.top_resources == 0 then user.top_resources = nil; end
63 function handle_normal_presence(origin, stanza, core_route_stanza)
64 local roster = origin.roster;
65 local node, host = origin.username, origin.host;
66 for _, res in pairs(hosts[host].sessions[node].sessions) do -- broadcast to all resources
67 if res ~= origin and res.presence then -- to resource
68 stanza.attr.to = res.full_jid;
69 core_route_stanza(origin, stanza);
72 for jid, item in pairs(roster) do -- broadcast to all interested contacts
73 if item.subscription == "both" or item.subscription == "from" then
75 core_route_stanza(origin, stanza);
78 if stanza.attr.type == nil and not origin.presence then -- initial presence
79 local probe = st.presence({from = origin.full_jid, type = "probe"});
80 for jid, item in pairs(roster) do -- probe all contacts we are subscribed to
81 if item.subscription == "both" or item.subscription == "to" then
83 core_route_stanza(origin, probe);
86 for _, res in pairs(hosts[host].sessions[node].sessions) do -- broadcast from all available resources
87 if res ~= origin and res.presence then
88 res.presence.attr.to = origin.full_jid;
89 core_route_stanza(res, res.presence);
90 res.presence.attr.to = nil;
93 if roster.pending then -- resend incoming subscription requests
94 for jid in pairs(roster.pending) do
95 origin.send(st.presence({type="subscribe", from=jid})); -- TODO add to attribute? Use original?
98 local request = st.presence({type="subscribe", from=origin.username.."@"..origin.host});
99 for jid, item in pairs(roster) do -- resend outgoing subscription requests
101 request.attr.to = jid;
102 core_route_stanza(origin, request);
105 local offline = offlinemanager.load(node, host);
107 for _, msg in ipairs(offline) do
108 origin.send(msg); -- FIXME do we need to modify to/from in any way?
110 offlinemanager.deleteAll(node, host);
113 if stanza.attr.type == "unavailable" then
114 origin.presence = nil;
115 if origin.priority then
116 origin.priority = nil;
117 recalc_resource_map(origin);
119 if origin.directed then
120 for jid in pairs(origin.directed) do
121 stanza.attr.to = jid;
122 core_route_stanza(origin, stanza);
124 origin.directed = nil;
127 origin.presence = stanza;
128 local priority = stanza:child_with_name("priority");
129 if priority and #priority > 0 then
130 priority = t_concat(priority);
131 if s_find(priority, "^[+-]?[0-9]+$") then
132 priority = tonumber(priority);
133 if priority < -128 then priority = -128 end
134 if priority > 127 then priority = 127 end
135 else priority = 0; end
136 else priority = 0; end
137 if origin.priority ~= priority then
138 origin.priority = priority;
139 recalc_resource_map(origin);
142 stanza.attr.to = nil; -- reset it
145 function send_presence_of_available_resources(user, host, jid, recipient_session, core_route_stanza)
146 local h = hosts[host];
148 if h and h.type == "local" then
149 local u = h.sessions[user];
151 for k, session in pairs(u.sessions) do
152 local pres = session.presence;
155 core_route_stanza(session, pres);
162 log("debug", "broadcasted presence of "..count.." resources from "..user.."@"..host.." to "..jid);
166 function handle_outbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare, core_route_stanza)
167 local node, host = jid_split(from_bare);
168 local st_from, st_to = stanza.attr.from, stanza.attr.to;
169 stanza.attr.from, stanza.attr.to = from_bare, to_bare;
170 log("debug", "outbound presence "..stanza.attr.type.." from "..from_bare.." for "..to_bare);
171 if stanza.attr.type == "subscribe" then
173 -- 2. roster push (subscription = none, ask = subscribe)
174 if rostermanager.set_contact_pending_out(node, host, to_bare) then
175 rostermanager.roster_push(node, host, to_bare);
176 end -- else file error
177 core_route_stanza(origin, stanza);
178 elseif stanza.attr.type == "unsubscribe" then
180 -- 2. roster push (subscription = none or from)
181 if rostermanager.unsubscribe(node, host, to_bare) then
182 rostermanager.roster_push(node, host, to_bare); -- FIXME do roster push when roster has in fact not changed?
183 end -- else file error
184 core_route_stanza(origin, stanza);
185 elseif stanza.attr.type == "subscribed" then
188 -- 3. send_presence_of_available_resources
189 if rostermanager.subscribed(node, host, to_bare) then
190 rostermanager.roster_push(node, host, to_bare);
192 core_route_stanza(origin, stanza);
193 send_presence_of_available_resources(node, host, to_bare, origin, core_route_stanza);
194 elseif stanza.attr.type == "unsubscribed" then
196 -- 2. roster push (subscription = none or to)
197 if rostermanager.unsubscribed(node, host, to_bare) then
198 rostermanager.roster_push(node, host, to_bare);
200 core_route_stanza(origin, stanza);
202 stanza.attr.from, stanza.attr.to = st_from, st_to;
205 function handle_inbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare, core_route_stanza)
206 local node, host = jid_split(to_bare);
207 local st_from, st_to = stanza.attr.from, stanza.attr.to;
208 stanza.attr.from, stanza.attr.to = from_bare, to_bare;
209 log("debug", "inbound presence "..stanza.attr.type.." from "..from_bare.." for "..to_bare);
210 if stanza.attr.type == "probe" then
211 if rostermanager.is_contact_subscribed(node, host, from_bare) then
212 if 0 == send_presence_of_available_resources(node, host, st_from, origin, core_route_stanza) then
213 -- TODO send last recieved unavailable presence (or we MAY do nothing, which is fine too)
216 core_route_stanza(origin, st.presence({from=to_bare, to=from_bare, type="unsubscribed"}));
218 elseif stanza.attr.type == "subscribe" then
219 if rostermanager.is_contact_subscribed(node, host, from_bare) then
220 core_route_stanza(origin, st.presence({from=to_bare, to=from_bare, type="subscribed"})); -- already subscribed
221 -- Sending presence is not clearly stated in the RFC, but it seems appropriate
222 if 0 == send_presence_of_available_resources(node, host, from_bare, origin, core_route_stanza) then
223 -- TODO send last recieved unavailable presence (or we MAY do nothing, which is fine too)
226 if not rostermanager.is_contact_pending_in(node, host, from_bare) then
227 if rostermanager.set_contact_pending_in(node, host, from_bare) then
228 sessionmanager.send_to_available_resources(node, host, stanza);
229 end -- TODO else return error, unable to save
232 elseif stanza.attr.type == "unsubscribe" then
233 if rostermanager.process_inbound_unsubscribe(node, host, from_bare) then
234 rostermanager.roster_push(node, host, from_bare);
236 elseif stanza.attr.type == "subscribed" then
237 if rostermanager.process_inbound_subscription_approval(node, host, from_bare) then
238 rostermanager.roster_push(node, host, from_bare);
240 elseif stanza.attr.type == "unsubscribed" then
241 if rostermanager.process_inbound_subscription_cancellation(node, host, from_bare) then
242 rostermanager.roster_push(node, host, from_bare);
244 end -- discard any other type
245 stanza.attr.from, stanza.attr.to = st_from, st_to;
248 local outbound_presence_handler = function(data)
249 -- outbound presence recieved
250 local origin, stanza = data.origin, data.stanza;
252 local to = stanza.attr.to;
254 local t = stanza.attr.type;
255 if t ~= nil and t ~= "unavailable" and t ~= "error" then -- check for subscriptions and probes
256 handle_outbound_presence_subscriptions_and_probes(origin, stanza, jid_bare(stanza.attr.from), jid_bare(stanza.attr.to), core_route_stanza);
260 local to_bare = jid_bare(to);
261 if not(origin.roster[to_bare] and (origin.roster[to_bare].subscription == "both" or origin.roster[to_bare].subscription == "from")) then -- directed presence
262 origin.directed = origin.directed or {};
263 if t then -- removing from directed presence list on sending an error or unavailable
264 origin.directed[to] = nil; -- FIXME does it make more sense to add to_bare rather than to?
266 origin.directed[to] = true; -- FIXME does it make more sense to add to_bare rather than to?
269 end -- TODO maybe handle normal presence here, instead of letting it pass to incoming handlers?
272 module:hook("pre-presence/full", outbound_presence_handler);
273 module:hook("pre-presence/bare", outbound_presence_handler);
274 module:hook("pre-presence/host", outbound_presence_handler);
276 module:hook("presence/bare", function(data)
277 -- inbound presence to bare JID recieved
278 local origin, stanza = data.origin, data.stanza;
280 local to = stanza.attr.to;
281 local t = stanza.attr.type;
283 if t ~= nil and t ~= "unavailable" and t ~= "error" then -- check for subscriptions and probes sent to bare JID
284 handle_inbound_presence_subscriptions_and_probes(origin, stanza, jid_bare(stanza.attr.from), jid_bare(stanza.attr.to), core_route_stanza);
288 local user = bare_sessions[to];
290 for _, session in pairs(user.sessions) do
291 if session.presence then -- only send to available resources
292 session.send(stanza);
295 end -- no resources not online, discard
296 elseif not t or t == "unavailable" then
297 handle_normal_presence(origin, stanza, core_route_stanza);
301 module:hook("presence/full", function(data)
302 -- inbound presence to full JID recieved
303 local origin, stanza = data.origin, data.stanza;
305 local t = stanza.attr.type;
306 if t ~= nil and t ~= "unavailable" and t ~= "error" then -- check for subscriptions and probes sent to full JID
307 handle_inbound_presence_subscriptions_and_probes(origin, stanza, jid_bare(stanza.attr.from), jid_bare(stanza.attr.to), core_route_stanza);
311 local session = full_sessions[stanza.attr.to];
313 -- TODO fire post processing event
314 session.send(stanza);
315 end -- resource not online, discard
319 module:hook("resource-unbind", function(event)
320 local session, err = event.session, event.error;
321 -- Send unavailable presence
322 if session.presence then
323 local pres = st.presence{ type = "unavailable" };
324 if not(err) or err == "closed" then err = "connection closed"; end
325 pres:tag("status"):text("Disconnected: "..err):up();
326 session:dispatch_stanza(pres);
327 elseif session.directed then
328 local pres = st.presence{ type = "unavailable" };
329 if not(err) or err == "closed" then err = "connection closed"; end
330 pres:tag("status"):text("Disconnected: "..err):up();
331 for jid in pairs(session.directed) do
333 core_route_stanza(session, pres);
335 session.directed = nil;