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 tonumber = use "tonumber"
36 local tostring = use "tostring"
37 local collectgarbage = use "collectgarbage"
42 local table = use "table"
43 local string = use "string"
44 local coroutine = use "coroutine"
46 --// lua lib methods //--
48 local os_difftime = os.difftime
49 local math_min = math.min
50 local math_huge = math.huge
51 local table_concat = table.concat
52 local table_remove = table.remove
53 local string_len = string.len
54 local string_sub = string.sub
55 local coroutine_wrap = coroutine.wrap
56 local coroutine_yield = coroutine.yield
60 local luasec = use "ssl"
61 local luasocket = use "socket" or require "socket"
62 local luasocket_gettime = luasocket.gettime
64 --// extern lib methods //--
66 local ssl_wrap = ( luasec and luasec.wrap )
67 local socket_bind = luasocket.bind
68 local socket_sleep = luasocket.sleep
69 local socket_select = luasocket.select
70 local ssl_newcontext = ( luasec and luasec.newcontext )
102 --// simple data types //--
129 local _maxclientsperserver
131 local _maxsslhandshake
133 ----------------------------------// DEFINITION //--
135 _server = { } -- key = port, value = table; list of listening servers
136 _readlist = { } -- array with sockets to read from
137 _sendlist = { } -- arrary with sockets to write to
138 _timerlist = { } -- array of timer functions
139 _socketlist = { } -- key = socket, value = wrapped socket (handlers)
140 _readtimes = { } -- key = handler, value = timestamp of last data reading
141 _writetimes = { } -- key = handler, value = timestamp of last data writing/sending
142 _closelist = { } -- handlers to close
144 _readlistlen = 0 -- length of readlist
145 _sendlistlen = 0 -- length of sendlist
146 _timerlistlen = 0 -- lenght of timerlist
148 _sendtraffic = 0 -- some stats
151 _selecttimeout = 1 -- timeout of socket.select
152 _sleeptime = 0 -- time to wait at the end of every loop
154 _maxsendlen = 51000 * 1024 -- max len of send buffer
155 _maxreadlen = 25000 * 1024 -- max len of read buffer
157 _checkinterval = 1200000 -- interval in secs to check idle clients
158 _sendtimeout = 60000 -- allowed send idle time in secs
159 _readtimeout = 6 * 60 * 60 -- allowed read idle time in secs
161 _cleanqueue = false -- clean bufferqueue after using
163 _maxclientsperserver = 1000
165 _maxsslhandshake = 30 -- max handshake round-trips
167 ----------------------------------// PRIVATE //--
169 wrapserver = function( listeners, socket, ip, serverport, pattern, sslctx, maxconnections ) -- this function wraps a server
171 maxconnections = maxconnections or _maxclientsperserver
173 local connections = 0
175 local dispatch, disconnect = listeners.onconnect or listeners.onincoming, listeners.ondisconnect
177 local accept = socket.accept
179 --// public methods of the object //--
183 handler.shutdown = function( ) end
185 handler.ssl = function( )
188 handler.sslctx = function( )
191 handler.remove = function( )
192 connections = connections - 1
194 handler.close = function( )
195 for _, handler in pairs( _socketlist ) do
196 if handler.serverport == serverport then
197 handler.disconnect( handler, "server closed" )
198 handler:close( true )
202 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
203 _readlistlen = removesocket( _readlist, socket, _readlistlen )
204 _socketlist[ socket ] = nil
208 out_put "server.lua: closed server handler and removed sockets from list"
210 handler.ip = function( )
213 handler.serverport = function( )
216 handler.socket = function( )
219 handler.readbuffer = function( )
220 if connections > maxconnections then
221 out_put( "server.lua: refused new client connection: server full" )
224 local client, err = accept( socket ) -- try to accept
226 local ip, clientport = client:getpeername( )
227 client:settimeout( 0 )
228 local handler, client, err = wrapconnection( handler, listeners, client, ip, serverport, clientport, pattern, sslctx ) -- wrap new client socket
229 if err then -- error while wrapping ssl socket
232 connections = connections + 1
233 out_put( "server.lua: accepted new client connection from ", tostring(ip), ":", tostring(clientport), " to ", tostring(serverport))
234 return dispatch( handler )
235 elseif err then -- maybe timeout or something else
236 out_put( "server.lua: error with new client connection: ", tostring(err) )
243 wrapconnection = function( server, listeners, socket, ip, serverport, clientport, pattern, sslctx ) -- this function wraps a client to a handler object
245 socket:settimeout( 0 )
247 --// local import of socket methods //--
253 --// private closures of the object //--
257 local dispatch = listeners.onincoming
258 local status = listeners.onstatus
259 local disconnect = listeners.ondisconnect
260 local drain = listeners.ondrain
262 local bufferqueue = { } -- buffer array
263 local bufferqueuelen = 0 -- end of buffer array
274 local sendtraffic, readtraffic = 0, 0
276 local maxsendlen = _maxsendlen
277 local maxreadlen = _maxreadlen
279 --// public methods of the object //--
281 local handler = bufferqueue -- saves a table ^_^
283 handler.dispatch = function( )
286 handler.disconnect = function( )
289 handler.setlistener = function( self, listeners )
290 dispatch = listeners.onincoming
291 disconnect = listeners.ondisconnect
292 status = listeners.onstatus
293 drain = listeners.ondrain
295 handler.getstats = function( )
296 return readtraffic, sendtraffic
298 handler.ssl = function( )
301 handler.sslctx = function ( )
304 handler.send = function( _, data, i, j )
305 return send( socket, data, i, j )
307 handler.receive = function( pattern, prefix )
308 return receive( socket, pattern, prefix )
310 handler.shutdown = function( pattern )
311 return shutdown( socket, pattern )
313 handler.setoption = function (self, option, value)
314 if socket.setoption then
315 return socket:setoption(option, value);
317 return false, "setoption not implemented";
319 handler.close = function( self, forced )
320 if not handler then return true; end
321 _readlistlen = removesocket( _readlist, socket, _readlistlen )
322 _readtimes[ handler ] = nil
323 if bufferqueuelen ~= 0 then
324 if not ( forced or fatalerror ) then
325 handler.sendbuffer( )
326 if bufferqueuelen ~= 0 then -- try again...
328 handler.write = nil -- ... but no further writing allowed
334 send( socket, table_concat( bufferqueue, "", 1, bufferqueuelen ), 1, bufferlen ) -- forced send
338 _ = shutdown and shutdown( socket )
340 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
341 _socketlist[ socket ] = nil
344 out_put "server.lua: socket already closed"
347 _writetimes[ handler ] = nil
348 _closelist[ handler ] = nil
354 out_put "server.lua: closed client handler and removed socket from list"
357 handler.ip = function( )
360 handler.serverport = function( )
363 handler.clientport = function( )
366 local write = function( self, data )
367 bufferlen = bufferlen + string_len( data )
368 if bufferlen > maxsendlen then
369 _closelist[ handler ] = "send buffer exceeded" -- cannot close the client at the moment, have to wait to the end of the cycle
370 handler.write = idfalse -- dont write anymore
372 elseif socket and not _sendlist[ socket ] then
373 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
375 bufferqueuelen = bufferqueuelen + 1
376 bufferqueue[ bufferqueuelen ] = data
378 _writetimes[ handler ] = _writetimes[ handler ] or _currenttime
382 handler.write = write
383 handler.bufferqueue = function( self )
386 handler.socket = function( self )
389 handler.set_mode = function( self, new )
390 pattern = new or pattern
393 handler.set_send = function ( self, newsend )
394 send = newsend or send
397 handler.bufferlen = function( self, readlen, sendlen )
398 maxsendlen = sendlen or maxsendlen
399 maxreadlen = readlen or maxreadlen
400 return bufferlen, maxreadlen, maxsendlen
403 handler.lock_read = function (self, switch)
404 if switch == true then
405 local tmp = _readlistlen
406 _readlistlen = removesocket( _readlist, socket, _readlistlen )
407 _readtimes[ handler ] = nil
408 if _readlistlen ~= tmp then
411 elseif switch == false then
414 _readlistlen = addsocket(_readlist, socket, _readlistlen)
415 _readtimes[ handler ] = _currenttime
420 handler.pause = function (self)
421 return self:lock_read(true);
423 handler.resume = function (self)
424 return self:lock_read(false);
426 handler.lock = function( self, switch )
427 handler.lock_read (switch)
428 if switch == true then
429 handler.write = idfalse
430 local tmp = _sendlistlen
431 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
432 _writetimes[ handler ] = nil
433 if _sendlistlen ~= tmp then
436 elseif switch == false then
437 handler.write = write
443 return noread, nosend
445 local _readbuffer = function( ) -- this function reads data
446 local buffer, err, part = receive( socket, pattern ) -- receive buffer with "pattern"
447 if not err or (err == "wantread" or err == "timeout") then -- received something
448 local buffer = buffer or part or ""
449 local len = string_len( buffer )
450 if len > maxreadlen then
451 disconnect( handler, "receive buffer exceeded" )
452 handler:close( true )
455 local count = len * STAT_UNIT
456 readtraffic = readtraffic + count
457 _readtraffic = _readtraffic + count
458 _readtimes[ handler ] = _currenttime
459 --out_put( "server.lua: read data '", buffer:gsub("[^%w%p ]", "."), "', error: ", err )
460 return dispatch( handler, buffer, err )
461 else -- connections was closed or fatal error
462 out_put( "server.lua: client ", tostring(ip), ":", tostring(clientport), " read error: ", tostring(err) )
464 disconnect( handler, err )
465 _ = handler and handler:close( )
469 local _sendbuffer = function( ) -- this function sends data
470 local succ, err, byte, buffer, count;
473 buffer = table_concat( bufferqueue, "", 1, bufferqueuelen )
474 succ, err, byte = send( socket, buffer, 1, bufferlen )
475 count = ( succ or byte or 0 ) * STAT_UNIT
476 sendtraffic = sendtraffic + count
477 _sendtraffic = _sendtraffic + count
478 _ = _cleanqueue and clean( bufferqueue )
479 --out_put( "server.lua: sended '", buffer, "', bytes: ", tostring(succ), ", error: ", tostring(err), ", part: ", tostring(byte), ", to: ", tostring(ip), ":", tostring(clientport) )
481 succ, err, count = false, "closed", 0;
483 if succ then -- sending succesful
486 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen ) -- delete socket from writelist
487 _writetimes[ handler ] = nil
491 _ = needtls and handler:starttls(nil)
492 _ = toclose and handler:close( )
494 elseif byte and ( err == "timeout" or err == "wantwrite" ) then -- want write
495 buffer = string_sub( buffer, byte + 1, bufferlen ) -- new buffer
496 bufferqueue[ 1 ] = buffer -- insert new buffer in queue
498 bufferlen = bufferlen - byte
499 _writetimes[ handler ] = _currenttime
501 else -- connection was closed during sending or fatal error
502 out_put( "server.lua: client ", tostring(ip), ":", tostring(clientport), " write error: ", tostring(err) )
504 disconnect( handler, err )
505 _ = handler and handler:close( )
512 function handler.set_sslctx(self, new_sslctx)
517 handshake = coroutine_wrap( function( client ) -- create handshake coroutine
519 for i = 1, _maxsslhandshake do
520 _sendlistlen = ( wrote and removesocket( _sendlist, client, _sendlistlen ) ) or _sendlistlen
521 _readlistlen = ( read and removesocket( _readlist, client, _readlistlen ) ) or _readlistlen
522 read, wrote = nil, nil
523 _, err = client:dohandshake( )
525 out_put( "server.lua: ssl handshake done" )
526 handler.readbuffer = _readbuffer -- when handshake is done, replace the handshake function with regular functions
527 handler.sendbuffer = _sendbuffer
528 _ = status and status( handler, "ssl-handshake-complete" )
529 _readlistlen = addsocket(_readlist, client, _readlistlen)
532 out_put( "server.lua: error during ssl handshake: ", tostring(err) )
533 if err == "wantwrite" and not wrote then
534 _sendlistlen = addsocket(_sendlist, client, _sendlistlen)
536 elseif err == "wantread" and not read then
537 _readlistlen = addsocket(_readlist, client, _readlistlen)
542 --coroutine_yield( handler, nil, err ) -- handshake not finished
546 disconnect( handler, "ssl handshake failed" )
547 _ = handler and handler:close( true ) -- forced disconnect
548 return false -- handshake failed
553 if sslctx then -- ssl?
554 handler:set_sslctx(sslctx);
555 out_put("server.lua: ", "starting ssl handshake")
557 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
559 out_put( "server.lua: ssl error: ", tostring(err) )
561 return nil, nil, err -- fatal error
563 socket:settimeout( 0 )
564 handler.readbuffer = handshake
565 handler.sendbuffer = handshake
566 handshake( socket ) -- do handshake
568 return nil, nil, "ssl handshake failed";
572 handler.starttls = function( self, _sslctx)
575 handler:set_sslctx(sslctx);
577 if bufferqueuelen > 0 then
578 out_put "server.lua: we need to do tls, but delaying until send buffer empty"
582 out_put( "server.lua: attempting to start tls on " .. tostring( socket ) )
583 local oldsocket, err = socket
584 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
585 --out_put( "server.lua: sslwrapped socket is " .. tostring( socket ) )
587 out_put( "server.lua: error while starting tls on client: ", tostring(err) )
588 return nil, err -- fatal error
591 socket:settimeout( 0 )
593 -- add the new socket to our system
596 receive = socket.receive
599 _socketlist[ socket ] = handler
600 _readlistlen = addsocket(_readlist, socket, _readlistlen)
602 -- 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
614 handler.readbuffer = handshake
615 handler.sendbuffer = handshake
616 handshake( socket ) -- do handshake
618 handler.readbuffer = _readbuffer
619 handler.sendbuffer = _sendbuffer
622 handler.readbuffer = _readbuffer
623 handler.sendbuffer = _sendbuffer
626 receive = socket.receive
627 shutdown = ( ssl and id ) or socket.shutdown
629 _socketlist[ socket ] = handler
630 _readlistlen = addsocket(_readlist, socket, _readlistlen)
631 return handler, socket
637 idfalse = function( )
641 addsocket = function( list, socket, len )
642 if not list[ socket ] then
650 removesocket = function( list, socket, len ) -- this function removes sockets from a list ( copied from copas )
651 local pos = list[ socket ]
654 local last = list[ len ]
656 if last ~= socket then
665 closesocket = function( socket )
666 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
667 _readlistlen = removesocket( _readlist, socket, _readlistlen )
668 _socketlist[ socket ] = nil
673 local function link(sender, receiver, buffersize)
675 local _sendbuffer = receiver.sendbuffer;
676 function receiver.sendbuffer()
678 if sender_locked and receiver.bufferlen() < buffersize then
679 sender:lock_read(false); -- Unlock now
684 local _readbuffer = sender.readbuffer;
685 function sender.readbuffer()
687 if not sender_locked and receiver.bufferlen() >= buffersize then
688 sender_locked = true;
689 sender:lock_read(true);
694 ----------------------------------// PUBLIC //--
696 addserver = function( addr, port, listeners, pattern, sslctx ) -- this function provides a way for other scripts to reg a server
698 if type( listeners ) ~= "table" then
699 err = "invalid listener table"
701 if type( port ) ~= "number" or not ( port >= 0 and port <= 65535 ) then
703 elseif _server[ port ] then
704 err = "listeners on port '" .. port .. "' already exist"
705 elseif sslctx and not luasec then
706 err = "luasec not found"
709 out_error( "server.lua, port ", port, ": ", err )
713 local server, err = socket_bind( addr, port )
715 out_error( "server.lua, port ", port, ": ", err )
718 local handler, err = wrapserver( listeners, server, addr, port, pattern, sslctx, _maxclientsperserver ) -- wrap new server socket
723 server:settimeout( 0 )
724 _readlistlen = addsocket(_readlist, server, _readlistlen)
725 _server[ port ] = handler
726 _socketlist[ server ] = handler
727 out_put( "server.lua: new "..(sslctx and "ssl " or "").."server listener on '", addr, ":", port, "'" )
731 getserver = function ( port )
732 return _server[ port ];
735 removeserver = function( port )
736 local handler = _server[ port ]
738 return nil, "no server found on port '" .. tostring( port ) .. "'"
741 _server[ port ] = nil
745 closeall = function( )
746 for _, handler in pairs( _socketlist ) do
748 _socketlist[ _ ] = nil
761 getsettings = function( )
762 return _selecttimeout, _sleeptime, _maxsendlen, _maxreadlen, _checkinterval, _sendtimeout, _readtimeout, _cleanqueue, _maxclientsperserver, _maxsslhandshake
765 changesettings = function( new )
766 if type( new ) ~= "table" then
767 return nil, "invalid settings table"
769 _selecttimeout = tonumber( new.timeout ) or _selecttimeout
770 _sleeptime = tonumber( new.sleeptime ) or _sleeptime
771 _maxsendlen = tonumber( new.maxsendlen ) or _maxsendlen
772 _maxreadlen = tonumber( new.maxreadlen ) or _maxreadlen
773 _checkinterval = tonumber( new.checkinterval ) or _checkinterval
774 _sendtimeout = tonumber( new.sendtimeout ) or _sendtimeout
775 _readtimeout = tonumber( new.readtimeout ) or _readtimeout
776 _cleanqueue = new.cleanqueue
777 _maxclientsperserver = new._maxclientsperserver or _maxclientsperserver
778 _maxsslhandshake = new._maxsslhandshake or _maxsslhandshake
782 addtimer = function( listener )
783 if type( listener ) ~= "function" then
784 return nil, "invalid listener function"
786 _timerlistlen = _timerlistlen + 1
787 _timerlist[ _timerlistlen ] = listener
792 return _readtraffic, _sendtraffic, _readlistlen, _sendlistlen, _timerlistlen
797 setquitting = function (quit)
798 quitting = not not quit;
801 loop = function(once) -- this is the main loop of the program
802 if quitting then return "quitting"; end
803 if once then quitting = "once"; end
804 local next_timer_time = math_huge;
806 local read, write, err = socket_select( _readlist, _sendlist, math_min(_selecttimeout, next_timer_time) )
807 for i, socket in ipairs( write ) do -- send data waiting in writequeues
808 local handler = _socketlist[ socket ]
810 handler.sendbuffer( )
812 closesocket( socket )
813 out_put "server.lua: found no handler and closed socket (writelist)" -- this should not happen
816 for i, socket in ipairs( read ) do -- receive data
817 local handler = _socketlist[ socket ]
819 handler.readbuffer( )
821 closesocket( socket )
822 out_put "server.lua: found no handler and closed socket (readlist)" -- this can happen
825 for handler, err in pairs( _closelist ) do
826 handler.disconnect( )( handler, err )
827 handler:close( true ) -- forced disconnect
830 _currenttime = luasocket_gettime( )
831 if _currenttime - _timer >= math_min(next_timer_time, 1) then
832 next_timer_time = math_huge;
833 for i = 1, _timerlistlen do
834 local t = _timerlist[ i ]( _currenttime ) -- fire timers
835 if t then next_timer_time = math_min(next_timer_time, t); end
837 _timer = _currenttime
839 next_timer_time = next_timer_time - (_currenttime - _timer);
841 socket_sleep( _sleeptime ) -- wait some time
844 if once and quitting == "once" then quitting = nil; return; end
852 local function get_backend()
856 --// EXPERIMENTAL //--
858 local wrapclient = function( socket, ip, serverport, listeners, pattern, sslctx )
859 local handler = wrapconnection( nil, listeners, socket, ip, serverport, "clientport", pattern, sslctx )
860 _socketlist[ socket ] = handler
861 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
862 if listeners.onconnect then
863 -- When socket is writeable, call onconnect
864 local _sendbuffer = handler.sendbuffer;
865 handler.sendbuffer = function ()
866 handler.sendbuffer = _sendbuffer;
867 listeners.onconnect(handler);
868 -- If there was data with the incoming packet, handle it now.
869 if #handler:bufferqueue() > 0 then
870 return _sendbuffer();
874 return handler, socket
877 local addclient = function( address, port, listeners, pattern, sslctx )
878 local client, err = luasocket.tcp( )
882 client:settimeout( 0 )
883 _, err = client:connect( address, port )
884 if err then -- try again
885 local handler = wrapclient( client, address, port, listeners )
887 wrapconnection( nil, listeners, client, address, port, "clientport", pattern, sslctx )
891 --// EXPERIMENTAL //--
893 ----------------------------------// BEGIN //--
895 use "setmetatable" ( _socketlist, { __mode = "k" } )
896 use "setmetatable" ( _readtimes, { __mode = "k" } )
897 use "setmetatable" ( _writetimes, { __mode = "k" } )
899 _timer = luasocket_gettime( )
900 _starttime = luasocket_gettime( )
902 addtimer( function( )
903 local difftime = os_difftime( _currenttime - _starttime )
904 if difftime > _checkinterval then
905 _starttime = _currenttime
906 for handler, timestamp in pairs( _writetimes ) do
907 if os_difftime( _currenttime - timestamp ) > _sendtimeout then
908 --_writetimes[ handler ] = nil
909 handler.disconnect( )( handler, "send timeout" )
910 handler:close( true ) -- forced disconnect
913 for handler, timestamp in pairs( _readtimes ) do
914 if os_difftime( _currenttime - timestamp ) > _readtimeout then
915 --_readtimes[ handler ] = nil
916 handler.disconnect( )( handler, "read timeout" )
917 handler:close( ) -- forced disconnect?
924 local function setlogger(new_logger)
925 local old_logger = log;
932 ----------------------------------// PUBLIC INTERFACE //--
936 addclient = addclient,
937 wrapclient = wrapclient,
944 addserver = addserver,
945 getserver = getserver,
946 setlogger = setlogger,
947 getsettings = getsettings,
948 setquitting = setquitting,
949 removeserver = removeserver,
950 get_backend = get_backend,
951 changesettings = changesettings,