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

Refactored hook handlers in mod_shared_roster_ldap #3874

Merged
merged 1 commit into from
Nov 25, 2022
Merged

Refactored hook handlers in mod_shared_roster_ldap #3874

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
120 changes: 64 additions & 56 deletions src/mod_shared_roster_ldap.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@
-export([init/1, handle_call/3, handle_cast/2,
handle_info/2, terminate/2, code_change/3]).

-export([get_user_roster/2, get_subscription_lists/2,
get_jid_info/4, process_item/2, in_subscription/5,
out_subscription/4]).
%% Hook handlers
-export([get_user_roster/3, get_subscription_lists/3,
get_jid_info/3, process_item/3, in_subscription/3,
out_subscription/3]).

-ignore_xref([config_change/4, get_jid_info/4, get_subscription_lists/2, get_user_roster/2,
in_subscription/5, out_subscription/4, process_item/2, start_link/2]).
-ignore_xref([start_link/2]).

-include("jlib.hrl").
-include("mod_roster.hrl").
Expand Down Expand Up @@ -149,7 +149,11 @@ process_ldap_options(Opts = #{groupattr := GroupAttr}) ->
%%--------------------------------------------------------------------
%% Hooks
%%--------------------------------------------------------------------
get_user_roster(Acc, #jid{luser = U, lserver = S} = JID) ->
-spec get_user_roster(Acc, Params, Extra) -> {ok, Acc} when
Acc :: mongoose_acc:t(),
Params :: #{jid := jid:jid()},
Extra :: gen_hook:extra().
get_user_roster(Acc, #{jid := #jid{luser = U, lserver = S} = JID}, _) ->
US = jid:to_lus(JID),
Items = mongoose_acc:get(roster, items, [], Acc),
SRUsers = get_user_to_groups_map(US, true),
Expand All @@ -172,26 +176,35 @@ get_user_roster(Acc, #jid{luser = U, lserver = S} = JID) ->
name = get_user_name(U1, S1), subscription = both,
ask = none, groups = GroupNames}
|| {{U1, S1}, GroupNames} <- dict:to_list(SRUsersRest)],
mongoose_acc:set(roster, items, SRItems ++ NewItems1, Acc).
{ok, mongoose_acc:set(roster, items, SRItems ++ NewItems1, Acc)}.

%% This function in use to rewrite the roster entries when moving or renaming
%% them in the user contact list.
process_item(RosterItem, _Host) ->
-spec process_item(Acc, Params, Extra) -> {ok, Acc} when
Acc :: mod_roster:roster(),
Params :: map(),
Extra :: gen_hook:extra().
process_item(RosterItem, _, _) ->
USFrom = RosterItem#roster.us,
{User, Server, _Resource} = RosterItem#roster.jid,
USTo = {User, Server},
Map = get_user_to_groups_map(USFrom, false),
case dict:find(USTo, Map) of
NewRosterItem = case dict:find(USTo, Map) of
error -> RosterItem;
{ok, []} -> RosterItem;
{ok, GroupNames}
when RosterItem#roster.subscription == remove ->
RosterItem#roster{subscription = both, ask = none,
groups = GroupNames};
_ -> RosterItem#roster{subscription = both, ask = none}
end.

get_subscription_lists(Acc, #jid{lserver = LServer} = JID) ->
end,
{ok, NewRosterItem}.

-spec get_subscription_lists(Acc, Params, Extra) -> {ok, Acc} when
Acc ::mongoose_acc:t(),
Params :: #{jid := jid:jid()},
Extra :: gen_hook:extra().
get_subscription_lists(Acc, #{jid := #jid{lserver = LServer} = JID}, _) ->
{F, T, P} = mongoose_acc:get(roster, subscription_lists, {[], [], []}, Acc),
US = jid:to_lus(JID),
DisplayedGroups = get_user_displayed_groups(US),
Expand All @@ -201,49 +214,55 @@ get_subscription_lists(Acc, #jid{lserver = LServer} = JID) ->
DisplayedGroups)),
SRJIDs = [{U1, S1, <<>>} || {U1, S1} <- SRUsers],
NewLists = {lists:usort(SRJIDs ++ F), lists:usort(SRJIDs ++ T), P},
mongoose_acc:set(roster, subscription_lists, NewLists, Acc).
{ok, mongoose_acc:set(roster, subscription_lists, NewLists, Acc)}.

get_jid_info({Subscription, Groups}, _HostType, ToJID, JID) ->
-spec get_jid_info(Acc, Params, Extra) -> {ok, Acc} when
Acc :: {mod_roster:subscription_state(), [binary()]},
Params :: #{to_jid := jid:jid(), remote_jid := jid:jid() | jid:simple_jid()},
Extra :: gen_hook:extra().
get_jid_info({Subscription, Groups}, #{to_jid := ToJID, remote_jid := JID}, _) ->
ToUS = jid:to_lus(ToJID),
US1 = jid:to_lus(JID),
SRUsers = get_user_to_groups_map(ToUS, false),
case dict:find(US1, SRUsers) of
NewAcc = case dict:find(US1, SRUsers) of
{ok, GroupNames} ->
NewGroups = case Groups of
[] -> GroupNames;
_ -> Groups
end,
{both, NewGroups};
error -> {Subscription, Groups}
end.

-spec in_subscription(Acc :: mongoose_acc:t(),
ToJID :: jid:jid(),
FromJID :: jid:jid(),
Type :: mod_roster:sub_presence(),
_Reason :: any()) ->
mongoose_acc:t() | {stop, mongoose_acc:t()}.
in_subscription(Acc, ToJID, FromJID, Type, _Reason) ->
end,
{ok, NewAcc}.

-spec in_subscription(Acc, Params, Extra) -> {ok | stop, Acc} when
Acc :: mongoose_acc:t(),
Params :: #{to_jid := jid:jid(),
from_jid := jid:jid(),
type := mod_roster:sub_presence()},
Extra :: gen_hook:extra().
in_subscription(Acc, #{to_jid := ToJID, from_jid := FromJID, type := Type}, _) ->
case process_subscription(in, ToJID, FromJID, Type) of
stop ->
{stop, Acc};
{stop, false} ->
{stop, mongoose_acc:set(hook, result, false, Acc)};
_ -> Acc
_ -> {ok, Acc}
end.

-spec out_subscription(Acc :: mongoose_acc:t(),
FromJID :: jid:jid(),
ToJID :: jid:jid(),
Type :: mod_roster:sub_presence()) ->
mongoose_acc:t() | {stop, mongoose_acc:t()}.
out_subscription(Acc, FromJID, ToJID, Type) ->
-spec out_subscription(Acc, Params, Extra) -> {ok | stop, Acc} when
Acc :: mongoose_acc:t(),
Params :: #{to_jid := jid:jid(),
from_jid := jid:jid(),
type := mod_roster:sub_presence()},
Extra :: gen_hook:extra().
out_subscription(Acc, #{to_jid := ToJID, from_jid := FromJID, type := Type}, _) ->
case process_subscription(out, FromJID, ToJID, Type) of
stop ->
{stop, Acc};
{stop, false} ->
{stop, Acc};
false -> Acc
false -> {ok, Acc}
end.

process_subscription(Direction, #jid{luser = LUser, lserver = LServer}, ToJID, _Type) ->
Expand Down Expand Up @@ -278,18 +297,7 @@ init([Host, Opts]) ->
cache_tab:new(shared_roster_ldap_group,
[{max_size, State#state.group_cache_size}, {lru, false},
{life_time, State#state.group_cache_validity}]),
ejabberd_hooks:add(roster_get, Host, ?MODULE,
get_user_roster, 70),
ejabberd_hooks:add(roster_in_subscription, Host, ?MODULE,
in_subscription, 30),
ejabberd_hooks:add(roster_out_subscription, Host, ?MODULE,
out_subscription, 30),
ejabberd_hooks:add(roster_get_subscription_lists, Host, ?MODULE,
get_subscription_lists, 70),
ejabberd_hooks:add(roster_get_jid_info, Host, ?MODULE,
get_jid_info, 70),
ejabberd_hooks:add(roster_process_item, Host, ?MODULE,
process_item, 50),
gen_hook:add_handlers(hooks(Host)),
{ok, State}.

handle_call(get_state, _From, State) ->
Expand All @@ -303,21 +311,21 @@ handle_info(_Info, State) -> {noreply, State}.

terminate(_Reason, State) ->
Host = State#state.host,
ejabberd_hooks:delete(roster_get, Host, ?MODULE,
get_user_roster, 70),
ejabberd_hooks:delete(roster_in_subscription, Host,
?MODULE, in_subscription, 30),
ejabberd_hooks:delete(roster_out_subscription, Host,
?MODULE, out_subscription, 30),
ejabberd_hooks:delete(roster_get_subscription_lists,
Host, ?MODULE, get_subscription_lists, 70),
ejabberd_hooks:delete(roster_get_jid_info, Host,
?MODULE, get_jid_info, 70),
ejabberd_hooks:delete(roster_process_item, Host,
?MODULE, process_item, 50).
gen_hook:delete_handlers(hooks(Host)).

code_change(_OldVsn, State, _Extra) -> {ok, State}.

-spec hooks(mongooseim:host_type()) -> gen_hook:hook_list().
hooks(HostType) ->
[
{roster_get, HostType, fun ?MODULE:get_user_roster/3, #{}, 70},
{roster_in_subscription, HostType, fun ?MODULE:in_subscription/3, #{}, 70},
{roster_out_subscription, HostType, fun ?MODULE:out_subscription/3, #{}, 70},
{roster_get_subscription_lists, HostType, fun ?MODULE:get_subscription_lists/3, #{}, 70},
{roster_get_jid_info, HostType, fun ?MODULE:get_jid_info/3, #{}, 70},
{roster_process_item, HostType, fun ?MODULE:process_item/3, #{}, 70}
].

%%--------------------------------------------------------------------
%%% Internal functions
%%--------------------------------------------------------------------
Expand Down
12 changes: 10 additions & 2 deletions src/mongoose_hooks.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -904,8 +904,13 @@ roster_get_jid_info(HostType, ToJID, RemBareJID) ->
JID :: jid:jid(),
Result :: mongoose_acc:t().
roster_get_subscription_lists(HostType, Acc, JID) ->
BareJID = jid:to_bare(JID),
Params = #{jid => BareJID},
Args = [BareJID],
ParamsWithLegacyArgs = ejabberd_hooks:add_args(Params, Args),
HostType = mongoose_acc:host_type(Acc),
run_hook_for_host_type(roster_get_subscription_lists, HostType, Acc,
[jid:to_bare(JID)]).
ParamsWithLegacyArgs).

%%% @doc The `roster_get_versioning_feature' hook is
%%% called to determine if roster versioning is enabled.
Expand Down Expand Up @@ -952,7 +957,10 @@ roster_out_subscription(Acc, From, To, Type) ->
Item :: mod_roster:roster(),
Result :: mod_roster:roster().
roster_process_item(HostType, LServer, Item) ->
run_hook_for_host_type(roster_process_item, HostType, Item, [LServer]).
Params = #{lserver => LServer},
Args = [LServer],
ParamsWithLegacyArgs = ejabberd_hooks:add_args(Params, Args),
run_hook_for_host_type(roster_process_item, HostType, Item, ParamsWithLegacyArgs).

%%% @doc The `roster_push' hook is called when a roster item is
%%% being pushed and roster versioning is not enabled.
Expand Down