src/modules/m_spanningtree/utils.h

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