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]);
202 Utils->DoOneToOne(user->nick, "MOTD", params, s->GetName());
204 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
210 int ModuleSpanningTree::HandleAdmin(const char** parameters, int pcnt, userrec* user)
214 /* Remote ADMIN, the server is within the 1st parameter */
215 std::deque<std::string> params;
216 params.push_back(parameters[0]);
217 /* Send it out remotely, generate no reply yet */
218 TreeServer* s = Utils->FindServerMask(parameters[0]);
220 Utils->DoOneToOne(user->nick, "ADMIN", params, s->GetName());
222 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
228 int ModuleSpanningTree::HandleModules(const char** parameters, int pcnt, userrec* user)
230 std::deque<std::string> params;
231 params.push_back(parameters[0]);
232 TreeServer* s = Utils->FindServerMask(parameters[0]);
234 Utils->DoOneToOne(user->nick, "MODULES", params, s->GetName());
236 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
240 int ModuleSpanningTree::HandleStats(const char** parameters, int pcnt, userrec* user)
244 /* Remote STATS, the server is within the 2nd parameter */
245 std::deque<std::string> params;
246 params.push_back(parameters[0]);
247 params.push_back(parameters[1]);
248 /* Send it out remotely, generate no reply yet */
249 TreeServer* s = Utils->FindServerMask(parameters[1]);
252 params[1] = s->GetName();
253 Utils->DoOneToOne(user->nick, "STATS", params, s->GetName());
256 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
262 // Ok, prepare to be confused.
263 // After much mulling over how to approach this, it struck me that
264 // the 'usual' way of doing a /MAP isnt the best way. Instead of
265 // keeping track of a ton of ascii characters, and line by line
266 // under recursion working out where to place them using multiplications
267 // and divisons, we instead render the map onto a backplane of characters
268 // (a character matrix), then draw the branches as a series of "L" shapes
269 // from the nodes. This is not only friendlier on CPU it uses less stack.
270 void ModuleSpanningTree::HandleMap(const char** parameters, int pcnt, userrec* user)
272 // This array represents a virtual screen which we will
273 // "scratch" draw to, as the console device of an irc
274 // client does not provide for a proper terminal.
276 float totservers = 0;
277 char matrix[128][80];
278 for (unsigned int t = 0; t < 128; t++)
283 // The only recursive bit is called here.
284 ShowMap(Utils->TreeRoot,user,0,matrix,totusers,totservers);
285 // Process each line one by one. The algorithm has a limit of
286 // 128 servers (which is far more than a spanning tree should have
287 // anyway, so we're ok). This limit can be raised simply by making
288 // the character matrix deeper, 128 rows taking 10k of memory.
289 for (int l = 1; l < line; l++)
291 // scan across the line looking for the start of the
292 // servername (the recursive part of the algorithm has placed
293 // the servers at indented positions depending on what they
295 int first_nonspace = 0;
296 while (matrix[l][first_nonspace] == ' ')
301 // Draw the `- (corner) section: this may be overwritten by
302 // another L shape passing along the same vertical pane, becoming
303 // a |- (branch) section instead.
304 matrix[l][first_nonspace] = '-';
305 matrix[l][first_nonspace-1] = '`';
307 // Draw upwards until we hit the parent server, causing possibly
308 // other corners (`-) to become branches (|-)
309 while ((matrix[l2][first_nonspace-1] == ' ') || (matrix[l2][first_nonspace-1] == '`'))
311 matrix[l2][first_nonspace-1] = '|';
315 // dump the whole lot to the user. This is the easy bit, honest.
316 for (int t = 0; t < line; t++)
318 user->WriteServ("006 %s :%s",user->nick,&matrix[t][0]);
320 float avg_users = totusers / totservers;
321 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);
322 user->WriteServ("007 %s :End of /MAP",user->nick);
326 int ModuleSpanningTree::HandleSquit(const char** parameters, int pcnt, userrec* user)
328 TreeServer* s = Utils->FindServerMask(parameters[0]);
331 if (s == Utils->TreeRoot)
333 user->WriteServ("NOTICE %s :*** SQUIT: Foolish mortal, you cannot make a server SQUIT itself! (%s matches local server name)",user->nick,parameters[0]);
336 TreeSocket* sock = s->GetSocket();
339 ServerInstance->SNO->WriteToSnoMask('l',"SQUIT: Server \002%s\002 removed from network by %s",parameters[0],user->nick);
340 sock->Squit(s,std::string("Server quit by ") + user->GetFullRealHost());
341 ServerInstance->SE->DelFd(sock);
348 std::deque<std::string> params;
349 params.push_back(parameters[0]);
350 params.push_back(std::string(":Server quit by ") + user->GetFullRealHost());
351 Utils->DoOneToOne(user->nick, "RSQUIT", params, parameters[0]);
356 user->WriteServ("NOTICE %s :*** SQUIT: The server \002%s\002 does not exist on the network.",user->nick,parameters[0]);
361 int ModuleSpanningTree::HandleTime(const char** parameters, int pcnt, userrec* user)
363 if ((IS_LOCAL(user)) && (pcnt))
365 TreeServer* found = Utils->FindServerMask(parameters[0]);
368 // we dont' override for local server
369 if (found == Utils->TreeRoot)
372 std::deque<std::string> params;
373 params.push_back(found->GetName());
374 params.push_back(user->nick);
375 Utils->DoOneToOne(ServerInstance->Config->ServerName,"TIME",params,found->GetName());
379 user->WriteServ("402 %s %s :No such server",user->nick,parameters[0]);
385 int ModuleSpanningTree::HandleRemoteWhois(const char** parameters, int pcnt, userrec* user)
387 if ((IS_LOCAL(user)) && (pcnt > 1))
389 userrec* remote = ServerInstance->FindNick(parameters[1]);
390 if ((remote) && (remote->GetFd() < 0))
392 std::deque<std::string> params;
393 params.push_back(parameters[1]);
394 Utils->DoOneToOne(user->nick,"IDLE",params,remote->server);
399 user->WriteServ("401 %s %s :No such nick/channel",user->nick, parameters[1]);
400 user->WriteServ("318 %s %s :End of /WHOIS list.",user->nick, parameters[1]);
407 void ModuleSpanningTree::DoPingChecks(time_t curtime)
409 for (unsigned int j = 0; j < Utils->TreeRoot->ChildCount(); j++)
411 TreeServer* serv = Utils->TreeRoot->GetChild(j);
412 TreeSocket* sock = serv->GetSocket();
415 if (curtime >= serv->NextPingTime())
417 if (serv->AnsweredLastPing())
419 sock->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" PING "+serv->GetName());
420 serv->SetNextPingTime(curtime + 60);
424 // they didnt answer, boot them
425 ServerInstance->SNO->WriteToSnoMask('l',"Server \002%s\002 pinged out",serv->GetName().c_str());
426 sock->Squit(serv,"Ping timeout");
427 ServerInstance->SE->DelFd(sock);
437 void ModuleSpanningTree::ConnectServer(Link* x)
440 QueryType start_type = DNS_QUERY_A;
442 start_type = DNS_QUERY_AAAA;
443 if (strchr(x->IPAddr.c_str(),':'))
446 if (inet_pton(AF_INET6, x->IPAddr.c_str(), &n) < 1)
452 if (inet_aton(x->IPAddr.c_str(),&n) < 1)
457 if (inet_aton(x->IPAddr.c_str(),&n) < 1)
461 /* Do we already have an IP? If so, no need to resolve it. */
464 /* Gave a hook, but it wasnt one we know */
465 if ((!x->Hook.empty()) && (Utils->hooks.find(x->Hook.c_str()) == Utils->hooks.end()))
467 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()]);
468 if (newsocket->GetFd() > -1)
470 /* Handled automatically on success */
474 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(),strerror(errno));
476 Utils->DoFailOver(x);
484 ServernameResolver* snr = new ServernameResolver((Module*)this, Utils, ServerInstance,x->IPAddr, *x, cached, start_type);
485 ServerInstance->AddResolver(snr, cached);
487 catch (ModuleException& e)
489 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason());
490 Utils->DoFailOver(x);
495 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
497 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
499 if ((x->AutoConnect) && (curtime >= x->NextConnectTime))
501 x->NextConnectTime = curtime + x->AutoConnect;
502 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
503 if (x->FailOver.length())
505 TreeServer* CheckFailOver = Utils->FindServer(x->FailOver.c_str());
508 /* The failover for this server is currently a member of the network.
509 * The failover probably succeeded, where the main link did not.
510 * Don't try the main link until the failover is gone again.
517 // an autoconnected server is not connected. Check if its time to connect it
518 ServerInstance->SNO->WriteToSnoMask('l',"AUTOCONNECT: Auto-connecting server \002%s\002 (%lu seconds until next attempt)",x->Name.c_str(),x->AutoConnect);
519 this->ConnectServer(&(*x));
525 int ModuleSpanningTree::HandleVersion(const char** parameters, int pcnt, userrec* user)
527 // we've already checked if pcnt > 0, so this is safe
528 TreeServer* found = Utils->FindServerMask(parameters[0]);
531 std::string Version = found->GetVersion();
532 user->WriteServ("351 %s :%s",user->nick,Version.c_str());
533 if (found == Utils->TreeRoot)
535 ServerInstance->Config->Send005(user);
540 user->WriteServ("402 %s %s :No such server",user->nick,parameters[0]);
545 int ModuleSpanningTree::HandleConnect(const char** parameters, int pcnt, userrec* user)
547 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
549 if (ServerInstance->MatchText(x->Name.c_str(),parameters[0]))
551 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
554 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);
555 ConnectServer(&(*x));
560 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());
565 user->WriteServ("NOTICE %s :*** CONNECT: No server matching \002%s\002 could be found in the config file.",user->nick,parameters[0]);
569 void ModuleSpanningTree::BroadcastTimeSync()
571 if (Utils->MasterTime)
573 std::deque<std::string> params;
574 params.push_back(ConvToStr(ServerInstance->Time(false)));
575 params.push_back("FORCE");
576 Utils->DoOneToMany(Utils->TreeRoot->GetName(), "TIMESET", params);
580 int ModuleSpanningTree::OnStats(char statschar, userrec* user, string_list &results)
582 if ((statschar == 'c') || (statschar == 'n'))
584 for (unsigned int i = 0; i < Utils->LinkBlocks.size(); i++)
586 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');
587 if (statschar == 'c')
588 results.push_back(std::string(ServerInstance->Config->ServerName)+" 244 "+user->nick+" H * * "+Utils->LinkBlocks[i].Name.c_str());
590 results.push_back(std::string(ServerInstance->Config->ServerName)+" 219 "+user->nick+" "+statschar+" :End of /STATS report");
591 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);
597 int ModuleSpanningTree::OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line)
599 /* If the command doesnt appear to be valid, we dont want to mess with it. */
602 if (command == "CONNECT")
604 return this->HandleConnect(parameters,pcnt,user);
606 else if (command == "STATS")
608 return this->HandleStats(parameters,pcnt,user);
610 else if (command == "MOTD")
612 return this->HandleMotd(parameters,pcnt,user);
614 else if (command == "ADMIN")
616 return this->HandleAdmin(parameters,pcnt,user);
618 else if (command == "SQUIT")
620 return this->HandleSquit(parameters,pcnt,user);
622 else if (command == "MAP")
624 this->HandleMap(parameters,pcnt,user);
627 else if ((command == "TIME") && (pcnt > 0))
629 return this->HandleTime(parameters,pcnt,user);
631 else if (command == "LUSERS")
633 this->HandleLusers(parameters,pcnt,user);
636 else if (command == "LINKS")
638 this->HandleLinks(parameters,pcnt,user);
641 else if (command == "WHOIS")
646 return this->HandleRemoteWhois(parameters,pcnt,user);
649 else if ((command == "VERSION") && (pcnt > 0))
651 this->HandleVersion(parameters,pcnt,user);
654 else if ((command == "MODULES") && (pcnt > 0))
656 this->HandleModules(parameters,pcnt,user);
662 void ModuleSpanningTree::OnPostCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, CmdResult result, const std::string &original_line)
664 if ((result == CMD_SUCCESS) && (ServerInstance->IsValidModuleCommand(command, pcnt, user)))
666 // this bit of code cleverly routes all module commands
667 // to all remote severs *automatically* so that modules
668 // can just handle commands locally, without having
669 // to have any special provision in place for remote
670 // commands and linking protocols.
671 std::deque<std::string> params;
673 for (int j = 0; j < pcnt; j++)
675 if (strchr(parameters[j],' '))
677 params.push_back(":" + std::string(parameters[j]));
681 params.push_back(std::string(parameters[j]));
684 Utils->DoOneToMany(user->nick,command,params);
688 void ModuleSpanningTree::OnGetServerDescription(const std::string &servername,std::string &description)
690 TreeServer* s = Utils->FindServer(servername);
693 description = s->GetDesc();
697 void ModuleSpanningTree::OnUserInvite(userrec* source,userrec* dest,chanrec* channel)
699 if (IS_LOCAL(source))
701 std::deque<std::string> params;
702 params.push_back(dest->nick);
703 params.push_back(channel->name);
704 Utils->DoOneToMany(source->nick,"INVITE",params);
708 void ModuleSpanningTree::OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic)
710 std::deque<std::string> params;
711 params.push_back(chan->name);
712 params.push_back(":"+topic);
713 Utils->DoOneToMany(user->nick,"TOPIC",params);
716 void ModuleSpanningTree::OnWallops(userrec* user, const std::string &text)
720 std::deque<std::string> params;
721 params.push_back(":"+text);
722 Utils->DoOneToMany(user->nick,"WALLOPS",params);
726 void ModuleSpanningTree::OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
728 if (target_type == TYPE_USER)
730 userrec* d = (userrec*)dest;
731 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
733 std::deque<std::string> params;
735 params.push_back(d->nick);
736 params.push_back(":"+text);
737 Utils->DoOneToOne(user->nick,"NOTICE",params,d->server);
740 else if (target_type == TYPE_CHANNEL)
744 chanrec *c = (chanrec*)dest;
747 std::string cname = c->name;
749 cname = status + cname;
751 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
752 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
754 TreeSocket* Sock = i->second->GetSocket();
756 Sock->WriteLine(":"+std::string(user->nick)+" NOTICE "+cname+" :"+text);
761 else if (target_type == TYPE_SERVER)
765 char* target = (char*)dest;
766 std::deque<std::string> par;
767 par.push_back(target);
768 par.push_back(":"+text);
769 Utils->DoOneToMany(user->nick,"NOTICE",par);
774 void ModuleSpanningTree::OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
776 if (target_type == TYPE_USER)
778 // route private messages which are targetted at clients only to the server
779 // which needs to receive them
780 userrec* d = (userrec*)dest;
781 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
783 std::deque<std::string> params;
785 params.push_back(d->nick);
786 params.push_back(":"+text);
787 Utils->DoOneToOne(user->nick,"PRIVMSG",params,d->server);
790 else if (target_type == TYPE_CHANNEL)
794 chanrec *c = (chanrec*)dest;
797 std::string cname = c->name;
799 cname = status + cname;
801 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
802 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
804 TreeSocket* Sock = i->second->GetSocket();
806 Sock->WriteLine(":"+std::string(user->nick)+" PRIVMSG "+cname+" :"+text);
811 else if (target_type == TYPE_SERVER)
815 char* target = (char*)dest;
816 std::deque<std::string> par;
817 par.push_back(target);
818 par.push_back(":"+text);
819 Utils->DoOneToMany(user->nick,"PRIVMSG",par);
824 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
826 AutoConnectServers(curtime);
827 DoPingChecks(curtime);
830 void ModuleSpanningTree::OnUserJoin(userrec* user, chanrec* channel)
832 // Only do this for local users
835 if (channel->GetUserCounter() == 1)
837 std::deque<std::string> params;
838 // set up their permissions and the channel TS with FJOIN.
839 // All users are FJOINed now, because a module may specify
840 // new joining permissions for the user.
841 params.push_back(channel->name);
842 params.push_back(ConvToStr(channel->age));
843 params.push_back(std::string(channel->GetAllPrefixChars(user))+","+std::string(user->nick));
844 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FJOIN",params);
845 /* First user in, sync the modes for the channel */
847 /* This is safe, all inspircd servers default to +nt */
848 params.push_back("+nt");
849 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FMODE",params);
853 std::deque<std::string> params;
854 params.push_back(channel->name);
855 params.push_back(ConvToStr(channel->age));
856 Utils->DoOneToMany(user->nick,"JOIN",params);
861 void ModuleSpanningTree::OnChangeHost(userrec* user, const std::string &newhost)
863 // only occurs for local clients
864 if (user->registered != REG_ALL)
866 std::deque<std::string> params;
867 params.push_back(newhost);
868 Utils->DoOneToMany(user->nick,"FHOST",params);
871 void ModuleSpanningTree::OnChangeName(userrec* user, const std::string &gecos)
873 // only occurs for local clients
874 if (user->registered != REG_ALL)
876 std::deque<std::string> params;
877 params.push_back(gecos);
878 Utils->DoOneToMany(user->nick,"FNAME",params);
881 void ModuleSpanningTree::OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage)
885 std::deque<std::string> params;
886 params.push_back(channel->name);
887 if (partmessage != "")
888 params.push_back(":"+partmessage);
889 Utils->DoOneToMany(user->nick,"PART",params);
893 void ModuleSpanningTree::OnUserConnect(userrec* user)
898 std::deque<std::string> params;
899 snprintf(agestr,MAXBUF,"%lu",(unsigned long)user->age);
900 params.push_back(agestr);
901 params.push_back(user->nick);
902 params.push_back(user->host);
903 params.push_back(user->dhost);
904 params.push_back(user->ident);
905 params.push_back("+"+std::string(user->FormatModes()));
906 params.push_back(user->GetIPString());
907 params.push_back(":"+std::string(user->fullname));
908 Utils->DoOneToMany(ServerInstance->Config->ServerName,"NICK",params);
909 // User is Local, change needs to be reflected!
910 TreeServer* SourceServer = Utils->FindServer(user->server);
913 SourceServer->AddUserCount();
918 void ModuleSpanningTree::OnUserQuit(userrec* user, const std::string &reason, const std::string &oper_message)
920 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
922 std::deque<std::string> params;
924 if (oper_message != reason)
926 params.push_back(":"+oper_message);
927 Utils->DoOneToMany(user->nick,"OPERQUIT",params);
930 params.push_back(":"+reason);
931 Utils->DoOneToMany(user->nick,"QUIT",params);
933 // Regardless, We need to modify the user Counts..
934 TreeServer* SourceServer = Utils->FindServer(user->server);
937 SourceServer->DelUserCount();
941 void ModuleSpanningTree::OnUserPostNick(userrec* user, const std::string &oldnick)
945 std::deque<std::string> params;
946 params.push_back(user->nick);
947 Utils->DoOneToMany(oldnick,"NICK",params);
951 void ModuleSpanningTree::OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason)
953 if ((source) && (IS_LOCAL(source)))
955 std::deque<std::string> params;
956 params.push_back(chan->name);
957 params.push_back(user->nick);
958 params.push_back(":"+reason);
959 Utils->DoOneToMany(source->nick,"KICK",params);
963 std::deque<std::string> params;
964 params.push_back(chan->name);
965 params.push_back(user->nick);
966 params.push_back(":"+reason);
967 Utils->DoOneToMany(ServerInstance->Config->ServerName,"KICK",params);
971 void ModuleSpanningTree::OnRemoteKill(userrec* source, userrec* dest, const std::string &reason)
973 std::deque<std::string> params;
974 params.push_back(dest->nick);
975 params.push_back(":"+reason);
976 Utils->DoOneToMany(source->nick,"KILL",params);
979 void ModuleSpanningTree::OnRehash(userrec* user, const std::string ¶meter)
983 std::deque<std::string> params;
984 params.push_back(parameter);
985 Utils->DoOneToMany(user ? user->nick : ServerInstance->Config->ServerName, "REHASH", params);
987 if (ServerInstance->MatchText(ServerInstance->Config->ServerName,parameter))
989 ServerInstance->WriteOpers("*** Remote rehash initiated locally by \002%s\002", user ? user->nick : ServerInstance->Config->ServerName);
990 ServerInstance->RehashServer();
993 Utils->ReadConfiguration(false);
994 InitializeDisabledCommands(ServerInstance->Config->DisabledCommands, ServerInstance);
997 // note: the protocol does not allow direct umode +o except
998 // via NICK with 8 params. sending OPERTYPE infers +o modechange
1000 void ModuleSpanningTree::OnOper(userrec* user, const std::string &opertype)
1004 std::deque<std::string> params;
1005 params.push_back(opertype);
1006 Utils->DoOneToMany(user->nick,"OPERTYPE",params);
1010 void ModuleSpanningTree::OnLine(userrec* source, const std::string &host, bool adding, char linetype, long duration, const std::string &reason)
1014 /* Server-set lines */
1016 snprintf(data,MAXBUF,"%c %s %s %lu %lu :%s", linetype, host.c_str(), ServerInstance->Config->ServerName, (unsigned long)ServerInstance->Time(false),
1017 (unsigned long)duration, reason.c_str());
1018 std::deque<std::string> params;
1019 params.push_back(data);
1020 Utils->DoOneToMany(ServerInstance->Config->ServerName, "ADDLINE", params);
1024 if (IS_LOCAL(source))
1027 snprintf(type,8,"%cLINE",linetype);
1028 std::string stype = type;
1031 char sduration[MAXBUF];
1032 snprintf(sduration,MAXBUF,"%ld",duration);
1033 std::deque<std::string> params;
1034 params.push_back(host);
1035 params.push_back(sduration);
1036 params.push_back(":"+reason);
1037 Utils->DoOneToMany(source->nick,stype,params);
1041 std::deque<std::string> params;
1042 params.push_back(host);
1043 Utils->DoOneToMany(source->nick,stype,params);
1049 void ModuleSpanningTree::OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask)
1051 OnLine(source,hostmask,true,'G',duration,reason);
1054 void ModuleSpanningTree::OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask)
1056 OnLine(source,ipmask,true,'Z',duration,reason);
1059 void ModuleSpanningTree::OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask)
1061 OnLine(source,nickmask,true,'Q',duration,reason);
1064 void ModuleSpanningTree::OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask)
1066 OnLine(source,hostmask,true,'E',duration,reason);
1069 void ModuleSpanningTree::OnDelGLine(userrec* source, const std::string &hostmask)
1071 OnLine(source,hostmask,false,'G',0,"");
1074 void ModuleSpanningTree::OnDelZLine(userrec* source, const std::string &ipmask)
1076 OnLine(source,ipmask,false,'Z',0,"");
1079 void ModuleSpanningTree::OnDelQLine(userrec* source, const std::string &nickmask)
1081 OnLine(source,nickmask,false,'Q',0,"");
1084 void ModuleSpanningTree::OnDelELine(userrec* source, const std::string &hostmask)
1086 OnLine(source,hostmask,false,'E',0,"");
1089 void ModuleSpanningTree::OnMode(userrec* user, void* dest, int target_type, const std::string &text)
1091 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
1093 std::deque<std::string> params;
1094 std::string command;
1096 if (target_type == TYPE_USER)
1098 userrec* u = (userrec*)dest;
1099 params.push_back(u->nick);
1100 params.push_back(text);
1105 chanrec* c = (chanrec*)dest;
1106 params.push_back(c->name);
1107 params.push_back(ConvToStr(c->age));
1108 params.push_back(text);
1111 Utils->DoOneToMany(user->nick, command, params);
1115 void ModuleSpanningTree::OnSetAway(userrec* user)
1119 std::deque<std::string> params;
1120 params.push_back(":"+std::string(user->awaymsg));
1121 Utils->DoOneToMany(user->nick,"AWAY",params);
1125 void ModuleSpanningTree::OnCancelAway(userrec* user)
1129 std::deque<std::string> params;
1131 Utils->DoOneToMany(user->nick,"AWAY",params);
1135 void ModuleSpanningTree::ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline)
1137 TreeSocket* s = (TreeSocket*)opaque;
1140 if (target_type == TYPE_USER)
1142 userrec* u = (userrec*)target;
1143 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" FMODE "+u->nick+" "+ConvToStr(u->age)+" "+modeline);
1147 chanrec* c = (chanrec*)target;
1148 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" FMODE "+c->name+" "+ConvToStr(c->age)+" "+modeline);
1153 void ModuleSpanningTree::ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata)
1155 TreeSocket* s = (TreeSocket*)opaque;
1158 if (target_type == TYPE_USER)
1160 userrec* u = (userrec*)target;
1161 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA "+u->nick+" "+extname+" :"+extdata);
1163 else if (target_type == TYPE_CHANNEL)
1165 chanrec* c = (chanrec*)target;
1166 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA "+c->name+" "+extname+" :"+extdata);
1169 if (target_type == TYPE_OTHER)
1171 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA * "+extname+" :"+extdata);
1175 void ModuleSpanningTree::OnEvent(Event* event)
1177 std::deque<std::string>* params = (std::deque<std::string>*)event->GetData();
1178 if (event->GetEventID() == "send_metadata")
1180 if (params->size() < 3)
1182 (*params)[2] = ":" + (*params)[2];
1183 Utils->DoOneToMany(ServerInstance->Config->ServerName,"METADATA",*params);
1185 else if (event->GetEventID() == "send_topic")
1187 if (params->size() < 2)
1189 (*params)[1] = ":" + (*params)[1];
1190 params->insert(params->begin() + 1,ServerInstance->Config->ServerName);
1191 params->insert(params->begin() + 1,ConvToStr(ServerInstance->Time(true)));
1192 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FTOPIC",*params);
1194 else if (event->GetEventID() == "send_mode")
1196 if (params->size() < 2)
1198 // Insert the TS value of the object, either userrec or chanrec
1200 userrec* a = ServerInstance->FindNick((*params)[0]);
1207 chanrec* a = ServerInstance->FindChan((*params)[0]);
1213 params->insert(params->begin() + 1,ConvToStr(ourTS));
1214 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FMODE",*params);
1216 else if (event->GetEventID() == "send_mode_explicit")
1218 if (params->size() < 2)
1220 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODE",*params);
1222 else if (event->GetEventID() == "send_opers")
1224 if (params->size() < 1)
1226 (*params)[0] = ":" + (*params)[0];
1227 Utils->DoOneToMany(ServerInstance->Config->ServerName,"OPERNOTICE",*params);
1229 else if (event->GetEventID() == "send_modeset")
1231 if (params->size() < 2)
1233 (*params)[1] = ":" + (*params)[1];
1234 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODENOTICE",*params);
1236 else if (event->GetEventID() == "send_snoset")
1238 if (params->size() < 2)
1240 (*params)[1] = ":" + (*params)[1];
1241 Utils->DoOneToMany(ServerInstance->Config->ServerName,"SNONOTICE",*params);
1243 else if (event->GetEventID() == "send_push")
1245 if (params->size() < 2)
1248 userrec *a = ServerInstance->FindNick((*params)[0]);
1253 (*params)[1] = ":" + (*params)[1];
1254 Utils->DoOneToOne(ServerInstance->Config->ServerName, "PUSH", *params, a->server);
1258 ModuleSpanningTree::~ModuleSpanningTree()
1260 /* This will also free the listeners */
1263 ServerInstance->Timers->DelTimer(SyncTimer);
1265 ServerInstance->DoneWithInterface("InspSocketHook");
1268 Version ModuleSpanningTree::GetVersion()
1270 return Version(1,1,0,2,VF_VENDOR,API_VERSION);
1273 void ModuleSpanningTree::Implements(char* List)
1275 List[I_OnPreCommand] = List[I_OnGetServerDescription] = List[I_OnUserInvite] = List[I_OnPostLocalTopicChange] = 1;
1276 List[I_OnWallops] = List[I_OnUserNotice] = List[I_OnUserMessage] = List[I_OnBackgroundTimer] = 1;
1277 List[I_OnUserJoin] = List[I_OnChangeHost] = List[I_OnChangeName] = List[I_OnUserPart] = List[I_OnUserConnect] = 1;
1278 List[I_OnUserQuit] = List[I_OnUserPostNick] = List[I_OnUserKick] = List[I_OnRemoteKill] = List[I_OnRehash] = 1;
1279 List[I_OnOper] = List[I_OnAddGLine] = List[I_OnAddZLine] = List[I_OnAddQLine] = List[I_OnAddELine] = 1;
1280 List[I_OnDelGLine] = List[I_OnDelZLine] = List[I_OnDelQLine] = List[I_OnDelELine] = List[I_ProtoSendMode] = List[I_OnMode] = 1;
1281 List[I_OnStats] = List[I_ProtoSendMetaData] = List[I_OnEvent] = List[I_OnSetAway] = List[I_OnCancelAway] = List[I_OnPostCommand] = 1;
1284 /* It is IMPORTANT that m_spanningtree is the last module in the chain
1285 * so that any activity it sees is FINAL, e.g. we arent going to send out
1286 * a NICK message before m_cloaking has finished putting the +x on the user,
1288 * Therefore, we return PRIORITY_LAST to make sure we end up at the END of
1289 * the module call queue.
1291 Priority ModuleSpanningTree::Prioritize()
1293 return PRIORITY_LAST;
1296 class ModuleSpanningTreeFactory : public ModuleFactory
1299 ModuleSpanningTreeFactory()
1303 ~ModuleSpanningTreeFactory()
1307 virtual Module * CreateModule(InspIRCd* Me)
1309 return new ModuleSpanningTree(Me);
1315 extern "C" void * init_module( void )
1317 return new ModuleSpanningTreeFactory;