3 server.lua by blastbeat of the luadch project
\r
5 re-used here under the MIT/X Consortium License
\r
7 - this script contains the server loop of the program
\r
8 - other scripts can reg a server here
\r
12 ----------------------------------// DECLARATION //--
\r
16 local STAT_UNIT = 1 / ( 1024 * 1024 ) -- mb
\r
18 --// lua functions //--
\r
20 local function use( what ) return _G[ what ] end
\r
22 local type = use "type"
\r
23 local pairs = use "pairs"
\r
24 local ipairs = use "ipairs"
\r
25 local tostring = use "tostring"
\r
26 local collectgarbage = use "collectgarbage"
\r
30 local table = use "table"
\r
31 local coroutine = use "coroutine"
\r
33 --// lua lib methods //--
\r
35 local table_concat = table.concat
\r
36 local table_remove = table.remove
\r
37 local string_sub = use'string'.sub
\r
38 local coroutine_wrap = coroutine.wrap
\r
39 local coroutine_yield = coroutine.yield
\r
40 local print = print;
\r
41 local out_put = function () end --print;
\r
42 local out_put = print;
\r
43 local out_error = print;
\r
45 --// extern libs //--
\r
47 local luasec = require "ssl"
\r
48 local luasocket = require "socket"
\r
50 --// extern lib methods //--
\r
52 local ssl_wrap = ( luasec and luasec.wrap )
\r
53 local socket_bind = luasocket.bind
\r
54 local socket_select = luasocket.select
\r
55 local ssl_newcontext = ( luasec and luasec.newcontext )
\r
79 --// simple data types //--
\r
82 local readlen = 0 -- length of readlist
\r
83 local writelen = 0 -- lenght of writelist
\r
86 local receivestat = 0
\r
88 ----------------------------------// DEFINITION //--
\r
90 listener = { } -- key = port, value = table
\r
91 readlist = { } -- array with sockets to read from
\r
92 writelist = { } -- arrary with sockets to write to
\r
93 socketlist = { } -- key = socket, value = wrapped socket
\r
97 return receivestat, sendstat
\r
100 wrapserver = function( listener, socket, ip, serverport, mode, sslctx ) -- this function wraps a server
\r
102 local dispatch, disconnect = listener.listener, listener.disconnect -- dangerous
\r
104 local wrapclient, err
\r
107 if not ssl_newcontext then
\r
108 return nil, "luasec not found"
\r
110 if type( sslctx ) ~= "table" then
\r
111 out_error "server.lua: wrong server sslctx"
\r
112 return nil, "wrong server sslctx"
\r
114 sslctx, err = ssl_newcontext( sslctx )
\r
116 err = err or "wrong sslctx parameters"
\r
117 out_error( "server.lua: ", err )
\r
120 wrapclient = wrapsslclient
\r
121 wrapclient = wraptlsclient
\r
123 wrapclient = wraptcpclient
\r
126 local accept = socket.accept
\r
127 local close = socket.close
\r
129 --// public methods of the object //--
\r
131 local handler = { }
\r
133 handler.shutdown = function( ) end
\r
135 --[[handler.listener = function( data, err )
\r
136 return ondata( handler, data, err )
\r
138 handler.ssl = function( )
\r
139 return sslctx and true or false
\r
141 handler.close = function( closed )
\r
142 _ = not closed and close( socket )
\r
143 writelen = removesocket( writelist, socket, writelen )
\r
144 readlen = removesocket( readlist, socket, readlen )
\r
145 socketlist[ socket ] = nil
\r
148 handler.ip = function( )
\r
151 handler.serverport = function( )
\r
154 handler.socket = function( )
\r
157 handler.receivedata = function( )
\r
158 local client, err = accept( socket ) -- try to accept
\r
160 local ip, clientport = client:getpeername( )
\r
161 client:settimeout( 0 )
\r
162 local handler, client, err = wrapclient( listener, client, ip, serverport, clientport, mode, sslctx ) -- wrap new client socket
\r
163 if err then -- error while wrapping ssl socket
\r
166 out_put( "server.lua: accepted new client connection from ", ip, ":", clientport )
\r
167 return dispatch( handler )
\r
168 elseif err then -- maybe timeout or something else
\r
169 out_put( "server.lua: error with new client connection: ", err )
\r
176 wrapsslclient = function( listener, socket, ip, serverport, clientport, mode, sslctx ) -- this function wraps a ssl cleint
\r
178 local dispatch, disconnect = listener.listener, listener.disconnect
\r
180 --// transform socket to ssl object //--
\r
183 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
\r
185 out_put( "server.lua: ssl error: ", err )
\r
186 return nil, nil, err -- fatal error
\r
188 socket:settimeout( 0 )
\r
190 --// private closures of the object //--
\r
192 local writequeue = { } -- buffer for messages to send
\r
194 local eol -- end of buffer
\r
196 local sstat, rstat = 0, 0
\r
198 --// local import of socket methods //--
\r
200 local send = socket.send
\r
201 local receive = socket.receive
\r
202 local close = socket.close
\r
203 --local shutdown = socket.shutdown
\r
205 --// public methods of the object //--
\r
207 local handler = { }
\r
209 handler.getstats = function( )
\r
210 return rstat, sstat
\r
213 handler.listener = function( data, err )
\r
214 return listener( handler, data, err )
\r
216 handler.ssl = function( )
\r
219 handler.send = function( _, data, i, j )
\r
220 return send( socket, data, i, j )
\r
222 handler.receive = function( pattern, prefix )
\r
223 return receive( socket, pattern, prefix )
\r
225 handler.shutdown = function( pattern )
\r
226 --return shutdown( socket, pattern )
\r
228 handler.close = function( closed )
\r
230 writelen = ( eol and removesocket( writelist, socket, writelen ) ) or writelen
\r
231 readlen = removesocket( readlist, socket, readlen )
\r
232 socketlist[ socket ] = nil
\r
233 out_put "server.lua: closed handler and removed socket from list"
\r
235 handler.ip = function( )
\r
238 handler.serverport = function( )
\r
241 handler.clientport = function( )
\r
245 handler.write = function( data )
\r
247 writelen = writelen + 1
\r
248 writelist[ writelen ] = socket
\r
252 writequeue[ eol ] = data
\r
254 handler.writequeue = function( )
\r
257 handler.socket = function( )
\r
260 handler.mode = function( )
\r
263 handler._receivedata = function( )
\r
264 local data, err, part = receive( socket, mode ) -- receive data in "mode"
\r
265 if not err or ( err == "timeout" or err == "wantread" ) then -- received something
\r
266 local data = data or part or ""
\r
267 local count = #data * STAT_UNIT
\r
268 rstat = rstat + count
\r
269 receivestat = receivestat + count
\r
270 out_put( "server.lua: read data '", data, "', error: ", err )
\r
271 return dispatch( handler, data, err )
\r
272 else -- connections was closed or fatal error
\r
273 out_put( "server.lua: client ", ip, ":", clientport, " error: ", err )
\r
275 disconnect( handler, err )
\r
281 handler._dispatchdata = function( ) -- this function writes data to handlers
\r
282 local buffer = table_concat( writequeue, "", 1, eol )
\r
283 local succ, err, byte = send( socket, buffer )
\r
284 local count = ( succ or 0 ) * STAT_UNIT
\r
285 sstat = sstat + count
\r
286 sendstat = sendstat + count
\r
287 out_put( "server.lua: sended '", buffer, "', bytes: ", succ, ", error: ", err, ", part: ", byte, ", to: ", ip, ":", clientport )
\r
288 if succ then -- sending succesful
\r
291 writelen = removesocket( writelist, socket, writelen ) -- delete socket from writelist
\r
293 elseif byte and ( err == "timeout" or err == "wantwrite" ) then -- want write
\r
294 buffer = string_sub( buffer, byte + 1, -1 ) -- new buffer
\r
295 writequeue[ 1 ] = buffer -- insert new buffer in queue
\r
298 else -- connection was closed during sending or fatal error
\r
299 out_put( "server.lua: client ", ip, ":", clientport, " error: ", err )
\r
301 disconnect( handler, err )
\r
310 handler.getIp = handler.ip
\r
311 handler.getPort = handler.clientport
\r
313 --// handshake //--
\r
317 handler.handshake = coroutine_wrap( function( client )
\r
319 for i = 1, 10 do -- 10 handshake attemps
\r
320 _, err = client:dohandshake( )
\r
322 out_put( "server.lua: ssl handshake done" )
\r
323 writelen = ( wrote and removesocket( writelist, socket, writelen ) ) or writelen
\r
324 handler.receivedata = handler._receivedata -- when handshake is done, replace the handshake function with regular functions
\r
325 handler.dispatchdata = handler._dispatchdata
\r
326 return dispatch( handler )
\r
328 out_put( "server.lua: error during ssl handshake: ", err )
\r
329 if err == "wantwrite" then
\r
330 if wrote == nil then
\r
331 writelen = writelen + 1
\r
332 writelist[ writelen ] = client
\r
336 coroutine_yield( handler, nil, err ) -- handshake not finished
\r
339 _ = err ~= "closed" and close( socket )
\r
341 disconnect( handler, err )
\r
344 return false -- handshake failed
\r
347 handler.receivedata = handler.handshake
\r
348 handler.dispatchdata = handler.handshake
\r
350 handler.handshake( socket ) -- do handshake
\r
352 socketlist[ socket ] = handler
\r
353 readlen = readlen + 1
\r
354 readlist[ readlen ] = socket
\r
356 return handler, socket
\r
359 wraptlsclient = function( listener, socket, ip, serverport, clientport, mode, sslctx ) -- this function wraps a tls cleint
\r
361 local dispatch, disconnect = listener.listener, listener.disconnect
\r
363 --// transform socket to ssl object //--
\r
367 socket:settimeout( 0 )
\r
369 --// private closures of the object //--
\r
371 local writequeue = { } -- buffer for messages to send
\r
373 local eol -- end of buffer
\r
375 local sstat, rstat = 0, 0
\r
377 --// local import of socket methods //--
\r
379 local send = socket.send
\r
380 local receive = socket.receive
\r
381 local close = socket.close
\r
382 --local shutdown = socket.shutdown
\r
384 --// public methods of the object //--
\r
386 local handler = { }
\r
388 handler.getstats = function( )
\r
389 return rstat, sstat
\r
392 handler.listener = function( data, err )
\r
393 return listener( handler, data, err )
\r
395 handler.ssl = function( )
\r
398 handler.send = function( _, data, i, j )
\r
399 return send( socket, data, i, j )
\r
401 handler.receive = function( pattern, prefix )
\r
402 return receive( socket, pattern, prefix )
\r
404 handler.shutdown = function( pattern )
\r
405 --return shutdown( socket, pattern )
\r
407 handler.close = function( closed )
\r
409 writelen = ( eol and removesocket( writelist, socket, writelen ) ) or writelen
\r
410 readlen = removesocket( readlist, socket, readlen )
\r
411 socketlist[ socket ] = nil
\r
412 out_put "server.lua: closed handler and removed socket from list"
\r
414 handler.ip = function( )
\r
417 handler.serverport = function( )
\r
420 handler.clientport = function( )
\r
424 handler.write = function( data )
\r
426 writelen = writelen + 1
\r
427 writelist[ writelen ] = socket
\r
431 writequeue[ eol ] = data
\r
433 handler.writequeue = function( )
\r
436 handler.socket = function( )
\r
439 handler.mode = function( )
\r
442 handler._receivedata = function( )
\r
443 local data, err, part = receive( socket, mode ) -- receive data in "mode"
\r
444 if not err or ( err == "timeout" or err == "wantread" ) then -- received something
\r
445 local data = data or part or ""
\r
446 local count = #data * STAT_UNIT
\r
447 rstat = rstat + count
\r
448 receivestat = receivestat + count
\r
449 --out_put( "server.lua: read data '", data, "', error: ", err )
\r
450 return dispatch( handler, data, err )
\r
451 else -- connections was closed or fatal error
\r
452 out_put( "server.lua: client ", ip, ":", clientport, " error: ", err )
\r
454 disconnect( handler, err )
\r
460 handler._dispatchdata = function( ) -- this function writes data to handlers
\r
461 local buffer = table_concat( writequeue, "", 1, eol )
\r
462 local succ, err, byte = send( socket, buffer )
\r
463 local count = ( succ or 0 ) * STAT_UNIT
\r
464 sstat = sstat + count
\r
465 sendstat = sendstat + count
\r
466 out_put( "server.lua: sended '", buffer, "', bytes: ", succ, ", error: ", err, ", part: ", byte, ", to: ", ip, ":", clientport )
\r
467 if succ then -- sending succesful
\r
470 writelen = removesocket( writelist, socket, writelen ) -- delete socket from writelist
\r
471 if handler.need_tls then
\r
472 out_put("server.lua: connection is ready for tls handshake");
\r
473 handler.starttls(true);
\r
474 if handler.need_tls then
\r
475 out_put("server.lua: uh-oh... we still want tls, something must be wrong");
\r
479 elseif byte and ( err == "timeout" or err == "wantwrite" ) then -- want write
\r
480 buffer = string_sub( buffer, byte + 1, -1 ) -- new buffer
\r
481 writequeue[ 1 ] = buffer -- insert new buffer in queue
\r
484 else -- connection was closed during sending or fatal error
\r
485 out_put( "server.lua: client ", ip, ":", clientport, " error: ", err )
\r
487 disconnect( handler, err )
\r
494 handler.receivedata, handler.dispatchdata = handler._receivedata, handler._dispatchdata;
\r
497 handler.getIp = handler.ip
\r
498 handler.getPort = handler.clientport
\r
500 --// handshake //--
\r
504 handler.starttls = function (now)
\r
505 if not now then out_put("server.lua: we need to do tls, but delaying until later"); handler.need_tls = true; return; end
\r
506 out_put( "server.lua: attempting to start tls on "..tostring(socket) )
\r
507 socket, err = ssl_wrap( socket, sslctx ) -- wrap socket
\r
508 out_put("sslwrapped socket is "..tostring(socket));
\r
510 out_put( "server.lua: ssl error: ", err )
\r
511 return nil, nil, err -- fatal error
\r
513 socket:settimeout( 1 )
\r
515 receive = socket.receive
\r
516 close = socket.close
\r
517 handler.ssl = function( )
\r
520 handler.send = function( _, data, i, j )
\r
521 return send( socket, data, i, j )
\r
523 handler.receive = function( pattern, prefix )
\r
524 return receive( socket, pattern, prefix )
\r
527 handler.handshake = coroutine_wrap( function( client )
\r
529 for i = 1, 10 do -- 10 handshake attemps
\r
530 _, err = client:dohandshake( )
\r
532 out_put( "server.lua: ssl handshake done" )
\r
533 writelen = ( wrote and removesocket( writelist, socket, writelen ) ) or writelen
\r
534 handler.receivedata = handler._receivedata -- when handshake is done, replace the handshake function with regular functions
\r
535 handler.dispatchdata = handler._dispatchdata
\r
536 handler.need_tls = nil
\r
537 socketlist[ client ] = handler
\r
538 readlen = readlen + 1
\r
539 readlist[ readlen ] = client
\r
542 out_put( "server.lua: error during ssl handshake: ", err )
\r
543 if err == "wantwrite" then
\r
544 if wrote == nil then
\r
545 writelen = writelen + 1
\r
546 writelist[ writelen ] = client
\r
550 coroutine_yield( handler, nil, err ) -- handshake not finished
\r
553 _ = err ~= "closed" and close( socket )
\r
555 disconnect( handler, err )
\r
558 return false -- handshake failed
\r
561 handler.receivedata = handler.handshake
\r
562 handler.dispatchdata = handler.handshake
\r
564 handler.handshake( socket ) -- do handshake
\r
566 socketlist[ socket ] = handler
\r
567 readlen = readlen + 1
\r
568 readlist[ readlen ] = socket
\r
570 return handler, socket
\r
573 wraptcpclient = function( listener, socket, ip, serverport, clientport, mode ) -- this function wraps a socket
\r
575 local dispatch, disconnect = listener.listener, listener.disconnect
\r
577 --// private closures of the object //--
\r
579 local writequeue = { } -- list for messages to send
\r
583 local rstat, sstat = 0, 0
\r
585 --// local import of socket methods //--
\r
587 local send = socket.send
\r
588 local receive = socket.receive
\r
589 local close = socket.close
\r
590 local shutdown = socket.shutdown
\r
592 --// public methods of the object //--
\r
594 local handler = { }
\r
596 handler.getstats = function( )
\r
597 return rstat, sstat
\r
600 handler.listener = function( data, err )
\r
601 return listener( handler, data, err )
\r
603 handler.ssl = function( )
\r
606 handler.send = function( _, data, i, j )
\r
607 return send( socket, data, i, j )
\r
609 handler.receive = function( pattern, prefix )
\r
610 return receive( socket, pattern, prefix )
\r
612 handler.shutdown = function( pattern )
\r
613 return shutdown( socket, pattern )
\r
615 handler.close = function( closed )
\r
616 _ = not closed and shutdown( socket )
\r
617 _ = not closed and close( socket )
\r
618 writelen = ( eol and removesocket( writelist, socket, writelen ) ) or writelen
\r
619 readlen = removesocket( readlist, socket, readlen )
\r
620 socketlist[ socket ] = nil
\r
621 out_put "server.lua: closed handler and removed socket from list"
\r
623 handler.ip = function( )
\r
626 handler.serverport = function( )
\r
629 handler.clientport = function( )
\r
632 handler.write = function( data )
\r
634 writelen = writelen + 1
\r
635 writelist[ writelen ] = socket
\r
639 writequeue[ eol ] = data
\r
641 handler.writequeue = function( )
\r
644 handler.socket = function( )
\r
647 handler.mode = function( )
\r
651 handler.receivedata = function( )
\r
652 local data, err, part = receive( socket, mode ) -- receive data in "mode"
\r
653 if not err or ( err == "timeout" or err == "wantread" ) then -- received something
\r
654 local data = data or part or ""
\r
655 local count = #data * STAT_UNIT
\r
656 rstat = rstat + count
\r
657 receivestat = receivestat + count
\r
658 out_put( "server.lua: read data '", data, "', error: ", err )
\r
659 return dispatch( handler, data, err )
\r
660 else -- connections was closed or fatal error
\r
661 out_put( "server.lua: client ", ip, ":", clientport, " error: ", err )
\r
663 disconnect( handler, err )
\r
670 handler.dispatchdata = function( ) -- this function writes data to handlers
\r
671 local buffer = table_concat( writequeue, "", 1, eol )
\r
672 local succ, err, byte = send( socket, buffer )
\r
673 local count = ( succ or 0 ) * STAT_UNIT
\r
674 sstat = sstat + count
\r
675 sendstat = sendstat + count
\r
676 out_put( "server.lua: sended '", buffer, "', bytes: ", succ, ", error: ", err, ", part: ", byte, ", to: ", ip, ":", clientport )
\r
677 if succ then -- sending succesful
\r
680 writelen = removesocket( writelist, socket, writelen ) -- delete socket from writelist
\r
682 elseif byte and ( err == "timeout" or err == "wantwrite" ) then -- want write
\r
683 buffer = string_sub( buffer, byte + 1, -1 ) -- new buffer
\r
684 writequeue[ 1 ] = buffer -- insert new buffer in queue
\r
687 else -- connection was closed during sending or fatal error
\r
688 out_put( "server.lua: client ", ip, ":", clientport, " error: ", err )
\r
690 disconnect( handler, err )
\r
699 handler.getIp = handler.ip
\r
700 handler.getPort = handler.clientport
\r
702 socketlist[ socket ] = handler
\r
703 readlen = readlen + 1
\r
704 readlist[ readlen ] = socket
\r
706 return handler, socket
\r
709 addtimer = function( listener )
\r
710 timelistener[ #timelistener + 1 ] = listener
\r
713 firetimer = function( listener )
\r
714 for i, listener in ipairs( timelistener ) do
\r
719 addserver = function( listeners, port, addr, mode, sslctx ) -- this function provides a way for other scripts to reg a server
\r
721 if type( listeners ) ~= "table" then
\r
722 err = "invalid listener table"
\r
724 for name, func in pairs( listeners ) do
\r
725 if type( func ) ~= "function" then
\r
726 err = "invalid listener function"
\r
731 if not type( port ) == "number" or not ( port >= 0 and port <= 65535 ) then
\r
732 err = "invalid port"
\r
733 elseif listener[ port ] then
\r
734 err= "listeners on port '" .. port .. "' already exist"
\r
735 elseif sslctx and not luasec then
\r
736 err = "luasec not found"
\r
739 out_error( "server.lua: ", err )
\r
743 local server, err = socket_bind( addr, port )
\r
745 out_error( "server.lua: ", err )
\r
748 local handler, err = wrapserver( listeners, server, addr, port, mode, sslctx ) -- wrap new server socket
\r
749 if not handler then
\r
753 server:settimeout( 0 )
\r
754 readlen = readlen + 1
\r
755 readlist[ readlen ] = server
\r
756 listener[ port ] = listeners
\r
757 socketlist[ server ] = handler
\r
758 out_put( "server.lua: new server listener on ", addr, ":", port )
\r
762 removesocket = function( tbl, socket, len ) -- this function removes sockets from a list
\r
763 for i, target in ipairs( tbl ) do
\r
764 if target == socket then
\r
766 table_remove( tbl, i )
\r
773 closeall = function( )
\r
774 for sock, handler in pairs( socketlist ) do
\r
775 handler.shutdown( )
\r
777 socketlist[ sock ] = nil
\r
779 writelist, readlist, socketlist = { }, { }, { }
\r
782 closesocket = function( socket )
\r
783 writelen = removesocket( writelist, socket, writelen )
\r
784 readlen = removesocket( readlist, socket, readlen )
\r
785 socketlist[ socket ] = nil
\r
789 loop = function( ) -- this is the main loop of the program
\r
790 --signal_set( "hub", "run" )
\r
792 --[[print(readlen, writelen)
\r
793 for _, s in ipairs(readlist) do print("R:", tostring(s)) end
\r
794 for _, s in ipairs(writelist) do print("W:", tostring(s)) end
\r
795 out_put("select()"..os.time())]]
\r
796 local read, write, err = socket_select( readlist, writelist, 1 ) -- 1 sec timeout, nice for timers
\r
797 for i, socket in ipairs( write ) do -- send data waiting in writequeues
\r
798 local handler = socketlist[ socket ]
\r
800 handler.dispatchdata( )
\r
802 closesocket( socket )
\r
803 out_put "server.lua: found no handler and closed socket (writelist)" -- this should not happen
\r
806 for i, socket in ipairs( read ) do -- receive data
\r
807 local handler = socketlist[ socket ]
\r
809 handler.receivedata( )
\r
811 closesocket( socket )
\r
812 out_put "server.lua: found no handler and closed socket (readlist)" -- this can happen
\r
820 ----------------------------------// BEGIN //--
\r
822 ----------------------------------// PUBLIC INTERFACE //--
\r
829 closeall = closeall,
\r
830 addtimer = addtimer,
\r