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 //--
121 local _maxsslhandshake
123 ----------------------------------// DEFINITION //--
125 _server = { } -- key = port, value = table; list of listening servers
126 _readlist = { } -- array with sockets to read from
127 _sendlist = { } -- arrary with sockets to write to
128 _timerlist = { } -- array of timer functions
129 _socketlist = { } -- key = socket, value = wrapped socket (handlers)
130 _readtimes = { } -- key = handler, value = timestamp of last data reading
131 _writetimes = { } -- key = handler, value = timestamp of last data writing/sending
132 _closelist = { } -- handlers to close
134 _readlistlen = 0 -- length of readlist
135 _sendlistlen = 0 -- length of sendlist
136 _timerlistlen = 0 -- lenght of timerlist
138 _sendtraffic = 0 -- some stats
141 _selecttimeout = 1 -- timeout of socket.select
142 _sleeptime = 0 -- time to wait at the end of every loop
143 _tcpbacklog = 128 -- some kind of hint to the OS
145 _maxsendlen = 51000 * 1024 -- max len of send buffer
146 _maxreadlen = 25000 * 1024 -- max len of read buffer
148 _checkinterval = 1200000 -- interval in secs to check idle clients
149 _sendtimeout = 60000 -- allowed send idle time in secs
150 _readtimeout = 6 * 60 * 60 -- allowed read idle time in secs
152 _maxfd = luasocket._SETSIZE or 1024 -- We should ignore this on Windows. Perhaps by simply setting it to math.huge or something.
153 _maxselectlen = luasocket._SETSIZE or 1024 -- But this still applies on Windows
155 _maxsslhandshake = 30 -- max handshake round-trips
157 ----------------------------------// PRIVATE //--
159 wrapserver = function( listeners, socket, ip, serverport, pattern, sslctx ) -- this function wraps a server -- FIXME Make sure FD < _maxfd
161 if socket:getfd() >= _maxfd then
162 out_error("server.lua: Disallowed FD number: "..socket:getfd())
164 return nil, "fd-too-large"
167 local connections = 0
169 local dispatch, disconnect = listeners.onconnect, listeners.ondisconnect
171 local accept = socket.accept
173 --// public methods of the object //--
177 handler.shutdown = function( ) end
179 handler.ssl = function( )
182 handler.sslctx = function( )
185 handler.remove = function( )
186 connections = connections - 1
191 handler.close = function()
193 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
194 _readlistlen = removesocket( _readlist, socket, _readlistlen )
195 _server[ip..":"..serverport] = nil;
196 _socketlist[ socket ] = nil
200 out_put "server.lua: closed server handler and removed sockets from list"
202 handler.pause = function( hard )
203 if not handler.paused then
204 _readlistlen = removesocket( _readlist, socket, _readlistlen )
206 _socketlist[ socket ] = nil
210 handler.paused = true;
213 handler.resume = function( )
214 if handler.paused then
216 socket = socket_bind( ip, serverport, _tcpbacklog );
217 socket:settimeout( 0 )
219 _readlistlen = addsocket(_readlist, socket, _readlistlen)
220 _socketlist[ socket ] = handler
221 handler.paused = false;
224 handler.ip = function( )
227 handler.serverport = function( )
230 handler.socket = function( )
233 handler.readbuffer = function( )
234 if _readlistlen >= _maxselectlen or _sendlistlen >= _maxselectlen then
236 out_put( "server.lua: refused new client connection: server full" )
239 local client, err = accept( socket ) -- try to accept
241 local ip, clientport = client:getpeername( )
242 local handler, client, err = wrapconnection( handler, listeners, client, ip, serverport, clientport, pattern, sslctx ) -- wrap new client socket
243 if err then -- error while wrapping ssl socket
246 connections = connections + 1
247 out_put( "server.lua: accepted new client connection from ", tostring(ip), ":", tostring(clientport), " to ", tostring(serverport))
248 if dispatch and not sslctx then -- SSL connections will notify onconnect when handshake completes
249 return dispatch( handler );
252 elseif err then -- maybe timeout or something else
253 out_put( "server.lua: error with new client connection: ", tostring(err) )
260 wrapconnection = function( server, listeners, socket, ip, serverport, clientport, pattern, sslctx ) -- this function wraps a client to a handler object
262 if socket:getfd() >= _maxfd then
263 out_error("server.lua: Disallowed FD number: "..socket:getfd()) -- PROTIP: Switch to libevent
264 socket:close( ) -- Should we send some kind of error here?
266 return nil, nil, "fd-too-large"
268 socket:settimeout( 0 )
270 --// local import of socket methods //--
276 --// private closures of the object //--
280 local dispatch = listeners.onincoming
281 local status = listeners.onstatus
282 local disconnect = listeners.ondisconnect
283 local drain = listeners.ondrain
285 local bufferqueue = { } -- buffer array
286 local bufferqueuelen = 0 -- end of buffer array
297 local sendtraffic, readtraffic = 0, 0
299 local maxsendlen = _maxsendlen
300 local maxreadlen = _maxreadlen
302 --// public methods of the object //--
304 local handler = bufferqueue -- saves a table ^_^
306 handler.dispatch = function( )
309 handler.disconnect = function( )
312 handler.setlistener = function( self, listeners )
313 dispatch = listeners.onincoming
314 disconnect = listeners.ondisconnect
315 status = listeners.onstatus
316 drain = listeners.ondrain
318 handler.getstats = function( )
319 return readtraffic, sendtraffic
321 handler.ssl = function( )
324 handler.sslctx = function ( )
327 handler.send = function( _, data, i, j )
328 return send( socket, data, i, j )
330 handler.receive = function( pattern, prefix )
331 return receive( socket, pattern, prefix )
333 handler.shutdown = function( pattern )
334 return shutdown( socket, pattern )
336 handler.setoption = function (self, option, value)
337 if socket.setoption then
338 return socket:setoption(option, value);
340 return false, "setoption not implemented";
342 handler.force_close = function ( self, err )
343 if bufferqueuelen ~= 0 then
344 out_put("server.lua: discarding unwritten data for ", tostring(ip), ":", tostring(clientport))
347 return self:close(err);
349 handler.close = function( self, err )
350 if not handler then return true; end
351 _readlistlen = removesocket( _readlist, socket, _readlistlen )
352 _readtimes[ handler ] = nil
353 if bufferqueuelen ~= 0 then
354 handler.sendbuffer() -- Try now to send any outstanding data
355 if bufferqueuelen ~= 0 then -- Still not empty, so we'll try again later
357 handler.write = nil -- ... but no further writing allowed
364 _ = shutdown and shutdown( socket )
366 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
367 _socketlist[ socket ] = nil
370 out_put "server.lua: socket already closed"
373 _writetimes[ handler ] = nil
374 _closelist[ handler ] = nil
375 local _handler = handler;
378 disconnect(_handler, err or false);
385 out_put "server.lua: closed client handler and removed socket from list"
388 handler.ip = function( )
391 handler.serverport = function( )
394 handler.clientport = function( )
397 local write = function( self, data )
398 bufferlen = bufferlen + #data
399 if bufferlen > maxsendlen then
400 _closelist[ handler ] = "send buffer exceeded" -- cannot close the client at the moment, have to wait to the end of the cycle
401 handler.write = idfalse -- dont write anymore
403 elseif socket and not _sendlist[ socket ] then
404 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
406 bufferqueuelen = bufferqueuelen + 1
407 bufferqueue[ bufferqueuelen ] = data
409 _writetimes[ handler ] = _writetimes[ handler ] or _currenttime
413 handler.write = write
414 handler.bufferqueue = function( self )
417 handler.socket = function( self )
420 handler.set_mode = function( self, new )
421 pattern = new or pattern
424 handler.set_send = function ( self, newsend )
425 send = newsend or send
428 handler.bufferlen = function( self, readlen, sendlen )
429 maxsendlen = sendlen or maxsendlen
430 maxreadlen = readlen or maxreadlen
431 return bufferlen, maxreadlen, maxsendlen
434 handler.lock_read = function (self, switch)
435 if switch == true then
436 local tmp = _readlistlen
437 _readlistlen = removesocket( _readlist, socket, _readlistlen )
438 _readtimes[ handler ] = nil
439 if _readlistlen ~= tmp then
442 elseif switch == false then
445 _readlistlen = addsocket(_readlist, socket, _readlistlen)
446 _readtimes[ handler ] = _currenttime
451 handler.pause = function (self)
452 return self:lock_read(true);
454 handler.resume = function (self)
455 return self:lock_read(false);
457 handler.lock = function( self, switch )
458 handler.lock_read (switch)
459 if switch == true then
460 handler.write = idfalse
461 local tmp = _sendlistlen
462 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
463 _writetimes[ handler ] = nil
464 if _sendlistlen ~= tmp then
467 elseif switch == false then
468 handler.write = write
474 return noread, nosend
476 local _readbuffer = function( ) -- this function reads data
477 local buffer, err, part = receive( socket, pattern ) -- receive buffer with "pattern"
478 if not err or (err == "wantread" or err == "timeout") then -- received something
479 local buffer = buffer or part or ""
481 if len > maxreadlen then
482 handler:close( "receive buffer exceeded" )
485 local count = len * STAT_UNIT
486 readtraffic = readtraffic + count
487 _readtraffic = _readtraffic + count
488 _readtimes[ handler ] = _currenttime
489 --out_put( "server.lua: read data '", buffer:gsub("[^%w%p ]", "."), "', error: ", err )
490 return dispatch( handler, buffer, err )
491 else -- connections was closed or fatal error
492 out_put( "server.lua: client ", tostring(ip), ":", tostring(clientport), " read error: ", tostring(err) )
494 _ = handler and handler:force_close( err )
498 local _sendbuffer = function( ) -- this function sends data
499 local succ, err, byte, buffer, count;
501 buffer = table_concat( bufferqueue, "", 1, bufferqueuelen )
502 succ, err, byte = send( socket, buffer, 1, bufferlen )
503 count = ( succ or byte or 0 ) * STAT_UNIT
504 sendtraffic = sendtraffic + count
505 _sendtraffic = _sendtraffic + count
506 for i = bufferqueuelen,1,-1 do
507 bufferqueue[ i ] = nil
509 --out_put( "server.lua: sended '", buffer, "', bytes: ", tostring(succ), ", error: ", tostring(err), ", part: ", tostring(byte), ", to: ", tostring(ip), ":", tostring(clientport) )
511 succ, err, count = false, "unexpected close", 0;
513 if succ then -- sending succesful
516 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen ) -- delete socket from writelist
517 _writetimes[ handler ] = nil
521 _ = needtls and handler:starttls(nil)
522 _ = toclose and handler:force_close( )
524 elseif byte and ( err == "timeout" or err == "wantwrite" ) then -- want write
525 buffer = string_sub( buffer, byte + 1, bufferlen ) -- new buffer
526 bufferqueue[ 1 ] = buffer -- insert new buffer in queue
528 bufferlen = bufferlen - byte
529 _writetimes[ handler ] = _currenttime
531 else -- connection was closed during sending or fatal error
532 out_put( "server.lua: client ", tostring(ip), ":", tostring(clientport), " write error: ", tostring(err) )
534 _ = handler and handler:force_close( err )
541 function handler.set_sslctx(self, new_sslctx)
544 handshake = coroutine_wrap( function( client ) -- create handshake coroutine
546 for i = 1, _maxsslhandshake do
547 _sendlistlen = ( wrote and removesocket( _sendlist, client, _sendlistlen ) ) or _sendlistlen
548 _readlistlen = ( read and removesocket( _readlist, client, _readlistlen ) ) or _readlistlen
549 read, wrote = nil, nil
550 _, err = client:dohandshake( )
552 out_put( "server.lua: ssl handshake done" )
553 handler.readbuffer = _readbuffer -- when handshake is done, replace the handshake function with regular functions
554 handler.sendbuffer = _sendbuffer
555 _ = status and status( handler, "ssl-handshake-complete" )
556 if self.autostart_ssl and listeners.onconnect then
557 listeners.onconnect(self);
559 _readlistlen = addsocket(_readlist, client, _readlistlen)
562 if err == "wantwrite" then
563 _sendlistlen = addsocket(_sendlist, client, _sendlistlen)
565 elseif err == "wantread" then
566 _readlistlen = addsocket(_readlist, client, _readlistlen)
572 coroutine_yield( ) -- handshake not finished
575 out_put( "server.lua: ssl handshake error: ", tostring(err or "handshake too long") )
576 _ = handler and handler:force_close("ssl handshake failed")
577 return false, err -- handshake failed
582 handler.starttls = function( self, _sslctx)
584 handler:set_sslctx(_sslctx);
586 if bufferqueuelen > 0 then
587 out_put "server.lua: we need to do tls, but delaying until send buffer empty"
591 out_put( "server.lua: attempting to start tls on " .. tostring( socket ) )
592 local oldsocket, err = socket
593 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
595 out_put( "server.lua: error while starting tls on client: ", tostring(err or "unknown error") )
596 return nil, err -- fatal error
599 socket:settimeout( 0 )
601 -- add the new socket to our system
603 receive = socket.receive
605 _socketlist[ socket ] = handler
606 _readlistlen = addsocket(_readlist, socket, _readlistlen)
608 -- remove traces of the old socket
609 _readlistlen = removesocket( _readlist, oldsocket, _readlistlen )
610 _sendlistlen = removesocket( _sendlist, oldsocket, _sendlistlen )
611 _socketlist[ oldsocket ] = nil
613 handler.starttls = nil
616 -- Secure now (if handshake fails connection will close)
619 handler.readbuffer = handshake
620 handler.sendbuffer = handshake
621 return handshake( socket ) -- do handshake
625 handler.readbuffer = _readbuffer
626 handler.sendbuffer = _sendbuffer
628 receive = socket.receive
629 shutdown = ( ssl and id ) or socket.shutdown
631 _socketlist[ socket ] = handler
632 _readlistlen = addsocket(_readlist, socket, _readlistlen)
634 if sslctx and luasec then
635 out_put "server.lua: auto-starting ssl negotiation..."
636 handler.autostart_ssl = true;
637 local ok, err = handler:starttls(sslctx);
643 return handler, socket
649 idfalse = function( )
653 addsocket = function( list, socket, len )
654 if not list[ socket ] then
662 removesocket = function( list, socket, len ) -- this function removes sockets from a list ( copied from copas )
663 local pos = list[ socket ]
666 local last = list[ len ]
668 if last ~= socket then
677 closesocket = function( socket )
678 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
679 _readlistlen = removesocket( _readlist, socket, _readlistlen )
680 _socketlist[ socket ] = nil
685 local function link(sender, receiver, buffersize)
687 local _sendbuffer = receiver.sendbuffer;
688 function receiver.sendbuffer()
690 if sender_locked and receiver.bufferlen() < buffersize then
691 sender:lock_read(false); -- Unlock now
696 local _readbuffer = sender.readbuffer;
697 function sender.readbuffer()
699 if not sender_locked and receiver.bufferlen() >= buffersize then
700 sender_locked = true;
701 sender:lock_read(true);
706 ----------------------------------// PUBLIC //--
708 addserver = function( addr, port, listeners, pattern, sslctx ) -- this function provides a way for other scripts to reg a server
710 if type( listeners ) ~= "table" then
711 err = "invalid listener table"
713 if type( port ) ~= "number" or not ( port >= 0 and port <= 65535 ) then
715 elseif _server[ addr..":"..port ] then
716 err = "listeners on '[" .. addr .. "]:" .. port .. "' already exist"
717 elseif sslctx and not luasec then
718 err = "luasec not found"
721 out_error( "server.lua, [", addr, "]:", port, ": ", err )
725 local server, err = socket_bind( addr, port, _tcpbacklog )
727 out_error( "server.lua, [", addr, "]:", port, ": ", err )
730 local handler, err = wrapserver( listeners, server, addr, port, pattern, sslctx ) -- wrap new server socket
735 server:settimeout( 0 )
736 _readlistlen = addsocket(_readlist, server, _readlistlen)
737 _server[ addr..":"..port ] = handler
738 _socketlist[ server ] = handler
739 out_put( "server.lua: new "..(sslctx and "ssl " or "").."server listener on '[", addr, "]:", port, "'" )
743 getserver = function ( addr, port )
744 return _server[ addr..":"..port ];
747 removeserver = function( addr, port )
748 local handler = _server[ addr..":"..port ]
750 return nil, "no server found on '[" .. addr .. "]:" .. tostring( port ) .. "'"
753 _server[ addr..":"..port ] = nil
757 closeall = function( )
758 for _, handler in pairs( _socketlist ) do
760 _socketlist[ _ ] = nil
773 getsettings = function( )
775 select_timeout = _selecttimeout;
776 select_sleep_time = _sleeptime;
777 tcp_backlog = _tcpbacklog;
778 max_send_buffer_size = _maxsendlen;
779 max_receive_buffer_size = _maxreadlen;
780 select_idle_check_interval = _checkinterval;
781 send_timeout = _sendtimeout;
782 read_timeout = _readtimeout;
783 max_connections = _maxselectlen;
784 max_ssl_handshake_roundtrips = _maxsslhandshake;
785 highest_allowed_fd = _maxfd;
789 changesettings = function( new )
790 if type( new ) ~= "table" then
791 return nil, "invalid settings table"
793 _selecttimeout = tonumber( new.select_timeout ) or _selecttimeout
794 _sleeptime = tonumber( new.select_sleep_time ) or _sleeptime
795 _maxsendlen = tonumber( new.max_send_buffer_size ) or _maxsendlen
796 _maxreadlen = tonumber( new.max_receive_buffer_size ) or _maxreadlen
797 _checkinterval = tonumber( new.select_idle_check_interval ) or _checkinterval
798 _tcpbacklog = tonumber( new.tcp_backlog ) or _tcpbacklog
799 _sendtimeout = tonumber( new.send_timeout ) or _sendtimeout
800 _readtimeout = tonumber( new.read_timeout ) or _readtimeout
801 _maxselectlen = new.max_connections or _maxselectlen
802 _maxsslhandshake = new.max_ssl_handshake_roundtrips or _maxsslhandshake
803 _maxfd = new.highest_allowed_fd or _maxfd
807 addtimer = function( listener )
808 if type( listener ) ~= "function" then
809 return nil, "invalid listener function"
811 _timerlistlen = _timerlistlen + 1
812 _timerlist[ _timerlistlen ] = listener
817 return _readtraffic, _sendtraffic, _readlistlen, _sendlistlen, _timerlistlen
822 local function setquitting(quit)
823 quitting = not not quit;
826 loop = function(once) -- this is the main loop of the program
827 if quitting then return "quitting"; end
828 if once then quitting = "once"; end
829 local next_timer_time = math_huge;
831 local read, write, err = socket_select( _readlist, _sendlist, math_min(_selecttimeout, next_timer_time) )
832 for i, socket in ipairs( write ) do -- send data waiting in writequeues
833 local handler = _socketlist[ socket ]
835 handler.sendbuffer( )
837 closesocket( socket )
838 out_put "server.lua: found no handler and closed socket (writelist)" -- this should not happen
841 for i, socket in ipairs( read ) do -- receive data
842 local handler = _socketlist[ socket ]
844 handler.readbuffer( )
846 closesocket( socket )
847 out_put "server.lua: found no handler and closed socket (readlist)" -- this can happen
850 for handler, err in pairs( _closelist ) do
851 handler.disconnect( )( handler, err )
852 handler:force_close() -- forced disconnect
853 _closelist[ handler ] = nil;
855 _currenttime = luasocket_gettime( )
857 -- Check for socket timeouts
858 local difftime = os_difftime( _currenttime - _starttime )
859 if difftime > _checkinterval then
860 _starttime = _currenttime
861 for handler, timestamp in pairs( _writetimes ) do
862 if os_difftime( _currenttime - timestamp ) > _sendtimeout then
863 --_writetimes[ handler ] = nil
864 handler.disconnect( )( handler, "send timeout" )
865 handler:force_close() -- forced disconnect
868 for handler, timestamp in pairs( _readtimes ) do
869 if os_difftime( _currenttime - timestamp ) > _readtimeout then
870 --_readtimes[ handler ] = nil
871 handler.disconnect( )( handler, "read timeout" )
872 handler:close( ) -- forced disconnect?
878 if _currenttime - _timer >= math_min(next_timer_time, 1) then
879 next_timer_time = math_huge;
880 for i = 1, _timerlistlen do
881 local t = _timerlist[ i ]( _currenttime ) -- fire timers
882 if t then next_timer_time = math_min(next_timer_time, t); end
884 _timer = _currenttime
886 next_timer_time = next_timer_time - (_currenttime - _timer);
889 -- wait some time (0 by default)
890 socket_sleep( _sleeptime )
892 if once and quitting == "once" then quitting = nil; return; end
896 local function step()
900 local function get_backend()
904 --// EXPERIMENTAL //--
906 local wrapclient = function( socket, ip, serverport, listeners, pattern, sslctx )
907 local handler, socket, err = wrapconnection( nil, listeners, socket, ip, serverport, "clientport", pattern, sslctx )
908 if not handler then return nil, err end
909 _socketlist[ socket ] = handler
911 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
912 if listeners.onconnect then
913 -- When socket is writeable, call onconnect
914 local _sendbuffer = handler.sendbuffer;
915 handler.sendbuffer = function ()
916 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen );
917 handler.sendbuffer = _sendbuffer;
918 listeners.onconnect(handler);
919 -- If there was data with the incoming packet, handle it now.
920 if #handler:bufferqueue() > 0 then
921 return _sendbuffer();
926 return handler, socket
929 local addclient = function( address, port, listeners, pattern, sslctx )
930 local client, err = luasocket.tcp( )
934 client:settimeout( 0 )
935 _, err = client:connect( address, port )
936 if err then -- try again
937 local handler = wrapclient( client, address, port, listeners )
939 wrapconnection( nil, listeners, client, address, port, "clientport", pattern, sslctx )
943 --// EXPERIMENTAL //--
945 ----------------------------------// BEGIN //--
947 use "setmetatable" ( _socketlist, { __mode = "k" } )
948 use "setmetatable" ( _readtimes, { __mode = "k" } )
949 use "setmetatable" ( _writetimes, { __mode = "k" } )
951 _timer = luasocket_gettime( )
952 _starttime = luasocket_gettime( )
954 local function setlogger(new_logger)
955 local old_logger = log;
962 ----------------------------------// PUBLIC INTERFACE //--
965 _addtimer = addtimer,
967 addclient = addclient,
968 wrapclient = wrapclient,
975 addserver = addserver,
976 getserver = getserver,
977 setlogger = setlogger,
978 getsettings = getsettings,
979 setquitting = setquitting,
980 removeserver = removeserver,
981 get_backend = get_backend,
982 changesettings = changesettings,