Merge 0.7->trunk
[prosody.git] / plugins / mod_bosh.lua
index 653af8bbdbfb419a5c2d7f6fca59fcc3b5a3a3f3..66a79785dea936ba77779028c768039ccdb8fcb0 100644 (file)
@@ -1,3 +1,10 @@
+-- Prosody IM
+-- Copyright (C) 2008-2010 Matthew Wild
+-- Copyright (C) 2008-2010 Waqas Hussain
+-- 
+-- This project is MIT/X11 licensed. Please see the
+-- COPYING file in the source package for more information.
+--
 
 module.host = "*" -- Global module
 
@@ -12,18 +19,38 @@ local new_uuid = require "util.uuid".generate;
 local fire_event = require "core.eventmanager".fire_event;
 local core_process_stanza = core_process_stanza;
 local st = require "util.stanza";
-local log = require "util.logger".init("bosh");
-local stream_callbacks = { stream_tag = "http://jabber.org/protocol/httpbind|body" };
-local config = require "core.configmanager";
+local logger = require "util.logger";
+local log = logger.init("mod_bosh");
+
 local xmlns_bosh = "http://jabber.org/protocol/httpbind"; -- (hard-coded into a literal in session.send)
+local stream_callbacks = { stream_ns = "http://jabber.org/protocol/httpbind", 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 = tonumber(config.get("*", "core", "bosh_default_hold")) or 1;
-local BOSH_DEFAULT_INACTIVITY = tonumber(config.get("*", "core", "bosh_max_inactivity")) or 60;
-local BOSH_DEFAULT_POLLING = tonumber(config.get("*", "core", "bosh_max_polling")) or 5;
-local BOSH_DEFAULT_REQUESTS = tonumber(config.get("*", "core", "bosh_max_requests")) or 2;
-local BOSH_DEFAULT_MAXPAUSE = tonumber(config.get("*", "core", "bosh_max_pause")) or 300;
+local consider_bosh_secure = module:get_option_boolean("consider_bosh_secure");
 
 local default_headers = { ["Content-Type"] = "text/xml; charset=utf-8" };
+local session_close_reply = { headers = default_headers, body = st.stanza("body", { xmlns = xmlns_bosh, type = "terminate" }), attr = {} };
+
+local cross_domain = module:get_option("cross_domain_bosh");
+if cross_domain then
+       default_headers["Access-Control-Allow-Methods"] = "GET, POST, OPTIONS";
+       default_headers["Access-Control-Allow-Headers"] = "Content-Type";
+       default_headers["Access-Control-Max-Age"] = "7200";
+
+       if cross_domain == true then
+               default_headers["Access-Control-Allow-Origin"] = "*";
+       elseif type(cross_domain) == "table" then
+               cross_domain = table.concat(cross_domain, ", ");
+       end
+       if type(cross_domain) == "string" then
+               default_headers["Access-Control-Allow-Origin"] = cross_domain;
+       end
+end
 
 local t_insert, t_remove, t_concat = table.insert, table.remove, table.concat;
 local os_time = os.time;
@@ -38,8 +65,11 @@ function on_destroy_request(request)
        local session = sessions[request.sid];
        if session then
                local requests = session.requests;
-               for i,r in pairs(requests) do
-                       if r == request then requests[i] = nil; break; end
+               for i,r in ipairs(requests) do
+                       if r == request then
+                               t_remove(requests, i);
+                               break;
+                       end
                end
                
                -- If this session now has no requests open, mark it as inactive
@@ -52,16 +82,22 @@ end
 
 function handle_request(method, body, request)
        if (not body) or request.method ~= "POST" then
-               return "<html><body>You really don't look like a BOSH client to me... what do you want?</body></html>";
+               if request.method == "OPTIONS" then
+                       return { headers = default_headers, body = "" };
+               else
+                       return "<html><body>You really don't look like a BOSH client to me... what do you want?</body></html>";
+               end
        end
-       if not method then 
+       if not method then
                log("debug", "Request %s suffered error %s", tostring(request.id), body);
                return;
        end
        --log("debug", "Handling new request %s: %s\n----------", request.id, tostring(body));
        request.notopen = true;
        request.log = log;
-       local parser = lxp.new(init_xmlhandlers(request, stream_callbacks), "|");
+       request.on_destroy = on_destroy_request;
+       
+       local parser = lxp.new(init_xmlhandlers(request, stream_callbacks), "\1");
        
        parser:parse(body);
        
@@ -89,25 +125,30 @@ function handle_request(method, body, request)
                        session.send(resp);
                end
                
-               if not request.destroyed and session.bosh_wait then
-                       request.reply_before = os_time() + session.bosh_wait;
-                       request.on_destroy = on_destroy_request;
-                       waiting_requests[request] = true;
+               if not request.destroyed then
+                       -- We're keeping this request open, to respond later
+                       log("debug", "Have nothing to say, so leaving request unanswered for now");
+                       if session.bosh_wait then
+                               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
                
-               log("debug", "Have nothing to say, so leaving request unanswered for now");
-               return true;
+               return true; -- Inform httpserver we shall reply later
        end
 end
 
 
 local function bosh_reset_stream(session) session.notopen = true; end
 
-local session_close_reply = { headers = default_headers, body = st.stanza("body", { xmlns = xmlns_bosh, type = "terminate" }), attr = {} };
 local function bosh_close_stream(session, reason)
        (session.log or log)("info", "BOSH client disconnected");
        session_close_reply.attr.condition = reason;
-       local session_close_reply = tostring(session_close_reply);
        for _, held_request in ipairs(session.requests) do
                held_request:send(session_close_reply);
                held_request:destroy();
@@ -127,31 +168,32 @@ 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.attr.condition = "host-unknown";
-                       request:send{ headers = default_headers, body = tostring(session_close_reply) };
+                       session_close_reply.body.attr.condition = "host-unknown";
+                       request:send(session_close_reply);
                        request.notopen = nil
                        return;
                end
                
                -- New session
                sid = new_uuid();
-               local session = { type = "c2s_unauthed", conn = {}, sid = sid, rid = attr.rid, host = attr.to, bosh_version = attr.ver, bosh_wait = attr.wait, streamid = sid, 
-                                               bosh_hold = BOSH_DEFAULT_HOLD, bosh_max_inactive = BOSH_DEFAULT_INACTIVITY,
-                                               requests = { }, send_buffer = {}, reset_stream = bosh_reset_stream, close = bosh_close_stream, dispatch_stanza = core_process_stanza };
+               local session = {
+                       type = "c2s_unauthed", conn = {}, sid = sid, rid = tonumber(attr.rid)-1, host = attr.to,
+                       bosh_version = attr.ver, bosh_wait = attr.wait, streamid = sid,
+                       bosh_hold = BOSH_DEFAULT_HOLD, bosh_max_inactive = BOSH_DEFAULT_INACTIVITY,
+                       requests = { }, send_buffer = {}, reset_stream = bosh_reset_stream,
+                       close = bosh_close_stream, dispatch_stanza = core_process_stanza,
+                       log = logger.init("bosh"..sid), secure = consider_bosh_secure or request.secure
+               };
                sessions[sid] = session;
+               
                log("info", "New BOSH session, assigned it sid '%s'", sid);
                local r, send_buffer = session.requests, session.send_buffer;
                local response = { headers = default_headers }
                function session.send(s)
-                       log("debug", "Sending BOSH data: %s", tostring(s));
+                       --log("debug", "Sending BOSH data: %s", tostring(s));
                        local oldest_request = r[1];
-                       while oldest_request and oldest_request.destroyed do
-                               t_remove(r, 1);
-                               waiting_requests[oldest_request] = nil;
-                               oldest_request = r[1];
-                       end
                        if oldest_request then
-                               log("debug", "We have an open request, so using that to send with");
+                               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>" };
                                oldest_request:send(response);
                                --log("debug", "Sent");
@@ -164,7 +206,6 @@ function stream_callbacks.streamopened(request, attr)
                                else
                                        log("debug", "Destroying the request now...");
                                        oldest_request:destroy();
-                                       t_remove(r, 1);
                                end
                        elseif s ~= "" then
                                log("debug", "Saved to send buffer because there are %d open requests", #r);
@@ -177,14 +218,15 @@ function stream_callbacks.streamopened(request, attr)
                -- Send creation response
                
                local features = st.stanza("stream:features");
+               hosts[session.host].events.fire_event("stream-features", { origin = session, features = features });
                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", 
+               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);
                request:send{ headers = default_headers, body = tostring(response) };
-                               
+               
                request.sid = sid;
                return;
        end
@@ -198,6 +240,22 @@ function stream_callbacks.streamopened(request, attr)
                return;
        end
        
+       if session.rid then
+               local rid = tonumber(attr.rid);
+               local diff = rid - session.rid;
+               if diff > 1 then
+                       session.log("warn", "rid too large (means a request was lost). Last rid: %d New rid: %s", session.rid, attr.rid);
+               elseif diff <= 0 then
+                       -- Repeated, ignore
+                       session.log("debug", "rid repeated (on request %s), ignoring: %s (diff %d)", request.id, session.rid, diff);
+                       request.notopen = nil;
+                       request.sid = sid;
+                       t_insert(session.requests, request);
+                       return;
+               end
+               session.rid = rid;
+       end
+       
        if attr.type == "terminate" then
                -- Client wants to end this session
                session:close();
@@ -205,14 +263,9 @@ function stream_callbacks.streamopened(request, attr)
                return;
        end
        
-       -- If session was inactive, make sure it is now marked as not
-       if #session.requests == 0 then
-               (session.log or log)("debug", "BOSH client now active again at %d", os_time());
-               inactive_sessions[session] = nil;
-       end
-       
        if session.notopen then
                local features = st.stanza("stream:features");
+               hosts[session.host].events.fire_event("stream-features", { origin = session, features = features });
                fire_event("stream-features", session, features);
                session.send(features);
                session.notopen = nil;
@@ -228,12 +281,14 @@ function stream_callbacks.handlestanza(request, stanza)
        local session = sessions[request.sid];
        if session then
                if stanza.attr.xmlns == xmlns_bosh then
-                       stanza.attr.xmlns = "jabber:client";
+                       stanza.attr.xmlns = nil;
                end
+               session.ip = request.handler:ip();
                core_process_stanza(session, stanza);
        end
 end
 
+local dead_sessions = {};
 function on_timer()
        -- log("debug", "Checking for requests soon to timeout...");
        -- Identify requests timing out within the next few seconds
@@ -250,31 +305,36 @@ function on_timer()
        end
        
        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;
-                               sm_destroy_session(session, "BOSH client silent for over "..session.bosh_max_inactive.." seconds");
+                               n_dead_sessions = n_dead_sessions + 1;
+                               dead_sessions[n_dead_sessions] = session;
                        end
                else
                        inactive_sessions[session] = nil;
                end
        end
-end
 
-local ports = config.get(module.host, "core", "bosh_ports") or { 5280 };
-for _, options in ipairs(ports) do
-       local port, base, ssl, interface = 5280, "http-bind", false, nil;
-       if type(options) == "number" then
-               port = options;
-       elseif type(options) == "table" then
-               port, base, ssl, interface = options.port or 5280, options.path or "http-bind", options.ssl or false, options.interface;
-       elseif type(options) == "string" then
-               base = options;
+       for i=1,n_dead_sessions do
+               local session = dead_sessions[i];
+               dead_sessions[i] = nil;
+               sm_destroy_session(session, "BOSH client silent for over "..session.bosh_max_inactive.." seconds");
        end
-       httpserver.new{ port = port, base = base, handler = handle_request, ssl = ssl }
 end
 
-server.addtimer(on_timer);
+
+local function setup()
+       local ports = module:get_option("bosh_ports") or { 5280 };
+       httpserver.new_from_config(ports, handle_request, { base = "http-bind" });
+       server.addtimer(on_timer);
+end
+if prosody.start_time then -- already started
+       setup();
+else
+       prosody.events.add_handler("server-started", setup);
+end