Chapril/xmpp.chapril.org-ejabberd
25
1
Fork 0
mirror of https://github.com/processone/ejabberd.git synced 2024-11-30 16:36:29 +01:00
Code Releases Activity

PubSub: node_flat becomes default plugin (thanks to Karim Gemayel)(EJAB-1077)

Browse Source
This commit is contained in:
Christophe Romain 2010-05-17 22:09:01 +02:00
parent 4409c49494
commit f6e4d95c6f
17 changed files with 1202 additions and 1202 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/mod_pubsub/mod_pubsub.erl
View File

@ -258,7 +258,7 @@ init_send_loop(ServerHost, State) ->
%% <em>node_plugin</em>. The 'node_' prefix is mandatory.</p> %% <em>node_plugin</em>. The 'node_' prefix is mandatory.</p>
%% <p>The modules are initialized in alphetical order and the list is checked %% <p>The modules are initialized in alphetical order and the list is checked
%% and sorted to ensure that each module is initialized only once.</p> %% and sorted to ensure that each module is initialized only once.</p>
%% <p>See {@link node_hometree:init/1} for an example implementation.</p> %% <p>See {@link node_flat:init/1} for an example implementation.</p>
init_plugins(Host, ServerHost, Opts) -> init_plugins(Host, ServerHost, Opts) ->
TreePlugin = list_to_atom(?TREE_PREFIX ++ TreePlugin = list_to_atom(?TREE_PREFIX ++
gen_mod:get_opt(nodetree, Opts, ?STDTREE)), gen_mod:get_opt(nodetree, Opts, ?STDTREE)),
@ -1912,7 +1912,7 @@ delete_node(Host, Node, Owner) ->
%% Node = pubsubNode() %% Node = pubsubNode()
%% From = jid() %% From = jid()
%% JID = jid() %% JID = jid()
%% @see node_hometree:subscribe_node/5 %% @see node_flat:subscribe_node/5
%% @doc <p>Accepts or rejects subcription requests on a PubSub node.</p> %% @doc <p>Accepts or rejects subcription requests on a PubSub node.</p>
%%<p>There are several reasons why the subscription request might fail:</p> %%<p>There are several reasons why the subscription request might fail:</p>
%%<ul> %%<ul>
@ -3751,7 +3751,7 @@ select_type(ServerHost, Host, Node) ->
features() -> features() ->
[ [
% see plugin "access-authorize", % OPTIONAL % see plugin "access-authorize", % OPTIONAL
"access-open", % OPTIONAL this relates to access_model option in node_hometree "access-open", % OPTIONAL this relates to access_model option in node_flat
"access-presence", % OPTIONAL this relates to access_model option in node_pep "access-presence", % OPTIONAL this relates to access_model option in node_pep
%TODO "access-roster", % OPTIONAL %TODO "access-roster", % OPTIONAL
"access-whitelist", % OPTIONAL "access-whitelist", % OPTIONAL

8
src/mod_pubsub/mod_pubsub_odbc.erl
View File

@ -256,7 +256,7 @@ init_send_loop(ServerHost, State) ->
%% <em>node_plugin</em>. The 'node_' prefix is mandatory.</p> %% <em>node_plugin</em>. The 'node_' prefix is mandatory.</p>
%% <p>The modules are initialized in alphetical order and the list is checked %% <p>The modules are initialized in alphetical order and the list is checked
%% and sorted to ensure that each module is initialized only once.</p> %% and sorted to ensure that each module is initialized only once.</p>
%% <p>See {@link node_hometree:init/1} for an example implementation.</p> %% <p>See {@link node_flat:init/1} for an example implementation.</p>
init_plugins(Host, ServerHost, Opts) -> init_plugins(Host, ServerHost, Opts) ->
TreePlugin = list_to_atom(?TREE_PREFIX ++ TreePlugin = list_to_atom(?TREE_PREFIX ++
gen_mod:get_opt(nodetree, Opts, ?STDTREE)), gen_mod:get_opt(nodetree, Opts, ?STDTREE)),
@ -1727,7 +1727,7 @@ delete_node(Host, Node, Owner) ->
%% Node = pubsubNode() %% Node = pubsubNode()
%% From = jid() %% From = jid()
%% JID = jid() %% JID = jid()
%% @see node_hometree:subscribe_node/5 %% @see node_flat:subscribe_node/5
%% @doc <p>Accepts or rejects subcription requests on a PubSub node.</p> %% @doc <p>Accepts or rejects subcription requests on a PubSub node.</p>
%%<p>There are several reasons why the subscription request might fail:</p> %%<p>There are several reasons why the subscription request might fail:</p>
%%<ul> %%<ul>
@ -2213,7 +2213,7 @@ get_item(Host, Node, ItemId) ->
send_items(Host, Node, NodeId, Type, LJID, last) -> send_items(Host, Node, NodeId, Type, LJID, last) ->
Stanza = case get_cached_item(Host, NodeId) of Stanza = case get_cached_item(Host, NodeId) of
undefined -> undefined ->
% special ODBC optimization, works only with node_hometree_odbc, node_flat_odbc and node_pep_odbc % special ODBC optimization, works only with node_flat_odbc, node_flat_odbc and node_pep_odbc
case node_action(Host, Type, get_last_items, [NodeId, LJID, 1]) of case node_action(Host, Type, get_last_items, [NodeId, LJID, 1]) of
{result, [LastItem]} -> {result, [LastItem]} ->
{ModifNow, ModifLjid} = LastItem#pubsub_item.modification, {ModifNow, ModifLjid} = LastItem#pubsub_item.modification,
@ -3589,7 +3589,7 @@ select_type(ServerHost, Host, Node) ->
features() -> features() ->
[ [
% see plugin "access-authorize", % OPTIONAL % see plugin "access-authorize", % OPTIONAL
"access-open", % OPTIONAL this relates to access_model option in node_hometree "access-open", % OPTIONAL this relates to access_model option in node_flat
"access-presence", % OPTIONAL this relates to access_model option in node_pep "access-presence", % OPTIONAL this relates to access_model option in node_pep
%TODO "access-roster", % OPTIONAL %TODO "access-roster", % OPTIONAL
"access-whitelist", % OPTIONAL "access-whitelist", % OPTIONAL

56
src/mod_pubsub/node.template
View File

@ -34,7 +34,7 @@
%% it's possible not to define some function at all %% it's possible not to define some function at all
%% in that case, warning will be generated at compilation %% in that case, warning will be generated at compilation
%% and function call will fail, %% and function call will fail,
%% then mod_pubsub will call function from node_hometree %% then mod_pubsub will call function from node_flat
%% (this makes code cleaner, but execution a little bit longer) %% (this makes code cleaner, but execution a little bit longer)
%% API definition %% API definition
@ -69,10 +69,10 @@
init(Host, ServerHost, Opts) -> init(Host, ServerHost, Opts) ->
node_hometree:init(Host, ServerHost, Opts). node_flat:init(Host, ServerHost, Opts).
terminate(Host, ServerHost) -> terminate(Host, ServerHost) ->
node_hometree:terminate(Host, ServerHost). node_flat:terminate(Host, ServerHost).
options() -> options() ->
[{node_type, __TO_BE_DEFINED__}, [{node_type, __TO_BE_DEFINED__},
@ -112,76 +112,76 @@ features() ->
]. ].
create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access) -> create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access) ->
node_hometree:create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access). node_flat:create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access).
create_node(NodeId, Owner) -> create_node(NodeId, Owner) ->
node_hometree:create_node(NodeId, Owner). node_flat:create_node(NodeId, Owner).
delete_node(Removed) -> delete_node(Removed) ->
node_hometree:delete_node(Removed). node_flat:delete_node(Removed).
subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup) -> subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup) ->
node_hometree:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup). node_flat:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup).
unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> unsubscribe_node(NodeId, Sender, Subscriber, SubID) ->
node_hometree:unsubscribe_node(NodeId, Sender, Subscriber, SubID). node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubID).
publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) ->
node_hometree:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). node_flat:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload).
remove_extra_items(NodeId, MaxItems, ItemIds) -> remove_extra_items(NodeId, MaxItems, ItemIds) ->
node_hometree:remove_extra_items(NodeId, MaxItems, ItemIds). node_flat:remove_extra_items(NodeId, MaxItems, ItemIds).
delete_item(NodeId, Publisher, PublishModel, ItemId) -> delete_item(NodeId, Publisher, PublishModel, ItemId) ->
node_hometree:delete_item(NodeId, Publisher, PublishModel, ItemId). node_flat:delete_item(NodeId, Publisher, PublishModel, ItemId).
purge_node(NodeId, Owner) -> purge_node(NodeId, Owner) ->
node_hometree:purge_node(NodeId, Owner). node_flat:purge_node(NodeId, Owner).
get_entity_affiliations(Host, Owner) -> get_entity_affiliations(Host, Owner) ->
node_hometree:get_entity_affiliations(Host, Owner). node_flat:get_entity_affiliations(Host, Owner).
get_node_affiliations(NodeId) -> get_node_affiliations(NodeId) ->
node_hometree:get_node_affiliations(NodeId). node_flat:get_node_affiliations(NodeId).
get_affiliation(NodeId, Owner) -> get_affiliation(NodeId, Owner) ->
node_hometree:get_affiliation(NodeId, Owner). node_flat:get_affiliation(NodeId, Owner).
set_affiliation(NodeId, Owner, Affiliation) -> set_affiliation(NodeId, Owner, Affiliation) ->
node_hometree:set_affiliation(NodeId, Owner, Affiliation). node_flat:set_affiliation(NodeId, Owner, Affiliation).
get_entity_subscriptions(Host, Owner) -> get_entity_subscriptions(Host, Owner) ->
node_hometree:get_entity_subscriptions(Host, Owner). node_flat:get_entity_subscriptions(Host, Owner).
get_node_subscriptions(NodeId) -> get_node_subscriptions(NodeId) ->
node_hometree:get_node_subscriptions(NodeId). node_flat:get_node_subscriptions(NodeId).
get_subscription(NodeId, Owner) -> get_subscription(NodeId, Owner) ->
node_hometree:get_subscription(NodeId, Owner). node_flat:get_subscription(NodeId, Owner).
set_subscription(NodeId, Owner, Subscription) -> set_subscription(NodeId, Owner, Subscription) ->
node_hometree:set_subscription(NodeId, Owner, Subscription). node_flat:set_subscription(NodeId, Owner, Subscription).
get_states(NodeId) -> get_states(NodeId) ->
node_hometree:get_states(NodeId). node_flat:get_states(NodeId).
get_state(NodeId, JID) -> get_state(NodeId, JID) ->
node_hometree:get_state(NodeId, JID). node_flat:get_state(NodeId, JID).
set_state(State) -> set_state(State) ->
node_hometree:set_state(State). node_flat:set_state(State).
get_items(NodeId, From) -> get_items(NodeId, From) ->
node_hometree:get_items(NodeId, From). node_flat:get_items(NodeId, From).
get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId)
node_hometree:get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). node_flat:get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId).
get_item(NodeId, ItemId) -> get_item(NodeId, ItemId) ->
node_hometree:get_item(NodeId, ItemId). node_flat:get_item(NodeId, ItemId).
get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) ->
node_hometree:get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). node_flat:get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId).
set_item(Item) -> set_item(Item) ->
node_hometree:set_item(Item). node_flat:set_item(Item).

60
src/mod_pubsub/node_buddy.erl
View File

@ -37,7 +37,7 @@
%% it's possible not to define some function at all %% it's possible not to define some function at all
%% in that case, warning will be generated at compilation %% in that case, warning will be generated at compilation
%% and function call will fail, %% and function call will fail,
%% then mod_pubsub will call function from node_hometree %% then mod_pubsub will call function from node_flat
%% (this makes code cleaner, but execution a little bit longer) %% (this makes code cleaner, but execution a little bit longer)
%% API definition %% API definition
@ -76,10 +76,10 @@
init(Host, ServerHost, Opts) -> init(Host, ServerHost, Opts) ->
node_hometree:init(Host, ServerHost, Opts). node_flat:init(Host, ServerHost, Opts).
terminate(Host, ServerHost) -> terminate(Host, ServerHost) ->
node_hometree:terminate(Host, ServerHost). node_flat:terminate(Host, ServerHost).
options() -> options() ->
[{deliver_payloads, true}, [{deliver_payloads, true},
@ -119,86 +119,86 @@ features() ->
]. ].
create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access) -> create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access) ->
node_hometree:create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access). node_flat:create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access).
create_node(NodeId, Owner) -> create_node(NodeId, Owner) ->
node_hometree:create_node(NodeId, Owner). node_flat:create_node(NodeId, Owner).
delete_node(Removed) -> delete_node(Removed) ->
node_hometree:delete_node(Removed). node_flat:delete_node(Removed).
subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) ->
node_hometree:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). node_flat:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options).
unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> unsubscribe_node(NodeId, Sender, Subscriber, SubID) ->
node_hometree:unsubscribe_node(NodeId, Sender, Subscriber, SubID). node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubID).
publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) ->
node_hometree:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). node_flat:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload).
remove_extra_items(NodeId, MaxItems, ItemIds) -> remove_extra_items(NodeId, MaxItems, ItemIds) ->
node_hometree:remove_extra_items(NodeId, MaxItems, ItemIds). node_flat:remove_extra_items(NodeId, MaxItems, ItemIds).
delete_item(NodeId, Publisher, PublishModel, ItemId) -> delete_item(NodeId, Publisher, PublishModel, ItemId) ->
node_hometree:delete_item(NodeId, Publisher, PublishModel, ItemId). node_flat:delete_item(NodeId, Publisher, PublishModel, ItemId).
purge_node(NodeId, Owner) -> purge_node(NodeId, Owner) ->
node_hometree:purge_node(NodeId, Owner). node_flat:purge_node(NodeId, Owner).
get_entity_affiliations(Host, Owner) -> get_entity_affiliations(Host, Owner) ->
node_hometree:get_entity_affiliations(Host, Owner). node_flat:get_entity_affiliations(Host, Owner).
get_node_affiliations(NodeId) -> get_node_affiliations(NodeId) ->
node_hometree:get_node_affiliations(NodeId). node_flat:get_node_affiliations(NodeId).
get_affiliation(NodeId, Owner) -> get_affiliation(NodeId, Owner) ->
node_hometree:get_affiliation(NodeId, Owner). node_flat:get_affiliation(NodeId, Owner).
set_affiliation(NodeId, Owner, Affiliation) -> set_affiliation(NodeId, Owner, Affiliation) ->
node_hometree:set_affiliation(NodeId, Owner, Affiliation). node_flat:set_affiliation(NodeId, Owner, Affiliation).
get_entity_subscriptions(Host, Owner) -> get_entity_subscriptions(Host, Owner) ->
node_hometree:get_entity_subscriptions(Host, Owner). node_flat:get_entity_subscriptions(Host, Owner).
get_node_subscriptions(NodeId) -> get_node_subscriptions(NodeId) ->
node_hometree:get_node_subscriptions(NodeId). node_flat:get_node_subscriptions(NodeId).
get_subscriptions(NodeId, Owner) -> get_subscriptions(NodeId, Owner) ->
node_hometree:get_subscriptions(NodeId, Owner). node_flat:get_subscriptions(NodeId, Owner).
set_subscriptions(NodeId, Owner, Subscription, SubId) -> set_subscriptions(NodeId, Owner, Subscription, SubId) ->
node_hometree:set_subscriptions(NodeId, Owner, Subscription, SubId). node_flat:set_subscriptions(NodeId, Owner, Subscription, SubId).
get_pending_nodes(Host, Owner) -> get_pending_nodes(Host, Owner) ->
node_hometree:get_pending_nodes(Host, Owner). node_flat:get_pending_nodes(Host, Owner).
get_states(NodeId) -> get_states(NodeId) ->
node_hometree:get_states(NodeId). node_flat:get_states(NodeId).
get_state(NodeId, JID) -> get_state(NodeId, JID) ->
node_hometree:get_state(NodeId, JID). node_flat:get_state(NodeId, JID).
set_state(State) -> set_state(State) ->
node_hometree:set_state(State). node_flat:set_state(State).
get_items(NodeId, From) -> get_items(NodeId, From) ->
node_hometree:get_items(NodeId, From). node_flat:get_items(NodeId, From).
get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) ->
node_hometree:get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). node_flat:get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId).
get_item(NodeId, ItemId) -> get_item(NodeId, ItemId) ->
node_hometree:get_item(NodeId, ItemId). node_flat:get_item(NodeId, ItemId).
get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) ->
node_hometree:get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). node_flat:get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId).
set_item(Item) -> set_item(Item) ->
node_hometree:set_item(Item). node_flat:set_item(Item).
get_item_name(Host, Node, Id) -> get_item_name(Host, Node, Id) ->
node_hometree:get_item_name(Host, Node, Id). node_flat:get_item_name(Host, Node, Id).
node_to_path(Node) -> node_to_path(Node) ->
node_flat:node_to_path(Node). node_flat:node_to_path(Node).

60
src/mod_pubsub/node_club.erl
View File

