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");
24 local stream_callbacks = { stream_tag = "http://jabber.org/protocol/httpbind|body" };
25 local xmlns_bosh = "http://jabber.org/protocol/httpbind"; -- (hard-coded into a literal in session.send)
27 local BOSH_DEFAULT_HOLD = tonumber(module:get_option("bosh_default_hold")) or 1;
28 local BOSH_DEFAULT_INACTIVITY = tonumber(module:get_option("bosh_max_inactivity")) or 60;
29 local BOSH_DEFAULT_POLLING = tonumber(module:get_option("bosh_max_polling")) or 5;
30 local BOSH_DEFAULT_REQUESTS = tonumber(module:get_option("bosh_max_requests")) or 2;
31 local BOSH_DEFAULT_MAXPAUSE = tonumber(module:get_option("bosh_max_pause")) or 300;
33 local default_headers = { ["Content-Type"] = "text/xml; charset=utf-8" };
34 local session_close_reply = { headers = default_headers, body = st.stanza("body", { xmlns = xmlns_bosh, type = "terminate" }), attr = {} };
36 local t_insert, t_remove, t_concat = table.insert, table.remove, table.concat;
37 local os_time = os.time;
40 local inactive_sessions = {}; -- Sessions which have no open requests
42 -- Used to respond to idle sessions (those with waiting requests)
43 local waiting_requests = {};
44 function on_destroy_request(request)
45 waiting_requests[request] = nil;
46 local session = sessions[request.sid];
48 local requests = session.requests;
49 for i,r in pairs(requests) do
50 if r == request then requests[i] = nil; break; end
53 -- If this session now has no requests open, mark it as inactive
54 if #requests == 0 and session.bosh_max_inactive and not inactive_sessions[session] then
55 inactive_sessions[session] = os_time();
56 (session.log or log)("debug", "BOSH session marked as inactive at %d", inactive_sessions[session]);
61 function handle_request(method, body, request)
62 if (not body) or request.method ~= "POST" then
63 return "<html><body>You really don't look like a BOSH client to me... what do you want?</body></html>";
66 log("debug", "Request %s suffered error %s", tostring(request.id), body);
69 --log("debug", "Handling new request %s: %s\n----------", request.id, tostring(body));
70 request.notopen = true;
72 local parser = lxp.new(init_xmlhandlers(request, stream_callbacks), "|");
76 local session = sessions[request.sid];
78 local r = session.requests;
79 log("debug", "Session %s has %d out of %d requests open", request.sid, #r, session.bosh_hold);
80 log("debug", "and there are %d things in the send_buffer", #session.send_buffer);
81 if #r > session.bosh_hold then
82 -- We are holding too many requests, send what's in the buffer,
83 log("debug", "We are holding too many requests, so...");
84 if #session.send_buffer > 0 then
85 log("debug", "...sending what is in the buffer")
86 session.send(t_concat(session.send_buffer));
87 session.send_buffer = {};
89 -- or an empty response
90 log("debug", "...sending an empty response");
93 elseif #session.send_buffer > 0 then
94 log("debug", "Session has data in the send buffer, will send now..");
95 local resp = t_concat(session.send_buffer);
96 session.send_buffer = {};
100 if not request.destroyed and session.bosh_wait then
101 request.reply_before = os_time() + session.bosh_wait;
102 request.on_destroy = on_destroy_request;
103 waiting_requests[request] = true;
106 log("debug", "Have nothing to say, so leaving request unanswered for now");
112 local function bosh_reset_stream(session) session.notopen = true; end
114 local function bosh_close_stream(session, reason)
115 (session.log or log)("info", "BOSH client disconnected");
116 session_close_reply.attr.condition = reason;
117 for _, held_request in ipairs(session.requests) do
118 held_request:send(session_close_reply);
119 held_request:destroy();
121 sessions[session.sid] = nil;
122 sm_destroy_session(session);
125 function stream_callbacks.streamopened(request, attr)
126 log("debug", "BOSH body open (sid: %s)", attr.sid);
129 -- New session request
130 request.notopen = nil; -- Signals that we accept this opening tag
132 -- TODO: Sanity checks here (rid, to, known host, etc.)
133 if not hosts[attr.to] then
135 log("debug", "BOSH client tried to connect to unknown host: %s", tostring(attr.to));
136 session_close_reply.body.attr.condition = "host-unknown";
137 request:send(session_close_reply);
138 request.notopen = nil
144 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,
145 bosh_hold = BOSH_DEFAULT_HOLD, bosh_max_inactive = BOSH_DEFAULT_INACTIVITY,
146 requests = { }, send_buffer = {}, reset_stream = bosh_reset_stream, close = bosh_close_stream,
147 dispatch_stanza = core_process_stanza, log = logger.init("bosh"..sid), secure = request.secure };
148 sessions[sid] = session;
150 log("info", "New BOSH session, assigned it sid '%s'", sid);
151 local r, send_buffer = session.requests, session.send_buffer;
152 local response = { headers = default_headers }
153 function session.send(s)
154 log("debug", "Sending BOSH data: %s", tostring(s));
155 local oldest_request = r[1];
156 while oldest_request and oldest_request.destroyed do
158 waiting_requests[oldest_request] = nil;
159 oldest_request = r[1];
161 if oldest_request then
162 log("debug", "We have an open request, so using that to send with");
163 response.body = t_concat{"<body xmlns='http://jabber.org/protocol/httpbind' sid='", sid, "' xmlns:stream = 'http://etherx.jabber.org/streams'>", tostring(s), "</body>" };
164 oldest_request:send(response);
165 --log("debug", "Sent");
166 if oldest_request.stayopen then
168 -- Move front request to back
169 t_insert(r, oldest_request);
173 log("debug", "Destroying the request now...");
174 oldest_request:destroy();
178 log("debug", "Saved to send buffer because there are %d open requests", #r);
179 -- Hmm, no requests are open :(
180 t_insert(session.send_buffer, tostring(s));
181 log("debug", "There are now %d things in the send_buffer", #session.send_buffer);
185 -- Send creation response
187 local features = st.stanza("stream:features");
188 fire_event("stream-features", session, features);
189 --xmpp:version='1.0' xmlns:xmpp='urn:xmpp:xbosh'
190 local response = st.stanza("body", { xmlns = xmlns_bosh,
191 inactivity = tostring(BOSH_DEFAULT_INACTIVITY), polling = tostring(BOSH_DEFAULT_POLLING), requests = tostring(BOSH_DEFAULT_REQUESTS), hold = tostring(session.bosh_hold), maxpause = "120",
192 sid = sid, authid = sid, ver = '1.6', from = session.host, secure = 'true', ["xmpp:version"] = "1.0",
193 ["xmlns:xmpp"] = "urn:xmpp:xbosh", ["xmlns:stream"] = "http://etherx.jabber.org/streams" }):add_child(features);
194 request:send{ headers = default_headers, body = tostring(response) };
200 local session = sessions[sid];
203 log("info", "Client tried to use sid '%s' which we don't know about", sid);
204 request:send{ headers = default_headers, body = tostring(st.stanza("body", { xmlns = xmlns_bosh, type = "terminate", condition = "item-not-found" })) };
205 request.notopen = nil;
210 local rid = tonumber(attr.rid);
211 local diff = rid - session.rid;
213 session.log("warn", "rid too large (means a request was lost). Last rid: %d New rid: %s", session.rid, attr.rid);
214 elseif diff <= 0 then
216 session.log("debug", "rid repeated (on request %s), ignoring: %d", request.id, session.rid);
217 request.notopen = nil;
218 t_insert(session.requests, request);
224 if attr.type == "terminate" then
225 -- Client wants to end this session
227 request.notopen = nil;
231 -- If session was inactive, make sure it is now marked as not
232 if #session.requests == 0 then
233 (session.log or log)("debug", "BOSH client now active again at %d", os_time());
234 inactive_sessions[session] = nil;
237 if session.notopen then
238 local features = st.stanza("stream:features");
239 fire_event("stream-features", session, features);
240 session.send(features);
241 session.notopen = nil;
244 request.notopen = nil; -- Signals that we accept this opening tag
245 t_insert(session.requests, request);
249 function stream_callbacks.handlestanza(request, stanza)
250 log("debug", "BOSH stanza received: %s\n", stanza:top_tag());
251 local session = sessions[request.sid];
253 if stanza.attr.xmlns == xmlns_bosh then
254 stanza.attr.xmlns = "jabber:client";
256 core_process_stanza(session, stanza);
261 -- log("debug", "Checking for requests soon to timeout...");
262 -- Identify requests timing out within the next few seconds
263 local now = os_time() + 3;
264 for request in pairs(waiting_requests) do
265 if request.reply_before <= now then
266 log("debug", "%s was soon to timeout, sending empty response", request.id);
267 -- Send empty response to let the
268 -- client know we're still here
270 sessions[request.sid].send("");
276 for session, inactive_since in pairs(inactive_sessions) do
277 if session.bosh_max_inactive then
278 if now - inactive_since > session.bosh_max_inactive then
279 (session.log or log)("debug", "BOSH client inactive too long, destroying session at %d", now);
280 sessions[session.sid] = nil;
281 inactive_sessions[session] = nil;
282 sm_destroy_session(session, "BOSH client silent for over "..session.bosh_max_inactive.." seconds");
285 inactive_sessions[session] = nil;
290 local ports = module:get_option("bosh_ports") or { 5280 };
291 httpserver.new_from_config(ports, "http-bind", handle_request);
293 server.addtimer(on_timer);