net.server_event: Don't emit empty packets, check for errors first. (fixes #287)
[prosody.git] / net / server_event.lua
1 --[[
2
3
4                         server.lua based on lua/libevent by blastbeat
5
6                         notes:
7                         -- when using luaevent, never register 2 or more EV_READ at one socket, same for EV_WRITE
8                         -- you cant even register a new EV_READ/EV_WRITE callback inside another one
9                         -- never call eventcallback:close( ) from inside eventcallback
10                         -- to do some of the above, use timeout events or something what will called from outside
11                         -- dont let garbagecollect eventcallbacks, as long they are running
12                         -- when using luasec, there are 4 cases of timeout errors: wantread or wantwrite during reading or writing
13
14 --]]
15
16 local SCRIPT_NAME           = "server_event.lua"
17 local SCRIPT_VERSION        = "0.05"
18 local SCRIPT_AUTHOR         = "blastbeat"
19 local LAST_MODIFIED         = "2009/11/20"
20
21 local cfg = {
22         MAX_CONNECTIONS       = 100000,  -- max per server connections (use "ulimit -n" on *nix)
23         MAX_HANDSHAKE_ATTEMPTS= 1000,  -- attempts to finish ssl handshake
24         HANDSHAKE_TIMEOUT     = 60,  -- timeout in seconds per handshake attempt
25         MAX_READ_LENGTH       = 1024 * 1024 * 1024 * 1024,  -- max bytes allowed to read from sockets
26         MAX_SEND_LENGTH       = 1024 * 1024 * 1024 * 1024,  -- max bytes size of write buffer (for writing on sockets)
27         ACCEPT_DELAY          = 10,  -- seconds to wait until the next attempt of a full server to accept
28         READ_TIMEOUT          = 60 * 60 * 6,  -- timeout in seconds for read data from socket
29         WRITE_TIMEOUT         = 180,  -- timeout in seconds for write data on socket
30         CONNECT_TIMEOUT       = 20,  -- timeout in seconds for connection attempts
31         CLEAR_DELAY           = 5,  -- seconds to wait for clearing interface list (and calling ondisconnect listeners)
32         DEBUG                 = true,  -- show debug messages
33 }
34
35 local function use(x) return rawget(_G, x); end
36 local ipairs = use "ipairs"
37 local string = use "string"
38 local select = use "select"
39 local require = use "require"
40 local tostring = use "tostring"
41 local coroutine = use "coroutine"
42 local setmetatable = use "setmetatable"
43
44 local ssl = use "ssl"
45 local socket = use "socket" or require "socket"
46
47 local log = require ("util.logger").init("socket")
48
49 local function debug(...)
50         return log("debug", ("%s "):rep(select('#', ...)), ...)
51 end
52 local vdebug = debug;
53
54 local bitor = ( function( ) -- thx Rici Lake
55         local hasbit = function( x, p )
56                 return x % ( p + p ) >= p
57         end
58         return function( x, y )
59                 local p = 1
60                 local z = 0
61                 local limit = x > y and x or y
62                 while p <= limit do
63                         if hasbit( x, p ) or hasbit( y, p ) then
64                                 z = z + p
65                         end
66                         p = p + p
67                 end
68                 return z
69         end
70 end )( )
71
72 local event = require "luaevent.core"
73 local base = event.new( )
74 local EV_READ = event.EV_READ
75 local EV_WRITE = event.EV_WRITE
76 local EV_TIMEOUT = event.EV_TIMEOUT
77 local EV_SIGNAL = event.EV_SIGNAL
78
79 local EV_READWRITE = bitor( EV_READ, EV_WRITE )
80
81 local interfacelist = ( function( )  -- holds the interfaces for sockets
82         local array = { }
83         local len = 0
84         return function( method, arg )
85                 if "add" == method then
86                         len = len + 1
87                         array[ len ] = arg
88                         arg:_position( len )
89                         return len
90                 elseif "delete" == method then
91                         if len <= 0 then
92                                 return nil, "array is already empty"
93                         end
94                         local position = arg:_position()  -- get position in array
95                         if position ~= len then
96                                 local interface = array[ len ]  -- get last interface
97                                 array[ position ] = interface  -- copy it into free position
98                                 array[ len ] = nil  -- free last position
99                                 interface:_position( position )  -- set new position in array
100                         else  -- free last position
101                                 array[ len ] = nil
102                         end
103                         len = len - 1
104                         return len
105                 else
106                         return array
107                 end
108         end
109 end )( )
110
111 -- Client interface methods
112 local interface_mt
113 do
114         interface_mt = {}; interface_mt.__index = interface_mt;
115         
116         local addevent = base.addevent
117         local coroutine_wrap, coroutine_yield = coroutine.wrap,coroutine.yield
118         local string_len = string.len
119         
120         -- Private methods
121         function interface_mt:_position(new_position)
122                         self.position = new_position or self.position
123                         return self.position;
124         end
125         function interface_mt:_close() -- regs event to start self:_destroy()
126                         local callback = function( )
127                                 self:_destroy();
128                                 self.eventclose = nil
129                                 return -1
130                         end
131                         self.eventclose = addevent( base, nil, EV_TIMEOUT, callback, 0 )
132                         return true
133         end
134         
135         function interface_mt:_start_connection(plainssl) -- should be called from addclient
136                         local callback = function( event )
137                                 if EV_TIMEOUT == event then  -- timeout during connection
138                                         self.fatalerror = "connection timeout"
139                                         self:ontimeout()  -- call timeout listener
140                                         self:_close()
141                                         debug( "new connection failed. id:", self.id, "error:", self.fatalerror )
142                                 else
143                                         if plainssl and ssl then  -- start ssl session
144                                                 self:starttls(self._sslctx, true)
145                                         else  -- normal connection
146                                                 self:_start_session(true)
147                                         end
148                                         debug( "new connection established. id:", self.id )
149                                 end
150                                 self.eventconnect = nil
151                                 return -1
152                         end
153                         self.eventconnect = addevent( base, self.conn, EV_WRITE, callback, cfg.CONNECT_TIMEOUT )
154                         return true
155         end
156         function interface_mt:_start_session(call_onconnect) -- new session, for example after startssl
157                 if self.type == "client" then
158                         local callback = function( )
159                                 self:_lock( false,  false, false )
160                                 --vdebug( "start listening on client socket with id:", self.id )
161                                 self.eventread = addevent( base, self.conn, EV_READ, self.readcallback, cfg.READ_TIMEOUT );  -- register callback
162                                 if call_onconnect then
163                                         self:onconnect()
164                                 end
165                                 self.eventsession = nil
166                                 return -1
167                         end
168                         self.eventsession = addevent( base, nil, EV_TIMEOUT, callback, 0 )
169                 else
170                         self:_lock( false )
171                         --vdebug( "start listening on server socket with id:", self.id )
172                         self.eventread = addevent( base, self.conn, EV_READ, self.readcallback )  -- register callback
173                 end
174                 return true
175         end
176         function interface_mt:_start_ssl(call_onconnect) -- old socket will be destroyed, therefore we have to close read/write events first
177                         --vdebug( "starting ssl session with client id:", self.id )
178                         local _
179                         _ = self.eventread and self.eventread:close( )  -- close events; this must be called outside of the event callbacks!
180                         _ = self.eventwrite and self.eventwrite:close( )
181                         self.eventread, self.eventwrite = nil, nil
182                         local err
183                         self.conn, err = ssl.wrap( self.conn, self._sslctx )
184                         if err then
185                                 self.fatalerror = err
186                                 self.conn = nil  -- cannot be used anymore
187                                 if call_onconnect then
188                                         self.ondisconnect = nil  -- dont call this when client isnt really connected
189                                 end
190                                 self:_close()
191                                 debug( "fatal error while ssl wrapping:", err )
192                                 return false
193                         end
194                         self.conn:settimeout( 0 )  -- set non blocking
195                         local handshakecallback = coroutine_wrap(
196                                 function( event )
197                                         local _, err
198                                         local attempt = 0
199                                         local maxattempt = cfg.MAX_HANDSHAKE_ATTEMPTS
200                                         while attempt < maxattempt do  -- no endless loop
201                                                 attempt = attempt + 1
202                                                 debug( "ssl handshake of client with id:"..tostring(self)..", attempt:"..attempt )
203                                                 if attempt > maxattempt then
204                                                         self.fatalerror = "max handshake attempts exceeded"
205                                                 elseif EV_TIMEOUT == event then
206                                                         self.fatalerror = "timeout during handshake"
207                                                 else
208                                                         _, err = self.conn:dohandshake( )
209                                                         if not err then
210                                                                 self:_lock( false, false, false )  -- unlock the interface; sending, closing etc allowed
211                                                                 self.send = self.conn.send  -- caching table lookups with new client object
212                                                                 self.receive = self.conn.receive
213                                                                 if not call_onconnect then  -- trigger listener
214                                                                         self:onstatus("ssl-handshake-complete");
215                                                                 end
216                                                                 self:_start_session( call_onconnect )
217                                                                 debug( "ssl handshake done" )
218                                                                 self.eventhandshake = nil
219                                                                 return -1
220                                                         end
221                                                         if err == "wantwrite" then
222                                                                 event = EV_WRITE
223                                                         elseif err == "wantread" then
224                                                                 event = EV_READ
225                                                         else
226                                                                 debug( "ssl handshake error:", err )
227                                                                 self.fatalerror = err
228                                                         end
229                                                 end
230                                                 if self.fatalerror then
231                                                         if call_onconnect then
232                                                                 self.ondisconnect = nil  -- dont call this when client isnt really connected
233                                                         end
234                                                         self:_close()
235                                                         debug( "handshake failed because:", self.fatalerror )
236                                                         self.eventhandshake = nil
237                                                         return -1
238                                                 end
239                                                 event = coroutine_yield( event, cfg.HANDSHAKE_TIMEOUT )  -- yield this monster...
240                                         end
241                                 end
242                         )
243                         debug "starting handshake..."
244                         self:_lock( false, true, true )  -- unlock read/write events, but keep interface locked
245                         self.eventhandshake = addevent( base, self.conn, EV_READWRITE, handshakecallback, cfg.HANDSHAKE_TIMEOUT )
246                         return true
247         end
248         function interface_mt:_destroy()  -- close this interface + events and call last listener
249                         debug( "closing client with id:", self.id, self.fatalerror )
250                         self:_lock( true, true, true )  -- first of all, lock the interface to avoid further actions
251                         local _
252                         _ = self.eventread and self.eventread:close( )  -- close events; this must be called outside of the event callbacks!
253                         if self.type == "client" then
254                                 _ = self.eventwrite and self.eventwrite:close( )
255                                 _ = self.eventhandshake and self.eventhandshake:close( )
256                                 _ = self.eventstarthandshake and self.eventstarthandshake:close( )
257                                 _ = self.eventconnect and self.eventconnect:close( )
258                                 _ = self.eventsession and self.eventsession:close( )
259                                 _ = self.eventwritetimeout and self.eventwritetimeout:close( )
260                                 _ = self.eventreadtimeout and self.eventreadtimeout:close( )
261                                 _ = self.ondisconnect and self:ondisconnect( self.fatalerror ~= "client to close" and self.fatalerror)  -- call ondisconnect listener (wont be the case if handshake failed on connect)
262                                 _ = self.conn and self.conn:close( ) -- close connection, must also be called outside of any socket registered events!
263                                 _ = self._server and self._server:counter(-1);
264                                 self.eventread, self.eventwrite = nil, nil
265                                 self.eventstarthandshake, self.eventhandshake, self.eventclose = nil, nil, nil
266                                 self.readcallback, self.writecallback = nil, nil
267                         else
268                                 self.conn:close( )
269                                 self.eventread, self.eventclose = nil, nil
270                                 self.interface, self.readcallback = nil, nil
271                         end
272                         interfacelist( "delete", self )
273                         return true
274         end
275         
276         function interface_mt:_lock(nointerface, noreading, nowriting)  -- lock or unlock this interface or events
277                         self.nointerface, self.noreading, self.nowriting = nointerface, noreading, nowriting
278                         return nointerface, noreading, nowriting
279         end
280         
281         --TODO: Deprecate
282         function interface_mt:lock_read(switch)
283                 if switch then
284                         return self:pause();
285                 else
286                         return self:resume();
287                 end
288         end
289
290         function interface_mt:pause()
291                 return self:_lock(self.nointerface, true, self.nowriting);
292         end
293
294         function interface_mt:resume()
295                 self:_lock(self.nointerface, false, self.nowriting);
296                 if not self.eventread then
297                         self.eventread = addevent( base, self.conn, EV_READ, self.readcallback, cfg.READ_TIMEOUT );  -- register callback
298                 end
299         end
300
301         function interface_mt:counter(c)
302                 if c then
303                         self._connections = self._connections + c
304                 end
305                 return self._connections
306         end
307         
308         -- Public methods
309         function interface_mt:write(data)
310                 if self.nowriting then return nil, "locked" end
311                 --vdebug( "try to send data to client, id/data:", self.id, data )
312                 data = tostring( data )
313                 local len = string_len( data )
314                 local total = len + self.writebufferlen
315                 if total > cfg.MAX_SEND_LENGTH then  -- check buffer length
316                         local err = "send buffer exceeded"
317                         debug( "error:", err )  -- to much, check your app
318                         return nil, err
319                 end
320                 self.writebuffer = self.writebuffer .. data -- new buffer
321                 self.writebufferlen = total
322                 if not self.eventwrite then  -- register new write event
323                         --vdebug( "register new write event" )
324                         self.eventwrite = addevent( base, self.conn, EV_WRITE, self.writecallback, cfg.WRITE_TIMEOUT )
325                 end
326                 return true
327         end
328         function interface_mt:close()
329                 if self.nointerface then return nil, "locked"; end
330                 debug( "try to close client connection with id:", self.id )
331                 if self.type == "client" then
332                         self.fatalerror = "client to close"
333                         if self.eventwrite then -- wait for incomplete write request
334                                 self:_lock( true, true, false )
335                                 debug "closing delayed until writebuffer is empty"
336                                 return nil, "writebuffer not empty, waiting"
337                         else -- close now
338                                 self:_lock( true, true, true )
339                                 self:_close()
340                                 return true
341                         end
342                 else
343                         debug( "try to close server with id:", tostring(self.id))
344                         self.fatalerror = "server to close"
345                         self:_lock( true )
346                         self:_close( 0 )  -- add new event to remove the server interface
347                         return true
348                 end
349         end
350         
351         function interface_mt:socket()
352                 return self.conn
353         end
354         
355         function interface_mt:server()
356                 return self._server or self;
357         end
358         
359         function interface_mt:port()
360                 return self._port
361         end
362         
363         function interface_mt:serverport()
364                 return self._serverport
365         end
366         
367         function interface_mt:ip()
368                 return self._ip
369         end
370         
371         function interface_mt:ssl()
372                 return self._usingssl
373         end
374
375         function interface_mt:type()
376                 return self._type or "client"
377         end
378         
379         function interface_mt:connections()
380                 return self._connections
381         end
382         
383         function interface_mt:address()
384                 return self.addr
385         end
386         
387         function interface_mt:set_sslctx(sslctx)
388                 self._sslctx = sslctx;
389                 if sslctx then
390                         self.starttls = nil; -- use starttls() of interface_mt
391                 else
392                         self.starttls = false; -- prevent starttls()
393                 end
394         end
395
396         function interface_mt:set_mode(pattern)
397                 if pattern then
398                         self._pattern = pattern;
399                 end
400                 return self._pattern;
401         end
402         
403         function interface_mt:set_send(new_send)
404                 -- No-op, we always use the underlying connection's send
405         end
406         
407         function interface_mt:starttls(sslctx, call_onconnect)
408                 debug( "try to start ssl at client id:", self.id )
409                 local err
410                 self._sslctx = sslctx;
411                 if self._usingssl then  -- startssl was already called
412                         err = "ssl already active"
413                 end
414                 if err then
415                         debug( "error:", err )
416                         return nil, err
417                 end
418                 self._usingssl = true
419                 self.startsslcallback = function( )  -- we have to start the handshake outside of a read/write event
420                         self.startsslcallback = nil
421                         self:_start_ssl(call_onconnect);
422                         self.eventstarthandshake = nil
423                         return -1
424                 end
425                 if not self.eventwrite then
426                         self:_lock( true, true, true )  -- lock the interface, to not disturb the handshake
427                         self.eventstarthandshake = addevent( base, nil, EV_TIMEOUT, self.startsslcallback, 0 )  -- add event to start handshake
428                 else  -- wait until writebuffer is empty
429                         self:_lock( true, true, false )
430                         debug "ssl session delayed until writebuffer is empty..."
431                 end
432                 self.starttls = false;
433                 return true
434         end
435         
436         function interface_mt:setoption(option, value)
437                 if self.conn.setoption then
438                         return self.conn:setoption(option, value);
439                 end
440                 return false, "setoption not implemented";
441         end
442         
443         function interface_mt:setlistener(listener)
444                 self.onconnect, self.ondisconnect, self.onincoming, self.ontimeout, self.onstatus
445                         = listener.onconnect, listener.ondisconnect, listener.onincoming, listener.ontimeout, listener.onstatus;
446         end
447         
448         -- Stub handlers
449         function interface_mt:onconnect()
450         end
451         function interface_mt:onincoming()
452         end
453         function interface_mt:ondisconnect()
454         end
455         function interface_mt:ontimeout()
456         end
457         function interface_mt:ondrain()
458         end
459         function interface_mt:onstatus()
460         end
461 end
462
463 -- End of client interface methods
464
465 local handleclient;
466 do
467         local string_sub = string.sub  -- caching table lookups
468         local string_len = string.len
469         local addevent = base.addevent
470         local socket_gettime = socket.gettime
471         function handleclient( client, ip, port, server, pattern, listener, sslctx )  -- creates an client interface
472                 --vdebug("creating client interfacce...")
473                 local interface = {
474                         type = "client";
475                         conn = client;
476                         currenttime = socket_gettime( );  -- safe the origin
477                         writebuffer = "";  -- writebuffer
478                         writebufferlen = 0;  -- length of writebuffer
479                         send = client.send;  -- caching table lookups
480                         receive = client.receive;
481                         onconnect = listener.onconnect;  -- will be called when client disconnects
482                         ondisconnect = listener.ondisconnect;  -- will be called when client disconnects
483                         onincoming = listener.onincoming;  -- will be called when client sends data
484                         ontimeout = listener.ontimeout; -- called when fatal socket timeout occurs
485                         onstatus = listener.onstatus; -- called for status changes (e.g. of SSL/TLS)
486                         eventread = false, eventwrite = false, eventclose = false,
487                         eventhandshake = false, eventstarthandshake = false;  -- event handler
488                         eventconnect = false, eventsession = false;  -- more event handler...
489                         eventwritetimeout = false;  -- even more event handler...
490                         eventreadtimeout = false;
491                         fatalerror = false;  -- error message
492                         writecallback = false;  -- will be called on write events
493                         readcallback = false;  -- will be called on read events
494                         nointerface = true;  -- lock/unlock parameter of this interface
495                         noreading = false, nowriting = false;  -- locks of the read/writecallback
496                         startsslcallback = false;  -- starting handshake callback
497                         position = false;  -- position of client in interfacelist
498                         
499                         -- Properties
500                         _ip = ip, _port = port, _server = server, _pattern = pattern,
501                         _serverport = (server and server:port() or nil),
502                         _sslctx = sslctx; -- parameters
503                         _usingssl = false;  -- client is using ssl;
504                 }
505                 if not ssl then interface.starttls = false; end
506                 interface.id = tostring(interface):match("%x+$");
507                 interface.writecallback = function( event )  -- called on write events
508                         --vdebug( "new client write event, id/ip/port:", interface, ip, port )
509                         if interface.nowriting or ( interface.fatalerror and ( "client to close" ~= interface.fatalerror ) ) then  -- leave this event
510                                 --vdebug( "leaving this event because:", interface.nowriting or interface.fatalerror )
511                                 interface.eventwrite = false
512                                 return -1
513                         end
514                         if EV_TIMEOUT == event then  -- took too long to write some data to socket -> disconnect
515                                 interface.fatalerror = "timeout during writing"
516                                 debug( "writing failed:", interface.fatalerror )
517                                 interface:_close()
518                                 interface.eventwrite = false
519                                 return -1
520                         else  -- can write :)
521                                 if interface._usingssl then  -- handle luasec
522                                         if interface.eventreadtimeout then  -- we have to read first
523                                                 local ret = interface.readcallback( )  -- call readcallback
524                                                 --vdebug( "tried to read in writecallback, result:", ret )
525                                         end
526                                         if interface.eventwritetimeout then  -- luasec only
527                                                 interface.eventwritetimeout:close( )  -- first we have to close timeout event which where regged after a wantread error
528                                                 interface.eventwritetimeout = false
529                                         end
530                                 end
531                                 local succ, err, byte = interface.conn:send( interface.writebuffer, 1, interface.writebufferlen )
532                                 --vdebug( "write data:", interface.writebuffer, "error:", err, "part:", byte )
533                                 if succ then  -- writing succesful
534                                         interface.writebuffer = ""
535                                         interface.writebufferlen = 0
536                                         interface:ondrain();
537                                         if interface.fatalerror then
538                                                 debug "closing client after writing"
539                                                 interface:_close()  -- close interface if needed
540                                         elseif interface.startsslcallback then  -- start ssl connection if needed
541                                                 debug "starting ssl handshake after writing"
542                                                 interface.eventstarthandshake = addevent( base, nil, EV_TIMEOUT, interface.startsslcallback, 0 )
543                                         elseif interface.eventreadtimeout then
544                                                 return EV_WRITE, EV_TIMEOUT
545                                         end
546                                         interface.eventwrite = nil
547                                         return -1
548                                 elseif byte and (err == "timeout" or err == "wantwrite") then  -- want write again
549                                         --vdebug( "writebuffer is not empty:", err )
550                                         interface.writebuffer = string_sub( interface.writebuffer, byte + 1, interface.writebufferlen )  -- new buffer
551                                         interface.writebufferlen = interface.writebufferlen - byte
552                                         if "wantread" == err then  -- happens only with luasec
553                                                 local callback = function( )
554                                                         interface:_close()
555                                                         interface.eventwritetimeout = nil
556                                                         return -1;
557                                                 end
558                                                 interface.eventwritetimeout = addevent( base, nil, EV_TIMEOUT, callback, cfg.WRITE_TIMEOUT )  -- reg a new timeout event
559                                                 debug( "wantread during write attempt, reg it in readcallback but dont know what really happens next..." )
560                                                 -- hopefully this works with luasec; its simply not possible to use 2 different write events on a socket in luaevent
561                                                 return -1
562                                         end
563                                         return EV_WRITE, cfg.WRITE_TIMEOUT
564                                 else  -- connection was closed during writing or fatal error
565                                         interface.fatalerror = err or "fatal error"
566                                         debug( "connection failed in write event:", interface.fatalerror )
567                                         interface:_close()
568                                         interface.eventwrite = nil
569                                         return -1
570                                 end
571                         end
572                 end
573                 
574                 interface.readcallback = function( event )  -- called on read events
575                         --vdebug( "new client read event, id/ip/port:", tostring(interface.id), tostring(ip), tostring(port) )
576                         if interface.noreading or interface.fatalerror then  -- leave this event
577                                 --vdebug( "leaving this event because:", tostring(interface.noreading or interface.fatalerror) )
578                                 interface.eventread = nil
579                                 return -1
580                         end
581                         if EV_TIMEOUT == event then  -- took too long to get some data from client -> disconnect
582                                 interface.fatalerror = "timeout during receiving"
583                                 debug( "connection failed:", interface.fatalerror )
584                                 interface:_close()
585                                 interface.eventread = nil
586                                 return -1
587                         else -- can read
588                                 if interface._usingssl then  -- handle luasec
589                                         if interface.eventwritetimeout then  -- ok, in the past writecallback was regged
590                                                 local ret = interface.writecallback( )  -- call it
591                                                 --vdebug( "tried to write in readcallback, result:", tostring(ret) )
592                                         end
593                                         if interface.eventreadtimeout then
594                                                 interface.eventreadtimeout:close( )
595                                                 interface.eventreadtimeout = nil
596                                         end
597                                 end
598                                 local buffer, err, part = interface.conn:receive( interface._pattern )  -- receive buffer with "pattern"
599                                 --vdebug( "read data:", tostring(buffer), "error:", tostring(err), "part:", tostring(part) )
600                                 buffer = buffer or part
601                                 if buffer and #buffer > cfg.MAX_READ_LENGTH then  -- check buffer length
602                                         interface.fatalerror = "receive buffer exceeded"
603                                         debug( "fatal error:", interface.fatalerror )
604                                         interface:_close()
605                                         interface.eventread = nil
606                                         return -1
607                                 end
608                                 if err and ( err ~= "timeout" and err ~= "wantread" ) then
609                                         if "wantwrite" == err then -- need to read on write event
610                                                 if not interface.eventwrite then  -- register new write event if needed
611                                                         interface.eventwrite = addevent( base, interface.conn, EV_WRITE, interface.writecallback, cfg.WRITE_TIMEOUT )
612                                                 end
613                                                 interface.eventreadtimeout = addevent( base, nil, EV_TIMEOUT,
614                                                         function( )
615                                                                 interface:_close()
616                                                         end, cfg.READ_TIMEOUT
617                                                 )
618                                                 debug( "wantwrite during read attempt, reg it in writecallback but dont know what really happens next..." )
619                                                 -- to be honest i dont know what happens next, if it is allowed to first read, the write etc...
620                                         else  -- connection was closed or fatal error
621                                                 interface.fatalerror = err
622                                                 debug( "connection failed in read event:", interface.fatalerror )
623                                                 interface:_close()
624                                                 interface.eventread = nil
625                                                 return -1
626                                         end
627                                 else
628                                         interface.onincoming( interface, buffer, err )  -- send new data to listener
629                                 end
630                                 if interface.noreading then
631                                         interface.eventread = nil;
632                                         return -1;
633                                 end
634                                 return EV_READ, cfg.READ_TIMEOUT
635                         end
636                 end
637
638                 client:settimeout( 0 )  -- set non blocking
639                 setmetatable(interface, interface_mt)
640                 interfacelist( "add", interface )  -- add to interfacelist
641                 return interface
642         end
643 end
644
645 local handleserver
646 do
647         function handleserver( server, addr, port, pattern, listener, sslctx )  -- creates an server interface
648                 debug "creating server interface..."
649                 local interface = {
650                         _connections = 0;
651                         
652                         conn = server;
653                         onconnect = listener.onconnect;  -- will be called when new client connected
654                         eventread = false;  -- read event handler
655                         eventclose = false; -- close event handler
656                         readcallback = false; -- read event callback
657                         fatalerror = false; -- error message
658                         nointerface = true;  -- lock/unlock parameter
659                         
660                         _ip = addr, _port = port, _pattern = pattern,
661                         _sslctx = sslctx;
662                 }
663                 interface.id = tostring(interface):match("%x+$");
664                 interface.readcallback = function( event )  -- server handler, called on incoming connections
665                         --vdebug( "server can accept, id/addr/port:", interface, addr, port )
666                         if interface.fatalerror then
667                                 --vdebug( "leaving this event because:", self.fatalerror )
668                                 interface.eventread = nil
669                                 return -1
670                         end
671                         local delay = cfg.ACCEPT_DELAY
672                         if EV_TIMEOUT == event then
673                                 if interface._connections >= cfg.MAX_CONNECTIONS then  -- check connection count
674                                         debug( "to many connections, seconds to wait for next accept:", delay )
675                                         return EV_TIMEOUT, delay  -- timeout...
676                                 else
677                                         return EV_READ  -- accept again
678                                 end
679                         end
680                         --vdebug("max connection check ok, accepting...")
681                         local client, err = server:accept()    -- try to accept; TODO: check err
682                         while client do
683                                 if interface._connections >= cfg.MAX_CONNECTIONS then
684                                         client:close( )  -- refuse connection
685                                         debug( "maximal connections reached, refuse client connection; accept delay:", delay )
686                                         return EV_TIMEOUT, delay  -- delay for next accept attempt
687                                 end
688                                 local client_ip, client_port = client:getpeername( )
689                                 interface._connections = interface._connections + 1  -- increase connection count
690                                 local clientinterface = handleclient( client, client_ip, client_port, interface, pattern, listener, sslctx )
691                                 --vdebug( "client id:", clientinterface, "startssl:", startssl )
692                                 if ssl and sslctx then
693                                         clientinterface:starttls(sslctx, true)
694                                 else
695                                         clientinterface:_start_session( true )
696                                 end
697                                 debug( "accepted incoming client connection from:", client_ip or "<unknown IP>", client_port or "<unknown port>", "to", port or "<unknown port>");
698                                 
699                                 client, err = server:accept()    -- try to accept again
700                         end
701                         return EV_READ
702                 end
703                 
704                 server:settimeout( 0 )
705                 setmetatable(interface, interface_mt)
706                 interfacelist( "add", interface )
707                 interface:_start_session()
708                 return interface
709         end
710 end
711
712 local addserver = ( function( )
713         return function( addr, port, listener, pattern, sslcfg, startssl )  -- TODO: check arguments
714                 --vdebug( "creating new tcp server with following parameters:", addr or "nil", port or "nil", sslcfg or "nil", startssl or "nil")
715                 local server, err = socket.bind( addr, port, cfg.ACCEPT_QUEUE )  -- create server socket
716                 if not server then
717                         debug( "creating server socket on "..addr.." port "..port.." failed:", err )
718                         return nil, err
719                 end
720                 local sslctx
721                 if sslcfg then
722                         if not ssl then
723                                 debug "fatal error: luasec not found"
724                                 return nil, "luasec not found"
725                         end
726                         sslctx, err = sslcfg
727                         if err then
728                                 debug( "error while creating new ssl context for server socket:", err )
729                                 return nil, err
730                         end
731                 end
732                 local interface = handleserver( server, addr, port, pattern, listener, sslctx, startssl )  -- new server handler
733                 debug( "new server created with id:", tostring(interface))
734                 return interface
735         end
736 end )( )
737
738 local addclient, wrapclient
739 do
740         function wrapclient( client, ip, port, listeners, pattern, sslctx )
741                 local interface = handleclient( client, ip, port, nil, pattern, listeners, sslctx )
742                 interface:_start_connection(sslctx)
743                 return interface, client
744                 --function handleclient( client, ip, port, server, pattern, listener, _, sslctx )  -- creates an client interface
745         end
746         
747         function addclient( addr, serverport, listener, pattern, localaddr, localport, sslcfg, startssl )
748                 local client, err = socket.tcp()  -- creating new socket
749                 if not client then
750                         debug( "cannot create socket:", err )
751                         return nil, err
752                 end
753                 client:settimeout( 0 )  -- set nonblocking
754                 if localaddr then
755                         local res, err = client:bind( localaddr, localport, -1 )
756                         if not res then
757                                 debug( "cannot bind client:", err )
758                                 return nil, err
759                         end
760                 end
761                 local sslctx
762                 if sslcfg then  -- handle ssl/new context
763                         if not ssl then
764                                 debug "need luasec, but not available"
765                                 return nil, "luasec not found"
766                         end
767                         sslctx, err = sslcfg
768                         if err then
769                                 debug( "cannot create new ssl context:", err )
770                                 return nil, err
771                         end
772                 end
773                 local res, err = client:connect( addr, serverport )  -- connect
774                 if res or ( err == "timeout" ) then
775                         local ip, port = client:getsockname( )
776                         local interface = wrapclient( client, ip, serverport, listener, pattern, sslctx, startssl )
777                         interface:_start_connection( startssl )
778                         debug( "new connection id:", interface.id )
779                         return interface, err
780                 else
781                         debug( "new connection failed:", err )
782                         return nil, err
783                 end
784         end
785 end
786
787
788 local loop = function( )  -- starts the event loop
789         base:loop( )
790         return "quitting";
791 end
792
793 local newevent = ( function( )
794         local add = base.addevent
795         return function( ... )
796                 return add( base, ... )
797         end
798 end )( )
799
800 local closeallservers = function( arg )
801         for _, item in ipairs( interfacelist( ) ) do
802                 if item.type == "server" then
803                         item:close( arg )
804                 end
805         end
806 end
807
808 local function setquitting(yes)
809         if yes then
810                  -- Quit now
811                  closeallservers();
812                  base:loopexit();
813         end
814 end
815
816 local function get_backend()
817         return base:method();
818 end
819
820 -- We need to hold onto the events to stop them
821 -- being garbage-collected
822 local signal_events = {}; -- [signal_num] -> event object
823 local function hook_signal(signal_num, handler)
824         local function _handler(event)
825                 local ret = handler();
826                 if ret ~= false then -- Continue handling this signal?
827                         return EV_SIGNAL; -- Yes
828                 end
829                 return -1; -- Close this event
830         end
831         signal_events[signal_num] = base:addevent(signal_num, EV_SIGNAL, _handler);
832         return signal_events[signal_num];
833 end
834
835 local function link(sender, receiver, buffersize)
836         local sender_locked;
837         
838         function receiver:ondrain()
839                 if sender_locked then
840                         sender:resume();
841                         sender_locked = nil;
842                 end
843         end
844         
845         function sender:onincoming(data)
846                 receiver:write(data);
847                 if receiver.writebufferlen >= buffersize then
848                         sender_locked = true;
849                         sender:pause();
850                 end
851         end
852 end
853
854 return {
855
856         cfg = cfg,
857         base = base,
858         loop = loop,
859         link = link,
860         event = event,
861         event_base = base,
862         addevent = newevent,
863         addserver = addserver,
864         addclient = addclient,
865         wrapclient = wrapclient,
866         setquitting = setquitting,
867         closeall = closeallservers,
868         get_backend = get_backend,
869         hook_signal = hook_signal,
870
871         __NAME = SCRIPT_NAME,
872         __DATE = LAST_MODIFIED,
873         __AUTHOR = SCRIPT_AUTHOR,
874         __VERSION = SCRIPT_VERSION,
875
876 }