]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_spanningtree/override_map.cpp
Merge insp20
[user/henk/code/inspircd.git] / src / modules / m_spanningtree / override_map.cpp
index a6bff8aba0cc2c2977d234e31c624a36fa57912f..68551e84f5ba22359cdd4e3a0235c181a4ae40ba 100644 (file)
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/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 "commands/cmd_whois.h"
-#include "commands/cmd_stats.h"
-#include "socket.h"
-#include "wildcard.h"
-#include "xline.h"      
-#include "transport.h"  
-                        
-#include "m_spanningtree/timesynctimer.h"
-#include "m_spanningtree/resolvers.h"
-#include "m_spanningtree/main.h"
-#include "m_spanningtree/utils.h"
-#include "m_spanningtree/treeserver.h"
-#include "m_spanningtree/link.h"
-#include "m_spanningtree/treesocket.h"
-#include "m_spanningtree/rconnect.h"
-#include "m_spanningtree/rsquit.h"
-
-/* $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 */
-
-const std::string ModuleSpanningTree::MapOperInfo(TreeServer* Current)
-{                       
-        time_t secs_up = ServerInstance->Time() - Current->age;
-        return (" [Up: " + TimeToStr(secs_up) + " Lag: "+ConvToStr(Current->rtt)+"ms]");
-}               
-                
-// WARNING: NOT THREAD SAFE - DONT GET ANY SMART IDEAS.
-void ModuleSpanningTree::ShowMap(TreeServer* Current, userrec* user, int depth, char matrix[128][128], float &totusers, float &totservers)
-{               
-        if (line < 128)
-        {               
-                for (int t = 0; t < depth; t++)
-                {
-                        matrix[line][t] = ' ';
-                }       
-                // For Aligning, we need to work out exactly how deep this thing is, and produce
-                // a 'Spacer' String to compensate.
-                char spacer[40];
-                memset(spacer,' ',40);
-                if ((40 - Current->GetName().length() - depth) > 1) {
-                        spacer[40 - Current->GetName().length() - depth] = '\0';
-                }
-                else
-                {
-                        spacer[5] = '\0';
-                }       
-                float percent;
-                char text[128];
-                /* Neat and tidy default values, as we're dealing with a matrix not a simple string */
-                memset(text, 0, 128);
-
-                if (ServerInstance->clientlist->size() == 0) {
-                        // If there are no users, WHO THE HELL DID THE /MAP?!?!?!
-                        percent = 0;
-                }
-                else
-                {
-                        percent = ((float)Current->GetUserCount() / (float)ServerInstance->clientlist->size()) * 100;
-                }
-                const std::string operdata = IS_OPER(user) ? MapOperInfo(Current) : "";
-                snprintf(text, 126, "%s %s%5d [%5.2f%%]%s", Current->GetName().c_str(), spacer, Current->GetUserCount(), percent, operdata.c_str());
-                totusers += Current->GetUserCount();
-                totservers++;
-                strlcpy(&matrix[line][depth],text,126);
-                line++;
-                for (unsigned int q = 0; q < Current->ChildCount(); q++)
-                {
-                        if ((Current->GetChild(q)->Hidden) || ((Utils->HideULines) && (ServerInstance->ULine(Current->GetChild(q)->GetName().c_str()))))
-                        {
-                                if (*user->oper)
-                                {
-                                        ShowMap(Current->GetChild(q),user,(Utils->FlatLinks && (!*user->oper)) ? depth : depth+2,matrix,totusers,totservers);
-                                }
-                        }
-                        else
-                        {
-                                ShowMap(Current->GetChild(q),user,(Utils->FlatLinks && (!*user->oper)) ? depth : depth+2,matrix,totusers,totservers);
-                        }
-                }
-        }
+
+#include "main.h"
+#include "utils.h"
+#include "treeserver.h"
+#include "commands.h"
+
+CommandMap::CommandMap(Module* Creator)
+       : Command(Creator, "MAP", 0, 1)
+{
+       Penalty = 2;
+}
+
+static inline bool IsHidden(User* user, TreeServer* server)
+{
+       if (!user->IsOper())
+       {
+               if (server->Hidden)
+                       return true;
+               if (Utils->HideULines && server->IsULine())
+                       return true;
+       }
+
+       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)
+       {
+               TreeServer* child = *i;
+               GetDepthAndLen(child, depth + 1, max_depth, max_len);
+       }
 }
 
