plugins/mod_bosh.lua

   1
   2 module.host = "*" -- Global module
   3
   4 local lxp = require "lxp";
   5 local init_xmlhandlers = require "core.xmlhandlers"
   6 local server = require "net.server";
   7 local httpserver = require "net.httpserver";
   8 local sm = require "core.sessionmanager";
   9 local sm_destroy_session = sm.destroy_session;
  10 local new_uuid = require "util.uuid".generate;
  11 local fire_event = require "core.eventmanager".fire_event;
  12 local core_process_stanza = core_process_stanza;
  13 local st = require "util.stanza";
  14 local log = require "util.logger".init("bosh");
  15 local stream_callbacks = { stream_tag = "http://jabber.org/protocol/httpbind|body" };
  16 local config = require "core.configmanager";
  17 local xmlns_bosh = "http://jabber.org/protocol/httpbind"; -- (hard-coded into a literal in session.send)
  18
  19 local BOSH_DEFAULT_HOLD = tonumber(config.get("*", "core", "bosh_default_hold")) or 1;
  20 local BOSH_DEFAULT_INACTIVITY = tonumber(config.get("*", "core", "bosh_max_inactivity")) or 60;
  21 local BOSH_DEFAULT_POLLING = tonumber(config.get("*", "core", "bosh_max_polling")) or 5;
  22 local BOSH_DEFAULT_REQUESTS = tonumber(config.get("*", "core", "bosh_max_requests")) or 2;
  23 local BOSH_DEFAULT_MAXPAUSE = tonumber(config.get("*", "core", "bosh_max_pause")) or 300;
  24
  25 local t_insert, t_remove, t_concat = table.insert, table.remove, table.concat;
  26 local os_time = os.time;
  27
  28 local sessions = {};
  29 local inactive_sessions = {}; -- Sessions which have no open requests
  30
  31 -- Used to respond to idle sessions (those with waiting requests)
  32 local waiting_requests = {};
  33 function on_destroy_request(request)
  34         waiting_requests[request] = nil;
  35 end
  36
  37 function handle_request(method, body, request)
  38         if (not body) or request.method ~= "POST" then
  39                 return "<html><body>You really don't look like a BOSH client to me... what do you want?</body></html>";
  40         end
  41         if not method then
  42                 log("debug", "Request %s suffered error %s", tostring(request.id), body);
  43                 return;
  44         end
  45         log("debug", "Handling new request %s: %s\n----------", request.id, tostring(body));
  46         request.notopen = true;
  47         request.log = log;
  48         local parser = lxp.new(init_xmlhandlers(request, stream_callbacks), "|");
  49
  50         parser:parse(body);
  51
  52         local session = sessions[request.sid];
  53         if session then
  54                 local r = session.requests;
  55                 log("debug", "Session %s has %d out of %d requests open", request.sid, #r, session.bosh_hold);
  56                 log("debug", "and there are %d things in the send_buffer", #session.send_buffer);
  57                 if #r > session.bosh_hold then
  58                         -- We are holding too many requests, send what's in the buffer,
  59                         log("debug", "We are holding too many requests, so...");
  60                         if #session.send_buffer > 0 then
  61                                 log("debug", "...sending what is in the buffer")
  62                                 session.send(t_concat(session.send_buffer));
  63                                 session.send_buffer = {};
  64                         else
  65                                 -- or an empty response
  66                                 log("debug", "...sending an empty response");
  67                                 session.send("");
  68                         end
  69                 elseif #session.send_buffer > 0 then
  70                         log("debug", "Session has data in the send buffer, will send now..");
  71                         local resp = t_concat(session.send_buffer);
  72                         session.send_buffer = {};
  73                         session.send(resp);
  74                 end
  75
  76                 if not request.destroyed and session.bosh_wait then
  77                         request.reply_before = os_time() + session.bosh_wait;
  78                         request.on_destroy = on_destroy_request;
  79                         waiting_requests[request] = true;
  80                 end
  81
  82                 log("debug", "Had nothing to say, so leaving request unanswered for now");
  83                 return true;
  84         end
  85 end
  86
  87
  88 local function bosh_reset_stream(session) session.notopen = true; end
  89
  90 local session_close_reply = st.stanza("body", { xmlns = xmlns_bosh, type = "terminate" });
  91 local function bosh_close_stream(session, reason)
  92         (session.log or log)("info", "BOSH client disconnected");
  93         session_close_reply.attr.condition = reason;
  94         local session_close_reply = tostring(session_close_reply);
  95         for _, held_request in ipairs(session.requests) do
  96                 held_request:send(session_close_reply);
  97                 held_request:destroy();
  98         end
  99         sessions[session.sid]  = nil;
 100         sm_destroy_session(session);
 101 end
 102
 103 function stream_callbacks.streamopened(request, attr)
 104         print("Attr:")
 105         for k,v in pairs(attr) do print("", k, v); end
 106         log("debug", "BOSH body open (sid: %s)", attr.sid);
 107         local sid = attr.sid
 108         if not sid then
 109                 -- New session request
 110                 request.notopen = nil; -- Signals that we accept this opening tag
 111
 112                 -- TODO: Sanity checks here (rid, to, known host, etc.)
 113                 if not hosts[attr.to] then
 114                         -- Unknown host
 115                         session_close_reply.attr.condition = "host-unknown";
 116                         request:send(tostring(session_close_reply));
 117                         request.notopen = nil
 118                         return;
 119                 end
 120
 121                 -- New session
 122                 sid = tostring(new_uuid());
 123                 local session = { type = "c2s_unauthed", conn = {}, sid = sid, rid = attr.rid, host = attr.to, bosh_version = attr.ver, bosh_wait = attr.wait, streamid = sid,
 124                                                 bosh_hold = BOSH_DEFAULT_HOLD, bosh_max_inactive = BOSH_DEFAULT_INACTIVITY,
 125                                                 requests = { }, send_buffer = {}, reset_stream = bosh_reset_stream, close = bosh_close_stream, dispatch_stanza = core_process_stanza };
 126                 sessions[sid] = session;
 127                 log("info", "New BOSH session, assigned it sid '%s'", sid);
 128                 local r, send_buffer = session.requests, session.send_buffer;
 129                 local response = { }
 130                 function session.send(s)
 131                         log("debug", "Sending BOSH data: %s", tostring(s));
 132                         local oldest_request = r[1];
 133                         while oldest_request and oldest_request.destroyed do
 134                                 t_remove(r, 1);
 135                                 waiting_requests[oldest_request] = nil;
 136                                 oldest_request = r[1];
 137                         end
 138                         if oldest_request then
 139                                 log("debug", "We have an open request, so using that to send with");
 140                                 response.body = t_concat{"<body xmlns='http://jabber.org/protocol/httpbind' sid='", sid, "' xmlns:stream = 'http://etherx.jabber.org/streams'>", tostring(s), "</body>" };
 141                                 oldest_request:send(response);
 142                                 log("debug", "Sent");
 143                                 if oldest_request.stayopen then
 144                                         if #r>1 then
 145                                                 -- Move front request to back
 146                                                 t_insert(r, oldest_request);
 147                                                 t_remove(r, 1);
 148                                         end
 149                                 else
 150                                         log("debug", "Destroying the request now...");
 151                                         oldest_request:destroy();
 152                                         t_remove(r, 1);
 153                                 end
 154                         elseif s ~= "" then
 155                                 log("debug", "Saved to send buffer because there are %d open requests", #r);
 156                                 if session.bosh_max_inactive and not inactive_sessions[session] then
 157                                         inactive_sessions[session] = os_time();
 158                                         (session.log or log)("debug", "BOSH session marked as inactive at %d", inactive_sessions[session]);
 159                                 end
 160                                 -- Hmm, no requests are open :(
 161                                 t_insert(session.send_buffer, tostring(s));
 162                                 log("debug", "There are now %d things in the send_buffer", #session.send_buffer);
 163                         end
 164                 end
 165
 166                 -- Send creation response
 167
 168                 local features = st.stanza("stream:features");
 169                 fire_event("stream-features", session, features);
 170                 --xmpp:version='1.0' xmlns:xmpp='urn:xmpp:xbosh'
 171                 local response = st.stanza("body", { xmlns = xmlns_bosh,
 172                                                                         inactivity = tostring(BOSH_DEFAULT_INACTIVITY), polling = tostring(BOSH_DEFAULT_POLLING), requests = tostring(BOSH_DEFAULT_REQUESTS), hold = tostring(session.bosh_hold), maxpause = "120",
 173                                                                         sid = sid, ver  = '1.6', from = session.host, secure = 'true', ["xmpp:version"] = "1.0",
 174                                                                         ["xmlns:xmpp"] = "urn:xmpp:xbosh", ["xmlns:stream"] = "http://etherx.jabber.org/streams" }):add_child(features);
 175                 request:send(tostring(response));
 176
 177                 request.sid = sid;
 178                 return;
 179         end
 180
 181         local session = sessions[sid];
 182         if not session then
 183                 -- Unknown sid
 184                 log("info", "Client tried to use sid '%s' which we don't know about", sid);
 185                 request:send(tostring(st.stanza("body", { xmlns = xmlns_bosh, type = "terminate", condition = "item-not-found" })));
 186                 request.notopen = nil;
 187                 return;
 188         end
 189
 190         if attr.type == "terminate" then
 191                 -- Client wants to end this session
 192                 session:close();
 193                 request.notopen = nil;
 194                 return;
 195         end
 196
 197         -- If session was inactive, make sure it is now marked as not
 198         if #session.requests == 0 then
 199                 (session.log or log)("debug", "BOSH client now active again at %d", os_time());
 200                 inactive_sessions[session] = nil;
 201         end
 202
 203         if session.notopen then
 204                 local features = st.stanza("stream:features");
 205                 fire_event("stream-features", session, features);
 206                 session.send(features);
 207                 session.notopen = nil;
 208         end
 209
 210         request.notopen = nil; -- Signals that we accept this opening tag
 211         t_insert(session.requests, request);
 212         request.sid = sid;
 213 end
 214
 215 function stream_callbacks.handlestanza(request, stanza)
 216         log("debug", "BOSH stanza received: %s\n", stanza:pretty_print());
 217         local session = sessions[request.sid];
 218         if session then
 219                 if stanza.attr.xmlns == xmlns_bosh then
 220                         stanza.attr.xmlns = "jabber:client";
 221                 end
 222                 core_process_stanza(session, stanza);
 223         end
 224 end
 225
 226 function on_timer()
 227         -- log("debug", "Checking for requests soon to timeout...");
 228         -- Identify requests timing out within the next few seconds
 229         local now = os_time() + 3;
 230         for request in pairs(waiting_requests) do
 231                 if request.reply_before <= now then
 232                         log("debug", "%s was soon to timeout, sending empty response", request.id);
 233                         -- Send empty response to let the
 234                         -- client know we're still here
 235                         if request.conn then
 236                                 sessions[request.sid].send("");
 237                         end
 238                 end
 239         end
 240
 241         now = now - 3;
 242         for session, inactive_since in pairs(inactive_sessions) do
 243                 if now - inactive_since > session.bosh_max_inactive then
 244                         (session.log or log)("debug", "BOSH client inactive too long, destroying session at %d", now);
 245                         sessions[session.sid]  = nil;
 246                         inactive_sessions[session] = nil;
 247                         sm_destroy_session(session, "BOSH client silent for over "..session.bosh_max_inactive.." seconds");
 248                 end
 249         end
 250 end
 251
 252 httpserver.new{ port = 5280, base = "http-bind", handler = handle_request, ssl = false}
 253 server.addtimer(on_timer);