Merge presence/subscription support from waqas

Sun, 26 Oct 2008 13:19:09 +0000

author
Matthew Wild <mwild1@gmail.com>
date
Sun, 26 Oct 2008 13:19:09 +0000
changeset 178
8315cf03f304
parent 169
92768120b717 (current diff)
parent 177
606c433955e7 (diff)
child 179
774a172b03c8

Merge presence/subscription support from waqas

core/stanza_router.lua file | annotate | diff | comparison | revisions
--- a/core/rostermanager.lua	Sun Oct 26 13:14:14 2008 +0000
+++ b/core/rostermanager.lua	Sun Oct 26 13:19:09 2008 +0000
@@ -49,7 +49,7 @@
 end
 
 function roster_push(username, host, jid)
-	if hosts[host] and hosts[host].sessions[username] and hosts[host].sessions[username].roster then
+	if jid ~= "pending" and hosts[host] and hosts[host].sessions[username] and hosts[host].sessions[username].roster then
 		local item = hosts[host].sessions[username].roster[jid];
 		local stanza = st.iq({type="set"});
 		stanza:tag("query", {xmlns = "jabber:iq:roster"});
@@ -74,23 +74,196 @@
 end
 
 function load_roster(username, host)
+	log("debug", "load_roster: asked for: "..username.."@"..host);
 	if hosts[host] and hosts[host].sessions[username] then
 		local roster = hosts[host].sessions[username].roster;
 		if not roster then
+			log("debug", "load_roster: loading for new user: "..username.."@"..host);
 			roster = datamanager.load(username, host, "roster") or {};
 			hosts[host].sessions[username].roster = roster;
 		end
 		return roster;
 	end
 	-- Attempt to load roster for non-loaded user
-	-- TODO also support loading for offline user
+	log("debug", "load_roster: loading for offline user: "..username.."@"..host);
+	return datamanager.load(username, host, "roster") or {};
 end
 
 function save_roster(username, host)
+	log("debug", "save_roster: saving roster for "..username.."@"..host);
 	if hosts[host] and hosts[host].sessions[username] and hosts[host].sessions[username].roster then
 		return datamanager.store(username, host, "roster", hosts[host].sessions[username].roster);
 	end
 	return nil;
 end
 
