src/modules/m_spanningtree/treeserver.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #include "inspircd.h"
  15 #include "commands/cmd_whois.h"
  16 #include "commands/cmd_stats.h"
  17 #include "socket.h"
  18 #include "wildcard.h"
  19 #include "xline.h"
  20 #include "transport.h"
  21
  22 #include "m_spanningtree/utils.h"
  23 #include "m_spanningtree/treeserver.h"
  24
  25 /* $ModDep: m_spanningtree/utils.h m_spanningtree/treeserver.h */
  26
  27 TreeServer::TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance, const std::string &id) : ServerInstance(Instance), Utils(Util)
  28 {
  29         Parent = NULL;
  30         bursting = false;
  31         ServerName.clear();
  32         ServerDesc.clear();
  33         VersionString.clear();
  34         ServerUserCount = ServerOperCount = 0;
  35         StartBurst = rtt = 0;
  36         Warned = Hidden = DupError = false;
  37         VersionString = ServerInstance->GetVersionString();
  38         SetID(id);
  39 }
  40
  41 /** We use this constructor only to create the 'root' item, Utils->TreeRoot, which
  42  * represents our own server. Therefore, it has no route, no parent, and
  43  * no socket associated with it. Its version string is our own local version.
  44  */
  45 TreeServer::TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance, std::string Name, std::string Desc, const std::string &id)
  46                                                 : ServerInstance(Instance), ServerName(Name.c_str()), ServerDesc(Desc), Utils(Util)
  47 {
  48         bursting = false;
  49         Parent = NULL;
  50         VersionString.clear();
  51         ServerUserCount = ServerOperCount = 0;
  52         VersionString = ServerInstance->GetVersionString();
  53         Route = NULL;
  54         Socket = NULL; /* Fix by brain */
  55         StartBurst = rtt = 0;
  56         Warned = Hidden = DupError = false;
  57         AddHashEntry();
  58         SetID(id);
  59 }
  60
  61 /** When we create a new server, we call this constructor to initialize it.
  62  * This constructor initializes the server's Route and Parent, and sets up
  63  * its ping counters so that it will be pinged one minute from now.
  64  */
  65 TreeServer::TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance, std::string Name, std::string Desc, const std::string &id, TreeServer* Above, TreeSocket* Sock, bool Hide)
  66         : ServerInstance(Instance), Parent(Above), ServerName(Name.c_str()), ServerDesc(Desc), Socket(Sock), Utils(Util), Hidden(Hide)
  67 {
  68         bursting = false;
  69         VersionString.clear();
  70         ServerUserCount = ServerOperCount = 0;
  71         this->SetNextPingTime(time(NULL) + Utils->PingFreq);
  72         this->SetPingFlag();
  73         DupError = false;
  74         StartBurst = rtt = 0;
  75
  76         timeval t;
  77         gettimeofday(&t, NULL);
  78         long ts = (t.tv_sec * 1000) + (t.tv_usec / 1000);
  79         this->StartBurst = ts;
  80         Instance->Logs->Log("m_spanningtree",DEBUG, "Started bursting at time %lu", ts);
  81
  82         /* find the 'route' for this server (e.g. the one directly connected
  83          * to the local server, which we can use to reach it)
  84          *
  85          * In the following example, consider we have just added a TreeServer
  86          * class for server G on our network, of which we are server A.
  87          * To route traffic to G (marked with a *) we must send the data to
  88          * B (marked with a +) so this algorithm initializes the 'Route'
  89          * value to point at whichever server traffic must be routed through
  90          * to get here. If we were to try this algorithm with server B,
  91          * the Route pointer would point at its own object ('this').
  92          *
  93          *            A
  94          *           / \
  95          *        + B   C
  96          *         / \   \
  97          *        D   E   F
  98          *       /         \
  99          *    * G           H
 100          *
 101          * We only run this algorithm when a server is created, as
 102          * the routes remain constant while ever the server exists, and
 103          * do not need to be re-calculated.
 104          */
 105
 106         Route = Above;
 107         if (Route == Utils->TreeRoot)
 108         {
 109                 Route = this;
 110         }
 111         else
 112         {
 113                 while (this->Route->GetParent() != Utils->TreeRoot)
 114                 {
 115                         this->Route = Route->GetParent();
 116                 }
 117         }
 118
 119         /* Because recursive code is slow and takes a lot of resources,
 120          * we store two representations of the server tree. The first
 121          * is a recursive structure where each server references its
 122          * children and its parent, which is used for netbursts and
 123          * netsplits to dump the whole dataset to the other server,
 124          * and the second is used for very fast lookups when routing
 125          * messages and is instead a hash_map, where each item can
 126          * be referenced by its server name. The AddHashEntry()
 127          * call below automatically inserts each TreeServer class
 128          * into the hash_map as it is created. There is a similar
 129          * maintainance call in the destructor to tidy up deleted
 130          * servers.
 131          */
 132
 133         this->AddHashEntry();
 134
 135         SetID(id);
 136 }
 137
 138 std::string& TreeServer::GetID()
 139 {
 140         return sid;
 141 }
 142
 143 void TreeServer::FinishBurst()
 144 {
 145         this->bursting = false;
 146         ServerInstance->XLines->ApplyLines();
 147         timeval t;
 148         gettimeofday(&t, NULL);
 149         long ts = (t.tv_sec * 1000) + (t.tv_usec / 1000);
 150         unsigned long bursttime = ts - this->StartBurst;
 151         ServerInstance->SNO->WriteToSnoMask('l', "Received end of netburst from \2%s\2 (burst time: %lu %s)", ServerName.c_str(),
 152                                                 (bursttime > 1000 ? bursttime / 1000 : bursttime), (bursttime > 1000 ? "secs" : "msecs"));
 153         Event rmode((char*)ServerName.c_str(),  (Module*)Utils->Creator, "new_server");
 154         rmode.Send(ServerInstance);
 155 }
 156
 157 void TreeServer::SetID(const std::string &id)
 158 {
 159         ServerInstance->Logs->Log("m_spanningtree",DEBUG, "Setting SID to " + id);
 160         sid = id;
 161         server_hash::iterator iter = Utils->sidlist.find(sid);
 162         if (iter == Utils->sidlist.end())
 163                 Utils->sidlist[sid] = this;
 164         else
 165                 DupError = true;
 166 }
 167
 168 bool TreeServer::DuplicateID()
 169 {
 170         return DupError;
 171 }
 172
 173 int TreeServer::QuitUsers(const std::string &reason)
 174 {
 175         const char* reason_s = reason.c_str();
 176         std::vector<User*> time_to_die;
 177         for (user_hash::iterator n = ServerInstance->Users->clientlist->begin(); n != ServerInstance->Users->clientlist->end(); n++)
 178         {
 179                 if (!strcmp(n->second->server, this->ServerName.c_str()))
 180                 {
 181                         time_to_die.push_back(n->second);
 182                 }
 183         }
 184         for (std::vector<User*>::iterator n = time_to_die.begin(); n != time_to_die.end(); n++)
 185         {
 186                 User* a = (User*)*n;
 187                 if (!IS_LOCAL(a))
 188                 {
 189                         if (ServerInstance->Config->HideSplits)
 190                                 User::QuitUser(ServerInstance, a, "*.net *.split", reason_s);
 191                         else
 192                                 User::QuitUser(ServerInstance, a, reason_s);
 193
 194                         if (this->Utils->quiet_bursts)
 195                                 ServerInstance->GlobalCulls.MakeSilent(a);
 196                 }
 197         }
 198         return time_to_die.size();
 199 }
 200
 201 /** This method is used to add the structure to the
 202  * hash_map for linear searches. It is only called
 203  * by the constructors.
 204  */
 205 void TreeServer::AddHashEntry()
 206 {
 207         server_hash::iterator iter = Utils->serverlist.find(this->ServerName.c_str());
 208         if (iter == Utils->serverlist.end())
 209                 Utils->serverlist[this->ServerName.c_str()] = this;
 210 }
 211
 212 /** This method removes the reference to this object
 213  * from the hash_map which is used for linear searches.
 214  * It is only called by the default destructor.
 215  */
 216 void TreeServer::DelHashEntry()
 217 {
 218         server_hash::iterator iter = Utils->serverlist.find(this->ServerName.c_str());
 219         if (iter != Utils->serverlist.end())
 220                 Utils->serverlist.erase(iter);
 221 }
 222
 223 /** These accessors etc should be pretty self-
 224  * explanitory.
 225  */
 226 TreeServer* TreeServer::GetRoute()
 227 {
 228         return Route;
 229 }
 230
 231 std::string TreeServer::GetName()
 232 {
 233         return ServerName.c_str();
 234 }
 235
 236 std::string TreeServer::GetDesc()
 237 {
 238         return ServerDesc;
 239 }
 240
 241 std::string TreeServer::GetVersion()
 242 {
 243         return VersionString;
 244 }
 245
 246 void TreeServer::SetNextPingTime(time_t t)
 247 {
 248         this->NextPing = t;
 249         LastPingWasGood = false;
 250 }
 251
 252 time_t TreeServer::NextPingTime()
 253 {
 254         return NextPing;
 255 }
 256
 257 bool TreeServer::AnsweredLastPing()
 258 {
 259         return LastPingWasGood;
 260 }
 261
 262 void TreeServer::SetPingFlag()
 263 {
 264         LastPingWasGood = true;
 265 }
 266
 267 unsigned int TreeServer::GetUserCount()
 268 {
 269         return ServerUserCount;
 270 }
 271
 272 void TreeServer::SetUserCount(int diff)
 273 {
 274         ServerUserCount += diff;
 275 }
 276
 277 void TreeServer::SetOperCount(int diff)
 278 {
 279         ServerOperCount += diff;
 280 }
 281
 282 unsigned int TreeServer::GetOperCount()
 283 {
 284         return ServerOperCount;
 285 }
 286
 287 TreeSocket* TreeServer::GetSocket()
 288 {
 289         return Socket;
 290 }
 291
 292 TreeServer* TreeServer::GetParent()
 293 {
 294         return Parent;
 295 }
 296
 297 void TreeServer::SetVersion(const std::string &Version)
 298 {
 299         VersionString = Version;
 300 }
 301
 302 unsigned int TreeServer::ChildCount()
 303 {
 304         return Children.size();
 305 }
 306
 307 TreeServer* TreeServer::GetChild(unsigned int n)
 308 {
 309         if (n < Children.size())
 310         {
 311                 /* Make sure they  cant request
 312                  * an out-of-range object. After
 313                  * all we know what these programmer
 314                  * types are like *grin*.
 315                  */
 316                 return Children[n];
 317         }
 318         else
 319         {
 320                 return NULL;
 321         }
 322 }
 323
 324 void TreeServer::AddChild(TreeServer* Child)
 325 {
 326         Children.push_back(Child);
 327 }
 328
 329 bool TreeServer::DelChild(TreeServer* Child)
 330 {
 331         for (std::vector<TreeServer*>::iterator a = Children.begin(); a < Children.end(); a++)
 332         {
 333                 if (*a == Child)
 334                 {
 335                         Children.erase(a);
 336                         return true;
 337                 }
 338         }
 339         return false;
 340 }
 341
 342 /** Removes child nodes of this node, and of that node, etc etc.
 343  * This is used during netsplits to automatically tidy up the
 344  * server tree. It is slow, we don't use it for much else.
 345  */
 346 bool TreeServer::Tidy()
 347 {
 348         bool stillchildren = true;
 349         while (stillchildren)
 350         {
 351                 stillchildren = false;
 352                 for (std::vector<TreeServer*>::iterator a = Children.begin(); a < Children.end(); a++)
 353                 {
 354                         TreeServer* s = (TreeServer*)*a;
 355                         s->Tidy();
 356                         Children.erase(a);
 357                         delete s;
 358                         stillchildren = true;
 359                         break;
 360                 }
 361         }
 362         return true;
 363 }
 364
 365 TreeServer::~TreeServer()
 366 {
 367         /* We'd better tidy up after ourselves, eh? */
 368         this->DelHashEntry();
 369
 370         server_hash::iterator iter = Utils->sidlist.find(GetID());
 371         if (iter != Utils->sidlist.end())
 372                 Utils->sidlist.erase(iter);
 373 }
 374
 375