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/>.
26 #include "cachetimer.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 TR1NS::unordered_map<std::string, TreeServer*, irc::insensitive, irc::StrHashComp> server_hash;
41 typedef std::set<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
48 /** Creates a line in the :<prefix> <command> [<params>] format
50 std::string ConstructLine(const std::string& prefix, const std::string& command, const parameterlist& params);
52 CacheRefreshTimer RefreshTimer;
57 ModuleSpanningTree* Creator;
59 /** Flatten links and /MAP for non-opers
62 /** Hide U-Lined servers in /MAP and /LINKS
65 /** Announce TS changes to channels on merge
67 bool AnnounceTSChange;
69 /** Allow modules marked as VF_OPTCOMMON to be mismatched when linking
73 /** Make snomasks +CQ quiet during bursts and splits
77 /* Number of seconds that a server can go without ping
78 * before opers are warned of high latency.
81 /** This variable represents the root of the server tree
84 /** IPs allowed to link to us
86 std::vector<std::string> ValidIPs;
87 /** Hash of currently connected servers by name
89 server_hash serverlist;
90 /** Hash of currently known server ids
93 /** Hash of servers currently bursting but not initialized as connected
95 std::map<irc::string,TreeSocket*> burstingserverlist;
96 /** List of all outgoing sockets and their timeouts
98 std::map<TreeSocket*, std::pair<std::string, int> > timeoutlist;
99 /** Holds the data from the <link> tags in the conf
101 std::vector<reference<Link> > LinkBlocks;
102 /** Holds the data from the <autoconnect> tags in the conf
104 std::vector<reference<Autoconnect> > AutoconnectBlocks;
106 /** True (default) if we are to use challenge-response HMAC
107 * to authenticate passwords.
109 * NOTE: This defaults to on, but should be turned off if
110 * you are linking to an older version of inspircd.
112 bool ChallengeResponse;
114 /** Ping frequency of server to server links
118 /** Initialise utility class
120 SpanningTreeUtilities(ModuleSpanningTree* Creator);
122 /** Prepare for class destruction
126 /** Destroy class and free listeners etc
128 ~SpanningTreeUtilities();
130 void RouteCommand(TreeServer*, const std::string&, const parameterlist&, User*);
132 /** Send a message from this server to one other local or remote
134 bool DoOneToOne(const std::string& prefix, const std::string& command, const parameterlist& params, const std::string& target);
136 /** Send a message from this server to all but one other, local or remote
138 bool DoOneToAllButSender(const std::string &prefix, const std::string &command, const parameterlist& params, const std::string& omit);
140 /** Send a message from this server to all others
142 bool DoOneToMany(const std::string &prefix, const std::string &command, const parameterlist ¶ms);
144 /** Read the spanningtree module's tags from the config file
146 void ReadConfiguration();
148 /** Compile a list of servers which contain members of channel c
150 void GetListOfServersForChannel(Channel* c, TreeServerList &list, char status, const CUList &exempt_list);
152 /** Find a server by name
154 TreeServer* FindServer(const std::string &ServerName);
156 /** Find server by SID
158 TreeServer* FindServerID(const std::string &id);
160 /** Find a route to a server by name
162 TreeServer* BestRouteTo(const std::string &ServerName);
164 /** Find a server by glob mask
166 TreeServer* FindServerMask(const std::string &ServerName);
168 /** Find a link tag from a server name
170 Link* FindLink(const std::string& name);
172 /** Refresh the IP cache used for allowing inbound connections
174 void RefreshIPCache();
176 /** Sends a PRIVMSG or a NOTICE to a channel obeying an exempt list and an optional prefix
178 void SendChannelMessage(const std::string& prefix, Channel* target, const std::string &text, char status, const CUList& exempt_list, const char* message_type);