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 : commands(NULL), DNS(this, "DNS")
43 SpanningTreeCommands::SpanningTreeCommands(ModuleSpanningTree* module)
44 : rconnect(module), rsquit(module), map(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);
62 ServerInstance->Modules->AddService(commands->rconnect);
63 ServerInstance->Modules->AddService(commands->rsquit);
64 ServerInstance->Modules->AddService(commands->map);
66 delete ServerInstance->PI;
67 ServerInstance->PI = new SpanningTreeProtocolInterface;
70 // update our local user count
71 Utils->TreeRoot->UserCount = ServerInstance->Users->local_users.size();
74 void ModuleSpanningTree::ShowLinks(TreeServer* Current, User* user, int hops)
76 std::string Parent = Utils->TreeRoot->GetName();
77 if (Current->GetParent())
79 Parent = Current->GetParent()->GetName();
82 const TreeServer::ChildServers& children = Current->GetChildren();
83 for (TreeServer::ChildServers::const_iterator i = children.begin(); i != children.end(); ++i)
85 TreeServer* server = *i;
86 if ((server->Hidden) || ((Utils->HideULines) && (ServerInstance->ULine(server->GetName()))))
90 ShowLinks(server, user, hops+1);
95 ShowLinks(server, user, hops+1);
98 /* Don't display the line if its a uline, hide ulines is on, and the user isnt an oper */
99 if ((Utils->HideULines) && (ServerInstance->ULine(Current->GetName())) && (!user->IsOper()))
101 /* Or if the server is hidden and they're not an oper */
102 else if ((Current->Hidden) && (!user->IsOper()))
105 user->WriteNumeric(364, "%s %s %s :%d %s", user->nick.c_str(), Current->GetName().c_str(),
106 (Utils->FlatLinks && (!user->IsOper())) ? ServerInstance->Config->ServerName.c_str() : Parent.c_str(),
107 (Utils->FlatLinks && (!user->IsOper())) ? 0 : hops,
108 Current->GetDesc().c_str());
111 void ModuleSpanningTree::HandleLinks(const std::vector<std::string>& parameters, User* user)
113 ShowLinks(Utils->TreeRoot,user,0);
114 user->WriteNumeric(365, "%s * :End of /LINKS list.",user->nick.c_str());
117 std::string ModuleSpanningTree::TimeToStr(time_t secs)
119 time_t mins_up = secs / 60;
120 time_t hours_up = mins_up / 60;
121 time_t days_up = hours_up / 24;
123 mins_up = mins_up % 60;
124 hours_up = hours_up % 24;
125 return ((days_up ? (ConvToStr(days_up) + "d") : "")
126 + (hours_up ? (ConvToStr(hours_up) + "h") : "")
127 + (mins_up ? (ConvToStr(mins_up) + "m") : "")
128 + ConvToStr(secs) + "s");
131 void ModuleSpanningTree::DoPingChecks(time_t curtime)
134 * Cancel remote burst mode on any servers which still have it enabled due to latency/lack of data.
135 * This prevents lost REMOTECONNECT notices
137 long ts = ServerInstance->Time() * 1000 + (ServerInstance->Time_ns() / 1000000);
140 for (server_hash::iterator i = Utils->serverlist.begin(); i != Utils->serverlist.end(); i++)
142 TreeServer *s = i->second;
148 if (s->GetSocket()->GetLinkState() == DYING)
150 s->GetSocket()->Close();
154 // Do not ping servers that are not fully connected yet!
155 // Servers which are connected to us have IsLocal() == true and if they're fully connected
156 // then Socket->LinkState == CONNECTED. Servers that are linked to another server are always fully connected.
157 if (s->IsLocal() && s->GetSocket()->GetLinkState() != CONNECTED)
160 // Now do PING checks on all servers
161 // Only ping if this server needs one
162 if (curtime >= s->NextPingTime())
164 // And if they answered the last
165 if (s->AnsweredLastPing())
167 // They did, send a ping to them
168 s->SetNextPingTime(curtime + Utils->PingFreq);
169 s->GetSocket()->WriteLine(":" + ServerInstance->Config->GetSID() + " PING " + s->GetID());
170 s->LastPingMsec = ts;
174 // They didn't answer the last ping, if they are locally connected, get rid of them.
177 TreeSocket* sock = s->GetSocket();
178 sock->SendError("Ping timeout");
185 // If warn on ping enabled and not warned and the difference is sufficient and they didn't answer the last ping...
186 if ((Utils->PingWarnTime) && (!s->Warned) && (curtime >= s->NextPingTime() - (Utils->PingFreq - Utils->PingWarnTime)) && (!s->AnsweredLastPing()))
188 /* The server hasnt responded, send a warning to opers */
189 ServerInstance->SNO->WriteToSnoMask('l',"Server \002%s\002 has not responded to PING for %d seconds, high latency.", s->GetName().c_str(), Utils->PingWarnTime);
195 void ModuleSpanningTree::ConnectServer(Autoconnect* a, bool on_timer)
199 for(unsigned int j=0; j < a->servers.size(); j++)
201 if (Utils->FindServer(a->servers[j]))
203 // found something in this block. Should the server fail,
204 // we want to start at the start of the list, not in the
205 // middle where we left off
210 if (on_timer && a->position >= 0)
212 if (!on_timer && a->position < 0)
216 while (a->position < (int)a->servers.size())
218 Link* x = Utils->FindLink(a->servers[a->position]);
221 ServerInstance->SNO->WriteToSnoMask('l', "AUTOCONNECT: Auto-connecting server \002%s\002", x->Name.c_str());
227 // Autoconnect chain has been fully iterated; start at the beginning on the
228 // next AutoConnectServers run
232 void ModuleSpanningTree::ConnectServer(Link* x, Autoconnect* y)
236 if (InspIRCd::Match(ServerInstance->Config->ServerName, assign(x->Name)))
238 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Not connecting to myself.");
242 DNS::QueryType start_type = DNS::QUERY_AAAA;
243 if (strchr(x->IPAddr.c_str(),':'))
246 if (inet_pton(AF_INET6, x->IPAddr.c_str(), &n) < 1)
252 if (inet_aton(x->IPAddr.c_str(),&n) < 1)
256 /* Do we already have an IP? If so, no need to resolve it. */
259 /* Gave a hook, but it wasnt one we know */
260 TreeSocket* newsocket = new TreeSocket(x, y, x->IPAddr);
261 if (newsocket->GetFd() > -1)
263 /* Handled automatically on success */
267 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s.",
268 x->Name.c_str(), newsocket->getError().c_str());
269 ServerInstance->GlobalCulls.AddItem(newsocket);
274 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());
278 ServernameResolver* snr = new ServernameResolver(*DNS, x->IPAddr, x, start_type, y);
283 catch (DNS::Exception& e)
286 ServerInstance->SNO->WriteToSnoMask('l', "CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason());
287 ConnectServer(y, false);
292 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
294 for (std::vector<reference<Autoconnect> >::iterator i = Utils->AutoconnectBlocks.begin(); i < Utils->AutoconnectBlocks.end(); ++i)
297 if (curtime >= x->NextConnectTime)
299 x->NextConnectTime = curtime + x->Period;
300 ConnectServer(x, true);
305 void ModuleSpanningTree::DoConnectTimeout(time_t curtime)
307 std::map<TreeSocket*, std::pair<std::string, int> >::iterator i = Utils->timeoutlist.begin();
308 while (i != Utils->timeoutlist.end())
310 TreeSocket* s = i->first;
311 std::pair<std::string, int> p = i->second;
312 std::map<TreeSocket*, std::pair<std::string, int> >::iterator me = i;
314 if (s->GetLinkState() == DYING)
316 Utils->timeoutlist.erase(me);
319 else if (curtime > s->age + p.second)
321 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002 (timeout of %d seconds)",p.first.c_str(),p.second);
322 Utils->timeoutlist.erase(me);
328 ModResult ModuleSpanningTree::HandleVersion(const std::vector<std::string>& parameters, User* user)
330 // we've already checked if pcnt > 0, so this is safe
331 TreeServer* found = Utils->FindServerMask(parameters[0]);
334 if (found == Utils->TreeRoot)
336 // Pass to default VERSION handler.
337 return MOD_RES_PASSTHRU;
339 std::string Version = found->GetVersion();
340 user->WriteNumeric(351, "%s :%s",user->nick.c_str(),Version.c_str());
344 user->WriteNumeric(402, "%s %s :No such server",user->nick.c_str(),parameters[0].c_str());
349 /* This method will attempt to get a message to a remote user.
351 void ModuleSpanningTree::RemoteMessage(User* user, const char* format, ...)
354 VAFORMAT(text, format, format);
357 user->WriteNotice(text);
359 ServerInstance->PI->SendUserNotice(user, text);
362 ModResult ModuleSpanningTree::HandleConnect(const std::vector<std::string>& parameters, User* user)
364 for (std::vector<reference<Link> >::iterator i = Utils->LinkBlocks.begin(); i < Utils->LinkBlocks.end(); i++)
367 if (InspIRCd::Match(x->Name.c_str(),parameters[0]))
369 if (InspIRCd::Match(ServerInstance->Config->ServerName, assign(x->Name)))
371 RemoteMessage(user, "*** CONNECT: Server \002%s\002 is ME, not connecting.",x->Name.c_str());
375 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
378 RemoteMessage(user, "*** CONNECT: Connecting to server: \002%s\002 (%s:%d)",x->Name.c_str(),(x->HiddenFromStats ? "<hidden>" : x->IPAddr.c_str()),x->Port);
384 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());
389 RemoteMessage(user, "*** CONNECT: No server matching \002%s\002 could be found in the config file.",parameters[0].c_str());
393 void ModuleSpanningTree::On005Numeric(std::map<std::string, std::string>& tokens)
398 void ModuleSpanningTree::OnGetServerDescription(const std::string &servername,std::string &description)
400 TreeServer* s = Utils->FindServer(servername);
403 description = s->GetDesc();
407 void ModuleSpanningTree::OnUserInvite(User* source,User* dest,Channel* channel, time_t expiry)
409 if (IS_LOCAL(source))
411 CmdBuilder params(source, "INVITE");
412 params.push_back(dest->uuid);
413 params.push_back(channel->name);
414 params.push_back(ConvToStr(expiry));
419 void ModuleSpanningTree::OnPostTopicChange(User* user, Channel* chan, const std::string &topic)
421 // Drop remote events on the floor.
425 CmdBuilder params(user->uuid, "TOPIC");
426 params.push_back(chan->name);
427 params.push_last(topic);
431 void ModuleSpanningTree::OnUserMessage(User* user, void* dest, int target_type, const std::string& text, char status, const CUList& exempt_list, MessageType msgtype)
436 const char* message_type = (msgtype == MSG_PRIVMSG ? "PRIVMSG" : "NOTICE");
437 if (target_type == TYPE_USER)
439 User* d = (User*) dest;
442 CmdBuilder params(user, message_type);
443 params.push_back(d->uuid);
444 params.push_last(text);
448 else if (target_type == TYPE_CHANNEL)
450 Utils->SendChannelMessage(user->uuid, (Channel*)dest, text, status, exempt_list, message_type);
452 else if (target_type == TYPE_SERVER)
454 char* target = (char*) dest;
455 CmdBuilder par(user, message_type);
456 par.push_back(target);
462 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
464 AutoConnectServers(curtime);
465 DoPingChecks(curtime);
466 DoConnectTimeout(curtime);
469 void ModuleSpanningTree::OnUserConnect(LocalUser* user)
474 CommandUID::Builder(user).Broadcast();
477 CommandOpertype::Builder(user).Broadcast();
479 for(Extensible::ExtensibleStore::const_iterator i = user->GetExtList().begin(); i != user->GetExtList().end(); i++)
481 ExtensionItem* item = i->first;
482 std::string value = item->serialize(FORMAT_NETWORK, user, i->second);
484 ServerInstance->PI->SendMetaData(user, item->name, value);
487 Utils->TreeRoot->UserCount++;
490 void ModuleSpanningTree::OnUserJoin(Membership* memb, bool sync, bool created_by_local, CUList& excepts)
492 // Only do this for local users
493 if (!IS_LOCAL(memb->user))
496 if (created_by_local)
498 CmdBuilder params("FJOIN");
499 params.push_back(memb->chan->name);
500 params.push_back(ConvToStr(memb->chan->age));
501 params.push_raw(" +").push_raw(memb->chan->ChanModes(true));
502 params.push(memb->modes).push_raw(',').push_raw(memb->user->uuid);
507 CmdBuilder params(memb->user, "IJOIN");
508 params.push_back(memb->chan->name);
509 if (!memb->modes.empty())
511 params.push_back(ConvToStr(memb->chan->age));
512 params.push_back(memb->modes);
518 void ModuleSpanningTree::OnChangeHost(User* user, const std::string &newhost)
520 if (user->registered != REG_ALL || !IS_LOCAL(user))
523 CmdBuilder(user, "FHOST").push(newhost).Broadcast();
526 void ModuleSpanningTree::OnChangeName(User* user, const std::string &gecos)
528 if (user->registered != REG_ALL || !IS_LOCAL(user))
531 CmdBuilder(user, "FNAME").push(gecos).Broadcast();
534 void ModuleSpanningTree::OnChangeIdent(User* user, const std::string &ident)
536 if ((user->registered != REG_ALL) || (!IS_LOCAL(user)))
539 CmdBuilder(user, "FIDENT").push(ident).Broadcast();
542 void ModuleSpanningTree::OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts)
544 if (IS_LOCAL(memb->user))
546 CmdBuilder params(memb->user, "PART");
547 params.push_back(memb->chan->name);
548 if (!partmessage.empty())
549 params.push_last(partmessage);
554 void ModuleSpanningTree::OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
556 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
558 if (oper_message != reason)
559 ServerInstance->PI->SendMetaData(user, "operquit", oper_message);
561 CmdBuilder(user, "QUIT").push_last(reason).Broadcast();
564 // Regardless, We need to modify the user Counts..
565 TreeServer* SourceServer = Utils->FindServer(user->server);
568 SourceServer->UserCount--;
572 void ModuleSpanningTree::OnUserPostNick(User* user, const std::string &oldnick)
576 CmdBuilder params(user, "NICK");
577 params.push_back(user->nick);
579 /** IMPORTANT: We don't update the TS if the oldnick is just a case change of the newnick!
581 if (irc::string(user->nick.c_str()) != assign(oldnick))
582 user->age = ServerInstance->Time();
584 params.push_back(ConvToStr(user->age));
587 else if (!loopCall && user->nick == user->uuid)
589 CmdBuilder params("SAVE");
590 params.push_back(user->uuid);
591 params.push_back(ConvToStr(user->age));
596 void ModuleSpanningTree::OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts)
598 if ((!IS_LOCAL(source) || source != ServerInstance->FakeClient))
601 CmdBuilder params(source, "KICK");
602 params.push_back(memb->chan->name);
603 params.push_back(memb->user->uuid);
604 params.push_last(reason);
608 void ModuleSpanningTree::OnPreRehash(User* user, const std::string ¶meter)
611 return; // Don't generate a REHASH here if we're in the middle of processing a message that generated this one
613 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "OnPreRehash called with param %s", parameter.c_str());
615 // Send out to other servers
616 if (!parameter.empty() && parameter[0] != '-')
618 CmdBuilder params((user ? user->uuid : ServerInstance->Config->GetSID()), "REHASH");
619 params.push_back(parameter);
620 params.Forward(user ? Utils->BestRouteTo(user->server) : NULL);
624 void ModuleSpanningTree::OnRehash(User* user)
626 // Re-read config stuff
629 Utils->ReadConfiguration();
631 catch (ModuleException& e)
633 // Refresh the IP cache anyway, so servers read before the error will be allowed to connect
634 Utils->RefreshIPCache();
635 // Always warn local opers with snomask +l, also warn globally (snomask +L) if the rehash was issued by a remote user
636 std::string msg = "Error in configuration: ";
637 msg.append(e.GetReason());
638 ServerInstance->SNO->WriteToSnoMask('l', msg);
639 if (user && !IS_LOCAL(user))
640 ServerInstance->PI->SendSNONotice("L", msg);
644 void ModuleSpanningTree::OnLoadModule(Module* mod)
648 data.append(mod->ModuleSourceFile);
649 Version v = mod->GetVersion();
650 if (!v.link_data.empty())
653 data.append(v.link_data);
655 ServerInstance->PI->SendMetaData(NULL, "modules", data);
658 void ModuleSpanningTree::OnUnloadModule(Module* mod)
662 ServerInstance->PI->SendMetaData(NULL, "modules", "-" + mod->ModuleSourceFile);
664 // Close all connections which use an IO hook provided by this module
665 const TreeServer::ChildServers& list = Utils->TreeRoot->GetChildren();
666 for (TreeServer::ChildServers::const_iterator i = list.begin(); i != list.end(); ++i)
668 TreeSocket* sock = (*i)->GetSocket();
669 if (sock && sock->GetIOHook() && sock->GetIOHook()->creator == mod)
671 sock->SendError("SSL module unloaded");
677 // note: the protocol does not allow direct umode +o except
678 // via NICK with 8 params. sending OPERTYPE infers +o modechange
680 void ModuleSpanningTree::OnOper(User* user, const std::string &opertype)
682 if (user->registered != REG_ALL || !IS_LOCAL(user))
684 CommandOpertype::Builder(user).Broadcast();
687 void ModuleSpanningTree::OnAddLine(User* user, XLine *x)
689 if (!x->IsBurstable() || loopCall || (user && !IS_LOCAL(user)))
693 user = ServerInstance->FakeClient;
695 CommandAddLine::Builder(x, user).Broadcast();
698 void ModuleSpanningTree::OnDelLine(User* user, XLine *x)
700 if (!x->IsBurstable() || loopCall || (user && !IS_LOCAL(user)))
704 user = ServerInstance->FakeClient;
706 CmdBuilder params(user, "DELLINE");
707 params.push_back(x->type);
708 params.push_back(x->Displayable());
712 ModResult ModuleSpanningTree::OnSetAway(User* user, const std::string &awaymsg)
715 CommandAway::Builder(user, awaymsg).Broadcast();
717 return MOD_RES_PASSTHRU;
720 void ModuleSpanningTree::ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const parameterlist &modeline, const std::vector<TranslateType> &translate)
722 TreeSocket* s = (TreeSocket*)opaque;
723 std::string output_text = CommandParser::TranslateUIDs(translate, modeline);
727 if (target_type == TYPE_USER)
729 User* u = (User*)target;
730 s->WriteLine(":"+ServerInstance->Config->GetSID()+" MODE "+u->uuid+" "+output_text);
732 else if (target_type == TYPE_CHANNEL)
734 Channel* c = (Channel*)target;
735 s->WriteLine(":"+ServerInstance->Config->GetSID()+" FMODE "+c->name+" "+ConvToStr(c->age)+" "+output_text);
740 void ModuleSpanningTree::ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata)
742 TreeSocket* s = static_cast<TreeSocket*>(opaque);
743 User* u = dynamic_cast<User*>(target);
744 Channel* c = dynamic_cast<Channel*>(target);
746 s->WriteLine(":"+ServerInstance->Config->GetSID()+" METADATA "+u->uuid+" "+extname+" :"+extdata);
748 s->WriteLine(":"+ServerInstance->Config->GetSID()+" METADATA "+c->name+" "+ConvToStr(c->age)+" "+extname+" :"+extdata);
750 s->WriteLine(":"+ServerInstance->Config->GetSID()+" METADATA * "+extname+" :"+extdata);
753 CullResult ModuleSpanningTree::cull()
757 return this->Module::cull();
760 ModuleSpanningTree::~ModuleSpanningTree()
762 delete ServerInstance->PI;
763 ServerInstance->PI = new ProtocolInterface;
765 /* This will also free the listeners */
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 return 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);
788 MODULE_INIT(ModuleSpanningTree)