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 %lu.%03lu seconds." },
77 { "MCMSG_COMMAND_TIME", "Command $b%s$b finished in %lu.%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 extern struct userNode *chanserv;
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) {
471 /* Just use the inferred MODCMD_REQUIRE_CHANNEL. */
472 } else if (!channel->channel_info) {
473 if (options & SVCCMD_NOISY)
474 send_message(user, bot, "MCMSG_CHAN_NOT_REGISTERED", channel->name);
476 } else if (IsSuspended(channel->channel_info) && !(flags & MODCMD_IGNORE_CSUSPEND)) {
477 /* Allow security-override users to ignore most channel
478 * suspensions, but flag that use as a staff command.
480 if (!IsHelping(user) || (flags & MODCMD_NEVER_CSUSPEND)) {
481 if (options & SVCCMD_NOISY)
482 send_message(user, bot, "MCMSG_CHAN_SUSPENDED", channel->name, channel->channel_info->suspended->reason);
485 rflags |= ACTION_STAFF;
488 if (flags & MODCMD_REQUIRE_CHANUSER) {
490 uData = _GetChannelUser(channel->channel_info, user->handle_info, 1, 0), uData_checked = 1;
492 /* Assume someone knows what they're doing. */
494 if (options & SVCCMD_NOISY)
495 send_message(user, bot, "MCMSG_NO_CHANNEL_ACCESS", channel->name);
497 } else if (uData->access < cmd->min_channel_access) {
498 if (options & SVCCMD_NOISY)
499 send_message(user, bot, "MCMSG_LOW_CHANNEL_ACCESS", channel->name);
503 if ((flags & MODCMD_REQUIRE_JOINABLE) && channel) {
505 uData = _GetChannelUser(channel->channel_info, user->handle_info, 1, 0), uData_checked = 1;
506 if ((channel->modes & (MODE_INVITEONLY|MODE_KEY|MODE_SECRET))
509 && !GetUserMode(channel, user)) {
510 if (options & SVCCMD_NOISY)
511 send_message(user, bot, "MCMSG_REQUIRES_JOINABLE", channel->name);
515 if ((flags & MODCMD_TOY) && channel) {
516 if (!channel->channel_info)
517 rflags |= ACTION_NOCHANNEL;
518 else switch (channel->channel_info->chOpts[chToys]) {
520 if (options & SVCCMD_NOISY)
521 send_message(user, bot, "MCMSG_TOYS_DISABLED", channel->name);
524 rflags |= ACTION_NOCHANNEL;
531 if (flags & MODCMD_REQUIRE_STAFF) {
532 if (((flags & MODCMD_REQUIRE_OPER) && IsOper(user))
533 || ((flags & MODCMD_REQUIRE_NETWORK_HELPER) && IsNetworkHelper(user))
534 || ((flags & MODCMD_REQUIRE_SUPPORT_HELPER) && IsSupportHelper(user))) {
536 rflags |= ACTION_STAFF;
538 if (options & SVCCMD_NOISY)
539 send_message(user, bot, "MSG_COMMAND_PRIVILEGED", cmd->name);
543 if (flags & MODCMD_REQUIRE_HELPING) {
544 if (!HANDLE_FLAGGED(user->handle_info, HELPING)) {
545 if (options & SVCCMD_NOISY)
546 send_message(user, bot, "MCMSG_MUST_BE_HELPING");
549 rflags |= ACTION_STAFF;
551 if (cmd->min_opserv_level > 0) {
552 if (!oper_has_access(user, bot, cmd->min_opserv_level, !(options & SVCCMD_NOISY)))
554 rflags |= ACTION_STAFF;
556 if (cmd->req_account_flags || cmd->deny_account_flags) {
557 if (!user->handle_info) {
558 if (options & SVCCMD_NOISY)
559 send_message(user, bot, "MSG_AUTHENTICATE");
562 /* Do we want separate or different messages here? */
563 if ((cmd->req_account_flags & ~user->handle_info->flags)
564 || (cmd->deny_account_flags & user->handle_info->flags)) {
565 if (options & SVCCMD_NOISY)
566 send_message(user, bot, "MSG_COMMAND_PRIVILEGED", cmd->name);
571 /* If it's an override, return a special value. */
572 if ((flags & MODCMD_REQUIRE_CHANUSER)
573 && (options & SVCCMD_NOISY)
574 && (!uData || (uData->access > 500))
575 && (!(uData = _GetChannelUser(channel->channel_info, user->handle_info, 0, 0))
576 || uData->access < cmd->min_channel_access)
577 && !(flags & (MODCMD_REQUIRE_STAFF|MODCMD_REQUIRE_HELPING))) {
578 rflags |= ACTION_OVERRIDE;
580 return rflags | ACTION_ALLOW;
584 svccmd_expand_alias(struct svccmd *cmd, unsigned int old_argc, char *old_argv[], char *new_argv[]) {
585 unsigned int ii, new_argc;
588 for (ii=new_argc=0; ii<cmd->alias.used; ++ii) {
589 arg = cmd->alias.list[ii];
591 new_argv[new_argc++] = arg;
595 new_argv[new_argc++] = arg + 1;
596 } else if (isdigit(arg[1])) {
597 unsigned int lbound, ubound, jj;
600 lbound = strtoul(arg+1, &end_num, 10);
601 switch (end_num[0]) {
602 case 0: ubound = lbound; break;
604 if (end_num[1] == 0) {
605 ubound = old_argc - 1;
607 } else if (isdigit(end_num[1])) {
608 ubound = strtoul(end_num+1, NULL, 10);
611 /* else fall through to default case */
613 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);
616 if (lbound >= old_argc)
618 if (ubound >= old_argc)
619 ubound = old_argc - 1;
620 if (lbound < old_argc)
621 for (jj = lbound; jj <= ubound; )
622 new_argv[new_argc++] = old_argv[jj++];
624 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);
632 svccmd_invoke_argv(struct userNode *user, struct service *service, struct chanNode *channel, unsigned int argc, char *argv[], unsigned int server_qualified) {
633 extern struct userNode *chanserv;
635 unsigned int cmd_arg, perms, flags, options, result;
636 char channel_name[CHANNELLEN+1];
638 /* First check pubcmd for the channel. */
639 if (channel && (channel->channel_info) && (service->bot == chanserv)
640 && !check_user_level(channel, user, lvlPubCmd, 1, 0)) {
641 send_message(user, service->bot, "MCMSG_PUBLIC_DENY", channel->name);
645 options = (server_qualified ? SVCCMD_QUALIFIED : 0) | SVCCMD_DEBIT | SVCCMD_NOISY;
646 /* Find the command argument. */
647 cmd_arg = IsChannelName(argv[0]) ? 1 : 0;
648 if (argc < cmd_arg+1) {
649 send_message(user, service->bot, "MCMSG_MISSING_COMMAND");
652 if (!isalnum(*argv[cmd_arg])) {
653 /* Silently ignore stuff that doesn't begin with a letter or number. */
656 cmd = dict_find(service->commands, argv[cmd_arg], NULL);
659 send_message(user, service->bot, "MSG_COMMAND_UNKNOWN", argv[cmd_arg]);
662 flags = cmd->effective_flags;
663 /* If they put a channel name first, check if the command allows
664 * it. If so, swap it with the command name.
668 /* Complain if we're not supposed to accept the channel. */
669 if (!(flags & MODCMD_ACCEPT_CHANNEL)) {
670 send_message(user, service->bot, "MCMSG_NO_CHANNEL_BEFORE");
673 if (!(flags & MODCMD_ACCEPT_PCHANNEL)
674 && (argv[0][0] == '+')) {
675 send_message(user, service->bot, "MCMSG_NO_PLUS_CHANNEL");
683 /* Try to grab a channel handle before alias expansion.
684 * If the command accepts a channel name, and argv[1] is
685 * one, use it as a channel name, and hide it from logging.
688 && (flags & MODCMD_ACCEPT_CHANNEL)
689 && IsChannelName(argv[1])
690 && ((argv[1][0] != '+') || (flags & MODCMD_ACCEPT_PCHANNEL))
691 && (channel = dict_find(channels, argv[1], NULL))) {
697 /* Expand the alias arguments, if there are any. */
698 if (cmd->alias.used) {
699 char *new_argv[MAXNUMPARAMS];
702 res = svccmd_expand_alias(cmd, argc, argv, new_argv);
704 send_message(user, service->bot, "MSG_MISSING_PARAMS", cmd->name);
706 } else if (res == 0) {
707 send_message(user, service->bot, "MCMSG_ALIAS_ERROR", cmd->name);
713 /* Try again to grab a handle to the channel after alias
714 * expansion, overwriting any previous channel. This should,
715 * of course, only be done again if an alias was acually
718 && (flags & MODCMD_ACCEPT_CHANNEL)
719 && IsChannelName(argv[1])
720 && ((argv[1][0] != '+') || (flags & MODCMD_ACCEPT_PCHANNEL))
721 && (channel = dict_find(channels, argv[1], NULL))) {
728 /* Figure out what actions we should do for it.. */
729 if (cmd_arg && (flags & MODCMD_TOY)) {
730 /* Do not let user manually specify a channel. */
733 if (argc < cmd->command->min_argc) {
734 send_message(user, service->bot, "MSG_MISSING_PARAMS", cmd->name);
737 if (!cmd->command->func) {
738 send_message(user, service->bot, "MCMSG_INTERNAL_COMMAND", cmd->name);
741 perms = svccmd_can_invoke(user, service->bot, cmd, channel, options);
745 if (perms & ACTION_NOCHANNEL)
749 safestrncpy(channel_name, channel->name, sizeof(channel_name));
752 if (!(result = cmd->command->func(user, channel, argc, argv, cmd)))
754 if (!(flags & MODCMD_NO_LOG)) {
755 enum log_severity slvl;
756 if (result & CMD_LOG_OVERRIDE)
758 else if ((perms & ACTION_STAFF) || (result & CMD_LOG_STAFF))
760 else if (perms & ACTION_OVERRIDE)
764 /* Unsplit argv after running the function to get the benefit
765 * of any mangling/hiding done by the commands. */
766 log_audit(cmd->command->parent->clog, slvl, user, service->bot, channel_name, ((flags & MODCMD_LOG_HOSTMASK) ? AUDIT_HOSTMASK : 0), unsplit_string(argv, argc, NULL));
772 svccmd_send_help(struct userNode *user, struct userNode *bot, struct svccmd *cmd) {
773 char cmdname[MAXLEN];
775 /* Show command name (in bold). */
776 for (nn=0; cmd->name[nn]; nn++)
777 cmdname[nn] = toupper(cmd->name[nn]);
779 send_message_type(4, user, bot, "$b%s$b", cmdname);
780 /* If it's an alias, show what it's an alias for. */
781 if (cmd->alias.used) {
782 char alias_text[MAXLEN];
783 unsplit_string((char**)cmd->alias.list, cmd->alias.used, alias_text);
784 send_message(user, bot, "MCMSG_COMMAND_ALIASES", cmd->name, alias_text);
786 /* Show the help entry for the underlying command. */
787 return send_help(user, bot, cmd->command->parent->helpfile, cmd->command->name);
791 svccmd_send_help_2(struct userNode *user, struct service *service, const char *topic) {
792 struct module *module;
796 if ((cmd = dict_find(service->commands, topic, NULL)))
797 return svccmd_send_help(user, service->bot, cmd);
800 for (ii = 0; ii < service->modules.used; ++ii) {
801 module = service->modules.list[ii];
802 if (!module->helpfile)
804 if (dict_find(module->helpfile->db, topic, NULL))
805 return send_help(user, service->bot, module->helpfile, topic);
807 send_message(user, service->bot, "MSG_TOPIC_UNKNOWN");
812 svccmd_invoke(struct userNode *user, struct service *service, struct chanNode *channel, const char *text, int server_qualified) {
814 char *argv[MAXNUMPARAMS];
815 char tmpline[MAXLEN];
819 if (service->privileged) {
821 send_message(user, service->bot, "MSG_SERVICE_PRIVILEGED", service->bot->nick);
824 if (!user->handle_info) {
825 send_message(user, service->bot, "MSG_AUTHENTICATE");
828 if (HANDLE_FLAGGED(user->handle_info, OPER_SUSPENDED)) {
829 send_message(user, service->bot, "MSG_OPER_SUSPENDED");
833 safestrncpy(tmpline, text, sizeof(tmpline));
834 argc = split_line(tmpline, false, ArrayLength(argv), argv);
835 return argc ? svccmd_invoke_argv(user, service, channel, argc, argv, server_qualified) : 0;
839 modcmd_privmsg(struct userNode *user, struct userNode *bot, const char *text, int server_qualified) {
840 struct service *service;
842 if (!(service = dict_find(services, bot->nick, NULL))) {
843 log_module(MAIN_LOG, LOG_ERROR, "modcmd_privmsg got privmsg for unhandled service %s, unregistering.", bot->nick);
844 reg_privmsg_func(bot, NULL);
848 if (text[0] == '\x01') {
849 char *term, response[MAXLEN];
851 text++; /* Skip leading ^A. */
852 /* Chop off final ^A. */
853 term = strchr(text, '\x01');
857 /* Parse out leading text. */
858 term = strchr(text, ' ');
864 /* No dict lookup since these are so few. */
865 if (!irccasecmp(text, "CLIENTINFO")) {
866 /* Use \001 instead of \x01 because apparently \x01C is
867 * interpreted as ASCII FS (\034, decimal 28, hex 1C).
869 irc_notice_user(bot, user, "\001CLIENTINFO CLIENTINFO PING TIME USERINFO VERSION\x01");
870 } else if (!irccasecmp(text, "PING")) {
872 snprintf(response, sizeof(response), "\x01PING %s\x01", term);
873 irc_notice_user(bot, user, response);
875 irc_notice_user(bot,user, "\x01PING\x01");
877 } else if (!irccasecmp(text, "TIME")) {
880 strftime(response, sizeof(response), "\x01TIME %a %b %d %H:%M:%S %Y\x01", localtime(&feh));
881 irc_notice_user(bot, user, response);
882 } else if (!irccasecmp(text, "USERINFO")) {
883 snprintf(response, sizeof(response), "\x01USERINFO %s\x01", bot->info);
884 irc_notice_user(bot, user, response);
885 } else if (!irccasecmp(text, "VERSION")) {
886 /* This function provides copyright management information
887 * to end users of srvx. You should not alter, disable or
888 * remove this command or its accessibility to normal IRC
889 * users, except to add copyright information pertaining
890 * to changes you make to srvx.
892 snprintf(response, sizeof(response), "\x01VERSION %s (%s) %s\x01", PACKAGE_STRING, CODENAME, git_version);
893 irc_notice_user(bot, user, response);
898 if (service->msg_hook && service->msg_hook(user, bot, text, server_qualified))
900 svccmd_invoke(user, service, NULL, text, server_qualified);
904 modcmd_chanmsg(struct userNode *user, struct chanNode *chan, const char *text, struct userNode *bot, unsigned int is_notice) {
905 struct service *service;
906 if (!(service = dict_find(services, bot->nick, NULL)))
908 svccmd_invoke(user, service, chan, text, 0);
913 service_register(struct userNode *bot) {
914 struct service *service;
915 if ((service = dict_find(services, bot->nick, NULL)))
917 service = calloc(1, sizeof(*service));
918 module_list_init(&service->modules);
919 service->commands = dict_new();
921 dict_set_free_data(service->commands, free_service_command);
922 dict_insert(services, service->bot->nick, service);
923 reg_privmsg_func(bot, modcmd_privmsg);
928 service_find(const char *name) {
929 return dict_find(services, name, NULL);
933 svccmd_insert(struct service *service, char *name, struct svccmd *svccmd, struct modcmd *modcmd) {
935 svccmd->parent = service;
937 svccmd->command = modcmd;
938 svccmd->command->bind_count++;
939 dict_insert(service->commands, svccmd->name, svccmd);
940 for (ii=0; ii<service->modules.used; ++ii) {
941 if (service->modules.list[ii] == svccmd->command->parent) break;
943 if (ii == service->modules.used) {
944 module_list_append(&service->modules, svccmd->command->parent);
949 service_bind_modcmd(struct service *service, struct modcmd *cmd, const char *name) {
950 struct svccmd *svccmd;
951 if ((svccmd = dict_find(service->commands, name, NULL))) {
952 if (svccmd->command == cmd) return svccmd;
953 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);
956 svccmd = calloc(1, sizeof(*svccmd));
957 svccmd_insert(service, strdup(name), svccmd, cmd);
958 svccmd_copy_rules(svccmd, cmd->defaults);
963 service_bind_module(struct service *service, struct module *module) {
965 struct modcmd *modcmd;
969 for (it = dict_first(module->commands); it; it = iter_next(it)) {
970 modcmd = iter_data(it);
971 if (!((modcmd->flags | modcmd->defaults->flags) & MODCMD_NO_DEFAULT_BIND))
972 if (service_bind_modcmd(service, modcmd, iter_key(it)))
978 /* This MUST return argc if the alias expansion code knows how to deal
979 * with every argument in argv; otherwise, it MUST return the index of
980 * an argument that the expansion code does not know how to deal with.
983 check_alias_args(char *argv[], unsigned int argc) {
986 for (arg=0; arg<argc; ++arg) {
987 if (argv[arg][0] != '$') {
989 } else if (argv[arg][1] == '$') {
991 } else if (isdigit(argv[arg][1])) {
994 strtoul(argv[arg]+1, &end_num, 10);
995 switch (end_num[0]) {
1001 else if (isdigit(end_num[1]))
1003 /* else fall through to default case */
1014 collapse_cmdname(char *argv[], unsigned int argc, char *dest) {
1015 unsigned int ii, pos, arg;
1020 for (ii=pos=0, arg=0; argv[arg][ii]; ) {
1021 if (argv[arg][ii] == '\\') {
1022 if (argv[arg][ii+1]) {
1023 /* escaping a real character just puts it in literally */
1024 dest[pos++] = argv[arg][++ii];
1025 } else if ((arg+1) == argc) {
1026 /* we ran to the end of the argument list; abort */
1029 /* escape at end of a word is a space */
1035 /* normal characters don't need escapes */
1036 dest[pos++] = argv[arg][ii++];
1043 static MODCMD_FUNC(cmd_bind) {
1044 struct service *service;
1045 struct svccmd *template, *newcmd;
1046 char *svcname, *dot;
1047 char newname[MAXLEN], cmdname[MAXLEN];
1048 unsigned int arg, diff;
1052 arg = collapse_cmdname(argv+2, argc-2, newname) + 2;
1054 reply("MSG_MISSING_PARAMS", cmd->name);
1057 diff = collapse_cmdname(argv+arg, argc-arg, cmdname);
1059 reply("MSG_MISSING_PARAMS", cmd->name);
1064 if (!(service = service_find(svcname))) {
1065 reply("MCMSG_UNKNOWN_SERVICE", svcname);
1069 if ((newcmd = dict_find(service->commands, newname, NULL))) {
1070 reply("MCMSG_ALREADY_BOUND", service->bot->nick, newname);
1074 if ((dot = strchr(cmdname, '.')) && (dot[1] == '*') && (dot[2] == 0)) {
1076 struct module *module;
1078 module = module_find((cmdname[0] == '*') ? cmdname+1 : cmdname);
1080 reply("MSG_MODULE_UNKNOWN", cmdname);
1083 count = service_bind_module(service, module);
1084 reply("MCMSG_MODULE_BOUND", count, module->name, service->bot->nick);
1087 newcmd = calloc(1, sizeof(*newcmd));
1088 newcmd->name = strdup(newname);
1089 newcmd->parent = service;
1090 if (!(template = svccmd_resolve_name(newcmd, cmdname))) {
1091 reply("MCMSG_UNKNOWN_COMMAND_2", cmdname, service->bot->nick);
1096 if (template->alias.used) {
1097 reply("MCMSG_CANNOT_DOUBLE_ALIAS");
1104 /* a more complicated alias; fix it up */
1108 nn = check_alias_args(argv+arg, argc-arg);
1109 if (nn+arg < argc) {
1110 reply("MCMSG_BAD_ALIAS_ARGUMENT", argv[nn+arg]);
1115 newcmd->alias.used = newcmd->alias.size = argc-arg;
1116 newcmd->alias.list = calloc(newcmd->alias.size, sizeof(newcmd->alias.list[0]));
1117 for (nn=0; nn<newcmd->alias.used; ++nn)
1118 newcmd->alias.list[nn] = strdup(argv[nn+arg]);
1121 svccmd_insert(service, newcmd->name, newcmd, template->command);
1122 svccmd_copy_rules(newcmd, template);
1123 reply("MCMSG_COMMAND_BOUND", newcmd->name, newcmd->parent->bot->nick);
1128 service_recheck_bindings(struct service *service, struct module *module) {
1132 for (it = dict_first(service->commands); it; it = iter_next(it)) {
1133 cmd = iter_data(it);
1134 if (cmd->command->parent == module) return 0;
1136 /* No more bindings, remove it from our list. */
1137 module_list_remove(&service->modules, module);
1141 static svccmd_unbind_func_t *suf_list;
1142 unsigned int suf_size, suf_used;
1145 reg_svccmd_unbind_func(svccmd_unbind_func_t handler) {
1146 if (suf_used == suf_size) {
1149 suf_list = realloc(suf_list, suf_size*sizeof(svccmd_unbind_func_t));
1152 suf_list = malloc(suf_size*sizeof(svccmd_unbind_func_t));
1155 suf_list[suf_used++] = handler;
1158 static MODCMD_FUNC(cmd_unbind) {
1159 struct service *service;
1160 struct userNode *bot;
1161 struct svccmd *bound;
1162 struct module *module;
1163 const char *svcname;
1164 unsigned int arg, ii;
1165 char cmdname[MAXLEN];
1169 arg = collapse_cmdname(argv+2, argc-2, cmdname) + 2;
1171 reply("MSG_MISSING_PARAMS", cmd->name);
1174 if (!(service = service_find(svcname))) {
1175 reply("MCMSG_UNKNOWN_SERVICE", svcname);
1178 if (!(bound = dict_find(service->commands, cmdname, NULL))) {
1179 reply("MCMSG_NO_COMMAND_BOUND", service->bot->nick, cmdname);
1182 if ((bound->command->flags & MODCMD_KEEP_BOUND) && (bound->command->bind_count == 1)) {
1183 reply("MCMSG_UNBIND_PROHIBITED", bound->command->name);
1187 for (ii=0; ii<suf_used; ii++)
1188 suf_list[ii](bound);
1189 /* If this command binding is removing itself, we must take care
1190 * not to dereference it after the dict_remove.
1192 bot = cmd->parent->bot;
1193 module = cmd->command->parent;
1194 dict_remove(service->commands, bound->name);
1195 send_message(user, bot, "MCMSG_COMMAND_UNBOUND", cmdname, service->bot->nick);
1196 if (service_recheck_bindings(service, module))
1197 send_message(user, bot, "MCMSG_HELPFILE_UNBOUND", module->name, module->name);
1201 static MODCMD_FUNC(cmd_readhelp) {
1202 const char *modname;
1203 struct module *module;
1204 struct helpfile *old_helpfile;
1205 struct timeval start, stop;
1209 if (!(module = module_find(modname))) {
1210 reply("MSG_MODULE_UNKNOWN", modname);
1213 if (!module->helpfile_name) {
1214 reply("MCMSG_NO_HELPFILE", module->name);
1217 old_helpfile = module->helpfile;
1218 gettimeofday(&start, NULL);
1219 module->helpfile = open_helpfile(module->helpfile_name, module->expand_help);
1220 if (!module->helpfile) {
1221 module->helpfile = old_helpfile;
1222 reply("MCMSG_HELPFILE_ERROR", module->helpfile_name);
1225 if (old_helpfile) close_helpfile(old_helpfile);
1226 gettimeofday(&stop, NULL);
1227 stop.tv_sec -= start.tv_sec;
1228 stop.tv_usec -= start.tv_usec;
1229 if (stop.tv_usec < 0) {
1231 stop.tv_usec += 1000000;
1233 reply("MCMSG_HELPFILE_READ", module->name, (unsigned long)stop.tv_sec, (unsigned long)stop.tv_usec/1000);
1237 static MODCMD_FUNC(cmd_help) {
1240 topic = (argc < 2) ? NULL : unsplit_string(argv+1, argc-1, NULL);
1241 return svccmd_send_help_2(user, cmd->parent, topic);
1244 static MODCMD_FUNC(cmd_timecmd) {
1245 struct timeval start, stop;
1246 char cmd_text[MAXLEN];
1248 unsplit_string(argv+1, argc-1, cmd_text);
1249 gettimeofday(&start, NULL);
1250 svccmd_invoke(user, cmd->parent, channel, cmd_text, 0);
1251 gettimeofday(&stop, NULL);
1252 stop.tv_sec -= start.tv_sec;
1253 stop.tv_usec -= start.tv_usec;
1254 if (stop.tv_usec < 0) {
1256 stop.tv_usec += 1000000;
1258 reply("MCMSG_COMMAND_TIME", cmd_text, (unsigned long)stop.tv_sec, (unsigned long)stop.tv_usec);
1262 static MODCMD_FUNC(cmd_command) {
1263 struct svccmd *svccmd;
1264 const char *cmd_name, *fmt_str;
1265 unsigned int flags, shown_flags, nn, pos;
1269 cmd_name = unsplit_string(argv+1, argc-1, NULL);
1270 if (!(svccmd = svccmd_resolve_name(cmd, cmd_name))) {
1271 reply("MCMSG_UNKNOWN_COMMAND_2", cmd_name, cmd->parent->bot->nick);
1274 pos = snprintf(buf, sizeof(buf), "%s.%s", svccmd->command->parent->name, svccmd->command->name);
1275 if (svccmd->alias.used) {
1277 unsplit_string((char**)svccmd->alias.list+1, svccmd->alias.used-1, buf+pos);
1278 reply("MCMSG_COMMAND_ALIASES", svccmd->name, buf);
1280 reply("MCMSG_COMMAND_BINDING", svccmd->name, buf);
1282 flags = svccmd->effective_flags;
1283 if ((svccmd->parent && svccmd->parent->privileged && !IsOper(user))
1284 || ((flags & MODCMD_REQUIRE_STAFF)
1285 && !IsOper(user) && !IsNetworkHelper(user) && !IsSupportHelper(user))) {
1286 reply("MCMSG_INSPECTION_REFUSED", svccmd->name);
1289 if (flags & MODCMD_DISABLED) {
1290 reply("MSG_COMMAND_DISABLED", svccmd->name);
1294 if (svccmd->min_opserv_level > 0) {
1295 reply("MCMSG_NEED_OPSERV_LEVEL", svccmd->min_opserv_level);
1296 shown_flags |= MODCMD_REQUIRE_OPER | MODCMD_REQUIRE_AUTHED;
1298 if (svccmd->min_channel_access > 0) {
1299 reply("MCMSG_NEED_CHANSERV_LEVEL", svccmd->min_channel_access);
1300 shown_flags |= MODCMD_REQUIRE_CHANUSER | MODCMD_REQUIRE_REGCHAN | MODCMD_REQUIRE_CHANNEL | MODCMD_REQUIRE_AUTHED;
1302 if (svccmd->req_account_flags) {
1303 for (nn=pos=0; nn<32; nn++) {
1304 if (!(svccmd->req_account_flags & (1 << nn))) continue;
1305 buf[pos++] = HANDLE_FLAGS[nn];
1308 reply("MCMSG_NEED_ACCOUNT_FLAGS", buf);
1309 shown_flags |= MODCMD_REQUIRE_AUTHED;
1311 if (!flags && !shown_flags) {
1312 reply("MCMSG_NEED_NOTHING", svccmd->name);
1315 if (flags & ~shown_flags & MODCMD_REQUIRE_HELPING) {
1316 reply("MCMSG_MUST_BE_HELPING");
1317 shown_flags |= MODCMD_REQUIRE_AUTHED | MODCMD_REQUIRE_STAFF;
1319 if (flags & ~shown_flags & MODCMD_REQUIRE_STAFF) {
1320 switch (flags & MODCMD_REQUIRE_STAFF) {
1321 default: case MODCMD_REQUIRE_STAFF:
1322 fmt_str = "MCMSG_NEED_STAFF_ACCESS";
1324 case MODCMD_REQUIRE_OPER:
1325 fmt_str = "MCMSG_NEED_STAFF_OPER";
1327 case MODCMD_REQUIRE_NETWORK_HELPER:
1328 fmt_str = "MCMSG_NEED_STAFF_NETHELPER";
1330 case MODCMD_REQUIRE_OPER|MODCMD_REQUIRE_NETWORK_HELPER:
1331 fmt_str = "MCMSG_NEED_STAFF_NETHELPER_OR_OPER";
1333 case MODCMD_REQUIRE_SUPPORT_HELPER:
1334 fmt_str = "MCMSG_NEED_STAFF_SHELPER";
1336 case MODCMD_REQUIRE_OPER|MODCMD_REQUIRE_SUPPORT_HELPER:
1337 fmt_str = "MCMSG_NEED_STAFF_SHELPER_OR_OPER";
1339 case MODCMD_REQUIRE_SUPPORT_HELPER|MODCMD_REQUIRE_NETWORK_HELPER:
1340 fmt_str = "MCMSG_NEED_STAFF_HELPER";
1344 shown_flags |= MODCMD_REQUIRE_AUTHED | MODCMD_REQUIRE_STAFF;
1346 if (flags & ~shown_flags & MODCMD_REQUIRE_JOINABLE) {
1347 reply("MCMSG_NEED_JOINABLE");
1348 shown_flags |= MODCMD_REQUIRE_CHANUSER;
1350 if (flags & ~shown_flags & MODCMD_REQUIRE_CHANUSER) {
1351 if (flags & ~shown_flags & MODCMD_IGNORE_CSUSPEND)
1352 reply("MCMSG_NEED_CHANUSER_CSUSPENDABLE");
1354 reply("MCMSG_NEED_CHANUSER");
1355 shown_flags |= MODCMD_IGNORE_CSUSPEND | MODCMD_REQUIRE_REGCHAN | MODCMD_REQUIRE_CHANNEL | MODCMD_REQUIRE_AUTHED;
1357 if (flags & ~shown_flags & MODCMD_REQUIRE_REGCHAN) {
1358 reply("MCMSG_NEED_REGCHAN");
1359 shown_flags |= MODCMD_REQUIRE_CHANNEL;
1361 if (flags & ~shown_flags & MODCMD_REQUIRE_CHANNEL)
1362 reply("MCMSG_NEED_CHANNEL");
1363 if (flags & ~shown_flags & MODCMD_REQUIRE_AUTHED)
1364 reply("MCMSG_NEED_AUTHED");
1365 if (flags & ~shown_flags & MODCMD_TOY)
1366 reply("MCMSG_IS_TOY", svccmd->name);
1367 if (flags & ~shown_flags & MODCMD_REQUIRE_QUALIFIED) {
1368 const char *botnick = svccmd->parent ? svccmd->parent->bot->nick : "SomeBot";
1369 reply("MCMSG_MUST_QUALIFY", botnick, svccmd->name, botnick);
1371 reply("MCMSG_END_REQUIREMENTS", svccmd->name);
1376 modcmd_describe_command(struct userNode *user, struct svccmd *cmd, struct svccmd *target) {
1377 char buf1[MAXLEN], buf2[MAXLEN];
1378 unsigned int ii, len, buf1_used, buf2_used;
1380 if (target->alias.used) {
1381 unsplit_string((char**)target->alias.list, target->alias.used, buf1);
1382 reply("MCMSG_COMMAND_ALIASES", target->name, buf1);
1384 snprintf(buf1, sizeof(buf1), "%s.%s", target->command->parent->name, target->command->name);
1385 reply("MCMSG_COMMAND_BINDING", target->name, buf1);
1387 for (ii = buf1_used = buf2_used = 0; flags[ii].name; ++ii) {
1388 if (target->flags & flags[ii].flag) {
1390 buf1[buf1_used++] = ',';
1391 len = strlen(flags[ii].name);
1392 memcpy(buf1 + buf1_used, flags[ii].name, len);
1394 } else if (target->effective_flags & flags[ii].flag) {
1396 buf2[buf2_used++] = ',';
1397 len = strlen(flags[ii].name);
1398 memcpy(buf2 + buf2_used, flags[ii].name, len);
1403 buf1[buf1_used] = '\0';
1405 strcpy(buf1, user_find_message(user, "MSG_NONE"));
1407 buf2[buf2_used] = '\0';
1409 strcpy(buf2, user_find_message(user, "MSG_NONE"));
1410 reply("MCMSG_COMMAND_FLAGS", buf1, buf2);
1411 for (ii = buf1_used = buf2_used = 0; handle_flags[ii]; ++ii) {
1412 if (target->req_account_flags & (1 << ii))
1413 buf1[buf1_used++] = handle_flags[ii];
1414 else if (target->deny_account_flags & (1 << ii))
1415 buf2[buf2_used++] = handle_flags[ii];
1417 buf1[buf1_used] = buf2[buf2_used] = '\0';
1418 reply("MCMSG_COMMAND_ACCOUNT_FLAGS", buf1, buf2);
1419 reply("MCMSG_COMMAND_ACCESS_LEVEL", target->min_channel_access, target->min_opserv_level);
1420 reply("MCMSG_COMMAND_USES", target->name, target->uses);
1423 static MODCMD_FUNC(cmd_modcmd) {
1424 struct svccmd *svccmd;
1425 unsigned int arg, changed;
1426 char cmdname[MAXLEN];
1429 arg = collapse_cmdname(argv+1, argc-1, cmdname) + 1;
1431 reply("MSG_MISSING_PARAMS", cmd->name);
1434 if (!(svccmd = svccmd_resolve_name(cmd, cmdname))) {
1435 reply("MCMSG_UNKNOWN_COMMAND_2", cmdname, cmd->parent->bot->nick);
1438 for (changed = 0; arg+1 < argc; arg += 2) {
1439 if (svccmd_configure(svccmd, user, cmd->parent->bot, argv[arg], argv[arg+1])) {
1440 reply("MCMSG_COMMAND_MODIFIED", argv[arg], svccmd->name);
1445 modcmd_set_effective_flags(svccmd);
1446 modcmd_describe_command(user, cmd, svccmd);
1450 static MODCMD_FUNC(cmd_god) {
1454 if (enabled_string(argv[1])) {
1455 if (HANDLE_FLAGGED(user->handle_info, HELPING)) {
1456 reply("MCMSG_ALREADY_HELPING");
1460 } else if (disabled_string(argv[1])) {
1461 if (!HANDLE_FLAGGED(user->handle_info, HELPING)) {
1462 reply("MCMSG_ALREADY_NOT_HELPING");
1467 reply("MSG_INVALID_BINARY", argv[1]);
1471 helping = !IsHelping(user);
1475 HANDLE_SET_FLAG(user->handle_info, HELPING);
1476 reply("MCMSG_NOW_HELPING");
1478 HANDLE_CLEAR_FLAG(user->handle_info, HELPING);
1479 reply("MCMSG_NOW_NOT_HELPING");
1485 static MODCMD_FUNC(cmd_joiner) {
1486 char cmdname[MAXLEN];
1489 int len = sprintf(cmdname, "%s ", cmd->name);
1491 struct string_buffer sbuf;
1493 string_buffer_init(&sbuf);
1494 for (it = dict_first(cmd->parent->commands); it; it = iter_next(it)) {
1495 if (!ircncasecmp(iter_key(it), cmdname, len)) {
1496 if (sbuf.used) string_buffer_append_string(&sbuf, ", ");
1497 string_buffer_append_string(&sbuf, iter_key(it));
1500 if (!sbuf.used) string_buffer_append(&sbuf, 0);
1501 reply("MCMSG_JOINER_CHOICES", cmd->name, sbuf.list);
1502 string_buffer_clean(&sbuf);
1505 sprintf(cmdname, "%s %s", cmd->name, argv[1]);
1507 svccmd_invoke_argv(user, cmd->parent, channel, argc-1, argv+1, 0);
1508 return 0; /* never try to log this; the recursive one logs it */
1511 static MODCMD_FUNC(cmd_stats_modules) {
1512 struct helpfile_table tbl;
1516 struct modcmd *modcmd;
1519 tbl.length = dict_size(modules) + 1;
1521 tbl.flags = TABLE_PAD_LEFT;
1522 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1523 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1524 tbl.contents[0][0] = "Module";
1525 tbl.contents[0][1] = "Commands";
1526 tbl.contents[0][2] = "Helpfile";
1527 for (ii=1, it=dict_first(modules); it; it=iter_next(it), ii++) {
1528 mod = iter_data(it);
1529 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1530 tbl.contents[ii][0] = mod->name;
1531 tbl.contents[ii][1] = strtab(dict_size(mod->commands));
1532 tbl.contents[ii][2] = mod->helpfile_name ? mod->helpfile_name : "(none)";
1534 } else if (!(mod = dict_find(modules, argv[1], NULL))) {
1535 reply("MCMSG_UNKNOWN_MODULE", argv[1]);
1538 reply("MCMSG_MODULE_INFO", mod->name);
1539 tbl.length = dict_size(mod->commands) + 1;
1541 tbl.flags = TABLE_PAD_LEFT;
1542 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1543 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1544 tbl.contents[0][0] = "Command";
1545 tbl.contents[0][1] = "Min. Args";
1546 tbl.contents[0][2] = "Bind Count";
1547 for (ii=1, it=dict_first(mod->commands); it; it=iter_next(it), ii++) {
1548 modcmd = iter_data(it);
1549 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1550 tbl.contents[ii][0] = modcmd->name;
1551 tbl.contents[ii][1] = strtab(modcmd->min_argc);
1552 tbl.contents[ii][2] = strtab(modcmd->bind_count);
1555 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1559 static MODCMD_FUNC(cmd_stats_services) {
1560 struct helpfile_table tbl;
1563 struct service *service;
1564 struct svccmd *svccmd;
1568 tbl.length = dict_size(services) + 1;
1570 tbl.flags = TABLE_PAD_LEFT;
1571 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1572 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1573 tbl.contents[0][0] = "Service";
1574 tbl.contents[0][1] = "Commands";
1575 tbl.contents[0][2] = "Priv'd?";
1576 tbl.contents[0][3] = "Trigger";
1577 extra = calloc(2, tbl.length);
1578 for (ii=1, it=dict_first(services); it; it=iter_next(it), ii++) {
1579 service = iter_data(it);
1580 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1581 tbl.contents[ii][0] = service->bot->nick;
1582 tbl.contents[ii][1] = strtab(dict_size(service->commands));
1583 tbl.contents[ii][2] = service->privileged ? "yes" : "no";
1584 extra[ii*2] = service->trigger;
1585 tbl.contents[ii][3] = extra+ii*2;
1587 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1590 } else if (!(service = dict_find(services, argv[1], NULL))) {
1591 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1594 tbl.length = dict_size(service->commands) + 1;
1596 tbl.flags = TABLE_PAD_LEFT | TABLE_NO_FREE;
1597 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1598 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1599 tbl.contents[0][0] = "Command";
1600 tbl.contents[0][1] = "Module";
1601 tbl.contents[0][2] = "ModCmd";
1602 tbl.contents[0][3] = "Alias?";
1603 tbl.contents[0][4] = strdup("Uses");
1604 for (ii=1, it=dict_first(service->commands); it; it=iter_next(it), ii++) {
1605 svccmd = iter_data(it);
1606 tbl.contents[ii] = calloc(tbl.width, sizeof(tbl.contents[ii][0]));
1607 tbl.contents[ii][0] = svccmd->name;
1608 tbl.contents[ii][1] = svccmd->command->parent->name;
1609 tbl.contents[ii][2] = svccmd->command->name;
1610 tbl.contents[ii][3] = svccmd->alias.used ? "yes" : "no";
1611 tbl.contents[ii][4] = extra = malloc(12);
1612 sprintf(extra, "%u", svccmd->uses);
1614 reply("MCMSG_SERVICE_INFO", service->bot->nick);
1615 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1616 for (ii=0; ii<tbl.length; ii++) {
1617 free((char*)tbl.contents[ii][4]);
1618 free(tbl.contents[ii]);
1625 static MODCMD_FUNC(cmd_showcommands) {
1626 struct svccmd_list commands;
1627 struct helpfile_table tbl;
1628 struct svccmd *svccmd;
1630 unsigned int ii, ignore_flags = 0;
1631 unsigned int max_opserv_level = 1000;
1632 unsigned short max_chanserv_level = 500;
1633 char show_opserv_level = 0, show_channel_access = 0;
1635 /* Check to see what the max access they want to see is. */
1636 for (ii=1; ii<argc; ++ii) {
1637 if (isdigit(argv[ii][0]))
1638 max_opserv_level = atoi(argv[ii]);
1640 max_chanserv_level = user_level_from_name(argv[ii], UL_OWNER);
1643 /* Find the matching commands. */
1644 svccmd_list_init(&commands);
1645 if (cmd->parent->privileged)
1646 ignore_flags = MODCMD_REQUIRE_OPER;
1647 for (it = dict_first(cmd->parent->commands); it; it = iter_next(it)) {
1648 svccmd = iter_data(it);
1649 if (strchr(svccmd->name, ' '))
1651 if (!svccmd_can_invoke(user, svccmd->parent->bot, svccmd, channel, SVCCMD_QUALIFIED))
1653 if (svccmd->min_opserv_level > max_opserv_level)
1655 if (svccmd->min_channel_access > max_chanserv_level)
1657 if (svccmd->min_opserv_level > 0)
1658 show_opserv_level = 1;
1659 if (svccmd->min_channel_access > 0)
1660 show_channel_access = 1;
1661 if (svccmd->effective_flags
1662 & (MODCMD_REQUIRE_STAFF|MODCMD_REQUIRE_HELPING)
1664 show_channel_access = 1;
1666 svccmd_list_append(&commands, svccmd);
1669 /* Build the table. */
1670 tbl.length = commands.used + 1;
1671 tbl.width = 1 + show_opserv_level + show_channel_access;
1672 tbl.flags = TABLE_REPEAT_ROWS;
1673 tbl.contents = calloc(tbl.length, sizeof(tbl.contents[0]));
1674 tbl.contents[0] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1675 tbl.contents[0][ii = 0] = "Command";
1676 if (show_opserv_level)
1677 tbl.contents[0][++ii] = "OpServ Level";
1678 if (show_channel_access)
1679 tbl.contents[0][++ii] = "ChanServ Access";
1680 for (ii=0; ii<commands.used; ++ii) {
1681 svccmd = commands.list[ii];
1682 tbl.contents[ii+1] = calloc(tbl.width, sizeof(tbl.contents[0][0]));
1683 tbl.contents[ii+1][0] = svccmd->name;
1684 if (show_opserv_level)
1685 tbl.contents[ii+1][1] = strtab(svccmd->min_opserv_level);
1686 if (show_channel_access) {
1688 int flags = svccmd->effective_flags;
1689 if (flags & MODCMD_REQUIRE_HELPING)
1691 else if (flags & MODCMD_REQUIRE_STAFF) {
1692 if (flags & MODCMD_REQUIRE_OPER)
1694 else if (flags & MODCMD_REQUIRE_NETWORK_HELPER)
1695 access = "net.helper";
1699 access = strtab(svccmd->min_channel_access);
1700 tbl.contents[ii+1][1+show_opserv_level] = access;
1703 svccmd_list_clean(&commands);
1704 table_send(cmd->parent->bot, user->nick, 0, 0, tbl);
1708 static MODCMD_FUNC(cmd_helpfiles) {
1709 struct service *service;
1712 if (!(service = dict_find(services, argv[1], NULL))) {
1713 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1718 for (ii=0; ii<service->modules.used; ++ii)
1719 reply("MCMSG_HELPFILE_SEQUENCE", ii+1, service->modules.list[ii]->name);
1723 service->modules.used = 0;
1724 for (ii=0; ii<argc-2; ii++) {
1725 struct module *module = dict_find(modules, argv[ii+2], NULL);
1727 reply("MCMSG_UNKNOWN_MODULE", argv[ii+2]);
1730 module_list_append(&service->modules, module);
1732 reply("MCMSG_HELPFILE_SEQUENCE_SET", service->bot->nick);
1736 static MODCMD_FUNC(cmd_service_add) {
1737 const char *nick, *hostname, *desc;
1738 struct userNode *bot;
1741 if (!is_valid_nick(nick)) {
1742 reply("MCMSG_BAD_SERVICE_NICK", nick);
1746 desc = unsplit_string(argv+3, argc-3, NULL);
1747 bot = GetUserH(nick);
1748 if (bot && IsService(bot)) {
1749 reply("MCMSG_ALREADY_SERVICE", bot->nick);
1752 bot = AddLocalUser(nick, nick, hostname, desc, NULL);
1753 service_register(bot);
1754 reply("MCMSG_NEW_SERVICE", bot->nick);
1758 static MODCMD_FUNC(cmd_service_rename) {
1759 struct service *service;
1761 if (!(service = service_find(argv[1]))) {
1762 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1765 NickChange(service->bot, argv[2], 0);
1766 reply("MCMSG_SERVICE_RENAMED", service->bot->nick);
1770 static MODCMD_FUNC(cmd_service_trigger) {
1771 struct userNode *bogon;
1772 struct service *service;
1774 if (!(service = service_find(argv[1]))) {
1775 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1779 if (service->trigger)
1780 reply("MCMSG_CURRENT_TRIGGER", service->bot->nick, service->trigger);
1782 reply("MCMSG_NO_TRIGGER", service->bot->nick);
1785 if (service->trigger)
1786 reg_chanmsg_func(service->trigger, NULL, NULL);
1787 if (!irccasecmp(argv[2], "none") || !irccasecmp(argv[2], "remove")) {
1788 service->trigger = 0;
1789 reply("MCMSG_REMOVED_TRIGGER", service->bot->nick);
1790 } else if ((bogon = get_chanmsg_bot(argv[2][0]))) {
1791 reply("MCMSG_DUPLICATE_TRIGGER", bogon->nick, argv[2][0]);
1794 service->trigger = argv[2][0];
1795 reg_chanmsg_func(service->trigger, service->bot, modcmd_chanmsg);
1796 reply("MCMSG_NEW_TRIGGER", service->bot->nick, service->trigger);
1801 static MODCMD_FUNC(cmd_service_privileged) {
1802 struct service *service;
1805 if (!(service = service_find(argv[1]))) {
1806 reply("MCMSG_UNKNOWN_SERVICE", argv[1]);
1810 service->privileged = true_string(argv[2]) || enabled_string(argv[2]);
1811 newval = user_find_message(user, service->privileged ? "MSG_ON" : "MSG_OFF");
1812 reply("MCMSG_SERVICE_PRIVILEGED", service->bot->nick, newval);
1816 static MODCMD_FUNC(cmd_service_remove) {
1817 char *name, *reason;
1818 struct service *service;
1822 reason = unsplit_string(argv+2, argc-2, NULL);
1824 reason = "Removing bot";
1825 if (!(service = service_find(name))) {
1826 reply("MCMSG_UNKNOWN_SERVICE", name);
1829 DelUser(service->bot, NULL, 1, reason);
1830 reply("MCMSG_SERVICE_REMOVED", name);
1831 dict_remove(services, name);
1835 static MODCMD_FUNC(cmd_dump_messages) {
1836 const char *fname = "strings.db";
1837 struct saxdb_context *ctx;
1842 if (!(pf = fopen(fname, "w"))) {
1843 reply("MCMSG_FILE_NOT_OPENED", fname);
1846 if (!(ctx = saxdb_open_context(pf))) {
1847 reply("MSG_INTERNAL_FAILURE");
1850 if ((res = setjmp(*saxdb_jmp_buf(ctx))) != 0) {
1851 saxdb_close_context(ctx, 1);
1852 reply("MCMSG_MESSAGE_DUMP_FAILED", strerror(res));
1855 for (it = dict_first(lang_C->messages); it; it = iter_next(it))
1856 saxdb_write_string(ctx, iter_key(it), iter_data(it));
1857 saxdb_close_context(ctx, 1);
1858 reply("MCMSG_MESSAGES_DUMPED", fname);
1863 static MODCMD_FUNC(cmd_version) {
1864 /* This function provides copyright management information to end
1865 * users of srvx. You should not alter, disable or remove this
1866 * command or its accessibility to normal IRC users, except to add
1867 * copyright information pertaining to changes you make to srvx.
1869 send_message_type(4, user, cmd->parent->bot, "$b"PACKAGE_STRING"$b ("CODENAME"), Built: "__DATE__", "__TIME__". Copyright 2000-2007 srvx Development Team.");
1871 send_message_type(4, user, cmd->parent->bot, "%s", git_version);
1873 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.");
1877 static MODCMD_FUNC(cmd_tell) {
1878 struct userNode *target;
1881 target = GetUserH(argv[1]);
1882 msg = unsplit_string(argv + 2, argc - 2, NULL);
1884 reply("MSG_NOT_TARGET_NAME");
1887 send_message_type(MSG_TYPE_NOXLATE, target, cmd->parent->bot, "%s", msg);
1892 modcmd_nick_change(struct userNode *user, const char *old_nick) {
1893 struct service *svc;
1894 if (!(svc = dict_find(services, old_nick, NULL)))
1896 dict_remove2(services, old_nick, 1);
1897 dict_insert(services, user->nick, svc);
1901 modcmd_cleanup(void) {
1902 dict_delete(services);
1903 dict_delete(modules);
1909 modcmd_saxdb_write_command(struct saxdb_context *ctx, struct svccmd *cmd) {
1911 unsigned int nn, len, pos;
1912 struct svccmd *template = cmd->command->defaults;
1914 saxdb_start_record(ctx, cmd->name, 0);
1915 sprintf(buf, "%s.%s", cmd->command->parent->name, cmd->command->name);
1916 saxdb_write_string(ctx, "command", buf);
1917 if (cmd->alias.used)
1918 saxdb_write_string_list(ctx, "aliased", &cmd->alias);
1919 if (cmd->min_opserv_level != template->min_opserv_level)
1920 saxdb_write_int(ctx, "oper_access", cmd->min_opserv_level);
1921 if (cmd->min_channel_access != template->min_channel_access)
1922 saxdb_write_int(ctx, "channel_access", cmd->min_channel_access);
1923 if (cmd->flags != template->flags) {
1925 for (nn=pos=0; flags[nn].name; ++nn) {
1926 if (cmd->flags & flags[nn].flag) {
1928 len = strlen(flags[nn].name);
1929 memcpy(buf+pos, flags[nn].name, len);
1938 saxdb_write_string(ctx, "flags", buf);
1940 if ((cmd->req_account_flags != template->req_account_flags)
1941 || (cmd->deny_account_flags != template->req_account_flags)) {
1943 if (cmd->req_account_flags) {
1945 for (nn=0; nn<32; nn++)
1946 if (cmd->req_account_flags & (1 << nn))
1947 buf[pos++] = handle_flags[nn];
1949 if (cmd->deny_account_flags) {
1951 for (nn=0; nn<32; nn++)
1952 if (cmd->deny_account_flags & (1 << nn))
1953 buf[pos++] = handle_flags[nn];
1956 saxdb_write_string(ctx, "account_flags", buf);
1958 saxdb_end_record(ctx);
1962 modcmd_saxdb_write(struct saxdb_context *ctx) {
1963 struct string_list slist;
1964 dict_iterator_t it, it2;
1965 struct service *service;
1968 saxdb_start_record(ctx, "bots", 1);
1969 for (it = dict_first(services); it; it = iter_next(it)) {
1971 service = iter_data(it);
1972 saxdb_start_record(ctx, service->bot->nick, 1);
1973 if (service->trigger) {
1974 buff[0] = service->trigger;
1976 saxdb_write_string(ctx, "trigger", buff);
1978 saxdb_write_string(ctx, "description", service->bot->info);
1979 saxdb_write_string(ctx, "hostname", service->bot->hostname);
1980 if (service->privileged)
1981 saxdb_write_string(ctx, "privileged", "1");
1982 saxdb_end_record(ctx);
1984 saxdb_end_record(ctx);
1986 saxdb_start_record(ctx, "services", 1);
1987 for (it = dict_first(services); it; it = iter_next(it)) {
1988 service = iter_data(it);
1989 saxdb_start_record(ctx, service->bot->nick, 1);
1990 for (it2 = dict_first(service->commands); it2; it2 = iter_next(it2))
1991 modcmd_saxdb_write_command(ctx, iter_data(it2));
1992 saxdb_end_record(ctx);
1994 saxdb_end_record(ctx);
1996 saxdb_start_record(ctx, "helpfiles", 1);
1998 for (it = dict_first(services); it; it = iter_next(it)) {
1999 service = iter_data(it);
2001 for (ii = 0; ii < service->modules.used; ++ii)
2002 string_list_append(&slist, service->modules.list[ii]->name);
2003 saxdb_write_string_list(ctx, iter_key(it), &slist);
2007 saxdb_end_record(ctx);
2013 append_entry(const char *key, UNUSED_ARG(void *data), void *extra) {
2014 struct helpfile_expansion *exp = extra;
2015 int row = exp->value.table.length++;
2016 exp->value.table.contents[row] = calloc(1, sizeof(char*));
2017 exp->value.table.contents[row][0] = key;
2021 static struct helpfile_expansion
2022 modcmd_expand(const char *variable) {
2023 struct helpfile_expansion exp;
2024 extern struct userNode *message_source;
2025 struct service *service;
2027 service = dict_find(services, message_source->nick, NULL);
2028 if (!irccasecmp(variable, "index")) {
2029 exp.type = HF_TABLE;
2030 exp.value.table.length = 1;
2031 exp.value.table.width = 1;
2032 exp.value.table.flags = TABLE_REPEAT_ROWS;
2033 exp.value.table.contents = calloc(dict_size(service->commands)+1, sizeof(char**));
2034 exp.value.table.contents[0] = calloc(1, sizeof(char*));
2035 exp.value.table.contents[0][0] = "Commands:";
2036 dict_foreach(service->commands, append_entry, &exp);
2038 } else if (!irccasecmp(variable, "languages")) {
2039 struct string_buffer sbuf;
2041 sbuf.used = sbuf.size = 0;
2043 for (it = dict_first(languages); it; it = iter_next(it)) {
2044 string_buffer_append_string(&sbuf, iter_key(it));
2045 string_buffer_append(&sbuf, ' ');
2047 sbuf.list[--sbuf.used] = 0;
2048 exp.type = HF_STRING;
2049 exp.value.str = sbuf.list;
2052 exp.type = HF_STRING;
2053 exp.value.str = NULL;
2058 modcmd_load_bots(struct dict *db, int default_nick) {
2061 for (it = dict_first(db); it; it = iter_next(it)) {
2062 struct record_data *rd;
2063 struct service *svc;
2064 const char *nick, *desc, *hostname;
2067 if (rd->type != RECDB_OBJECT) {
2068 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'bots/%s' in modcmd db (expected object).", iter_key(it));
2071 nick = database_get_data(rd->d.object, "nick", RECDB_QSTRING);
2074 nick = iter_key(it);
2078 svc = service_find(nick);
2079 desc = database_get_data(rd->d.object, "description", RECDB_QSTRING);
2080 hostname = database_get_data(rd->d.object, "hostname", RECDB_QSTRING);
2083 svc = service_register(AddLocalUser(nick, nick, hostname, desc, NULL));
2085 strcpy(svc->bot->hostname, hostname);
2086 desc = database_get_data(rd->d.object, "trigger", RECDB_QSTRING);
2088 svc->trigger = desc[0];
2089 desc = database_get_data(rd->d.object, "privileged", RECDB_QSTRING);
2090 if (desc && (true_string(desc) || enabled_string(desc)))
2091 svc->privileged = 1;
2097 modcmd_conf_read(void) {
2098 modcmd_load_bots(conf_get_data("services", RECDB_OBJECT), 0);
2103 qsort(flags, ArrayLength(flags)-1, sizeof(flags[0]), flags_qsort);
2104 modules = dict_new();
2105 dict_set_free_data(modules, free_module);
2106 services = dict_new();
2107 dict_set_free_data(services, free_service);
2108 reg_nick_change_func(modcmd_nick_change);
2109 reg_exit_func(modcmd_cleanup);
2110 conf_register_reload(modcmd_conf_read);
2112 modcmd_module = module_register("modcmd", MAIN_LOG, "modcmd.help", modcmd_expand);
2113 bind_command = modcmd_register(modcmd_module, "bind", cmd_bind, 4, MODCMD_KEEP_BOUND, "oper_level", "800", NULL);
2114 help_command = modcmd_register(modcmd_module, "help", cmd_help, 1, 0, "flags", "+nolog", NULL);
2115 modcmd_register(modcmd_module, "command", cmd_command, 2, 0, "flags", "+nolog", NULL);
2116 modcmd_register(modcmd_module, "modcmd", cmd_modcmd, 2, MODCMD_KEEP_BOUND, "template", "bind", NULL);
2117 modcmd_register(modcmd_module, "god", cmd_god, 0, MODCMD_REQUIRE_AUTHED, "flags", "+oper,+networkhelper", NULL);
2118 modcmd_register(modcmd_module, "readhelp", cmd_readhelp, 2, 0, "oper_level", "650", NULL);
2119 modcmd_register(modcmd_module, "timecmd", cmd_timecmd, 2, 0, "oper_level", "1", NULL);
2120 modcmd_register(modcmd_module, "unbind", cmd_unbind, 3, 0, "template", "bind", NULL);
2121 modcmd_register(modcmd_module, "joiner", cmd_joiner, 1, 0, NULL);
2122 modcmd_register(modcmd_module, "stats modules", cmd_stats_modules, 1, 0, "flags", "+oper", NULL);
2123 modcmd_register(modcmd_module, "stats services", cmd_stats_services, 1, 0, "flags", "+oper", NULL);
2124 modcmd_register(modcmd_module, "showcommands", cmd_showcommands, 1, 0, "flags", "+acceptchan", NULL);
2125 modcmd_register(modcmd_module, "helpfiles", cmd_helpfiles, 2, 0, "template", "bind", NULL);
2126 modcmd_register(modcmd_module, "service add", cmd_service_add, 4, 0, "flags", "+oper", NULL);
2127 modcmd_register(modcmd_module, "service rename", cmd_service_rename, 3, 0, "flags", "+oper", NULL);
2128 modcmd_register(modcmd_module, "service trigger", cmd_service_trigger, 2, 0, "flags", "+oper", NULL);
2129 modcmd_register(modcmd_module, "service privileged", cmd_service_privileged, 2, 0, "flags", "+oper", NULL);
2130 modcmd_register(modcmd_module, "service remove", cmd_service_remove, 2, 0, "flags", "+oper", NULL);
2131 modcmd_register(modcmd_module, "dumpmessages", cmd_dump_messages, 1, 0, "oper_level", "1000", NULL);
2132 modcmd_register(modcmd_module, "tell", cmd_tell, 3, 0, "flags", "+oper", NULL);
2133 version_command = modcmd_register(modcmd_module, "version", cmd_version, 1, 0, NULL);
2134 message_register_table(msgtab);
2138 modcmd_db_load_command(struct service *service, const char *cmdname, struct dict *obj) {
2139 struct svccmd *svccmd;
2140 struct module *module;
2141 struct modcmd *modcmd;
2142 struct string_list *slist;
2143 const char *str, *sep;
2146 str = database_get_data(obj, "command", RECDB_QSTRING);
2148 log_module(MAIN_LOG, LOG_ERROR, "Missing command for service %s command %s in modcmd.db", service->bot->nick, cmdname);
2151 sep = strchr(str, '.');
2153 log_module(MAIN_LOG, LOG_ERROR, "Invalid command %s for service %s command %s in modcmd.db", str, service->bot->nick, cmdname);
2156 memcpy(buf, str, sep-str);
2158 if (!(module = module_find(buf))) {
2159 log_module(MAIN_LOG, LOG_ERROR, "Unknown module %s for service %s command %s in modcmd.db", buf, service->bot->nick, cmdname);
2162 if (!(modcmd = dict_find(module->commands, sep+1, NULL))) {
2163 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);
2166 /* Now that we know we have a command to use, fill in the basics. */
2167 svccmd = calloc(1, sizeof(*svccmd));
2168 svccmd_insert(service, strdup(cmdname), svccmd, modcmd);
2169 if ((str = database_get_data(obj, "template", RECDB_QSTRING))) {
2170 add_pending_template(svccmd, str);
2172 svccmd_copy_rules(svccmd, modcmd->defaults);
2174 if ((str = database_get_data(obj, "account_flags", RECDB_QSTRING))) {
2175 svccmd->req_account_flags = svccmd->deny_account_flags = 0;
2176 svccmd_configure(svccmd, NULL, service->bot, "account_flags", str);
2178 if ((str = database_get_data(obj, "flags", RECDB_QSTRING))) {
2180 svccmd_configure(svccmd, NULL, service->bot, "flags", str);
2182 if ((str = database_get_data(obj, "oper_access", RECDB_QSTRING))
2183 || (str = database_get_data(obj, "opserv_level", RECDB_QSTRING))) {
2184 svccmd_configure(svccmd, NULL, service->bot, "oper_access", str);
2186 if ((str = database_get_data(obj, "channel_access", RECDB_QSTRING))
2187 || (str = database_get_data(obj, "chanserv_level", RECDB_QSTRING))) {
2188 svccmd_configure(svccmd, NULL, service->bot, "channel_access", str);
2190 if ((slist = database_get_data(obj, "aliased", RECDB_STRING_LIST))) {
2192 svccmd->alias.used = svccmd->alias.size = slist->used;
2193 svccmd->alias.list = calloc(svccmd->alias.size, sizeof(svccmd->alias.list[0]));
2194 for (nn=0; nn<slist->used; ++nn)
2195 svccmd->alias.list[nn] = strdup(slist->list[nn]);
2197 modcmd_set_effective_flags(svccmd);
2200 static struct svccmd *
2201 service_make_alias(struct service *service, const char *alias, ...) {
2202 char *arg, *argv[MAXNUMPARAMS];
2203 unsigned int nn, argc;
2204 struct svccmd *svccmd, *template;
2207 va_start(args, alias);
2210 arg = va_arg(args, char*);
2216 svccmd = calloc(1, sizeof(*svccmd));
2217 if (!(template = svccmd_resolve_name(svccmd, argv[0]))) {
2218 log_module(MAIN_LOG, LOG_ERROR, "Invalid base command %s for alias %s in service %s", argv[0], alias, service->bot->nick);
2224 svccmd->alias.used = svccmd->alias.size = argc;
2225 svccmd->alias.list = calloc(svccmd->alias.size, sizeof(svccmd->alias.list[0]));
2226 for (nn=0; nn<argc; nn++)
2227 svccmd->alias.list[nn] = strdup(argv[nn]);
2229 svccmd_insert(service, strdup(alias), svccmd, template->command);
2230 svccmd_copy_rules(svccmd, template);
2234 static int saxdb_present;
2237 modcmd_saxdb_read(struct dict *db) {
2239 dict_iterator_t it, it2;
2240 struct record_data *rd, *rd2;
2241 struct service *service;
2243 modcmd_load_bots(database_get_data(db, "bots", RECDB_OBJECT), 1);
2244 db2 = database_get_data(db, "services", RECDB_OBJECT);
2246 log_module(MAIN_LOG, LOG_ERROR, "Missing section 'services' in modcmd db.");
2249 for (it = dict_first(db2); it; it = iter_next(it)) {
2251 if (rd->type != RECDB_OBJECT) {
2252 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'services/%s' in modcmd db (expected object).", iter_key(it));
2255 if (!(service = service_find(iter_key(it)))) {
2256 log_module(MAIN_LOG, LOG_ERROR, "Unknown service '%s' listed in modcmd db.", iter_key(it));
2259 for (it2 = dict_first(rd->d.object); it2; it2 = iter_next(it2)) {
2260 rd2 = iter_data(it2);
2261 if (rd2->type != RECDB_OBJECT) {
2262 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'services/%s/%s' in modcmd db (expected object).", iter_key(it), iter_key(it2));
2265 modcmd_db_load_command(service, iter_key(it2), rd2->d.object);
2268 db2 = database_get_data(db, "helpfiles", RECDB_OBJECT);
2269 for (it = dict_first(db2); it; it = iter_next(it)) {
2270 struct module *module;
2271 struct string_list *slist;
2275 if (rd->type != RECDB_STRING_LIST) {
2276 log_module(MAIN_LOG, LOG_ERROR, "Bad type for 'helpfiles/%s' in modcmd db (expected string list).", iter_key(it));
2279 slist = rd->d.slist;
2280 if (!(service = service_find(iter_key(it)))) {
2281 /* We probably whined about the service being missing above. */
2284 service->modules.used = 0;
2285 for (ii=0; ii<slist->used; ++ii) {
2286 if (!(module = dict_find(modules, slist->list[ii], NULL))) {
2287 log_module(MAIN_LOG, LOG_ERROR, "Unknown module '%s' listed in modcmd 'helpfiles/%s'.", slist->list[ii], iter_key(it));
2290 module_list_append(&service->modules, module);
2298 create_default_binds(void) {
2299 /* Which services should import which modules by default? */
2301 const char *svcname;
2302 /* C is lame and requires a fixed size for this array.
2303 * Be sure you NULL-terminate each array and increment the
2304 * size here if you add more default modules to any
2306 const char *modnames[8];
2308 { "ChanServ", { "ChanServ", NULL } },
2309 { "Global", { "Global", NULL } },
2310 { "NickServ", { "NickServ", NULL } },
2311 { "OpServ", { "OpServ", "modcmd", "sendmail", "saxdb", "proxycheck", NULL } },
2314 unsigned int ii, jj;
2315 char buf[128], *nick;
2316 struct service *service;
2317 struct module *module;
2319 for (ii = 0; def_binds[ii].svcname; ++ii) {
2320 sprintf(buf, "services/%s/nick", def_binds[ii].svcname);
2321 if (!(nick = conf_get_data(buf, RECDB_QSTRING)))
2323 if (!(service = service_find(nick)))
2325 if (dict_size(service->commands) > 0)
2328 /* Bind the default modules for this service to it */
2329 for (jj = 0; def_binds[ii].modnames[jj]; ++jj) {
2330 if (!(module = module_find(def_binds[ii].modnames[jj])))
2332 service_bind_module(service, module);
2335 /* Bind the help and version commands to this service */
2336 service_bind_modcmd(service, help_command, help_command->name);
2337 service_bind_modcmd(service, version_command, version_command->name);
2339 /* Now some silly hax.. (aliases that most people want) */
2340 if (!irccasecmp(def_binds[ii].svcname, "ChanServ")) {
2341 service_make_alias(service, "addowner", "*chanserv.adduser", "$1", "owner", NULL);
2342 service_make_alias(service, "addcoowner", "*chanserv.adduser", "$1", "coowner", NULL);
2343 service_make_alias(service, "addmaster", "*chanserv.adduser", "$1", "master", NULL);
2344 service_make_alias(service, "addop", "*chanserv.adduser", "$1", "op", NULL);
2345 service_make_alias(service, "addpeon", "*chanserv.adduser", "$1", "peon", NULL);
2346 service_make_alias(service, "delowner", "*chanserv.deluser", "owner", "$1", NULL);
2347 service_make_alias(service, "delcoowner", "*chanserv.deluser", "coowner", "$1", NULL);
2348 service_make_alias(service, "delmaster", "*chanserv.deluser", "master", "$1", NULL);
2349 service_make_alias(service, "delop", "*chanserv.deluser", "op", "$1", NULL);
2350 service_make_alias(service, "delpeon", "*chanserv.deluser", "peon", "$1", NULL);
2351 service_make_alias(service, "command", "*modcmd.command", NULL);
2352 service_make_alias(service, "god", "*modcmd.god", NULL);
2353 } else if (!irccasecmp(def_binds[ii].svcname, "OpServ")) {
2354 struct svccmd *svccmd;
2355 svccmd = service_make_alias(service, "stats", "*modcmd.joiner", NULL);
2356 svccmd->min_opserv_level = 101;
2357 svccmd = service_make_alias(service, "service", "*modcmd.joiner", NULL);
2358 svccmd->min_opserv_level = 900;
2364 import_aliases_db() {
2366 dict_iterator_t it, it2;
2367 struct record_data *rd, *rd2;
2368 struct service *service;
2369 struct module *module;
2371 if (!(db = parse_database("aliases.db")))
2373 for (it = dict_first(db); it; it = iter_next(it)) {
2374 service = service_find(iter_key(it));
2377 module = module_find(service->bot->nick);
2379 if (rd->type != RECDB_OBJECT)
2381 for (it2 = dict_first(rd->d.object); it2; it2 = iter_next(it2)) {
2382 struct modcmd *command;
2383 rd2 = iter_data(it2);
2384 if (rd2->type != RECDB_QSTRING)
2386 command = dict_find(module->commands, rd2->d.qstring, NULL);
2389 service_bind_modcmd(service, command, iter_key(it2));
2395 modcmd_finalize(void) {
2398 /* Check databases. */
2399 saxdb_register("modcmd", modcmd_saxdb_read, modcmd_saxdb_write);
2400 create_default_binds();
2402 import_aliases_db();
2404 /* Register services for their triggers. */
2405 for (it = dict_first(services); it; it = iter_next(it)) {
2406 struct service *svc = iter_data(it);
2408 reg_chanmsg_func(svc->trigger, svc->bot, modcmd_chanmsg);
2411 /* Resolve command rule-templates. */
2412 while (pending_templates) {
2413 struct pending_template *ptempl = pending_templates;
2414 struct svccmd *svccmd;
2416 pending_templates = ptempl->next;
2417 /* Only overwrite the current template if we have a valid template. */
2418 if (!strcmp(ptempl->base, "*")) {
2420 } else if ((svccmd = svccmd_resolve_name(ptempl->cmd, ptempl->base))) {
2421 svccmd_copy_rules(ptempl->cmd, svccmd);
2423 assert(ptempl->cmd->parent);
2424 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);