1 /* modcmd.c - Generalized module command support
2 * Copyright 2002-2006 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 "git-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_BARE_FLAG", "Flag %.*s must be preceded by a + or -." },
40 { "MCMSG_UNKNOWN_FLAG", "Unknown module flag %.*s." },
41 { "MCMSG_BAD_OPSERV_LEVEL", "Invalid $O access level %s." },
42 { "MCMSG_BAD_CHANSERV_LEVEL", "Invalid $C access level %s." },
43 { "MCMSG_LEVEL_TOO_LOW", "You cannot set the access requirements for %s (your level is too low.)" },
44 { "MCMSG_LEVEL_TOO_HIGH", "You cannot set the access requirements to %s (that is too high)." },
45 { "MCMSG_BAD_OPTION", "Unknown option %s." },
46 { "MCMSG_MUST_QUALIFY", "You $bMUST$b \"/msg %s@$s %s\" (not just /msg %s)." },
47 { "MCMSG_ACCOUNT_SUSPENDED", "Your account has been suspended." },
48 { "MCMSG_CHAN_NOT_REGISTERED", "%s has not been registered with $C." },
49 { "MCMSG_CHAN_SUSPENDED", "$b$C$b access to $b%s$b has been temporarily suspended (%s)." },
50 { "MCMSG_NO_CHANNEL_ACCESS", "You lack access to %s." },
51 { "MCMSG_LOW_CHANNEL_ACCESS", "You lack sufficient access in %s to use this command." },
52 { "MCMSG_REQUIRES_JOINABLE", "You must be in %s (or on its userlist) to use this command." },
53 { "MCMSG_MUST_BE_HELPING", "You must have security override (helping mode) on to use this command." },
54 { "MCMSG_MISSING_COMMAND", "You must specify a command as well as a channel." },
55 { "MCMSG_NO_CHANNEL_BEFORE", "You may not give a channel name before this command." },
56 { "MCMSG_NO_PLUS_CHANNEL", "You may not use a +channel with this command." },
57 { "MCMSG_COMMAND_ALIASES", "%s is an alias for: %s" },
58 { "MCMSG_COMMAND_BINDING", "%s is a binding of: %s" },
59 { "MCMSG_ALIAS_ERROR", "Error in alias expansion for %s; check the error log for details." },
60 { "MCMSG_INTERNAL_COMMAND", "$b%s$b is an internal command and cannot be called directly; please check command bindings." },
61 { "MCMSG_UNKNOWN_MODULE", "Unknown module %s." },
62 { "MCMSG_UNKNOWN_SERVICE", "Unknown service %s." },
63 { "MCMSG_ALREADY_BOUND", "%s already has a command bound as %s." },
64 { "MCMSG_UNKNOWN_COMMAND_2", "Unknown command name %s (relative to service %s)." },
65 { "MCMSG_COMMAND_MODIFIED", "Option $b%s$b for $b%s$b has been set." },
66 { "MCMSG_INSPECTION_REFUSED", "You do not have access to inspect command %s." },
67 { "MCMSG_CANNOT_DOUBLE_ALIAS", "You cannot bind to a complex (argument-carrying) bind." },
68 { "MCMSG_BAD_ALIAS_ARGUMENT", "Invalid alias argument $b%s$b." },
69 { "MCMSG_COMMAND_BOUND", "New command %s bound to %s." },
70 { "MCMSG_MODULE_BOUND", "Bound %d commands from %s to %s." },
71 { "MCMSG_NO_COMMAND_BOUND", "%s has nothing bound as command %s." },
72 { "MCMSG_UNBIND_PROHIBITED", "It wouldn't be very much fun to unbind the last %s command, now would it?" },
73 { "MCMSG_COMMAND_UNBOUND", "Unbound command %s from %s." },
74 { "MCMSG_HELPFILE_UNBOUND", "Since that was the last command from module %s on the service, the helpfile for %s was removed." },
75 { "MCMSG_NO_HELPFILE", "Module %s does not have a help file." },
76 { "MCMSG_HELPFILE_ERROR", "Syntax error reading %s; help contents not changed." },
77 { "MCMSG_HELPFILE_READ", "Read %s help database in "FMT_TIME_T".%03lu seconds." },
78 { "MCMSG_COMMAND_TIME", "Command $b%s$b finished in "FMT_TIME_T".%06lu seconds." },
79 { "MCMSG_NEED_OPSERV_LEVEL", "You must have $O access of at least $b%u$b." },
80 { "MCMSG_NEED_CHANSERV_LEVEL", "You must have $C access of at least $b%u$b in the channel." },
81 { "MCMSG_NEED_ACCOUNT_FLAGS", "You must have account flags $b%s$b." },
82 { "MCMSG_NEED_NOTHING", "Anyone may use the $b%s$b command." },
83 { "MCMSG_NEED_STAFF_ACCESS", "You must be network staff." },
84 { "MCMSG_NEED_STAFF_OPER", "You must be an IRC operator." },
85 { "MCMSG_NEED_STAFF_NETHELPER", "You must be a network helper." },
86 { "MCMSG_NEED_STAFF_NETHELPER_OR_OPER", "You must be a network helper or IRC operator." },
87 { "MCMSG_NEED_STAFF_SHELPER", "You must be a support helper." },
88 { "MCMSG_NEED_STAFF_SHELPER_OR_OPER", "You must be a support helper or IRC operator." },
89 { "MCMSG_NEED_STAFF_HELPER", "You must be a network or support helper." },
90 { "MCMSG_NEED_JOINABLE", "The channel must be open or you must be in the channel or on its userlist." },
91 { "MCMSG_NEED_CHANUSER_CSUSPENDABLE", "You must be on the channel's userlist, and the channel can be suspended." },
92 { "MCMSG_NEED_CHANUSER", "You must be on the channel's userlist." },
93 { "MCMSG_NEED_REGCHAN", "You must specify a channel registered with $C." },
94 { "MCMSG_NEED_CHANNEL", "You must specify a channel that exists." },
95 { "MCMSG_NEED_AUTHED", "You must be authenticated with $N." },
96 { "MCMSG_IS_TOY", "$b%s$b is a toy command." },
97 { "MCMSG_END_REQUIREMENTS", "End of requirements for $b%s$b." },
98 { "MCMSG_ALREADY_HELPING", "You already have security override enabled." },
99 { "MCMSG_ALREADY_NOT_HELPING", "You already have security override disabled." },
100 { "MCMSG_NOW_HELPING", "Security override has been enabled." },
101 { "MCMSG_NOW_NOT_HELPING", "Security override has been disabled." },
102 { "MCMSG_JOINER_CHOICES", "Subcommands of %s: %s" },
103 { "MCMSG_MODULE_INFO", "Commands exported by module $b%s$b:" },
104 { "MCMSG_SERVICE_INFO", "Commands bound to service $b%s$b:" },
105 { "MCMSG_TOYS_DISABLED", "Toys are disabled in %s." },
106 { "MCMSG_PUBLIC_DENY", "Public commands in $b%s$b are restricted." },
107 { "MCMSG_HELPFILE_SEQUENCE", "Help priority %d: %s" },
108 { "MCMSG_HELPFILE_SEQUENCE_SET", "Set helpfile priority sequence for %s." },
109 { "MCMSG_BAD_SERVICE_NICK", "$b%s$b is an invalid nickname." },
110 { "MCMSG_ALREADY_SERVICE", "$b%s$b is already a service." },
111 { "MCMSG_NEW_SERVICE", "Added new service bot $b%s$b." },
112 { "MCMSG_SERVICE_RENAMED", "Service renamed to $b%s$b." },
113 { "MCMSG_NO_TRIGGER", "$b%s$b does not have an in-channel trigger." },
114 { "MCMSG_REMOVED_TRIGGER", "Removed trigger from $b%s$b." },
115 { "MCMSG_DUPLICATE_TRIGGER", "$b%s$b already uses trigger $b%c$b." },
116 { "MCMSG_CURRENT_TRIGGER", "Trigger for $b%s$b is $b%c$b." },
117 { "MCMSG_NEW_TRIGGER", "Changed trigger for $b%s$b to $b%c$b." },
118 { "MCMSG_SERVICE_PRIVILEGED", "Service $b%s$b privileged: $b%s$b." },
119 { "MCMSG_SERVICE_REMOVED", "Service $b%s$b has been deleted." },
120 { "MCMSG_FILE_NOT_OPENED", "Unable to open file $b%s$b for writing." },
121 { "MCMSG_MESSAGES_DUMPED", "Messages written to $b%s$b." },
122 { "MCMSG_MESSAGE_DUMP_FAILED", "Message dump failed: %s." },
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 { "helping", MODCMD_REQUIRE_HELPING },
149 { "ignore_csuspend", MODCMD_IGNORE_CSUSPEND },
150 { "joinable", MODCMD_REQUIRE_JOINABLE },
151 { "keepbound", MODCMD_KEEP_BOUND },
152 { "loghostmask", MODCMD_LOG_HOSTMASK },
153 { "networkhelper", MODCMD_REQUIRE_NETWORK_HELPER },
154 { "never_csuspend", MODCMD_NEVER_CSUSPEND },
155 { "nolog", MODCMD_NO_LOG },
156 { "oper", MODCMD_REQUIRE_OPER },
157 { "qualified", MODCMD_REQUIRE_QUALIFIED },
158 { "regchan", MODCMD_REQUIRE_REGCHAN },
159 { "supporthelper", MODCMD_REQUIRE_SUPPORT_HELPER },
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)))
550 rflags |= ACTION_STAFF;
552 if (cmd->req_account_flags || cmd->deny_account_flags) {
553 if (!user->handle_info) {
554 if (options & SVCCMD_NOISY)
555 send_message(user, bot, "MSG_AUTHENTICATE");
558 /* Do we want separate or different messages here? */
559 if ((cmd->req_account_flags & ~user->handle_info->flags)
560 || (cmd->deny_account_flags & user->handle_info->flags)) {
561 if (options & SVCCMD_NOISY)
562 send_message(user, bot, "MSG_COMMAND_PRIVILEGED", cmd->name);
567 /* If it's an override, return a special value. */
568 if ((flags & MODCMD_REQUIRE_CHANUSER)
569 && (options & SVCCMD_NOISY)
570 && (!uData || (uData->access > 500))
571 && (!(uData = _GetChannelUser(channel->channel_info, user->handle_info, 0, 0))
572 || uData->access < cmd->min_channel_access)
573 && !(flags & (MODCMD_REQUIRE_STAFF|MODCMD_REQUIRE_HELPING))) {
574 rflags |= ACTION_OVERRIDE;
576 return rflags | ACTION_ALLOW;
580 svccmd_expand_alias(struct svccmd *cmd, unsigned int old_argc, char *old_argv[], char *new_argv[]) {
581 unsigned int ii, new_argc;
584 for (ii=new_argc=0; ii<cmd->alias.used; ++ii) {
585 arg = cmd->alias.list[ii];
587 new_argv[new_argc++] = arg;
591 new_argv[new_argc++] = arg + 1;
592 } else if (isdigit(arg[1])) {
593 unsigned int lbound, ubound, jj;
596 lbound = strtoul(arg+1, &end_num, 10);
597 switch (end_num[0]) {
598 case 0: ubound = lbound; break;
600 if (end_num[1] == 0) {
601 ubound = old_argc - 1;
603 } else if (isdigit(end_num[1])) {
604 ubound = strtoul(end_num+1, NULL, 10);
607 /* else fall through to default case */
609 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);
612 if (ubound >= old_argc)
613 ubound = old_argc - 1;
614 if (lbound < old_argc)
615 for (jj = lbound; jj <= ubound; )
616 new_argv[new_argc++] = old_argv[jj++];
618 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);
626 svccmd_invoke_argv(struct userNode *user, struct service *service, struct chanNode *channel, unsigned int argc, char *argv[], unsigned int server_qualified) {
627 extern struct userNode *chanserv;
629 unsigned int cmd_arg, perms, flags, options, result;
630 char channel_name[CHANNELLEN+1];
632 /* First check pubcmd for the channel. */
633 if (channel && (channel->channel_info) && (service->bot == chanserv)
634 && !check_user_level(channel, user, lvlPubCmd, 1, 0)) {
635 send_message(user, service->bot, "MCMSG_PUBLIC_DENY", channel->name);
639 options = (server_qualified ? SVCCMD_QUALIFIED : 0) | SVCCMD_DEBIT | SVCCMD_NOISY;
640 /* Find the command argument. */
641 cmd_arg = IsChannelName(argv[0]) ? 1 : 0;
642 if (argc < cmd_arg+1) {
643 send_message(user, service->bot, "MCMSG_MISSING_COMMAND");
646 if (!isalnum(*argv[cmd_arg])) {
647 /* Silently ignore stuff that doesn't begin with a letter or number. */
650 cmd = dict_find(service->commands, argv[cmd_arg], NULL);
653 send_message(user, service->bot, "MSG_COMMAND_UNKNOWN", argv[cmd_arg]);
656 flags = cmd->effective_flags;
657 /* If they put a channel name first, check if the command allows
658 * it. If so, swap it with the command name.
662 /* Complain if we're not supposed to accept the channel. */
663 if (!(flags & MODCMD_ACCEPT_CHANNEL)) {
664 send_message(user, service->bot, "MCMSG_NO_CHANNEL_BEFORE");
667 if (!(flags & MODCMD_ACCEPT_PCHANNEL)
668 && (argv[0][0] == '+')) {
669 send_message(user, service->bot, "MCMSG_NO_PLUS_CHANNEL");
677 /* Try to grab a channel handle before alias expansion.
678 * If the command accepts a channel name, and argv[1] is
679 * one, use it as a channel name, and hide it from logging.
682 && (flags & MODCMD_ACCEPT_CHANNEL)
683 && IsChannelName(argv[1])
684 && ((argv[1][0] != '+') || (flags & MODCMD_ACCEPT_PCHANNEL))
685 && (channel = dict_find(channels, argv[1], NULL))) {
691 /* Expand the alias arguments, if there are any. */
692 if (cmd->alias.used) {
693 char *new_argv[MAXNUMPARAMS];
694 argc = svccmd_expand_alias(cmd, argc, argv, new_argv);
696 send_message(service->bot, user, "MCMSG_ALIAS_ERROR", cmd->name);
701 /* Try again to grab a handle to the channel after alias
702 * expansion, overwriting any previous channel. This should,
703 * of course, only be done again if an alias was acually
706 && (flags & MODCMD_ACCEPT_CHANNEL)
707 && IsChannelName(argv[1])
708 && ((argv[1][0] != '+') || (flags & MODCMD_ACCEPT_PCHANNEL))
709 && (channel = dict_find(channels, argv[1], NULL))) {
716 /* Figure out what actions we should do for it.. */
717 if (cmd_arg && (flags & MODCMD_TOY)) {
718 /* Do not let user manually specify a channel. */
721 if (argc < cmd->command->min_argc) {
722 send_message(user, service->bot, "MSG_MISSING_PARAMS", cmd->name);
725 if (!cmd->command->func) {
726 send_message(user, service->bot, "MCMSG_INTERNAL_COMMAND", cmd->name);
729 perms = svccmd_can_invoke(user, service->bot, cmd, channel, options);
733 if (perms & ACTION_NOCHANNEL)
737 safestrncpy(channel_name, channel->name, sizeof(channel_name));
740 if (!(result = cmd->command->func(user, channel, argc, argv, cmd)))
742 if (!(flags & MODCMD_NO_LOG)) {
743 enum log_severity slvl;
744 if (result & CMD_LOG_OVERRIDE)
746 else if ((perms & ACTION_STAFF) || (result & CMD_LOG_STAFF))
748 else if (perms & ACTION_OVERRIDE)
752 /* Unsplit argv after running the function to get the benefit
753 * of any mangling/hiding done by the commands. */
754 log_audit(cmd->command->parent->clog, slvl, user, service->bot, channel_name, ((flags & MODCMD_LOG_HOSTMASK) ? AUDIT_HOSTMASK : 0), unsplit_string(argv, argc, NULL));
760 svccmd_send_help(struct userNode *user, struct userNode *bot, struct svccmd *cmd) {
761 char cmdname[MAXLEN];
763 /* Show command name (in bold). */
764 for (nn=0; cmd->name[nn]; nn++)
765 cmdname[nn] = toupper(cmd->name[nn]);
767 send_message_type(4, user, bot, "$b%s$b", cmdname);
768 /* If it's an alias, show what it's an alias for. */
769 if (cmd->alias.used) {
770 char alias_text[MAXLEN];
771 unsplit_string((char**)cmd->alias.list, cmd->alias.used, alias_text);
772 send_message(user, bot, "MCMSG_COMMAND_ALIASES", cmd->name, alias_text);
774 /* Show the help entry for the underlying command. */
775 return send_help(user, bot, cmd->command->parent->helpfile, cmd->command->name);
779 svccmd_send_help_2(struct userNode *user, struct service *service, const char *topic) {
780 struct module *module;
784 if ((cmd = dict_find(service->commands, topic, NULL)))
785 return svccmd_send_help(user, service->bot, cmd);
788 for (ii = 0; ii < service->modules.used; ++ii) {
789 module = service->modules.list[ii];
790 if (!module->helpfile)
792 if (dict_find(module->helpfile->db, topic, NULL))
793 return send_help(user, service->bot, module->helpfile, topic);
795 send_message(user, service->bot, "MSG_TOPIC_UNKNOWN");
800 svccmd_invoke(struct userNode *user, struct service *service, struct chanNode *channel, const char *text, int server_qualified) {
802 char *argv[MAXNUMPARAMS];
803 char tmpline[MAXLEN];
807 if (service->privileged) {
809 send_message(user, service->bot, "MSG_SERVICE_PRIVILEGED", service->bot->nick);
812 if (!user->handle_info) {
813 send_message(user, service->bot, "MSG_AUTHENTICATE");
816 if (HANDLE_FLAGGED(user->handle_info, OPER_SUSPENDED)) {
817 send_message(user, service->bot, "MSG_OPER_SUSPENDED");
821 safestrncpy(tmpline, text, sizeof(tmpline));
822 argc = split_line(tmpline, false, ArrayLength(argv), argv);
823 return argc ? svccmd_invoke_argv(user, service, channel, argc, argv, server_qualified) : 0;
827 modcmd_privmsg(struct userNode *user, struct userNode *bot, const char *text, int server_qualified) {
828 struct service *service;
830 if (!(service = dict_find(services, bot->nick, NULL))) {
831 log_module(MAIN_LOG, LOG_ERROR, "modcmd_privmsg got privmsg for unhandled service %s, unregistering.", bot->nick);
832 reg_privmsg_func(bot, NULL);
836 if (text[0] == '\x01') {
837 char *term, response[MAXLEN];
839 text++; /* Skip leading ^A. */
840 /* Chop off final ^A. */
841 term = strchr(text, '\x01');
845 /* Parse out leading text. */
846 term = strchr(text, ' ');
852 /* No dict lookup since these are so few. */
853 if (!irccasecmp(text, "CLIENTINFO")) {
854 /* Use \001 instead of \x01 because apparently \x01C is
855 * interpreted as ASCII FS (\034, decimal 28, hex 1C).
857 irc_notice_user(bot, user, "\001CLIENTINFO CLIENTINFO PING TIME USERINFO VERSION\x01");
858 } else if (!irccasecmp(text, "PING")) {
860 snprintf(response, sizeof(response), "\x01PING %s\x01", term);
861 irc_notice_user(bot, user, response);
863 irc_notice_user(bot,user, "\x01PING\x01");
865 } else if (!irccasecmp(text, "TIME")) {
867 localtime_r(&now, &tm);
868 strftime(response, sizeof(response), "\x01TIME %a %b %d %H:%M:%S %Y\x01", &tm);
869 irc_notice_user(bot, user, response);
870 } else if (!irccasecmp(text, "USERINFO")) {
871 snprintf(response, sizeof(response), "\x01USERINFO %s\x01", bot->info);
872 irc_notice_user(bot, user, response);
873 } else if (!irccasecmp(text, "VERSION")) {
874 /* This function provides copyright management information
875 * to end users of srvx. You should not alter, disable or
876 * remove this command or its accessibility to normal IRC
877 * users, except to add copyright information pertaining
878 * to changes you make to srvx.
880 snprintf(response, sizeof(response), "\x01VERSION %s (%s) %s\x01", PACKAGE_STRING, CODENAME, GIT_VERSION);
881 irc_notice_user(bot, user, response);
886 if (service->msg_hook && service->msg_hook(user, bot, text, server_qualified))
888 svccmd_invoke(user, service, NULL, text, server_qualified);
892 modcmd_chanmsg(struct userNode *user, struct chanNode *chan, const char *text, struct userNode *bot) {
893 struct service *service;
894 if (!(service = dict_find(services, bot->nick, NULL))) return;
895 svccmd_invoke(user, service, chan, text, 0);
899 service_register(struct userNode *bot) {
900 struct service *service;
901 if ((service = dict_find(services, bot->nick, NULL)))
903 service = calloc(1, sizeof(*service));
904 module_list_init(&service->modules);
905 service->commands = dict_new();
907 dict_set_free_data(service->commands, free_service_command);
908 dict_insert(services, service->bot->nick, service);
909 reg_privmsg_func(bot, modcmd_privmsg);
914 service_find(const char *name) {
915 return dict_find(services, name, NULL);
919 svccmd_insert(struct service *service, char *name, struct svccmd *svccmd, struct modcmd *modcmd) {
921 svccmd->parent = service;
923 svccmd->command = modcmd;
924 svccmd->command->bind_count++;
925 dict_insert(service->commands, svccmd->name, svccmd);
926 for (ii=0; ii<service->modules.used; ++ii) {
927 if (service->modules.list[ii] == svccmd->command->parent) break;
929 if (ii == service->modules.used) {
930 module_list_append(&service->modules, svccmd->command->parent);
935 service_bind_modcmd(struct service *service, struct modcmd *cmd, const char *name) {
936 struct svccmd *svccmd;
937 if ((svccmd = dict_find(service->commands, name, NULL))) {
938 if (svccmd->command == cmd) return svccmd;
939 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);
942 svccmd = calloc(1, sizeof(*svccmd));
943 svccmd_insert(service, strdup(name), svccmd, cmd);
944 svccmd_copy_rules(svccmd, cmd->defaults);
949 service_bind_module(struct service *service, struct module *module) {
951 struct modcmd *modcmd;
955 for (it = dict_first(module->commands); it; it = iter_next(it)) {
956 modcmd = iter_data(it);
957 if (!((modcmd->flags | modcmd->defaults->flags) & MODCMD_NO_DEFAULT_BIND))
958 if (service_bind_modcmd(service, modcmd, iter_key(it)))
964 /* This MUST return argc if the alias expansion code knows how to deal
965 * with every argument in argv; otherwise, it MUST return the index of
966 * an argument that the expansion code does not know how to deal with.
969 check_alias_args(char *argv[], unsigned int argc) {
972 for (arg=0; arg<argc; ++arg) {
973 if (argv[arg][0] != '$') {
975 } else if (argv[arg][1] == '$') {
977 } else if (isdigit(argv[arg][1])) {
980 strtoul(argv[arg]+1, &end_num, 10);
981 switch (end_num[0]) {
987 else if (isdigit(end_num[1]))
989 /* else fall through to default case */
1000 collapse_cmdname(char *argv[], unsigned int argc, char *dest) {
1001 unsigned int ii, pos, arg;
1006 for (ii=pos=0, arg=0; argv[arg][ii]; ) {
1007 if (argv[arg][ii] == '\\') {
1008 if (argv[arg][ii+1]) {
1009 /* escaping a real character just puts it in literally */
1010 dest[pos++] = argv[arg][++ii];
1011 } else if ((arg+1) == argc) {
1012 /* we ran to the end of the argument list; abort */
1015 /* escape at end of a word is a space */
1021 /* normal characters don't need escapes */
1022 dest[pos++] = argv[arg][ii++];
1029 static MODCMD_FUNC(cmd_bind) {
1030 struct service *service;
1031 struct svccmd *template, *newcmd;
1032 char *svcname, *dot;
1033 char newname[MAXLEN], cmdname[MAXLEN];
1034 unsigned int arg, diff;
1038 arg = collapse_cmdname(argv+2, argc-2, newname) + 2;
1040 reply("MSG_MISSING_PARAMS", cmd->name);
1043 diff = collapse_cmdname(argv+arg, argc-arg, cmdname);
1045 reply("MSG_MISSING_PARAMS", cmd->name);
1050 if (!(service = service_find(svcname))) {
1051 reply("MCMSG_UNKNOWN_SERVICE", svcname);
1055 if ((newcmd = dict_find(service->commands, newname, NULL))) {
1056 reply("MCMSG_ALREADY_BOUND", service->bot->nick, newname);
1060 if ((dot = strchr(cmdname, '.')) && (dot[1] == '*') && (dot[2] == 0)) {
1062 struct module *module;
1064 module = module_find((cmdname[0] == '*') ? cmdname+1 : cmdname);
1066 reply("MSG_MODULE_UNKNOWN", cmdname);
1069 count = service_bind_module(service, module);
1070 reply("MCMSG_MODULE_BOUND", count, module->name, service->bot->nick);
1073 newcmd = calloc(1, sizeof(*newcmd));
1074 newcmd->name = strdup(newname);
1075 newcmd->parent = service;
1076 if (!(template = svccmd_resolve_name(newcmd, cmdname))) {
1077 reply("MCMSG_UNKNOWN_COMMAND_2", cmdname, service->bot->nick);
1082 if (template->alias.used) {
1083 reply("MCMSG_CANNOT_DOUBLE_ALIAS");
1090 /* a more complicated alias; fix it up */
1094 nn = check_alias_args(argv+arg, argc-arg);
1095 if (nn+arg < argc) {
1096 reply("MCMSG_BAD_ALIAS_ARGUMENT", argv[nn+arg]);
1101 newcmd->alias.used = newcmd->alias.size = argc-arg;
1102 newcmd->alias.list = calloc(newcmd->alias.size, sizeof(newcmd->alias.list[0]));
1103 for (nn=0; nn<newcmd->alias.used; ++nn)
1104 newcmd->alias.list[nn] = strdup(argv[nn+arg]);
1107 svccmd_insert(service, newcmd->name, newcmd, template->command);
1108 svccmd_copy_rules(newcmd, template);
1109 reply("MCMSG_COMMAND_BOUND", newcmd->name, newcmd->parent->bot->nick);
1114 service_recheck_bindings(struct service *service, struct module *module) {
1118 for (it = dict_first(service->commands); it; it = iter_next(it)) {
1119 cmd = iter_data(it);
1120 if (cmd->command->parent == module) return 0;
1122 /* No more bindings, remove it from our list. */
1123 module_list_remove(&service->modules, module);
1127 static svccmd_unbind_func_t *suf_list;
1128 unsigned int suf_size, suf_used;
1131 reg_svccmd_unbind_func(svccmd_unbind_func_t handler) {
1132 if (suf_used == suf_size) {
1135 suf_list = realloc(suf_list, suf_size*sizeof(svccmd_unbind_func_t));
1138 suf_list = malloc(suf_size*sizeof(svccmd_unbind_func_t));
1141 suf_list[suf_used++] = handler;
1144 static MODCMD_FUNC(cmd_unbind) {
1145 struct service *service;
1146 struct userNode *bot;
1147 struct svccmd *bound;
1148 struct module *module;
1149 const char *svcname;
1150 unsigned int arg, ii;
1151 char cmdname[MAXLEN];
1155 arg = collapse_cmdname(argv+2, argc-2, cmdname) + 2;
1157 reply("MSG_MISSING_PARAMS", cmd->name);
1160 if (!(service = service_find(svcname))) {
1161 reply("MCMSG_UNKNOWN_SERVICE", svcname);
1164 if (!(bound = dict_find(service->commands, cmdname, NULL))) {
1165 reply("MCMSG_NO_COMMAND_BOUND", service->bot->nick, cmdname);
1168 if ((bound->command->flags & MODCMD_KEEP_BOUND) && (bound->command->bind_count == 1)) {
1169 reply("MCMSG_UNBIND_PROHIBITED", bound->command->name);
1173 for (ii=0; ii<suf_used; ii++)
1174 suf_list[ii](bound);
1175 /* If this command binding is removing itself, we must take care
1176 * not to dereference it after the dict_remove.
1178 bot = cmd->parent->bot;
1179 module = cmd->command->parent;
1180 dict_remove(service->commands, bound->name);
1181 send_message(user, bot, "MCMSG_COMMAND_UNBOUND", cmdname, service->bot->nick);
1182 if (service_recheck_bindings(service, module))
1183 send_message(user, bot, "MCMSG_HELPFILE_UNBOUND", module->name, module->name);
1187 static MODCMD_FUNC(cmd_readhelp) {
1188 const char *modname;
1189 struct module *module;
1190 struct helpfile *old_helpfile;
1191 struct timeval start, stop;
1195 if (!(module = module_find(modname))) {
1196 reply("MSG_MODULE_UNKNOWN", modname);
1199 if (!module->helpfile_name) {
1200 reply("MCMSG_NO_HELPFILE", module->name);
1203 old_helpfile = module->helpfile;
1204 gettimeofday(&start, NULL);
1205 module->helpfile = open_helpfile(module->helpfile_name, module->expand_help);
1206 if (!module->helpfile) {
1207 module->helpfile = old_helpfile;
1208 reply("MCMSG_HELPFILE_ERROR", module->helpfile_name);
1211 if (old_helpfile) close_helpfile(old_helpfile);
1212 gettimeofday(&stop, NULL);
1213 stop.tv_sec -= start.tv_sec;
1214 stop.tv_usec -= start.tv_usec;
1215 if (stop.tv_usec < 0) {
1217 stop.tv_usec += 1000000;
1219 reply("MCMSG_HELPFILE_READ", module->name, stop.tv_sec, stop.tv_usec/1000);
1223 static MODCMD_FUNC(cmd_help) {
1226 topic = (argc < 2) ? NULL : unsplit_string(argv+1, argc-1, NULL);
1227 return svccmd_send_help_2(user, cmd->parent, topic);
1230 static MODCMD_FUNC(cmd_timecmd) {
1231 struct timeval start, stop;
1232 char cmd_text[MAXLEN];
1234 unsplit_string(argv+1, argc-1, cmd_text);
1235 gettimeofday(&start, NULL);
1236 svccmd_invoke(user, cmd->parent, channel, cmd_text, 0);
1237 gettimeofday(&stop, NULL);
1238 stop.tv_sec -= start.tv_sec;
1239 stop.tv_usec -= start.tv_usec;
1240 if (stop.tv_usec < 0) {
1242 stop.tv_usec += 1000000;
1244 reply("MCMSG_COMMAND_TIME", cmd_text, stop.tv_sec, stop.tv_usec);
1248 static MODCMD_FUNC(cmd_command) {
1249 struct svccmd *svccmd;
1250 const char *cmd_name, *fmt_str;
1251 unsigned int flags, shown_flags, nn, pos;
1255 cmd_name = unsplit_string(argv+1, argc-1, NULL);
1256 if (!(svccmd = svccmd_resolve_name(cmd, cmd_name))) {
1257 reply("MCMSG_UNKNOWN_COMMAND_2", cmd_name, cmd->parent->bot->nick);
1260 pos = snprintf(buf, sizeof(buf), "%s.%s", svccmd->command->parent->name, svccmd->command->name);
1261 if (svccmd->alias.used) {
1263 unsplit_string((char**)svccmd->alias.list+1, svccmd->alias.used-1, buf+pos);
1264 reply("MCMSG_COMMAND_ALIASES", svccmd->name, buf);
1266 reply("MCMSG_COMMAND_BINDING", svccmd->name, buf);
1268 flags = svccmd->effective_flags;
1269 if ((svccmd->parent && svccmd->parent->privileged && !IsOper(user))
1270 || ((flags & MODCMD_REQUIRE_STAFF)
1271 && !IsOper(user) && !IsNetworkHelper(user) && !IsSupportHelper(user))) {
1272 reply("MCMSG_INSPECTION_REFUSED", svccmd->name);
1275 if (flags & MODCMD_DISABLED) {
1276 reply("MSG_COMMAND_DISABLED", svccmd->name);
1280 if (svccmd->min_opserv_level > 0) {
1281 reply("MCMSG_NEED_OPSERV_LEVEL", svccmd->min_opserv_level);
1282 shown_flags |= MODCMD_REQUIRE_OPER | MODCMD_REQUIRE_AUTHED;
1284 if (svccmd->min_channel_access > 0) {
1285 reply("MCMSG_NEED_CHANSERV_LEVEL", svccmd->min_channel_access);
1286 shown_flags |= MODCMD_REQUIRE_CHANUSER | MODCMD_REQUIRE_REGCHAN | MODCMD_REQUIRE_CHANNEL | MODCMD_REQUIRE_AUTHED;
1288 if (svccmd->req_account_flags) {
1289 for (nn=pos=0; nn<32; nn++) {
1290 if (!(svccmd->req_account_flags & (1 << nn))) continue;
1291 buf[pos++] = HANDLE_FLAGS[nn];
1294 reply("MCMSG_NEED_ACCOUNT_FLAGS", buf);
1295 shown_flags |= MODCMD_REQUIRE_AUTHED;
1297 if (!flags && !shown_flags) {
1298 reply("MCMSG_NEED_NOTHING", svccmd->name);
1301 if (flags & ~shown_flags & MODCMD_REQUIRE_HELPING) {
1302 reply("MCMSG_MUST_BE_HELPING");
1303 shown_flags |= MODCMD_REQUIRE_AUTHED | MODCMD_REQUIRE_STAFF;
1305 if (flags & ~shown_flags & MODCMD_REQUIRE_STAFF) {
1306 switch (flags & MODCMD_REQUIRE_STAFF) {
1307 default: case MODCMD_REQUIRE_STAFF:
1308 fmt_str = "MCMSG_NEED_STAFF_ACCESS";
1310 case MODCMD_REQUIRE_OPER:
1311 fmt_str = "MCMSG_NEED_STAFF_OPER";
1313 case MODCMD_REQUIRE_NETWORK_HELPER:
1314 fmt_str = "MCMSG_NEED_STAFF_NETHELPER";
1316 case MODCMD_REQUIRE_OPER|MODCMD_REQUIRE_NETWORK_HELPER:
1317 fmt_str = "MCMSG_NEED_STAFF_NETHELPER_OR_OPER";
1319 case MODCMD_REQUIRE_SUPPORT_HELPER:
1320 fmt_str = "MCMSG_NEED_STAFF_SHELPER";
1322 case MODCMD_REQUIRE_OPER|MODCMD_REQUIRE_SUPPORT_HELPER:
1323 fmt_str = "MCMSG_NEED_STAFF_SHELPER_OR_OPER";
1325 case MODCMD_REQUIRE_SUPPORT_HELPER|MODCMD_REQUIRE_NETWORK_HELPER:
1326 fmt_str = "MCMSG_NEED_STAFF_HELPER";
1330 shown_flags |= MODCMD_REQUIRE_AUTHED | MODCMD_REQUIRE_STAFF;
1332 if (flags & ~shown_flags & MODCMD_REQUIRE_JOINABLE) {
1333 reply("MCMSG_NEED_JOINABLE");
1334 shown_flags |= MODCMD_REQUIRE_CHANUSER;
1336 if (flags & ~shown_flags & MODCMD_REQUIRE_CHANUSER) {
1337 if (flags & ~shown_flags & MODCMD_IGNORE_CSUSPEND)
1338 reply("MCMSG_NEED_CHANUSER_CSUSPENDABLE");
1340 reply("MCMSG_NEED_CHANUSER");
1341 shown_flags |= MODCMD_IGNORE_CSUSPEND | MODCMD_REQUIRE_REGCHAN | MODCMD_REQUIRE_CHANNEL | MODCMD_REQUIRE_AUTHED;
1343 if (flags & ~shown_flags & MODCMD_REQUIRE_REGCHAN) {
1344 reply("MCMSG_NEED_REGCHAN");
1345 shown_flags |= MODCMD_REQUIRE_CHANNEL;
1347 if (flags & ~shown_flags & MODCMD_REQUIRE_CHANNEL)
1348 reply("MCMSG_NEED_CHANNEL");
1349 if (flags & ~shown_flags & MODCMD_REQUIRE_AUTHED)
1350 reply("MCMSG_NEED_AUTHED");
1351 if (flags & ~shown_flags & MODCMD_TOY)
1352 reply("MCMSG_IS_TOY", svccmd->name);
1353 if (flags & ~shown_flags & MODCMD_REQUIRE_QUALIFIED) {
1354 const char *botnick = svccmd->parent ? svccmd->parent->bot->nick : "SomeBot";
1355 reply("MCMSG_MUST_QUALIFY", botnick, svccmd->name, botnick);
1357 reply("MCMSG_END_REQUIREMENTS", svccmd->name);
1362 modcmd_describe_command(struct userNode *user, struct svccmd *cmd, struct svccmd *target) {
1363 char buf1[MAXLEN], buf2[MAXLEN];
1364 unsigned int ii, len, buf1_used, buf2_used;
1366 if (target->alias.used) {
1367 unsplit_string((char**)target->alias.list, target->alias.used, buf1);
1368 reply("MCMSG_COMMAND_ALIASES", target->name, buf1);
1370 snprintf(buf1, sizeof(buf1), "%s.%s", target->command->parent->name, target->command->name);
1371 reply("MCMSG_COMMAND_BINDING", target->name, buf1);
1373 for (ii = buf1_used = buf2_used = 0; flags[ii].name; ++ii) {
1374 if (target->flags & flags[ii].flag) {
1376 buf1[buf1_used++] = ',';
1377 len = strlen(flags[ii].name);
1378 memcpy(buf1 + buf1_used, flags[ii].name, len);
1380 } else if (target->effective_flags & flags[ii].flag) {
1382 buf2[buf2_used++] = ',';
1383 len = strlen(flags[ii].name);
1384 memcpy(buf2 + buf2_used, flags[ii].name, len);
1389 buf1[buf1_used] = '\0';
1391 strcpy(buf1, user_find_message(user, "MSG_NONE"));
1393 buf2[buf2_used] = '\0';
1395 strcpy(buf2, user_find_message(user, "MSG_NONE"));
1396 reply("MCMSG_COMMAND_FLAGS", buf1, buf2);
1397 for (ii = buf1_used = buf2_used = 0; handle_flags[ii]; ++ii) {
1398 if (target->req_account_flags & (1 << ii))
1399 buf1[buf1_used++] = handle_flags[ii];
1400 else if (target->deny_account_flags & (1 << ii))
1401 buf2[buf2_used++] = handle_flags[ii];
1403 buf1[buf1_used] = buf2[buf2_used] = '\0';
1404 reply("MCMSG_COMMAND_ACCOUNT_FLAGS", buf1, buf2);
1405 reply("MCMSG_COMMAND_ACCESS_LEVEL", target->min_channel_access, target->min_opserv_level);
1406 reply("MCMSG_COMMAND_USES", target->name, target->uses);
1409 static MODCMD_FUNC(cmd_modcmd) {
1410 struct svccmd *svccmd;
1411 unsigned int arg, changed;
1412 char cmdname[MAXLEN];
1415 arg = collapse_cmdname(argv+1, argc-1, cmdname) + 1;
1417 reply("MSG_MISSING_PARAMS", cmd->name);
1420 if (!(svccmd = svccmd_resolve_name(cmd, cmdname))) {
1421 reply("MCMSG_UNKNOWN_COMMAND_2", cmdname, cmd->parent->bot->nick);
1424 for (changed = 0; arg+1 < argc; arg += 2) {
1425 if (svccmd_configure(svccmd, user, cmd->parent->bot, argv[arg], argv[arg+1])) {
1426 reply("MCMSG_COMMAND_MODIFIED", argv[arg], svccmd->name);
1431 modcmd_set_effective_flags(svccmd);
1432 modcmd_describe_command(user, cmd, svccmd);
1436 static MODCMD_FUNC(cmd_god) {
1440 if (enabled_string(argv[1])) {
1441 if (HANDLE_FLAGGED(user->handle_info, HELPING)) {
1442 reply("MCMSG_ALREADY_HELPING");
1446 } else if (disabled_string(argv[1])) {
1447 if (!HANDLE_FLAGGED(user->handle_info, HELPING)) {
1448 reply("MCMSG_ALREADY_NOT_HELPING");
1453 reply("MSG_INVALID_BINARY", argv[1]);
1457 helping = !IsHelping(user);
1461 HANDLE_SET_FLAG(user->handle_info, HELPING);
1462 reply("MCMSG_NOW_HELPING");
1464 HANDLE_CLEAR_FLAG(user->handle_info, HELPING);
1465 reply("MCMSG_NOW_NOT_HELPING");
1471 static MODCMD_FUNC(cmd_joiner) {
1472 char cmdname[MAXLEN];
1475 int len = sprintf(cmdname, "%s ", cmd->name);
1477 struct string_buffer sbuf;
1479 string_buffer_init(&sbuf);
1480 for (it = dict_first(cmd->parent->commands); it; it = iter_next(it)) {
1481 if (!ircncasecmp(iter_key(it), cmdname, len)) {
1482 if (sbuf.used) string_buffer_append_string(&sbuf, ", ");
1483 string_buffer_append_string(&sbuf, iter_key(it));
1486 if (!sbuf.used) string_buffer_append(&sbuf, 0);
1487 reply("MCMSG_JOINER_CHOICES", cmd->name, sbuf.list);
1488 string_buffer_clean(&sbuf);
1491 sprintf(cmdname, "%s %s", cmd->name, argv[1]);
1493 svccmd_invoke_argv(user, cmd->parent, channel, argc-1, argv+1, 0);
1494 return 0; /* never try to log this; the recursive one logs it */
1497 static MODCMD_FUNC(cmd_stats_modules) {
1498 struct helpfile_table tbl;
1502 struct modcmd *modcmd;
1505 tbl.length = dict_size(modules) + 1;
1507 tbl.flags = TABLE_PAD_LEFT;
1508 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1509 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1510 tbl.contents[0][0] = "Module";
1511 tbl.contents[0][1] = "Commands";
1512 tbl.contents[0][2] = "Helpfile";
1513 for (ii=1, it=dict_first(modules); it; it=iter_next(it), ii++) {
1514 mod = iter_data(it);
1515 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1516 tbl.contents[ii][0] = mod->name;
1517 tbl.contents[ii][1] = strtab(dict_size(mod->commands));
1518 tbl.contents[ii][2] = mod->helpfile_name ? mod->helpfile_name : "(none)";
1520 } else if (!(mod = dict_find(modules, argv[1], NULL))) {
1521 reply("MCMSG_UNKNOWN_MODULE", argv[1]);
1524 reply("MCMSG_MODULE_INFO", mod->name);
1525 tbl.length = dict_size(mod->commands) + 1;
1527 tbl.flags = TABLE_PAD_LEFT;
1528 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1529 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1530 tbl.contents[0][0] = "Command";
1531 tbl.contents[0][1] = "Min. Args";
1532 tbl.contents[0][2] = "Bind Count";
1533 for (ii=1, it=dict_first(mod->commands); it; it=iter_next(it), ii++) {
1534 modcmd = iter_data(it);
1535 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1536 tbl.contents[ii][0] = modcmd->name;
1537 tbl.contents[ii][1] = strtab(modcmd->min_argc);
1538 tbl.contents[ii][2] = strtab(modcmd->bind_count);
1541 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1545 static MODCMD_FUNC(cmd_stats_services) {
1546 struct helpfile_table tbl;
1549 struct service *service;
1550 struct svccmd *svccmd;
1554 tbl.length = dict_size(services) + 1;
1556 tbl.flags = TABLE_PAD_LEFT;
1557 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1558 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1559 tbl.contents[0][0] = "Service";
1560 tbl.contents[0][1] = "Commands";
1561 tbl.contents[0][2] = "Priv'd?";
1562 tbl.contents[0][3] = "Trigger";
1563 extra = calloc(2, tbl.length);
1564 for (ii=1, it=dict_first(services); it; it=iter_next(it), ii++) {
1565 service = iter_data(it);
1566 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1567 tbl.contents[ii][0] = service->bot->nick;
1568 tbl.contents[ii][1] = strtab(dict_size(service->commands));
1569 tbl.contents[ii][2] = service->privileged ? "yes" : "no";
1570 extra[ii*2] = service->trigger;
1571 tbl.contents[ii][3] = extra+ii*2;
1573 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1576 } else if (!(service = dict_find(services, argv[1], NULL))) {
1577 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1580 tbl.length = dict_size(service->commands) + 1;
1582 tbl.flags = TABLE_PAD_LEFT | TABLE_NO_FREE;
1583 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1584 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1585 tbl.contents[0][0] = "Command";
1586 tbl.contents[0][1] = "Module";
1587 tbl.contents[0][2] = "ModCmd";
1588 tbl.contents[0][3] = "Alias?";
1589 tbl.contents[0][4] = strdup("Uses");
1590 for (ii=1, it=dict_first(service->commands); it; it=iter_next(it), ii++) {
1591 svccmd = iter_data(it);
1592 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1593 tbl.contents[ii][0] = svccmd->name;
1594 tbl.contents[ii][1] = svccmd->command->parent->name;
1595 tbl.contents[ii][2] = svccmd->command->name;
1596 tbl.contents[ii][3] = svccmd->alias.used ? "yes" : "no";
1597 tbl.contents[ii][4] = extra = malloc(12);
1598 sprintf(extra, "%u", svccmd->uses);
1600 reply("MCMSG_SERVICE_INFO", service->bot->nick);
1601 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1602 for (ii=0; ii<tbl.length; ii++) {
1603 free((char*)tbl.contents[ii][4]);
1604 free(tbl.contents[ii]);
1611 static MODCMD_FUNC(cmd_showcommands) {
1612 struct svccmd_list commands;
1613 struct helpfile_table tbl;
1614 struct svccmd *svccmd;
1616 unsigned int ii, ignore_flags = 0;
1617 unsigned int max_opserv_level = 1000;
1618 unsigned short max_chanserv_level = 500;
1619 char show_opserv_level = 0, show_channel_access = 0;
1621 /* Check to see what the max access they want to see is. */
1622 for (ii=1; ii<argc; ++ii) {
1623 if (isdigit(argv[ii][0]))
1624 max_opserv_level = atoi(argv[ii]);
1626 max_chanserv_level = user_level_from_name(argv[ii], UL_OWNER);
1629 /* Find the matching commands. */
1630 svccmd_list_init(&commands);
1631 if (cmd->parent->privileged)
1632 ignore_flags = MODCMD_REQUIRE_OPER;
1633 for (it = dict_first(cmd->parent->commands); it; it = iter_next(it)) {
1634 svccmd = iter_data(it);
1635 if (strchr(svccmd->name, ' '))
1637 if (!svccmd_can_invoke(user, svccmd->parent->bot, svccmd, channel, SVCCMD_QUALIFIED))
1639 if (svccmd->min_opserv_level > max_opserv_level)
1641 if (svccmd->min_channel_access > max_chanserv_level)
1643 if (svccmd->min_opserv_level > 0)
1644 show_opserv_level = 1;
1645 if (svccmd->min_channel_access > 0)
1646 show_channel_access = 1;
1647 if (svccmd->effective_flags
1648 & (MODCMD_REQUIRE_STAFF|MODCMD_REQUIRE_HELPING)
1650 show_channel_access = 1;
1652 svccmd_list_append(&commands, svccmd);
1655 /* Build the table. */
1656 tbl.length = commands.used + 1;
1657 tbl.width = 1 + show_opserv_level + show_channel_access;
1658 tbl.flags = TABLE_REPEAT_ROWS;
1659 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1660 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1661 tbl.contents[0][ii = 0] = "Command";
1662 if (show_opserv_level)
1663 tbl.contents[0][++ii] = "OpServ Level";
1664 if (show_channel_access)
1665 tbl.contents[0][++ii] = "ChanServ Access";
1666 for (ii=0; ii<commands.used; ++ii) {
1667 svccmd = commands.list[ii];
1668 tbl.contents[ii+1] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1669 tbl.contents[ii+1][0] = svccmd->name;
1670 if (show_opserv_level)
1671 tbl.contents[ii+1][1] = strtab(svccmd->min_opserv_level);
1672 if (show_channel_access) {
1674 int flags = svccmd->effective_flags;
1675 if (flags & MODCMD_REQUIRE_HELPING)
1677 else if (flags & MODCMD_REQUIRE_STAFF) {
1678 if (flags & MODCMD_REQUIRE_OPER)
1680 else if (flags & MODCMD_REQUIRE_NETWORK_HELPER)
1681 access = "net.helper";
1685 access = strtab(svccmd->min_channel_access);
1686 tbl.contents[ii+1][1+show_opserv_level] = access;
1689 svccmd_list_clean(&commands);
1690 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1694 static MODCMD_FUNC(cmd_helpfiles) {
1695 struct service *service;
1698 if (!(service = dict_find(services, argv[1], NULL))) {
1699 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1704 for (ii=0; ii<service->modules.used; ++ii)
1705 reply("MCMSG_HELPFILE_SEQUENCE", ii+1, service->modules.list[ii]->name);
1709 service->modules.used = 0;
1710 for (ii=0; ii<argc-2; ii++) {
1711 struct module *module = dict_find(modules, argv[ii+2], NULL);
1713 reply("MCMSG_UNKNOWN_MODULE", argv[ii+2]);
1716 module_list_append(&service->modules, module);
1718 reply("MCMSG_HELPFILE_SEQUENCE_SET", service->bot->nick);
1722 static MODCMD_FUNC(cmd_service_add) {
1723 const char *nick, *hostname, *desc;
1724 struct userNode *bot;
1727 if (!is_valid_nick(nick)) {
1728 reply("MCMSG_BAD_SERVICE_NICK", nick);
1732 desc = unsplit_string(argv+3, argc-3, NULL);
1733 bot = GetUserH(nick);
1734 if (bot && IsService(bot)) {
1735 reply("MCMSG_ALREADY_SERVICE", bot->nick);
1738 bot = AddLocalUser(nick, nick, hostname, desc, NULL);
1739 service_register(bot);
1740 reply("MCMSG_NEW_SERVICE", bot->nick);
1744 static MODCMD_FUNC(cmd_service_rename) {
1745 struct service *service;
1747 if (!(service = service_find(argv[1]))) {
1748 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1751 NickChange(service->bot, argv[2], 0);
1752 reply("MCMSG_SERVICE_RENAMED", service->bot->nick);
1756 static MODCMD_FUNC(cmd_service_trigger) {
1757 struct userNode *bogon;
1758 struct service *service;
1760 if (!(service = service_find(argv[1]))) {
1761 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1765 if (service->trigger)
1766 reply("MCMSG_CURRENT_TRIGGER", service->bot->nick, service->trigger);
1768 reply("MCMSG_NO_TRIGGER", service->bot->nick);
1771 if (service->trigger)
1772 reg_chanmsg_func(service->trigger, NULL, NULL);
1773 if (!irccasecmp(argv[2], "none") || !irccasecmp(argv[2], "remove")) {
1774 service->trigger = 0;
1775 reply("MCMSG_REMOVED_TRIGGER", service->bot->nick);
1776 } else if ((bogon = get_chanmsg_bot(argv[2][0]))) {
1777 reply("MCMSG_DUPLICATE_TRIGGER", bogon->nick, argv[2][0]);
1780 service->trigger = argv[2][0];
1781 reg_chanmsg_func(service->trigger, service->bot, modcmd_chanmsg);
1782 reply("MCMSG_NEW_TRIGGER", service->bot->nick, service->trigger);
1787 static MODCMD_FUNC(cmd_service_privileged) {
1788 struct service *service;
1791 if (!(service = service_find(argv[1]))) {
1792 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1796 service->privileged = true_string(argv[2]) || enabled_string(argv[2]);
1797 newval = user_find_message(user, service->privileged ? "MSG_ON" : "MSG_OFF");
1798 reply("MCMSG_SERVICE_PRIVILEGED", service->bot->nick, newval);
1802 static MODCMD_FUNC(cmd_service_remove) {
1803 char *name, *reason;
1804 struct service *service;
1808 reason = unsplit_string(argv+2, argc-2, NULL);
1810 reason = "Removing bot";
1811 if (!(service = service_find(name))) {
1812 reply("MCMSG_UNKNOWN_SERVICE", name);
1815 DelUser(service->bot, NULL, 1, reason);
1816 reply("MCMSG_SERVICE_REMOVED", name);
1817 dict_remove(services, name);
1821 static MODCMD_FUNC(cmd_dump_messages) {
1822 const char *fname = "strings.db";
1823 struct saxdb_context *ctx;
1828 if (!(pf = fopen(fname, "w"))) {
1829 reply("MCMSG_FILE_NOT_OPENED", fname);
1832 if (!(ctx = saxdb_open_context(pf))) {
1833 reply("MSG_INTERNAL_FAILURE");
1836 if ((res = setjmp(ctx->jbuf)) != 0) {
1837 ctx->complex.used = 0; /* to avoid false assert()s in close */
1838 saxdb_close_context(ctx);
1840 reply("MCMSG_MESSAGE_DUMP_FAILED", strerror(res));
1843 for (it = dict_first(lang_C->messages); it; it = iter_next(it))
1844 saxdb_write_string(ctx, iter_key(it), iter_data(it));
1845 saxdb_close_context(ctx);
1847 reply("MCMSG_MESSAGES_DUMPED", fname);
1852 static MODCMD_FUNC(cmd_version) {
1853 /* This function provides copyright management information to end
1854 * users of srvx. You should not alter, disable or remove this
1855 * command or its accessibility to normal IRC users, except to add
1856 * copyright information pertaining to changes you make to srvx.
1858 send_message_type(4, user, cmd->parent->bot, "$b"PACKAGE_STRING"$b ("CODENAME"), Built: "__DATE__", "__TIME__". Copyright 2000-2006 srvx Development Team.");
1859 if ((argc > 1) && !irccasecmp(argv[1], "arch"))
1860 send_message_type(4, user, cmd->parent->bot, "%s", GIT_VERSION);
1862 send_message_type(12, user, cmd->parent->bot, "The srvx Development Team includes Paul Chang, Adrian Dewhurst, Miles Peterson, Michael Poole and others.\nThe srvx Development Team can be reached at http://sf.net/projects/srvx/ or in #srvx on irc.gamesurge.net.");
1866 static MODCMD_FUNC(cmd_tell) {
1867 struct userNode *target;
1870 target = GetUserH(argv[1]);
1871 msg = unsplit_string(argv + 2, argc - 2, NULL);
1873 reply("MSG_NOT_TARGET_NAME");
1876 send_message_type(MSG_TYPE_NOXLATE, target, cmd->parent->bot, "%s", msg);
1881 modcmd_nick_change(struct userNode *user, const char *old_nick) {
1882 struct service *svc;
1883 if (!(svc = dict_find(services, old_nick, NULL)))
1885 dict_remove2(services, old_nick, 1);
1886 dict_insert(services, user->nick, svc);
1890 modcmd_cleanup(void) {
1891 dict_delete(services);
1892 dict_delete(modules);
1898 modcmd_saxdb_write_command(struct saxdb_context *ctx, struct svccmd *cmd) {
1900 unsigned int nn, len, pos;
1901 struct svccmd *template = cmd->command->defaults;
1903 saxdb_start_record(ctx, cmd->name, 0);
1904 sprintf(buf, "%s.%s", cmd->command->parent->name, cmd->command->name);
1905 saxdb_write_string(ctx, "command", buf);
1906 if (cmd->alias.used)
1907 saxdb_write_string_list(ctx, "aliased", &cmd->alias);
1908 if (cmd->min_opserv_level != template->min_opserv_level)
1909 saxdb_write_int(ctx, "oper_access", cmd->min_opserv_level);
1910 if (cmd->min_channel_access != template->min_channel_access)
1911 saxdb_write_int(ctx, "channel_access", cmd->min_channel_access);
1912 if (cmd->flags != template->flags) {
1914 for (nn=pos=0; flags[nn].name; ++nn) {
1915 if (cmd->flags & flags[nn].flag) {
1917 len = strlen(flags[nn].name);
1918 memcpy(buf+pos, flags[nn].name, len);
1927 saxdb_write_string(ctx, "flags", buf);
1929 if ((cmd->req_account_flags != template->req_account_flags)
1930 || (cmd->deny_account_flags != template->req_account_flags)) {
1932 if (cmd->req_account_flags) {
1934 for (nn=0; nn<32; nn++)
1935 if (cmd->req_account_flags & (1 << nn))
1936 buf[pos++] = handle_flags[nn];
1938 if (cmd->deny_account_flags) {
1940 for (nn=0; nn<32; nn++)
1941 if (cmd->deny_account_flags & (1 << nn))
1942 buf[pos++] = handle_flags[nn];
1945 saxdb_write_string(ctx, "account_flags", buf);
1947 saxdb_end_record(ctx);
1951 modcmd_saxdb_write(struct saxdb_context *ctx) {
1952 struct string_list slist;
1953 dict_iterator_t it, it2;
1954 struct service *service;
1957 saxdb_start_record(ctx, "bots", 1);
1958 for (it = dict_first(services); it; it = iter_next(it)) {
1960 service = iter_data(it);
1961 saxdb_start_record(ctx, service->bot->nick, 1);
1962 if (service->trigger) {
1963 buff[0] = service->trigger;
1965 saxdb_write_string(ctx, "trigger", buff);
1967 saxdb_write_string(ctx, "description", service->bot->info);
1968 saxdb_write_string(ctx, "hostname", service->bot->hostname);
1969 if (service->privileged)
1970 saxdb_write_string(ctx, "privileged", "1");
1971 saxdb_end_record(ctx);
1973 saxdb_end_record(ctx);
1975 saxdb_start_record(ctx, "services", 1);
1976 for (it = dict_first(services); it; it = iter_next(it)) {
1977 service = iter_data(it);
1978 saxdb_start_record(ctx, service->bot->nick, 1);
1979 for (it2 = dict_first(service->commands); it2; it2 = iter_next(it2))
1980 modcmd_saxdb_write_command(ctx, iter_data(it2));
1981 saxdb_end_record(ctx);
1983 saxdb_end_record(ctx);
1985 saxdb_start_record(ctx, "helpfiles", 1);
1987 for (it = dict_first(services); it; it = iter_next(it)) {
1988 service = iter_data(it);
1990 for (ii = 0; ii < service->modules.used; ++ii)
1991 string_list_append(&slist, service->modules.list[ii]->name);
1992 saxdb_write_string_list(ctx, iter_key(it), &slist);
1996 saxdb_end_record(ctx);
2002 append_entry(const char *key, UNUSED_ARG(void *data), void *extra) {
2003 struct helpfile_expansion *exp = extra;
2004 int row = exp->value.table.length++;
2005 exp->value.table.contents[row] = calloc(1, sizeof(char*));
2006 exp->value.table.contents[row][0] = key;
2010 static struct helpfile_expansion
2011 modcmd_expand(const char *variable) {
2012 struct helpfile_expansion exp;
2013 extern struct userNode *message_source;
2014 struct service *service;
2016 service = dict_find(services, message_source->nick, NULL);
2017 if (!irccasecmp(variable, "index")) {
2018 exp.type = HF_TABLE;
2019 exp.value.table.length = 1;
2020 exp.value.table.width = 1;
2021 exp.value.table.flags = TABLE_REPEAT_ROWS;
2022 exp.value.table.contents = calloc(dict_size(service->commands)+1, sizeof(char**));
2023 exp.value.table.contents[0] = calloc(1, sizeof(char*));
2024 exp.value.table.contents[0][0] = "Commands:";
2025 dict_foreach(service->commands, append_entry, &exp);
2027 } else if (!irccasecmp(variable, "languages")) {
2028 struct string_buffer sbuf;
2030 sbuf.used = sbuf.size = 0;
2032 for (it = dict_first(languages); it; it = iter_next(it)) {
2033 string_buffer_append_string(&sbuf, iter_key(it));
2034 string_buffer_append(&sbuf, ' ');
2036 sbuf.list[--sbuf.used] = 0;
2037 exp.type = HF_STRING;
2038 exp.value.str = sbuf.list;
2041 exp.type = HF_STRING;
2042 exp.value.str = NULL;
2047 modcmd_load_bots(struct dict *db, int default_nick) {
2050 for (it = dict_first(db); it; it = iter_next(it)) {
2051 struct record_data *rd;
2052 struct service *svc;
2053 const char *nick, *desc, *hostname;
2056 if (rd->type != RECDB_OBJECT) {
2057 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'bots/%s' in modcmd db (expected object).", iter_key(it));
2060 nick = database_get_data(rd->d.object, "nick", RECDB_QSTRING);
2063 nick = iter_key(it);
2067 svc = service_find(nick);
2068 desc = database_get_data(rd->d.object, "description", RECDB_QSTRING);
2069 hostname = database_get_data(rd->d.object, "hostname", RECDB_QSTRING);
2072 svc = service_register(AddLocalUser(nick, nick, hostname, desc, NULL));
2074 strcpy(svc->bot->hostname, hostname);
2075 desc = database_get_data(rd->d.object, "trigger", RECDB_QSTRING);
2077 svc->trigger = desc[0];
2078 desc = database_get_data(rd->d.object, "privileged", RECDB_QSTRING);
2079 if (desc && (true_string(desc) || enabled_string(desc)))
2080 svc->privileged = 1;
2086 modcmd_conf_read(void) {
2087 modcmd_load_bots(conf_get_data("services", RECDB_OBJECT), 0);
2092 qsort(flags, ArrayLength(flags)-1, sizeof(flags[0]), flags_qsort);
2093 modules = dict_new();
2094 dict_set_free_data(modules, free_module);
2095 services = dict_new();
2096 dict_set_free_data(services, free_service);
2097 reg_nick_change_func(modcmd_nick_change);
2098 reg_exit_func(modcmd_cleanup);
2099 conf_register_reload(modcmd_conf_read);
2101 modcmd_module = module_register("modcmd", MAIN_LOG, "modcmd.help", modcmd_expand);
2102 bind_command = modcmd_register(modcmd_module, "bind", cmd_bind, 4, MODCMD_KEEP_BOUND, "oper_level", "800", NULL);
2103 help_command = modcmd_register(modcmd_module, "help", cmd_help, 1, 0, "flags", "+nolog", NULL);
2104 modcmd_register(modcmd_module, "command", cmd_command, 2, 0, "flags", "+nolog", NULL);
2105 modcmd_register(modcmd_module, "modcmd", cmd_modcmd, 2, MODCMD_KEEP_BOUND, "template", "bind", NULL);
2106 modcmd_register(modcmd_module, "god", cmd_god, 0, MODCMD_REQUIRE_AUTHED, "flags", "+oper,+networkhelper", NULL);
2107 modcmd_register(modcmd_module, "readhelp", cmd_readhelp, 2, 0, "oper_level", "650", NULL);
2108 modcmd_register(modcmd_module, "timecmd", cmd_timecmd, 2, 0, "oper_level", "1", NULL);
2109 modcmd_register(modcmd_module, "unbind", cmd_unbind, 3, 0, "template", "bind", NULL);
2110 modcmd_register(modcmd_module, "joiner", cmd_joiner, 1, 0, NULL);
2111 modcmd_register(modcmd_module, "stats modules", cmd_stats_modules, 1, 0, "flags", "+oper", NULL);
2112 modcmd_register(modcmd_module, "stats services", cmd_stats_services, 1, 0, "flags", "+oper", NULL);
2113 modcmd_register(modcmd_module, "showcommands", cmd_showcommands, 1, 0, "flags", "+acceptchan", NULL);
2114 modcmd_register(modcmd_module, "helpfiles", cmd_helpfiles, 2, 0, "template", "bind", NULL);
2115 modcmd_register(modcmd_module, "service add", cmd_service_add, 4, 0, "flags", "+oper", NULL);
2116 modcmd_register(modcmd_module, "service rename", cmd_service_rename, 3, 0, "flags", "+oper", NULL);
2117 modcmd_register(modcmd_module, "service trigger", cmd_service_trigger, 2, 0, "flags", "+oper", NULL);
2118 modcmd_register(modcmd_module, "service privileged", cmd_service_privileged, 2, 0, "flags", "+oper", NULL);
2119 modcmd_register(modcmd_module, "service remove", cmd_service_remove, 2, 0, "flags", "+oper", NULL);
2120 modcmd_register(modcmd_module, "dumpmessages", cmd_dump_messages, 1, 0, "oper_level", "1000", NULL);
2121 modcmd_register(modcmd_module, "tell", cmd_tell, 3, 0, "flags", "+oper", NULL);
2122 version_command = modcmd_register(modcmd_module, "version", cmd_version, 1, 0, NULL);
2123 message_register_table(msgtab);
2127 modcmd_db_load_command(struct service *service, const char *cmdname, struct dict *obj) {
2128 struct svccmd *svccmd;
2129 struct module *module;
2130 struct modcmd *modcmd;
2131 struct string_list *slist;
2132 const char *str, *sep;
2135 str = database_get_data(obj, "command", RECDB_QSTRING);
2137 log_module(MAIN_LOG, LOG_ERROR, "Missing command for service %s command %s in modcmd.db", service->bot->nick, cmdname);
2140 sep = strchr(str, '.');
2142 log_module(MAIN_LOG, LOG_ERROR, "Invalid command %s for service %s command %s in modcmd.db", str, service->bot->nick, cmdname);
2145 memcpy(buf, str, sep-str);
2147 if (!(module = module_find(buf))) {
2148 log_module(MAIN_LOG, LOG_ERROR, "Unknown module %s for service %s command %s in modcmd.db", buf, service->bot->nick, cmdname);
2151 if (!(modcmd = dict_find(module->commands, sep+1, NULL))) {
2152 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);
2155 /* Now that we know we have a command to use, fill in the basics. */
2156 svccmd = calloc(1, sizeof(*svccmd));
2157 svccmd_insert(service, strdup(cmdname), svccmd, modcmd);
2158 if ((str = database_get_data(obj, "template", RECDB_QSTRING))) {
2159 add_pending_template(svccmd, str);
2161 svccmd_copy_rules(svccmd, modcmd->defaults);
2163 if ((str = database_get_data(obj, "account_flags", RECDB_QSTRING))) {
2164 svccmd->req_account_flags = svccmd->deny_account_flags = 0;
2165 svccmd_configure(svccmd, NULL, service->bot, "account_flags", str);
2167 if ((str = database_get_data(obj, "flags", RECDB_QSTRING))) {
2169 svccmd_configure(svccmd, NULL, service->bot, "flags", str);
2171 if ((str = database_get_data(obj, "oper_access", RECDB_QSTRING))
2172 || (str = database_get_data(obj, "opserv_level", RECDB_QSTRING))) {
2173 svccmd_configure(svccmd, NULL, service->bot, "oper_access", str);
2175 if ((str = database_get_data(obj, "channel_access", RECDB_QSTRING))
2176 || (str = database_get_data(obj, "chanserv_level", RECDB_QSTRING))) {
2177 svccmd_configure(svccmd, NULL, service->bot, "channel_access", str);
2179 if ((slist = database_get_data(obj, "aliased", RECDB_STRING_LIST))) {
2181 svccmd->alias.used = svccmd->alias.size = slist->used;
2182 svccmd->alias.list = calloc(svccmd->alias.size, sizeof(svccmd->alias.list[0]));
2183 for (nn=0; nn<slist->used; ++nn)
2184 svccmd->alias.list[nn] = strdup(slist->list[nn]);
2186 modcmd_set_effective_flags(svccmd);
2189 static struct svccmd *
2190 service_make_alias(struct service *service, const char *alias, ...) {
2191 char *arg, *argv[MAXNUMPARAMS];
2192 unsigned int nn, argc;
2193 struct svccmd *svccmd, *template;
2196 va_start(args, alias);
2199 arg = va_arg(args, char*);
2205 svccmd = calloc(1, sizeof(*svccmd));
2206 if (!(template = svccmd_resolve_name(svccmd, argv[0]))) {
2207 log_module(MAIN_LOG, LOG_ERROR, "Invalid base command %s for alias %s in service %s", argv[0], alias, service->bot->nick);
2213 svccmd->alias.used = svccmd->alias.size = argc;
2214 svccmd->alias.list = calloc(svccmd->alias.size, sizeof(svccmd->alias.list[0]));
2215 for (nn=0; nn<argc; nn++)
2216 svccmd->alias.list[nn] = strdup(argv[nn]);
2218 svccmd_insert(service, strdup(alias), svccmd, template->command);
2219 svccmd_copy_rules(svccmd, template);
2223 static int saxdb_present;
2226 modcmd_saxdb_read(struct dict *db) {
2228 dict_iterator_t it, it2;
2229 struct record_data *rd, *rd2;
2230 struct service *service;
2232 modcmd_load_bots(database_get_data(db, "bots", RECDB_OBJECT), 1);
2233 db2 = database_get_data(db, "services", RECDB_OBJECT);
2235 log_module(MAIN_LOG, LOG_ERROR, "Missing section 'services' in modcmd db.");
2238 for (it = dict_first(db2); it; it = iter_next(it)) {
2240 if (rd->type != RECDB_OBJECT) {
2241 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'services/%s' in modcmd db (expected object).", iter_key(it));
2244 if (!(service = service_find(iter_key(it)))) {
2245 log_module(MAIN_LOG, LOG_ERROR, "Unknown service '%s' listed in modcmd db.", iter_key(it));
2248 for (it2 = dict_first(rd->d.object); it2; it2 = iter_next(it2)) {
2249 rd2 = iter_data(it2);
2250 if (rd2->type != RECDB_OBJECT) {
2251 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'services/%s/%s' in modcmd db (expected object).", iter_key(it), iter_key(it2));
2254 modcmd_db_load_command(service, iter_key(it2), rd2->d.object);
2257 db2 = database_get_data(db, "helpfiles", RECDB_OBJECT);
2258 for (it = dict_first(db2); it; it = iter_next(it)) {
2259 struct module *module;
2260 struct string_list *slist;
2264 if (rd->type != RECDB_STRING_LIST) {
2265 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'helpfiles/%s' in modcmd db (expected string list).", iter_key(it));
2268 slist = rd->d.slist;
2269 if (!(service = service_find(iter_key(it)))) {
2270 /* We probably whined about the service being missing above. */
2273 service->modules.used = 0;
2274 for (ii=0; ii<slist->used; ++ii) {
2275 if (!(module = dict_find(modules, slist->list[ii], NULL))) {
2276 log_module(MAIN_LOG, LOG_ERROR, "Unknown module '%s' listed in modcmd 'helpfiles/%s'.", slist->list[ii], iter_key(it));
2279 module_list_append(&service->modules, module);
2287 create_default_binds(void) {
2288 /* Which services should import which modules by default? */
2290 const char *svcname;
2291 /* C is lame and requires a fixed size for this array.
2292 * Be sure you NULL-terminate each array and increment the
2293 * size here if you add more default modules to any
2295 const char *modnames[8];
2297 { "ChanServ", { "ChanServ", NULL } },
2298 { "Global", { "Global", NULL } },
2299 { "NickServ", { "NickServ", NULL } },
2300 { "OpServ", { "OpServ", "modcmd", "sendmail", "saxdb", "proxycheck", NULL } },
2303 unsigned int ii, jj;
2304 char buf[128], *nick;
2305 struct service *service;
2306 struct module *module;
2308 for (ii = 0; def_binds[ii].svcname; ++ii) {
2309 sprintf(buf, "services/%s/nick", def_binds[ii].svcname);
2310 if (!(nick = conf_get_data(buf, RECDB_QSTRING)))
2312 if (!(service = service_find(nick)))
2314 if (dict_size(service->commands) > 0)
2317 /* Bind the default modules for this service to it */
2318 for (jj = 0; def_binds[ii].modnames[jj]; ++jj) {
2319 if (!(module = module_find(def_binds[ii].modnames[jj])))
2321 service_bind_module(service, module);
2324 /* Bind the help and version commands to this service */
2325 service_bind_modcmd(service, help_command, help_command->name);
2326 service_bind_modcmd(service, version_command, version_command->name);
2328 /* Now some silly hax.. (aliases that most people want) */
2329 if (!irccasecmp(def_binds[ii].svcname, "ChanServ")) {
2330 service_make_alias(service, "addowner", "*chanserv.adduser", "$1", "owner", NULL);
2331 service_make_alias(service, "addcoowner", "*chanserv.adduser", "$1", "coowner", NULL);
2332 service_make_alias(service, "addmaster", "*chanserv.adduser", "$1", "master", NULL);
2333 service_make_alias(service, "addop", "*chanserv.adduser", "$1", "op", NULL);
2334 service_make_alias(service, "addpeon", "*chanserv.adduser", "$1", "peon", NULL);
2335 service_make_alias(service, "delowner", "*chanserv.deluser", "owner", "$1", NULL);
2336 service_make_alias(service, "delcoowner", "*chanserv.deluser", "coowner", "$1", NULL);
2337 service_make_alias(service, "delmaster", "*chanserv.deluser", "master", "$1", NULL);
2338 service_make_alias(service, "delop", "*chanserv.deluser", "op", "$1", NULL);
2339 service_make_alias(service, "delpeon", "*chanserv.deluser", "peon", "$1", NULL);
2340 service_make_alias(service, "command", "*modcmd.command", NULL);
2341 service_make_alias(service, "god", "*modcmd.god", NULL);
2342 } else if (!irccasecmp(def_binds[ii].svcname, "OpServ")) {
2343 struct svccmd *svccmd;
2344 svccmd = service_make_alias(service, "stats", "*modcmd.joiner", NULL);
2345 svccmd->min_opserv_level = 101;
2346 svccmd = service_make_alias(service, "service", "*modcmd.joiner", NULL);
2347 svccmd->min_opserv_level = 900;
2353 import_aliases_db() {
2355 dict_iterator_t it, it2;
2356 struct record_data *rd, *rd2;
2357 struct service *service;
2358 struct module *module;
2360 if (!(db = parse_database("aliases.db")))
2362 for (it = dict_first(db); it; it = iter_next(it)) {
2363 service = service_find(iter_key(it));
2366 module = module_find(service->bot->nick);
2368 if (rd->type != RECDB_OBJECT)
2370 for (it2 = dict_first(rd->d.object); it2; it2 = iter_next(it2)) {
2371 struct modcmd *command;
2372 rd2 = iter_data(it2);
2373 if (rd2->type != RECDB_QSTRING)
2375 command = dict_find(module->commands, rd2->d.qstring, NULL);
2378 service_bind_modcmd(service, command, iter_key(it2));
2384 modcmd_finalize(void) {
2387 /* Check databases. */
2388 saxdb_register("modcmd", modcmd_saxdb_read, modcmd_saxdb_write);
2389 create_default_binds();
2391 import_aliases_db();
2393 /* Register services for their triggers. */
2394 for (it = dict_first(services); it; it = iter_next(it)) {
2395 struct service *svc = iter_data(it);
2397 reg_chanmsg_func(svc->trigger, svc->bot, modcmd_chanmsg);
2400 /* Resolve command rule-templates. */
2401 while (pending_templates) {
2402 struct pending_template *ptempl = pending_templates;
2403 struct svccmd *svccmd;
2405 pending_templates = ptempl->next;
2406 /* Only overwrite the current template if we have a valid template. */
2407 if (!strcmp(ptempl->base, "*")) {
2409 } else if ((svccmd = svccmd_resolve_name(ptempl->cmd, ptempl->base))) {
2410 svccmd_copy_rules(ptempl->cmd, svccmd);
2412 assert(ptempl->cmd->parent);
2413 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);