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