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 "socket.h"
  18 #include "configreader.h"
  19 #include "inspstring.h"
  20 #include "socketengine.h"
  21 #include "inspircd.h"
  22
  23 using irc::sockets::OpenTCPSocket;
  24 using irc::sockets::insp_inaddr;
  25 using irc::sockets::insp_sockaddr;
  26
  27 bool InspSocket::Readable()
  28 {
  29         return ((this->state != I_CONNECTING) && (this->WaitingForWriteEvent == false));
  30 }
  31
  32 InspSocket::InspSocket(InspIRCd* SI)
  33 {
  34         this->state = I_DISCONNECTED;
  35         this->fd = -1;
  36         this->WaitingForWriteEvent = false;
  37         this->Instance = SI;
  38         this->IsIOHooked = false;
  39 }
  40
  41 InspSocket::InspSocket(InspIRCd* SI, int newfd, const char* ip)
  42 {
  43         this->fd = newfd;
  44         this->state = I_CONNECTED;
  45         strlcpy(this->IP,ip,MAXBUF);
  46         this->WaitingForWriteEvent = false;
  47         this->Instance = SI;
  48         this->IsIOHooked = false;
  49         if (this->fd > -1)
  50                 this->Instance->SE->AddFd(this);
  51 }
  52
  53 InspSocket::InspSocket(InspIRCd* SI, const std::string &ipaddr, int aport, bool listening, unsigned long maxtime)
  54 {
  55         this->fd = -1;
  56         this->Instance = SI;
  57         strlcpy(host,ipaddr.c_str(),MAXBUF);
  58         this->WaitingForWriteEvent = false;
  59         this->IsIOHooked = false;
  60         if (listening)
  61         {
  62                 if ((this->fd = OpenTCPSocket()) == ERROR)
  63                 {
  64                         this->fd = -1;
  65                         this->state = I_ERROR;
  66                         this->OnError(I_ERR_SOCKET);
  67                         this->Instance->Log(DEBUG,"OpenTCPSocket() error");
  68                         return;
  69                 }
  70                 else
  71                 {
  72                         if (!SI->BindSocket(this->fd,this->client,this->server,aport,(char*)ipaddr.c_str()))
  73                         {
  74                                 this->Instance->Log(DEBUG,"BindSocket() error %s",strerror(errno));
  75                                 this->Close();
  76                                 this->fd = -1;
  77                                 this->state = I_ERROR;
  78                                 this->OnError(I_ERR_BIND);
  79                                 this->ClosePending = true;
  80                                 return;
  81                         }
  82                         else
  83                         {
  84                                 this->state = I_LISTENING;
  85                                 if (this->fd > -1)
  86                                 {
  87                                         if (!this->Instance->SE->AddFd(this))
  88                                         {
  89                                                 this->Close();
  90                                                 this->state = I_ERROR;
  91                                                 this->OnError(I_ERR_NOMOREFDS);
  92                                         }
  93                                 }
  94                                 this->Instance->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                         this->Instance->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                         return;
 112                 }
 113                 else
 114                 {
 115                         this->Instance->Log(DEBUG,"No need to resolve %s",this->host);
 116                         strlcpy(this->IP,host,MAXBUF);
 117                         timeout_val = maxtime;
 118                         this->DoConnect();
 119                 }
 120         }
 121 }
 122
 123 void InspSocket::WantWrite()
 124 {
 125         this->Instance->SE->WantWrite(this);
 126         this->WaitingForWriteEvent = true;
 127 }
 128
 129 void InspSocket::SetQueues(int nfd)
 130 {
 131         // attempt to increase socket sendq and recvq as high as its possible
 132         int sendbuf = 32768;
 133         int recvbuf = 32768;
 134         setsockopt(nfd,SOL_SOCKET,SO_SNDBUF,(const void *)&sendbuf,sizeof(sendbuf));
 135         setsockopt(nfd,SOL_SOCKET,SO_RCVBUF,(const void *)&recvbuf,sizeof(sendbuf));
 136 }
 137
 138 /* Most irc servers require you to specify the ip you want to bind to.
 139  * If you dont specify an IP, they rather dumbly bind to the first IP
 140  * of the box (e.g. INADDR_ANY). In InspIRCd, we scan thought the IP
 141  * addresses we've bound server ports to, and we try and bind our outbound
 142  * connections to the first usable non-loopback and non-any IP we find.
 143  * This is easier to configure when you have a lot of links and a lot
 144  * of servers to configure.
 145  */
 146 bool InspSocket::BindAddr()
 147 {
 148         insp_inaddr n;
 149         ConfigReader Conf(this->Instance);
 150
 151         this->Instance->Log(DEBUG,"In InspSocket::BindAddr()");
 152         for (int j =0; j < Conf.Enumerate("bind"); j++)
 153         {
 154                 std::string Type = Conf.ReadValue("bind","type",j);
 155                 std::string IP = Conf.ReadValue("bind","address",j);
 156                 if (Type == "servers")
 157                 {
 158                         if ((IP != "*") && (IP != "127.0.0.1") && (IP != ""))
 159                         {
 160                                 insp_sockaddr s;
 161
 162                                 if (insp_aton(IP.c_str(),&n) > 0)
 163                                 {
 164                                         this->Instance->Log(DEBUG,"Found an IP to bind to: %s",IP.c_str());
 165 #ifdef IPV6
 166                                         s.sin6_addr = n;
 167                                         s.sin6_family = AF_FAMILY;
 168 #else
 169                                         s.sin_addr = n;
 170                                         s.sin_family = AF_FAMILY;
 171 #endif
 172                                         if (bind(this->fd,(struct sockaddr*)&s,sizeof(s)) < 0)
 173                                         {
 174                                                 this->Instance->Log(DEBUG,"Cant bind()");
 175                                                 this->state = I_ERROR;
 176                                                 this->OnError(I_ERR_BIND);
 177                                                 this->fd = -1;
 178                                                 return false;
 179                                         }
 180                                         this->Instance->Log(DEBUG,"bind() reports outbound fd bound to ip %s",IP.c_str());
 181                                         return true;
 182                                 }
 183                                 else
 184                                 {
 185                                         this->Instance->Log(DEBUG,"Address '%s' was not an IP address",IP.c_str());
 186                                 }
 187                         }
 188                 }
 189         }
 190         this->Instance->Log(DEBUG,"Found no suitable IPs to bind, binding INADDR_ANY");
 191         return true;
 192 }
 193
 194 bool InspSocket::DoConnect()
 195 {
 196         this->Instance->Log(DEBUG,"In DoConnect()");
 197         if ((this->fd = socket(AF_FAMILY, SOCK_STREAM, 0)) == -1)
 198         {
 199                 this->Instance->Log(DEBUG,"Cant socket()");
 200                 this->state = I_ERROR;
 201                 this->OnError(I_ERR_SOCKET);
 202                 return false;
 203         }
 204
 205         if ((strstr(this->IP,"::ffff:") != (char*)&this->IP) && (strstr(this->IP,"::FFFF:") != (char*)&this->IP))
 206         {
 207                 if (!this->BindAddr())
 208                         return false;
 209         }
 210
 211         this->Instance->Log(DEBUG,"Part 2 DoConnect() %s",this->IP);
 212         insp_aton(this->IP,&addy);
 213 #ifdef IPV6
 214         addr.sin6_family = AF_FAMILY;
 215         memcpy(&addr.sin6_addr, &addy, sizeof(insp_inaddr));
 216         addr.sin6_port = htons(this->port);
 217 #else
 218         addr.sin_family = AF_FAMILY;
 219         addr.sin_addr = addy;
 220         addr.sin_port = htons(this->port);
 221 #endif
 222
 223         int flags;
 224         flags = fcntl(this->fd, F_GETFL, 0);
 225         fcntl(this->fd, F_SETFL, flags | O_NONBLOCK);
 226
 227         if (connect(this->fd, (sockaddr*)&this->addr,sizeof(this->addr)) == -1)
 228         {
 229                 if (errno != EINPROGRESS)
 230                 {
 231                         this->Instance->Log(DEBUG,"Error connect() %d: %s",this->fd,strerror(errno));
 232                         this->OnError(I_ERR_CONNECT);
 233                         this->Close();
 234                         this->state = I_ERROR;
 235                         return false;
 236                 }
 237
 238                 this->Timeout = new SocketTimeout(this->GetFd(), this->Instance, this, timeout_val, this->Instance->Time());
 239                 this->Instance->Timers->AddTimer(this->Timeout);
 240         }
 241         this->state = I_CONNECTING;
 242         if (this->fd > -1)
 243         {
 244                 if (!this->Instance->SE->AddFd(this))
 245                 {
 246                         this->OnError(I_ERR_NOMOREFDS);
 247                         this->Close();
 248                         this->state = I_ERROR;
 249                         return false;
 250                 }
 251                 this->SetQueues(this->fd);
 252         }
 253         this->Instance->Log(DEBUG,"Returning true from InspSocket::DoConnect");
 254         return true;
 255 }
 256
 257
 258 void InspSocket::Close()
 259 {
 260         if (this->fd > -1)
 261         {
 262                 if (this->IsIOHooked && Instance->Config->GetIOHook(this))
 263                 {
 264                         try
 265                         {
 266                                 Instance->Config->GetIOHook(this)->OnRawSocketClose(this->fd);
 267                         }
 268                         catch (ModuleException& modexcept)
 269                         {
 270                                 Instance->Log(DEBUG,"Module exception cought: %s",modexcept.GetReason());
 271                         }
 272                 }
 273                 this->OnClose();
 274                 shutdown(this->fd,2);
 275                 close(this->fd);
 276         }
 277 }
 278
 279 std::string InspSocket::GetIP()
 280 {
 281         return this->IP;
 282 }
 283
 284 char* InspSocket::Read()
 285 {
 286         if ((fd < 0) || (fd > MAX_DESCRIPTORS))
 287                 return NULL;
 288
 289         int n = 0;
 290
 291         if (this->IsIOHooked)
 292         {
 293                 int result2 = 0;
 294                 int MOD_RESULT = 0;
 295                 try
 296                 {
 297                         MOD_RESULT = Instance->Config->GetIOHook(this)->OnRawSocketRead(this->fd,this->ibuf,sizeof(this->ibuf),result2);
 298                 }
 299                 catch (ModuleException& modexcept)
 300                 {
 301                         Instance->Log(DEBUG,"Module exception caught: %s",modexcept.GetReason());
 302                 }
 303                 if (MOD_RESULT < 0)
 304                 {
 305                         n = -1;
 306                         errno = EAGAIN;
 307                 }
 308                 else
 309                 {
 310                         n = result2;
 311                 }
 312         }
 313         else
 314         {
 315                 n = recv(this->fd,this->ibuf,sizeof(this->ibuf),0);
 316         }
 317
 318         if ((n > 0) && (n <= (int)sizeof(this->ibuf)))
 319         {
 320                 ibuf[n] = 0;
 321                 return ibuf;
 322         }
 323         else
 324         {
 325                 int err = errno;
 326                 if (err == EAGAIN)
 327                 {
 328                         return "";
 329                 }
 330                 else
 331                 {
 332                         if (!n)
 333                                 this->Instance->Log(DEBUG,"EOF or error on socket: EOF");
 334                         else
 335                                 this->Instance->Log(DEBUG,"EOF or error on socket: %s",strerror(err));
 336                         return NULL;
 337                 }
 338         }
 339 }
 340
 341 void InspSocket::MarkAsClosed()
 342 {
 343         this->Instance->Log(DEBUG,"Marked as closed");
 344 }
 345
 346 // There are two possible outcomes to this function.
 347 // It will either write all of the data, or an undefined amount.
 348 // If an undefined amount is written the connection has failed
 349 // and should be aborted.
 350 int InspSocket::Write(const std::string &data)
 351 {
 352         /* Try and append the data to the back of the queue, and send it on its way
 353          */
 354         outbuffer.push_back(data);
 355         this->Instance->SE->WantWrite(this);
 356         return (!this->FlushWriteBuffer());
 357 }
 358
 359 bool InspSocket::FlushWriteBuffer()
 360 {
 361         errno = 0;
 362         if ((this->fd > -1) && (this->state == I_CONNECTED))
 363         {
 364                 if (this->IsIOHooked)
 365                 {
 366                         while (outbuffer.size() && (errno != EAGAIN))
 367                         {
 368                                 try
 369                                 {
 370                                         Instance->Log(DEBUG,"To write: %s", outbuffer[0].c_str());
 371                                         int result = Instance->Config->GetIOHook(this)->OnRawSocketWrite(this->fd, outbuffer[0].c_str(), outbuffer[0].length());
 372                                         if (result > 0)
 373                                         {
 374                                                 if ((unsigned int)result == outbuffer[0].length())
 375                                                 {
 376                                                         outbuffer.pop_front();
 377                                                 }
 378                                                 else
 379                                                 {
 380                                                         std::string temp = outbuffer[0].substr(result);
 381                                                         outbuffer[0] = temp;
 382                                                         errno = EAGAIN;
 383                                                 }
 384                                         }
 385                                         else if ((result == -1) && (errno != EAGAIN))
 386                                         {
 387                                                 this->Instance->Log(DEBUG,"Write error on socket: %s",strerror(errno));
 388                                                 this->OnError(I_ERR_WRITE);
 389                                                 this->state = I_ERROR;
 390                                                 this->Instance->SE->DelFd(this);
 391                                                 this->Close();
 392                                                 return true;
 393                                         }
 394                                 }
 395                                 catch (ModuleException& modexcept)
 396                                 {
 397                                         Instance->Log(DEBUG,"Module exception caught: %s",modexcept.GetReason());
 398                                         return true;
 399                                 }
 400                         }
 401                 }
 402                 else
 403                 {
 404                         /* If we have multiple lines, try to send them all,
 405                          * not just the first one -- Brain
 406                          */
 407                         while (outbuffer.size() && (errno != EAGAIN))
 408                         {
 409                                 /* Send a line */
 410                                 int result = write(this->fd,outbuffer[0].c_str(),outbuffer[0].length());
 411                                 if (result > 0)
 412                                 {
 413                                         if ((unsigned int)result == outbuffer[0].length())
 414                                         {
 415                                                 /* The whole block was written (usually a line)
 416                                                  * Pop the block off the front of the queue,
 417                                                  * dont set errno, because we are clear of errors
 418                                                  * and want to try and write the next block too.
 419                                                  */
 420                                                 outbuffer.pop_front();
 421                                         }
 422                                         else
 423                                         {
 424                                                 std::string temp = outbuffer[0].substr(result);
 425                                                 outbuffer[0] = temp;
 426                                                 /* We didnt get the whole line out. arses.
 427                                                  * Try again next time, i guess. Set errno,
 428                                                  * because we shouldnt be writing any more now,
 429                                                  * until the socketengine says its safe to do so.
 430                                                  */
 431                                                 errno = EAGAIN;
 432                                         }
 433                                 }
 434                                 else if ((result == -1) && (errno != EAGAIN))
 435                                 {
 436                                         this->Instance->Log(DEBUG,"Write error on socket: %s",strerror(errno));
 437                                         this->OnError(I_ERR_WRITE);
 438                                         this->state = I_ERROR;
 439                                         this->Instance->SE->DelFd(this);
 440                                         this->Close();
 441                                         return true;
 442                                 }
 443                         }
 444                 }
 445         }
 446
 447         if ((errno == EAGAIN) && (fd > -1))
 448         {
 449                 this->Instance->SE->WantWrite(this);
 450         }
 451
 452         return (fd < 0);
 453 }
 454
 455 void SocketTimeout::Tick(time_t now)
 456 {
 457         if (ServerInstance->SE->GetRef(this->sfd) != this->sock)
 458         {
 459                 ServerInstance->Log(DEBUG,"Our socket has been deleted before the timeout was reached.");
 460                 return;
 461         }
 462
 463         if (this->sock->state == I_CONNECTING)
 464         {
 465                 ServerInstance->Log(DEBUG,"Timed out, current=%lu",now);
 466                 // for non-listening sockets, the timeout can occur
 467                 // which causes termination of the connection after
 468                 // the given number of seconds without a successful
 469                 // connection.
 470                 this->sock->OnTimeout();
 471                 this->sock->OnError(I_ERR_TIMEOUT);
 472                 this->sock->timeout = true;
 473                 ServerInstance->SE->DelFd(this->sock);
 474                 /* NOTE: We must set this AFTER DelFd, as we added
 475                  * this socket whilst writeable. This means that we
 476                  * must DELETE the socket whilst writeable too!
 477                  */
 478                 this->sock->state = I_ERROR;
 479                 this->sock->Close();
 480                 delete this->sock;
 481                 return;
 482         }
 483 }
 484
 485 bool InspSocket::Poll()
 486 {
 487         if (this->Instance->SE->GetRef(this->fd) != this)
 488                 return false;
 489
 490         int incoming = -1;
 491
 492         if ((fd < 0) || (fd > MAX_DESCRIPTORS))
 493                 return false;
 494
 495         switch (this->state)
 496         {
 497                 case I_CONNECTING:
 498                         this->Instance->Log(DEBUG,"State = I_CONNECTING");
 499                         /* Our socket was in write-state, so delete it and re-add it
 500                          * in read-state.
 501                          */
 502                         if (this->fd > -1)
 503                         {
 504                                 this->Instance->SE->DelFd(this);
 505                                 this->SetState(I_CONNECTED);
 506                                 if (!this->Instance->SE->AddFd(this))
 507                                         return false;
 508                         }
 509                         if (this->IsIOHooked)
 510                         {
 511                                 try
 512                                 {
 513                                         Instance->Config->GetIOHook(this)->OnRawSocketConnect(this->fd);
 514                                 }
 515                                 catch (ModuleException& modexcept)
 516                                 {
 517                                         Instance->Log(DEBUG,"Module exception cought: %s",modexcept.GetReason());
 518                                 }
 519                         }
 520                         return this->OnConnected();
 521                 break;
 522                 case I_LISTENING:
 523                         length = sizeof (client);
 524                         incoming = accept (this->fd, (sockaddr*)&client,&length);
 525
 526 #ifdef IPV6
 527                         this->OnIncomingConnection(incoming, (char*)insp_ntoa(client.sin6_addr));
 528 #else
 529                         this->OnIncomingConnection(incoming, (char*)insp_ntoa(client.sin_addr));
 530 #endif
 531
 532                         if (this->IsIOHooked)
 533                         {
 534                                 try
 535                                 {
 536 #ifdef IPV6
 537                                         Instance->Config->GetIOHook(this)->OnRawSocketAccept(incoming, insp_ntoa(client.sin6_addr), this->port);
 538 #else
 539                                         Instance->Config->GetIOHook(this)->OnRawSocketAccept(incoming, insp_ntoa(client.sin_addr), this->port);
 540 #endif
 541                                 }
 542                                 catch (ModuleException& modexcept)
 543                                 {
 544                                         Instance->Log(DEBUG,"Module exception cought: %s",modexcept.GetReason());
 545                                 }
 546                         }
 547
 548                         this->SetQueues(incoming);
 549                         return true;
 550                 break;
 551                 case I_CONNECTED:
 552                         /* Process the read event */
 553                         return this->OnDataReady();
 554                 break;
 555                 default:
 556                 break;
 557         }
 558         return true;
 559 }
 560
 561 void InspSocket::SetState(InspSocketState s)
 562 {
 563         this->Instance->Log(DEBUG,"Socket state change");
 564         this->state = s;
 565 }
 566
 567 InspSocketState InspSocket::GetState()
 568 {
 569         return this->state;
 570 }
 571
 572 int InspSocket::GetFd()
 573 {
 574         return this->fd;
 575 }
 576
 577 bool InspSocket::OnConnected() { return true; }
 578 void InspSocket::OnError(InspSocketError e) { return; }
 579 int InspSocket::OnDisconnect() { return 0; }
 580 int InspSocket::OnIncomingConnection(int newfd, char* ip) { return 0; }
 581 bool InspSocket::OnDataReady() { return true; }
 582 bool InspSocket::OnWriteReady() { return true; }
 583 void InspSocket::OnTimeout() { return; }
 584 void InspSocket::OnClose() { return; }
 585
 586 InspSocket::~InspSocket()
 587 {
 588         this->Close();
 589 }
 590
 591 void InspSocket::HandleEvent(EventType et, int errornum)
 592 {
 593         switch (et)
 594         {
 595                 case EVENT_ERROR:
 596                         this->Instance->SE->DelFd(this);
 597                         this->Close();
 598                         delete this;
 599                         return;
 600                 break;
 601                 case EVENT_READ:
 602                         if (!this->Poll())
 603                         {
 604                                 this->Instance->SE->DelFd(this);
 605                                 this->Close();
 606                                 delete this;
 607                                 return;
 608                         }
 609                 break;
 610                 case EVENT_WRITE:
 611                         if (this->WaitingForWriteEvent)
 612                         {
 613                                 this->WaitingForWriteEvent = false;
 614                                 if (!this->OnWriteReady())
 615                                 {
 616                                         this->Instance->SE->DelFd(this);
 617                                         this->Close();
 618                                         delete this;
 619                                         return;
 620                                 }
 621                         }
 622                         if (this->state == I_CONNECTING)
 623                         {
 624                                 /* This might look wrong as if we should be actually calling
 625                                  * with EVENT_WRITE, but trust me it is correct. There are some
 626                                  * writeability-state things in the read code, because of how
 627                                  * InspSocket used to work regarding write buffering in previous
 628                                  * versions of InspIRCd. - Brain
 629                                  */
 630                                 this->HandleEvent(EVENT_READ);
 631                                 return;
 632                         }
 633                         else
 634                         {
 635                                 Instance->Log(DEBUG,"State=%d CONNECTED=%d", this->state, I_CONNECTED);
 636                                 if (this->FlushWriteBuffer())
 637                                 {
 638                                         this->Instance->SE->DelFd(this);
 639                                         this->Close();
 640                                         delete this;
 641                                         return;
 642                                 }
 643                         }
 644                 break;
 645         }
 646 }
 647