2 -- Copyright (C) 2008-2010 Matthew Wild
3 -- Copyright (C) 2008-2010 Waqas Hussain
5 -- This project is MIT/X11 licensed. Please see the
6 -- COPYING file in the source package for more information.
12 local log = require "util.logger".init("rostermanager");
14 local setmetatable = setmetatable;
15 local format = string.format;
17 local pairs, ipairs = pairs, ipairs;
18 local tostring = tostring;
21 local bare_sessions = bare_sessions;
23 local datamanager = require "util.datamanager"
24 local st = require "util.stanza";
26 module "rostermanager"
28 function add_to_roster(session, jid, item)
29 if session.roster then
30 local old_item = session.roster[jid];
31 session.roster[jid] = item;
32 if save_roster(session.username, session.host) then
35 session.roster[jid] = old_item;
36 return nil, "wait", "internal-server-error", "Unable to save roster";
39 return nil, "auth", "not-authorized", "Session's roster not loaded";
43 function remove_from_roster(session, jid)
44 if session.roster then
45 local old_item = session.roster[jid];
46 session.roster[jid] = nil;
47 if save_roster(session.username, session.host) then
50 session.roster[jid] = old_item;
51 return nil, "wait", "internal-server-error", "Unable to save roster";
54 return nil, "auth", "not-authorized", "Session's roster not loaded";
58 function roster_push(username, host, jid)
59 local roster = jid and jid ~= "pending" and hosts[host] and hosts[host].sessions[username] and hosts[host].sessions[username].roster;
61 local item = hosts[host].sessions[username].roster[jid];
62 local stanza = st.iq({type="set"});
63 stanza:tag("query", {xmlns = "jabber:iq:roster", ver = tostring(roster[false].version or "1") });
65 stanza:tag("item", {jid = jid, subscription = item.subscription, name = item.name, ask = item.ask});
66 for group in pairs(item.groups) do
67 stanza:tag("group"):text(group):up();
70 stanza:tag("item", {jid = jid, subscription = "remove"});
72 stanza:up(); -- move out from item
73 stanza:up(); -- move out from stanza
75 for _, session in pairs(hosts[host].sessions[username].sessions) do
76 if session.interested then
77 -- FIXME do we need to set stanza.attr.to?
84 function load_roster(username, host)
85 local jid = username.."@"..host;
86 log("debug", "load_roster: asked for: %s", jid);
87 local user = bare_sessions[jid];
91 if roster then return roster; end
92 log("debug", "load_roster: loading for new user: %s@%s", username, host);
93 else -- Attempt to load roster for non-loaded user
94 log("debug", "load_roster: loading for offline user: %s@%s", username, host);
96 local data, err = datamanager.load(username, host, "roster");
98 if user then user.roster = roster; end
99 if not roster[false] then roster[false] = { broken = err or nil }; end
102 log("warn", "roster for %s has a self-contact", jid);
105 hosts[host].events.fire_event("roster-load", username, host, roster);
110 function save_roster(username, host, roster)
111 log("debug", "save_roster: saving roster for %s@%s", username, host);
113 roster = hosts[host] and hosts[host].sessions[username] and hosts[host].sessions[username].roster;
115 -- --roster = load_roster(username, host);
116 -- return true; -- roster unchanged, no reason to save
120 local metadata = roster[false];
123 roster[false] = metadata;
125 if metadata.version ~= true then
126 metadata.version = (metadata.version or 0) + 1;
128 if roster[false].broken then return nil, "Not saving broken roster" end
129 return datamanager.store(username, host, "roster", roster);
131 log("warn", "save_roster: user had no roster to save");
135 function process_inbound_subscription_approval(username, host, jid)
136 local roster = load_roster(username, host);
137 local item = roster[jid];
138 if item and item.ask then
139 if item.subscription == "none" then
140 item.subscription = "to";
141 else -- subscription == from
142 item.subscription = "both";
145 return save_roster(username, host, roster);
149 function process_inbound_subscription_cancellation(username, host, jid)
150 local roster = load_roster(username, host);
151 local item = roster[jid];
153 if is_contact_pending_out(username, host, jid) then
158 if item.subscription == "to" then
159 item.subscription = "none";
161 elseif item.subscription == "both" then
162 item.subscription = "from";
167 return save_roster(username, host, roster);
171 function process_inbound_unsubscribe(username, host, jid)
172 local roster = load_roster(username, host);
173 local item = roster[jid];
175 if is_contact_pending_in(username, host, jid) then
176 roster.pending[jid] = nil; -- TODO maybe delete roster.pending if empty?
180 if item.subscription == "from" then
181 item.subscription = "none";
183 elseif item.subscription == "both" then
184 item.subscription = "to";
189 return save_roster(username, host, roster);
193 local function _get_online_roster_subscription(jidA, jidB)
194 local user = bare_sessions[jidA];
195 local item = user and (user.roster[jidB] or { subscription = "none" });
196 return item and item.subscription;
198 function is_contact_subscribed(username, host, jid)
200 local selfjid = username.."@"..host;
201 local subscription = _get_online_roster_subscription(selfjid, jid);
202 if subscription then return (subscription == "both" or subscription == "from"); end
203 local subscription = _get_online_roster_subscription(jid, selfjid);
204 if subscription then return (subscription == "both" or subscription == "to"); end
206 local roster, err = load_roster(username, host);
207 local item = roster[jid];
208 return item and (item.subscription == "from" or item.subscription == "both"), err;
211 function is_contact_pending_in(username, host, jid)
212 local roster = load_roster(username, host);
213 return roster.pending and roster.pending[jid];
215 function set_contact_pending_in(username, host, jid, pending)
216 local roster = load_roster(username, host);
217 local item = roster[jid];
218 if item and (item.subscription == "from" or item.subscription == "both") then
221 if not roster.pending then roster.pending = {}; end
222 roster.pending[jid] = true;
223 return save_roster(username, host, roster);
225 function is_contact_pending_out(username, host, jid)
226 local roster = load_roster(username, host);
227 local item = roster[jid];
228 return item and item.ask;
230 function set_contact_pending_out(username, host, jid) -- subscribe
231 local roster = load_roster(username, host);
232 local item = roster[jid];
233 if item and (item.ask or item.subscription == "to" or item.subscription == "both") then
237 item = {subscription = "none", groups = {}};
240 item.ask = "subscribe";
241 log("debug", "set_contact_pending_out: saving roster; set %s@%s.roster[%q].ask=subscribe", username, host, jid);
242 return save_roster(username, host, roster);
244 function unsubscribe(username, host, jid)
245 local roster = load_roster(username, host);
246 local item = roster[jid];
247 if not item then return false; end
248 if (item.subscription == "from" or item.subscription == "none") and not item.ask then
252 if item.subscription == "both" then
253 item.subscription = "from";
254 elseif item.subscription == "to" then
255 item.subscription = "none";
257 return save_roster(username, host, roster);
259 function subscribed(username, host, jid)
260 if is_contact_pending_in(username, host, jid) then
261 local roster = load_roster(username, host);
262 local item = roster[jid];
263 if not item then -- FIXME should roster item be auto-created?
264 item = {subscription = "none", groups = {}};
267 if item.subscription == "none" then
268 item.subscription = "from";
269 else -- subscription == to
270 item.subscription = "both";
272 roster.pending[jid] = nil;
273 -- TODO maybe remove roster.pending if empty
274 return save_roster(username, host, roster);
275 end -- TODO else implement optional feature pre-approval (ask = subscribed)
277 function unsubscribed(username, host, jid)
278 local roster = load_roster(username, host);
279 local item = roster[jid];
280 local pending = is_contact_pending_in(username, host, jid);
282 if is_contact_pending_in(username, host, jid) then
283 roster.pending[jid] = nil; -- TODO maybe delete roster.pending if empty?
287 if item.subscription == "from" then
288 item.subscription = "none";
290 elseif item.subscription == "both" then
291 item.subscription = "to";
296 return save_roster(username, host, roster);
300 function process_outbound_subscription_request(username, host, jid)
301 local roster = load_roster(username, host);
302 local item = roster[jid];
303 if item and (item.subscription == "none" or item.subscription == "from") then
304 item.ask = "subscribe";
305 return save_roster(username, host, roster);
309 --[[function process_outbound_subscription_approval(username, host, jid)
310 local roster = load_roster(username, host);
311 local item = roster[jid];
312 if item and (item.subscription == "none" or item.subscription == "from" then
313 item.ask = "subscribe";
314 return save_roster(username, host, roster);