4 * This module handles states which are global to the entire server.
6 * Copyright (c) 1987-2009 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)
82 * TODO: solaris manpages describe this function, but the headers
86 if (flock(fileno(control_fp), (LOCK_EX | LOCK_NB))) {
87 CtdlLogPrintf(CTDL_EMERG, "citserver: unable to lock %s.\n", file_citadel_control);
88 CtdlLogPrintf(CTDL_EMERG, "Is another citserver already running?\n");
89 exit(CTDLEXIT_CONTROL);
95 * callback to get highest room number when rebuilding control file
97 void control_find_highest(struct ctdlroom *qrbuf, void *data)
100 struct cdbdata *cdbfr;
105 int message_fixed = 0;
107 if (qrbuf->QRnumber > CitControl.MMnextroom)
109 CitControl.MMnextroom = qrbuf->QRnumber;
113 CtdlGetRoom (&room, qrbuf->QRname);
115 /* Load the message list */
116 cdbfr = cdb_fetch(CDB_MSGLISTS, &room.QRnumber, sizeof(long));
118 msglist = (long *) cdbfr->ptr;
119 num_msgs = cdbfr->len / sizeof(long);
121 return; /* No messages at all? No further action. */
126 for (c=0; c<num_msgs; c++)
128 if (msglist[c] > CitControl.MMhighest)
130 CitControl.MMhighest = msglist[c];
137 CtdlLogPrintf(CTDL_INFO, "Control record checking....Fixed room counter\n");
139 CtdlLogPrintf(CTDL_INFO, "Control record checking....Fixed message count\n");
145 * Callback to get highest user number.
148 void control_find_user (struct ctdluser *EachUser, void *out_data)
152 if (EachUser->usernum > CitControl.MMnextuser)
154 CitControl.MMnextuser = EachUser->usernum;
158 CtdlLogPrintf(CTDL_INFO, "Control record checking....Fixed user count\n");
163 * get_control - read the control record into memory.
165 void get_control(void)
167 static int already_have_control = 0;
171 * If we already have the control record in memory, there's no point
172 * in reading it from disk again.
174 if (already_have_control) return;
176 /* Zero it out. If the control record on disk is missing or short,
177 * the system functions with all control record fields initialized
180 memset(&CitControl, 0, sizeof(struct CitControl));
181 if (control_fp == NULL) {
182 control_fp = fopen(file_citadel_control, "rb+");
183 if (control_fp != NULL) {
185 rv = fchown(fileno(control_fp), config.c_ctdluid, -1);
186 rv = fchmod(fileno(control_fp), S_IRUSR|S_IWUSR);
189 if (control_fp == NULL) {
190 control_fp = fopen(file_citadel_control, "wb+");
191 if (control_fp != NULL) {
193 rv = fchown(fileno(control_fp), config.c_ctdluid, -1);
194 rv = fchmod(fileno(control_fp), S_IRUSR|S_IWUSR);
195 memset(&CitControl, 0, sizeof(struct CitControl));
196 rv = fwrite(&CitControl, sizeof(struct CitControl), 1, control_fp);
200 if (control_fp == NULL) {
201 CtdlLogPrintf(CTDL_ALERT, "ERROR opening %s: %s\n", file_citadel_control, strerror(errno));
206 rv = fread(&CitControl, sizeof(struct CitControl), 1, control_fp);
207 already_have_control = 1;
208 rv = chown(file_citadel_control, config.c_ctdluid, (-1));
213 * put_control - write the control record to disk.
215 void put_control(void)
219 if (control_fp != NULL) {
221 rv = fwrite(&CitControl, sizeof(struct CitControl), 1, control_fp);
228 * check_control - check the control record has sensible values for message, user and room numbers
230 void check_control(void)
232 CtdlLogPrintf(CTDL_INFO, "Checking/re-building control record\n");
234 // Find highest room number and message number.
235 CtdlForEachRoom(control_find_highest, NULL);
236 ForEachUser(control_find_user, NULL);
242 * release_control - close our fd on exit
244 void release_control(void)
246 if (control_fp != NULL)
252 * get_new_message_number() - Obtain a new, unique ID to be used for a message.
254 long get_new_message_number(void)
257 begin_critical_section(S_CONTROL);
259 retval = ++CitControl.MMhighest;
261 end_critical_section(S_CONTROL);
267 * CtdlGetCurrentMessageNumber() - Obtain the current highest message number in the system
268 * This provides a quick way to initialise a variable that might be used to indicate
269 * messages that should not be processed. EG. a new Sieve script will use this
270 * to record determine that messages older than this should not be processed.
272 long CtdlGetCurrentMessageNumber(void)
275 begin_critical_section(S_CONTROL);
277 retval = CitControl.MMhighest;
278 end_critical_section(S_CONTROL);
284 * get_new_user_number() - Obtain a new, unique ID to be used for a user.
286 long get_new_user_number(void)
289 begin_critical_section(S_CONTROL);
291 retval = ++CitControl.MMnextuser;
293 end_critical_section(S_CONTROL);
300 * get_new_room_number() - Obtain a new, unique ID to be used for a room.
302 long get_new_room_number(void)
305 begin_critical_section(S_CONTROL);
307 retval = ++CitControl.MMnextroom;
309 end_critical_section(S_CONTROL);
316 * Get or set global configuration options
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);
409 else if (!strcasecmp(cmd, "SET")) {
411 cprintf("%d Send configuration...\n", SEND_LISTING);
413 while (client_getln(buf, sizeof buf) >= 0 && strcmp(buf, "000")) {
416 safestrncpy(config.c_nodename, buf,
417 sizeof config.c_nodename);
420 safestrncpy(config.c_fqdn, buf,
421 sizeof config.c_fqdn);
424 safestrncpy(config.c_humannode, buf,
425 sizeof config.c_humannode);
428 safestrncpy(config.c_phonenum, buf,
429 sizeof config.c_phonenum);
432 config.c_creataide = atoi(buf);
435 config.c_sleeping = atoi(buf);
438 config.c_initax = atoi(buf);
439 if (config.c_initax < 1)
441 if (config.c_initax > 6)
445 config.c_regiscall = atoi(buf);
446 if (config.c_regiscall != 0)
447 config.c_regiscall = 1;
450 config.c_twitdetect = atoi(buf);
451 if (config.c_twitdetect != 0)
452 config.c_twitdetect = 1;
455 safestrncpy(config.c_twitroom, buf,
456 sizeof config.c_twitroom);
459 safestrncpy(config.c_moreprompt, buf,
460 sizeof config.c_moreprompt);
463 config.c_restrict = atoi(buf);
464 if (config.c_restrict != 0)
465 config.c_restrict = 1;
468 safestrncpy(config.c_site_location, buf,
469 sizeof config.c_site_location);
472 safestrncpy(config.c_sysadm, buf,
473 sizeof config.c_sysadm);
476 config.c_maxsessions = atoi(buf);
477 if (config.c_maxsessions < 0)
478 config.c_maxsessions = 0;
481 /* placeholder -- field no longer in use */
484 config.c_userpurge = atoi(buf);
487 config.c_roompurge = atoi(buf);
490 safestrncpy(config.c_logpages, buf,
491 sizeof config.c_logpages);
494 config.c_createax = atoi(buf);
495 if (config.c_createax < 1)
496 config.c_createax = 1;
497 if (config.c_createax > 6)
498 config.c_createax = 6;
501 if (atoi(buf) >= 8192)
502 config.c_maxmsglen = atoi(buf);
506 config.c_min_workers = atoi(buf);
508 if (atoi(buf) >= config.c_min_workers)
509 config.c_max_workers = atoi(buf);
511 config.c_pop3_port = atoi(buf);
514 config.c_smtp_port = atoi(buf);
517 config.c_rfc822_strict_from = atoi(buf);
520 config.c_aide_zap = atoi(buf);
521 if (config.c_aide_zap != 0)
522 config.c_aide_zap = 1;
525 config.c_imap_port = atoi(buf);
528 config.c_net_freq = atol(buf);
531 config.c_disable_newu = atoi(buf);
532 if (config.c_disable_newu != 0)
533 config.c_disable_newu = 1;
539 if ((config.c_purge_hour >= 0)
540 && (config.c_purge_hour <= 23)) {
541 config.c_purge_hour = atoi(buf);
546 safestrncpy(config.c_ldap_host, buf,
547 sizeof config.c_ldap_host);
550 config.c_ldap_port = atoi(buf);
553 safestrncpy(config.c_ldap_base_dn, buf,
554 sizeof config.c_ldap_base_dn);
557 safestrncpy(config.c_ldap_bind_dn, buf,
558 sizeof config.c_ldap_bind_dn);
561 safestrncpy(config.c_ldap_bind_pw, buf,
562 sizeof config.c_ldap_bind_pw);
566 safestrncpy(config.c_ip_addr, buf,
567 sizeof config.c_ip_addr);
569 config.c_msa_port = atoi(buf);
572 config.c_imaps_port = atoi(buf);
575 config.c_pop3s_port = atoi(buf);
578 config.c_smtps_port = atoi(buf);
581 config.c_enable_fulltext = atoi(buf);
584 config.c_auto_cull = atoi(buf);
587 config.c_instant_expunge = atoi(buf);
590 config.c_allow_spoofing = atoi(buf);
593 config.c_journal_email = atoi(buf);
596 config.c_journal_pubmsgs = atoi(buf);
599 safestrncpy(config.c_journal_dest, buf,
600 sizeof config.c_journal_dest);
602 safestrncpy(config.c_default_cal_zone, buf,
603 sizeof config.c_default_cal_zone);
606 config.c_pftcpdict_port = atoi(buf);
609 config.c_managesieve_port = atoi(buf);
612 config.c_auth_mode = atoi(buf);
614 safestrncpy(config.c_funambol_host, buf,
615 sizeof config.c_funambol_host);
618 config.c_funambol_port = atoi(buf);
621 safestrncpy(config.c_funambol_source,
623 sizeof config.c_funambol_source);
626 safestrncpy(config.c_funambol_auth,
628 sizeof config.c_funambol_auth);
631 config.c_rbl_at_greeting = atoi(buf);
634 safestrncpy(config.c_master_user, buf, sizeof config.c_master_user);
637 safestrncpy(config.c_master_pass, buf, sizeof config.c_master_pass);
640 safestrncpy(config.c_pager_program,
642 sizeof config.c_pager_program);
645 config.c_imap_keep_from = atoi(buf);
648 config.c_xmpp_c2s_port = atoi(buf);
651 config.c_xmpp_s2s_port = atoi(buf);
654 config.c_pop3_fetch = atol(buf);
657 config.c_pop3_fastest = atol(buf);
660 config.c_spam_flag_only = atoi(buf);
666 snprintf(buf, sizeof buf,
667 "The global system configuration has been edited by %s.\n",
669 CtdlAideMessage(buf,"Citadel Configuration Manager Message");
671 if (!IsEmptyStr(config.c_logpages))
672 CtdlCreateRoom(config.c_logpages, 3, "", 0, 1, 1, VIEW_BBS);
674 /* If full text indexing has been disabled, invalidate the
675 * index so it doesn't try to use it later.
677 if (config.c_enable_fulltext == 0) {
678 CitControl.fulltext_wordbreaker = 0;
683 else if (!strcasecmp(cmd, "GETSYS")) {
684 extract_token(confname, argbuf, 1, '|', sizeof confname);
685 confptr = CtdlGetSysConfig(confname);
686 if (confptr != NULL) {
687 cprintf("%d %s\n", LISTING_FOLLOWS, confname);
688 client_write(confptr, strlen(confptr));
689 if (confptr[strlen(confptr) - 1] != 10)
690 client_write("\n", 1);
694 cprintf("%d No such configuration.\n",
695 ERROR + ILLEGAL_VALUE);
699 else if (!strcasecmp(cmd, "PUTSYS")) {
700 extract_token(confname, argbuf, 1, '|', sizeof confname);
702 cprintf("%d %s\n", SEND_LISTING, confname);
703 confptr = CtdlReadMessageBody(HKEY("000"), config.c_maxmsglen, NULL, 0, 0);
704 CtdlPutSysConfig(confname, confptr);
709 cprintf("%d Illegal option(s) specified.\n",
710 ERROR + ILLEGAL_VALUE);
715 /*****************************************************************************/
716 /* MODULE INITIALIZATION STUFF */
717 /*****************************************************************************/
720 CTDL_MODULE_INIT(control)
723 CtdlRegisterProtoHook(cmd_conf, "CONF", "Autoconverted. TODO: document me.");
725 /* return our Subversion id for the Log */