2 module.host = "*" -- Global module
4 local hosts = _G.hosts;
5 local lxp = require "lxp";
6 local init_xmlhandlers = require "core.xmlhandlers"
7 local server = require "net.server";
8 local httpserver = require "net.httpserver";
9 local sm = require "core.sessionmanager";
10 local sm_destroy_session = sm.destroy_session;
11 local new_uuid = require "util.uuid".generate;
12 local fire_event = require "core.eventmanager".fire_event;
13 local core_process_stanza = core_process_stanza;
14 local st = require "util.stanza";
15 local log = require "util.logger".init("bosh");
16 local stream_callbacks = { stream_tag = "http://jabber.org/protocol/httpbind|body" };
17 local config = require "core.configmanager";
18 local xmlns_bosh = "http://jabber.org/protocol/httpbind"; -- (hard-coded into a literal in session.send)
20 local BOSH_DEFAULT_HOLD = tonumber(config.get("*", "core", "bosh_default_hold")) or 1;
21 local BOSH_DEFAULT_INACTIVITY = tonumber(config.get("*", "core", "bosh_max_inactivity")) or 60;
22 local BOSH_DEFAULT_POLLING = tonumber(config.get("*", "core", "bosh_max_polling")) or 5;
23 local BOSH_DEFAULT_REQUESTS = tonumber(config.get("*", "core", "bosh_max_requests")) or 2;
24 local BOSH_DEFAULT_MAXPAUSE = tonumber(config.get("*", "core", "bosh_max_pause")) or 300;
26 local default_headers = { ["Content-Type"] = "text/xml; charset=utf-8" };
28 local t_insert, t_remove, t_concat = table.insert, table.remove, table.concat;
29 local os_time = os.time;
32 local inactive_sessions = {}; -- Sessions which have no open requests
34 -- Used to respond to idle sessions (those with waiting requests)
35 local waiting_requests = {};
36 function on_destroy_request(request)
37 waiting_requests[request] = nil;
38 local session = sessions[request.sid];
40 local requests = session.requests;
41 for i,r in pairs(requests) do
42 if r == request then requests[i] = nil; break; end
45 -- If this session now has no requests open, mark it as inactive
46 if #requests == 0 and session.bosh_max_inactive and not inactive_sessions[session] then
47 inactive_sessions[session] = os_time();
48 (session.log or log)("debug", "BOSH session marked as inactive at %d", inactive_sessions[session]);
53 function handle_request(method, body, request)
54 if (not body) or request.method ~= "POST" then
55 return "<html><body>You really don't look like a BOSH client to me... what do you want?</body></html>";
58 log("debug", "Request %s suffered error %s", tostring(request.id), body);
61 --log("debug", "Handling new request %s: %s\n----------", request.id, tostring(body));
62 request.notopen = true;
64 local parser = lxp.new(init_xmlhandlers(request, stream_callbacks), "|");
68 local session = sessions[request.sid];
70 local r = session.requests;
71 log("debug", "Session %s has %d out of %d requests open", request.sid, #r, session.bosh_hold);
72 log("debug", "and there are %d things in the send_buffer", #session.send_buffer);
73 if #r > session.bosh_hold then
74 -- We are holding too many requests, send what's in the buffer,
75 log("debug", "We are holding too many requests, so...");
76 if #session.send_buffer > 0 then
77 log("debug", "...sending what is in the buffer")
78 session.send(t_concat(session.send_buffer));
79 session.send_buffer = {};
81 -- or an empty response
82 log("debug", "...sending an empty response");
85 elseif #session.send_buffer > 0 then
86 log("debug", "Session has data in the send buffer, will send now..");
87 local resp = t_concat(session.send_buffer);
88 session.send_buffer = {};
92 if not request.destroyed and session.bosh_wait then
93 request.reply_before = os_time() + session.bosh_wait;
94 request.on_destroy = on_destroy_request;
95 waiting_requests[request] = true;
98 log("debug", "Have nothing to say, so leaving request unanswered for now");
104 local function bosh_reset_stream(session) session.notopen = true; end
106 local session_close_reply = { headers = default_headers, body = st.stanza("body", { xmlns = xmlns_bosh, type = "terminate" }), attr = {} };
107 local function bosh_close_stream(session, reason)
108 (session.log or log)("info", "BOSH client disconnected");
109 session_close_reply.attr.condition = reason;
110 local session_close_reply = tostring(session_close_reply);
111 for _, held_request in ipairs(session.requests) do
112 held_request:send(session_close_reply);
113 held_request:destroy();
115 sessions[session.sid] = nil;
116 sm_destroy_session(session);
119 function stream_callbacks.streamopened(request, attr)
120 log("debug", "BOSH body open (sid: %s)", attr.sid);
123 -- New session request
124 request.notopen = nil; -- Signals that we accept this opening tag
126 -- TODO: Sanity checks here (rid, to, known host, etc.)
127 if not hosts[attr.to] then
129 log("debug", "BOSH client tried to connect to unknown host: %s", tostring(attr.to));
130 session_close_reply.attr.condition = "host-unknown";
131 request:send{ headers = default_headers, body = tostring(session_close_reply) };
132 request.notopen = nil
138 local session = { type = "c2s_unauthed", conn = {}, sid = sid, rid = attr.rid, host = attr.to, bosh_version = attr.ver, bosh_wait = attr.wait, streamid = sid,
139 bosh_hold = BOSH_DEFAULT_HOLD, bosh_max_inactive = BOSH_DEFAULT_INACTIVITY,
140 requests = { }, send_buffer = {}, reset_stream = bosh_reset_stream, close = bosh_close_stream, dispatch_stanza = core_process_stanza };
141 sessions[sid] = session;
142 log("info", "New BOSH session, assigned it sid '%s'", sid);
143 local r, send_buffer = session.requests, session.send_buffer;
144 local response = { headers = default_headers }
145 function session.send(s)
146 log("debug", "Sending BOSH data: %s", tostring(s));
147 local oldest_request = r[1];
148 while oldest_request and oldest_request.destroyed do
150 waiting_requests[oldest_request] = nil;
151 oldest_request = r[1];
153 if oldest_request then
154 log("debug", "We have an open request, so using that to send with");
155 response.body = t_concat{"<body xmlns='http://jabber.org/protocol/httpbind' sid='", sid, "' xmlns:stream = 'http://etherx.jabber.org/streams'>", tostring(s), "</body>" };
156 oldest_request:send(response);
157 --log("debug", "Sent");
158 if oldest_request.stayopen then
160 -- Move front request to back
161 t_insert(r, oldest_request);
165 log("debug", "Destroying the request now...");
166 oldest_request:destroy();
170 log("debug", "Saved to send buffer because there are %d open requests", #r);
171 -- Hmm, no requests are open :(
172 t_insert(session.send_buffer, tostring(s));
173 log("debug", "There are now %d things in the send_buffer", #session.send_buffer);
177 -- Send creation response
179 local features = st.stanza("stream:features");
180 fire_event("stream-features", session, features);
181 --xmpp:version='1.0' xmlns:xmpp='urn:xmpp:xbosh'
182 local response = st.stanza("body", { xmlns = xmlns_bosh,
183 inactivity = tostring(BOSH_DEFAULT_INACTIVITY), polling = tostring(BOSH_DEFAULT_POLLING), requests = tostring(BOSH_DEFAULT_REQUESTS), hold = tostring(session.bosh_hold), maxpause = "120",
184 sid = sid, authid = sid, ver = '1.6', from = session.host, secure = 'true', ["xmpp:version"] = "1.0",
185 ["xmlns:xmpp"] = "urn:xmpp:xbosh", ["xmlns:stream"] = "http://etherx.jabber.org/streams" }):add_child(features);
186 request:send{ headers = default_headers, body = tostring(response) };
192 local session = sessions[sid];
195 log("info", "Client tried to use sid '%s' which we don't know about", sid);
196 request:send{ headers = default_headers, body = tostring(st.stanza("body", { xmlns = xmlns_bosh, type = "terminate", condition = "item-not-found" })) };
197 request.notopen = nil;
201 if attr.type == "terminate" then
202 -- Client wants to end this session
204 request.notopen = nil;
208 -- If session was inactive, make sure it is now marked as not
209 if #session.requests == 0 then
210 (session.log or log)("debug", "BOSH client now active again at %d", os_time());
211 inactive_sessions[session] = nil;
214 if session.notopen then
215 local features = st.stanza("stream:features");
216 fire_event("stream-features", session, features);
217 session.send(features);
218 session.notopen = nil;
221 request.notopen = nil; -- Signals that we accept this opening tag
222 t_insert(session.requests, request);
226 function stream_callbacks.handlestanza(request, stanza)
227 log("debug", "BOSH stanza received: %s\n", stanza:top_tag());
228 local session = sessions[request.sid];
230 if stanza.attr.xmlns == xmlns_bosh then
231 stanza.attr.xmlns = "jabber:client";
233 core_process_stanza(session, stanza);
238 -- log("debug", "Checking for requests soon to timeout...");
239 -- Identify requests timing out within the next few seconds
240 local now = os_time() + 3;
241 for request in pairs(waiting_requests) do
242 if request.reply_before <= now then
243 log("debug", "%s was soon to timeout, sending empty response", request.id);
244 -- Send empty response to let the
245 -- client know we're still here
247 sessions[request.sid].send("");
253 for session, inactive_since in pairs(inactive_sessions) do
254 if session.bosh_max_inactive then
255 if now - inactive_since > session.bosh_max_inactive then
256 (session.log or log)("debug", "BOSH client inactive too long, destroying session at %d", now);
257 sessions[session.sid] = nil;
258 inactive_sessions[session] = nil;
259 sm_destroy_session(session, "BOSH client silent for over "..session.bosh_max_inactive.." seconds");
262 inactive_sessions[session] = nil;
267 local ports = config.get(module.host, "core", "bosh_ports") or { 5280 };
268 for _, options in ipairs(ports) do
269 local port, base, ssl, interface = 5280, "http-bind", false, nil;
270 if type(options) == "number" then
272 elseif type(options) == "table" then
273 port, base, ssl, interface = options.port or 5280, options.path or "http-bind", options.ssl or false, options.interface;
274 elseif type(options) == "string" then
277 httpserver.new{ port = port, base = base, handler = handle_request, ssl = ssl }
280 server.addtimer(on_timer);