net/server_event: pcall require ssl rather than relying on globals
[prosody.git] / net / server_event.lua
index c4aa7be4dd526997e36656e7de4ac49d1233ec94..7575044a8563778f4b388036d5cd2380596deca4 100644 (file)
@@ -44,7 +44,7 @@ local setmetatable = use "setmetatable"
 local t_insert = table.insert
 local t_concat = table.concat
 
-local ssl = use "ssl"
+local has_luasec, ssl = pcall ( require , "ssl" )
 local socket = use "socket" or require "socket"
 
 local log = require ("util.logger").init("socket")
@@ -115,10 +115,10 @@ end )( )
 local interface_mt
 do
        interface_mt = {}; interface_mt.__index = interface_mt;
-       
+
        local addevent = base.addevent
        local coroutine_wrap, coroutine_yield = coroutine.wrap,coroutine.yield
-       
+
        -- Private methods
        function interface_mt:_position(new_position)
                        self.position = new_position or self.position
@@ -127,7 +127,7 @@ do
        function interface_mt:_close()
                return self:_destroy();
        end
-       
+
        function interface_mt:_start_connection(plainssl) -- should be called from addclient
                        local callback = function( event )
                                if EV_TIMEOUT == event then  -- timeout during connection
@@ -136,7 +136,7 @@ do
                                        self:_close()
                                        debug( "new connection failed. id:", self.id, "error:", self.fatalerror )
                                else
-                                       if plainssl and ssl then  -- start ssl session
+                                       if plainssl and has_luasec then  -- start ssl session
                                                self:starttls(self._sslctx, true)
                                        else  -- normal connection
                                                self:_start_session(true)
@@ -268,12 +268,12 @@ do
                        interfacelist( "delete", self )
                        return true
        end
-       
+
        function interface_mt:_lock(nointerface, noreading, nowriting)  -- lock or unlock this interface or events
                        self.nointerface, self.noreading, self.nowriting = nointerface, noreading, nowriting
                        return nointerface, noreading, nowriting
        end
-       
+
        --TODO: Deprecate
        function interface_mt:lock_read(switch)
                if switch then
@@ -300,7 +300,7 @@ do
                end
                return self._connections
        end
-       
+
        -- Public methods
        function interface_mt:write(data)
                if self.nowriting then return nil, "locked" end
@@ -343,43 +343,44 @@ do
                        return true
                end
        end
-       
+
        function interface_mt:socket()
                return self.conn
        end
-       
+
        function interface_mt:server()
                return self._server or self;
        end
-       
-       function interface_mt:clientport()
+
+       function interface_mt:port()
                return self._port
        end
-       
+
        function interface_mt:serverport()
                return self._serverport
        end
-       
+
        function interface_mt:ip()
                return self._ip
        end
-       
+
        function interface_mt:ssl()
                return self._usingssl
        end
+       interface_mt.clientport = interface_mt.port -- COMPAT server_select
 
        function interface_mt:type()
                return self._type or "client"
        end
-       
+
        function interface_mt:connections()
                return self._connections
        end
-       
+
        function interface_mt:address()
                return self.addr
        end
-       
+
        function interface_mt:set_sslctx(sslctx)
                self._sslctx = sslctx;
                if sslctx then
@@ -395,11 +396,11 @@ do
                end
                return self._pattern;
        end
-       
+
        function interface_mt:set_send(new_send)
                -- No-op, we always use the underlying connection's send
        end
-       
+
        function interface_mt:starttls(sslctx, call_onconnect)
                debug( "try to start ssl at client id:", self.id )
                local err
@@ -428,19 +429,22 @@ do
                self.starttls = false;
                return true
        end
-       
+
        function interface_mt:setoption(option, value)
                if self.conn.setoption then
                        return self.conn:setoption(option, value);
                end
                return false, "setoption not implemented";
        end
-       
+
        function interface_mt:setlistener(listener)
-               self.onconnect, self.ondisconnect, self.onincoming, self.ontimeout, self.onstatus
-                       = listener.onconnect, listener.ondisconnect, listener.onincoming, listener.ontimeout, listener.onstatus;
+               self:ondetach(); -- Notify listener that it is no longer responsible for this connection
+               self.onconnect, self.ondisconnect, self.onincoming, self.ontimeout,
+               self.onreadtimeout, self.onstatus, self.ondetach
+                       = listener.onconnect, listener.ondisconnect, listener.onincoming, listener.ontimeout,
+                         listener.onreadtimeout, listener.onstatus, listener.ondetach;
        end
