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->nick, "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->nick, "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->nick, "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->nick, "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->nick);
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->nick,"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 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(),strerror(errno));
557 Utils->DoFailOver(x);
565 ServernameResolver* snr = new ServernameResolver((Module*)this, Utils, ServerInstance,x->IPAddr, *x, cached, start_type);
566 ServerInstance->AddResolver(snr, cached);
568 catch (ModuleException& e)
570 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason());
571 Utils->DoFailOver(x);
576 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
578 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
580 if ((x->AutoConnect) && (curtime >= x->NextConnectTime))
582 x->NextConnectTime = curtime + x->AutoConnect;
583 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
584 if (x->FailOver.length())
586 TreeServer* CheckFailOver = Utils->FindServer(x->FailOver.c_str());
589 /* The failover for this server is currently a member of the network.
590 * The failover probably succeeded, where the main link did not.
591 * Don't try the main link until the failover is gone again.
598 // an autoconnected server is not connected. Check if its time to connect it
599 ServerInstance->SNO->WriteToSnoMask('l',"AUTOCONNECT: Auto-connecting server \002%s\002 (%lu seconds until next attempt)",x->Name.c_str(),x->AutoConnect);
600 this->ConnectServer(&(*x));
606 int ModuleSpanningTree::HandleVersion(const char** parameters, int pcnt, userrec* user)
608 // we've already checked if pcnt > 0, so this is safe
609 TreeServer* found = Utils->FindServerMask(parameters[0]);
612 std::string Version = found->GetVersion();
613 user->WriteServ("351 %s :%s",user->nick,Version.c_str());
614 if (found == Utils->TreeRoot)
616 ServerInstance->Config->Send005(user);
621 user->WriteServ("402 %s %s :No such server",user->nick,parameters[0]);
626 int ModuleSpanningTree::HandleConnect(const char** parameters, int pcnt, userrec* user)
628 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
630 if (ServerInstance->MatchText(x->Name.c_str(),parameters[0]))
632 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
635 user->WriteServ("NOTICE %s :*** CONNECT: Connecting to server: \002%s\002 (%s:%d)",user->nick,x->Name.c_str(),(x->HiddenFromStats ? "<hidden>" : x->IPAddr.c_str()),x->Port);
636 ConnectServer(&(*x));
641 user->WriteServ("NOTICE %s :*** 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());
646 user->WriteServ("NOTICE %s :*** CONNECT: No server matching \002%s\002 could be found in the config file.",user->nick,parameters[0]);
650 void ModuleSpanningTree::BroadcastTimeSync()
652 if (Utils->MasterTime)
654 std::deque<std::string> params;
655 params.push_back(ConvToStr(ServerInstance->Time(false)));
656 params.push_back("FORCE");
657 Utils->DoOneToMany(Utils->TreeRoot->GetName(), "TIMESET", params);
661 int ModuleSpanningTree::OnStats(char statschar, userrec* user, string_list &results)
663 if ((statschar == 'c') || (statschar == 'n'))
665 for (unsigned int i = 0; i < Utils->LinkBlocks.size(); i++)
667 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');
668 if (statschar == 'c')
669 results.push_back(std::string(ServerInstance->Config->ServerName)+" 244 "+user->nick+" H * * "+Utils->LinkBlocks[i].Name.c_str());
671 results.push_back(std::string(ServerInstance->Config->ServerName)+" 219 "+user->nick+" "+statschar+" :End of /STATS report");
672 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);
676 if (statschar == 'p')
678 /* show all server ports, after showing client ports. -- w00t */
680 for (unsigned int i = 0; i < Utils->Bindings.size(); i++)
682 std::string ip = Utils->Bindings[i]->IP;
686 std::string transport("plaintext");
687 if (Utils->Bindings[i]->GetHook())
688 transport = InspSocketNameRequest(this, Utils->Bindings[i]->GetHook()).Send();
690 results.push_back(ConvToStr(ServerInstance->Config->ServerName) + " 249 "+user->nick+" :" + ip + ":" + ConvToStr(Utils->Bindings[i]->port)+
691 " (server, " + transport + ")");
697 int ModuleSpanningTree::OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line)
699 /* If the command doesnt appear to be valid, we dont want to mess with it. */
703 if (command == "CONNECT")
705 return this->HandleConnect(parameters,pcnt,user);
707 else if (command == "STATS")
709 return this->HandleStats(parameters,pcnt,user);
711 else if (command == "MOTD")
713 return this->HandleMotd(parameters,pcnt,user);
715 else if (command == "ADMIN")
717 return this->HandleAdmin(parameters,pcnt,user);
719 else if (command == "SQUIT")
721 return this->HandleSquit(parameters,pcnt,user);
723 else if (command == "MAP")
725 this->HandleMap(parameters,pcnt,user);
728 else if ((command == "TIME") && (pcnt > 0))
730 return this->HandleTime(parameters,pcnt,user);
732 else if (command == "LUSERS")
734 this->HandleLusers(parameters,pcnt,user);
737 else if (command == "LINKS")
739 this->HandleLinks(parameters,pcnt,user);
742 else if (command == "WHOIS")
747 return this->HandleRemoteWhois(parameters,pcnt,user);
750 else if ((command == "VERSION") && (pcnt > 0))
752 this->HandleVersion(parameters,pcnt,user);
755 else if ((command == "MODULES") && (pcnt > 0))
757 return this->HandleModules(parameters,pcnt,user);
762 void ModuleSpanningTree::OnPostCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, CmdResult result, const std::string &original_line)
764 if ((result == CMD_SUCCESS) && (ServerInstance->IsValidModuleCommand(command, pcnt, user)))
766 // this bit of code cleverly routes all module commands
767 // to all remote severs *automatically* so that modules
768 // can just handle commands locally, without having
769 // to have any special provision in place for remote
770 // commands and linking protocols.
771 std::deque<std::string> params;
773 for (int j = 0; j < pcnt; j++)
775 if (strchr(parameters[j],' '))
777 params.push_back(":" + std::string(parameters[j]));
781 params.push_back(std::string(parameters[j]));
784 Utils->DoOneToMany(user->nick,command,params);
788 void ModuleSpanningTree::OnGetServerDescription(const std::string &servername,std::string &description)
790 TreeServer* s = Utils->FindServer(servername);
793 description = s->GetDesc();
797 void ModuleSpanningTree::OnUserInvite(userrec* source,userrec* dest,chanrec* channel)
799 if (IS_LOCAL(source))
801 std::deque<std::string> params;
802 params.push_back(dest->nick);
803 params.push_back(channel->name);
804 Utils->DoOneToMany(source->nick,"INVITE",params);
808 void ModuleSpanningTree::OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic)
810 std::deque<std::string> params;
811 params.push_back(chan->name);
812 params.push_back(":"+topic);
813 Utils->DoOneToMany(user->nick,"TOPIC",params);
816 void ModuleSpanningTree::OnWallops(userrec* user, const std::string &text)
820 std::deque<std::string> params;
821 params.push_back(":"+text);
822 Utils->DoOneToMany(user->nick,"WALLOPS",params);
826 void ModuleSpanningTree::OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
828 if (target_type == TYPE_USER)
830 userrec* d = (userrec*)dest;
831 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
833 std::deque<std::string> params;
835 params.push_back(d->nick);
836 params.push_back(":"+text);
837 Utils->DoOneToOne(user->nick,"NOTICE",params,d->server);
840 else if (target_type == TYPE_CHANNEL)
844 chanrec *c = (chanrec*)dest;
847 std::string cname = c->name;
849 cname = status + cname;
851 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
852 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
854 TreeSocket* Sock = i->second->GetSocket();
856 Sock->WriteLine(":"+std::string(user->nick)+" NOTICE "+cname+" :"+text);
861 else if (target_type == TYPE_SERVER)
865 char* target = (char*)dest;
866 std::deque<std::string> par;
867 par.push_back(target);
868 par.push_back(":"+text);
869 Utils->DoOneToMany(user->nick,"NOTICE",par);
874 void ModuleSpanningTree::OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
876 if (target_type == TYPE_USER)
878 // route private messages which are targetted at clients only to the server
879 // which needs to receive them
880 userrec* d = (userrec*)dest;
881 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
883 std::deque<std::string> params;
885 params.push_back(d->nick);
886 params.push_back(":"+text);
887 Utils->DoOneToOne(user->nick,"PRIVMSG",params,d->server);
890 else if (target_type == TYPE_CHANNEL)
894 chanrec *c = (chanrec*)dest;
897 std::string cname = c->name;
899 cname = status + cname;
901 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
902 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
904 TreeSocket* Sock = i->second->GetSocket();
906 Sock->WriteLine(":"+std::string(user->nick)+" PRIVMSG "+cname+" :"+text);
911 else if (target_type == TYPE_SERVER)
915 char* target = (char*)dest;
916 std::deque<std::string> par;
917 par.push_back(target);
918 par.push_back(":"+text);
919 Utils->DoOneToMany(user->nick,"PRIVMSG",par);
924 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
926 AutoConnectServers(curtime);
927 DoPingChecks(curtime);
930 void ModuleSpanningTree::OnUserJoin(userrec* user, chanrec* channel, bool &silent)
932 // Only do this for local users
935 if (channel->GetUserCounter() == 1)
937 std::deque<std::string> params;
938 // set up their permissions and the channel TS with FJOIN.
939 // All users are FJOINed now, because a module may specify
940 // new joining permissions for the user.
941 params.push_back(channel->name);
942 params.push_back(ConvToStr(channel->age));
943 params.push_back(std::string(channel->GetAllPrefixChars(user))+","+std::string(user->nick));
944 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FJOIN",params);
945 /* First user in, sync the modes for the channel */
947 params.push_back(channel->ChanModes(true));
948 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FMODE",params);
952 std::deque<std::string> params;
953 params.push_back(channel->name);
954 params.push_back(ConvToStr(channel->age));
955 Utils->DoOneToMany(user->nick,"JOIN",params);
960 void ModuleSpanningTree::OnChangeHost(userrec* user, const std::string &newhost)
962 // only occurs for local clients
963 if (user->registered != REG_ALL)
965 std::deque<std::string> params;
966 params.push_back(newhost);
967 Utils->DoOneToMany(user->nick,"FHOST",params);
970 void ModuleSpanningTree::OnChangeName(userrec* user, const std::string &gecos)
972 // only occurs for local clients
973 if (user->registered != REG_ALL)
975 std::deque<std::string> params;
976 params.push_back(gecos);
977 Utils->DoOneToMany(user->nick,"FNAME",params);
980 void ModuleSpanningTree::OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage, bool &silent)
984 std::deque<std::string> params;
985 params.push_back(channel->name);
986 if (!partmessage.empty())
987 params.push_back(":"+partmessage);
988 Utils->DoOneToMany(user->nick,"PART",params);
992 void ModuleSpanningTree::OnUserConnect(userrec* user)
997 std::deque<std::string> params;
998 snprintf(agestr,MAXBUF,"%lu",(unsigned long)user->age);
999 params.push_back(agestr);
1000 params.push_back(user->nick);
1001 params.push_back(user->host);
1002 params.push_back(user->dhost);
1003 params.push_back(user->ident);
1004 params.push_back("+"+std::string(user->FormatModes()));
1005 params.push_back(user->GetIPString());
1006 params.push_back(":"+std::string(user->fullname));
1007 Utils->DoOneToMany(ServerInstance->Config->ServerName,"NICK",params);
1008 // User is Local, change needs to be reflected!
1009 TreeServer* SourceServer = Utils->FindServer(user->server);
1012 SourceServer->AddUserCount();
1017 void ModuleSpanningTree::OnUserQuit(userrec* user, const std::string &reason, const std::string &oper_message)
1019 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
1021 std::deque<std::string> params;
1023 if (oper_message != reason)
1025 params.push_back(":"+oper_message);
1026 Utils->DoOneToMany(user->nick,"OPERQUIT",params);
1029 params.push_back(":"+reason);
1030 Utils->DoOneToMany(user->nick,"QUIT",params);
1032 // Regardless, We need to modify the user Counts..
1033 TreeServer* SourceServer = Utils->FindServer(user->server);
1036 SourceServer->DelUserCount();
1040 void ModuleSpanningTree::OnUserPostNick(userrec* user, const std::string &oldnick)
1044 std::deque<std::string> params;
1045 params.push_back(user->nick);
1046 Utils->DoOneToMany(oldnick,"NICK",params);
1050 void ModuleSpanningTree::OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason, bool &silent)
1052 if ((source) && (IS_LOCAL(source)))
1054 std::deque<std::string> params;
1055 params.push_back(chan->name);
1056 params.push_back(user->nick);
1057 params.push_back(":"+reason);
1058 Utils->DoOneToMany(source->nick,"KICK",params);
1062 std::deque<std::string> params;
1063 params.push_back(chan->name);
1064 params.push_back(user->nick);
1065 params.push_back(":"+reason);
1066 Utils->DoOneToMany(ServerInstance->Config->ServerName,"KICK",params);
1070 void ModuleSpanningTree::OnRemoteKill(userrec* source, userrec* dest, const std::string &reason, const std::string &operreason)
1072 std::deque<std::string> params;
1073 params.push_back(":"+reason);
1074 Utils->DoOneToMany(dest->nick,"OPERQUIT",params);
1076 params.push_back(dest->nick);
1077 params.push_back(":"+reason);
1078 dest->SetOperQuit(operreason);
1079 Utils->DoOneToMany(source->nick,"KILL",params);
1082 void ModuleSpanningTree::OnRehash(userrec* user, const std::string ¶meter)
1084 if (!parameter.empty())
1086 std::deque<std::string> params;
1087 params.push_back(parameter);
1088 Utils->DoOneToMany(user ? user->nick : ServerInstance->Config->ServerName, "REHASH", params);
1090 if (ServerInstance->MatchText(ServerInstance->Config->ServerName,parameter))
1092 ServerInstance->WriteOpers("*** Remote rehash initiated locally by \002%s\002", user ? user->nick : ServerInstance->Config->ServerName);
1093 ServerInstance->RehashServer();
1096 Utils->ReadConfiguration(false);
1097 InitializeDisabledCommands(ServerInstance->Config->DisabledCommands, ServerInstance);
1100 // note: the protocol does not allow direct umode +o except
1101 // via NICK with 8 params. sending OPERTYPE infers +o modechange
1103 void ModuleSpanningTree::OnOper(userrec* user, const std::string &opertype)
1107 std::deque<std::string> params;
1108 params.push_back(opertype);
1109 Utils->DoOneToMany(user->nick,"OPERTYPE",params);
1113 void ModuleSpanningTree::OnLine(userrec* source, const std::string &host, bool adding, char linetype, long duration, const std::string &reason)
1117 /* Server-set lines */
1119 snprintf(data,MAXBUF,"%c %s %s %lu %lu :%s", linetype, host.c_str(), ServerInstance->Config->ServerName, (unsigned long)ServerInstance->Time(false),
1120 (unsigned long)duration, reason.c_str());
1121 std::deque<std::string> params;
1122 params.push_back(data);
1123 Utils->DoOneToMany(ServerInstance->Config->ServerName, "ADDLINE", params);
1127 if (IS_LOCAL(source))
1130 snprintf(type,8,"%cLINE",linetype);
1131 std::string stype = type;
1134 char sduration[MAXBUF];
1135 snprintf(sduration,MAXBUF,"%ld",duration);
1136 std::deque<std::string> params;
1137 params.push_back(host);
1138 params.push_back(sduration);
1139 params.push_back(":"+reason);
1140 Utils->DoOneToMany(source->nick,stype,params);
1144 std::deque<std::string> params;
1145 params.push_back(host);
1146 Utils->DoOneToMany(source->nick,stype,params);
1152 void ModuleSpanningTree::OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask)
1154 OnLine(source,hostmask,true,'G',duration,reason);
1157 void ModuleSpanningTree::OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask)
1159 OnLine(source,ipmask,true,'Z',duration,reason);
1162 void ModuleSpanningTree::OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask)
1164 OnLine(source,nickmask,true,'Q',duration,reason);
1167 void ModuleSpanningTree::OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask)
1169 OnLine(source,hostmask,true,'E',duration,reason);
1172 void ModuleSpanningTree::OnDelGLine(userrec* source, const std::string &hostmask)
1174 OnLine(source,hostmask,false,'G',0,"");
1177 void ModuleSpanningTree::OnDelZLine(userrec* source, const std::string &ipmask)
1179 OnLine(source,ipmask,false,'Z',0,"");
1182 void ModuleSpanningTree::OnDelQLine(userrec* source, const std::string &nickmask)
1184 OnLine(source,nickmask,false,'Q',0,"");
1187 void ModuleSpanningTree::OnDelELine(userrec* source, const std::string &hostmask)
1189 OnLine(source,hostmask,false,'E',0,"");
1192 void ModuleSpanningTree::OnMode(userrec* user, void* dest, int target_type, const std::string &text)
1194 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
1196 std::deque<std::string> params;
1197 std::string command;
1199 if (target_type == TYPE_USER)
1201 userrec* u = (userrec*)dest;
1202 params.push_back(u->nick);
1203 params.push_back(text);
1208 chanrec* c = (chanrec*)dest;
1209 params.push_back(c->name);
1210 params.push_back(ConvToStr(c->age));
1211 params.push_back(text);
1214 Utils->DoOneToMany(user->nick, command, params);
1218 void ModuleSpanningTree::OnSetAway(userrec* user)
1222 std::deque<std::string> params;
1223 params.push_back(":"+std::string(user->awaymsg));
1224 Utils->DoOneToMany(user->nick,"AWAY",params);
1228 void ModuleSpanningTree::OnCancelAway(userrec* user)
1232 std::deque<std::string> params;
1234 Utils->DoOneToMany(user->nick,"AWAY",params);
1238 void ModuleSpanningTree::ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline)
1240 TreeSocket* s = (TreeSocket*)opaque;
1243 if (target_type == TYPE_USER)
1245 userrec* u = (userrec*)target;
1246 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" FMODE "+u->nick+" "+ConvToStr(u->age)+" "+modeline);
1250 chanrec* c = (chanrec*)target;
1251 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" FMODE "+c->name+" "+ConvToStr(c->age)+" "+modeline);
1256 void ModuleSpanningTree::ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata)
1258 TreeSocket* s = (TreeSocket*)opaque;
1261 if (target_type == TYPE_USER)
1263 userrec* u = (userrec*)target;
1264 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA "+u->nick+" "+extname+" :"+extdata);
1266 else if (target_type == TYPE_CHANNEL)
1268 chanrec* c = (chanrec*)target;
1269 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA "+c->name+" "+extname+" :"+extdata);
1272 if (target_type == TYPE_OTHER)
1274 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA * "+extname+" :"+extdata);
1278 void ModuleSpanningTree::OnEvent(Event* event)
1280 std::deque<std::string>* params = (std::deque<std::string>*)event->GetData();
1281 if (event->GetEventID() == "send_metadata")
1283 if (params->size() < 3)
1285 (*params)[2] = ":" + (*params)[2];
1286 Utils->DoOneToMany(ServerInstance->Config->ServerName,"METADATA",*params);
1288 else if (event->GetEventID() == "send_topic")
1290 if (params->size() < 2)
1292 (*params)[1] = ":" + (*params)[1];
1293 params->insert(params->begin() + 1,ServerInstance->Config->ServerName);
1294 params->insert(params->begin() + 1,ConvToStr(ServerInstance->Time(true)));
1295 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FTOPIC",*params);
1297 else if (event->GetEventID() == "send_mode")
1299 if (params->size() < 2)
1301 // Insert the TS value of the object, either userrec or chanrec
1303 userrec* a = ServerInstance->FindNick((*params)[0]);
1307 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODE",*params);
1312 chanrec* a = ServerInstance->FindChan((*params)[0]);
1316 params->insert(params->begin() + 1,ConvToStr(ourTS));
1317 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FMODE",*params);
1321 else if (event->GetEventID() == "send_mode_explicit")
1323 if (params->size() < 2)
1325 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODE",*params);
1327 else if (event->GetEventID() == "send_opers")
1329 if (params->size() < 1)
1331 (*params)[0] = ":" + (*params)[0];
1332 Utils->DoOneToMany(ServerInstance->Config->ServerName,"OPERNOTICE",*params);
1334 else if (event->GetEventID() == "send_modeset")
1336 if (params->size() < 2)
1338 (*params)[1] = ":" + (*params)[1];
1339 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODENOTICE",*params);
1341 else if (event->GetEventID() == "send_snoset")
1343 if (params->size() < 2)
1345 (*params)[1] = ":" + (*params)[1];
1346 Utils->DoOneToMany(ServerInstance->Config->ServerName,"SNONOTICE",*params);
1348 else if (event->GetEventID() == "send_push")
1350 if (params->size() < 2)
1353 userrec *a = ServerInstance->FindNick((*params)[0]);
1358 (*params)[1] = ":" + (*params)[1];
1359 Utils->DoOneToOne(ServerInstance->Config->ServerName, "PUSH", *params, a->server);
1363 ModuleSpanningTree::~ModuleSpanningTree()
1365 /* This will also free the listeners */
1368 ServerInstance->Timers->DelTimer(SyncTimer);
1370 ServerInstance->Timers->DelTimer(RefreshTimer);
1372 ServerInstance->DoneWithInterface("InspSocketHook");
1375 Version ModuleSpanningTree::GetVersion()
1377 return Version(1,1,0,2,VF_VENDOR,API_VERSION);
1380 void ModuleSpanningTree::Implements(char* List)
1382 List[I_OnPreCommand] = List[I_OnGetServerDescription] = List[I_OnUserInvite] = List[I_OnPostLocalTopicChange] = 1;
1383 List[I_OnWallops] = List[I_OnUserNotice] = List[I_OnUserMessage] = List[I_OnBackgroundTimer] = 1;
1384 List[I_OnUserJoin] = List[I_OnChangeHost] = List[I_OnChangeName] = List[I_OnUserPart] = List[I_OnUserConnect] = 1;
1385 List[I_OnUserQuit] = List[I_OnUserPostNick] = List[I_OnUserKick] = List[I_OnRemoteKill] = List[I_OnRehash] = 1;
1386 List[I_OnOper] = List[I_OnAddGLine] = List[I_OnAddZLine] = List[I_OnAddQLine] = List[I_OnAddELine] = 1;
1387 List[I_OnDelGLine] = List[I_OnDelZLine] = List[I_OnDelQLine] = List[I_OnDelELine] = List[I_ProtoSendMode] = List[I_OnMode] = 1;
1388 List[I_OnStats] = List[I_ProtoSendMetaData] = List[I_OnEvent] = List[I_OnSetAway] = List[I_OnCancelAway] = List[I_OnPostCommand] = 1;
1391 /* It is IMPORTANT that m_spanningtree is the last module in the chain
1392 * so that any activity it sees is FINAL, e.g. we arent going to send out
1393 * a NICK message before m_cloaking has finished putting the +x on the user,
1395 * Therefore, we return PRIORITY_LAST to make sure we end up at the END of
1396 * the module call queue.
1398 Priority ModuleSpanningTree::Prioritize()
1400 return PRIORITY_LAST;
1403 MODULE_INIT(ModuleSpanningTree)