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 )
13 local clean = function( tbl )
14 for i, k in pairs( tbl ) do
19 local log, table_concat = require ("util.logger").init("socket"), table.concat;
20 local out_put = function (...) return log("debug", table_concat{...}); end
21 local out_error = function (...) return log("warn", table_concat{...}); end
23 ----------------------------------// DECLARATION //--
27 local STAT_UNIT = 1 -- byte
29 --// lua functions //--
31 local type = use "type"
32 local pairs = use "pairs"
33 local ipairs = use "ipairs"
34 local tonumber = use "tonumber"
35 local tostring = use "tostring"
40 local table = use "table"
41 local string = use "string"
42 local coroutine = use "coroutine"
44 --// lua lib methods //--
46 local os_difftime = os.difftime
47 local math_min = math.min
48 local math_huge = math.huge
49 local table_concat = table.concat
50 local string_len = string.len
51 local string_sub = string.sub
52 local coroutine_wrap = coroutine.wrap
53 local coroutine_yield = coroutine.yield
57 local luasec = use "ssl"
58 local luasocket = use "socket" or require "socket"
59 local luasocket_gettime = luasocket.gettime
61 --// extern lib methods //--
63 local ssl_wrap = ( luasec and luasec.wrap )
64 local socket_bind = luasocket.bind
65 local socket_sleep = luasocket.sleep
66 local socket_select = luasocket.select
98 --// simple data types //--
125 local _maxclientsperserver
127 local _maxsslhandshake
129 ----------------------------------// DEFINITION //--
131 _server = { } -- key = port, value = table; list of listening servers
132 _readlist = { } -- array with sockets to read from
133 _sendlist = { } -- arrary with sockets to write to
134 _timerlist = { } -- array of timer functions
135 _socketlist = { } -- key = socket, value = wrapped socket (handlers)
136 _readtimes = { } -- key = handler, value = timestamp of last data reading
137 _writetimes = { } -- key = handler, value = timestamp of last data writing/sending
138 _closelist = { } -- handlers to close
140 _readlistlen = 0 -- length of readlist
141 _sendlistlen = 0 -- length of sendlist
142 _timerlistlen = 0 -- lenght of timerlist
144 _sendtraffic = 0 -- some stats
147 _selecttimeout = 1 -- timeout of socket.select
148 _sleeptime = 0 -- time to wait at the end of every loop
150 _maxsendlen = 51000 * 1024 -- max len of send buffer
151 _maxreadlen = 25000 * 1024 -- max len of read buffer
153 _checkinterval = 1200000 -- interval in secs to check idle clients
154 _sendtimeout = 60000 -- allowed send idle time in secs
155 _readtimeout = 6 * 60 * 60 -- allowed read idle time in secs
157 _cleanqueue = false -- clean bufferqueue after using
159 _maxclientsperserver = 1000
161 _maxsslhandshake = 30 -- max handshake round-trips
163 ----------------------------------// PRIVATE //--
165 wrapserver = function( listeners, socket, ip, serverport, pattern, sslctx, maxconnections ) -- this function wraps a server
167 maxconnections = maxconnections or _maxclientsperserver
169 local connections = 0
171 local dispatch, disconnect = listeners.onconnect, listeners.ondisconnect
173 local accept = socket.accept
175 --// public methods of the object //--
179 handler.shutdown = function( ) end
181 handler.ssl = function( )
184 handler.sslctx = function( )
187 handler.remove = function( )
188 connections = connections - 1
193 handler.close = function()
195 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
196 _readlistlen = removesocket( _readlist, socket, _readlistlen )
197 _server[ip..":"..serverport] = nil;
198 _socketlist[ socket ] = nil
202 out_put "server.lua: closed server handler and removed sockets from list"
204 handler.pause = function()
205 if not handler.paused then
207 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
208 _readlistlen = removesocket( _readlist, socket, _readlistlen )
209 _socketlist[ socket ] = nil
211 handler.paused = true;
214 handler.resume = function()
215 if handler.paused then
216 socket = socket_bind( ip, serverport );
217 socket:settimeout( 0 )
218 _readlistlen = addsocket(_readlist, socket, _readlistlen)
219 _socketlist[ socket ] = handler
220 handler.paused = false;
223 handler.ip = function( )
226 handler.serverport = function( )
229 handler.socket = function( )
232 handler.readbuffer = function( )
233 if connections > maxconnections then
235 out_put( "server.lua: refused new client connection: server full" )
238 local client, err = accept( socket ) -- try to accept
240 local ip, clientport = client:getpeername( )
241 client:settimeout( 0 )
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))
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 socket:settimeout( 0 )
264 --// local import of socket methods //--
270 --// private closures of the object //--
274 local dispatch = listeners.onincoming
275 local status = listeners.onstatus
276 local disconnect = listeners.ondisconnect
277 local drain = listeners.ondrain
279 local bufferqueue = { } -- buffer array
280 local bufferqueuelen = 0 -- end of buffer array
291 local sendtraffic, readtraffic = 0, 0
293 local maxsendlen = _maxsendlen
294 local maxreadlen = _maxreadlen
296 --// public methods of the object //--
298 local handler = bufferqueue -- saves a table ^_^
300 handler.dispatch = function( )
303 handler.disconnect = function( )
306 handler.setlistener = function( self, listeners )
307 dispatch = listeners.onincoming
308 disconnect = listeners.ondisconnect
309 status = listeners.onstatus
310 drain = listeners.ondrain
312 handler.getstats = function( )
313 return readtraffic, sendtraffic
315 handler.ssl = function( )
318 handler.sslctx = function ( )
321 handler.send = function( _, data, i, j )
322 return send( socket, data, i, j )
324 handler.receive = function( pattern, prefix )
325 return receive( socket, pattern, prefix )
327 handler.shutdown = function( pattern )
328 return shutdown( socket, pattern )
330 handler.setoption = function (self, option, value)
331 if socket.setoption then
332 return socket:setoption(option, value);
334 return false, "setoption not implemented";
336 handler.force_close = function ( self, err )
337 if bufferqueuelen ~= 0 then
338 out_put("server.lua: discarding unwritten data for ", tostring(ip), ":", tostring(clientport))
339 for i = bufferqueuelen, 1, -1 do
340 bufferqueue[i] = nil;
344 return self:close(err);
346 handler.close = function( self, err )
347 if not handler then return true; end
348 _readlistlen = removesocket( _readlist, socket, _readlistlen )
349 _readtimes[ handler ] = nil
350 if bufferqueuelen ~= 0 then
351 handler.sendbuffer() -- Try now to send any outstanding data
352 if bufferqueuelen ~= 0 then -- Still not empty, so we'll try again later
354 handler.write = nil -- ... but no further writing allowed
361 _ = shutdown and shutdown( socket )
363 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
364 _socketlist[ socket ] = nil
367 out_put "server.lua: socket already closed"
370 _writetimes[ handler ] = nil
371 _closelist[ handler ] = nil
372 local _handler = handler;
375 disconnect(_handler, err or false);
382 out_put "server.lua: closed client handler and removed socket from list"
385 handler.ip = function( )
388 handler.serverport = function( )
391 handler.clientport = function( )
394 local write = function( self, data )
395 bufferlen = bufferlen + string_len( data )
396 if bufferlen > maxsendlen then
397 _closelist[ handler ] = "send buffer exceeded" -- cannot close the client at the moment, have to wait to the end of the cycle
398 handler.write = idfalse -- dont write anymore
400 elseif socket and not _sendlist[ socket ] then
401 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
403 bufferqueuelen = bufferqueuelen + 1
404 bufferqueue[ bufferqueuelen ] = data
406 _writetimes[ handler ] = _writetimes[ handler ] or _currenttime
410 handler.write = write
411 handler.bufferqueue = function( self )
414 handler.socket = function( self )
417 handler.set_mode = function( self, new )
418 pattern = new or pattern
421 handler.set_send = function ( self, newsend )
422 send = newsend or send
425 handler.bufferlen = function( self, readlen, sendlen )
426 maxsendlen = sendlen or maxsendlen
427 maxreadlen = readlen or maxreadlen
428 return bufferlen, maxreadlen, maxsendlen
431 handler.lock_read = function (self, switch)
432 if switch == true then
433 local tmp = _readlistlen
434 _readlistlen = removesocket( _readlist, socket, _readlistlen )
435 _readtimes[ handler ] = nil
436 if _readlistlen ~= tmp then
439 elseif switch == false then
442 _readlistlen = addsocket(_readlist, socket, _readlistlen)
443 _readtimes[ handler ] = _currenttime
448 handler.pause = function (self)
449 return self:lock_read(true);
451 handler.resume = function (self)
452 return self:lock_read(false);
454 handler.lock = function( self, switch )
455 handler.lock_read (switch)
456 if switch == true then
457 handler.write = idfalse
458 local tmp = _sendlistlen
459 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
460 _writetimes[ handler ] = nil
461 if _sendlistlen ~= tmp then
464 elseif switch == false then
465 handler.write = write
471 return noread, nosend
473 local _readbuffer = function( ) -- this function reads data
474 local buffer, err, part = receive( socket, pattern ) -- receive buffer with "pattern"
475 if not err or (err == "wantread" or err == "timeout") then -- received something
476 local buffer = buffer or part or ""
477 local len = string_len( buffer )
478 if len > maxreadlen then
479 handler:close( "receive buffer exceeded" )
482 local count = len * STAT_UNIT
483 readtraffic = readtraffic + count
484 _readtraffic = _readtraffic + count
485 _readtimes[ handler ] = _currenttime
486 --out_put( "server.lua: read data '", buffer:gsub("[^%w%p ]", "."), "', error: ", err )
487 return dispatch( handler, buffer, err )
488 else -- connections was closed or fatal error
489 out_put( "server.lua: client ", tostring(ip), ":", tostring(clientport), " read error: ", tostring(err) )
491 _ = handler and handler:force_close( err )
495 local _sendbuffer = function( ) -- this function sends data
496 local succ, err, byte, buffer, count;
498 buffer = table_concat( bufferqueue, "", 1, bufferqueuelen )
499 succ, err, byte = send( socket, buffer, 1, bufferlen )
500 count = ( succ or byte or 0 ) * STAT_UNIT
501 sendtraffic = sendtraffic + count
502 _sendtraffic = _sendtraffic + count
503 _ = _cleanqueue and clean( bufferqueue )
504 --out_put( "server.lua: sended '", buffer, "', bytes: ", tostring(succ), ", error: ", tostring(err), ", part: ", tostring(byte), ", to: ", tostring(ip), ":", tostring(clientport) )
506 succ, err, count = false, "unexpected close", 0;
508 if succ then -- sending succesful
511 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen ) -- delete socket from writelist
512 _writetimes[ handler ] = nil
516 _ = needtls and handler:starttls(nil)
517 _ = toclose and handler:force_close( )
519 elseif byte and ( err == "timeout" or err == "wantwrite" ) then -- want write
520 buffer = string_sub( buffer, byte + 1, bufferlen ) -- new buffer
521 bufferqueue[ 1 ] = buffer -- insert new buffer in queue
523 bufferlen = bufferlen - byte
524 _writetimes[ handler ] = _currenttime
526 else -- connection was closed during sending or fatal error
527 out_put( "server.lua: client ", tostring(ip), ":", tostring(clientport), " write error: ", tostring(err) )
529 _ = handler and handler:force_close( err )
536 function handler.set_sslctx(self, new_sslctx)
539 handshake = coroutine_wrap( function( client ) -- create handshake coroutine
541 for i = 1, _maxsslhandshake do
542 _sendlistlen = ( wrote and removesocket( _sendlist, client, _sendlistlen ) ) or _sendlistlen
543 _readlistlen = ( read and removesocket( _readlist, client, _readlistlen ) ) or _readlistlen
544 read, wrote = nil, nil
545 _, err = client:dohandshake( )
547 out_put( "server.lua: ssl handshake done" )
548 handler.readbuffer = _readbuffer -- when handshake is done, replace the handshake function with regular functions
549 handler.sendbuffer = _sendbuffer
550 _ = status and status( handler, "ssl-handshake-complete" )
551 if self.autostart_ssl and listeners.onconnect then
552 listeners.onconnect(self);
554 _readlistlen = addsocket(_readlist, client, _readlistlen)
557 if err == "wantwrite" then
558 _sendlistlen = addsocket(_sendlist, client, _sendlistlen)
560 elseif err == "wantread" then
561 _readlistlen = addsocket(_readlist, client, _readlistlen)
567 coroutine_yield( ) -- handshake not finished
570 out_put( "server.lua: ssl handshake error: ", tostring(err or "handshake too long") )
571 _ = handler and handler:force_close("ssl handshake failed")
572 return false, err -- handshake failed
577 handler.starttls = function( self, _sslctx)
579 handler:set_sslctx(_sslctx);
581 if bufferqueuelen > 0 then
582 out_put "server.lua: we need to do tls, but delaying until send buffer empty"
586 out_put( "server.lua: attempting to start tls on " .. tostring( socket ) )
587 local oldsocket, err = socket
588 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
590 out_put( "server.lua: error while starting tls on client: ", tostring(err or "unknown error") )
591 return nil, err -- fatal error
594 socket:settimeout( 0 )
596 -- add the new socket to our system
598 receive = socket.receive
600 _socketlist[ socket ] = handler
601 _readlistlen = addsocket(_readlist, socket, _readlistlen)
603 -- remove traces of the old socket
604 _readlistlen = removesocket( _readlist, oldsocket, _readlistlen )
605 _sendlistlen = removesocket( _sendlist, oldsocket, _sendlistlen )
606 _socketlist[ oldsocket ] = nil
608 handler.starttls = nil
611 -- Secure now (if handshake fails connection will close)
614 handler.readbuffer = handshake
615 handler.sendbuffer = handshake
616 return handshake( socket ) -- do handshake
620 handler.readbuffer = _readbuffer
621 handler.sendbuffer = _sendbuffer
623 receive = socket.receive
624 shutdown = ( ssl and id ) or socket.shutdown
626 _socketlist[ socket ] = handler
627 _readlistlen = addsocket(_readlist, socket, _readlistlen)
629 if sslctx and luasec then
630 out_put "server.lua: auto-starting ssl negotiation..."
631 handler.autostart_ssl = true;
632 local ok, err = handler:starttls(sslctx);
638 return handler, socket
644 idfalse = function( )
648 addsocket = function( list, socket, len )
649 if not list[ socket ] then
657 removesocket = function( list, socket, len ) -- this function removes sockets from a list ( copied from copas )
658 local pos = list[ socket ]
661 local last = list[ len ]
663 if last ~= socket then
672 closesocket = function( socket )
673 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
674 _readlistlen = removesocket( _readlist, socket, _readlistlen )
675 _socketlist[ socket ] = nil
680 local function link(sender, receiver, buffersize)
682 local _sendbuffer = receiver.sendbuffer;
683 function receiver.sendbuffer()
685 if sender_locked and receiver.bufferlen() < buffersize then
686 sender:lock_read(false); -- Unlock now
691 local _readbuffer = sender.readbuffer;
692 function sender.readbuffer()
694 if not sender_locked and receiver.bufferlen() >= buffersize then
695 sender_locked = true;
696 sender:lock_read(true);
701 ----------------------------------// PUBLIC //--
703 addserver = function( addr, port, listeners, pattern, sslctx ) -- this function provides a way for other scripts to reg a server
705 if type( listeners ) ~= "table" then
706 err = "invalid listener table"
708 if type( port ) ~= "number" or not ( port >= 0 and port <= 65535 ) then
710 elseif _server[ addr..":"..port ] then
711 err = "listeners on '[" .. addr .. "]:" .. port .. "' already exist"
712 elseif sslctx and not luasec then
713 err = "luasec not found"
716 out_error( "server.lua, [", addr, "]:", port, ": ", err )
720 local server, err = socket_bind( addr, port )
722 out_error( "server.lua, [", addr, "]:", port, ": ", err )
725 local handler, err = wrapserver( listeners, server, addr, port, pattern, sslctx, _maxclientsperserver ) -- wrap new server socket
730 server:settimeout( 0 )
731 _readlistlen = addsocket(_readlist, server, _readlistlen)
732 _server[ addr..":"..port ] = handler
733 _socketlist[ server ] = handler
734 out_put( "server.lua: new "..(sslctx and "ssl " or "").."server listener on '[", addr, "]:", port, "'" )
738 getserver = function ( addr, port )
739 return _server[ addr..":"..port ];
742 removeserver = function( addr, port )
743 local handler = _server[ addr..":"..port ]
745 return nil, "no server found on '[" .. addr .. "]:" .. tostring( port ) .. "'"
748 _server[ addr..":"..port ] = nil
752 closeall = function( )
753 for _, handler in pairs( _socketlist ) do
755 _socketlist[ _ ] = nil
768 getsettings = function( )
769 return _selecttimeout, _sleeptime, _maxsendlen, _maxreadlen, _checkinterval, _sendtimeout, _readtimeout, _cleanqueue, _maxclientsperserver, _maxsslhandshake
772 changesettings = function( new )
773 if type( new ) ~= "table" then
774 return nil, "invalid settings table"
776 _selecttimeout = tonumber( new.select_timeout ) or _selecttimeout
777 _sleeptime = tonumber( new.select_sleep_time ) or _sleeptime
778 _maxsendlen = tonumber( new.max_send_buffer_size ) or _maxsendlen
779 _maxreadlen = tonumber( new.max_receive_buffer_size ) or _maxreadlen
780 _checkinterval = tonumber( new.select_idle_check_interval ) or _checkinterval
781 _sendtimeout = tonumber( new.send_timeout ) or _sendtimeout
782 _readtimeout = tonumber( new.read_timeout ) or _readtimeout
783 _cleanqueue = new.select_clean_queue
784 _maxclientsperserver = new.max_connections or _maxclientsperserver
785 _maxsslhandshake = new.max_ssl_handshake_roundtrips or _maxsslhandshake
789 addtimer = function( listener )
790 if type( listener ) ~= "function" then
791 return nil, "invalid listener function"
793 _timerlistlen = _timerlistlen + 1
794 _timerlist[ _timerlistlen ] = listener
799 return _readtraffic, _sendtraffic, _readlistlen, _sendlistlen, _timerlistlen
804 local function setquitting(quit)
805 quitting = not not quit;
808 loop = function(once) -- this is the main loop of the program
809 if quitting then return "quitting"; end
810 if once then quitting = "once"; end
811 local next_timer_time = math_huge;
813 local read, write, err = socket_select( _readlist, _sendlist, math_min(_selecttimeout, next_timer_time) )
814 for i, socket in ipairs( write ) do -- send data waiting in writequeues
815 local handler = _socketlist[ socket ]
817 handler.sendbuffer( )
819 closesocket( socket )
820 out_put "server.lua: found no handler and closed socket (writelist)" -- this should not happen
823 for i, socket in ipairs( read ) do -- receive data
824 local handler = _socketlist[ socket ]
826 handler.readbuffer( )
828 closesocket( socket )
829 out_put "server.lua: found no handler and closed socket (readlist)" -- this can happen
832 for handler, err in pairs( _closelist ) do
833 handler.disconnect( )( handler, err )
834 handler:force_close() -- forced disconnect
837 _currenttime = luasocket_gettime( )
838 if _currenttime - _timer >= math_min(next_timer_time, 1) then
839 next_timer_time = math_huge;
840 for i = 1, _timerlistlen do
841 local t = _timerlist[ i ]( _currenttime ) -- fire timers
842 if t then next_timer_time = math_min(next_timer_time, t); end
844 _timer = _currenttime
846 next_timer_time = next_timer_time - (_currenttime - _timer);
848 socket_sleep( _sleeptime ) -- wait some time
851 if once and quitting == "once" then quitting = nil; return; end
855 local function step()
859 local function get_backend()
863 --// EXPERIMENTAL //--
865 local wrapclient = function( socket, ip, serverport, listeners, pattern, sslctx )
866 local handler = wrapconnection( nil, listeners, socket, ip, serverport, "clientport", pattern, sslctx )
867 _socketlist[ socket ] = handler
869 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
870 if listeners.onconnect then
871 -- When socket is writeable, call onconnect
872 local _sendbuffer = handler.sendbuffer;
873 handler.sendbuffer = function ()
874 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen );
875 handler.sendbuffer = _sendbuffer;
876 listeners.onconnect(handler);
877 -- If there was data with the incoming packet, handle it now.
878 if #handler:bufferqueue() > 0 then
879 return _sendbuffer();
884 return handler, socket
887 local addclient = function( address, port, listeners, pattern, sslctx )
888 local client, err = luasocket.tcp( )
892 client:settimeout( 0 )
893 _, err = client:connect( address, port )
894 if err then -- try again
895 local handler = wrapclient( client, address, port, listeners )
897 wrapconnection( nil, listeners, client, address, port, "clientport", pattern, sslctx )
901 --// EXPERIMENTAL //--
903 ----------------------------------// BEGIN //--
905 use "setmetatable" ( _socketlist, { __mode = "k" } )
906 use "setmetatable" ( _readtimes, { __mode = "k" } )
907 use "setmetatable" ( _writetimes, { __mode = "k" } )
909 _timer = luasocket_gettime( )
910 _starttime = luasocket_gettime( )
912 addtimer( function( )
913 local difftime = os_difftime( _currenttime - _starttime )
914 if difftime > _checkinterval then
915 _starttime = _currenttime
916 for handler, timestamp in pairs( _writetimes ) do
917 if os_difftime( _currenttime - timestamp ) > _sendtimeout then
918 --_writetimes[ handler ] = nil
919 handler.disconnect( )( handler, "send timeout" )
920 handler:force_close() -- forced disconnect
923 for handler, timestamp in pairs( _readtimes ) do
924 if os_difftime( _currenttime - timestamp ) > _readtimeout then
925 --_readtimes[ handler ] = nil
926 handler.disconnect( )( handler, "read timeout" )
927 handler:close( ) -- forced disconnect?
934 local function setlogger(new_logger)
935 local old_logger = log;
942 ----------------------------------// PUBLIC INTERFACE //--
945 _addtimer = addtimer,
947 addclient = addclient,
948 wrapclient = wrapclient,
955 addserver = addserver,
956 getserver = getserver,
957 setlogger = setlogger,
958 getsettings = getsettings,
959 setquitting = setquitting,
960 removeserver = removeserver,
961 get_backend = get_backend,
962 changesettings = changesettings,