-       
+
        -- Stub handlers
        function interface_mt:onconnect()
        end
@@ -450,8 +454,16 @@ do
        end
        function interface_mt:ontimeout()
        end
+       function interface_mt:onreadtimeout()
+               self.fatalerror = "timeout during receiving"
+               debug( "connection failed:", self.fatalerror )
+               self:_close()
+               self.eventread = nil
+       end
        function interface_mt:ondrain()
        end
+       function interface_mt:ondetach()
+       end
        function interface_mt:onstatus()
        end
 end
@@ -477,7 +489,9 @@ do
                        ondisconnect = listener.ondisconnect;  -- will be called when client disconnects
                        onincoming = listener.onincoming;  -- will be called when client sends data
                        ontimeout = listener.ontimeout; -- called when fatal socket timeout occurs
+                       onreadtimeout = listener.onreadtimeout; -- called when socket inactivity timeout occurs
                        ondrain = listener.ondrain; -- called when writebuffer is empty
+                       ondetach = listener.ondetach; -- called when disassociating this listener from this connection
                        onstatus = listener.onstatus; -- called for status changes (e.g. of SSL/TLS)
                        eventread = false, eventwrite = false, eventclose = false,
                        eventhandshake = false, eventstarthandshake = false;  -- event handler
@@ -491,14 +505,14 @@ do
                        noreading = false, nowriting = false;  -- locks of the read/writecallback
                        startsslcallback = false;  -- starting handshake callback
                        position = false;  -- position of client in interfacelist
-                       
+
                        -- Properties
                        _ip = ip, _port = port, _server = server, _pattern = pattern,
                        _serverport = (server and server:port() or nil),
                        _sslctx = sslctx; -- parameters
                        _usingssl = false;  -- client is using ssl;
                }
-               if not ssl then interface.starttls = false; end
+               if not has_luasec then interface.starttls = false; end
                interface.id = tostring(interface):match("%x+$");
                interface.writecallback = function( event )  -- called on write events
                        --vdebug( "new client write event, id/ip/port:", interface, ip, port )
@@ -567,7 +581,7 @@ do
                                end
                        end
                end
-               
+
                interface.readcallback = function( event )  -- called on read events
                        --vdebug( "new client read event, id/ip/port:", tostring(interface.id), tostring(ip), tostring(port) )
                        if interface.noreading or interface.fatalerror then  -- leave this event
@@ -575,61 +589,56 @@ do
                                interface.eventread = nil
                                return -1
                        end
-                       if EV_TIMEOUT == event then  -- took too long to get some data from client -> disconnect
-                               interface.fatalerror = "timeout during receiving"
-                               debug( "connection failed:", interface.fatalerror )
+                       if EV_TIMEOUT == event and interface:onreadtimeout() ~= true then
+                               return -1 -- took too long to get some data from client -> disconnect
+                       end
+                       if interface._usingssl then  -- handle luasec
+                               if interface.eventwritetimeout then  -- ok, in the past writecallback was regged
+                                       local ret = interface.writecallback( )  -- call it
+                                       --vdebug( "tried to write in readcallback, result:", tostring(ret) )
+                               end
+                               if interface.eventreadtimeout then
+                                       interface.eventreadtimeout:close( )
+                                       interface.eventreadtimeout = nil
+                               end
+                       end
+                       local buffer, err, part = interface.conn:receive( interface._pattern )  -- receive buffer with "pattern"
+                       --vdebug( "read data:", tostring(buffer), "error:", tostring(err), "part:", tostring(part) )
+                       buffer = buffer or part
+                       if buffer and #buffer > cfg.MAX_READ_LENGTH then  -- check buffer length
+                               interface.fatalerror = "receive buffer exceeded"
+                               debug( "fatal error:", interface.fatalerror )
                                interface:_close()
                                interface.eventread = nil
                                return -1
