2015-12-15 16:11:29 +01:00
|
|
|
%%%----------------------------------------------------------------------
|
|
|
|
%%% File : node_dispatch.erl
|
|
|
|
%%% Author : Christophe Romain <christophe.romain@process-one.net>
|
|
|
|
%%% Purpose : Publish item to node and all child subnodes
|
|
|
|
%%% Created : 1 Dec 2007 by Christophe Romain <christophe.romain@process-one.net>
|
2015-04-08 17:12:05 +02:00
|
|
|
%%%
|
2013-03-14 10:33:02 +01:00
|
|
|
%%%
|
2017-01-02 21:41:53 +01:00
|
|
|
%%% ejabberd, Copyright (C) 2002-2017 ProcessOne
|
2015-04-08 17:12:05 +02:00
|
|
|
%%%
|
2015-12-15 16:11:29 +01:00
|
|
|
%%% 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.
|
2013-03-14 10:33:02 +01:00
|
|
|
%%%
|
2015-12-15 16:11:29 +01:00
|
|
|
%%% 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.
|
2007-12-01 06:16:30 +01:00
|
|
|
%%%
|
2015-12-15 16:11:29 +01:00
|
|
|
%%% 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.
|
|
|
|
%%%
|
|
|
|
%%%----------------------------------------------------------------------
|
|
|
|
|
|
|
|
%%% @doc <p>The <strong>{@module}</strong> module is a PubSub plugin whose
|
|
|
|
%%% goal is to republished each published item to all its children.</p>
|
|
|
|
%%% <p>Users cannot subscribe to this node, but are supposed to subscribe to
|
|
|
|
%%% its children.</p>
|
|
|
|
%%% This module can not work with virtual nodetree
|
2007-12-01 06:16:30 +01:00
|
|
|
|
|
|
|
-module(node_dispatch).
|
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").
|
2016-09-08 14:49:27 +02:00
|
|
|
-include("xmpp.hrl").
|
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,
|
2015-07-01 17:18:32 +02:00
|
|
|
publish_item/7, delete_item/4, remove_extra_items/3,
|
2015-04-08 17:12:05 +02:00
|
|
|
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,
|
2017-03-30 14:26:30 +02:00
|
|
|
get_last_items/3,
|
2015-04-08 17:12:05 +02:00
|
|
|
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).
|
2007-12-01 06:16:30 +01:00
|
|
|
|
|
|
|
terminate(Host, ServerHost) ->
|
2009-05-29 00:30:43 +02:00
|
|
|
node_hometree:terminate(Host, ServerHost).
|
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, true},
|
|
|
|
{purge_offline, false},
|
|
|
|
{persist_items, true},
|
|
|
|
{max_items, ?MAXITEMS},
|
|
|
|
{subscribe, true},
|
|
|
|
{access_model, presence},
|
|
|
|
{roster_groups_allowed, []},
|
|
|
|
{publish_model, publishers},
|
|
|
|
{notification_type, headline},
|
|
|
|
{max_payload_size, ?MAX_PAYLOAD_SIZE},
|
|
|
|
{send_last_published_item, never},
|
|
|
|
{deliver_notifications, true},
|
2016-04-21 23:47:07 +02:00
|
|
|
{presence_based_delivery, false},
|
|
|
|
{itemreply, none}].
|
2007-12-01 06:16:30 +01:00
|
|
|
|
|
|
|
features() ->
|
2015-04-08 17:12:05 +02:00
|
|
|
[<<"create-nodes">>,
|
|
|
|
<<"delete-nodes">>,
|
|
|
|
<<"instant-nodes">>,
|
|
|
|
<<"outcast-affiliation">>,
|
|
|
|
<<"persistent-items">>,
|
|
|
|
<<"publish">>,
|
|
|
|
<<"retrieve-items">>].
|
2013-03-14 10:33:02 +01:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access) ->
|
|
|
|
node_hometree:create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access).
|
2007-12-01 06:16:30 +01:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
create_node(Nidx, Owner) ->
|
|
|
|
node_hometree:create_node(Nidx, Owner).
|
2007-12-01 06:16:30 +01:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
delete_node(Nodes) ->
|
|
|
|
node_hometree:delete_node(Nodes).
|
2007-12-01 06:16:30 +01:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
subscribe_node(_Nidx, _Sender, _Subscriber, _AccessModel, _SendLast, _PresenceSubscription,
|
|
|
|
_RosterGroup, _Options) ->
|
2016-09-08 14:49:27 +02:00
|
|
|
{error, mod_pubsub:extended_error(xmpp:err_feature_not_implemented(),
|
|
|
|
mod_pubsub:err_unsupported('subscribe'))}.
|
2007-12-01 06:16:30 +01:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
unsubscribe_node(_Nidx, _Sender, _Subscriber, _SubId) ->
|
2016-09-08 14:49:27 +02:00
|
|
|
{error, mod_pubsub:extended_error(xmpp:err_feature_not_implemented(),
|
|
|
|
mod_pubsub:err_unsupported('subscribe'))}.
|
2007-12-01 06:16:30 +01:00
|
|
|
|
2015-07-01 17:18:32 +02:00
|
|
|
publish_item(Nidx, Publisher, PublishModel, MaxItems, ItemId, Payload,
|
|
|
|
PubOpts) ->
|
2015-04-08 17:12:05 +02:00
|
|
|
case nodetree_tree:get_node(Nidx) of
|
|
|
|
#pubsub_node{nodeid = {Host, Node}} ->
|
|
|
|
lists:foreach(fun (SubNode) ->
|
|
|
|
node_hometree:publish_item(SubNode#pubsub_node.id,
|
|
|
|
Publisher, PublishModel, MaxItems,
|
2015-07-01 17:18:32 +02:00
|
|
|
ItemId, Payload, PubOpts)
|
2015-04-08 17:12:05 +02:00
|
|
|
end,
|
|
|
|
nodetree_tree:get_subnodes(Host, Node, Publisher)),
|
|
|
|
{result, {default, broadcast, []}};
|
|
|
|
Error ->
|
|
|
|
Error
|
|
|
|
end.
|
|
|
|
|
|
|
|
remove_extra_items(_Nidx, _MaxItems, ItemIds) ->
|
2007-12-06 10:29:28 +01:00
|
|
|
{result, {ItemIds, []}}.
|
2007-12-01 06:16:30 +01:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
delete_item(_Nidx, _Publisher, _PublishModel, _ItemId) ->
|
2016-09-08 14:49:27 +02:00
|
|
|
{error, mod_pubsub:extended_error(xmpp:err_feature_not_implemented(),
|
|
|
|
mod_pubsub:err_unsupported('delete-items'))}.
|
2007-12-01 06:16:30 +01:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
purge_node(_Nidx, _Owner) ->
|
2016-09-08 14:49:27 +02:00
|
|
|
{error, mod_pubsub:extended_error(xmpp:err_feature_not_implemented(),
|
|
|
|
mod_pubsub:err_unsupported('purge-nodes'))}.
|
2007-12-01 06:16:30 +01:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
get_entity_affiliations(_Host, _Owner) ->
|
|
|
|
{result, []}.
|
2007-12-01 06:16:30 +01:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
get_node_affiliations(_Nidx) ->
|
|
|
|
{result, []}.
|
2007-12-01 06:16:30 +01:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
get_affiliation(_Nidx, _Owner) ->
|
|
|
|
{result, none}.
|
2007-12-01 06:16:30 +01:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
set_affiliation(Nidx, Owner, Affiliation) ->
|
|
|
|
node_hometree:set_affiliation(Nidx, Owner, Affiliation).
|
2007-12-01 06:16:30 +01:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
get_entity_subscriptions(_Host, _Owner) ->
|
|
|
|
{result, []}.
|
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).
|
2007-12-01 06:16:30 +01:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
get_subscriptions(_Nidx, _Owner) ->
|
|
|
|
{result, []}.
|
2007-12-01 06:16:30 +01:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
set_subscriptions(Nidx, Owner, Subscription, SubId) ->
|
|
|
|
node_hometree:set_subscriptions(Nidx, Owner, Subscription, SubId).
|
2007-12-01 06:16:30 +01:00
|
|
|
|
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).
|
2007-12-01 06:16:30 +01:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
get_state(Nidx, JID) ->
|
|
|
|
node_hometree:get_state(Nidx, JID).
|
2007-12-01 06:16:30 +01:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
set_state(State) ->
|
|
|
|
node_hometree:set_state(State).
|
2007-12-01 06:16:30 +01:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
get_items(Nidx, From, RSM) ->
|
|
|
|
node_hometree:get_items(Nidx, From, RSM).
|
2007-12-01 06:16:30 +01:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
get_items(Nidx, JID, AccessModel, PresenceSubscription, RosterGroup, SubId, RSM) ->
|
|
|
|
node_hometree:get_items(Nidx, JID, AccessModel,
|
|
|
|
PresenceSubscription, RosterGroup, SubId, RSM).
|
2008-07-03 11:56:31 +02:00
|
|
|
|
2017-03-30 14:26:30 +02:00
|
|
|
get_last_items(Nidx, From, Count) ->
|
|
|
|
node_hometree:get_last_items(Nidx, From, Count).
|
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
get_item(Nidx, ItemId) ->
|
|
|
|
node_hometree:get_item(Nidx, ItemId).
|
2007-12-01 06:16:30 +01:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
get_item(Nidx, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) ->
|
|
|
|
node_hometree:get_item(Nidx, ItemId, JID, AccessModel,
|
|
|
|
PresenceSubscription, RosterGroup, SubId).
|
2008-07-03 11:56:31 +02:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
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).
|
2009-10-20 17:03:07 +02:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
node_to_path(Node) ->
|
2015-07-22 10:37:26 +02:00
|
|
|
node_hometree:node_to_path(Node).
|
2009-10-20 17:03:07 +02:00
|
|
|
|
2015-04-08 17:12:05 +02:00
|
|
|
path_to_node(Path) ->
|
2015-07-22 10:37:26 +02:00
|
|
|
node_hometree:path_to_node(Path).
|