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