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::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 const std::string ModuleSpanningTree::MapOperInfo(TreeServer* Current)
152 time_t secs_up = ServerInstance->Time() - Current->age;
153 time_t mins_up = secs_up / 60;
154 time_t hours_up = mins_up / 60;
155 time_t days_up = hours_up / 24;
156 secs_up = secs_up % 60;
157 mins_up = mins_up % 60;
158 hours_up = hours_up % 24;
159 return (" [Up: "+ (days_up ? (ConvToStr(days_up) + "d") : std::string(""))
160 + (hours_up ? (ConvToStr(hours_up) + "h") : std::string(""))
161 + (mins_up ? (ConvToStr(mins_up) + "m") : std::string(""))
162 + ConvToStr(secs_up) + "s Lag: "+ConvToStr(Current->rtt)+"s]");
165 // WARNING: NOT THREAD SAFE - DONT GET ANY SMART IDEAS.
166 void ModuleSpanningTree::ShowMap(TreeServer* Current, userrec* user, int depth, char matrix[128][80], float &totusers, float &totservers)
170 for (int t = 0; t < depth; t++)
172 matrix[line][t] = ' ';
174 // For Aligning, we need to work out exactly how deep this thing is, and produce
175 // a 'Spacer' String to compensate.
177 memset(spacer,' ',40);
178 if ((40 - Current->GetName().length() - depth) > 1) {
179 spacer[40 - Current->GetName().length() - depth] = '\0';
187 if (ServerInstance->clientlist->size() == 0) {
188 // If there are no users, WHO THE HELL DID THE /MAP?!?!?!
193 percent = ((float)Current->GetUserCount() / (float)ServerInstance->clientlist->size()) * 100;
195 const std::string operdata = IS_OPER(user) ? MapOperInfo(Current) : "";
196 snprintf(text, 80, "%s %s%5d [%5.2f%%]%s", Current->GetName().c_str(), spacer, Current->GetUserCount(), percent, operdata.c_str());
197 totusers += Current->GetUserCount();
199 strlcpy(&matrix[line][depth],text,80);
201 for (unsigned int q = 0; q < Current->ChildCount(); q++)
203 if ((Current->GetChild(q)->Hidden) || ((Utils->HideULines) && (ServerInstance->ULine(Current->GetChild(q)->GetName().c_str()))))
207 ShowMap(Current->GetChild(q),user,(Utils->FlatLinks && (!*user->oper)) ? depth : depth+2,matrix,totusers,totservers);
212 ShowMap(Current->GetChild(q),user,(Utils->FlatLinks && (!*user->oper)) ? depth : depth+2,matrix,totusers,totservers);
218 int ModuleSpanningTree::HandleMotd(const char** parameters, int pcnt, userrec* user)
222 if (match(ServerInstance->Config->ServerName, parameters[0]))
225 /* Remote MOTD, the server is within the 1st parameter */
226 std::deque<std::string> params;
227 params.push_back(parameters[0]);
228 /* Send it out remotely, generate no reply yet */
229 TreeServer* s = Utils->FindServerMask(parameters[0]);
231 Utils->DoOneToOne(user->nick, "MOTD", params, s->GetName());
233 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
239 int ModuleSpanningTree::HandleAdmin(const char** parameters, int pcnt, userrec* user)
243 if (match(ServerInstance->Config->ServerName, parameters[0]))
246 /* Remote ADMIN, the server is within the 1st parameter */
247 std::deque<std::string> params;
248 params.push_back(parameters[0]);
249 /* Send it out remotely, generate no reply yet */
250 TreeServer* s = Utils->FindServerMask(parameters[0]);
252 Utils->DoOneToOne(user->nick, "ADMIN", params, s->GetName());
254 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
260 int ModuleSpanningTree::HandleModules(const char** parameters, int pcnt, userrec* user)
262 if (match(ServerInstance->Config->ServerName, parameters[0]))
265 std::deque<std::string> params;
266 params.push_back(parameters[0]);
267 TreeServer* s = Utils->FindServerMask(parameters[0]);
269 Utils->DoOneToOne(user->nick, "MODULES", params, s->GetName());
271 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
275 int ModuleSpanningTree::HandleStats(const char** parameters, int pcnt, userrec* user)
279 if (match(ServerInstance->Config->ServerName, parameters[1]))
282 /* Remote STATS, the server is within the 2nd parameter */
283 std::deque<std::string> params;
284 params.push_back(parameters[0]);
285 params.push_back(parameters[1]);
286 /* Send it out remotely, generate no reply yet */
288 TreeServer* s = Utils->FindServerMask(parameters[1]);
291 params[1] = s->GetName();
292 Utils->DoOneToOne(user->nick, "STATS", params, s->GetName());
296 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[1]);
303 // Ok, prepare to be confused.
304 // After much mulling over how to approach this, it struck me that
305 // the 'usual' way of doing a /MAP isnt the best way. Instead of
306 // keeping track of a ton of ascii characters, and line by line
307 // under recursion working out where to place them using multiplications
308 // and divisons, we instead render the map onto a backplane of characters
309 // (a character matrix), then draw the branches as a series of "L" shapes
310 // from the nodes. This is not only friendlier on CPU it uses less stack.
311 void ModuleSpanningTree::HandleMap(const char** parameters, int pcnt, userrec* user)
313 // This array represents a virtual screen which we will
314 // "scratch" draw to, as the console device of an irc
315 // client does not provide for a proper terminal.
317 float totservers = 0;
318 char matrix[128][80];
319 for (unsigned int t = 0; t < 128; t++)
324 // The only recursive bit is called here.
325 ShowMap(Utils->TreeRoot,user,0,matrix,totusers,totservers);
326 // Process each line one by one. The algorithm has a limit of
327 // 128 servers (which is far more than a spanning tree should have
328 // anyway, so we're ok). This limit can be raised simply by making
329 // the character matrix deeper, 128 rows taking 10k of memory.
330 for (int l = 1; l < line; l++)
332 // scan across the line looking for the start of the
333 // servername (the recursive part of the algorithm has placed
334 // the servers at indented positions depending on what they
336 int first_nonspace = 0;
337 while (matrix[l][first_nonspace] == ' ')
342 // Draw the `- (corner) section: this may be overwritten by
343 // another L shape passing along the same vertical pane, becoming
344 // a |- (branch) section instead.
345 matrix[l][first_nonspace] = '-';
346 matrix[l][first_nonspace-1] = '`';
348 // Draw upwards until we hit the parent server, causing possibly
349 // other corners (`-) to become branches (|-)
350 while ((matrix[l2][first_nonspace-1] == ' ') || (matrix[l2][first_nonspace-1] == '`'))
352 matrix[l2][first_nonspace-1] = '|';
356 // dump the whole lot to the user. This is the easy bit, honest.
357 for (int t = 0; t < line; t++)
359 user->WriteServ("006 %s :%s",user->nick,&matrix[t][0]);
361 float avg_users = totusers / totservers;
362 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);
363 user->WriteServ("007 %s :End of /MAP",user->nick);
367 int ModuleSpanningTree::HandleSquit(const char** parameters, int pcnt, userrec* user)
369 TreeServer* s = Utils->FindServerMask(parameters[0]);
372 if (s == Utils->TreeRoot)
374 user->WriteServ("NOTICE %s :*** SQUIT: Foolish mortal, you cannot make a server SQUIT itself! (%s matches local server name)",user->nick,parameters[0]);
377 TreeSocket* sock = s->GetSocket();
380 ServerInstance->SNO->WriteToSnoMask('l',"SQUIT: Server \002%s\002 removed from network by %s",parameters[0],user->nick);
381 sock->Squit(s,std::string("Server quit by ") + user->GetFullRealHost());
382 ServerInstance->SE->DelFd(sock);
389 std::deque<std::string> params;
390 params.push_back(parameters[0]);
391 params.push_back(std::string(":Server quit by ") + user->GetFullRealHost());
392 Utils->DoOneToOne(user->nick, "RSQUIT", params, parameters[0]);
397 user->WriteServ("NOTICE %s :*** SQUIT: The server \002%s\002 does not exist on the network.",user->nick,parameters[0]);
402 int ModuleSpanningTree::HandleTime(const char** parameters, int pcnt, userrec* user)
404 if ((IS_LOCAL(user)) && (pcnt))
406 TreeServer* found = Utils->FindServerMask(parameters[0]);
409 // we dont' override for local server
410 if (found == Utils->TreeRoot)
413 std::deque<std::string> params;
414 params.push_back(found->GetName());
415 params.push_back(user->nick);
416 Utils->DoOneToOne(ServerInstance->Config->ServerName,"TIME",params,found->GetName());
420 user->WriteServ("402 %s %s :No such server",user->nick,parameters[0]);
426 int ModuleSpanningTree::HandleRemoteWhois(const char** parameters, int pcnt, userrec* user)
428 if ((IS_LOCAL(user)) && (pcnt > 1))
430 userrec* remote = ServerInstance->FindNick(parameters[1]);
431 if ((remote) && (remote->GetFd() < 0))
433 std::deque<std::string> params;
434 params.push_back(parameters[1]);
435 Utils->DoOneToOne(user->nick,"IDLE",params,remote->server);
440 user->WriteServ("401 %s %s :No such nick/channel",user->nick, parameters[1]);
441 user->WriteServ("318 %s %s :End of /WHOIS list.",user->nick, parameters[1]);
448 void ModuleSpanningTree::DoPingChecks(time_t curtime)
450 for (unsigned int j = 0; j < Utils->TreeRoot->ChildCount(); j++)
452 TreeServer* serv = Utils->TreeRoot->GetChild(j);
453 TreeSocket* sock = serv->GetSocket();
456 if (curtime >= serv->NextPingTime())
458 if (serv->AnsweredLastPing())
460 sock->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" PING "+serv->GetName());
461 serv->SetNextPingTime(curtime + 60);
462 serv->LastPing = curtime;
466 // they didnt answer, boot them
467 ServerInstance->SNO->WriteToSnoMask('l',"Server \002%s\002 pinged out",serv->GetName().c_str());
468 sock->Squit(serv,"Ping timeout");
469 ServerInstance->SE->DelFd(sock);
479 void ModuleSpanningTree::ConnectServer(Link* x)
482 QueryType start_type = DNS_QUERY_A;
484 start_type = DNS_QUERY_AAAA;
485 if (strchr(x->IPAddr.c_str(),':'))
488 if (inet_pton(AF_INET6, x->IPAddr.c_str(), &n) < 1)
494 if (inet_aton(x->IPAddr.c_str(),&n) < 1)
499 if (inet_aton(x->IPAddr.c_str(),&n) < 1)
503 /* Do we already have an IP? If so, no need to resolve it. */
506 /* Gave a hook, but it wasnt one we know */
507 if ((!x->Hook.empty()) && (Utils->hooks.find(x->Hook.c_str()) == Utils->hooks.end()))
509 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()]);
510 if (newsocket->GetFd() > -1)
512 /* Handled automatically on success */
516 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(),strerror(errno));
518 Utils->DoFailOver(x);
526 ServernameResolver* snr = new ServernameResolver((Module*)this, Utils, ServerInstance,x->IPAddr, *x, cached, start_type);
527 ServerInstance->AddResolver(snr, cached);
529 catch (ModuleException& e)
531 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason());
532 Utils->DoFailOver(x);
537 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
539 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
541 if ((x->AutoConnect) && (curtime >= x->NextConnectTime))
543 x->NextConnectTime = curtime + x->AutoConnect;
544 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
545 if (x->FailOver.length())
547 TreeServer* CheckFailOver = Utils->FindServer(x->FailOver.c_str());
550 /* The failover for this server is currently a member of the network.
551 * The failover probably succeeded, where the main link did not.
552 * Don't try the main link until the failover is gone again.
559 // an autoconnected server is not connected. Check if its time to connect it
560 ServerInstance->SNO->WriteToSnoMask('l',"AUTOCONNECT: Auto-connecting server \002%s\002 (%lu seconds until next attempt)",x->Name.c_str(),x->AutoConnect);
561 this->ConnectServer(&(*x));
567 int ModuleSpanningTree::HandleVersion(const char** parameters, int pcnt, userrec* user)
569 // we've already checked if pcnt > 0, so this is safe
570 TreeServer* found = Utils->FindServerMask(parameters[0]);
573 std::string Version = found->GetVersion();
574 user->WriteServ("351 %s :%s",user->nick,Version.c_str());
575 if (found == Utils->TreeRoot)
577 ServerInstance->Config->Send005(user);
582 user->WriteServ("402 %s %s :No such server",user->nick,parameters[0]);
587 int ModuleSpanningTree::HandleConnect(const char** parameters, int pcnt, userrec* user)
589 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
591 if (ServerInstance->MatchText(x->Name.c_str(),parameters[0]))
593 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
596 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);
597 ConnectServer(&(*x));
602 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());
607 user->WriteServ("NOTICE %s :*** CONNECT: No server matching \002%s\002 could be found in the config file.",user->nick,parameters[0]);
611 void ModuleSpanningTree::BroadcastTimeSync()
613 if (Utils->MasterTime)
615 std::deque<std::string> params;
616 params.push_back(ConvToStr(ServerInstance->Time(false)));
617 params.push_back("FORCE");
618 Utils->DoOneToMany(Utils->TreeRoot->GetName(), "TIMESET", params);
622 int ModuleSpanningTree::OnStats(char statschar, userrec* user, string_list &results)
624 if ((statschar == 'c') || (statschar == 'n'))
626 for (unsigned int i = 0; i < Utils->LinkBlocks.size(); i++)
628 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');
629 if (statschar == 'c')
630 results.push_back(std::string(ServerInstance->Config->ServerName)+" 244 "+user->nick+" H * * "+Utils->LinkBlocks[i].Name.c_str());
632 results.push_back(std::string(ServerInstance->Config->ServerName)+" 219 "+user->nick+" "+statschar+" :End of /STATS report");
633 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);
639 int ModuleSpanningTree::OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line)
641 /* If the command doesnt appear to be valid, we dont want to mess with it. */
645 if (command == "CONNECT")
647 return this->HandleConnect(parameters,pcnt,user);
649 else if (command == "STATS")
651 return this->HandleStats(parameters,pcnt,user);
653 else if (command == "MOTD")
655 return this->HandleMotd(parameters,pcnt,user);
657 else if (command == "ADMIN")
659 return this->HandleAdmin(parameters,pcnt,user);
661 else if (command == "SQUIT")
663 return this->HandleSquit(parameters,pcnt,user);
665 else if (command == "MAP")
667 this->HandleMap(parameters,pcnt,user);
670 else if ((command == "TIME") && (pcnt > 0))
672 return this->HandleTime(parameters,pcnt,user);
674 else if (command == "LUSERS")
676 this->HandleLusers(parameters,pcnt,user);
679 else if (command == "LINKS")
681 this->HandleLinks(parameters,pcnt,user);
684 else if (command == "WHOIS")
689 return this->HandleRemoteWhois(parameters,pcnt,user);
692 else if ((command == "VERSION") && (pcnt > 0))
694 this->HandleVersion(parameters,pcnt,user);
697 else if ((command == "MODULES") && (pcnt > 0))
699 return this->HandleModules(parameters,pcnt,user);
704 void ModuleSpanningTree::OnPostCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, CmdResult result, const std::string &original_line)
706 if ((result == CMD_SUCCESS) && (ServerInstance->IsValidModuleCommand(command, pcnt, user)))
708 // this bit of code cleverly routes all module commands
709 // to all remote severs *automatically* so that modules
710 // can just handle commands locally, without having
711 // to have any special provision in place for remote
712 // commands and linking protocols.
713 std::deque<std::string> params;
715 for (int j = 0; j < pcnt; j++)
717 if (strchr(parameters[j],' '))
719 params.push_back(":" + std::string(parameters[j]));
723 params.push_back(std::string(parameters[j]));
726 Utils->DoOneToMany(user->nick,command,params);
730 void ModuleSpanningTree::OnGetServerDescription(const std::string &servername,std::string &description)
732 TreeServer* s = Utils->FindServer(servername);
735 description = s->GetDesc();
739 void ModuleSpanningTree::OnUserInvite(userrec* source,userrec* dest,chanrec* channel)
741 if (IS_LOCAL(source))
743 std::deque<std::string> params;
744 params.push_back(dest->nick);
745 params.push_back(channel->name);
746 Utils->DoOneToMany(source->nick,"INVITE",params);
750 void ModuleSpanningTree::OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic)
752 std::deque<std::string> params;
753 params.push_back(chan->name);
754 params.push_back(":"+topic);
755 Utils->DoOneToMany(user->nick,"TOPIC",params);
758 void ModuleSpanningTree::OnWallops(userrec* user, const std::string &text)
762 std::deque<std::string> params;
763 params.push_back(":"+text);
764 Utils->DoOneToMany(user->nick,"WALLOPS",params);
768 void ModuleSpanningTree::OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
770 if (target_type == TYPE_USER)
772 userrec* d = (userrec*)dest;
773 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
775 std::deque<std::string> params;
777 params.push_back(d->nick);
778 params.push_back(":"+text);
779 Utils->DoOneToOne(user->nick,"NOTICE",params,d->server);
782 else if (target_type == TYPE_CHANNEL)
786 chanrec *c = (chanrec*)dest;
789 std::string cname = c->name;
791 cname = status + cname;
793 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
794 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
796 TreeSocket* Sock = i->second->GetSocket();
798 Sock->WriteLine(":"+std::string(user->nick)+" NOTICE "+cname+" :"+text);
803 else if (target_type == TYPE_SERVER)
807 char* target = (char*)dest;
808 std::deque<std::string> par;
809 par.push_back(target);
810 par.push_back(":"+text);
811 Utils->DoOneToMany(user->nick,"NOTICE",par);
816 void ModuleSpanningTree::OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
818 if (target_type == TYPE_USER)
820 // route private messages which are targetted at clients only to the server
821 // which needs to receive them
822 userrec* d = (userrec*)dest;
823 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
825 std::deque<std::string> params;
827 params.push_back(d->nick);
828 params.push_back(":"+text);
829 Utils->DoOneToOne(user->nick,"PRIVMSG",params,d->server);
832 else if (target_type == TYPE_CHANNEL)
836 chanrec *c = (chanrec*)dest;
839 std::string cname = c->name;
841 cname = status + cname;
843 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
844 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
846 TreeSocket* Sock = i->second->GetSocket();
848 Sock->WriteLine(":"+std::string(user->nick)+" PRIVMSG "+cname+" :"+text);
853 else if (target_type == TYPE_SERVER)
857 char* target = (char*)dest;
858 std::deque<std::string> par;
859 par.push_back(target);
860 par.push_back(":"+text);
861 Utils->DoOneToMany(user->nick,"PRIVMSG",par);
866 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
868 AutoConnectServers(curtime);
869 DoPingChecks(curtime);
872 void ModuleSpanningTree::OnUserJoin(userrec* user, chanrec* channel)
874 // Only do this for local users
877 if (channel->GetUserCounter() == 1)
879 std::deque<std::string> params;
880 // set up their permissions and the channel TS with FJOIN.
881 // All users are FJOINed now, because a module may specify
882 // new joining permissions for the user.
883 params.push_back(channel->name);
884 params.push_back(ConvToStr(channel->age));
885 params.push_back(std::string(channel->GetAllPrefixChars(user))+","+std::string(user->nick));
886 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FJOIN",params);
887 /* First user in, sync the modes for the channel */
889 /* This is safe, all inspircd servers default to +nt */
890 params.push_back("+nt");
891 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FMODE",params);
895 std::deque<std::string> params;
896 params.push_back(channel->name);
897 params.push_back(ConvToStr(channel->age));
898 Utils->DoOneToMany(user->nick,"JOIN",params);
903 void ModuleSpanningTree::OnChangeHost(userrec* user, const std::string &newhost)
905 // only occurs for local clients
906 if (user->registered != REG_ALL)
908 std::deque<std::string> params;
909 params.push_back(newhost);
910 Utils->DoOneToMany(user->nick,"FHOST",params);
913 void ModuleSpanningTree::OnChangeName(userrec* user, const std::string &gecos)
915 // only occurs for local clients
916 if (user->registered != REG_ALL)
918 std::deque<std::string> params;
919 params.push_back(gecos);
920 Utils->DoOneToMany(user->nick,"FNAME",params);
923 void ModuleSpanningTree::OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage)
927 std::deque<std::string> params;
928 params.push_back(channel->name);
929 if (partmessage != "")
930 params.push_back(":"+partmessage);
931 Utils->DoOneToMany(user->nick,"PART",params);
935 void ModuleSpanningTree::OnUserConnect(userrec* user)
940 std::deque<std::string> params;
941 snprintf(agestr,MAXBUF,"%lu",(unsigned long)user->age);
942 params.push_back(agestr);
943 params.push_back(user->nick);
944 params.push_back(user->host);
945 params.push_back(user->dhost);
946 params.push_back(user->ident);
947 params.push_back("+"+std::string(user->FormatModes()));
948 params.push_back(user->GetIPString());
949 params.push_back(":"+std::string(user->fullname));
950 Utils->DoOneToMany(ServerInstance->Config->ServerName,"NICK",params);
951 // User is Local, change needs to be reflected!
952 TreeServer* SourceServer = Utils->FindServer(user->server);
955 SourceServer->AddUserCount();
960 void ModuleSpanningTree::OnUserQuit(userrec* user, const std::string &reason, const std::string &oper_message)
962 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
964 std::deque<std::string> params;
966 if (oper_message != reason)
968 params.push_back(":"+oper_message);
969 Utils->DoOneToMany(user->nick,"OPERQUIT",params);
972 params.push_back(":"+reason);
973 Utils->DoOneToMany(user->nick,"QUIT",params);
975 // Regardless, We need to modify the user Counts..
976 TreeServer* SourceServer = Utils->FindServer(user->server);
979 SourceServer->DelUserCount();
983 void ModuleSpanningTree::OnUserPostNick(userrec* user, const std::string &oldnick)
987 std::deque<std::string> params;
988 params.push_back(user->nick);
989 Utils->DoOneToMany(oldnick,"NICK",params);
993 void ModuleSpanningTree::OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason)
995 if ((source) && (IS_LOCAL(source)))
997 std::deque<std::string> params;
998 params.push_back(chan->name);
999 params.push_back(user->nick);
1000 params.push_back(":"+reason);
1001 Utils->DoOneToMany(source->nick,"KICK",params);
1005 std::deque<std::string> params;
1006 params.push_back(chan->name);
1007 params.push_back(user->nick);
1008 params.push_back(":"+reason);
1009 Utils->DoOneToMany(ServerInstance->Config->ServerName,"KICK",params);
1013 void ModuleSpanningTree::OnRemoteKill(userrec* source, userrec* dest, const std::string &reason)
1015 std::deque<std::string> params;
1016 params.push_back(dest->nick);
1017 params.push_back(":"+reason);
1018 Utils->DoOneToMany(source->nick,"KILL",params);
1021 void ModuleSpanningTree::OnRehash(userrec* user, const std::string ¶meter)
1023 if (parameter != "")
1025 std::deque<std::string> params;
1026 params.push_back(parameter);
1027 Utils->DoOneToMany(user ? user->nick : ServerInstance->Config->ServerName, "REHASH", params);
1029 if (ServerInstance->MatchText(ServerInstance->Config->ServerName,parameter))
1031 ServerInstance->WriteOpers("*** Remote rehash initiated locally by \002%s\002", user ? user->nick : ServerInstance->Config->ServerName);
1032 ServerInstance->RehashServer();
1035 Utils->ReadConfiguration(false);
1036 InitializeDisabledCommands(ServerInstance->Config->DisabledCommands, ServerInstance);
1039 // note: the protocol does not allow direct umode +o except
1040 // via NICK with 8 params. sending OPERTYPE infers +o modechange
1042 void ModuleSpanningTree::OnOper(userrec* user, const std::string &opertype)
1046 std::deque<std::string> params;
1047 params.push_back(opertype);
1048 Utils->DoOneToMany(user->nick,"OPERTYPE",params);
1052 void ModuleSpanningTree::OnLine(userrec* source, const std::string &host, bool adding, char linetype, long duration, const std::string &reason)
1056 /* Server-set lines */
1058 snprintf(data,MAXBUF,"%c %s %s %lu %lu :%s", linetype, host.c_str(), ServerInstance->Config->ServerName, (unsigned long)ServerInstance->Time(false),
1059 (unsigned long)duration, reason.c_str());
1060 std::deque<std::string> params;
1061 params.push_back(data);
1062 Utils->DoOneToMany(ServerInstance->Config->ServerName, "ADDLINE", params);
1066 if (IS_LOCAL(source))
1069 snprintf(type,8,"%cLINE",linetype);
1070 std::string stype = type;
1073 char sduration[MAXBUF];
1074 snprintf(sduration,MAXBUF,"%ld",duration);
1075 std::deque<std::string> params;
1076 params.push_back(host);
1077 params.push_back(sduration);
1078 params.push_back(":"+reason);
1079 Utils->DoOneToMany(source->nick,stype,params);
1083 std::deque<std::string> params;
1084 params.push_back(host);
1085 Utils->DoOneToMany(source->nick,stype,params);
1091 void ModuleSpanningTree::OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask)
1093 OnLine(source,hostmask,true,'G',duration,reason);
1096 void ModuleSpanningTree::OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask)
1098 OnLine(source,ipmask,true,'Z',duration,reason);
1101 void ModuleSpanningTree::OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask)
1103 OnLine(source,nickmask,true,'Q',duration,reason);
1106 void ModuleSpanningTree::OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask)
1108 OnLine(source,hostmask,true,'E',duration,reason);
1111 void ModuleSpanningTree::OnDelGLine(userrec* source, const std::string &hostmask)
1113 OnLine(source,hostmask,false,'G',0,"");
1116 void ModuleSpanningTree::OnDelZLine(userrec* source, const std::string &ipmask)
1118 OnLine(source,ipmask,false,'Z',0,"");
1121 void ModuleSpanningTree::OnDelQLine(userrec* source, const std::string &nickmask)
1123 OnLine(source,nickmask,false,'Q',0,"");
1126 void ModuleSpanningTree::OnDelELine(userrec* source, const std::string &hostmask)
1128 OnLine(source,hostmask,false,'E',0,"");
1131 void ModuleSpanningTree::OnMode(userrec* user, void* dest, int target_type, const std::string &text)
1133 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
1135 std::deque<std::string> params;
1136 std::string command;
1138 if (target_type == TYPE_USER)
1140 userrec* u = (userrec*)dest;
1141 params.push_back(u->nick);
1142 params.push_back(text);
1147 chanrec* c = (chanrec*)dest;
1148 params.push_back(c->name);
1149 params.push_back(ConvToStr(c->age));
1150 params.push_back(text);
1153 Utils->DoOneToMany(user->nick, command, params);
1157 void ModuleSpanningTree::OnSetAway(userrec* user)
1161 std::deque<std::string> params;
1162 params.push_back(":"+std::string(user->awaymsg));
1163 Utils->DoOneToMany(user->nick,"AWAY",params);
1167 void ModuleSpanningTree::OnCancelAway(userrec* user)
1171 std::deque<std::string> params;
1173 Utils->DoOneToMany(user->nick,"AWAY",params);
1177 void ModuleSpanningTree::ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline)
1179 TreeSocket* s = (TreeSocket*)opaque;
1182 if (target_type == TYPE_USER)
1184 userrec* u = (userrec*)target;
1185 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" FMODE "+u->nick+" "+ConvToStr(u->age)+" "+modeline);
1189 chanrec* c = (chanrec*)target;
1190 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" FMODE "+c->name+" "+ConvToStr(c->age)+" "+modeline);
1195 void ModuleSpanningTree::ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata)
1197 TreeSocket* s = (TreeSocket*)opaque;
1200 if (target_type == TYPE_USER)
1202 userrec* u = (userrec*)target;
1203 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA "+u->nick+" "+extname+" :"+extdata);
1205 else if (target_type == TYPE_CHANNEL)
1207 chanrec* c = (chanrec*)target;
1208 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA "+c->name+" "+extname+" :"+extdata);
1211 if (target_type == TYPE_OTHER)
1213 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA * "+extname+" :"+extdata);
1217 void ModuleSpanningTree::OnEvent(Event* event)
1219 std::deque<std::string>* params = (std::deque<std::string>*)event->GetData();
1220 if (event->GetEventID() == "send_metadata")
1222 if (params->size() < 3)
1224 (*params)[2] = ":" + (*params)[2];
1225 Utils->DoOneToMany(ServerInstance->Config->ServerName,"METADATA",*params);
1227 else if (event->GetEventID() == "send_topic")
1229 if (params->size() < 2)
1231 (*params)[1] = ":" + (*params)[1];
1232 params->insert(params->begin() + 1,ServerInstance->Config->ServerName);
1233 params->insert(params->begin() + 1,ConvToStr(ServerInstance->Time(true)));
1234 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FTOPIC",*params);
1236 else if (event->GetEventID() == "send_mode")
1238 if (params->size() < 2)
1240 // Insert the TS value of the object, either userrec or chanrec
1242 userrec* a = ServerInstance->FindNick((*params)[0]);
1249 chanrec* a = ServerInstance->FindChan((*params)[0]);
1255 params->insert(params->begin() + 1,ConvToStr(ourTS));
1256 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FMODE",*params);
1258 else if (event->GetEventID() == "send_mode_explicit")
1260 if (params->size() < 2)
1262 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODE",*params);
1264 else if (event->GetEventID() == "send_opers")
1266 if (params->size() < 1)
1268 (*params)[0] = ":" + (*params)[0];
1269 Utils->DoOneToMany(ServerInstance->Config->ServerName,"OPERNOTICE",*params);
1271 else if (event->GetEventID() == "send_modeset")
1273 if (params->size() < 2)
1275 (*params)[1] = ":" + (*params)[1];
1276 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODENOTICE",*params);
1278 else if (event->GetEventID() == "send_snoset")
1280 if (params->size() < 2)
1282 (*params)[1] = ":" + (*params)[1];
1283 Utils->DoOneToMany(ServerInstance->Config->ServerName,"SNONOTICE",*params);
1285 else if (event->GetEventID() == "send_push")
1287 if (params->size() < 2)
1290 userrec *a = ServerInstance->FindNick((*params)[0]);
1295 (*params)[1] = ":" + (*params)[1];
1296 Utils->DoOneToOne(ServerInstance->Config->ServerName, "PUSH", *params, a->server);
1300 ModuleSpanningTree::~ModuleSpanningTree()
1302 /* This will also free the listeners */
1305 ServerInstance->Timers->DelTimer(SyncTimer);
1307 ServerInstance->Timers->DelTimer(RefreshTimer);
1309 ServerInstance->DoneWithInterface("InspSocketHook");
1312 Version ModuleSpanningTree::GetVersion()
1314 return Version(1,1,0,2,VF_VENDOR,API_VERSION);
1317 void ModuleSpanningTree::Implements(char* List)
1319 List[I_OnPreCommand] = List[I_OnGetServerDescription] = List[I_OnUserInvite] = List[I_OnPostLocalTopicChange] = 1;
1320 List[I_OnWallops] = List[I_OnUserNotice] = List[I_OnUserMessage] = List[I_OnBackgroundTimer] = 1;
1321 List[I_OnUserJoin] = List[I_OnChangeHost] = List[I_OnChangeName] = List[I_OnUserPart] = List[I_OnUserConnect] = 1;
1322 List[I_OnUserQuit] = List[I_OnUserPostNick] = List[I_OnUserKick] = List[I_OnRemoteKill] = List[I_OnRehash] = 1;
1323 List[I_OnOper] = List[I_OnAddGLine] = List[I_OnAddZLine] = List[I_OnAddQLine] = List[I_OnAddELine] = 1;
1324 List[I_OnDelGLine] = List[I_OnDelZLine] = List[I_OnDelQLine] = List[I_OnDelELine] = List[I_ProtoSendMode] = List[I_OnMode] = 1;
1325 List[I_OnStats] = List[I_ProtoSendMetaData] = List[I_OnEvent] = List[I_OnSetAway] = List[I_OnCancelAway] = List[I_OnPostCommand] = 1;
1328 /* It is IMPORTANT that m_spanningtree is the last module in the chain
1329 * so that any activity it sees is FINAL, e.g. we arent going to send out
1330 * a NICK message before m_cloaking has finished putting the +x on the user,
1332 * Therefore, we return PRIORITY_LAST to make sure we end up at the END of
1333 * the module call queue.
1335 Priority ModuleSpanningTree::Prioritize()
1337 return PRIORITY_LAST;
1340 class ModuleSpanningTreeFactory : public ModuleFactory
1343 ModuleSpanningTreeFactory()
1347 ~ModuleSpanningTreeFactory()
1351 virtual Module * CreateModule(InspIRCd* Me)
1353 return new ModuleSpanningTree(Me);
1359 extern "C" void * init_module( void )
1361 return new ModuleSpanningTreeFactory;