%%%---------------------------------------------------------------------- %%% File : ejabberd_sm.erl %%% Author : Alexey Shchepin %%% Purpose : Session manager %%% Created : 24 Nov 2002 by Alexey Shchepin %%% %%% %%% ejabberd, Copyright (C) 2002-2020 ProcessOne %%% %%% This program is free software; you can redistribute it and/or %%% modify it under the terms of the GNU General Public License as %%% published by the Free Software Foundation; either version 2 of the %%% License, or (at your option) any later version. %%% %%% This program is distributed in the hope that it will be useful, %%% but WITHOUT ANY WARRANTY; without even the implied warranty of %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU %%% General Public License for more details. %%% %%% You should have received a copy of the GNU General Public License along %%% with this program; if not, write to the Free Software Foundation, Inc., %%% 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. %%% %%%---------------------------------------------------------------------- -module(ejabberd_sm). -author('alexey@process-one.net'). -ifndef(GEN_SERVER). -define(GEN_SERVER, gen_server). -endif. -behaviour(?GEN_SERVER). %% API -export([start_link/0, stop/0, route/1, route/2, open_session/5, open_session/6, close_session/4, check_in_subscription/2, bounce_offline_message/1, bounce_sm_packet/1, disconnect_removed_user/2, get_user_resources/2, get_user_present_resources/2, set_presence/6, unset_presence/5, close_session_unset_presence/5, dirty_get_sessions_list/0, dirty_get_my_sessions_list/0, get_vh_session_list/1, get_vh_session_number/1, get_vh_by_backend/1, force_update_presence/1, connected_users/0, connected_users_number/0, user_resources/2, kick_user/2, kick_user/3, get_session_pid/3, get_session_sid/3, get_session_sids/2, get_session_sids/3, get_user_info/2, get_user_info/3, set_user_info/5, del_user_info/4, get_user_ip/3, get_max_user_sessions/2, get_all_pids/0, is_existing_resource/3, get_commands_spec/0, c2s_handle_info/2, host_up/1, host_down/1, make_sid/0, clean_cache/1, config_reloaded/0 ]). -export([init/1, handle_call/3, handle_cast/2, handle_info/2, terminate/2, code_change/3]). -include("logger.hrl"). -include("xmpp.hrl"). -include("ejabberd_commands.hrl"). -include("ejabberd_sm.hrl"). -include("ejabberd_stacktrace.hrl"). -include("translate.hrl"). -callback init() -> ok | {error, any()}. -callback set_session(#session{}) -> ok | {error, any()}. -callback delete_session(#session{}) -> ok | {error, any()}. -callback get_sessions() -> [#session{}]. -callback get_sessions(binary()) -> [#session{}]. -callback get_sessions(binary(), binary()) -> {ok, [#session{}]} | {error, any()}. -callback use_cache(binary()) -> boolean(). -callback cache_nodes(binary()) -> [node()]. -optional_callbacks([use_cache/1, cache_nodes/1]). -record(state, {}). %% default value for the maximum number of user connections -define(MAX_USER_SESSIONS, infinity). %%==================================================================== %% API %%==================================================================== -export_type([sid/0, info/0]). start_link() -> ?GEN_SERVER:start_link({local, ?MODULE}, ?MODULE, [], []). -spec stop() -> ok. stop() -> _ = supervisor:terminate_child(ejabberd_sup, ?MODULE), _ = supervisor:delete_child(ejabberd_sup, ?MODULE), _ = supervisor:terminate_child(ejabberd_sup, ejabberd_c2s_sup), _ = supervisor:delete_child(ejabberd_sup, ejabberd_c2s_sup), ok. -spec route(jid(), term()) -> ok. %% @doc route arbitrary term to c2s process(es) route(To, Term) -> try do_route(To, Term), ok catch ?EX_RULE(E, R, St) -> StackTrace = ?EX_STACK(St), ?ERROR_MSG("Failed to route term to ~ts:~n" "** Term = ~p~n" "** ~ts", [jid:encode(To), Term, misc:format_exception(2, E, R, StackTrace)]) end. -spec route(stanza()) -> ok. route(Packet) -> #jid{lserver = LServer} = xmpp:get_to(Packet), case ejabberd_hooks:run_fold(sm_receive_packet, LServer, Packet, []) of drop -> ?DEBUG("Hook dropped stanza:~n~ts", [xmpp:pp(Packet)]); Packet1 -> do_route(Packet1), ok end. -spec open_session(sid(), binary(), binary(), binary(), prio(), info()) -> ok. open_session(SID, User, Server, Resource, Priority, Info) -> set_session(SID, User, Server, Resource, Priority, Info), check_for_sessions_to_replace(User, Server, Resource), JID = jid:make(User, Server, Resource), ejabberd_hooks:run(sm_register_connection_hook, JID#jid.lserver, [SID, JID, Info]). -spec open_session(sid(), binary(), binary(), binary(), info()) -> ok. open_session(SID, User, Server, Resource, Info) -> open_session(SID, User, Server, Resource, undefined, Info). -spec close_session(sid(), binary(), binary(), binary()) -> ok. close_session(SID, User, Server, Resource) -> LUser = jid:nodeprep(User), LServer = jid:nameprep(Server), LResource = jid:resourceprep(Resource), Mod = get_sm_backend(LServer), Sessions = get_sessions(Mod, LUser, LServer, LResource), Info = case lists:keyfind(SID, #session.sid, Sessions) of #session{info = I} = Session -> delete_session(Mod, Session), I; _ -> [] end, JID = jid:make(User, Server, Resource), ejabberd_hooks:run(sm_remove_connection_hook, JID#jid.lserver, [SID, JID, Info]). -spec check_in_subscription(boolean(), presence()) -> boolean() | {stop, false}. check_in_subscription(Acc, #presence{to = To}) -> #jid{user = User, server = Server} = To, case ejabberd_auth:user_exists(User, Server) of true -> Acc; false -> {stop, false} end. -spec bounce_offline_message({bounce, message()} | any()) -> any(). bounce_offline_message({bounce, #message{type = T}} = Acc) when T == chat; T == groupchat; T == normal -> bounce_sm_packet(Acc); bounce_offline_message(Acc) -> Acc. -spec bounce_sm_packet({bounce | term(), stanza()}) -> any(). bounce_sm_packet({bounce, Packet} = Acc) -> Lang = xmpp:get_lang(Packet), Txt = ?T("User session not found"), Err = xmpp:err_service_unavailable(Txt, Lang), ejabberd_router:route_error(Packet, Err), {stop, Acc}; bounce_sm_packet({_, Packet} = Acc) -> ?DEBUG("Dropping packet to unavailable resource:~n~ts", [xmpp:pp(Packet)]), Acc. -spec disconnect_removed_user(binary(), binary()) -> ok. disconnect_removed_user(User, Server) -> route(jid:make(User, Server), {exit, ?T("User removed")}). get_user_resources(User, Server) -> LUser = jid:nodeprep(User), LServer = jid:nameprep(Server), Mod = get_sm_backend(LServer), Ss = get_sessions(Mod, LUser, LServer), [element(3, S#session.usr) || S <- clean_session_list(Ss)]. -spec get_user_present_resources(binary(), binary()) -> [tuple()]. get_user_present_resources(LUser, LServer) -> Mod = get_sm_backend(LServer), Ss = get_sessions(Mod, LUser, LServer), [{S#session.priority, element(3, S#session.usr)} || S <- clean_session_list(Ss), is_integer(S#session.priority)]. -spec get_user_ip(binary(), binary(), binary()) -> ip(). get_user_ip(User, Server, Resource) -> LUser = jid:nodeprep(User), LServer = jid:nameprep(Server), LResource = jid:resourceprep(Resource), Mod = get_sm_backend(LServer), case get_sessions(Mod, LUser, LServer, LResource) of [] -> undefined; Ss -> Session = lists:max(Ss), proplists:get_value(ip, Session#session.info) end. -spec get_user_info(binary(), binary()) -> [{binary(), info()}]. get_user_info(User, Server) -> LUser = jid:nodeprep(User), LServer = jid:nameprep(Server), Mod = get_sm_backend(LServer), Ss = get_sessions(Mod, LUser, LServer), [{LResource, [{node, node(Pid)}, {ts, Ts}, {pid, Pid}, {priority, Priority} | Info]} || #session{usr = {_, _, LResource}, priority = Priority, info = Info, sid = {Ts, Pid}} <- clean_session_list(Ss)]. -spec get_user_info(binary(), binary(), binary()) -> info() | offline. get_user_info(User, Server, Resource) -> LUser = jid:nodeprep(User), LServer = jid:nameprep(Server), LResource = jid:resourceprep(Resource), Mod = get_sm_backend(LServer), case get_sessions(Mod, LUser, LServer, LResource) of [] -> offline; Ss -> Session = lists:max(Ss), {Ts, Pid} = Session#session.sid, Node = node(Pid), Priority = Session#session.priority, [{node, Node}, {ts, Ts}, {pid, Pid}, {priority, Priority} |Session#session.info] end. -spec set_user_info(binary(), binary(), binary(), atom(), term()) -> ok | {error, any()}. set_user_info(User, Server, Resource, Key, Val) -> LUser = jid:nodeprep(User), LServer = jid:nameprep(Server), LResource = jid:resourceprep(Resource), Mod = get_sm_backend(LServer), case get_sessions(Mod, LUser, LServer, LResource) of [] -> {error, notfound}; Ss -> lists:foldl( fun(#session{sid = {_, Pid}, info = Info} = Session, _) when Pid == self() -> Info1 = lists:keystore(Key, 1, Info, {Key, Val}), set_session(Session#session{info = Info1}); (_, Acc) -> Acc end, {error, not_owner}, Ss) end. -spec del_user_info(binary(), binary(), binary(), atom()) -> ok | {error, any()}. del_user_info(User, Server, Resource, Key) -> LUser = jid:nodeprep(User), LServer = jid:nameprep(Server), LResource = jid:resourceprep(Resource), Mod = get_sm_backend(LServer), case get_sessions(Mod, LUser, LServer, LResource) of [] -> {error, notfound}; Ss -> lists:foldl( fun(#session{sid = {_, Pid}, info = Info} = Session, _) when Pid == self() -> Info1 = lists:keydelete(Key, 1, Info), set_session(Session#session{info = Info1}); (_, Acc) -> Acc end, {error, not_owner}, Ss) end. -spec set_presence(sid(), binary(), binary(), binary(), prio(), presence()) -> ok | {error, notfound}. set_presence(SID, User, Server, Resource, Priority, Presence) -> LUser = jid:nodeprep(User), LServer = jid:nameprep(Server), LResource = jid:resourceprep(Resource), Mod = get_sm_backend(LServer), case get_sessions(Mod, LUser, LServer, LResource) of [] -> {error, notfound}; Ss -> case lists:keyfind(SID, #session.sid, Ss) of #session{info = Info} -> set_session(SID, User, Server, Resource, Priority, Info), ejabberd_hooks:run(set_presence_hook, LServer, [User, Server, Resource, Presence]); false -> {error, notfound} end end. -spec unset_presence(sid(), binary(), binary(), binary(), binary()) -> ok | {error, notfound}. unset_presence(SID, User, Server, Resource, Status) -> LUser = jid:nodeprep(User), LServer = jid:nameprep(Server), LResource = jid:resourceprep(Resource), Mod = get_sm_backend(LServer), case get_sessions(Mod, LUser, LServer, LResource) of [] -> {error, notfound}; Ss -> case lists:keyfind(SID, #session.sid, Ss) of #session{info = Info} -> set_session(SID, User, Server, Resource, undefined, Info), ejabberd_hooks:run(unset_presence_hook, LServer, [User, Server, Resource, Status]); false -> {error, notfound} end end. -spec close_session_unset_presence(sid(), binary(), binary(), binary(), binary()) -> ok. close_session_unset_presence(SID, User, Server, Resource, Status) -> close_session(SID, User, Server, Resource), ejabberd_hooks:run(unset_presence_hook, jid:nameprep(Server), [User, Server, Resource, Status]). -spec get_session_pid(binary(), binary(), binary()) -> none | pid(). get_session_pid(User, Server, Resource) -> case get_session_sid(User, Server, Resource) of {_, PID} -> PID; none -> none end. -spec get_session_sid(binary(), binary(), binary()) -> none | sid(). get_session_sid(User, Server, Resource) -> LUser = jid:nodeprep(User), LServer = jid:nameprep(Server), LResource = jid:resourceprep(Resource), Mod = get_sm_backend(LServer), case get_sessions(Mod, LUser, LServer, LResource) of [] -> none; Ss -> #session{sid = SID} = lists:max(Ss), SID end. -spec get_session_sids(binary(), binary()) -> [sid()]. get_session_sids(User, Server) -> LUser = jid:nodeprep(User), LServer = jid:nameprep(Server), Mod = get_sm_backend(LServer), Sessions = get_sessions(Mod, LUser, LServer), [SID || #session{sid = SID} <- Sessions]. -spec get_session_sids(binary(), binary(), binary()) -> [sid()]. get_session_sids(User, Server, Resource) -> LUser = jid:nodeprep(User), LServer = jid:nameprep(Server), LResource = jid:resourceprep(Resource), Mod = get_sm_backend(LServer), Sessions = get_sessions(Mod, LUser, LServer, LResource), [SID || #session{sid = SID} <- Sessions]. -spec dirty_get_sessions_list() -> [ljid()]. dirty_get_sessions_list() -> lists:flatmap( fun(Mod) -> [S#session.usr || S <- get_sessions(Mod)] end, get_sm_backends()). -spec dirty_get_my_sessions_list() -> [#session{}]. dirty_get_my_sessions_list() -> lists:flatmap( fun(Mod) -> [S || S <- get_sessions(Mod), node(element(2, S#session.sid)) == node()] end, get_sm_backends()). -spec get_vh_session_list(binary()) -> [ljid()]. get_vh_session_list(Server) -> LServer = jid:nameprep(Server), Mod = get_sm_backend(LServer), [S#session.usr || S <- get_sessions(Mod, LServer)]. -spec get_all_pids() -> [pid()]. get_all_pids() -> lists:flatmap( fun(Mod) -> [element(2, S#session.sid) || S <- get_sessions(Mod)] end, get_sm_backends()). -spec get_vh_session_number(binary()) -> non_neg_integer(). get_vh_session_number(Server) -> LServer = jid:nameprep(Server), Mod = get_sm_backend(LServer), length(get_sessions(Mod, LServer)). c2s_handle_info(#{lang := Lang} = State, replaced) -> State1 = State#{replaced => true}, Err = xmpp:serr_conflict(?T("Replaced by new connection"), Lang), {stop, ejabberd_c2s:send(State1, Err)}; c2s_handle_info(#{lang := Lang} = State, kick) -> Err = xmpp:serr_policy_violation(?T("has been kicked"), Lang), {stop, ejabberd_c2s:send(State, Err)}; c2s_handle_info(#{lang := Lang} = State, {exit, Reason}) -> Err = xmpp:serr_conflict(Reason, Lang), {stop, ejabberd_c2s:send(State, Err)}; c2s_handle_info(State, _) -> State. -spec config_reloaded() -> ok. config_reloaded() -> init_cache(). %%==================================================================== %% gen_server callbacks %%==================================================================== init([]) -> process_flag(trap_exit, true), init_cache(), case lists:foldl( fun(Mod, ok) -> Mod:init(); (_, Err) -> Err end, ok, get_sm_backends()) of ok -> clean_cache(), gen_iq_handler:start(?MODULE), ejabberd_hooks:add(host_up, ?MODULE, host_up, 50), ejabberd_hooks:add(host_down, ?MODULE, host_down, 60), ejabberd_hooks:add(config_reloaded, ?MODULE, config_reloaded, 50), lists:foreach(fun host_up/1, ejabberd_option:hosts()), ejabberd_commands:register_commands(get_commands_spec()), {ok, #state{}}; {error, Why} -> {stop, Why} end. handle_call(Request, From, State) -> ?WARNING_MSG("Unexpected call from ~p: ~p", [From, Request]), {noreply, State}. handle_cast(Msg, State) -> ?WARNING_MSG("Unexpected cast: ~p", [Msg]), {noreply, State}. handle_info(Info, State) -> ?WARNING_MSG("Unexpected info: ~p", [Info]), {noreply, State}. terminate(_Reason, _State) -> lists:foreach(fun host_down/1, ejabberd_option:hosts()), ejabberd_hooks:delete(host_up, ?MODULE, host_up, 50), ejabberd_hooks:delete(host_down, ?MODULE, host_down, 60), ejabberd_hooks:delete(config_reloaded, ?MODULE, config_reloaded, 50), ejabberd_commands:unregister_commands(get_commands_spec()), ok. code_change(_OldVsn, State, _Extra) -> {ok, State}. %%-------------------------------------------------------------------- %%% Internal functions %%-------------------------------------------------------------------- -spec host_up(binary()) -> ok. host_up(Host) -> ejabberd_hooks:add(c2s_handle_info, Host, ejabberd_sm, c2s_handle_info, 50), ejabberd_hooks:add(roster_in_subscription, Host, ejabberd_sm, check_in_subscription, 20), ejabberd_hooks:add(offline_message_hook, Host, ejabberd_sm, bounce_offline_message, 100), ejabberd_hooks:add(bounce_sm_packet, Host, ejabberd_sm, bounce_sm_packet, 100), ejabberd_hooks:add(remove_user, Host, ejabberd_sm, disconnect_removed_user, 100), ejabberd_c2s:host_up(Host). -spec host_down(binary()) -> ok. host_down(Host) -> Mod = get_sm_backend(Host), Err = case ejabberd_cluster:get_nodes() of [Node] when Node == node() -> xmpp:serr_system_shutdown(); _ -> xmpp:serr_reset() end, lists:foreach( fun(#session{sid = {_, Pid}}) when node(Pid) == node() -> ejabberd_c2s:send(Pid, Err), ejabberd_c2s:stop(Pid); (_) -> ok end, get_sessions(Mod, Host)), ejabberd_hooks:delete(c2s_handle_info, Host, ejabberd_sm, c2s_handle_info, 50), ejabberd_hooks:delete(roster_in_subscription, Host, ejabberd_sm, check_in_subscription, 20), ejabberd_hooks:delete(offline_message_hook, Host, ejabberd_sm, bounce_offline_message, 100), ejabberd_hooks:delete(bounce_sm_packet, Host, ejabberd_sm, bounce_sm_packet, 100), ejabberd_hooks:delete(remove_user, Host, ejabberd_sm, disconnect_removed_user, 100), ejabberd_c2s:host_down(Host). -spec set_session(sid(), binary(), binary(), binary(), prio(), info()) -> ok | {error, any()}. set_session(SID, User, Server, Resource, Priority, Info) -> LUser = jid:nodeprep(User), LServer = jid:nameprep(Server), LResource = jid:resourceprep(Resource), US = {LUser, LServer}, USR = {LUser, LServer, LResource}, set_session(#session{sid = SID, usr = USR, us = US, priority = Priority, info = Info}). -spec set_session(#session{}) -> ok | {error, any()}. set_session(#session{us = {LUser, LServer}} = Session) -> Mod = get_sm_backend(LServer), case Mod:set_session(Session) of ok -> case use_cache(Mod, LServer) of true -> ets_cache:delete(?SM_CACHE, {LUser, LServer}, cache_nodes(Mod, LServer)); false -> ok end; {error, _} = Err -> Err end. -spec get_sessions(module()) -> [#session{}]. get_sessions(Mod) -> delete_dead(Mod, Mod:get_sessions()). -spec get_sessions(module(), binary()) -> [#session{}]. get_sessions(Mod, LServer) -> delete_dead(Mod, Mod:get_sessions(LServer)). -spec get_sessions(module(), binary(), binary()) -> [#session{}]. get_sessions(Mod, LUser, LServer) -> case use_cache(Mod, LServer) of true -> case ets_cache:lookup( ?SM_CACHE, {LUser, LServer}, fun() -> case Mod:get_sessions(LUser, LServer) of {ok, Ss} when Ss /= [] -> {ok, Ss}; _ -> error end end) of {ok, Sessions} -> delete_dead(Mod, Sessions); error -> [] end; false -> case Mod:get_sessions(LUser, LServer) of {ok, Ss} -> delete_dead(Mod, Ss); _ -> [] end end. -spec get_sessions(module(), binary(), binary(), binary()) -> [#session{}]. get_sessions(Mod, LUser, LServer, LResource) -> Sessions = get_sessions(Mod, LUser, LServer), [S || S <- Sessions, element(3, S#session.usr) == LResource]. -spec delete_session(module(), #session{}) -> ok. delete_session(Mod, #session{usr = {LUser, LServer, _}} = Session) -> Mod:delete_session(Session), case use_cache(Mod, LServer) of true -> ets_cache:delete(?SM_CACHE, {LUser, LServer}, cache_nodes(Mod, LServer)); false -> ok end. -spec delete_dead(module(), [#session{}]) -> [#session{}]. delete_dead(Mod, Sessions) -> lists:filter( fun(#session{sid = {_, Pid}} = Session) when node(Pid) == node() -> case is_process_alive(Pid) of true -> true; false -> delete_session(Mod, Session), false end; (_) -> true end, Sessions). %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -spec do_route(jid(), term()) -> any(). do_route(#jid{lresource = <<"">>} = To, Term) -> lists:foreach( fun(R) -> do_route(jid:replace_resource(To, R), Term) end, get_user_resources(To#jid.user, To#jid.server)); do_route(To, Term) -> ?DEBUG("Broadcasting ~p to ~ts", [Term, jid:encode(To)]), {U, S, R} = jid:tolower(To), Mod = get_sm_backend(S), case get_sessions(Mod, U, S, R) of [] -> ?DEBUG("Dropping broadcast to unavailable resourse: ~p", [Term]); Ss -> Session = lists:max(Ss), Pid = element(2, Session#session.sid), ?DEBUG("Sending to process ~p: ~p", [Pid, Term]), ejabberd_c2s:route(Pid, Term) end. -spec do_route(stanza()) -> any(). do_route(#presence{to = To, type = T} = Packet) when T == subscribe; T == subscribed; T == unsubscribe; T == unsubscribed -> ?DEBUG("Processing subscription:~n~ts", [xmpp:pp(Packet)]), #jid{luser = LUser, lserver = LServer} = To, case is_privacy_allow(Packet) andalso ejabberd_hooks:run_fold( roster_in_subscription, LServer, false, [Packet]) of true -> Mod = get_sm_backend(LServer), lists:foreach( fun(#session{sid = SID, usr = {_, _, R}, priority = Prio}) when is_integer(Prio) -> Pid = element(2, SID), Packet1 = Packet#presence{to = jid:replace_resource(To, R)}, ?DEBUG("Sending to process ~p:~n~ts", [Pid, xmpp:pp(Packet1)]), ejabberd_c2s:route(Pid, {route, Packet1}); (_) -> ok end, get_sessions(Mod, LUser, LServer)); false -> ok end; do_route(#presence{to = #jid{lresource = <<"">>} = To} = Packet) -> ?DEBUG("Processing presence to bare JID:~n~ts", [xmpp:pp(Packet)]), {LUser, LServer, _} = jid:tolower(To), lists:foreach( fun({_, R}) -> do_route(Packet#presence{to = jid:replace_resource(To, R)}) end, get_user_present_resources(LUser, LServer)); do_route(#message{to = #jid{lresource = <<"">>} = To, type = T} = Packet) -> ?DEBUG("Processing message to bare JID:~n~ts", [xmpp:pp(Packet)]), if T == chat; T == headline; T == normal -> route_message(Packet); true -> ejabberd_hooks:run_fold(bounce_sm_packet, To#jid.lserver, {bounce, Packet}, []) end; do_route(#iq{to = #jid{lresource = <<"">>} = To, type = T} = Packet) -> if T == set; T == get -> ?DEBUG("Processing IQ to bare JID:~n~ts", [xmpp:pp(Packet)]), gen_iq_handler:handle(?MODULE, Packet); true -> ejabberd_hooks:run_fold(bounce_sm_packet, To#jid.lserver, {pass, Packet}, []) end; do_route(Packet) -> ?DEBUG("Processing packet to full JID:~n~ts", [xmpp:pp(Packet)]), To = xmpp:get_to(Packet), {LUser, LServer, LResource} = jid:tolower(To), Mod = get_sm_backend(LServer), case get_sessions(Mod, LUser, LServer, LResource) of [] -> case Packet of #message{type = T} when T == chat; T == normal -> route_message(Packet); #message{type = T} when T == headline -> ejabberd_hooks:run_fold(bounce_sm_packet, LServer, {pass, Packet}, []); #presence{} -> ejabberd_hooks:run_fold(bounce_sm_packet, LServer, {pass, Packet}, []); _ -> ejabberd_hooks:run_fold(bounce_sm_packet, LServer, {bounce, Packet}, []) end; Ss -> Session = lists:max(Ss), Pid = element(2, Session#session.sid), ?DEBUG("Sending to process ~p:~n~ts", [Pid, xmpp:pp(Packet)]), ejabberd_c2s:route(Pid, {route, Packet}) end. %% The default list applies to the user as a whole, %% and is processed if there is no active list set %% for the target session/resource to which a stanza is addressed, %% or if there are no current sessions for the user. -spec is_privacy_allow(stanza()) -> boolean(). is_privacy_allow(Packet) -> To = xmpp:get_to(Packet), LServer = To#jid.server, allow == ejabberd_hooks:run_fold( privacy_check_packet, LServer, allow, [To, Packet, in]). -spec route_message(message()) -> any(). route_message(#message{to = To, type = Type} = Packet) -> LUser = To#jid.luser, LServer = To#jid.lserver, PrioRes = get_user_present_resources(LUser, LServer), case catch lists:max(PrioRes) of {MaxPrio, MaxRes} when is_integer(MaxPrio), MaxPrio >= 0 -> lists:foreach(fun ({P, R}) when P == MaxPrio; (P >= 0) and (Type == headline) -> LResource = jid:resourceprep(R), Mod = get_sm_backend(LServer), case get_sessions(Mod, LUser, LServer, LResource) of [] -> ok; % Race condition Ss -> Session = lists:max(Ss), Pid = element(2, Session#session.sid), ?DEBUG("Sending to process ~p~n", [Pid]), LMaxRes = jid:resourceprep(MaxRes), Packet1 = maybe_mark_as_copy(Packet, LResource, LMaxRes, P, MaxPrio), ejabberd_c2s:route(Pid, {route, Packet1}) end; %% Ignore other priority: ({_Prio, _Res}) -> ok end, PrioRes); _ -> case ejabberd_auth:user_exists(LUser, LServer) andalso is_privacy_allow(Packet) of true -> ejabberd_hooks:run_fold(offline_message_hook, LServer, {bounce, Packet}, []); false -> Err = xmpp:err_service_unavailable(), ejabberd_router:route_error(Packet, Err) end end. -spec maybe_mark_as_copy(message(), binary(), binary(), integer(), integer()) -> message(). maybe_mark_as_copy(Packet, R, R, P, P) -> Packet; maybe_mark_as_copy(Packet, _, _, P, P) -> xmpp:put_meta(Packet, sm_copy, true); maybe_mark_as_copy(Packet, _, _, _, _) -> Packet. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -spec clean_session_list([#session{}]) -> [#session{}]. clean_session_list(Ss) -> clean_session_list(lists:keysort(#session.usr, Ss), []). -spec clean_session_list([#session{}], [#session{}]) -> [#session{}]. clean_session_list([], Res) -> Res; clean_session_list([S], Res) -> [S | Res]; clean_session_list([S1, S2 | Rest], Res) -> if S1#session.usr == S2#session.usr -> if S1#session.sid > S2#session.sid -> clean_session_list([S1 | Rest], Res); true -> clean_session_list([S2 | Rest], Res) end; true -> clean_session_list([S2 | Rest], [S1 | Res]) end. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% On new session, check if some existing connections need to be replace -spec check_for_sessions_to_replace(binary(), binary(), binary()) -> ok | replaced. check_for_sessions_to_replace(User, Server, Resource) -> LUser = jid:nodeprep(User), LServer = jid:nameprep(Server), LResource = jid:resourceprep(Resource), check_existing_resources(LUser, LServer, LResource), check_max_sessions(LUser, LServer). -spec check_existing_resources(binary(), binary(), binary()) -> ok. check_existing_resources(LUser, LServer, LResource) -> Mod = get_sm_backend(LServer), Ss = get_sessions(Mod, LUser, LServer, LResource), if Ss == [] -> ok; true -> SIDs = [SID || #session{sid = SID} <- Ss], MaxSID = lists:max(SIDs), lists:foreach(fun ({_, Pid} = S) when S /= MaxSID -> ejabberd_c2s:route(Pid, replaced); (_) -> ok end, SIDs) end. -spec is_existing_resource(binary(), binary(), binary()) -> boolean(). is_existing_resource(LUser, LServer, LResource) -> [] /= get_resource_sessions(LUser, LServer, LResource). -spec get_resource_sessions(binary(), binary(), binary()) -> [sid()]. get_resource_sessions(User, Server, Resource) -> LUser = jid:nodeprep(User), LServer = jid:nameprep(Server), LResource = jid:resourceprep(Resource), Mod = get_sm_backend(LServer), [S#session.sid || S <- get_sessions(Mod, LUser, LServer, LResource)]. -spec check_max_sessions(binary(), binary()) -> ok | replaced. check_max_sessions(LUser, LServer) -> Mod = get_sm_backend(LServer), Ss = get_sessions(Mod, LUser, LServer), MaxSessions = get_max_user_sessions(LUser, LServer), if length(Ss) =< MaxSessions -> ok; true -> #session{sid = {_, Pid}} = lists:min(Ss), ejabberd_c2s:route(Pid, replaced) end. %% Get the user_max_session setting %% This option defines the max number of time a given users are allowed to %% log in %% Defaults to infinity -spec get_max_user_sessions(binary(), binary()) -> infinity | non_neg_integer(). get_max_user_sessions(LUser, Host) -> case ejabberd_shaper:match(Host, max_user_sessions, jid:make(LUser, Host)) of Max when is_integer(Max) -> Max; infinity -> infinity; _ -> ?MAX_USER_SESSIONS end. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -spec force_update_presence({binary(), binary()}) -> ok. force_update_presence({LUser, LServer}) -> Mod = get_sm_backend(LServer), Ss = get_sessions(Mod, LUser, LServer), lists:foreach(fun (#session{sid = {_, Pid}}) -> ejabberd_c2s:resend_presence(Pid) end, Ss). -spec get_sm_backend(binary()) -> module(). get_sm_backend(Host) -> DBType = ejabberd_option:sm_db_type(Host), list_to_existing_atom("ejabberd_sm_" ++ atom_to_list(DBType)). -spec get_sm_backends() -> [module()]. get_sm_backends() -> lists:usort([get_sm_backend(Host) || Host <- ejabberd_option:hosts()]). -spec get_vh_by_backend(module()) -> [binary()]. get_vh_by_backend(Mod) -> lists:filter( fun(Host) -> get_sm_backend(Host) == Mod end, ejabberd_option:hosts()). %%-------------------------------------------------------------------- %%% Cache stuff %%-------------------------------------------------------------------- -spec init_cache() -> ok. init_cache() -> case use_cache() of true -> ets_cache:new(?SM_CACHE, cache_opts()); false -> ets_cache:delete(?SM_CACHE) end. -spec cache_opts() -> [proplists:property()]. cache_opts() -> MaxSize = ejabberd_option:sm_cache_size(), CacheMissed = ejabberd_option:sm_cache_missed(), LifeTime = ejabberd_option:sm_cache_life_time(), [{max_size, MaxSize}, {cache_missed, CacheMissed}, {life_time, LifeTime}]. -spec clean_cache(node()) -> non_neg_integer(). clean_cache(Node) -> ets_cache:filter( ?SM_CACHE, fun(_, error) -> false; (_, {ok, Ss}) -> not lists:any( fun(#session{sid = {_, Pid}}) -> node(Pid) == Node end, Ss) end). -spec clean_cache() -> ok. clean_cache() -> ejabberd_cluster:eval_everywhere(?MODULE, clean_cache, [node()]). -spec use_cache(module(), binary()) -> boolean(). use_cache(Mod, LServer) -> case erlang:function_exported(Mod, use_cache, 1) of true -> Mod:use_cache(LServer); false -> ejabberd_option:sm_use_cache(LServer) end. -spec use_cache() -> boolean(). use_cache() -> lists:any( fun(Host) -> Mod = get_sm_backend(Host), use_cache(Mod, Host) end, ejabberd_option:hosts()). -spec cache_nodes(module(), binary()) -> [node()]. cache_nodes(Mod, LServer) -> case erlang:function_exported(Mod, cache_nodes, 1) of true -> Mod:cache_nodes(LServer); false -> ejabberd_cluster:get_nodes() end. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%% ejabberd commands get_commands_spec() -> [#ejabberd_commands{name = connected_users, tags = [session], desc = "List all established sessions", policy = admin, module = ?MODULE, function = connected_users, args = [], result_desc = "List of users sessions", result_example = [<<"user1@example.com">>, <<"user2@example.com">>], result = {connected_users, {list, {sessions, string}}}}, #ejabberd_commands{name = connected_users_number, tags = [session, stats], desc = "Get the number of established sessions", policy = admin, module = ?MODULE, function = connected_users_number, result_example = 2, args = [], result = {num_sessions, integer}}, #ejabberd_commands{name = user_resources, tags = [session], desc = "List user's connected resources", policy = admin, module = ?MODULE, function = user_resources, args = [{user, binary}, {host, binary}], args_desc = ["User name", "Server name"], args_example = [<<"user1">>, <<"example.com">>], result_example = [<<"tka1">>, <<"Gajim">>, <<"mobile-app">>], result = {resources, {list, {resource, string}}}}, #ejabberd_commands{name = kick_user, tags = [session], desc = "Disconnect user's active sessions", module = ?MODULE, function = kick_user, args = [{user, binary}, {host, binary}], args_desc = ["User name", "Server name"], args_example = [<<"user1">>, <<"example.com">>], result_desc = "Number of resources that were kicked", result_example = 3, result = {num_resources, integer}}]. -spec connected_users() -> [binary()]. connected_users() -> USRs = dirty_get_sessions_list(), SUSRs = lists:sort(USRs), lists:map(fun ({U, S, R}) -> <> end, SUSRs). connected_users_number() -> length(dirty_get_sessions_list()). user_resources(User, Server) -> Resources = get_user_resources(User, Server), lists:sort(Resources). -spec kick_user(binary(), binary()) -> non_neg_integer(). kick_user(User, Server) -> Resources = get_user_resources(User, Server), lists:foldl( fun(Resource, Acc) -> case kick_user(User, Server, Resource) of false -> Acc; true -> Acc + 1 end end, 0, Resources). -spec kick_user(binary(), binary(), binary()) -> boolean(). kick_user(User, Server, Resource) -> case get_session_pid(User, Server, Resource) of none -> false; Pid -> ejabberd_c2s:route(Pid, kick) end. make_sid() -> {misc:unique_timestamp(), self()}.