]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_spanningtree/utils.h
Make classbase and refcountbase uncopyable; expand comments on their indended uses
[user/henk/code/inspircd.git] / src / modules / m_spanningtree / utils.h
index e031fdeb51231978776e4232b3a3d2b61c6c07ed..2fc7304af7e4df3102bd8f52361063a905f78c6a 100644 (file)
@@ -1,43 +1,70 @@
+/*       +------------------------------------+
+ *       | Inspire Internet Relay Chat Daemon |
+ *       +------------------------------------+
+ *
+ *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
+ *
+ * This program is free but copyrighted software; see
+ *            the file COPYING for details.
+ *
+ * ---------------------------------------------------
+ */
+
 #ifndef __ST__UTIL__
 #define __ST__UTIL__
 
-#include "configreader.h"
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
 #include "inspircd.h"
 
 /* Foward declarations */
 class TreeServer;
 class TreeSocket;
 class Link;
+class Autoconnect;
 class ModuleSpanningTree;
+class SpanningTreeUtilities;
 
 /* This hash_map holds the hash equivalent of the server
  * tree, used for rapid linear lookups.
  */
-typedef nspace::hash_map<std::string, TreeServer*, nspace::hash<string>, irc::StrHashComp> server_hash;
-
-typedef std::map<TreeServer*,TreeServer*> TreeServerList;
+#if defined(WINDOWS) && !defined(HASHMAP_DEPRECATED)
+       typedef nspace::hash_map<std::string, TreeServer*, nspace::hash_compare<std::string, std::less<std::string> > > server_hash;
+#else
+       #ifdef HASHCOMP_DEPRECATED
+               typedef nspace::hash_map<std::string, TreeServer*, nspace::insensitive, irc::StrHashComp> server_hash;
+       #else
+               typedef nspace::hash_map<std::string, TreeServer*, nspace::hash<std::string>, irc::StrHashComp> server_hash;
+       #endif
+#endif
 
-/** A group of modules that implement InspSocketHook
- * that we can use to hook our server to server connections.
+/*
+ * Initialises server connections
  */
-typedef std::map<irc::string, Module*> hookmodules;
+class ServerSocketListener : public ListenSocketBase
+{
+       SpanningTreeUtilities *Utils;
+
+ public:
+       ServerSocketListener(SpanningTreeUtilities *u, int port, const std::string& addr, const std::string& Hook)
+               : ListenSocketBase(port, addr, "servers", Hook), Utils(u)
+       {
+       }
+
+       virtual void OnAcceptReady(int nfd);
+};
+
+typedef std::map<TreeServer*,TreeServer*> TreeServerList;
 
 /** Contains helper functions and variables for this module,
  * and keeps them out of the global namespace
  */
