1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2008 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 */
17 #include "commands/cmd_whois.h"
18 #include "commands/cmd_stats.h"
22 #include "transport.h"
24 #include "m_spanningtree/timesynctimer.h"
25 #include "m_spanningtree/resolvers.h"
26 #include "m_spanningtree/main.h"
27 #include "m_spanningtree/utils.h"
28 #include "m_spanningtree/treeserver.h"
29 #include "m_spanningtree/link.h"
30 #include "m_spanningtree/treesocket.h"
31 #include "m_spanningtree/rconnect.h"
32 #include "m_spanningtree/rsquit.h"
34 /* $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 m_spanningtree/rsquit.h */
36 const std::string ModuleSpanningTree::MapOperInfo(TreeServer* Current)
38 time_t secs_up = ServerInstance->Time() - Current->age;
39 return (" [Up: " + TimeToStr(secs_up) + " Lag: "+ConvToStr(Current->rtt)+"ms]");
42 // WARNING: NOT THREAD SAFE - DONT GET ANY SMART IDEAS.
43 void ModuleSpanningTree::ShowMap(TreeServer* Current, User* user, int depth, char matrix[128][128], float &totusers, float &totservers)
45 ServerInstance->Logs->Log("map",DEBUG,"ShowMap depth %d totusers %0.2f totservers %0.2f", depth, totusers, totservers);
48 for (int t = 0; t < depth; t++)
50 ServerInstance->Logs->Log("map",DEBUG,"Zero to depth");
51 matrix[line][t] = ' ';
54 // For Aligning, we need to work out exactly how deep this thing is, and produce
55 // a 'Spacer' String to compensate.
57 memset(spacer,' ',40);
58 if ((40 - Current->GetName().length() - depth) > 1) {
59 spacer[40 - Current->GetName().length() - depth] = '\0';
68 /* Neat and tidy default values, as we're dealing with a matrix not a simple string */
71 if (ServerInstance->Users->clientlist->size() == 0)
73 // If there are no users, WHO THE HELL DID THE /MAP?!?!?!
78 percent = ((float)Current->GetUserCount() / (float)ServerInstance->Users->clientlist->size()) * 100;
81 const std::string operdata = IS_OPER(user) ? MapOperInfo(Current) : "";
82 snprintf(text, 126, "%s %s%5d [%5.2f%%]%s", Current->GetName().c_str(), spacer, Current->GetUserCount(), percent, operdata.c_str());
83 totusers += Current->GetUserCount();
85 strlcpy(&matrix[line][depth],text,126);
88 ServerInstance->Logs->Log("map",DEBUG,"Increment line to %d, ChildCount %d", line, Current->ChildCount());
90 for (unsigned int q = 0; q < Current->ChildCount(); q++)
92 ServerInstance->Logs->Log("map",DEBUG,"Hidden? %d HideULines? %d GetName %s", Current->GetChild(q)->Hidden, Utils->HideULines, Current->GetChild(q)->GetName().c_str());
93 if ((Current->GetChild(q)->Hidden) || ((Utils->HideULines) && (ServerInstance->ULine(Current->GetChild(q)->GetName().c_str()))))
95 if (*user->oper || !IS_LOCAL(user))
97 ShowMap(Current->GetChild(q),user,(Utils->FlatLinks && (!*user->oper || !IS_LOCAL(user))) ? depth : depth+2,matrix,totusers,totservers);
98 ServerInstance->Logs->Log("map",DEBUG,"Show to oper");
100 ServerInstance->Logs->Log("map",DEBUG,"Fall through");
104 ShowMap(Current->GetChild(q),user,(Utils->FlatLinks && (!*user->oper || !IS_LOCAL(user))) ? depth : depth+2,matrix,totusers,totservers);
105 ServerInstance->Logs->Log("map",DEBUG,"Show to non oper");
108 ServerInstance->Logs->Log("map",DEBUG,"After loop");
113 // Ok, prepare to be confused.
114 // After much mulling over how to approach this, it struck me that
115 // the 'usual' way of doing a /MAP isnt the best way. Instead of
116 // keeping track of a ton of ascii characters, and line by line
117 // under recursion working out where to place them using multiplications
118 // and divisons, we instead render the map onto a backplane of characters
119 // (a character matrix), then draw the branches as a series of "L" shapes
120 // from the nodes. This is not only friendlier on CPU it uses less stack.
121 int ModuleSpanningTree::HandleMap(const char* const* parameters, int pcnt, User* user)
123 ServerInstance->Logs->Log("map",DEBUG,"HandleMap");
124 if ((pcnt > 0) && (IS_OPER(user)))
126 ServerInstance->Logs->Log("remotemap", DEBUG, "remote map request for %s", parameters[0]);
128 /* Remote MAP, the server is within the 1st parameter */
129 TreeServer* s = Utils->FindServerMask(parameters[0]);
133 ServerInstance->Logs->Log("remotemap", DEBUG, "lolnoserver %s", parameters[0]);
134 user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
137 else if (s && s != Utils->TreeRoot)
139 ServerInstance->Logs->Log("remotemap", DEBUG, "lol routing to %s", parameters[0]);
140 std::deque<std::string> params;
141 params.push_back(parameters[0]);
143 params[0] = s->GetName();
144 Utils->DoOneToOne(user->uuid, "MAP", params, s->GetName());
149 ServerInstance->Logs->Log("remotemap", DEBUG, "lol it's me");
152 // Don't return if s == Utils->TreeRoot (us)
157 // This array represents a virtual screen which we will
158 // "scratch" draw to, as the console device of an irc
159 // client does not provide for a proper terminal.
161 float totservers = 0;
162 static char matrix[128][128];
164 for (unsigned int t = 0; t < 128; t++)
171 // The only recursive bit is called here.
172 ShowMap(Utils->TreeRoot,user,0,matrix,totusers,totservers);
174 // Process each line one by one. The algorithm has a limit of
175 // 128 servers (which is far more than a spanning tree should have
176 // anyway, so we're ok). This limit can be raised simply by making
177 // the character matrix deeper, 128 rows taking 10k of memory.
178 for (int l = 1; l < line; l++)
180 // scan across the line looking for the start of the
181 // servername (the recursive part of the algorithm has placed
182 // the servers at indented positions depending on what they
184 int first_nonspace = 0;
186 while (matrix[l][first_nonspace] == ' ')
193 // Draw the `- (corner) section: this may be overwritten by
194 // another L shape passing along the same vertical pane, becoming
195 // a |- (branch) section instead.
197 matrix[l][first_nonspace] = '-';
198 matrix[l][first_nonspace-1] = '`';
201 // Draw upwards until we hit the parent server, causing possibly
202 // other corners (`-) to become branches (|-)
203 while ((matrix[l2][first_nonspace-1] == ' ') || (matrix[l2][first_nonspace-1] == '`'))
205 matrix[l2][first_nonspace-1] = '|';
210 float avg_users = totusers / totservers;
212 // dump the whole lot to the user.
215 ServerInstance->Logs->Log("map",DEBUG,"local");
216 for (int t = 0; t < line; t++)
218 user->WriteNumeric(6, "%s :%s",user->nick,&matrix[t][0]);
220 user->WriteNumeric(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);
221 user->WriteNumeric(7, "%s :End of /MAP",user->nick);
226 //void SpanningTreeProtocolInterface::PushToClient(User* target, const std::string &rawline)
228 ServerInstance->Logs->Log("map", DEBUG, "remote dump lines=%d", line);
230 for (int t = 0; t < line; t++)
232 ServerInstance->Logs->Log("map",DEBUG,"Dump %d", line);
233 ServerInstance->PI->PushToClient(user, std::string("::") + ServerInstance->Config->ServerName + " 006 " + user->nick + " :" + &matrix[t][0]);
236 ServerInstance->PI->PushToClient(user, std::string("::") + ServerInstance->Config->ServerName + " 270 " + user->nick + " :" + ConvToStr(totservers) + " user"+(totservers > 1 ? "s" : "") + " and " + ConvToStr(totusers) + " server"+(totusers > 1 ? "s" : "") + ", average " + ConvToStr(avg_users) + " users per server");
237 ServerInstance->PI->PushToClient(user, std::string("::") + ServerInstance->Config->ServerName + " 007 " + user->nick + " :End of /MAP");