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);
179 rv = fchmod(fileno(control_fp), S_IRUSR|S_IWUSR);
182 if (control_fp == NULL) {
183 control_fp = fopen(file_citadel_control, "wb+");
184 if (control_fp != NULL) {
186 rv = fchown(fileno(control_fp), config.c_ctdluid, -1);
187 rv = fchmod(fileno(control_fp), S_IRUSR|S_IWUSR);
188 memset(&CitControl, 0, sizeof(struct CitControl));
189 rv = fwrite(&CitControl, sizeof(struct CitControl), 1, control_fp);
193 if (control_fp == NULL) {
194 syslog(LOG_ALERT, "ERROR opening %s: %s\n", file_citadel_control, strerror(errno));
199 rv = fread(&CitControl, sizeof(struct CitControl), 1, control_fp);
200 already_have_control = 1;
201 rv = chown(file_citadel_control, config.c_ctdluid, (-1));
206 * put_control - write the control record to disk.
208 void put_control(void)
212 if (control_fp != NULL) {
214 rv = fwrite(&CitControl, sizeof(struct CitControl), 1, control_fp);
221 * check_control - check the control record has sensible values for message, user and room numbers
223 void check_control(void)
225 syslog(LOG_INFO, "Checking/re-building control record\n");
227 // Find highest room number and message number.
228 CtdlForEachRoom(control_find_highest, NULL);
229 ForEachUser(control_find_user, NULL);
235 * release_control - close our fd on exit
237 void release_control(void)
239 if (control_fp != NULL) {
246 * get_new_message_number() - Obtain a new, unique ID to be used for a message.
248 long get_new_message_number(void)
251 begin_critical_section(S_CONTROL);
253 retval = ++CitControl.MMhighest;
255 end_critical_section(S_CONTROL);
261 * CtdlGetCurrentMessageNumber() - Obtain the current highest message number in the system
262 * This provides a quick way to initialise a variable that might be used to indicate
263 * messages that should not be processed. EG. a new Sieve script will use this
264 * to record determine that messages older than this should not be processed.
266 long CtdlGetCurrentMessageNumber(void)
269 begin_critical_section(S_CONTROL);
271 retval = CitControl.MMhighest;
272 end_critical_section(S_CONTROL);
278 * get_new_user_number() - Obtain a new, unique ID to be used for a user.
280 long get_new_user_number(void)
283 begin_critical_section(S_CONTROL);
285 retval = ++CitControl.MMnextuser;
287 end_critical_section(S_CONTROL);
294 * get_new_room_number() - Obtain a new, unique ID to be used for a room.
296 long get_new_room_number(void)
299 begin_critical_section(S_CONTROL);
301 retval = ++CitControl.MMnextroom;
303 end_critical_section(S_CONTROL);
310 * Get or set global configuration options
312 * IF YOU ADD OR CHANGE FIELDS HERE, YOU *MUST* DOCUMENT YOUR CHANGES AT:
313 * http://www.citadel.org/doku.php/documentation:appproto:system_config
316 void cmd_conf(char *argbuf)
324 if (CtdlAccessCheck(ac_aide)) return;
326 extract_token(cmd, argbuf, 0, '|', sizeof cmd);
327 if (!strcasecmp(cmd, "GET")) {
328 cprintf("%d Configuration...\n", LISTING_FOLLOWS);
329 cprintf("%s\n", config.c_nodename);
330 cprintf("%s\n", config.c_fqdn);
331 cprintf("%s\n", config.c_humannode);
332 cprintf("%s\n", config.c_phonenum);
333 cprintf("%d\n", config.c_creataide);
334 cprintf("%d\n", config.c_sleeping);
335 cprintf("%d\n", config.c_initax);
336 cprintf("%d\n", config.c_regiscall);
337 cprintf("%d\n", config.c_twitdetect);
338 cprintf("%s\n", config.c_twitroom);
339 cprintf("%s\n", config.c_moreprompt);
340 cprintf("%d\n", config.c_restrict);
341 cprintf("%s\n", config.c_site_location);
342 cprintf("%s\n", config.c_sysadm);
343 cprintf("%d\n", config.c_maxsessions);
344 cprintf("xxx\n"); /* placeholder -- field no longer in use */
345 cprintf("%d\n", config.c_userpurge);
346 cprintf("%d\n", config.c_roompurge);
347 cprintf("%s\n", config.c_logpages);
348 cprintf("%d\n", config.c_createax);
349 cprintf("%ld\n", config.c_maxmsglen);
350 cprintf("%d\n", config.c_min_workers);
351 cprintf("%d\n", config.c_max_workers);
352 cprintf("%d\n", config.c_pop3_port);
353 cprintf("%d\n", config.c_smtp_port);
354 cprintf("%d\n", config.c_rfc822_strict_from);
355 cprintf("%d\n", config.c_aide_zap);
356 cprintf("%d\n", config.c_imap_port);
357 cprintf("%ld\n", config.c_net_freq);
358 cprintf("%d\n", config.c_disable_newu);
359 cprintf("1\n"); /* niu */
360 cprintf("%d\n", config.c_purge_hour);
362 cprintf("%s\n", config.c_ldap_host);
363 cprintf("%d\n", config.c_ldap_port);
364 cprintf("%s\n", config.c_ldap_base_dn);
365 cprintf("%s\n", config.c_ldap_bind_dn);
366 cprintf("%s\n", config.c_ldap_bind_pw);
374 cprintf("%s\n", config.c_ip_addr);
375 cprintf("%d\n", config.c_msa_port);
376 cprintf("%d\n", config.c_imaps_port);
377 cprintf("%d\n", config.c_pop3s_port);
378 cprintf("%d\n", config.c_smtps_port);
379 cprintf("%d\n", config.c_enable_fulltext);
380 cprintf("%d\n", config.c_auto_cull);
381 cprintf("%d\n", config.c_instant_expunge);
382 cprintf("%d\n", config.c_allow_spoofing);
383 cprintf("%d\n", config.c_journal_email);
384 cprintf("%d\n", config.c_journal_pubmsgs);
385 cprintf("%s\n", config.c_journal_dest);
386 cprintf("%s\n", config.c_default_cal_zone);
387 cprintf("%d\n", config.c_pftcpdict_port);
388 cprintf("%d\n", config.c_managesieve_port);
389 cprintf("%d\n", config.c_auth_mode);
390 cprintf("%s\n", config.c_funambol_host);
391 cprintf("%d\n", config.c_funambol_port);
392 cprintf("%s\n", config.c_funambol_source);
393 cprintf("%s\n", config.c_funambol_auth);
394 cprintf("%d\n", config.c_rbl_at_greeting);
395 cprintf("%s\n", config.c_master_user);
396 cprintf("%s\n", config.c_master_pass);
397 cprintf("%s\n", config.c_pager_program);
398 cprintf("%d\n", config.c_imap_keep_from);
399 cprintf("%d\n", config.c_xmpp_c2s_port);
400 cprintf("%d\n", config.c_xmpp_s2s_port);
401 cprintf("%ld\n", config.c_pop3_fetch);
402 cprintf("%ld\n", config.c_pop3_fastest);
403 cprintf("%d\n", config.c_spam_flag_only);
404 cprintf("%d\n", config.c_guest_logins);
408 else if (!strcasecmp(cmd, "SET")) {
410 cprintf("%d Send configuration...\n", SEND_LISTING);
412 while (client_getln(buf, sizeof buf) >= 0 && strcmp(buf, "000")) {
415 safestrncpy(config.c_nodename, buf,
416 sizeof config.c_nodename);
419 safestrncpy(config.c_fqdn, buf,
420 sizeof config.c_fqdn);
423 safestrncpy(config.c_humannode, buf,
424 sizeof config.c_humannode);
427 safestrncpy(config.c_phonenum, buf,
428 sizeof config.c_phonenum);
431 config.c_creataide = atoi(buf);
434 config.c_sleeping = atoi(buf);
437 config.c_initax = atoi(buf);
438 if (config.c_initax < 1)
440 if (config.c_initax > 6)
444 config.c_regiscall = atoi(buf);
445 if (config.c_regiscall != 0)
446 config.c_regiscall = 1;
449 config.c_twitdetect = atoi(buf);
450 if (config.c_twitdetect != 0)
451 config.c_twitdetect = 1;
454 safestrncpy(config.c_twitroom, buf,
455 sizeof config.c_twitroom);
458 safestrncpy(config.c_moreprompt, buf,
459 sizeof config.c_moreprompt);
462 config.c_restrict = atoi(buf);
463 if (config.c_restrict != 0)
464 config.c_restrict = 1;
467 safestrncpy(config.c_site_location, buf,
468 sizeof config.c_site_location);
471 safestrncpy(config.c_sysadm, buf,
472 sizeof config.c_sysadm);
475 config.c_maxsessions = atoi(buf);
476 if (config.c_maxsessions < 0)
477 config.c_maxsessions = 0;
480 /* placeholder -- field no longer in use */
483 config.c_userpurge = atoi(buf);
486 config.c_roompurge = atoi(buf);
489 safestrncpy(config.c_logpages, buf,
490 sizeof config.c_logpages);
493 config.c_createax = atoi(buf);
494 if (config.c_createax < 1)
495 config.c_createax = 1;
496 if (config.c_createax > 6)
497 config.c_createax = 6;
500 if (atoi(buf) >= 8192)
501 config.c_maxmsglen = atoi(buf);
505 config.c_min_workers = atoi(buf);
507 if (atoi(buf) >= config.c_min_workers)
508 config.c_max_workers = atoi(buf);
510 config.c_pop3_port = atoi(buf);
513 config.c_smtp_port = atoi(buf);
516 config.c_rfc822_strict_from = atoi(buf);
519 config.c_aide_zap = atoi(buf);
520 if (config.c_aide_zap != 0)
521 config.c_aide_zap = 1;
524 config.c_imap_port = atoi(buf);
527 config.c_net_freq = atol(buf);
530 config.c_disable_newu = atoi(buf);
531 if (config.c_disable_newu != 0)
532 config.c_disable_newu = 1;
538 if ((config.c_purge_hour >= 0)
539 && (config.c_purge_hour <= 23)) {
540 config.c_purge_hour = atoi(buf);
545 safestrncpy(config.c_ldap_host, buf,
546 sizeof config.c_ldap_host);
549 config.c_ldap_port = atoi(buf);
552 safestrncpy(config.c_ldap_base_dn, buf,
553 sizeof config.c_ldap_base_dn);
556 safestrncpy(config.c_ldap_bind_dn, buf,
557 sizeof config.c_ldap_bind_dn);
560 safestrncpy(config.c_ldap_bind_pw, buf,
561 sizeof config.c_ldap_bind_pw);
565 safestrncpy(config.c_ip_addr, buf,
566 sizeof config.c_ip_addr);
568 config.c_msa_port = atoi(buf);
571 config.c_imaps_port = atoi(buf);
574 config.c_pop3s_port = atoi(buf);
577 config.c_smtps_port = atoi(buf);
580 config.c_enable_fulltext = atoi(buf);
583 config.c_auto_cull = atoi(buf);
586 config.c_instant_expunge = atoi(buf);
589 config.c_allow_spoofing = atoi(buf);
592 config.c_journal_email = atoi(buf);
595 config.c_journal_pubmsgs = atoi(buf);
598 safestrncpy(config.c_journal_dest, buf,
599 sizeof config.c_journal_dest);
601 safestrncpy(config.c_default_cal_zone, buf,
602 sizeof config.c_default_cal_zone);
605 config.c_pftcpdict_port = atoi(buf);
608 config.c_managesieve_port = atoi(buf);
611 config.c_auth_mode = atoi(buf);
613 safestrncpy(config.c_funambol_host, buf,
614 sizeof config.c_funambol_host);
617 config.c_funambol_port = atoi(buf);
620 safestrncpy(config.c_funambol_source,
622 sizeof config.c_funambol_source);
625 safestrncpy(config.c_funambol_auth,
627 sizeof config.c_funambol_auth);
630 config.c_rbl_at_greeting = atoi(buf);
633 safestrncpy(config.c_master_user, buf, sizeof config.c_master_user);
636 safestrncpy(config.c_master_pass, buf, sizeof config.c_master_pass);
639 safestrncpy(config.c_pager_program,
641 sizeof config.c_pager_program);
644 config.c_imap_keep_from = atoi(buf);
647 config.c_xmpp_c2s_port = atoi(buf);
650 config.c_xmpp_s2s_port = atoi(buf);
653 config.c_pop3_fetch = atol(buf);
656 config.c_pop3_fastest = atol(buf);
659 config.c_spam_flag_only = atoi(buf);
662 config.c_guest_logins = atoi(buf);
668 snprintf(buf, sizeof buf,
669 "The global system configuration has been edited by %s.\n",
671 CtdlAideMessage(buf,"Citadel Configuration Manager Message");
673 if (!IsEmptyStr(config.c_logpages))
674 CtdlCreateRoom(config.c_logpages, 3, "", 0, 1, 1, VIEW_BBS);
676 /* If full text indexing has been disabled, invalidate the
677 * index so it doesn't try to use it later.
679 if (config.c_enable_fulltext == 0) {
680 CitControl.fulltext_wordbreaker = 0;
685 else if (!strcasecmp(cmd, "GETSYS")) {
686 extract_token(confname, argbuf, 1, '|', sizeof confname);
687 confptr = CtdlGetSysConfig(confname);
688 if (confptr != NULL) {
691 len = strlen(confptr);
692 cprintf("%d %s\n", LISTING_FOLLOWS, confname);
693 client_write(confptr, len);
694 if ((len > 0) && (confptr[len - 1] != 10))
695 client_write("\n", 1);
699 cprintf("%d No such configuration.\n",
700 ERROR + ILLEGAL_VALUE);
704 else if (!strcasecmp(cmd, "PUTSYS")) {
705 extract_token(confname, argbuf, 1, '|', sizeof confname);
707 cprintf("%d %s\n", SEND_LISTING, confname);
708 confptr = CtdlReadMessageBody(HKEY("000"), config.c_maxmsglen, NULL, 0, 0);
709 CtdlPutSysConfig(confname, confptr);
714 cprintf("%d Illegal option(s) specified.\n",
715 ERROR + ILLEGAL_VALUE);
720 /*****************************************************************************/
721 /* MODULE INITIALIZATION STUFF */
722 /*****************************************************************************/
725 CTDL_MODULE_INIT(control)
728 CtdlRegisterProtoHook(cmd_conf, "CONF", "get/set system configuration");
730 /* return our id for the Log */