]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_spanningtree/override_map.cpp
Convert WriteNumeric() calls to pass the parameters of the numeric as method parameters
[user/henk/code/inspircd.git] / src / modules / m_spanningtree / override_map.cpp
index 1eb85761c2d30c5e77da1b955f19ef7fabf70dfd..7ae6c6b4a0203a4ef34be878a0c578e88760cdd3 100644 (file)
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2010 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2014 Adam <Adam@anope.org>
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2007-2008 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
  *
- * This program is free but copyrighted software; see
- *       the file COPYING for details.
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
  *
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/* $ModDesc: Provides a spanning tree server link protocol */
 
 #include "inspircd.h"
 
 #include "main.h"
 #include "utils.h"
 #include "treeserver.h"
-#include "treesocket.h"
-
-/* $ModDep: m_spanningtree/main.h m_spanningtree/utils.h m_spanningtree/treeserver.h m_spanningtree/treesocket.h */
+#include "commands.h"
 
-const std::string ModuleSpanningTree::MapOperInfo(TreeServer* Current)
+CommandMap::CommandMap(Module* Creator)
+       : Command(Creator, "MAP", 0, 1)
 {
-       time_t secs_up = ServerInstance->Time() - Current->age;
-       return " [Up: " + TimeToStr(secs_up) + (Current->rtt == 0 ? "]" : " Lag: " + ConvToStr(Current->rtt) + "ms]");
+       Penalty = 2;
 }
 
-void ModuleSpanningTree::ShowMap(TreeServer* Current, User* user, int depth, int &line, char* names, int &maxnamew, char* stats)
+static inline bool IsHidden(User* user, TreeServer* server)
 {
-       ServerInstance->Logs->Log("map",DEBUG,"ShowMap depth %d on line %d", depth, line);
-       float percent;
-
-       if (ServerInstance->Users->clientlist->size() == 0)
+       if (!user->IsOper())
        {
-               // If there are no users, WHO THE HELL DID THE /MAP?!?!?!
-               percent = 0;
+               if (server->Hidden)
+                       return true;
+               if (Utils->HideULines && server->IsULine())
+                       return true;
        }
-       else
+
+       return false;
+}
+
+// Calculate the map depth the servers go, and the longest server name
+static void GetDepthAndLen(TreeServer* current, unsigned int depth, unsigned int& max_depth, unsigned int& max_len)
+{
+       if (depth > max_depth)
+               max_depth = depth;
+       if (current->GetName().length() > max_len)
+               max_len = current->GetName().length();
+
+       const TreeServer::ChildServers& servers = current->GetChildren();
+       for (TreeServer::ChildServers::const_iterator i = servers.begin(); i != servers.end(); ++i)
        {
-               percent = Current->GetUserCount() * 100.0 / ServerInstance->Users->clientlist->size();
+               TreeServer* child = *i;
+               GetDepthAndLen(child, depth + 1, max_depth, max_len);
        }
+}
 
-       const std::string operdata = IS_OPER(user) ? MapOperInfo(Current) : "";
-
-       char* myname = names + 100 * line;
-       char* mystat = stats + 50 * line;
-       memset(myname, ' ', depth);
-       int w = depth;
+static std::vector<std::string> GetMap(User* user, TreeServer* current, unsigned int max_len, unsigned int depth)
+{
+       float percent = 0;
 
-       if (IS_OPER(user))
+       const user_hash& users = ServerInstance->Users->GetUsers();
+       if (!users.empty())
        {
-               w += snprintf(myname + depth, 99 - depth, "%s (%s)", Current->GetName().c_str(), Current->GetID().c_str());
+               // If there are no users, WHO THE HELL DID THE /MAP?!?!?!
+               percent = current->UserCount * 100.0 / users.size();
        }
-       else
+
+       std::string buffer = current->GetName();
+       if (user->IsOper())
        {
-               w += snprintf(myname + depth, 99 - depth, "%s", Current->GetName().c_str());
+               buffer += " (" + current->GetID() + ")";
        }
-       memset(myname + w, ' ', 100 - w);
-       if (w > maxnamew)
-               maxnamew = w;
-       snprintf(mystat, 49, "%5d [%5.2f%%]%s", Current->GetUserCount(), percent, operdata.c_str());
 
-       line++;
+       // Pad with spaces until its at max len, max_len must always be >= my names length
+       buffer.append(max_len - current->GetName().length(), ' ');
+
+       char buf[16];
+       snprintf(buf, sizeof(buf), "%5d [%5.2f%%]", current->UserCount, percent);
+       buffer += buf;
 
-       if (IS_OPER(user) || !Utils->FlatLinks)
-               depth = depth + 2;
-       for (unsigned int q = 0; q < Current->ChildCount(); q++)
+       if (user->IsOper())
        {
-               TreeServer* child = Current->GetChild(q);
-               if (!IS_OPER(user)) {
-                       if (child->Hidden)
-                               continue;
-                       if ((Utils->HideULines) && (ServerInstance->ULine(child->GetName().c_str())))
-                               continue;
-               }
-               ShowMap(child, user, depth, line, names, maxnamew, stats);
+               time_t secs_up = ServerInstance->Time() - current->age;
+               buffer += " [Up: " + ModuleSpanningTree::TimeToStr(secs_up) + (current->rtt == 0 ? "]" : " Lag: " + ConvToStr(current->rtt) + "ms]");
        }
-}
 
