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 // Does not change the server of quitting users because those are not in the list
64 ServerInstance->FakeClient->server = newserver;
65 const LocalUserList& list = ServerInstance->Users->local_users;
66 for (LocalUserList::const_iterator i = list.begin(); i != list.end(); ++i)
67 (*i)->server = newserver;
70 void ResetMembershipIds()
72 // Set all membership ids to 0
73 const LocalUserList& list = ServerInstance->Users->local_users;
74 for (LocalUserList::iterator i = list.begin(); i != list.end(); ++i)
77 for (User::ChanList::iterator j = user->chans.begin(); j != user->chans.end(); ++j)
83 void ModuleSpanningTree::init()
85 ServerInstance->SNO->EnableSnomask('l', "LINK");
89 Utils = new SpanningTreeUtilities(this);
90 Utils->TreeRoot = new TreeServer;
91 commands = new SpanningTreeCommands(this);
93 ServerInstance->PI = &protocolinterface;
95 delete ServerInstance->FakeClient->server;
96 SetLocalUsersServer(Utils->TreeRoot);
99 void ModuleSpanningTree::ShowLinks(TreeServer* Current, User* user, int hops)
101 std::string Parent = Utils->TreeRoot->GetName();
102 if (Current->GetParent())
104 Parent = Current->GetParent()->GetName();
107 const TreeServer::ChildServers& children = Current->GetChildren();
108 for (TreeServer::ChildServers::const_iterator i = children.begin(); i != children.end(); ++i)
110 TreeServer* server = *i;
111 if ((server->Hidden) || ((Utils->HideULines) && (server->IsULine())))
115 ShowLinks(server, user, hops+1);
120 ShowLinks(server, user, hops+1);
123 /* Don't display the line if its a uline, hide ulines is on, and the user isnt an oper */
124 if ((Utils->HideULines) && (Current->IsULine()) && (!user->IsOper()))
126 /* Or if the server is hidden and they're not an oper */
127 else if ((Current->Hidden) && (!user->IsOper()))
130 user->WriteNumeric(RPL_LINKS, "%s %s :%d %s", Current->GetName().c_str(),
131 (Utils->FlatLinks && (!user->IsOper())) ? ServerInstance->Config->ServerName.c_str() : Parent.c_str(),
132 (Utils->FlatLinks && (!user->IsOper())) ? 0 : hops,
133 Current->GetDesc().c_str());
136 void ModuleSpanningTree::HandleLinks(const std::vector<std::string>& parameters, User* user)
138 ShowLinks(Utils->TreeRoot,user,0);
139 user->WriteNumeric(RPL_ENDOFLINKS, "* :End of /LINKS list.");
142 std::string ModuleSpanningTree::TimeToStr(time_t secs)
144 time_t mins_up = secs / 60;
145 time_t hours_up = mins_up / 60;
146 time_t days_up = hours_up / 24;
148 mins_up = mins_up % 60;
149 hours_up = hours_up % 24;
150 return ((days_up ? (ConvToStr(days_up) + "d") : "")
151 + (hours_up ? (ConvToStr(hours_up) + "h") : "")
152 + (mins_up ? (ConvToStr(mins_up) + "m") : "")
153 + ConvToStr(secs) + "s");
156 void ModuleSpanningTree::DoPingChecks(time_t curtime)
159 * Cancel remote burst mode on any servers which still have it enabled due to latency/lack of data.
160 * This prevents lost REMOTECONNECT notices
162 long ts = ServerInstance->Time() * 1000 + (ServerInstance->Time_ns() / 1000000);
165 for (server_hash::iterator i = Utils->serverlist.begin(); i != Utils->serverlist.end(); i++)
167 TreeServer *s = i->second;
173 if (s->GetSocket()->GetLinkState() == DYING)
175 s->GetSocket()->Close();
179 // Do not ping servers that are not fully connected yet!
180 // Servers which are connected to us have IsLocal() == true and if they're fully connected
181 // then Socket->LinkState == CONNECTED. Servers that are linked to another server are always fully connected.
182 if (s->IsLocal() && s->GetSocket()->GetLinkState() != CONNECTED)
185 // Now do PING checks on all servers
186 // Only ping if this server needs one
187 if (curtime >= s->NextPingTime())
189 // And if they answered the last
190 if (s->AnsweredLastPing())
192 // They did, send a ping to them
193 s->SetNextPingTime(curtime + Utils->PingFreq);
194 s->GetSocket()->WriteLine(CmdBuilder("PING").push(s->GetID()));
195 s->LastPingMsec = ts;
199 // They didn't answer the last ping, if they are locally connected, get rid of them.
202 TreeSocket* sock = s->GetSocket();
203 sock->SendError("Ping timeout");
210 // If warn on ping enabled and not warned and the difference is sufficient and they didn't answer the last ping...
211 if ((Utils->PingWarnTime) && (!s->Warned) && (curtime >= s->NextPingTime() - (Utils->PingFreq - Utils->PingWarnTime)) && (!s->AnsweredLastPing()))
213 /* The server hasnt responded, send a warning to opers */
214 ServerInstance->SNO->WriteToSnoMask('l',"Server \002%s\002 has not responded to PING for %d seconds, high latency.", s->GetName().c_str(), Utils->PingWarnTime);
220 void ModuleSpanningTree::ConnectServer(Autoconnect* a, bool on_timer)
224 for(unsigned int j=0; j < a->servers.size(); j++)
226 if (Utils->FindServer(a->servers[j]))
228 // found something in this block. Should the server fail,
229 // we want to start at the start of the list, not in the
230 // middle where we left off
235 if (on_timer && a->position >= 0)
237 if (!on_timer && a->position < 0)
241 while (a->position < (int)a->servers.size())
243 Link* x = Utils->FindLink(a->servers[a->position]);
246 ServerInstance->SNO->WriteToSnoMask('l', "AUTOCONNECT: Auto-connecting server \002%s\002", x->Name.c_str());
252 // Autoconnect chain has been fully iterated; start at the beginning on the
253 // next AutoConnectServers run
257 void ModuleSpanningTree::ConnectServer(Link* x, Autoconnect* y)
261 if (InspIRCd::Match(ServerInstance->Config->ServerName, assign(x->Name), rfc_case_insensitive_map))
263 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Not connecting to myself.");
267 DNS::QueryType start_type = DNS::QUERY_AAAA;
268 if (strchr(x->IPAddr.c_str(),':'))
271 if (inet_pton(AF_INET6, x->IPAddr.c_str(), &n) < 1)
277 if (inet_aton(x->IPAddr.c_str(),&n) < 1)
281 /* Do we already have an IP? If so, no need to resolve it. */
284 /* Gave a hook, but it wasnt one we know */
285 TreeSocket* newsocket = new TreeSocket(x, y, x->IPAddr);
286 if (newsocket->GetFd() > -1)
288 /* Handled automatically on success */
292 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s.",
293 x->Name.c_str(), newsocket->getError().c_str());
294 ServerInstance->GlobalCulls.AddItem(newsocket);
299 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());
303 ServernameResolver* snr = new ServernameResolver(*DNS, x->IPAddr, x, start_type, y);
308 catch (DNS::Exception& e)
311 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason().c_str());
312 ConnectServer(y, false);
317 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
319 for (std::vector<reference<Autoconnect> >::iterator i = Utils->AutoconnectBlocks.begin(); i < Utils->AutoconnectBlocks.end(); ++i)
322 if (curtime >= x->NextConnectTime)
324 x->NextConnectTime = curtime + x->Period;
325 ConnectServer(x, true);
330 void ModuleSpanningTree::DoConnectTimeout(time_t curtime)
332 std::map<TreeSocket*, std::pair<std::string, int> >::iterator i = Utils->timeoutlist.begin();
333 while (i != Utils->timeoutlist.end())
335 TreeSocket* s = i->first;
336 std::pair<std::string, int> p = i->second;
337 std::map<TreeSocket*, std::pair<std::string, int> >::iterator me = i;
339 if (s->GetLinkState() == DYING)
341 Utils->timeoutlist.erase(me);
344 else if (curtime > s->age + p.second)
346 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002 (timeout of %d seconds)",p.first.c_str(),p.second);
347 Utils->timeoutlist.erase(me);
353 ModResult ModuleSpanningTree::HandleVersion(const std::vector<std::string>& parameters, User* user)
355 // we've already checked if pcnt > 0, so this is safe
356 TreeServer* found = Utils->FindServerMask(parameters[0]);
359 if (found == Utils->TreeRoot)
361 // Pass to default VERSION handler.
362 return MOD_RES_PASSTHRU;
365 // If an oper wants to see the version then show the full version string instead of the normal,
366 // but only if it is non-empty.
367 // If it's empty it might be that the server is still syncing (full version hasn't arrived yet)
368 // or the server is a 2.0 server and does not send a full version.
369 bool showfull = ((user->IsOper()) && (!found->GetFullVersion().empty()));
370 const std::string& Version = (showfull ? found->GetFullVersion() : found->GetVersion());
371 user->WriteNumeric(RPL_VERSION, ":%s", Version.c_str());
375 user->WriteNumeric(ERR_NOSUCHSERVER, "%s :No such server", parameters[0].c_str());
380 /* This method will attempt to get a message to a remote user.
382 void ModuleSpanningTree::RemoteMessage(User* user, const char* format, ...)
385 VAFORMAT(text, format, format);
388 user->WriteNotice(text);
390 ServerInstance->PI->SendUserNotice(user, text);
393 ModResult ModuleSpanningTree::HandleConnect(const std::vector<std::string>& parameters, User* user)
395 for (std::vector<reference<Link> >::iterator i = Utils->LinkBlocks.begin(); i < Utils->LinkBlocks.end(); i++)
398 if (InspIRCd::Match(x->Name.c_str(),parameters[0], rfc_case_insensitive_map))
400 if (InspIRCd::Match(ServerInstance->Config->ServerName, assign(x->Name), rfc_case_insensitive_map))
402 RemoteMessage(user, "*** CONNECT: Server \002%s\002 is ME, not connecting.",x->Name.c_str());
406 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
409 RemoteMessage(user, "*** CONNECT: Connecting to server: \002%s\002 (%s:%d)",x->Name.c_str(),(x->HiddenFromStats ? "<hidden>" : x->IPAddr.c_str()),x->Port);
415 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());
420 RemoteMessage(user, "*** CONNECT: No server matching \002%s\002 could be found in the config file.",parameters[0].c_str());
424 void ModuleSpanningTree::On005Numeric(std::map<std::string, std::string>& tokens)
429 void ModuleSpanningTree::OnUserInvite(User* source,User* dest,Channel* channel, time_t expiry)
431 if (IS_LOCAL(source))
433 CmdBuilder params(source, "INVITE");
434 params.push_back(dest->uuid);
435 params.push_back(channel->name);
436 params.push_int(channel->age);
437 params.push_back(ConvToStr(expiry));
442 void ModuleSpanningTree::OnPostTopicChange(User* user, Channel* chan, const std::string &topic)
444 // Drop remote events on the floor.
448 CommandFTopic::Builder(user, chan).Broadcast();
451 void ModuleSpanningTree::OnUserMessage(User* user, void* dest, int target_type, const std::string& text, char status, const CUList& exempt_list, MessageType msgtype)
456 const char* message_type = (msgtype == MSG_PRIVMSG ? "PRIVMSG" : "NOTICE");
457 if (target_type == TYPE_USER)
459 User* d = (User*) dest;
462 CmdBuilder params(user, message_type);
463 params.push_back(d->uuid);
464 params.push_last(text);
468 else if (target_type == TYPE_CHANNEL)
470 Utils->SendChannelMessage(user->uuid, (Channel*)dest, text, status, exempt_list, message_type);
472 else if (target_type == TYPE_SERVER)
474 char* target = (char*) dest;
475 CmdBuilder par(user, message_type);
476 par.push_back(target);
482 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
484 AutoConnectServers(curtime);
485 DoPingChecks(curtime);
486 DoConnectTimeout(curtime);
489 void ModuleSpanningTree::OnUserConnect(LocalUser* user)
494 CommandUID::Builder(user).Broadcast();
497 CommandOpertype::Builder(user).Broadcast();
499 for(Extensible::ExtensibleStore::const_iterator i = user->GetExtList().begin(); i != user->GetExtList().end(); i++)
501 ExtensionItem* item = i->first;
502 std::string value = item->serialize(FORMAT_NETWORK, user, i->second);
504 ServerInstance->PI->SendMetaData(user, item->name, value);
507 Utils->TreeRoot->UserCount++;
510 void ModuleSpanningTree::OnUserJoin(Membership* memb, bool sync, bool created_by_local, CUList& excepts)
512 // Only do this for local users
513 if (!IS_LOCAL(memb->user))
516 // Assign the current membership id to the new Membership and increase it
517 memb->id = currmembid++;
519 if (created_by_local)
521 CommandFJoin::Builder params(memb->chan);
528 CmdBuilder params(memb->user, "IJOIN");
529 params.push_back(memb->chan->name);
530 params.push_int(memb->id);
531 if (!memb->modes.empty())
533 params.push_back(ConvToStr(memb->chan->age));
534 params.push_back(memb->modes);
540 void ModuleSpanningTree::OnChangeHost(User* user, const std::string &newhost)
542 if (user->registered != REG_ALL || !IS_LOCAL(user))
545 CmdBuilder(user, "FHOST").push(newhost).Broadcast();
548 void ModuleSpanningTree::OnChangeName(User* user, const std::string &gecos)
550 if (user->registered != REG_ALL || !IS_LOCAL(user))
553 CmdBuilder(user, "FNAME").push_last(gecos).Broadcast();
556 void ModuleSpanningTree::OnChangeIdent(User* user, const std::string &ident)
558 if ((user->registered != REG_ALL) || (!IS_LOCAL(user)))
561 CmdBuilder(user, "FIDENT").push(ident).Broadcast();
564 void ModuleSpanningTree::OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts)
566 if (IS_LOCAL(memb->user))
568 CmdBuilder params(memb->user, "PART");
569 params.push_back(memb->chan->name);
570 if (!partmessage.empty())
571 params.push_last(partmessage);
576 void ModuleSpanningTree::OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
580 if (oper_message != reason)
581 ServerInstance->PI->SendMetaData(user, "operquit", oper_message);
583 CmdBuilder(user, "QUIT").push_last(reason).Broadcast();
587 // Hide the message if one of the following is true:
588 // - User is being quit due to a netsplit and quietbursts is on
589 // - Server is a silent uline
590 bool hide = (((this->SplitInProgress) && (Utils->quiet_bursts)) || (user->server->IsSilentULine()));
593 ServerInstance->SNO->WriteToSnoMask('Q', "Client exiting on server %s: %s (%s) [%s]",
594 user->server->GetName().c_str(), user->GetFullRealHost().c_str(), user->GetIPString().c_str(), oper_message.c_str());
598 // Regardless, We need to modify the user Counts..
599 TreeServer::Get(user)->UserCount--;
602 void ModuleSpanningTree::OnUserPostNick(User* user, const std::string &oldnick)
606 // The nick TS is updated by the core, we don't do it
607 CmdBuilder params(user, "NICK");
608 params.push_back(user->nick);
609 params.push_back(ConvToStr(user->age));
612 else if (!loopCall && user->nick == user->uuid)
614 CmdBuilder params("SAVE");
615 params.push_back(user->uuid);
616 params.push_back(ConvToStr(user->age));
621 void ModuleSpanningTree::OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts)
623 if ((!IS_LOCAL(source)) && (source != ServerInstance->FakeClient))
626 CmdBuilder params(source, "KICK");
627 params.push_back(memb->chan->name);
628 params.push_back(memb->user->uuid);
629 // If a remote user is being kicked by us then send the membership id in the kick too
630 if (!IS_LOCAL(memb->user))
631 params.push_int(memb->id);
632 params.push_last(reason);
636 void ModuleSpanningTree::OnPreRehash(User* user, const std::string ¶meter)
639 return; // Don't generate a REHASH here if we're in the middle of processing a message that generated this one
641 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "OnPreRehash called with param %s", parameter.c_str());
643 // Send out to other servers
644 if (!parameter.empty() && parameter[0] != '-')
646 CmdBuilder params((user ? user->uuid : ServerInstance->Config->GetSID()), "REHASH");
647 params.push_back(parameter);
648 params.Forward(user ? TreeServer::Get(user)->GetRoute() : NULL);
652 void ModuleSpanningTree::ReadConfig(ConfigStatus& status)
654 // Did this rehash change the description of this server?
655 const std::string& newdesc = ServerInstance->Config->ServerDesc;
656 if (newdesc != Utils->TreeRoot->GetDesc())
658 // Broadcast a SINFO desc message to let the network know about the new description. This is the description
659 // string that is sent in the SERVER message initially and shown for example in WHOIS.
660 // We don't need to update the field itself in the Server object - the core does that.
661 CommandSInfo::Builder(Utils->TreeRoot, "desc", newdesc).Broadcast();
664 // Re-read config stuff
667 Utils->ReadConfiguration();
669 catch (ModuleException& e)
671 // Refresh the IP cache anyway, so servers read before the error will be allowed to connect
672 Utils->RefreshIPCache();
673 // Always warn local opers with snomask +l, also warn globally (snomask +L) if the rehash was issued by a remote user
674 std::string msg = "Error in configuration: ";
675 msg.append(e.GetReason());
676 ServerInstance->SNO->WriteToSnoMask('l', msg);
677 if (status.srcuser && !IS_LOCAL(status.srcuser))
678 ServerInstance->PI->SendSNONotice('L', msg);
682 void ModuleSpanningTree::OnLoadModule(Module* mod)
686 data.append(mod->ModuleSourceFile);
687 Version v = mod->GetVersion();
688 if (!v.link_data.empty())
691 data.append(v.link_data);
693 ServerInstance->PI->SendMetaData("modules", data);
696 void ModuleSpanningTree::OnUnloadModule(Module* mod)
700 ServerInstance->PI->SendMetaData("modules", "-" + mod->ModuleSourceFile);
702 // Close all connections which use an IO hook provided by this module
703 const TreeServer::ChildServers& list = Utils->TreeRoot->GetChildren();
704 for (TreeServer::ChildServers::const_iterator i = list.begin(); i != list.end(); ++i)
706 TreeSocket* sock = (*i)->GetSocket();
707 if (sock->GetIOHook() && sock->GetIOHook()->prov->creator == mod)
709 sock->SendError("SSL module unloaded");
714 for (SpanningTreeUtilities::TimeoutList::const_iterator i = Utils->timeoutlist.begin(); i != Utils->timeoutlist.end(); ++i)
716 TreeSocket* sock = i->first;
717 if (sock->GetIOHook() && sock->GetIOHook()->prov->creator == mod)
722 // note: the protocol does not allow direct umode +o except
723 // via NICK with 8 params. sending OPERTYPE infers +o modechange
725 void ModuleSpanningTree::OnOper(User* user, const std::string &opertype)
727 if (user->registered != REG_ALL || !IS_LOCAL(user))
729 CommandOpertype::Builder(user).Broadcast();
732 void ModuleSpanningTree::OnAddLine(User* user, XLine *x)
734 if (!x->IsBurstable() || loopCall || (user && !IS_LOCAL(user)))
738 user = ServerInstance->FakeClient;
740 CommandAddLine::Builder(x, user).Broadcast();
743 void ModuleSpanningTree::OnDelLine(User* user, XLine *x)
745 if (!x->IsBurstable() || loopCall || (user && !IS_LOCAL(user)))
749 user = ServerInstance->FakeClient;
751 CmdBuilder params(user, "DELLINE");
752 params.push_back(x->type);
753 params.push_back(x->Displayable());
757 ModResult ModuleSpanningTree::OnSetAway(User* user, const std::string &awaymsg)
760 CommandAway::Builder(user, awaymsg).Broadcast();
762 return MOD_RES_PASSTHRU;
765 CullResult ModuleSpanningTree::cull()
769 return this->Module::cull();
772 ModuleSpanningTree::~ModuleSpanningTree()
774 ServerInstance->PI = &ServerInstance->DefaultProtocolInterface;
776 Server* newsrv = new Server(ServerInstance->Config->ServerName, ServerInstance->Config->ServerDesc);
777 SetLocalUsersServer(newsrv);
779 /* This will also free the listeners */
785 Version ModuleSpanningTree::GetVersion()
787 return Version("Allows servers to be linked", VF_VENDOR);
790 /* It is IMPORTANT that m_spanningtree is the last module in the chain
791 * so that any activity it sees is FINAL, e.g. we arent going to send out
792 * a NICK message before m_cloaking has finished putting the +x on the user,
794 * Therefore, we return PRIORITY_LAST to make sure we end up at the END of
795 * the module call queue.
797 void ModuleSpanningTree::Prioritize()
799 ServerInstance->Modules->SetPriority(this, PRIORITY_LAST);
802 MODULE_INIT(ModuleSpanningTree)