3 server.lua by blastbeat of the luadch project
5 re-used here under the MIT/X Consortium License
7 Modifications (C) 2008 Matthew Wild, Waqas Hussain
10 ----------------------------------// DECLARATION //--
14 local STAT_UNIT = 1 / ( 1024 * 1024 ) -- mb
16 --// lua functions //--
18 local function use( what ) return _G[ what ] end
20 local type = use "type"
21 local pairs = use "pairs"
22 local ipairs = use "ipairs"
23 local tostring = use "tostring"
24 local collectgarbage = use "collectgarbage"
28 local table = use "table"
29 local coroutine = use "coroutine"
31 --// lua lib methods //--
33 local table_concat = table.concat
34 local table_remove = table.remove
35 local string_sub = use'string'.sub
36 local coroutine_wrap = coroutine.wrap
37 local coroutine_yield = coroutine.yield
40 local log = require "util.logger".init("server");
41 local out_put = function () end --print;
42 local out_error = function (...) log("error", table_concat({...}, " ")); end
46 local luasec = select(2, pcall(require, "ssl"))
47 local luasocket = require "socket"
49 --// extern lib methods //--
51 local ssl_wrap = ( luasec and luasec.wrap )
52 local socket_bind = luasocket.bind
53 local socket_select = luasocket.select
54 local ssl_newcontext = ( luasec and luasec.newcontext )
78 --// simple data types //--
81 local readlen = 0 -- length of readlist
82 local writelen = 0 -- lenght of writelist
87 ----------------------------------// DEFINITION //--
89 listener = { } -- key = port, value = table
90 readlist = { } -- array with sockets to read from
91 writelist = { } -- arrary with sockets to write to
92 socketlist = { } -- key = socket, value = wrapped socket
96 return receivestat, sendstat
99 wrapserver = function( listener, socket, ip, serverport, mode, sslctx, wrapper_function ) -- this function wraps a server
101 local dispatch, disconnect = listener.listener, listener.disconnect -- dangerous
103 local wrapclient, err
105 out_put("Starting a new server on "..tostring(serverport).." with ssl: "..tostring(sslctx));
107 if not ssl_newcontext then
108 return nil, "luasec not found"
110 if type( sslctx ) ~= "table" then
111 out_error "server.lua: wrong server sslctx"
112 return nil, "wrong server sslctx"
114 sslctx, err = ssl_newcontext( sslctx )
116 err = err or "wrong sslctx parameters"
117 out_error( "server.lua: ", err )
122 if wrapper_function then
123 wrapclient = wrapper_function
125 wrapclient = wrapsslclient
127 wrapclient = wraptcpclient
130 local accept = socket.accept
131 local close = socket.close
133 --// public methods of the object //--
137 handler.shutdown = function( ) end
139 --[[handler.listener = function( data, err )
140 return ondata( handler, data, err )
142 handler.ssl = function( )
143 return sslctx and true or false
145 handler.close = function( closed )
146 _ = not closed and close( socket )
147 writelen = removesocket( writelist, socket, writelen )
148 readlen = removesocket( readlist, socket, readlen )
149 socketlist[ socket ] = nil
152 handler.ip = function( )
155 handler.serverport = function( )
158 handler.socket = function( )
161 handler.receivedata = function( )
162 local client, err = accept( socket ) -- try to accept
164 local ip, clientport = client:getpeername( )
165 client:settimeout( 0 )
166 local handler, client, err = wrapclient( listener, client, ip, serverport, clientport, mode, sslctx ) -- wrap new client socket
167 if err then -- error while wrapping ssl socket
170 out_put( "server.lua: accepted new client connection from ", ip, ":", clientport )
171 return dispatch( handler )
172 elseif err then -- maybe timeout or something else
173 out_put( "server.lua: error with new client connection: ", err )
180 wrapsslclient = function( listener, socket, ip, serverport, clientport, mode, sslctx ) -- this function wraps a ssl cleint
182 local dispatch, disconnect = listener.listener, listener.disconnect
184 --// transform socket to ssl object //--
187 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
189 out_put( "server.lua: ssl error: ", err )
190 return nil, nil, err -- fatal error
192 socket:settimeout( 0 )
194 --// private closures of the object //--
196 local writequeue = { } -- buffer for messages to send
198 local eol, fatal_send_error, wants_closing
200 local sstat, rstat = 0, 0
202 --// local import of socket methods //--
204 local send = socket.send
205 local receive = socket.receive
206 local close = socket.close
207 --local shutdown = socket.shutdown
209 --// public methods of the object //--
213 handler.getstats = function( )
217 handler.listener = function( data, err )
218 return listener( handler, data, err )
220 handler.ssl = function( )
223 handler.send = function( _, data, i, j )
224 return send( socket, data, i, j )
226 handler.receive = function( pattern, prefix )
227 return receive( socket, pattern, prefix )
229 handler.shutdown = function( pattern )
230 --return shutdown( socket, pattern )
232 handler.close = function( closed )
233 if eol and not fatal_send_error then
234 -- There is data in the buffer, and we haven't experienced
235 -- an error trying to send yet, so we'll flush the buffer now
236 handler._dispatchdata();
238 -- and there is *still* data in the buffer
239 -- we'll give up for now, and close later
240 wants_closing = true;
245 writelen = ( eol and removesocket( writelist, socket, writelen ) ) or writelen
246 readlen = removesocket( readlist, socket, readlen )
247 socketlist[ socket ] = nil
248 out_put "server.lua: closed handler and removed socket from list"
250 handler.ip = function( )
253 handler.serverport = function( )
256 handler.clientport = function( )
260 handler.write = function( data )
262 writelen = writelen + 1
263 writelist[ writelen ] = socket
267 writequeue[ eol ] = data
269 handler.writequeue = function( )
272 handler.socket = function( )
275 handler.mode = function( )
278 handler._receivedata = function( )
279 local data, err, part = receive( socket, mode ) -- receive data in "mode"
280 if not err or ( err == "timeout" or err == "wantread" ) then -- received something
281 local data = data or part or ""
282 local count = #data * STAT_UNIT
283 rstat = rstat + count
284 receivestat = receivestat + count
285 --out_put( "server.lua: read data '", data, "', error: ", err )
286 return dispatch( handler, data, err )
287 else -- connections was closed or fatal error
288 out_put( "server.lua: client ", ip, ":", clientport, " error: ", err )
290 disconnect( handler, err )
296 handler._dispatchdata = function( ) -- this function writes data to handlers
297 local buffer = table_concat( writequeue, "", 1, eol )
298 local succ, err, byte = send( socket, buffer )
299 local count = ( succ or 0 ) * STAT_UNIT
300 sstat = sstat + count
301 sendstat = sendstat + count
302 out_put( "server.lua: sended '", buffer, "', bytes: ", succ, ", error: ", err, ", part: ", byte, ", to: ", ip, ":", clientport )
303 if succ then -- sending succesful
306 writelen = removesocket( writelist, socket, writelen ) -- delete socket from writelist
307 if wants_closing then
311 elseif byte and ( err == "timeout" or err == "wantwrite" ) then -- want write
312 buffer = string_sub( buffer, byte + 1, -1 ) -- new buffer
313 writequeue[ 1 ] = buffer -- insert new buffer in queue
316 else -- connection was closed during sending or fatal error
317 fatal_send_error = true;
318 out_put( "server.lua: client ", ip, ":", clientport, " error: ", err )
320 disconnect( handler, err )
329 handler.getIp = handler.ip
330 handler.getPort = handler.clientport
336 handler.handshake = coroutine_wrap( function( client )
338 for i = 1, 10 do -- 10 handshake attemps
339 _, err = client:dohandshake( )
341 out_put( "server.lua: ssl handshake done" )
342 writelen = ( wrote and removesocket( writelist, socket, writelen ) ) or writelen
343 handler.receivedata = handler._receivedata -- when handshake is done, replace the handshake function with regular functions
344 handler.dispatchdata = handler._dispatchdata
345 return dispatch( handler )
347 out_put( "server.lua: error during ssl handshake: ", err )
348 if err == "wantwrite" then
350 writelen = writelen + 1
351 writelist[ writelen ] = client
355 coroutine_yield( handler, nil, err ) -- handshake not finished
358 _ = err ~= "closed" and close( socket )
360 disconnect( handler, err )
363 return false -- handshake failed
366 handler.receivedata = handler.handshake
367 handler.dispatchdata = handler.handshake
369 handler.handshake( socket ) -- do handshake
371 socketlist[ socket ] = handler
372 readlen = readlen + 1
373 readlist[ readlen ] = socket
375 return handler, socket
378 wraptlsclient = function( listener, socket, ip, serverport, clientport, mode, sslctx ) -- this function wraps a tls cleint
380 local dispatch, disconnect = listener.listener, listener.disconnect
382 --// transform socket to ssl object //--
386 socket:settimeout( 0 )
387 --// private closures of the object //--
389 local writequeue = { } -- buffer for messages to send
391 local eol, fatal_send_error, wants_closing
393 local sstat, rstat = 0, 0
395 --// local import of socket methods //--
397 local send = socket.send
398 local receive = socket.receive
399 local close = socket.close
400 --local shutdown = socket.shutdown
402 --// public methods of the object //--
406 handler.getstats = function( )
410 handler.listener = function( data, err )
411 return listener( handler, data, err )
413 handler.ssl = function( )
416 handler.send = function( _, data, i, j )
417 return send( socket, data, i, j )
419 handler.receive = function( pattern, prefix )
420 return receive( socket, pattern, prefix )
422 handler.shutdown = function( pattern )
423 --return shutdown( socket, pattern )
425 handler.close = function( closed )
426 if eol and not fatal_send_error then
427 -- There is data in the buffer, and we haven't experienced
428 -- an error trying to send yet, so we'll flush the buffer now
429 handler._dispatchdata();
431 -- and there is *still* data in the buffer
432 -- we'll give up for now, and close later
433 wants_closing = true;
438 writelen = ( eol and removesocket( writelist, socket, writelen ) ) or writelen
439 readlen = removesocket( readlist, socket, readlen )
440 socketlist[ socket ] = nil
441 out_put "server.lua: closed handler and removed socket from list"
443 handler.ip = function( )
446 handler.serverport = function( )
449 handler.clientport = function( )
453 handler.write = function( data )
455 writelen = writelen + 1
456 writelist[ writelen ] = socket
460 writequeue[ eol ] = data
462 handler.writequeue = function( )
465 handler.socket = function( )
468 handler.mode = function( )
471 handler._receivedata = function( )
472 local data, err, part = receive( socket, mode ) -- receive data in "mode"
473 if not err or ( err == "timeout" or err == "wantread" ) then -- received something
474 local data = data or part or ""
475 local count = #data * STAT_UNIT
476 rstat = rstat + count
477 receivestat = receivestat + count
478 --out_put( "server.lua: read data '", data, "', error: ", err )
479 return dispatch( handler, data, err )
480 else -- connections was closed or fatal error
481 out_put( "server.lua: client ", ip, ":", clientport, " error: ", err )
483 disconnect( handler, err )
489 handler._dispatchdata = function( ) -- this function writes data to handlers
490 local buffer = table_concat( writequeue, "", 1, eol )
491 local succ, err, byte = send( socket, buffer )
492 local count = ( succ or 0 ) * STAT_UNIT
493 sstat = sstat + count
494 sendstat = sendstat + count
495 out_put( "server.lua: sended '", buffer, "', bytes: ", succ, ", error: ", err, ", part: ", byte, ", to: ", ip, ":", clientport )
496 if succ then -- sending succesful
499 writelen = removesocket( writelist, socket, writelen ) -- delete socket from writelist
500 if handler.need_tls then
501 out_put("server.lua: connection is ready for tls handshake");
502 handler.starttls(true);
504 if wants_closing then
508 elseif byte and ( err == "timeout" or err == "wantwrite" ) then -- want write
509 buffer = string_sub( buffer, byte + 1, -1 ) -- new buffer
510 writequeue[ 1 ] = buffer -- insert new buffer in queue
513 else -- connection was closed during sending or fatal error
514 fatal_send_error = true; -- :(
515 out_put( "server.lua: client ", ip, ":", clientport, " error: ", err )
517 disconnect( handler, err )
524 handler.receivedata, handler.dispatchdata = handler._receivedata, handler._dispatchdata;
527 handler.getIp = handler.ip
528 handler.getPort = handler.clientport
534 handler.starttls = function (now)
535 if not now then out_put("server.lua: we need to do tls, but delaying until later"); handler.need_tls = true; return; end
536 out_put( "server.lua: attempting to start tls on "..tostring(socket) )
537 local oldsocket = socket;
538 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
539 out_put("sslwrapped socket is "..tostring(socket));
541 out_put( "server.lua: ssl error: ", err )
542 return nil, nil, err -- fatal error
544 socket:settimeout(0);
546 -- Add the new socket to our system
547 socketlist[ socket ] = handler
548 readlen = readlen + 1
549 readlist[ readlen ] = socket
551 -- Remove traces of the old socket
552 readlen = removesocket( readlist, oldsocket, readlen )
553 socketlist [ oldsocket ] = nil;
556 receive = socket.receive
558 handler.ssl = function( )
561 handler.send = function( _, data, i, j )
562 return send( socket, data, i, j )
564 handler.receive = function( pattern, prefix )
565 return receive( socket, pattern, prefix )
568 handler.starttls = nil;
569 handler.need_tls = nil
571 handler.handshake = coroutine_wrap( function( client )
573 for i = 1, 10 do -- 10 handshake attemps
574 _, err = client:dohandshake( )
576 out_put( "server.lua: ssl handshake done" )
577 writelen = ( wrote and removesocket( writelist, socket, writelen ) ) or writelen
578 handler.receivedata = handler._receivedata -- when handshake is done, replace the handshake function with regular functions
579 handler.dispatchdata = handler._dispatchdata;
582 out_put( "server.lua: error during ssl handshake: ", err )
583 if err == "wantwrite" then
585 writelen = writelen + 1
586 writelist[ writelen ] = client
590 coroutine_yield( handler, nil, err ) -- handshake not finished
593 _ = err ~= "closed" and close( socket )
595 disconnect( handler, err )
598 return false -- handshake failed
601 handler.receivedata = handler.handshake
602 handler.dispatchdata = handler.handshake
604 handler.handshake( socket ) -- do handshake
606 socketlist[ socket ] = handler
607 readlen = readlen + 1
608 readlist[ readlen ] = socket
610 return handler, socket
613 wraptcpclient = function( listener, socket, ip, serverport, clientport, mode ) -- this function wraps a socket
615 local dispatch, disconnect = listener.listener, listener.disconnect
617 --// private closures of the object //--
619 local writequeue = { } -- list for messages to send
621 local eol, fatal_send_error, wants_closing
623 socket:settimeout(0);
625 local rstat, sstat = 0, 0
627 --// local import of socket methods //--
629 local send = socket.send
630 local receive = socket.receive
631 local close = socket.close
632 local shutdown = socket.shutdown
634 --// public methods of the object //--
638 handler.getstats = function( )
642 handler.listener = function( data, err )
643 return listener( handler, data, err )
645 handler.ssl = function( )
648 handler.send = function( _, data, i, j )
649 return send( socket, data, i, j )
651 handler.receive = function( pattern, prefix )
652 return receive( socket, pattern, prefix )
654 handler.shutdown = function( pattern )
655 return shutdown( socket, pattern )
657 handler.close = function( closed )
658 if eol and not fatal_send_error then
659 -- There is data in the buffer, and we haven't experienced
660 -- an error trying to send yet, so we'll flush the buffer now
661 handler.dispatchdata();
663 -- and there is *still* data in the buffer
664 -- we'll give up for now, and close later
665 wants_closing = true;
669 _ = not closed and shutdown( socket )
670 _ = not closed and close( socket )
671 writelen = ( eol and removesocket( writelist, socket, writelen ) ) or writelen
672 readlen = removesocket( readlist, socket, readlen )
673 socketlist[ socket ] = nil
674 out_put "server.lua: closed handler and removed socket from list"
676 handler.ip = function( )
679 handler.serverport = function( )
682 handler.clientport = function( )
685 handler.write = function( data )
687 writelen = writelen + 1
688 writelist[ writelen ] = socket
692 writequeue[ eol ] = data
694 handler.writequeue = function( )
697 handler.socket = function( )
700 handler.mode = function( )
704 handler.receivedata = function( )
705 local data, err, part = receive( socket, mode ) -- receive data in "mode"
706 if not err or ( err == "timeout" or err == "wantread" ) then -- received something
707 local data = data or part or ""
708 local count = #data * STAT_UNIT
709 rstat = rstat + count
710 receivestat = receivestat + count
711 --out_put( "server.lua: read data '", data, "', error: ", err )
712 return dispatch( handler, data, err )
713 else -- connections was closed or fatal error
714 out_put( "server.lua: client ", ip, ":", clientport, " error: ", err )
716 disconnect( handler, err )
723 handler.dispatchdata = function( ) -- this function writes data to handlers
724 local buffer = table_concat( writequeue, "", 1, eol )
725 local succ, err, byte = send( socket, buffer )
726 local count = ( succ or 0 ) * STAT_UNIT
727 sstat = sstat + count
728 sendstat = sendstat + count
729 out_put( "server.lua: sended '", buffer, "', bytes: ", succ, ", error: ", err, ", part: ", byte, ", to: ", ip, ":", clientport )
730 if succ then -- sending succesful
733 writelen = removesocket( writelist, socket, writelen ) -- delete socket from writelist
734 if wants_closing then
738 elseif byte and ( err == "timeout" or err == "wantwrite" ) then -- want write
739 buffer = string_sub( buffer, byte + 1, -1 ) -- new buffer
740 writequeue[ 1 ] = buffer -- insert new buffer in queue
743 else -- connection was closed during sending or fatal error
744 fatal_send_error = true; -- :'-(
745 out_put( "server.lua: client ", ip, ":", clientport, " error: ", err )
747 disconnect( handler, err )
756 handler.getIp = handler.ip
757 handler.getPort = handler.clientport
759 socketlist[ socket ] = handler
760 readlen = readlen + 1
761 readlist[ readlen ] = socket
763 return handler, socket
766 addtimer = function( listener )
767 timelistener[ #timelistener + 1 ] = listener
770 firetimer = function( listener )
771 for i, listener in ipairs( timelistener ) do
776 addserver = function( listeners, port, addr, mode, sslctx, wrapper_function ) -- this function provides a way for other scripts to reg a server
778 if type( listeners ) ~= "table" then
779 err = "invalid listener table"
781 for name, func in pairs( listeners ) do
782 if type( func ) ~= "function" then
783 --err = "invalid listener function"
788 if not type( port ) == "number" or not ( port >= 0 and port <= 65535 ) then
790 elseif listener[ port ] then
791 err= "listeners on port '" .. port .. "' already exist"
792 elseif sslctx and not luasec then
793 err = "luasec not found"
796 out_error( "server.lua: ", err )
800 local server, err = socket_bind( addr, port )
802 out_error( addr..":"..port.." -", err )
805 local handler, err = wrapserver( listeners, server, addr, port, mode, sslctx, wrapper_function ) -- wrap new server socket
810 server:settimeout( 0 )
811 readlen = readlen + 1
812 readlist[ readlen ] = server
813 listener[ port ] = listeners
814 socketlist[ server ] = handler
815 out_put( "server.lua: new server listener on ", addr, ":", port )
819 removesocket = function( tbl, socket, len ) -- this function removes sockets from a list
820 for i, target in ipairs( tbl ) do
821 if target == socket then
823 table_remove( tbl, i )
830 closeall = function( )
831 for sock, handler in pairs( socketlist ) do
834 socketlist[ sock ] = nil
836 writelist, readlist, socketlist = { }, { }, { }
839 closesocket = function( socket )
840 writelen = removesocket( writelist, socket, writelen )
841 readlen = removesocket( readlist, socket, readlen )
842 socketlist[ socket ] = nil
846 loop = function( ) -- this is the main loop of the program
847 --signal_set( "hub", "run" )
849 local read, write, err = socket_select( readlist, writelist, 1 ) -- 1 sec timeout, nice for timers
850 for i, socket in ipairs( write ) do -- send data waiting in writequeues
851 local handler = socketlist[ socket ]
853 handler.dispatchdata( )
855 closesocket( socket )
856 out_put "server.lua: found no handler and closed socket (writelist)" -- this should not happen
859 for i, socket in ipairs( read ) do -- receive data
860 local handler = socketlist[ socket ]
862 handler.receivedata( )
864 closesocket( socket )
865 out_put "server.lua: found no handler and closed socket (readlist)" -- this can happen
873 ----------------------------------// BEGIN //--
875 ----------------------------------// PUBLIC INTERFACE //--
884 wraptcpclient = wraptcpclient,
885 wrapsslclient = wrapsslclient,
886 wraptlsclient = wraptlsclient,