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;
6 local xmlns_pubsub = "http://jabber.org/protocol/pubsub";
7 local xmlns_pubsub_errors = "http://jabber.org/protocol/pubsub#errors";
8 local xmlns_pubsub_event = "http://jabber.org/protocol/pubsub#event";
10 local autocreate_on_publish = module:get_option_boolean("autocreate_on_publish", false);
11 local autocreate_on_subscribe = module:get_option_boolean("autocreate_on_subscribe", false);
12 local pubsub_disco_name = module:get_option("name");
13 if type(pubsub_disco_name) ~= "string" then pubsub_disco_name = "Prosody PubSub Service"; end
19 function handle_pubsub_iq(event)
20 local origin, stanza = event.origin, event.stanza;
21 local pubsub = stanza.tags[1];
22 local action = pubsub.tags[1];
23 local handler = handlers[stanza.attr.type.."_"..action.name];
25 handler(origin, stanza, action);
30 local pubsub_errors = {
31 ["conflict"] = { "cancel", "conflict" };
32 ["invalid-jid"] = { "modify", "bad-request", nil, "invalid-jid" };
33 ["item-not-found"] = { "cancel", "item-not-found" };
34 ["not-subscribed"] = { "modify", "unexpected-request", nil, "not-subscribed" };
35 ["forbidden"] = { "cancel", "forbidden" };
37 function pubsub_error_reply(stanza, error)
38 local e = pubsub_errors[error];
39 local reply = st.error_reply(stanza, unpack(e, 1, 3));
41 reply:tag(e[4], { xmlns = xmlns_pubsub_errors }):up();
46 function handlers.get_items(origin, stanza, items)
47 local node = items.attr.node;
48 local item = items:get_child("item");
49 local id = item and item.attr.id;
51 local ok, results = service:get_items(node, stanza.attr.from, id);
53 return origin.send(pubsub_error_reply(stanza, results));
56 local data = st.stanza("items", { node = node });
57 for _, entry in pairs(results) do
58 data:add_child(entry);
61 reply = st.reply(stanza)
62 :tag("pubsub", { xmlns = xmlns_pubsub })
65 reply = pubsub_error_reply(stanza, "item-not-found");
67 return origin.send(reply);
70 function handlers.get_subscriptions(origin, stanza, subscriptions)
71 local node = subscriptions.attr.node;
72 local ok, ret = service:get_subscriptions(node, stanza.attr.from, stanza.attr.from);
74 return origin.send(pubsub_error_reply(stanza, ret));
76 local reply = st.reply(stanza)
77 :tag("pubsub", { xmlns = xmlns_pubsub })
78 :tag("subscriptions");
79 for _, sub in ipairs(ret) do
80 reply:tag("subscription", { node = sub.node, jid = sub.jid, subscription = 'subscribed' }):up();
82 return origin.send(reply);
85 function handlers.set_create(origin, stanza, create)
86 local node = create.attr.node;
89 ok, ret = service:create(node, stanza.attr.from);
91 reply = st.reply(stanza);
93 reply = pubsub_error_reply(stanza, ret);
97 node = uuid_generate();
98 ok, ret = service:create(node, stanza.attr.from);
99 until ok or ret ~= "conflict";
101 reply = st.reply(stanza)
102 :tag("pubsub", { xmlns = xmlns_pubsub })
103 :tag("create", { node = node });
105 reply = pubsub_error_reply(stanza, ret);
108 return origin.send(reply);
111 function handlers.set_subscribe(origin, stanza, subscribe)
112 local node, jid = subscribe.attr.node, subscribe.attr.jid;
113 local options_tag, options = stanza.tags[1]:get_child("options"), nil;
115 options = options_form:data(options_tag.tags[1]);
117 local ok, ret = service:add_subscription(node, stanza.attr.from, jid, options);
120 reply = st.reply(stanza)
121 :tag("pubsub", { xmlns = xmlns_pubsub })
122 :tag("subscription", {
125 subscription = "subscribed"
128 reply:add_child(options_tag);
131 reply = pubsub_error_reply(stanza, ret);
133 return origin.send(reply);
136 function handlers.set_unsubscribe(origin, stanza, unsubscribe)
137 local node, jid = unsubscribe.attr.node, unsubscribe.attr.jid;
138 local ok, ret = service:remove_subscription(node, stanza.attr.from, jid);
141 reply = st.reply(stanza);
143 reply = pubsub_error_reply(stanza, ret);
145 return origin.send(reply);
148 function handlers.set_publish(origin, stanza, publish)
149 local node = publish.attr.node;
150 local item = publish:get_child("item");
151 local id = (item and item.attr.id) or uuid_generate();
152 local ok, ret = service:publish(node, stanza.attr.from, id, item);
155 reply = st.reply(stanza)
156 :tag("pubsub", { xmlns = xmlns_pubsub })
157 :tag("publish", { node = node })
158 :tag("item", { id = id });
160 reply = pubsub_error_reply(stanza, ret);
162 return origin.send(reply);
165 function handlers.set_retract(origin, stanza, retract)
166 local node, notify = retract.attr.node, retract.attr.notify;
167 notify = (notify == "1") or (notify == "true");
168 local item = retract:get_child("item");
169 local id = item and item.attr.id
170 local reply, notifier;
172 notifier = st.stanza("retract", { id = id });
174 local ok, ret = service:retract(node, stanza.attr.from, id, notifier);
176 reply = st.reply(stanza);
178 reply = pubsub_error_reply(stanza, ret);
180 return origin.send(reply);
183 function simple_broadcast(node, jids, item)
184 item = st.clone(item);
185 item.attr.xmlns = nil; -- Clear the pubsub namespace
186 local message = st.message({ from = module.host, type = "headline" })
187 :tag("event", { xmlns = xmlns_pubsub_event })
188 :tag("items", { node = node })
190 for jid in pairs(jids) do
191 module:log("debug", "Sending notification to %s", jid);
192 message.attr.to = jid;
193 core_post_stanza(hosts[module.host], message);
197 module:hook("iq/host/http://jabber.org/protocol/pubsub:pubsub", handle_pubsub_iq);
201 local feature_map = {
202 create = { "create-nodes", autocreate_on_publish and "instant-nodes", "item-ids" };
203 retract = { "delete-items", "retract-items" };
204 publish = { "publish" };
205 get_items = { "retrieve-items" };
206 add_subscription = { "subscribe" };
207 get_subscriptions = { "retrieve-subscriptions" };
210 local function add_disco_features_from_service(disco, service)
211 for method, features in pairs(feature_map) do
212 if service[method] then
213 for _, feature in ipairs(features) do
215 disco:tag("feature", { var = xmlns_pubsub.."#"..feature }):up();
220 for affiliation in pairs(service.config.capabilities) do
221 if affiliation ~= "none" and affiliation ~= "owner" then
222 disco:tag("feature", { var = xmlns_pubsub.."#"..affiliation.."-affiliation" }):up();
227 local function build_disco_info(service)
228 local disco_info = st.stanza("query", { xmlns = "http://jabber.org/protocol/disco#info" })
229 :tag("identity", { category = "pubsub", type = "service", name = pubsub_disco_name }):up()
230 :tag("feature", { var = "http://jabber.org/protocol/pubsub" }):up();
231 add_disco_features_from_service(disco_info, service);
235 module:hook("iq-get/host/http://jabber.org/protocol/disco#info:query", function (event)
236 local origin, stanza = event.origin, event.stanza;
237 local node = stanza.tags[1].attr.node;
239 return origin.send(st.reply(stanza):add_child(disco_info));
241 local ok, ret = service:get_nodes(stanza.attr.from);
242 if ok and not ret[node] then
243 ok, ret = false, "item-not-found";
246 return origin.send(pubsub_error_reply(stanza, ret));
248 local reply = st.reply(stanza)
249 :tag("query", { xmlns = "http://jabber.org/protocol/disco#info", node = node })
250 :tag("identity", { category = "pubsub", type = "leaf" });
251 return origin.send(reply);
255 local function handle_disco_items_on_node(event)
256 local stanza, origin = event.stanza, event.origin;
257 local query = stanza.tags[1];
258 local node = query.attr.node;
259 local ok, ret = service:get_items(node, stanza.attr.from);
261 return origin.send(pubsub_error_reply(stanza, ret));
264 local reply = st.reply(stanza)
265 :tag("query", { xmlns = "http://jabber.org/protocol/disco#items", node = node });
267 for id, item in pairs(ret) do
268 reply:tag("item", { jid = module.host, name = id }):up();
271 return origin.send(reply);
275 module:hook("iq-get/host/http://jabber.org/protocol/disco#items:query", function (event)
276 if event.stanza.tags[1].attr.node then
277 return handle_disco_items_on_node(event);
279 local ok, ret = service:get_nodes(event.stanza.attr.from);
281 event.origin.send(pubsub_error_reply(stanza, ret));
283 local reply = st.reply(event.stanza)
284 :tag("query", { xmlns = "http://jabber.org/protocol/disco#items" });
285 for node, node_obj in pairs(ret) do
286 reply:tag("item", { jid = module.host, node = node, name = node_obj.config.name }):up();
288 event.origin.send(reply);
293 local admin_aff = module:get_option_string("default_admin_affiliation", "owner");
294 local function get_affiliation(jid)
295 local bare_jid = jid_bare(jid);
296 if bare_jid == module.host or usermanager.is_admin(bare_jid, module.host) then
301 function set_service(new_service)
302 service = new_service;
303 module.environment.service = service;
304 disco_info = build_disco_info(service);
307 function module.save()
308 return { service = service };
311 function module.restore(data)
312 set_service(data.service);
315 set_service(pubsub.new({
325 get_subscription = true;
326 get_subscriptions = true;
329 subscribe_other = false;
330 unsubscribe_other = false;
331 get_subscription_other = false;
332 get_subscriptions_other = false;
334 be_subscribed = true;
335 be_unsubscribed = true;
337 set_affiliation = false;
347 get_subscription = true;
348 get_subscriptions = true;
352 subscribe_other = true;
353 unsubscribe_other = true;
354 get_subscription_other = true;
355 get_subscriptions_other = true;
357 be_subscribed = true;
358 be_unsubscribed = true;
360 set_affiliation = true;
364 autocreate_on_publish = autocreate_on_publish;
365 autocreate_on_subscribe = autocreate_on_subscribe;
367 broadcaster = simple_broadcast;
368 get_affiliation = get_affiliation;
370 normalize_jid = jid_bare;