2 -- Copyright (C) 2008-2009 Matthew Wild
3 -- Copyright (C) 2008-2009 Waqas Hussain
5 -- This project is MIT/X11 licensed. Please see the
6 -- COPYING file in the source package for more information.
9 module.host = "*" -- Global module
11 local hosts = _G.hosts;
12 local lxp = require "lxp";
13 local init_xmlhandlers = require "core.xmlhandlers"
14 local server = require "net.server";
15 local httpserver = require "net.httpserver";
16 local sm = require "core.sessionmanager";
17 local sm_destroy_session = sm.destroy_session;
18 local new_uuid = require "util.uuid".generate;
19 local fire_event = require "core.eventmanager".fire_event;
20 local core_process_stanza = core_process_stanza;
21 local st = require "util.stanza";
22 local logger = require "util.logger";
23 local log = logger.init("mod_bosh");
25 local xmlns_bosh = "http://jabber.org/protocol/httpbind"; -- (hard-coded into a literal in session.send)
26 local stream_callbacks = { stream_tag = "http://jabber.org/protocol/httpbind\1body", default_ns = xmlns_bosh };
28 local BOSH_DEFAULT_HOLD = tonumber(module:get_option("bosh_default_hold")) or 1;
29 local BOSH_DEFAULT_INACTIVITY = tonumber(module:get_option("bosh_max_inactivity")) or 60;
30 local BOSH_DEFAULT_POLLING = tonumber(module:get_option("bosh_max_polling")) or 5;
31 local BOSH_DEFAULT_REQUESTS = tonumber(module:get_option("bosh_max_requests")) or 2;
32 local BOSH_DEFAULT_MAXPAUSE = tonumber(module:get_option("bosh_max_pause")) or 300;
34 local default_headers = { ["Content-Type"] = "text/xml; charset=utf-8" };
35 local session_close_reply = { headers = default_headers, body = st.stanza("body", { xmlns = xmlns_bosh, type = "terminate" }), attr = {} };
37 local t_insert, t_remove, t_concat = table.insert, table.remove, table.concat;
38 local os_time = os.time;
41 local inactive_sessions = {}; -- Sessions which have no open requests
43 -- Used to respond to idle sessions (those with waiting requests)
44 local waiting_requests = {};
45 function on_destroy_request(request)
46 waiting_requests[request] = nil;
47 local session = sessions[request.sid];
49 local requests = session.requests;
50 for i,r in pairs(requests) do
51 if r == request then requests[i] = nil; break; end
54 -- If this session now has no requests open, mark it as inactive
55 if #requests == 0 and session.bosh_max_inactive and not inactive_sessions[session] then
56 inactive_sessions[session] = os_time();
57 (session.log or log)("debug", "BOSH session marked as inactive at %d", inactive_sessions[session]);
62 function handle_request(method, body, request)
63 if (not body) or request.method ~= "POST" then
64 return "<html><body>You really don't look like a BOSH client to me... what do you want?</body></html>";
67 log("debug", "Request %s suffered error %s", tostring(request.id), body);
70 --log("debug", "Handling new request %s: %s\n----------", request.id, tostring(body));
71 request.notopen = true;
73 local parser = lxp.new(init_xmlhandlers(request, stream_callbacks), "\1");
77 local session = sessions[request.sid];
79 local r = session.requests;
80 log("debug", "Session %s has %d out of %d requests open", request.sid, #r, session.bosh_hold);
81 log("debug", "and there are %d things in the send_buffer", #session.send_buffer);
82 if #r > session.bosh_hold then
83 -- We are holding too many requests, send what's in the buffer,
84 log("debug", "We are holding too many requests, so...");
85 if #session.send_buffer > 0 then
86 log("debug", "...sending what is in the buffer")
87 session.send(t_concat(session.send_buffer));
88 session.send_buffer = {};
90 -- or an empty response
91 log("debug", "...sending an empty response");
94 elseif #session.send_buffer > 0 then
95 log("debug", "Session has data in the send buffer, will send now..");
96 local resp = t_concat(session.send_buffer);
97 session.send_buffer = {};
101 if not request.destroyed and session.bosh_wait then
102 request.reply_before = os_time() + session.bosh_wait;
103 request.on_destroy = on_destroy_request;
104 waiting_requests[request] = true;
107 log("debug", "Have nothing to say, so leaving request unanswered for now");
113 local function bosh_reset_stream(session) session.notopen = true; end
115 local function bosh_close_stream(session, reason)
116 (session.log or log)("info", "BOSH client disconnected");
117 session_close_reply.attr.condition = reason;
118 for _, held_request in ipairs(session.requests) do
119 held_request:send(session_close_reply);
120 held_request:destroy();
122 sessions[session.sid] = nil;
123 sm_destroy_session(session);
126 function stream_callbacks.streamopened(request, attr)
127 log("debug", "BOSH body open (sid: %s)", attr.sid);
130 -- New session request
131 request.notopen = nil; -- Signals that we accept this opening tag
133 -- TODO: Sanity checks here (rid, to, known host, etc.)
134 if not hosts[attr.to] then
136 log("debug", "BOSH client tried to connect to unknown host: %s", tostring(attr.to));
137 session_close_reply.body.attr.condition = "host-unknown";
138 request:send(session_close_reply);
139 request.notopen = nil
145 local session = { type = "c2s_unauthed", conn = {}, sid = sid, rid = tonumber(attr.rid), host = attr.to, bosh_version = attr.ver, bosh_wait = attr.wait, streamid = sid,
146 bosh_hold = BOSH_DEFAULT_HOLD, bosh_max_inactive = BOSH_DEFAULT_INACTIVITY,
147 requests = { }, send_buffer = {}, reset_stream = bosh_reset_stream, close = bosh_close_stream,
148 dispatch_stanza = core_process_stanza, log = logger.init("bosh"..sid), secure = request.secure };
149 sessions[sid] = session;
151 log("info", "New BOSH session, assigned it sid '%s'", sid);
152 local r, send_buffer = session.requests, session.send_buffer;
153 local response = { headers = default_headers }
154 function session.send(s)
155 log("debug", "Sending BOSH data: %s", tostring(s));
156 local oldest_request = r[1];
157 while oldest_request and oldest_request.destroyed do
159 waiting_requests[oldest_request] = nil;
160 oldest_request = r[1];
162 if oldest_request then
163 log("debug", "We have an open request, so using that to send with");
164 response.body = t_concat{"<body xmlns='http://jabber.org/protocol/httpbind' sid='", sid, "' xmlns:stream = 'http://etherx.jabber.org/streams'>", tostring(s), "</body>" };
165 oldest_request:send(response);
166 --log("debug", "Sent");
167 if oldest_request.stayopen then
169 -- Move front request to back
170 t_insert(r, oldest_request);
174 log("debug", "Destroying the request now...");
175 oldest_request:destroy();
179 log("debug", "Saved to send buffer because there are %d open requests", #r);
180 -- Hmm, no requests are open :(
181 t_insert(session.send_buffer, tostring(s));
182 log("debug", "There are now %d things in the send_buffer", #session.send_buffer);
186 -- Send creation response
188 local features = st.stanza("stream:features");
189 fire_event("stream-features", session, features);
190 --xmpp:version='1.0' xmlns:xmpp='urn:xmpp:xbosh'
191 local response = st.stanza("body", { xmlns = xmlns_bosh,
192 inactivity = tostring(BOSH_DEFAULT_INACTIVITY), polling = tostring(BOSH_DEFAULT_POLLING), requests = tostring(BOSH_DEFAULT_REQUESTS), hold = tostring(session.bosh_hold), maxpause = "120",
193 sid = sid, authid = sid, ver = '1.6', from = session.host, secure = 'true', ["xmpp:version"] = "1.0",
194 ["xmlns:xmpp"] = "urn:xmpp:xbosh", ["xmlns:stream"] = "http://etherx.jabber.org/streams" }):add_child(features);
195 request:send{ headers = default_headers, body = tostring(response) };
201 local session = sessions[sid];
204 log("info", "Client tried to use sid '%s' which we don't know about", sid);
205 request:send{ headers = default_headers, body = tostring(st.stanza("body", { xmlns = xmlns_bosh, type = "terminate", condition = "item-not-found" })) };
206 request.notopen = nil;
211 local rid = tonumber(attr.rid);
212 local diff = rid - session.rid;
214 session.log("warn", "rid too large (means a request was lost). Last rid: %d New rid: %s", session.rid, attr.rid);
215 elseif diff <= 0 then
217 session.log("debug", "rid repeated (on request %s), ignoring: %d", request.id, session.rid);
218 request.notopen = nil;
219 t_insert(session.requests, request);
225 if attr.type == "terminate" then
226 -- Client wants to end this session
228 request.notopen = nil;
232 -- If session was inactive, make sure it is now marked as not
233 if #session.requests == 0 then
234 (session.log or log)("debug", "BOSH client now active again at %d", os_time());
235 inactive_sessions[session] = nil;
238 if session.notopen then
239 local features = st.stanza("stream:features");
240 fire_event("stream-features", session, features);
241 session.send(features);
242 session.notopen = nil;
245 request.notopen = nil; -- Signals that we accept this opening tag
246 t_insert(session.requests, request);
250 function stream_callbacks.handlestanza(request, stanza)
251 log("debug", "BOSH stanza received: %s\n", stanza:top_tag());
252 local session = sessions[request.sid];
254 if stanza.attr.xmlns == xmlns_bosh then
255 stanza.attr.xmlns = "jabber:client";
257 session.ip = request.handler.ip();
258 core_process_stanza(session, stanza);
262 local dead_sessions = {};
264 -- log("debug", "Checking for requests soon to timeout...");
265 -- Identify requests timing out within the next few seconds
266 local now = os_time() + 3;
267 for request in pairs(waiting_requests) do
268 if request.reply_before <= now then
269 log("debug", "%s was soon to timeout, sending empty response", request.id);
270 -- Send empty response to let the
271 -- client know we're still here
273 sessions[request.sid].send("");
279 local n_dead_sessions = 0;
280 for session, inactive_since in pairs(inactive_sessions) do
281 if session.bosh_max_inactive then
282 if now - inactive_since > session.bosh_max_inactive then
283 (session.log or log)("debug", "BOSH client inactive too long, destroying session at %d", now);
284 sessions[session.sid] = nil;
285 inactive_sessions[session] = nil;
286 n_dead_sessions = n_dead_sessions + 1;
287 dead_sessions[n_dead_sessions] = session;
290 inactive_sessions[session] = nil;
294 for i=1,n_dead_sessions do
295 local session = dead_sessions[i];
296 dead_sessions[i] = nil;
297 sm_destroy_session(session, "BOSH client silent for over "..session.bosh_max_inactive.." seconds");
301 local ports = module:get_option("bosh_ports") or { 5280 };
302 httpserver.new_from_config(ports, handle_request, { base = "http-bind" });
304 server.addtimer(on_timer);