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 ((Current->GetChild(q)->Hidden) || ((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())) && (!IS_OPER(user)))
79 /* Or if the server is hidden and they're not an oper */
80 else if ((Current->Hidden) && (!IS_OPER(user)))
83 user->WriteServ("364 %s %s %s :%d %s", user->nick,Current->GetName().c_str(),
84 (Utils->FlatLinks && (!IS_OPER(user))) ? ServerInstance->Config->ServerName : Parent.c_str(),
85 (Utils->FlatLinks && (!IS_OPER(user))) ? 0 : hops,
86 Current->GetDesc().c_str());
89 int ModuleSpanningTree::CountLocalServs()
91 return Utils->TreeRoot->ChildCount();
94 int ModuleSpanningTree::CountServs()
96 return Utils->serverlist.size();
99 void ModuleSpanningTree::HandleLinks(const char** parameters, int pcnt, userrec* user)
101 ShowLinks(Utils->TreeRoot,user,0);
102 user->WriteServ("365 %s * :End of /LINKS list.",user->nick);
106 void ModuleSpanningTree::HandleLusers(const char** parameters, int pcnt, userrec* user)
108 unsigned int n_users = ServerInstance->UserCount();
110 /* Only update these when someone wants to see them, more efficient */
111 if ((unsigned int)ServerInstance->LocalUserCount() > max_local)
112 max_local = ServerInstance->LocalUserCount();
113 if (n_users > max_global)
114 max_global = n_users;
116 unsigned int ulined_count = 0;
117 unsigned int ulined_local_count = 0;
119 /* If ulined are hidden and we're not an oper, count the number of ulined servers hidden,
120 * locally and globally (locally means directly connected to us)
122 if ((Utils->HideULines) && (!*user->oper))
124 for (server_hash::iterator q = Utils->serverlist.begin(); q != Utils->serverlist.end(); q++)
126 if (ServerInstance->ULine(q->second->GetName().c_str()))
129 if (q->second->GetParent() == Utils->TreeRoot)
130 ulined_local_count++;
134 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());
135 if (ServerInstance->OperCount())
136 user->WriteServ("252 %s %d :operator(s) online",user->nick,ServerInstance->OperCount());
137 if (ServerInstance->UnregisteredUserCount())
138 user->WriteServ("253 %s %d :unknown connections",user->nick,ServerInstance->UnregisteredUserCount());
139 if (ServerInstance->ChannelCount())
140 user->WriteServ("254 %s %d :channels formed",user->nick,ServerInstance->ChannelCount());
141 user->WriteServ("255 %s :I have %d clients and %d servers",user->nick,ServerInstance->LocalUserCount(),ulined_local_count ? this->CountLocalServs() - ulined_local_count : this->CountLocalServs());
142 user->WriteServ("265 %s :Current Local Users: %d Max: %d",user->nick,ServerInstance->LocalUserCount(),max_local);
143 user->WriteServ("266 %s :Current Global Users: %d Max: %d",user->nick,n_users,max_global);
147 const std::string ModuleSpanningTree::MapOperInfo(TreeServer* Current)
149 time_t secs_up = ServerInstance->Time() - Current->age;
150 time_t mins_up = secs_up / 60;
151 time_t hours_up = mins_up / 60;
152 time_t days_up = hours_up / 24;
153 secs_up = secs_up % 60;
154 mins_up = mins_up % 60;
155 hours_up = hours_up % 24;
156 return (" [Up: "+ (days_up ? (ConvToStr(days_up) + "d") : std::string(""))
157 + (hours_up ? (ConvToStr(hours_up) + "h") : std::string(""))
158 + (mins_up ? (ConvToStr(mins_up) + "m") : std::string(""))
159 + ConvToStr(secs_up) + "s Lag: "+ConvToStr(Current->rtt)+"s]");
162 // WARNING: NOT THREAD SAFE - DONT GET ANY SMART IDEAS.
163 void ModuleSpanningTree::ShowMap(TreeServer* Current, userrec* user, int depth, char matrix[128][80], float &totusers, float &totservers)
167 for (int t = 0; t < depth; t++)
169 matrix[line][t] = ' ';
171 // For Aligning, we need to work out exactly how deep this thing is, and produce
172 // a 'Spacer' String to compensate.
174 memset(spacer,' ',40);
175 if ((40 - Current->GetName().length() - depth) > 1) {
176 spacer[40 - Current->GetName().length() - depth] = '\0';
184 if (ServerInstance->clientlist->size() == 0) {
185 // If there are no users, WHO THE HELL DID THE /MAP?!?!?!
190 percent = ((float)Current->GetUserCount() / (float)ServerInstance->clientlist->size()) * 100;
192 const std::string operdata = IS_OPER(user) ? MapOperInfo(Current) : "";
193 snprintf(text, 80, "%s %s%5d [%5.2f%%]%s", Current->GetName().c_str(), spacer, Current->GetUserCount(), percent, operdata.c_str());
194 totusers += Current->GetUserCount();
196 strlcpy(&matrix[line][depth],text,80);
198 for (unsigned int q = 0; q < Current->ChildCount(); q++)
200 if ((Current->GetChild(q)->Hidden) || ((Utils->HideULines) && (ServerInstance->ULine(Current->GetChild(q)->GetName().c_str()))))
204 ShowMap(Current->GetChild(q),user,(Utils->FlatLinks && (!*user->oper)) ? depth : depth+2,matrix,totusers,totservers);
209 ShowMap(Current->GetChild(q),user,(Utils->FlatLinks && (!*user->oper)) ? depth : depth+2,matrix,totusers,totservers);
215 int ModuleSpanningTree::HandleMotd(const char** parameters, int pcnt, userrec* user)
219 if (match(ServerInstance->Config->ServerName, parameters[0]))
222 /* Remote MOTD, the server is within the 1st parameter */
223 std::deque<std::string> params;
224 params.push_back(parameters[0]);
225 /* Send it out remotely, generate no reply yet */
226 TreeServer* s = Utils->FindServerMask(parameters[0]);
228 Utils->DoOneToOne(user->nick, "MOTD", params, s->GetName());
230 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
236 int ModuleSpanningTree::HandleAdmin(const char** parameters, int pcnt, userrec* user)
240 if (match(ServerInstance->Config->ServerName, parameters[0]))
243 /* Remote ADMIN, the server is within the 1st parameter */
244 std::deque<std::string> params;
245 params.push_back(parameters[0]);
246 /* Send it out remotely, generate no reply yet */
247 TreeServer* s = Utils->FindServerMask(parameters[0]);
249 Utils->DoOneToOne(user->nick, "ADMIN", params, s->GetName());
251 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
257 int ModuleSpanningTree::HandleModules(const char** parameters, int pcnt, userrec* user)
259 if (match(ServerInstance->Config->ServerName, parameters[0]))
262 std::deque<std::string> params;
263 params.push_back(parameters[0]);
264 TreeServer* s = Utils->FindServerMask(parameters[0]);
266 Utils->DoOneToOne(user->nick, "MODULES", params, s->GetName());
268 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
272 int ModuleSpanningTree::HandleStats(const char** parameters, int pcnt, userrec* user)
276 if (match(ServerInstance->Config->ServerName, parameters[1]))
279 /* Remote STATS, the server is within the 2nd parameter */
280 std::deque<std::string> params;
281 params.push_back(parameters[0]);
282 params.push_back(parameters[1]);
283 /* Send it out remotely, generate no reply yet */
285 TreeServer* s = Utils->FindServerMask(parameters[1]);
288 params[1] = s->GetName();
289 Utils->DoOneToOne(user->nick, "STATS", params, s->GetName());
293 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[1]);
300 // Ok, prepare to be confused.
301 // After much mulling over how to approach this, it struck me that
302 // the 'usual' way of doing a /MAP isnt the best way. Instead of
303 // keeping track of a ton of ascii characters, and line by line
304 // under recursion working out where to place them using multiplications
305 // and divisons, we instead render the map onto a backplane of characters
306 // (a character matrix), then draw the branches as a series of "L" shapes
307 // from the nodes. This is not only friendlier on CPU it uses less stack.
308 void ModuleSpanningTree::HandleMap(const char** parameters, int pcnt, userrec* user)
310 // This array represents a virtual screen which we will
311 // "scratch" draw to, as the console device of an irc
312 // client does not provide for a proper terminal.
314 float totservers = 0;
315 char matrix[128][80];
316 for (unsigned int t = 0; t < 128; t++)
321 // The only recursive bit is called here.
322 ShowMap(Utils->TreeRoot,user,0,matrix,totusers,totservers);
323 // Process each line one by one. The algorithm has a limit of
324 // 128 servers (which is far more than a spanning tree should have
325 // anyway, so we're ok). This limit can be raised simply by making
326 // the character matrix deeper, 128 rows taking 10k of memory.
327 for (int l = 1; l < line; l++)
329 // scan across the line looking for the start of the
330 // servername (the recursive part of the algorithm has placed
331 // the servers at indented positions depending on what they
333 int first_nonspace = 0;
334 while (matrix[l][first_nonspace] == ' ')
339 // Draw the `- (corner) section: this may be overwritten by
340 // another L shape passing along the same vertical pane, becoming
341 // a |- (branch) section instead.
342 matrix[l][first_nonspace] = '-';
343 matrix[l][first_nonspace-1] = '`';
345 // Draw upwards until we hit the parent server, causing possibly
346 // other corners (`-) to become branches (|-)
347 while ((matrix[l2][first_nonspace-1] == ' ') || (matrix[l2][first_nonspace-1] == '`'))
349 matrix[l2][first_nonspace-1] = '|';
353 // dump the whole lot to the user. This is the easy bit, honest.
354 for (int t = 0; t < line; t++)
356 user->WriteServ("006 %s :%s",user->nick,&matrix[t][0]);
358 float avg_users = totusers / totservers;
359 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);
360 user->WriteServ("007 %s :End of /MAP",user->nick);
364 int ModuleSpanningTree::HandleSquit(const char** parameters, int pcnt, userrec* user)
366 TreeServer* s = Utils->FindServerMask(parameters[0]);
369 if (s == Utils->TreeRoot)
371 user->WriteServ("NOTICE %s :*** SQUIT: Foolish mortal, you cannot make a server SQUIT itself! (%s matches local server name)",user->nick,parameters[0]);
374 TreeSocket* sock = s->GetSocket();
377 ServerInstance->SNO->WriteToSnoMask('l',"SQUIT: Server \002%s\002 removed from network by %s",parameters[0],user->nick);
378 sock->Squit(s,std::string("Server quit by ") + user->GetFullRealHost());
379 ServerInstance->SE->DelFd(sock);
386 std::deque<std::string> params;
387 params.push_back(parameters[0]);
388 params.push_back(std::string(":Server quit by ") + user->GetFullRealHost());
389 Utils->DoOneToOne(user->nick, "RSQUIT", params, parameters[0]);
394 user->WriteServ("NOTICE %s :*** SQUIT: The server \002%s\002 does not exist on the network.",user->nick,parameters[0]);
399 int ModuleSpanningTree::HandleTime(const char** parameters, int pcnt, userrec* user)
401 if ((IS_LOCAL(user)) && (pcnt))
403 TreeServer* found = Utils->FindServerMask(parameters[0]);
406 // we dont' override for local server
407 if (found == Utils->TreeRoot)
410 std::deque<std::string> params;
411 params.push_back(found->GetName());
412 params.push_back(user->nick);
413 Utils->DoOneToOne(ServerInstance->Config->ServerName,"TIME",params,found->GetName());
417 user->WriteServ("402 %s %s :No such server",user->nick,parameters[0]);
423 int ModuleSpanningTree::HandleRemoteWhois(const char** parameters, int pcnt, userrec* user)
425 if ((IS_LOCAL(user)) && (pcnt > 1))
427 userrec* remote = ServerInstance->FindNick(parameters[1]);
428 if ((remote) && (remote->GetFd() < 0))
430 std::deque<std::string> params;
431 params.push_back(parameters[1]);
432 Utils->DoOneToOne(user->nick,"IDLE",params,remote->server);
437 user->WriteServ("401 %s %s :No such nick/channel",user->nick, parameters[1]);
438 user->WriteServ("318 %s %s :End of /WHOIS list.",user->nick, parameters[1]);
445 void ModuleSpanningTree::DoPingChecks(time_t curtime)
447 for (unsigned int j = 0; j < Utils->TreeRoot->ChildCount(); j++)
449 TreeServer* serv = Utils->TreeRoot->GetChild(j);
450 TreeSocket* sock = serv->GetSocket();
453 if (curtime >= serv->NextPingTime())
455 if (serv->AnsweredLastPing())
457 sock->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" PING "+serv->GetName());
458 serv->SetNextPingTime(curtime + 60);
459 serv->LastPing = curtime;
463 // they didnt answer, boot them
464 ServerInstance->SNO->WriteToSnoMask('l',"Server \002%s\002 pinged out",serv->GetName().c_str());
465 sock->Squit(serv,"Ping timeout");
466 ServerInstance->SE->DelFd(sock);
476 void ModuleSpanningTree::ConnectServer(Link* x)
479 QueryType start_type = DNS_QUERY_A;
481 start_type = DNS_QUERY_AAAA;
482 if (strchr(x->IPAddr.c_str(),':'))
485 if (inet_pton(AF_INET6, x->IPAddr.c_str(), &n) < 1)
491 if (inet_aton(x->IPAddr.c_str(),&n) < 1)
496 if (inet_aton(x->IPAddr.c_str(),&n) < 1)
500 /* Do we already have an IP? If so, no need to resolve it. */
503 /* Gave a hook, but it wasnt one we know */
504 if ((!x->Hook.empty()) && (Utils->hooks.find(x->Hook.c_str()) == Utils->hooks.end()))
506 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()]);
507 if (newsocket->GetFd() > -1)
509 /* Handled automatically on success */
513 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(),strerror(errno));
515 Utils->DoFailOver(x);
523 ServernameResolver* snr = new ServernameResolver((Module*)this, Utils, ServerInstance,x->IPAddr, *x, cached, start_type);
524 ServerInstance->AddResolver(snr, cached);
526 catch (ModuleException& e)
528 ServerInstance->SNO->WriteToSnoMask('l',"CONNECT: Error connecting \002%s\002: %s.",x->Name.c_str(), e.GetReason());
529 Utils->DoFailOver(x);
534 void ModuleSpanningTree::AutoConnectServers(time_t curtime)
536 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
538 if ((x->AutoConnect) && (curtime >= x->NextConnectTime))
540 x->NextConnectTime = curtime + x->AutoConnect;
541 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
542 if (x->FailOver.length())
544 TreeServer* CheckFailOver = Utils->FindServer(x->FailOver.c_str());
547 /* The failover for this server is currently a member of the network.
548 * The failover probably succeeded, where the main link did not.
549 * Don't try the main link until the failover is gone again.
556 // an autoconnected server is not connected. Check if its time to connect it
557 ServerInstance->SNO->WriteToSnoMask('l',"AUTOCONNECT: Auto-connecting server \002%s\002 (%lu seconds until next attempt)",x->Name.c_str(),x->AutoConnect);
558 this->ConnectServer(&(*x));
564 int ModuleSpanningTree::HandleVersion(const char** parameters, int pcnt, userrec* user)
566 // we've already checked if pcnt > 0, so this is safe
567 TreeServer* found = Utils->FindServerMask(parameters[0]);
570 std::string Version = found->GetVersion();
571 user->WriteServ("351 %s :%s",user->nick,Version.c_str());
572 if (found == Utils->TreeRoot)
574 ServerInstance->Config->Send005(user);
579 user->WriteServ("402 %s %s :No such server",user->nick,parameters[0]);
584 int ModuleSpanningTree::HandleConnect(const char** parameters, int pcnt, userrec* user)
586 for (std::vector<Link>::iterator x = Utils->LinkBlocks.begin(); x < Utils->LinkBlocks.end(); x++)
588 if (ServerInstance->MatchText(x->Name.c_str(),parameters[0]))
590 TreeServer* CheckDupe = Utils->FindServer(x->Name.c_str());
593 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);
594 ConnectServer(&(*x));
599 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());
604 user->WriteServ("NOTICE %s :*** CONNECT: No server matching \002%s\002 could be found in the config file.",user->nick,parameters[0]);
608 void ModuleSpanningTree::BroadcastTimeSync()
610 if (Utils->MasterTime)
612 std::deque<std::string> params;
613 params.push_back(ConvToStr(ServerInstance->Time(false)));
614 params.push_back("FORCE");
615 Utils->DoOneToMany(Utils->TreeRoot->GetName(), "TIMESET", params);
619 int ModuleSpanningTree::OnStats(char statschar, userrec* user, string_list &results)
621 if ((statschar == 'c') || (statschar == 'n'))
623 for (unsigned int i = 0; i < Utils->LinkBlocks.size(); i++)
625 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');
626 if (statschar == 'c')
627 results.push_back(std::string(ServerInstance->Config->ServerName)+" 244 "+user->nick+" H * * "+Utils->LinkBlocks[i].Name.c_str());
629 results.push_back(std::string(ServerInstance->Config->ServerName)+" 219 "+user->nick+" "+statschar+" :End of /STATS report");
630 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);
636 int ModuleSpanningTree::OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line)
638 /* If the command doesnt appear to be valid, we dont want to mess with it. */
642 if (command == "CONNECT")
644 return this->HandleConnect(parameters,pcnt,user);
646 else if (command == "STATS")
648 return this->HandleStats(parameters,pcnt,user);
650 else if (command == "MOTD")
652 return this->HandleMotd(parameters,pcnt,user);
654 else if (command == "ADMIN")
656 return this->HandleAdmin(parameters,pcnt,user);
658 else if (command == "SQUIT")
660 return this->HandleSquit(parameters,pcnt,user);
662 else if (command == "MAP")
664 this->HandleMap(parameters,pcnt,user);
667 else if ((command == "TIME") && (pcnt > 0))
669 return this->HandleTime(parameters,pcnt,user);
671 else if (command == "LUSERS")
673 this->HandleLusers(parameters,pcnt,user);
676 else if (command == "LINKS")
678 this->HandleLinks(parameters,pcnt,user);
681 else if (command == "WHOIS")
686 return this->HandleRemoteWhois(parameters,pcnt,user);
689 else if ((command == "VERSION") && (pcnt > 0))
691 this->HandleVersion(parameters,pcnt,user);
694 else if ((command == "MODULES") && (pcnt > 0))
696 return this->HandleModules(parameters,pcnt,user);
701 void ModuleSpanningTree::OnPostCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, CmdResult result, const std::string &original_line)
703 if ((result == CMD_SUCCESS) && (ServerInstance->IsValidModuleCommand(command, pcnt, user)))
705 // this bit of code cleverly routes all module commands
706 // to all remote severs *automatically* so that modules
707 // can just handle commands locally, without having
708 // to have any special provision in place for remote
709 // commands and linking protocols.
710 std::deque<std::string> params;
712 for (int j = 0; j < pcnt; j++)
714 if (strchr(parameters[j],' '))
716 params.push_back(":" + std::string(parameters[j]));
720 params.push_back(std::string(parameters[j]));
723 Utils->DoOneToMany(user->nick,command,params);
727 void ModuleSpanningTree::OnGetServerDescription(const std::string &servername,std::string &description)
729 TreeServer* s = Utils->FindServer(servername);
732 description = s->GetDesc();
736 void ModuleSpanningTree::OnUserInvite(userrec* source,userrec* dest,chanrec* channel)
738 if (IS_LOCAL(source))
740 std::deque<std::string> params;
741 params.push_back(dest->nick);
742 params.push_back(channel->name);
743 Utils->DoOneToMany(source->nick,"INVITE",params);
747 void ModuleSpanningTree::OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic)
749 std::deque<std::string> params;
750 params.push_back(chan->name);
751 params.push_back(":"+topic);
752 Utils->DoOneToMany(user->nick,"TOPIC",params);
755 void ModuleSpanningTree::OnWallops(userrec* user, const std::string &text)
759 std::deque<std::string> params;
760 params.push_back(":"+text);
761 Utils->DoOneToMany(user->nick,"WALLOPS",params);
765 void ModuleSpanningTree::OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
767 if (target_type == TYPE_USER)
769 userrec* d = (userrec*)dest;
770 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
772 std::deque<std::string> params;
774 params.push_back(d->nick);
775 params.push_back(":"+text);
776 Utils->DoOneToOne(user->nick,"NOTICE",params,d->server);
779 else if (target_type == TYPE_CHANNEL)
783 chanrec *c = (chanrec*)dest;
786 std::string cname = c->name;
788 cname = status + cname;
790 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
791 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
793 TreeSocket* Sock = i->second->GetSocket();
795 Sock->WriteLine(":"+std::string(user->nick)+" NOTICE "+cname+" :"+text);
800 else if (target_type == TYPE_SERVER)
804 char* target = (char*)dest;
805 std::deque<std::string> par;
806 par.push_back(target);
807 par.push_back(":"+text);
808 Utils->DoOneToMany(user->nick,"NOTICE",par);
813 void ModuleSpanningTree::OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list)
815 if (target_type == TYPE_USER)
817 // route private messages which are targetted at clients only to the server
818 // which needs to receive them
819 userrec* d = (userrec*)dest;
820 if ((d->GetFd() < 0) && (IS_LOCAL(user)))
822 std::deque<std::string> params;
824 params.push_back(d->nick);
825 params.push_back(":"+text);
826 Utils->DoOneToOne(user->nick,"PRIVMSG",params,d->server);
829 else if (target_type == TYPE_CHANNEL)
833 chanrec *c = (chanrec*)dest;
836 std::string cname = c->name;
838 cname = status + cname;
840 Utils->GetListOfServersForChannel(c,list,status,exempt_list);
841 for (TreeServerList::iterator i = list.begin(); i != list.end(); i++)
843 TreeSocket* Sock = i->second->GetSocket();
845 Sock->WriteLine(":"+std::string(user->nick)+" PRIVMSG "+cname+" :"+text);
850 else if (target_type == TYPE_SERVER)
854 char* target = (char*)dest;
855 std::deque<std::string> par;
856 par.push_back(target);
857 par.push_back(":"+text);
858 Utils->DoOneToMany(user->nick,"PRIVMSG",par);
863 void ModuleSpanningTree::OnBackgroundTimer(time_t curtime)
865 AutoConnectServers(curtime);
866 DoPingChecks(curtime);
869 void ModuleSpanningTree::OnUserJoin(userrec* user, chanrec* channel)
871 // Only do this for local users
874 if (channel->GetUserCounter() == 1)
876 std::deque<std::string> params;
877 // set up their permissions and the channel TS with FJOIN.
878 // All users are FJOINed now, because a module may specify
879 // new joining permissions for the user.
880 params.push_back(channel->name);
881 params.push_back(ConvToStr(channel->age));
882 params.push_back(std::string(channel->GetAllPrefixChars(user))+","+std::string(user->nick));
883 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FJOIN",params);
884 /* First user in, sync the modes for the channel */
886 /* This is safe, all inspircd servers default to +nt */
887 params.push_back("+nt");
888 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FMODE",params);
892 std::deque<std::string> params;
893 params.push_back(channel->name);
894 params.push_back(ConvToStr(channel->age));
895 Utils->DoOneToMany(user->nick,"JOIN",params);
900 void ModuleSpanningTree::OnChangeHost(userrec* user, const std::string &newhost)
902 // only occurs for local clients
903 if (user->registered != REG_ALL)
905 std::deque<std::string> params;
906 params.push_back(newhost);
907 Utils->DoOneToMany(user->nick,"FHOST",params);
910 void ModuleSpanningTree::OnChangeName(userrec* user, const std::string &gecos)
912 // only occurs for local clients
913 if (user->registered != REG_ALL)
915 std::deque<std::string> params;
916 params.push_back(gecos);
917 Utils->DoOneToMany(user->nick,"FNAME",params);
920 void ModuleSpanningTree::OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage)
924 std::deque<std::string> params;
925 params.push_back(channel->name);
926 if (partmessage != "")
927 params.push_back(":"+partmessage);
928 Utils->DoOneToMany(user->nick,"PART",params);
932 void ModuleSpanningTree::OnUserConnect(userrec* user)
937 std::deque<std::string> params;
938 snprintf(agestr,MAXBUF,"%lu",(unsigned long)user->age);
939 params.push_back(agestr);
940 params.push_back(user->nick);
941 params.push_back(user->host);
942 params.push_back(user->dhost);
943 params.push_back(user->ident);
944 params.push_back("+"+std::string(user->FormatModes()));
945 params.push_back(user->GetIPString());
946 params.push_back(":"+std::string(user->fullname));
947 Utils->DoOneToMany(ServerInstance->Config->ServerName,"NICK",params);
948 // User is Local, change needs to be reflected!
949 TreeServer* SourceServer = Utils->FindServer(user->server);
952 SourceServer->AddUserCount();
957 void ModuleSpanningTree::OnUserQuit(userrec* user, const std::string &reason, const std::string &oper_message)
959 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
961 std::deque<std::string> params;
963 if (oper_message != reason)
965 params.push_back(":"+oper_message);
966 Utils->DoOneToMany(user->nick,"OPERQUIT",params);
969 params.push_back(":"+reason);
970 Utils->DoOneToMany(user->nick,"QUIT",params);
972 // Regardless, We need to modify the user Counts..
973 TreeServer* SourceServer = Utils->FindServer(user->server);
976 SourceServer->DelUserCount();
980 void ModuleSpanningTree::OnUserPostNick(userrec* user, const std::string &oldnick)
984 std::deque<std::string> params;
985 params.push_back(user->nick);
986 Utils->DoOneToMany(oldnick,"NICK",params);
990 void ModuleSpanningTree::OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason)
992 if ((source) && (IS_LOCAL(source)))
994 std::deque<std::string> params;
995 params.push_back(chan->name);
996 params.push_back(user->nick);
997 params.push_back(":"+reason);
998 Utils->DoOneToMany(source->nick,"KICK",params);
1002 std::deque<std::string> params;
1003 params.push_back(chan->name);
1004 params.push_back(user->nick);
1005 params.push_back(":"+reason);
1006 Utils->DoOneToMany(ServerInstance->Config->ServerName,"KICK",params);
1010 void ModuleSpanningTree::OnRemoteKill(userrec* source, userrec* dest, const std::string &reason)
1012 std::deque<std::string> params;
1013 params.push_back(dest->nick);
1014 params.push_back(":"+reason);
1015 Utils->DoOneToMany(source->nick,"KILL",params);
1018 void ModuleSpanningTree::OnRehash(userrec* user, const std::string ¶meter)
1020 if (parameter != "")
1022 std::deque<std::string> params;
1023 params.push_back(parameter);
1024 Utils->DoOneToMany(user ? user->nick : ServerInstance->Config->ServerName, "REHASH", params);
1026 if (ServerInstance->MatchText(ServerInstance->Config->ServerName,parameter))
1028 ServerInstance->WriteOpers("*** Remote rehash initiated locally by \002%s\002", user ? user->nick : ServerInstance->Config->ServerName);
1029 ServerInstance->RehashServer();
1032 Utils->ReadConfiguration(false);
1033 InitializeDisabledCommands(ServerInstance->Config->DisabledCommands, ServerInstance);
1036 // note: the protocol does not allow direct umode +o except
1037 // via NICK with 8 params. sending OPERTYPE infers +o modechange
1039 void ModuleSpanningTree::OnOper(userrec* user, const std::string &opertype)
1043 std::deque<std::string> params;
1044 params.push_back(opertype);
1045 Utils->DoOneToMany(user->nick,"OPERTYPE",params);
1049 void ModuleSpanningTree::OnLine(userrec* source, const std::string &host, bool adding, char linetype, long duration, const std::string &reason)
1053 /* Server-set lines */
1055 snprintf(data,MAXBUF,"%c %s %s %lu %lu :%s", linetype, host.c_str(), ServerInstance->Config->ServerName, (unsigned long)ServerInstance->Time(false),
1056 (unsigned long)duration, reason.c_str());
1057 std::deque<std::string> params;
1058 params.push_back(data);
1059 Utils->DoOneToMany(ServerInstance->Config->ServerName, "ADDLINE", params);
1063 if (IS_LOCAL(source))
1066 snprintf(type,8,"%cLINE",linetype);
1067 std::string stype = type;
1070 char sduration[MAXBUF];
1071 snprintf(sduration,MAXBUF,"%ld",duration);
1072 std::deque<std::string> params;
1073 params.push_back(host);
1074 params.push_back(sduration);
1075 params.push_back(":"+reason);
1076 Utils->DoOneToMany(source->nick,stype,params);
1080 std::deque<std::string> params;
1081 params.push_back(host);
1082 Utils->DoOneToMany(source->nick,stype,params);
1088 void ModuleSpanningTree::OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask)
1090 OnLine(source,hostmask,true,'G',duration,reason);
1093 void ModuleSpanningTree::OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask)
1095 OnLine(source,ipmask,true,'Z',duration,reason);
1098 void ModuleSpanningTree::OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask)
1100 OnLine(source,nickmask,true,'Q',duration,reason);
1103 void ModuleSpanningTree::OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask)
1105 OnLine(source,hostmask,true,'E',duration,reason);
1108 void ModuleSpanningTree::OnDelGLine(userrec* source, const std::string &hostmask)
1110 OnLine(source,hostmask,false,'G',0,"");
1113 void ModuleSpanningTree::OnDelZLine(userrec* source, const std::string &ipmask)
1115 OnLine(source,ipmask,false,'Z',0,"");
1118 void ModuleSpanningTree::OnDelQLine(userrec* source, const std::string &nickmask)
1120 OnLine(source,nickmask,false,'Q',0,"");
1123 void ModuleSpanningTree::OnDelELine(userrec* source, const std::string &hostmask)
1125 OnLine(source,hostmask,false,'E',0,"");
1128 void ModuleSpanningTree::OnMode(userrec* user, void* dest, int target_type, const std::string &text)
1130 if ((IS_LOCAL(user)) && (user->registered == REG_ALL))
1132 std::deque<std::string> params;
1133 std::string command;
1135 if (target_type == TYPE_USER)
1137 userrec* u = (userrec*)dest;
1138 params.push_back(u->nick);
1139 params.push_back(text);
1144 chanrec* c = (chanrec*)dest;
1145 params.push_back(c->name);
1146 params.push_back(ConvToStr(c->age));
1147 params.push_back(text);
1150 Utils->DoOneToMany(user->nick, command, params);
1154 void ModuleSpanningTree::OnSetAway(userrec* user)
1158 std::deque<std::string> params;
1159 params.push_back(":"+std::string(user->awaymsg));
1160 Utils->DoOneToMany(user->nick,"AWAY",params);
1164 void ModuleSpanningTree::OnCancelAway(userrec* user)
1168 std::deque<std::string> params;
1170 Utils->DoOneToMany(user->nick,"AWAY",params);
1174 void ModuleSpanningTree::ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline)
1176 TreeSocket* s = (TreeSocket*)opaque;
1179 if (target_type == TYPE_USER)
1181 userrec* u = (userrec*)target;
1182 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" FMODE "+u->nick+" "+ConvToStr(u->age)+" "+modeline);
1186 chanrec* c = (chanrec*)target;
1187 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" FMODE "+c->name+" "+ConvToStr(c->age)+" "+modeline);
1192 void ModuleSpanningTree::ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata)
1194 TreeSocket* s = (TreeSocket*)opaque;
1197 if (target_type == TYPE_USER)
1199 userrec* u = (userrec*)target;
1200 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA "+u->nick+" "+extname+" :"+extdata);
1202 else if (target_type == TYPE_CHANNEL)
1204 chanrec* c = (chanrec*)target;
1205 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA "+c->name+" "+extname+" :"+extdata);
1208 if (target_type == TYPE_OTHER)
1210 s->WriteLine(std::string(":")+ServerInstance->Config->ServerName+" METADATA * "+extname+" :"+extdata);
1214 void ModuleSpanningTree::OnEvent(Event* event)
1216 std::deque<std::string>* params = (std::deque<std::string>*)event->GetData();
1217 if (event->GetEventID() == "send_metadata")
1219 if (params->size() < 3)
1221 (*params)[2] = ":" + (*params)[2];
1222 Utils->DoOneToMany(ServerInstance->Config->ServerName,"METADATA",*params);
1224 else if (event->GetEventID() == "send_topic")
1226 if (params->size() < 2)
1228 (*params)[1] = ":" + (*params)[1];
1229 params->insert(params->begin() + 1,ServerInstance->Config->ServerName);
1230 params->insert(params->begin() + 1,ConvToStr(ServerInstance->Time(true)));
1231 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FTOPIC",*params);
1233 else if (event->GetEventID() == "send_mode")
1235 if (params->size() < 2)
1237 // Insert the TS value of the object, either userrec or chanrec
1239 userrec* a = ServerInstance->FindNick((*params)[0]);
1246 chanrec* a = ServerInstance->FindChan((*params)[0]);
1252 params->insert(params->begin() + 1,ConvToStr(ourTS));
1253 Utils->DoOneToMany(ServerInstance->Config->ServerName,"FMODE",*params);
1255 else if (event->GetEventID() == "send_mode_explicit")
1257 if (params->size() < 2)
1259 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODE",*params);
1261 else if (event->GetEventID() == "send_opers")
1263 if (params->size() < 1)
1265 (*params)[0] = ":" + (*params)[0];
1266 Utils->DoOneToMany(ServerInstance->Config->ServerName,"OPERNOTICE",*params);
1268 else if (event->GetEventID() == "send_modeset")
1270 if (params->size() < 2)
1272 (*params)[1] = ":" + (*params)[1];
1273 Utils->DoOneToMany(ServerInstance->Config->ServerName,"MODENOTICE",*params);
1275 else if (event->GetEventID() == "send_snoset")
1277 if (params->size() < 2)
1279 (*params)[1] = ":" + (*params)[1];
1280 Utils->DoOneToMany(ServerInstance->Config->ServerName,"SNONOTICE",*params);
1282 else if (event->GetEventID() == "send_push")
1284 if (params->size() < 2)
1287 userrec *a = ServerInstance->FindNick((*params)[0]);
1292 (*params)[1] = ":" + (*params)[1];
1293 Utils->DoOneToOne(ServerInstance->Config->ServerName, "PUSH", *params, a->server);
1297 ModuleSpanningTree::~ModuleSpanningTree()
1299 /* This will also free the listeners */
1302 ServerInstance->Timers->DelTimer(SyncTimer);
1304 ServerInstance->DoneWithInterface("InspSocketHook");
1307 Version ModuleSpanningTree::GetVersion()
1309 return Version(1,1,0,2,VF_VENDOR,API_VERSION);
1312 void ModuleSpanningTree::Implements(char* List)
1314 List[I_OnPreCommand] = List[I_OnGetServerDescription] = List[I_OnUserInvite] = List[I_OnPostLocalTopicChange] = 1;
1315 List[I_OnWallops] = List[I_OnUserNotice] = List[I_OnUserMessage] = List[I_OnBackgroundTimer] = 1;
1316 List[I_OnUserJoin] = List[I_OnChangeHost] = List[I_OnChangeName] = List[I_OnUserPart] = List[I_OnUserConnect] = 1;
1317 List[I_OnUserQuit] = List[I_OnUserPostNick] = List[I_OnUserKick] = List[I_OnRemoteKill] = List[I_OnRehash] = 1;
1318 List[I_OnOper] = List[I_OnAddGLine] = List[I_OnAddZLine] = List[I_OnAddQLine] = List[I_OnAddELine] = 1;
1319 List[I_OnDelGLine] = List[I_OnDelZLine] = List[I_OnDelQLine] = List[I_OnDelELine] = List[I_ProtoSendMode] = List[I_OnMode] = 1;
1320 List[I_OnStats] = List[I_ProtoSendMetaData] = List[I_OnEvent] = List[I_OnSetAway] = List[I_OnCancelAway] = List[I_OnPostCommand] = 1;
1323 /* It is IMPORTANT that m_spanningtree is the last module in the chain
1324 * so that any activity it sees is FINAL, e.g. we arent going to send out
1325 * a NICK message before m_cloaking has finished putting the +x on the user,
1327 * Therefore, we return PRIORITY_LAST to make sure we end up at the END of
1328 * the module call queue.
1330 Priority ModuleSpanningTree::Prioritize()
1332 return PRIORITY_LAST;
1335 class ModuleSpanningTreeFactory : public ModuleFactory
1338 ModuleSpanningTreeFactory()
1342 ~ModuleSpanningTreeFactory()
1346 virtual Module * CreateModule(InspIRCd* Me)
1348 return new ModuleSpanningTree(Me);
1354 extern "C" void * init_module( void )
1356 return new ModuleSpanningTreeFactory;