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 "servercommand.h"
33 #include "protocolinterface.h"
35 /** An enumeration of all known protocol versions.
37 * If you introduce new protocol versions please document them here:
38 * https://docs.inspircd.org/spanningtree/changes
42 /** The linking protocol version introduced in InspIRCd v2.0. */
43 PROTO_INSPIRCD_20 = 1202,
45 /** The linking protocol version introduced in InspIRCd v2.1 alpha 0. */
46 PROTO_INSPIRCD_21_A0 = 1203,
48 /** The linking protocol version introduced in InspIRCd v2.1 beta 2. */
49 PROTO_INSPIRCD_21_B2 = 1204,
51 /** The linking protocol version introduced in InspIRCd v3.0. */
52 PROTO_INSPIRCD_30 = 1205,
54 /** The oldest version of the protocol that we support. */
55 PROTO_OLDEST = PROTO_INSPIRCD_20,
57 /** The newest version of the protocol that we support. */
58 PROTO_NEWEST = PROTO_INSPIRCD_30
61 /** Forward declarations
63 class SpanningTreeUtilities;
64 class CacheRefreshTimer;
69 /** This is the main class for the spanningtree module
71 class ModuleSpanningTree
73 , public Away::EventListener
74 , public Stats::EventListener
76 /** Client to server commands, registered in the core
78 CommandRConnect rconnect;
82 /** Server to server only commands, not registered in the core
84 SpanningTreeCommands commands;
86 /** Next membership id assigned when a local user joins a channel
88 Membership::Id currmembid;
90 /** The specialized ProtocolInterface that is assigned to ServerInstance->PI on load
92 SpanningTreeProtocolInterface protocolinterface;
94 /** Event provider for our events
96 Events::ModuleEventProvider eventprov;
98 /** API for accessing user SSL certificates. */
99 UserCertificateAPI sslapi;
102 dynamic_reference<DNS::Manager> DNS;
104 /** Event provider for message tags. */
105 Events::ModuleEventProvider tagevprov;
107 ServerCommandManager CmdManager;
109 /** Set to true if inside a spanningtree call, to prevent sending
110 * xlines and other things back to their source
116 ModuleSpanningTree();
117 void init() CXX11_OVERRIDE;
121 void ShowLinks(TreeServer* Current, User* user, int hops);
123 /** Handle LINKS command
125 void HandleLinks(const CommandBase::Params& parameters, User* user);
129 ModResult HandleSquit(const CommandBase::Params& parameters, User* user);
131 /** Handle remote WHOIS
133 ModResult HandleRemoteWhois(const CommandBase::Params& parameters, User* user);
135 /** Connect a server locally
137 void ConnectServer(Link* x, Autoconnect* y = NULL);
139 /** Connect the next autoconnect server
141 void ConnectServer(Autoconnect* y, bool on_timer);
143 /** Check if any servers are due to be autoconnected
145 void AutoConnectServers(time_t curtime);
147 /** Check if any connecting servers should timeout
149 void DoConnectTimeout(time_t curtime);
151 /** Handle remote VERSON
153 ModResult HandleVersion(const CommandBase::Params& parameters, User* user);
157 ModResult HandleConnect(const CommandBase::Params& parameters, User* user);
159 const Events::ModuleEventProvider& GetEventProvider() const { return eventprov; }
162 ** *** MODULE EVENTS ***
165 ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE;
166 void OnPostCommand(Command*, const CommandBase::Params& parameters, LocalUser* user, CmdResult result, bool loop) CXX11_OVERRIDE;
167 void OnUserConnect(LocalUser* source) CXX11_OVERRIDE;
168 void OnUserInvite(User* source, User* dest, Channel* channel, time_t timeout, unsigned int notifyrank, CUList& notifyexcepts) CXX11_OVERRIDE;
169 ModResult OnPreTopicChange(User* user, Channel* chan, const std::string& topic) CXX11_OVERRIDE;
170 void OnPostTopicChange(User* user, Channel* chan, const std::string &topic) CXX11_OVERRIDE;
171 void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details) CXX11_OVERRIDE;
172 void OnBackgroundTimer(time_t curtime) CXX11_OVERRIDE;
173 void OnUserJoin(Membership* memb, bool sync, bool created, CUList& excepts) CXX11_OVERRIDE;
174 void OnChangeHost(User* user, const std::string &newhost) CXX11_OVERRIDE;
175 void OnChangeRealName(User* user, const std::string& real) CXX11_OVERRIDE;
176 void OnChangeIdent(User* user, const std::string &ident) CXX11_OVERRIDE;
177 void OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts) CXX11_OVERRIDE;
178 void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message) CXX11_OVERRIDE;
179 void OnUserPostNick(User* user, const std::string &oldnick) CXX11_OVERRIDE;
180 void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts) CXX11_OVERRIDE;
181 void OnPreRehash(User* user, const std::string ¶meter) CXX11_OVERRIDE;
182 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE;
183 void OnOper(User* user, const std::string &opertype) CXX11_OVERRIDE;
184 void OnAddLine(User *u, XLine *x) CXX11_OVERRIDE;
185 void OnDelLine(User *u, XLine *x) CXX11_OVERRIDE;
186 ModResult OnStats(Stats::Context& stats) CXX11_OVERRIDE;
187 void OnUserAway(User* user) CXX11_OVERRIDE;
188 void OnUserBack(User* user) CXX11_OVERRIDE;
189 void OnLoadModule(Module* mod) CXX11_OVERRIDE;
190 void OnUnloadModule(Module* mod) CXX11_OVERRIDE;
191 ModResult OnAcceptConnection(int newsock, ListenSocket* from, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE;
192 void OnMode(User* source, User* u, Channel* c, const Modes::ChangeList& modes, ModeParser::ModeProcessFlag processflags) CXX11_OVERRIDE;
193 CullResult cull() CXX11_OVERRIDE;
194 ~ModuleSpanningTree();
195 Version GetVersion() CXX11_OVERRIDE;
196 void Prioritize() CXX11_OVERRIDE;