1 /* modcmd.c - Generalized module command support
2 * Copyright 2002-2007 srvx Development Team
4 * This file is part of srvx.
6 * srvx is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with srvx; if not, write to the Free Software Foundation,
18 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
26 struct pending_template {
29 struct pending_template *next;
32 static struct dict *modules;
33 static struct dict *services;
34 static struct pending_template *pending_templates;
35 static struct module *modcmd_module;
36 static struct modcmd *bind_command, *help_command, *version_command;
37 static const struct message_entry msgtab[] = {
38 { "MCMSG_BARE_FLAG", "Flag %.*s must be preceded by a + or -." },
39 { "MCMSG_UNKNOWN_FLAG", "Unknown module flag %.*s." },
40 { "MCMSG_BAD_OPSERV_LEVEL", "Invalid $O access level %s." },
41 { "MCMSG_BAD_CHANSERV_LEVEL", "Invalid $C access level %s." },
42 { "MCMSG_LEVEL_TOO_LOW", "You cannot set the access requirements for %s (your level is too low.)" },
43 { "MCMSG_LEVEL_TOO_HIGH", "You cannot set the access requirements to %s (that is too high)." },
44 { "MCMSG_BAD_OPTION", "Unknown option %s." },
45 { "MCMSG_MUST_QUALIFY", "You $bMUST$b \"/msg %s@$s %s\" (not just /msg %s)." },
46 { "MCMSG_ACCOUNT_SUSPENDED", "Your account has been suspended." },
47 { "MCMSG_CHAN_NOT_REGISTERED", "%s has not been registered with $C." },
48 { "MCMSG_CHAN_SUSPENDED", "$b$C$b access to $b%s$b has been temporarily suspended (%s)." },
49 { "MCMSG_NO_CHANNEL_ACCESS", "You lack access to %s." },
50 { "MCMSG_LOW_CHANNEL_ACCESS", "You lack sufficient access in %s to use this command." },
51 { "MCMSG_REQUIRES_JOINABLE", "You must be in %s (or on its userlist) to use this command." },
52 { "MCMSG_MUST_BE_HELPING", "You must have security override (helping mode) on to use this command." },
53 { "MCMSG_MISSING_COMMAND", "You must specify a command as well as a channel." },
54 { "MCMSG_NO_CHANNEL_BEFORE", "You may not give a channel name before this command." },
55 { "MCMSG_NO_PLUS_CHANNEL", "You may not use a +channel with this command." },
56 { "MCMSG_COMMAND_ALIASES", "%s is an alias for: %s" },
57 { "MCMSG_COMMAND_BINDING", "%s is a binding of: %s" },
58 { "MCMSG_ALIAS_ERROR", "Error in alias expansion for %s; check the error log for details." },
59 { "MCMSG_INTERNAL_COMMAND", "$b%s$b is an internal command and cannot be called directly; please check command bindings." },
60 { "MCMSG_UNKNOWN_MODULE", "Unknown module %s." },
61 { "MCMSG_UNKNOWN_SERVICE", "Unknown service %s." },
62 { "MCMSG_ALREADY_BOUND", "%s already has a command bound as %s." },
63 { "MCMSG_UNKNOWN_COMMAND_2", "Unknown command name %s (relative to service %s)." },
64 { "MCMSG_COMMAND_MODIFIED", "Option $b%s$b for $b%s$b has been set." },
65 { "MCMSG_INSPECTION_REFUSED", "You do not have access to inspect command %s." },
66 { "MCMSG_CANNOT_DOUBLE_ALIAS", "You cannot bind to a complex (argument-carrying) bind." },
67 { "MCMSG_BAD_ALIAS_ARGUMENT", "Invalid alias argument $b%s$b." },
68 { "MCMSG_COMMAND_BOUND", "New command %s bound to %s." },
69 { "MCMSG_MODULE_BOUND", "Bound %d commands from %s to %s." },
70 { "MCMSG_NO_COMMAND_BOUND", "%s has nothing bound as command %s." },
71 { "MCMSG_UNBIND_PROHIBITED", "It wouldn't be very much fun to unbind the last %s command, now would it?" },
72 { "MCMSG_COMMAND_UNBOUND", "Unbound command %s from %s." },
73 { "MCMSG_HELPFILE_UNBOUND", "Since that was the last command from module %s on the service, the helpfile for %s was removed." },
74 { "MCMSG_NO_HELPFILE", "Module %s does not have a help file." },
75 { "MCMSG_HELPFILE_ERROR", "Syntax error reading %s; help contents not changed." },
76 { "MCMSG_HELPFILE_READ", "Read %s help database in "FMT_TIME_T".%03lu seconds." },
77 { "MCMSG_COMMAND_TIME", "Command $b%s$b finished in "FMT_TIME_T".%06lu seconds." },
78 { "MCMSG_NEED_OPSERV_LEVEL", "You must have $O access of at least $b%u$b." },
79 { "MCMSG_NEED_CHANSERV_LEVEL", "You must have $C access of at least $b%u$b in the channel." },
80 { "MCMSG_NEED_ACCOUNT_FLAGS", "You must have account flags $b%s$b." },
81 { "MCMSG_NEED_NOTHING", "Anyone may use the $b%s$b command." },
82 { "MCMSG_NEED_STAFF_ACCESS", "You must be network staff." },
83 { "MCMSG_NEED_STAFF_OPER", "You must be an IRC operator." },
84 { "MCMSG_NEED_STAFF_NETHELPER", "You must be a network helper." },
85 { "MCMSG_NEED_STAFF_NETHELPER_OR_OPER", "You must be a network helper or IRC operator." },
86 { "MCMSG_NEED_STAFF_SHELPER", "You must be a support helper." },
87 { "MCMSG_NEED_STAFF_SHELPER_OR_OPER", "You must be a support helper or IRC operator." },
88 { "MCMSG_NEED_STAFF_HELPER", "You must be a network or support helper." },
89 { "MCMSG_NEED_JOINABLE", "The channel must be open or you must be in the channel or on its userlist." },
90 { "MCMSG_NEED_CHANUSER_CSUSPENDABLE", "You must be on the channel's userlist, and the channel can be suspended." },
91 { "MCMSG_NEED_CHANUSER", "You must be on the channel's userlist." },
92 { "MCMSG_NEED_REGCHAN", "You must specify a channel registered with $C." },
93 { "MCMSG_NEED_CHANNEL", "You must specify a channel that exists." },
94 { "MCMSG_NEED_AUTHED", "You must be authenticated with $N." },
95 { "MCMSG_IS_TOY", "$b%s$b is a toy command." },
96 { "MCMSG_END_REQUIREMENTS", "End of requirements for $b%s$b." },
97 { "MCMSG_ALREADY_HELPING", "You already have security override enabled." },
98 { "MCMSG_ALREADY_NOT_HELPING", "You already have security override disabled." },
99 { "MCMSG_NOW_HELPING", "Security override has been enabled." },
100 { "MCMSG_NOW_NOT_HELPING", "Security override has been disabled." },
101 { "MCMSG_JOINER_CHOICES", "Subcommands of %s: %s" },
102 { "MCMSG_MODULE_INFO", "Commands exported by module $b%s$b:" },
103 { "MCMSG_SERVICE_INFO", "Commands bound to service $b%s$b:" },
104 { "MCMSG_TOYS_DISABLED", "Toys are disabled in %s." },
105 { "MCMSG_PUBLIC_DENY", "Public commands in $b%s$b are restricted." },
106 { "MCMSG_HELPFILE_SEQUENCE", "Help priority %d: %s" },
107 { "MCMSG_HELPFILE_SEQUENCE_SET", "Set helpfile priority sequence for %s." },
108 { "MCMSG_BAD_SERVICE_NICK", "$b%s$b is an invalid nickname." },
109 { "MCMSG_ALREADY_SERVICE", "$b%s$b is already a service." },
110 { "MCMSG_NEW_SERVICE", "Added new service bot $b%s$b." },
111 { "MCMSG_SERVICE_RENAMED", "Service renamed to $b%s$b." },
112 { "MCMSG_NO_TRIGGER", "$b%s$b does not have an in-channel trigger." },
113 { "MCMSG_REMOVED_TRIGGER", "Removed trigger from $b%s$b." },
114 { "MCMSG_DUPLICATE_TRIGGER", "$b%s$b already uses trigger $b%c$b." },
115 { "MCMSG_CURRENT_TRIGGER", "Trigger for $b%s$b is $b%c$b." },
116 { "MCMSG_NEW_TRIGGER", "Changed trigger for $b%s$b to $b%c$b." },
117 { "MCMSG_SERVICE_PRIVILEGED", "Service $b%s$b privileged: $b%s$b." },
118 { "MCMSG_SERVICE_REMOVED", "Service $b%s$b has been deleted." },
119 { "MCMSG_FILE_NOT_OPENED", "Unable to open file $b%s$b for writing." },
120 { "MCMSG_MESSAGES_DUMPED", "Messages written to $b%s$b." },
121 { "MCMSG_MESSAGE_DUMP_FAILED", "Message dump failed: %s." },
122 { "MCMSG_COMMAND_FLAGS", "Command flags are %s (inferred: %s)." },
123 { "MCMSG_COMMAND_ACCOUNT_FLAGS", "Requires account flags +%s, prohibits account flags +%s." },
124 { "MCMSG_COMMAND_ACCESS_LEVEL", "Requires channel access %d and $O access %d." },
125 { "MCMSG_COMMAND_USES", "%s has been used %d times." },
128 struct userData *_GetChannelUser(struct chanData *channel, struct handle_info *handle, int override, int allow_suspended);
130 #define ACTION_ALLOW 1
131 #define ACTION_OVERRIDE 2
132 #define ACTION_NOCHANNEL 4
133 #define ACTION_STAFF 8
135 #define RESOLVE_DEPTH 4
137 static struct modcmd_flag {
141 { "acceptchan", MODCMD_ACCEPT_CHANNEL },
142 { "acceptpluschan", MODCMD_ACCEPT_PCHANNEL },
143 { "authed", MODCMD_REQUIRE_AUTHED },
144 { "channel", MODCMD_REQUIRE_CHANNEL },
145 { "chanuser", MODCMD_REQUIRE_CHANUSER },
146 { "disabled", MODCMD_DISABLED },
147 { "helping", MODCMD_REQUIRE_HELPING },
148 { "ignore_csuspend", MODCMD_IGNORE_CSUSPEND },
149 { "joinable", MODCMD_REQUIRE_JOINABLE },
150 { "keepbound", MODCMD_KEEP_BOUND },
151 { "loghostmask", MODCMD_LOG_HOSTMASK },
152 { "networkhelper", MODCMD_REQUIRE_NETWORK_HELPER },
153 { "never_csuspend", MODCMD_NEVER_CSUSPEND },
154 { "nolog", MODCMD_NO_LOG },
155 { "oper", MODCMD_REQUIRE_OPER },
156 { "qualified", MODCMD_REQUIRE_QUALIFIED },
157 { "regchan", MODCMD_REQUIRE_REGCHAN },
158 { "supporthelper", MODCMD_REQUIRE_SUPPORT_HELPER },
159 { "toy", MODCMD_TOY },
164 flags_bsearch(const void *a, const void *b) {
166 const struct modcmd_flag *flag = b;
167 return ircncasecmp(key, flag->name, strlen(flag->name));
171 flags_qsort(const void *a, const void *b) {
172 const struct modcmd_flag *fa = a, *fb = b;
173 return irccasecmp(fa->name, fb->name);
176 DEFINE_LIST(svccmd_list, struct svccmd*);
177 DEFINE_LIST(module_list, struct module*);
180 free_service_command(void *data) {
181 struct svccmd *svccmd;
185 if (svccmd->alias.used) {
186 for (nn=0; nn<svccmd->alias.used; ++nn)
187 free(svccmd->alias.list[nn]);
188 free(svccmd->alias.list);
195 free_service(void *data) {
196 struct service *service = data;
197 dict_delete(service->commands);
198 module_list_clean(&service->modules);
203 free_module_command(void *data) {
204 struct modcmd *modcmd = data;
205 free_service_command(modcmd->defaults);
211 free_module(void *data) {
212 struct module *module = data;
213 dict_delete(module->commands);
214 close_helpfile(module->helpfile);
220 module_register(const char *name, struct log_type *clog, const char *helpfile_name, expand_func_t expand_help) {
221 struct module *newmod;
223 newmod = calloc(1, sizeof(*newmod));
224 newmod->name = strdup(name);
225 newmod->commands = dict_new();
226 dict_set_free_data(newmod->commands, free_module_command);
228 newmod->helpfile_name = helpfile_name;
229 newmod->expand_help = expand_help;
230 if (newmod->helpfile_name) {
231 newmod->helpfile = open_helpfile(newmod->helpfile_name, newmod->expand_help);
233 dict_insert(modules, newmod->name, newmod);
238 module_find(const char *name) {
239 return dict_find(modules, name, NULL);
243 add_pending_template(struct svccmd *cmd, const char *target) {
244 struct pending_template *pending = calloc(1, sizeof(*pending));
246 pending->base = strdup(target);
247 pending->next = pending_templates;
248 pending_templates = pending;
251 static struct svccmd *
252 svccmd_resolve_name(struct svccmd *origin, const char *name) {
253 char *sep, svcname[MAXLEN];
255 if ((sep = strchr(name, '.'))) {
256 memcpy(svcname, name, sep-name);
257 svcname[sep-name] = 0;
259 if (svcname[0] == '*') {
260 struct module *module = module_find(svcname+1);
261 struct modcmd *cmd = module ? dict_find(module->commands, name, NULL) : NULL;
262 return cmd ? cmd->defaults : NULL;
264 struct service *service = service_find(svcname);
265 return service ? dict_find(service->commands, name, NULL) : NULL;
268 if (origin->parent) {
269 return dict_find(origin->parent->commands, name, NULL);
271 struct modcmd *cmd = dict_find(origin->command->parent->commands, name, NULL);
272 return cmd ? cmd->defaults : NULL;
278 modcmd_set_effective_flags(struct svccmd *cmd) {
279 int flags = cmd->flags | cmd->command->flags;
280 if (cmd->min_opserv_level > 0)
281 flags |= MODCMD_REQUIRE_OPER;
282 if (cmd->min_channel_access > 0)
283 flags |= MODCMD_REQUIRE_CHANUSER;
284 if (flags & MODCMD_REQUIRE_CHANUSER)
285 flags |= MODCMD_REQUIRE_REGCHAN;
286 if (flags & MODCMD_REQUIRE_REGCHAN)
287 flags |= MODCMD_REQUIRE_CHANNEL;
288 if (flags & (MODCMD_REQUIRE_STAFF|MODCMD_REQUIRE_HELPING))
289 flags |= MODCMD_REQUIRE_AUTHED;
290 cmd->effective_flags = flags;
294 svccmd_copy_rules(struct svccmd *dest, struct svccmd *src) {
295 dest->flags |= src->flags;
296 dest->req_account_flags |= src->req_account_flags;
297 dest->deny_account_flags |= src->deny_account_flags;
298 if (src->min_opserv_level > dest->min_opserv_level)
299 dest->min_opserv_level = src->min_opserv_level;
300 if (src->min_channel_access > dest->min_channel_access)
301 dest->min_channel_access = src->min_channel_access;
302 modcmd_set_effective_flags(dest);
306 svccmd_configure(struct svccmd *cmd, struct userNode *user, struct userNode *bot, const char *param, const char *value) {
307 if (!irccasecmp(param, "flags")) {
308 unsigned int set_flags, rem_flags;
309 struct modcmd_flag *flag;
312 for (set_flags = rem_flags = 0; 1; value += end) {
313 end = strcspn(value, ",");
316 else if (*value == '-')
320 send_message(user, bot, "MCMSG_BARE_FLAG", end, value);
322 log_module(MAIN_LOG, LOG_ERROR, "Flag %.*s must be preceded by a + or - (for command %s).", end, value, cmd->name);
326 flag = bsearch(value, flags, ArrayLength(flags)-1, sizeof(flags[0]), flags_bsearch);
329 send_message(user, bot, "MCMSG_UNKNOWN_FLAG", end, value);
331 log_module(MAIN_LOG, LOG_ERROR, "Unknown module flag %.*s (for command %s).", end, value, cmd->name);
335 set_flags |= flag->flag, rem_flags &= ~flag->flag;
337 rem_flags |= flag->flag, set_flags &= ~flag->flag;
341 cmd->flags = (cmd->flags | set_flags) & ~rem_flags;
343 } else if (!irccasecmp(param, "channel_level") || !irccasecmp(param, "channel_access") || !irccasecmp(param, "access")) {
345 if (!irccasecmp(value, "none") || !irccasecmp(value, "0")) {
346 cmd->min_channel_access = 0;
348 } else if ((ul = user_level_from_name(value, UL_OWNER)) > 0) {
349 cmd->min_channel_access = ul;
352 send_message(user, bot, "MCMSG_BAD_CHANSERV_LEVEL", value);
355 log_module(MAIN_LOG, LOG_ERROR, "Invalid ChanServ access level %s (for command %s).", value, cmd->name);
358 } else if (!irccasecmp(param, "oper_level") || !irccasecmp(param, "oper_access") || !irccasecmp(param, "level")) {
359 unsigned int newval = atoi(value);
360 if (!isdigit(value[0]) || (newval > 1000)) {
362 send_message(user, bot, "MCMSG_BAD_OPSERV_LEVEL", value);
364 log_module(MAIN_LOG, LOG_ERROR, "Invalid OpServ access level %s (for command %s).", value, cmd->name);
367 if (user && (!user->handle_info || (cmd->min_opserv_level > user->handle_info->opserv_level))) {
368 send_message(user, bot, "MCMSG_LEVEL_TOO_LOW", cmd->name);
371 if (user && (!user->handle_info || (newval > user->handle_info->opserv_level))) {
372 send_message(user, bot, "MCMSG_LEVEL_TOO_HIGH", value);
375 cmd->min_opserv_level = newval;
377 } else if (!irccasecmp(param, "account_flags")) {
378 return nickserv_modify_handle_flags(user, bot, value, &cmd->req_account_flags, &cmd->deny_account_flags);
381 send_message(user, bot, "MCMSG_BAD_OPTION", param);
383 log_module(MAIN_LOG, LOG_ERROR, "Unknown option %s (for command %s).", param, cmd->name);
389 modcmd_register(struct module *module, const char *name, modcmd_func_t func, unsigned int min_argc, unsigned int flags, ...) {
390 struct modcmd *newcmd;
392 const char *param, *value;
394 newcmd = calloc(1, sizeof(*newcmd));
395 newcmd->name = strdup(name);
396 newcmd->parent = module;
398 newcmd->min_argc = min_argc;
399 newcmd->flags = flags;
400 newcmd->defaults = calloc(1, sizeof(*newcmd->defaults));
401 newcmd->defaults->name = strdup(newcmd->name);
402 newcmd->defaults->command = newcmd;
403 dict_insert(module->commands, newcmd->name, newcmd);
404 if (newcmd->flags & (MODCMD_REQUIRE_REGCHAN|MODCMD_REQUIRE_CHANNEL|MODCMD_REQUIRE_CHANUSER|MODCMD_REQUIRE_JOINABLE)) {
405 newcmd->defaults->flags |= MODCMD_ACCEPT_CHANNEL;
407 if (newcmd->flags & MODCMD_REQUIRE_STAFF) {
408 newcmd->defaults->flags |= MODCMD_REQUIRE_AUTHED;
410 va_start(args, flags);
411 while ((param = va_arg(args, const char*))) {
412 value = va_arg(args, const char*);
413 if (!irccasecmp(param, "template")) {
414 struct svccmd *svccmd = svccmd_resolve_name(newcmd->defaults, value);
416 svccmd_copy_rules(newcmd->defaults, svccmd);
418 log_module(MAIN_LOG, LOG_ERROR, "Unable to resolve template name %s for %s.%s.", value, newcmd->parent->name, newcmd->name);
420 add_pending_template(newcmd->defaults, value);
422 svccmd_configure(newcmd->defaults, NULL, NULL, param, value);
425 modcmd_set_effective_flags(newcmd->defaults);
430 /* This is kind of a lame hack, but it is actually simpler than having
431 * the permission check vary based on the command itself, or having a
432 * more generic rule system.
435 svccmd_can_invoke(struct userNode *user, struct userNode *bot, struct svccmd *cmd, struct chanNode *channel, int options) {
436 unsigned int uData_checked = 0;
437 struct userData *uData = NULL;
438 int rflags = 0, flags = cmd->effective_flags;
440 if (flags & MODCMD_DISABLED) {
441 if (options & SVCCMD_NOISY)
442 send_message(user, bot, "MSG_COMMAND_DISABLED", cmd->name);
445 if ((flags & MODCMD_REQUIRE_QUALIFIED) && !(options & SVCCMD_QUALIFIED)) {
446 if (options & SVCCMD_NOISY)
447 send_message(user, bot, "MCMSG_MUST_QUALIFY", bot->nick, cmd->name, bot->nick);
450 if (flags & MODCMD_REQUIRE_AUTHED) {
451 if (!user->handle_info) {
452 if (options & SVCCMD_NOISY)
453 send_message(user, bot, "MSG_AUTHENTICATE");
456 if (HANDLE_FLAGGED(user->handle_info, SUSPENDED)) {
457 if (options & SVCCMD_NOISY)
458 send_message(user, bot, "MCMSG_ACCOUNT_SUSPENDED");
462 if (channel || (options & SVCCMD_NOISY)) {
463 if ((flags & MODCMD_REQUIRE_CHANNEL) && !channel) {
464 if (options & SVCCMD_NOISY)
465 send_message(user, bot, "MSG_INVALID_CHANNEL");
468 if (flags & MODCMD_REQUIRE_REGCHAN) {
469 if (!channel->channel_info) {
470 if (options & SVCCMD_NOISY)
471 send_message(user, bot, "MCMSG_CHAN_NOT_REGISTERED", channel->name);
473 } else if (IsSuspended(channel->channel_info) && !(flags & MODCMD_IGNORE_CSUSPEND)) {
474 /* allow security-override users to always ignore channel suspensions, but flag it as a staff command */
475 if (!user->handle_info
476 || !HANDLE_FLAGGED(user->handle_info, HELPING)
477 || (flags & MODCMD_NEVER_CSUSPEND)) {
478 if (options & SVCCMD_NOISY)
479 send_message(user, bot, "MCMSG_CHAN_SUSPENDED", channel->name, channel->channel_info->suspended->reason);
482 rflags |= ACTION_STAFF;
485 if (flags & MODCMD_REQUIRE_CHANUSER) {
487 uData = _GetChannelUser(channel->channel_info, user->handle_info, 1, 0), uData_checked = 1;
489 if (options & SVCCMD_NOISY)
490 send_message(user, bot, "MCMSG_NO_CHANNEL_ACCESS", channel->name);
492 } else if (uData->access < cmd->min_channel_access) {
493 if (options & SVCCMD_NOISY)
494 send_message(user, bot, "MCMSG_LOW_CHANNEL_ACCESS", channel->name);
498 if ((flags & MODCMD_REQUIRE_JOINABLE) && channel) {
500 uData = _GetChannelUser(channel->channel_info, user->handle_info, 1, 0), uData_checked = 1;
501 if ((channel->modes & (MODE_INVITEONLY|MODE_KEY|MODE_SECRET))
504 && !GetUserMode(channel, user)) {
505 if (options & SVCCMD_NOISY)
506 send_message(user, bot, "MCMSG_REQUIRES_JOINABLE", channel->name);
510 if ((flags & MODCMD_TOY) && channel) {
511 if (!channel->channel_info)
512 rflags |= ACTION_NOCHANNEL;
513 else switch (channel->channel_info->chOpts[chToys]) {
515 if (options & SVCCMD_NOISY)
516 send_message(user, bot, "MCMSG_TOYS_DISABLED", channel->name);
519 rflags |= ACTION_NOCHANNEL;
526 if (flags & MODCMD_REQUIRE_STAFF) {
527 if (((flags & MODCMD_REQUIRE_OPER) && IsOper(user))
528 || ((flags & MODCMD_REQUIRE_NETWORK_HELPER) && IsNetworkHelper(user))
529 || ((flags & MODCMD_REQUIRE_SUPPORT_HELPER) && IsSupportHelper(user))) {
531 rflags |= ACTION_STAFF;
533 if (options & SVCCMD_NOISY)
534 send_message(user, bot, "MSG_COMMAND_PRIVILEGED", cmd->name);
538 if (flags & MODCMD_REQUIRE_HELPING) {
539 if (!HANDLE_FLAGGED(user->handle_info, HELPING)) {
540 if (options & SVCCMD_NOISY)
541 send_message(user, bot, "MCMSG_MUST_BE_HELPING");
544 rflags |= ACTION_STAFF;
546 if (cmd->min_opserv_level > 0) {
547 if (!oper_has_access(user, bot, cmd->min_opserv_level, !(options & SVCCMD_NOISY)))
549 rflags |= ACTION_STAFF;
551 if (cmd->req_account_flags || cmd->deny_account_flags) {
552 if (!user->handle_info) {
553 if (options & SVCCMD_NOISY)
554 send_message(user, bot, "MSG_AUTHENTICATE");
557 /* Do we want separate or different messages here? */
558 if ((cmd->req_account_flags & ~user->handle_info->flags)
559 || (cmd->deny_account_flags & user->handle_info->flags)) {
560 if (options & SVCCMD_NOISY)
561 send_message(user, bot, "MSG_COMMAND_PRIVILEGED", cmd->name);
566 /* If it's an override, return a special value. */
567 if ((flags & MODCMD_REQUIRE_CHANUSER)
568 && (options & SVCCMD_NOISY)
569 && (!uData || (uData->access > 500))
570 && (!(uData = _GetChannelUser(channel->channel_info, user->handle_info, 0, 0))
571 || uData->access < cmd->min_channel_access)
572 && !(flags & (MODCMD_REQUIRE_STAFF|MODCMD_REQUIRE_HELPING))) {
573 rflags |= ACTION_OVERRIDE;
575 return rflags | ACTION_ALLOW;
579 svccmd_expand_alias(struct svccmd *cmd, unsigned int old_argc, char *old_argv[], char *new_argv[]) {
580 unsigned int ii, new_argc;
583 for (ii=new_argc=0; ii<cmd->alias.used; ++ii) {
584 arg = cmd->alias.list[ii];
586 new_argv[new_argc++] = arg;
590 new_argv[new_argc++] = arg + 1;
591 } else if (isdigit(arg[1])) {
592 unsigned int lbound, ubound, jj;
595 lbound = strtoul(arg+1, &end_num, 10);
596 switch (end_num[0]) {
597 case 0: ubound = lbound; break;
599 if (end_num[1] == 0) {
600 ubound = old_argc - 1;
602 } else if (isdigit(end_num[1])) {
603 ubound = strtoul(end_num+1, NULL, 10);
606 /* else fall through to default case */
608 log_module(MAIN_LOG, LOG_ERROR, "Alias expansion parse error in %s (near %s; %s.%s arg %d).", arg, end_num, cmd->parent->bot->nick, cmd->name, ii);
611 if (ubound >= old_argc)
612 ubound = old_argc - 1;
613 if (lbound < old_argc)
614 for (jj = lbound; jj <= ubound; )
615 new_argv[new_argc++] = old_argv[jj++];
617 log_module(MAIN_LOG, LOG_ERROR, "Alias expansion: I do not know how to handle %s (%s.%s arg %d).", arg, cmd->parent->bot->nick, cmd->name, ii);
625 svccmd_invoke_argv(struct userNode *user, struct service *service, struct chanNode *channel, unsigned int argc, char *argv[], unsigned int server_qualified) {
626 extern struct userNode *chanserv;
628 unsigned int cmd_arg, perms, flags, options, result;
629 char channel_name[CHANNELLEN+1];
631 /* First check pubcmd for the channel. */
632 if (channel && (channel->channel_info) && (service->bot == chanserv)
633 && !check_user_level(channel, user, lvlPubCmd, 1, 0)) {
634 send_message(user, service->bot, "MCMSG_PUBLIC_DENY", channel->name);
638 options = (server_qualified ? SVCCMD_QUALIFIED : 0) | SVCCMD_DEBIT | SVCCMD_NOISY;
639 /* Find the command argument. */
640 cmd_arg = IsChannelName(argv[0]) ? 1 : 0;
641 if (argc < cmd_arg+1) {
642 send_message(user, service->bot, "MCMSG_MISSING_COMMAND");
645 if (!isalnum(*argv[cmd_arg])) {
646 /* Silently ignore stuff that doesn't begin with a letter or number. */
649 cmd = dict_find(service->commands, argv[cmd_arg], NULL);
652 send_message(user, service->bot, "MSG_COMMAND_UNKNOWN", argv[cmd_arg]);
655 flags = cmd->effective_flags;
656 /* If they put a channel name first, check if the command allows
657 * it. If so, swap it with the command name.
661 /* Complain if we're not supposed to accept the channel. */
662 if (!(flags & MODCMD_ACCEPT_CHANNEL)) {
663 send_message(user, service->bot, "MCMSG_NO_CHANNEL_BEFORE");
666 if (!(flags & MODCMD_ACCEPT_PCHANNEL)
667 && (argv[0][0] == '+')) {
668 send_message(user, service->bot, "MCMSG_NO_PLUS_CHANNEL");
676 /* Try to grab a channel handle before alias expansion.
677 * If the command accepts a channel name, and argv[1] is
678 * one, use it as a channel name, and hide it from logging.
681 && (flags & MODCMD_ACCEPT_CHANNEL)
682 && IsChannelName(argv[1])
683 && ((argv[1][0] != '+') || (flags & MODCMD_ACCEPT_PCHANNEL))
684 && (channel = dict_find(channels, argv[1], NULL))) {
690 /* Expand the alias arguments, if there are any. */
691 if (cmd->alias.used) {
692 char *new_argv[MAXNUMPARAMS];
693 argc = svccmd_expand_alias(cmd, argc, argv, new_argv);
695 send_message(service->bot, user, "MCMSG_ALIAS_ERROR", cmd->name);
700 /* Try again to grab a handle to the channel after alias
701 * expansion, overwriting any previous channel. This should,
702 * of course, only be done again if an alias was acually
705 && (flags & MODCMD_ACCEPT_CHANNEL)
706 && IsChannelName(argv[1])
707 && ((argv[1][0] != '+') || (flags & MODCMD_ACCEPT_PCHANNEL))
708 && (channel = dict_find(channels, argv[1], NULL))) {
715 /* Figure out what actions we should do for it.. */
716 if (cmd_arg && (flags & MODCMD_TOY)) {
717 /* Do not let user manually specify a channel. */
720 if (argc < cmd->command->min_argc) {
721 send_message(user, service->bot, "MSG_MISSING_PARAMS", cmd->name);
724 if (!cmd->command->func) {
725 send_message(user, service->bot, "MCMSG_INTERNAL_COMMAND", cmd->name);
728 perms = svccmd_can_invoke(user, service->bot, cmd, channel, options);
732 if (perms & ACTION_NOCHANNEL)
736 safestrncpy(channel_name, channel->name, sizeof(channel_name));
739 if (!(result = cmd->command->func(user, channel, argc, argv, cmd)))
741 if (!(flags & MODCMD_NO_LOG)) {
742 enum log_severity slvl;
743 if (result & CMD_LOG_OVERRIDE)
745 else if ((perms & ACTION_STAFF) || (result & CMD_LOG_STAFF))
747 else if (perms & ACTION_OVERRIDE)
751 /* Unsplit argv after running the function to get the benefit
752 * of any mangling/hiding done by the commands. */
753 log_audit(cmd->command->parent->clog, slvl, user, service->bot, channel_name, ((flags & MODCMD_LOG_HOSTMASK) ? AUDIT_HOSTMASK : 0), unsplit_string(argv, argc, NULL));
759 svccmd_send_help(struct userNode *user, struct userNode *bot, struct svccmd *cmd) {
760 char cmdname[MAXLEN];
762 /* Show command name (in bold). */
763 for (nn=0; cmd->name[nn]; nn++)
764 cmdname[nn] = toupper(cmd->name[nn]);
766 send_message_type(4, user, bot, "$b%s$b", cmdname);
767 /* If it's an alias, show what it's an alias for. */
768 if (cmd->alias.used) {
769 char alias_text[MAXLEN];
770 unsplit_string((char**)cmd->alias.list, cmd->alias.used, alias_text);
771 send_message(user, bot, "MCMSG_COMMAND_ALIASES", cmd->name, alias_text);
773 /* Show the help entry for the underlying command. */
774 return send_help(user, bot, cmd->command->parent->helpfile, cmd->command->name);
778 svccmd_send_help_2(struct userNode *user, struct service *service, const char *topic) {
779 struct module *module;
783 if ((cmd = dict_find(service->commands, topic, NULL)))
784 return svccmd_send_help(user, service->bot, cmd);
787 for (ii = 0; ii < service->modules.used; ++ii) {
788 module = service->modules.list[ii];
789 if (!module->helpfile)
791 if (dict_find(module->helpfile->db, topic, NULL))
792 return send_help(user, service->bot, module->helpfile, topic);
794 send_message(user, service->bot, "MSG_TOPIC_UNKNOWN");
799 svccmd_invoke(struct userNode *user, struct service *service, struct chanNode *channel, const char *text, int server_qualified) {
801 char *argv[MAXNUMPARAMS];
802 char tmpline[MAXLEN];
806 if (service->privileged) {
808 send_message(user, service->bot, "MSG_SERVICE_PRIVILEGED", service->bot->nick);
811 if (!user->handle_info) {
812 send_message(user, service->bot, "MSG_AUTHENTICATE");
815 if (HANDLE_FLAGGED(user->handle_info, OPER_SUSPENDED)) {
816 send_message(user, service->bot, "MSG_OPER_SUSPENDED");
820 safestrncpy(tmpline, text, sizeof(tmpline));
821 argc = split_line(tmpline, false, ArrayLength(argv), argv);
822 return argc ? svccmd_invoke_argv(user, service, channel, argc, argv, server_qualified) : 0;
826 modcmd_privmsg(struct userNode *user, struct userNode *bot, const char *text, int server_qualified) {
827 struct service *service;
829 if (!(service = dict_find(services, bot->nick, NULL))) {
830 log_module(MAIN_LOG, LOG_ERROR, "modcmd_privmsg got privmsg for unhandled service %s, unregistering.", bot->nick);
831 reg_privmsg_func(bot, NULL);
835 if (text[0] == '\x01') {
836 char *term, response[MAXLEN];
838 text++; /* Skip leading ^A. */
839 /* Chop off final ^A. */
840 term = strchr(text, '\x01');
844 /* Parse out leading text. */
845 term = strchr(text, ' ');
851 /* No dict lookup since these are so few. */
852 if (!irccasecmp(text, "CLIENTINFO")) {
853 /* Use \001 instead of \x01 because apparently \x01C is
854 * interpreted as ASCII FS (\034, decimal 28, hex 1C).
856 irc_notice_user(bot, user, "\001CLIENTINFO CLIENTINFO PING TIME USERINFO VERSION\x01");
857 } else if (!irccasecmp(text, "PING")) {
859 snprintf(response, sizeof(response), "\x01PING %s\x01", term);
860 irc_notice_user(bot, user, response);
862 irc_notice_user(bot,user, "\x01PING\x01");
864 } else if (!irccasecmp(text, "TIME")) {
866 localtime_r(&now, &tm);
867 strftime(response, sizeof(response), "\x01TIME %a %b %d %H:%M:%S %Y\x01", &tm);
868 irc_notice_user(bot, user, response);
869 } else if (!irccasecmp(text, "USERINFO")) {
870 snprintf(response, sizeof(response), "\x01USERINFO %s\x01", bot->info);
871 irc_notice_user(bot, user, response);
872 } else if (!irccasecmp(text, "VERSION")) {
873 /* This function provides copyright management information
874 * to end users of srvx. You should not alter, disable or
875 * remove this command or its accessibility to normal IRC
876 * users, except to add copyright information pertaining
877 * to changes you make to srvx.
879 snprintf(response, sizeof(response), "\x01VERSION %s (%s) %s\x01", PACKAGE_STRING, CODENAME, git_version);
880 irc_notice_user(bot, user, response);
885 if (service->msg_hook && service->msg_hook(user, bot, text, server_qualified))
887 svccmd_invoke(user, service, NULL, text, server_qualified);
891 modcmd_chanmsg(struct userNode *user, struct chanNode *chan, const char *text, struct userNode *bot) {
892 struct service *service;
893 if (!(service = dict_find(services, bot->nick, NULL))) return;
894 svccmd_invoke(user, service, chan, text, 0);
898 service_register(struct userNode *bot) {
899 struct service *service;
900 if ((service = dict_find(services, bot->nick, NULL)))
902 service = calloc(1, sizeof(*service));
903 module_list_init(&service->modules);
904 service->commands = dict_new();
906 dict_set_free_data(service->commands, free_service_command);
907 dict_insert(services, service->bot->nick, service);
908 reg_privmsg_func(bot, modcmd_privmsg);
913 service_find(const char *name) {
914 return dict_find(services, name, NULL);
918 svccmd_insert(struct service *service, char *name, struct svccmd *svccmd, struct modcmd *modcmd) {
920 svccmd->parent = service;
922 svccmd->command = modcmd;
923 svccmd->command->bind_count++;
924 dict_insert(service->commands, svccmd->name, svccmd);
925 for (ii=0; ii<service->modules.used; ++ii) {
926 if (service->modules.list[ii] == svccmd->command->parent) break;
928 if (ii == service->modules.used) {
929 module_list_append(&service->modules, svccmd->command->parent);
934 service_bind_modcmd(struct service *service, struct modcmd *cmd, const char *name) {
935 struct svccmd *svccmd;
936 if ((svccmd = dict_find(service->commands, name, NULL))) {
937 if (svccmd->command == cmd) return svccmd;
938 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);
941 svccmd = calloc(1, sizeof(*svccmd));
942 svccmd_insert(service, strdup(name), svccmd, cmd);
943 svccmd_copy_rules(svccmd, cmd->defaults);
948 service_bind_module(struct service *service, struct module *module) {
950 struct modcmd *modcmd;
954 for (it = dict_first(module->commands); it; it = iter_next(it)) {
955 modcmd = iter_data(it);
956 if (!((modcmd->flags | modcmd->defaults->flags) & MODCMD_NO_DEFAULT_BIND))
957 if (service_bind_modcmd(service, modcmd, iter_key(it)))
963 /* This MUST return argc if the alias expansion code knows how to deal
964 * with every argument in argv; otherwise, it MUST return the index of
965 * an argument that the expansion code does not know how to deal with.
968 check_alias_args(char *argv[], unsigned int argc) {
971 for (arg=0; arg<argc; ++arg) {
972 if (argv[arg][0] != '$') {
974 } else if (argv[arg][1] == '$') {
976 } else if (isdigit(argv[arg][1])) {
979 strtoul(argv[arg]+1, &end_num, 10);
980 switch (end_num[0]) {
986 else if (isdigit(end_num[1]))
988 /* else fall through to default case */
999 collapse_cmdname(char *argv[], unsigned int argc, char *dest) {
1000 unsigned int ii, pos, arg;
1005 for (ii=pos=0, arg=0; argv[arg][ii]; ) {
1006 if (argv[arg][ii] == '\\') {
1007 if (argv[arg][ii+1]) {
1008 /* escaping a real character just puts it in literally */
1009 dest[pos++] = argv[arg][++ii];
1010 } else if ((arg+1) == argc) {
1011 /* we ran to the end of the argument list; abort */
1014 /* escape at end of a word is a space */
1020 /* normal characters don't need escapes */
1021 dest[pos++] = argv[arg][ii++];
1028 static MODCMD_FUNC(cmd_bind) {
1029 struct service *service;
1030 struct svccmd *template, *newcmd;
1031 char *svcname, *dot;
1032 char newname[MAXLEN], cmdname[MAXLEN];
1033 unsigned int arg, diff;
1037 arg = collapse_cmdname(argv+2, argc-2, newname) + 2;
1039 reply("MSG_MISSING_PARAMS", cmd->name);
1042 diff = collapse_cmdname(argv+arg, argc-arg, cmdname);
1044 reply("MSG_MISSING_PARAMS", cmd->name);
1049 if (!(service = service_find(svcname))) {
1050 reply("MCMSG_UNKNOWN_SERVICE", svcname);
1054 if ((newcmd = dict_find(service->commands, newname, NULL))) {
1055 reply("MCMSG_ALREADY_BOUND", service->bot->nick, newname);
1059 if ((dot = strchr(cmdname, '.')) && (dot[1] == '*') && (dot[2] == 0)) {
1061 struct module *module;
1063 module = module_find((cmdname[0] == '*') ? cmdname+1 : cmdname);
1065 reply("MSG_MODULE_UNKNOWN", cmdname);
1068 count = service_bind_module(service, module);
1069 reply("MCMSG_MODULE_BOUND", count, module->name, service->bot->nick);
1072 newcmd = calloc(1, sizeof(*newcmd));
1073 newcmd->name = strdup(newname);
1074 newcmd->parent = service;
1075 if (!(template = svccmd_resolve_name(newcmd, cmdname))) {
1076 reply("MCMSG_UNKNOWN_COMMAND_2", cmdname, service->bot->nick);
1081 if (template->alias.used) {
1082 reply("MCMSG_CANNOT_DOUBLE_ALIAS");
1089 /* a more complicated alias; fix it up */
1093 nn = check_alias_args(argv+arg, argc-arg);
1094 if (nn+arg < argc) {
1095 reply("MCMSG_BAD_ALIAS_ARGUMENT", argv[nn+arg]);
1100 newcmd->alias.used = newcmd->alias.size = argc-arg;
1101 newcmd->alias.list = calloc(newcmd->alias.size, sizeof(newcmd->alias.list[0]));
1102 for (nn=0; nn<newcmd->alias.used; ++nn)
1103 newcmd->alias.list[nn] = strdup(argv[nn+arg]);
1106 svccmd_insert(service, newcmd->name, newcmd, template->command);
1107 svccmd_copy_rules(newcmd, template);
1108 reply("MCMSG_COMMAND_BOUND", newcmd->name, newcmd->parent->bot->nick);
1113 service_recheck_bindings(struct service *service, struct module *module) {
1117 for (it = dict_first(service->commands); it; it = iter_next(it)) {
1118 cmd = iter_data(it);
1119 if (cmd->command->parent == module) return 0;
1121 /* No more bindings, remove it from our list. */
1122 module_list_remove(&service->modules, module);
1126 static svccmd_unbind_func_t *suf_list;
1127 unsigned int suf_size, suf_used;
1130 reg_svccmd_unbind_func(svccmd_unbind_func_t handler) {
1131 if (suf_used == suf_size) {
1134 suf_list = realloc(suf_list, suf_size*sizeof(svccmd_unbind_func_t));
1137 suf_list = malloc(suf_size*sizeof(svccmd_unbind_func_t));
1140 suf_list[suf_used++] = handler;
1143 static MODCMD_FUNC(cmd_unbind) {
1144 struct service *service;
1145 struct userNode *bot;
1146 struct svccmd *bound;
1147 struct module *module;
1148 const char *svcname;
1149 unsigned int arg, ii;
1150 char cmdname[MAXLEN];
1154 arg = collapse_cmdname(argv+2, argc-2, cmdname) + 2;
1156 reply("MSG_MISSING_PARAMS", cmd->name);
1159 if (!(service = service_find(svcname))) {
1160 reply("MCMSG_UNKNOWN_SERVICE", svcname);
1163 if (!(bound = dict_find(service->commands, cmdname, NULL))) {
1164 reply("MCMSG_NO_COMMAND_BOUND", service->bot->nick, cmdname);
1167 if ((bound->command->flags & MODCMD_KEEP_BOUND) && (bound->command->bind_count == 1)) {
1168 reply("MCMSG_UNBIND_PROHIBITED", bound->command->name);
1172 for (ii=0; ii<suf_used; ii++)
1173 suf_list[ii](bound);
1174 /* If this command binding is removing itself, we must take care
1175 * not to dereference it after the dict_remove.
1177 bot = cmd->parent->bot;
1178 module = cmd->command->parent;
1179 dict_remove(service->commands, bound->name);
1180 send_message(user, bot, "MCMSG_COMMAND_UNBOUND", cmdname, service->bot->nick);
1181 if (service_recheck_bindings(service, module))
1182 send_message(user, bot, "MCMSG_HELPFILE_UNBOUND", module->name, module->name);
1186 static MODCMD_FUNC(cmd_readhelp) {
1187 const char *modname;
1188 struct module *module;
1189 struct helpfile *old_helpfile;
1190 struct timeval start, stop;
1194 if (!(module = module_find(modname))) {
1195 reply("MSG_MODULE_UNKNOWN", modname);
1198 if (!module->helpfile_name) {
1199 reply("MCMSG_NO_HELPFILE", module->name);
1202 old_helpfile = module->helpfile;
1203 gettimeofday(&start, NULL);
1204 module->helpfile = open_helpfile(module->helpfile_name, module->expand_help);
1205 if (!module->helpfile) {
1206 module->helpfile = old_helpfile;
1207 reply("MCMSG_HELPFILE_ERROR", module->helpfile_name);
1210 if (old_helpfile) close_helpfile(old_helpfile);
1211 gettimeofday(&stop, NULL);
1212 stop.tv_sec -= start.tv_sec;
1213 stop.tv_usec -= start.tv_usec;
1214 if (stop.tv_usec < 0) {
1216 stop.tv_usec += 1000000;
1218 reply("MCMSG_HELPFILE_READ", module->name, stop.tv_sec, stop.tv_usec/1000);
1222 static MODCMD_FUNC(cmd_help) {
1225 topic = (argc < 2) ? NULL : unsplit_string(argv+1, argc-1, NULL);
1226 return svccmd_send_help_2(user, cmd->parent, topic);
1229 static MODCMD_FUNC(cmd_timecmd) {
1230 struct timeval start, stop;
1231 char cmd_text[MAXLEN];
1233 unsplit_string(argv+1, argc-1, cmd_text);
1234 gettimeofday(&start, NULL);
1235 svccmd_invoke(user, cmd->parent, channel, cmd_text, 0);
1236 gettimeofday(&stop, NULL);
1237 stop.tv_sec -= start.tv_sec;
1238 stop.tv_usec -= start.tv_usec;
1239 if (stop.tv_usec < 0) {
1241 stop.tv_usec += 1000000;
1243 reply("MCMSG_COMMAND_TIME", cmd_text, stop.tv_sec, stop.tv_usec);
1247 static MODCMD_FUNC(cmd_command) {
1248 struct svccmd *svccmd;
1249 const char *cmd_name, *fmt_str;
1250 unsigned int flags, shown_flags, nn, pos;
1254 cmd_name = unsplit_string(argv+1, argc-1, NULL);
1255 if (!(svccmd = svccmd_resolve_name(cmd, cmd_name))) {
1256 reply("MCMSG_UNKNOWN_COMMAND_2", cmd_name, cmd->parent->bot->nick);
1259 pos = snprintf(buf, sizeof(buf), "%s.%s", svccmd->command->parent->name, svccmd->command->name);
1260 if (svccmd->alias.used) {
1262 unsplit_string((char**)svccmd->alias.list+1, svccmd->alias.used-1, buf+pos);
1263 reply("MCMSG_COMMAND_ALIASES", svccmd->name, buf);
1265 reply("MCMSG_COMMAND_BINDING", svccmd->name, buf);
1267 flags = svccmd->effective_flags;
1268 if ((svccmd->parent && svccmd->parent->privileged && !IsOper(user))
1269 || ((flags & MODCMD_REQUIRE_STAFF)
1270 && !IsOper(user) && !IsNetworkHelper(user) && !IsSupportHelper(user))) {
1271 reply("MCMSG_INSPECTION_REFUSED", svccmd->name);
1274 if (flags & MODCMD_DISABLED) {
1275 reply("MSG_COMMAND_DISABLED", svccmd->name);
1279 if (svccmd->min_opserv_level > 0) {
1280 reply("MCMSG_NEED_OPSERV_LEVEL", svccmd->min_opserv_level);
1281 shown_flags |= MODCMD_REQUIRE_OPER | MODCMD_REQUIRE_AUTHED;
1283 if (svccmd->min_channel_access > 0) {
1284 reply("MCMSG_NEED_CHANSERV_LEVEL", svccmd->min_channel_access);
1285 shown_flags |= MODCMD_REQUIRE_CHANUSER | MODCMD_REQUIRE_REGCHAN | MODCMD_REQUIRE_CHANNEL | MODCMD_REQUIRE_AUTHED;
1287 if (svccmd->req_account_flags) {
1288 for (nn=pos=0; nn<32; nn++) {
1289 if (!(svccmd->req_account_flags & (1 << nn))) continue;
1290 buf[pos++] = HANDLE_FLAGS[nn];
1293 reply("MCMSG_NEED_ACCOUNT_FLAGS", buf);
1294 shown_flags |= MODCMD_REQUIRE_AUTHED;
1296 if (!flags && !shown_flags) {
1297 reply("MCMSG_NEED_NOTHING", svccmd->name);
1300 if (flags & ~shown_flags & MODCMD_REQUIRE_HELPING) {
1301 reply("MCMSG_MUST_BE_HELPING");
1302 shown_flags |= MODCMD_REQUIRE_AUTHED | MODCMD_REQUIRE_STAFF;
1304 if (flags & ~shown_flags & MODCMD_REQUIRE_STAFF) {
1305 switch (flags & MODCMD_REQUIRE_STAFF) {
1306 default: case MODCMD_REQUIRE_STAFF:
1307 fmt_str = "MCMSG_NEED_STAFF_ACCESS";
1309 case MODCMD_REQUIRE_OPER:
1310 fmt_str = "MCMSG_NEED_STAFF_OPER";
1312 case MODCMD_REQUIRE_NETWORK_HELPER:
1313 fmt_str = "MCMSG_NEED_STAFF_NETHELPER";
1315 case MODCMD_REQUIRE_OPER|MODCMD_REQUIRE_NETWORK_HELPER:
1316 fmt_str = "MCMSG_NEED_STAFF_NETHELPER_OR_OPER";
1318 case MODCMD_REQUIRE_SUPPORT_HELPER:
1319 fmt_str = "MCMSG_NEED_STAFF_SHELPER";
1321 case MODCMD_REQUIRE_OPER|MODCMD_REQUIRE_SUPPORT_HELPER:
1322 fmt_str = "MCMSG_NEED_STAFF_SHELPER_OR_OPER";
1324 case MODCMD_REQUIRE_SUPPORT_HELPER|MODCMD_REQUIRE_NETWORK_HELPER:
1325 fmt_str = "MCMSG_NEED_STAFF_HELPER";
1329 shown_flags |= MODCMD_REQUIRE_AUTHED | MODCMD_REQUIRE_STAFF;
1331 if (flags & ~shown_flags & MODCMD_REQUIRE_JOINABLE) {
1332 reply("MCMSG_NEED_JOINABLE");
1333 shown_flags |= MODCMD_REQUIRE_CHANUSER;
1335 if (flags & ~shown_flags & MODCMD_REQUIRE_CHANUSER) {
1336 if (flags & ~shown_flags & MODCMD_IGNORE_CSUSPEND)
1337 reply("MCMSG_NEED_CHANUSER_CSUSPENDABLE");
1339 reply("MCMSG_NEED_CHANUSER");
1340 shown_flags |= MODCMD_IGNORE_CSUSPEND | MODCMD_REQUIRE_REGCHAN | MODCMD_REQUIRE_CHANNEL | MODCMD_REQUIRE_AUTHED;
1342 if (flags & ~shown_flags & MODCMD_REQUIRE_REGCHAN) {
1343 reply("MCMSG_NEED_REGCHAN");
1344 shown_flags |= MODCMD_REQUIRE_CHANNEL;
1346 if (flags & ~shown_flags & MODCMD_REQUIRE_CHANNEL)
1347 reply("MCMSG_NEED_CHANNEL");
1348 if (flags & ~shown_flags & MODCMD_REQUIRE_AUTHED)
1349 reply("MCMSG_NEED_AUTHED");
1350 if (flags & ~shown_flags & MODCMD_TOY)
1351 reply("MCMSG_IS_TOY", svccmd->name);
1352 if (flags & ~shown_flags & MODCMD_REQUIRE_QUALIFIED) {
1353 const char *botnick = svccmd->parent ? svccmd->parent->bot->nick : "SomeBot";
1354 reply("MCMSG_MUST_QUALIFY", botnick, svccmd->name, botnick);
1356 reply("MCMSG_END_REQUIREMENTS", svccmd->name);
1361 modcmd_describe_command(struct userNode *user, struct svccmd *cmd, struct svccmd *target) {
1362 char buf1[MAXLEN], buf2[MAXLEN];
1363 unsigned int ii, len, buf1_used, buf2_used;
1365 if (target->alias.used) {
1366 unsplit_string((char**)target->alias.list, target->alias.used, buf1);
1367 reply("MCMSG_COMMAND_ALIASES", target->name, buf1);
1369 snprintf(buf1, sizeof(buf1), "%s.%s", target->command->parent->name, target->command->name);
1370 reply("MCMSG_COMMAND_BINDING", target->name, buf1);
1372 for (ii = buf1_used = buf2_used = 0; flags[ii].name; ++ii) {
1373 if (target->flags & flags[ii].flag) {
1375 buf1[buf1_used++] = ',';
1376 len = strlen(flags[ii].name);
1377 memcpy(buf1 + buf1_used, flags[ii].name, len);
1379 } else if (target->effective_flags & flags[ii].flag) {
1381 buf2[buf2_used++] = ',';
1382 len = strlen(flags[ii].name);
1383 memcpy(buf2 + buf2_used, flags[ii].name, len);
1388 buf1[buf1_used] = '\0';
1390 strcpy(buf1, user_find_message(user, "MSG_NONE"));
1392 buf2[buf2_used] = '\0';
1394 strcpy(buf2, user_find_message(user, "MSG_NONE"));
1395 reply("MCMSG_COMMAND_FLAGS", buf1, buf2);
1396 for (ii = buf1_used = buf2_used = 0; handle_flags[ii]; ++ii) {
1397 if (target->req_account_flags & (1 << ii))
1398 buf1[buf1_used++] = handle_flags[ii];
1399 else if (target->deny_account_flags & (1 << ii))
1400 buf2[buf2_used++] = handle_flags[ii];
1402 buf1[buf1_used] = buf2[buf2_used] = '\0';
1403 reply("MCMSG_COMMAND_ACCOUNT_FLAGS", buf1, buf2);
1404 reply("MCMSG_COMMAND_ACCESS_LEVEL", target->min_channel_access, target->min_opserv_level);
1405 reply("MCMSG_COMMAND_USES", target->name, target->uses);
1408 static MODCMD_FUNC(cmd_modcmd) {
1409 struct svccmd *svccmd;
1410 unsigned int arg, changed;
1411 char cmdname[MAXLEN];
1414 arg = collapse_cmdname(argv+1, argc-1, cmdname) + 1;
1416 reply("MSG_MISSING_PARAMS", cmd->name);
1419 if (!(svccmd = svccmd_resolve_name(cmd, cmdname))) {
1420 reply("MCMSG_UNKNOWN_COMMAND_2", cmdname, cmd->parent->bot->nick);
1423 for (changed = 0; arg+1 < argc; arg += 2) {
1424 if (svccmd_configure(svccmd, user, cmd->parent->bot, argv[arg], argv[arg+1])) {
1425 reply("MCMSG_COMMAND_MODIFIED", argv[arg], svccmd->name);
1430 modcmd_set_effective_flags(svccmd);
1431 modcmd_describe_command(user, cmd, svccmd);
1435 static MODCMD_FUNC(cmd_god) {
1439 if (enabled_string(argv[1])) {
1440 if (HANDLE_FLAGGED(user->handle_info, HELPING)) {
1441 reply("MCMSG_ALREADY_HELPING");
1445 } else if (disabled_string(argv[1])) {
1446 if (!HANDLE_FLAGGED(user->handle_info, HELPING)) {
1447 reply("MCMSG_ALREADY_NOT_HELPING");
1452 reply("MSG_INVALID_BINARY", argv[1]);
1456 helping = !IsHelping(user);
1460 HANDLE_SET_FLAG(user->handle_info, HELPING);
1461 reply("MCMSG_NOW_HELPING");
1463 HANDLE_CLEAR_FLAG(user->handle_info, HELPING);
1464 reply("MCMSG_NOW_NOT_HELPING");
1470 static MODCMD_FUNC(cmd_joiner) {
1471 char cmdname[MAXLEN];
1474 int len = sprintf(cmdname, "%s ", cmd->name);
1476 struct string_buffer sbuf;
1478 string_buffer_init(&sbuf);
1479 for (it = dict_first(cmd->parent->commands); it; it = iter_next(it)) {
1480 if (!ircncasecmp(iter_key(it), cmdname, len)) {
1481 if (sbuf.used) string_buffer_append_string(&sbuf, ", ");
1482 string_buffer_append_string(&sbuf, iter_key(it));
1485 if (!sbuf.used) string_buffer_append(&sbuf, 0);
1486 reply("MCMSG_JOINER_CHOICES", cmd->name, sbuf.list);
1487 string_buffer_clean(&sbuf);
1490 sprintf(cmdname, "%s %s", cmd->name, argv[1]);
1492 svccmd_invoke_argv(user, cmd->parent, channel, argc-1, argv+1, 0);
1493 return 0; /* never try to log this; the recursive one logs it */
1496 static MODCMD_FUNC(cmd_stats_modules) {
1497 struct helpfile_table tbl;
1501 struct modcmd *modcmd;
1504 tbl.length = dict_size(modules) + 1;
1506 tbl.flags = TABLE_PAD_LEFT;
1507 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1508 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1509 tbl.contents[0][0] = "Module";
1510 tbl.contents[0][1] = "Commands";
1511 tbl.contents[0][2] = "Helpfile";
1512 for (ii=1, it=dict_first(modules); it; it=iter_next(it), ii++) {
1513 mod = iter_data(it);
1514 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1515 tbl.contents[ii][0] = mod->name;
1516 tbl.contents[ii][1] = strtab(dict_size(mod->commands));
1517 tbl.contents[ii][2] = mod->helpfile_name ? mod->helpfile_name : "(none)";
1519 } else if (!(mod = dict_find(modules, argv[1], NULL))) {
1520 reply("MCMSG_UNKNOWN_MODULE", argv[1]);
1523 reply("MCMSG_MODULE_INFO", mod->name);
1524 tbl.length = dict_size(mod->commands) + 1;
1526 tbl.flags = TABLE_PAD_LEFT;
1527 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1528 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1529 tbl.contents[0][0] = "Command";
1530 tbl.contents[0][1] = "Min. Args";
1531 tbl.contents[0][2] = "Bind Count";
1532 for (ii=1, it=dict_first(mod->commands); it; it=iter_next(it), ii++) {
1533 modcmd = iter_data(it);
1534 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1535 tbl.contents[ii][0] = modcmd->name;
1536 tbl.contents[ii][1] = strtab(modcmd->min_argc);
1537 tbl.contents[ii][2] = strtab(modcmd->bind_count);
1540 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1544 static MODCMD_FUNC(cmd_stats_services) {
1545 struct helpfile_table tbl;
1548 struct service *service;
1549 struct svccmd *svccmd;
1553 tbl.length = dict_size(services) + 1;
1555 tbl.flags = TABLE_PAD_LEFT;
1556 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1557 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1558 tbl.contents[0][0] = "Service";
1559 tbl.contents[0][1] = "Commands";
1560 tbl.contents[0][2] = "Priv'd?";
1561 tbl.contents[0][3] = "Trigger";
1562 extra = calloc(2, tbl.length);
1563 for (ii=1, it=dict_first(services); it; it=iter_next(it), ii++) {
1564 service = iter_data(it);
1565 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1566 tbl.contents[ii][0] = service->bot->nick;
1567 tbl.contents[ii][1] = strtab(dict_size(service->commands));
1568 tbl.contents[ii][2] = service->privileged ? "yes" : "no";
1569 extra[ii*2] = service->trigger;
1570 tbl.contents[ii][3] = extra+ii*2;
1572 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1575 } else if (!(service = dict_find(services, argv[1], NULL))) {
1576 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1579 tbl.length = dict_size(service->commands) + 1;
1581 tbl.flags = TABLE_PAD_LEFT | TABLE_NO_FREE;
1582 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1583 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1584 tbl.contents[0][0] = "Command";
1585 tbl.contents[0][1] = "Module";
1586 tbl.contents[0][2] = "ModCmd";
1587 tbl.contents[0][3] = "Alias?";
1588 tbl.contents[0][4] = strdup("Uses");
1589 for (ii=1, it=dict_first(service->commands); it; it=iter_next(it), ii++) {
1590 svccmd = iter_data(it);
1591 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1592 tbl.contents[ii][0] = svccmd->name;
1593 tbl.contents[ii][1] = svccmd->command->parent->name;
1594 tbl.contents[ii][2] = svccmd->command->name;
1595 tbl.contents[ii][3] = svccmd->alias.used ? "yes" : "no";
1596 tbl.contents[ii][4] = extra = malloc(12);
1597 sprintf(extra, "%u", svccmd->uses);
1599 reply("MCMSG_SERVICE_INFO", service->bot->nick);
1600 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1601 for (ii=0; ii<tbl.length; ii++) {
1602 free((char*)tbl.contents[ii][4]);
1603 free(tbl.contents[ii]);
1610 static MODCMD_FUNC(cmd_showcommands) {
1611 struct svccmd_list commands;
1612 struct helpfile_table tbl;
1613 struct svccmd *svccmd;
1615 unsigned int ii, ignore_flags = 0;
1616 unsigned int max_opserv_level = 1000;
1617 unsigned short max_chanserv_level = 500;
1618 char show_opserv_level = 0, show_channel_access = 0;
1620 /* Check to see what the max access they want to see is. */
1621 for (ii=1; ii<argc; ++ii) {
1622 if (isdigit(argv[ii][0]))
1623 max_opserv_level = atoi(argv[ii]);
1625 max_chanserv_level = user_level_from_name(argv[ii], UL_OWNER);
1628 /* Find the matching commands. */
1629 svccmd_list_init(&commands);
1630 if (cmd->parent->privileged)
1631 ignore_flags = MODCMD_REQUIRE_OPER;
1632 for (it = dict_first(cmd->parent->commands); it; it = iter_next(it)) {
1633 svccmd = iter_data(it);
1634 if (strchr(svccmd->name, ' '))
1636 if (!svccmd_can_invoke(user, svccmd->parent->bot, svccmd, channel, SVCCMD_QUALIFIED))
1638 if (svccmd->min_opserv_level > max_opserv_level)
1640 if (svccmd->min_channel_access > max_chanserv_level)
1642 if (svccmd->min_opserv_level > 0)
1643 show_opserv_level = 1;
1644 if (svccmd->min_channel_access > 0)
1645 show_channel_access = 1;
1646 if (svccmd->effective_flags
1647 & (MODCMD_REQUIRE_STAFF|MODCMD_REQUIRE_HELPING)
1649 show_channel_access = 1;
1651 svccmd_list_append(&commands, svccmd);
1654 /* Build the table. */
1655 tbl.length = commands.used + 1;
1656 tbl.width = 1 + show_opserv_level + show_channel_access;
1657 tbl.flags = TABLE_REPEAT_ROWS;
1658 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1659 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1660 tbl.contents[0][ii = 0] = "Command";
1661 if (show_opserv_level)
1662 tbl.contents[0][++ii] = "OpServ Level";
1663 if (show_channel_access)
1664 tbl.contents[0][++ii] = "ChanServ Access";
1665 for (ii=0; ii<commands.used; ++ii) {
1666 svccmd = commands.list[ii];
1667 tbl.contents[ii+1] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1668 tbl.contents[ii+1][0] = svccmd->name;
1669 if (show_opserv_level)
1670 tbl.contents[ii+1][1] = strtab(svccmd->min_opserv_level);
1671 if (show_channel_access) {
1673 int flags = svccmd->effective_flags;
1674 if (flags & MODCMD_REQUIRE_HELPING)
1676 else if (flags & MODCMD_REQUIRE_STAFF) {
1677 if (flags & MODCMD_REQUIRE_OPER)
1679 else if (flags & MODCMD_REQUIRE_NETWORK_HELPER)
1680 access = "net.helper";
1684 access = strtab(svccmd->min_channel_access);
1685 tbl.contents[ii+1][1+show_opserv_level] = access;
1688 svccmd_list_clean(&commands);
1689 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1693 static MODCMD_FUNC(cmd_helpfiles) {
1694 struct service *service;
1697 if (!(service = dict_find(services, argv[1], NULL))) {
1698 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1703 for (ii=0; ii<service->modules.used; ++ii)
1704 reply("MCMSG_HELPFILE_SEQUENCE", ii+1, service->modules.list[ii]->name);
1708 service->modules.used = 0;
1709 for (ii=0; ii<argc-2; ii++) {
1710 struct module *module = dict_find(modules, argv[ii+2], NULL);
1712 reply("MCMSG_UNKNOWN_MODULE", argv[ii+2]);
1715 module_list_append(&service->modules, module);
1717 reply("MCMSG_HELPFILE_SEQUENCE_SET", service->bot->nick);
1721 static MODCMD_FUNC(cmd_service_add) {
1722 const char *nick, *hostname, *desc;
1723 struct userNode *bot;
1726 if (!is_valid_nick(nick)) {
1727 reply("MCMSG_BAD_SERVICE_NICK", nick);
1731 desc = unsplit_string(argv+3, argc-3, NULL);
1732 bot = GetUserH(nick);
1733 if (bot && IsService(bot)) {
1734 reply("MCMSG_ALREADY_SERVICE", bot->nick);
1737 bot = AddLocalUser(nick, nick, hostname, desc, NULL);
1738 service_register(bot);
1739 reply("MCMSG_NEW_SERVICE", bot->nick);
1743 static MODCMD_FUNC(cmd_service_rename) {
1744 struct service *service;
1746 if (!(service = service_find(argv[1]))) {
1747 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1750 NickChange(service->bot, argv[2], 0);
1751 reply("MCMSG_SERVICE_RENAMED", service->bot->nick);
1755 static MODCMD_FUNC(cmd_service_trigger) {
1756 struct userNode *bogon;
1757 struct service *service;
1759 if (!(service = service_find(argv[1]))) {
1760 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1764 if (service->trigger)
1765 reply("MCMSG_CURRENT_TRIGGER", service->bot->nick, service->trigger);
1767 reply("MCMSG_NO_TRIGGER", service->bot->nick);
1770 if (service->trigger)
1771 reg_chanmsg_func(service->trigger, NULL, NULL);
1772 if (!irccasecmp(argv[2], "none") || !irccasecmp(argv[2], "remove")) {
1773 service->trigger = 0;
1774 reply("MCMSG_REMOVED_TRIGGER", service->bot->nick);
1775 } else if ((bogon = get_chanmsg_bot(argv[2][0]))) {
1776 reply("MCMSG_DUPLICATE_TRIGGER", bogon->nick, argv[2][0]);
1779 service->trigger = argv[2][0];
1780 reg_chanmsg_func(service->trigger, service->bot, modcmd_chanmsg);
1781 reply("MCMSG_NEW_TRIGGER", service->bot->nick, service->trigger);
1786 static MODCMD_FUNC(cmd_service_privileged) {
1787 struct service *service;
1790 if (!(service = service_find(argv[1]))) {
1791 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1795 service->privileged = true_string(argv[2]) || enabled_string(argv[2]);
1796 newval = user_find_message(user, service->privileged ? "MSG_ON" : "MSG_OFF");
1797 reply("MCMSG_SERVICE_PRIVILEGED", service->bot->nick, newval);
1801 static MODCMD_FUNC(cmd_service_remove) {
1802 char *name, *reason;
1803 struct service *service;
1807 reason = unsplit_string(argv+2, argc-2, NULL);
1809 reason = "Removing bot";
1810 if (!(service = service_find(name))) {
1811 reply("MCMSG_UNKNOWN_SERVICE", name);
1814 DelUser(service->bot, NULL, 1, reason);
1815 reply("MCMSG_SERVICE_REMOVED", name);
1816 dict_remove(services, name);
1820 static MODCMD_FUNC(cmd_dump_messages) {
1821 const char *fname = "strings.db";
1822 struct saxdb_context *ctx;
1827 if (!(pf = fopen(fname, "w"))) {
1828 reply("MCMSG_FILE_NOT_OPENED", fname);
1831 if (!(ctx = saxdb_open_context(pf))) {
1832 reply("MSG_INTERNAL_FAILURE");
1835 if ((res = setjmp(ctx->jbuf)) != 0) {
1836 ctx->complex.used = 0; /* to avoid false assert()s in close */
1837 saxdb_close_context(ctx);
1839 reply("MCMSG_MESSAGE_DUMP_FAILED", strerror(res));
1842 for (it = dict_first(lang_C->messages); it; it = iter_next(it))
1843 saxdb_write_string(ctx, iter_key(it), iter_data(it));
1844 saxdb_close_context(ctx);
1846 reply("MCMSG_MESSAGES_DUMPED", fname);
1851 static MODCMD_FUNC(cmd_version) {
1852 /* This function provides copyright management information to end
1853 * users of srvx. You should not alter, disable or remove this
1854 * command or its accessibility to normal IRC users, except to add
1855 * copyright information pertaining to changes you make to srvx.
1857 send_message_type(4, user, cmd->parent->bot, "$b"PACKAGE_STRING"$b ("CODENAME"), Built: "__DATE__", "__TIME__". Copyright 2000-2007 srvx Development Team.");
1859 send_message_type(4, user, cmd->parent->bot, "%s", git_version);
1861 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.");
1865 static MODCMD_FUNC(cmd_tell) {
1866 struct userNode *target;
1869 target = GetUserH(argv[1]);
1870 msg = unsplit_string(argv + 2, argc - 2, NULL);
1872 reply("MSG_NOT_TARGET_NAME");
1875 send_message_type(MSG_TYPE_NOXLATE, target, cmd->parent->bot, "%s", msg);
1880 modcmd_nick_change(struct userNode *user, const char *old_nick) {
1881 struct service *svc;
1882 if (!(svc = dict_find(services, old_nick, NULL)))
1884 dict_remove2(services, old_nick, 1);
1885 dict_insert(services, user->nick, svc);
1889 modcmd_cleanup(void) {
1890 dict_delete(services);
1891 dict_delete(modules);
1897 modcmd_saxdb_write_command(struct saxdb_context *ctx, struct svccmd *cmd) {
1899 unsigned int nn, len, pos;
1900 struct svccmd *template = cmd->command->defaults;
1902 saxdb_start_record(ctx, cmd->name, 0);
1903 sprintf(buf, "%s.%s", cmd->command->parent->name, cmd->command->name);
1904 saxdb_write_string(ctx, "command", buf);
1905 if (cmd->alias.used)
1906 saxdb_write_string_list(ctx, "aliased", &cmd->alias);
1907 if (cmd->min_opserv_level != template->min_opserv_level)
1908 saxdb_write_int(ctx, "oper_access", cmd->min_opserv_level);
1909 if (cmd->min_channel_access != template->min_channel_access)
1910 saxdb_write_int(ctx, "channel_access", cmd->min_channel_access);
1911 if (cmd->flags != template->flags) {
1913 for (nn=pos=0; flags[nn].name; ++nn) {
1914 if (cmd->flags & flags[nn].flag) {
1916 len = strlen(flags[nn].name);
1917 memcpy(buf+pos, flags[nn].name, len);
1926 saxdb_write_string(ctx, "flags", buf);
1928 if ((cmd->req_account_flags != template->req_account_flags)
1929 || (cmd->deny_account_flags != template->req_account_flags)) {
1931 if (cmd->req_account_flags) {
1933 for (nn=0; nn<32; nn++)
1934 if (cmd->req_account_flags & (1 << nn))
1935 buf[pos++] = handle_flags[nn];
1937 if (cmd->deny_account_flags) {
1939 for (nn=0; nn<32; nn++)
1940 if (cmd->deny_account_flags & (1 << nn))
1941 buf[pos++] = handle_flags[nn];
1944 saxdb_write_string(ctx, "account_flags", buf);
1946 saxdb_end_record(ctx);
1950 modcmd_saxdb_write(struct saxdb_context *ctx) {
1951 struct string_list slist;
1952 dict_iterator_t it, it2;
1953 struct service *service;
1956 saxdb_start_record(ctx, "bots", 1);
1957 for (it = dict_first(services); it; it = iter_next(it)) {
1959 service = iter_data(it);
1960 saxdb_start_record(ctx, service->bot->nick, 1);
1961 if (service->trigger) {
1962 buff[0] = service->trigger;
1964 saxdb_write_string(ctx, "trigger", buff);
1966 saxdb_write_string(ctx, "description", service->bot->info);
1967 saxdb_write_string(ctx, "hostname", service->bot->hostname);
1968 if (service->privileged)
1969 saxdb_write_string(ctx, "privileged", "1");
1970 saxdb_end_record(ctx);
1972 saxdb_end_record(ctx);
1974 saxdb_start_record(ctx, "services", 1);
1975 for (it = dict_first(services); it; it = iter_next(it)) {
1976 service = iter_data(it);
1977 saxdb_start_record(ctx, service->bot->nick, 1);
1978 for (it2 = dict_first(service->commands); it2; it2 = iter_next(it2))
1979 modcmd_saxdb_write_command(ctx, iter_data(it2));
1980 saxdb_end_record(ctx);
1982 saxdb_end_record(ctx);
1984 saxdb_start_record(ctx, "helpfiles", 1);
1986 for (it = dict_first(services); it; it = iter_next(it)) {
1987 service = iter_data(it);
1989 for (ii = 0; ii < service->modules.used; ++ii)
1990 string_list_append(&slist, service->modules.list[ii]->name);
1991 saxdb_write_string_list(ctx, iter_key(it), &slist);
1995 saxdb_end_record(ctx);
2001 append_entry(const char *key, UNUSED_ARG(void *data), void *extra) {
2002 struct helpfile_expansion *exp = extra;
2003 int row = exp->value.table.length++;
2004 exp->value.table.contents[row] = calloc(1, sizeof(char*));
2005 exp->value.table.contents[row][0] = key;
2009 static struct helpfile_expansion
2010 modcmd_expand(const char *variable) {
2011 struct helpfile_expansion exp;
2012 extern struct userNode *message_source;
2013 struct service *service;
2015 service = dict_find(services, message_source->nick, NULL);
2016 if (!irccasecmp(variable, "index")) {
2017 exp.type = HF_TABLE;
2018 exp.value.table.length = 1;
2019 exp.value.table.width = 1;
2020 exp.value.table.flags = TABLE_REPEAT_ROWS;
2021 exp.value.table.contents = calloc(dict_size(service->commands)+1, sizeof(char**));
2022 exp.value.table.contents[0] = calloc(1, sizeof(char*));
2023 exp.value.table.contents[0][0] = "Commands:";
2024 dict_foreach(service->commands, append_entry, &exp);
2026 } else if (!irccasecmp(variable, "languages")) {
2027 struct string_buffer sbuf;
2029 sbuf.used = sbuf.size = 0;
2031 for (it = dict_first(languages); it; it = iter_next(it)) {
2032 string_buffer_append_string(&sbuf, iter_key(it));
2033 string_buffer_append(&sbuf, ' ');
2035 sbuf.list[--sbuf.used] = 0;
2036 exp.type = HF_STRING;
2037 exp.value.str = sbuf.list;
2040 exp.type = HF_STRING;
2041 exp.value.str = NULL;
2046 modcmd_load_bots(struct dict *db, int default_nick) {
2049 for (it = dict_first(db); it; it = iter_next(it)) {
2050 struct record_data *rd;
2051 struct service *svc;
2052 const char *nick, *desc, *hostname;
2055 if (rd->type != RECDB_OBJECT) {
2056 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'bots/%s' in modcmd db (expected object).", iter_key(it));
2059 nick = database_get_data(rd->d.object, "nick", RECDB_QSTRING);
2062 nick = iter_key(it);
2066 svc = service_find(nick);
2067 desc = database_get_data(rd->d.object, "description", RECDB_QSTRING);
2068 hostname = database_get_data(rd->d.object, "hostname", RECDB_QSTRING);
2071 svc = service_register(AddLocalUser(nick, nick, hostname, desc, NULL));
2073 strcpy(svc->bot->hostname, hostname);
2074 desc = database_get_data(rd->d.object, "trigger", RECDB_QSTRING);
2076 svc->trigger = desc[0];
2077 desc = database_get_data(rd->d.object, "privileged", RECDB_QSTRING);
2078 if (desc && (true_string(desc) || enabled_string(desc)))
2079 svc->privileged = 1;
2085 modcmd_conf_read(void) {
2086 modcmd_load_bots(conf_get_data("services", RECDB_OBJECT), 0);
2091 qsort(flags, ArrayLength(flags)-1, sizeof(flags[0]), flags_qsort);
2092 modules = dict_new();
2093 dict_set_free_data(modules, free_module);
2094 services = dict_new();
2095 dict_set_free_data(services, free_service);
2096 reg_nick_change_func(modcmd_nick_change);
2097 reg_exit_func(modcmd_cleanup);
2098 conf_register_reload(modcmd_conf_read);
2100 modcmd_module = module_register("modcmd", MAIN_LOG, "modcmd.help", modcmd_expand);
2101 bind_command = modcmd_register(modcmd_module, "bind", cmd_bind, 4, MODCMD_KEEP_BOUND, "oper_level", "800", NULL);
2102 help_command = modcmd_register(modcmd_module, "help", cmd_help, 1, 0, "flags", "+nolog", NULL);
2103 modcmd_register(modcmd_module, "command", cmd_command, 2, 0, "flags", "+nolog", NULL);
2104 modcmd_register(modcmd_module, "modcmd", cmd_modcmd, 2, MODCMD_KEEP_BOUND, "template", "bind", NULL);
2105 modcmd_register(modcmd_module, "god", cmd_god, 0, MODCMD_REQUIRE_AUTHED, "flags", "+oper,+networkhelper", NULL);
2106 modcmd_register(modcmd_module, "readhelp", cmd_readhelp, 2, 0, "oper_level", "650", NULL);
2107 modcmd_register(modcmd_module, "timecmd", cmd_timecmd, 2, 0, "oper_level", "1", NULL);
2108 modcmd_register(modcmd_module, "unbind", cmd_unbind, 3, 0, "template", "bind", NULL);
2109 modcmd_register(modcmd_module, "joiner", cmd_joiner, 1, 0, NULL);
2110 modcmd_register(modcmd_module, "stats modules", cmd_stats_modules, 1, 0, "flags", "+oper", NULL);
2111 modcmd_register(modcmd_module, "stats services", cmd_stats_services, 1, 0, "flags", "+oper", NULL);
2112 modcmd_register(modcmd_module, "showcommands", cmd_showcommands, 1, 0, "flags", "+acceptchan", NULL);
2113 modcmd_register(modcmd_module, "helpfiles", cmd_helpfiles, 2, 0, "template", "bind", NULL);
2114 modcmd_register(modcmd_module, "service add", cmd_service_add, 4, 0, "flags", "+oper", NULL);
2115 modcmd_register(modcmd_module, "service rename", cmd_service_rename, 3, 0, "flags", "+oper", NULL);
2116 modcmd_register(modcmd_module, "service trigger", cmd_service_trigger, 2, 0, "flags", "+oper", NULL);
2117 modcmd_register(modcmd_module, "service privileged", cmd_service_privileged, 2, 0, "flags", "+oper", NULL);
2118 modcmd_register(modcmd_module, "service remove", cmd_service_remove, 2, 0, "flags", "+oper", NULL);
2119 modcmd_register(modcmd_module, "dumpmessages", cmd_dump_messages, 1, 0, "oper_level", "1000", NULL);
2120 modcmd_register(modcmd_module, "tell", cmd_tell, 3, 0, "flags", "+oper", NULL);
2121 version_command = modcmd_register(modcmd_module, "version", cmd_version, 1, 0, NULL);
2122 message_register_table(msgtab);
2126 modcmd_db_load_command(struct service *service, const char *cmdname, struct dict *obj) {
2127 struct svccmd *svccmd;
2128 struct module *module;
2129 struct modcmd *modcmd;
2130 struct string_list *slist;
2131 const char *str, *sep;
2134 str = database_get_data(obj, "command", RECDB_QSTRING);
2136 log_module(MAIN_LOG, LOG_ERROR, "Missing command for service %s command %s in modcmd.db", service->bot->nick, cmdname);
2139 sep = strchr(str, '.');
2141 log_module(MAIN_LOG, LOG_ERROR, "Invalid command %s for service %s command %s in modcmd.db", str, service->bot->nick, cmdname);
2144 memcpy(buf, str, sep-str);
2146 if (!(module = module_find(buf))) {
2147 log_module(MAIN_LOG, LOG_ERROR, "Unknown module %s for service %s command %s in modcmd.db", buf, service->bot->nick, cmdname);
2150 if (!(modcmd = dict_find(module->commands, sep+1, NULL))) {
2151 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);
2154 /* Now that we know we have a command to use, fill in the basics. */
2155 svccmd = calloc(1, sizeof(*svccmd));
2156 svccmd_insert(service, strdup(cmdname), svccmd, modcmd);
2157 if ((str = database_get_data(obj, "template", RECDB_QSTRING))) {
2158 add_pending_template(svccmd, str);
2160 svccmd_copy_rules(svccmd, modcmd->defaults);
2162 if ((str = database_get_data(obj, "account_flags", RECDB_QSTRING))) {
2163 svccmd->req_account_flags = svccmd->deny_account_flags = 0;
2164 svccmd_configure(svccmd, NULL, service->bot, "account_flags", str);
2166 if ((str = database_get_data(obj, "flags", RECDB_QSTRING))) {
2168 svccmd_configure(svccmd, NULL, service->bot, "flags", str);
2170 if ((str = database_get_data(obj, "oper_access", RECDB_QSTRING))
2171 || (str = database_get_data(obj, "opserv_level", RECDB_QSTRING))) {
2172 svccmd_configure(svccmd, NULL, service->bot, "oper_access", str);
2174 if ((str = database_get_data(obj, "channel_access", RECDB_QSTRING))
2175 || (str = database_get_data(obj, "chanserv_level", RECDB_QSTRING))) {
2176 svccmd_configure(svccmd, NULL, service->bot, "channel_access", str);
2178 if ((slist = database_get_data(obj, "aliased", RECDB_STRING_LIST))) {
2180 svccmd->alias.used = svccmd->alias.size = slist->used;
2181 svccmd->alias.list = calloc(svccmd->alias.size, sizeof(svccmd->alias.list[0]));
2182 for (nn=0; nn<slist->used; ++nn)
2183 svccmd->alias.list[nn] = strdup(slist->list[nn]);
2185 modcmd_set_effective_flags(svccmd);
2188 static struct svccmd *
2189 service_make_alias(struct service *service, const char *alias, ...) {
2190 char *arg, *argv[MAXNUMPARAMS];
2191 unsigned int nn, argc;
2192 struct svccmd *svccmd, *template;
2195 va_start(args, alias);
2198 arg = va_arg(args, char*);
2204 svccmd = calloc(1, sizeof(*svccmd));
2205 if (!(template = svccmd_resolve_name(svccmd, argv[0]))) {
2206 log_module(MAIN_LOG, LOG_ERROR, "Invalid base command %s for alias %s in service %s", argv[0], alias, service->bot->nick);
2212 svccmd->alias.used = svccmd->alias.size = argc;
2213 svccmd->alias.list = calloc(svccmd->alias.size, sizeof(svccmd->alias.list[0]));
2214 for (nn=0; nn<argc; nn++)
2215 svccmd->alias.list[nn] = strdup(argv[nn]);
2217 svccmd_insert(service, strdup(alias), svccmd, template->command);
2218 svccmd_copy_rules(svccmd, template);
2222 static int saxdb_present;
2225 modcmd_saxdb_read(struct dict *db) {
2227 dict_iterator_t it, it2;
2228 struct record_data *rd, *rd2;
2229 struct service *service;
2231 modcmd_load_bots(database_get_data(db, "bots", RECDB_OBJECT), 1);
2232 db2 = database_get_data(db, "services", RECDB_OBJECT);
2234 log_module(MAIN_LOG, LOG_ERROR, "Missing section 'services' in modcmd db.");
2237 for (it = dict_first(db2); it; it = iter_next(it)) {
2239 if (rd->type != RECDB_OBJECT) {
2240 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'services/%s' in modcmd db (expected object).", iter_key(it));
2243 if (!(service = service_find(iter_key(it)))) {
2244 log_module(MAIN_LOG, LOG_ERROR, "Unknown service '%s' listed in modcmd db.", iter_key(it));
2247 for (it2 = dict_first(rd->d.object); it2; it2 = iter_next(it2)) {
2248 rd2 = iter_data(it2);
2249 if (rd2->type != RECDB_OBJECT) {
2250 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'services/%s/%s' in modcmd db (expected object).", iter_key(it), iter_key(it2));
2253 modcmd_db_load_command(service, iter_key(it2), rd2->d.object);
2256 db2 = database_get_data(db, "helpfiles", RECDB_OBJECT);
2257 for (it = dict_first(db2); it; it = iter_next(it)) {
2258 struct module *module;
2259 struct string_list *slist;
2263 if (rd->type != RECDB_STRING_LIST) {
2264 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'helpfiles/%s' in modcmd db (expected string list).", iter_key(it));
2267 slist = rd->d.slist;
2268 if (!(service = service_find(iter_key(it)))) {
2269 /* We probably whined about the service being missing above. */
2272 service->modules.used = 0;
2273 for (ii=0; ii<slist->used; ++ii) {
2274 if (!(module = dict_find(modules, slist->list[ii], NULL))) {
2275 log_module(MAIN_LOG, LOG_ERROR, "Unknown module '%s' listed in modcmd 'helpfiles/%s'.", slist->list[ii], iter_key(it));
2278 module_list_append(&service->modules, module);
2286 create_default_binds(void) {
2287 /* Which services should import which modules by default? */
2289 const char *svcname;
2290 /* C is lame and requires a fixed size for this array.
2291 * Be sure you NULL-terminate each array and increment the
2292 * size here if you add more default modules to any
2294 const char *modnames[8];
2296 { "ChanServ", { "ChanServ", NULL } },
2297 { "Global", { "Global", NULL } },
2298 { "NickServ", { "NickServ", NULL } },
2299 { "OpServ", { "OpServ", "modcmd", "sendmail", "saxdb", "proxycheck", NULL } },
2302 unsigned int ii, jj;
2303 char buf[128], *nick;
2304 struct service *service;
2305 struct module *module;
2307 for (ii = 0; def_binds[ii].svcname; ++ii) {
2308 sprintf(buf, "services/%s/nick", def_binds[ii].svcname);
2309 if (!(nick = conf_get_data(buf, RECDB_QSTRING)))
2311 if (!(service = service_find(nick)))
2313 if (dict_size(service->commands) > 0)
2316 /* Bind the default modules for this service to it */
2317 for (jj = 0; def_binds[ii].modnames[jj]; ++jj) {
2318 if (!(module = module_find(def_binds[ii].modnames[jj])))
2320 service_bind_module(service, module);
2323 /* Bind the help and version commands to this service */
2324 service_bind_modcmd(service, help_command, help_command->name);
2325 service_bind_modcmd(service, version_command, version_command->name);
2327 /* Now some silly hax.. (aliases that most people want) */
2328 if (!irccasecmp(def_binds[ii].svcname, "ChanServ")) {
2329 service_make_alias(service, "addowner", "*chanserv.adduser", "$1", "owner", NULL);
2330 service_make_alias(service, "addcoowner", "*chanserv.adduser", "$1", "coowner", NULL);
2331 service_make_alias(service, "addmaster", "*chanserv.adduser", "$1", "master", NULL);
2332 service_make_alias(service, "addop", "*chanserv.adduser", "$1", "op", NULL);
2333 service_make_alias(service, "addpeon", "*chanserv.adduser", "$1", "peon", NULL);
2334 service_make_alias(service, "delowner", "*chanserv.deluser", "owner", "$1", NULL);
2335 service_make_alias(service, "delcoowner", "*chanserv.deluser", "coowner", "$1", NULL);
2336 service_make_alias(service, "delmaster", "*chanserv.deluser", "master", "$1", NULL);
2337 service_make_alias(service, "delop", "*chanserv.deluser", "op", "$1", NULL);
2338 service_make_alias(service, "delpeon", "*chanserv.deluser", "peon", "$1", NULL);
2339 service_make_alias(service, "command", "*modcmd.command", NULL);
2340 service_make_alias(service, "god", "*modcmd.god", NULL);
2341 } else if (!irccasecmp(def_binds[ii].svcname, "OpServ")) {
2342 struct svccmd *svccmd;
2343 svccmd = service_make_alias(service, "stats", "*modcmd.joiner", NULL);
2344 svccmd->min_opserv_level = 101;
2345 svccmd = service_make_alias(service, "service", "*modcmd.joiner", NULL);
2346 svccmd->min_opserv_level = 900;
2352 import_aliases_db() {
2354 dict_iterator_t it, it2;
2355 struct record_data *rd, *rd2;
2356 struct service *service;
2357 struct module *module;
2359 if (!(db = parse_database("aliases.db")))
2361 for (it = dict_first(db); it; it = iter_next(it)) {
2362 service = service_find(iter_key(it));
2365 module = module_find(service->bot->nick);
2367 if (rd->type != RECDB_OBJECT)
2369 for (it2 = dict_first(rd->d.object); it2; it2 = iter_next(it2)) {
2370 struct modcmd *command;
2371 rd2 = iter_data(it2);
2372 if (rd2->type != RECDB_QSTRING)
2374 command = dict_find(module->commands, rd2->d.qstring, NULL);
2377 service_bind_modcmd(service, command, iter_key(it2));
2383 modcmd_finalize(void) {
2386 /* Check databases. */
2387 saxdb_register("modcmd", modcmd_saxdb_read, modcmd_saxdb_write);
2388 create_default_binds();
2390 import_aliases_db();
2392 /* Register services for their triggers. */
2393 for (it = dict_first(services); it; it = iter_next(it)) {
2394 struct service *svc = iter_data(it);
2396 reg_chanmsg_func(svc->trigger, svc->bot, modcmd_chanmsg);
2399 /* Resolve command rule-templates. */
2400 while (pending_templates) {
2401 struct pending_template *ptempl = pending_templates;
2402 struct svccmd *svccmd;
2404 pending_templates = ptempl->next;
2405 /* Only overwrite the current template if we have a valid template. */
2406 if (!strcmp(ptempl->base, "*")) {
2408 } else if ((svccmd = svccmd_resolve_name(ptempl->cmd, ptempl->base))) {
2409 svccmd_copy_rules(ptempl->cmd, svccmd);
2411 assert(ptempl->cmd->parent);
2412 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);