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