diff options
Diffstat (limited to 'src/node.template')
| -rw-r--r-- | src/node.template | 194 |
1 files changed, 194 insertions, 0 deletions
diff --git a/src/node.template b/src/node.template new file mode 100644 index 000000000..b31d8a8e2 --- /dev/null +++ b/src/node.template @@ -0,0 +1,194 @@ +%%% ==================================================================== +%%% ``The contents of this file are subject to the Erlang Public License, +%%% Version 1.1, (the "License"); you may not use this file except in +%%% compliance with the License. You should have received a copy of the +%%% Erlang Public License along with this software. If not, it can be +%%% retrieved via the world wide web at http://www.erlang.org/. +%%% +%%% Software distributed under the License is distributed on an "AS IS" +%%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +%%% the License for the specific language governing rights and limitations +%%% under the License. +%%% +%%% The Initial Developer of the Original Code is ProcessOne. +%%% Portions created by ProcessOne are Copyright 2006-2013, ProcessOne +%%% All Rights Reserved.'' +%%% This software is copyright 2006-2013, ProcessOne. +%%% +%%% @copyright 2006-2013 ProcessOne +%%% @author Christophe romain <christophe.romain@process-one.net> +%%% [http://www.process-one.net/] +%%% @version {@vsn}, {@date} {@time} +%%% @end +%%% ==================================================================== + +-module(__TO_BE_DEFINED__). +-author(__TO_BE_DEFINED__). + +-include("pubsub.hrl"). +-include("jlib.hrl"). + +-behaviour(gen_pubsub_node). + +%% Note on function definition +%% included is all defined plugin function +%% it's possible not to define some function at all +%% in that case, warning will be generated at compilation +%% and function call will fail, +%% then mod_pubsub will call function from node_hometree +%% (this makes code cleaner, but execution a little bit longer) + +%% API definition +-export([init/3, terminate/2, + options/0, features/0, + create_node_permission/6, + create_node/2, + delete_node/1, + purge_node/2, + subscribe_node/8, + unsubscribe_node/4, + publish_item/6, + delete_item/4, + remove_extra_items/3, + get_entity_affiliations/2, + get_node_affiliations/1, + get_affiliation/2, + set_affiliation/3, + get_entity_subscriptions/2, + get_node_subscriptions/1, + get_subscriptions/2, + set_subscriptions/4, + get_pending_nodes/2, + get_states/1, + get_state/2, + set_state/1, + get_items/6, + get_items/2, + get_item/7, + get_item/2, + set_item/1, + get_item_name/3 + ]). + + +init(Host, ServerHost, Opts) -> + node_hometree:init(Host, ServerHost, Opts). + +terminate(Host, ServerHost) -> + node_hometree:terminate(Host, ServerHost). + +options() -> + [{deliver_payloads, true}, + {notify_config, false}, + {notify_delete, false}, + {notify_retract, true}, + {purge_offline, false}, + {persist_items, true}, + {max_items, ?MAXITEMS}, + {subscribe, true}, + {access_model, open}, + {roster_groups_allowed, []}, + {publish_model, publishers}, + {notification_type, headline}, + {max_payload_size, ?MAX_PAYLOAD_SIZE}, + {send_last_published_item, on_sub_and_presence}, + {deliver_notifications, true}, + {presence_based_delivery, false}]. + +features() -> + ["create-nodes", + "delete-nodes", + "delete-items", + "instant-nodes", + "outcast-affiliation", + "persistent-items", + "publish", + "purge-nodes", + "retract-items", + "retrieve-affiliations", + "retrieve-items", + "retrieve-subscriptions", + "subscribe", + "subscription-notifications" + ]. + +create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access) -> + node_hometree:create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access). + +create_node(NodeId, Owner) -> + node_hometree:create_node(NodeId, Owner). + +delete_node(Removed) -> + node_hometree:delete_node(Removed). + +subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> + node_hometree:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). + +unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> + node_hometree:unsubscribe_node(NodeId, Sender, Subscriber, SubID). + +publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> + node_hometree:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). + +remove_extra_items(NodeId, MaxItems, ItemIds) -> + node_hometree:remove_extra_items(NodeId, MaxItems, ItemIds). + +delete_item(NodeId, Publisher, PublishModel, ItemId) -> + node_hometree:delete_item(NodeId, Publisher, PublishModel, ItemId). + +purge_node(NodeId, Owner) -> + node_hometree:purge_node(NodeId, Owner). + +get_entity_affiliations(Host, Owner) -> + node_hometree:get_entity_affiliations(Host, Owner). + +get_node_affiliations(NodeId) -> + node_hometree:get_node_affiliations(NodeId). + +get_affiliation(NodeId, Owner) -> + node_hometree:get_affiliation(NodeId, Owner). + +set_affiliation(NodeId, Owner, Affiliation) -> + node_hometree:set_affiliation(NodeId, Owner, Affiliation). + +get_entity_subscriptions(Host, Owner) -> + node_hometree:get_entity_subscriptions(Host, Owner). + +get_node_subscriptions(NodeId) -> + node_hometree:get_node_subscriptions(NodeId). + +get_subscriptions(NodeId, Owner) -> + node_hometree:get_subscriptions(NodeId, Owner). + +set_subscriptions(NodeId, Owner, Subscription, SubId) -> + node_hometree:set_subscriptions(NodeId, Owner, Subscription, SubId). + +get_pending_nodes(Host, Owner) -> + node_hometree:get_pending_nodes(Host, Owner). + +get_states(NodeId) -> + node_hometree:get_states(NodeId). + +get_state(NodeId, JID) -> + node_hometree:get_state(NodeId, JID). + +set_state(State) -> + node_hometree:set_state(State). + +get_items(NodeId, From) -> + node_hometree:get_items(NodeId, From). + +get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> + node_hometree:get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). + +get_item(NodeId, ItemId) -> + node_hometree:get_item(NodeId, ItemId). + +get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> + node_hometree:get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). + +set_item(Item) -> + node_hometree:set_item(Item). + +get_item_name(Host, Node, Id) -> + node_hometree:get_item_name(Host, Node, Id). |