src/modules/m_spanningtree/override_map.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *        the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 /* $ModDesc: Provides a spanning tree server link protocol */
  15
  16 #include "inspircd.h"
  17 #include "commands/cmd_whois.h"
  18 #include "commands/cmd_stats.h"
  19 #include "socket.h"
  20 #include "wildcard.h"
  21 #include "xline.h"
  22 #include "transport.h"
  23
  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"
  33
  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 */
  35
  36 const std::string ModuleSpanningTree::MapOperInfo(TreeServer* Current)
  37 {
  38         time_t secs_up = ServerInstance->Time() - Current->age;
  39         return (" [Up: " + TimeToStr(secs_up) + " Lag: "+ConvToStr(Current->rtt)+"ms]");
  40 }
  41
  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)
  44 {
  45         ServerInstance->Logs->Log("map",DEBUG,"ShowMap depth %d totusers %0.2f totservers %0.2f", depth, totusers, totservers);
  46         if (line < 128)
  47         {
  48                 for (int t = 0; t < depth; t++)
  49                 {
  50                         ServerInstance->Logs->Log("map",DEBUG,"Zero to depth");
  51                         matrix[line][t] = ' ';
  52                 }
  53
  54                 // For Aligning, we need to work out exactly how deep this thing is, and produce
  55                 // a 'Spacer' String to compensate.
  56                 char spacer[40];
  57                 memset(spacer,' ',40);
  58                 if ((40 - Current->GetName().length() - depth) > 1) {
  59                         spacer[40 - Current->GetName().length() - depth] = '\0';
  60                 }
  61                 else
  62                 {
  63                         spacer[5] = '\0';
  64                 }
  65
  66                 float percent;
  67                 char text[128];
  68                 /* Neat and tidy default values, as we're dealing with a matrix not a simple string */
  69                 memset(text, 0, 128);
  70
  71                 if (ServerInstance->Users->clientlist->size() == 0)
  72                 {
  73                         // If there are no users, WHO THE HELL DID THE /MAP?!?!?!
  74                         percent = 0;
  75                 }
  76                 else
  77                 {
  78                         percent = ((float)Current->GetUserCount() / (float)ServerInstance->Users->clientlist->size()) * 100;
  79                 }
  80
  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();
  84                 totservers++;
  85                 strlcpy(&matrix[line][depth],text,126);
  86                 line++;
  87
  88                 ServerInstance->Logs->Log("map",DEBUG,"Increment line to %d", line);
  89
  90                 for (unsigned int q = 0; q < Current->ChildCount(); q++)
  91                 {
  92                         if ((Current->GetChild(q)->Hidden) || ((Utils->HideULines) && (ServerInstance->ULine(Current->GetChild(q)->GetName().c_str()))))
  93                         {
  94                                 if (*user->oper)
  95                                 {
  96                                         ShowMap(Current->GetChild(q),user,(Utils->FlatLinks && (!*user->oper)) ? depth : depth+2,matrix,totusers,totservers);
  97                                 }
  98                         }
  99                         else
 100                         {
 101                                 ShowMap(Current->GetChild(q),user,(Utils->FlatLinks && (!*user->oper)) ? depth : depth+2,matrix,totusers,totservers);
 102                         }
 103                 }
 104         }
 105 }
 106
 107
 108 // Ok, prepare to be confused.
 109 // After much mulling over how to approach this, it struck me that
 110 // the 'usual' way of doing a /MAP isnt the best way. Instead of
 111 // keeping track of a ton of ascii characters, and line by line
 112 // under recursion working out where to place them using multiplications
 113 // and divisons, we instead render the map onto a backplane of characters
 114 // (a character matrix), then draw the branches as a series of "L" shapes
 115 // from the nodes. This is not only friendlier on CPU it uses less stack.
 116 int ModuleSpanningTree::HandleMap(const char* const* parameters, int pcnt, User* user)
 117 {
 118         ServerInstance->Logs->Log("map",DEBUG,"HandleMap");
 119         if (pcnt > 0)
 120         {
 121                 ServerInstance->Logs->Log("remotemap", DEBUG, "remote map request for %s", parameters[0]);
 122
 123                 /* Remote MAP, the server is within the 1st parameter */
 124                 TreeServer* s = Utils->FindServerMask(parameters[0]);
 125                 bool ret = false;
 126                 if (!s)
 127                 {
 128                         ServerInstance->Logs->Log("remotemap", DEBUG, "lolnoserver %s", parameters[0]);
 129                         user->WriteServ( "402 %s %s :No such server", user->nick, parameters[0]);
 130                         ret = true;
 131                 }
 132                 else if (s && s != Utils->TreeRoot)
 133                 {
 134                         ServerInstance->Logs->Log("remotemap", DEBUG, "lol routing to %s", parameters[0]);
 135                         std::deque<std::string> params;
 136                         params.push_back(parameters[0]);
 137
 138                         params[0] = s->GetName();
 139                         Utils->DoOneToOne(user->uuid, "MAP", params, s->GetName());
 140                         ret = true;
 141                 }
 142                 else
 143                 {
 144                         ServerInstance->Logs->Log("remotemap", DEBUG, "lol it's me");
 145                 }
 146
 147                 // Don't return if s == Utils->TreeRoot (us)
 148                 if (ret)
 149                         return 1;
 150         }
 151
 152         // This array represents a virtual screen which we will
 153         // "scratch" draw to, as the console device of an irc
 154         // client does not provide for a proper terminal.
 155         float totusers = 0;
 156         float totservers = 0;
 157         static char matrix[128][128];
 158
 159         for (unsigned int t = 0; t < 128; t++)
 160         {
 161                 matrix[t][0] = '\0';
 162         }
 163
 164         line = 0;
 165
 166         // The only recursive bit is called here.
 167         ShowMap(Utils->TreeRoot,user,0,matrix,totusers,totservers);
 168
 169         // Process each line one by one. The algorithm has a limit of
 170         // 128 servers (which is far more than a spanning tree should have
 171         // anyway, so we're ok). This limit can be raised simply by making
 172         // the character matrix deeper, 128 rows taking 10k of memory.
 173         for (int l = 1; l < line; l++)
 174         {
 175                 // scan across the line looking for the start of the
 176                 // servername (the recursive part of the algorithm has placed
 177                 // the servers at indented positions depending on what they
 178                 // are related to)
 179                 int first_nonspace = 0;
 180
 181                 while (matrix[l][first_nonspace] == ' ')
 182                 {
 183                         first_nonspace++;
 184                 }
 185
 186                 first_nonspace--;
 187
 188                 // Draw the `- (corner) section: this may be overwritten by
 189                 // another L shape passing along the same vertical pane, becoming
 190                 // a |- (branch) section instead.
 191
 192                 matrix[l][first_nonspace] = '-';
 193                 matrix[l][first_nonspace-1] = '`';
 194                 int l2 = l - 1;
 195
 196                 // Draw upwards until we hit the parent server, causing possibly
 197                 // other corners (`-) to become branches (|-)
 198                 while ((matrix[l2][first_nonspace-1] == ' ') || (matrix[l2][first_nonspace-1] == '`'))
 199                 {
 200                         matrix[l2][first_nonspace-1] = '|';
 201                         l2--;
 202                 }
 203         }
 204
 205         float avg_users = totusers / totservers;
 206
 207         // dump the whole lot to the user.
 208         if (IS_LOCAL(user))
 209         {
 210                 ServerInstance->Logs->Log("map",DEBUG,"local");
 211                 for (int t = 0; t < line; t++)
 212                 {
 213                         user->WriteNumeric(6, "%s :%s",user->nick,&matrix[t][0]);
 214                 }
 215                 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);
 216                 user->WriteNumeric(7, "%s :End of /MAP",user->nick);
 217         }
 218         else
 219         {
 220
 221                 //void SpanningTreeProtocolInterface::PushToClient(User* target, const std::string &rawline)
 222                 //
 223                 ServerInstance->Logs->Log("map", DEBUG, "remote dump lines=%d", line);
 224
 225                 for (int t = 0; t < line; t++)
 226                 {
 227                         ServerInstance->Logs->Log("map",DEBUG,"Dump %d", line);
 228                         ServerInstance->PI->PushToClient(user, std::string("::") + ServerInstance->Config->ServerName + " 006 " + user->nick + " :" + &matrix[t][0]);
 229                 }
 230
 231                 ServerInstance->PI->PushToClient(user, std::string("::") + ServerInstance->Config->ServerName + " 270 " + user->nick + " :" + ConvToStr(totservers) + (totservers > 1 ? "s" : "") + " and " + ConvToStr(totusers) + (totusers > 1 ? "s" : "") + ", average " + ConvToStr(avg_users) + " users per server");
 232                 ServerInstance->PI->PushToClient(user, std::string("::") + ServerInstance->Config->ServerName + " 007 " + user->nick + " :End of /MAP");
 233         }
 234
 235         return 1;
 236 }
 237