2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
6 * Copyright (C) 2007-2008 Craig Edwards <craigedwards@brainbox.cc>
7 * Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
8 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
10 * This file is part of InspIRCd. InspIRCd is free software: you can
11 * redistribute it and/or modify it under the terms of the GNU General Public
12 * License as published by the Free Software Foundation, version 2.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
28 #include "modules/dns.h"
29 #include "modules/ssl.h"
30 #include "modules/stats.h"
31 #include "modules/ctctags.h"
32 #include "servercommand.h"
34 #include "protocolinterface.h"
36 /** An enumeration of all known protocol versions.
38 * If you introduce new protocol versions please document them here:
39 * https://docs.inspircd.org/spanningtree/changes
43 /** The linking protocol version introduced in InspIRCd v2.0. */
44 PROTO_INSPIRCD_20 = 1202,
46 /** The linking protocol version introduced in InspIRCd v2.1 alpha 0. */
47 PROTO_INSPIRCD_21_A0 = 1203,
49 /** The linking protocol version introduced in InspIRCd v2.1 beta 2. */
50 PROTO_INSPIRCD_21_B2 = 1204,
52 /** The linking protocol version introduced in InspIRCd v3.0. */
53 PROTO_INSPIRCD_30 = 1205,
55 /** The oldest version of the protocol that we support. */
56 PROTO_OLDEST = PROTO_INSPIRCD_20,
58 /** The newest version of the protocol that we support. */
59 PROTO_NEWEST = PROTO_INSPIRCD_30
62 /** Forward declarations
64 class SpanningTreeUtilities;
65 class CacheRefreshTimer;
70 /** This is the main class for the spanningtree module
72 class ModuleSpanningTree
74 , public Away::EventListener
75 , public Stats::EventListener
76 , public CTCTags::EventListener
78 /** Client to server commands, registered in the core
80 CommandRConnect rconnect;
84 /** Server to server only commands, not registered in the core
86 SpanningTreeCommands commands;
88 /** Next membership id assigned when a local user joins a channel
90 Membership::Id currmembid;
92 /** The specialized ProtocolInterface that is assigned to ServerInstance->PI on load
94 SpanningTreeProtocolInterface protocolinterface;
96 /** Event provider for our broadcast events. */
97 Events::ModuleEventProvider broadcasteventprov;
99 /** Event provider for our link events. */
100 Events::ModuleEventProvider linkeventprov;
102 /** Event provider for our sync events. */
103 Events::ModuleEventProvider synceventprov;
105 /** API for accessing user SSL certificates. */
106 UserCertificateAPI sslapi;
109 dynamic_reference<DNS::Manager> DNS;
111 /** Event provider for message tags. */
112 Events::ModuleEventProvider tagevprov;
114 ServerCommandManager CmdManager;
116 /** Set to true if inside a spanningtree call, to prevent sending
117 * xlines and other things back to their source
123 ModuleSpanningTree();
124 void init() CXX11_OVERRIDE;
128 void ShowLinks(TreeServer* Current, User* user, int hops);
130 /** Handle LINKS command
132 void HandleLinks(const CommandBase::Params& parameters, User* user);
136 ModResult HandleSquit(const CommandBase::Params& parameters, User* user);
138 /** Handle remote WHOIS
140 ModResult HandleRemoteWhois(const CommandBase::Params& parameters, User* user);
142 /** Connect a server locally
144 void ConnectServer(Link* x, Autoconnect* y = NULL);
146 /** Connect the next autoconnect server
148 void ConnectServer(Autoconnect* y, bool on_timer);
150 /** Check if any servers are due to be autoconnected
152 void AutoConnectServers(time_t curtime);
154 /** Check if any connecting servers should timeout
156 void DoConnectTimeout(time_t curtime);
158 /** Handle remote VERSON
160 ModResult HandleVersion(const CommandBase::Params& parameters, User* user);
164 ModResult HandleConnect(const CommandBase::Params& parameters, User* user);
166 /** Retrieves the event provider for broadcast events. */
167 const Events::ModuleEventProvider& GetBroadcastEventProvider() const { return broadcasteventprov; }
169 /** Retrieves the event provider for link events. */
170 const Events::ModuleEventProvider& GetLinkEventProvider() const { return linkeventprov; }
172 /** Retrieves the event provider for sync events. */
173 const Events::ModuleEventProvider& GetSyncEventProvider() const { return synceventprov; }
176 ** *** MODULE EVENTS ***
179 ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE;
180 void OnPostCommand(Command*, const CommandBase::Params& parameters, LocalUser* user, CmdResult result, bool loop) CXX11_OVERRIDE;
181 void OnUserConnect(LocalUser* source) CXX11_OVERRIDE;
182 void OnUserInvite(User* source, User* dest, Channel* channel, time_t timeout, unsigned int notifyrank, CUList& notifyexcepts) CXX11_OVERRIDE;
183 ModResult OnPreTopicChange(User* user, Channel* chan, const std::string& topic) CXX11_OVERRIDE;
184 void OnPostTopicChange(User* user, Channel* chan, const std::string &topic) CXX11_OVERRIDE;
185 void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details) CXX11_OVERRIDE;
186 void OnUserPostTagMessage(User* user, const MessageTarget& target, const CTCTags::TagMessageDetails& details) CXX11_OVERRIDE;
187 void OnBackgroundTimer(time_t curtime) CXX11_OVERRIDE;
188 void OnUserJoin(Membership* memb, bool sync, bool created, CUList& excepts) CXX11_OVERRIDE;
189 void OnChangeHost(User* user, const std::string &newhost) CXX11_OVERRIDE;
190 void OnChangeRealName(User* user, const std::string& real) CXX11_OVERRIDE;
191 void OnChangeIdent(User* user, const std::string &ident) CXX11_OVERRIDE;
192 void OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts) CXX11_OVERRIDE;
193 void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message) CXX11_OVERRIDE;
194 void OnUserPostNick(User* user, const std::string &oldnick) CXX11_OVERRIDE;
195 void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts) CXX11_OVERRIDE;
196 void OnPreRehash(User* user, const std::string ¶meter) CXX11_OVERRIDE;
197 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE;
198 void OnOper(User* user, const std::string &opertype) CXX11_OVERRIDE;
199 void OnAddLine(User *u, XLine *x) CXX11_OVERRIDE;
200 void OnDelLine(User *u, XLine *x) CXX11_OVERRIDE;
201 ModResult OnStats(Stats::Context& stats) CXX11_OVERRIDE;
202 void OnUserAway(User* user) CXX11_OVERRIDE;
203 void OnUserBack(User* user) CXX11_OVERRIDE;
204 void OnLoadModule(Module* mod) CXX11_OVERRIDE;
205 void OnUnloadModule(Module* mod) CXX11_OVERRIDE;
206 ModResult OnAcceptConnection(int newsock, ListenSocket* from, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE;
207 void OnMode(User* source, User* u, Channel* c, const Modes::ChangeList& modes, ModeParser::ModeProcessFlag processflags) CXX11_OVERRIDE;
208 CullResult cull() CXX11_OVERRIDE;
209 ~ModuleSpanningTree();
210 Version GetVersion() CXX11_OVERRIDE;
211 void Prioritize() CXX11_OVERRIDE;