2 * Read and write the citadel.config file
4 * Copyright (c) 1987-2017 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.
20 #include <sys/utsname.h>
21 #include <libcitadel.h>
24 #include "ctdl_module.h"
26 long config_msgnum = 0;
27 HashList *ctdlconfig = NULL; // new configuration
30 void config_warn_if_port_unset(char *key, int default_port)
32 int p = CtdlGetConfigInt(key);
33 if ((p < -1) || (p == 0) || (p > UINT16_MAX))
35 syslog(LOG_ERR, "config: setting %s is not -1 (disabled) or a valid TCP port - setting to default %d", key, default_port);
36 CtdlSetConfigInt(key, default_port);
41 void config_warn_if_empty(char *key)
43 if (IsEmptyStr(CtdlGetConfigStr(key)))
45 syslog(LOG_ERR, "config: setting %s is empty, but must not - check your config!", key);
50 void validate_config(void) {
53 * these shouldn't be empty
55 config_warn_if_empty("c_fqdn");
56 config_warn_if_empty("c_baseroom");
57 config_warn_if_empty("c_aideroom");
58 config_warn_if_empty("c_twitroom");
59 config_warn_if_empty("c_nodename");
60 config_warn_if_empty("c_default_cal_zone");
63 * Sanity check for port bindings
65 config_warn_if_port_unset("c_smtp_port", 25);
66 config_warn_if_port_unset("c_pop3_port", 110);
67 config_warn_if_port_unset("c_imap_port", 143);
68 config_warn_if_port_unset("c_msa_port", 587);
69 config_warn_if_port_unset("c_port_number", 504);
70 config_warn_if_port_unset("c_smtps_port", 465);
71 config_warn_if_port_unset("c_pop3s_port", 995);
72 config_warn_if_port_unset("c_imaps_port", 993);
73 config_warn_if_port_unset("c_pftcpdict_port", -1);
74 config_warn_if_port_unset("c_managesieve_port", 2020);
75 config_warn_if_port_unset("c_xmpp_c2s_port", 5222);
76 config_warn_if_port_unset("c_xmpp_s2s_port", 5269);
77 config_warn_if_port_unset("c_nntp_port", 119);
78 config_warn_if_port_unset("c_nntps_port", 563);
80 if (getpwuid(ctdluid) == NULL) {
81 syslog(LOG_ERR, "config: uid (%d) does not exist ... citserver will run as root", ctdluid);
87 * Put some sane default values into our configuration. Some will be overridden when we run setup.
89 void brand_new_installation_set_defaults(void) {
91 struct utsname my_utsname;
93 char detected_hostname[256];
95 /* Determine our host name, in case we need to use it as a default */
98 /* set some sample/default values in place of blanks... */
99 extract_token(detected_hostname, my_utsname.nodename, 0, '.', sizeof detected_hostname);
100 CtdlSetConfigStr("c_nodename", detected_hostname);
102 if ((he = gethostbyname(my_utsname.nodename)) != NULL) {
103 CtdlSetConfigStr("c_fqdn", he->h_name);
106 CtdlSetConfigStr("c_fqdn", my_utsname.nodename);
109 CtdlSetConfigStr("c_humannode", "Citadel Server");
110 CtdlSetConfigInt("c_initax", 4);
111 CtdlSetConfigStr("c_moreprompt", "<more>");
112 CtdlSetConfigStr("c_twitroom", "Trashcan");
113 CtdlSetConfigStr("c_baseroom", BASEROOM);
114 CtdlSetConfigStr("c_aideroom", "Aide");
115 CtdlSetConfigInt("c_sleeping", 900);
117 if (CtdlGetConfigInt("c_createax") == 0) {
118 CtdlSetConfigInt("c_createax", 3);
122 * Default port numbers for various services
124 CtdlSetConfigInt("c_port_number", 504);
125 CtdlSetConfigInt("c_smtp_port", 25);
126 CtdlSetConfigInt("c_pop3_port", 110);
127 CtdlSetConfigInt("c_imap_port", 143);
128 CtdlSetConfigInt("c_msa_port", 587);
129 CtdlSetConfigInt("c_smtps_port", 465);
130 CtdlSetConfigInt("c_pop3s_port", 995);
131 CtdlSetConfigInt("c_imaps_port", 993);
132 CtdlSetConfigInt("c_pftcpdict_port", -1);
133 CtdlSetConfigInt("c_managesieve_port", 2020);
134 CtdlSetConfigInt("c_xmpp_c2s_port", 5222);
135 CtdlSetConfigInt("c_xmpp_s2s_port", 5269);
136 CtdlSetConfigInt("c_nntp_port", 119);
137 CtdlSetConfigInt("c_nntps_port", 563);
140 * Prevent the "new installation, set defaults" behavior from occurring again
142 CtdlSetConfigLong("c_config_created_or_migrated", (long)time(NULL));
147 * Migrate a supplied legacy configuration to the new in-db format.
148 * No individual site should ever have to do this more than once.
150 void migrate_legacy_config(struct legacy_config *lconfig)
152 CtdlSetConfigStr( "c_nodename" , lconfig->c_nodename );
153 CtdlSetConfigStr( "c_fqdn" , lconfig->c_fqdn );
154 CtdlSetConfigStr( "c_humannode" , lconfig->c_humannode );
155 CtdlSetConfigInt( "c_creataide" , lconfig->c_creataide );
156 CtdlSetConfigInt( "c_sleeping" , lconfig->c_sleeping );
157 CtdlSetConfigInt( "c_initax" , lconfig->c_initax );
158 CtdlSetConfigInt( "c_regiscall" , lconfig->c_regiscall );
159 CtdlSetConfigInt( "c_twitdetect" , lconfig->c_twitdetect );
160 CtdlSetConfigStr( "c_twitroom" , lconfig->c_twitroom );
161 CtdlSetConfigStr( "c_moreprompt" , lconfig->c_moreprompt );
162 CtdlSetConfigInt( "c_restrict" , lconfig->c_restrict );
163 CtdlSetConfigStr( "c_site_location" , lconfig->c_site_location );
164 CtdlSetConfigStr( "c_sysadm" , lconfig->c_sysadm );
165 CtdlSetConfigInt( "c_maxsessions" , lconfig->c_maxsessions );
166 CtdlSetConfigStr( "c_ip_addr" , lconfig->c_ip_addr );
167 CtdlSetConfigInt( "c_port_number" , lconfig->c_port_number );
168 CtdlSetConfigInt( "c_ep_mode" , lconfig->c_ep.expire_mode );
169 CtdlSetConfigInt( "c_ep_value" , lconfig->c_ep.expire_value );
170 CtdlSetConfigInt( "c_userpurge" , lconfig->c_userpurge );
171 CtdlSetConfigInt( "c_roompurge" , lconfig->c_roompurge );
172 CtdlSetConfigStr( "c_logpages" , lconfig->c_logpages );
173 CtdlSetConfigInt( "c_createax" , lconfig->c_createax );
174 CtdlSetConfigLong( "c_maxmsglen" , lconfig->c_maxmsglen );
175 CtdlSetConfigInt( "c_min_workers" , lconfig->c_min_workers );
176 CtdlSetConfigInt( "c_max_workers" , lconfig->c_max_workers );
177 CtdlSetConfigInt( "c_pop3_port" , lconfig->c_pop3_port );
178 CtdlSetConfigInt( "c_smtp_port" , lconfig->c_smtp_port );
179 CtdlSetConfigInt( "c_rfc822_strict_from" , lconfig->c_rfc822_strict_from );
180 CtdlSetConfigInt( "c_aide_zap" , lconfig->c_aide_zap );
181 CtdlSetConfigInt( "c_imap_port" , lconfig->c_imap_port );
182 CtdlSetConfigLong( "c_net_freq" , lconfig->c_net_freq );
183 CtdlSetConfigInt( "c_disable_newu" , lconfig->c_disable_newu );
184 CtdlSetConfigInt( "c_enable_fulltext" , lconfig->c_enable_fulltext );
185 CtdlSetConfigStr( "c_baseroom" , lconfig->c_baseroom );
186 CtdlSetConfigStr( "c_aideroom" , lconfig->c_aideroom );
187 CtdlSetConfigInt( "c_purge_hour" , lconfig->c_purge_hour );
188 CtdlSetConfigInt( "c_mbxep_mode" , lconfig->c_mbxep.expire_mode );
189 CtdlSetConfigInt( "c_mbxep_value" , lconfig->c_mbxep.expire_value );
190 CtdlSetConfigStr( "c_ldap_host" , lconfig->c_ldap_host );
191 CtdlSetConfigInt( "c_ldap_port" , lconfig->c_ldap_port );
192 CtdlSetConfigStr( "c_ldap_base_dn" , lconfig->c_ldap_base_dn );
193 CtdlSetConfigStr( "c_ldap_bind_dn" , lconfig->c_ldap_bind_dn );
194 CtdlSetConfigStr( "c_ldap_bind_pw" , lconfig->c_ldap_bind_pw );
195 CtdlSetConfigInt( "c_msa_port" , lconfig->c_msa_port );
196 CtdlSetConfigInt( "c_imaps_port" , lconfig->c_imaps_port );
197 CtdlSetConfigInt( "c_pop3s_port" , lconfig->c_pop3s_port );
198 CtdlSetConfigInt( "c_smtps_port" , lconfig->c_smtps_port );
199 CtdlSetConfigInt( "c_auto_cull" , lconfig->c_auto_cull );
200 CtdlSetConfigInt( "c_allow_spoofing" , lconfig->c_allow_spoofing );
201 CtdlSetConfigInt( "c_journal_email" , lconfig->c_journal_email );
202 CtdlSetConfigInt( "c_journal_pubmsgs" , lconfig->c_journal_pubmsgs );
203 CtdlSetConfigStr( "c_journal_dest" , lconfig->c_journal_dest );
204 CtdlSetConfigStr( "c_default_cal_zone" , lconfig->c_default_cal_zone );
205 CtdlSetConfigInt( "c_pftcpdict_port" , lconfig->c_pftcpdict_port );
206 CtdlSetConfigInt( "c_managesieve_port" , lconfig->c_managesieve_port );
207 CtdlSetConfigInt( "c_auth_mode" , lconfig->c_auth_mode );
208 CtdlSetConfigInt( "c_rbl_at_greeting" , lconfig->c_rbl_at_greeting );
209 CtdlSetConfigStr( "c_master_user" , lconfig->c_master_user );
210 CtdlSetConfigStr( "c_master_pass" , lconfig->c_master_pass );
211 CtdlSetConfigStr( "c_pager_program" , lconfig->c_pager_program );
212 CtdlSetConfigInt( "c_imap_keep_from" , lconfig->c_imap_keep_from );
213 CtdlSetConfigInt( "c_xmpp_c2s_port" , lconfig->c_xmpp_c2s_port );
214 CtdlSetConfigInt( "c_xmpp_s2s_port" , lconfig->c_xmpp_s2s_port );
215 CtdlSetConfigLong( "c_pop3_fetch" , lconfig->c_pop3_fetch );
216 CtdlSetConfigLong( "c_pop3_fastest" , lconfig->c_pop3_fastest );
217 CtdlSetConfigInt( "c_spam_flag_only" , lconfig->c_spam_flag_only );
218 CtdlSetConfigInt( "c_guest_logins" , lconfig->c_guest_logins );
219 CtdlSetConfigInt( "c_nntp_port" , lconfig->c_nntp_port );
220 CtdlSetConfigInt( "c_nntps_port" , lconfig->c_nntps_port );
225 * Called during the initialization of Citadel server.
226 * It verifies the system's integrity and reads citadel.config into memory.
228 void initialize_config_system(void) {
231 struct legacy_config lconfig; // legacy configuration
232 ctdlconfig = NewHash(1, NULL); // set up the real config system
234 /* Ensure that we are linked to the correct version of libcitadel */
235 if (libcitadel_version_number() < LIBCITADEL_VERSION_NUMBER) {
236 fprintf(stderr, "You are running libcitadel version %d\n", libcitadel_version_number());
237 fprintf(stderr, "citserver was compiled against version %d\n", LIBCITADEL_VERSION_NUMBER);
238 exit(CTDLEXIT_LIBCITADEL);
241 if (chdir(ctdl_bbsbase_dir) != 0) {
243 "This program could not be started.\nUnable to change directory to %s\nError: %s\n",
250 memset(&lconfig, 0, sizeof(struct legacy_config));
251 cfp = fopen(file_citadel_config, "rb");
253 if (CtdlGetConfigLong("c_config_created_or_migrated") > 0) {
254 fprintf(stderr, "Citadel Server found BOTH legacy and new configurations present.\n");
255 fprintf(stderr, "Exiting to prevent data corruption.\n");
256 exit(CTDLEXIT_CONFIG);
258 rv = fread((char *) &lconfig, sizeof(struct legacy_config), 1, cfp);
262 "Warning: Found a legacy config file %s has unexpected size. \n",
267 migrate_legacy_config(&lconfig);
270 if (unlink(file_citadel_config) != 0) {
271 fprintf(stderr, "Unable to remove legacy config file %s after migrating it.\n", file_citadel_config);
272 fprintf(stderr, "Exiting to prevent data corruption.\n");
273 exit(CTDLEXIT_CONFIG);
277 * Prevent migration/initialization from happening again.
279 CtdlSetConfigLong("c_config_created_or_migrated", (long)time(NULL));
283 /* New installation? Set up configuration */
284 if (CtdlGetConfigLong("c_config_created_or_migrated") <= 0) {
285 brand_new_installation_set_defaults();
288 /* Only allow LDAP auth mode if we actually have LDAP support */
290 if ((CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP) || (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD)) {
291 fprintf(stderr, "Your system is configured for LDAP authentication,\n"
292 "but you are running a server built without OpenLDAP support.\n");
293 exit(CTDL_EXIT_UNSUP_AUTH);
297 /* Default maximum message length is 10 megabytes. This is site
298 * configurable. Also check to make sure the limit has not been
299 * set below 8192 bytes.
301 if (CtdlGetConfigLong("c_maxmsglen") <= 0) CtdlSetConfigLong("c_maxmsglen", 10485760);
302 if (CtdlGetConfigLong("c_maxmsglen") < 8192) CtdlSetConfigLong("c_maxmsglen", 8192);
305 * Default lower and upper limits on number of worker threads
307 if (CtdlGetConfigInt("c_min_workers") < 5) CtdlSetConfigInt("c_min_workers", 5); // min
308 if (CtdlGetConfigInt("c_max_workers") == 0) CtdlSetConfigInt("c_max_workers", 256); // default max
309 if (CtdlGetConfigInt("c_max_workers") < CtdlGetConfigInt("c_min_workers")) {
310 CtdlSetConfigInt("c_max_workers", CtdlGetConfigInt("c_min_workers")); // max >= min
313 /* Networking more than once every five minutes just isn't sane */
314 if (CtdlGetConfigLong("c_net_freq") == 0) CtdlSetConfigLong("c_net_freq", 3600); // once per hour default
315 if (CtdlGetConfigLong("c_net_freq") < 300) CtdlSetConfigLong("c_net_freq", 300); // minimum 5 minutes
317 /* Same goes for POP3 */
318 if (CtdlGetConfigLong("c_pop3_fetch") == 0) CtdlSetConfigLong("c_pop3_fetch", 3600); // once per hour default
319 if (CtdlGetConfigLong("c_pop3_fetch") < 300) CtdlSetConfigLong("c_pop3_fetch", 300); // 5 minutes min
320 if (CtdlGetConfigLong("c_pop3_fastest") == 0) CtdlSetConfigLong("c_pop3_fastest", 3600); // once per hour default
321 if (CtdlGetConfigLong("c_pop3_fastest") < 300) CtdlSetConfigLong("c_pop3_fastest", 300); // 5 minutes min
323 /* LDAP sync frequency */
324 if (CtdlGetConfigLong("c_ldap_sync_freq") == 0) CtdlSetConfigLong("c_ldap_sync_freq", 300); // every 5 minutes default
326 /* "create new user" only works with native authentication mode */
327 if (CtdlGetConfigInt("c_auth_mode") != AUTHMODE_NATIVE) {
328 CtdlSetConfigInt("c_disable_newu", 1);
334 * Called when Citadel server is shutting down.
335 * Clears out the config hash table.
337 void shutdown_config_system(void)
339 DeleteHash(&ctdlconfig);
344 * Set a system config value. Simple key/value here.
346 void CtdlSetConfigStr(char *key, char *value)
348 int key_len = strlen(key);
349 int value_len = strlen(value);
351 /* Save it in memory */
352 Put(ctdlconfig, key, key_len, strdup(value), NULL);
354 /* Also write it to the config database */
356 int dbv_size = key_len + value_len + 2;
357 char *dbv = malloc(dbv_size);
359 strcpy(&dbv[key_len + 1], value);
360 cdb_store(CDB_CONFIG, key, key_len, dbv, dbv_size);
366 * Set a numeric system config value (long integer)
368 void CtdlSetConfigLong(char *key, long value)
371 sprintf(longstr, "%ld", value);
372 CtdlSetConfigStr(key, longstr);
377 * Set a numeric system config value (integer)
379 void CtdlSetConfigInt(char *key, int value)
382 sprintf(intstr, "%d", value);
383 CtdlSetConfigStr(key, intstr);
388 * Delete a system config value.
390 void CtdlDelConfig(char *key)
392 int key_len = strlen(key);
394 if (IsEmptyStr(key)) return;
396 /* Delete from the database. */
397 cdb_delete(CDB_CONFIG, key, key_len);
399 /* Delete from the in-memory cache */
400 HashPos *Pos = GetNewHashPos(ctdlconfig, 1);
401 if (GetHashPosFromKey(ctdlconfig, key, key_len, Pos)) {
402 DeleteEntryFromHash(ctdlconfig, Pos);
406 assert(Pos == NULL); // no memory leaks allowed
411 * Fetch a system config value. Caller does *not* own the returned value and may not alter it.
413 char *CtdlGetConfigStr(char *key)
417 int key_len = strlen(key);
419 if (IsEmptyStr(key)) return(NULL);
421 /* First look in memory */
422 if (GetHash(ctdlconfig, key, key_len, (void *)&value))
427 /* Then look in the database. */
429 cdb = cdb_fetch(CDB_CONFIG, key, key_len);
431 if (cdb == NULL) { /* nope, not there either. */
435 /* Got it. Save it in memory for the next fetch. */
436 value = strdup(cdb->ptr + key_len + 1); /* The key was stored there too; skip past it */
438 Put(ctdlconfig, key, key_len, value, NULL);
444 * Fetch a system config value - integer
446 int CtdlGetConfigInt(char *key)
448 char *s = CtdlGetConfigStr(key);
449 if (s) return atoi(s);
455 * Fetch a system config value - long integer
457 long CtdlGetConfigLong(char *key)
459 char *s = CtdlGetConfigStr(key);
460 if (s) return atol(s);
465 void CtdlGetSysConfigBackend(long msgnum, void *userdata) {
466 config_msgnum = msgnum;
470 char *CtdlGetSysConfig(char *sysconfname) {
471 char hold_rm[ROOMNAMELEN];
474 struct CtdlMessage *msg;
477 strcpy(hold_rm, CC->room.QRname);
478 if (CtdlGetRoom(&CC->room, SYSCONFIGROOM) != 0) {
479 CtdlGetRoom(&CC->room, hold_rm);
483 /* We want the last (and probably only) config in this room */
484 begin_critical_section(S_CONFIG);
485 config_msgnum = (-1L);
486 CtdlForEachMessage(MSGS_LAST, 1, NULL, sysconfname, NULL, CtdlGetSysConfigBackend, NULL);
487 msgnum = config_msgnum;
488 end_critical_section(S_CONFIG);
494 msg = CtdlFetchMessage(msgnum, 1, 1);
496 conf = strdup(msg->cm_fields[eMesageText]);
504 CtdlGetRoom(&CC->room, hold_rm);
508 extract_token(buf, conf, 0, '\n', sizeof buf);
509 strcpy(conf, &conf[strlen(buf)+1]);
510 } while ( (!IsEmptyStr(conf)) && (!IsEmptyStr(buf)) );
517 void CtdlPutSysConfig(char *sysconfname, char *sysconfdata) {
518 CtdlWriteObject(SYSCONFIGROOM, sysconfname, sysconfdata, (strlen(sysconfdata)+1), NULL, 0, 1, 0);