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 local is_windows = package.config:sub(1,1) == "\\" -- check the directory separator, to detemine whether this is Windows
153 _maxfd = (is_windows and math.huge) or luasocket._SETSIZE or 1024 -- max fd number, limit to 1024 by default to prevent glibc buffer overflow, but not on Windows
154 _maxselectlen = luasocket._SETSIZE or 1024 -- But this still applies on Windows
156 _maxsslhandshake = 30 -- max handshake round-trips
158 ----------------------------------// PRIVATE //--
160 wrapserver = function( listeners, socket, ip, serverport, pattern, sslctx ) -- this function wraps a server -- FIXME Make sure FD < _maxfd
162 if socket:getfd() >= _maxfd then
163 out_error("server.lua: Disallowed FD number: "..socket:getfd())
165 return nil, "fd-too-large"
168 local connections = 0
170 local dispatch, disconnect = listeners.onconnect, listeners.ondisconnect
172 local accept = socket.accept
174 --// public methods of the object //--
178 handler.shutdown = function( ) end
180 handler.ssl = function( )
183 handler.sslctx = function( )
186 handler.remove = function( )
187 connections = connections - 1
192 handler.close = function()
194 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
195 _readlistlen = removesocket( _readlist, socket, _readlistlen )
196 _server[ip..":"..serverport] = nil;
197 _socketlist[ socket ] = nil
201 out_put "server.lua: closed server handler and removed sockets from list"
203 handler.pause = function( hard )
204 if not handler.paused then
205 _readlistlen = removesocket( _readlist, socket, _readlistlen )
207 _socketlist[ socket ] = nil
211 handler.paused = true;
214 handler.resume = function( )
215 if handler.paused then
217 socket = socket_bind( ip, serverport, _tcpbacklog );
218 socket:settimeout( 0 )
220 _readlistlen = addsocket(_readlist, socket, _readlistlen)
221 _socketlist[ socket ] = handler
222 handler.paused = false;
225 handler.ip = function( )
228 handler.serverport = function( )
231 handler.socket = function( )
234 handler.readbuffer = function( )
235 if _readlistlen >= _maxselectlen or _sendlistlen >= _maxselectlen then
237 out_put( "server.lua: refused new client connection: server full" )
240 local client, err = accept( socket ) -- try to accept
242 local ip, clientport = client:getpeername( )
243 local handler, client, err = wrapconnection( handler, listeners, client, ip, serverport, clientport, pattern, sslctx ) -- wrap new client socket
244 if err then -- error while wrapping ssl socket
247 connections = connections + 1
248 out_put( "server.lua: accepted new client connection from ", tostring(ip), ":", tostring(clientport), " to ", tostring(serverport))
249 if dispatch and not sslctx then -- SSL connections will notify onconnect when handshake completes
250 return dispatch( handler );
253 elseif err then -- maybe timeout or something else
254 out_put( "server.lua: error with new client connection: ", tostring(err) )
261 wrapconnection = function( server, listeners, socket, ip, serverport, clientport, pattern, sslctx ) -- this function wraps a client to a handler object
263 if socket:getfd() >= _maxfd then
264 out_error("server.lua: Disallowed FD number: "..socket:getfd()) -- PROTIP: Switch to libevent
265 socket:close( ) -- Should we send some kind of error here?
269 return nil, nil, "fd-too-large"
271 socket:settimeout( 0 )
273 --// local import of socket methods //--
279 --// private closures of the object //--
283 local dispatch = listeners.onincoming
284 local status = listeners.onstatus
285 local disconnect = listeners.ondisconnect
286 local drain = listeners.ondrain
288 local bufferqueue = { } -- buffer array
289 local bufferqueuelen = 0 -- end of buffer array
300 local sendtraffic, readtraffic = 0, 0
302 local maxsendlen = _maxsendlen
303 local maxreadlen = _maxreadlen
305 --// public methods of the object //--
307 local handler = bufferqueue -- saves a table ^_^
309 handler.dispatch = function( )
312 handler.disconnect = function( )
315 handler.setlistener = function( self, listeners )
316 dispatch = listeners.onincoming
317 disconnect = listeners.ondisconnect
318 status = listeners.onstatus
319 drain = listeners.ondrain
321 handler.getstats = function( )
322 return readtraffic, sendtraffic
324 handler.ssl = function( )
327 handler.sslctx = function ( )
330 handler.send = function( _, data, i, j )
331 return send( socket, data, i, j )
333 handler.receive = function( pattern, prefix )
334 return receive( socket, pattern, prefix )
336 handler.shutdown = function( pattern )
337 return shutdown( socket, pattern )
339 handler.setoption = function (self, option, value)
340 if socket.setoption then
341 return socket:setoption(option, value);
343 return false, "setoption not implemented";
345 handler.force_close = function ( self, err )
346 if bufferqueuelen ~= 0 then
347 out_put("server.lua: discarding unwritten data for ", tostring(ip), ":", tostring(clientport))
350 return self:close(err);
352 handler.close = function( self, err )
353 if not handler then return true; end
354 _readlistlen = removesocket( _readlist, socket, _readlistlen )
355 _readtimes[ handler ] = nil
356 if bufferqueuelen ~= 0 then
357 handler.sendbuffer() -- Try now to send any outstanding data
358 if bufferqueuelen ~= 0 then -- Still not empty, so we'll try again later
360 handler.write = nil -- ... but no further writing allowed
367 _ = shutdown and shutdown( socket )
369 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
370 _socketlist[ socket ] = nil
373 out_put "server.lua: socket already closed"
376 _writetimes[ handler ] = nil
377 _closelist[ handler ] = nil
378 local _handler = handler;
381 disconnect(_handler, err or false);
388 out_put "server.lua: closed client handler and removed socket from list"
391 handler.ip = function( )
394 handler.serverport = function( )
397 handler.clientport = function( )
400 handler.port = handler.clientport -- COMPAT server_event
401 local write = function( self, data )
402 bufferlen = bufferlen + #data
403 if bufferlen > maxsendlen then
404 _closelist[ handler ] = "send buffer exceeded" -- cannot close the client at the moment, have to wait to the end of the cycle
405 handler.write = idfalse -- dont write anymore
407 elseif socket and not _sendlist[ socket ] then
408 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
410 bufferqueuelen = bufferqueuelen + 1
411 bufferqueue[ bufferqueuelen ] = data
413 _writetimes[ handler ] = _writetimes[ handler ] or _currenttime
417 handler.write = write
418 handler.bufferqueue = function( self )
421 handler.socket = function( self )
424 handler.set_mode = function( self, new )
425 pattern = new or pattern
428 handler.set_send = function ( self, newsend )
429 send = newsend or send
432 handler.bufferlen = function( self, readlen, sendlen )
433 maxsendlen = sendlen or maxsendlen
434 maxreadlen = readlen or maxreadlen
435 return bufferlen, maxreadlen, maxsendlen
438 handler.lock_read = function (self, switch)
439 if switch == true then
440 local tmp = _readlistlen
441 _readlistlen = removesocket( _readlist, socket, _readlistlen )
442 _readtimes[ handler ] = nil
443 if _readlistlen ~= tmp then
446 elseif switch == false then
449 _readlistlen = addsocket(_readlist, socket, _readlistlen)
450 _readtimes[ handler ] = _currenttime
455 handler.pause = function (self)
456 return self:lock_read(true);
458 handler.resume = function (self)
459 return self:lock_read(false);
461 handler.lock = function( self, switch )
462 handler.lock_read (switch)
463 if switch == true then
464 handler.write = idfalse
465 local tmp = _sendlistlen
466 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
467 _writetimes[ handler ] = nil
468 if _sendlistlen ~= tmp then
471 elseif switch == false then
472 handler.write = write
478 return noread, nosend
480 local _readbuffer = function( ) -- this function reads data
481 local buffer, err, part = receive( socket, pattern ) -- receive buffer with "pattern"
482 if not err or (err == "wantread" or err == "timeout") then -- received something
483 local buffer = buffer or part or ""
485 if len > maxreadlen then
486 handler:close( "receive buffer exceeded" )
489 local count = len * STAT_UNIT
490 readtraffic = readtraffic + count
491 _readtraffic = _readtraffic + count
492 _readtimes[ handler ] = _currenttime
493 --out_put( "server.lua: read data '", buffer:gsub("[^%w%p ]", "."), "', error: ", err )
494 return dispatch( handler, buffer, err )
495 else -- connections was closed or fatal error
496 out_put( "server.lua: client ", tostring(ip), ":", tostring(clientport), " read error: ", tostring(err) )
498 _ = handler and handler:force_close( err )
502 local _sendbuffer = function( ) -- this function sends data
503 local succ, err, byte, buffer, count;
505 buffer = table_concat( bufferqueue, "", 1, bufferqueuelen )
506 succ, err, byte = send( socket, buffer, 1, bufferlen )
507 count = ( succ or byte or 0 ) * STAT_UNIT
508 sendtraffic = sendtraffic + count
509 _sendtraffic = _sendtraffic + count
510 for i = bufferqueuelen,1,-1 do
511 bufferqueue[ i ] = nil
513 --out_put( "server.lua: sended '", buffer, "', bytes: ", tostring(succ), ", error: ", tostring(err), ", part: ", tostring(byte), ", to: ", tostring(ip), ":", tostring(clientport) )
515 succ, err, count = false, "unexpected close", 0;
517 if succ then -- sending succesful
520 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen ) -- delete socket from writelist
521 _writetimes[ handler ] = nil
525 _ = needtls and handler:starttls(nil)
526 _ = toclose and handler:force_close( )
528 elseif byte and ( err == "timeout" or err == "wantwrite" ) then -- want write
529 buffer = string_sub( buffer, byte + 1, bufferlen ) -- new buffer
530 bufferqueue[ 1 ] = buffer -- insert new buffer in queue
532 bufferlen = bufferlen - byte
533 _writetimes[ handler ] = _currenttime
535 else -- connection was closed during sending or fatal error
536 out_put( "server.lua: client ", tostring(ip), ":", tostring(clientport), " write error: ", tostring(err) )
538 _ = handler and handler:force_close( err )
545 function handler.set_sslctx(self, new_sslctx)
548 handshake = coroutine_wrap( function( client ) -- create handshake coroutine
550 for i = 1, _maxsslhandshake do
551 _sendlistlen = ( wrote and removesocket( _sendlist, client, _sendlistlen ) ) or _sendlistlen
552 _readlistlen = ( read and removesocket( _readlist, client, _readlistlen ) ) or _readlistlen
553 read, wrote = nil, nil
554 _, err = client:dohandshake( )
556 out_put( "server.lua: ssl handshake done" )
557 handler.readbuffer = _readbuffer -- when handshake is done, replace the handshake function with regular functions
558 handler.sendbuffer = _sendbuffer
559 _ = status and status( handler, "ssl-handshake-complete" )
560 if self.autostart_ssl and listeners.onconnect then
561 listeners.onconnect(self);
563 _readlistlen = addsocket(_readlist, client, _readlistlen)
566 if err == "wantwrite" then
567 _sendlistlen = addsocket(_sendlist, client, _sendlistlen)
569 elseif err == "wantread" then
570 _readlistlen = addsocket(_readlist, client, _readlistlen)
576 coroutine_yield( ) -- handshake not finished
579 out_put( "server.lua: ssl handshake error: ", tostring(err or "handshake too long") )
580 _ = handler and handler:force_close("ssl handshake failed")
581 return false, err -- handshake failed
586 handler.starttls = function( self, _sslctx)
588 handler:set_sslctx(_sslctx);
590 if bufferqueuelen > 0 then
591 out_put "server.lua: we need to do tls, but delaying until send buffer empty"
595 out_put( "server.lua: attempting to start tls on " .. tostring( socket ) )
596 local oldsocket, err = socket
597 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
599 out_put( "server.lua: error while starting tls on client: ", tostring(err or "unknown error") )
600 return nil, err -- fatal error
603 socket:settimeout( 0 )
605 -- add the new socket to our system
607 receive = socket.receive
609 _socketlist[ socket ] = handler
610 _readlistlen = addsocket(_readlist, socket, _readlistlen)
612 -- remove traces of the old socket
613 _readlistlen = removesocket( _readlist, oldsocket, _readlistlen )
614 _sendlistlen = removesocket( _sendlist, oldsocket, _sendlistlen )
615 _socketlist[ oldsocket ] = nil
617 handler.starttls = nil
620 -- Secure now (if handshake fails connection will close)
623 handler.readbuffer = handshake
624 handler.sendbuffer = handshake
625 return handshake( socket ) -- do handshake
629 handler.readbuffer = _readbuffer
630 handler.sendbuffer = _sendbuffer
632 receive = socket.receive
633 shutdown = ( ssl and id ) or socket.shutdown
635 _socketlist[ socket ] = handler
636 _readlistlen = addsocket(_readlist, socket, _readlistlen)
638 if sslctx and luasec then
639 out_put "server.lua: auto-starting ssl negotiation..."
640 handler.autostart_ssl = true;
641 local ok, err = handler:starttls(sslctx);
647 return handler, socket
653 idfalse = function( )
657 addsocket = function( list, socket, len )
658 if not list[ socket ] then
666 removesocket = function( list, socket, len ) -- this function removes sockets from a list ( copied from copas )
667 local pos = list[ socket ]
670 local last = list[ len ]
672 if last ~= socket then
681 closesocket = function( socket )
682 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
683 _readlistlen = removesocket( _readlist, socket, _readlistlen )
684 _socketlist[ socket ] = nil
689 local function link(sender, receiver, buffersize)
691 local _sendbuffer = receiver.sendbuffer;
692 function receiver.sendbuffer()
694 if sender_locked and receiver.bufferlen() < buffersize then
695 sender:lock_read(false); -- Unlock now
700 local _readbuffer = sender.readbuffer;
701 function sender.readbuffer()
703 if not sender_locked and receiver.bufferlen() >= buffersize then
704 sender_locked = true;
705 sender:lock_read(true);
710 ----------------------------------// PUBLIC //--
712 addserver = function( addr, port, listeners, pattern, sslctx ) -- this function provides a way for other scripts to reg a server
714 if type( listeners ) ~= "table" then
715 err = "invalid listener table"
717 if type( port ) ~= "number" or not ( port >= 0 and port <= 65535 ) then
719 elseif _server[ addr..":"..port ] then
720 err = "listeners on '[" .. addr .. "]:" .. port .. "' already exist"
721 elseif sslctx and not luasec then
722 err = "luasec not found"
725 out_error( "server.lua, [", addr, "]:", port, ": ", err )
729 local server, err = socket_bind( addr, port, _tcpbacklog )
731 out_error( "server.lua, [", addr, "]:", port, ": ", err )
734 local handler, err = wrapserver( listeners, server, addr, port, pattern, sslctx ) -- wrap new server socket
739 server:settimeout( 0 )
740 _readlistlen = addsocket(_readlist, server, _readlistlen)
741 _server[ addr..":"..port ] = handler
742 _socketlist[ server ] = handler
743 out_put( "server.lua: new "..(sslctx and "ssl " or "").."server listener on '[", addr, "]:", port, "'" )
747 getserver = function ( addr, port )
748 return _server[ addr..":"..port ];
751 removeserver = function( addr, port )
752 local handler = _server[ addr..":"..port ]
754 return nil, "no server found on '[" .. addr .. "]:" .. tostring( port ) .. "'"
757 _server[ addr..":"..port ] = nil
761 closeall = function( )
762 for _, handler in pairs( _socketlist ) do
764 _socketlist[ _ ] = nil
777 getsettings = function( )
779 select_timeout = _selecttimeout;
780 select_sleep_time = _sleeptime;
781 tcp_backlog = _tcpbacklog;
782 max_send_buffer_size = _maxsendlen;
783 max_receive_buffer_size = _maxreadlen;
784 select_idle_check_interval = _checkinterval;
785 send_timeout = _sendtimeout;
786 read_timeout = _readtimeout;
787 max_connections = _maxselectlen;
788 max_ssl_handshake_roundtrips = _maxsslhandshake;
789 highest_allowed_fd = _maxfd;
793 changesettings = function( new )
794 if type( new ) ~= "table" then
795 return nil, "invalid settings table"
797 _selecttimeout = tonumber( new.select_timeout ) or _selecttimeout
798 _sleeptime = tonumber( new.select_sleep_time ) or _sleeptime
799 _maxsendlen = tonumber( new.max_send_buffer_size ) or _maxsendlen
800 _maxreadlen = tonumber( new.max_receive_buffer_size ) or _maxreadlen
801 _checkinterval = tonumber( new.select_idle_check_interval ) or _checkinterval
802 _tcpbacklog = tonumber( new.tcp_backlog ) or _tcpbacklog
803 _sendtimeout = tonumber( new.send_timeout ) or _sendtimeout
804 _readtimeout = tonumber( new.read_timeout ) or _readtimeout
805 _maxselectlen = new.max_connections or _maxselectlen
806 _maxsslhandshake = new.max_ssl_handshake_roundtrips or _maxsslhandshake
807 _maxfd = new.highest_allowed_fd or _maxfd
811 addtimer = function( listener )
812 if type( listener ) ~= "function" then
813 return nil, "invalid listener function"
815 _timerlistlen = _timerlistlen + 1
816 _timerlist[ _timerlistlen ] = listener
821 return _readtraffic, _sendtraffic, _readlistlen, _sendlistlen, _timerlistlen
826 local function setquitting(quit)
827 quitting = not not quit;
830 loop = function(once) -- this is the main loop of the program
831 if quitting then return "quitting"; end
832 if once then quitting = "once"; end
833 local next_timer_time = math_huge;
835 local read, write, err = socket_select( _readlist, _sendlist, math_min(_selecttimeout, next_timer_time) )
836 for i, socket in ipairs( write ) do -- send data waiting in writequeues
837 local handler = _socketlist[ socket ]
839 handler.sendbuffer( )
841 closesocket( socket )
842 out_put "server.lua: found no handler and closed socket (writelist)" -- this should not happen
845 for i, socket in ipairs( read ) do -- receive data
846 local handler = _socketlist[ socket ]
848 handler.readbuffer( )
850 closesocket( socket )
851 out_put "server.lua: found no handler and closed socket (readlist)" -- this can happen
854 for handler, err in pairs( _closelist ) do
855 handler.disconnect( )( handler, err )
856 handler:force_close() -- forced disconnect
857 _closelist[ handler ] = nil;
859 _currenttime = luasocket_gettime( )
861 -- Check for socket timeouts
862 local difftime = os_difftime( _currenttime - _starttime )
863 if difftime > _checkinterval then
864 _starttime = _currenttime
865 for handler, timestamp in pairs( _writetimes ) do
866 if os_difftime( _currenttime - timestamp ) > _sendtimeout then
867 --_writetimes[ handler ] = nil
868 handler.disconnect( )( handler, "send timeout" )
869 handler:force_close() -- forced disconnect
872 for handler, timestamp in pairs( _readtimes ) do
873 if os_difftime( _currenttime - timestamp ) > _readtimeout then
874 --_readtimes[ handler ] = nil
875 handler.disconnect( )( handler, "read timeout" )
876 handler:close( ) -- forced disconnect?
882 if _currenttime - _timer >= math_min(next_timer_time, 1) then
883 next_timer_time = math_huge;
884 for i = 1, _timerlistlen do
885 local t = _timerlist[ i ]( _currenttime ) -- fire timers
886 if t then next_timer_time = math_min(next_timer_time, t); end
888 _timer = _currenttime
890 next_timer_time = next_timer_time - (_currenttime - _timer);
893 -- wait some time (0 by default)
894 socket_sleep( _sleeptime )
896 if once and quitting == "once" then quitting = nil; return; end
900 local function step()
904 local function get_backend()
908 --// EXPERIMENTAL //--
910 local wrapclient = function( socket, ip, serverport, listeners, pattern, sslctx )
911 local handler, socket, err = wrapconnection( nil, listeners, socket, ip, serverport, "clientport", pattern, sslctx )
912 if not handler then return nil, err end
913 _socketlist[ socket ] = handler
915 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
916 if listeners.onconnect then
917 -- When socket is writeable, call onconnect
918 local _sendbuffer = handler.sendbuffer;
919 handler.sendbuffer = function ()
920 handler.sendbuffer = _sendbuffer;
921 listeners.onconnect(handler);
922 return _sendbuffer(); -- Send any queued outgoing data
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,