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