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
22 local mem_free = collectgarbage
24 ----------------------------------// DECLARATION //--
28 local STAT_UNIT = 1 -- byte
30 --// lua functions //--
32 local type = use "type"
33 local pairs = use "pairs"
34 local ipairs = use "ipairs"
35 local tostring = use "tostring"
36 local collectgarbage = use "collectgarbage"
41 local table = use "table"
42 local string = use "string"
43 local coroutine = use "coroutine"
45 --// lua lib methods //--
47 local os_time = os.time
48 local os_difftime = os.difftime
49 local table_concat = table.concat
50 local table_remove = table.remove
51 local string_len = string.len
52 local string_sub = string.sub
53 local coroutine_wrap = coroutine.wrap
54 local coroutine_yield = coroutine.yield
58 local luasec = use "ssl"
59 local luasocket = use "socket" or require "socket"
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
67 local ssl_newcontext = ( luasec and luasec.newcontext )
99 --// simple data types //--
126 local _maxclientsperserver
128 ----------------------------------// DEFINITION //--
130 _server = { } -- key = port, value = table; list of listening servers
131 _readlist = { } -- array with sockets to read from
132 _sendlist = { } -- arrary with sockets to write to
133 _timerlist = { } -- array of timer functions
134 _socketlist = { } -- key = socket, value = wrapped socket (handlers)
135 _readtimes = { } -- key = handler, value = timestamp of last data reading
136 _writetimes = { } -- key = handler, value = timestamp of last data writing/sending
137 _closelist = { } -- handlers to close
139 _readlistlen = 0 -- length of readlist
140 _sendlistlen = 0 -- length of sendlist
141 _timerlistlen = 0 -- lenght of timerlist
143 _sendtraffic = 0 -- some stats
146 _selecttimeout = 1 -- timeout of socket.select
147 _sleeptime = 0 -- time to wait at the end of every loop
149 _maxsendlen = 51000 * 1024 -- max len of send buffer
150 _maxreadlen = 25000 * 1024 -- max len of read buffer
152 _checkinterval = 1200000 -- interval in secs to check idle clients
153 _sendtimeout = 60000 -- allowed send idle time in secs
154 _readtimeout = 6 * 60 * 60 -- allowed read idle time in secs
156 _cleanqueue = false -- clean bufferqueue after using
158 _maxclientsperserver = 1000
160 _maxsslhandshake = 30 -- max handshake round-trips
162 ----------------------------------// PRIVATE //--
164 wrapserver = function( listeners, socket, ip, serverport, pattern, sslctx, maxconnections ) -- this function wraps a server
166 maxconnections = maxconnections or _maxclientsperserver
168 local connections = 0
170 local dispatch, disconnect = listeners.onincoming, 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
189 handler.close = function( )
190 for _, handler in pairs( _socketlist ) do
191 if handler.serverport == serverport then
192 handler.disconnect( handler, "server closed" )
193 handler:close( true )
197 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
198 _readlistlen = removesocket( _readlist, socket, _readlistlen )
199 _socketlist[ socket ] = nil
203 out_put "server.lua: closed server handler and removed sockets from list"
205 handler.ip = function( )
208 handler.serverport = function( )
211 handler.socket = function( )
214 handler.readbuffer = function( )
215 if connections > maxconnections then
216 out_put( "server.lua: refused new client connection: server full" )
219 local client, err = accept( socket ) -- try to accept
221 local ip, clientport = client:getpeername( )
222 client:settimeout( 0 )
223 local handler, client, err = wrapconnection( handler, listeners, client, ip, serverport, clientport, pattern, sslctx ) -- wrap new client socket
224 if err then -- error while wrapping ssl socket
227 connections = connections + 1
228 out_put( "server.lua: accepted new client connection from ", tostring(ip), ":", tostring(clientport), " to ", tostring(serverport))
229 return dispatch( handler )
230 elseif err then -- maybe timeout or something else
231 out_put( "server.lua: error with new client connection: ", tostring(err) )
238 wrapconnection = function( server, listeners, socket, ip, serverport, clientport, pattern, sslctx ) -- this function wraps a client to a handler object
240 socket:settimeout( 0 )
242 --// local import of socket methods //--
248 --// private closures of the object //--
252 local dispatch = listeners.onincoming
253 local status = listeners.onstatus
254 local disconnect = listeners.ondisconnect
255 local drain = listeners.ondrain
257 local bufferqueue = { } -- buffer array
258 local bufferqueuelen = 0 -- end of buffer array
269 local sendtraffic, readtraffic = 0, 0
271 local maxsendlen = _maxsendlen
272 local maxreadlen = _maxreadlen
274 --// public methods of the object //--
276 local handler = bufferqueue -- saves a table ^_^
278 handler.dispatch = function( )
281 handler.disconnect = function( )
284 handler.setlistener = function( self, listeners )
285 dispatch = listeners.onincoming
286 disconnect = listeners.ondisconnect
287 status = listeners.onstatus
288 drain = listeners.ondrain
290 handler.getstats = function( )
291 return readtraffic, sendtraffic
293 handler.ssl = function( )
296 handler.sslctx = function ( )
299 handler.send = function( _, data, i, j )
300 return send( socket, data, i, j )
302 handler.receive = function( pattern, prefix )
303 return receive( socket, pattern, prefix )
305 handler.shutdown = function( pattern )
306 return shutdown( socket, pattern )
308 handler.setoption = function (self, option, value)
309 if socket.setoption then
310 return socket:setoption(option, value);
312 return false, "setoption not implemented";
314 handler.close = function( self, forced )
315 if not handler then return true; end
316 _readlistlen = removesocket( _readlist, socket, _readlistlen )
317 _readtimes[ handler ] = nil
318 if bufferqueuelen ~= 0 then
319 if not ( forced or fatalerror ) then
320 handler.sendbuffer( )
321 if bufferqueuelen ~= 0 then -- try again...
323 handler.write = nil -- ... but no further writing allowed
329 send( socket, table_concat( bufferqueue, "", 1, bufferqueuelen ), 1, bufferlen ) -- forced send
333 _ = shutdown and shutdown( socket )
335 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
336 _socketlist[ socket ] = nil
339 out_put "server.lua: socket already closed"
342 _writetimes[ handler ] = nil
343 _closelist[ handler ] = nil
349 out_put "server.lua: closed client handler and removed socket from list"
352 handler.ip = function( )
355 handler.serverport = function( )
358 handler.clientport = function( )
361 local write = function( self, data )
362 bufferlen = bufferlen + string_len( data )
363 if bufferlen > maxsendlen then
364 _closelist[ handler ] = "send buffer exceeded" -- cannot close the client at the moment, have to wait to the end of the cycle
365 handler.write = idfalse -- dont write anymore
367 elseif socket and not _sendlist[ socket ] then
368 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
370 bufferqueuelen = bufferqueuelen + 1
371 bufferqueue[ bufferqueuelen ] = data
373 _writetimes[ handler ] = _writetimes[ handler ] or _currenttime
377 handler.write = write
378 handler.bufferqueue = function( self )
381 handler.socket = function( self )
384 handler.set_mode = function( self, new )
385 pattern = new or pattern
388 handler.set_send = function ( self, newsend )
389 send = newsend or send
392 handler.bufferlen = function( self, readlen, sendlen )
393 maxsendlen = sendlen or maxsendlen
394 maxreadlen = readlen or maxreadlen
395 return bufferlen, maxreadlen, maxsendlen
398 handler.lock_read = function (self, switch)
399 if switch == true then
400 local tmp = _readlistlen
401 _readlistlen = removesocket( _readlist, socket, _readlistlen )
402 _readtimes[ handler ] = nil
403 if _readlistlen ~= tmp then
406 elseif switch == false then
409 _readlistlen = addsocket(_readlist, socket, _readlistlen)
410 _readtimes[ handler ] = _currenttime
415 handler.pause = function (self)
416 return self:lock_read(true);
418 handler.resume = function (self)
419 return self:lock_read(false);
421 handler.lock = function( self, switch )
422 handler.lock_read (switch)
423 if switch == true then
424 handler.write = idfalse
425 local tmp = _sendlistlen
426 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
427 _writetimes[ handler ] = nil
428 if _sendlistlen ~= tmp then
431 elseif switch == false then
432 handler.write = write
438 return noread, nosend
440 local _readbuffer = function( ) -- this function reads data
441 local buffer, err, part = receive( socket, pattern ) -- receive buffer with "pattern"
442 if not err or (err == "wantread" or err == "timeout") then -- received something
443 local buffer = buffer or part or ""
444 local len = string_len( buffer )
445 if len > maxreadlen then
446 disconnect( handler, "receive buffer exceeded" )
447 handler:close( true )
450 local count = len * STAT_UNIT
451 readtraffic = readtraffic + count
452 _readtraffic = _readtraffic + count
453 _readtimes[ handler ] = _currenttime
454 --out_put( "server.lua: read data '", buffer:gsub("[^%w%p ]", "."), "', error: ", err )
455 return dispatch( handler, buffer, err )
456 else -- connections was closed or fatal error
457 out_put( "server.lua: client ", tostring(ip), ":", tostring(clientport), " read error: ", tostring(err) )
459 disconnect( handler, err )
460 _ = handler and handler:close( )
464 local _sendbuffer = function( ) -- this function sends data
465 local succ, err, byte, buffer, count;
468 buffer = table_concat( bufferqueue, "", 1, bufferqueuelen )
469 succ, err, byte = send( socket, buffer, 1, bufferlen )
470 count = ( succ or byte or 0 ) * STAT_UNIT
471 sendtraffic = sendtraffic + count
472 _sendtraffic = _sendtraffic + count
473 _ = _cleanqueue and clean( bufferqueue )
474 --out_put( "server.lua: sended '", buffer, "', bytes: ", tostring(succ), ", error: ", tostring(err), ", part: ", tostring(byte), ", to: ", tostring(ip), ":", tostring(clientport) )
476 succ, err, count = false, "closed", 0;
478 if succ then -- sending succesful
481 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen ) -- delete socket from writelist
482 _ = needtls and handler:starttls(nil, true)
483 _writetimes[ handler ] = nil
487 _ = toclose and handler:close( )
489 elseif byte and ( err == "timeout" or err == "wantwrite" ) then -- want write
490 buffer = string_sub( buffer, byte + 1, bufferlen ) -- new buffer
491 bufferqueue[ 1 ] = buffer -- insert new buffer in queue
493 bufferlen = bufferlen - byte
494 _writetimes[ handler ] = _currenttime
496 else -- connection was closed during sending or fatal error
497 out_put( "server.lua: client ", tostring(ip), ":", tostring(clientport), " write error: ", tostring(err) )
499 disconnect( handler, err )
500 _ = handler and handler:close( )
507 function handler.set_sslctx(self, new_sslctx)
512 handshake = coroutine_wrap( function( client ) -- create handshake coroutine
514 for i = 1, _maxsslhandshake do
515 _sendlistlen = ( wrote and removesocket( _sendlist, client, _sendlistlen ) ) or _sendlistlen
516 _readlistlen = ( read and removesocket( _readlist, client, _readlistlen ) ) or _readlistlen
517 read, wrote = nil, nil
518 _, err = client:dohandshake( )
520 out_put( "server.lua: ssl handshake done" )
521 handler.readbuffer = _readbuffer -- when handshake is done, replace the handshake function with regular functions
522 handler.sendbuffer = _sendbuffer
523 _ = status and status( handler, "ssl-handshake-complete" )
524 _readlistlen = addsocket(_readlist, client, _readlistlen)
527 out_put( "server.lua: error during ssl handshake: ", tostring(err) )
528 if err == "wantwrite" and not wrote then
529 _sendlistlen = addsocket(_sendlist, client, _sendlistlen)
531 elseif err == "wantread" and not read then
532 _readlistlen = addsocket(_readlist, client, _readlistlen)
537 --coroutine_yield( handler, nil, err ) -- handshake not finished
541 disconnect( handler, "ssl handshake failed" )
542 _ = handler and handler:close( true ) -- forced disconnect
543 return false -- handshake failed
548 if sslctx then -- ssl?
549 handler:set_sslctx(sslctx);
550 out_put("server.lua: ", "starting ssl handshake")
552 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
554 out_put( "server.lua: ssl error: ", tostring(err) )
556 return nil, nil, err -- fatal error
558 socket:settimeout( 0 )
559 handler.readbuffer = handshake
560 handler.sendbuffer = handshake
561 handshake( socket ) -- do handshake
563 return nil, nil, "ssl handshake failed";
567 handler.starttls = function( self, _sslctx, now )
570 handler:set_sslctx(sslctx);
573 out_put "server.lua: we need to do tls, but delaying until later"
577 out_put( "server.lua: attempting to start tls on " .. tostring( socket ) )
578 local oldsocket, err = socket
579 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
580 --out_put( "server.lua: sslwrapped socket is " .. tostring( socket ) )
582 out_put( "server.lua: error while starting tls on client: ", tostring(err) )
583 return nil, err -- fatal error
586 socket:settimeout( 0 )
588 -- add the new socket to our system
591 receive = socket.receive
594 _socketlist[ socket ] = handler
595 _readlistlen = addsocket(_readlist, socket, _readlistlen)
597 -- remove traces of the old socket
599 _readlistlen = removesocket( _readlist, oldsocket, _readlistlen )
600 _sendlistlen = removesocket( _sendlist, oldsocket, _sendlistlen )
601 _socketlist[ oldsocket ] = nil
603 handler.starttls = nil
609 handler.readbuffer = handshake
610 handler.sendbuffer = handshake
611 handshake( socket ) -- do handshake
613 handler.readbuffer = _readbuffer
614 handler.sendbuffer = _sendbuffer
617 handler.readbuffer = _readbuffer
618 handler.sendbuffer = _sendbuffer
621 receive = socket.receive
622 shutdown = ( ssl and id ) or socket.shutdown
624 _socketlist[ socket ] = handler
625 _readlistlen = addsocket(_readlist, socket, _readlistlen)
626 if listeners.onconnect then
627 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
628 handler.sendbuffer = function ()
629 listeners.onconnect(handler);
630 handler.sendbuffer = _sendbuffer;
631 if bufferqueuelen > 0 then
632 return _sendbuffer();
636 return handler, socket
642 idfalse = function( )
646 addsocket = function( list, socket, len )
647 if not list[ socket ] then
655 removesocket = function( list, socket, len ) -- this function removes sockets from a list ( copied from copas )
656 local pos = list[ socket ]
659 local last = list[ len ]
661 if last ~= socket then
670 closesocket = function( socket )
671 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
672 _readlistlen = removesocket( _readlist, socket, _readlistlen )
673 _socketlist[ socket ] = nil
678 local function link(sender, receiver, buffersize)
679 sender:set_mode(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[ port ] then
710 err = "listeners on port '" .. port .. "' already exist"
711 elseif sslctx and not luasec then
712 err = "luasec not found"
715 out_error( "server.lua, port ", port, ": ", err )
719 local server, err = socket_bind( addr, port )
721 out_error( "server.lua, port ", 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[ port ] = handler
732 _socketlist[ server ] = handler
733 out_put( "server.lua: new "..(sslctx and "ssl " or "").."server listener on '", addr, ":", port, "'" )
737 getserver = function ( port )
738 return _server[ port ];
741 removeserver = function( port )
742 local handler = _server[ port ]
744 return nil, "no server found on port '" .. tostring( port ) .. "'"
747 _server[ 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.timeout ) or _selecttimeout
776 _sleeptime = tonumber( new.sleeptime ) or _sleeptime
777 _maxsendlen = tonumber( new.maxsendlen ) or _maxsendlen
778 _maxreadlen = tonumber( new.maxreadlen ) or _maxreadlen
779 _checkinterval = tonumber( new.checkinterval ) or _checkinterval
780 _sendtimeout = tonumber( new.sendtimeout ) or _sendtimeout
781 _readtimeout = tonumber( new.readtimeout ) or _readtimeout
782 _cleanqueue = new.cleanqueue
783 _maxclientsperserver = new._maxclientsperserver or _maxclientsperserver
784 _maxsslhandshake = new._maxsslhandshake 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
801 local dontstop = true; -- thinking about tomorrow, ...
803 setquitting = function (quit)
808 loop = function( ) -- this is the main loop of the program
810 local read, write, err = socket_select( _readlist, _sendlist, _selecttimeout )
811 for i, socket in ipairs( write ) do -- send data waiting in writequeues
812 local handler = _socketlist[ socket ]
814 handler.sendbuffer( )
816 closesocket( socket )
817 out_put "server.lua: found no handler and closed socket (writelist)" -- this should not happen
820 for i, socket in ipairs( read ) do -- receive data
821 local handler = _socketlist[ socket ]
823 handler.readbuffer( )
825 closesocket( socket )
826 out_put "server.lua: found no handler and closed socket (readlist)" -- this can happen
829 for handler, err in pairs( _closelist ) do
830 handler.disconnect( )( handler, err )
831 handler:close( true ) -- forced disconnect
834 _currenttime = os_time( )
835 if os_difftime( _currenttime - _timer ) >= 1 then
836 for i = 1, _timerlistlen do
837 _timerlist[ i ]( _currenttime ) -- fire timers
839 _timer = _currenttime
841 socket_sleep( _sleeptime ) -- wait some time
847 local function get_backend()
851 --// EXPERIMENTAL //--
853 local wrapclient = function( socket, ip, serverport, listeners, pattern, sslctx )
854 local handler = wrapconnection( nil, listeners, socket, ip, serverport, "clientport", pattern, sslctx )
855 _socketlist[ socket ] = handler
856 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
857 return handler, socket
860 local addclient = function( address, port, listeners, pattern, sslctx )
861 local client, err = luasocket.tcp( )
865 client:settimeout( 0 )
866 _, err = client:connect( address, port )
867 if err then -- try again
868 local handler = wrapclient( client, address, port, listeners )
870 wrapconnection( nil, listeners, client, address, port, "clientport", pattern, sslctx )
874 --// EXPERIMENTAL //--
876 ----------------------------------// BEGIN //--
878 use "setmetatable" ( _socketlist, { __mode = "k" } )
879 use "setmetatable" ( _readtimes, { __mode = "k" } )
880 use "setmetatable" ( _writetimes, { __mode = "k" } )
883 _starttime = os_time( )
885 addtimer( function( )
886 local difftime = os_difftime( _currenttime - _starttime )
887 if difftime > _checkinterval then
888 _starttime = _currenttime
889 for handler, timestamp in pairs( _writetimes ) do
890 if os_difftime( _currenttime - timestamp ) > _sendtimeout then
891 --_writetimes[ handler ] = nil
892 handler.disconnect( )( handler, "send timeout" )
893 handler:close( true ) -- forced disconnect
896 for handler, timestamp in pairs( _readtimes ) do
897 if os_difftime( _currenttime - timestamp ) > _readtimeout then
898 --_readtimes[ handler ] = nil
899 handler.disconnect( )( handler, "read timeout" )
900 handler:close( ) -- forced disconnect?
907 local function setlogger(new_logger)
908 local old_logger = log;
915 ----------------------------------// PUBLIC INTERFACE //--
919 addclient = addclient,
920 wrapclient = wrapclient,
927 addserver = addserver,
928 getserver = getserver,
929 setlogger = setlogger,
930 getsettings = getsettings,
931 setquitting = setquitting,
932 removeserver = removeserver,
933 get_backend = get_backend,
934 changesettings = changesettings,