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 local handler, client, err = wrapconnection( handler, listeners, client, ip, serverport, clientport, pattern, sslctx ) -- wrap new client socket
242 if err then -- error while wrapping ssl socket
245 connections = connections + 1
246 out_put( "server.lua: accepted new client connection from ", tostring(ip), ":", tostring(clientport), " to ", tostring(serverport))
248 return dispatch( handler );
251 elseif err then -- maybe timeout or something else
252 out_put( "server.lua: error with new client connection: ", tostring(err) )
259 wrapconnection = function( server, listeners, socket, ip, serverport, clientport, pattern, sslctx ) -- this function wraps a client to a handler object
261 socket:settimeout( 0 )
263 --// local import of socket methods //--
269 --// private closures of the object //--
273 local dispatch = listeners.onincoming
274 local status = listeners.onstatus
275 local disconnect = listeners.ondisconnect
276 local drain = listeners.ondrain
278 local bufferqueue = { } -- buffer array
279 local bufferqueuelen = 0 -- end of buffer array
290 local sendtraffic, readtraffic = 0, 0
292 local maxsendlen = _maxsendlen
293 local maxreadlen = _maxreadlen
295 --// public methods of the object //--
297 local handler = bufferqueue -- saves a table ^_^
299 handler.dispatch = function( )
302 handler.disconnect = function( )
305 handler.setlistener = function( self, listeners )
306 dispatch = listeners.onincoming
307 disconnect = listeners.ondisconnect
308 status = listeners.onstatus
309 drain = listeners.ondrain
311 handler.getstats = function( )
312 return readtraffic, sendtraffic
314 handler.ssl = function( )
317 handler.sslctx = function ( )
320 handler.send = function( _, data, i, j )
321 return send( socket, data, i, j )
323 handler.receive = function( pattern, prefix )
324 return receive( socket, pattern, prefix )
326 handler.shutdown = function( pattern )
327 return shutdown( socket, pattern )
329 handler.setoption = function (self, option, value)
330 if socket.setoption then
331 return socket:setoption(option, value);
333 return false, "setoption not implemented";
335 handler.force_close = function ( self, err )
336 if bufferqueuelen ~= 0 then
337 out_put("server.lua: discarding unwritten data for ", tostring(ip), ":", tostring(clientport))
338 for i = bufferqueuelen, 1, -1 do
339 bufferqueue[i] = nil;
343 return self:close(err);
345 handler.close = function( self, err )
346 if not handler then return true; end
347 _readlistlen = removesocket( _readlist, socket, _readlistlen )
348 _readtimes[ handler ] = nil
349 if bufferqueuelen ~= 0 then
350 handler.sendbuffer() -- Try now to send any outstanding data
351 if bufferqueuelen ~= 0 then -- Still not empty, so we'll try again later
353 handler.write = nil -- ... but no further writing allowed
360 _ = shutdown and shutdown( socket )
362 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
363 _socketlist[ socket ] = nil
366 out_put "server.lua: socket already closed"
369 _writetimes[ handler ] = nil
370 _closelist[ handler ] = nil
371 local _handler = handler;
374 disconnect(_handler, err or false);
381 out_put "server.lua: closed client handler and removed socket from list"
384 handler.ip = function( )
387 handler.serverport = function( )
390 handler.clientport = function( )
393 local write = function( self, data )
394 bufferlen = bufferlen + string_len( data )
395 if bufferlen > maxsendlen then
396 _closelist[ handler ] = "send buffer exceeded" -- cannot close the client at the moment, have to wait to the end of the cycle
397 handler.write = idfalse -- dont write anymore
399 elseif socket and not _sendlist[ socket ] then
400 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
402 bufferqueuelen = bufferqueuelen + 1
403 bufferqueue[ bufferqueuelen ] = data
405 _writetimes[ handler ] = _writetimes[ handler ] or _currenttime
409 handler.write = write
410 handler.bufferqueue = function( self )
413 handler.socket = function( self )
416 handler.set_mode = function( self, new )
417 pattern = new or pattern
420 handler.set_send = function ( self, newsend )
421 send = newsend or send
424 handler.bufferlen = function( self, readlen, sendlen )
425 maxsendlen = sendlen or maxsendlen
426 maxreadlen = readlen or maxreadlen
427 return bufferlen, maxreadlen, maxsendlen
430 handler.lock_read = function (self, switch)
431 if switch == true then
432 local tmp = _readlistlen
433 _readlistlen = removesocket( _readlist, socket, _readlistlen )
434 _readtimes[ handler ] = nil
435 if _readlistlen ~= tmp then
438 elseif switch == false then
441 _readlistlen = addsocket(_readlist, socket, _readlistlen)
442 _readtimes[ handler ] = _currenttime
447 handler.pause = function (self)
448 return self:lock_read(true);
450 handler.resume = function (self)
451 return self:lock_read(false);
453 handler.lock = function( self, switch )
454 handler.lock_read (switch)
455 if switch == true then
456 handler.write = idfalse
457 local tmp = _sendlistlen
458 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
459 _writetimes[ handler ] = nil
460 if _sendlistlen ~= tmp then
463 elseif switch == false then
464 handler.write = write
470 return noread, nosend
472 local _readbuffer = function( ) -- this function reads data
473 local buffer, err, part = receive( socket, pattern ) -- receive buffer with "pattern"
474 if not err or (err == "wantread" or err == "timeout") then -- received something
475 local buffer = buffer or part or ""
476 local len = string_len( buffer )
477 if len > maxreadlen then
478 handler:close( "receive buffer exceeded" )
481 local count = len * STAT_UNIT
482 readtraffic = readtraffic + count
483 _readtraffic = _readtraffic + count
484 _readtimes[ handler ] = _currenttime
485 --out_put( "server.lua: read data '", buffer:gsub("[^%w%p ]", "."), "', error: ", err )
486 return dispatch( handler, buffer, err )
487 else -- connections was closed or fatal error
488 out_put( "server.lua: client ", tostring(ip), ":", tostring(clientport), " read error: ", tostring(err) )
490 _ = handler and handler:force_close( err )
494 local _sendbuffer = function( ) -- this function sends data
495 local succ, err, byte, buffer, count;
497 buffer = table_concat( bufferqueue, "", 1, bufferqueuelen )
498 succ, err, byte = send( socket, buffer, 1, bufferlen )
499 count = ( succ or byte or 0 ) * STAT_UNIT
500 sendtraffic = sendtraffic + count
501 _sendtraffic = _sendtraffic + count
502 _ = _cleanqueue and clean( bufferqueue )
503 --out_put( "server.lua: sended '", buffer, "', bytes: ", tostring(succ), ", error: ", tostring(err), ", part: ", tostring(byte), ", to: ", tostring(ip), ":", tostring(clientport) )
505 succ, err, count = false, "unexpected close", 0;
507 if succ then -- sending succesful
510 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen ) -- delete socket from writelist
511 _writetimes[ handler ] = nil
515 _ = needtls and handler:starttls(nil)
516 _ = toclose and handler:force_close( )
518 elseif byte and ( err == "timeout" or err == "wantwrite" ) then -- want write
519 buffer = string_sub( buffer, byte + 1, bufferlen ) -- new buffer
520 bufferqueue[ 1 ] = buffer -- insert new buffer in queue
522 bufferlen = bufferlen - byte
523 _writetimes[ handler ] = _currenttime
525 else -- connection was closed during sending or fatal error
526 out_put( "server.lua: client ", tostring(ip), ":", tostring(clientport), " write error: ", tostring(err) )
528 _ = handler and handler:force_close( err )
535 function handler.set_sslctx(self, new_sslctx)
538 handshake = coroutine_wrap( function( client ) -- create handshake coroutine
540 for i = 1, _maxsslhandshake do
541 _sendlistlen = ( wrote and removesocket( _sendlist, client, _sendlistlen ) ) or _sendlistlen
542 _readlistlen = ( read and removesocket( _readlist, client, _readlistlen ) ) or _readlistlen
543 read, wrote = nil, nil
544 _, err = client:dohandshake( )
546 out_put( "server.lua: ssl handshake done" )
547 handler.readbuffer = _readbuffer -- when handshake is done, replace the handshake function with regular functions
548 handler.sendbuffer = _sendbuffer
549 _ = status and status( handler, "ssl-handshake-complete" )
550 if self.autostart_ssl and listeners.onconnect then
551 listeners.onconnect(self);
553 _readlistlen = addsocket(_readlist, client, _readlistlen)
556 if err == "wantwrite" then
557 _sendlistlen = addsocket(_sendlist, client, _sendlistlen)
559 elseif err == "wantread" then
560 _readlistlen = addsocket(_readlist, client, _readlistlen)
566 coroutine_yield( ) -- handshake not finished
569 out_put( "server.lua: ssl handshake error: ", tostring(err or "handshake too long") )
570 _ = handler and handler:force_close("ssl handshake failed")
571 return false, err -- handshake failed
576 handler.starttls = function( self, _sslctx)
578 handler:set_sslctx(_sslctx);
580 if bufferqueuelen > 0 then
581 out_put "server.lua: we need to do tls, but delaying until send buffer empty"
585 out_put( "server.lua: attempting to start tls on " .. tostring( socket ) )
586 local oldsocket, err = socket
587 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
589 out_put( "server.lua: error while starting tls on client: ", tostring(err or "unknown error") )
590 return nil, err -- fatal error
593 socket:settimeout( 0 )
595 -- add the new socket to our system
597 receive = socket.receive
599 _socketlist[ socket ] = handler
600 _readlistlen = addsocket(_readlist, socket, _readlistlen)
602 -- remove traces of the old socket
603 _readlistlen = removesocket( _readlist, oldsocket, _readlistlen )
604 _sendlistlen = removesocket( _sendlist, oldsocket, _sendlistlen )
605 _socketlist[ oldsocket ] = nil
607 handler.starttls = nil
610 -- Secure now (if handshake fails connection will close)
613 handler.readbuffer = handshake
614 handler.sendbuffer = handshake
615 return handshake( socket ) -- do handshake
619 handler.readbuffer = _readbuffer
620 handler.sendbuffer = _sendbuffer
622 receive = socket.receive
623 shutdown = ( ssl and id ) or socket.shutdown
625 _socketlist[ socket ] = handler
626 _readlistlen = addsocket(_readlist, socket, _readlistlen)
628 if sslctx and luasec then
629 out_put "server.lua: auto-starting ssl negotiation..."
630 handler.autostart_ssl = true;
631 local ok, err = handler:starttls(sslctx);
637 return handler, socket
643 idfalse = function( )
647 addsocket = function( list, socket, len )
648 if not list[ socket ] then
656 removesocket = function( list, socket, len ) -- this function removes sockets from a list ( copied from copas )
657 local pos = list[ socket ]
660 local last = list[ len ]
662 if last ~= socket then
671 closesocket = function( socket )
672 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
673 _readlistlen = removesocket( _readlist, socket, _readlistlen )
674 _socketlist[ socket ] = nil
679 local function link(sender, receiver, buffersize)
681 local _sendbuffer = receiver.sendbuffer;
682 function receiver.sendbuffer()
684 if sender_locked and receiver.bufferlen() < buffersize then
685 sender:lock_read(false); -- Unlock now
690 local _readbuffer = sender.readbuffer;
691 function sender.readbuffer()
693 if not sender_locked and receiver.bufferlen() >= buffersize then
694 sender_locked = true;
695 sender:lock_read(true);
700 ----------------------------------// PUBLIC //--
702 addserver = function( addr, port, listeners, pattern, sslctx ) -- this function provides a way for other scripts to reg a server
704 if type( listeners ) ~= "table" then
705 err = "invalid listener table"
707 if type( port ) ~= "number" or not ( port >= 0 and port <= 65535 ) then
709 elseif _server[ addr..":"..port ] then
710 err = "listeners on '[" .. addr .. "]:" .. port .. "' already exist"
711 elseif sslctx and not luasec then
712 err = "luasec not found"
715 out_error( "server.lua, [", addr, "]:", port, ": ", err )
719 local server, err = socket_bind( addr, port )
721 out_error( "server.lua, [", addr, "]:", port, ": ", err )
724 local handler, err = wrapserver( listeners, server, addr, port, pattern, sslctx, _maxclientsperserver ) -- wrap new server socket
729 server:settimeout( 0 )
730 _readlistlen = addsocket(_readlist, server, _readlistlen)
731 _server[ addr..":"..port ] = handler
732 _socketlist[ server ] = handler
733 out_put( "server.lua: new "..(sslctx and "ssl " or "").."server listener on '[", addr, "]:", port, "'" )
737 getserver = function ( addr, port )
738 return _server[ addr..":"..port ];
741 removeserver = function( addr, port )
742 local handler = _server[ addr..":"..port ]
744 return nil, "no server found on '[" .. addr .. "]:" .. tostring( port ) .. "'"
747 _server[ addr..":"..port ] = nil
751 closeall = function( )
752 for _, handler in pairs( _socketlist ) do
754 _socketlist[ _ ] = nil
767 getsettings = function( )
768 return _selecttimeout, _sleeptime, _maxsendlen, _maxreadlen, _checkinterval, _sendtimeout, _readtimeout, _cleanqueue, _maxclientsperserver, _maxsslhandshake
771 changesettings = function( new )
772 if type( new ) ~= "table" then
773 return nil, "invalid settings table"
775 _selecttimeout = tonumber( new.select_timeout ) or _selecttimeout
776 _sleeptime = tonumber( new.select_sleep_time ) or _sleeptime
777 _maxsendlen = tonumber( new.max_send_buffer_size ) or _maxsendlen
778 _maxreadlen = tonumber( new.max_receive_buffer_size ) or _maxreadlen
779 _checkinterval = tonumber( new.select_idle_check_interval ) or _checkinterval
780 _sendtimeout = tonumber( new.send_timeout ) or _sendtimeout
781 _readtimeout = tonumber( new.read_timeout ) or _readtimeout
782 _cleanqueue = new.select_clean_queue
783 _maxclientsperserver = new.max_connections or _maxclientsperserver
784 _maxsslhandshake = new.max_ssl_handshake_roundtrips or _maxsslhandshake
788 addtimer = function( listener )
789 if type( listener ) ~= "function" then
790 return nil, "invalid listener function"
792 _timerlistlen = _timerlistlen + 1
793 _timerlist[ _timerlistlen ] = listener
798 return _readtraffic, _sendtraffic, _readlistlen, _sendlistlen, _timerlistlen
803 local function setquitting(quit)
804 quitting = not not quit;
807 loop = function(once) -- this is the main loop of the program
808 if quitting then return "quitting"; end
809 if once then quitting = "once"; end
810 local next_timer_time = math_huge;
812 local read, write, err = socket_select( _readlist, _sendlist, math_min(_selecttimeout, next_timer_time) )
813 for i, socket in ipairs( write ) do -- send data waiting in writequeues
814 local handler = _socketlist[ socket ]
816 handler.sendbuffer( )
818 closesocket( socket )
819 out_put "server.lua: found no handler and closed socket (writelist)" -- this should not happen
822 for i, socket in ipairs( read ) do -- receive data
823 local handler = _socketlist[ socket ]
825 handler.readbuffer( )
827 closesocket( socket )
828 out_put "server.lua: found no handler and closed socket (readlist)" -- this can happen
831 for handler, err in pairs( _closelist ) do
832 handler.disconnect( )( handler, err )
833 handler:force_close() -- forced disconnect
836 _currenttime = luasocket_gettime( )
837 if _currenttime - _timer >= math_min(next_timer_time, 1) then
838 next_timer_time = math_huge;
839 for i = 1, _timerlistlen do
840 local t = _timerlist[ i ]( _currenttime ) -- fire timers
841 if t then next_timer_time = math_min(next_timer_time, t); end
843 _timer = _currenttime
845 next_timer_time = next_timer_time - (_currenttime - _timer);
847 socket_sleep( _sleeptime ) -- wait some time
850 if once and quitting == "once" then quitting = nil; return; end
854 local function step()
858 local function get_backend()
862 --// EXPERIMENTAL //--
864 local wrapclient = function( socket, ip, serverport, listeners, pattern, sslctx )
865 local handler = wrapconnection( nil, listeners, socket, ip, serverport, "clientport", pattern, sslctx )
866 _socketlist[ socket ] = handler
868 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
869 if listeners.onconnect then
870 -- When socket is writeable, call onconnect
871 local _sendbuffer = handler.sendbuffer;
872 handler.sendbuffer = function ()
873 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen );
874 handler.sendbuffer = _sendbuffer;
875 listeners.onconnect(handler);
876 -- If there was data with the incoming packet, handle it now.
877 if #handler:bufferqueue() > 0 then
878 return _sendbuffer();
883 return handler, socket
886 local addclient = function( address, port, listeners, pattern, sslctx )
887 local client, err = luasocket.tcp( )
891 client:settimeout( 0 )
892 _, err = client:connect( address, port )
893 if err then -- try again
894 local handler = wrapclient( client, address, port, listeners )
896 wrapconnection( nil, listeners, client, address, port, "clientport", pattern, sslctx )
900 --// EXPERIMENTAL //--
902 ----------------------------------// BEGIN //--
904 use "setmetatable" ( _socketlist, { __mode = "k" } )
905 use "setmetatable" ( _readtimes, { __mode = "k" } )
906 use "setmetatable" ( _writetimes, { __mode = "k" } )
908 _timer = luasocket_gettime( )
909 _starttime = luasocket_gettime( )
911 addtimer( function( )
912 local difftime = os_difftime( _currenttime - _starttime )
913 if difftime > _checkinterval then
914 _starttime = _currenttime
915 for handler, timestamp in pairs( _writetimes ) do
916 if os_difftime( _currenttime - timestamp ) > _sendtimeout then
917 --_writetimes[ handler ] = nil
918 handler.disconnect( )( handler, "send timeout" )
919 handler:force_close() -- forced disconnect
922 for handler, timestamp in pairs( _readtimes ) do
923 if os_difftime( _currenttime - timestamp ) > _readtimeout then
924 --_readtimes[ handler ] = nil
925 handler.disconnect( )( handler, "read timeout" )
926 handler:close( ) -- forced disconnect?
933 local function setlogger(new_logger)
934 local old_logger = log;
941 ----------------------------------// PUBLIC INTERFACE //--
944 _addtimer = addtimer,
946 addclient = addclient,
947 wrapclient = wrapclient,
954 addserver = addserver,
955 getserver = getserver,
956 setlogger = setlogger,
957 getsettings = getsettings,
958 setquitting = setquitting,
959 removeserver = removeserver,
960 get_backend = get_backend,
961 changesettings = changesettings,