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 */
16 #include "configreader.h"
20 #include "commands/cmd_whois.h"
21 #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"
37 /* $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 */
39 ModuleSpanningTree::ModuleSpanningTree(InspIRCd* Me)
40 : Module(Me), max_local(0), max_global(0)
42 ServerInstance->UseInterface("InspSocketHook");
43 Utils = new SpanningTreeUtilities(Me, this);
44 command_rconnect = new cmd_rconnect(ServerInstance, this, Utils);
45 ServerInstance->AddCommand(command_rconnect);
46 if (Utils->EnableTimeSync)
48 SyncTimer = new TimeSyncTimer(ServerInstance, this);
49 ServerInstance->Timers->AddTimer(SyncTimer);
54 RefreshTimer = new CacheRefreshTimer(ServerInstance, Utils);
55 ServerInstance->Timers->AddTimer(RefreshTimer);
58 void ModuleSpanningTree::ShowLinks(TreeServer* Current, userrec* user, int hops)
60 std::string Parent = Utils->TreeRoot->GetName();
61 if (Current->GetParent())
63 Parent = Current->GetParent()->GetName();
65 for (unsigned int q = 0; q < Current->ChildCount(); q++)
67 if ((Current->GetChild(q)->Hidden) || ((Utils->HideULines) && (ServerInstance->ULine(Current->GetChild(q)->GetName().c_str()))))
71 ShowLinks(Current->GetChild(q),user,hops+1);
76 ShowLinks(Current->GetChild(q),user,hops+1);
79 /* Don't display the line if its a uline, hide ulines is on, and the user isnt an oper */
80 if ((Utils->HideULines) && (ServerInstance->ULine(Current->GetName().c_str())) && (!IS_OPER(user)))
82 /* Or if the server is hidden and they're not an oper */
83 else if ((Current->Hidden) && (!IS_OPER(user)))
86 user->WriteServ("364 %s %s %s :%d %s", user->nick,Current->GetName().c_str(),
87 (Utils->FlatLinks && (!IS_OPER(user))) ? ServerInstance->Config->ServerName : Parent.c_str(),
88 (Utils->FlatLinks && (!IS_OPER(user))) ? 0 : hops,
89 Current->GetDesc().c_str());
92 int ModuleSpanningTree::CountLocalServs()
94 return Utils->TreeRoot->ChildCount();
97 int ModuleSpanningTree::CountServs()
99 return Utils->serverlist.size();
102 void ModuleSpanningTree::HandleLinks(const char** parameters, int pcnt, userrec* user)
104 ShowLinks(Utils->TreeRoot,user,0);
105 user->WriteServ("365 %s * :End of /LINKS list.",user->nick);
109 void ModuleSpanningTree::HandleLusers(const char** parameters, int pcnt, userrec* user)
111 unsigned int n_users = ServerInstance->UserCount();
113 /* Only update these when someone wants to see them, more efficient */
114 if ((unsigned int)ServerInstance->LocalUserCount() > max_local)
115 max_local = ServerInstance->LocalUserCount();
116 if (n_users > max_global)
117 max_global = n_users;
119 unsigned int ulined_count = 0;
120 unsigned int ulined_local_count = 0;
122 /* If ulined are hidden and we're not an oper, count the number of ulined servers hidden,
123 * locally and globally (locally means directly connected to us)
125 if ((Utils->HideULines) && (!*user->oper))
127 for (server_hash::iterator q = Utils->serverlist.begin(); q != Utils->serverlist.end(); q++)
129 if (ServerInstance->ULine(q->second->GetName().c_str()))
132 if (q->second->GetParent() == Utils->TreeRoot)
133 ulined_local_count++;
137 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());
138 if (ServerInstance->OperCount())
139 user->WriteServ("252 %s %d :operator(s) online",user->nick,ServerInstance->OperCount());
140 if (ServerInstance->UnregisteredUserCount())
141 user->WriteServ("253 %s %d :unknown connections",user->nick,ServerInstance->UnregisteredUserCount());
142 if (ServerInstance->ChannelCount())
143 user->WriteServ("254 %s %d :channels formed",user->nick,ServerInstance->ChannelCount());
144 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());
145 user->WriteServ("265 %s :Current Local Users: %d Max: %d",user->nick,ServerInstance->LocalUserCount(),max_local);
146 user->WriteServ("266 %s :Current Global Users: %d Max: %d",user->nick,n_users,max_global);
150 std::string ModuleSpanningTree::TimeToStr(time_t secs)
152 time_t mins_up = secs / 60;
153 time_t hours_up = mins_up / 60;
154 time_t days_up = hours_up / 24;
156 mins_up = mins_up % 60;
157 hours_up = hours_up % 24;
158 return ((days_up ? (ConvToStr(days_up) + "d") : std::string(""))
159 + (hours_up ? (ConvToStr(hours_up) + "h") : std::string(""))
160 + (mins_up ? (ConvToStr(mins_up) + "m") : std::string(""))
161 + ConvToStr(secs) + "s");
164 const std::string ModuleSpanningTree::MapOperInfo(TreeServer* Current)
166 time_t secs_up = ServerInstance->Time() - Current->age;
167 return (" [Up: " + TimeToStr(secs_up) + " Lag: "+ConvToStr(Current->rtt)+"s]");
170 // WARNING: NOT THREAD SAFE - DONT GET ANY SMART IDEAS.
171 void ModuleSpanningTree::ShowMap(TreeServer* Current, userrec* user, int depth, char matrix[128][128], float &totusers, float &totservers)
175 for (int t = 0; t < depth; t++)
177 matrix[line][t] = ' ';
179 // For Aligning, we need to work out exactly how deep this thing is, and produce
180 // a 'Spacer' String to compensate.
182 memset(spacer,' ',40);
183 if ((40 - Current->GetName().length() - depth) > 1) {
184 spacer[40 - Current->GetName().length() - depth] = '\0';
192 /* Neat and tidy default values, as we're dealing with a matrix not a simple string */
193 memset(text, 0, 128);
195 if (ServerInstance->clientlist->size() == 0) {
196 // If there are no users, WHO THE HELL DID THE /MAP?!?!?!
201 percent = ((float)Current->GetUserCount() / (float)ServerInstance->clientlist->size()) * 100;
203 const std::string operdata = IS_OPER(user) ? MapOperInfo(Current) : "";
204 snprintf(text, 126, "%s %s%5d [%5.2f%%]%s", Current->GetName().c_str(), spacer, Current->GetUserCount(), percent, operdata.c_str());
205 totusers += Current->GetUserCount();
207 strlcpy(&matrix[line][depth],text,126);
209 for (unsigned int q = 0; q < Current->ChildCount(); q++)
211 if ((Current->GetChild(q)->Hidden) || ((Utils->HideULines) && (ServerInstance->ULine(Current->GetChild(q)->GetName().c_str()))))
215 ShowMap(Current->GetChild(q),user,(Utils->FlatLinks && (!*user->oper)) ? depth : depth+2,matrix,totusers,totservers);
220 ShowMap(Current->GetChild(q),user,(Utils->FlatLinks && (!*user->oper)) ? depth : depth+2,matrix,totusers,totservers);
226 int ModuleSpanningTree::HandleMotd(const char** parameters, int pcnt, userrec* user)
230 if (match(ServerInstance->Config->ServerName, parameters[0]))
233 /* Remote MOTD, the server is within the 1st parameter */
234 std::deque<std::string> params;
235 params.push_back(parameters[0]);
236 /* Send it out remotely, generate no reply yet */
237 TreeServer* s = Utils->FindServerMask(parameters[0]);
239 Utils->DoOneToOne(user->nick, "MOTD", params, s->GetName());
241 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
247 int ModuleSpanningTree::HandleAdmin(const char** parameters, int pcnt, userrec* user)
251 if (match(ServerInstance->Config->ServerName, parameters[0]))
254 /* Remote ADMIN, the server is within the 1st parameter */
255 std::deque<std::string> params;
256 params.push_back(parameters[0]);
257 /* Send it out remotely, generate no reply yet */
258 TreeServer* s = Utils->FindServerMask(parameters[0]);
260 Utils->DoOneToOne(user->nick, "ADMIN", params, s->GetName());
262 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
268 int ModuleSpanningTree::HandleModules(const char** parameters, int pcnt, userrec* user)
270 if (match(ServerInstance->Config->ServerName, parameters[0]))
273 std::deque<std::string> params;
274 params.push_back(parameters[0]);
275 TreeServer* s = Utils->FindServerMask(parameters[0]);
277 Utils->DoOneToOne(user->nick, "MODULES", params, s->GetName());
279 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
283 int ModuleSpanningTree::HandleStats(const char** parameters, int pcnt, userrec* user)
287 if (match(ServerInstance->Config->ServerName, parameters[1]))
290 /* Remote STATS, the server is within the 2nd parameter */
291 std::deque<std::string> params;
292 params.push_back(parameters[0]);
293 params.push_back(parameters[1]);
294 /* Send it out remotely, generate no reply yet */
296 TreeServer* s = Utils->FindServerMask(parameters[1]);
299 params[1] = s->GetName();
300 Utils->DoOneToOne(user->nick, "STATS", params, s->GetName());
304 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[1]);
311 // Ok, prepare to be confused.
312 // After much mulling over how to approach this, it struck me that
313 // the 'usual' way of doing a /MAP isnt the best way. Instead of
314 // keeping track of a ton of ascii characters, and line by line
315 // under recursion working out where to place them using multiplications
316 // and divisons, we instead render the map onto a backplane of characters
317 // (a character matrix), then draw the branches as a series of "L" shapes
318 // from the nodes. This is not only friendlier on CPU it uses less stack.
319 void ModuleSpanningTree::HandleMap(const char** parameters, int pcnt, userrec* user)
321 // This array represents a virtual screen which we will
322 // "scratch" draw to, as the console device of an irc
323 // client does not provide for a proper terminal.
325 float totservers = 0;
326 char matrix[128][128];
327 for (unsigned int t = 0; t < 128; t++)
332 // The only recursive bit is called here.
333 ShowMap(Utils->TreeRoot,user,0,matrix,totusers,totservers);
334 // Process each line one by one. The algorithm has a limit of
335 // 128 servers (which is far more than a spanning tree should have
336 // anyway, so we're ok). This limit can be raised simply by making
337 // the character matrix deeper, 128 rows taking 10k of memory.
338 for (int l = 1; l < line; l++)
340 // scan across the line looking for the start of the
341 // servername (the recursive part of the algorithm has placed
342 // the servers at indented positions depending on what they
344 int first_nonspace = 0;
345 while (matrix[l][first_nonspace] == ' ')
350 // Draw the `- (corner) section: this may be overwritten by
351 // another L shape passing along the same vertical pane, becoming
352 // a |- (branch) section instead.
353 matrix[l][first_nonspace] = '-';
354 matrix[l][first_nonspace-1] = '`';
356 // Draw upwards until we hit the parent server, causing possibly
357 // other corners (`-) to become branches (|-)
358 while ((matrix[l2][first_nonspace-1] == ' ') || (matrix[l2][first_nonspace-1] == '`'))
360 matrix[l2][first_nonspace-1] = '|';
364 // dump the whole lot to the user. This is the easy bit, honest.
365 for (int t = 0; t < line; t++)
367 user->WriteServ("006 %s :%s",user->nick,&matrix[t][0]);
369 float avg_users = totusers / totservers;
370 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);
371 user->WriteServ("007 %s :End of /MAP",user->nick);
375 int ModuleSpanningTree::HandleSquit(const char** parameters, int pcnt, userrec* user)
377 TreeServer* s = Utils->FindServerMask(parameters[0]);
380 if (s == Utils->TreeRoot)
382 user->WriteServ("NOTICE %s :*** SQUIT: Foolish mortal, you cannot make a server SQUIT itself! (%s matches local server name)",user->nick,parameters[0]);
385 TreeSocket* sock = s->GetSocket();
388 ServerInstance->SNO->WriteToSnoMask('l',"SQUIT: Server \002%s\002 removed from network by %s",parameters[0],user->nick);
389 sock->Squit(s,std::string("Server quit by ") + user->GetFullRealHost());
390 ServerInstance->SE->DelFd(sock);
397 std::deque<std::string> params;
398 params.push_back(parameters[0]);
399 params.push_back(std::string(":Server quit by ") + user->GetFullRealHost());
400 Utils->DoOneToOne(user->nick, "RSQUIT", params, parameters[0]);
405 user->WriteServ("NOTICE %s :*** SQUIT: The server \002%s\002 does not exist on the network.",user->nick,parameters[0]);
410 int ModuleSpanningTree::HandleTime(const char** parameters, int pcnt, userrec* user)
412 if ((IS_LOCAL(user)) && (pcnt))
414 TreeServer* found = Utils->FindServerMask(parameters[0]);
417 // we dont' override for local server
418 if (found == Utils->TreeRoot)
421 std::deque<std::string> params;
422 params.push_back(found->GetName());
423 params.push_back(user->nick);
424 Utils->DoOneToOne(ServerInstance->Config->ServerName,"TIME",params,found->GetName());
428 user->WriteServ("402 %s %s :No such server",user->nick,parameters[0]);
434 int ModuleSpanningTree::HandleRemoteWhois(const char** parameters, int pcnt, userrec* user)
436 if ((IS_LOCAL(user)) && (pcnt > 1))
438 userrec* remote = ServerInstance->FindNick(parameters[1]);
439 if ((remote) && (remote->GetFd() < 0))
441 std::deque<std::string> params;
442 params.push_back(parameters[1]);
443 Utils->DoOneToOne(user->nick,"IDLE",params,remote->server);
448 user->WriteServ("401 %s %s :No such nick/channel",user->nick, parameters[1]);
449 user->WriteServ("318 %s %s :End of /WHOIS list.",user->nick, parameters[1]);
456 void ModuleSpanningTree::DoPingChecks(time_t curtime)
458 for (unsigned int j = 0; j < Utils->TreeRoot->ChildCount(); j++)
460 TreeServer* serv = Utils->TreeRoot->GetChild(j);
461 TreeSocket* sock = serv->GetSocket();
464 if (curtime >= serv->NextPingTime())
466 if (serv->AnsweredLastPing())
468 sock->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" PING "+serv->GetName());
469 serv->SetNextPingTime(curtime + 60);
470 serv->LastPing = curtime;
471 serv->Warned = false;
475 /* they didnt answer, boot them */
476 sock->SendError("Ping timeout");
477 sock->Squit(serv,"Ping timeout");
478 ServerInstance->SE->DelFd(sock);
484 else if ((Utils->PingWarnTime) && (!serv->Warned) && (curtime >= serv->NextPingTime() - (60 - Utils->PingWarnTime)) && (!serv->AnsweredLastPing()))
486 /* The server hasnt responded, send a warning to opers */
487 ServerInstance->SNO->WriteToSnoMask('l',"Server \002%s\002 has not responded to PING for %d seconds, high latency.", serv->GetName().c_str(), Utils->PingWarnTime);
493 /* Cancel remote burst mode on any servers which still have it enabled due to latency/lack of data.
494 * This prevents lost REMOTECONNECT notices
496 for (server_hash::iterator i = Utils->serverlist.begin(); i != Utils->serverlist.end(); i++)
497 Utils->SetRemoteBursting(i->second, false);
500 void ModuleSpanningTree::ConnectServer(Link* x)
503 QueryType start_type = DNS_QUERY_A;
505 start_type = DNS_QUERY_AAAA;
506 if (strchr(x->IPAddr.c_str(),':'))
509 if (inet_pton(AF_INET6, x->IPAddr.c_str(), &n) < 1)
515 if (inet_aton(x->IPAddr.c_str(),&n) < 1)
520 if (inet_aton(x->IPAddr.c_str(),&n) < 1)
524 /* Do we already have an IP? If so, no need to resolve it. */
527 /* Gave a hook, but it wasnt one we know */
528 if ((!x->Hook.empty()) && (Utils->hooks.find(x->Hook.c_str()) == Utils->hooks.end()))
530 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()]);
531 if (newsocket->GetFd() > -1)
533 /* Handled automatically on success */
537 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(),strerror(errno));
539 Utils->DoFailOver(x);
547 ServernameResolver* snr = new ServernameResolver((Module*)this, Utils, ServerInstance,x->IPAddr, *x, cached, start_type);
548 ServerInstance->AddResolver(snr, cached);
550 catch (ModuleException& e)
552 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason());
553 Utils->DoFailOver(x);
558 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
560 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
562 if ((x->AutoConnect) && (curtime >= x->NextConnectTime))
564 x->NextConnectTime = curtime + x->AutoConnect;
565 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
566 if (x->FailOver.length())
568 TreeServer* CheckFailOver = Utils->FindServer(x->FailOver.c_str());
571 /* The failover for this server is currently a member of the network.
572 * The failover probably succeeded, where the main link did not.
573 * Don't try the main link until the failover is gone again.
580 // an autoconnected server is not connected. Check if its time to connect it
581 ServerInstance->SNO->WriteToSnoMask('l',"AUTOCONNECT: Auto-connecting server \002%s\002 (%lu seconds until next attempt)",x->Name.c_str(),x->AutoConnect);
582 this->ConnectServer(&(*x));
588 int ModuleSpanningTree::HandleVersion(const char** parameters, int pcnt, userrec* user)
590 // we've already checked if pcnt > 0, so this is safe
591 TreeServer* found = Utils->FindServerMask(parameters[0]);
594 std::string Version = found->GetVersion();
595 user->WriteServ("351 %s :%s",user->nick,Version.c_str());
596 if (found == Utils->TreeRoot)
598 ServerInstance->Config->Send005(user);
603 user->WriteServ("402 %s %s :No such server",user->nick,parameters[0]);
608 int ModuleSpanningTree::HandleConnect(const char** parameters, int pcnt, userrec* user)
610 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
612 if (ServerInstance->MatchText(x->Name.c_str(),parameters[0]))
614 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
617 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);
618 ConnectServer(&(*x));
623 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());
628 user->WriteServ("NOTICE %s :*** CONNECT: No server matching \002%s\002 could be found in the config file.",user->nick,parameters[0]);
632 void ModuleSpanningTree::BroadcastTimeSync()
634 if (Utils->MasterTime)
636 std::deque<std::string> params;
637 params.push_back(ConvToStr(ServerInstance->Time(false)));
638 params.push_back("FORCE");
639 Utils->DoOneToMany(Utils->TreeRoot->GetName(), "TIMESET", params);
643 int ModuleSpanningTree::OnStats(char statschar, userrec* user, string_list &results)
645 if ((statschar == 'c') || (statschar == 'n'))
647 for (unsigned int i = 0; i < Utils->LinkBlocks.size(); i++)
649 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');
650 if (statschar == 'c')
651 results.push_back(std::string(ServerInstance->Config->ServerName)+" 244 "+user->nick+" H * * "+Utils->LinkBlocks[i].Name.c_str());
653 results.push_back(std::string(ServerInstance->Config->ServerName)+" 219 "+user->nick+" "+statschar+" :End of /STATS report");
654 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);
660 int ModuleSpanningTree::OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line)
662 /* If the command doesnt appear to be valid, we dont want to mess with it. */
666 if (command == "CONNECT")
668 return this->HandleConnect(parameters,pcnt,user);
670 else if (command == "STATS")
672 return this->HandleStats(parameters,pcnt,user);
674 else if (command == "MOTD")
676 return this->HandleMotd(parameters,pcnt,user);
678 else if (command == "ADMIN")
680 return this->HandleAdmin(parameters,pcnt,user);
682 else if (command == "SQUIT")
684 return this->HandleSquit(parameters,pcnt,user);
686 else if (command == "MAP")
688 this->HandleMap(parameters,pcnt,user);
691 else if ((command == "TIME") && (pcnt > 0))
693 return this->HandleTime(parameters,pcnt,user);
695 else if (command == "LUSERS")
697 this->HandleLusers(parameters,pcnt,user);
700 else if (command == "LINKS")
702 this->HandleLinks(parameters,pcnt,user);
705 else if (command == "WHOIS")
710 return this->HandleRemoteWhois(parameters,pcnt,user);
713 else if ((command == "VERSION") && (pcnt > 0))
715 this->HandleVersion(parameters,pcnt,user);
718 else if ((command == "MODULES") && (pcnt > 0))
720 return this->HandleModules(parameters,pcnt,user);
725 void ModuleSpanningTree::OnPostCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, CmdResult result, const std::string &original_line)
727 if ((result == CMD_SUCCESS) && (ServerInstance->IsValidModuleCommand(command, pcnt, user)))
729 // this bit of code cleverly routes all module commands
730 // to all remote severs *automatically* so that modules
731 // can just handle commands locally, without having
732 // to have any special provision in place for remote
733 // commands and linking protocols.
734 std::deque<std::string> params;
736 for (int j = 0; j < pcnt; j++)
738 if (strchr(parameters[j],' '))
740 params.push_back(":" + std::string(parameters[j]));
744 params.push_back(std::string(parameters[j]));
747 Utils->DoOneToMany(user->nick,command,params);
751 void ModuleSpanningTree::OnGetServerDescription(const std::string &servername,std::string &description)
753 TreeServer* s = Utils->FindServer(servername);
756 description = s->GetDesc();
760 void ModuleSpanningTree::OnUserInvite(userrec* source,userrec* dest,chanrec* channel)
762 if (IS_LOCAL(source))
764 std::deque<std::string> params;
765 params.push_back(dest->nick);
766 params.push_back(channel->name);
767 Utils->DoOneToMany(source->nick,"INVITE",params);
771 void ModuleSpanningTree::OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic)
773 std::deque<std::string> params;
774 params.push_back(chan->name);
775 params.push_back(":"+topic);
776 Utils->DoOneToMany(user->nick,"TOPIC",params);
779 void ModuleSpanningTree::OnWallops(userrec* user, const std::string &text)
783 std::deque<std::string> params;
784 params.push_back(":"+text);
785 Utils->DoOneToMany(user->nick,"WALLOPS",params);
789 void ModuleSpanningTree::OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
791 if (target_type == TYPE_USER)
793 userrec* d = (userrec*)dest;
794 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
796 std::deque<std::string> params;
798 params.push_back(d->nick);
799 params.push_back(":"+text);
800 Utils->DoOneToOne(user->nick,"NOTICE",params,d->server);
803 else if (target_type == TYPE_CHANNEL)
807 chanrec *c = (chanrec*)dest;
810 std::string cname = c->name;
812 cname = status + cname;
814 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
815 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
817 TreeSocket* Sock = i->second->GetSocket();
819 Sock->WriteLine(":"+std::string(user->nick)+" NOTICE "+cname+" :"+text);
824 else if (target_type == TYPE_SERVER)
828 char* target = (char*)dest;
829 std::deque<std::string> par;
830 par.push_back(target);
831 par.push_back(":"+text);
832 Utils->DoOneToMany(user->nick,"NOTICE",par);
837 void ModuleSpanningTree::OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
839 if (target_type == TYPE_USER)
841 // route private messages which are targetted at clients only to the server
842 // which needs to receive them
843 userrec* d = (userrec*)dest;
844 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
846 std::deque<std::string> params;
848 params.push_back(d->nick);
849 params.push_back(":"+text);
850 Utils->DoOneToOne(user->nick,"PRIVMSG",params,d->server);
853 else if (target_type == TYPE_CHANNEL)
857 chanrec *c = (chanrec*)dest;
860 std::string cname = c->name;
862 cname = status + cname;
864 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
865 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
867 TreeSocket* Sock = i->second->GetSocket();
869 Sock->WriteLine(":"+std::string(user->nick)+" PRIVMSG "+cname+" :"+text);
874 else if (target_type == TYPE_SERVER)
878 char* target = (char*)dest;
879 std::deque<std::string> par;
880 par.push_back(target);
881 par.push_back(":"+text);
882 Utils->DoOneToMany(user->nick,"PRIVMSG",par);
887 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
889 AutoConnectServers(curtime);
890 DoPingChecks(curtime);
893 void ModuleSpanningTree::OnUserJoin(userrec* user, chanrec* channel, bool &silent)
895 // Only do this for local users
898 if (channel->GetUserCounter() == 1)
900 std::deque<std::string> params;
901 // set up their permissions and the channel TS with FJOIN.
902 // All users are FJOINed now, because a module may specify
903 // new joining permissions for the user.
904 params.push_back(channel->name);
905 params.push_back(ConvToStr(channel->age));
906 params.push_back(std::string(channel->GetAllPrefixChars(user))+","+std::string(user->nick));
907 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FJOIN",params);
908 /* First user in, sync the modes for the channel */
910 /* This is safe, all inspircd servers default to +nt */
911 params.push_back("+nt");
912 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FMODE",params);
916 std::deque<std::string> params;
917 params.push_back(channel->name);
918 params.push_back(ConvToStr(channel->age));
919 Utils->DoOneToMany(user->nick,"JOIN",params);
924 void ModuleSpanningTree::OnChangeHost(userrec* user, const std::string &newhost)
926 // only occurs for local clients
927 if (user->registered != REG_ALL)
929 std::deque<std::string> params;
930 params.push_back(newhost);
931 Utils->DoOneToMany(user->nick,"FHOST",params);
934 void ModuleSpanningTree::OnChangeName(userrec* user, const std::string &gecos)
936 // only occurs for local clients
937 if (user->registered != REG_ALL)
939 std::deque<std::string> params;
940 params.push_back(gecos);
941 Utils->DoOneToMany(user->nick,"FNAME",params);
944 void ModuleSpanningTree::OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage, bool &silent)
948 std::deque<std::string> params;
949 params.push_back(channel->name);
950 if (partmessage != "")
951 params.push_back(":"+partmessage);
952 Utils->DoOneToMany(user->nick,"PART",params);
956 void ModuleSpanningTree::OnUserConnect(userrec* user)
961 std::deque<std::string> params;
962 snprintf(agestr,MAXBUF,"%lu",(unsigned long)user->age);
963 params.push_back(agestr);
964 params.push_back(user->nick);
965 params.push_back(user->host);
966 params.push_back(user->dhost);
967 params.push_back(user->ident);
968 params.push_back("+"+std::string(user->FormatModes()));
969 params.push_back(user->GetIPString());
970 params.push_back(":"+std::string(user->fullname));
971 Utils->DoOneToMany(ServerInstance->Config->ServerName,"NICK",params);
972 // User is Local, change needs to be reflected!
973 TreeServer* SourceServer = Utils->FindServer(user->server);
976 SourceServer->AddUserCount();
981 void ModuleSpanningTree::OnUserQuit(userrec* user, const std::string &reason, const std::string &oper_message)
983 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
985 std::deque<std::string> params;
987 if (oper_message != reason)
989 params.push_back(":"+oper_message);
990 Utils->DoOneToMany(user->nick,"OPERQUIT",params);
993 params.push_back(":"+reason);
994 Utils->DoOneToMany(user->nick,"QUIT",params);
996 // Regardless, We need to modify the user Counts..
997 TreeServer* SourceServer = Utils->FindServer(user->server);
1000 SourceServer->DelUserCount();
1004 void ModuleSpanningTree::OnUserPostNick(userrec* user, const std::string &oldnick)
1008 std::deque<std::string> params;
1009 params.push_back(user->nick);
1010 Utils->DoOneToMany(oldnick,"NICK",params);
1014 void ModuleSpanningTree::OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason, bool &silent)
1016 if ((source) && (IS_LOCAL(source)))
1018 std::deque<std::string> params;
1019 params.push_back(chan->name);
1020 params.push_back(user->nick);
1021 params.push_back(":"+reason);
1022 Utils->DoOneToMany(source->nick,"KICK",params);
1026 std::deque<std::string> params;
1027 params.push_back(chan->name);
1028 params.push_back(user->nick);
1029 params.push_back(":"+reason);
1030 Utils->DoOneToMany(ServerInstance->Config->ServerName,"KICK",params);
1034 void ModuleSpanningTree::OnRemoteKill(userrec* source, userrec* dest, const std::string &reason)
1036 std::deque<std::string> params;
1037 params.push_back(dest->nick);
1038 params.push_back(":"+reason);
1039 Utils->DoOneToMany(source->nick,"KILL",params);
1042 void ModuleSpanningTree::OnRehash(userrec* user, const std::string ¶meter)
1044 if (parameter != "")
1046 std::deque<std::string> params;
1047 params.push_back(parameter);
1048 Utils->DoOneToMany(user ? user->nick : ServerInstance->Config->ServerName, "REHASH", params);
1050 if (ServerInstance->MatchText(ServerInstance->Config->ServerName,parameter))
1052 ServerInstance->WriteOpers("*** Remote rehash initiated locally by \002%s\002", user ? user->nick : ServerInstance->Config->ServerName);
1053 ServerInstance->RehashServer();
1056 Utils->ReadConfiguration(false);
1057 InitializeDisabledCommands(ServerInstance->Config->DisabledCommands, ServerInstance);
1060 // note: the protocol does not allow direct umode +o except
1061 // via NICK with 8 params. sending OPERTYPE infers +o modechange
1063 void ModuleSpanningTree::OnOper(userrec* user, const std::string &opertype)
1067 std::deque<std::string> params;
1068 params.push_back(opertype);
1069 Utils->DoOneToMany(user->nick,"OPERTYPE",params);
1073 void ModuleSpanningTree::OnLine(userrec* source, const std::string &host, bool adding, char linetype, long duration, const std::string &reason)
1077 /* Server-set lines */
1079 snprintf(data,MAXBUF,"%c %s %s %lu %lu :%s", linetype, host.c_str(), ServerInstance->Config->ServerName, (unsigned long)ServerInstance->Time(false),
1080 (unsigned long)duration, reason.c_str());
1081 std::deque<std::string> params;
1082 params.push_back(data);
1083 Utils->DoOneToMany(ServerInstance->Config->ServerName, "ADDLINE", params);
1087 if (IS_LOCAL(source))
1090 snprintf(type,8,"%cLINE",linetype);
1091 std::string stype = type;
1094 char sduration[MAXBUF];
1095 snprintf(sduration,MAXBUF,"%ld",duration);
1096 std::deque<std::string> params;
1097 params.push_back(host);
1098 params.push_back(sduration);
1099 params.push_back(":"+reason);
1100 Utils->DoOneToMany(source->nick,stype,params);
1104 std::deque<std::string> params;
1105 params.push_back(host);
1106 Utils->DoOneToMany(source->nick,stype,params);
1112 void ModuleSpanningTree::OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask)
1114 OnLine(source,hostmask,true,'G',duration,reason);
1117 void ModuleSpanningTree::OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask)
1119 OnLine(source,ipmask,true,'Z',duration,reason);
1122 void ModuleSpanningTree::OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask)
1124 OnLine(source,nickmask,true,'Q',duration,reason);
1127 void ModuleSpanningTree::OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask)
1129 OnLine(source,hostmask,true,'E',duration,reason);
1132 void ModuleSpanningTree::OnDelGLine(userrec* source, const std::string &hostmask)
1134 OnLine(source,hostmask,false,'G',0,"");
1137 void ModuleSpanningTree::OnDelZLine(userrec* source, const std::string &ipmask)
1139 OnLine(source,ipmask,false,'Z',0,"");
1142 void ModuleSpanningTree::OnDelQLine(userrec* source, const std::string &nickmask)
1144 OnLine(source,nickmask,false,'Q',0,"");
1147 void ModuleSpanningTree::OnDelELine(userrec* source, const std::string &hostmask)
1149 OnLine(source,hostmask,false,'E',0,"");
1152 void ModuleSpanningTree::OnMode(userrec* user, void* dest, int target_type, const std::string &text)
1154 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
1156 std::deque<std::string> params;
1157 std::string command;
1159 if (target_type == TYPE_USER)
1161 userrec* u = (userrec*)dest;
1162 params.push_back(u->nick);
1163 params.push_back(text);
1168 chanrec* c = (chanrec*)dest;
1169 params.push_back(c->name);
1170 params.push_back(ConvToStr(c->age));
1171 params.push_back(text);
1174 Utils->DoOneToMany(user->nick, command, params);
1178 void ModuleSpanningTree::OnSetAway(userrec* user)
1182 std::deque<std::string> params;
1183 params.push_back(":"+std::string(user->awaymsg));
1184 Utils->DoOneToMany(user->nick,"AWAY",params);
1188 void ModuleSpanningTree::OnCancelAway(userrec* user)
1192 std::deque<std::string> params;
1194 Utils->DoOneToMany(user->nick,"AWAY",params);
1198 void ModuleSpanningTree::ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline)
1200 TreeSocket* s = (TreeSocket*)opaque;
1203 if (target_type == TYPE_USER)
1205 userrec* u = (userrec*)target;
1206 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" FMODE "+u->nick+" "+ConvToStr(u->age)+" "+modeline);
1210 chanrec* c = (chanrec*)target;
1211 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" FMODE "+c->name+" "+ConvToStr(c->age)+" "+modeline);
1216 void ModuleSpanningTree::ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata)
1218 TreeSocket* s = (TreeSocket*)opaque;
1221 if (target_type == TYPE_USER)
1223 userrec* u = (userrec*)target;
1224 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA "+u->nick+" "+extname+" :"+extdata);
1226 else if (target_type == TYPE_CHANNEL)
1228 chanrec* c = (chanrec*)target;
1229 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA "+c->name+" "+extname+" :"+extdata);
1232 if (target_type == TYPE_OTHER)
1234 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA * "+extname+" :"+extdata);
1238 void ModuleSpanningTree::OnEvent(Event* event)
1240 std::deque<std::string>* params = (std::deque<std::string>*)event->GetData();
1241 if (event->GetEventID() == "send_metadata")
1243 if (params->size() < 3)
1245 (*params)[2] = ":" + (*params)[2];
1246 Utils->DoOneToMany(ServerInstance->Config->ServerName,"METADATA",*params);
1248 else if (event->GetEventID() == "send_topic")
1250 if (params->size() < 2)
1252 (*params)[1] = ":" + (*params)[1];
1253 params->insert(params->begin() + 1,ServerInstance->Config->ServerName);
1254 params->insert(params->begin() + 1,ConvToStr(ServerInstance->Time(true)));
1255 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FTOPIC",*params);
1257 else if (event->GetEventID() == "send_mode")
1259 if (params->size() < 2)
1261 // Insert the TS value of the object, either userrec or chanrec
1263 userrec* a = ServerInstance->FindNick((*params)[0]);
1267 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODE",*params);
1272 chanrec* a = ServerInstance->FindChan((*params)[0]);
1276 params->insert(params->begin() + 1,ConvToStr(ourTS));
1277 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FMODE",*params);
1281 else if (event->GetEventID() == "send_mode_explicit")
1283 if (params->size() < 2)
1285 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODE",*params);
1287 else if (event->GetEventID() == "send_opers")
1289 if (params->size() < 1)
1291 (*params)[0] = ":" + (*params)[0];
1292 Utils->DoOneToMany(ServerInstance->Config->ServerName,"OPERNOTICE",*params);
1294 else if (event->GetEventID() == "send_modeset")
1296 if (params->size() < 2)
1298 (*params)[1] = ":" + (*params)[1];
1299 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODENOTICE",*params);
1301 else if (event->GetEventID() == "send_snoset")
1303 if (params->size() < 2)
1305 (*params)[1] = ":" + (*params)[1];
1306 Utils->DoOneToMany(ServerInstance->Config->ServerName,"SNONOTICE",*params);
1308 else if (event->GetEventID() == "send_push")
1310 if (params->size() < 2)
1313 userrec *a = ServerInstance->FindNick((*params)[0]);
1318 (*params)[1] = ":" + (*params)[1];
1319 Utils->DoOneToOne(ServerInstance->Config->ServerName, "PUSH", *params, a->server);
1323 ModuleSpanningTree::~ModuleSpanningTree()
1325 /* This will also free the listeners */
1328 ServerInstance->Timers->DelTimer(SyncTimer);
1330 ServerInstance->Timers->DelTimer(RefreshTimer);
1332 ServerInstance->DoneWithInterface("InspSocketHook");
1335 Version ModuleSpanningTree::GetVersion()
1337 return Version(1,1,0,2,VF_VENDOR,API_VERSION);
1340 void ModuleSpanningTree::Implements(char* List)
1342 List[I_OnPreCommand] = List[I_OnGetServerDescription] = List[I_OnUserInvite] = List[I_OnPostLocalTopicChange] = 1;
1343 List[I_OnWallops] = List[I_OnUserNotice] = List[I_OnUserMessage] = List[I_OnBackgroundTimer] = 1;
1344 List[I_OnUserJoin] = List[I_OnChangeHost] = List[I_OnChangeName] = List[I_OnUserPart] = List[I_OnUserConnect] = 1;
1345 List[I_OnUserQuit] = List[I_OnUserPostNick] = List[I_OnUserKick] = List[I_OnRemoteKill] = List[I_OnRehash] = 1;
1346 List[I_OnOper] = List[I_OnAddGLine] = List[I_OnAddZLine] = List[I_OnAddQLine] = List[I_OnAddELine] = 1;
1347 List[I_OnDelGLine] = List[I_OnDelZLine] = List[I_OnDelQLine] = List[I_OnDelELine] = List[I_ProtoSendMode] = List[I_OnMode] = 1;
1348 List[I_OnStats] = List[I_ProtoSendMetaData] = List[I_OnEvent] = List[I_OnSetAway] = List[I_OnCancelAway] = List[I_OnPostCommand] = 1;
1351 /* It is IMPORTANT that m_spanningtree is the last module in the chain
1352 * so that any activity it sees is FINAL, e.g. we arent going to send out
1353 * a NICK message before m_cloaking has finished putting the +x on the user,
1355 * Therefore, we return PRIORITY_LAST to make sure we end up at the END of
1356 * the module call queue.
1358 Priority ModuleSpanningTree::Prioritize()
1360 return PRIORITY_LAST;
1363 class ModuleSpanningTreeFactory : public ModuleFactory
1366 ModuleSpanningTreeFactory()
1370 ~ModuleSpanningTreeFactory()
1374 virtual Module * CreateModule(InspIRCd* Me)
1376 return new ModuleSpanningTree(Me);
1382 extern "C" DllExport void * init_module( void )
1384 return new ModuleSpanningTreeFactory;