4 * This module handles states which are global to the entire server.
6 * Copyright (c) 1987-2010 by the citadel.org team
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 #if TIME_WITH_SYS_TIME
31 # include <sys/time.h>
35 # include <sys/time.h>
45 #include <sys/types.h>
48 #include <libcitadel.h>
52 #include "sysdep_decls.h"
56 #include "citserver.h"
66 #include "ctdl_module.h"
68 struct CitControl CitControl;
69 extern struct config config;
70 FILE *control_fp = NULL;
71 long control_highest_user = 0;
75 * lock_control - acquire a lock on the control record file.
76 * This keeps multiple citservers from running concurrently.
78 void lock_control(void)
80 #if defined(LOCK_EX) && defined(LOCK_NB)
81 if (flock(fileno(control_fp), (LOCK_EX | LOCK_NB))) {
82 CtdlLogPrintf(CTDL_EMERG, "citserver: unable to lock %s.\n", file_citadel_control);
83 CtdlLogPrintf(CTDL_EMERG, "Is another citserver already running?\n");
84 exit(CTDLEXIT_CONTROL);
90 * callback to get highest room number when rebuilding control file
92 void control_find_highest(struct ctdlroom *qrbuf, void *data)
95 struct cdbdata *cdbfr;
100 int message_fixed = 0;
102 if (qrbuf->QRnumber > CitControl.MMnextroom)
104 CitControl.MMnextroom = qrbuf->QRnumber;
108 CtdlGetRoom (&room, qrbuf->QRname);
110 /* Load the message list */
111 cdbfr = cdb_fetch(CDB_MSGLISTS, &room.QRnumber, sizeof(long));
113 msglist = (long *) cdbfr->ptr;
114 num_msgs = cdbfr->len / sizeof(long);
116 return; /* No messages at all? No further action. */
121 for (c=0; c<num_msgs; c++)
123 if (msglist[c] > CitControl.MMhighest)
125 CitControl.MMhighest = msglist[c];
132 CtdlLogPrintf(CTDL_INFO, "Control record checking....Fixed room counter\n");
134 CtdlLogPrintf(CTDL_INFO, "Control record checking....Fixed message count\n");
140 * Callback to get highest user number.
143 void control_find_user (struct ctdluser *EachUser, void *out_data)
147 if (EachUser->usernum > CitControl.MMnextuser)
149 CitControl.MMnextuser = EachUser->usernum;
153 CtdlLogPrintf(CTDL_INFO, "Control record checking....Fixed user count\n");
158 * get_control - read the control record into memory.
160 void get_control(void)
162 static int already_have_control = 0;
166 * If we already have the control record in memory, there's no point
167 * in reading it from disk again.
169 if (already_have_control) return;
171 /* Zero it out. If the control record on disk is missing or short,
172 * the system functions with all control record fields initialized
175 memset(&CitControl, 0, sizeof(struct CitControl));
176 if (control_fp == NULL) {
177 control_fp = fopen(file_citadel_control, "rb+");
178 if (control_fp != NULL) {
180 rv = fchown(fileno(control_fp), config.c_ctdluid, -1);
181 rv = fchmod(fileno(control_fp), S_IRUSR|S_IWUSR);
184 if (control_fp == NULL) {
185 control_fp = fopen(file_citadel_control, "wb+");
186 if (control_fp != NULL) {
188 rv = fchown(fileno(control_fp), config.c_ctdluid, -1);
189 rv = fchmod(fileno(control_fp), S_IRUSR|S_IWUSR);
190 memset(&CitControl, 0, sizeof(struct CitControl));
191 rv = fwrite(&CitControl, sizeof(struct CitControl), 1, control_fp);
195 if (control_fp == NULL) {
196 CtdlLogPrintf(CTDL_ALERT, "ERROR opening %s: %s\n", file_citadel_control, strerror(errno));
201 rv = fread(&CitControl, sizeof(struct CitControl), 1, control_fp);
202 already_have_control = 1;
203 rv = chown(file_citadel_control, config.c_ctdluid, (-1));
208 * put_control - write the control record to disk.
210 void put_control(void)
214 if (control_fp != NULL) {
216 rv = fwrite(&CitControl, sizeof(struct CitControl), 1, control_fp);
223 * check_control - check the control record has sensible values for message, user and room numbers
225 void check_control(void)
227 CtdlLogPrintf(CTDL_INFO, "Checking/re-building control record\n");
229 // Find highest room number and message number.
230 CtdlForEachRoom(control_find_highest, NULL);
231 ForEachUser(control_find_user, NULL);
237 * release_control - close our fd on exit
239 void release_control(void)
241 if (control_fp != NULL) {
248 * get_new_message_number() - Obtain a new, unique ID to be used for a message.
250 long get_new_message_number(void)
253 begin_critical_section(S_CONTROL);
255 retval = ++CitControl.MMhighest;
257 end_critical_section(S_CONTROL);
263 * CtdlGetCurrentMessageNumber() - Obtain the current highest message number in the system
264 * This provides a quick way to initialise a variable that might be used to indicate
265 * messages that should not be processed. EG. a new Sieve script will use this
266 * to record determine that messages older than this should not be processed.
268 long CtdlGetCurrentMessageNumber(void)
271 begin_critical_section(S_CONTROL);
273 retval = CitControl.MMhighest;
274 end_critical_section(S_CONTROL);
280 * get_new_user_number() - Obtain a new, unique ID to be used for a user.
282 long get_new_user_number(void)
285 begin_critical_section(S_CONTROL);
287 retval = ++CitControl.MMnextuser;
289 end_critical_section(S_CONTROL);
296 * get_new_room_number() - Obtain a new, unique ID to be used for a room.
298 long get_new_room_number(void)
301 begin_critical_section(S_CONTROL);
303 retval = ++CitControl.MMnextroom;
305 end_critical_section(S_CONTROL);
312 * Get or set global configuration options
314 * IF YOU ADD OR CHANGE FIELDS HERE, YOU *MUST* DOCUMENT YOUR CHANGES AT:
315 * http://www.citadel.org/doku.php/documentation:appproto:system_config
318 void cmd_conf(char *argbuf)
326 if (CtdlAccessCheck(ac_aide)) return;
328 extract_token(cmd, argbuf, 0, '|', sizeof cmd);
329 if (!strcasecmp(cmd, "GET")) {
330 cprintf("%d Configuration...\n", LISTING_FOLLOWS);
331 cprintf("%s\n", config.c_nodename);
332 cprintf("%s\n", config.c_fqdn);
333 cprintf("%s\n", config.c_humannode);
334 cprintf("%s\n", config.c_phonenum);
335 cprintf("%d\n", config.c_creataide);
336 cprintf("%d\n", config.c_sleeping);
337 cprintf("%d\n", config.c_initax);
338 cprintf("%d\n", config.c_regiscall);
339 cprintf("%d\n", config.c_twitdetect);
340 cprintf("%s\n", config.c_twitroom);
341 cprintf("%s\n", config.c_moreprompt);
342 cprintf("%d\n", config.c_restrict);
343 cprintf("%s\n", config.c_site_location);
344 cprintf("%s\n", config.c_sysadm);
345 cprintf("%d\n", config.c_maxsessions);
346 cprintf("xxx\n"); /* placeholder -- field no longer in use */
347 cprintf("%d\n", config.c_userpurge);
348 cprintf("%d\n", config.c_roompurge);
349 cprintf("%s\n", config.c_logpages);
350 cprintf("%d\n", config.c_createax);
351 cprintf("%ld\n", config.c_maxmsglen);
352 cprintf("%d\n", config.c_min_workers);
353 cprintf("%d\n", config.c_max_workers);
354 cprintf("%d\n", config.c_pop3_port);
355 cprintf("%d\n", config.c_smtp_port);
356 cprintf("%d\n", config.c_rfc822_strict_from);
357 cprintf("%d\n", config.c_aide_zap);
358 cprintf("%d\n", config.c_imap_port);
359 cprintf("%ld\n", config.c_net_freq);
360 cprintf("%d\n", config.c_disable_newu);
361 cprintf("1\n"); /* niu */
362 cprintf("%d\n", config.c_purge_hour);
364 cprintf("%s\n", config.c_ldap_host);
365 cprintf("%d\n", config.c_ldap_port);
366 cprintf("%s\n", config.c_ldap_base_dn);
367 cprintf("%s\n", config.c_ldap_bind_dn);
368 cprintf("%s\n", config.c_ldap_bind_pw);
376 cprintf("%s\n", config.c_ip_addr);
377 cprintf("%d\n", config.c_msa_port);
378 cprintf("%d\n", config.c_imaps_port);
379 cprintf("%d\n", config.c_pop3s_port);
380 cprintf("%d\n", config.c_smtps_port);
381 cprintf("%d\n", config.c_enable_fulltext);
382 cprintf("%d\n", config.c_auto_cull);
383 cprintf("%d\n", config.c_instant_expunge);
384 cprintf("%d\n", config.c_allow_spoofing);
385 cprintf("%d\n", config.c_journal_email);
386 cprintf("%d\n", config.c_journal_pubmsgs);
387 cprintf("%s\n", config.c_journal_dest);
388 cprintf("%s\n", config.c_default_cal_zone);
389 cprintf("%d\n", config.c_pftcpdict_port);
390 cprintf("%d\n", config.c_managesieve_port);
391 cprintf("%d\n", config.c_auth_mode);
392 cprintf("%s\n", config.c_funambol_host);
393 cprintf("%d\n", config.c_funambol_port);
394 cprintf("%s\n", config.c_funambol_source);
395 cprintf("%s\n", config.c_funambol_auth);
396 cprintf("%d\n", config.c_rbl_at_greeting);
397 cprintf("%s\n", config.c_master_user);
398 cprintf("%s\n", config.c_master_pass);
399 cprintf("%s\n", config.c_pager_program);
400 cprintf("%d\n", config.c_imap_keep_from);
401 cprintf("%d\n", config.c_xmpp_c2s_port);
402 cprintf("%d\n", config.c_xmpp_s2s_port);
403 cprintf("%ld\n", config.c_pop3_fetch);
404 cprintf("%ld\n", config.c_pop3_fastest);
405 cprintf("%d\n", config.c_spam_flag_only);
406 cprintf("%d\n", config.c_guest_logins);
410 else if (!strcasecmp(cmd, "SET")) {
412 cprintf("%d Send configuration...\n", SEND_LISTING);
414 while (client_getln(buf, sizeof buf) >= 0 && strcmp(buf, "000")) {
417 safestrncpy(config.c_nodename, buf,
418 sizeof config.c_nodename);
421 safestrncpy(config.c_fqdn, buf,
422 sizeof config.c_fqdn);
425 safestrncpy(config.c_humannode, buf,
426 sizeof config.c_humannode);
429 safestrncpy(config.c_phonenum, buf,
430 sizeof config.c_phonenum);
433 config.c_creataide = atoi(buf);
436 config.c_sleeping = atoi(buf);
439 config.c_initax = atoi(buf);
440 if (config.c_initax < 1)
442 if (config.c_initax > 6)
446 config.c_regiscall = atoi(buf);
447 if (config.c_regiscall != 0)
448 config.c_regiscall = 1;
451 config.c_twitdetect = atoi(buf);
452 if (config.c_twitdetect != 0)
453 config.c_twitdetect = 1;
456 safestrncpy(config.c_twitroom, buf,
457 sizeof config.c_twitroom);
460 safestrncpy(config.c_moreprompt, buf,
461 sizeof config.c_moreprompt);
464 config.c_restrict = atoi(buf);
465 if (config.c_restrict != 0)
466 config.c_restrict = 1;
469 safestrncpy(config.c_site_location, buf,
470 sizeof config.c_site_location);
473 safestrncpy(config.c_sysadm, buf,
474 sizeof config.c_sysadm);
477 config.c_maxsessions = atoi(buf);
478 if (config.c_maxsessions < 0)
479 config.c_maxsessions = 0;
482 /* placeholder -- field no longer in use */
485 config.c_userpurge = atoi(buf);
488 config.c_roompurge = atoi(buf);
491 safestrncpy(config.c_logpages, buf,
492 sizeof config.c_logpages);
495 config.c_createax = atoi(buf);
496 if (config.c_createax < 1)
497 config.c_createax = 1;
498 if (config.c_createax > 6)
499 config.c_createax = 6;
502 if (atoi(buf) >= 8192)
503 config.c_maxmsglen = atoi(buf);
507 config.c_min_workers = atoi(buf);
509 if (atoi(buf) >= config.c_min_workers)
510 config.c_max_workers = atoi(buf);
512 config.c_pop3_port = atoi(buf);
515 config.c_smtp_port = atoi(buf);
518 config.c_rfc822_strict_from = atoi(buf);
521 config.c_aide_zap = atoi(buf);
522 if (config.c_aide_zap != 0)
523 config.c_aide_zap = 1;
526 config.c_imap_port = atoi(buf);
529 config.c_net_freq = atol(buf);
532 config.c_disable_newu = atoi(buf);
533 if (config.c_disable_newu != 0)
534 config.c_disable_newu = 1;
540 if ((config.c_purge_hour >= 0)
541 && (config.c_purge_hour <= 23)) {
542 config.c_purge_hour = atoi(buf);
547 safestrncpy(config.c_ldap_host, buf,
548 sizeof config.c_ldap_host);
551 config.c_ldap_port = atoi(buf);
554 safestrncpy(config.c_ldap_base_dn, buf,
555 sizeof config.c_ldap_base_dn);
558 safestrncpy(config.c_ldap_bind_dn, buf,
559 sizeof config.c_ldap_bind_dn);
562 safestrncpy(config.c_ldap_bind_pw, buf,
563 sizeof config.c_ldap_bind_pw);
567 safestrncpy(config.c_ip_addr, buf,
568 sizeof config.c_ip_addr);
570 config.c_msa_port = atoi(buf);
573 config.c_imaps_port = atoi(buf);
576 config.c_pop3s_port = atoi(buf);
579 config.c_smtps_port = atoi(buf);
582 config.c_enable_fulltext = atoi(buf);
585 config.c_auto_cull = atoi(buf);
588 config.c_instant_expunge = atoi(buf);
591 config.c_allow_spoofing = atoi(buf);
594 config.c_journal_email = atoi(buf);
597 config.c_journal_pubmsgs = atoi(buf);
600 safestrncpy(config.c_journal_dest, buf,
601 sizeof config.c_journal_dest);
603 safestrncpy(config.c_default_cal_zone, buf,
604 sizeof config.c_default_cal_zone);
607 config.c_pftcpdict_port = atoi(buf);
610 config.c_managesieve_port = atoi(buf);
613 config.c_auth_mode = atoi(buf);
615 safestrncpy(config.c_funambol_host, buf,
616 sizeof config.c_funambol_host);
619 config.c_funambol_port = atoi(buf);
622 safestrncpy(config.c_funambol_source,
624 sizeof config.c_funambol_source);
627 safestrncpy(config.c_funambol_auth,
629 sizeof config.c_funambol_auth);
632 config.c_rbl_at_greeting = atoi(buf);
635 safestrncpy(config.c_master_user, buf, sizeof config.c_master_user);
638 safestrncpy(config.c_master_pass, buf, sizeof config.c_master_pass);
641 safestrncpy(config.c_pager_program,
643 sizeof config.c_pager_program);
646 config.c_imap_keep_from = atoi(buf);
649 config.c_xmpp_c2s_port = atoi(buf);
652 config.c_xmpp_s2s_port = atoi(buf);
655 config.c_pop3_fetch = atol(buf);
658 config.c_pop3_fastest = atol(buf);
661 config.c_spam_flag_only = atoi(buf);
664 config.c_guest_logins = atoi(buf);
670 snprintf(buf, sizeof buf,
671 "The global system configuration has been edited by %s.\n",
673 CtdlAideMessage(buf,"Citadel Configuration Manager Message");
675 if (!IsEmptyStr(config.c_logpages))
676 CtdlCreateRoom(config.c_logpages, 3, "", 0, 1, 1, VIEW_BBS);
678 /* If full text indexing has been disabled, invalidate the
679 * index so it doesn't try to use it later.
681 if (config.c_enable_fulltext == 0) {
682 CitControl.fulltext_wordbreaker = 0;
687 else if (!strcasecmp(cmd, "GETSYS")) {
688 extract_token(confname, argbuf, 1, '|', sizeof confname);
689 confptr = CtdlGetSysConfig(confname);
690 if (confptr != NULL) {
691 cprintf("%d %s\n", LISTING_FOLLOWS, confname);
692 client_write(confptr, strlen(confptr));
693 if (confptr[strlen(confptr) - 1] != 10)
694 client_write("\n", 1);
698 cprintf("%d No such configuration.\n",
699 ERROR + ILLEGAL_VALUE);
703 else if (!strcasecmp(cmd, "PUTSYS")) {
704 extract_token(confname, argbuf, 1, '|', sizeof confname);
706 cprintf("%d %s\n", SEND_LISTING, confname);
707 confptr = CtdlReadMessageBody(HKEY("000"), config.c_maxmsglen, NULL, 0, 0);
708 CtdlPutSysConfig(confname, confptr);
713 cprintf("%d Illegal option(s) specified.\n",
714 ERROR + ILLEGAL_VALUE);
719 /*****************************************************************************/
720 /* MODULE INITIALIZATION STUFF */
721 /*****************************************************************************/
724 CTDL_MODULE_INIT(control)
727 CtdlRegisterProtoHook(cmd_conf, "CONF", "get/set system configuration");
729 /* return our Subversion id for the Log */