2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
6 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
7 * Copyright (C) 2007 Craig Edwards <craigedwards@brainbox.cc>
9 * This file is part of InspIRCd. InspIRCd is free software: you can
10 * redistribute it and/or modify it under the terms of the GNU General Public
11 * License as published by the Free Software Foundation, version 2.
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
27 /* Foward declarations */
32 class ModuleSpanningTree;
33 class SpanningTreeUtilities;
35 /* This hash_map holds the hash equivalent of the server
36 * tree, used for rapid linear lookups.
38 typedef std::tr1::unordered_map<std::string, TreeServer*, std::tr1::insensitive, irc::StrHashComp> server_hash;
40 typedef std::map<TreeServer*,TreeServer*> TreeServerList;
42 /** Contains helper functions and variables for this module,
43 * and keeps them out of the global namespace
45 class SpanningTreeUtilities : public classbase
50 ModuleSpanningTree* Creator;
52 /** Flatten links and /MAP for non-opers
55 /** Hide U-Lined servers in /MAP and /LINKS
58 /** Announce TS changes to channels on merge
60 bool AnnounceTSChange;
62 /** Allow modules marked as VF_OPTCOMMON to be mismatched when linking
66 /** Make snomasks +CQ quiet during bursts and splits
70 /* Number of seconds that a server can go without ping
71 * before opers are warned of high latency.
74 /** This variable represents the root of the server tree
77 /** IPs allowed to link to us
79 std::vector<std::string> ValidIPs;
80 /** Hash of currently connected servers by name
82 server_hash serverlist;
83 /** Hash of currently known server ids
86 /** Hash of servers currently bursting but not initialized as connected
88 std::map<irc::string,TreeSocket*> burstingserverlist;
89 /** List of all outgoing sockets and their timeouts
91 std::map<TreeSocket*, std::pair<std::string, int> > timeoutlist;
92 /** Holds the data from the <link> tags in the conf
94 std::vector<reference<Link> > LinkBlocks;
95 /** Holds the data from the <autoconnect> tags in the conf
97 std::vector<reference<Autoconnect> > AutoconnectBlocks;
99 /** True (default) if we are to use challenge-response HMAC
100 * to authenticate passwords.
102 * NOTE: This defaults to on, but should be turned off if
103 * you are linking to an older version of inspircd.
105 bool ChallengeResponse;
107 /** Ping frequency of server to server links
111 /** Initialise utility class
113 SpanningTreeUtilities(ModuleSpanningTree* Creator);
115 /** Prepare for class destruction
119 /** Destroy class and free listeners etc
121 ~SpanningTreeUtilities();
123 void RouteCommand(TreeServer*, const std::string&, const parameterlist&, User*);
125 /** Send a message from this server to one other local or remote
127 bool DoOneToOne(const std::string &prefix, const std::string &command, const parameterlist ¶ms, std::string target);
129 /** Send a message from this server to all but one other, local or remote
131 bool DoOneToAllButSender(const std::string &prefix, const std::string &command, const parameterlist ¶ms, std::string omit);
133 /** Send a message from this server to all but one other, local or remote
135 bool DoOneToAllButSender(const char* prefix, const char* command, const parameterlist ¶ms, std::string omit);
137 /** Send a message from this server to all others
139 bool DoOneToMany(const std::string &prefix, const std::string &command, const parameterlist ¶ms);
141 /** Send a message from this server to all others
143 bool DoOneToMany(const char* prefix, const char* command, const parameterlist ¶ms);
145 /** Read the spanningtree module's tags from the config file
147 void ReadConfiguration();
149 /** Add a server to the server list for GetListOfServersForChannel
151 void AddThisServer(TreeServer* server, TreeServerList &list);
153 /** Compile a list of servers which contain members of channel c
155 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);
161 /** Find server by SID
163 TreeServer* FindServerID(const std::string &id);
165 /** Find a route to a server by name
167 TreeServer* BestRouteTo(const std::string &ServerName);
169 /** Find a server by glob mask
171 TreeServer* FindServerMask(const std::string &ServerName);
173 /** Find a link tag from a server name
175 Link* FindLink(const std::string& name);
177 /** Refresh the IP cache used for allowing inbound connections
179 void RefreshIPCache();