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 user->WriteServ("NOTICE %s :*** WARNING: Using SQUIT to split remote servers is deprecated. Please use RSQUIT instead.",user->nick);
417 user->WriteServ("NOTICE %s :*** SQUIT: The server \002%s\002 does not exist on the network.",user->nick,parameters[0]);
422 int ModuleSpanningTree::HandleTime(const char** parameters, int pcnt, userrec* user)
424 if ((IS_LOCAL(user)) && (pcnt))
426 TreeServer* found = Utils->FindServerMask(parameters[0]);
429 // we dont' override for local server
430 if (found == Utils->TreeRoot)
433 std::deque<std::string> params;
434 params.push_back(found->GetName());
435 params.push_back(user->nick);
436 Utils->DoOneToOne(ServerInstance->Config->ServerName,"TIME",params,found->GetName());
440 user->WriteServ("402 %s %s :No such server",user->nick,parameters[0]);
446 int ModuleSpanningTree::HandleRemoteWhois(const char** parameters, int pcnt, userrec* user)
448 if ((IS_LOCAL(user)) && (pcnt > 1))
450 userrec* remote = ServerInstance->FindNick(parameters[1]);
451 if ((remote) && (remote->GetFd() < 0))
453 std::deque<std::string> params;
454 params.push_back(parameters[1]);
455 Utils->DoOneToOne(user->nick,"IDLE",params,remote->server);
460 user->WriteServ("401 %s %s :No such nick/channel",user->nick, parameters[1]);
461 user->WriteServ("318 %s %s :End of /WHOIS list.",user->nick, parameters[1]);
468 void ModuleSpanningTree::DoPingChecks(time_t curtime)
470 for (unsigned int j = 0; j < Utils->TreeRoot->ChildCount(); j++)
472 TreeServer* serv = Utils->TreeRoot->GetChild(j);
473 TreeSocket* sock = serv->GetSocket();
476 if (curtime >= serv->NextPingTime())
478 if (serv->AnsweredLastPing())
480 sock->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" PING "+serv->GetName());
481 serv->SetNextPingTime(curtime + 60);
482 serv->LastPing = curtime;
483 serv->Warned = false;
487 /* they didnt answer, boot them */
488 sock->SendError("Ping timeout");
489 sock->Squit(serv,"Ping timeout");
490 /*** XXX SOCKET CULL ***/
494 else if ((Utils->PingWarnTime) && (!serv->Warned) && (curtime >= serv->NextPingTime() - (60 - Utils->PingWarnTime)) && (!serv->AnsweredLastPing()))
496 /* The server hasnt responded, send a warning to opers */
497 ServerInstance->SNO->WriteToSnoMask('l',"Server \002%s\002 has not responded to PING for %d seconds, high latency.", serv->GetName().c_str(), Utils->PingWarnTime);
503 /* Cancel remote burst mode on any servers which still have it enabled due to latency/lack of data.
504 * This prevents lost REMOTECONNECT notices
506 for (server_hash::iterator i = Utils->serverlist.begin(); i != Utils->serverlist.end(); i++)
507 Utils->SetRemoteBursting(i->second, false);
510 void ModuleSpanningTree::ConnectServer(Link* x)
513 QueryType start_type = DNS_QUERY_A;
515 start_type = DNS_QUERY_AAAA;
516 if (strchr(x->IPAddr.c_str(),':'))
519 if (inet_pton(AF_INET6, x->IPAddr.c_str(), &n) < 1)
526 if (inet_aton(x->IPAddr.c_str(),&n) < 1)
530 /* Do we already have an IP? If so, no need to resolve it. */
533 /* Gave a hook, but it wasnt one we know */
534 if ((!x->Hook.empty()) && (Utils->hooks.find(x->Hook.c_str()) == Utils->hooks.end()))
536 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()]);
537 if (newsocket->GetFd() > -1)
539 /* Handled automatically on success */
543 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(),strerror(errno));
545 Utils->DoFailOver(x);
553 ServernameResolver* snr = new ServernameResolver((Module*)this, Utils, ServerInstance,x->IPAddr, *x, cached, start_type);
554 ServerInstance->AddResolver(snr, cached);
556 catch (ModuleException& e)
558 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason());
559 Utils->DoFailOver(x);
564 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
566 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
568 if ((x->AutoConnect) && (curtime >= x->NextConnectTime))
570 x->NextConnectTime = curtime + x->AutoConnect;
571 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
572 if (x->FailOver.length())
574 TreeServer* CheckFailOver = Utils->FindServer(x->FailOver.c_str());
577 /* The failover for this server is currently a member of the network.
578 * The failover probably succeeded, where the main link did not.
579 * Don't try the main link until the failover is gone again.
586 // an autoconnected server is not connected. Check if its time to connect it
587 ServerInstance->SNO->WriteToSnoMask('l',"AUTOCONNECT: Auto-connecting server \002%s\002 (%lu seconds until next attempt)",x->Name.c_str(),x->AutoConnect);
588 this->ConnectServer(&(*x));
594 int ModuleSpanningTree::HandleVersion(const char** parameters, int pcnt, userrec* user)
596 // we've already checked if pcnt > 0, so this is safe
597 TreeServer* found = Utils->FindServerMask(parameters[0]);
600 std::string Version = found->GetVersion();
601 user->WriteServ("351 %s :%s",user->nick,Version.c_str());
602 if (found == Utils->TreeRoot)
604 ServerInstance->Config->Send005(user);
609 user->WriteServ("402 %s %s :No such server",user->nick,parameters[0]);
614 int ModuleSpanningTree::HandleConnect(const char** parameters, int pcnt, userrec* user)
616 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
618 if (ServerInstance->MatchText(x->Name.c_str(),parameters[0]))
620 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
623 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);
624 ConnectServer(&(*x));
629 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());
634 user->WriteServ("NOTICE %s :*** CONNECT: No server matching \002%s\002 could be found in the config file.",user->nick,parameters[0]);
638 void ModuleSpanningTree::BroadcastTimeSync()
640 if (Utils->MasterTime)
642 std::deque<std::string> params;
643 params.push_back(ConvToStr(ServerInstance->Time(false)));
644 params.push_back("FORCE");
645 Utils->DoOneToMany(Utils->TreeRoot->GetName(), "TIMESET", params);
649 int ModuleSpanningTree::OnStats(char statschar, userrec* user, string_list &results)
651 if ((statschar == 'c') || (statschar == 'n'))
653 for (unsigned int i = 0; i < Utils->LinkBlocks.size(); i++)
655 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');
656 if (statschar == 'c')
657 results.push_back(std::string(ServerInstance->Config->ServerName)+" 244 "+user->nick+" H * * "+Utils->LinkBlocks[i].Name.c_str());
659 results.push_back(std::string(ServerInstance->Config->ServerName)+" 219 "+user->nick+" "+statschar+" :End of /STATS report");
660 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);
664 if (statschar == 'p')
666 /* show all server ports, after showing client ports. -- w00t */
668 for (unsigned int i = 0; i < Utils->Bindings.size(); i++)
670 std::string ip = Utils->Bindings[i]->IP;
674 std::string transport("plaintext");
675 if (Utils->Bindings[i]->GetHook())
676 transport = InspSocketNameRequest(this, Utils->Bindings[i]->GetHook()).Send();
678 results.push_back(ConvToStr(ServerInstance->Config->ServerName) + " 249 "+user->nick+" :" + ip + ":" + ConvToStr(Utils->Bindings[i]->port)+
679 " (server, " + transport + ")");
685 int ModuleSpanningTree::OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line)
687 /* If the command doesnt appear to be valid, we dont want to mess with it. */
691 if (command == "CONNECT")
693 return this->HandleConnect(parameters,pcnt,user);
695 else if (command == "STATS")
697 return this->HandleStats(parameters,pcnt,user);
699 else if (command == "MOTD")
701 return this->HandleMotd(parameters,pcnt,user);
703 else if (command == "ADMIN")
705 return this->HandleAdmin(parameters,pcnt,user);
707 else if (command == "SQUIT")
709 return this->HandleSquit(parameters,pcnt,user);
711 else if (command == "MAP")
713 this->HandleMap(parameters,pcnt,user);
716 else if ((command == "TIME") && (pcnt > 0))
718 return this->HandleTime(parameters,pcnt,user);
720 else if (command == "LUSERS")
722 this->HandleLusers(parameters,pcnt,user);
725 else if (command == "LINKS")
727 this->HandleLinks(parameters,pcnt,user);
730 else if (command == "WHOIS")
735 return this->HandleRemoteWhois(parameters,pcnt,user);
738 else if ((command == "VERSION") && (pcnt > 0))
740 this->HandleVersion(parameters,pcnt,user);
743 else if ((command == "MODULES") && (pcnt > 0))
745 return this->HandleModules(parameters,pcnt,user);
750 void ModuleSpanningTree::OnPostCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, CmdResult result, const std::string &original_line)
752 if ((result == CMD_SUCCESS) && (ServerInstance->IsValidModuleCommand(command, pcnt, user)))
754 // this bit of code cleverly routes all module commands
755 // to all remote severs *automatically* so that modules
756 // can just handle commands locally, without having
757 // to have any special provision in place for remote
758 // commands and linking protocols.
759 std::deque<std::string> params;
761 for (int j = 0; j < pcnt; j++)
763 if (strchr(parameters[j],' '))
765 params.push_back(":" + std::string(parameters[j]));
769 params.push_back(std::string(parameters[j]));
772 Utils->DoOneToMany(user->nick,command,params);
776 void ModuleSpanningTree::OnGetServerDescription(const std::string &servername,std::string &description)
778 TreeServer* s = Utils->FindServer(servername);
781 description = s->GetDesc();
785 void ModuleSpanningTree::OnUserInvite(userrec* source,userrec* dest,chanrec* channel)
787 if (IS_LOCAL(source))
789 std::deque<std::string> params;
790 params.push_back(dest->nick);
791 params.push_back(channel->name);
792 Utils->DoOneToMany(source->nick,"INVITE",params);
796 void ModuleSpanningTree::OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic)
798 std::deque<std::string> params;
799 params.push_back(chan->name);
800 params.push_back(":"+topic);
801 Utils->DoOneToMany(user->nick,"TOPIC",params);
804 void ModuleSpanningTree::OnWallops(userrec* user, const std::string &text)
808 std::deque<std::string> params;
809 params.push_back(":"+text);
810 Utils->DoOneToMany(user->nick,"WALLOPS",params);
814 void ModuleSpanningTree::OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
816 if (target_type == TYPE_USER)
818 userrec* d = (userrec*)dest;
819 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
821 std::deque<std::string> params;
823 params.push_back(d->nick);
824 params.push_back(":"+text);
825 Utils->DoOneToOne(user->nick,"NOTICE",params,d->server);
828 else if (target_type == TYPE_CHANNEL)
832 chanrec *c = (chanrec*)dest;
835 std::string cname = c->name;
837 cname = status + cname;
839 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
840 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
842 TreeSocket* Sock = i->second->GetSocket();
844 Sock->WriteLine(":"+std::string(user->nick)+" NOTICE "+cname+" :"+text);
849 else if (target_type == TYPE_SERVER)
853 char* target = (char*)dest;
854 std::deque<std::string> par;
855 par.push_back(target);
856 par.push_back(":"+text);
857 Utils->DoOneToMany(user->nick,"NOTICE",par);
862 void ModuleSpanningTree::OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
864 if (target_type == TYPE_USER)
866 // route private messages which are targetted at clients only to the server
867 // which needs to receive them
868 userrec* d = (userrec*)dest;
869 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
871 std::deque<std::string> params;
873 params.push_back(d->nick);
874 params.push_back(":"+text);
875 Utils->DoOneToOne(user->nick,"PRIVMSG",params,d->server);
878 else if (target_type == TYPE_CHANNEL)
882 chanrec *c = (chanrec*)dest;
885 std::string cname = c->name;
887 cname = status + cname;
889 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
890 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
892 TreeSocket* Sock = i->second->GetSocket();
894 Sock->WriteLine(":"+std::string(user->nick)+" PRIVMSG "+cname+" :"+text);
899 else if (target_type == TYPE_SERVER)
903 char* target = (char*)dest;
904 std::deque<std::string> par;
905 par.push_back(target);
906 par.push_back(":"+text);
907 Utils->DoOneToMany(user->nick,"PRIVMSG",par);
912 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
914 AutoConnectServers(curtime);
915 DoPingChecks(curtime);
918 void ModuleSpanningTree::OnUserJoin(userrec* user, chanrec* channel, bool &silent)
920 // Only do this for local users
923 if (channel->GetUserCounter() == 1)
925 std::deque<std::string> params;
926 // set up their permissions and the channel TS with FJOIN.
927 // All users are FJOINed now, because a module may specify
928 // new joining permissions for the user.
929 params.push_back(channel->name);
930 params.push_back(ConvToStr(channel->age));
931 params.push_back(std::string(channel->GetAllPrefixChars(user))+","+std::string(user->nick));
932 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FJOIN",params);
933 /* First user in, sync the modes for the channel */
935 params.push_back(channel->ChanModes(true));
936 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FMODE",params);
940 std::deque<std::string> params;
941 params.push_back(channel->name);
942 params.push_back(ConvToStr(channel->age));
943 Utils->DoOneToMany(user->nick,"JOIN",params);
948 void ModuleSpanningTree::OnChangeHost(userrec* user, const std::string &newhost)
950 // only occurs for local clients
951 if (user->registered != REG_ALL)
953 std::deque<std::string> params;
954 params.push_back(newhost);
955 Utils->DoOneToMany(user->nick,"FHOST",params);
958 void ModuleSpanningTree::OnChangeName(userrec* user, const std::string &gecos)
960 // only occurs for local clients
961 if (user->registered != REG_ALL)
963 std::deque<std::string> params;
964 params.push_back(gecos);
965 Utils->DoOneToMany(user->nick,"FNAME",params);
968 void ModuleSpanningTree::OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage, bool &silent)
972 std::deque<std::string> params;
973 params.push_back(channel->name);
974 if (!partmessage.empty())
975 params.push_back(":"+partmessage);
976 Utils->DoOneToMany(user->nick,"PART",params);
980 void ModuleSpanningTree::OnUserConnect(userrec* user)
985 std::deque<std::string> params;
986 snprintf(agestr,MAXBUF,"%lu",(unsigned long)user->age);
987 params.push_back(agestr);
988 params.push_back(user->nick);
989 params.push_back(user->host);
990 params.push_back(user->dhost);
991 params.push_back(user->ident);
992 params.push_back("+"+std::string(user->FormatModes()));
993 params.push_back(user->GetIPString());
994 params.push_back(":"+std::string(user->fullname));
995 Utils->DoOneToMany(ServerInstance->Config->ServerName,"NICK",params);
996 // User is Local, change needs to be reflected!
997 TreeServer* SourceServer = Utils->FindServer(user->server);
1000 SourceServer->AddUserCount();
1005 void ModuleSpanningTree::OnUserQuit(userrec* user, const std::string &reason, const std::string &oper_message)
1007 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
1009 std::deque<std::string> params;
1011 if (oper_message != reason)
1013 params.push_back(":"+oper_message);
1014 Utils->DoOneToMany(user->nick,"OPERQUIT",params);
1017 params.push_back(":"+reason);
1018 Utils->DoOneToMany(user->nick,"QUIT",params);
1020 // Regardless, We need to modify the user Counts..
1021 TreeServer* SourceServer = Utils->FindServer(user->server);
1024 SourceServer->DelUserCount();
1028 void ModuleSpanningTree::OnUserPostNick(userrec* user, const std::string &oldnick)
1032 std::deque<std::string> params;
1033 params.push_back(user->nick);
1034 Utils->DoOneToMany(oldnick,"NICK",params);
1038 void ModuleSpanningTree::OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason, bool &silent)
1040 if ((source) && (IS_LOCAL(source)))
1042 std::deque<std::string> params;
1043 params.push_back(chan->name);
1044 params.push_back(user->nick);
1045 params.push_back(":"+reason);
1046 Utils->DoOneToMany(source->nick,"KICK",params);
1050 std::deque<std::string> params;
1051 params.push_back(chan->name);
1052 params.push_back(user->nick);
1053 params.push_back(":"+reason);
1054 Utils->DoOneToMany(ServerInstance->Config->ServerName,"KICK",params);
1058 void ModuleSpanningTree::OnRemoteKill(userrec* source, userrec* dest, const std::string &reason, const std::string &operreason)
1060 std::deque<std::string> params;
1061 params.push_back(":"+reason);
1062 Utils->DoOneToMany(dest->nick,"OPERQUIT",params);
1064 params.push_back(dest->nick);
1065 params.push_back(":"+reason);
1066 dest->SetOperQuit(operreason);
1067 Utils->DoOneToMany(source->nick,"KILL",params);
1070 void ModuleSpanningTree::OnRehash(userrec* user, const std::string ¶meter)
1072 if (!parameter.empty())
1074 std::deque<std::string> params;
1075 params.push_back(parameter);
1076 Utils->DoOneToMany(user ? user->nick : ServerInstance->Config->ServerName, "REHASH", params);
1078 if (ServerInstance->MatchText(ServerInstance->Config->ServerName,parameter))
1080 ServerInstance->WriteOpers("*** Remote rehash initiated locally by \002%s\002", user ? user->nick : ServerInstance->Config->ServerName);
1081 ServerInstance->RehashServer();
1084 Utils->ReadConfiguration(false);
1085 InitializeDisabledCommands(ServerInstance->Config->DisabledCommands, ServerInstance);
1088 // note: the protocol does not allow direct umode +o except
1089 // via NICK with 8 params. sending OPERTYPE infers +o modechange
1091 void ModuleSpanningTree::OnOper(userrec* user, const std::string &opertype)
1095 std::deque<std::string> params;
1096 params.push_back(opertype);
1097 Utils->DoOneToMany(user->nick,"OPERTYPE",params);
1101 void ModuleSpanningTree::OnLine(userrec* source, const std::string &host, bool adding, char linetype, long duration, const std::string &reason)
1105 /* Server-set lines */
1107 snprintf(data,MAXBUF,"%c %s %s %lu %lu :%s", linetype, host.c_str(), ServerInstance->Config->ServerName, (unsigned long)ServerInstance->Time(false),
1108 (unsigned long)duration, reason.c_str());
1109 std::deque<std::string> params;
1110 params.push_back(data);
1111 Utils->DoOneToMany(ServerInstance->Config->ServerName, "ADDLINE", params);
1115 if (IS_LOCAL(source))
1118 snprintf(type,8,"%cLINE",linetype);
1119 std::string stype = type;
1122 char sduration[MAXBUF];
1123 snprintf(sduration,MAXBUF,"%ld",duration);
1124 std::deque<std::string> params;
1125 params.push_back(host);
1126 params.push_back(sduration);
1127 params.push_back(":"+reason);
1128 Utils->DoOneToMany(source->nick,stype,params);
1132 std::deque<std::string> params;
1133 params.push_back(host);
1134 Utils->DoOneToMany(source->nick,stype,params);
1140 void ModuleSpanningTree::OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask)
1142 OnLine(source,hostmask,true,'G',duration,reason);
1145 void ModuleSpanningTree::OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask)
1147 OnLine(source,ipmask,true,'Z',duration,reason);
1150 void ModuleSpanningTree::OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask)
1152 OnLine(source,nickmask,true,'Q',duration,reason);
1155 void ModuleSpanningTree::OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask)
1157 OnLine(source,hostmask,true,'E',duration,reason);
1160 void ModuleSpanningTree::OnDelGLine(userrec* source, const std::string &hostmask)
1162 OnLine(source,hostmask,false,'G',0,"");
1165 void ModuleSpanningTree::OnDelZLine(userrec* source, const std::string &ipmask)
1167 OnLine(source,ipmask,false,'Z',0,"");
1170 void ModuleSpanningTree::OnDelQLine(userrec* source, const std::string &nickmask)
1172 OnLine(source,nickmask,false,'Q',0,"");
1175 void ModuleSpanningTree::OnDelELine(userrec* source, const std::string &hostmask)
1177 OnLine(source,hostmask,false,'E',0,"");
1180 void ModuleSpanningTree::OnMode(userrec* user, void* dest, int target_type, const std::string &text)
1182 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
1184 std::deque<std::string> params;
1185 std::string command;
1187 if (target_type == TYPE_USER)
1189 userrec* u = (userrec*)dest;
1190 params.push_back(u->nick);
1191 params.push_back(text);
1196 chanrec* c = (chanrec*)dest;
1197 params.push_back(c->name);
1198 params.push_back(ConvToStr(c->age));
1199 params.push_back(text);
1202 Utils->DoOneToMany(user->nick, command, params);
1206 void ModuleSpanningTree::OnSetAway(userrec* user)
1210 std::deque<std::string> params;
1211 params.push_back(":"+std::string(user->awaymsg));
1212 Utils->DoOneToMany(user->nick,"AWAY",params);
1216 void ModuleSpanningTree::OnCancelAway(userrec* user)
1220 std::deque<std::string> params;
1222 Utils->DoOneToMany(user->nick,"AWAY",params);
1226 void ModuleSpanningTree::ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline)
1228 TreeSocket* s = (TreeSocket*)opaque;
1231 if (target_type == TYPE_USER)
1233 userrec* u = (userrec*)target;
1234 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" FMODE "+u->nick+" "+ConvToStr(u->age)+" "+modeline);
1238 chanrec* c = (chanrec*)target;
1239 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" FMODE "+c->name+" "+ConvToStr(c->age)+" "+modeline);
1244 void ModuleSpanningTree::ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata)
1246 TreeSocket* s = (TreeSocket*)opaque;
1249 if (target_type == TYPE_USER)
1251 userrec* u = (userrec*)target;
1252 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA "+u->nick+" "+extname+" :"+extdata);
1254 else if (target_type == TYPE_CHANNEL)
1256 chanrec* c = (chanrec*)target;
1257 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA "+c->name+" "+extname+" :"+extdata);
1260 if (target_type == TYPE_OTHER)
1262 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA * "+extname+" :"+extdata);
1266 void ModuleSpanningTree::OnEvent(Event* event)
1268 std::deque<std::string>* params = (std::deque<std::string>*)event->GetData();
1269 if (event->GetEventID() == "send_metadata")
1271 if (params->size() < 3)
1273 (*params)[2] = ":" + (*params)[2];
1274 Utils->DoOneToMany(ServerInstance->Config->ServerName,"METADATA",*params);
1276 else if (event->GetEventID() == "send_topic")
1278 if (params->size() < 2)
1280 (*params)[1] = ":" + (*params)[1];
1281 params->insert(params->begin() + 1,ServerInstance->Config->ServerName);
1282 params->insert(params->begin() + 1,ConvToStr(ServerInstance->Time(true)));
1283 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FTOPIC",*params);
1285 else if (event->GetEventID() == "send_mode")
1287 if (params->size() < 2)
1289 // Insert the TS value of the object, either userrec or chanrec
1291 userrec* a = ServerInstance->FindNick((*params)[0]);
1295 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODE",*params);
1300 chanrec* a = ServerInstance->FindChan((*params)[0]);
1304 params->insert(params->begin() + 1,ConvToStr(ourTS));
1305 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FMODE",*params);
1309 else if (event->GetEventID() == "send_mode_explicit")
1311 if (params->size() < 2)
1313 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODE",*params);
1315 else if (event->GetEventID() == "send_opers")
1317 if (params->size() < 1)
1319 (*params)[0] = ":" + (*params)[0];
1320 Utils->DoOneToMany(ServerInstance->Config->ServerName,"OPERNOTICE",*params);
1322 else if (event->GetEventID() == "send_modeset")
1324 if (params->size() < 2)
1326 (*params)[1] = ":" + (*params)[1];
1327 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODENOTICE",*params);
1329 else if (event->GetEventID() == "send_snoset")
1331 if (params->size() < 2)
1333 (*params)[1] = ":" + (*params)[1];
1334 Utils->DoOneToMany(ServerInstance->Config->ServerName,"SNONOTICE",*params);
1336 else if (event->GetEventID() == "send_push")
1338 if (params->size() < 2)
1341 userrec *a = ServerInstance->FindNick((*params)[0]);
1346 (*params)[1] = ":" + (*params)[1];
1347 Utils->DoOneToOne(ServerInstance->Config->ServerName, "PUSH", *params, a->server);
1351 ModuleSpanningTree::~ModuleSpanningTree()
1353 /* This will also free the listeners */
1356 ServerInstance->Timers->DelTimer(SyncTimer);
1358 ServerInstance->Timers->DelTimer(RefreshTimer);
1360 ServerInstance->DoneWithInterface("InspSocketHook");
1363 Version ModuleSpanningTree::GetVersion()
1365 return Version(1,1,0,2,VF_VENDOR,API_VERSION);
1368 void ModuleSpanningTree::Implements(char* List)
1370 List[I_OnPreCommand] = List[I_OnGetServerDescription] = List[I_OnUserInvite] = List[I_OnPostLocalTopicChange] = 1;
1371 List[I_OnWallops] = List[I_OnUserNotice] = List[I_OnUserMessage] = List[I_OnBackgroundTimer] = 1;
1372 List[I_OnUserJoin] = List[I_OnChangeHost] = List[I_OnChangeName] = List[I_OnUserPart] = List[I_OnUserConnect] = 1;
1373 List[I_OnUserQuit] = List[I_OnUserPostNick] = List[I_OnUserKick] = List[I_OnRemoteKill] = List[I_OnRehash] = 1;
1374 List[I_OnOper] = List[I_OnAddGLine] = List[I_OnAddZLine] = List[I_OnAddQLine] = List[I_OnAddELine] = 1;
1375 List[I_OnDelGLine] = List[I_OnDelZLine] = List[I_OnDelQLine] = List[I_OnDelELine] = List[I_ProtoSendMode] = List[I_OnMode] = 1;
1376 List[I_OnStats] = List[I_ProtoSendMetaData] = List[I_OnEvent] = List[I_OnSetAway] = List[I_OnCancelAway] = List[I_OnPostCommand] = 1;
1379 /* It is IMPORTANT that m_spanningtree is the last module in the chain
1380 * so that any activity it sees is FINAL, e.g. we arent going to send out
1381 * a NICK message before m_cloaking has finished putting the +x on the user,
1383 * Therefore, we return PRIORITY_LAST to make sure we end up at the END of
1384 * the module call queue.
1386 Priority ModuleSpanningTree::Prioritize()
1388 return PRIORITY_LAST;
1391 MODULE_INIT(ModuleSpanningTree)