2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2007-2008 Craig Edwards <craigedwards@brainbox.cc>
6 * Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
7 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
9 * This file is part of InspIRCd. InspIRCd is free software: you can
10 * redistribute it and/or modify it under the terms of the GNU General Public
11 * License as published by the Free Software Foundation, version 2.
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
26 #include "modules/spanningtree.h"
29 #include "treeserver.h"
31 /** We use this constructor only to create the 'root' item, Utils->TreeRoot, which
32 * represents our own server. Therefore, it has no route, no parent, and
33 * no socket associated with it. Its version string is our own local version.
35 TreeServer::TreeServer()
36 : Server(ServerInstance->Config->ServerName, ServerInstance->Config->ServerDesc)
37 , Parent(NULL), Route(NULL)
38 , VersionString(ServerInstance->GetVersionString())
39 , fullversion(ServerInstance->GetVersionString(true))
40 , Socket(NULL), sid(ServerInstance->Config->GetSID()), ServerUser(ServerInstance->FakeClient)
41 , age(ServerInstance->Time()), Warned(false), bursting(false), UserCount(ServerInstance->Users.GetLocalUsers().size())
42 , OperCount(0), rtt(0), StartBurst(0), Hidden(false)
47 /** When we create a new server, we call this constructor to initialize it.
48 * This constructor initializes the server's Route and Parent, and sets up
49 * its ping counters so that it will be pinged one minute from now.
51 TreeServer::TreeServer(const std::string& Name, const std::string& Desc, const std::string& id, TreeServer* Above, TreeSocket* Sock, bool Hide)
53 , Parent(Above), Socket(Sock), sid(id), ServerUser(new FakeUser(id, this))
54 , age(ServerInstance->Time()), Warned(false), bursting(true), UserCount(0), OperCount(0), rtt(0), Hidden(Hide)
57 SetNextPingTime(ServerInstance->Time() + Utils->PingFreq);
60 long ts = ServerInstance->Time() * 1000 + (ServerInstance->Time_ns() / 1000000);
61 this->StartBurst = ts;
62 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Server %s started bursting at time %lu", sid.c_str(), ts);
64 /* find the 'route' for this server (e.g. the one directly connected
65 * to the local server, which we can use to reach it)
67 * In the following example, consider we have just added a TreeServer
68 * class for server G on our network, of which we are server A.
69 * To route traffic to G (marked with a *) we must send the data to
70 * B (marked with a +) so this algorithm initializes the 'Route'
71 * value to point at whichever server traffic must be routed through
72 * to get here. If we were to try this algorithm with server B,
73 * the Route pointer would point at its own object ('this').
83 * We only run this algorithm when a server is created, as
84 * the routes remain constant while ever the server exists, and
85 * do not need to be re-calculated.
89 if (Route == Utils->TreeRoot)
95 while (this->Route->GetParent() != Utils->TreeRoot)
97 this->Route = Route->GetParent();
101 /* Because recursive code is slow and takes a lot of resources,
102 * we store two representations of the server tree. The first
103 * is a recursive structure where each server references its
104 * children and its parent, which is used for netbursts and
105 * netsplits to dump the whole dataset to the other server,
106 * and the second is used for very fast lookups when routing
107 * messages and is instead a hash_map, where each item can
108 * be referenced by its server name. The AddHashEntry()
109 * call below automatically inserts each TreeServer class
110 * into the hash_map as it is created. There is a similar
111 * maintainance call in the destructor to tidy up deleted
115 this->AddHashEntry();
116 Parent->AddChild(this);
119 const std::string& TreeServer::GetID()
124 void TreeServer::FinishBurstInternal()
126 this->bursting = false;
127 SetNextPingTime(ServerInstance->Time() + Utils->PingFreq);
129 for (ChildServers::const_iterator i = Children.begin(); i != Children.end(); ++i)
131 TreeServer* child = *i;
132 child->FinishBurstInternal();
136 void TreeServer::FinishBurst()
138 FinishBurstInternal();
139 ServerInstance->XLines->ApplyLines();
140 long ts = ServerInstance->Time() * 1000 + (ServerInstance->Time_ns() / 1000000);
141 unsigned long bursttime = ts - this->StartBurst;
142 ServerInstance->SNO->WriteToSnoMask(Parent == Utils->TreeRoot ? 'l' : 'L', "Received end of netburst from \2%s\2 (burst time: %lu %s)",
143 GetName().c_str(), (bursttime > 10000 ? bursttime / 1000 : bursttime), (bursttime > 10000 ? "secs" : "msecs"));
144 AddServerEvent(Utils->Creator, GetName());
147 int TreeServer::QuitUsers(const std::string &reason)
149 std::string publicreason = ServerInstance->Config->HideSplits ? "*.net *.split" : reason;
151 const user_hash& users = ServerInstance->Users->GetUsers();
152 unsigned int original_size = users.size();
153 for (user_hash::const_iterator i = users.begin(); i != users.end(); )
155 User* user = i->second;
156 // Increment the iterator now because QuitUser() removes the user from the container
158 if (user->server == this)
159 ServerInstance->Users->QuitUser(user, publicreason, &reason);
161 return original_size - users.size();
164 void TreeServer::CheckULine()
166 uline = silentuline = false;
168 ConfigTagList tags = ServerInstance->Config->ConfTags("uline");
169 for (ConfigIter i = tags.first; i != tags.second; ++i)
171 ConfigTag* tag = i->second;
172 std::string server = tag->getString("server");
173 if (!strcasecmp(server.c_str(), GetName().c_str()))
177 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Servers should not uline themselves (at " + tag->getTagLocation() + ")");
182 silentuline = tag->getBool("silent");
188 /** This method is used to add the structure to the
189 * hash_map for linear searches. It is only called
190 * by the constructors.
192 void TreeServer::AddHashEntry()
194 Utils->serverlist[GetName()] = this;
195 Utils->sidlist[sid] = this;
198 /** These accessors etc should be pretty self-
201 TreeServer* TreeServer::GetRoute()
206 const std::string& TreeServer::GetVersion()
208 return VersionString;
211 void TreeServer::SetNextPingTime(time_t t)
214 LastPingWasGood = false;
217 time_t TreeServer::NextPingTime()
222 bool TreeServer::AnsweredLastPing()
224 return LastPingWasGood;
227 void TreeServer::SetPingFlag()
229 LastPingWasGood = true;
232 TreeSocket* TreeServer::GetSocket()
237 TreeServer* TreeServer::GetParent()
242 void TreeServer::SetVersion(const std::string &Version)
244 VersionString = Version;
247 void TreeServer::AddChild(TreeServer* Child)
249 Children.push_back(Child);
252 bool TreeServer::DelChild(TreeServer* Child)
254 std::vector<TreeServer*>::iterator it = std::find(Children.begin(), Children.end(), Child);
255 if (it != Children.end())
263 /** Removes child nodes of this node, and of that node, etc etc.
264 * This is used during netsplits to automatically tidy up the
265 * server tree. It is slow, we don't use it for much else.
267 void TreeServer::Tidy()
271 std::vector<TreeServer*>::iterator a = Children.begin();
272 if (a == Children.end())
282 CullResult TreeServer::cull()
286 return classbase::cull();
289 TreeServer::~TreeServer()
291 /* We'd better tidy up after ourselves, eh? */
295 Utils->sidlist.erase(sid);
296 Utils->serverlist.erase(GetName());