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/>.
23 #ifndef M_SPANNINGTREE_UTILS_H
24 #define M_SPANNINGTREE_UTILS_H
28 /* Foward declarations */
33 class ModuleSpanningTree;
34 class SpanningTreeUtilities;
36 /* This hash_map holds the hash equivalent of the server
37 * tree, used for rapid linear lookups.
39 typedef std::tr1::unordered_map<std::string, TreeServer*, std::tr1::insensitive, irc::StrHashComp> server_hash;
41 typedef std::map<TreeServer*,TreeServer*> TreeServerList;
43 /** Contains helper functions and variables for this module,
44 * and keeps them out of the global namespace
46 class SpanningTreeUtilities : public classbase
51 ModuleSpanningTree* Creator;
53 /** Flatten links and /MAP for non-opers
56 /** Hide U-Lined servers in /MAP and /LINKS
59 /** Announce TS changes to channels on merge
61 bool AnnounceTSChange;
63 /** Allow modules marked as VF_OPTCOMMON to be mismatched when linking
67 /** Make snomasks +CQ quiet during bursts and splits
71 /* Number of seconds that a server can go without ping
72 * before opers are warned of high latency.
75 /** This variable represents the root of the server tree
78 /** IPs allowed to link to us
80 std::vector<std::string> ValidIPs;
81 /** Hash of currently connected servers by name
83 server_hash serverlist;
84 /** Hash of currently known server ids
87 /** Hash of servers currently bursting but not initialized as connected
89 std::map<irc::string,TreeSocket*> burstingserverlist;
90 /** List of all outgoing sockets and their timeouts
92 std::map<TreeSocket*, std::pair<std::string, int> > timeoutlist;
93 /** Holds the data from the <link> tags in the conf
95 std::vector<reference<Link> > LinkBlocks;
96 /** Holds the data from the <autoconnect> tags in the conf
98 std::vector<reference<Autoconnect> > AutoconnectBlocks;
100 /** True (default) if we are to use challenge-response HMAC
101 * to authenticate passwords.
103 * NOTE: This defaults to on, but should be turned off if
104 * you are linking to an older version of inspircd.
106 bool ChallengeResponse;
108 /** Ping frequency of server to server links
112 /** Initialise utility class
114 SpanningTreeUtilities(ModuleSpanningTree* Creator);
116 /** Prepare for class destruction
120 /** Destroy class and free listeners etc
122 ~SpanningTreeUtilities();
124 void RouteCommand(TreeServer*, const std::string&, const parameterlist&, User*);
126 /** Send a message from this server to one other local or remote
128 bool DoOneToOne(const std::string &prefix, const std::string &command, const parameterlist ¶ms, std::string target);
130 /** Send a message from this server to all but one other, local or remote
132 bool DoOneToAllButSender(const std::string &prefix, const std::string &command, const parameterlist ¶ms, std::string omit);
134 /** Send a message from this server to all but one other, local or remote
136 bool DoOneToAllButSender(const char* prefix, const char* command, const parameterlist ¶ms, std::string omit);
138 /** Send a message from this server to all others
140 bool DoOneToMany(const std::string &prefix, const std::string &command, const parameterlist ¶ms);
142 /** Send a message from this server to all others
144 bool DoOneToMany(const char* prefix, const char* command, const parameterlist ¶ms);
146 /** Read the spanningtree module's tags from the config file
148 void ReadConfiguration();
150 /** Add a server to the server list for GetListOfServersForChannel
152 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);
158 /** Find a server by name
160 TreeServer* FindServer(const std::string &ServerName);
162 /** Find server by SID
164 TreeServer* FindServerID(const std::string &id);
166 /** Find a route to a server by name
168 TreeServer* BestRouteTo(const std::string &ServerName);
170 /** Find a server by glob mask
172 TreeServer* FindServerMask(const std::string &ServerName);
174 /** Find a link tag from a server name
176 Link* FindLink(const std::string& name);
178 /** Refresh the IP cache used for allowing inbound connections
180 void RefreshIPCache();