1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
15 #include "commands/cmd_whois.h"
16 #include "commands/cmd_stats.h"
20 #include "transport.h"
22 #include "m_spanningtree/utils.h"
23 #include "m_spanningtree/treeserver.h"
25 /* $ModDep: m_spanningtree/utils.h m_spanningtree/treeserver.h */
27 TreeServer::TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance, const std::string &id) : ServerInstance(Instance), Utils(Util)
32 VersionString.clear();
33 UserCount = OperCount = 0;
35 Hidden = DupError = false;
36 VersionString = ServerInstance->GetVersionString();
40 /** We use this constructor only to create the 'root' item, Utils->TreeRoot, which
41 * represents our own server. Therefore, it has no route, no parent, and
42 * no socket associated with it. Its version string is our own local version.
44 TreeServer::TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance, std::string Name, std::string Desc, const std::string &id)
45 : ServerInstance(Instance), ServerName(Name.c_str()), ServerDesc(Desc), Utils(Util)
48 VersionString.clear();
49 UserCount = ServerInstance->UserCount();
50 OperCount = ServerInstance->OperCount();
51 VersionString = ServerInstance->GetVersionString();
53 Socket = NULL; /* Fix by brain */
55 Hidden = DupError = false;
60 /** When we create a new server, we call this constructor to initialize it.
61 * This constructor initializes the server's Route and Parent, and sets up
62 * its ping counters so that it will be pinged one minute from now.
64 TreeServer::TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance, std::string Name, std::string Desc, const std::string &id, TreeServer* Above, TreeSocket* Sock, bool Hide)
65 : ServerInstance(Instance), Parent(Above), ServerName(Name.c_str()), ServerDesc(Desc), Socket(Sock), Utils(Util), Hidden(Hide)
67 VersionString.clear();
68 UserCount = OperCount = 0;
69 this->SetNextPingTime(time(NULL) + Utils->PingFreq);
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)
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').
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.
98 if (Route == Utils->TreeRoot)
104 while (this->Route->GetParent() != Utils->TreeRoot)
106 this->Route = Route->GetParent();
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
124 this->AddHashEntry();
129 std::string& TreeServer::GetID()
134 void TreeServer::SetID(const std::string &id)
137 server_hash::iterator iter = Utils->sidlist.find(sid);
138 if (iter == Utils->sidlist.end())
139 Utils->sidlist[sid] = this;
144 bool TreeServer::DuplicateID()
149 int TreeServer::QuitUsers(const std::string &reason)
151 const char* reason_s = reason.c_str();
152 std::vector<userrec*> time_to_die;
153 for (user_hash::iterator n = ServerInstance->clientlist->begin(); n != ServerInstance->clientlist->end(); n++)
155 if (!strcmp(n->second->server, this->ServerName.c_str()))
157 time_to_die.push_back(n->second);
160 for (std::vector<userrec*>::iterator n = time_to_die.begin(); n != time_to_die.end(); n++)
162 userrec* a = (userrec*)*n;
165 if (ServerInstance->Config->HideSplits)
166 userrec::QuitUser(ServerInstance, a, "*.net *.split", reason_s);
168 userrec::QuitUser(ServerInstance, a, reason_s);
170 if (this->Utils->quiet_bursts)
171 ServerInstance->GlobalCulls.MakeSilent(a);
174 return time_to_die.size();
177 /** This method is used to add the structure to the
178 * hash_map for linear searches. It is only called
179 * by the constructors.
181 void TreeServer::AddHashEntry()
183 server_hash::iterator iter = Utils->serverlist.find(this->ServerName.c_str());
184 if (iter == Utils->serverlist.end())
185 Utils->serverlist[this->ServerName.c_str()] = this;
188 /** This method removes the reference to this object
189 * from the hash_map which is used for linear searches.
190 * It is only called by the default destructor.
192 void TreeServer::DelHashEntry()
194 server_hash::iterator iter = Utils->serverlist.find(this->ServerName.c_str());
195 if (iter != Utils->serverlist.end())
196 Utils->serverlist.erase(iter);
199 /** These accessors etc should be pretty self-
202 TreeServer* TreeServer::GetRoute()
207 std::string TreeServer::GetName()
209 return ServerName.c_str();
212 std::string TreeServer::GetDesc()
217 std::string TreeServer::GetVersion()
219 return VersionString;
222 void TreeServer::SetNextPingTime(time_t t)
225 LastPingWasGood = false;
228 time_t TreeServer::NextPingTime()
233 bool TreeServer::AnsweredLastPing()
235 return LastPingWasGood;
238 void TreeServer::SetPingFlag()
240 LastPingWasGood = true;
243 int TreeServer::GetUserCount()
248 void TreeServer::AddUserCount()
253 void TreeServer::DelUserCount()
258 int TreeServer::GetOperCount()
263 TreeSocket* TreeServer::GetSocket()
268 TreeServer* TreeServer::GetParent()
273 void TreeServer::SetVersion(const std::string &Version)
275 VersionString = Version;
278 unsigned int TreeServer::ChildCount()
280 return Children.size();
283 TreeServer* TreeServer::GetChild(unsigned int n)
285 if (n < Children.size())
287 /* Make sure they cant request
288 * an out-of-range object. After
289 * all we know what these programmer
290 * types are like *grin*.
300 void TreeServer::AddChild(TreeServer* Child)
302 Children.push_back(Child);
305 bool TreeServer::DelChild(TreeServer* Child)
307 for (std::vector<TreeServer*>::iterator a = Children.begin(); a < Children.end(); a++)
318 /** Removes child nodes of this node, and of that node, etc etc.
319 * This is used during netsplits to automatically tidy up the
320 * server tree. It is slow, we don't use it for much else.
322 bool TreeServer::Tidy()
324 bool stillchildren = true;
325 while (stillchildren)
327 stillchildren = false;
328 for (std::vector<TreeServer*>::iterator a = Children.begin(); a < Children.end(); a++)
330 TreeServer* s = (TreeServer*)*a;
334 stillchildren = true;
341 TreeServer::~TreeServer()
343 /* We'd better tidy up after ourselves, eh? */
344 this->DelHashEntry();
346 server_hash::iterator iter = Utils->sidlist.find(GetID());
347 if (iter != Utils->sidlist.end())
348 Utils->sidlist.erase(iter);