src/modules/m_spanningtree/override_map.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2007-2008 Craig Edwards <craigedwards@brainbox.cc>
   6  *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
   7  *
   8  * This file is part of InspIRCd.  InspIRCd is free software: you can
   9  * redistribute it and/or modify it under the terms of the GNU General Public
  10  * License as published by the Free Software Foundation, version 2.
  11  *
  12  * This program is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  15  * details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21
  22 /* $ModDesc: Provides a spanning tree server link protocol */
  23
  24 #include "inspircd.h"
  25
  26 #include "main.h"
  27 #include "utils.h"
  28 #include "treeserver.h"
  29 #include "treesocket.h"
  30
  31 /* $ModDep: m_spanningtree/main.h m_spanningtree/utils.h m_spanningtree/treeserver.h m_spanningtree/treesocket.h */
  32
  33 const std::string ModuleSpanningTree::MapOperInfo(TreeServer* Current)
  34 {
  35         time_t secs_up = ServerInstance->Time() - Current->age;
  36         return " [Up: " + TimeToStr(secs_up) + (Current->rtt == 0 ? "]" : " Lag: " + ConvToStr(Current->rtt) + "ms]");
  37 }
  38
  39 void ModuleSpanningTree::ShowMap(TreeServer* Current, User* user, int depth, int &line, char* names, int &maxnamew, char* stats)
  40 {
  41         ServerInstance->Logs->Log("map",DEBUG,"ShowMap depth %d on line %d", depth, line);
  42         float percent;
  43
  44         if (ServerInstance->Users->clientlist->size() == 0)
  45         {
  46                 // If there are no users, WHO THE HELL DID THE /MAP?!?!?!
  47                 percent = 0;
  48         }
  49         else
  50         {
  51                 percent = Current->GetUserCount() * 100.0 / ServerInstance->Users->clientlist->size();
  52         }
  53
  54         const std::string operdata = IS_OPER(user) ? MapOperInfo(Current) : "";
  55
  56         char* myname = names + 100 * line;
  57         char* mystat = stats + 50 * line;
  58         memset(myname, ' ', depth);
  59         int w = depth;
  60
  61         if (IS_OPER(user))
  62         {
  63                 w += snprintf(myname + depth, 99 - depth, "%s (%s)", Current->GetName().c_str(), Current->GetID().c_str());
  64         }
  65         else
  66         {
  67                 w += snprintf(myname + depth, 99 - depth, "%s", Current->GetName().c_str());
  68         }
  69         memset(myname + w, ' ', 100 - w);
  70         if (w > maxnamew)
  71                 maxnamew = w;
  72         snprintf(mystat, 49, "%5d [%5.2f%%]%s", Current->GetUserCount(), percent, operdata.c_str());
  73
  74         line++;
  75
  76         if (IS_OPER(user) || !Utils->FlatLinks)
  77                 depth = depth + 2;
  78         for (unsigned int q = 0; q < Current->ChildCount(); q++)
  79         {
  80                 TreeServer* child = Current->GetChild(q);
  81                 if (!IS_OPER(user)) {
  82                         if (child->Hidden)
  83                                 continue;
  84                         if ((Utils->HideULines) && (ServerInstance->ULine(child->GetName().c_str())))
  85                                 continue;
  86                 }
  87                 ShowMap(child, user, depth, line, names, maxnamew, stats);
  88         }
  89 }
  90
  91
  92 // Ok, prepare to be confused.
  93 // After much mulling over how to approach this, it struck me that
  94 // the 'usual' way of doing a /MAP isnt the best way. Instead of
  95 // keeping track of a ton of ascii characters, and line by line
  96 // under recursion working out where to place them using multiplications
  97 // and divisons, we instead render the map onto a backplane of characters
  98 // (a character matrix), then draw the branches as a series of "L" shapes
  99 // from the nodes. This is not only friendlier on CPU it uses less stack.
 100 bool ModuleSpanningTree::HandleMap(const std::vector<std::string>& parameters, User* user)
 101 {
 102         if (parameters.size() > 0)
 103         {
 104                 /* Remote MAP, the server is within the 1st parameter */
 105                 TreeServer* s = Utils->FindServerMask(parameters[0]);
 106                 bool ret = false;
 107                 if (!s)
 108                 {
 109                         user->WriteNumeric(ERR_NOSUCHSERVER, "%s %s :No such server", user->nick.c_str(), parameters[0].c_str());
 110                         ret = true;
 111                 }
 112                 else if (s && s != Utils->TreeRoot)
 113                 {
 114                         parameterlist params;
 115                         params.push_back(parameters[0]);
 116
 117                         params[0] = s->GetName();
 118                         Utils->DoOneToOne(user->uuid, "MAP", params, s->GetName());
 119                         ret = true;
 120                 }
 121
 122                 // Don't return if s == Utils->TreeRoot (us)
 123                 if (ret)
 124                         return true;
 125         }
 126
 127         // These arrays represent a virtual screen which we will
 128         // "scratch" draw to, as the console device of an irc
 129         // client does not provide for a proper terminal.
 130         int totusers = ServerInstance->Users->clientlist->size();
 131         int totservers = this->CountServs();
 132         int maxnamew = 0;
 133         int line = 0;
 134         char* names = new char[totservers * 100];
 135         char* stats = new char[totservers * 50];
 136
 137         // The only recursive bit is called here.
 138         ShowMap(Utils->TreeRoot,user,0,line,names,maxnamew,stats);
 139
 140         // Process each line one by one.
 141         for (int l = 1; l < line; l++)
 142         {
 143                 char* myname = names + 100 * l;
 144                 // scan across the line looking for the start of the
 145                 // servername (the recursive part of the algorithm has placed
 146                 // the servers at indented positions depending on what they
 147                 // are related to)
 148                 int first_nonspace = 0;
 149
 150                 while (myname[first_nonspace] == ' ')
 151                 {
 152                         first_nonspace++;
 153                 }
 154
 155                 first_nonspace--;
 156
 157                 // Draw the `- (corner) section: this may be overwritten by
 158                 // another L shape passing along the same vertical pane, becoming
 159                 // a |- (branch) section instead.
 160
 161                 myname[first_nonspace] = '-';
 162                 myname[first_nonspace-1] = '`';
 163                 int l2 = l - 1;
 164
 165                 // Draw upwards until we hit the parent server, causing possibly
 166                 // other corners (`-) to become branches (|-)
 167                 while ((names[l2 * 100 + first_nonspace-1] == ' ') || (names[l2 * 100 + first_nonspace-1] == '`'))
 168                 {
 169                         names[l2 * 100 + first_nonspace-1] = '|';
 170                         l2--;
 171                 }
 172         }
 173
 174         float avg_users = totusers * 1.0 / line;
 175
 176         ServerInstance->Logs->Log("map",DEBUG,"local");
 177         for (int t = 0; t < line; t++)
 178         {
 179                 // terminate the string at maxnamew characters
 180                 names[100 * t + maxnamew] = '\0';
 181                 user->SendText(":%s %03d %s :%s %s", ServerInstance->Config->ServerName.c_str(),
 182                         RPL_MAP, user->nick.c_str(), names + 100 * t, stats + 50 * t);
 183         }
 184         user->SendText(":%s %03d %s :%d server%s and %d user%s, average %.2f users per server",
 185                 ServerInstance->Config->ServerName.c_str(), RPL_MAPUSERS, user->nick.c_str(),
 186                 line, (line > 1 ? "s" : ""), totusers, (totusers > 1 ? "s" : ""), avg_users);
 187         user->SendText(":%s %03d %s :End of /MAP", ServerInstance->Config->ServerName.c_str(),
 188                 RPL_ENDMAP, user->nick.c_str());
 189
 190         delete[] names;
 191         delete[] stats;
 192
 193         return true;
 194 }
 195