plugins/mod_pep.lua

-- Prosody IM

-- Copyright (C) 2008-2010 Matthew Wild

-- Copyright (C) 2008-2010 Waqas Hussain

-- 

-- This project is MIT/X11 licensed. Please see the

-- COPYING file in the source package for more information.

--

local jid_bare = require "util.jid".bare;

local jid_split = require "util.jid".split;

local st = require "util.stanza";

local hosts = hosts;

local user_exists = require "core.usermanager".user_exists;

local is_contact_subscribed = require "core.rostermanager".is_contact_subscribed;

local pairs, ipairs = pairs, ipairs;

local next = next;

local type = type;

local calculate_hash = require "util.caps".calculate_hash;

local NULL = {};

local data = {};

local recipients = {};

local hash_map = {};

module.save = function()

	return { data = data, recipients = recipients, hash_map = hash_map };

end

module.restore = function(state)

	data = state.data or {};

	recipients = state.recipients or {};

	hash_map = state.hash_map or {};

end

module:add_identity("pubsub", "pep", "Prosody");

module:add_feature("http://jabber.org/protocol/pubsub#publish");

local function subscription_presence(user_bare, recipient)

	local recipient_bare = jid_bare(recipient);

	if (recipient_bare == user_bare) then return true end

	local username, host = jid_split(user_bare);

	return is_contact_subscribed(username, host, recipient_bare);

end

local function publish(session, node, id, item)

	item.attr.xmlns = nil;

	local disable = #item.tags ~= 1 or #item.tags[1] == 0;

	if #item.tags == 0 then item.name = "retract"; end

	local bare = session.username..'@'..session.host;

	local stanza = st.message({from=bare, type='headline'})

		:tag('event', {xmlns='http://jabber.org/protocol/pubsub#event'})

			:tag('items', {node=node})

				:add_child(item)

			:up()

		:up();

	-- store for the future

	local user_data = data[bare];

	if disable then

		if user_data then

			user_data[node] = nil;

			if not next(user_data) then data[bare] = nil; end

		end

	else

		if not user_data then user_data = {}; data[bare] = user_data; end

		user_data[node] = {id or "1", item};

	end

	-- broadcast

	for recipient, notify in pairs(recipients[bare] or NULL) do

		if notify[node] then

			stanza.attr.to = recipient;

			core_post_stanza(session, stanza);

		end

	end

end

local function publish_all(user, recipient, session)

	local d = data[user];

	local notify = recipients[user] and recipients[user][recipient];

	if d and notify then

		for node in pairs(notify) do

			if d[node] then

				local id, item = unpack(d[node]);

				session.send(st.message({from=user, to=recipient, type='headline'})

					:tag('event', {xmlns='http://jabber.org/protocol/pubsub#event'})

						:tag('items', {node=node})

							:add_child(item)

						:up()

					:up());

			end

		end

	end

end

local function get_caps_hash_from_presence(stanza, current)

	local t = stanza.attr.type;

	if not t then

		for _, child in pairs(stanza.tags) do

			if child.name == "c" and child.attr.xmlns == "http://jabber.org/protocol/caps" then

				local attr = child.attr;

				if attr.hash then -- new caps

					if attr.hash == 'sha-1' and attr.node and attr.ver then return attr.ver, attr.node.."#"..attr.ver; end

				else -- legacy caps

					if attr.node and attr.ver then return attr.node.."#"..attr.ver.."#"..(attr.ext or ""), attr.node.."#"..attr.ver; end

				end

				return; -- bad caps format

			end

		end

	elseif t == "unavailable" or t == "error" then

		return;

	end

	return current; -- no caps, could mean caps optimization, so return current

end

module:hook("presence/bare", function(event)

	-- inbound presence to bare JID recieved

	local origin, stanza = event.origin, event.stanza;

	local user = stanza.attr.to or (origin.username..'@'..origin.host);

	local t = stanza.attr.type;

	local self = not stanza.attr.to;

	if not t then -- available presence

		if self or subscription_presence(user, stanza.attr.from) then

			local recipient = stanza.attr.from;

			local current = recipients[user] and recipients[user][recipient];

			local hash = get_caps_hash_from_presence(stanza, current);

			if current == hash then return; end

			if not hash then

				if recipients[user] then recipients[user][recipient] = nil; end

			else

				recipients[user] = recipients[user] or {};

				if hash_map[hash] then

					recipients[user][recipient] = hash_map[hash];

					publish_all(user, recipient, origin);

				else

					recipients[user][recipient] = hash;

					local from_bare = origin.type == "c2s" and origin.username.."@"..origin.host;

					if self or origin.type ~= "c2s" or (recipients[from_bare] and recipients[from_bare][origin.full_jid]) ~= hash then

						origin.send(

							st.stanza("iq", {from=stanza.attr.to, to=stanza.attr.from, id="disco", type="get"})

								:query("http://jabber.org/protocol/disco#info")

						);

					end

				end

			end

		end

	elseif t == "unavailable" then

		if recipients[user] then recipients[user][stanza.attr.from] = nil; end

	elseif not self and t == "unsubscribe" then

		local from = jid_bare(stanza.attr.from);

		local subscriptions = recipients[user];

		if subscriptions then

			for subscriber in pairs(subscriptions) do

				if jid_bare(subscriber) == from then

					recipients[user][subscriber] = nil;

				end

			end

		end

	end

end, 10);

