2 * This module handles states which are global to the entire server.
4 * Copyright (c) 1987-2015 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 control record for the message base...
29 struct legacy_ctrl_format {
30 long MMhighest; /* highest message number in file */
31 unsigned MMflags; /* Global system flags */
32 long MMnextuser; /* highest user number on system */
33 long MMnextroom; /* highest room number on system */
34 int MM_hosted_upgrade_level; /* Server-hosted upgrade level */
35 int MM_fulltext_wordbreaker; /* ID of wordbreaker in use */
36 long MMfulltext; /* highest message number indexed */
37 int MMdbversion; /* Version of Berkeley DB used on previous server run */
43 * callback to get highest room number when rebuilding control file
45 void control_find_highest(struct ctdlroom *qrbuf, void *data)
48 struct cdbdata *cdbfr;
53 int message_fixed = 0;
55 if (qrbuf->QRnumber > CtdlGetConfigLong("MMnextroom"))
57 CtdlSetConfigLong("MMnextroom", qrbuf->QRnumber);
61 CtdlGetRoom (&room, qrbuf->QRname);
63 /* Load the message list */
64 cdbfr = cdb_fetch(CDB_MSGLISTS, &room.QRnumber, sizeof(long));
66 msglist = (long *) cdbfr->ptr;
67 num_msgs = cdbfr->len / sizeof(long);
69 return; /* No messages at all? No further action. */
74 for (c=0; c<num_msgs; c++)
76 if (msglist[c] > CtdlGetConfigLong("MMhighest"))
78 CtdlSetConfigLong("MMhighest", msglist[c]);
85 syslog(LOG_INFO, "Control record checking....Fixed room counter\n");
88 syslog(LOG_INFO, "Control record checking....Fixed message count\n");
95 * Callback to get highest user number.
98 void control_find_user (struct ctdluser *EachUser, void *out_data)
102 if (EachUser->usernum > CtdlGetConfigLong("MMnextuser"))
104 CtdlSetConfigLong("MMnextuser", EachUser->usernum);
108 syslog(LOG_INFO, "Control record checking....Fixed user count\n");
113 * If we have a legacy format control record on disk, import it.
115 void migrate_legacy_control_record(void)
118 struct legacy_ctrl_format c;
119 memset(&c, 0, sizeof(c));
121 fp = fopen(file_citadel_control, "rb+");
123 syslog(LOG_INFO, "Legacy format control record found -- importing to db");
124 fread(&c, sizeof(struct legacy_ctrl_format), 1, fp);
126 CtdlSetConfigLong( "MMhighest", c.MMhighest);
127 CtdlSetConfigInt( "MMflags", c.MMflags);
128 CtdlSetConfigLong( "MMnextuser", c.MMnextuser);
129 CtdlSetConfigLong( "MMnextroom", c.MMnextroom);
130 CtdlSetConfigInt( "MM_hosted_upgrade_level", c.MM_hosted_upgrade_level);
131 CtdlSetConfigInt( "MM_fulltext_wordbreaker", c.MM_fulltext_wordbreaker);
132 CtdlSetConfigLong( "MMfulltext", c.MMfulltext);
135 if (unlink(file_citadel_control) != 0) {
136 fprintf(stderr, "Unable to remove legacy control record %s after migrating it.\n", file_citadel_control);
137 fprintf(stderr, "Exiting to prevent data corruption.\n");
138 exit(CTDLEXIT_CONFIG);
145 * check_control - check the control record has sensible values for message, user and room numbers
147 void check_control(void)
149 syslog(LOG_INFO, "Sanity checking the recorded highest message, user, and room numbers\n");
150 CtdlForEachRoom(control_find_highest, NULL);
151 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);
202 * get_new_room_number() - Obtain a new, unique ID to be used for a room.
204 long get_new_room_number(void)
207 begin_critical_section(S_CONTROL);
208 retval = CtdlGetConfigLong("MMnextroom");
210 CtdlSetConfigLong("MMnextroom", retval);
211 end_critical_section(S_CONTROL);
218 * Helper function for cmd_conf() to handle boolean values
220 int confbool(char *v)
222 if (IsEmptyStr(v)) return(0);
223 if (atoi(v) != 0) return(1);
229 * Get or set global configuration options
231 * IF YOU ADD OR CHANGE FIELDS HERE, YOU *MUST* DOCUMENT YOUR CHANGES AT:
232 * http://www.citadel.org/doku.php?id=documentation:applicationprotocol
235 void cmd_conf(char *argbuf)
244 if (CtdlAccessCheck(ac_aide)) return;
246 extract_token(cmd, argbuf, 0, '|', sizeof cmd);
247 if (!strcasecmp(cmd, "GET")) {
248 cprintf("%d Configuration...\n", LISTING_FOLLOWS);
249 cprintf("%s\n", CtdlGetConfigStr("c_nodename"));
250 cprintf("%s\n", CtdlGetConfigStr("c_fqdn"));
251 cprintf("%s\n", CtdlGetConfigStr("c_humannode"));
252 cprintf("xxx\n"); /* placeholder -- field no longer in use */
253 cprintf("%d\n", CtdlGetConfigInt("c_creataide"));
254 cprintf("%d\n", CtdlGetConfigInt("c_sleeping"));
255 cprintf("%d\n", CtdlGetConfigInt("c_initax"));
256 cprintf("%d\n", CtdlGetConfigInt("c_regiscall"));
257 cprintf("%d\n", CtdlGetConfigInt("c_twitdetect"));
258 cprintf("%s\n", CtdlGetConfigStr("c_twitroom"));
259 cprintf("%s\n", CtdlGetConfigStr("c_moreprompt"));
260 cprintf("%d\n", CtdlGetConfigInt("c_restrict"));
261 cprintf("%s\n", CtdlGetConfigStr("c_site_location"));
262 cprintf("%s\n", CtdlGetConfigStr("c_sysadm"));
263 cprintf("%d\n", CtdlGetConfigInt("c_maxsessions"));
264 cprintf("xxx\n"); /* placeholder -- field no longer in use */
265 cprintf("%d\n", CtdlGetConfigInt("c_userpurge"));
266 cprintf("%d\n", CtdlGetConfigInt("c_roompurge"));
267 cprintf("%s\n", CtdlGetConfigStr("c_logpages"));
268 cprintf("%d\n", CtdlGetConfigInt("c_createax"));
269 cprintf("%ld\n", CtdlGetConfigLong("c_maxmsglen"));
270 cprintf("%d\n", CtdlGetConfigInt("c_min_workers"));
271 cprintf("%d\n", CtdlGetConfigInt("c_max_workers"));
272 cprintf("%d\n", CtdlGetConfigInt("c_pop3_port"));
273 cprintf("%d\n", CtdlGetConfigInt("c_smtp_port"));
274 cprintf("%d\n", CtdlGetConfigInt("c_rfc822_strict_from"));
275 cprintf("%d\n", CtdlGetConfigInt("c_aide_zap"));
276 cprintf("%d\n", CtdlGetConfigInt("c_imap_port"));
277 cprintf("%ld\n", CtdlGetConfigLong("c_net_freq"));
278 cprintf("%d\n", CtdlGetConfigInt("c_disable_newu"));
279 cprintf("1\n"); /* niu */
280 cprintf("%d\n", CtdlGetConfigInt("c_purge_hour"));
282 cprintf("%s\n", CtdlGetConfigStr("c_ldap_host"));
283 cprintf("%d\n", CtdlGetConfigInt("c_ldap_port"));
284 cprintf("%s\n", CtdlGetConfigStr("c_ldap_base_dn"));
285 cprintf("%s\n", CtdlGetConfigStr("c_ldap_bind_dn"));
286 cprintf("%s\n", CtdlGetConfigStr("c_ldap_bind_pw"));
294 cprintf("%s\n", CtdlGetConfigStr("c_ip_addr"));
295 cprintf("%d\n", CtdlGetConfigInt("c_msa_port"));
296 cprintf("%d\n", CtdlGetConfigInt("c_imaps_port"));
297 cprintf("%d\n", CtdlGetConfigInt("c_pop3s_port"));
298 cprintf("%d\n", CtdlGetConfigInt("c_smtps_port"));
299 cprintf("%d\n", CtdlGetConfigInt("c_enable_fulltext"));
300 cprintf("%d\n", CtdlGetConfigInt("c_auto_cull"));
302 cprintf("%d\n", CtdlGetConfigInt("c_allow_spoofing"));
303 cprintf("%d\n", CtdlGetConfigInt("c_journal_email"));
304 cprintf("%d\n", CtdlGetConfigInt("c_journal_pubmsgs"));
305 cprintf("%s\n", CtdlGetConfigStr("c_journal_dest"));
306 cprintf("%s\n", CtdlGetConfigStr("c_default_cal_zone"));
307 cprintf("%d\n", CtdlGetConfigInt("c_pftcpdict_port"));
308 cprintf("%d\n", CtdlGetConfigInt("c_managesieve_port"));
309 cprintf("%d\n", CtdlGetConfigInt("c_auth_mode"));
310 cprintf("%s\n", CtdlGetConfigStr("c_funambol_host"));
311 cprintf("%d\n", CtdlGetConfigInt("c_funambol_port"));
312 cprintf("%s\n", CtdlGetConfigStr("c_funambol_source"));
313 cprintf("%s\n", CtdlGetConfigStr("c_funambol_auth"));
314 cprintf("%d\n", CtdlGetConfigInt("c_rbl_at_greeting"));
315 cprintf("%s\n", CtdlGetConfigStr("c_master_user"));
316 cprintf("%s\n", CtdlGetConfigStr("c_master_pass"));
317 cprintf("%s\n", CtdlGetConfigStr("c_pager_program"));
318 cprintf("%d\n", CtdlGetConfigInt("c_imap_keep_from"));
319 cprintf("%d\n", CtdlGetConfigInt("c_xmpp_c2s_port"));
320 cprintf("%d\n", CtdlGetConfigInt("c_xmpp_s2s_port"));
321 cprintf("%ld\n", CtdlGetConfigLong("c_pop3_fetch"));
322 cprintf("%ld\n", CtdlGetConfigLong("c_pop3_fastest"));
323 cprintf("%d\n", CtdlGetConfigInt("c_spam_flag_only"));
324 cprintf("%d\n", CtdlGetConfigInt("c_guest_logins"));
325 cprintf("%d\n", CtdlGetConfigInt("c_port_number"));
326 cprintf("%d\n", ctdluid);
327 cprintf("%d\n", CtdlGetConfigInt("c_nntp_port"));
328 cprintf("%d\n", CtdlGetConfigInt("c_nntps_port"));
332 else if (!strcasecmp(cmd, "SET")) {
334 cprintf("%d Send configuration...\n", SEND_LISTING);
336 while (client_getln(buf, sizeof buf) >= 0 && strcmp(buf, "000")) {
339 CtdlSetConfigStr("c_nodename", buf);
342 CtdlSetConfigStr("c_fqdn", buf);
345 CtdlSetConfigStr("c_humannode", buf);
348 /* placeholder -- field no longer in use */
351 CtdlSetConfigInt("c_creataide", atoi(buf));
354 CtdlSetConfigInt("c_sleeping", atoi(buf));
360 CtdlSetConfigInt("c_initax", i);
363 CtdlSetConfigInt("c_regiscall", confbool(buf));
366 CtdlSetConfigInt("c_twitdetect", confbool(buf));
369 CtdlSetConfigStr("c_twitroom", buf);
372 CtdlSetConfigStr("c_moreprompt", buf);
375 CtdlSetConfigInt("c_restrict", confbool(buf));
378 CtdlSetConfigInt("c_site_location", confbool(buf));
381 CtdlSetConfigInt("c_sysadm", confbool(buf));
386 CtdlSetConfigInt("c_maxsessions", i);
389 /* placeholder -- field no longer in use */
392 CtdlSetConfigInt("c_userpurge", atoi(buf));
395 CtdlSetConfigInt("c_roompurge", atoi(buf));
398 CtdlSetConfigStr("c_logpages", buf);
404 CtdlSetConfigInt("c_createax", i);
409 CtdlSetConfigLong("c_maxmsglen", ii);
414 if (i >= 3) { // minimum value
415 CtdlSetConfigInt("c_min_workers", i);
420 if (i >= CtdlGetConfigInt("c_min_workers")) { // max must be >= min
421 CtdlSetConfigInt("c_max_workers", i);
425 CtdlSetConfigInt("c_pop3_port", atoi(buf));
428 CtdlSetConfigInt("c_smtp_port", atoi(buf));
431 CtdlSetConfigInt("c_rfc822_strict_from", atoi(buf));
434 CtdlSetConfigInt("c_aide_zap", confbool(buf));
437 CtdlSetConfigInt("c_imap_port", atoi(buf));
440 CtdlSetConfigLong("c_net_freq", atol(buf));
443 CtdlSetConfigInt("c_disable_newu", confbool(buf));
450 if ((i >= 0) && (i <= 23)) {
451 CtdlSetConfigInt("c_purge_hour", i);
455 CtdlSetConfigStr("c_ldap_host", buf);
458 CtdlSetConfigInt("c_ldap_port", atoi(buf));
461 CtdlSetConfigStr("c_ldap_base_dn", buf);
464 CtdlSetConfigStr("c_ldap_bind_dn", buf);
467 CtdlSetConfigStr("c_ldap_bind_pw", buf);
470 CtdlSetConfigStr("c_ip_addr", buf);
473 CtdlSetConfigInt("c_msa_port", atoi(buf));
476 CtdlSetConfigInt("c_imaps_port", atoi(buf));
479 CtdlSetConfigInt("c_pop3s_port", atoi(buf));
482 CtdlSetConfigInt("c_smtps_port", atoi(buf));
485 CtdlSetConfigInt("c_enable_fulltext", confbool(buf));
488 CtdlSetConfigInt("c_auto_cull", confbool(buf));
494 CtdlSetConfigInt("c_allow_spoofing", confbool(buf));
497 CtdlSetConfigInt("c_journal_email", confbool(buf));
500 CtdlSetConfigInt("c_journal_pubmsgs", confbool(buf));
503 CtdlSetConfigStr("c_journal_dest", buf);
506 CtdlSetConfigStr("c_default_cal_zone", buf);
509 CtdlSetConfigInt("c_pftcpdict_port", atoi(buf));
512 CtdlSetConfigInt("c_managesieve_port", atoi(buf));
515 CtdlSetConfigInt("c_auth_mode", atoi(buf));
518 CtdlSetConfigStr("c_funambol_host", buf);
521 CtdlSetConfigInt("c_funambol_port", atoi(buf));
524 CtdlSetConfigStr("c_funambol_source", buf);
527 CtdlSetConfigStr("c_funambol_auth", buf);
530 CtdlSetConfigInt("c_rbl_at_greeting", confbool(buf));
533 CtdlSetConfigStr("c_master_user", buf);
536 CtdlSetConfigStr("c_master_pass", buf);
539 CtdlSetConfigStr("c_pager_program", buf);
542 CtdlSetConfigInt("c_imap_keep_from", confbool(buf));
545 CtdlSetConfigInt("c_xmpp_c2s_port", atoi(buf));
548 CtdlSetConfigInt("c_xmpp_s2s_port", atoi(buf));
551 CtdlSetConfigLong("c_pop3_fetch", atol(buf));
554 CtdlSetConfigLong("c_pop3_fastest", atol(buf));
557 CtdlSetConfigInt("c_spam_flag_only", confbool(buf));
560 CtdlSetConfigInt("c_guest_logins", confbool(buf));
563 CtdlSetConfigInt("c_port_number", atoi(buf));
569 CtdlSetConfigInt("c_nntp_port", atoi(buf));
572 CtdlSetConfigInt("c_nntps_port", atoi(buf));
577 snprintf(buf, sizeof buf,
578 "The global system configuration has been edited by %s.\n",
579 (CC->logged_in ? CC->curr_user : "an administrator")
581 CtdlAideMessage(buf,"Citadel Configuration Manager Message");
583 if (!IsEmptyStr(CtdlGetConfigStr("c_logpages")))
584 CtdlCreateRoom(CtdlGetConfigStr("c_logpages"), 3, "", 0, 1, 1, VIEW_BBS);
586 /* If full text indexing has been disabled, invalidate the
587 * index so it doesn't try to use it later.
589 if (CtdlGetConfigInt("c_enable_fulltext") == 0) {
590 CtdlSetConfigInt("MM_fulltext_wordbreaker", 0);
594 else if (!strcasecmp(cmd, "GETSYS")) {
595 extract_token(confname, argbuf, 1, '|', sizeof confname);
596 confptr = CtdlGetSysConfig(confname);
597 if (confptr != NULL) {
600 len = strlen(confptr);
601 cprintf("%d %s\n", LISTING_FOLLOWS, confname);
602 client_write(confptr, len);
603 if ((len > 0) && (confptr[len - 1] != 10))
604 client_write("\n", 1);
608 cprintf("%d No such configuration.\n",
609 ERROR + ILLEGAL_VALUE);
613 else if (!strcasecmp(cmd, "PUTSYS")) {
614 extract_token(confname, argbuf, 1, '|', sizeof confname);
616 cprintf("%d %s\n", SEND_LISTING, confname);
617 confptr = CtdlReadMessageBody(HKEY("000"), CtdlGetConfigLong("c_maxmsglen"), NULL, 0, 0);
618 CtdlPutSysConfig(confname, confptr);
623 cprintf("%d Illegal option(s) specified.\n",
624 ERROR + ILLEGAL_VALUE);
628 typedef struct __ConfType {
633 ConfType CfgNames[] = {
634 { {HKEY("localhost") }, 0},
635 { {HKEY("directory") }, 0},
636 { {HKEY("smarthost") }, 2},
637 { {HKEY("fallbackhost") }, 2},
638 { {HKEY("rbl") }, 3},
639 { {HKEY("spamassassin") }, 3},
640 { {HKEY("masqdomain") }, 1},
641 { {HKEY("clamav") }, 3},
642 { {HKEY("notify") }, 3},
646 HashList *CfgNameHash = NULL;
647 void cmd_gvdn(char *argbuf)
649 const ConfType *pCfg;
651 long min = atol(argbuf);
652 const char *Pos = NULL;
653 const char *PPos = NULL;
664 List = NewHash(1, NULL);
665 Cfg = NewStrBufPlain(CtdlGetConfigStr("c_fqdn"), -1);
666 Put(List, SKEY(Cfg), Cfg, HFreeStrBuf);
669 confptr = CtdlGetSysConfig(INTERNETCFG);
670 Config = NewStrBufPlain(confptr, -1);
673 Line = NewStrBufPlain(NULL, StrLength(Config));
674 CfgToken = NewStrBufPlain(NULL, StrLength(Config));
675 while (StrBufSipLine(Line, Config, &Pos))
678 Cfg = NewStrBufPlain(NULL, StrLength(Line));
680 StrBufExtract_NextToken(Cfg, Line, &PPos, '|');
681 StrBufExtract_NextToken(CfgToken, Line, &PPos, '|');
682 if (GetHash(CfgNameHash, SKEY(CfgToken), &vptr) &&
685 pCfg = (ConfType *) vptr;
686 if (pCfg->Type <= min)
688 Put(List, SKEY(Cfg), Cfg, HFreeStrBuf);
694 cprintf("%d Valid Domains\n", LISTING_FOLLOWS);
695 It = GetNewHashPos(List, 1);
696 while (GetNextHashPos(List, It, &HKLen, &HKey, &vptr))
707 FreeStrBuf(&CfgToken);
711 /*****************************************************************************/
712 /* MODULE INITIALIZATION STUFF */
713 /*****************************************************************************/
715 void control_cleanup(void)
717 DeleteHash(&CfgNameHash);
719 CTDL_MODULE_INIT(control)
724 CfgNameHash = NewHash(1, NULL);
725 for (i = 0; CfgNames[i].Name.Key != NULL; i++)
726 Put(CfgNameHash, CKEY(CfgNames[i].Name), &CfgNames[i], reference_free_handler);
728 CtdlRegisterProtoHook(cmd_gvdn, "GVDN", "get valid domain names");
729 CtdlRegisterProtoHook(cmd_conf, "CONF", "get/set system configuration");
730 CtdlRegisterCleanupHook(control_cleanup);
733 /* return our id for the Log */