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);
55 void ModuleSpanningTree::ShowLinks(TreeServer* Current, userrec* user, int hops)
57 std::string Parent = Utils->TreeRoot->GetName();
58 if (Current->GetParent())
60 Parent = Current->GetParent()->GetName();
62 for (unsigned int q = 0; q < Current->ChildCount(); q++)
64 if ((Utils->HideULines) && (ServerInstance->ULine(Current->GetChild(q)->GetName().c_str())))
68 ShowLinks(Current->GetChild(q),user,hops+1);
73 ShowLinks(Current->GetChild(q),user,hops+1);
76 /* Don't display the line if its a uline, hide ulines is on, and the user isnt an oper */
77 if ((Utils->HideULines) && (ServerInstance->ULine(Current->GetName().c_str())) && (!*user->oper))
79 user->WriteServ("364 %s %s %s :%d %s",user->nick,Current->GetName().c_str(),(Utils->FlatLinks && (!*user->oper)) ? ServerInstance->Config->ServerName : Parent.c_str(),(Utils->FlatLinks && (!*user->oper)) ? 0 : hops,Current->GetDesc().c_str());
82 int ModuleSpanningTree::CountLocalServs()
84 return Utils->TreeRoot->ChildCount();
87 int ModuleSpanningTree::CountServs()
89 return Utils->serverlist.size();
92 void ModuleSpanningTree::HandleLinks(const char** parameters, int pcnt, userrec* user)
94 ShowLinks(Utils->TreeRoot,user,0);
95 user->WriteServ("365 %s * :End of /LINKS list.",user->nick);
99 void ModuleSpanningTree::HandleLusers(const char** parameters, int pcnt, userrec* user)
101 unsigned int n_users = ServerInstance->UserCount();
103 /* Only update these when someone wants to see them, more efficient */
104 if ((unsigned int)ServerInstance->LocalUserCount() > max_local)
105 max_local = ServerInstance->LocalUserCount();
106 if (n_users > max_global)
107 max_global = n_users;
109 unsigned int ulined_count = 0;
110 unsigned int ulined_local_count = 0;
112 /* If ulined are hidden and we're not an oper, count the number of ulined servers hidden,
113 * locally and globally (locally means directly connected to us)
115 if ((Utils->HideULines) && (!*user->oper))
117 for (server_hash::iterator q = Utils->serverlist.begin(); q != Utils->serverlist.end(); q++)
119 if (ServerInstance->ULine(q->second->GetName().c_str()))
122 if (q->second->GetParent() == Utils->TreeRoot)
123 ulined_local_count++;
127 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());
128 if (ServerInstance->OperCount())
129 user->WriteServ("252 %s %d :operator(s) online",user->nick,ServerInstance->OperCount());
130 if (ServerInstance->UnregisteredUserCount())
131 user->WriteServ("253 %s %d :unknown connections",user->nick,ServerInstance->UnregisteredUserCount());
132 if (ServerInstance->ChannelCount())
133 user->WriteServ("254 %s %d :channels formed",user->nick,ServerInstance->ChannelCount());
134 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());
135 user->WriteServ("265 %s :Current Local Users: %d Max: %d",user->nick,ServerInstance->LocalUserCount(),max_local);
136 user->WriteServ("266 %s :Current Global Users: %d Max: %d",user->nick,n_users,max_global);
140 // WARNING: NOT THREAD SAFE - DONT GET ANY SMART IDEAS.
141 void ModuleSpanningTree::ShowMap(TreeServer* Current, userrec* user, int depth, char matrix[128][80], float &totusers, float &totservers)
145 for (int t = 0; t < depth; t++)
147 matrix[line][t] = ' ';
149 // For Aligning, we need to work out exactly how deep this thing is, and produce
150 // a 'Spacer' String to compensate.
152 memset(spacer,' ',40);
153 if ((40 - Current->GetName().length() - depth) > 1) {
154 spacer[40 - Current->GetName().length() - depth] = '\0';
162 if (ServerInstance->clientlist->size() == 0) {
163 // If there are no users, WHO THE HELL DID THE /MAP?!?!?!
168 percent = ((float)Current->GetUserCount() / (float)ServerInstance->clientlist->size()) * 100;
170 snprintf(text, 80, "%s %s%5d [%5.2f%%]", Current->GetName().c_str(), spacer, Current->GetUserCount(), percent);
171 totusers += Current->GetUserCount();
173 strlcpy(&matrix[line][depth],text,80);
175 for (unsigned int q = 0; q < Current->ChildCount(); q++)
177 if ((Utils->HideULines) && (ServerInstance->ULine(Current->GetChild(q)->GetName().c_str())))
181 ShowMap(Current->GetChild(q),user,(Utils->FlatLinks && (!*user->oper)) ? depth : depth+2,matrix,totusers,totservers);
186 ShowMap(Current->GetChild(q),user,(Utils->FlatLinks && (!*user->oper)) ? depth : depth+2,matrix,totusers,totservers);
192 int ModuleSpanningTree::HandleMotd(const char** parameters, int pcnt, userrec* user)
196 if (match(ServerInstance->Config->ServerName, parameters[0]))
199 /* Remote MOTD, the server is within the 1st parameter */
200 std::deque<std::string> params;
201 params.push_back(parameters[0]);
202 /* Send it out remotely, generate no reply yet */
203 TreeServer* s = Utils->FindServerMask(parameters[0]);
205 Utils->DoOneToOne(user->nick, "MOTD", params, s->GetName());
207 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
213 int ModuleSpanningTree::HandleAdmin(const char** parameters, int pcnt, userrec* user)
217 if (match(ServerInstance->Config->ServerName, parameters[0]))
220 /* Remote ADMIN, the server is within the 1st parameter */
221 std::deque<std::string> params;
222 params.push_back(parameters[0]);
223 /* Send it out remotely, generate no reply yet */
224 TreeServer* s = Utils->FindServerMask(parameters[0]);
226 Utils->DoOneToOne(user->nick, "ADMIN", params, s->GetName());
228 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
234 int ModuleSpanningTree::HandleModules(const char** parameters, int pcnt, userrec* user)
236 if (match(ServerInstance->Config->ServerName, parameters[0]))
239 std::deque<std::string> params;
240 params.push_back(parameters[0]);
241 TreeServer* s = Utils->FindServerMask(parameters[0]);
243 Utils->DoOneToOne(user->nick, "MODULES", params, s->GetName());
245 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
249 int ModuleSpanningTree::HandleStats(const char** parameters, int pcnt, userrec* user)
253 if (match(ServerInstance->Config->ServerName, parameters[1]))
256 /* Remote STATS, the server is within the 2nd parameter */
257 std::deque<std::string> params;
258 params.push_back(parameters[0]);
259 params.push_back(parameters[1]);
260 /* Send it out remotely, generate no reply yet */
262 TreeServer* s = Utils->FindServerMask(parameters[1]);
265 params[1] = s->GetName();
266 Utils->DoOneToOne(user->nick, "STATS", params, s->GetName());
270 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[1]);
277 // Ok, prepare to be confused.
278 // After much mulling over how to approach this, it struck me that
279 // the 'usual' way of doing a /MAP isnt the best way. Instead of
280 // keeping track of a ton of ascii characters, and line by line
281 // under recursion working out where to place them using multiplications
282 // and divisons, we instead render the map onto a backplane of characters
283 // (a character matrix), then draw the branches as a series of "L" shapes
284 // from the nodes. This is not only friendlier on CPU it uses less stack.
285 void ModuleSpanningTree::HandleMap(const char** parameters, int pcnt, userrec* user)
287 // This array represents a virtual screen which we will
288 // "scratch" draw to, as the console device of an irc
289 // client does not provide for a proper terminal.
291 float totservers = 0;
292 char matrix[128][80];
293 for (unsigned int t = 0; t < 128; t++)
298 // The only recursive bit is called here.
299 ShowMap(Utils->TreeRoot,user,0,matrix,totusers,totservers);
300 // Process each line one by one. The algorithm has a limit of
301 // 128 servers (which is far more than a spanning tree should have
302 // anyway, so we're ok). This limit can be raised simply by making
303 // the character matrix deeper, 128 rows taking 10k of memory.
304 for (int l = 1; l < line; l++)
306 // scan across the line looking for the start of the
307 // servername (the recursive part of the algorithm has placed
308 // the servers at indented positions depending on what they
310 int first_nonspace = 0;
311 while (matrix[l][first_nonspace] == ' ')
316 // Draw the `- (corner) section: this may be overwritten by
317 // another L shape passing along the same vertical pane, becoming
318 // a |- (branch) section instead.
319 matrix[l][first_nonspace] = '-';
320 matrix[l][first_nonspace-1] = '`';
322 // Draw upwards until we hit the parent server, causing possibly
323 // other corners (`-) to become branches (|-)
324 while ((matrix[l2][first_nonspace-1] == ' ') || (matrix[l2][first_nonspace-1] == '`'))
326 matrix[l2][first_nonspace-1] = '|';
330 // dump the whole lot to the user. This is the easy bit, honest.
331 for (int t = 0; t < line; t++)
333 user->WriteServ("006 %s :%s",user->nick,&matrix[t][0]);
335 float avg_users = totusers / totservers;
336 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);
337 user->WriteServ("007 %s :End of /MAP",user->nick);
341 int ModuleSpanningTree::HandleSquit(const char** parameters, int pcnt, userrec* user)
343 TreeServer* s = Utils->FindServerMask(parameters[0]);
346 if (s == Utils->TreeRoot)
348 user->WriteServ("NOTICE %s :*** SQUIT: Foolish mortal, you cannot make a server SQUIT itself! (%s matches local server name)",user->nick,parameters[0]);
351 TreeSocket* sock = s->GetSocket();
354 ServerInstance->SNO->WriteToSnoMask('l',"SQUIT: Server \002%s\002 removed from network by %s",parameters[0],user->nick);
355 sock->Squit(s,std::string("Server quit by ") + user->GetFullRealHost());
356 ServerInstance->SE->DelFd(sock);
363 std::deque<std::string> params;
364 params.push_back(parameters[0]);
365 params.push_back(std::string(":Server quit by ") + user->GetFullRealHost());
366 Utils->DoOneToOne(user->nick, "RSQUIT", params, parameters[0]);
371 user->WriteServ("NOTICE %s :*** SQUIT: The server \002%s\002 does not exist on the network.",user->nick,parameters[0]);
376 int ModuleSpanningTree::HandleTime(const char** parameters, int pcnt, userrec* user)
378 if ((IS_LOCAL(user)) && (pcnt))
380 TreeServer* found = Utils->FindServerMask(parameters[0]);
383 // we dont' override for local server
384 if (found == Utils->TreeRoot)
387 std::deque<std::string> params;
388 params.push_back(found->GetName());
389 params.push_back(user->nick);
390 Utils->DoOneToOne(ServerInstance->Config->ServerName,"TIME",params,found->GetName());
394 user->WriteServ("402 %s %s :No such server",user->nick,parameters[0]);
400 int ModuleSpanningTree::HandleRemoteWhois(const char** parameters, int pcnt, userrec* user)
402 if ((IS_LOCAL(user)) && (pcnt > 1))
404 userrec* remote = ServerInstance->FindNick(parameters[1]);
405 if ((remote) && (remote->GetFd() < 0))
407 std::deque<std::string> params;
408 params.push_back(parameters[1]);
409 Utils->DoOneToOne(user->nick,"IDLE",params,remote->server);
414 user->WriteServ("401 %s %s :No such nick/channel",user->nick, parameters[1]);
415 user->WriteServ("318 %s %s :End of /WHOIS list.",user->nick, parameters[1]);
422 void ModuleSpanningTree::DoPingChecks(time_t curtime)
424 for (unsigned int j = 0; j < Utils->TreeRoot->ChildCount(); j++)
426 TreeServer* serv = Utils->TreeRoot->GetChild(j);
427 TreeSocket* sock = serv->GetSocket();
430 if (curtime >= serv->NextPingTime())
432 if (serv->AnsweredLastPing())
434 sock->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" PING "+serv->GetName());
435 serv->SetNextPingTime(curtime + 60);
439 // they didnt answer, boot them
440 ServerInstance->SNO->WriteToSnoMask('l',"Server \002%s\002 pinged out",serv->GetName().c_str());
441 sock->Squit(serv,"Ping timeout");
442 ServerInstance->SE->DelFd(sock);
452 void ModuleSpanningTree::ConnectServer(Link* x)
455 QueryType start_type = DNS_QUERY_A;
457 start_type = DNS_QUERY_AAAA;
458 if (strchr(x->IPAddr.c_str(),':'))
461 if (inet_pton(AF_INET6, x->IPAddr.c_str(), &n) < 1)
467 if (inet_aton(x->IPAddr.c_str(),&n) < 1)
472 if (inet_aton(x->IPAddr.c_str(),&n) < 1)
476 /* Do we already have an IP? If so, no need to resolve it. */
479 /* Gave a hook, but it wasnt one we know */
480 if ((!x->Hook.empty()) && (Utils->hooks.find(x->Hook.c_str()) == Utils->hooks.end()))
482 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()]);
483 if (newsocket->GetFd() > -1)
485 /* Handled automatically on success */
489 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(),strerror(errno));
491 Utils->DoFailOver(x);
499 ServernameResolver* snr = new ServernameResolver((Module*)this, Utils, ServerInstance,x->IPAddr, *x, cached, start_type);
500 ServerInstance->AddResolver(snr, cached);
502 catch (ModuleException& e)
504 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason());
505 Utils->DoFailOver(x);
510 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
512 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
514 if ((x->AutoConnect) && (curtime >= x->NextConnectTime))
516 x->NextConnectTime = curtime + x->AutoConnect;
517 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
518 if (x->FailOver.length())
520 TreeServer* CheckFailOver = Utils->FindServer(x->FailOver.c_str());
523 /* The failover for this server is currently a member of the network.
524 * The failover probably succeeded, where the main link did not.
525 * Don't try the main link until the failover is gone again.
532 // an autoconnected server is not connected. Check if its time to connect it
533 ServerInstance->SNO->WriteToSnoMask('l',"AUTOCONNECT: Auto-connecting server \002%s\002 (%lu seconds until next attempt)",x->Name.c_str(),x->AutoConnect);
534 this->ConnectServer(&(*x));
540 int ModuleSpanningTree::HandleVersion(const char** parameters, int pcnt, userrec* user)
542 // we've already checked if pcnt > 0, so this is safe
543 TreeServer* found = Utils->FindServerMask(parameters[0]);
546 std::string Version = found->GetVersion();
547 user->WriteServ("351 %s :%s",user->nick,Version.c_str());
548 if (found == Utils->TreeRoot)
550 ServerInstance->Config->Send005(user);
555 user->WriteServ("402 %s %s :No such server",user->nick,parameters[0]);
560 int ModuleSpanningTree::HandleConnect(const char** parameters, int pcnt, userrec* user)
562 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
564 if (ServerInstance->MatchText(x->Name.c_str(),parameters[0]))
566 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
569 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);
570 ConnectServer(&(*x));
575 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());
580 user->WriteServ("NOTICE %s :*** CONNECT: No server matching \002%s\002 could be found in the config file.",user->nick,parameters[0]);
584 void ModuleSpanningTree::BroadcastTimeSync()
586 if (Utils->MasterTime)
588 std::deque<std::string> params;
589 params.push_back(ConvToStr(ServerInstance->Time(false)));
590 params.push_back("FORCE");
591 Utils->DoOneToMany(Utils->TreeRoot->GetName(), "TIMESET", params);
595 int ModuleSpanningTree::OnStats(char statschar, userrec* user, string_list &results)
597 if ((statschar == 'c') || (statschar == 'n'))
599 for (unsigned int i = 0; i < Utils->LinkBlocks.size(); i++)
601 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');
602 if (statschar == 'c')
603 results.push_back(std::string(ServerInstance->Config->ServerName)+" 244 "+user->nick+" H * * "+Utils->LinkBlocks[i].Name.c_str());
605 results.push_back(std::string(ServerInstance->Config->ServerName)+" 219 "+user->nick+" "+statschar+" :End of /STATS report");
606 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);
612 int ModuleSpanningTree::OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line)
614 /* If the command doesnt appear to be valid, we dont want to mess with it. */
618 if (command == "CONNECT")
620 return this->HandleConnect(parameters,pcnt,user);
622 else if (command == "STATS")
624 return this->HandleStats(parameters,pcnt,user);
626 else if (command == "MOTD")
628 return this->HandleMotd(parameters,pcnt,user);
630 else if (command == "ADMIN")
632 return this->HandleAdmin(parameters,pcnt,user);
634 else if (command == "SQUIT")
636 return this->HandleSquit(parameters,pcnt,user);
638 else if (command == "MAP")
640 this->HandleMap(parameters,pcnt,user);
643 else if ((command == "TIME") && (pcnt > 0))
645 return this->HandleTime(parameters,pcnt,user);
647 else if (command == "LUSERS")
649 this->HandleLusers(parameters,pcnt,user);
652 else if (command == "LINKS")
654 this->HandleLinks(parameters,pcnt,user);
657 else if (command == "WHOIS")
662 return this->HandleRemoteWhois(parameters,pcnt,user);
665 else if ((command == "VERSION") && (pcnt > 0))
667 this->HandleVersion(parameters,pcnt,user);
670 else if ((command == "MODULES") && (pcnt > 0))
672 return this->HandleModules(parameters,pcnt,user);
677 void ModuleSpanningTree::OnPostCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, CmdResult result, const std::string &original_line)
679 if ((result == CMD_SUCCESS) && (ServerInstance->IsValidModuleCommand(command, pcnt, user)))
681 // this bit of code cleverly routes all module commands
682 // to all remote severs *automatically* so that modules
683 // can just handle commands locally, without having
684 // to have any special provision in place for remote
685 // commands and linking protocols.
686 std::deque<std::string> params;
688 for (int j = 0; j < pcnt; j++)
690 if (strchr(parameters[j],' '))
692 params.push_back(":" + std::string(parameters[j]));
696 params.push_back(std::string(parameters[j]));
699 Utils->DoOneToMany(user->nick,command,params);
703 void ModuleSpanningTree::OnGetServerDescription(const std::string &servername,std::string &description)
705 TreeServer* s = Utils->FindServer(servername);
708 description = s->GetDesc();
712 void ModuleSpanningTree::OnUserInvite(userrec* source,userrec* dest,chanrec* channel)
714 if (IS_LOCAL(source))
716 std::deque<std::string> params;
717 params.push_back(dest->nick);
718 params.push_back(channel->name);
719 Utils->DoOneToMany(source->nick,"INVITE",params);
723 void ModuleSpanningTree::OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic)
725 std::deque<std::string> params;
726 params.push_back(chan->name);
727 params.push_back(":"+topic);
728 Utils->DoOneToMany(user->nick,"TOPIC",params);
731 void ModuleSpanningTree::OnWallops(userrec* user, const std::string &text)
735 std::deque<std::string> params;
736 params.push_back(":"+text);
737 Utils->DoOneToMany(user->nick,"WALLOPS",params);
741 void ModuleSpanningTree::OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
743 if (target_type == TYPE_USER)
745 userrec* d = (userrec*)dest;
746 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
748 std::deque<std::string> params;
750 params.push_back(d->nick);
751 params.push_back(":"+text);
752 Utils->DoOneToOne(user->nick,"NOTICE",params,d->server);
755 else if (target_type == TYPE_CHANNEL)
759 chanrec *c = (chanrec*)dest;
762 std::string cname = c->name;
764 cname = status + cname;
766 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
767 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
769 TreeSocket* Sock = i->second->GetSocket();
771 Sock->WriteLine(":"+std::string(user->nick)+" NOTICE "+cname+" :"+text);
776 else if (target_type == TYPE_SERVER)
780 char* target = (char*)dest;
781 std::deque<std::string> par;
782 par.push_back(target);
783 par.push_back(":"+text);
784 Utils->DoOneToMany(user->nick,"NOTICE",par);
789 void ModuleSpanningTree::OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
791 if (target_type == TYPE_USER)
793 // route private messages which are targetted at clients only to the server
794 // which needs to receive them
795 userrec* d = (userrec*)dest;
796 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
798 std::deque<std::string> params;
800 params.push_back(d->nick);
801 params.push_back(":"+text);
802 Utils->DoOneToOne(user->nick,"PRIVMSG",params,d->server);
805 else if (target_type == TYPE_CHANNEL)
809 chanrec *c = (chanrec*)dest;
812 std::string cname = c->name;
814 cname = status + cname;
816 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
817 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
819 TreeSocket* Sock = i->second->GetSocket();
821 Sock->WriteLine(":"+std::string(user->nick)+" PRIVMSG "+cname+" :"+text);
826 else if (target_type == TYPE_SERVER)
830 char* target = (char*)dest;
831 std::deque<std::string> par;
832 par.push_back(target);
833 par.push_back(":"+text);
834 Utils->DoOneToMany(user->nick,"PRIVMSG",par);
839 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
841 AutoConnectServers(curtime);
842 DoPingChecks(curtime);
845 void ModuleSpanningTree::OnUserJoin(userrec* user, chanrec* channel)
847 // Only do this for local users
850 if (channel->GetUserCounter() == 1)
852 std::deque<std::string> params;
853 // set up their permissions and the channel TS with FJOIN.
854 // All users are FJOINed now, because a module may specify
855 // new joining permissions for the user.
856 params.push_back(channel->name);
857 params.push_back(ConvToStr(channel->age));
858 params.push_back(std::string(channel->GetAllPrefixChars(user))+","+std::string(user->nick));
859 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FJOIN",params);
860 /* First user in, sync the modes for the channel */
862 /* This is safe, all inspircd servers default to +nt */
863 params.push_back("+nt");
864 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FMODE",params);
868 std::deque<std::string> params;
869 params.push_back(channel->name);
870 params.push_back(ConvToStr(channel->age));
871 Utils->DoOneToMany(user->nick,"JOIN",params);
876 void ModuleSpanningTree::OnChangeHost(userrec* user, const std::string &newhost)
878 // only occurs for local clients
879 if (user->registered != REG_ALL)
881 std::deque<std::string> params;
882 params.push_back(newhost);
883 Utils->DoOneToMany(user->nick,"FHOST",params);
886 void ModuleSpanningTree::OnChangeName(userrec* user, const std::string &gecos)
888 // only occurs for local clients
889 if (user->registered != REG_ALL)
891 std::deque<std::string> params;
892 params.push_back(gecos);
893 Utils->DoOneToMany(user->nick,"FNAME",params);
896 void ModuleSpanningTree::OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage)
900 std::deque<std::string> params;
901 params.push_back(channel->name);
902 if (partmessage != "")
903 params.push_back(":"+partmessage);
904 Utils->DoOneToMany(user->nick,"PART",params);
908 void ModuleSpanningTree::OnUserConnect(userrec* user)
913 std::deque<std::string> params;
914 snprintf(agestr,MAXBUF,"%lu",(unsigned long)user->age);
915 params.push_back(agestr);
916 params.push_back(user->nick);
917 params.push_back(user->host);
918 params.push_back(user->dhost);
919 params.push_back(user->ident);
920 params.push_back("+"+std::string(user->FormatModes()));
921 params.push_back(user->GetIPString());
922 params.push_back(":"+std::string(user->fullname));
923 Utils->DoOneToMany(ServerInstance->Config->ServerName,"NICK",params);
924 // User is Local, change needs to be reflected!
925 TreeServer* SourceServer = Utils->FindServer(user->server);
928 SourceServer->AddUserCount();
933 void ModuleSpanningTree::OnUserQuit(userrec* user, const std::string &reason, const std::string &oper_message)
935 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
937 std::deque<std::string> params;
939 if (oper_message != reason)
941 params.push_back(":"+oper_message);
942 Utils->DoOneToMany(user->nick,"OPERQUIT",params);
945 params.push_back(":"+reason);
946 Utils->DoOneToMany(user->nick,"QUIT",params);
948 // Regardless, We need to modify the user Counts..
949 TreeServer* SourceServer = Utils->FindServer(user->server);
952 SourceServer->DelUserCount();
956 void ModuleSpanningTree::OnUserPostNick(userrec* user, const std::string &oldnick)
960 std::deque<std::string> params;
961 params.push_back(user->nick);
962 Utils->DoOneToMany(oldnick,"NICK",params);
966 void ModuleSpanningTree::OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason)
968 if ((source) && (IS_LOCAL(source)))
970 std::deque<std::string> params;
971 params.push_back(chan->name);
972 params.push_back(user->nick);
973 params.push_back(":"+reason);
974 Utils->DoOneToMany(source->nick,"KICK",params);
978 std::deque<std::string> params;
979 params.push_back(chan->name);
980 params.push_back(user->nick);
981 params.push_back(":"+reason);
982 Utils->DoOneToMany(ServerInstance->Config->ServerName,"KICK",params);
986 void ModuleSpanningTree::OnRemoteKill(userrec* source, userrec* dest, const std::string &reason)
988 std::deque<std::string> params;
989 params.push_back(dest->nick);
990 params.push_back(":"+reason);
991 Utils->DoOneToMany(source->nick,"KILL",params);
994 void ModuleSpanningTree::OnRehash(userrec* user, const std::string ¶meter)
998 std::deque<std::string> params;
999 params.push_back(parameter);
1000 Utils->DoOneToMany(user ? user->nick : ServerInstance->Config->ServerName, "REHASH", params);
1002 if (ServerInstance->MatchText(ServerInstance->Config->ServerName,parameter))
1004 ServerInstance->WriteOpers("*** Remote rehash initiated locally by \002%s\002", user ? user->nick : ServerInstance->Config->ServerName);
1005 ServerInstance->RehashServer();
1008 Utils->ReadConfiguration(false);
1009 InitializeDisabledCommands(ServerInstance->Config->DisabledCommands, ServerInstance);
1012 // note: the protocol does not allow direct umode +o except
1013 // via NICK with 8 params. sending OPERTYPE infers +o modechange
1015 void ModuleSpanningTree::OnOper(userrec* user, const std::string &opertype)
1019 std::deque<std::string> params;
1020 params.push_back(opertype);
1021 Utils->DoOneToMany(user->nick,"OPERTYPE",params);
1025 void ModuleSpanningTree::OnLine(userrec* source, const std::string &host, bool adding, char linetype, long duration, const std::string &reason)
1029 /* Server-set lines */
1031 snprintf(data,MAXBUF,"%c %s %s %lu %lu :%s", linetype, host.c_str(), ServerInstance->Config->ServerName, (unsigned long)ServerInstance->Time(false),
1032 (unsigned long)duration, reason.c_str());
1033 std::deque<std::string> params;
1034 params.push_back(data);
1035 Utils->DoOneToMany(ServerInstance->Config->ServerName, "ADDLINE", params);
1039 if (IS_LOCAL(source))
1042 snprintf(type,8,"%cLINE",linetype);
1043 std::string stype = type;
1046 char sduration[MAXBUF];
1047 snprintf(sduration,MAXBUF,"%ld",duration);
1048 std::deque<std::string> params;
1049 params.push_back(host);
1050 params.push_back(sduration);
1051 params.push_back(":"+reason);
1052 Utils->DoOneToMany(source->nick,stype,params);
1056 std::deque<std::string> params;
1057 params.push_back(host);
1058 Utils->DoOneToMany(source->nick,stype,params);
1064 void ModuleSpanningTree::OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask)
1066 OnLine(source,hostmask,true,'G',duration,reason);
1069 void ModuleSpanningTree::OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask)
1071 OnLine(source,ipmask,true,'Z',duration,reason);
1074 void ModuleSpanningTree::OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask)
1076 OnLine(source,nickmask,true,'Q',duration,reason);
1079 void ModuleSpanningTree::OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask)
1081 OnLine(source,hostmask,true,'E',duration,reason);
1084 void ModuleSpanningTree::OnDelGLine(userrec* source, const std::string &hostmask)
1086 OnLine(source,hostmask,false,'G',0,"");
1089 void ModuleSpanningTree::OnDelZLine(userrec* source, const std::string &ipmask)
1091 OnLine(source,ipmask,false,'Z',0,"");
1094 void ModuleSpanningTree::OnDelQLine(userrec* source, const std::string &nickmask)
1096 OnLine(source,nickmask,false,'Q',0,"");
1099 void ModuleSpanningTree::OnDelELine(userrec* source, const std::string &hostmask)
1101 OnLine(source,hostmask,false,'E',0,"");
1104 void ModuleSpanningTree::OnMode(userrec* user, void* dest, int target_type, const std::string &text)
1106 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
1108 std::deque<std::string> params;
1109 std::string command;
1111 if (target_type == TYPE_USER)
1113 userrec* u = (userrec*)dest;
1114 params.push_back(u->nick);
1115 params.push_back(text);
1120 chanrec* c = (chanrec*)dest;
1121 params.push_back(c->name);
1122 params.push_back(ConvToStr(c->age));
1123 params.push_back(text);
1126 Utils->DoOneToMany(user->nick, command, params);
1130 void ModuleSpanningTree::OnSetAway(userrec* user)
1134 std::deque<std::string> params;
1135 params.push_back(":"+std::string(user->awaymsg));
1136 Utils->DoOneToMany(user->nick,"AWAY",params);
1140 void ModuleSpanningTree::OnCancelAway(userrec* user)
1144 std::deque<std::string> params;
1146 Utils->DoOneToMany(user->nick,"AWAY",params);
1150 void ModuleSpanningTree::ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline)
1152 TreeSocket* s = (TreeSocket*)opaque;
1155 if (target_type == TYPE_USER)
1157 userrec* u = (userrec*)target;
1158 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" FMODE "+u->nick+" "+ConvToStr(u->age)+" "+modeline);
1162 chanrec* c = (chanrec*)target;
1163 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" FMODE "+c->name+" "+ConvToStr(c->age)+" "+modeline);
1168 void ModuleSpanningTree::ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata)
1170 TreeSocket* s = (TreeSocket*)opaque;
1173 if (target_type == TYPE_USER)
1175 userrec* u = (userrec*)target;
1176 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA "+u->nick+" "+extname+" :"+extdata);
1178 else if (target_type == TYPE_CHANNEL)
1180 chanrec* c = (chanrec*)target;
1181 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA "+c->name+" "+extname+" :"+extdata);
1184 if (target_type == TYPE_OTHER)
1186 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA * "+extname+" :"+extdata);
1190 void ModuleSpanningTree::OnEvent(Event* event)
1192 std::deque<std::string>* params = (std::deque<std::string>*)event->GetData();
1193 if (event->GetEventID() == "send_metadata")
1195 if (params->size() < 3)
1197 (*params)[2] = ":" + (*params)[2];
1198 Utils->DoOneToMany(ServerInstance->Config->ServerName,"METADATA",*params);
1200 else if (event->GetEventID() == "send_topic")
1202 if (params->size() < 2)
1204 (*params)[1] = ":" + (*params)[1];
1205 params->insert(params->begin() + 1,ServerInstance->Config->ServerName);
1206 params->insert(params->begin() + 1,ConvToStr(ServerInstance->Time(true)));
1207 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FTOPIC",*params);
1209 else if (event->GetEventID() == "send_mode")
1211 if (params->size() < 2)
1213 // Insert the TS value of the object, either userrec or chanrec
1215 userrec* a = ServerInstance->FindNick((*params)[0]);
1222 chanrec* a = ServerInstance->FindChan((*params)[0]);
1228 params->insert(params->begin() + 1,ConvToStr(ourTS));
1229 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FMODE",*params);
1231 else if (event->GetEventID() == "send_mode_explicit")
1233 if (params->size() < 2)
1235 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODE",*params);
1237 else if (event->GetEventID() == "send_opers")
1239 if (params->size() < 1)
1241 (*params)[0] = ":" + (*params)[0];
1242 Utils->DoOneToMany(ServerInstance->Config->ServerName,"OPERNOTICE",*params);
1244 else if (event->GetEventID() == "send_modeset")
1246 if (params->size() < 2)
1248 (*params)[1] = ":" + (*params)[1];
1249 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODENOTICE",*params);
1251 else if (event->GetEventID() == "send_snoset")
1253 if (params->size() < 2)
1255 (*params)[1] = ":" + (*params)[1];
1256 Utils->DoOneToMany(ServerInstance->Config->ServerName,"SNONOTICE",*params);
1258 else if (event->GetEventID() == "send_push")
1260 if (params->size() < 2)
1263 userrec *a = ServerInstance->FindNick((*params)[0]);
1268 (*params)[1] = ":" + (*params)[1];
1269 Utils->DoOneToOne(ServerInstance->Config->ServerName, "PUSH", *params, a->server);
1273 ModuleSpanningTree::~ModuleSpanningTree()
1275 /* This will also free the listeners */
1278 ServerInstance->Timers->DelTimer(SyncTimer);
1280 ServerInstance->DoneWithInterface("InspSocketHook");
1283 Version ModuleSpanningTree::GetVersion()
1285 return Version(1,1,0,2,VF_VENDOR,API_VERSION);
1288 void ModuleSpanningTree::Implements(char* List)
1290 List[I_OnPreCommand] = List[I_OnGetServerDescription] = List[I_OnUserInvite] = List[I_OnPostLocalTopicChange] = 1;
1291 List[I_OnWallops] = List[I_OnUserNotice] = List[I_OnUserMessage] = List[I_OnBackgroundTimer] = 1;
1292 List[I_OnUserJoin] = List[I_OnChangeHost] = List[I_OnChangeName] = List[I_OnUserPart] = List[I_OnUserConnect] = 1;
1293 List[I_OnUserQuit] = List[I_OnUserPostNick] = List[I_OnUserKick] = List[I_OnRemoteKill] = List[I_OnRehash] = 1;
1294 List[I_OnOper] = List[I_OnAddGLine] = List[I_OnAddZLine] = List[I_OnAddQLine] = List[I_OnAddELine] = 1;
1295 List[I_OnDelGLine] = List[I_OnDelZLine] = List[I_OnDelQLine] = List[I_OnDelELine] = List[I_ProtoSendMode] = List[I_OnMode] = 1;
1296 List[I_OnStats] = List[I_ProtoSendMetaData] = List[I_OnEvent] = List[I_OnSetAway] = List[I_OnCancelAway] = List[I_OnPostCommand] = 1;
1299 /* It is IMPORTANT that m_spanningtree is the last module in the chain
1300 * so that any activity it sees is FINAL, e.g. we arent going to send out
1301 * a NICK message before m_cloaking has finished putting the +x on the user,
1303 * Therefore, we return PRIORITY_LAST to make sure we end up at the END of
1304 * the module call queue.
1306 Priority ModuleSpanningTree::Prioritize()
1308 return PRIORITY_LAST;
1311 class ModuleSpanningTreeFactory : public ModuleFactory
1314 ModuleSpanningTreeFactory()
1318 ~ModuleSpanningTreeFactory()
1322 virtual Module * CreateModule(InspIRCd* Me)
1324 return new ModuleSpanningTree(Me);
1330 extern "C" void * init_module( void )
1332 return new ModuleSpanningTreeFactory;