mirror of
https://github.com/processone/ejabberd.git
synced 2024-11-28 16:34:13 +01:00
66fc1bf3b6
Since we got rid of all bottle-neck processes and we have a connection pool for every database, the option is no longer needed and in fact is detrimental: in practice what you get is just a bunch of overloaded processes in the IQ handlers pool no matter how much you increase the `iqdisc` value. Given that there are close to zero operators understanding the meaning of the option and, hence, not using it all, it's not simply deprecated but completely removed. The commit also deprecates the following functions: - gen_iq_handler:add_iq_handler/6 - gen_iq_handler:handle/5 - gen_iq_handler:iqdisc/1
279 lines
9.0 KiB
Erlang
279 lines
9.0 KiB
Erlang
%%%----------------------------------------------------------------------
|
|
%%% File : mod_ping.erl
|
|
%%% Author : Brian Cully <bjc@kublai.com>
|
|
%%% Purpose : Support XEP-0199 XMPP Ping and periodic keepalives
|
|
%%% Created : 11 Jul 2009 by Brian Cully <bjc@kublai.com>
|
|
%%%
|
|
%%%
|
|
%%% ejabberd, Copyright (C) 2002-2018 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(mod_ping).
|
|
|
|
-author('bjc@kublai.com').
|
|
|
|
-protocol({xep, 199, '2.0'}).
|
|
|
|
-behaviour(gen_mod).
|
|
|
|
-behaviour(gen_server).
|
|
|
|
-include("ejabberd.hrl").
|
|
-include("logger.hrl").
|
|
|
|
-include("xmpp.hrl").
|
|
|
|
%% API
|
|
-export([start_ping/2, stop_ping/2]).
|
|
|
|
%% gen_mod callbacks
|
|
-export([start/2, stop/1, reload/3]).
|
|
|
|
%% gen_server callbacks
|
|
-export([init/1, terminate/2, handle_call/3,
|
|
handle_cast/2, handle_info/2, code_change/3]).
|
|
|
|
-export([iq_ping/1, user_online/3, user_offline/3,
|
|
user_send/1, mod_opt_type/1, mod_options/1, depends/2]).
|
|
|
|
-record(state,
|
|
{host = <<"">> :: binary(),
|
|
send_pings :: boolean(),
|
|
ping_interval :: non_neg_integer(),
|
|
ping_ack_timeout :: undefined | non_neg_integer(),
|
|
timeout_action ::none | kill,
|
|
timers = maps:new() :: map()}).
|
|
|
|
%%====================================================================
|
|
%% API
|
|
%%====================================================================
|
|
-spec start_ping(binary(), jid()) -> ok.
|
|
start_ping(Host, JID) ->
|
|
Proc = gen_mod:get_module_proc(Host, ?MODULE),
|
|
gen_server:cast(Proc, {start_ping, JID}).
|
|
|
|
-spec stop_ping(binary(), jid()) -> ok.
|
|
stop_ping(Host, JID) ->
|
|
Proc = gen_mod:get_module_proc(Host, ?MODULE),
|
|
gen_server:cast(Proc, {stop_ping, JID}).
|
|
|
|
%%====================================================================
|
|
%% gen_mod callbacks
|
|
%%====================================================================
|
|
start(Host, Opts) ->
|
|
gen_mod:start_child(?MODULE, Host, Opts).
|
|
|
|
stop(Host) ->
|
|
gen_mod:stop_child(?MODULE, Host).
|
|
|
|
reload(Host, NewOpts, OldOpts) ->
|
|
Proc = gen_mod:get_module_proc(Host, ?MODULE),
|
|
gen_server:cast(Proc, {reload, Host, NewOpts, OldOpts}).
|
|
|
|
%%====================================================================
|
|
%% gen_server callbacks
|
|
%%====================================================================
|
|
init([Host, Opts]) ->
|
|
process_flag(trap_exit, true),
|
|
State = init_state(Host, Opts),
|
|
register_iq_handlers(Host),
|
|
case State#state.send_pings of
|
|
true -> register_hooks(Host);
|
|
false -> ok
|
|
end,
|
|
{ok, State}.
|
|
|
|
terminate(_Reason, #state{host = Host}) ->
|
|
unregister_hooks(Host),
|
|
unregister_iq_handlers(Host).
|
|
|
|
handle_call(stop, _From, State) ->
|
|
{stop, normal, ok, State};
|
|
handle_call(_Req, _From, State) ->
|
|
{reply, {error, badarg}, State}.
|
|
|
|
handle_cast({reload, Host, NewOpts, _OldOpts},
|
|
#state{timers = Timers} = OldState) ->
|
|
NewState = init_state(Host, NewOpts),
|
|
case {NewState#state.send_pings, OldState#state.send_pings} of
|
|
{true, false} -> register_hooks(Host);
|
|
{false, true} -> unregister_hooks(Host);
|
|
_ -> ok
|
|
end,
|
|
{noreply, NewState#state{timers = Timers}};
|
|
handle_cast({start_ping, JID}, State) ->
|
|
Timers = add_timer(JID, State#state.ping_interval,
|
|
State#state.timers),
|
|
{noreply, State#state{timers = Timers}};
|
|
handle_cast({stop_ping, JID}, State) ->
|
|
Timers = del_timer(JID, State#state.timers),
|
|
{noreply, State#state{timers = Timers}};
|
|
handle_cast({iq_reply, timeout, JID}, State) ->
|
|
Timers = del_timer(JID, State#state.timers),
|
|
ejabberd_hooks:run(user_ping_timeout, State#state.host,
|
|
[JID]),
|
|
case State#state.timeout_action of
|
|
kill ->
|
|
#jid{user = User, server = Server,
|
|
resource = Resource} =
|
|
JID,
|
|
case ejabberd_sm:get_session_pid(User, Server, Resource)
|
|
of
|
|
Pid when is_pid(Pid) -> ejabberd_c2s:close(Pid, ping_timeout);
|
|
_ -> ok
|
|
end;
|
|
_ -> ok
|
|
end,
|
|
{noreply, State#state{timers = Timers}};
|
|
handle_cast({iq_reply, #iq{}, _JID}, State) ->
|
|
{noreply, State};
|
|
handle_cast(Msg, State) ->
|
|
?WARNING_MSG("unexpected cast: ~p", [Msg]),
|
|
{noreply, State}.
|
|
|
|
handle_info({timeout, _TRef, {ping, JID}}, State) ->
|
|
Host = State#state.host,
|
|
From = jid:remove_resource(JID),
|
|
IQ = #iq{from = From, to = JID, type = get, sub_els = [#ping{}]},
|
|
ejabberd_router:route_iq(IQ, JID,
|
|
gen_mod:get_module_proc(Host, ?MODULE),
|
|
State#state.ping_ack_timeout),
|
|
Timers = add_timer(JID, State#state.ping_interval,
|
|
State#state.timers),
|
|
{noreply, State#state{timers = Timers}};
|
|
handle_info(_Info, State) -> {noreply, State}.
|
|
|
|
code_change(_OldVsn, State, _Extra) -> {ok, State}.
|
|
|
|
%%====================================================================
|
|
%% Hook callbacks
|
|
%%====================================================================
|
|
-spec iq_ping(iq()) -> iq().
|
|
iq_ping(#iq{type = get, sub_els = [#ping{}]} = IQ) ->
|
|
xmpp:make_iq_result(IQ);
|
|
iq_ping(#iq{lang = Lang} = IQ) ->
|
|
Txt = <<"Ping query is incorrect">>,
|
|
xmpp:make_error(IQ, xmpp:err_bad_request(Txt, Lang)).
|
|
|
|
-spec user_online(ejabberd_sm:sid(), jid(), ejabberd_sm:info()) -> ok.
|
|
user_online(_SID, JID, _Info) ->
|
|
start_ping(JID#jid.lserver, JID).
|
|
|
|
-spec user_offline(ejabberd_sm:sid(), jid(), ejabberd_sm:info()) -> ok.
|
|
user_offline(_SID, JID, _Info) ->
|
|
stop_ping(JID#jid.lserver, JID).
|
|
|
|
-spec user_send({stanza(), ejabberd_c2s:state()}) -> {stanza(), ejabberd_c2s:state()}.
|
|
user_send({Packet, #{jid := JID} = C2SState}) ->
|
|
start_ping(JID#jid.lserver, JID),
|
|
{Packet, C2SState}.
|
|
|
|
%%====================================================================
|
|
%% Internal functions
|
|
%%====================================================================
|
|
init_state(Host, Opts) ->
|
|
SendPings = gen_mod:get_opt(send_pings, Opts),
|
|
PingInterval = gen_mod:get_opt(ping_interval, Opts),
|
|
PingAckTimeout = gen_mod:get_opt(ping_ack_timeout, Opts),
|
|
TimeoutAction = gen_mod:get_opt(timeout_action, Opts),
|
|
#state{host = Host,
|
|
send_pings = SendPings,
|
|
ping_interval = PingInterval,
|
|
timeout_action = TimeoutAction,
|
|
ping_ack_timeout = PingAckTimeout,
|
|
timers = maps:new()}.
|
|
|
|
register_hooks(Host) ->
|
|
ejabberd_hooks:add(sm_register_connection_hook, Host,
|
|
?MODULE, user_online, 100),
|
|
ejabberd_hooks:add(sm_remove_connection_hook, Host,
|
|
?MODULE, user_offline, 100),
|
|
ejabberd_hooks:add(user_send_packet, Host, ?MODULE,
|
|
user_send, 100).
|
|
|
|
unregister_hooks(Host) ->
|
|
ejabberd_hooks:delete(sm_remove_connection_hook, Host,
|
|
?MODULE, user_offline, 100),
|
|
ejabberd_hooks:delete(sm_register_connection_hook, Host,
|
|
?MODULE, user_online, 100),
|
|
ejabberd_hooks:delete(user_send_packet, Host, ?MODULE,
|
|
user_send, 100).
|
|
|
|
register_iq_handlers(Host) ->
|
|
gen_iq_handler:add_iq_handler(ejabberd_sm, Host, ?NS_PING,
|
|
?MODULE, iq_ping),
|
|
gen_iq_handler:add_iq_handler(ejabberd_local, Host, ?NS_PING,
|
|
?MODULE, iq_ping).
|
|
|
|
unregister_iq_handlers(Host) ->
|
|
gen_iq_handler:remove_iq_handler(ejabberd_local, Host, ?NS_PING),
|
|
gen_iq_handler:remove_iq_handler(ejabberd_sm, Host, ?NS_PING).
|
|
|
|
-spec add_timer(jid(), non_neg_integer(), map()) -> map().
|
|
add_timer(JID, Interval, Timers) ->
|
|
LJID = jid:tolower(JID),
|
|
NewTimers = case maps:find(LJID, Timers) of
|
|
{ok, OldTRef} ->
|
|
cancel_timer(OldTRef),
|
|
maps:remove(LJID, Timers);
|
|
_ -> Timers
|
|
end,
|
|
TRef = erlang:start_timer(Interval * 1000, self(),
|
|
{ping, JID}),
|
|
maps:put(LJID, TRef, NewTimers).
|
|
|
|
-spec del_timer(jid(), map()) -> map().
|
|
del_timer(JID, Timers) ->
|
|
LJID = jid:tolower(JID),
|
|
case maps:find(LJID, Timers) of
|
|
{ok, TRef} ->
|
|
cancel_timer(TRef),
|
|
maps:remove(LJID, Timers);
|
|
_ -> Timers
|
|
end.
|
|
|
|
-spec cancel_timer(reference()) -> ok.
|
|
cancel_timer(TRef) ->
|
|
case erlang:cancel_timer(TRef) of
|
|
false ->
|
|
receive {timeout, TRef, _} -> ok after 0 -> ok end;
|
|
_ -> ok
|
|
end.
|
|
|
|
depends(_Host, _Opts) ->
|
|
[].
|
|
|
|
mod_opt_type(ping_interval) ->
|
|
fun (I) when is_integer(I), I > 0 -> I end;
|
|
mod_opt_type(ping_ack_timeout) ->
|
|
fun(undefined) -> undefined;
|
|
(I) when is_integer(I), I>0 -> timer:seconds(I)
|
|
end;
|
|
mod_opt_type(send_pings) ->
|
|
fun (B) when is_boolean(B) -> B end;
|
|
mod_opt_type(timeout_action) ->
|
|
fun (none) -> none;
|
|
(kill) -> kill
|
|
end.
|
|
|
|
mod_options(_Host) ->
|
|
[{ping_interval, 60},
|
|
{ping_ack_timeout, undefined},
|
|
{send_pings, false},
|
|
{timeout_action, none}].
|