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