src/modules/m_spanningtree/override_map.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2007 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         if (line < 128)
  46         {
  47                 for (int t = 0; t < depth; t++)
  48                 {
  49                         matrix[line][t] = ' ';
  50                 }
  51                 // For Aligning, we need to work out exactly how deep this thing is, and produce
  52                 // a 'Spacer' String to compensate.
  53                 char spacer[40];
  54                 memset(spacer,' ',40);
  55                 if ((40 - Current->GetName().length() - depth) > 1) {
  56                         spacer[40 - Current->GetName().length() - depth] = '\0';
  57                 }
  58                 else
  59                 {
  60                         spacer[5] = '\0';
  61                 }
  62                 float percent;
  63                 char text[128];
  64                 /* Neat and tidy default values, as we're dealing with a matrix not a simple string */
  65                 memset(text, 0, 128);
  66
  67                 if (ServerInstance->clientlist->size() == 0) {
  68                         // If there are no users, WHO THE HELL DID THE /MAP?!?!?!
  69                         percent = 0;
  70                 }
  71                 else
  72                 {
  73                         percent = ((float)Current->GetUserCount() / (float)ServerInstance->clientlist->size()) * 100;
  74                 }
  75                 const std::string operdata = IS_OPER(user) ? MapOperInfo(Current) : "";
  76                 snprintf(text, 126, "%s %s%5d [%5.2f%%]%s", Current->GetName().c_str(), spacer, Current->GetUserCount(), percent, operdata.c_str());
  77                 totusers += Current->GetUserCount();
  78                 totservers++;
  79                 strlcpy(&matrix[line][depth],text,126);
  80                 line++;
  81                 for (unsigned int q = 0; q < Current->ChildCount(); q++)
  82                 {
  83                         if ((Current->GetChild(q)->Hidden) || ((Utils->HideULines) && (ServerInstance->ULine(Current->GetChild(q)->GetName().c_str()))))
  84                         {
  85                                 if (*user->oper)
  86                                 {
  87                                         ShowMap(Current->GetChild(q),user,(Utils->FlatLinks && (!*user->oper)) ? depth : depth+2,matrix,totusers,totservers);
  88                                 }
  89                         }
  90                         else
  91                         {
  92                                 ShowMap(Current->GetChild(q),user,(Utils->FlatLinks && (!*user->oper)) ? depth : depth+2,matrix,totusers,totservers);
  93                         }
  94                 }
  95         }
  96 }
  97
  98
  99 // Ok, prepare to be confused.
 100 // After much mulling over how to approach this, it struck me that
 101 // the 'usual' way of doing a /MAP isnt the best way. Instead of
 102 // keeping track of a ton of ascii characters, and line by line
 103 // under recursion working out where to place them using multiplications
 104 // and divisons, we instead render the map onto a backplane of characters
 105 // (a character matrix), then draw the branches as a series of "L" shapes
 106 // from the nodes. This is not only friendlier on CPU it uses less stack.
 107 void ModuleSpanningTree::HandleMap(const char** parameters, int pcnt, User* user)
 108 {
 109         // This array represents a virtual screen which we will
 110         // "scratch" draw to, as the console device of an irc
 111         // client does not provide for a proper terminal.
 112         float totusers = 0;
 113         float totservers = 0;
 114         char matrix[128][128];
 115         for (unsigned int t = 0; t < 128; t++)
 116         {
 117                 matrix[t][0] = '\0';
 118         }
 119         line = 0;
 120         // The only recursive bit is called here.
 121         ShowMap(Utils->TreeRoot,user,0,matrix,totusers,totservers);
 122         // Process each line one by one. The algorithm has a limit of
 123         // 128 servers (which is far more than a spanning tree should have
 124         // anyway, so we're ok). This limit can be raised simply by making
 125         // the character matrix deeper, 128 rows taking 10k of memory.
 126         for (int l = 1; l < line; l++)
 127         {
 128                 // scan across the line looking for the start of the
 129                 // servername (the recursive part of the algorithm has placed
 130                 // the servers at indented positions depending on what they
 131                 // are related to)
 132                 int first_nonspace = 0;
 133                 while (matrix[l][first_nonspace] == ' ')
 134                 {
 135                         first_nonspace++;
 136                 }
 137                 first_nonspace--;
 138                 // Draw the `- (corner) section: this may be overwritten by
 139                 // another L shape passing along the same vertical pane, becoming
 140                 // a |- (branch) section instead.
 141                 matrix[l][first_nonspace] = '-';
 142                 matrix[l][first_nonspace-1] = '`';
 143                 int l2 = l - 1;
 144                 // Draw upwards until we hit the parent server, causing possibly
 145                 // other corners (`-) to become branches (|-)
 146                 while ((matrix[l2][first_nonspace-1] == ' ') || (matrix[l2][first_nonspace-1] == '`'))
 147                 {
 148                         matrix[l2][first_nonspace-1] = '|';
 149                         l2--;
 150                 }
 151         }
 152         // dump the whole lot to the user. This is the easy bit, honest.
 153         for (int t = 0; t < line; t++)
 154         {
 155                 user->WriteServ("006 %s :%s",user->nick,&matrix[t][0]);
 156         }
 157         float avg_users = totusers / totservers;
 158         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);
 159         user->WriteServ("007 %s :End of /MAP",user->nick);
 160         return;
 161 }
 162