1 local pubsub = require "util.pubsub";
2 local st = require "util.stanza";
3 local jid_bare = require "util.jid".bare;
4 local uuid_generate = require "util.uuid".generate;
5 local usermanager = require "core.usermanager";
7 local xmlns_pubsub = "http://jabber.org/protocol/pubsub";
8 local xmlns_pubsub_errors = "http://jabber.org/protocol/pubsub#errors";
9 local xmlns_pubsub_event = "http://jabber.org/protocol/pubsub#event";
10 local xmlns_pubsub_owner = "http://jabber.org/protocol/pubsub#owner";
12 local autocreate_on_publish = module:get_option_boolean("autocreate_on_publish", false);
13 local autocreate_on_subscribe = module:get_option_boolean("autocreate_on_subscribe", false);
14 local pubsub_disco_name = module:get_option("name");
15 if type(pubsub_disco_name) ~= "string" then pubsub_disco_name = "Prosody PubSub Service"; end
21 function handle_pubsub_iq(event)
22 local origin, stanza = event.origin, event.stanza;
23 local pubsub = stanza.tags[1];
24 local action = pubsub.tags[1];
26 return origin.send(st.error_reply(stanza, "cancel", "bad-request"));
28 local handler = handlers[stanza.attr.type.."_"..action.name];
30 handler(origin, stanza, action);
35 local pubsub_errors = {
36 ["conflict"] = { "cancel", "conflict" };
37 ["invalid-jid"] = { "modify", "bad-request", nil, "invalid-jid" };
38 ["jid-required"] = { "modify", "bad-request", nil, "jid-required" };
39 ["nodeid-required"] = { "modify", "bad-request", nil, "nodeid-required" };
40 ["item-not-found"] = { "cancel", "item-not-found" };
41 ["not-subscribed"] = { "modify", "unexpected-request", nil, "not-subscribed" };
42 ["forbidden"] = { "cancel", "forbidden" };
44 function pubsub_error_reply(stanza, error)
45 local e = pubsub_errors[error];
46 local reply = st.error_reply(stanza, unpack(e, 1, 3));
48 reply:tag(e[4], { xmlns = xmlns_pubsub_errors }):up();
53 function handlers.get_items(origin, stanza, items)
54 local node = items.attr.node;
55 local item = items:get_child("item");
56 local id = item and item.attr.id;
59 return origin.send(pubsub_error_reply(stanza, "nodeid-required"));
61 local ok, results = service:get_items(node, stanza.attr.from, id);
63 return origin.send(pubsub_error_reply(stanza, results));
66 local data = st.stanza("items", { node = node });
67 for _, entry in pairs(results) do
68 data:add_child(entry);
72 reply = st.reply(stanza)
73 :tag("pubsub", { xmlns = xmlns_pubsub })
76 reply = pubsub_error_reply(stanza, "item-not-found");
78 return origin.send(reply);
81 function handlers.get_subscriptions(origin, stanza, subscriptions)
82 local node = subscriptions.attr.node;
83 local ok, ret = service:get_subscriptions(node, stanza.attr.from, stanza.attr.from);
85 return origin.send(pubsub_error_reply(stanza, ret));
87 local reply = st.reply(stanza)
88 :tag("pubsub", { xmlns = xmlns_pubsub })
89 :tag("subscriptions");
90 for _, sub in ipairs(ret) do
91 reply:tag("subscription", { node = sub.node, jid = sub.jid, subscription = 'subscribed' }):up();
93 return origin.send(reply);
96 function handlers.set_create(origin, stanza, create)
97 local node = create.attr.node;
100 ok, ret = service:create(node, stanza.attr.from);
102 reply = st.reply(stanza);
104 reply = pubsub_error_reply(stanza, ret);
108 node = uuid_generate();
109 ok, ret = service:create(node, stanza.attr.from);
110 until ok or ret ~= "conflict";
112 reply = st.reply(stanza)
113 :tag("pubsub", { xmlns = xmlns_pubsub })
114 :tag("create", { node = node });
116 reply = pubsub_error_reply(stanza, ret);
119 return origin.send(reply);
122 function handlers.set_delete(origin, stanza, delete)
123 local node = delete.attr.node;
125 local reply, notifier;
127 return origin.send(pubsub_error_reply(stanza, "nodeid-required"));
129 local ok, ret = service:delete(node, stanza.attr.from);
131 reply = st.reply(stanza);
133 reply = pubsub_error_reply(stanza, ret);
135 return origin.send(reply);
138 function handlers.set_subscribe(origin, stanza, subscribe)
139 local node, jid = subscribe.attr.node, subscribe.attr.jid;
140 if not (node and jid) then
141 return origin.send(pubsub_error_reply(stanza, jid and "nodeid-required" or "invalid-jid"));
144 local options_tag, options = stanza.tags[1]:get_child("options"), nil;
146 options = options_form:data(options_tag.tags[1]);
149 local options_tag, options; -- FIXME
150 local ok, ret = service:add_subscription(node, stanza.attr.from, jid, options);
153 reply = st.reply(stanza)
154 :tag("pubsub", { xmlns = xmlns_pubsub })
155 :tag("subscription", {
158 subscription = "subscribed"
161 reply:add_child(options_tag);
164 reply = pubsub_error_reply(stanza, ret);
169 function handlers.set_unsubscribe(origin, stanza, unsubscribe)
170 local node, jid = unsubscribe.attr.node, unsubscribe.attr.jid;
171 if not (node and jid) then
172 return origin.send(pubsub_error_reply(stanza, jid and "nodeid-required" or "invalid-jid"));
174 local ok, ret = service:remove_subscription(node, stanza.attr.from, jid);
177 reply = st.reply(stanza);
179 reply = pubsub_error_reply(stanza, ret);
181 return origin.send(reply);
184 function handlers.set_publish(origin, stanza, publish)
185 local node = publish.attr.node;
187 return origin.send(pubsub_error_reply(stanza, "nodeid-required"));
189 local item = publish:get_child("item");
190 local id = (item and item.attr.id);
192 id = uuid_generate();
197 local ok, ret = service:publish(node, stanza.attr.from, id, item);
200 reply = st.reply(stanza)
201 :tag("pubsub", { xmlns = xmlns_pubsub })
202 :tag("publish", { node = node })
203 :tag("item", { id = id });
205 reply = pubsub_error_reply(stanza, ret);
207 return origin.send(reply);
210 function handlers.set_retract(origin, stanza, retract)
211 local node, notify = retract.attr.node, retract.attr.notify;
212 notify = (notify == "1") or (notify == "true");
213 local item = retract:get_child("item");
214 local id = item and item.attr.id
215 if not (node and id) then
216 return origin.send(pubsub_error_reply(stanza, node and "item-not-found" or "nodeid-required"));
218 local reply, notifier;
220 notifier = st.stanza("retract", { id = id });
222 local ok, ret = service:retract(node, stanza.attr.from, id, notifier);
224 reply = st.reply(stanza);
226 reply = pubsub_error_reply(stanza, ret);
228 return origin.send(reply);
231 function handlers.set_purge(origin, stanza, purge)
232 local node, notify = purge.attr.node, purge.attr.notify;
233 notify = (notify == "1") or (notify == "true");
236 return origin.send(pubsub_error_reply(stanza, "nodeid-required"));
238 local ok, ret = service:purge(node, stanza.attr.from, notify);
240 reply = st.reply(stanza);
242 reply = pubsub_error_reply(stanza, ret);
244 return origin.send(reply);
247 function simple_broadcast(kind, node, jids, item)
249 item = st.clone(item);
250 item.attr.xmlns = nil; -- Clear the pubsub namespace
252 local message = st.message({ from = module.host, type = "headline" })
253 :tag("event", { xmlns = xmlns_pubsub_event })
254 :tag(kind, { node = node })
256 for jid in pairs(jids) do
257 module:log("debug", "Sending notification to %s", jid);
258 message.attr.to = jid;
259 module:send(message);
263 module:hook("iq/host/"..xmlns_pubsub..":pubsub", handle_pubsub_iq);
264 module:hook("iq/host/"..xmlns_pubsub_owner..":pubsub", handle_pubsub_iq);
268 local feature_map = {
269 create = { "create-nodes", "instant-nodes", "item-ids" };
270 retract = { "delete-items", "retract-items" };
271 purge = { "purge-nodes" };
272 publish = { "publish", autocreate_on_publish and "auto-create" };
273 delete = { "delete-nodes" };
274 get_items = { "retrieve-items" };
275 add_subscription = { "subscribe" };
276 get_subscriptions = { "retrieve-subscriptions" };
279 local function add_disco_features_from_service(disco, service)
280 for method, features in pairs(feature_map) do
281 if service[method] then
282 for _, feature in ipairs(features) do
284 disco:tag("feature", { var = xmlns_pubsub.."#"..feature }):up();
289 for affiliation in pairs(service.config.capabilities) do
290 if affiliation ~= "none" and affiliation ~= "owner" then
291 disco:tag("feature", { var = xmlns_pubsub.."#"..affiliation.."-affiliation" }):up();
296 local function build_disco_info(service)
297 local disco_info = st.stanza("query", { xmlns = "http://jabber.org/protocol/disco#info" })
298 :tag("identity", { category = "pubsub", type = "service", name = pubsub_disco_name }):up()
299 :tag("feature", { var = "http://jabber.org/protocol/pubsub" }):up();
300 add_disco_features_from_service(disco_info, service);
304 module:hook("iq-get/host/http://jabber.org/protocol/disco#info:query", function (event)
305 local origin, stanza = event.origin, event.stanza;
306 local node = stanza.tags[1].attr.node;
308 return origin.send(st.reply(stanza):add_child(disco_info));
310 local ok, ret = service:get_nodes(stanza.attr.from);
311 if ok and not ret[node] then
312 ok, ret = false, "item-not-found";
315 return origin.send(pubsub_error_reply(stanza, ret));
317 local reply = st.reply(stanza)
318 :tag("query", { xmlns = "http://jabber.org/protocol/disco#info", node = node })
319 :tag("identity", { category = "pubsub", type = "leaf" });
320 return origin.send(reply);
324 local function handle_disco_items_on_node(event)
325 local stanza, origin = event.stanza, event.origin;
326 local query = stanza.tags[1];
327 local node = query.attr.node;
328 local ok, ret = service:get_items(node, stanza.attr.from);
330 return origin.send(pubsub_error_reply(stanza, ret));
333 local reply = st.reply(stanza)
334 :tag("query", { xmlns = "http://jabber.org/protocol/disco#items", node = node });
336 for id, item in pairs(ret) do
337 reply:tag("item", { jid = module.host, name = id }):up();
340 return origin.send(reply);
344 module:hook("iq-get/host/http://jabber.org/protocol/disco#items:query", function (event)
345 if event.stanza.tags[1].attr.node then
346 return handle_disco_items_on_node(event);
348 local ok, ret = service:get_nodes(event.stanza.attr.from);
350 event.origin.send(pubsub_error_reply(event.stanza, ret));
352 local reply = st.reply(event.stanza)
353 :tag("query", { xmlns = "http://jabber.org/protocol/disco#items" });
354 for node, node_obj in pairs(ret) do
355 reply:tag("item", { jid = module.host, node = node, name = node_obj.config.name }):up();
357 event.origin.send(reply);
362 local admin_aff = module:get_option_string("default_admin_affiliation", "owner");
363 local function get_affiliation(jid)
364 local bare_jid = jid_bare(jid);
365 if bare_jid == module.host or usermanager.is_admin(bare_jid, module.host) then
370 function set_service(new_service)
371 service = new_service;
372 module.environment.service = service;
373 disco_info = build_disco_info(service);
376 function module.save()
377 return { service = service };
380 function module.restore(data)
381 set_service(data.service);
384 set_service(pubsub.new({
394 get_subscription = true;
395 get_subscriptions = true;
398 subscribe_other = false;
399 unsubscribe_other = false;
400 get_subscription_other = false;
401 get_subscriptions_other = false;
403 be_subscribed = true;
404 be_unsubscribed = true;
406 set_affiliation = false;
416 get_subscription = true;
417 get_subscriptions = true;
420 subscribe_other = false;
421 unsubscribe_other = false;
422 get_subscription_other = false;
423 get_subscriptions_other = false;
425 be_subscribed = true;
426 be_unsubscribed = true;
428 set_affiliation = false;
439 get_subscription = true;
440 get_subscriptions = true;
444 subscribe_other = true;
445 unsubscribe_other = true;
446 get_subscription_other = true;
447 get_subscriptions_other = true;
449 be_subscribed = true;
450 be_unsubscribed = true;
452 set_affiliation = true;
456 autocreate_on_publish = autocreate_on_publish;
457 autocreate_on_subscribe = autocreate_on_subscribe;
459 broadcaster = simple_broadcast;
460 get_affiliation = get_affiliation;
462 normalize_jid = jid_bare;