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
|
/*
* InspIRCd -- Internet Relay Chat Daemon
*
* Copyright (C) 2019 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/>.
*/
// IMPORTANT: The contents of this file are experimental and are not presently
// covered by the InspIRCd API stability guarantee.
#pragma once
#include "modules/cap.h"
namespace IRCv3
{
namespace Replies
{
class Reply;
class Fail;
class Note;
class Warn;
}
}
/** Base class for standard replies. */
class IRCv3::Replies::Reply
{
private:
/** The name of the command for this reply. */
std::string cmd;
/** The event provider for this reply. */
ClientProtocol::EventProvider evprov;
/** Wraps a message in an event and sends it to a user.
* @param user The user to send the message to.
* @param msg The message to send to the user.
*/
void SendInternal(LocalUser* user, ClientProtocol::Message& msg)
{
ClientProtocol::Event ev(evprov, msg);
user->Send(ev);
}
protected:
/** Initializes a new instance of the Reply class.
* @param Creator The module which created this instance.
* @param Cmd The name of the command to reply with.
*/
Reply(Module* Creator, const std::string& Cmd)
: cmd(Cmd)
, evprov(Creator, Cmd)
{
}
public:
/**
* Sends a standard reply to the specified user.
* @param user The user to send the reply to.
* @param command The command that the reply relates to.
* @param code A machine readable code for this reply.
* @param description A human readable description of this reply.
*/
void Send(LocalUser* user, Command* command, const std::string& code, const std::string& description)
{
ClientProtocol::Message msg(cmd.c_str(), ServerInstance->Config->ServerName);
msg.PushParamRef(command->name);
msg.PushParam(code);
msg.PushParam(description);
SendInternal(user, msg);
}
template<typename T1>
void Send(LocalUser* user, Command* command, const std::string& code, const T1& p1, const std::string& description)
{
ClientProtocol::Message msg(cmd.c_str(), ServerInstance->Config->ServerName);
msg.PushParamRef(command->name);
msg.PushParam(code);
msg.PushParam(ConvToStr(p1));
msg.PushParam(description);
SendInternal(user, msg);
}
template<typename T1, typename T2>
void Send(LocalUser* user, Command* command, const std::string& code, const T1& p1, const T2& p2,
const std::string& description)
{
ClientProtocol::Message msg(cmd.c_str(), ServerInstance->Config->ServerName);
msg.PushParamRef(command->name);
msg.PushParam(code);
msg.PushParam(ConvToStr(p1));
msg.PushParam(ConvToStr(p2));
msg.PushParam(description);
SendInternal(user, msg);
}
template<typename T1, typename T2, typename T3>
void Send(LocalUser* user, Command* command, const std::string& code, const T1& p1, const T2& p2,
const T3& p3, const std::string& description)
{
ClientProtocol::Message msg(cmd.c_str(), ServerInstance->Config->ServerName);
msg.PushParamRef(command->name);
msg.PushParam(code);
msg.PushParam(ConvToStr(p1));
msg.PushParam(ConvToStr(p2));
msg.PushParam(ConvToStr(p3));
msg.PushParam(description);
SendInternal(user, msg);
}
template<typename T1, typename T2, typename T3, typename T4>
void Send(LocalUser* user, Command* command, const std::string& code, const T1& p1, const T2& p2,
const T3& p3, const T4& p4, const std::string& description)
{
ClientProtocol::Message msg(cmd.c_str(), ServerInstance->Config->ServerName);
msg.PushParamRef(command->name);
msg.PushParam(code);
msg.PushParam(ConvToStr(p1));
msg.PushParam(ConvToStr(p2));
msg.PushParam(ConvToStr(p3));
msg.PushParam(ConvToStr(p4));
msg.PushParam(description);
SendInternal(user, msg);
}
template<typename T1, typename T2, typename T3, typename T4, typename T5>
void Send(LocalUser* user, Command* command, const std::string& code, const T1& p1, const T2& p2,
const T3& p3, const T4& p4, const T5& p5, const std::string& description)
{
ClientProtocol::Message msg(cmd.c_str(), ServerInstance->Config->ServerName);
msg.PushParamRef(command->name);
msg.PushParam(code);
msg.PushParam(ConvToStr(p1));
msg.PushParam(ConvToStr(p2));
msg.PushParam(ConvToStr(p3));
msg.PushParam(ConvToStr(p4));
msg.PushParam(ConvToStr(p5));
msg.PushParam(description);
SendInternal(user, msg);
}
/**
* Sends a standard reply to the specified user if they have the specified cap
* or a notice if they do not.
* @param user The user to send the reply to.
* @param command The command that the reply relates to.
* @param code A machine readable code for this reply.
* @param description A human readable description of this reply.
*/
void SendIfCap(LocalUser* user, const Cap::Capability& cap, Command* command, const std::string& code,
const std::string& description)
{
if (cap.get(user))
Send(user, command, code, description);
else
user->WriteNotice(InspIRCd::Format("*** %s: %s", command->name.c_str(), description.c_str()));
}
};
/** Sends a FAIL standard reply. */
class IRCv3::Replies::Fail
: public IRCv3::Replies::Reply
{
public:
/** Initializes a new instance of the Fail class.
* @param Creator The module which created this instance.
*/
Fail(Module* Creator)
: Reply(Creator, "FAIL")
{
}
};
/** Sends a NOTE standard reply. */
class IRCv3::Replies::Note
: public IRCv3::Replies::Reply
{
public:
/** Initializes a new instance of the Note class.
* @param Creator The module which created this instance.
*/
Note(Module* Creator)
: Reply(Creator, "NOTE")
{
}
};
/** Sends a WARN standard reply. */
class IRCv3::Replies::Warn
: public IRCv3::Replies::Reply
{
public:
/** Initializes a new instance of the Warn class.
* @param Creator The module which created this instance.
*/
Warn(Module* Creator)
: Reply(Creator, "WARN")
{
}
};
|
