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 )
103 --// simple data types //--
130 local _maxclientsperserver
132 local _maxsslhandshake
134 ----------------------------------// DEFINITION //--
136 _server = { } -- key = port, value = table; list of listening servers
137 _readlist = { } -- array with sockets to read from
138 _sendlist = { } -- arrary with sockets to write to
139 _timerlist = { } -- array of timer functions
140 _socketlist = { } -- key = socket, value = wrapped socket (handlers)
141 _readtimes = { } -- key = handler, value = timestamp of last data reading
142 _writetimes = { } -- key = handler, value = timestamp of last data writing/sending
143 _closelist = { } -- handlers to close
145 _readlistlen = 0 -- length of readlist
146 _sendlistlen = 0 -- length of sendlist
147 _timerlistlen = 0 -- lenght of timerlist
149 _sendtraffic = 0 -- some stats
152 _selecttimeout = 1 -- timeout of socket.select
153 _sleeptime = 0 -- time to wait at the end of every loop
155 _maxsendlen = 51000 * 1024 -- max len of send buffer
156 _maxreadlen = 25000 * 1024 -- max len of read buffer
158 _checkinterval = 1200000 -- interval in secs to check idle clients
159 _sendtimeout = 60000 -- allowed send idle time in secs
160 _readtimeout = 6 * 60 * 60 -- allowed read idle time in secs
162 _cleanqueue = false -- clean bufferqueue after using
164 _maxclientsperserver = 1000
166 _maxsslhandshake = 30 -- max handshake round-trips
168 ----------------------------------// PRIVATE //--
170 wrapserver = function( listeners, socket, ip, serverport, pattern, sslctx, maxconnections ) -- this function wraps a server
172 maxconnections = maxconnections or _maxclientsperserver
174 local connections = 0
176 local dispatch, disconnect = listeners.onconnect, listeners.ondisconnect
178 local accept = socket.accept
180 --// public methods of the object //--
184 handler.shutdown = function( ) end
186 handler.ssl = function( )
189 handler.sslctx = function( )
192 handler.remove = function( )
193 connections = connections - 1
195 handler.close = function( )
196 for _, handler in pairs( _socketlist ) do
197 if handler.serverport == serverport then
198 handler.disconnect( handler, "server closed" )
199 handler:close( true )
203 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
204 _readlistlen = removesocket( _readlist, socket, _readlistlen )
205 _socketlist[ socket ] = nil
209 out_put "server.lua: closed server handler and removed sockets from list"
211 handler.ip = function( )
214 handler.serverport = function( )
217 handler.socket = function( )
220 handler.readbuffer = function( )
221 if connections > maxconnections then
222 out_put( "server.lua: refused new client connection: server full" )
225 local client, err = accept( socket ) -- try to accept
227 local ip, clientport = client:getpeername( )
228 client:settimeout( 0 )
229 local handler, client, err = wrapconnection( handler, listeners, client, ip, serverport, clientport, pattern, sslctx ) -- wrap new client socket
230 if err then -- error while wrapping ssl socket
233 connections = connections + 1
234 out_put( "server.lua: accepted new client connection from ", tostring(ip), ":", tostring(clientport), " to ", tostring(serverport))
236 return dispatch( handler );
239 elseif err then -- maybe timeout or something else
240 out_put( "server.lua: error with new client connection: ", tostring(err) )
247 wrapconnection = function( server, listeners, socket, ip, serverport, clientport, pattern, sslctx ) -- this function wraps a client to a handler object
249 socket:settimeout( 0 )
251 --// local import of socket methods //--
257 --// private closures of the object //--
261 local dispatch = listeners.onincoming
262 local status = listeners.onstatus
263 local disconnect = listeners.ondisconnect
264 local drain = listeners.ondrain
266 local bufferqueue = { } -- buffer array
267 local bufferqueuelen = 0 -- end of buffer array
278 local sendtraffic, readtraffic = 0, 0
280 local maxsendlen = _maxsendlen
281 local maxreadlen = _maxreadlen
283 --// public methods of the object //--
285 local handler = bufferqueue -- saves a table ^_^
287 handler.dispatch = function( )
290 handler.disconnect = function( )
293 handler.setlistener = function( self, listeners )
294 dispatch = listeners.onincoming
295 disconnect = listeners.ondisconnect
296 status = listeners.onstatus
297 drain = listeners.ondrain
299 handler.getstats = function( )
300 return readtraffic, sendtraffic
302 handler.ssl = function( )
305 handler.sslctx = function ( )
308 handler.send = function( _, data, i, j )
309 return send( socket, data, i, j )
311 handler.receive = function( pattern, prefix )
312 return receive( socket, pattern, prefix )
314 handler.shutdown = function( pattern )
315 return shutdown( socket, pattern )
317 handler.setoption = function (self, option, value)
318 if socket.setoption then
319 return socket:setoption(option, value);
321 return false, "setoption not implemented";
323 handler.close = function( self, forced )
324 if not handler then return true; end
325 _readlistlen = removesocket( _readlist, socket, _readlistlen )
326 _readtimes[ handler ] = nil
327 if bufferqueuelen ~= 0 then
328 if not ( forced or fatalerror ) then
329 handler.sendbuffer( )
330 if bufferqueuelen ~= 0 then -- try again...
332 handler.write = nil -- ... but no further writing allowed
338 send( socket, table_concat( bufferqueue, "", 1, bufferqueuelen ), 1, bufferlen ) -- forced send
342 _ = shutdown and shutdown( socket )
344 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
345 _socketlist[ socket ] = nil
348 out_put "server.lua: socket already closed"
351 _writetimes[ handler ] = nil
352 _closelist[ handler ] = nil
358 out_put "server.lua: closed client handler and removed socket from list"
361 handler.ip = function( )
364 handler.serverport = function( )
367 handler.clientport = function( )
370 local write = function( self, data )
371 bufferlen = bufferlen + string_len( data )
372 if bufferlen > maxsendlen then
373 _closelist[ handler ] = "send buffer exceeded" -- cannot close the client at the moment, have to wait to the end of the cycle
374 handler.write = idfalse -- dont write anymore
376 elseif socket and not _sendlist[ socket ] then
377 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
379 bufferqueuelen = bufferqueuelen + 1
380 bufferqueue[ bufferqueuelen ] = data
382 _writetimes[ handler ] = _writetimes[ handler ] or _currenttime
386 handler.write = write
387 handler.bufferqueue = function( self )
390 handler.socket = function( self )
393 handler.set_mode = function( self, new )
394 pattern = new or pattern
397 handler.set_send = function ( self, newsend )
398 send = newsend or send
401 handler.bufferlen = function( self, readlen, sendlen )
402 maxsendlen = sendlen or maxsendlen
403 maxreadlen = readlen or maxreadlen
404 return bufferlen, maxreadlen, maxsendlen
407 handler.lock_read = function (self, switch)
408 if switch == true then
409 local tmp = _readlistlen
410 _readlistlen = removesocket( _readlist, socket, _readlistlen )
411 _readtimes[ handler ] = nil
412 if _readlistlen ~= tmp then
415 elseif switch == false then
418 _readlistlen = addsocket(_readlist, socket, _readlistlen)
419 _readtimes[ handler ] = _currenttime
424 handler.pause = function (self)
425 return self:lock_read(true);
427 handler.resume = function (self)
428 return self:lock_read(false);
430 handler.lock = function( self, switch )
431 handler.lock_read (switch)
432 if switch == true then
433 handler.write = idfalse
434 local tmp = _sendlistlen
435 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
436 _writetimes[ handler ] = nil
437 if _sendlistlen ~= tmp then
440 elseif switch == false then
441 handler.write = write
447 return noread, nosend
449 local _readbuffer = function( ) -- this function reads data
450 local buffer, err, part = receive( socket, pattern ) -- receive buffer with "pattern"
451 if not err or (err == "wantread" or err == "timeout") then -- received something
452 local buffer = buffer or part or ""
453 local len = string_len( buffer )
454 if len > maxreadlen then
455 disconnect( handler, "receive buffer exceeded" )
456 handler:close( true )
459 local count = len * STAT_UNIT
460 readtraffic = readtraffic + count
461 _readtraffic = _readtraffic + count
462 _readtimes[ handler ] = _currenttime
463 --out_put( "server.lua: read data '", buffer:gsub("[^%w%p ]", "."), "', error: ", err )
464 return dispatch( handler, buffer, err )
465 else -- connections was closed or fatal error
466 out_put( "server.lua: client ", tostring(ip), ":", tostring(clientport), " read error: ", tostring(err) )
468 disconnect( handler, err )
469 _ = handler and handler:close( )
473 local _sendbuffer = function( ) -- this function sends data
474 local succ, err, byte, buffer, count;
477 buffer = table_concat( bufferqueue, "", 1, bufferqueuelen )
478 succ, err, byte = send( socket, buffer, 1, bufferlen )
479 count = ( succ or byte or 0 ) * STAT_UNIT
480 sendtraffic = sendtraffic + count
481 _sendtraffic = _sendtraffic + count
482 _ = _cleanqueue and clean( bufferqueue )
483 --out_put( "server.lua: sended '", buffer, "', bytes: ", tostring(succ), ", error: ", tostring(err), ", part: ", tostring(byte), ", to: ", tostring(ip), ":", tostring(clientport) )
485 succ, err, count = false, "closed", 0;
487 if succ then -- sending succesful
490 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen ) -- delete socket from writelist
491 _writetimes[ handler ] = nil
495 _ = needtls and handler:starttls(nil)
496 _ = toclose and handler:close( )
498 elseif byte and ( err == "timeout" or err == "wantwrite" ) then -- want write
499 buffer = string_sub( buffer, byte + 1, bufferlen ) -- new buffer
500 bufferqueue[ 1 ] = buffer -- insert new buffer in queue
502 bufferlen = bufferlen - byte
503 _writetimes[ handler ] = _currenttime
505 else -- connection was closed during sending or fatal error
506 out_put( "server.lua: client ", tostring(ip), ":", tostring(clientport), " write error: ", tostring(err) )
508 disconnect( handler, err )
509 _ = handler and handler:close( )
516 function handler.set_sslctx(self, new_sslctx)
519 handshake = coroutine_wrap( function( client ) -- create handshake coroutine
521 for i = 1, _maxsslhandshake do
522 _sendlistlen = ( wrote and removesocket( _sendlist, client, _sendlistlen ) ) or _sendlistlen
523 _readlistlen = ( read and removesocket( _readlist, client, _readlistlen ) ) or _readlistlen
524 read, wrote = nil, nil
525 _, err = client:dohandshake( )
527 out_put( "server.lua: ssl handshake done" )
528 handler.readbuffer = _readbuffer -- when handshake is done, replace the handshake function with regular functions
529 handler.sendbuffer = _sendbuffer
530 _ = status and status( handler, "ssl-handshake-complete" )
531 if self.autostart_ssl and listeners.onconnect then
532 listeners.onconnect(self);
534 _readlistlen = addsocket(_readlist, client, _readlistlen)
537 if err == "wantwrite" then
538 _sendlistlen = addsocket(_sendlist, client, _sendlistlen)
540 elseif err == "wantread" then
541 _readlistlen = addsocket(_readlist, client, _readlistlen)
547 coroutine_yield( ) -- handshake not finished
550 out_put( "server.lua: ssl handshake error: ", tostring(err or "handshake too long") )
551 disconnect( handler, "ssl handshake failed" )
552 _ = handler and handler:close( true ) -- forced disconnect
553 return false -- handshake failed
558 handler.starttls = function( self, _sslctx)
560 handler:set_sslctx(_sslctx);
562 if bufferqueuelen > 0 then
563 out_put "server.lua: we need to do tls, but delaying until send buffer empty"
567 out_put( "server.lua: attempting to start tls on " .. tostring( socket ) )
568 local oldsocket, err = socket
569 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
571 out_put( "server.lua: error while starting tls on client: ", tostring(err or "unknown error") )
572 return nil, err -- fatal error
575 socket:settimeout( 0 )
577 -- add the new socket to our system
579 receive = socket.receive
581 _socketlist[ socket ] = handler
582 _readlistlen = addsocket(_readlist, socket, _readlistlen)
584 -- remove traces of the old socket
585 _readlistlen = removesocket( _readlist, oldsocket, _readlistlen )
586 _sendlistlen = removesocket( _sendlist, oldsocket, _sendlistlen )
587 _socketlist[ oldsocket ] = nil
589 handler.starttls = nil
592 -- Secure now (if handshake fails connection will close)
595 handler.readbuffer = handshake
596 handler.sendbuffer = handshake
597 handshake( socket ) -- do handshake
599 handler.readbuffer = _readbuffer
600 handler.sendbuffer = _sendbuffer
603 out_put "server.lua: auto-starting ssl negotiation..."
604 handler.autostart_ssl = true;
605 handler:starttls(sslctx);
609 handler.readbuffer = _readbuffer
610 handler.sendbuffer = _sendbuffer
613 receive = socket.receive
614 shutdown = ( ssl and id ) or socket.shutdown
616 _socketlist[ socket ] = handler
617 _readlistlen = addsocket(_readlist, socket, _readlistlen)
618 return handler, socket
624 idfalse = function( )
628 addsocket = function( list, socket, len )
629 if not list[ socket ] then
637 removesocket = function( list, socket, len ) -- this function removes sockets from a list ( copied from copas )
638 local pos = list[ socket ]
641 local last = list[ len ]
643 if last ~= socket then
652 closesocket = function( socket )
653 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
654 _readlistlen = removesocket( _readlist, socket, _readlistlen )
655 _socketlist[ socket ] = nil
660 local function link(sender, receiver, buffersize)
662 local _sendbuffer = receiver.sendbuffer;
663 function receiver.sendbuffer()
665 if sender_locked and receiver.bufferlen() < buffersize then
666 sender:lock_read(false); -- Unlock now
671 local _readbuffer = sender.readbuffer;
672 function sender.readbuffer()
674 if not sender_locked and receiver.bufferlen() >= buffersize then
675 sender_locked = true;
676 sender:lock_read(true);
681 ----------------------------------// PUBLIC //--
683 addserver = function( addr, port, listeners, pattern, sslctx ) -- this function provides a way for other scripts to reg a server
685 if type( listeners ) ~= "table" then
686 err = "invalid listener table"
688 if type( port ) ~= "number" or not ( port >= 0 and port <= 65535 ) then
690 elseif _server[ addr..":"..port ] then
691 err = "listeners on '[" .. addr .. "]:" .. port .. "' already exist"
692 elseif sslctx and not luasec then
693 err = "luasec not found"
696 out_error( "server.lua, [", addr, "]:", port, ": ", err )
700 local server, err = socket_bind( addr, port )
702 out_error( "server.lua, [", addr, "]:", port, ": ", err )
705 local handler, err = wrapserver( listeners, server, addr, port, pattern, sslctx, _maxclientsperserver ) -- wrap new server socket
710 server:settimeout( 0 )
711 _readlistlen = addsocket(_readlist, server, _readlistlen)
712 _server[ addr..":"..port ] = handler
713 _socketlist[ server ] = handler
714 out_put( "server.lua: new "..(sslctx and "ssl " or "").."server listener on '[", addr, "]:", port, "'" )
718 getserver = function ( addr, port )
719 return _server[ addr..":"..port ];
722 removeserver = function( addr, port )
723 local handler = _server[ addr..":"..port ]
725 return nil, "no server found on '[" .. addr .. "]:" .. tostring( port ) .. "'"
728 _server[ addr..":"..port ] = nil
732 closeall = function( )
733 for _, handler in pairs( _socketlist ) do
735 _socketlist[ _ ] = nil
748 getsettings = function( )
749 return _selecttimeout, _sleeptime, _maxsendlen, _maxreadlen, _checkinterval, _sendtimeout, _readtimeout, _cleanqueue, _maxclientsperserver, _maxsslhandshake
752 changesettings = function( new )
753 if type( new ) ~= "table" then
754 return nil, "invalid settings table"
756 _selecttimeout = tonumber( new.timeout ) or _selecttimeout
757 _sleeptime = tonumber( new.sleeptime ) or _sleeptime
758 _maxsendlen = tonumber( new.maxsendlen ) or _maxsendlen
759 _maxreadlen = tonumber( new.maxreadlen ) or _maxreadlen
760 _checkinterval = tonumber( new.checkinterval ) or _checkinterval
761 _sendtimeout = tonumber( new.sendtimeout ) or _sendtimeout
762 _readtimeout = tonumber( new.readtimeout ) or _readtimeout
763 _cleanqueue = new.cleanqueue
764 _maxclientsperserver = new._maxclientsperserver or _maxclientsperserver
765 _maxsslhandshake = new._maxsslhandshake or _maxsslhandshake
769 addtimer = function( listener )
770 if type( listener ) ~= "function" then
771 return nil, "invalid listener function"
773 _timerlistlen = _timerlistlen + 1
774 _timerlist[ _timerlistlen ] = listener
779 return _readtraffic, _sendtraffic, _readlistlen, _sendlistlen, _timerlistlen
784 local function setquitting(quit)
785 quitting = not not quit;
788 loop = function(once) -- this is the main loop of the program
789 if quitting then return "quitting"; end
790 if once then quitting = "once"; end
791 local next_timer_time = math_huge;
793 local read, write, err = socket_select( _readlist, _sendlist, math_min(_selecttimeout, next_timer_time) )
794 for i, socket in ipairs( write ) do -- send data waiting in writequeues
795 local handler = _socketlist[ socket ]
797 handler.sendbuffer( )
799 closesocket( socket )
800 out_put "server.lua: found no handler and closed socket (writelist)" -- this should not happen
803 for i, socket in ipairs( read ) do -- receive data
804 local handler = _socketlist[ socket ]
806 handler.readbuffer( )
808 closesocket( socket )
809 out_put "server.lua: found no handler and closed socket (readlist)" -- this can happen
812 for handler, err in pairs( _closelist ) do
813 handler.disconnect( )( handler, err )
814 handler:close( true ) -- forced disconnect
817 _currenttime = luasocket_gettime( )
818 if _currenttime - _timer >= math_min(next_timer_time, 1) then
819 next_timer_time = math_huge;
820 for i = 1, _timerlistlen do
821 local t = _timerlist[ i ]( _currenttime ) -- fire timers
822 if t then next_timer_time = math_min(next_timer_time, t); end
824 _timer = _currenttime
826 next_timer_time = next_timer_time - (_currenttime - _timer);
828 socket_sleep( _sleeptime ) -- wait some time
831 if once and quitting == "once" then quitting = nil; return; end
835 local function step()
839 local function get_backend()
843 --// EXPERIMENTAL //--
845 local wrapclient = function( socket, ip, serverport, listeners, pattern, sslctx )
846 local handler = wrapconnection( nil, listeners, socket, ip, serverport, "clientport", pattern, sslctx )
847 _socketlist[ socket ] = handler
849 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
850 if listeners.onconnect then
851 -- When socket is writeable, call onconnect
852 local _sendbuffer = handler.sendbuffer;
853 handler.sendbuffer = function ()
854 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen );
855 handler.sendbuffer = _sendbuffer;
856 listeners.onconnect(handler);
857 -- If there was data with the incoming packet, handle it now.
858 if #handler:bufferqueue() > 0 then
859 return _sendbuffer();
864 return handler, socket
867 local addclient = function( address, port, listeners, pattern, sslctx )
868 local client, err = luasocket.tcp( )
872 client:settimeout( 0 )
873 _, err = client:connect( address, port )
874 if err then -- try again
875 local handler = wrapclient( client, address, port, listeners )
877 wrapconnection( nil, listeners, client, address, port, "clientport", pattern, sslctx )
881 --// EXPERIMENTAL //--
883 ----------------------------------// BEGIN //--
885 use "setmetatable" ( _socketlist, { __mode = "k" } )
886 use "setmetatable" ( _readtimes, { __mode = "k" } )
887 use "setmetatable" ( _writetimes, { __mode = "k" } )
889 _timer = luasocket_gettime( )
890 _starttime = luasocket_gettime( )
892 addtimer( function( )
893 local difftime = os_difftime( _currenttime - _starttime )
894 if difftime > _checkinterval then
895 _starttime = _currenttime
896 for handler, timestamp in pairs( _writetimes ) do
897 if os_difftime( _currenttime - timestamp ) > _sendtimeout then
898 --_writetimes[ handler ] = nil
899 handler.disconnect( )( handler, "send timeout" )
900 handler:close( true ) -- forced disconnect
903 for handler, timestamp in pairs( _readtimes ) do
904 if os_difftime( _currenttime - timestamp ) > _readtimeout then
905 --_readtimes[ handler ] = nil
906 handler.disconnect( )( handler, "read timeout" )
907 handler:close( ) -- forced disconnect?
914 local function setlogger(new_logger)
915 local old_logger = log;
922 ----------------------------------// PUBLIC INTERFACE //--
926 addclient = addclient,
927 wrapclient = wrapclient,
935 addserver = addserver,
936 getserver = getserver,
937 setlogger = setlogger,
938 getsettings = getsettings,
939 setquitting = setquitting,
940 removeserver = removeserver,
941 get_backend = get_backend,
942 changesettings = changesettings,