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"
36 #include "translate.h"
38 ModuleSpanningTree::ModuleSpanningTree()
39 : rconnect(this), rsquit(this), map(this)
42 , eventprov(this, "event/spanningtree")
48 SpanningTreeCommands::SpanningTreeCommands(ModuleSpanningTree* module)
49 : svsjoin(module), svspart(module), svsnick(module), metadata(module),
50 uid(module), opertype(module), fjoin(module), ijoin(module), resync(module),
51 fmode(module), ftopic(module), fhost(module), fident(module), fname(module),
52 away(module), addline(module), delline(module), encap(module), idle(module),
53 nick(module), ping(module), pong(module), push(module), save(module),
54 server(module), squit(module), snonotice(module),
55 endburst(module), sinfo(module)
61 void SetLocalUsersServer(Server* newserver)
63 // Does not change the server of quitting users because those are not in the list
65 ServerInstance->FakeClient->server = newserver;
66 const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers();
67 for (UserManager::LocalList::const_iterator i = list.begin(); i != list.end(); ++i)
68 (*i)->server = newserver;
71 void ResetMembershipIds()
73 // Set all membership ids to 0
74 const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers();
75 for (UserManager::LocalList::iterator i = list.begin(); i != list.end(); ++i)
78 for (User::ChanList::iterator j = user->chans.begin(); j != user->chans.end(); ++j)
84 void ModuleSpanningTree::init()
86 ServerInstance->SNO->EnableSnomask('l', "LINK");
90 Utils = new SpanningTreeUtilities(this);
91 Utils->TreeRoot = new TreeServer;
92 commands = new SpanningTreeCommands(this);
94 ServerInstance->PI = &protocolinterface;
96 delete ServerInstance->FakeClient->server;
97 SetLocalUsersServer(Utils->TreeRoot);
100 void ModuleSpanningTree::ShowLinks(TreeServer* Current, User* user, int hops)
102 std::string Parent = Utils->TreeRoot->GetName();
103 if (Current->GetParent())
105 Parent = Current->GetParent()->GetName();
108 const TreeServer::ChildServers& children = Current->GetChildren();
109 for (TreeServer::ChildServers::const_iterator i = children.begin(); i != children.end(); ++i)
111 TreeServer* server = *i;
112 if ((server->Hidden) || ((Utils->HideULines) && (server->IsULine())))
116 ShowLinks(server, user, hops+1);
121 ShowLinks(server, user, hops+1);
124 /* Don't display the line if its a uline, hide ulines is on, and the user isnt an oper */
125 if ((Utils->HideULines) && (Current->IsULine()) && (!user->IsOper()))
127 /* Or if the server is hidden and they're not an oper */
128 else if ((Current->Hidden) && (!user->IsOper()))
131 user->WriteNumeric(RPL_LINKS, "%s %s :%d %s", Current->GetName().c_str(),
132 (Utils->FlatLinks && (!user->IsOper())) ? ServerInstance->Config->ServerName.c_str() : Parent.c_str(),
133 (Utils->FlatLinks && (!user->IsOper())) ? 0 : hops,
134 Current->GetDesc().c_str());
137 void ModuleSpanningTree::HandleLinks(const std::vector<std::string>& parameters, User* user)
139 ShowLinks(Utils->TreeRoot,user,0);
140 user->WriteNumeric(RPL_ENDOFLINKS, "* :End of /LINKS list.");
143 std::string ModuleSpanningTree::TimeToStr(time_t secs)
145 time_t mins_up = secs / 60;
146 time_t hours_up = mins_up / 60;
147 time_t days_up = hours_up / 24;
149 mins_up = mins_up % 60;
150 hours_up = hours_up % 24;
151 return ((days_up ? (ConvToStr(days_up) + "d") : "")
152 + (hours_up ? (ConvToStr(hours_up) + "h") : "")
153 + (mins_up ? (ConvToStr(mins_up) + "m") : "")
154 + ConvToStr(secs) + "s");
157 void ModuleSpanningTree::ConnectServer(Autoconnect* a, bool on_timer)
161 for(unsigned int j=0; j < a->servers.size(); j++)
163 if (Utils->FindServer(a->servers[j]))
165 // found something in this block. Should the server fail,
166 // we want to start at the start of the list, not in the
167 // middle where we left off
172 if (on_timer && a->position >= 0)
174 if (!on_timer && a->position < 0)
178 while (a->position < (int)a->servers.size())
180 Link* x = Utils->FindLink(a->servers[a->position]);
183 ServerInstance->SNO->WriteToSnoMask('l', "AUTOCONNECT: Auto-connecting server \002%s\002", x->Name.c_str());
189 // Autoconnect chain has been fully iterated; start at the beginning on the
190 // next AutoConnectServers run
194 void ModuleSpanningTree::ConnectServer(Link* x, Autoconnect* y)
198 if (InspIRCd::Match(ServerInstance->Config->ServerName, assign(x->Name), rfc_case_insensitive_map))
200 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Not connecting to myself.");
204 DNS::QueryType start_type = DNS::QUERY_AAAA;
205 if (strchr(x->IPAddr.c_str(),':'))
208 if (inet_pton(AF_INET6, x->IPAddr.c_str(), &n) < 1)
214 if (inet_aton(x->IPAddr.c_str(),&n) < 1)
218 /* Do we already have an IP? If so, no need to resolve it. */
221 /* Gave a hook, but it wasnt one we know */
222 TreeSocket* newsocket = new TreeSocket(x, y, x->IPAddr);
223 if (newsocket->GetFd() > -1)
225 /* Handled automatically on success */
229 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s.",
230 x->Name.c_str(), newsocket->getError().c_str());
231 ServerInstance->GlobalCulls.AddItem(newsocket);
236 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());
240 ServernameResolver* snr = new ServernameResolver(*DNS, x->IPAddr, x, start_type, y);
245 catch (DNS::Exception& e)
248 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason().c_str());
249 ConnectServer(y, false);
254 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
256 for (std::vector<reference<Autoconnect> >::iterator i = Utils->AutoconnectBlocks.begin(); i < Utils->AutoconnectBlocks.end(); ++i)
259 if (curtime >= x->NextConnectTime)
261 x->NextConnectTime = curtime + x->Period;
262 ConnectServer(x, true);
267 void ModuleSpanningTree::DoConnectTimeout(time_t curtime)
269 std::map<TreeSocket*, std::pair<std::string, int> >::iterator i = Utils->timeoutlist.begin();
270 while (i != Utils->timeoutlist.end())
272 TreeSocket* s = i->first;
273 std::pair<std::string, int> p = i->second;
274 std::map<TreeSocket*, std::pair<std::string, int> >::iterator me = i;
276 if (s->GetLinkState() == DYING)
278 Utils->timeoutlist.erase(me);
281 else if (curtime > s->age + p.second)
283 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002 (timeout of %d seconds)",p.first.c_str(),p.second);
284 Utils->timeoutlist.erase(me);
290 ModResult ModuleSpanningTree::HandleVersion(const std::vector<std::string>& parameters, User* user)
292 // we've already checked if pcnt > 0, so this is safe
293 TreeServer* found = Utils->FindServerMask(parameters[0]);
296 if (found == Utils->TreeRoot)
298 // Pass to default VERSION handler.
299 return MOD_RES_PASSTHRU;
302 // If an oper wants to see the version then show the full version string instead of the normal,
303 // but only if it is non-empty.
304 // If it's empty it might be that the server is still syncing (full version hasn't arrived yet)
305 // or the server is a 2.0 server and does not send a full version.
306 bool showfull = ((user->IsOper()) && (!found->GetFullVersion().empty()));
307 const std::string& Version = (showfull ? found->GetFullVersion() : found->GetVersion());
308 user->WriteNumeric(RPL_VERSION, ":%s", Version.c_str());
312 user->WriteNumeric(ERR_NOSUCHSERVER, "%s :No such server", parameters[0].c_str());
317 /* This method will attempt to get a message to a remote user.
319 void ModuleSpanningTree::RemoteMessage(User* user, const char* format, ...)
322 VAFORMAT(text, format, format);
325 user->WriteNotice(text);
327 ServerInstance->PI->SendUserNotice(user, text);
330 ModResult ModuleSpanningTree::HandleConnect(const std::vector<std::string>& parameters, User* user)
332 for (std::vector<reference<Link> >::iterator i = Utils->LinkBlocks.begin(); i < Utils->LinkBlocks.end(); i++)
335 if (InspIRCd::Match(x->Name.c_str(),parameters[0], rfc_case_insensitive_map))
337 if (InspIRCd::Match(ServerInstance->Config->ServerName, assign(x->Name), rfc_case_insensitive_map))
339 RemoteMessage(user, "*** CONNECT: Server \002%s\002 is ME, not connecting.",x->Name.c_str());
343 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
346 RemoteMessage(user, "*** CONNECT: Connecting to server: \002%s\002 (%s:%d)",x->Name.c_str(),(x->HiddenFromStats ? "<hidden>" : x->IPAddr.c_str()),x->Port);
352 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());
357 RemoteMessage(user, "*** CONNECT: No server matching \002%s\002 could be found in the config file.",parameters[0].c_str());
361 void ModuleSpanningTree::OnUserInvite(User* source,User* dest,Channel* channel, time_t expiry)
363 if (IS_LOCAL(source))
365 CmdBuilder params(source, "INVITE");
366 params.push_back(dest->uuid);
367 params.push_back(channel->name);
368 params.push_int(channel->age);
369 params.push_back(ConvToStr(expiry));
374 void ModuleSpanningTree::OnPostTopicChange(User* user, Channel* chan, const std::string &topic)
376 // Drop remote events on the floor.
380 CommandFTopic::Builder(user, chan).Broadcast();
383 void ModuleSpanningTree::OnUserMessage(User* user, void* dest, int target_type, const std::string& text, char status, const CUList& exempt_list, MessageType msgtype)
388 const char* message_type = (msgtype == MSG_PRIVMSG ? "PRIVMSG" : "NOTICE");
389 if (target_type == TYPE_USER)
391 User* d = (User*) dest;
394 CmdBuilder params(user, message_type);
395 params.push_back(d->uuid);
396 params.push_last(text);
400 else if (target_type == TYPE_CHANNEL)
402 Utils->SendChannelMessage(user->uuid, (Channel*)dest, text, status, exempt_list, message_type);
404 else if (target_type == TYPE_SERVER)
406 char* target = (char*) dest;
407 CmdBuilder par(user, message_type);
408 par.push_back(target);
414 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
416 AutoConnectServers(curtime);
417 DoConnectTimeout(curtime);
420 void ModuleSpanningTree::OnUserConnect(LocalUser* user)
425 CommandUID::Builder(user).Broadcast();
428 CommandOpertype::Builder(user).Broadcast();
430 for(Extensible::ExtensibleStore::const_iterator i = user->GetExtList().begin(); i != user->GetExtList().end(); i++)
432 ExtensionItem* item = i->first;
433 std::string value = item->serialize(FORMAT_NETWORK, user, i->second);
435 ServerInstance->PI->SendMetaData(user, item->name, value);
438 Utils->TreeRoot->UserCount++;
441 void ModuleSpanningTree::OnUserJoin(Membership* memb, bool sync, bool created_by_local, CUList& excepts)
443 // Only do this for local users
444 if (!IS_LOCAL(memb->user))
447 // Assign the current membership id to the new Membership and increase it
448 memb->id = currmembid++;
450 if (created_by_local)
452 CommandFJoin::Builder params(memb->chan);
459 CmdBuilder params(memb->user, "IJOIN");
460 params.push_back(memb->chan->name);
461 params.push_int(memb->id);
462 if (!memb->modes.empty())
464 params.push_back(ConvToStr(memb->chan->age));
465 params.push_back(memb->modes);
471 void ModuleSpanningTree::OnChangeHost(User* user, const std::string &newhost)
473 if (user->registered != REG_ALL || !IS_LOCAL(user))
476 CmdBuilder(user, "FHOST").push(newhost).Broadcast();
479 void ModuleSpanningTree::OnChangeName(User* user, const std::string &gecos)
481 if (user->registered != REG_ALL || !IS_LOCAL(user))
484 CmdBuilder(user, "FNAME").push_last(gecos).Broadcast();
487 void ModuleSpanningTree::OnChangeIdent(User* user, const std::string &ident)
489 if ((user->registered != REG_ALL) || (!IS_LOCAL(user)))
492 CmdBuilder(user, "FIDENT").push(ident).Broadcast();
495 void ModuleSpanningTree::OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts)
497 if (IS_LOCAL(memb->user))
499 CmdBuilder params(memb->user, "PART");
500 params.push_back(memb->chan->name);
501 if (!partmessage.empty())
502 params.push_last(partmessage);
507 void ModuleSpanningTree::OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
511 if (oper_message != reason)
512 ServerInstance->PI->SendMetaData(user, "operquit", oper_message);
514 CmdBuilder(user, "QUIT").push_last(reason).Broadcast();
518 // Hide the message if one of the following is true:
519 // - User is being quit due to a netsplit and quietbursts is on
520 // - Server is a silent uline
521 TreeServer* server = TreeServer::Get(user);
522 bool hide = (((server->IsDead()) && (Utils->quiet_bursts)) || (server->IsSilentULine()));
525 ServerInstance->SNO->WriteToSnoMask('Q', "Client exiting on server %s: %s (%s) [%s]",
526 user->server->GetName().c_str(), user->GetFullRealHost().c_str(), user->GetIPString().c_str(), oper_message.c_str());
530 // Regardless, We need to modify the user Counts..
531 TreeServer::Get(user)->UserCount--;
534 void ModuleSpanningTree::OnUserPostNick(User* user, const std::string &oldnick)
538 // The nick TS is updated by the core, we don't do it
539 CmdBuilder params(user, "NICK");
540 params.push_back(user->nick);
541 params.push_back(ConvToStr(user->age));
546 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);
550 void ModuleSpanningTree::OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts)
552 if ((!IS_LOCAL(source)) && (source != ServerInstance->FakeClient))
555 CmdBuilder params(source, "KICK");
556 params.push_back(memb->chan->name);
557 params.push_back(memb->user->uuid);
558 // If a remote user is being kicked by us then send the membership id in the kick too
559 if (!IS_LOCAL(memb->user))
560 params.push_int(memb->id);
561 params.push_last(reason);
565 void ModuleSpanningTree::OnPreRehash(User* user, const std::string ¶meter)
568 return; // Don't generate a REHASH here if we're in the middle of processing a message that generated this one
570 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "OnPreRehash called with param %s", parameter.c_str());
572 // Send out to other servers
573 if (!parameter.empty() && parameter[0] != '-')
575 CmdBuilder params((user ? user->uuid : ServerInstance->Config->GetSID()), "REHASH");
576 params.push_back(parameter);
577 params.Forward(user ? TreeServer::Get(user)->GetRoute() : NULL);
581 void ModuleSpanningTree::ReadConfig(ConfigStatus& status)
583 // Did this rehash change the description of this server?
584 const std::string& newdesc = ServerInstance->Config->ServerDesc;
585 if (newdesc != Utils->TreeRoot->GetDesc())
587 // Broadcast a SINFO desc message to let the network know about the new description. This is the description
588 // string that is sent in the SERVER message initially and shown for example in WHOIS.
589 // We don't need to update the field itself in the Server object - the core does that.
590 CommandSInfo::Builder(Utils->TreeRoot, "desc", newdesc).Broadcast();
593 // Re-read config stuff
596 Utils->ReadConfiguration();
598 catch (ModuleException& e)
600 // Refresh the IP cache anyway, so servers read before the error will be allowed to connect
601 Utils->RefreshIPCache();
602 // Always warn local opers with snomask +l, also warn globally (snomask +L) if the rehash was issued by a remote user
603 std::string msg = "Error in configuration: ";
604 msg.append(e.GetReason());
605 ServerInstance->SNO->WriteToSnoMask('l', msg);
606 if (status.srcuser && !IS_LOCAL(status.srcuser))
607 ServerInstance->PI->SendSNONotice('L', msg);
611 void ModuleSpanningTree::OnLoadModule(Module* mod)
615 data.append(mod->ModuleSourceFile);
616 Version v = mod->GetVersion();
617 if (!v.link_data.empty())
620 data.append(v.link_data);
622 ServerInstance->PI->SendMetaData("modules", data);
625 void ModuleSpanningTree::OnUnloadModule(Module* mod)
629 ServerInstance->PI->SendMetaData("modules", "-" + mod->ModuleSourceFile);
632 // Close all connections which use an IO hook provided by this module
633 const TreeServer::ChildServers& list = Utils->TreeRoot->GetChildren();
634 for (TreeServer::ChildServers::const_iterator i = list.begin(); i != list.end(); ++i)
636 TreeSocket* sock = (*i)->GetSocket();
637 if (sock->GetIOHook() && sock->GetIOHook()->prov->creator == mod)
639 sock->SendError("SSL module unloaded");
641 // XXX: The list we're iterating is modified by TreeServer::SQuit() which is called by Close()
646 for (SpanningTreeUtilities::TimeoutList::const_iterator i = Utils->timeoutlist.begin(); i != Utils->timeoutlist.end(); ++i)
648 TreeSocket* sock = i->first;
649 if (sock->GetIOHook() && sock->GetIOHook()->prov->creator == mod)
654 // note: the protocol does not allow direct umode +o except
655 // via NICK with 8 params. sending OPERTYPE infers +o modechange
657 void ModuleSpanningTree::OnOper(User* user, const std::string &opertype)
659 if (user->registered != REG_ALL || !IS_LOCAL(user))
661 CommandOpertype::Builder(user).Broadcast();
664 void ModuleSpanningTree::OnAddLine(User* user, XLine *x)
666 if (!x->IsBurstable() || loopCall || (user && !IS_LOCAL(user)))
670 user = ServerInstance->FakeClient;
672 CommandAddLine::Builder(x, user).Broadcast();
675 void ModuleSpanningTree::OnDelLine(User* user, XLine *x)
677 if (!x->IsBurstable() || loopCall || (user && !IS_LOCAL(user)))
681 user = ServerInstance->FakeClient;
683 CmdBuilder params(user, "DELLINE");
684 params.push_back(x->type);
685 params.push_back(x->Displayable());
689 ModResult ModuleSpanningTree::OnSetAway(User* user, const std::string &awaymsg)
692 CommandAway::Builder(user, awaymsg).Broadcast();
694 return MOD_RES_PASSTHRU;
697 void ModuleSpanningTree::OnMode(User* source, User* u, Channel* c, const Modes::ChangeList& modes, ModeParser::ModeProcessFlag processflags, const std::string& output_mode)
699 if (processflags & ModeParser::MODE_LOCALONLY)
704 if (u->registered != REG_ALL)
707 CmdBuilder params(source, "MODE");
708 params.push(u->uuid);
709 params.push(output_mode);
710 params.push_raw(Translate::ModeChangeListToParams(modes.getlist()));
715 CmdBuilder params(source, "FMODE");
716 params.push(c->name);
717 params.push_int(c->age);
718 params.push(output_mode);
719 params.push_raw(Translate::ModeChangeListToParams(modes.getlist()));
724 CullResult ModuleSpanningTree::cull()
728 return this->Module::cull();
731 ModuleSpanningTree::~ModuleSpanningTree()
733 ServerInstance->PI = &ServerInstance->DefaultProtocolInterface;
735 Server* newsrv = new Server(ServerInstance->Config->ServerName, ServerInstance->Config->ServerDesc);
736 SetLocalUsersServer(newsrv);
738 /* This will also free the listeners */
744 Version ModuleSpanningTree::GetVersion()
746 return Version("Allows servers to be linked", VF_VENDOR);
749 /* It is IMPORTANT that m_spanningtree is the last module in the chain
750 * so that any activity it sees is FINAL, e.g. we arent going to send out
751 * a NICK message before m_cloaking has finished putting the +x on the user,
753 * Therefore, we return PRIORITY_LAST to make sure we end up at the END of
754 * the module call queue.
756 void ModuleSpanningTree::Prioritize()
758 ServerInstance->Modules->SetPriority(this, PRIORITY_LAST);
761 MODULE_INIT(ModuleSpanningTree)