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,n_users-ServerInstance->InvisibleUserCount(),ServerInstance->InvisibleUserCount(),ulined_count ? this->CountServs() - ulined_count : this->CountServs());
141 if (ServerInstance->OperCount())
142 user->WriteServ("252 %s %d :operator(s) online",user->nick,ServerInstance->OperCount());
143 if (ServerInstance->UnregisteredUserCount())
144 user->WriteServ("253 %s %d :unknown connections",user->nick,ServerInstance->UnregisteredUserCount());
145 if (ServerInstance->ChannelCount())
146 user->WriteServ("254 %s %d :channels formed",user->nick,ServerInstance->ChannelCount());
147 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());
148 user->WriteServ("265 %s :Current Local Users: %d Max: %d",user->nick,ServerInstance->LocalUserCount(),max_local);
149 user->WriteServ("266 %s :Current Global Users: %d Max: %d",user->nick,n_users,max_global);
153 std::string ModuleSpanningTree::TimeToStr(time_t secs)
155 time_t mins_up = secs / 60;
156 time_t hours_up = mins_up / 60;
157 time_t days_up = hours_up / 24;
159 mins_up = mins_up % 60;
160 hours_up = hours_up % 24;
161 return ((days_up ? (ConvToStr(days_up) + "d") : std::string(""))
162 + (hours_up ? (ConvToStr(hours_up) + "h") : std::string(""))
163 + (mins_up ? (ConvToStr(mins_up) + "m") : std::string(""))
164 + ConvToStr(secs) + "s");
167 const std::string ModuleSpanningTree::MapOperInfo(TreeServer* Current)
169 time_t secs_up = ServerInstance->Time() - Current->age;
170 return (" [Up: " + TimeToStr(secs_up) + " Lag: "+ConvToStr(Current->rtt)+"s]");
173 // WARNING: NOT THREAD SAFE - DONT GET ANY SMART IDEAS.
174 void ModuleSpanningTree::ShowMap(TreeServer* Current, userrec* user, int depth, char matrix[128][128], float &totusers, float &totservers)
178 for (int t = 0; t < depth; t++)
180 matrix[line][t] = ' ';
182 // For Aligning, we need to work out exactly how deep this thing is, and produce
183 // a 'Spacer' String to compensate.
185 memset(spacer,' ',40);
186 if ((40 - Current->GetName().length() - depth) > 1) {
187 spacer[40 - Current->GetName().length() - depth] = '\0';
195 /* Neat and tidy default values, as we're dealing with a matrix not a simple string */
196 memset(text, 0, 128);
198 if (ServerInstance->clientlist->size() == 0) {
199 // If there are no users, WHO THE HELL DID THE /MAP?!?!?!
204 percent = ((float)Current->GetUserCount() / (float)ServerInstance->clientlist->size()) * 100;
206 const std::string operdata = IS_OPER(user) ? MapOperInfo(Current) : "";
207 snprintf(text, 126, "%s %s%5d [%5.2f%%]%s", Current->GetName().c_str(), spacer, Current->GetUserCount(), percent, operdata.c_str());
208 totusers += Current->GetUserCount();
210 strlcpy(&matrix[line][depth],text,126);
212 for (unsigned int q = 0; q < Current->ChildCount(); q++)
214 if ((Current->GetChild(q)->Hidden) || ((Utils->HideULines) && (ServerInstance->ULine(Current->GetChild(q)->GetName().c_str()))))
218 ShowMap(Current->GetChild(q),user,(Utils->FlatLinks && (!*user->oper)) ? depth : depth+2,matrix,totusers,totservers);
223 ShowMap(Current->GetChild(q),user,(Utils->FlatLinks && (!*user->oper)) ? depth : depth+2,matrix,totusers,totservers);
229 int ModuleSpanningTree::HandleMotd(const char** parameters, int pcnt, userrec* user)
233 if (match(ServerInstance->Config->ServerName, parameters[0]))
236 /* Remote MOTD, the server is within the 1st parameter */
237 std::deque<std::string> params;
238 params.push_back(parameters[0]);
239 /* Send it out remotely, generate no reply yet */
240 TreeServer* s = Utils->FindServerMask(parameters[0]);
243 params[0] = s->GetName();
244 Utils->DoOneToOne(user->nick, "MOTD", params, s->GetName());
247 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
253 int ModuleSpanningTree::HandleAdmin(const char** parameters, int pcnt, userrec* user)
257 if (match(ServerInstance->Config->ServerName, parameters[0]))
260 /* Remote ADMIN, the server is within the 1st parameter */
261 std::deque<std::string> params;
262 params.push_back(parameters[0]);
263 /* Send it out remotely, generate no reply yet */
264 TreeServer* s = Utils->FindServerMask(parameters[0]);
267 params[0] = s->GetName();
268 Utils->DoOneToOne(user->nick, "ADMIN", params, s->GetName());
271 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
277 int ModuleSpanningTree::HandleModules(const char** parameters, int pcnt, userrec* user)
281 if (match(ServerInstance->Config->ServerName, parameters[0]))
284 std::deque<std::string> params;
285 params.push_back(parameters[0]);
286 TreeServer* s = Utils->FindServerMask(parameters[0]);
289 params[0] = s->GetName();
290 Utils->DoOneToOne(user->nick, "MODULES", params, s->GetName());
293 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
299 int ModuleSpanningTree::HandleStats(const char** parameters, int pcnt, userrec* user)
303 if (match(ServerInstance->Config->ServerName, parameters[1]))
306 /* Remote STATS, the server is within the 2nd parameter */
307 std::deque<std::string> params;
308 params.push_back(parameters[0]);
309 params.push_back(parameters[1]);
310 /* Send it out remotely, generate no reply yet */
312 TreeServer* s = Utils->FindServerMask(parameters[1]);
315 params[1] = s->GetName();
316 Utils->DoOneToOne(user->nick, "STATS", params, s->GetName());
320 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[1]);
327 // Ok, prepare to be confused.
328 // After much mulling over how to approach this, it struck me that
329 // the 'usual' way of doing a /MAP isnt the best way. Instead of
330 // keeping track of a ton of ascii characters, and line by line
331 // under recursion working out where to place them using multiplications
332 // and divisons, we instead render the map onto a backplane of characters
333 // (a character matrix), then draw the branches as a series of "L" shapes
334 // from the nodes. This is not only friendlier on CPU it uses less stack.
335 void ModuleSpanningTree::HandleMap(const char** parameters, int pcnt, userrec* user)
337 // This array represents a virtual screen which we will
338 // "scratch" draw to, as the console device of an irc
339 // client does not provide for a proper terminal.
341 float totservers = 0;
342 char matrix[128][128];
343 for (unsigned int t = 0; t < 128; t++)
348 // The only recursive bit is called here.
349 ShowMap(Utils->TreeRoot,user,0,matrix,totusers,totservers);
350 // Process each line one by one. The algorithm has a limit of
351 // 128 servers (which is far more than a spanning tree should have
352 // anyway, so we're ok). This limit can be raised simply by making
353 // the character matrix deeper, 128 rows taking 10k of memory.
354 for (int l = 1; l < line; l++)
356 // scan across the line looking for the start of the
357 // servername (the recursive part of the algorithm has placed
358 // the servers at indented positions depending on what they
360 int first_nonspace = 0;
361 while (matrix[l][first_nonspace] == ' ')
366 // Draw the `- (corner) section: this may be overwritten by
367 // another L shape passing along the same vertical pane, becoming
368 // a |- (branch) section instead.
369 matrix[l][first_nonspace] = '-';
370 matrix[l][first_nonspace-1] = '`';
372 // Draw upwards until we hit the parent server, causing possibly
373 // other corners (`-) to become branches (|-)
374 while ((matrix[l2][first_nonspace-1] == ' ') || (matrix[l2][first_nonspace-1] == '`'))
376 matrix[l2][first_nonspace-1] = '|';
380 // dump the whole lot to the user. This is the easy bit, honest.
381 for (int t = 0; t < line; t++)
383 user->WriteServ("006 %s :%s",user->nick,&matrix[t][0]);
385 float avg_users = totusers / totservers;
386 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);
387 user->WriteServ("007 %s :End of /MAP",user->nick);
391 int ModuleSpanningTree::HandleSquit(const char** parameters, int pcnt, userrec* user)
393 TreeServer* s = Utils->FindServerMask(parameters[0]);
396 if (s == Utils->TreeRoot)
398 user->WriteServ("NOTICE %s :*** SQUIT: Foolish mortal, you cannot make a server SQUIT itself! (%s matches local server name)",user->nick,parameters[0]);
401 TreeSocket* sock = s->GetSocket();
404 ServerInstance->SNO->WriteToSnoMask('l',"SQUIT: Server \002%s\002 removed from network by %s",parameters[0],user->nick);
405 sock->Squit(s,std::string("Server quit by ") + user->GetFullRealHost());
406 ServerInstance->SE->DelFd(sock);
412 /* to be removed after 1.1.9 */
414 user->WriteServ("NOTICE %s :*** WARNING: Using SQUIT to split remote servers is deprecated and will be removed in a future version. Please use RSQUIT instead.",user->nick);
415 std::deque<std::string> params;
416 params.push_back(parameters[0]);
417 //params.push_back(std::string(":Server quit by ") + user->GetFullRealHost());
418 Utils->DoOneToOne(user->nick, "RSQUIT", params, s->GetName());
419 /* end to be removed after 1.1.9 */
420 /* to be INSERTED after 1.1.9 */
423 user->WriteServ("NOTICE %s :*** WARNING: Using SQUIT to split remote servers is deprecated. Please use RSQUIT instead.",user->nick);
425 /* end to be INSERTED after 1.1.9 */
430 user->WriteServ("NOTICE %s :*** SQUIT: The server \002%s\002 does not exist on the network.",user->nick,parameters[0]);
435 int ModuleSpanningTree::HandleTime(const char** parameters, int pcnt, userrec* user)
437 if ((IS_LOCAL(user)) && (pcnt))
439 TreeServer* found = Utils->FindServerMask(parameters[0]);
442 // we dont' override for local server
443 if (found == Utils->TreeRoot)
446 std::deque<std::string> params;
447 params.push_back(found->GetName());
448 params.push_back(user->nick);
449 Utils->DoOneToOne(ServerInstance->Config->ServerName,"TIME",params,found->GetName());
453 user->WriteServ("402 %s %s :No such server",user->nick,parameters[0]);
459 int ModuleSpanningTree::HandleRemoteWhois(const char** parameters, int pcnt, userrec* user)
461 if ((IS_LOCAL(user)) && (pcnt > 1))
463 userrec* remote = ServerInstance->FindNick(parameters[1]);
464 if ((remote) && (remote->GetFd() < 0))
466 std::deque<std::string> params;
467 params.push_back(parameters[1]);
468 Utils->DoOneToOne(user->nick,"IDLE",params,remote->server);
473 user->WriteServ("401 %s %s :No such nick/channel",user->nick, parameters[1]);
474 user->WriteServ("318 %s %s :End of /WHOIS list.",user->nick, parameters[1]);
481 void ModuleSpanningTree::DoPingChecks(time_t curtime)
483 for (unsigned int j = 0; j < Utils->TreeRoot->ChildCount(); j++)
485 TreeServer* serv = Utils->TreeRoot->GetChild(j);
486 TreeSocket* sock = serv->GetSocket();
489 if (curtime >= serv->NextPingTime())
491 if (serv->AnsweredLastPing())
493 sock->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" PING "+serv->GetName());
494 serv->SetNextPingTime(curtime + 60);
495 serv->LastPing = curtime;
496 serv->Warned = false;
500 /* they didnt answer, boot them */
501 sock->SendError("Ping timeout");
502 sock->Squit(serv,"Ping timeout");
503 ServerInstance->SE->DelFd(sock);
509 else if ((Utils->PingWarnTime) && (!serv->Warned) && (curtime >= serv->NextPingTime() - (60 - Utils->PingWarnTime)) && (!serv->AnsweredLastPing()))
511 /* The server hasnt responded, send a warning to opers */
512 ServerInstance->SNO->WriteToSnoMask('l',"Server \002%s\002 has not responded to PING for %d seconds, high latency.", serv->GetName().c_str(), Utils->PingWarnTime);
518 /* Cancel remote burst mode on any servers which still have it enabled due to latency/lack of data.
519 * This prevents lost REMOTECONNECT notices
521 for (server_hash::iterator i = Utils->serverlist.begin(); i != Utils->serverlist.end(); i++)
522 Utils->SetRemoteBursting(i->second, false);
525 void ModuleSpanningTree::ConnectServer(Link* x)
528 QueryType start_type = DNS_QUERY_A;
530 start_type = DNS_QUERY_AAAA;
531 if (strchr(x->IPAddr.c_str(),':'))
534 if (inet_pton(AF_INET6, x->IPAddr.c_str(), &n) < 1)
541 if (inet_aton(x->IPAddr.c_str(),&n) < 1)
545 /* Do we already have an IP? If so, no need to resolve it. */
548 /* Gave a hook, but it wasnt one we know */
549 if ((!x->Hook.empty()) && (Utils->hooks.find(x->Hook.c_str()) == Utils->hooks.end()))
551 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()]);
552 if (newsocket->GetFd() > -1)
554 /* Handled automatically on success */
558 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(),strerror(errno));
560 Utils->DoFailOver(x);
568 ServernameResolver* snr = new ServernameResolver((Module*)this, Utils, ServerInstance,x->IPAddr, *x, cached, start_type);
569 ServerInstance->AddResolver(snr, cached);
571 catch (ModuleException& e)
573 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason());
574 Utils->DoFailOver(x);
579 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
581 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
583 if ((x->AutoConnect) && (curtime >= x->NextConnectTime))
585 x->NextConnectTime = curtime + x->AutoConnect;
586 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
587 if (x->FailOver.length())
589 TreeServer* CheckFailOver = Utils->FindServer(x->FailOver.c_str());
592 /* The failover for this server is currently a member of the network.
593 * The failover probably succeeded, where the main link did not.
594 * Don't try the main link until the failover is gone again.
601 // an autoconnected server is not connected. Check if its time to connect it
602 ServerInstance->SNO->WriteToSnoMask('l',"AUTOCONNECT: Auto-connecting server \002%s\002 (%lu seconds until next attempt)",x->Name.c_str(),x->AutoConnect);
603 this->ConnectServer(&(*x));
609 int ModuleSpanningTree::HandleVersion(const char** parameters, int pcnt, userrec* user)
611 // we've already checked if pcnt > 0, so this is safe
612 TreeServer* found = Utils->FindServerMask(parameters[0]);
615 std::string Version = found->GetVersion();
616 user->WriteServ("351 %s :%s",user->nick,Version.c_str());
617 if (found == Utils->TreeRoot)
619 ServerInstance->Config->Send005(user);
624 user->WriteServ("402 %s %s :No such server",user->nick,parameters[0]);
629 int ModuleSpanningTree::HandleConnect(const char** parameters, int pcnt, userrec* user)
631 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
633 if (ServerInstance->MatchText(x->Name.c_str(),parameters[0]))
635 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
638 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);
639 ConnectServer(&(*x));
644 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());
649 user->WriteServ("NOTICE %s :*** CONNECT: No server matching \002%s\002 could be found in the config file.",user->nick,parameters[0]);
653 void ModuleSpanningTree::BroadcastTimeSync()
655 if (Utils->MasterTime)
657 std::deque<std::string> params;
658 params.push_back(ConvToStr(ServerInstance->Time(false)));
659 params.push_back("FORCE");
660 Utils->DoOneToMany(Utils->TreeRoot->GetName(), "TIMESET", params);
664 int ModuleSpanningTree::OnStats(char statschar, userrec* user, string_list &results)
666 if ((statschar == 'c') || (statschar == 'n'))
668 for (unsigned int i = 0; i < Utils->LinkBlocks.size(); i++)
670 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');
671 if (statschar == 'c')
672 results.push_back(std::string(ServerInstance->Config->ServerName)+" 244 "+user->nick+" H * * "+Utils->LinkBlocks[i].Name.c_str());
674 results.push_back(std::string(ServerInstance->Config->ServerName)+" 219 "+user->nick+" "+statschar+" :End of /STATS report");
675 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);
679 if (statschar == 'p')
681 /* show all server ports, after showing client ports. -- w00t */
683 for (unsigned int i = 0; i < Utils->Bindings.size(); i++)
685 std::string ip = Utils->Bindings[i]->IP;
689 std::string transport("plaintext");
690 if (Utils->Bindings[i]->GetHook())
691 transport = InspSocketNameRequest(this, Utils->Bindings[i]->GetHook()).Send();
693 results.push_back(ConvToStr(ServerInstance->Config->ServerName) + " 249 "+user->nick+" :" + ip + ":" + ConvToStr(Utils->Bindings[i]->port)+
694 " (server, " + transport + ")");
700 int ModuleSpanningTree::OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line)
702 /* If the command doesnt appear to be valid, we dont want to mess with it. */
706 if (command == "CONNECT")
708 return this->HandleConnect(parameters,pcnt,user);
710 else if (command == "STATS")
712 return this->HandleStats(parameters,pcnt,user);
714 else if (command == "MOTD")
716 return this->HandleMotd(parameters,pcnt,user);
718 else if (command == "ADMIN")
720 return this->HandleAdmin(parameters,pcnt,user);
722 else if (command == "SQUIT")
724 return this->HandleSquit(parameters,pcnt,user);
726 else if (command == "MAP")
728 this->HandleMap(parameters,pcnt,user);
731 else if ((command == "TIME") && (pcnt > 0))
733 return this->HandleTime(parameters,pcnt,user);
735 else if (command == "LUSERS")
737 this->HandleLusers(parameters,pcnt,user);
740 else if (command == "LINKS")
742 this->HandleLinks(parameters,pcnt,user);
745 else if (command == "WHOIS")
750 return this->HandleRemoteWhois(parameters,pcnt,user);
753 else if ((command == "VERSION") && (pcnt > 0))
755 this->HandleVersion(parameters,pcnt,user);
758 else if ((command == "MODULES") && (pcnt > 0))
760 return this->HandleModules(parameters,pcnt,user);
765 void ModuleSpanningTree::OnPostCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, CmdResult result, const std::string &original_line)
767 if ((result == CMD_SUCCESS) && (ServerInstance->IsValidModuleCommand(command, pcnt, user)))
769 // this bit of code cleverly routes all module commands
770 // to all remote severs *automatically* so that modules
771 // can just handle commands locally, without having
772 // to have any special provision in place for remote
773 // commands and linking protocols.
774 std::deque<std::string> params;
776 for (int j = 0; j < pcnt; j++)
778 if (strchr(parameters[j],' '))
780 params.push_back(":" + std::string(parameters[j]));
784 params.push_back(std::string(parameters[j]));
787 Utils->DoOneToMany(user->nick,command,params);
791 void ModuleSpanningTree::OnGetServerDescription(const std::string &servername,std::string &description)
793 TreeServer* s = Utils->FindServer(servername);
796 description = s->GetDesc();
800 void ModuleSpanningTree::OnUserInvite(userrec* source,userrec* dest,chanrec* channel)
802 if (IS_LOCAL(source))
804 std::deque<std::string> params;
805 params.push_back(dest->nick);
806 params.push_back(channel->name);
807 Utils->DoOneToMany(source->nick,"INVITE",params);
811 void ModuleSpanningTree::OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic)
813 std::deque<std::string> params;
814 params.push_back(chan->name);
815 params.push_back(":"+topic);
816 Utils->DoOneToMany(user->nick,"TOPIC",params);
819 void ModuleSpanningTree::OnWallops(userrec* user, const std::string &text)
823 std::deque<std::string> params;
824 params.push_back(":"+text);
825 Utils->DoOneToMany(user->nick,"WALLOPS",params);
829 void ModuleSpanningTree::OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
831 if (target_type == TYPE_USER)
833 userrec* d = (userrec*)dest;
834 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
836 std::deque<std::string> params;
838 params.push_back(d->nick);
839 params.push_back(":"+text);
840 Utils->DoOneToOne(user->nick,"NOTICE",params,d->server);
843 else if (target_type == TYPE_CHANNEL)
847 chanrec *c = (chanrec*)dest;
850 std::string cname = c->name;
852 cname = status + cname;
854 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
855 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
857 TreeSocket* Sock = i->second->GetSocket();
859 Sock->WriteLine(":"+std::string(user->nick)+" NOTICE "+cname+" :"+text);
864 else if (target_type == TYPE_SERVER)
868 char* target = (char*)dest;
869 std::deque<std::string> par;
870 par.push_back(target);
871 par.push_back(":"+text);
872 Utils->DoOneToMany(user->nick,"NOTICE",par);
877 void ModuleSpanningTree::OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
879 if (target_type == TYPE_USER)
881 // route private messages which are targetted at clients only to the server
882 // which needs to receive them
883 userrec* d = (userrec*)dest;
884 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
886 std::deque<std::string> params;
888 params.push_back(d->nick);
889 params.push_back(":"+text);
890 Utils->DoOneToOne(user->nick,"PRIVMSG",params,d->server);
893 else if (target_type == TYPE_CHANNEL)
897 chanrec *c = (chanrec*)dest;
900 std::string cname = c->name;
902 cname = status + cname;
904 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
905 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
907 TreeSocket* Sock = i->second->GetSocket();
909 Sock->WriteLine(":"+std::string(user->nick)+" PRIVMSG "+cname+" :"+text);
914 else if (target_type == TYPE_SERVER)
918 char* target = (char*)dest;
919 std::deque<std::string> par;
920 par.push_back(target);
921 par.push_back(":"+text);
922 Utils->DoOneToMany(user->nick,"PRIVMSG",par);
927 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
929 AutoConnectServers(curtime);
930 DoPingChecks(curtime);
933 void ModuleSpanningTree::OnUserJoin(userrec* user, chanrec* channel, bool &silent)
935 // Only do this for local users
938 if (channel->GetUserCounter() == 1)
940 std::deque<std::string> params;
941 // set up their permissions and the channel TS with FJOIN.
942 // All users are FJOINed now, because a module may specify
943 // new joining permissions for the user.
944 params.push_back(channel->name);
945 params.push_back(ConvToStr(channel->age));
946 params.push_back(std::string(channel->GetAllPrefixChars(user))+","+std::string(user->nick));
947 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FJOIN",params);
948 /* First user in, sync the modes for the channel */
950 params.push_back(channel->ChanModes(true));
951 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FMODE",params);
955 std::deque<std::string> params;
956 params.push_back(channel->name);
957 params.push_back(ConvToStr(channel->age));
958 Utils->DoOneToMany(user->nick,"JOIN",params);
963 void ModuleSpanningTree::OnChangeHost(userrec* user, const std::string &newhost)
965 // only occurs for local clients
966 if (user->registered != REG_ALL)
968 std::deque<std::string> params;
969 params.push_back(newhost);
970 Utils->DoOneToMany(user->nick,"FHOST",params);
973 void ModuleSpanningTree::OnChangeName(userrec* user, const std::string &gecos)
975 // only occurs for local clients
976 if (user->registered != REG_ALL)
978 std::deque<std::string> params;
979 params.push_back(gecos);
980 Utils->DoOneToMany(user->nick,"FNAME",params);
983 void ModuleSpanningTree::OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage, bool &silent)
987 std::deque<std::string> params;
988 params.push_back(channel->name);
989 if (!partmessage.empty())
990 params.push_back(":"+partmessage);
991 Utils->DoOneToMany(user->nick,"PART",params);
995 void ModuleSpanningTree::OnUserConnect(userrec* user)
1000 std::deque<std::string> params;
1001 snprintf(agestr,MAXBUF,"%lu",(unsigned long)user->age);
1002 params.push_back(agestr);
1003 params.push_back(user->nick);
1004 params.push_back(user->host);
1005 params.push_back(user->dhost);
1006 params.push_back(user->ident);
1007 params.push_back("+"+std::string(user->FormatModes()));
1008 params.push_back(user->GetIPString());
1009 params.push_back(":"+std::string(user->fullname));
1010 Utils->DoOneToMany(ServerInstance->Config->ServerName,"NICK",params);
1011 // User is Local, change needs to be reflected!
1012 TreeServer* SourceServer = Utils->FindServer(user->server);
1015 SourceServer->AddUserCount();
1020 void ModuleSpanningTree::OnUserQuit(userrec* user, const std::string &reason, const std::string &oper_message)
1022 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
1024 std::deque<std::string> params;
1026 if (oper_message != reason)
1028 params.push_back(":"+oper_message);
1029 Utils->DoOneToMany(user->nick,"OPERQUIT",params);
1032 params.push_back(":"+reason);
1033 Utils->DoOneToMany(user->nick,"QUIT",params);
1035 // Regardless, We need to modify the user Counts..
1036 TreeServer* SourceServer = Utils->FindServer(user->server);
1039 SourceServer->DelUserCount();
1043 void ModuleSpanningTree::OnUserPostNick(userrec* user, const std::string &oldnick)
1047 std::deque<std::string> params;
1048 params.push_back(user->nick);
1049 Utils->DoOneToMany(oldnick,"NICK",params);
1053 void ModuleSpanningTree::OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason, bool &silent)
1055 if ((source) && (IS_LOCAL(source)))
1057 std::deque<std::string> params;
1058 params.push_back(chan->name);
1059 params.push_back(user->nick);
1060 params.push_back(":"+reason);
1061 Utils->DoOneToMany(source->nick,"KICK",params);
1065 std::deque<std::string> params;
1066 params.push_back(chan->name);
1067 params.push_back(user->nick);
1068 params.push_back(":"+reason);
1069 Utils->DoOneToMany(ServerInstance->Config->ServerName,"KICK",params);
1073 void ModuleSpanningTree::OnRemoteKill(userrec* source, userrec* dest, const std::string &reason)
1075 std::deque<std::string> params;
1076 params.push_back(dest->nick);
1077 params.push_back(":"+reason);
1078 Utils->DoOneToMany(source->nick,"KILL",params);
1081 void ModuleSpanningTree::OnRehash(userrec* user, const std::string ¶meter)
1083 if (!parameter.empty())
1085 std::deque<std::string> params;
1086 params.push_back(parameter);
1087 Utils->DoOneToMany(user ? user->nick : ServerInstance->Config->ServerName, "REHASH", params);
1089 if (ServerInstance->MatchText(ServerInstance->Config->ServerName,parameter))
1091 ServerInstance->WriteOpers("*** Remote rehash initiated locally by \002%s\002", user ? user->nick : ServerInstance->Config->ServerName);
1092 ServerInstance->RehashServer();
1095 Utils->ReadConfiguration(false);
1096 InitializeDisabledCommands(ServerInstance->Config->DisabledCommands, ServerInstance);
1099 // note: the protocol does not allow direct umode +o except
1100 // via NICK with 8 params. sending OPERTYPE infers +o modechange
1102 void ModuleSpanningTree::OnOper(userrec* user, const std::string &opertype)
1106 std::deque<std::string> params;
1107 params.push_back(opertype);
1108 Utils->DoOneToMany(user->nick,"OPERTYPE",params);
1112 void ModuleSpanningTree::OnLine(userrec* source, const std::string &host, bool adding, char linetype, long duration, const std::string &reason)
1116 /* Server-set lines */
1118 snprintf(data,MAXBUF,"%c %s %s %lu %lu :%s", linetype, host.c_str(), ServerInstance->Config->ServerName, (unsigned long)ServerInstance->Time(false),
1119 (unsigned long)duration, reason.c_str());
1120 std::deque<std::string> params;
1121 params.push_back(data);
1122 Utils->DoOneToMany(ServerInstance->Config->ServerName, "ADDLINE", params);
1126 if (IS_LOCAL(source))
1129 snprintf(type,8,"%cLINE",linetype);
1130 std::string stype = type;
1133 char sduration[MAXBUF];
1134 snprintf(sduration,MAXBUF,"%ld",duration);
1135 std::deque<std::string> params;
1136 params.push_back(host);
1137 params.push_back(sduration);
1138 params.push_back(":"+reason);
1139 Utils->DoOneToMany(source->nick,stype,params);
1143 std::deque<std::string> params;
1144 params.push_back(host);
1145 Utils->DoOneToMany(source->nick,stype,params);
1151 void ModuleSpanningTree::OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask)
1153 OnLine(source,hostmask,true,'G',duration,reason);
1156 void ModuleSpanningTree::OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask)
1158 OnLine(source,ipmask,true,'Z',duration,reason);
1161 void ModuleSpanningTree::OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask)
1163 OnLine(source,nickmask,true,'Q',duration,reason);
1166 void ModuleSpanningTree::OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask)
1168 OnLine(source,hostmask,true,'E',duration,reason);
1171 void ModuleSpanningTree::OnDelGLine(userrec* source, const std::string &hostmask)
1173 OnLine(source,hostmask,false,'G',0,"");
1176 void ModuleSpanningTree::OnDelZLine(userrec* source, const std::string &ipmask)
1178 OnLine(source,ipmask,false,'Z',0,"");
1181 void ModuleSpanningTree::OnDelQLine(userrec* source, const std::string &nickmask)
1183 OnLine(source,nickmask,false,'Q',0,"");
1186 void ModuleSpanningTree::OnDelELine(userrec* source, const std::string &hostmask)
1188 OnLine(source,hostmask,false,'E',0,"");
1191 void ModuleSpanningTree::OnMode(userrec* user, void* dest, int target_type, const std::string &text)
1193 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
1195 std::deque<std::string> params;
1196 std::string command;
1198 if (target_type == TYPE_USER)
1200 userrec* u = (userrec*)dest;
1201 params.push_back(u->nick);
1202 params.push_back(text);
1207 chanrec* c = (chanrec*)dest;
1208 params.push_back(c->name);
1209 params.push_back(ConvToStr(c->age));
1210 params.push_back(text);
1213 Utils->DoOneToMany(user->nick, command, params);
1217 void ModuleSpanningTree::OnSetAway(userrec* user)
1221 std::deque<std::string> params;
1222 params.push_back(":"+std::string(user->awaymsg));
1223 Utils->DoOneToMany(user->nick,"AWAY",params);
1227 void ModuleSpanningTree::OnCancelAway(userrec* user)
1231 std::deque<std::string> params;
1233 Utils->DoOneToMany(user->nick,"AWAY",params);
1237 void ModuleSpanningTree::ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline)
1239 TreeSocket* s = (TreeSocket*)opaque;
1242 if (target_type == TYPE_USER)
1244 userrec* u = (userrec*)target;
1245 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" FMODE "+u->nick+" "+ConvToStr(u->age)+" "+modeline);
1249 chanrec* c = (chanrec*)target;
1250 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" FMODE "+c->name+" "+ConvToStr(c->age)+" "+modeline);
1255 void ModuleSpanningTree::ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata)
1257 TreeSocket* s = (TreeSocket*)opaque;
1260 if (target_type == TYPE_USER)
1262 userrec* u = (userrec*)target;
1263 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA "+u->nick+" "+extname+" :"+extdata);
1265 else if (target_type == TYPE_CHANNEL)
1267 chanrec* c = (chanrec*)target;
1268 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA "+c->name+" "+extname+" :"+extdata);
1271 if (target_type == TYPE_OTHER)
1273 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA * "+extname+" :"+extdata);
1277 void ModuleSpanningTree::OnEvent(Event* event)
1279 std::deque<std::string>* params = (std::deque<std::string>*)event->GetData();
1280 if (event->GetEventID() == "send_metadata")
1282 if (params->size() < 3)
1284 (*params)[2] = ":" + (*params)[2];
1285 Utils->DoOneToMany(ServerInstance->Config->ServerName,"METADATA",*params);
1287 else if (event->GetEventID() == "send_topic")
1289 if (params->size() < 2)
1291 (*params)[1] = ":" + (*params)[1];
1292 params->insert(params->begin() + 1,ServerInstance->Config->ServerName);
1293 params->insert(params->begin() + 1,ConvToStr(ServerInstance->Time(true)));
1294 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FTOPIC",*params);
1296 else if (event->GetEventID() == "send_mode")
1298 if (params->size() < 2)
1300 // Insert the TS value of the object, either userrec or chanrec
1302 userrec* a = ServerInstance->FindNick((*params)[0]);
1306 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODE",*params);
1311 chanrec* a = ServerInstance->FindChan((*params)[0]);
1315 params->insert(params->begin() + 1,ConvToStr(ourTS));
1316 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FMODE",*params);
1320 else if (event->GetEventID() == "send_mode_explicit")
1322 if (params->size() < 2)
1324 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODE",*params);
1326 else if (event->GetEventID() == "send_opers")
1328 if (params->size() < 1)
1330 (*params)[0] = ":" + (*params)[0];
1331 Utils->DoOneToMany(ServerInstance->Config->ServerName,"OPERNOTICE",*params);
1333 else if (event->GetEventID() == "send_modeset")
1335 if (params->size() < 2)
1337 (*params)[1] = ":" + (*params)[1];
1338 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODENOTICE",*params);
1340 else if (event->GetEventID() == "send_snoset")
1342 if (params->size() < 2)
1344 (*params)[1] = ":" + (*params)[1];
1345 Utils->DoOneToMany(ServerInstance->Config->ServerName,"SNONOTICE",*params);
1347 else if (event->GetEventID() == "send_push")
1349 if (params->size() < 2)
1352 userrec *a = ServerInstance->FindNick((*params)[0]);
1357 (*params)[1] = ":" + (*params)[1];
1358 Utils->DoOneToOne(ServerInstance->Config->ServerName, "PUSH", *params, a->server);
1362 ModuleSpanningTree::~ModuleSpanningTree()
1364 /* This will also free the listeners */
1367 ServerInstance->Timers->DelTimer(SyncTimer);
1369 ServerInstance->Timers->DelTimer(RefreshTimer);
1371 ServerInstance->DoneWithInterface("InspSocketHook");
1374 Version ModuleSpanningTree::GetVersion()
1376 return Version(1,1,0,2,VF_VENDOR,API_VERSION);
1379 void ModuleSpanningTree::Implements(char* List)
1381 List[I_OnPreCommand] = List[I_OnGetServerDescription] = List[I_OnUserInvite] = List[I_OnPostLocalTopicChange] = 1;
1382 List[I_OnWallops] = List[I_OnUserNotice] = List[I_OnUserMessage] = List[I_OnBackgroundTimer] = 1;
1383 List[I_OnUserJoin] = List[I_OnChangeHost] = List[I_OnChangeName] = List[I_OnUserPart] = List[I_OnUserConnect] = 1;
1384 List[I_OnUserQuit] = List[I_OnUserPostNick] = List[I_OnUserKick] = List[I_OnRemoteKill] = List[I_OnRehash] = 1;
1385 List[I_OnOper] = List[I_OnAddGLine] = List[I_OnAddZLine] = List[I_OnAddQLine] = List[I_OnAddELine] = 1;
1386 List[I_OnDelGLine] = List[I_OnDelZLine] = List[I_OnDelQLine] = List[I_OnDelELine] = List[I_ProtoSendMode] = List[I_OnMode] = 1;
1387 List[I_OnStats] = List[I_ProtoSendMetaData] = List[I_OnEvent] = List[I_OnSetAway] = List[I_OnCancelAway] = List[I_OnPostCommand] = 1;
1390 /* It is IMPORTANT that m_spanningtree is the last module in the chain
1391 * so that any activity it sees is FINAL, e.g. we arent going to send out
1392 * a NICK message before m_cloaking has finished putting the +x on the user,
1394 * Therefore, we return PRIORITY_LAST to make sure we end up at the END of
1395 * the module call queue.
1397 Priority ModuleSpanningTree::Prioritize()
1399 return PRIORITY_LAST;
1402 class ModuleSpanningTreeFactory : public ModuleFactory
1405 ModuleSpanningTreeFactory()
1409 ~ModuleSpanningTreeFactory()
1413 virtual Module * CreateModule(InspIRCd* Me)
1415 return new ModuleSpanningTree(Me);
1421 extern "C" DllExport void * init_module( void )
1423 return new ModuleSpanningTreeFactory;