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
|
/*
* InspIRCd -- Internet Relay Chat Daemon
*
* Copyright (C) 2015 Attila Molnar <attilamolnar@hush.com>
*
* 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/reload.h"
class CapNotify : public Cap::Capability
{
bool OnRequest(LocalUser* user, bool add) CXX11_OVERRIDE
{
// Users using the negotiation protocol v3.2 or newer may not turn off cap-notify
if ((!add) && (GetProtocol(user) != Cap::CAP_LEGACY))
return false;
return true;
}
bool OnList(LocalUser* user) CXX11_OVERRIDE
{
// If the client supports 3.2 enable cap-notify for them
if (GetProtocol(user) != Cap::CAP_LEGACY)
set(user, true);
return true;
}
public:
CapNotify(Module* mod)
: Cap::Capability(mod, "cap-notify")
{
}
};
class CapNotifyMessage : public Cap::MessageBase
{
public:
CapNotifyMessage(bool add, const std::string& capname)
: Cap::MessageBase((add ? "NEW" : "DEL"))
{
PushParamRef(capname);
}
};
class CapNotifyValueMessage : public Cap::MessageBase
{
std::string s;
const std::string::size_type pos;
public:
CapNotifyValueMessage(const std::string& capname)
: Cap::MessageBase("NEW")
, s(capname)
, pos(s.size()+1)
{
s.push_back('=');
PushParamRef(s);
}
void SetCapValue(const std::string& capvalue)
{
s.erase(pos);
s.append(capvalue);
InvalidateCache();
}
};
class ModuleIRCv3CapNotify : public Module, public Cap::EventListener, public ReloadModule::EventListener
{
CapNotify capnotify;
std::string reloadedmod;
std::vector<std::string> reloadedcaps;
ClientProtocol::EventProvider protoev;
void Send(const std::string& capname, Cap::Capability* cap, bool add)
{
CapNotifyMessage msg(add, capname);
CapNotifyValueMessage msgwithval(capname);
ClientProtocol::Event event(protoev, msg);
ClientProtocol::Event eventwithval(protoev, msgwithval);
const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers();
for (UserManager::LocalList::const_iterator i = list.begin(); i != list.end(); ++i)
{
LocalUser* user = *i;
if (!capnotify.get(user))
continue;
// Check that this user can actually see the cap.
if (!cap->OnList(user))
continue;
// If the cap is being added and the client supports cap values then show the value, if any
if ((add) && (capnotify.GetProtocol(user) != Cap::CAP_LEGACY))
{
const std::string* capvalue = cap->GetValue(user);
if ((capvalue) && (!capvalue->empty()))
{
msgwithval.SetUser(user);
msgwithval.SetCapValue(*capvalue);
user->Send(eventwithval);
continue;
}
}
msg.SetUser(user);
user->Send(event);
}
}
public:
ModuleIRCv3CapNotify()
: Cap::EventListener(this)
, ReloadModule::EventListener(this)
, capnotify(this)
, protoev(this, "CAP_NOTIFY")
{
}
void OnCapAddDel(Cap::Capability* cap, bool add) CXX11_OVERRIDE
{
if (cap->creator == this)
return;
if (cap->creator->ModuleSourceFile == reloadedmod)
{
if (!add)
reloadedcaps.push_back(cap->GetName());
return;
}
Send(cap->GetName(), cap, add);
}
void OnCapValueChange(Cap::Capability* cap) CXX11_OVERRIDE
{
// The value of a cap has changed, send CAP DEL and CAP NEW with the new value
Send(cap->GetName(), cap, false);
Send(cap->GetName(), cap, true);
}
void OnReloadModuleSave(Module* mod, ReloadModule::CustomData& cd) CXX11_OVERRIDE
{
if (mod == this)
return;
reloadedmod = mod->ModuleSourceFile;
// Request callback when reload is complete
cd.add(this, NULL);
}
void OnReloadModuleRestore(Module* mod, void* data) CXX11_OVERRIDE
{
// Reloading can change the set of caps provided by a module so assuming that if the reload succeded all
// caps that the module previously provided are available or all were lost if the reload failed is wrong.
// Instead, we verify the availability of each cap individually.
dynamic_reference_nocheck<Cap::Manager> capmanager(this, "capmanager");
if (capmanager)
{
for (std::vector<std::string>::const_iterator i = reloadedcaps.begin(); i != reloadedcaps.end(); ++i)
{
const std::string& capname = *i;
if (!capmanager->Find(capname))
Send(capname, NULL, false);
}
}
reloadedmod.clear();
reloadedcaps.clear();
}
Version GetVersion() CXX11_OVERRIDE
{
return Version("Provides the cap-notify IRCv3 extension", VF_VENDOR);
}
};
MODULE_INIT(ModuleIRCv3CapNotify)
|
