1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
19 /* Foward declarations */
23 class ModuleSpanningTree;
24 class SpanningTreeUtilities;
26 /* This hash_map holds the hash equivalent of the server
27 * tree, used for rapid linear lookups.
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;
32 #ifdef HASHCOMP_DEPRECATED
33 typedef nspace::hash_map<std::string, TreeServer*, nspace::insensitive, irc::StrHashComp> server_hash;
35 typedef nspace::hash_map<std::string, TreeServer*, nspace::hash<std::string>, irc::StrHashComp> server_hash;
40 * Initialises server connections
42 class ServerSocketListener : public ListenSocketBase
44 SpanningTreeUtilities *Utils;
47 ServerSocketListener(InspIRCd* Instance, SpanningTreeUtilities *u, int port, char* addr) : ListenSocketBase(Instance, port, addr)
55 virtual void OnAcceptReady(int nfd);
58 typedef std::map<TreeServer*,TreeServer*> TreeServerList;
60 /** A group of modules that implement BufferedSocketHook
61 * that we can use to hook our server to server connections.
63 typedef std::map<irc::string, Module*> hookmodules;
65 /** The Autoconnect class might as well be a struct,
66 * but this is C++ and we don't believe in structs (!).
67 * It holds the entire information of one <autoconnect>
68 * tag from the main config file. We maintain a list
69 * of them, and populate the list on rehash/load.
71 class Autoconnect : public classbase
76 time_t NextConnectTime;
80 /** Contains helper functions and variables for this module,
81 * and keeps them out of the global namespace
83 class SpanningTreeUtilities : public classbase
88 InspIRCd* ServerInstance;
92 ModuleSpanningTree* Creator;
94 /** Flatten links and /MAP for non-opers
97 /** Hide U-Lined servers in /MAP and /LINKS
100 /** Announce TS changes to channels on merge
102 bool AnnounceTSChange;
104 /** Allow modules marked as VF_OPTCOMMON to be mismatched when linking
108 /** Make snomasks +CQ quiet during bursts and splits
112 /** Socket bindings for listening sockets
114 std::vector<ServerSocketListener *> Bindings;
115 /* Number of seconds that a server can go without ping
116 * before opers are warned of high latency.
119 /** This variable represents the root of the server tree
121 TreeServer *TreeRoot;
122 /** Represents the server whose command we are processing
124 FakeUser *ServerUser;
125 /** IPs allowed to link to us
127 std::vector<std::string> ValidIPs;
128 /** Hash of currently connected servers by name
130 server_hash serverlist;
131 /** Hash of currently known server ids
134 /** Hash of servers currently bursting but not initialized as connected
136 std::map<irc::string,TreeSocket*> burstingserverlist;
137 /** List of all outgoing sockets and their timeouts
139 std::map<TreeSocket*, std::pair<std::string, int> > timeoutlist;
140 /** Holds the data from the <link> tags in the conf
142 std::vector<Link> LinkBlocks;
143 /** Holds the data from the <autoconnect> tags in the conf
145 std::vector<Autoconnect> AutoconnectBlocks;
147 /** List of module pointers which can provide I/O abstraction
151 /** List of module names which can provide I/O abstraction
153 std::vector<std::string> hooknames;
155 /** True (default) if we are to use challenge-response HMAC
156 * to authenticate passwords.
158 * NOTE: This defaults to on, but should be turned off if
159 * you are linking to an older version of inspircd.
161 bool ChallengeResponse;
163 /** Ping frequency of server to server links
167 /** Initialise utility class
169 SpanningTreeUtilities(InspIRCd* Instance, ModuleSpanningTree* Creator);
171 /** Destroy class and free listeners etc
173 ~SpanningTreeUtilities();
175 /** Send a message from this server to one other local or remote
177 bool DoOneToOne(const std::string &prefix, const std::string &command, parameterlist ¶ms, std::string target);
179 /** Send a message from this server to all but one other, local or remote
181 bool DoOneToAllButSender(const std::string &prefix, const std::string &command, parameterlist ¶ms, std::string omit);
183 /** Send a message from this server to all but one other, local or remote
185 bool DoOneToAllButSender(const char* prefix, const char* command, parameterlist ¶ms, std::string omit);
187 /** Send a message from this server to all others
189 bool DoOneToMany(const std::string &prefix, const std::string &command, parameterlist ¶ms);
191 /** Send a message from this server to all others
193 bool DoOneToMany(const char* prefix, const char* command, parameterlist ¶ms);
195 /** 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)
197 bool DoOneToAllButSenderRaw(const std::string &data, const std::string &omit, const std::string &prefix, const irc::string &command, parameterlist ¶ms);
199 /** Read the spanningtree module's tags from the config file
201 void ReadConfiguration(bool rebind);
203 /** Add a server to the server list for GetListOfServersForChannel
205 void AddThisServer(TreeServer* server, TreeServerList &list);
207 /** Compile a list of servers which contain members of channel c
209 void GetListOfServersForChannel(Channel* c, TreeServerList &list, char status, const CUList &exempt_list);
211 /** Find a server by name
213 TreeServer* FindServer(const std::string &ServerName);
215 /** Find server by SID
217 TreeServer* FindServerID(const std::string &id);
219 /** Find a route to a server by name
221 TreeServer* BestRouteTo(const std::string &ServerName);
223 /** Find a server by glob mask
225 TreeServer* FindServerMask(const std::string &ServerName);
227 /** Returns true if this is a server name we recognise
229 bool IsServer(const std::string &ServerName);
231 /** Attempt to connect to the failover link of link x
233 void DoFailOver(Autoconnect* x);
235 /** Find a link tag from a server name
237 Link* FindLink(const std::string& name);
239 /** Refresh the IP cache used for allowing inbound connections
241 void RefreshIPCache();