src/modules/m_spanningtree/utils.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2007 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 "configreader.h"
  18 #include "users.h"
  19 #include "channels.h"
  20 #include "modules.h"
  21 #include "inspircd.h"
  22
  23 /* Foward declarations */
  24 class TreeServer;
  25 class TreeSocket;
  26 class Link;
  27 class ModuleSpanningTree;
  28
  29 /* This hash_map holds the hash equivalent of the server
  30  * tree, used for rapid linear lookups.
  31  */
  32 typedef nspace::hash_map<std::string, TreeServer*, nspace::hash<string>, irc::StrHashComp> server_hash;
  33
  34 typedef std::map<TreeServer*,TreeServer*> TreeServerList;
  35
  36 /** A group of modules that implement InspSocketHook
  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         /** Flatten links and /MAP for non-opers
  55          */
  56         bool FlatLinks;
  57         /** Hide U-Lined servers in /MAP and /LINKS
  58          */
  59         bool HideULines;
  60         /** Announce TS changes to channels on merge
  61          */
  62         bool AnnounceTSChange;
  63         /** Synchronize timestamps between servers
  64          */
  65         bool EnableTimeSync;
  66         /** Socket bindings for listening sockets
  67          */
  68         std::vector<TreeSocket*> Bindings;
  69         /** This variable represents the root of the server tree
  70          */
  71         TreeServer *TreeRoot;
  72         /** IPs allowed to link to us
  73          */
  74         std::vector<std::string> ValidIPs;
  75         /** Hash of currently connected servers by name
  76          */
  77         server_hash serverlist;
  78         /** Holds the data from the <link> tags in the conf
  79          */
  80         std::vector<Link> LinkBlocks;
  81         /** Holds a bitmask of queued xline types waiting to be applied.
  82          * Will be a mask containing values APPLY_GLINES, APPLY_KLINES,
  83          * APPLY_QLINES and APPLY_ZLINES.
  84          */
  85         int lines_to_apply;
  86
  87         /** If this is true, this server is the master sync server for time
  88          * synching - e.g. it is the server with its clock correct. It will
  89          * send out the correct time at intervals.
  90          */
  91         bool MasterTime;
  92
  93         /** List of module pointers which can provide I/O abstraction
  94          */
  95         hookmodules hooks;
  96
  97         /** List of module names which can provide I/O abstraction
  98          */
  99         std::vector<std::string> hooknames;
 100
 101         /** True (default) if we are to use challenge-response HMAC
 102          * to authenticate passwords.
 103          *
 104          * NOTE: This defaults to on, but should be turned off if
 105          * you are linking to an older version of inspircd.
 106          */
 107         bool ChallengeResponse;
 108
 109         /** Initialise utility class
 110          */
 111         SpanningTreeUtilities(InspIRCd* Instance, ModuleSpanningTree* Creator);
 112         /** Destroy class and free listeners etc
 113          */
 114         ~SpanningTreeUtilities();
 115         /** Send a message from this server to one other local or remote
 116          */
 117         bool DoOneToOne(const std::string &prefix, const std::string &command, std::deque<std::string> &params, std::string target);
 118         /** Send a message from this server to all but one other, local or remote
 119          */
 120         bool DoOneToAllButSender(const std::string &prefix, const std::string &command, std::deque<std::string> &params, std::string omit);
 121         /** Send a message from this server to all but one other, local or remote
 122          */
 123         bool DoOneToAllButSender(const char* prefix, const char* command, std::deque<std::string> &params, std::string omit);
 124         /** Send a message from this server to all others
 125          */
 126         bool DoOneToMany(const std::string &prefix, const std::string &command, std::deque<std::string> &params);
 127         /** Send a message from this server to all others
 128          */
 129         bool DoOneToMany(const char* prefix, const char* command, std::deque<std::string> &params);
 130         /** 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)
 131          */
 132         bool DoOneToAllButSenderRaw(const std::string &data, const std::string &omit, const std::string &prefix, const irc::string &command, std::deque<std::string> &params);
 133         /** Read the spanningtree module's tags from the config file
 134          */
 135         void ReadConfiguration(bool rebind);
 136         /** Add a server to the server list for GetListOfServersForChannel
 137          */
 138         void AddThisServer(TreeServer* server, TreeServerList &list);
 139         /** Compile a list of servers which contain members of channel c
 140          */
 141         void GetListOfServersForChannel(chanrec* c, TreeServerList &list, char status, const CUList &exempt_list);
 142         /** Find a server by name
 143          */
 144         TreeServer* FindServer(const std::string &ServerName);
 145         /** Find a route to a server by name
 146          */
 147         TreeServer* BestRouteTo(const std::string &ServerName);
 148         /** Find a server by glob mask
 149          */
 150         TreeServer* FindServerMask(const std::string &ServerName);
 151         /** Returns true if this is a server name we recognise
 152          */
 153         bool IsServer(const std::string &ServerName);
 154         /** Attempt to connect to the failover link of link x
 155          */
 156         void DoFailOver(Link* x);
 157         /** Find a link tag from a server name
 158          */
 159         Link* FindLink(const std::string& name);
 160         /** Refresh the IP cache used for allowing inbound connections
 161          */
 162         void RefreshIPCache();
 163 };
 164
 165 #endif