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;
179 return (" [Up: " + TimeToStr(secs_up) + " Lag: "+ConvToStr(Current->rtt)+"ms]");
181 return (" [Up: " + TimeToStr(secs_up) + " Lag: "+ConvToStr(Current->rtt)+"s]");
185 // WARNING: NOT THREAD SAFE - DONT GET ANY SMART IDEAS.
186 void ModuleSpanningTree::ShowMap(TreeServer* Current, userrec* user, int depth, char matrix[128][128], float &totusers, float &totservers)
190 for (int t = 0; t < depth; t++)
192 matrix[line][t] = ' ';
194 // For Aligning, we need to work out exactly how deep this thing is, and produce
195 // a 'Spacer' String to compensate.
197 memset(spacer,' ',40);
198 if ((40 - Current->GetName().length() - depth) > 1) {
199 spacer[40 - Current->GetName().length() - depth] = '\0';
207 /* Neat and tidy default values, as we're dealing with a matrix not a simple string */
208 memset(text, 0, 128);
210 if (ServerInstance->clientlist->size() == 0) {
211 // If there are no users, WHO THE HELL DID THE /MAP?!?!?!
216 percent = ((float)Current->GetUserCount() / (float)ServerInstance->clientlist->size()) * 100;
218 const std::string operdata = IS_OPER(user) ? MapOperInfo(Current) : "";
219 snprintf(text, 126, "%s %s%5d [%5.2f%%]%s", Current->GetName().c_str(), spacer, Current->GetUserCount(), percent, operdata.c_str());
220 totusers += Current->GetUserCount();
222 strlcpy(&matrix[line][depth],text,126);
224 for (unsigned int q = 0; q < Current->ChildCount(); q++)
226 if ((Current->GetChild(q)->Hidden) || ((Utils->HideULines) && (ServerInstance->ULine(Current->GetChild(q)->GetName().c_str()))))
230 ShowMap(Current->GetChild(q),user,(Utils->FlatLinks && (!*user->oper)) ? depth : depth+2,matrix,totusers,totservers);
235 ShowMap(Current->GetChild(q),user,(Utils->FlatLinks && (!*user->oper)) ? depth : depth+2,matrix,totusers,totservers);
241 int ModuleSpanningTree::HandleMotd(const char** parameters, int pcnt, userrec* user)
245 if (match(ServerInstance->Config->ServerName, parameters[0]))
248 /* Remote MOTD, the server is within the 1st parameter */
249 std::deque<std::string> params;
250 params.push_back(parameters[0]);
251 /* Send it out remotely, generate no reply yet */
252 TreeServer* s = Utils->FindServerMask(parameters[0]);
255 params[0] = s->GetName();
256 Utils->DoOneToOne(user->nick, "MOTD", params, s->GetName());
259 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
265 int ModuleSpanningTree::HandleAdmin(const char** parameters, int pcnt, userrec* user)
269 if (match(ServerInstance->Config->ServerName, parameters[0]))
272 /* Remote ADMIN, the server is within the 1st parameter */
273 std::deque<std::string> params;
274 params.push_back(parameters[0]);
275 /* Send it out remotely, generate no reply yet */
276 TreeServer* s = Utils->FindServerMask(parameters[0]);
279 params[0] = s->GetName();
280 Utils->DoOneToOne(user->nick, "ADMIN", params, s->GetName());
283 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
289 int ModuleSpanningTree::HandleModules(const char** parameters, int pcnt, userrec* user)
293 if (match(ServerInstance->Config->ServerName, parameters[0]))
296 std::deque<std::string> params;
297 params.push_back(parameters[0]);
298 TreeServer* s = Utils->FindServerMask(parameters[0]);
301 params[0] = s->GetName();
302 Utils->DoOneToOne(user->nick, "MODULES", params, s->GetName());
305 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
311 int ModuleSpanningTree::HandleStats(const char** parameters, int pcnt, userrec* user)
315 if (match(ServerInstance->Config->ServerName, parameters[1]))
318 /* Remote STATS, the server is within the 2nd parameter */
319 std::deque<std::string> params;
320 params.push_back(parameters[0]);
321 params.push_back(parameters[1]);
322 /* Send it out remotely, generate no reply yet */
324 TreeServer* s = Utils->FindServerMask(parameters[1]);
327 params[1] = s->GetName();
328 Utils->DoOneToOne(user->nick, "STATS", params, s->GetName());
332 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[1]);
339 // Ok, prepare to be confused.
340 // After much mulling over how to approach this, it struck me that
341 // the 'usual' way of doing a /MAP isnt the best way. Instead of
342 // keeping track of a ton of ascii characters, and line by line
343 // under recursion working out where to place them using multiplications
344 // and divisons, we instead render the map onto a backplane of characters
345 // (a character matrix), then draw the branches as a series of "L" shapes
346 // from the nodes. This is not only friendlier on CPU it uses less stack.
347 void ModuleSpanningTree::HandleMap(const char** parameters, int pcnt, userrec* user)
349 // This array represents a virtual screen which we will
350 // "scratch" draw to, as the console device of an irc
351 // client does not provide for a proper terminal.
353 float totservers = 0;
354 char matrix[128][128];
355 for (unsigned int t = 0; t < 128; t++)
360 // The only recursive bit is called here.
361 ShowMap(Utils->TreeRoot,user,0,matrix,totusers,totservers);
362 // Process each line one by one. The algorithm has a limit of
363 // 128 servers (which is far more than a spanning tree should have
364 // anyway, so we're ok). This limit can be raised simply by making
365 // the character matrix deeper, 128 rows taking 10k of memory.
366 for (int l = 1; l < line; l++)
368 // scan across the line looking for the start of the
369 // servername (the recursive part of the algorithm has placed
370 // the servers at indented positions depending on what they
372 int first_nonspace = 0;
373 while (matrix[l][first_nonspace] == ' ')
378 // Draw the `- (corner) section: this may be overwritten by
379 // another L shape passing along the same vertical pane, becoming
380 // a |- (branch) section instead.
381 matrix[l][first_nonspace] = '-';
382 matrix[l][first_nonspace-1] = '`';
384 // Draw upwards until we hit the parent server, causing possibly
385 // other corners (`-) to become branches (|-)
386 while ((matrix[l2][first_nonspace-1] == ' ') || (matrix[l2][first_nonspace-1] == '`'))
388 matrix[l2][first_nonspace-1] = '|';
392 // dump the whole lot to the user. This is the easy bit, honest.
393 for (int t = 0; t < line; t++)
395 user->WriteServ("006 %s :%s",user->nick,&matrix[t][0]);
397 float avg_users = totusers / totservers;
398 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);
399 user->WriteServ("007 %s :End of /MAP",user->nick);
403 int ModuleSpanningTree::HandleSquit(const char** parameters, int pcnt, userrec* user)
405 TreeServer* s = Utils->FindServerMask(parameters[0]);
408 if (s == Utils->TreeRoot)
410 user->WriteServ("NOTICE %s :*** SQUIT: Foolish mortal, you cannot make a server SQUIT itself! (%s matches local server name)",user->nick,parameters[0]);
413 TreeSocket* sock = s->GetSocket();
416 ServerInstance->SNO->WriteToSnoMask('l',"SQUIT: Server \002%s\002 removed from network by %s",parameters[0],user->nick);
417 sock->Squit(s,std::string("Server quit by ") + user->GetFullRealHost());
418 ServerInstance->SE->DelFd(sock);
424 user->WriteServ("NOTICE %s :*** WARNING: Using SQUIT to split remote servers is deprecated. Please use RSQUIT instead.",user->nick);
429 user->WriteServ("NOTICE %s :*** SQUIT: The server \002%s\002 does not exist on the network.",user->nick,parameters[0]);
434 int ModuleSpanningTree::HandleTime(const char** parameters, int pcnt, userrec* user)
436 if ((IS_LOCAL(user)) && (pcnt))
438 TreeServer* found = Utils->FindServerMask(parameters[0]);
441 // we dont' override for local server
442 if (found == Utils->TreeRoot)
445 std::deque<std::string> params;
446 params.push_back(found->GetName());
447 params.push_back(user->nick);
448 Utils->DoOneToOne(ServerInstance->Config->ServerName,"TIME",params,found->GetName());
452 user->WriteServ("402 %s %s :No such server",user->nick,parameters[0]);
458 int ModuleSpanningTree::HandleRemoteWhois(const char** parameters, int pcnt, userrec* user)
460 if ((IS_LOCAL(user)) && (pcnt > 1))
462 userrec* remote = ServerInstance->FindNick(parameters[1]);
463 if ((remote) && (remote->GetFd() < 0))
465 std::deque<std::string> params;
466 params.push_back(parameters[1]);
467 Utils->DoOneToOne(user->nick,"IDLE",params,remote->server);
472 user->WriteServ("401 %s %s :No such nick/channel",user->nick, parameters[1]);
473 user->WriteServ("318 %s %s :End of /WHOIS list.",user->nick, parameters[1]);
480 void ModuleSpanningTree::DoPingChecks(time_t curtime)
482 for (unsigned int j = 0; j < Utils->TreeRoot->ChildCount(); j++)
484 TreeServer* serv = Utils->TreeRoot->GetChild(j);
485 TreeSocket* sock = serv->GetSocket();
488 if (curtime >= serv->NextPingTime())
490 if (serv->AnsweredLastPing())
492 sock->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" PING "+serv->GetName());
493 serv->SetNextPingTime(curtime + Utils->PingFreq);
494 serv->LastPing = curtime;
497 gettimeofday(&t, NULL);
498 long ts = (t.tv_sec * 1000) + (t.tv_usec / 1000);
499 serv->LastPingMsec = ts;
501 serv->Warned = false;
505 /* they didnt answer, boot them */
506 sock->SendError("Ping timeout");
507 sock->Squit(serv,"Ping timeout");
508 ServerInstance->SE->DelFd(sock);
513 else if ((Utils->PingWarnTime) && (!serv->Warned) && (curtime >= serv->NextPingTime() - (Utils->PingFreq - Utils->PingWarnTime)) && (!serv->AnsweredLastPing()))
515 /* The server hasnt responded, send a warning to opers */
516 ServerInstance->SNO->WriteToSnoMask('l',"Server \002%s\002 has not responded to PING for %d seconds, high latency.", serv->GetName().c_str(), Utils->PingWarnTime);
522 /* Cancel remote burst mode on any servers which still have it enabled due to latency/lack of data.
523 * This prevents lost REMOTECONNECT notices
525 for (server_hash::iterator i = Utils->serverlist.begin(); i != Utils->serverlist.end(); i++)
526 Utils->SetRemoteBursting(i->second, false);
529 void ModuleSpanningTree::ConnectServer(Link* x)
532 QueryType start_type = DNS_QUERY_A;
534 start_type = DNS_QUERY_AAAA;
535 if (strchr(x->IPAddr.c_str(),':'))
538 if (inet_pton(AF_INET6, x->IPAddr.c_str(), &n) < 1)
545 if (inet_aton(x->IPAddr.c_str(),&n) < 1)
549 /* Do we already have an IP? If so, no need to resolve it. */
552 /* Gave a hook, but it wasnt one we know */
553 if ((!x->Hook.empty()) && (Utils->hooks.find(x->Hook.c_str()) == Utils->hooks.end()))
555 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()]);
556 if (newsocket->GetFd() > -1)
558 /* Handled automatically on success */
562 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(),strerror(errno));
564 Utils->DoFailOver(x);
572 ServernameResolver* snr = new ServernameResolver((Module*)this, Utils, ServerInstance,x->IPAddr, *x, cached, start_type);
573 ServerInstance->AddResolver(snr, cached);
575 catch (ModuleException& e)
577 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason());
578 Utils->DoFailOver(x);
583 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
585 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
587 if ((x->AutoConnect) && (curtime >= x->NextConnectTime))
589 x->NextConnectTime = curtime + x->AutoConnect;
590 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
591 if (x->FailOver.length())
593 TreeServer* CheckFailOver = Utils->FindServer(x->FailOver.c_str());
596 /* The failover for this server is currently a member of the network.
597 * The failover probably succeeded, where the main link did not.
598 * Don't try the main link until the failover is gone again.
605 // an autoconnected server is not connected. Check if its time to connect it
606 ServerInstance->SNO->WriteToSnoMask('l',"AUTOCONNECT: Auto-connecting server \002%s\002 (%lu seconds until next attempt)",x->Name.c_str(),x->AutoConnect);
607 this->ConnectServer(&(*x));
613 int ModuleSpanningTree::HandleVersion(const char** parameters, int pcnt, userrec* user)
615 // we've already checked if pcnt > 0, so this is safe
616 TreeServer* found = Utils->FindServerMask(parameters[0]);
619 std::string Version = found->GetVersion();
620 user->WriteServ("351 %s :%s",user->nick,Version.c_str());
621 if (found == Utils->TreeRoot)
623 ServerInstance->Config->Send005(user);
628 user->WriteServ("402 %s %s :No such server",user->nick,parameters[0]);
633 int ModuleSpanningTree::HandleConnect(const char** parameters, int pcnt, userrec* user)
635 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
637 if (ServerInstance->MatchText(x->Name.c_str(),parameters[0]))
639 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
642 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);
643 ConnectServer(&(*x));
648 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());
653 user->WriteServ("NOTICE %s :*** CONNECT: No server matching \002%s\002 could be found in the config file.",user->nick,parameters[0]);
657 void ModuleSpanningTree::BroadcastTimeSync()
659 if (Utils->MasterTime)
661 std::deque<std::string> params;
662 params.push_back(ConvToStr(ServerInstance->Time(false)));
663 params.push_back("FORCE");
664 Utils->DoOneToMany(Utils->TreeRoot->GetName(), "TIMESET", params);
668 int ModuleSpanningTree::OnStats(char statschar, userrec* user, string_list &results)
670 if ((statschar == 'c') || (statschar == 'n'))
672 for (unsigned int i = 0; i < Utils->LinkBlocks.size(); i++)
674 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');
675 if (statschar == 'c')
676 results.push_back(std::string(ServerInstance->Config->ServerName)+" 244 "+user->nick+" H * * "+Utils->LinkBlocks[i].Name.c_str());
678 results.push_back(std::string(ServerInstance->Config->ServerName)+" 219 "+user->nick+" "+statschar+" :End of /STATS report");
679 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);
683 if (statschar == 'p')
685 /* show all server ports, after showing client ports. -- w00t */
687 for (unsigned int i = 0; i < Utils->Bindings.size(); i++)
689 std::string ip = Utils->Bindings[i]->IP;
693 std::string transport("plaintext");
694 if (Utils->Bindings[i]->GetHook())
695 transport = InspSocketNameRequest(this, Utils->Bindings[i]->GetHook()).Send();
697 results.push_back(ConvToStr(ServerInstance->Config->ServerName) + " 249 "+user->nick+" :" + ip + ":" + ConvToStr(Utils->Bindings[i]->port)+
698 " (server, " + transport + ")");
704 int ModuleSpanningTree::OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line)
706 /* If the command doesnt appear to be valid, we dont want to mess with it. */
710 if (command == "CONNECT")
712 return this->HandleConnect(parameters,pcnt,user);
714 else if (command == "STATS")
716 return this->HandleStats(parameters,pcnt,user);
718 else if (command == "MOTD")
720 return this->HandleMotd(parameters,pcnt,user);
722 else if (command == "ADMIN")
724 return this->HandleAdmin(parameters,pcnt,user);
726 else if (command == "SQUIT")
728 return this->HandleSquit(parameters,pcnt,user);
730 else if (command == "MAP")
732 this->HandleMap(parameters,pcnt,user);
735 else if ((command == "TIME") && (pcnt > 0))
737 return this->HandleTime(parameters,pcnt,user);
739 else if (command == "LUSERS")
741 this->HandleLusers(parameters,pcnt,user);
744 else if (command == "LINKS")
746 this->HandleLinks(parameters,pcnt,user);
749 else if (command == "WHOIS")
754 return this->HandleRemoteWhois(parameters,pcnt,user);
757 else if ((command == "VERSION") && (pcnt > 0))
759 this->HandleVersion(parameters,pcnt,user);
762 else if ((command == "MODULES") && (pcnt > 0))
764 return this->HandleModules(parameters,pcnt,user);
769 void ModuleSpanningTree::OnPostCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, CmdResult result, const std::string &original_line)
771 if ((result == CMD_SUCCESS) && (ServerInstance->IsValidModuleCommand(command, pcnt, user)))
773 // this bit of code cleverly routes all module commands
774 // to all remote severs *automatically* so that modules
775 // can just handle commands locally, without having
776 // to have any special provision in place for remote
777 // commands and linking protocols.
778 std::deque<std::string> params;
780 for (int j = 0; j < pcnt; j++)
782 if (strchr(parameters[j],' '))
784 params.push_back(":" + std::string(parameters[j]));
788 params.push_back(std::string(parameters[j]));
791 Utils->DoOneToMany(user->nick,command,params);
795 void ModuleSpanningTree::OnGetServerDescription(const std::string &servername,std::string &description)
797 TreeServer* s = Utils->FindServer(servername);
800 description = s->GetDesc();
804 void ModuleSpanningTree::OnUserInvite(userrec* source,userrec* dest,chanrec* channel)
806 if (IS_LOCAL(source))
808 std::deque<std::string> params;
809 params.push_back(dest->nick);
810 params.push_back(channel->name);
811 Utils->DoOneToMany(source->nick,"INVITE",params);
815 void ModuleSpanningTree::OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic)
817 std::deque<std::string> params;
818 params.push_back(chan->name);
819 params.push_back(":"+topic);
820 Utils->DoOneToMany(user->nick,"TOPIC",params);
823 void ModuleSpanningTree::OnWallops(userrec* user, const std::string &text)
827 std::deque<std::string> params;
828 params.push_back(":"+text);
829 Utils->DoOneToMany(user->nick,"WALLOPS",params);
833 void ModuleSpanningTree::OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
835 if (target_type == TYPE_USER)
837 userrec* d = (userrec*)dest;
838 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
840 std::deque<std::string> params;
842 params.push_back(d->nick);
843 params.push_back(":"+text);
844 Utils->DoOneToOne(user->nick,"NOTICE",params,d->server);
847 else if (target_type == TYPE_CHANNEL)
851 chanrec *c = (chanrec*)dest;
854 std::string cname = c->name;
856 cname = status + cname;
858 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
859 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
861 TreeSocket* Sock = i->second->GetSocket();
863 Sock->WriteLine(":"+std::string(user->nick)+" NOTICE "+cname+" :"+text);
868 else if (target_type == TYPE_SERVER)
872 char* target = (char*)dest;
873 std::deque<std::string> par;
874 par.push_back(target);
875 par.push_back(":"+text);
876 Utils->DoOneToMany(user->nick,"NOTICE",par);
881 void ModuleSpanningTree::OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
883 if (target_type == TYPE_USER)
885 // route private messages which are targetted at clients only to the server
886 // which needs to receive them
887 userrec* d = (userrec*)dest;
888 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
890 std::deque<std::string> params;
892 params.push_back(d->nick);
893 params.push_back(":"+text);
894 Utils->DoOneToOne(user->nick,"PRIVMSG",params,d->server);
897 else if (target_type == TYPE_CHANNEL)
901 chanrec *c = (chanrec*)dest;
904 std::string cname = c->name;
906 cname = status + cname;
908 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
909 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
911 TreeSocket* Sock = i->second->GetSocket();
913 Sock->WriteLine(":"+std::string(user->nick)+" PRIVMSG "+cname+" :"+text);
918 else if (target_type == TYPE_SERVER)
922 char* target = (char*)dest;
923 std::deque<std::string> par;
924 par.push_back(target);
925 par.push_back(":"+text);
926 Utils->DoOneToMany(user->nick,"PRIVMSG",par);
931 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
933 AutoConnectServers(curtime);
934 DoPingChecks(curtime);
937 void ModuleSpanningTree::OnUserJoin(userrec* user, chanrec* channel, bool &silent)
939 // Only do this for local users
942 if (channel->GetUserCounter() == 1)
944 std::deque<std::string> params;
945 // set up their permissions and the channel TS with FJOIN.
946 // All users are FJOINed now, because a module may specify
947 // new joining permissions for the user.
948 params.push_back(channel->name);
949 params.push_back(ConvToStr(channel->age));
950 params.push_back(std::string(channel->GetAllPrefixChars(user))+","+std::string(user->nick));
951 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FJOIN",params);
952 /* First user in, sync the modes for the channel */
954 params.push_back(channel->ChanModes(true));
955 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FMODE",params);
959 std::deque<std::string> params;
960 params.push_back(channel->name);
961 params.push_back(ConvToStr(channel->age));
962 Utils->DoOneToMany(user->nick,"JOIN",params);
967 void ModuleSpanningTree::OnChangeHost(userrec* user, const std::string &newhost)
969 // only occurs for local clients
970 if (user->registered != REG_ALL)
972 std::deque<std::string> params;
973 params.push_back(newhost);
974 Utils->DoOneToMany(user->nick,"FHOST",params);
977 void ModuleSpanningTree::OnChangeName(userrec* user, const std::string &gecos)
979 // only occurs for local clients
980 if (user->registered != REG_ALL)
982 std::deque<std::string> params;
983 params.push_back(gecos);
984 Utils->DoOneToMany(user->nick,"FNAME",params);
987 void ModuleSpanningTree::OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage, bool &silent)
991 std::deque<std::string> params;
992 params.push_back(channel->name);
993 if (!partmessage.empty())
994 params.push_back(":"+partmessage);
995 Utils->DoOneToMany(user->nick,"PART",params);
999 void ModuleSpanningTree::OnUserConnect(userrec* user)
1001 char agestr[MAXBUF];
1004 std::deque<std::string> params;
1005 snprintf(agestr,MAXBUF,"%lu",(unsigned long)user->age);
1006 params.push_back(agestr);
1007 params.push_back(user->nick);
1008 params.push_back(user->host);
1009 params.push_back(user->dhost);
1010 params.push_back(user->ident);
1011 params.push_back("+"+std::string(user->FormatModes()));
1012 params.push_back(user->GetIPString());
1013 params.push_back(":"+std::string(user->fullname));
1014 Utils->DoOneToMany(ServerInstance->Config->ServerName,"NICK",params);
1015 // User is Local, change needs to be reflected!
1016 TreeServer* SourceServer = Utils->FindServer(user->server);
1019 SourceServer->AddUserCount();
1024 void ModuleSpanningTree::OnUserQuit(userrec* user, const std::string &reason, const std::string &oper_message)
1026 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
1028 std::deque<std::string> params;
1030 if (oper_message != reason)
1032 params.push_back(":"+oper_message);
1033 Utils->DoOneToMany(user->nick,"OPERQUIT",params);
1036 params.push_back(":"+reason);
1037 Utils->DoOneToMany(user->nick,"QUIT",params);
1039 // Regardless, We need to modify the user Counts..
1040 TreeServer* SourceServer = Utils->FindServer(user->server);
1043 SourceServer->DelUserCount();
1047 void ModuleSpanningTree::OnUserPostNick(userrec* user, const std::string &oldnick)
1051 std::deque<std::string> params;
1052 params.push_back(user->nick);
1053 Utils->DoOneToMany(oldnick,"NICK",params);
1057 void ModuleSpanningTree::OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason, bool &silent)
1059 if ((source) && (IS_LOCAL(source)))
1061 std::deque<std::string> params;
1062 params.push_back(chan->name);
1063 params.push_back(user->nick);
1064 params.push_back(":"+reason);
1065 Utils->DoOneToMany(source->nick,"KICK",params);
1069 std::deque<std::string> params;
1070 params.push_back(chan->name);
1071 params.push_back(user->nick);
1072 params.push_back(":"+reason);
1073 Utils->DoOneToMany(ServerInstance->Config->ServerName,"KICK",params);
1077 void ModuleSpanningTree::OnRemoteKill(userrec* source, userrec* dest, const std::string &reason, const std::string &operreason)
1079 std::deque<std::string> params;
1080 params.push_back(":"+reason);
1081 Utils->DoOneToMany(dest->nick,"OPERQUIT",params);
1083 params.push_back(dest->nick);
1084 params.push_back(":"+reason);
1085 dest->SetOperQuit(operreason);
1086 Utils->DoOneToMany(source->nick,"KILL",params);
1089 void ModuleSpanningTree::OnRehash(userrec* user, const std::string ¶meter)
1091 if (!parameter.empty())
1093 std::deque<std::string> params;
1094 params.push_back(parameter);
1095 Utils->DoOneToMany(user ? user->nick : ServerInstance->Config->ServerName, "REHASH", params);
1097 if (ServerInstance->MatchText(ServerInstance->Config->ServerName,parameter))
1099 ServerInstance->WriteOpers("*** Remote rehash initiated locally by \002%s\002", user ? user->nick : ServerInstance->Config->ServerName);
1100 ServerInstance->RehashServer();
1103 Utils->ReadConfiguration(false);
1104 InitializeDisabledCommands(ServerInstance->Config->DisabledCommands, ServerInstance);
1107 // note: the protocol does not allow direct umode +o except
1108 // via NICK with 8 params. sending OPERTYPE infers +o modechange
1110 void ModuleSpanningTree::OnOper(userrec* user, const std::string &opertype)
1114 std::deque<std::string> params;
1115 params.push_back(opertype);
1116 Utils->DoOneToMany(user->nick,"OPERTYPE",params);
1120 void ModuleSpanningTree::OnLine(userrec* source, const std::string &host, bool adding, char linetype, long duration, const std::string &reason)
1124 /* Server-set lines */
1126 snprintf(data,MAXBUF,"%c %s %s %lu %lu :%s", linetype, host.c_str(), ServerInstance->Config->ServerName, (unsigned long)ServerInstance->Time(false),
1127 (unsigned long)duration, reason.c_str());
1128 std::deque<std::string> params;
1129 params.push_back(data);
1130 Utils->DoOneToMany(ServerInstance->Config->ServerName, "ADDLINE", params);
1134 if (IS_LOCAL(source))
1137 snprintf(type,8,"%cLINE",linetype);
1138 std::string stype = type;
1141 char sduration[MAXBUF];
1142 snprintf(sduration,MAXBUF,"%ld",duration);
1143 std::deque<std::string> params;
1144 params.push_back(host);
1145 params.push_back(sduration);
1146 params.push_back(":"+reason);
1147 Utils->DoOneToMany(source->nick,stype,params);
1151 std::deque<std::string> params;
1152 params.push_back(host);
1153 Utils->DoOneToMany(source->nick,stype,params);
1159 void ModuleSpanningTree::OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask)
1161 OnLine(source,hostmask,true,'G',duration,reason);
1164 void ModuleSpanningTree::OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask)
1166 OnLine(source,ipmask,true,'Z',duration,reason);
1169 void ModuleSpanningTree::OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask)
1171 OnLine(source,nickmask,true,'Q',duration,reason);
1174 void ModuleSpanningTree::OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask)
1176 OnLine(source,hostmask,true,'E',duration,reason);
1179 void ModuleSpanningTree::OnDelGLine(userrec* source, const std::string &hostmask)
1181 OnLine(source,hostmask,false,'G',0,"");
1184 void ModuleSpanningTree::OnDelZLine(userrec* source, const std::string &ipmask)
1186 OnLine(source,ipmask,false,'Z',0,"");
1189 void ModuleSpanningTree::OnDelQLine(userrec* source, const std::string &nickmask)
1191 OnLine(source,nickmask,false,'Q',0,"");
1194 void ModuleSpanningTree::OnDelELine(userrec* source, const std::string &hostmask)
1196 OnLine(source,hostmask,false,'E',0,"");
1199 void ModuleSpanningTree::OnMode(userrec* user, void* dest, int target_type, const std::string &text)
1201 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
1203 std::deque<std::string> params;
1204 std::string command;
1206 if (target_type == TYPE_USER)
1208 userrec* u = (userrec*)dest;
1209 params.push_back(u->nick);
1210 params.push_back(text);
1215 chanrec* c = (chanrec*)dest;
1216 params.push_back(c->name);
1217 params.push_back(ConvToStr(c->age));
1218 params.push_back(text);
1221 Utils->DoOneToMany(user->nick, command, params);
1225 void ModuleSpanningTree::OnSetAway(userrec* user)
1229 std::deque<std::string> params;
1230 params.push_back(":"+std::string(user->awaymsg));
1231 Utils->DoOneToMany(user->nick,"AWAY",params);
1235 void ModuleSpanningTree::OnCancelAway(userrec* user)
1239 std::deque<std::string> params;
1241 Utils->DoOneToMany(user->nick,"AWAY",params);
1245 void ModuleSpanningTree::ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline)
1247 TreeSocket* s = (TreeSocket*)opaque;
1250 if (target_type == TYPE_USER)
1252 userrec* u = (userrec*)target;
1253 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" FMODE "+u->nick+" "+ConvToStr(u->age)+" "+modeline);
1257 chanrec* c = (chanrec*)target;
1258 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" FMODE "+c->name+" "+ConvToStr(c->age)+" "+modeline);
1263 void ModuleSpanningTree::ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata)
1265 TreeSocket* s = (TreeSocket*)opaque;
1268 if (target_type == TYPE_USER)
1270 userrec* u = (userrec*)target;
1271 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA "+u->nick+" "+extname+" :"+extdata);
1273 else if (target_type == TYPE_CHANNEL)
1275 chanrec* c = (chanrec*)target;
1276 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA "+c->name+" "+extname+" :"+extdata);
1279 if (target_type == TYPE_OTHER)
1281 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA * "+extname+" :"+extdata);
1285 void ModuleSpanningTree::OnEvent(Event* event)
1287 std::deque<std::string>* params = (std::deque<std::string>*)event->GetData();
1288 if (event->GetEventID() == "send_metadata")
1290 if (params->size() < 3)
1292 (*params)[2] = ":" + (*params)[2];
1293 Utils->DoOneToMany(ServerInstance->Config->ServerName,"METADATA",*params);
1295 else if (event->GetEventID() == "send_topic")
1297 if (params->size() < 2)
1299 (*params)[1] = ":" + (*params)[1];
1300 params->insert(params->begin() + 1,ServerInstance->Config->ServerName);
1301 params->insert(params->begin() + 1,ConvToStr(ServerInstance->Time(true)));
1302 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FTOPIC",*params);
1304 else if (event->GetEventID() == "send_mode")
1306 if (params->size() < 2)
1308 // Insert the TS value of the object, either userrec or chanrec
1310 userrec* a = ServerInstance->FindNick((*params)[0]);
1314 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODE",*params);
1319 chanrec* a = ServerInstance->FindChan((*params)[0]);
1323 params->insert(params->begin() + 1,ConvToStr(ourTS));
1324 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FMODE",*params);
1328 else if (event->GetEventID() == "send_mode_explicit")
1330 if (params->size() < 2)
1332 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODE",*params);
1334 else if (event->GetEventID() == "send_opers")
1336 if (params->size() < 1)
1338 (*params)[0] = ":" + (*params)[0];
1339 Utils->DoOneToMany(ServerInstance->Config->ServerName,"OPERNOTICE",*params);
1341 else if (event->GetEventID() == "send_modeset")
1343 if (params->size() < 2)
1345 (*params)[1] = ":" + (*params)[1];
1346 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODENOTICE",*params);
1348 else if (event->GetEventID() == "send_snoset")
1350 if (params->size() < 2)
1352 (*params)[1] = ":" + (*params)[1];
1353 Utils->DoOneToMany(ServerInstance->Config->ServerName,"SNONOTICE",*params);
1355 else if (event->GetEventID() == "send_push")
1357 if (params->size() < 2)
1360 userrec *a = ServerInstance->FindNick((*params)[0]);
1365 (*params)[1] = ":" + (*params)[1];
1366 Utils->DoOneToOne(ServerInstance->Config->ServerName, "PUSH", *params, a->server);
1370 ModuleSpanningTree::~ModuleSpanningTree()
1372 /* This will also free the listeners */
1375 ServerInstance->Timers->DelTimer(SyncTimer);
1377 ServerInstance->Timers->DelTimer(RefreshTimer);
1379 ServerInstance->DoneWithInterface("InspSocketHook");
1382 Version ModuleSpanningTree::GetVersion()
1384 return Version(1,1,0,2,VF_VENDOR,API_VERSION);
1387 void ModuleSpanningTree::Implements(char* List)
1389 List[I_OnPreCommand] = List[I_OnGetServerDescription] = List[I_OnUserInvite] = List[I_OnPostLocalTopicChange] = 1;
1390 List[I_OnWallops] = List[I_OnUserNotice] = List[I_OnUserMessage] = List[I_OnBackgroundTimer] = 1;
1391 List[I_OnUserJoin] = List[I_OnChangeHost] = List[I_OnChangeName] = List[I_OnUserPart] = List[I_OnUserConnect] = 1;
1392 List[I_OnUserQuit] = List[I_OnUserPostNick] = List[I_OnUserKick] = List[I_OnRemoteKill] = List[I_OnRehash] = 1;
1393 List[I_OnOper] = List[I_OnAddGLine] = List[I_OnAddZLine] = List[I_OnAddQLine] = List[I_OnAddELine] = 1;
1394 List[I_OnDelGLine] = List[I_OnDelZLine] = List[I_OnDelQLine] = List[I_OnDelELine] = List[I_ProtoSendMode] = List[I_OnMode] = 1;
1395 List[I_OnStats] = List[I_ProtoSendMetaData] = List[I_OnEvent] = List[I_OnSetAway] = List[I_OnCancelAway] = List[I_OnPostCommand] = 1;
1398 /* It is IMPORTANT that m_spanningtree is the last module in the chain
1399 * so that any activity it sees is FINAL, e.g. we arent going to send out
1400 * a NICK message before m_cloaking has finished putting the +x on the user,
1402 * Therefore, we return PRIORITY_LAST to make sure we end up at the END of
1403 * the module call queue.
1405 Priority ModuleSpanningTree::Prioritize()
1407 return PRIORITY_LAST;
1410 MODULE_INIT(ModuleSpanningTree)