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 ModuleSpanningTree::ModuleSpanningTree(InspIRCd* Me)
38 : Module::Module(Me), max_local(0), max_global(0)
40 ServerInstance->UseInterface("InspSocketHook");
41 Utils = new SpanningTreeUtilities(Me, this);
42 command_rconnect = new cmd_rconnect(ServerInstance, this, Utils);
43 ServerInstance->AddCommand(command_rconnect);
44 if (Utils->EnableTimeSync)
46 SyncTimer = new TimeSyncTimer(ServerInstance, this);
47 ServerInstance->Timers->AddTimer(SyncTimer);
53 void ModuleSpanningTree::ShowLinks(TreeServer* Current, userrec* user, int hops)
55 std::string Parent = Utils->TreeRoot->GetName();
56 if (Current->GetParent())
58 Parent = Current->GetParent()->GetName();
60 for (unsigned int q = 0; q < Current->ChildCount(); q++)
62 if ((Utils->HideULines) && (ServerInstance->ULine(Current->GetChild(q)->GetName().c_str())))
66 ShowLinks(Current->GetChild(q),user,hops+1);
71 ShowLinks(Current->GetChild(q),user,hops+1);
74 /* Don't display the line if its a uline, hide ulines is on, and the user isnt an oper */
75 if ((Utils->HideULines) && (ServerInstance->ULine(Current->GetName().c_str())) && (!*user->oper))
77 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());
80 int ModuleSpanningTree::CountLocalServs()
82 return Utils->TreeRoot->ChildCount();
85 int ModuleSpanningTree::CountServs()
87 return Utils->serverlist.size();
90 void ModuleSpanningTree::HandleLinks(const char** parameters, int pcnt, userrec* user)
92 ShowLinks(Utils->TreeRoot,user,0);
93 user->WriteServ("365 %s * :End of /LINKS list.",user->nick);
97 void ModuleSpanningTree::HandleLusers(const char** parameters, int pcnt, userrec* user)
99 unsigned int n_users = ServerInstance->UserCount();
101 /* Only update these when someone wants to see them, more efficient */
102 if ((unsigned int)ServerInstance->LocalUserCount() > max_local)
103 max_local = ServerInstance->LocalUserCount();
104 if (n_users > max_global)
105 max_global = n_users;
107 unsigned int ulined_count = 0;
108 unsigned int ulined_local_count = 0;
110 /* If ulined are hidden and we're not an oper, count the number of ulined servers hidden,
111 * locally and globally (locally means directly connected to us)
113 if ((Utils->HideULines) && (!*user->oper))
115 for (server_hash::iterator q = Utils->serverlist.begin(); q != Utils->serverlist.end(); q++)
117 if (ServerInstance->ULine(q->second->GetName().c_str()))
120 if (q->second->GetParent() == Utils->TreeRoot)
121 ulined_local_count++;
125 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());
126 if (ServerInstance->OperCount())
127 user->WriteServ("252 %s %d :operator(s) online",user->nick,ServerInstance->OperCount());
128 if (ServerInstance->UnregisteredUserCount())
129 user->WriteServ("253 %s %d :unknown connections",user->nick,ServerInstance->UnregisteredUserCount());
130 if (ServerInstance->ChannelCount())
131 user->WriteServ("254 %s %d :channels formed",user->nick,ServerInstance->ChannelCount());
132 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());
133 user->WriteServ("265 %s :Current Local Users: %d Max: %d",user->nick,ServerInstance->LocalUserCount(),max_local);
134 user->WriteServ("266 %s :Current Global Users: %d Max: %d",user->nick,n_users,max_global);
138 // WARNING: NOT THREAD SAFE - DONT GET ANY SMART IDEAS.
139 void ModuleSpanningTree::ShowMap(TreeServer* Current, userrec* user, int depth, char matrix[128][80], float &totusers, float &totservers)
143 for (int t = 0; t < depth; t++)
145 matrix[line][t] = ' ';
147 // For Aligning, we need to work out exactly how deep this thing is, and produce
148 // a 'Spacer' String to compensate.
150 memset(spacer,' ',40);
151 if ((40 - Current->GetName().length() - depth) > 1) {
152 spacer[40 - Current->GetName().length() - depth] = '\0';
160 if (ServerInstance->clientlist->size() == 0) {
161 // If there are no users, WHO THE HELL DID THE /MAP?!?!?!
166 percent = ((float)Current->GetUserCount() / (float)ServerInstance->clientlist->size()) * 100;
168 snprintf(text, 80, "%s %s%5d [%5.2f%%]", Current->GetName().c_str(), spacer, Current->GetUserCount(), percent);
169 totusers += Current->GetUserCount();
171 strlcpy(&matrix[line][depth],text,80);
173 for (unsigned int q = 0; q < Current->ChildCount(); q++)
175 if ((Utils->HideULines) && (ServerInstance->ULine(Current->GetChild(q)->GetName().c_str())))
179 ShowMap(Current->GetChild(q),user,(Utils->FlatLinks && (!*user->oper)) ? depth : depth+2,matrix,totusers,totservers);
184 ShowMap(Current->GetChild(q),user,(Utils->FlatLinks && (!*user->oper)) ? depth : depth+2,matrix,totusers,totservers);
190 int ModuleSpanningTree::HandleMotd(const char** parameters, int pcnt, userrec* user)
194 /* Remote MOTD, the server is within the 1st parameter */
195 std::deque<std::string> params;
196 params.push_back(parameters[0]);
197 /* Send it out remotely, generate no reply yet */
198 TreeServer* s = Utils->FindServerMask(parameters[0]);
201 Utils->DoOneToOne(user->nick, "MOTD", params, s->GetName());
205 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
212 int ModuleSpanningTree::HandleAdmin(const char** parameters, int pcnt, userrec* user)
216 /* Remote ADMIN, the server is within the 1st parameter */
217 std::deque<std::string> params;
218 params.push_back(parameters[0]);
219 /* Send it out remotely, generate no reply yet */
220 TreeServer* s = Utils->FindServerMask(parameters[0]);
223 Utils->DoOneToOne(user->nick, "ADMIN", params, s->GetName());
227 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
234 int ModuleSpanningTree::HandleStats(const char** parameters, int pcnt, userrec* user)
238 /* Remote STATS, the server is within the 2nd parameter */
239 std::deque<std::string> params;
240 params.push_back(parameters[0]);
241 params.push_back(parameters[1]);
242 /* Send it out remotely, generate no reply yet */
243 TreeServer* s = Utils->FindServerMask(parameters[1]);
246 params[1] = s->GetName();
247 Utils->DoOneToOne(user->nick, "STATS", params, s->GetName());
251 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
258 // Ok, prepare to be confused.
259 // After much mulling over how to approach this, it struck me that
260 // the 'usual' way of doing a /MAP isnt the best way. Instead of
261 // keeping track of a ton of ascii characters, and line by line
262 // under recursion working out where to place them using multiplications
263 // and divisons, we instead render the map onto a backplane of characters
264 // (a character matrix), then draw the branches as a series of "L" shapes
265 // from the nodes. This is not only friendlier on CPU it uses less stack.
266 void ModuleSpanningTree::HandleMap(const char** parameters, int pcnt, userrec* user)
268 // This array represents a virtual screen which we will
269 // "scratch" draw to, as the console device of an irc
270 // client does not provide for a proper terminal.
272 float totservers = 0;
273 char matrix[128][80];
274 for (unsigned int t = 0; t < 128; t++)
279 // The only recursive bit is called here.
280 ShowMap(Utils->TreeRoot,user,0,matrix,totusers,totservers);
281 // Process each line one by one. The algorithm has a limit of
282 // 128 servers (which is far more than a spanning tree should have
283 // anyway, so we're ok). This limit can be raised simply by making
284 // the character matrix deeper, 128 rows taking 10k of memory.
285 for (int l = 1; l < line; l++)
287 // scan across the line looking for the start of the
288 // servername (the recursive part of the algorithm has placed
289 // the servers at indented positions depending on what they
291 int first_nonspace = 0;
292 while (matrix[l][first_nonspace] == ' ')
297 // Draw the `- (corner) section: this may be overwritten by
298 // another L shape passing along the same vertical pane, becoming
299 // a |- (branch) section instead.
300 matrix[l][first_nonspace] = '-';
301 matrix[l][first_nonspace-1] = '`';
303 // Draw upwards until we hit the parent server, causing possibly
304 // other corners (`-) to become branches (|-)
305 while ((matrix[l2][first_nonspace-1] == ' ') || (matrix[l2][first_nonspace-1] == '`'))
307 matrix[l2][first_nonspace-1] = '|';
311 // dump the whole lot to the user. This is the easy bit, honest.
312 for (int t = 0; t < line; t++)
314 user->WriteServ("006 %s :%s",user->nick,&matrix[t][0]);
316 float avg_users = totusers / totservers;
317 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);
318 user->WriteServ("007 %s :End of /MAP",user->nick);
322 int ModuleSpanningTree::HandleSquit(const char** parameters, int pcnt, userrec* user)
324 TreeServer* s = Utils->FindServerMask(parameters[0]);
327 if (s == Utils->TreeRoot)
329 user->WriteServ("NOTICE %s :*** SQUIT: Foolish mortal, you cannot make a server SQUIT itself! (%s matches local server name)",user->nick,parameters[0]);
332 TreeSocket* sock = s->GetSocket();
335 ServerInstance->SNO->WriteToSnoMask('l',"SQUIT: Server \002%s\002 removed from network by %s",parameters[0],user->nick);
336 sock->Squit(s,std::string("Server quit by ") + user->GetFullRealHost());
337 ServerInstance->SE->DelFd(sock);
344 std::deque<std::string> params;
345 params.push_back(parameters[0]);
346 params.push_back(std::string(":Server quit by ") + user->GetFullRealHost());
347 Utils->DoOneToOne(user->nick, "RSQUIT", params, parameters[0]);
352 user->WriteServ("NOTICE %s :*** SQUIT: The server \002%s\002 does not exist on the network.",user->nick,parameters[0]);
357 int ModuleSpanningTree::HandleTime(const char** parameters, int pcnt, userrec* user)
359 if ((IS_LOCAL(user)) && (pcnt))
361 TreeServer* found = Utils->FindServerMask(parameters[0]);
364 // we dont' override for local server
365 if (found == Utils->TreeRoot)
368 std::deque<std::string> params;
369 params.push_back(found->GetName());
370 params.push_back(user->nick);
371 Utils->DoOneToOne(ServerInstance->Config->ServerName,"TIME",params,found->GetName());
375 user->WriteServ("402 %s %s :No such server",user->nick,parameters[0]);
381 int ModuleSpanningTree::HandleRemoteWhois(const char** parameters, int pcnt, userrec* user)
383 if ((IS_LOCAL(user)) && (pcnt > 1))
385 userrec* remote = ServerInstance->FindNick(parameters[1]);
386 if ((remote) && (remote->GetFd() < 0))
388 std::deque<std::string> params;
389 params.push_back(parameters[1]);
390 Utils->DoOneToOne(user->nick,"IDLE",params,remote->server);
395 user->WriteServ("401 %s %s :No such nick/channel",user->nick, parameters[1]);
396 user->WriteServ("318 %s %s :End of /WHOIS list.",user->nick, parameters[1]);
403 void ModuleSpanningTree::DoPingChecks(time_t curtime)
405 for (unsigned int j = 0; j < Utils->TreeRoot->ChildCount(); j++)
407 TreeServer* serv = Utils->TreeRoot->GetChild(j);
408 TreeSocket* sock = serv->GetSocket();
411 if (curtime >= serv->NextPingTime())
413 if (serv->AnsweredLastPing())
415 sock->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" PING "+serv->GetName());
416 serv->SetNextPingTime(curtime + 60);
420 // they didnt answer, boot them
421 ServerInstance->SNO->WriteToSnoMask('l',"Server \002%s\002 pinged out",serv->GetName().c_str());
422 sock->Squit(serv,"Ping timeout");
423 ServerInstance->SE->DelFd(sock);
433 void ModuleSpanningTree::ConnectServer(Link* x)
436 /* Do we already have an IP? If so, no need to resolve it. */
437 if (insp_aton(x->IPAddr.c_str(), &binip) > 0)
439 /* Gave a hook, but it wasnt one we know */
440 if ((!x->Hook.empty()) && (Utils->hooks.find(x->Hook.c_str()) == Utils->hooks.end()))
442 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()]);
443 if (newsocket->GetFd() > -1)
445 /* Handled automatically on success */
449 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(),strerror(errno));
451 Utils->DoFailOver(x);
459 ServernameResolver* snr = new ServernameResolver((Module*)this, Utils, ServerInstance,x->IPAddr, *x, cached);
460 ServerInstance->AddResolver(snr, cached);
462 catch (ModuleException& e)
464 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason());
465 Utils->DoFailOver(x);
470 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
472 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
474 if ((x->AutoConnect) && (curtime >= x->NextConnectTime))
476 x->NextConnectTime = curtime + x->AutoConnect;
477 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
478 if (x->FailOver.length())
480 TreeServer* CheckFailOver = Utils->FindServer(x->FailOver.c_str());
483 /* The failover for this server is currently a member of the network.
484 * The failover probably succeeded, where the main link did not.
485 * Don't try the main link until the failover is gone again.
492 // an autoconnected server is not connected. Check if its time to connect it
493 ServerInstance->SNO->WriteToSnoMask('l',"AUTOCONNECT: Auto-connecting server \002%s\002 (%lu seconds until next attempt)",x->Name.c_str(),x->AutoConnect);
494 this->ConnectServer(&(*x));
500 int ModuleSpanningTree::HandleVersion(const char** parameters, int pcnt, userrec* user)
502 // we've already checked if pcnt > 0, so this is safe
503 TreeServer* found = Utils->FindServerMask(parameters[0]);
506 std::string Version = found->GetVersion();
507 user->WriteServ("351 %s :%s",user->nick,Version.c_str());
508 if (found == Utils->TreeRoot)
510 ServerInstance->Config->Send005(user);
515 user->WriteServ("402 %s %s :No such server",user->nick,parameters[0]);
520 int ModuleSpanningTree::HandleConnect(const char** parameters, int pcnt, userrec* user)
522 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
524 if (ServerInstance->MatchText(x->Name.c_str(),parameters[0]))
526 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
529 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);
530 ConnectServer(&(*x));
535 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());
540 user->WriteServ("NOTICE %s :*** CONNECT: No server matching \002%s\002 could be found in the config file.",user->nick,parameters[0]);
544 void ModuleSpanningTree::BroadcastTimeSync()
546 std::deque<std::string> params;
547 params.push_back(ConvToStr(ServerInstance->Time(true)));
548 Utils->DoOneToMany(Utils->TreeRoot->GetName(), "TIMESET", params);
551 int ModuleSpanningTree::OnStats(char statschar, userrec* user, string_list &results)
553 if ((statschar == 'c') || (statschar == 'n'))
555 for (unsigned int i = 0; i < Utils->LinkBlocks.size(); i++)
557 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');
558 if (statschar == 'c')
559 results.push_back(std::string(ServerInstance->Config->ServerName)+" 244 "+user->nick+" H * * "+Utils->LinkBlocks[i].Name.c_str());
561 results.push_back(std::string(ServerInstance->Config->ServerName)+" 219 "+user->nick+" "+statschar+" :End of /STATS report");
562 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);
568 int ModuleSpanningTree::OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line)
570 /* If the command doesnt appear to be valid, we dont want to mess with it. */
573 if (command == "CONNECT")
575 return this->HandleConnect(parameters,pcnt,user);
577 else if (command == "STATS")
579 return this->HandleStats(parameters,pcnt,user);
581 else if (command == "MOTD")
583 return this->HandleMotd(parameters,pcnt,user);
585 else if (command == "ADMIN")
587 return this->HandleAdmin(parameters,pcnt,user);
589 else if (command == "SQUIT")
591 return this->HandleSquit(parameters,pcnt,user);
593 else if (command == "MAP")
595 this->HandleMap(parameters,pcnt,user);
598 else if ((command == "TIME") && (pcnt > 0))
600 return this->HandleTime(parameters,pcnt,user);
602 else if (command == "LUSERS")
604 this->HandleLusers(parameters,pcnt,user);
607 else if (command == "LINKS")
609 this->HandleLinks(parameters,pcnt,user);
612 else if (command == "WHOIS")
617 return this->HandleRemoteWhois(parameters,pcnt,user);
620 else if ((command == "VERSION") && (pcnt > 0))
622 this->HandleVersion(parameters,pcnt,user);
628 void ModuleSpanningTree::OnPostCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, CmdResult result, const std::string &original_line)
630 if ((result == CMD_SUCCESS) && (ServerInstance->IsValidModuleCommand(command, pcnt, user)))
632 // this bit of code cleverly routes all module commands
633 // to all remote severs *automatically* so that modules
634 // can just handle commands locally, without having
635 // to have any special provision in place for remote
636 // commands and linking protocols.
637 std::deque<std::string> params;
639 for (int j = 0; j < pcnt; j++)
641 if (strchr(parameters[j],' '))
643 params.push_back(":" + std::string(parameters[j]));
647 params.push_back(std::string(parameters[j]));
650 Utils->DoOneToMany(user->nick,command,params);
654 void ModuleSpanningTree::OnGetServerDescription(const std::string &servername,std::string &description)
656 TreeServer* s = Utils->FindServer(servername);
659 description = s->GetDesc();
663 void ModuleSpanningTree::OnUserInvite(userrec* source,userrec* dest,chanrec* channel)
665 if (IS_LOCAL(source))
667 std::deque<std::string> params;
668 params.push_back(dest->nick);
669 params.push_back(channel->name);
670 Utils->DoOneToMany(source->nick,"INVITE",params);
674 void ModuleSpanningTree::OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic)
676 std::deque<std::string> params;
677 params.push_back(chan->name);
678 params.push_back(":"+topic);
679 Utils->DoOneToMany(user->nick,"TOPIC",params);
682 void ModuleSpanningTree::OnWallops(userrec* user, const std::string &text)
686 std::deque<std::string> params;
687 params.push_back(":"+text);
688 Utils->DoOneToMany(user->nick,"WALLOPS",params);
692 void ModuleSpanningTree::OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
694 if (target_type == TYPE_USER)
696 userrec* d = (userrec*)dest;
697 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
699 std::deque<std::string> params;
701 params.push_back(d->nick);
702 params.push_back(":"+text);
703 Utils->DoOneToOne(user->nick,"NOTICE",params,d->server);
706 else if (target_type == TYPE_CHANNEL)
710 chanrec *c = (chanrec*)dest;
713 std::string cname = c->name;
715 cname = status + cname;
717 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
718 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
720 TreeSocket* Sock = i->second->GetSocket();
722 Sock->WriteLine(":"+std::string(user->nick)+" NOTICE "+cname+" :"+text);
727 else if (target_type == TYPE_SERVER)
731 char* target = (char*)dest;
732 std::deque<std::string> par;
733 par.push_back(target);
734 par.push_back(":"+text);
735 Utils->DoOneToMany(user->nick,"NOTICE",par);
740 void ModuleSpanningTree::OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
742 if (target_type == TYPE_USER)
744 // route private messages which are targetted at clients only to the server
745 // which needs to receive them
746 userrec* d = (userrec*)dest;
747 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
749 std::deque<std::string> params;
751 params.push_back(d->nick);
752 params.push_back(":"+text);
753 Utils->DoOneToOne(user->nick,"PRIVMSG",params,d->server);
756 else if (target_type == TYPE_CHANNEL)
760 chanrec *c = (chanrec*)dest;
763 std::string cname = c->name;
765 cname = status + cname;
767 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
768 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
770 TreeSocket* Sock = i->second->GetSocket();
772 Sock->WriteLine(":"+std::string(user->nick)+" PRIVMSG "+cname+" :"+text);
777 else if (target_type == TYPE_SERVER)
781 char* target = (char*)dest;
782 std::deque<std::string> par;
783 par.push_back(target);
784 par.push_back(":"+text);
785 Utils->DoOneToMany(user->nick,"PRIVMSG",par);
790 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
792 AutoConnectServers(curtime);
793 DoPingChecks(curtime);
796 void ModuleSpanningTree::OnUserJoin(userrec* user, chanrec* channel)
798 // Only do this for local users
801 if (channel->GetUserCounter() == 1)
803 std::deque<std::string> params;
804 // set up their permissions and the channel TS with FJOIN.
805 // All users are FJOINed now, because a module may specify
806 // new joining permissions for the user.
807 params.push_back(channel->name);
808 params.push_back(ConvToStr(channel->age));
809 params.push_back(std::string(channel->GetAllPrefixChars(user))+","+std::string(user->nick));
810 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FJOIN",params);
811 /* First user in, sync the modes for the channel */
813 /* This is safe, all inspircd servers default to +nt */
814 params.push_back("+nt");
815 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FMODE",params);
819 std::deque<std::string> params;
820 params.push_back(channel->name);
821 params.push_back(ConvToStr(channel->age));
822 Utils->DoOneToMany(user->nick,"JOIN",params);
827 void ModuleSpanningTree::OnChangeHost(userrec* user, const std::string &newhost)
829 // only occurs for local clients
830 if (user->registered != REG_ALL)
832 std::deque<std::string> params;
833 params.push_back(newhost);
834 Utils->DoOneToMany(user->nick,"FHOST",params);
837 void ModuleSpanningTree::OnChangeName(userrec* user, const std::string &gecos)
839 // only occurs for local clients
840 if (user->registered != REG_ALL)
842 std::deque<std::string> params;
843 params.push_back(gecos);
844 Utils->DoOneToMany(user->nick,"FNAME",params);
847 void ModuleSpanningTree::OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage)
851 std::deque<std::string> params;
852 params.push_back(channel->name);
853 if (partmessage != "")
854 params.push_back(":"+partmessage);
855 Utils->DoOneToMany(user->nick,"PART",params);
859 void ModuleSpanningTree::OnUserConnect(userrec* user)
864 std::deque<std::string> params;
865 snprintf(agestr,MAXBUF,"%lu",(unsigned long)user->age);
866 params.push_back(agestr);
867 params.push_back(user->nick);
868 params.push_back(user->host);
869 params.push_back(user->dhost);
870 params.push_back(user->ident);
871 params.push_back("+"+std::string(user->FormatModes()));
872 params.push_back(user->GetIPString());
873 params.push_back(":"+std::string(user->fullname));
874 Utils->DoOneToMany(ServerInstance->Config->ServerName,"NICK",params);
875 // User is Local, change needs to be reflected!
876 TreeServer* SourceServer = Utils->FindServer(user->server);
879 SourceServer->AddUserCount();
884 void ModuleSpanningTree::OnUserQuit(userrec* user, const std::string &reason)
886 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
888 std::deque<std::string> params;
889 params.push_back(":"+reason);
890 Utils->DoOneToMany(user->nick,"QUIT",params);
892 // Regardless, We need to modify the user Counts..
893 TreeServer* SourceServer = Utils->FindServer(user->server);
896 SourceServer->DelUserCount();
900 void ModuleSpanningTree::OnUserPostNick(userrec* user, const std::string &oldnick)
904 std::deque<std::string> params;
905 params.push_back(user->nick);
906 Utils->DoOneToMany(oldnick,"NICK",params);
910 void ModuleSpanningTree::OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason)
912 if ((source) && (IS_LOCAL(source)))
914 std::deque<std::string> params;
915 params.push_back(chan->name);
916 params.push_back(user->nick);
917 params.push_back(":"+reason);
918 Utils->DoOneToMany(source->nick,"KICK",params);
922 std::deque<std::string> params;
923 params.push_back(chan->name);
924 params.push_back(user->nick);
925 params.push_back(":"+reason);
926 Utils->DoOneToMany(ServerInstance->Config->ServerName,"KICK",params);
930 void ModuleSpanningTree::OnRemoteKill(userrec* source, userrec* dest, const std::string &reason)
932 std::deque<std::string> params;
933 params.push_back(dest->nick);
934 params.push_back(":"+reason);
935 Utils->DoOneToMany(source->nick,"KILL",params);
938 void ModuleSpanningTree::OnRehash(userrec* user, const std::string ¶meter)
942 std::deque<std::string> params;
943 params.push_back(parameter);
944 Utils->DoOneToMany(user ? user->nick : ServerInstance->Config->ServerName, "REHASH", params);
946 if (ServerInstance->MatchText(ServerInstance->Config->ServerName,parameter))
948 ServerInstance->WriteOpers("*** Remote rehash initiated locally by \002%s\002", user ? user->nick : ServerInstance->Config->ServerName);
949 ServerInstance->RehashServer();
952 Utils->ReadConfiguration(false);
953 InitializeDisabledCommands(ServerInstance->Config->DisabledCommands, ServerInstance);
956 // note: the protocol does not allow direct umode +o except
957 // via NICK with 8 params. sending OPERTYPE infers +o modechange
959 void ModuleSpanningTree::OnOper(userrec* user, const std::string &opertype)
963 std::deque<std::string> params;
964 params.push_back(opertype);
965 Utils->DoOneToMany(user->nick,"OPERTYPE",params);
969 void ModuleSpanningTree::OnLine(userrec* source, const std::string &host, bool adding, char linetype, long duration, const std::string &reason)
973 /* Server-set lines */
975 snprintf(data,MAXBUF,"%c %s %s %lu %lu :%s", linetype, host.c_str(), ServerInstance->Config->ServerName, (unsigned long)ServerInstance->Time(false),
976 (unsigned long)duration, reason.c_str());
977 std::deque<std::string> params;
978 params.push_back(data);
979 Utils->DoOneToMany(ServerInstance->Config->ServerName, "ADDLINE", params);
983 if (IS_LOCAL(source))
986 snprintf(type,8,"%cLINE",linetype);
987 std::string stype = type;
990 char sduration[MAXBUF];
991 snprintf(sduration,MAXBUF,"%ld",duration);
992 std::deque<std::string> params;
993 params.push_back(host);
994 params.push_back(sduration);
995 params.push_back(":"+reason);
996 Utils->DoOneToMany(source->nick,stype,params);
1000 std::deque<std::string> params;
1001 params.push_back(host);
1002 Utils->DoOneToMany(source->nick,stype,params);
1008 void ModuleSpanningTree::OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask)
1010 OnLine(source,hostmask,true,'G',duration,reason);
1013 void ModuleSpanningTree::OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask)
1015 OnLine(source,ipmask,true,'Z',duration,reason);
1018 void ModuleSpanningTree::OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask)
1020 OnLine(source,nickmask,true,'Q',duration,reason);
1023 void ModuleSpanningTree::OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask)
1025 OnLine(source,hostmask,true,'E',duration,reason);
1028 void ModuleSpanningTree::OnDelGLine(userrec* source, const std::string &hostmask)
1030 OnLine(source,hostmask,false,'G',0,"");
1033 void ModuleSpanningTree::OnDelZLine(userrec* source, const std::string &ipmask)
1035 OnLine(source,ipmask,false,'Z',0,"");
1038 void ModuleSpanningTree::OnDelQLine(userrec* source, const std::string &nickmask)
1040 OnLine(source,nickmask,false,'Q',0,"");
1043 void ModuleSpanningTree::OnDelELine(userrec* source, const std::string &hostmask)
1045 OnLine(source,hostmask,false,'E',0,"");
1048 void ModuleSpanningTree::OnMode(userrec* user, void* dest, int target_type, const std::string &text)
1050 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
1052 if (target_type == TYPE_USER)
1054 userrec* u = (userrec*)dest;
1055 std::deque<std::string> params;
1056 params.push_back(u->nick);
1057 params.push_back(text);
1058 Utils->DoOneToMany(user->nick,"MODE",params);
1062 chanrec* c = (chanrec*)dest;
1063 std::deque<std::string> params;
1064 params.push_back(c->name);
1065 params.push_back(text);
1066 Utils->DoOneToMany(user->nick,"MODE",params);
1071 void ModuleSpanningTree::OnSetAway(userrec* user)
1075 std::deque<std::string> params;
1076 params.push_back(":"+std::string(user->awaymsg));
1077 Utils->DoOneToMany(user->nick,"AWAY",params);
1081 void ModuleSpanningTree::OnCancelAway(userrec* user)
1085 std::deque<std::string> params;
1087 Utils->DoOneToMany(user->nick,"AWAY",params);
1091 void ModuleSpanningTree::ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline)
1093 TreeSocket* s = (TreeSocket*)opaque;
1096 if (target_type == TYPE_USER)
1098 userrec* u = (userrec*)target;
1099 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" FMODE "+u->nick+" "+ConvToStr(u->age)+" "+modeline);
1103 chanrec* c = (chanrec*)target;
1104 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" FMODE "+c->name+" "+ConvToStr(c->age)+" "+modeline);
1109 void ModuleSpanningTree::ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata)
1111 TreeSocket* s = (TreeSocket*)opaque;
1114 if (target_type == TYPE_USER)
1116 userrec* u = (userrec*)target;
1117 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA "+u->nick+" "+extname+" :"+extdata);
1119 else if (target_type == TYPE_CHANNEL)
1121 chanrec* c = (chanrec*)target;
1122 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA "+c->name+" "+extname+" :"+extdata);
1125 if (target_type == TYPE_OTHER)
1127 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA * "+extname+" :"+extdata);
1131 void ModuleSpanningTree::OnEvent(Event* event)
1133 std::deque<std::string>* params = (std::deque<std::string>*)event->GetData();
1134 if (event->GetEventID() == "send_metadata")
1136 if (params->size() < 3)
1138 (*params)[2] = ":" + (*params)[2];
1139 Utils->DoOneToMany(ServerInstance->Config->ServerName,"METADATA",*params);
1141 else if (event->GetEventID() == "send_topic")
1143 if (params->size() < 2)
1145 (*params)[1] = ":" + (*params)[1];
1146 params->insert(params->begin() + 1,ServerInstance->Config->ServerName);
1147 params->insert(params->begin() + 1,ConvToStr(ServerInstance->Time(true)));
1148 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FTOPIC",*params);
1150 else if (event->GetEventID() == "send_mode")
1152 if (params->size() < 2)
1154 // Insert the TS value of the object, either userrec or chanrec
1156 userrec* a = ServerInstance->FindNick((*params)[0]);
1163 chanrec* a = ServerInstance->FindChan((*params)[0]);
1169 params->insert(params->begin() + 1,ConvToStr(ourTS));
1170 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FMODE",*params);
1172 else if (event->GetEventID() == "send_mode_explicit")
1174 if (params->size() < 2)
1176 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODE",*params);
1178 else if (event->GetEventID() == "send_opers")
1180 if (params->size() < 1)
1182 (*params)[0] = ":" + (*params)[0];
1183 Utils->DoOneToMany(ServerInstance->Config->ServerName,"OPERNOTICE",*params);
1185 else if (event->GetEventID() == "send_modeset")
1187 if (params->size() < 2)
1189 (*params)[1] = ":" + (*params)[1];
1190 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODENOTICE",*params);
1192 else if (event->GetEventID() == "send_snoset")
1194 if (params->size() < 2)
1196 (*params)[1] = ":" + (*params)[1];
1197 Utils->DoOneToMany(ServerInstance->Config->ServerName,"SNONOTICE",*params);
1199 else if (event->GetEventID() == "send_push")
1201 if (params->size() < 2)
1204 userrec *a = ServerInstance->FindNick((*params)[0]);
1209 (*params)[1] = ":" + (*params)[1];
1210 Utils->DoOneToOne(ServerInstance->Config->ServerName, "PUSH", *params, a->server);
1214 ModuleSpanningTree::~ModuleSpanningTree()
1216 /* This will also free the listeners */
1219 ServerInstance->Timers->DelTimer(SyncTimer);
1221 ServerInstance->DoneWithInterface("InspSocketHook");
1224 Version ModuleSpanningTree::GetVersion()
1226 return Version(1,1,0,2,VF_VENDOR,API_VERSION);
1229 void ModuleSpanningTree::Implements(char* List)
1231 List[I_OnPreCommand] = List[I_OnGetServerDescription] = List[I_OnUserInvite] = List[I_OnPostLocalTopicChange] = 1;
1232 List[I_OnWallops] = List[I_OnUserNotice] = List[I_OnUserMessage] = List[I_OnBackgroundTimer] = 1;
1233 List[I_OnUserJoin] = List[I_OnChangeHost] = List[I_OnChangeName] = List[I_OnUserPart] = List[I_OnUserConnect] = 1;
1234 List[I_OnUserQuit] = List[I_OnUserPostNick] = List[I_OnUserKick] = List[I_OnRemoteKill] = List[I_OnRehash] = 1;
1235 List[I_OnOper] = List[I_OnAddGLine] = List[I_OnAddZLine] = List[I_OnAddQLine] = List[I_OnAddELine] = 1;
1236 List[I_OnDelGLine] = List[I_OnDelZLine] = List[I_OnDelQLine] = List[I_OnDelELine] = List[I_ProtoSendMode] = List[I_OnMode] = 1;
1237 List[I_OnStats] = List[I_ProtoSendMetaData] = List[I_OnEvent] = List[I_OnSetAway] = List[I_OnCancelAway] = List[I_OnPostCommand] = 1;
1240 /* It is IMPORTANT that m_spanningtree is the last module in the chain
1241 * so that any activity it sees is FINAL, e.g. we arent going to send out
1242 * a NICK message before m_cloaking has finished putting the +x on the user,
1244 * Therefore, we return PRIORITY_LAST to make sure we end up at the END of
1245 * the module call queue.
1247 Priority ModuleSpanningTree::Prioritize()
1249 return PRIORITY_LAST;
1252 class ModuleSpanningTreeFactory : public ModuleFactory
1255 ModuleSpanningTreeFactory()
1259 ~ModuleSpanningTreeFactory()
1263 virtual Module * CreateModule(InspIRCd* Me)
1265 return new ModuleSpanningTree(Me);
1271 extern "C" void * init_module( void )
1273 return new ModuleSpanningTreeFactory;