+function process_inbound_subscription_approval(username, host, jid)
+	local roster = load_roster(username, host);
+	local item = roster[jid];
+	if item and item.ask then
+		if item.subscription == "none" then
+			item.subscription = "to";
+		else -- subscription == from
+			item.subscription = "both";
+		end
+		item.ask = nil;
+		return datamanager.store(username, host, "roster", roster);
+	end
+end
+
+function process_inbound_subscription_cancellation(username, host, jid)
+	local roster = load_roster(username, host);
+	local item = roster[jid];
+	local changed = nil;
+	if is_contact_pending_out(username, host, jid) then
+		item.ask = nil;
+		changed = true;
+	end
+	if item then
+		if item.subscription == "to" then
+			item.subscription = "none";
+			changed = true;
+		elseif item.subscription == "both" then
+			item.subscription = "from";
+			changed = true;
+		end
+	end
+	if changed then
+		return datamanager.store(username, host, "roster", roster);
+	end
+end
+
+function process_inbound_unsubscribe(username, host, jid)
+	local roster = load_roster(username, host);
+	local item = roster[jid];
+	local changed = nil;
+	if is_contact_pending_in(username, host, jid) then
+		roster.pending[jid] = nil; -- TODO maybe delete roster.pending if empty?
+		changed = true;
+	end
+	if item then
+		if item.subscription == "from" then
+			item.subscription = "none";
+			changed = true;
+		elseif item.subscription == "both" then
+			item.subscription = "to";
+			changed = true;
+		end
+	end
+	if changed then
+		return datamanager.store(username, host, "roster", roster);
+	end
+end
+
+function is_contact_subscribed(username, host, jid)
+	local roster = load_roster(username, host);
+	local item = roster[jid];
+	return item and (item.subscription == "from" or item.subscription == "both");
+end
+
+function is_contact_pending_in(username, host, jid)
+	local roster = load_roster(username, host);
+	return roster.pending and roster.pending[jid];
+end
+function set_contact_pending_in(username, host, jid, pending)
+	local roster = load_roster(username, host);
+	local item = roster[jid];
+	if item and (item.subscription == "from" or item.subscription == "both") then
+		return; -- false
+	end
+	if not roster.pending then roster.pending = {}; end
+	roster.pending[jid] = true;
+	return datamanager.store(username, host, "roster", roster);
+end
+function is_contact_pending_out(username, host, jid)
+	local roster = load_roster(username, host);
+	local item = roster[jid];
+	return item and item.ask;
+end
+function set_contact_pending_out(username, host, jid) -- subscribe
+	local roster = load_roster(username, host);
+	local item = roster[jid];
+	if item and (item.ask or item.subscription == "to" or item.subscription == "both") then
+		return true;
+	end
+	if not item then
+		item = {subscription = "none", groups = {}};
+		roster[jid] = item;
+	end
+	item.ask = "subscribe";
+	log("debug", "set_contact_pending_out: saving roster; set "..username.."@"..host..".roster["..jid.."].ask=subscribe");
+	return datamanager.store(username, host, "roster", roster);
+end
+function unsubscribe(username, host, jid)
+	local roster = load_roster(username, host);
+	local item = roster[jid];
+	if not item then return false; end
+	if (item.subscription == "from" or item.subscription == "none") and not item.ask then
+		return true;
+	end
+	item.ask = nil;
+	if item.subscription == "both" then
+		item.subscription = "from";
+	elseif item.subscription == "to" then
+		item.subscription = "none";
+	end
+	return datamanager.store(username, host, "roster", roster);
+end
+function subscribed(username, host, jid)
+	if is_contact_pending_in(username, host, jid) then
+		local roster = load_roster(username, host);
+		local item = roster[jid];
+		if item.subscription == "none" then
+			item.subscription = "from";
+		else -- subscription == to
+			item.subscription = "both";
+		end
+		roster.pending[jid] = nil;
+		-- TODO maybe remove roster.pending if empty
+		return datamanager.store(username, host, "roster", roster);
+	end -- TODO else implement optional feature pre-approval (ask = subscribed)
+end
+function unsubscribed(username, host, jid)
+	local roster = load_roster(username, host);
+	local item = roster[jid];
+	local pending = is_contact_pending_in(username, host, jid);
+	local changed = nil;
+	if is_contact_pending_in(username, host, jid) then
+		roster.pending[jid] = nil; -- TODO maybe delete roster.pending if empty?
+		changed = true;
+	end
+	if item then
+		if item.subscription == "from" then
+			item.subscription = "none";
+			changed = true;
+		elseif item.subscription == both then
+			item.subscription = "to";
+			changed = true;
+		end
+	end
+	if changed then
+		return datamanager.store(username, host, "roster", roster);
+	end
+end
+
+function process_outbound_subscription_request(username, host, jid)
+	local roster = load_roster(username, host);
+	local item = roster[jid];
+	if item and (item.subscription == "none" or item.subscription == "from") then
+		item.ask = "subscribe";
+		return datamanager.store(username, host, "roster", roster);
+	end
+end
+
+--[[function process_outbound_subscription_approval(username, host, jid)
+	local roster = load_roster(username, host);
+	local item = roster[jid];
+	if item and (item.subscription == "none" or item.subscription == "from" then
+		item.ask = "subscribe";
+		return datamanager.store(username, host, "roster", roster);
+	end
+end]]
+
+
+
 return _M;
\ No newline at end of file
--- a/core/sessionmanager.lua	Sun Oct 26 13:14:14 2008 +0000
+++ b/core/sessionmanager.lua	Sun Oct 26 13:19:09 2008 +0000
@@ -115,4 +115,24 @@
 						session.notopen = nil;
 end
 
+function send_to_available_resources(user, host, stanza)
+	local count = 0;
+	local to = stanza.attr.to;
+	stanza.attr.to = nil;
+	local h = hosts[host];
+	if h and h.type == "local" then
+		local u = h.sessions[user];
+		if u then
+			for k, session in pairs(u.sessions) do
+				if session.presence then
+					session.send(stanza);
+					count = count + 1;
+				end
+			end
+		end
+	end
+	stanza.attr.to = to;
+	return count;
+end
+
 return _M;
\ No newline at end of file
--- a/core/stanza_router.lua	Sun Oct 26 13:14:14 2008 +0000
+++ b/core/stanza_router.lua	Sun Oct 26 13:19:09 2008 +0000
@@ -8,10 +8,25 @@
 local log = require "util.logger".init("stanzarouter")
 
 local st = require "util.stanza";
-local send = require "core.sessionmanager".send_to_session;
+local _send = require "core.sessionmanager".send_to_session;
 local send_s2s = require "core.s2smanager".send_to_host;
+function send(session, stanza)
+	if session.type == "c2s" then
+		_send(session, stanza);
+	else
+		local xmlns = stanza.attr.xmlns;
+		--stanza.attr.xmlns = "jabber:server";
+		stanza.attr.xmlns = nil;
+		log("debug", "sending s2s stanza: %s", tostring(stanza));
+		send_s2s(session.host, host, stanza); -- TODO handle remote routing errors
+		stanza.attr.xmlns = xmlns; -- reset
+	end
+end
 local user_exists = require "core.usermanager".user_exists;
 
+local rostermanager = require "core.rostermanager";
+local sessionmanager = require "core.sessionmanager";
+
 local s2s_verify_dialback = require "core.s2smanager".verify_dialback;
 local s2s_make_authenticated = require "core.s2smanager".make_authenticated;
 local format = string.format;
@@ -44,7 +59,13 @@
 	end
 	
 	if not to then
-			core_handle_stanza(origin, stanza);
+		core_handle_stanza(origin, stanza);
+	elseif origin.type == "c2s" and stanza.name == "presence" and stanza.attr.type ~= nil and stanza.attr.type ~= "unavailable" then
+		local node, host = jid_split(stanza.attr.to);
+		local to_bare = node and (node.."@"..host) or host; -- bare JID
+		local from_node, from_host = jid_split(stanza.attr.from);
+		local from_bare = from_node and (from_node.."@"..from_host) or from_host; -- bare JID
+		handle_outbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare);
 	elseif hosts[to] and hosts[to].type == "local" then
 		core_handle_stanza(origin, stanza);
 	elseif stanza.name == "iq" and not select(3, jid_split(to)) then
