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 : Stats::EventListener(this)
46 , eventprov(this, "event/server")
52 SpanningTreeCommands::SpanningTreeCommands(ModuleSpanningTree* module)
53 : svsjoin(module), svspart(module), svsnick(module), metadata(module),
54 uid(module), opertype(module), fjoin(module), ijoin(module), resync(module),
55 fmode(module), ftopic(module), fhost(module), fident(module), fname(module),
56 away(module), addline(module), delline(module), encap(module), idle(module),
57 nick(module), ping(module), pong(module), save(module),
58 server(module), squit(module), snonotice(module),
59 endburst(module), sinfo(module), num(module)
65 void SetLocalUsersServer(Server* newserver)
67 // Does not change the server of quitting users because those are not in the list
69 ServerInstance->FakeClient->server = newserver;
70 const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers();
71 for (UserManager::LocalList::const_iterator i = list.begin(); i != list.end(); ++i)
72 (*i)->server = newserver;
75 void ResetMembershipIds()
77 // Set all membership ids to 0
78 const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers();
79 for (UserManager::LocalList::iterator i = list.begin(); i != list.end(); ++i)
82 for (User::ChanList::iterator j = user->chans.begin(); j != user->chans.end(); ++j)
88 void ModuleSpanningTree::init()
90 ServerInstance->SNO->EnableSnomask('l', "LINK");
94 Utils = new SpanningTreeUtilities(this);
95 Utils->TreeRoot = new TreeServer;
97 ServerInstance->PI = &protocolinterface;
99 delete ServerInstance->FakeClient->server;
100 SetLocalUsersServer(Utils->TreeRoot);
103 void ModuleSpanningTree::ShowLinks(TreeServer* Current, User* user, int hops)
105 std::string Parent = Utils->TreeRoot->GetName();
106 if (Current->GetParent())
108 Parent = Current->GetParent()->GetName();
111 const TreeServer::ChildServers& children = Current->GetChildren();
112 for (TreeServer::ChildServers::const_iterator i = children.begin(); i != children.end(); ++i)
114 TreeServer* server = *i;
115 if ((server->Hidden) || ((Utils->HideULines) && (server->IsULine())))
119 ShowLinks(server, user, hops+1);
124 ShowLinks(server, user, hops+1);
127 /* Don't display the line if its a uline, hide ulines is on, and the user isnt an oper */
128 if ((Utils->HideULines) && (Current->IsULine()) && (!user->IsOper()))
130 /* Or if the server is hidden and they're not an oper */
131 else if ((Current->Hidden) && (!user->IsOper()))
134 user->WriteNumeric(RPL_LINKS, Current->GetName(),
135 (((Utils->FlatLinks) && (!user->IsOper())) ? ServerInstance->Config->ServerName : Parent),
136 InspIRCd::Format("%d %s", (((Utils->FlatLinks) && (!user->IsOper())) ? 0 : hops), Current->GetDesc().c_str()));
139 void ModuleSpanningTree::HandleLinks(const std::vector<std::string>& parameters, User* user)
141 ShowLinks(Utils->TreeRoot,user,0);
142 user->WriteNumeric(RPL_ENDOFLINKS, '*', "End of /LINKS list.");
145 std::string ModuleSpanningTree::TimeToStr(time_t secs)
147 time_t mins_up = secs / 60;
148 time_t hours_up = mins_up / 60;
149 time_t days_up = hours_up / 24;
151 mins_up = mins_up % 60;
152 hours_up = hours_up % 24;
153 return ((days_up ? (ConvToStr(days_up) + "d") : "")
154 + (hours_up ? (ConvToStr(hours_up) + "h") : "")
155 + (mins_up ? (ConvToStr(mins_up) + "m") : "")
156 + ConvToStr(secs) + "s");
159 void ModuleSpanningTree::ConnectServer(Autoconnect* a, bool on_timer)
163 for(unsigned int j=0; j < a->servers.size(); j++)
165 if (Utils->FindServer(a->servers[j]))
167 // found something in this block. Should the server fail,
168 // we want to start at the start of the list, not in the
169 // middle where we left off
174 if (on_timer && a->position >= 0)
176 if (!on_timer && a->position < 0)
180 while (a->position < (int)a->servers.size())
182 Link* x = Utils->FindLink(a->servers[a->position]);
185 ServerInstance->SNO->WriteToSnoMask('l', "AUTOCONNECT: Auto-connecting server \002%s\002", x->Name.c_str());
191 // Autoconnect chain has been fully iterated; start at the beginning on the
192 // next AutoConnectServers run
196 void ModuleSpanningTree::ConnectServer(Link* x, Autoconnect* y)
200 if (InspIRCd::Match(ServerInstance->Config->ServerName, x->Name, ascii_case_insensitive_map))
202 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Not connecting to myself.");
206 if (strchr(x->IPAddr.c_str(),':'))
209 if (inet_pton(AF_INET6, x->IPAddr.c_str(), &n) < 1)
215 if (inet_pton(AF_INET, x->IPAddr.c_str(),&n) < 1)
219 /* Do we already have an IP? If so, no need to resolve it. */
222 // Create a TreeServer object that will start connecting immediately in the background
223 TreeSocket* newsocket = new TreeSocket(x, y, x->IPAddr);
224 if (newsocket->GetFd() > -1)
226 /* Handled automatically on success */
230 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s.",
231 x->Name.c_str(), newsocket->getError().c_str());
232 ServerInstance->GlobalCulls.AddItem(newsocket);
237 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());
241 // Guess start_type from bindip aftype
242 DNS::QueryType start_type = DNS::QUERY_AAAA;
243 irc::sockets::sockaddrs bind;
244 if ((!x->Bind.empty()) && (irc::sockets::aptosa(x->Bind, 0, bind)))
246 if (bind.family() == AF_INET)
247 start_type = DNS::QUERY_A;
250 ServernameResolver* snr = new ServernameResolver(*DNS, x->IPAddr, x, start_type, y);
255 catch (DNS::Exception& e)
258 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason().c_str());
259 ConnectServer(y, false);
264 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
266 for (std::vector<reference<Autoconnect> >::iterator i = Utils->AutoconnectBlocks.begin(); i < Utils->AutoconnectBlocks.end(); ++i)
269 if (curtime >= x->NextConnectTime)
271 x->NextConnectTime = curtime + x->Period;
272 ConnectServer(x, true);
277 void ModuleSpanningTree::DoConnectTimeout(time_t curtime)
279 SpanningTreeUtilities::TimeoutList::iterator i = Utils->timeoutlist.begin();
280 while (i != Utils->timeoutlist.end())
282 TreeSocket* s = i->first;
283 std::pair<std::string, unsigned int> p = i->second;
284 SpanningTreeUtilities::TimeoutList::iterator me = i;
286 if (s->GetLinkState() == DYING)
288 Utils->timeoutlist.erase(me);
291 else if (curtime > s->age + p.second)
293 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002 (timeout of %u seconds)",p.first.c_str(),p.second);
294 Utils->timeoutlist.erase(me);
300 ModResult ModuleSpanningTree::HandleVersion(const std::vector<std::string>& parameters, User* user)
302 // We've already confirmed that !parameters.empty(), so this is safe
303 TreeServer* found = Utils->FindServerMask(parameters[0]);
306 if (found == Utils->TreeRoot)
308 // Pass to default VERSION handler.
309 return MOD_RES_PASSTHRU;
312 // If an oper wants to see the version then show the full version string instead of the normal,
313 // but only if it is non-empty.
314 // If it's empty it might be that the server is still syncing (full version hasn't arrived yet)
315 // or the server is a 2.0 server and does not send a full version.
316 bool showfull = ((user->IsOper()) && (!found->GetFullVersion().empty()));
317 const std::string& Version = (showfull ? found->GetFullVersion() : found->GetVersion());
318 user->WriteNumeric(RPL_VERSION, Version);
322 user->WriteNumeric(ERR_NOSUCHSERVER, parameters[0], "No such server");
327 ModResult ModuleSpanningTree::HandleConnect(const std::vector<std::string>& parameters, User* user)
329 for (std::vector<reference<Link> >::iterator i = Utils->LinkBlocks.begin(); i < Utils->LinkBlocks.end(); i++)
332 if (InspIRCd::Match(x->Name, parameters[0], ascii_case_insensitive_map))
334 if (InspIRCd::Match(ServerInstance->Config->ServerName, x->Name, ascii_case_insensitive_map))
336 user->WriteRemoteNotice(InspIRCd::Format("*** CONNECT: Server \002%s\002 is ME, not connecting.", x->Name.c_str()));
340 TreeServer* CheckDupe = Utils->FindServer(x->Name);
343 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));
349 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()));
354 user->WriteRemoteNotice(InspIRCd::Format("*** CONNECT: No server matching \002%s\002 could be found in the config file.", parameters[0].c_str()));
358 void ModuleSpanningTree::OnUserInvite(User* source, User* dest, Channel* channel, time_t expiry, unsigned int notifyrank, CUList& notifyexcepts)
360 if (IS_LOCAL(source))
362 CmdBuilder params(source, "INVITE");
363 params.push_back(dest->uuid);
364 params.push_back(channel->name);
365 params.push_int(channel->age);
366 params.push_back(ConvToStr(expiry));
371 ModResult ModuleSpanningTree::OnPreTopicChange(User* user, Channel* chan, const std::string& topic)
373 // XXX: Deny topic changes if the current topic set time is the current time or is in the future because
374 // other servers will drop our FTOPIC. This restriction will be removed when the protocol is updated.
375 if ((chan->topicset >= ServerInstance->Time()) && (Utils->serverlist.size() > 1))
377 user->WriteNumeric(ERR_CHANOPRIVSNEEDED, chan->name, "Retry topic change later");
380 return MOD_RES_PASSTHRU;
383 void ModuleSpanningTree::OnPostTopicChange(User* user, Channel* chan, const std::string &topic)
385 // Drop remote events on the floor.
389 CommandFTopic::Builder(user, chan).Broadcast();
392 void ModuleSpanningTree::OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details)
397 const char* message_type = (details.type == MSG_PRIVMSG ? "PRIVMSG" : "NOTICE");
398 if (target.type == MessageTarget::TYPE_USER)
400 User* d = target.Get<User>();
403 CmdBuilder params(user, message_type);
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.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_back(*serverglob);
418 par.push_last(details.text);
423 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
425 AutoConnectServers(curtime);
426 DoConnectTimeout(curtime);
429 void ModuleSpanningTree::OnUserConnect(LocalUser* user)
434 CommandUID::Builder(user).Broadcast();
437 CommandOpertype::Builder(user).Broadcast();
439 for(Extensible::ExtensibleStore::const_iterator i = user->GetExtList().begin(); i != user->GetExtList().end(); i++)
441 ExtensionItem* item = i->first;
442 std::string value = item->serialize(FORMAT_NETWORK, user, i->second);
444 ServerInstance->PI->SendMetaData(user, item->name, value);
447 Utils->TreeRoot->UserCount++;
450 void ModuleSpanningTree::OnUserJoin(Membership* memb, bool sync, bool created_by_local, CUList& excepts)
452 // Only do this for local users
453 if (!IS_LOCAL(memb->user))
456 // Assign the current membership id to the new Membership and increase it
457 memb->id = currmembid++;
459 if (created_by_local)
461 CommandFJoin::Builder params(memb->chan);
468 CmdBuilder params(memb->user, "IJOIN");
469 params.push_back(memb->chan->name);
470 params.push_int(memb->id);
471 if (!memb->modes.empty())
473 params.push_back(ConvToStr(memb->chan->age));
474 params.push_back(memb->modes);
480 void ModuleSpanningTree::OnChangeHost(User* user, const std::string &newhost)
482 if (user->registered != REG_ALL || !IS_LOCAL(user))
485 CmdBuilder(user, "FHOST").push(newhost).Broadcast();
488 void ModuleSpanningTree::OnChangeName(User* user, const std::string &gecos)
490 if (user->registered != REG_ALL || !IS_LOCAL(user))
493 CmdBuilder(user, "FNAME").push_last(gecos).Broadcast();
496 void ModuleSpanningTree::OnChangeIdent(User* user, const std::string &ident)
498 if ((user->registered != REG_ALL) || (!IS_LOCAL(user)))
501 CmdBuilder(user, "FIDENT").push(ident).Broadcast();
504 void ModuleSpanningTree::OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts)
506 if (IS_LOCAL(memb->user))
508 CmdBuilder params(memb->user, "PART");
509 params.push_back(memb->chan->name);
510 if (!partmessage.empty())
511 params.push_last(partmessage);
516 void ModuleSpanningTree::OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
520 if (oper_message != reason)
521 ServerInstance->PI->SendMetaData(user, "operquit", oper_message);
523 CmdBuilder(user, "QUIT").push_last(reason).Broadcast();
527 // Hide the message if one of the following is true:
528 // - User is being quit due to a netsplit and quietbursts is on
529 // - Server is a silent uline
530 TreeServer* server = TreeServer::Get(user);
531 bool hide = (((server->IsDead()) && (Utils->quiet_bursts)) || (server->IsSilentULine()));
534 ServerInstance->SNO->WriteToSnoMask('Q', "Client exiting on server %s: %s (%s) [%s]",
535 user->server->GetName().c_str(), user->GetFullRealHost().c_str(), user->GetIPString().c_str(), oper_message.c_str());
539 // Regardless, update the UserCount
540 TreeServer::Get(user)->UserCount--;
543 void ModuleSpanningTree::OnUserPostNick(User* user, const std::string &oldnick)
547 // The nick TS is updated by the core, we don't do it
548 CmdBuilder params(user, "NICK");
549 params.push_back(user->nick);
550 params.push_back(ConvToStr(user->age));
555 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);
559 void ModuleSpanningTree::OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts)
561 if ((!IS_LOCAL(source)) && (source != ServerInstance->FakeClient))
564 CmdBuilder params(source, "KICK");
565 params.push_back(memb->chan->name);
566 params.push_back(memb->user->uuid);
567 // If a remote user is being kicked by us then send the membership id in the kick too
568 if (!IS_LOCAL(memb->user))
569 params.push_int(memb->id);
570 params.push_last(reason);
574 void ModuleSpanningTree::OnPreRehash(User* user, const std::string ¶meter)
577 return; // Don't generate a REHASH here if we're in the middle of processing a message that generated this one
579 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "OnPreRehash called with param %s", parameter.c_str());
581 // Send out to other servers
582 if (!parameter.empty() && parameter[0] != '-')
584 CmdBuilder params((user ? user->uuid : ServerInstance->Config->GetSID()), "REHASH");
585 params.push_back(parameter);
586 params.Forward(user ? TreeServer::Get(user)->GetRoute() : NULL);
590 void ModuleSpanningTree::ReadConfig(ConfigStatus& status)
592 // Did this rehash change the description of this server?
593 const std::string& newdesc = ServerInstance->Config->ServerDesc;
594 if (newdesc != Utils->TreeRoot->GetDesc())
596 // Broadcast a SINFO desc message to let the network know about the new description. This is the description
597 // string that is sent in the SERVER message initially and shown for example in WHOIS.
598 // We don't need to update the field itself in the Server object - the core does that.
599 CommandSInfo::Builder(Utils->TreeRoot, "desc", newdesc).Broadcast();
602 // Re-read config stuff
605 Utils->ReadConfiguration();
607 catch (ModuleException& e)
609 // Refresh the IP cache anyway, so servers read before the error will be allowed to connect
610 Utils->RefreshIPCache();
611 // Always warn local opers with snomask +l, also warn globally (snomask +L) if the rehash was issued by a remote user
612 std::string msg = "Error in configuration: ";
613 msg.append(e.GetReason());
614 ServerInstance->SNO->WriteToSnoMask('l', msg);
615 if (status.srcuser && !IS_LOCAL(status.srcuser))
616 ServerInstance->PI->SendSNONotice('L', msg);
620 void ModuleSpanningTree::OnLoadModule(Module* mod)
624 data.append(mod->ModuleSourceFile);
625 Version v = mod->GetVersion();
626 if (!v.link_data.empty())
629 data.append(v.link_data);
631 ServerInstance->PI->SendMetaData("modules", data);
634 void ModuleSpanningTree::OnUnloadModule(Module* mod)
638 ServerInstance->PI->SendMetaData("modules", "-" + mod->ModuleSourceFile);
642 // We are being unloaded, inform modules about all servers splitting which cannot be done later when the servers are actually disconnected
643 const server_hash& servers = Utils->serverlist;
644 for (server_hash::const_iterator i = servers.begin(); i != servers.end(); ++i)
646 TreeServer* server = i->second;
647 if (!server->IsRoot())
648 FOREACH_MOD_CUSTOM(GetEventProvider(), ServerEventListener, OnServerSplit, (server));
653 // Some other module is being unloaded. If it provides an IOHook we use, we must close that server connection now.
656 // Close all connections which use an IO hook provided by this module
657 const TreeServer::ChildServers& list = Utils->TreeRoot->GetChildren();
658 for (TreeServer::ChildServers::const_iterator i = list.begin(); i != list.end(); ++i)
660 TreeSocket* sock = (*i)->GetSocket();
661 if (sock->GetModHook(mod))
663 sock->SendError("SSL module unloaded");
665 // XXX: The list we're iterating is modified by TreeServer::SQuit() which is called by Close()
670 for (SpanningTreeUtilities::TimeoutList::const_iterator i = Utils->timeoutlist.begin(); i != Utils->timeoutlist.end(); ++i)
672 TreeSocket* sock = i->first;
673 if (sock->GetModHook(mod))
678 void ModuleSpanningTree::OnOper(User* user, const std::string &opertype)
680 if (user->registered != REG_ALL || !IS_LOCAL(user))
683 // Note: The protocol does not allow direct umode +o;
684 // sending OPERTYPE infers +o modechange locally.
685 CommandOpertype::Builder(user).Broadcast();
688 void ModuleSpanningTree::OnAddLine(User* user, XLine *x)
690 if (!x->IsBurstable() || loopCall || (user && !IS_LOCAL(user)))
694 user = ServerInstance->FakeClient;
696 CommandAddLine::Builder(x, user).Broadcast();
699 void ModuleSpanningTree::OnDelLine(User* user, XLine *x)
701 if (!x->IsBurstable() || loopCall || (user && !IS_LOCAL(user)))
705 user = ServerInstance->FakeClient;
707 CmdBuilder params(user, "DELLINE");
708 params.push_back(x->type);
709 params.push_back(x->Displayable());
713 ModResult ModuleSpanningTree::OnSetAway(User* user, const std::string &awaymsg)
716 CommandAway::Builder(user, awaymsg).Broadcast();
718 return MOD_RES_PASSTHRU;
721 void ModuleSpanningTree::OnMode(User* source, User* u, Channel* c, const Modes::ChangeList& modes, ModeParser::ModeProcessFlag processflags, const std::string& output_mode)
723 if (processflags & ModeParser::MODE_LOCALONLY)
728 if (u->registered != REG_ALL)
731 CmdBuilder params(source, "MODE");
732 params.push(u->uuid);
733 params.push(output_mode);
734 params.push_raw(Translate::ModeChangeListToParams(modes.getlist()));
739 CmdBuilder params(source, "FMODE");
740 params.push(c->name);
741 params.push_int(c->age);
742 params.push(output_mode);
743 params.push_raw(Translate::ModeChangeListToParams(modes.getlist()));
748 CullResult ModuleSpanningTree::cull()
752 return this->Module::cull();
755 ModuleSpanningTree::~ModuleSpanningTree()
757 ServerInstance->PI = &ServerInstance->DefaultProtocolInterface;
759 Server* newsrv = new Server(ServerInstance->Config->ServerName, ServerInstance->Config->ServerDesc);
760 SetLocalUsersServer(newsrv);
765 Version ModuleSpanningTree::GetVersion()
767 return Version("Allows servers to be linked", VF_VENDOR);
770 /* It is IMPORTANT that m_spanningtree is the last module in the chain
771 * so that any activity it sees is FINAL, e.g. we arent going to send out
772 * a NICK message before m_cloaking has finished putting the +x on the user,
774 * Therefore, we set our priority to PRIORITY_LAST to make sure we end up at the END of
775 * the module call queue.
777 void ModuleSpanningTree::Prioritize()
779 ServerInstance->Modules->SetPriority(this, PRIORITY_LAST);
780 ServerInstance->Modules.SetPriority(this, I_OnPreTopicChange, PRIORITY_FIRST);
783 MODULE_INIT(ModuleSpanningTree)