2 -- server.lua by blastbeat of the luadch project
3 -- Re-used here under the MIT/X Consortium License
5 -- Modifications (C) 2008-2010 Matthew Wild, Waqas Hussain
8 -- // wrapping luadch stuff // --
10 local use = function( what )
14 local log, table_concat = require ("util.logger").init("socket"), table.concat;
15 local out_put = function (...) return log("debug", table_concat{...}); end
16 local out_error = function (...) return log("warn", table_concat{...}); end
18 ----------------------------------// DECLARATION //--
22 local STAT_UNIT = 1 -- byte
24 --// lua functions //--
26 local type = use "type"
27 local pairs = use "pairs"
28 local ipairs = use "ipairs"
29 local tonumber = use "tonumber"
30 local tostring = use "tostring"
35 local table = use "table"
36 local string = use "string"
37 local coroutine = use "coroutine"
39 --// lua lib methods //--
41 local os_difftime = os.difftime
42 local math_min = math.min
43 local math_huge = math.huge
44 local table_concat = table.concat
45 local string_sub = string.sub
46 local coroutine_wrap = coroutine.wrap
47 local coroutine_yield = coroutine.yield
51 local luasec = use "ssl"
52 local luasocket = use "socket" or require "socket"
53 local luasocket_gettime = luasocket.gettime
55 --// extern lib methods //--
57 local ssl_wrap = ( luasec and luasec.wrap )
58 local socket_bind = luasocket.bind
59 local socket_sleep = luasocket.sleep
60 local socket_select = luasocket.select
92 --// simple data types //--
120 local _maxsslhandshake
122 ----------------------------------// DEFINITION //--
124 _server = { } -- key = port, value = table; list of listening servers
125 _readlist = { } -- array with sockets to read from
126 _sendlist = { } -- arrary with sockets to write to
127 _timerlist = { } -- array of timer functions
128 _socketlist = { } -- key = socket, value = wrapped socket (handlers)
129 _readtimes = { } -- key = handler, value = timestamp of last data reading
130 _writetimes = { } -- key = handler, value = timestamp of last data writing/sending
131 _closelist = { } -- handlers to close
133 _readlistlen = 0 -- length of readlist
134 _sendlistlen = 0 -- length of sendlist
135 _timerlistlen = 0 -- lenght of timerlist
137 _sendtraffic = 0 -- some stats
140 _selecttimeout = 1 -- timeout of socket.select
141 _sleeptime = 0 -- time to wait at the end of every loop
143 _maxsendlen = 51000 * 1024 -- max len of send buffer
144 _maxreadlen = 25000 * 1024 -- max len of read buffer
146 _checkinterval = 1200000 -- interval in secs to check idle clients
147 _sendtimeout = 60000 -- allowed send idle time in secs
148 _readtimeout = 6 * 60 * 60 -- allowed read idle time in secs
150 _maxfd = luasocket._SETSIZE or 1024 -- We should ignore this on Windows. Perhaps by simply setting it to math.huge or something.
151 _maxselectlen = luasocket._SETSIZE or 1024 -- But this still applies on Windows
153 _maxsslhandshake = 30 -- max handshake round-trips
155 ----------------------------------// PRIVATE //--
157 wrapserver = function( listeners, socket, ip, serverport, pattern, sslctx ) -- this function wraps a server -- FIXME Make sure FD < _maxfd
159 if socket:getfd() >= _maxfd then
160 out_error("server.lua: Disallowed FD number: "..socket:getfd())
162 return nil, "fd-too-large"
165 local connections = 0
167 local dispatch, disconnect = listeners.onconnect, listeners.ondisconnect
169 local accept = socket.accept
171 --// public methods of the object //--
175 handler.shutdown = function( ) end
177 handler.ssl = function( )
180 handler.sslctx = function( )
183 handler.remove = function( )
184 connections = connections - 1
189 handler.close = function()
191 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
192 _readlistlen = removesocket( _readlist, socket, _readlistlen )
193 _server[ip..":"..serverport] = nil;
194 _socketlist[ socket ] = nil
198 out_put "server.lua: closed server handler and removed sockets from list"
200 handler.pause = function( hard )
201 if not handler.paused then
202 _readlistlen = removesocket( _readlist, socket, _readlistlen )
204 _socketlist[ socket ] = nil
208 handler.paused = true;
211 handler.resume = function( )
212 if handler.paused then
214 socket = socket_bind( ip, serverport );
215 socket:settimeout( 0 )
217 _readlistlen = addsocket(_readlist, socket, _readlistlen)
218 _socketlist[ socket ] = handler
219 handler.paused = false;
222 handler.ip = function( )
225 handler.serverport = function( )
228 handler.socket = function( )
231 handler.readbuffer = function( )
232 if _readlistlen >= _maxselectlen or _sendlistlen >= _maxselectlen then
234 out_put( "server.lua: refused new client connection: server full" )
237 local client, err = accept( socket ) -- try to accept
239 local ip, clientport = client:getpeername( )
240 local handler, client, err = wrapconnection( handler, listeners, client, ip, serverport, clientport, pattern, sslctx ) -- wrap new client socket
241 if err then -- error while wrapping ssl socket
244 connections = connections + 1
245 out_put( "server.lua: accepted new client connection from ", tostring(ip), ":", tostring(clientport), " to ", tostring(serverport))
246 if dispatch and not sslctx then -- SSL connections will notify onconnect when handshake completes
247 return dispatch( handler );
250 elseif err then -- maybe timeout or something else
251 out_put( "server.lua: error with new client connection: ", tostring(err) )
258 wrapconnection = function( server, listeners, socket, ip, serverport, clientport, pattern, sslctx ) -- this function wraps a client to a handler object
260 if socket:getfd() >= _maxfd then
261 out_error("server.lua: Disallowed FD number: "..socket:getfd()) -- PROTIP: Switch to libevent
262 socket:close( ) -- Should we send some kind of error here?
264 return nil, nil, "fd-too-large"
266 socket:settimeout( 0 )
268 --// local import of socket methods //--
274 --// private closures of the object //--
278 local dispatch = listeners.onincoming
279 local status = listeners.onstatus
280 local disconnect = listeners.ondisconnect
281 local drain = listeners.ondrain
283 local bufferqueue = { } -- buffer array
284 local bufferqueuelen = 0 -- end of buffer array
295 local sendtraffic, readtraffic = 0, 0
297 local maxsendlen = _maxsendlen
298 local maxreadlen = _maxreadlen
300 --// public methods of the object //--
302 local handler = bufferqueue -- saves a table ^_^
304 handler.dispatch = function( )
307 handler.disconnect = function( )
310 handler.setlistener = function( self, listeners )
311 dispatch = listeners.onincoming
312 disconnect = listeners.ondisconnect
313 status = listeners.onstatus
314 drain = listeners.ondrain
316 handler.getstats = function( )
317 return readtraffic, sendtraffic
319 handler.ssl = function( )
322 handler.sslctx = function ( )
325 handler.send = function( _, data, i, j )
326 return send( socket, data, i, j )
328 handler.receive = function( pattern, prefix )
329 return receive( socket, pattern, prefix )
331 handler.shutdown = function( pattern )
332 return shutdown( socket, pattern )
334 handler.setoption = function (self, option, value)
335 if socket.setoption then
336 return socket:setoption(option, value);
338 return false, "setoption not implemented";
340 handler.force_close = function ( self, err )
341 if bufferqueuelen ~= 0 then
342 out_put("server.lua: discarding unwritten data for ", tostring(ip), ":", tostring(clientport))
345 return self:close(err);
347 handler.close = function( self, err )
348 if not handler then return true; end
349 _readlistlen = removesocket( _readlist, socket, _readlistlen )
350 _readtimes[ handler ] = nil
351 if bufferqueuelen ~= 0 then
352 handler.sendbuffer() -- Try now to send any outstanding data
353 if bufferqueuelen ~= 0 then -- Still not empty, so we'll try again later
355 handler.write = nil -- ... but no further writing allowed
362 _ = shutdown and shutdown( socket )
364 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
365 _socketlist[ socket ] = nil
368 out_put "server.lua: socket already closed"
371 _writetimes[ handler ] = nil
372 _closelist[ handler ] = nil
373 local _handler = handler;
376 disconnect(_handler, err or false);
383 out_put "server.lua: closed client handler and removed socket from list"
386 handler.ip = function( )
389 handler.serverport = function( )
392 handler.clientport = function( )
395 local write = function( self, data )
396 bufferlen = bufferlen + #data
397 if bufferlen > maxsendlen then
398 _closelist[ handler ] = "send buffer exceeded" -- cannot close the client at the moment, have to wait to the end of the cycle
399 handler.write = idfalse -- dont write anymore
401 elseif socket and not _sendlist[ socket ] then
402 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
404 bufferqueuelen = bufferqueuelen + 1
405 bufferqueue[ bufferqueuelen ] = data
407 _writetimes[ handler ] = _writetimes[ handler ] or _currenttime
411 handler.write = write
412 handler.bufferqueue = function( self )
415 handler.socket = function( self )
418 handler.set_mode = function( self, new )
419 pattern = new or pattern
422 handler.set_send = function ( self, newsend )
423 send = newsend or send
426 handler.bufferlen = function( self, readlen, sendlen )
427 maxsendlen = sendlen or maxsendlen
428 maxreadlen = readlen or maxreadlen
429 return bufferlen, maxreadlen, maxsendlen
432 handler.lock_read = function (self, switch)
433 if switch == true then
434 local tmp = _readlistlen
435 _readlistlen = removesocket( _readlist, socket, _readlistlen )
436 _readtimes[ handler ] = nil
437 if _readlistlen ~= tmp then
440 elseif switch == false then
443 _readlistlen = addsocket(_readlist, socket, _readlistlen)
444 _readtimes[ handler ] = _currenttime
449 handler.pause = function (self)
450 return self:lock_read(true);
452 handler.resume = function (self)
453 return self:lock_read(false);
455 handler.lock = function( self, switch )
456 handler.lock_read (switch)
457 if switch == true then
458 handler.write = idfalse
459 local tmp = _sendlistlen
460 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
461 _writetimes[ handler ] = nil
462 if _sendlistlen ~= tmp then
465 elseif switch == false then
466 handler.write = write
472 return noread, nosend
474 local _readbuffer = function( ) -- this function reads data
475 local buffer, err, part = receive( socket, pattern ) -- receive buffer with "pattern"
476 if not err or (err == "wantread" or err == "timeout") then -- received something
477 local buffer = buffer or part or ""
479 if len > maxreadlen then
480 handler:close( "receive buffer exceeded" )
483 local count = len * STAT_UNIT
484 readtraffic = readtraffic + count
485 _readtraffic = _readtraffic + count
486 _readtimes[ handler ] = _currenttime
487 --out_put( "server.lua: read data '", buffer:gsub("[^%w%p ]", "."), "', error: ", err )
488 return dispatch( handler, buffer, err )
489 else -- connections was closed or fatal error
490 out_put( "server.lua: client ", tostring(ip), ":", tostring(clientport), " read error: ", tostring(err) )
492 _ = handler and handler:force_close( err )
496 local _sendbuffer = function( ) -- this function sends data
497 local succ, err, byte, buffer, count;
499 buffer = table_concat( bufferqueue, "", 1, bufferqueuelen )
500 succ, err, byte = send( socket, buffer, 1, bufferlen )
501 count = ( succ or byte or 0 ) * STAT_UNIT
502 sendtraffic = sendtraffic + count
503 _sendtraffic = _sendtraffic + count
504 for i = bufferqueuelen,1,-1 do
505 bufferqueue[ i ] = nil
507 --out_put( "server.lua: sended '", buffer, "', bytes: ", tostring(succ), ", error: ", tostring(err), ", part: ", tostring(byte), ", to: ", tostring(ip), ":", tostring(clientport) )
509 succ, err, count = false, "unexpected close", 0;
511 if succ then -- sending succesful
514 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen ) -- delete socket from writelist
515 _writetimes[ handler ] = nil
519 _ = needtls and handler:starttls(nil)
520 _ = toclose and handler:force_close( )
522 elseif byte and ( err == "timeout" or err == "wantwrite" ) then -- want write
523 buffer = string_sub( buffer, byte + 1, bufferlen ) -- new buffer
524 bufferqueue[ 1 ] = buffer -- insert new buffer in queue
526 bufferlen = bufferlen - byte
527 _writetimes[ handler ] = _currenttime
529 else -- connection was closed during sending or fatal error
530 out_put( "server.lua: client ", tostring(ip), ":", tostring(clientport), " write error: ", tostring(err) )
532 _ = handler and handler:force_close( err )
539 function handler.set_sslctx(self, new_sslctx)
542 handshake = coroutine_wrap( function( client ) -- create handshake coroutine
544 for i = 1, _maxsslhandshake do
545 _sendlistlen = ( wrote and removesocket( _sendlist, client, _sendlistlen ) ) or _sendlistlen
546 _readlistlen = ( read and removesocket( _readlist, client, _readlistlen ) ) or _readlistlen
547 read, wrote = nil, nil
548 _, err = client:dohandshake( )
550 out_put( "server.lua: ssl handshake done" )
551 handler.readbuffer = _readbuffer -- when handshake is done, replace the handshake function with regular functions
552 handler.sendbuffer = _sendbuffer
553 _ = status and status( handler, "ssl-handshake-complete" )
554 if self.autostart_ssl and listeners.onconnect then
555 listeners.onconnect(self);
557 _readlistlen = addsocket(_readlist, client, _readlistlen)
560 if err == "wantwrite" then
561 _sendlistlen = addsocket(_sendlist, client, _sendlistlen)
563 elseif err == "wantread" then
564 _readlistlen = addsocket(_readlist, client, _readlistlen)
570 coroutine_yield( ) -- handshake not finished
573 out_put( "server.lua: ssl handshake error: ", tostring(err or "handshake too long") )
574 _ = handler and handler:force_close("ssl handshake failed")
575 return false, err -- handshake failed
580 handler.starttls = function( self, _sslctx)
582 handler:set_sslctx(_sslctx);
584 if bufferqueuelen > 0 then
585 out_put "server.lua: we need to do tls, but delaying until send buffer empty"
589 out_put( "server.lua: attempting to start tls on " .. tostring( socket ) )
590 local oldsocket, err = socket
591 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
593 out_put( "server.lua: error while starting tls on client: ", tostring(err or "unknown error") )
594 return nil, err -- fatal error
597 socket:settimeout( 0 )
599 -- add the new socket to our system
601 receive = socket.receive
603 _socketlist[ socket ] = handler
604 _readlistlen = addsocket(_readlist, socket, _readlistlen)
606 -- remove traces of the old socket
607 _readlistlen = removesocket( _readlist, oldsocket, _readlistlen )
608 _sendlistlen = removesocket( _sendlist, oldsocket, _sendlistlen )
609 _socketlist[ oldsocket ] = nil
611 handler.starttls = nil
614 -- Secure now (if handshake fails connection will close)
617 handler.readbuffer = handshake
618 handler.sendbuffer = handshake
619 return handshake( socket ) -- do handshake
623 handler.readbuffer = _readbuffer
624 handler.sendbuffer = _sendbuffer
626 receive = socket.receive
627 shutdown = ( ssl and id ) or socket.shutdown
629 _socketlist[ socket ] = handler
630 _readlistlen = addsocket(_readlist, socket, _readlistlen)
632 if sslctx and luasec then
633 out_put "server.lua: auto-starting ssl negotiation..."
634 handler.autostart_ssl = true;
635 local ok, err = handler:starttls(sslctx);
641 return handler, socket
647 idfalse = function( )
651 addsocket = function( list, socket, len )
652 if not list[ socket ] then
660 removesocket = function( list, socket, len ) -- this function removes sockets from a list ( copied from copas )
661 local pos = list[ socket ]
664 local last = list[ len ]
666 if last ~= socket then
675 closesocket = function( socket )
676 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
677 _readlistlen = removesocket( _readlist, socket, _readlistlen )
678 _socketlist[ socket ] = nil
683 local function link(sender, receiver, buffersize)
685 local _sendbuffer = receiver.sendbuffer;
686 function receiver.sendbuffer()
688 if sender_locked and receiver.bufferlen() < buffersize then
689 sender:lock_read(false); -- Unlock now
694 local _readbuffer = sender.readbuffer;
695 function sender.readbuffer()
697 if not sender_locked and receiver.bufferlen() >= buffersize then
698 sender_locked = true;
699 sender:lock_read(true);
704 ----------------------------------// PUBLIC //--
706 addserver = function( addr, port, listeners, pattern, sslctx ) -- this function provides a way for other scripts to reg a server
708 if type( listeners ) ~= "table" then
709 err = "invalid listener table"
711 if type( port ) ~= "number" or not ( port >= 0 and port <= 65535 ) then
713 elseif _server[ addr..":"..port ] then
714 err = "listeners on '[" .. addr .. "]:" .. port .. "' already exist"
715 elseif sslctx and not luasec then
716 err = "luasec not found"
719 out_error( "server.lua, [", addr, "]:", port, ": ", err )
723 local server, err = socket_bind( addr, port )
725 out_error( "server.lua, [", addr, "]:", port, ": ", err )
728 local handler, err = wrapserver( listeners, server, addr, port, pattern, sslctx ) -- wrap new server socket
733 server:settimeout( 0 )
734 _readlistlen = addsocket(_readlist, server, _readlistlen)
735 _server[ addr..":"..port ] = handler
736 _socketlist[ server ] = handler
737 out_put( "server.lua: new "..(sslctx and "ssl " or "").."server listener on '[", addr, "]:", port, "'" )
741 getserver = function ( addr, port )
742 return _server[ addr..":"..port ];
745 removeserver = function( addr, port )
746 local handler = _server[ addr..":"..port ]
748 return nil, "no server found on '[" .. addr .. "]:" .. tostring( port ) .. "'"
751 _server[ addr..":"..port ] = nil
755 closeall = function( )
756 for _, handler in pairs( _socketlist ) do
758 _socketlist[ _ ] = nil
771 getsettings = function( )
773 select_timeout = _selecttimeout;
774 select_sleep_time = _sleeptime;
775 max_send_buffer_size = _maxsendlen;
776 max_receive_buffer_size = _maxreadlen;
777 select_idle_check_interval = _checkinterval;
778 send_timeout = _sendtimeout;
779 read_timeout = _readtimeout;
780 max_connections = _maxselectlen;
781 max_ssl_handshake_roundtrips = _maxsslhandshake;
782 highest_allowed_fd = _maxfd;
786 changesettings = function( new )
787 if type( new ) ~= "table" then
788 return nil, "invalid settings table"
790 _selecttimeout = tonumber( new.select_timeout ) or _selecttimeout
791 _sleeptime = tonumber( new.select_sleep_time ) or _sleeptime
792 _maxsendlen = tonumber( new.max_send_buffer_size ) or _maxsendlen
793 _maxreadlen = tonumber( new.max_receive_buffer_size ) or _maxreadlen
794 _checkinterval = tonumber( new.select_idle_check_interval ) or _checkinterval
795 _sendtimeout = tonumber( new.send_timeout ) or _sendtimeout
796 _readtimeout = tonumber( new.read_timeout ) or _readtimeout
797 _maxselectlen = new.max_connections or _maxselectlen
798 _maxsslhandshake = new.max_ssl_handshake_roundtrips or _maxsslhandshake
799 _maxfd = new.highest_allowed_fd or _maxfd
803 addtimer = function( listener )
804 if type( listener ) ~= "function" then
805 return nil, "invalid listener function"
807 _timerlistlen = _timerlistlen + 1
808 _timerlist[ _timerlistlen ] = listener
813 return _readtraffic, _sendtraffic, _readlistlen, _sendlistlen, _timerlistlen
818 local function setquitting(quit)
819 quitting = not not quit;
822 loop = function(once) -- this is the main loop of the program
823 if quitting then return "quitting"; end
824 if once then quitting = "once"; end
825 local next_timer_time = math_huge;
827 local read, write, err = socket_select( _readlist, _sendlist, math_min(_selecttimeout, next_timer_time) )
828 for i, socket in ipairs( write ) do -- send data waiting in writequeues
829 local handler = _socketlist[ socket ]
831 handler.sendbuffer( )
833 closesocket( socket )
834 out_put "server.lua: found no handler and closed socket (writelist)" -- this should not happen
837 for i, socket in ipairs( read ) do -- receive data
838 local handler = _socketlist[ socket ]
840 handler.readbuffer( )
842 closesocket( socket )
843 out_put "server.lua: found no handler and closed socket (readlist)" -- this can happen
846 for handler, err in pairs( _closelist ) do
847 handler.disconnect( )( handler, err )
848 handler:force_close() -- forced disconnect
849 _closelist[ handler ] = nil;
851 _currenttime = luasocket_gettime( )
853 -- Check for socket timeouts
854 local difftime = os_difftime( _currenttime - _starttime )
855 if difftime > _checkinterval then
856 _starttime = _currenttime
857 for handler, timestamp in pairs( _writetimes ) do
858 if os_difftime( _currenttime - timestamp ) > _sendtimeout then
859 --_writetimes[ handler ] = nil
860 handler.disconnect( )( handler, "send timeout" )
861 handler:force_close() -- forced disconnect
864 for handler, timestamp in pairs( _readtimes ) do
865 if os_difftime( _currenttime - timestamp ) > _readtimeout then
866 --_readtimes[ handler ] = nil
867 handler.disconnect( )( handler, "read timeout" )
868 handler:close( ) -- forced disconnect?
874 if _currenttime - _timer >= math_min(next_timer_time, 1) then
875 next_timer_time = math_huge;
876 for i = 1, _timerlistlen do
877 local t = _timerlist[ i ]( _currenttime ) -- fire timers
878 if t then next_timer_time = math_min(next_timer_time, t); end
880 _timer = _currenttime
882 next_timer_time = next_timer_time - (_currenttime - _timer);
885 -- wait some time (0 by default)
886 socket_sleep( _sleeptime )
888 if once and quitting == "once" then quitting = nil; return; end
892 local function step()
896 local function get_backend()
900 --// EXPERIMENTAL //--
902 local wrapclient = function( socket, ip, serverport, listeners, pattern, sslctx )
903 local handler, socket, err = wrapconnection( nil, listeners, socket, ip, serverport, "clientport", pattern, sslctx )
904 if not handler then return nil, err end
905 _socketlist[ socket ] = handler
907 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
908 if listeners.onconnect then
909 -- When socket is writeable, call onconnect
910 local _sendbuffer = handler.sendbuffer;
911 handler.sendbuffer = function ()
912 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen );
913 handler.sendbuffer = _sendbuffer;
914 listeners.onconnect(handler);
915 -- If there was data with the incoming packet, handle it now.
916 if #handler:bufferqueue() > 0 then
917 return _sendbuffer();
922 return handler, socket
925 local addclient = function( address, port, listeners, pattern, sslctx )
926 local client, err = luasocket.tcp( )
930 client:settimeout( 0 )
931 _, err = client:connect( address, port )
932 if err then -- try again
933 local handler = wrapclient( client, address, port, listeners )
935 wrapconnection( nil, listeners, client, address, port, "clientport", pattern, sslctx )
939 --// EXPERIMENTAL //--
941 ----------------------------------// BEGIN //--
943 use "setmetatable" ( _socketlist, { __mode = "k" } )
944 use "setmetatable" ( _readtimes, { __mode = "k" } )
945 use "setmetatable" ( _writetimes, { __mode = "k" } )
947 _timer = luasocket_gettime( )
948 _starttime = luasocket_gettime( )
950 local function setlogger(new_logger)
951 local old_logger = log;
958 ----------------------------------// PUBLIC INTERFACE //--
961 _addtimer = addtimer,
963 addclient = addclient,
964 wrapclient = wrapclient,
971 addserver = addserver,
972 getserver = getserver,
973 setlogger = setlogger,
974 getsettings = getsettings,
975 setquitting = setquitting,
976 removeserver = removeserver,
977 get_backend = get_backend,
978 changesettings = changesettings,