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 &ahost, int aport, bool listening, unsigned long maxtime) : fd(-1)
  61 {
  62         strlcpy(host,ahost.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*)ahost.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,ahost.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                                 char resolved_addr[MAXBUF];
 174
 175                                 if (insp_aton(IP.c_str(),&n) < 1)
 176                                 {
 177                                         /* If they gave a hostname, bind to the IP it resolves to */
 178                                         log(DEBUG,"Resolving host %s",IP.c_str());
 179                                         if (CleanAndResolve(resolved_addr, IP.c_str(), true, 1))
 180                                         {
 181                                                 log(DEBUG,"Resolved host %s to %s",IP.c_str(),resolved_addr);
 182                                                 IP = resolved_addr;
 183                                         }
 184                                 }
 185
 186                                 if (insp_aton(IP.c_str(),&n) > 0)
 187                                 {
 188                                         log(DEBUG,"Found an IP to bind to: %s",IP.c_str());
 189 #ifdef IPV6
 190                                         s.sin6_addr = n;
 191                                         s.sin6_family = AF_FAMILY;
 192 #else
 193                                         s.sin_addr = n;
 194                                         s.sin_family = AF_FAMILY;
 195 #endif
 196                                         if (bind(this->fd,(struct sockaddr*)&s,sizeof(s)) < 0)
 197                                         {
 198                                                 log(DEBUG,"Cant bind()");
 199                                                 this->state = I_ERROR;
 200                                                 this->OnError(I_ERR_BIND);
 201                                                 this->fd = -1;
 202                                                 return false;
 203                                         }
 204                                         log(DEBUG,"bind() reports outbound fd bound to ip %s",IP.c_str());
 205                                         return true;
 206                                 }
 207                                 else
 208                                 {
 209                                         log(DEBUG,"Address '%s' was not an IP address",IP.c_str());
 210                                 }
 211                         }
 212                 }
 213         }
 214         log(DEBUG,"Found no suitable IPs to bind, binding INADDR_ANY");
 215         return true;
 216 }
 217
 218 bool InspSocket::DoConnect()
 219 {
 220         log(DEBUG,"In DoConnect()");
 221         if ((this->fd = socket(AF_FAMILY, SOCK_STREAM, 0)) == -1)
 222         {
 223                 log(DEBUG,"Cant socket()");
 224                 this->state = I_ERROR;
 225                 this->OnError(I_ERR_SOCKET);
 226                 this->fd = -1;
 227                 return false;
 228         }
 229
 230         if (!this->BindAddr())
 231                 return false;
 232
 233         log(DEBUG,"Part 2 DoConnect() %s",this->IP);
 234         insp_aton(this->IP,&addy);
 235 #ifdef IPV6
 236         addr.sin6_family = AF_FAMILY;
 237         memcpy(&addy, &addr.sin6_addr, sizeof(insp_inaddr));
 238         addr.sin6_port = htons(this->port);
 239 #else
 240         addr.sin_family = AF_FAMILY;
 241         addr.sin_addr = addy;
 242         addr.sin_port = htons(this->port);
 243 #endif
 244
 245         int flags;
 246         flags = fcntl(this->fd, F_GETFL, 0);
 247         fcntl(this->fd, F_SETFL, flags | O_NONBLOCK);
 248
 249         if (connect(this->fd, (sockaddr*)&this->addr,sizeof(this->addr)) == -1)
 250         {
 251                 if (errno != EINPROGRESS)
 252                 {
 253                         log(DEBUG,"Error connect() %d: %s",this->fd,strerror(errno));
 254                         this->OnError(I_ERR_CONNECT);
 255                         this->Close();
 256                         this->state = I_ERROR;
 257                         this->fd = -1;
 258                         this->ClosePending = true;
 259                         return false;
 260                 }
 261         }
 262         this->state = I_CONNECTING;
 263         if (this->fd > -1)
 264         {
 265                 ServerInstance->SE->AddFd(this->fd,false,X_ESTAB_MODULE);
 266                 socket_ref[this->fd] = this;
 267                 this->SetQueues(this->fd);
 268         }
 269         log(DEBUG,"Returning true from InspSocket::DoConnect");
 270         return true;
 271 }
 272
 273
 274 void InspSocket::Close()
 275 {
 276         if (this->fd != -1)
 277         {
 278                 this->OnClose();
 279                 shutdown(this->fd,2);
 280                 close(this->fd);
 281                 socket_ref[this->fd] = NULL;
 282                 this->ClosePending = true;
 283                 this->fd = -1;
 284         }
 285 }
 286
 287 std::string InspSocket::GetIP()
 288 {
 289         return this->IP;
 290 }
 291
 292 char* InspSocket::Read()
 293 {
 294         if ((fd < 0) || (fd > MAX_DESCRIPTORS))
 295                 return NULL;
 296         int n = recv(this->fd,this->ibuf,sizeof(this->ibuf),0);
 297         if ((n > 0) && (n <= (int)sizeof(this->ibuf)))
 298         {
 299                 ibuf[n] = 0;
 300                 return ibuf;
 301         }
 302         else
 303         {
 304                 if (errno == EAGAIN)
 305                 {
 306                         return "";
 307                 }
 308                 else
 309                 {
 310                         log(DEBUG,"EOF or error on socket: %s",strerror(errno));
 311                         return NULL;
 312                 }
 313         }
 314 }
 315
 316 void InspSocket::MarkAsClosed()
 317 {
 318         log(DEBUG,"Marked as closed");
 319         this->ClosePending = true;
 320 }
 321
 322 // There are two possible outcomes to this function.
 323 // It will either write all of the data, or an undefined amount.
 324 // If an undefined amount is written the connection has failed
 325 // and should be aborted.
 326 int InspSocket::Write(const std::string &data)
 327 {
 328         if (this->ClosePending)
 329                 return false;
 330
 331         /*int result = write(this->fd,data.c_str(),data.length());
 332         if (result < 1)
 333                 return false;
 334         return true;*/
 335
 336         /* Try and append the data to the back of the queue, and send it on its way
 337          */
 338         outbuffer.push_back(data);
 339         return (!this->FlushWriteBuffer());
 340 }
 341
 342 bool InspSocket::FlushWriteBuffer()
 343 {
 344         if (this->ClosePending)
 345                 return true;
 346
 347         if ((this->fd > -1) && (this->state == I_CONNECTED))
 348         {
 349                 if (outbuffer.size())
 350                 {
 351                         int result = write(this->fd,outbuffer[0].c_str(),outbuffer[0].length());
 352                         if (result > 0)
 353                         {
 354                                 if ((unsigned int)result == outbuffer[0].length())
 355                                 {
 356                                         /* The whole block was written (usually a line)
 357                                          * Pop the block off the front of the queue
 358                                          */
 359                                         outbuffer.pop_front();
 360                                 }
 361                                 else
 362                                 {
 363                                         std::string temp = outbuffer[0].substr(result);
 364                                         outbuffer[0] = temp;
 365                                 }
 366                         }
 367                         else if ((result == -1) && (errno != EAGAIN))
 368                         {
 369                                 log(DEBUG,"Write error on socket: %s",strerror(errno));
 370                                 this->OnError(I_ERR_WRITE);
 371                                 this->state = I_ERROR;
 372                                 this->ClosePending = true;
 373                                 return true;
 374                         }
 375                 }
 376         }
 377         return (fd < 0);
 378 }
 379
 380 bool InspSocket::Timeout(time_t current)
 381 {
 382         if (!socket_ref[this->fd] || !ServerInstance->SE->HasFd(this->fd))
 383         {
 384                 log(DEBUG,"No FD or socket ref");
 385                 return false;
 386         }
 387
 388         if (this->ClosePending)
 389         {
 390                 log(DEBUG,"Close is pending");
 391                 return true;
 392         }
 393
 394         if ((this->state == I_CONNECTING) && (current > timeout_end))
 395         {
 396                 log(DEBUG,"Timed out, current=%lu timeout_end=%lu");
 397                 // for non-listening sockets, the timeout can occur
 398                 // which causes termination of the connection after
 399                 // the given number of seconds without a successful
 400                 // connection.
 401                 this->OnTimeout();
 402                 this->OnError(I_ERR_TIMEOUT);
 403                 timeout = true;
 404                 this->state = I_ERROR;
 405                 this->ClosePending = true;
 406                 return true;
 407         }
 408         return this->FlushWriteBuffer();
 409 }
 410
 411 bool InspSocket::Poll()
 412 {
 413         if (!socket_ref[this->fd] || !ServerInstance->SE->HasFd(this->fd))
 414                 return false;
 415
 416         int incoming = -1;
 417         bool n = true;
 418
 419         if ((fd < 0) || (fd > MAX_DESCRIPTORS) || (this->ClosePending))
 420                 return false;
 421
 422         switch (this->state)
 423         {
 424                 case I_CONNECTING:
 425                         log(DEBUG,"State = I_CONNECTING");
 426                         this->SetState(I_CONNECTED);
 427                         /* Our socket was in write-state, so delete it and re-add it
 428                          * in read-state.
 429                          */
 430                         if (this->fd > -1)
 431                         {
 432                                 ServerInstance->SE->DelFd(this->fd);
 433                                 ServerInstance->SE->AddFd(this->fd,true,X_ESTAB_MODULE);
 434                         }
 435                         return this->OnConnected();
 436                 break;
 437                 case I_LISTENING:
 438                         length = sizeof (client);
 439                         incoming = accept (this->fd, (sockaddr*)&client,&length);
 440                         this->SetQueues(incoming);
 441 #ifdef IPV6
 442                         this->OnIncomingConnection(incoming,(char*)insp_ntoa(client.sin6_addr));
 443 #else
 444                         this->OnIncomingConnection(incoming,(char*)insp_ntoa(client.sin_addr));
 445 #endif
 446                         return true;
 447                 break;
 448                 case I_CONNECTED:
 449
 450                         if (this->WaitingForWriteEvent)
 451                         {
 452                                 /* Switch back to read events */
 453                                 ServerInstance->SE->DelFd(this->fd);
 454                                 ServerInstance->SE->AddFd(this->fd,true,X_ESTAB_MODULE);
 455                                 /* Trigger the write event */
 456                                 n = this->OnWriteReady();
 457                         }
 458                         else
 459                         {
 460                                 /* Process the read event */
 461                                 n = this->OnDataReady();
 462                         }
 463                         /* Flush any pending, but not till after theyre done with the event
 464                          * so there are less write calls involved.
 465                          * Both FlushWriteBuffer AND the return result of OnDataReady must
 466                          * return true for this to be ok.
 467                          */
 468                         if (this->FlushWriteBuffer())
 469                                 return false;
 470                         return n;
 471                 break;
 472                 default:
 473                 break;
 474         }
 475         return true;
 476 }
 477
 478 void InspSocket::SetState(InspSocketState s)
 479 {
 480         log(DEBUG,"Socket state change");
 481         this->state = s;
 482 }
 483
 484 InspSocketState InspSocket::GetState()
 485 {
 486         return this->state;
 487 }
 488
 489 int InspSocket::GetFd()
 490 {
 491         return this->fd;
 492 }
 493
 494 bool InspSocket::OnConnected() { return true; }
 495 void InspSocket::OnError(InspSocketError e) { return; }
 496 int InspSocket::OnDisconnect() { return 0; }
 497 int InspSocket::OnIncomingConnection(int newfd, char* ip) { return 0; }
 498 bool InspSocket::OnDataReady() { return true; }
 499 bool InspSocket::OnWriteReady() { return true; }
 500 void InspSocket::OnTimeout() { return; }
 501 void InspSocket::OnClose() { return; }
 502
 503 InspSocket::~InspSocket()
 504 {
 505         this->Close();
 506 }