%%% ==================================================================== %%% ``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-2011, ProcessOne %%% All Rights Reserved.'' %%% This software is copyright 2006-2011, ProcessOne. %%% %%% %%% @copyright 2006-2011 ProcessOne %%% @author Christophe Romain %%% [http://www.process-one.net/] %%% @version {@vsn}, {@date} {@time} %%% @end %%% ==================================================================== %%% @doc The module {@module} is the PubSub node tree plugin that %%% allow virtual nodes handling. %%%

PubSub node tree plugins are using the {@link gen_nodetree} behaviour.

%%%

This plugin development is still a work in progress. Due to optimizations in %%% mod_pubsub, this plugin can not work anymore without altering functioning. %%% Please, send us comments, feedback and improvements.

-module(nodetree_virtual). -author('christophe.romain@process-one.net'). -include("pubsub.hrl"). -include("jlib.hrl"). -behaviour(gen_pubsub_nodetree). -export([init/3, terminate/2, options/0, set_node/1, get_node/3, get_node/2, get_node/1, get_nodes/2, get_nodes/1, get_parentnodes/3, get_parentnodes_tree/3, get_subnodes/3, get_subnodes_tree/3, create_node/6, delete_node/2 ]). %% ================ %% API definition %% ================ %% @spec (Host, ServerHost, Opts) -> any() %% Host = mod_pubsub:host() %% ServerHost = host() %% Opts = list() %% @doc

Called during pubsub modules initialisation. Any pubsub plugin must %% implement this function. It can return anything.

%%

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.

init(_Host, _ServerHost, _Opts) -> ok. terminate(_Host, _ServerHost) -> ok. %% @spec () -> [Option] %% Option = mod_pubsub:nodetreeOption() %% @doc

Returns the default pubsub node tree options.

options() -> [{virtual_tree, true}]. %% @spec (NodeRecord) -> ok | {error, Reason} %% NodeRecord = mod_pubsub:pubsub_node() %% @doc

No node record is stored on database. Just do nothing.

set_node(_NodeRecord) -> ok. %% @spec (Host, Node, From) -> pubsubNode() %% Host = mod_pubsub:host() %% Node = mod_pubsub:pubsubNode() %% From = mod_pubsub:jid() %% @doc

Virtual node tree does not handle a node database. Any node is considered %% as existing. Node record contains default values.

get_node(Host, Node, _From) -> get_node(Host, Node). get_node(Host, Node) -> get_node({Host, Node}). get_node({Host, _} = NodeId) -> Record = #pubsub_node{nodeid = NodeId, id = NodeId}, Module = list_to_atom("node_" ++ Record#pubsub_node.type), Options = Module:options(), Owners = [{"", Host, ""}], Record#pubsub_node{owners = Owners, options = Options}. %% @spec (Host, From) -> [pubsubNode()] %% Host = mod_pubsub:host() | mod_pubsub:jid() %% From = mod_pubsub:jid() %% @doc

Virtual node tree does not handle a node database. Any node is considered %% as existing. Nodes list can not be determined.

get_nodes(Host, _From) -> get_nodes(Host). get_nodes(_Host) -> []. %% @spec (Host, Node, From) -> [pubsubNode()] %% Host = mod_pubsub:host() %% Node = mod_pubsub:pubsubNode() %% From = mod_pubsub:jid() %% @doc

Virtual node tree does not handle parent/child. Child list is empty.

get_parentnodes(_Host, _Node, _From) -> []. %% @spec (Host, Node, From) -> [pubsubNode()] %% Host = mod_pubsub:host() %% Node = mod_pubsub:pubsubNode() %% From = mod_pubsub:jid() %% @doc

Virtual node tree does not handle parent/child. Child list is empty.

get_parentnodes_tree(_Host, _Node, _From) -> []. %% @spec (Host, Node, From) -> [pubsubNode()] %% Host = mod_pubsub:host() %% Node = mod_pubsub:pubsubNode() %% From = mod_pubsub:jid() %% @doc

Virtual node tree does not handle parent/child. Child list is empty.

get_subnodes(Host, Node, _From) -> get_subnodes(Host, Node). get_subnodes(_Host, _Node) -> []. %% @spec (Host, Node, From) -> [pubsubNode()] %% Host = mod_pubsub:host() %% Node = mod_pubsub:pubsubNode() %% From = mod_pubsub:jid() %% @doc

Virtual node tree does not handle parent/child. Child list is empty.

get_subnodes_tree(Host, Node, _From) -> get_subnodes_tree(Host, Node). get_subnodes_tree(_Host, _Node) -> []. %% @spec (Host, Node, Type, Owner, Options, Parents) -> ok %% Host = mod_pubsub:host() %% Node = mod_pubsub:pubsubNode() %% Type = mod_pubsub:nodeType() %% Owner = mod_pubsub:jid() %% Options = list() %% @doc

No node record is stored on database. Any valid node %% is considered as already created.

%%

default allowed nodes: /home/host/user/any/node/name

create_node(Host, Node, _Type, _Owner, _Options, _Parents) -> {error, {virtual, {Host, Node}}}. %% @spec (Host, Node) -> [mod_pubsub:node()] %% Host = mod_pubsub:host() %% Node = mod_pubsub:pubsubNode() %% @doc

Virtual node tree does not handle parent/child. %% node deletion just affects the corresponding node.

delete_node(Host, Node) -> [get_node(Host, Node)].