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