2 * InspIRCd -- Internet Relay Chat Daemon
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>
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.
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
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/>.
24 #include "treesocket.h"
25 #include "pingtimer.h"
27 /** Each server in the tree is represented by one class of
28 * type TreeServer. A locally connected TreeServer can
29 * have a class of type TreeSocket associated with it, for
30 * remote servers, the TreeSocket entry will be NULL.
31 * Each server also maintains a pointer to its parent
32 * (NULL if this server is ours, at the top of the tree)
33 * and a pointer to its "Route" (see the comments in the
34 * constructors below), and also a dynamic list of pointers
35 * to its children which can be iterated recursively
36 * if required. Creating or deleting objects of type
37 i* TreeServer automatically maintains the hash_map of
38 * TreeServer items, deleting and inserting them as they
39 * are created and destroyed.
41 class TreeServer : public Server
43 TreeServer* Parent; /* Parent entry */
44 TreeServer* Route; /* Route entry */
45 std::vector<TreeServer*> Children; /* List of child objects */
46 std::string VersionString; /* Version string or empty string */
48 /** Full version string including patch version and other info
50 std::string fullversion;
52 TreeSocket* Socket; /* Socket used to communicate with this server */
53 std::string sid; /* Server ID */
55 /** Counter counting how many servers are bursting in front of this server, including
56 * this server. Set to parents' value on construction then it is increased if the
57 * server itself starts bursting. Decreased when a server on the path to this server
60 unsigned int behind_bursting;
62 /** True if this server has been lost in a split and is awaiting destruction
66 /** Timer handling PINGing the server and killing it on timeout
70 /** This method is used to add this TreeServer to the
71 * hash maps. It is only called by the constructors.
75 /** Used by SQuit logic to recursively remove servers
77 void SQuitInternal(unsigned int& num_lost_servers);
79 /** Remove the reference to this server from the hash maps
84 typedef std::vector<TreeServer*> ChildServers;
85 FakeUser* const ServerUser; /* User representing this server */
88 unsigned int UserCount; /* How many users are on this server? [note: doesn't care about +i] */
89 unsigned int OperCount; /* How many opers are on this server? */
91 /** We use this constructor only to create the 'root' item, Utils->TreeRoot, which
92 * represents our own server. Therefore, it has no route, no parent, and
93 * no socket associated with it. Its version string is our own local version.
97 /** When we create a new server, we call this constructor to initialize it.
98 * This constructor initializes the server's Route and Parent, and sets up
99 * its ping counters so that it will be pinged one minute from now.
101 TreeServer(const std::string& Name, const std::string& Desc, const std::string& id, TreeServer* Above, TreeSocket* Sock, bool Hide);
103 /** SQuit a server connected to this server, removing the given server and all servers behind it
104 * @param server Server to squit, must be directly below this server
105 * @param reason Reason for quitting the server, sent to opers and other servers
107 void SQuitChild(TreeServer* server, const std::string& reason);
109 /** SQuit this server, removing this server and all servers behind it
110 * @param reason Reason for quitting the server, sent to opers and other servers
112 void SQuit(const std::string& reason)
114 GetParent()->SQuitChild(this, reason);
117 static unsigned int QuitUsers(const std::string& reason);
120 * The 'route' is defined as the locally-
121 * connected server which can be used to reach this server.
123 TreeServer* GetRoute() const { return Route; }
125 /** Returns true if this server is the tree root (i.e.: us)
127 bool IsRoot() const { return (this->Parent == NULL); }
129 /** Returns true if this server is locally connected
131 bool IsLocal() const { return (this->Route == this); }
133 /** Returns true if the server is awaiting destruction
134 * @return True if the server is waiting to be culled and deleted, false otherwise
136 bool IsDead() const { return isdead; }
138 /** Get server version string
140 const std::string& GetVersion() const { return VersionString; }
142 /** Get the full version string of this server
143 * @return The full version string of this server, including patch version and other info
145 const std::string& GetFullVersion() const { return fullversion; }
147 /** Round trip time of last ping
151 /** When we recieved BURST from this server, used to calculate total burst time at ENDBURST.
155 /** True if this server is hidden
159 /** Get the TreeSocket pointer for local servers.
160 * For remote servers, this returns NULL.
162 TreeSocket* GetSocket() const { return Socket; }
164 /** Get the parent server.
165 * For the root node, this returns NULL.
167 TreeServer* GetParent() const { return Parent; }
169 /** Set the server version string
171 void SetVersion(const std::string& verstr) { VersionString = verstr; }
173 /** Set the full version string
174 * @param verstr The version string to set
176 void SetFullVersion(const std::string& verstr) { fullversion = verstr; }
178 /** Sets the description of this server. Called when the description of a remote server changes
179 * and we are notified about it.
180 * @param descstr The description to set
182 void SetDesc(const std::string& descstr) { description = descstr; }
184 /** Return all child servers
186 const ChildServers& GetChildren() const { return Children; }
190 const std::string& GetID() const { return sid; }
192 /** Marks a server as having finished bursting and performs appropriate actions.
195 /** Recursive call for child servers */
196 void FinishBurstInternal();
198 /** (Re)check the uline state of this server
202 /** Get the bursting state of this server
203 * @return True if this server is bursting, false if it isn't
205 bool IsBursting() const { return (StartBurst != 0); }
207 /** Check whether this server is behind a bursting server or is itself bursting.
208 * This can tell whether a user is on a part of the network that is still bursting.
209 * @return True if this server is bursting or is behind a server that is bursting, false if it isn't
211 bool IsBehindBursting() const { return (behind_bursting != 0); }
213 /** Set the bursting state of the server
214 * @param startms Time the server started bursting, if 0 or omitted, use current time
216 void BeginBurst(uint64_t startms = 0);
218 /** Register a PONG from the server
220 void OnPong() { pingtimer.OnPong(); }
222 CullResult cull() CXX11_OVERRIDE;
224 /** Destructor, deletes ServerUser unless IsRoot()
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.
232 static TreeServer* Get(User* user)
234 return static_cast<TreeServer*>(user->server);