+       std::vector<std::string> map;
+       map.push_back(buffer);
 
-// Ok, prepare to be confused.
-// After much mulling over how to approach this, it struck me that
-// the 'usual' way of doing a /MAP isnt the best way. Instead of
-// keeping track of a ton of ascii characters, and line by line
-// under recursion working out where to place them using multiplications
-// and divisons, we instead render the map onto a backplane of characters
-// (a character matrix), then draw the branches as a series of "L" shapes
-// from the nodes. This is not only friendlier on CPU it uses less stack.
-bool ModuleSpanningTree::HandleMap(const std::vector<std::string>& parameters, User* user)
-{
-       if (parameters.size() > 0)
+       const TreeServer::ChildServers& servers = current->GetChildren();
+       for (TreeServer::ChildServers::const_iterator i = servers.begin(); i != servers.end(); ++i)
        {
-               /* Remote MAP, the server is within the 1st parameter */
-               TreeServer* s = Utils->FindServerMask(parameters[0]);
-               bool ret = false;
-               if (!s)
+               TreeServer* child = *i;
+
+               if (IsHidden(user, child))
+                       continue;
+
+               bool last = true;
+               for (TreeServer::ChildServers::const_iterator j = i + 1; last && j != servers.end(); ++j)
+                       if (!IsHidden(user, *j))
+                               last = false;
+
+               unsigned int next_len;
+
+               if (user->IsOper() || !Utils->FlatLinks)
                {
-                       user->WriteNumeric(ERR_NOSUCHSERVER, "%s %s :No such server", user->nick.c_str(), parameters[0].c_str());
-                       ret = true;
+                       // This child is indented by us, so remove the depth from the max length to align the users properly
+                       next_len = max_len - 2;
                }
-               else if (s && s != Utils->TreeRoot)
+               else
                {
-                       parameterlist params;
-                       params.push_back(parameters[0]);
-
-                       params[0] = s->GetName();
-                       Utils->DoOneToOne(user->uuid, "MAP", params, s->GetName());
-                       ret = true;
+                       // This user can not see depth, so max_len remains constant
+                       next_len = max_len;
                }
 
-               // Don't return if s == Utils->TreeRoot (us)
-               if (ret)
-                       return true;
-       }
+               // Build the map for this child
+               std::vector<std::string> child_map = GetMap(user, child, next_len, depth + 1);
 
-       // These arrays represent a virtual screen which we will
-       // "scratch" draw to, as the console device of an irc
-       // client does not provide for a proper terminal.
-       int totusers = ServerInstance->Users->clientlist->size();
-       int totservers = this->CountServs();
-       int maxnamew = 0;
-       int line = 0;
-       char* names = new char[totservers * 100];
-       char* stats = new char[totservers * 50];
-
-       // The only recursive bit is called here.
-       ShowMap(Utils->TreeRoot,user,0,line,names,maxnamew,stats);
-
-       // Process each line one by one.
-       for (int l = 1; l < line; l++)
-       {
-               char* myname = names + 100 * l;
-               // scan across the line looking for the start of the
-               // servername (the recursive part of the algorithm has placed
-               // the servers at indented positions depending on what they
-               // are related to)
-               int first_nonspace = 0;
-
-               while (myname[first_nonspace] == ' ')
+               for (std::vector<std::string>::const_iterator j = child_map.begin(); j != child_map.end(); ++j)
                {
-                       first_nonspace++;
+                       const char* prefix;
+
+                       if (user->IsOper() || !Utils->FlatLinks)
+                       {
+                               // If this server is not the root child
+                               if (j != child_map.begin())
+                               {
+                                       // If this child is not my last child, then add |
+                                       // to be able to "link" the next server in my list to me, and to indent this childs servers
+                                       if (!last)
+                                               prefix = "| ";
+                                       // Otherwise this is my last child, so just use a space as theres nothing else linked to me below this
+                                       else
+                                               prefix = "  ";
+                               }
+                               // If we get here, this server must be the root child
+                               else
+                               {
+                                       // If this is the last child, it gets a `-
+                                       if (last)
+                                               prefix = "`-";
+                                       // Otherwise this isn't the last child, so it gets |-
+                                       else
+                                               prefix = "|-";
+                               }
+                       }
+                       else
+                               // User can't see depth, so use no prefix
+                               prefix = "";
+
+                       // Add line to the map
+                       map.push_back(prefix + *j);
                }
+       }
 
-               first_nonspace--;
-
-               // Draw the `- (corner) section: this may be overwritten by
-               // another L shape passing along the same vertical pane, becoming
-               // a |- (branch) section instead.
-
-               myname[first_nonspace] = '-';
-               myname[first_nonspace-1] = '`';
-               int l2 = l - 1;
+       return map;
+}
 
