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 struct CitControl CitControl;
25 FILE *control_fp = NULL;
26 long control_highest_user = 0;
30 * lock_control - acquire a lock on the control record file.
31 * This keeps multiple citservers from running concurrently.
33 void lock_control(void)
35 #if defined(LOCK_EX) && defined(LOCK_NB)
36 if (flock(fileno(control_fp), (LOCK_EX | LOCK_NB))) {
37 syslog(LOG_EMERG, "citserver: unable to lock %s.\n", file_citadel_control);
38 syslog(LOG_EMERG, "Is another citserver already running?\n");
39 exit(CTDLEXIT_CONTROL);
45 * callback to get highest room number when rebuilding control file
47 void control_find_highest(struct ctdlroom *qrbuf, void *data)
50 struct cdbdata *cdbfr;
55 int message_fixed = 0;
57 if (qrbuf->QRnumber > CitControl.MMnextroom)
59 CitControl.MMnextroom = qrbuf->QRnumber;
63 CtdlGetRoom (&room, qrbuf->QRname);
65 /* Load the message list */
66 cdbfr = cdb_fetch(CDB_MSGLISTS, &room.QRnumber, sizeof(long));
68 msglist = (long *) cdbfr->ptr;
69 num_msgs = cdbfr->len / sizeof(long);
71 return; /* No messages at all? No further action. */
76 for (c=0; c<num_msgs; c++)
78 if (msglist[c] > CitControl.MMhighest)
80 CitControl.MMhighest = msglist[c];
87 syslog(LOG_INFO, "Control record checking....Fixed room counter\n");
89 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 > CitControl.MMnextuser)
104 CitControl.MMnextuser = EachUser->usernum;
108 syslog(LOG_INFO, "Control record checking....Fixed user count\n");
113 * get_control - read the control record into memory.
115 void get_control(void)
117 static int already_have_control = 0;
121 * If we already have the control record in memory, there's no point
122 * in reading it from disk again.
124 if (already_have_control) return;
126 /* Zero it out. If the control record on disk is missing or short,
127 * the system functions with all control record fields initialized
130 memset(&CitControl, 0, sizeof(struct CitControl));
131 if (control_fp == NULL) {
132 control_fp = fopen(file_citadel_control, "rb+");
133 if (control_fp != NULL) {
135 rv = fchown(fileno(control_fp), ctdluid, -1);
137 syslog(LOG_EMERG, "Failed to adjust ownership of: %s [%s]\n",
138 file_citadel_control, strerror(errno));
139 rv = fchmod(fileno(control_fp), S_IRUSR|S_IWUSR);
141 syslog(LOG_EMERG, "Failed to adjust accessrights of: %s [%s]\n",
142 file_citadel_control, strerror(errno));
145 if (control_fp == NULL) {
146 control_fp = fopen(file_citadel_control, "wb+");
147 if (control_fp != NULL) {
149 memset(&CitControl, 0, sizeof(struct CitControl));
151 rv = fchown(fileno(control_fp), ctdluid, -1);
153 syslog(LOG_EMERG, "Failed to adjust ownership of: %s [%s]\n",
154 file_citadel_control, strerror(errno));
156 rv = fchmod(fileno(control_fp), S_IRUSR|S_IWUSR);
158 syslog(LOG_EMERG, "Failed to adjust accessrights of: %s [%s]\n",
159 file_citadel_control, strerror(errno));
160 rv = fwrite(&CitControl, sizeof(struct CitControl), 1, control_fp);
162 syslog(LOG_EMERG, "Failed to write: %s [%s]\n",
163 file_citadel_control, strerror(errno));
167 if (control_fp == NULL) {
168 syslog(LOG_ALERT, "ERROR opening %s: %s\n", file_citadel_control, strerror(errno));
173 rv = fread(&CitControl, sizeof(struct CitControl), 1, control_fp);
175 syslog(LOG_EMERG, "Failed to read Controlfile: %s [%s]\n",
176 file_citadel_control, strerror(errno));
177 already_have_control = 1;
178 rv = chown(file_citadel_control, ctdluid, (-1));
180 syslog(LOG_EMERG, "Failed to adjust ownership of: %s [%s]\n",
181 file_citadel_control, strerror(errno));
185 * put_control - write the control record to disk.
187 void put_control(void)
191 if (control_fp != NULL) {
193 rv = fwrite(&CitControl, sizeof(struct CitControl), 1, control_fp);
195 syslog(LOG_EMERG, "Failed to write: %s [%s]\n",
196 file_citadel_control, strerror(errno));
203 * check_control - check the control record has sensible values for message, user and room numbers
205 void check_control(void)
207 syslog(LOG_INFO, "Checking/re-building control record\n");
209 // Find highest room number and message number.
210 CtdlForEachRoom(control_find_highest, NULL);
211 ForEachUser(control_find_user, NULL);
217 * release_control - close our fd on exit
219 void release_control(void)
221 if (control_fp != NULL) {
228 * get_new_message_number() - Obtain a new, unique ID to be used for a message.
230 long get_new_message_number(void)
233 begin_critical_section(S_CONTROL);
235 retval = ++CitControl.MMhighest;
237 end_critical_section(S_CONTROL);
243 * CtdlGetCurrentMessageNumber() - Obtain the current highest message number in the system
244 * This provides a quick way to initialise a variable that might be used to indicate
245 * messages that should not be processed. EG. a new Sieve script will use this
246 * to record determine that messages older than this should not be processed.
248 long CtdlGetCurrentMessageNumber(void)
251 begin_critical_section(S_CONTROL);
253 retval = CitControl.MMhighest;
254 end_critical_section(S_CONTROL);
260 * get_new_user_number() - Obtain a new, unique ID to be used for a user.
262 long get_new_user_number(void)
265 begin_critical_section(S_CONTROL);
267 retval = ++CitControl.MMnextuser;
269 end_critical_section(S_CONTROL);
276 * get_new_room_number() - Obtain a new, unique ID to be used for a room.
278 long get_new_room_number(void)
281 begin_critical_section(S_CONTROL);
283 retval = ++CitControl.MMnextroom;
285 end_critical_section(S_CONTROL);
292 * Helper function for cmd_conf() to handle boolean values
294 int confbool(char *v)
296 if (IsEmptyStr(v)) return(0);
297 if (atoi(v) != 0) return(1);
303 * Get or set global configuration options
305 * IF YOU ADD OR CHANGE FIELDS HERE, YOU *MUST* DOCUMENT YOUR CHANGES AT:
306 * http://www.citadel.org/doku.php?id=documentation:applicationprotocol
309 void cmd_conf(char *argbuf)
318 if (CtdlAccessCheck(ac_aide)) return;
320 extract_token(cmd, argbuf, 0, '|', sizeof cmd);
321 if (!strcasecmp(cmd, "GET")) {
322 cprintf("%d Configuration...\n", LISTING_FOLLOWS);
323 cprintf("%s\n", CtdlGetConfigStr("c_nodename"));
324 cprintf("%s\n", CtdlGetConfigStr("c_fqdn"));
325 cprintf("%s\n", CtdlGetConfigStr("c_humannode"));
326 cprintf("xxx\n"); /* placeholder -- field no longer in use */
327 cprintf("%d\n", CtdlGetConfigInt("c_creataide"));
328 cprintf("%d\n", CtdlGetConfigInt("c_sleeping"));
329 cprintf("%d\n", CtdlGetConfigInt("c_initax"));
330 cprintf("%d\n", CtdlGetConfigInt("c_regiscall"));
331 cprintf("%d\n", CtdlGetConfigInt("c_twitdetect"));
332 cprintf("%s\n", CtdlGetConfigStr("c_twitroom"));
333 cprintf("%s\n", CtdlGetConfigStr("c_moreprompt"));
334 cprintf("%d\n", CtdlGetConfigInt("c_restrict"));
335 cprintf("%s\n", CtdlGetConfigStr("c_site_location"));
336 cprintf("%s\n", CtdlGetConfigStr("c_sysadm"));
337 cprintf("%d\n", CtdlGetConfigInt("c_maxsessions"));
338 cprintf("xxx\n"); /* placeholder -- field no longer in use */
339 cprintf("%d\n", CtdlGetConfigInt("c_userpurge"));
340 cprintf("%d\n", CtdlGetConfigInt("c_roompurge"));
341 cprintf("%s\n", CtdlGetConfigStr("c_logpages"));
342 cprintf("%d\n", CtdlGetConfigInt("c_createax"));
343 cprintf("%ld\n", CtdlGetConfigLong("c_maxmsglen"));
344 cprintf("%d\n", CtdlGetConfigInt("c_min_workers"));
345 cprintf("%d\n", CtdlGetConfigInt("c_max_workers"));
346 cprintf("%d\n", CtdlGetConfigInt("c_pop3_port"));
347 cprintf("%d\n", CtdlGetConfigInt("c_smtp_port"));
348 cprintf("%d\n", CtdlGetConfigInt("c_rfc822_strict_from"));
349 cprintf("%d\n", CtdlGetConfigInt("c_aide_zap"));
350 cprintf("%d\n", CtdlGetConfigInt("c_imap_port"));
351 cprintf("%ld\n", CtdlGetConfigLong("c_net_freq"));
352 cprintf("%d\n", CtdlGetConfigInt("c_disable_newu"));
353 cprintf("1\n"); /* niu */
354 cprintf("%d\n", CtdlGetConfigInt("c_purge_hour"));
356 cprintf("%s\n", CtdlGetConfigStr("c_ldap_host"));
357 cprintf("%d\n", CtdlGetConfigInt("c_ldap_port"));
358 cprintf("%s\n", CtdlGetConfigStr("c_ldap_base_dn"));
359 cprintf("%s\n", CtdlGetConfigStr("c_ldap_bind_dn"));
360 cprintf("%s\n", CtdlGetConfigStr("c_ldap_bind_pw"));
368 cprintf("%s\n", CtdlGetConfigStr("c_ip_addr"));
369 cprintf("%d\n", CtdlGetConfigInt("c_msa_port"));
370 cprintf("%d\n", CtdlGetConfigInt("c_imaps_port"));
371 cprintf("%d\n", CtdlGetConfigInt("c_pop3s_port"));
372 cprintf("%d\n", CtdlGetConfigInt("c_smtps_port"));
373 cprintf("%d\n", CtdlGetConfigInt("c_enable_fulltext"));
374 cprintf("%d\n", CtdlGetConfigInt("c_auto_cull"));
376 cprintf("%d\n", CtdlGetConfigInt("c_allow_spoofing"));
377 cprintf("%d\n", CtdlGetConfigInt("c_journal_email"));
378 cprintf("%d\n", CtdlGetConfigInt("c_journal_pubmsgs"));
379 cprintf("%s\n", CtdlGetConfigStr("c_journal_dest"));
380 cprintf("%s\n", CtdlGetConfigStr("c_default_cal_zone"));
381 cprintf("%d\n", CtdlGetConfigInt("c_pftcpdict_port"));
382 cprintf("%d\n", CtdlGetConfigInt("c_managesieve_port"));
383 cprintf("%d\n", CtdlGetConfigInt("c_auth_mode"));
384 cprintf("%s\n", CtdlGetConfigStr("c_funambol_host"));
385 cprintf("%d\n", CtdlGetConfigInt("c_funambol_port"));
386 cprintf("%s\n", CtdlGetConfigStr("c_funambol_source"));
387 cprintf("%s\n", CtdlGetConfigStr("c_funambol_auth"));
388 cprintf("%d\n", CtdlGetConfigInt("c_rbl_at_greeting"));
389 cprintf("%s\n", CtdlGetConfigStr("c_master_user"));
390 cprintf("%s\n", CtdlGetConfigStr("c_master_pass"));
391 cprintf("%s\n", CtdlGetConfigStr("c_pager_program"));
392 cprintf("%d\n", CtdlGetConfigInt("c_imap_keep_from"));
393 cprintf("%d\n", CtdlGetConfigInt("c_xmpp_c2s_port"));
394 cprintf("%d\n", CtdlGetConfigInt("c_xmpp_s2s_port"));
395 cprintf("%ld\n", CtdlGetConfigLong("c_pop3_fetch"));
396 cprintf("%ld\n", CtdlGetConfigLong("c_pop3_fastest"));
397 cprintf("%d\n", CtdlGetConfigInt("c_spam_flag_only"));
398 cprintf("%d\n", CtdlGetConfigInt("c_guest_logins"));
399 cprintf("%d\n", CtdlGetConfigInt("c_port_number"));
400 cprintf("%d\n", ctdluid);
401 cprintf("%d\n", CtdlGetConfigInt("c_nntp_port"));
402 cprintf("%d\n", CtdlGetConfigInt("c_nntps_port"));
406 else if (!strcasecmp(cmd, "SET")) {
408 cprintf("%d Send configuration...\n", SEND_LISTING);
410 while (client_getln(buf, sizeof buf) >= 0 && strcmp(buf, "000")) {
413 CtdlSetConfigStr("c_nodename", buf);
416 CtdlSetConfigStr("c_fqdn", buf);
419 CtdlSetConfigStr("c_humannode", buf);
422 /* placeholder -- field no longer in use */
425 CtdlSetConfigInt("c_creataide", atoi(buf));
428 CtdlSetConfigInt("c_sleeping", atoi(buf));
434 CtdlSetConfigInt("c_initax", i);
437 CtdlSetConfigInt("c_regiscall", confbool(buf));
440 CtdlSetConfigInt("c_twitdetect", confbool(buf));
443 CtdlSetConfigStr("c_twitroom", buf);
446 CtdlSetConfigStr("c_moreprompt", buf);
449 CtdlSetConfigInt("c_restrict", confbool(buf));
452 CtdlSetConfigInt("c_site_location", confbool(buf));
455 CtdlSetConfigInt("c_sysadm", confbool(buf));
460 CtdlSetConfigInt("c_maxsessions", i);
463 /* placeholder -- field no longer in use */
466 CtdlSetConfigInt("c_userpurge", atoi(buf));
469 CtdlSetConfigInt("c_roompurge", atoi(buf));
472 CtdlSetConfigStr("c_logpages", buf);
478 CtdlSetConfigInt("c_createax", i);
483 CtdlSetConfigLong("c_maxmsglen", ii);
488 if (i >= 3) { // minimum value
489 CtdlSetConfigInt("c_min_workers", i);
494 if (i >= CtdlGetConfigInt("c_min_workers")) { // max must be >= min
495 CtdlSetConfigInt("c_max_workers", i);
499 CtdlSetConfigInt("c_pop3_port", atoi(buf));
502 CtdlSetConfigInt("c_smtp_port", atoi(buf));
505 CtdlSetConfigInt("c_rfc822_strict_from", atoi(buf));
508 CtdlSetConfigInt("c_aide_zap", confbool(buf));
511 CtdlSetConfigInt("c_imap_port", atoi(buf));
514 CtdlSetConfigLong("c_net_freq", atol(buf));
517 CtdlSetConfigInt("c_disable_newu", confbool(buf));
523 if ((config.c_purge_hour >= 0)
524 && (config.c_purge_hour <= 23)) {
525 config.c_purge_hour = atoi(buf);
530 safestrncpy(config.c_ldap_host, buf, sizeof config.c_ldap_host);
533 config.c_ldap_port = atoi(buf);
536 safestrncpy(config.c_ldap_base_dn, buf, sizeof config.c_ldap_base_dn);
539 safestrncpy(config.c_ldap_bind_dn, buf, sizeof config.c_ldap_bind_dn);
542 safestrncpy(config.c_ldap_bind_pw, buf, sizeof config.c_ldap_bind_pw);
546 safestrncpy(config.c_ip_addr, buf, sizeof config.c_ip_addr);
548 config.c_msa_port = atoi(buf);
551 config.c_imaps_port = atoi(buf);
554 config.c_pop3s_port = atoi(buf);
557 config.c_smtps_port = atoi(buf);
560 config.c_enable_fulltext = atoi(buf);
563 config.c_auto_cull = atoi(buf);
569 config.c_allow_spoofing = atoi(buf);
572 config.c_journal_email = atoi(buf);
575 config.c_journal_pubmsgs = atoi(buf);
578 safestrncpy(config.c_journal_dest, buf, sizeof config.c_journal_dest);
580 safestrncpy(config.c_default_cal_zone, buf, sizeof config.c_default_cal_zone);
583 config.c_pftcpdict_port = atoi(buf);
586 config.c_managesieve_port = atoi(buf);
589 config.c_auth_mode = atoi(buf);
591 safestrncpy(config.c_funambol_host, buf, sizeof config.c_funambol_host);
594 config.c_funambol_port = atoi(buf);
597 safestrncpy(config.c_funambol_source, buf, sizeof config.c_funambol_source);
600 safestrncpy(config.c_funambol_auth, buf, sizeof config.c_funambol_auth);
603 config.c_rbl_at_greeting = atoi(buf);
606 safestrncpy(config.c_master_user, buf, sizeof config.c_master_user);
609 safestrncpy(config.c_master_pass, buf, sizeof config.c_master_pass);
612 safestrncpy(config.c_pager_program, buf, sizeof config.c_pager_program);
615 config.c_imap_keep_from = atoi(buf);
618 config.c_xmpp_c2s_port = atoi(buf);
621 config.c_xmpp_s2s_port = atoi(buf);
624 config.c_pop3_fetch = atol(buf);
627 config.c_pop3_fastest = atol(buf);
630 config.c_spam_flag_only = atoi(buf);
633 config.c_guest_logins = atoi(buf);
636 config.c_port_number = atoi(buf);
642 config.c_nntp_port = atoi(buf);
645 config.c_nntps_port = atoi(buf);
651 snprintf(buf, sizeof buf,
652 "The global system configuration has been edited by %s.\n",
653 (CC->logged_in ? CC->curr_user : "an administrator")
655 CtdlAideMessage(buf,"Citadel Configuration Manager Message");
657 if (!IsEmptyStr(config.c_logpages))
658 CtdlCreateRoom(config.c_logpages, 3, "", 0, 1, 1, VIEW_BBS);
660 /* If full text indexing has been disabled, invalidate the
661 * index so it doesn't try to use it later.
663 if (config.c_enable_fulltext == 0) {
664 CitControl.MM_fulltext_wordbreaker = 0;
669 else if (!strcasecmp(cmd, "GETSYS")) {
670 extract_token(confname, argbuf, 1, '|', sizeof confname);
671 confptr = CtdlGetSysConfig(confname);
672 if (confptr != NULL) {
675 len = strlen(confptr);
676 cprintf("%d %s\n", LISTING_FOLLOWS, confname);
677 client_write(confptr, len);
678 if ((len > 0) && (confptr[len - 1] != 10))
679 client_write("\n", 1);
683 cprintf("%d No such configuration.\n",
684 ERROR + ILLEGAL_VALUE);
688 else if (!strcasecmp(cmd, "PUTSYS")) {
689 extract_token(confname, argbuf, 1, '|', sizeof confname);
691 cprintf("%d %s\n", SEND_LISTING, confname);
692 confptr = CtdlReadMessageBody(HKEY("000"), config.c_maxmsglen, NULL, 0, 0);
693 CtdlPutSysConfig(confname, confptr);
698 cprintf("%d Illegal option(s) specified.\n",
699 ERROR + ILLEGAL_VALUE);
703 typedef struct __ConfType {
708 ConfType CfgNames[] = {
709 { {HKEY("localhost") }, 0},
710 { {HKEY("directory") }, 0},
711 { {HKEY("smarthost") }, 2},
712 { {HKEY("fallbackhost") }, 2},
713 { {HKEY("rbl") }, 3},
714 { {HKEY("spamassassin") }, 3},
715 { {HKEY("masqdomain") }, 1},
716 { {HKEY("clamav") }, 3},
717 { {HKEY("notify") }, 3},
721 HashList *CfgNameHash = NULL;
722 void cmd_gvdn(char *argbuf)
724 const ConfType *pCfg;
726 long min = atol(argbuf);
727 const char *Pos = NULL;
728 const char *PPos = NULL;
739 List = NewHash(1, NULL);
740 Cfg = NewStrBufPlain(config.c_fqdn, -1);
741 Put(List, SKEY(Cfg), Cfg, HFreeStrBuf);
744 confptr = CtdlGetSysConfig(INTERNETCFG);
745 Config = NewStrBufPlain(confptr, -1);
748 Line = NewStrBufPlain(NULL, StrLength(Config));
749 CfgToken = NewStrBufPlain(NULL, StrLength(Config));
750 while (StrBufSipLine(Line, Config, &Pos))
753 Cfg = NewStrBufPlain(NULL, StrLength(Line));
755 StrBufExtract_NextToken(Cfg, Line, &PPos, '|');
756 StrBufExtract_NextToken(CfgToken, Line, &PPos, '|');
757 if (GetHash(CfgNameHash, SKEY(CfgToken), &vptr) &&
760 pCfg = (ConfType *) vptr;
761 if (pCfg->Type <= min)
763 Put(List, SKEY(Cfg), Cfg, HFreeStrBuf);
769 cprintf("%d Valid Domains\n", LISTING_FOLLOWS);
770 It = GetNewHashPos(List, 1);
771 while (GetNextHashPos(List, It, &HKLen, &HKey, &vptr))
782 FreeStrBuf(&CfgToken);
786 /*****************************************************************************/
787 /* MODULE INITIALIZATION STUFF */
788 /*****************************************************************************/
790 void control_cleanup(void)
792 DeleteHash(&CfgNameHash);
794 CTDL_MODULE_INIT(control)
799 CfgNameHash = NewHash(1, NULL);
800 for (i = 0; CfgNames[i].Name.Key != NULL; i++)
801 Put(CfgNameHash, CKEY(CfgNames[i].Name), &CfgNames[i], reference_free_handler);
803 CtdlRegisterProtoHook(cmd_gvdn, "GVDN", "get valid domain names");
804 CtdlRegisterProtoHook(cmd_conf, "CONF", "get/set system configuration");
805 CtdlRegisterCleanupHook(control_cleanup);
808 /* return our id for the Log */