]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_spanningtree/utils.h
Replace copyright headers with headers granting specific authors copyright
[user/henk/code/inspircd.git] / src / modules / m_spanningtree / utils.h
index 734d88d5d37283e7286ea682134769b71024d915..a82b9eb911fa3132f94876f5f241f697068091f9 100644 (file)
@@ -1,43 +1,63 @@
-#ifndef __ST__UTIL__
-#define __ST__UTIL__
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2007 Craig Edwards <craigedwards@brainbox.cc>
+ *
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+
+#ifndef M_SPANNINGTREE_UTILS_H
+#define M_SPANNINGTREE_UTILS_H
 
-#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;
+#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
 
 typedef std::map<TreeServer*,TreeServer*> TreeServerList;
 
-/** A group of modules that implement InspSocketHook
- * that we can use to hook our server to server connections.
- */
-typedef std::map<irc::string, Module*> hookmodules;
-
 /** 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,12 +67,19 @@ 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;
@@ -62,69 +89,111 @@ class SpanningTreeUtilities
        /** 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
+        */
+       std::vector<reference<Autoconnect> > AutoconnectBlocks;
+
+       /** 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.
         */
-       int lines_to_apply;
+       bool ChallengeResponse;
 
-       hookmodules hooks;
-       std::vector<std::string> hooknames;
+       /** Ping frequency of server to server links
+        */
+       int PingFreq;
 
        /** Initialise utility class
         */
-       SpanningTreeUtilities(InspIRCd* Instance, ModuleSpanningTree* Creator);
+       SpanningTreeUtilities(ModuleSpanningTree* Creator);
+
+       /** Prepare for class destruction
+        */
+       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, const 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, const 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, const 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, const 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, const 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, const parameterlist &params);
+
        /** Read the spanningtree module's tags from the config file
         */
-       void ReadConfiguration(bool rebind);
+       void ReadConfiguration();
+
        /** 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();
 };
 
 #endif