]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_spanningtree/treeserver.cpp
Merge branch 'insp20' into master.
[user/henk/code/inspircd.git] / src / modules / m_spanningtree / treeserver.cpp
index 670f7e420e06f63c4fbdd1a0f4698e94deac300b..ca7959ea7d44dacb8787e9641a00a5ece1ae0767 100644 (file)
@@ -1 +1,294 @@
-/*       +------------------------------------+\r *       | Inspire Internet Relay Chat Daemon |\r *       +------------------------------------+\r *\r *  InspIRCd: (C) 2002-2007 InspIRCd Development Team\r * See: http://www.inspircd.org/wiki/index.php/Credits\r *\r * This program is free but copyrighted software; see\r *            the file COPYING for details.\r *\r * ---------------------------------------------------\r */\r\r#include "inspircd.h"\r#include "configreader.h"\r#include "users.h"\r#include "channels.h"\r#include "modules.h"\r#include "commands/cmd_whois.h"\r#include "commands/cmd_stats.h"\r#include "socket.h"\r#include "wildcard.h"\r#include "xline.h"\r#include "transport.h"\r\r#include "m_spanningtree/utils.h"\r#include "m_spanningtree/treeserver.h"\r\r/* $ModDep: m_spanningtree/utils.h m_spanningtree/treeserver.h */\r\rTreeServer::TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance) : ServerInstance(Instance), Utils(Util)\r{\r Parent = NULL;\r ServerName.clear();\r    ServerDesc.clear();\r    VersionString.clear();\r UserCount = OperCount = 0;\r     rtt = LastPing = 0;\r    Hidden = false;\r        VersionString = ServerInstance->GetVersionString();\r}\r\r/** We use this constructor only to create the 'root' item, Utils->TreeRoot, which\r * represents our own server. Therefore, it has no route, no parent, and\r * no socket associated with it. Its version string is our own local version.\r */\rTreeServer::TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance, std::string Name, std::string Desc) : ServerInstance(Instance), ServerName(Name.c_str()), ServerDesc(Desc), Utils(Util)\r{\r Parent = NULL;\r VersionString.clear();\r UserCount = ServerInstance->UserCount();\r       OperCount = ServerInstance->OperCount();\r       VersionString = ServerInstance->GetVersionString();\r    Route = NULL;\r  Socket = NULL; /* Fix by brain */\r      rtt = LastPing = 0;\r    Hidden = false;\r        AddHashEntry();\r}\r\r/** When we create a new server, we call this constructor to initialize it.\r * This constructor initializes the server's Route and Parent, and sets up\r * its ping counters so that it will be pinged one minute from now.\r */\rTreeServer::TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance, std::string Name, std::string Desc, TreeServer* Above, TreeSocket* Sock, bool Hide)\r  : ServerInstance(Instance), Parent(Above), ServerName(Name.c_str()), ServerDesc(Desc), Socket(Sock), Utils(Util), Hidden(Hide)\r{\r       VersionString.clear();\r UserCount = OperCount = 0;\r     this->SetNextPingTime(time(NULL) + 60);\r        this->SetPingFlag();\r   rtt = LastPing = 0;\r    /* find the 'route' for this server (e.g. the one directly connected\r    * to the local server, which we can use to reach it)\r   *\r      * In the following example, consider we have just added a TreeServer\r   * class for server G on our network, of which we are server A.\r         * To route traffic to G (marked with a *) we must send the data to\r     * B (marked with a +) so this algorithm initializes the 'Route'\r        * value to point at whichever server traffic must be routed through\r    * to get here. If we were to try this algorithm with server B,\r         * the Route pointer would point at its own object ('this').\r    *\r      *            A\r         *           / \\r        *        + B   C\r       *         / \   \\r      *        D   E   F\r     *       /         \\r    *    * G           H\r   *\r      * We only run this algorithm when a server is created, as\r      * the routes remain constant while ever the server exists, and\r         * do not need to be re-calculated.\r     */\r\r   Route = Above;\r if (Route == Utils->TreeRoot)\r  {\r              Route = this;\r  }\r      else\r   {\r              while (this->Route->GetParent() != Utils->TreeRoot)\r            {\r                      this->Route = Route->GetParent();\r              }\r      }\r\r     /* Because recursive code is slow and takes a lot of resources,\r         * we store two representations of the server tree. The first\r   * is a recursive structure where each server references its\r    * children and its parent, which is used for netbursts and\r     * netsplits to dump the whole dataset to the other server,\r     * and the second is used for very fast lookups when routing\r    * messages and is instead a hash_map, where each item can\r      * be referenced by its server name. The AddHashEntry()\r         * call below automatically inserts each TreeServer class\r       * into the hash_map as it is created. There is a similar\r       * maintainance call in the destructor to tidy up deleted\r       * servers.\r     */\r\r   this->AddHashEntry();\r}\r\rint TreeServer::QuitUsers(const std::string &reason)\r{\r        const char* reason_s = reason.c_str();\r std::vector<userrec*> time_to_die;\r     for (user_hash::iterator n = ServerInstance->clientlist->begin(); n != ServerInstance->clientlist->end(); n++)\r {\r              if (!strcmp(n->second->server, this->ServerName.c_str()))\r              {\r                      time_to_die.push_back(n->second);\r              }\r      }\r      for (std::vector<userrec*>::iterator n = time_to_die.begin(); n != time_to_die.end(); n++)\r     {\r              userrec* a = (userrec*)*n;\r             if (!IS_LOCAL(a))\r              {\r                      if (ServerInstance->Config->HideSplits)\r                                userrec::QuitUser(ServerInstance, a, "*.net *.split", reason_s);\r                       else\r                           userrec::QuitUser(ServerInstance, a, reason_s);\r\r                       if (this->Utils->quiet_bursts)\r                         ServerInstance->GlobalCulls.MakeSilent(a);\r             }\r      }\r      return time_to_die.size();\r}\r\r/** This method is used to add the structure to the\r * hash_map for linear searches. It is only called\r * by the constructors.\r */\rvoid TreeServer::AddHashEntry()\r{\r     server_hash::iterator iter = Utils->serverlist.find(this->ServerName.c_str());\r if (iter == Utils->serverlist.end())\r           Utils->serverlist[this->ServerName.c_str()] = this;\r}\r\r/** This method removes the reference to this object\r * from the hash_map which is used for linear searches.\r * It is only called by the default destructor.\r */\rvoid TreeServer::DelHashEntry()\r{\r      server_hash::iterator iter = Utils->serverlist.find(this->ServerName.c_str());\r if (iter != Utils->serverlist.end())\r           Utils->serverlist.erase(iter);\r}\r\r/** These accessors etc should be pretty self-\r * explanitory.\r */\rTreeServer* TreeServer::GetRoute()\r{\r      return Route;\r}\r\rstd::string TreeServer::GetName()\r{\r   return ServerName.c_str();\r}\r\rstd::string TreeServer::GetDesc()\r{\r      return ServerDesc;\r}\r\rstd::string TreeServer::GetVersion()\r{\r   return VersionString;\r}\r\rvoid TreeServer::SetNextPingTime(time_t t)\r{\r  this->NextPing = t;\r    LastPingWasGood = false;\r}\r\rtime_t TreeServer::NextPingTime()\r{\r        return NextPing;\r}\r\rbool TreeServer::AnsweredLastPing()\r{\r      return LastPingWasGood;\r}\r\rvoid TreeServer::SetPingFlag()\r{\r    LastPingWasGood = true;\r}\r\rint TreeServer::GetUserCount()\r{\r    return UserCount;\r}\r\rvoid TreeServer::AddUserCount()\r{\r UserCount++;\r}\r\rvoid TreeServer::DelUserCount()\r{\r      UserCount--;\r}\r\rint TreeServer::GetOperCount()\r{\r       return OperCount;\r}\r\rTreeSocket* TreeServer::GetSocket()\r{\r     return Socket;\r}\r\rTreeServer* TreeServer::GetParent()\r{\r        return Parent;\r}\r\rvoid TreeServer::SetVersion(const std::string &Version)\r{\r    VersionString = Version;\r}\r\runsigned int TreeServer::ChildCount()\r{\r    return Children.size();\r}\r\rTreeServer* TreeServer::GetChild(unsigned int n)\r{\r  if (n < Children.size())\r       {\r              /* Make sure they  cant request\r                 * an out-of-range object. After\r                * all we know what these programmer\r            * types are like *grin*.\r               */\r            return Children[n];\r    }\r      else\r   {\r              return NULL;\r   }\r}\r\rvoid TreeServer::AddChild(TreeServer* Child)\r{\r    Children.push_back(Child);\r}\r\rbool TreeServer::DelChild(TreeServer* Child)\r{\r   for (std::vector<TreeServer*>::iterator a = Children.begin(); a < Children.end(); a++)\r {\r              if (*a == Child)\r               {\r                      Children.erase(a);\r                     return true;\r           }\r      }\r      return false;\r}\r\r/** Removes child nodes of this node, and of that node, etc etc.\r * This is used during netsplits to automatically tidy up the\r * server tree. It is slow, we don't use it for much else.\r */\rbool TreeServer::Tidy()\r{\r       bool stillchildren = true;\r     while (stillchildren)\r  {\r              stillchildren = false;\r         for (std::vector<TreeServer*>::iterator a = Children.begin(); a < Children.end(); a++)\r         {\r                      TreeServer* s = (TreeServer*)*a;\r                       s->Tidy();\r                     Children.erase(a);\r                     DELETE(s);\r                     stillchildren = true;\r                  break;\r         }\r      }\r      return true;\r}\r\rTreeServer::~TreeServer()\r{\r    /* We'd better tidy up after ourselves, eh? */\r this->DelHashEntry();\r}\r\r\r
\ No newline at end of file
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ *   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>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *
+ * 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/>.
+ */
+
+
+#include "inspircd.h"
+#include "xline.h"
+#include "main.h"
+#include "modules/server.h"
+
+#include "utils.h"
+#include "treeserver.h"
+
+/** We use this constructor only to create the 'root' item, Utils->TreeRoot, which
+ * represents our own server. Therefore, it has no route, no parent, and
+ * no socket associated with it. Its version string is our own local version.
+ */
+TreeServer::TreeServer()
+       : Server(ServerInstance->Config->ServerName, ServerInstance->Config->ServerDesc)
+       , Parent(NULL), Route(NULL)
+       , VersionString(ServerInstance->GetVersionString())
+       , fullversion(ServerInstance->GetVersionString(true))
+       , rawversion(INSPIRCD_VERSION)
+       , Socket(NULL), sid(ServerInstance->Config->GetSID()), behind_bursting(0), isdead(false)
+       , pingtimer(this)
+       , ServerUser(ServerInstance->FakeClient)
+       , age(ServerInstance->Time()), UserCount(ServerInstance->Users.LocalUserCount())
+       , OperCount(0), rtt(0), StartBurst(0), Hidden(false)
+{
+       AddHashEntry();
+}
+
+/** When we create a new server, we call this constructor to initialize it.
+ * This constructor initializes the server's Route and Parent, and sets up
+ * the ping timer for the server.
+ */
+TreeServer::TreeServer(const std::string& Name, const std::string& Desc, const std::string& id, TreeServer* Above, TreeSocket* Sock, bool Hide)
+       : Server(Name, Desc)
+       , Parent(Above), Socket(Sock), sid(id), behind_bursting(Parent->behind_bursting), isdead(false)
+       , pingtimer(this)
+       , ServerUser(new FakeUser(id, this))
+       , age(ServerInstance->Time()), UserCount(0), OperCount(0), rtt(0), StartBurst(0), Hidden(Hide)
+{
+       ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "New server %s behind_bursting %u", GetName().c_str(), behind_bursting);
+       CheckULine();
+
+       ServerInstance->Timers.AddTimer(&pingtimer);
+
+       /* find the 'route' for this server (e.g. the one directly connected
+        * to the local server, which we can use to reach it)
+        *
+        * In the following example, consider we have just added a TreeServer
+        * class for server G on our network, of which we are server A.
+        * To route traffic to G (marked with a *) we must send the data to
+        * B (marked with a +) so this algorithm initializes the 'Route'
+        * value to point at whichever server traffic must be routed through
+        * to get here. If we were to try this algorithm with server B,
+        * the Route pointer would point at its own object ('this').
+        *
+        *            A
+        *           / \
+        *        + B   C
+        *         / \   \
+        *        D   E   F
+        *       /         \
+        *    * G           H
+        *
+        * We only run this algorithm when a server is created, as
+        * the routes remain constant while ever the server exists, and
+        * do not need to be re-calculated.
+        */
+
+       Route = Above;
+       if (Route == Utils->TreeRoot)
+       {
+               Route = this;
+       }
+       else
+       {
+               while (this->Route->GetParent() != Utils->TreeRoot)
+               {
+                       this->Route = Route->GetParent();
+               }
+       }
+
+       /* Because recursive code is slow and takes a lot of resources,
+        * we store two representations of the server tree. The first
+        * is a recursive structure where each server references its
+        * children and its parent, which is used for netbursts and
+        * netsplits to dump the whole dataset to the other server,
+        * and the second is used for very fast lookups when routing
+        * messages and is instead a hash_map, where each item can
+        * be referenced by its server name. The AddHashEntry()
+        * call below automatically inserts each TreeServer class
+        * into the hash_map as it is created. There is a similar
+        * maintainance call in the destructor to tidy up deleted
+        * servers.
+        */
+
+       this->AddHashEntry();
+       Parent->Children.push_back(this);
+
+       FOREACH_MOD_CUSTOM(Utils->Creator->GetEventProvider(), ServerEventListener, OnServerLink, (this));
+}
+
+void TreeServer::BeginBurst(uint64_t startms)
+{
+       behind_bursting++;
+
+       uint64_t now = ServerInstance->Time() * 1000 + (ServerInstance->Time_ns() / 1000000);
+       // If the start time is in the future (clocks are not synced) then use current time
+       if ((!startms) || (startms > now))
+               startms = now;
+       this->StartBurst = startms;
+       ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Server %s started bursting at time %s behind_bursting %u", sid.c_str(), ConvToStr(startms).c_str(), behind_bursting);
+}
+
+void TreeServer::FinishBurstInternal()
+{
+       // Check is needed because 1202 protocol servers don't send the bursting state of a server, so servers
+       // introduced during a netburst may later send ENDBURST which would normally decrease this counter
+       if (behind_bursting > 0)
+               behind_bursting--;
+       ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "FinishBurstInternal() %s behind_bursting %u", GetName().c_str(), behind_bursting);
+
+       for (ChildServers::const_iterator i = Children.begin(); i != Children.end(); ++i)
+       {
+               TreeServer* child = *i;
+               child->FinishBurstInternal();
+       }
+}
+
+void TreeServer::FinishBurst()
+{
+       ServerInstance->XLines->ApplyLines();
+       uint64_t ts = ServerInstance->Time() * 1000 + (ServerInstance->Time_ns() / 1000000);
+       unsigned long bursttime = ts - this->StartBurst;
+       ServerInstance->SNO->WriteToSnoMask(Parent == Utils->TreeRoot ? 'l' : 'L', "Received end of netburst from \2%s\2 (burst time: %lu %s)",
+               GetName().c_str(), (bursttime > 10000 ? bursttime / 1000 : bursttime), (bursttime > 10000 ? "secs" : "msecs"));
+
+       StartBurst = 0;
+       FinishBurstInternal();
+}
+
+void TreeServer::SQuitChild(TreeServer* server, const std::string& reason)
+{
+       stdalgo::erase(Children, server);
+
+       if (IsRoot())
+       {
+               // Server split from us, generate a SQUIT message and broadcast it
+               ServerInstance->SNO->WriteGlobalSno('l', "Server \002" + server->GetName() + "\002 split: " + reason);
+               CmdBuilder("SQUIT").push(server->GetID()).push_last(reason).Broadcast();
+       }
+       else
+       {
+               ServerInstance->SNO->WriteToSnoMask('L', "Server \002" + server->GetName() + "\002 split from server \002" + GetName() + "\002 with reason: " + reason);
+       }
+
+       unsigned int num_lost_servers = 0;
+       server->SQuitInternal(num_lost_servers);
+
+       const std::string quitreason = GetName() + " " + server->GetName();
+       unsigned int num_lost_users = QuitUsers(quitreason);
+
+       ServerInstance->SNO->WriteToSnoMask(IsRoot() ? 'l' : 'L', "Netsplit complete, lost \002%u\002 user%s on \002%u\002 server%s.",
+               num_lost_users, num_lost_users != 1 ? "s" : "", num_lost_servers, num_lost_servers != 1 ? "s" : "");
+
+       // No-op if the socket is already closed (i.e. it called us)
+       if (server->IsLocal())
+               server->GetSocket()->Close();
+
+       // Add the server to the cull list, the servers behind it are handled by cull() and the destructor
+       ServerInstance->GlobalCulls.AddItem(server);
+}
+
+void TreeServer::SQuitInternal(unsigned int& num_lost_servers)
+{
+       ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Server %s lost in split", GetName().c_str());
+
+       for (ChildServers::const_iterator i = Children.begin(); i != Children.end(); ++i)
+       {
+               TreeServer* server = *i;
+               server->SQuitInternal(num_lost_servers);
+       }
+
+       // Mark server as dead
+       isdead = true;
+       num_lost_servers++;
+       RemoveHash();
+
+       if (!Utils->Creator->dying)
+               FOREACH_MOD_CUSTOM(Utils->Creator->GetEventProvider(), ServerEventListener, OnServerSplit, (this));
+}
+
+unsigned int TreeServer::QuitUsers(const std::string& reason)
+{
+       std::string publicreason = ServerInstance->Config->HideSplits ? "*.net *.split" : reason;
+
+       const user_hash& users = ServerInstance->Users->GetUsers();
+       unsigned int original_size = users.size();
+       for (user_hash::const_iterator i = users.begin(); i != users.end(); )
+       {
+               User* user = i->second;
+               // Increment the iterator now because QuitUser() removes the user from the container
+               ++i;
+               TreeServer* server = TreeServer::Get(user);
+               if (server->IsDead())
+                       ServerInstance->Users->QuitUser(user, publicreason, &reason);
+       }
+       return original_size - users.size();
+}
+
+void TreeServer::CheckULine()
+{
+       uline = silentuline = false;
+
+       ConfigTagList tags = ServerInstance->Config->ConfTags("uline");
+       for (ConfigIter i = tags.first; i != tags.second; ++i)
+       {
+               ConfigTag* tag = i->second;
+               std::string server = tag->getString("server");
+               if (!strcasecmp(server.c_str(), GetName().c_str()))
+               {
+                       if (this->IsRoot())
+                       {
+                               ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Servers should not uline themselves (at " + tag->getTagLocation() + ")");
+                               return;
+                       }
+
+                       uline = true;
+                       silentuline = tag->getBool("silent");
+                       break;
+               }
+       }
+}
+
+/** This method is used to add the server to the
+ * maps for linear searches. It is only called
+ * by the constructors.
+ */
+void TreeServer::AddHashEntry()
+{
+       Utils->serverlist[GetName()] = this;
+       Utils->sidlist[sid] = this;
+}
+
+CullResult TreeServer::cull()
+{
+       // Recursively cull all servers that are under us in the tree
+       for (ChildServers::const_iterator i = Children.begin(); i != Children.end(); ++i)
+       {
+               TreeServer* server = *i;
+               server->cull();
+       }
+
+       if (!IsRoot())
+               ServerUser->cull();
+       return classbase::cull();
+}
+
+TreeServer::~TreeServer()
+{
+       // Recursively delete all servers that are under us in the tree first
+       for (ChildServers::const_iterator i = Children.begin(); i != Children.end(); ++i)
+               delete *i;
+
+       // Delete server user unless it's us
+       if (!IsRoot())
+               delete ServerUser;
+}
+
+void TreeServer::RemoveHash()
+{
+       Utils->sidlist.erase(sid);
+       Utils->serverlist.erase(GetName());
+}