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"
25 #include "configreader.h"
26 #include "inspstring.h"
27 #include "helperfuncs.h"
28 #include "socketengine.h"
32 extern InspIRCd* ServerInstance;
33 extern ServerConfig* Config;
35 extern Server* MyServer;
37 InspSocket* socket_ref[MAX_DESCRIPTORS];
40 InspSocket::InspSocket()
42 this->state = I_DISCONNECTED;
44 this->ClosePending = false;
47 InspSocket::InspSocket(int newfd, const char* ip)
50 this->state = I_CONNECTED;
51 strlcpy(this->IP,ip,MAXBUF);
52 this->ClosePending = false;
55 ServerInstance->SE->AddFd(this->fd,true,X_ESTAB_MODULE);
56 socket_ref[this->fd] = this;
60 InspSocket::InspSocket(const std::string &ahost, int aport, bool listening, unsigned long maxtime) : fd(-1)
62 strlcpy(host,ahost.c_str(),MAXBUF);
63 this->ClosePending = false;
65 if ((this->fd = OpenTCPSocket()) == ERROR)
68 this->state = I_ERROR;
69 this->OnError(I_ERR_SOCKET);
70 this->ClosePending = true;
71 log(DEBUG,"OpenTCPSocket() error");
76 if (!BindSocket(this->fd,this->client,this->server,aport,(char*)ahost.c_str()))
78 log(DEBUG,"BindSocket() error %s",strerror(errno));
81 this->state = I_ERROR;
82 this->OnError(I_ERR_BIND);
83 this->ClosePending = true;
88 this->state = I_LISTENING;
91 ServerInstance->SE->AddFd(this->fd,true,X_ESTAB_MODULE);
92 socket_ref[this->fd] = this;
94 log(DEBUG,"New socket now in I_LISTENING state");
101 strlcpy(this->host,ahost.c_str(),MAXBUF);
104 if (insp_aton(host,&addy) < 1)
106 log(DEBUG,"You cannot pass hostnames to InspSocket, resolve them first with Resolver!");
109 this->state = I_ERROR;
110 this->OnError(I_ERR_RESOLVE);
111 this->ClosePending = true;
116 log(DEBUG,"No need to resolve %s",this->host);
117 strlcpy(this->IP,host,MAXBUF);
118 timeout_end = time(NULL) + maxtime;
124 void InspSocket::WantWrite()
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
134 * This behaviour may be fixed in a later version.
136 this->WaitingForWriteEvent = true;
137 ServerInstance->SE->DelFd(this->fd);
138 ServerInstance->SE->AddFd(this->fd,false,X_ESTAB_MODULE);
141 void InspSocket::SetQueues(int nfd)
143 // attempt to increase socket sendq and recvq as high as its possible
146 setsockopt(nfd,SOL_SOCKET,SO_SNDBUF,(const void *)&sendbuf,sizeof(sendbuf));
147 setsockopt(nfd,SOL_SOCKET,SO_RCVBUF,(const void *)&recvbuf,sizeof(sendbuf));
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.
158 bool InspSocket::BindAddr()
163 log(DEBUG,"In InspSocket::BindAddr()");
164 for (int j =0; j < Conf.Enumerate("bind"); j++)
166 std::string Type = Conf.ReadValue("bind","type",j);
167 std::string IP = Conf.ReadValue("bind","address",j);
168 if (Type == "servers")
170 if ((IP != "*") && (IP != "127.0.0.1") && (IP != ""))
173 char resolved_addr[MAXBUF];
175 if (insp_aton(IP.c_str(),&n) < 1)
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))
181 log(DEBUG,"Resolved host %s to %s",IP.c_str(),resolved_addr);
186 if (insp_aton(IP.c_str(),&n) > 0)
188 log(DEBUG,"Found an IP to bind to: %s",IP.c_str());
191 s.sin6_family = AF_FAMILY;
194 s.sin_family = AF_FAMILY;
196 if (bind(this->fd,(struct sockaddr*)&s,sizeof(s)) < 0)
198 log(DEBUG,"Cant bind()");
199 this->state = I_ERROR;
200 this->OnError(I_ERR_BIND);
204 log(DEBUG,"bind() reports outbound fd bound to ip %s",IP.c_str());
209 log(DEBUG,"Address '%s' was not an IP address",IP.c_str());
214 log(DEBUG,"Found no suitable IPs to bind, binding INADDR_ANY");
218 bool InspSocket::DoConnect()
220 log(DEBUG,"In DoConnect()");
221 if ((this->fd = socket(AF_FAMILY, SOCK_STREAM, 0)) == -1)
223 log(DEBUG,"Cant socket()");
224 this->state = I_ERROR;
225 this->OnError(I_ERR_SOCKET);
230 if (!this->BindAddr())
233 log(DEBUG,"Part 2 DoConnect() %s",this->IP);
234 insp_aton(this->IP,&addy);
236 addr.sin6_family = AF_FAMILY;
237 memcpy(&addy, &addr.sin6_addr, sizeof(insp_inaddr));
238 addr.sin6_port = htons(this->port);
240 addr.sin_family = AF_FAMILY;
241 addr.sin_addr = addy;
242 addr.sin_port = htons(this->port);
246 flags = fcntl(this->fd, F_GETFL, 0);
247 fcntl(this->fd, F_SETFL, flags | O_NONBLOCK);
249 if (connect(this->fd, (sockaddr*)&this->addr,sizeof(this->addr)) == -1)
251 if (errno != EINPROGRESS)
253 log(DEBUG,"Error connect() %d: %s",this->fd,strerror(errno));
254 this->OnError(I_ERR_CONNECT);
256 this->state = I_ERROR;
258 this->ClosePending = true;
262 this->state = I_CONNECTING;
265 ServerInstance->SE->AddFd(this->fd,false,X_ESTAB_MODULE);
266 socket_ref[this->fd] = this;
267 this->SetQueues(this->fd);
269 log(DEBUG,"Returning true from InspSocket::DoConnect");
274 void InspSocket::Close()
279 shutdown(this->fd,2);
281 socket_ref[this->fd] = NULL;
282 this->ClosePending = true;
287 std::string InspSocket::GetIP()
292 char* InspSocket::Read()
294 if ((fd < 0) || (fd > MAX_DESCRIPTORS))
296 int n = recv(this->fd,this->ibuf,sizeof(this->ibuf),0);
297 if ((n > 0) && (n <= (int)sizeof(this->ibuf)))
310 log(DEBUG,"EOF or error on socket: %s",strerror(errno));
316 void InspSocket::MarkAsClosed()
318 log(DEBUG,"Marked as closed");
319 this->ClosePending = true;
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)
328 if (this->ClosePending)
331 /*int result = write(this->fd,data.c_str(),data.length());
336 /* Try and append the data to the back of the queue, and send it on its way
338 outbuffer.push_back(data);
339 return (!this->FlushWriteBuffer());
342 bool InspSocket::FlushWriteBuffer()
344 if (this->ClosePending)
347 if ((this->fd > -1) && (this->state == I_CONNECTED))
349 if (outbuffer.size())
351 int result = write(this->fd,outbuffer[0].c_str(),outbuffer[0].length());
354 if ((unsigned int)result == outbuffer[0].length())
356 /* The whole block was written (usually a line)
357 * Pop the block off the front of the queue
359 outbuffer.pop_front();
363 std::string temp = outbuffer[0].substr(result);
367 else if ((result == -1) && (errno != EAGAIN))
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;
380 bool InspSocket::Timeout(time_t current)
382 if (!socket_ref[this->fd] || !ServerInstance->SE->HasFd(this->fd))
384 log(DEBUG,"No FD or socket ref");
388 if (this->ClosePending)
390 log(DEBUG,"Close is pending");
394 if ((this->state == I_CONNECTING) && (current > timeout_end))
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
402 this->OnError(I_ERR_TIMEOUT);
404 this->state = I_ERROR;
405 this->ClosePending = true;
408 return this->FlushWriteBuffer();
411 bool InspSocket::Poll()
413 if (!socket_ref[this->fd] || !ServerInstance->SE->HasFd(this->fd))
419 if ((fd < 0) || (fd > MAX_DESCRIPTORS) || (this->ClosePending))
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
432 ServerInstance->SE->DelFd(this->fd);
433 ServerInstance->SE->AddFd(this->fd,true,X_ESTAB_MODULE);
435 return this->OnConnected();
438 length = sizeof (client);
439 incoming = accept (this->fd, (sockaddr*)&client,&length);
440 this->SetQueues(incoming);
442 this->OnIncomingConnection(incoming,(char*)insp_ntoa(client.sin6_addr));
444 this->OnIncomingConnection(incoming,(char*)insp_ntoa(client.sin_addr));
450 if (this->WaitingForWriteEvent)
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();
460 /* Process the read event */
461 n = this->OnDataReady();
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.
468 if (this->FlushWriteBuffer())
478 void InspSocket::SetState(InspSocketState s)
480 log(DEBUG,"Socket state change");
484 InspSocketState InspSocket::GetState()
489 int InspSocket::GetFd()
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; }
503 InspSocket::~InspSocket()