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