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;
195 if (x->IPAddr.find('/') != std::string::npos)
198 if (stat(x->IPAddr.c_str(), &sb) == -1 || !S_ISSOCK(sb.st_mode) || !irc::sockets::untosa(x->IPAddr, sa))
200 // We don't use the family() != AF_UNSPEC check below for UNIX sockets as
201 // that results in a DNS lookup.
202 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s is not a UNIX socket!",
203 x->Name.c_str(), x->IPAddr.c_str());
210 // If this fails then the IP sa will be AF_UNSPEC.
211 irc::sockets::aptosa(x->IPAddr, x->Port, sa);
214 /* Do we already have an IP? If so, no need to resolve it. */
215 if (sa.family() != AF_UNSPEC)
217 // Create a TreeServer object that will start connecting immediately in the background
218 TreeSocket* newsocket = new TreeSocket(x, y, sa);
219 if (newsocket->GetFd() > -1)
221 /* Handled automatically on success */
225 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s.",
226 x->Name.c_str(), newsocket->getError().c_str());
227 ServerInstance->GlobalCulls.AddItem(newsocket);
232 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());
236 // Guess start_type from bindip aftype
237 DNS::QueryType start_type = DNS::QUERY_AAAA;
238 irc::sockets::sockaddrs bind;
239 if ((!x->Bind.empty()) && (irc::sockets::aptosa(x->Bind, 0, bind)))
241 if (bind.family() == AF_INET)
242 start_type = DNS::QUERY_A;
245 ServernameResolver* snr = new ServernameResolver(*DNS, x->IPAddr, x, start_type, y);
250 catch (DNS::Exception& e)
253 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason().c_str());
254 ConnectServer(y, false);
259 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
261 for (std::vector<reference<Autoconnect> >::iterator i = Utils->AutoconnectBlocks.begin(); i < Utils->AutoconnectBlocks.end(); ++i)
264 if (curtime >= x->NextConnectTime)
266 x->NextConnectTime = curtime + x->Period;
267 ConnectServer(x, true);
272 void ModuleSpanningTree::DoConnectTimeout(time_t curtime)
274 SpanningTreeUtilities::TimeoutList::iterator i = Utils->timeoutlist.begin();
275 while (i != Utils->timeoutlist.end())
277 TreeSocket* s = i->first;
278 std::pair<std::string, unsigned int> p = i->second;
279 SpanningTreeUtilities::TimeoutList::iterator me = i;
281 if (s->GetLinkState() == DYING)
283 Utils->timeoutlist.erase(me);
286 else if (curtime > s->age + p.second)
288 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002 (timeout of %u seconds)",p.first.c_str(),p.second);
289 Utils->timeoutlist.erase(me);
295 ModResult ModuleSpanningTree::HandleVersion(const CommandBase::Params& parameters, User* user)
297 // We've already confirmed that !parameters.empty(), so this is safe
298 TreeServer* found = Utils->FindServerMask(parameters[0]);
301 if (found == Utils->TreeRoot)
303 // Pass to default VERSION handler.
304 return MOD_RES_PASSTHRU;
307 // If an oper wants to see the version then show the full version string instead of the normal,
308 // but only if it is non-empty.
309 // If it's empty it might be that the server is still syncing (full version hasn't arrived yet)
310 // or the server is a 2.0 server and does not send a full version.
311 bool showfull = ((user->IsOper()) && (!found->GetFullVersion().empty()));
313 Numeric::Numeric numeric(RPL_VERSION);
314 irc::tokenstream tokens(showfull ? found->GetFullVersion() : found->GetVersion());
315 for (std::string token; tokens.GetTrailing(token); )
317 user->WriteNumeric(numeric);
321 user->WriteNumeric(ERR_NOSUCHSERVER, parameters[0], "No such server");
326 ModResult ModuleSpanningTree::HandleConnect(const CommandBase::Params& parameters, User* user)
328 for (std::vector<reference<Link> >::iterator i = Utils->LinkBlocks.begin(); i < Utils->LinkBlocks.end(); i++)
331 if (InspIRCd::Match(x->Name, parameters[0], ascii_case_insensitive_map))
333 if (InspIRCd::Match(ServerInstance->Config->ServerName, x->Name, ascii_case_insensitive_map))
335 user->WriteRemoteNotice(InspIRCd::Format("*** CONNECT: Server \002%s\002 is ME, not connecting.", x->Name.c_str()));
339 TreeServer* CheckDupe = Utils->FindServer(x->Name);
342 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));
348 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()));
353 user->WriteRemoteNotice(InspIRCd::Format("*** CONNECT: No server matching \002%s\002 could be found in the config file.", parameters[0].c_str()));
357 void ModuleSpanningTree::OnUserInvite(User* source, User* dest, Channel* channel, time_t expiry, unsigned int notifyrank, CUList& notifyexcepts)
359 if (IS_LOCAL(source))
361 CmdBuilder params(source, "INVITE");
362 params.push_back(dest->uuid);
363 params.push_back(channel->name);
364 params.push_int(channel->age);
365 params.push_back(ConvToStr(expiry));
370 ModResult ModuleSpanningTree::OnPreTopicChange(User* user, Channel* chan, const std::string& topic)
372 // XXX: Deny topic changes if the current topic set time is the current time or is in the future because
373 // other servers will drop our FTOPIC. This restriction will be removed when the protocol is updated.
374 if ((chan->topicset >= ServerInstance->Time()) && (Utils->serverlist.size() > 1))
376 user->WriteNumeric(ERR_CHANOPRIVSNEEDED, chan->name, "Retry topic change later");
379 return MOD_RES_PASSTHRU;
382 void ModuleSpanningTree::OnPostTopicChange(User* user, Channel* chan, const std::string &topic)
384 // Drop remote events on the floor.
388 CommandFTopic::Builder(user, chan).Broadcast();
391 void ModuleSpanningTree::OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details)
396 const char* message_type = (details.type == MSG_PRIVMSG ? "PRIVMSG" : "NOTICE");
397 if (target.type == MessageTarget::TYPE_USER)
399 User* d = target.Get<User>();
402 CmdBuilder params(user, message_type);
403 params.push_tags(details.tags_out);
404 params.push_back(d->uuid);
405 params.push_last(details.text);
409 else if (target.type == MessageTarget::TYPE_CHANNEL)
411 Utils->SendChannelMessage(user->uuid, target.Get<Channel>(), details.text, target.status, details.tags_out, details.exemptions, message_type);
413 else if (target.type == MessageTarget::TYPE_SERVER)
415 const std::string* serverglob = target.Get<std::string>();
416 CmdBuilder par(user, message_type);
417 par.push_tags(details.tags_out);
418 par.push_back(*serverglob);
419 par.push_last(details.text);
424 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
426 AutoConnectServers(curtime);
427 DoConnectTimeout(curtime);
430 void ModuleSpanningTree::OnUserConnect(LocalUser* user)
435 // Create the lazy ssl_cert metadata for this user if not already created.
437 sslapi->GetCertificate(user);
439 CommandUID::Builder(user).Broadcast();
442 CommandOpertype::Builder(user).Broadcast();
444 for(Extensible::ExtensibleStore::const_iterator i = user->GetExtList().begin(); i != user->GetExtList().end(); i++)
446 ExtensionItem* item = i->first;
447 std::string value = item->serialize(FORMAT_NETWORK, user, i->second);
449 ServerInstance->PI->SendMetaData(user, item->name, value);
452 Utils->TreeRoot->UserCount++;
455 void ModuleSpanningTree::OnUserJoin(Membership* memb, bool sync, bool created_by_local, CUList& excepts)
457 // Only do this for local users
458 if (!IS_LOCAL(memb->user))
461 // Assign the current membership id to the new Membership and increase it
462 memb->id = currmembid++;
464 if (created_by_local)
466 CommandFJoin::Builder params(memb->chan);
473 CmdBuilder params(memb->user, "IJOIN");
474 params.push_back(memb->chan->name);
475 params.push_int(memb->id);
476 if (!memb->modes.empty())
478 params.push_back(ConvToStr(memb->chan->age));
479 params.push_back(memb->modes);
485 void ModuleSpanningTree::OnChangeHost(User* user, const std::string &newhost)
487 if (user->registered != REG_ALL || !IS_LOCAL(user))
490 CmdBuilder(user, "FHOST").push(newhost).Broadcast();
493 void ModuleSpanningTree::OnChangeRealName(User* user, const std::string& real)
495 if (user->registered != REG_ALL || !IS_LOCAL(user))
498 CmdBuilder(user, "FNAME").push_last(real).Broadcast();
501 void ModuleSpanningTree::OnChangeIdent(User* user, const std::string &ident)
503 if ((user->registered != REG_ALL) || (!IS_LOCAL(user)))
506 CmdBuilder(user, "FIDENT").push(ident).Broadcast();
509 void ModuleSpanningTree::OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts)
511 if (IS_LOCAL(memb->user))
513 CmdBuilder params(memb->user, "PART");
514 params.push_back(memb->chan->name);
515 if (!partmessage.empty())
516 params.push_last(partmessage);
521 void ModuleSpanningTree::OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
525 if (oper_message != reason)
526 ServerInstance->PI->SendMetaData(user, "operquit", oper_message);
528 CmdBuilder(user, "QUIT").push_last(reason).Broadcast();
532 // Hide the message if one of the following is true:
533 // - User is being quit due to a netsplit and quietbursts is on
534 // - Server is a silent uline
535 TreeServer* server = TreeServer::Get(user);
536 bool hide = (((server->IsDead()) && (Utils->quiet_bursts)) || (server->IsSilentULine()));
539 ServerInstance->SNO->WriteToSnoMask('Q', "Client exiting on server %s: %s (%s) [%s]",
540 user->server->GetName().c_str(), user->GetFullRealHost().c_str(), user->GetIPString().c_str(), oper_message.c_str());
544 // Regardless, update the UserCount
545 TreeServer::Get(user)->UserCount--;
548 void ModuleSpanningTree::OnUserPostNick(User* user, const std::string &oldnick)
552 // The nick TS is updated by the core, we don't do it
553 CmdBuilder params(user, "NICK");
554 params.push_back(user->nick);
555 params.push_back(ConvToStr(user->age));
560 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);
564 void ModuleSpanningTree::OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts)
566 if ((!IS_LOCAL(source)) && (source != ServerInstance->FakeClient))
569 CmdBuilder params(source, "KICK");
570 params.push_back(memb->chan->name);
571 params.push_back(memb->user->uuid);
572 // If a remote user is being kicked by us then send the membership id in the kick too
573 if (!IS_LOCAL(memb->user))
574 params.push_int(memb->id);
575 params.push_last(reason);
579 void ModuleSpanningTree::OnPreRehash(User* user, const std::string ¶meter)
581 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "OnPreRehash called with param %s", parameter.c_str());
583 // Send out to other servers
584 if (!parameter.empty() && parameter[0] != '-')
586 CmdBuilder params((user ? user->uuid : ServerInstance->Config->GetSID()), "REHASH");
587 params.push_back(parameter);
588 params.Forward(user ? TreeServer::Get(user)->GetRoute() : NULL);
592 void ModuleSpanningTree::ReadConfig(ConfigStatus& status)
594 // Did this rehash change the description of this server?
595 const std::string& newdesc = ServerInstance->Config->ServerDesc;
596 if (newdesc != Utils->TreeRoot->GetDesc())
598 // Broadcast a SINFO desc message to let the network know about the new description. This is the description
599 // string that is sent in the SERVER message initially and shown for example in WHOIS.
600 // We don't need to update the field itself in the Server object - the core does that.
601 CommandSInfo::Builder(Utils->TreeRoot, "desc", newdesc).Broadcast();
604 // Re-read config stuff
607 Utils->ReadConfiguration();
609 catch (ModuleException& e)
611 // Refresh the IP cache anyway, so servers read before the error will be allowed to connect
612 Utils->RefreshIPCache();
613 // Always warn local opers with snomask +l, also warn globally (snomask +L) if the rehash was issued by a remote user
614 std::string msg = "Error in configuration: ";
615 msg.append(e.GetReason());
616 ServerInstance->SNO->WriteToSnoMask('l', msg);
617 if (status.srcuser && !IS_LOCAL(status.srcuser))
618 ServerInstance->PI->SendSNONotice('L', msg);
622 void ModuleSpanningTree::OnLoadModule(Module* mod)
626 data.append(mod->ModuleSourceFile);
627 Version v = mod->GetVersion();
628 if (!v.link_data.empty())
631 data.append(v.link_data);
633 ServerInstance->PI->SendMetaData("modules", data);
636 void ModuleSpanningTree::OnUnloadModule(Module* mod)
640 ServerInstance->PI->SendMetaData("modules", "-" + mod->ModuleSourceFile);
644 // We are being unloaded, inform modules about all servers splitting which cannot be done later when the servers are actually disconnected
645 const server_hash& servers = Utils->serverlist;
646 for (server_hash::const_iterator i = servers.begin(); i != servers.end(); ++i)
648 TreeServer* server = i->second;
649 if (!server->IsRoot())
650 FOREACH_MOD_CUSTOM(GetEventProvider(), ServerEventListener, OnServerSplit, (server));
655 // Some other module is being unloaded. If it provides an IOHook we use, we must close that server connection now.
658 // Close all connections which use an IO hook provided by this module
659 const TreeServer::ChildServers& list = Utils->TreeRoot->GetChildren();
660 for (TreeServer::ChildServers::const_iterator i = list.begin(); i != list.end(); ++i)
662 TreeSocket* sock = (*i)->GetSocket();
663 if (sock->GetModHook(mod))
665 sock->SendError("SSL module unloaded");
667 // XXX: The list we're iterating is modified by TreeServer::SQuit() which is called by Close()
672 for (SpanningTreeUtilities::TimeoutList::const_iterator i = Utils->timeoutlist.begin(); i != Utils->timeoutlist.end(); ++i)
674 TreeSocket* sock = i->first;
675 if (sock->GetModHook(mod))
680 void ModuleSpanningTree::OnOper(User* user, const std::string &opertype)
682 if (user->registered != REG_ALL || !IS_LOCAL(user))
685 // Note: The protocol does not allow direct umode +o;
686 // sending OPERTYPE infers +o modechange locally.
687 CommandOpertype::Builder(user).Broadcast();
690 void ModuleSpanningTree::OnAddLine(User* user, XLine *x)
692 if (!x->IsBurstable() || loopCall || (user && !IS_LOCAL(user)))
696 user = ServerInstance->FakeClient;
698 CommandAddLine::Builder(x, user).Broadcast();
701 void ModuleSpanningTree::OnDelLine(User* user, XLine *x)
703 if (!x->IsBurstable() || loopCall || (user && !IS_LOCAL(user)))
707 user = ServerInstance->FakeClient;
709 CmdBuilder params(user, "DELLINE");
710 params.push_back(x->type);
711 params.push_back(x->Displayable());
715 void ModuleSpanningTree::OnUserAway(User* user)
718 CommandAway::Builder(user).Broadcast();
721 void ModuleSpanningTree::OnUserBack(User* user)
724 CommandAway::Builder(user).Broadcast();
727 void ModuleSpanningTree::OnMode(User* source, User* u, Channel* c, const Modes::ChangeList& modes, ModeParser::ModeProcessFlag processflags)
729 if (processflags & ModeParser::MODE_LOCALONLY)
734 if (u->registered != REG_ALL)
737 CmdBuilder params(source, "MODE");
738 params.push(u->uuid);
739 params.push(ClientProtocol::Messages::Mode::ToModeLetters(modes));
740 params.push_raw(Translate::ModeChangeListToParams(modes.getlist()));
745 CmdBuilder params(source, "FMODE");
746 params.push(c->name);
747 params.push_int(c->age);
748 params.push(ClientProtocol::Messages::Mode::ToModeLetters(modes));
749 params.push_raw(Translate::ModeChangeListToParams(modes.getlist()));
754 CullResult ModuleSpanningTree::cull()
758 return this->Module::cull();
761 ModuleSpanningTree::~ModuleSpanningTree()
763 ServerInstance->PI = &ServerInstance->DefaultProtocolInterface;
765 Server* newsrv = new Server(ServerInstance->Config->ServerName, ServerInstance->Config->ServerDesc);
766 SetLocalUsersServer(newsrv);
771 Version ModuleSpanningTree::GetVersion()
773 return Version("Allows servers to be linked", VF_VENDOR);
776 /* It is IMPORTANT that m_spanningtree is the last module in the chain
777 * so that any activity it sees is FINAL, e.g. we arent going to send out
778 * a NICK message before m_cloaking has finished putting the +x on the user,
780 * Therefore, we set our priority to PRIORITY_LAST to make sure we end up at the END of
781 * the module call queue.
783 void ModuleSpanningTree::Prioritize()
785 ServerInstance->Modules->SetPriority(this, PRIORITY_LAST);
786 ServerInstance->Modules.SetPriority(this, I_OnPreTopicChange, PRIORITY_FIRST);
789 MODULE_INIT(ModuleSpanningTree)