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 "protocolinterface.h"
38 ModuleSpanningTree::ModuleSpanningTree()
39 : rconnect(this), rsquit(this), map(this)
40 , commands(NULL), DNS(this, "DNS")
44 SpanningTreeCommands::SpanningTreeCommands(ModuleSpanningTree* module)
45 : svsjoin(module), svspart(module), svsnick(module), metadata(module),
46 uid(module), opertype(module), fjoin(module), ijoin(module), resync(module),
47 fmode(module), ftopic(module), fhost(module), fident(module), fname(module),
48 away(module), addline(module), delline(module), encap(module), idle(module),
49 nick(module), ping(module), pong(module), push(module), save(module),
50 server(module), squit(module), snonotice(module), version(module),
51 burst(module), endburst(module)
55 void ModuleSpanningTree::init()
57 ServerInstance->SNO->EnableSnomask('l', "LINK");
59 Utils = new SpanningTreeUtilities(this);
60 Utils->TreeRoot = new TreeServer;
61 commands = new SpanningTreeCommands(this);
63 delete ServerInstance->PI;
64 ServerInstance->PI = new SpanningTreeProtocolInterface;
67 // update our local user count
68 Utils->TreeRoot->UserCount = ServerInstance->Users->local_users.size();
71 void ModuleSpanningTree::ShowLinks(TreeServer* Current, User* user, int hops)
73 std::string Parent = Utils->TreeRoot->GetName();
74 if (Current->GetParent())
76 Parent = Current->GetParent()->GetName();
79 const TreeServer::ChildServers& children = Current->GetChildren();
80 for (TreeServer::ChildServers::const_iterator i = children.begin(); i != children.end(); ++i)
82 TreeServer* server = *i;
83 if ((server->Hidden) || ((Utils->HideULines) && (ServerInstance->ULine(server->GetName()))))
87 ShowLinks(server, user, hops+1);
92 ShowLinks(server, user, hops+1);
95 /* Don't display the line if its a uline, hide ulines is on, and the user isnt an oper */
96 if ((Utils->HideULines) && (ServerInstance->ULine(Current->GetName())) && (!user->IsOper()))
98 /* Or if the server is hidden and they're not an oper */
99 else if ((Current->Hidden) && (!user->IsOper()))
102 user->WriteNumeric(364, "%s %s %s :%d %s", user->nick.c_str(), Current->GetName().c_str(),
103 (Utils->FlatLinks && (!user->IsOper())) ? ServerInstance->Config->ServerName.c_str() : Parent.c_str(),
104 (Utils->FlatLinks && (!user->IsOper())) ? 0 : hops,
105 Current->GetDesc().c_str());
108 void ModuleSpanningTree::HandleLinks(const std::vector<std::string>& parameters, User* user)
110 ShowLinks(Utils->TreeRoot,user,0);
111 user->WriteNumeric(365, "%s * :End of /LINKS list.",user->nick.c_str());
114 std::string ModuleSpanningTree::TimeToStr(time_t secs)
116 time_t mins_up = secs / 60;
117 time_t hours_up = mins_up / 60;
118 time_t days_up = hours_up / 24;
120 mins_up = mins_up % 60;
121 hours_up = hours_up % 24;
122 return ((days_up ? (ConvToStr(days_up) + "d") : "")
123 + (hours_up ? (ConvToStr(hours_up) + "h") : "")
124 + (mins_up ? (ConvToStr(mins_up) + "m") : "")
125 + ConvToStr(secs) + "s");
128 void ModuleSpanningTree::DoPingChecks(time_t curtime)
131 * Cancel remote burst mode on any servers which still have it enabled due to latency/lack of data.
132 * This prevents lost REMOTECONNECT notices
134 long ts = ServerInstance->Time() * 1000 + (ServerInstance->Time_ns() / 1000000);
137 for (server_hash::iterator i = Utils->serverlist.begin(); i != Utils->serverlist.end(); i++)
139 TreeServer *s = i->second;
145 if (s->GetSocket()->GetLinkState() == DYING)
147 s->GetSocket()->Close();
151 // Do not ping servers that are not fully connected yet!
152 // Servers which are connected to us have IsLocal() == true and if they're fully connected
153 // then Socket->LinkState == CONNECTED. Servers that are linked to another server are always fully connected.
154 if (s->IsLocal() && s->GetSocket()->GetLinkState() != CONNECTED)
157 // Now do PING checks on all servers
158 // Only ping if this server needs one
159 if (curtime >= s->NextPingTime())
161 // And if they answered the last
162 if (s->AnsweredLastPing())
164 // They did, send a ping to them
165 s->SetNextPingTime(curtime + Utils->PingFreq);
166 s->GetSocket()->WriteLine(":" + ServerInstance->Config->GetSID() + " PING " + s->GetID());
167 s->LastPingMsec = ts;
171 // They didn't answer the last ping, if they are locally connected, get rid of them.
174 TreeSocket* sock = s->GetSocket();
175 sock->SendError("Ping timeout");
182 // If warn on ping enabled and not warned and the difference is sufficient and they didn't answer the last ping...
183 if ((Utils->PingWarnTime) && (!s->Warned) && (curtime >= s->NextPingTime() - (Utils->PingFreq - Utils->PingWarnTime)) && (!s->AnsweredLastPing()))
185 /* The server hasnt responded, send a warning to opers */
186 ServerInstance->SNO->WriteToSnoMask('l',"Server \002%s\002 has not responded to PING for %d seconds, high latency.", s->GetName().c_str(), Utils->PingWarnTime);
192 void ModuleSpanningTree::ConnectServer(Autoconnect* a, bool on_timer)
196 for(unsigned int j=0; j < a->servers.size(); j++)
198 if (Utils->FindServer(a->servers[j]))
200 // found something in this block. Should the server fail,
201 // we want to start at the start of the list, not in the
202 // middle where we left off
207 if (on_timer && a->position >= 0)
209 if (!on_timer && a->position < 0)
213 while (a->position < (int)a->servers.size())
215 Link* x = Utils->FindLink(a->servers[a->position]);
218 ServerInstance->SNO->WriteToSnoMask('l', "AUTOCONNECT: Auto-connecting server \002%s\002", x->Name.c_str());
224 // Autoconnect chain has been fully iterated; start at the beginning on the
225 // next AutoConnectServers run
229 void ModuleSpanningTree::ConnectServer(Link* x, Autoconnect* y)
233 if (InspIRCd::Match(ServerInstance->Config->ServerName, assign(x->Name)))
235 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Not connecting to myself.");
239 DNS::QueryType start_type = DNS::QUERY_AAAA;
240 if (strchr(x->IPAddr.c_str(),':'))
243 if (inet_pton(AF_INET6, x->IPAddr.c_str(), &n) < 1)
249 if (inet_aton(x->IPAddr.c_str(),&n) < 1)
253 /* Do we already have an IP? If so, no need to resolve it. */
256 /* Gave a hook, but it wasnt one we know */
257 TreeSocket* newsocket = new TreeSocket(x, y, x->IPAddr);
258 if (newsocket->GetFd() > -1)
260 /* Handled automatically on success */
264 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s.",
265 x->Name.c_str(), newsocket->getError().c_str());
266 ServerInstance->GlobalCulls.AddItem(newsocket);
271 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());
275 ServernameResolver* snr = new ServernameResolver(*DNS, x->IPAddr, x, start_type, y);
280 catch (DNS::Exception& e)
283 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason());
284 ConnectServer(y, false);
289 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
291 for (std::vector<reference<Autoconnect> >::iterator i = Utils->AutoconnectBlocks.begin(); i < Utils->AutoconnectBlocks.end(); ++i)
294 if (curtime >= x->NextConnectTime)
296 x->NextConnectTime = curtime + x->Period;
297 ConnectServer(x, true);
302 void ModuleSpanningTree::DoConnectTimeout(time_t curtime)
304 std::map<TreeSocket*, std::pair<std::string, int> >::iterator i = Utils->timeoutlist.begin();
305 while (i != Utils->timeoutlist.end())
307 TreeSocket* s = i->first;
308 std::pair<std::string, int> p = i->second;
309 std::map<TreeSocket*, std::pair<std::string, int> >::iterator me = i;
311 if (s->GetLinkState() == DYING)
313 Utils->timeoutlist.erase(me);
316 else if (curtime > s->age + p.second)
318 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002 (timeout of %d seconds)",p.first.c_str(),p.second);
319 Utils->timeoutlist.erase(me);
325 ModResult ModuleSpanningTree::HandleVersion(const std::vector<std::string>& parameters, User* user)
327 // we've already checked if pcnt > 0, so this is safe
328 TreeServer* found = Utils->FindServerMask(parameters[0]);
331 if (found == Utils->TreeRoot)
333 // Pass to default VERSION handler.
334 return MOD_RES_PASSTHRU;
336 std::string Version = found->GetVersion();
337 user->WriteNumeric(351, "%s :%s",user->nick.c_str(),Version.c_str());
341 user->WriteNumeric(402, "%s %s :No such server",user->nick.c_str(),parameters[0].c_str());
346 /* This method will attempt to get a message to a remote user.
348 void ModuleSpanningTree::RemoteMessage(User* user, const char* format, ...)
351 VAFORMAT(text, format, format);
354 user->WriteNotice(text);
356 ServerInstance->PI->SendUserNotice(user, text);
359 ModResult ModuleSpanningTree::HandleConnect(const std::vector<std::string>& parameters, User* user)
361 for (std::vector<reference<Link> >::iterator i = Utils->LinkBlocks.begin(); i < Utils->LinkBlocks.end(); i++)
364 if (InspIRCd::Match(x->Name.c_str(),parameters[0]))
366 if (InspIRCd::Match(ServerInstance->Config->ServerName, assign(x->Name)))
368 RemoteMessage(user, "*** CONNECT: Server \002%s\002 is ME, not connecting.",x->Name.c_str());
372 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
375 RemoteMessage(user, "*** CONNECT: Connecting to server: \002%s\002 (%s:%d)",x->Name.c_str(),(x->HiddenFromStats ? "<hidden>" : x->IPAddr.c_str()),x->Port);
381 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());
386 RemoteMessage(user, "*** CONNECT: No server matching \002%s\002 could be found in the config file.",parameters[0].c_str());
390 void ModuleSpanningTree::On005Numeric(std::map<std::string, std::string>& tokens)
395 void ModuleSpanningTree::OnGetServerDescription(const std::string &servername,std::string &description)
397 TreeServer* s = Utils->FindServer(servername);
400 description = s->GetDesc();
404 void ModuleSpanningTree::OnUserInvite(User* source,User* dest,Channel* channel, time_t expiry)
406 if (IS_LOCAL(source))
408 CmdBuilder params(source, "INVITE");
409 params.push_back(dest->uuid);
410 params.push_back(channel->name);
411 params.push_back(ConvToStr(expiry));
416 void ModuleSpanningTree::OnPostTopicChange(User* user, Channel* chan, const std::string &topic)
418 // Drop remote events on the floor.
422 CommandFTopic::Builder(user, chan).Broadcast();
425 void ModuleSpanningTree::OnUserMessage(User* user, void* dest, int target_type, const std::string& text, char status, const CUList& exempt_list, MessageType msgtype)
430 const char* message_type = (msgtype == MSG_PRIVMSG ? "PRIVMSG" : "NOTICE");
431 if (target_type == TYPE_USER)
433 User* d = (User*) dest;
436 CmdBuilder params(user, message_type);
437 params.push_back(d->uuid);
438 params.push_last(text);
442 else if (target_type == TYPE_CHANNEL)
444 Utils->SendChannelMessage(user->uuid, (Channel*)dest, text, status, exempt_list, message_type);
446 else if (target_type == TYPE_SERVER)
448 char* target = (char*) dest;
449 CmdBuilder par(user, message_type);
450 par.push_back(target);
456 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
458 AutoConnectServers(curtime);
459 DoPingChecks(curtime);
460 DoConnectTimeout(curtime);
463 void ModuleSpanningTree::OnUserConnect(LocalUser* user)
468 CommandUID::Builder(user).Broadcast();
471 CommandOpertype::Builder(user).Broadcast();
473 for(Extensible::ExtensibleStore::const_iterator i = user->GetExtList().begin(); i != user->GetExtList().end(); i++)
475 ExtensionItem* item = i->first;
476 std::string value = item->serialize(FORMAT_NETWORK, user, i->second);
478 ServerInstance->PI->SendMetaData(user, item->name, value);
481 Utils->TreeRoot->UserCount++;
484 void ModuleSpanningTree::OnUserJoin(Membership* memb, bool sync, bool created_by_local, CUList& excepts)
486 // Only do this for local users
487 if (!IS_LOCAL(memb->user))
490 if (created_by_local)
492 CmdBuilder params("FJOIN");
493 params.push_back(memb->chan->name);
494 params.push_back(ConvToStr(memb->chan->age));
495 params.push_raw(" +").push_raw(memb->chan->ChanModes(true));
496 params.push(memb->modes).push_raw(',').push_raw(memb->user->uuid);
501 CmdBuilder params(memb->user, "IJOIN");
502 params.push_back(memb->chan->name);
503 if (!memb->modes.empty())
505 params.push_back(ConvToStr(memb->chan->age));
506 params.push_back(memb->modes);
512 void ModuleSpanningTree::OnChangeHost(User* user, const std::string &newhost)
514 if (user->registered != REG_ALL || !IS_LOCAL(user))
517 CmdBuilder(user, "FHOST").push(newhost).Broadcast();
520 void ModuleSpanningTree::OnChangeName(User* user, const std::string &gecos)
522 if (user->registered != REG_ALL || !IS_LOCAL(user))
525 CmdBuilder(user, "FNAME").push(gecos).Broadcast();
528 void ModuleSpanningTree::OnChangeIdent(User* user, const std::string &ident)
530 if ((user->registered != REG_ALL) || (!IS_LOCAL(user)))
533 CmdBuilder(user, "FIDENT").push(ident).Broadcast();
536 void ModuleSpanningTree::OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts)
538 if (IS_LOCAL(memb->user))
540 CmdBuilder params(memb->user, "PART");
541 params.push_back(memb->chan->name);
542 if (!partmessage.empty())
543 params.push_last(partmessage);
548 void ModuleSpanningTree::OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
550 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
552 if (oper_message != reason)
553 ServerInstance->PI->SendMetaData(user, "operquit", oper_message);
555 CmdBuilder(user, "QUIT").push_last(reason).Broadcast();
558 // Regardless, We need to modify the user Counts..
559 TreeServer* SourceServer = Utils->FindServer(user->server);
562 SourceServer->UserCount--;
566 void ModuleSpanningTree::OnUserPostNick(User* user, const std::string &oldnick)
570 CmdBuilder params(user, "NICK");
571 params.push_back(user->nick);
573 /** IMPORTANT: We don't update the TS if the oldnick is just a case change of the newnick!
575 if (irc::string(user->nick.c_str()) != assign(oldnick))
576 user->age = ServerInstance->Time();
578 params.push_back(ConvToStr(user->age));
581 else if (!loopCall && user->nick == user->uuid)
583 CmdBuilder params("SAVE");
584 params.push_back(user->uuid);
585 params.push_back(ConvToStr(user->age));
590 void ModuleSpanningTree::OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts)
592 if ((!IS_LOCAL(source) || source != ServerInstance->FakeClient))
595 CmdBuilder params(source, "KICK");
596 params.push_back(memb->chan->name);
597 params.push_back(memb->user->uuid);
598 params.push_last(reason);
602 void ModuleSpanningTree::OnPreRehash(User* user, const std::string ¶meter)
605 return; // Don't generate a REHASH here if we're in the middle of processing a message that generated this one
607 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "OnPreRehash called with param %s", parameter.c_str());
609 // Send out to other servers
610 if (!parameter.empty() && parameter[0] != '-')
612 CmdBuilder params((user ? user->uuid : ServerInstance->Config->GetSID()), "REHASH");
613 params.push_back(parameter);
614 params.Forward(user ? Utils->BestRouteTo(user->server) : NULL);
618 void ModuleSpanningTree::ReadConfig(ConfigStatus& status)
620 // Re-read config stuff
623 Utils->ReadConfiguration();
625 catch (ModuleException& e)
627 // Refresh the IP cache anyway, so servers read before the error will be allowed to connect
628 Utils->RefreshIPCache();
629 // Always warn local opers with snomask +l, also warn globally (snomask +L) if the rehash was issued by a remote user
630 std::string msg = "Error in configuration: ";
631 msg.append(e.GetReason());
632 ServerInstance->SNO->WriteToSnoMask('l', msg);
633 if (status.srcuser && !IS_LOCAL(status.srcuser))
634 ServerInstance->PI->SendSNONotice("L", msg);
638 void ModuleSpanningTree::OnLoadModule(Module* mod)
642 data.append(mod->ModuleSourceFile);
643 Version v = mod->GetVersion();
644 if (!v.link_data.empty())
647 data.append(v.link_data);
649 ServerInstance->PI->SendMetaData("modules", data);
652 void ModuleSpanningTree::OnUnloadModule(Module* mod)
656 ServerInstance->PI->SendMetaData("modules", "-" + mod->ModuleSourceFile);
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 && sock->GetIOHook() && sock->GetIOHook()->creator == mod)
665 sock->SendError("SSL module unloaded");
670 for (SpanningTreeUtilities::TimeoutList::const_iterator i = Utils->timeoutlist.begin(); i != Utils->timeoutlist.end(); ++i)
672 TreeSocket* sock = i->first;
673 if (sock->GetIOHook() && sock->GetIOHook()->creator == mod)
678 // note: the protocol does not allow direct umode +o except
679 // via NICK with 8 params. sending OPERTYPE infers +o modechange
681 void ModuleSpanningTree::OnOper(User* user, const std::string &opertype)
683 if (user->registered != REG_ALL || !IS_LOCAL(user))
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::ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata)
723 TreeSocket* s = static_cast<TreeSocket*>(opaque);
724 User* u = dynamic_cast<User*>(target);
725 Channel* c = dynamic_cast<Channel*>(target);
727 s->WriteLine(":"+ServerInstance->Config->GetSID()+" METADATA "+u->uuid+" "+extname+" :"+extdata);
729 s->WriteLine(":"+ServerInstance->Config->GetSID()+" METADATA "+c->name+" "+ConvToStr(c->age)+" "+extname+" :"+extdata);
731 s->WriteLine(":"+ServerInstance->Config->GetSID()+" METADATA * "+extname+" :"+extdata);
734 CullResult ModuleSpanningTree::cull()
738 return this->Module::cull();
741 ModuleSpanningTree::~ModuleSpanningTree()
743 delete ServerInstance->PI;
744 ServerInstance->PI = new ProtocolInterface;
746 /* This will also free the listeners */
752 Version ModuleSpanningTree::GetVersion()
754 return Version("Allows servers to be linked", VF_VENDOR);
757 /* It is IMPORTANT that m_spanningtree is the last module in the chain
758 * so that any activity it sees is FINAL, e.g. we arent going to send out
759 * a NICK message before m_cloaking has finished putting the +x on the user,
761 * Therefore, we return PRIORITY_LAST to make sure we end up at the END of
762 * the module call queue.
764 void ModuleSpanningTree::Prioritize()
766 ServerInstance->Modules->SetPriority(this, PRIORITY_LAST);
769 MODULE_INIT(ModuleSpanningTree)