src/modules/m_spanningtree/treeserver.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
   5  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   6  *   Copyright (C) 2007 Craig Edwards <craigedwards@brainbox.cc>
   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 #pragma once
  23
  24 #include "treesocket.h"
  25
  26 /** Each server in the tree is represented by one class of
  27  * type TreeServer. A locally connected TreeServer can
  28  * have a class of type TreeSocket associated with it, for
  29  * remote servers, the TreeSocket entry will be NULL.
  30  * Each server also maintains a pointer to its parent
  31  * (NULL if this server is ours, at the top of the tree)
  32  * and a pointer to its "Route" (see the comments in the
  33  * constructors below), and also a dynamic list of pointers
  34  * to its children which can be iterated recursively
  35  * if required. Creating or deleting objects of type
  36  i* TreeServer automatically maintains the hash_map of
  37  * TreeServer items, deleting and inserting them as they
  38  * are created and destroyed.
  39  */
  40 class TreeServer : public Server
  41 {
  42         TreeServer* Parent;                     /* Parent entry */
  43         TreeServer* Route;                      /* Route entry */
  44         std::vector<TreeServer*> Children;      /* List of child objects */
  45         std::string VersionString;              /* Version string or empty string */
  46
  47         /** Full version string including patch version and other info
  48          */
  49         std::string fullversion;
  50
  51         TreeSocket* Socket;                     /* Socket used to communicate with this server */
  52         time_t NextPing;                        /* After this time, the server should be PINGed*/
  53         bool LastPingWasGood;                   /* True if the server responded to the last PING with a PONG */
  54         std::string sid;                        /* Server ID */
  55
  56         /** This method is used to add this TreeServer to the
  57          * hash maps. It is only called by the constructors.
  58          */
  59         void AddHashEntry();
  60
  61  public:
  62         typedef std::vector<TreeServer*> ChildServers;
  63         FakeUser* const ServerUser;             /* User representing this server */
  64         const time_t age;
  65
  66         bool Warned;                            /* True if we've warned opers about high latency on this server */
  67         bool bursting;                          /* whether or not this server is bursting */
  68
  69         unsigned int UserCount;                 /* How many users are on this server? [note: doesn't care about +i] */
  70         unsigned int OperCount;                 /* How many opers are on this server? */
  71
  72         /** We use this constructor only to create the 'root' item, Utils->TreeRoot, which
  73          * represents our own server. Therefore, it has no route, no parent, and
  74          * no socket associated with it. Its version string is our own local version.
  75          */
  76         TreeServer();
  77
  78         /** When we create a new server, we call this constructor to initialize it.
  79          * This constructor initializes the server's Route and Parent, and sets up
  80          * its ping counters so that it will be pinged one minute from now.
  81          */
  82         TreeServer(const std::string& Name, const std::string& Desc, const std::string& id, TreeServer* Above, TreeSocket* Sock, bool Hide);
  83
  84         int QuitUsers(const std::string &reason);
  85
  86         /** Get route.
  87          * The 'route' is defined as the locally-
  88          * connected server which can be used to reach this server.
  89          */
  90         TreeServer* GetRoute();
  91
  92         /** Returns true if this server is the tree root (i.e.: us)
  93          */
  94         bool IsRoot() const { return (this->Parent == NULL); }
  95
  96         /** Returns true if this server is locally connected
  97          */
  98         bool IsLocal() const { return (this->Route == this); }
  99
 100         /** Get server version string
 101          */
 102         const std::string& GetVersion();
 103
 104         /** Get the full version string of this server
 105          * @return The full version string of this server, including patch version and other info
 106          */
 107         const std::string& GetFullVersion() const { return fullversion; }
 108
 109         /** Set time we are next due to ping this server
 110          */
 111         void SetNextPingTime(time_t t);
 112
 113         /** Get the time we are next due to ping this server
 114          */
 115         time_t NextPingTime();
 116
 117         /** Last ping time in milliseconds, used to calculate round trip time
 118          */
 119         unsigned long LastPingMsec;
 120
 121         /** Round trip time of last ping
 122          */
 123         unsigned long rtt;
 124
 125         /** When we recieved BURST from this server, used to calculate total burst time at ENDBURST.
 126          */
 127         unsigned long StartBurst;
 128
 129         /** True if this server is hidden
 130          */
 131         bool Hidden;
 132
 133         /** True if the server answered their last ping
 134          */
 135         bool AnsweredLastPing();
 136
 137         /** Set the server as responding to its last ping
 138          */
 139         void SetPingFlag();
 140
 141         /** Get the TreeSocket pointer for local servers.
 142          * For remote servers, this returns NULL.
 143          */
 144         TreeSocket* GetSocket();
 145
 146         /** Get the parent server.
 147          * For the root node, this returns NULL.
 148          */
 149         TreeServer* GetParent();
 150
 151         /** Set the server version string
 152          */
 153         void SetVersion(const std::string &Version);
 154
 155         /** Set the full version string
 156          * @param verstr The version string to set
 157          */
 158         void SetFullVersion(const std::string& verstr) { fullversion = verstr; }
 159
 160         /** Sets the description of this server. Called when the description of a remote server changes
 161          * and we are notified about it.
 162          * @param descstr The description to set
 163          */
 164         void SetDesc(const std::string& descstr) { description = descstr; }
 165
 166         /** Return all child servers
 167          */
 168         const ChildServers& GetChildren() const { return Children; }
 169
 170         /** Add a child server
 171          */
 172         void AddChild(TreeServer* Child);
 173
 174         /** Delete a child server, return false if it didn't exist.
 175          */
 176         bool DelChild(TreeServer* Child);
 177
 178         /** Removes child nodes of this node, and of that node, etc etc.
 179          * This is used during netsplits to automatically tidy up the
 180          * server tree. It is slow, we don't use it for much else.
 181          */
 182         void Tidy();
 183
 184         /** Get server ID
 185          */
 186         const std::string& GetID();
 187
 188         /** Marks a server as having finished bursting and performs appropriate actions.
 189          */
 190         void FinishBurst();
 191         /** Recursive call for child servers */
 192         void FinishBurstInternal();
 193
 194         /** (Re)check the uline state of this server
 195          */
 196         void CheckULine();
 197
 198         CullResult cull();
 199
 200         /** Destructor
 201          * Removes the reference to this object from the
 202          * hash maps.
 203          */
 204         ~TreeServer();
 205
 206         /** Returns the TreeServer the given user is connected to
 207          * @param user The user whose server to return
 208          * @return The TreeServer this user is connected to.
 209          */
 210         static TreeServer* Get(User* user)
 211         {
 212                 return static_cast<TreeServer*>(user->server);
 213         }
 214 };