@@ -77,7 +98,7 @@
 						core_route_stanza(origin, stanza);
 					end
 				end
-				if not origin.presence then -- presence probes on initial presence
+				if not origin.presence then -- presence probes on initial presence -- FIXME does unavailable qualify as initial presence?
 					local probe = st.presence({from = origin.full_jid, type = "probe"});
 					for jid in pairs(origin.roster) do -- probe all contacts we are subscribed to
 						local subscription = origin.roster[jid].subscription;
@@ -162,10 +183,110 @@
 	end
 end
 
-function is_authorized_to_see_presence(origin, username, host)
-	local roster = datamanager.load(username, host, "roster") or {};
-	local item = roster[origin.username.."@"..origin.host];
-	return item and (item.subscription == "both" or item.subscription == "from");
+function send_presence_of_available_resources(user, host, jid, recipient_session)
+	local h = hosts[host];
+	local count = 0;
+	if h and h.type == "local" then
+		local u = h.sessions[user];
+		if u then
+			for k, session in pairs(u.sessions) do
+				local pres = session.presence;
+				if pres then
+					pres.attr.to = jid;
+					pres.attr.from = session.full_jid;
+					send(recipient_session, pres);
+					pres.attr.to = nil;
+					pres.attr.from = nil;
+					count = count + 1;
+				end
+			end
+		end
+	end
+	return count;
+end
+
+function handle_outbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare)
+	local node, host = jid_split(from_bare);
+	local st_from, st_to = stanza.attr.from, stanza.attr.to;
+	stanza.attr.from, stanza.attr.to = from_bare, to_bare;
+	if stanza.attr.type == "subscribe" then
+		log("debug", "outbound subscribe from "..from_bare.." for "..to_bare);
+		-- 1. route stanza
+		-- 2. roster push (subscription = none, ask = subscribe)
+		if rostermanager.set_contact_pending_out(node, host, to_bare) then
+			rostermanager.roster_push(node, host, to_bare);
+		end -- else file error
+		core_route_stanza(origin, stanza);
+	elseif stanza.attr.type == "unsubscribe" then
+		log("debug", "outbound unsubscribe from "..from_bare.." for "..to_bare);
+		-- 1. route stanza
+		-- 2. roster push (subscription = none or from)
+		if rostermanager.unsubscribe(node, host, to_bare) then
+			rostermanager.roster_push(node, host, to_bare); -- FIXME do roster push when roster has in fact not changed?
+		end -- else file error
+		core_route_stanza(origin, stanza);
+	elseif stanza.attr.type == "subscribed" then
+		log("debug", "outbound subscribed from "..from_bare.." for "..to_bare);
+		-- 1. route stanza
+		-- 2. roster_push ()
+		-- 3. send_presence_of_available_resources
+		if rostermanager.subscribed(node, host, to_bare) then
+			rostermanager.roster_push(node, host, to_bare);
+			core_route_stanza(origin, stanza);
+			send_presence_of_available_resources(node, host, to_bare, origin);
+		end
+	elseif stanza.attr.type == "unsubscribed" then
+		log("debug", "outbound unsubscribed from "..from_bare.." for "..to_bare);
+		-- 1. route stanza
+		-- 2. roster push (subscription = none or to)
+		if rostermanager.unsubscribed(node, host, to_bare) then
+			rostermanager.roster_push(node, host, to_bare);
+			core_route_stanza(origin, stanza);
+		end
+	end
+	stanza.attr.from, stanza.attr.to = st_from, st_to;
+end
+
+function handle_inbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare)
+	local node, host = jid_split(to_bare);
+	local st_from, st_to = stanza.attr.from, stanza.attr.to;
+	stanza.attr.from, stanza.attr.to = from_bare, to_bare;
+	if stanza.attr.type == "probe" then
+		if rostermanager.is_contact_subscribed(node, host, from_bare) then
+			if 0 == send_presence_of_available_resources(node, host, from_bare, origin) then
+				-- TODO send last recieved unavailable presence (or we MAY do nothing, which is fine too)
+			end
+		else
+			core_route_stanza(origin, st.presence({from=to_bare, to=from_bare, type="unsubscribed"}));
+		end
+	elseif stanza.attr.type == "subscribe" then
+		log("debug", "inbound subscribe from "..from_bare.." for "..to_bare);
+		if rostermanager.is_contact_subscribed(node, host, from_bare) then
+			core_route_stanza(origin, st.presence({from=to_bare, to=from_bare, type="subscribed"})); -- already subscribed
+		else
+			if not rostermanager.is_contact_pending_in(node, host, from_bare) then
+				if rostermanager.set_contact_pending_in(node, host, from_bare) then
+					sessionmanager.send_to_available_resources(node, host, stanza);
+				end -- TODO else return error, unable to save
+			end
+		end
+	elseif stanza.attr.type == "unsubscribe" then
+		log("debug", "inbound unsubscribe from "..from_bare.." for "..to_bare);
+		if rostermanager.process_inbound_unsubscribe(node, host, from_bare) then
+			rostermanager.roster_push(node, host, from_bare);
+		end
+	elseif stanza.attr.type == "subscribed" then
+		log("debug", "inbound subscribed from "..from_bare.." for "..to_bare);
+		if rostermanager.process_inbound_subscription_approval(node, host, from_bare) then
+			rostermanager.roster_push(node, host, from_bare);
+		end
+	elseif stanza.attr.type == "unsubscribed" then
+		log("debug", "inbound unsubscribed from "..from_bare.." for "..to_bare);
+		if rostermanager.process_inbound_subscription_approval(node, host, from_bare) then
+			rostermanager.roster_push(node, host, from_bare);
+		end
+	end -- discard any other type
+	stanza.attr.from, stanza.attr.to = st_from, st_to;
 end
 
 function core_route_stanza(origin, stanza)
