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/>.
28 #include "modules/server.h"
30 #include "resolvers.h"
33 #include "treeserver.h"
35 #include "treesocket.h"
37 #include "translate.h"
39 ModuleSpanningTree::ModuleSpanningTree()
40 : Away::EventListener(this)
41 , Stats::EventListener(this)
47 , eventprov(this, "event/server")
50 , tagevprov(this, "event/messagetag")
55 SpanningTreeCommands::SpanningTreeCommands(ModuleSpanningTree* module)
56 : svsjoin(module), svspart(module), svsnick(module), metadata(module),
57 uid(module), opertype(module), fjoin(module), ijoin(module), resync(module),
58 fmode(module), ftopic(module), fhost(module), fident(module), fname(module),
59 away(module), addline(module), delline(module), encap(module), idle(module),
60 nick(module), ping(module), pong(module), save(module),
61 server(module), squit(module), snonotice(module),
62 endburst(module), sinfo(module), num(module)
68 void SetLocalUsersServer(Server* newserver)
70 // Does not change the server of quitting users because those are not in the list
72 ServerInstance->FakeClient->server = newserver;
73 const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers();
74 for (UserManager::LocalList::const_iterator i = list.begin(); i != list.end(); ++i)
75 (*i)->server = newserver;
78 void ResetMembershipIds()
80 // Set all membership ids to 0
81 const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers();
82 for (UserManager::LocalList::iterator i = list.begin(); i != list.end(); ++i)
85 for (User::ChanList::iterator j = user->chans.begin(); j != user->chans.end(); ++j)
91 void ModuleSpanningTree::init()
93 ServerInstance->SNO->EnableSnomask('l', "LINK");
97 Utils = new SpanningTreeUtilities(this);
98 Utils->TreeRoot = new TreeServer;
100 ServerInstance->PI = &protocolinterface;
102 delete ServerInstance->FakeClient->server;
103 SetLocalUsersServer(Utils->TreeRoot);
106 void ModuleSpanningTree::ShowLinks(TreeServer* Current, User* user, int hops)
108 std::string Parent = Utils->TreeRoot->GetName();
109 if (Current->GetParent())
111 Parent = Current->GetParent()->GetName();
114 const TreeServer::ChildServers& children = Current->GetChildren();
115 for (TreeServer::ChildServers::const_iterator i = children.begin(); i != children.end(); ++i)
117 TreeServer* server = *i;
118 if ((server->Hidden) || ((Utils->HideULines) && (server->IsULine())))
122 ShowLinks(server, user, hops+1);
127 ShowLinks(server, user, hops+1);
130 /* Don't display the line if its a uline, hide ulines is on, and the user isnt an oper */
131 if ((Utils->HideULines) && (Current->IsULine()) && (!user->IsOper()))
133 /* Or if the server is hidden and they're not an oper */
134 else if ((Current->Hidden) && (!user->IsOper()))
137 user->WriteNumeric(RPL_LINKS, Current->GetName(),
138 (((Utils->FlatLinks) && (!user->IsOper())) ? ServerInstance->Config->ServerName : Parent),
139 InspIRCd::Format("%d %s", (((Utils->FlatLinks) && (!user->IsOper())) ? 0 : hops), Current->GetDesc().c_str()));
142 void ModuleSpanningTree::HandleLinks(const CommandBase::Params& parameters, User* user)
144 ShowLinks(Utils->TreeRoot,user,0);
145 user->WriteNumeric(RPL_ENDOFLINKS, '*', "End of /LINKS list.");
148 void ModuleSpanningTree::ConnectServer(Autoconnect* a, bool on_timer)
152 for(unsigned int j=0; j < a->servers.size(); j++)
154 if (Utils->FindServer(a->servers[j]))
156 // found something in this block. Should the server fail,
157 // we want to start at the start of the list, not in the
158 // middle where we left off
163 if (on_timer && a->position >= 0)
165 if (!on_timer && a->position < 0)
169 while (a->position < (int)a->servers.size())
171 Link* x = Utils->FindLink(a->servers[a->position]);
174 ServerInstance->SNO->WriteToSnoMask('l', "AUTOCONNECT: Auto-connecting server \002%s\002", x->Name.c_str());
180 // Autoconnect chain has been fully iterated; start at the beginning on the
181 // next AutoConnectServers run
185 void ModuleSpanningTree::ConnectServer(Link* x, Autoconnect* y)
187 if (InspIRCd::Match(ServerInstance->Config->ServerName, x->Name, ascii_case_insensitive_map))
189 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Not connecting to myself.");
193 irc::sockets::sockaddrs sa;
194 if (x->IPAddr.find('/') != std::string::npos)
196 if (!irc::sockets::isunix(x->IPAddr) || !irc::sockets::untosa(x->IPAddr, sa))
198 // We don't use the family() != AF_UNSPEC check below for UNIX sockets as
199 // that results in a DNS lookup.
200 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s is not a UNIX socket!",
201 x->Name.c_str(), x->IPAddr.c_str());
207 // If this fails then the IP sa will be AF_UNSPEC.
208 irc::sockets::aptosa(x->IPAddr, x->Port, sa);
211 /* Do we already have an IP? If so, no need to resolve it. */
212 if (sa.family() != AF_UNSPEC)
214 // Create a TreeServer object that will start connecting immediately in the background
215 TreeSocket* newsocket = new TreeSocket(x, y, sa);
216 if (newsocket->GetFd() > -1)
218 /* Handled automatically on success */
222 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s.",
223 x->Name.c_str(), newsocket->getError().c_str());
224 ServerInstance->GlobalCulls.AddItem(newsocket);
229 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: Hostname given and core_dns is not loaded, unable to resolve.", x->Name.c_str());
233 // Guess start_type from bindip aftype
234 DNS::QueryType start_type = DNS::QUERY_AAAA;
235 irc::sockets::sockaddrs bind;
236 if ((!x->Bind.empty()) && (irc::sockets::aptosa(x->Bind, 0, bind)))
238 if (bind.family() == AF_INET)
239 start_type = DNS::QUERY_A;
242 ServernameResolver* snr = new ServernameResolver(*DNS, x->IPAddr, x, start_type, y);
247 catch (DNS::Exception& e)
250 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason().c_str());
251 ConnectServer(y, false);
256 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
258 for (std::vector<reference<Autoconnect> >::iterator i = Utils->AutoconnectBlocks.begin(); i < Utils->AutoconnectBlocks.end(); ++i)
261 if (curtime >= x->NextConnectTime)
263 x->NextConnectTime = curtime + x->Period;
264 ConnectServer(x, true);
269 void ModuleSpanningTree::DoConnectTimeout(time_t curtime)
271 SpanningTreeUtilities::TimeoutList::iterator i = Utils->timeoutlist.begin();
272 while (i != Utils->timeoutlist.end())
274 TreeSocket* s = i->first;
275 std::pair<std::string, unsigned int> p = i->second;
276 SpanningTreeUtilities::TimeoutList::iterator me = i;
278 if (s->GetLinkState() == DYING)
280 Utils->timeoutlist.erase(me);
283 else if (curtime > s->age + p.second)
285 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002 (timeout of %u seconds)",p.first.c_str(),p.second);
286 Utils->timeoutlist.erase(me);
292 ModResult ModuleSpanningTree::HandleVersion(const CommandBase::Params& parameters, User* user)
294 // We've already confirmed that !parameters.empty(), so this is safe
295 TreeServer* found = Utils->FindServerMask(parameters[0]);
298 if (found == Utils->TreeRoot)
300 // Pass to default VERSION handler.
301 return MOD_RES_PASSTHRU;
304 // If an oper wants to see the version then show the full version string instead of the normal,
305 // but only if it is non-empty.
306 // If it's empty it might be that the server is still syncing (full version hasn't arrived yet)
307 // or the server is a 2.0 server and does not send a full version.
308 bool showfull = ((user->IsOper()) && (!found->GetFullVersion().empty()));
310 Numeric::Numeric numeric(RPL_VERSION);
311 irc::tokenstream tokens(showfull ? found->GetFullVersion() : found->GetVersion());
312 for (std::string token; tokens.GetTrailing(token); )
314 user->WriteNumeric(numeric);
318 user->WriteNumeric(ERR_NOSUCHSERVER, parameters[0], "No such server");
323 ModResult ModuleSpanningTree::HandleConnect(const CommandBase::Params& parameters, User* user)
325 for (std::vector<reference<Link> >::iterator i = Utils->LinkBlocks.begin(); i < Utils->LinkBlocks.end(); i++)
328 if (InspIRCd::Match(x->Name, parameters[0], ascii_case_insensitive_map))
330 if (InspIRCd::Match(ServerInstance->Config->ServerName, x->Name, ascii_case_insensitive_map))
332 user->WriteRemoteNotice(InspIRCd::Format("*** CONNECT: Server \002%s\002 is ME, not connecting.", x->Name.c_str()));
336 TreeServer* CheckDupe = Utils->FindServer(x->Name);
339 user->WriteRemoteNotice(InspIRCd::Format("*** CONNECT: Connecting to server: \002%s\002 (%s:%d)", x->Name.c_str(), (x->HiddenFromStats ? "<hidden>" : x->IPAddr.c_str()), x->Port));
345 user->WriteRemoteNotice(InspIRCd::Format("*** 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()));
350 user->WriteRemoteNotice(InspIRCd::Format("*** CONNECT: No server matching \002%s\002 could be found in the config file.", parameters[0].c_str()));
354 void ModuleSpanningTree::OnUserInvite(User* source, User* dest, Channel* channel, time_t expiry, unsigned int notifyrank, CUList& notifyexcepts)
356 if (IS_LOCAL(source))
358 CmdBuilder params(source, "INVITE");
359 params.push_back(dest->uuid);
360 params.push_back(channel->name);
361 params.push_int(channel->age);
362 params.push_back(ConvToStr(expiry));
367 ModResult ModuleSpanningTree::OnPreTopicChange(User* user, Channel* chan, const std::string& topic)
369 // XXX: Deny topic changes if the current topic set time is the current time or is in the future because
370 // other servers will drop our FTOPIC. This restriction will be removed when the protocol is updated.
371 if ((chan->topicset >= ServerInstance->Time()) && (Utils->serverlist.size() > 1))
373 user->WriteNumeric(ERR_CHANOPRIVSNEEDED, chan->name, "Retry topic change later");
376 return MOD_RES_PASSTHRU;
379 void ModuleSpanningTree::OnPostTopicChange(User* user, Channel* chan, const std::string &topic)
381 // Drop remote events on the floor.
385 CommandFTopic::Builder(user, chan).Broadcast();
388 void ModuleSpanningTree::OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details)
393 const char* message_type = (details.type == MSG_PRIVMSG ? "PRIVMSG" : "NOTICE");
394 if (target.type == MessageTarget::TYPE_USER)
396 User* d = target.Get<User>();
399 CmdBuilder params(user, message_type);
400 params.push_tags(details.tags_out);
401 params.push_back(d->uuid);
402 params.push_last(details.text);
406 else if (target.type == MessageTarget::TYPE_CHANNEL)
408 Utils->SendChannelMessage(user->uuid, target.Get<Channel>(), details.text, target.status, details.tags_out, details.exemptions, message_type);
410 else if (target.type == MessageTarget::TYPE_SERVER)
412 const std::string* serverglob = target.Get<std::string>();
413 CmdBuilder par(user, message_type);
414 par.push_tags(details.tags_out);
415 par.push_back(*serverglob);
416 par.push_last(details.text);
421 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
423 AutoConnectServers(curtime);
424 DoConnectTimeout(curtime);
427 void ModuleSpanningTree::OnUserConnect(LocalUser* user)
432 // Create the lazy ssl_cert metadata for this user if not already created.
434 sslapi->GetCertificate(user);
436 CommandUID::Builder(user).Broadcast();
439 CommandOpertype::Builder(user).Broadcast();
441 for(Extensible::ExtensibleStore::const_iterator i = user->GetExtList().begin(); i != user->GetExtList().end(); i++)
443 ExtensionItem* item = i->first;
444 std::string value = item->serialize(FORMAT_NETWORK, user, i->second);
446 ServerInstance->PI->SendMetaData(user, item->name, value);
449 Utils->TreeRoot->UserCount++;
452 void ModuleSpanningTree::OnUserJoin(Membership* memb, bool sync, bool created_by_local, CUList& excepts)
454 // Only do this for local users
455 if (!IS_LOCAL(memb->user))
458 // Assign the current membership id to the new Membership and increase it
459 memb->id = currmembid++;
461 if (created_by_local)
463 CommandFJoin::Builder params(memb->chan);
470 CmdBuilder params(memb->user, "IJOIN");
471 params.push_back(memb->chan->name);
472 params.push_int(memb->id);
473 if (!memb->modes.empty())
475 params.push_back(ConvToStr(memb->chan->age));
476 params.push_back(memb->modes);
482 void ModuleSpanningTree::OnChangeHost(User* user, const std::string &newhost)
484 if (user->registered != REG_ALL || !IS_LOCAL(user))
487 CmdBuilder(user, "FHOST").push(newhost).Broadcast();
490 void ModuleSpanningTree::OnChangeRealName(User* user, const std::string& real)
492 if (user->registered != REG_ALL || !IS_LOCAL(user))
495 CmdBuilder(user, "FNAME").push_last(real).Broadcast();
498 void ModuleSpanningTree::OnChangeIdent(User* user, const std::string &ident)
500 if ((user->registered != REG_ALL) || (!IS_LOCAL(user)))
503 CmdBuilder(user, "FIDENT").push(ident).Broadcast();
506 void ModuleSpanningTree::OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts)
508 if (IS_LOCAL(memb->user))
510 CmdBuilder params(memb->user, "PART");
511 params.push_back(memb->chan->name);
512 if (!partmessage.empty())
513 params.push_last(partmessage);
518 void ModuleSpanningTree::OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
522 if (oper_message != reason)
523 ServerInstance->PI->SendMetaData(user, "operquit", oper_message);
525 CmdBuilder(user, "QUIT").push_last(reason).Broadcast();
529 // Hide the message if one of the following is true:
530 // - User is being quit due to a netsplit and quietbursts is on
531 // - Server is a silent uline
532 TreeServer* server = TreeServer::Get(user);
533 bool hide = (((server->IsDead()) && (Utils->quiet_bursts)) || (server->IsSilentULine()));
536 ServerInstance->SNO->WriteToSnoMask('Q', "Client exiting on server %s: %s (%s) [%s]",
537 user->server->GetName().c_str(), user->GetFullRealHost().c_str(), user->GetIPString().c_str(), oper_message.c_str());
541 // Regardless, update the UserCount
542 TreeServer::Get(user)->UserCount--;
545 void ModuleSpanningTree::OnUserPostNick(User* user, const std::string &oldnick)
549 // The nick TS is updated by the core, we don't do it
550 CmdBuilder params(user, "NICK");
551 params.push_back(user->nick);
552 params.push_back(ConvToStr(user->age));
557 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "WARNING: Changed nick of remote user %s from %s to %s TS %lu by ourselves!", user->uuid.c_str(), oldnick.c_str(), user->nick.c_str(), (unsigned long) user->age);
561 void ModuleSpanningTree::OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts)
563 if ((!IS_LOCAL(source)) && (source != ServerInstance->FakeClient))
566 CmdBuilder params(source, "KICK");
567 params.push_back(memb->chan->name);
568 params.push_back(memb->user->uuid);
569 // If a remote user is being kicked by us then send the membership id in the kick too
570 if (!IS_LOCAL(memb->user))
571 params.push_int(memb->id);
572 params.push_last(reason);
576 void ModuleSpanningTree::OnPreRehash(User* user, const std::string ¶meter)
578 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "OnPreRehash called with param %s", parameter.c_str());
580 // Send out to other servers
581 if (!parameter.empty() && parameter[0] != '-')
583 CmdBuilder params((user ? user->uuid : ServerInstance->Config->GetSID()), "REHASH");
584 params.push_back(parameter);
585 params.Forward(user ? TreeServer::Get(user)->GetRoute() : NULL);
589 void ModuleSpanningTree::ReadConfig(ConfigStatus& status)
591 // Did this rehash change the description of this server?
592 const std::string& newdesc = ServerInstance->Config->ServerDesc;
593 if (newdesc != Utils->TreeRoot->GetDesc())
595 // Broadcast a SINFO desc message to let the network know about the new description. This is the description
596 // string that is sent in the SERVER message initially and shown for example in WHOIS.
597 // We don't need to update the field itself in the Server object - the core does that.
598 CommandSInfo::Builder(Utils->TreeRoot, "desc", newdesc).Broadcast();
601 // Re-read config stuff
604 Utils->ReadConfiguration();
606 catch (ModuleException& e)
608 // Refresh the IP cache anyway, so servers read before the error will be allowed to connect
609 Utils->RefreshIPCache();
610 // Always warn local opers with snomask +l, also warn globally (snomask +L) if the rehash was issued by a remote user
611 std::string msg = "Error in configuration: ";
612 msg.append(e.GetReason());
613 ServerInstance->SNO->WriteToSnoMask('l', msg);
614 if (status.srcuser && !IS_LOCAL(status.srcuser))
615 ServerInstance->PI->SendSNONotice('L', msg);
619 void ModuleSpanningTree::OnLoadModule(Module* mod)
623 data.append(mod->ModuleSourceFile);
624 Version v = mod->GetVersion();
625 if (!v.link_data.empty())
628 data.append(v.link_data);
630 ServerInstance->PI->SendMetaData("modules", data);
633 void ModuleSpanningTree::OnUnloadModule(Module* mod)
637 ServerInstance->PI->SendMetaData("modules", "-" + mod->ModuleSourceFile);
641 // We are being unloaded, inform modules about all servers splitting which cannot be done later when the servers are actually disconnected
642 const server_hash& servers = Utils->serverlist;
643 for (server_hash::const_iterator i = servers.begin(); i != servers.end(); ++i)
645 TreeServer* server = i->second;
646 if (!server->IsRoot())
647 FOREACH_MOD_CUSTOM(GetEventProvider(), ServerEventListener, OnServerSplit, (server));
652 // Some other module is being unloaded. If it provides an IOHook we use, we must close that server connection now.
655 // Close all connections which use an IO hook provided by this module
656 const TreeServer::ChildServers& list = Utils->TreeRoot->GetChildren();
657 for (TreeServer::ChildServers::const_iterator i = list.begin(); i != list.end(); ++i)
659 TreeSocket* sock = (*i)->GetSocket();
660 if (sock->GetModHook(mod))
662 sock->SendError("SSL module unloaded");
664 // XXX: The list we're iterating is modified by TreeServer::SQuit() which is called by Close()
669 for (SpanningTreeUtilities::TimeoutList::const_iterator i = Utils->timeoutlist.begin(); i != Utils->timeoutlist.end(); ++i)
671 TreeSocket* sock = i->first;
672 if (sock->GetModHook(mod))
677 void ModuleSpanningTree::OnOper(User* user, const std::string &opertype)
679 if (user->registered != REG_ALL || !IS_LOCAL(user))
682 // Note: The protocol does not allow direct umode +o;
683 // sending OPERTYPE infers +o modechange locally.
684 CommandOpertype::Builder(user).Broadcast();
687 void ModuleSpanningTree::OnAddLine(User* user, XLine *x)
689 if (!x->IsBurstable() || loopCall || (user && !IS_LOCAL(user)))
693 user = ServerInstance->FakeClient;
695 CommandAddLine::Builder(x, user).Broadcast();
698 void ModuleSpanningTree::OnDelLine(User* user, XLine *x)
700 if (!x->IsBurstable() || loopCall || (user && !IS_LOCAL(user)))
704 user = ServerInstance->FakeClient;
706 CmdBuilder params(user, "DELLINE");
707 params.push_back(x->type);
708 params.push_back(x->Displayable());
712 void ModuleSpanningTree::OnUserAway(User* user)
715 CommandAway::Builder(user).Broadcast();
718 void ModuleSpanningTree::OnUserBack(User* user)
721 CommandAway::Builder(user).Broadcast();
724 void ModuleSpanningTree::OnMode(User* source, User* u, Channel* c, const Modes::ChangeList& modes, ModeParser::ModeProcessFlag processflags)
726 if (processflags & ModeParser::MODE_LOCALONLY)
731 if (u->registered != REG_ALL)
734 CmdBuilder params(source, "MODE");
735 params.push(u->uuid);
736 params.push(ClientProtocol::Messages::Mode::ToModeLetters(modes));
737 params.push_raw(Translate::ModeChangeListToParams(modes.getlist()));
742 CmdBuilder params(source, "FMODE");
743 params.push(c->name);
744 params.push_int(c->age);
745 params.push(ClientProtocol::Messages::Mode::ToModeLetters(modes));
746 params.push_raw(Translate::ModeChangeListToParams(modes.getlist()));
751 CullResult ModuleSpanningTree::cull()
755 return this->Module::cull();
758 ModuleSpanningTree::~ModuleSpanningTree()
760 ServerInstance->PI = &ServerInstance->DefaultProtocolInterface;
762 Server* newsrv = new Server(ServerInstance->Config->ServerName, ServerInstance->Config->ServerDesc);
763 SetLocalUsersServer(newsrv);
768 Version ModuleSpanningTree::GetVersion()
770 return Version("Allows servers to be linked", VF_VENDOR);
773 /* It is IMPORTANT that m_spanningtree is the last module in the chain
774 * so that any activity it sees is FINAL, e.g. we arent going to send out
775 * a NICK message before m_cloaking has finished putting the +x on the user,
777 * Therefore, we set our priority to PRIORITY_LAST to make sure we end up at the END of
778 * the module call queue.
780 void ModuleSpanningTree::Prioritize()
782 ServerInstance->Modules->SetPriority(this, PRIORITY_LAST);
783 ServerInstance->Modules.SetPriority(this, I_OnPreTopicChange, PRIORITY_FIRST);
786 MODULE_INIT(ModuleSpanningTree)