net/server_event.lua

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