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")
49 , tagevprov(this, "event/messagetag")
54 SpanningTreeCommands::SpanningTreeCommands(ModuleSpanningTree* module)
55 : svsjoin(module), svspart(module), svsnick(module), metadata(module),
56 uid(module), opertype(module), fjoin(module), ijoin(module), resync(module),
57 fmode(module), ftopic(module), fhost(module), fident(module), fname(module),
58 away(module), addline(module), delline(module), encap(module), idle(module),
59 nick(module), ping(module), pong(module), save(module),
60 server(module), squit(module), snonotice(module),
61 endburst(module), sinfo(module), num(module)
67 void SetLocalUsersServer(Server* newserver)
69 // Does not change the server of quitting users because those are not in the list
71 ServerInstance->FakeClient->server = newserver;
72 const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers();
73 for (UserManager::LocalList::const_iterator i = list.begin(); i != list.end(); ++i)
74 (*i)->server = newserver;
77 void ResetMembershipIds()
79 // Set all membership ids to 0
80 const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers();
81 for (UserManager::LocalList::iterator i = list.begin(); i != list.end(); ++i)
84 for (User::ChanList::iterator j = user->chans.begin(); j != user->chans.end(); ++j)
90 void ModuleSpanningTree::init()
92 ServerInstance->SNO->EnableSnomask('l', "LINK");
96 Utils = new SpanningTreeUtilities(this);
97 Utils->TreeRoot = new TreeServer;
99 ServerInstance->PI = &protocolinterface;
101 delete ServerInstance->FakeClient->server;
102 SetLocalUsersServer(Utils->TreeRoot);
105 void ModuleSpanningTree::ShowLinks(TreeServer* Current, User* user, int hops)
107 std::string Parent = Utils->TreeRoot->GetName();
108 if (Current->GetParent())
110 Parent = Current->GetParent()->GetName();
113 const TreeServer::ChildServers& children = Current->GetChildren();
114 for (TreeServer::ChildServers::const_iterator i = children.begin(); i != children.end(); ++i)
116 TreeServer* server = *i;
117 if ((server->Hidden) || ((Utils->HideULines) && (server->IsULine())))
121 ShowLinks(server, user, hops+1);
126 ShowLinks(server, user, hops+1);
129 /* Don't display the line if its a uline, hide ulines is on, and the user isnt an oper */
130 if ((Utils->HideULines) && (Current->IsULine()) && (!user->IsOper()))
132 /* Or if the server is hidden and they're not an oper */
133 else if ((Current->Hidden) && (!user->IsOper()))
136 user->WriteNumeric(RPL_LINKS, Current->GetName(),
137 (((Utils->FlatLinks) && (!user->IsOper())) ? ServerInstance->Config->ServerName : Parent),
138 InspIRCd::Format("%d %s", (((Utils->FlatLinks) && (!user->IsOper())) ? 0 : hops), Current->GetDesc().c_str()));
141 void ModuleSpanningTree::HandleLinks(const CommandBase::Params& parameters, User* user)
143 ShowLinks(Utils->TreeRoot,user,0);
144 user->WriteNumeric(RPL_ENDOFLINKS, '*', "End of /LINKS list.");
147 std::string ModuleSpanningTree::TimeToStr(time_t secs)
149 time_t mins_up = secs / 60;
150 time_t hours_up = mins_up / 60;
151 time_t days_up = hours_up / 24;
153 mins_up = mins_up % 60;
154 hours_up = hours_up % 24;
155 return ((days_up ? (ConvToStr(days_up) + "d") : "")
156 + (hours_up ? (ConvToStr(hours_up) + "h") : "")
157 + (mins_up ? (ConvToStr(mins_up) + "m") : "")
158 + ConvToStr(secs) + "s");
161 void ModuleSpanningTree::ConnectServer(Autoconnect* a, bool on_timer)
165 for(unsigned int j=0; j < a->servers.size(); j++)
167 if (Utils->FindServer(a->servers[j]))
169 // found something in this block. Should the server fail,
170 // we want to start at the start of the list, not in the
171 // middle where we left off
176 if (on_timer && a->position >= 0)
178 if (!on_timer && a->position < 0)
182 while (a->position < (int)a->servers.size())
184 Link* x = Utils->FindLink(a->servers[a->position]);
187 ServerInstance->SNO->WriteToSnoMask('l', "AUTOCONNECT: Auto-connecting server \002%s\002", x->Name.c_str());
193 // Autoconnect chain has been fully iterated; start at the beginning on the
194 // next AutoConnectServers run
198 void ModuleSpanningTree::ConnectServer(Link* x, Autoconnect* y)
202 if (InspIRCd::Match(ServerInstance->Config->ServerName, x->Name, ascii_case_insensitive_map))
204 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Not connecting to myself.");
209 if (x->IPAddr.find('/') != std::string::npos)
212 if (stat(x->IPAddr.c_str(), &sb) == -1 || !S_ISSOCK(sb.st_mode))
216 if (x->IPAddr.find(':') != std::string::npos)
219 if (inet_pton(AF_INET6, x->IPAddr.c_str(), &n) < 1)
225 if (inet_pton(AF_INET, x->IPAddr.c_str(),&n) < 1)
229 /* Do we already have an IP? If so, no need to resolve it. */
232 // Create a TreeServer object that will start connecting immediately in the background
233 TreeSocket* newsocket = new TreeSocket(x, y, x->IPAddr);
234 if (newsocket->GetFd() > -1)
236 /* Handled automatically on success */
240 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s.",
241 x->Name.c_str(), newsocket->getError().c_str());
242 ServerInstance->GlobalCulls.AddItem(newsocket);
247 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());
251 // Guess start_type from bindip aftype
252 DNS::QueryType start_type = DNS::QUERY_AAAA;
253 irc::sockets::sockaddrs bind;
254 if ((!x->Bind.empty()) && (irc::sockets::aptosa(x->Bind, 0, bind)))
256 if (bind.family() == AF_INET)
257 start_type = DNS::QUERY_A;
260 ServernameResolver* snr = new ServernameResolver(*DNS, x->IPAddr, x, start_type, y);
265 catch (DNS::Exception& e)
268 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason().c_str());
269 ConnectServer(y, false);
274 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
276 for (std::vector<reference<Autoconnect> >::iterator i = Utils->AutoconnectBlocks.begin(); i < Utils->AutoconnectBlocks.end(); ++i)
279 if (curtime >= x->NextConnectTime)
281 x->NextConnectTime = curtime + x->Period;
282 ConnectServer(x, true);
287 void ModuleSpanningTree::DoConnectTimeout(time_t curtime)
289 SpanningTreeUtilities::TimeoutList::iterator i = Utils->timeoutlist.begin();
290 while (i != Utils->timeoutlist.end())
292 TreeSocket* s = i->first;
293 std::pair<std::string, unsigned int> p = i->second;
294 SpanningTreeUtilities::TimeoutList::iterator me = i;
296 if (s->GetLinkState() == DYING)
298 Utils->timeoutlist.erase(me);
301 else if (curtime > s->age + p.second)
303 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002 (timeout of %u seconds)",p.first.c_str(),p.second);
304 Utils->timeoutlist.erase(me);
310 ModResult ModuleSpanningTree::HandleVersion(const CommandBase::Params& parameters, User* user)
312 // We've already confirmed that !parameters.empty(), so this is safe
313 TreeServer* found = Utils->FindServerMask(parameters[0]);
316 if (found == Utils->TreeRoot)
318 // Pass to default VERSION handler.
319 return MOD_RES_PASSTHRU;
322 // If an oper wants to see the version then show the full version string instead of the normal,
323 // but only if it is non-empty.
324 // If it's empty it might be that the server is still syncing (full version hasn't arrived yet)
325 // or the server is a 2.0 server and does not send a full version.
326 bool showfull = ((user->IsOper()) && (!found->GetFullVersion().empty()));
327 const std::string& Version = (showfull ? found->GetFullVersion() : found->GetVersion());
328 user->WriteNumeric(RPL_VERSION, Version);
332 user->WriteNumeric(ERR_NOSUCHSERVER, parameters[0], "No such server");
337 ModResult ModuleSpanningTree::HandleConnect(const CommandBase::Params& parameters, User* user)
339 for (std::vector<reference<Link> >::iterator i = Utils->LinkBlocks.begin(); i < Utils->LinkBlocks.end(); i++)
342 if (InspIRCd::Match(x->Name, parameters[0], ascii_case_insensitive_map))
344 if (InspIRCd::Match(ServerInstance->Config->ServerName, x->Name, ascii_case_insensitive_map))
346 user->WriteRemoteNotice(InspIRCd::Format("*** CONNECT: Server \002%s\002 is ME, not connecting.", x->Name.c_str()));
350 TreeServer* CheckDupe = Utils->FindServer(x->Name);
353 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));
359 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()));
364 user->WriteRemoteNotice(InspIRCd::Format("*** CONNECT: No server matching \002%s\002 could be found in the config file.", parameters[0].c_str()));
368 void ModuleSpanningTree::OnUserInvite(User* source, User* dest, Channel* channel, time_t expiry, unsigned int notifyrank, CUList& notifyexcepts)
370 if (IS_LOCAL(source))
372 CmdBuilder params(source, "INVITE");
373 params.push_back(dest->uuid);
374 params.push_back(channel->name);
375 params.push_int(channel->age);
376 params.push_back(ConvToStr(expiry));
381 ModResult ModuleSpanningTree::OnPreTopicChange(User* user, Channel* chan, const std::string& topic)
383 // XXX: Deny topic changes if the current topic set time is the current time or is in the future because
384 // other servers will drop our FTOPIC. This restriction will be removed when the protocol is updated.
385 if ((chan->topicset >= ServerInstance->Time()) && (Utils->serverlist.size() > 1))
387 user->WriteNumeric(ERR_CHANOPRIVSNEEDED, chan->name, "Retry topic change later");
390 return MOD_RES_PASSTHRU;
393 void ModuleSpanningTree::OnPostTopicChange(User* user, Channel* chan, const std::string &topic)
395 // Drop remote events on the floor.
399 CommandFTopic::Builder(user, chan).Broadcast();
402 void ModuleSpanningTree::OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details)
407 const char* message_type = (details.type == MSG_PRIVMSG ? "PRIVMSG" : "NOTICE");
408 if (target.type == MessageTarget::TYPE_USER)
410 User* d = target.Get<User>();
413 CmdBuilder params(user, message_type);
414 params.push_tags(details.tags_out);
415 params.push_back(d->uuid);
416 params.push_last(details.text);
420 else if (target.type == MessageTarget::TYPE_CHANNEL)
422 Utils->SendChannelMessage(user->uuid, target.Get<Channel>(), details.text, target.status, details.tags_out, details.exemptions, message_type);
424 else if (target.type == MessageTarget::TYPE_SERVER)
426 const std::string* serverglob = target.Get<std::string>();
427 CmdBuilder par(user, message_type);
428 par.push_tags(details.tags_out);
429 par.push_back(*serverglob);
430 par.push_last(details.text);
435 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
437 AutoConnectServers(curtime);
438 DoConnectTimeout(curtime);
441 void ModuleSpanningTree::OnUserConnect(LocalUser* user)
446 CommandUID::Builder(user).Broadcast();
449 CommandOpertype::Builder(user).Broadcast();
451 for(Extensible::ExtensibleStore::const_iterator i = user->GetExtList().begin(); i != user->GetExtList().end(); i++)
453 ExtensionItem* item = i->first;
454 std::string value = item->serialize(FORMAT_NETWORK, user, i->second);
456 ServerInstance->PI->SendMetaData(user, item->name, value);
459 Utils->TreeRoot->UserCount++;
462 void ModuleSpanningTree::OnUserJoin(Membership* memb, bool sync, bool created_by_local, CUList& excepts)
464 // Only do this for local users
465 if (!IS_LOCAL(memb->user))
468 // Assign the current membership id to the new Membership and increase it
469 memb->id = currmembid++;
471 if (created_by_local)
473 CommandFJoin::Builder params(memb->chan);
480 CmdBuilder params(memb->user, "IJOIN");
481 params.push_back(memb->chan->name);
482 params.push_int(memb->id);
483 if (!memb->modes.empty())
485 params.push_back(ConvToStr(memb->chan->age));
486 params.push_back(memb->modes);
492 void ModuleSpanningTree::OnChangeHost(User* user, const std::string &newhost)
494 if (user->registered != REG_ALL || !IS_LOCAL(user))
497 CmdBuilder(user, "FHOST").push(newhost).Broadcast();
500 void ModuleSpanningTree::OnChangeRealName(User* user, const std::string& real)
502 if (user->registered != REG_ALL || !IS_LOCAL(user))
505 CmdBuilder(user, "FNAME").push_last(real).Broadcast();
508 void ModuleSpanningTree::OnChangeIdent(User* user, const std::string &ident)
510 if ((user->registered != REG_ALL) || (!IS_LOCAL(user)))
513 CmdBuilder(user, "FIDENT").push(ident).Broadcast();
516 void ModuleSpanningTree::OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts)
518 if (IS_LOCAL(memb->user))
520 CmdBuilder params(memb->user, "PART");
521 params.push_back(memb->chan->name);
522 if (!partmessage.empty())
523 params.push_last(partmessage);
528 void ModuleSpanningTree::OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
532 if (oper_message != reason)
533 ServerInstance->PI->SendMetaData(user, "operquit", oper_message);
535 CmdBuilder(user, "QUIT").push_last(reason).Broadcast();
539 // Hide the message if one of the following is true:
540 // - User is being quit due to a netsplit and quietbursts is on
541 // - Server is a silent uline
542 TreeServer* server = TreeServer::Get(user);
543 bool hide = (((server->IsDead()) && (Utils->quiet_bursts)) || (server->IsSilentULine()));
546 ServerInstance->SNO->WriteToSnoMask('Q', "Client exiting on server %s: %s (%s) [%s]",
547 user->server->GetName().c_str(), user->GetFullRealHost().c_str(), user->GetIPString().c_str(), oper_message.c_str());
551 // Regardless, update the UserCount
552 TreeServer::Get(user)->UserCount--;
555 void ModuleSpanningTree::OnUserPostNick(User* user, const std::string &oldnick)
559 // The nick TS is updated by the core, we don't do it
560 CmdBuilder params(user, "NICK");
561 params.push_back(user->nick);
562 params.push_back(ConvToStr(user->age));
567 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);
571 void ModuleSpanningTree::OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts)
573 if ((!IS_LOCAL(source)) && (source != ServerInstance->FakeClient))
576 CmdBuilder params(source, "KICK");
577 params.push_back(memb->chan->name);
578 params.push_back(memb->user->uuid);
579 // If a remote user is being kicked by us then send the membership id in the kick too
580 if (!IS_LOCAL(memb->user))
581 params.push_int(memb->id);
582 params.push_last(reason);
586 void ModuleSpanningTree::OnPreRehash(User* user, const std::string ¶meter)
588 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "OnPreRehash called with param %s", parameter.c_str());
590 // Send out to other servers
591 if (!parameter.empty() && parameter[0] != '-')
593 CmdBuilder params((user ? user->uuid : ServerInstance->Config->GetSID()), "REHASH");
594 params.push_back(parameter);
595 params.Forward(user ? TreeServer::Get(user)->GetRoute() : NULL);
599 void ModuleSpanningTree::ReadConfig(ConfigStatus& status)
601 // Did this rehash change the description of this server?
602 const std::string& newdesc = ServerInstance->Config->ServerDesc;
603 if (newdesc != Utils->TreeRoot->GetDesc())
605 // Broadcast a SINFO desc message to let the network know about the new description. This is the description
606 // string that is sent in the SERVER message initially and shown for example in WHOIS.
607 // We don't need to update the field itself in the Server object - the core does that.
608 CommandSInfo::Builder(Utils->TreeRoot, "desc", newdesc).Broadcast();
611 // Re-read config stuff
614 Utils->ReadConfiguration();
616 catch (ModuleException& e)
618 // Refresh the IP cache anyway, so servers read before the error will be allowed to connect
619 Utils->RefreshIPCache();
620 // Always warn local opers with snomask +l, also warn globally (snomask +L) if the rehash was issued by a remote user
621 std::string msg = "Error in configuration: ";
622 msg.append(e.GetReason());
623 ServerInstance->SNO->WriteToSnoMask('l', msg);
624 if (status.srcuser && !IS_LOCAL(status.srcuser))
625 ServerInstance->PI->SendSNONotice('L', msg);
629 void ModuleSpanningTree::OnLoadModule(Module* mod)
633 data.append(mod->ModuleSourceFile);
634 Version v = mod->GetVersion();
635 if (!v.link_data.empty())
638 data.append(v.link_data);
640 ServerInstance->PI->SendMetaData("modules", data);
643 void ModuleSpanningTree::OnUnloadModule(Module* mod)
647 ServerInstance->PI->SendMetaData("modules", "-" + mod->ModuleSourceFile);
651 // We are being unloaded, inform modules about all servers splitting which cannot be done later when the servers are actually disconnected
652 const server_hash& servers = Utils->serverlist;
653 for (server_hash::const_iterator i = servers.begin(); i != servers.end(); ++i)
655 TreeServer* server = i->second;
656 if (!server->IsRoot())
657 FOREACH_MOD_CUSTOM(GetEventProvider(), ServerEventListener, OnServerSplit, (server));
662 // Some other module is being unloaded. If it provides an IOHook we use, we must close that server connection now.
665 // Close all connections which use an IO hook provided by this module
666 const TreeServer::ChildServers& list = Utils->TreeRoot->GetChildren();
667 for (TreeServer::ChildServers::const_iterator i = list.begin(); i != list.end(); ++i)
669 TreeSocket* sock = (*i)->GetSocket();
670 if (sock->GetModHook(mod))
672 sock->SendError("SSL module unloaded");
674 // XXX: The list we're iterating is modified by TreeServer::SQuit() which is called by Close()
679 for (SpanningTreeUtilities::TimeoutList::const_iterator i = Utils->timeoutlist.begin(); i != Utils->timeoutlist.end(); ++i)
681 TreeSocket* sock = i->first;
682 if (sock->GetModHook(mod))
687 void ModuleSpanningTree::OnOper(User* user, const std::string &opertype)
689 if (user->registered != REG_ALL || !IS_LOCAL(user))
692 // Note: The protocol does not allow direct umode +o;
693 // sending OPERTYPE infers +o modechange locally.
694 CommandOpertype::Builder(user).Broadcast();
697 void ModuleSpanningTree::OnAddLine(User* user, XLine *x)
699 if (!x->IsBurstable() || loopCall || (user && !IS_LOCAL(user)))
703 user = ServerInstance->FakeClient;
705 CommandAddLine::Builder(x, user).Broadcast();
708 void ModuleSpanningTree::OnDelLine(User* user, XLine *x)
710 if (!x->IsBurstable() || loopCall || (user && !IS_LOCAL(user)))
714 user = ServerInstance->FakeClient;
716 CmdBuilder params(user, "DELLINE");
717 params.push_back(x->type);
718 params.push_back(x->Displayable());
722 void ModuleSpanningTree::OnUserAway(User* user)
725 CommandAway::Builder(user).Broadcast();
728 void ModuleSpanningTree::OnUserBack(User* user)
731 CommandAway::Builder(user).Broadcast();
734 void ModuleSpanningTree::OnMode(User* source, User* u, Channel* c, const Modes::ChangeList& modes, ModeParser::ModeProcessFlag processflags)
736 if (processflags & ModeParser::MODE_LOCALONLY)
741 if (u->registered != REG_ALL)
744 CmdBuilder params(source, "MODE");
745 params.push(u->uuid);
746 params.push(ClientProtocol::Messages::Mode::ToModeLetters(modes));
747 params.push_raw(Translate::ModeChangeListToParams(modes.getlist()));
752 CmdBuilder params(source, "FMODE");
753 params.push(c->name);
754 params.push_int(c->age);
755 params.push(ClientProtocol::Messages::Mode::ToModeLetters(modes));
756 params.push_raw(Translate::ModeChangeListToParams(modes.getlist()));
761 CullResult ModuleSpanningTree::cull()
765 return this->Module::cull();
768 ModuleSpanningTree::~ModuleSpanningTree()
770 ServerInstance->PI = &ServerInstance->DefaultProtocolInterface;
772 Server* newsrv = new Server(ServerInstance->Config->ServerName, ServerInstance->Config->ServerDesc);
773 SetLocalUsersServer(newsrv);
778 Version ModuleSpanningTree::GetVersion()
780 return Version("Allows servers to be linked", VF_VENDOR);
783 /* It is IMPORTANT that m_spanningtree is the last module in the chain
784 * so that any activity it sees is FINAL, e.g. we arent going to send out
785 * a NICK message before m_cloaking has finished putting the +x on the user,
787 * Therefore, we set our priority to PRIORITY_LAST to make sure we end up at the END of
788 * the module call queue.
790 void ModuleSpanningTree::Prioritize()
792 ServerInstance->Modules->SetPriority(this, PRIORITY_LAST);
793 ServerInstance->Modules.SetPriority(this, I_OnPreTopicChange, PRIORITY_FIRST);
796 MODULE_INIT(ModuleSpanningTree)