src/inspsocket.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
   6  *                       E-mail:
   7  *                <brain@chatspike.net>
   8  *                <Craig@chatspike.net>
   9  *
  10  * Written by Craig Edwards, Craig McLure, and others.
  11  * This program is free but copyrighted software; see
  12  *            the file COPYING for details.
  13  *
  14  * ---------------------------------------------------
  15  */
  16
  17 #include <string>
  18 #include <sstream>
  19 #include <iostream>
  20 #include <fstream>
  21 #include <stdexcept>
  22 #include "inspircd_config.h"
  23 #include "socket.h"
  24 #include "inspircd.h"
  25 #include "configreader.h"
  26 #include "inspstring.h"
  27 #include "helperfuncs.h"
  28 #include "socketengine.h"
  29 #include "message.h"
  30
  31
  32 extern InspIRCd* ServerInstance;
  33 extern ServerConfig* Config;
  34 extern time_t TIME;
  35 extern Server* MyServer;
  36
  37 InspSocket* socket_ref[MAX_DESCRIPTORS];
  38
  39
  40 InspSocket::InspSocket()
  41 {
  42         this->state = I_DISCONNECTED;
  43         this->fd = -1;
  44         this->ClosePending = false;
  45 }
  46
  47 InspSocket::InspSocket(int newfd, const char* ip)
  48 {
  49         this->fd = newfd;
  50         this->state = I_CONNECTED;
  51         strlcpy(this->IP,ip,MAXBUF);
  52         this->ClosePending = false;
  53         if (this->fd > -1)
  54         {
  55                 ServerInstance->SE->AddFd(this->fd,true,X_ESTAB_MODULE);
  56                 socket_ref[this->fd] = this;
  57         }
  58 }
  59
  60 InspSocket::InspSocket(const std::string &ipaddr, int aport, bool listening, unsigned long maxtime) : fd(-1)
  61 {
  62         strlcpy(host,ipaddr.c_str(),MAXBUF);
  63         this->ClosePending = false;
  64         if (listening) {
  65                 if ((this->fd = OpenTCPSocket()) == ERROR)
  66                 {
  67                         this->fd = -1;
  68                         this->state = I_ERROR;
  69                         this->OnError(I_ERR_SOCKET);
  70                         this->ClosePending = true;
  71                         log(DEBUG,"OpenTCPSocket() error");
  72                         return;
  73                 }
  74                 else
  75                 {
  76                         if (!BindSocket(this->fd,this->client,this->server,aport,(char*)ipaddr.c_str()))
  77                         {
  78                                 log(DEBUG,"BindSocket() error %s",strerror(errno));
  79                                 this->Close();
  80                                 this->fd = -1;
  81                                 this->state = I_ERROR;
  82                                 this->OnError(I_ERR_BIND);
  83                                 this->ClosePending = true;
  84                                 return;
  85                         }
  86                         else
  87                         {
  88                                 this->state = I_LISTENING;
  89                                 if (this->fd > -1)
  90                                 {
  91                                         ServerInstance->SE->AddFd(this->fd,true,X_ESTAB_MODULE);
  92                                         socket_ref[this->fd] = this;
  93                                 }
  94                                 log(DEBUG,"New socket now in I_LISTENING state");
  95                                 return;
  96                         }
  97                 }
  98         }
  99         else
 100         {
 101                 strlcpy(this->host,ipaddr.c_str(),MAXBUF);
 102                 this->port = aport;
 103
 104                 if (insp_aton(host,&addy) < 1)
 105                 {
 106                         log(DEBUG,"You cannot pass hostnames to InspSocket, resolve them first with Resolver!");
 107                         this->Close();
 108                         this->fd = -1;
 109                         this->state = I_ERROR;
 110                         this->OnError(I_ERR_RESOLVE);
 111                         this->ClosePending = true;
 112                         return;
 113                 }
 114                 else
 115                 {
 116                         log(DEBUG,"No need to resolve %s",this->host);
 117                         strlcpy(this->IP,host,MAXBUF);
 118                         timeout_end = time(NULL) + maxtime;
 119                         this->DoConnect();
 120                 }
 121         }
 122 }
 123
 124 void InspSocket::WantWrite()
 125 {
 126         /** XXX:
 127          * The socket engine may only have each FD in the list ONCE.
 128          * This means we cant watch for write AND read at the same
 129          * time. We have to remove the READ fd, to insert the WRITE
 130          * fd. Once we receive our WRITE event (which WILL ARRIVE,
 131          * pretty much gauranteed) we switch back to watching for
 132          * READ events again.
 133          *
 134          * This behaviour may be fixed in a later version.
 135          */
 136         this->WaitingForWriteEvent = true;
 137         ServerInstance->SE->DelFd(this->fd);
 138         ServerInstance->SE->AddFd(this->fd,false,X_ESTAB_MODULE);
 139 }
 140
 141 void InspSocket::SetQueues(int nfd)
 142 {
 143         // attempt to increase socket sendq and recvq as high as its possible
 144         int sendbuf = 32768;
 145         int recvbuf = 32768;
 146         setsockopt(nfd,SOL_SOCKET,SO_SNDBUF,(const void *)&sendbuf,sizeof(sendbuf));
 147         setsockopt(nfd,SOL_SOCKET,SO_RCVBUF,(const void *)&recvbuf,sizeof(sendbuf));
 148 }
 149
 150 /* Most irc servers require you to specify the ip you want to bind to.
 151  * If you dont specify an IP, they rather dumbly bind to the first IP
 152  * of the box (e.g. INADDR_ANY). In InspIRCd, we scan thought the IP
 153  * addresses we've bound server ports to, and we try and bind our outbound
 154  * connections to the first usable non-loopback and non-any IP we find.
 155  * This is easier to configure when you have a lot of links and a lot
 156  * of servers to configure.
 157  */
 158 bool InspSocket::BindAddr()
 159 {
 160         insp_inaddr n;
 161         ConfigReader Conf;
 162
 163         log(DEBUG,"In InspSocket::BindAddr()");
 164         for (int j =0; j < Conf.Enumerate("bind"); j++)
 165         {
 166                 std::string Type = Conf.ReadValue("bind","type",j);
 167                 std::string IP = Conf.ReadValue("bind","address",j);
 168                 if (Type == "servers")
 169                 {
 170                         if ((IP != "*") && (IP != "127.0.0.1") && (IP != ""))
 171                         {
 172                                 insp_sockaddr s;
 173
 174                                 if (insp_aton(IP.c_str(),&n) > 0)
 175                                 {
 176                                         log(DEBUG,"Found an IP to bind to: %s",IP.c_str());
 177 #ifdef IPV6
 178                                         s.sin6_addr = n;
 179                                         s.sin6_family = AF_FAMILY;
 180 #else
 181                                         s.sin_addr = n;
 182                                         s.sin_family = AF_FAMILY;
 183 #endif
 184                                         if (bind(this->fd,(struct sockaddr*)&s,sizeof(s)) < 0)
 185                                         {
 186                                                 log(DEBUG,"Cant bind()");
 187                                                 this->state = I_ERROR;
 188                                                 this->OnError(I_ERR_BIND);
 189                                                 this->fd = -1;
 190                                                 return false;
 191                                         }
 192                                         log(DEBUG,"bind() reports outbound fd bound to ip %s",IP.c_str());
 193                                         return true;
 194                                 }
 195                                 else
 196                                 {
 197                                         log(DEBUG,"Address '%s' was not an IP address",IP.c_str());
 198                                 }
 199                         }
 200                 }
 201         }
 202         log(DEBUG,"Found no suitable IPs to bind, binding INADDR_ANY");
 203         return true;
 204 }
 205
 206 bool InspSocket::DoConnect()
 207 {
 208         log(DEBUG,"In DoConnect()");
 209         if ((this->fd = socket(AF_FAMILY, SOCK_STREAM, 0)) == -1)
 210         {
 211                 log(DEBUG,"Cant socket()");
 212                 this->state = I_ERROR;
 213                 this->OnError(I_ERR_SOCKET);
 214                 this->fd = -1;
 215                 return false;
 216         }
 217
 218         if (!this->BindAddr())
 219                 return false;
 220
 221         log(DEBUG,"Part 2 DoConnect() %s",this->IP);
 222         insp_aton(this->IP,&addy);
 223 #ifdef IPV6
 224         addr.sin6_family = AF_FAMILY;
 225         memcpy(&addy, &addr.sin6_addr, sizeof(insp_inaddr));
 226         addr.sin6_port = htons(this->port);
 227 #else
 228         addr.sin_family = AF_FAMILY;
 229         addr.sin_addr = addy;
 230         addr.sin_port = htons(this->port);
 231 #endif
 232
 233         int flags;
 234         flags = fcntl(this->fd, F_GETFL, 0);
 235         fcntl(this->fd, F_SETFL, flags | O_NONBLOCK);
 236
 237         if (connect(this->fd, (sockaddr*)&this->addr,sizeof(this->addr)) == -1)
 238         {
 239                 if (errno != EINPROGRESS)
 240                 {
 241                         log(DEBUG,"Error connect() %d: %s",this->fd,strerror(errno));
 242                         this->OnError(I_ERR_CONNECT);
 243                         this->Close();
 244                         this->state = I_ERROR;
 245                         this->fd = -1;
 246                         this->ClosePending = true;
 247                         return false;
 248                 }
 249         }
 250         this->state = I_CONNECTING;
 251         if (this->fd > -1)
 252         {
 253                 ServerInstance->SE->AddFd(this->fd,false,X_ESTAB_MODULE);
 254                 socket_ref[this->fd] = this;
 255                 this->SetQueues(this->fd);
 256         }
 257         log(DEBUG,"Returning true from InspSocket::DoConnect");
 258         return true;
 259 }
 260
 261
 262 void InspSocket::Close()
 263 {
 264         if (this->fd != -1)
 265         {
 266                 this->OnClose();
 267                 shutdown(this->fd,2);
 268                 close(this->fd);
 269                 socket_ref[this->fd] = NULL;
 270                 this->ClosePending = true;
 271                 this->fd = -1;
 272         }
 273 }
 274
 275 std::string InspSocket::GetIP()
 276 {
 277         return this->IP;
 278 }
 279
 280 char* InspSocket::Read()
 281 {
 282         if ((fd < 0) || (fd > MAX_DESCRIPTORS))
 283                 return NULL;
 284         int n = recv(this->fd,this->ibuf,sizeof(this->ibuf),0);
 285         if ((n > 0) && (n <= (int)sizeof(this->ibuf)))
 286         {
 287                 ibuf[n] = 0;
 288                 return ibuf;
 289         }
 290         else
 291         {
 292                 if (errno == EAGAIN)
 293                 {
 294                         return "";
 295                 }
 296                 else
 297                 {
 298                         log(DEBUG,"EOF or error on socket: %s",strerror(errno));
 299                         return NULL;
 300                 }
 301         }
 302 }
 303
 304 void InspSocket::MarkAsClosed()
 305 {
 306         log(DEBUG,"Marked as closed");
 307         this->ClosePending = true;
 308 }
 309
 310 // There are two possible outcomes to this function.
 311 // It will either write all of the data, or an undefined amount.
 312 // If an undefined amount is written the connection has failed
 313 // and should be aborted.
 314 int InspSocket::Write(const std::string &data)
 315 {
 316         if (this->ClosePending)
 317                 return false;
 318
 319         /*int result = write(this->fd,data.c_str(),data.length());
 320         if (result < 1)
 321                 return false;
 322         return true;*/
 323
 324         /* Try and append the data to the back of the queue, and send it on its way
 325          */
 326         outbuffer.push_back(data);
 327         return (!this->FlushWriteBuffer());
 328 }
 329
 330 bool InspSocket::FlushWriteBuffer()
 331 {
 332         if (this->ClosePending)
 333                 return true;
 334
 335         if ((this->fd > -1) && (this->state == I_CONNECTED))
 336         {
 337                 if (outbuffer.size())
 338                 {
 339                         int result = write(this->fd,outbuffer[0].c_str(),outbuffer[0].length());
 340                         if (result > 0)
 341                         {
 342                                 if ((unsigned int)result == outbuffer[0].length())
 343                                 {
 344                                         /* The whole block was written (usually a line)
 345                                          * Pop the block off the front of the queue
 346                                          */
 347                                         outbuffer.pop_front();
 348                                 }
 349                                 else
 350                                 {
 351                                         std::string temp = outbuffer[0].substr(result);
 352                                         outbuffer[0] = temp;
 353                                 }
 354                         }
 355                         else if ((result == -1) && (errno != EAGAIN))
 356                         {
 357                                 log(DEBUG,"Write error on socket: %s",strerror(errno));
 358                                 this->OnError(I_ERR_WRITE);
 359                                 this->state = I_ERROR;
 360                                 this->ClosePending = true;
 361                                 return true;
 362                         }
 363                 }
 364         }
 365         return (fd < 0);
 366 }
 367
 368 bool InspSocket::Timeout(time_t current)
 369 {
 370         if (!socket_ref[this->fd] || !ServerInstance->SE->HasFd(this->fd))
 371         {
 372                 log(DEBUG,"No FD or socket ref");
 373                 return false;
 374         }
 375
 376         if (this->ClosePending)
 377         {
 378                 log(DEBUG,"Close is pending");
 379                 return true;
 380         }
 381
 382         if ((this->state == I_CONNECTING) && (current > timeout_end))
 383         {
 384                 log(DEBUG,"Timed out, current=%lu timeout_end=%lu");
 385                 // for non-listening sockets, the timeout can occur
 386                 // which causes termination of the connection after
 387                 // the given number of seconds without a successful
 388                 // connection.
 389                 this->OnTimeout();
 390                 this->OnError(I_ERR_TIMEOUT);
 391                 timeout = true;
 392                 this->state = I_ERROR;
 393                 this->ClosePending = true;
 394                 return true;
 395         }
 396         return this->FlushWriteBuffer();
 397 }
 398
 399 bool InspSocket::Poll()
 400 {
 401         if (!socket_ref[this->fd] || !ServerInstance->SE->HasFd(this->fd))
 402                 return false;
 403
 404         int incoming = -1;
 405         bool n = true;
 406
 407         if ((fd < 0) || (fd > MAX_DESCRIPTORS) || (this->ClosePending))
 408                 return false;
 409
 410         switch (this->state)
 411         {
 412                 case I_CONNECTING:
 413                         log(DEBUG,"State = I_CONNECTING");
 414                         this->SetState(I_CONNECTED);
 415                         /* Our socket was in write-state, so delete it and re-add it
 416                          * in read-state.
 417                          */
 418                         if (this->fd > -1)
 419                         {
 420                                 ServerInstance->SE->DelFd(this->fd);
 421                                 ServerInstance->SE->AddFd(this->fd,true,X_ESTAB_MODULE);
 422                         }
 423                         return this->OnConnected();
 424                 break;
 425                 case I_LISTENING:
 426                         length = sizeof (client);
 427                         incoming = accept (this->fd, (sockaddr*)&client,&length);
 428                         this->SetQueues(incoming);
 429 #ifdef IPV6
 430                         this->OnIncomingConnection(incoming,(char*)insp_ntoa(client.sin6_addr));
 431 #else
 432                         this->OnIncomingConnection(incoming,(char*)insp_ntoa(client.sin_addr));
 433 #endif
 434                         return true;
 435                 break;
 436                 case I_CONNECTED:
 437
 438                         if (this->WaitingForWriteEvent)
 439                         {
 440                                 /* Switch back to read events */
 441                                 ServerInstance->SE->DelFd(this->fd);
 442                                 ServerInstance->SE->AddFd(this->fd,true,X_ESTAB_MODULE);
 443                                 /* Trigger the write event */
 444                                 n = this->OnWriteReady();
 445                         }
 446                         else
 447                         {
 448                                 /* Process the read event */
 449                                 n = this->OnDataReady();
 450                         }
 451                         /* Flush any pending, but not till after theyre done with the event
 452                          * so there are less write calls involved.
 453                          * Both FlushWriteBuffer AND the return result of OnDataReady must
 454                          * return true for this to be ok.
 455                          */
 456                         if (this->FlushWriteBuffer())
 457                                 return false;
 458                         return n;
 459                 break;
 460                 default:
 461                 break;
 462         }
 463         return true;
 464 }
 465
 466 void InspSocket::SetState(InspSocketState s)
 467 {
 468         log(DEBUG,"Socket state change");
 469         this->state = s;
 470 }
 471
 472 InspSocketState InspSocket::GetState()
 473 {
 474         return this->state;
 475 }
 476
 477 int InspSocket::GetFd()
 478 {
 479         return this->fd;
 480 }
 481
 482 bool InspSocket::OnConnected() { return true; }
 483 void InspSocket::OnError(InspSocketError e) { return; }
 484 int InspSocket::OnDisconnect() { return 0; }
 485 int InspSocket::OnIncomingConnection(int newfd, char* ip) { return 0; }
 486 bool InspSocket::OnDataReady() { return true; }
 487 bool InspSocket::OnWriteReady() { return true; }
 488 void InspSocket::OnTimeout() { return; }
 489 void InspSocket::OnClose() { return; }
 490
 491 InspSocket::~InspSocket()
 492 {
 493         this->Close();
 494 }