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 extern SpanningTreeUtilities* Utils;
38 /* This hash_map holds the hash equivalent of the server
39 * tree, used for rapid linear lookups.
41 typedef TR1NS::unordered_map<std::string, TreeServer*, irc::insensitive, irc::StrHashComp> server_hash;
43 typedef std::set<TreeServer*> TreeServerList;
45 /** Contains helper functions and variables for this module,
46 * and keeps them out of the global namespace
48 class SpanningTreeUtilities : public classbase
50 /** Creates a line in the :<prefix> <command> [<params>] format
52 std::string ConstructLine(const std::string& prefix, const std::string& command, const parameterlist& params);
54 CacheRefreshTimer RefreshTimer;
59 ModuleSpanningTree* Creator;
61 /** Flatten links and /MAP for non-opers
64 /** Hide U-Lined servers in /MAP and /LINKS
67 /** Announce TS changes to channels on merge
69 bool AnnounceTSChange;
71 /** Allow modules marked as VF_OPTCOMMON to be mismatched when linking
75 /** Make snomasks +CQ quiet during bursts and splits
79 /* Number of seconds that a server can go without ping
80 * before opers are warned of high latency.
83 /** This variable represents the root of the server tree
86 /** IPs allowed to link to us
88 std::vector<std::string> ValidIPs;
89 /** Hash of currently connected servers by name
91 server_hash serverlist;
92 /** Hash of currently known server ids
95 /** List of all outgoing sockets and their timeouts
97 std::map<TreeSocket*, std::pair<std::string, int> > timeoutlist;
98 /** Holds the data from the <link> tags in the conf
100 std::vector<reference<Link> > LinkBlocks;
101 /** Holds the data from the <autoconnect> tags in the conf
103 std::vector<reference<Autoconnect> > AutoconnectBlocks;
105 /** True (default) if we are to use challenge-response HMAC
106 * to authenticate passwords.
108 * NOTE: This defaults to on, but should be turned off if
109 * you are linking to an older version of inspircd.
111 bool ChallengeResponse;
113 /** Ping frequency of server to server links
117 /** Initialise utility class
119 SpanningTreeUtilities(ModuleSpanningTree* Creator);
121 /** Prepare for class destruction
125 /** Destroy class and free listeners etc
127 ~SpanningTreeUtilities();
129 void RouteCommand(TreeServer* origin, CommandBase* cmd, const parameterlist& parameters, User* user);
131 /** Send a message from this server to one other local or remote
133 bool DoOneToOne(const std::string& prefix, const std::string& command, const parameterlist& params, const std::string& target);
135 /** Send a message from this server to all but one other, local or remote
137 bool DoOneToAllButSender(const std::string &prefix, const std::string &command, const parameterlist& params, const std::string& omit);
139 /** Send a message from this server to all others
141 bool DoOneToMany(const std::string &prefix, const std::string &command, const parameterlist ¶ms);
143 /** Read the spanningtree module's tags from the config file
145 void ReadConfiguration();
147 /** Handle nick collision
149 int DoCollision(User* u, TreeServer* server, time_t remotets, const std::string& remoteident, const std::string& remoteip, const std::string& remoteuid);
151 /** Compile a list of servers which contain members of channel c
153 void GetListOfServersForChannel(Channel* c, TreeServerList &list, char status, const CUList &exempt_list);
155 /** Find a server by name
157 TreeServer* FindServer(const std::string &ServerName);
159 /** Find server by SID
161 TreeServer* FindServerID(const std::string &id);
163 /** Find a route to a server by name
165 TreeServer* BestRouteTo(const std::string &ServerName);
167 /** Find a server by glob mask
169 TreeServer* FindServerMask(const std::string &ServerName);
171 /** Find a link tag from a server name
173 Link* FindLink(const std::string& name);
175 /** Refresh the IP cache used for allowing inbound connections
177 void RefreshIPCache();
179 /** Sends a PRIVMSG or a NOTICE to a channel obeying an exempt list and an optional prefix
181 void SendChannelMessage(const std::string& prefix, Channel* target, const std::string &text, char status, const CUList& exempt_list, const char* message_type);