1 /* modcmd.c - Generalized module command support
2 * Copyright 2002-2007 srvx Development Team
4 * This file is part of srvx.
6 * srvx is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with srvx; if not, write to the Free Software Foundation,
18 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
26 struct pending_template {
29 struct pending_template *next;
32 static struct dict *modules;
33 static struct dict *services;
34 static struct pending_template *pending_templates;
35 static struct module *modcmd_module;
36 static struct modcmd *bind_command, *help_command, *version_command;
37 unsigned short offchannel_allowed[256] = { 0 };
38 static const struct message_entry msgtab[] = {
39 { "MCMSG_BARE_FLAG", "Flag %.*s must be preceded by a + or -." },
40 { "MCMSG_UNKNOWN_FLAG", "Unknown module flag %.*s." },
41 { "MCMSG_BAD_OPSERV_LEVEL", "Invalid $O access level %s." },
42 { "MCMSG_BAD_CHANSERV_LEVEL", "Invalid $C access level %s." },
43 { "MCMSG_LEVEL_TOO_LOW", "You cannot set the access requirements for %s (your level is too low.)" },
44 { "MCMSG_LEVEL_TOO_HIGH", "You cannot set the access requirements to %s (that is too high)." },
45 { "MCMSG_BAD_OPTION", "Unknown option %s." },
46 { "MCMSG_MUST_QUALIFY", "You $bMUST$b \"/msg %s@$s %s\" (not just /msg %s)." },
47 { "MCMSG_ACCOUNT_SUSPENDED", "Your account has been suspended." },
48 { "MCMSG_CHAN_NOT_REGISTERED", "%s has not been registered with $C." },
49 { "MCMSG_CHAN_SUSPENDED", "$b$C$b access to $b%s$b has been temporarily suspended (%s)." },
50 { "MCMSG_NO_CHANNEL_ACCESS", "You lack access to %s." },
51 { "MCMSG_LOW_CHANNEL_ACCESS", "You lack sufficient access in %s to use this command." },
52 { "MCMSG_REQUIRES_JOINABLE", "You must be in %s (or on its userlist) to use this command." },
53 { "MCMSG_MUST_BE_HELPING", "You must have security override (helping mode) on to use this command." },
54 { "MCMSG_MISSING_COMMAND", "You must specify a command as well as a channel." },
55 { "MCMSG_NO_CHANNEL_BEFORE", "You may not give a channel name before this command." },
56 { "MCMSG_NO_PLUS_CHANNEL", "You may not use a +channel with this command." },
57 { "MCMSG_COMMAND_ALIASES", "%s is an alias for: %s" },
58 { "MCMSG_COMMAND_BINDING", "%s is a binding of: %s" },
59 { "MCMSG_ALIAS_ERROR", "Error in alias expansion for %s; check the error log for details." },
60 { "MCMSG_INTERNAL_COMMAND", "$b%s$b is an internal command and cannot be called directly; please check command bindings." },
61 { "MCMSG_UNKNOWN_MODULE", "Unknown module %s." },
62 { "MCMSG_UNKNOWN_SERVICE", "Unknown service %s." },
63 { "MCMSG_ALREADY_BOUND", "%s already has a command bound as %s." },
64 { "MCMSG_UNKNOWN_COMMAND_2", "Unknown command name %s (relative to service %s)." },
65 { "MCMSG_COMMAND_MODIFIED", "Option $b%s$b for $b%s$b has been set." },
66 { "MCMSG_INSPECTION_REFUSED", "You do not have access to inspect command %s." },
67 { "MCMSG_CANNOT_DOUBLE_ALIAS", "You cannot bind to a complex (argument-carrying) bind." },
68 { "MCMSG_BAD_ALIAS_ARGUMENT", "Invalid alias argument $b%s$b." },
69 { "MCMSG_COMMAND_BOUND", "New command %s bound to %s." },
70 { "MCMSG_MODULE_BOUND", "Bound %d commands from %s to %s." },
71 { "MCMSG_NO_COMMAND_BOUND", "%s has nothing bound as command %s." },
72 { "MCMSG_UNBIND_PROHIBITED", "It wouldn't be very much fun to unbind the last %s command, now would it?" },
73 { "MCMSG_COMMAND_UNBOUND", "Unbound command %s from %s." },
74 { "MCMSG_HELPFILE_UNBOUND", "Since that was the last command from module %s on the service, the helpfile for %s was removed." },
75 { "MCMSG_NO_HELPFILE", "Module %s does not have a help file." },
76 { "MCMSG_HELPFILE_ERROR", "Syntax error reading %s; help contents not changed." },
77 { "MCMSG_HELPFILE_READ", "Read %s help database in %lu.%03lu seconds." },
78 { "MCMSG_COMMAND_TIME", "Command $b%s$b finished in %lu.%06lu seconds." },
79 { "MCMSG_NEED_OPSERV_LEVEL", "You must have $O access of at least $b%u$b." },
80 { "MCMSG_NEED_CHANSERV_LEVEL", "You must have $C access of at least $b%u$b in the channel." },
81 { "MCMSG_NEED_ACCOUNT_FLAGS", "You must have account flags $b%s$b." },
82 { "MCMSG_NEED_NOTHING", "Anyone may use the $b%s$b command." },
83 { "MCMSG_NEED_STAFF_ACCESS", "You must be network staff." },
84 { "MCMSG_NEED_STAFF_OPER", "You must be an IRC operator." },
85 { "MCMSG_NEED_STAFF_NETHELPER", "You must be a network helper." },
86 { "MCMSG_NEED_STAFF_NETHELPER_OR_OPER", "You must be a network helper or IRC operator." },
87 { "MCMSG_NEED_STAFF_SHELPER", "You must be a support helper." },
88 { "MCMSG_NEED_STAFF_SHELPER_OR_OPER", "You must be a support helper or IRC operator." },
89 { "MCMSG_NEED_STAFF_HELPER", "You must be a network or support helper." },
90 { "MCMSG_NEED_JOINABLE", "The channel must be open or you must be in the channel or on its userlist." },
91 { "MCMSG_NEED_CHANUSER_CSUSPENDABLE", "You must be on the channel's userlist, and the channel can be suspended." },
92 { "MCMSG_NEED_CHANUSER", "You must be on the channel's userlist." },
93 { "MCMSG_NEED_REGCHAN", "You must specify a channel registered with $C." },
94 { "MCMSG_NEED_CHANNEL", "You must specify a channel that exists." },
95 { "MCMSG_NEED_AUTHED", "You must be authenticated with $N." },
96 { "MCMSG_IS_TOY", "$b%s$b is a toy command." },
97 { "MCMSG_END_REQUIREMENTS", "End of requirements for $b%s$b." },
98 { "MCMSG_ALREADY_HELPING", "You already have security override enabled." },
99 { "MCMSG_ALREADY_NOT_HELPING", "You already have security override disabled." },
100 { "MCMSG_NOW_HELPING", "Security override has been enabled." },
101 { "MCMSG_NOW_NOT_HELPING", "Security override has been disabled." },
102 { "MCMSG_JOINER_CHOICES", "Subcommands of %s: %s" },
103 { "MCMSG_MODULE_INFO", "Commands exported by module $b%s$b:" },
104 { "MCMSG_SERVICE_INFO", "Commands bound to service $b%s$b:" },
105 { "MCMSG_TOYS_DISABLED", "Toys are disabled in %s." },
106 { "MCMSG_PUBLIC_DENY", "Public commands in $b%s$b are restricted." },
107 { "MCMSG_HELPFILE_SEQUENCE", "Help priority %d: %s" },
108 { "MCMSG_HELPFILE_SEQUENCE_SET", "Set helpfile priority sequence for %s." },
109 { "MCMSG_BAD_SERVICE_NICK", "$b%s$b is an invalid nickname." },
110 { "MCMSG_ALREADY_SERVICE", "$b%s$b is already a service." },
111 { "MCMSG_NEW_SERVICE", "Added new service bot $b%s$b." },
112 { "MCMSG_SERVICE_RENAMED", "Service renamed to $b%s$b." },
113 { "MCMSG_NO_TRIGGER", "$b%s$b does not have an in-channel trigger." },
114 { "MCMSG_REMOVED_TRIGGER", "Removed trigger from $b%s$b." },
115 { "MCMSG_DUPLICATE_TRIGGER", "$b%s$b already uses trigger $b%c$b." },
116 { "MCMSG_CURRENT_TRIGGER", "Trigger for $b%s$b is $b%c$b." },
117 { "MCMSG_NEW_TRIGGER", "Changed trigger for $b%s$b to $b%c$b." },
118 { "MCMSG_SERVICE_PRIVILEGED", "Service $b%s$b privileged: $b%s$b." },
119 { "MCMSG_OFFCHANNEL_IS_ON", "Off-channel use for $b%s$b (trigger $b%c$b) is enabled" },
120 { "MCMSG_OFFCHANNEL_IS_OFF", "Off-channel use for $b%s$b (trigger $b%c$b) is disabled" },
121 { "MCMSG_OFFCHANNEL_ON", "Enabled off-channel use for $b%s$b (trigger $b%c$b)" },
122 { "MCMSG_OFFCHANNEL_OFF", "Disabled off-channel use for $b%s$b (trigger $b%c$b)" },
123 { "MCMSG_SERVICE_REMOVED", "Service $b%s$b has been deleted." },
124 { "MCMSG_FILE_NOT_OPENED", "Unable to open file $b%s$b for writing." },
125 { "MCMSG_MESSAGES_DUMPED", "Messages written to $b%s$b." },
126 { "MCMSG_MESSAGE_DUMP_FAILED", "Message dump failed: %s." },
127 { "MCMSG_COMMAND_FLAGS", "Command flags are %s (inferred: %s)." },
128 { "MCMSG_COMMAND_ACCOUNT_FLAGS", "Requires account flags +%s, prohibits account flags +%s." },
129 { "MCMSG_COMMAND_ACCESS_LEVEL", "Requires channel access %d and $O access %d." },
130 { "MCMSG_COMMAND_USES", "%s has been used %d times." },
133 struct userData *_GetChannelUser(struct chanData *channel, struct handle_info *handle, int override, int allow_suspended);
135 #define ACTION_ALLOW 1
136 #define ACTION_OVERRIDE 2
137 #define ACTION_NOCHANNEL 4
138 #define ACTION_STAFF 8
140 #define RESOLVE_DEPTH 4
142 static struct modcmd_flag {
146 { "acceptchan", MODCMD_ACCEPT_CHANNEL },
147 { "acceptpluschan", MODCMD_ACCEPT_PCHANNEL },
148 { "authed", MODCMD_REQUIRE_AUTHED },
149 { "channel", MODCMD_REQUIRE_CHANNEL },
150 { "chanuser", MODCMD_REQUIRE_CHANUSER },
151 { "disabled", MODCMD_DISABLED },
152 { "helping", MODCMD_REQUIRE_HELPING },
153 { "ignore_csuspend", MODCMD_IGNORE_CSUSPEND },
154 { "joinable", MODCMD_REQUIRE_JOINABLE },
155 { "keepbound", MODCMD_KEEP_BOUND },
156 { "loghostmask", MODCMD_LOG_HOSTMASK },
157 { "networkhelper", MODCMD_REQUIRE_NETWORK_HELPER },
158 { "never_csuspend", MODCMD_NEVER_CSUSPEND },
159 { "nolog", MODCMD_NO_LOG },
160 { "oper", MODCMD_REQUIRE_OPER },
161 { "qualified", MODCMD_REQUIRE_QUALIFIED },
162 { "regchan", MODCMD_REQUIRE_REGCHAN },
163 { "supporthelper", MODCMD_REQUIRE_SUPPORT_HELPER },
164 { "toy", MODCMD_TOY },
169 flags_bsearch(const void *a, const void *b) {
171 const struct modcmd_flag *flag = b;
172 return ircncasecmp(key, flag->name, strlen(flag->name));
176 flags_qsort(const void *a, const void *b) {
177 const struct modcmd_flag *fa = a, *fb = b;
178 return irccasecmp(fa->name, fb->name);
181 DEFINE_LIST(svccmd_list, struct svccmd*)
182 DEFINE_LIST(module_list, struct module*)
185 free_service_command(void *data) {
186 struct svccmd *svccmd;
190 if (svccmd->alias.used) {
191 for (nn=0; nn<svccmd->alias.used; ++nn)
192 free(svccmd->alias.list[nn]);
193 free(svccmd->alias.list);
200 free_service(void *data) {
201 struct service *service = data;
202 dict_delete(service->commands);
203 module_list_clean(&service->modules);
208 free_module_command(void *data) {
209 struct modcmd *modcmd = data;
210 free_service_command(modcmd->defaults);
216 free_module(void *data) {
217 struct module *module = data;
218 dict_delete(module->commands);
219 close_helpfile(module->helpfile);
225 module_register(const char *name, struct log_type *clog, const char *helpfile_name, expand_func_t expand_help) {
226 struct module *newmod;
228 newmod = calloc(1, sizeof(*newmod));
229 newmod->name = strdup(name);
230 newmod->commands = dict_new();
231 dict_set_free_data(newmod->commands, free_module_command);
233 newmod->helpfile_name = helpfile_name;
234 newmod->expand_help = expand_help;
235 if (newmod->helpfile_name) {
236 newmod->helpfile = open_helpfile(newmod->helpfile_name, newmod->expand_help);
238 dict_insert(modules, newmod->name, newmod);
243 module_find(const char *name) {
244 return dict_find(modules, name, NULL);
248 add_pending_template(struct svccmd *cmd, const char *target) {
249 struct pending_template *pending = calloc(1, sizeof(*pending));
251 pending->base = strdup(target);
252 pending->next = pending_templates;
253 pending_templates = pending;
256 static struct svccmd *
257 svccmd_resolve_name(struct svccmd *origin, const char *name) {
258 char *sep, svcname[MAXLEN];
260 if ((sep = strchr(name, '.'))) {
261 memcpy(svcname, name, sep-name);
262 svcname[sep-name] = 0;
264 if (svcname[0] == '*') {
265 struct module *module = module_find(svcname+1);
266 struct modcmd *cmd = module ? dict_find(module->commands, name, NULL) : NULL;
267 return cmd ? cmd->defaults : NULL;
269 struct service *service = service_find(svcname);
270 return service ? dict_find(service->commands, name, NULL) : NULL;
273 if (origin->parent) {
274 return dict_find(origin->parent->commands, name, NULL);
276 struct modcmd *cmd = dict_find(origin->command->parent->commands, name, NULL);
277 return cmd ? cmd->defaults : NULL;
283 modcmd_set_effective_flags(struct svccmd *cmd) {
284 int flags = cmd->flags | cmd->command->flags;
285 if (cmd->min_opserv_level > 0)
286 flags |= MODCMD_REQUIRE_OPER;
287 if (cmd->min_channel_access > 0)
288 flags |= MODCMD_REQUIRE_CHANUSER;
289 if (flags & MODCMD_REQUIRE_CHANUSER)
290 flags |= MODCMD_REQUIRE_REGCHAN;
291 if (flags & MODCMD_REQUIRE_REGCHAN)
292 flags |= MODCMD_REQUIRE_CHANNEL;
293 if (flags & (MODCMD_REQUIRE_STAFF|MODCMD_REQUIRE_HELPING))
294 flags |= MODCMD_REQUIRE_AUTHED;
295 cmd->effective_flags = flags;
299 svccmd_copy_rules(struct svccmd *dest, struct svccmd *src) {
300 dest->flags |= src->flags;
301 dest->req_account_flags |= src->req_account_flags;
302 dest->deny_account_flags |= src->deny_account_flags;
303 if (src->min_opserv_level > dest->min_opserv_level)
304 dest->min_opserv_level = src->min_opserv_level;
305 if (src->min_channel_access > dest->min_channel_access)
306 dest->min_channel_access = src->min_channel_access;
307 modcmd_set_effective_flags(dest);
311 svccmd_configure(struct svccmd *cmd, struct userNode *user, struct userNode *bot, const char *param, const char *value) {
312 if (!irccasecmp(param, "flags")) {
313 unsigned int set_flags, rem_flags;
314 struct modcmd_flag *flag;
317 for (set_flags = rem_flags = 0; 1; value += end) {
318 end = strcspn(value, ",");
321 else if (*value == '-')
325 send_message(user, bot, "MCMSG_BARE_FLAG", end, value);
327 log_module(MAIN_LOG, LOG_ERROR, "Flag %.*s must be preceded by a + or - (for command %s).", end, value, cmd->name);
331 flag = bsearch(value, modcmd_flags, ArrayLength(modcmd_flags)-1, sizeof(modcmd_flags[0]), flags_bsearch);
334 send_message(user, bot, "MCMSG_UNKNOWN_FLAG", end, value);
336 log_module(MAIN_LOG, LOG_ERROR, "Unknown module flag %.*s (for command %s).", end, value, cmd->name);
340 set_flags |= flag->flag, rem_flags &= ~flag->flag;
342 rem_flags |= flag->flag, set_flags &= ~flag->flag;
346 cmd->flags = (cmd->flags | set_flags) & ~rem_flags;
348 } else if (!irccasecmp(param, "channel_level") || !irccasecmp(param, "channel_access") || !irccasecmp(param, "access")) {
350 if (!irccasecmp(value, "none") || !irccasecmp(value, "0")) {
351 cmd->min_channel_access = 0;
353 } else if ((ul = user_level_from_name(value, UL_OWNER)) > 0) {
354 cmd->min_channel_access = ul;
357 send_message(user, bot, "MCMSG_BAD_CHANSERV_LEVEL", value);
360 log_module(MAIN_LOG, LOG_ERROR, "Invalid ChanServ access level %s (for command %s).", value, cmd->name);
363 } else if (!irccasecmp(param, "oper_level") || !irccasecmp(param, "oper_access") || !irccasecmp(param, "level")) {
364 unsigned int newval = atoi(value);
365 if (!isdigit(value[0]) || (newval > 1000)) {
367 send_message(user, bot, "MCMSG_BAD_OPSERV_LEVEL", value);
369 log_module(MAIN_LOG, LOG_ERROR, "Invalid OpServ access level %s (for command %s).", value, cmd->name);
372 if (user && (!user->handle_info || (cmd->min_opserv_level > user->handle_info->opserv_level))) {
373 send_message(user, bot, "MCMSG_LEVEL_TOO_LOW", cmd->name);
376 if (user && (!user->handle_info || (newval > user->handle_info->opserv_level))) {
377 send_message(user, bot, "MCMSG_LEVEL_TOO_HIGH", value);
380 cmd->min_opserv_level = newval;
382 } else if (!irccasecmp(param, "account_flags")) {
383 return nickserv_modify_handle_flags(user, bot, value, &cmd->req_account_flags, &cmd->deny_account_flags);
386 send_message(user, bot, "MCMSG_BAD_OPTION", param);
388 log_module(MAIN_LOG, LOG_ERROR, "Unknown option %s (for command %s).", param, cmd->name);
394 modcmd_register(struct module *module, const char *name, modcmd_func_t func, unsigned int min_argc, unsigned int flags, ...) {
395 struct modcmd *newcmd;
397 const char *param, *value;
399 newcmd = calloc(1, sizeof(*newcmd));
400 newcmd->name = strdup(name);
401 newcmd->parent = module;
403 newcmd->min_argc = min_argc;
404 newcmd->flags = flags;
405 newcmd->defaults = calloc(1, sizeof(*newcmd->defaults));
406 newcmd->defaults->name = strdup(newcmd->name);
407 newcmd->defaults->command = newcmd;
408 dict_insert(module->commands, newcmd->name, newcmd);
409 if (newcmd->flags & (MODCMD_REQUIRE_REGCHAN|MODCMD_REQUIRE_CHANNEL|MODCMD_REQUIRE_CHANUSER|MODCMD_REQUIRE_JOINABLE)) {
410 newcmd->defaults->flags |= MODCMD_ACCEPT_CHANNEL;
412 if (newcmd->flags & MODCMD_REQUIRE_STAFF) {
413 newcmd->defaults->flags |= MODCMD_REQUIRE_AUTHED;
415 va_start(args, flags);
416 while ((param = va_arg(args, const char*))) {
417 value = va_arg(args, const char*);
418 if (!irccasecmp(param, "template")) {
419 struct svccmd *svccmd = svccmd_resolve_name(newcmd->defaults, value);
421 svccmd_copy_rules(newcmd->defaults, svccmd);
423 log_module(MAIN_LOG, LOG_ERROR, "Unable to resolve template name %s for %s.%s.", value, newcmd->parent->name, newcmd->name);
425 add_pending_template(newcmd->defaults, value);
427 svccmd_configure(newcmd->defaults, NULL, NULL, param, value);
430 modcmd_set_effective_flags(newcmd->defaults);
435 /* This is kind of a lame hack, but it is actually simpler than having
436 * the permission check vary based on the command itself, or having a
437 * more generic rule system.
440 svccmd_can_invoke(struct userNode *user, struct userNode *bot, struct svccmd *cmd, struct chanNode *channel, int options) {
441 extern struct userNode *chanserv;
442 unsigned int uData_checked = 0;
443 struct userData *uData = NULL;
444 int rflags = 0, flags = cmd->effective_flags;
446 if (flags & MODCMD_DISABLED) {
447 if (options & SVCCMD_NOISY)
448 send_message(user, bot, "MSG_COMMAND_DISABLED", cmd->name);
451 if ((flags & MODCMD_REQUIRE_QUALIFIED) && !(options & SVCCMD_QUALIFIED)) {
452 if (options & SVCCMD_NOISY)
453 send_message(user, bot, "MCMSG_MUST_QUALIFY", bot->nick, cmd->name, bot->nick);
456 if (flags & MODCMD_REQUIRE_AUTHED) {
457 if (!user->handle_info) {
458 if (options & SVCCMD_NOISY)
459 send_message(user, bot, "MSG_AUTHENTICATE");
462 if (HANDLE_FLAGGED(user->handle_info, SUSPENDED)) {
463 if (options & SVCCMD_NOISY)
464 send_message(user, bot, "MCMSG_ACCOUNT_SUSPENDED");
468 if (channel || (options & SVCCMD_NOISY)) {
469 if ((flags & MODCMD_REQUIRE_CHANNEL) && !channel) {
470 if (options & SVCCMD_NOISY)
471 send_message(user, bot, "MSG_INVALID_CHANNEL");
474 if (flags & MODCMD_REQUIRE_REGCHAN) {
476 /* Just use the inferred MODCMD_REQUIRE_CHANNEL. */
477 } else if (!channel->channel_info) {
478 if (options & SVCCMD_NOISY)
479 send_message(user, bot, "MCMSG_CHAN_NOT_REGISTERED", channel->name);
481 } else if (IsSuspended(channel->channel_info) && !(flags & MODCMD_IGNORE_CSUSPEND)) {
482 /* Allow security-override users to ignore most channel
483 * suspensions, but flag that use as a staff command.
485 if (!IsHelping(user) || (flags & MODCMD_NEVER_CSUSPEND)) {
486 if (options & SVCCMD_NOISY)
487 send_message(user, bot, "MCMSG_CHAN_SUSPENDED", channel->name, channel->channel_info->suspended->reason);
490 rflags |= ACTION_STAFF;
493 if (flags & MODCMD_REQUIRE_CHANUSER) {
495 uData = _GetChannelUser(channel->channel_info, user->handle_info, 1, 0), uData_checked = 1;
497 /* Assume someone knows what they're doing. */
499 if (options & SVCCMD_NOISY)
500 send_message(user, bot, "MCMSG_NO_CHANNEL_ACCESS", channel->name);
502 } else if (uData->access < cmd->min_channel_access) {
503 if (options & SVCCMD_NOISY)
504 send_message(user, bot, "MCMSG_LOW_CHANNEL_ACCESS", channel->name);
508 if ((flags & MODCMD_REQUIRE_JOINABLE) && channel) {
510 uData = _GetChannelUser(channel->channel_info, user->handle_info, 1, 0), uData_checked = 1;
511 if ((channel->modes & (MODE_INVITEONLY|MODE_KEY|MODE_SECRET))
514 && !GetUserMode(channel, user)) {
515 if (options & SVCCMD_NOISY)
516 send_message(user, bot, "MCMSG_REQUIRES_JOINABLE", channel->name);
520 if ((flags & MODCMD_TOY) && channel) {
521 if (!channel->channel_info)
522 rflags |= ACTION_NOCHANNEL;
523 else switch (channel->channel_info->chOpts[chToys]) {
525 if (options & SVCCMD_NOISY)
526 send_message(user, bot, "MCMSG_TOYS_DISABLED", channel->name);
529 rflags |= ACTION_NOCHANNEL;
536 if (flags & MODCMD_REQUIRE_STAFF) {
537 if (((flags & MODCMD_REQUIRE_OPER) && IsOper(user))
538 || ((flags & MODCMD_REQUIRE_NETWORK_HELPER) && IsNetworkHelper(user))
539 || ((flags & MODCMD_REQUIRE_SUPPORT_HELPER) && IsSupportHelper(user))) {
541 rflags |= ACTION_STAFF;
543 if (options & SVCCMD_NOISY)
544 send_message(user, bot, "MSG_COMMAND_PRIVILEGED", cmd->name);
548 if (flags & MODCMD_REQUIRE_HELPING) {
549 if (!HANDLE_FLAGGED(user->handle_info, HELPING)) {
550 if (options & SVCCMD_NOISY)
551 send_message(user, bot, "MCMSG_MUST_BE_HELPING");
554 rflags |= ACTION_STAFF;
556 if (cmd->min_opserv_level > 0) {
557 if (!oper_has_access(user, bot, cmd->min_opserv_level, !(options & SVCCMD_NOISY)))
559 rflags |= ACTION_STAFF;
561 if (cmd->req_account_flags || cmd->deny_account_flags) {
562 if (!user->handle_info) {
563 if (options & SVCCMD_NOISY)
564 send_message(user, bot, "MSG_AUTHENTICATE");
567 /* Do we want separate or different messages here? */
568 if ((cmd->req_account_flags & ~user->handle_info->flags)
569 || (cmd->deny_account_flags & user->handle_info->flags)) {
570 if (options & SVCCMD_NOISY)
571 send_message(user, bot, "MSG_COMMAND_PRIVILEGED", cmd->name);
576 /* If it's an override, return a special value. */
577 if ((flags & MODCMD_REQUIRE_CHANUSER)
578 && (options & SVCCMD_NOISY)
579 && (!uData || (uData->access > 500))
580 && (!(uData = _GetChannelUser(channel->channel_info, user->handle_info, 0, 0))
581 || uData->access < cmd->min_channel_access)
582 && !(flags & (MODCMD_REQUIRE_STAFF|MODCMD_REQUIRE_HELPING))) {
583 rflags |= ACTION_OVERRIDE;
585 return rflags | ACTION_ALLOW;
589 svccmd_expand_alias(struct svccmd *cmd, unsigned int old_argc, char *old_argv[], char *new_argv[]) {
590 unsigned int ii, new_argc;
593 for (ii=new_argc=0; ii<cmd->alias.used; ++ii) {
594 arg = cmd->alias.list[ii];
596 new_argv[new_argc++] = arg;
600 new_argv[new_argc++] = arg + 1;
601 } else if (isdigit(arg[1])) {
602 unsigned int lbound, ubound, jj;
605 lbound = strtoul(arg+1, &end_num, 10);
606 switch (end_num[0]) {
607 case 0: ubound = lbound; break;
609 if (end_num[1] == 0) {
610 ubound = old_argc - 1;
612 } else if (isdigit(end_num[1])) {
613 ubound = strtoul(end_num+1, NULL, 10);
616 /* else fall through to default case */
618 log_module(MAIN_LOG, LOG_ERROR, "Alias expansion parse error in %s (near %s; %s.%s arg %d).", arg, end_num, cmd->parent->bot->nick, cmd->name, ii);
621 if (lbound >= old_argc)
623 if (ubound >= old_argc)
624 ubound = old_argc - 1;
625 if (lbound < old_argc)
626 for (jj = lbound; jj <= ubound; )
627 new_argv[new_argc++] = old_argv[jj++];
629 log_module(MAIN_LOG, LOG_ERROR, "Alias expansion: I do not know how to handle %s (%s.%s arg %d).", arg, cmd->parent->bot->nick, cmd->name, ii);
637 svccmd_invoke_argv(struct userNode *user, struct service *service, struct chanNode *channel, unsigned int argc, char *argv[], unsigned int server_qualified) {
638 extern struct userNode *chanserv;
640 unsigned int cmd_arg, perms, flags, options, result;
641 char channel_name[CHANNELLEN+1];
643 /* First check pubcmd for the channel. */
644 if (channel && (channel->channel_info) && (service->bot == chanserv)
645 && !check_user_level(channel, user, lvlPubCmd, 1, 0)) {
646 send_message(user, service->bot, "MCMSG_PUBLIC_DENY", channel->name);
650 options = (server_qualified ? SVCCMD_QUALIFIED : 0) | SVCCMD_DEBIT | SVCCMD_NOISY;
651 /* Find the command argument. */
652 cmd_arg = IsChannelName(argv[0]) ? 1 : 0;
653 if (argc < cmd_arg+1) {
654 send_message(user, service->bot, "MCMSG_MISSING_COMMAND");
657 if (!isalnum(*argv[cmd_arg])) {
658 /* Silently ignore stuff that doesn't begin with a letter or number. */
661 cmd = dict_find(service->commands, argv[cmd_arg], NULL);
664 send_message(user, service->bot, "MSG_COMMAND_UNKNOWN", argv[cmd_arg]);
667 flags = cmd->effective_flags;
668 /* If they put a channel name first, check if the command allows
669 * it. If so, swap it with the command name.
673 /* Complain if we're not supposed to accept the channel. */
674 if (!(flags & MODCMD_ACCEPT_CHANNEL)) {
675 send_message(user, service->bot, "MCMSG_NO_CHANNEL_BEFORE");
678 if (!(flags & MODCMD_ACCEPT_PCHANNEL)
679 && (argv[0][0] == '+')) {
680 send_message(user, service->bot, "MCMSG_NO_PLUS_CHANNEL");
688 /* Try to grab a channel handle before alias expansion.
689 * If the command accepts a channel name, and argv[1] is
690 * one, use it as a channel name, and hide it from logging.
693 && (flags & MODCMD_ACCEPT_CHANNEL)
694 && IsChannelName(argv[1])
695 && ((argv[1][0] != '+') || (flags & MODCMD_ACCEPT_PCHANNEL))
696 && (channel = dict_find(channels, argv[1], NULL))) {
702 /* Expand the alias arguments, if there are any. */
703 if (cmd->alias.used) {
704 char *new_argv[MAXNUMPARAMS];
707 res = svccmd_expand_alias(cmd, argc, argv, new_argv);
709 send_message(user, service->bot, "MSG_MISSING_PARAMS", cmd->name);
711 } else if (res == 0) {
712 send_message(user, service->bot, "MCMSG_ALIAS_ERROR", cmd->name);
718 /* Try again to grab a handle to the channel after alias
719 * expansion, overwriting any previous channel. This should,
720 * of course, only be done again if an alias was acually
723 && (flags & MODCMD_ACCEPT_CHANNEL)
724 && IsChannelName(argv[1])
725 && ((argv[1][0] != '+') || (flags & MODCMD_ACCEPT_PCHANNEL))
726 && (channel = dict_find(channels, argv[1], NULL))) {
733 /* Figure out what actions we should do for it.. */
734 if (cmd_arg && (flags & MODCMD_TOY)) {
735 /* Do not let user manually specify a channel. */
738 if (argc < cmd->command->min_argc) {
739 send_message(user, service->bot, "MSG_MISSING_PARAMS", cmd->name);
742 if (!cmd->command->func) {
743 send_message(user, service->bot, "MCMSG_INTERNAL_COMMAND", cmd->name);
746 perms = svccmd_can_invoke(user, service->bot, cmd, channel, options);
750 if (perms & ACTION_NOCHANNEL)
754 safestrncpy(channel_name, channel->name, sizeof(channel_name));
757 if (!(result = cmd->command->func(user, channel, argc, argv, cmd)))
759 if (!(flags & MODCMD_NO_LOG)) {
760 enum log_severity slvl;
761 if (result & CMD_LOG_OVERRIDE)
763 else if ((perms & ACTION_STAFF) || (result & CMD_LOG_STAFF))
765 else if (perms & ACTION_OVERRIDE)
769 /* Unsplit argv after running the function to get the benefit
770 * of any mangling/hiding done by the commands. */
771 log_audit(cmd->command->parent->clog, slvl, user, service->bot, channel_name, ((flags & MODCMD_LOG_HOSTMASK) ? AUDIT_HOSTMASK : 0), unsplit_string(argv, argc, NULL));
777 svccmd_send_help(struct userNode *user, struct userNode *bot, struct svccmd *cmd) {
778 char cmdname[MAXLEN];
780 /* Show command name (in bold). */
781 for (nn=0; cmd->name[nn]; nn++)
782 cmdname[nn] = toupper(cmd->name[nn]);
784 send_message_type(4, user, bot, "$b%s$b", cmdname);
785 /* If it's an alias, show what it's an alias for. */
786 if (cmd->alias.used) {
787 char alias_text[MAXLEN];
788 unsplit_string((char**)cmd->alias.list, cmd->alias.used, alias_text);
789 send_message(user, bot, "MCMSG_COMMAND_ALIASES", cmd->name, alias_text);
791 /* Show the help entry for the underlying command. */
792 return send_help(user, bot, cmd->command->parent->helpfile, cmd->command->name);
796 svccmd_send_help_2(struct userNode *user, struct service *service, const char *topic) {
797 struct module *module;
801 if ((cmd = dict_find(service->commands, topic, NULL)))
802 return svccmd_send_help(user, service->bot, cmd);
805 for (ii = 0; ii < service->modules.used; ++ii) {
806 module = service->modules.list[ii];
807 if (!module->helpfile)
809 if (dict_find(module->helpfile->db, topic, NULL))
810 return send_help(user, service->bot, module->helpfile, topic);
812 send_message(user, service->bot, "MSG_TOPIC_UNKNOWN");
817 svccmd_invoke(struct userNode *user, struct service *service, struct chanNode *channel, const char *text, int server_qualified) {
819 char *argv[MAXNUMPARAMS];
820 char tmpline[MAXLEN];
824 if (service->privileged) {
826 send_message(user, service->bot, "MSG_SERVICE_PRIVILEGED", service->bot->nick);
829 if (!user->handle_info) {
830 send_message(user, service->bot, "MSG_AUTHENTICATE");
833 if (HANDLE_FLAGGED(user->handle_info, OPER_SUSPENDED)) {
834 send_message(user, service->bot, "MSG_OPER_SUSPENDED");
838 safestrncpy(tmpline, text, sizeof(tmpline));
839 argc = split_line(tmpline, false, ArrayLength(argv), argv);
840 return argc ? svccmd_invoke_argv(user, service, channel, argc, argv, server_qualified) : 0;
844 modcmd_privmsg(struct userNode *user, struct userNode *bot, const char *text, int server_qualified) {
845 struct service *service;
847 if (!(service = dict_find(services, bot->nick, NULL))) {
848 log_module(MAIN_LOG, LOG_ERROR, "modcmd_privmsg got privmsg for unhandled service %s, unregistering.", bot->nick);
849 reg_privmsg_func(bot, NULL);
853 if (text[0] == '\x01') {
854 char *term, response[MAXLEN];
856 text++; /* Skip leading ^A. */
857 /* Chop off final ^A. */
858 term = strchr(text, '\x01');
862 /* Parse out leading text. */
863 term = strchr(text, ' ');
869 /* No dict lookup since these are so few. */
870 if (!irccasecmp(text, "CLIENTINFO")) {
871 /* Use \001 instead of \x01 because apparently \x01C is
872 * interpreted as ASCII FS (\034, decimal 28, hex 1C).
874 irc_notice_user(bot, user, "\001CLIENTINFO CLIENTINFO PING TIME USERINFO VERSION\x01");
875 } else if (!irccasecmp(text, "PING")) {
877 snprintf(response, sizeof(response), "\x01PING %s\x01", term);
878 irc_notice_user(bot, user, response);
880 irc_notice_user(bot,user, "\x01PING\x01");
882 } else if (!irccasecmp(text, "TIME")) {
885 strftime(response, sizeof(response), "\x01TIME %a %b %d %H:%M:%S %Y\x01", localtime(&feh));
886 irc_notice_user(bot, user, response);
887 } else if (!irccasecmp(text, "USERINFO")) {
888 snprintf(response, sizeof(response), "\x01USERINFO %s\x01", bot->info);
889 irc_notice_user(bot, user, response);
890 } else if (!irccasecmp(text, "VERSION")) {
891 /* This function provides copyright management information
892 * to end users of srvx. You should not alter, disable or
893 * remove this command or its accessibility to normal IRC
894 * users, except to add copyright information pertaining
895 * to changes you make to srvx.
897 snprintf(response, sizeof(response), "\x01VERSION %s (%s) %s\x01", PACKAGE_STRING, CODENAME, git_version);
898 irc_notice_user(bot, user, response);
903 if (service->msg_hook && service->msg_hook(user, bot, text, server_qualified))
905 svccmd_invoke(user, service, NULL, text, server_qualified);
909 modcmd_chanmsg(struct userNode *user, struct chanNode *chan, const char *text, struct userNode *bot, unsigned int is_notice) {
910 struct service *service;
911 if (!(service = dict_find(services, bot->nick, NULL)))
913 svccmd_invoke(user, service, chan, text, 0);
918 service_register(struct userNode *bot) {
919 struct service *service;
920 if ((service = dict_find(services, bot->nick, NULL)))
922 service = calloc(1, sizeof(*service));
923 module_list_init(&service->modules);
924 service->commands = dict_new();
926 dict_set_free_data(service->commands, free_service_command);
927 dict_insert(services, service->bot->nick, service);
928 reg_privmsg_func(bot, modcmd_privmsg);
933 service_find(const char *name) {
934 return dict_find(services, name, NULL);
938 svccmd_insert(struct service *service, char *name, struct svccmd *svccmd, struct modcmd *modcmd) {
940 svccmd->parent = service;
942 svccmd->command = modcmd;
943 svccmd->command->bind_count++;
944 dict_insert(service->commands, svccmd->name, svccmd);
945 for (ii=0; ii<service->modules.used; ++ii) {
946 if (service->modules.list[ii] == svccmd->command->parent) break;
948 if (ii == service->modules.used) {
949 module_list_append(&service->modules, svccmd->command->parent);
954 service_bind_modcmd(struct service *service, struct modcmd *cmd, const char *name) {
955 struct svccmd *svccmd;
956 if ((svccmd = dict_find(service->commands, name, NULL))) {
957 if (svccmd->command == cmd) return svccmd;
958 log_module(MAIN_LOG, LOG_ERROR, "Tried to bind command %s.%s into service %s as %s, but already bound (as %s.%s).", cmd->parent->name, cmd->name, service->bot->nick, name, svccmd->command->parent->name, svccmd->command->name);
961 svccmd = calloc(1, sizeof(*svccmd));
962 svccmd_insert(service, strdup(name), svccmd, cmd);
963 svccmd_copy_rules(svccmd, cmd->defaults);
968 service_bind_module(struct service *service, struct module *module) {
970 struct modcmd *modcmd;
974 for (it = dict_first(module->commands); it; it = iter_next(it)) {
975 modcmd = iter_data(it);
976 if (!((modcmd->flags | modcmd->defaults->flags) & MODCMD_NO_DEFAULT_BIND))
977 if (service_bind_modcmd(service, modcmd, iter_key(it)))
983 /* This MUST return argc if the alias expansion code knows how to deal
984 * with every argument in argv; otherwise, it MUST return the index of
985 * an argument that the expansion code does not know how to deal with.
988 check_alias_args(char *argv[], unsigned int argc) {
991 for (arg=0; arg<argc; ++arg) {
992 if (argv[arg][0] != '$') {
994 } else if (argv[arg][1] == '$') {
996 } else if (isdigit(argv[arg][1])) {
1000 tmp = strtoul(argv[arg]+1, &end_num, 10);
1002 switch (end_num[0]) {
1006 if (end_num[1] == 0)
1008 else if (isdigit(end_num[1]))
1010 /* else fall through to default case */
1021 collapse_cmdname(char *argv[], unsigned int argc, char *dest) {
1022 unsigned int ii, pos, arg;
1027 for (ii=pos=0, arg=0; argv[arg][ii]; ) {
1028 if (argv[arg][ii] == '\\') {
1029 if (argv[arg][ii+1]) {
1030 /* escaping a real character just puts it in literally */
1031 dest[pos++] = argv[arg][++ii];
1032 } else if ((arg+1) == argc) {
1033 /* we ran to the end of the argument list; abort */
1036 /* escape at end of a word is a space */
1042 /* normal characters don't need escapes */
1043 dest[pos++] = argv[arg][ii++];
1050 static MODCMD_FUNC(cmd_bind) {
1051 struct service *service;
1052 struct svccmd *template, *newcmd;
1053 char *svcname, *dot;
1054 char newname[MAXLEN], cmdname[MAXLEN];
1055 unsigned int arg, diff;
1059 arg = collapse_cmdname(argv+2, argc-2, newname) + 2;
1061 reply("MSG_MISSING_PARAMS", cmd->name);
1064 diff = collapse_cmdname(argv+arg, argc-arg, cmdname);
1066 reply("MSG_MISSING_PARAMS", cmd->name);
1071 if (!(service = service_find(svcname))) {
1072 reply("MCMSG_UNKNOWN_SERVICE", svcname);
1076 if ((newcmd = dict_find(service->commands, newname, NULL))) {
1077 reply("MCMSG_ALREADY_BOUND", service->bot->nick, newname);
1081 if ((dot = strchr(cmdname, '.')) && (dot[1] == '*') && (dot[2] == 0)) {
1083 struct module *module;
1085 module = module_find((cmdname[0] == '*') ? cmdname+1 : cmdname);
1087 reply("MSG_MODULE_UNKNOWN", cmdname);
1090 count = service_bind_module(service, module);
1091 reply("MCMSG_MODULE_BOUND", count, module->name, service->bot->nick);
1094 newcmd = calloc(1, sizeof(*newcmd));
1095 newcmd->name = strdup(newname);
1096 newcmd->parent = service;
1097 if (!(template = svccmd_resolve_name(newcmd, cmdname))) {
1098 reply("MCMSG_UNKNOWN_COMMAND_2", cmdname, service->bot->nick);
1103 if (template->alias.used) {
1104 reply("MCMSG_CANNOT_DOUBLE_ALIAS");
1111 /* a more complicated alias; fix it up */
1115 nn = check_alias_args(argv+arg, argc-arg);
1116 if (nn+arg < argc) {
1117 reply("MCMSG_BAD_ALIAS_ARGUMENT", argv[nn+arg]);
1122 newcmd->alias.used = newcmd->alias.size = argc-arg;
1123 newcmd->alias.list = calloc(newcmd->alias.size, sizeof(newcmd->alias.list[0]));
1124 for (nn=0; nn<newcmd->alias.used; ++nn)
1125 newcmd->alias.list[nn] = strdup(argv[nn+arg]);
1128 svccmd_insert(service, newcmd->name, newcmd, template->command);
1129 svccmd_copy_rules(newcmd, template);
1130 reply("MCMSG_COMMAND_BOUND", newcmd->name, newcmd->parent->bot->nick);
1135 service_recheck_bindings(struct service *service, struct module *module) {
1139 for (it = dict_first(service->commands); it; it = iter_next(it)) {
1140 cmd = iter_data(it);
1141 if (cmd->command->parent == module) return 0;
1143 /* No more bindings, remove it from our list. */
1144 module_list_remove(&service->modules, module);
1148 static svccmd_unbind_func_t *suf_list;
1149 unsigned int suf_size, suf_used;
1152 reg_svccmd_unbind_func(svccmd_unbind_func_t handler) {
1153 if (suf_used == suf_size) {
1156 suf_list = realloc(suf_list, suf_size*sizeof(svccmd_unbind_func_t));
1159 suf_list = malloc(suf_size*sizeof(svccmd_unbind_func_t));
1162 suf_list[suf_used++] = handler;
1165 static MODCMD_FUNC(cmd_unbind) {
1166 struct service *service;
1167 struct userNode *bot;
1168 struct svccmd *bound;
1169 struct module *module;
1170 const char *svcname;
1171 unsigned int arg, ii;
1172 char cmdname[MAXLEN];
1176 arg = collapse_cmdname(argv+2, argc-2, cmdname) + 2;
1178 reply("MSG_MISSING_PARAMS", cmd->name);
1181 if (!(service = service_find(svcname))) {
1182 reply("MCMSG_UNKNOWN_SERVICE", svcname);
1185 if (!(bound = dict_find(service->commands, cmdname, NULL))) {
1186 reply("MCMSG_NO_COMMAND_BOUND", service->bot->nick, cmdname);
1189 if ((bound->command->flags & MODCMD_KEEP_BOUND) && (bound->command->bind_count == 1)) {
1190 reply("MCMSG_UNBIND_PROHIBITED", bound->command->name);
1194 for (ii=0; ii<suf_used; ii++)
1195 suf_list[ii](bound);
1196 /* If this command binding is removing itself, we must take care
1197 * not to dereference it after the dict_remove.
1199 bot = cmd->parent->bot;
1200 module = cmd->command->parent;
1201 dict_remove(service->commands, bound->name);
1202 send_message(user, bot, "MCMSG_COMMAND_UNBOUND", cmdname, service->bot->nick);
1203 if (service_recheck_bindings(service, module))
1204 send_message(user, bot, "MCMSG_HELPFILE_UNBOUND", module->name, module->name);
1208 static MODCMD_FUNC(cmd_readhelp) {
1209 const char *modname;
1210 struct module *module;
1211 struct helpfile *old_helpfile;
1212 struct timeval start, stop;
1216 if (!(module = module_find(modname))) {
1217 reply("MSG_MODULE_UNKNOWN", modname);
1220 if (!module->helpfile_name) {
1221 reply("MCMSG_NO_HELPFILE", module->name);
1224 old_helpfile = module->helpfile;
1225 gettimeofday(&start, NULL);
1226 module->helpfile = open_helpfile(module->helpfile_name, module->expand_help);
1227 if (!module->helpfile) {
1228 module->helpfile = old_helpfile;
1229 reply("MCMSG_HELPFILE_ERROR", module->helpfile_name);
1232 if (old_helpfile) close_helpfile(old_helpfile);
1233 gettimeofday(&stop, NULL);
1234 stop.tv_sec -= start.tv_sec;
1235 stop.tv_usec -= start.tv_usec;
1236 if (stop.tv_usec < 0) {
1238 stop.tv_usec += 1000000;
1240 reply("MCMSG_HELPFILE_READ", module->name, (unsigned long)stop.tv_sec, (unsigned long)stop.tv_usec/1000);
1244 static MODCMD_FUNC(cmd_help) {
1247 topic = (argc < 2) ? NULL : unsplit_string(argv+1, argc-1, NULL);
1248 return svccmd_send_help_2(user, cmd->parent, topic);
1251 static MODCMD_FUNC(cmd_timecmd) {
1252 struct timeval start, stop;
1253 char cmd_text[MAXLEN];
1255 unsplit_string(argv+1, argc-1, cmd_text);
1256 gettimeofday(&start, NULL);
1257 svccmd_invoke(user, cmd->parent, channel, cmd_text, 0);
1258 gettimeofday(&stop, NULL);
1259 stop.tv_sec -= start.tv_sec;
1260 stop.tv_usec -= start.tv_usec;
1261 if (stop.tv_usec < 0) {
1263 stop.tv_usec += 1000000;
1265 reply("MCMSG_COMMAND_TIME", cmd_text, (unsigned long)stop.tv_sec, (unsigned long)stop.tv_usec);
1269 static MODCMD_FUNC(cmd_command) {
1270 struct svccmd *svccmd;
1271 const char *cmd_name, *fmt_str;
1272 unsigned int flags, shown_flags, nn, pos;
1276 cmd_name = unsplit_string(argv+1, argc-1, NULL);
1277 if (!(svccmd = svccmd_resolve_name(cmd, cmd_name))) {
1278 reply("MCMSG_UNKNOWN_COMMAND_2", cmd_name, cmd->parent->bot->nick);
1281 pos = snprintf(buf, sizeof(buf), "%s.%s", svccmd->command->parent->name, svccmd->command->name);
1282 if (svccmd->alias.used) {
1284 unsplit_string((char**)svccmd->alias.list+1, svccmd->alias.used-1, buf+pos);
1285 reply("MCMSG_COMMAND_ALIASES", svccmd->name, buf);
1287 reply("MCMSG_COMMAND_BINDING", svccmd->name, buf);
1289 flags = svccmd->effective_flags;
1290 if ((svccmd->parent && svccmd->parent->privileged && !IsOper(user))
1291 || ((flags & MODCMD_REQUIRE_STAFF)
1292 && !IsOper(user) && !IsNetworkHelper(user) && !IsSupportHelper(user))) {
1293 reply("MCMSG_INSPECTION_REFUSED", svccmd->name);
1296 if (flags & MODCMD_DISABLED) {
1297 reply("MSG_COMMAND_DISABLED", svccmd->name);
1301 if (svccmd->min_opserv_level > 0) {
1302 reply("MCMSG_NEED_OPSERV_LEVEL", svccmd->min_opserv_level);
1303 shown_flags |= MODCMD_REQUIRE_OPER | MODCMD_REQUIRE_AUTHED;
1305 if (svccmd->min_channel_access > 0) {
1306 reply("MCMSG_NEED_CHANSERV_LEVEL", svccmd->min_channel_access);
1307 shown_flags |= MODCMD_REQUIRE_CHANUSER | MODCMD_REQUIRE_REGCHAN | MODCMD_REQUIRE_CHANNEL | MODCMD_REQUIRE_AUTHED;
1309 if (svccmd->req_account_flags) {
1310 for (nn=pos=0; nn<32; nn++) {
1311 if (!(svccmd->req_account_flags & (1 << nn))) continue;
1312 buf[pos++] = HANDLE_FLAGS[nn];
1315 reply("MCMSG_NEED_ACCOUNT_FLAGS", buf);
1316 shown_flags |= MODCMD_REQUIRE_AUTHED;
1318 if (!flags && !shown_flags) {
1319 reply("MCMSG_NEED_NOTHING", svccmd->name);
1322 if (flags & ~shown_flags & MODCMD_REQUIRE_HELPING) {
1323 reply("MCMSG_MUST_BE_HELPING");
1324 shown_flags |= MODCMD_REQUIRE_AUTHED | MODCMD_REQUIRE_STAFF;
1326 if (flags & ~shown_flags & MODCMD_REQUIRE_STAFF) {
1327 switch (flags & MODCMD_REQUIRE_STAFF) {
1328 default: case MODCMD_REQUIRE_STAFF:
1329 fmt_str = "MCMSG_NEED_STAFF_ACCESS";
1331 case MODCMD_REQUIRE_OPER:
1332 fmt_str = "MCMSG_NEED_STAFF_OPER";
1334 case MODCMD_REQUIRE_NETWORK_HELPER:
1335 fmt_str = "MCMSG_NEED_STAFF_NETHELPER";
1337 case MODCMD_REQUIRE_OPER|MODCMD_REQUIRE_NETWORK_HELPER:
1338 fmt_str = "MCMSG_NEED_STAFF_NETHELPER_OR_OPER";
1340 case MODCMD_REQUIRE_SUPPORT_HELPER:
1341 fmt_str = "MCMSG_NEED_STAFF_SHELPER";
1343 case MODCMD_REQUIRE_OPER|MODCMD_REQUIRE_SUPPORT_HELPER:
1344 fmt_str = "MCMSG_NEED_STAFF_SHELPER_OR_OPER";
1346 case MODCMD_REQUIRE_SUPPORT_HELPER|MODCMD_REQUIRE_NETWORK_HELPER:
1347 fmt_str = "MCMSG_NEED_STAFF_HELPER";
1351 shown_flags |= MODCMD_REQUIRE_AUTHED | MODCMD_REQUIRE_STAFF;
1353 if (flags & ~shown_flags & MODCMD_REQUIRE_JOINABLE) {
1354 reply("MCMSG_NEED_JOINABLE");
1355 shown_flags |= MODCMD_REQUIRE_CHANUSER;
1357 if (flags & ~shown_flags & MODCMD_REQUIRE_CHANUSER) {
1358 if (flags & ~shown_flags & MODCMD_IGNORE_CSUSPEND)
1359 reply("MCMSG_NEED_CHANUSER_CSUSPENDABLE");
1361 reply("MCMSG_NEED_CHANUSER");
1362 shown_flags |= MODCMD_IGNORE_CSUSPEND | MODCMD_REQUIRE_REGCHAN | MODCMD_REQUIRE_CHANNEL | MODCMD_REQUIRE_AUTHED;
1364 if (flags & ~shown_flags & MODCMD_REQUIRE_REGCHAN) {
1365 reply("MCMSG_NEED_REGCHAN");
1366 shown_flags |= MODCMD_REQUIRE_CHANNEL;
1368 if (flags & ~shown_flags & MODCMD_REQUIRE_CHANNEL)
1369 reply("MCMSG_NEED_CHANNEL");
1370 if (flags & ~shown_flags & MODCMD_REQUIRE_AUTHED)
1371 reply("MCMSG_NEED_AUTHED");
1372 if (flags & ~shown_flags & MODCMD_TOY)
1373 reply("MCMSG_IS_TOY", svccmd->name);
1374 if (flags & ~shown_flags & MODCMD_REQUIRE_QUALIFIED) {
1375 const char *botnick = svccmd->parent ? svccmd->parent->bot->nick : "SomeBot";
1376 reply("MCMSG_MUST_QUALIFY", botnick, svccmd->name, botnick);
1378 reply("MCMSG_END_REQUIREMENTS", svccmd->name);
1383 modcmd_describe_command(struct userNode *user, struct svccmd *cmd, struct svccmd *target) {
1384 char buf1[MAXLEN], buf2[MAXLEN];
1385 unsigned int ii, len, buf1_used, buf2_used;
1387 if (target->alias.used) {
1388 unsplit_string((char**)target->alias.list, target->alias.used, buf1);
1389 reply("MCMSG_COMMAND_ALIASES", target->name, buf1);
1391 snprintf(buf1, sizeof(buf1), "%s.%s", target->command->parent->name, target->command->name);
1392 reply("MCMSG_COMMAND_BINDING", target->name, buf1);
1394 for (ii = buf1_used = buf2_used = 0; modcmd_flags[ii].name; ++ii) {
1395 const struct modcmd_flag *flag = &modcmd_flags[ii];
1396 if (target->flags & flag->flag) {
1398 buf1[buf1_used++] = ',';
1399 len = strlen(flag->name);
1400 memcpy(buf1 + buf1_used, flag->name, len);
1402 } else if (target->effective_flags & flag->flag) {
1404 buf2[buf2_used++] = ',';
1405 len = strlen(flag->name);
1406 memcpy(buf2 + buf2_used, flag->name, len);
1411 buf1[buf1_used] = '\0';
1413 strcpy(buf1, user_find_message(user, "MSG_NONE"));
1415 buf2[buf2_used] = '\0';
1417 strcpy(buf2, user_find_message(user, "MSG_NONE"));
1418 reply("MCMSG_COMMAND_FLAGS", buf1, buf2);
1419 for (ii = buf1_used = buf2_used = 0; handle_flags[ii]; ++ii) {
1420 if (target->req_account_flags & (1 << ii))
1421 buf1[buf1_used++] = handle_flags[ii];
1422 else if (target->deny_account_flags & (1 << ii))
1423 buf2[buf2_used++] = handle_flags[ii];
1425 buf1[buf1_used] = buf2[buf2_used] = '\0';
1426 reply("MCMSG_COMMAND_ACCOUNT_FLAGS", buf1, buf2);
1427 reply("MCMSG_COMMAND_ACCESS_LEVEL", target->min_channel_access, target->min_opserv_level);
1428 reply("MCMSG_COMMAND_USES", target->name, target->uses);
1431 static MODCMD_FUNC(cmd_modcmd) {
1432 struct svccmd *svccmd;
1433 unsigned int arg, changed;
1434 char cmdname[MAXLEN];
1437 arg = collapse_cmdname(argv+1, argc-1, cmdname) + 1;
1439 reply("MSG_MISSING_PARAMS", cmd->name);
1442 if (!(svccmd = svccmd_resolve_name(cmd, cmdname))) {
1443 reply("MCMSG_UNKNOWN_COMMAND_2", cmdname, cmd->parent->bot->nick);
1446 for (changed = 0; arg+1 < argc; arg += 2) {
1447 if (svccmd_configure(svccmd, user, cmd->parent->bot, argv[arg], argv[arg+1])) {
1448 reply("MCMSG_COMMAND_MODIFIED", argv[arg], svccmd->name);
1453 modcmd_set_effective_flags(svccmd);
1454 modcmd_describe_command(user, cmd, svccmd);
1458 static MODCMD_FUNC(cmd_god) {
1462 if (enabled_string(argv[1])) {
1463 if (HANDLE_FLAGGED(user->handle_info, HELPING)) {
1464 reply("MCMSG_ALREADY_HELPING");
1468 } else if (disabled_string(argv[1])) {
1469 if (!HANDLE_FLAGGED(user->handle_info, HELPING)) {
1470 reply("MCMSG_ALREADY_NOT_HELPING");
1475 reply("MSG_INVALID_BINARY", argv[1]);
1479 helping = !IsHelping(user);
1483 HANDLE_SET_FLAG(user->handle_info, HELPING);
1484 reply("MCMSG_NOW_HELPING");
1486 HANDLE_CLEAR_FLAG(user->handle_info, HELPING);
1487 reply("MCMSG_NOW_NOT_HELPING");
1493 static MODCMD_FUNC(cmd_joiner) {
1494 char cmdname[MAXLEN];
1497 int len = sprintf(cmdname, "%s ", cmd->name);
1499 struct string_buffer sbuf;
1501 string_buffer_init(&sbuf);
1502 for (it = dict_first(cmd->parent->commands); it; it = iter_next(it)) {
1503 if (!ircncasecmp(iter_key(it), cmdname, len)) {
1504 if (sbuf.used) string_buffer_append_string(&sbuf, ", ");
1505 string_buffer_append_string(&sbuf, iter_key(it));
1508 if (!sbuf.used) string_buffer_append(&sbuf, 0);
1509 reply("MCMSG_JOINER_CHOICES", cmd->name, sbuf.list);
1510 string_buffer_clean(&sbuf);
1513 sprintf(cmdname, "%s %s", cmd->name, argv[1]);
1515 svccmd_invoke_argv(user, cmd->parent, channel, argc-1, argv+1, 0);
1516 return 0; /* never try to log this; the recursive one logs it */
1519 static MODCMD_FUNC(cmd_stats_modules) {
1520 struct helpfile_table tbl;
1524 struct modcmd *modcmd;
1527 tbl.length = dict_size(modules) + 1;
1529 tbl.flags = TABLE_PAD_LEFT;
1530 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1531 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1532 tbl.contents[0][0] = "Module";
1533 tbl.contents[0][1] = "Commands";
1534 tbl.contents[0][2] = "Helpfile";
1535 for (ii=1, it=dict_first(modules); it; it=iter_next(it), ii++) {
1536 mod = iter_data(it);
1537 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1538 tbl.contents[ii][0] = mod->name;
1539 tbl.contents[ii][1] = strtab(dict_size(mod->commands));
1540 tbl.contents[ii][2] = mod->helpfile_name ? mod->helpfile_name : "(none)";
1542 } else if (!(mod = dict_find(modules, argv[1], NULL))) {
1543 reply("MCMSG_UNKNOWN_MODULE", argv[1]);
1546 reply("MCMSG_MODULE_INFO", mod->name);
1547 tbl.length = dict_size(mod->commands) + 1;
1549 tbl.flags = TABLE_PAD_LEFT;
1550 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1551 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1552 tbl.contents[0][0] = "Command";
1553 tbl.contents[0][1] = "Min. Args";
1554 tbl.contents[0][2] = "Bind Count";
1555 for (ii=1, it=dict_first(mod->commands); it; it=iter_next(it), ii++) {
1556 modcmd = iter_data(it);
1557 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1558 tbl.contents[ii][0] = modcmd->name;
1559 tbl.contents[ii][1] = strtab(modcmd->min_argc);
1560 tbl.contents[ii][2] = strtab(modcmd->bind_count);
1563 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1567 static MODCMD_FUNC(cmd_stats_services) {
1568 struct helpfile_table tbl;
1571 struct service *service;
1572 struct svccmd *svccmd;
1576 tbl.length = dict_size(services) + 1;
1578 tbl.flags = TABLE_PAD_LEFT;
1579 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1580 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1581 tbl.contents[0][0] = "Service";
1582 tbl.contents[0][1] = "Commands";
1583 tbl.contents[0][2] = "Priv'd?";
1584 tbl.contents[0][3] = "Trigger";
1585 extra = calloc(2, tbl.length);
1586 for (ii=1, it=dict_first(services); it; it=iter_next(it), ii++) {
1587 service = iter_data(it);
1588 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1589 tbl.contents[ii][0] = service->bot->nick;
1590 tbl.contents[ii][1] = (service->commands && dict_size(service->commands) ? strtab(dict_size(service->commands)) : strtab(0));
1591 tbl.contents[ii][2] = service->privileged ? "yes" : "no";
1592 extra[ii*2] = service->trigger;
1593 tbl.contents[ii][3] = extra+ii*2;
1595 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1598 } else if (!(service = dict_find(services, argv[1], NULL))) {
1599 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1602 tbl.length = dict_size(service->commands) + 1;
1604 tbl.flags = TABLE_PAD_LEFT | TABLE_NO_FREE;
1605 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1606 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1607 tbl.contents[0][0] = "Command";
1608 tbl.contents[0][1] = "Module";
1609 tbl.contents[0][2] = "ModCmd";
1610 tbl.contents[0][3] = "Alias?";
1611 tbl.contents[0][4] = strdup("Uses");
1612 for (ii=1, it=dict_first(service->commands); it; it=iter_next(it), ii++) {
1613 svccmd = iter_data(it);
1614 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1615 tbl.contents[ii][0] = svccmd->name;
1616 tbl.contents[ii][1] = svccmd->command->parent->name;
1617 tbl.contents[ii][2] = svccmd->command->name;
1618 tbl.contents[ii][3] = svccmd->alias.used ? "yes" : "no";
1619 tbl.contents[ii][4] = extra = malloc(12);
1620 sprintf(extra, "%u", svccmd->uses);
1622 reply("MCMSG_SERVICE_INFO", service->bot->nick);
1623 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1624 for (ii=0; ii<tbl.length; ii++) {
1625 free((char*)tbl.contents[ii][4]);
1626 free(tbl.contents[ii]);
1633 static MODCMD_FUNC(cmd_showcommands) {
1634 struct svccmd_list commands;
1635 struct helpfile_table tbl;
1636 struct svccmd *svccmd;
1638 unsigned int ii, ignore_flags = 0;
1639 unsigned int max_opserv_level = 1000;
1640 unsigned short max_chanserv_level = 500;
1641 char show_opserv_level = 0, show_channel_access = 0;
1643 /* Check to see what the max access they want to see is. */
1644 for (ii=1; ii<argc; ++ii) {
1645 if (isdigit(argv[ii][0]))
1646 max_opserv_level = atoi(argv[ii]);
1648 max_chanserv_level = user_level_from_name(argv[ii], UL_OWNER);
1651 /* Find the matching commands. */
1652 svccmd_list_init(&commands);
1653 if (cmd->parent->privileged)
1654 ignore_flags = MODCMD_REQUIRE_OPER;
1655 for (it = dict_first(cmd->parent->commands); it; it = iter_next(it)) {
1656 svccmd = iter_data(it);
1657 if (strchr(svccmd->name, ' '))
1659 if (!svccmd_can_invoke(user, svccmd->parent->bot, svccmd, channel, SVCCMD_QUALIFIED))
1661 if (svccmd->min_opserv_level > max_opserv_level)
1663 if (svccmd->min_channel_access > max_chanserv_level)
1665 if (svccmd->min_opserv_level > 0)
1666 show_opserv_level = 1;
1667 if (svccmd->min_channel_access > 0)
1668 show_channel_access = 1;
1669 if (svccmd->effective_flags
1670 & (MODCMD_REQUIRE_STAFF|MODCMD_REQUIRE_HELPING)
1672 show_channel_access = 1;
1674 svccmd_list_append(&commands, svccmd);
1677 /* Build the table. */
1678 tbl.length = commands.used + 1;
1679 tbl.width = 1 + show_opserv_level + show_channel_access;
1680 tbl.flags = TABLE_REPEAT_ROWS;
1681 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1682 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1683 tbl.contents[0][ii = 0] = "Command";
1684 if (show_opserv_level)
1685 tbl.contents[0][++ii] = "OpServ Level";
1686 if (show_channel_access)
1687 tbl.contents[0][++ii] = "ChanServ Access";
1688 for (ii=0; ii<commands.used; ++ii) {
1689 svccmd = commands.list[ii];
1690 tbl.contents[ii+1] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1691 tbl.contents[ii+1][0] = svccmd->name;
1692 if (show_opserv_level)
1693 tbl.contents[ii+1][1] = strtab(svccmd->min_opserv_level);
1694 if (show_channel_access) {
1695 const char *access_name;
1696 int flags = svccmd->effective_flags;
1697 if (flags & MODCMD_REQUIRE_HELPING)
1698 access_name = "helping";
1699 else if (flags & MODCMD_REQUIRE_STAFF) {
1700 if (flags & MODCMD_REQUIRE_OPER)
1701 access_name = "oper";
1702 else if (flags & MODCMD_REQUIRE_NETWORK_HELPER)
1703 access_name = "net.helper";
1705 access_name = "staff";
1707 access_name = strtab(svccmd->min_channel_access);
1708 tbl.contents[ii+1][1+show_opserv_level] = access_name;
1711 svccmd_list_clean(&commands);
1712 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1716 static MODCMD_FUNC(cmd_helpfiles) {
1717 struct service *service;
1720 if (!(service = dict_find(services, argv[1], NULL))) {
1721 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1726 for (ii=0; ii<service->modules.used; ++ii)
1727 reply("MCMSG_HELPFILE_SEQUENCE", ii+1, service->modules.list[ii]->name);
1731 service->modules.used = 0;
1732 for (ii=0; ii<argc-2; ii++) {
1733 struct module *module = dict_find(modules, argv[ii+2], NULL);
1735 reply("MCMSG_UNKNOWN_MODULE", argv[ii+2]);
1738 module_list_append(&service->modules, module);
1740 reply("MCMSG_HELPFILE_SEQUENCE_SET", service->bot->nick);
1744 static MODCMD_FUNC(cmd_service_add) {
1745 const char *nick, *hostname, *desc;
1746 struct userNode *bot;
1749 if (!is_valid_nick(nick)) {
1750 reply("MCMSG_BAD_SERVICE_NICK", nick);
1754 desc = unsplit_string(argv+3, argc-3, NULL);
1755 bot = GetUserH(nick);
1756 if (bot && IsService(bot)) {
1757 reply("MCMSG_ALREADY_SERVICE", bot->nick);
1760 bot = AddLocalUser(nick, nick, hostname, desc, NULL);
1761 service_register(bot);
1762 reply("MCMSG_NEW_SERVICE", bot->nick);
1766 static MODCMD_FUNC(cmd_service_rename) {
1767 struct service *service;
1769 if (!(service = service_find(argv[1]))) {
1770 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1773 NickChange(service->bot, argv[2], 0);
1774 reply("MCMSG_SERVICE_RENAMED", service->bot->nick);
1778 static MODCMD_FUNC(cmd_service_trigger) {
1779 struct userNode *bogon;
1780 struct service *service;
1783 if (!(service = service_find(argv[1]))) {
1784 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1788 if (service->trigger)
1789 reply("MCMSG_CURRENT_TRIGGER", service->bot->nick, service->trigger);
1791 reply("MCMSG_NO_TRIGGER", service->bot->nick);
1794 if (service->trigger) {
1795 old_oc = offchannel_allowed[(unsigned char)service->trigger];
1796 offchannel_allowed[(unsigned char)service->trigger] = 0;
1797 reg_chanmsg_func(service->trigger, NULL, NULL);
1799 if (!irccasecmp(argv[2], "none") || !irccasecmp(argv[2], "remove")) {
1800 offchannel_allowed[(unsigned char)service->trigger] = 0;
1801 service->trigger = 0;
1802 reply("MCMSG_REMOVED_TRIGGER", service->bot->nick);
1803 } else if ((bogon = get_chanmsg_bot(argv[2][0]))) {
1804 reply("MCMSG_DUPLICATE_TRIGGER", bogon->nick, argv[2][0]);
1807 service->trigger = argv[2][0];
1808 offchannel_allowed[(unsigned char)service->trigger] = old_oc;
1809 reg_chanmsg_func(service->trigger, service->bot, modcmd_chanmsg);
1810 reply("MCMSG_NEW_TRIGGER", service->bot->nick, service->trigger);
1815 static MODCMD_FUNC(cmd_service_offchannel) {
1816 struct service *service;
1818 if (!(service = service_find(argv[1]))) {
1819 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1823 if(!service->trigger) {
1824 reply("MCMSG_NO_TRIGGER", service->bot->nick);
1829 if(offchannel_allowed[(unsigned char)service->trigger])
1830 reply("MCMSG_OFFCHANNEL_IS_ON", service->bot->nick, service->trigger);
1832 reply("MCMSG_OFFCHANNEL_IS_OFF", service->bot->nick, service->trigger);
1836 if(enabled_string(argv[2])) {
1837 offchannel_allowed[(unsigned char)service->trigger] = 1;
1838 reply("MCMSG_OFFCHANNEL_ON", service->bot->nick, service->trigger);
1839 } else if(disabled_string(argv[2])) {
1840 offchannel_allowed[(unsigned char)service->trigger] = 0;
1841 reply("MCMSG_OFFCHANNEL_OFF", service->bot->nick, service->trigger);
1843 reply("MSG_INVALID_BINARY", argv[2]);
1850 static MODCMD_FUNC(cmd_service_privileged) {
1851 struct service *service;
1854 if (!(service = service_find(argv[1]))) {
1855 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1859 service->privileged = true_string(argv[2]) || enabled_string(argv[2]);
1860 newval = user_find_message(user, service->privileged ? "MSG_ON" : "MSG_OFF");
1861 reply("MCMSG_SERVICE_PRIVILEGED", service->bot->nick, newval);
1865 static MODCMD_FUNC(cmd_service_remove) {
1866 char *name, *reason;
1867 struct service *service;
1871 reason = unsplit_string(argv+2, argc-2, NULL);
1873 reason = "Removing bot";
1874 if (!(service = service_find(name))) {
1875 reply("MCMSG_UNKNOWN_SERVICE", name);
1878 DelUser(service->bot, NULL, 1, reason);
1879 reply("MCMSG_SERVICE_REMOVED", name);
1880 dict_remove(services, name);
1884 static MODCMD_FUNC(cmd_dump_messages) {
1885 const char *fname = "strings.db";
1886 struct saxdb_context *ctx;
1891 if (!(pf = fopen(fname, "w"))) {
1892 reply("MCMSG_FILE_NOT_OPENED", fname);
1895 if (!(ctx = saxdb_open_context(pf))) {
1896 reply("MSG_INTERNAL_FAILURE");
1899 if ((res = setjmp(*saxdb_jmp_buf(ctx))) != 0) {
1900 saxdb_close_context(ctx, 1);
1901 reply("MCMSG_MESSAGE_DUMP_FAILED", strerror(res));
1904 for (it = dict_first(lang_C->messages); it; it = iter_next(it))
1905 saxdb_write_string(ctx, iter_key(it), iter_data(it));
1906 saxdb_close_context(ctx, 1);
1907 reply("MCMSG_MESSAGES_DUMPED", fname);
1912 static MODCMD_FUNC(cmd_version) {
1913 /* This function provides copyright management information to end
1914 * users of srvx. You should not alter, disable or remove this
1915 * command or its accessibility to normal IRC users, except to add
1916 * copyright information pertaining to changes you make to srvx.
1918 send_message_type(4, user, cmd->parent->bot, "$b"PACKAGE_STRING"$b ("CODENAME"), Built: "__DATE__", "__TIME__". Copyright 2000-2008 srvx Development Team.");
1920 send_message_type(4, user, cmd->parent->bot, "%s", git_version);
1922 send_message_type(12, user, cmd->parent->bot, "The srvx Development Team includes Paul Chang, Adrian Dewhurst, Miles Peterson, Michael Poole and others.\nThe srvx Development Team can be reached at http://sf.net/projects/srvx/ or in #srvx on irc.gamesurge.net.");
1926 static MODCMD_FUNC(cmd_tell) {
1927 struct userNode *target;
1930 target = GetUserH(argv[1]);
1931 msg = unsplit_string(argv + 2, argc - 2, NULL);
1933 reply("MSG_NOT_TARGET_NAME");
1936 send_message_type(MSG_TYPE_NOXLATE, target, cmd->parent->bot, "%s", msg);
1941 modcmd_nick_change(struct userNode *user, const char *old_nick) {
1942 struct service *svc;
1943 if (!(svc = dict_find(services, old_nick, NULL)))
1945 dict_remove2(services, old_nick, 1);
1946 dict_insert(services, user->nick, svc);
1950 modcmd_cleanup(void) {
1951 dict_delete(services);
1952 dict_delete(modules);
1958 modcmd_saxdb_write_command(struct saxdb_context *ctx, struct svccmd *cmd) {
1960 unsigned int nn, len, pos;
1961 struct svccmd *template = cmd->command->defaults;
1963 saxdb_start_record(ctx, cmd->name, 0);
1964 sprintf(buf, "%s.%s", cmd->command->parent->name, cmd->command->name);
1965 saxdb_write_string(ctx, "command", buf);
1966 if (cmd->alias.used)
1967 saxdb_write_string_list(ctx, "aliased", &cmd->alias);
1968 if (cmd->min_opserv_level != template->min_opserv_level)
1969 saxdb_write_int(ctx, "oper_access", cmd->min_opserv_level);
1970 if (cmd->min_channel_access != template->min_channel_access)
1971 saxdb_write_int(ctx, "channel_access", cmd->min_channel_access);
1972 if (cmd->flags != template->flags) {
1974 for (nn=pos=0; modcmd_flags[nn].name; ++nn) {
1975 const struct modcmd_flag *flag = &modcmd_flags[nn];
1976 if (cmd->flags & flag->flag) {
1978 len = strlen(flag->name);
1979 memcpy(buf+pos, flag->name, len);
1988 saxdb_write_string(ctx, "flags", buf);
1990 if ((cmd->req_account_flags != template->req_account_flags)
1991 || (cmd->deny_account_flags != template->req_account_flags)) {
1993 if (cmd->req_account_flags) {
1995 for (nn=0; nn<32; nn++)
1996 if (cmd->req_account_flags & (1 << nn))
1997 buf[pos++] = handle_flags[nn];
1999 if (cmd->deny_account_flags) {
2001 for (nn=0; nn<32; nn++)
2002 if (cmd->deny_account_flags & (1 << nn))
2003 buf[pos++] = handle_flags[nn];
2006 saxdb_write_string(ctx, "account_flags", buf);
2008 saxdb_end_record(ctx);
2012 modcmd_saxdb_write(struct saxdb_context *ctx) {
2013 struct string_list slist;
2014 dict_iterator_t it, it2;
2015 struct service *service;
2018 saxdb_start_record(ctx, "bots", 1);
2019 for (it = dict_first(services); it; it = iter_next(it)) {
2023 service = iter_data(it);
2024 saxdb_start_record(ctx, service->bot->nick, 1);
2025 if (service->trigger) {
2026 buff[0] = service->trigger;
2028 saxdb_write_string(ctx, "trigger", buff);
2029 if(offchannel_allowed[(unsigned char)service->trigger])
2030 saxdb_write_int(ctx, "offchannel", 1);
2032 saxdb_write_string(ctx, "description", service->bot->info);
2033 saxdb_write_string(ctx, "hostname", service->bot->hostname);
2034 if (service->bot->modes) {
2035 irc_user_modes(service->bot, modes, sizeof(modes));
2036 saxdb_write_string(ctx, "modes", modes);
2038 if (service->privileged)
2039 saxdb_write_string(ctx, "privileged", "1");
2040 saxdb_end_record(ctx);
2042 saxdb_end_record(ctx);
2044 saxdb_start_record(ctx, "services", 1);
2045 for (it = dict_first(services); it; it = iter_next(it)) {
2046 service = iter_data(it);
2047 saxdb_start_record(ctx, service->bot->nick, 1);
2048 for (it2 = dict_first(service->commands); it2; it2 = iter_next(it2))
2049 modcmd_saxdb_write_command(ctx, iter_data(it2));
2050 saxdb_end_record(ctx);
2052 saxdb_end_record(ctx);
2054 saxdb_start_record(ctx, "helpfiles", 1);
2056 for (it = dict_first(services); it; it = iter_next(it)) {
2057 service = iter_data(it);
2059 for (ii = 0; ii < service->modules.used; ++ii)
2060 string_list_append(&slist, service->modules.list[ii]->name);
2061 saxdb_write_string_list(ctx, iter_key(it), &slist);
2065 saxdb_end_record(ctx);
2071 append_entry(const char *key, UNUSED_ARG(void *data), void *extra) {
2072 struct helpfile_expansion *exp = extra;
2073 int row = exp->value.table.length++;
2074 exp->value.table.contents[row] = calloc(1, sizeof(char*));
2075 exp->value.table.contents[row][0] = key;
2079 static struct helpfile_expansion
2080 modcmd_expand(const char *variable) {
2081 struct helpfile_expansion exp;
2082 extern struct userNode *message_source;
2083 struct service *service;
2085 service = dict_find(services, message_source->nick, NULL);
2086 if (!irccasecmp(variable, "index")) {
2087 exp.type = HF_TABLE;
2088 exp.value.table.length = 1;
2089 exp.value.table.width = 1;
2090 exp.value.table.flags = TABLE_REPEAT_ROWS;
2091 exp.value.table.contents = calloc(dict_size(service->commands)+1, sizeof(char**));
2092 exp.value.table.contents[0] = calloc(1, sizeof(char*));
2093 exp.value.table.contents[0][0] = "Commands:";
2094 dict_foreach(service->commands, append_entry, &exp);
2096 } else if (!irccasecmp(variable, "languages")) {
2097 struct string_buffer sbuf;
2099 sbuf.used = sbuf.size = 0;
2101 for (it = dict_first(languages); it; it = iter_next(it)) {
2102 string_buffer_append_string(&sbuf, iter_key(it));
2103 string_buffer_append(&sbuf, ' ');
2105 sbuf.list[--sbuf.used] = 0;
2106 exp.type = HF_STRING;
2107 exp.value.str = sbuf.list;
2110 exp.type = HF_STRING;
2111 exp.value.str = NULL;
2116 modcmd_load_bots(struct dict *db, int default_nick) {
2119 for (it = dict_first(db); it; it = iter_next(it)) {
2120 struct record_data *rd;
2121 struct service *svc;
2122 const char *nick, *desc, *hostname, *modes;
2125 if (rd->type != RECDB_OBJECT) {
2126 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'bots/%s' in modcmd db (expected object).", iter_key(it));
2129 nick = database_get_data(rd->d.object, "nick", RECDB_QSTRING);
2132 nick = iter_key(it);
2136 svc = service_find(nick);
2137 desc = database_get_data(rd->d.object, "description", RECDB_QSTRING);
2138 hostname = database_get_data(rd->d.object, "hostname", RECDB_QSTRING);
2139 modes = database_get_data(rd->d.object, "modes", RECDB_QSTRING);
2142 svc = service_register(AddLocalUser(nick, nick, hostname, desc, modes));
2144 strcpy(svc->bot->hostname, hostname);
2145 desc = database_get_data(rd->d.object, "trigger", RECDB_QSTRING);
2147 svc->trigger = desc[0];
2148 desc = database_get_data(rd->d.object, "offchannel", RECDB_QSTRING);
2150 offchannel_allowed[(unsigned char)svc->trigger] = atoi(desc);
2152 desc = database_get_data(rd->d.object, "privileged", RECDB_QSTRING);
2153 if (desc && (true_string(desc) || enabled_string(desc)))
2154 svc->privileged = 1;
2160 modcmd_conf_read(void) {
2161 modcmd_load_bots(conf_get_data("services", RECDB_OBJECT), 0);
2166 qsort(modcmd_flags, ArrayLength(modcmd_flags)-1, sizeof(modcmd_flags[0]), flags_qsort);
2167 modules = dict_new();
2168 dict_set_free_data(modules, free_module);
2169 services = dict_new();
2170 dict_set_free_data(services, free_service);
2171 reg_nick_change_func(modcmd_nick_change);
2172 reg_exit_func(modcmd_cleanup);
2173 conf_register_reload(modcmd_conf_read);
2175 modcmd_module = module_register("modcmd", MAIN_LOG, "modcmd.help", modcmd_expand);
2176 bind_command = modcmd_register(modcmd_module, "bind", cmd_bind, 4, MODCMD_KEEP_BOUND, "oper_level", "800", NULL);
2177 help_command = modcmd_register(modcmd_module, "help", cmd_help, 1, 0, "flags", "+nolog", NULL);
2178 modcmd_register(modcmd_module, "command", cmd_command, 2, 0, "flags", "+nolog", NULL);
2179 modcmd_register(modcmd_module, "modcmd", cmd_modcmd, 2, MODCMD_KEEP_BOUND, "template", "bind", NULL);
2180 modcmd_register(modcmd_module, "god", cmd_god, 0, MODCMD_REQUIRE_AUTHED, "flags", "+oper,+networkhelper", NULL);
2181 modcmd_register(modcmd_module, "readhelp", cmd_readhelp, 2, 0, "oper_level", "650", NULL);
2182 modcmd_register(modcmd_module, "timecmd", cmd_timecmd, 2, 0, "oper_level", "1", NULL);
2183 modcmd_register(modcmd_module, "unbind", cmd_unbind, 3, 0, "template", "bind", NULL);
2184 modcmd_register(modcmd_module, "joiner", cmd_joiner, 1, 0, NULL);
2185 modcmd_register(modcmd_module, "stats modules", cmd_stats_modules, 1, 0, "flags", "+oper", NULL);
2186 modcmd_register(modcmd_module, "stats services", cmd_stats_services, 1, 0, "flags", "+oper", NULL);
2187 modcmd_register(modcmd_module, "showcommands", cmd_showcommands, 1, 0, "flags", "+acceptchan", NULL);
2188 modcmd_register(modcmd_module, "helpfiles", cmd_helpfiles, 2, 0, "template", "bind", NULL);
2189 modcmd_register(modcmd_module, "service add", cmd_service_add, 4, 0, "flags", "+oper", NULL);
2190 modcmd_register(modcmd_module, "service rename", cmd_service_rename, 3, 0, "flags", "+oper", NULL);
2191 modcmd_register(modcmd_module, "service trigger", cmd_service_trigger, 2, 0, "flags", "+oper", NULL);
2192 modcmd_register(modcmd_module, "service offchannel", cmd_service_offchannel, 2, 0, "flags", "+oper", NULL);
2193 modcmd_register(modcmd_module, "service privileged", cmd_service_privileged, 2, 0, "flags", "+oper", NULL);
2194 modcmd_register(modcmd_module, "service remove", cmd_service_remove, 2, 0, "flags", "+oper", NULL);
2195 modcmd_register(modcmd_module, "dumpmessages", cmd_dump_messages, 1, 0, "oper_level", "1000", NULL);
2196 modcmd_register(modcmd_module, "tell", cmd_tell, 3, 0, "flags", "+oper", NULL);
2197 version_command = modcmd_register(modcmd_module, "version", cmd_version, 1, 0, NULL);
2198 message_register_table(msgtab);
2202 modcmd_db_load_command(struct service *service, const char *cmdname, struct dict *obj) {
2203 struct svccmd *svccmd;
2204 struct module *module;
2205 struct modcmd *modcmd;
2206 struct string_list *slist;
2207 const char *str, *sep;
2210 str = database_get_data(obj, "command", RECDB_QSTRING);
2212 log_module(MAIN_LOG, LOG_ERROR, "Missing command for service %s command %s in modcmd.db", service->bot->nick, cmdname);
2215 sep = strchr(str, '.');
2217 log_module(MAIN_LOG, LOG_ERROR, "Invalid command %s for service %s command %s in modcmd.db", str, service->bot->nick, cmdname);
2220 memcpy(buf, str, sep-str);
2222 if (!(module = module_find(buf))) {
2223 log_module(MAIN_LOG, LOG_ERROR, "Unknown module %s for service %s command %s in modcmd.db", buf, service->bot->nick, cmdname);
2226 if (!(modcmd = dict_find(module->commands, sep+1, NULL))) {
2227 log_module(MAIN_LOG, LOG_ERROR, "Unknown command %s in module %s for service %s command %s", sep+1, module->name, service->bot->nick, cmdname);
2230 /* Now that we know we have a command to use, fill in the basics. */
2231 svccmd = calloc(1, sizeof(*svccmd));
2232 svccmd_insert(service, strdup(cmdname), svccmd, modcmd);
2233 if ((str = database_get_data(obj, "template", RECDB_QSTRING))) {
2234 add_pending_template(svccmd, str);
2236 svccmd_copy_rules(svccmd, modcmd->defaults);
2238 if ((str = database_get_data(obj, "account_flags", RECDB_QSTRING))) {
2239 svccmd->req_account_flags = svccmd->deny_account_flags = 0;
2240 svccmd_configure(svccmd, NULL, service->bot, "account_flags", str);
2242 if ((str = database_get_data(obj, "flags", RECDB_QSTRING))) {
2244 svccmd_configure(svccmd, NULL, service->bot, "flags", str);
2246 if ((str = database_get_data(obj, "oper_access", RECDB_QSTRING))
2247 || (str = database_get_data(obj, "opserv_level", RECDB_QSTRING))) {
2248 svccmd_configure(svccmd, NULL, service->bot, "oper_access", str);
2250 if ((str = database_get_data(obj, "channel_access", RECDB_QSTRING))
2251 || (str = database_get_data(obj, "chanserv_level", RECDB_QSTRING))) {
2252 svccmd_configure(svccmd, NULL, service->bot, "channel_access", str);
2254 if ((slist = database_get_data(obj, "aliased", RECDB_STRING_LIST))) {
2256 svccmd->alias.used = svccmd->alias.size = slist->used;
2257 svccmd->alias.list = calloc(svccmd->alias.size, sizeof(svccmd->alias.list[0]));
2258 for (nn=0; nn<slist->used; ++nn)
2259 svccmd->alias.list[nn] = strdup(slist->list[nn]);
2261 modcmd_set_effective_flags(svccmd);
2264 static struct svccmd *
2265 service_make_alias(struct service *service, const char *alias, ...) {
2266 char *arg, *argv[MAXNUMPARAMS];
2267 unsigned int nn, argc;
2268 struct svccmd *svccmd, *template;
2271 va_start(args, alias);
2274 arg = va_arg(args, char*);
2280 svccmd = calloc(1, sizeof(*svccmd));
2281 if (!(template = svccmd_resolve_name(svccmd, argv[0]))) {
2282 log_module(MAIN_LOG, LOG_ERROR, "Invalid base command %s for alias %s in service %s", argv[0], alias, service->bot->nick);
2288 svccmd->alias.used = svccmd->alias.size = argc;
2289 svccmd->alias.list = calloc(svccmd->alias.size, sizeof(svccmd->alias.list[0]));
2290 for (nn=0; nn<argc; nn++)
2291 svccmd->alias.list[nn] = strdup(argv[nn]);
2293 svccmd_insert(service, strdup(alias), svccmd, template->command);
2294 svccmd_copy_rules(svccmd, template);
2298 static int saxdb_present;
2301 modcmd_saxdb_read(struct dict *db) {
2303 dict_iterator_t it, it2;
2304 struct record_data *rd, *rd2;
2305 struct service *service;
2307 modcmd_load_bots(database_get_data(db, "bots", RECDB_OBJECT), 1);
2308 db2 = database_get_data(db, "services", RECDB_OBJECT);
2310 log_module(MAIN_LOG, LOG_ERROR, "Missing section 'services' in modcmd db.");
2313 for (it = dict_first(db2); it; it = iter_next(it)) {
2315 if (rd->type != RECDB_OBJECT) {
2316 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'services/%s' in modcmd db (expected object).", iter_key(it));
2319 if (!(service = service_find(iter_key(it)))) {
2320 log_module(MAIN_LOG, LOG_ERROR, "Unknown service '%s' listed in modcmd db.", iter_key(it));
2323 for (it2 = dict_first(rd->d.object); it2; it2 = iter_next(it2)) {
2324 rd2 = iter_data(it2);
2325 if (rd2->type != RECDB_OBJECT) {
2326 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'services/%s/%s' in modcmd db (expected object).", iter_key(it), iter_key(it2));
2329 modcmd_db_load_command(service, iter_key(it2), rd2->d.object);
2332 db2 = database_get_data(db, "helpfiles", RECDB_OBJECT);
2333 for (it = dict_first(db2); it; it = iter_next(it)) {
2334 struct module *module;
2335 struct string_list *slist;
2339 if (rd->type != RECDB_STRING_LIST) {
2340 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'helpfiles/%s' in modcmd db (expected string list).", iter_key(it));
2343 slist = rd->d.slist;
2344 if (!(service = service_find(iter_key(it)))) {
2345 /* We probably whined about the service being missing above. */
2348 service->modules.used = 0;
2349 for (ii=0; ii<slist->used; ++ii) {
2350 if (!(module = dict_find(modules, slist->list[ii], NULL))) {
2351 log_module(MAIN_LOG, LOG_ERROR, "Unknown module '%s' listed in modcmd 'helpfiles/%s'.", slist->list[ii], iter_key(it));
2354 module_list_append(&service->modules, module);
2362 create_default_binds(void) {
2363 /* Which services should import which modules by default? */
2365 const char *svcname;
2366 /* C is lame and requires a fixed size for this array.
2367 * Be sure you NULL-terminate each array and increment the
2368 * size here if you add more default modules to any
2370 const char *modnames[8];
2372 { "ChanServ", { "ChanServ", NULL } },
2373 { "Global", { "Global", NULL } },
2374 { "NickServ", { "NickServ", NULL } },
2375 { "OpServ", { "OpServ", "modcmd", "sendmail", "saxdb", "proxycheck", NULL } },
2378 unsigned int ii, jj;
2379 char buf[128], *nick;
2380 struct service *service;
2381 struct module *module;
2383 for (ii = 0; def_binds[ii].svcname; ++ii) {
2384 sprintf(buf, "services/%s/nick", def_binds[ii].svcname);
2385 if (!(nick = conf_get_data(buf, RECDB_QSTRING)))
2387 if (!(service = service_find(nick)))
2389 if (dict_size(service->commands) > 0)
2392 /* Bind the default modules for this service to it */
2393 for (jj = 0; def_binds[ii].modnames[jj]; ++jj) {
2394 if (!(module = module_find(def_binds[ii].modnames[jj])))
2396 service_bind_module(service, module);
2399 /* Bind the help and version commands to this service */
2400 service_bind_modcmd(service, help_command, help_command->name);
2401 service_bind_modcmd(service, version_command, version_command->name);
2403 /* Now some silly hax.. (aliases that most people want) */
2404 if (!irccasecmp(def_binds[ii].svcname, "ChanServ")) {
2405 service_make_alias(service, "addowner", "*chanserv.adduser", "$1", "owner", NULL);
2406 service_make_alias(service, "addcoowner", "*chanserv.adduser", "$1", "coowner", NULL);
2407 service_make_alias(service, "addmaster", "*chanserv.adduser", "$1", "master", NULL);
2408 service_make_alias(service, "addop", "*chanserv.adduser", "$1", "op", NULL);
2409 service_make_alias(service, "addpeon", "*chanserv.adduser", "$1", "peon", NULL);
2410 service_make_alias(service, "delowner", "*chanserv.deluser", "owner", "$1", NULL);
2411 service_make_alias(service, "delcoowner", "*chanserv.deluser", "coowner", "$1", NULL);
2412 service_make_alias(service, "delmaster", "*chanserv.deluser", "master", "$1", NULL);
2413 service_make_alias(service, "delop", "*chanserv.deluser", "op", "$1", NULL);
2414 service_make_alias(service, "delpeon", "*chanserv.deluser", "peon", "$1", NULL);
2415 service_make_alias(service, "command", "*modcmd.command", NULL);
2416 service_make_alias(service, "god", "*modcmd.god", NULL);
2417 } else if (!irccasecmp(def_binds[ii].svcname, "OpServ")) {
2418 struct svccmd *svccmd;
2419 svccmd = service_make_alias(service, "stats", "*modcmd.joiner", NULL);
2420 svccmd->min_opserv_level = 101;
2421 svccmd = service_make_alias(service, "devnull", "*modcmd.joiner", NULL);
2422 svccmd->min_opserv_level = 200;
2423 svccmd = service_make_alias(service, "service", "*modcmd.joiner", NULL);
2424 svccmd->min_opserv_level = 900;
2430 import_aliases_db() {
2432 dict_iterator_t it, it2;
2433 struct record_data *rd, *rd2;
2434 struct service *service;
2435 struct module *module;
2437 if (!(db = parse_database("aliases.db")))
2439 for (it = dict_first(db); it; it = iter_next(it)) {
2440 service = service_find(iter_key(it));
2443 module = module_find(service->bot->nick);
2445 if (rd->type != RECDB_OBJECT)
2447 for (it2 = dict_first(rd->d.object); it2; it2 = iter_next(it2)) {
2448 struct modcmd *command;
2449 rd2 = iter_data(it2);
2450 if (rd2->type != RECDB_QSTRING)
2452 command = dict_find(module->commands, rd2->d.qstring, NULL);
2455 service_bind_modcmd(service, command, iter_key(it2));
2461 modcmd_finalize(void) {
2464 /* Check databases. */
2465 saxdb_register("modcmd", modcmd_saxdb_read, modcmd_saxdb_write);
2466 create_default_binds();
2468 import_aliases_db();
2470 /* Register services for their triggers. */
2471 for (it = dict_first(services); it; it = iter_next(it)) {
2472 struct service *svc = iter_data(it);
2474 reg_chanmsg_func(svc->trigger, svc->bot, modcmd_chanmsg);
2477 /* Resolve command rule-templates. */
2478 while (pending_templates) {
2479 struct pending_template *ptempl = pending_templates;
2480 struct svccmd *svccmd;
2482 pending_templates = ptempl->next;
2483 /* Only overwrite the current template if we have a valid template. */
2484 if (!strcmp(ptempl->base, "*")) {
2486 } else if ((svccmd = svccmd_resolve_name(ptempl->cmd, ptempl->base))) {
2487 svccmd_copy_rules(ptempl->cmd, svccmd);
2489 assert(ptempl->cmd->parent);
2490 log_module(MAIN_LOG, LOG_ERROR, "Unable to resolve template name %s for command %s in service %s.", ptempl->base, ptempl->cmd->name, ptempl->cmd->parent->bot->nick);