-class SpanningTreeUtilities
+class SpanningTreeUtilities : public classbase
 {
- private:
-       /** Creator server
-        */
-       InspIRCd* ServerInstance;
  public:
        /** Creator module
         */
        ModuleSpanningTree* Creator;
+
        /** Flatten links and /MAP for non-opers
         */
        bool FlatLinks;
@@ -47,95 +74,133 @@ class SpanningTreeUtilities
        /** Announce TS changes to channels on merge
         */
        bool AnnounceTSChange;
-       /** Synchronize timestamps between servers
+
+       /** Allow modules marked as VF_OPTCOMMON to be mismatched when linking
         */
-       bool EnableTimeSync;
-       /** Socket bindings for listening sockets
+       bool AllowOptCommon;
+
+       /** Make snomasks +CQ quiet during bursts and splits
         */
-       std::vector<TreeSocket*> Bindings;
+       bool quiet_bursts;
+
+       /* Number of seconds that a server can go without ping
+        * before opers are warned of high latency.
+        */
+       int PingWarnTime;
        /** This variable represents the root of the server tree
         */
        TreeServer *TreeRoot;
+       /** Represents the server whose command we are processing
+        */
+       FakeUser *ServerUser;
        /** IPs allowed to link to us
         */
        std::vector<std::string> ValidIPs;
        /** Hash of currently connected servers by name
         */
        server_hash serverlist;
+       /** Hash of currently known server ids
+        */
+       server_hash sidlist;
+       /** Hash of servers currently bursting but not initialized as connected
+        */
+       std::map<irc::string,TreeSocket*> burstingserverlist;
+       /** List of all outgoing sockets and their timeouts
+        */
+       std::map<TreeSocket*, std::pair<std::string, int> > timeoutlist;
        /** Holds the data from the <link> tags in the conf
         */
-       std::vector<Link> LinkBlocks;
-       /** Holds a bitmask of queued xline types waiting to be applied.
-        * Will be a mask containing values APPLY_GLINES, APPLY_KLINES,
-        * APPLY_QLINES and APPLY_ZLINES.
+       std::vector<reference<Link> > LinkBlocks;
+       /** Holds the data from the <autoconnect> tags in the conf
         */
-       int lines_to_apply;
+       std::vector<reference<Autoconnect> > AutoconnectBlocks;
 
-       /** If this is true, this server is the master sync server for time
-        * synching - e.g. it is the server with its clock correct. It will
-        * send out the correct time at intervals.
+       /** True (default) if we are to use challenge-response HMAC
+        * to authenticate passwords.
+        *
+        * NOTE: This defaults to on, but should be turned off if
+        * you are linking to an older version of inspircd.
         */
-       bool MasterTime;
+       bool ChallengeResponse;
 
-       /** List of module pointers which can provide I/O abstraction
+       /** Ping frequency of server to server links
         */
-       hookmodules hooks;
+       int PingFreq;
 
-       /** List of module names which can provide I/O abstraction
+       /** Initialise utility class
         */
-       std::vector<std::string> hooknames;
+       SpanningTreeUtilities(ModuleSpanningTree* Creator);
 
-       /** Initialise utility class
+       /** Prepare for class destruction
         */
-       SpanningTreeUtilities(InspIRCd* Instance, ModuleSpanningTree* Creator);
+       CullResult cull();
+
        /** Destroy class and free listeners etc
         */
        ~SpanningTreeUtilities();
+
+       void RouteCommand(TreeServer*, const std::string&, const parameterlist&, User*);
+
        /** Send a message from this server to one other local or remote
         */
-       bool DoOneToOne(const std::string &prefix, const std::string &command, std::deque<std::string> &params, std::string target);
+       bool DoOneToOne(const std::string &prefix, const std::string &command, parameterlist &params, std::string target);
+
        /** Send a message from this server to all but one other, local or remote
         */
-       bool DoOneToAllButSender(const std::string &prefix, const std::string &command, std::deque<std::string> &params, std::string omit);
+       bool DoOneToAllButSender(const std::string &prefix, const std::string &command, parameterlist &params, std::string omit);
+
        /** Send a message from this server to all but one other, local or remote
         */
-       bool DoOneToAllButSender(const char* prefix, const char* command, std::deque<std::string> &params, std::string omit);
+       bool DoOneToAllButSender(const char* prefix, const char* command, parameterlist &params, std::string omit);
+
        /** Send a message from this server to all others
         */
-       bool DoOneToMany(const std::string &prefix, const std::string &command, std::deque<std::string> &params);
+       bool DoOneToMany(const std::string &prefix, const std::string &command, parameterlist &params);
+
        /** Send a message from this server to all others
         */
-       bool DoOneToMany(const char* prefix, const char* command, std::deque<std::string> &params);
+       bool DoOneToMany(const char* prefix, const char* command, parameterlist &params);
+
        /** Send a message from this server to all others, without doing any processing on the command (e.g. send it as-is with colons and all)
         */
-       bool DoOneToAllButSenderRaw(const std::string &data, const std::string &omit, const std::string &prefix, const irc::string &command, std::deque<std::string> &params);
+       bool DoOneToAllButSenderRaw(const std::string &data, const std::string &omit, const std::string &prefix, const irc::string &command, parameterlist &params);
+
        /** Read the spanningtree module's tags from the config file
         */
        void ReadConfiguration(bool rebind);
+
        /** Add a server to the server list for GetListOfServersForChannel
         */
        void AddThisServer(TreeServer* server, TreeServerList &list);
+
        /** Compile a list of servers which contain members of channel c
         */
-       void GetListOfServersForChannel(chanrec* c, TreeServerList &list, char status, const CUList &exempt_list);
+       void GetListOfServersForChannel(Channel* c, TreeServerList &list, char status, const CUList &exempt_list);
+
        /** Find a server by name
         */
        TreeServer* FindServer(const std::string &ServerName);
+
+       /** Find server by SID
+        */
+       TreeServer* FindServerID(const std::string &id);
+
        /** Find a route to a server by name
         */
        TreeServer* BestRouteTo(const std::string &ServerName);
+
        /** Find a server by glob mask
         */
        TreeServer* FindServerMask(const std::string &ServerName);
+
        /** Returns true if this is a server name we recognise
         */
        bool IsServer(const std::string &ServerName);
-       /** Attempt to connect to the failover link of link x
-        */
-       void DoFailOver(Link* x);
+
        /** Find a link tag from a server name
         */
        Link* FindLink(const std::string& name);
+
        /** Refresh the IP cache used for allowing inbound connections
         */
        void RefreshIPCache();