@ -36,7 +36,7 @@
%% it's possible not to define some function at all %% it's possible not to define some function at all
%% in that case, warning will be generated at compilation %% in that case, warning will be generated at compilation
%% and function call will fail, %% and function call will fail,
%% then mod_pubsub will call function from node_hometree %% then mod_pubsub will call function from node_flat
%% (this makes code cleaner, but execution a little bit longer) %% (this makes code cleaner, but execution a little bit longer)
%% API definition %% API definition
@ -75,10 +75,10 @@
init(Host, ServerHost, Opts) -> init(Host, ServerHost, Opts) ->
node_hometree:init(Host, ServerHost, Opts). node_flat:init(Host, ServerHost, Opts).
terminate(Host, ServerHost) -> terminate(Host, ServerHost) ->
node_hometree:terminate(Host, ServerHost). node_flat:terminate(Host, ServerHost).
options() -> options() ->
[{deliver_payloads, true}, [{deliver_payloads, true},
@ -117,85 +117,85 @@ features() ->
]. ].
create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access) -> create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access) ->
node_hometree:create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access). node_flat:create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access).
create_node(NodeId, Owner) -> create_node(NodeId, Owner) ->
node_hometree:create_node(NodeId, Owner). node_flat:create_node(NodeId, Owner).
delete_node(Removed) -> delete_node(Removed) ->
node_hometree:delete_node(Removed). node_flat:delete_node(Removed).
subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) ->
node_hometree:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). node_flat:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options).
unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> unsubscribe_node(NodeId, Sender, Subscriber, SubID) ->
node_hometree:unsubscribe_node(NodeId, Sender, Subscriber, SubID). node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubID).
publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) ->
node_hometree:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). node_flat:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload).
remove_extra_items(NodeId, MaxItems, ItemIds) -> remove_extra_items(NodeId, MaxItems, ItemIds) ->
node_hometree:remove_extra_items(NodeId, MaxItems, ItemIds). node_flat:remove_extra_items(NodeId, MaxItems, ItemIds).
delete_item(NodeId, Publisher, PublishModel, ItemId) -> delete_item(NodeId, Publisher, PublishModel, ItemId) ->
node_hometree:delete_item(NodeId, Publisher, PublishModel, ItemId). node_flat:delete_item(NodeId, Publisher, PublishModel, ItemId).
purge_node(NodeId, Owner) -> purge_node(NodeId, Owner) ->
node_hometree:purge_node(NodeId, Owner). node_flat:purge_node(NodeId, Owner).
get_entity_affiliations(Host, Owner) -> get_entity_affiliations(Host, Owner) ->
node_hometree:get_entity_affiliations(Host, Owner). node_flat:get_entity_affiliations(Host, Owner).
get_node_affiliations(NodeId) -> get_node_affiliations(NodeId) ->
node_hometree:get_node_affiliations(NodeId). node_flat:get_node_affiliations(NodeId).
get_affiliation(NodeId, Owner) -> get_affiliation(NodeId, Owner) ->
node_hometree:get_affiliation(NodeId, Owner). node_flat:get_affiliation(NodeId, Owner).
set_affiliation(NodeId, Owner, Affiliation) -> set_affiliation(NodeId, Owner, Affiliation) ->
node_hometree:set_affiliation(NodeId, Owner, Affiliation). node_flat:set_affiliation(NodeId, Owner, Affiliation).
get_entity_subscriptions(Host, Owner) -> get_entity_subscriptions(Host, Owner) ->
node_hometree:get_entity_subscriptions(Host, Owner). node_flat:get_entity_subscriptions(Host, Owner).
get_node_subscriptions(NodeId) -> get_node_subscriptions(NodeId) ->
node_hometree:get_node_subscriptions(NodeId). node_flat:get_node_subscriptions(NodeId).
get_subscriptions(NodeId, Owner) -> get_subscriptions(NodeId, Owner) ->
node_hometree:get_subscriptions(NodeId, Owner). node_flat:get_subscriptions(NodeId, Owner).
set_subscriptions(NodeId, Owner, Subscription, SubId) -> set_subscriptions(NodeId, Owner, Subscription, SubId) ->
node_hometree:set_subscriptions(NodeId, Owner, Subscription, SubId). node_flat:set_subscriptions(NodeId, Owner, Subscription, SubId).
get_pending_nodes(Host, Owner) -> get_pending_nodes(Host, Owner) ->
node_hometree:get_pending_nodes(Host, Owner). node_flat:get_pending_nodes(Host, Owner).
get_states(NodeId) -> get_states(NodeId) ->
node_hometree:get_states(NodeId). node_flat:get_states(NodeId).
get_state(NodeId, JID) -> get_state(NodeId, JID) ->
node_hometree:get_state(NodeId, JID). node_flat:get_state(NodeId, JID).
set_state(State) -> set_state(State) ->
node_hometree:set_state(State). node_flat:set_state(State).
get_items(NodeId, From) -> get_items(NodeId, From) ->
node_hometree:get_items(NodeId, From). node_flat:get_items(NodeId, From).
get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) ->
node_hometree:get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). node_flat:get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId).
get_item(NodeId, ItemId) -> get_item(NodeId, ItemId) ->
node_hometree:get_item(NodeId, ItemId). node_flat:get_item(NodeId, ItemId).
get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) ->
node_hometree:get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). node_flat:get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId).
set_item(Item) -> set_item(Item) ->
node_hometree:set_item(Item). node_flat:set_item(Item).
get_item_name(Host, Node, Id) -> get_item_name(Host, Node, Id) ->
node_hometree:get_item_name(Host, Node, Id). node_flat:get_item_name(Host, Node, Id).
node_to_path(Node) -> node_to_path(Node) ->
node_flat:node_to_path(Node). node_flat:node_to_path(Node).

64
src/mod_pubsub/node_dag.erl
View File

@ -58,35 +58,35 @@
init(Host, ServerHost, Opts) -> init(Host, ServerHost, Opts) ->
node_hometree:init(Host, ServerHost, Opts). node_flat:init(Host, ServerHost, Opts).
terminate(Host, ServerHost) -> terminate(Host, ServerHost) ->
node_hometree:terminate(Host, ServerHost). node_flat:terminate(Host, ServerHost).
options() -> options() ->
[{node_type, leaf} | node_hometree:options()]. [{node_type, leaf} | node_flat:options()].
features() -> features() ->
["multi-collection" | node_hometree:features()]. ["multi-collection" | node_flat:features()].
create_node_permission(_Host, _ServerHost, _Node, _ParentNode, create_node_permission(_Host, _ServerHost, _Node, _ParentNode,
_Owner, _Access) -> _Owner, _Access) ->
{result, true}. {result, true}.
create_node(NodeID, Owner) -> create_node(NodeID, Owner) ->
node_hometree:create_node(NodeID, Owner). node_flat:create_node(NodeID, Owner).
delete_node(Removed) -> delete_node(Removed) ->
node_hometree:delete_node(Removed). node_flat:delete_node(Removed).
subscribe_node(NodeID, Sender, Subscriber, AccessModel, subscribe_node(NodeID, Sender, Subscriber, AccessModel,
SendLast, PresenceSubscription, RosterGroup, Options) -> SendLast, PresenceSubscription, RosterGroup, Options) ->
node_hometree:subscribe_node(NodeID, Sender, Subscriber, AccessModel, node_flat:subscribe_node(NodeID, Sender, Subscriber, AccessModel,
SendLast, PresenceSubscription, RosterGroup, SendLast, PresenceSubscription, RosterGroup,
Options). Options).
unsubscribe_node(NodeID, Sender, Subscriber, SubID) -> unsubscribe_node(NodeID, Sender, Subscriber, SubID) ->
node_hometree:unsubscribe_node(NodeID, Sender, Subscriber, SubID). node_flat:unsubscribe_node(NodeID, Sender, Subscriber, SubID).
publish_item(NodeID, Publisher, Model, MaxItems, ItemID, Payload) -> publish_item(NodeID, Publisher, Model, MaxItems, ItemID, Payload) ->
%% TODO: should look up the NodeTree plugin here. There's no %% TODO: should look up the NodeTree plugin here. There's no
@ -98,7 +98,7 @@ publish_item(NodeID, Publisher, Model, MaxItems, ItemID, Payload) ->
collection -> collection ->
{error, mod_pubsub:extended_error('not-allowed', "publish")}; {error, mod_pubsub:extended_error('not-allowed', "publish")};
_ -> _ ->
node_hometree:publish_item(NodeID, Publisher, Model, node_flat:publish_item(NodeID, Publisher, Model,
MaxItems, ItemID, Payload) MaxItems, ItemID, Payload)
end; end;
Err -> Err ->
@ -110,74 +110,74 @@ find_opt(Option, [{Option, Value} | _]) -> Value;
find_opt(Option, [_ | T]) -> find_opt(Option, T). find_opt(Option, [_ | T]) -> find_opt(Option, T).
remove_extra_items(NodeID, MaxItems, ItemIDs) -> remove_extra_items(NodeID, MaxItems, ItemIDs) ->
node_hometree:remove_extra_items(NodeID, MaxItems, ItemIDs). node_flat:remove_extra_items(NodeID, MaxItems, ItemIDs).
delete_item(NodeID, Publisher, PublishModel, ItemID) -> delete_item(NodeID, Publisher, PublishModel, ItemID) ->
node_hometree:delete_item(NodeID, Publisher, PublishModel, ItemID). node_flat:delete_item(NodeID, Publisher, PublishModel, ItemID).
purge_node(NodeID, Owner) -> purge_node(NodeID, Owner) ->
node_hometree:purge_node(NodeID, Owner). node_flat:purge_node(NodeID, Owner).
get_entity_affiliations(Host, Owner) -> get_entity_affiliations(Host, Owner) ->
node_hometree:get_entity_affiliations(Host, Owner). node_flat:get_entity_affiliations(Host, Owner).
get_node_affiliations(NodeID) -> get_node_affiliations(NodeID) ->
node_hometree:get_node_affiliations(NodeID). node_flat:get_node_affiliations(NodeID).
get_affiliation(NodeID, Owner) -> get_affiliation(NodeID, Owner) ->
node_hometree:get_affiliation(NodeID, Owner). node_flat:get_affiliation(NodeID, Owner).
set_affiliation(NodeID, Owner, Affiliation) -> set_affiliation(NodeID, Owner, Affiliation) ->
node_hometree:set_affiliation(NodeID, Owner, Affiliation). node_flat:set_affiliation(NodeID, Owner, Affiliation).
get_entity_subscriptions(Host, Owner) -> get_entity_subscriptions(Host, Owner) ->
node_hometree:get_entity_subscriptions(Host, Owner). node_flat:get_entity_subscriptions(Host, Owner).
get_node_subscriptions(NodeID) -> get_node_subscriptions(NodeID) ->
node_hometree:get_node_subscriptions(NodeID). node_flat:get_node_subscriptions(NodeID).
get_subscriptions(NodeID, Owner) -> get_subscriptions(NodeID, Owner) ->
node_hometree:get_subscriptions(NodeID, Owner). node_flat:get_subscriptions(NodeID, Owner).
set_subscriptions(NodeID, Owner, Subscription, SubID) -> set_subscriptions(NodeID, Owner, Subscription, SubID) ->
node_hometree:set_subscriptions(NodeID, Owner, Subscription, SubID). node_flat:set_subscriptions(NodeID, Owner, Subscription, SubID).
get_pending_nodes(Host, Owner) -> get_pending_nodes(Host, Owner) ->
node_hometree:get_pending_nodes(Host, Owner). node_flat:get_pending_nodes(Host, Owner).
get_states(NodeID) -> get_states(NodeID) ->
node_hometree:get_states(NodeID). node_flat:get_states(NodeID).
get_state(NodeID, JID) -> get_state(NodeID, JID) ->
node_hometree:get_state(NodeID, JID). node_flat:get_state(NodeID, JID).
set_state(State) -> set_state(State) ->
node_hometree:set_state(State). node_flat:set_state(State).
get_items(NodeID, From) -> get_items(NodeID, From) ->
node_hometree:get_items(NodeID, From). node_flat:get_items(NodeID, From).
get_items(NodeID, JID, AccessModel, PresenceSubscription, get_items(NodeID, JID, AccessModel, PresenceSubscription,
RosterGroup, SubID) -> RosterGroup, SubID) ->
node_hometree:get_items(NodeID, JID, AccessModel, PresenceSubscription, node_flat:get_items(NodeID, JID, AccessModel, PresenceSubscription,
RosterGroup, SubID). RosterGroup, SubID).
get_item(NodeID, ItemID) -> get_item(NodeID, ItemID) ->
node_hometree:get_item(NodeID, ItemID). node_flat:get_item(NodeID, ItemID).
get_item(NodeID, ItemID, JID, AccessModel, PresenceSubscription, get_item(NodeID, ItemID, JID, AccessModel, PresenceSubscription,
RosterGroup, SubID) -> RosterGroup, SubID) ->
node_hometree:get_item(NodeID, ItemID, JID, AccessModel, node_flat:get_item(NodeID, ItemID, JID, AccessModel,
PresenceSubscription, RosterGroup, SubID). PresenceSubscription, RosterGroup, SubID).
set_item(Item) -> set_item(Item) ->
node_hometree:set_item(Item). node_flat:set_item(Item).
get_item_name(Host, Node, ID) -> get_item_name(Host, Node, ID) ->
node_hometree:get_item_name(Host, Node, ID). node_flat:get_item_name(Host, Node, ID).
node_to_path(Node) -> node_to_path(Node) ->
node_hometree:node_to_path(Node). node_flat:node_to_path(Node).
path_to_node(Path) -> path_to_node(Path) ->
node_hometree:path_to_node(Path). node_flat:path_to_node(Path).

38
src/mod_pubsub/node_dispatch.erl
View File

@ -73,10 +73,10 @@
init(Host, ServerHost, Opts) -> init(Host, ServerHost, Opts) ->
node_hometree:init(Host, ServerHost, Opts). node_flat:init(Host, ServerHost, Opts).
terminate(Host, ServerHost) -> terminate(Host, ServerHost) ->
node_hometree:terminate(Host, ServerHost). node_flat:terminate(Host, ServerHost).
options() -> options() ->
[{deliver_payloads, true}, [{deliver_payloads, true},
@ -114,13 +114,13 @@ features() ->
]. ].
create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access) -> create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access) ->
node_hometree:create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access). node_flat:create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access).
create_node(NodeId, Owner) -> create_node(NodeId, Owner) ->
node_hometree:create_node(NodeId, Owner). node_flat:create_node(NodeId, Owner).
delete_node(Removed) -> delete_node(Removed) ->
node_hometree:delete_node(Removed). node_flat:delete_node(Removed).
subscribe_node(_NodeId, _Sender, _Subscriber, _AccessModel, subscribe_node(_NodeId, _Sender, _Subscriber, _AccessModel,
_SendLast, _PresenceSubscription, _RosterGroup, _Options) -> _SendLast, _PresenceSubscription, _RosterGroup, _Options) ->
@ -131,7 +131,7 @@ unsubscribe_node(_NodeId, _Sender, _Subscriber, _SubID) ->
publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) ->
lists:foreach(fun(SubNode) -> lists:foreach(fun(SubNode) ->
node_hometree:publish_item( node_flat:publish_item(
SubNode#pubsub_node.id, Publisher, Model, SubNode#pubsub_node.id, Publisher, Model,
MaxItems, ItemId, Payload) MaxItems, ItemId, Payload)
end, nodetree_tree:get_subnodes(NodeId, Publisher, Publisher)). end, nodetree_tree:get_subnodes(NodeId, Publisher, Publisher)).
@ -155,7 +155,7 @@ get_affiliation(_NodeId, _Owner) ->
{result, []}. {result, []}.
set_affiliation(NodeId, Owner, Affiliation) -> set_affiliation(NodeId, Owner, Affiliation) ->
node_hometree:set_affiliation(NodeId, Owner, Affiliation). node_flat:set_affiliation(NodeId, Owner, Affiliation).
get_entity_subscriptions(_Host, _Owner) -> get_entity_subscriptions(_Host, _Owner) ->
{result, []}. {result, []}.
@ -163,43 +163,43 @@ get_entity_subscriptions(_Host, _Owner) ->
get_node_subscriptions(NodeId) -> get_node_subscriptions(NodeId) ->
%% note: get_node_subscriptions is used for broadcasting %% note: get_node_subscriptions is used for broadcasting
%% DO NOT REMOVE %% DO NOT REMOVE
node_hometree:get_node_subscriptions(NodeId). node_flat:get_node_subscriptions(NodeId).
get_subscriptions(_NodeId, _Owner) -> get_subscriptions(_NodeId, _Owner) ->
{result, []}. {result, []}.
set_subscriptions(NodeId, Owner, Subscription, SubId) -> set_subscriptions(NodeId, Owner, Subscription, SubId) ->
node_hometree:set_subscriptions(NodeId, Owner, Subscription, SubId). node_flat:set_subscriptions(NodeId, Owner, Subscription, SubId).
get_pending_nodes(Host, Owner) -> get_pending_nodes(Host, Owner) ->
node_hometree:get_pending_nodes(Host, Owner). node_flat:get_pending_nodes(Host, Owner).
get_states(NodeId) -> get_states(NodeId) ->
node_hometree:get_states(NodeId). node_flat:get_states(NodeId).
get_state(NodeId, JID) -> get_state(NodeId, JID) ->
node_hometree:get_state(NodeId, JID). node_flat:get_state(NodeId, JID).
set_state(State) -> set_state(State) ->
node_hometree:set_state(State). node_flat:set_state(State).
get_items(NodeId, From) -> get_items(NodeId, From) ->
node_hometree:get_items(NodeId, From). node_flat:get_items(NodeId, From).
get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) ->
node_hometree:get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). node_flat:get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId).
get_item(NodeId, ItemId) -> get_item(NodeId, ItemId) ->
node_hometree:get_item(NodeId, ItemId). node_flat:get_item(NodeId, ItemId).
get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) ->
node_hometree:get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). node_flat:get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId).
set_item(Item) -> set_item(Item) ->
node_hometree:set_item(Item). node_flat:set_item(Item).
get_item_name(Host, Node, Id) -> get_item_name(Host, Node, Id) ->
node_hometree:get_item_name(Host, Node, Id). node_flat:get_item_name(Host, Node, Id).
node_to_path(Node) -> node_to_path(Node) ->
node_flat:node_to_path(Node). node_flat:node_to_path(Node).

898
src/mod_pubsub/node_flat.erl
View File

