summaryrefslogtreecommitdiff
path: root/src/modules
diff options
context:
space:
mode:
Diffstat (limited to 'src/modules')
-rw-r--r--src/modules/m_spanningtree/main.cpp382
1 files changed, 1 insertions, 381 deletions
diff --git a/src/modules/m_spanningtree/main.cpp b/src/modules/m_spanningtree/main.cpp
index f77fd15b7..b81d989ec 100644
--- a/src/modules/m_spanningtree/main.cpp
+++ b/src/modules/m_spanningtree/main.cpp
@@ -26,6 +26,7 @@
#include "transport.h"
#include "m_spanningtree/utils.h"
+#include "m_spanningtree/treeserver.h"
/** If you make a change which breaks the protocol, increment this.
* If you completely change the protocol, completely change the number.
@@ -115,387 +116,6 @@ class HandshakeTimer : public InspTimer
virtual void Tick(time_t TIME);
};
-/** Each server in the tree is represented by one class of
- * type TreeServer. A locally connected TreeServer can
- * have a class of type TreeSocket associated with it, for
- * remote servers, the TreeSocket entry will be NULL.
- * Each server also maintains a pointer to its parent
- * (NULL if this server is ours, at the top of the tree)
- * and a pointer to its "Route" (see the comments in the
- * constructors below), and also a dynamic list of pointers
- * to its children which can be iterated recursively
- * if required. Creating or deleting objects of type
- i* TreeServer automatically maintains the hash_map of
- * TreeServer items, deleting and inserting them as they
- * are created and destroyed.
- */
-class TreeServer : public classbase
-{
- InspIRCd* ServerInstance; /* Creator */
- TreeServer* Parent; /* Parent entry */
- TreeServer* Route; /* Route entry */
- std::vector<TreeServer*> Children; /* List of child objects */
- irc::string ServerName; /* Server's name */
- std::string ServerDesc; /* Server's description */
- std::string VersionString; /* Version string or empty string */
- int UserCount; /* Not used in this version */
- int OperCount; /* Not used in this version */
- TreeSocket* Socket; /* For directly connected servers this points at the socket object */
- time_t NextPing; /* After this time, the server should be PINGed*/
- bool LastPingWasGood; /* True if the server responded to the last PING with a PONG */
- SpanningTreeUtilities* Utils; /* Utility class */
-
- public:
-
- /** We don't use this constructor. Its a dummy, and won't cause any insertion
- * of the TreeServer into the hash_map. See below for the two we DO use.
- */
- TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance) : ServerInstance(Instance), Utils(Util)
- {
- Parent = NULL;
- ServerName = "";
- ServerDesc = "";
- VersionString = "";
- UserCount = OperCount = 0;
- VersionString = ServerInstance->GetVersionString();
- }
-
- /** We use this constructor only to create the 'root' item, Utils->TreeRoot, which
- * represents our own server. Therefore, it has no route, no parent, and
- * no socket associated with it. Its version string is our own local version.
- */
- TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance, std::string Name, std::string Desc) : ServerInstance(Instance), ServerName(Name.c_str()), ServerDesc(Desc), Utils(Util)
- {
- Parent = NULL;
- VersionString = "";
- UserCount = ServerInstance->UserCount();
- OperCount = ServerInstance->OperCount();
- VersionString = ServerInstance->GetVersionString();
- Route = NULL;
- Socket = NULL; /* Fix by brain */
- AddHashEntry();
- }
-
- /** When we create a new server, we call this constructor to initialize it.
- * This constructor initializes the server's Route and Parent, and sets up
- * its ping counters so that it will be pinged one minute from now.
- */
- TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance, std::string Name, std::string Desc, TreeServer* Above, TreeSocket* Sock)
- : ServerInstance(Instance), Parent(Above), ServerName(Name.c_str()), ServerDesc(Desc), Socket(Sock), Utils(Util)
- {
- VersionString = "";
- UserCount = OperCount = 0;
- this->SetNextPingTime(time(NULL) + 60);
- this->SetPingFlag();
-
- /* find the 'route' for this server (e.g. the one directly connected
- * to the local server, which we can use to reach it)
- *
- * In the following example, consider we have just added a TreeServer
- * class for server G on our network, of which we are server A.
- * To route traffic to G (marked with a *) we must send the data to
- * B (marked with a +) so this algorithm initializes the 'Route'
- * value to point at whichever server traffic must be routed through
- * to get here. If we were to try this algorithm with server B,
- * the Route pointer would point at its own object ('this').
- *
- * A
- * / \
- * + B C
- * / \ \
- * D E F
- * / \
- * * G H
- *
- * We only run this algorithm when a server is created, as
- * the routes remain constant while ever the server exists, and
- * do not need to be re-calculated.
- */
-
- Route = Above;
- if (Route == Utils->TreeRoot)
- {
- Route = this;
- }
- else
- {
- while (this->Route->GetParent() != Utils->TreeRoot)
- {
- this->Route = Route->GetParent();
- }
- }
-
- /* Because recursive code is slow and takes a lot of resources,
- * we store two representations of the server tree. The first
- * is a recursive structure where each server references its
- * children and its parent, which is used for netbursts and
- * netsplits to dump the whole dataset to the other server,
- * and the second is used for very fast lookups when routing
- * messages and is instead a hash_map, where each item can
- * be referenced by its server name. The AddHashEntry()
- * call below automatically inserts each TreeServer class
- * into the hash_map as it is created. There is a similar
- * maintainance call in the destructor to tidy up deleted
- * servers.
- */
-
- this->AddHashEntry();
- }
-
- int QuitUsers(const std::string &reason)
- {
- const char* reason_s = reason.c_str();
- std::vector<userrec*> time_to_die;
- for (user_hash::iterator n = ServerInstance->clientlist->begin(); n != ServerInstance->clientlist->end(); n++)
- {
- if (!strcmp(n->second->server, this->ServerName.c_str()))
- {
- time_to_die.push_back(n->second);
- }
- }
- for (std::vector<userrec*>::iterator n = time_to_die.begin(); n != time_to_die.end(); n++)
- {
- userrec* a = (userrec*)*n;
- if (!IS_LOCAL(a))
- userrec::QuitUser(ServerInstance,a,reason_s);
- }
- return time_to_die.size();
- }
-
- /** This method is used to add the structure to the
- * hash_map for linear searches. It is only called
- * by the constructors.
- */
- void AddHashEntry()
- {
- server_hash::iterator iter = Utils->serverlist.find(this->ServerName.c_str());
- if (iter == Utils->serverlist.end())
- Utils->serverlist[this->ServerName.c_str()] = this;
- }
-
- /** This method removes the reference to this object
- * from the hash_map which is used for linear searches.
- * It is only called by the default destructor.
- */
- void DelHashEntry()
- {
- server_hash::iterator iter = Utils->serverlist.find(this->ServerName.c_str());
- if (iter != Utils->serverlist.end())
- Utils->serverlist.erase(iter);
- }
-
- /** These accessors etc should be pretty self-
- * explanitory.
- */
- TreeServer* GetRoute()
- {
- return Route;
- }
-
- std::string GetName()
- {
- return ServerName.c_str();
- }
-
- std::string GetDesc()
- {
- return ServerDesc;
- }
-
- std::string GetVersion()
- {
- return VersionString;
- }
-
- void SetNextPingTime(time_t t)
- {
- this->NextPing = t;
- LastPingWasGood = false;
- }
-
- time_t NextPingTime()
- {
- return NextPing;
- }
-
- bool AnsweredLastPing()
- {
- return LastPingWasGood;
- }
-
- void SetPingFlag()
- {
- LastPingWasGood = true;
- }
-
- int GetUserCount()
- {
- return UserCount;
- }
-
- void AddUserCount()
- {
- UserCount++;
- }
-
- void DelUserCount()
- {
- UserCount--;
- }
-
- int GetOperCount()
- {
- return OperCount;
- }
-
- TreeSocket* GetSocket()
- {
- return Socket;
- }
-
- TreeServer* GetParent()
- {
- return Parent;
- }
-
- void SetVersion(const std::string &Version)
- {
- VersionString = Version;
- }
-
- unsigned int ChildCount()
- {
- return Children.size();
- }
-
- TreeServer* GetChild(unsigned int n)
- {
- if (n < Children.size())
- {
- /* Make sure they cant request
- * an out-of-range object. After
- * all we know what these programmer
- * types are like *grin*.
- */
- return Children[n];
- }
- else
- {
- return NULL;
- }
- }
-
- void AddChild(TreeServer* Child)
- {
- Children.push_back(Child);
- }
-
- bool DelChild(TreeServer* Child)
- {
- for (std::vector<TreeServer*>::iterator a = Children.begin(); a < Children.end(); a++)
- {
- if (*a == Child)
- {
- Children.erase(a);
- return true;
- }
- }
- return false;
- }
-
- /** Removes child nodes of this node, and of that node, etc etc.
- * This is used during netsplits to automatically tidy up the
- * server tree. It is slow, we don't use it for much else.
- */
- bool Tidy()
- {
- bool stillchildren = true;
- while (stillchildren)
- {
- stillchildren = false;
- for (std::vector<TreeServer*>::iterator a = Children.begin(); a < Children.end(); a++)
- {
- TreeServer* s = (TreeServer*)*a;
- s->Tidy();
- Children.erase(a);
- DELETE(s);
- stillchildren = true;
- break;
- }
- }
- return true;
- }
-
- ~TreeServer()
- {
- /* We'd better tidy up after ourselves, eh? */
- this->DelHashEntry();
- }
-};
-
-/** Yay for fast searches!
- * This is hundreds of times faster than recursion
- * or even scanning a linked list, especially when
- * there are more than a few servers to deal with.
- * (read as: lots).
- */
-TreeServer* SpanningTreeUtilities::FindServer(const std::string &ServerName)
-{
- server_hash::iterator iter;
- iter = serverlist.find(ServerName.c_str());
- if (iter != serverlist.end())
- {
- return iter->second;
- }
- else
- {
- return NULL;
- }
-}
-
-/** Returns the locally connected server we must route a
- * message through to reach server 'ServerName'. This
- * only applies to one-to-one and not one-to-many routing.
- * See the comments for the constructor of TreeServer
- * for more details.
- */
-TreeServer* SpanningTreeUtilities::BestRouteTo(const std::string &ServerName)
-{
- if (ServerName.c_str() == TreeRoot->GetName())
- return NULL;
- TreeServer* Found = FindServer(ServerName);
- if (Found)
- {
- return Found->GetRoute();
- }
- else
- {
- return NULL;
- }
-}
-
-/** Find the first server matching a given glob mask.
- * Theres no find-using-glob method of hash_map [awwww :-(]
- * so instead, we iterate over the list using an iterator
- * and match each one until we get a hit. Yes its slow,
- * deal with it.
- */
-TreeServer* SpanningTreeUtilities::FindServerMask(const std::string &ServerName)
-{
- for (server_hash::iterator i = serverlist.begin(); i != serverlist.end(); i++)
- {
- if (match(i->first.c_str(),ServerName.c_str()))
- return i->second;
- }
- return NULL;
-}
-
-/* A convenient wrapper that returns true if a server exists */
-bool SpanningTreeUtilities::IsServer(const std::string &ServerName)
-{
- return (FindServer(ServerName) != NULL);
-}
-
/** Handle /RCONNECT
*/