aboutsummaryrefslogtreecommitdiff
path: root/src/mod_ping.erl
diff options
context:
space:
mode:
Diffstat (limited to 'src/mod_ping.erl')
-rw-r--r--src/mod_ping.erl268
1 files changed, 135 insertions, 133 deletions
diff --git a/src/mod_ping.erl b/src/mod_ping.erl
index d1b3f9322..8e6827247 100644
--- a/src/mod_ping.erl
+++ b/src/mod_ping.erl
@@ -5,7 +5,7 @@
%%% Created : 11 Jul 2009 by Brian Cully <bjc@kublai.com>
%%%
%%%
-%%% ejabberd, Copyright (C) 2002-2016 ProcessOne
+%%% ejabberd, Copyright (C) 2002-2019 ProcessOne
%%%
%%% This program is free software; you can redistribute it and/or
%%% modify it under the terms of the GNU General Public License as
@@ -29,54 +29,48 @@
-protocol({xep, 199, '2.0'}).
--behavior(gen_mod).
+-behaviour(gen_mod).
--behavior(gen_server).
+-behaviour(gen_server).
--include("ejabberd.hrl").
-include("logger.hrl").
--include("jlib.hrl").
+-include("xmpp.hrl").
--define(SUPERVISOR, ejabberd_sup).
-
--define(DEFAULT_SEND_PINGS, false).
-
--define(DEFAULT_PING_INTERVAL, 60).
+-include("translate.hrl").
%% API
--export([start_link/2, start_ping/2, stop_ping/2]).
+-export([start_ping/2, stop_ping/2]).
%% gen_mod callbacks
--export([start/2, stop/1]).
+-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/3, user_online/3, user_offline/3,
- user_send/4, mod_opt_type/1, depends/2]).
+-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 = <<"">>,
- send_pings = ?DEFAULT_SEND_PINGS :: boolean(),
- ping_interval = ?DEFAULT_PING_INTERVAL :: non_neg_integer(),
- ping_ack_timeout = undefined :: non_neg_integer(),
- timeout_action = none :: none | kill,
- timers = maps:new() :: map()}).
+ {host :: binary(),
+ send_pings :: boolean(),
+ ping_interval :: pos_integer(),
+ ping_ack_timeout :: undefined | non_neg_integer(),
+ timeout_action :: none | kill,
+ timers :: timers()}).
+
+-type timers() :: #{ljid() => reference()}.
%%====================================================================
%% API
%%====================================================================
-start_link(Host, Opts) ->
- Proc = gen_mod:get_module_proc(Host, ?MODULE),
- gen_server:start_link({local, Proc}, ?MODULE,
- [Host, Opts], []).
-
+-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}).
@@ -85,75 +79,48 @@ stop_ping(Host, JID) ->
%% gen_mod callbacks
%%====================================================================
start(Host, Opts) ->
- Proc = gen_mod:get_module_proc(Host, ?MODULE),
- PingSpec = {Proc, {?MODULE, start_link, [Host, Opts]},
- transient, 2000, worker, [?MODULE]},
- supervisor:start_child(?SUPERVISOR, PingSpec).
+ 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:call(Proc, stop),
- supervisor:delete_child(?SUPERVISOR, Proc).
+ gen_server:cast(Proc, {reload, Host, NewOpts, OldOpts}).
%%====================================================================
%% gen_server callbacks
%%====================================================================
-init([Host, Opts]) ->
- SendPings = gen_mod:get_opt(send_pings, Opts,
- fun(B) when is_boolean(B) -> B end,
- ?DEFAULT_SEND_PINGS),
- PingInterval = gen_mod:get_opt(ping_interval, Opts,
- fun(I) when is_integer(I), I>0 -> I end,
- ?DEFAULT_PING_INTERVAL),
- PingAckTimeout = gen_mod:get_opt(ping_ack_timeout, Opts,
- fun(I) when is_integer(I), I>0 -> I * 1000 end,
- undefined),
- TimeoutAction = gen_mod:get_opt(timeout_action, Opts,
- fun(none) -> none;
- (kill) -> kill
- end, none),
- IQDisc = gen_mod:get_opt(iqdisc, Opts, fun gen_iq_handler:check_type/1,
- no_queue),
- mod_disco:register_feature(Host, ?NS_PING),
- gen_iq_handler:add_iq_handler(ejabberd_sm, Host,
- ?NS_PING, ?MODULE, iq_ping, IQDisc),
- gen_iq_handler:add_iq_handler(ejabberd_local, Host,
- ?NS_PING, ?MODULE, iq_ping, IQDisc),
- case SendPings of
- true ->
- 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);
- _ -> ok
+init([Host|_]) ->
+ process_flag(trap_exit, true),
+ Opts = gen_mod:get_module_opts(Host, ?MODULE),
+ State = init_state(Host, Opts),
+ register_iq_handlers(Host),
+ case State#state.send_pings of
+ true -> register_hooks(Host);
+ false -> ok
end,
- {ok,
- #state{host = Host, send_pings = SendPings,
- ping_interval = PingInterval,
- timeout_action = TimeoutAction,
- ping_ack_timeout = PingAckTimeout,
- timers = maps:new()}}.
+ {ok, State}.
terminate(_Reason, #state{host = 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),
- gen_iq_handler:remove_iq_handler(ejabberd_local, Host,
- ?NS_PING),
- gen_iq_handler:remove_iq_handler(ejabberd_sm, Host,
- ?NS_PING),
- mod_disco:unregister_feature(Host, ?NS_PING).
+ 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_call(Request, From, State) ->
+ ?WARNING_MSG("Unexpected call from ~p: ~p", [From, Request]),
+ {noreply, 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),
@@ -161,111 +128,146 @@ handle_cast({start_ping, JID}, State) ->
handle_cast({stop_ping, JID}, State) ->
Timers = del_timer(JID, State#state.timers),
{noreply, State#state{timers = Timers}};
-handle_cast({iq_pong, JID, timeout}, State) ->
- Timers = del_timer(JID, State#state.timers),
+handle_cast(Msg, State) ->
+ ?WARNING_MSG("Unexpected cast: ~p", [Msg]),
+ {noreply, State}.
+
+handle_info({iq_reply, #iq{}, _JID}, State) ->
+ {noreply, State};
+handle_info({iq_reply, timeout, JID}, State) ->
ejabberd_hooks:run(user_ping_timeout, State#state.host,
[JID]),
- case State#state.timeout_action of
+ Timers = 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);
+ Pid when is_pid(Pid) -> ejabberd_c2s:close(Pid, ping_timeout);
_ -> ok
- end;
- _ -> ok
+ end,
+ del_timer(JID, State#state.timers);
+ _ ->
+ State#state.timers
end,
{noreply, State#state{timers = Timers}};
-handle_cast(_Msg, State) -> {noreply, State}.
-
handle_info({timeout, _TRef, {ping, JID}}, State) ->
- IQ = #iq{type = get,
- sub_el =
- [#xmlel{name = <<"ping">>,
- attrs = [{<<"xmlns">>, ?NS_PING}], children = []}]},
- Pid = self(),
- F = fun (Response) ->
- gen_server:cast(Pid, {iq_pong, JID, Response})
- end,
- From = jid:make(<<"">>, State#state.host, <<"">>),
- ejabberd_local:route_iq(From, JID, IQ, F, State#state.ping_ack_timeout),
+ 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}.
+handle_info(Info, State) ->
+ ?WARNING_MSG("Unexpected info: ~p", [Info]),
+ {noreply, State}.
code_change(_OldVsn, State, _Extra) -> {ok, State}.
%%====================================================================
%% Hook callbacks
%%====================================================================
-iq_ping(_From, _To,
- #iq{type = Type, sub_el = SubEl, lang = Lang} = IQ) ->
- case {Type, SubEl} of
- {get, #xmlel{name = <<"ping">>}} ->
- IQ#iq{type = result, sub_el = []};
- _ ->
- Txt = <<"Ping query is incorrect">>,
- IQ#iq{type = error,
- sub_el = [SubEl, ?ERRT_BAD_REQUEST(Lang, Txt)]}
- end.
-
+-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 = ?T("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).
-user_send(Packet, _C2SState, JID, _From) ->
+-spec user_send({stanza(), ejabberd_c2s:state()}) -> {stanza(), ejabberd_c2s:state()}.
+user_send({Packet, #{jid := JID} = C2SState}) ->
start_ping(JID#jid.lserver, JID),
- Packet.
+ {Packet, C2SState}.
%%====================================================================
%% Internal functions
%%====================================================================
+init_state(Host, Opts) ->
+ SendPings = mod_ping_opt:send_pings(Opts),
+ PingInterval = mod_ping_opt:ping_interval(Opts),
+ PingAckTimeout = mod_ping_opt:ping_ack_timeout(Opts),
+ TimeoutAction = mod_ping_opt:timeout_action(Opts),
+ #state{host = Host,
+ send_pings = SendPings,
+ ping_interval = PingInterval,
+ timeout_action = TimeoutAction,
+ ping_ack_timeout = PingAckTimeout,
+ timers = #{}}.
+
+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(), pos_integer(), timers()) -> timers().
add_timer(JID, Interval, Timers) ->
LJID = jid:tolower(JID),
NewTimers = case maps:find(LJID, Timers) of
{ok, OldTRef} ->
- cancel_timer(OldTRef),
+ misc:cancel_timer(OldTRef),
maps:remove(LJID, Timers);
_ -> Timers
end,
- TRef = erlang:start_timer(Interval * 1000, self(),
- {ping, JID}),
+ TRef = erlang:start_timer(Interval, self(), {ping, JID}),
maps:put(LJID, TRef, NewTimers).
+-spec del_timer(jid(), timers()) -> timers().
del_timer(JID, Timers) ->
LJID = jid:tolower(JID),
case maps:find(LJID, Timers) of
{ok, TRef} ->
- cancel_timer(TRef),
+ misc:cancel_timer(TRef),
maps:remove(LJID, Timers);
_ -> Timers
end.
-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(iqdisc) -> fun gen_iq_handler:check_type/1;
mod_opt_type(ping_interval) ->
- fun (I) when is_integer(I), I > 0 -> I end;
+ econf:timeout(second);
mod_opt_type(ping_ack_timeout) ->
- fun (I) when is_integer(I), I > 0 -> I end;
+ econf:timeout(second);
mod_opt_type(send_pings) ->
- fun (B) when is_boolean(B) -> B end;
+ econf:bool();
mod_opt_type(timeout_action) ->
- fun (none) -> none;
- (kill) -> kill
- end;
-mod_opt_type(_) ->
- [iqdisc, ping_interval, ping_ack_timeout, send_pings, timeout_action].
+ econf:enum([none, kill]).
+
+mod_options(_Host) ->
+ [{ping_interval, timer:minutes(1)},
+ {ping_ack_timeout, undefined},
+ {send_pings, false},
+ {timeout_action, none}].
generated by cgit v1.2.3 (git 2.25.1) at 2025-09-08 02:28:05 +0000