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