2 * This module handles states which are global to the entire server.
4 * Copyright (c) 1987-2010 by the citadel.org team
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 #if TIME_WITH_SYS_TIME
29 # include <sys/time.h>
33 # include <sys/time.h>
43 #include <sys/types.h>
46 #include <libcitadel.h>
50 #include "sysdep_decls.h"
54 #include "citserver.h"
64 #include "ctdl_module.h"
66 struct CitControl CitControl;
67 extern struct config config;
68 FILE *control_fp = NULL;
69 long control_highest_user = 0;
73 * lock_control - acquire a lock on the control record file.
74 * This keeps multiple citservers from running concurrently.
76 void lock_control(void)
78 #if defined(LOCK_EX) && defined(LOCK_NB)
79 if (flock(fileno(control_fp), (LOCK_EX | LOCK_NB))) {
80 syslog(LOG_EMERG, "citserver: unable to lock %s.\n", file_citadel_control);
81 syslog(LOG_EMERG, "Is another citserver already running?\n");
82 exit(CTDLEXIT_CONTROL);
88 * callback to get highest room number when rebuilding control file
90 void control_find_highest(struct ctdlroom *qrbuf, void *data)
93 struct cdbdata *cdbfr;
98 int message_fixed = 0;
100 if (qrbuf->QRnumber > CitControl.MMnextroom)
102 CitControl.MMnextroom = qrbuf->QRnumber;
106 CtdlGetRoom (&room, qrbuf->QRname);
108 /* Load the message list */
109 cdbfr = cdb_fetch(CDB_MSGLISTS, &room.QRnumber, sizeof(long));
111 msglist = (long *) cdbfr->ptr;
112 num_msgs = cdbfr->len / sizeof(long);
114 return; /* No messages at all? No further action. */
119 for (c=0; c<num_msgs; c++)
121 if (msglist[c] > CitControl.MMhighest)
123 CitControl.MMhighest = msglist[c];
130 syslog(LOG_INFO, "Control record checking....Fixed room counter\n");
132 syslog(LOG_INFO, "Control record checking....Fixed message count\n");
138 * Callback to get highest user number.
141 void control_find_user (struct ctdluser *EachUser, void *out_data)
145 if (EachUser->usernum > CitControl.MMnextuser)
147 CitControl.MMnextuser = EachUser->usernum;
151 syslog(LOG_INFO, "Control record checking....Fixed user count\n");
156 * get_control - read the control record into memory.
158 void get_control(void)
160 static int already_have_control = 0;
164 * If we already have the control record in memory, there's no point
165 * in reading it from disk again.
167 if (already_have_control) return;
169 /* Zero it out. If the control record on disk is missing or short,
170 * the system functions with all control record fields initialized
173 memset(&CitControl, 0, sizeof(struct CitControl));
174 if (control_fp == NULL) {
175 control_fp = fopen(file_citadel_control, "rb+");
176 if (control_fp != NULL) {
178 rv = fchown(fileno(control_fp), config.c_ctdluid, -1);
180 syslog(LOG_EMERG, "Failed to adjust ownership of: %s [%s]\n",
181 file_citadel_control, strerror(errno));
182 rv = fchmod(fileno(control_fp), S_IRUSR|S_IWUSR);
184 syslog(LOG_EMERG, "Failed to adjust accessrights of: %s [%s]\n",
185 file_citadel_control, strerror(errno));
188 if (control_fp == NULL) {
189 control_fp = fopen(file_citadel_control, "wb+");
190 if (control_fp != NULL) {
192 memset(&CitControl, 0, sizeof(struct CitControl));
194 rv = fchown(fileno(control_fp), config.c_ctdluid, -1);
196 syslog(LOG_EMERG, "Failed to adjust ownership of: %s [%s]\n",
197 file_citadel_control, strerror(errno));
199 rv = fchmod(fileno(control_fp), S_IRUSR|S_IWUSR);
201 syslog(LOG_EMERG, "Failed to adjust accessrights of: %s [%s]\n",
202 file_citadel_control, strerror(errno));
203 rv = fwrite(&CitControl, sizeof(struct CitControl), 1, control_fp);
205 syslog(LOG_EMERG, "Failed to write: %s [%s]\n",
206 file_citadel_control, strerror(errno));
210 if (control_fp == NULL) {
211 syslog(LOG_ALERT, "ERROR opening %s: %s\n", file_citadel_control, strerror(errno));
216 rv = fread(&CitControl, sizeof(struct CitControl), 1, control_fp);
218 syslog(LOG_EMERG, "Failed to read Controlfile: %s [%s]\n",
219 file_citadel_control, strerror(errno));
220 already_have_control = 1;
221 rv = chown(file_citadel_control, config.c_ctdluid, (-1));
223 syslog(LOG_EMERG, "Failed to adjust ownership of: %s [%s]\n",
224 file_citadel_control, strerror(errno));
228 * put_control - write the control record to disk.
230 void put_control(void)
234 if (control_fp != NULL) {
236 rv = fwrite(&CitControl, sizeof(struct CitControl), 1, control_fp);
238 syslog(LOG_EMERG, "Failed to write: %s [%s]\n",
239 file_citadel_control, strerror(errno));
246 * check_control - check the control record has sensible values for message, user and room numbers
248 void check_control(void)
250 syslog(LOG_INFO, "Checking/re-building control record\n");
252 // Find highest room number and message number.
253 CtdlForEachRoom(control_find_highest, NULL);
254 ForEachUser(control_find_user, NULL);
260 * release_control - close our fd on exit
262 void release_control(void)
264 if (control_fp != NULL) {
271 * get_new_message_number() - Obtain a new, unique ID to be used for a message.
273 long get_new_message_number(void)
276 begin_critical_section(S_CONTROL);
278 retval = ++CitControl.MMhighest;
280 end_critical_section(S_CONTROL);
286 * CtdlGetCurrentMessageNumber() - Obtain the current highest message number in the system
287 * This provides a quick way to initialise a variable that might be used to indicate
288 * messages that should not be processed. EG. a new Sieve script will use this
289 * to record determine that messages older than this should not be processed.
291 long CtdlGetCurrentMessageNumber(void)
294 begin_critical_section(S_CONTROL);
296 retval = CitControl.MMhighest;
297 end_critical_section(S_CONTROL);
303 * get_new_user_number() - Obtain a new, unique ID to be used for a user.
305 long get_new_user_number(void)
308 begin_critical_section(S_CONTROL);
310 retval = ++CitControl.MMnextuser;
312 end_critical_section(S_CONTROL);
319 * get_new_room_number() - Obtain a new, unique ID to be used for a room.
321 long get_new_room_number(void)
324 begin_critical_section(S_CONTROL);
326 retval = ++CitControl.MMnextroom;
328 end_critical_section(S_CONTROL);
335 * Get or set global configuration options
337 * IF YOU ADD OR CHANGE FIELDS HERE, YOU *MUST* DOCUMENT YOUR CHANGES AT:
338 * http://www.citadel.org/doku.php/documentation:appproto:system_config
341 void cmd_conf(char *argbuf)
349 if (CtdlAccessCheck(ac_aide)) return;
351 extract_token(cmd, argbuf, 0, '|', sizeof cmd);
352 if (!strcasecmp(cmd, "GET")) {
353 cprintf("%d Configuration...\n", LISTING_FOLLOWS);
354 cprintf("%s\n", config.c_nodename);
355 cprintf("%s\n", config.c_fqdn);
356 cprintf("%s\n", config.c_humannode);
357 cprintf("%s\n", config.c_phonenum);
358 cprintf("%d\n", config.c_creataide);
359 cprintf("%d\n", config.c_sleeping);
360 cprintf("%d\n", config.c_initax);
361 cprintf("%d\n", config.c_regiscall);
362 cprintf("%d\n", config.c_twitdetect);
363 cprintf("%s\n", config.c_twitroom);
364 cprintf("%s\n", config.c_moreprompt);
365 cprintf("%d\n", config.c_restrict);
366 cprintf("%s\n", config.c_site_location);
367 cprintf("%s\n", config.c_sysadm);
368 cprintf("%d\n", config.c_maxsessions);
369 cprintf("xxx\n"); /* placeholder -- field no longer in use */
370 cprintf("%d\n", config.c_userpurge);
371 cprintf("%d\n", config.c_roompurge);
372 cprintf("%s\n", config.c_logpages);
373 cprintf("%d\n", config.c_createax);
374 cprintf("%ld\n", config.c_maxmsglen);
375 cprintf("%d\n", config.c_min_workers);
376 cprintf("%d\n", config.c_max_workers);
377 cprintf("%d\n", config.c_pop3_port);
378 cprintf("%d\n", config.c_smtp_port);
379 cprintf("%d\n", config.c_rfc822_strict_from);
380 cprintf("%d\n", config.c_aide_zap);
381 cprintf("%d\n", config.c_imap_port);
382 cprintf("%ld\n", config.c_net_freq);
383 cprintf("%d\n", config.c_disable_newu);
384 cprintf("1\n"); /* niu */
385 cprintf("%d\n", config.c_purge_hour);
387 cprintf("%s\n", config.c_ldap_host);
388 cprintf("%d\n", config.c_ldap_port);
389 cprintf("%s\n", config.c_ldap_base_dn);
390 cprintf("%s\n", config.c_ldap_bind_dn);
391 cprintf("%s\n", config.c_ldap_bind_pw);
399 cprintf("%s\n", config.c_ip_addr);
400 cprintf("%d\n", config.c_msa_port);
401 cprintf("%d\n", config.c_imaps_port);
402 cprintf("%d\n", config.c_pop3s_port);
403 cprintf("%d\n", config.c_smtps_port);
404 cprintf("%d\n", config.c_enable_fulltext);
405 cprintf("%d\n", config.c_auto_cull);
406 cprintf("%d\n", config.c_instant_expunge);
407 cprintf("%d\n", config.c_allow_spoofing);
408 cprintf("%d\n", config.c_journal_email);
409 cprintf("%d\n", config.c_journal_pubmsgs);
410 cprintf("%s\n", config.c_journal_dest);
411 cprintf("%s\n", config.c_default_cal_zone);
412 cprintf("%d\n", config.c_pftcpdict_port);
413 cprintf("%d\n", config.c_managesieve_port);
414 cprintf("%d\n", config.c_auth_mode);
415 cprintf("%s\n", config.c_funambol_host);
416 cprintf("%d\n", config.c_funambol_port);
417 cprintf("%s\n", config.c_funambol_source);
418 cprintf("%s\n", config.c_funambol_auth);
419 cprintf("%d\n", config.c_rbl_at_greeting);
420 cprintf("%s\n", config.c_master_user);
421 cprintf("%s\n", config.c_master_pass);
422 cprintf("%s\n", config.c_pager_program);
423 cprintf("%d\n", config.c_imap_keep_from);
424 cprintf("%d\n", config.c_xmpp_c2s_port);
425 cprintf("%d\n", config.c_xmpp_s2s_port);
426 cprintf("%ld\n", config.c_pop3_fetch);
427 cprintf("%ld\n", config.c_pop3_fastest);
428 cprintf("%d\n", config.c_spam_flag_only);
429 cprintf("%d\n", config.c_guest_logins);
433 else if (!strcasecmp(cmd, "SET")) {
435 cprintf("%d Send configuration...\n", SEND_LISTING);
437 while (client_getln(buf, sizeof buf) >= 0 && strcmp(buf, "000")) {
440 safestrncpy(config.c_nodename, buf,
441 sizeof config.c_nodename);
444 safestrncpy(config.c_fqdn, buf,
445 sizeof config.c_fqdn);
448 safestrncpy(config.c_humannode, buf,
449 sizeof config.c_humannode);
452 safestrncpy(config.c_phonenum, buf,
453 sizeof config.c_phonenum);
456 config.c_creataide = atoi(buf);
459 config.c_sleeping = atoi(buf);
462 config.c_initax = atoi(buf);
463 if (config.c_initax < 1)
465 if (config.c_initax > 6)
469 config.c_regiscall = atoi(buf);
470 if (config.c_regiscall != 0)
471 config.c_regiscall = 1;
474 config.c_twitdetect = atoi(buf);
475 if (config.c_twitdetect != 0)
476 config.c_twitdetect = 1;
479 safestrncpy(config.c_twitroom, buf,
480 sizeof config.c_twitroom);
483 safestrncpy(config.c_moreprompt, buf,
484 sizeof config.c_moreprompt);
487 config.c_restrict = atoi(buf);
488 if (config.c_restrict != 0)
489 config.c_restrict = 1;
492 safestrncpy(config.c_site_location, buf,
493 sizeof config.c_site_location);
496 safestrncpy(config.c_sysadm, buf,
497 sizeof config.c_sysadm);
500 config.c_maxsessions = atoi(buf);
501 if (config.c_maxsessions < 0)
502 config.c_maxsessions = 0;
505 /* placeholder -- field no longer in use */
508 config.c_userpurge = atoi(buf);
511 config.c_roompurge = atoi(buf);
514 safestrncpy(config.c_logpages, buf,
515 sizeof config.c_logpages);
518 config.c_createax = atoi(buf);
519 if (config.c_createax < 1)
520 config.c_createax = 1;
521 if (config.c_createax > 6)
522 config.c_createax = 6;
525 if (atoi(buf) >= 8192)
526 config.c_maxmsglen = atoi(buf);
530 config.c_min_workers = atoi(buf);
532 if (atoi(buf) >= config.c_min_workers)
533 config.c_max_workers = atoi(buf);
535 config.c_pop3_port = atoi(buf);
538 config.c_smtp_port = atoi(buf);
541 config.c_rfc822_strict_from = atoi(buf);
544 config.c_aide_zap = atoi(buf);
545 if (config.c_aide_zap != 0)
546 config.c_aide_zap = 1;
549 config.c_imap_port = atoi(buf);
552 config.c_net_freq = atol(buf);
555 config.c_disable_newu = atoi(buf);
556 if (config.c_disable_newu != 0)
557 config.c_disable_newu = 1;
563 if ((config.c_purge_hour >= 0)
564 && (config.c_purge_hour <= 23)) {
565 config.c_purge_hour = atoi(buf);
570 safestrncpy(config.c_ldap_host, buf,
571 sizeof config.c_ldap_host);
574 config.c_ldap_port = atoi(buf);
577 safestrncpy(config.c_ldap_base_dn, buf,
578 sizeof config.c_ldap_base_dn);
581 safestrncpy(config.c_ldap_bind_dn, buf,
582 sizeof config.c_ldap_bind_dn);
585 safestrncpy(config.c_ldap_bind_pw, buf,
586 sizeof config.c_ldap_bind_pw);
590 safestrncpy(config.c_ip_addr, buf,
591 sizeof config.c_ip_addr);
593 config.c_msa_port = atoi(buf);
596 config.c_imaps_port = atoi(buf);
599 config.c_pop3s_port = atoi(buf);
602 config.c_smtps_port = atoi(buf);
605 config.c_enable_fulltext = atoi(buf);
608 config.c_auto_cull = atoi(buf);
611 config.c_instant_expunge = atoi(buf);
614 config.c_allow_spoofing = atoi(buf);
617 config.c_journal_email = atoi(buf);
620 config.c_journal_pubmsgs = atoi(buf);
623 safestrncpy(config.c_journal_dest, buf,
624 sizeof config.c_journal_dest);
626 safestrncpy(config.c_default_cal_zone, buf,
627 sizeof config.c_default_cal_zone);
630 config.c_pftcpdict_port = atoi(buf);
633 config.c_managesieve_port = atoi(buf);
636 config.c_auth_mode = atoi(buf);
638 safestrncpy(config.c_funambol_host, buf,
639 sizeof config.c_funambol_host);
642 config.c_funambol_port = atoi(buf);
645 safestrncpy(config.c_funambol_source,
647 sizeof config.c_funambol_source);
650 safestrncpy(config.c_funambol_auth,
652 sizeof config.c_funambol_auth);
655 config.c_rbl_at_greeting = atoi(buf);
658 safestrncpy(config.c_master_user, buf, sizeof config.c_master_user);
661 safestrncpy(config.c_master_pass, buf, sizeof config.c_master_pass);
664 safestrncpy(config.c_pager_program,
666 sizeof config.c_pager_program);
669 config.c_imap_keep_from = atoi(buf);
672 config.c_xmpp_c2s_port = atoi(buf);
675 config.c_xmpp_s2s_port = atoi(buf);
678 config.c_pop3_fetch = atol(buf);
681 config.c_pop3_fastest = atol(buf);
684 config.c_spam_flag_only = atoi(buf);
687 config.c_guest_logins = atoi(buf);
693 snprintf(buf, sizeof buf,
694 "The global system configuration has been edited by %s.\n",
696 CtdlAideMessage(buf,"Citadel Configuration Manager Message");
698 if (!IsEmptyStr(config.c_logpages))
699 CtdlCreateRoom(config.c_logpages, 3, "", 0, 1, 1, VIEW_BBS);
701 /* If full text indexing has been disabled, invalidate the
702 * index so it doesn't try to use it later.
704 if (config.c_enable_fulltext == 0) {
705 CitControl.fulltext_wordbreaker = 0;
710 else if (!strcasecmp(cmd, "GETSYS")) {
711 extract_token(confname, argbuf, 1, '|', sizeof confname);
712 confptr = CtdlGetSysConfig(confname);
713 if (confptr != NULL) {
716 len = strlen(confptr);
717 cprintf("%d %s\n", LISTING_FOLLOWS, confname);
718 client_write(confptr, len);
719 if ((len > 0) && (confptr[len - 1] != 10))
720 client_write("\n", 1);
724 cprintf("%d No such configuration.\n",
725 ERROR + ILLEGAL_VALUE);
729 else if (!strcasecmp(cmd, "PUTSYS")) {
730 extract_token(confname, argbuf, 1, '|', sizeof confname);
732 cprintf("%d %s\n", SEND_LISTING, confname);
733 confptr = CtdlReadMessageBody(HKEY("000"), config.c_maxmsglen, NULL, 0, 0);
734 CtdlPutSysConfig(confname, confptr);
739 cprintf("%d Illegal option(s) specified.\n",
740 ERROR + ILLEGAL_VALUE);
745 /*****************************************************************************/
746 /* MODULE INITIALIZATION STUFF */
747 /*****************************************************************************/
750 CTDL_MODULE_INIT(control)
753 CtdlRegisterProtoHook(cmd_conf, "CONF", "get/set system configuration");
755 /* return our id for the Log */