-                       else -- can read
-                               if interface._usingssl then  -- handle luasec
-                                       if interface.eventwritetimeout then  -- ok, in the past writecallback was regged
-                                               local ret = interface.writecallback( )  -- call it
-                                               --vdebug( "tried to write in readcallback, result:", tostring(ret) )
-                                       end
-                                       if interface.eventreadtimeout then
-                                               interface.eventreadtimeout:close( )
-                                               interface.eventreadtimeout = nil
+                       end
+                       if err and ( err ~= "timeout" and err ~= "wantread" ) then
+                               if "wantwrite" == err then -- need to read on write event
+                                       if not interface.eventwrite then  -- register new write event if needed
+                                               interface.eventwrite = addevent( base, interface.conn, EV_WRITE, interface.writecallback, cfg.WRITE_TIMEOUT )
                                        end
-                               end
-                               local buffer, err, part = interface.conn:receive( interface._pattern )  -- receive buffer with "pattern"
-                               --vdebug( "read data:", tostring(buffer), "error:", tostring(err), "part:", tostring(part) )
-                               buffer = buffer or part
-                               if buffer and #buffer > cfg.MAX_READ_LENGTH then  -- check buffer length
-                                       interface.fatalerror = "receive buffer exceeded"
-                                       debug( "fatal error:", interface.fatalerror )
+                                       interface.eventreadtimeout = addevent( base, nil, EV_TIMEOUT,
+                                               function( )
+                                                       interface:_close()
+                                               end, cfg.READ_TIMEOUT
+                                       )
+                                       debug( "wantwrite during read attempt, reg it in writecallback but dont know what really happens next..." )
+                                       -- to be honest i dont know what happens next, if it is allowed to first read, the write etc...
+                               else  -- connection was closed or fatal error
+                                       interface.fatalerror = err
+                                       debug( "connection failed in read event:", interface.fatalerror )
                                        interface:_close()
                                        interface.eventread = nil
                                        return -1
                                end
-                               if err and ( err ~= "timeout" and err ~= "wantread" ) then
-                                       if "wantwrite" == err then -- need to read on write event
-                                               if not interface.eventwrite then  -- register new write event if needed
-                                                       interface.eventwrite = addevent( base, interface.conn, EV_WRITE, interface.writecallback, cfg.WRITE_TIMEOUT )
-                                               end
-                                               interface.eventreadtimeout = addevent( base, nil, EV_TIMEOUT,
-                                                       function( )
-                                                               interface:_close()
-                                                       end, cfg.READ_TIMEOUT
-                                               )
-                                               debug( "wantwrite during read attempt, reg it in writecallback but dont know what really happens next..." )
-                                               -- to be honest i dont know what happens next, if it is allowed to first read, the write etc...
-                                       else  -- connection was closed or fatal error
-                                               interface.fatalerror = err
-                                               debug( "connection failed in read event:", interface.fatalerror )
-                                               interface:_close()
-                                               interface.eventread = nil
-                                               return -1
-                                       end
-                               else
-                                       interface.onincoming( interface, buffer, err )  -- send new data to listener
-                               end
-                               if interface.noreading then
-                                       interface.eventread = nil;
-                                       return -1;
-                               end
-                               return EV_READ, cfg.READ_TIMEOUT
+                       else
+                               interface.onincoming( interface, buffer, err )  -- send new data to listener
                        end
+                       if interface.noreading then
+                               interface.eventread = nil;
+                               return -1;
+                       end
+                       return EV_READ, cfg.READ_TIMEOUT
                end
 
                client:settimeout( 0 )  -- set non blocking
@@ -645,7 +654,7 @@ do
                debug "creating server interface..."
                local interface = {
                        _connections = 0;
-                       
+
                        conn = server;
                        onconnect = listener.onconnect;  -- will be called when new client connected
                        eventread = false;  -- read event handler
@@ -653,7 +662,7 @@ do
                        readcallback = false; -- read event callback
                        fatalerror = false; -- error message
                        nointerface = true;  -- lock/unlock parameter
-                       
+
                        _ip = addr, _port = port, _pattern = pattern,
                        _sslctx = sslctx;
                }
@@ -686,18 +695,18 @@ do
                                interface._connections = interface._connections + 1  -- increase connection count
                                local clientinterface = handleclient( client, client_ip, client_port, interface, pattern, listener, sslctx )
                                --vdebug( "client id:", clientinterface, "startssl:", startssl )
