src/modules/m_spanningtree/treeserver.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2007 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 #include "configreader.h"
  15 #include "users.h"
  16 #include "channels.h"
  17 #include "modules.h"
  18 #include "commands/cmd_whois.h"
  19 #include "commands/cmd_stats.h"
  20 #include "socket.h"
  21 #include "inspircd.h"
  22 #include "wildcard.h"
  23 #include "xline.h"
  24 #include "transport.h"
  25
  26 #include "m_spanningtree/utils.h"
  27 #include "m_spanningtree/treeserver.h"
  28
  29 /* $ModDep: m_spanningtree/utils.h m_spanningtree/treeserver.h */
  30
  31 TreeServer::TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance) : ServerInstance(Instance), Utils(Util)
  32 {
  33         Parent = NULL;
  34         ServerName = "";
  35         ServerDesc = "";
  36         VersionString = "";
  37         UserCount = OperCount = 0;
  38         rtt = LastPing = 0;
  39         Hidden = false;
  40         VersionString = ServerInstance->GetVersionString();
  41 }
  42
  43 /** We use this constructor only to create the 'root' item, Utils->TreeRoot, which
  44  * represents our own server. Therefore, it has no route, no parent, and
  45  * no socket associated with it. Its version string is our own local version.
  46  */
  47 TreeServer::TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance, std::string Name, std::string Desc) : ServerInstance(Instance), ServerName(Name.c_str()), ServerDesc(Desc), Utils(Util)
  48 {
  49         Parent = NULL;
  50         VersionString = "";
  51         UserCount = ServerInstance->UserCount();
  52         OperCount = ServerInstance->OperCount();
  53         VersionString = ServerInstance->GetVersionString();
  54         Route = NULL;
  55         Socket = NULL; /* Fix by brain */
  56         rtt = LastPing = 0;
  57         Hidden = false;
  58         AddHashEntry();
  59 }
  60
  61 /** When we create a new server, we call this constructor to initialize it.
  62  * This constructor initializes the server's Route and Parent, and sets up
  63  * its ping counters so that it will be pinged one minute from now.
  64  */
  65 TreeServer::TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance, std::string Name, std::string Desc, TreeServer* Above, TreeSocket* Sock, bool Hide)
  66         : ServerInstance(Instance), Parent(Above), ServerName(Name.c_str()), ServerDesc(Desc), Socket(Sock), Utils(Util), Hidden(Hide)
  67 {
  68         VersionString = "";
  69         UserCount = OperCount = 0;
  70         this->SetNextPingTime(time(NULL) + 60);
  71         this->SetPingFlag();
  72         rtt = LastPing = 0;
  73         /* find the 'route' for this server (e.g. the one directly connected
  74          * to the local server, which we can use to reach it)
  75          *
  76          * In the following example, consider we have just added a TreeServer
  77          * class for server G on our network, of which we are server A.
  78          * To route traffic to G (marked with a *) we must send the data to
  79          * B (marked with a +) so this algorithm initializes the 'Route'
  80          * value to point at whichever server traffic must be routed through
  81          * to get here. If we were to try this algorithm with server B,
  82          * the Route pointer would point at its own object ('this').
  83          *
  84          *            A
  85          *           / \
  86          *        + B   C
  87          *         / \   \
  88          *        D   E   F
  89          *       /         \
  90          *    * G           H
  91          *
  92          * We only run this algorithm when a server is created, as
  93          * the routes remain constant while ever the server exists, and
  94          * do not need to be re-calculated.
  95          */
  96
  97         Route = Above;
  98         if (Route == Utils->TreeRoot)
  99         {
 100                 Route = this;
 101         }
 102         else
 103         {
 104                 while (this->Route->GetParent() != Utils->TreeRoot)
 105                 {
 106                         this->Route = Route->GetParent();
 107                 }
 108         }
 109
 110         /* Because recursive code is slow and takes a lot of resources,
 111          * we store two representations of the server tree. The first
 112          * is a recursive structure where each server references its
 113          * children and its parent, which is used for netbursts and
 114          * netsplits to dump the whole dataset to the other server,
 115          * and the second is used for very fast lookups when routing
 116          * messages and is instead a hash_map, where each item can
 117          * be referenced by its server name. The AddHashEntry()
 118          * call below automatically inserts each TreeServer class
 119          * into the hash_map as it is created. There is a similar
 120          * maintainance call in the destructor to tidy up deleted
 121          * servers.
 122          */
 123
 124         this->AddHashEntry();
 125 }
 126
 127 int TreeServer::QuitUsers(const std::string &reason)
 128 {
 129         const char* reason_s = reason.c_str();
 130         std::vector<userrec*> time_to_die;
 131         for (user_hash::iterator n = ServerInstance->clientlist->begin(); n != ServerInstance->clientlist->end(); n++)
 132         {
 133                 if (!strcmp(n->second->server, this->ServerName.c_str()))
 134                 {
 135                         time_to_die.push_back(n->second);
 136                 }
 137         }
 138         for (std::vector<userrec*>::iterator n = time_to_die.begin(); n != time_to_die.end(); n++)
 139         {
 140                 userrec* a = (userrec*)*n;
 141                 if (!IS_LOCAL(a))
 142                 {
 143                         if (ServerInstance->Config->HideSplits)
 144                                 userrec::QuitUser(ServerInstance, a, "*.net *.split", reason_s);
 145                         else
 146                                 userrec::QuitUser(ServerInstance, a, reason_s);
 147                 }
 148         }
 149         return time_to_die.size();
 150 }
 151
 152 /** This method is used to add the structure to the
 153  * hash_map for linear searches. It is only called
 154  * by the constructors.
 155  */
 156 void TreeServer::AddHashEntry()
 157 {
 158         server_hash::iterator iter = Utils->serverlist.find(this->ServerName.c_str());
 159         if (iter == Utils->serverlist.end())
 160                 Utils->serverlist[this->ServerName.c_str()] = this;
 161 }
 162
 163 /** This method removes the reference to this object
 164  * from the hash_map which is used for linear searches.
 165  * It is only called by the default destructor.
 166  */
 167 void TreeServer::DelHashEntry()
 168 {
 169         server_hash::iterator iter = Utils->serverlist.find(this->ServerName.c_str());
 170         if (iter != Utils->serverlist.end())
 171                 Utils->serverlist.erase(iter);
 172 }
 173
 174 /** These accessors etc should be pretty self-
 175  * explanitory.
 176  */
 177 TreeServer* TreeServer::GetRoute()
 178 {
 179         return Route;
 180 }
 181
 182 std::string TreeServer::GetName()
 183 {
 184         return ServerName.c_str();
 185 }
 186
 187 std::string TreeServer::GetDesc()
 188 {
 189         return ServerDesc;
 190 }
 191
 192 std::string TreeServer::GetVersion()
 193 {
 194         return VersionString;
 195 }
 196
 197 void TreeServer::SetNextPingTime(time_t t)
 198 {
 199         this->NextPing = t;
 200         LastPingWasGood = false;
 201 }
 202
 203 time_t TreeServer::NextPingTime()
 204 {
 205         return NextPing;
 206 }
 207
 208 bool TreeServer::AnsweredLastPing()
 209 {
 210         return LastPingWasGood;
 211 }
 212
 213 void TreeServer::SetPingFlag()
 214 {
 215         LastPingWasGood = true;
 216 }
 217
 218 int TreeServer::GetUserCount()
 219 {
 220         return UserCount;
 221 }
 222
 223 void TreeServer::AddUserCount()
 224 {
 225         UserCount++;
 226 }
 227
 228 void TreeServer::DelUserCount()
 229 {
 230         UserCount--;
 231 }
 232
 233 int TreeServer::GetOperCount()
 234 {
 235         return OperCount;
 236 }
 237
 238 TreeSocket* TreeServer::GetSocket()
 239 {
 240         return Socket;
 241 }
 242
 243 TreeServer* TreeServer::GetParent()
 244 {
 245         return Parent;
 246 }
 247
 248 void TreeServer::SetVersion(const std::string &Version)
 249 {
 250         VersionString = Version;
 251 }
 252
 253 unsigned int TreeServer::ChildCount()
 254 {
 255         return Children.size();
 256 }
 257
 258 TreeServer* TreeServer::GetChild(unsigned int n)
 259 {
 260         if (n < Children.size())
 261         {
 262                 /* Make sure they  cant request
 263                  * an out-of-range object. After
 264                  * all we know what these programmer
 265                  * types are like *grin*.
 266                  */
 267                 return Children[n];
 268         }
 269         else
 270         {
 271                 return NULL;
 272         }
 273 }
 274
 275 void TreeServer::AddChild(TreeServer* Child)
 276 {
 277         Children.push_back(Child);
 278 }
 279
 280 bool TreeServer::DelChild(TreeServer* Child)
 281 {
 282         for (std::vector<TreeServer*>::iterator a = Children.begin(); a < Children.end(); a++)
 283         {
 284                 if (*a == Child)
 285                 {
 286                         Children.erase(a);
 287                         return true;
 288                 }
 289         }
 290         return false;
 291 }
 292
 293 /** Removes child nodes of this node, and of that node, etc etc.
 294  * This is used during netsplits to automatically tidy up the
 295  * server tree. It is slow, we don't use it for much else.
 296  */
 297 bool TreeServer::Tidy()
 298 {
 299         bool stillchildren = true;
 300         while (stillchildren)
 301         {
 302                 stillchildren = false;
 303                 for (std::vector<TreeServer*>::iterator a = Children.begin(); a < Children.end(); a++)
 304                 {
 305                         TreeServer* s = (TreeServer*)*a;
 306                         s->Tidy();
 307                         Children.erase(a);
 308                         DELETE(s);
 309                         stillchildren = true;
 310                         break;
 311                 }
 312         }
 313         return true;
 314 }
 315
 316 TreeServer::~TreeServer()
 317 {
 318         /* We'd better tidy up after ourselves, eh? */
 319         this->DelHashEntry();
 320 }
 321
 322