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;
13 local t_concat, t_insert = table.concat, table.insert;
14 local s_find = string.find;
15 local tonumber = tonumber;
17 local core_post_stanza = prosody.core_post_stanza;
18 local st = require "util.stanza";
19 local jid_split = require "util.jid".split;
20 local jid_bare = require "util.jid".bare;
21 local datetime = require "util.datetime";
22 local hosts = prosody.hosts;
23 local bare_sessions = prosody.bare_sessions;
24 local full_sessions = prosody.full_sessions;
27 local rostermanager = require "core.rostermanager";
28 local sessionmanager = require "core.sessionmanager";
30 local function select_top_resources(user)
32 local recipients = {};
33 for _, session in pairs(user.sessions) do -- find resource with greatest priority
34 if session.presence then
35 -- TODO check active privacy list for session
36 local p = session.priority;
39 recipients = {session};
40 elseif p == priority then
41 t_insert(recipients, session);
47 local function recalc_resource_map(user)
49 user.top_resources = select_top_resources(user);
50 if #user.top_resources == 0 then user.top_resources = nil; end
54 local ignore_presence_priority = module:get_option("ignore_presence_priority");
56 function handle_normal_presence(origin, stanza)
57 if ignore_presence_priority then
58 local priority = stanza:child_with_name("priority");
59 if priority and priority[1] ~= "0" then
60 for i=#priority.tags,1,-1 do priority.tags[i] = nil; end
61 for i=#priority,1,-1 do priority[i] = nil; end
65 local priority = stanza:child_with_name("priority");
66 if priority and #priority > 0 then
67 priority = t_concat(priority);
68 if s_find(priority, "^[+-]?[0-9]+$") then
69 priority = tonumber(priority);
70 if priority < -128 then priority = -128 end
71 if priority > 127 then priority = 127 end
72 else priority = 0; end
73 else priority = 0; end
74 if full_sessions[origin.full_jid] then -- if user is still connected
75 origin.send(stanza); -- reflect their presence back to them
77 local roster = origin.roster;
78 local node, host = origin.username, origin.host;
79 local user = bare_sessions[node.."@"..host];
80 for _, res in pairs(user and user.sessions or NULL) do -- broadcast to all resources
81 if res ~= origin and res.presence then -- to resource
82 stanza.attr.to = res.full_jid;
83 core_post_stanza(origin, stanza, true);
86 for jid, item in pairs(roster) do -- broadcast to all interested contacts
87 if item.subscription == "both" or item.subscription == "from" then
89 core_post_stanza(origin, stanza, true);
92 if stanza.attr.type == nil and not origin.presence then -- initial presence
93 origin.presence = stanza; -- FIXME repeated later
94 local probe = st.presence({from = origin.full_jid, type = "probe"});
95 for jid, item in pairs(roster) do -- probe all contacts we are subscribed to
96 if item.subscription == "both" or item.subscription == "to" then
98 core_post_stanza(origin, probe, true);
101 for _, res in pairs(user and user.sessions or NULL) do -- broadcast from all available resources
102 if res ~= origin and res.presence then
103 res.presence.attr.to = origin.full_jid;
104 core_post_stanza(res, res.presence, true);
105 res.presence.attr.to = nil;
108 if roster.pending then -- resend incoming subscription requests
109 for jid in pairs(roster.pending) do
110 origin.send(st.presence({type="subscribe", from=jid})); -- TODO add to attribute? Use original?
113 local request = st.presence({type="subscribe", from=origin.username.."@"..origin.host});
114 for jid, item in pairs(roster) do -- resend outgoing subscription requests
116 request.attr.to = jid;
117 core_post_stanza(origin, request, true);
121 if priority >= 0 then
122 local event = { origin = origin }
123 module:fire_event('message/offline/broadcast', event);
126 if stanza.attr.type == "unavailable" then
127 origin.presence = nil;
128 if origin.priority then
129 origin.priority = nil;
130 recalc_resource_map(user);
132 if origin.directed then
133 for jid in pairs(origin.directed) do
134 stanza.attr.to = jid;
135 core_post_stanza(origin, stanza, true);
137 origin.directed = nil;
140 origin.presence = stanza;
141 stanza:tag("delay", { xmlns = "urn:xmpp:delay", from = host, stamp = datetime.datetime() }):up();
142 if origin.priority ~= priority then
143 origin.priority = priority;
144 recalc_resource_map(user);
147 stanza.attr.to = nil; -- reset it
150 function send_presence_of_available_resources(user, host, jid, recipient_session, stanza)
151 local h = hosts[host];
153 if h and h.type == "local" then
154 local u = h.sessions[user];
156 for k, session in pairs(u.sessions) do
157 local pres = session.presence;
159 if stanza then pres = stanza; pres.attr.from = session.full_jid; end
161 core_post_stanza(session, pres, true);
168 log("debug", "broadcasted presence of %d resources from %s@%s to %s", count, user, host, jid);
172 function handle_outbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare)
173 local node, host = jid_split(from_bare);
174 if to_bare == from_bare then return; end -- No self contacts
175 local st_from, st_to = stanza.attr.from, stanza.attr.to;
176 stanza.attr.from, stanza.attr.to = from_bare, to_bare;
177 log("debug", "outbound presence %s from %s for %s", stanza.attr.type, from_bare, to_bare);
178 if stanza.attr.type == "probe" then
179 stanza.attr.from, stanza.attr.to = st_from, st_to;
181 elseif stanza.attr.type == "subscribe" then
183 -- 2. roster push (subscription = none, ask = subscribe)
184 if rostermanager.set_contact_pending_out(node, host, to_bare) then
185 rostermanager.roster_push(node, host, to_bare);
186 end -- else file error
187 core_post_stanza(origin, stanza);
188 elseif stanza.attr.type == "unsubscribe" then
190 -- 2. roster push (subscription = none or from)
191 if rostermanager.unsubscribe(node, host, to_bare) then
192 rostermanager.roster_push(node, host, to_bare); -- FIXME do roster push when roster has in fact not changed?
193 end -- else file error
194 core_post_stanza(origin, stanza);
195 elseif stanza.attr.type == "subscribed" then
198 -- 3. send_presence_of_available_resources
199 if rostermanager.subscribed(node, host, to_bare) then
200 rostermanager.roster_push(node, host, to_bare);
202 core_post_stanza(origin, stanza);
203 send_presence_of_available_resources(node, host, to_bare, origin);
204 elseif stanza.attr.type == "unsubscribed" then
205 -- 1. send unavailable
207 -- 3. roster push (subscription = from or both)
208 local success, pending_in, subscribed = rostermanager.unsubscribed(node, host, to_bare);
211 rostermanager.roster_push(node, host, to_bare);
213 core_post_stanza(origin, stanza);
215 send_presence_of_available_resources(node, host, to_bare, origin, st.presence({ type = "unavailable" }));
219 origin.send(st.error_reply(stanza, "modify", "bad-request", "Invalid presence type"));
221 stanza.attr.from, stanza.attr.to = st_from, st_to;
225 function handle_inbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare)
226 local node, host = jid_split(to_bare);
227 local st_from, st_to = stanza.attr.from, stanza.attr.to;
228 stanza.attr.from, stanza.attr.to = from_bare, to_bare;
229 log("debug", "inbound presence %s from %s for %s", stanza.attr.type, from_bare, to_bare);
231 if stanza.attr.type == "probe" then
232 local result, err = rostermanager.is_contact_subscribed(node, host, from_bare);
234 if 0 == send_presence_of_available_resources(node, host, st_from, origin) then
235 core_post_stanza(hosts[host], st.presence({from=to_bare, to=st_from, type="unavailable"}), true); -- TODO send last activity
238 core_post_stanza(hosts[host], st.presence({from=to_bare, to=from_bare, type="unsubscribed"}), true);
240 elseif stanza.attr.type == "subscribe" then
241 if rostermanager.is_contact_subscribed(node, host, from_bare) then
242 core_post_stanza(hosts[host], st.presence({from=to_bare, to=from_bare, type="subscribed"}), true); -- already subscribed
243 -- Sending presence is not clearly stated in the RFC, but it seems appropriate
244 if 0 == send_presence_of_available_resources(node, host, from_bare, origin) then
245 core_post_stanza(hosts[host], st.presence({from=to_bare, to=from_bare, type="unavailable"}), true); -- TODO send last activity
248 core_post_stanza(hosts[host], st.presence({from=to_bare, to=from_bare, type="unavailable"}), true); -- acknowledging receipt
249 if not rostermanager.is_contact_pending_in(node, host, from_bare) then
250 if rostermanager.set_contact_pending_in(node, host, from_bare) then
251 sessionmanager.send_to_available_resources(node, host, stanza);
252 end -- TODO else return error, unable to save
255 elseif stanza.attr.type == "unsubscribe" then
256 if rostermanager.process_inbound_unsubscribe(node, host, from_bare) then
257 sessionmanager.send_to_interested_resources(node, host, stanza);
258 rostermanager.roster_push(node, host, from_bare);
260 elseif stanza.attr.type == "subscribed" then
261 if rostermanager.process_inbound_subscription_approval(node, host, from_bare) then
262 sessionmanager.send_to_interested_resources(node, host, stanza);
263 rostermanager.roster_push(node, host, from_bare);
265 elseif stanza.attr.type == "unsubscribed" then
266 if rostermanager.process_inbound_subscription_cancellation(node, host, from_bare) then
267 sessionmanager.send_to_interested_resources(node, host, stanza);
268 rostermanager.roster_push(node, host, from_bare);
271 origin.send(st.error_reply(stanza, "modify", "bad-request", "Invalid presence type"));
273 stanza.attr.from, stanza.attr.to = st_from, st_to;
277 local outbound_presence_handler = function(data)
278 -- outbound presence recieved
279 local origin, stanza = data.origin, data.stanza;
281 local to = stanza.attr.to;
283 local t = stanza.attr.type;
284 if t ~= nil and t ~= "unavailable" and t ~= "error" then -- check for subscriptions and probes
285 return handle_outbound_presence_subscriptions_and_probes(origin, stanza, jid_bare(stanza.attr.from), jid_bare(stanza.attr.to));
288 local to_bare = jid_bare(to);
289 local roster = origin.roster;
290 if roster and not(roster[to_bare] and (roster[to_bare].subscription == "both" or roster[to_bare].subscription == "from")) then -- directed presence
291 origin.directed = origin.directed or {};
292 if t then -- removing from directed presence list on sending an error or unavailable
293 origin.directed[to] = nil; -- FIXME does it make more sense to add to_bare rather than to?
295 origin.directed[to] = true; -- FIXME does it make more sense to add to_bare rather than to?
298 end -- TODO maybe handle normal presence here, instead of letting it pass to incoming handlers?
301 module:hook("pre-presence/full", outbound_presence_handler);
302 module:hook("pre-presence/bare", outbound_presence_handler);
303 module:hook("pre-presence/host", outbound_presence_handler);
305 module:hook("presence/bare", function(data)
306 -- inbound presence to bare JID recieved
307 local origin, stanza = data.origin, data.stanza;
309 local to = stanza.attr.to;
310 local t = stanza.attr.type;
312 if t ~= nil and t ~= "unavailable" and t ~= "error" then -- check for subscriptions and probes sent to bare JID
313 return handle_inbound_presence_subscriptions_and_probes(origin, stanza, jid_bare(stanza.attr.from), jid_bare(stanza.attr.to));
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);
327 origin.send(st.error_reply(stanza, "modify", "bad-request", "Invalid presence type"));
331 module:hook("presence/full", function(data)
332 -- inbound presence to full JID recieved
333 local origin, stanza = data.origin, data.stanza;
335 local t = stanza.attr.type;
336 if t ~= nil and t ~= "unavailable" and t ~= "error" then -- check for subscriptions and probes sent to full JID
337 return handle_inbound_presence_subscriptions_and_probes(origin, stanza, jid_bare(stanza.attr.from), jid_bare(stanza.attr.to));
340 local session = full_sessions[stanza.attr.to];
342 -- TODO fire post processing event
343 session.send(stanza);
344 end -- resource not online, discard
347 module:hook("presence/host", function(data)
348 -- inbound presence to the host
349 local stanza = data.stanza;
351 local from_bare = jid_bare(stanza.attr.from);
352 local t = stanza.attr.type;
354 core_post_stanza(hosts[module.host], st.presence({ from = module.host, to = from_bare, id = stanza.attr.id }));
355 elseif t == "subscribe" then
356 core_post_stanza(hosts[module.host], st.presence({ from = module.host, to = from_bare, id = stanza.attr.id, type = "subscribed" }));
357 core_post_stanza(hosts[module.host], st.presence({ from = module.host, to = from_bare, id = stanza.attr.id }));
362 module:hook("resource-unbind", function(event)
363 local session, err = event.session, event.error;
364 -- Send unavailable presence
365 if session.presence then
366 local pres = st.presence{ type = "unavailable" };
368 pres:tag("status"):text("Disconnected: "..err):up();
370 session:dispatch_stanza(pres);
371 elseif session.directed then
372 local pres = st.presence{ type = "unavailable", from = session.full_jid };
374 pres:tag("status"):text("Disconnected: "..err):up();
376 for jid in pairs(session.directed) do
378 core_post_stanza(session, pres, true);
380 session.directed = nil;