Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Convert mod_vcard to gen_hook #3833

Merged
merged 2 commits into from
Nov 2, 2022
Merged

Convert mod_vcard to gen_hook #3833

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff5d269
Convert mod_vcard to gen_hook
Oct 28, 2022
5d4df61
Apply review comments
Nov 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/mongoose_hooks.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -413,8 +413,10 @@ session_cleanup(Server, Acc, User, Resource, SID) ->
VCard :: exml:element(),
Result :: ok | {error, any()}.
set_vcard(HostType, UserJID, VCard) ->
run_hook_for_host_type(set_vcard, HostType, {error, no_handler_defined},
[HostType, UserJID, VCard]).
Params = #{user => UserJID, vcard => VCard},
Args = [HostType, UserJID, VCard],
ParamsWithLegacyArgs = ejabberd_hooks:add_args(Params, Args),
run_hook_for_host_type(set_vcard, HostType, {error, no_handler_defined}, ParamsWithLegacyArgs).

-spec unacknowledged_message(Acc, JID) -> Result when
Acc :: mongoose_acc:t(),
Expand Down
96 changes: 49 additions & 47 deletions src/vcard/mod_vcard.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@
process_sm_iq/5,
remove_user/3,
remove_domain/3,
set_vcard/4]).
set_vcard/3]).

-export([start_link/2]).
-export([default_search_fields/0]).
Expand All @@ -85,22 +85,23 @@

-ignore_xref([
process_packet/5,
get_personal_data/3, remove_user/3, remove_domain/3, set_vcard/4, start_link/2
start_link/2
]).

-define(PROCNAME, ejabberd_mod_vcard).

-record(state, {search :: boolean(),
host_type :: mongooseim:host_type()}).

-type error() :: error | {error, any()}.

%%--------------------------------------------------------------------
%% gdpr callback
%%--------------------------------------------------------------------

