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         /** Counter counting how many servers are bursting in front of this server, including
  57          * this server. Set to parents' value on construction then it is increased if the
  58          * server itself starts bursting. Decreased when a server on the path to this server
  59          * finishes burst.
  60          */
  61         unsigned int behind_bursting;
  62
  63         /** This method is used to add this TreeServer to the
  64          * hash maps. It is only called by the constructors.
  65          */
  66         void AddHashEntry();
  67
  68  public:
  69         typedef std::vector<TreeServer*> ChildServers;
  70         FakeUser* const ServerUser;             /* User representing this server */
  71         const time_t age;
  72
  73         bool Warned;                            /* True if we've warned opers about high latency on this server */
  74
  75         unsigned int UserCount;                 /* How many users are on this server? [note: doesn't care about +i] */
  76         unsigned int OperCount;                 /* How many opers are on this server? */
  77
  78         /** We use this constructor only to create the 'root' item, Utils->TreeRoot, which
  79          * represents our own server. Therefore, it has no route, no parent, and
  80          * no socket associated with it. Its version string is our own local version.
  81          */
  82         TreeServer();
  83
  84         /** When we create a new server, we call this constructor to initialize it.
  85          * This constructor initializes the server's Route and Parent, and sets up
  86          * its ping counters so that it will be pinged one minute from now.
  87          */
  88         TreeServer(const std::string& Name, const std::string& Desc, const std::string& id, TreeServer* Above, TreeSocket* Sock, bool Hide);
  89
  90         int QuitUsers(const std::string &reason);
  91
  92         /** Get route.
  93          * The 'route' is defined as the locally-
  94          * connected server which can be used to reach this server.
  95          */
  96         TreeServer* GetRoute();
  97
  98         /** Returns true if this server is the tree root (i.e.: us)
  99          */
 100         bool IsRoot() const { return (this->Parent == NULL); }
 101
 102         /** Returns true if this server is locally connected
 103          */
 104         bool IsLocal() const { return (this->Route == this); }
 105
 106         /** Get server version string
 107          */
 108         const std::string& GetVersion();
 109
 110         /** Get the full version string of this server
 111          * @return The full version string of this server, including patch version and other info
 112          */
 113         const std::string& GetFullVersion() const { return fullversion; }
 114
 115         /** Set time we are next due to ping this server
 116          */
 117         void SetNextPingTime(time_t t);
 118
 119         /** Get the time we are next due to ping this server
 120          */
 121         time_t NextPingTime();
 122
 123         /** Last ping time in milliseconds, used to calculate round trip time
 124          */
 125         unsigned long LastPingMsec;
 126
 127         /** Round trip time of last ping
 128          */
 129         unsigned long rtt;
 130
 131         /** When we recieved BURST from this server, used to calculate total burst time at ENDBURST.
 132          */
 133         unsigned long StartBurst;
 134
 135         /** True if this server is hidden
 136          */
 137         bool Hidden;
 138
 139         /** True if the server answered their last ping
 140          */
 141         bool AnsweredLastPing();
 142
 143         /** Set the server as responding to its last ping
 144          */
 145         void SetPingFlag();
 146
 147         /** Get the TreeSocket pointer for local servers.
 148          * For remote servers, this returns NULL.
 149          */
 150         TreeSocket* GetSocket();
 151
 152         /** Get the parent server.
 153          * For the root node, this returns NULL.
 154          */
 155         TreeServer* GetParent();
 156
 157         /** Set the server version string
 158          */
 159         void SetVersion(const std::string &Version);
 160
 161         /** Set the full version string
 162          * @param verstr The version string to set
 163          */
 164         void SetFullVersion(const std::string& verstr) { fullversion = verstr; }
 165
 166         /** Sets the description of this server. Called when the description of a remote server changes
 167          * and we are notified about it.
 168          * @param descstr The description to set
 169          */
 170         void SetDesc(const std::string& descstr) { description = descstr; }
 171
 172         /** Return all child servers
 173          */
 174         const ChildServers& GetChildren() const { return Children; }
 175
 176         /** Add a child server
 177          */
 178         void AddChild(TreeServer* Child);
 179
 180         /** Delete a child server, return false if it didn't exist.
 181          */
 182         bool DelChild(TreeServer* Child);
 183
 184         /** Removes child nodes of this node, and of that node, etc etc.
 185          * This is used during netsplits to automatically tidy up the
 186          * server tree. It is slow, we don't use it for much else.
 187          */
 188         void Tidy();
 189
 190         /** Get server ID
 191          */
 192         const std::string& GetID();
 193
 194         /** Marks a server as having finished bursting and performs appropriate actions.
 195          */
 196         void FinishBurst();
 197         /** Recursive call for child servers */
 198         void FinishBurstInternal();
 199
 200         /** (Re)check the uline state of this server
 201          */
 202         void CheckULine();
 203
 204         /** Get the bursting state of this server
 205          * @return True if this server is bursting, false if it isn't
 206          */
 207         bool IsBursting() const { return (StartBurst != 0); }
 208
 209         /** Check whether this server is behind a bursting server or is itself bursting.
 210          * This can tell whether a user is on a part of the network that is still bursting.
 211          * @return True if this server is bursting or is behind a server that is bursting, false if it isn't
 212          */
 213         bool IsBehindBursting() const { return (behind_bursting != 0); }
 214
 215         /** Set the bursting state of the server
 216          * @param startms Time the server started bursting, if 0 or omitted, use current time
 217          */
 218         void BeginBurst(unsigned long startms = 0);
 219
 220         CullResult cull();
 221
 222         /** Destructor
 223          * Removes the reference to this object from the
 224          * hash maps.
 225          */
 226         ~TreeServer();
 227
 228         /** Returns the TreeServer the given user is connected to
 229          * @param user The user whose server to return
 230          * @return The TreeServer this user is connected to.
 231          */
 232         static TreeServer* Get(User* user)
 233         {
 234                 return static_cast<TreeServer*>(user->server);
 235         }
 236 };