mod_bosh: Store time to destroy session in inactive_sessions, removing dependency...
[prosody.git] / plugins / mod_bosh.lua
index b9106083c16b0421df857ada3a0e3ba8a1d29c24..ffba5c110e1a32ede7b332078b597e5d98201264 100644 (file)
@@ -10,8 +10,7 @@ module.host = "*" -- Global module
 
 local hosts = _G.hosts;
 local lxp = require "lxp";
-local init_xmlhandlers = require "core.xmlhandlers"
-local server = require "net.server";
+local new_xmpp_stream = require "util.xmppstream".new;
 local httpserver = require "net.httpserver";
 local sm = require "core.sessionmanager";
 local sm_destroy_session = sm.destroy_session;
@@ -21,6 +20,7 @@ local core_process_stanza = core_process_stanza;
 local st = require "util.stanza";
 local logger = require "util.logger";
 local log = logger.init("mod_bosh");
+local timer = require "util.timer";
 
 local xmlns_streams = "http://etherx.jabber.org/streams";
 local xmlns_xmpp_streams = "urn:ietf:params:xml:ns:xmpp-streams";
@@ -29,17 +29,16 @@ local xmlns_bosh = "http://jabber.org/protocol/httpbind"; -- (hard-coded into a
 local stream_callbacks = {
        stream_ns = xmlns_bosh, stream_tag = "body", default_ns = "jabber:client" };
 
-local BOSH_DEFAULT_HOLD = tonumber(module:get_option("bosh_default_hold")) or 1;
-local BOSH_DEFAULT_INACTIVITY = tonumber(module:get_option("bosh_max_inactivity")) or 60;
-local BOSH_DEFAULT_POLLING = tonumber(module:get_option("bosh_max_polling")) or 5;
-local BOSH_DEFAULT_REQUESTS = tonumber(module:get_option("bosh_max_requests")) or 2;
-local BOSH_DEFAULT_MAXPAUSE = tonumber(module:get_option("bosh_max_pause")) or 300;
+local BOSH_DEFAULT_HOLD = module:get_option_number("bosh_default_hold", 1);
+local BOSH_DEFAULT_INACTIVITY = module:get_option_number("bosh_max_inactivity", 60);
+local BOSH_DEFAULT_POLLING = module:get_option_number("bosh_max_polling", 5);
+local BOSH_DEFAULT_REQUESTS = module:get_option_number("bosh_max_requests", 2);
 
 local consider_bosh_secure = module:get_option_boolean("consider_bosh_secure");
 
 local default_headers = { ["Content-Type"] = "text/xml; charset=utf-8" };
 
-local cross_domain = module:get_option("cross_domain_bosh");
+local cross_domain = module:get_option("cross_domain_bosh", false);
 if cross_domain then
        default_headers["Access-Control-Allow-Methods"] = "GET, POST, OPTIONS";
        default_headers["Access-Control-Allow-Headers"] = "Content-Type";
@@ -92,9 +91,10 @@ function on_destroy_request(request)
                end
                
                -- If this session now has no requests open, mark it as inactive
-               if #requests == 0 and session.bosh_max_inactive and not inactive_sessions[session] then
-                       inactive_sessions[session] = os_time();
-                       (session.log or log)("debug", "BOSH session marked as inactive at %d", inactive_sessions[session]);
+               local max_inactive = session.bosh_max_inactive;
+               if max_inactive and #requests == 0 then
+                       inactive_sessions[session] = os_time() + max_inactive;
+                       (session.log or log)("debug", "BOSH session marked as inactive (for %ds)", max_inactive);
                end
        end
 end
@@ -102,7 +102,10 @@ end
 function handle_request(method, body, request)
        if (not body) or request.method ~= "POST" then
                if request.method == "OPTIONS" then
-                       return { headers = default_headers, body = "" };
+                       local headers = {};
+                       for k,v in pairs(default_headers) do headers[k] = v; end
+                       headers["Content-Type"] = nil;
+                       return { headers = headers, body = "" };
                else
                        return "<html><body>You really don't look like a BOSH client to me... what do you want?</body></html>";
                end
@@ -116,12 +119,19 @@ function handle_request(method, body, request)
        request.log = log;
        request.on_destroy = on_destroy_request;
        
-       local parser = lxp.new(init_xmlhandlers(request, stream_callbacks), "\1");
-       
-       parser:parse(body);
+       local stream = new_xmpp_stream(request, stream_callbacks);
+       -- stream:feed() calls the stream_callbacks, so all stanzas in
+       -- the body are processed in this next line before it returns.
+       stream:feed(body);
        
        local session = sessions[request.sid];
        if session then
+               -- Session was marked as inactive, since we have
+               -- a request open now, unmark it
+               if inactive_sessions[session] and #session.requests > 0 then
+                       inactive_sessions[session] = nil;
+               end
+
                local r = session.requests;
                log("debug", "Session %s has %d out of %d requests open", request.sid, #r, session.bosh_hold);
                log("debug", "and there are %d things in the send_buffer", #session.send_buffer);
@@ -151,14 +161,15 @@ function handle_request(method, body, request)
                                request.reply_before = os_time() + session.bosh_wait;
                                waiting_requests[request] = true;
                        end
-                       if inactive_sessions[session] then
-                               -- Session was marked as inactive, since we have
-                               -- a request open now, unmark it
-                               inactive_sessions[session] = nil;
-                       end
                end
                
-               return true; -- Inform httpserver we shall reply later
+               if session.bosh_terminate then
+                       session.log("debug", "Closing session with %d requests open", #session.requests);
+                       session:close();
+                       return nil;
+               else
+                       return true; -- Inform httpserver we shall reply later
+               end
        end
 end
 
@@ -171,7 +182,7 @@ local function bosh_close_stream(session, reason)
        (session.log or log)("info", "BOSH client disconnected");
        
        local close_reply = st.stanza("body", { xmlns = xmlns_bosh, type = "terminate",
-               ["xmlns:streams"] = xmlns_streams });
+               ["xmlns:stream"] = xmlns_streams });
        
 
        if reason then
@@ -198,7 +209,6 @@ local function bosh_close_stream(session, reason)
 
        local session_close_response = { headers = default_headers, body = tostring(close_reply) };
 
-       --FIXME: Quite sure we shouldn't reply to all requests with the error
        for _, held_request in ipairs(session.requests) do
                held_request:send(session_close_response);
                held_request:destroy();
@@ -208,8 +218,8 @@ local function bosh_close_stream(session, reason)
 end
 
 function stream_callbacks.streamopened(request, attr)
-       log("debug", "BOSH body open (sid: %s)", attr.sid);
-       local sid = attr.sid
+       local sid = attr.sid;
+       log("debug", "BOSH body open (sid: %s)", sid or "<none>");
        if not sid then
                -- New session request
                request.notopen = nil; -- Signals that we accept this opening tag
@@ -218,9 +228,9 @@ function stream_callbacks.streamopened(request, attr)
                if not hosts[attr.to] then
                        -- Unknown host
                        log("debug", "BOSH client tried to connect to unknown host: %s", tostring(attr.to));
-                       session_close_reply.body.attr.condition = "host-unknown";
-                       request:send(session_close_reply);
-                       request.notopen = nil
+                       local close_reply = st.stanza("body", { xmlns = xmlns_bosh, type = "terminate",
+                               ["xmlns:stream"] = xmlns_streams, condition = "host-unknown" });
+                       request:send(tostring(close_reply));
                        return;
                end
                
@@ -251,7 +261,13 @@ function stream_callbacks.streamopened(request, attr)
                        local oldest_request = r[1];
                        if oldest_request then
                                log("debug", "We have an open request, so sending on that");
-                               response.body = t_concat{"<body xmlns='http://jabber.org/protocol/httpbind' sid='", sid, "' xmlns:stream = 'http://etherx.jabber.org/streams'>", tostring(s), "</body>" };
+                               response.body = t_concat({
+                                       "<body xmlns='http://jabber.org/protocol/httpbind' ",
+                                       session.bosh_terminate and "type='terminate' " or "",
+                                       "sid='", sid, "' xmlns:stream = 'http://etherx.jabber.org/streams'>",
+                                       tostring(s),
+                                       "</body>"
+                               });
                                oldest_request:send(response);
                                --log("debug", "Sent");
                                if oldest_request.stayopen then
@@ -270,6 +286,7 @@ function stream_callbacks.streamopened(request, attr)
                                t_insert(session.send_buffer, tostring(s));
                                log("debug", "There are now %d things in the send_buffer", #session.send_buffer);
                        end
+                       return true;
                end
                
                -- Send creation response
@@ -279,9 +296,17 @@ function stream_callbacks.streamopened(request, attr)
                fire_event("stream-features", session, features);
                --xmpp:version='1.0' xmlns:xmpp='urn:xmpp:xbosh'
                local response = st.stanza("body", { xmlns = xmlns_bosh,
-                                                                       inactivity = tostring(BOSH_DEFAULT_INACTIVITY), polling = tostring(BOSH_DEFAULT_POLLING), requests = tostring(BOSH_DEFAULT_REQUESTS), hold = tostring(session.bosh_hold), maxpause = "120",
-                                                                       sid = sid, authid = sid, ver  = '1.6', from = session.host, secure = 'true', ["xmpp:version"] = "1.0",
-                                                                       ["xmlns:xmpp"] = "urn:xmpp:xbosh", ["xmlns:stream"] = "http://etherx.jabber.org/streams" }):add_child(features);
+                       wait = attr.wait,
+                       inactivity = tostring(BOSH_DEFAULT_INACTIVITY),
+                       polling = tostring(BOSH_DEFAULT_POLLING),
+                       requests = tostring(BOSH_DEFAULT_REQUESTS),
+                       hold = tostring(session.bosh_hold),
+                       sid = sid, authid = sid,
+                       ver  = '1.6', from = session.host,
+                       secure = 'true', ["xmpp:version"] = "1.0",
+                       ["xmlns:xmpp"] = "urn:xmpp:xbosh",
+                       ["xmlns:stream"] = "http://etherx.jabber.org/streams"
+               }):add_child(features);
                request:send{ headers = default_headers, body = tostring(response) };
                
                request.sid = sid;
@@ -314,13 +339,6 @@ function stream_callbacks.streamopened(request, attr)
                session.rid = rid;
        end
        
-       if attr.type == "terminate" then
-               -- Client wants to end this session
-               session:close();
-               request.notopen = nil;
-               return;
-       end
-       
        if session.notopen then
                local features = st.stanza("stream:features");
                hosts[session.host].events.fire_event("stream-features", { origin = session, features = features });
@@ -329,6 +347,12 @@ function stream_callbacks.streamopened(request, attr)
                session.notopen = nil;
        end
        
+       if attr.type == "terminate" then
+               -- Client wants to end this session, which we'll do
+               -- after processing any stanzas in this request
+               session.bosh_terminate = true;
+       end
+
        request.notopen = nil; -- Signals that we accept this opening tag
        t_insert(session.requests, request);
        request.sid = sid;
@@ -379,17 +403,13 @@ function on_timer()
        
        now = now - 3;
        local n_dead_sessions = 0;
-       for session, inactive_since in pairs(inactive_sessions) do
-               if session.bosh_max_inactive then
-                       if now - inactive_since > session.bosh_max_inactive then
-                               (session.log or log)("debug", "BOSH client inactive too long, destroying session at %d", now);
-                               sessions[session.sid]  = nil;
-                               inactive_sessions[session] = nil;
-                               n_dead_sessions = n_dead_sessions + 1;
-                               dead_sessions[n_dead_sessions] = session;
-                       end
-               else
+       for session, close_after in pairs(inactive_sessions) do
+               if close_after < now then
+                       (session.log or log)("debug", "BOSH client inactive too long, destroying session at %d", now);
+                       sessions[session.sid]  = nil;
                        inactive_sessions[session] = nil;
+                       n_dead_sessions = n_dead_sessions + 1;
+                       dead_sessions[n_dead_sessions] = session;
                end
        end
 
@@ -398,13 +418,14 @@ function on_timer()
                dead_sessions[i] = nil;
                sm_destroy_session(session, "BOSH client silent for over "..session.bosh_max_inactive.." seconds");
        end
+       return 1;
 end
 
 
 local function setup()
-       local ports = module:get_option("bosh_ports") or { 5280 };
+       local ports = module:get_option_array("bosh_ports") or { 5280 };
        httpserver.new_from_config(ports, handle_request, { base = "http-bind" });
-       server.addtimer(on_timer);
+       timer.add_task(1, on_timer);
 end
 if prosody.start_time then -- already started
        setup();