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), 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), UserCount(0), OperCount(0), rtt(0), StartBurst(0), Hidden(Hide)
57 SetNextPingTime(ServerInstance->Time() + Utils->PingFreq);
60 /* find the 'route' for this server (e.g. the one directly connected
61 * to the local server, which we can use to reach it)
63 * In the following example, consider we have just added a TreeServer
64 * class for server G on our network, of which we are server A.
65 * To route traffic to G (marked with a *) we must send the data to
66 * B (marked with a +) so this algorithm initializes the 'Route'
67 * value to point at whichever server traffic must be routed through
68 * to get here. If we were to try this algorithm with server B,
69 * the Route pointer would point at its own object ('this').
79 * We only run this algorithm when a server is created, as
80 * the routes remain constant while ever the server exists, and
81 * do not need to be re-calculated.
85 if (Route == Utils->TreeRoot)
91 while (this->Route->GetParent() != Utils->TreeRoot)
93 this->Route = Route->GetParent();
97 /* Because recursive code is slow and takes a lot of resources,
98 * we store two representations of the server tree. The first
99 * is a recursive structure where each server references its
100 * children and its parent, which is used for netbursts and
101 * netsplits to dump the whole dataset to the other server,
102 * and the second is used for very fast lookups when routing
103 * messages and is instead a hash_map, where each item can
104 * be referenced by its server name. The AddHashEntry()
105 * call below automatically inserts each TreeServer class
106 * into the hash_map as it is created. There is a similar
107 * maintainance call in the destructor to tidy up deleted
111 this->AddHashEntry();
112 Parent->AddChild(this);
115 void TreeServer::BeginBurst(unsigned long startms)
117 unsigned long now = ServerInstance->Time() * 1000 + (ServerInstance->Time_ns() / 1000000);
118 // If the start time is in the future (clocks are not synced) then use current time
119 if ((!startms) || (startms > now))
121 this->StartBurst = startms;
122 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Server %s started bursting at time %lu", sid.c_str(), startms);
125 const std::string& TreeServer::GetID()
130 void TreeServer::FinishBurstInternal()
133 SetNextPingTime(ServerInstance->Time() + Utils->PingFreq);
135 for (ChildServers::const_iterator i = Children.begin(); i != Children.end(); ++i)
137 TreeServer* child = *i;
138 child->FinishBurstInternal();
142 void TreeServer::FinishBurst()
144 ServerInstance->XLines->ApplyLines();
145 long ts = ServerInstance->Time() * 1000 + (ServerInstance->Time_ns() / 1000000);
146 unsigned long bursttime = ts - this->StartBurst;
147 ServerInstance->SNO->WriteToSnoMask(Parent == Utils->TreeRoot ? 'l' : 'L', "Received end of netburst from \2%s\2 (burst time: %lu %s)",
148 GetName().c_str(), (bursttime > 10000 ? bursttime / 1000 : bursttime), (bursttime > 10000 ? "secs" : "msecs"));
149 AddServerEvent(Utils->Creator, GetName());
151 FinishBurstInternal();
154 int TreeServer::QuitUsers(const std::string &reason)
156 std::string publicreason = ServerInstance->Config->HideSplits ? "*.net *.split" : reason;
158 const user_hash& users = ServerInstance->Users->GetUsers();
159 unsigned int original_size = users.size();
160 for (user_hash::const_iterator i = users.begin(); i != users.end(); )
162 User* user = i->second;
163 // Increment the iterator now because QuitUser() removes the user from the container
165 if (user->server == this)
166 ServerInstance->Users->QuitUser(user, publicreason, &reason);
168 return original_size - users.size();
171 void TreeServer::CheckULine()
173 uline = silentuline = false;
175 ConfigTagList tags = ServerInstance->Config->ConfTags("uline");
176 for (ConfigIter i = tags.first; i != tags.second; ++i)
178 ConfigTag* tag = i->second;
179 std::string server = tag->getString("server");
180 if (!strcasecmp(server.c_str(), GetName().c_str()))
184 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Servers should not uline themselves (at " + tag->getTagLocation() + ")");
189 silentuline = tag->getBool("silent");
195 /** This method is used to add the structure to the
196 * hash_map for linear searches. It is only called
197 * by the constructors.
199 void TreeServer::AddHashEntry()
201 Utils->serverlist[GetName()] = this;
202 Utils->sidlist[sid] = this;
205 /** These accessors etc should be pretty self-
208 TreeServer* TreeServer::GetRoute()
213 const std::string& TreeServer::GetVersion()
215 return VersionString;
218 void TreeServer::SetNextPingTime(time_t t)
221 LastPingWasGood = false;
224 time_t TreeServer::NextPingTime()
229 bool TreeServer::AnsweredLastPing()
231 return LastPingWasGood;
234 void TreeServer::SetPingFlag()
236 LastPingWasGood = true;
239 TreeSocket* TreeServer::GetSocket()
244 TreeServer* TreeServer::GetParent()
249 void TreeServer::SetVersion(const std::string &Version)
251 VersionString = Version;
254 void TreeServer::AddChild(TreeServer* Child)
256 Children.push_back(Child);
259 bool TreeServer::DelChild(TreeServer* Child)
261 std::vector<TreeServer*>::iterator it = std::find(Children.begin(), Children.end(), Child);
262 if (it != Children.end())
270 /** Removes child nodes of this node, and of that node, etc etc.
271 * This is used during netsplits to automatically tidy up the
272 * server tree. It is slow, we don't use it for much else.
274 void TreeServer::Tidy()
278 std::vector<TreeServer*>::iterator a = Children.begin();
279 if (a == Children.end())
289 CullResult TreeServer::cull()
293 return classbase::cull();
296 TreeServer::~TreeServer()
298 /* We'd better tidy up after ourselves, eh? */
302 Utils->sidlist.erase(sid);
303 Utils->serverlist.erase(GetName());