src/modules/m_spanningtree/utils.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #ifndef __ST__UTIL__
  15 #define __ST__UTIL__
  16
  17 #include "inspircd.h"
  18
  19 /* Foward declarations */
  20 class TreeServer;
  21 class TreeSocket;
  22 class Link;
  23 class ModuleSpanningTree;
  24
  25 /* This hash_map holds the hash equivalent of the server
  26  * tree, used for rapid linear lookups.
  27  */
  28 #ifdef WINDOWS
  29 typedef nspace::hash_map<std::string, TreeServer*, nspace::hash_compare<std::string, less<string> > > server_hash;
  30 #else
  31 typedef nspace::hash_map<std::string, TreeServer*, nspace::hash<std::string>, irc::StrHashComp> server_hash;
  32 #endif
  33
  34 typedef std::map<TreeServer*,TreeServer*> TreeServerList;
  35
  36 /** A group of modules that implement BufferedSocketHook
  37  * that we can use to hook our server to server connections.
  38  */
  39 typedef std::map<irc::string, Module*> hookmodules;
  40
  41 /** Contains helper functions and variables for this module,
  42  * and keeps them out of the global namespace
  43  */
  44 class SpanningTreeUtilities
  45 {
  46  private:
  47         /** Creator server
  48          */
  49         InspIRCd* ServerInstance;
  50  public:
  51         /** Creator module
  52          */
  53         ModuleSpanningTree* Creator;
  54
  55         /** Flatten links and /MAP for non-opers
  56          */
  57         bool FlatLinks;
  58         /** Hide U-Lined servers in /MAP and /LINKS
  59          */
  60         bool HideULines;
  61         /** Announce TS changes to channels on merge
  62          */
  63         bool AnnounceTSChange;
  64         /** Synchronize timestamps between servers
  65          */
  66         bool EnableTimeSync;
  67         /** Make snomasks +CQ quiet during bursts and splits
  68          */
  69         bool quiet_bursts;
  70         /** Socket bindings for listening sockets
  71          */
  72         std::vector<TreeSocket*> Bindings;
  73         /* Number of seconds that a server can go without ping
  74          * before opers are warned of high latency.
  75          */
  76         int PingWarnTime;
  77         /** This variable represents the root of the server tree
  78          */
  79         TreeServer *TreeRoot;
  80         /** IPs allowed to link to us
  81          */
  82         std::vector<std::string> ValidIPs;
  83         /** Hash of currently connected servers by name
  84          */
  85         server_hash serverlist;
  86         /** Hash of currently known server ids
  87          */
  88         server_hash sidlist;
  89         /** Hash of servers currently bursting but not initialized as connected
  90          */
  91         std::map<irc::string,TreeSocket*> burstingserverlist;
  92         /** Holds the data from the <link> tags in the conf
  93          */
  94         std::vector<Link> LinkBlocks;
  95
  96         /** If this is true, this server is the master sync server for time
  97          * synching - e.g. it is the server with its clock correct. It will
  98          * send out the correct time at intervals.
  99          */
 100         bool MasterTime;
 101
 102         /** List of module pointers which can provide I/O abstraction
 103          */
 104         hookmodules hooks;
 105
 106         /** List of module names which can provide I/O abstraction
 107          */
 108         std::vector<std::string> hooknames;
 109
 110         /** True (default) if we are to use challenge-response HMAC
 111          * to authenticate passwords.
 112          *
 113          * NOTE: This defaults to on, but should be turned off if
 114          * you are linking to an older version of inspircd.
 115          */
 116         bool ChallengeResponse;
 117
 118         /** Ping frequency of server to server links
 119          */
 120         int PingFreq;
 121
 122         /** Initialise utility class
 123          */
 124         SpanningTreeUtilities(InspIRCd* Instance, ModuleSpanningTree* Creator);
 125
 126         /** Destroy class and free listeners etc
 127          */
 128         ~SpanningTreeUtilities();
 129
 130         /** Send a message from this server to one other local or remote
 131          */
 132         bool DoOneToOne(const std::string &prefix, const std::string &command, std::deque<std::string> &params, std::string target);
 133
 134         /** Send a message from this server to all but one other, local or remote
 135          */
 136         bool DoOneToAllButSender(const std::string &prefix, const std::string &command, std::deque<std::string> &params, std::string omit);
 137
 138         /** Send a message from this server to all but one other, local or remote
 139          */
 140         bool DoOneToAllButSender(const char* prefix, const char* command, std::deque<std::string> &params, std::string omit);
 141
 142         /** Send a message from this server to all others
 143          */
 144         bool DoOneToMany(const std::string &prefix, const std::string &command, std::deque<std::string> &params);
 145
 146         /** Send a message from this server to all others
 147          */
 148         bool DoOneToMany(const char* prefix, const char* command, std::deque<std::string> &params);
 149
 150         /** 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)
 151          */
 152         bool DoOneToAllButSenderRaw(const std::string &data, const std::string &omit, const std::string &prefix, const irc::string &command, std::deque<std::string> &params);
 153
 154         /** Read the spanningtree module's tags from the config file
 155          */
 156         void ReadConfiguration(bool rebind);
 157
 158         /** Add a server to the server list for GetListOfServersForChannel
 159          */
 160         void AddThisServer(TreeServer* server, TreeServerList &list);
 161
 162         /** Compile a list of servers which contain members of channel c
 163          */
 164         void GetListOfServersForChannel(Channel* c, TreeServerList &list, char status, const CUList &exempt_list);
 165
 166         /** Find a server by name
 167          */
 168         TreeServer* FindServer(const std::string &ServerName);
 169
 170         /** Find server by SID
 171          */
 172         TreeServer* FindServerID(const std::string &id);
 173
 174         /** Find a route to a server by name
 175          */
 176         TreeServer* BestRouteTo(const std::string &ServerName);
 177
 178         /** Find a server by glob mask
 179          */
 180         TreeServer* FindServerMask(const std::string &ServerName);
 181
 182         /** Returns true if this is a server name we recognise
 183          */
 184         bool IsServer(const std::string &ServerName);
 185
 186         /** Attempt to connect to the failover link of link x
 187          */
 188         void DoFailOver(Link* x);
 189
 190         /** Find a link tag from a server name
 191          */
 192         Link* FindLink(const std::string& name);
 193
 194         /** Refresh the IP cache used for allowing inbound connections
 195          */
 196         void RefreshIPCache();
 197 };
 198
 199 #endif