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