@@ -175,6 +296,10 @@
 	-- Deliver
 	local to = stanza.attr.to;
 	local node, host, resource = jid_split(to);
+	local to_bare = node and (node.."@"..host) or host; -- bare JID
+	local from = stanza.attr.from;
+	local from_node, from_host, from_resource = jid_split(from);
+	local from_bare = from_node and (from_node.."@"..from_host) or from_host; -- bare JID
 
 	if stanza.name == "presence" and (stanza.attr.type ~= nil and stanza.attr.type ~= "unavailable") then resource = nil; end
 
@@ -188,34 +313,11 @@
 				-- if we get here, resource was not specified or was unavailable
 				if stanza.name == "presence" then
 					if stanza.attr.type ~= nil and stanza.attr.type ~= "unavailable" then
-						if stanza.attr.type == "probe" then
-							if is_authorized_to_see_presence(origin, node, host) then
-								for k in pairs(user.sessions) do -- return presence for all resources
-									if user.sessions[k].presence then
-										local pres = user.sessions[k].presence;
-										pres.attr.to = origin.full_jid;
-										pres.attr.from = user.sessions[k].full_jid;
-										send(origin, pres);
-										pres.attr.to = nil;
-										pres.attr.from = nil;
-									end
-								end
-							else
-								send(origin, st.presence({from=user.."@"..host, to=origin.username.."@"..origin.host, type="unsubscribed"}));
-							end
-						elseif stanza.attr.type == "subscribe" then
-							-- TODO
-						elseif stanza.attr.type == "unsubscribe" then
-							-- TODO
-						elseif stanza.attr.type == "subscribed" then
-							-- TODO
-						elseif stanza.attr.type == "unsubscribed" then
-							-- TODO
-						end -- discard any other type
+						handle_inbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare);
 					else -- sender is available or unavailable
-						for k in pairs(user.sessions) do -- presence broadcast to all user resources
+						for k in pairs(user.sessions) do -- presence broadcast to all user resources. FIXME should this be just for available resources? Do we need to check subscription?
 							if user.sessions[k].full_jid then
