mod_roster: Add some comments for the error cases to improve readability

Tue, 26 May 2009 01:27:07 +0100

author
Matthew Wild <mwild1@gmail.com>
date
Tue, 26 May 2009 01:27:07 +0100
changeset 1200
57a72472e1bc
parent 1199
db2a55fe94f2
child 1201
9d5c1b2cf89c

mod_roster: Add some comments for the error cases to improve readability

plugins/mod_roster.lua file | annotate | diff | comparison | revisions
--- a/plugins/mod_roster.lua	Tue May 26 01:07:52 2009 +0100
+++ b/plugins/mod_roster.lua	Tue May 26 01:27:07 2009 +0100
@@ -114,19 +114,25 @@
 									end
 									local success, err_type, err_cond, err_msg = rm_add_to_roster(session, jid, r_item);
 									if success then
+										-- Ok, send success
 										session.send(st.reply(stanza));
+										-- and push change to all resources
 										rm_roster_push(from_node, from_host, jid);
 									else
+										-- Adding to roster failed
 										session.send(st.error_reply(stanza, err_type, err_cond, err_msg));
 									end
 								end
 							else
+								-- Trying to add self to roster
 								session.send(st.error_reply(stanza, "cancel", "not-allowed"));
 							end
 						else
+							-- Invalid JID added to roster
 							session.send(st.error_reply(stanza, "modify", "bad-request")); -- FIXME what's the correct error?
 						end
 					else
+						-- Roster set didn't include a single item, or its name wasn't  'item'
 						session.send(st.error_reply(stanza, "modify", "bad-request"));
 					end
 					return true;

mercurial