-
Notifications
You must be signed in to change notification settings - Fork 0
/
help.go
376 lines (302 loc) · 9.63 KB
/
help.go
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
370
371
372
373
374
375
376
// Copyright (c) 2016- Daniel Oaks <daniel@danieloaks.net>
// released under the MIT license
package irc
import (
"strings"
"github.com/DanielOaks/girc-go/ircmsg"
)
// HelpEntry represents an entry in the Help map.
type HelpEntry struct {
oper bool
text string
}
// used for duplicates
var (
cmodeHelpText = `== Channel Modes ==
Oragono supports the following channel modes:
= Type A - list modes =
+b | Client masks that are banned from the channel.
+e | Client masks that are exempted from bans.
+I | Client masks that are exempted from the invite-only flag.
= Type C - setting modes with a parameter =
+l | Client join limit for the channel.
+k | Key required when joining the channel.
= Type D - flag modes =
+i | Invite-only mode, only invited clients can join the channel.
+m | Moderated mode, only privileged clients can talk on the channel.
+n | No-outside-messages mode, only users that are on the channel can send the channel messages.
+t | Only channel opers can modify the topic.
+s | Secret mode, channel won't show up in /LIST or whois replies.
= Prefixes =
+q (~) | Founder channel mode.
+a (&) | Admin channel mode.
+o (@) | Operator channel mode.
+h (%) | Halfop channel mode.
+v (+) | Voice channel mode.`
umodeHelpText = `== User Modes ==
Oragono supports the following user modes:
+a | User is marked as being away. This mode is set with the /AWAY command.
+i | User is marked as invisible (their channels are hidden from whois replies).
+o | User is an IRC operator.
+Z | User is connected via TLS.`
)
// Help contains the help strings distributed with the IRCd.
var Help = map[string]HelpEntry{
// Commands
"ambiance": {
text: `AMBIANCE <target> <text to be sent>
The AMBIANCE command is used to send a scene notification to the given target.`,
},
"authenticate": {
text: `AUTHENTICATE
Used during SASL authentication. See the IRCv3 specs for more info:
http://ircv3.net/specs/extensions/sasl-3.1.html`,
},
"away": {
text: `AWAY [message]
If [message] is sent, marks you away. If [message] is not sent, marks you no
longer away.`,
},
"cap": {
text: `CAP <subcommand> [:<capabilities>]
Used in capability negotiation. See the IRCv3 specs for more info:
http://ircv3.net/specs/core/capability-negotiation-3.1.html
http://ircv3.net/specs/core/capability-negotiation-3.2.html`,
},
"debug": {
oper: true,
text: `DEBUG <option>
Prints debug information about the IRCd. <option> can be one of:
* GCSTATS: Garbage control statistics.
* NUMGOROUTINE: Number of goroutines in use.
* STARTCPUPROFILE: Starts the CPU profiler.
* STOPCPUPROFILE: Stops the CPU profiler.
* PROFILEHEAP: Writes out the CPU profiler info.`,
},
"help": {
text: `HELP <argument>
Get an explanation of <argument>.`,
},
"invite": {
text: `INVITE <nickname> <channel>
Invites the given user to the given channel, so long as you have the
appropriate channel privs.`,
},
"ison": {
text: `ISON <nickname>{ <nickname>}
Returns whether the given nicks exist on the network.`,
},
"join": {
text: `JOIN <channel>{,<channel>} [<key>{,<key>}]
JOIN 0
Joins the given channels with the matching keys, or if the only param is "0"
parts all channels instead.`,
},
"kick": {
text: `KICK <channel> <user> [reason]
Removes the user from the given channel, so long as you have the appropriate
channel privs.`,
},
"kill": {
oper: true,
text: `KILL <nickname> [reason]
Removes the given user from the network, showing them the reason if it is
supplied.`,
},
"list": {
text: `LIST [<channel>{,<channel>}] [<elistcond>{,<elistcond>}]
Shows information on the given channels (or if none are given, then on all
channels). <elistcond>s modify how the channels are selected.`,
//TODO(dan): Explain <elistcond>s in more specific detail
},
"mode": {
text: `MODE <target> [<modestring> [<mode arguments>...]]
Sets and removes modes from the given target. For more specific information on
mode characters, see the help for "cmode" and "umode".`,
},
"monitor": {
text: `MONITOR <subcmd>
Allows the monitoring of nicknames, for alerts when they are online and
offline. The subcommands are:
MONITOR + target{,target}
Adds the given names to your list of monitored nicknames.
MONITOR - target{,target}
Removes the given names from your list of monitored nicknames.
MONITOR C
Clears your list of monitored nicknames.
MONITOR L
Lists all the nicknames you are currently monitoring.
MONITOR S
Lists whether each nick in your MONITOR list is online or offline.`,
},
"motd": {
text: `MOTD [server]
Returns the message of the day for this, or the given, server.`,
},
"names": {
text: `NAMES [<channel>{,<channel>}]
Views the clients joined to a channel and their channel membership prefixes. To
view the channel membership prefixes supported by this server, see the help for
"PREFIX".`,
},
"nick": {
text: `NICK <newnick>
Sets your nickname to the new given one.`,
},
"notice": {
text: `NOTICE <target>{,<target>} <text to be sent>
Sends the text to the given targets as a NOTICE.`,
},
"npc": {
text: `NPC <target> <sourcenick> <text to be sent>
The NPC command is used to send a message to the target as the source.`,
},
"npca": {
text: `NPCA <target> <sourcenick> <text to be sent>
The NPC command is used to send an action to the target as the source.`,
},
"oper": {
text: `OPER <name> <password>
If the correct details are given, gives you IRCop privs.`,
},
"part": {
text: `PART <channel>{,<channel>} [reason]
Leaves the given channels and shows people the given reason.`,
},
"pass": {
text: `PASS <password>
When the server requires a connection password to join, used to send us the
password.`,
},
"ping": {
text: `PING <args>...
Requests a PONG. Used to check link connectivity.`,
},
"pong": {
text: `PONG <args>...
Replies to a PING. Used to check link connectivity.`,
},
"privmsg": {
text: `PRIVMSG <target>{,<target>} <text to be sent>
Sends the text to the given targets as a PRIVMSG.`,
},
"sanick": {
oper: true,
text: `SANICK <currentnick> <newnick>
Gives the given user a new nickname.`,
},
"scene": {
text: `SCENE <target> <text to be sent>
The SCENE command is used to send a scene notification to the given target.`,
},
"quit": {
text: `QUIT [reason]
Indicates that you're leaving the server, and shows everyone the given reason.`,
},
"reg": {
text: `REG CREATE <accountname> [callback_namespace:]<callback> [cred_type] :<credential>
REG VERIFY <accountname> <auth_code>
Used in account registration. See the relevant specs for more info:
https://github.com/DanielOaks/ircv3-specifications/blob/register-and-verify/extensions/reg-core-3.3.md`,
},
"rehash": {
oper: true,
text: `REHASH
Reloads the config file and updates TLS certificates on listeners`,
},
"time": {
text: `TIME [server]
Shows the time of the current, or the given, server.`,
},
"topic": {
text: `TOPIC <channel> [topic]
If [topic] is given, sets the topic in the channel to that. If [topic] is not
given, views the current topic on the channel.`,
},
"user": {
text: `USER <username> 0 * <realname>
Used in connection registration, sets your username and realname to the given
values (though your username may also be looked up with Ident).`,
},
"version": {
text: `VERSION [server]
Views the version of software and the RPL_ISUPPORT tokens for the given server.`,
},
"who": {
text: `WHO <name> [o]
Returns information for the given user.`,
},
"whois": {
text: `WHOIS <client>{,<client>}
Returns information for the given user(s).`,
},
"whowas": {
text: `WHOWAS <nickname>
Returns historical information on the last user with the given nickname.`,
},
// Informational
"cmode": {
text: cmodeHelpText,
},
"cmodes": {
text: cmodeHelpText,
},
"umode": {
text: umodeHelpText,
},
"umodes": {
text: umodeHelpText,
},
// RPL_ISUPPORT
"casemapping": {
text: `RPL_ISUPPORT CASEMAPPING
Oragono supports an experimental unicode casemapping designed for extended
Unicode support. This casemapping is based off RFC 7700 and the draft rfc7700
casemapping spec here:
https://github.com/DanielOaks/ircv3-specifications/blob/master%2Brfc7700/documentation/rfc7700.md`,
},
"prefix": {
text: `RPL_ISUPPORT PREFIX
Oragono supports the following channel membership prefixes:
+q (~) | Founder channel mode.
+a (&) | Admin channel mode.
+o (@) | Operator channel mode.
+h (%) | Halfop channel mode.
+v (+) | Voice channel mode.`,
},
}
// sendHelp sends the client help of the given string.
func (client *Client) sendHelp(name string, text string) {
splitName := strings.Split(name, " ")
textLines := strings.Split(text, "\n")
for i, line := range textLines {
args := splitName
args = append(args, line)
if i == 0 {
client.Send(nil, client.server.name, RPL_HELPSTART, args...)
} else {
client.Send(nil, client.server.name, RPL_HELPTXT, args...)
}
}
args := splitName
args = append(args, "End of /HELP")
client.Send(nil, client.server.name, RPL_ENDOFHELP, args...)
}
// helpHandler returns the appropriate help for the given query.
func helpHandler(server *Server, client *Client, msg ircmsg.IrcMessage) bool {
argument := strings.ToLower(strings.TrimSpace(strings.Join(msg.Params, " ")))
if len(argument) < 1 {
client.sendHelp("HELP", `HELP <argument>
Get an explanation of <argument>.`)
return false
}
helpHandler, exists := Help[argument]
if exists && (!helpHandler.oper || (helpHandler.oper && client.flags[Operator])) {
client.sendHelp(strings.ToUpper(argument), helpHandler.text)
} else {
args := msg.Params
args = append(args, "Help not found")
client.Send(nil, server.name, ERR_HELPNOTFOUND, args...)
}
return false
}