Add SQL as router RAM backend

2025-10-05 02:29:34 +02:00 · 2017-03-28 16:31:37 +03:00 · 2017-03-28 16:31:37 +03:00 · 117f31125d
commit 117f31125d
parent 5b6d042de2
8 changed files with 247 additions and 8 deletions
--- a/src/ejabberd_router_sql.erl
+++ b/src/ejabberd_router_sql.erl
@ -0,0 +1,181 @@
+%%%-------------------------------------------------------------------
+%%% @author Evgeny Khramtsov <ekhramtsov@process-one.net>
+%%% Created : 28 Mar 2017 by Evgeny Khramtsov <ekhramtsov@process-one.net>
+%%%
+%%%
+%%% ejabberd, Copyright (C) 2002-2017   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_sql).
+-behaviour(ejabberd_router).
+
+-compile([{parse_transform, ejabberd_sql_pt}]).
+
+%% API
+-export([init/0, register_route/5, unregister_route/3, find_routes/1,
+	 host_of_route/1, is_my_route/1, is_my_host/1, get_all_routes/0]).
+
+-include("ejabberd.hrl").
+-include("logger.hrl").
+-include("ejabberd_sql_pt.hrl").
+-include("ejabberd_router.hrl").
+
+%%%===================================================================
+%%% API
+%%%===================================================================
+init() ->
+    Node = erlang:atom_to_binary(node(), latin1),
+    ?INFO_MSG("Cleaning SQL 'route' table...", []),
+    case ejabberd_sql:sql_query(
+	   ?MYNAME, ?SQL("delete from route where node=%(Node)s")) of
+	{updated, _} ->
+	    ok;
+	Err ->
+	    ?ERROR_MSG("failed to clean 'route' table: ~p", [Err]),
+	    Err
+    end.
+
+register_route(Domain, ServerHost, LocalHint, _, Pid) ->
+    PidS = enc_pid(Pid),
+    LocalHintS = enc_local_hint(LocalHint),
+    Node = erlang:atom_to_binary(node(Pid), latin1),
+    case ?SQL_UPSERT(?MYNAME, "route",
+		     ["!domain=%(Domain)s",
+		      "!server_host=%(ServerHost)s",
+		      "!node=%(Node)s",
+		      "!pid=%(PidS)s",
+		      "local_hint=%(LocalHintS)s"]) of
+	ok ->
+	    ok;
+	Err ->
+	    ?ERROR_MSG("failed to update 'route' table: ~p", [Err]),
+	    {error, Err}
+    end.
+
+unregister_route(Domain, _, Pid) ->
+    PidS = enc_pid(Pid),
+    Node = erlang:atom_to_binary(node(Pid), latin1),
+    ejabberd_sql:sql_query(
+      ?MYNAME,
+      ?SQL("delete from route where domain=%(Domain)s "
+	   "and pid=%(PidS)s and node=%(Node)s")),
+    %% TODO: return meaningful error
+    ok.
+
+find_routes(Domain) ->
+    case ejabberd_sql:sql_query(
+	   ?MYNAME,
+	   ?SQL("select @(server_host)s, @(node)s, @(pid)s, @(local_hint)s "
+		"from route where domain=%(Domain)s")) of
+	{selected, Rows} ->
+	    lists:flatmap(
+	      fun(Row) ->
+		      row_to_route(Domain, Row)
+	      end, Rows);
+	Err ->
+	    ?ERROR_MSG("failed to select from 'route' table: ~p", [Err]),
+	    {error, Err}
+    end.
+
+host_of_route(Domain) ->
+    case ejabberd_sql:sql_query(
+	   ?MYNAME,
+	   ?SQL("select @(server_host)s from route where domain=%(Domain)s")) of
+	{selected, [{ServerHost}|_]} ->
+	    {ok, ServerHost};
+	{selected, []} ->
+	    error;
+	Err ->
+	    ?ERROR_MSG("failed to select from 'route' table: ~p", [Err]),
+	    error
+    end.
+
+is_my_route(Domain) ->
+    case host_of_route(Domain) of
+	{ok, _} -> true;
+	_ -> false
+    end.
+
+is_my_host(Domain) ->
+    {ok, Domain} == host_of_route(Domain).
+
+get_all_routes() ->
+    case ejabberd_sql:sql_query(
+	   ?MYNAME,
+	   ?SQL("select @(domain)s from route where domain <> server_host")) of
+	{selected, Domains} ->
+	    [Domain || {Domain} <- Domains];
+	Err ->
+	    ?ERROR_MSG("failed to select from 'route' table: ~p", [Err]),
+	    []
+    end.
+
+%%%===================================================================
+%%% Internal functions
+%%%===================================================================
+enc_local_hint(undefined) ->
+    <<"">>;
+enc_local_hint(LocalHint) ->
+    jlib:term_to_expr(LocalHint).
+
+dec_local_hint(<<"">>) ->
+    undefined;
+dec_local_hint(S) ->
+    ejabberd_sql:decode_term(S).
+
+-spec enc_pid(pid()) -> binary().
+enc_pid(Pid) ->
+    list_to_binary(erlang:pid_to_list(Pid)).
+
+-spec dec_pid(binary(), binary()) -> pid().
+dec_pid(PidBin, NodeBin) ->
+    PidStr = binary_to_list(PidBin),
+    Pid = erlang:list_to_pid(PidStr),
+    case erlang:binary_to_atom(NodeBin, latin1) of
+	Node when Node == node() ->
+	    Pid;
+	Node ->
+	    try set_node_id(PidStr, NodeBin)
+	    catch _:badarg ->
+		    erlang:error({node_down, Node})
+	    end
+    end.
+
+-spec set_node_id(string(), binary()) -> pid().
+set_node_id(PidStr, NodeBin) ->
+    ExtPidStr = erlang:pid_to_list(
+		  binary_to_term(
+		    <<131,103,100,(size(NodeBin)):16,NodeBin/binary,0:72>>)),
+    [H|_] = string:tokens(ExtPidStr, "."),
+    [_|T] = string:tokens(PidStr, "."),
+    erlang:list_to_pid(string:join([H|T], ".")).
+
+row_to_route(Domain, {ServerHost, NodeS, PidS, LocalHintS} = Row) ->
+    try	[#route{domain = Domain,
+		server_host = ServerHost,
+		pid = dec_pid(PidS, NodeS),
+		local_hint = dec_local_hint(LocalHintS)}]
+    catch _:{node_down, _} ->
+	    [];
+	  E:R ->
+	    ?ERROR_MSG("failed to decode row from 'route' table:~n"
+		       "Row = ~p~n"
+		       "Domain = ~s~n"
+		       "Reason = ~p",
+		       [Row, Domain, {E, {R, erlang:get_stacktrace()}}]),
+	    []
+    end.