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
39 local out_put = function () end --print;
40 local out_error = print;
44 local luasec = select(2, pcall(require, "ssl"))
45 local luasocket = require "socket"
47 --// extern lib methods //--
49 local ssl_wrap = ( luasec and luasec.wrap )
50 local socket_bind = luasocket.bind
51 local socket_select = luasocket.select
52 local ssl_newcontext = ( luasec and luasec.newcontext )
76 --// simple data types //--
79 local readlen = 0 -- length of readlist
80 local writelen = 0 -- lenght of writelist
85 ----------------------------------// DEFINITION //--
87 listener = { } -- key = port, value = table
88 readlist = { } -- array with sockets to read from
89 writelist = { } -- arrary with sockets to write to
90 socketlist = { } -- key = socket, value = wrapped socket
94 return receivestat, sendstat
97 wrapserver = function( listener, socket, ip, serverport, mode, sslctx ) -- this function wraps a server
99 local dispatch, disconnect = listener.listener, listener.disconnect -- dangerous
101 local wrapclient, err
104 if not ssl_newcontext then
105 return nil, "luasec not found"
107 if type( sslctx ) ~= "table" then
108 out_error "server.lua: wrong server sslctx"
109 return nil, "wrong server sslctx"
111 sslctx, err = ssl_newcontext( sslctx )
113 err = err or "wrong sslctx parameters"
114 out_error( "server.lua: ", err )
117 wrapclient = wrapsslclient
118 wrapclient = wraptlsclient
120 wrapclient = wraptcpclient
123 local accept = socket.accept
124 local close = socket.close
126 --// public methods of the object //--
130 handler.shutdown = function( ) end
132 --[[handler.listener = function( data, err )
133 return ondata( handler, data, err )
135 handler.ssl = function( )
136 return sslctx and true or false
138 handler.close = function( closed )
139 _ = not closed and close( socket )
140 writelen = removesocket( writelist, socket, writelen )
141 readlen = removesocket( readlist, socket, readlen )
142 socketlist[ socket ] = nil
145 handler.ip = function( )
148 handler.serverport = function( )
151 handler.socket = function( )
154 handler.receivedata = function( )
155 local client, err = accept( socket ) -- try to accept
157 local ip, clientport = client:getpeername( )
158 client:settimeout( 0 )
159 local handler, client, err = wrapclient( listener, client, ip, serverport, clientport, mode, sslctx ) -- wrap new client socket
160 if err then -- error while wrapping ssl socket
163 out_put( "server.lua: accepted new client connection from ", ip, ":", clientport )
164 return dispatch( handler )
165 elseif err then -- maybe timeout or something else
166 out_put( "server.lua: error with new client connection: ", err )
173 wrapsslclient = function( listener, socket, ip, serverport, clientport, mode, sslctx ) -- this function wraps a ssl cleint
175 local dispatch, disconnect = listener.listener, listener.disconnect
177 --// transform socket to ssl object //--
180 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
182 out_put( "server.lua: ssl error: ", err )
183 return nil, nil, err -- fatal error
185 socket:settimeout( 0 )
187 --// private closures of the object //--
189 local writequeue = { } -- buffer for messages to send
191 local eol, fatal_send_error -- end of buffer
193 local sstat, rstat = 0, 0
195 --// local import of socket methods //--
197 local send = socket.send
198 local receive = socket.receive
199 local close = socket.close
200 --local shutdown = socket.shutdown
202 --// public methods of the object //--
206 handler.getstats = function( )
210 handler.listener = function( data, err )
211 return listener( handler, data, err )
213 handler.ssl = function( )
216 handler.send = function( _, data, i, j )
217 return send( socket, data, i, j )
219 handler.receive = function( pattern, prefix )
220 return receive( socket, pattern, prefix )
222 handler.shutdown = function( pattern )
223 --return shutdown( socket, pattern )
225 handler.close = function( closed )
226 if eol and not fatal_send_error then handler._dispatchdata(); end
228 writelen = ( eol and removesocket( writelist, socket, writelen ) ) or writelen
229 readlen = removesocket( readlist, socket, readlen )
230 socketlist[ socket ] = nil
231 out_put "server.lua: closed handler and removed socket from list"
233 handler.ip = function( )
236 handler.serverport = function( )
239 handler.clientport = function( )
243 handler.write = function( data )
245 writelen = writelen + 1
246 writelist[ writelen ] = socket
250 writequeue[ eol ] = data
252 handler.writequeue = function( )
255 handler.socket = function( )
258 handler.mode = function( )
261 handler._receivedata = function( )
262 local data, err, part = receive( socket, mode ) -- receive data in "mode"
263 if not err or ( err == "timeout" or err == "wantread" ) then -- received something
264 local data = data or part or ""
265 local count = #data * STAT_UNIT
266 rstat = rstat + count
267 receivestat = receivestat + count
268 --out_put( "server.lua: read data '", data, "', error: ", err )
269 return dispatch( handler, data, err )
270 else -- connections was closed or fatal error
271 out_put( "server.lua: client ", ip, ":", clientport, " error: ", err )
273 disconnect( handler, err )
279 handler._dispatchdata = function( ) -- this function writes data to handlers
280 local buffer = table_concat( writequeue, "", 1, eol )
281 local succ, err, byte = send( socket, buffer )
282 local count = ( succ or 0 ) * STAT_UNIT
283 sstat = sstat + count
284 sendstat = sendstat + count
285 out_put( "server.lua: sended '", buffer, "', bytes: ", succ, ", error: ", err, ", part: ", byte, ", to: ", ip, ":", clientport )
286 if succ then -- sending succesful
289 writelen = removesocket( writelist, socket, writelen ) -- delete socket from writelist
291 elseif byte and ( err == "timeout" or err == "wantwrite" ) then -- want write
292 buffer = string_sub( buffer, byte + 1, -1 ) -- new buffer
293 writequeue[ 1 ] = buffer -- insert new buffer in queue
296 else -- connection was closed during sending or fatal error
297 fatal_send_error = true;
298 out_put( "server.lua: client ", ip, ":", clientport, " error: ", err )
300 disconnect( handler, err )
309 handler.getIp = handler.ip
310 handler.getPort = handler.clientport
316 handler.handshake = coroutine_wrap( function( client )
318 for i = 1, 10 do -- 10 handshake attemps
319 _, err = client:dohandshake( )
321 out_put( "server.lua: ssl handshake done" )
322 writelen = ( wrote and removesocket( writelist, socket, writelen ) ) or writelen
323 handler.receivedata = handler._receivedata -- when handshake is done, replace the handshake function with regular functions
324 handler.dispatchdata = handler._dispatchdata
325 return dispatch( handler )
327 out_put( "server.lua: error during ssl handshake: ", err )
328 if err == "wantwrite" then
330 writelen = writelen + 1
331 writelist[ writelen ] = client
335 coroutine_yield( handler, nil, err ) -- handshake not finished
338 _ = err ~= "closed" and close( socket )
340 disconnect( handler, err )
343 return false -- handshake failed
346 handler.receivedata = handler.handshake
347 handler.dispatchdata = handler.handshake
349 handler.handshake( socket ) -- do handshake
351 socketlist[ socket ] = handler
352 readlen = readlen + 1
353 readlist[ readlen ] = socket
355 return handler, socket
358 wraptlsclient = function( listener, socket, ip, serverport, clientport, mode, sslctx ) -- this function wraps a tls cleint
360 local dispatch, disconnect = listener.listener, listener.disconnect
362 --// transform socket to ssl object //--
366 socket:settimeout( 0 )
367 --// private closures of the object //--
369 local writequeue = { } -- buffer for messages to send
371 local eol, fatal_send_error -- end of buffer
373 local sstat, rstat = 0, 0
375 --// local import of socket methods //--
377 local send = socket.send
378 local receive = socket.receive
379 local close = socket.close
380 --local shutdown = socket.shutdown
382 --// public methods of the object //--
386 handler.getstats = function( )
390 handler.listener = function( data, err )
391 return listener( handler, data, err )
393 handler.ssl = function( )
396 handler.send = function( _, data, i, j )
397 return send( socket, data, i, j )
399 handler.receive = function( pattern, prefix )
400 return receive( socket, pattern, prefix )
402 handler.shutdown = function( pattern )
403 --return shutdown( socket, pattern )
405 handler.close = function( closed )
406 if eol and not fatal_send_error then handler._dispatchdata(); end
408 writelen = ( eol and removesocket( writelist, socket, writelen ) ) or writelen
409 readlen = removesocket( readlist, socket, readlen )
410 socketlist[ socket ] = nil
411 out_put "server.lua: closed handler and removed socket from list"
413 handler.ip = function( )
416 handler.serverport = function( )
419 handler.clientport = function( )
423 handler.write = function( data )
425 writelen = writelen + 1
426 writelist[ writelen ] = socket
430 writequeue[ eol ] = data
432 handler.writequeue = function( )
435 handler.socket = function( )
438 handler.mode = function( )
441 handler._receivedata = function( )
442 local data, err, part = receive( socket, mode ) -- receive data in "mode"
443 if not err or ( err == "timeout" or err == "wantread" ) then -- received something
444 local data = data or part or ""
445 local count = #data * STAT_UNIT
446 rstat = rstat + count
447 receivestat = receivestat + count
448 --out_put( "server.lua: read data '", data, "', error: ", err )
449 return dispatch( handler, data, err )
450 else -- connections was closed or fatal error
451 out_put( "server.lua: client ", ip, ":", clientport, " error: ", err )
453 disconnect( handler, err )
459 handler._dispatchdata = function( ) -- this function writes data to handlers
460 local buffer = table_concat( writequeue, "", 1, eol )
461 local succ, err, byte = send( socket, buffer )
462 local count = ( succ or 0 ) * STAT_UNIT
463 sstat = sstat + count
464 sendstat = sendstat + count
465 out_put( "server.lua: sended '", buffer, "', bytes: ", succ, ", error: ", err, ", part: ", byte, ", to: ", ip, ":", clientport )
466 if succ then -- sending succesful
469 writelen = removesocket( writelist, socket, writelen ) -- delete socket from writelist
470 if handler.need_tls then
471 out_put("server.lua: connection is ready for tls handshake");
472 handler.starttls(true);
475 elseif byte and ( err == "timeout" or err == "wantwrite" ) then -- want write
476 buffer = string_sub( buffer, byte + 1, -1 ) -- new buffer
477 writequeue[ 1 ] = buffer -- insert new buffer in queue
480 else -- connection was closed during sending or fatal error
481 fatal_send_error = true; -- :(
482 out_put( "server.lua: client ", ip, ":", clientport, " error: ", err )
484 disconnect( handler, err )
491 handler.receivedata, handler.dispatchdata = handler._receivedata, handler._dispatchdata;
494 handler.getIp = handler.ip
495 handler.getPort = handler.clientport
501 handler.starttls = function (now)
502 if not now then out_put("server.lua: we need to do tls, but delaying until later"); handler.need_tls = true; return; end
503 out_put( "server.lua: attempting to start tls on "..tostring(socket) )
504 local oldsocket = socket;
505 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
506 out_put("sslwrapped socket is "..tostring(socket));
508 out_put( "server.lua: ssl error: ", err )
509 return nil, nil, err -- fatal error
511 socket:settimeout(0);
513 -- Add the new socket to our system
514 socketlist[ socket ] = handler
515 readlen = readlen + 1
516 readlist[ readlen ] = socket
518 -- Remove traces of the old socket
519 readlen = removesocket( readlist, oldsocket, readlen )
520 socketlist [ oldsocket ] = nil;
523 receive = socket.receive
525 handler.ssl = function( )
528 handler.send = function( _, data, i, j )
529 return send( socket, data, i, j )
531 handler.receive = function( pattern, prefix )
532 return receive( socket, pattern, prefix )
535 handler.starttls = nil;
536 handler.need_tls = nil
538 handler.handshake = coroutine_wrap( function( client )
540 for i = 1, 10 do -- 10 handshake attemps
541 _, err = client:dohandshake( )
543 out_put( "server.lua: ssl handshake done" )
544 writelen = ( wrote and removesocket( writelist, socket, writelen ) ) or writelen
545 handler.receivedata = handler._receivedata -- when handshake is done, replace the handshake function with regular functions
546 handler.dispatchdata = handler._dispatchdata;
549 out_put( "server.lua: error during ssl handshake: ", err )
550 if err == "wantwrite" then
552 writelen = writelen + 1
553 writelist[ writelen ] = client
557 coroutine_yield( handler, nil, err ) -- handshake not finished
560 _ = err ~= "closed" and close( socket )
562 disconnect( handler, err )
565 return false -- handshake failed
568 handler.receivedata = handler.handshake
569 handler.dispatchdata = handler.handshake
571 handler.handshake( socket ) -- do handshake
573 socketlist[ socket ] = handler
574 readlen = readlen + 1
575 readlist[ readlen ] = socket
577 return handler, socket
580 wraptcpclient = function( listener, socket, ip, serverport, clientport, mode ) -- this function wraps a socket
582 local dispatch, disconnect = listener.listener, listener.disconnect
584 --// private closures of the object //--
586 local writequeue = { } -- list for messages to send
588 local eol, fatal_send_error
590 socket:settimeout(0);
592 local rstat, sstat = 0, 0
594 --// local import of socket methods //--
596 local send = socket.send
597 local receive = socket.receive
598 local close = socket.close
599 local shutdown = socket.shutdown
601 --// public methods of the object //--
605 handler.getstats = function( )
609 handler.listener = function( data, err )
610 return listener( handler, data, err )
612 handler.ssl = function( )
615 handler.send = function( _, data, i, j )
616 return send( socket, data, i, j )
618 handler.receive = function( pattern, prefix )
619 return receive( socket, pattern, prefix )
621 handler.shutdown = function( pattern )
622 return shutdown( socket, pattern )
624 handler.close = function( closed )
625 if eol and not fatal_send_error then handler.dispatchdata(); end
626 _ = not closed and shutdown( socket )
627 _ = not closed and close( socket )
628 writelen = ( eol and removesocket( writelist, socket, writelen ) ) or writelen
629 readlen = removesocket( readlist, socket, readlen )
630 socketlist[ socket ] = nil
631 out_put "server.lua: closed handler and removed socket from list"
633 handler.ip = function( )
636 handler.serverport = function( )
639 handler.clientport = function( )
642 handler.write = function( data )
644 writelen = writelen + 1
645 writelist[ writelen ] = socket
649 writequeue[ eol ] = data
651 handler.writequeue = function( )
654 handler.socket = function( )
657 handler.mode = function( )
661 handler.receivedata = function( )
662 local data, err, part = receive( socket, mode ) -- receive data in "mode"
663 if not err or ( err == "timeout" or err == "wantread" ) then -- received something
664 local data = data or part or ""
665 local count = #data * STAT_UNIT
666 rstat = rstat + count
667 receivestat = receivestat + count
668 --out_put( "server.lua: read data '", data, "', error: ", err )
669 return dispatch( handler, data, err )
670 else -- connections was closed or fatal error
671 out_put( "server.lua: client ", ip, ":", clientport, " error: ", err )
673 disconnect( handler, err )
680 handler.dispatchdata = function( ) -- this function writes data to handlers
681 local buffer = table_concat( writequeue, "", 1, eol )
682 local succ, err, byte = send( socket, buffer )
683 local count = ( succ or 0 ) * STAT_UNIT
684 sstat = sstat + count
685 sendstat = sendstat + count
686 out_put( "server.lua: sended '", buffer, "', bytes: ", succ, ", error: ", err, ", part: ", byte, ", to: ", ip, ":", clientport )
687 if succ then -- sending succesful
690 writelen = removesocket( writelist, socket, writelen ) -- delete socket from writelist
692 elseif byte and ( err == "timeout" or err == "wantwrite" ) then -- want write
693 buffer = string_sub( buffer, byte + 1, -1 ) -- new buffer
694 writequeue[ 1 ] = buffer -- insert new buffer in queue
697 else -- connection was closed during sending or fatal error
698 fatal_send_error = true; -- :'-(
699 out_put( "server.lua: client ", ip, ":", clientport, " error: ", err )
701 disconnect( handler, err )
710 handler.getIp = handler.ip
711 handler.getPort = handler.clientport
713 socketlist[ socket ] = handler
714 readlen = readlen + 1
715 readlist[ readlen ] = socket
717 return handler, socket
720 addtimer = function( listener )
721 timelistener[ #timelistener + 1 ] = listener
724 firetimer = function( listener )
725 for i, listener in ipairs( timelistener ) do
730 addserver = function( listeners, port, addr, mode, sslctx ) -- this function provides a way for other scripts to reg a server
732 if type( listeners ) ~= "table" then
733 err = "invalid listener table"
735 for name, func in pairs( listeners ) do
736 if type( func ) ~= "function" then
737 --err = "invalid listener function"
742 if not type( port ) == "number" or not ( port >= 0 and port <= 65535 ) then
744 elseif listener[ port ] then
745 err= "listeners on port '" .. port .. "' already exist"
746 elseif sslctx and not luasec then
747 err = "luasec not found"
750 out_error( "server.lua: ", err )
754 local server, err = socket_bind( addr, port )
756 out_error( "server.lua: ", err )
759 local handler, err = wrapserver( listeners, server, addr, port, mode, sslctx ) -- wrap new server socket
764 server:settimeout( 0 )
765 readlen = readlen + 1
766 readlist[ readlen ] = server
767 listener[ port ] = listeners
768 socketlist[ server ] = handler
769 out_put( "server.lua: new server listener on ", addr, ":", port )
773 removesocket = function( tbl, socket, len ) -- this function removes sockets from a list
774 for i, target in ipairs( tbl ) do
775 if target == socket then
777 table_remove( tbl, i )
784 closeall = function( )
785 for sock, handler in pairs( socketlist ) do
788 socketlist[ sock ] = nil
790 writelist, readlist, socketlist = { }, { }, { }
793 closesocket = function( socket )
794 writelen = removesocket( writelist, socket, writelen )
795 readlen = removesocket( readlist, socket, readlen )
796 socketlist[ socket ] = nil
800 loop = function( ) -- this is the main loop of the program
801 --signal_set( "hub", "run" )
803 local read, write, err = socket_select( readlist, writelist, 1 ) -- 1 sec timeout, nice for timers
804 for i, socket in ipairs( write ) do -- send data waiting in writequeues
805 local handler = socketlist[ socket ]
807 handler.dispatchdata( )
809 closesocket( socket )
810 out_put "server.lua: found no handler and closed socket (writelist)" -- this should not happen
813 for i, socket in ipairs( read ) do -- receive data
814 local handler = socketlist[ socket ]
816 handler.receivedata( )
818 closesocket( socket )
819 out_put "server.lua: found no handler and closed socket (readlist)" -- this can happen
827 ----------------------------------// BEGIN //--
829 ----------------------------------// PUBLIC INTERFACE //--
838 wraptcpclient = wraptcpclient,
839 wraptlsclient = wraptlsclient,