1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
14 /* $ModDesc: Provides a spanning tree server link protocol */
17 #include "configreader.h"
21 #include "commands/cmd_whois.h"
22 #include "commands/cmd_stats.h"
26 #include "transport.h"
28 #include "m_spanningtree/timesynctimer.h"
29 #include "m_spanningtree/resolvers.h"
30 #include "m_spanningtree/main.h"
31 #include "m_spanningtree/utils.h"
32 #include "m_spanningtree/treeserver.h"
33 #include "m_spanningtree/link.h"
34 #include "m_spanningtree/treesocket.h"
35 #include "m_spanningtree/rconnect.h"
36 #include "m_spanningtree/rsquit.h"
38 /* $ModDep: m_spanningtree/timesynctimer.h m_spanningtree/resolvers.h m_spanningtree/main.h m_spanningtree/utils.h m_spanningtree/treeserver.h m_spanningtree/link.h m_spanningtree/treesocket.h m_spanningtree/rconnect.h m_spanningtree/rsquit.h */
40 ModuleSpanningTree::ModuleSpanningTree(InspIRCd* Me)
41 : Module(Me), max_local(0), max_global(0)
43 ServerInstance->UseInterface("InspSocketHook");
44 Utils = new SpanningTreeUtilities(Me, this);
45 command_rconnect = new cmd_rconnect(ServerInstance, this, Utils);
46 ServerInstance->AddCommand(command_rconnect);
47 command_rsquit = new cmd_rsquit(ServerInstance, this, Utils);
48 ServerInstance->AddCommand(command_rsquit);
49 if (Utils->EnableTimeSync)
51 SyncTimer = new TimeSyncTimer(ServerInstance, this);
52 ServerInstance->Timers->AddTimer(SyncTimer);
57 RefreshTimer = new CacheRefreshTimer(ServerInstance, Utils);
58 ServerInstance->Timers->AddTimer(RefreshTimer);
61 void ModuleSpanningTree::ShowLinks(TreeServer* Current, userrec* user, int hops)
63 std::string Parent = Utils->TreeRoot->GetName();
64 if (Current->GetParent())
66 Parent = Current->GetParent()->GetName();
68 for (unsigned int q = 0; q < Current->ChildCount(); q++)
70 if ((Current->GetChild(q)->Hidden) || ((Utils->HideULines) && (ServerInstance->ULine(Current->GetChild(q)->GetName().c_str()))))
74 ShowLinks(Current->GetChild(q),user,hops+1);
79 ShowLinks(Current->GetChild(q),user,hops+1);
82 /* Don't display the line if its a uline, hide ulines is on, and the user isnt an oper */
83 if ((Utils->HideULines) && (ServerInstance->ULine(Current->GetName().c_str())) && (!IS_OPER(user)))
85 /* Or if the server is hidden and they're not an oper */
86 else if ((Current->Hidden) && (!IS_OPER(user)))
89 user->WriteServ("364 %s %s %s :%d %s", user->nick,Current->GetName().c_str(),
90 (Utils->FlatLinks && (!IS_OPER(user))) ? ServerInstance->Config->ServerName : Parent.c_str(),
91 (Utils->FlatLinks && (!IS_OPER(user))) ? 0 : hops,
92 Current->GetDesc().c_str());
95 int ModuleSpanningTree::CountLocalServs()
97 return Utils->TreeRoot->ChildCount();
100 int ModuleSpanningTree::CountServs()
102 return Utils->serverlist.size();
105 void ModuleSpanningTree::HandleLinks(const char** parameters, int pcnt, userrec* user)
107 ShowLinks(Utils->TreeRoot,user,0);
108 user->WriteServ("365 %s * :End of /LINKS list.",user->nick);
112 void ModuleSpanningTree::HandleLusers(const char** parameters, int pcnt, userrec* user)
114 unsigned int n_users = ServerInstance->UserCount();
116 /* Only update these when someone wants to see them, more efficient */
117 if ((unsigned int)ServerInstance->LocalUserCount() > max_local)
118 max_local = ServerInstance->LocalUserCount();
119 if (n_users > max_global)
120 max_global = n_users;
122 unsigned int ulined_count = 0;
123 unsigned int ulined_local_count = 0;
125 /* If ulined are hidden and we're not an oper, count the number of ulined servers hidden,
126 * locally and globally (locally means directly connected to us)
128 if ((Utils->HideULines) && (!*user->oper))
130 for (server_hash::iterator q = Utils->serverlist.begin(); q != Utils->serverlist.end(); q++)
132 if (ServerInstance->ULine(q->second->GetName().c_str()))
135 if (q->second->GetParent() == Utils->TreeRoot)
136 ulined_local_count++;
140 user->WriteServ("251 %s :There are %d users and %d invisible on %d servers",user->nick,
141 n_users-ServerInstance->InvisibleUserCount(),
142 ServerInstance->InvisibleUserCount(),
143 ulined_count ? this->CountServs() - ulined_count : this->CountServs());
145 if (ServerInstance->OperCount())
146 user->WriteServ("252 %s %d :operator(s) online",user->nick,ServerInstance->OperCount());
148 if (ServerInstance->UnregisteredUserCount())
149 user->WriteServ("253 %s %d :unknown connections",user->nick,ServerInstance->UnregisteredUserCount());
151 if (ServerInstance->ChannelCount())
152 user->WriteServ("254 %s %d :channels formed",user->nick,ServerInstance->ChannelCount());
154 user->WriteServ("255 %s :I have %d clients and %d servers",user->nick,ServerInstance->LocalUserCount(),ulined_local_count ? this->CountLocalServs() - ulined_local_count : this->CountLocalServs());
155 user->WriteServ("265 %s :Current Local Users: %d Max: %d",user->nick,ServerInstance->LocalUserCount(),max_local);
156 user->WriteServ("266 %s :Current Global Users: %d Max: %d",user->nick,n_users,max_global);
160 std::string ModuleSpanningTree::TimeToStr(time_t secs)
162 time_t mins_up = secs / 60;
163 time_t hours_up = mins_up / 60;
164 time_t days_up = hours_up / 24;
166 mins_up = mins_up % 60;
167 hours_up = hours_up % 24;
168 return ((days_up ? (ConvToStr(days_up) + "d") : std::string(""))
169 + (hours_up ? (ConvToStr(hours_up) + "h") : std::string(""))
170 + (mins_up ? (ConvToStr(mins_up) + "m") : std::string(""))
171 + ConvToStr(secs) + "s");
174 const std::string ModuleSpanningTree::MapOperInfo(TreeServer* Current)
176 time_t secs_up = ServerInstance->Time() - Current->age;
177 return (" [Up: " + TimeToStr(secs_up) + " Lag: "+ConvToStr(Current->rtt)+"ms]");
180 // WARNING: NOT THREAD SAFE - DONT GET ANY SMART IDEAS.
181 void ModuleSpanningTree::ShowMap(TreeServer* Current, userrec* user, int depth, char matrix[128][128], float &totusers, float &totservers)
185 for (int t = 0; t < depth; t++)
187 matrix[line][t] = ' ';
189 // For Aligning, we need to work out exactly how deep this thing is, and produce
190 // a 'Spacer' String to compensate.
192 memset(spacer,' ',40);
193 if ((40 - Current->GetName().length() - depth) > 1) {
194 spacer[40 - Current->GetName().length() - depth] = '\0';
202 /* Neat and tidy default values, as we're dealing with a matrix not a simple string */
203 memset(text, 0, 128);
205 if (ServerInstance->clientlist->size() == 0) {
206 // If there are no users, WHO THE HELL DID THE /MAP?!?!?!
211 percent = ((float)Current->GetUserCount() / (float)ServerInstance->clientlist->size()) * 100;
213 const std::string operdata = IS_OPER(user) ? MapOperInfo(Current) : "";
214 snprintf(text, 126, "%s %s%5d [%5.2f%%]%s", Current->GetName().c_str(), spacer, Current->GetUserCount(), percent, operdata.c_str());
215 totusers += Current->GetUserCount();
217 strlcpy(&matrix[line][depth],text,126);
219 for (unsigned int q = 0; q < Current->ChildCount(); q++)
221 if ((Current->GetChild(q)->Hidden) || ((Utils->HideULines) && (ServerInstance->ULine(Current->GetChild(q)->GetName().c_str()))))
225 ShowMap(Current->GetChild(q),user,(Utils->FlatLinks && (!*user->oper)) ? depth : depth+2,matrix,totusers,totservers);
230 ShowMap(Current->GetChild(q),user,(Utils->FlatLinks && (!*user->oper)) ? depth : depth+2,matrix,totusers,totservers);
236 int ModuleSpanningTree::HandleMotd(const char** parameters, int pcnt, userrec* user)
240 if (match(ServerInstance->Config->ServerName, parameters[0]))
243 /* Remote MOTD, the server is within the 1st parameter */
244 std::deque<std::string> params;
245 params.push_back(parameters[0]);
246 /* Send it out remotely, generate no reply yet */
247 TreeServer* s = Utils->FindServerMask(parameters[0]);
250 params[0] = s->GetName();
251 Utils->DoOneToOne(user->uuid, "MOTD", params, s->GetName());
254 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
260 int ModuleSpanningTree::HandleAdmin(const char** parameters, int pcnt, userrec* user)
264 if (match(ServerInstance->Config->ServerName, parameters[0]))
267 /* Remote ADMIN, the server is within the 1st parameter */
268 std::deque<std::string> params;
269 params.push_back(parameters[0]);
270 /* Send it out remotely, generate no reply yet */
271 TreeServer* s = Utils->FindServerMask(parameters[0]);
274 params[0] = s->GetName();
275 Utils->DoOneToOne(user->uuid, "ADMIN", params, s->GetName());
278 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
284 int ModuleSpanningTree::HandleModules(const char** parameters, int pcnt, userrec* user)
288 if (match(ServerInstance->Config->ServerName, parameters[0]))
291 std::deque<std::string> params;
292 params.push_back(parameters[0]);
293 TreeServer* s = Utils->FindServerMask(parameters[0]);
296 params[0] = s->GetName();
297 Utils->DoOneToOne(user->uuid, "MODULES", params, s->GetName());
300 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
306 int ModuleSpanningTree::HandleStats(const char** parameters, int pcnt, userrec* user)
310 if (match(ServerInstance->Config->ServerName, parameters[1]))
313 /* Remote STATS, the server is within the 2nd parameter */
314 std::deque<std::string> params;
315 params.push_back(parameters[0]);
316 params.push_back(parameters[1]);
317 /* Send it out remotely, generate no reply yet */
319 TreeServer* s = Utils->FindServerMask(parameters[1]);
322 params[1] = s->GetName();
323 Utils->DoOneToOne(user->uuid, "STATS", params, s->GetName());
327 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[1]);
334 // Ok, prepare to be confused.
335 // After much mulling over how to approach this, it struck me that
336 // the 'usual' way of doing a /MAP isnt the best way. Instead of
337 // keeping track of a ton of ascii characters, and line by line
338 // under recursion working out where to place them using multiplications
339 // and divisons, we instead render the map onto a backplane of characters
340 // (a character matrix), then draw the branches as a series of "L" shapes
341 // from the nodes. This is not only friendlier on CPU it uses less stack.
342 void ModuleSpanningTree::HandleMap(const char** parameters, int pcnt, userrec* user)
344 // This array represents a virtual screen which we will
345 // "scratch" draw to, as the console device of an irc
346 // client does not provide for a proper terminal.
348 float totservers = 0;
349 char matrix[128][128];
350 for (unsigned int t = 0; t < 128; t++)
355 // The only recursive bit is called here.
356 ShowMap(Utils->TreeRoot,user,0,matrix,totusers,totservers);
357 // Process each line one by one. The algorithm has a limit of
358 // 128 servers (which is far more than a spanning tree should have
359 // anyway, so we're ok). This limit can be raised simply by making
360 // the character matrix deeper, 128 rows taking 10k of memory.
361 for (int l = 1; l < line; l++)
363 // scan across the line looking for the start of the
364 // servername (the recursive part of the algorithm has placed
365 // the servers at indented positions depending on what they
367 int first_nonspace = 0;
368 while (matrix[l][first_nonspace] == ' ')
373 // Draw the `- (corner) section: this may be overwritten by
374 // another L shape passing along the same vertical pane, becoming
375 // a |- (branch) section instead.
376 matrix[l][first_nonspace] = '-';
377 matrix[l][first_nonspace-1] = '`';
379 // Draw upwards until we hit the parent server, causing possibly
380 // other corners (`-) to become branches (|-)
381 while ((matrix[l2][first_nonspace-1] == ' ') || (matrix[l2][first_nonspace-1] == '`'))
383 matrix[l2][first_nonspace-1] = '|';
387 // dump the whole lot to the user. This is the easy bit, honest.
388 for (int t = 0; t < line; t++)
390 user->WriteServ("006 %s :%s",user->nick,&matrix[t][0]);
392 float avg_users = totusers / totservers;
393 user->WriteServ("270 %s :%.0f server%s and %.0f user%s, average %.2f users per server",user->nick,totservers,(totservers > 1 ? "s" : ""),totusers,(totusers > 1 ? "s" : ""),avg_users);
394 user->WriteServ("007 %s :End of /MAP",user->nick);
398 int ModuleSpanningTree::HandleSquit(const char** parameters, int pcnt, userrec* user)
400 TreeServer* s = Utils->FindServerMask(parameters[0]);
403 if (s == Utils->TreeRoot)
405 user->WriteServ("NOTICE %s :*** SQUIT: Foolish mortal, you cannot make a server SQUIT itself! (%s matches local server name)",user->nick,parameters[0]);
408 TreeSocket* sock = s->GetSocket();
411 ServerInstance->SNO->WriteToSnoMask('l',"SQUIT: Server \002%s\002 removed from network by %s",parameters[0],user->nick);
412 sock->Squit(s,std::string("Server quit by ") + user->GetFullRealHost());
413 ServerInstance->SE->DelFd(sock);
419 user->WriteServ("NOTICE %s :*** WARNING: Using SQUIT to split remote servers is deprecated. Please use RSQUIT instead.",user->nick);
424 user->WriteServ("NOTICE %s :*** SQUIT: The server \002%s\002 does not exist on the network.",user->nick,parameters[0]);
429 int ModuleSpanningTree::HandleTime(const char** parameters, int pcnt, userrec* user)
431 if ((IS_LOCAL(user)) && (pcnt))
433 TreeServer* found = Utils->FindServerMask(parameters[0]);
436 // we dont' override for local server
437 if (found == Utils->TreeRoot)
440 std::deque<std::string> params;
441 params.push_back(found->GetName());
442 params.push_back(user->uuid);
443 Utils->DoOneToOne(ServerInstance->Config->ServerName,"TIME",params,found->GetName());
447 user->WriteServ("402 %s %s :No such server",user->nick,parameters[0]);
453 int ModuleSpanningTree::HandleRemoteWhois(const char** parameters, int pcnt, userrec* user)
455 if ((IS_LOCAL(user)) && (pcnt > 1))
457 userrec* remote = ServerInstance->FindNick(parameters[1]);
458 if ((remote) && (remote->GetFd() < 0))
460 std::deque<std::string> params;
461 params.push_back(parameters[1]);
462 Utils->DoOneToOne(user->uuid,"IDLE",params,remote->server);
467 user->WriteServ("401 %s %s :No such nick/channel",user->nick, parameters[1]);
468 user->WriteServ("318 %s %s :End of /WHOIS list.",user->nick, parameters[1]);
475 void ModuleSpanningTree::DoPingChecks(time_t curtime)
477 for (unsigned int j = 0; j < Utils->TreeRoot->ChildCount(); j++)
479 TreeServer* serv = Utils->TreeRoot->GetChild(j);
480 TreeSocket* sock = serv->GetSocket();
483 if (curtime >= serv->NextPingTime())
485 if (serv->AnsweredLastPing())
487 sock->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" PING "+serv->GetName());
488 serv->SetNextPingTime(curtime + Utils->PingFreq);
489 serv->LastPing = curtime;
491 gettimeofday(&t, NULL);
492 long ts = (t.tv_sec * 1000) + (t.tv_usec / 1000);
493 serv->LastPingMsec = ts;
494 serv->Warned = false;
498 /* they didnt answer, boot them */
499 sock->SendError("Ping timeout");
500 sock->Squit(serv,"Ping timeout");
501 ServerInstance->SE->DelFd(sock);
506 else if ((Utils->PingWarnTime) && (!serv->Warned) && (curtime >= serv->NextPingTime() - (Utils->PingFreq - Utils->PingWarnTime)) && (!serv->AnsweredLastPing()))
508 /* The server hasnt responded, send a warning to opers */
509 ServerInstance->SNO->WriteToSnoMask('l',"Server \002%s\002 has not responded to PING for %d seconds, high latency.", serv->GetName().c_str(), Utils->PingWarnTime);
515 /* Cancel remote burst mode on any servers which still have it enabled due to latency/lack of data.
516 * This prevents lost REMOTECONNECT notices
518 for (server_hash::iterator i = Utils->serverlist.begin(); i != Utils->serverlist.end(); i++)
519 Utils->SetRemoteBursting(i->second, false);
522 void ModuleSpanningTree::ConnectServer(Link* x)
525 QueryType start_type = DNS_QUERY_A;
527 start_type = DNS_QUERY_AAAA;
528 if (strchr(x->IPAddr.c_str(),':'))
531 if (inet_pton(AF_INET6, x->IPAddr.c_str(), &n) < 1)
538 if (inet_aton(x->IPAddr.c_str(),&n) < 1)
542 /* Do we already have an IP? If so, no need to resolve it. */
545 /* Gave a hook, but it wasnt one we know */
546 if ((!x->Hook.empty()) && (Utils->hooks.find(x->Hook.c_str()) == Utils->hooks.end()))
548 TreeSocket* newsocket = new TreeSocket(Utils, ServerInstance, x->IPAddr,x->Port,false,x->Timeout ? x->Timeout : 10,x->Name.c_str(), x->Bind, x->Hook.empty() ? NULL : Utils->hooks[x->Hook.c_str()]);
549 if (newsocket->GetFd() > -1)
551 /* Handled automatically on success */
555 RemoteMessage(NULL, "CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(),strerror(errno));
556 if (ServerInstance->SocketCull.find(newsocket) == ServerInstance->SocketCull.end())
557 ServerInstance->SocketCull[newsocket] = newsocket;
558 Utils->DoFailOver(x);
566 ServernameResolver* snr = new ServernameResolver((Module*)this, Utils, ServerInstance,x->IPAddr, *x, cached, start_type);
567 ServerInstance->AddResolver(snr, cached);
569 catch (ModuleException& e)
571 RemoteMessage(NULL, "CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason());
572 Utils->DoFailOver(x);
577 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
579 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
581 if ((x->AutoConnect) && (curtime >= x->NextConnectTime))
583 x->NextConnectTime = curtime + x->AutoConnect;
584 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
585 if (x->FailOver.length())
587 TreeServer* CheckFailOver = Utils->FindServer(x->FailOver.c_str());
590 /* The failover for this server is currently a member of the network.
591 * The failover probably succeeded, where the main link did not.
592 * Don't try the main link until the failover is gone again.
599 // an autoconnected server is not connected. Check if its time to connect it
600 ServerInstance->SNO->WriteToSnoMask('l',"AUTOCONNECT: Auto-connecting server \002%s\002 (%lu seconds until next attempt)",x->Name.c_str(),x->AutoConnect);
601 this->ConnectServer(&(*x));
607 int ModuleSpanningTree::HandleVersion(const char** parameters, int pcnt, userrec* user)
609 // we've already checked if pcnt > 0, so this is safe
610 TreeServer* found = Utils->FindServerMask(parameters[0]);
613 std::string Version = found->GetVersion();
614 user->WriteServ("351 %s :%s",user->nick,Version.c_str());
615 if (found == Utils->TreeRoot)
617 ServerInstance->Config->Send005(user);
622 user->WriteServ("402 %s %s :No such server",user->nick,parameters[0]);
627 /* This method will attempt to get a link message out to as many people as is required.
628 * If a user is provided, and that user is local, then the user is sent the message using
629 * WriteServ (they are the local initiator of that message). If the user is remote, they are
630 * sent that message remotely via PUSH.
631 * If the user is NULL, then the notice is sent locally via WriteToSnoMask with snomask 'l',
632 * and remotely via SNONOTICE with mask 'l'.
634 void ModuleSpanningTree::RemoteMessage(userrec* user, const char* format, ...)
636 std::deque<std::string> params;
640 va_start(argsPtr, format);
641 vsnprintf(text, MAXBUF, format, argsPtr);
646 /* No user, target it generically at everyone */
647 ServerInstance->SNO->WriteToSnoMask('l', "%s", text);
648 params.push_back("l");
649 params.push_back(std::string(":") + text);
650 Utils->DoOneToMany(ServerInstance->Config->ServerName, "SNONOTICE", params);
655 user->WriteServ("NOTICE %s :%s", user->nick, text);
658 params.push_back(user->uuid);
659 params.push_back(std::string("::") + ServerInstance->Config->ServerName + " NOTICE " + user->nick + " :*** From " +
660 ServerInstance->Config->ServerName+ ": " + text);
661 Utils->DoOneToMany(ServerInstance->Config->ServerName, "PUSH", params);
666 int ModuleSpanningTree::HandleConnect(const char** parameters, int pcnt, userrec* user)
668 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
670 if (ServerInstance->MatchText(x->Name.c_str(),parameters[0]))
672 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
675 RemoteMessage(user, "*** CONNECT: Connecting to server: \002%s\002 (%s:%d)",user->nick,x->Name.c_str(),(x->HiddenFromStats ? "<hidden>" : x->IPAddr.c_str()),x->Port);
676 ConnectServer(&(*x));
681 RemoteMessage(user, "*** CONNECT: Server \002%s\002 already exists on the network and is connected via \002%s\002",user->nick,x->Name.c_str(),CheckDupe->GetParent()->GetName().c_str());
686 RemoteMessage(user, "NOTICE %s :*** CONNECT: No server matching \002%s\002 could be found in the config file.",user->nick,parameters[0]);
690 void ModuleSpanningTree::BroadcastTimeSync()
692 if (Utils->MasterTime)
694 std::deque<std::string> params;
695 params.push_back(ConvToStr(ServerInstance->Time(false)));
696 params.push_back("FORCE");
697 Utils->DoOneToMany(Utils->TreeRoot->GetName(), "TIMESET", params);
701 int ModuleSpanningTree::OnStats(char statschar, userrec* user, string_list &results)
703 if ((statschar == 'c') || (statschar == 'n'))
705 for (unsigned int i = 0; i < Utils->LinkBlocks.size(); i++)
707 results.push_back(std::string(ServerInstance->Config->ServerName)+" 213 "+user->nick+" "+statschar+" *@"+(Utils->LinkBlocks[i].HiddenFromStats ? "<hidden>" : Utils->LinkBlocks[i].IPAddr)+" * "+Utils->LinkBlocks[i].Name.c_str()+" "+ConvToStr(Utils->LinkBlocks[i].Port)+" "+(Utils->LinkBlocks[i].Hook.empty() ? "plaintext" : Utils->LinkBlocks[i].Hook)+" "+(Utils->LinkBlocks[i].AutoConnect ? 'a' : '-')+'s');
708 if (statschar == 'c')
709 results.push_back(std::string(ServerInstance->Config->ServerName)+" 244 "+user->nick+" H * * "+Utils->LinkBlocks[i].Name.c_str());
711 results.push_back(std::string(ServerInstance->Config->ServerName)+" 219 "+user->nick+" "+statschar+" :End of /STATS report");
712 ServerInstance->SNO->WriteToSnoMask('t',"%s '%c' requested by %s (%s@%s)",(!strcmp(user->server,ServerInstance->Config->ServerName) ? "Stats" : "Remote stats"),statschar,user->nick,user->ident,user->host);
716 if (statschar == 'p')
718 /* show all server ports, after showing client ports. -- w00t */
720 for (unsigned int i = 0; i < Utils->Bindings.size(); i++)
722 std::string ip = Utils->Bindings[i]->IP;
726 std::string transport("plaintext");
727 if (Utils->Bindings[i]->GetHook())
728 transport = InspSocketNameRequest(this, Utils->Bindings[i]->GetHook()).Send();
730 results.push_back(ConvToStr(ServerInstance->Config->ServerName) + " 249 "+user->nick+" :" + ip + ":" + ConvToStr(Utils->Bindings[i]->port)+
731 " (server, " + transport + ")");
737 int ModuleSpanningTree::OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line)
739 /* If the command doesnt appear to be valid, we dont want to mess with it. */
743 if (command == "CONNECT")
745 return this->HandleConnect(parameters,pcnt,user);
747 else if (command == "STATS")
749 return this->HandleStats(parameters,pcnt,user);
751 else if (command == "MOTD")
753 return this->HandleMotd(parameters,pcnt,user);
755 else if (command == "ADMIN")
757 return this->HandleAdmin(parameters,pcnt,user);
759 else if (command == "SQUIT")
761 return this->HandleSquit(parameters,pcnt,user);
763 else if (command == "MAP")
765 this->HandleMap(parameters,pcnt,user);
768 else if ((command == "TIME") && (pcnt > 0))
770 return this->HandleTime(parameters,pcnt,user);
772 else if (command == "LUSERS")
774 this->HandleLusers(parameters,pcnt,user);
777 else if (command == "LINKS")
779 this->HandleLinks(parameters,pcnt,user);
782 else if (command == "WHOIS")
787 return this->HandleRemoteWhois(parameters,pcnt,user);
790 else if ((command == "VERSION") && (pcnt > 0))
792 this->HandleVersion(parameters,pcnt,user);
795 else if ((command == "MODULES") && (pcnt > 0))
797 return this->HandleModules(parameters,pcnt,user);
802 void ModuleSpanningTree::OnPostCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, CmdResult result, const std::string &original_line)
804 if ((result == CMD_SUCCESS) && (ServerInstance->IsValidModuleCommand(command, pcnt, user)))
806 // this bit of code cleverly routes all module commands
807 // to all remote severs *automatically* so that modules
808 // can just handle commands locally, without having
809 // to have any special provision in place for remote
810 // commands and linking protocols.
811 std::deque<std::string> params;
813 for (int j = 0; j < pcnt; j++)
815 /* XXX UID: Translate nicks in this list to UIDs, potentially using some form of lookup
816 * table that specifies a value type for each parameter, as part of the command_t.
818 if (strchr(parameters[j],' '))
820 params.push_back(":" + std::string(parameters[j]));
824 params.push_back(std::string(parameters[j]));
827 Utils->DoOneToMany(user->uuid, command, params);
831 void ModuleSpanningTree::OnGetServerDescription(const std::string &servername,std::string &description)
833 TreeServer* s = Utils->FindServer(servername);
836 description = s->GetDesc();
840 void ModuleSpanningTree::OnUserInvite(userrec* source,userrec* dest,chanrec* channel)
842 if (IS_LOCAL(source))
844 std::deque<std::string> params;
845 params.push_back(dest->uuid);
846 params.push_back(channel->name);
847 Utils->DoOneToMany(source->uuid,"INVITE",params);
851 void ModuleSpanningTree::OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic)
853 std::deque<std::string> params;
854 params.push_back(chan->name);
855 params.push_back(":"+topic);
856 Utils->DoOneToMany(user->uuid,"TOPIC",params);
859 void ModuleSpanningTree::OnWallops(userrec* user, const std::string &text)
863 std::deque<std::string> params;
864 params.push_back(":"+text);
865 Utils->DoOneToMany(user->uuid,"WALLOPS",params);
869 void ModuleSpanningTree::OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
871 if (target_type == TYPE_USER)
873 userrec* d = (userrec*)dest;
874 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
876 std::deque<std::string> params;
878 params.push_back(d->uuid);
879 params.push_back(":"+text);
880 Utils->DoOneToOne(user->uuid,"NOTICE",params,d->server);
883 else if (target_type == TYPE_CHANNEL)
887 chanrec *c = (chanrec*)dest;
890 std::string cname = c->name;
892 cname = status + cname;
894 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
895 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
897 TreeSocket* Sock = i->second->GetSocket();
899 Sock->WriteLine(":"+std::string(user->uuid)+" NOTICE "+cname+" :"+text);
904 else if (target_type == TYPE_SERVER)
908 char* target = (char*)dest;
909 std::deque<std::string> par;
910 par.push_back(target);
911 par.push_back(":"+text);
912 Utils->DoOneToMany(user->uuid,"NOTICE",par);
917 void ModuleSpanningTree::OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
919 if (target_type == TYPE_USER)
921 // route private messages which are targetted at clients only to the server
922 // which needs to receive them
923 userrec* d = (userrec*)dest;
924 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
926 std::deque<std::string> params;
928 params.push_back(d->uuid);
929 params.push_back(":"+text);
930 Utils->DoOneToOne(user->uuid,"PRIVMSG",params,d->server);
933 else if (target_type == TYPE_CHANNEL)
937 chanrec *c = (chanrec*)dest;
940 std::string cname = c->name;
942 cname = status + cname;
944 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
945 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
947 TreeSocket* Sock = i->second->GetSocket();
949 Sock->WriteLine(":"+std::string(user->uuid)+" PRIVMSG "+cname+" :"+text);
954 else if (target_type == TYPE_SERVER)
958 char* target = (char*)dest;
959 std::deque<std::string> par;
960 par.push_back(target);
961 par.push_back(":"+text);
962 Utils->DoOneToMany(user->uuid,"PRIVMSG",par);
967 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
969 AutoConnectServers(curtime);
970 DoPingChecks(curtime);
973 void ModuleSpanningTree::OnUserJoin(userrec* user, chanrec* channel, bool &silent)
975 // Only do this for local users
978 if (channel->GetUserCounter() == 1)
980 std::deque<std::string> params;
981 // set up their permissions and the channel TS with FJOIN.
982 // All users are FJOINed now, because a module may specify
983 // new joining permissions for the user.
984 params.push_back(channel->name);
985 params.push_back(ConvToStr(channel->age));
986 params.push_back(std::string(channel->GetAllPrefixChars(user))+","+std::string(user->uuid));
987 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FJOIN",params);
988 /* First user in, sync the modes for the channel */
990 params.push_back(channel->ChanModes(true));
991 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FMODE",params);
995 std::deque<std::string> params;
996 params.push_back(channel->name);
997 params.push_back(ConvToStr(channel->age));
998 Utils->DoOneToMany(user->uuid,"JOIN",params);
1003 void ModuleSpanningTree::OnChangeHost(userrec* user, const std::string &newhost)
1005 // only occurs for local clients
1006 if (user->registered != REG_ALL)
1008 std::deque<std::string> params;
1009 params.push_back(newhost);
1010 Utils->DoOneToMany(user->uuid,"FHOST",params);
1013 void ModuleSpanningTree::OnChangeName(userrec* user, const std::string &gecos)
1015 // only occurs for local clients
1016 if (user->registered != REG_ALL)
1018 std::deque<std::string> params;
1019 params.push_back(gecos);
1020 Utils->DoOneToMany(user->uuid,"FNAME",params);
1023 void ModuleSpanningTree::OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage, bool &silent)
1027 std::deque<std::string> params;
1028 params.push_back(channel->name);
1029 if (!partmessage.empty())
1030 params.push_back(":"+partmessage);
1031 Utils->DoOneToMany(user->uuid,"PART",params);
1035 void ModuleSpanningTree::OnUserConnect(userrec* user)
1037 char agestr[MAXBUF];
1040 std::deque<std::string> params;
1041 snprintf(agestr,MAXBUF,"%lu",(unsigned long)user->age);
1042 params.push_back(user->uuid);
1043 params.push_back(agestr);
1044 params.push_back(user->nick);
1045 params.push_back(user->host);
1046 params.push_back(user->dhost);
1047 params.push_back(user->ident);
1048 params.push_back("+"+std::string(user->FormatModes()));
1049 params.push_back(user->GetIPString());
1050 params.push_back(":"+std::string(user->fullname));
1051 Utils->DoOneToMany(ServerInstance->Config->ServerName, "UID", params);
1052 // User is Local, change needs to be reflected!
1053 TreeServer* SourceServer = Utils->FindServer(user->server);
1056 SourceServer->AddUserCount();
1061 void ModuleSpanningTree::OnUserQuit(userrec* user, const std::string &reason, const std::string &oper_message)
1063 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
1065 std::deque<std::string> params;
1067 if (oper_message != reason)
1069 params.push_back(":"+oper_message);
1070 Utils->DoOneToMany(user->uuid,"OPERQUIT",params);
1073 params.push_back(":"+reason);
1074 Utils->DoOneToMany(user->uuid,"QUIT",params);
1076 // Regardless, We need to modify the user Counts..
1077 TreeServer* SourceServer = Utils->FindServer(user->server);
1080 SourceServer->DelUserCount();
1084 void ModuleSpanningTree::OnUserPostNick(userrec* user, const std::string &oldnick)
1088 std::deque<std::string> params;
1089 params.push_back(user->nick);
1090 Utils->DoOneToMany(user->uuid,"NICK",params);
1094 void ModuleSpanningTree::OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason, bool &silent)
1096 if ((source) && (IS_LOCAL(source)))
1098 std::deque<std::string> params;
1099 params.push_back(chan->name);
1100 params.push_back(user->uuid);
1101 params.push_back(":"+reason);
1102 Utils->DoOneToMany(source->uuid,"KICK",params);
1106 std::deque<std::string> params;
1107 params.push_back(chan->name);
1108 params.push_back(user->uuid);
1109 params.push_back(":"+reason);
1110 Utils->DoOneToMany(ServerInstance->Config->ServerName,"KICK",params);
1114 void ModuleSpanningTree::OnRemoteKill(userrec* source, userrec* dest, const std::string &reason, const std::string &operreason)
1116 std::deque<std::string> params;
1117 params.push_back(":"+reason);
1118 Utils->DoOneToMany(dest->uuid,"OPERQUIT",params);
1120 params.push_back(dest->uuid);
1121 params.push_back(":"+reason);
1122 dest->SetOperQuit(operreason);
1123 Utils->DoOneToMany(source->uuid,"KILL",params);
1126 void ModuleSpanningTree::OnRehash(userrec* user, const std::string ¶meter)
1128 if (!parameter.empty())
1130 std::deque<std::string> params;
1131 params.push_back(parameter);
1132 Utils->DoOneToMany(user ? user->nick : ServerInstance->Config->ServerName, "REHASH", params);
1134 if (ServerInstance->MatchText(ServerInstance->Config->ServerName,parameter))
1136 ServerInstance->WriteOpers("*** Remote rehash initiated locally by \002%s\002", user ? user->nick : ServerInstance->Config->ServerName);
1137 ServerInstance->RehashServer();
1140 Utils->ReadConfiguration(false);
1141 InitializeDisabledCommands(ServerInstance->Config->DisabledCommands, ServerInstance);
1144 // note: the protocol does not allow direct umode +o except
1145 // via NICK with 8 params. sending OPERTYPE infers +o modechange
1147 void ModuleSpanningTree::OnOper(userrec* user, const std::string &opertype)
1151 std::deque<std::string> params;
1152 params.push_back(opertype);
1153 Utils->DoOneToMany(user->uuid,"OPERTYPE",params);
1157 void ModuleSpanningTree::OnLine(userrec* source, const std::string &host, bool adding, char linetype, long duration, const std::string &reason)
1161 /* Server-set lines */
1163 snprintf(data,MAXBUF,"%c %s %s %lu %lu :%s", linetype, host.c_str(), ServerInstance->Config->ServerName, (unsigned long)ServerInstance->Time(false),
1164 (unsigned long)duration, reason.c_str());
1165 std::deque<std::string> params;
1166 params.push_back(data);
1167 Utils->DoOneToMany(ServerInstance->Config->ServerName, "ADDLINE", params);
1171 if (IS_LOCAL(source))
1174 snprintf(type,8,"%cLINE",linetype);
1175 std::string stype = type;
1178 char sduration[MAXBUF];
1179 snprintf(sduration,MAXBUF,"%ld",duration);
1180 std::deque<std::string> params;
1181 params.push_back(host);
1182 params.push_back(sduration);
1183 params.push_back(":"+reason);
1184 Utils->DoOneToMany(source->uuid,stype,params);
1188 std::deque<std::string> params;
1189 params.push_back(host);
1190 Utils->DoOneToMany(source->uuid,stype,params);
1196 void ModuleSpanningTree::OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask)
1198 OnLine(source,hostmask,true,'G',duration,reason);
1201 void ModuleSpanningTree::OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask)
1203 OnLine(source,ipmask,true,'Z',duration,reason);
1206 void ModuleSpanningTree::OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask)
1208 OnLine(source,nickmask,true,'Q',duration,reason);
1211 void ModuleSpanningTree::OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask)
1213 OnLine(source,hostmask,true,'E',duration,reason);
1216 void ModuleSpanningTree::OnDelGLine(userrec* source, const std::string &hostmask)
1218 OnLine(source,hostmask,false,'G',0,"");
1221 void ModuleSpanningTree::OnDelZLine(userrec* source, const std::string &ipmask)
1223 OnLine(source,ipmask,false,'Z',0,"");
1226 void ModuleSpanningTree::OnDelQLine(userrec* source, const std::string &nickmask)
1228 OnLine(source,nickmask,false,'Q',0,"");
1231 void ModuleSpanningTree::OnDelELine(userrec* source, const std::string &hostmask)
1233 OnLine(source,hostmask,false,'E',0,"");
1236 void ModuleSpanningTree::OnMode(userrec* user, void* dest, int target_type, const std::string &text)
1238 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
1240 std::deque<std::string> params;
1241 std::string command;
1243 if (target_type == TYPE_USER)
1245 userrec* u = (userrec*)dest;
1246 params.push_back(u->uuid);
1247 params.push_back(text);
1252 chanrec* c = (chanrec*)dest;
1253 params.push_back(c->name);
1254 params.push_back(ConvToStr(c->age));
1255 params.push_back(text);
1258 /* XXX UID: Translate nick parameters to uuids */
1259 Utils->DoOneToMany(user->uuid, command, params);
1263 void ModuleSpanningTree::OnSetAway(userrec* user)
1267 std::deque<std::string> params;
1268 params.push_back(":"+std::string(user->awaymsg));
1269 Utils->DoOneToMany(user->uuid,"AWAY",params);
1273 void ModuleSpanningTree::OnCancelAway(userrec* user)
1277 std::deque<std::string> params;
1279 Utils->DoOneToMany(user->uuid,"AWAY",params);
1283 void ModuleSpanningTree::ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline)
1285 TreeSocket* s = (TreeSocket*)opaque;
1288 if (target_type == TYPE_USER)
1290 userrec* u = (userrec*)target;
1291 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" FMODE "+u->uuid+" "+ConvToStr(u->age)+" "+modeline);
1295 chanrec* c = (chanrec*)target;
1296 /* XXX UID: Translate nicks in modeline to uids */
1297 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" FMODE "+c->name+" "+ConvToStr(c->age)+" "+modeline);
1302 void ModuleSpanningTree::ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata)
1304 TreeSocket* s = (TreeSocket*)opaque;
1307 if (target_type == TYPE_USER)
1309 userrec* u = (userrec*)target;
1310 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA "+u->uuid+" "+extname+" :"+extdata);
1312 else if (target_type == TYPE_CHANNEL)
1314 chanrec* c = (chanrec*)target;
1315 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA "+c->name+" "+extname+" :"+extdata);
1318 if (target_type == TYPE_OTHER)
1320 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA * "+extname+" :"+extdata);
1324 void ModuleSpanningTree::OnEvent(Event* event)
1326 std::deque<std::string>* params = (std::deque<std::string>*)event->GetData();
1327 if (event->GetEventID() == "send_metadata")
1329 if (params->size() < 3)
1331 (*params)[2] = ":" + (*params)[2];
1332 Utils->DoOneToMany(ServerInstance->Config->ServerName,"METADATA",*params);
1334 else if (event->GetEventID() == "send_topic")
1336 if (params->size() < 2)
1338 (*params)[1] = ":" + (*params)[1];
1339 params->insert(params->begin() + 1,ServerInstance->Config->ServerName);
1340 params->insert(params->begin() + 1,ConvToStr(ServerInstance->Time(true)));
1341 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FTOPIC",*params);
1343 else if (event->GetEventID() == "send_mode")
1345 if (params->size() < 2)
1347 // Insert the TS value of the object, either userrec or chanrec
1349 userrec* a = ServerInstance->FindNick((*params)[0]);
1352 (*params)[0] = a->uuid;
1354 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODE",*params);
1359 chanrec* a = ServerInstance->FindChan((*params)[0]);
1363 params->insert(params->begin() + 1,ConvToStr(ourTS));
1364 /* XXX UID: Translate modes in string to uids */
1365 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FMODE",*params);
1369 else if (event->GetEventID() == "send_mode_explicit")
1371 if (params->size() < 2)
1373 /* XXX UID: Translate modes in string to uids */
1374 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODE",*params);
1376 else if (event->GetEventID() == "send_opers")
1378 if (params->size() < 1)
1380 (*params)[0] = ":" + (*params)[0];
1381 Utils->DoOneToMany(ServerInstance->Config->ServerName,"OPERNOTICE",*params);
1383 else if (event->GetEventID() == "send_modeset")
1385 if (params->size() < 2)
1387 (*params)[1] = ":" + (*params)[1];
1388 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODENOTICE",*params);
1390 else if (event->GetEventID() == "send_snoset")
1392 if (params->size() < 2)
1394 (*params)[1] = ":" + (*params)[1];
1395 Utils->DoOneToMany(ServerInstance->Config->ServerName,"SNONOTICE",*params);
1397 else if (event->GetEventID() == "send_push")
1399 if (params->size() < 2)
1402 userrec *a = ServerInstance->FindNick((*params)[0]);
1407 (*params)[0] = a->uuid;
1408 (*params)[1] = ":" + (*params)[1];
1409 Utils->DoOneToOne(ServerInstance->Config->ServerName, "PUSH", *params, a->server);
1413 ModuleSpanningTree::~ModuleSpanningTree()
1415 /* This will also free the listeners */
1418 ServerInstance->Timers->DelTimer(SyncTimer);
1420 ServerInstance->Timers->DelTimer(RefreshTimer);
1422 ServerInstance->DoneWithInterface("InspSocketHook");
1425 Version ModuleSpanningTree::GetVersion()
1427 return Version(1,1,0,2,VF_VENDOR,API_VERSION);
1430 void ModuleSpanningTree::Implements(char* List)
1432 List[I_OnPreCommand] = List[I_OnGetServerDescription] = List[I_OnUserInvite] = List[I_OnPostLocalTopicChange] = 1;
1433 List[I_OnWallops] = List[I_OnUserNotice] = List[I_OnUserMessage] = List[I_OnBackgroundTimer] = 1;
1434 List[I_OnUserJoin] = List[I_OnChangeHost] = List[I_OnChangeName] = List[I_OnUserPart] = List[I_OnUserConnect] = 1;
1435 List[I_OnUserQuit] = List[I_OnUserPostNick] = List[I_OnUserKick] = List[I_OnRemoteKill] = List[I_OnRehash] = 1;
1436 List[I_OnOper] = List[I_OnAddGLine] = List[I_OnAddZLine] = List[I_OnAddQLine] = List[I_OnAddELine] = 1;
1437 List[I_OnDelGLine] = List[I_OnDelZLine] = List[I_OnDelQLine] = List[I_OnDelELine] = List[I_ProtoSendMode] = List[I_OnMode] = 1;
1438 List[I_OnStats] = List[I_ProtoSendMetaData] = List[I_OnEvent] = List[I_OnSetAway] = List[I_OnCancelAway] = List[I_OnPostCommand] = 1;
1441 /* It is IMPORTANT that m_spanningtree is the last module in the chain
1442 * so that any activity it sees is FINAL, e.g. we arent going to send out
1443 * a NICK message before m_cloaking has finished putting the +x on the user,
1445 * Therefore, we return PRIORITY_LAST to make sure we end up at the END of
1446 * the module call queue.
1448 Priority ModuleSpanningTree::Prioritize()
1450 return PRIORITY_LAST;
1453 MODULE_INIT(ModuleSpanningTree)