prosody-modules
45d0802d0787
mod_pubsub_serverinfo/mod_pubsub_serverinfo.lua

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Annotate

mod_pubsub_serverinfo/mod_pubsub_serverinfo.lua @ 5839:45d0802d0787

mod_pubsub_serverinfo: Allow configuration of node persistence/deletion
author Matthew Wild <mwild1@gmail.com>
date Mon, 08 Jan 2024 15:54:09 +0000
parent 5838:77c5709bd57a
child 5840:7905766d01f6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
1 local st = require "util.stanza";
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
2 local new_id = require"util.id".medium;
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
3 local dataform = require "util.dataforms".new;
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
4
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
5 local local_domain = module:get_host();
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
6 local service = module:get_option(module.name .. "_service") or "pubsub." .. local_domain;
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
7 local node = module:get_option(module.name .. "_node") or "serverinfo";
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
8 local actor = module.host .. "/modules/" .. module.name;
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
9 local publication_interval = module:get_option(module.name .. "_publication_interval") or 300;
5828
55b99f593c3a mod_pubsub_serverinfo: Disco/info cache TTL should be configurable
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5827
diff changeset
10 local cache_ttl = module:get_option(module.name .. "_cache_ttl") or 3600;
5839
45d0802d0787 mod_pubsub_serverinfo: Allow configuration of node persistence/deletion
Matthew Wild <mwild1@gmail.com>
parents: 5838
diff changeset
11 local delete_node_on_unload = module:get_option_boolean(module.name.."_delete_node_on_unload", false);
45d0802d0787 mod_pubsub_serverinfo: Allow configuration of node persistence/deletion
Matthew Wild <mwild1@gmail.com>
parents: 5838
diff changeset
12 local persist_items = module:get_option_boolean(module.name.."_persist_items", true);
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
13
5838
77c5709bd57a mod_pubsub_serverinfo: Add explicit xmlns to all pubsub tags
Matthew Wild <mwild1@gmail.com>
parents: 5837
diff changeset
14 local xmlns_pubsub = "http://jabber.org/protocol/pubsub";
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
15
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
16 function module.load()
5827
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
17 discover_node():next(
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
18 function(exists)
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
19 if not exists then create_node() end
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
20 end
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
21 ):catch(
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
22 function(error)
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
23 module:log("warn", "Error prevented discovery or creation of pub/sub node at %s: %s", service, error)
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
24 end
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
25 )
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
26
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
27 module:add_feature("urn:xmpp:serverinfo:0");
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
28
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
29 module:add_extension(dataform {
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
30 { name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/network/serverinfo" },
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
31 { name = "serverinfo-pubsub-node", type = "text-single" },
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
32 }:form({ ["serverinfo-pubsub-node"] = ("xmpp:%s?;node=%s"):format(service, node) }, "result"));
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
33
5836
d38772479891 mod_pubsub_serverinfo: Some logging improvements
Matthew Wild <mwild1@gmail.com>
parents: 5835
diff changeset
34 if cache_ttl < publication_interval then
d38772479891 mod_pubsub_serverinfo: Some logging improvements
Matthew Wild <mwild1@gmail.com>
parents: 5835
diff changeset
35 module:log("warn", "It is recommended to have a cache interval higher than the publication interval");
d38772479891 mod_pubsub_serverinfo: Some logging improvements
Matthew Wild <mwild1@gmail.com>
parents: 5835
diff changeset
36 end
d38772479891 mod_pubsub_serverinfo: Some logging improvements
Matthew Wild <mwild1@gmail.com>
parents: 5835
diff changeset
37
5833
76b57bcfe1b2 mod_pubsub_serverinfo: Warm-up opt-in cache
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5832
diff changeset
38 cache_warm_up()
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
39 module:add_timer(10, publish_serverinfo);
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
40 end
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
41
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
42 function module.unload()
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
43 -- This removes all subscribers, which may or may not be desirable, depending on the reason for the unload.
5839
45d0802d0787 mod_pubsub_serverinfo: Allow configuration of node persistence/deletion
Matthew Wild <mwild1@gmail.com>
parents: 5838
diff changeset
44 if delete_node_on_unload then
45d0802d0787 mod_pubsub_serverinfo: Allow configuration of node persistence/deletion
Matthew Wild <mwild1@gmail.com>
parents: 5838
diff changeset
45 delete_node();
45d0802d0787 mod_pubsub_serverinfo: Allow configuration of node persistence/deletion
Matthew Wild <mwild1@gmail.com>
parents: 5838
diff changeset
46 end
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
47 end
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
48
5827
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
49 -- Returns a promise of a boolean
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
50 function discover_node()
5833
76b57bcfe1b2 mod_pubsub_serverinfo: Warm-up opt-in cache
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5832
diff changeset
51 local request = st.iq({ type = "get", to = service, from = actor, id = new_id() })
76b57bcfe1b2 mod_pubsub_serverinfo: Warm-up opt-in cache
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5832
diff changeset
52 :tag("query", { xmlns = "http://jabber.org/protocol/disco#items" })
5827
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
53
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
54 module:log("debug", "Sending request to discover existence of pub/sub node '%s' at %s", node, service)
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
55 return module:send_iq(request):next(
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
56 function(response)
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
57 if response.stanza == nil or response.stanza.attr.type ~= "result" then
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
58 module:log("warn", "Unexpected response to service discovery items request at %s: %s", service, response.stanza)
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
59 return false
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
60 end
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
61
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
62 local query = response.stanza:get_child("query", "http://jabber.org/protocol/disco#items")
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
63 if query ~= nil then
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
64 for item in query:childtags("item") do
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
65 if item.attr.jid == service and item.attr.node == node then
5836
d38772479891 mod_pubsub_serverinfo: Some logging improvements
Matthew Wild <mwild1@gmail.com>
parents: 5835
diff changeset
66 module:log("debug", "pub/sub node '%s' at %s does exist.", node, service)
5827
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
67 return true
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
68 end
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
69 end
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
70 end
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
71 module:log("debug", "pub/sub node '%s' at %s does not exist.", node, service)
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
72 return false;
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
73 end
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
74 );
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
75 end
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
76
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
77 -- Returns a promise of a boolean
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
78 function create_node()
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
79 local request = st.iq({ type = "set", to = service, from = actor, id = new_id() })
5838
77c5709bd57a mod_pubsub_serverinfo: Add explicit xmlns to all pubsub tags
Matthew Wild <mwild1@gmail.com>
parents: 5837
diff changeset
80 :tag("pubsub", { xmlns = xmlns_pubsub })
77c5709bd57a mod_pubsub_serverinfo: Add explicit xmlns to all pubsub tags
Matthew Wild <mwild1@gmail.com>
parents: 5837
diff changeset
81 :tag("create", { node = node, xmlns = xmlns_pubsub }):up()
77c5709bd57a mod_pubsub_serverinfo: Add explicit xmlns to all pubsub tags
Matthew Wild <mwild1@gmail.com>
parents: 5837
diff changeset
82 :tag("configure", { xmlns = xmlns_pubsub })
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
83 :tag("x", { xmlns = "jabber:x:data", type = "submit" })
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
84 :tag("field", { var = "FORM_TYPE", type = "hidden"})
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
85 :text_tag("value", "http://jabber.org/protocol/pubsub#node_config")
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
86 :up()
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
87 :tag("field", { var = "pubsub#max_items" })
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
88 :text_tag("value", "1")
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
89 :up()
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
90 :tag("field", { var = "pubsub#persist_items" })
5839
45d0802d0787 mod_pubsub_serverinfo: Allow configuration of node persistence/deletion
Matthew Wild <mwild1@gmail.com>
parents: 5838
diff changeset
91 :text_tag("value", persist_items and "1" or "0")
5827
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
92
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
93 module:log("debug", "Sending request to create pub/sub node '%s' at %s", node, service)
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
94 return module:send_iq(request):next(
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
95 function(response)
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
96 if response.stanza == nil or response.stanza.attr.type ~= "result" then
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
97 module:log("warn", "Unexpected response to pub/sub node '%s' creation request at %s: %s", node, service, response.stanza)
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
98 return false
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
99 else
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
100 module:log("debug", "Successfully created pub/sub node '%s' at %s", node, service)
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
101 return true
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
102 end
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
103 end
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
104 )
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
105 end
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
106
5827
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
107 -- Returns a promise of a boolean
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
108 function delete_node()
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
109 local request = st.iq({ type = "set", to = service, from = actor, id = new_id() })
5838
77c5709bd57a mod_pubsub_serverinfo: Add explicit xmlns to all pubsub tags
Matthew Wild <mwild1@gmail.com>
parents: 5837
diff changeset
110 :tag("pubsub", { xmlns = xmlns_pubsub })
77c5709bd57a mod_pubsub_serverinfo: Add explicit xmlns to all pubsub tags
Matthew Wild <mwild1@gmail.com>
parents: 5837
diff changeset
111 :tag("delete", { node = node, xmlns = xmlns_pubsub });
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
112
5827
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
113 module:log("debug", "Sending request to delete pub/sub node '%s' at %s", node, service)
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
114 return module:send_iq(request):next(
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
115 function(response)
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
116 if response.stanza == nil or response.stanza.attr.type ~= "result" then
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
117 module:log("warn", "Unexpected response to pub/sub node '%s' deletion request at %s: %s", node, service, response.stanza)
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
118 return false
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
119 else
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
120 module:log("debug", "Successfully deleted pub/sub node '%s' at %s", node, service)
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
121 return true
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
122 end
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
123 end
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
124 )
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
125 end
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
126
5833
76b57bcfe1b2 mod_pubsub_serverinfo: Warm-up opt-in cache
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5832
diff changeset
127 function get_remote_domain_names()
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
128 -- Iterate over s2s sessions, adding them to a multimap, where the key is the local domain name,
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
129 -- mapped to a collection of remote domain names. De-duplicate all remote domain names by using
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
130 -- them as an index in a table.
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
131 local domains_by_host = {}
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
132 for session, _ in pairs(prosody.incoming_s2s) do
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
133 if session ~= nil and session.from_host ~= nil and local_domain == session.to_host then
5831
2465d5191ae9 mod_pubsub_serverinfo: Consider sibling vhosts 'connected'
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5828
diff changeset
134 module:log("debug", "Local host '%s' has remote '%s' (inbound)", session.to_host, session.from_host);
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
135 local sessions = domains_by_host[session.to_host]
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
136 if sessions == nil then sessions = {} end; -- instantiate a new entry if none existed
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
137 sessions[session.from_host] = true
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
138 domains_by_host[session.to_host] = sessions
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
139 end
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
140 end
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
141
5831
2465d5191ae9 mod_pubsub_serverinfo: Consider sibling vhosts 'connected'
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5828
diff changeset
142 -- At an earlier stage, the code iterated over all prosody.hosts, trying to generate one pubsub item for all local hosts. That turned out to be
2465d5191ae9 mod_pubsub_serverinfo: Consider sibling vhosts 'connected'
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5828
diff changeset
143 -- to noisy. Instead, this code now creates an item that includes the local vhost only. It is assumed that this module will also be loaded for
2465d5191ae9 mod_pubsub_serverinfo: Consider sibling vhosts 'connected'
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5828
diff changeset
144 -- other vhosts. Their data should then be published to distinct pub/sub services and nodes.
2465d5191ae9 mod_pubsub_serverinfo: Consider sibling vhosts 'connected'
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5828
diff changeset
145
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
146 -- for host, data in pairs(prosody.hosts) do
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
147 local host = local_domain
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
148 local data = prosody.hosts[host]
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
149 if data ~= nil then
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
150 local sessions = domains_by_host[host]
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
151 if sessions == nil then sessions = {} end; -- instantiate a new entry if none existed
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
152 if data.s2sout ~= nil then
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
153 for _, session in pairs(data.s2sout) do
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
154 if session.to_host ~= nil then
5831
2465d5191ae9 mod_pubsub_serverinfo: Consider sibling vhosts 'connected'
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5828
diff changeset
155 module:log("debug", "Local host '%s' has remote '%s' (outbound)", host, session.to_host);
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
156 sessions[session.to_host] = true
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
157 domains_by_host[host] = sessions
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
158 end
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
159 end
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
160 end
5831
2465d5191ae9 mod_pubsub_serverinfo: Consider sibling vhosts 'connected'
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5828
diff changeset
161
2465d5191ae9 mod_pubsub_serverinfo: Consider sibling vhosts 'connected'
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5828
diff changeset
162 -- When the instance of Prosody hosts more than one host, the other hosts can be thought of as having a 'permanent' s2s connection.
2465d5191ae9 mod_pubsub_serverinfo: Consider sibling vhosts 'connected'
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5828
diff changeset
163 for host_name, host_info in pairs(prosody.hosts) do
2465d5191ae9 mod_pubsub_serverinfo: Consider sibling vhosts 'connected'
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5828
diff changeset
164 if host ~= host_name and host_info.type ~= "component" then
2465d5191ae9 mod_pubsub_serverinfo: Consider sibling vhosts 'connected'
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5828
diff changeset
165 module:log("debug", "Local host '%s' has remote '%s' (vhost)", host, host_name);
2465d5191ae9 mod_pubsub_serverinfo: Consider sibling vhosts 'connected'
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5828
diff changeset
166 sessions[host_name] = true;
2465d5191ae9 mod_pubsub_serverinfo: Consider sibling vhosts 'connected'
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5828
diff changeset
167 domains_by_host[host] = sessions
2465d5191ae9 mod_pubsub_serverinfo: Consider sibling vhosts 'connected'
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5828
diff changeset
168 end
2465d5191ae9 mod_pubsub_serverinfo: Consider sibling vhosts 'connected'
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5828
diff changeset
169 end
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
170 end
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
171
5833
76b57bcfe1b2 mod_pubsub_serverinfo: Warm-up opt-in cache
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5832
diff changeset
172 return domains_by_host
76b57bcfe1b2 mod_pubsub_serverinfo: Warm-up opt-in cache
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5832
diff changeset
173 end
76b57bcfe1b2 mod_pubsub_serverinfo: Warm-up opt-in cache
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5832
diff changeset
174
76b57bcfe1b2 mod_pubsub_serverinfo: Warm-up opt-in cache
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5832
diff changeset
175 function publish_serverinfo()
5836
d38772479891 mod_pubsub_serverinfo: Some logging improvements
Matthew Wild <mwild1@gmail.com>
parents: 5835
diff changeset
176 module:log("debug", "Publishing server info...");
5833
76b57bcfe1b2 mod_pubsub_serverinfo: Warm-up opt-in cache
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5832
diff changeset
177 local domains_by_host = get_remote_domain_names()
76b57bcfe1b2 mod_pubsub_serverinfo: Warm-up opt-in cache
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5832
diff changeset
178
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
179 -- Build the publication stanza.
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
180 local request = st.iq({ type = "set", to = service, from = actor, id = new_id() })
5838
77c5709bd57a mod_pubsub_serverinfo: Add explicit xmlns to all pubsub tags
Matthew Wild <mwild1@gmail.com>
parents: 5837
diff changeset
181 :tag("pubsub", { xmlns = xmlns_pubsub })
77c5709bd57a mod_pubsub_serverinfo: Add explicit xmlns to all pubsub tags
Matthew Wild <mwild1@gmail.com>
parents: 5837
diff changeset
182 :tag("publish", { node = node, xmlns = xmlns_pubsub })
77c5709bd57a mod_pubsub_serverinfo: Add explicit xmlns to all pubsub tags
Matthew Wild <mwild1@gmail.com>
parents: 5837
diff changeset
183 :tag("item", { id = "current", xmlns = xmlns_pubsub })
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
184 :tag("serverinfo", { xmlns = "urn:xmpp:serverinfo:0" })
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
185
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
186 request:tag("domain", { name = local_domain })
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
187 :tag("federation")
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
188
5833
76b57bcfe1b2 mod_pubsub_serverinfo: Warm-up opt-in cache
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5832
diff changeset
189 local remotes = domains_by_host[local_domain]
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
190
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
191 if remotes ~= nil then
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
192 for remote, _ in pairs(remotes) do
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
193 -- include a domain name for remote domains, but only if they advertise support.
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
194 if does_opt_in(remote) then
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
195 request:tag("remote-domain", { name = remote }):up()
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
196 else
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
197 request:tag("remote-domain"):up()
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
198 end
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
199 end
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
200 end
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
201
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
202 request:up():up()
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
203
5827
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
204 module:send_iq(request):next(
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
205 function(response)
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
206 if response.stanza == nil or response.stanza.attr.type ~= "result" then
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
207 module:log("warn", "Unexpected response to item publication at pub/sub node '%s' on %s: %s", node, service, response.stanza)
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
208 return false
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
209 else
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
210 module:log("debug", "Successfully published item on pub/sub node '%s' at %s", node, service)
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
211 return true
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
212 end
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
213 end,
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
214 function(error)
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
215 module:log("warn", "Error prevented publication of item on pub/sub node at %s: %s", service, error)
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
216 end
c3eeeb968403 mod_pubsub_serverinfo: Detect existence of pub/sub node
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5826
diff changeset
217 )
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
218
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
219 return publication_interval;
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
220 end
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
221
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
222 local opt_in_cache = {}
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
223
5833
76b57bcfe1b2 mod_pubsub_serverinfo: Warm-up opt-in cache
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5832
diff changeset
224 function cache_warm_up()
76b57bcfe1b2 mod_pubsub_serverinfo: Warm-up opt-in cache
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5832
diff changeset
225 module:log("debug", "Warming up opt-in cache")
76b57bcfe1b2 mod_pubsub_serverinfo: Warm-up opt-in cache
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5832
diff changeset
226 local domains_by_host = get_remote_domain_names()
76b57bcfe1b2 mod_pubsub_serverinfo: Warm-up opt-in cache
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5832
diff changeset
227 local remotes = domains_by_host[local_domain]
76b57bcfe1b2 mod_pubsub_serverinfo: Warm-up opt-in cache
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5832
diff changeset
228 if remotes ~= nil then
76b57bcfe1b2 mod_pubsub_serverinfo: Warm-up opt-in cache
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5832
diff changeset
229 for remote, _ in pairs(remotes) do
76b57bcfe1b2 mod_pubsub_serverinfo: Warm-up opt-in cache
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5832
diff changeset
230 does_opt_in(remote)
76b57bcfe1b2 mod_pubsub_serverinfo: Warm-up opt-in cache
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5832
diff changeset
231 end
76b57bcfe1b2 mod_pubsub_serverinfo: Warm-up opt-in cache
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5832
diff changeset
232 end
76b57bcfe1b2 mod_pubsub_serverinfo: Warm-up opt-in cache
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5832
diff changeset
233 end
76b57bcfe1b2 mod_pubsub_serverinfo: Warm-up opt-in cache
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5832
diff changeset
234
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
235 function does_opt_in(remoteDomain)
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
236
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
237 -- try to read answer from cache.
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
238 local cached_value = opt_in_cache[remoteDomain]
5835
cf5f77491323 mod_pubsub_serverinfo: Refresh cache entries if they will expire before next run
Matthew Wild <mwild1@gmail.com>
parents: 5833
diff changeset
239 local ttl = cached_value and os.difftime(cached_value.expires, os.time());
cf5f77491323 mod_pubsub_serverinfo: Refresh cache entries if they will expire before next run
Matthew Wild <mwild1@gmail.com>
parents: 5833
diff changeset
240 if cached_value and ttl > (publication_interval + 60) then
5831
2465d5191ae9 mod_pubsub_serverinfo: Consider sibling vhosts 'connected'
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5828
diff changeset
241 module:log("debug", "Opt-in status (from cache) for '%s': %s", remoteDomain, cached_value.opt_in)
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
242 return cached_value.opt_in;
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
243 end
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
244
5835
cf5f77491323 mod_pubsub_serverinfo: Refresh cache entries if they will expire before next run
Matthew Wild <mwild1@gmail.com>
parents: 5833
diff changeset
245 -- We don't have a cached value, or it is nearing expiration - refresh it now
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
246 -- TODO worry about not having multiple requests in flight to the same domain.cached_value
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
247
5836
d38772479891 mod_pubsub_serverinfo: Some logging improvements
Matthew Wild <mwild1@gmail.com>
parents: 5835
diff changeset
248 module:log("debug", "%s: performing disco/info to determine opt-in", remoteDomain)
5833
76b57bcfe1b2 mod_pubsub_serverinfo: Warm-up opt-in cache
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5832
diff changeset
249 local discoRequest = st.iq({ type = "get", to = remoteDomain, from = actor, id = new_id() })
76b57bcfe1b2 mod_pubsub_serverinfo: Warm-up opt-in cache
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5832
diff changeset
250 :tag("query", { xmlns = "http://jabber.org/protocol/disco#info" })
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
251
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
252 module:send_iq(discoRequest):next(
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
253 function(response)
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
254 if response.stanza ~= nil and response.stanza.attr.type == "result" then
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
255 local query = response.stanza:get_child("query", "http://jabber.org/protocol/disco#info")
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
256 if query ~= nil then
5832
a8cae8322b7c mod_pubsub_serverinfo: Fix namespace parsing issue with disco/info
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5831
diff changeset
257 for feature in query:childtags("feature") do
5836
d38772479891 mod_pubsub_serverinfo: Some logging improvements
Matthew Wild <mwild1@gmail.com>
parents: 5835
diff changeset
258 --module:log("debug", "Disco/info feature for '%s': %s", remoteDomain, feature)
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
259 if feature.attr.var == 'urn:xmpp:serverinfo:0' then
5831
2465d5191ae9 mod_pubsub_serverinfo: Consider sibling vhosts 'connected'
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5828
diff changeset
260 module:log("debug", "Disco/info response included opt-in for '%s'", remoteDomain)
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
261 opt_in_cache[remoteDomain] = {
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
262 opt_in = true;
5828
55b99f593c3a mod_pubsub_serverinfo: Disco/info cache TTL should be configurable
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5827
diff changeset
263 expires = os.time() + cache_ttl;
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
264 }
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
265 return; -- prevent 'false' to be cached, down below.
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
266 end
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
267 end
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
268 end
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
269 end
5831
2465d5191ae9 mod_pubsub_serverinfo: Consider sibling vhosts 'connected'
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5828
diff changeset
270 module:log("debug", "Disco/info response did not include opt-in for '%s'", remoteDomain)
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
271 opt_in_cache[remoteDomain] = {
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
272 opt_in = false;
5828
55b99f593c3a mod_pubsub_serverinfo: Disco/info cache TTL should be configurable
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5827
diff changeset
273 expires = os.time() + cache_ttl;
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
274 }
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
275 end,
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
276 function(response)
5831
2465d5191ae9 mod_pubsub_serverinfo: Consider sibling vhosts 'connected'
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5828
diff changeset
277 module:log("debug", "An error occurred while performing a disco/info request to determine opt-in for '%s'", remoteDomain, response)
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
278 opt_in_cache[remoteDomain] = {
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
279 opt_in = false;
5828
55b99f593c3a mod_pubsub_serverinfo: Disco/info cache TTL should be configurable
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5827
diff changeset
280 expires = os.time() + cache_ttl;
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
281 }
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
282 end
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
283 );
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
284
5835
cf5f77491323 mod_pubsub_serverinfo: Refresh cache entries if they will expire before next run
Matthew Wild <mwild1@gmail.com>
parents: 5833
diff changeset
285 if ttl and ttl <= 0 then
cf5f77491323 mod_pubsub_serverinfo: Refresh cache entries if they will expire before next run
Matthew Wild <mwild1@gmail.com>
parents: 5833
diff changeset
286 -- Cache entry expired, remove it and assume not opted in
cf5f77491323 mod_pubsub_serverinfo: Refresh cache entries if they will expire before next run
Matthew Wild <mwild1@gmail.com>
parents: 5833
diff changeset
287 opt_in_cache[remoteDomain] = nil;
cf5f77491323 mod_pubsub_serverinfo: Refresh cache entries if they will expire before next run
Matthew Wild <mwild1@gmail.com>
parents: 5833
diff changeset
288 return false;
cf5f77491323 mod_pubsub_serverinfo: Refresh cache entries if they will expire before next run
Matthew Wild <mwild1@gmail.com>
parents: 5833
diff changeset
289 end
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
290
5835
cf5f77491323 mod_pubsub_serverinfo: Refresh cache entries if they will expire before next run
Matthew Wild <mwild1@gmail.com>
parents: 5833
diff changeset
291 return cached_value and cached_value.opt_in;
5826
f55e65315ba0 mod_pubsub_serverinfo: implemented all basic features
Guus der Kinderen <guus.der.kinderen@gmail.com>
parents: 5824
diff changeset
292 end