Chapril
/
xmpp.chapril.org-ejabberd
mirror of https://github.com/processone/ejabberd.git
24
1
Fork 0
Code Releases Activity

* src/*.erl: Fix EDoc comments 

SVN Revision: 1772
This commit is contained in:
Badlop 2009-01-03 21:31:36 +00:00
parent ee02b0b57f
commit b32793efcf
9 changed files with 82 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
ChangeLog
View File

@ -1,3 +1,7 @@
2009-01-03 Badlop <badlop@process-one.net>
* src/*.erl: Fix EDoc comments
2009-01-03 Christophe Romain <christophe.romain@process-one.net>
* src/mod_pubsub/mod_pubsub.erl: deliver notification depending on
@ -24,7 +28,7 @@
2008-12-24 Badlop <badlop@process-one.net>
* src/aclocal.m4: Fixes in configure script: fix
disable-disable_zlib and disable-pam; in case of problems, PAM
disable-ejabberd_zlib and disable-pam; in case of problems, PAM
verification aborts with error instead of warning. (EJAB-787)
* src/configure.ac: Likewise
* src/configure: Likewise

4
src/ejabberd_auth.erl
View File

@ -262,7 +262,7 @@ is_user_exists_in_other_modules(Module, User, Server) ->
end, auth_modules(Server)--[Module]).
%% @spec (User, Server) -> ok | error | {error, not_allowed}
%% Remove user.
%% @doc Remove user.
%% Note: it may return ok even if there was some problem removing the user.
remove_user(User, Server) ->
R = lists:foreach(
@ -276,7 +276,7 @@ remove_user(User, Server) ->
R.
%% @spec (User, Server, Password) -> ok | not_exists | not_allowed | bad_request | error
%% Try to remove user if the provided password is correct.
%% @doc Try to remove user if the provided password is correct.
%% The removal is attempted in each auth method provided:
%% when one returns 'ok' the loop stops;
%% if no method returns 'ok' then it returns the error message indicated by the last method attempted.

4
src/ejabberd_auth_internal.erl
View File

@ -244,7 +244,7 @@ is_user_exists(User, Server) ->
end.
%% @spec (User, Server) -> ok
%% Remove user.
%% @doc Remove user.
%% Note: it returns ok even if there was some problem removing the user.
remove_user(User, Server) ->
LUser = jlib:nodeprep(User),
@ -257,7 +257,7 @@ remove_user(User, Server) ->
ok.
%% @spec (User, Server, Password) -> ok | not_exists | not_allowed | bad_request
%% Remove user if the provided password is correct.
%% @doc Remove user if the provided password is correct.
remove_user(User, Server, Password) ->
LUser = jlib:nodeprep(User),
LServer = jlib:nameprep(Server),

4
src/ejabberd_auth_odbc.erl
View File

@ -224,7 +224,7 @@ is_user_exists(User, Server) ->
end.
%% @spec (User, Server) -> ok | error
%% Remove user.
%% @doc Remove user.
%% Note: it may return ok even if there was some problem removing the user.
remove_user(User, Server) ->
case jlib:nodeprep(User) of
@ -238,7 +238,7 @@ remove_user(User, Server) ->
end.
%% @spec (User, Server, Password) -> ok | error | not_exists | not_allowed
%% Remove user if the provided password is correct.
%% @doc Remove user if the provided password is correct.
remove_user(User, Server, Password) ->
case jlib:nodeprep(User) of
error ->

116
src/mod_pubsub/mod_pubsub.erl
View File

@ -33,8 +33,8 @@
%%% 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 also inspired from the original PEP patch by Magnus Henoch <mange@freemail.hu>
%%% Code is derivated from the original pubsub v1.7, by Alexey Shchepin (alexey at process-one.net)
%%% Code also inspired from the original PEP patch by Magnus Henoch (mange at freemail.hu)
%%% TODO
%%% plugin: generate Reply (do not use broadcast atom anymore)
@ -190,8 +190,9 @@ init([ServerHost, Opts]) ->
nodetree = NodeTree,
plugins = Plugins}}.
%% @spec (Host, Opts) -> Plugins
%% Host = mod_pubsub:host() Opts = [{Key,Value}]
%% @spec (Host, ServerHost, Opts) -> Plugins
%% Host = mod_pubsub:host()
%% Opts = [{Key,Value}]
%% ServerHost = host()
%% Key = atom()
%% Value = term()
@ -1151,19 +1152,19 @@ handle_authorization_response(Host, From, To, Packet, XFields) ->
%% @doc <p>Create new pubsub nodes</p>
%%<p>In addition to method-specific error conditions, there are several general reasons why the node creation request might fail:</p>
%%<ul>
%%<li>The service does not support node creation.
%%<li>Only entities that are registered with the service are allowed to create nodes but the requesting entity is not registered.
%%<li>The requesting entity does not have sufficient privileges to create nodes.
%%<li>The requested NodeID already exists.
%%<li>The request did not include a NodeID and "instant nodes" are not supported.
%%<li>The service does not support node creation.</li>
%%<li>Only entities that are registered with the service are allowed to create nodes but the requesting entity is not registered.</li>
%%<li>The requesting entity does not have sufficient privileges to create nodes.</li>
%%<li>The requested NodeID already exists.</li>
%%<li>The request did not include a NodeID and "instant nodes" are not supported.</li>
%%</ul>
%%<p>ote: node creation is a particular case, error return code is evaluated at many places:</p>
%%<ul>
%%<li>iq_pubsub checks if service supports node creation (type exists)
%%<li>create_node checks if instant nodes are supported
%%<li>create_node asks node plugin if entity have sufficient privilege
%%<li>nodetree create_node checks if nodeid already exists
%%<li>node plugin create_node just sets default affiliation/subscription
%%<li>iq_pubsub checks if service supports node creation (type exists)</li>
%%<li>create_node checks if instant nodes are supported</li>
%%<li>create_node asks node plugin if entity have sufficient privilege</li>
%%<li>nodetree create_node checks if nodeid already exists</li>
%%<li>node plugin create_node just sets default affiliation/subscription</li>
%%</ul>
create_node(Host, ServerHost, Node, Owner, Type) ->
create_node(Host, ServerHost, Node, Owner, Type, all, []).
@ -1274,9 +1275,9 @@ create_node(Host, ServerHost, Node, Owner, GivenType, Access, Configuration) ->
%% @doc <p>Delete specified node and all childs.</p>
%%<p>There are several reasons why the node deletion request might fail:</p>
%%<ul>
%%<li>The requesting entity does not have sufficient privileges to delete the node.
%%<li>The node is the root collection node, which cannot be deleted.
%%<li>The specified node does not exist.
%%<li>The requesting entity does not have sufficient privileges to delete the node.</li>
%%<li>The node is the root collection node, which cannot be deleted.</li>
%%<li>The specified node does not exist.</li>
%%</ul>
delete_node(_Host, [], _Owner) ->
%% Node is the root
@ -1326,20 +1327,20 @@ delete_node(Host, Node, Owner) ->
%% From = jid()
%% JID = jid()
%% @doc <p>Accepts or rejects subcription requests on a PubSub node.</p>
%% @see node_default:subscribe_node/5
%%<p>There are several reasons why the subscription request might fail:</p>
%%<ul>
%%<li>The bare JID portions of the JIDs do not match.
%%<li>The node has an access model of "presence" and the requesting entity is not subscribed to the owner's presence.
%%<li>The node has an access model of "roster" and the requesting entity is not in one of the authorized roster groups.
%%<li>The node has an access model of "whitelist" and the requesting entity is not on the whitelist.
%%<li>The service requires payment for subscriptions to the node.
%%<li>The requesting entity is anonymous and the service does not allow anonymous entities to subscribe.
%%<li>The requesting entity has a pending subscription.
%%<li>The requesting entity is blocked from subscribing (e.g., because having an affiliation of outcast).
%%<li>The node does not support subscriptions.
%%<li>The node does not exist.
%%<li>The bare JID portions of the JIDs do not match.</li>
%%<li>The node has an access model of "presence" and the requesting entity is not subscribed to the owner's presence.</li>
%%<li>The node has an access model of "roster" and the requesting entity is not in one of the authorized roster groups.</li>
%%<li>The node has an access model of "whitelist" and the requesting entity is not on the whitelist.</li>
%%<li>The service requires payment for subscriptions to the node.</li>
%%<li>The requesting entity is anonymous and the service does not allow anonymous entities to subscribe.</li>
%%<li>The requesting entity has a pending subscription.</li>
%%<li>The requesting entity is blocked from subscribing (e.g., because having an affiliation of outcast).</li>
%%<li>The node does not support subscriptions.</li>
%%<li>The node does not exist.</li>
%%</ul>
%% @see node_default:subscribe_node/5
subscribe_node(Host, Node, From, JID) ->
Subscriber = case jlib:string_to_jid(JID) of
error -> {"", "", ""};
@ -1411,7 +1412,7 @@ subscribe_node(Host, Node, From, JID) ->
{result, Result}
end.
%% @spec (Host, Noce, From, JID) -> {error, Reason} | {result, []}
%% @spec (Host, Noce, From, JID, SubId) -> {error, Reason} | {result, []}
%% Host = host()
%% Node = pubsubNode()
%% From = jid()
@ -1421,12 +1422,12 @@ subscribe_node(Host, Node, From, JID) ->
%% @doc <p>Unsubscribe <tt>JID</tt> from the <tt>Node</tt>.</p>
%%<p>There are several reasons why the unsubscribe request might fail:</p>
%%<ul>
%%<li>The requesting entity has multiple subscriptions to the node but does not specify a subscription ID.
%%<li>The request does not specify an existing subscriber.
%%<li>The requesting entity does not have sufficient privileges to unsubscribe the specified JID.
%%<li>The node does not exist.
%%<li>The request specifies a subscription ID that is not valid or current.
%%</il>
%%<li>The requesting entity has multiple subscriptions to the node but does not specify a subscription ID.</li>
%%<li>The request does not specify an existing subscriber.</li>
%%<li>The requesting entity does not have sufficient privileges to unsubscribe the specified JID.</li>
%%<li>The node does not exist.</li>
%%<li>The request specifies a subscription ID that is not valid or current.</li>
%%</ul>
unsubscribe_node(Host, Node, From, JID, SubId) ->
Subscriber = case jlib:string_to_jid(JID) of
error -> {"", "", ""};
@ -1449,12 +1450,12 @@ unsubscribe_node(Host, Node, From, JID, SubId) ->
%% <p>The permission to publish an item must be verified by the plugin implementation.</p>
%%<p>There are several reasons why the publish request might fail:</p>
%%<ul>
%%<li>The requesting entity does not have sufficient privileges to publish.
%%<li>The node does not support item publication.
%%<li>The node does not exist.
%%<li>The payload size exceeds a service-defined limit.
%%<li>The item contains more than one payload element or the namespace of the root payload element does not match the configured namespace for the node.
%%<li>The request does not match the node configuration.
%%<li>The requesting entity does not have sufficient privileges to publish.</li>
%%<li>The node does not support item publication.</li>
%%<li>The node does not exist.</li>
%%<li>The payload size exceeds a service-defined limit.</li>
%%<li>The item contains more than one payload element or the namespace of the root payload element does not match the configured namespace for the node.</li>
%%<li>The request does not match the node configuration.</li>
%%</ul>
publish_item(Host, ServerHost, Node, Publisher, "", Payload) ->
%% if publisher does not specify an ItemId, the service MUST generate the ItemId
@ -1541,12 +1542,12 @@ publish_item(Host, ServerHost, Node, Publisher, ItemId, Payload) ->
%% <p>The permission to delete an item must be verified by the plugin implementation.</p>
%%<p>There are several reasons why the item retraction request might fail:</p>
%%<ul>
%%<li>The publisher does not have sufficient privileges to delete the requested item.
%%<li>The node or item does not exist.
%%<li>The request does not specify a node.
%%<li>The request does not include an <item/> element or the <item/> element does not specify an ItemId.
%%<li>The node does not support persistent items.
%%<li>The service does not support the deletion of items.
%%<li>The publisher does not have sufficient privileges to delete the requested item.</li>
%%<li>The node or item does not exist.</li>
%%<li>The request does not specify a node.</li>
%%<li>The request does not include an <item/> element or the <item/> element does not specify an ItemId.</li>
%%<li>The node does not support persistent items.</li>
%%<li>The service does not support the deletion of items.</li>
%%</ul>
delete_item(Host, Node, Publisher, ItemId) ->
delete_item(Host, Node, Publisher, ItemId, false).
@ -1597,10 +1598,10 @@ delete_item(Host, Node, Publisher, ItemId, ForceNotify) ->
%% @doc <p>Delete all items of specified node owned by JID.</p>
%%<p>There are several reasons why the node purge request might fail:</p>
%%<ul>
%%<li>The node or service does not support node purging.
%%<li>The requesting entity does not have sufficient privileges to purge the node.
%%<li>The node is not configured to persist items.
%%<li>The specified node does not exist.
%%<li>The node or service does not support node purging.</li>
%%<li>The requesting entity does not have sufficient privileges to purge the node.</li>
%%<li>The node is not configured to persist items.</li>
%%<li>The specified node does not exist.</li>
%%</ul>
purge_node(Host, Node, Owner) ->
Action = fun(#pubsub_node{type = Type, options = Options}) ->
@ -1723,15 +1724,16 @@ get_items(Host, Node) ->
%% @spec (Host, Node, LJID) -> any()
%% Host = host()
%% Node = pubsubNode()
%% LJID = {U,S,""}
%% LJID = {U,S,[]}
%% @doc <p>Resend the last item of a node to the user.</p>
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) ->
@ -2020,7 +2022,7 @@ set_subscriptions(Host, Node, From, EntitiesEls) ->
end.
% @spec (OwnerUser, OwnerServer, {SubscriberUser, SubscriberServer, _}, AllowedGroups)
%% @spec (OwnerUser, OwnerServer, {SubscriberUser, SubscriberServer, any()}, AllowedGroups) -> {PresenceSubscription, RosterGroup}
get_roster_info(OwnerUser, OwnerServer, {SubscriberUser, SubscriberServer, _}, AllowedGroups) ->
{Subscription, Groups} =
ejabberd_hooks:run_fold(
@ -2094,11 +2096,11 @@ service_jid(Host) ->
_ -> {jid, "", Host, "", "", Host, ""}
end.
%% @spec (LJID, PresenceDelivery) -> boolean()
%% @spec (LJID, Subscription, PresenceDelivery) -> boolean()
%% LJID = jid()
%% Subscription = atom()
%% PresenceDelivery = boolean()
%% @doc <p>Check if a notification must be delivered or not
%% @doc <p>Check if a notification must be delivered or not</p>
is_to_deliver(_, none, _) -> false;
is_to_deliver(_, pending, _) -> false;
is_to_deliver(_, _, false) -> true;
@ -2113,7 +2115,7 @@ is_to_deliver({User, Server, _}, _, true) ->
%% @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}]}.

18
src/mod_pubsub/node_default.erl
View File

@ -80,7 +80,7 @@
%% API definition
%% ================
%% @spec (Host) -> any()
%% @spec (Host, ServerHost, Opts) -> any()
%% Host = mod_pubsub:host()
%% ServerHost = host()
%% Opts = list()
@ -110,7 +110,7 @@ init(_Host, _ServerHost, _Opts) ->
end,
ok.
%% @spec (Host) -> any()
%% @spec (Host, ServerHost) -> any()
%% Host = mod_pubsub:host()
%% @doc <p>Called during pubsub modules termination. Any pubsub plugin must
%% implement this function. It can return anything.</p>
@ -173,7 +173,7 @@ features() ->
"subscription-notifications"
].
%% @spec (Host, Node, Owner, Access) -> bool()
%% @spec (Host, ServerHost, Node, ParentNode, Owner, Access) -> bool()
%% Host = mod_pubsub:host()
%% ServerHost = mod_pubsub:host()
%% Node = mod_pubsub:pubsubNode()
@ -239,7 +239,7 @@ delete_node(Host, Removed) ->
end, Removed),
{result, {default, broadcast, Removed}}.
%% @spec (Host, Node, Sender, Subscriber, AccessModel, SendLast) ->
%% @spec (Host, Node, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup) ->
%% {error, Reason} | {result, Result}
%% @doc <p>Accepts or rejects subcription requests on a PubSub node.</p>
%% <p>The mechanism works as follow:
@ -557,9 +557,9 @@ set_affiliation(Host, Node, Owner, Affiliation) ->
set_state(State#pubsub_state{affiliation = Affiliation}),
ok.
%% @spec (Host) -> [{Node,Subscription}]
%% @spec (Host, Ownner) -> [{Node,Subscription}]
%% Host = host()
%% JID = mod_pubsub:jid()
%% 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
@ -627,7 +627,7 @@ get_state(Host, Node, JID) ->
_ -> #pubsub_state{stateid=StateId}
end.
%% @spec (State) -> ok | {error, ?ERR_INTERNAL_SERVER_ERROR}
%% @spec (State) -> ok | {error, ErrorCode}
%% State = mod_pubsub:pubsubStates()
%% @doc <p>Write a state into database.</p>
set_state(State) when is_record(State, pubsub_state) ->
@ -746,7 +746,7 @@ get_item(Host, Node, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup
get_item(Host, Node, ItemId)
end.
%% @spec (Item) -> ok | {error, ?ERR_INTERNAL_SERVER_ERROR}
%% @spec (Item) -> ok | {error, ErrorCode}
%% Item = mod_pubsub:pubsubItems()
%% @doc <p>Write a state into database.</p>
set_item(Item) when is_record(Item, pubsub_item) ->
@ -754,7 +754,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()

2
src/mod_pubsub/nodetree_default.erl
View File

@ -58,7 +58,7 @@
%% API definition
%% ================
%% @spec (Host) -> any()
%% @spec (Host, ServerHost, Opts) -> any()
%% Host = mod_pubsub:host()
%% ServerHost = host()
%% Opts = list()

2
src/mod_pubsub/nodetree_virtual.erl
View File

@ -55,7 +55,7 @@
%% API definition
%% ================
%% @spec (Host) -> any()
%% @spec (Host, ServerHost, Opts) -> any()
%% Host = mod_pubsub:host()
%% ServerHost = host()
%% Opts = list()

2
src/mod_pubsub/pubsub.hrl
View File

@ -16,7 +16,7 @@
%%% This software is copyright 2006-2008, ProcessOne.
%%%
%%%
%%% @copyright 2006-2008 ProcessOne
%%% Copyright 2006-2008 ProcessOne
%%%
%%% This file contains pubsub types definition.
%%% ====================================================================