src/modules/m_spanningtree/utils.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
   6  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   7  *   Copyright (C) 2007 Craig Edwards <craigedwards@brainbox.cc>
   8  *
   9  * This file is part of InspIRCd.  InspIRCd is free software: you can
  10  * redistribute it and/or modify it under the terms of the GNU General Public
  11  * License as published by the Free Software Foundation, version 2.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22
  23 #ifndef M_SPANNINGTREE_UTILS_H
  24 #define M_SPANNINGTREE_UTILS_H
  25
  26 #include "inspircd.h"
  27
  28 /* Foward declarations */
  29 class TreeServer;
  30 class TreeSocket;
  31 class Link;
  32 class Autoconnect;
  33 class ModuleSpanningTree;
  34 class SpanningTreeUtilities;
  35
  36 /* This hash_map holds the hash equivalent of the server
  37  * tree, used for rapid linear lookups.
  38  */
  39 typedef std::tr1::unordered_map<std::string, TreeServer*, std::tr1::insensitive, irc::StrHashComp> server_hash;
  40
  41 typedef std::map<TreeServer*,TreeServer*> TreeServerList;
  42
  43 /** Contains helper functions and variables for this module,
  44  * and keeps them out of the global namespace
  45  */
  46 class SpanningTreeUtilities : public classbase
  47 {
  48  public:
  49         /** Creator module
  50          */
  51         ModuleSpanningTree* Creator;
  52
  53         /** Flatten links and /MAP for non-opers
  54          */
  55         bool FlatLinks;
  56         /** Hide U-Lined servers in /MAP and /LINKS
  57          */
  58         bool HideULines;
  59         /** Announce TS changes to channels on merge
  60          */
  61         bool AnnounceTSChange;
  62
  63         /** Allow modules marked as VF_OPTCOMMON to be mismatched when linking
  64          */
  65         bool AllowOptCommon;
  66
  67         /** Make snomasks +CQ quiet during bursts and splits
  68          */
  69         bool quiet_bursts;
  70
  71         /* Number of seconds that a server can go without ping
  72          * before opers are warned of high latency.
  73          */
  74         int PingWarnTime;
  75         /** This variable represents the root of the server tree
  76          */
  77         TreeServer *TreeRoot;
  78         /** IPs allowed to link to us
  79          */
  80         std::vector<std::string> ValidIPs;
  81         /** Hash of currently connected servers by name
  82          */
  83         server_hash serverlist;
  84         /** Hash of currently known server ids
  85          */
  86         server_hash sidlist;
  87         /** Hash of servers currently bursting but not initialized as connected
  88          */
  89         std::map<irc::string,TreeSocket*> burstingserverlist;
  90         /** List of all outgoing sockets and their timeouts
  91          */
  92         std::map<TreeSocket*, std::pair<std::string, int> > timeoutlist;
  93         /** Holds the data from the <link> tags in the conf
  94          */
  95         std::vector<reference<Link> > LinkBlocks;
  96         /** Holds the data from the <autoconnect> tags in the conf
  97          */
  98         std::vector<reference<Autoconnect> > AutoconnectBlocks;
  99
 100         /** True (default) if we are to use challenge-response HMAC
 101          * to authenticate passwords.
 102          *
 103          * NOTE: This defaults to on, but should be turned off if
 104          * you are linking to an older version of inspircd.
 105          */
 106         bool ChallengeResponse;
 107
 108         /** Ping frequency of server to server links
 109          */
 110         int PingFreq;
 111
 112         /** Initialise utility class
 113          */
 114         SpanningTreeUtilities(ModuleSpanningTree* Creator);
 115
 116         /** Prepare for class destruction
 117          */
 118         CullResult cull();
 119
 120         /** Destroy class and free listeners etc
 121          */
 122         ~SpanningTreeUtilities();
 123
 124         void RouteCommand(TreeServer*, const std::string&, const parameterlist&, User*);
 125
 126         /** Send a message from this server to one other local or remote
 127          */
 128         bool DoOneToOne(const std::string &prefix, const std::string &command, const parameterlist &params, std::string target);
 129
 130         /** Send a message from this server to all but one other, local or remote
 131          */
 132         bool DoOneToAllButSender(const std::string &prefix, const std::string &command, const parameterlist &params, std::string omit);
 133
 134         /** Send a message from this server to all but one other, local or remote
 135          */
 136         bool DoOneToAllButSender(const char* prefix, const char* command, const parameterlist &params, std::string omit);
 137
 138         /** Send a message from this server to all others
 139          */
 140         bool DoOneToMany(const std::string &prefix, const std::string &command, const parameterlist &params);
 141
 142         /** Send a message from this server to all others
 143          */
 144         bool DoOneToMany(const char* prefix, const char* command, const parameterlist &params);
 145
 146         /** Read the spanningtree module's tags from the config file
 147          */
 148         void ReadConfiguration();
 149
 150         /** Add a server to the server list for GetListOfServersForChannel
 151          */
 152         void AddThisServer(TreeServer* server, TreeServerList &list);
 153
 154         /** Compile a list of servers which contain members of channel c
 155          */
 156         void GetListOfServersForChannel(Channel* c, TreeServerList &list, char status, const CUList &exempt_list);
 157
 158         /** Find a server by name
 159          */
 160         TreeServer* FindServer(const std::string &ServerName);
 161
 162         /** Find server by SID
 163          */
 164         TreeServer* FindServerID(const std::string &id);
 165
 166         /** Find a route to a server by name
 167          */
 168         TreeServer* BestRouteTo(const std::string &ServerName);
 169
 170         /** Find a server by glob mask
 171          */
 172         TreeServer* FindServerMask(const std::string &ServerName);
 173
 174         /** Find a link tag from a server name
 175          */
 176         Link* FindLink(const std::string& name);
 177
 178         /** Refresh the IP cache used for allowing inbound connections
 179          */
 180         void RefreshIPCache();
 181 };
 182
 183 #endif