automatic arch-version.h update; CTCP support; helpfile fixes; disk-out-of-space...
[srvx.git] / src / modcmd.c
index 24776ff390e8b66e0d378fb8bae915dc766a0bf3..557373c66c7f35bae46edf7a8d6123e8f93adc4e 100644 (file)
@@ -1,11 +1,12 @@
 /* modcmd.c - Generalized module command support
  * Copyright 2002-2004 srvx Development Team
  *
- * This program is free software; you can redistribute it and/or modify
+ * This file is part of srvx.
+ *
+ * srvx is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.  Important limitations are
- * listed in the COPYING file that accompanies this software.
+ * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -13,7 +14,8 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, email srvx-maintainers@srvx.net.
+ * along with srvx; if not, write to the Free Software Foundation,
+ * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
  */
 
 #include "arch-version.h"
@@ -34,8 +36,7 @@ static struct pending_template *pending_templates;
 static struct module *modcmd_module;
 static struct modcmd *bind_command, *help_command, *version_command;
 static const struct message_entry msgtab[] = {
-    { "MCMSG_VERSION", "$b"PACKAGE_STRING"$b ("CODENAME"), Built: " __DATE__ ", " __TIME__"." },
-    { "MCMSG_BARE_FLAG", "Flag %.*s must be preceeded by a + or -." },
+    { "MCMSG_BARE_FLAG", "Flag %.*s must be preceded by a + or -." },
     { "MCMSG_UNKNOWN_FLAG", "Unknown module flag %.*s." },
     { "MCMSG_BAD_OPSERV_LEVEL", "Invalid $O access level %s." },
     { "MCMSG_BAD_CHANSERV_LEVEL", "Invalid $C access level %s." },
@@ -118,6 +119,11 @@ static const struct message_entry msgtab[] = {
     { "MCMSG_SERVICE_REMOVED", "Service $b%s$b has been deleted." },
     { "MCMSG_FILE_NOT_OPENED", "Unable to open file $b%s$b for writing." },
     { "MCMSG_MESSAGES_DUMPED", "Messages written to $b%s$b." },
+    { "MCMSG_MESSAGE_DUMP_FAILED", "Message dump failed: %s." },
+    { "MCMSG_COMMAND_FLAGS", "Command flags are %s (inferred: %s)." },
+    { "MCMSG_COMMAND_ACCOUNT_FLAGS", "Requires account flags +%s, prohibits account flags +%s." },
+    { "MCMSG_COMMAND_ACCESS_LEVEL", "Requires channel access %d and $O access %d." },
+    { "MCMSG_COMMAND_USES", "%s has been used %d times." },
     { NULL, NULL }
 };
 struct userData *_GetChannelUser(struct chanData *channel, struct handle_info *handle, int override, int allow_suspended);
@@ -337,7 +343,7 @@ svccmd_configure(struct svccmd *cmd, struct userNode *user, struct userNode *bot
         return 1;
     } else if (!irccasecmp(param, "channel_level") || !irccasecmp(param, "channel_access") || !irccasecmp(param, "access")) {
         unsigned short ul;
-        if (!irccasecmp(value, "none")) {
+        if (!irccasecmp(value, "none") || !irccasecmp(value, "0")) {
             cmd->min_channel_access = 0;
             return 1;
         } else if ((ul = user_level_from_name(value, UL_OWNER)) > 0) {
@@ -642,7 +648,8 @@ svccmd_invoke_argv(struct userNode *user, struct service *service, struct chanNo
     }
     cmd = dict_find(service->commands, argv[cmd_arg], NULL);
     if (!cmd) {
-        send_message(user, service->bot, "MSG_COMMAND_UNKNOWN", argv[cmd_arg]);
+        if (!channel)
+            send_message(user, service->bot, "MSG_COMMAND_UNKNOWN", argv[cmd_arg]);
         return 0;
     }
     flags = cmd->effective_flags;
@@ -814,11 +821,63 @@ svccmd_invoke(struct userNode *user, struct service *service, struct chanNode *c
 void
 modcmd_privmsg(struct userNode *user, struct userNode *bot, char *text, int server_qualified) {
     struct service *service;
+
     if (!(service = dict_find(services, bot->nick, NULL))) {
         log_module(MAIN_LOG, LOG_ERROR, "modcmd_privmsg got privmsg for unhandled service %s, unregistering.", bot->nick);
         reg_privmsg_func(bot, NULL);
         return;
     }
+
+    if (text[0] == '\x01') {
+        char *term, response[MAXLEN];
+
+        text++; /* Skip leading ^A. */
+        /* Chop off final ^A. */
+        term = strchr(text, '\x01');
+        if (!term)
+            return;
+        *term = '\0';
+        /* Parse out leading text. */
+        term = strchr(text, ' ');
+        if (term) {
+            *term++ = '\0';
+            if (!*term)
+                term = NULL;
+        }
+        /* No dict lookup since these are so few. */
+        if (!irccasecmp(text, "CLIENTINFO")) {
+            /* Use \001 instead of \x01 because apparently \x01C is
+             * interpreted as ASCII FS (\034, decimal 28, hex 1C).
+             */
+            irc_notice_user(bot, user, "\001CLIENTINFO CLIENTINFO PING TIME USERINFO VERSION\x01");
+        } else if (!irccasecmp(text, "PING")) {
+            if (term) {
+                snprintf(response, sizeof(response), "\x01PONG %s\x01", term);
+                irc_notice_user(bot, user, response);
+            } else {
+                irc_notice_user(bot,user, "\x01PONG\x01");
+            }
+        } else if (!irccasecmp(text, "TIME")) {
+            struct tm tm;
+            localtime_r(&now, &tm);
+            strftime(response, sizeof(response), "\x01TIME %a %b %d %H:%M:%S %Y\x01", &tm);
+            irc_notice_user(bot, user, response);
+        } else if (!irccasecmp(text, "USERINFO")) {
+            snprintf(response, sizeof(response), "\x01USERINFO %s\x01", bot->info);
+            irc_notice_user(bot, user, response);
+        } else if (!irccasecmp(text, "VERSION")) {
+            /* This function provides copyright management information
+             * to end users of srvx. You should not alter, disable or
+             * remove this command or its accessibility to normal IRC
+             * users, except to add copyright information pertaining
+             * to changes you make to srvx.
+             */
+            snprintf(response, sizeof(response), "\x01VERSION %s (%s) %s\x01", PACKAGE_STRING, CODENAME, ARCH_VERSION);
+            irc_notice_user(bot, user, response);
+        }
+        return;
+    }
+
     if (service->msg_hook && service->msg_hook(user, bot, text, server_qualified))
         return;
     svccmd_invoke(user, service, NULL, text, server_qualified);
@@ -1297,6 +1356,54 @@ static MODCMD_FUNC(cmd_command) {
     return 1;
 }
 
+static void
+modcmd_describe_command(struct userNode *user, struct svccmd *cmd, struct svccmd *target) {
+    char buf1[MAXLEN], buf2[MAXLEN];
+    unsigned int ii, len, buf1_used, buf2_used;
+
+    if (target->alias.used) {
+        unsplit_string((char**)target->alias.list, target->alias.used, buf1);
+        reply("MCMSG_COMMAND_ALIASES", target->name, buf1);
+    } else {
+        snprintf(buf1, sizeof(buf1), "%s.%s", target->command->parent->name, target->command->name);
+        reply("MCMSG_COMMAND_BINDING", target->name, buf1);
+    }
+    for (ii = buf1_used = buf2_used = 0; flags[ii].name; ++ii) {
+        if (target->flags & flags[ii].flag) {
+            if (buf1_used)
+                buf1[buf1_used++] = ',';
+            len = strlen(flags[ii].name);
+            memcpy(buf1 + buf1_used, flags[ii].name, len);
+            buf1_used += len;
+        } else if (target->effective_flags & flags[ii].flag) {
+            if (buf2_used)
+                buf2[buf2_used++] = ',';
+            len = strlen(flags[ii].name);
+            memcpy(buf2 + buf2_used, flags[ii].name, len);
+            buf2_used += len;
+        }
+    }
+    if (buf1_used)
+        buf1[buf1_used] = '\0';
+    else
+        strcpy(buf1, user_find_message(user, "MSG_NONE"));
+    if (buf2_used)
+        buf2[buf2_used] = '\0';
+    else
+        strcpy(buf2, user_find_message(user, "MSG_NONE"));
+    reply("MCMSG_COMMAND_FLAGS", buf1, buf2);
+    for (ii = buf1_used = buf2_used = 0; handle_flags[ii]; ++ii) {
+        if (target->req_account_flags & (1 << ii))
+            buf1[buf1_used++] = handle_flags[ii];
+        else if (target->deny_account_flags & (1 << ii))
+            buf2[buf2_used++] = handle_flags[ii];
+    }
+    buf1[buf1_used] = buf2[buf2_used] = '\0';
+    reply("MCMSG_COMMAND_ACCOUNT_FLAGS", buf1, buf2);
+    reply("MCMSG_COMMAND_ACCESS_LEVEL", target->min_channel_access, target->min_opserv_level);
+    reply("MCMSG_COMMAND_USES", target->name, target->uses);
+}
+
 static MODCMD_FUNC(cmd_modcmd) {
     struct svccmd *svccmd;
     unsigned int arg, changed;
@@ -1304,7 +1411,7 @@ static MODCMD_FUNC(cmd_modcmd) {
 
     assert(argc >= 2);
     arg = collapse_cmdname(argv+1, argc-1, cmdname) + 1;
-    if (!arg || (arg+2 < argc)) {
+    if (!arg) {
         reply("MSG_MISSING_PARAMS", cmd->name);
         return 0;
     }
@@ -1312,16 +1419,15 @@ static MODCMD_FUNC(cmd_modcmd) {
         reply("MCMSG_UNKNOWN_COMMAND_2", cmdname, cmd->parent->bot->nick);
         return 0;
     }
-    changed = 0;
-    while (arg+1 < argc) {
+    for (changed = 0; arg+1 < argc; arg += 2) {
         if (svccmd_configure(svccmd, user, cmd->parent->bot, argv[arg], argv[arg+1])) {
             reply("MCMSG_COMMAND_MODIFIED", argv[arg], svccmd->name);
             changed = 1;
         }
-        arg += 2;
     }
     if (changed)
         modcmd_set_effective_flags(svccmd);
+    modcmd_describe_command(user, cmd, svccmd);
     return changed;
 }
 
@@ -1714,6 +1820,7 @@ static MODCMD_FUNC(cmd_dump_messages) {
     struct saxdb_context *ctx;
     dict_iterator_t it;
     FILE *pf;
+    int res;
 
     if (!(pf = fopen(fname, "w"))) {
         reply("MCMSG_FILE_NOT_OPENED", fname);
@@ -1723,17 +1830,29 @@ static MODCMD_FUNC(cmd_dump_messages) {
         reply("MSG_INTERNAL_FAILURE");
         return 0;
     }
-    for (it = dict_first(lang_C->messages); it; it = iter_next(it))
-        saxdb_write_string(ctx, iter_key(it), iter_data(it));
-    saxdb_close_context(ctx);
-    fclose(pf);
-    reply("MCMSG_MESSAGES_DUMPED", fname);
-    return 1;
+    if ((res = setjmp(ctx->jbuf)) != 0) {
+        ctx->complex.used = 0; /* to avoid false assert()s in close */
+        saxdb_close_context(ctx);
+        fclose(pf);
+        reply("MCMSG_MESSAGE_DUMP_FAILED", strerror(res));
+        return 0;
+    } else {
+        for (it = dict_first(lang_C->messages); it; it = iter_next(it))
+            saxdb_write_string(ctx, iter_key(it), iter_data(it));
+        saxdb_close_context(ctx);
+        fclose(pf);
+        reply("MCMSG_MESSAGES_DUMPED", fname);
+        return 1;
+    }
 }
 
 static MODCMD_FUNC(cmd_version) {
-    reply("MCMSG_VERSION");
-    send_message_type(4, user, cmd->parent->bot, "Copyright 2000-2004 srvx Development Team.\nThe srvx Development Team includes Paul Chang, Adrian Dewhurst, Miles Peterson, Michael Poole and others.\nThe srvx Development Team can be reached at http://sf.net/projects/srvx/ or in #srvx on irc.gamesurge.net.");
+    /* This function provides copyright management information to end
+     * users of srvx. You should not alter, disable or remove this
+     * command or its accessibility to normal IRC users, except to add
+     * copyright information pertaining to changes you make to srvx.
+     */
+    send_message_type(4, user, cmd->parent->bot, "$b"PACKAGE_STRING"$b ("CODENAME"), Built: "__DATE__", "__TIME__".\nCopyright 2000-2004 srvx Development Team.\nThe srvx Development Team includes Paul Chang, Adrian Dewhurst, Miles Peterson, Michael Poole and others.\nThe srvx Development Team can be reached at http://sf.net/projects/srvx/ or in #srvx on irc.gamesurge.net.");
     if ((argc > 1) && !irccasecmp(argv[1], "arch"))
         send_message_type(4, user, cmd->parent->bot, "%s", ARCH_VERSION);
     return 1;
@@ -1960,7 +2079,7 @@ modcmd_init(void) {
     bind_command = modcmd_register(modcmd_module, "bind", cmd_bind, 4, MODCMD_KEEP_BOUND, "oper_level", "800", NULL);
     help_command = modcmd_register(modcmd_module, "help", cmd_help, 1, 0, "flags", "+nolog", NULL);
     modcmd_register(modcmd_module, "command", cmd_command, 2, 0, "flags", "+nolog", NULL);
-    modcmd_register(modcmd_module, "modcmd", cmd_modcmd, 4, MODCMD_KEEP_BOUND, "template", "bind", NULL);
+    modcmd_register(modcmd_module, "modcmd", cmd_modcmd, 2, MODCMD_KEEP_BOUND, "template", "bind", NULL);
     modcmd_register(modcmd_module, "god", cmd_god, 0, MODCMD_REQUIRE_AUTHED, "flags", "+oper,+networkhelper", NULL);
     modcmd_register(modcmd_module, "readhelp", cmd_readhelp, 2, 0, "oper_level", "650", NULL);
     modcmd_register(modcmd_module, "timecmd", cmd_timecmd, 2, 0, "oper_level", "1", NULL);