]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_spanningtree/utils.h
Use CommandBase::Params instead of std::vector<std::string>.
[user/henk/code/inspircd.git] / src / modules / m_spanningtree / utils.h
index db61fd7aaa40eeb7b4cf6787afce3437393034db..495b0941401fe4c1a869e4354adc68d3029f05c4 100644 (file)
@@ -1,53 +1,55 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *   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 program is free but copyrighted software; see
- *            the file COPYING for details.
+ * 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 __ST__UTIL__
-#define __ST__UTIL__
+
+#pragma once
 
 #include "inspircd.h"
+#include "cachetimer.h"
 
-/* Foward declarations */
 class TreeServer;
 class TreeSocket;
 class Link;
+class Autoconnect;
 class ModuleSpanningTree;
+class SpanningTreeUtilities;
+class CmdBuilder;
 
-/* This hash_map holds the hash equivalent of the server
- * tree, used for rapid linear lookups.
- */
-#ifdef WINDOWS
-typedef nspace::hash_map<std::string, TreeServer*, nspace::hash_compare<std::string, std::less<std::string> > > server_hash;
-#else
-typedef nspace::hash_map<std::string, TreeServer*, nspace::hash<std::string>, irc::StrHashComp> server_hash;
-#endif
+extern SpanningTreeUtilities* Utils;
 
-typedef std::map<TreeServer*,TreeServer*> TreeServerList;
-
-/** A group of modules that implement BufferedSocketHook
- * that we can use to hook our server to server connections.
+/** Associative container type, mapping server names/ids to TreeServers
  */
-typedef std::map<irc::string, Module*> hookmodules;
+typedef TR1NS::unordered_map<std::string, TreeServer*, irc::insensitive, irc::StrHashComp> server_hash;
 
 /** Contains helper functions and variables for this module,
  * and keeps them out of the global namespace
  */
 class SpanningTreeUtilities : public classbase
 {
- private:
-       /** Creator server
-        */
-       InspIRCd* ServerInstance;
+       CacheRefreshTimer RefreshTimer;
+
  public:
+       typedef std::set<TreeSocket*> TreeSocketSet;
+       typedef std::map<TreeSocket*, std::pair<std::string, unsigned int> > TimeoutList;
+
        /** Creator module
         */
        ModuleSpanningTree* Creator;
@@ -62,16 +64,18 @@ class SpanningTreeUtilities : public classbase
         */
        bool AnnounceTSChange;
 
+       /** Allow modules marked as VF_OPTCOMMON to be mismatched when linking
+        */
+       bool AllowOptCommon;
+
        /** Make snomasks +CQ quiet during bursts and splits
         */
        bool quiet_bursts;
-       /** Socket bindings for listening sockets
-        */
-       std::vector<TreeSocket*> Bindings;
+
        /* Number of seconds that a server can go without ping
         * before opers are warned of high latency.
         */
-       int PingWarnTime;
+       unsigned int PingWarnTime;
        /** This variable represents the root of the server tree
         */
        TreeServer *TreeRoot;
@@ -84,78 +88,59 @@ class SpanningTreeUtilities : public classbase
        /** Hash of currently known server ids
         */
        server_hash sidlist;
-       /** Hash of servers currently bursting but not initialized as connected
+       /** List of all outgoing sockets and their timeouts
         */
-       std::map<irc::string,TreeSocket*> burstingserverlist;
+       TimeoutList timeoutlist;
        /** Holds the data from the <link> tags in the conf
         */
-       std::vector<Link> LinkBlocks;
-
-       /** List of module pointers which can provide I/O abstraction
-        */
-       hookmodules hooks;
-
-       /** List of module names which can provide I/O abstraction
-        */
-       std::vector<std::string> hooknames;
-
-       /** 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.
+       std::vector<reference<Link> > LinkBlocks;
+       /** Holds the data from the <autoconnect> tags in the conf
         */
-       bool ChallengeResponse;
+       std::vector<reference<Autoconnect> > AutoconnectBlocks;
 
        /** Ping frequency of server to server links
         */
-       int PingFreq;
+       unsigned int PingFreq;
 
        /** Initialise utility class
         */
-       SpanningTreeUtilities(InspIRCd* Instance, ModuleSpanningTree* Creator);
+       SpanningTreeUtilities(ModuleSpanningTree* Creator);
+
+       /** Prepare for class destruction
+        */
+       CullResult cull() CXX11_OVERRIDE;
 
        /** Destroy class and free listeners etc
         */
        ~SpanningTreeUtilities();
 
-       /** 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);
+       void RouteCommand(TreeServer* origin, CommandBase* cmd, const CommandBase::Params& parameters, User* user);
 
-       /** Send a message from this server to all but one other, local or remote
+       /** Send a message from this server to one other local or remote
         */
-       bool DoOneToAllButSender(const std::string &prefix, const std::string &command, std::deque<std::string> &params, std::string omit);
+       void DoOneToOne(const CmdBuilder& params, Server* target);
 
        /** 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);
+       void DoOneToAllButSender(const CmdBuilder& params, TreeServer* 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);
-
-       /** Send a message from this server to all others
-        */
-       bool DoOneToMany(const char* prefix, const char* command, std::deque<std::string> &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);
+       void DoOneToMany(const CmdBuilder& 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
+       /** Handle nick collision
         */
-       void AddThisServer(TreeServer* server, TreeServerList &list);
+       bool DoCollision(User* u, TreeServer* server, time_t remotets, const std::string& remoteident, const std::string& remoteip, const std::string& remoteuid, const char* collidecmd);
 
        /** Compile a list of servers which contain members of channel c
         */
-       void GetListOfServersForChannel(Channel* c, TreeServerList &list, char status, const CUList &exempt_list);
+       void GetListOfServersForChannel(Channel* c, TreeSocketSet& list, char status, const CUList& exempt_list);
 
-       /** Find a server by name
+       /** Find a server by name or SID
         */
        TreeServer* FindServer(const std::string &ServerName);
 
@@ -163,22 +148,15 @@ class SpanningTreeUtilities : public classbase
         */
        TreeServer* FindServerID(const std::string &id);
 
-       /** Find a route to a server by name
+       /** Find a server based on a target string.
+        * @param target Target string where a command should be routed to. May be a server name, a sid, a nickname or a uuid.
         */
-       TreeServer* BestRouteTo(const std::string &ServerName);
+       TreeServer* FindRouteTarget(const std::string& target);
 
        /** 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);
@@ -186,6 +164,13 @@ class SpanningTreeUtilities : public classbase
        /** Refresh the IP cache used for allowing inbound connections
         */
        void RefreshIPCache();
+
+       /** Sends a PRIVMSG or a NOTICE to a channel obeying an exempt list and an optional prefix
+        */
+       void SendChannelMessage(const std::string& prefix, Channel* target, const std::string& text, char status, const CUList& exempt_list, const char* message_type, TreeSocket* omit = NULL);
 };
 
-#endif
+inline void SpanningTreeUtilities::DoOneToMany(const CmdBuilder& params)
+{
+       DoOneToAllButSender(params, NULL);
+}