diff options
Diffstat (limited to 'src/mod_pubsub')
-rw-r--r-- | src/mod_pubsub/mod_pubsub.erl | 12 | ||||
-rw-r--r-- | src/mod_pubsub/node_default.erl | 4 | ||||
-rw-r--r-- | src/mod_pubsub/node_mb.erl | 1 | ||||
-rw-r--r-- | src/mod_pubsub/nodetree_default.erl | 10 | ||||
-rw-r--r-- | src/mod_pubsub/nodetree_virtual.erl | 12 |
5 files changed, 20 insertions, 19 deletions
diff --git a/src/mod_pubsub/mod_pubsub.erl b/src/mod_pubsub/mod_pubsub.erl index cff4daa9d..1afe066b6 100644 --- a/src/mod_pubsub/mod_pubsub.erl +++ b/src/mod_pubsub/mod_pubsub.erl @@ -33,7 +33,7 @@ %%% This module uses version 1.12 of the specification as a base. %%% Most of the specification is implemented. %%% Functions concerning configuration should be rewritten. -%%% Code is derivated from the original pubsub v1.7, by Alexey Shchepin <alexey@process-one.net> +%%% Code is derivated from the original pubsub v1.7, by Alexey Shchepin %%% TODO %%% plugin: generate Reply (do not use broadcast atom anymore) @@ -1753,10 +1753,11 @@ get_items(Host, Node, From) -> send_last_item(Host, Node, LJID) -> send_items(Host, Node, LJID, last). -%% @spec (Host, Node, LJID) -> any() +%% @spec (Host, Node, LJID, Number) -> any() %% Host = host() %% Node = pubsubNode() %% LJID = {U, S, []} +%% Number = last | integer() %% @doc <p>Resend the items of a node to the user.</p> %% @todo use cache-last-item feature send_items(Host, Node, LJID, Number) -> @@ -2139,10 +2140,9 @@ is_to_deliver({User, Server, _}, _, true) -> end, false, Ss) end. -%% @spec (Elem, Payload) -> int() -%% Elem = atom() +%% @spec (Payload) -> int() %% Payload = term() -%% @doc <p>Count occurence of given element in payload.</p> +%% @doc <p>Count occurence of XML elements in payload.</p> payload_xmlelements(Payload) -> payload_xmlelements(Payload, 0). payload_xmlelements([], Count) -> Count; payload_xmlelements([{xmlelement, _, _, _}|Tail], Count) -> payload_xmlelements(Tail, Count+1); @@ -2150,7 +2150,7 @@ payload_xmlelements([_|Tail], Count) -> payload_xmlelements(Tail, Count). %% @spec (Els) -> stanza() %% Els = [xmlelement()] -%% @doc <p>Build pubsub event stanza +%% @doc <p>Build pubsub event stanza</p> event_stanza(Els) -> {xmlelement, "message", [], [{xmlelement, "event", [{"xmlns", ?NS_PUBSUB_EVENT}], Els}]}. diff --git a/src/mod_pubsub/node_default.erl b/src/mod_pubsub/node_default.erl index 3a4faf506..f52c97648 100644 --- a/src/mod_pubsub/node_default.erl +++ b/src/mod_pubsub/node_default.erl @@ -645,7 +645,7 @@ set_state(_) -> del_state(StateId) -> mnesia:delete({pubsub_state, StateId}). -%% @spec (Host, Node) -> [Items] | [] +%% @spec (Host, Node, From) -> [Items] | [] %% Host = mod_pubsub:host() %% Node = mod_pubsub:pubsubNode() %% Items = mod_pubsub:pubsubItems() @@ -760,7 +760,7 @@ set_item(Item) when is_record(Item, pubsub_item) -> set_item(_) -> {error, ?ERR_INTERNAL_SERVER_ERROR}. -%% @spec (ItemId) -> ok | {error, Reason::stanzaError()} +%% @spec (Host, Node, ItemId) -> ok | {error, Reason::stanzaError()} %% Host = mod_pubsub:host() %% Node = mod_pubsub:pubsubNode() %% ItemId = string() diff --git a/src/mod_pubsub/node_mb.erl b/src/mod_pubsub/node_mb.erl index f2498071c..515229841 100644 --- a/src/mod_pubsub/node_mb.erl +++ b/src/mod_pubsub/node_mb.erl @@ -30,6 +30,7 @@ %%% {plugins, ["default", "pep","mb"]}, %%% {pep_mapping, [{"urn:xmpp:microblog", "mb"}]} %%% ]}, +%%% </p> %%% <p>PubSub plugin nodes are using the {@link gen_pubsub_node} behaviour.</p> -module(node_mb). diff --git a/src/mod_pubsub/nodetree_default.erl b/src/mod_pubsub/nodetree_default.erl index 05dd87746..6ed5670da 100644 --- a/src/mod_pubsub/nodetree_default.erl +++ b/src/mod_pubsub/nodetree_default.erl @@ -96,12 +96,12 @@ set_node(Record) when is_record(Record, pubsub_node) -> set_node(_) -> {error, ?ERR_INTERNAL_SERVER_ERROR}. -%% @spec (Host, Node) -> pubsubNode() | {error, Reason} -%% Host = mod_pubsub:host() -%% Node = mod_pubsub:pubsubNode() get_node(Host, Node, _From) -> get_node(Host, Node). +%% @spec (Host, Node) -> pubsubNode() | {error, Reason} +%% Host = mod_pubsub:host() +%% Node = mod_pubsub:pubsubNode() get_node(Host, Node) -> case catch mnesia:read({pubsub_node, {Host, Node}}) of [Record] when is_record(Record, pubsub_node) -> Record; @@ -109,11 +109,11 @@ get_node(Host, Node) -> Error -> Error end. -%% @spec (Key) -> [pubsubNode()] | {error, Reason} -%% Key = mod_pubsub:host() | mod_pubsub:jid() get_nodes(Key, _From) -> get_nodes(Key). +%% @spec (Key) -> [pubsubNode()] | {error, Reason} +%% Key = mod_pubsub:host() | mod_pubsub:jid() get_nodes(Key) -> mnesia:match_object(#pubsub_node{nodeid = {Key, '_'}, _ = '_'}). diff --git a/src/mod_pubsub/nodetree_virtual.erl b/src/mod_pubsub/nodetree_virtual.erl index a122c4b1d..019fafc34 100644 --- a/src/mod_pubsub/nodetree_virtual.erl +++ b/src/mod_pubsub/nodetree_virtual.erl @@ -83,24 +83,24 @@ options() -> set_node(_NodeRecord) -> ok. +get_node(Host, Node, _From) -> + get_node(Host, Node). + %% @spec (Host, Node) -> pubsubNode() %% Host = mod_pubsub:host() %% Node = mod_pubsub:pubsubNode() %% @doc <p>Virtual node tree does not handle a node database. Any node is considered %% as existing. Node record contains default values.</p> -get_node(Host, Node, _From) -> - get_node(Host, Node). - get_node(Host, Node) -> #pubsub_node{nodeid = {Host, Node}}. +get_nodes(Key, _From) -> + get_nodes(Key). + %% @spec (Key) -> [pubsubNode()] %% Host = mod_pubsub:host() | mod_pubsub:jid() %% @doc <p>Virtual node tree does not handle a node database. Any node is considered %% as existing. Nodes list can not be determined.</p> -get_nodes(Key, _From) -> - get_nodes(Key). - get_nodes(_Key) -> []. |