2 * This module handles states which are global to the entire server.
4 * Copyright (c) 1987-2017 by the citadel.org team
6 * This program is open source software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 3.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
17 #include <libcitadel.h>
19 #include "ctdl_module.h"
21 #include "citserver.h"
24 long control_highest_user = 0;
27 * This is the legacy "control record" format for the message base. If found
28 * on disk, its contents will be migrated into the system configuration. Never
31 struct legacy_ctrl_format {
32 long MMhighest; /* highest message number in file */
33 unsigned MMflags; /* Global system flags */
34 long MMnextuser; /* highest user number on system */
35 long MMnextroom; /* highest room number on system */
36 int MM_hosted_upgrade_level; /* Server-hosted upgrade level */
37 int MM_fulltext_wordbreaker; /* ID of wordbreaker in use */
38 long MMfulltext; /* highest message number indexed */
39 int MMdbversion; /* Version of Berkeley DB used on previous server run */
44 * Callback to get highest room number when rebuilding message base metadata
46 void control_find_highest(struct ctdlroom *qrbuf, void *data)
49 struct cdbdata *cdbfr;
54 int message_fixed = 0;
56 if (qrbuf->QRnumber > CtdlGetConfigLong("MMnextroom"))
58 CtdlSetConfigLong("MMnextroom", qrbuf->QRnumber);
62 CtdlGetRoom (&room, qrbuf->QRname);
64 /* Load the message list */
65 cdbfr = cdb_fetch(CDB_MSGLISTS, &room.QRnumber, sizeof(long));
67 msglist = (long *) cdbfr->ptr;
68 num_msgs = cdbfr->len / sizeof(long);
70 return; /* No messages at all? No further action. */
75 for (c=0; c<num_msgs; c++)
77 if (msglist[c] > CtdlGetConfigLong("MMhighest"))
79 CtdlSetConfigLong("MMhighest", msglist[c]);
86 syslog(LOG_INFO, "control: fixed room counter");
89 syslog(LOG_INFO, "control: fixed message count");
96 * Callback to get highest user number.
99 void control_find_user (struct ctdluser *EachUser, void *out_data)
103 if (EachUser->usernum > CtdlGetConfigLong("MMnextuser"))
105 CtdlSetConfigLong("MMnextuser", EachUser->usernum);
109 syslog(LOG_INFO, "control: fixed user count");
114 * If we have a legacy format control record on disk, import it.
116 void migrate_legacy_control_record(void)
119 struct legacy_ctrl_format c;
120 memset(&c, 0, sizeof(c));
122 fp = fopen(file_citadel_control, "rb+");
124 syslog(LOG_INFO, "control: legacy format record found -- importing to db");
125 fread(&c, sizeof(struct legacy_ctrl_format), 1, fp);
127 CtdlSetConfigLong( "MMhighest", c.MMhighest);
128 CtdlSetConfigInt( "MMflags", c.MMflags);
129 CtdlSetConfigLong( "MMnextuser", c.MMnextuser);
130 CtdlSetConfigLong( "MMnextroom", c.MMnextroom);
131 CtdlSetConfigInt( "MM_hosted_upgrade_level", c.MM_hosted_upgrade_level);
132 CtdlSetConfigInt( "MM_fulltext_wordbreaker", c.MM_fulltext_wordbreaker);
133 CtdlSetConfigLong( "MMfulltext", c.MMfulltext);
136 if (unlink(file_citadel_control) != 0) {
137 fprintf(stderr, "Unable to remove legacy control record %s after migrating it.\n", file_citadel_control);
138 fprintf(stderr, "Exiting to prevent data corruption.\n");
139 exit(CTDLEXIT_CONFIG);
146 * check_control - check the control record has sensible values for message, user and room numbers
148 void check_control(void)
150 syslog(LOG_INFO, "control: sanity checking the recorded highest message, user, and room numbers");
151 CtdlForEachRoom(control_find_highest, NULL);
152 ForEachUser(control_find_user, NULL);
157 * get_new_message_number() - Obtain a new, unique ID to be used for a message.
159 long get_new_message_number(void)
162 begin_critical_section(S_CONTROL);
163 retval = CtdlGetConfigLong("MMhighest");
165 CtdlSetConfigLong("MMhighest", retval);
166 end_critical_section(S_CONTROL);
172 * CtdlGetCurrentMessageNumber() - Obtain the current highest message number in the system
173 * This provides a quick way to initialise a variable that might be used to indicate
174 * messages that should not be processed. EG. a new Sieve script will use this
175 * to record determine that messages older than this should not be processed.
177 * (Why is this function here? Can't we just go straight to the config variable it fetches?)
179 long CtdlGetCurrentMessageNumber(void)
181 return CtdlGetConfigLong("MMhighest");
186 * get_new_user_number() - Obtain a new, unique ID to be used for a user.
188 long get_new_user_number(void)
191 begin_critical_section(S_CONTROL);
192 retval = CtdlGetConfigLong("MMnextuser");
194 CtdlSetConfigLong("MMnextuser", retval);
195 end_critical_section(S_CONTROL);
201 * get_new_room_number() - Obtain a new, unique ID to be used for a room.
203 long get_new_room_number(void)
206 begin_critical_section(S_CONTROL);
207 retval = CtdlGetConfigLong("MMnextroom");
209 CtdlSetConfigLong("MMnextroom", retval);
210 end_critical_section(S_CONTROL);
216 * Helper function for cmd_conf() to handle boolean values
218 int confbool(char *v)
220 if (IsEmptyStr(v)) return(0);
221 if (atoi(v) != 0) return(1);
227 * Get or set global configuration options
229 * IF YOU ADD OR CHANGE FIELDS HERE, YOU *MUST* DOCUMENT YOUR CHANGES AT:
230 * http://www.citadel.org/doku.php/documentation:appproto:system_config
233 void cmd_conf(char *argbuf)
242 if (CtdlAccessCheck(ac_aide)) return;
244 extract_token(cmd, argbuf, 0, '|', sizeof cmd);
246 // CONF GET - retrieve system configuration in legacy format
247 // This is deprecated; please do not add fields or change their order.
248 if (!strcasecmp(cmd, "GET")) {
249 cprintf("%d Configuration...\n", LISTING_FOLLOWS);
250 cprintf("%s\n", CtdlGetConfigStr("c_nodename"));
251 cprintf("%s\n", CtdlGetConfigStr("c_fqdn"));
252 cprintf("%s\n", CtdlGetConfigStr("c_humannode"));
253 cprintf("xxx\n"); /* placeholder -- field no longer in use */
254 cprintf("%d\n", CtdlGetConfigInt("c_creataide"));
255 cprintf("%d\n", CtdlGetConfigInt("c_sleeping"));
256 cprintf("%d\n", CtdlGetConfigInt("c_initax"));
257 cprintf("%d\n", CtdlGetConfigInt("c_regiscall"));
258 cprintf("%d\n", CtdlGetConfigInt("c_twitdetect"));
259 cprintf("%s\n", CtdlGetConfigStr("c_twitroom"));
260 cprintf("%s\n", CtdlGetConfigStr("c_moreprompt"));
261 cprintf("%d\n", CtdlGetConfigInt("c_restrict"));
262 cprintf("%s\n", CtdlGetConfigStr("c_site_location"));
263 cprintf("%s\n", CtdlGetConfigStr("c_sysadm"));
264 cprintf("%d\n", CtdlGetConfigInt("c_maxsessions"));
265 cprintf("xxx\n"); /* placeholder -- field no longer in use */
266 cprintf("%d\n", CtdlGetConfigInt("c_userpurge"));
267 cprintf("%d\n", CtdlGetConfigInt("c_roompurge"));
268 cprintf("%s\n", CtdlGetConfigStr("c_logpages"));
269 cprintf("%d\n", CtdlGetConfigInt("c_createax"));
270 cprintf("%ld\n", CtdlGetConfigLong("c_maxmsglen"));
271 cprintf("%d\n", CtdlGetConfigInt("c_min_workers"));
272 cprintf("%d\n", CtdlGetConfigInt("c_max_workers"));
273 cprintf("%d\n", CtdlGetConfigInt("c_pop3_port"));
274 cprintf("%d\n", CtdlGetConfigInt("c_smtp_port"));
275 cprintf("%d\n", CtdlGetConfigInt("c_rfc822_strict_from"));
276 cprintf("%d\n", CtdlGetConfigInt("c_aide_zap"));
277 cprintf("%d\n", CtdlGetConfigInt("c_imap_port"));
278 cprintf("%ld\n", CtdlGetConfigLong("c_net_freq"));
279 cprintf("%d\n", CtdlGetConfigInt("c_disable_newu"));
280 cprintf("1\n"); /* niu */
281 cprintf("%d\n", CtdlGetConfigInt("c_purge_hour"));
283 cprintf("%s\n", CtdlGetConfigStr("c_ldap_host"));
284 cprintf("%d\n", CtdlGetConfigInt("c_ldap_port"));
285 cprintf("%s\n", CtdlGetConfigStr("c_ldap_base_dn"));
286 cprintf("%s\n", CtdlGetConfigStr("c_ldap_bind_dn"));
287 cprintf("%s\n", CtdlGetConfigStr("c_ldap_bind_pw"));
295 cprintf("%s\n", CtdlGetConfigStr("c_ip_addr"));
296 cprintf("%d\n", CtdlGetConfigInt("c_msa_port"));
297 cprintf("%d\n", CtdlGetConfigInt("c_imaps_port"));
298 cprintf("%d\n", CtdlGetConfigInt("c_pop3s_port"));
299 cprintf("%d\n", CtdlGetConfigInt("c_smtps_port"));
300 cprintf("%d\n", CtdlGetConfigInt("c_enable_fulltext"));
301 cprintf("%d\n", CtdlGetConfigInt("c_auto_cull"));
303 cprintf("%d\n", CtdlGetConfigInt("c_allow_spoofing"));
304 cprintf("%d\n", CtdlGetConfigInt("c_journal_email"));
305 cprintf("%d\n", CtdlGetConfigInt("c_journal_pubmsgs"));
306 cprintf("%s\n", CtdlGetConfigStr("c_journal_dest"));
307 cprintf("%s\n", CtdlGetConfigStr("c_default_cal_zone"));
308 cprintf("%d\n", CtdlGetConfigInt("c_pftcpdict_port"));
309 cprintf("%d\n", CtdlGetConfigInt("c_managesieve_port"));
310 cprintf("%d\n", CtdlGetConfigInt("c_auth_mode"));
315 cprintf("%d\n", CtdlGetConfigInt("c_rbl_at_greeting"));
316 cprintf("%s\n", CtdlGetConfigStr("c_master_user"));
317 cprintf("%s\n", CtdlGetConfigStr("c_master_pass"));
318 cprintf("%s\n", CtdlGetConfigStr("c_pager_program"));
319 cprintf("%d\n", CtdlGetConfigInt("c_imap_keep_from"));
320 cprintf("%d\n", CtdlGetConfigInt("c_xmpp_c2s_port"));
321 cprintf("%d\n", CtdlGetConfigInt("c_xmpp_s2s_port"));
322 cprintf("%ld\n", CtdlGetConfigLong("c_pop3_fetch"));
323 cprintf("%ld\n", CtdlGetConfigLong("c_pop3_fastest"));
324 cprintf("%d\n", CtdlGetConfigInt("c_spam_flag_only"));
325 cprintf("%d\n", CtdlGetConfigInt("c_guest_logins"));
326 cprintf("%d\n", CtdlGetConfigInt("c_port_number"));
327 cprintf("%d\n", ctdluid);
328 cprintf("%d\n", CtdlGetConfigInt("c_nntp_port"));
329 cprintf("%d\n", CtdlGetConfigInt("c_nntps_port"));
333 // CONF SET - set system configuration in legacy format
334 // This is deprecated; please do not add fields or change their order.
335 else if (!strcasecmp(cmd, "SET")) {
337 cprintf("%d Send configuration...\n", SEND_LISTING);
339 while (client_getln(buf, sizeof buf) >= 0 && strcmp(buf, "000")) {
342 CtdlSetConfigStr("c_nodename", buf);
345 CtdlSetConfigStr("c_fqdn", buf);
348 CtdlSetConfigStr("c_humannode", buf);
351 /* placeholder -- field no longer in use */
354 CtdlSetConfigInt("c_creataide", confbool(buf));
357 CtdlSetConfigInt("c_sleeping", atoi(buf));
363 CtdlSetConfigInt("c_initax", i);
366 CtdlSetConfigInt("c_regiscall", confbool(buf));
369 CtdlSetConfigInt("c_twitdetect", confbool(buf));
372 CtdlSetConfigStr("c_twitroom", buf);
375 CtdlSetConfigStr("c_moreprompt", buf);
378 CtdlSetConfigInt("c_restrict", confbool(buf));
381 CtdlSetConfigStr("c_site_location", buf);
384 CtdlSetConfigStr("c_sysadm", buf);
389 CtdlSetConfigInt("c_maxsessions", i);
392 /* placeholder -- field no longer in use */
395 CtdlSetConfigInt("c_userpurge", atoi(buf));
398 CtdlSetConfigInt("c_roompurge", atoi(buf));
401 CtdlSetConfigStr("c_logpages", buf);
407 CtdlSetConfigInt("c_createax", i);
412 CtdlSetConfigLong("c_maxmsglen", ii);
417 if (i >= 3) { // minimum value
418 CtdlSetConfigInt("c_min_workers", i);
423 if (i >= CtdlGetConfigInt("c_min_workers")) { // max must be >= min
424 CtdlSetConfigInt("c_max_workers", i);
428 CtdlSetConfigInt("c_pop3_port", atoi(buf));
431 CtdlSetConfigInt("c_smtp_port", atoi(buf));
434 CtdlSetConfigInt("c_rfc822_strict_from", atoi(buf));
437 CtdlSetConfigInt("c_aide_zap", confbool(buf));
440 CtdlSetConfigInt("c_imap_port", atoi(buf));
443 CtdlSetConfigLong("c_net_freq", atol(buf));
446 CtdlSetConfigInt("c_disable_newu", confbool(buf));
453 if ((i >= 0) && (i <= 23)) {
454 CtdlSetConfigInt("c_purge_hour", i);
458 CtdlSetConfigStr("c_ldap_host", buf);
461 CtdlSetConfigInt("c_ldap_port", atoi(buf));
464 CtdlSetConfigStr("c_ldap_base_dn", buf);
467 CtdlSetConfigStr("c_ldap_bind_dn", buf);
470 CtdlSetConfigStr("c_ldap_bind_pw", buf);
473 CtdlSetConfigStr("c_ip_addr", buf);
476 CtdlSetConfigInt("c_msa_port", atoi(buf));
479 CtdlSetConfigInt("c_imaps_port", atoi(buf));
482 CtdlSetConfigInt("c_pop3s_port", atoi(buf));
485 CtdlSetConfigInt("c_smtps_port", atoi(buf));
488 CtdlSetConfigInt("c_enable_fulltext", confbool(buf));
491 CtdlSetConfigInt("c_auto_cull", confbool(buf));
497 CtdlSetConfigInt("c_allow_spoofing", confbool(buf));
500 CtdlSetConfigInt("c_journal_email", confbool(buf));
503 CtdlSetConfigInt("c_journal_pubmsgs", confbool(buf));
506 CtdlSetConfigStr("c_journal_dest", buf);
509 CtdlSetConfigStr("c_default_cal_zone", buf);
512 CtdlSetConfigInt("c_pftcpdict_port", atoi(buf));
515 CtdlSetConfigInt("c_managesieve_port", atoi(buf));
518 CtdlSetConfigInt("c_auth_mode", atoi(buf));
533 CtdlSetConfigInt("c_rbl_at_greeting", confbool(buf));
536 CtdlSetConfigStr("c_master_user", buf);
539 CtdlSetConfigStr("c_master_pass", buf);
542 CtdlSetConfigStr("c_pager_program", buf);
545 CtdlSetConfigInt("c_imap_keep_from", confbool(buf));
548 CtdlSetConfigInt("c_xmpp_c2s_port", atoi(buf));
551 CtdlSetConfigInt("c_xmpp_s2s_port", atoi(buf));
554 CtdlSetConfigLong("c_pop3_fetch", atol(buf));
557 CtdlSetConfigLong("c_pop3_fastest", atol(buf));
560 CtdlSetConfigInt("c_spam_flag_only", confbool(buf));
563 CtdlSetConfigInt("c_guest_logins", confbool(buf));
566 CtdlSetConfigInt("c_port_number", atoi(buf));
572 CtdlSetConfigInt("c_nntp_port", atoi(buf));
575 CtdlSetConfigInt("c_nntps_port", atoi(buf));
580 snprintf(buf, sizeof buf,
581 "The global system configuration has been edited by %s.\n",
582 (CC->logged_in ? CC->curr_user : "an administrator")
584 CtdlAideMessage(buf, "Citadel Configuration Manager Message");
586 if (!IsEmptyStr(CtdlGetConfigStr("c_logpages")))
587 CtdlCreateRoom(CtdlGetConfigStr("c_logpages"), 3, "", 0, 1, 1, VIEW_BBS);
589 /* If full text indexing has been disabled, invalidate the
590 * index so it doesn't try to use it later.
592 if (CtdlGetConfigInt("c_enable_fulltext") == 0) {
593 CtdlSetConfigInt("MM_fulltext_wordbreaker", 0);
597 // CONF GETSYS - retrieve arbitrary system configuration stanzas stored in the message base
598 else if (!strcasecmp(cmd, "GETSYS")) {
599 extract_token(confname, argbuf, 1, '|', sizeof confname);
600 confptr = CtdlGetSysConfig(confname);
601 if (confptr != NULL) {
604 len = strlen(confptr);
605 cprintf("%d %s\n", LISTING_FOLLOWS, confname);
606 client_write(confptr, len);
607 if ((len > 0) && (confptr[len - 1] != 10))
608 client_write("\n", 1);
612 cprintf("%d No such configuration.\n",
613 ERROR + ILLEGAL_VALUE);
617 // CONF PUTSYS - store arbitrary system configuration stanzas in the message base
618 else if (!strcasecmp(cmd, "PUTSYS")) {
619 extract_token(confname, argbuf, 1, '|', sizeof confname);
621 cprintf("%d %s\n", SEND_LISTING, confname);
622 confptr = CtdlReadMessageBody(HKEY("000"), CtdlGetConfigLong("c_maxmsglen"), NULL, 0);
623 CtdlPutSysConfig(confname, confptr);
627 // CONF GETVAL - retrieve configuration variables from the database
628 // CONF LOADVAL - same thing but can handle variables bigger than 1 KB
629 else if ( (!strcasecmp(cmd, "GETVAL")) || (!strcasecmp(cmd, "LOADVAL")) ) {
630 extract_token(confname, argbuf, 1, '|', sizeof confname);
631 char *v = CtdlGetConfigStr(confname);
632 if ( (v) && (!strcasecmp(cmd, "GETVAL")) ) {
633 cprintf("%d %s|\n", CIT_OK, v);
635 else if ( (v) && (!strcasecmp(cmd, "LOADVAL")) ) {
636 cprintf("%d %d\n", BINARY_FOLLOWS, (int)strlen(v));
637 client_write(v, strlen(v));
640 cprintf("%d |\n", ERROR);
644 // CONF PUTVAL - store configuration variables in the database
645 else if (!strcasecmp(cmd, "PUTVAL")) {
646 if (num_tokens(argbuf, '|') < 3) {
647 cprintf("%d name and value required\n", ERROR);
650 extract_token(confname, argbuf, 1, '|', sizeof confname);
651 extract_token(buf, argbuf, 2, '|', sizeof buf);
652 CtdlSetConfigStr(confname, buf);
653 cprintf("%d setting '%s' to '%s'\n", CIT_OK, confname, buf);
657 // CONF STOREVAL - store configuration variables in the database bigger than 1 KB
658 else if (!strcasecmp(cmd, "STOREVAL")) {
659 if (num_tokens(argbuf, '|') < 3) {
660 cprintf("%d name and length required\n", ERROR);
663 extract_token(confname, argbuf, 1, '|', sizeof confname);
664 int bytes = extract_int(argbuf, 2);
665 char *valbuf = malloc(bytes + 1);
666 cprintf("%d %d\n", SEND_BINARY, bytes);
667 client_read(valbuf, bytes);
669 CtdlSetConfigStr(confname, valbuf);
674 // CONF LISTVAL - list configuration variables in the database and their values
675 else if (!strcasecmp(cmd, "LISTVAL")) {
676 struct cdbdata *cdbcfg;
681 cprintf("%d all configuration variables\n", LISTING_FOLLOWS);
682 cdb_rewind(CDB_CONFIG);
683 while (cdbcfg = cdb_next_item(CDB_CONFIG), cdbcfg != NULL) {
684 if (cdbcfg->len < 1020) {
685 keylen = strlen(cdbcfg->ptr);
687 value = cdbcfg->ptr + keylen + 1;
688 cprintf("%s|%s\n", key, value);
696 cprintf("%d Illegal option(s) specified.\n", ERROR + ILLEGAL_VALUE);
701 typedef struct __ConfType {
706 ConfType CfgNames[] = {
707 { {HKEY("localhost") }, 0},
708 { {HKEY("directory") }, 0},
709 { {HKEY("smarthost") }, 2},
710 { {HKEY("fallbackhost") }, 2},
711 { {HKEY("rbl") }, 3},
712 { {HKEY("spamassassin") }, 3},
713 { {HKEY("masqdomain") }, 1},
714 { {HKEY("clamav") }, 3},
715 { {HKEY("notify") }, 3},
719 HashList *CfgNameHash = NULL;
720 void cmd_gvdn(char *argbuf)
722 const ConfType *pCfg;
724 long min = atol(argbuf);
725 const char *Pos = NULL;
726 const char *PPos = NULL;
737 List = NewHash(1, NULL);
738 Cfg = NewStrBufPlain(CtdlGetConfigStr("c_fqdn"), -1);
739 Put(List, SKEY(Cfg), Cfg, HFreeStrBuf);
742 confptr = CtdlGetSysConfig(INTERNETCFG);
743 Config = NewStrBufPlain(confptr, -1);
746 Line = NewStrBufPlain(NULL, StrLength(Config));
747 CfgToken = NewStrBufPlain(NULL, StrLength(Config));
748 while (StrBufSipLine(Line, Config, &Pos))
751 Cfg = NewStrBufPlain(NULL, StrLength(Line));
753 StrBufExtract_NextToken(Cfg, Line, &PPos, '|');
754 StrBufExtract_NextToken(CfgToken, Line, &PPos, '|');
755 if (GetHash(CfgNameHash, SKEY(CfgToken), &vptr) &&
758 pCfg = (ConfType *) vptr;
759 if (pCfg->Type <= min)
761 Put(List, SKEY(Cfg), Cfg, HFreeStrBuf);
767 cprintf("%d Valid Domains\n", LISTING_FOLLOWS);
768 It = GetNewHashPos(List, 1);
769 while (GetNextHashPos(List, It, &HKLen, &HKey, &vptr))
780 FreeStrBuf(&CfgToken);
784 /*****************************************************************************/
785 /* MODULE INITIALIZATION STUFF */
786 /*****************************************************************************/
788 void control_cleanup(void)
790 DeleteHash(&CfgNameHash);
792 CTDL_MODULE_INIT(control)
797 CfgNameHash = NewHash(1, NULL);
798 for (i = 0; CfgNames[i].Name.Key != NULL; i++)
799 Put(CfgNameHash, CKEY(CfgNames[i].Name), &CfgNames[i], reference_free_handler);
801 CtdlRegisterProtoHook(cmd_gvdn, "GVDN", "get valid domain names");
802 CtdlRegisterProtoHook(cmd_conf, "CONF", "get/set system configuration");
803 CtdlRegisterCleanupHook(control_cleanup);
806 /* return our id for the Log */