core/sessionmanager.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 tostring, setmetatable = tostring, setmetatable;
  10 local pairs, next= pairs, next;
  11
  12 local hosts = hosts;
  13 local full_sessions = prosody.full_sessions;
  14 local bare_sessions = prosody.bare_sessions;
  15
  16 local logger = require "util.logger";
  17 local log = logger.init("sessionmanager");
  18 local rm_load_roster = require "core.rostermanager".load_roster;
  19 local config_get = require "core.configmanager".get;
  20 local resourceprep = require "util.encodings".stringprep.resourceprep;
  21 local nodeprep = require "util.encodings".stringprep.nodeprep;
  22 local uuid_generate = require "util.uuid".generate;
  23
  24 local initialize_filters = require "util.filters".initialize;
  25 local gettime = require "socket".gettime;
  26
  27 module "sessionmanager"
  28
  29 function new_session(conn)
  30         local session = { conn = conn, type = "c2s_unauthed", conntime = gettime() };
  31         local filter = initialize_filters(session);
  32         local w = conn.write;
  33         session.send = function (t)
  34                 if t.name then
  35                         t = filter("stanzas/out", t);
  36                 end
  37                 if t then
  38                         t = filter("bytes/out", tostring(t));
  39                         if t then
  40                                 return w(conn, t);
  41                         end
  42                 end
  43         end
  44         session.ip = conn:ip();
  45         local conn_name = "c2s"..tostring(session):match("[a-f0-9]+$");
  46         session.log = logger.init(conn_name);
  47
  48         return session;
  49 end
  50
  51 local resting_session = { -- Resting, not dead
  52                 destroyed = true;
  53                 type = "c2s_destroyed";
  54                 close = function (session)
  55                         session.log("debug", "Attempt to close already-closed session");
  56                 end;
  57                 filter = function (type, data) return data; end;
  58         }; resting_session.__index = resting_session;
  59
  60 function retire_session(session)
  61         local log = session.log or log;
  62         for k in pairs(session) do
  63                 if k ~= "log" and k ~= "id" then
  64                         session[k] = nil;
  65                 end
  66         end
  67
  68         function session.send(data) log("debug", "Discarding data sent to resting session: %s", tostring(data)); return false; end
  69         function session.data(data) log("debug", "Discarding data received from resting session: %s", tostring(data)); end
  70         session.thread = { run = function (_, data) return session.data(data) end };
  71         return setmetatable(session, resting_session);
  72 end
  73
  74 function destroy_session(session, err)
  75         (session.log or log)("debug", "Destroying session for %s (%s@%s)%s", session.full_jid or "(unknown)", session.username or "(unknown)", session.host or "(unknown)", err and (": "..err) or "");
  76         if session.destroyed then return; end
  77
  78         -- Remove session/resource from user's session list
  79         if session.full_jid then
  80                 local host_session = hosts[session.host];
  81
  82                 -- Allow plugins to prevent session destruction
  83                 if host_session.events.fire_event("pre-resource-unbind", {session=session, error=err}) then
  84                         return;
  85                 end
  86
  87                 host_session.sessions[session.username].sessions[session.resource] = nil;
  88                 full_sessions[session.full_jid] = nil;
  89
  90                 if not next(host_session.sessions[session.username].sessions) then
  91                         log("debug", "All resources of %s are now offline", session.username);
  92                         host_session.sessions[session.username] = nil;
  93                         bare_sessions[session.username..'@'..session.host] = nil;
  94                 end
  95
  96                 host_session.events.fire_event("resource-unbind", {session=session, error=err});
  97         end
  98
  99         retire_session(session);
 100 end
 101
 102 function make_authenticated(session, username)
 103         username = nodeprep(username);
 104         if not username or #username == 0 then return nil, "Invalid username"; end
 105         session.username = username;
 106         if session.type == "c2s_unauthed" then
 107                 session.type = "c2s";
 108         end
 109         session.log("info", "Authenticated as %s@%s", username or "(unknown)", session.host or "(unknown)");
 110         return true;
 111 end
 112
 113 -- returns true, nil on success
 114 -- returns nil, err_type, err, err_message on failure
 115 function bind_resource(session, resource)
 116         if not session.username then return nil, "auth", "not-authorized", "Cannot bind resource before authentication"; end
 117         if session.resource then return nil, "cancel", "not-allowed", "Cannot bind multiple resources on a single connection"; end
 118         -- We don't support binding multiple resources
 119
 120         local event_payload = { session = session, resource = resource };
 121         if hosts[session.host].events.fire_event("pre-resource-bind", event_payload) == false then
 122                 local err = event_payload.error;
 123                 if err then return nil, err.type, err.condition, err.text; end
 124                 return nil, "cancel", "not-allowed";
 125         else
 126                 -- In case a plugin wants to poke at it
 127                 resource = event_payload.resource;
 128         end
 129
 130         resource = resourceprep(resource);
 131         resource = resource ~= "" and resource or uuid_generate();
 132         --FIXME: Randomly-generated resources must be unique per-user, and never conflict with existing
 133
 134         if not hosts[session.host].sessions[session.username] then
 135                 local sessions = { sessions = {} };
 136                 hosts[session.host].sessions[session.username] = sessions;
 137                 bare_sessions[session.username..'@'..session.host] = sessions;
 138         else
 139                 local sessions = hosts[session.host].sessions[session.username].sessions;
 140                 if sessions[resource] then
 141                         -- Resource conflict
 142                         local policy = config_get(session.host, "conflict_resolve");
 143                         local increment;
 144                         if policy == "random" then
 145                                 resource = uuid_generate();
 146                                 increment = true;
 147                         elseif policy == "increment" then
 148                                 increment = true; -- TODO ping old resource
 149                         elseif policy == "kick_new" then
 150                                 return nil, "cancel", "conflict", "Resource already exists";
 151                         else -- if policy == "kick_old" then
 152                                 sessions[resource]:close {
 153                                         condition = "conflict";
 154                                         text = "Replaced by new connection";
 155                                 };
 156                                 if not next(sessions) then
 157                                         hosts[session.host].sessions[session.username] = { sessions = sessions };
 158                                         bare_sessions[session.username.."@"..session.host] = hosts[session.host].sessions[session.username];
 159                                 end
 160                         end
 161                         if increment and sessions[resource] then
 162                                 local count = 1;
 163                                 while sessions[resource.."#"..count] do
 164                                         count = count + 1;
 165                                 end
 166                                 resource = resource.."#"..count;
 167                         end
 168                 end
 169         end
 170
 171         session.resource = resource;
 172         session.full_jid = session.username .. '@' .. session.host .. '/' .. resource;
 173         hosts[session.host].sessions[session.username].sessions[resource] = session;
 174         full_sessions[session.full_jid] = session;
 175
 176         local err;
 177         session.roster, err = rm_load_roster(session.username, session.host);
 178         if err then
 179                 full_sessions[session.full_jid] = nil;
 180                 hosts[session.host].sessions[session.username].sessions[resource] = nil;
 181                 session.full_jid = nil;
 182                 session.resource = nil;
 183                 if next(bare_sessions[session.username..'@'..session.host].sessions) == nil then
 184                         bare_sessions[session.username..'@'..session.host] = nil;
 185                         hosts[session.host].sessions[session.username] = nil;
 186                 end
 187                 session.log("error", "Roster loading failed: %s", err);
 188                 return nil, "cancel", "internal-server-error", "Error loading roster";
 189         end
 190
 191         hosts[session.host].events.fire_event("resource-bind", {session=session});
 192
 193         return true;
 194 end
 195
 196 function send_to_available_resources(username, host, stanza)
 197         local jid = username.."@"..host;
 198         local count = 0;
 199         local user = bare_sessions[jid];
 200         if user then
 201                 for k, session in pairs(user.sessions) do
 202                         if session.presence then
 203                                 session.send(stanza);
 204                                 count = count + 1;
 205                         end
 206                 end
 207         end
 208         return count;
 209 end
 210
 211 function send_to_interested_resources(user, host, stanza)
 212         local jid = user.."@"..host;
 213         local count = 0;
 214         local user = bare_sessions[jid];
 215         if user then
 216                 for k, session in pairs(user.sessions) do
 217                         if session.interested then
 218                                 session.send(stanza);
 219                                 count = count + 1;
 220                         end
 221                 end
 222         end
 223         return count;
 224 end
 225
 226 return _M;