mirror of
https://github.com/processone/ejabberd.git
synced 2024-11-24 16:23:40 +01:00
446 lines
14 KiB
Erlang
446 lines
14 KiB
Erlang
%%%----------------------------------------------------------------------
|
|
%%% File : ejabberd_router.erl
|
|
%%% Author : Alexey Shchepin <alexey@process-one.net>
|
|
%%% Purpose : Main router
|
|
%%% Created : 27 Nov 2002 by Alexey Shchepin <alexey@process-one.net>
|
|
%%%
|
|
%%%
|
|
%%% ejabberd, Copyright (C) 2002-2016 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_router).
|
|
|
|
-behaviour(ejabberd_config).
|
|
|
|
-author('alexey@process-one.net').
|
|
|
|
-behaviour(gen_server).
|
|
|
|
%% API
|
|
-export([route/3,
|
|
route_error/4,
|
|
register_route/1,
|
|
register_route/2,
|
|
register_route/3,
|
|
register_routes/1,
|
|
host_of_route/1,
|
|
unregister_route/1,
|
|
unregister_routes/1,
|
|
dirty_get_all_routes/0,
|
|
dirty_get_all_domains/0
|
|
]).
|
|
|
|
-export([start_link/0]).
|
|
|
|
-export([init/1, handle_call/3, handle_cast/2,
|
|
handle_info/2, terminate/2, code_change/3, opt_type/1]).
|
|
|
|
-include("ejabberd.hrl").
|
|
-include("logger.hrl").
|
|
|
|
-include("jlib.hrl").
|
|
|
|
-type local_hint() :: undefined | integer() | {apply, atom(), atom()}.
|
|
|
|
-record(route, {domain, server_host, pid, local_hint}).
|
|
|
|
-record(state, {}).
|
|
|
|
%%====================================================================
|
|
%% API
|
|
%%====================================================================
|
|
%%--------------------------------------------------------------------
|
|
%% Function: start_link() -> {ok,Pid} | ignore | {error,Error}
|
|
%% Description: Starts the server
|
|
%%--------------------------------------------------------------------
|
|
start_link() ->
|
|
gen_server:start_link({local, ?MODULE}, ?MODULE, [], []).
|
|
|
|
-spec route(jid(), jid(), xmlel()) -> ok.
|
|
|
|
route(From, To, Packet) ->
|
|
case catch do_route(From, To, Packet) of
|
|
{'EXIT', Reason} ->
|
|
?ERROR_MSG("~p~nwhen processing: ~p",
|
|
[Reason, {From, To, Packet}]);
|
|
_ ->
|
|
ok
|
|
end.
|
|
|
|
%% Route the error packet only if the originating packet is not an error itself.
|
|
%% RFC3920 9.3.1
|
|
-spec route_error(jid(), jid(), xmlel(), xmlel()) -> ok.
|
|
|
|
route_error(From, To, ErrPacket, OrigPacket) ->
|
|
#xmlel{attrs = Attrs} = OrigPacket,
|
|
case <<"error">> == fxml:get_attr_s(<<"type">>, Attrs) of
|
|
false -> route(From, To, ErrPacket);
|
|
true -> ok
|
|
end.
|
|
|
|
-spec register_route(binary()) -> term().
|
|
|
|
register_route(Domain) ->
|
|
?WARNING_MSG("~s:register_route/1 is deprected, "
|
|
"use ~s:register_route/2 instead",
|
|
[?MODULE, ?MODULE]),
|
|
register_route(Domain, ?MYNAME).
|
|
|
|
-spec register_route(binary(), binary()) -> term().
|
|
|
|
register_route(Domain, ServerHost) ->
|
|
register_route(Domain, ServerHost, undefined).
|
|
|
|
-spec register_route(binary(), binary(), local_hint()) -> term().
|
|
|
|
register_route(Domain, ServerHost, LocalHint) ->
|
|
case {jid:nameprep(Domain), jid:nameprep(ServerHost)} of
|
|
{error, _} -> erlang:error({invalid_domain, Domain});
|
|
{_, error} -> erlang:error({invalid_domain, ServerHost});
|
|
{LDomain, LServerHost} ->
|
|
Pid = self(),
|
|
case get_component_number(LDomain) of
|
|
undefined ->
|
|
F = fun () ->
|
|
mnesia:write(#route{domain = LDomain, pid = Pid,
|
|
server_host = LServerHost,
|
|
local_hint = LocalHint})
|
|
end,
|
|
mnesia:transaction(F);
|
|
N ->
|
|
F = fun () ->
|
|
case mnesia:wread({route, LDomain}) of
|
|
[] ->
|
|
mnesia:write(#route{domain = LDomain,
|
|
server_host = LServerHost,
|
|
pid = Pid,
|
|
local_hint = 1}),
|
|
lists:foreach(
|
|
fun (I) ->
|
|
mnesia:write(
|
|
#route{domain = LDomain,
|
|
pid = undefined,
|
|
server_host = LServerHost,
|
|
local_hint = I})
|
|
end,
|
|
lists:seq(2, N));
|
|
Rs ->
|
|
lists:any(
|
|
fun (#route{pid = undefined,
|
|
local_hint = I} = R) ->
|
|
mnesia:write(
|
|
#route{domain = LDomain,
|
|
pid = Pid,
|
|
server_host = LServerHost,
|
|
local_hint = I}),
|
|
mnesia:delete_object(R),
|
|
true;
|
|
(_) -> false
|
|
end,
|
|
Rs)
|
|
end
|
|
end,
|
|
mnesia:transaction(F)
|
|
end
|
|
end.
|
|
|
|
-spec register_routes([{binary(), binary()}]) -> ok.
|
|
|
|
register_routes(Domains) ->
|
|
lists:foreach(fun ({Domain, ServerHost}) -> register_route(Domain, ServerHost)
|
|
end,
|
|
Domains).
|
|
|
|
-spec unregister_route(binary()) -> term().
|
|
|
|
unregister_route(Domain) ->
|
|
case jid:nameprep(Domain) of
|
|
error -> erlang:error({invalid_domain, Domain});
|
|
LDomain ->
|
|
Pid = self(),
|
|
case get_component_number(LDomain) of
|
|
undefined ->
|
|
F = fun () ->
|
|
case mnesia:match_object(#route{domain = LDomain,
|
|
pid = Pid, _ = '_'})
|
|
of
|
|
[R] -> mnesia:delete_object(R);
|
|
_ -> ok
|
|
end
|
|
end,
|
|
mnesia:transaction(F);
|
|
_ ->
|
|
F = fun () ->
|
|
case mnesia:match_object(#route{domain = LDomain,
|
|
pid = Pid, _ = '_'})
|
|
of
|
|
[R] ->
|
|
I = R#route.local_hint,
|
|
ServerHost = R#route.server_host,
|
|
mnesia:write(#route{domain = LDomain,
|
|
server_host = ServerHost,
|
|
pid = undefined,
|
|
local_hint = I}),
|
|
mnesia:delete_object(R);
|
|
_ -> ok
|
|
end
|
|
end,
|
|
mnesia:transaction(F)
|
|
end
|
|
end.
|
|
|
|
-spec unregister_routes([binary()]) -> ok.
|
|
|
|
unregister_routes(Domains) ->
|
|
lists:foreach(fun (Domain) -> unregister_route(Domain)
|
|
end,
|
|
Domains).
|
|
|
|
-spec dirty_get_all_routes() -> [binary()].
|
|
|
|
dirty_get_all_routes() ->
|
|
lists:usort(mnesia:dirty_all_keys(route)) -- (?MYHOSTS).
|
|
|
|
-spec dirty_get_all_domains() -> [binary()].
|
|
|
|
dirty_get_all_domains() ->
|
|
lists:usort(mnesia:dirty_all_keys(route)).
|
|
|
|
-spec host_of_route(binary()) -> binary().
|
|
|
|
host_of_route(Domain) ->
|
|
case jid:nameprep(Domain) of
|
|
error ->
|
|
erlang:error({invalid_domain, Domain});
|
|
LDomain ->
|
|
case mnesia:dirty_read(route, LDomain) of
|
|
[#route{server_host = ServerHost}|_] ->
|
|
ServerHost;
|
|
[] ->
|
|
erlang:error({unregistered_route, Domain})
|
|
end
|
|
end.
|
|
|
|
%%====================================================================
|
|
%% gen_server callbacks
|
|
%%====================================================================
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% Function: init(Args) -> {ok, State} |
|
|
%% {ok, State, Timeout} |
|
|
%% ignore |
|
|
%% {stop, Reason}
|
|
%% Description: Initiates the server
|
|
%%--------------------------------------------------------------------
|
|
init([]) ->
|
|
update_tables(),
|
|
mnesia:create_table(route,
|
|
[{ram_copies, [node()]},
|
|
{type, bag},
|
|
{attributes, record_info(fields, route)}]),
|
|
mnesia:add_table_copy(route, node(), ram_copies),
|
|
mnesia:subscribe({table, route, simple}),
|
|
lists:foreach(fun (Pid) -> erlang:monitor(process, Pid)
|
|
end,
|
|
mnesia:dirty_select(route,
|
|
[{{route, '_', '$1', '_'}, [], ['$1']}])),
|
|
{ok, #state{}}.
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% Function: %% handle_call(Request, From, State) -> {reply, Reply, State} |
|
|
%% {reply, Reply, State, Timeout} |
|
|
%% {noreply, State} |
|
|
%% {noreply, State, Timeout} |
|
|
%% {stop, Reason, Reply, State} |
|
|
%% {stop, Reason, State}
|
|
%% Description: Handling call messages
|
|
%%--------------------------------------------------------------------
|
|
handle_call(_Request, _From, State) ->
|
|
Reply = ok, {reply, Reply, State}.
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% Function: handle_cast(Msg, State) -> {noreply, State} |
|
|
%% {noreply, State, Timeout} |
|
|
%% {stop, Reason, State}
|
|
%% Description: Handling cast messages
|
|
%%--------------------------------------------------------------------
|
|
handle_cast(_Msg, State) -> {noreply, State}.
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% Function: handle_info(Info, State) -> {noreply, State} |
|
|
%% {noreply, State, Timeout} |
|
|
%% {stop, Reason, State}
|
|
%% Description: Handling all non call/cast messages
|
|
%%--------------------------------------------------------------------
|
|
handle_info({route, From, To, Packet}, State) ->
|
|
case catch do_route(From, To, Packet) of
|
|
{'EXIT', Reason} ->
|
|
?ERROR_MSG("~p~nwhen processing: ~p",
|
|
[Reason, {From, To, Packet}]);
|
|
_ -> ok
|
|
end,
|
|
{noreply, State};
|
|
handle_info({mnesia_table_event,
|
|
{write, #route{pid = Pid}, _ActivityId}},
|
|
State) ->
|
|
erlang:monitor(process, Pid), {noreply, State};
|
|
handle_info({'DOWN', _Ref, _Type, Pid, _Info}, State) ->
|
|
F = fun () ->
|
|
Es = mnesia:select(route,
|
|
[{#route{pid = Pid, _ = '_'}, [], ['$_']}]),
|
|
lists:foreach(fun (E) ->
|
|
if is_integer(E#route.local_hint) ->
|
|
LDomain = E#route.domain,
|
|
I = E#route.local_hint,
|
|
ServerHost = E#route.server_host,
|
|
mnesia:write(#route{domain =
|
|
LDomain,
|
|
server_host =
|
|
ServerHost,
|
|
pid =
|
|
undefined,
|
|
local_hint =
|
|
I}),
|
|
mnesia:delete_object(E);
|
|
true -> mnesia:delete_object(E)
|
|
end
|
|
end,
|
|
Es)
|
|
end,
|
|
mnesia:transaction(F),
|
|
{noreply, State};
|
|
handle_info(_Info, State) ->
|
|
{noreply, State}.
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% Function: terminate(Reason, State) -> void()
|
|
%% Description: This function is called by a gen_server when it is about to
|
|
%% terminate. It should be the opposite of Module:init/1 and do any necessary
|
|
%% cleaning up. When it returns, the gen_server terminates with Reason.
|
|
%% The return value is ignored.
|
|
%%--------------------------------------------------------------------
|
|
terminate(_Reason, _State) ->
|
|
ok.
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% Func: code_change(OldVsn, State, Extra) -> {ok, NewState}
|
|
%% Description: Convert process state when code is changed
|
|
%%--------------------------------------------------------------------
|
|
code_change(_OldVsn, State, _Extra) ->
|
|
{ok, State}.
|
|
|
|
%%--------------------------------------------------------------------
|
|
%%% Internal functions
|
|
%%--------------------------------------------------------------------
|
|
do_route(OrigFrom, OrigTo, OrigPacket) ->
|
|
?DEBUG("route~n\tfrom ~p~n\tto ~p~n\tpacket "
|
|
"~p~n",
|
|
[OrigFrom, OrigTo, OrigPacket]),
|
|
case ejabberd_hooks:run_fold(filter_packet,
|
|
{OrigFrom, OrigTo, OrigPacket}, [])
|
|
of
|
|
{From, To, Packet} ->
|
|
LDstDomain = To#jid.lserver,
|
|
case mnesia:dirty_read(route, LDstDomain) of
|
|
[] -> ejabberd_s2s:route(From, To, Packet);
|
|
[R] ->
|
|
Pid = R#route.pid,
|
|
if node(Pid) == node() ->
|
|
case R#route.local_hint of
|
|
{apply, Module, Function} ->
|
|
Module:Function(From, To, Packet);
|
|
_ -> Pid ! {route, From, To, Packet}
|
|
end;
|
|
is_pid(Pid) -> Pid ! {route, From, To, Packet};
|
|
true -> drop
|
|
end;
|
|
Rs ->
|
|
Value = case
|
|
ejabberd_config:get_option({domain_balancing,
|
|
LDstDomain}, fun(D) when is_atom(D) -> D end)
|
|
of
|
|
undefined -> p1_time_compat:monotonic_time();
|
|
random -> p1_time_compat:monotonic_time();
|
|
source -> jid:tolower(From);
|
|
destination -> jid:tolower(To);
|
|
bare_source ->
|
|
jid:remove_resource(jid:tolower(From));
|
|
bare_destination ->
|
|
jid:remove_resource(jid:tolower(To))
|
|
end,
|
|
case get_component_number(LDstDomain) of
|
|
undefined ->
|
|
case [R || R <- Rs, node(R#route.pid) == node()] of
|
|
[] ->
|
|
R = lists:nth(erlang:phash(Value, length(Rs)), Rs),
|
|
Pid = R#route.pid,
|
|
if is_pid(Pid) -> Pid ! {route, From, To, Packet};
|
|
true -> drop
|
|
end;
|
|
LRs ->
|
|
R = lists:nth(erlang:phash(Value, length(LRs)),
|
|
LRs),
|
|
Pid = R#route.pid,
|
|
case R#route.local_hint of
|
|
{apply, Module, Function} ->
|
|
Module:Function(From, To, Packet);
|
|
_ -> Pid ! {route, From, To, Packet}
|
|
end
|
|
end;
|
|
_ ->
|
|
SRs = lists:ukeysort(#route.local_hint, Rs),
|
|
R = lists:nth(erlang:phash(Value, length(SRs)), SRs),
|
|
Pid = R#route.pid,
|
|
if is_pid(Pid) -> Pid ! {route, From, To, Packet};
|
|
true -> drop
|
|
end
|
|
end
|
|
end;
|
|
drop -> ok
|
|
end.
|
|
|
|
get_component_number(LDomain) ->
|
|
ejabberd_config:get_option(
|
|
{domain_balancing_component_number, LDomain},
|
|
fun(N) when is_integer(N), N > 1 -> N end,
|
|
undefined).
|
|
|
|
update_tables() ->
|
|
try
|
|
mnesia:transform_table(route, ignore, record_info(fields, route))
|
|
catch exit:{aborted, {no_exists, _}} ->
|
|
ok
|
|
end,
|
|
case lists:member(local_route,
|
|
mnesia:system_info(tables))
|
|
of
|
|
true -> mnesia:delete_table(local_route);
|
|
false -> ok
|
|
end.
|
|
|
|
opt_type(domain_balancing) ->
|
|
fun (random) -> random;
|
|
(source) -> source;
|
|
(destination) -> destination;
|
|
(bare_source) -> bare_source;
|
|
(bare_destination) -> bare_destination
|
|
end;
|
|
opt_type(domain_balancing_component_number) ->
|
|
fun (N) when is_integer(N), N > 1 -> N end;
|
|
opt_type(_) -> [domain_balancing, domain_balancing_component_number].
|