-                               if ssl and sslctx then
+                               if has_luasec and sslctx then
                                        clientinterface:starttls(sslctx, true)
                                else
                                        clientinterface:_start_session( true )
                                end
                                debug( "accepted incoming client connection from:", client_ip or "<unknown IP>", client_port or "<unknown port>", "to", port or "<unknown port>");
-                               
+
                                client, err = server:accept()    -- try to accept again
                        end
                        return EV_READ
                end
-               
+
                server:settimeout( 0 )
                setmetatable(interface, interface_mt)
                interfacelist( "add", interface )
@@ -707,25 +716,17 @@ do
 end
 
 local addserver = ( function( )
-       return function( addr, port, listener, pattern, sslcfg, startssl )  -- TODO: check arguments
-               --vdebug( "creating new tcp server with following parameters:", addr or "nil", port or "nil", sslcfg or "nil", startssl or "nil")
+       return function( addr, port, listener, pattern, sslctx, startssl )  -- TODO: check arguments
+               --vdebug( "creating new tcp server with following parameters:", addr or "nil", port or "nil", sslctx or "nil", startssl or "nil")
+               if sslctx and not has_luasec then
+                       debug "fatal error: luasec not found"
+                       return nil, "luasec not found"
+               end
                local server, err = socket.bind( addr, port, cfg.ACCEPT_QUEUE )  -- create server socket
                if not server then
                        debug( "creating server socket on "..addr.." port "..port.." failed:", err )
                        return nil, err
                end
-               local sslctx
-               if sslcfg then
-                       if not ssl then
-                               debug "fatal error: luasec not found"
-                               return nil, "luasec not found"
-                       end
-                       sslctx, err = sslcfg
-                       if err then
-                               debug( "error while creating new ssl context for server socket:", err )
-                               return nil, err
-                       end
-               end
                local interface = handleserver( server, addr, port, pattern, listener, sslctx, startssl )  -- new server handler
                debug( "new server created with id:", tostring(interface))
                return interface
@@ -740,37 +741,22 @@ do
                return interface, client
                --function handleclient( client, ip, port, server, pattern, listener, _, sslctx )  -- creates an client interface
        end
-       
-       function addclient( addr, serverport, listener, pattern, localaddr, localport, sslcfg, startssl )
+
+       function addclient( addr, serverport, listener, pattern, sslctx )
+               if sslctx and not has_luasec then
+                       debug "need luasec, but not available"
+                       return nil, "luasec not found"
+               end
                local client, err = socket.tcp()  -- creating new socket
                if not client then
                        debug( "cannot create socket:", err )
                        return nil, err
                end
                client:settimeout( 0 )  -- set nonblocking
-               if localaddr then
-                       local res, err = client:bind( localaddr, localport, -1 )
-                       if not res then
-                               debug( "cannot bind client:", err )
-                               return nil, err
-                       end
-               end
-               local sslctx
-               if sslcfg then  -- handle ssl/new context
-                       if not ssl then
-                               debug "need luasec, but not available"
-                               return nil, "luasec not found"
-                       end
-                       sslctx, err = sslcfg
-                       if err then
-                               debug( "cannot create new ssl context:", err )
-                               return nil, err
-                       end
-               end
                local res, err = client:connect( addr, serverport )  -- connect
                if res or ( err == "timeout" ) then
                        local ip, port = client:getsockname( )
-                       local interface = wrapclient( client, ip, serverport, listener, pattern, sslctx, startssl )
+                       local interface = wrapclient( client, ip, serverport, listener, pattern, sslctx )
                        interface:_start_connection( startssl )
                        debug( "new connection id:", interface.id )
                        return interface, err
@@ -831,14 +817,14 @@ end
 
 local function link(sender, receiver, buffersize)
        local sender_locked;
-       
+
        function receiver:ondrain()
                if sender_locked then
                        sender:resume();
                        sender_locked = nil;
                end
        end
-       
+
        function sender:onincoming(data)
                receiver:write(data);
                if receiver.writebufferlen >= buffersize then
@@ -846,6 +832,7 @@ local function link(sender, receiver, buffersize)
                        sender:pause();
                end
        end
+       sender:set_mode("*a");
 end
 
 return {