1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
14 #include "configreader.h"
18 #include "commands/cmd_whois.h"
19 #include "commands/cmd_stats.h"
24 #include "transport.h"
26 #include "socketengine.h"
28 #include "m_spanningtree/main.h"
29 #include "m_spanningtree/utils.h"
30 #include "m_spanningtree/treeserver.h"
31 #include "m_spanningtree/link.h"
32 #include "m_spanningtree/treesocket.h"
33 #include "m_spanningtree/resolvers.h"
34 #include "m_spanningtree/handshaketimer.h"
36 /* $ModDep: m_spanningtree/timesynctimer.h m_spanningtree/resolvers.h m_spanningtree/main.h m_spanningtree/utils.h m_spanningtree/treeserver.h m_spanningtree/link.h m_spanningtree/treesocket.h m_hash.h */
38 /** Because most of the I/O gubbins are encapsulated within
39 * InspSocket, we just call the superclass constructor for
40 * most of the action, and append a few of our own values
43 TreeSocket::TreeSocket(SpanningTreeUtilities* Util, InspIRCd* SI, std::string host, int port, bool listening, unsigned long maxtime, Module* HookMod)
44 : InspSocket(SI, host, port, listening, maxtime), Utils(Util), Hook(HookMod)
47 this->LinkState = LISTENER;
48 theirchallenge = ourchallenge = "";
49 if (listening && Hook)
50 InspSocketHookRequest(this, (Module*)Utils->Creator, Hook).Send();
53 TreeSocket::TreeSocket(SpanningTreeUtilities* Util, InspIRCd* SI, std::string host, int port, bool listening, unsigned long maxtime, const std::string &ServerName, const std::string &bindto, Module* HookMod)
54 : InspSocket(SI, host, port, listening, maxtime, bindto), Utils(Util), Hook(HookMod)
57 theirchallenge = ourchallenge = "";
58 this->LinkState = CONNECTING;
60 InspSocketHookRequest(this, (Module*)Utils->Creator, Hook).Send();
63 /** When a listening socket gives us a new file descriptor,
64 * we must associate it with a socket without creating a new
65 * connection. This constructor is used for this purpose.
67 TreeSocket::TreeSocket(SpanningTreeUtilities* Util, InspIRCd* SI, int newfd, char* ip, Module* HookMod)
68 : InspSocket(SI, newfd, ip), Utils(Util), Hook(HookMod)
70 this->LinkState = WAIT_AUTH_1;
71 theirchallenge = ourchallenge = "";
72 /* If we have a transport module hooked to the parent, hook the same module to this
73 * socket, and set a timer waiting for handshake before we send CAPAB etc.
76 InspSocketHookRequest(this, (Module*)Utils->Creator, Hook).Send();
78 Instance->Timers->AddTimer(new HandshakeTimer(Instance, this, &(Utils->LinkBlocks[0]), this->Utils));
81 ServerState TreeSocket::GetLinkState()
83 return this->LinkState;
86 Module* TreeSocket::GetHook()
91 TreeSocket::~TreeSocket()
94 InspSocketUnhookRequest(this, (Module*)Utils->Creator, Hook).Send();
97 const std::string& TreeSocket::GetOurChallenge()
99 return this->ourchallenge;
102 void TreeSocket::SetOurChallenge(const std::string &c)
104 this->ourchallenge = c;
107 const std::string& TreeSocket::GetTheirChallenge()
109 return this->theirchallenge;
112 void TreeSocket::SetTheirChallenge(const std::string &c)
114 this->theirchallenge = c;
117 std::string TreeSocket::MakePass(const std::string &password, const std::string &challenge)
119 /* This is a simple (maybe a bit hacky?) HMAC algorithm, thanks to jilles for
120 * suggesting the use of HMAC to secure the password against various attacks.
122 * Note: If m_sha256.so is not loaded, we MUST fall back to plaintext with no
123 * HMAC challenge/response.
125 Module* sha256 = Instance->FindModule("m_sha256.so");
126 if (Utils->ChallengeResponse && sha256 && !challenge.empty())
128 /* XXX: This is how HMAC is supposed to be done:
130 * sha256( (pass xor 0x5c) + sha256((pass xor 0x36) + m) )
132 * Note that we are encoding the hex hash, not the binary
133 * output of the hash which is slightly different to standard.
135 * Don't ask me why its always 0x5c and 0x36... it just is.
137 std::string hmac1, hmac2;
139 for (size_t n = 0; n < password.length(); n++)
141 hmac1 += static_cast<char>(password[n] ^ 0x5C);
142 hmac2 += static_cast<char>(password[n] ^ 0x36);
145 HashResetRequest(Utils->Creator, sha256).Send();
146 hmac2 = HashSumRequest(Utils->Creator, sha256, hmac2).Send();
148 HashResetRequest(Utils->Creator, sha256).Send();
149 std::string hmac = hmac1 + hmac2 + challenge;
150 hmac = HashSumRequest(Utils->Creator, sha256, hmac).Send();
152 return "HMAC-SHA256:"+ hmac;
154 else if (!challenge.empty() && !sha256)
155 Instance->Log(DEFAULT,"Not authenticating to server using SHA256/HMAC because we don't have m_sha256 loaded!");
160 /** When an outbound connection finishes connecting, we receive
161 * this event, and must send our SERVER string to the other
162 * side. If the other side is happy, as outlined in the server
163 * to server docs on the inspircd.org site, the other side
164 * will then send back its own server string.
166 bool TreeSocket::OnConnected()
168 if (this->LinkState == CONNECTING)
170 /* we do not need to change state here. */
171 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
173 if (x->Name == this->myhost)
175 this->Instance->SNO->WriteToSnoMask('l',"Connection to \2"+myhost+"\2["+(x->HiddenFromStats ? "<hidden>" : this->GetIP())+"] started.");
178 InspSocketHookRequest(this, (Module*)Utils->Creator, Hook).Send();
179 this->Instance->SNO->WriteToSnoMask('l',"Connection to \2"+myhost+"\2["+(x->HiddenFromStats ? "<hidden>" : this->GetIP())+"] using transport \2"+x->Hook+"\2");
181 this->OutboundPass = x->SendPass;
182 /* found who we're supposed to be connecting to, send the neccessary gubbins. */
183 Instance->Timers->AddTimer(new HandshakeTimer(Instance, this, &(*x), this->Utils));
188 /* There is a (remote) chance that between the /CONNECT and the connection
189 * being accepted, some muppet has removed the <link> block and rehashed.
190 * If that happens the connection hangs here until it's closed. Unlikely
191 * and rather harmless.
193 this->Instance->SNO->WriteToSnoMask('l',"Connection to \2"+myhost+"\2 lost link tag(!)");
197 void TreeSocket::OnError(InspSocketError e)
199 /* We don't handle this method, because all our
200 * dirty work is done in OnClose() (see below)
201 * which is still called on error conditions too.
203 if (e == I_ERR_CONNECT)
205 this->Instance->SNO->WriteToSnoMask('l',"Connection failed: Connection to \002"+myhost+"\002 refused");
206 Link* MyLink = Utils->FindLink(myhost);
208 Utils->DoFailOver(MyLink);
212 int TreeSocket::OnDisconnect()
214 /* For the same reason as above, we don't
215 * handle OnDisconnect()
220 /** Recursively send the server tree with distances as hops.
221 * This is used during network burst to inform the other server
222 * (and any of ITS servers too) of what servers we know about.
223 * If at any point any of these servers already exist on the other
224 * end, our connection may be terminated. The hopcounts given
225 * by this function are relative, this doesn't matter so long as
226 * they are all >1, as all the remote servers re-calculate them
227 * to be relative too, with themselves as hop 0.
229 void TreeSocket::SendServers(TreeServer* Current, TreeServer* s, int hops)
232 for (unsigned int q = 0; q < Current->ChildCount(); q++)
234 TreeServer* recursive_server = Current->GetChild(q);
235 if (recursive_server != s)
237 snprintf(command,1024,":%s SERVER %s * %d :%s",Current->GetName().c_str(),recursive_server->GetName().c_str(),hops,recursive_server->GetDesc().c_str());
238 this->WriteLine(command);
239 this->WriteLine(":"+recursive_server->GetName()+" VERSION :"+recursive_server->GetVersion());
240 /* down to next level */
241 this->SendServers(recursive_server, s, hops+1);
246 std::string TreeSocket::MyCapabilities()
248 std::vector<std::string> modlist;
249 std::string capabilities = "";
250 for (int i = 0; i <= this->Instance->GetModuleCount(); i++)
252 if (this->Instance->modules[i]->GetVersion().Flags & VF_COMMON)
253 modlist.push_back(this->Instance->Config->module_names[i]);
255 sort(modlist.begin(),modlist.end());
256 for (unsigned int i = 0; i < modlist.size(); i++)
259 capabilities = capabilities + ",";
260 capabilities = capabilities + modlist[i];
265 std::string TreeSocket::RandString(unsigned int length)
268 for (unsigned int i = 0; i < length; i++)
269 out += static_cast<char>((rand() % 26) + 65);
273 void TreeSocket::SendCapabilities()
275 irc::commasepstream modulelist(MyCapabilities());
276 this->WriteLine("CAPAB START");
278 /* Send module names, split at 509 length */
279 std::string item = "*";
280 std::string line = "CAPAB MODULES ";
281 while ((item = modulelist.GetToken()) != "")
283 if (line.length() + item.length() + 1 > 509)
285 this->WriteLine(line);
286 line = "CAPAB MODULES ";
289 if (line != "CAPAB MODULES ")
294 if (line != "CAPAB MODULES ")
295 this->WriteLine(line);
302 #ifdef SUPPORT_IP6LINKS
306 /* Do we have sha256 available? If so, we send a challenge */
307 if (Utils->ChallengeResponse && (Instance->FindModule("m_sha256.so")))
309 this->SetOurChallenge(RandString(20));
310 extra = " CHALLENGE=" + this->GetOurChallenge();
313 this->WriteLine("CAPAB CAPABILITIES :NICKMAX="+ConvToStr(NICKMAX)+" HALFOP="+ConvToStr(this->Instance->Config->AllowHalfop)+" CHANMAX="+ConvToStr(CHANMAX)+" MAXMODES="+ConvToStr(MAXMODES)+" IDENTMAX="+ConvToStr(IDENTMAX)+" MAXQUIT="+ConvToStr(MAXQUIT)+" MAXTOPIC="+ConvToStr(MAXTOPIC)+" MAXKICK="+ConvToStr(MAXKICK)+" MAXGECOS="+ConvToStr(MAXGECOS)+" MAXAWAY="+ConvToStr(MAXAWAY)+" IP6NATIVE="+ConvToStr(ip6)+" IP6SUPPORT="+ConvToStr(ip6support)+" PROTOCOL="+ConvToStr(ProtocolVersion)+extra);
315 this->WriteLine("CAPAB END");
318 /* Check a comma seperated list for an item */
319 bool TreeSocket::HasItem(const std::string &list, const std::string &item)
321 irc::commasepstream seplist(list);
322 std::string item2 = "*";
323 while ((item2 = seplist.GetToken()) != "")
331 /* Isolate and return the elements that are different between two comma seperated lists */
332 std::string TreeSocket::ListDifference(const std::string &one, const std::string &two)
334 irc::commasepstream list_one(one);
335 std::string item = "*";
336 std::string result = "";
337 while ((item = list_one.GetToken()) != "")
339 if (!HasItem(two, item))
348 bool TreeSocket::Capab(const std::deque<std::string> ¶ms)
350 if (params.size() < 1)
352 this->WriteLine("ERROR :Invalid number of parameters for CAPAB - Mismatched version");
355 if (params[0] == "START")
357 this->ModuleList = "";
358 this->CapKeys.clear();
360 else if (params[0] == "END")
362 std::string reason = "";
364 #ifdef SUPPORT_IP6LINKS
367 /* Compare ModuleList and check CapKeys...
368 * Maybe this could be tidier? -- Brain
370 if ((this->ModuleList != this->MyCapabilities()) && (this->ModuleList.length()))
372 std::string diff = ListDifference(this->ModuleList, this->MyCapabilities());
375 diff = "your server:" + ListDifference(this->MyCapabilities(), this->ModuleList);
379 diff = "this server:" + diff;
381 if (diff.length() == 12)
382 reason = "Module list in CAPAB is not alphabetically ordered, cannot compare lists.";
384 reason = "Modules loaded on these servers are not correctly matched, these modules are not loaded on " + diff;
386 if (((this->CapKeys.find("IP6SUPPORT") == this->CapKeys.end()) && (ip6support)) || ((this->CapKeys.find("IP6SUPPORT") != this->CapKeys.end()) && (this->CapKeys.find("IP6SUPPORT")->second != ConvToStr(ip6support))))
387 reason = "We don't both support linking to IPV6 servers";
388 if (((this->CapKeys.find("IP6NATIVE") != this->CapKeys.end()) && (this->CapKeys.find("IP6NATIVE")->second == "1")) && (!ip6support))
389 reason = "The remote server is IPV6 native, and we don't support linking to IPV6 servers";
390 if (((this->CapKeys.find("NICKMAX") == this->CapKeys.end()) || ((this->CapKeys.find("NICKMAX") != this->CapKeys.end()) && (this->CapKeys.find("NICKMAX")->second != ConvToStr(NICKMAX)))))
391 reason = "Maximum nickname lengths differ or remote nickname length not specified";
392 if (((this->CapKeys.find("PROTOCOL") == this->CapKeys.end()) || ((this->CapKeys.find("PROTOCOL") != this->CapKeys.end()) && (this->CapKeys.find("PROTOCOL")->second != ConvToStr(ProtocolVersion)))))
394 if (this->CapKeys.find("PROTOCOL") != this->CapKeys.end())
396 reason = "Mismatched protocol versions "+this->CapKeys.find("PROTOCOL")->second+" and "+ConvToStr(ProtocolVersion);
400 reason = "Protocol version not specified";
403 if (((this->CapKeys.find("HALFOP") == this->CapKeys.end()) && (Instance->Config->AllowHalfop)) || ((this->CapKeys.find("HALFOP") != this->CapKeys.end()) && (this->CapKeys.find("HALFOP")->second != ConvToStr(Instance->Config->AllowHalfop))))
404 reason = "We don't both have halfop support enabled/disabled identically";
405 if (((this->CapKeys.find("IDENTMAX") == this->CapKeys.end()) || ((this->CapKeys.find("IDENTMAX") != this->CapKeys.end()) && (this->CapKeys.find("IDENTMAX")->second != ConvToStr(IDENTMAX)))))
406 reason = "Maximum ident lengths differ or remote ident length not specified";
407 if (((this->CapKeys.find("CHANMAX") == this->CapKeys.end()) || ((this->CapKeys.find("CHANMAX") != this->CapKeys.end()) && (this->CapKeys.find("CHANMAX")->second != ConvToStr(CHANMAX)))))
408 reason = "Maximum channel lengths differ or remote channel length not specified";
409 if (((this->CapKeys.find("MAXMODES") == this->CapKeys.end()) || ((this->CapKeys.find("MAXMODES") != this->CapKeys.end()) && (this->CapKeys.find("MAXMODES")->second != ConvToStr(MAXMODES)))))
410 reason = "Maximum modes per line differ or remote modes per line not specified";
411 if (((this->CapKeys.find("MAXQUIT") == this->CapKeys.end()) || ((this->CapKeys.find("MAXQUIT") != this->CapKeys.end()) && (this->CapKeys.find("MAXQUIT")->second != ConvToStr(MAXQUIT)))))
412 reason = "Maximum quit lengths differ or remote quit length not specified";
413 if (((this->CapKeys.find("MAXTOPIC") == this->CapKeys.end()) || ((this->CapKeys.find("MAXTOPIC") != this->CapKeys.end()) && (this->CapKeys.find("MAXTOPIC")->second != ConvToStr(MAXTOPIC)))))
414 reason = "Maximum topic lengths differ or remote topic length not specified";
415 if (((this->CapKeys.find("MAXKICK") == this->CapKeys.end()) || ((this->CapKeys.find("MAXKICK") != this->CapKeys.end()) && (this->CapKeys.find("MAXKICK")->second != ConvToStr(MAXKICK)))))
416 reason = "Maximum kick lengths differ or remote kick length not specified";
417 if (((this->CapKeys.find("MAXGECOS") == this->CapKeys.end()) || ((this->CapKeys.find("MAXGECOS") != this->CapKeys.end()) && (this->CapKeys.find("MAXGECOS")->second != ConvToStr(MAXGECOS)))))
418 reason = "Maximum GECOS (fullname) lengths differ or remote GECOS length not specified";
419 if (((this->CapKeys.find("MAXAWAY") == this->CapKeys.end()) || ((this->CapKeys.find("MAXAWAY") != this->CapKeys.end()) && (this->CapKeys.find("MAXAWAY")->second != ConvToStr(MAXAWAY)))))
420 reason = "Maximum awaymessage lengths differ or remote awaymessage length not specified";
422 /* Challenge response, store their challenge for our password */
423 std::map<std::string,std::string>::iterator n = this->CapKeys.find("CHALLENGE");
424 if (Utils->ChallengeResponse && (n != this->CapKeys.end()) && (Instance->FindModule("m_sha256.so")))
426 /* Challenge-response is on now */
427 this->SetTheirChallenge(n->second);
428 if (!this->GetOurChallenge().empty() && (this->LinkState == CONNECTING))
430 this->WriteLine(std::string("SERVER ")+this->Instance->Config->ServerName+" "+this->MakePass(OutboundPass, this->GetTheirChallenge())+" 0 :"+this->Instance->Config->ServerDesc);
435 /* They didnt specify a challenge or we don't have m_sha256.so, we use plaintext */
436 if (this->LinkState == CONNECTING)
437 this->WriteLine(std::string("SERVER ")+this->Instance->Config->ServerName+" "+OutboundPass+" 0 :"+this->Instance->Config->ServerDesc);
442 this->WriteLine("ERROR :CAPAB negotiation failed: "+reason);
446 else if ((params[0] == "MODULES") && (params.size() == 2))
448 if (!this->ModuleList.length())
450 this->ModuleList.append(params[1]);
454 this->ModuleList.append(",");
455 this->ModuleList.append(params[1]);
459 else if ((params[0] == "CAPABILITIES") && (params.size() == 2))
461 irc::tokenstream capabs(params[1]);
464 while ((more = capabs.GetToken(item)))
466 /* Process each key/value pair */
467 std::string::size_type equals = item.rfind('=');
468 if (equals != std::string::npos)
470 std::string var = item.substr(0, equals);
471 std::string value = item.substr(equals+1, item.length());
472 CapKeys[var] = value;
479 /** This function forces this server to quit, removing this server
480 * and any users on it (and servers and users below that, etc etc).
481 * It's very slow and pretty clunky, but luckily unless your network
482 * is having a REAL bad hair day, this function shouldnt be called
483 * too many times a month ;-)
485 void TreeSocket::SquitServer(std::string &from, TreeServer* Current)
487 /* recursively squit the servers attached to 'Current'.
488 * We're going backwards so we don't remove users
489 * while we still need them ;)
491 for (unsigned int q = 0; q < Current->ChildCount(); q++)
493 TreeServer* recursive_server = Current->GetChild(q);
494 this->SquitServer(from,recursive_server);
496 /* Now we've whacked the kids, whack self */
498 num_lost_users += Current->QuitUsers(from);
501 /** This is a wrapper function for SquitServer above, which
502 * does some validation first and passes on the SQUIT to all
503 * other remaining servers.
505 void TreeSocket::Squit(TreeServer* Current, const std::string &reason)
507 if ((Current) && (Current != Utils->TreeRoot))
509 Event rmode((char*)Current->GetName().c_str(), (Module*)Utils->Creator, "lost_server");
510 rmode.Send(Instance);
512 std::deque<std::string> params;
513 params.push_back(Current->GetName());
514 params.push_back(":"+reason);
515 Utils->DoOneToAllButSender(Current->GetParent()->GetName(),"SQUIT",params,Current->GetName());
516 if (Current->GetParent() == Utils->TreeRoot)
518 this->Instance->WriteOpers("Server \002"+Current->GetName()+"\002 split: "+reason);
522 this->Instance->WriteOpers("Server \002"+Current->GetName()+"\002 split from server \002"+Current->GetParent()->GetName()+"\002 with reason: "+reason);
524 num_lost_servers = 0;
526 std::string from = Current->GetParent()->GetName()+" "+Current->GetName();
527 SquitServer(from, Current);
529 Current->GetParent()->DelChild(Current);
531 this->Instance->WriteOpers("Netsplit complete, lost \002%d\002 users on \002%d\002 servers.", num_lost_users, num_lost_servers);
535 Instance->Log(DEFAULT,"Squit from unknown server");
539 /** FMODE command - server mode with timestamp checks */
540 bool TreeSocket::ForceMode(const std::string &source, std::deque<std::string> ¶ms)
542 /* Chances are this is a 1.0 FMODE without TS */
543 if (params.size() < 3)
545 /* No modes were in the command, probably a channel with no modes set on it */
550 std::string sourceserv;
551 /* Are we dealing with an FMODE from a user, or from a server? */
552 userrec* who = this->Instance->FindNick(source);
555 /* FMODE from a user, set sourceserv to the users server name */
556 sourceserv = who->server;
560 /* FMODE from a server, create a fake user to receive mode feedback */
561 who = new userrec(this->Instance);
562 who->SetFd(FD_MAGIC_NUMBER);
563 smode = true; /* Setting this flag tells us we should free the userrec later */
564 sourceserv = source; /* Set sourceserv to the actual source string */
566 const char* modelist[64];
569 memset(&modelist,0,sizeof(modelist));
570 for (unsigned int q = 0; (q < params.size()) && (q < 64); q++)
574 /* The timestamp is in this position.
575 * We don't want to pass that up to the
576 * server->client protocol!
578 TS = atoi(params[q].c_str());
582 /* Everything else is fine to append to the modelist */
583 modelist[n++] = params[q].c_str();
587 /* Extract the TS value of the object, either userrec or chanrec */
588 userrec* dst = this->Instance->FindNick(params[0]);
589 chanrec* chan = NULL;
597 chan = this->Instance->FindChan(params[0]);
603 /* Oops, channel doesnt exist! */
607 /* TS is equal or less: Merge the mode changes into ours and pass on.
613 this->Instance->SendMode(modelist, n, who);
617 this->Instance->CallCommandHandler("MODE", modelist, n, who);
619 /* HOT POTATO! PASS IT ON! */
620 Utils->DoOneToAllButSender(source,"FMODE",params,sourceserv);
622 /* If the TS is greater than ours, we drop the mode and dont pass it anywhere.
631 /** FTOPIC command */
632 bool TreeSocket::ForceTopic(const std::string &source, std::deque<std::string> ¶ms)
634 if (params.size() != 4)
636 time_t ts = atoi(params[1].c_str());
637 std::string nsource = source;
638 chanrec* c = this->Instance->FindChan(params[0]);
641 if ((ts >= c->topicset) || (!*c->topic))
643 std::string oldtopic = c->topic;
644 strlcpy(c->topic,params[3].c_str(),MAXTOPIC);
645 strlcpy(c->setby,params[2].c_str(),127);
647 /* if the topic text is the same as the current topic,
648 * dont bother to send the TOPIC command out, just silently
649 * update the set time and set nick.
651 if (oldtopic != params[3])
653 userrec* user = this->Instance->FindNick(source);
656 c->WriteChannelWithServ(source.c_str(), "TOPIC %s :%s", c->name, c->topic);
660 c->WriteChannel(user, "TOPIC %s :%s", c->name, c->topic);
661 nsource = user->server;
663 /* all done, send it on its way */
664 params[3] = ":" + params[3];
665 Utils->DoOneToAllButSender(source,"FTOPIC",params,nsource);
673 /** FJOIN, similar to TS6 SJOIN, but not quite. */
674 bool TreeSocket::ForceJoin(const std::string &source, std::deque<std::string> ¶ms)
676 /* 1.1 FJOIN works as follows:
678 * Each FJOIN is sent along with a timestamp, and the side with the lowest
679 * timestamp 'wins'. From this point on we will refer to this side as the
680 * winner. The side with the higher timestamp loses, from this point on we
681 * will call this side the loser or losing side. This should be familiar to
682 * anyone who's dealt with dreamforge or TS6 before.
684 * When two sides of a split heal and this occurs, the following things
687 * If the timestamps are exactly equal, both sides merge their privilages
688 * and users, as in InspIRCd 1.0 and ircd2.8. The channels have not been
689 * re-created during a split, this is safe to do.
692 * If the timestamps are NOT equal, the losing side removes all privilage
693 * modes from all of its users that currently exist in the channel, before
694 * introducing new users into the channel which are listed in the FJOIN
695 * command's parameters. This means, all modes +ohv, and privilages added
696 * by modules, such as +qa. The losing side then LOWERS its timestamp value
697 * of the channel to match that of the winning side, and the modes of the
698 * users of the winning side are merged in with the losing side. The loser
699 * then sends out a set of FMODE commands which 'confirm' that it just
700 * removed all privilage modes from its existing users, which allows for
701 * services packages to still work correctly without needing to know the
702 * timestamping rules which InspIRCd follows. In TS6 servers this is always
703 * a problem, and services packages must contain code which explicitly
704 * behaves as TS6 does, removing ops from the losing side of a split where
705 * neccessary within its internal records, as this state information is
706 * not explicitly echoed out in that protocol.
708 * The winning side on the other hand will ignore all user modes from the
709 * losing side, so only its own modes get applied. Life is simple for those
710 * who succeed at internets. :-)
712 * NOTE: Unlike TS6 and dreamforge and other protocols which have SJOIN,
713 * FJOIN does not contain the simple-modes such as +iklmnsp. Why not,
714 * you ask? Well, quite simply because we don't need to. They'll be sent
715 * after the FJOIN by FMODE, and FMODE is timestamped, so in the event
716 * the losing side sends any modes for the channel which shouldnt win,
717 * they wont as their timestamp will be too high :-)
720 if (params.size() < 3)
723 char first[MAXBUF]; /* The first parameter of the mode command */
724 char modestring[MAXBUF]; /* The mode sequence (2nd parameter) of the mode command */
725 char* mode_users[127]; /* The values used by the mode command */
726 memset(&mode_users,0,sizeof(mode_users)); /* Initialize mode parameters */
727 mode_users[0] = first; /* Set this up to be our on-stack value */
728 mode_users[1] = modestring; /* Same here as above */
729 strcpy(modestring,"+"); /* Initialize the mode sequence to just '+' */
730 unsigned int modectr = 2; /* Pointer to the third mode parameter (e.g. the one after the +-sequence) */
732 userrec* who = NULL; /* User we are currently checking */
733 std::string channel = params[0]; /* Channel name, as a string */
734 time_t TS = atoi(params[1].c_str()); /* Timestamp given to us for remote side */
735 std::string nicklist = params[2];
736 bool created = false;
738 /* Try and find the channel */
739 chanrec* chan = this->Instance->FindChan(channel);
741 /* Initialize channel name in the mode parameters */
742 strlcpy(mode_users[0],channel.c_str(),MAXBUF);
744 /* default TS is a high value, which if we dont have this
745 * channel will let the other side apply their modes.
747 time_t ourTS = Instance->Time(true)+600;
748 /* Does this channel exist? if it does, get its REAL timestamp */
752 created = true; /* don't perform deops, and set TS to correct time after processing. */
754 /* do this first, so our mode reversals are correctly received by other servers
755 * if there is a TS collision.
757 params[2] = ":" + params[2];
758 Utils->DoOneToAllButSender(source,"FJOIN",params,source);
760 /* In 1.1, if they have the newer channel, we immediately clear
761 * all status modes from our users. We then accept their modes.
762 * If WE have the newer channel its the other side's job to do this.
763 * Note that this causes the losing server to send out confirming
768 std::deque<std::string> param_list;
769 /* Lower the TS here */
770 if (Utils->AnnounceTSChange && chan)
771 chan->WriteChannelWithServ(Instance->Config->ServerName,
772 "NOTICE %s :TS for %s changed from %lu to %lu", chan->name, chan->name, ourTS, TS);
774 /* Zap all the privilage modes on our side, if the channel exists here */
777 param_list.push_back(channel);
780 this->RemoveStatus(Instance->Config->ServerName, param_list);
783 /* Put the final parameter of the FJOIN into a tokenstream ready to split it */
784 irc::tokenstream users(nicklist);
787 /* Now, process every 'prefixes,nick' pair */
788 while (users.GetToken(item))
791 const char* usr = item.c_str();
792 /* Safety check just to make sure someones not sent us an FJOIN full of spaces
793 * (is this even possible?) */
796 const char* permissions = usr;
798 char* nm = new char[MAXBUF];
800 /* Iterate through all the prefix values, convert them from prefixes
801 * to mode letters, and append them to the mode sequence
803 while ((*permissions) && (*permissions != ',') && (ntimes < MAXBUF))
805 ModeHandler* mh = Instance->Modes->FindPrefix(*permissions);
808 /* This is a valid prefix */
810 *tnm++ = mh->GetModeChar();
814 /* Not a valid prefix...
815 * danger bill bobbertson! (that's will robinsons older brother ;-) ...)
817 this->Instance->WriteOpers("ERROR: We received a user with an unknown prefix '%c'. Closed connection to avoid a desync.",*permissions);
818 this->WriteLine(std::string("ERROR :Invalid prefix '")+(*permissions)+"' in FJOIN");
824 /* Null terminate modes */
826 /* Advance past the comma, to the nick */
828 /* Check the user actually exists */
829 who = this->Instance->FindNick(usr);
832 /* Check that the user's 'direction' is correct
833 * based on the server sending the FJOIN. We must
834 * check each nickname in turn, because the origin of
835 * the FJOIN may be different to the origin of the nicks
836 * in the command itself.
838 TreeServer* route_back_again = Utils->BestRouteTo(who->server);
839 if ((!route_back_again) || (route_back_again->GetSocket() != this))
841 /* Oh dear oh dear. */
846 /* NOTE: Moved this below the fake direction check, so that modes
847 * arent put into the mode list for users that were collided, and
848 * may reconnect from the other side or our side before the split
852 /* Did they get any modes? How many times? */
853 strlcat(modestring, nm, MAXBUF);
854 for (int k = 0; k < ntimes; k++)
855 mode_users[modectr++] = strdup(usr);
856 /* Free temporary buffer used for mode sequence */
859 /* Finally, we can actually place the user into the channel.
860 * We're sure its right. Final answer, phone a friend.
863 chanrec::JoinUser(this->Instance, who, channel.c_str(), true, "", TS);
865 chanrec::JoinUser(this->Instance, who, channel.c_str(), true, "");
866 /* Have we already queued up MAXMODES modes with parameters
867 * (+qaohv) ready to be sent to the server?
869 if (modectr >= (MAXMODES-1))
871 /* Only actually give the users any status if we lost
872 * the FJOIN or drew (equal timestamps).
873 * It isn't actually possible for ourTS to be > TS here,
874 * only possible to actually have ourTS == TS, or
875 * ourTS < TS, because if we lost, we already lowered
876 * our TS above before we entered this loop. We only
877 * check >= as a safety measure, in case someone stuffed
878 * up. If someone DID stuff up, it was most likely me.
879 * Note: I do not like baseball bats in the face...
883 this->Instance->SendMode((const char**)mode_users,modectr,who);
885 /* Something stuffed up, and for some reason, the timestamp is
886 * NOT lowered right now and should be. Lower it. Usually this
887 * code won't be executed, doubtless someone will remove it some
892 Instance->Log(DEFAULT,"Channel TS for %s changed from %lu to %lu",chan->name,ourTS,TS);
898 /* Reset all this back to defaults, and
899 * free any ram we have left allocated.
901 strcpy(mode_users[1],"+");
902 for (unsigned int f = 2; f < modectr; f++)
909 /* Remember to free this */
911 /* If we got here, there's a nick in FJOIN which doesnt exist on this server.
912 * We don't try to process the nickname here (that WOULD cause a segfault because
913 * we'd be playing with null pointers) however, we DO pass the nickname on, just
914 * in case somehow we're desynched, so that other users which might be able to see
915 * the nickname get their fair chance to process it.
917 Instance->Log(SPARSE,"Warning! Invalid user %s in FJOIN to channel %s IGNORED", usr, channel.c_str());
923 /* there werent enough modes built up to flush it during FJOIN,
924 * or, there are a number left over. flush them out.
926 if ((modectr > 2) && (who) && (chan))
930 /* Our channel is newer than theirs. Evil deeds must be afoot. */
931 this->Instance->SendMode((const char**)mode_users,modectr,who);
932 /* Yet again, we can't actually get a true value here, if everything else
933 * is working as it should.
937 Instance->Log(DEFAULT,"Channel TS for %s changed from %lu to %lu",chan->name,ourTS,TS);
943 /* Free anything we have left to free */
944 for (unsigned int f = 2; f < modectr; f++)
947 /* All done. That wasnt so bad was it, you can wipe
948 * the sweat from your forehead now. :-)
954 bool TreeSocket::IntroduceClient(const std::string &source, std::deque<std::string> ¶ms)
956 /** Do we have enough parameters:
957 * NICK age nick host dhost ident +modes ip :gecos
959 if (params.size() != 8)
961 this->WriteLine(std::string(":")+this->Instance->Config->ServerName+" KILL "+params[1]+" :Invalid client introduction ("+params[1]+"?)");
965 time_t age = atoi(params[0].c_str());
966 const char* tempnick = params[1].c_str();
968 /** Check parameters for validity before introducing the client, discovered by dmb.
969 * XXX: Can we make this neater?
973 this->WriteLine(std::string(":")+this->Instance->Config->ServerName+" KILL "+params[1]+" :Invalid client introduction (Invalid TS?)");
976 else if (params[1].length() > NICKMAX)
978 this->WriteLine(std::string(":")+this->Instance->Config->ServerName+" KILL "+params[1]+" :Invalid client introduction ("+params[1]+" > NICKMAX?)");
981 else if (params[2].length() > 64)
983 this->WriteLine(std::string(":")+this->Instance->Config->ServerName+" KILL "+params[1]+" :Invalid client introduction ("+params[2]+" > 64?)");
986 else if (params[3].length() > 64)
988 this->WriteLine(std::string(":")+this->Instance->Config->ServerName+" KILL "+params[1]+" :Invalid client introduction ("+params[3]+" > 64?)");
991 else if (params[4].length() > IDENTMAX)
993 this->WriteLine(std::string(":")+this->Instance->Config->ServerName+" KILL "+params[1]+" :Invalid client introduction ("+params[4]+" > IDENTMAX?)");
996 else if (params[7].length() > MAXGECOS)
998 this->WriteLine(std::string(":")+this->Instance->Config->ServerName+" KILL "+params[1]+" :Invalid client introduction ("+params[7]+" > MAXGECOS?)");
1002 /** Our client looks ok, lets introduce it now
1004 Instance->Log(DEBUG,"New remote client %s",tempnick);
1005 user_hash::iterator iter = this->Instance->clientlist->find(tempnick);
1007 if (iter != this->Instance->clientlist->end())
1009 /* nick collision */
1010 this->WriteLine(std::string(":")+this->Instance->Config->ServerName+" KILL "+tempnick+" :Nickname collision");
1011 userrec::QuitUser(this->Instance, iter->second, "Nickname collision");
1015 userrec* _new = new userrec(this->Instance);
1016 (*(this->Instance->clientlist))[tempnick] = _new;
1017 _new->SetFd(FD_MAGIC_NUMBER);
1018 strlcpy(_new->nick, tempnick,NICKMAX-1);
1019 strlcpy(_new->host, params[2].c_str(),63);
1020 strlcpy(_new->dhost, params[3].c_str(),63);
1021 _new->server = this->Instance->FindServerNamePtr(source.c_str());
1022 strlcpy(_new->ident, params[4].c_str(),IDENTMAX);
1023 strlcpy(_new->fullname, params[7].c_str(),MAXGECOS);
1024 _new->registered = REG_ALL;
1027 /* we need to remove the + from the modestring, so we can do our stuff */
1028 std::string::size_type pos_after_plus = params[5].find_first_not_of('+');
1029 if (pos_after_plus != std::string::npos)
1030 params[5] = params[5].substr(pos_after_plus);
1032 for (std::string::iterator v = params[5].begin(); v != params[5].end(); v++)
1034 _new->modes[(*v)-65] = 1;
1035 /* For each mode thats set, increase counter */
1036 ModeHandler* mh = Instance->Modes->FindMode(*v, MODETYPE_USER);
1041 /* now we've done with modes processing, put the + back for remote servers */
1042 params[5] = "+" + params[5];
1044 #ifdef SUPPORT_IP6LINKS
1045 if (params[6].find_first_of(":") != std::string::npos)
1046 _new->SetSockAddr(AF_INET6, params[6].c_str(), 0);
1049 _new->SetSockAddr(AF_INET, params[6].c_str(), 0);
1051 Instance->AddGlobalClone(_new);
1053 if (!this->Instance->SilentULine(_new->server))
1054 this->Instance->SNO->WriteToSnoMask('C',"Client connecting at %s: %s!%s@%s [%s]",_new->server,_new->nick,_new->ident,_new->host, _new->GetIPString());
1056 params[7] = ":" + params[7];
1057 Utils->DoOneToAllButSender(source,"NICK", params, source);
1059 // Increment the Source Servers User Count..
1060 TreeServer* SourceServer = Utils->FindServer(source);
1063 SourceServer->AddUserCount();
1066 FOREACH_MOD_I(Instance,I_OnPostConnect,OnPostConnect(_new));
1071 /** Send one or more FJOINs for a channel of users.
1072 * If the length of a single line is more than 480-NICKMAX
1073 * in length, it is split over multiple lines.
1075 void TreeSocket::SendFJoins(TreeServer* Current, chanrec* c)
1079 std::string individual_halfops = std::string(":")+this->Instance->Config->ServerName+" FMODE "+c->name+" "+ConvToStr(c->age);
1081 size_t dlen, curlen;
1082 dlen = curlen = snprintf(list,MAXBUF,":%s FJOIN %s %lu",this->Instance->Config->ServerName,c->name,(unsigned long)c->age);
1084 char* ptr = list + dlen;
1086 CUList *ulist = c->GetUsers();
1087 std::string modes = "";
1088 std::string params = "";
1090 for (CUList::iterator i = ulist->begin(); i != ulist->end(); i++)
1092 // The first parameter gets a : before it
1093 size_t ptrlen = snprintf(ptr, MAXBUF, " %s%s,%s", !numusers ? ":" : "", c->GetAllPrefixChars(i->second), i->second->nick);
1100 if (curlen > (480-NICKMAX))
1102 buffer.append(list).append("\r\n");
1103 dlen = curlen = snprintf(list,MAXBUF,":%s FJOIN %s %lu",this->Instance->Config->ServerName,c->name,(unsigned long)c->age);
1111 buffer.append(list).append("\r\n");
1113 /* Sorry for the hax. Because newly created channels assume +nt,
1114 * if this channel doesnt have +nt, explicitly send -n and -t for the missing modes.
1116 bool inverted = false;
1117 if (!c->IsModeSet('n'))
1122 if (!c->IsModeSet('t'))
1132 buffer.append(":").append(this->Instance->Config->ServerName).append(" FMODE ").append(c->name).append(" ").append(ConvToStr(c->age)).append(" +").append(c->ChanModes(true)).append("\r\n");
1135 for (BanList::iterator b = c->bans.begin(); b != c->bans.end(); b++)
1137 int size = strlen(b->data) + 2;
1138 int currsize = linesize + size;
1139 if (currsize <= 350)
1142 params.append(" ").append(b->data);
1145 if ((params.length() >= MAXMODES) || (currsize > 350))
1147 /* Wrap at MAXMODES */
1148 buffer.append(":").append(this->Instance->Config->ServerName).append(" FMODE ").append(c->name).append(" ").append(ConvToStr(c->age)).append(" +").append(modes).append(params).append("\r\n");
1155 /* Only send these if there are any */
1157 buffer.append(":").append(this->Instance->Config->ServerName).append(" FMODE ").append(c->name).append(" ").append(ConvToStr(c->age)).append(" +").append(modes).append(params);
1159 this->WriteLine(buffer);
1162 /** Send G, Q, Z and E lines */
1163 void TreeSocket::SendXLines(TreeServer* Current)
1167 std::string n = this->Instance->Config->ServerName;
1168 const char* sn = n.c_str();
1169 /* Yes, these arent too nice looking, but they get the job done */
1170 for (std::vector<ZLine*>::iterator i = Instance->XLines->zlines.begin(); i != Instance->XLines->zlines.end(); i++)
1172 snprintf(data,MAXBUF,":%s ADDLINE Z %s %s %lu %lu :%s\r\n",sn,(*i)->ipaddr,(*i)->source,(unsigned long)(*i)->set_time,(unsigned long)(*i)->duration,(*i)->reason);
1173 buffer.append(data);
1175 for (std::vector<QLine*>::iterator i = Instance->XLines->qlines.begin(); i != Instance->XLines->qlines.end(); i++)
1177 snprintf(data,MAXBUF,":%s ADDLINE Q %s %s %lu %lu :%s\r\n",sn,(*i)->nick,(*i)->source,(unsigned long)(*i)->set_time,(unsigned long)(*i)->duration,(*i)->reason);
1178 buffer.append(data);
1180 for (std::vector<GLine*>::iterator i = Instance->XLines->glines.begin(); i != Instance->XLines->glines.end(); i++)
1182 snprintf(data,MAXBUF,":%s ADDLINE G %s@%s %s %lu %lu :%s\r\n",sn,(*i)->identmask,(*i)->hostmask,(*i)->source,(unsigned long)(*i)->set_time,(unsigned long)(*i)->duration,(*i)->reason);
1183 buffer.append(data);
1185 for (std::vector<ELine*>::iterator i = Instance->XLines->elines.begin(); i != Instance->XLines->elines.end(); i++)
1187 snprintf(data,MAXBUF,":%s ADDLINE E %s@%s %s %lu %lu :%s\r\n",sn,(*i)->identmask,(*i)->hostmask,(*i)->source,(unsigned long)(*i)->set_time,(unsigned long)(*i)->duration,(*i)->reason);
1188 buffer.append(data);
1190 for (std::vector<ZLine*>::iterator i = Instance->XLines->pzlines.begin(); i != Instance->XLines->pzlines.end(); i++)
1192 snprintf(data,MAXBUF,":%s ADDLINE Z %s %s %lu %lu :%s\r\n",sn,(*i)->ipaddr,(*i)->source,(unsigned long)(*i)->set_time,(unsigned long)(*i)->duration,(*i)->reason);
1193 buffer.append(data);
1195 for (std::vector<QLine*>::iterator i = Instance->XLines->pqlines.begin(); i != Instance->XLines->pqlines.end(); i++)
1197 snprintf(data,MAXBUF,":%s ADDLINE Q %s %s %lu %lu :%s\r\n",sn,(*i)->nick,(*i)->source,(unsigned long)(*i)->set_time,(unsigned long)(*i)->duration,(*i)->reason);
1198 buffer.append(data);
1200 for (std::vector<GLine*>::iterator i = Instance->XLines->pglines.begin(); i != Instance->XLines->pglines.end(); i++)
1202 snprintf(data,MAXBUF,":%s ADDLINE G %s@%s %s %lu %lu :%s\r\n",sn,(*i)->identmask,(*i)->hostmask,(*i)->source,(unsigned long)(*i)->set_time,(unsigned long)(*i)->duration,(*i)->reason);
1203 buffer.append(data);
1205 for (std::vector<ELine*>::iterator i = Instance->XLines->pelines.begin(); i != Instance->XLines->pelines.end(); i++)
1207 snprintf(data,MAXBUF,":%s ADDLINE E %s@%s %s %lu %lu :%s\r\n",sn,(*i)->identmask,(*i)->hostmask,(*i)->source,(unsigned long)(*i)->set_time,(unsigned long)(*i)->duration,(*i)->reason);
1208 buffer.append(data);
1211 if (!buffer.empty())
1212 this->WriteLine(buffer);
1215 /** Send channel modes and topics */
1216 void TreeSocket::SendChannelModes(TreeServer* Current)
1219 std::deque<std::string> list;
1220 std::string n = this->Instance->Config->ServerName;
1221 const char* sn = n.c_str();
1222 for (chan_hash::iterator c = this->Instance->chanlist->begin(); c != this->Instance->chanlist->end(); c++)
1224 SendFJoins(Current, c->second);
1225 if (*c->second->topic)
1227 snprintf(data,MAXBUF,":%s FTOPIC %s %lu %s :%s",sn,c->second->name,(unsigned long)c->second->topicset,c->second->setby,c->second->topic);
1228 this->WriteLine(data);
1230 FOREACH_MOD_I(this->Instance,I_OnSyncChannel,OnSyncChannel(c->second,(Module*)Utils->Creator,(void*)this));
1232 c->second->GetExtList(list);
1233 for (unsigned int j = 0; j < list.size(); j++)
1235 FOREACH_MOD_I(this->Instance,I_OnSyncChannelMetaData,OnSyncChannelMetaData(c->second,(Module*)Utils->Creator,(void*)this,list[j]));
1240 /** send all users and their oper state/modes */
1241 void TreeSocket::SendUsers(TreeServer* Current)
1244 std::deque<std::string> list;
1245 std::string dataline;
1246 for (user_hash::iterator u = this->Instance->clientlist->begin(); u != this->Instance->clientlist->end(); u++)
1248 if (u->second->registered == REG_ALL)
1250 snprintf(data,MAXBUF,":%s NICK %lu %s %s %s %s +%s %s :%s",u->second->server,(unsigned long)u->second->age,u->second->nick,u->second->host,u->second->dhost,u->second->ident,u->second->FormatModes(),u->second->GetIPString(),u->second->fullname);
1251 this->WriteLine(data);
1252 if (*u->second->oper)
1254 snprintf(data,MAXBUF,":%s OPERTYPE %s", u->second->nick, u->second->oper);
1255 this->WriteLine(data);
1257 if (*u->second->awaymsg)
1259 snprintf(data,MAXBUF,":%s AWAY :%s", u->second->nick, u->second->awaymsg);
1260 this->WriteLine(data);
1262 FOREACH_MOD_I(this->Instance,I_OnSyncUser,OnSyncUser(u->second,(Module*)Utils->Creator,(void*)this));
1264 u->second->GetExtList(list);
1266 for (unsigned int j = 0; j < list.size(); j++)
1268 FOREACH_MOD_I(this->Instance,I_OnSyncUserMetaData,OnSyncUserMetaData(u->second,(Module*)Utils->Creator,(void*)this,list[j]));
1274 /** This function is called when we want to send a netburst to a local
1275 * server. There is a set order we must do this, because for example
1276 * users require their servers to exist, and channels require their
1277 * users to exist. You get the idea.
1279 void TreeSocket::DoBurst(TreeServer* s)
1281 std::string name = s->GetName();
1282 std::string burst = "BURST "+ConvToStr(Instance->Time(true));
1283 std::string endburst = "ENDBURST";
1284 this->Instance->SNO->WriteToSnoMask('l',"Bursting to \2%s\2 (Authentication: %s).", name.c_str(), this->GetTheirChallenge().empty() ? "plaintext password" : "SHA256-HMAC challenge-response");
1285 this->WriteLine(burst);
1286 /* send our version string */
1287 this->WriteLine(std::string(":")+this->Instance->Config->ServerName+" VERSION :"+this->Instance->GetVersionString());
1288 /* Send server tree */
1289 this->SendServers(Utils->TreeRoot,s,1);
1290 /* Send users and their oper status */
1292 /* Send everything else (channel modes, xlines etc) */
1293 this->SendChannelModes(s);
1294 this->SendXLines(s);
1295 FOREACH_MOD_I(this->Instance,I_OnSyncOtherMetaData,OnSyncOtherMetaData((Module*)Utils->Creator,(void*)this));
1296 this->WriteLine(endburst);
1297 this->Instance->SNO->WriteToSnoMask('l',"Finished bursting to \2"+name+"\2.");
1300 /** This function is called when we receive data from a remote
1301 * server. We buffer the data in a std::string (it doesnt stay
1302 * there for long), reading using InspSocket::Read() which can
1303 * read up to 16 kilobytes in one operation.
1305 * IF THIS FUNCTION RETURNS FALSE, THE CORE CLOSES AND DELETES
1306 * THE SOCKET OBJECT FOR US.
1308 bool TreeSocket::OnDataReady()
1310 char* data = this->Read();
1311 /* Check that the data read is a valid pointer and it has some content */
1314 this->in_buffer.append(data);
1315 /* While there is at least one new line in the buffer,
1316 * do something useful (we hope!) with it.
1318 while (in_buffer.find("\n") != std::string::npos)
1320 std::string ret = in_buffer.substr(0,in_buffer.find("\n")-1);
1321 in_buffer = in_buffer.substr(in_buffer.find("\n")+1,in_buffer.length()-in_buffer.find("\n"));
1322 /* Use rfind here not find, as theres more
1323 * chance of the \r being near the end of the
1324 * string, not the start.
1326 if (ret.find("\r") != std::string::npos)
1327 ret = in_buffer.substr(0,in_buffer.find("\r")-1);
1328 /* Process this one, abort if it
1329 * didnt return true.
1331 if (!this->ProcessLine(ret))
1338 /* EAGAIN returns an empty but non-NULL string, so this
1339 * evaluates to TRUE for EAGAIN but to FALSE for EOF.
1341 return (data && !*data);