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 */
24 class ModuleSpanningTree;
25 class SpanningTreeUtilities;
27 /* This hash_map holds the hash equivalent of the server
28 * tree, used for rapid linear lookups.
30 #if defined(WINDOWS) && !defined(HASHMAP_DEPRECATED)
31 typedef nspace::hash_map<std::string, TreeServer*, nspace::hash_compare<std::string, std::less<std::string> > > server_hash;
33 #ifdef HASHCOMP_DEPRECATED
34 typedef nspace::hash_map<std::string, TreeServer*, nspace::insensitive, irc::StrHashComp> server_hash;
36 typedef nspace::hash_map<std::string, TreeServer*, nspace::hash<std::string>, irc::StrHashComp> server_hash;
41 * Initialises server connections
43 class ServerSocketListener : public ListenSocketBase
45 SpanningTreeUtilities *Utils;
48 ServerSocketListener(SpanningTreeUtilities *u, int port, const std::string& addr, const std::string& Hook)
49 : ListenSocketBase(port, addr, "servers", Hook), Utils(u)
53 virtual void OnAcceptReady(int nfd);
56 typedef std::map<TreeServer*,TreeServer*> TreeServerList;
58 /** Contains helper functions and variables for this module,
59 * and keeps them out of the global namespace
61 class SpanningTreeUtilities : public classbase
66 ModuleSpanningTree* Creator;
68 /** Flatten links and /MAP for non-opers
71 /** Hide U-Lined servers in /MAP and /LINKS
74 /** Announce TS changes to channels on merge
76 bool AnnounceTSChange;
78 /** Allow modules marked as VF_OPTCOMMON to be mismatched when linking
82 /** Make snomasks +CQ quiet during bursts and splits
86 /* Number of seconds that a server can go without ping
87 * before opers are warned of high latency.
90 /** This variable represents the root of the server tree
93 /** Represents the server whose command we are processing
96 /** IPs allowed to link to us
98 std::vector<std::string> ValidIPs;
99 /** Hash of currently connected servers by name
101 server_hash serverlist;
102 /** Hash of currently known server ids
105 /** Hash of servers currently bursting but not initialized as connected
107 std::map<irc::string,TreeSocket*> burstingserverlist;
108 /** List of all outgoing sockets and their timeouts
110 std::map<TreeSocket*, std::pair<std::string, int> > timeoutlist;
111 /** Holds the data from the <link> tags in the conf
113 std::vector<reference<Link> > LinkBlocks;
114 /** Holds the data from the <autoconnect> tags in the conf
116 std::vector<reference<Autoconnect> > AutoconnectBlocks;
118 /** True (default) if we are to use challenge-response HMAC
119 * to authenticate passwords.
121 * NOTE: This defaults to on, but should be turned off if
122 * you are linking to an older version of inspircd.
124 bool ChallengeResponse;
126 /** Ping frequency of server to server links
130 /** Initialise utility class
132 SpanningTreeUtilities(ModuleSpanningTree* Creator);
134 /** Prepare for class destruction
138 /** Destroy class and free listeners etc
140 ~SpanningTreeUtilities();
142 void RouteCommand(TreeServer*, const std::string&, const parameterlist&, User*);
144 /** Send a message from this server to one other local or remote
146 bool DoOneToOne(const std::string &prefix, const std::string &command, parameterlist ¶ms, std::string target);
148 /** Send a message from this server to all but one other, local or remote
150 bool DoOneToAllButSender(const std::string &prefix, const std::string &command, parameterlist ¶ms, std::string omit);
152 /** Send a message from this server to all but one other, local or remote
154 bool DoOneToAllButSender(const char* prefix, const char* command, parameterlist ¶ms, std::string omit);
156 /** Send a message from this server to all others
158 bool DoOneToMany(const std::string &prefix, const std::string &command, parameterlist ¶ms);
160 /** Send a message from this server to all others
162 bool DoOneToMany(const char* prefix, const char* command, parameterlist ¶ms);
164 /** 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)
166 bool DoOneToAllButSenderRaw(const std::string &data, const std::string &omit, const std::string &prefix, const irc::string &command, parameterlist ¶ms);
168 /** Read the spanningtree module's tags from the config file
170 void ReadConfiguration(bool rebind);
172 /** Add a server to the server list for GetListOfServersForChannel
174 void AddThisServer(TreeServer* server, TreeServerList &list);
176 /** Compile a list of servers which contain members of channel c
178 void GetListOfServersForChannel(Channel* c, TreeServerList &list, char status, const CUList &exempt_list);
180 /** Find a server by name
182 TreeServer* FindServer(const std::string &ServerName);
184 /** Find server by SID
186 TreeServer* FindServerID(const std::string &id);
188 /** Find a route to a server by name
190 TreeServer* BestRouteTo(const std::string &ServerName);
192 /** Find a server by glob mask
194 TreeServer* FindServerMask(const std::string &ServerName);
196 /** Returns true if this is a server name we recognise
198 bool IsServer(const std::string &ServerName);
200 /** Find a link tag from a server name
202 Link* FindLink(const std::string& name);
204 /** Refresh the IP cache used for allowing inbound connections
206 void RefreshIPCache();