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