4 * Citadel setup utility
8 #define SHOW_ME_VAPPEND_PRINTF
10 #include "ctdl_module.h"
19 #include <sys/types.h>
21 #include <sys/utsname.h>
29 #include <libcitadel.h>
34 #include "citadel_dirs.h"
45 #define _(string) gettext(string)
47 #define _(string) (string)
51 #define MAXSETUP 11 /* How many setup questions to ask */
53 #define UI_TEXT 0 /* Default setup type -- text only */
54 #define UI_DIALOG 2 /* Use the 'dialog' program */
55 #define UI_SILENT 3 /* Silent running, for use in scripts */
57 #define SERVICE_NAME "citadel"
58 #define PROTO_NAME "tcp"
59 #define NSSCONF "/etc/nsswitch.conf"
62 typedef enum _SetupStep {
78 ///"CREATE_XINETD_ENTRY";
79 const char *EnvNames [eMaxQuestions] = {
95 int using_web_installer = 0;
100 const char *setup_titles[eMaxQuestions];
104 setup_titles[eCitadelHomeDir] = _("Citadel Home Directory");
105 setup_titles[eSysAdminName] = _("Citadel administrator username:");////
106 setup_titles[eSysAdminPW] = _("Administrator password:");//
107 setup_titles[eUID] = _("Citadel User ID:");
108 setup_titles[eIP_ADDR] = _("Listening address for the Citadel server:");///
109 setup_titles[eCTDL_Port] = _("Server port number:");
110 setup_titles[eAuthType] = _("Authentication method to use:");////
111 setup_titles[eLDAP_Host] = _("LDAP host:");///
112 setup_titles[eLDAP_Port] = _("LDAP port number:");////
113 setup_titles[eLDAP_Base_DN] = _("LDAP base DN:");///
114 setup_titles[eLDAP_Bind_DN] = _("LDAP bind DN:");//
115 setup_titles[eLDAP_Bind_PW] = _("LDAP bind password:");//
119 * \brief print the actual stack frame.
121 void cit_backtrace(void)
123 #ifdef HAVE_BACKTRACE
124 void *stack_frames[50];
129 size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
130 strings = backtrace_symbols(stack_frames, size);
131 for (i = 0; i < size; i++) {
133 fprintf(stderr, "%s\n", strings[i]);
135 fprintf(stderr, "%p\n", stack_frames[i]);
141 struct config config;
143 /* calculate all our path on a central place */
144 /* where to keep our config */
147 char *setup_text[] = {
149 "Enter the full pathname of the directory in which the Citadel\n"
150 "installation you are creating or updating resides. If you\n"
151 "specify a directory other than the default, you will need to\n"
152 "specify the -h flag to the server when you start it up.\n",
154 "Enter the subdirectory name for an alternate installation of "
155 "Citadel. To do a default installation just leave it blank."
156 "If you specify a directory other than the default, you will need to\n"
157 "specify the -h flag to the server when you start it up.\n"
158 "note that it may not have a leading /",
161 "Enter the name of the system administrator (which is probably\n"
162 "you). When an account is created with this name, it will\n"
163 "automatically be given administrator-level access.\n",
165 "Enter a password for the system administrator. When setup\n"
166 "completes it will attempt to create the administrator user\n"
167 "and set the password specified here.\n",
169 "Citadel needs to run under its own user ID. This would\n"
170 "typically be called \"citadel\", but if you are running Citadel\n"
171 "as a public BBS, you might also call it \"bbs\" or \"guest\".\n"
172 "The server will run under this user ID. Please specify that\n"
173 "user ID here. You may specify either a user name or a numeric\n"
176 "Specify the IP address on which your server will run. If you\n"
177 "leave this blank, or if you specify 0.0.0.0, Citadel will listen\n"
178 "on all addresses. You can usually skip this unless you are\n"
179 "running multiple instances of Citadel on the same computer.\n",
181 "Specify the TCP port number on which your server will run.\n"
182 "Normally, this will be port 504, which is the official port\n"
183 "assigned by the IANA for Citadel servers. You will only need\n"
184 "to specify a different port number if you run multiple instances\n"
185 "of Citadel on the same computer and there is something else\n"
186 "already using port 504.\n",
190 "Specify which authentication mode you wish to use.\n"
192 " 0. Self contained authentication\n"
193 " 1. Host system integrated authentication\n"
194 " 2. External LDAP - RFC 2307 compliant directory\n"
195 " 3. External LDAP - nonstandard MS Active Directory\n"
197 "For help: http://www.citadel.org/doku.php/faq:installation:authmodes\n"
199 "ANSWER \"0\" UNLESS YOU COMPLETELY UNDERSTAND THIS OPTION.\n",
201 "Please enter the host name or IP address of your LDAP server.\n",
203 "Please enter the port number of the LDAP service (usually 389).\n",
205 "Please enter the Base DN to search for authentication\n"
206 "(for example: dc=example,dc=com)\n",
208 "Please enter the DN of an account to use for binding to the LDAP server\n"
209 "for performing queries. The account does not require any other\n"
210 "privileges. If your LDAP server allows anonymous queries, you can.\n"
211 "leave this blank.\n",
213 "If you entered a Bind DN in the previous question, you must now enter\n"
214 "the password associated with that account. Otherwise, you can leave this\n"
219 struct config config;
223 void cleanup(int exitcode)
225 // printf("Exitcode: %d\n", exitcode);
232 void title(const char *text)
234 if (setup_type == UI_TEXT) {
235 printf("\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<%s>\n", text);
241 int yesno(char *question, int default_value)
247 switch (setup_type) {
251 printf("%s\nYes/No [%s] --> ",
253 ( default_value ? "Yes" : "No" )
255 if (fgets(buf, sizeof buf, stdin))
257 answer = tolower(buf[0]);
258 if ((buf[0]==0) || (buf[0]==13) || (buf[0]==10))
259 answer = default_value;
260 else if (answer == 'y')
262 else if (answer == 'n')
265 } while ((answer < 0) || (answer > 1));
269 sprintf(buf, "exec %s %s --yesno '%s' 15 75",
270 getenv("CTDL_DIALOG"),
271 ( default_value ? "" : "--defaultno" ),
289 void important_message(char *title, char *msgtext)
294 switch (setup_type) {
297 printf("\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n");
298 printf(" %s \n\n%s\n\n", title, msgtext);
299 printf("Press return to continue...");
300 if (fgets(buf, sizeof buf, stdin));
304 sprintf(buf, "exec %s --msgbox '%s' 19 72",
305 getenv("CTDL_DIALOG"),
310 fprintf(stderr, "%s\n", msgtext);
315 void important_msgnum(int msgnum)
317 important_message("Important Message", setup_text[msgnum]);
320 void display_error(char *error_message)
322 important_message("Error", error_message);
325 void progress(char *text, long int curr, long int cmax)
327 static long dots_printed = 0L;
329 static FILE *fp = NULL;
332 switch (setup_type) {
336 printf("%s\n", text);
337 printf("..........................");
338 printf("..........................");
339 printf("..........................\r");
342 } else if (curr == cmax) {
343 printf("\r%79s\n", "");
345 a = (curr * 100) / cmax;
348 while (dots_printed < a) {
358 sprintf(buf, "exec %s --gauge '%s' 7 72 0",
359 getenv("CTDL_DIALOG"),
361 fp = popen(buf, "w");
367 else if (curr == cmax) {
369 fprintf(fp, "100\n");
375 a = (curr * 100) / cmax;
377 fprintf(fp, "%ld\n", a);
391 * check_services_entry() -- Make sure "citadel" is in /etc/services
394 void check_services_entry(void)
400 if (getservbyname(SERVICE_NAME, PROTO_NAME) == NULL) {
401 for (i=0; i<=2; ++i) {
402 progress("Adding service entry...", i, 2);
404 sfp = fopen("/etc/services", "a");
406 sprintf(errmsg, "Cannot open /etc/services: %s", strerror(errno));
407 display_error(errmsg);
409 fprintf(sfp, "%s 504/tcp\n", SERVICE_NAME);
421 * delete_inittab_entry() -- Remove obsolete /etc/inittab entry for Citadel
424 void delete_inittab_entry(void)
428 char looking_for[256];
430 char outfilename[32];
431 int changes_made = 0;
434 /* Determine the fully qualified path name of citserver */
435 snprintf(looking_for,
441 /* Now tweak /etc/inittab */
442 infp = fopen("/etc/inittab", "r");
445 /* If /etc/inittab does not exist, return quietly.
446 * Not all host platforms have it.
448 if (errno == ENOENT) {
452 /* Other errors might mean something really did go wrong.
454 sprintf(buf, "Cannot open /etc/inittab: %s", strerror(errno));
459 strcpy(outfilename, "/tmp/ctdlsetup.XXXXXX");
460 outfp = fdopen(mkstemp(outfilename), "w+");
462 sprintf(buf, "Cannot open %s: %s", outfilename, strerror(errno));
468 while (fgets(buf, sizeof buf, infp) != NULL) {
469 if (strstr(buf, looking_for) != NULL) {
470 rv = fwrite("#", 1, 1, outfp);
473 rv = fwrite(buf, strlen(buf), 1, outfp);
480 sprintf(buf, "/bin/mv -f %s /etc/inittab 2>/dev/null", outfilename);
482 rv = system("/sbin/init q 2>/dev/null");
491 * install_init_scripts() -- Try to configure to start Citadel at boot
494 void install_init_scripts(void)
496 struct stat etcinitd;
498 char *initfile = "/etc/init.d/citadel";
502 if ((stat("/etc/init.d/", &etcinitd) == -1) &&
505 if ((stat("/etc/rc.d/init.d/", &etcinitd) == -1) &&
507 initfile = CTDLDIR"/citadel.init";
509 initfile = "/etc/rc.d/init.d/citadel";
512 fp = fopen(initfile, "r");
514 if (yesno("Citadel already appears to be configured to start at boot.\n"
515 "Would you like to keep your boot configuration as is?\n", 1) == 1) {
522 if (yesno("Would you like to automatically start Citadel at boot?\n", 1) == 0) {
526 fp = fopen(initfile, "w");
528 display_error("Cannot create /etc/init.d/citadel");
532 fprintf(fp, "#!/bin/sh\n"
534 "# Init file for Citadel\n"
536 "# chkconfig: - 79 30\n"
537 "# description: Citadel service\n"
538 "# processname: citserver\n"
539 "# pidfile: %s/citadel.pid\n\n"
540 "# uncomment this to create coredumps as described in\n"
541 "# http://www.citadel.org/doku.php/faq:mastering_your_os:gdb#how.do.i.make.my.system.produce.core-files\n"
542 "# ulimit -c unlimited\n"
550 "test -d /var/run || exit 0\n"
554 "start) echo -n \"Starting Citadel... \"\n"
555 " if $CITADEL_DIR/citserver -lmail -d\n"
562 "stop) echo -n \"Stopping Citadel... \"\n"
563 " if $CITADEL_DIR/sendcommand DOWN >/dev/null 2>&1 ; then\n"
568 " rm -f %s/citadel.pid 2>/dev/null\n"
573 "restart) if $CITADEL_DIR/sendcommand DOWN 1 >/dev/null 2>&1 ; then\n"
579 "*) echo \"Usage: $0 {start|stop|restart}\"\n"
586 chmod(initfile, 0755);
588 /* Set up the run levels. */
589 rv = system("/bin/rm -f /etc/rc?.d/[SK]??citadel 2>/dev/null");
590 snprintf(command, sizeof(command), "for x in 2 3 4 5 ; do [ -d /etc/rc$x.d ] && ln -s %s /etc/rc$x.d/S79citadel ; done 2>/dev/null", initfile);
591 rv = system(command);
592 snprintf(command, sizeof(command),"for x in 0 6 S; do [ -d /etc/rc$x.d ] && ln -s %s /etc/rc$x.d/K30citadel ; done 2>/dev/null", initfile);
593 rv = system(command);
603 * On systems which use xinetd, see if we can offer to install Citadel as
604 * the default telnet target.
606 void check_xinetd_entry(void) {
607 char *filename = "/etc/xinetd.d/telnet";
610 int already_citadel = 0;
613 fp = fopen(filename, "r+");
614 if (fp == NULL) return; /* Not there. Oh well... */
616 while (fgets(buf, sizeof buf, fp) != NULL) {
617 if (strstr(buf, "/citadel") != NULL) already_citadel = 1;
620 if (already_citadel) return; /* Already set up this way. */
622 /* Otherwise, prompt the user to create an entry. */
623 if (getenv("CREATE_XINETD_ENTRY") != NULL) {
624 if (strcasecmp(getenv("CREATE_XINETD_ENTRY"), "yes")) {
629 snprintf(buf, sizeof buf,
630 "Setup can configure the \"xinetd\" service to automatically\n"
631 "connect incoming telnet sessions to Citadel, bypassing the\n"
632 "host system login: prompt. Would you like to do this?\n"
634 if (yesno(buf, 1) == 0) {
639 fp = fopen(filename, "w");
641 "# description: telnet service for Citadel users\n"
646 " socket_type = stream\n"
649 " server = /usr/sbin/in.telnetd\n"
650 " server_args = -h -L %s/citadel\n"
651 " log_on_failure += USERID\n"
656 /* Now try to restart the service */
657 rv = system("/etc/init.d/xinetd restart >/dev/null 2>&1");
663 * Offer to disable other MTA's
665 void disable_other_mta(const char *mta) {
671 sprintf(buf, "/bin/ls -l /etc/rc*.d/S*%s 2>/dev/null; "
672 "/bin/ls -l /etc/rc.d/rc*.d/S*%s 2>/dev/null",
674 fp = popen(buf, "r");
675 if (fp == NULL) return;
677 while (fgets(buf, sizeof buf, fp) != NULL) {
681 if (lines == 0) return; /* Nothing to do. */
684 /* Offer to replace other MTA with the vastly superior Citadel :) */
686 snprintf(buf, sizeof buf,
687 "You appear to have the \"%s\" email program\n"
688 "running on your system. If you want Citadel mail\n"
689 "connected with %s, you will have to manually integrate\n"
690 "them. It is preferable to disable %s, and use Citadel's\n"
691 "SMTP, POP3, and IMAP services.\n\n"
692 "May we disable %s so that Citadel has access to ports\n"
693 "25, 110, and 143?\n",
696 if (yesno(buf, 1) == 0) {
701 sprintf(buf, "for x in /etc/rc*.d/S*%s; do mv $x `echo $x |sed s/S/K/g`; done >/dev/null 2>&1", mta);
703 sprintf(buf, "/etc/init.d/%s stop >/dev/null 2>&1", mta);
707 const char *other_mtas[] = {
708 "courier-authdaemon",
731 void disable_other_mtas(void)
734 if ((getenv("ACT_AS_MTA") == NULL) ||
735 (getenv("ACT_AS_MTA") &&
736 strcasecmp(getenv("ACT_AS_MTA"), "yes") == 0)) {
737 /* Offer to disable other MTA's on the system. */
738 while (!IsEmptyStr(other_mtas[i]))
740 disable_other_mta(other_mtas[i]);
747 * Check to see if our server really works. Returns 0 on success.
749 int test_server(char *relhomestr, int relhome) {
756 /* Generate a silly little cookie. We're going to write it out
757 * to the server and try to get it back. The cookie does not
758 * have to be secret ... just unique.
760 sprintf(cookie, "--test--%d--", getpid());
763 sprintf(cmd, "%s/sendcommand -h%s ECHO %s 2>&1",
768 sprintf(cmd, "%s/sendcommand ECHO %s 2>&1",
772 fp = popen(cmd, "r");
773 if (fp == NULL) return(errno);
775 while (fgets(buf, sizeof buf, fp) != NULL) {
777 && (strstr(buf, cookie) != NULL) ) {
789 void strprompt(const char *prompt_title, char *prompt_text, char *Target, char *DefValue)
793 char dialog_result[PATH_MAX];
797 strcpy(setupmsg, "");
799 switch (setup_type) {
802 printf("\n%s\n", prompt_text);
803 printf("This is currently set to:\n%s\n", Target);
804 printf("Enter new value or press return to leave unchanged:\n");
805 if (fgets(buf, sizeof buf, stdin)){
806 buf[strlen(buf) - 1] = 0;
808 if (!IsEmptyStr(buf))
813 CtdlMakeTempFileName(dialog_result, sizeof dialog_result);
814 sprintf(buf, "exec %s --inputbox '%s' 19 72 '%s' 2>%s",
815 getenv("CTDL_DIALOG"),
820 fp = fopen(dialog_result, "r");
822 if (fgets(Target, sizeof buf, fp)) {
823 if (Target[strlen(Target)-1] == 10) {
824 Target[strlen(Target)-1] = 0;
828 unlink(dialog_result);
832 strcpy(Target, DefValue);
837 void set_bool_val(int msgpos, int *ip, char *DefValue) {
838 title(setup_titles[msgpos]);
839 *ip = yesno(setup_text[msgpos], *ip);
842 void set_str_val(int msgpos, char *Target, char *DefValue) {
843 strprompt(setup_titles[msgpos],
849 void set_int_val(int msgpos, int *ip, char *DefValue)
852 snprintf(buf, sizeof buf, "%d", (int) *ip);
853 set_str_val(msgpos, buf, DefValue);
858 void set_char_val(int msgpos, char *ip, char *DefValue)
861 snprintf(buf, sizeof buf, "%d", (int) *ip);
862 set_str_val(msgpos, buf, DefValue);
863 *ip = (char) atoi(buf);
867 void set_long_val(int msgpos, long int *ip, char *DefValue)
870 snprintf(buf, sizeof buf, "%ld", *ip);
871 set_str_val(msgpos, buf, DefValue);
876 void edit_value(int curr)
880 char ctdluidname[256];
883 if (setup_type == UI_SILENT)
885 Value = getenv(EnvNames[curr]);
892 set_str_val(curr, config.c_sysadm, Value);
896 set_str_val(curr, admin_pass, Value);
900 if (setup_type == UI_SILENT)
903 config.c_ctdluid = atoi(Value);
909 config.c_ctdluid = 0; /* XXX Windows hack, prob. insecure */
911 i = config.c_ctdluid;
914 set_int_val(curr, &i, Value);
915 config.c_ctdluid = i;
918 strcpy(ctdluidname, pw->pw_name);
919 set_str_val(curr, ctdluidname, Value);
920 pw = getpwnam(ctdluidname);
922 config.c_ctdluid = pw->pw_uid;
924 else if (atoi(ctdluidname) > 0) {
925 config.c_ctdluid = atoi(ctdluidname);
933 set_str_val(curr, config.c_ip_addr, Value);
937 set_int_val(curr, &config.c_port_number, Value);
941 if (setup_type == UI_SILENT)
944 config.c_auth_mode = AUTHMODE_NATIVE;
948 if ((strcasecmp(auth, "yes") == 0) ||
949 (strcasecmp(auth, "host") == 0))
951 config.c_auth_mode = AUTHMODE_HOST;
953 else if (strcasecmp(auth, "ldap") == 0){
954 config.c_auth_mode = AUTHMODE_LDAP;
956 else if ((strcasecmp(auth, "ldap_ad") == 0) ||
957 (strcasecmp(auth, "active directory") == 0)){
958 config.c_auth_mode = AUTHMODE_LDAP_AD;
963 set_int_val(curr, &config.c_auth_mode, Value);
968 set_str_val(curr, config.c_ldap_host, Value);
972 if (config.c_ldap_port == 0) {
973 config.c_ldap_port = 389;
975 set_int_val(curr, &config.c_ldap_port, Value);
979 set_str_val(curr, config.c_ldap_base_dn, Value);
983 set_str_val(curr, config.c_ldap_bind_dn, Value);
987 set_str_val(curr, config.c_ldap_bind_pw, Value);
994 * (re-)write the config data to disk
996 void write_config_to_disk(void)
1002 if ((fd = creat(file_citadel_config, S_IRUSR | S_IWUSR)) == -1) {
1003 display_error("setup: cannot open citadel.config");
1006 fp = fdopen(fd, "wb");
1008 display_error("setup: cannot open citadel.config");
1011 rv = fwrite((char *) &config, sizeof(struct config), 1, fp);
1019 * Figure out what type of user interface we're going to use
1021 int discover_ui(void)
1024 /* Use "dialog" if we have it */
1025 if (getenv("CTDL_DIALOG") != NULL) {
1034 void migrate_old_installs(void)
1037 rv = system("exec /bin/rm -fr ./rooms ./chatpipes ./expressmsgs ./sessions 2>/dev/null");
1038 unlink("citadel.log");
1044 * Strip "db" entries out of /etc/nsswitch.conf
1054 int file_changed = 0;
1055 char new_filename[64];
1058 fp_read = fopen(NSSCONF, "r");
1059 if (fp_read == NULL) {
1063 strcpy(new_filename, "/tmp/ctdl_fixnss_XXXXXX");
1064 fd_write = mkstemp(new_filename);
1070 while (fgets(buf, sizeof buf, fp_read) != NULL) {
1072 strcpy(buf_nc, buf);
1073 for (i=0; i<strlen(buf_nc); ++i) {
1074 if (buf_nc[i] == '#') {
1078 for (i=0; i<strlen(buf_nc); ++i) {
1079 if (!strncasecmp(&buf_nc[i], "db", 2)) {
1081 if ((isspace(buf_nc[i+2])) || (buf_nc[i+2]==0)) {
1084 strcpy(&buf_nc[i], &buf_nc[i+2]);
1085 strcpy(&buf[i], &buf[i+2]);
1087 strcpy(&buf_nc[i], &buf_nc[i+1]);
1088 strcpy(&buf[i], &buf[i+1]);
1094 if (write(fd_write, buf, strlen(buf)) != strlen(buf)) {
1097 unlink(new_filename);
1104 if (!file_changed) {
1105 unlink(new_filename);
1109 snprintf(question, sizeof question,
1111 "/etc/nsswitch.conf is configured to use the 'db' module for\n"
1112 "one or more services. This is not necessary on most systems,\n"
1113 "and it is known to crash the Citadel server when delivering\n"
1114 "mail to the Internet.\n"
1116 "Do you want this module to be automatically disabled?\n"
1120 if (yesno(question, 1)) {
1121 sprintf(buf, "/bin/mv -f %s %s", new_filename, NSSCONF);
1123 chmod(NSSCONF, 0644);
1125 unlink(new_filename);
1128 void check_init_script (char *relhome)
1134 * If we're running on SysV, install init scripts.
1136 if (!access("/var/run", W_OK)) {
1138 if (getenv("NO_INIT_SCRIPTS") == NULL) {
1139 install_init_scripts();
1142 if (!access("/etc/init.d/citadel", X_OK)) {
1143 rv = system("/etc/init.d/citadel start");
1147 if (test_server(relhome, enable_home) == 0) {
1151 if (config.c_auth_mode == AUTHMODE_NATIVE) {
1152 snprintf (admin_cmd, sizeof(admin_cmd), "%s/sendcommand \"CREU %s|%s\" 2>&1",
1153 ctdl_sbin_dir, config.c_sysadm, admin_pass);
1154 fp = popen(admin_cmd, "r");
1156 while (fgets(buf, sizeof buf, fp) != NULL)
1158 if ((atol(buf) == 574) || (atol(buf) == 200))
1164 if (found_it == 0) {
1165 important_message("Error","Setup failed to create your admin user");
1169 if (setup_type != UI_SILENT)
1170 important_message("Setup finished",
1171 "Setup of the Citadel server is complete.\n"
1172 "If you will be using WebCit, please run its\n"
1173 "setup program now; otherwise, run './citadel'\n"
1177 important_message("Setup failed",
1178 "Setup is finished, but the Citadel server failed to start.\n"
1179 "Go back and check your configuration.\n"
1186 important_message("Setup finished",
1187 "Setup is finished. You may now start the server.");
1191 void set_default_values(void)
1194 struct utsname my_utsname;
1197 /* Determine our host name, in case we need to use it as a default */
1200 /* set some sample/default values in place of blanks... */
1201 if (IsEmptyStr(config.c_nodename))
1202 safestrncpy(config.c_nodename, my_utsname.nodename,
1203 sizeof config.c_nodename);
1204 strtok(config.c_nodename, ".");
1205 if (IsEmptyStr(config.c_fqdn) ) {
1206 if ((he = gethostbyname(my_utsname.nodename)) != NULL) {
1207 safestrncpy(config.c_fqdn, he->h_name, sizeof config.c_fqdn);
1209 safestrncpy(config.c_fqdn, my_utsname.nodename, sizeof config.c_fqdn);
1212 if (IsEmptyStr(config.c_humannode)) {
1213 strcpy(config.c_humannode, "My System");
1215 if (IsEmptyStr(config.c_phonenum)) {
1216 strcpy(config.c_phonenum, "US 800 555 1212");
1218 if (config.c_initax == 0) {
1219 config.c_initax = 4;
1221 if (IsEmptyStr(config.c_moreprompt)) strcpy(config.c_moreprompt, "<more>");
1222 if (IsEmptyStr(config.c_twitroom)) strcpy(config.c_twitroom, "Trashcan");
1223 if (IsEmptyStr(config.c_baseroom)) strcpy(config.c_baseroom, BASEROOM);
1224 if (IsEmptyStr(config.c_aideroom)) strcpy(config.c_aideroom, "Aide");
1225 if (config.c_port_number == 0) {
1226 config.c_port_number = 504;
1228 if (config.c_sleeping == 0) {
1229 config.c_sleeping = 900;
1231 if (config.c_ctdluid == 0) {
1232 pw = getpwnam("citadel");
1234 config.c_ctdluid = pw->pw_uid;
1237 if (config.c_ctdluid == 0) {
1238 pw = getpwnam("bbs");
1240 config.c_ctdluid = pw->pw_uid;
1243 if (config.c_ctdluid == 0) {
1244 pw = getpwnam("guest");
1246 config.c_ctdluid = pw->pw_uid;
1249 if (config.c_createax == 0) {
1250 config.c_createax = 3;
1253 * Negative values for maxsessions are not allowed.
1255 if (config.c_maxsessions < 0) {
1256 config.c_maxsessions = 0;
1258 /* We need a system default message expiry policy, because this is
1259 * the top level and there's no 'higher' policy to fall back on.
1260 * By default, do not expire messages at all.
1262 if (config.c_ep.expire_mode == 0) {
1263 config.c_ep.expire_mode = EXPIRE_MANUAL;
1264 config.c_ep.expire_value = 0;
1268 * Default port numbers for various services
1270 if (config.c_smtp_port == 0) config.c_smtp_port = 25;
1271 if (config.c_pop3_port == 0) config.c_pop3_port = 110;
1272 if (config.c_imap_port == 0) config.c_imap_port = 143;
1273 if (config.c_msa_port == 0) config.c_msa_port = 587;
1274 if (config.c_smtps_port == 0) config.c_smtps_port = 465;
1275 if (config.c_pop3s_port == 0) config.c_pop3s_port = 995;
1276 if (config.c_imaps_port == 0) config.c_imaps_port = 993;
1277 if (config.c_pftcpdict_port == 0) config.c_pftcpdict_port = -1;
1278 if (config.c_managesieve_port == 0) config.c_managesieve_port = 2020;
1279 if (config.c_xmpp_c2s_port == 0) config.c_xmpp_c2s_port = 5222;
1280 if (config.c_xmpp_s2s_port == 0) config.c_xmpp_s2s_port = 5269;
1284 void get_config (void)
1291 * What we're going to try to do here is append a whole bunch of
1292 * nulls to the citadel.config file, so we can keep the old config
1293 * values if they exist, but if the file is missing or from an
1294 * earlier version with a shorter config structure, when setup tries
1295 * to read the old config parameters, they'll all come up zero.
1296 * The length of the config file will be set to what it's supposed
1297 * to be when we rewrite it, because we replace the old file with a
1298 * completely new copy.
1300 if ((a = open(file_citadel_config, O_WRONLY | O_CREAT | O_APPEND,
1301 S_IRUSR | S_IWUSR)) == -1) {
1302 display_error("setup: cannot append citadel.config");
1305 fp = fdopen(a, "ab");
1307 display_error("setup: cannot append citadel.config");
1310 for (a = 0; a < sizeof(struct config); ++a) {
1315 /* now we re-open it, and read the old or blank configuration */
1316 fp = fopen(file_citadel_config, "rb");
1318 display_error("setup: cannot open citadel.config");
1321 rv = fread((char *) &config, sizeof(struct config), 1, fp);
1326 int main(int argc, char *argv[])
1331 int old_setup_level = 0;
1335 char relhome[PATH_MAX]="";
1336 char ctdldir[PATH_MAX]=CTDLDIR;
1341 /* set an invalid setup type */
1344 /* Check to see if we're running the web installer */
1345 if (getenv("CITADEL_INSTALLER") != NULL) {
1346 using_web_installer = 1;
1349 /* parse command line args */
1350 for (a = 0; a < argc; ++a) {
1351 if (!strncmp(argv[a], "-u", 2)) {
1352 strcpy(aaa, argv[a]);
1353 strcpy(aaa, &aaa[2]);
1354 setup_type = atoi(aaa);
1356 else if (!strcmp(argv[a], "-i")) {
1359 else if (!strcmp(argv[a], "-q")) {
1360 setup_type = UI_SILENT;
1362 else if (!strncmp(argv[a], "-h", 2)) {
1363 relh=argv[a][2]!='/';
1365 safestrncpy(ctdl_home_directory, &argv[a][2], sizeof ctdl_home_directory);
1367 safestrncpy(relhome, &argv[a][2], sizeof relhome);
1374 calc_dirs_n_files(relh, home, relhome, ctdldir, 0);
1377 /* If a setup type was not specified, try to determine automatically
1378 * the best one to use out of all available types.
1380 if (setup_type < 0) {
1381 setup_type = discover_ui();
1383 if (info_only == 1) {
1384 important_message("Citadel Setup", CITADEL);
1388 enable_home = ( relh | home );
1390 if (chdir(ctdl_run_dir) != 0) {
1392 sprintf(errmsg, "The directory you specified does not exist: [%s]\n", ctdl_run_dir);
1394 important_message("Citadel Setup", errmsg);
1399 /* Try to stop Citadel if we can */
1400 if (!access("/etc/init.d/citadel", X_OK)) {
1401 rv = system("/etc/init.d/citadel stop");
1404 /* Make sure Citadel is not running. */
1405 if (test_server(relhome, enable_home) == 0) {
1406 important_message("Citadel Setup",
1407 "The Citadel service is still running.\n"
1408 "Please stop the service manually and run "
1414 switch (setup_type) {
1418 " *** Citadel setup program ***\n\n");
1425 set_default_values();
1427 /* Go through a series of dialogs prompting for config info */
1428 for (curr = 1; curr <= MAXSETUP; ++curr) {
1430 if ((curr == 6) && (config.c_auth_mode != AUTHMODE_LDAP) && (config.c_auth_mode != AUTHMODE_LDAP_AD)) {
1431 curr += 5; /* skip LDAP questions if we're not authenticating against LDAP */
1435 /***** begin version update section ***** */
1436 /* take care of any updating that is necessary */
1438 old_setup_level = config.c_setup_level;
1440 if (old_setup_level == 0) {
1444 if (old_setup_level < 555) {
1445 important_message("Citadel Setup",
1446 "This Citadel installation is too old "
1450 write_config_to_disk();
1452 old_setup_level = config.c_setup_level;
1454 /* end of version update section */
1457 config.c_setup_level = REV_LEVEL;
1459 /******************************************/
1460 if ((pw = getpwuid(config.c_ctdluid)) == NULL) {
1466 create_run_directories(config.c_ctdluid, gid);
1468 write_config_to_disk();
1470 migrate_old_installs(); /* Delete files and directories used by older Citadel versions */
1472 if (((setup_type == UI_SILENT) && (getenv("ALTER_ETC_SERVICES")!=NULL)) ||
1473 (setup_type != UI_SILENT))
1474 check_services_entry(); /* Check /etc/services */
1476 delete_inittab_entry(); /* Remove obsolete /etc/inittab entry */
1477 check_xinetd_entry(); /* Check /etc/xinetd.d/telnet */
1478 disable_other_mtas(); /* Offer to disable other MTAs */
1481 fixnss(); /* Check for the 'db' nss and offer to disable it */
1483 progress("Setting file permissions", 1, 3);
1484 rv = chown(file_citadel_config, config.c_ctdluid, gid);
1485 progress("Setting file permissions", 2, 3);
1486 rv = chmod(file_citadel_config, S_IRUSR | S_IWUSR);
1487 progress("Setting file permissions", 3, 3);
1489 check_init_script (relhome);