plugins/mod_presence.lua

   1 -- Prosody IM
   2 -- Copyright (C) 2008-2010 Matthew Wild
   3 -- Copyright (C) 2008-2010 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 local log = module._log;
  10
  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;
  16
  17 local st = require "util.stanza";
  18 local jid_split = require "util.jid".split;
  19 local jid_bare = require "util.jid".bare;
  20 local hosts = hosts;
  21 local NULL = {};
  22
  23 local rostermanager = require "core.rostermanager";
  24 local sessionmanager = require "core.sessionmanager";
  25 local offlinemanager = require "core.offlinemanager";
  26
  27 local function select_top_resources(user)
  28         local priority = 0;
  29         local recipients = {};
  30         for _, session in pairs(user.sessions) do -- find resource with greatest priority
  31                 if session.presence then
  32                         -- TODO check active privacy list for session
  33                         local p = session.priority;
  34                         if p > priority then
  35                                 priority = p;
  36                                 recipients = {session};
  37                         elseif p == priority then
  38                                 t_insert(recipients, session);
  39                         end
  40                 end
  41         end
  42         return recipients;
  43 end
  44 local function recalc_resource_map(user)
  45         if user then
  46                 user.top_resources = select_top_resources(user);
  47                 if #user.top_resources == 0 then user.top_resources = nil; end
  48         end
  49 end
  50
  51 local ignore_presence_priority = module:get_option("ignore_presence_priority");
  52
  53 function handle_normal_presence(origin, stanza)
  54         if ignore_presence_priority then
  55                 local priority = stanza:child_with_name("priority");
  56                 if priority and priority[1] ~= "0" then
  57                         for i=#priority.tags,1,-1 do priority.tags[i] = nil; end
  58                         for i=#priority,1,-1 do priority[i] = nil; end
  59                         priority[1] = "0";
  60                 end
  61         end
  62         if full_sessions[origin.full_jid] then -- if user is still connected
  63                 origin.send(stanza); -- reflect their presence back to them
  64         end
  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_post_stanza(origin, stanza, true);
  72                 end
  73         end
  74         for jid, item in pairs(roster) do -- broadcast to all interested contacts
  75                 if item.subscription == "both" or item.subscription == "from" then
  76                         stanza.attr.to = jid;
  77                         core_post_stanza(origin, stanza, true);
  78                 end
  79         end
  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
  85                                 probe.attr.to = jid;
  86                                 core_post_stanza(origin, probe, true);
  87                         end
  88                 end
  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_post_stanza(res, res.presence, true);
  93                                 res.presence.attr.to = nil;
  94                         end
  95                 end
  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?
  99                         end
 100                 end
 101                 local request = st.presence({type="subscribe", from=origin.username.."@"..origin.host});
 102                 for jid, item in pairs(roster) do -- resend outgoing subscription requests
 103                         if item.ask then
 104                                 request.attr.to = jid;
 105                                 core_post_stanza(origin, request, true);
 106                         end
 107                 end
 108                 local offline = offlinemanager.load(node, host);
 109                 if offline then
 110                         for _, msg in ipairs(offline) do
 111                                 origin.send(msg); -- FIXME do we need to modify to/from in any way?
 112                         end
 113                         offlinemanager.deleteAll(node, host);
 114                 end
 115         end
 116         if stanza.attr.type == "unavailable" then
 117                 origin.presence = nil;
 118                 if origin.priority then
 119                         origin.priority = nil;
 120                         recalc_resource_map(user);
 121                 end
 122                 if origin.directed then
 123                         for jid in pairs(origin.directed) do
 124                                 stanza.attr.to = jid;
 125                                 core_post_stanza(origin, stanza, true);
 126                         end
 127                         origin.directed = nil;
 128                 end
 129         else
 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(user);
 143                 end
 144         end
 145         stanza.attr.to = nil; -- reset it
 146 end
 147
 148 function send_presence_of_available_resources(user, host, jid, recipient_session, stanza)
 149         local h = hosts[host];
 150         local count = 0;
 151         if h and h.type == "local" then
 152                 local u = h.sessions[user];
 153                 if u then
 154                         for k, session in pairs(u.sessions) do
 155                                 local pres = session.presence;
 156                                 if pres then
 157                                         if stanza then pres = stanza; pres.attr.from = session.full_jid; end
 158                                         pres.attr.to = jid;
 159                                         core_post_stanza(session, pres, true);
 160                                         pres.attr.to = nil;
 161                                         count = count + 1;
 162                                 end
 163                         end
 164                 end
 165         end
 166         log("debug", "broadcasted presence of "..count.." resources from "..user.."@"..host.." to "..jid);
 167         return count;
 168 end
 169
 170 function handle_outbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare)
 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 == "probe" then
 177                 stanza.attr.from, stanza.attr.to = st_from, st_to;
 178                 return;
 179         elseif stanza.attr.type == "subscribe" then
 180                 -- 1. route stanza
 181                 -- 2. roster push (subscription = none, ask = subscribe)
 182                 if rostermanager.set_contact_pending_out(node, host, to_bare) then
 183                         rostermanager.roster_push(node, host, to_bare);
 184                 end -- else file error
 185                 core_post_stanza(origin, stanza);
 186         elseif stanza.attr.type == "unsubscribe" then
 187                 -- 1. route stanza
 188                 -- 2. roster push (subscription = none or from)
 189                 if rostermanager.unsubscribe(node, host, to_bare) then
 190                         rostermanager.roster_push(node, host, to_bare); -- FIXME do roster push when roster has in fact not changed?
 191                 end -- else file error
 192                 core_post_stanza(origin, stanza);
 193         elseif stanza.attr.type == "subscribed" then
 194                 -- 1. route stanza
 195                 -- 2. roster_push ()
 196                 -- 3. send_presence_of_available_resources
 197                 if rostermanager.subscribed(node, host, to_bare) then
 198                         rostermanager.roster_push(node, host, to_bare);
 199                 end
 200                 core_post_stanza(origin, stanza);
 201                 send_presence_of_available_resources(node, host, to_bare, origin);
 202         elseif stanza.attr.type == "unsubscribed" then
 203                 -- 1. route stanza
 204                 -- 2. roster push (subscription = none or to)
 205                 if rostermanager.unsubscribed(node, host, to_bare) then
 206                         rostermanager.roster_push(node, host, to_bare);
 207                 end
 208                 core_post_stanza(origin, stanza);
 209         end
 210         stanza.attr.from, stanza.attr.to = st_from, st_to;
 211         return true;
 212 end
 213
 214 function handle_inbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare)
 215         local node, host = jid_split(to_bare);
 216         local st_from, st_to = stanza.attr.from, stanza.attr.to;
 217         stanza.attr.from, stanza.attr.to = from_bare, to_bare;
 218         log("debug", "inbound presence "..stanza.attr.type.." from "..from_bare.." for "..to_bare);
 219
 220         if stanza.attr.type == "probe" then
 221                 local result, err = rostermanager.is_contact_subscribed(node, host, from_bare);
 222                 if result then
 223                         if 0 == send_presence_of_available_resources(node, host, st_from, origin) then
 224                                 core_post_stanza(hosts[host], st.presence({from=to_bare, to=st_from, type="unavailable"}), true); -- TODO send last activity
 225                         end
 226                 elseif not err then
 227                         core_post_stanza(hosts[host], st.presence({from=to_bare, to=from_bare, type="unsubscribed"}), true);
 228                 end
 229         elseif stanza.attr.type == "subscribe" then
 230                 if rostermanager.is_contact_subscribed(node, host, from_bare) then
 231                         core_post_stanza(hosts[host], st.presence({from=to_bare, to=from_bare, type="subscribed"}), true); -- already subscribed
 232                         -- Sending presence is not clearly stated in the RFC, but it seems appropriate
 233                         if 0 == send_presence_of_available_resources(node, host, from_bare, origin) then
 234                                 core_post_stanza(hosts[host], st.presence({from=to_bare, to=from_bare, type="unavailable"}), true); -- TODO send last activity
 235                         end
 236                 else
 237                         core_post_stanza(hosts[host], st.presence({from=to_bare, to=from_bare, type="unavailable"}), true); -- acknowledging receipt
 238                         if not rostermanager.is_contact_pending_in(node, host, from_bare) then
 239                                 if rostermanager.set_contact_pending_in(node, host, from_bare) then
 240                                         sessionmanager.send_to_available_resources(node, host, stanza);
 241                                 end -- TODO else return error, unable to save
 242                         end
 243                 end
 244         elseif stanza.attr.type == "unsubscribe" then
 245                 if rostermanager.process_inbound_unsubscribe(node, host, from_bare) then
 246                         sessionmanager.send_to_interested_resources(node, host, stanza);
 247                         rostermanager.roster_push(node, host, from_bare);
 248                 end
 249         elseif stanza.attr.type == "subscribed" then
 250                 if rostermanager.process_inbound_subscription_approval(node, host, from_bare) then
 251                         sessionmanager.send_to_interested_resources(node, host, stanza);
 252                         rostermanager.roster_push(node, host, from_bare);
 253                 end
 254         elseif stanza.attr.type == "unsubscribed" then
 255                 if rostermanager.process_inbound_subscription_cancellation(node, host, from_bare) then
 256                         sessionmanager.send_to_interested_resources(node, host, stanza);
 257                         rostermanager.roster_push(node, host, from_bare);
 258                 end
 259         end -- discard any other type
 260         stanza.attr.from, stanza.attr.to = st_from, st_to;
 261         return true;
 262 end
 263
 264 local outbound_presence_handler = function(data)
 265         -- outbound presence recieved
 266         local origin, stanza = data.origin, data.stanza;
 267
 268         local to = stanza.attr.to;
 269         if to then
 270                 local t = stanza.attr.type;
 271                 if t ~= nil and t ~= "unavailable" and t ~= "error" then -- check for subscriptions and probes
 272                         return handle_outbound_presence_subscriptions_and_probes(origin, stanza, jid_bare(stanza.attr.from), jid_bare(stanza.attr.to));
 273                 end
 274
 275                 local to_bare = jid_bare(to);
 276                 if not(origin.roster[to_bare] and (origin.roster[to_bare].subscription == "both" or origin.roster[to_bare].subscription == "from")) then -- directed presence
 277                         origin.directed = origin.directed or {};
 278                         if t then -- removing from directed presence list on sending an error or unavailable
 279                                 origin.directed[to] = nil; -- FIXME does it make more sense to add to_bare rather than to?
 280                         else
 281                                 origin.directed[to] = true; -- FIXME does it make more sense to add to_bare rather than to?
 282                         end
 283                 end
 284         end -- TODO maybe handle normal presence here, instead of letting it pass to incoming handlers?
 285 end
 286
 287 module:hook("pre-presence/full", outbound_presence_handler);
 288 module:hook("pre-presence/bare", outbound_presence_handler);
 289 module:hook("pre-presence/host", outbound_presence_handler);
 290
 291 module:hook("presence/bare", function(data)
 292         -- inbound presence to bare JID recieved
 293         local origin, stanza = data.origin, data.stanza;
 294
 295         local to = stanza.attr.to;
 296         local t = stanza.attr.type;
 297         if to then
 298                 if t ~= nil and t ~= "unavailable" and t ~= "error" then -- check for subscriptions and probes sent to bare JID
 299                         return handle_inbound_presence_subscriptions_and_probes(origin, stanza, jid_bare(stanza.attr.from), jid_bare(stanza.attr.to));
 300                 end
 301
 302                 local user = bare_sessions[to];
 303                 if user then
 304                         for _, session in pairs(user.sessions) do
 305                                 if session.presence then -- only send to available resources
 306                                         session.send(stanza);
 307                                 end
 308                         end
 309                 end -- no resources not online, discard
 310         elseif not t or t == "unavailable" then
 311                 handle_normal_presence(origin, stanza);
 312         end
 313         return true;
 314 end);
 315 module:hook("presence/full", function(data)
 316         -- inbound presence to full JID recieved
 317         local origin, stanza = data.origin, data.stanza;
 318
 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                 return handle_inbound_presence_subscriptions_and_probes(origin, stanza, jid_bare(stanza.attr.from), jid_bare(stanza.attr.to));
 322         end
 323
 324         local session = full_sessions[stanza.attr.to];
 325         if session then
 326                 -- TODO fire post processing event
 327                 session.send(stanza);
 328         end -- resource not online, discard
 329         return true;
 330 end);
 331 module:hook("presence/host", function(data)
 332         -- inbound presence to the host
 333         local origin, stanza = data.origin, data.stanza;
 334
 335         local from_bare = jid_bare(stanza.attr.from);
 336         local t = stanza.attr.type;
 337         if t == "probe" then
 338                 core_post_stanza(hosts[module.host], st.presence({ from = module.host, to = from_bare, id = stanza.attr.id }));
 339         elseif t == "subscribe" then
 340                 core_post_stanza(hosts[module.host], st.presence({ from = module.host, to = from_bare, id = stanza.attr.id, type = "subscribed" }));
 341                 core_post_stanza(hosts[module.host], st.presence({ from = module.host, to = from_bare, id = stanza.attr.id }));
 342         end
 343         return true;
 344 end);
 345
 346 module:hook("resource-unbind", function(event)
 347         local session, err = event.session, event.error;
 348         -- Send unavailable presence
 349         if session.presence then
 350                 local pres = st.presence{ type = "unavailable" };
 351                 if not(err) or err == "closed" then err = "connection closed"; end
 352                 pres:tag("status"):text("Disconnected: "..err):up();
 353                 session:dispatch_stanza(pres);
 354         elseif session.directed then
 355                 local pres = st.presence{ type = "unavailable", from = session.full_jid };
 356                 if not(err) or err == "closed" then err = "connection closed"; end
 357                 pres:tag("status"):text("Disconnected: "..err):up();
 358                 for jid in pairs(session.directed) do
 359                         pres.attr.to = jid;
 360                         core_post_stanza(session, pres, true);
 361                 end
 362                 session.directed = nil;
 363         end
 364 end);