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, 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()
196 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
197 _readlistlen = removesocket( _readlist, socket, _readlistlen )
198 _server[ip..":"..serverport] = nil;
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))
230 return dispatch( handler );
233 elseif err then -- maybe timeout or something else
234 out_put( "server.lua: error with new client connection: ", tostring(err) )
241 wrapconnection = function( server, listeners, socket, ip, serverport, clientport, pattern, sslctx ) -- this function wraps a client to a handler object
243 socket:settimeout( 0 )
245 --// local import of socket methods //--
251 --// private closures of the object //--
255 local dispatch = listeners.onincoming
256 local status = listeners.onstatus
257 local disconnect = listeners.ondisconnect
258 local drain = listeners.ondrain
260 local bufferqueue = { } -- buffer array
261 local bufferqueuelen = 0 -- end of buffer array
272 local sendtraffic, readtraffic = 0, 0
274 local maxsendlen = _maxsendlen
275 local maxreadlen = _maxreadlen
277 --// public methods of the object //--
279 local handler = bufferqueue -- saves a table ^_^
281 handler.dispatch = function( )
284 handler.disconnect = function( )
287 handler.setlistener = function( self, listeners )
288 dispatch = listeners.onincoming
289 disconnect = listeners.ondisconnect
290 status = listeners.onstatus
291 drain = listeners.ondrain
293 handler.getstats = function( )
294 return readtraffic, sendtraffic
296 handler.ssl = function( )
299 handler.sslctx = function ( )
302 handler.send = function( _, data, i, j )
303 return send( socket, data, i, j )
305 handler.receive = function( pattern, prefix )
306 return receive( socket, pattern, prefix )
308 handler.shutdown = function( pattern )
309 return shutdown( socket, pattern )
311 handler.setoption = function (self, option, value)
312 if socket.setoption then
313 return socket:setoption(option, value);
315 return false, "setoption not implemented";
317 handler.force_close = function ( self )
318 if bufferqueuelen ~= 0 then
319 out_put("discarding unwritten data for ", tostring(ip), ":", tostring(clientport))
320 for i = bufferqueuelen, 1, -1 do
321 bufferqueue[i] = nil;
327 handler.close = function( self )
328 if not handler then return true; end
329 _readlistlen = removesocket( _readlist, socket, _readlistlen )
330 _readtimes[ handler ] = nil
331 if bufferqueuelen ~= 0 then
332 handler.sendbuffer() -- Try now to send any outstanding data
333 if bufferqueuelen ~= 0 then -- Still not empty, so we'll try again later
335 handler.write = nil -- ... but no further writing allowed
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
353 local _handler = handler;
356 disconnect(_handler, false);
362 out_put "server.lua: closed client handler and removed socket from list"
365 handler.ip = function( )
368 handler.serverport = function( )
371 handler.clientport = function( )
374 local write = function( self, data )
375 bufferlen = bufferlen + string_len( data )
376 if bufferlen > maxsendlen then
377 _closelist[ handler ] = "send buffer exceeded" -- cannot close the client at the moment, have to wait to the end of the cycle
378 handler.write = idfalse -- dont write anymore
380 elseif socket and not _sendlist[ socket ] then
381 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
383 bufferqueuelen = bufferqueuelen + 1
384 bufferqueue[ bufferqueuelen ] = data
386 _writetimes[ handler ] = _writetimes[ handler ] or _currenttime
390 handler.write = write
391 handler.bufferqueue = function( self )
394 handler.socket = function( self )
397 handler.set_mode = function( self, new )
398 pattern = new or pattern
401 handler.set_send = function ( self, newsend )
402 send = newsend or send
405 handler.bufferlen = function( self, readlen, sendlen )
406 maxsendlen = sendlen or maxsendlen
407 maxreadlen = readlen or maxreadlen
408 return bufferlen, maxreadlen, maxsendlen
411 handler.lock_read = function (self, switch)
412 if switch == true then
413 local tmp = _readlistlen
414 _readlistlen = removesocket( _readlist, socket, _readlistlen )
415 _readtimes[ handler ] = nil
416 if _readlistlen ~= tmp then
419 elseif switch == false then
422 _readlistlen = addsocket(_readlist, socket, _readlistlen)
423 _readtimes[ handler ] = _currenttime
428 handler.pause = function (self)
429 return self:lock_read(true);
431 handler.resume = function (self)
432 return self:lock_read(false);
434 handler.lock = function( self, switch )
435 handler.lock_read (switch)
436 if switch == true then
437 handler.write = idfalse
438 local tmp = _sendlistlen
439 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
440 _writetimes[ handler ] = nil
441 if _sendlistlen ~= tmp then
444 elseif switch == false then
445 handler.write = write
451 return noread, nosend
453 local _readbuffer = function( ) -- this function reads data
454 local buffer, err, part = receive( socket, pattern ) -- receive buffer with "pattern"
455 if not err or (err == "wantread" or err == "timeout") then -- received something
456 local buffer = buffer or part or ""
457 local len = string_len( buffer )
458 if len > maxreadlen then
459 disconnect( handler, "receive buffer exceeded" )
460 handler:close( true )
463 local count = len * STAT_UNIT
464 readtraffic = readtraffic + count
465 _readtraffic = _readtraffic + count
466 _readtimes[ handler ] = _currenttime
467 --out_put( "server.lua: read data '", buffer:gsub("[^%w%p ]", "."), "', error: ", err )
468 return dispatch( handler, buffer, err )
469 else -- connections was closed or fatal error
470 out_put( "server.lua: client ", tostring(ip), ":", tostring(clientport), " read error: ", tostring(err) )
472 disconnect( handler, err )
473 _ = handler and handler:close( )
477 local _sendbuffer = function( ) -- this function sends data
478 local succ, err, byte, buffer, count;
481 buffer = table_concat( bufferqueue, "", 1, bufferqueuelen )
482 succ, err, byte = send( socket, buffer, 1, bufferlen )
483 count = ( succ or byte or 0 ) * STAT_UNIT
484 sendtraffic = sendtraffic + count
485 _sendtraffic = _sendtraffic + count
486 _ = _cleanqueue and clean( bufferqueue )
487 --out_put( "server.lua: sended '", buffer, "', bytes: ", tostring(succ), ", error: ", tostring(err), ", part: ", tostring(byte), ", to: ", tostring(ip), ":", tostring(clientport) )
489 succ, err, count = false, "unexpected close", 0;
491 if succ then -- sending succesful
494 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen ) -- delete socket from writelist
495 _writetimes[ handler ] = nil
499 _ = needtls and handler:starttls(nil)
500 _ = toclose and handler:force_close( )
502 elseif byte and ( err == "timeout" or err == "wantwrite" ) then -- want write
503 buffer = string_sub( buffer, byte + 1, bufferlen ) -- new buffer
504 bufferqueue[ 1 ] = buffer -- insert new buffer in queue
506 bufferlen = bufferlen - byte
507 _writetimes[ handler ] = _currenttime
509 else -- connection was closed during sending or fatal error
510 out_put( "server.lua: client ", tostring(ip), ":", tostring(clientport), " write error: ", tostring(err) )
512 disconnect( handler, err )
513 _ = handler and handler:force_close( )
520 function handler.set_sslctx(self, new_sslctx)
523 handshake = coroutine_wrap( function( client ) -- create handshake coroutine
525 for i = 1, _maxsslhandshake do
526 _sendlistlen = ( wrote and removesocket( _sendlist, client, _sendlistlen ) ) or _sendlistlen
527 _readlistlen = ( read and removesocket( _readlist, client, _readlistlen ) ) or _readlistlen
528 read, wrote = nil, nil
529 _, err = client:dohandshake( )
531 out_put( "server.lua: ssl handshake done" )
532 handler.readbuffer = _readbuffer -- when handshake is done, replace the handshake function with regular functions
533 handler.sendbuffer = _sendbuffer
534 _ = status and status( handler, "ssl-handshake-complete" )
535 if self.autostart_ssl and listeners.onconnect then
536 listeners.onconnect(self);
538 _readlistlen = addsocket(_readlist, client, _readlistlen)
541 if err == "wantwrite" then
542 _sendlistlen = addsocket(_sendlist, client, _sendlistlen)
544 elseif err == "wantread" then
545 _readlistlen = addsocket(_readlist, client, _readlistlen)
551 coroutine_yield( ) -- handshake not finished
554 out_put( "server.lua: ssl handshake error: ", tostring(err or "handshake too long") )
555 disconnect( handler, "ssl handshake failed" )
556 _ = handler and handler:force_close()
557 return false, err -- handshake failed
562 handler.starttls = function( self, _sslctx)
564 handler:set_sslctx(_sslctx);
566 if bufferqueuelen > 0 then
567 out_put "server.lua: we need to do tls, but delaying until send buffer empty"
571 out_put( "server.lua: attempting to start tls on " .. tostring( socket ) )
572 local oldsocket, err = socket
573 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
575 out_put( "server.lua: error while starting tls on client: ", tostring(err or "unknown error") )
576 return nil, err -- fatal error
579 socket:settimeout( 0 )
581 -- add the new socket to our system
583 receive = socket.receive
585 _socketlist[ socket ] = handler
586 _readlistlen = addsocket(_readlist, socket, _readlistlen)
588 -- remove traces of the old socket
589 _readlistlen = removesocket( _readlist, oldsocket, _readlistlen )
590 _sendlistlen = removesocket( _sendlist, oldsocket, _sendlistlen )
591 _socketlist[ oldsocket ] = nil
593 handler.starttls = nil
596 -- Secure now (if handshake fails connection will close)
599 handler.readbuffer = handshake
600 handler.sendbuffer = handshake
601 return handshake( socket ) -- do handshake
605 handler.readbuffer = _readbuffer
606 handler.sendbuffer = _sendbuffer
608 receive = socket.receive
609 shutdown = ( ssl and id ) or socket.shutdown
611 _socketlist[ socket ] = handler
612 _readlistlen = addsocket(_readlist, socket, _readlistlen)
614 if sslctx and luasec then
615 out_put "server.lua: auto-starting ssl negotiation..."
616 handler.autostart_ssl = true;
617 local ok, err = handler:starttls(sslctx);
623 return handler, socket
629 idfalse = function( )
633 addsocket = function( list, socket, len )
634 if not list[ socket ] then
642 removesocket = function( list, socket, len ) -- this function removes sockets from a list ( copied from copas )
643 local pos = list[ socket ]
646 local last = list[ len ]
648 if last ~= socket then
657 closesocket = function( socket )
658 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
659 _readlistlen = removesocket( _readlist, socket, _readlistlen )
660 _socketlist[ socket ] = nil
665 local function link(sender, receiver, buffersize)
667 local _sendbuffer = receiver.sendbuffer;
668 function receiver.sendbuffer()
670 if sender_locked and receiver.bufferlen() < buffersize then
671 sender:lock_read(false); -- Unlock now
676 local _readbuffer = sender.readbuffer;
677 function sender.readbuffer()
679 if not sender_locked and receiver.bufferlen() >= buffersize then
680 sender_locked = true;
681 sender:lock_read(true);
686 ----------------------------------// PUBLIC //--
688 addserver = function( addr, port, listeners, pattern, sslctx ) -- this function provides a way for other scripts to reg a server
690 if type( listeners ) ~= "table" then
691 err = "invalid listener table"
693 if type( port ) ~= "number" or not ( port >= 0 and port <= 65535 ) then
695 elseif _server[ addr..":"..port ] then
696 err = "listeners on '[" .. addr .. "]:" .. port .. "' already exist"
697 elseif sslctx and not luasec then
698 err = "luasec not found"
701 out_error( "server.lua, [", addr, "]:", port, ": ", err )
705 local server, err = socket_bind( addr, port )
707 out_error( "server.lua, [", addr, "]:", port, ": ", err )
710 local handler, err = wrapserver( listeners, server, addr, port, pattern, sslctx, _maxclientsperserver ) -- wrap new server socket
715 server:settimeout( 0 )
716 _readlistlen = addsocket(_readlist, server, _readlistlen)
717 _server[ addr..":"..port ] = handler
718 _socketlist[ server ] = handler
719 out_put( "server.lua: new "..(sslctx and "ssl " or "").."server listener on '[", addr, "]:", port, "'" )
723 getserver = function ( addr, port )
724 return _server[ addr..":"..port ];
727 removeserver = function( addr, port )
728 local handler = _server[ addr..":"..port ]
730 return nil, "no server found on '[" .. addr .. "]:" .. tostring( port ) .. "'"
733 _server[ addr..":"..port ] = nil
737 closeall = function( )
738 for _, handler in pairs( _socketlist ) do
740 _socketlist[ _ ] = nil
753 getsettings = function( )
754 return _selecttimeout, _sleeptime, _maxsendlen, _maxreadlen, _checkinterval, _sendtimeout, _readtimeout, _cleanqueue, _maxclientsperserver, _maxsslhandshake
757 changesettings = function( new )
758 if type( new ) ~= "table" then
759 return nil, "invalid settings table"
761 _selecttimeout = tonumber( new.timeout ) or _selecttimeout
762 _sleeptime = tonumber( new.sleeptime ) or _sleeptime
763 _maxsendlen = tonumber( new.maxsendlen ) or _maxsendlen
764 _maxreadlen = tonumber( new.maxreadlen ) or _maxreadlen
765 _checkinterval = tonumber( new.checkinterval ) or _checkinterval
766 _sendtimeout = tonumber( new.sendtimeout ) or _sendtimeout
767 _readtimeout = tonumber( new.readtimeout ) or _readtimeout
768 _cleanqueue = new.cleanqueue
769 _maxclientsperserver = new._maxclientsperserver or _maxclientsperserver
770 _maxsslhandshake = new._maxsslhandshake or _maxsslhandshake
774 addtimer = function( listener )
775 if type( listener ) ~= "function" then
776 return nil, "invalid listener function"
778 _timerlistlen = _timerlistlen + 1
779 _timerlist[ _timerlistlen ] = listener
784 return _readtraffic, _sendtraffic, _readlistlen, _sendlistlen, _timerlistlen
789 local function setquitting(quit)
790 quitting = not not quit;
793 loop = function(once) -- this is the main loop of the program
794 if quitting then return "quitting"; end
795 if once then quitting = "once"; end
796 local next_timer_time = math_huge;
798 local read, write, err = socket_select( _readlist, _sendlist, math_min(_selecttimeout, next_timer_time) )
799 for i, socket in ipairs( write ) do -- send data waiting in writequeues
800 local handler = _socketlist[ socket ]
802 handler.sendbuffer( )
804 closesocket( socket )
805 out_put "server.lua: found no handler and closed socket (writelist)" -- this should not happen
808 for i, socket in ipairs( read ) do -- receive data
809 local handler = _socketlist[ socket ]
811 handler.readbuffer( )
813 closesocket( socket )
814 out_put "server.lua: found no handler and closed socket (readlist)" -- this can happen
817 for handler, err in pairs( _closelist ) do
818 handler.disconnect( )( handler, err )
819 handler:force_close() -- forced disconnect
822 _currenttime = luasocket_gettime( )
823 if _currenttime - _timer >= math_min(next_timer_time, 1) then
824 next_timer_time = math_huge;
825 for i = 1, _timerlistlen do
826 local t = _timerlist[ i ]( _currenttime ) -- fire timers
827 if t then next_timer_time = math_min(next_timer_time, t); end
829 _timer = _currenttime
831 next_timer_time = next_timer_time - (_currenttime - _timer);
833 socket_sleep( _sleeptime ) -- wait some time
836 if once and quitting == "once" then quitting = nil; return; end
840 local function step()
844 local function get_backend()
848 --// EXPERIMENTAL //--
850 local wrapclient = function( socket, ip, serverport, listeners, pattern, sslctx )
851 local handler = wrapconnection( nil, listeners, socket, ip, serverport, "clientport", pattern, sslctx )
852 _socketlist[ socket ] = handler
854 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
855 if listeners.onconnect then
856 -- When socket is writeable, call onconnect
857 local _sendbuffer = handler.sendbuffer;
858 handler.sendbuffer = function ()
859 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen );
860 handler.sendbuffer = _sendbuffer;
861 listeners.onconnect(handler);
862 -- If there was data with the incoming packet, handle it now.
863 if #handler:bufferqueue() > 0 then
864 return _sendbuffer();
869 return handler, socket
872 local addclient = function( address, port, listeners, pattern, sslctx )
873 local client, err = luasocket.tcp( )
877 client:settimeout( 0 )
878 _, err = client:connect( address, port )
879 if err then -- try again
880 local handler = wrapclient( client, address, port, listeners )
882 wrapconnection( nil, listeners, client, address, port, "clientport", pattern, sslctx )
886 --// EXPERIMENTAL //--
888 ----------------------------------// BEGIN //--
890 use "setmetatable" ( _socketlist, { __mode = "k" } )
891 use "setmetatable" ( _readtimes, { __mode = "k" } )
892 use "setmetatable" ( _writetimes, { __mode = "k" } )
894 _timer = luasocket_gettime( )
895 _starttime = luasocket_gettime( )
897 addtimer( function( )
898 local difftime = os_difftime( _currenttime - _starttime )
899 if difftime > _checkinterval then
900 _starttime = _currenttime
901 for handler, timestamp in pairs( _writetimes ) do
902 if os_difftime( _currenttime - timestamp ) > _sendtimeout then
903 --_writetimes[ handler ] = nil
904 handler.disconnect( )( handler, "send timeout" )
905 handler:force_close() -- forced disconnect
908 for handler, timestamp in pairs( _readtimes ) do
909 if os_difftime( _currenttime - timestamp ) > _readtimeout then
910 --_readtimes[ handler ] = nil
911 handler.disconnect( )( handler, "read timeout" )
912 handler:close( ) -- forced disconnect?
919 local function setlogger(new_logger)
920 local old_logger = log;
927 ----------------------------------// PUBLIC INTERFACE //--
930 _addtimer = addtimer,
932 addclient = addclient,
933 wrapclient = wrapclient,
940 addserver = addserver,
941 getserver = getserver,
942 setlogger = setlogger,
943 getsettings = getsettings,
944 setquitting = setquitting,
945 removeserver = removeserver,
946 get_backend = get_backend,
947 changesettings = changesettings,