1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 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<string, less<string> > > server_hash;
31 typedef nspace::hash_map<std::string, TreeServer*, nspace::hash<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;
54 /** Remote servers that are currently bursting
56 server_hash RemoteServersBursting;
57 /** Flatten links and /MAP for non-opers
60 /** Hide U-Lined servers in /MAP and /LINKS
63 /** Announce TS changes to channels on merge
65 bool AnnounceTSChange;
66 /** Synchronize timestamps between servers
69 /** Make snomasks +CQ quiet during bursts and splits
72 /** Socket bindings for listening sockets
74 std::vector<TreeSocket*> Bindings;
75 /* Number of seconds that a server can go without ping
76 * before opers are warned of high latency.
79 /** This variable represents the root of the server tree
82 /** IPs allowed to link to us
84 std::vector<std::string> ValidIPs;
85 /** Hash of currently connected servers by name
87 server_hash serverlist;
88 /** Hash of currently known server ids
91 /** Hash of servers currently bursting but not initialized as connected
93 std::map<irc::string,TreeSocket*> burstingserverlist;
94 /** Holds the data from the <link> tags in the conf
96 std::vector<Link> LinkBlocks;
98 /** If this is true, this server is the master sync server for time
99 * synching - e.g. it is the server with its clock correct. It will
100 * send out the correct time at intervals.
104 /** List of module pointers which can provide I/O abstraction
108 /** List of module names which can provide I/O abstraction
110 std::vector<std::string> hooknames;
112 /** True (default) if we are to use challenge-response HMAC
113 * to authenticate passwords.
115 * NOTE: This defaults to on, but should be turned off if
116 * you are linking to an older version of inspircd.
118 bool ChallengeResponse;
120 /** Ping frequency of server to server links
124 /** Initialise utility class
126 SpanningTreeUtilities(InspIRCd* Instance, ModuleSpanningTree* Creator);
127 /** Destroy class and free listeners etc
129 ~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);
133 /** Send a message from this server to all but one other, local or remote
135 bool DoOneToAllButSender(const std::string &prefix, const std::string &command, std::deque<std::string> ¶ms, std::string omit);
136 /** Send a message from this server to all but one other, local or remote
138 bool DoOneToAllButSender(const char* prefix, const char* command, std::deque<std::string> ¶ms, std::string omit);
139 /** Send a message from this server to all others
141 bool DoOneToMany(const std::string &prefix, const std::string &command, std::deque<std::string> ¶ms);
142 /** Send a message from this server to all others
144 bool DoOneToMany(const char* prefix, const char* command, std::deque<std::string> ¶ms);
145 /** 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)
147 bool DoOneToAllButSenderRaw(const std::string &data, const std::string &omit, const std::string &prefix, const irc::string &command, std::deque<std::string> ¶ms);
148 /** Read the spanningtree module's tags from the config file
150 void ReadConfiguration(bool rebind);
151 /** Add a server to the server list for GetListOfServersForChannel
153 void AddThisServer(TreeServer* server, TreeServerList &list);
154 /** Compile a list of servers which contain members of channel c
156 void GetListOfServersForChannel(Channel* c, TreeServerList &list, char status, const CUList &exempt_list);
157 /** Find a server by name
159 TreeServer* FindServer(const std::string &ServerName);
160 /** Find server by SID
162 TreeServer* FindServerID(const std::string &id);
163 /** Find a remote bursting server by name
165 TreeServer* FindRemoteBurstServer(TreeServer* Server);
166 /** Set a remote server to bursting or not bursting
168 void SetRemoteBursting(TreeServer* Server, bool bursting);
169 /** Find a route to a server by name
171 TreeServer* BestRouteTo(const std::string &ServerName);
172 /** Find a server by glob mask
174 TreeServer* FindServerMask(const std::string &ServerName);
175 /** Returns true if this is a server name we recognise
177 bool IsServer(const std::string &ServerName);
178 /** Attempt to connect to the failover link of link x
180 void DoFailOver(Link* x);
181 /** Find a link tag from a server name
183 Link* FindLink(const std::string& name);
184 /** Refresh the IP cache used for allowing inbound connections
186 void RefreshIPCache();
188 TreeSocket* FindBurstingServer(const std::string &ServerName);
190 void AddBurstingServer(const std::string &ServerName, TreeSocket* s);
192 void DelBurstingServer(TreeSocket* s);
194 /** Return true if str looks like a server ID
195 * @param string to check against
197 bool IsSID(const std::string &str);