mirror of
https://github.com/processone/ejabberd
synced 2025-10-06 03:50:15 +02:00
Implement cache for mod_private
This commit is contained in:
Evgeniy Khramtsov
parent
d88e4d495f
commit
3a96d72a7f
4 changed files with 229 additions and 68 deletions
|
|
@ -37,21 +37,27 @@
|
|||
|
||||
-include("ejabberd.hrl").
|
||||
-include("logger.hrl").
|
||||
|
||||
-include("xmpp.hrl").
|
||||
-include("mod_private.hrl").
|
||||
|
||||
-define(PRIVATE_CACHE, private_cache).
|
||||
|
||||
-callback init(binary(), gen_mod:opts()) -> any().
|
||||
-callback import(binary(), binary(), [binary()]) -> ok.
|
||||
-callback set_data(binary(), binary(), [{binary(), xmlel()}]) -> {atomic, any()}.
|
||||
-callback get_data(binary(), binary(), binary()) -> {ok, xmlel()} | error.
|
||||
-callback get_all_data(binary(), binary()) -> [xmlel()].
|
||||
-callback remove_user(binary(), binary()) -> any().
|
||||
-callback set_data(binary(), binary(), [{binary(), xmlel()}]) -> ok | {error, any()}.
|
||||
-callback get_data(binary(), binary(), binary()) -> {ok, xmlel()} | error | {error, any()}.
|
||||
-callback get_all_data(binary(), binary()) -> {ok, [xmlel()]} | error | {error, any()}.
|
||||
-callback del_data(binary(), binary()) -> ok | {error, any()}.
|
||||
-callback use_cache(binary()) -> boolean().
|
||||
-callback cache_nodes(binary()) -> [node()].
|
||||
|
||||
-optional_callbacks([use_cache/1, cache_nodes/1]).
|
||||
|
||||
start(Host, Opts) ->
|
||||
IQDisc = gen_mod:get_opt(iqdisc, Opts, gen_iq_handler:iqdisc(Host)),
|
||||
Mod = gen_mod:db_mod(Host, Opts, ?MODULE),
|
||||
Mod:init(Host, Opts),
|
||||
init_cache(Mod, Host, Opts),
|
||||
ejabberd_hooks:add(remove_user, Host, ?MODULE,
|
||||
remove_user, 50),
|
||||
gen_iq_handler:add_iq_handler(ejabberd_sm, Host,
|
||||
|
|
@ -71,6 +77,7 @@ reload(Host, NewOpts, OldOpts) ->
|
|||
true ->
|
||||
ok
|
||||
end,
|
||||
init_cache(NewMod, Host, NewOpts),
|
||||
case gen_mod:is_equal_opt(iqdisc, NewOpts, OldOpts, gen_iq_handler:iqdisc(Host)) of
|
||||
{false, IQDisc, _} ->
|
||||
gen_iq_handler:add_iq_handler(ejabberd_sm, Host, ?NS_PRIVATE,
|
||||
|
|
@ -89,11 +96,23 @@ process_sm_iq(#iq{type = Type, lang = Lang,
|
|||
Txt = <<"No private data found in this query">>,
|
||||
xmpp:make_error(IQ, xmpp:err_bad_request(Txt, Lang));
|
||||
Data when Type == set ->
|
||||
set_data(LUser, LServer, Data),
|
||||
xmpp:make_iq_result(IQ);
|
||||
case set_data(LUser, LServer, Data) of
|
||||
ok ->
|
||||
xmpp:make_iq_result(IQ);
|
||||
{error, _} ->
|
||||
Txt = <<"Database failure">>,
|
||||
Err = xmpp:err_internal_server_error(Txt, Lang),
|
||||
xmpp:make_error(IQ, Err)
|
||||
end;
|
||||
Data when Type == get ->
|
||||
StorageEls = get_data(LUser, LServer, Data),
|
||||
xmpp:make_iq_result(IQ, #private{xml_els = StorageEls})
|
||||
case get_data(LUser, LServer, Data) of
|
||||
{error, _} ->
|
||||
Txt = <<"Database failure">>,
|
||||
Err = xmpp:err_internal_server_error(Txt, Lang),
|
||||
xmpp:make_error(IQ, Err);
|
||||
Els ->
|
||||
xmpp:make_iq_result(IQ, #private{xml_els = Els})
|
||||
end
|
||||
end;
|
||||
process_sm_iq(#iq{lang = Lang} = IQ) ->
|
||||
Txt = <<"Query to another users is forbidden">>,
|
||||
|
|
@ -109,35 +128,124 @@ filter_xmlels(Els) ->
|
|||
end
|
||||
end, Els).
|
||||
|
||||
-spec set_data(binary(), binary(), [{binary(), xmlel()}]) -> {atomic, any()}.
|
||||
-spec set_data(binary(), binary(), [{binary(), xmlel()}]) -> ok | {error, _}.
|
||||
set_data(LUser, LServer, Data) ->
|
||||
Mod = gen_mod:db_mod(LServer, ?MODULE),
|
||||
Mod:set_data(LUser, LServer, Data).
|
||||
case Mod:set_data(LUser, LServer, Data) of
|
||||
ok ->
|
||||
delete_cache(Mod, LServer, LServer, Data);
|
||||
{error, _} = Err ->
|
||||
Err
|
||||
end.
|
||||
|
||||
-spec get_data(binary(), binary(), [{binary(), xmlel()}]) -> [xmlel()].
|
||||
-spec get_data(binary(), binary(), [{binary(), xmlel()}]) -> [xmlel()] | {error, _}.
|
||||
get_data(LUser, LServer, Data) ->
|
||||
Mod = gen_mod:db_mod(LServer, ?MODULE),
|
||||
lists:map(
|
||||
fun({NS, El}) ->
|
||||
case Mod:get_data(LUser, LServer, NS) of
|
||||
lists:foldr(
|
||||
fun(_, {error, _} = Err) ->
|
||||
Err;
|
||||
({NS, El}, Els) ->
|
||||
Res = case use_cache(Mod, LServer) of
|
||||
true ->
|
||||
ets_cache:lookup(
|
||||
?PRIVATE_CACHE, {LUser, LServer, NS},
|
||||
fun() -> Mod:get_data(LUser, LServer, NS) end);
|
||||
false ->
|
||||
Mod:get_data(LUser, LServer, NS)
|
||||
end,
|
||||
case Res of
|
||||
{ok, StorageEl} ->
|
||||
StorageEl;
|
||||
[StorageEl|Els];
|
||||
error ->
|
||||
El
|
||||
[El|Els];
|
||||
{error, _} = Err ->
|
||||
Err
|
||||
end
|
||||
end, Data).
|
||||
end, [], Data).
|
||||
|
||||
-spec get_data(binary(), binary()) -> [xmlel()].
|
||||
-spec get_data(binary(), binary()) -> [xmlel()] | {error, _}.
|
||||
get_data(LUser, LServer) ->
|
||||
Mod = gen_mod:db_mod(LServer, ?MODULE),
|
||||
Mod:get_all_data(LUser, LServer).
|
||||
case Mod:get_all_data(LUser, LServer) of
|
||||
{ok, Els} -> Els;
|
||||
error -> [];
|
||||
{error, _} = Err -> Err
|
||||
end.
|
||||
|
||||
-spec remove_user(binary(), binary()) -> any().
|
||||
-spec remove_user(binary(), binary()) -> ok.
|
||||
remove_user(User, Server) ->
|
||||
LUser = jid:nodeprep(User),
|
||||
LServer = jid:nameprep(Server),
|
||||
Mod = gen_mod:db_mod(Server, ?MODULE),
|
||||
Mod:remove_user(LUser, LServer).
|
||||
Data = case use_cache(Mod, LServer) of
|
||||
true ->
|
||||
case Mod:get_all_data(LUser, LServer) of
|
||||
{ok, Els} -> filter_xmlels(Els);
|
||||
_ -> []
|
||||
end;
|
||||
false ->
|
||||
[]
|
||||
end,
|
||||
Mod:del_data(LUser, LServer),
|
||||
delete_cache(Mod, LUser, LServer, Data).
|
||||
|
||||
-spec delete_cache(module(), binary(), binary(), [{binary(), xmlel()}]) -> ok.
|
||||
delete_cache(Mod, LUser, LServer, Data) ->
|
||||
case use_cache(Mod, LServer) of
|
||||
true ->
|
||||
Nodes = cache_nodes(Mod, LServer),
|
||||
lists:foreach(
|
||||
fun({NS, _}) ->
|
||||
ets_cache:delete(?PRIVATE_CACHE,
|
||||
{LUser, LServer, NS},
|
||||
Nodes)
|
||||
end, Data);
|
||||
false ->
|
||||
ok
|
||||
end.
|
||||
|
||||
-spec init_cache(module(), binary(), gen_mod:opts()) -> ok.
|
||||
init_cache(Mod, Host, Opts) ->
|
||||
case use_cache(Mod, Host) of
|
||||
true ->
|
||||
CacheOpts = cache_opts(Host, Opts),
|
||||
ets_cache:new(?PRIVATE_CACHE, CacheOpts);
|
||||
false ->
|
||||
ets_cache:delete(?PRIVATE_CACHE)
|
||||
end.
|
||||
|
||||
-spec cache_opts(binary(), gen_mod:opts()) -> [proplists:property()].
|
||||
cache_opts(Host, Opts) ->
|
||||
MaxSize = gen_mod:get_opt(
|
||||
cache_size, Opts,
|
||||
ejabberd_config:cache_size(Host)),
|
||||
CacheMissed = gen_mod:get_opt(
|
||||
cache_missed, Opts,
|
||||
ejabberd_config:cache_missed(Host)),
|
||||
LifeTime = case gen_mod:get_opt(
|
||||
cache_life_time, Opts,
|
||||
ejabberd_config:cache_life_time(Host)) of
|
||||
infinity -> infinity;
|
||||
I -> timer:seconds(I)
|
||||
end,
|
||||
[{max_size, MaxSize}, {cache_missed, CacheMissed}, {life_time, LifeTime}].
|
||||
|
||||
-spec use_cache(module(), binary()) -> boolean().
|
||||
use_cache(Mod, Host) ->
|
||||
case erlang:function_exported(Mod, use_cache, 1) of
|
||||
true -> Mod:use_cache(Host);
|
||||
false ->
|
||||
gen_mod:get_module_opt(
|
||||
Host, ?MODULE, use_cache,
|
||||
ejabberd_config:use_cache(Host))
|
||||
end.
|
||||
|
||||
-spec cache_nodes(module(), binary()) -> [node()].
|
||||
cache_nodes(Mod, Host) ->
|
||||
case erlang:function_exported(Mod, cache_nodes, 1) of
|
||||
true -> Mod:cache_nodes(Host);
|
||||
false -> ejabberd_cluster:get_nodes()
|
||||
end.
|
||||
|
||||
import_info() ->
|
||||
[{<<"private_storage">>, 4}].
|
||||
|
|
@ -159,4 +267,11 @@ depends(_Host, _Opts) ->
|
|||
|
||||
mod_opt_type(db_type) -> fun(T) -> ejabberd_config:v_db(?MODULE, T) end;
|
||||
mod_opt_type(iqdisc) -> fun gen_iq_handler:check_type/1;
|
||||
mod_opt_type(_) -> [db_type, iqdisc].
|
||||
mod_opt_type(O) when O == cache_life_time; O == cache_size ->
|
||||
fun (I) when is_integer(I), I > 0 -> I;
|
||||
(infinity) -> infinity
|
||||
end;
|
||||
mod_opt_type(O) when O == use_cache; O == cache_missed ->
|
||||
fun (B) when is_boolean(B) -> B end;
|
||||
mod_opt_type(_) ->
|
||||
[db_type, iqdisc, cache_life_time, cache_size, use_cache, cache_missed].
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue