1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2008 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
19 /* Foward declarations */
23 class ModuleSpanningTree;
25 /* This hash_map holds the hash equivalent of the server
26 * tree, used for rapid linear lookups.
29 typedef nspace::hash_map<std::string, TreeServer*, nspace::hash_compare<std::string, std::less<std::string> > > server_hash;
31 typedef nspace::hash_map<std::string, TreeServer*, nspace::hash<std::string>, irc::StrHashComp> server_hash;
34 typedef std::map<TreeServer*,TreeServer*> TreeServerList;
36 /** A group of modules that implement BufferedSocketHook
37 * that we can use to hook our server to server connections.
39 typedef std::map<irc::string, Module*> hookmodules;
41 /** Contains helper functions and variables for this module,
42 * and keeps them out of the global namespace
44 class SpanningTreeUtilities
49 InspIRCd* ServerInstance;
53 ModuleSpanningTree* Creator;
55 /** Flatten links and /MAP for non-opers
58 /** Hide U-Lined servers in /MAP and /LINKS
61 /** Announce TS changes to channels on merge
63 bool AnnounceTSChange;
64 /** Synchronize timestamps between servers
67 /** Make snomasks +CQ quiet during bursts and splits
70 /** Socket bindings for listening sockets
72 std::vector<TreeSocket*> Bindings;
73 /* Number of seconds that a server can go without ping
74 * before opers are warned of high latency.
77 /** This variable represents the root of the server tree
80 /** IPs allowed to link to us
82 std::vector<std::string> ValidIPs;
83 /** Hash of currently connected servers by name
85 server_hash serverlist;
86 /** Hash of currently known server ids
89 /** Hash of servers currently bursting but not initialized as connected
91 std::map<irc::string,TreeSocket*> burstingserverlist;
92 /** Holds the data from the <link> tags in the conf
94 std::vector<Link> LinkBlocks;
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.
102 /** List of module pointers which can provide I/O abstraction
106 /** List of module names which can provide I/O abstraction
108 std::vector<std::string> hooknames;
110 /** True (default) if we are to use challenge-response HMAC
111 * to authenticate passwords.
113 * NOTE: This defaults to on, but should be turned off if
114 * you are linking to an older version of inspircd.
116 bool ChallengeResponse;
118 /** Ping frequency of server to server links
122 /** Initialise utility class
124 SpanningTreeUtilities(InspIRCd* Instance, ModuleSpanningTree* Creator);
126 /** Destroy class and free listeners etc
128 ~SpanningTreeUtilities();
130 /** Send a message from this server to one other local or remote
132 bool DoOneToOne(const std::string &prefix, const std::string &command, std::deque<std::string> ¶ms, std::string target);
134 /** Send a message from this server to all but one other, local or remote
136 bool DoOneToAllButSender(const std::string &prefix, const std::string &command, std::deque<std::string> ¶ms, std::string omit);
138 /** Send a message from this server to all but one other, local or remote
140 bool DoOneToAllButSender(const char* prefix, const char* command, std::deque<std::string> ¶ms, std::string omit);
142 /** Send a message from this server to all others
144 bool DoOneToMany(const std::string &prefix, const std::string &command, std::deque<std::string> ¶ms);
146 /** Send a message from this server to all others
148 bool DoOneToMany(const char* prefix, const char* command, std::deque<std::string> ¶ms);
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)
152 bool DoOneToAllButSenderRaw(const std::string &data, const std::string &omit, const std::string &prefix, const irc::string &command, std::deque<std::string> ¶ms);
154 /** Read the spanningtree module's tags from the config file
156 void ReadConfiguration(bool rebind);
158 /** Add a server to the server list for GetListOfServersForChannel
160 void AddThisServer(TreeServer* server, TreeServerList &list);
162 /** Compile a list of servers which contain members of channel c
164 void GetListOfServersForChannel(Channel* c, TreeServerList &list, char status, const CUList &exempt_list);
166 /** Find a server by name
168 TreeServer* FindServer(const std::string &ServerName);
170 /** Find server by SID
172 TreeServer* FindServerID(const std::string &id);
174 /** Find a route to a server by name
176 TreeServer* BestRouteTo(const std::string &ServerName);
178 /** Find a server by glob mask
180 TreeServer* FindServerMask(const std::string &ServerName);
182 /** Returns true if this is a server name we recognise
184 bool IsServer(const std::string &ServerName);
186 /** Attempt to connect to the failover link of link x
188 void DoFailOver(Link* x);
190 /** Find a link tag from a server name
192 Link* FindLink(const std::string& name);
194 /** Refresh the IP cache used for allowing inbound connections
196 void RefreshIPCache();