-								stanza.attr.to = user.sessions[k].full_jid;
+								stanza.attr.to = user.sessions[k].full_jid; -- reset at the end of function
 								send(user.sessions[k], stanza);
 							end
 						end
@@ -234,17 +336,17 @@
 				end
 			else
 				-- User + resource is online...
-				stanza.attr.to = res.full_jid;
+				stanza.attr.to = res.full_jid; -- reset at the end of function
 				send(res, stanza); -- Yay \o/
 			end
 		else
 			-- user not online
 			if user_exists(node, host) then
 				if stanza.name == "presence" then
-					if stanza.attr.type == "probe" and is_authorized_to_see_presence(origin, node, host) then -- FIXME what to do for not c2s?
-						-- TODO send last recieved unavailable presence
+					if stanza.attr.type ~= nil and stanza.attr.type ~= "unavailable" then
+						handle_inbound_presence_subscriptions_and_probes(origin, stanza, from_bare, to_bare);
 					else
-						-- TODO send unavailable presence
+						-- TODO send unavailable presence or unsubscribed
 					end
 				elseif stanza.name == "message" then
 					-- TODO send message error, or store offline messages
@@ -255,7 +357,7 @@
 				-- TODO we would get here for nodeless JIDs too. Do something fun maybe? Echo service? Let plugins use xmpp:server/resource addresses?
 				if stanza.name == "presence" then
 					if stanza.attr.type == "probe" then
-						send(origin, st.presence({from = stanza.attr.to, to = stanza.attr.from, type = "unsubscribed"}));
+						send(origin, st.presence({from = to_bare, to = from_bare, type = "unsubscribed"}));
 					end
 					-- else ignore
 				else
@@ -265,10 +367,12 @@
 		end
 	elseif origin.type == "c2s" then
 		-- Remote host
+		local xmlns = stanza.attr.xmlns;
 		--stanza.attr.xmlns = "jabber:server";
 		stanza.attr.xmlns = nil;
 		log("debug", "sending s2s stanza: %s", tostring(stanza));
-		send_s2s(origin.host, host, stanza);
+		send_s2s(origin.host, host, stanza); -- TODO handle remote routing errors
+		stanza.attr.xmlns = xmlns; -- reset
 	else
 		log("warn", "received stanza from unhandled connection type: %s", origin.type);
 	end
--- a/plugins/mod_roster.lua	Sun Oct 26 13:14:14 2008 +0000
+++ b/plugins/mod_roster.lua	Sun Oct 26 13:19:09 2008 +0000
@@ -16,14 +16,16 @@
 					local roster = st.reply(stanza)
 								:query("jabber:iq:roster");
 					for jid in pairs(session.roster) do
-						roster:tag("item", {
-							jid = jid,
-							subscription = session.roster[jid].subscription,
-							ask = session.roster[jid].ask,
-							name = session.roster[jid].name,
-						});
-						for group in pairs(session.roster[jid].groups) do
-							roster:tag("group"):text(group):up();
+						if jid ~= "pending" then
+							roster:tag("item", {
+								jid = jid,
+								subscription = session.roster[jid].subscription,
+								ask = session.roster[jid].ask,
+								name = session.roster[jid].name,
+							});
+							for group in pairs(session.roster[jid].groups) do
+								roster:tag("group"):text(group):up();
+							end
 						end
 					end
 					send(session, roster);
@@ -32,7 +34,8 @@
 				elseif stanza.attr.type == "set" then
 					local query = stanza.tags[1];
 					if #query.tags == 1 and query.tags[1].name == "item"
-							and query.tags[1].attr.xmlns == "jabber:iq:roster" and query.tags[1].attr.jid then
+							and query.tags[1].attr.xmlns == "jabber:iq:roster" and query.tags[1].attr.jid
+							and query.tags[1].attr.jid ~= "pending" then
 						local item = query.tags[1];
 						local from_node, from_host = jid_split(stanza.attr.from);
 						local node, host, resource = jid_split(item.attr.jid);
--- a/util/datamanager.lua	Sun Oct 26 13:14:14 2008 +0000
+++ b/util/datamanager.lua	Sun Oct 26 13:19:09 2008 +0000
@@ -6,6 +6,7 @@
 local log = log;
 local io_open = io.open;
 local tostring = tostring;
+local error = error;
 
 module "datamanager"
 
@@ -49,6 +50,8 @@
           f:write(",\n")
         end
         f:write("}\n")
+      elseif type(o) == "boolean" then
+        f:write(o and "true" or "false");
       else
         error("cannot serialize a " .. type(o))
       end

mercurial