2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2007-2009 Craig Edwards <craigedwards@brainbox.cc>
6 * Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
7 * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
8 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
10 * This file is part of InspIRCd. InspIRCd is free software: you can
11 * redistribute it and/or modify it under the terms of the GNU General Public
12 * License as published by the Free Software Foundation, version 2.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
29 #include "resolvers.h"
32 #include "treeserver.h"
34 #include "treesocket.h"
37 ModuleSpanningTree::ModuleSpanningTree()
38 : rconnect(this), rsquit(this), map(this)
43 , SplitInProgress(false)
47 SpanningTreeCommands::SpanningTreeCommands(ModuleSpanningTree* module)
48 : svsjoin(module), svspart(module), svsnick(module), metadata(module),
49 uid(module), opertype(module), fjoin(module), ijoin(module), resync(module),
50 fmode(module), ftopic(module), fhost(module), fident(module), fname(module),
51 away(module), addline(module), delline(module), encap(module), idle(module),
52 nick(module), ping(module), pong(module), push(module), save(module),
53 server(module), squit(module), snonotice(module),
54 burst(module), endburst(module), sinfo(module)
60 void SetLocalUsersServer(Server* newserver)
62 ServerInstance->FakeClient->server = newserver;
63 const LocalUserList& list = ServerInstance->Users->local_users;
64 for (LocalUserList::const_iterator i = list.begin(); i != list.end(); ++i)
65 (*i)->server = newserver;
68 void ResetMembershipIds()
70 // Set all membership ids to 0
71 const LocalUserList& list = ServerInstance->Users->local_users;
72 for (LocalUserList::iterator i = list.begin(); i != list.end(); ++i)
75 for (UCListIter j = user->chans.begin(); j != user->chans.end(); ++j)
81 void ModuleSpanningTree::init()
83 ServerInstance->SNO->EnableSnomask('l', "LINK");
87 Utils = new SpanningTreeUtilities(this);
88 Utils->TreeRoot = new TreeServer;
89 commands = new SpanningTreeCommands(this);
91 ServerInstance->PI = &protocolinterface;
93 delete ServerInstance->FakeClient->server;
94 SetLocalUsersServer(Utils->TreeRoot);
97 void ModuleSpanningTree::ShowLinks(TreeServer* Current, User* user, int hops)
99 std::string Parent = Utils->TreeRoot->GetName();
100 if (Current->GetParent())
102 Parent = Current->GetParent()->GetName();
105 const TreeServer::ChildServers& children = Current->GetChildren();
106 for (TreeServer::ChildServers::const_iterator i = children.begin(); i != children.end(); ++i)
108 TreeServer* server = *i;
109 if ((server->Hidden) || ((Utils->HideULines) && (server->IsULine())))
113 ShowLinks(server, user, hops+1);
118 ShowLinks(server, user, hops+1);
121 /* Don't display the line if its a uline, hide ulines is on, and the user isnt an oper */
122 if ((Utils->HideULines) && (Current->IsULine()) && (!user->IsOper()))
124 /* Or if the server is hidden and they're not an oper */
125 else if ((Current->Hidden) && (!user->IsOper()))
128 user->WriteNumeric(RPL_LINKS, "%s %s :%d %s", Current->GetName().c_str(),
129 (Utils->FlatLinks && (!user->IsOper())) ? ServerInstance->Config->ServerName.c_str() : Parent.c_str(),
130 (Utils->FlatLinks && (!user->IsOper())) ? 0 : hops,
131 Current->GetDesc().c_str());
134 void ModuleSpanningTree::HandleLinks(const std::vector<std::string>& parameters, User* user)
136 ShowLinks(Utils->TreeRoot,user,0);
137 user->WriteNumeric(RPL_ENDOFLINKS, "* :End of /LINKS list.");
140 std::string ModuleSpanningTree::TimeToStr(time_t secs)
142 time_t mins_up = secs / 60;
143 time_t hours_up = mins_up / 60;
144 time_t days_up = hours_up / 24;
146 mins_up = mins_up % 60;
147 hours_up = hours_up % 24;
148 return ((days_up ? (ConvToStr(days_up) + "d") : "")
149 + (hours_up ? (ConvToStr(hours_up) + "h") : "")
150 + (mins_up ? (ConvToStr(mins_up) + "m") : "")
151 + ConvToStr(secs) + "s");
154 void ModuleSpanningTree::DoPingChecks(time_t curtime)
157 * Cancel remote burst mode on any servers which still have it enabled due to latency/lack of data.
158 * This prevents lost REMOTECONNECT notices
160 long ts = ServerInstance->Time() * 1000 + (ServerInstance->Time_ns() / 1000000);
163 for (server_hash::iterator i = Utils->serverlist.begin(); i != Utils->serverlist.end(); i++)
165 TreeServer *s = i->second;
171 if (s->GetSocket()->GetLinkState() == DYING)
173 s->GetSocket()->Close();
177 // Do not ping servers that are not fully connected yet!
178 // Servers which are connected to us have IsLocal() == true and if they're fully connected
179 // then Socket->LinkState == CONNECTED. Servers that are linked to another server are always fully connected.
180 if (s->IsLocal() && s->GetSocket()->GetLinkState() != CONNECTED)
183 // Now do PING checks on all servers
184 // Only ping if this server needs one
185 if (curtime >= s->NextPingTime())
187 // And if they answered the last
188 if (s->AnsweredLastPing())
190 // They did, send a ping to them
191 s->SetNextPingTime(curtime + Utils->PingFreq);
192 s->GetSocket()->WriteLine(":" + ServerInstance->Config->GetSID() + " PING " + s->GetID());
193 s->LastPingMsec = ts;
197 // They didn't answer the last ping, if they are locally connected, get rid of them.
200 TreeSocket* sock = s->GetSocket();
201 sock->SendError("Ping timeout");
208 // If warn on ping enabled and not warned and the difference is sufficient and they didn't answer the last ping...
209 if ((Utils->PingWarnTime) && (!s->Warned) && (curtime >= s->NextPingTime() - (Utils->PingFreq - Utils->PingWarnTime)) && (!s->AnsweredLastPing()))
211 /* The server hasnt responded, send a warning to opers */
212 ServerInstance->SNO->WriteToSnoMask('l',"Server \002%s\002 has not responded to PING for %d seconds, high latency.", s->GetName().c_str(), Utils->PingWarnTime);
218 void ModuleSpanningTree::ConnectServer(Autoconnect* a, bool on_timer)
222 for(unsigned int j=0; j < a->servers.size(); j++)
224 if (Utils->FindServer(a->servers[j]))
226 // found something in this block. Should the server fail,
227 // we want to start at the start of the list, not in the
228 // middle where we left off
233 if (on_timer && a->position >= 0)
235 if (!on_timer && a->position < 0)
239 while (a->position < (int)a->servers.size())
241 Link* x = Utils->FindLink(a->servers[a->position]);
244 ServerInstance->SNO->WriteToSnoMask('l', "AUTOCONNECT: Auto-connecting server \002%s\002", x->Name.c_str());
250 // Autoconnect chain has been fully iterated; start at the beginning on the
251 // next AutoConnectServers run
255 void ModuleSpanningTree::ConnectServer(Link* x, Autoconnect* y)
259 if (InspIRCd::Match(ServerInstance->Config->ServerName, assign(x->Name), rfc_case_insensitive_map))
261 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Not connecting to myself.");
265 DNS::QueryType start_type = DNS::QUERY_AAAA;
266 if (strchr(x->IPAddr.c_str(),':'))
269 if (inet_pton(AF_INET6, x->IPAddr.c_str(), &n) < 1)
275 if (inet_aton(x->IPAddr.c_str(),&n) < 1)
279 /* Do we already have an IP? If so, no need to resolve it. */
282 /* Gave a hook, but it wasnt one we know */
283 TreeSocket* newsocket = new TreeSocket(x, y, x->IPAddr);
284 if (newsocket->GetFd() > -1)
286 /* Handled automatically on success */
290 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s.",
291 x->Name.c_str(), newsocket->getError().c_str());
292 ServerInstance->GlobalCulls.AddItem(newsocket);
297 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: Hostname given and m_dns.so is not loaded, unable to resolve.", x->Name.c_str());
301 ServernameResolver* snr = new ServernameResolver(*DNS, x->IPAddr, x, start_type, y);
306 catch (DNS::Exception& e)
309 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason().c_str());
310 ConnectServer(y, false);
315 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
317 for (std::vector<reference<Autoconnect> >::iterator i = Utils->AutoconnectBlocks.begin(); i < Utils->AutoconnectBlocks.end(); ++i)
320 if (curtime >= x->NextConnectTime)
322 x->NextConnectTime = curtime + x->Period;
323 ConnectServer(x, true);
328 void ModuleSpanningTree::DoConnectTimeout(time_t curtime)
330 std::map<TreeSocket*, std::pair<std::string, int> >::iterator i = Utils->timeoutlist.begin();
331 while (i != Utils->timeoutlist.end())
333 TreeSocket* s = i->first;
334 std::pair<std::string, int> p = i->second;
335 std::map<TreeSocket*, std::pair<std::string, int> >::iterator me = i;
337 if (s->GetLinkState() == DYING)
339 Utils->timeoutlist.erase(me);
342 else if (curtime > s->age + p.second)
344 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002 (timeout of %d seconds)",p.first.c_str(),p.second);
345 Utils->timeoutlist.erase(me);
351 ModResult ModuleSpanningTree::HandleVersion(const std::vector<std::string>& parameters, User* user)
353 // we've already checked if pcnt > 0, so this is safe
354 TreeServer* found = Utils->FindServerMask(parameters[0]);
357 if (found == Utils->TreeRoot)
359 // Pass to default VERSION handler.
360 return MOD_RES_PASSTHRU;
363 // If an oper wants to see the version then show the full version string instead of the normal,
364 // but only if it is non-empty.
365 // If it's empty it might be that the server is still syncing (full version hasn't arrived yet)
366 // or the server is a 2.0 server and does not send a full version.
367 bool showfull = ((user->IsOper()) && (!found->GetFullVersion().empty()));
368 const std::string& Version = (showfull ? found->GetFullVersion() : found->GetVersion());
369 user->WriteNumeric(RPL_VERSION, ":%s", Version.c_str());
373 user->WriteNumeric(ERR_NOSUCHSERVER, "%s :No such server", parameters[0].c_str());
378 /* This method will attempt to get a message to a remote user.
380 void ModuleSpanningTree::RemoteMessage(User* user, const char* format, ...)
383 VAFORMAT(text, format, format);
386 user->WriteNotice(text);
388 ServerInstance->PI->SendUserNotice(user, text);
391 ModResult ModuleSpanningTree::HandleConnect(const std::vector<std::string>& parameters, User* user)
393 for (std::vector<reference<Link> >::iterator i = Utils->LinkBlocks.begin(); i < Utils->LinkBlocks.end(); i++)
396 if (InspIRCd::Match(x->Name.c_str(),parameters[0], rfc_case_insensitive_map))
398 if (InspIRCd::Match(ServerInstance->Config->ServerName, assign(x->Name), rfc_case_insensitive_map))
400 RemoteMessage(user, "*** CONNECT: Server \002%s\002 is ME, not connecting.",x->Name.c_str());
404 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
407 RemoteMessage(user, "*** CONNECT: Connecting to server: \002%s\002 (%s:%d)",x->Name.c_str(),(x->HiddenFromStats ? "<hidden>" : x->IPAddr.c_str()),x->Port);
413 RemoteMessage(user, "*** CONNECT: Server \002%s\002 already exists on the network and is connected via \002%s\002", x->Name.c_str(), CheckDupe->GetParent()->GetName().c_str());
418 RemoteMessage(user, "*** CONNECT: No server matching \002%s\002 could be found in the config file.",parameters[0].c_str());
422 void ModuleSpanningTree::On005Numeric(std::map<std::string, std::string>& tokens)
427 void ModuleSpanningTree::OnUserInvite(User* source,User* dest,Channel* channel, time_t expiry)
429 if (IS_LOCAL(source))
431 CmdBuilder params(source, "INVITE");
432 params.push_back(dest->uuid);
433 params.push_back(channel->name);
434 params.push_int(channel->age);
435 params.push_back(ConvToStr(expiry));
440 void ModuleSpanningTree::OnPostTopicChange(User* user, Channel* chan, const std::string &topic)
442 // Drop remote events on the floor.
446 CommandFTopic::Builder(user, chan).Broadcast();
449 void ModuleSpanningTree::OnUserMessage(User* user, void* dest, int target_type, const std::string& text, char status, const CUList& exempt_list, MessageType msgtype)
454 const char* message_type = (msgtype == MSG_PRIVMSG ? "PRIVMSG" : "NOTICE");
455 if (target_type == TYPE_USER)
457 User* d = (User*) dest;
460 CmdBuilder params(user, message_type);
461 params.push_back(d->uuid);
462 params.push_last(text);
466 else if (target_type == TYPE_CHANNEL)
468 Utils->SendChannelMessage(user->uuid, (Channel*)dest, text, status, exempt_list, message_type);
470 else if (target_type == TYPE_SERVER)
472 char* target = (char*) dest;
473 CmdBuilder par(user, message_type);
474 par.push_back(target);
480 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
482 AutoConnectServers(curtime);
483 DoPingChecks(curtime);
484 DoConnectTimeout(curtime);
487 void ModuleSpanningTree::OnUserConnect(LocalUser* user)
492 CommandUID::Builder(user).Broadcast();
495 CommandOpertype::Builder(user).Broadcast();
497 for(Extensible::ExtensibleStore::const_iterator i = user->GetExtList().begin(); i != user->GetExtList().end(); i++)
499 ExtensionItem* item = i->first;
500 std::string value = item->serialize(FORMAT_NETWORK, user, i->second);
502 ServerInstance->PI->SendMetaData(user, item->name, value);
505 Utils->TreeRoot->UserCount++;
508 void ModuleSpanningTree::OnUserJoin(Membership* memb, bool sync, bool created_by_local, CUList& excepts)
510 // Only do this for local users
511 if (!IS_LOCAL(memb->user))
514 // Assign the current membership id to the new Membership and increase it
515 memb->id = currmembid++;
517 if (created_by_local)
519 CommandFJoin::Builder params(memb->chan);
526 CmdBuilder params(memb->user, "IJOIN");
527 params.push_back(memb->chan->name);
528 params.push_int(memb->id);
529 if (!memb->modes.empty())
531 params.push_back(ConvToStr(memb->chan->age));
532 params.push_back(memb->modes);
538 void ModuleSpanningTree::OnChangeHost(User* user, const std::string &newhost)
540 if (user->registered != REG_ALL || !IS_LOCAL(user))
543 CmdBuilder(user, "FHOST").push(newhost).Broadcast();
546 void ModuleSpanningTree::OnChangeName(User* user, const std::string &gecos)
548 if (user->registered != REG_ALL || !IS_LOCAL(user))
551 CmdBuilder(user, "FNAME").push_last(gecos).Broadcast();
554 void ModuleSpanningTree::OnChangeIdent(User* user, const std::string &ident)
556 if ((user->registered != REG_ALL) || (!IS_LOCAL(user)))
559 CmdBuilder(user, "FIDENT").push(ident).Broadcast();
562 void ModuleSpanningTree::OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts)
564 if (IS_LOCAL(memb->user))
566 CmdBuilder params(memb->user, "PART");
567 params.push_back(memb->chan->name);
568 if (!partmessage.empty())
569 params.push_last(partmessage);
574 void ModuleSpanningTree::OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
578 if (oper_message != reason)
579 ServerInstance->PI->SendMetaData(user, "operquit", oper_message);
581 CmdBuilder(user, "QUIT").push_last(reason).Broadcast();
585 // Hide the message if one of the following is true:
586 // - User is being quit due to a netsplit and quietbursts is on
587 // - Server is a silent uline
588 bool hide = (((this->SplitInProgress) && (Utils->quiet_bursts)) || (user->server->IsSilentULine()));
591 ServerInstance->SNO->WriteToSnoMask('Q', "Client exiting on server %s: %s (%s) [%s]",
592 user->server->GetName().c_str(), user->GetFullRealHost().c_str(), user->GetIPString().c_str(), oper_message.c_str());
596 // Regardless, We need to modify the user Counts..
597 TreeServer::Get(user)->UserCount--;
600 void ModuleSpanningTree::OnUserPostNick(User* user, const std::string &oldnick)
604 // The nick TS is updated by the core, we don't do it
605 CmdBuilder params(user, "NICK");
606 params.push_back(user->nick);
607 params.push_back(ConvToStr(user->age));
610 else if (!loopCall && user->nick == user->uuid)
612 CmdBuilder params("SAVE");
613 params.push_back(user->uuid);
614 params.push_back(ConvToStr(user->age));
619 void ModuleSpanningTree::OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts)
621 if ((!IS_LOCAL(source)) && (source != ServerInstance->FakeClient))
624 CmdBuilder params(source, "KICK");
625 params.push_back(memb->chan->name);
626 params.push_back(memb->user->uuid);
627 // If a remote user is being kicked by us then send the membership id in the kick too
628 if (!IS_LOCAL(memb->user))
629 params.push_int(memb->id);
630 params.push_last(reason);
634 void ModuleSpanningTree::OnPreRehash(User* user, const std::string ¶meter)
637 return; // Don't generate a REHASH here if we're in the middle of processing a message that generated this one
639 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "OnPreRehash called with param %s", parameter.c_str());
641 // Send out to other servers
642 if (!parameter.empty() && parameter[0] != '-')
644 CmdBuilder params((user ? user->uuid : ServerInstance->Config->GetSID()), "REHASH");
645 params.push_back(parameter);
646 params.Forward(user ? TreeServer::Get(user)->GetRoute() : NULL);
650 void ModuleSpanningTree::ReadConfig(ConfigStatus& status)
652 // Did this rehash change the description of this server?
653 const std::string& newdesc = ServerInstance->Config->ServerDesc;
654 if (newdesc != Utils->TreeRoot->GetDesc())
656 // Broadcast a SINFO desc message to let the network know about the new description. This is the description
657 // string that is sent in the SERVER message initially and shown for example in WHOIS.
658 // We don't need to update the field itself in the Server object - the core does that.
659 CommandSInfo::Builder(Utils->TreeRoot, "desc", newdesc).Broadcast();
662 // Re-read config stuff
665 Utils->ReadConfiguration();
667 catch (ModuleException& e)
669 // Refresh the IP cache anyway, so servers read before the error will be allowed to connect
670 Utils->RefreshIPCache();
671 // Always warn local opers with snomask +l, also warn globally (snomask +L) if the rehash was issued by a remote user
672 std::string msg = "Error in configuration: ";
673 msg.append(e.GetReason());
674 ServerInstance->SNO->WriteToSnoMask('l', msg);
675 if (status.srcuser && !IS_LOCAL(status.srcuser))
676 ServerInstance->PI->SendSNONotice('L', msg);
680 void ModuleSpanningTree::OnLoadModule(Module* mod)
684 data.append(mod->ModuleSourceFile);
685 Version v = mod->GetVersion();
686 if (!v.link_data.empty())
689 data.append(v.link_data);
691 ServerInstance->PI->SendMetaData("modules", data);
694 void ModuleSpanningTree::OnUnloadModule(Module* mod)
698 ServerInstance->PI->SendMetaData("modules", "-" + mod->ModuleSourceFile);
700 // Close all connections which use an IO hook provided by this module
701 const TreeServer::ChildServers& list = Utils->TreeRoot->GetChildren();
702 for (TreeServer::ChildServers::const_iterator i = list.begin(); i != list.end(); ++i)
704 TreeSocket* sock = (*i)->GetSocket();
705 if (sock->GetIOHook() && sock->GetIOHook()->prov->creator == mod)
707 sock->SendError("SSL module unloaded");
712 for (SpanningTreeUtilities::TimeoutList::const_iterator i = Utils->timeoutlist.begin(); i != Utils->timeoutlist.end(); ++i)
714 TreeSocket* sock = i->first;
715 if (sock->GetIOHook() && sock->GetIOHook()->prov->creator == mod)
720 // note: the protocol does not allow direct umode +o except
721 // via NICK with 8 params. sending OPERTYPE infers +o modechange
723 void ModuleSpanningTree::OnOper(User* user, const std::string &opertype)
725 if (user->registered != REG_ALL || !IS_LOCAL(user))
727 CommandOpertype::Builder(user).Broadcast();
730 void ModuleSpanningTree::OnAddLine(User* user, XLine *x)
732 if (!x->IsBurstable() || loopCall || (user && !IS_LOCAL(user)))
736 user = ServerInstance->FakeClient;
738 CommandAddLine::Builder(x, user).Broadcast();
741 void ModuleSpanningTree::OnDelLine(User* user, XLine *x)
743 if (!x->IsBurstable() || loopCall || (user && !IS_LOCAL(user)))
747 user = ServerInstance->FakeClient;
749 CmdBuilder params(user, "DELLINE");
750 params.push_back(x->type);
751 params.push_back(x->Displayable());
755 ModResult ModuleSpanningTree::OnSetAway(User* user, const std::string &awaymsg)
758 CommandAway::Builder(user, awaymsg).Broadcast();
760 return MOD_RES_PASSTHRU;
763 CullResult ModuleSpanningTree::cull()
767 return this->Module::cull();
770 ModuleSpanningTree::~ModuleSpanningTree()
772 ServerInstance->PI = &ServerInstance->DefaultProtocolInterface;
774 Server* newsrv = new Server(ServerInstance->Config->ServerName, ServerInstance->Config->ServerDesc);
775 SetLocalUsersServer(newsrv);
777 /* This will also free the listeners */
783 Version ModuleSpanningTree::GetVersion()
785 return Version("Allows servers to be linked", VF_VENDOR);
788 /* It is IMPORTANT that m_spanningtree is the last module in the chain
789 * so that any activity it sees is FINAL, e.g. we arent going to send out
790 * a NICK message before m_cloaking has finished putting the +x on the user,
792 * Therefore, we return PRIORITY_LAST to make sure we end up at the END of
793 * the module call queue.
795 void ModuleSpanningTree::Prioritize()
797 ServerInstance->Modules->SetPriority(this, PRIORITY_LAST);
800 MODULE_INIT(ModuleSpanningTree)