mirror of
https://github.com/processone/ejabberd.git
synced 2024-12-26 17:38:45 +01:00
278 lines
8.6 KiB
Erlang
278 lines
8.6 KiB
Erlang
%%%----------------------------------------------------------------------
|
|
%%% File : mod_private.erl
|
|
%%% Author : Alexey Shchepin <alexey@process-one.net>
|
|
%%% Purpose : Support for private storage.
|
|
%%% Created : 16 Jan 2003 by Alexey Shchepin <alexey@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(mod_private).
|
|
|
|
-author('alexey@process-one.net').
|
|
|
|
-protocol({xep, 49, '1.2'}).
|
|
|
|
-behaviour(gen_mod).
|
|
|
|
-export([start/2, stop/1, reload/3, process_sm_iq/1, import_info/0,
|
|
remove_user/2, get_data/2, get_data/3, export/1,
|
|
import/5, import_start/2, mod_opt_type/1, set_data/3, depends/2]).
|
|
|
|
-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()}]) -> 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,
|
|
?NS_PRIVATE, ?MODULE, process_sm_iq, IQDisc).
|
|
|
|
stop(Host) ->
|
|
ejabberd_hooks:delete(remove_user, Host, ?MODULE,
|
|
remove_user, 50),
|
|
gen_iq_handler:remove_iq_handler(ejabberd_sm, Host,
|
|
?NS_PRIVATE).
|
|
|
|
reload(Host, NewOpts, OldOpts) ->
|
|
NewMod = gen_mod:db_mod(Host, NewOpts, ?MODULE),
|
|
OldMod = gen_mod:db_mod(Host, OldOpts, ?MODULE),
|
|
if NewMod /= OldMod ->
|
|
NewMod:init(Host, NewOpts);
|
|
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,
|
|
?MODULE, process_sm_iq, IQDisc);
|
|
true ->
|
|
ok
|
|
end.
|
|
|
|
-spec process_sm_iq(iq()) -> iq().
|
|
process_sm_iq(#iq{type = Type, lang = Lang,
|
|
from = #jid{luser = LUser, lserver = LServer},
|
|
to = #jid{luser = LUser, lserver = LServer},
|
|
sub_els = [#private{xml_els = Els0}]} = IQ) ->
|
|
case filter_xmlels(Els0) of
|
|
[] ->
|
|
Txt = <<"No private data found in this query">>,
|
|
xmpp:make_error(IQ, xmpp:err_bad_request(Txt, Lang));
|
|
Data when Type == set ->
|
|
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 ->
|
|
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">>,
|
|
xmpp:make_error(IQ, xmpp:err_forbidden(Txt, Lang)).
|
|
|
|
-spec filter_xmlels([xmlel()]) -> [{binary(), xmlel()}].
|
|
filter_xmlels(Els) ->
|
|
lists:flatmap(
|
|
fun(#xmlel{} = El) ->
|
|
case fxml:get_tag_attr_s(<<"xmlns">>, El) of
|
|
<<"">> -> [];
|
|
NS -> [{NS, El}]
|
|
end
|
|
end, Els).
|
|
|
|
-spec set_data(binary(), binary(), [{binary(), xmlel()}]) -> ok | {error, _}.
|
|
set_data(LUser, LServer, Data) ->
|
|
Mod = gen_mod:db_mod(LServer, ?MODULE),
|
|
case Mod:set_data(LUser, LServer, Data) of
|
|
ok ->
|
|
delete_cache(Mod, LUser, LServer, Data);
|
|
{error, _} = Err ->
|
|
Err
|
|
end.
|
|
|
|
-spec get_data(binary(), binary(), [{binary(), xmlel()}]) -> [xmlel()] | {error, _}.
|
|
get_data(LUser, LServer, Data) ->
|
|
Mod = gen_mod:db_mod(LServer, ?MODULE),
|
|
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|Els];
|
|
error ->
|
|
[El|Els];
|
|
{error, _} = Err ->
|
|
Err
|
|
end
|
|
end, [], Data).
|
|
|
|
-spec get_data(binary(), binary()) -> [xmlel()] | {error, _}.
|
|
get_data(LUser, LServer) ->
|
|
Mod = gen_mod:db_mod(LServer, ?MODULE),
|
|
case Mod:get_all_data(LUser, LServer) of
|
|
{ok, Els} -> Els;
|
|
error -> [];
|
|
{error, _} = Err -> Err
|
|
end.
|
|
|
|
-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),
|
|
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}].
|
|
|
|
import_start(LServer, DBType) ->
|
|
Mod = gen_mod:db_mod(DBType, ?MODULE),
|
|
Mod:init(LServer, []).
|
|
|
|
export(LServer) ->
|
|
Mod = gen_mod:db_mod(LServer, ?MODULE),
|
|
Mod:export(LServer).
|
|
|
|
import(LServer, {sql, _}, DBType, Tab, L) ->
|
|
Mod = gen_mod:db_mod(DBType, ?MODULE),
|
|
Mod:import(LServer, Tab, L).
|
|
|
|
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(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].
|