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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
|
/*
* InspIRCd -- Internet Relay Chat Daemon
*
* Copyright (C) 2019 linuxdaemon <linuxdaemon.irc@gmail.com>
* Copyright (C) 2018-2020 Sadie Powell <sadie@witchery.services>
*
* 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/>.
*/
#include "inspircd.h"
#include "modules/cap.h"
#include "modules/ctctags.h"
class CommandTagMsg : public Command
{
private:
Cap::Capability& cap;
Events::ModuleEventProvider tagevprov;
ClientProtocol::EventProvider msgevprov;
bool FirePreEvents(User* source, MessageTarget& msgtarget, CTCTags::TagMessageDetails& msgdetails)
{
// Inform modules that a TAGMSG wants to be sent.
ModResult modres;
FIRST_MOD_RESULT_CUSTOM(tagevprov, CTCTags::EventListener, OnUserPreTagMessage, modres, (source, msgtarget, msgdetails));
if (modres == MOD_RES_DENY)
{
// Inform modules that a module blocked the TAGMSG.
FOREACH_MOD_CUSTOM(tagevprov, CTCTags::EventListener, OnUserTagMessageBlocked, (source, msgtarget, msgdetails));
return false;
}
// Check whether a module zapped the message tags.
if (msgdetails.tags_out.empty())
{
source->WriteNumeric(ERR_NOTEXTTOSEND, "No tags to send");
return false;
}
// Inform modules that a TAGMSG is about to be sent.
FOREACH_MOD_CUSTOM(tagevprov, CTCTags::EventListener, OnUserTagMessage, (source, msgtarget, msgdetails));
return true;
}
CmdResult FirePostEvent(User* source, const MessageTarget& msgtarget, const CTCTags::TagMessageDetails& msgdetails)
{
// If the source is local then update its idle time.
LocalUser* lsource = IS_LOCAL(source);
if (lsource && msgdetails.update_idle)
lsource->idle_lastmsg = ServerInstance->Time();
// Inform modules that a TAGMSG was sent.
FOREACH_MOD_CUSTOM(tagevprov, CTCTags::EventListener, OnUserPostTagMessage, (source, msgtarget, msgdetails));
return CMD_SUCCESS;
}
CmdResult HandleChannelTarget(User* source, const Params& parameters, const char* target, PrefixMode* pm)
{
Channel* chan = ServerInstance->FindChan(target);
if (!chan)
{
// The target channel does not exist.
source->WriteNumeric(Numerics::NoSuchChannel(parameters[0]));
return CMD_FAILURE;
}
// Fire the pre-message events.
MessageTarget msgtarget(chan, pm ? pm->GetPrefix() : 0);
CTCTags::TagMessageDetails msgdetails(parameters.GetTags());
if (!FirePreEvents(source, msgtarget, msgdetails))
return CMD_FAILURE;
unsigned int minrank = pm ? pm->GetPrefixRank() : 0;
CTCTags::TagMessage message(source, chan, msgdetails.tags_out, msgtarget.status);
message.SetSideEffect(true);
const Channel::MemberMap& userlist = chan->GetUsers();
for (Channel::MemberMap::const_iterator iter = userlist.begin(); iter != userlist.end(); ++iter)
{
LocalUser* luser = IS_LOCAL(iter->first);
// Don't send to remote users or the user who is the source.
if (!luser || luser == source)
continue;
// Don't send to unprivileged or exempt users.
if (iter->second->getRank() < minrank || msgdetails.exemptions.count(luser))
continue;
// Send to users if they have the capability.
if (cap.get(luser))
luser->Send(msgevprov, message);
}
return FirePostEvent(source, msgtarget, msgdetails);
}
CmdResult HandleServerTarget(User* source, const Params& parameters)
{
// If the source isn't allowed to mass message users then reject
// the attempt to mass-message users.
if (!source->HasPrivPermission("users/mass-message"))
return CMD_FAILURE;
// Extract the server glob match from the target parameter.
std::string servername(parameters[0], 1);
// Fire the pre-message events.
MessageTarget msgtarget(&servername);
CTCTags::TagMessageDetails msgdetails(parameters.GetTags());
if (!FirePreEvents(source, msgtarget, msgdetails))
return CMD_FAILURE;
// If the current server name matches the server name glob then send
// the message out to the local users.
if (InspIRCd::Match(ServerInstance->Config->ServerName, servername))
{
CTCTags::TagMessage message(source, "$*", msgdetails.tags_out);
message.SetSideEffect(true);
const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers();
for (UserManager::LocalList::const_iterator iter = list.begin(); iter != list.end(); ++iter)
{
LocalUser* luser = IS_LOCAL(*iter);
// Don't send to unregistered users or the user who is the source.
if (luser->registered != REG_ALL || luser == source)
continue;
// Don't send to exempt users.
if (msgdetails.exemptions.count(luser))
continue;
// Send to users if they have the capability.
if (cap.get(luser))
luser->Send(msgevprov, message);
}
}
// Fire the post-message event.
return FirePostEvent(source, msgtarget, msgdetails);
}
CmdResult HandleUserTarget(User* source, const Params& parameters)
{
User* target;
if (IS_LOCAL(source))
{
// Local sources can specify either a nick or a nick@server mask as the target.
const char* targetserver = strchr(parameters[0].c_str(), '@');
if (targetserver)
{
// The target is a user on a specific server (e.g. jto@tolsun.oulu.fi).
target = ServerInstance->FindNickOnly(parameters[0].substr(0, targetserver - parameters[0].c_str()));
if (target && strcasecmp(target->server->GetName().c_str(), targetserver + 1))
target = NULL;
}
else
{
// If the source is a local user then we only look up the target by nick.
target = ServerInstance->FindNickOnly(parameters[0]);
}
}
else
{
// Remote users can only specify a nick or UUID as the target.
target = ServerInstance->FindNick(parameters[0]);
}
if (!target || target->registered != REG_ALL)
{
// The target user does not exist or is not fully registered.
source->WriteNumeric(Numerics::NoSuchNick(parameters[0]));
return CMD_FAILURE;
}
// Fire the pre-message events.
MessageTarget msgtarget(target);
CTCTags::TagMessageDetails msgdetails(parameters.GetTags());
if (!FirePreEvents(source, msgtarget, msgdetails))
return CMD_FAILURE;
LocalUser* const localtarget = IS_LOCAL(target);
if (localtarget && cap.get(localtarget))
{
// Send to the target if they have the capability and are a local user.
CTCTags::TagMessage message(source, localtarget, msgdetails.tags_out);
message.SetSideEffect(true);
localtarget->Send(msgevprov, message);
}
// Fire the post-message event.
return FirePostEvent(source, msgtarget, msgdetails);
}
public:
CommandTagMsg(Module* Creator, Cap::Capability& Cap)
: Command(Creator, "TAGMSG", 1)
, cap(Cap)
, tagevprov(Creator, "event/tagmsg")
, msgevprov(Creator, "TAGMSG")
{
allow_empty_last_param = false;
}
CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
{
if (CommandParser::LoopCall(user, this, parameters, 0))
return CMD_SUCCESS;
// Check that the source has the message tags capability.
if (IS_LOCAL(user) && !cap.get(user))
return CMD_FAILURE;
// The specified message tags were empty.
if (parameters.GetTags().empty())
{
user->WriteNumeric(ERR_NOTEXTTOSEND, "No tags to send");
return CMD_FAILURE;
}
// The target is a server glob.
if (parameters[0][0] == '$')
return HandleServerTarget(user, parameters);
// If the message begins with a status character then look it up.
const char* target = parameters[0].c_str();
PrefixMode* pmh = ServerInstance->Modes->FindPrefix(target[0]);
if (pmh)
target++;
// The target is a channel name.
if (*target == '#')
return HandleChannelTarget(user, parameters, target, pmh);
// The target is a nickname.
return HandleUserTarget(user, parameters);
}
RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
{
if (IS_LOCAL(user))
// This is handled by the OnUserPostTagMessage hook to split the LoopCall pieces
return ROUTE_LOCALONLY;
else
return ROUTE_MESSAGE(parameters[0]);
}
};
class C2CTags : public ClientProtocol::MessageTagProvider
{
private:
Cap::Capability& cap;
public:
C2CTags(Module* Creator, Cap::Capability& Cap)
: ClientProtocol::MessageTagProvider(Creator)
, cap(Cap)
{
}
ModResult OnProcessTag(User* user, const std::string& tagname, std::string& tagvalue) CXX11_OVERRIDE
{
// A client-only tag is prefixed with a plus sign (+) and otherwise conforms
// to the format specified in IRCv3.2 tags.
if (tagname[0] != '+' || tagname.length() < 2)
return MOD_RES_PASSTHRU;
// If the user is local then we check whether they have the message-tags cap
// enabled. If not then we reject all client-only tags originating from them.
LocalUser* lu = IS_LOCAL(user);
if (lu && !cap.get(lu))
return MOD_RES_DENY;
// Remote users have their client-only tags checked by their local server.
return MOD_RES_ALLOW;
}
bool ShouldSendTag(LocalUser* user, const ClientProtocol::MessageTagData& tagdata) CXX11_OVERRIDE
{
return cap.get(user);
}
};
class ModuleIRCv3CTCTags
: public Module
, public CTCTags::EventListener
{
private:
Cap::Capability cap;
CommandTagMsg cmd;
C2CTags c2ctags;
ChanModeReference moderatedmode;
ChanModeReference noextmsgmode;
ModResult CopyClientTags(const ClientProtocol::TagMap& tags_in, ClientProtocol::TagMap& tags_out)
{
for (ClientProtocol::TagMap::const_iterator i = tags_in.begin(); i != tags_in.end(); ++i)
{
const ClientProtocol::MessageTagData& tagdata = i->second;
if (tagdata.tagprov == &c2ctags)
tags_out.insert(*i);
}
return MOD_RES_PASSTHRU;
}
public:
ModuleIRCv3CTCTags()
: CTCTags::EventListener(this)
, cap(this, "message-tags")
, cmd(this, cap)
, c2ctags(this, cap)
, moderatedmode(this, "moderated")
, noextmsgmode(this, "noextmsg")
{
}
ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details) CXX11_OVERRIDE
{
return CopyClientTags(details.tags_in, details.tags_out);
}
ModResult OnUserPreTagMessage(User* user, const MessageTarget& target, CTCTags::TagMessageDetails& details) CXX11_OVERRIDE
{
if (IS_LOCAL(user) && target.type == MessageTarget::TYPE_CHANNEL)
{
Channel* chan = target.Get<Channel>();
if (chan->IsModeSet(noextmsgmode) && !chan->HasUser(user))
{
// The noextmsg mode is set and the user is not in the channel.
user->WriteNumeric(Numerics::CannotSendTo(chan, "external messages", *noextmsgmode));
return MOD_RES_DENY;
}
bool no_chan_priv = chan->GetPrefixValue(user) < VOICE_VALUE;
if (no_chan_priv && chan->IsModeSet(moderatedmode))
{
// The moderated mode is set and the user has no status rank.
user->WriteNumeric(Numerics::CannotSendTo(chan, "messages", *noextmsgmode));
return MOD_RES_DENY;
}
if (no_chan_priv && ServerInstance->Config->RestrictBannedUsers != ServerConfig::BUT_NORMAL && chan->IsBanned(user))
{
// The user is banned in the channel and restrictbannedusers is enabled.
if (ServerInstance->Config->RestrictBannedUsers == ServerConfig::BUT_RESTRICT_NOTIFY)
user->WriteNumeric(Numerics::CannotSendTo(chan, "You cannot send messages to this channel whilst banned."));
return MOD_RES_DENY;
}
}
return CopyClientTags(details.tags_in, details.tags_out);
}
Version GetVersion() CXX11_OVERRIDE
{
return Version("Provides the IRCv3 message-tags client capability.", VF_VENDOR | VF_COMMON);
}
};
MODULE_INIT(ModuleIRCv3CTCTags)
|