46105383bccbdb45333c4beb69fa5d1defdb2b0e
[citadel.git] / citadel / config.c
1 /*
2  * Read and write the citadel.config file
3  *
4  * Copyright (c) 1987-2017 by the citadel.org team
5  *
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.
8  *
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.
13  */
14
15 #include "sysdep.h"
16 #include <stdio.h>
17 #include <sys/utsname.h>
18 #include <libcitadel.h>
19 #include <assert.h>
20 #include "config.h"
21 #include "ctdl_module.h"
22
23 long config_msgnum = 0;
24 HashList *ctdlconfig = NULL;    // new configuration
25
26
27 void config_warn_if_port_unset(char *key, int default_port)                     \
28 {
29         int p = CtdlGetConfigInt(key);
30         if ((p < -1) || (p == 0) || (p > UINT16_MAX))
31         {
32                 syslog(LOG_ERR,
33                         "config: setting %s is not -1 (disabled) or a valid TCP-Port - check your config! Default setting is: %d",
34                         key, default_port
35                 );
36         }
37 }
38
39
40 void config_warn_if_empty(char *key)
41 {
42         if (IsEmptyStr(CtdlGetConfigStr(key)))
43         {
44                 syslog(LOG_ERR, "config: setting %s is empty, but must not - check your config!", key);
45         }
46 }
47
48
49 void validate_config(void) {
50
51         /*
52          * these shouldn't be empty
53          */
54         config_warn_if_empty("c_fqdn");
55         config_warn_if_empty("c_baseroom");
56         config_warn_if_empty("c_aideroom");
57         config_warn_if_empty("c_twitroom");
58         config_warn_if_empty("c_nodename");
59         config_warn_if_empty("c_default_cal_zone");
60
61         /*
62          * Sanity check for port bindings
63          */
64         config_warn_if_port_unset("c_smtp_port", 25);
65         config_warn_if_port_unset("c_pop3_port", 110);
66         config_warn_if_port_unset("c_imap_port", 143);
67         config_warn_if_port_unset("c_msa_port", 587);
68         config_warn_if_port_unset("c_port_number", 504);
69         config_warn_if_port_unset("c_smtps_port", 465);
70         config_warn_if_port_unset("c_pop3s_port", 995);
71         config_warn_if_port_unset("c_imaps_port", 993);
72         config_warn_if_port_unset("c_pftcpdict_port", -1);
73         config_warn_if_port_unset("c_managesieve_port", 2020);
74         config_warn_if_port_unset("c_xmpp_c2s_port", 5222);
75         config_warn_if_port_unset("c_xmpp_s2s_port", 5269);
76         config_warn_if_port_unset("c_nntp_port", 119);
77         config_warn_if_port_unset("c_nntps_port", 563);
78
79         if (getpwuid(ctdluid) == NULL) {
80                 syslog(LOG_ERR, "config: UID (%d) citadel is configured to use is not defined in your system (/etc/passwd?)!", ctdluid);
81         }
82 }
83
84
85 /*
86  * Put some sane default values into our configuration.  Some will be overridden when we run setup.
87  */
88 void brand_new_installation_set_defaults(void) {
89
90         struct utsname my_utsname;
91         struct hostent *he;
92         char detected_hostname[256];
93
94         /* Determine our host name, in case we need to use it as a default */
95         uname(&my_utsname);
96
97         /* set some sample/default values in place of blanks... */
98         extract_token(detected_hostname, my_utsname.nodename, 0, '.', sizeof detected_hostname);
99         CtdlSetConfigStr("c_nodename", detected_hostname);
100
101         if ((he = gethostbyname(my_utsname.nodename)) != NULL) {
102                 CtdlSetConfigStr("c_fqdn", he->h_name);
103         }
104         else {
105                 CtdlSetConfigStr("c_fqdn", my_utsname.nodename);
106         }
107
108         CtdlSetConfigStr("c_humannode",         "Citadel Server");
109         CtdlSetConfigInt("c_initax",            4);
110         CtdlSetConfigStr("c_moreprompt",        "<more>");
111         CtdlSetConfigStr("c_twitroom",          "Trashcan");
112         CtdlSetConfigStr("c_baseroom",          BASEROOM);
113         CtdlSetConfigStr("c_aideroom",          "Aide");
114         CtdlSetConfigInt("c_sleeping",          900);
115
116         if (CtdlGetConfigInt("c_createax") == 0) {
117                 CtdlSetConfigInt("c_createax", 3);
118         }
119
120         /*
121          * Default port numbers for various services
122          */
123         CtdlSetConfigInt("c_port_number",       504);
124         CtdlSetConfigInt("c_smtp_port",         25);
125         CtdlSetConfigInt("c_pop3_port",         110);
126         CtdlSetConfigInt("c_imap_port",         143);
127         CtdlSetConfigInt("c_msa_port",          587);
128         CtdlSetConfigInt("c_smtps_port",        465);
129         CtdlSetConfigInt("c_pop3s_port",        995);
130         CtdlSetConfigInt("c_imaps_port",        993);
131         CtdlSetConfigInt("c_pftcpdict_port",    -1);
132         CtdlSetConfigInt("c_managesieve_port",  2020);
133         CtdlSetConfigInt("c_xmpp_c2s_port",     5222);
134         CtdlSetConfigInt("c_xmpp_s2s_port",     5269);
135         CtdlSetConfigInt("c_nntp_port",         119);
136         CtdlSetConfigInt("c_nntps_port",        563);
137
138         /*
139          * Prevent the "new installation, set defaults" behavior from occurring again
140          */
141         CtdlSetConfigLong("c_config_created_or_migrated", (long)time(NULL));
142 }
143
144
145 /*
146  * Migrate a supplied legacy configuration to the new in-db format.
147  * No individual site should ever have to do this more than once.
148  */
149 void migrate_legacy_config(struct legacy_config *lconfig)
150 {
151         CtdlSetConfigStr(       "c_nodename"            ,       lconfig->c_nodename             );
152         CtdlSetConfigStr(       "c_fqdn"                ,       lconfig->c_fqdn                 );
153         CtdlSetConfigStr(       "c_humannode"           ,       lconfig->c_humannode            );
154         CtdlSetConfigInt(       "c_creataide"           ,       lconfig->c_creataide            );
155         CtdlSetConfigInt(       "c_sleeping"            ,       lconfig->c_sleeping             );
156         CtdlSetConfigInt(       "c_initax"              ,       lconfig->c_initax               );
157         CtdlSetConfigInt(       "c_regiscall"           ,       lconfig->c_regiscall            );
158         CtdlSetConfigInt(       "c_twitdetect"          ,       lconfig->c_twitdetect           );
159         CtdlSetConfigStr(       "c_twitroom"            ,       lconfig->c_twitroom             );
160         CtdlSetConfigStr(       "c_moreprompt"          ,       lconfig->c_moreprompt           );
161         CtdlSetConfigInt(       "c_restrict"            ,       lconfig->c_restrict             );
162         CtdlSetConfigStr(       "c_site_location"       ,       lconfig->c_site_location        );
163         CtdlSetConfigStr(       "c_sysadm"              ,       lconfig->c_sysadm               );
164         CtdlSetConfigInt(       "c_maxsessions"         ,       lconfig->c_maxsessions          );
165         CtdlSetConfigStr(       "c_ip_addr"             ,       lconfig->c_ip_addr              );
166         CtdlSetConfigInt(       "c_port_number"         ,       lconfig->c_port_number          );
167         CtdlSetConfigInt(       "c_ep_mode"             ,       lconfig->c_ep.expire_mode       );
168         CtdlSetConfigInt(       "c_ep_value"            ,       lconfig->c_ep.expire_value      );
169         CtdlSetConfigInt(       "c_userpurge"           ,       lconfig->c_userpurge            );
170         CtdlSetConfigInt(       "c_roompurge"           ,       lconfig->c_roompurge            );
171         CtdlSetConfigStr(       "c_logpages"            ,       lconfig->c_logpages             );
172         CtdlSetConfigInt(       "c_createax"            ,       lconfig->c_createax             );
173         CtdlSetConfigLong(      "c_maxmsglen"           ,       lconfig->c_maxmsglen            );
174         CtdlSetConfigInt(       "c_min_workers"         ,       lconfig->c_min_workers          );
175         CtdlSetConfigInt(       "c_max_workers"         ,       lconfig->c_max_workers          );
176         CtdlSetConfigInt(       "c_pop3_port"           ,       lconfig->c_pop3_port            );
177         CtdlSetConfigInt(       "c_smtp_port"           ,       lconfig->c_smtp_port            );
178         CtdlSetConfigInt(       "c_rfc822_strict_from"  ,       lconfig->c_rfc822_strict_from   );
179         CtdlSetConfigInt(       "c_aide_zap"            ,       lconfig->c_aide_zap             );
180         CtdlSetConfigInt(       "c_imap_port"           ,       lconfig->c_imap_port            );
181         CtdlSetConfigLong(      "c_net_freq"            ,       lconfig->c_net_freq             );
182         CtdlSetConfigInt(       "c_disable_newu"        ,       lconfig->c_disable_newu         );
183         CtdlSetConfigInt(       "c_enable_fulltext"     ,       lconfig->c_enable_fulltext      );
184         CtdlSetConfigStr(       "c_baseroom"            ,       lconfig->c_baseroom             );
185         CtdlSetConfigStr(       "c_aideroom"            ,       lconfig->c_aideroom             );
186         CtdlSetConfigInt(       "c_purge_hour"          ,       lconfig->c_purge_hour           );
187         CtdlSetConfigInt(       "c_mbxep_mode"          ,       lconfig->c_mbxep.expire_mode    );
188         CtdlSetConfigInt(       "c_mbxep_value"         ,       lconfig->c_mbxep.expire_value   );
189         CtdlSetConfigStr(       "c_ldap_host"           ,       lconfig->c_ldap_host            );
190         CtdlSetConfigInt(       "c_ldap_port"           ,       lconfig->c_ldap_port            );
191         CtdlSetConfigStr(       "c_ldap_base_dn"        ,       lconfig->c_ldap_base_dn         );
192         CtdlSetConfigStr(       "c_ldap_bind_dn"        ,       lconfig->c_ldap_bind_dn         );
193         CtdlSetConfigStr(       "c_ldap_bind_pw"        ,       lconfig->c_ldap_bind_pw         );
194         CtdlSetConfigInt(       "c_msa_port"            ,       lconfig->c_msa_port             );
195         CtdlSetConfigInt(       "c_imaps_port"          ,       lconfig->c_imaps_port           );
196         CtdlSetConfigInt(       "c_pop3s_port"          ,       lconfig->c_pop3s_port           );
197         CtdlSetConfigInt(       "c_smtps_port"          ,       lconfig->c_smtps_port           );
198         CtdlSetConfigInt(       "c_auto_cull"           ,       lconfig->c_auto_cull            );
199         CtdlSetConfigInt(       "c_allow_spoofing"      ,       lconfig->c_allow_spoofing       );
200         CtdlSetConfigInt(       "c_journal_email"       ,       lconfig->c_journal_email        );
201         CtdlSetConfigInt(       "c_journal_pubmsgs"     ,       lconfig->c_journal_pubmsgs      );
202         CtdlSetConfigStr(       "c_journal_dest"        ,       lconfig->c_journal_dest         );
203         CtdlSetConfigStr(       "c_default_cal_zone"    ,       lconfig->c_default_cal_zone     );
204         CtdlSetConfigInt(       "c_pftcpdict_port"      ,       lconfig->c_pftcpdict_port       );
205         CtdlSetConfigInt(       "c_managesieve_port"    ,       lconfig->c_managesieve_port     );
206         CtdlSetConfigInt(       "c_auth_mode"           ,       lconfig->c_auth_mode            );
207         CtdlSetConfigStr(       "c_funambol_host"       ,       lconfig->c_funambol_host        );
208         CtdlSetConfigInt(       "c_funambol_port"       ,       lconfig->c_funambol_port        );
209         CtdlSetConfigStr(       "c_funambol_source"     ,       lconfig->c_funambol_source      );
210         CtdlSetConfigStr(       "c_funambol_auth"       ,       lconfig->c_funambol_auth        );
211         CtdlSetConfigInt(       "c_rbl_at_greeting"     ,       lconfig->c_rbl_at_greeting      );
212         CtdlSetConfigStr(       "c_master_user"         ,       lconfig->c_master_user          );
213         CtdlSetConfigStr(       "c_master_pass"         ,       lconfig->c_master_pass          );
214         CtdlSetConfigStr(       "c_pager_program"       ,       lconfig->c_pager_program        );
215         CtdlSetConfigInt(       "c_imap_keep_from"      ,       lconfig->c_imap_keep_from       );
216         CtdlSetConfigInt(       "c_xmpp_c2s_port"       ,       lconfig->c_xmpp_c2s_port        );
217         CtdlSetConfigInt(       "c_xmpp_s2s_port"       ,       lconfig->c_xmpp_s2s_port        );
218         CtdlSetConfigLong(      "c_pop3_fetch"          ,       lconfig->c_pop3_fetch           );
219         CtdlSetConfigLong(      "c_pop3_fastest"        ,       lconfig->c_pop3_fastest         );
220         CtdlSetConfigInt(       "c_spam_flag_only"      ,       lconfig->c_spam_flag_only       );
221         CtdlSetConfigInt(       "c_guest_logins"        ,       lconfig->c_guest_logins         );
222         CtdlSetConfigInt(       "c_nntp_port"           ,       lconfig->c_nntp_port            );
223         CtdlSetConfigInt(       "c_nntps_port"          ,       lconfig->c_nntps_port           );
224 }
225
226
227 /*
228  * Called during the initialization of Citadel server.
229  * It verifies the system's integrity and reads citadel.config into memory.
230  */
231 void initialize_config_system(void) {
232         FILE *cfp;
233         int rv;
234         struct legacy_config lconfig;   // legacy configuration
235         ctdlconfig = NewHash(1, NULL);  // set up the real config system
236
237         /* Ensure that we are linked to the correct version of libcitadel */
238         if (libcitadel_version_number() < LIBCITADEL_VERSION_NUMBER) {
239                 fprintf(stderr, "You are running libcitadel version %d\n", libcitadel_version_number());
240                 fprintf(stderr, "citserver was compiled against version %d\n", LIBCITADEL_VERSION_NUMBER);
241                 exit(CTDLEXIT_LIBCITADEL);
242         }
243
244         if (chdir(ctdl_bbsbase_dir) != 0) {
245                 fprintf(stderr,
246                         "This program could not be started.\nUnable to change directory to %s\nError: %s\n",
247                         ctdl_bbsbase_dir,
248                         strerror(errno)
249                 );
250                 exit(CTDLEXIT_HOME);
251         }
252
253         memset(&lconfig, 0, sizeof(struct legacy_config));
254         cfp = fopen(file_citadel_config, "rb");
255         if (cfp != NULL) {
256                 if (CtdlGetConfigLong("c_config_created_or_migrated") > 0) {
257                         fprintf(stderr, "Citadel Server found BOTH legacy and new configurations present.\n");
258                         fprintf(stderr, "Exiting to prevent data corruption.\n");
259                         exit(CTDLEXIT_CONFIG);
260                 }
261                 rv = fread((char *) &lconfig, sizeof(struct legacy_config), 1, cfp);
262                 if (rv != 1)
263                 {
264                         fprintf(stderr, 
265                                 "Warning: Found a legacy config file %s has unexpected size. \n",
266                                 file_citadel_config
267                         );
268                 }
269
270                 migrate_legacy_config(&lconfig);
271
272                 fclose(cfp);
273                 if (unlink(file_citadel_config) != 0) {
274                         fprintf(stderr, "Unable to remove legacy config file %s after migrating it.\n", file_citadel_config);
275                         fprintf(stderr, "Exiting to prevent data corruption.\n");
276                         exit(CTDLEXIT_CONFIG);
277                 }
278
279                 /*
280                  * Prevent migration/initialization from happening again.
281                  */
282                 CtdlSetConfigLong("c_config_created_or_migrated", (long)time(NULL));
283
284         }
285
286         /* New installation?  Set up configuration */
287         if (CtdlGetConfigLong("c_config_created_or_migrated") <= 0) {
288                 brand_new_installation_set_defaults();
289         }
290
291         /* Only allow LDAP auth mode if we actually have LDAP support */
292 #ifndef HAVE_LDAP
293         if ((CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP) || (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD)) {
294                 fprintf(stderr, "Your system is configured for LDAP authentication,\n"
295                                 "but you are running a server built without OpenLDAP support.\n");
296                 exit(CTDL_EXIT_UNSUP_AUTH);
297         }
298 #endif
299
300         /* Default maximum message length is 10 megabytes.  This is site
301          * configurable.  Also check to make sure the limit has not been
302          * set below 8192 bytes.
303          */
304         if (CtdlGetConfigLong("c_maxmsglen") <= 0)      CtdlSetConfigLong("c_maxmsglen", 10485760);
305         if (CtdlGetConfigLong("c_maxmsglen") < 8192)    CtdlSetConfigLong("c_maxmsglen", 8192);
306
307         /*
308          * Default lower and upper limits on number of worker threads
309          */
310         if (CtdlGetConfigInt("c_min_workers") < 5)      CtdlSetConfigInt("c_min_workers", 5);   // min
311         if (CtdlGetConfigInt("c_max_workers") == 0)     CtdlSetConfigInt("c_max_workers", 256); // default max
312         if (CtdlGetConfigInt("c_max_workers") < CtdlGetConfigInt("c_min_workers")) {
313                 CtdlSetConfigInt("c_max_workers", CtdlGetConfigInt("c_min_workers"));           // max >= min
314         }
315
316         /* Networking more than once every five minutes just isn't sane */
317         if (CtdlGetConfigLong("c_net_freq") == 0)       CtdlSetConfigLong("c_net_freq", 3600);  // once per hour default
318         if (CtdlGetConfigLong("c_net_freq") < 300)      CtdlSetConfigLong("c_net_freq", 300);   // minimum 5 minutes
319
320         /* Same goes for POP3 */
321         if (CtdlGetConfigLong("c_pop3_fetch") == 0)     CtdlSetConfigLong("c_pop3_fetch", 3600);        // once per hour default
322         if (CtdlGetConfigLong("c_pop3_fetch") < 300)    CtdlSetConfigLong("c_pop3_fetch", 300);         // 5 minutes min
323         if (CtdlGetConfigLong("c_pop3_fastest") == 0)   CtdlSetConfigLong("c_pop3_fastest", 3600);      // once per hour default
324         if (CtdlGetConfigLong("c_pop3_fastest") < 300)  CtdlSetConfigLong("c_pop3_fastest", 300);       // 5 minutes min
325
326         /* "create new user" only works with native authentication mode */
327         if (CtdlGetConfigInt("c_auth_mode") != AUTHMODE_NATIVE) {
328                 CtdlSetConfigInt("c_disable_newu", 1);
329         }
330 }
331
332
333 /*
334  * Called when Citadel server is shutting down.
335  * Clears out the config hash table.
336  */
337 void shutdown_config_system(void) 
338 {
339         DeleteHash(&ctdlconfig);
340 }
341
342
343 /*
344  * Set a system config value.  Simple key/value here.
345  */
346 void CtdlSetConfigStr(char *key, char *value)
347 {
348         int key_len = strlen(key);
349         int value_len = strlen(value);
350
351         /* Save it in memory */
352         Put(ctdlconfig, key, key_len, strdup(value), NULL);
353
354         /* Also write it to the config database */
355
356         int dbv_size = key_len + value_len + 2;
357         char *dbv = malloc(dbv_size);
358         strcpy(dbv, key);
359         strcpy(&dbv[key_len + 1], value);
360         cdb_store(CDB_CONFIG, key, key_len, dbv, dbv_size);
361         free(dbv);
362 }
363
364
365 /*
366  * Set a numeric system config value (long integer)
367  */
368 void CtdlSetConfigLong(char *key, long value)
369 {
370         char longstr[256];
371         sprintf(longstr, "%ld", value);
372         CtdlSetConfigStr(key, longstr);
373 }
374
375
376 /*
377  * Set a numeric system config value (integer)
378  */
379 void CtdlSetConfigInt(char *key, int value)
380 {
381         char intstr[256];
382         sprintf(intstr, "%d", value);
383         CtdlSetConfigStr(key, intstr);
384 }
385
386
387 /*
388  * Delete a system config value.
389  */
390 void CtdlDelConfig(char *key)
391 {
392         int key_len = strlen(key);
393
394         if (IsEmptyStr(key)) return;
395
396         /* Delete from the database. */
397         cdb_delete(CDB_CONFIG, key, key_len);
398
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);
403         }
404         DeleteHashPos(&Pos);
405
406         assert(Pos == NULL);    // no memory leaks allowed
407 }
408
409
410 /*
411  * Fetch a system config value.  Caller does *not* own the returned value and may not alter it.
412  */
413 char *CtdlGetConfigStr(char *key)
414 {
415         char *value = NULL;
416         struct cdbdata *cdb;
417         int key_len = strlen(key);
418
419         if (IsEmptyStr(key)) return(NULL);
420
421         /* First look in memory */
422         if (GetHash(ctdlconfig, key, key_len, (void *)&value))
423         {
424                 return value;
425         }
426
427         /* Then look in the database. */
428
429         cdb = cdb_fetch(CDB_CONFIG, key, key_len);
430
431         if (cdb == NULL) {      /* nope, not there either. */
432                 return(NULL);
433         }
434
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 */
437         cdb_free(cdb);
438         Put(ctdlconfig, key, key_len, value, NULL);
439         return value;
440 }
441
442
443 /*
444  * Fetch a system config value - integer
445  */
446 int CtdlGetConfigInt(char *key)
447 {
448         char *s = CtdlGetConfigStr(key);
449         if (s) return atoi(s);
450         return 0;
451 }
452
453
454 /*
455  * Fetch a system config value - long integer
456  */
457 long CtdlGetConfigLong(char *key)
458 {
459         char *s = CtdlGetConfigStr(key);
460         if (s) return atol(s);
461         return 0;
462 }
463
464
465 void CtdlGetSysConfigBackend(long msgnum, void *userdata) {
466         config_msgnum = msgnum;
467 }
468
469
470 char *CtdlGetSysConfig(char *sysconfname) {
471         char hold_rm[ROOMNAMELEN];
472         long msgnum;
473         char *conf;
474         struct CtdlMessage *msg;
475         char buf[SIZ];
476         
477         strcpy(hold_rm, CC->room.QRname);
478         if (CtdlGetRoom(&CC->room, SYSCONFIGROOM) != 0) {
479                 CtdlGetRoom(&CC->room, hold_rm);
480                 return NULL;
481         }
482
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,
487                            CtdlGetSysConfigBackend, NULL);
488         msgnum = config_msgnum;
489         end_critical_section(S_CONFIG);
490
491         if (msgnum < 0L) {
492                 conf = NULL;
493         }
494         else {
495                 msg = CtdlFetchMessage(msgnum, 1, 1);
496                 if (msg != NULL) {
497                         conf = strdup(msg->cm_fields[eMesageText]);
498                         CM_Free(msg);
499                 }
500                 else {
501                         conf = NULL;
502                 }
503         }
504
505         CtdlGetRoom(&CC->room, hold_rm);
506
507         if (conf != NULL) do {
508                         extract_token(buf, conf, 0, '\n', sizeof buf);
509                         strcpy(conf, &conf[strlen(buf)+1]);
510                 } while ( (!IsEmptyStr(conf)) && (!IsEmptyStr(buf)) );
511
512         return(conf);
513 }
514
515
516 void CtdlPutSysConfig(char *sysconfname, char *sysconfdata) {
517         CtdlWriteObject(SYSCONFIGROOM, sysconfname, sysconfdata, (strlen(sysconfdata)+1), NULL, 0, 1, 0);
518 }