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 "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_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;
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 (!cmd->command->func(user, channel, argc, argv, cmd))
742 if (!(flags & MODCMD_NO_LOG)) {
743 enum log_severity slvl;
744 if (perms & ACTION_STAFF)
746 else if (perms & ACTION_OVERRIDE)
750 /* Unsplit argv after running the function to get the benefit
751 * of any mangling/hiding done by the commands. */
752 log_audit(cmd->command->parent->clog, slvl, user, service->bot, channel_name, ((flags & MODCMD_LOG_HOSTMASK) ? AUDIT_HOSTMASK : 0), unsplit_string(argv, argc, NULL));
758 svccmd_send_help(struct userNode *user, struct userNode *bot, struct svccmd *cmd) {
759 char cmdname[MAXLEN];
761 /* Show command name (in bold). */
762 for (nn=0; cmd->name[nn]; nn++)
763 cmdname[nn] = toupper(cmd->name[nn]);
765 send_message_type(4, user, bot, "$b%s$b", cmdname);
766 /* If it's an alias, show what it's an alias for. */
767 if (cmd->alias.used) {
768 char alias_text[MAXLEN];
769 unsplit_string((char**)cmd->alias.list, cmd->alias.used, alias_text);
770 send_message(user, bot, "MCMSG_COMMAND_ALIASES", cmd->name, alias_text);
772 /* Show the help entry for the underlying command. */
773 return send_help(user, bot, cmd->command->parent->helpfile, cmd->command->name);
777 svccmd_send_help_2(struct userNode *user, struct service *service, const char *topic) {
778 struct module *module;
782 if ((cmd = dict_find(service->commands, topic, NULL)))
783 return svccmd_send_help(user, service->bot, cmd);
786 for (ii = 0; ii < service->modules.used; ++ii) {
787 module = service->modules.list[ii];
788 if (!module->helpfile)
790 if (dict_find(module->helpfile->db, topic, NULL))
791 return send_help(user, service->bot, module->helpfile, topic);
793 send_message(user, service->bot, "MSG_TOPIC_UNKNOWN");
798 svccmd_invoke(struct userNode *user, struct service *service, struct chanNode *channel, const char *text, int server_qualified) {
800 char *argv[MAXNUMPARAMS];
801 char tmpline[MAXLEN];
805 if (service->privileged) {
807 send_message(user, service->bot, "MSG_SERVICE_PRIVILEGED", service->bot->nick);
810 if (!user->handle_info) {
811 send_message(user, service->bot, "MSG_AUTHENTICATE");
814 if (HANDLE_FLAGGED(user->handle_info, OPER_SUSPENDED)) {
815 send_message(user, service->bot, "MSG_OPER_SUSPENDED");
819 safestrncpy(tmpline, text, sizeof(tmpline));
820 argc = split_line(tmpline, false, ArrayLength(argv), argv);
821 return argc ? svccmd_invoke_argv(user, service, channel, argc, argv, server_qualified) : 0;
825 modcmd_privmsg(struct userNode *user, struct userNode *bot, const char *text, int server_qualified) {
826 struct service *service;
828 if (!(service = dict_find(services, bot->nick, NULL))) {
829 log_module(MAIN_LOG, LOG_ERROR, "modcmd_privmsg got privmsg for unhandled service %s, unregistering.", bot->nick);
830 reg_privmsg_func(bot, NULL);
834 if (text[0] == '\x01') {
835 char *term, response[MAXLEN];
837 text++; /* Skip leading ^A. */
838 /* Chop off final ^A. */
839 term = strchr(text, '\x01');
843 /* Parse out leading text. */
844 term = strchr(text, ' ');
850 /* No dict lookup since these are so few. */
851 if (!irccasecmp(text, "CLIENTINFO")) {
852 /* Use \001 instead of \x01 because apparently \x01C is
853 * interpreted as ASCII FS (\034, decimal 28, hex 1C).
855 irc_notice_user(bot, user, "\001CLIENTINFO CLIENTINFO PING TIME USERINFO VERSION\x01");
856 } else if (!irccasecmp(text, "PING")) {
858 snprintf(response, sizeof(response), "\x01PING %s\x01", term);
859 irc_notice_user(bot, user, response);
861 irc_notice_user(bot,user, "\x01PING\x01");
863 } else if (!irccasecmp(text, "TIME")) {
865 localtime_r(&now, &tm);
866 strftime(response, sizeof(response), "\x01TIME %a %b %d %H:%M:%S %Y\x01", &tm);
867 irc_notice_user(bot, user, response);
868 } else if (!irccasecmp(text, "USERINFO")) {
869 snprintf(response, sizeof(response), "\x01USERINFO %s\x01", bot->info);
870 irc_notice_user(bot, user, response);
871 } else if (!irccasecmp(text, "VERSION")) {
872 /* This function provides copyright management information
873 * to end users of srvx. You should not alter, disable or
874 * remove this command or its accessibility to normal IRC
875 * users, except to add copyright information pertaining
876 * to changes you make to srvx.
878 snprintf(response, sizeof(response), "\x01VERSION %s (%s) %s\x01", PACKAGE_STRING, CODENAME, ARCH_VERSION);
879 irc_notice_user(bot, user, response);
884 if (service->msg_hook && service->msg_hook(user, bot, text, server_qualified))
886 svccmd_invoke(user, service, NULL, text, server_qualified);
890 modcmd_chanmsg(struct userNode *user, struct chanNode *chan, const char *text, struct userNode *bot) {
891 struct service *service;
892 if (!(service = dict_find(services, bot->nick, NULL))) return;
893 svccmd_invoke(user, service, chan, text, 0);
897 service_register(struct userNode *bot) {
898 struct service *service;
899 if ((service = dict_find(services, bot->nick, NULL)))
901 service = calloc(1, sizeof(*service));
902 module_list_init(&service->modules);
903 service->commands = dict_new();
905 dict_set_free_data(service->commands, free_service_command);
906 dict_insert(services, service->bot->nick, service);
907 reg_privmsg_func(bot, modcmd_privmsg);
912 service_find(const char *name) {
913 return dict_find(services, name, NULL);
917 svccmd_insert(struct service *service, char *name, struct svccmd *svccmd, struct modcmd *modcmd) {
919 svccmd->parent = service;
921 svccmd->command = modcmd;
922 svccmd->command->bind_count++;
923 dict_insert(service->commands, svccmd->name, svccmd);
924 for (ii=0; ii<service->modules.used; ++ii) {
925 if (service->modules.list[ii] == svccmd->command->parent) break;
927 if (ii == service->modules.used) {
928 module_list_append(&service->modules, svccmd->command->parent);
933 service_bind_modcmd(struct service *service, struct modcmd *cmd, const char *name) {
934 struct svccmd *svccmd;
935 if ((svccmd = dict_find(service->commands, name, NULL))) {
936 if (svccmd->command == cmd) return svccmd;
937 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);
940 svccmd = calloc(1, sizeof(*svccmd));
941 svccmd_insert(service, strdup(name), svccmd, cmd);
942 svccmd_copy_rules(svccmd, cmd->defaults);
947 service_bind_module(struct service *service, struct module *module) {
949 struct modcmd *modcmd;
953 for (it = dict_first(module->commands); it; it = iter_next(it)) {
954 modcmd = iter_data(it);
955 if (!((modcmd->flags | modcmd->defaults->flags) & MODCMD_NO_DEFAULT_BIND))
956 if (service_bind_modcmd(service, modcmd, iter_key(it)))
962 /* This MUST return argc if the alias expansion code knows how to deal
963 * with every argument in argv; otherwise, it MUST return the index of
964 * an argument that the expansion code does not know how to deal with.
967 check_alias_args(char *argv[], unsigned int argc) {
970 for (arg=0; arg<argc; ++arg) {
971 if (argv[arg][0] != '$') {
973 } else if (argv[arg][1] == '$') {
975 } else if (isdigit(argv[arg][1])) {
978 strtoul(argv[arg]+1, &end_num, 10);
979 switch (end_num[0]) {
985 else if (isdigit(end_num[1]))
987 /* else fall through to default case */
998 collapse_cmdname(char *argv[], unsigned int argc, char *dest) {
999 unsigned int ii, pos, arg;
1004 for (ii=pos=0, arg=0; argv[arg][ii]; ) {
1005 if (argv[arg][ii] == '\\') {
1006 if (argv[arg][ii+1]) {
1007 /* escaping a real character just puts it in literally */
1008 dest[pos++] = argv[arg][++ii];
1009 } else if ((arg+1) == argc) {
1010 /* we ran to the end of the argument list; abort */
1013 /* escape at end of a word is a space */
1019 /* normal characters don't need escapes */
1020 dest[pos++] = argv[arg][ii++];
1027 static MODCMD_FUNC(cmd_bind) {
1028 struct service *service;
1029 struct svccmd *template, *newcmd;
1030 char *svcname, *dot;
1031 char newname[MAXLEN], cmdname[MAXLEN];
1032 unsigned int arg, diff;
1036 arg = collapse_cmdname(argv+2, argc-2, newname) + 2;
1038 reply("MSG_MISSING_PARAMS", cmd->name);
1041 diff = collapse_cmdname(argv+arg, argc-arg, cmdname);
1043 reply("MSG_MISSING_PARAMS", cmd->name);
1048 if (!(service = service_find(svcname))) {
1049 reply("MCMSG_UNKNOWN_SERVICE", svcname);
1053 if ((newcmd = dict_find(service->commands, newname, NULL))) {
1054 reply("MCMSG_ALREADY_BOUND", service->bot->nick, newname);
1058 if ((dot = strchr(cmdname, '.')) && (dot[1] == '*') && (dot[2] == 0)) {
1060 struct module *module;
1062 module = module_find((cmdname[0] == '*') ? cmdname+1 : cmdname);
1064 reply("MSG_MODULE_UNKNOWN", cmdname);
1067 count = service_bind_module(service, module);
1068 reply("MCMSG_MODULE_BOUND", count, module->name, service->bot->nick);
1071 newcmd = calloc(1, sizeof(*newcmd));
1072 newcmd->name = strdup(newname);
1073 newcmd->parent = service;
1074 if (!(template = svccmd_resolve_name(newcmd, cmdname))) {
1075 reply("MCMSG_UNKNOWN_COMMAND_2", cmdname, service->bot->nick);
1080 if (template->alias.used) {
1081 reply("MCMSG_CANNOT_DOUBLE_ALIAS");
1088 /* a more complicated alias; fix it up */
1092 nn = check_alias_args(argv+arg, argc-arg);
1093 if (nn+arg < argc) {
1094 reply("MCMSG_BAD_ALIAS_ARGUMENT", argv[nn+arg]);
1099 newcmd->alias.used = newcmd->alias.size = argc-arg;
1100 newcmd->alias.list = calloc(newcmd->alias.size, sizeof(newcmd->alias.list[0]));
1101 for (nn=0; nn<newcmd->alias.used; ++nn)
1102 newcmd->alias.list[nn] = strdup(argv[nn+arg]);
1105 svccmd_insert(service, newcmd->name, newcmd, template->command);
1106 svccmd_copy_rules(newcmd, template);
1107 reply("MCMSG_COMMAND_BOUND", newcmd->name, newcmd->parent->bot->nick);
1112 service_recheck_bindings(struct service *service, struct module *module) {
1116 for (it = dict_first(service->commands); it; it = iter_next(it)) {
1117 cmd = iter_data(it);
1118 if (cmd->command->parent == module) return 0;
1120 /* No more bindings, remove it from our list. */
1121 module_list_remove(&service->modules, module);
1125 static svccmd_unbind_func_t *suf_list;
1126 unsigned int suf_size, suf_used;
1129 reg_svccmd_unbind_func(svccmd_unbind_func_t handler) {
1130 if (suf_used == suf_size) {
1133 suf_list = realloc(suf_list, suf_size*sizeof(svccmd_unbind_func_t));
1136 suf_list = malloc(suf_size*sizeof(svccmd_unbind_func_t));
1139 suf_list[suf_used++] = handler;
1142 static MODCMD_FUNC(cmd_unbind) {
1143 struct service *service;
1144 struct userNode *bot;
1145 struct svccmd *bound;
1146 struct module *module;
1147 const char *svcname;
1148 unsigned int arg, ii;
1149 char cmdname[MAXLEN];
1153 arg = collapse_cmdname(argv+2, argc-2, cmdname) + 2;
1155 reply("MSG_MISSING_PARAMS", cmd->name);
1158 if (!(service = service_find(svcname))) {
1159 reply("MCMSG_UNKNOWN_SERVICE", svcname);
1162 if (!(bound = dict_find(service->commands, cmdname, NULL))) {
1163 reply("MCMSG_NO_COMMAND_BOUND", service->bot->nick, cmdname);
1166 if ((bound->command->flags & MODCMD_KEEP_BOUND) && (bound->command->bind_count == 1)) {
1167 reply("MCMSG_UNBIND_PROHIBITED", bound->command->name);
1171 for (ii=0; ii<suf_used; ii++)
1172 suf_list[ii](bound);
1173 /* If this command binding is removing itself, we must take care
1174 * not to dereference it after the dict_remove.
1176 bot = cmd->parent->bot;
1177 module = cmd->command->parent;
1178 dict_remove(service->commands, bound->name);
1179 send_message(user, bot, "MCMSG_COMMAND_UNBOUND", cmdname, service->bot->nick);
1180 if (service_recheck_bindings(service, module))
1181 send_message(user, bot, "MCMSG_HELPFILE_UNBOUND", module->name, module->name);
1185 static MODCMD_FUNC(cmd_readhelp) {
1186 const char *modname;
1187 struct module *module;
1188 struct helpfile *old_helpfile;
1189 struct timeval start, stop;
1193 if (!(module = module_find(modname))) {
1194 reply("MSG_MODULE_UNKNOWN", modname);
1197 if (!module->helpfile_name) {
1198 reply("MCMSG_NO_HELPFILE", module->name);
1201 old_helpfile = module->helpfile;
1202 gettimeofday(&start, NULL);
1203 module->helpfile = open_helpfile(module->helpfile_name, module->expand_help);
1204 if (!module->helpfile) {
1205 module->helpfile = old_helpfile;
1206 reply("MCMSG_HELPFILE_ERROR", module->helpfile_name);
1209 if (old_helpfile) close_helpfile(old_helpfile);
1210 gettimeofday(&stop, NULL);
1211 stop.tv_sec -= start.tv_sec;
1212 stop.tv_usec -= start.tv_usec;
1213 if (stop.tv_usec < 0) {
1215 stop.tv_usec += 1000000;
1217 reply("MCMSG_HELPFILE_READ", module->name, stop.tv_sec, stop.tv_usec/1000);
1221 static MODCMD_FUNC(cmd_help) {
1224 topic = (argc < 2) ? NULL : unsplit_string(argv+1, argc-1, NULL);
1225 return svccmd_send_help_2(user, cmd->parent, topic);
1228 static MODCMD_FUNC(cmd_timecmd) {
1229 struct timeval start, stop;
1230 char cmd_text[MAXLEN];
1232 unsplit_string(argv+1, argc-1, cmd_text);
1233 gettimeofday(&start, NULL);
1234 svccmd_invoke(user, cmd->parent, channel, cmd_text, 0);
1235 gettimeofday(&stop, NULL);
1236 stop.tv_sec -= start.tv_sec;
1237 stop.tv_usec -= start.tv_usec;
1238 if (stop.tv_usec < 0) {
1240 stop.tv_usec += 1000000;
1242 reply("MCMSG_COMMAND_TIME", cmd_text, stop.tv_sec, stop.tv_usec);
1246 static MODCMD_FUNC(cmd_command) {
1247 struct svccmd *svccmd;
1248 const char *cmd_name, *fmt_str;
1249 unsigned int flags, shown_flags, nn, pos;
1253 cmd_name = unsplit_string(argv+1, argc-1, NULL);
1254 if (!(svccmd = svccmd_resolve_name(cmd, cmd_name))) {
1255 reply("MCMSG_UNKNOWN_COMMAND_2", cmd_name, cmd->parent->bot->nick);
1258 pos = snprintf(buf, sizeof(buf), "%s.%s", svccmd->command->parent->name, svccmd->command->name);
1259 if (svccmd->alias.used) {
1261 unsplit_string((char**)svccmd->alias.list+1, svccmd->alias.used-1, buf+pos);
1262 reply("MCMSG_COMMAND_ALIASES", svccmd->name, buf);
1264 reply("MCMSG_COMMAND_BINDING", svccmd->name, buf);
1266 flags = svccmd->effective_flags;
1267 if ((svccmd->parent && svccmd->parent->privileged && !IsOper(user))
1268 || ((flags & MODCMD_REQUIRE_STAFF)
1269 && !IsOper(user) && !IsNetworkHelper(user) && !IsSupportHelper(user))) {
1270 reply("MCMSG_INSPECTION_REFUSED", svccmd->name);
1273 if (flags & MODCMD_DISABLED) {
1274 reply("MSG_COMMAND_DISABLED", svccmd->name);
1278 if (svccmd->min_opserv_level > 0) {
1279 reply("MCMSG_NEED_OPSERV_LEVEL", svccmd->min_opserv_level);
1280 shown_flags |= MODCMD_REQUIRE_OPER | MODCMD_REQUIRE_AUTHED;
1282 if (svccmd->min_channel_access > 0) {
1283 reply("MCMSG_NEED_CHANSERV_LEVEL", svccmd->min_channel_access);
1284 shown_flags |= MODCMD_REQUIRE_CHANUSER | MODCMD_REQUIRE_REGCHAN | MODCMD_REQUIRE_CHANNEL | MODCMD_REQUIRE_AUTHED;
1286 if (svccmd->req_account_flags) {
1287 for (nn=pos=0; nn<32; nn++) {
1288 if (!(svccmd->req_account_flags & (1 << nn))) continue;
1289 buf[pos++] = HANDLE_FLAGS[nn];
1292 reply("MCMSG_NEED_ACCOUNT_FLAGS", buf);
1293 shown_flags |= MODCMD_REQUIRE_AUTHED;
1295 if (!flags && !shown_flags) {
1296 reply("MCMSG_NEED_NOTHING", svccmd->name);
1299 if (flags & ~shown_flags & MODCMD_REQUIRE_HELPING) {
1300 reply("MCMSG_MUST_BE_HELPING");
1301 shown_flags |= MODCMD_REQUIRE_AUTHED | MODCMD_REQUIRE_STAFF;
1303 if (flags & ~shown_flags & MODCMD_REQUIRE_STAFF) {
1304 switch (flags & MODCMD_REQUIRE_STAFF) {
1305 default: case MODCMD_REQUIRE_STAFF:
1306 fmt_str = "MCMSG_NEED_STAFF_ACCESS";
1308 case MODCMD_REQUIRE_OPER:
1309 fmt_str = "MCMSG_NEED_STAFF_OPER";
1311 case MODCMD_REQUIRE_NETWORK_HELPER:
1312 fmt_str = "MCMSG_NEED_STAFF_NETHELPER";
1314 case MODCMD_REQUIRE_OPER|MODCMD_REQUIRE_NETWORK_HELPER:
1315 fmt_str = "MCMSG_NEED_STAFF_NETHELPER_OR_OPER";
1317 case MODCMD_REQUIRE_SUPPORT_HELPER:
1318 fmt_str = "MCMSG_NEED_STAFF_SHELPER";
1320 case MODCMD_REQUIRE_OPER|MODCMD_REQUIRE_SUPPORT_HELPER:
1321 fmt_str = "MCMSG_NEED_STAFF_SHELPER_OR_OPER";
1323 case MODCMD_REQUIRE_SUPPORT_HELPER|MODCMD_REQUIRE_NETWORK_HELPER:
1324 fmt_str = "MCMSG_NEED_STAFF_HELPER";
1328 shown_flags |= MODCMD_REQUIRE_AUTHED | MODCMD_REQUIRE_STAFF;
1330 if (flags & ~shown_flags & MODCMD_REQUIRE_JOINABLE) {
1331 reply("MCMSG_NEED_JOINABLE");
1332 shown_flags |= MODCMD_REQUIRE_CHANUSER;
1334 if (flags & ~shown_flags & MODCMD_REQUIRE_CHANUSER) {
1335 if (flags & ~shown_flags & MODCMD_IGNORE_CSUSPEND)
1336 reply("MCMSG_NEED_CHANUSER_CSUSPENDABLE");
1338 reply("MCMSG_NEED_CHANUSER");
1339 shown_flags |= MODCMD_IGNORE_CSUSPEND | MODCMD_REQUIRE_REGCHAN | MODCMD_REQUIRE_CHANNEL | MODCMD_REQUIRE_AUTHED;
1341 if (flags & ~shown_flags & MODCMD_REQUIRE_REGCHAN) {
1342 reply("MCMSG_NEED_REGCHAN");
1343 shown_flags |= MODCMD_REQUIRE_CHANNEL;
1345 if (flags & ~shown_flags & MODCMD_REQUIRE_CHANNEL)
1346 reply("MCMSG_NEED_CHANNEL");
1347 if (flags & ~shown_flags & MODCMD_REQUIRE_AUTHED)
1348 reply("MCMSG_NEED_AUTHED");
1349 if (flags & ~shown_flags & MODCMD_TOY)
1350 reply("MCMSG_IS_TOY", svccmd->name);
1351 if (flags & ~shown_flags & MODCMD_REQUIRE_QUALIFIED) {
1352 const char *botnick = svccmd->parent ? svccmd->parent->bot->nick : "SomeBot";
1353 reply("MCMSG_MUST_QUALIFY", botnick, svccmd->name, botnick);
1355 reply("MCMSG_END_REQUIREMENTS", svccmd->name);
1360 modcmd_describe_command(struct userNode *user, struct svccmd *cmd, struct svccmd *target) {
1361 char buf1[MAXLEN], buf2[MAXLEN];
1362 unsigned int ii, len, buf1_used, buf2_used;
1364 if (target->alias.used) {
1365 unsplit_string((char**)target->alias.list, target->alias.used, buf1);
1366 reply("MCMSG_COMMAND_ALIASES", target->name, buf1);
1368 snprintf(buf1, sizeof(buf1), "%s.%s", target->command->parent->name, target->command->name);
1369 reply("MCMSG_COMMAND_BINDING", target->name, buf1);
1371 for (ii = buf1_used = buf2_used = 0; flags[ii].name; ++ii) {
1372 if (target->flags & flags[ii].flag) {
1374 buf1[buf1_used++] = ',';
1375 len = strlen(flags[ii].name);
1376 memcpy(buf1 + buf1_used, flags[ii].name, len);
1378 } else if (target->effective_flags & flags[ii].flag) {
1380 buf2[buf2_used++] = ',';
1381 len = strlen(flags[ii].name);
1382 memcpy(buf2 + buf2_used, flags[ii].name, len);
1387 buf1[buf1_used] = '\0';
1389 strcpy(buf1, user_find_message(user, "MSG_NONE"));
1391 buf2[buf2_used] = '\0';
1393 strcpy(buf2, user_find_message(user, "MSG_NONE"));
1394 reply("MCMSG_COMMAND_FLAGS", buf1, buf2);
1395 for (ii = buf1_used = buf2_used = 0; handle_flags[ii]; ++ii) {
1396 if (target->req_account_flags & (1 << ii))
1397 buf1[buf1_used++] = handle_flags[ii];
1398 else if (target->deny_account_flags & (1 << ii))
1399 buf2[buf2_used++] = handle_flags[ii];
1401 buf1[buf1_used] = buf2[buf2_used] = '\0';
1402 reply("MCMSG_COMMAND_ACCOUNT_FLAGS", buf1, buf2);
1403 reply("MCMSG_COMMAND_ACCESS_LEVEL", target->min_channel_access, target->min_opserv_level);
1404 reply("MCMSG_COMMAND_USES", target->name, target->uses);
1407 static MODCMD_FUNC(cmd_modcmd) {
1408 struct svccmd *svccmd;
1409 unsigned int arg, changed;
1410 char cmdname[MAXLEN];
1413 arg = collapse_cmdname(argv+1, argc-1, cmdname) + 1;
1415 reply("MSG_MISSING_PARAMS", cmd->name);
1418 if (!(svccmd = svccmd_resolve_name(cmd, cmdname))) {
1419 reply("MCMSG_UNKNOWN_COMMAND_2", cmdname, cmd->parent->bot->nick);
1422 for (changed = 0; arg+1 < argc; arg += 2) {
1423 if (svccmd_configure(svccmd, user, cmd->parent->bot, argv[arg], argv[arg+1])) {
1424 reply("MCMSG_COMMAND_MODIFIED", argv[arg], svccmd->name);
1429 modcmd_set_effective_flags(svccmd);
1430 modcmd_describe_command(user, cmd, svccmd);
1434 static MODCMD_FUNC(cmd_god) {
1438 if (enabled_string(argv[1])) {
1439 if (HANDLE_FLAGGED(user->handle_info, HELPING)) {
1440 reply("MCMSG_ALREADY_HELPING");
1444 } else if (disabled_string(argv[1])) {
1445 if (!HANDLE_FLAGGED(user->handle_info, HELPING)) {
1446 reply("MCMSG_ALREADY_NOT_HELPING");
1451 reply("MSG_INVALID_BINARY", argv[1]);
1455 helping = !IsHelping(user);
1459 HANDLE_SET_FLAG(user->handle_info, HELPING);
1460 reply("MCMSG_NOW_HELPING");
1462 HANDLE_CLEAR_FLAG(user->handle_info, HELPING);
1463 reply("MCMSG_NOW_NOT_HELPING");
1469 static MODCMD_FUNC(cmd_joiner) {
1470 char cmdname[MAXLEN];
1473 int len = sprintf(cmdname, "%s ", cmd->name);
1475 struct string_buffer sbuf;
1477 string_buffer_init(&sbuf);
1478 for (it = dict_first(cmd->parent->commands); it; it = iter_next(it)) {
1479 if (!ircncasecmp(iter_key(it), cmdname, len)) {
1480 if (sbuf.used) string_buffer_append_string(&sbuf, ", ");
1481 string_buffer_append_string(&sbuf, iter_key(it));
1484 if (!sbuf.used) string_buffer_append(&sbuf, 0);
1485 reply("MCMSG_JOINER_CHOICES", cmd->name, sbuf.list);
1486 string_buffer_clean(&sbuf);
1489 sprintf(cmdname, "%s %s", cmd->name, argv[1]);
1491 svccmd_invoke_argv(user, cmd->parent, channel, argc-1, argv+1, 0);
1492 return 0; /* never try to log this; the recursive one logs it */
1495 static MODCMD_FUNC(cmd_stats_modules) {
1496 struct helpfile_table tbl;
1500 struct modcmd *modcmd;
1503 tbl.length = dict_size(modules) + 1;
1505 tbl.flags = TABLE_PAD_LEFT;
1506 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1507 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1508 tbl.contents[0][0] = "Module";
1509 tbl.contents[0][1] = "Commands";
1510 tbl.contents[0][2] = "Helpfile";
1511 for (ii=1, it=dict_first(modules); it; it=iter_next(it), ii++) {
1512 mod = iter_data(it);
1513 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1514 tbl.contents[ii][0] = mod->name;
1515 tbl.contents[ii][1] = strtab(dict_size(mod->commands));
1516 tbl.contents[ii][2] = mod->helpfile_name ? mod->helpfile_name : "(none)";
1518 } else if (!(mod = dict_find(modules, argv[1], NULL))) {
1519 reply("MCMSG_UNKNOWN_MODULE", argv[1]);
1522 reply("MCMSG_MODULE_INFO", mod->name);
1523 tbl.length = dict_size(mod->commands) + 1;
1525 tbl.flags = TABLE_PAD_LEFT;
1526 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1527 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1528 tbl.contents[0][0] = "Command";
1529 tbl.contents[0][1] = "Min. Args";
1530 tbl.contents[0][2] = "Bind Count";
1531 for (ii=1, it=dict_first(mod->commands); it; it=iter_next(it), ii++) {
1532 modcmd = iter_data(it);
1533 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1534 tbl.contents[ii][0] = modcmd->name;
1535 tbl.contents[ii][1] = strtab(modcmd->min_argc);
1536 tbl.contents[ii][2] = strtab(modcmd->bind_count);
1539 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1543 static MODCMD_FUNC(cmd_stats_services) {
1544 struct helpfile_table tbl;
1547 struct service *service;
1548 struct svccmd *svccmd;
1552 tbl.length = dict_size(services) + 1;
1554 tbl.flags = TABLE_PAD_LEFT;
1555 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1556 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1557 tbl.contents[0][0] = "Service";
1558 tbl.contents[0][1] = "Commands";
1559 tbl.contents[0][2] = "Priv'd?";
1560 tbl.contents[0][3] = "Trigger";
1561 extra = calloc(2, tbl.length);
1562 for (ii=1, it=dict_first(services); it; it=iter_next(it), ii++) {
1563 service = iter_data(it);
1564 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1565 tbl.contents[ii][0] = service->bot->nick;
1566 tbl.contents[ii][1] = strtab(dict_size(service->commands));
1567 tbl.contents[ii][2] = service->privileged ? "yes" : "no";
1568 extra[ii*2] = service->trigger;
1569 tbl.contents[ii][3] = extra+ii*2;
1571 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1574 } else if (!(service = dict_find(services, argv[1], NULL))) {
1575 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1578 tbl.length = dict_size(service->commands) + 1;
1580 tbl.flags = TABLE_PAD_LEFT | TABLE_NO_FREE;
1581 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1582 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1583 tbl.contents[0][0] = "Command";
1584 tbl.contents[0][1] = "Module";
1585 tbl.contents[0][2] = "ModCmd";
1586 tbl.contents[0][3] = "Alias?";
1587 tbl.contents[0][4] = strdup("Uses");
1588 for (ii=1, it=dict_first(service->commands); it; it=iter_next(it), ii++) {
1589 svccmd = iter_data(it);
1590 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1591 tbl.contents[ii][0] = svccmd->name;
1592 tbl.contents[ii][1] = svccmd->command->parent->name;
1593 tbl.contents[ii][2] = svccmd->command->name;
1594 tbl.contents[ii][3] = svccmd->alias.used ? "yes" : "no";
1595 tbl.contents[ii][4] = extra = malloc(12);
1596 sprintf(extra, "%u", svccmd->uses);
1598 reply("MCMSG_SERVICE_INFO", service->bot->nick);
1599 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1600 for (ii=0; ii<tbl.length; ii++) {
1601 free((char*)tbl.contents[ii][4]);
1602 free(tbl.contents[ii]);
1609 static MODCMD_FUNC(cmd_showcommands) {
1610 struct svccmd_list commands;
1611 struct helpfile_table tbl;
1612 struct svccmd *svccmd;
1614 unsigned int ii, ignore_flags = 0;
1615 unsigned int max_opserv_level = 1000;
1616 unsigned short max_chanserv_level = 500;
1617 char show_opserv_level = 0, show_channel_access = 0;
1619 /* Check to see what the max access they want to see is. */
1620 for (ii=1; ii<argc; ++ii) {
1621 if (isdigit(argv[ii][0]))
1622 max_opserv_level = atoi(argv[ii]);
1624 max_chanserv_level = user_level_from_name(argv[ii], UL_OWNER);
1627 /* Find the matching commands. */
1628 svccmd_list_init(&commands);
1629 if (cmd->parent->privileged)
1630 ignore_flags = MODCMD_REQUIRE_OPER;
1631 for (it = dict_first(cmd->parent->commands); it; it = iter_next(it)) {
1632 svccmd = iter_data(it);
1633 if (strchr(svccmd->name, ' '))
1635 if (!svccmd_can_invoke(user, svccmd->parent->bot, svccmd, channel, SVCCMD_QUALIFIED))
1637 if (svccmd->min_opserv_level > max_opserv_level)
1639 if (svccmd->min_channel_access > max_chanserv_level)
1641 if (svccmd->min_opserv_level > 0)
1642 show_opserv_level = 1;
1643 if (svccmd->min_channel_access > 0)
1644 show_channel_access = 1;
1645 if (svccmd->effective_flags
1646 & (MODCMD_REQUIRE_STAFF|MODCMD_REQUIRE_HELPING)
1648 show_channel_access = 1;
1650 svccmd_list_append(&commands, svccmd);
1653 /* Build the table. */
1654 tbl.length = commands.used + 1;
1655 tbl.width = 1 + show_opserv_level + show_channel_access;
1656 tbl.flags = TABLE_REPEAT_ROWS;
1657 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1658 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1659 tbl.contents[0][ii = 0] = "Command";
1660 if (show_opserv_level)
1661 tbl.contents[0][++ii] = "OpServ Level";
1662 if (show_channel_access)
1663 tbl.contents[0][++ii] = "ChanServ Access";
1664 for (ii=0; ii<commands.used; ++ii) {
1665 svccmd = commands.list[ii];
1666 tbl.contents[ii+1] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1667 tbl.contents[ii+1][0] = svccmd->name;
1668 if (show_opserv_level)
1669 tbl.contents[ii+1][1] = strtab(svccmd->min_opserv_level);
1670 if (show_channel_access) {
1672 int flags = svccmd->effective_flags;
1673 if (flags & MODCMD_REQUIRE_HELPING)
1675 else if (flags & MODCMD_REQUIRE_STAFF) {
1676 if (flags & MODCMD_REQUIRE_OPER)
1678 else if (flags & MODCMD_REQUIRE_NETWORK_HELPER)
1679 access = "net.helper";
1683 access = strtab(svccmd->min_channel_access);
1684 tbl.contents[ii+1][1+show_opserv_level] = access;
1687 svccmd_list_clean(&commands);
1688 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1692 static MODCMD_FUNC(cmd_helpfiles) {
1693 struct service *service;
1696 if (!(service = dict_find(services, argv[1], NULL))) {
1697 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1702 for (ii=0; ii<service->modules.used; ++ii)
1703 reply("MCMSG_HELPFILE_SEQUENCE", ii+1, service->modules.list[ii]->name);
1707 service->modules.used = 0;
1708 for (ii=0; ii<argc-2; ii++) {
1709 struct module *module = dict_find(modules, argv[ii+2], NULL);
1711 reply("MCMSG_UNKNOWN_MODULE", argv[ii+2]);
1714 module_list_append(&service->modules, module);
1716 reply("MCMSG_HELPFILE_SEQUENCE_SET", service->bot->nick);
1720 static MODCMD_FUNC(cmd_service_add) {
1721 const char *nick, *hostname, *desc;
1722 struct userNode *bot;
1725 if (!is_valid_nick(nick)) {
1726 reply("MCMSG_BAD_SERVICE_NICK", nick);
1730 desc = unsplit_string(argv+3, argc-3, NULL);
1731 bot = GetUserH(nick);
1732 if (bot && IsService(bot)) {
1733 reply("MCMSG_ALREADY_SERVICE", bot->nick);
1736 bot = AddLocalUser(nick, nick, hostname, desc, NULL);
1737 service_register(bot);
1738 reply("MCMSG_NEW_SERVICE", bot->nick);
1742 static MODCMD_FUNC(cmd_service_rename) {
1743 struct service *service;
1745 if (!(service = service_find(argv[1]))) {
1746 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1749 NickChange(service->bot, argv[2], 0);
1750 reply("MCMSG_SERVICE_RENAMED", service->bot->nick);
1754 static MODCMD_FUNC(cmd_service_trigger) {
1755 struct userNode *bogon;
1756 struct service *service;
1758 if (!(service = service_find(argv[1]))) {
1759 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1763 if (service->trigger)
1764 reply("MCMSG_CURRENT_TRIGGER", service->bot->nick, service->trigger);
1766 reply("MCMSG_NO_TRIGGER", service->bot->nick);
1769 if (service->trigger)
1770 reg_chanmsg_func(service->trigger, NULL, NULL);
1771 if (!irccasecmp(argv[2], "none") || !irccasecmp(argv[2], "remove")) {
1772 service->trigger = 0;
1773 reply("MCMSG_REMOVED_TRIGGER", service->bot->nick);
1774 } else if ((bogon = get_chanmsg_bot(argv[2][0]))) {
1775 reply("MCMSG_DUPLICATE_TRIGGER", bogon->nick, argv[2][0]);
1778 service->trigger = argv[2][0];
1779 reg_chanmsg_func(service->trigger, service->bot, modcmd_chanmsg);
1780 reply("MCMSG_NEW_TRIGGER", service->bot->nick, service->trigger);
1785 static MODCMD_FUNC(cmd_service_privileged) {
1786 struct service *service;
1789 if (!(service = service_find(argv[1]))) {
1790 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1794 service->privileged = true_string(argv[2]) || enabled_string(argv[2]);
1795 newval = user_find_message(user, service->privileged ? "MSG_ON" : "MSG_OFF");
1796 reply("MCMSG_SERVICE_PRIVILEGED", service->bot->nick, newval);
1800 static MODCMD_FUNC(cmd_service_remove) {
1801 char *name, *reason;
1802 struct service *service;
1806 reason = unsplit_string(argv+2, argc-2, NULL);
1808 reason = "Removing bot";
1809 if (!(service = service_find(name))) {
1810 reply("MCMSG_UNKNOWN_SERVICE", name);
1813 DelUser(service->bot, NULL, 1, reason);
1814 reply("MCMSG_SERVICE_REMOVED", name);
1815 dict_remove(services, name);
1819 static MODCMD_FUNC(cmd_dump_messages) {
1820 const char *fname = "strings.db";
1821 struct saxdb_context *ctx;
1826 if (!(pf = fopen(fname, "w"))) {
1827 reply("MCMSG_FILE_NOT_OPENED", fname);
1830 if (!(ctx = saxdb_open_context(pf))) {
1831 reply("MSG_INTERNAL_FAILURE");
1834 if ((res = setjmp(ctx->jbuf)) != 0) {
1835 ctx->complex.used = 0; /* to avoid false assert()s in close */
1836 saxdb_close_context(ctx);
1838 reply("MCMSG_MESSAGE_DUMP_FAILED", strerror(res));
1841 for (it = dict_first(lang_C->messages); it; it = iter_next(it))
1842 saxdb_write_string(ctx, iter_key(it), iter_data(it));
1843 saxdb_close_context(ctx);
1845 reply("MCMSG_MESSAGES_DUMPED", fname);
1850 static MODCMD_FUNC(cmd_version) {
1851 /* This function provides copyright management information to end
1852 * users of srvx. You should not alter, disable or remove this
1853 * command or its accessibility to normal IRC users, except to add
1854 * copyright information pertaining to changes you make to srvx.
1856 send_message_type(4, user, cmd->parent->bot, "$b"PACKAGE_STRING"$b ("CODENAME"), Built: "__DATE__", "__TIME__".\nCopyright 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.");
1857 if ((argc > 1) && !irccasecmp(argv[1], "arch"))
1858 send_message_type(4, user, cmd->parent->bot, "%s", ARCH_VERSION);
1864 modcmd_nick_change(struct userNode *user, const char *old_nick) {
1865 struct service *svc;
1866 if (!(svc = dict_find(services, old_nick, NULL)))
1868 dict_remove2(services, old_nick, 1);
1869 dict_insert(services, user->nick, svc);
1873 modcmd_cleanup(void) {
1874 dict_delete(services);
1875 dict_delete(modules);
1881 modcmd_saxdb_write_command(struct saxdb_context *ctx, struct svccmd *cmd) {
1883 unsigned int nn, len, pos;
1884 struct svccmd *template = cmd->command->defaults;
1886 saxdb_start_record(ctx, cmd->name, 0);
1887 sprintf(buf, "%s.%s", cmd->command->parent->name, cmd->command->name);
1888 saxdb_write_string(ctx, "command", buf);
1889 if (cmd->alias.used)
1890 saxdb_write_string_list(ctx, "aliased", &cmd->alias);
1891 if (cmd->min_opserv_level != template->min_opserv_level)
1892 saxdb_write_int(ctx, "oper_access", cmd->min_opserv_level);
1893 if (cmd->min_channel_access != template->min_channel_access)
1894 saxdb_write_int(ctx, "channel_access", cmd->min_channel_access);
1895 if (cmd->flags != template->flags) {
1897 for (nn=pos=0; flags[nn].name; ++nn) {
1898 if (cmd->flags & flags[nn].flag) {
1900 len = strlen(flags[nn].name);
1901 memcpy(buf+pos, flags[nn].name, len);
1910 saxdb_write_string(ctx, "flags", buf);
1912 if ((cmd->req_account_flags != template->req_account_flags)
1913 || (cmd->deny_account_flags != template->req_account_flags)) {
1915 if (cmd->req_account_flags) {
1917 for (nn=0; nn<32; nn++)
1918 if (cmd->req_account_flags & (1 << nn))
1919 buf[pos++] = handle_flags[nn];
1921 if (cmd->deny_account_flags) {
1923 for (nn=0; nn<32; nn++)
1924 if (cmd->deny_account_flags & (1 << nn))
1925 buf[pos++] = handle_flags[nn];
1928 saxdb_write_string(ctx, "account_flags", buf);
1930 saxdb_end_record(ctx);
1934 modcmd_saxdb_write(struct saxdb_context *ctx) {
1935 struct string_list slist;
1936 dict_iterator_t it, it2;
1937 struct service *service;
1940 saxdb_start_record(ctx, "bots", 1);
1941 for (it = dict_first(services); it; it = iter_next(it)) {
1943 service = iter_data(it);
1944 saxdb_start_record(ctx, service->bot->nick, 1);
1945 if (service->trigger) {
1946 buff[0] = service->trigger;
1948 saxdb_write_string(ctx, "trigger", buff);
1950 saxdb_write_string(ctx, "description", service->bot->info);
1951 saxdb_write_string(ctx, "hostname", service->bot->hostname);
1952 if (service->privileged)
1953 saxdb_write_string(ctx, "privileged", "1");
1954 saxdb_end_record(ctx);
1956 saxdb_end_record(ctx);
1958 saxdb_start_record(ctx, "services", 1);
1959 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 for (it2 = dict_first(service->commands); it2; it2 = iter_next(it2))
1963 modcmd_saxdb_write_command(ctx, iter_data(it2));
1964 saxdb_end_record(ctx);
1966 saxdb_end_record(ctx);
1968 saxdb_start_record(ctx, "helpfiles", 1);
1970 for (it = dict_first(services); it; it = iter_next(it)) {
1971 service = iter_data(it);
1973 for (ii = 0; ii < service->modules.used; ++ii)
1974 string_list_append(&slist, service->modules.list[ii]->name);
1975 saxdb_write_string_list(ctx, iter_key(it), &slist);
1979 saxdb_end_record(ctx);
1985 append_entry(const char *key, UNUSED_ARG(void *data), void *extra) {
1986 struct helpfile_expansion *exp = extra;
1987 int row = exp->value.table.length++;
1988 exp->value.table.contents[row] = calloc(1, sizeof(char*));
1989 exp->value.table.contents[row][0] = key;
1993 static struct helpfile_expansion
1994 modcmd_expand(const char *variable) {
1995 struct helpfile_expansion exp;
1996 extern struct userNode *message_source;
1997 struct service *service;
1999 service = dict_find(services, message_source->nick, NULL);
2000 if (!irccasecmp(variable, "index")) {
2001 exp.type = HF_TABLE;
2002 exp.value.table.length = 1;
2003 exp.value.table.width = 1;
2004 exp.value.table.flags = TABLE_REPEAT_ROWS;
2005 exp.value.table.contents = calloc(dict_size(service->commands)+1, sizeof(char**));
2006 exp.value.table.contents[0] = calloc(1, sizeof(char*));
2007 exp.value.table.contents[0][0] = "Commands:";
2008 dict_foreach(service->commands, append_entry, &exp);
2010 } else if (!irccasecmp(variable, "languages")) {
2011 struct string_buffer sbuf;
2013 sbuf.used = sbuf.size = 0;
2015 for (it = dict_first(languages); it; it = iter_next(it)) {
2016 string_buffer_append_string(&sbuf, iter_key(it));
2017 string_buffer_append(&sbuf, ' ');
2019 sbuf.list[--sbuf.used] = 0;
2020 exp.type = HF_STRING;
2021 exp.value.str = sbuf.list;
2024 exp.type = HF_STRING;
2025 exp.value.str = NULL;
2030 modcmd_load_bots(struct dict *db, int default_nick) {
2033 for (it = dict_first(db); it; it = iter_next(it)) {
2034 struct record_data *rd;
2035 struct service *svc;
2036 const char *nick, *desc, *hostname;
2039 if (rd->type != RECDB_OBJECT) {
2040 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'bots/%s' in modcmd db (expected object).", iter_key(it));
2043 nick = database_get_data(rd->d.object, "nick", RECDB_QSTRING);
2046 nick = iter_key(it);
2050 svc = service_find(nick);
2051 desc = database_get_data(rd->d.object, "description", RECDB_QSTRING);
2052 hostname = database_get_data(rd->d.object, "hostname", RECDB_QSTRING);
2055 svc = service_register(AddLocalUser(nick, nick, hostname, desc, NULL));
2057 strcpy(svc->bot->hostname, hostname);
2058 desc = database_get_data(rd->d.object, "trigger", RECDB_QSTRING);
2060 svc->trigger = desc[0];
2061 desc = database_get_data(rd->d.object, "privileged", RECDB_QSTRING);
2062 if (desc && (true_string(desc) || enabled_string(desc)))
2063 svc->privileged = 1;
2069 modcmd_conf_read(void) {
2070 modcmd_load_bots(conf_get_data("services", RECDB_OBJECT), 0);
2075 qsort(flags, ArrayLength(flags)-1, sizeof(flags[0]), flags_qsort);
2076 modules = dict_new();
2077 dict_set_free_data(modules, free_module);
2078 services = dict_new();
2079 dict_set_free_data(services, free_service);
2080 reg_nick_change_func(modcmd_nick_change);
2081 reg_exit_func(modcmd_cleanup);
2082 conf_register_reload(modcmd_conf_read);
2084 modcmd_module = module_register("modcmd", MAIN_LOG, "modcmd.help", modcmd_expand);
2085 bind_command = modcmd_register(modcmd_module, "bind", cmd_bind, 4, MODCMD_KEEP_BOUND, "oper_level", "800", NULL);
2086 help_command = modcmd_register(modcmd_module, "help", cmd_help, 1, 0, "flags", "+nolog", NULL);
2087 modcmd_register(modcmd_module, "command", cmd_command, 2, 0, "flags", "+nolog", NULL);
2088 modcmd_register(modcmd_module, "modcmd", cmd_modcmd, 2, MODCMD_KEEP_BOUND, "template", "bind", NULL);
2089 modcmd_register(modcmd_module, "god", cmd_god, 0, MODCMD_REQUIRE_AUTHED, "flags", "+oper,+networkhelper", NULL);
2090 modcmd_register(modcmd_module, "readhelp", cmd_readhelp, 2, 0, "oper_level", "650", NULL);
2091 modcmd_register(modcmd_module, "timecmd", cmd_timecmd, 2, 0, "oper_level", "1", NULL);
2092 modcmd_register(modcmd_module, "unbind", cmd_unbind, 3, 0, "template", "bind", NULL);
2093 modcmd_register(modcmd_module, "joiner", cmd_joiner, 1, 0, NULL);
2094 modcmd_register(modcmd_module, "stats modules", cmd_stats_modules, 1, 0, "flags", "+oper", NULL);
2095 modcmd_register(modcmd_module, "stats services", cmd_stats_services, 1, 0, "flags", "+oper", NULL);
2096 modcmd_register(modcmd_module, "showcommands", cmd_showcommands, 1, 0, "flags", "+acceptchan", NULL);
2097 modcmd_register(modcmd_module, "helpfiles", cmd_helpfiles, 2, 0, "template", "bind", NULL);
2098 modcmd_register(modcmd_module, "service add", cmd_service_add, 4, 0, "flags", "+oper", NULL);
2099 modcmd_register(modcmd_module, "service rename", cmd_service_rename, 3, 0, "flags", "+oper", NULL);
2100 modcmd_register(modcmd_module, "service trigger", cmd_service_trigger, 2, 0, "flags", "+oper", NULL);
2101 modcmd_register(modcmd_module, "service privileged", cmd_service_privileged, 2, 0, "flags", "+oper", NULL);
2102 modcmd_register(modcmd_module, "service remove", cmd_service_remove, 2, 0, "flags", "+oper", NULL);
2103 modcmd_register(modcmd_module, "dumpmessages", cmd_dump_messages, 1, 0, "oper_level", "1000", NULL);
2104 version_command = modcmd_register(modcmd_module, "version", cmd_version, 1, 0, NULL);
2105 message_register_table(msgtab);
2109 modcmd_db_load_command(struct service *service, const char *cmdname, struct dict *obj) {
2110 struct svccmd *svccmd;
2111 struct module *module;
2112 struct modcmd *modcmd;
2113 struct string_list *slist;
2114 const char *str, *sep;
2117 str = database_get_data(obj, "command", RECDB_QSTRING);
2119 log_module(MAIN_LOG, LOG_ERROR, "Missing command for service %s command %s in modcmd.db", service->bot->nick, cmdname);
2122 sep = strchr(str, '.');
2124 log_module(MAIN_LOG, LOG_ERROR, "Invalid command %s for service %s command %s in modcmd.db", str, service->bot->nick, cmdname);
2127 memcpy(buf, str, sep-str);
2129 if (!(module = module_find(buf))) {
2130 log_module(MAIN_LOG, LOG_ERROR, "Unknown module %s for service %s command %s in modcmd.db", buf, service->bot->nick, cmdname);
2133 if (!(modcmd = dict_find(module->commands, sep+1, NULL))) {
2134 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);
2137 /* Now that we know we have a command to use, fill in the basics. */
2138 svccmd = calloc(1, sizeof(*svccmd));
2139 svccmd_insert(service, strdup(cmdname), svccmd, modcmd);
2140 if ((str = database_get_data(obj, "template", RECDB_QSTRING))) {
2141 add_pending_template(svccmd, str);
2143 svccmd_copy_rules(svccmd, modcmd->defaults);
2145 if ((str = database_get_data(obj, "account_flags", RECDB_QSTRING))) {
2146 svccmd->req_account_flags = svccmd->deny_account_flags = 0;
2147 svccmd_configure(svccmd, NULL, service->bot, "account_flags", str);
2149 if ((str = database_get_data(obj, "flags", RECDB_QSTRING))) {
2151 svccmd_configure(svccmd, NULL, service->bot, "flags", str);
2153 if ((str = database_get_data(obj, "oper_access", RECDB_QSTRING))
2154 || (str = database_get_data(obj, "opserv_level", RECDB_QSTRING))) {
2155 svccmd_configure(svccmd, NULL, service->bot, "oper_access", str);
2157 if ((str = database_get_data(obj, "channel_access", RECDB_QSTRING))
2158 || (str = database_get_data(obj, "chanserv_level", RECDB_QSTRING))) {
2159 svccmd_configure(svccmd, NULL, service->bot, "channel_access", str);
2161 if ((slist = database_get_data(obj, "aliased", RECDB_STRING_LIST))) {
2163 svccmd->alias.used = svccmd->alias.size = slist->used;
2164 svccmd->alias.list = calloc(svccmd->alias.size, sizeof(svccmd->alias.list[0]));
2165 for (nn=0; nn<slist->used; ++nn)
2166 svccmd->alias.list[nn] = strdup(slist->list[nn]);
2168 modcmd_set_effective_flags(svccmd);
2171 static struct svccmd *
2172 service_make_alias(struct service *service, const char *alias, ...) {
2173 char *arg, *argv[MAXNUMPARAMS];
2174 unsigned int nn, argc;
2175 struct svccmd *svccmd, *template;
2178 va_start(args, alias);
2181 arg = va_arg(args, char*);
2187 svccmd = calloc(1, sizeof(*svccmd));
2188 if (!(template = svccmd_resolve_name(svccmd, argv[0]))) {
2189 log_module(MAIN_LOG, LOG_ERROR, "Invalid base command %s for alias %s in service %s", argv[0], alias, service->bot->nick);
2195 svccmd->alias.used = svccmd->alias.size = argc;
2196 svccmd->alias.list = calloc(svccmd->alias.size, sizeof(svccmd->alias.list[0]));
2197 for (nn=0; nn<argc; nn++)
2198 svccmd->alias.list[nn] = strdup(argv[nn]);
2200 svccmd_insert(service, strdup(alias), svccmd, template->command);
2201 svccmd_copy_rules(svccmd, template);
2205 static int saxdb_present;
2208 modcmd_saxdb_read(struct dict *db) {
2210 dict_iterator_t it, it2;
2211 struct record_data *rd, *rd2;
2212 struct service *service;
2214 modcmd_load_bots(database_get_data(db, "bots", RECDB_OBJECT), 1);
2215 db2 = database_get_data(db, "services", RECDB_OBJECT);
2217 log_module(MAIN_LOG, LOG_ERROR, "Missing section 'services' in modcmd db.");
2220 for (it = dict_first(db2); it; it = iter_next(it)) {
2222 if (rd->type != RECDB_OBJECT) {
2223 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'services/%s' in modcmd db (expected object).", iter_key(it));
2226 if (!(service = service_find(iter_key(it)))) {
2227 log_module(MAIN_LOG, LOG_ERROR, "Unknown service '%s' listed in modcmd db.", iter_key(it));
2230 for (it2 = dict_first(rd->d.object); it2; it2 = iter_next(it2)) {
2231 rd2 = iter_data(it2);
2232 if (rd2->type != RECDB_OBJECT) {
2233 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'services/%s/%s' in modcmd db (expected object).", iter_key(it), iter_key(it2));
2236 modcmd_db_load_command(service, iter_key(it2), rd2->d.object);
2239 db2 = database_get_data(db, "helpfiles", RECDB_OBJECT);
2240 for (it = dict_first(db2); it; it = iter_next(it)) {
2241 struct module *module;
2242 struct string_list *slist;
2246 if (rd->type != RECDB_STRING_LIST) {
2247 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'helpfiles/%s' in modcmd db (expected string list).", iter_key(it));
2250 slist = rd->d.slist;
2251 if (!(service = service_find(iter_key(it)))) {
2252 /* We probably whined about the service being missing above. */
2255 service->modules.used = 0;
2256 for (ii=0; ii<slist->used; ++ii) {
2257 if (!(module = dict_find(modules, slist->list[ii], NULL))) {
2258 log_module(MAIN_LOG, LOG_ERROR, "Unknown module '%s' listed in modcmd 'helpfiles/%s'.", slist->list[ii], iter_key(it));
2261 module_list_append(&service->modules, module);
2269 create_default_binds(void) {
2270 /* Which services should import which modules by default? */
2272 const char *svcname;
2273 /* C is lame and requires a fixed size for this array.
2274 * Be sure you NULL-terminate each array and increment the
2275 * size here if you add more default modules to any
2277 const char *modnames[8];
2279 { "ChanServ", { "ChanServ", NULL } },
2280 { "Global", { "Global", NULL } },
2281 { "NickServ", { "NickServ", NULL } },
2282 { "OpServ", { "OpServ", "modcmd", "sendmail", "saxdb", "proxycheck", NULL } },
2285 unsigned int ii, jj;
2286 char buf[128], *nick;
2287 struct service *service;
2288 struct module *module;
2290 for (ii = 0; def_binds[ii].svcname; ++ii) {
2291 sprintf(buf, "services/%s/nick", def_binds[ii].svcname);
2292 if (!(nick = conf_get_data(buf, RECDB_QSTRING)))
2294 if (!(service = service_find(nick)))
2296 if (dict_size(service->commands) > 0)
2299 /* Bind the default modules for this service to it */
2300 for (jj = 0; def_binds[ii].modnames[jj]; ++jj) {
2301 if (!(module = module_find(def_binds[ii].modnames[jj])))
2303 service_bind_module(service, module);
2306 /* Bind the help and version commands to this service */
2307 service_bind_modcmd(service, help_command, help_command->name);
2308 service_bind_modcmd(service, version_command, version_command->name);
2310 /* Now some silly hax.. (aliases that most people want) */
2311 if (!irccasecmp(def_binds[ii].svcname, "ChanServ")) {
2312 service_make_alias(service, "addowner", "*chanserv.adduser", "$1", "owner", NULL);
2313 service_make_alias(service, "addcoowner", "*chanserv.adduser", "$1", "coowner", NULL);
2314 service_make_alias(service, "addmaster", "*chanserv.adduser", "$1", "master", NULL);
2315 service_make_alias(service, "addop", "*chanserv.adduser", "$1", "op", NULL);
2316 service_make_alias(service, "addpeon", "*chanserv.adduser", "$1", "peon", NULL);
2317 service_make_alias(service, "delowner", "*chanserv.deluser", "owner", "$1", NULL);
2318 service_make_alias(service, "delcoowner", "*chanserv.deluser", "coowner", "$1", NULL);
2319 service_make_alias(service, "delmaster", "*chanserv.deluser", "master", "$1", NULL);
2320 service_make_alias(service, "delop", "*chanserv.deluser", "op", "$1", NULL);
2321 service_make_alias(service, "delpeon", "*chanserv.deluser", "peon", "$1", NULL);
2322 service_make_alias(service, "command", "*modcmd.command", NULL);
2323 service_make_alias(service, "god", "*modcmd.god", NULL);
2324 } else if (!irccasecmp(def_binds[ii].svcname, "OpServ")) {
2325 struct svccmd *svccmd;
2326 svccmd = service_make_alias(service, "stats", "*modcmd.joiner", NULL);
2327 svccmd->min_opserv_level = 101;
2328 svccmd = service_make_alias(service, "service", "*modcmd.joiner", NULL);
2329 svccmd->min_opserv_level = 900;
2335 import_aliases_db() {
2337 dict_iterator_t it, it2;
2338 struct record_data *rd, *rd2;
2339 struct service *service;
2340 struct module *module;
2342 if (!(db = parse_database("aliases.db")))
2344 for (it = dict_first(db); it; it = iter_next(it)) {
2345 service = service_find(iter_key(it));
2348 module = module_find(service->bot->nick);
2350 if (rd->type != RECDB_OBJECT)
2352 for (it2 = dict_first(rd->d.object); it2; it2 = iter_next(it2)) {
2353 struct modcmd *command;
2354 rd2 = iter_data(it2);
2355 if (rd2->type != RECDB_QSTRING)
2357 command = dict_find(module->commands, rd2->d.qstring, NULL);
2360 service_bind_modcmd(service, command, iter_key(it2));
2366 modcmd_finalize(void) {
2369 /* Check databases. */
2370 saxdb_register("modcmd", modcmd_saxdb_read, modcmd_saxdb_write);
2371 create_default_binds();
2373 import_aliases_db();
2375 /* Register services for their triggers. */
2376 for (it = dict_first(services); it; it = iter_next(it)) {
2377 struct service *svc = iter_data(it);
2379 reg_chanmsg_func(svc->trigger, svc->bot, modcmd_chanmsg);
2382 /* Resolve command rule-templates. */
2383 while (pending_templates) {
2384 struct pending_template *ptempl = pending_templates;
2385 struct svccmd *svccmd;
2387 pending_templates = ptempl->next;
2388 /* Only overwrite the current template if we have a valid template. */
2389 if (!strcmp(ptempl->base, "*")) {
2391 } else if ((svccmd = svccmd_resolve_name(ptempl->cmd, ptempl->base))) {
2392 svccmd_copy_rules(ptempl->cmd, svccmd);
2394 assert(ptempl->cmd->parent);
2395 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);