4575889384

Build Type

push

github

Committed by Denys Gonchar

Commit Message

Do not redefine id-on-xmppAddr if already present

Run Details

28363 of 34052 relevant lines covered (83.29%)

38613.72 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

79.63

/src/pubsub/node_pep.erl

%%% ====================================================================
%%% ``The contents of this file are subject to the Erlang Public License,
%%% Version 1.1, (the "License"); you may not use this file except in
%%% compliance with the License. You should have received a copy of the
%%% Erlang Public License along with this software. If not, it can be
%%% retrieved via the world wide web at http://www.erlang.org/.
%%%
%%%
%%% Software distributed under the License is distributed on an "AS IS"
%%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
%%% the License for the specific language governing rights and limitations
%%% under the License.
%%%
%%%
%%% The Initial Developer of the Original Code is ProcessOne.
%%% Portions created by ProcessOne are Copyright 2006-2015, ProcessOne
%%% All Rights Reserved.''
%%% This software is copyright 2006-2015, ProcessOne.
%%%
%%% @copyright 2006-2015 ProcessOne
%%% @author Christophe Romain <christophe.romain@process-one.net>
%%%   [http://www.process-one.net/]
%%% @end
%%% ====================================================================

-module(node_pep).
-behaviour(gen_pubsub_node).
-author('christophe.romain@process-one.net').

-include("mongoose.hrl").
-include("pubsub.hrl").
-include("jlib.hrl").

%%% @doc The module <strong>{@module}</strong> is the pep PubSub plugin.
%%% <p>PubSub plugin nodes are using the {@link gen_pubsub_node} behaviour.</p>

-export([based_on/0, init/3, terminate/2, options/0, features/0,
         create_node_permission/6, delete_node/1,
         unsubscribe_node/4, node_to_path/1,
         get_entity_affiliations/2, get_entity_affiliations/3,
         get_entity_subscriptions/2, get_entity_subscriptions/4,
         should_delete_when_owner_removed/0
         ]).

-ignore_xref([get_entity_affiliations/3, get_entity_subscriptions/4]).

based_on() ->  node_flat.

init(Host, ServerHost, Opts) ->
    node_flat:init(Host, ServerHost, Opts),
    complain_if_modcaps_disabled(ServerHost),
    ok.

terminate(Host, ServerHost) ->
    node_flat:terminate(Host, ServerHost),
    ok.

options() ->
    [{deliver_payloads, true},
        {notify_config, false},
        {notify_delete, false},
        {notify_retract, false},
        {purge_offline, false},
        {persist_items, true},
        {max_items, 1},
        {subscribe, true},
        {access_model, presence},
        {roster_groups_allowed, []},
        {publish_model, publishers},
        {notification_type, headline},
        {max_payload_size, ?MAX_PAYLOAD_SIZE},
        {send_last_published_item, on_sub_and_presence},
        {deliver_notifications, true},
        {presence_based_delivery, true}].

features() ->
    [<<"create-nodes">>,
        <<"auto-create">>,
        <<"auto-subscribe">>,
        <<"delete-nodes">>,
        <<"delete-items">>,
        <<"filtered-notifications">>,
        <<"modify-affiliations">>,
        <<"outcast-affiliation">>,
        <<"persistent-items">>,
        <<"publish">>,
        <<"publish-options">>,
        <<"purge-nodes">>,
        <<"retract-items">>,
        <<"retrieve-affiliations">>,
        <<"retrieve-items">>,
        <<"retrieve-subscriptions">>,
        <<"subscribe">>].

create_node_permission(Host, _ServerHost, _Node, _ParentNode,
                       #jid{ luser = <<>>, lserver = Host, lresource = <<>> }, _Access) ->
    {result, true}; % pubsub service always allowed
create_node_permission(Host, ServerHost, _Node, _ParentNode,
                       #jid{ luser = User, lserver = Server } = Owner, Access) ->
    {ok, HostType} = mongoose_domain_api:get_domain_host_type(ServerHost),
    case acl:match_rule(HostType, ServerHost, Access, Owner) of
        allow ->
            case Host of
                {User, Server, _} -> {result, true};
                _ -> {result, false}
            end;
        _ ->
            {result, false}
    end.

delete_node(Nodes) ->
    {result, {_, _, Result}} = node_flat:delete_node(Nodes),
    {result, {[], Result}}.

unsubscribe_node(Nidx, Sender, Subscriber, SubId) ->
    case node_flat:unsubscribe_node(Nidx, Sender, Subscriber, SubId) of
        {error, Error} -> {error, Error};
        {result, _} -> {result, []}
    end.

get_entity_affiliations(Host, #jid{ lserver = D } = Owner) ->
    get_entity_affiliations(Host, D, jid:to_lower(Owner));
get_entity_affiliations(Host, {_, D, _} = Owner) ->
    get_entity_affiliations(Host, D, Owner).

get_entity_affiliations(Host, D, Owner) ->
    {ok, States} = mod_pubsub_db_backend:get_states_by_bare(Owner),
    HT = mod_pubsub:host_to_host_type(Host),
    NodeTree = mod_pubsub:tree(HT),
    Reply = lists:foldl(fun (#pubsub_state{stateid = {_, N}, affiliation = A}, Acc) ->
                    case gen_pubsub_nodetree:get_node(NodeTree, N) of
                        #pubsub_node{nodeid = {{_, D, _}, _}} = Node -> [{Node, A} | Acc];
                        _ -> Acc
                    end
            end,
            [], States),
    {result, Reply}.

get_entity_subscriptions(Host, #jid{ lserver = D, lresource = R } = Owner) ->
    get_entity_subscriptions(Host, D, R, Owner);
get_entity_subscriptions(Host, {_, D, R} = Owner) ->
    get_entity_subscriptions(Host, D, R, Owner).

get_entity_subscriptions(Host, D, R, Owner) ->
    LOwner = jid:to_lower(Owner),
    States = case R of
                 <<>> ->
                     {ok, States0} = mod_pubsub_db_backend:get_states_by_lus(LOwner),
                     States0;
                 _ ->
                     {ok, States0} = mod_pubsub_db_backend:get_states_by_bare_and_full(LOwner),
                     States0
             end,
    HT = mod_pubsub:host_to_host_type(Host),
    NodeTree = mod_pubsub:tree(HT),
    Reply = lists:foldl(fun (#pubsub_state{stateid = {J, N}, subscriptions = Ss}, Acc) ->
                    case gen_pubsub_nodetree:get_node(NodeTree, N) of
                        #pubsub_node{nodeid = {{_, D, _}, _}} = Node ->
                            accumulate_entity_subscriptions(J, Node, Ss, Acc);
                        _ ->
                            Acc
                    end
            end,
            [], States),
    {result, Reply}.

accumulate_entity_subscriptions(J, Node, Ss, Acc) ->
    lists:foldl(fun({subscribed, SubId}, Acc2) ->
                        [{Node, subscribed, SubId, J} | Acc2];
                   ({pending, _SubId}, Acc2) ->
                        [{Node, pending, J} | Acc2];
                   (S, Acc2) ->
                        [{Node, S, J} | Acc2]
                end, Acc, Ss).


node_to_path(Node) ->
    node_flat:node_to_path(Node).

should_delete_when_owner_removed() -> true.

%%%
%%% Internal
%%%

%% @doc Check mod_caps is enabled, otherwise show warning.
%% The PEP plugin for mod_pubsub requires mod_caps to be enabled in the host.
%% Check that the mod_caps module is enabled in that Jabber Host
%% If not, log a warning message.
complain_if_modcaps_disabled(ServerHost) ->
    ?WARNING_MSG_IF(
       not gen_mod:is_loaded(ServerHost, mod_caps),
       "The PEP plugin is enabled in mod_pubsub "
       "of host ~p. This plugin requires mod_caps "
       "to be enabled, but it isn't.",
       [ServerHost]).

1	%%% ====================================================================
2	%%% ``The contents of this file are subject to the Erlang Public License,
3	%%% Version 1.1, (the "License"); you may not use this file except in
4	%%% compliance with the License. You should have received a copy of the
5	%%% Erlang Public License along with this software. If not, it can be
6	%%% retrieved via the world wide web at http://www.erlang.org/.
7	%%%
8	%%%
9	%%% Software distributed under the License is distributed on an "AS IS"
10	%%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
11	%%% the License for the specific language governing rights and limitations
12	%%% under the License.
13	%%%
14	%%%
15	%%% The Initial Developer of the Original Code is ProcessOne.
16	%%% Portions created by ProcessOne are Copyright 2006-2015, ProcessOne
17	%%% All Rights Reserved.''
18	%%% This software is copyright 2006-2015, ProcessOne.
19	%%%
20	%%% @copyright 2006-2015 ProcessOne
21	%%% @author Christophe Romain <christophe.romain@process-one.net>
22	%%% [http://www.process-one.net/]
23	%%% @end
24	%%% ====================================================================
25
26	-module(node_pep).
27	-behaviour(gen_pubsub_node).
28	-author('christophe.romain@process-one.net').
29
30	-include("mongoose.hrl").
31	-include("pubsub.hrl").
32	-include("jlib.hrl").
33
34	%%% @doc The module <strong>{@module}</strong> is the pep PubSub plugin.
35	%%% <p>PubSub plugin nodes are using the {@link gen_pubsub_node} behaviour.</p>
36
37	-export([based_on/0, init/3, terminate/2, options/0, features/0,
38	create_node_permission/6, delete_node/1,
39	unsubscribe_node/4, node_to_path/1,
40	get_entity_affiliations/2, get_entity_affiliations/3,
41	get_entity_subscriptions/2, get_entity_subscriptions/4,
42	should_delete_when_owner_removed/0
43	]).
44
45	-ignore_xref([get_entity_affiliations/3, get_entity_subscriptions/4]).
46
47	based_on() -> node_flat.	812✔
48
49	init(Host, ServerHost, Opts) ->
50	node_flat:init(Host, ServerHost, Opts),	23✔
51	complain_if_modcaps_disabled(ServerHost),	23✔
52	ok.	23✔
53
54	terminate(Host, ServerHost) ->
55	node_flat:terminate(Host, ServerHost),	23✔
56	ok.	23✔
57
58	options() ->
59	[{deliver_payloads, true},	99✔
60	{notify_config, false},
61	{notify_delete, false},
62	{notify_retract, false},
63	{purge_offline, false},
64	{persist_items, true},
65	{max_items, 1},
66	{subscribe, true},
67	{access_model, presence},
68	{roster_groups_allowed, []},
69	{publish_model, publishers},
70	{notification_type, headline},
71	{max_payload_size, ?MAX_PAYLOAD_SIZE},
72	{send_last_published_item, on_sub_and_presence},
73	{deliver_notifications, true},
74	{presence_based_delivery, true}].
75
76	features() ->
77	[<<"create-nodes">>,	1,337✔
78	<<"auto-create">>,
79	<<"auto-subscribe">>,
80	<<"delete-nodes">>,
81	<<"delete-items">>,
82	<<"filtered-notifications">>,
83	<<"modify-affiliations">>,
84	<<"outcast-affiliation">>,
85	<<"persistent-items">>,
86	<<"publish">>,
87	<<"publish-options">>,
88	<<"purge-nodes">>,
89	<<"retract-items">>,
90	<<"retrieve-affiliations">>,
91	<<"retrieve-items">>,
92	<<"retrieve-subscriptions">>,
93	<<"subscribe">>].
94
95	create_node_permission(Host, _ServerHost, _Node, _ParentNode,
96	#jid{ luser = <<>>, lserver = Host, lresource = <<>> }, _Access) ->
97	{result, true}; % pubsub service always allowed	×
98	create_node_permission(Host, ServerHost, _Node, _ParentNode,
99	#jid{ luser = User, lserver = Server } = Owner, Access) ->
100	{ok, HostType} = mongoose_domain_api:get_domain_host_type(ServerHost),	99✔
101	case acl:match_rule(HostType, ServerHost, Access, Owner) of	99✔
102	allow ->
103	case Host of	99✔
104	{User, Server, _} -> {result, true};	99✔
105	_ -> {result, false}	×
106	end;
107	_ ->
108	{result, false}	×
109	end.
110
111	delete_node(Nodes) ->
112	{result, {_, _, Result}} = node_flat:delete_node(Nodes),	25✔
113	{result, {[], Result}}.	25✔
114
115	unsubscribe_node(Nidx, Sender, Subscriber, SubId) ->
116	case node_flat:unsubscribe_node(Nidx, Sender, Subscriber, SubId) of	×
117	{error, Error} -> {error, Error};	×
118	{result, _} -> {result, []}	×
119	end.
120
121	get_entity_affiliations(Host, #jid{ lserver = D } = Owner) ->
122	get_entity_affiliations(Host, D, jid:to_lower(Owner));	×
123	get_entity_affiliations(Host, {_, D, _} = Owner) ->
124	get_entity_affiliations(Host, D, Owner).	387✔
125
126	get_entity_affiliations(Host, D, Owner) ->
127	{ok, States} = mod_pubsub_db_backend:get_states_by_bare(Owner),	387✔
128	HT = mod_pubsub:host_to_host_type(Host),	387✔
129	NodeTree = mod_pubsub:tree(HT),	387✔
130	Reply = lists:foldl(fun (#pubsub_state{stateid = {_, N}, affiliation = A}, Acc) ->	387✔
131	case gen_pubsub_nodetree:get_node(NodeTree, N) of	127✔
132	#pubsub_node{nodeid = {{_, D, _}, _}} = Node -> [{Node, A} \| Acc];	56✔
133	_ -> Acc	71✔
134	end
135	end,
136	[], States),
137	{result, Reply}.	387✔
138
139	get_entity_subscriptions(Host, #jid{ lserver = D, lresource = R } = Owner) ->
140	get_entity_subscriptions(Host, D, R, Owner);	430✔
141	get_entity_subscriptions(Host, {_, D, R} = Owner) ->
142	get_entity_subscriptions(Host, D, R, Owner).	×
143
144	get_entity_subscriptions(Host, D, R, Owner) ->
145	LOwner = jid:to_lower(Owner),	430✔
146	States = case R of	430✔
147	<<>> ->
148	{ok, States0} = mod_pubsub_db_backend:get_states_by_lus(LOwner),	43✔
149	States0;	43✔
150	_ ->
151	{ok, States0} = mod_pubsub_db_backend:get_states_by_bare_and_full(LOwner),	387✔
152	States0	387✔
153	end,
154	HT = mod_pubsub:host_to_host_type(Host),	430✔
155	NodeTree = mod_pubsub:tree(HT),	430✔
156	Reply = lists:foldl(fun (#pubsub_state{stateid = {J, N}, subscriptions = Ss}, Acc) ->	430✔
157	case gen_pubsub_nodetree:get_node(NodeTree, N) of	12✔
158	#pubsub_node{nodeid = {{_, D, _}, _}} = Node ->
159	accumulate_entity_subscriptions(J, Node, Ss, Acc);	12✔
160	_ ->
161	Acc	×
162	end
163	end,
164	[], States),
165	{result, Reply}.	430✔
166
167	accumulate_entity_subscriptions(J, Node, Ss, Acc) ->
168	lists:foldl(fun({subscribed, SubId}, Acc2) ->	12✔
169	[{Node, subscribed, SubId, J} \| Acc2];	1✔
170	({pending, _SubId}, Acc2) ->
171	[{Node, pending, J} \| Acc2];	8✔
172	(S, Acc2) ->
173	[{Node, S, J} \| Acc2]	×
174	end, Acc, Ss).
175
176
177	node_to_path(Node) ->
178	node_flat:node_to_path(Node).	99✔
179
180	should_delete_when_owner_removed() -> true.	74✔
181
182	%%%
183	%%% Internal
184	%%%
185
186	%% @doc Check mod_caps is enabled, otherwise show warning.
187	%% The PEP plugin for mod_pubsub requires mod_caps to be enabled in the host.
188	%% Check that the mod_caps module is enabled in that Jabber Host
189	%% If not, log a warning message.
190	complain_if_modcaps_disabled(ServerHost) ->
191	?WARNING_MSG_IF(	23✔
192	not gen_mod:is_loaded(ServerHost, mod_caps),	23✔
193	"The PEP plugin is enabled in mod_pubsub "
194	"of host ~p. This plugin requires mod_caps "
195	"to be enabled, but it isn't.",
196	[ServerHost]).	×

esl / MongooseIM / 4575889384

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous