1 /* modcmd.c - Generalized module command support
2 * Copyright 2002-2004 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.
21 #include "arch-version.h"
27 struct pending_template {
30 struct pending_template *next;
33 static struct dict *modules;
34 static struct dict *services;
35 static struct pending_template *pending_templates;
36 static struct module *modcmd_module;
37 static struct modcmd *bind_command, *help_command, *version_command;
38 static const struct message_entry msgtab[] = {
39 { "MCMSG_VERSION", "$b"PACKAGE_STRING"$b ("CODENAME"), Built: " __DATE__ ", " __TIME__"." },
40 { "MCMSG_BARE_FLAG", "Flag %.*s must be preceeded by a + or -." },
41 { "MCMSG_UNKNOWN_FLAG", "Unknown module flag %.*s." },
42 { "MCMSG_BAD_OPSERV_LEVEL", "Invalid $O access level %s." },
43 { "MCMSG_BAD_CHANSERV_LEVEL", "Invalid $C access level %s." },
44 { "MCMSG_LEVEL_TOO_LOW", "You cannot set the access requirements for %s (your level is too low.)" },
45 { "MCMSG_LEVEL_TOO_HIGH", "You cannot set the access requirements to %s (that is too high)." },
46 { "MCMSG_BAD_OPTION", "Unknown option %s." },
47 { "MCMSG_MUST_QUALIFY", "You $bMUST$b \"/msg %s@$s %s\" (not just /msg %s)." },
48 { "MCMSG_ACCOUNT_SUSPENDED", "Your account has been suspended." },
49 { "MCMSG_CHAN_NOT_REGISTERED", "%s has not been registered with $C." },
50 { "MCMSG_CHAN_SUSPENDED", "$b$C$b access to $b%s$b has been temporarily suspended (%s)." },
51 { "MCMSG_NO_CHANNEL_ACCESS", "You lack access to %s." },
52 { "MCMSG_LOW_CHANNEL_ACCESS", "You lack sufficient access in %s to use this command." },
53 { "MCMSG_REQUIRES_JOINABLE", "You must be in %s (or on its userlist) to use this command." },
54 { "MCMSG_MUST_BE_HELPING", "You must have security override (helping mode) on to use this command." },
55 { "MCMSG_MISSING_COMMAND", "You must specify a command as well as a channel." },
56 { "MCMSG_NO_CHANNEL_BEFORE", "You may not give a channel name before this command." },
57 { "MCMSG_NO_PLUS_CHANNEL", "You may not use a +channel with this command." },
58 { "MCMSG_COMMAND_ALIASES", "%s is an alias for: %s" },
59 { "MCMSG_COMMAND_BINDING", "%s is a binding of: %s" },
60 { "MCMSG_ALIAS_ERROR", "Error in alias expansion for %s; check the error log for details." },
61 { "MCMSG_INTERNAL_COMMAND", "$b%s$b is an internal command and cannot be called directly; please check command bindings." },
62 { "MCMSG_UNKNOWN_MODULE", "Unknown module %s." },
63 { "MCMSG_UNKNOWN_SERVICE", "Unknown service %s." },
64 { "MCMSG_ALREADY_BOUND", "%s already has a command bound as %s." },
65 { "MCMSG_UNKNOWN_COMMAND_2", "Unknown command name %s (relative to service %s)." },
66 { "MCMSG_COMMAND_MODIFIED", "Option $b%s$b for $b%s$b has been set." },
67 { "MCMSG_INSPECTION_REFUSED", "You do not have access to inspect command %s." },
68 { "MCMSG_CANNOT_DOUBLE_ALIAS", "You cannot bind to a complex (argument-carrying) bind." },
69 { "MCMSG_BAD_ALIAS_ARGUMENT", "Invalid alias argument $b%s$b." },
70 { "MCMSG_COMMAND_BOUND", "New command %s bound to %s." },
71 { "MCMSG_MODULE_BOUND", "Bound %d commands from %s to %s." },
72 { "MCMSG_NO_COMMAND_BOUND", "%s has nothing bound as command %s." },
73 { "MCMSG_UNBIND_PROHIBITED", "It wouldn't be very much fun to unbind the last %s command, now would it?" },
74 { "MCMSG_COMMAND_UNBOUND", "Unbound command %s from %s." },
75 { "MCMSG_HELPFILE_UNBOUND", "Since that was the last command from module %s on the service, the helpfile for %s was removed." },
76 { "MCMSG_NO_HELPFILE", "Module %s does not have a help file." },
77 { "MCMSG_HELPFILE_ERROR", "Syntax error reading %s; help contents not changed." },
78 { "MCMSG_HELPFILE_READ", "Read %s help database in "FMT_TIME_T".%03lu seconds." },
79 { "MCMSG_COMMAND_TIME", "Command $b%s$b finished in "FMT_TIME_T".%06lu seconds." },
80 { "MCMSG_NEED_OPSERV_LEVEL", "You must have $O access of at least $b%u$b." },
81 { "MCMSG_NEED_CHANSERV_LEVEL", "You must have $C access of at least $b%u$b in the channel." },
82 { "MCMSG_NEED_ACCOUNT_FLAGS", "You must have account flags $b%s$b." },
83 { "MCMSG_NEED_NOTHING", "Anyone may use the $b%s$b command." },
84 { "MCMSG_NEED_STAFF_ACCESS", "You must be network staff." },
85 { "MCMSG_NEED_STAFF_OPER", "You must be an IRC operator." },
86 { "MCMSG_NEED_STAFF_NETHELPER", "You must be a network helper." },
87 { "MCMSG_NEED_STAFF_NETHELPER_OR_OPER", "You must be a network helper or IRC operator." },
88 { "MCMSG_NEED_STAFF_SHELPER", "You must be a support helper." },
89 { "MCMSG_NEED_STAFF_SHELPER_OR_OPER", "You must be a support helper or IRC operator." },
90 { "MCMSG_NEED_STAFF_HELPER", "You must be a network or support helper." },
91 { "MCMSG_NEED_JOINABLE", "The channel must be open or you must be in the channel or on its userlist." },
92 { "MCMSG_NEED_CHANUSER_CSUSPENDABLE", "You must be on the channel's userlist, and the channel can be suspended." },
93 { "MCMSG_NEED_CHANUSER", "You must be on the channel's userlist." },
94 { "MCMSG_NEED_REGCHAN", "You must specify a channel registered with $C." },
95 { "MCMSG_NEED_CHANNEL", "You must specify a channel that exists." },
96 { "MCMSG_NEED_AUTHED", "You must be authenticated with $N." },
97 { "MCMSG_IS_TOY", "$b%s$b is a toy command." },
98 { "MCMSG_END_REQUIREMENTS", "End of requirements for $b%s$b." },
99 { "MCMSG_ALREADY_HELPING", "You already have security override enabled." },
100 { "MCMSG_ALREADY_NOT_HELPING", "You already have security override disabled." },
101 { "MCMSG_NOW_HELPING", "Security override has been enabled." },
102 { "MCMSG_NOW_NOT_HELPING", "Security override has been disabled." },
103 { "MCMSG_JOINER_CHOICES", "Subcommands of %s: %s" },
104 { "MCMSG_MODULE_INFO", "Commands exported by module $b%s$b:" },
105 { "MCMSG_SERVICE_INFO", "Commands bound to service $b%s$b:" },
106 { "MCMSG_TOYS_DISABLED", "Toys are disabled in %s." },
107 { "MCMSG_PUBLIC_DENY", "Public commands in $b%s$b are restricted." },
108 { "MCMSG_HELPFILE_SEQUENCE", "Help priority %d: %s" },
109 { "MCMSG_HELPFILE_SEQUENCE_SET", "Set helpfile priority sequence for %s." },
110 { "MCMSG_BAD_SERVICE_NICK", "$b%s$b is an invalid nickname." },
111 { "MCMSG_ALREADY_SERVICE", "$b%s$b is already a service." },
112 { "MCMSG_NEW_SERVICE", "Added new service bot $b%s$b." },
113 { "MCMSG_SERVICE_RENAMED", "Service renamed to $b%s$b." },
114 { "MCMSG_NO_TRIGGER", "$b%s$b does not have an in-channel trigger." },
115 { "MCMSG_REMOVED_TRIGGER", "Removed trigger from $b%s$b." },
116 { "MCMSG_DUPLICATE_TRIGGER", "$b%s$b already uses trigger $b%c$b." },
117 { "MCMSG_CURRENT_TRIGGER", "Trigger for $b%s$b is $b%c$b." },
118 { "MCMSG_NEW_TRIGGER", "Changed trigger for $b%s$b to $b%c$b." },
119 { "MCMSG_SERVICE_PRIVILEGED", "Service $b%s$b privileged: $b%s$b." },
120 { "MCMSG_SERVICE_REMOVED", "Service $b%s$b has been deleted." },
121 { "MCMSG_FILE_NOT_OPENED", "Unable to open file $b%s$b for writing." },
122 { "MCMSG_MESSAGES_DUMPED", "Messages written to $b%s$b." },
125 struct userData *_GetChannelUser(struct chanData *channel, struct handle_info *handle, int override, int allow_suspended);
127 #define ACTION_ALLOW 1
128 #define ACTION_OVERRIDE 2
129 #define ACTION_NOCHANNEL 4
130 #define ACTION_STAFF 8
132 #define RESOLVE_DEPTH 4
134 static struct modcmd_flag {
138 { "acceptchan", MODCMD_ACCEPT_CHANNEL },
139 { "acceptpluschan", MODCMD_ACCEPT_PCHANNEL },
140 { "authed", MODCMD_REQUIRE_AUTHED },
141 { "channel", MODCMD_REQUIRE_CHANNEL },
142 { "chanuser", MODCMD_REQUIRE_CHANUSER },
143 { "disabled", MODCMD_DISABLED },
144 { "ignore_csuspend", MODCMD_IGNORE_CSUSPEND },
145 { "joinable", MODCMD_REQUIRE_JOINABLE },
146 { "keepbound", MODCMD_KEEP_BOUND },
147 { "loghostmask", MODCMD_LOG_HOSTMASK },
148 { "nolog", MODCMD_NO_LOG },
149 { "networkhelper", MODCMD_REQUIRE_NETWORK_HELPER },
150 { "never_csuspend", MODCMD_NEVER_CSUSPEND },
151 { "oper", MODCMD_REQUIRE_OPER },
152 { "qualified", MODCMD_REQUIRE_QUALIFIED },
153 { "regchan", MODCMD_REQUIRE_REGCHAN },
154 { "supporthelper", MODCMD_REQUIRE_SUPPORT_HELPER },
155 { "helping", MODCMD_REQUIRE_HELPING },
156 { "toy", MODCMD_TOY },
161 flags_bsearch(const void *a, const void *b) {
163 const struct modcmd_flag *flag = b;
164 return ircncasecmp(key, flag->name, strlen(flag->name));
168 flags_qsort(const void *a, const void *b) {
169 const struct modcmd_flag *fa = a, *fb = b;
170 return irccasecmp(fa->name, fb->name);
173 DEFINE_LIST(svccmd_list, struct svccmd*);
174 DEFINE_LIST(module_list, struct module*);
177 free_service_command(void *data) {
178 struct svccmd *svccmd;
182 if (svccmd->alias.used) {
183 for (nn=0; nn<svccmd->alias.used; ++nn)
184 free(svccmd->alias.list[nn]);
185 free(svccmd->alias.list);
192 free_service(void *data) {
193 struct service *service = data;
194 dict_delete(service->commands);
195 module_list_clean(&service->modules);
200 free_module_command(void *data) {
201 struct modcmd *modcmd = data;
202 free_service_command(modcmd->defaults);
208 free_module(void *data) {
209 struct module *module = data;
210 dict_delete(module->commands);
211 close_helpfile(module->helpfile);
217 module_register(const char *name, struct log_type *clog, const char *helpfile_name, expand_func_t expand_help) {
218 struct module *newmod;
220 newmod = calloc(1, sizeof(*newmod));
221 newmod->name = strdup(name);
222 newmod->commands = dict_new();
223 dict_set_free_data(newmod->commands, free_module_command);
225 newmod->helpfile_name = helpfile_name;
226 newmod->expand_help = expand_help;
227 if (newmod->helpfile_name) {
228 newmod->helpfile = open_helpfile(newmod->helpfile_name, newmod->expand_help);
230 dict_insert(modules, newmod->name, newmod);
235 module_find(const char *name) {
236 return dict_find(modules, name, NULL);
240 add_pending_template(struct svccmd *cmd, const char *target) {
241 struct pending_template *pending = calloc(1, sizeof(*pending));
243 pending->base = strdup(target);
244 pending->next = pending_templates;
245 pending_templates = pending;
248 static struct svccmd *
249 svccmd_resolve_name(struct svccmd *origin, const char *name) {
250 char *sep, svcname[MAXLEN];
252 if ((sep = strchr(name, '.'))) {
253 memcpy(svcname, name, sep-name);
254 svcname[sep-name] = 0;
256 if (svcname[0] == '*') {
257 struct module *module = module_find(svcname+1);
258 struct modcmd *cmd = module ? dict_find(module->commands, name, NULL) : NULL;
259 return cmd ? cmd->defaults : NULL;
261 struct service *service = service_find(svcname);
262 return service ? dict_find(service->commands, name, NULL) : NULL;
265 if (origin->parent) {
266 return dict_find(origin->parent->commands, name, NULL);
268 struct modcmd *cmd = dict_find(origin->command->parent->commands, name, NULL);
269 return cmd ? cmd->defaults : NULL;
275 modcmd_set_effective_flags(struct svccmd *cmd) {
276 int flags = cmd->flags | cmd->command->flags;
277 if (cmd->min_opserv_level > 0)
278 flags |= MODCMD_REQUIRE_OPER;
279 if (cmd->min_channel_access > 0)
280 flags |= MODCMD_REQUIRE_CHANUSER;
281 if (flags & MODCMD_REQUIRE_CHANUSER)
282 flags |= MODCMD_REQUIRE_REGCHAN;
283 if (flags & MODCMD_REQUIRE_REGCHAN)
284 flags |= MODCMD_REQUIRE_CHANNEL;
285 if (flags & (MODCMD_REQUIRE_STAFF|MODCMD_REQUIRE_HELPING))
286 flags |= MODCMD_REQUIRE_AUTHED;
287 cmd->effective_flags = flags;
291 svccmd_copy_rules(struct svccmd *dest, struct svccmd *src) {
292 dest->flags |= src->flags;
293 dest->req_account_flags |= src->req_account_flags;
294 dest->deny_account_flags |= src->deny_account_flags;
295 if (src->min_opserv_level > dest->min_opserv_level)
296 dest->min_opserv_level = src->min_opserv_level;
297 if (src->min_channel_access > dest->min_channel_access)
298 dest->min_channel_access = src->min_channel_access;
299 modcmd_set_effective_flags(dest);
303 svccmd_configure(struct svccmd *cmd, struct userNode *user, struct userNode *bot, const char *param, const char *value) {
304 if (!irccasecmp(param, "flags")) {
305 unsigned int set_flags, rem_flags;
306 struct modcmd_flag *flag;
309 for (set_flags = rem_flags = 0; 1; value += end) {
310 end = strcspn(value, ",");
313 else if (*value == '-')
317 send_message(user, bot, "MCMSG_BARE_FLAG", end, value);
319 log_module(MAIN_LOG, LOG_ERROR, "Flag %.*s must be preceded by a + or - (for command %s).", end, value, cmd->name);
323 flag = bsearch(value, flags, ArrayLength(flags)-1, sizeof(flags[0]), flags_bsearch);
326 send_message(user, bot, "MCMSG_UNKNOWN_FLAG", end, value);
328 log_module(MAIN_LOG, LOG_ERROR, "Unknown module flag %.*s (for command %s).", end, value, cmd->name);
332 set_flags |= flag->flag, rem_flags &= ~flag->flag;
334 rem_flags |= flag->flag, set_flags &= ~flag->flag;
338 cmd->flags = (cmd->flags | set_flags) & ~rem_flags;
340 } else if (!irccasecmp(param, "channel_level") || !irccasecmp(param, "channel_access") || !irccasecmp(param, "access")) {
342 if (!irccasecmp(value, "none") || !irccasecmp(value, "0")) {
343 cmd->min_channel_access = 0;
345 } else if ((ul = user_level_from_name(value, UL_OWNER)) > 0) {
346 cmd->min_channel_access = ul;
349 send_message(user, bot, "MCMSG_BAD_CHANSERV_LEVEL", value);
352 log_module(MAIN_LOG, LOG_ERROR, "Invalid ChanServ access level %s (for command %s).", value, cmd->name);
355 } else if (!irccasecmp(param, "oper_level") || !irccasecmp(param, "oper_access") || !irccasecmp(param, "level")) {
356 unsigned int newval = atoi(value);
357 if (!isdigit(value[0]) || (newval > 1000)) {
359 send_message(user, bot, "MCMSG_BAD_OPSERV_LEVEL", value);
361 log_module(MAIN_LOG, LOG_ERROR, "Invalid OpServ access level %s (for command %s).", value, cmd->name);
364 if (user && (!user->handle_info || (cmd->min_opserv_level > user->handle_info->opserv_level))) {
365 send_message(user, bot, "MCMSG_LEVEL_TOO_LOW", cmd->name);
368 if (user && (!user->handle_info || (newval > user->handle_info->opserv_level))) {
369 send_message(user, bot, "MCMSG_LEVEL_TOO_HIGH", value);
372 cmd->min_opserv_level = newval;
374 } else if (!irccasecmp(param, "account_flags")) {
375 return nickserv_modify_handle_flags(user, bot, value, &cmd->req_account_flags, &cmd->deny_account_flags);
378 send_message(user, bot, "MCMSG_BAD_OPTION", param);
380 log_module(MAIN_LOG, LOG_ERROR, "Unknown option %s (for command %s).", param, cmd->name);
386 modcmd_register(struct module *module, const char *name, modcmd_func_t func, unsigned int min_argc, unsigned int flags, ...) {
387 struct modcmd *newcmd;
389 const char *param, *value;
391 newcmd = calloc(1, sizeof(*newcmd));
392 newcmd->name = strdup(name);
393 newcmd->parent = module;
395 newcmd->min_argc = min_argc;
396 newcmd->flags = flags;
397 newcmd->defaults = calloc(1, sizeof(*newcmd->defaults));
398 newcmd->defaults->name = strdup(newcmd->name);
399 newcmd->defaults->command = newcmd;
400 dict_insert(module->commands, newcmd->name, newcmd);
401 if (newcmd->flags & (MODCMD_REQUIRE_REGCHAN|MODCMD_REQUIRE_CHANNEL|MODCMD_REQUIRE_CHANUSER|MODCMD_REQUIRE_JOINABLE)) {
402 newcmd->defaults->flags |= MODCMD_ACCEPT_CHANNEL;
404 if (newcmd->flags & MODCMD_REQUIRE_STAFF) {
405 newcmd->defaults->flags |= MODCMD_REQUIRE_AUTHED;
407 va_start(args, flags);
408 while ((param = va_arg(args, const char*))) {
409 value = va_arg(args, const char*);
410 if (!irccasecmp(param, "template")) {
411 struct svccmd *svccmd = svccmd_resolve_name(newcmd->defaults, value);
413 svccmd_copy_rules(newcmd->defaults, svccmd);
415 log_module(MAIN_LOG, LOG_ERROR, "Unable to resolve template name %s for %s.%s.", value, newcmd->parent->name, newcmd->name);
417 add_pending_template(newcmd->defaults, value);
419 svccmd_configure(newcmd->defaults, NULL, NULL, param, value);
422 modcmd_set_effective_flags(newcmd->defaults);
427 /* This is kind of a lame hack, but it is actually simpler than having
428 * the permission check vary based on the command itself, or having a
429 * more generic rule system.
432 svccmd_can_invoke(struct userNode *user, struct userNode *bot, struct svccmd *cmd, struct chanNode *channel, int options) {
433 unsigned int uData_checked = 0;
434 struct userData *uData = NULL;
435 int rflags = 0, flags = cmd->effective_flags;
437 if (flags & MODCMD_DISABLED) {
438 if (options & SVCCMD_NOISY)
439 send_message(user, bot, "MSG_COMMAND_DISABLED", cmd->name);
442 if ((flags & MODCMD_REQUIRE_QUALIFIED) && !(options & SVCCMD_QUALIFIED)) {
443 if (options & SVCCMD_NOISY)
444 send_message(user, bot, "MCMSG_MUST_QUALIFY", bot->nick, cmd->name, bot->nick);
447 if (flags & MODCMD_REQUIRE_AUTHED) {
448 if (!user->handle_info) {
449 if (options & SVCCMD_NOISY)
450 send_message(user, bot, "MSG_AUTHENTICATE");
453 if (HANDLE_FLAGGED(user->handle_info, SUSPENDED)) {
454 if (options & SVCCMD_NOISY)
455 send_message(user, bot, "MCMSG_ACCOUNT_SUSPENDED");
459 if (channel || (options & SVCCMD_NOISY)) {
460 if ((flags & MODCMD_REQUIRE_CHANNEL) && !channel) {
461 if (options & SVCCMD_NOISY)
462 send_message(user, bot, "MSG_INVALID_CHANNEL");
465 if (flags & MODCMD_REQUIRE_REGCHAN) {
466 if (!channel->channel_info) {
467 if (options & SVCCMD_NOISY)
468 send_message(user, bot, "MCMSG_CHAN_NOT_REGISTERED", channel->name);
470 } else if (IsSuspended(channel->channel_info) && !(flags & MODCMD_IGNORE_CSUSPEND)) {
471 /* allow security-override users to always ignore channel suspensions, but flag it as a staff command */
472 if (!user->handle_info
473 || !HANDLE_FLAGGED(user->handle_info, HELPING)
474 || (flags & MODCMD_NEVER_CSUSPEND)) {
475 if (options & SVCCMD_NOISY)
476 send_message(user, bot, "MCMSG_CHAN_SUSPENDED", channel->name, channel->channel_info->suspended->reason);
479 rflags |= ACTION_STAFF;
482 if (flags & MODCMD_REQUIRE_CHANUSER) {
484 uData = _GetChannelUser(channel->channel_info, user->handle_info, 1, 0), uData_checked = 1;
486 if (options & SVCCMD_NOISY)
487 send_message(user, bot, "MCMSG_NO_CHANNEL_ACCESS", channel->name);
489 } else if (uData->access < cmd->min_channel_access) {
490 if (options & SVCCMD_NOISY)
491 send_message(user, bot, "MCMSG_LOW_CHANNEL_ACCESS", channel->name);
495 if ((flags & MODCMD_REQUIRE_JOINABLE) && channel) {
497 uData = _GetChannelUser(channel->channel_info, user->handle_info, 1, 0), uData_checked = 1;
498 if ((channel->modes & (MODE_INVITEONLY|MODE_KEY|MODE_SECRET))
501 && !GetUserMode(channel, user)) {
502 if (options & SVCCMD_NOISY)
503 send_message(user, bot, "MCMSG_REQUIRES_JOINABLE", channel->name);
507 if ((flags & MODCMD_TOY) && channel) {
508 if (!channel->channel_info)
509 rflags |= ACTION_NOCHANNEL;
510 else switch (channel->channel_info->chOpts[chToys]) {
512 if (options & SVCCMD_NOISY)
513 send_message(user, bot, "MCMSG_TOYS_DISABLED", channel->name);
516 rflags |= ACTION_NOCHANNEL;
523 if (flags & MODCMD_REQUIRE_STAFF) {
524 if (((flags & MODCMD_REQUIRE_OPER) && IsOper(user))
525 || ((flags & MODCMD_REQUIRE_NETWORK_HELPER) && IsNetworkHelper(user))
526 || ((flags & MODCMD_REQUIRE_SUPPORT_HELPER) && IsSupportHelper(user))) {
528 rflags |= ACTION_STAFF;
530 if (options & SVCCMD_NOISY)
531 send_message(user, bot, "MSG_COMMAND_PRIVILEGED", cmd->name);
535 if (flags & MODCMD_REQUIRE_HELPING) {
536 if (!HANDLE_FLAGGED(user->handle_info, HELPING)) {
537 if (options & SVCCMD_NOISY)
538 send_message(user, bot, "MCMSG_MUST_BE_HELPING");
541 rflags |= ACTION_STAFF;
543 if (cmd->min_opserv_level > 0) {
544 if (!oper_has_access(user, bot, cmd->min_opserv_level, !(options & SVCCMD_NOISY))) return 0;
545 rflags |= ACTION_STAFF;
547 if (cmd->req_account_flags || cmd->deny_account_flags) {
548 if (!user->handle_info) {
549 if (options & SVCCMD_NOISY)
550 send_message(user, bot, "MSG_AUTHENTICATE");
553 /* Do we want separate or different messages here? */
554 if ((cmd->req_account_flags & ~user->handle_info->flags)
555 || (cmd->deny_account_flags & user->handle_info->flags)) {
556 if (options & SVCCMD_NOISY)
557 send_message(user, bot, "MSG_COMMAND_PRIVILEGED", cmd->name);
562 /* If it's an override, return a special value. */
563 if ((flags & MODCMD_REQUIRE_CHANUSER)
564 && (options & SVCCMD_NOISY)
565 && (uData->access > 500)
566 && (!(uData = _GetChannelUser(channel->channel_info, user->handle_info, 0, 0))
567 || uData->access < cmd->min_channel_access)
568 && !(flags & (MODCMD_REQUIRE_STAFF|MODCMD_REQUIRE_HELPING))) {
569 rflags |= ACTION_OVERRIDE;
571 return rflags | ACTION_ALLOW;
575 svccmd_expand_alias(struct svccmd *cmd, unsigned int old_argc, char *old_argv[], char *new_argv[]) {
576 unsigned int ii, new_argc;
579 for (ii=new_argc=0; ii<cmd->alias.used; ++ii) {
580 arg = cmd->alias.list[ii];
582 new_argv[new_argc++] = arg;
586 new_argv[new_argc++] = arg + 1;
587 } else if (isdigit(arg[1])) {
588 unsigned int lbound, ubound, jj;
591 lbound = strtoul(arg+1, &end_num, 10);
592 switch (end_num[0]) {
593 case 0: ubound = lbound; break;
595 if (end_num[1] == 0) {
596 ubound = old_argc - 1;
598 } else if (isdigit(end_num[1])) {
599 ubound = strtoul(end_num+1, NULL, 10);
602 /* else fall through to default case */
604 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);
607 if (ubound >= old_argc)
608 ubound = old_argc - 1;
609 if (lbound < old_argc)
610 for (jj = lbound; jj <= ubound; )
611 new_argv[new_argc++] = old_argv[jj++];
613 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);
621 svccmd_invoke_argv(struct userNode *user, struct service *service, struct chanNode *channel, unsigned int argc, char *argv[], unsigned int server_qualified) {
622 extern struct userNode *chanserv;
624 unsigned int cmd_arg, perms, flags, options;
625 char channel_name[CHANNELLEN+1];
627 /* First check pubcmd for the channel. */
628 if (channel && (channel->channel_info) && (service->bot == chanserv)
629 && !check_user_level(channel, user, lvlPubCmd, 1, 0)) {
630 send_message(user, service->bot, "MCMSG_PUBLIC_DENY", channel->name);
634 options = (server_qualified ? SVCCMD_QUALIFIED : 0) | SVCCMD_DEBIT | SVCCMD_NOISY;
635 /* Find the command argument. */
636 cmd_arg = IsChannelName(argv[0]) ? 1 : 0;
637 if (argc < cmd_arg+1) {
638 send_message(user, service->bot, "MCMSG_MISSING_COMMAND");
641 if (!isalnum(*argv[cmd_arg])) {
642 /* Silently ignore stuff that doesn't begin with a letter or number. */
645 cmd = dict_find(service->commands, argv[cmd_arg], NULL);
648 send_message(user, service->bot, "MSG_COMMAND_UNKNOWN", argv[cmd_arg]);
651 flags = cmd->effective_flags;
652 /* If they put a channel name first, check if the command allows
653 * it. If so, swap it with the command name.
657 /* Complain if we're not supposed to accept the channel. */
658 if (!(flags & MODCMD_ACCEPT_CHANNEL)) {
659 send_message(user, service->bot, "MCMSG_NO_CHANNEL_BEFORE");
662 if (!(flags & MODCMD_ACCEPT_PCHANNEL)
663 && (argv[0][0] == '+')) {
664 send_message(user, service->bot, "MCMSG_NO_PLUS_CHANNEL");
672 /* Try to grab a channel handle before alias expansion.
673 * If the command accepts a channel name, and argv[1] is
674 * one, use it as a channel name, and hide it from logging.
677 && (flags & MODCMD_ACCEPT_CHANNEL)
678 && IsChannelName(argv[1])
679 && ((argv[1][0] != '+') || (flags & MODCMD_ACCEPT_PCHANNEL))
680 && (channel = dict_find(channels, argv[1], NULL))) {
686 /* Expand the alias arguments, if there are any. */
687 if (cmd->alias.used) {
688 char *new_argv[MAXNUMPARAMS];
689 argc = svccmd_expand_alias(cmd, argc, argv, new_argv);
691 send_message(service->bot, user, "MCMSG_ALIAS_ERROR", cmd->name);
696 /* Try again to grab a handle to the channel after alias
697 * expansion, overwriting any previous channel. This should,
698 * of course, only be done again if an alias was acually
701 && (flags & MODCMD_ACCEPT_CHANNEL)
702 && IsChannelName(argv[1])
703 && ((argv[1][0] != '+') || (flags & MODCMD_ACCEPT_PCHANNEL))
704 && (channel = dict_find(channels, argv[1], NULL))) {
711 /* Figure out what actions we should do for it.. */
712 if (cmd_arg && (flags & MODCMD_TOY)) {
713 /* Do not let user manually specify a channel. */
716 if (argc < cmd->command->min_argc) {
717 send_message(user, service->bot, "MSG_MISSING_PARAMS", cmd->name);
720 if (!cmd->command->func) {
721 send_message(user, service->bot, "MCMSG_INTERNAL_COMMAND", cmd->name);
724 perms = svccmd_can_invoke(user, service->bot, cmd, channel, options);
728 if (perms & ACTION_NOCHANNEL)
732 safestrncpy(channel_name, channel->name, sizeof(channel_name));
735 if (!cmd->command->func(user, channel, argc, argv, cmd))
737 if (!(flags & MODCMD_NO_LOG)) {
738 enum log_severity slvl;
739 if (perms & ACTION_STAFF)
741 else if (perms & ACTION_OVERRIDE)
745 /* Unsplit argv after running the function to get the benefit
746 * of any mangling/hiding done by the commands. */
747 log_audit(cmd->command->parent->clog, slvl, user, service->bot, channel_name, ((flags & MODCMD_LOG_HOSTMASK) ? AUDIT_HOSTMASK : 0), unsplit_string(argv, argc, NULL));
753 svccmd_send_help(struct userNode *user, struct userNode *bot, struct svccmd *cmd) {
754 char cmdname[MAXLEN];
756 /* Show command name (in bold). */
757 for (nn=0; cmd->name[nn]; nn++)
758 cmdname[nn] = toupper(cmd->name[nn]);
760 send_message_type(4, user, bot, "$b%s$b", cmdname);
761 /* If it's an alias, show what it's an alias for. */
762 if (cmd->alias.used) {
763 char alias_text[MAXLEN];
764 unsplit_string((char**)cmd->alias.list, cmd->alias.used, alias_text);
765 send_message(user, bot, "MCMSG_COMMAND_ALIASES", cmd->name, alias_text);
767 /* Show the help entry for the underlying command. */
768 return send_help(user, bot, cmd->command->parent->helpfile, cmd->command->name);
772 svccmd_send_help_2(struct userNode *user, struct service *service, const char *topic) {
773 struct module *module;
777 if ((cmd = dict_find(service->commands, topic, NULL)))
778 return svccmd_send_help(user, service->bot, cmd);
781 for (ii = 0; ii < service->modules.used; ++ii) {
782 module = service->modules.list[ii];
783 if (!module->helpfile)
785 if (dict_find(module->helpfile->db, topic, NULL))
786 return send_help(user, service->bot, module->helpfile, topic);
788 send_message(user, service->bot, "MSG_TOPIC_UNKNOWN");
793 svccmd_invoke(struct userNode *user, struct service *service, struct chanNode *channel, char *text, int server_qualified) {
795 char *argv[MAXNUMPARAMS];
799 if (service->privileged) {
801 send_message(user, service->bot, "MSG_SERVICE_PRIVILEGED", service->bot->nick);
804 if (!user->handle_info) {
805 send_message(user, service->bot, "MSG_AUTHENTICATE");
808 if (HANDLE_FLAGGED(user->handle_info, OPER_SUSPENDED)) {
809 send_message(user, service->bot, "MSG_OPER_SUSPENDED");
813 argc = split_line(text, false, ArrayLength(argv), argv);
814 return argc ? svccmd_invoke_argv(user, service, channel, argc, argv, server_qualified) : 0;
818 modcmd_privmsg(struct userNode *user, struct userNode *bot, char *text, int server_qualified) {
819 struct service *service;
820 if (!(service = dict_find(services, bot->nick, NULL))) {
821 log_module(MAIN_LOG, LOG_ERROR, "modcmd_privmsg got privmsg for unhandled service %s, unregistering.", bot->nick);
822 reg_privmsg_func(bot, NULL);
825 if (service->msg_hook && service->msg_hook(user, bot, text, server_qualified))
827 svccmd_invoke(user, service, NULL, text, server_qualified);
831 modcmd_chanmsg(struct userNode *user, struct chanNode *chan, char *text, struct userNode *bot) {
832 struct service *service;
833 if (!(service = dict_find(services, bot->nick, NULL))) return;
834 svccmd_invoke(user, service, chan, text, 0);
838 service_register(struct userNode *bot, char trigger) {
839 struct service *service;
840 if ((service = dict_find(services, bot->nick, NULL)))
842 service = calloc(1, sizeof(*service));
843 module_list_init(&service->modules);
844 service->commands = dict_new();
846 service->trigger = trigger;
847 dict_set_free_data(service->commands, free_service_command);
848 dict_insert(services, service->bot->nick, service);
849 reg_privmsg_func(bot, modcmd_privmsg);
851 reg_chanmsg_func(trigger, bot, modcmd_chanmsg);
856 service_find(const char *name) {
857 return dict_find(services, name, NULL);
861 svccmd_insert(struct service *service, char *name, struct svccmd *svccmd, struct modcmd *modcmd) {
863 svccmd->parent = service;
865 svccmd->command = modcmd;
866 svccmd->command->bind_count++;
867 dict_insert(service->commands, svccmd->name, svccmd);
868 for (ii=0; ii<service->modules.used; ++ii) {
869 if (service->modules.list[ii] == svccmd->command->parent) break;
871 if (ii == service->modules.used) {
872 module_list_append(&service->modules, svccmd->command->parent);
877 service_bind_modcmd(struct service *service, struct modcmd *cmd, const char *name) {
878 struct svccmd *svccmd;
879 if ((svccmd = dict_find(service->commands, name, NULL))) {
880 if (svccmd->command == cmd) return svccmd;
881 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);
884 svccmd = calloc(1, sizeof(*svccmd));
885 svccmd_insert(service, strdup(name), svccmd, cmd);
886 svccmd_copy_rules(svccmd, cmd->defaults);
891 service_bind_module(struct service *service, struct module *module) {
893 struct modcmd *modcmd;
897 for (it = dict_first(module->commands); it; it = iter_next(it)) {
898 modcmd = iter_data(it);
899 if (!((modcmd->flags | modcmd->defaults->flags) & MODCMD_NO_DEFAULT_BIND))
900 if (service_bind_modcmd(service, modcmd, iter_key(it)))
906 /* This MUST return argc if the alias expansion code knows how to deal
907 * with every argument in argv; otherwise, it MUST return the index of
908 * an argument that the expansion code does not know how to deal with.
911 check_alias_args(char *argv[], unsigned int argc) {
914 for (arg=0; arg<argc; ++arg) {
915 if (argv[arg][0] != '$') {
917 } else if (argv[arg][1] == '$') {
919 } else if (isdigit(argv[arg][1])) {
922 strtoul(argv[arg]+1, &end_num, 10);
923 switch (end_num[0]) {
929 else if (isdigit(end_num[1]))
931 /* else fall through to default case */
942 collapse_cmdname(char *argv[], unsigned int argc, char *dest) {
943 unsigned int ii, pos, arg;
948 for (ii=pos=0, arg=0; argv[arg][ii]; ) {
949 if (argv[arg][ii] == '\\') {
950 if (argv[arg][ii+1]) {
951 /* escaping a real character just puts it in literally */
952 dest[pos++] = argv[arg][++ii];
953 } else if ((arg+1) == argc) {
954 /* we ran to the end of the argument list; abort */
957 /* escape at end of a word is a space */
963 /* normal characters don't need escapes */
964 dest[pos++] = argv[arg][ii++];
971 static MODCMD_FUNC(cmd_bind) {
972 struct service *service;
973 struct svccmd *template, *newcmd;
975 char newname[MAXLEN], cmdname[MAXLEN];
976 unsigned int arg, diff;
980 arg = collapse_cmdname(argv+2, argc-2, newname) + 2;
982 reply("MSG_MISSING_PARAMS", cmd->name);
985 diff = collapse_cmdname(argv+arg, argc-arg, cmdname);
987 reply("MSG_MISSING_PARAMS", cmd->name);
992 if (!(service = service_find(svcname))) {
993 reply("MCMSG_UNKNOWN_SERVICE", svcname);
997 if ((newcmd = dict_find(service->commands, newname, NULL))) {
998 reply("MCMSG_ALREADY_BOUND", service->bot->nick, newname);
1002 if ((dot = strchr(cmdname, '.')) && (dot[1] == '*') && (dot[2] == 0)) {
1004 struct module *module;
1006 module = module_find((cmdname[0] == '*') ? cmdname+1 : cmdname);
1008 reply("MSG_MODULE_UNKNOWN", cmdname);
1011 count = service_bind_module(service, module);
1012 reply("MCMSG_MODULE_BOUND", count, module->name, service->bot->nick);
1015 newcmd = calloc(1, sizeof(*newcmd));
1016 newcmd->name = strdup(newname);
1017 newcmd->parent = service;
1018 if (!(template = svccmd_resolve_name(newcmd, cmdname))) {
1019 reply("MCMSG_UNKNOWN_COMMAND_2", cmdname, service->bot->nick);
1024 if (template->alias.used) {
1025 reply("MCMSG_CANNOT_DOUBLE_ALIAS");
1032 /* a more complicated alias; fix it up */
1036 nn = check_alias_args(argv+arg, argc-arg);
1037 if (nn+arg < argc) {
1038 reply("MCMSG_BAD_ALIAS_ARGUMENT", argv[nn+arg]);
1043 newcmd->alias.used = newcmd->alias.size = argc-arg;
1044 newcmd->alias.list = calloc(newcmd->alias.size, sizeof(newcmd->alias.list[0]));
1045 for (nn=0; nn<newcmd->alias.used; ++nn)
1046 newcmd->alias.list[nn] = strdup(argv[nn+arg]);
1049 svccmd_insert(service, newcmd->name, newcmd, template->command);
1050 svccmd_copy_rules(newcmd, template);
1051 reply("MCMSG_COMMAND_BOUND", newcmd->name, newcmd->parent->bot->nick);
1056 service_recheck_bindings(struct service *service, struct module *module) {
1060 for (it = dict_first(service->commands); it; it = iter_next(it)) {
1061 cmd = iter_data(it);
1062 if (cmd->command->parent == module) return 0;
1064 /* No more bindings, remove it from our list. */
1065 module_list_remove(&service->modules, module);
1069 static svccmd_unbind_func_t *suf_list;
1070 unsigned int suf_size, suf_used;
1073 reg_svccmd_unbind_func(svccmd_unbind_func_t handler) {
1074 if (suf_used == suf_size) {
1077 suf_list = realloc(suf_list, suf_size*sizeof(svccmd_unbind_func_t));
1080 suf_list = malloc(suf_size*sizeof(svccmd_unbind_func_t));
1083 suf_list[suf_used++] = handler;
1086 static MODCMD_FUNC(cmd_unbind) {
1087 struct service *service;
1088 struct userNode *bot;
1089 struct svccmd *bound;
1090 struct module *module;
1091 const char *svcname;
1092 unsigned int arg, ii;
1093 char cmdname[MAXLEN];
1097 arg = collapse_cmdname(argv+2, argc-2, cmdname) + 2;
1099 reply("MSG_MISSING_PARAMS", cmd->name);
1102 if (!(service = service_find(svcname))) {
1103 reply("MCMSG_UNKNOWN_SERVICE", svcname);
1106 if (!(bound = dict_find(service->commands, cmdname, NULL))) {
1107 reply("MCMSG_NO_COMMAND_BOUND", service->bot->nick, cmdname);
1110 if ((bound->command->flags & MODCMD_KEEP_BOUND) && (bound->command->bind_count == 1)) {
1111 reply("MCMSG_UNBIND_PROHIBITED", bound->command->name);
1115 for (ii=0; ii<suf_used; ii++)
1116 suf_list[ii](bound);
1117 /* If this command binding is removing itself, we must take care
1118 * not to dereference it after the dict_remove.
1120 bot = cmd->parent->bot;
1121 module = cmd->command->parent;
1122 dict_remove(service->commands, bound->name);
1123 send_message(user, bot, "MCMSG_COMMAND_UNBOUND", cmdname, service->bot->nick);
1124 if (service_recheck_bindings(service, module))
1125 send_message(user, bot, "MCMSG_HELPFILE_UNBOUND", module->name, module->name);
1129 static MODCMD_FUNC(cmd_readhelp) {
1130 const char *modname;
1131 struct module *module;
1132 struct helpfile *old_helpfile;
1133 struct timeval start, stop;
1137 if (!(module = module_find(modname))) {
1138 reply("MSG_MODULE_UNKNOWN", modname);
1141 if (!module->helpfile_name) {
1142 reply("MCMSG_NO_HELPFILE", module->name);
1145 old_helpfile = module->helpfile;
1146 gettimeofday(&start, NULL);
1147 module->helpfile = open_helpfile(module->helpfile_name, module->expand_help);
1148 if (!module->helpfile) {
1149 module->helpfile = old_helpfile;
1150 reply("MCMSG_HELPFILE_ERROR", module->helpfile_name);
1153 if (old_helpfile) close_helpfile(old_helpfile);
1154 gettimeofday(&stop, NULL);
1155 stop.tv_sec -= start.tv_sec;
1156 stop.tv_usec -= start.tv_usec;
1157 if (stop.tv_usec < 0) {
1159 stop.tv_usec += 1000000;
1161 reply("MCMSG_HELPFILE_READ", module->name, stop.tv_sec, stop.tv_usec/1000);
1165 static MODCMD_FUNC(cmd_help) {
1168 topic = (argc < 2) ? NULL : unsplit_string(argv+1, argc-1, NULL);
1169 return svccmd_send_help_2(user, cmd->parent, topic);
1172 static MODCMD_FUNC(cmd_timecmd) {
1173 struct timeval start, stop;
1174 char cmd_text[MAXLEN];
1176 unsplit_string(argv+1, argc-1, cmd_text);
1177 gettimeofday(&start, NULL);
1178 svccmd_invoke(user, cmd->parent, channel, cmd_text, 0);
1179 gettimeofday(&stop, NULL);
1180 stop.tv_sec -= start.tv_sec;
1181 stop.tv_usec -= start.tv_usec;
1182 if (stop.tv_usec < 0) {
1184 stop.tv_usec += 1000000;
1186 reply("MCMSG_COMMAND_TIME", cmd_text, stop.tv_sec, stop.tv_usec);
1190 static MODCMD_FUNC(cmd_command) {
1191 struct svccmd *svccmd;
1192 const char *cmd_name, *fmt_str;
1193 unsigned int flags, shown_flags, nn, pos;
1197 cmd_name = unsplit_string(argv+1, argc-1, NULL);
1198 if (!(svccmd = svccmd_resolve_name(cmd, cmd_name))) {
1199 reply("MCMSG_UNKNOWN_COMMAND_2", cmd_name, cmd->parent->bot->nick);
1202 pos = snprintf(buf, sizeof(buf), "%s.%s", svccmd->command->parent->name, svccmd->command->name);
1203 if (svccmd->alias.used) {
1205 unsplit_string((char**)svccmd->alias.list+1, svccmd->alias.used-1, buf+pos);
1206 reply("MCMSG_COMMAND_ALIASES", svccmd->name, buf);
1208 reply("MCMSG_COMMAND_BINDING", svccmd->name, buf);
1210 flags = svccmd->effective_flags;
1211 if ((svccmd->parent && svccmd->parent->privileged && !IsOper(user))
1212 || ((flags & MODCMD_REQUIRE_STAFF)
1213 && !IsOper(user) && !IsNetworkHelper(user) && !IsSupportHelper(user))) {
1214 reply("MCMSG_INSPECTION_REFUSED", svccmd->name);
1217 if (flags & MODCMD_DISABLED) {
1218 reply("MSG_COMMAND_DISABLED", svccmd->name);
1222 if (svccmd->min_opserv_level > 0) {
1223 reply("MCMSG_NEED_OPSERV_LEVEL", svccmd->min_opserv_level);
1224 shown_flags |= MODCMD_REQUIRE_OPER | MODCMD_REQUIRE_AUTHED;
1226 if (svccmd->min_channel_access > 0) {
1227 reply("MCMSG_NEED_CHANSERV_LEVEL", svccmd->min_channel_access);
1228 shown_flags |= MODCMD_REQUIRE_CHANUSER | MODCMD_REQUIRE_REGCHAN | MODCMD_REQUIRE_CHANNEL | MODCMD_REQUIRE_AUTHED;
1230 if (svccmd->req_account_flags) {
1231 for (nn=pos=0; nn<32; nn++) {
1232 if (!(svccmd->req_account_flags & (1 << nn))) continue;
1233 buf[pos++] = HANDLE_FLAGS[nn];
1236 reply("MCMSG_NEED_ACCOUNT_FLAGS", buf);
1237 shown_flags |= MODCMD_REQUIRE_AUTHED;
1239 if (!flags && !shown_flags) {
1240 reply("MCMSG_NEED_NOTHING", svccmd->name);
1243 if (flags & ~shown_flags & MODCMD_REQUIRE_HELPING) {
1244 reply("MCMSG_MUST_BE_HELPING");
1245 shown_flags |= MODCMD_REQUIRE_AUTHED | MODCMD_REQUIRE_STAFF;
1247 if (flags & ~shown_flags & MODCMD_REQUIRE_STAFF) {
1248 switch (flags & MODCMD_REQUIRE_STAFF) {
1249 default: case MODCMD_REQUIRE_STAFF:
1250 fmt_str = "MCMSG_NEED_STAFF_ACCESS";
1252 case MODCMD_REQUIRE_OPER:
1253 fmt_str = "MCMSG_NEED_STAFF_OPER";
1255 case MODCMD_REQUIRE_NETWORK_HELPER:
1256 fmt_str = "MCMSG_NEED_STAFF_NETHELPER";
1258 case MODCMD_REQUIRE_OPER|MODCMD_REQUIRE_NETWORK_HELPER:
1259 fmt_str = "MCMSG_NEED_STAFF_NETHELPER_OR_OPER";
1261 case MODCMD_REQUIRE_SUPPORT_HELPER:
1262 fmt_str = "MCMSG_NEED_STAFF_SHELPER";
1264 case MODCMD_REQUIRE_OPER|MODCMD_REQUIRE_SUPPORT_HELPER:
1265 fmt_str = "MCMSG_NEED_STAFF_SHELPER_OR_OPER";
1267 case MODCMD_REQUIRE_SUPPORT_HELPER|MODCMD_REQUIRE_NETWORK_HELPER:
1268 fmt_str = "MCMSG_NEED_STAFF_HELPER";
1272 shown_flags |= MODCMD_REQUIRE_AUTHED | MODCMD_REQUIRE_STAFF;
1274 if (flags & ~shown_flags & MODCMD_REQUIRE_JOINABLE) {
1275 reply("MCMSG_NEED_JOINABLE");
1276 shown_flags |= MODCMD_REQUIRE_CHANUSER;
1278 if (flags & ~shown_flags & MODCMD_REQUIRE_CHANUSER) {
1279 if (flags & ~shown_flags & MODCMD_IGNORE_CSUSPEND)
1280 reply("MCMSG_NEED_CHANUSER_CSUSPENDABLE");
1282 reply("MCMSG_NEED_CHANUSER");
1283 shown_flags |= MODCMD_IGNORE_CSUSPEND | MODCMD_REQUIRE_REGCHAN | MODCMD_REQUIRE_CHANNEL | MODCMD_REQUIRE_AUTHED;
1285 if (flags & ~shown_flags & MODCMD_REQUIRE_REGCHAN) {
1286 reply("MCMSG_NEED_REGCHAN");
1287 shown_flags |= MODCMD_REQUIRE_CHANNEL;
1289 if (flags & ~shown_flags & MODCMD_REQUIRE_CHANNEL)
1290 reply("MCMSG_NEED_CHANNEL");
1291 if (flags & ~shown_flags & MODCMD_REQUIRE_AUTHED)
1292 reply("MCMSG_NEED_AUTHED");
1293 if (flags & ~shown_flags & MODCMD_TOY)
1294 reply("MCMSG_IS_TOY", svccmd->name);
1295 if (flags & ~shown_flags & MODCMD_REQUIRE_QUALIFIED) {
1296 const char *botnick = svccmd->parent ? svccmd->parent->bot->nick : "SomeBot";
1297 reply("MCMSG_MUST_QUALIFY", botnick, svccmd->name, botnick);
1299 reply("MCMSG_END_REQUIREMENTS", svccmd->name);
1303 static MODCMD_FUNC(cmd_modcmd) {
1304 struct svccmd *svccmd;
1305 unsigned int arg, changed;
1306 char cmdname[MAXLEN];
1309 arg = collapse_cmdname(argv+1, argc-1, cmdname) + 1;
1310 if (!arg || (arg+2 < argc)) {
1311 reply("MSG_MISSING_PARAMS", cmd->name);
1314 if (!(svccmd = svccmd_resolve_name(cmd, cmdname))) {
1315 reply("MCMSG_UNKNOWN_COMMAND_2", cmdname, cmd->parent->bot->nick);
1319 while (arg+1 < argc) {
1320 if (svccmd_configure(svccmd, user, cmd->parent->bot, argv[arg], argv[arg+1])) {
1321 reply("MCMSG_COMMAND_MODIFIED", argv[arg], svccmd->name);
1327 modcmd_set_effective_flags(svccmd);
1331 static MODCMD_FUNC(cmd_god) {
1335 if (enabled_string(argv[1])) {
1336 if (HANDLE_FLAGGED(user->handle_info, HELPING)) {
1337 reply("MCMSG_ALREADY_HELPING");
1341 } else if (disabled_string(argv[1])) {
1342 if (!HANDLE_FLAGGED(user->handle_info, HELPING)) {
1343 reply("MCMSG_ALREADY_NOT_HELPING");
1348 reply("MSG_INVALID_BINARY", argv[1]);
1352 helping = !IsHelping(user);
1356 HANDLE_SET_FLAG(user->handle_info, HELPING);
1357 reply("MCMSG_NOW_HELPING");
1359 HANDLE_CLEAR_FLAG(user->handle_info, HELPING);
1360 reply("MCMSG_NOW_NOT_HELPING");
1366 static MODCMD_FUNC(cmd_joiner) {
1370 int len = sprintf(cmdname, "%s ", cmd->name);
1372 struct string_buffer sbuf;
1374 string_buffer_init(&sbuf);
1375 for (it = dict_first(cmd->parent->commands); it; it = iter_next(it)) {
1376 if (!ircncasecmp(iter_key(it), cmdname, len)) {
1377 if (sbuf.used) string_buffer_append_string(&sbuf, ", ");
1378 string_buffer_append_string(&sbuf, iter_key(it));
1381 if (!sbuf.used) string_buffer_append(&sbuf, 0);
1382 reply("MCMSG_JOINER_CHOICES", cmd->name, sbuf.list);
1383 string_buffer_clean(&sbuf);
1386 sprintf(cmdname, "%s %s", cmd->name, argv[1]);
1388 svccmd_invoke_argv(user, cmd->parent, channel, argc-1, argv+1, 0);
1389 return 0; /* never try to log this; the recursive one logs it */
1392 static MODCMD_FUNC(cmd_stats_modules) {
1393 struct helpfile_table tbl;
1397 struct modcmd *modcmd;
1400 tbl.length = dict_size(modules) + 1;
1402 tbl.flags = TABLE_PAD_LEFT;
1403 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1404 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1405 tbl.contents[0][0] = "Module";
1406 tbl.contents[0][1] = "Commands";
1407 tbl.contents[0][2] = "Helpfile";
1408 for (ii=1, it=dict_first(modules); it; it=iter_next(it), ii++) {
1409 mod = iter_data(it);
1410 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1411 tbl.contents[ii][0] = mod->name;
1412 tbl.contents[ii][1] = strtab(dict_size(mod->commands));
1413 tbl.contents[ii][2] = mod->helpfile_name ? mod->helpfile_name : "(none)";
1415 } else if (!(mod = dict_find(modules, argv[1], NULL))) {
1416 reply("MCMSG_UNKNOWN_MODULE", argv[1]);
1419 reply("MCMSG_MODULE_INFO", mod->name);
1420 tbl.length = dict_size(mod->commands) + 1;
1422 tbl.flags = TABLE_PAD_LEFT;
1423 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1424 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1425 tbl.contents[0][0] = "Command";
1426 tbl.contents[0][1] = "Min. Args";
1427 tbl.contents[0][2] = "Bind Count";
1428 for (ii=1, it=dict_first(mod->commands); it; it=iter_next(it), ii++) {
1429 modcmd = iter_data(it);
1430 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1431 tbl.contents[ii][0] = modcmd->name;
1432 tbl.contents[ii][1] = strtab(modcmd->min_argc);
1433 tbl.contents[ii][2] = strtab(modcmd->bind_count);
1436 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1440 static MODCMD_FUNC(cmd_stats_services) {
1441 struct helpfile_table tbl;
1444 struct service *service;
1445 struct svccmd *svccmd;
1449 tbl.length = dict_size(services) + 1;
1451 tbl.flags = TABLE_PAD_LEFT;
1452 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1453 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1454 tbl.contents[0][0] = "Service";
1455 tbl.contents[0][1] = "Commands";
1456 tbl.contents[0][2] = "Priv'd?";
1457 tbl.contents[0][3] = "Trigger";
1458 extra = calloc(2, tbl.length);
1459 for (ii=1, it=dict_first(services); it; it=iter_next(it), ii++) {
1460 service = iter_data(it);
1461 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1462 tbl.contents[ii][0] = service->bot->nick;
1463 tbl.contents[ii][1] = strtab(dict_size(service->commands));
1464 tbl.contents[ii][2] = service->privileged ? "yes" : "no";
1465 extra[ii*2] = service->trigger;
1466 tbl.contents[ii][3] = extra+ii*2;
1468 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1471 } else if (!(service = dict_find(services, argv[1], NULL))) {
1472 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1475 tbl.length = dict_size(service->commands) + 1;
1477 tbl.flags = TABLE_PAD_LEFT | TABLE_NO_FREE;
1478 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1479 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1480 tbl.contents[0][0] = "Command";
1481 tbl.contents[0][1] = "Module";
1482 tbl.contents[0][2] = "ModCmd";
1483 tbl.contents[0][3] = "Alias?";
1484 tbl.contents[0][4] = strdup("Uses");
1485 for (ii=1, it=dict_first(service->commands); it; it=iter_next(it), ii++) {
1486 svccmd = iter_data(it);
1487 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1488 tbl.contents[ii][0] = svccmd->name;
1489 tbl.contents[ii][1] = svccmd->command->parent->name;
1490 tbl.contents[ii][2] = svccmd->command->name;
1491 tbl.contents[ii][3] = svccmd->alias.used ? "yes" : "no";
1492 tbl.contents[ii][4] = extra = malloc(12);
1493 sprintf(extra, "%u", svccmd->uses);
1495 reply("MCMSG_SERVICE_INFO", service->bot->nick);
1496 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1497 for (ii=0; ii<tbl.length; ii++) {
1498 free((char*)tbl.contents[ii][4]);
1499 free(tbl.contents[ii]);
1506 static MODCMD_FUNC(cmd_showcommands) {
1507 struct svccmd_list commands;
1508 struct helpfile_table tbl;
1509 struct svccmd *svccmd;
1511 unsigned int ii, ignore_flags = 0;
1512 unsigned int max_opserv_level = 1000;
1513 unsigned short max_chanserv_level = 500;
1514 char show_opserv_level = 0, show_channel_access = 0;
1516 /* Check to see what the max access they want to see is. */
1517 for (ii=1; ii<argc; ++ii) {
1518 if (isdigit(argv[ii][0]))
1519 max_opserv_level = atoi(argv[ii]);
1521 max_chanserv_level = user_level_from_name(argv[ii], UL_OWNER);
1524 /* Find the matching commands. */
1525 svccmd_list_init(&commands);
1526 if (cmd->parent->privileged)
1527 ignore_flags = MODCMD_REQUIRE_OPER;
1528 for (it = dict_first(cmd->parent->commands); it; it = iter_next(it)) {
1529 svccmd = iter_data(it);
1530 if (strchr(svccmd->name, ' '))
1532 if (!svccmd_can_invoke(user, svccmd->parent->bot, svccmd, channel, SVCCMD_QUALIFIED))
1534 if (svccmd->min_opserv_level > max_opserv_level)
1536 if (svccmd->min_channel_access > max_chanserv_level)
1538 if (svccmd->min_opserv_level > 0)
1539 show_opserv_level = 1;
1540 if (svccmd->min_channel_access > 0)
1541 show_channel_access = 1;
1542 if (svccmd->effective_flags
1543 & (MODCMD_REQUIRE_STAFF|MODCMD_REQUIRE_HELPING)
1545 show_channel_access = 1;
1547 svccmd_list_append(&commands, svccmd);
1550 /* Build the table. */
1551 tbl.length = commands.used + 1;
1552 tbl.width = 1 + show_opserv_level + show_channel_access;
1553 tbl.flags = TABLE_REPEAT_ROWS;
1554 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1555 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1556 tbl.contents[0][ii = 0] = "Command";
1557 if (show_opserv_level)
1558 tbl.contents[0][++ii] = "OpServ Level";
1559 if (show_channel_access)
1560 tbl.contents[0][++ii] = "ChanServ Access";
1561 for (ii=0; ii<commands.used; ++ii) {
1562 svccmd = commands.list[ii];
1563 tbl.contents[ii+1] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1564 tbl.contents[ii+1][0] = svccmd->name;
1565 if (show_opserv_level)
1566 tbl.contents[ii+1][1] = strtab(svccmd->min_opserv_level);
1567 if (show_channel_access) {
1569 int flags = svccmd->effective_flags;
1570 if (flags & MODCMD_REQUIRE_HELPING)
1572 else if (flags & MODCMD_REQUIRE_STAFF) {
1573 switch (flags & MODCMD_REQUIRE_STAFF) {
1574 case MODCMD_REQUIRE_OPER: access = "oper"; break;
1575 case MODCMD_REQUIRE_OPER | MODCMD_REQUIRE_NETWORK_HELPER:
1576 case MODCMD_REQUIRE_NETWORK_HELPER: access = "net.helper"; break;
1577 default: access = "staff"; break;
1580 access = strtab(svccmd->min_channel_access);
1581 tbl.contents[ii+1][1+show_opserv_level] = access;
1584 svccmd_list_clean(&commands);
1585 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1589 static MODCMD_FUNC(cmd_helpfiles) {
1590 struct service *service;
1593 if (!(service = dict_find(services, argv[1], NULL))) {
1594 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1599 for (ii=0; ii<service->modules.used; ++ii)
1600 reply("MCMSG_HELPFILE_SEQUENCE", ii+1, service->modules.list[ii]->name);
1604 service->modules.used = 0;
1605 for (ii=0; ii<argc-2; ii++) {
1606 struct module *module = dict_find(modules, argv[ii+2], NULL);
1608 reply("MCMSG_UNKNOWN_MODULE", argv[ii+2]);
1611 module_list_append(&service->modules, module);
1613 reply("MCMSG_HELPFILE_SEQUENCE_SET", service->bot->nick);
1617 static MODCMD_FUNC(cmd_service_add) {
1618 const char *nick, *desc;
1619 struct userNode *bot;
1622 if (!is_valid_nick(nick)) {
1623 reply("MCMSG_BAD_SERVICE_NICK", nick);
1626 desc = unsplit_string(argv+2, argc-2, NULL);
1627 bot = GetUserH(nick);
1628 if (bot && IsService(bot)) {
1629 reply("MCMSG_ALREADY_SERVICE", bot->nick);
1632 bot = AddService(nick, desc);
1633 service_register(bot, '\0');
1634 reply("MCMSG_NEW_SERVICE", bot->nick);
1638 static MODCMD_FUNC(cmd_service_rename) {
1639 struct service *service;
1641 if (!(service = service_find(argv[1]))) {
1642 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1645 NickChange(service->bot, argv[2], 0);
1646 reply("MCMSG_SERVICE_RENAMED", service->bot->nick);
1650 static MODCMD_FUNC(cmd_service_trigger) {
1651 struct userNode *bogon;
1652 struct service *service;
1654 if (!(service = service_find(argv[1]))) {
1655 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1659 if (service->trigger)
1660 reply("MCMSG_CURRENT_TRIGGER", service->bot->nick, service->trigger);
1662 reply("MCMSG_NO_TRIGGER", service->bot->nick);
1665 if (service->trigger)
1666 reg_chanmsg_func(service->trigger, NULL, NULL);
1667 if (!irccasecmp(argv[2], "none") || !irccasecmp(argv[2], "remove")) {
1668 service->trigger = 0;
1669 reply("MCMSG_REMOVED_TRIGGER", service->bot->nick);
1670 } else if ((bogon = get_chanmsg_bot(argv[2][0]))) {
1671 reply("MCMSG_DUPLICATE_TRIGGER", bogon->nick, argv[2][0]);
1674 service->trigger = argv[2][0];
1675 reg_chanmsg_func(service->trigger, service->bot, modcmd_chanmsg);
1676 reply("MCMSG_NEW_TRIGGER", service->bot->nick, service->trigger);
1681 static MODCMD_FUNC(cmd_service_privileged) {
1682 struct service *service;
1685 if (!(service = service_find(argv[1]))) {
1686 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1690 service->privileged = true_string(argv[2]) || enabled_string(argv[2]);
1691 newval = user_find_message(user, service->privileged ? "MSG_ON" : "MSG_OFF");
1692 reply("MCMSG_SERVICE_PRIVILEGED", service->bot->nick, newval);
1696 static MODCMD_FUNC(cmd_service_remove) {
1697 char *name, *reason;
1698 struct service *service;
1702 reason = unsplit_string(argv+2, argc-2, NULL);
1704 reason = "Removing bot";
1705 if (!(service = service_find(name))) {
1706 reply("MCMSG_UNKNOWN_SERVICE", name);
1709 DelUser(service->bot, NULL, 1, reason);
1710 reply("MCMSG_SERVICE_REMOVED", name);
1711 dict_remove(services, name);
1715 static MODCMD_FUNC(cmd_dump_messages) {
1716 const char *fname = "strings.db";
1717 struct saxdb_context *ctx;
1721 if (!(pf = fopen(fname, "w"))) {
1722 reply("MCMSG_FILE_NOT_OPENED", fname);
1725 if (!(ctx = saxdb_open_context(pf))) {
1726 reply("MSG_INTERNAL_FAILURE");
1729 for (it = dict_first(lang_C->messages); it; it = iter_next(it))
1730 saxdb_write_string(ctx, iter_key(it), iter_data(it));
1731 saxdb_close_context(ctx);
1733 reply("MCMSG_MESSAGES_DUMPED", fname);
1737 static MODCMD_FUNC(cmd_version) {
1738 reply("MCMSG_VERSION");
1739 send_message_type(4, user, cmd->parent->bot, "Copyright 2000-2004 srvx Development Team.\nThe 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.");
1740 if ((argc > 1) && !irccasecmp(argv[1], "arch"))
1741 send_message_type(4, user, cmd->parent->bot, "%s", ARCH_VERSION);
1747 modcmd_nick_change(struct userNode *user, const char *old_nick) {
1748 struct service *svc;
1749 if (!(svc = dict_find(services, old_nick, NULL)))
1751 dict_remove2(services, old_nick, 1);
1752 dict_insert(services, user->nick, svc);
1756 modcmd_cleanup(void) {
1757 dict_delete(services);
1758 dict_delete(modules);
1764 modcmd_saxdb_write_command(struct saxdb_context *ctx, struct svccmd *cmd) {
1766 unsigned int nn, len, pos;
1767 struct svccmd *template = cmd->command->defaults;
1769 saxdb_start_record(ctx, cmd->name, 0);
1770 sprintf(buf, "%s.%s", cmd->command->parent->name, cmd->command->name);
1771 saxdb_write_string(ctx, "command", buf);
1772 if (cmd->alias.used)
1773 saxdb_write_string_list(ctx, "aliased", &cmd->alias);
1774 if (cmd->min_opserv_level != template->min_opserv_level)
1775 saxdb_write_int(ctx, "oper_access", cmd->min_opserv_level);
1776 if (cmd->min_channel_access != template->min_channel_access)
1777 saxdb_write_int(ctx, "channel_access", cmd->min_channel_access);
1778 if (cmd->flags != template->flags) {
1780 for (nn=pos=0; flags[nn].name; ++nn) {
1781 if (cmd->flags & flags[nn].flag) {
1783 len = strlen(flags[nn].name);
1784 memcpy(buf+pos, flags[nn].name, len);
1793 saxdb_write_string(ctx, "flags", buf);
1795 if ((cmd->req_account_flags != template->req_account_flags)
1796 || (cmd->deny_account_flags != template->req_account_flags)) {
1798 if (cmd->req_account_flags) {
1800 for (nn=0; nn<32; nn++)
1801 if (cmd->req_account_flags & (1 << nn))
1802 buf[pos++] = handle_flags[nn];
1804 if (cmd->deny_account_flags) {
1806 for (nn=0; nn<32; nn++)
1807 if (cmd->deny_account_flags & (1 << nn))
1808 buf[pos++] = handle_flags[nn];
1811 saxdb_write_string(ctx, "account_flags", buf);
1813 saxdb_end_record(ctx);
1817 modcmd_saxdb_write(struct saxdb_context *ctx) {
1818 struct string_list slist;
1819 dict_iterator_t it, it2;
1820 struct service *service;
1823 saxdb_start_record(ctx, "bots", 1);
1824 for (it = dict_first(services); it; it = iter_next(it)) {
1826 service = iter_data(it);
1827 saxdb_start_record(ctx, service->bot->nick, 1);
1828 if (service->trigger) {
1829 buff[0] = service->trigger;
1831 saxdb_write_string(ctx, "trigger", buff);
1833 saxdb_write_string(ctx, "description", service->bot->info);
1834 if (service->privileged)
1835 saxdb_write_string(ctx, "privileged", "1");
1836 saxdb_end_record(ctx);
1838 saxdb_end_record(ctx);
1840 saxdb_start_record(ctx, "services", 1);
1841 for (it = dict_first(services); it; it = iter_next(it)) {
1842 service = iter_data(it);
1843 saxdb_start_record(ctx, service->bot->nick, 1);
1844 for (it2 = dict_first(service->commands); it2; it2 = iter_next(it2))
1845 modcmd_saxdb_write_command(ctx, iter_data(it2));
1846 saxdb_end_record(ctx);
1848 saxdb_end_record(ctx);
1850 saxdb_start_record(ctx, "helpfiles", 1);
1852 for (it = dict_first(services); it; it = iter_next(it)) {
1853 service = iter_data(it);
1855 for (ii = 0; ii < service->modules.used; ++ii)
1856 string_list_append(&slist, service->modules.list[ii]->name);
1857 saxdb_write_string_list(ctx, iter_key(it), &slist);
1861 saxdb_end_record(ctx);
1867 append_entry(const char *key, UNUSED_ARG(void *data), void *extra) {
1868 struct helpfile_expansion *exp = extra;
1869 int row = exp->value.table.length++;
1870 exp->value.table.contents[row] = calloc(1, sizeof(char*));
1871 exp->value.table.contents[row][0] = key;
1875 static struct helpfile_expansion
1876 modcmd_expand(const char *variable) {
1877 struct helpfile_expansion exp;
1878 extern struct userNode *message_source;
1879 struct service *service;
1881 service = dict_find(services, message_source->nick, NULL);
1882 if (!irccasecmp(variable, "index")) {
1883 exp.type = HF_TABLE;
1884 exp.value.table.length = 1;
1885 exp.value.table.width = 1;
1886 exp.value.table.flags = TABLE_REPEAT_ROWS;
1887 exp.value.table.contents = calloc(dict_size(service->commands)+1, sizeof(char**));
1888 exp.value.table.contents[0] = calloc(1, sizeof(char*));
1889 exp.value.table.contents[0][0] = "Commands:";
1890 dict_foreach(service->commands, append_entry, &exp);
1892 } else if (!irccasecmp(variable, "languages")) {
1893 struct string_buffer sbuf;
1895 sbuf.used = sbuf.size = 0;
1897 for (it = dict_first(languages); it; it = iter_next(it)) {
1898 string_buffer_append_string(&sbuf, iter_key(it));
1899 string_buffer_append(&sbuf, ' ');
1901 sbuf.list[--sbuf.used] = 0;
1902 exp.type = HF_STRING;
1903 exp.value.str = sbuf.list;
1906 exp.type = HF_STRING;
1907 exp.value.str = NULL;
1912 modcmd_load_bots(struct dict *db) {
1915 for (it = dict_first(db); it; it = iter_next(it)) {
1916 struct record_data *rd;
1917 struct userNode *bot;
1918 const char *nick, *desc;
1922 if (rd->type != RECDB_OBJECT) {
1923 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'bots/%s' in modcmd db (expected object).", iter_key(it));
1926 nick = database_get_data(rd->d.object, "nick", RECDB_QSTRING);
1928 nick = iter_key(it);
1929 if (service_find(nick))
1931 desc = database_get_data(rd->d.object, "trigger", RECDB_QSTRING);
1932 trigger = desc ? desc[0] : '\0';
1933 desc = database_get_data(rd->d.object, "description", RECDB_QSTRING);
1936 struct service *svc;
1937 bot = AddService(nick, desc);
1938 svc = service_register(bot, trigger);
1939 desc = database_get_data(rd->d.object, "privileged", RECDB_QSTRING);
1940 if (desc && (true_string(desc) || enabled_string(desc)))
1941 svc->privileged = 1;
1947 modcmd_conf_read(void) {
1948 modcmd_load_bots(conf_get_data("services", RECDB_OBJECT));
1953 qsort(flags, ArrayLength(flags)-1, sizeof(flags[0]), flags_qsort);
1954 modules = dict_new();
1955 dict_set_free_data(modules, free_module);
1956 services = dict_new();
1957 dict_set_free_data(services, free_service);
1958 reg_nick_change_func(modcmd_nick_change);
1959 reg_exit_func(modcmd_cleanup);
1960 conf_register_reload(modcmd_conf_read);
1962 modcmd_module = module_register("modcmd", MAIN_LOG, "modcmd.help", modcmd_expand);
1963 bind_command = modcmd_register(modcmd_module, "bind", cmd_bind, 4, MODCMD_KEEP_BOUND, "oper_level", "800", NULL);
1964 help_command = modcmd_register(modcmd_module, "help", cmd_help, 1, 0, "flags", "+nolog", NULL);
1965 modcmd_register(modcmd_module, "command", cmd_command, 2, 0, "flags", "+nolog", NULL);
1966 modcmd_register(modcmd_module, "modcmd", cmd_modcmd, 4, MODCMD_KEEP_BOUND, "template", "bind", NULL);
1967 modcmd_register(modcmd_module, "god", cmd_god, 0, MODCMD_REQUIRE_AUTHED, "flags", "+oper,+networkhelper", NULL);
1968 modcmd_register(modcmd_module, "readhelp", cmd_readhelp, 2, 0, "oper_level", "650", NULL);
1969 modcmd_register(modcmd_module, "timecmd", cmd_timecmd, 2, 0, "oper_level", "1", NULL);
1970 modcmd_register(modcmd_module, "unbind", cmd_unbind, 3, 0, "template", "bind", NULL);
1971 modcmd_register(modcmd_module, "joiner", cmd_joiner, 1, 0, NULL);
1972 modcmd_register(modcmd_module, "stats modules", cmd_stats_modules, 1, 0, "flags", "+oper", NULL);
1973 modcmd_register(modcmd_module, "stats services", cmd_stats_services, 1, 0, "flags", "+oper", NULL);
1974 modcmd_register(modcmd_module, "showcommands", cmd_showcommands, 1, 0, "flags", "+acceptchan", NULL);
1975 modcmd_register(modcmd_module, "helpfiles", cmd_helpfiles, 2, 0, "template", "bind", NULL);
1976 modcmd_register(modcmd_module, "service add", cmd_service_add, 3, 0, "flags", "+oper", NULL);
1977 modcmd_register(modcmd_module, "service rename", cmd_service_rename, 3, 0, "flags", "+oper", NULL);
1978 modcmd_register(modcmd_module, "service trigger", cmd_service_trigger, 2, 0, "flags", "+oper", NULL);
1979 modcmd_register(modcmd_module, "service privileged", cmd_service_privileged, 2, 0, "flags", "+oper", NULL);
1980 modcmd_register(modcmd_module, "service remove", cmd_service_remove, 2, 0, "flags", "+oper", NULL);
1981 modcmd_register(modcmd_module, "dumpmessages", cmd_dump_messages, 1, 0, "oper_level", "1000", NULL);
1982 version_command = modcmd_register(modcmd_module, "version", cmd_version, 1, 0, NULL);
1983 message_register_table(msgtab);
1987 modcmd_db_load_command(struct service *service, const char *cmdname, struct dict *obj) {
1988 struct svccmd *svccmd;
1989 struct module *module;
1990 struct modcmd *modcmd;
1991 struct string_list *slist;
1992 const char *str, *sep;
1995 str = database_get_data(obj, "command", RECDB_QSTRING);
1997 log_module(MAIN_LOG, LOG_ERROR, "Missing command for service %s command %s in modcmd.db", service->bot->nick, cmdname);
2000 sep = strchr(str, '.');
2002 log_module(MAIN_LOG, LOG_ERROR, "Invalid command %s for service %s command %s in modcmd.db", str, service->bot->nick, cmdname);
2005 memcpy(buf, str, sep-str);
2007 if (!(module = module_find(buf))) {
2008 log_module(MAIN_LOG, LOG_ERROR, "Unknown module %s for service %s command %s in modcmd.db", buf, service->bot->nick, cmdname);
2011 if (!(modcmd = dict_find(module->commands, sep+1, NULL))) {
2012 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);
2015 /* Now that we know we have a command to use, fill in the basics. */
2016 svccmd = calloc(1, sizeof(*svccmd));
2017 svccmd_insert(service, strdup(cmdname), svccmd, modcmd);
2018 if ((str = database_get_data(obj, "template", RECDB_QSTRING))) {
2019 add_pending_template(svccmd, str);
2021 svccmd_copy_rules(svccmd, modcmd->defaults);
2023 if ((str = database_get_data(obj, "account_flags", RECDB_QSTRING))) {
2024 svccmd->req_account_flags = svccmd->deny_account_flags = 0;
2025 svccmd_configure(svccmd, NULL, service->bot, "account_flags", str);
2027 if ((str = database_get_data(obj, "flags", RECDB_QSTRING))) {
2029 svccmd_configure(svccmd, NULL, service->bot, "flags", str);
2031 if ((str = database_get_data(obj, "oper_access", RECDB_QSTRING))
2032 || (str = database_get_data(obj, "opserv_level", RECDB_QSTRING))) {
2033 svccmd_configure(svccmd, NULL, service->bot, "oper_access", str);
2035 if ((str = database_get_data(obj, "channel_access", RECDB_QSTRING))
2036 || (str = database_get_data(obj, "chanserv_level", RECDB_QSTRING))) {
2037 svccmd_configure(svccmd, NULL, service->bot, "channel_access", str);
2039 if ((slist = database_get_data(obj, "aliased", RECDB_STRING_LIST))) {
2041 svccmd->alias.used = svccmd->alias.size = slist->used;
2042 svccmd->alias.list = calloc(svccmd->alias.size, sizeof(svccmd->alias.list[0]));
2043 for (nn=0; nn<slist->used; ++nn)
2044 svccmd->alias.list[nn] = strdup(slist->list[nn]);
2046 modcmd_set_effective_flags(svccmd);
2049 static struct svccmd *
2050 service_make_alias(struct service *service, const char *alias, ...) {
2051 char *arg, *argv[MAXNUMPARAMS];
2052 unsigned int nn, argc;
2053 struct svccmd *svccmd, *template;
2056 va_start(args, alias);
2059 arg = va_arg(args, char*);
2065 svccmd = calloc(1, sizeof(*svccmd));
2066 if (!(template = svccmd_resolve_name(svccmd, argv[0]))) {
2067 log_module(MAIN_LOG, LOG_ERROR, "Invalid base command %s for alias %s in service %s", argv[0], alias, service->bot->nick);
2073 svccmd->alias.used = svccmd->alias.size = argc;
2074 svccmd->alias.list = calloc(svccmd->alias.size, sizeof(svccmd->alias.list[0]));
2075 for (nn=0; nn<argc; nn++)
2076 svccmd->alias.list[nn] = strdup(argv[nn]);
2078 svccmd_insert(service, strdup(alias), svccmd, template->command);
2079 svccmd_copy_rules(svccmd, template);
2083 static int saxdb_present;
2086 modcmd_saxdb_read(struct dict *db) {
2088 dict_iterator_t it, it2;
2089 struct record_data *rd, *rd2;
2090 struct service *service;
2092 modcmd_load_bots(database_get_data(db, "bots", RECDB_OBJECT));
2093 db2 = database_get_data(db, "services", RECDB_OBJECT);
2095 log_module(MAIN_LOG, LOG_ERROR, "Missing section 'services' in modcmd db.");
2098 for (it = dict_first(db2); it; it = iter_next(it)) {
2100 if (rd->type != RECDB_OBJECT) {
2101 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'services/%s' in modcmd db (expected object).", iter_key(it));
2104 if (!(service = service_find(iter_key(it)))) {
2105 log_module(MAIN_LOG, LOG_ERROR, "Unknown service '%s' listed in modcmd db.", iter_key(it));
2108 for (it2 = dict_first(rd->d.object); it2; it2 = iter_next(it2)) {
2109 rd2 = iter_data(it2);
2110 if (rd2->type != RECDB_OBJECT) {
2111 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'services/%s/%s' in modcmd db (expected object).", iter_key(it), iter_key(it2));
2114 modcmd_db_load_command(service, iter_key(it2), rd2->d.object);
2117 db2 = database_get_data(db, "helpfiles", RECDB_OBJECT);
2118 for (it = dict_first(db2); it; it = iter_next(it)) {
2119 struct module *module;
2120 struct string_list *slist;
2124 if (rd->type != RECDB_STRING_LIST) {
2125 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'helpfiles/%s' in modcmd db (expected string list).", iter_key(it));
2128 slist = rd->d.slist;
2129 if (!(service = service_find(iter_key(it)))) {
2130 /* We probably whined about the service being missing above. */
2133 service->modules.used = 0;
2134 for (ii=0; ii<slist->used; ++ii) {
2135 if (!(module = dict_find(modules, slist->list[ii], NULL))) {
2136 log_module(MAIN_LOG, LOG_ERROR, "Unknown module '%s' listed in modcmd 'helpfiles/%s'.", slist->list[ii], iter_key(it));
2139 module_list_append(&service->modules, module);
2147 create_default_binds(void) {
2148 /* Which services should import which modules by default? */
2150 const char *svcname;
2151 /* C is lame and requires a fixed size for this array.
2152 * Be sure you NULL-terminate each array and increment the
2153 * size here if you add more default modules to any
2155 const char *modnames[8];
2157 { "ChanServ", { "ChanServ", NULL } },
2158 { "Global", { "Global", NULL } },
2159 { "NickServ", { "NickServ", NULL } },
2160 { "OpServ", { "OpServ", "modcmd", "sendmail", "saxdb", "proxycheck", NULL } },
2163 unsigned int ii, jj;
2164 char buf[128], *nick;
2165 struct service *service;
2166 struct module *module;
2168 for (ii = 0; def_binds[ii].svcname; ++ii) {
2169 sprintf(buf, "services/%s/nick", def_binds[ii].svcname);
2170 if (!(nick = conf_get_data(buf, RECDB_QSTRING)))
2172 if (!(service = service_find(nick)))
2174 if (dict_size(service->commands) > 0)
2177 /* Bind the default modules for this service to it */
2178 for (jj = 0; def_binds[ii].modnames[jj]; ++jj) {
2179 if (!(module = module_find(def_binds[ii].modnames[jj])))
2181 service_bind_module(service, module);
2184 /* Bind the help and version commands to this service */
2185 service_bind_modcmd(service, help_command, help_command->name);
2186 service_bind_modcmd(service, version_command, version_command->name);
2188 /* Now some silly hax.. (aliases that most people want) */
2189 if (!irccasecmp(def_binds[ii].svcname, "ChanServ")) {
2190 service_make_alias(service, "addowner", "*chanserv.adduser", "$1", "owner", NULL);
2191 service_make_alias(service, "addcoowner", "*chanserv.adduser", "$1", "coowner", NULL);
2192 service_make_alias(service, "addmaster", "*chanserv.adduser", "$1", "master", NULL);
2193 service_make_alias(service, "addop", "*chanserv.adduser", "$1", "op", NULL);
2194 service_make_alias(service, "addpeon", "*chanserv.adduser", "$1", "peon", NULL);
2195 service_make_alias(service, "delowner", "*chanserv.deluser", "owner", "$1", NULL);
2196 service_make_alias(service, "delcoowner", "*chanserv.deluser", "coowner", "$1", NULL);
2197 service_make_alias(service, "delmaster", "*chanserv.deluser", "master", "$1", NULL);
2198 service_make_alias(service, "delop", "*chanserv.deluser", "op", "$1", NULL);
2199 service_make_alias(service, "delpeon", "*chanserv.deluser", "peon", "$1", NULL);
2200 service_make_alias(service, "command", "*modcmd.command", NULL);
2201 service_make_alias(service, "god", "*modcmd.god", NULL);
2202 } else if (!irccasecmp(def_binds[ii].svcname, "OpServ")) {
2203 struct svccmd *svccmd;
2204 svccmd = service_make_alias(service, "stats", "*modcmd.joiner", NULL);
2205 svccmd->min_opserv_level = 101;
2206 svccmd = service_make_alias(service, "service", "*modcmd.joiner", NULL);
2207 svccmd->min_opserv_level = 900;
2213 import_aliases_db() {
2215 dict_iterator_t it, it2;
2216 struct record_data *rd, *rd2;
2217 struct service *service;
2218 struct module *module;
2220 if (!(db = parse_database("aliases.db")))
2222 for (it = dict_first(db); it; it = iter_next(it)) {
2223 service = service_find(iter_key(it));
2226 module = module_find(service->bot->nick);
2228 if (rd->type != RECDB_OBJECT)
2230 for (it2 = dict_first(rd->d.object); it2; it2 = iter_next(it2)) {
2231 struct modcmd *command;
2232 rd2 = iter_data(it2);
2233 if (rd2->type != RECDB_QSTRING)
2235 command = dict_find(module->commands, rd2->d.qstring, NULL);
2238 service_bind_modcmd(service, command, iter_key(it2));
2244 modcmd_finalize(void) {
2245 /* Check databases. */
2246 saxdb_register("modcmd", modcmd_saxdb_read, modcmd_saxdb_write);
2247 create_default_binds();
2249 import_aliases_db();
2251 /* Resolve command rule-templates. */
2252 while (pending_templates) {
2253 struct pending_template *ptempl = pending_templates;
2254 struct svccmd *svccmd;
2256 pending_templates = ptempl->next;
2257 /* Only overwrite the current template if we have a valid template. */
2258 if (!strcmp(ptempl->base, "*")) {
2260 } else if ((svccmd = svccmd_resolve_name(ptempl->cmd, ptempl->base))) {
2261 svccmd_copy_rules(ptempl->cmd, svccmd);
2263 assert(ptempl->cmd->parent);
2264 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);