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." },
123 { "MCMSG_COMMAND_FLAGS", "Command flags are %s (inferred: %s)." },
124 { "MCMSG_COMMAND_ACCOUNT_FLAGS", "Requires account flags +%s, prohibits account flags +%s." },
125 { "MCMSG_COMMAND_ACCESS_LEVEL", "Requires channel access %d and $O access %d." },
126 { "MCMSG_COMMAND_USES", "%s has been used %d times." },
129 struct userData *_GetChannelUser(struct chanData *channel, struct handle_info *handle, int override, int allow_suspended);
131 #define ACTION_ALLOW 1
132 #define ACTION_OVERRIDE 2
133 #define ACTION_NOCHANNEL 4
134 #define ACTION_STAFF 8
136 #define RESOLVE_DEPTH 4
138 static struct modcmd_flag {
142 { "acceptchan", MODCMD_ACCEPT_CHANNEL },
143 { "acceptpluschan", MODCMD_ACCEPT_PCHANNEL },
144 { "authed", MODCMD_REQUIRE_AUTHED },
145 { "channel", MODCMD_REQUIRE_CHANNEL },
146 { "chanuser", MODCMD_REQUIRE_CHANUSER },
147 { "disabled", MODCMD_DISABLED },
148 { "ignore_csuspend", MODCMD_IGNORE_CSUSPEND },
149 { "joinable", MODCMD_REQUIRE_JOINABLE },
150 { "keepbound", MODCMD_KEEP_BOUND },
151 { "loghostmask", MODCMD_LOG_HOSTMASK },
152 { "nolog", MODCMD_NO_LOG },
153 { "networkhelper", MODCMD_REQUIRE_NETWORK_HELPER },
154 { "never_csuspend", MODCMD_NEVER_CSUSPEND },
155 { "oper", MODCMD_REQUIRE_OPER },
156 { "qualified", MODCMD_REQUIRE_QUALIFIED },
157 { "regchan", MODCMD_REQUIRE_REGCHAN },
158 { "supporthelper", MODCMD_REQUIRE_SUPPORT_HELPER },
159 { "helping", MODCMD_REQUIRE_HELPING },
160 { "toy", MODCMD_TOY },
165 flags_bsearch(const void *a, const void *b) {
167 const struct modcmd_flag *flag = b;
168 return ircncasecmp(key, flag->name, strlen(flag->name));
172 flags_qsort(const void *a, const void *b) {
173 const struct modcmd_flag *fa = a, *fb = b;
174 return irccasecmp(fa->name, fb->name);
177 DEFINE_LIST(svccmd_list, struct svccmd*);
178 DEFINE_LIST(module_list, struct module*);
181 free_service_command(void *data) {
182 struct svccmd *svccmd;
186 if (svccmd->alias.used) {
187 for (nn=0; nn<svccmd->alias.used; ++nn)
188 free(svccmd->alias.list[nn]);
189 free(svccmd->alias.list);
196 free_service(void *data) {
197 struct service *service = data;
198 dict_delete(service->commands);
199 module_list_clean(&service->modules);
204 free_module_command(void *data) {
205 struct modcmd *modcmd = data;
206 free_service_command(modcmd->defaults);
212 free_module(void *data) {
213 struct module *module = data;
214 dict_delete(module->commands);
215 close_helpfile(module->helpfile);
221 module_register(const char *name, struct log_type *clog, const char *helpfile_name, expand_func_t expand_help) {
222 struct module *newmod;
224 newmod = calloc(1, sizeof(*newmod));
225 newmod->name = strdup(name);
226 newmod->commands = dict_new();
227 dict_set_free_data(newmod->commands, free_module_command);
229 newmod->helpfile_name = helpfile_name;
230 newmod->expand_help = expand_help;
231 if (newmod->helpfile_name) {
232 newmod->helpfile = open_helpfile(newmod->helpfile_name, newmod->expand_help);
234 dict_insert(modules, newmod->name, newmod);
239 module_find(const char *name) {
240 return dict_find(modules, name, NULL);
244 add_pending_template(struct svccmd *cmd, const char *target) {
245 struct pending_template *pending = calloc(1, sizeof(*pending));
247 pending->base = strdup(target);
248 pending->next = pending_templates;
249 pending_templates = pending;
252 static struct svccmd *
253 svccmd_resolve_name(struct svccmd *origin, const char *name) {
254 char *sep, svcname[MAXLEN];
256 if ((sep = strchr(name, '.'))) {
257 memcpy(svcname, name, sep-name);
258 svcname[sep-name] = 0;
260 if (svcname[0] == '*') {
261 struct module *module = module_find(svcname+1);
262 struct modcmd *cmd = module ? dict_find(module->commands, name, NULL) : NULL;
263 return cmd ? cmd->defaults : NULL;
265 struct service *service = service_find(svcname);
266 return service ? dict_find(service->commands, name, NULL) : NULL;
269 if (origin->parent) {
270 return dict_find(origin->parent->commands, name, NULL);
272 struct modcmd *cmd = dict_find(origin->command->parent->commands, name, NULL);
273 return cmd ? cmd->defaults : NULL;
279 modcmd_set_effective_flags(struct svccmd *cmd) {
280 int flags = cmd->flags | cmd->command->flags;
281 if (cmd->min_opserv_level > 0)
282 flags |= MODCMD_REQUIRE_OPER;
283 if (cmd->min_channel_access > 0)
284 flags |= MODCMD_REQUIRE_CHANUSER;
285 if (flags & MODCMD_REQUIRE_CHANUSER)
286 flags |= MODCMD_REQUIRE_REGCHAN;
287 if (flags & MODCMD_REQUIRE_REGCHAN)
288 flags |= MODCMD_REQUIRE_CHANNEL;
289 if (flags & (MODCMD_REQUIRE_STAFF|MODCMD_REQUIRE_HELPING))
290 flags |= MODCMD_REQUIRE_AUTHED;
291 cmd->effective_flags = flags;
295 svccmd_copy_rules(struct svccmd *dest, struct svccmd *src) {
296 dest->flags |= src->flags;
297 dest->req_account_flags |= src->req_account_flags;
298 dest->deny_account_flags |= src->deny_account_flags;
299 if (src->min_opserv_level > dest->min_opserv_level)
300 dest->min_opserv_level = src->min_opserv_level;
301 if (src->min_channel_access > dest->min_channel_access)
302 dest->min_channel_access = src->min_channel_access;
303 modcmd_set_effective_flags(dest);
307 svccmd_configure(struct svccmd *cmd, struct userNode *user, struct userNode *bot, const char *param, const char *value) {
308 if (!irccasecmp(param, "flags")) {
309 unsigned int set_flags, rem_flags;
310 struct modcmd_flag *flag;
313 for (set_flags = rem_flags = 0; 1; value += end) {
314 end = strcspn(value, ",");
317 else if (*value == '-')
321 send_message(user, bot, "MCMSG_BARE_FLAG", end, value);
323 log_module(MAIN_LOG, LOG_ERROR, "Flag %.*s must be preceded by a + or - (for command %s).", end, value, cmd->name);
327 flag = bsearch(value, flags, ArrayLength(flags)-1, sizeof(flags[0]), flags_bsearch);
330 send_message(user, bot, "MCMSG_UNKNOWN_FLAG", end, value);
332 log_module(MAIN_LOG, LOG_ERROR, "Unknown module flag %.*s (for command %s).", end, value, cmd->name);
336 set_flags |= flag->flag, rem_flags &= ~flag->flag;
338 rem_flags |= flag->flag, set_flags &= ~flag->flag;
342 cmd->flags = (cmd->flags | set_flags) & ~rem_flags;
344 } else if (!irccasecmp(param, "channel_level") || !irccasecmp(param, "channel_access") || !irccasecmp(param, "access")) {
346 if (!irccasecmp(value, "none") || !irccasecmp(value, "0")) {
347 cmd->min_channel_access = 0;
349 } else if ((ul = user_level_from_name(value, UL_OWNER)) > 0) {
350 cmd->min_channel_access = ul;
353 send_message(user, bot, "MCMSG_BAD_CHANSERV_LEVEL", value);
356 log_module(MAIN_LOG, LOG_ERROR, "Invalid ChanServ access level %s (for command %s).", value, cmd->name);
359 } else if (!irccasecmp(param, "oper_level") || !irccasecmp(param, "oper_access") || !irccasecmp(param, "level")) {
360 unsigned int newval = atoi(value);
361 if (!isdigit(value[0]) || (newval > 1000)) {
363 send_message(user, bot, "MCMSG_BAD_OPSERV_LEVEL", value);
365 log_module(MAIN_LOG, LOG_ERROR, "Invalid OpServ access level %s (for command %s).", value, cmd->name);
368 if (user && (!user->handle_info || (cmd->min_opserv_level > user->handle_info->opserv_level))) {
369 send_message(user, bot, "MCMSG_LEVEL_TOO_LOW", cmd->name);
372 if (user && (!user->handle_info || (newval > user->handle_info->opserv_level))) {
373 send_message(user, bot, "MCMSG_LEVEL_TOO_HIGH", value);
376 cmd->min_opserv_level = newval;
378 } else if (!irccasecmp(param, "account_flags")) {
379 return nickserv_modify_handle_flags(user, bot, value, &cmd->req_account_flags, &cmd->deny_account_flags);
382 send_message(user, bot, "MCMSG_BAD_OPTION", param);
384 log_module(MAIN_LOG, LOG_ERROR, "Unknown option %s (for command %s).", param, cmd->name);
390 modcmd_register(struct module *module, const char *name, modcmd_func_t func, unsigned int min_argc, unsigned int flags, ...) {
391 struct modcmd *newcmd;
393 const char *param, *value;
395 newcmd = calloc(1, sizeof(*newcmd));
396 newcmd->name = strdup(name);
397 newcmd->parent = module;
399 newcmd->min_argc = min_argc;
400 newcmd->flags = flags;
401 newcmd->defaults = calloc(1, sizeof(*newcmd->defaults));
402 newcmd->defaults->name = strdup(newcmd->name);
403 newcmd->defaults->command = newcmd;
404 dict_insert(module->commands, newcmd->name, newcmd);
405 if (newcmd->flags & (MODCMD_REQUIRE_REGCHAN|MODCMD_REQUIRE_CHANNEL|MODCMD_REQUIRE_CHANUSER|MODCMD_REQUIRE_JOINABLE)) {
406 newcmd->defaults->flags |= MODCMD_ACCEPT_CHANNEL;
408 if (newcmd->flags & MODCMD_REQUIRE_STAFF) {
409 newcmd->defaults->flags |= MODCMD_REQUIRE_AUTHED;
411 va_start(args, flags);
412 while ((param = va_arg(args, const char*))) {
413 value = va_arg(args, const char*);
414 if (!irccasecmp(param, "template")) {
415 struct svccmd *svccmd = svccmd_resolve_name(newcmd->defaults, value);
417 svccmd_copy_rules(newcmd->defaults, svccmd);
419 log_module(MAIN_LOG, LOG_ERROR, "Unable to resolve template name %s for %s.%s.", value, newcmd->parent->name, newcmd->name);
421 add_pending_template(newcmd->defaults, value);
423 svccmd_configure(newcmd->defaults, NULL, NULL, param, value);
426 modcmd_set_effective_flags(newcmd->defaults);
431 /* This is kind of a lame hack, but it is actually simpler than having
432 * the permission check vary based on the command itself, or having a
433 * more generic rule system.
436 svccmd_can_invoke(struct userNode *user, struct userNode *bot, struct svccmd *cmd, struct chanNode *channel, int options) {
437 unsigned int uData_checked = 0;
438 struct userData *uData = NULL;
439 int rflags = 0, flags = cmd->effective_flags;
441 if (flags & MODCMD_DISABLED) {
442 if (options & SVCCMD_NOISY)
443 send_message(user, bot, "MSG_COMMAND_DISABLED", cmd->name);
446 if ((flags & MODCMD_REQUIRE_QUALIFIED) && !(options & SVCCMD_QUALIFIED)) {
447 if (options & SVCCMD_NOISY)
448 send_message(user, bot, "MCMSG_MUST_QUALIFY", bot->nick, cmd->name, bot->nick);
451 if (flags & MODCMD_REQUIRE_AUTHED) {
452 if (!user->handle_info) {
453 if (options & SVCCMD_NOISY)
454 send_message(user, bot, "MSG_AUTHENTICATE");
457 if (HANDLE_FLAGGED(user->handle_info, SUSPENDED)) {
458 if (options & SVCCMD_NOISY)
459 send_message(user, bot, "MCMSG_ACCOUNT_SUSPENDED");
463 if (channel || (options & SVCCMD_NOISY)) {
464 if ((flags & MODCMD_REQUIRE_CHANNEL) && !channel) {
465 if (options & SVCCMD_NOISY)
466 send_message(user, bot, "MSG_INVALID_CHANNEL");
469 if (flags & MODCMD_REQUIRE_REGCHAN) {
470 if (!channel->channel_info) {
471 if (options & SVCCMD_NOISY)
472 send_message(user, bot, "MCMSG_CHAN_NOT_REGISTERED", channel->name);
474 } else if (IsSuspended(channel->channel_info) && !(flags & MODCMD_IGNORE_CSUSPEND)) {
475 /* allow security-override users to always ignore channel suspensions, but flag it as a staff command */
476 if (!user->handle_info
477 || !HANDLE_FLAGGED(user->handle_info, HELPING)
478 || (flags & MODCMD_NEVER_CSUSPEND)) {
479 if (options & SVCCMD_NOISY)
480 send_message(user, bot, "MCMSG_CHAN_SUSPENDED", channel->name, channel->channel_info->suspended->reason);
483 rflags |= ACTION_STAFF;
486 if (flags & MODCMD_REQUIRE_CHANUSER) {
488 uData = _GetChannelUser(channel->channel_info, user->handle_info, 1, 0), uData_checked = 1;
490 if (options & SVCCMD_NOISY)
491 send_message(user, bot, "MCMSG_NO_CHANNEL_ACCESS", channel->name);
493 } else if (uData->access < cmd->min_channel_access) {
494 if (options & SVCCMD_NOISY)
495 send_message(user, bot, "MCMSG_LOW_CHANNEL_ACCESS", channel->name);
499 if ((flags & MODCMD_REQUIRE_JOINABLE) && channel) {
501 uData = _GetChannelUser(channel->channel_info, user->handle_info, 1, 0), uData_checked = 1;
502 if ((channel->modes & (MODE_INVITEONLY|MODE_KEY|MODE_SECRET))
505 && !GetUserMode(channel, user)) {
506 if (options & SVCCMD_NOISY)
507 send_message(user, bot, "MCMSG_REQUIRES_JOINABLE", channel->name);
511 if ((flags & MODCMD_TOY) && channel) {
512 if (!channel->channel_info)
513 rflags |= ACTION_NOCHANNEL;
514 else switch (channel->channel_info->chOpts[chToys]) {
516 if (options & SVCCMD_NOISY)
517 send_message(user, bot, "MCMSG_TOYS_DISABLED", channel->name);
520 rflags |= ACTION_NOCHANNEL;
527 if (flags & MODCMD_REQUIRE_STAFF) {
528 if (((flags & MODCMD_REQUIRE_OPER) && IsOper(user))
529 || ((flags & MODCMD_REQUIRE_NETWORK_HELPER) && IsNetworkHelper(user))
530 || ((flags & MODCMD_REQUIRE_SUPPORT_HELPER) && IsSupportHelper(user))) {
532 rflags |= ACTION_STAFF;
534 if (options & SVCCMD_NOISY)
535 send_message(user, bot, "MSG_COMMAND_PRIVILEGED", cmd->name);
539 if (flags & MODCMD_REQUIRE_HELPING) {
540 if (!HANDLE_FLAGGED(user->handle_info, HELPING)) {
541 if (options & SVCCMD_NOISY)
542 send_message(user, bot, "MCMSG_MUST_BE_HELPING");
545 rflags |= ACTION_STAFF;
547 if (cmd->min_opserv_level > 0) {
548 if (!oper_has_access(user, bot, cmd->min_opserv_level, !(options & SVCCMD_NOISY))) return 0;
549 rflags |= ACTION_STAFF;
551 if (cmd->req_account_flags || cmd->deny_account_flags) {
552 if (!user->handle_info) {
553 if (options & SVCCMD_NOISY)
554 send_message(user, bot, "MSG_AUTHENTICATE");
557 /* Do we want separate or different messages here? */
558 if ((cmd->req_account_flags & ~user->handle_info->flags)
559 || (cmd->deny_account_flags & user->handle_info->flags)) {
560 if (options & SVCCMD_NOISY)
561 send_message(user, bot, "MSG_COMMAND_PRIVILEGED", cmd->name);
566 /* If it's an override, return a special value. */
567 if ((flags & MODCMD_REQUIRE_CHANUSER)
568 && (options & SVCCMD_NOISY)
569 && (uData->access > 500)
570 && (!(uData = _GetChannelUser(channel->channel_info, user->handle_info, 0, 0))
571 || uData->access < cmd->min_channel_access)
572 && !(flags & (MODCMD_REQUIRE_STAFF|MODCMD_REQUIRE_HELPING))) {
573 rflags |= ACTION_OVERRIDE;
575 return rflags | ACTION_ALLOW;
579 svccmd_expand_alias(struct svccmd *cmd, unsigned int old_argc, char *old_argv[], char *new_argv[]) {
580 unsigned int ii, new_argc;
583 for (ii=new_argc=0; ii<cmd->alias.used; ++ii) {
584 arg = cmd->alias.list[ii];
586 new_argv[new_argc++] = arg;
590 new_argv[new_argc++] = arg + 1;
591 } else if (isdigit(arg[1])) {
592 unsigned int lbound, ubound, jj;
595 lbound = strtoul(arg+1, &end_num, 10);
596 switch (end_num[0]) {
597 case 0: ubound = lbound; break;
599 if (end_num[1] == 0) {
600 ubound = old_argc - 1;
602 } else if (isdigit(end_num[1])) {
603 ubound = strtoul(end_num+1, NULL, 10);
606 /* else fall through to default case */
608 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);
611 if (ubound >= old_argc)
612 ubound = old_argc - 1;
613 if (lbound < old_argc)
614 for (jj = lbound; jj <= ubound; )
615 new_argv[new_argc++] = old_argv[jj++];
617 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);
625 svccmd_invoke_argv(struct userNode *user, struct service *service, struct chanNode *channel, unsigned int argc, char *argv[], unsigned int server_qualified) {
626 extern struct userNode *chanserv;
628 unsigned int cmd_arg, perms, flags, options;
629 char channel_name[CHANNELLEN+1];
631 /* First check pubcmd for the channel. */
632 if (channel && (channel->channel_info) && (service->bot == chanserv)
633 && !check_user_level(channel, user, lvlPubCmd, 1, 0)) {
634 send_message(user, service->bot, "MCMSG_PUBLIC_DENY", channel->name);
638 options = (server_qualified ? SVCCMD_QUALIFIED : 0) | SVCCMD_DEBIT | SVCCMD_NOISY;
639 /* Find the command argument. */
640 cmd_arg = IsChannelName(argv[0]) ? 1 : 0;
641 if (argc < cmd_arg+1) {
642 send_message(user, service->bot, "MCMSG_MISSING_COMMAND");
645 if (!isalnum(*argv[cmd_arg])) {
646 /* Silently ignore stuff that doesn't begin with a letter or number. */
649 cmd = dict_find(service->commands, argv[cmd_arg], NULL);
652 send_message(user, service->bot, "MSG_COMMAND_UNKNOWN", argv[cmd_arg]);
655 flags = cmd->effective_flags;
656 /* If they put a channel name first, check if the command allows
657 * it. If so, swap it with the command name.
661 /* Complain if we're not supposed to accept the channel. */
662 if (!(flags & MODCMD_ACCEPT_CHANNEL)) {
663 send_message(user, service->bot, "MCMSG_NO_CHANNEL_BEFORE");
666 if (!(flags & MODCMD_ACCEPT_PCHANNEL)
667 && (argv[0][0] == '+')) {
668 send_message(user, service->bot, "MCMSG_NO_PLUS_CHANNEL");
676 /* Try to grab a channel handle before alias expansion.
677 * If the command accepts a channel name, and argv[1] is
678 * one, use it as a channel name, and hide it from logging.
681 && (flags & MODCMD_ACCEPT_CHANNEL)
682 && IsChannelName(argv[1])
683 && ((argv[1][0] != '+') || (flags & MODCMD_ACCEPT_PCHANNEL))
684 && (channel = dict_find(channels, argv[1], NULL))) {
690 /* Expand the alias arguments, if there are any. */
691 if (cmd->alias.used) {
692 char *new_argv[MAXNUMPARAMS];
693 argc = svccmd_expand_alias(cmd, argc, argv, new_argv);
695 send_message(service->bot, user, "MCMSG_ALIAS_ERROR", cmd->name);
700 /* Try again to grab a handle to the channel after alias
701 * expansion, overwriting any previous channel. This should,
702 * of course, only be done again if an alias was acually
705 && (flags & MODCMD_ACCEPT_CHANNEL)
706 && IsChannelName(argv[1])
707 && ((argv[1][0] != '+') || (flags & MODCMD_ACCEPT_PCHANNEL))
708 && (channel = dict_find(channels, argv[1], NULL))) {
715 /* Figure out what actions we should do for it.. */
716 if (cmd_arg && (flags & MODCMD_TOY)) {
717 /* Do not let user manually specify a channel. */
720 if (argc < cmd->command->min_argc) {
721 send_message(user, service->bot, "MSG_MISSING_PARAMS", cmd->name);
724 if (!cmd->command->func) {
725 send_message(user, service->bot, "MCMSG_INTERNAL_COMMAND", cmd->name);
728 perms = svccmd_can_invoke(user, service->bot, cmd, channel, options);
732 if (perms & ACTION_NOCHANNEL)
736 safestrncpy(channel_name, channel->name, sizeof(channel_name));
739 if (!cmd->command->func(user, channel, argc, argv, cmd))
741 if (!(flags & MODCMD_NO_LOG)) {
742 enum log_severity slvl;
743 if (perms & ACTION_STAFF)
745 else if (perms & ACTION_OVERRIDE)
749 /* Unsplit argv after running the function to get the benefit
750 * of any mangling/hiding done by the commands. */
751 log_audit(cmd->command->parent->clog, slvl, user, service->bot, channel_name, ((flags & MODCMD_LOG_HOSTMASK) ? AUDIT_HOSTMASK : 0), unsplit_string(argv, argc, NULL));
757 svccmd_send_help(struct userNode *user, struct userNode *bot, struct svccmd *cmd) {
758 char cmdname[MAXLEN];
760 /* Show command name (in bold). */
761 for (nn=0; cmd->name[nn]; nn++)
762 cmdname[nn] = toupper(cmd->name[nn]);
764 send_message_type(4, user, bot, "$b%s$b", cmdname);
765 /* If it's an alias, show what it's an alias for. */
766 if (cmd->alias.used) {
767 char alias_text[MAXLEN];
768 unsplit_string((char**)cmd->alias.list, cmd->alias.used, alias_text);
769 send_message(user, bot, "MCMSG_COMMAND_ALIASES", cmd->name, alias_text);
771 /* Show the help entry for the underlying command. */
772 return send_help(user, bot, cmd->command->parent->helpfile, cmd->command->name);
776 svccmd_send_help_2(struct userNode *user, struct service *service, const char *topic) {
777 struct module *module;
781 if ((cmd = dict_find(service->commands, topic, NULL)))
782 return svccmd_send_help(user, service->bot, cmd);
785 for (ii = 0; ii < service->modules.used; ++ii) {
786 module = service->modules.list[ii];
787 if (!module->helpfile)
789 if (dict_find(module->helpfile->db, topic, NULL))
790 return send_help(user, service->bot, module->helpfile, topic);
792 send_message(user, service->bot, "MSG_TOPIC_UNKNOWN");
797 svccmd_invoke(struct userNode *user, struct service *service, struct chanNode *channel, char *text, int server_qualified) {
799 char *argv[MAXNUMPARAMS];
803 if (service->privileged) {
805 send_message(user, service->bot, "MSG_SERVICE_PRIVILEGED", service->bot->nick);
808 if (!user->handle_info) {
809 send_message(user, service->bot, "MSG_AUTHENTICATE");
812 if (HANDLE_FLAGGED(user->handle_info, OPER_SUSPENDED)) {
813 send_message(user, service->bot, "MSG_OPER_SUSPENDED");
817 argc = split_line(text, false, ArrayLength(argv), argv);
818 return argc ? svccmd_invoke_argv(user, service, channel, argc, argv, server_qualified) : 0;
822 modcmd_privmsg(struct userNode *user, struct userNode *bot, char *text, int server_qualified) {
823 struct service *service;
824 if (!(service = dict_find(services, bot->nick, NULL))) {
825 log_module(MAIN_LOG, LOG_ERROR, "modcmd_privmsg got privmsg for unhandled service %s, unregistering.", bot->nick);
826 reg_privmsg_func(bot, NULL);
829 if (service->msg_hook && service->msg_hook(user, bot, text, server_qualified))
831 svccmd_invoke(user, service, NULL, text, server_qualified);
835 modcmd_chanmsg(struct userNode *user, struct chanNode *chan, char *text, struct userNode *bot) {
836 struct service *service;
837 if (!(service = dict_find(services, bot->nick, NULL))) return;
838 svccmd_invoke(user, service, chan, text, 0);
842 service_register(struct userNode *bot, char trigger) {
843 struct service *service;
844 if ((service = dict_find(services, bot->nick, NULL)))
846 service = calloc(1, sizeof(*service));
847 module_list_init(&service->modules);
848 service->commands = dict_new();
850 service->trigger = trigger;
851 dict_set_free_data(service->commands, free_service_command);
852 dict_insert(services, service->bot->nick, service);
853 reg_privmsg_func(bot, modcmd_privmsg);
855 reg_chanmsg_func(trigger, bot, modcmd_chanmsg);
860 service_find(const char *name) {
861 return dict_find(services, name, NULL);
865 svccmd_insert(struct service *service, char *name, struct svccmd *svccmd, struct modcmd *modcmd) {
867 svccmd->parent = service;
869 svccmd->command = modcmd;
870 svccmd->command->bind_count++;
871 dict_insert(service->commands, svccmd->name, svccmd);
872 for (ii=0; ii<service->modules.used; ++ii) {
873 if (service->modules.list[ii] == svccmd->command->parent) break;
875 if (ii == service->modules.used) {
876 module_list_append(&service->modules, svccmd->command->parent);
881 service_bind_modcmd(struct service *service, struct modcmd *cmd, const char *name) {
882 struct svccmd *svccmd;
883 if ((svccmd = dict_find(service->commands, name, NULL))) {
884 if (svccmd->command == cmd) return svccmd;
885 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);
888 svccmd = calloc(1, sizeof(*svccmd));
889 svccmd_insert(service, strdup(name), svccmd, cmd);
890 svccmd_copy_rules(svccmd, cmd->defaults);
895 service_bind_module(struct service *service, struct module *module) {
897 struct modcmd *modcmd;
901 for (it = dict_first(module->commands); it; it = iter_next(it)) {
902 modcmd = iter_data(it);
903 if (!((modcmd->flags | modcmd->defaults->flags) & MODCMD_NO_DEFAULT_BIND))
904 if (service_bind_modcmd(service, modcmd, iter_key(it)))
910 /* This MUST return argc if the alias expansion code knows how to deal
911 * with every argument in argv; otherwise, it MUST return the index of
912 * an argument that the expansion code does not know how to deal with.
915 check_alias_args(char *argv[], unsigned int argc) {
918 for (arg=0; arg<argc; ++arg) {
919 if (argv[arg][0] != '$') {
921 } else if (argv[arg][1] == '$') {
923 } else if (isdigit(argv[arg][1])) {
926 strtoul(argv[arg]+1, &end_num, 10);
927 switch (end_num[0]) {
933 else if (isdigit(end_num[1]))
935 /* else fall through to default case */
946 collapse_cmdname(char *argv[], unsigned int argc, char *dest) {
947 unsigned int ii, pos, arg;
952 for (ii=pos=0, arg=0; argv[arg][ii]; ) {
953 if (argv[arg][ii] == '\\') {
954 if (argv[arg][ii+1]) {
955 /* escaping a real character just puts it in literally */
956 dest[pos++] = argv[arg][++ii];
957 } else if ((arg+1) == argc) {
958 /* we ran to the end of the argument list; abort */
961 /* escape at end of a word is a space */
967 /* normal characters don't need escapes */
968 dest[pos++] = argv[arg][ii++];
975 static MODCMD_FUNC(cmd_bind) {
976 struct service *service;
977 struct svccmd *template, *newcmd;
979 char newname[MAXLEN], cmdname[MAXLEN];
980 unsigned int arg, diff;
984 arg = collapse_cmdname(argv+2, argc-2, newname) + 2;
986 reply("MSG_MISSING_PARAMS", cmd->name);
989 diff = collapse_cmdname(argv+arg, argc-arg, cmdname);
991 reply("MSG_MISSING_PARAMS", cmd->name);
996 if (!(service = service_find(svcname))) {
997 reply("MCMSG_UNKNOWN_SERVICE", svcname);
1001 if ((newcmd = dict_find(service->commands, newname, NULL))) {
1002 reply("MCMSG_ALREADY_BOUND", service->bot->nick, newname);
1006 if ((dot = strchr(cmdname, '.')) && (dot[1] == '*') && (dot[2] == 0)) {
1008 struct module *module;
1010 module = module_find((cmdname[0] == '*') ? cmdname+1 : cmdname);
1012 reply("MSG_MODULE_UNKNOWN", cmdname);
1015 count = service_bind_module(service, module);
1016 reply("MCMSG_MODULE_BOUND", count, module->name, service->bot->nick);
1019 newcmd = calloc(1, sizeof(*newcmd));
1020 newcmd->name = strdup(newname);
1021 newcmd->parent = service;
1022 if (!(template = svccmd_resolve_name(newcmd, cmdname))) {
1023 reply("MCMSG_UNKNOWN_COMMAND_2", cmdname, service->bot->nick);
1028 if (template->alias.used) {
1029 reply("MCMSG_CANNOT_DOUBLE_ALIAS");
1036 /* a more complicated alias; fix it up */
1040 nn = check_alias_args(argv+arg, argc-arg);
1041 if (nn+arg < argc) {
1042 reply("MCMSG_BAD_ALIAS_ARGUMENT", argv[nn+arg]);
1047 newcmd->alias.used = newcmd->alias.size = argc-arg;
1048 newcmd->alias.list = calloc(newcmd->alias.size, sizeof(newcmd->alias.list[0]));
1049 for (nn=0; nn<newcmd->alias.used; ++nn)
1050 newcmd->alias.list[nn] = strdup(argv[nn+arg]);
1053 svccmd_insert(service, newcmd->name, newcmd, template->command);
1054 svccmd_copy_rules(newcmd, template);
1055 reply("MCMSG_COMMAND_BOUND", newcmd->name, newcmd->parent->bot->nick);
1060 service_recheck_bindings(struct service *service, struct module *module) {
1064 for (it = dict_first(service->commands); it; it = iter_next(it)) {
1065 cmd = iter_data(it);
1066 if (cmd->command->parent == module) return 0;
1068 /* No more bindings, remove it from our list. */
1069 module_list_remove(&service->modules, module);
1073 static svccmd_unbind_func_t *suf_list;
1074 unsigned int suf_size, suf_used;
1077 reg_svccmd_unbind_func(svccmd_unbind_func_t handler) {
1078 if (suf_used == suf_size) {
1081 suf_list = realloc(suf_list, suf_size*sizeof(svccmd_unbind_func_t));
1084 suf_list = malloc(suf_size*sizeof(svccmd_unbind_func_t));
1087 suf_list[suf_used++] = handler;
1090 static MODCMD_FUNC(cmd_unbind) {
1091 struct service *service;
1092 struct userNode *bot;
1093 struct svccmd *bound;
1094 struct module *module;
1095 const char *svcname;
1096 unsigned int arg, ii;
1097 char cmdname[MAXLEN];
1101 arg = collapse_cmdname(argv+2, argc-2, cmdname) + 2;
1103 reply("MSG_MISSING_PARAMS", cmd->name);
1106 if (!(service = service_find(svcname))) {
1107 reply("MCMSG_UNKNOWN_SERVICE", svcname);
1110 if (!(bound = dict_find(service->commands, cmdname, NULL))) {
1111 reply("MCMSG_NO_COMMAND_BOUND", service->bot->nick, cmdname);
1114 if ((bound->command->flags & MODCMD_KEEP_BOUND) && (bound->command->bind_count == 1)) {
1115 reply("MCMSG_UNBIND_PROHIBITED", bound->command->name);
1119 for (ii=0; ii<suf_used; ii++)
1120 suf_list[ii](bound);
1121 /* If this command binding is removing itself, we must take care
1122 * not to dereference it after the dict_remove.
1124 bot = cmd->parent->bot;
1125 module = cmd->command->parent;
1126 dict_remove(service->commands, bound->name);
1127 send_message(user, bot, "MCMSG_COMMAND_UNBOUND", cmdname, service->bot->nick);
1128 if (service_recheck_bindings(service, module))
1129 send_message(user, bot, "MCMSG_HELPFILE_UNBOUND", module->name, module->name);
1133 static MODCMD_FUNC(cmd_readhelp) {
1134 const char *modname;
1135 struct module *module;
1136 struct helpfile *old_helpfile;
1137 struct timeval start, stop;
1141 if (!(module = module_find(modname))) {
1142 reply("MSG_MODULE_UNKNOWN", modname);
1145 if (!module->helpfile_name) {
1146 reply("MCMSG_NO_HELPFILE", module->name);
1149 old_helpfile = module->helpfile;
1150 gettimeofday(&start, NULL);
1151 module->helpfile = open_helpfile(module->helpfile_name, module->expand_help);
1152 if (!module->helpfile) {
1153 module->helpfile = old_helpfile;
1154 reply("MCMSG_HELPFILE_ERROR", module->helpfile_name);
1157 if (old_helpfile) close_helpfile(old_helpfile);
1158 gettimeofday(&stop, NULL);
1159 stop.tv_sec -= start.tv_sec;
1160 stop.tv_usec -= start.tv_usec;
1161 if (stop.tv_usec < 0) {
1163 stop.tv_usec += 1000000;
1165 reply("MCMSG_HELPFILE_READ", module->name, stop.tv_sec, stop.tv_usec/1000);
1169 static MODCMD_FUNC(cmd_help) {
1172 topic = (argc < 2) ? NULL : unsplit_string(argv+1, argc-1, NULL);
1173 return svccmd_send_help_2(user, cmd->parent, topic);
1176 static MODCMD_FUNC(cmd_timecmd) {
1177 struct timeval start, stop;
1178 char cmd_text[MAXLEN];
1180 unsplit_string(argv+1, argc-1, cmd_text);
1181 gettimeofday(&start, NULL);
1182 svccmd_invoke(user, cmd->parent, channel, cmd_text, 0);
1183 gettimeofday(&stop, NULL);
1184 stop.tv_sec -= start.tv_sec;
1185 stop.tv_usec -= start.tv_usec;
1186 if (stop.tv_usec < 0) {
1188 stop.tv_usec += 1000000;
1190 reply("MCMSG_COMMAND_TIME", cmd_text, stop.tv_sec, stop.tv_usec);
1194 static MODCMD_FUNC(cmd_command) {
1195 struct svccmd *svccmd;
1196 const char *cmd_name, *fmt_str;
1197 unsigned int flags, shown_flags, nn, pos;
1201 cmd_name = unsplit_string(argv+1, argc-1, NULL);
1202 if (!(svccmd = svccmd_resolve_name(cmd, cmd_name))) {
1203 reply("MCMSG_UNKNOWN_COMMAND_2", cmd_name, cmd->parent->bot->nick);
1206 pos = snprintf(buf, sizeof(buf), "%s.%s", svccmd->command->parent->name, svccmd->command->name);
1207 if (svccmd->alias.used) {
1209 unsplit_string((char**)svccmd->alias.list+1, svccmd->alias.used-1, buf+pos);
1210 reply("MCMSG_COMMAND_ALIASES", svccmd->name, buf);
1212 reply("MCMSG_COMMAND_BINDING", svccmd->name, buf);
1214 flags = svccmd->effective_flags;
1215 if ((svccmd->parent && svccmd->parent->privileged && !IsOper(user))
1216 || ((flags & MODCMD_REQUIRE_STAFF)
1217 && !IsOper(user) && !IsNetworkHelper(user) && !IsSupportHelper(user))) {
1218 reply("MCMSG_INSPECTION_REFUSED", svccmd->name);
1221 if (flags & MODCMD_DISABLED) {
1222 reply("MSG_COMMAND_DISABLED", svccmd->name);
1226 if (svccmd->min_opserv_level > 0) {
1227 reply("MCMSG_NEED_OPSERV_LEVEL", svccmd->min_opserv_level);
1228 shown_flags |= MODCMD_REQUIRE_OPER | MODCMD_REQUIRE_AUTHED;
1230 if (svccmd->min_channel_access > 0) {
1231 reply("MCMSG_NEED_CHANSERV_LEVEL", svccmd->min_channel_access);
1232 shown_flags |= MODCMD_REQUIRE_CHANUSER | MODCMD_REQUIRE_REGCHAN | MODCMD_REQUIRE_CHANNEL | MODCMD_REQUIRE_AUTHED;
1234 if (svccmd->req_account_flags) {
1235 for (nn=pos=0; nn<32; nn++) {
1236 if (!(svccmd->req_account_flags & (1 << nn))) continue;
1237 buf[pos++] = HANDLE_FLAGS[nn];
1240 reply("MCMSG_NEED_ACCOUNT_FLAGS", buf);
1241 shown_flags |= MODCMD_REQUIRE_AUTHED;
1243 if (!flags && !shown_flags) {
1244 reply("MCMSG_NEED_NOTHING", svccmd->name);
1247 if (flags & ~shown_flags & MODCMD_REQUIRE_HELPING) {
1248 reply("MCMSG_MUST_BE_HELPING");
1249 shown_flags |= MODCMD_REQUIRE_AUTHED | MODCMD_REQUIRE_STAFF;
1251 if (flags & ~shown_flags & MODCMD_REQUIRE_STAFF) {
1252 switch (flags & MODCMD_REQUIRE_STAFF) {
1253 default: case MODCMD_REQUIRE_STAFF:
1254 fmt_str = "MCMSG_NEED_STAFF_ACCESS";
1256 case MODCMD_REQUIRE_OPER:
1257 fmt_str = "MCMSG_NEED_STAFF_OPER";
1259 case MODCMD_REQUIRE_NETWORK_HELPER:
1260 fmt_str = "MCMSG_NEED_STAFF_NETHELPER";
1262 case MODCMD_REQUIRE_OPER|MODCMD_REQUIRE_NETWORK_HELPER:
1263 fmt_str = "MCMSG_NEED_STAFF_NETHELPER_OR_OPER";
1265 case MODCMD_REQUIRE_SUPPORT_HELPER:
1266 fmt_str = "MCMSG_NEED_STAFF_SHELPER";
1268 case MODCMD_REQUIRE_OPER|MODCMD_REQUIRE_SUPPORT_HELPER:
1269 fmt_str = "MCMSG_NEED_STAFF_SHELPER_OR_OPER";
1271 case MODCMD_REQUIRE_SUPPORT_HELPER|MODCMD_REQUIRE_NETWORK_HELPER:
1272 fmt_str = "MCMSG_NEED_STAFF_HELPER";
1276 shown_flags |= MODCMD_REQUIRE_AUTHED | MODCMD_REQUIRE_STAFF;
1278 if (flags & ~shown_flags & MODCMD_REQUIRE_JOINABLE) {
1279 reply("MCMSG_NEED_JOINABLE");
1280 shown_flags |= MODCMD_REQUIRE_CHANUSER;
1282 if (flags & ~shown_flags & MODCMD_REQUIRE_CHANUSER) {
1283 if (flags & ~shown_flags & MODCMD_IGNORE_CSUSPEND)
1284 reply("MCMSG_NEED_CHANUSER_CSUSPENDABLE");
1286 reply("MCMSG_NEED_CHANUSER");
1287 shown_flags |= MODCMD_IGNORE_CSUSPEND | MODCMD_REQUIRE_REGCHAN | MODCMD_REQUIRE_CHANNEL | MODCMD_REQUIRE_AUTHED;
1289 if (flags & ~shown_flags & MODCMD_REQUIRE_REGCHAN) {
1290 reply("MCMSG_NEED_REGCHAN");
1291 shown_flags |= MODCMD_REQUIRE_CHANNEL;
1293 if (flags & ~shown_flags & MODCMD_REQUIRE_CHANNEL)
1294 reply("MCMSG_NEED_CHANNEL");
1295 if (flags & ~shown_flags & MODCMD_REQUIRE_AUTHED)
1296 reply("MCMSG_NEED_AUTHED");
1297 if (flags & ~shown_flags & MODCMD_TOY)
1298 reply("MCMSG_IS_TOY", svccmd->name);
1299 if (flags & ~shown_flags & MODCMD_REQUIRE_QUALIFIED) {
1300 const char *botnick = svccmd->parent ? svccmd->parent->bot->nick : "SomeBot";
1301 reply("MCMSG_MUST_QUALIFY", botnick, svccmd->name, botnick);
1303 reply("MCMSG_END_REQUIREMENTS", svccmd->name);
1308 modcmd_describe_command(struct userNode *user, struct svccmd *cmd, struct svccmd *target) {
1309 char buf1[MAXLEN], buf2[MAXLEN];
1310 unsigned int ii, len, buf1_used, buf2_used;
1312 if (target->alias.used) {
1313 unsplit_string((char**)target->alias.list, target->alias.used, buf1);
1314 reply("MCMSG_COMMAND_ALIASES", target->name, buf1);
1316 snprintf(buf1, sizeof(buf1), "%s.%s", target->command->parent->name, target->command->name);
1317 reply("MCMSG_COMMAND_BINDING", target->name, buf1);
1319 for (ii = buf1_used = buf2_used = 0; flags[ii].name; ++ii) {
1320 if (target->flags & flags[ii].flag) {
1322 buf1[buf1_used++] = ',';
1323 len = strlen(flags[ii].name);
1324 memcpy(buf1 + buf1_used, flags[ii].name, len);
1326 } else if (target->effective_flags & flags[ii].flag) {
1328 buf2[buf2_used++] = ',';
1329 len = strlen(flags[ii].name);
1330 memcpy(buf2 + buf2_used, flags[ii].name, len);
1335 buf1[buf1_used] = '\0';
1337 strcpy(buf1, user_find_message(user, "MSG_NONE"));
1339 buf2[buf2_used] = '\0';
1341 strcpy(buf2, user_find_message(user, "MSG_NONE"));
1342 reply("MCMSG_COMMAND_FLAGS", buf1, buf2);
1343 for (ii = buf1_used = buf2_used = 0; handle_flags[ii]; ++ii) {
1344 if (target->req_account_flags & (1 << ii))
1345 buf1[buf1_used++] = handle_flags[ii];
1346 else if (target->deny_account_flags & (1 << ii))
1347 buf2[buf2_used++] = handle_flags[ii];
1349 buf1[buf1_used] = buf2[buf2_used] = '\0';
1350 reply("MCMSG_COMMAND_ACCOUNT_FLAGS", buf1, buf2);
1351 reply("MCMSG_COMMAND_ACCESS_LEVEL", target->min_channel_access, target->min_opserv_level);
1352 reply("MCMSG_COMMAND_USES", target->name, target->uses);
1355 static MODCMD_FUNC(cmd_modcmd) {
1356 struct svccmd *svccmd;
1357 unsigned int arg, changed;
1358 char cmdname[MAXLEN];
1361 arg = collapse_cmdname(argv+1, argc-1, cmdname) + 1;
1363 reply("MSG_MISSING_PARAMS", cmd->name);
1366 if (!(svccmd = svccmd_resolve_name(cmd, cmdname))) {
1367 reply("MCMSG_UNKNOWN_COMMAND_2", cmdname, cmd->parent->bot->nick);
1370 for (changed = 0; arg+1 < argc; arg += 2) {
1371 if (svccmd_configure(svccmd, user, cmd->parent->bot, argv[arg], argv[arg+1])) {
1372 reply("MCMSG_COMMAND_MODIFIED", argv[arg], svccmd->name);
1377 modcmd_set_effective_flags(svccmd);
1378 modcmd_describe_command(user, cmd, svccmd);
1382 static MODCMD_FUNC(cmd_god) {
1386 if (enabled_string(argv[1])) {
1387 if (HANDLE_FLAGGED(user->handle_info, HELPING)) {
1388 reply("MCMSG_ALREADY_HELPING");
1392 } else if (disabled_string(argv[1])) {
1393 if (!HANDLE_FLAGGED(user->handle_info, HELPING)) {
1394 reply("MCMSG_ALREADY_NOT_HELPING");
1399 reply("MSG_INVALID_BINARY", argv[1]);
1403 helping = !IsHelping(user);
1407 HANDLE_SET_FLAG(user->handle_info, HELPING);
1408 reply("MCMSG_NOW_HELPING");
1410 HANDLE_CLEAR_FLAG(user->handle_info, HELPING);
1411 reply("MCMSG_NOW_NOT_HELPING");
1417 static MODCMD_FUNC(cmd_joiner) {
1421 int len = sprintf(cmdname, "%s ", cmd->name);
1423 struct string_buffer sbuf;
1425 string_buffer_init(&sbuf);
1426 for (it = dict_first(cmd->parent->commands); it; it = iter_next(it)) {
1427 if (!ircncasecmp(iter_key(it), cmdname, len)) {
1428 if (sbuf.used) string_buffer_append_string(&sbuf, ", ");
1429 string_buffer_append_string(&sbuf, iter_key(it));
1432 if (!sbuf.used) string_buffer_append(&sbuf, 0);
1433 reply("MCMSG_JOINER_CHOICES", cmd->name, sbuf.list);
1434 string_buffer_clean(&sbuf);
1437 sprintf(cmdname, "%s %s", cmd->name, argv[1]);
1439 svccmd_invoke_argv(user, cmd->parent, channel, argc-1, argv+1, 0);
1440 return 0; /* never try to log this; the recursive one logs it */
1443 static MODCMD_FUNC(cmd_stats_modules) {
1444 struct helpfile_table tbl;
1448 struct modcmd *modcmd;
1451 tbl.length = dict_size(modules) + 1;
1453 tbl.flags = TABLE_PAD_LEFT;
1454 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1455 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1456 tbl.contents[0][0] = "Module";
1457 tbl.contents[0][1] = "Commands";
1458 tbl.contents[0][2] = "Helpfile";
1459 for (ii=1, it=dict_first(modules); it; it=iter_next(it), ii++) {
1460 mod = iter_data(it);
1461 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1462 tbl.contents[ii][0] = mod->name;
1463 tbl.contents[ii][1] = strtab(dict_size(mod->commands));
1464 tbl.contents[ii][2] = mod->helpfile_name ? mod->helpfile_name : "(none)";
1466 } else if (!(mod = dict_find(modules, argv[1], NULL))) {
1467 reply("MCMSG_UNKNOWN_MODULE", argv[1]);
1470 reply("MCMSG_MODULE_INFO", mod->name);
1471 tbl.length = dict_size(mod->commands) + 1;
1473 tbl.flags = TABLE_PAD_LEFT;
1474 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1475 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1476 tbl.contents[0][0] = "Command";
1477 tbl.contents[0][1] = "Min. Args";
1478 tbl.contents[0][2] = "Bind Count";
1479 for (ii=1, it=dict_first(mod->commands); it; it=iter_next(it), ii++) {
1480 modcmd = iter_data(it);
1481 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1482 tbl.contents[ii][0] = modcmd->name;
1483 tbl.contents[ii][1] = strtab(modcmd->min_argc);
1484 tbl.contents[ii][2] = strtab(modcmd->bind_count);
1487 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1491 static MODCMD_FUNC(cmd_stats_services) {
1492 struct helpfile_table tbl;
1495 struct service *service;
1496 struct svccmd *svccmd;
1500 tbl.length = dict_size(services) + 1;
1502 tbl.flags = TABLE_PAD_LEFT;
1503 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1504 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1505 tbl.contents[0][0] = "Service";
1506 tbl.contents[0][1] = "Commands";
1507 tbl.contents[0][2] = "Priv'd?";
1508 tbl.contents[0][3] = "Trigger";
1509 extra = calloc(2, tbl.length);
1510 for (ii=1, it=dict_first(services); it; it=iter_next(it), ii++) {
1511 service = iter_data(it);
1512 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1513 tbl.contents[ii][0] = service->bot->nick;
1514 tbl.contents[ii][1] = strtab(dict_size(service->commands));
1515 tbl.contents[ii][2] = service->privileged ? "yes" : "no";
1516 extra[ii*2] = service->trigger;
1517 tbl.contents[ii][3] = extra+ii*2;
1519 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1522 } else if (!(service = dict_find(services, argv[1], NULL))) {
1523 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1526 tbl.length = dict_size(service->commands) + 1;
1528 tbl.flags = TABLE_PAD_LEFT | TABLE_NO_FREE;
1529 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1530 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1531 tbl.contents[0][0] = "Command";
1532 tbl.contents[0][1] = "Module";
1533 tbl.contents[0][2] = "ModCmd";
1534 tbl.contents[0][3] = "Alias?";
1535 tbl.contents[0][4] = strdup("Uses");
1536 for (ii=1, it=dict_first(service->commands); it; it=iter_next(it), ii++) {
1537 svccmd = iter_data(it);
1538 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1539 tbl.contents[ii][0] = svccmd->name;
1540 tbl.contents[ii][1] = svccmd->command->parent->name;
1541 tbl.contents[ii][2] = svccmd->command->name;
1542 tbl.contents[ii][3] = svccmd->alias.used ? "yes" : "no";
1543 tbl.contents[ii][4] = extra = malloc(12);
1544 sprintf(extra, "%u", svccmd->uses);
1546 reply("MCMSG_SERVICE_INFO", service->bot->nick);
1547 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1548 for (ii=0; ii<tbl.length; ii++) {
1549 free((char*)tbl.contents[ii][4]);
1550 free(tbl.contents[ii]);
1557 static MODCMD_FUNC(cmd_showcommands) {
1558 struct svccmd_list commands;
1559 struct helpfile_table tbl;
1560 struct svccmd *svccmd;
1562 unsigned int ii, ignore_flags = 0;
1563 unsigned int max_opserv_level = 1000;
1564 unsigned short max_chanserv_level = 500;
1565 char show_opserv_level = 0, show_channel_access = 0;
1567 /* Check to see what the max access they want to see is. */
1568 for (ii=1; ii<argc; ++ii) {
1569 if (isdigit(argv[ii][0]))
1570 max_opserv_level = atoi(argv[ii]);
1572 max_chanserv_level = user_level_from_name(argv[ii], UL_OWNER);
1575 /* Find the matching commands. */
1576 svccmd_list_init(&commands);
1577 if (cmd->parent->privileged)
1578 ignore_flags = MODCMD_REQUIRE_OPER;
1579 for (it = dict_first(cmd->parent->commands); it; it = iter_next(it)) {
1580 svccmd = iter_data(it);
1581 if (strchr(svccmd->name, ' '))
1583 if (!svccmd_can_invoke(user, svccmd->parent->bot, svccmd, channel, SVCCMD_QUALIFIED))
1585 if (svccmd->min_opserv_level > max_opserv_level)
1587 if (svccmd->min_channel_access > max_chanserv_level)
1589 if (svccmd->min_opserv_level > 0)
1590 show_opserv_level = 1;
1591 if (svccmd->min_channel_access > 0)
1592 show_channel_access = 1;
1593 if (svccmd->effective_flags
1594 & (MODCMD_REQUIRE_STAFF|MODCMD_REQUIRE_HELPING)
1596 show_channel_access = 1;
1598 svccmd_list_append(&commands, svccmd);
1601 /* Build the table. */
1602 tbl.length = commands.used + 1;
1603 tbl.width = 1 + show_opserv_level + show_channel_access;
1604 tbl.flags = TABLE_REPEAT_ROWS;
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][ii = 0] = "Command";
1608 if (show_opserv_level)
1609 tbl.contents[0][++ii] = "OpServ Level";
1610 if (show_channel_access)
1611 tbl.contents[0][++ii] = "ChanServ Access";
1612 for (ii=0; ii<commands.used; ++ii) {
1613 svccmd = commands.list[ii];
1614 tbl.contents[ii+1] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1615 tbl.contents[ii+1][0] = svccmd->name;
1616 if (show_opserv_level)
1617 tbl.contents[ii+1][1] = strtab(svccmd->min_opserv_level);
1618 if (show_channel_access) {
1620 int flags = svccmd->effective_flags;
1621 if (flags & MODCMD_REQUIRE_HELPING)
1623 else if (flags & MODCMD_REQUIRE_STAFF) {
1624 switch (flags & MODCMD_REQUIRE_STAFF) {
1625 case MODCMD_REQUIRE_OPER: access = "oper"; break;
1626 case MODCMD_REQUIRE_OPER | MODCMD_REQUIRE_NETWORK_HELPER:
1627 case MODCMD_REQUIRE_NETWORK_HELPER: access = "net.helper"; break;
1628 default: access = "staff"; break;
1631 access = strtab(svccmd->min_channel_access);
1632 tbl.contents[ii+1][1+show_opserv_level] = access;
1635 svccmd_list_clean(&commands);
1636 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1640 static MODCMD_FUNC(cmd_helpfiles) {
1641 struct service *service;
1644 if (!(service = dict_find(services, argv[1], NULL))) {
1645 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1650 for (ii=0; ii<service->modules.used; ++ii)
1651 reply("MCMSG_HELPFILE_SEQUENCE", ii+1, service->modules.list[ii]->name);
1655 service->modules.used = 0;
1656 for (ii=0; ii<argc-2; ii++) {
1657 struct module *module = dict_find(modules, argv[ii+2], NULL);
1659 reply("MCMSG_UNKNOWN_MODULE", argv[ii+2]);
1662 module_list_append(&service->modules, module);
1664 reply("MCMSG_HELPFILE_SEQUENCE_SET", service->bot->nick);
1668 static MODCMD_FUNC(cmd_service_add) {
1669 const char *nick, *desc;
1670 struct userNode *bot;
1673 if (!is_valid_nick(nick)) {
1674 reply("MCMSG_BAD_SERVICE_NICK", nick);
1677 desc = unsplit_string(argv+2, argc-2, NULL);
1678 bot = GetUserH(nick);
1679 if (bot && IsService(bot)) {
1680 reply("MCMSG_ALREADY_SERVICE", bot->nick);
1683 bot = AddService(nick, desc);
1684 service_register(bot, '\0');
1685 reply("MCMSG_NEW_SERVICE", bot->nick);
1689 static MODCMD_FUNC(cmd_service_rename) {
1690 struct service *service;
1692 if (!(service = service_find(argv[1]))) {
1693 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1696 NickChange(service->bot, argv[2], 0);
1697 reply("MCMSG_SERVICE_RENAMED", service->bot->nick);
1701 static MODCMD_FUNC(cmd_service_trigger) {
1702 struct userNode *bogon;
1703 struct service *service;
1705 if (!(service = service_find(argv[1]))) {
1706 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1710 if (service->trigger)
1711 reply("MCMSG_CURRENT_TRIGGER", service->bot->nick, service->trigger);
1713 reply("MCMSG_NO_TRIGGER", service->bot->nick);
1716 if (service->trigger)
1717 reg_chanmsg_func(service->trigger, NULL, NULL);
1718 if (!irccasecmp(argv[2], "none") || !irccasecmp(argv[2], "remove")) {
1719 service->trigger = 0;
1720 reply("MCMSG_REMOVED_TRIGGER", service->bot->nick);
1721 } else if ((bogon = get_chanmsg_bot(argv[2][0]))) {
1722 reply("MCMSG_DUPLICATE_TRIGGER", bogon->nick, argv[2][0]);
1725 service->trigger = argv[2][0];
1726 reg_chanmsg_func(service->trigger, service->bot, modcmd_chanmsg);
1727 reply("MCMSG_NEW_TRIGGER", service->bot->nick, service->trigger);
1732 static MODCMD_FUNC(cmd_service_privileged) {
1733 struct service *service;
1736 if (!(service = service_find(argv[1]))) {
1737 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1741 service->privileged = true_string(argv[2]) || enabled_string(argv[2]);
1742 newval = user_find_message(user, service->privileged ? "MSG_ON" : "MSG_OFF");
1743 reply("MCMSG_SERVICE_PRIVILEGED", service->bot->nick, newval);
1747 static MODCMD_FUNC(cmd_service_remove) {
1748 char *name, *reason;
1749 struct service *service;
1753 reason = unsplit_string(argv+2, argc-2, NULL);
1755 reason = "Removing bot";
1756 if (!(service = service_find(name))) {
1757 reply("MCMSG_UNKNOWN_SERVICE", name);
1760 DelUser(service->bot, NULL, 1, reason);
1761 reply("MCMSG_SERVICE_REMOVED", name);
1762 dict_remove(services, name);
1766 static MODCMD_FUNC(cmd_dump_messages) {
1767 const char *fname = "strings.db";
1768 struct saxdb_context *ctx;
1772 if (!(pf = fopen(fname, "w"))) {
1773 reply("MCMSG_FILE_NOT_OPENED", fname);
1776 if (!(ctx = saxdb_open_context(pf))) {
1777 reply("MSG_INTERNAL_FAILURE");
1780 for (it = dict_first(lang_C->messages); it; it = iter_next(it))
1781 saxdb_write_string(ctx, iter_key(it), iter_data(it));
1782 saxdb_close_context(ctx);
1784 reply("MCMSG_MESSAGES_DUMPED", fname);
1788 static MODCMD_FUNC(cmd_version) {
1789 /* This function provides copyright management information to end
1790 * users of srvx. You should not alter, disable or remove this
1791 * command or its accessibility to normal IRC users.
1793 reply("MCMSG_VERSION");
1794 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.");
1795 if ((argc > 1) && !irccasecmp(argv[1], "arch"))
1796 send_message_type(4, user, cmd->parent->bot, "%s", ARCH_VERSION);
1802 modcmd_nick_change(struct userNode *user, const char *old_nick) {
1803 struct service *svc;
1804 if (!(svc = dict_find(services, old_nick, NULL)))
1806 dict_remove2(services, old_nick, 1);
1807 dict_insert(services, user->nick, svc);
1811 modcmd_cleanup(void) {
1812 dict_delete(services);
1813 dict_delete(modules);
1819 modcmd_saxdb_write_command(struct saxdb_context *ctx, struct svccmd *cmd) {
1821 unsigned int nn, len, pos;
1822 struct svccmd *template = cmd->command->defaults;
1824 saxdb_start_record(ctx, cmd->name, 0);
1825 sprintf(buf, "%s.%s", cmd->command->parent->name, cmd->command->name);
1826 saxdb_write_string(ctx, "command", buf);
1827 if (cmd->alias.used)
1828 saxdb_write_string_list(ctx, "aliased", &cmd->alias);
1829 if (cmd->min_opserv_level != template->min_opserv_level)
1830 saxdb_write_int(ctx, "oper_access", cmd->min_opserv_level);
1831 if (cmd->min_channel_access != template->min_channel_access)
1832 saxdb_write_int(ctx, "channel_access", cmd->min_channel_access);
1833 if (cmd->flags != template->flags) {
1835 for (nn=pos=0; flags[nn].name; ++nn) {
1836 if (cmd->flags & flags[nn].flag) {
1838 len = strlen(flags[nn].name);
1839 memcpy(buf+pos, flags[nn].name, len);
1848 saxdb_write_string(ctx, "flags", buf);
1850 if ((cmd->req_account_flags != template->req_account_flags)
1851 || (cmd->deny_account_flags != template->req_account_flags)) {
1853 if (cmd->req_account_flags) {
1855 for (nn=0; nn<32; nn++)
1856 if (cmd->req_account_flags & (1 << nn))
1857 buf[pos++] = handle_flags[nn];
1859 if (cmd->deny_account_flags) {
1861 for (nn=0; nn<32; nn++)
1862 if (cmd->deny_account_flags & (1 << nn))
1863 buf[pos++] = handle_flags[nn];
1866 saxdb_write_string(ctx, "account_flags", buf);
1868 saxdb_end_record(ctx);
1872 modcmd_saxdb_write(struct saxdb_context *ctx) {
1873 struct string_list slist;
1874 dict_iterator_t it, it2;
1875 struct service *service;
1878 saxdb_start_record(ctx, "bots", 1);
1879 for (it = dict_first(services); it; it = iter_next(it)) {
1881 service = iter_data(it);
1882 saxdb_start_record(ctx, service->bot->nick, 1);
1883 if (service->trigger) {
1884 buff[0] = service->trigger;
1886 saxdb_write_string(ctx, "trigger", buff);
1888 saxdb_write_string(ctx, "description", service->bot->info);
1889 if (service->privileged)
1890 saxdb_write_string(ctx, "privileged", "1");
1891 saxdb_end_record(ctx);
1893 saxdb_end_record(ctx);
1895 saxdb_start_record(ctx, "services", 1);
1896 for (it = dict_first(services); it; it = iter_next(it)) {
1897 service = iter_data(it);
1898 saxdb_start_record(ctx, service->bot->nick, 1);
1899 for (it2 = dict_first(service->commands); it2; it2 = iter_next(it2))
1900 modcmd_saxdb_write_command(ctx, iter_data(it2));
1901 saxdb_end_record(ctx);
1903 saxdb_end_record(ctx);
1905 saxdb_start_record(ctx, "helpfiles", 1);
1907 for (it = dict_first(services); it; it = iter_next(it)) {
1908 service = iter_data(it);
1910 for (ii = 0; ii < service->modules.used; ++ii)
1911 string_list_append(&slist, service->modules.list[ii]->name);
1912 saxdb_write_string_list(ctx, iter_key(it), &slist);
1916 saxdb_end_record(ctx);
1922 append_entry(const char *key, UNUSED_ARG(void *data), void *extra) {
1923 struct helpfile_expansion *exp = extra;
1924 int row = exp->value.table.length++;
1925 exp->value.table.contents[row] = calloc(1, sizeof(char*));
1926 exp->value.table.contents[row][0] = key;
1930 static struct helpfile_expansion
1931 modcmd_expand(const char *variable) {
1932 struct helpfile_expansion exp;
1933 extern struct userNode *message_source;
1934 struct service *service;
1936 service = dict_find(services, message_source->nick, NULL);
1937 if (!irccasecmp(variable, "index")) {
1938 exp.type = HF_TABLE;
1939 exp.value.table.length = 1;
1940 exp.value.table.width = 1;
1941 exp.value.table.flags = TABLE_REPEAT_ROWS;
1942 exp.value.table.contents = calloc(dict_size(service->commands)+1, sizeof(char**));
1943 exp.value.table.contents[0] = calloc(1, sizeof(char*));
1944 exp.value.table.contents[0][0] = "Commands:";
1945 dict_foreach(service->commands, append_entry, &exp);
1947 } else if (!irccasecmp(variable, "languages")) {
1948 struct string_buffer sbuf;
1950 sbuf.used = sbuf.size = 0;
1952 for (it = dict_first(languages); it; it = iter_next(it)) {
1953 string_buffer_append_string(&sbuf, iter_key(it));
1954 string_buffer_append(&sbuf, ' ');
1956 sbuf.list[--sbuf.used] = 0;
1957 exp.type = HF_STRING;
1958 exp.value.str = sbuf.list;
1961 exp.type = HF_STRING;
1962 exp.value.str = NULL;
1967 modcmd_load_bots(struct dict *db) {
1970 for (it = dict_first(db); it; it = iter_next(it)) {
1971 struct record_data *rd;
1972 struct userNode *bot;
1973 const char *nick, *desc;
1977 if (rd->type != RECDB_OBJECT) {
1978 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'bots/%s' in modcmd db (expected object).", iter_key(it));
1981 nick = database_get_data(rd->d.object, "nick", RECDB_QSTRING);
1983 nick = iter_key(it);
1984 if (service_find(nick))
1986 desc = database_get_data(rd->d.object, "trigger", RECDB_QSTRING);
1987 trigger = desc ? desc[0] : '\0';
1988 desc = database_get_data(rd->d.object, "description", RECDB_QSTRING);
1991 struct service *svc;
1992 bot = AddService(nick, desc);
1993 svc = service_register(bot, trigger);
1994 desc = database_get_data(rd->d.object, "privileged", RECDB_QSTRING);
1995 if (desc && (true_string(desc) || enabled_string(desc)))
1996 svc->privileged = 1;
2002 modcmd_conf_read(void) {
2003 modcmd_load_bots(conf_get_data("services", RECDB_OBJECT));
2008 qsort(flags, ArrayLength(flags)-1, sizeof(flags[0]), flags_qsort);
2009 modules = dict_new();
2010 dict_set_free_data(modules, free_module);
2011 services = dict_new();
2012 dict_set_free_data(services, free_service);
2013 reg_nick_change_func(modcmd_nick_change);
2014 reg_exit_func(modcmd_cleanup);
2015 conf_register_reload(modcmd_conf_read);
2017 modcmd_module = module_register("modcmd", MAIN_LOG, "modcmd.help", modcmd_expand);
2018 bind_command = modcmd_register(modcmd_module, "bind", cmd_bind, 4, MODCMD_KEEP_BOUND, "oper_level", "800", NULL);
2019 help_command = modcmd_register(modcmd_module, "help", cmd_help, 1, 0, "flags", "+nolog", NULL);
2020 modcmd_register(modcmd_module, "command", cmd_command, 2, 0, "flags", "+nolog", NULL);
2021 modcmd_register(modcmd_module, "modcmd", cmd_modcmd, 2, MODCMD_KEEP_BOUND, "template", "bind", NULL);
2022 modcmd_register(modcmd_module, "god", cmd_god, 0, MODCMD_REQUIRE_AUTHED, "flags", "+oper,+networkhelper", NULL);
2023 modcmd_register(modcmd_module, "readhelp", cmd_readhelp, 2, 0, "oper_level", "650", NULL);
2024 modcmd_register(modcmd_module, "timecmd", cmd_timecmd, 2, 0, "oper_level", "1", NULL);
2025 modcmd_register(modcmd_module, "unbind", cmd_unbind, 3, 0, "template", "bind", NULL);
2026 modcmd_register(modcmd_module, "joiner", cmd_joiner, 1, 0, NULL);
2027 modcmd_register(modcmd_module, "stats modules", cmd_stats_modules, 1, 0, "flags", "+oper", NULL);
2028 modcmd_register(modcmd_module, "stats services", cmd_stats_services, 1, 0, "flags", "+oper", NULL);
2029 modcmd_register(modcmd_module, "showcommands", cmd_showcommands, 1, 0, "flags", "+acceptchan", NULL);
2030 modcmd_register(modcmd_module, "helpfiles", cmd_helpfiles, 2, 0, "template", "bind", NULL);
2031 modcmd_register(modcmd_module, "service add", cmd_service_add, 3, 0, "flags", "+oper", NULL);
2032 modcmd_register(modcmd_module, "service rename", cmd_service_rename, 3, 0, "flags", "+oper", NULL);
2033 modcmd_register(modcmd_module, "service trigger", cmd_service_trigger, 2, 0, "flags", "+oper", NULL);
2034 modcmd_register(modcmd_module, "service privileged", cmd_service_privileged, 2, 0, "flags", "+oper", NULL);
2035 modcmd_register(modcmd_module, "service remove", cmd_service_remove, 2, 0, "flags", "+oper", NULL);
2036 modcmd_register(modcmd_module, "dumpmessages", cmd_dump_messages, 1, 0, "oper_level", "1000", NULL);
2037 version_command = modcmd_register(modcmd_module, "version", cmd_version, 1, 0, NULL);
2038 message_register_table(msgtab);
2042 modcmd_db_load_command(struct service *service, const char *cmdname, struct dict *obj) {
2043 struct svccmd *svccmd;
2044 struct module *module;
2045 struct modcmd *modcmd;
2046 struct string_list *slist;
2047 const char *str, *sep;
2050 str = database_get_data(obj, "command", RECDB_QSTRING);
2052 log_module(MAIN_LOG, LOG_ERROR, "Missing command for service %s command %s in modcmd.db", service->bot->nick, cmdname);
2055 sep = strchr(str, '.');
2057 log_module(MAIN_LOG, LOG_ERROR, "Invalid command %s for service %s command %s in modcmd.db", str, service->bot->nick, cmdname);
2060 memcpy(buf, str, sep-str);
2062 if (!(module = module_find(buf))) {
2063 log_module(MAIN_LOG, LOG_ERROR, "Unknown module %s for service %s command %s in modcmd.db", buf, service->bot->nick, cmdname);
2066 if (!(modcmd = dict_find(module->commands, sep+1, NULL))) {
2067 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);
2070 /* Now that we know we have a command to use, fill in the basics. */
2071 svccmd = calloc(1, sizeof(*svccmd));
2072 svccmd_insert(service, strdup(cmdname), svccmd, modcmd);
2073 if ((str = database_get_data(obj, "template", RECDB_QSTRING))) {
2074 add_pending_template(svccmd, str);
2076 svccmd_copy_rules(svccmd, modcmd->defaults);
2078 if ((str = database_get_data(obj, "account_flags", RECDB_QSTRING))) {
2079 svccmd->req_account_flags = svccmd->deny_account_flags = 0;
2080 svccmd_configure(svccmd, NULL, service->bot, "account_flags", str);
2082 if ((str = database_get_data(obj, "flags", RECDB_QSTRING))) {
2084 svccmd_configure(svccmd, NULL, service->bot, "flags", str);
2086 if ((str = database_get_data(obj, "oper_access", RECDB_QSTRING))
2087 || (str = database_get_data(obj, "opserv_level", RECDB_QSTRING))) {
2088 svccmd_configure(svccmd, NULL, service->bot, "oper_access", str);
2090 if ((str = database_get_data(obj, "channel_access", RECDB_QSTRING))
2091 || (str = database_get_data(obj, "chanserv_level", RECDB_QSTRING))) {
2092 svccmd_configure(svccmd, NULL, service->bot, "channel_access", str);
2094 if ((slist = database_get_data(obj, "aliased", RECDB_STRING_LIST))) {
2096 svccmd->alias.used = svccmd->alias.size = slist->used;
2097 svccmd->alias.list = calloc(svccmd->alias.size, sizeof(svccmd->alias.list[0]));
2098 for (nn=0; nn<slist->used; ++nn)
2099 svccmd->alias.list[nn] = strdup(slist->list[nn]);
2101 modcmd_set_effective_flags(svccmd);
2104 static struct svccmd *
2105 service_make_alias(struct service *service, const char *alias, ...) {
2106 char *arg, *argv[MAXNUMPARAMS];
2107 unsigned int nn, argc;
2108 struct svccmd *svccmd, *template;
2111 va_start(args, alias);
2114 arg = va_arg(args, char*);
2120 svccmd = calloc(1, sizeof(*svccmd));
2121 if (!(template = svccmd_resolve_name(svccmd, argv[0]))) {
2122 log_module(MAIN_LOG, LOG_ERROR, "Invalid base command %s for alias %s in service %s", argv[0], alias, service->bot->nick);
2128 svccmd->alias.used = svccmd->alias.size = argc;
2129 svccmd->alias.list = calloc(svccmd->alias.size, sizeof(svccmd->alias.list[0]));
2130 for (nn=0; nn<argc; nn++)
2131 svccmd->alias.list[nn] = strdup(argv[nn]);
2133 svccmd_insert(service, strdup(alias), svccmd, template->command);
2134 svccmd_copy_rules(svccmd, template);
2138 static int saxdb_present;
2141 modcmd_saxdb_read(struct dict *db) {
2143 dict_iterator_t it, it2;
2144 struct record_data *rd, *rd2;
2145 struct service *service;
2147 modcmd_load_bots(database_get_data(db, "bots", RECDB_OBJECT));
2148 db2 = database_get_data(db, "services", RECDB_OBJECT);
2150 log_module(MAIN_LOG, LOG_ERROR, "Missing section 'services' in modcmd db.");
2153 for (it = dict_first(db2); it; it = iter_next(it)) {
2155 if (rd->type != RECDB_OBJECT) {
2156 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'services/%s' in modcmd db (expected object).", iter_key(it));
2159 if (!(service = service_find(iter_key(it)))) {
2160 log_module(MAIN_LOG, LOG_ERROR, "Unknown service '%s' listed in modcmd db.", iter_key(it));
2163 for (it2 = dict_first(rd->d.object); it2; it2 = iter_next(it2)) {
2164 rd2 = iter_data(it2);
2165 if (rd2->type != RECDB_OBJECT) {
2166 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'services/%s/%s' in modcmd db (expected object).", iter_key(it), iter_key(it2));
2169 modcmd_db_load_command(service, iter_key(it2), rd2->d.object);
2172 db2 = database_get_data(db, "helpfiles", RECDB_OBJECT);
2173 for (it = dict_first(db2); it; it = iter_next(it)) {
2174 struct module *module;
2175 struct string_list *slist;
2179 if (rd->type != RECDB_STRING_LIST) {
2180 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'helpfiles/%s' in modcmd db (expected string list).", iter_key(it));
2183 slist = rd->d.slist;
2184 if (!(service = service_find(iter_key(it)))) {
2185 /* We probably whined about the service being missing above. */
2188 service->modules.used = 0;
2189 for (ii=0; ii<slist->used; ++ii) {
2190 if (!(module = dict_find(modules, slist->list[ii], NULL))) {
2191 log_module(MAIN_LOG, LOG_ERROR, "Unknown module '%s' listed in modcmd 'helpfiles/%s'.", slist->list[ii], iter_key(it));
2194 module_list_append(&service->modules, module);
2202 create_default_binds(void) {
2203 /* Which services should import which modules by default? */
2205 const char *svcname;
2206 /* C is lame and requires a fixed size for this array.
2207 * Be sure you NULL-terminate each array and increment the
2208 * size here if you add more default modules to any
2210 const char *modnames[8];
2212 { "ChanServ", { "ChanServ", NULL } },
2213 { "Global", { "Global", NULL } },
2214 { "NickServ", { "NickServ", NULL } },
2215 { "OpServ", { "OpServ", "modcmd", "sendmail", "saxdb", "proxycheck", NULL } },
2218 unsigned int ii, jj;
2219 char buf[128], *nick;
2220 struct service *service;
2221 struct module *module;
2223 for (ii = 0; def_binds[ii].svcname; ++ii) {
2224 sprintf(buf, "services/%s/nick", def_binds[ii].svcname);
2225 if (!(nick = conf_get_data(buf, RECDB_QSTRING)))
2227 if (!(service = service_find(nick)))
2229 if (dict_size(service->commands) > 0)
2232 /* Bind the default modules for this service to it */
2233 for (jj = 0; def_binds[ii].modnames[jj]; ++jj) {
2234 if (!(module = module_find(def_binds[ii].modnames[jj])))
2236 service_bind_module(service, module);
2239 /* Bind the help and version commands to this service */
2240 service_bind_modcmd(service, help_command, help_command->name);
2241 service_bind_modcmd(service, version_command, version_command->name);
2243 /* Now some silly hax.. (aliases that most people want) */
2244 if (!irccasecmp(def_binds[ii].svcname, "ChanServ")) {
2245 service_make_alias(service, "addowner", "*chanserv.adduser", "$1", "owner", NULL);
2246 service_make_alias(service, "addcoowner", "*chanserv.adduser", "$1", "coowner", NULL);
2247 service_make_alias(service, "addmaster", "*chanserv.adduser", "$1", "master", NULL);
2248 service_make_alias(service, "addop", "*chanserv.adduser", "$1", "op", NULL);
2249 service_make_alias(service, "addpeon", "*chanserv.adduser", "$1", "peon", NULL);
2250 service_make_alias(service, "delowner", "*chanserv.deluser", "owner", "$1", NULL);
2251 service_make_alias(service, "delcoowner", "*chanserv.deluser", "coowner", "$1", NULL);
2252 service_make_alias(service, "delmaster", "*chanserv.deluser", "master", "$1", NULL);
2253 service_make_alias(service, "delop", "*chanserv.deluser", "op", "$1", NULL);
2254 service_make_alias(service, "delpeon", "*chanserv.deluser", "peon", "$1", NULL);
2255 service_make_alias(service, "command", "*modcmd.command", NULL);
2256 service_make_alias(service, "god", "*modcmd.god", NULL);
2257 } else if (!irccasecmp(def_binds[ii].svcname, "OpServ")) {
2258 struct svccmd *svccmd;
2259 svccmd = service_make_alias(service, "stats", "*modcmd.joiner", NULL);
2260 svccmd->min_opserv_level = 101;
2261 svccmd = service_make_alias(service, "service", "*modcmd.joiner", NULL);
2262 svccmd->min_opserv_level = 900;
2268 import_aliases_db() {
2270 dict_iterator_t it, it2;
2271 struct record_data *rd, *rd2;
2272 struct service *service;
2273 struct module *module;
2275 if (!(db = parse_database("aliases.db")))
2277 for (it = dict_first(db); it; it = iter_next(it)) {
2278 service = service_find(iter_key(it));
2281 module = module_find(service->bot->nick);
2283 if (rd->type != RECDB_OBJECT)
2285 for (it2 = dict_first(rd->d.object); it2; it2 = iter_next(it2)) {
2286 struct modcmd *command;
2287 rd2 = iter_data(it2);
2288 if (rd2->type != RECDB_QSTRING)
2290 command = dict_find(module->commands, rd2->d.qstring, NULL);
2293 service_bind_modcmd(service, command, iter_key(it2));
2299 modcmd_finalize(void) {
2300 /* Check databases. */
2301 saxdb_register("modcmd", modcmd_saxdb_read, modcmd_saxdb_write);
2302 create_default_binds();
2304 import_aliases_db();
2306 /* Resolve command rule-templates. */
2307 while (pending_templates) {
2308 struct pending_template *ptempl = pending_templates;
2309 struct svccmd *svccmd;
2311 pending_templates = ptempl->next;
2312 /* Only overwrite the current template if we have a valid template. */
2313 if (!strcmp(ptempl->base, "*")) {
2315 } else if ((svccmd = svccmd_resolve_name(ptempl->cmd, ptempl->base))) {
2316 svccmd_copy_rules(ptempl->cmd, svccmd);
2318 assert(ptempl->cmd->parent);
2319 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);