-spec get_personal_data(gdpr:personal_data(), mongooseim:host_type(), jid:jid()) -> gdpr:personal_data().
get_personal_data(Acc, HostType, #jid{luser = LUser, lserver = LServer}) ->
-spec get_personal_data(Acc, Params, Extra) -> {ok, Acc} when
Acc :: gdpr:personal_data(),
Params :: map(),
Extra :: map().
get_personal_data(Acc, #{jid := #jid{luser = LUser, lserver = LServer}}, #{host_type := HostType}) ->
Jid = jid:to_binary({LUser, LServer}),
Schema = ["jid", "vcard"],
Entries = case mod_vcard_backend:get_vcard(HostType, LUser, LServer) of
Expand All @@ -109,7 +110,7 @@ get_personal_data(Acc, HostType, #jid{luser = LUser, lserver = LServer}) ->
[{Jid, SerializedRecords}];
_ -> []
end,
[{vcard, Schema, Entries} | Acc].
{ok, [{vcard, Schema, Entries} | Acc]}.

-spec default_search_fields() -> list().
default_search_fields() ->
Expand Down Expand Up @@ -161,21 +162,18 @@ stop(HostType) ->
supported_features() -> [dynamic_domains].

start_hooks(HostType) ->
ejabberd_hooks:add(hooks(HostType)).
gen_hook:add_handlers(hooks(HostType)).

stop_hooks(HostType) ->
ejabberd_hooks:delete(hooks(HostType)).
gen_hook:delete_handlers(hooks(HostType)).

-spec hooks(mongooseim:host_type()) -> gen_hook:hook_list().
hooks(HostType) ->
[{Hook, HostType, ?MODULE, Function, Priority}
|| {Hook, Function, Priority} <- hooks2()].

hooks2() ->
[{remove_user, remove_user, 50},
{anonymous_purge_hook, remove_user, 50},
{remove_domain, remove_domain, 50},
{set_vcard, set_vcard, 50},
{get_personal_data, get_personal_data, 50}].
[{remove_user, HostType, fun ?MODULE:remove_user/3, #{}, 50},
{anonymous_purge_hook, HostType, fun ?MODULE:remove_user/3, #{}, 50},
{remove_domain, HostType, fun ?MODULE:remove_domain/3, #{}, 50},
{set_vcard, HostType, fun ?MODULE:set_vcard/3, #{}, 50},
{get_personal_data, HostType, fun ?MODULE:get_personal_data/3, #{}, 50}].

start_iq_handlers(HostType, #{iqdisc := IQDisc}) ->
gen_iq_handler:add_iq_handler_for_domain(HostType, ?NS_VCARD, ejabberd_sm,
Expand Down Expand Up @@ -458,42 +456,46 @@ unsafe_set_vcard(HostType, From, VCARD) ->
end.


-spec set_vcard(HandlerAcc, HostType, From, VCARD) -> Result when
HandlerAcc :: ok | error(),
HostType :: mongooseim:host_type(),
From ::jid:jid(),
VCARD :: exml:element(),
Result :: ok | error().
set_vcard(ok, _HostType, _From, _VCARD) ->
-spec set_vcard(Acc, Params, Extra) -> {ok, Acc} when
Acc :: ok | {error, term()},
Params :: map(),
Extra :: map().
set_vcard(ok, _Params, _Extra) ->
?LOG_DEBUG(#{what => hook_call_already_handled}),
ok;
set_vcard({error, no_handler_defined}, HostType, From, VCARD) ->
try unsafe_set_vcard(HostType, From, VCARD) of
ok -> ok;
{error, Reason} ->
?LOG_ERROR(#{what => unsafe_set_vcard_failed, reason => Reason}),
{error, Reason}
catch
E:R:S -> ?LOG_ERROR(#{what => unsafe_set_vcard_failed, class => E,
reason => R, stacktrace => S}),
{error, {E, R}}
end;
set_vcard({error, _} = E, _HostType, _From, _VCARD) -> E.

-spec remove_domain(mongoose_hooks:simple_acc(),
mongooseim:host_type(), jid:lserver()) ->
mongoose_hooks:simple_acc().
remove_domain(Acc, HostType, Domain) ->
{ok, ok};
set_vcard({error, no_handler_defined}, #{user := From, vcard := VCARD}, #{host_type := HostType}) ->
Result = try unsafe_set_vcard(HostType, From, VCARD) of
ok -> ok;
{error, Reason} ->
?LOG_ERROR(#{what => unsafe_set_vcard_failed, reason => Reason}),
{error, Reason}
catch
E:R:S -> ?LOG_ERROR(#{what => unsafe_set_vcard_failed, class => E,
reason => R, stacktrace => S}),
{error, {E, R}}
end,
{ok, Result};
set_vcard({error, _} = Error, _Params, _Extra) ->
{ok, Error}.

-spec remove_domain(Acc, Params, Extra) -> {ok, Acc} when
Acc :: mongoose_domain_api:remove_domain_acc(),
Params :: map(),
Extra :: map().
remove_domain(Acc, #{domain := Domain}, #{host_type := HostType}) ->
mod_vcard_backend:remove_domain(HostType, Domain),
Acc.
{ok, Acc}.

%% #rh
remove_user(Acc, User, Server) ->
-spec remove_user(Acc, Params, Extra) -> {ok, Acc} when
Acc :: mongoose_acc:t(),
Params :: map(),
Extra :: map().
remove_user(Acc, #{jid := #jid{luser = User, lserver = Server}}, #{host_type := HostType}) ->
HostType = mongoose_acc:host_type(Acc),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can remove this line since HostType is already bound in function's head.

LUser = jid:nodeprep(User),
LServer = jid:nodeprep(Server),
mod_vcard_backend:remove_user(HostType, LUser, LServer),
Acc.
{ok, Acc}.

%% ------------------------------------------------------------------
%% Internal
Expand Down