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)
52 virtual void OnAcceptReady(int nfd);
55 typedef std::map<TreeServer*,TreeServer*> TreeServerList;
57 /** A group of modules that implement BufferedSocketHook
58 * that we can use to hook our server to server connections.
60 typedef std::map<irc::string, Module*> hookmodules;
62 /** Contains helper functions and variables for this module,
63 * and keeps them out of the global namespace
65 class SpanningTreeUtilities : public classbase
70 InspIRCd* ServerInstance;
74 ModuleSpanningTree* Creator;
76 /** Flatten links and /MAP for non-opers
79 /** Hide U-Lined servers in /MAP and /LINKS
82 /** Announce TS changes to channels on merge
84 bool AnnounceTSChange;
86 /** Allow modules marked as VF_OPTCOMMON to be mismatched when linking
90 /** Make snomasks +CQ quiet during bursts and splits
94 /** Socket bindings for listening sockets
96 std::vector<ServerSocketListener *> Bindings;
97 /* Number of seconds that a server can go without ping
98 * before opers are warned of high latency.
101 /** This variable represents the root of the server tree
103 TreeServer *TreeRoot;
104 /** Represents the server whose command we are processing
106 FakeUser *ServerUser;
107 /** IPs allowed to link to us
109 std::vector<std::string> ValidIPs;
110 /** Hash of currently connected servers by name
112 server_hash serverlist;
113 /** Hash of currently known server ids
116 /** Hash of servers currently bursting but not initialized as connected
118 std::map<irc::string,TreeSocket*> burstingserverlist;
119 /** List of all outgoing sockets and their timeouts
121 std::map<TreeSocket*, std::pair<std::string, int> > timeoutlist;
122 /** Holds the data from the <link> tags in the conf
124 std::vector<Link> LinkBlocks;
126 /** List of module pointers which can provide I/O abstraction
130 /** List of module names which can provide I/O abstraction
132 std::vector<std::string> hooknames;
134 /** True (default) if we are to use challenge-response HMAC
135 * to authenticate passwords.
137 * NOTE: This defaults to on, but should be turned off if
138 * you are linking to an older version of inspircd.
140 bool ChallengeResponse;
142 /** Ping frequency of server to server links
146 /** Initialise utility class
148 SpanningTreeUtilities(InspIRCd* Instance, ModuleSpanningTree* Creator);
150 /** Destroy class and free listeners etc
152 ~SpanningTreeUtilities();
154 /** Send a message from this server to one other local or remote
156 bool DoOneToOne(const std::string &prefix, const std::string &command, parameterlist ¶ms, std::string target);
158 /** Send a message from this server to all but one other, local or remote
160 bool DoOneToAllButSender(const std::string &prefix, const std::string &command, parameterlist ¶ms, std::string omit);
162 /** Send a message from this server to all but one other, local or remote
164 bool DoOneToAllButSender(const char* prefix, const char* command, parameterlist ¶ms, std::string omit);
166 /** Send a message from this server to all others
168 bool DoOneToMany(const std::string &prefix, const std::string &command, parameterlist ¶ms);
170 /** Send a message from this server to all others
172 bool DoOneToMany(const char* prefix, const char* command, parameterlist ¶ms);
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)
176 bool DoOneToAllButSenderRaw(const std::string &data, const std::string &omit, const std::string &prefix, const irc::string &command, parameterlist ¶ms);
178 /** Read the spanningtree module's tags from the config file
180 void ReadConfiguration(bool rebind);
182 /** Add a server to the server list for GetListOfServersForChannel
184 void AddThisServer(TreeServer* server, TreeServerList &list);
186 /** Compile a list of servers which contain members of channel c
188 void GetListOfServersForChannel(Channel* c, TreeServerList &list, char status, const CUList &exempt_list);
190 /** Find a server by name
192 TreeServer* FindServer(const std::string &ServerName);
194 /** Find server by SID
196 TreeServer* FindServerID(const std::string &id);
198 /** Find a route to a server by name
200 TreeServer* BestRouteTo(const std::string &ServerName);
202 /** Find a server by glob mask
204 TreeServer* FindServerMask(const std::string &ServerName);
206 /** Returns true if this is a server name we recognise
208 bool IsServer(const std::string &ServerName);
210 /** Attempt to connect to the failover link of link x
212 void DoFailOver(Link* x);
214 /** Find a link tag from a server name
216 Link* FindLink(const std::string& name);
218 /** Refresh the IP cache used for allowing inbound connections
220 void RefreshIPCache();