X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=citadel%2Fcontrol.c;h=3463de80b3baf0e6e817e1b96d62c9daf52e3297;hb=9ffea7c3315046ddcea2589656c13da5f5e0c076;hp=24b643229edca506347d1dbbebf9c9a0e28b8794;hpb=9af50cb0641f0168c770554af3f446e35fc1008c;p=citadel.git diff --git a/citadel/control.c b/citadel/control.c index 24b643229..3463de80b 100644 --- a/citadel/control.c +++ b/citadel/control.c @@ -1,7 +1,7 @@ /* * This module handles states which are global to the entire server. * - * Copyright (c) 1987-2015 by the citadel.org team + * Copyright (c) 1987-2019 by the citadel.org team * * This program is open source software; you can redistribute it and/or modify * it under the terms of the GNU General Public License version 3. @@ -24,7 +24,9 @@ long control_highest_user = 0; /* - * This is the control record for the message base... + * This is the legacy "control record" format for the message base. If found + * on disk, its contents will be migrated into the system configuration. Never + * change this. */ struct legacy_ctrl_format { long MMhighest; /* highest message number in file */ @@ -38,9 +40,13 @@ struct legacy_ctrl_format { }; - /* - * callback to get highest room number when rebuilding control file + * Callback to get highest room number when rebuilding message base metadata + * + * sanity_diag_mode (can be set by -s flag at startup) may be: + * 0 = attempt to fix inconsistencies + * 1 = show inconsistencies but don't repair them, exit after complete + * 2 = show inconsistencies but don't repair them, continue execution */ void control_find_highest(struct ctdlroom *qrbuf, void *data) { @@ -49,16 +55,17 @@ void control_find_highest(struct ctdlroom *qrbuf, void *data) long *msglist; int num_msgs=0; int c; - int room_fixed = 0; - int message_fixed = 0; - if (qrbuf->QRnumber > CtdlGetConfigLong("MMnextroom")) - { - CtdlSetConfigLong("MMnextroom", qrbuf->QRnumber); - room_fixed = 1; + if (qrbuf->QRnumber > CtdlGetConfigLong("MMnextroom")) { + syslog(LOG_DEBUG, "control: fixing MMnextroom %ld > %ld , found in %s", + qrbuf->QRnumber, CtdlGetConfigLong("MMnextroom"), qrbuf->QRname + ); + if (!sanity_diag_mode) { + CtdlSetConfigLong("MMnextroom", qrbuf->QRnumber); + } } - CtdlGetRoom (&room, qrbuf->QRname); + CtdlGetRoom(&room, qrbuf->QRname); /* Load the message list */ cdbfr = cdb_fetch(CDB_MSGLISTS, &room.QRnumber, sizeof(long)); @@ -69,24 +76,19 @@ void control_find_highest(struct ctdlroom *qrbuf, void *data) return; /* No messages at all? No further action. */ } - if (num_msgs>0) - { - for (c=0; c CtdlGetConfigLong("MMhighest")) - { - CtdlSetConfigLong("MMhighest", msglist[c]); - message_fixed = 1; + if (num_msgs > 0) { + for (c=0; c CtdlGetConfigLong("MMhighest")) { + syslog(LOG_DEBUG, "control: fixing MMhighest %ld > %ld , found in %s", + msglist[c], CtdlGetConfigLong("MMhighest"), qrbuf->QRname + ); + if (!sanity_diag_mode) { + CtdlSetConfigLong("MMhighest", msglist[c]); + } } } } cdb_free(cdbfr); - if (room_fixed) { - syslog(LOG_INFO, "Control record checking....Fixed room counter\n"); - } - if (message_fixed) { - syslog(LOG_INFO, "Control record checking....Fixed message count\n"); - } return; } @@ -94,18 +96,21 @@ void control_find_highest(struct ctdlroom *qrbuf, void *data) /* * Callback to get highest user number. */ - -void control_find_user (struct ctdluser *EachUser, void *out_data) -{ - int user_fixed = 0; - - if (EachUser->usernum > CtdlGetConfigLong("MMnextuser")) - { - CtdlSetConfigLong("MMnextuser", EachUser->usernum); - user_fixed = 1; +void control_find_user(char *username, void *out_data) { + struct ctdluser EachUser; + + if (CtdlGetUser(&EachUser, username) != 0) { + return; + } + + if (EachUser.usernum > CtdlGetConfigLong("MMnextuser")) { + syslog(LOG_DEBUG, "control: fixing MMnextuser %ld > %ld , found in %s", + EachUser.usernum, CtdlGetConfigLong("MMnextuser"), EachUser.fullname + ); + if (!sanity_diag_mode) { + CtdlSetConfigLong("MMnextuser", EachUser.usernum); + } } - if(user_fixed) - syslog(LOG_INFO, "Control record checking....Fixed user count\n"); } @@ -120,7 +125,7 @@ void migrate_legacy_control_record(void) fp = fopen(file_citadel_control, "rb+"); if (fp != NULL) { - syslog(LOG_INFO, "Legacy format control record found -- importing to db"); + syslog(LOG_INFO, "control: legacy format record found -- importing to db"); fread(&c, sizeof(struct legacy_ctrl_format), 1, fp); CtdlSetConfigLong( "MMhighest", c.MMhighest); @@ -146,13 +151,18 @@ void migrate_legacy_control_record(void) */ void check_control(void) { - syslog(LOG_INFO, "Sanity checking the recorded highest message, user, and room numbers\n"); + syslog(LOG_INFO, "control: sanity checking the recorded highest message and room numbers"); CtdlForEachRoom(control_find_highest, NULL); + syslog(LOG_INFO, "control: sanity checking the recorded highest user number"); ForEachUser(control_find_user, NULL); + syslog(LOG_INFO, "control: sanity checks complete"); + if (sanity_diag_mode == 1) { + syslog(LOG_INFO, "control: sanity check diagnostic mode is active - exiting now"); + abort(); + } } - /* * get_new_message_number() - Obtain a new, unique ID to be used for a message. */ @@ -197,7 +207,6 @@ long get_new_user_number(void) } - /* * get_new_room_number() - Obtain a new, unique ID to be used for a room. */ @@ -213,7 +222,6 @@ long get_new_room_number(void) } - /* * Helper function for cmd_conf() to handle boolean values */ @@ -245,7 +253,8 @@ void cmd_conf(char *argbuf) extract_token(cmd, argbuf, 0, '|', sizeof cmd); - // CONF GET - retrieve system configuration in legacy format (deprecated) + // CONF GET - retrieve system configuration in legacy format + // This is deprecated; please do not add fields or change their order. if (!strcasecmp(cmd, "GET")) { cprintf("%d Configuration...\n", LISTING_FOLLOWS); cprintf("%s\n", CtdlGetConfigStr("c_nodename")); @@ -309,13 +318,13 @@ void cmd_conf(char *argbuf) cprintf("%d\n", CtdlGetConfigInt("c_pftcpdict_port")); cprintf("%d\n", CtdlGetConfigInt("c_managesieve_port")); cprintf("%d\n", CtdlGetConfigInt("c_auth_mode")); - cprintf("%s\n", CtdlGetConfigStr("c_funambol_host")); - cprintf("%d\n", CtdlGetConfigInt("c_funambol_port")); - cprintf("%s\n", CtdlGetConfigStr("c_funambol_source")); - cprintf("%s\n", CtdlGetConfigStr("c_funambol_auth")); + cprintf("\n"); + cprintf("\n"); + cprintf("\n"); + cprintf("\n"); cprintf("%d\n", CtdlGetConfigInt("c_rbl_at_greeting")); - cprintf("%s\n", CtdlGetConfigStr("c_master_user")); - cprintf("%s\n", CtdlGetConfigStr("c_master_pass")); + cprintf("\n"); + cprintf("\n"); cprintf("%s\n", CtdlGetConfigStr("c_pager_program")); cprintf("%d\n", CtdlGetConfigInt("c_imap_keep_from")); cprintf("%d\n", CtdlGetConfigInt("c_xmpp_c2s_port")); @@ -331,7 +340,8 @@ void cmd_conf(char *argbuf) cprintf("000\n"); } - // CONF SET - set system configuration in legacy format (really deprecated) + // CONF SET - set system configuration in legacy format + // This is deprecated; please do not add fields or change their order. else if (!strcasecmp(cmd, "SET")) { unbuffer_output(); cprintf("%d Send configuration...\n", SEND_LISTING); @@ -351,7 +361,7 @@ void cmd_conf(char *argbuf) /* placeholder -- field no longer in use */ break; case 4: - CtdlSetConfigInt("c_creataide", atoi(buf)); + CtdlSetConfigInt("c_creataide", confbool(buf)); break; case 5: CtdlSetConfigInt("c_sleeping", atoi(buf)); @@ -378,10 +388,10 @@ void cmd_conf(char *argbuf) CtdlSetConfigInt("c_restrict", confbool(buf)); break; case 12: - CtdlSetConfigInt("c_site_location", confbool(buf)); + CtdlSetConfigStr("c_site_location", buf); break; case 13: - CtdlSetConfigInt("c_sysadm", confbool(buf)); + CtdlSetConfigStr("c_sysadm", buf); break; case 14: i = atoi(buf); @@ -518,25 +528,25 @@ void cmd_conf(char *argbuf) CtdlSetConfigInt("c_auth_mode", atoi(buf)); break; case 53: - CtdlSetConfigStr("c_funambol_host", buf); + /* niu */ break; case 54: - CtdlSetConfigInt("c_funambol_port", atoi(buf)); + /* niu */ break; case 55: - CtdlSetConfigStr("c_funambol_source", buf); + /* niu */ break; case 56: - CtdlSetConfigStr("c_funambol_auth", buf); + /* niu */ break; case 57: CtdlSetConfigInt("c_rbl_at_greeting", confbool(buf)); break; case 58: - CtdlSetConfigStr("c_master_user", buf); + /* niu */ break; case 59: - CtdlSetConfigStr("c_master_pass", buf); + /* niu */ break; case 60: CtdlSetConfigStr("c_pager_program", buf); @@ -581,7 +591,7 @@ void cmd_conf(char *argbuf) "The global system configuration has been edited by %s.\n", (CC->logged_in ? CC->curr_user : "an administrator") ); - CtdlAideMessage(buf,"Citadel Configuration Manager Message"); + CtdlAideMessage(buf, "Citadel Configuration Manager Message"); if (!IsEmptyStr(CtdlGetConfigStr("c_logpages"))) CtdlCreateRoom(CtdlGetConfigStr("c_logpages"), 3, "", 0, 1, 1, VIEW_BBS); @@ -619,22 +629,29 @@ void cmd_conf(char *argbuf) extract_token(confname, argbuf, 1, '|', sizeof confname); unbuffer_output(); cprintf("%d %s\n", SEND_LISTING, confname); - confptr = CtdlReadMessageBody(HKEY("000"), CtdlGetConfigLong("c_maxmsglen"), NULL, 0, 0); + confptr = CtdlReadMessageBody(HKEY("000"), CtdlGetConfigLong("c_maxmsglen"), NULL, 0); CtdlPutSysConfig(confname, confptr); free(confptr); } - else if (!strcasecmp(cmd, "GETVAL")) { + // CONF GETVAL - retrieve configuration variables from the database + // CONF LOADVAL - same thing but can handle variables bigger than 1 KB + else if ( (!strcasecmp(cmd, "GETVAL")) || (!strcasecmp(cmd, "LOADVAL")) ) { extract_token(confname, argbuf, 1, '|', sizeof confname); char *v = CtdlGetConfigStr(confname); - if (v) { - cprintf("%d|%s|\n", CIT_OK, v); + if ( (v) && (!strcasecmp(cmd, "GETVAL")) ) { + cprintf("%d %s|\n", CIT_OK, v); + } + else if ( (v) && (!strcasecmp(cmd, "LOADVAL")) ) { + cprintf("%d %d\n", BINARY_FOLLOWS, (int)strlen(v)); + client_write(v, strlen(v)); } else { - cprintf("%d||\n", ERROR); + cprintf("%d |\n", ERROR); } } + // CONF PUTVAL - store configuration variables in the database else if (!strcasecmp(cmd, "PUTVAL")) { if (num_tokens(argbuf, '|') < 3) { cprintf("%d name and value required\n", ERROR); @@ -647,11 +664,50 @@ void cmd_conf(char *argbuf) } } + // CONF STOREVAL - store configuration variables in the database bigger than 1 KB + else if (!strcasecmp(cmd, "STOREVAL")) { + if (num_tokens(argbuf, '|') < 3) { + cprintf("%d name and length required\n", ERROR); + } + else { + extract_token(confname, argbuf, 1, '|', sizeof confname); + int bytes = extract_int(argbuf, 2); + char *valbuf = malloc(bytes + 1); + cprintf("%d %d\n", SEND_BINARY, bytes); + client_read(valbuf, bytes); + valbuf[bytes+1] = 0; + CtdlSetConfigStr(confname, valbuf); + free(valbuf); + } + } + + // CONF LISTVAL - list configuration variables in the database and their values + else if (!strcasecmp(cmd, "LISTVAL")) { + struct cdbdata *cdbcfg; + int keylen = 0; + char *key = NULL; + char *value = NULL; + + cprintf("%d all configuration variables\n", LISTING_FOLLOWS); + cdb_rewind(CDB_CONFIG); + while (cdbcfg = cdb_next_item(CDB_CONFIG), cdbcfg != NULL) { + if (cdbcfg->len < 1020) { + keylen = strlen(cdbcfg->ptr); + key = cdbcfg->ptr; + value = cdbcfg->ptr + keylen + 1; + cprintf("%s|%s\n", key, value); + } + cdb_free(cdbcfg); + } + cprintf("000\n"); + } + else { cprintf("%d Illegal option(s) specified.\n", ERROR + ILLEGAL_VALUE); } } + typedef struct __ConfType { ConstStr Name; long Type;