2 -- server.lua by blastbeat of the luadch project
3 -- Re-used here under the MIT/X Consortium License
5 -- Modifications (C) 2008-2009 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 = select( 2, pcall( require, "ssl" ) )
59 local luasocket = 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
256 local bufferqueue = { } -- buffer array
257 local bufferqueuelen = 0 -- end of buffer array
268 local sendtraffic, readtraffic = 0, 0
270 local maxsendlen = _maxsendlen
271 local maxreadlen = _maxreadlen
273 --// public methods of the object //--
275 local handler = bufferqueue -- saves a table ^_^
277 handler.dispatch = function( )
280 handler.disconnect = function( )
283 handler.setlistener = function( self, listeners )
284 dispatch = listeners.onincoming
285 disconnect = listeners.ondisconnect
286 status = listeners.onstatus
288 handler.getstats = function( )
289 return readtraffic, sendtraffic
291 handler.ssl = function( )
294 handler.sslctx = function ( )
297 handler.send = function( _, data, i, j )
298 return send( socket, data, i, j )
300 handler.receive = function( pattern, prefix )
301 return receive( socket, pattern, prefix )
303 handler.shutdown = function( pattern )
304 return shutdown( socket, pattern )
306 handler.setoption = function (self, option, value)
307 if socket.setoption then
308 return socket:setoption(option, value);
310 return false, "setoption not implemented";
312 handler.close = function( self, forced )
313 if not handler then return true; end
314 _readlistlen = removesocket( _readlist, socket, _readlistlen )
315 _readtimes[ handler ] = nil
316 if bufferqueuelen ~= 0 then
317 if not ( forced or fatalerror ) then
318 handler.sendbuffer( )
319 if bufferqueuelen ~= 0 then -- try again...
321 handler.write = nil -- ... but no further writing allowed
327 send( socket, table_concat( bufferqueue, "", 1, bufferqueuelen ), 1, bufferlen ) -- forced send
331 _ = shutdown and shutdown( socket )
333 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
334 _socketlist[ socket ] = nil
337 out_put "server.lua: socket already closed"
340 _writetimes[ handler ] = nil
341 _closelist[ handler ] = nil
347 out_put "server.lua: closed client handler and removed socket from list"
350 handler.ip = function( )
353 handler.serverport = function( )
356 handler.clientport = function( )
359 local write = function( self, data )
360 bufferlen = bufferlen + string_len( data )
361 if bufferlen > maxsendlen then
362 _closelist[ handler ] = "send buffer exceeded" -- cannot close the client at the moment, have to wait to the end of the cycle
363 handler.write = idfalse -- dont write anymore
365 elseif socket and not _sendlist[ socket ] then
366 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
368 bufferqueuelen = bufferqueuelen + 1
369 bufferqueue[ bufferqueuelen ] = data
371 _writetimes[ handler ] = _writetimes[ handler ] or _currenttime
375 handler.write = write
376 handler.bufferqueue = function( self )
379 handler.socket = function( self )
382 handler.pattern = function( self, new )
383 pattern = new or pattern
386 handler.set_send = function ( self, newsend )
387 send = newsend or send
390 handler.bufferlen = function( self, readlen, sendlen )
391 maxsendlen = sendlen or maxsendlen
392 maxreadlen = readlen or maxreadlen
393 return bufferlen, maxreadlen, maxsendlen
395 handler.lock_read = function (self, switch)
396 if switch == true then
397 local tmp = _readlistlen
398 _readlistlen = removesocket( _readlist, socket, _readlistlen )
399 _readtimes[ handler ] = nil
400 if _readlistlen ~= tmp then
403 elseif switch == false then
406 _readlistlen = addsocket(_readlist, socket, _readlistlen)
407 _readtimes[ handler ] = _currenttime
412 handler.lock = function( self, switch )
413 handler.lock_read (switch)
414 if switch == true then
415 handler.write = idfalse
416 local tmp = _sendlistlen
417 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
418 _writetimes[ handler ] = nil
419 if _sendlistlen ~= tmp then
422 elseif switch == false then
423 handler.write = write
429 return noread, nosend
431 local _readbuffer = function( ) -- this function reads data
432 local buffer, err, part = receive( socket, pattern ) -- receive buffer with "pattern"
433 if not err or (err == "wantread" or err == "timeout") or string_len(part) > 0 then -- received something
434 local buffer = buffer or part or ""
435 local len = string_len( buffer )
436 if len > maxreadlen then
437 disconnect( handler, "receive buffer exceeded" )
438 handler.close( true )
441 local count = len * STAT_UNIT
442 readtraffic = readtraffic + count
443 _readtraffic = _readtraffic + count
444 _readtimes[ handler ] = _currenttime
445 --out_put( "server.lua: read data '", buffer:gsub("[^%w%p ]", "."), "', error: ", err )
446 return dispatch( handler, buffer, err )
447 else -- connections was closed or fatal error
448 out_put( "server.lua: client ", tostring(ip), ":", tostring(clientport), " read error: ", tostring(err) )
450 disconnect( handler, err )
451 _ = handler and handler.close( )
455 local _sendbuffer = function( ) -- this function sends data
456 local succ, err, byte, buffer, count;
459 buffer = table_concat( bufferqueue, "", 1, bufferqueuelen )
460 succ, err, byte = send( socket, buffer, 1, bufferlen )
461 count = ( succ or byte or 0 ) * STAT_UNIT
462 sendtraffic = sendtraffic + count
463 _sendtraffic = _sendtraffic + count
464 _ = _cleanqueue and clean( bufferqueue )
465 --out_put( "server.lua: sended '", buffer, "', bytes: ", tostring(succ), ", error: ", tostring(err), ", part: ", tostring(byte), ", to: ", tostring(ip), ":", tostring(clientport) )
467 succ, err, count = false, "closed", 0;
469 if succ then -- sending succesful
472 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen ) -- delete socket from writelist
473 _ = needtls and handler:starttls(nil, true)
474 _writetimes[ handler ] = nil
475 _ = toclose and handler.close( )
477 elseif byte and ( err == "timeout" or err == "wantwrite" ) then -- want write
478 buffer = string_sub( buffer, byte + 1, bufferlen ) -- new buffer
479 bufferqueue[ 1 ] = buffer -- insert new buffer in queue
481 bufferlen = bufferlen - byte
482 _writetimes[ handler ] = _currenttime
484 else -- connection was closed during sending or fatal error
485 out_put( "server.lua: client ", tostring(ip), ":", tostring(clientport), " write error: ", tostring(err) )
487 disconnect( handler, err )
488 _ = handler and handler.close( )
495 function handler.set_sslctx(self, new_sslctx)
500 handshake = coroutine_wrap( function( client ) -- create handshake coroutine
502 for i = 1, _maxsslhandshake do
503 _sendlistlen = ( wrote and removesocket( _sendlist, client, _sendlistlen ) ) or _sendlistlen
504 _readlistlen = ( read and removesocket( _readlist, client, _readlistlen ) ) or _readlistlen
505 read, wrote = nil, nil
506 _, err = client:dohandshake( )
508 out_put( "server.lua: ssl handshake done" )
509 handler.readbuffer = _readbuffer -- when handshake is done, replace the handshake function with regular functions
510 handler.sendbuffer = _sendbuffer
511 _ = status and status( handler, "ssl-handshake-complete" )
512 _readlistlen = addsocket(_readlist, client, _readlistlen)
515 out_put( "server.lua: error during ssl handshake: ", tostring(err) )
516 if err == "wantwrite" and not wrote then
517 _sendlistlen = addsocket(_sendlist, client, _sendlistlen)
519 elseif err == "wantread" and not read then
520 _readlistlen = addsocket(_readlist, client, _readlistlen)
525 --coroutine_yield( handler, nil, err ) -- handshake not finished
529 disconnect( handler, "ssl handshake failed" )
530 _ = handler and handler:close( true ) -- forced disconnect
531 return false -- handshake failed
536 if sslctx then -- ssl?
537 handler:set_sslctx(sslctx);
538 out_put("server.lua: ", "starting ssl handshake")
540 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
542 out_put( "server.lua: ssl error: ", tostring(err) )
544 return nil, nil, err -- fatal error
546 socket:settimeout( 0 )
547 handler.readbuffer = handshake
548 handler.sendbuffer = handshake
549 handshake( socket ) -- do handshake
551 return nil, nil, "ssl handshake failed";
555 handler.starttls = function( self, _sslctx, now )
558 handler:set_sslctx(sslctx);
561 out_put "server.lua: we need to do tls, but delaying until later"
565 out_put( "server.lua: attempting to start tls on " .. tostring( socket ) )
566 local oldsocket, err = socket
567 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
568 --out_put( "server.lua: sslwrapped socket is " .. tostring( socket ) )
570 out_put( "server.lua: error while starting tls on client: ", tostring(err) )
571 return nil, err -- fatal error
574 socket:settimeout( 0 )
576 -- add the new socket to our system
579 receive = socket.receive
582 _socketlist[ socket ] = handler
583 _readlistlen = addsocket(_readlist, socket, _readlistlen)
585 -- remove traces of the old socket
587 _readlistlen = removesocket( _readlist, oldsocket, _readlistlen )
588 _sendlistlen = removesocket( _sendlist, oldsocket, _sendlistlen )
589 _socketlist[ oldsocket ] = nil
591 handler.starttls = nil
597 handler.readbuffer = handshake
598 handler.sendbuffer = handshake
599 handshake( socket ) -- do handshake
601 handler.readbuffer = _readbuffer
602 handler.sendbuffer = _sendbuffer
607 receive = socket.receive
608 shutdown = ( ssl and id ) or socket.shutdown
610 _socketlist[ socket ] = handler
611 _readlistlen = addsocket(_readlist, socket, _readlistlen)
613 return handler, socket
619 idfalse = function( )
623 addsocket = function( list, socket, len )
624 if not list[ socket ] then
632 removesocket = function( list, socket, len ) -- this function removes sockets from a list ( copied from copas )
633 local pos = list[ socket ]
636 local last = list[ len ]
638 if last ~= socket then
647 closesocket = function( socket )
648 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
649 _readlistlen = removesocket( _readlist, socket, _readlistlen )
650 _socketlist[ socket ] = nil
655 ----------------------------------// PUBLIC //--
657 addserver = function( addr, port, listeners, pattern, sslctx ) -- this function provides a way for other scripts to reg a server
659 if type( listeners ) ~= "table" then
660 err = "invalid listener table"
662 if not type( port ) == "number" or not ( port >= 0 and port <= 65535 ) then
664 elseif _server[ port ] then
665 err = "listeners on port '" .. port .. "' already exist"
666 elseif sslctx and not luasec then
667 err = "luasec not found"
670 out_error( "server.lua, port ", port, ": ", err )
674 local server, err = socket_bind( addr, port )
676 out_error( "server.lua, port ", port, ": ", err )
679 local handler, err = wrapserver( listeners, server, addr, port, pattern, sslctx, _maxclientsperserver ) -- wrap new server socket
684 server:settimeout( 0 )
685 _readlistlen = addsocket(_readlist, server, _readlistlen)
686 _server[ port ] = handler
687 _socketlist[ server ] = handler
688 out_put( "server.lua: new "..(sslctx and "ssl " or "").."server listener on '", addr, ":", port, "'" )
692 getserver = function ( port )
693 return _server[ port ];
696 removeserver = function( port )
697 local handler = _server[ port ]
699 return nil, "no server found on port '" .. tostring( port ) .. "'"
702 _server[ port ] = nil
706 closeall = function( )
707 for _, handler in pairs( _socketlist ) do
709 _socketlist[ _ ] = nil
722 getsettings = function( )
723 return _selecttimeout, _sleeptime, _maxsendlen, _maxreadlen, _checkinterval, _sendtimeout, _readtimeout, _cleanqueue, _maxclientsperserver, _maxsslhandshake
726 changesettings = function( new )
727 if type( new ) ~= "table" then
728 return nil, "invalid settings table"
730 _selecttimeout = tonumber( new.timeout ) or _selecttimeout
731 _sleeptime = tonumber( new.sleeptime ) or _sleeptime
732 _maxsendlen = tonumber( new.maxsendlen ) or _maxsendlen
733 _maxreadlen = tonumber( new.maxreadlen ) or _maxreadlen
734 _checkinterval = tonumber( new.checkinterval ) or _checkinterval
735 _sendtimeout = tonumber( new.sendtimeout ) or _sendtimeout
736 _readtimeout = tonumber( new.readtimeout ) or _readtimeout
737 _cleanqueue = new.cleanqueue
738 _maxclientsperserver = new._maxclientsperserver or _maxclientsperserver
739 _maxsslhandshake = new._maxsslhandshake or _maxsslhandshake
743 addtimer = function( listener )
744 if type( listener ) ~= "function" then
745 return nil, "invalid listener function"
747 _timerlistlen = _timerlistlen + 1
748 _timerlist[ _timerlistlen ] = listener
753 return _readtraffic, _sendtraffic, _readlistlen, _sendlistlen, _timerlistlen
756 local dontstop = true; -- thinking about tomorrow, ...
758 setquitting = function (quit)
763 loop = function( ) -- this is the main loop of the program
765 local read, write, err = socket_select( _readlist, _sendlist, _selecttimeout )
766 for i, socket in ipairs( write ) do -- send data waiting in writequeues
767 local handler = _socketlist[ socket ]
769 handler.sendbuffer( )
771 closesocket( socket )
772 out_put "server.lua: found no handler and closed socket (writelist)" -- this should not happen
775 for i, socket in ipairs( read ) do -- receive data
776 local handler = _socketlist[ socket ]
778 handler.readbuffer( )
780 closesocket( socket )
781 out_put "server.lua: found no handler and closed socket (readlist)" -- this can happen
784 for handler, err in pairs( _closelist ) do
785 handler.disconnect( )( handler, err )
786 handler:close( true ) -- forced disconnect
789 _currenttime = os_time( )
790 if os_difftime( _currenttime - _timer ) >= 1 then
791 for i = 1, _timerlistlen do
792 _timerlist[ i ]( _currenttime ) -- fire timers
794 _timer = _currenttime
796 socket_sleep( _sleeptime ) -- wait some time
802 local function get_backend()
806 --// EXPERIMENTAL //--
808 local wrapclient = function( socket, ip, serverport, listeners, pattern, sslctx )
809 local handler = wrapconnection( nil, listeners, socket, ip, serverport, "clientport", pattern, sslctx )
810 _socketlist[ socket ] = handler
811 _sendlistlen = addsocket(_sendlist, socket, _sendlistlen)
812 return handler, socket
815 local addclient = function( address, port, listeners, pattern, sslctx )
816 local client, err = luasocket.tcp( )
820 client:settimeout( 0 )
821 _, err = client:connect( address, port )
822 if err then -- try again
823 local handler = wrapclient( client, address, port, listeners )
825 wrapconnection( nil, listeners, client, address, port, "clientport", pattern, sslctx )
829 --// EXPERIMENTAL //--
831 ----------------------------------// BEGIN //--
833 use "setmetatable" ( _socketlist, { __mode = "k" } )
834 use "setmetatable" ( _readtimes, { __mode = "k" } )
835 use "setmetatable" ( _writetimes, { __mode = "k" } )
838 _starttime = os_time( )
840 addtimer( function( )
841 local difftime = os_difftime( _currenttime - _starttime )
842 if difftime > _checkinterval then
843 _starttime = _currenttime
844 for handler, timestamp in pairs( _writetimes ) do
845 if os_difftime( _currenttime - timestamp ) > _sendtimeout then
846 --_writetimes[ handler ] = nil
847 handler.disconnect( )( handler, "send timeout" )
848 handler:close( true ) -- forced disconnect
851 for handler, timestamp in pairs( _readtimes ) do
852 if os_difftime( _currenttime - timestamp ) > _readtimeout then
853 --_readtimes[ handler ] = nil
854 handler.disconnect( )( handler, "read timeout" )
855 handler:close( ) -- forced disconnect?
862 local function setlogger(new_logger)
863 local old_logger = log;
870 ----------------------------------// PUBLIC INTERFACE //--
874 addclient = addclient,
875 wrapclient = wrapclient,
881 addserver = addserver,
882 getserver = getserver,
883 setlogger = setlogger,
884 getsettings = getsettings,
885 setquitting = setquitting,
886 removeserver = removeserver,
887 get_backend = get_backend,
888 changesettings = changesettings,