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;
84 return origin.send(pubsub_error_reply(stanza, "nodeid-required"));
86 local ok, ret = service:get_subscriptions(node, stanza.attr.from, stanza.attr.from);
88 return origin.send(pubsub_error_reply(stanza, ret));
90 local reply = st.reply(stanza)
91 :tag("pubsub", { xmlns = xmlns_pubsub })
92 :tag("subscriptions");
93 for _, sub in ipairs(ret) do
94 reply:tag("subscription", { node = sub.node, jid = sub.jid, subscription = 'subscribed' }):up();
96 return origin.send(reply);
99 function handlers.set_create(origin, stanza, create)
100 local node = create.attr.node;
101 local ok, ret, reply;
103 ok, ret = service:create(node, stanza.attr.from);
105 reply = st.reply(stanza);
107 reply = pubsub_error_reply(stanza, ret);
111 node = uuid_generate();
112 ok, ret = service:create(node, stanza.attr.from);
113 until ok or ret ~= "conflict";
115 reply = st.reply(stanza)
116 :tag("pubsub", { xmlns = xmlns_pubsub })
117 :tag("create", { node = node });
119 reply = pubsub_error_reply(stanza, ret);
122 return origin.send(reply);
125 function handlers.set_delete(origin, stanza, delete)
126 local node = delete.attr.node;
128 local reply, notifier;
130 return origin.send(pubsub_error_reply(stanza, "nodeid-required"));
132 local ok, ret = service:delete(node, stanza.attr.from);
134 reply = st.reply(stanza);
136 reply = pubsub_error_reply(stanza, ret);
138 return origin.send(reply);
141 function handlers.set_subscribe(origin, stanza, subscribe)
142 local node, jid = subscribe.attr.node, subscribe.attr.jid;
143 if not (node and jid) then
144 return origin.send(pubsub_error_reply(stanza, jid and "nodeid-required" or "invalid-jid"));
147 local options_tag, options = stanza.tags[1]:get_child("options"), nil;
149 options = options_form:data(options_tag.tags[1]);
152 local options_tag, options; -- FIXME
153 local ok, ret = service:add_subscription(node, stanza.attr.from, jid, options);
156 reply = st.reply(stanza)
157 :tag("pubsub", { xmlns = xmlns_pubsub })
158 :tag("subscription", {
161 subscription = "subscribed"
164 reply:add_child(options_tag);
167 reply = pubsub_error_reply(stanza, ret);
172 function handlers.set_unsubscribe(origin, stanza, unsubscribe)
173 local node, jid = unsubscribe.attr.node, unsubscribe.attr.jid;
174 if not (node and jid) then
175 return origin.send(pubsub_error_reply(stanza, jid and "nodeid-required" or "invalid-jid"));
177 local ok, ret = service:remove_subscription(node, stanza.attr.from, jid);
180 reply = st.reply(stanza);
182 reply = pubsub_error_reply(stanza, ret);
184 return origin.send(reply);
187 function handlers.set_publish(origin, stanza, publish)
188 local node = publish.attr.node;
190 return origin.send(pubsub_error_reply(stanza, "nodeid-required"));
192 local item = publish:get_child("item");
193 local id = (item and item.attr.id);
195 id = uuid_generate();
200 local ok, ret = service:publish(node, stanza.attr.from, id, item);
203 reply = st.reply(stanza)
204 :tag("pubsub", { xmlns = xmlns_pubsub })
205 :tag("publish", { node = node })
206 :tag("item", { id = id });
208 reply = pubsub_error_reply(stanza, ret);
210 return origin.send(reply);
213 function handlers.set_retract(origin, stanza, retract)
214 local node, notify = retract.attr.node, retract.attr.notify;
215 notify = (notify == "1") or (notify == "true");
216 local item = retract:get_child("item");
217 local id = item and item.attr.id
218 if not (node and id) then
219 return origin.send(pubsub_error_reply(stanza, node and "item-not-found" or "nodeid-required"));
221 local reply, notifier;
223 notifier = st.stanza("retract", { id = id });
225 local ok, ret = service:retract(node, stanza.attr.from, id, notifier);
227 reply = st.reply(stanza);
229 reply = pubsub_error_reply(stanza, ret);
231 return origin.send(reply);
234 function handlers.set_purge(origin, stanza, purge)
235 local node, notify = purge.attr.node, purge.attr.notify;
236 notify = (notify == "1") or (notify == "true");
239 return origin.send(pubsub_error_reply(stanza, "nodeid-required"));
241 local ok, ret = service:purge(node, stanza.attr.from, notify);
243 reply = st.reply(stanza);
245 reply = pubsub_error_reply(stanza, ret);
247 return origin.send(reply);
250 function simple_broadcast(kind, node, jids, item)
252 item = st.clone(item);
253 item.attr.xmlns = nil; -- Clear the pubsub namespace
255 local message = st.message({ from = module.host, type = "headline" })
256 :tag("event", { xmlns = xmlns_pubsub_event })
257 :tag(kind, { node = node })
259 for jid in pairs(jids) do
260 module:log("debug", "Sending notification to %s", jid);
261 message.attr.to = jid;
262 module:send(message);
266 module:hook("iq/host/"..xmlns_pubsub..":pubsub", handle_pubsub_iq);
267 module:hook("iq/host/"..xmlns_pubsub_owner..":pubsub", handle_pubsub_iq);
271 local feature_map = {
272 create = { "create-nodes", "instant-nodes", "item-ids" };
273 retract = { "delete-items", "retract-items" };
274 purge = { "purge-nodes" };
275 publish = { "publish", autocreate_on_publish and "auto-create" };
276 delete = { "delete-nodes" };
277 get_items = { "retrieve-items" };
278 add_subscription = { "subscribe" };
279 get_subscriptions = { "retrieve-subscriptions" };
282 local function add_disco_features_from_service(disco, service)
283 for method, features in pairs(feature_map) do
284 if service[method] then
285 for _, feature in ipairs(features) do
287 disco:tag("feature", { var = xmlns_pubsub.."#"..feature }):up();
292 for affiliation in pairs(service.config.capabilities) do
293 if affiliation ~= "none" and affiliation ~= "owner" then
294 disco:tag("feature", { var = xmlns_pubsub.."#"..affiliation.."-affiliation" }):up();
299 local function build_disco_info(service)
300 local disco_info = st.stanza("query", { xmlns = "http://jabber.org/protocol/disco#info" })
301 :tag("identity", { category = "pubsub", type = "service", name = pubsub_disco_name }):up()
302 :tag("feature", { var = "http://jabber.org/protocol/pubsub" }):up();
303 add_disco_features_from_service(disco_info, service);
307 module:hook("iq-get/host/http://jabber.org/protocol/disco#info:query", function (event)
308 local origin, stanza = event.origin, event.stanza;
309 local node = stanza.tags[1].attr.node;
311 return origin.send(st.reply(stanza):add_child(disco_info));
313 local ok, ret = service:get_nodes(stanza.attr.from);
314 if ok and not ret[node] then
315 ok, ret = false, "item-not-found";
318 return origin.send(pubsub_error_reply(stanza, ret));
320 local reply = st.reply(stanza)
321 :tag("query", { xmlns = "http://jabber.org/protocol/disco#info", node = node })
322 :tag("identity", { category = "pubsub", type = "leaf" });
323 return origin.send(reply);
327 local function handle_disco_items_on_node(event)
328 local stanza, origin = event.stanza, event.origin;
329 local query = stanza.tags[1];
330 local node = query.attr.node;
331 local ok, ret = service:get_items(node, stanza.attr.from);
333 return origin.send(pubsub_error_reply(stanza, ret));
336 local reply = st.reply(stanza)
337 :tag("query", { xmlns = "http://jabber.org/protocol/disco#items", node = node });
339 for id, item in pairs(ret) do
340 reply:tag("item", { jid = module.host, name = id }):up();
343 return origin.send(reply);
347 module:hook("iq-get/host/http://jabber.org/protocol/disco#items:query", function (event)
348 if event.stanza.tags[1].attr.node then
349 return handle_disco_items_on_node(event);
351 local ok, ret = service:get_nodes(event.stanza.attr.from);
353 event.origin.send(pubsub_error_reply(event.stanza, ret));
355 local reply = st.reply(event.stanza)
356 :tag("query", { xmlns = "http://jabber.org/protocol/disco#items" });
357 for node, node_obj in pairs(ret) do
358 reply:tag("item", { jid = module.host, node = node, name = node_obj.config.name }):up();
360 event.origin.send(reply);
365 local admin_aff = module:get_option_string("default_admin_affiliation", "owner");
366 local function get_affiliation(jid)
367 local bare_jid = jid_bare(jid);
368 if bare_jid == module.host or usermanager.is_admin(bare_jid, module.host) then
373 function set_service(new_service)
374 service = new_service;
375 module.environment.service = service;
376 disco_info = build_disco_info(service);
379 function module.save()
380 return { service = service };
383 function module.restore(data)
384 set_service(data.service);
387 set_service(pubsub.new({
397 get_subscription = true;
398 get_subscriptions = true;
401 subscribe_other = false;
402 unsubscribe_other = false;
403 get_subscription_other = false;
404 get_subscriptions_other = false;
406 be_subscribed = true;
407 be_unsubscribed = true;
409 set_affiliation = false;
419 get_subscription = true;
420 get_subscriptions = true;
423 subscribe_other = false;
424 unsubscribe_other = false;
425 get_subscription_other = false;
426 get_subscriptions_other = false;
428 be_subscribed = true;
429 be_unsubscribed = true;
431 set_affiliation = false;
442 get_subscription = true;
443 get_subscriptions = true;
447 subscribe_other = true;
448 unsubscribe_other = true;
449 get_subscription_other = true;
450 get_subscriptions_other = true;
452 be_subscribed = true;
453 be_unsubscribed = true;
455 set_affiliation = true;
459 autocreate_on_publish = autocreate_on_publish;
460 autocreate_on_subscribe = autocreate_on_subscribe;
462 broadcaster = simple_broadcast;
463 get_affiliation = get_affiliation;
465 normalize_jid = jid_bare;