module:hook("iq/bare/http://jabber.org/protocol/pubsub:pubsub", function(event)

	local session, stanza = event.origin, event.stanza;

	local payload = stanza.tags[1];

	if stanza.attr.type == 'set' and (not stanza.attr.to or jid_bare(stanza.attr.from) == stanza.attr.to) then

		payload = payload.tags[1];

		if payload and (payload.name == 'publish' or payload.name == 'retract') and payload.attr.node then -- <publish node='http://jabber.org/protocol/tune'>

			local node = payload.attr.node;

			payload = payload.tags[1];

			if payload and payload.name == "item" then -- <item>

				local id = payload.attr.id;

				session.send(st.reply(stanza));

				publish(session, node, id, st.clone(payload));

				return true;

			end

		end

	elseif stanza.attr.type == 'get' then

		local user = stanza.attr.to and jid_bare(stanza.attr.to) or session.username..'@'..session.host;

		if subscription_presence(user, stanza.attr.from) then

			local user_data = data[user];

			local node, requested_id;

			payload = payload.tags[1];

			if payload and payload.name == 'items' then

				node = payload.attr.node;

				local item = payload.tags[1];

				if item and item.name == "item" then

					requested_id = item.attr.id;

				end

			end

			if node and user_data and user_data[node] then -- Send the last item

				local id, item = unpack(user_data[node]);

				if not requested_id or id == requested_id then

					local stanza = st.reply(stanza)

						:tag('pubsub', {xmlns='http://jabber.org/protocol/pubsub'})

							:tag('items', {node=node})

								:add_child(item)

							:up()

						:up();

					session.send(stanza);

					return true;

				else -- requested item doesn't exist

					local stanza = st.reply(stanza)

						:tag('pubsub', {xmlns='http://jabber.org/protocol/pubsub'})

							:tag('items', {node=node})

						:up();

					session.send(stanza);

					return true;

				end

			elseif node then -- node doesn't exist

				session.send(st.error_reply(stanza, 'cancel', 'item-not-found'));

				return true;

			else --invalid request

				session.send(st.error_reply(stanza, 'modify', 'bad-request'));

				return true;

			end

		else --no presence subscription

			session.send(st.error_reply(stanza, 'auth', 'not-authorized')

				:tag('presence-subscription-required', {xmlns='http://jabber.org/protocol/pubsub#errors'}));

			return true;

		end

	end

end);

module:hook("iq-result/bare/disco", function(event)

	local session, stanza = event.origin, event.stanza;

	if stanza.attr.type == "result" then

		local disco = stanza.tags[1];

		if disco and disco.name == "query" and disco.attr.xmlns == "http://jabber.org/protocol/disco#info" then

			-- Process disco response

			local self = not stanza.attr.to;

			local user = stanza.attr.to or (session.username..'@'..session.host);

			local contact = stanza.attr.from;

			local current = recipients[user] and recipients[user][contact];

			if type(current) ~= "string" then return; end -- check if waiting for recipient's response

			local ver = current;

			if not string.find(current, "#") then

				ver = calculate_hash(disco.tags); -- calculate hash

			end

			local notify = {};

			for _, feature in pairs(disco.tags) do

				if feature.name == "feature" and feature.attr.var then

					local nfeature = feature.attr.var:match("^(.*)%+notify$");

					if nfeature then notify[nfeature] = true; end

				end

			end

			hash_map[ver] = notify; -- update hash map

			if self then

				for jid, item in pairs(session.roster) do -- for all interested contacts

					if item.subscription == "both" or item.subscription == "from" then

						if not recipients[jid] then recipients[jid] = {}; end

						recipients[jid][contact] = notify;

						publish_all(jid, contact, session);

					end

				end

			end

			recipients[user][contact] = notify; -- set recipient's data to calculated data

			-- send messages to recipient

			publish_all(user, contact, session);

		end

	end

end);

module:hook("account-disco-info", function(event)

	local stanza = event.stanza;

	stanza:tag('identity', {category='pubsub', type='pep'}):up();

	stanza:tag('feature', {var='http://jabber.org/protocol/pubsub#publish'}):up();

end);

module:hook("account-disco-items", function(event)

	local stanza = event.stanza;

	local bare = stanza.attr.to;

	local user_data = data[bare];

	if user_data then

		for node, _ in pairs(user_data) do

			stanza:tag('item', {jid=bare, node=node}):up(); -- TODO we need to handle queries to these nodes

		end

	end

end);