2007-12-01 06:16:30 +01:00
|
|
|
%%% ====================================================================
|
2007-12-24 14:57:53 +01:00
|
|
|
%%% ``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/.
|
2015-04-08 17:12:05 +02:00
|
|
|
%%%
|
2013-03-14 10:33:02 +01:00
|
|
|
%%%
|
2007-12-24 14:57:53 +01:00
|
|
|
%%% 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.
|
2015-04-08 17:12:05 +02:00
|
|
|
%%%
|
2013-03-14 10:33:02 +01:00
|
|
|
%%%
|
2008-07-31 13:18:49 +02:00
|
|
|
%%% The Initial Developer of the Original Code is ProcessOne.
|
2015-01-08 17:34:43 +01:00
|
|
|
%%% Portions created by ProcessOne are Copyright 2006-2015, ProcessOne
|
2007-12-24 14:57:53 +01:00
|
|
|
%%% All Rights Reserved.''
|
2015-01-08 17:34:43 +01:00
|
|
|
%%% This software is copyright 2006-2015, ProcessOne.
|
2007-12-01 06:16:30 +01:00
|
|
|
%%%
|
2015-01-08 17:34:43 +01:00
|
|
|
%%% @copyright 2006-2015 ProcessOne
|
2007-12-01 06:16:30 +01:00
|
|
|
%%% @author Christophe Romain <christophe.romain@process-one.net>
|
|
|
|
%%% [http://www.process-one.net/]
|
|
|
|
%%% @version {@vsn}, {@date} {@time}
|
|
|
|
%%% @end
|
|
|
|
%%% ====================================================================
|
|
|
|
|
|
|
|
-module(node_pep).
|
2015-04-08 17:12:05 +02:00
|
|
|
-behaviour(gen_pubsub_node).
|
2007-12-01 06:16:30 +01:00
|
|
|
-author('christophe.romain@process-one.net').
|
|
|
|
|
|
|
|
-include("pubsub.hrl").
|
|
|
|
-include("jlib.hrl").
|
2015-04-08 17:12:05 +02:00
|
|
|
-include("logger.hrl").
|
2007-12-01 06:16:30 +01:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
%%% @doc The module <strong>{@module}</strong> is the pep PubSub plugin.
|
|
|
|
%%% <p>PubSub plugin nodes are using the {@link gen_pubsub_node} behaviour.</p>
|
2007-12-01 06:16:30 +01:00
|
|
|
|
2013-03-14 10:33:02 +01:00
|
|
|
-export([init/3, terminate/2, options/0, features/0,
|
2015-04-08 17:12:05 +02:00
|
|
|
create_node_permission/6, create_node/2, delete_node/1,
|
|
|
|
purge_node/2, subscribe_node/8, unsubscribe_node/4,
|
|
|
|
publish_item/6, delete_item/4, remove_extra_items/3,
|
|
|
|
get_entity_affiliations/2, get_node_affiliations/1,
|
|
|
|
get_affiliation/2, set_affiliation/3,
|
|
|
|
get_entity_subscriptions/2, get_node_subscriptions/1,
|
|
|
|
get_subscriptions/2, set_subscriptions/4,
|
|
|
|
get_pending_nodes/2, get_states/1, get_state/2,
|
|
|
|
set_state/1, get_items/7, get_items/3, get_item/7,
|
|
|
|
get_item/2, set_item/1, get_item_name/3, node_to_path/1,
|
|
|
|
path_to_node/1]).
|
2007-12-01 06:16:30 +01:00
|
|
|
|
|
|
|
init(Host, ServerHost, Opts) ->
|
2009-05-29 00:30:43 +02:00
|
|
|
node_hometree:init(Host, ServerHost, Opts),
|
2008-06-29 13:34:30 +02:00
|
|
|
complain_if_modcaps_disabled(ServerHost),
|
2007-12-01 06:16:30 +01:00
|
|
|
ok.
|
|
|
|
|
|
|
|
terminate(Host, ServerHost) ->
|
2013-03-14 10:33:02 +01:00
|
|
|
node_hometree:terminate(Host, ServerHost), ok.
|
2007-12-01 06:16:30 +01:00
|
|
|
|
|
|
|
options() ->
|
2015-04-08 17:12:05 +02:00
|
|
|
[{deliver_payloads, true},
|
|
|
|
{notify_config, false},
|
|
|
|
{notify_delete, false},
|
|
|
|
{notify_retract, false},
|
|
|
|
{purge_offline, false},
|
2015-06-18 12:06:29 +02:00
|
|
|
{persist_items, true},
|
2015-04-08 17:12:05 +02:00
|
|
|
{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}].
|
|
|
|
|
2007-12-01 06:16:30 +01:00
|
|
|
features() ->
|
2015-04-08 17:12:05 +02:00
|
|
|
[<<"create-nodes">>,
|
|
|
|
<<"auto-create">>,
|
|
|
|
<<"auto-subscribe">>,
|
|
|
|
<<"delete-nodes">>,
|
|
|
|
<<"delete-items">>,
|
|
|
|
<<"filtered-notifications">>,
|
|
|
|
<<"modify-affiliations">>,
|
|
|
|
<<"outcast-affiliation">>,
|
|
|
|
<<"persistent-items">>,
|
|
|
|
<<"publish">>,
|
|
|
|
<<"purge-nodes">>,
|
|
|
|
<<"retract-items">>,
|
|
|
|
<<"retrieve-affiliations">>,
|
|
|
|
<<"retrieve-items">>,
|
|
|
|
<<"retrieve-subscriptions">>,
|
|
|
|
<<"subscribe">>].
|
2007-12-01 06:16:30 +01:00
|
|
|
|
2008-07-23 01:41:44 +02:00
|
|
|
create_node_permission(Host, ServerHost, _Node, _ParentNode, Owner, Access) ->
|
|
|
|
LOwner = jlib:jid_tolower(Owner),
|
2009-02-27 04:09:00 +01:00
|
|
|
{User, Server, _Resource} = LOwner,
|
2008-07-23 01:41:44 +02:00
|
|
|
Allowed = case LOwner of
|
2015-04-08 17:12:05 +02:00
|
|
|
{<<"">>, Host, <<"">>} ->
|
|
|
|
true; % pubsub service always allowed
|
|
|
|
_ ->
|
|
|
|
case acl:match_rule(ServerHost, Access, LOwner) of
|
|
|
|
allow ->
|
|
|
|
case Host of
|
|
|
|
{User, Server, _} -> true;
|
|
|
|
_ -> false
|
|
|
|
end;
|
2013-03-14 10:33:02 +01:00
|
|
|
_ ->
|
2015-04-08 17:12:05 +02:00
|
|
|
false
|
|
|
|
end
|
|
|
|
end,
|
2008-07-23 01:41:44 +02:00
|
|
|
{result, Allowed}.
|
2009-02-27 04:09:00 +01:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
create_node(Nidx, Owner) ->
|
|
|
|
node_hometree:create_node(Nidx, Owner).
|
|
|
|
|
|
|
|
delete_node(Nodes) ->
|
|
|
|
{result, {_, _, Result}} = node_hometree:delete_node(Nodes),
|
|
|
|
{result, {[], Result}}.
|
|
|
|
|
|
|
|
subscribe_node(Nidx, Sender, Subscriber, AccessModel,
|
|
|
|
SendLast, PresenceSubscription, RosterGroup, Options) ->
|
|
|
|
node_hometree:subscribe_node(Nidx, Sender, Subscriber, AccessModel, SendLast,
|
|
|
|
PresenceSubscription, RosterGroup, Options).
|
2013-03-14 10:33:02 +01:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
unsubscribe_node(Nidx, Sender, Subscriber, SubId) ->
|
|
|
|
case node_hometree:unsubscribe_node(Nidx, Sender, Subscriber, SubId) of
|
|
|
|
{error, Error} -> {error, Error};
|
|
|
|
{result, _} -> {result, []}
|
2007-12-01 06:16:30 +01:00
|
|
|
end.
|
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
publish_item(Nidx, Publisher, Model, MaxItems, ItemId, Payload) ->
|
|
|
|
node_hometree:publish_item(Nidx, Publisher, Model, MaxItems, ItemId, Payload).
|
|
|
|
|
|
|
|
remove_extra_items(Nidx, MaxItems, ItemIds) ->
|
|
|
|
node_hometree:remove_extra_items(Nidx, MaxItems, ItemIds).
|
|
|
|
|
|
|
|
delete_item(Nidx, Publisher, PublishModel, ItemId) ->
|
|
|
|
node_hometree:delete_item(Nidx, Publisher, PublishModel, ItemId).
|
|
|
|
|
|
|
|
purge_node(Nidx, Owner) ->
|
|
|
|
node_hometree:purge_node(Nidx, Owner).
|
|
|
|
|
|
|
|
get_entity_affiliations(Host, Owner) ->
|
2009-05-26 23:50:13 +02:00
|
|
|
{_, D, _} = SubKey = jlib:jid_tolower(Owner),
|
|
|
|
SubKey = jlib:jid_tolower(Owner),
|
|
|
|
GenKey = jlib:jid_remove_resource(SubKey),
|
2015-04-08 17:12:05 +02:00
|
|
|
States = mnesia:match_object(#pubsub_state{stateid = {GenKey, '_'}, _ = '_'}),
|
|
|
|
NodeTree = mod_pubsub:tree(Host),
|
|
|
|
Reply = lists:foldl(fun (#pubsub_state{stateid = {_, N}, affiliation = A}, Acc) ->
|
|
|
|
case NodeTree:get_node(N) of
|
|
|
|
#pubsub_node{nodeid = {{_, D, _}, _}} = Node -> [{Node, A} | Acc];
|
|
|
|
_ -> Acc
|
|
|
|
end
|
|
|
|
end,
|
|
|
|
[], States),
|
2009-05-26 23:50:13 +02:00
|
|
|
{result, Reply}.
|
2007-12-01 06:16:30 +01:00
|
|
|
|
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
get_node_affiliations(Nidx) ->
|
|
|
|
node_hometree:get_node_affiliations(Nidx).
|
|
|
|
|
|
|
|
get_affiliation(Nidx, Owner) ->
|
|
|
|
node_hometree:get_affiliation(Nidx, Owner).
|
|
|
|
|
|
|
|
set_affiliation(Nidx, Owner, Affiliation) ->
|
|
|
|
node_hometree:set_affiliation(Nidx, Owner, Affiliation).
|
|
|
|
|
|
|
|
get_entity_subscriptions(Host, Owner) ->
|
2009-05-19 23:59:15 +02:00
|
|
|
{U, D, _} = SubKey = jlib:jid_tolower(Owner),
|
|
|
|
GenKey = jlib:jid_remove_resource(SubKey),
|
|
|
|
States = case SubKey of
|
2015-04-08 17:12:05 +02:00
|
|
|
GenKey ->
|
|
|
|
mnesia:match_object(#pubsub_state{stateid = {{U, D, '_'}, '_'}, _ = '_'});
|
|
|
|
_ ->
|
|
|
|
mnesia:match_object(#pubsub_state{stateid = {GenKey, '_'}, _ = '_'})
|
|
|
|
++
|
|
|
|
mnesia:match_object(#pubsub_state{stateid = {SubKey, '_'}, _ = '_'})
|
|
|
|
end,
|
|
|
|
NodeTree = mod_pubsub:tree(Host),
|
|
|
|
Reply = lists:foldl(fun (#pubsub_state{stateid = {J, N}, subscriptions = Ss}, Acc) ->
|
|
|
|
case NodeTree:get_node(N) of
|
|
|
|
#pubsub_node{nodeid = {{_, D, _}, _}} = Node ->
|
|
|
|
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);
|
|
|
|
_ ->
|
|
|
|
Acc
|
|
|
|
end
|
|
|
|
end,
|
|
|
|
[], States),
|
2009-05-19 23:59:15 +02:00
|
|
|
{result, Reply}.
|
2007-12-01 06:16:30 +01:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
get_node_subscriptions(Nidx) ->
|
|
|
|
node_hometree:get_node_subscriptions(Nidx).
|
|
|
|
|
|
|
|
get_subscriptions(Nidx, Owner) ->
|
|
|
|
node_hometree:get_subscriptions(Nidx, Owner).
|
|
|
|
|
|
|
|
set_subscriptions(Nidx, Owner, Subscription, SubId) ->
|
|
|
|
node_hometree:set_subscriptions(Nidx, Owner, Subscription, SubId).
|
|
|
|
|
2009-07-20 10:53:56 +02:00
|
|
|
get_pending_nodes(Host, Owner) ->
|
|
|
|
node_hometree:get_pending_nodes(Host, Owner).
|
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
get_states(Nidx) ->
|
|
|
|
node_hometree:get_states(Nidx).
|
|
|
|
|
|
|
|
get_state(Nidx, JID) ->
|
|
|
|
node_hometree:get_state(Nidx, JID).
|
|
|
|
|
|
|
|
set_state(State) ->
|
|
|
|
node_hometree:set_state(State).
|
|
|
|
|
|
|
|
get_items(Nidx, From, RSM) ->
|
|
|
|
node_hometree:get_items(Nidx, From, RSM).
|
|
|
|
|
|
|
|
get_items(Nidx, JID, AccessModel, PresenceSubscription, RosterGroup, SubId, RSM) ->
|
|
|
|
node_hometree:get_items(Nidx, JID, AccessModel,
|
|
|
|
PresenceSubscription, RosterGroup, SubId, RSM).
|
|
|
|
|
|
|
|
get_item(Nidx, ItemId) ->
|
|
|
|
node_hometree:get_item(Nidx, ItemId).
|
|
|
|
|
|
|
|
get_item(Nidx, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) ->
|
|
|
|
node_hometree:get_item(Nidx, ItemId, JID, AccessModel,
|
|
|
|
PresenceSubscription, RosterGroup, SubId).
|
|
|
|
|
|
|
|
set_item(Item) ->
|
|
|
|
node_hometree:set_item(Item).
|
2008-02-06 19:04:23 +01:00
|
|
|
|
|
|
|
get_item_name(Host, Node, Id) ->
|
2009-05-29 00:30:43 +02:00
|
|
|
node_hometree:get_item_name(Host, Node, Id).
|
2008-06-29 13:34:30 +02:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
node_to_path(Node) ->
|
|
|
|
node_flat:node_to_path(Node).
|
2009-10-20 17:03:07 +02:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
path_to_node(Path) ->
|
|
|
|
node_flat:path_to_node(Path).
|
2008-06-29 13:34:30 +02:00
|
|
|
|
|
|
|
%%%
|
|
|
|
%%% 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, show a warning message in the ejabberd log file.
|
|
|
|
complain_if_modcaps_disabled(ServerHost) ->
|
2013-08-12 14:25:05 +02:00
|
|
|
case gen_mod:is_loaded(ServerHost, mod_caps) of
|
2015-04-08 17:12:05 +02:00
|
|
|
false ->
|
|
|
|
?WARNING_MSG("The PEP plugin is enabled in mod_pubsub "
|
|
|
|
"of host ~p. This plugin requires mod_caps "
|
|
|
|
"to be enabled, but it isn't.",
|
|
|
|
[ServerHost]);
|
|
|
|
true -> ok
|
2008-06-29 13:34:30 +02:00
|
|
|
end.
|