-               // Draw upwards until we hit the parent server, causing possibly
-               // other corners (`-) to become branches (|-)
-               while ((names[l2 * 100 + first_nonspace-1] == ' ') || (names[l2 * 100 + first_nonspace-1] == '`'))
+CmdResult CommandMap::Handle(const std::vector<std::string>& parameters, User* user)
+{
+       if (parameters.size() > 0)
+       {
+               // Remote MAP, the target server is the 1st parameter
+               TreeServer* s = Utils->FindServerMask(parameters[0]);
+               if (!s)
                {
-                       names[l2 * 100 + first_nonspace-1] = '|';
-                       l2--;
+                       user->WriteNumeric(ERR_NOSUCHSERVER, parameters[0], "No such server");
+                       return CMD_FAILURE;
                }
+
+               if (!s->IsRoot())
+                       return CMD_SUCCESS;
        }
 
-       float avg_users = totusers * 1.0 / line;
+       // Max depth and max server name length
+       unsigned int max_depth = 0;
+       unsigned int max_len = 0;
+       GetDepthAndLen(Utils->TreeRoot, 0, max_depth, max_len);
 
-       ServerInstance->Logs->Log("map",DEBUG,"local");
-       for (int t = 0; t < line; t++)
+       unsigned int max;
+       if (user->IsOper() || !Utils->FlatLinks)
+       {
+               // Each level of the map is indented by 2 characters, making the max possible line (max_depth * 2) + max_len
+               max = (max_depth * 2) + max_len;
+       }
+       else
        {
-               // terminate the string at maxnamew characters
-               names[100 * t + maxnamew] = '\0';
-               user->SendText(":%s %d %s :%s %s", ServerInstance->Config->ServerName.c_str(),
-                       RPL_MAP, user->nick.c_str(), names + 100 * t, stats + 50 * t);
+               // This user can't see any depth
+               max = max_len;
        }
-       user->SendText(":%s %d %s :%d server%s and %d user%s, average %.2f users per server",
+
+       std::vector<std::string> map = GetMap(user, Utils->TreeRoot, max, 0);
+       for (std::vector<std::string>::const_iterator i = map.begin(); i != map.end(); ++i)
+               user->SendText(":%s %03d %s :%s", ServerInstance->Config->ServerName.c_str(),
+                       RPL_MAP, user->nick.c_str(), i->c_str());
+
+       size_t totusers = ServerInstance->Users->GetUsers().size();
+       float avg_users = (float) totusers / Utils->serverlist.size();
+
+       user->SendText(":%s %03d %s :%u server%s and %u user%s, average %.2f users per server",
                ServerInstance->Config->ServerName.c_str(), RPL_MAPUSERS, user->nick.c_str(),
-               line, (line > 1 ? "s" : ""), totusers, (totusers > 1 ? "s" : ""), avg_users);
-       user->SendText(":%s %d %s :End of /MAP", ServerInstance->Config->ServerName.c_str(),
+               (unsigned int)Utils->serverlist.size(), (Utils->serverlist.size() > 1 ? "s" : ""), (unsigned int)totusers, (totusers > 1 ? "s" : ""), avg_users);
+       user->SendText(":%s %03d %s :End of /MAP", ServerInstance->Config->ServerName.c_str(),
                RPL_ENDMAP, user->nick.c_str());
 
-       delete[] names;
-       delete[] stats;
-
-       return true;
+       return CMD_SUCCESS;
 }
 
+RouteDescriptor CommandMap::GetRouting(User* user, const std::vector<std::string>& parameters)
+{
+       if (!parameters.empty())
+               return ROUTE_UNICAST(parameters[0]);
+       return ROUTE_LOCALONLY;
+}