+static std::vector<std::string> GetMap(User* user, TreeServer* current, unsigned int max_len, unsigned int depth)
+{
+       float percent = 0;
+
+       const user_hash& users = ServerInstance->Users->GetUsers();
+       if (!users.empty())
+       {
+               // If there are no users, WHO THE HELL DID THE /MAP?!?!?!
+               percent = current->UserCount * 100.0 / users.size();
+       }
+
+       std::string buffer = current->GetName();
+       if (user->IsOper())
+       {
+               buffer += " (" + current->GetID() + ")";
+       }
+
+       // 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 (user->IsOper())
+       {
+               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.
-void ModuleSpanningTree::HandleMap(const char** parameters, int pcnt, userrec* user)
+       const TreeServer::ChildServers& servers = current->GetChildren();
+       for (TreeServer::ChildServers::const_iterator i = servers.begin(); i != servers.end(); ++i)
+       {
+               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)
+               {
+                       // 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
+               {
+                       // This user can not see depth, so max_len remains constant
+                       next_len = max_len;
+               }
+
+               // Build the map for this child
+               std::vector<std::string> child_map = GetMap(user, child, next_len, depth + 1);
+
+               for (std::vector<std::string>::const_iterator j = child_map.begin(); j != child_map.end(); ++j)
+               {
+                       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);
+               }
+       }
+
+       return map;
+}
+
+CmdResult CommandMap::Handle(const std::vector<std::string>& parameters, User* user)
 {
-        // This array represents a virtual screen which we will
-        // "scratch" draw to, as the console device of an irc
-        // client does not provide for a proper terminal.
-        float totusers = 0;
-        float totservers = 0;
-        char matrix[128][128];
-        for (unsigned int t = 0; t < 128; t++)
-        {
-                matrix[t][0] = '\0';
-        }
-        line = 0;
-        // The only recursive bit is called here.
-        ShowMap(Utils->TreeRoot,user,0,matrix,totusers,totservers);
-        // Process each line one by one. The algorithm has a limit of
-        // 128 servers (which is far more than a spanning tree should have
-        // anyway, so we're ok). This limit can be raised simply by making
-        // the character matrix deeper, 128 rows taking 10k of memory.
-        for (int l = 1; l < line; 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 (matrix[l][first_nonspace] == ' ')
-                {
-                        first_nonspace++;
-                }
-                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.
-                matrix[l][first_nonspace] = '-';
-                matrix[l][first_nonspace-1] = '`';
-                int l2 = l - 1;
-                // Draw upwards until we hit the parent server, causing possibly
-                // other corners (`-) to become branches (|-)
-                while ((matrix[l2][first_nonspace-1] == ' ') || (matrix[l2][first_nonspace-1] == '`'))
-                {
-                        matrix[l2][first_nonspace-1] = '|';
-                        l2--;
-                }
-        }
-        // dump the whole lot to the user. This is the easy bit, honest.
-        for (int t = 0; t < line; t++)
-        {
-                user->WriteServ("006 %s :%s",user->nick,&matrix[t][0]);
-        }
-        float avg_users = totusers / totservers;
-        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);
-        user->WriteServ("007 %s :End of /MAP",user->nick);
-        return;
+       if (parameters.size() > 0)
+       {
+               /* Remote MAP, the server is within the 1st parameter */
+               TreeServer* s = Utils->FindServerMask(parameters[0]);
+               if (!s)
+               {
+                       user->WriteNumeric(ERR_NOSUCHSERVER, "%s :No such server", parameters[0].c_str());
+                       return CMD_FAILURE;
+               }
+
+               if (!s->IsRoot())
+                       return CMD_SUCCESS;
+       }
+
+       // 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);
+
+       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
+       {
+               // This user can't see any depth
+               max = max_len;
+       }
+
+       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(),
+               (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());
+
+       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;
+}