3 server.lua by blastbeat
\r
5 - this script contains the server loop of the program
\r
6 - other scripts can reg a server here
\r
10 -- // wrapping luadch stuff // --
\r
12 local use = function( what )
\r
15 local clean = function( tbl )
\r
16 for i, k in pairs( tbl ) do
\r
21 local log, table_concat = require ("util.logger").init("socket"), table.concat;
\r
22 local out_put = function (...) return log("debug", table_concat{...}); end
\r
23 local out_error = function (...) return log("warn", table_concat{...}); end
\r
24 local mem_free = collectgarbage
\r
26 ----------------------------------// DECLARATION //--
\r
30 local STAT_UNIT = 1 -- byte
\r
32 --// lua functions //--
\r
34 local type = use "type"
\r
35 local pairs = use "pairs"
\r
36 local ipairs = use "ipairs"
\r
37 local tostring = use "tostring"
\r
38 local collectgarbage = use "collectgarbage"
\r
43 local table = use "table"
\r
44 local string = use "string"
\r
45 local coroutine = use "coroutine"
\r
47 --// lua lib methods //--
\r
49 local os_time = os.time
\r
50 local os_difftime = os.difftime
\r
51 local table_concat = table.concat
\r
52 local table_remove = table.remove
\r
53 local string_len = string.len
\r
54 local string_sub = string.sub
\r
55 local coroutine_wrap = coroutine.wrap
\r
56 local coroutine_yield = coroutine.yield
\r
58 --// extern libs //--
\r
60 local luasec = select( 2, pcall( require, "ssl" ) )
\r
61 local luasocket = require "socket"
\r
63 --// extern lib methods //--
\r
65 local ssl_wrap = ( luasec and luasec.wrap )
\r
66 local socket_bind = luasocket.bind
\r
67 local socket_sleep = luasocket.sleep
\r
68 local socket_select = luasocket.select
\r
69 local ssl_newcontext = ( luasec and luasec.newcontext )
\r
86 local wrapconnection
\r
87 local changesettings
\r
100 --// simple data types //--
\r
105 local _timerlistlen
\r
110 local _selecttimeout
\r
119 local _checkinterval
\r
127 local _maxclientsperserver
\r
129 ----------------------------------// DEFINITION //--
\r
131 _server = { } -- key = port, value = table; list of listening servers
\r
132 _readlist = { } -- array with sockets to read from
\r
133 _sendlist = { } -- arrary with sockets to write to
\r
134 _timerlist = { } -- array of timer functions
\r
135 _socketlist = { } -- key = socket, value = wrapped socket (handlers)
\r
136 _readtimes = { } -- key = handler, value = timestamp of last data reading
\r
137 _writetimes = { } -- key = handler, value = timestamp of last data writing/sending
\r
138 _closelist = { } -- handlers to close
\r
140 _readlistlen = 0 -- length of readlist
\r
141 _sendlistlen = 0 -- length of sendlist
\r
142 _timerlistlen = 0 -- lenght of timerlist
\r
144 _sendtraffic = 0 -- some stats
\r
147 _selecttimeout = 1 -- timeout of socket.select
\r
148 _sleeptime = 0 -- time to wait at the end of every loop
\r
150 _maxsendlen = 51000 * 1024 -- max len of send buffer
\r
151 _maxreadlen = 25000 * 1024 -- max len of read buffer
\r
153 _checkinterval = 1200000 -- interval in secs to check idle clients
\r
154 _sendtimeout = 60000 -- allowed send idle time in secs
\r
155 _readtimeout = 6 * 60 * 60 -- allowed read idle time in secs
\r
157 _cleanqueue = false -- clean bufferqueue after using
\r
159 _maxclientsperserver = 1000
\r
161 ----------------------------------// PRIVATE //--
\r
163 wrapserver = function( listeners, socket, ip, serverport, pattern, sslctx, maxconnections, startssl ) -- this function wraps a server
\r
165 maxconnections = maxconnections or _maxclientsperserver
\r
167 local connections = 0
\r
169 local dispatch, disconnect = listeners.incoming or listeners.listener, listeners.disconnect
\r
176 if not ssl_newcontext then
\r
177 return nil, "luasec not found"
\r
179 if type( sslctx ) ~= "table" then
\r
180 out_error "server.lua: wrong server sslctx"
\r
181 return nil, "wrong server sslctx"
\r
183 sslctx, err = ssl_newcontext( sslctx )
\r
185 err = err or "wrong sslctx parameters"
\r
186 out_error( "server.lua: ", err )
\r
191 out_put("server.lua: ", "ssl not enabled on ", serverport);
\r
194 local accept = socket.accept
\r
196 --// public methods of the object //--
\r
198 local handler = { }
\r
200 handler.shutdown = function( ) end
\r
202 handler.ssl = function( )
\r
205 handler.remove = function( )
\r
206 connections = connections - 1
\r
208 handler.close = function( )
\r
209 for _, handler in pairs( _socketlist ) do
\r
210 if handler.serverport == serverport then
\r
211 handler.disconnect( handler, "server closed" )
\r
212 handler.close( true )
\r
216 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
\r
217 _readlistlen = removesocket( _readlist, socket, _readlistlen )
\r
218 _socketlist[ socket ] = nil
\r
222 out_put "server.lua: closed server handler and removed sockets from list"
\r
224 handler.ip = function( )
\r
227 handler.serverport = function( )
\r
230 handler.socket = function( )
\r
233 handler.readbuffer = function( )
\r
234 if connections > maxconnections then
\r
235 out_put( "server.lua: refused new client connection: server full" )
\r
238 local client, err = accept( socket ) -- try to accept
\r
240 local ip, clientport = client:getpeername( )
\r
241 client:settimeout( 0 )
\r
242 local handler, client, err = wrapconnection( handler, listeners, client, ip, serverport, clientport, pattern, sslctx, startssl ) -- wrap new client socket
\r
243 if err then -- error while wrapping ssl socket
\r
246 connections = connections + 1
\r
247 out_put( "server.lua: accepted new client connection from ", ip, ":", clientport, " to ", serverport)
\r
248 return dispatch( handler )
\r
249 elseif err then -- maybe timeout or something else
\r
250 out_put( "server.lua: error with new client connection: ", err )
\r
257 wrapconnection = function( server, listeners, socket, ip, serverport, clientport, pattern, sslctx, startssl ) -- this function wraps a client to a handler object
\r
259 socket:settimeout( 0 )
\r
261 --// local import of socket methods //--
\r
267 --// private closures of the object //--
\r
271 local dispatch = listeners.incoming or listeners.listener
\r
272 local disconnect = listeners.disconnect
\r
274 local bufferqueue = { } -- buffer array
\r
275 local bufferqueuelen = 0 -- end of buffer array
\r
281 local bufferlen = 0
\r
283 local noread = false
\r
284 local nosend = false
\r
286 local sendtraffic, readtraffic = 0, 0
\r
288 local maxsendlen = _maxsendlen
\r
289 local maxreadlen = _maxreadlen
\r
291 --// public methods of the object //--
\r
293 local handler = bufferqueue -- saves a table ^_^
\r
295 handler.dispatch = function( )
\r
298 handler.disconnect = function( )
\r
301 handler.setlistener = function( listeners )
\r
302 dispatch = listeners.incoming
\r
303 disconnect = listeners.disconnect
\r
305 handler.getstats = function( )
\r
306 return readtraffic, sendtraffic
\r
308 handler.ssl = function( )
\r
311 handler.send = function( _, data, i, j )
\r
312 return send( socket, data, i, j )
\r
314 handler.receive = function( pattern, prefix )
\r
315 return receive( socket, pattern, prefix )
\r
317 handler.shutdown = function( pattern )
\r
318 return shutdown( socket, pattern )
\r
320 handler.close = function( forced )
\r
321 if not handler then return true; end
\r
322 _readlistlen = removesocket( _readlist, socket, _readlistlen )
\r
323 _readtimes[ handler ] = nil
\r
324 if bufferqueuelen ~= 0 then
\r
325 if not ( forced or fatalerror ) then
\r
326 handler.sendbuffer( )
\r
327 if bufferqueuelen ~= 0 then -- try again...
\r
328 handler.write = nil -- ... but no further writing allowed
\r
333 send( socket, table_concat( bufferqueue, "", 1, bufferqueuelen ), 1, bufferlen ) -- forced send
\r
336 _ = shutdown and shutdown( socket )
\r
338 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
\r
339 _socketlist[ socket ] = nil
\r
340 _writetimes[ handler ] = nil
\r
341 _closelist[ handler ] = nil
\r
348 out_put "server.lua: closed client handler and removed socket from list"
\r
351 handler.ip = function( )
\r
354 handler.serverport = function( )
\r
357 handler.clientport = function( )
\r
360 local write = function( data )
\r
361 bufferlen = bufferlen + string_len( data )
\r
362 if bufferlen > maxsendlen then
\r
363 _closelist[ handler ] = "send buffer exceeded" -- cannot close the client at the moment, have to wait to the end of the cycle
\r
364 handler.write = idfalse -- dont write anymore
\r
366 elseif socket and not _sendlist[ socket ] then
\r
367 _sendlistlen = _sendlistlen + 1
\r
368 _sendlist[ _sendlistlen ] = socket
\r
369 _sendlist[ socket ] = _sendlistlen
\r
371 bufferqueuelen = bufferqueuelen + 1
\r
372 bufferqueue[ bufferqueuelen ] = data
\r
374 _writetimes[ handler ] = _writetimes[ handler ] or _currenttime
\r
378 handler.write = write
\r
379 handler.bufferqueue = function( )
\r
382 handler.socket = function( )
\r
385 handler.pattern = function( new )
\r
386 pattern = new or pattern
\r
389 handler.setsend = function ( newsend )
\r
390 send = newsend or send
\r
393 handler.bufferlen = function( readlen, sendlen )
\r
394 maxsendlen = sendlen or maxsendlen
\r
395 maxreadlen = readlen or maxreadlen
\r
396 return maxreadlen, maxsendlen
\r
398 handler.lock = function( switch )
\r
399 if switch == true then
\r
400 handler.write = idfalse
\r
401 local tmp = _sendlistlen
\r
402 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
\r
403 _writetimes[ handler ] = nil
\r
404 if _sendlistlen ~= tmp then
\r
408 _readlistlen = removesocket( _readlist, socket, _readlistlen )
\r
409 _readtimes[ handler ] = nil
\r
410 if _readlistlen ~= tmp then
\r
413 elseif switch == false then
\r
414 handler.write = write
\r
417 _readlistlen = _readlistlen + 1
\r
418 _readlist[ socket ] = _readlistlen
\r
419 _readlist[ _readlistlen ] = socket
\r
420 _readtimes[ handler ] = _currenttime
\r
427 return noread, nosend
\r
429 local _readbuffer = function( ) -- this function reads data
\r
430 local buffer, err, part = receive( socket, pattern ) -- receive buffer with "pattern"
\r
431 if not err or ( err == "timeout" or err == "wantread" ) then -- received something
\r
432 local buffer = buffer or part or ""
\r
433 local len = string_len( buffer )
\r
434 if len > maxreadlen then
\r
435 disconnect( handler, "receive buffer exceeded" )
\r
436 handler.close( true )
\r
439 local count = len * STAT_UNIT
\r
440 readtraffic = readtraffic + count
\r
441 _readtraffic = _readtraffic + count
\r
442 _readtimes[ handler ] = _currenttime
\r
443 --out_put( "server.lua: read data '", buffer, "', error: ", err )
\r
444 return dispatch( handler, buffer, err )
\r
445 else -- connections was closed or fatal error
\r
446 out_put( "server.lua: client ", ip, ":", tostring(clientport), " error: ", tostring(err) )
\r
448 disconnect( handler, err )
\r
449 _ = handler and handler.close( )
\r
453 local _sendbuffer = function( ) -- this function sends data
\r
454 local buffer = table_concat( bufferqueue, "", 1, bufferqueuelen )
\r
455 local succ, err, byte = send( socket, buffer, 1, bufferlen )
\r
456 local count = ( succ or byte or 0 ) * STAT_UNIT
\r
457 sendtraffic = sendtraffic + count
\r
458 _sendtraffic = _sendtraffic + count
\r
459 _ = _cleanqueue and clean( bufferqueue )
\r
460 --out_put( "server.lua: sended '", buffer, "', bytes: ", succ, ", error: ", err, ", part: ", byte, ", to: ", ip, ":", clientport )
\r
461 if succ then -- sending succesful
\r
464 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen ) -- delete socket from writelist
\r
465 _ = needtls and handler.starttls(true)
\r
466 _writetimes[ handler ] = nil
\r
467 _ = toclose and handler.close( )
\r
469 elseif byte and ( err == "timeout" or err == "wantwrite" ) then -- want write
\r
470 buffer = string_sub( buffer, byte + 1, bufferlen ) -- new buffer
\r
471 bufferqueue[ 1 ] = buffer -- insert new buffer in queue
\r
473 bufferlen = bufferlen - byte
\r
474 _writetimes[ handler ] = _currenttime
\r
476 else -- connection was closed during sending or fatal error
\r
477 out_put( "server.lua: client ", ip, ":", clientport, " error: ", err )
\r
479 disconnect( handler, err )
\r
480 _ = handler and handler.close( )
\r
485 if sslctx then -- ssl?
\r
489 local handshake = coroutine_wrap( function( client ) -- create handshake coroutine
\r
491 for i = 1, 10 do -- 10 handshake attemps
\r
492 _sendlistlen = ( wrote and removesocket( _sendlist, socket, _sendlistlen ) ) or _sendlistlen
\r
493 _readlistlen = ( read and removesocket( _readlist, socket, _readlistlen ) ) or _readlistlen
\r
494 read, wrote = nil, nil
\r
495 _, err = client:dohandshake( )
\r
497 out_put( "server.lua: ssl handshake done" )
\r
498 handler.readbuffer = _readbuffer -- when handshake is done, replace the handshake function with regular functions
\r
499 handler.sendbuffer = _sendbuffer
\r
500 -- return dispatch( handler )
\r
503 out_put( "server.lua: error during ssl handshake: ", err )
\r
504 if err == "wantwrite" and not wrote then
\r
505 _sendlistlen = _sendlistlen + 1
\r
506 _sendlist[ _sendlistlen ] = client
\r
508 elseif err == "wantread" and not read then
\r
509 _readlistlen = _readlistlen + 1
\r
510 _readlist [ _readlistlen ] = client
\r
515 --coroutine_yield( handler, nil, err ) -- handshake not finished
\r
519 disconnect( handler, "ssl handshake failed" )
\r
520 handler.close( true ) -- forced disconnect
\r
521 return false -- handshake failed
\r
524 if startssl then -- ssl now?
\r
525 --out_put("server.lua: ", "starting ssl handshake")
\r
527 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
\r
529 out_put( "server.lua: ssl error: ", err )
\r
531 return nil, nil, err -- fatal error
\r
533 socket:settimeout( 0 )
\r
534 handler.readbuffer = handshake
\r
535 handler.sendbuffer = handshake
\r
536 handshake( socket ) -- do handshake
\r
538 handler.starttls = function( now )
\r
540 --out_put "server.lua: we need to do tls, but delaying until later"
\r
544 --out_put( "server.lua: attempting to start tls on " .. tostring( socket ) )
\r
545 local oldsocket, err = socket
\r
546 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
\r
547 --out_put( "server.lua: sslwrapped socket is " .. tostring( socket ) )
\r
549 out_put( "server.lua: error while starting tls on client: ", err )
\r
550 return nil, err -- fatal error
\r
553 socket:settimeout( 0 )
\r
555 -- add the new socket to our system
\r
558 receive = socket.receive
\r
561 _socketlist[ socket ] = handler
\r
562 _readlistlen = _readlistlen + 1
\r
563 _readlist[ _readlistlen ] = socket
\r
564 _readlist[ socket ] = _readlistlen
\r
566 -- remove traces of the old socket
\r
568 _readlistlen = removesocket( _readlist, oldsocket, _readlistlen )
\r
569 _sendlistlen = removesocket( _sendlist, oldsocket, _sendlistlen )
\r
570 _socketlist[ oldsocket ] = nil
\r
572 handler.starttls = nil
\r
575 handler.readbuffer = handshake
\r
576 handler.sendbuffer = handshake
\r
577 handshake( socket ) -- do handshake
\r
579 handler.readbuffer = _readbuffer
\r
580 handler.sendbuffer = _sendbuffer
\r
582 else -- normal connection
\r
584 handler.readbuffer = _readbuffer
\r
585 handler.sendbuffer = _sendbuffer
\r
589 receive = socket.receive
\r
590 shutdown = ( ssl and id ) or socket.shutdown
\r
592 _socketlist[ socket ] = handler
\r
593 _readlistlen = _readlistlen + 1
\r
594 _readlist[ _readlistlen ] = socket
\r
595 _readlist[ socket ] = _readlistlen
\r
597 return handler, socket
\r
603 idfalse = function( )
\r
607 removesocket = function( list, socket, len ) -- this function removes sockets from a list ( copied from copas )
\r
608 local pos = list[ socket ]
\r
610 list[ socket ] = nil
\r
611 local last = list[ len ]
\r
613 if last ~= socket then
\r
622 closesocket = function( socket )
\r
623 _sendlistlen = removesocket( _sendlist, socket, _sendlistlen )
\r
624 _readlistlen = removesocket( _readlist, socket, _readlistlen )
\r
625 _socketlist[ socket ] = nil
\r
630 ----------------------------------// PUBLIC //--
\r
632 addserver = function( listeners, port, addr, pattern, sslctx, maxconnections, startssl ) -- this function provides a way for other scripts to reg a server
\r
634 --out_put("server.lua: autossl on ", port, " is ", startssl)
\r
635 if type( listeners ) ~= "table" then
\r
636 err = "invalid listener table"
\r
638 if not type( port ) == "number" or not ( port >= 0 and port <= 65535 ) then
\r
639 err = "invalid port"
\r
640 elseif _server[ port ] then
\r
641 err = "listeners on port '" .. port .. "' already exist"
\r
642 elseif sslctx and not luasec then
\r
643 err = "luasec not found"
\r
646 out_error( "server.lua: ", err )
\r
650 local server, err = socket_bind( addr, port )
\r
652 out_error( "server.lua: ", err )
\r
655 local handler, err = wrapserver( listeners, server, addr, port, pattern, sslctx, maxconnections, startssl ) -- wrap new server socket
\r
656 if not handler then
\r
660 server:settimeout( 0 )
\r
661 _readlistlen = _readlistlen + 1
\r
662 _readlist[ _readlistlen ] = server
\r
663 _server[ port ] = handler
\r
664 _socketlist[ server ] = handler
\r
665 out_put( "server.lua: new server listener on '", addr, ":", port, "'" )
\r
669 removeserver = function( port )
\r
670 local handler = _server[ port ]
\r
671 if not handler then
\r
672 return nil, "no server found on port '" .. tostring( port ) "'"
\r
678 closeall = function( )
\r
679 for _, handler in pairs( _socketlist ) do
\r
681 _socketlist[ _ ] = nil
\r
694 getsettings = function( )
\r
695 return _selecttimeout, _sleeptime, _maxsendlen, _maxreadlen, _checkinterval, _sendtimeout, _readtimeout, _cleanqueue, _maxclientsperserver
\r
698 changesettings = function( new )
\r
699 if type( new ) ~= "table" then
\r
700 return nil, "invalid settings table"
\r
702 _selecttimeout = tonumber( new.timeout ) or _selecttimeout
\r
703 _sleeptime = tonumber( new.sleeptime ) or _sleeptime
\r
704 _maxsendlen = tonumber( new.maxsendlen ) or _maxsendlen
\r
705 _maxreadlen = tonumber( new.maxreadlen ) or _maxreadlen
\r
706 _checkinterval = tonumber( new.checkinterval ) or _checkinterval
\r
707 _sendtimeout = tonumber( new.sendtimeout ) or _sendtimeout
\r
708 _readtimeout = tonumber( new.readtimeout ) or _readtimeout
\r
709 _cleanqueue = new.cleanqueue
\r
710 _maxclientsperserver = new._maxclientsperserver or _maxclientsperserver
\r
714 addtimer = function( listener )
\r
715 if type( listener ) ~= "function" then
\r
716 return nil, "invalid listener function"
\r
718 _timerlistlen = _timerlistlen + 1
\r
719 _timerlist[ _timerlistlen ] = listener
\r
723 stats = function( )
\r
724 return _readtraffic, _sendtraffic, _readlistlen, _sendlistlen, _timerlistlen
\r
727 loop = function( ) -- this is the main loop of the program
\r
729 local read, write, err = socket_select( _readlist, _sendlist, _selecttimeout )
\r
730 for i, socket in ipairs( write ) do -- send data waiting in writequeues
\r
731 local handler = _socketlist[ socket ]
\r
733 handler.sendbuffer( )
\r
735 closesocket( socket )
\r
736 out_put "server.lua: found no handler and closed socket (writelist)" -- this should not happen
\r
739 for i, socket in ipairs( read ) do -- receive data
\r
740 local handler = _socketlist[ socket ]
\r
742 handler.readbuffer( )
\r
744 closesocket( socket )
\r
745 out_put "server.lua: found no handler and closed socket (readlist)" -- this can happen
\r
748 for handler, err in pairs( _closelist ) do
\r
749 handler.disconnect( )( handler, err )
\r
750 handler.close( true ) -- forced disconnect
\r
752 clean( _closelist )
\r
753 _currenttime = os_time( )
\r
754 if os_difftime( _currenttime - _timer ) >= 1 then
\r
755 for i = 1, _timerlistlen do
\r
756 _timerlist[ i ]( ) -- fire timers
\r
758 _timer = _currenttime
\r
760 socket_sleep( _sleeptime ) -- wait some time
\r
761 --collectgarbage( )
\r
765 --// EXPERIMENTAL //--
\r
767 local wrapclient = function( socket, ip, serverport, listeners, pattern, sslctx, startssl )
\r
768 local handler = wrapconnection( nil, listeners, socket, ip, serverport, "clientport", pattern, sslctx, startssl )
\r
769 _socketlist[ socket ] = handler
\r
770 _sendlistlen = _sendlistlen + 1
\r
771 _sendlist[ _sendlistlen ] = socket
\r
772 _sendlist[ socket ] = _sendlistlen
\r
773 return handler, socket
\r
776 local addclient = function( address, port, listeners, pattern, sslctx, startssl )
\r
777 local client, err = socket.tcp( )
\r
781 client:settimeout( 0 )
\r
782 _, err = client:connect( address, port )
\r
783 if err then -- try again
\r
784 local handler = wrapclient( client, address, port, listeners )
\r
786 wrapconnection( server, listeners, socket, address, port, "clientport", pattern, sslctx, startssl )
\r
790 --// EXPERIMENTAL //--
\r
792 ----------------------------------// BEGIN //--
\r
794 use "setmetatable" ( _socketlist, { __mode = "k" } )
\r
795 use "setmetatable" ( _readtimes, { __mode = "k" } )
\r
796 use "setmetatable" ( _writetimes, { __mode = "k" } )
\r
798 _timer = os_time( )
\r
799 _starttime = os_time( )
\r
801 addtimer( function( )
\r
802 local difftime = os_difftime( _currenttime - _starttime )
\r
803 if difftime > _checkinterval then
\r
804 _starttime = _currenttime
\r
805 for handler, timestamp in pairs( _writetimes ) do
\r
806 if os_difftime( _currenttime - timestamp ) > _sendtimeout then
\r
807 --_writetimes[ handler ] = nil
\r
808 handler.disconnect( )( handler, "send timeout" )
\r
809 handler.close( true ) -- forced disconnect
\r
812 for handler, timestamp in pairs( _readtimes ) do
\r
813 if os_difftime( _currenttime - timestamp ) > _readtimeout then
\r
814 --_readtimes[ handler ] = nil
\r
815 handler.disconnect( )( handler, "read timeout" )
\r
816 handler.close( ) -- forced disconnect?
\r
823 ----------------------------------// PUBLIC INTERFACE //--
\r
827 addclient = addclient,
\r
828 wrapclient = wrapclient,
\r
832 closeall = closeall,
\r
833 addtimer = addtimer,
\r
834 addserver = addserver,
\r
835 getsettings = getsettings,
\r
836 removeserver = removeserver,
\r
837 changesettings = changesettings,
\r