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
|
/*
* Copyright (C) 2004-2025 ZNC, see the NOTICE file for details.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include <znc/User.h>
#include <znc/znc.h>
using std::set;
class CClientNotifyMod : public CModule {
protected:
CString m_sMethod;
bool m_bNewOnly{};
bool m_bOnDisconnect{};
bool m_bNotifyOnNewIP{};
bool m_bNotifyOnNewClientID{};
set<CString> m_sClientsSeenIP;
set<CString> m_sClientsSeenID;
void SaveSettings() {
SetNV("method", m_sMethod);
SetNV("newonly", m_bNewOnly ? "1" : "0");
SetNV("notifyonnewip", m_bNotifyOnNewIP ? "1" : "0");
SetNV("notifyonnewclientid", m_bNotifyOnNewClientID ? "1" : "0");
SetNV("ondisconnect", m_bOnDisconnect ? "1" : "0");
}
void SendNotification(const CString& sMessage) {
if (m_sMethod == "message") {
GetUser()->PutStatus(sMessage, nullptr, GetClient());
} else if (m_sMethod == "notice") {
GetUser()->PutStatusNotice(sMessage, nullptr, GetClient());
}
}
public:
MODCONSTRUCTOR(CClientNotifyMod) {
AddHelpCommand();
AddCommand("Method", t_d("<message|notice|off>"),
t_d("Sets the notify method"),
[=](const CString& sLine) { OnMethodCommand(sLine); });
AddCommand("NewOnly", t_d("<on|off>"),
t_d("Turns notifications for unseen connections on or off"),
[=](const CString& sLine) { OnNewOnlyCommand(sLine); });
AddCommand("NotifyOnNewIP", t_d("<on|off>"),
t_d("Specifies whether you want to be notified about new "
"connections with new IPs"),
[=](const CString& sLine) { OnNotifyOnNewIP(sLine); });
AddCommand("NotifyOnNewID", t_d("<on|off>"),
t_d("Specifies whether you want to be notified about new "
"connections with new client IDs"),
[=](const CString& sLine) { OnNotifyOnNewID(sLine); });
AddCommand(
"OnDisconnect", t_d("<on|off>"),
t_d("Turns notifications for clients disconnecting on or off"),
[=](const CString& sLine) { OnDisconnectCommand(sLine); });
AddCommand("Show", "", t_d("Shows the current settings"),
[=](const CString& sLine) { OnShowCommand(sLine); });
}
bool OnLoad(const CString& sArgs, CString& sMessage) override {
m_sMethod = GetNV("method");
if (m_sMethod != "notice" && m_sMethod != "message" &&
m_sMethod != "off") {
m_sMethod = "message";
}
// default = off for these:
m_bNotifyOnNewIP = (GetNV("notifyonnewip") == "1");
m_bNotifyOnNewClientID = (GetNV("notifyonnewclientid") == "1");
m_bNewOnly = (GetNV("newonly") == "1");
m_bOnDisconnect = (GetNV("ondisconnect") == "1");
return true;
}
void OnClientLogin() override {
CString sRemoteIP = GetClient()->GetRemoteIP();
CString sRemoteClientID = GetClient()->GetIdentifier();
CString sClientNameMessage{sRemoteIP};
if (m_bNotifyOnNewClientID && sRemoteClientID != "") {
sClientNameMessage += " / " + sRemoteClientID;
}
auto sendLoginNotification = [&]() {
SendNotification(
t_p("<This message is impossible for 1 client>",
"Another client ({1}) authenticated as your user. "
"Use the 'ListClients' command to see all {2} "
"clients.",
GetUser()->GetAllClients().size())(
sClientNameMessage, GetUser()->GetAllClients().size()));
};
if (m_bNewOnly) {
// see if we actually got a new client
// TODO: replace setName.find(...) == setName.end() with
// !setName.contains() once ZNC uses C++20
if ((m_bNotifyOnNewIP && (m_sClientsSeenIP.find(sRemoteIP) ==
m_sClientsSeenIP.end())) ||
(m_bNotifyOnNewClientID &&
(m_sClientsSeenID.find(sRemoteClientID) ==
m_sClientsSeenID.end()))) {
sendLoginNotification();
}
} else {
sendLoginNotification();
}
// the set<> will automatically disregard duplicates:
m_sClientsSeenIP.insert(sRemoteIP);
m_sClientsSeenID.insert(sRemoteClientID);
}
void OnClientDisconnect() override {
if (m_bOnDisconnect) {
SendNotification(t_p("<This message is impossible for 1 client>",
"A client disconnected from your user. Use "
"the 'ListClients' command to see the {1} "
"remaining clients.",
GetUser()->GetAllClients().size())(
GetUser()->GetAllClients().size()));
}
}
void OnMethodCommand(const CString& sCommand) {
const CString sArg = sCommand.Token(1, true).AsLower();
if (sArg != "notice" && sArg != "message" && sArg != "off") {
PutModule(t_s("Usage: Method <message|notice|off>"));
return;
}
m_sMethod = sArg;
SaveSettings();
PutModule(t_s("Saved."));
}
void OnNewOnlyCommand(const CString& sCommand) {
const CString sArg = sCommand.Token(1, true).AsLower();
if (sArg.empty()) {
PutModule(t_s("Usage: NewOnly <on|off>"));
return;
}
m_bNewOnly = sArg.ToBool();
SaveSettings();
PutModule(t_s("Saved."));
}
void OnNotifyOnNewIP(const CString& sCommand) {
const CString sArg = sCommand.Token(1, true).AsLower();
if (sArg.empty()) {
PutModule(t_s("Usage: NotifyOnNewIP <on|off>"));
return;
}
m_bNotifyOnNewIP = sArg.ToBool();
SaveSettings();
PutModule(t_s("Saved."));
}
void OnNotifyOnNewID(const CString& sCommand) {
const CString sArg = sCommand.Token(1, true).AsLower();
if (sArg.empty()) {
PutModule(t_s("Usage: NotifyOnNewID <on|off>"));
return;
}
m_bNotifyOnNewClientID = sArg.ToBool();
SaveSettings();
PutModule(t_s("Saved."));
}
void OnDisconnectCommand(const CString& sCommand) {
const CString sArg = sCommand.Token(1, true).AsLower();
if (sArg.empty()) {
PutModule(t_s("Usage: OnDisconnect <on|off>"));
return;
}
m_bOnDisconnect = sArg.ToBool();
SaveSettings();
PutModule(t_s("Saved."));
}
void OnShowCommand(const CString& sLine) {
PutModule(
t_f("Current settings: Method: {1}, for unseen only: {2}, notify"
"for unseen IPs: {3}, notify for unseen IDs: {4}, notify on"
"disconnecting clients: {5}")(
m_sMethod, m_bNewOnly, m_bNotifyOnNewIP, m_bNotifyOnNewClientID,
m_bOnDisconnect));
}
};
template <>
void TModInfo<CClientNotifyMod>(CModInfo& Info) {
Info.SetWikiPage("clientnotify");
}
USERMODULEDEFS(CClientNotifyMod,
t_s("Notifies you when another IRC client logs into or out of "
"your account. Configurable."))
|
