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("254 %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 /* Remote MOTD, the server is within the 1st parameter */
197 std::deque<std::string> params;
198 params.push_back(parameters[0]);
199 /* Send it out remotely, generate no reply yet */
200 TreeServer* s = Utils->FindServerMask(parameters[0]);
203 Utils->DoOneToOne(user->nick, "MOTD", params, s->GetName());
207 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
214 int ModuleSpanningTree::HandleAdmin(const char** parameters, int pcnt, userrec* user)
218 /* Remote ADMIN, the server is within the 1st parameter */
219 std::deque<std::string> params;
220 params.push_back(parameters[0]);
221 /* Send it out remotely, generate no reply yet */
222 TreeServer* s = Utils->FindServerMask(parameters[0]);
225 Utils->DoOneToOne(user->nick, "ADMIN", params, s->GetName());
229 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
236 int ModuleSpanningTree::HandleStats(const char** parameters, int pcnt, userrec* user)
240 /* Remote STATS, the server is within the 2nd parameter */
241 std::deque<std::string> params;
242 params.push_back(parameters[0]);
243 params.push_back(parameters[1]);
244 /* Send it out remotely, generate no reply yet */
245 TreeServer* s = Utils->FindServerMask(parameters[1]);
248 params[1] = s->GetName();
249 Utils->DoOneToOne(user->nick, "STATS", params, s->GetName());
253 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
260 // Ok, prepare to be confused.
261 // After much mulling over how to approach this, it struck me that
262 // the 'usual' way of doing a /MAP isnt the best way. Instead of
263 // keeping track of a ton of ascii characters, and line by line
264 // under recursion working out where to place them using multiplications
265 // and divisons, we instead render the map onto a backplane of characters
266 // (a character matrix), then draw the branches as a series of "L" shapes
267 // from the nodes. This is not only friendlier on CPU it uses less stack.
268 void ModuleSpanningTree::HandleMap(const char** parameters, int pcnt, userrec* user)
270 // This array represents a virtual screen which we will
271 // "scratch" draw to, as the console device of an irc
272 // client does not provide for a proper terminal.
274 float totservers = 0;
275 char matrix[128][80];
276 for (unsigned int t = 0; t < 128; t++)
281 // The only recursive bit is called here.
282 ShowMap(Utils->TreeRoot,user,0,matrix,totusers,totservers);
283 // Process each line one by one. The algorithm has a limit of
284 // 128 servers (which is far more than a spanning tree should have
285 // anyway, so we're ok). This limit can be raised simply by making
286 // the character matrix deeper, 128 rows taking 10k of memory.
287 for (int l = 1; l < line; l++)
289 // scan across the line looking for the start of the
290 // servername (the recursive part of the algorithm has placed
291 // the servers at indented positions depending on what they
293 int first_nonspace = 0;
294 while (matrix[l][first_nonspace] == ' ')
299 // Draw the `- (corner) section: this may be overwritten by
300 // another L shape passing along the same vertical pane, becoming
301 // a |- (branch) section instead.
302 matrix[l][first_nonspace] = '-';
303 matrix[l][first_nonspace-1] = '`';
305 // Draw upwards until we hit the parent server, causing possibly
306 // other corners (`-) to become branches (|-)
307 while ((matrix[l2][first_nonspace-1] == ' ') || (matrix[l2][first_nonspace-1] == '`'))
309 matrix[l2][first_nonspace-1] = '|';
313 // dump the whole lot to the user. This is the easy bit, honest.
314 for (int t = 0; t < line; t++)
316 user->WriteServ("006 %s :%s",user->nick,&matrix[t][0]);
318 float avg_users = totusers / totservers;
319 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);
320 user->WriteServ("007 %s :End of /MAP",user->nick);
324 int ModuleSpanningTree::HandleSquit(const char** parameters, int pcnt, userrec* user)
326 TreeServer* s = Utils->FindServerMask(parameters[0]);
329 if (s == Utils->TreeRoot)
331 user->WriteServ("NOTICE %s :*** SQUIT: Foolish mortal, you cannot make a server SQUIT itself! (%s matches local server name)",user->nick,parameters[0]);
334 TreeSocket* sock = s->GetSocket();
337 ServerInstance->SNO->WriteToSnoMask('l',"SQUIT: Server \002%s\002 removed from network by %s",parameters[0],user->nick);
338 sock->Squit(s,std::string("Server quit by ") + user->GetFullRealHost());
339 ServerInstance->SE->DelFd(sock);
346 std::deque<std::string> params;
347 params.push_back(parameters[0]);
348 params.push_back(std::string(":Server quit by ") + user->GetFullRealHost());
349 Utils->DoOneToOne(user->nick, "RSQUIT", params, parameters[0]);
354 user->WriteServ("NOTICE %s :*** SQUIT: The server \002%s\002 does not exist on the network.",user->nick,parameters[0]);
359 int ModuleSpanningTree::HandleTime(const char** parameters, int pcnt, userrec* user)
361 if ((IS_LOCAL(user)) && (pcnt))
363 TreeServer* found = Utils->FindServerMask(parameters[0]);
366 // we dont' override for local server
367 if (found == Utils->TreeRoot)
370 std::deque<std::string> params;
371 params.push_back(found->GetName());
372 params.push_back(user->nick);
373 Utils->DoOneToOne(ServerInstance->Config->ServerName,"TIME",params,found->GetName());
377 user->WriteServ("402 %s %s :No such server",user->nick,parameters[0]);
383 int ModuleSpanningTree::HandleRemoteWhois(const char** parameters, int pcnt, userrec* user)
385 if ((IS_LOCAL(user)) && (pcnt > 1))
387 userrec* remote = ServerInstance->FindNick(parameters[1]);
388 if ((remote) && (remote->GetFd() < 0))
390 std::deque<std::string> params;
391 params.push_back(parameters[1]);
392 Utils->DoOneToOne(user->nick,"IDLE",params,remote->server);
397 user->WriteServ("401 %s %s :No such nick/channel",user->nick, parameters[1]);
398 user->WriteServ("318 %s %s :End of /WHOIS list.",user->nick, parameters[1]);
405 void ModuleSpanningTree::DoPingChecks(time_t curtime)
407 for (unsigned int j = 0; j < Utils->TreeRoot->ChildCount(); j++)
409 TreeServer* serv = Utils->TreeRoot->GetChild(j);
410 TreeSocket* sock = serv->GetSocket();
413 if (curtime >= serv->NextPingTime())
415 if (serv->AnsweredLastPing())
417 sock->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" PING "+serv->GetName());
418 serv->SetNextPingTime(curtime + 60);
422 // they didnt answer, boot them
423 ServerInstance->SNO->WriteToSnoMask('l',"Server \002%s\002 pinged out",serv->GetName().c_str());
424 sock->Squit(serv,"Ping timeout");
425 ServerInstance->SE->DelFd(sock);
435 void ModuleSpanningTree::ConnectServer(Link* x)
438 /* Do we already have an IP? If so, no need to resolve it. */
439 if (insp_aton(x->IPAddr.c_str(), &binip) > 0)
441 /* Gave a hook, but it wasnt one we know */
442 if ((!x->Hook.empty()) && (Utils->hooks.find(x->Hook.c_str()) == Utils->hooks.end()))
444 TreeSocket* newsocket = new TreeSocket(Utils, ServerInstance, x->IPAddr,x->Port,false,x->Timeout ? x->Timeout : 10,x->Name.c_str(), x->Hook.empty() ? NULL : Utils->hooks[x->Hook.c_str()]);
445 if (newsocket->GetFd() > -1)
447 /* Handled automatically on success */
451 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(),strerror(errno));
453 Utils->DoFailOver(x);
461 ServernameResolver* snr = new ServernameResolver((Module*)this, Utils, ServerInstance,x->IPAddr, *x, cached);
462 ServerInstance->AddResolver(snr, cached);
464 catch (ModuleException& e)
466 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason());
467 Utils->DoFailOver(x);
472 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
474 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
476 if ((x->AutoConnect) && (curtime >= x->NextConnectTime))
478 x->NextConnectTime = curtime + x->AutoConnect;
479 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
480 if (x->FailOver.length())
482 TreeServer* CheckFailOver = Utils->FindServer(x->FailOver.c_str());
485 /* The failover for this server is currently a member of the network.
486 * The failover probably succeeded, where the main link did not.
487 * Don't try the main link until the failover is gone again.
494 // an autoconnected server is not connected. Check if its time to connect it
495 ServerInstance->SNO->WriteToSnoMask('l',"AUTOCONNECT: Auto-connecting server \002%s\002 (%lu seconds until next attempt)",x->Name.c_str(),x->AutoConnect);
496 this->ConnectServer(&(*x));
502 int ModuleSpanningTree::HandleVersion(const char** parameters, int pcnt, userrec* user)
504 // we've already checked if pcnt > 0, so this is safe
505 TreeServer* found = Utils->FindServerMask(parameters[0]);
508 std::string Version = found->GetVersion();
509 user->WriteServ("351 %s :%s",user->nick,Version.c_str());
510 if (found == Utils->TreeRoot)
512 ServerInstance->Config->Send005(user);
517 user->WriteServ("402 %s %s :No such server",user->nick,parameters[0]);
522 int ModuleSpanningTree::HandleConnect(const char** parameters, int pcnt, userrec* user)
524 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
526 if (ServerInstance->MatchText(x->Name.c_str(),parameters[0]))
528 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
531 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);
532 ConnectServer(&(*x));
537 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());
542 user->WriteServ("NOTICE %s :*** CONNECT: No server matching \002%s\002 could be found in the config file.",user->nick,parameters[0]);
546 void ModuleSpanningTree::BroadcastTimeSync()
548 std::deque<std::string> params;
549 params.push_back(ConvToStr(ServerInstance->Time(true)));
550 Utils->DoOneToMany(Utils->TreeRoot->GetName(), "TIMESET", params);
553 int ModuleSpanningTree::OnStats(char statschar, userrec* user, string_list &results)
555 if ((statschar == 'c') || (statschar == 'n'))
557 for (unsigned int i = 0; i < Utils->LinkBlocks.size(); i++)
559 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');
560 if (statschar == 'c')
561 results.push_back(std::string(ServerInstance->Config->ServerName)+" 244 "+user->nick+" H * * "+Utils->LinkBlocks[i].Name.c_str());
563 results.push_back(std::string(ServerInstance->Config->ServerName)+" 219 "+user->nick+" "+statschar+" :End of /STATS report");
564 ServerInstance->SNO->WriteToSnoMask('t',"Notice: %s '%c' requested by %s (%s@%s)",(!strcmp(user->server,ServerInstance->Config->ServerName) ? "Stats" : "Remote stats"),statschar,user->nick,user->ident,user->host);
570 int ModuleSpanningTree::OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line)
572 /* If the command doesnt appear to be valid, we dont want to mess with it. */
575 if (command == "CONNECT")
577 return this->HandleConnect(parameters,pcnt,user);
579 else if (command == "STATS")
581 return this->HandleStats(parameters,pcnt,user);
583 else if (command == "MOTD")
585 return this->HandleMotd(parameters,pcnt,user);
587 else if (command == "ADMIN")
589 return this->HandleAdmin(parameters,pcnt,user);
591 else if (command == "SQUIT")
593 return this->HandleSquit(parameters,pcnt,user);
595 else if (command == "MAP")
597 this->HandleMap(parameters,pcnt,user);
600 else if ((command == "TIME") && (pcnt > 0))
602 return this->HandleTime(parameters,pcnt,user);
604 else if (command == "LUSERS")
606 this->HandleLusers(parameters,pcnt,user);
609 else if (command == "LINKS")
611 this->HandleLinks(parameters,pcnt,user);
614 else if (command == "WHOIS")
619 return this->HandleRemoteWhois(parameters,pcnt,user);
622 else if ((command == "VERSION") && (pcnt > 0))
624 this->HandleVersion(parameters,pcnt,user);
630 void ModuleSpanningTree::OnPostCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, CmdResult result, const std::string &original_line)
632 if ((result == CMD_SUCCESS) && (ServerInstance->IsValidModuleCommand(command, pcnt, user)))
634 // this bit of code cleverly routes all module commands
635 // to all remote severs *automatically* so that modules
636 // can just handle commands locally, without having
637 // to have any special provision in place for remote
638 // commands and linking protocols.
639 std::deque<std::string> params;
641 for (int j = 0; j < pcnt; j++)
643 if (strchr(parameters[j],' '))
645 params.push_back(":" + std::string(parameters[j]));
649 params.push_back(std::string(parameters[j]));
652 Utils->DoOneToMany(user->nick,command,params);
656 void ModuleSpanningTree::OnGetServerDescription(const std::string &servername,std::string &description)
658 TreeServer* s = Utils->FindServer(servername);
661 description = s->GetDesc();
665 void ModuleSpanningTree::OnUserInvite(userrec* source,userrec* dest,chanrec* channel)
667 if (IS_LOCAL(source))
669 std::deque<std::string> params;
670 params.push_back(dest->nick);
671 params.push_back(channel->name);
672 Utils->DoOneToMany(source->nick,"INVITE",params);
676 void ModuleSpanningTree::OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic)
678 std::deque<std::string> params;
679 params.push_back(chan->name);
680 params.push_back(":"+topic);
681 Utils->DoOneToMany(user->nick,"TOPIC",params);
684 void ModuleSpanningTree::OnWallops(userrec* user, const std::string &text)
688 std::deque<std::string> params;
689 params.push_back(":"+text);
690 Utils->DoOneToMany(user->nick,"WALLOPS",params);
694 void ModuleSpanningTree::OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
696 if (target_type == TYPE_USER)
698 userrec* d = (userrec*)dest;
699 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
701 std::deque<std::string> params;
703 params.push_back(d->nick);
704 params.push_back(":"+text);
705 Utils->DoOneToOne(user->nick,"NOTICE",params,d->server);
708 else if (target_type == TYPE_CHANNEL)
712 chanrec *c = (chanrec*)dest;
715 std::string cname = c->name;
717 cname = status + cname;
719 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
720 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
722 TreeSocket* Sock = i->second->GetSocket();
724 Sock->WriteLine(":"+std::string(user->nick)+" NOTICE "+cname+" :"+text);
729 else if (target_type == TYPE_SERVER)
733 char* target = (char*)dest;
734 std::deque<std::string> par;
735 par.push_back(target);
736 par.push_back(":"+text);
737 Utils->DoOneToMany(user->nick,"NOTICE",par);
742 void ModuleSpanningTree::OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
744 if (target_type == TYPE_USER)
746 // route private messages which are targetted at clients only to the server
747 // which needs to receive them
748 userrec* d = (userrec*)dest;
749 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
751 std::deque<std::string> params;
753 params.push_back(d->nick);
754 params.push_back(":"+text);
755 Utils->DoOneToOne(user->nick,"PRIVMSG",params,d->server);
758 else if (target_type == TYPE_CHANNEL)
762 chanrec *c = (chanrec*)dest;
765 std::string cname = c->name;
767 cname = status + cname;
769 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
770 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
772 TreeSocket* Sock = i->second->GetSocket();
774 Sock->WriteLine(":"+std::string(user->nick)+" PRIVMSG "+cname+" :"+text);
779 else if (target_type == TYPE_SERVER)
783 char* target = (char*)dest;
784 std::deque<std::string> par;
785 par.push_back(target);
786 par.push_back(":"+text);
787 Utils->DoOneToMany(user->nick,"PRIVMSG",par);
792 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
794 AutoConnectServers(curtime);
795 DoPingChecks(curtime);
798 void ModuleSpanningTree::OnUserJoin(userrec* user, chanrec* channel)
800 // Only do this for local users
803 if (channel->GetUserCounter() == 1)
805 std::deque<std::string> params;
806 // set up their permissions and the channel TS with FJOIN.
807 // All users are FJOINed now, because a module may specify
808 // new joining permissions for the user.
809 params.push_back(channel->name);
810 params.push_back(ConvToStr(channel->age));
811 params.push_back(std::string(channel->GetAllPrefixChars(user))+","+std::string(user->nick));
812 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FJOIN",params);
813 /* First user in, sync the modes for the channel */
815 /* This is safe, all inspircd servers default to +nt */
816 params.push_back("+nt");
817 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FMODE",params);
821 std::deque<std::string> params;
822 params.push_back(channel->name);
823 params.push_back(ConvToStr(channel->age));
824 Utils->DoOneToMany(user->nick,"JOIN",params);
829 void ModuleSpanningTree::OnChangeHost(userrec* user, const std::string &newhost)
831 // only occurs for local clients
832 if (user->registered != REG_ALL)
834 std::deque<std::string> params;
835 params.push_back(newhost);
836 Utils->DoOneToMany(user->nick,"FHOST",params);
839 void ModuleSpanningTree::OnChangeName(userrec* user, const std::string &gecos)
841 // only occurs for local clients
842 if (user->registered != REG_ALL)
844 std::deque<std::string> params;
845 params.push_back(gecos);
846 Utils->DoOneToMany(user->nick,"FNAME",params);
849 void ModuleSpanningTree::OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage)
853 std::deque<std::string> params;
854 params.push_back(channel->name);
855 if (partmessage != "")
856 params.push_back(":"+partmessage);
857 Utils->DoOneToMany(user->nick,"PART",params);
861 void ModuleSpanningTree::OnUserConnect(userrec* user)
866 std::deque<std::string> params;
867 snprintf(agestr,MAXBUF,"%lu",(unsigned long)user->age);
868 params.push_back(agestr);
869 params.push_back(user->nick);
870 params.push_back(user->host);
871 params.push_back(user->dhost);
872 params.push_back(user->ident);
873 params.push_back("+"+std::string(user->FormatModes()));
874 params.push_back(user->GetIPString());
875 params.push_back(":"+std::string(user->fullname));
876 Utils->DoOneToMany(ServerInstance->Config->ServerName,"NICK",params);
877 // User is Local, change needs to be reflected!
878 TreeServer* SourceServer = Utils->FindServer(user->server);
881 SourceServer->AddUserCount();
886 void ModuleSpanningTree::OnUserQuit(userrec* user, const std::string &reason)
888 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
890 std::deque<std::string> params;
891 params.push_back(":"+reason);
892 Utils->DoOneToMany(user->nick,"QUIT",params);
894 // Regardless, We need to modify the user Counts..
895 TreeServer* SourceServer = Utils->FindServer(user->server);
898 SourceServer->DelUserCount();
902 void ModuleSpanningTree::OnUserPostNick(userrec* user, const std::string &oldnick)
906 std::deque<std::string> params;
907 params.push_back(user->nick);
908 Utils->DoOneToMany(oldnick,"NICK",params);
912 void ModuleSpanningTree::OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason)
914 if ((source) && (IS_LOCAL(source)))
916 std::deque<std::string> params;
917 params.push_back(chan->name);
918 params.push_back(user->nick);
919 params.push_back(":"+reason);
920 Utils->DoOneToMany(source->nick,"KICK",params);
924 std::deque<std::string> params;
925 params.push_back(chan->name);
926 params.push_back(user->nick);
927 params.push_back(":"+reason);
928 Utils->DoOneToMany(ServerInstance->Config->ServerName,"KICK",params);
932 void ModuleSpanningTree::OnRemoteKill(userrec* source, userrec* dest, const std::string &reason)
934 std::deque<std::string> params;
935 params.push_back(dest->nick);
936 params.push_back(":"+reason);
937 Utils->DoOneToMany(source->nick,"KILL",params);
940 void ModuleSpanningTree::OnRehash(userrec* user, const std::string ¶meter)
944 std::deque<std::string> params;
945 params.push_back(parameter);
946 Utils->DoOneToMany(user ? user->nick : ServerInstance->Config->ServerName, "REHASH", params);
948 if (ServerInstance->MatchText(ServerInstance->Config->ServerName,parameter))
950 ServerInstance->WriteOpers("*** Remote rehash initiated locally by \002%s\002", user ? user->nick : ServerInstance->Config->ServerName);
951 ServerInstance->RehashServer();
954 Utils->ReadConfiguration(false);
955 InitializeDisabledCommands(ServerInstance->Config->DisabledCommands, ServerInstance);
958 // note: the protocol does not allow direct umode +o except
959 // via NICK with 8 params. sending OPERTYPE infers +o modechange
961 void ModuleSpanningTree::OnOper(userrec* user, const std::string &opertype)
965 std::deque<std::string> params;
966 params.push_back(opertype);
967 Utils->DoOneToMany(user->nick,"OPERTYPE",params);
971 void ModuleSpanningTree::OnLine(userrec* source, const std::string &host, bool adding, char linetype, long duration, const std::string &reason)
975 /* Server-set lines */
977 snprintf(data,MAXBUF,"%c %s %s %lu %lu :%s", linetype, host.c_str(), ServerInstance->Config->ServerName, (unsigned long)ServerInstance->Time(false),
978 (unsigned long)duration, reason.c_str());
979 std::deque<std::string> params;
980 params.push_back(data);
981 Utils->DoOneToMany(ServerInstance->Config->ServerName, "ADDLINE", params);
985 if (IS_LOCAL(source))
988 snprintf(type,8,"%cLINE",linetype);
989 std::string stype = type;
992 char sduration[MAXBUF];
993 snprintf(sduration,MAXBUF,"%ld",duration);
994 std::deque<std::string> params;
995 params.push_back(host);
996 params.push_back(sduration);
997 params.push_back(":"+reason);
998 Utils->DoOneToMany(source->nick,stype,params);
1002 std::deque<std::string> params;
1003 params.push_back(host);
1004 Utils->DoOneToMany(source->nick,stype,params);
1010 void ModuleSpanningTree::OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask)
1012 OnLine(source,hostmask,true,'G',duration,reason);
1015 void ModuleSpanningTree::OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask)
1017 OnLine(source,ipmask,true,'Z',duration,reason);
1020 void ModuleSpanningTree::OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask)
1022 OnLine(source,nickmask,true,'Q',duration,reason);
1025 void ModuleSpanningTree::OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask)
1027 OnLine(source,hostmask,true,'E',duration,reason);
1030 void ModuleSpanningTree::OnDelGLine(userrec* source, const std::string &hostmask)
1032 OnLine(source,hostmask,false,'G',0,"");
1035 void ModuleSpanningTree::OnDelZLine(userrec* source, const std::string &ipmask)
1037 OnLine(source,ipmask,false,'Z',0,"");
1040 void ModuleSpanningTree::OnDelQLine(userrec* source, const std::string &nickmask)
1042 OnLine(source,nickmask,false,'Q',0,"");
1045 void ModuleSpanningTree::OnDelELine(userrec* source, const std::string &hostmask)
1047 OnLine(source,hostmask,false,'E',0,"");
1050 void ModuleSpanningTree::OnMode(userrec* user, void* dest, int target_type, const std::string &text)
1052 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
1054 if (target_type == TYPE_USER)
1056 userrec* u = (userrec*)dest;
1057 std::deque<std::string> params;
1058 params.push_back(u->nick);
1059 params.push_back(text);
1060 Utils->DoOneToMany(user->nick,"MODE",params);
1064 chanrec* c = (chanrec*)dest;
1065 std::deque<std::string> params;
1066 params.push_back(c->name);
1067 params.push_back(text);
1068 Utils->DoOneToMany(user->nick,"MODE",params);
1073 void ModuleSpanningTree::OnSetAway(userrec* user)
1077 std::deque<std::string> params;
1078 params.push_back(":"+std::string(user->awaymsg));
1079 Utils->DoOneToMany(user->nick,"AWAY",params);
1083 void ModuleSpanningTree::OnCancelAway(userrec* user)
1087 std::deque<std::string> params;
1089 Utils->DoOneToMany(user->nick,"AWAY",params);
1093 void ModuleSpanningTree::ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline)
1095 TreeSocket* s = (TreeSocket*)opaque;
1098 if (target_type == TYPE_USER)
1100 userrec* u = (userrec*)target;
1101 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" FMODE "+u->nick+" "+ConvToStr(u->age)+" "+modeline);
1105 chanrec* c = (chanrec*)target;
1106 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" FMODE "+c->name+" "+ConvToStr(c->age)+" "+modeline);
1111 void ModuleSpanningTree::ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata)
1113 TreeSocket* s = (TreeSocket*)opaque;
1116 if (target_type == TYPE_USER)
1118 userrec* u = (userrec*)target;
1119 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA "+u->nick+" "+extname+" :"+extdata);
1121 else if (target_type == TYPE_CHANNEL)
1123 chanrec* c = (chanrec*)target;
1124 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA "+c->name+" "+extname+" :"+extdata);
1127 if (target_type == TYPE_OTHER)
1129 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA * "+extname+" :"+extdata);
1133 void ModuleSpanningTree::OnEvent(Event* event)
1135 std::deque<std::string>* params = (std::deque<std::string>*)event->GetData();
1136 if (event->GetEventID() == "send_metadata")
1138 if (params->size() < 3)
1140 (*params)[2] = ":" + (*params)[2];
1141 Utils->DoOneToMany(ServerInstance->Config->ServerName,"METADATA",*params);
1143 else if (event->GetEventID() == "send_topic")
1145 if (params->size() < 2)
1147 (*params)[1] = ":" + (*params)[1];
1148 params->insert(params->begin() + 1,ServerInstance->Config->ServerName);
1149 params->insert(params->begin() + 1,ConvToStr(ServerInstance->Time(true)));
1150 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FTOPIC",*params);
1152 else if (event->GetEventID() == "send_mode")
1154 if (params->size() < 2)
1156 // Insert the TS value of the object, either userrec or chanrec
1158 userrec* a = ServerInstance->FindNick((*params)[0]);
1165 chanrec* a = ServerInstance->FindChan((*params)[0]);
1171 params->insert(params->begin() + 1,ConvToStr(ourTS));
1172 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FMODE",*params);
1174 else if (event->GetEventID() == "send_mode_explicit")
1176 if (params->size() < 2)
1178 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODE",*params);
1180 else if (event->GetEventID() == "send_opers")
1182 if (params->size() < 1)
1184 (*params)[0] = ":" + (*params)[0];
1185 Utils->DoOneToMany(ServerInstance->Config->ServerName,"OPERNOTICE",*params);
1187 else if (event->GetEventID() == "send_modeset")
1189 if (params->size() < 2)
1191 (*params)[1] = ":" + (*params)[1];
1192 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODENOTICE",*params);
1194 else if (event->GetEventID() == "send_snoset")
1196 if (params->size() < 2)
1198 (*params)[1] = ":" + (*params)[1];
1199 Utils->DoOneToMany(ServerInstance->Config->ServerName,"SNONOTICE",*params);
1201 else if (event->GetEventID() == "send_push")
1203 if (params->size() < 2)
1206 userrec *a = ServerInstance->FindNick((*params)[0]);
1211 (*params)[1] = ":" + (*params)[1];
1212 Utils->DoOneToOne(ServerInstance->Config->ServerName, "PUSH", *params, a->server);
1216 ModuleSpanningTree::~ModuleSpanningTree()
1218 /* This will also free the listeners */
1221 ServerInstance->Timers->DelTimer(SyncTimer);
1223 ServerInstance->DoneWithInterface("InspSocketHook");
1226 Version ModuleSpanningTree::GetVersion()
1228 return Version(1,1,0,2,VF_VENDOR,API_VERSION);
1231 void ModuleSpanningTree::Implements(char* List)
1233 List[I_OnPreCommand] = List[I_OnGetServerDescription] = List[I_OnUserInvite] = List[I_OnPostLocalTopicChange] = 1;
1234 List[I_OnWallops] = List[I_OnUserNotice] = List[I_OnUserMessage] = List[I_OnBackgroundTimer] = 1;
1235 List[I_OnUserJoin] = List[I_OnChangeHost] = List[I_OnChangeName] = List[I_OnUserPart] = List[I_OnUserConnect] = 1;
1236 List[I_OnUserQuit] = List[I_OnUserPostNick] = List[I_OnUserKick] = List[I_OnRemoteKill] = List[I_OnRehash] = 1;
1237 List[I_OnOper] = List[I_OnAddGLine] = List[I_OnAddZLine] = List[I_OnAddQLine] = List[I_OnAddELine] = 1;
1238 List[I_OnDelGLine] = List[I_OnDelZLine] = List[I_OnDelQLine] = List[I_OnDelELine] = List[I_ProtoSendMode] = List[I_OnMode] = 1;
1239 List[I_OnStats] = List[I_ProtoSendMetaData] = List[I_OnEvent] = List[I_OnSetAway] = List[I_OnCancelAway] = List[I_OnPostCommand] = 1;
1242 /* It is IMPORTANT that m_spanningtree is the last module in the chain
1243 * so that any activity it sees is FINAL, e.g. we arent going to send out
1244 * a NICK message before m_cloaking has finished putting the +x on the user,
1246 * Therefore, we return PRIORITY_LAST to make sure we end up at the END of
1247 * the module call queue.
1249 Priority ModuleSpanningTree::Prioritize()
1251 return PRIORITY_LAST;
1254 class ModuleSpanningTreeFactory : public ModuleFactory
1257 ModuleSpanningTreeFactory()
1261 ~ModuleSpanningTreeFactory()
1265 virtual Module * CreateModule(InspIRCd* Me)
1267 return new ModuleSpanningTree(Me);
1273 extern "C" void * init_module( void )
1275 return new ModuleSpanningTreeFactory;