1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
/*
* InspIRCd -- Internet Relay Chat Daemon
*
* Copyright (C) 2019 linuxdaemon <linuxdaemon.irc@gmail.com>
* Copyright (C) 2013-2016, 2018 Attila Molnar <attilamolnar@hush.com>
* Copyright (C) 2013, 2017-2020 Sadie Powell <sadie@witchery.services>
* Copyright (C) 2013 Adam <Adam@anope.org>
* Copyright (C) 2012 Robby <robby@chatbelgie.be>
* Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
* Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
* Copyright (C) 2007-2008 Dennis Friis <peavey@inspircd.org>
* Copyright (C) 2007, 2009-2010 Craig Edwards <brain@inspircd.org>
* Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
*
* This file is part of InspIRCd. InspIRCd is free software: you can
* redistribute it and/or modify it under the terms of the GNU General Public
* License as published by the Free Software Foundation, version 2.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
#include "inspircd.h"
#include "event.h"
#include "modules/dns.h"
#include "modules/ssl.h"
#include "modules/stats.h"
#include "modules/ctctags.h"
#include "modules/server.h"
#include "servercommand.h"
#include "commands.h"
#include "protocolinterface.h"
#include "tags.h"
/** An enumeration of all known protocol versions.
*
* If you introduce new protocol versions please document them here:
* https://docs.inspircd.org/spanningtree/changes
*/
enum ProtocolVersion
{
/** The linking protocol version introduced in InspIRCd v2.0. */
PROTO_INSPIRCD_20 = 1202,
/** The linking protocol version introduced in InspIRCd v2.1 alpha 0. */
PROTO_INSPIRCD_21_A0 = 1203,
/** The linking protocol version introduced in InspIRCd v2.1 beta 2. */
PROTO_INSPIRCD_21_B2 = 1204,
/** The linking protocol version introduced in InspIRCd v3.0. */
PROTO_INSPIRCD_30 = 1205,
/** The oldest version of the protocol that we support. */
PROTO_OLDEST = PROTO_INSPIRCD_20,
/** The newest version of the protocol that we support. */
PROTO_NEWEST = PROTO_INSPIRCD_30
};
/** Forward declarations
*/
class SpanningTreeUtilities;
class CacheRefreshTimer;
class TreeServer;
class Link;
class Autoconnect;
/** This is the main class for the spanningtree module
*/
class ModuleSpanningTree
: public Module
, public Away::EventListener
, public Stats::EventListener
, public CTCTags::EventListener
{
/** Client to server commands, registered in the core
*/
CommandRConnect rconnect;
CommandRSQuit rsquit;
CommandMap map;
/** Server to server only commands, not registered in the core
*/
SpanningTreeCommands commands;
/** Next membership id assigned when a local user joins a channel
*/
Membership::Id currmembid;
/** The specialized ProtocolInterface that is assigned to ServerInstance->PI on load
*/
SpanningTreeProtocolInterface protocolinterface;
/** Event provider for our broadcast events. */
Events::ModuleEventProvider broadcasteventprov;
/** Event provider for our link events. */
Events::ModuleEventProvider linkeventprov;
/** Event provider for our message events. */
Events::ModuleEventProvider messageeventprov;
/** Event provider for our sync events. */
Events::ModuleEventProvider synceventprov;
/** API for accessing user SSL certificates. */
UserCertificateAPI sslapi;
/** Tag for marking services pseudoclients. */
ServiceTag servicetag;
public:
dynamic_reference<DNS::Manager> DNS;
/** Event provider for message tags. */
ClientProtocol::MessageTagEvent tagevprov;
ServerCommandManager CmdManager;
/** Set to true if inside a spanningtree call, to prevent sending
* xlines and other things back to their source
*/
bool loopCall;
/** Constructor
*/
ModuleSpanningTree();
void init() CXX11_OVERRIDE;
/** Shows /LINKS
*/
void ShowLinks(TreeServer* Current, User* user, int hops);
/** Handle LINKS command
*/
void HandleLinks(const CommandBase::Params& parameters, User* user);
/** Handle SQUIT
*/
ModResult HandleSquit(const CommandBase::Params& parameters, User* user);
/** Handle remote WHOIS
*/
ModResult HandleRemoteWhois(const CommandBase::Params& parameters, User* user);
/** Connect a server locally
*/
void ConnectServer(Link* x, Autoconnect* y = NULL);
/** Connect the next autoconnect server
*/
void ConnectServer(Autoconnect* y, bool on_timer);
/** Check if any servers are due to be autoconnected
*/
void AutoConnectServers(time_t curtime);
/** Check if any connecting servers should timeout
*/
void DoConnectTimeout(time_t curtime);
/** Handle remote VERSION
*/
ModResult HandleVersion(const CommandBase::Params& parameters, User* user);
/** Handle CONNECT
*/
ModResult HandleConnect(const CommandBase::Params& parameters, User* user);
/** Retrieves the event provider for broadcast events. */
const Events::ModuleEventProvider& GetBroadcastEventProvider() const { return broadcasteventprov; }
/** Retrieves the event provider for link events. */
const Events::ModuleEventProvider& GetLinkEventProvider() const { return linkeventprov; }
/** Retrieves the event provider for message events. */
const Events::ModuleEventProvider& GetMessageEventProvider() const { return messageeventprov; }
/** Retrieves the event provider for sync events. */
const Events::ModuleEventProvider& GetSyncEventProvider() const { return synceventprov; }
/**
** *** MODULE EVENTS ***
**/
ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE;
void OnPostCommand(Command*, const CommandBase::Params& parameters, LocalUser* user, CmdResult result, bool loop) CXX11_OVERRIDE;
void OnUserConnect(LocalUser* source) CXX11_OVERRIDE;
void OnUserInvite(User* source, User* dest, Channel* channel, time_t timeout, unsigned int notifyrank, CUList& notifyexcepts) CXX11_OVERRIDE;
ModResult OnPreTopicChange(User* user, Channel* chan, const std::string& topic) CXX11_OVERRIDE;
void OnPostTopicChange(User* user, Channel* chan, const std::string &topic) CXX11_OVERRIDE;
void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details) CXX11_OVERRIDE;
void OnUserPostTagMessage(User* user, const MessageTarget& target, const CTCTags::TagMessageDetails& details) CXX11_OVERRIDE;
void OnBackgroundTimer(time_t curtime) CXX11_OVERRIDE;
void OnUserJoin(Membership* memb, bool sync, bool created, CUList& excepts) CXX11_OVERRIDE;
void OnChangeHost(User* user, const std::string &newhost) CXX11_OVERRIDE;
void OnChangeRealName(User* user, const std::string& real) CXX11_OVERRIDE;
void OnChangeIdent(User* user, const std::string &ident) CXX11_OVERRIDE;
void OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts) CXX11_OVERRIDE;
void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message) CXX11_OVERRIDE;
void OnUserPostNick(User* user, const std::string &oldnick) CXX11_OVERRIDE;
void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts) CXX11_OVERRIDE;
void OnPreRehash(User* user, const std::string ¶meter) CXX11_OVERRIDE;
void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE;
void OnOper(User* user, const std::string &opertype) CXX11_OVERRIDE;
void OnAddLine(User *u, XLine *x) CXX11_OVERRIDE;
void OnDelLine(User *u, XLine *x) CXX11_OVERRIDE;
ModResult OnStats(Stats::Context& stats) CXX11_OVERRIDE;
void OnUserAway(User* user) CXX11_OVERRIDE;
void OnUserBack(User* user) CXX11_OVERRIDE;
void OnLoadModule(Module* mod) CXX11_OVERRIDE;
void OnUnloadModule(Module* mod) CXX11_OVERRIDE;
ModResult OnAcceptConnection(int newsock, ListenSocket* from, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE;
void OnMode(User* source, User* u, Channel* c, const Modes::ChangeList& modes, ModeParser::ModeProcessFlag processflags) CXX11_OVERRIDE;
void OnShutdown(const std::string& reason) CXX11_OVERRIDE;
CullResult cull() CXX11_OVERRIDE;
~ModuleSpanningTree();
Version GetVersion() CXX11_OVERRIDE;
void Prioritize() CXX11_OVERRIDE;
};
|
