2 * Read and write the citadel.config file
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 <sys/utsname.h>
18 #include <libcitadel.h>
20 #include "ctdl_module.h"
23 struct configlen configlen;
25 #define STR_NOT_EMPTY(CFG_FIELDNAME) if (IsEmptyStr(config.CFG_FIELDNAME)) \
26 syslog(LOG_EMERG, "configuration setting "#CFG_FIELDNAME" is empty, but must not - check your config!");
28 #define TEST_PORT(CFG_PORT, DEFAULTPORT) \
29 if ((config.CFG_PORT < -1) || \
30 (config.CFG_PORT == 0) || \
31 (config.CFG_PORT > UINT16_MAX)) \
32 syslog(LOG_EMERG, "configuration setting "#CFG_PORT" is not -1 (disabled) or a valid TCP-Port - check your config! Default setting is: "#DEFAULTPORT);
35 void validate_config(void) {
36 /* these shouldn't be empty: */
37 STR_NOT_EMPTY(c_fqdn);
39 STR_NOT_EMPTY(c_baseroom);
40 STR_NOT_EMPTY(c_aideroom);
41 STR_NOT_EMPTY(c_twitroom);
42 STR_NOT_EMPTY(c_nodename);
43 STR_NOT_EMPTY(c_default_cal_zone);
45 /* we bind a lot of ports: */
46 TEST_PORT(c_smtp_port, 25);
47 TEST_PORT(c_pop3_port, 110);
48 TEST_PORT(c_imap_port, 143);
49 TEST_PORT(c_msa_port, 587);
50 TEST_PORT(c_port_number, 504);
51 TEST_PORT(c_smtps_port, 465);
52 TEST_PORT(c_pop3s_port, 995);
53 TEST_PORT(c_imaps_port, 993);
54 TEST_PORT(c_pftcpdict_port, -1);
55 TEST_PORT(c_managesieve_port, 2020);
56 TEST_PORT(c_xmpp_c2s_port, 5222);
57 TEST_PORT(c_xmpp_s2s_port, 5269);
58 TEST_PORT(c_nntp_port, 119);
59 TEST_PORT(c_nntps_port, 563);
61 if (config.c_ctdluid == 0)
62 syslog(LOG_EMERG, "citadel should not be configured to run as root! Check the value of c_ctdluid");
63 else if (getpwuid(CTDLUID) == NULL)
64 syslog(LOG_EMERG, "The UID (%d) citadel is configured to use is not defined in your system (/etc/passwd?)! Check the value of c_ctdluid", CTDLUID);
69 * Put some sane default values into our configuration. Some will be overridden when we run setup.
71 void brand_new_installation_set_defaults(void) {
74 struct utsname my_utsname;
77 /* Determine our host name, in case we need to use it as a default */
79 memset(&configlen, 0, sizeof(struct configlen));
80 /* set some sample/default values in place of blanks... */
81 configlen.c_nodename = extract_token(config.c_nodename, my_utsname.nodename, 0, '.', sizeof config.c_nodename);
82 if (IsEmptyStr(config.c_fqdn) ) {
83 if ((he = gethostbyname(my_utsname.nodename)) != NULL) {
84 configlen.c_fqdn = safestrncpy(config.c_fqdn, he->h_name, sizeof config.c_fqdn);
87 configlen.c_fqdn = safestrncpy(config.c_fqdn, my_utsname.nodename, sizeof config.c_fqdn);
91 configlen.c_humannode = safestrncpy(config.c_humannode, "Citadel Server", sizeof config.c_humannode);
92 configlen.c_phonenum = safestrncpy(config.c_phonenum, "US 800 555 1212", sizeof config.c_phonenum);
94 configlen.c_moreprompt = safestrncpy(config.c_moreprompt, "<more>", sizeof config.c_moreprompt);
95 configlen.c_twitroom = safestrncpy(config.c_twitroom, "Trashcan", sizeof config.c_twitroom);
96 configlen.c_baseroom = safestrncpy(config.c_baseroom, BASEROOM, sizeof config.c_baseroom);
97 configlen.c_aideroom = safestrncpy(config.c_aideroom, "Aide", sizeof config.c_aideroom);
98 config.c_port_number = 504;
99 config.c_sleeping = 900;
101 if (config.c_ctdluid == 0) {
102 pw = getpwnam("citadel");
104 config.c_ctdluid = pw->pw_uid;
107 if (config.c_ctdluid == 0) {
108 pw = getpwnam("bbs");
110 config.c_ctdluid = pw->pw_uid;
113 if (config.c_ctdluid == 0) {
114 pw = getpwnam("guest");
116 config.c_ctdluid = pw->pw_uid;
119 if (config.c_createax == 0) {
120 config.c_createax = 3;
124 * Default port numbers for various services
126 config.c_smtp_port = 25;
127 config.c_pop3_port = 110;
128 config.c_imap_port = 143;
129 config.c_msa_port = 587;
130 config.c_smtps_port = 465;
131 config.c_pop3s_port = 995;
132 config.c_imaps_port = 993;
133 config.c_pftcpdict_port = -1 ;
134 config.c_managesieve_port = 2020;
135 config.c_xmpp_c2s_port = 5222;
136 config.c_xmpp_s2s_port = 5269;
137 config.c_nntp_port = 119;
138 config.c_nntps_port = 563;
143 configlen.c_nodename = strlen(config.c_nodename);
144 configlen.c_fqdn = strlen(config.c_fqdn);
145 configlen.c_humannode = strlen(config.c_humannode);
146 configlen.c_phonenum = strlen(config.c_phonenum);
147 configlen.c_twitroom = strlen(config.c_twitroom);
148 configlen.c_moreprompt = strlen(config.c_moreprompt);
149 configlen.c_site_location = strlen(config.c_site_location);
150 configlen.c_sysadm = strlen(config.c_sysadm);
151 configlen.c_niu_2 = strlen(config.c_niu_2);
152 configlen.c_ip_addr = strlen(config.c_ip_addr);
153 configlen.c_logpages = strlen(config.c_logpages);
154 configlen.c_baseroom = strlen(config.c_baseroom);
155 configlen.c_aideroom = strlen(config.c_aideroom);
156 configlen.c_ldap_host = strlen(config.c_ldap_host);
157 configlen.c_ldap_base_dn = strlen(config.c_ldap_base_dn);
158 configlen.c_ldap_bind_dn = strlen(config.c_ldap_bind_dn);
159 configlen.c_ldap_bind_pw = strlen(config.c_ldap_bind_pw);
160 configlen.c_journal_dest = strlen(config.c_journal_dest);
161 configlen.c_default_cal_zone = strlen(config.c_default_cal_zone);
162 configlen.c_funambol_host = strlen(config.c_funambol_host);
163 configlen.c_funambol_source = strlen(config.c_funambol_source);
164 configlen.c_funambol_auth = strlen(config.c_funambol_auth);
165 configlen.c_master_user = strlen(config.c_master_user);
166 configlen.c_master_pass = strlen(config.c_master_pass);
167 configlen.c_pager_program = strlen(config.c_pager_program);
173 * Called during the initialization of Citadel server.
174 * It verifies the system's integrity and reads citadel.config into memory.
176 void get_config(void) {
180 if (chdir(ctdl_bbsbase_dir) != 0) {
182 "This program could not be started.\nUnable to change directory to %s\nError: %s\n",
189 memset(&config, 0, sizeof(struct config));
190 cfp = fopen(file_citadel_config, "rb");
192 rv = fread((char *) &config, sizeof(struct config), 1, cfp);
196 "Warning: The config file %s has unexpected size. \n",
204 brand_new_installation_set_defaults();
207 /* Ensure that we are linked to the correct version of libcitadel */
208 if (libcitadel_version_number() < LIBCITADEL_VERSION_NUMBER) {
209 fprintf(stderr, " You are running libcitadel version %d.%02d\n",
210 (libcitadel_version_number() / 100), (libcitadel_version_number() % 100));
211 fprintf(stderr, "citserver was compiled against version %d.%02d\n",
212 (LIBCITADEL_VERSION_NUMBER / 100), (LIBCITADEL_VERSION_NUMBER % 100));
213 exit(CTDLEXIT_LIBCITADEL);
216 /* Only allow LDAP auth mode if we actually have LDAP support */
218 if ((config.c_auth_mode == AUTHMODE_LDAP) || (config.c_auth_mode == AUTHMODE_LDAP_AD)) {
219 fprintf(stderr, "Your system is configured for LDAP authentication,\n"
220 "but you are running a server built without OpenLDAP support.\n");
221 exit(CTDL_EXIT_UNSUP_AUTH);
225 /* Default maximum message length is 10 megabytes. This is site
226 * configurable. Also check to make sure the limit has not been
227 * set below 8192 bytes.
229 if (config.c_maxmsglen <= 0)
230 config.c_maxmsglen = 10485760;
231 if (config.c_maxmsglen < 8192)
232 config.c_maxmsglen = 8192;
234 /* Default lower and upper limits on number of worker threads */
236 if (config.c_min_workers < 3) /* no less than 3 */
237 config.c_min_workers = 5;
239 if (config.c_max_workers == 0) /* default maximum */
240 config.c_max_workers = 256;
242 if (config.c_max_workers < config.c_min_workers) /* max >= min */
243 config.c_max_workers = config.c_min_workers;
245 /* Networking more than once every five minutes just isn't sane */
246 if (config.c_net_freq == 0L)
247 config.c_net_freq = 3600L; /* once per hour default */
248 if (config.c_net_freq < 300L)
249 config.c_net_freq = 300L;
251 /* Same goes for POP3 */
252 if (config.c_pop3_fetch == 0L)
253 config.c_pop3_fetch = 3600L; /* once per hour default */
254 if (config.c_pop3_fetch < 300L)
255 config.c_pop3_fetch = 300L;
256 if (config.c_pop3_fastest == 0L)
257 config.c_pop3_fastest = 3600L; /* once per hour default */
258 if (config.c_pop3_fastest < 300L)
259 config.c_pop3_fastest = 300L;
261 /* "create new user" only works with native authentication mode */
262 if (config.c_auth_mode != AUTHMODE_NATIVE) {
263 config.c_disable_newu = 1;
267 long config_msgnum = 0;
270 * Occasionally, we will need to write the config file, because some operations
271 * change site-wide parameters.
273 void put_config(void)
276 int blocks_written = 0;
278 cfp = fopen(file_citadel_config, "w");
280 blocks_written = fwrite((char *) &config, sizeof(struct config), 1, cfp);
281 if (blocks_written == 1) {
282 chown(file_citadel_config, CTDLUID, (-1));
283 chmod(file_citadel_config, 0600);
289 syslog(LOG_EMERG, "%s: %s", file_citadel_config, strerror(errno));
294 void CtdlGetSysConfigBackend(long msgnum, void *userdata) {
295 config_msgnum = msgnum;
299 char *CtdlGetSysConfig(char *sysconfname) {
300 char hold_rm[ROOMNAMELEN];
303 struct CtdlMessage *msg;
306 strcpy(hold_rm, CC->room.QRname);
307 if (CtdlGetRoom(&CC->room, SYSCONFIGROOM) != 0) {
308 CtdlGetRoom(&CC->room, hold_rm);
313 /* We want the last (and probably only) config in this room */
314 begin_critical_section(S_CONFIG);
315 config_msgnum = (-1L);
316 CtdlForEachMessage(MSGS_LAST, 1, NULL, sysconfname, NULL,
317 CtdlGetSysConfigBackend, NULL);
318 msgnum = config_msgnum;
319 end_critical_section(S_CONFIG);
325 msg = CtdlFetchMessage(msgnum, 1);
327 conf = strdup(msg->cm_fields[eMesageText]);
335 CtdlGetRoom(&CC->room, hold_rm);
337 if (conf != NULL) do {
338 extract_token(buf, conf, 0, '\n', sizeof buf);
339 strcpy(conf, &conf[strlen(buf)+1]);
340 } while ( (!IsEmptyStr(conf)) && (!IsEmptyStr(buf)) );
346 void CtdlPutSysConfig(char *sysconfname, char *sysconfdata) {
347 CtdlWriteObject(SYSCONFIGROOM, sysconfname, sysconfdata, (strlen(sysconfdata)+1), NULL, 0, 1, 0);