@ -15,6 +15,7 @@
%%% All Rights Reserved.'' %%% All Rights Reserved.''
%%% This software is copyright 2006-2010, ProcessOne. %%% This software is copyright 2006-2010, ProcessOne.
%%% %%%
%%%
%%% @copyright 2006-2010 ProcessOne %%% @copyright 2006-2010 ProcessOne
%%% @author Christophe Romain <christophe.romain@process-one.net> %%% @author Christophe Romain <christophe.romain@process-one.net>
%%% [http://www.process-one.net/] %%% [http://www.process-one.net/]
@ -22,6 +23,21 @@
%%% @end %%% @end
%%% ==================================================================== %%% ====================================================================
%%% @todo The item table should be handled by the plugin, but plugin that do
%%% not want to manage it should be able to use the default behaviour.
%%% @todo Plugin modules should be able to register to receive presence update
%%% send to pubsub.
%%% @doc The module <strong>{@module}</strong> is the default PubSub plugin.
%%% <p>It is used as a default for all unknown PubSub node type. It can serve
%%% as a developer basis and reference to build its own custom pubsub node
%%% types.</p>
%%% <p>PubSub plugin nodes are using the {@link gen_node} behaviour.</p>
%%% <p><strong>The API isn't stabilized yet</strong>. The pubsub plugin
%%% development is still a work in progress. However, the system is already
%%% useable and useful as is. Please, send us comments, feedback and
%%% improvements.</p>
-module(node_flat). -module(node_flat).
-author('christophe.romain@process-one.net'). -author('christophe.romain@process-one.net').
@ -64,13 +80,60 @@
path_to_node/1 path_to_node/1
]). ]).
%% ================
%% API definition
%% ================
init(Host, ServerHost, Opts) -> %% @spec (Host, ServerHost, Opts) -> any()
node_hometree:init(Host, ServerHost, Opts). %% Host = mod_pubsub:host()
%% ServerHost = mod_pubsub:host()
%% Opts = list()
%% @doc <p>Called during pubsub modules initialisation. Any pubsub plugin must
%% implement this function. It can return anything.</p>
%% <p>This function is mainly used to trigger the setup task necessary for the
%% plugin. It can be used for example by the developer to create the specific
%% module database schema if it does not exists yet.</p>
init(_Host, _ServerHost, _Opts) ->
pubsub_subscription:init(),
mnesia:create_table(pubsub_state,
[{disc_copies, [node()]},
{attributes, record_info(fields, pubsub_state)}]),
mnesia:create_table(pubsub_item,
[{disc_only_copies, [node()]},
{attributes, record_info(fields, pubsub_item)}]),
ItemsFields = record_info(fields, pubsub_item),
case mnesia:table_info(pubsub_item, attributes) of
ItemsFields -> ok;
_ ->
mnesia:transform_table(pubsub_item, ignore, ItemsFields)
end,
ok.
terminate(Host, ServerHost) -> %% @spec (Host, ServerHost) -> any()
node_hometree:terminate(Host, ServerHost). %% Host = mod_pubsub:host()
%% ServerHost = host()
%% @doc <p>Called during pubsub modules termination. Any pubsub plugin must
%% implement this function. It can return anything.</p>
terminate(_Host, _ServerHost) ->
ok.
%% @spec () -> [Option]
%% Option = mod_pubsub:nodeOption()
%% @doc Returns the default pubsub node options.
%% <p>Example of function return value:</p>
%% ```
%% [{deliver_payloads, true},
%% {notify_config, false},
%% {notify_delete, false},
%% {notify_retract, true},
%% {persist_items, true},
%% {max_items, 10},
%% {subscribe, true},
%% {access_model, open},
%% {publish_model, publishers},
%% {max_payload_size, 100000},
%% {send_last_published_item, never},
%% {presence_based_delivery, false}]'''
options() -> options() ->
[{deliver_payloads, true}, [{deliver_payloads, true},
{notify_config, false}, {notify_config, false},
@ -90,10 +153,33 @@ options() ->
{deliver_notifications, true}, {deliver_notifications, true},
{presence_based_delivery, false}]. {presence_based_delivery, false}].
%% @spec () -> []
%% @doc Returns the node features
features() -> features() ->
node_hometree:features(). ["create-nodes",
"auto-create",
"access-authorize",
"delete-nodes",
"delete-items",
"get-pending",
"instant-nodes",
"manage-subscriptions",
"modify-affiliations",
"multi-subscribe",
"outcast-affiliation",
"persistent-items",
"publish",
"purge-nodes",
"retract-items",
"retrieve-affiliations",
"retrieve-items",
"retrieve-subscriptions",
"subscribe",
"subscription-notifications",
"subscription-options"
].
%% use same code as node_hometree, but do not limite node to %% use same code as node_flat, but do not limite node to
%% the home/localhost/user/... hierarchy %% the home/localhost/user/... hierarchy
%% any node is allowed %% any node is allowed
create_node_permission(Host, ServerHost, _Node, _ParentNode, Owner, Access) -> create_node_permission(Host, ServerHost, _Node, _ParentNode, Owner, Access) ->
@ -107,93 +193,805 @@ create_node_permission(Host, ServerHost, _Node, _ParentNode, Owner, Access) ->
end, end,
{result, Allowed}. {result, Allowed}.
%% @spec (NodeId, Owner) ->
%% {result, Result} | exit
%% NodeId = mod_pubsub:pubsubNodeId()
%% Owner = mod_pubsub:jid()
%% @doc <p></p>
create_node(NodeId, Owner) -> create_node(NodeId, Owner) ->
node_hometree:create_node(NodeId, Owner). OwnerKey = jlib:short_prepd_bare_jid(Owner),
set_state(#pubsub_state{stateid = {OwnerKey, NodeId}, affiliation = owner}),
{result, {default, broadcast}}.
%% @spec (Removed) -> ok
%% Removed = [mod_pubsub:pubsubNode()]
%% @doc <p>purge items of deleted nodes after effective deletion.</p>
delete_node(Removed) -> delete_node(Removed) ->
node_hometree:delete_node(Removed). Tr = fun(#pubsub_state{stateid = {J, _}, subscriptions = Ss}) ->
lists:map(fun(S) ->
{J, S}
end, Ss)
end,
Reply = lists:map(
fun(#pubsub_node{id = NodeId} = PubsubNode) ->
{result, States} = get_states(NodeId),
lists:foreach(
fun(#pubsub_state{stateid = {LJID, _}, items = Items}) ->
del_items(NodeId, Items),
del_state(NodeId, LJID)
end, States),
{PubsubNode, lists:flatmap(Tr, States)}
end, Removed),
{result, {default, broadcast, Reply}}.
subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> %% @spec (NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) ->
node_hometree:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). %% {error, Reason} | {result, Result}
%% @doc <p>Accepts or rejects subcription requests on a PubSub node.</p>
%% <p>The mechanism works as follow:
%% <ul>
%% <li>The main PubSub module prepares the subscription and passes the
%% result of the preparation as a record.</li>
%% <li>This function gets the prepared record and several other parameters and
%% can decide to:<ul>
%% <li>reject the subscription;</li>
%% <li>allow it as is, letting the main module perform the database
%% persistance;</li>
%% <li>allow it, modifying the record. The main module will store the
%% modified record;</li>
%% <li>allow it, but perform the needed persistance operations.</li></ul>
%% </li></ul></p>
%% <p>The selected behaviour depends on the return parameter:
%% <ul>
%% <li><tt>{error, Reason}</tt>: an IQ error result will be returned. No
%% subscription will actually be performed.</li>
%% <li><tt>true</tt>: Subscribe operation is allowed, based on the
%% unmodified record passed in parameter <tt>SubscribeResult</tt>. If this
%% parameter contains an error, no subscription will be performed.</li>
%% <li><tt>{true, PubsubState}</tt>: Subscribe operation is allowed, but
%% the {@link mod_pubsub:pubsubState()} record returned replaces the value
%% passed in parameter <tt>SubscribeResult</tt>.</li>
%% <li><tt>{true, done}</tt>: Subscribe operation is allowed, but the
%% {@link mod_pubsub:pubsubState()} will be considered as already stored and
%% no further persistance operation will be performed. This case is used,
%% when the plugin module is doing the persistance by itself or when it want
%% to completly disable persistance.</li></ul>
%% </p>
%% <p>In the default plugin module, the record is unchanged.</p>
subscribe_node(NodeId, Sender, {U,S,R} = Subscriber, AccessModel,
SendLast, PresenceSubscription, RosterGroup, Options) ->
SubKey = {U, S, R},
GenKey = {U, S, undefined},
Authorized = (jlib:short_prepd_bare_jid(Sender) == GenKey),
GenState = get_state(NodeId, GenKey),
SubState = case SubKey of
GenKey -> GenState;
_ -> get_state(NodeId, SubKey)
end,
Affiliation = GenState#pubsub_state.affiliation,
Subscriptions = SubState#pubsub_state.subscriptions,
Whitelisted = lists:member(Affiliation, [member, publisher, owner]),
PendingSubscription = lists:any(fun({pending, _}) -> true;
(_) -> false
end, Subscriptions),
if
not Authorized ->
%% JIDs do not match
{error, ?ERR_EXTENDED('bad-request', "invalid-jid")};
Affiliation == outcast ->
%% Requesting entity is blocked
{error, 'forbidden'};
PendingSubscription ->
%% Requesting entity has pending subscription
{error, ?ERR_EXTENDED('not-authorized', "pending-subscription")};
(AccessModel == presence) and (not PresenceSubscription) ->
%% Entity is not authorized to create a subscription (presence subscription required)
{error, ?ERR_EXTENDED('not-authorized', "presence-subscription-required")};
(AccessModel == roster) and (not RosterGroup) ->
%% Entity is not authorized to create a subscription (not in roster group)
{error, ?ERR_EXTENDED('not-authorized', "not-in-roster-group")};
(AccessModel == whitelist) and (not Whitelisted) ->
%% Node has whitelist access model and entity lacks required affiliation
{error, ?ERR_EXTENDED('not-allowed', "closed-node")};
%%MustPay ->
%% % Payment is required for a subscription
%% {error, ?ERR_PAYMENT_REQUIRED};
%%ForbiddenAnonymous ->
%% % Requesting entity is anonymous
%% {error, 'forbidden'};
true ->
case pubsub_subscription:subscribe_node(Subscriber, NodeId, Options) of
{result, SubId} ->
NewSub = case AccessModel of
authorize -> pending;
_ -> subscribed
end,
set_state(SubState#pubsub_state{subscriptions = [{NewSub, SubId} | Subscriptions]}),
case {NewSub, SendLast} of
{subscribed, never} ->
{result, {default, subscribed, SubId}};
{subscribed, _} ->
{result, {default, subscribed, SubId, send_last}};
{_, _} ->
{result, {default, pending, SubId}}
end;
_ ->
{error, 'internal-server-error'}
end
end.
unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> %% @spec (NodeId, Sender, Subscriber, SubId) ->
node_hometree:unsubscribe_node(NodeId, Sender, Subscriber, SubID). %% {error, Reason} | {result, []}
%% NodeId = mod_pubsub:pubsubNodeId()
%% Sender = mod_pubsub:jid()
%% Subscriber = mod_pubsub:jid()
%% SubId = mod_pubsub:subid()
%% Reason = mod_pubsub:stanzaError()
%% @doc <p>Unsubscribe the <tt>Subscriber</tt> from the <tt>Node</tt>.</p>
unsubscribe_node(NodeId, Sender, {U, S, R} = Subscriber, SubId) ->
SubKey = {U, S, R},
GenKey = {U, S, undefined},
Authorized = (jlib:short_prepd_bare_jid(Sender) == GenKey),
GenState = get_state(NodeId, GenKey),
SubState = case SubKey of
GenKey -> GenState;
_ -> get_state(NodeId, SubKey)
end,
Subscriptions = lists:filter(fun({_Sub, _SubId}) -> true;
(_SubId) -> false
end, SubState#pubsub_state.subscriptions),
SubIdExists = case SubId of
[] -> false;
List when is_list(List) -> true;
_ -> false
end,
if
%% Requesting entity is prohibited from unsubscribing entity
not Authorized ->
{error, 'forbidden'};
%% Entity did not specify SubId
%%SubId == "", ?? ->
%% {error, ?ERR_EXTENDED('bad-request', "subid-required")};
%% Invalid subscription identifier
%%InvalidSubId ->
%% {error, ?ERR_EXTENDED('not-acceptable', "invalid-subid")};
%% Requesting entity is not a subscriber
Subscriptions == [] ->
{error, ?ERR_EXTENDED('unexpected-request', "not-subscribed")};
%% Subid supplied, so use that.
SubIdExists ->
Sub = first_in_list(fun({_, Id}) when Id == SubId -> true;
(_) -> false
end, Subscriptions),
case Sub of
{value, Subscribed} ->
delete_subscriptions(Subscriber, NodeId, [Subscribed], SubState),
{result, default};
false ->
{error, ?ERR_EXTENDED('unexpected-request', "not-subscribed")}
end;
%% Asking to remove all subscriptions to the given node
SubId == all ->
delete_subscriptions(SubKey, NodeId, Subscriptions, SubState),
{result, default};
%% No subid supplied, but there's only one matching
%% subscription, so use that.
length(Subscriptions) == 1 ->
delete_subscriptions(SubKey, NodeId, Subscriptions, SubState),
{result, default};
true ->
{error, ?ERR_EXTENDED('bad-request', "subid-required")}
end.
publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> delete_subscriptions(SubKey, NodeId, Subscriptions, SubState) ->
node_hometree:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). NewSubs = lists:foldl(fun({Subscription, SubId}, Acc) ->
pubsub_subscription:delete_subscription(SubKey, NodeId, SubId),
Acc -- [{Subscription, SubId}]
end, SubState#pubsub_state.subscriptions, Subscriptions),
case {SubState#pubsub_state.affiliation, NewSubs} of
{none, []} ->
% Just a regular subscriber, and this is final item, so
% delete the state.
del_state(NodeId, SubKey);
_ ->
set_state(SubState#pubsub_state{subscriptions = NewSubs})
end.
%% @spec (NodeId, Publisher, PublishModel, MaxItems, ItemId, Payload) ->
%% {true, PubsubItem} | {result, Reply}
%% NodeId = mod_pubsub:pubsubNodeId()
%% Publisher = mod_pubsub:jid()
%% PublishModel = atom()
%% MaxItems = integer()
%% ItemId = string()
%% Payload = term()
%% @doc <p>Publishes the item passed as parameter.</p>
%% <p>The mechanism works as follow:
%% <ul>
%% <li>The main PubSub module prepares the item to publish and passes the
%% result of the preparation as a {@link mod_pubsub:pubsubItem()} record.</li>
%% <li>This function gets the prepared record and several other parameters and can decide to:<ul>
%% <li>reject the publication;</li>
%% <li>allow the publication as is, letting the main module perform the database persistance;</li>
%% <li>allow the publication, modifying the record. The main module will store the modified record;</li>
%% <li>allow it, but perform the needed persistance operations.</li></ul>
%% </li></ul></p>
%% <p>The selected behaviour depends on the return parameter:
%% <ul>
%% <li><tt>{error, Reason}</tt>: an iq error result will be return. No
%% publication is actually performed.</li>
%% <li><tt>true</tt>: Publication operation is allowed, based on the
%% unmodified record passed in parameter <tt>Item</tt>. If the <tt>Item</tt>
%% parameter contains an error, no subscription will actually be
%% performed.</li>
%% <li><tt>{true, Item}</tt>: Publication operation is allowed, but the
%% {@link mod_pubsub:pubsubItem()} record returned replaces the value passed
%% in parameter <tt>Item</tt>. The persistance will be performed by the main
%% module.</li>
%% <li><tt>{true, done}</tt>: Publication operation is allowed, but the
%% {@link mod_pubsub:pubsubItem()} will be considered as already stored and
%% no further persistance operation will be performed. This case is used,
%% when the plugin module is doing the persistance by itself or when it want
%% to completly disable persistance.</li></ul>
%% </p>
%% <p>In the default plugin module, the record is unchanged.</p>
publish_item(NodeId, Publisher, PublishModel, MaxItems, ItemId, Payload) ->
SubKey = jlib:short_prepd_jid(Publisher),
GenKey = jlib:short_prepd_bare_jid(Publisher),
GenState = get_state(NodeId, GenKey),
SubState = case SubKey of
GenKey -> GenState;
_ -> get_state(NodeId, SubKey)
end,
Affiliation = GenState#pubsub_state.affiliation,
Subscribed = case PublishModel of
subscribers -> is_subscribed(SubState#pubsub_state.subscriptions);
_ -> undefined
end,
if
not ((PublishModel == open)
or ((PublishModel == publishers)
and ((Affiliation == owner) or (Affiliation == publisher)))
or (Subscribed == true)) ->
%% Entity does not have sufficient privileges to publish to node
{error, 'forbidden'};
true ->
%% TODO: check creation, presence, roster
if MaxItems > 0 ->
Now = now(),
PubId = {Now, SubKey},
Item = case get_item(NodeId, ItemId) of
{result, OldItem} ->
OldItem#pubsub_item{modification = PubId,
payload = Payload};
_ ->
#pubsub_item{itemid = {ItemId, NodeId},
creation = {Now, GenKey},
modification = PubId,
payload = Payload}
end,
Items = [ItemId | GenState#pubsub_state.items--[ItemId]],
{result, {NI, OI}} = remove_extra_items(NodeId, MaxItems, Items),
set_item(Item),
set_state(GenState#pubsub_state{items = NI}),
{result, {default, broadcast, OI}};
true ->
{result, {default, broadcast, []}}
end
end.
%% @spec (NodeId, MaxItems, ItemIds) -> {NewItemIds,OldItemIds}
%% NodeId = mod_pubsub:pubsubNodeId()
%% MaxItems = integer() | unlimited
%% ItemIds = [ItemId::string()]
%% NewItemIds = [ItemId::string()]
%% @doc <p>This function is used to remove extra items, most notably when the
%% maximum number of items has been reached.</p>
%% <p>This function is used internally by the core PubSub module, as no
%% permission check is performed.</p>
%% <p>In the default plugin module, the oldest items are removed, but other
%% rules can be used.</p>
%% <p>If another PubSub plugin wants to delegate the item removal (and if the
%% plugin is using the default pubsub storage), it can implements this function like this:
%% ```remove_extra_items(NodeId, MaxItems, ItemIds) ->
%% node_default:remove_extra_items(NodeId, MaxItems, ItemIds).'''</p>
remove_extra_items(_NodeId, unlimited, ItemIds) ->
{result, {ItemIds, []}};
remove_extra_items(NodeId, MaxItems, ItemIds) -> remove_extra_items(NodeId, MaxItems, ItemIds) ->
node_hometree:remove_extra_items(NodeId, MaxItems, ItemIds). NewItems = lists:sublist(ItemIds, MaxItems),
OldItems = lists:nthtail(length(NewItems), ItemIds),
%% Remove extra items:
del_items(NodeId, OldItems),
%% Return the new items list:
{result, {NewItems, OldItems}}.
%% @spec (NodeId, Publisher, PublishModel, ItemId) ->
%% {error, Reason::stanzaError()} |
%% {result, []}
%% NodeId = mod_pubsub:pubsubNodeId()
%% Publisher = mod_pubsub:jid()
%% PublishModel = atom()
%% ItemId = string()
%% @doc <p>Triggers item deletion.</p>
%% <p>Default plugin: The user performing the deletion must be the node owner
%% or a publisher, or PublishModel being open.</p>
delete_item(NodeId, Publisher, PublishModel, ItemId) -> delete_item(NodeId, Publisher, PublishModel, ItemId) ->
node_hometree:delete_item(NodeId, Publisher, PublishModel, ItemId). GenKey = jlib:short_prepd_bare_jid(Publisher),
GenState = get_state(NodeId, GenKey),
#pubsub_state{affiliation = Affiliation, items = Items} = GenState,
Allowed = (Affiliation == publisher) orelse (Affiliation == owner)
orelse (PublishModel == open)
orelse case get_item(NodeId, ItemId) of
{result, #pubsub_item{creation = {_, GenKey}}} -> true;
_ -> false
end,
if
not Allowed ->
%% Requesting entity does not have sufficient privileges
{error, 'forbidden'};
true ->
case lists:member(ItemId, Items) of
true ->
del_item(NodeId, ItemId),
set_state(GenState#pubsub_state{items = lists:delete(ItemId, Items)}),
{result, {default, broadcast}};
false ->
case Affiliation of
owner ->
%% Owner can delete other publishers items as well
{result, States} = get_states(NodeId),
lists:foldl(
fun(#pubsub_state{items = PI, affiliation = publisher} = S, Res) ->
case lists:member(ItemId, PI) of
true ->
del_item(NodeId, ItemId),
set_state(S#pubsub_state{items = lists:delete(ItemId, PI)}),
{result, {default, broadcast}};
false ->
Res
end;
(_, Res) ->
Res
end, {error, 'item-not-found'}, States);
_ ->
%% Non-existent node or item
{error, 'item-not-found'}
end
end
end.
%% @spec (NodeId, Owner) ->
%% {error, Reason::stanzaError()} |
%% {result, {default, broadcast}}
%% NodeId = mod_pubsub:pubsubNodeId()
%% Owner = mod_pubsub:jid()
purge_node(NodeId, Owner) -> purge_node(NodeId, Owner) ->
node_hometree:purge_node(NodeId, Owner). GenKey = jlib:short_prepd_bare_jid(Owner),
GenState = get_state(NodeId, GenKey),
case GenState of
#pubsub_state{affiliation = owner} ->
{result, States} = get_states(NodeId),
lists:foreach(
fun(#pubsub_state{items = []}) ->
ok;
(#pubsub_state{items = Items} = S) ->
del_items(NodeId, Items),
set_state(S#pubsub_state{items = []})
end, States),
{result, {default, broadcast}};
_ ->
%% Entity is not owner
{error, 'forbidden'}
end.
%% @spec (Host, JID) -> [{Node,Affiliation}]
%% Host = host()
%% JID = mod_pubsub:jid()
%% @doc <p>Return the current affiliations for the given user</p>
%% <p>The default module reads affiliations in the main Mnesia
%% <tt>pubsub_state</tt> table. If a plugin stores its data in the same
%% table, it should return an empty list, as the affiliation will be read by
%% the default PubSub module. Otherwise, it should return its own affiliation,
%% that will be added to the affiliation stored in the main
%% <tt>pubsub_state</tt> table.</p>
get_entity_affiliations(Host, Owner) -> get_entity_affiliations(Host, Owner) ->
node_hometree:get_entity_affiliations(Host, Owner). GenKey = jlib:short_prepd_bare_jid(Owner),
States = mnesia:match_object(#pubsub_state{stateid = {GenKey, '_'}, _ = '_'}),
NodeTree = case catch ets:lookup(gen_mod:get_module_proc(Host, config), nodetree) of
[{nodetree, N}] -> N;
_ -> nodetree_tree
end,
Reply = lists:foldl(fun(#pubsub_state{stateid = {_, N}, affiliation = A}, Acc) ->
case NodeTree:get_node(N) of
#pubsub_node{nodeid = {Host, _}} = Node -> [{Node, A}|Acc];
_ -> Acc
end
end, [], States),
{result, Reply}.
get_node_affiliations(NodeId) -> get_node_affiliations(NodeId) ->
node_hometree:get_node_affiliations(NodeId). {result, States} = get_states(NodeId),
Tr = fun(#pubsub_state{stateid = {J, _}, affiliation = A}) ->
{J, A}
end,
{result, lists:map(Tr, States)}.
get_affiliation(NodeId, Owner) -> get_affiliation(NodeId, Owner) ->
node_hometree:get_affiliation(NodeId, Owner). GenKey = jlib:short_prepd_bare_jid(Owner),
GenState = get_state(NodeId, GenKey),
{result, GenState#pubsub_state.affiliation}.
set_affiliation(NodeId, Owner, Affiliation) -> set_affiliation(NodeId, Owner, Affiliation) when ?IS_JID(Owner)->
node_hometree:set_affiliation(NodeId, Owner, Affiliation). GenKey = jlib:short_prepd_bare_jid(Owner),
GenState = get_state(NodeId, GenKey),
case {Affiliation, GenState#pubsub_state.subscriptions} of
{none, none} ->
del_state(NodeId, GenKey);
_ ->
set_state(GenState#pubsub_state{affiliation = Affiliation})
end.
%% @spec (Host, Owner) -> [{Node,Subscription}]
%% Host = host()
%% Owner = mod_pubsub:jid()
%% @doc <p>Return the current subscriptions for the given user</p>
%% <p>The default module reads subscriptions in the main Mnesia
%% <tt>pubsub_state</tt> table. If a plugin stores its data in the same
%% table, it should return an empty list, as the affiliation will be read by
%% the default PubSub module. Otherwise, it should return its own affiliation,
%% that will be added to the affiliation stored in the main
%% <tt>pubsub_state</tt> table.</p>
get_entity_subscriptions(Host, Owner) -> get_entity_subscriptions(Host, Owner) ->
node_hometree:get_entity_subscriptions(Host, Owner). {U, D, _} = SubKey = jlib:short_prepd_jid(Owner),
GenKey = jlib:short_prepd_bare_jid(Owner),
States = case SubKey of
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 = case catch ets:lookup(gen_mod:get_module_proc(Host, config), nodetree) of
[{nodetree, N}] -> N;
_ -> nodetree_tree
end,
Reply = lists:foldl(fun(#pubsub_state{stateid = {J, N}, subscriptions = Ss}, Acc) ->
case NodeTree:get_node(N) of
#pubsub_node{nodeid = {Host, _}} = Node ->
lists:foldl(fun({Sub, SubId}, Acc2) ->
[{Node, Sub, SubId, J} | Acc2];
(S, Acc2) ->
[{Node, S, J} | Acc2]
end, Acc, Ss);
_ -> Acc
end
end, [], States),
{result, Reply}.
get_node_subscriptions(NodeId) -> get_node_subscriptions(NodeId) ->
node_hometree:get_node_subscriptions(NodeId). {result, States} = get_states(NodeId),
Tr = fun(#pubsub_state{stateid = {J, _}, subscriptions = Subscriptions}) ->
%% TODO: get rid of cases to handle non-list subscriptions
case Subscriptions of
[_|_] ->
lists:foldl(fun({S, SubId}, Acc) ->
[{J, S, SubId} | Acc];
(S, Acc) ->
[{J, S} | Acc]
end, [], Subscriptions);
[] ->
[];
_ ->
[{J, none}]
end
end,
{result, lists:flatmap(Tr, States)}.
get_subscriptions(NodeId, Owner) -> get_subscriptions(NodeId, Owner) ->
node_hometree:get_subscriptions(NodeId, Owner). SubKey = jlib:short_prepd_jid(Owner),
SubState = get_state(NodeId, SubKey),
{result, SubState#pubsub_state.subscriptions}.
set_subscriptions(NodeId, Owner, Subscription, SubId) -> set_subscriptions(NodeId, Owner, Subscription, SubId) ->
node_hometree:set_subscriptions(NodeId, Owner, Subscription, SubId). SubKey = jlib:short_prepd_jid(Owner),
SubState = get_state(NodeId, SubKey),
case {SubId, SubState#pubsub_state.subscriptions} of
{_, []} ->
case Subscription of
none -> {error, ?ERR_EXTENDED('bad_request', "not-subscribed")};
_ -> new_subscription(NodeId, Owner, Subscription, SubState)
end;
{"", [{_, SID}]} ->
case Subscription of
none -> unsub_with_subid(NodeId, SID, SubState);
_ -> replace_subscription({Subscription, SID}, SubState)
end;
{"", [_|_]} ->
{error, ?ERR_EXTENDED('bad_request', "subid-required")};
_ ->
case Subscription of
none -> unsub_with_subid(NodeId, SubId, SubState);
_ -> replace_subscription({Subscription, SubId}, SubState)
end
end.
replace_subscription(NewSub, SubState) ->
NewSubs = replace_subscription(NewSub,
SubState#pubsub_state.subscriptions, []),
set_state(SubState#pubsub_state{subscriptions = NewSubs}).
replace_subscription(_, [], Acc) ->
Acc;
replace_subscription({Sub, SubId}, [{_, SubID} | T], Acc) ->
replace_subscription({Sub, SubId}, T, [{Sub, SubID} | Acc]).
new_subscription(NodeId, Owner, Subscription, SubState) ->
SubId = pubsub_subscription:add_subscription(Owner, NodeId, []),
Subscriptions = SubState#pubsub_state.subscriptions,
set_state(SubState#pubsub_state{subscriptions = [{Subscription, SubId} | Subscriptions]}),
{Subscription, SubId}.
unsub_with_subid(NodeId, SubId, SubState) ->
pubsub_subscription:delete_subscription(SubState#pubsub_state.stateid,
NodeId, SubId),
NewSubs = lists:filter(fun ({_, SID}) -> SubId =/= SID end,
SubState#pubsub_state.subscriptions),
case {NewSubs, SubState#pubsub_state.affiliation} of
{[], none} ->
del_state(NodeId, element(1, SubState#pubsub_state.stateid));
_ ->
set_state(SubState#pubsub_state{subscriptions = NewSubs})
end.
%% @spec (Host, Owner) -> {result, [Node]} | {error, Reason}
%% Host = host()
%% Owner = jid()
%% Node = pubsubNode()
%% @doc <p>Returns a list of Owner's nodes on Host with pending
%% subscriptions.</p>
get_pending_nodes(Host, Owner) -> get_pending_nodes(Host, Owner) ->
node_hometree:get_pending_nodes(Host, Owner). GenKey = jlib:jid_remove_resource(jlib:jid_tolower(Owner)),
States = mnesia:match_object(#pubsub_state{stateid = {GenKey, '_'},
affiliation = owner,
_ = '_'}),
NodeIDs = [ID || #pubsub_state{stateid = {_, ID}} <- States],
NodeTree = case catch ets:lookup(gen_mod:get_module_proc(Host, config), nodetree) of
[{nodetree, N}] -> N;
_ -> nodetree_tree
end,
Reply = mnesia:foldl(fun(#pubsub_state{stateid = {_, NID}} = S, Acc) ->
case lists:member(NID, NodeIDs) of
true ->
case get_nodes_helper(NodeTree, S) of
{value, Node} -> [Node | Acc];
false -> Acc
end;
false ->
Acc
end
end, [], pubsub_state),
{result, Reply}.
get_nodes_helper(NodeTree,
#pubsub_state{stateid = {_, N}, subscriptions = Subs}) ->
HasPending = fun ({pending, _}) -> true;
(pending) -> true;
(_) -> false
end,
case lists:any(HasPending, Subs) of
true ->
case NodeTree:get_node(N) of
#pubsub_node{nodeid = {_, Node}} ->
{value, Node};
_ ->
false
end;
false ->
false
end.
%% @spec (NodeId) -> {result, [State] | []}
%% NodeId = mod_pubsub:pubsubNodeId()
%% State = mod_pubsub:pubsubState()
%% @doc Returns the list of stored states for a given node.
%% <p>For the default PubSub module, states are stored in Mnesia database.</p>
%% <p>We can consider that the pubsub_state table have been created by the main
%% mod_pubsub module.</p>
%% <p>PubSub plugins can store the states where they wants (for example in a
%% relational database).</p>
%% <p>If a PubSub plugin wants to delegate the states storage to the default node,
%% they can implement this function like this:
%% ```get_states(NodeId) ->
%% node_default:get_states(NodeId).'''</p>
get_states(NodeId) -> get_states(NodeId) ->
node_hometree:get_states(NodeId). States = case catch mnesia:match_object(
#pubsub_state{stateid = {'_', NodeId}, _ = '_'}) of
List when is_list(List) -> List;
_ -> []
end,
{result, States}.
%% @spec (NodeId, JID) -> [State] | []
%% NodeId = mod_pubsub:pubsubNodeId()
%% JID = mod_pubsub:jid()
%% State = mod_pubsub:pubsubItems()
%% @doc <p>Returns a state (one state list), given its reference.</p>
get_state(NodeId, JID) -> get_state(NodeId, JID) ->
node_hometree:get_state(NodeId, JID). StateId = {JID, NodeId},
case catch mnesia:read({pubsub_state, StateId}) of
[State] when is_record(State, pubsub_state) -> State;
_ -> #pubsub_state{stateid=StateId}
end.
set_state(State) -> %% @spec (State) -> ok | {error, Reason::stanzaError()}
node_hometree:set_state(State). %% State = mod_pubsub:pubsubStates()
%% @doc <p>Write a state into database.</p>
set_state(State) when is_record(State, pubsub_state) ->
mnesia:write(State);
set_state(_) ->
{error, 'internal-server-error'}.
get_items(NodeId, From) -> %% @spec (NodeId, JID) -> ok | {error, Reason::stanzaError()}
node_hometree:get_items(NodeId, From). %% NodeId = mod_pubsub:pubsubNodeId()
%% @doc <p>Delete a state from database.</p>
del_state(NodeId, JID) ->
mnesia:delete({pubsub_state, {JID, NodeId}}).
get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> %% @spec (NodeId, From) -> [Items] | []
node_hometree:get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). %% NodeId = mod_pubsub:pubsubNodeId()
%% Items = mod_pubsub:pubsubItems()
%% @doc Returns the list of stored items for a given node.
%% <p>For the default PubSub module, items are stored in Mnesia database.</p>
%% <p>We can consider that the pubsub_item table have been created by the main
%% mod_pubsub module.</p>
%% <p>PubSub plugins can store the items where they wants (for example in a
%% relational database), or they can even decide not to persist any items.</p>
%% <p>If a PubSub plugin wants to delegate the item storage to the default node,
%% they can implement this function like this:
%% ```get_items(NodeId, From) ->
%% node_default:get_items(NodeId, From).'''</p>
get_items(NodeId, _From) ->
Items = mnesia:match_object(#pubsub_item{itemid = {'_', NodeId}, _ = '_'}),
{result, lists:reverse(lists:keysort(#pubsub_item.modification, Items))}.
get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, _SubId) ->
SubKey = jlib:short_prepd_jid(JID),
GenKey = jlib:short_prepd_bare_jid(JID),
GenState = get_state(NodeId, GenKey),
SubState = get_state(NodeId, SubKey),
Affiliation = GenState#pubsub_state.affiliation,
Subscriptions = SubState#pubsub_state.subscriptions,
Whitelisted = can_fetch_item(Affiliation, Subscriptions),
if
%%SubId == "", ?? ->
%% Entity has multiple subscriptions to the node but does not specify a subscription ID
%{error, ?ERR_EXTENDED('bad-request', "subid-required")};
%%InvalidSubId ->
%% Entity is subscribed but specifies an invalid subscription ID
%{error, ?ERR_EXTENDED('not-acceptable', "invalid-subid")};
Affiliation == outcast ->
%% Requesting entity is blocked
{error, 'forbidden'};
(AccessModel == presence) and (not PresenceSubscription) ->
%% Entity is not authorized to create a subscription (presence subscription required)
{error, ?ERR_EXTENDED('not-authorized', "presence-subscription-required")};
(AccessModel == roster) and (not RosterGroup) ->
%% Entity is not authorized to create a subscription (not in roster group)
{error, ?ERR_EXTENDED('not-authorized', "not-in-roster-group")};
(AccessModel == whitelist) and (not Whitelisted) ->
%% Node has whitelist access model and entity lacks required affiliation
{error, ?ERR_EXTENDED('not-allowed', "closed-node")};
(AccessModel == authorize) and (not Whitelisted) ->
%% Node has authorize access model
{error, 'forbidden'};
%%MustPay ->
%% % Payment is required for a subscription
%% {error, ?ERR_PAYMENT_REQUIRED};
true ->
get_items(NodeId, JID)
end.
%% @spec (NodeId, ItemId) -> [Item] | []
%% NodeId = mod_pubsub:pubsubNodeId()
%% ItemId = string()
%% Item = mod_pubsub:pubsubItems()
%% @doc <p>Returns an item (one item list), given its reference.</p>
get_item(NodeId, ItemId) -> get_item(NodeId, ItemId) ->
node_hometree:get_item(NodeId, ItemId). case mnesia:read({pubsub_item, {ItemId, NodeId}}) of
[Item] when is_record(Item, pubsub_item) ->
{result, Item};
_ ->
{error, 'item-not-found'}
end.
get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, _SubId) ->
GenKey = jlib:short_prepd_bare_jid(JID),
GenState = get_state(NodeId, GenKey),
Affiliation = GenState#pubsub_state.affiliation,
Subscriptions = GenState#pubsub_state.subscriptions,
Whitelisted = can_fetch_item(Affiliation, Subscriptions),
if
%%SubId == "", ?? ->
%% Entity has multiple subscriptions to the node but does not specify a subscription ID
%{error, ?ERR_EXTENDED('bad-request', "subid-required")};
%%InvalidSubID ->
%% Entity is subscribed but specifies an invalid subscription ID
%{error, ?ERR_EXTENDED('not-acceptable', "invalid-subid")};
Affiliation == outcast ->
%% Requesting entity is blocked
{error, 'forbidden'};
(AccessModel == presence) and (not PresenceSubscription) ->
%% Entity is not authorized to create a subscription (presence subscription required)
{error, ?ERR_EXTENDED('not-authorized', "presence-subscription-required")};
(AccessModel == roster) and (not RosterGroup) ->
%% Entity is not authorized to create a subscription (not in roster group)
{error, ?ERR_EXTENDED('not-authorized', "not-in-roster-group")};
(AccessModel == whitelist) and (not Whitelisted) ->
%% Node has whitelist access model and entity lacks required affiliation
{error, ?ERR_EXTENDED('not-allowed', "closed-node")};
(AccessModel == authorize) and (not Whitelisted) ->
%% Node has authorize access model
{error, 'forbidden'};
%%MustPay ->
%% % Payment is required for a subscription
%% {error, ?ERR_PAYMENT_REQUIRED};
true ->
get_item(NodeId, ItemId)
end.
get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> %% @spec (Item) -> ok | {error, Reason::stanzaError()}
node_hometree:get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). %% Item = mod_pubsub:pubsubItems()
%% @doc <p>Write an item into database.</p>
set_item(Item) when is_record(Item, pubsub_item) ->
mnesia:write(Item);
set_item(_) ->
{error, 'internal-server-error'}.
set_item(Item) -> %% @spec (NodeId, ItemId) -> ok | {error, Reason::stanzaError()}
node_hometree:set_item(Item). %% NodeId = mod_pubsub:pubsubNodeId()
%% ItemId = string()
%% @doc <p>Delete an item from database.</p>
del_item(NodeId, ItemId) ->
mnesia:delete({pubsub_item, {ItemId, NodeId}}).
del_items(NodeId, ItemIds) ->
lists:foreach(fun(ItemId) ->
del_item(NodeId, ItemId)
end, ItemIds).
get_item_name(Host, Node, Id) -> %% @doc <p>Return the name of the node if known: Default is to return
node_hometree:get_item_name(Host, Node, Id). %% node id.</p>
get_item_name(_Host, _Node, Id) ->
Id.
node_to_path(Node) -> node_to_path(Node) ->
[Node]. [list_to_binary(Item) || Item <- string:tokens(binary_to_list(Node), "/")].
path_to_node([]) ->
<<>>;
path_to_node(Path) -> path_to_node(Path) ->
case Path of list_to_binary(string:join([""|[binary_to_list(Item) || Item <- Path]], "/")).
% default slot
[Node] -> Node; %% @spec (Affiliation, Subscription) -> true | false
% handle old possible entries, used when migrating database content to new format %% Affiliation = owner | member | publisher | outcast | none
[Node|_] when is_list(Node) -> list_to_binary(string:join([""|Path], "/")); %% Subscription = subscribed | none
% default case (used by PEP for example) %% @doc Determines if the combination of Affiliation and Subscribed
_ -> list_to_binary(Path) %% are allowed to get items from a node.
can_fetch_item(owner, _) -> true;
can_fetch_item(member, _) -> true;
can_fetch_item(publisher, _) -> true;
can_fetch_item(outcast, _) -> false;
can_fetch_item(none, Subscriptions) -> is_subscribed(Subscriptions);
can_fetch_item(_Affiliation, _Subscription) -> false.
is_subscribed(Subscriptions) ->
lists:any(fun ({subscribed, _SubId}) -> true;
(_) -> false
end, Subscriptions).
%% Returns the first item where Pred() is true in List
first_in_list(_Pred, []) ->
false;
first_in_list(Pred, [H | T]) ->
case Pred(H) of
true -> {value, H};
_ -> first_in_list(Pred, T)
end. end.

62
src/mod_pubsub/node_flat_odbc.erl
View File

@ -67,10 +67,10 @@
init(Host, ServerHost, Opts) -> init(Host, ServerHost, Opts) ->
node_hometree_odbc:init(Host, ServerHost, Opts). node_flat_odbc:init(Host, ServerHost, Opts).
terminate(Host, ServerHost) -> terminate(Host, ServerHost) ->
node_hometree_odbc:terminate(Host, ServerHost). node_flat_odbc:terminate(Host, ServerHost).
options() -> options() ->
[{deliver_payloads, true}, [{deliver_payloads, true},
@ -94,9 +94,9 @@ options() ->
{rsm, true}]. {rsm, true}].
features() -> features() ->
node_hometree_odbc:features(). node_flat_odbc:features().
%% use same code as node_hometree_odbc, but do not limite node to %% use same code as node_flat_odbc, but do not limite node to
%% the home/localhost/user/... hierarchy %% the home/localhost/user/... hierarchy
%% any node is allowed %% any node is allowed
create_node_permission(Host, ServerHost, _Node, _ParentNode, Owner, Access) -> create_node_permission(Host, ServerHost, _Node, _ParentNode, Owner, Access) ->
@ -111,85 +111,85 @@ create_node_permission(Host, ServerHost, _Node, _ParentNode, Owner, Access) ->
{result, Allowed}. {result, Allowed}.
create_node(NodeId, Owner) -> create_node(NodeId, Owner) ->
node_hometree_odbc:create_node(NodeId, Owner). node_flat_odbc:create_node(NodeId, Owner).
delete_node(Removed) -> delete_node(Removed) ->
node_hometree_odbc:delete_node(Removed). node_flat_odbc:delete_node(Removed).
subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) ->
node_hometree_odbc:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). node_flat_odbc:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options).
unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> unsubscribe_node(NodeId, Sender, Subscriber, SubID) ->
node_hometree_odbc:unsubscribe_node(NodeId, Sender, Subscriber, SubID). node_flat_odbc:unsubscribe_node(NodeId, Sender, Subscriber, SubID).
publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) ->
node_hometree_odbc:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). node_flat_odbc:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload).
remove_extra_items(NodeId, MaxItems, ItemIds) -> remove_extra_items(NodeId, MaxItems, ItemIds) ->
node_hometree_odbc:remove_extra_items(NodeId, MaxItems, ItemIds). node_flat_odbc:remove_extra_items(NodeId, MaxItems, ItemIds).
delete_item(NodeId, Publisher, PublishModel, ItemId) -> delete_item(NodeId, Publisher, PublishModel, ItemId) ->
node_hometree_odbc:delete_item(NodeId, Publisher, PublishModel, ItemId). node_flat_odbc:delete_item(NodeId, Publisher, PublishModel, ItemId).
purge_node(NodeId, Owner) -> purge_node(NodeId, Owner) ->
node_hometree_odbc:purge_node(NodeId, Owner). node_flat_odbc:purge_node(NodeId, Owner).
get_entity_affiliations(Host, Owner) -> get_entity_affiliations(Host, Owner) ->
node_hometree_odbc:get_entity_affiliations(Host, Owner). node_flat_odbc:get_entity_affiliations(Host, Owner).
get_node_affiliations(NodeId) -> get_node_affiliations(NodeId) ->
node_hometree_odbc:get_node_affiliations(NodeId). node_flat_odbc:get_node_affiliations(NodeId).
get_affiliation(NodeId, Owner) -> get_affiliation(NodeId, Owner) ->
node_hometree_odbc:get_affiliation(NodeId, Owner). node_flat_odbc:get_affiliation(NodeId, Owner).
set_affiliation(NodeId, Owner, Affiliation) -> set_affiliation(NodeId, Owner, Affiliation) ->
node_hometree_odbc:set_affiliation(NodeId, Owner, Affiliation). node_flat_odbc:set_affiliation(NodeId, Owner, Affiliation).
get_entity_subscriptions(Host, Owner) -> get_entity_subscriptions(Host, Owner) ->
node_hometree_odbc:get_entity_subscriptions(Host, Owner). node_flat_odbc:get_entity_subscriptions(Host, Owner).
get_node_subscriptions(NodeId) -> get_node_subscriptions(NodeId) ->
node_hometree_odbc:get_node_subscriptions(NodeId). node_flat_odbc:get_node_subscriptions(NodeId).
get_subscriptions(NodeId, Owner) -> get_subscriptions(NodeId, Owner) ->
node_hometree_odbc:get_subscriptions(NodeId, Owner). node_flat_odbc:get_subscriptions(NodeId, Owner).
set_subscriptions(NodeId, Owner, Subscription, SubId) -> set_subscriptions(NodeId, Owner, Subscription, SubId) ->
node_hometree_odbc:set_subscriptions(NodeId, Owner, Subscription, SubId). node_flat_odbc:set_subscriptions(NodeId, Owner, Subscription, SubId).
get_pending_nodes(Host, Owner) -> get_pending_nodes(Host, Owner) ->
node_hometree_odbc:get_pending_nodes(Host, Owner). node_flat_odbc:get_pending_nodes(Host, Owner).
get_states(NodeId) -> get_states(NodeId) ->
node_hometree_odbc:get_states(NodeId). node_flat_odbc:get_states(NodeId).
get_state(NodeId, JID) -> get_state(NodeId, JID) ->
node_hometree_odbc:get_state(NodeId, JID). node_flat_odbc:get_state(NodeId, JID).
set_state(State) -> set_state(State) ->
node_hometree_odbc:set_state(State). node_flat_odbc:set_state(State).
get_items(NodeId, From) -> get_items(NodeId, From) ->
node_hometree_odbc:get_items(NodeId, From). node_flat_odbc:get_items(NodeId, From).
get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) ->
node_hometree_odbc:get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). node_flat_odbc:get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId).
get_item(NodeId, ItemId) -> get_item(NodeId, ItemId) ->
node_hometree_odbc:get_item(NodeId, ItemId). node_flat_odbc:get_item(NodeId, ItemId).
get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) ->
node_hometree_odbc:get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). node_flat_odbc:get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId).
set_item(Item) -> set_item(Item) ->
node_hometree_odbc:set_item(Item). node_flat_odbc:set_item(Item).
get_item_name(Host, Node, Id) -> get_item_name(Host, Node, Id) ->
node_hometree_odbc:get_item_name(Host, Node, Id). node_flat_odbc:get_item_name(Host, Node, Id).
get_last_items(NodeId, From, Count) -> get_last_items(NodeId, From, Count) ->
node_hometree_odbc:get_last_items(NodeId, From, Count). node_flat_odbc:get_last_items(NodeId, From, Count).
node_to_path(Node) -> node_to_path(Node) ->
node_flat:node_to_path(Node). node_flat:node_to_path(Node).

896
src/mod_pubsub/node_hometree.erl
View File

@ -15,7 +15,6 @@
%%% All Rights Reserved.'' %%% All Rights Reserved.''
%%% This software is copyright 2006-2010, ProcessOne. %%% This software is copyright 2006-2010, ProcessOne.
%%% %%%
%%%
%%% @copyright 2006-2010 ProcessOne %%% @copyright 2006-2010 ProcessOne
%%% @author Christophe Romain <christophe.romain@process-one.net> %%% @author Christophe Romain <christophe.romain@process-one.net>
%%% [http://www.process-one.net/] %%% [http://www.process-one.net/]
@ -23,21 +22,6 @@
%%% @end %%% @end
%%% ==================================================================== %%% ====================================================================
%%% @todo The item table should be handled by the plugin, but plugin that do
%%% not want to manage it should be able to use the default behaviour.
%%% @todo Plugin modules should be able to register to receive presence update
%%% send to pubsub.
%%% @doc The module <strong>{@module}</strong> is the default PubSub plugin.
%%% <p>It is used as a default for all unknown PubSub node type. It can serve
%%% as a developer basis and reference to build its own custom pubsub node
%%% types.</p>
%%% <p>PubSub plugin nodes are using the {@link gen_node} behaviour.</p>
%%% <p><strong>The API isn't stabilized yet</strong>. The pubsub plugin
%%% development is still a work in progress. However, the system is already
%%% useable and useful as is. Please, send us comments, feedback and
%%% improvements.</p>
-module(node_hometree). -module(node_hometree).
-author('christophe.romain@process-one.net'). -author('christophe.romain@process-one.net').
@ -80,60 +64,13 @@
path_to_node/1 path_to_node/1
]). ]).
%% ================
%% API definition
%% ================
%% @spec (Host, ServerHost, Opts) -> any() init(Host, ServerHost, Opts) ->
%% Host = mod_pubsub:host() node_flat:init(Host, ServerHost, Opts).
%% ServerHost = mod_pubsub:host()
%% Opts = list()
%% @doc <p>Called during pubsub modules initialisation. Any pubsub plugin must
%% implement this function. It can return anything.</p>
%% <p>This function is mainly used to trigger the setup task necessary for the
%% plugin. It can be used for example by the developer to create the specific
%% module database schema if it does not exists yet.</p>
init(_Host, _ServerHost, _Opts) ->
pubsub_subscription:init(),
mnesia:create_table(pubsub_state,
[{disc_copies, [node()]},
{attributes, record_info(fields, pubsub_state)}]),
mnesia:create_table(pubsub_item,
[{disc_only_copies, [node()]},
{attributes, record_info(fields, pubsub_item)}]),
ItemsFields = record_info(fields, pubsub_item),
case mnesia:table_info(pubsub_item, attributes) of
ItemsFields -> ok;
_ ->
mnesia:transform_table(pubsub_item, ignore, ItemsFields)
end,
ok.
%% @spec (Host, ServerHost) -> any() terminate(Host, ServerHost) ->
%% Host = mod_pubsub:host() node_flat:terminate(Host, ServerHost).
%% ServerHost = host()
%% @doc <p>Called during pubsub modules termination. Any pubsub plugin must
%% implement this function. It can return anything.</p>
terminate(_Host, _ServerHost) ->
ok.
%% @spec () -> [Option]
%% Option = mod_pubsub:nodeOption()
%% @doc Returns the default pubsub node options.
%% <p>Example of function return value:</p>
%% ```
%% [{deliver_payloads, true},
%% {notify_config, false},
%% {notify_delete, false},
%% {notify_retract, true},
%% {persist_items, true},
%% {max_items, 10},
%% {subscribe, true},
%% {access_model, open},
%% {publish_model, publishers},
%% {max_payload_size, 100000},
%% {send_last_published_item, never},
%% {presence_based_delivery, false}]'''
options() -> options() ->
[{deliver_payloads, true}, [{deliver_payloads, true},
{notify_config, false}, {notify_config, false},
@ -153,31 +90,8 @@ options() ->
{deliver_notifications, true}, {deliver_notifications, true},
{presence_based_delivery, false}]. {presence_based_delivery, false}].
%% @spec () -> []
%% @doc Returns the node features
features() -> features() ->
["create-nodes", node_flat:features().
"auto-create",
"access-authorize",
"delete-nodes",
"delete-items",
"get-pending",
"instant-nodes",
"manage-subscriptions",
"modify-affiliations",
"multi-subscribe",
"outcast-affiliation",
"persistent-items",
"publish",
"purge-nodes",
"retract-items",
"retrieve-affiliations",
"retrieve-items",
"retrieve-subscriptions",
"subscribe",
"subscription-notifications",
"subscription-options"
].
%% @spec (Host, ServerHost, Node, ParentNode, Owner, Access) -> bool() %% @spec (Host, ServerHost, Node, ParentNode, Owner, Access) -> bool()
%% Host = mod_pubsub:host() %% Host = mod_pubsub:host()
@ -217,805 +131,93 @@ create_node_permission(Host, ServerHost, Node, _ParentNode, Owner, Access) ->
end, end,
{result, Allowed}. {result, Allowed}.
%% @spec (NodeId, Owner) ->
%% {result, Result} | exit
%% NodeId = mod_pubsub:pubsubNodeId()
%% Owner = mod_pubsub:jid()
%% @doc <p></p>
create_node(NodeId, Owner) -> create_node(NodeId, Owner) ->
OwnerKey = jlib:short_prepd_bare_jid(Owner), node_flat:create_node(NodeId, Owner).
set_state(#pubsub_state{stateid = {OwnerKey, NodeId}, affiliation = owner}),
{result, {default, broadcast}}.
%% @spec (Removed) -> ok
%% Removed = [mod_pubsub:pubsubNode()]
%% @doc <p>purge items of deleted nodes after effective deletion.</p>
delete_node(Removed) -> delete_node(Removed) ->
Tr = fun(#pubsub_state{stateid = {J, _}, subscriptions = Ss}) -> node_flat:delete_node(Removed).
lists:map(fun(S) ->
{J, S}
end, Ss)
end,
Reply = lists:map(
fun(#pubsub_node{id = NodeId} = PubsubNode) ->
{result, States} = get_states(NodeId),
lists:foreach(
fun(#pubsub_state{stateid = {LJID, _}, items = Items}) ->
del_items(NodeId, Items),
del_state(NodeId, LJID)
end, States),
{PubsubNode, lists:flatmap(Tr, States)}
end, Removed),
{result, {default, broadcast, Reply}}.
%% @spec (NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) ->
%% {error, Reason} | {result, Result} node_flat:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options).
%% @doc <p>Accepts or rejects subcription requests on a PubSub node.</p>
%% <p>The mechanism works as follow:
%% <ul>
%% <li>The main PubSub module prepares the subscription and passes the
%% result of the preparation as a record.</li>
%% <li>This function gets the prepared record and several other parameters and
%% can decide to:<ul>
%% <li>reject the subscription;</li>
%% <li>allow it as is, letting the main module perform the database
%% persistance;</li>
%% <li>allow it, modifying the record. The main module will store the
%% modified record;</li>
%% <li>allow it, but perform the needed persistance operations.</li></ul>
%% </li></ul></p>
%% <p>The selected behaviour depends on the return parameter:
%% <ul>
%% <li><tt>{error, Reason}</tt>: an IQ error result will be returned. No
%% subscription will actually be performed.</li>
%% <li><tt>true</tt>: Subscribe operation is allowed, based on the
%% unmodified record passed in parameter <tt>SubscribeResult</tt>. If this
%% parameter contains an error, no subscription will be performed.</li>
%% <li><tt>{true, PubsubState}</tt>: Subscribe operation is allowed, but
%% the {@link mod_pubsub:pubsubState()} record returned replaces the value
%% passed in parameter <tt>SubscribeResult</tt>.</li>
%% <li><tt>{true, done}</tt>: Subscribe operation is allowed, but the
%% {@link mod_pubsub:pubsubState()} will be considered as already stored and
%% no further persistance operation will be performed. This case is used,
%% when the plugin module is doing the persistance by itself or when it want
%% to completly disable persistance.</li></ul>
%% </p>
%% <p>In the default plugin module, the record is unchanged.</p>
subscribe_node(NodeId, Sender, {U,S,R} = Subscriber, AccessModel,
SendLast, PresenceSubscription, RosterGroup, Options) ->
SubKey = {U, S, R},
GenKey = {U, S, undefined},
Authorized = (jlib:short_prepd_bare_jid(Sender) == GenKey),
GenState = get_state(NodeId, GenKey),
SubState = case SubKey of
GenKey -> GenState;
_ -> get_state(NodeId, SubKey)
end,
Affiliation = GenState#pubsub_state.affiliation,
Subscriptions = SubState#pubsub_state.subscriptions,
Whitelisted = lists:member(Affiliation, [member, publisher, owner]),
PendingSubscription = lists:any(fun({pending, _}) -> true;
(_) -> false
end, Subscriptions),
if
not Authorized ->
%% JIDs do not match
{error, ?ERR_EXTENDED('bad-request', "invalid-jid")};
Affiliation == outcast ->
%% Requesting entity is blocked
{error, 'forbidden'};
PendingSubscription ->
%% Requesting entity has pending subscription
{error, ?ERR_EXTENDED('not-authorized', "pending-subscription")};
(AccessModel == presence) and (not PresenceSubscription) ->
%% Entity is not authorized to create a subscription (presence subscription required)
{error, ?ERR_EXTENDED('not-authorized', "presence-subscription-required")};
(AccessModel == roster) and (not RosterGroup) ->
%% Entity is not authorized to create a subscription (not in roster group)
{error, ?ERR_EXTENDED('not-authorized', "not-in-roster-group")};
(AccessModel == whitelist) and (not Whitelisted) ->
%% Node has whitelist access model and entity lacks required affiliation
{error, ?ERR_EXTENDED('not-allowed', "closed-node")};
%%MustPay ->
%% % Payment is required for a subscription
%% {error, ?ERR_PAYMENT_REQUIRED};
%%ForbiddenAnonymous ->
%% % Requesting entity is anonymous
%% {error, 'forbidden'};
true ->
case pubsub_subscription:subscribe_node(Subscriber, NodeId, Options) of
{result, SubId} ->
NewSub = case AccessModel of
authorize -> pending;
_ -> subscribed
end,
set_state(SubState#pubsub_state{subscriptions = [{NewSub, SubId} | Subscriptions]}),
case {NewSub, SendLast} of
{subscribed, never} ->
{result, {default, subscribed, SubId}};
{subscribed, _} ->
{result, {default, subscribed, SubId, send_last}};
{_, _} ->
{result, {default, pending, SubId}}
end;
_ ->
{error, 'internal-server-error'}
end
end.
%% @spec (NodeId, Sender, Subscriber, SubId) -> unsubscribe_node(NodeId, Sender, Subscriber, SubID) ->
%% {error, Reason} | {result, []} node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubID).
%% NodeId = mod_pubsub:pubsubNodeId()
%% Sender = mod_pubsub:jid()
%% Subscriber = mod_pubsub:jid()
%% SubId = mod_pubsub:subid()
%% Reason = mod_pubsub:stanzaError()
%% @doc <p>Unsubscribe the <tt>Subscriber</tt> from the <tt>Node</tt>.</p>
unsubscribe_node(NodeId, Sender, {U, S, R} = Subscriber, SubId) ->
SubKey = {U, S, R},
GenKey = {U, S, undefined},
Authorized = (jlib:short_prepd_bare_jid(Sender) == GenKey),
GenState = get_state(NodeId, GenKey),
SubState = case SubKey of
GenKey -> GenState;
_ -> get_state(NodeId, SubKey)
end,
Subscriptions = lists:filter(fun({_Sub, _SubId}) -> true;
(_SubId) -> false
end, SubState#pubsub_state.subscriptions),
SubIdExists = case SubId of
[] -> false;
List when is_list(List) -> true;
_ -> false
end,
if
%% Requesting entity is prohibited from unsubscribing entity
not Authorized ->
{error, 'forbidden'};
%% Entity did not specify SubId
%%SubId == "", ?? ->
%% {error, ?ERR_EXTENDED('bad-request', "subid-required")};
%% Invalid subscription identifier
%%InvalidSubId ->
%% {error, ?ERR_EXTENDED('not-acceptable', "invalid-subid")};
%% Requesting entity is not a subscriber
Subscriptions == [] ->
{error, ?ERR_EXTENDED('unexpected-request', "not-subscribed")};
%% Subid supplied, so use that.
SubIdExists ->
Sub = first_in_list(fun({_, Id}) when Id == SubId -> true;
(_) -> false
end, Subscriptions),
case Sub of
{value, Subscribed} ->
delete_subscriptions(Subscriber, NodeId, [Subscribed], SubState),
{result, default};
false ->
{error, ?ERR_EXTENDED('unexpected-request', "not-subscribed")}
end;
%% Asking to remove all subscriptions to the given node
SubId == all ->
delete_subscriptions(SubKey, NodeId, Subscriptions, SubState),
{result, default};
%% No subid supplied, but there's only one matching
%% subscription, so use that.
length(Subscriptions) == 1 ->
delete_subscriptions(SubKey, NodeId, Subscriptions, SubState),
{result, default};
true ->
{error, ?ERR_EXTENDED('bad-request', "subid-required")}
end.
delete_subscriptions(SubKey, NodeId, Subscriptions, SubState) -> publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) ->
NewSubs = lists:foldl(fun({Subscription, SubId}, Acc) -> node_flat:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload).
pubsub_subscription:delete_subscription(SubKey, NodeId, SubId),
Acc -- [{Subscription, SubId}]
end, SubState#pubsub_state.subscriptions, Subscriptions),
case {SubState#pubsub_state.affiliation, NewSubs} of
{none, []} ->
% Just a regular subscriber, and this is final item, so
% delete the state.
del_state(NodeId, SubKey);
_ ->
set_state(SubState#pubsub_state{subscriptions = NewSubs})
end.
%% @spec (NodeId, Publisher, PublishModel, MaxItems, ItemId, Payload) ->
%% {true, PubsubItem} | {result, Reply}
%% NodeId = mod_pubsub:pubsubNodeId()
%% Publisher = mod_pubsub:jid()
%% PublishModel = atom()
%% MaxItems = integer()
%% ItemId = string()
%% Payload = term()
%% @doc <p>Publishes the item passed as parameter.</p>
%% <p>The mechanism works as follow:
%% <ul>
%% <li>The main PubSub module prepares the item to publish and passes the
%% result of the preparation as a {@link mod_pubsub:pubsubItem()} record.</li>
%% <li>This function gets the prepared record and several other parameters and can decide to:<ul>
%% <li>reject the publication;</li>
%% <li>allow the publication as is, letting the main module perform the database persistance;</li>
%% <li>allow the publication, modifying the record. The main module will store the modified record;</li>
%% <li>allow it, but perform the needed persistance operations.</li></ul>
%% </li></ul></p>
%% <p>The selected behaviour depends on the return parameter:
%% <ul>
%% <li><tt>{error, Reason}</tt>: an iq error result will be return. No
%% publication is actually performed.</li>
%% <li><tt>true</tt>: Publication operation is allowed, based on the
%% unmodified record passed in parameter <tt>Item</tt>. If the <tt>Item</tt>
%% parameter contains an error, no subscription will actually be
%% performed.</li>
%% <li><tt>{true, Item}</tt>: Publication operation is allowed, but the
%% {@link mod_pubsub:pubsubItem()} record returned replaces the value passed
%% in parameter <tt>Item</tt>. The persistance will be performed by the main
%% module.</li>
%% <li><tt>{true, done}</tt>: Publication operation is allowed, but the
%% {@link mod_pubsub:pubsubItem()} will be considered as already stored and
%% no further persistance operation will be performed. This case is used,
%% when the plugin module is doing the persistance by itself or when it want
%% to completly disable persistance.</li></ul>
%% </p>
%% <p>In the default plugin module, the record is unchanged.</p>
publish_item(NodeId, Publisher, PublishModel, MaxItems, ItemId, Payload) ->
SubKey = jlib:short_prepd_jid(Publisher),
GenKey = jlib:short_prepd_bare_jid(Publisher),
GenState = get_state(NodeId, GenKey),
SubState = case SubKey of
GenKey -> GenState;
_ -> get_state(NodeId, SubKey)
end,
Affiliation = GenState#pubsub_state.affiliation,
Subscribed = case PublishModel of
subscribers -> is_subscribed(SubState#pubsub_state.subscriptions);
_ -> undefined
end,
if
not ((PublishModel == open)
or ((PublishModel == publishers)
and ((Affiliation == owner) or (Affiliation == publisher)))
or (Subscribed == true)) ->
%% Entity does not have sufficient privileges to publish to node
{error, 'forbidden'};
true ->
%% TODO: check creation, presence, roster
if MaxItems > 0 ->
Now = now(),
PubId = {Now, SubKey},
Item = case get_item(NodeId, ItemId) of
{result, OldItem} ->
OldItem#pubsub_item{modification = PubId,
payload = Payload};
_ ->
#pubsub_item{itemid = {ItemId, NodeId},
creation = {Now, GenKey},
modification = PubId,
payload = Payload}
end,
Items = [ItemId | GenState#pubsub_state.items--[ItemId]],
{result, {NI, OI}} = remove_extra_items(NodeId, MaxItems, Items),
set_item(Item),
set_state(GenState#pubsub_state{items = NI}),
{result, {default, broadcast, OI}};
true ->
{result, {default, broadcast, []}}
end
end.
%% @spec (NodeId, MaxItems, ItemIds) -> {NewItemIds,OldItemIds}
%% NodeId = mod_pubsub:pubsubNodeId()
%% MaxItems = integer() | unlimited
%% ItemIds = [ItemId::string()]
%% NewItemIds = [ItemId::string()]
%% @doc <p>This function is used to remove extra items, most notably when the
%% maximum number of items has been reached.</p>
%% <p>This function is used internally by the core PubSub module, as no
%% permission check is performed.</p>
%% <p>In the default plugin module, the oldest items are removed, but other
%% rules can be used.</p>
%% <p>If another PubSub plugin wants to delegate the item removal (and if the
%% plugin is using the default pubsub storage), it can implements this function like this:
%% ```remove_extra_items(NodeId, MaxItems, ItemIds) ->
%% node_default:remove_extra_items(NodeId, MaxItems, ItemIds).'''</p>
remove_extra_items(_NodeId, unlimited, ItemIds) ->
{result, {ItemIds, []}};
remove_extra_items(NodeId, MaxItems, ItemIds) -> remove_extra_items(NodeId, MaxItems, ItemIds) ->
NewItems = lists:sublist(ItemIds, MaxItems), node_flat:remove_extra_items(NodeId, MaxItems, ItemIds).
OldItems = lists:nthtail(length(NewItems), ItemIds),
%% Remove extra items:
del_items(NodeId, OldItems),
%% Return the new items list:
{result, {NewItems, OldItems}}.
%% @spec (NodeId, Publisher, PublishModel, ItemId) ->
%% {error, Reason::stanzaError()} |
%% {result, []}
%% NodeId = mod_pubsub:pubsubNodeId()
%% Publisher = mod_pubsub:jid()
%% PublishModel = atom()
%% ItemId = string()
%% @doc <p>Triggers item deletion.</p>
%% <p>Default plugin: The user performing the deletion must be the node owner
%% or a publisher, or PublishModel being open.</p>
delete_item(NodeId, Publisher, PublishModel, ItemId) -> delete_item(NodeId, Publisher, PublishModel, ItemId) ->
GenKey = jlib:short_prepd_bare_jid(Publisher), node_flat:delete_item(NodeId, Publisher, PublishModel, ItemId).
GenState = get_state(NodeId, GenKey),
#pubsub_state{affiliation = Affiliation, items = Items} = GenState,
Allowed = (Affiliation == publisher) orelse (Affiliation == owner)
orelse (PublishModel == open)
orelse case get_item(NodeId, ItemId) of
{result, #pubsub_item{creation = {_, GenKey}}} -> true;
_ -> false
end,
if
not Allowed ->
%% Requesting entity does not have sufficient privileges
{error, 'forbidden'};
true ->
case lists:member(ItemId, Items) of
true ->
del_item(NodeId, ItemId),
set_state(GenState#pubsub_state{items = lists:delete(ItemId, Items)}),
{result, {default, broadcast}};
false ->
case Affiliation of
owner ->
%% Owner can delete other publishers items as well
{result, States} = get_states(NodeId),
lists:foldl(
fun(#pubsub_state{items = PI, affiliation = publisher} = S, Res) ->
case lists:member(ItemId, PI) of
true ->
del_item(NodeId, ItemId),
set_state(S#pubsub_state{items = lists:delete(ItemId, PI)}),
{result, {default, broadcast}};
false ->
Res
end;
(_, Res) ->
Res
end, {error, 'item-not-found'}, States);
_ ->
%% Non-existent node or item
{error, 'item-not-found'}
end
end
end.
%% @spec (NodeId, Owner) ->
%% {error, Reason::stanzaError()} |
%% {result, {default, broadcast}}
%% NodeId = mod_pubsub:pubsubNodeId()
%% Owner = mod_pubsub:jid()
purge_node(NodeId, Owner) -> purge_node(NodeId, Owner) ->
GenKey = jlib:short_prepd_bare_jid(Owner), node_flat:purge_node(NodeId, Owner).
GenState = get_state(NodeId, GenKey),
case GenState of
#pubsub_state{affiliation = owner} ->
{result, States} = get_states(NodeId),
lists:foreach(
fun(#pubsub_state{items = []}) ->
ok;
(#pubsub_state{items = Items} = S) ->
del_items(NodeId, Items),
set_state(S#pubsub_state{items = []})
end, States),
{result, {default, broadcast}};
_ ->
%% Entity is not owner
{error, 'forbidden'}
end.
%% @spec (Host, JID) -> [{Node,Affiliation}]
%% Host = host()
%% JID = mod_pubsub:jid()
%% @doc <p>Return the current affiliations for the given user</p>
%% <p>The default module reads affiliations in the main Mnesia
%% <tt>pubsub_state</tt> table. If a plugin stores its data in the same
%% table, it should return an empty list, as the affiliation will be read by
%% the default PubSub module. Otherwise, it should return its own affiliation,
%% that will be added to the affiliation stored in the main
%% <tt>pubsub_state</tt> table.</p>
get_entity_affiliations(Host, Owner) -> get_entity_affiliations(Host, Owner) ->
GenKey = jlib:short_prepd_bare_jid(Owner), node_flat:get_entity_affiliations(Host, Owner).
States = mnesia:match_object(#pubsub_state{stateid = {GenKey, '_'}, _ = '_'}),
NodeTree = case catch ets:lookup(gen_mod:get_module_proc(Host, config), nodetree) of
[{nodetree, N}] -> N;
_ -> nodetree_tree
end,
Reply = lists:foldl(fun(#pubsub_state{stateid = {_, N}, affiliation = A}, Acc) ->
case NodeTree:get_node(N) of
#pubsub_node{nodeid = {Host, _}} = Node -> [{Node, A}|Acc];
_ -> Acc
end
end, [], States),
{result, Reply}.
get_node_affiliations(NodeId) -> get_node_affiliations(NodeId) ->
{result, States} = get_states(NodeId), node_flat:get_node_affiliations(NodeId).
Tr = fun(#pubsub_state{stateid = {J, _}, affiliation = A}) ->
{J, A}
end,
{result, lists:map(Tr, States)}.
get_affiliation(NodeId, Owner) -> get_affiliation(NodeId, Owner) ->
GenKey = jlib:short_prepd_bare_jid(Owner), node_flat:get_affiliation(NodeId, Owner).
GenState = get_state(NodeId, GenKey),
{result, GenState#pubsub_state.affiliation}.
set_affiliation(NodeId, Owner, Affiliation) when ?IS_JID(Owner)-> set_affiliation(NodeId, Owner, Affiliation) ->
GenKey = jlib:short_prepd_bare_jid(Owner), node_flat:set_affiliation(NodeId, Owner, Affiliation).
GenState = get_state(NodeId, GenKey),
case {Affiliation, GenState#pubsub_state.subscriptions} of
{none, none} ->
del_state(NodeId, GenKey);
_ ->
set_state(GenState#pubsub_state{affiliation = Affiliation})
end.
%% @spec (Host, Owner) -> [{Node,Subscription}]
%% Host = host()
%% Owner = mod_pubsub:jid()
%% @doc <p>Return the current subscriptions for the given user</p>
%% <p>The default module reads subscriptions in the main Mnesia
%% <tt>pubsub_state</tt> table. If a plugin stores its data in the same
%% table, it should return an empty list, as the affiliation will be read by
%% the default PubSub module. Otherwise, it should return its own affiliation,
%% that will be added to the affiliation stored in the main
%% <tt>pubsub_state</tt> table.</p>
get_entity_subscriptions(Host, Owner) -> get_entity_subscriptions(Host, Owner) ->
{U, D, _} = SubKey = jlib:short_prepd_jid(Owner), node_flat:get_entity_subscriptions(Host, Owner).
GenKey = jlib:short_prepd_bare_jid(Owner),
States = case SubKey of
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 = case catch ets:lookup(gen_mod:get_module_proc(Host, config), nodetree) of
[{nodetree, N}] -> N;
_ -> nodetree_tree
end,
Reply = lists:foldl(fun(#pubsub_state{stateid = {J, N}, subscriptions = Ss}, Acc) ->
case NodeTree:get_node(N) of
#pubsub_node{nodeid = {Host, _}} = Node ->
lists:foldl(fun({Sub, SubId}, Acc2) ->
[{Node, Sub, SubId, J} | Acc2];
(S, Acc2) ->
[{Node, S, J} | Acc2]
end, Acc, Ss);
_ -> Acc
end
end, [], States),
{result, Reply}.
get_node_subscriptions(NodeId) -> get_node_subscriptions(NodeId) ->
{result, States} = get_states(NodeId), node_flat:get_node_subscriptions(NodeId).
Tr = fun(#pubsub_state{stateid = {J, _}, subscriptions = Subscriptions}) ->
%% TODO: get rid of cases to handle non-list subscriptions
case Subscriptions of
[_|_] ->
lists:foldl(fun({S, SubId}, Acc) ->
[{J, S, SubId} | Acc];
(S, Acc) ->
[{J, S} | Acc]
end, [], Subscriptions);
[] ->
[];
_ ->
[{J, none}]
end
end,
{result, lists:flatmap(Tr, States)}.
get_subscriptions(NodeId, Owner) -> get_subscriptions(NodeId, Owner) ->
SubKey = jlib:short_prepd_jid(Owner), node_flat:get_subscriptions(NodeId, Owner).
SubState = get_state(NodeId, SubKey),
{result, SubState#pubsub_state.subscriptions}.
set_subscriptions(NodeId, Owner, Subscription, SubId) -> set_subscriptions(NodeId, Owner, Subscription, SubId) ->
SubKey = jlib:short_prepd_jid(Owner), node_flat:set_subscriptions(NodeId, Owner, Subscription, SubId).
SubState = get_state(NodeId, SubKey),
case {SubId, SubState#pubsub_state.subscriptions} of
{_, []} ->
case Subscription of
none -> {error, ?ERR_EXTENDED('bad_request', "not-subscribed")};
_ -> new_subscription(NodeId, Owner, Subscription, SubState)
end;
{"", [{_, SID}]} ->
case Subscription of
none -> unsub_with_subid(NodeId, SID, SubState);
_ -> replace_subscription({Subscription, SID}, SubState)
end;
{"", [_|_]} ->
{error, ?ERR_EXTENDED('bad_request', "subid-required")};
_ ->
case Subscription of
none -> unsub_with_subid(NodeId, SubId, SubState);
_ -> replace_subscription({Subscription, SubId}, SubState)
end
end.
replace_subscription(NewSub, SubState) ->
NewSubs = replace_subscription(NewSub,
SubState#pubsub_state.subscriptions, []),
set_state(SubState#pubsub_state{subscriptions = NewSubs}).
replace_subscription(_, [], Acc) ->
Acc;
replace_subscription({Sub, SubId}, [{_, SubID} | T], Acc) ->
replace_subscription({Sub, SubId}, T, [{Sub, SubID} | Acc]).
new_subscription(NodeId, Owner, Subscription, SubState) ->
SubId = pubsub_subscription:add_subscription(Owner, NodeId, []),
Subscriptions = SubState#pubsub_state.subscriptions,
set_state(SubState#pubsub_state{subscriptions = [{Subscription, SubId} | Subscriptions]}),
{Subscription, SubId}.
unsub_with_subid(NodeId, SubId, SubState) ->
pubsub_subscription:delete_subscription(SubState#pubsub_state.stateid,
NodeId, SubId),
NewSubs = lists:filter(fun ({_, SID}) -> SubId =/= SID end,
SubState#pubsub_state.subscriptions),
case {NewSubs, SubState#pubsub_state.affiliation} of
{[], none} ->
del_state(NodeId, element(1, SubState#pubsub_state.stateid));
_ ->
set_state(SubState#pubsub_state{subscriptions = NewSubs})
end.
%% @spec (Host, Owner) -> {result, [Node]} | {error, Reason}
%% Host = host()
%% Owner = jid()
%% Node = pubsubNode()
%% @doc <p>Returns a list of Owner's nodes on Host with pending
%% subscriptions.</p>
get_pending_nodes(Host, Owner) -> get_pending_nodes(Host, Owner) ->
GenKey = jlib:jid_remove_resource(jlib:jid_tolower(Owner)), node_flat:get_pending_nodes(Host, Owner).
States = mnesia:match_object(#pubsub_state{stateid = {GenKey, '_'},
affiliation = owner,
_ = '_'}),
NodeIDs = [ID || #pubsub_state{stateid = {_, ID}} <- States],
NodeTree = case catch ets:lookup(gen_mod:get_module_proc(Host, config), nodetree) of
[{nodetree, N}] -> N;
_ -> nodetree_tree
end,
Reply = mnesia:foldl(fun(#pubsub_state{stateid = {_, NID}} = S, Acc) ->
case lists:member(NID, NodeIDs) of
true ->
case get_nodes_helper(NodeTree, S) of
{value, Node} -> [Node | Acc];
false -> Acc
end;
false ->
Acc
end
end, [], pubsub_state),
{result, Reply}.
get_nodes_helper(NodeTree,
#pubsub_state{stateid = {_, N}, subscriptions = Subs}) ->
HasPending = fun ({pending, _}) -> true;
(pending) -> true;
(_) -> false
end,
case lists:any(HasPending, Subs) of
true ->
case NodeTree:get_node(N) of
#pubsub_node{nodeid = {_, Node}} ->
{value, Node};
_ ->
false
end;
false ->
false
end.
%% @spec (NodeId) -> {result, [State] | []}
%% NodeId = mod_pubsub:pubsubNodeId()
%% State = mod_pubsub:pubsubState()
%% @doc Returns the list of stored states for a given node.
%% <p>For the default PubSub module, states are stored in Mnesia database.</p>
%% <p>We can consider that the pubsub_state table have been created by the main
%% mod_pubsub module.</p>
%% <p>PubSub plugins can store the states where they wants (for example in a
%% relational database).</p>
%% <p>If a PubSub plugin wants to delegate the states storage to the default node,
%% they can implement this function like this:
%% ```get_states(NodeId) ->
%% node_default:get_states(NodeId).'''</p>
get_states(NodeId) -> get_states(NodeId) ->
States = case catch mnesia:match_object( node_flat:get_states(NodeId).
#pubsub_state{stateid = {'_', NodeId}, _ = '_'}) of
List when is_list(List) -> List;
_ -> []
end,
{result, States}.
%% @spec (NodeId, JID) -> [State] | []
%% NodeId = mod_pubsub:pubsubNodeId()
%% JID = mod_pubsub:jid()
%% State = mod_pubsub:pubsubItems()
%% @doc <p>Returns a state (one state list), given its reference.</p>
get_state(NodeId, JID) -> get_state(NodeId, JID) ->
StateId = {JID, NodeId}, node_flat:get_state(NodeId, JID).
case catch mnesia:read({pubsub_state, StateId}) of
[State] when is_record(State, pubsub_state) -> State;
_ -> #pubsub_state{stateid=StateId}
end.
%% @spec (State) -> ok | {error, Reason::stanzaError()} set_state(State) ->
%% State = mod_pubsub:pubsubStates() node_flat:set_state(State).
%% @doc <p>Write a state into database.</p>
set_state(State) when is_record(State, pubsub_state) ->
mnesia:write(State);
set_state(_) ->
{error, 'internal-server-error'}.
%% @spec (NodeId, JID) -> ok | {error, Reason::stanzaError()} get_items(NodeId, From) ->
%% NodeId = mod_pubsub:pubsubNodeId() node_flat:get_items(NodeId, From).
%% @doc <p>Delete a state from database.</p>
del_state(NodeId, JID) ->
mnesia:delete({pubsub_state, {JID, NodeId}}).
%% @spec (NodeId, From) -> [Items] | [] get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) ->
%% NodeId = mod_pubsub:pubsubNodeId() node_flat:get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId).
%% Items = mod_pubsub:pubsubItems()
%% @doc Returns the list of stored items for a given node.
%% <p>For the default PubSub module, items are stored in Mnesia database.</p>
%% <p>We can consider that the pubsub_item table have been created by the main
%% mod_pubsub module.</p>
%% <p>PubSub plugins can store the items where they wants (for example in a
%% relational database), or they can even decide not to persist any items.</p>
%% <p>If a PubSub plugin wants to delegate the item storage to the default node,
%% they can implement this function like this:
%% ```get_items(NodeId, From) ->
%% node_default:get_items(NodeId, From).'''</p>
get_items(NodeId, _From) ->
Items = mnesia:match_object(#pubsub_item{itemid = {'_', NodeId}, _ = '_'}),
{result, lists:reverse(lists:keysort(#pubsub_item.modification, Items))}.
get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, _SubId) ->
SubKey = jlib:short_prepd_jid(JID),
GenKey = jlib:short_prepd_bare_jid(JID),
GenState = get_state(NodeId, GenKey),
SubState = get_state(NodeId, SubKey),
Affiliation = GenState#pubsub_state.affiliation,
Subscriptions = SubState#pubsub_state.subscriptions,
Whitelisted = can_fetch_item(Affiliation, Subscriptions),
if
%%SubId == "", ?? ->
%% Entity has multiple subscriptions to the node but does not specify a subscription ID
%{error, ?ERR_EXTENDED('bad-request', "subid-required")};
%%InvalidSubId ->
%% Entity is subscribed but specifies an invalid subscription ID
%{error, ?ERR_EXTENDED('not-acceptable', "invalid-subid")};
Affiliation == outcast ->
%% Requesting entity is blocked
{error, 'forbidden'};
(AccessModel == presence) and (not PresenceSubscription) ->
%% Entity is not authorized to create a subscription (presence subscription required)
{error, ?ERR_EXTENDED('not-authorized', "presence-subscription-required")};
(AccessModel == roster) and (not RosterGroup) ->
%% Entity is not authorized to create a subscription (not in roster group)
{error, ?ERR_EXTENDED('not-authorized', "not-in-roster-group")};
(AccessModel == whitelist) and (not Whitelisted) ->
%% Node has whitelist access model and entity lacks required affiliation
{error, ?ERR_EXTENDED('not-allowed', "closed-node")};
(AccessModel == authorize) and (not Whitelisted) ->
%% Node has authorize access model
{error, 'forbidden'};
%%MustPay ->
%% % Payment is required for a subscription
%% {error, ?ERR_PAYMENT_REQUIRED};
true ->
get_items(NodeId, JID)
end.
%% @spec (NodeId, ItemId) -> [Item] | []
%% NodeId = mod_pubsub:pubsubNodeId()
%% ItemId = string()
%% Item = mod_pubsub:pubsubItems()
%% @doc <p>Returns an item (one item list), given its reference.</p>
get_item(NodeId, ItemId) -> get_item(NodeId, ItemId) ->
case mnesia:read({pubsub_item, {ItemId, NodeId}}) of node_flat:get_item(NodeId, ItemId).
[Item] when is_record(Item, pubsub_item) ->
{result, Item};
_ ->
{error, 'item-not-found'}
end.
get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, _SubId) ->
GenKey = jlib:short_prepd_bare_jid(JID),
GenState = get_state(NodeId, GenKey),
Affiliation = GenState#pubsub_state.affiliation,
Subscriptions = GenState#pubsub_state.subscriptions,
Whitelisted = can_fetch_item(Affiliation, Subscriptions),
if
%%SubId == "", ?? ->
%% Entity has multiple subscriptions to the node but does not specify a subscription ID
%{error, ?ERR_EXTENDED('bad-request', "subid-required")};
%%InvalidSubID ->
%% Entity is subscribed but specifies an invalid subscription ID
%{error, ?ERR_EXTENDED('not-acceptable', "invalid-subid")};
Affiliation == outcast ->
%% Requesting entity is blocked
{error, 'forbidden'};
(AccessModel == presence) and (not PresenceSubscription) ->
%% Entity is not authorized to create a subscription (presence subscription required)
{error, ?ERR_EXTENDED('not-authorized', "presence-subscription-required")};
(AccessModel == roster) and (not RosterGroup) ->
%% Entity is not authorized to create a subscription (not in roster group)
{error, ?ERR_EXTENDED('not-authorized', "not-in-roster-group")};
(AccessModel == whitelist) and (not Whitelisted) ->
%% Node has whitelist access model and entity lacks required affiliation
{error, ?ERR_EXTENDED('not-allowed', "closed-node")};
(AccessModel == authorize) and (not Whitelisted) ->
%% Node has authorize access model
{error, 'forbidden'};
%%MustPay ->
%% % Payment is required for a subscription
%% {error, ?ERR_PAYMENT_REQUIRED};
true ->
get_item(NodeId, ItemId)
end.
%% @spec (Item) -> ok | {error, Reason::stanzaError()} get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) ->
%% Item = mod_pubsub:pubsubItems() node_flat:get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId).
%% @doc <p>Write an item into database.</p>
set_item(Item) when is_record(Item, pubsub_item) ->
mnesia:write(Item);
set_item(_) ->
{error, 'internal-server-error'}.
%% @spec (NodeId, ItemId) -> ok | {error, Reason::stanzaError()} set_item(Item) ->
%% NodeId = mod_pubsub:pubsubNodeId() node_flat:set_item(Item).
%% ItemId = string()
%% @doc <p>Delete an item from database.</p>
del_item(NodeId, ItemId) ->
mnesia:delete({pubsub_item, {ItemId, NodeId}}).
del_items(NodeId, ItemIds) ->
lists:foreach(fun(ItemId) ->
del_item(NodeId, ItemId)
end, ItemIds).
%% @doc <p>Return the name of the node if known: Default is to return get_item_name(Host, Node, Id) ->
%% node id.</p> node_flat:get_item_name(Host, Node, Id).
get_item_name(_Host, _Node, Id) ->
Id.
node_to_path(Node) -> node_to_path(Node) ->
[list_to_binary(Item) || Item <- string:tokens(binary_to_list(Node), "/")]. [Node].
path_to_node([]) ->
<<>>;
path_to_node(Path) -> path_to_node(Path) ->
list_to_binary(string:join([""|[binary_to_list(Item) || Item <- Path]], "/")). case Path of
% default slot
%% @spec (Affiliation, Subscription) -> true | false [Node] -> Node;
%% Affiliation = owner | member | publisher | outcast | none % handle old possible entries, used when migrating database content to new format
%% Subscription = subscribed | none [Node|_] when is_list(Node) -> list_to_binary(string:join([""|Path], "/"));
%% @doc Determines if the combination of Affiliation and Subscribed % default case (used by PEP for example)
%% are allowed to get items from a node. _ -> list_to_binary(Path)
can_fetch_item(owner, _) -> true;
can_fetch_item(member, _) -> true;
can_fetch_item(publisher, _) -> true;
can_fetch_item(outcast, _) -> false;
can_fetch_item(none, Subscriptions) -> is_subscribed(Subscriptions);
can_fetch_item(_Affiliation, _Subscription) -> false.
is_subscribed(Subscriptions) ->
lists:any(fun ({subscribed, _SubId}) -> true;
(_) -> false
end, Subscriptions).
%% Returns the first item where Pred() is true in List
first_in_list(_Pred, []) ->
false;
first_in_list(Pred, [H | T]) ->
case Pred(H) of
true -> {value, H};
_ -> first_in_list(Pred, T)
end. end.

6
src/mod_pubsub/node_hometree_odbc.erl
View File

@ -239,7 +239,7 @@ create_node(NodeId, Owner) ->
%% Removed = [mod_pubsub:pubsubNode()] %% Removed = [mod_pubsub:pubsubNode()]
%% @doc <p>purge items of deleted nodes after effective deletion.</p> %% @doc <p>purge items of deleted nodes after effective deletion.</p>
delete_node(Removed) -> delete_node(Removed) ->
%% pablo: TODO, this is present on trunk/node_hometree but not on trunk/node_hometree_odbc. %% pablo: TODO, this is present on trunk/node_flat but not on trunk/node_flat_odbc.
%% check what is the desired behaviour %% check what is the desired behaviour
%% Tr = fun(#pubsub_state{stateid = {J, _}, subscriptions = Ss}) -> %% Tr = fun(#pubsub_state{stateid = {J, _}, subscriptions = Ss}) ->
%% lists:map(fun(S) -> %% lists:map(fun(S) ->
@ -1382,7 +1382,7 @@ i2l(L, N) when is_list(L) ->
end. end.
node_to_path(Node) -> node_to_path(Node) ->
node_hometree:node_to_path(Node). node_flat:node_to_path(Node).
path_to_node(Path) -> path_to_node(Path) ->
node_hometree:path_to_node(Path). node_flat:path_to_node(Path).

2
src/mod_pubsub/node_mb.erl
View File

@ -177,7 +177,7 @@ set_subscriptions(NodeId, Owner, Subscription, SubId) ->
node_pep:set_subscriptions(NodeId, Owner, Subscription, SubId). node_pep:set_subscriptions(NodeId, Owner, Subscription, SubId).
get_pending_nodes(Host, Owner) -> get_pending_nodes(Host, Owner) ->
node_hometree:get_pending_nodes(Host, Owner). node_flat:get_pending_nodes(Host, Owner).
get_states(NodeId) -> get_states(NodeId) ->
node_pep:get_states(NodeId). node_pep:get_states(NodeId).

52
src/mod_pubsub/node_pep.erl
View File

@ -71,12 +71,12 @@
]). ]).
init(Host, ServerHost, Opts) -> init(Host, ServerHost, Opts) ->
node_hometree:init(Host, ServerHost, Opts), node_flat:init(Host, ServerHost, Opts),
complain_if_modcaps_disabled(ServerHost), complain_if_modcaps_disabled(ServerHost),
ok. ok.
terminate(Host, ServerHost) -> terminate(Host, ServerHost) ->
node_hometree:terminate(Host, ServerHost), node_flat:terminate(Host, ServerHost),
ok. ok.
options() -> options() ->
@ -139,40 +139,40 @@ create_node_permission(Host, ServerHost, _Node, _ParentNode, Owner, Access) ->
{result, Allowed}. {result, Allowed}.
create_node(NodeId, Owner) -> create_node(NodeId, Owner) ->
case node_hometree:create_node(NodeId, Owner) of case node_flat:create_node(NodeId, Owner) of
{result, _} -> {result, []}; {result, _} -> {result, []};
Error -> Error Error -> Error
end. end.
delete_node(Removed) -> delete_node(Removed) ->
case node_hometree:delete_node(Removed) of case node_flat:delete_node(Removed) of
{result, {_, _, Removed}} -> {result, {[], Removed}}; {result, {_, _, Removed}} -> {result, {[], Removed}};
Error -> Error Error -> Error
end. end.
subscribe_node(NodeId, Sender, Subscriber, AccessModel, subscribe_node(NodeId, Sender, Subscriber, AccessModel,
SendLast, PresenceSubscription, RosterGroup, Options) -> SendLast, PresenceSubscription, RosterGroup, Options) ->
node_hometree:subscribe_node( node_flat:subscribe_node(
NodeId, Sender, Subscriber, AccessModel, SendLast, NodeId, Sender, Subscriber, AccessModel, SendLast,
PresenceSubscription, RosterGroup, Options). PresenceSubscription, RosterGroup, Options).
unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> unsubscribe_node(NodeId, Sender, Subscriber, SubID) ->
case node_hometree:unsubscribe_node(NodeId, Sender, Subscriber, SubID) of case node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubID) of
{error, Error} -> {error, Error}; {error, Error} -> {error, Error};
{result, _} -> {result, []} {result, _} -> {result, []}
end. end.
publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) ->
node_hometree:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). node_flat:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload).
remove_extra_items(NodeId, MaxItems, ItemIds) -> remove_extra_items(NodeId, MaxItems, ItemIds) ->
node_hometree:remove_extra_items(NodeId, MaxItems, ItemIds). node_flat:remove_extra_items(NodeId, MaxItems, ItemIds).
delete_item(NodeId, Publisher, PublishModel, ItemId) -> delete_item(NodeId, Publisher, PublishModel, ItemId) ->
node_hometree:delete_item(NodeId, Publisher, PublishModel, ItemId). node_flat:delete_item(NodeId, Publisher, PublishModel, ItemId).
purge_node(NodeId, Owner) -> purge_node(NodeId, Owner) ->
node_hometree:purge_node(NodeId, Owner). node_flat:purge_node(NodeId, Owner).
get_entity_affiliations(_Host, Owner) -> get_entity_affiliations(_Host, Owner) ->
{_, D, _} = SubKey = jlib:jid_tolower(Owner), {_, D, _} = SubKey = jlib:jid_tolower(Owner),
@ -192,13 +192,13 @@ get_entity_affiliations(_Host, Owner) ->
{result, Reply}. {result, Reply}.
get_node_affiliations(NodeId) -> get_node_affiliations(NodeId) ->
node_hometree:get_node_affiliations(NodeId). node_flat:get_node_affiliations(NodeId).
get_affiliation(NodeId, Owner) -> get_affiliation(NodeId, Owner) ->
node_hometree:get_affiliation(NodeId, Owner). node_flat:get_affiliation(NodeId, Owner).
set_affiliation(NodeId, Owner, Affiliation) -> set_affiliation(NodeId, Owner, Affiliation) ->
node_hometree:set_affiliation(NodeId, Owner, Affiliation). node_flat:set_affiliation(NodeId, Owner, Affiliation).
get_entity_subscriptions(_Host, Owner) -> get_entity_subscriptions(_Host, Owner) ->
{U, D, _} = SubKey = jlib:jid_tolower(Owner), {U, D, _} = SubKey = jlib:jid_tolower(Owner),
@ -236,43 +236,43 @@ get_node_subscriptions(NodeId) ->
%% but that call returns also all subscription to none %% but that call returns also all subscription to none
%% and this is required for broadcast to occurs %% and this is required for broadcast to occurs
%% DO NOT REMOVE %% DO NOT REMOVE
node_hometree:get_node_subscriptions(NodeId). node_flat:get_node_subscriptions(NodeId).
get_subscriptions(NodeId, Owner) -> get_subscriptions(NodeId, Owner) ->
node_hometree:get_subscriptions(NodeId, Owner). node_flat:get_subscriptions(NodeId, Owner).
set_subscriptions(NodeId, Owner, Subscription, SubId) -> set_subscriptions(NodeId, Owner, Subscription, SubId) ->
node_hometree:set_subscriptions(NodeId, Owner, Subscription, SubId). node_flat:set_subscriptions(NodeId, Owner, Subscription, SubId).
get_pending_nodes(Host, Owner) -> get_pending_nodes(Host, Owner) ->
node_hometree:get_pending_nodes(Host, Owner). node_flat:get_pending_nodes(Host, Owner).
get_states(NodeId) -> get_states(NodeId) ->
node_hometree:get_states(NodeId). node_flat:get_states(NodeId).
get_state(NodeId, JID) -> get_state(NodeId, JID) ->
node_hometree:get_state(NodeId, JID). node_flat:get_state(NodeId, JID).
set_state(State) -> set_state(State) ->
node_hometree:set_state(State). node_flat:set_state(State).
get_items(NodeId, From) -> get_items(NodeId, From) ->
node_hometree:get_items(NodeId, From). node_flat:get_items(NodeId, From).
get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) ->
node_hometree:get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). node_flat:get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId).
get_item(NodeId, ItemId) -> get_item(NodeId, ItemId) ->
node_hometree:get_item(NodeId, ItemId). node_flat:get_item(NodeId, ItemId).
get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) ->
node_hometree:get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). node_flat:get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId).
set_item(Item) -> set_item(Item) ->
node_hometree:set_item(Item). node_flat:set_item(Item).
get_item_name(Host, Node, Id) -> get_item_name(Host, Node, Id) ->
node_hometree:get_item_name(Host, Node, Id). node_flat:get_item_name(Host, Node, Id).
node_to_path(Node) -> node_to_path(Node) ->
node_flat:node_to_path(Node). node_flat:node_to_path(Node).

74
src/mod_pubsub/node_pep_odbc.erl
View File

@ -76,12 +76,12 @@
]). ]).
init(Host, ServerHost, Opts) -> init(Host, ServerHost, Opts) ->
node_hometree_odbc:init(Host, ServerHost, Opts), node_flat_odbc:init(Host, ServerHost, Opts),
complain_if_modcaps_disabled(ServerHost), complain_if_modcaps_disabled(ServerHost),
ok. ok.
terminate(Host, ServerHost) -> terminate(Host, ServerHost) ->
node_hometree_odbc:terminate(Host, ServerHost), node_flat_odbc:terminate(Host, ServerHost),
ok. ok.
options() -> options() ->
@ -146,60 +146,60 @@ create_node_permission(Host, ServerHost, _Node, _ParentNode, Owner, Access) ->
{result, Allowed}. {result, Allowed}.
create_node(NodeId, Owner) -> create_node(NodeId, Owner) ->
case node_hometree_odbc:create_node(NodeId, Owner) of case node_flat_odbc:create_node(NodeId, Owner) of
{result, _} -> {result, []}; {result, _} -> {result, []};
Error -> Error Error -> Error
end. end.
delete_node(Removed) -> delete_node(Removed) ->
case node_hometree_odbc:delete_node(Removed) of case node_flat_odbc:delete_node(Removed) of
{result, {_, _, Removed}} -> {result, {[], Removed}}; {result, {_, _, Removed}} -> {result, {[], Removed}};
Error -> Error Error -> Error
end. end.
subscribe_node(NodeId, Sender, Subscriber, AccessModel, subscribe_node(NodeId, Sender, Subscriber, AccessModel,
SendLast, PresenceSubscription, RosterGroup, Options) -> SendLast, PresenceSubscription, RosterGroup, Options) ->
node_hometree_odbc:subscribe_node( node_flat_odbc:subscribe_node(
NodeId, Sender, Subscriber, AccessModel, SendLast, NodeId, Sender, Subscriber, AccessModel, SendLast,
PresenceSubscription, RosterGroup, Options). PresenceSubscription, RosterGroup, Options).
unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> unsubscribe_node(NodeId, Sender, Subscriber, SubID) ->
case node_hometree_odbc:unsubscribe_node(NodeId, Sender, Subscriber, SubID) of case node_flat_odbc:unsubscribe_node(NodeId, Sender, Subscriber, SubID) of
{error, Error} -> {error, Error}; {error, Error} -> {error, Error};
{result, _} -> {result, []} {result, _} -> {result, []}
end. end.
publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) ->
node_hometree_odbc:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). node_flat_odbc:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload).
remove_extra_items(NodeId, MaxItems, ItemIds) -> remove_extra_items(NodeId, MaxItems, ItemIds) ->
node_hometree_odbc:remove_extra_items(NodeId, MaxItems, ItemIds). node_flat_odbc:remove_extra_items(NodeId, MaxItems, ItemIds).
delete_item(NodeId, Publisher, PublishModel, ItemId) -> delete_item(NodeId, Publisher, PublishModel, ItemId) ->
node_hometree_odbc:delete_item(NodeId, Publisher, PublishModel, ItemId). node_flat_odbc:delete_item(NodeId, Publisher, PublishModel, ItemId).
purge_node(NodeId, Owner) -> purge_node(NodeId, Owner) ->
node_hometree_odbc:purge_node(NodeId, Owner). node_flat_odbc:purge_node(NodeId, Owner).
get_entity_affiliations(_Host, Owner) -> get_entity_affiliations(_Host, Owner) ->
OwnerKey = jlib:short_prepd_bare_jid(Owner), OwnerKey = jlib:short_prepd_bare_jid(Owner),
node_hometree_odbc:get_entity_affiliations(OwnerKey, Owner). node_flat_odbc:get_entity_affiliations(OwnerKey, Owner).
get_node_affiliations(NodeId) -> get_node_affiliations(NodeId) ->
node_hometree_odbc:get_node_affiliations(NodeId). node_flat_odbc:get_node_affiliations(NodeId).
get_affiliation(NodeId, Owner) -> get_affiliation(NodeId, Owner) ->
node_hometree_odbc:get_affiliation(NodeId, Owner). node_flat_odbc:get_affiliation(NodeId, Owner).
set_affiliation(NodeId, Owner, Affiliation) -> set_affiliation(NodeId, Owner, Affiliation) ->
node_hometree_odbc:set_affiliation(NodeId, Owner, Affiliation). node_flat_odbc:set_affiliation(NodeId, Owner, Affiliation).
get_entity_subscriptions(_Host, Owner) -> get_entity_subscriptions(_Host, Owner) ->
SubKey = jlib:short_prepd_jid(Owner), SubKey = jlib:short_prepd_jid(Owner),
GenKey = jlib:short_prepd_bare_jid(SubKey), GenKey = jlib:short_prepd_bare_jid(SubKey),
Host = ?PUBSUB:escape(element(2, SubKey)), Host = ?PUBSUB:escape(element(2, SubKey)),
SJ = node_hometree_odbc:encode_jid(SubKey), SJ = node_flat_odbc:encode_jid(SubKey),
GJ = node_hometree_odbc:encode_jid(GenKey), GJ = node_flat_odbc:encode_jid(GenKey),
Query = case SubKey of Query = case SubKey of
GenKey -> GenKey ->
["select host, node, type, i.nodeid, jid, subscription " ["select host, node, type, i.nodeid, jid, subscription "
@ -217,9 +217,9 @@ get_entity_subscriptions(_Host, Owner) ->
Reply = case catch ejabberd_odbc:sql_query_t(Query) of Reply = case catch ejabberd_odbc:sql_query_t(Query) of
{selected, ["host", "node", "type", "nodeid", "jid", "subscription"], RItems} -> {selected, ["host", "node", "type", "nodeid", "jid", "subscription"], RItems} ->
lists:map(fun({H, N, T, I, J, S}) -> lists:map(fun({H, N, T, I, J, S}) ->
O = node_hometree_odbc:decode_jid(H), O = node_flat_odbc:decode_jid(H),
Node = nodetree_odbc:raw_to_node(O, {N, "", T, I}), Node = nodetree_odbc:raw_to_node(O, {N, "", T, I}),
{Node, node_hometree_odbc:decode_subscription(S), node_hometree_odbc:decode_jid(J)} {Node, node_flat_odbc:decode_subscription(S), node_flat_odbc:decode_jid(J)}
end, RItems); end, RItems);
_ -> _ ->
[] []
@ -229,8 +229,8 @@ get_entity_subscriptions_for_send_last(_Host, Owner) ->
SubKey = jlib:short_prepd_jid(Owner), SubKey = jlib:short_prepd_jid(Owner),
GenKey = jlib:short_prepd_bare_jid(SubKey), GenKey = jlib:short_prepd_bare_jid(SubKey),
Host = ?PUBSUB:escape(element(2, SubKey)), Host = ?PUBSUB:escape(element(2, SubKey)),
SJ = node_hometree_odbc:encode_jid(SubKey), SJ = node_flat_odbc:encode_jid(SubKey),
GJ = node_hometree_odbc:encode_jid(GenKey), GJ = node_flat_odbc:encode_jid(GenKey),
Query = case SubKey of Query = case SubKey of
GenKey -> GenKey ->
["select host, node, type, i.nodeid, jid, subscription " ["select host, node, type, i.nodeid, jid, subscription "
@ -250,9 +250,9 @@ get_entity_subscriptions_for_send_last(_Host, Owner) ->
Reply = case catch ejabberd_odbc:sql_query_t(Query) of Reply = case catch ejabberd_odbc:sql_query_t(Query) of
{selected, ["host", "node", "type", "nodeid", "jid", "subscription"], RItems} -> {selected, ["host", "node", "type", "nodeid", "jid", "subscription"], RItems} ->
lists:map(fun({H, N, T, I, J, S}) -> lists:map(fun({H, N, T, I, J, S}) ->
O = node_hometree_odbc:decode_jid(H), O = node_flat_odbc:decode_jid(H),
Node = nodetree_odbc:raw_to_node(O, {N, "", T, I}), Node = nodetree_odbc:raw_to_node(O, {N, "", T, I}),
{Node, node_hometree_odbc:decode_subscription(S), node_hometree_odbc:decode_jid(J)} {Node, node_flat_odbc:decode_subscription(S), node_flat_odbc:decode_jid(J)}
end, RItems); end, RItems);
_ -> _ ->
[] []
@ -266,49 +266,49 @@ get_node_subscriptions(NodeId) ->
%% but that call returns also all subscription to none %% but that call returns also all subscription to none
%% and this is required for broadcast to occurs %% and this is required for broadcast to occurs
%% DO NOT REMOVE %% DO NOT REMOVE
node_hometree_odbc:get_node_subscriptions(NodeId). node_flat_odbc:get_node_subscriptions(NodeId).
get_subscriptions(NodeId, Owner) -> get_subscriptions(NodeId, Owner) ->
node_hometree_odbc:get_subscriptions(NodeId, Owner). node_flat_odbc:get_subscriptions(NodeId, Owner).
set_subscriptions(NodeId, Owner, Subscription, SubId) -> set_subscriptions(NodeId, Owner, Subscription, SubId) ->
node_hometree_odbc:set_subscriptions(NodeId, Owner, Subscription, SubId). node_flat_odbc:set_subscriptions(NodeId, Owner, Subscription, SubId).
get_pending_nodes(Host, Owner) -> get_pending_nodes(Host, Owner) ->
node_hometree_odbc:get_pending_nodes(Host, Owner). node_flat_odbc:get_pending_nodes(Host, Owner).
get_states(NodeId) -> get_states(NodeId) ->
node_hometree_odbc:get_states(NodeId). node_flat_odbc:get_states(NodeId).
get_state(NodeId, JID) -> get_state(NodeId, JID) ->
node_hometree_odbc:get_state(NodeId, JID). node_flat_odbc:get_state(NodeId, JID).
set_state(State) -> set_state(State) ->
node_hometree_odbc:set_state(State). node_flat_odbc:set_state(State).
get_items(NodeId, From) -> get_items(NodeId, From) ->
node_hometree_odbc:get_items(NodeId, From). node_flat_odbc:get_items(NodeId, From).
get_items(NodeId, From, RSM) -> get_items(NodeId, From, RSM) ->
node_hometree_odbc:get_items(NodeId, From, RSM). node_flat_odbc:get_items(NodeId, From, RSM).
get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) ->
get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId, none). get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId, none).
get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId, RSM) -> get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId, RSM) ->
node_hometree_odbc:get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId, RSM). node_flat_odbc:get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId, RSM).
get_last_items(NodeId, JID, Count) -> get_last_items(NodeId, JID, Count) ->
node_hometree_odbc:get_last_items(NodeId, JID, Count). node_flat_odbc:get_last_items(NodeId, JID, Count).
get_item(NodeId, ItemId) -> get_item(NodeId, ItemId) ->
node_hometree_odbc:get_item(NodeId, ItemId). node_flat_odbc:get_item(NodeId, ItemId).
get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) ->
node_hometree_odbc:get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). node_flat_odbc:get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId).
set_item(Item) -> set_item(Item) ->
node_hometree_odbc:set_item(Item). node_flat_odbc:set_item(Item).
get_item_name(Host, Node, Id) -> get_item_name(Host, Node, Id) ->
node_hometree_odbc:get_item_name(Host, Node, Id). node_flat_odbc:get_item_name(Host, Node, Id).
node_to_path(Node) -> node_to_path(Node) ->
node_flat_odbc:node_to_path(Node). node_flat_odbc:node_to_path(Node).

60
src/mod_pubsub/node_private.erl
View File

@ -37,7 +37,7 @@
%% it's possible not to define some function at all %% it's possible not to define some function at all
%% in that case, warning will be generated at compilation %% in that case, warning will be generated at compilation
%% and function call will fail, %% and function call will fail,
%% then mod_pubsub will call function from node_hometree %% then mod_pubsub will call function from node_flat
%% (this makes code cleaner, but execution a little bit longer) %% (this makes code cleaner, but execution a little bit longer)
%% API definition %% API definition
@ -76,10 +76,10 @@
init(Host, ServerHost, Opts) -> init(Host, ServerHost, Opts) ->
node_hometree:init(Host, ServerHost, Opts). node_flat:init(Host, ServerHost, Opts).
terminate(Host, ServerHost) -> terminate(Host, ServerHost) ->
node_hometree:terminate(Host, ServerHost). node_flat:terminate(Host, ServerHost).
options() -> options() ->
[{deliver_payloads, true}, [{deliver_payloads, true},
@ -118,89 +118,89 @@ features() ->
]. ].
create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access) -> create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access) ->
node_hometree:create_node_permission(Host, ServerHost, Node, ParentNode, node_flat:create_node_permission(Host, ServerHost, Node, ParentNode,
Owner, Access). Owner, Access).
create_node(NodeId, Owner) -> create_node(NodeId, Owner) ->
node_hometree:create_node(NodeId, Owner). node_flat:create_node(NodeId, Owner).
delete_node(Removed) -> delete_node(Removed) ->
node_hometree:delete_node(Removed). node_flat:delete_node(Removed).
subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast,
PresenceSubscription, RosterGroup, Options) -> PresenceSubscription, RosterGroup, Options) ->
node_hometree:subscribe_node(NodeId, Sender, Subscriber, AccessModel, node_flat:subscribe_node(NodeId, Sender, Subscriber, AccessModel,
SendLast, PresenceSubscription, RosterGroup, SendLast, PresenceSubscription, RosterGroup,
Options). Options).
unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> unsubscribe_node(NodeId, Sender, Subscriber, SubID) ->
node_hometree:unsubscribe_node(NodeId, Sender, Subscriber, SubID). node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubID).
publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) ->
node_hometree:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). node_flat:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload).
remove_extra_items(NodeId, MaxItems, ItemIds) -> remove_extra_items(NodeId, MaxItems, ItemIds) ->
node_hometree:remove_extra_items(NodeId, MaxItems, ItemIds). node_flat:remove_extra_items(NodeId, MaxItems, ItemIds).
delete_item(NodeId, Publisher, PublishModel, ItemId) -> delete_item(NodeId, Publisher, PublishModel, ItemId) ->
node_hometree:delete_item(NodeId, Publisher, PublishModel, ItemId). node_flat:delete_item(NodeId, Publisher, PublishModel, ItemId).
purge_node(NodeId, Owner) -> purge_node(NodeId, Owner) ->
node_hometree:purge_node(NodeId, Owner). node_flat:purge_node(NodeId, Owner).
get_entity_affiliations(Host, Owner) -> get_entity_affiliations(Host, Owner) ->
node_hometree:get_entity_affiliations(Host, Owner). node_flat:get_entity_affiliations(Host, Owner).
get_node_affiliations(NodeId) -> get_node_affiliations(NodeId) ->
node_hometree:get_node_affiliations(NodeId). node_flat:get_node_affiliations(NodeId).
get_affiliation(NodeId, Owner) -> get_affiliation(NodeId, Owner) ->
node_hometree:get_affiliation(NodeId, Owner). node_flat:get_affiliation(NodeId, Owner).
set_affiliation(NodeId, Owner, Affiliation) -> set_affiliation(NodeId, Owner, Affiliation) ->
node_hometree:set_affiliation(NodeId, Owner, Affiliation). node_flat:set_affiliation(NodeId, Owner, Affiliation).
get_entity_subscriptions(Host, Owner) -> get_entity_subscriptions(Host, Owner) ->
node_hometree:get_entity_subscriptions(Host, Owner). node_flat:get_entity_subscriptions(Host, Owner).
get_node_subscriptions(NodeId) -> get_node_subscriptions(NodeId) ->
node_hometree:get_node_subscriptions(NodeId). node_flat:get_node_subscriptions(NodeId).
get_subscriptions(NodeId, Owner) -> get_subscriptions(NodeId, Owner) ->
node_hometree:get_subscriptions(NodeId, Owner). node_flat:get_subscriptions(NodeId, Owner).
set_subscriptions(NodeId, Owner, Subscription, SubId) -> set_subscriptions(NodeId, Owner, Subscription, SubId) ->
node_hometree:set_subscriptions(NodeId, Owner, Subscription, SubId). node_flat:set_subscriptions(NodeId, Owner, Subscription, SubId).
get_pending_nodes(Host, Owner) -> get_pending_nodes(Host, Owner) ->
node_hometree:get_pending_nodes(Host, Owner). node_flat:get_pending_nodes(Host, Owner).
get_states(NodeId) -> get_states(NodeId) ->
node_hometree:get_states(NodeId). node_flat:get_states(NodeId).
get_state(NodeId, JID) -> get_state(NodeId, JID) ->
node_hometree:get_state(NodeId, JID). node_flat:get_state(NodeId, JID).
set_state(State) -> set_state(State) ->
node_hometree:set_state(State). node_flat:set_state(State).
get_items(NodeId, From) -> get_items(NodeId, From) ->
node_hometree:get_items(NodeId, From). node_flat:get_items(NodeId, From).
get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) ->
node_hometree:get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). node_flat:get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId).
get_item(NodeId, ItemId) -> get_item(NodeId, ItemId) ->
node_hometree:get_item(NodeId, ItemId). node_flat:get_item(NodeId, ItemId).
get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) ->
node_hometree:get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). node_flat:get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId).
set_item(Item) -> set_item(Item) ->
node_hometree:set_item(Item). node_flat:set_item(Item).
get_item_name(Host, Node, Id) -> get_item_name(Host, Node, Id) ->
node_hometree:get_item_name(Host, Node, Id). node_flat:get_item_name(Host, Node, Id).
node_to_path(Node) -> node_to_path(Node) ->
node_flat:node_to_path(Node). node_flat:node_to_path(Node).

60
src/mod_pubsub/node_public.erl
View File

@ -37,7 +37,7 @@
%% it's possible not to define some function at all %% it's possible not to define some function at all
%% in that case, warning will be generated at compilation %% in that case, warning will be generated at compilation
%% and function call will fail, %% and function call will fail,
%% then mod_pubsub will call function from node_hometree %% then mod_pubsub will call function from node_flat
%% (this makes code cleaner, but execution a little bit longer) %% (this makes code cleaner, but execution a little bit longer)
%% API definition %% API definition
@ -76,10 +76,10 @@
init(Host, ServerHost, Opts) -> init(Host, ServerHost, Opts) ->
node_hometree:init(Host, ServerHost, Opts). node_flat:init(Host, ServerHost, Opts).
terminate(Host, ServerHost) -> terminate(Host, ServerHost) ->
node_hometree:terminate(Host, ServerHost). node_flat:terminate(Host, ServerHost).
options() -> options() ->
[{node_type, public}, [{node_type, public},
@ -119,87 +119,87 @@ features() ->
]. ].
create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access) -> create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access) ->
node_hometree:create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access). node_flat:create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access).
create_node(NodeId, Owner) -> create_node(NodeId, Owner) ->
node_hometree:create_node(NodeId, Owner). node_flat:create_node(NodeId, Owner).
delete_node(Removed) -> delete_node(Removed) ->
node_hometree:delete_node(Removed). node_flat:delete_node(Removed).
subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) ->
node_hometree:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). node_flat:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options).
unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> unsubscribe_node(NodeId, Sender, Subscriber, SubID) ->
node_hometree:unsubscribe_node(NodeId, Sender, Subscriber, SubID). node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubID).
publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) ->
node_hometree:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). node_flat:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload).
remove_extra_items(NodeId, MaxItems, ItemIds) -> remove_extra_items(NodeId, MaxItems, ItemIds) ->
node_hometree:remove_extra_items(NodeId, MaxItems, ItemIds). node_flat:remove_extra_items(NodeId, MaxItems, ItemIds).
delete_item(NodeId, Publisher, PublishModel, ItemId) -> delete_item(NodeId, Publisher, PublishModel, ItemId) ->
node_hometree:delete_item(NodeId, Publisher, PublishModel, ItemId). node_flat:delete_item(NodeId, Publisher, PublishModel, ItemId).
purge_node(NodeId, Owner) -> purge_node(NodeId, Owner) ->
node_hometree:purge_node(NodeId, Owner). node_flat:purge_node(NodeId, Owner).
get_entity_affiliations(Host, Owner) -> get_entity_affiliations(Host, Owner) ->
node_hometree:get_entity_affiliations(Host, Owner). node_flat:get_entity_affiliations(Host, Owner).
get_node_affiliations(NodeId) -> get_node_affiliations(NodeId) ->
node_hometree:get_node_affiliations(NodeId). node_flat:get_node_affiliations(NodeId).
get_affiliation(NodeId, Owner) -> get_affiliation(NodeId, Owner) ->
node_hometree:get_affiliation(NodeId, Owner). node_flat:get_affiliation(NodeId, Owner).
set_affiliation(NodeId, Owner, Affiliation) -> set_affiliation(NodeId, Owner, Affiliation) ->
node_hometree:set_affiliation(NodeId, Owner, Affiliation). node_flat:set_affiliation(NodeId, Owner, Affiliation).
get_entity_subscriptions(Host, Owner) -> get_entity_subscriptions(Host, Owner) ->
node_hometree:get_entity_subscriptions(Host, Owner). node_flat:get_entity_subscriptions(Host, Owner).
get_node_subscriptions(NodeId) -> get_node_subscriptions(NodeId) ->
node_hometree:get_node_subscriptions(NodeId). node_flat:get_node_subscriptions(NodeId).
get_subscriptions(NodeId, Owner) -> get_subscriptions(NodeId, Owner) ->
node_hometree:get_subscriptions(NodeId, Owner). node_flat:get_subscriptions(NodeId, Owner).
set_subscriptions(NodeId, Owner, Subscription, SubId) -> set_subscriptions(NodeId, Owner, Subscription, SubId) ->
node_hometree:set_subscription(NodeId, Owner, Subscription, SubId). node_flat:set_subscription(NodeId, Owner, Subscription, SubId).
get_pending_nodes(Host, Owner) -> get_pending_nodes(Host, Owner) ->
node_hometree:get_pending_nodes(Host, Owner). node_flat:get_pending_nodes(Host, Owner).
get_states(NodeId) -> get_states(NodeId) ->
node_hometree:get_states(NodeId). node_flat:get_states(NodeId).
get_state(NodeId, JID) -> get_state(NodeId, JID) ->
node_hometree:get_state(NodeId, JID). node_flat:get_state(NodeId, JID).
set_state(State) -> set_state(State) ->
node_hometree:set_state(State). node_flat:set_state(State).
get_items(NodeId, From) -> get_items(NodeId, From) ->
node_hometree:get_items(NodeId, From). node_flat:get_items(NodeId, From).
get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) ->
node_hometree:get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). node_flat:get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId).
get_item(NodeId, ItemId) -> get_item(NodeId, ItemId) ->
node_hometree:get_item(NodeId, ItemId). node_flat:get_item(NodeId, ItemId).
get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) ->
node_hometree:get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). node_flat:get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId).
set_item(Item) -> set_item(Item) ->
node_hometree:set_item(Item). node_flat:set_item(Item).
%% @doc <p>Return the name of the node if known: Default is to return %% @doc <p>Return the name of the node if known: Default is to return
%% node id.</p> %% node id.</p>
get_item_name(Host, Node, Id) -> get_item_name(Host, Node, Id) ->
node_hometree:get_item_name(Host, Node, Id). node_flat:get_item_name(Host, Node, Id).
node_to_path(Node) -> node_to_path(Node) ->
node_flat:node_to_path(Node). node_flat:node_to_path(Node).

2
src/mod_pubsub/nodetree_tree_odbc.erl
View File

@ -366,7 +366,7 @@ nodeid(Host, Node) ->
end. end.
nodeowners(NodeId) -> nodeowners(NodeId) ->
{result, Res} = node_hometree_odbc:get_node_affiliations(NodeId), {result, Res} = node_flat_odbc:get_node_affiliations(NodeId),
lists:foldl(fun({LJID, owner}, Acc) -> [LJID|Acc]; lists:foldl(fun({LJID, owner}, Acc) -> [LJID|Acc];
(_, Acc) -> Acc (_, Acc) -> Acc
end, [], Res). end, [], Res).