1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
22 #include "inspircd_config.h"
24 #include "configreader.h"
25 #include "inspstring.h"
26 #include "socketengine.h"
29 using irc::sockets::OpenTCPSocket;
30 using irc::sockets::insp_inaddr;
31 using irc::sockets::insp_sockaddr;
33 bool InspSocket::Readable()
35 return ((this->state != I_CONNECTING) && (this->WaitingForWriteEvent == false));
38 InspSocket::InspSocket(InspIRCd* SI)
40 this->state = I_DISCONNECTED;
42 this->WaitingForWriteEvent = false;
43 this->ClosePending = false;
47 InspSocket::InspSocket(InspIRCd* SI, int newfd, const char* ip)
50 this->state = I_CONNECTED;
51 strlcpy(this->IP,ip,MAXBUF);
52 this->ClosePending = false;
53 this->WaitingForWriteEvent = false;
56 this->ClosePending = (!this->Instance->SE->AddFd(this));
59 InspSocket::InspSocket(InspIRCd* SI, const std::string &ipaddr, int aport, bool listening, unsigned long maxtime)
63 strlcpy(host,ipaddr.c_str(),MAXBUF);
64 this->ClosePending = false;
65 this->WaitingForWriteEvent = false;
68 if ((this->fd = OpenTCPSocket()) == ERROR)
71 this->state = I_ERROR;
72 this->OnError(I_ERR_SOCKET);
73 this->ClosePending = true;
74 this->Instance->Log(DEBUG,"OpenTCPSocket() error");
79 if (!SI->BindSocket(this->fd,this->client,this->server,aport,(char*)ipaddr.c_str()))
81 this->Instance->Log(DEBUG,"BindSocket() error %s",strerror(errno));
84 this->state = I_ERROR;
85 this->OnError(I_ERR_BIND);
86 this->ClosePending = true;
91 this->state = I_LISTENING;
94 if (!this->Instance->SE->AddFd(this))
97 this->state = I_ERROR;
98 this->OnError(I_ERR_NOMOREFDS);
99 this->ClosePending = true;
102 this->Instance->Log(DEBUG,"New socket now in I_LISTENING state");
109 strlcpy(this->host,ipaddr.c_str(),MAXBUF);
112 if (insp_aton(host,&addy) < 1)
114 this->Instance->Log(DEBUG,"You cannot pass hostnames to InspSocket, resolve them first with Resolver!");
117 this->state = I_ERROR;
118 this->OnError(I_ERR_RESOLVE);
119 this->ClosePending = true;
124 this->Instance->Log(DEBUG,"No need to resolve %s",this->host);
125 strlcpy(this->IP,host,MAXBUF);
126 timeout_end = time(NULL) + maxtime;
132 void InspSocket::WantWrite()
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
142 * This behaviour may be fixed in a later version.
144 this->Instance->SE->DelFd(this);
145 this->WaitingForWriteEvent = true;
146 if (!this->Instance->SE->AddFd(this))
150 this->state = I_ERROR;
151 this->OnError(I_ERR_NOMOREFDS);
152 this->ClosePending = true;
156 void InspSocket::SetQueues(int nfd)
158 // attempt to increase socket sendq and recvq as high as its possible
161 setsockopt(nfd,SOL_SOCKET,SO_SNDBUF,(const void *)&sendbuf,sizeof(sendbuf));
162 setsockopt(nfd,SOL_SOCKET,SO_RCVBUF,(const void *)&recvbuf,sizeof(sendbuf));
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.
173 bool InspSocket::BindAddr()
176 ConfigReader Conf(this->Instance);
178 this->Instance->Log(DEBUG,"In InspSocket::BindAddr()");
179 for (int j =0; j < Conf.Enumerate("bind"); j++)
181 std::string Type = Conf.ReadValue("bind","type",j);
182 std::string IP = Conf.ReadValue("bind","address",j);
183 if (Type == "servers")
185 if ((IP != "*") && (IP != "127.0.0.1") && (IP != ""))
189 if (insp_aton(IP.c_str(),&n) > 0)
191 this->Instance->Log(DEBUG,"Found an IP to bind to: %s",IP.c_str());
194 s.sin6_family = AF_FAMILY;
197 s.sin_family = AF_FAMILY;
199 if (bind(this->fd,(struct sockaddr*)&s,sizeof(s)) < 0)
201 this->Instance->Log(DEBUG,"Cant bind()");
202 this->state = I_ERROR;
203 this->OnError(I_ERR_BIND);
207 this->Instance->Log(DEBUG,"bind() reports outbound fd bound to ip %s",IP.c_str());
212 this->Instance->Log(DEBUG,"Address '%s' was not an IP address",IP.c_str());
217 this->Instance->Log(DEBUG,"Found no suitable IPs to bind, binding INADDR_ANY");
221 bool InspSocket::DoConnect()
223 this->Instance->Log(DEBUG,"In DoConnect()");
224 if ((this->fd = socket(AF_FAMILY, SOCK_STREAM, 0)) == -1)
226 this->Instance->Log(DEBUG,"Cant socket()");
227 this->state = I_ERROR;
228 this->OnError(I_ERR_SOCKET);
233 if ((strstr(this->IP,"::ffff:") != (char*)&this->IP) && (strstr(this->IP,"::FFFF:") != (char*)&this->IP))
235 if (!this->BindAddr())
239 this->Instance->Log(DEBUG,"Part 2 DoConnect() %s",this->IP);
240 insp_aton(this->IP,&addy);
242 addr.sin6_family = AF_FAMILY;
243 memcpy(&addr.sin6_addr, &addy, sizeof(insp_inaddr));
244 addr.sin6_port = htons(this->port);
246 addr.sin_family = AF_FAMILY;
247 addr.sin_addr = addy;
248 addr.sin_port = htons(this->port);
252 flags = fcntl(this->fd, F_GETFL, 0);
253 fcntl(this->fd, F_SETFL, flags | O_NONBLOCK);
255 if (connect(this->fd, (sockaddr*)&this->addr,sizeof(this->addr)) == -1)
257 if (errno != EINPROGRESS)
259 this->Instance->Log(DEBUG,"Error connect() %d: %s",this->fd,strerror(errno));
260 this->OnError(I_ERR_CONNECT);
262 this->state = I_ERROR;
264 this->ClosePending = true;
268 this->state = I_CONNECTING;
271 if (!this->Instance->SE->AddFd(this))
273 this->OnError(I_ERR_NOMOREFDS);
276 this->state = I_ERROR;
277 this->ClosePending = true;
280 this->SetQueues(this->fd);
282 this->Instance->Log(DEBUG,"Returning true from InspSocket::DoConnect");
287 void InspSocket::Close()
292 shutdown(this->fd,2);
294 this->ClosePending = true;
299 std::string InspSocket::GetIP()
304 char* InspSocket::Read()
306 if ((fd < 0) || (fd > MAX_DESCRIPTORS))
308 int n = recv(this->fd,this->ibuf,sizeof(this->ibuf),0);
309 if ((n > 0) && (n <= (int)sizeof(this->ibuf)))
322 this->Instance->Log(DEBUG,"EOF or error on socket: %s",strerror(errno));
328 void InspSocket::MarkAsClosed()
330 this->Instance->Log(DEBUG,"Marked as closed");
331 this->ClosePending = true;
334 // There are two possible outcomes to this function.
335 // It will either write all of the data, or an undefined amount.
336 // If an undefined amount is written the connection has failed
337 // and should be aborted.
338 int InspSocket::Write(const std::string &data)
340 if (this->ClosePending)
343 /*int result = write(this->fd,data.c_str(),data.length());
348 /* Try and append the data to the back of the queue, and send it on its way
350 outbuffer.push_back(data);
351 return (!this->FlushWriteBuffer());
354 bool InspSocket::FlushWriteBuffer()
356 if (this->ClosePending)
359 if ((this->fd > -1) && (this->state == I_CONNECTED))
361 if (outbuffer.size())
363 int result = write(this->fd,outbuffer[0].c_str(),outbuffer[0].length());
366 if ((unsigned int)result == outbuffer[0].length())
368 /* The whole block was written (usually a line)
369 * Pop the block off the front of the queue
371 outbuffer.pop_front();
375 std::string temp = outbuffer[0].substr(result);
379 else if ((result == -1) && (errno != EAGAIN))
381 this->Instance->Log(DEBUG,"Write error on socket: %s",strerror(errno));
382 this->OnError(I_ERR_WRITE);
383 this->state = I_ERROR;
384 this->ClosePending = true;
392 bool InspSocket::Timeout(time_t current)
394 if (this->Instance->SE->GetRef(this->fd) != this)
396 this->Instance->Log(DEBUG,"No FD or socket ref");
400 if (this->ClosePending)
402 this->Instance->Log(DEBUG,"Close is pending");
406 if ((this->state == I_CONNECTING) && (current > timeout_end))
408 this->Instance->Log(DEBUG,"Timed out, current=%lu timeout_end=%lu");
409 // for non-listening sockets, the timeout can occur
410 // which causes termination of the connection after
411 // the given number of seconds without a successful
414 this->OnError(I_ERR_TIMEOUT);
416 this->state = I_ERROR;
417 this->ClosePending = true;
420 return this->FlushWriteBuffer();
423 bool InspSocket::Poll()
425 if (this->Instance->SE->GetRef(this->fd) != this)
431 if ((fd < 0) || (fd > MAX_DESCRIPTORS) || (this->ClosePending))
437 this->Instance->Log(DEBUG,"State = I_CONNECTING");
438 /* Our socket was in write-state, so delete it and re-add it
443 this->Instance->SE->DelFd(this);
444 this->SetState(I_CONNECTED);
445 if (!this->Instance->SE->AddFd(this))
448 return this->OnConnected();
451 length = sizeof (client);
452 incoming = accept (this->fd, (sockaddr*)&client,&length);
453 this->SetQueues(incoming);
455 this->OnIncomingConnection(incoming,(char*)insp_ntoa(client.sin6_addr));
457 this->OnIncomingConnection(incoming,(char*)insp_ntoa(client.sin_addr));
463 if (this->WaitingForWriteEvent)
465 /* Switch back to read events */
466 this->Instance->SE->DelFd(this);
467 this->WaitingForWriteEvent = false;
468 if (!this->Instance->SE->AddFd(this))
471 /* Trigger the write event */
472 n = this->OnWriteReady();
476 /* Process the read event */
477 n = this->OnDataReady();
479 /* Flush any pending, but not till after theyre done with the event
480 * so there are less write calls involved.
481 * Both FlushWriteBuffer AND the return result of OnDataReady must
482 * return true for this to be ok.
484 if (this->FlushWriteBuffer())
494 void InspSocket::SetState(InspSocketState s)
496 this->Instance->Log(DEBUG,"Socket state change");
500 InspSocketState InspSocket::GetState()
505 int InspSocket::GetFd()
510 bool InspSocket::OnConnected() { return true; }
511 void InspSocket::OnError(InspSocketError e) { return; }
512 int InspSocket::OnDisconnect() { return 0; }
513 int InspSocket::OnIncomingConnection(int newfd, char* ip) { return 0; }
514 bool InspSocket::OnDataReady() { return true; }
515 bool InspSocket::OnWriteReady() { return true; }
516 void InspSocket::OnTimeout() { return; }
517 void InspSocket::OnClose() { return; }
519 InspSocket::~InspSocket()
524 void InspSocket::HandleEvent(EventType et)
528 this->Instance->SE->DelFd(this);