2 * Citadel setup utility
5 #define SHOW_ME_VAPPEND_PRINTF
6 #include "ctdl_module.h"
13 #include <sys/types.h>
15 #include <sys/utsname.h>
23 #include <libcitadel.h>
28 #include "citadel_dirs.h"
39 #define _(string) gettext(string)
41 #define _(string) (string)
45 #define MAXSETUP 11 /* How many setup questions to ask */
47 #define UI_TEXT 0 /* Default setup type -- text only */
48 #define UI_DIALOG 2 /* Use the 'dialog' program */
49 #define UI_SILENT 3 /* Silent running, for use in scripts */
51 #define SERVICE_NAME "citadel"
52 #define PROTO_NAME "tcp"
53 #define NSSCONF "/etc/nsswitch.conf"
56 typedef enum _SetupStep {
72 ///"CREATE_XINETD_ENTRY";
73 /* Environment variables, don't translate! */
74 const char *EnvNames [eMaxQuestions] = {
90 int using_web_installer = 0;
95 const char *setup_titles[eMaxQuestions];
96 const char *setup_text[eMaxQuestions];
98 /* calculate all our path on a central place */
99 /* where to keep our config */
113 locale = setlocale(LC_MESSAGES, getenv("LANG"));
115 bindtextdomain("citadel-setup", LOCALEDIR"/locale");
116 textdomain("citadel-setup");
117 bind_textdomain_codeset("citadel-setup","UTF8");
119 setup_titles[eCitadelHomeDir] = _("Citadel Home Directory");
121 setup_text[eCitadelHomeDir] = _(
122 "Enter the full pathname of the directory in which the Citadel\n"
123 "installation you are creating or updating resides. If you\n"
124 "specify a directory other than the default, you will need to\n"
125 "specify the -h flag to the server when you start it up.\n");
127 setup_text[eCitadelHomeDir] = _(
128 "Enter the subdirectory name for an alternate installation of "
129 "Citadel. To do a default installation just leave it blank."
130 "If you specify a directory other than the default, you will need to\n"
131 "specify the -h flag to the server when you start it up.\n"
132 "note that it may not have a leading /");
135 setup_titles[eSysAdminName] = _("Citadel administrator username:");
136 setup_text[eSysAdminName] = _(
137 "Please enter the name of the Citadel user account that should be granted "
138 "administrative privileges once created. If using internal authentication "
139 "this user account will be created if it does not exist. For external "
140 "authentication this user account has to exist.");
143 setup_titles[eSysAdminPW] = _("Administrator password:");
144 setup_text[eSysAdminPW] = _(
145 "Enter a password for the system administrator. When setup\n"
146 "completes it will attempt to create the administrator user\n"
147 "and set the password specified here.\n");
149 setup_titles[eUID] = _("Citadel User ID:");
150 setup_text[eUID] = _(
151 "Citadel needs to run under its own user ID. This would\n"
152 "typically be called \"citadel\", but if you are running Citadel\n"
153 "as a public BBS, you might also call it \"bbs\" or \"guest\".\n"
154 "The server will run under this user ID. Please specify that\n"
155 "user ID here. You may specify either a user name or a numeric\n"
158 setup_titles[eIP_ADDR] = _("Listening address for the Citadel server:");
159 setup_text[eIP_ADDR] = _(
160 "Please specify the IP address which the server should be listening to. "
161 "You can name a specific IPv4 or IPv6 address, or you can specify\n"
162 "\"*\" for \"any address\", \"::\" for \"any IPv6 address\", or \"0.0.0.0\"\n"
163 "for \"any IPv4 address\". If you leave this blank, Citadel will\n"
164 "listen on all addresses. "
165 "This can usually be left to the default unless multiple instances of Citadel "
166 "are running on the same computer.");
168 setup_titles[eCTDL_Port] = _("Server port number:");
169 setup_text[eCTDL_Port] = _(
170 "Specify the TCP port number on which your server will run.\n"
171 "Normally, this will be port 504, which is the official port\n"
172 "assigned by the IANA for Citadel servers. You will only need\n"
173 "to specify a different port number if you run multiple instances\n"
174 "of Citadel on the same computer and there is something else\n"
175 "already using port 504.\n");
177 setup_titles[eAuthType] = _("Authentication method to use:");
178 setup_text[eAuthType] = _(
179 "Please choose the user authentication mode. By default Citadel will use its "
180 "own internal user accounts database. If you choose Host, Citadel users will "
181 "have accounts on the host system, authenticated via /etc/passwd or a PAM "
182 "source. LDAP chooses an RFC 2307 compliant directory server, the last option "
183 "chooses the nonstandard MS Active Directory LDAP scheme."
185 "Do not change this option unless you are sure it is required, since changing "
186 "back requires a full reinstall of Citadel."
188 " 0. Self contained authentication\n"
189 " 1. Host system integrated authentication\n"
190 " 2. External LDAP - RFC 2307 compliant directory\n"
191 " 3. External LDAP - nonstandard MS Active Directory\n"
193 "For help: http://www.citadel.org/doku.php/faq:installation:authmodes\n"
195 "ANSWER \"0\" UNLESS YOU COMPLETELY UNDERSTAND THIS OPTION.\n");
197 setup_titles[eLDAP_Host] = _("LDAP host:");
198 setup_text[eLDAP_Host] = _(
199 "Please enter the host name or IP address of your LDAP server.\n");
201 setup_titles[eLDAP_Port] = _("LDAP port number:");
202 setup_text[eLDAP_Port] = _(
203 "Please enter the port number of the LDAP service (usually 389).\n");
205 setup_titles[eLDAP_Base_DN] = _("LDAP base DN:");
206 setup_text[eLDAP_Base_DN] = _(
207 "Please enter the Base DN to search for authentication\n"
208 "(for example: dc=example,dc=com)\n");
210 setup_titles[eLDAP_Bind_DN] = _("LDAP bind DN:");
211 setup_text[eLDAP_Bind_DN] = _(
212 "Please enter the DN of an account to use for binding to the LDAP server for "
213 "performing queries. The account does not require any other privileges. If "
214 "your LDAP server allows anonymous queries, you can leave this blank."
215 "Please enter the DN of an account to use for binding to the LDAP server\n"
216 "for performing queries. The account does not require any other\n"
217 "privileges. If your LDAP server allows anonymous queries, you can\n"
218 "leave this blank.\n");
220 setup_titles[eLDAP_Bind_PW] = _("LDAP bind password:");
221 setup_text[eLDAP_Bind_PW] = _(
222 "If you entered a Bind DN in the previous question, you must now enter\n"
223 "the password associated with that account. Otherwise, you can leave this\n"
227 // Debug loading of locales... Strace does a better job though.
228 printf("Message catalog directory: %s\n", bindtextdomain("citadel-setup", LOCALEDIR"/locale"));
229 printf("Text domain: %s\n", textdomain("citadel-setup"));
230 printf("Text domain Charset: %s\n", bind_textdomain_codeset("citadel-setup","UTF8"));
233 for (i = 0; i < eMaxQuestions; i++)
234 printf("%s - %s\n", setup_titles[i], _(setup_titles[i]));
241 * print the actual stack frame.
243 void cit_backtrace(void)
245 #ifdef HAVE_BACKTRACE
246 void *stack_frames[50];
250 size = backtrace(stack_frames, sizeof(stack_frames) / sizeof(void*));
251 strings = backtrace_symbols(stack_frames, size);
252 for (i = 0; i < size; i++) {
254 fprintf(stderr, "%s\n", strings[i]);
256 fprintf(stderr, "%p\n", stack_frames[i]);
262 struct config config;
265 struct config config;
269 void cleanup(int exitcode)
271 // printf("Exitcode: %d\n", exitcode);
278 void title(const char *text)
280 if (setup_type == UI_TEXT) {
281 printf("\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<%s>\n", text);
287 int yesno(const char *question, int default_value)
293 switch (setup_type) {
297 printf("%s\n%s [%s] --> ",
300 ( default_value ? _("Yes") : _("No") )
302 if (fgets(buf, sizeof buf, stdin))
304 answer = tolower(buf[0]);
305 if ((buf[0]==0) || (buf[0]==13) || (buf[0]==10))
306 answer = default_value;
307 else if (answer == 'y')
309 else if (answer == 'n')
312 } while ((answer < 0) || (answer > 1));
316 sprintf(buf, "exec %s %s --yesno '%s' 15 75",
317 getenv("CTDL_DIALOG"),
318 ( default_value ? "" : "--defaultno" ),
336 void important_message(const char *title, const char *msgtext)
341 switch (setup_type) {
344 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");
345 printf(" %s \n\n%s\n\n", title, msgtext);
346 printf("%s", _("Press return to continue..."));
347 if (fgets(buf, sizeof buf, stdin));
351 sprintf(buf, "exec %s --msgbox '%s' 19 72",
352 getenv("CTDL_DIALOG"),
357 fprintf(stderr, "%s\n", msgtext);
362 void important_msgnum(int msgnum)
364 important_message(_("Important Message"), setup_text[msgnum]);
367 void display_error(char *error_message_format, ...)
373 va_start(arg_ptr, error_message_format);
374 StrBufVAppendPrintf(Msg,
375 error_message_format,
379 important_message(_("Error"), ChrPtr(Msg));
383 void progress(char *text, long int curr, long int cmax)
385 static long dots_printed = 0L;
387 static FILE *fp = NULL;
390 switch (setup_type) {
394 printf("%s\n", text);
395 printf("....................................................");
396 printf("..........................\r");
399 } else if (curr == cmax) {
400 printf("\r%79s\n", "");
402 a = (curr * 100) / cmax;
405 while (dots_printed < a) {
415 sprintf(buf, "exec %s --gauge '%s' 7 72 0",
416 getenv("CTDL_DIALOG"),
418 fp = popen(buf, "w");
424 else if (curr == cmax) {
426 fprintf(fp, "100\n");
432 a = (curr * 100) / cmax;
434 fprintf(fp, "%ld\n", a);
448 * check_services_entry() -- Make sure "citadel" is in /etc/services
451 void check_services_entry(void)
457 if (getservbyname(SERVICE_NAME, PROTO_NAME) == NULL) {
458 for (i=0; i<=2; ++i) {
459 progress(_("Adding service entry..."), i, 2);
461 sfp = fopen("/etc/services", "a");
463 sprintf(errmsg, "%s /etc/services: %s", _("Cannot open"), strerror(errno));
464 display_error(errmsg);
466 fprintf(sfp, "%s 504/tcp\n", SERVICE_NAME);
478 * delete_inittab_entry() -- Remove obsolete /etc/inittab entry for Citadel
480 void delete_inittab_entry(void)
484 char looking_for[256];
486 char outfilename[32];
487 int changes_made = 0;
490 /* Determine the fully qualified path name of citserver */
491 snprintf(looking_for,
497 /* Now tweak /etc/inittab */
498 infp = fopen("/etc/inittab", "r");
501 /* If /etc/inittab does not exist, return quietly.
502 * Not all host platforms have it.
504 if (errno == ENOENT) {
508 /* Other errors might mean something really did go wrong.
510 sprintf(buf, "%s /etc/inittab: %s", _("Cannot open"), strerror(errno));
515 strcpy(outfilename, "/tmp/ctdlsetup.XXXXXX");
516 outfp = fdopen(mkstemp(outfilename), "w+");
518 sprintf(buf, "%s %s: %s", _("Cannot open"), outfilename, strerror(errno));
524 while (fgets(buf, sizeof buf, infp) != NULL) {
525 if (strstr(buf, looking_for) != NULL) {
526 rv = fwrite("#", 1, 1, outfp);
529 rv = fwrite(buf, strlen(buf), 1, outfp);
536 sprintf(buf, "/bin/mv -f %s /etc/inittab 2>/dev/null", outfilename);
538 rv = system("/sbin/init q 2>/dev/null");
547 * install_init_scripts() -- Try to configure to start Citadel at boot
549 void install_init_scripts(void)
551 struct stat etcinitd;
553 char *initfile = "/etc/init.d/citadel";
557 if ((stat("/etc/init.d/", &etcinitd) == -1) &&
560 if ((stat("/etc/rc.d/init.d/", &etcinitd) == -1) &&
562 initfile = CTDLDIR"/citadel.init";
564 initfile = "/etc/rc.d/init.d/citadel";
567 fp = fopen(initfile, "r");
569 if (yesno(_("Citadel already appears to be configured to start at boot.\n"
570 "Would you like to keep your boot configuration as is?\n"), 1) == 1) {
577 if (yesno(_("Would you like to automatically start Citadel at boot?\n"), 1) == 0) {
581 fp = fopen(initfile, "w");
583 display_error("%s /etc/init.d/citadel", _("Cannot create"));
587 fprintf(fp, "#!/bin/sh\n"
589 "# Init file for Citadel\n"
591 "# chkconfig: - 79 30\n"
592 "# description: Citadel service\n"
593 "# processname: citserver\n"
594 "# pidfile: %s/citadel.pid\n\n"
595 "# uncomment this to create coredumps as described in\n"
596 "# http://www.citadel.org/doku.php/faq:mastering_your_os:gdb#how.do.i.make.my.system.produce.core-files\n"
597 "# ulimit -c unlimited\n"
605 "test -d /var/run || exit 0\n"
609 "start) echo -n \"Starting Citadel... \"\n"
610 " if $CITADEL_DIR/citserver -lmail -d\n"
617 "stop) echo -n \"Stopping Citadel... \"\n"
618 " if $CITADEL_DIR/sendcommand DOWN >/dev/null 2>&1 ; then\n"
623 " rm -f %s/citadel.pid 2>/dev/null\n"
628 "restart) if $CITADEL_DIR/sendcommand DOWN 1 >/dev/null 2>&1 ; then\n"
634 "*) echo \"Usage: $0 {start|stop|restart}\"\n"
641 chmod(initfile, 0755);
643 /* Set up the run levels. */
644 rv = system("/bin/rm -f /etc/rc?.d/[SK]??citadel 2>/dev/null");
645 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);
646 rv = system(command);
647 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);
648 rv = system(command);
655 * On systems which use xinetd, see if we can offer to install Citadel as
656 * the default telnet target.
658 void check_xinetd_entry(void) {
659 char *filename = "/etc/xinetd.d/telnet";
662 int already_citadel = 0;
665 fp = fopen(filename, "r+");
666 if (fp == NULL) return; /* Not there. Oh well... */
668 while (fgets(buf, sizeof buf, fp) != NULL) {
669 if (strstr(buf, "/citadel") != NULL) already_citadel = 1;
672 if (already_citadel) return; /* Already set up this way. */
674 /* Otherwise, prompt the user to create an entry. */
675 if (getenv("CREATE_XINETD_ENTRY") != NULL) {
676 if (strcasecmp(getenv("CREATE_XINETD_ENTRY"), "yes")) {
681 snprintf(buf, sizeof buf,
682 _("Setup can configure the \"xinetd\" service to automatically\n"
683 "connect incoming telnet sessions to Citadel, bypassing the\n"
684 "host system login: prompt. Would you like to do this?\n"
686 if (yesno(buf, 1) == 0) {
691 fp = fopen(filename, "w");
693 "# description: telnet service for Citadel users\n"
698 " socket_type = stream\n"
701 " server = /usr/sbin/in.telnetd\n"
702 " server_args = -h -L %s/citadel\n"
703 " log_on_failure += USERID\n"
708 /* Now try to restart the service */
709 rv = system("/etc/init.d/xinetd restart >/dev/null 2>&1");
715 * Offer to disable other MTA's
717 void disable_other_mta(const char *mta) {
723 sprintf(buf, "/bin/ls -l /etc/rc*.d/S*%s 2>/dev/null; "
724 "/bin/ls -l /etc/rc.d/rc*.d/S*%s 2>/dev/null",
726 fp = popen(buf, "r");
727 if (fp == NULL) return;
729 while (fgets(buf, sizeof buf, fp) != NULL) {
733 if (lines == 0) return; /* Nothing to do. */
736 /* Offer to replace other MTA with the vastly superior Citadel :) */
738 snprintf(buf, sizeof buf,
739 "%s \"%s\" %s%s%s%s%s%s%s",
740 _("You appear to have the "),
743 "running on your system. If you want Citadel mail\n"
746 _(" you will have to manually integrate\n"
747 "them. It is preferable to disable "),
749 _(", and use Citadel's\n"
750 "SMTP, POP3, and IMAP services.\n\n"
753 _("so that Citadel has access to ports\n"
754 "25, 110, and 143?\n")
756 if (yesno(buf, 1) == 0) {
761 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);
763 sprintf(buf, "/etc/init.d/%s stop >/dev/null 2>&1", mta);
767 const char *other_mtas[] = {
768 "courier-authdaemon",
791 void disable_other_mtas(void)
794 if ((getenv("ACT_AS_MTA") == NULL) ||
795 (getenv("ACT_AS_MTA") &&
796 strcasecmp(getenv("ACT_AS_MTA"), "yes") == 0)) {
797 /* Offer to disable other MTA's on the system. */
798 while (!IsEmptyStr(other_mtas[i]))
800 disable_other_mta(other_mtas[i]);
807 * Check to see if our server really works. Returns 0 on success.
809 int test_server(char *relhomestr, int relhome) {
816 /* Generate a silly little cookie. We're going to write it out
817 * to the server and try to get it back. The cookie does not
818 * have to be secret ... just unique.
820 sprintf(cookie, "--test--%d--", getpid());
823 sprintf(cmd, "%s/sendcommand -h%s ECHO %s 2>&1",
828 sprintf(cmd, "%s/sendcommand ECHO %s 2>&1",
832 fp = popen(cmd, "r");
833 if (fp == NULL) return(errno);
835 while (fgets(buf, sizeof buf, fp) != NULL) {
837 && (strstr(buf, cookie) != NULL) ) {
849 void strprompt(const char *prompt_title, const char *prompt_text, char *Target, char *DefValue)
853 char dialog_result[PATH_MAX];
857 strcpy(setupmsg, "");
859 switch (setup_type) {
862 printf("\n%s\n", prompt_text);
863 printf("%s\n%s\n", _("This is currently set to:"), Target);
864 printf("%s\n", _("Enter new value or press return to leave unchanged:"));
865 if (fgets(buf, sizeof buf, stdin)){
866 buf[strlen(buf) - 1] = 0;
868 if (!IsEmptyStr(buf))
873 CtdlMakeTempFileName(dialog_result, sizeof dialog_result);
874 sprintf(buf, "exec %s --inputbox '%s' 19 72 '%s' 2>%s",
875 getenv("CTDL_DIALOG"),
880 fp = fopen(dialog_result, "r");
882 if (fgets(Target, sizeof buf, fp)) {
883 if (Target[strlen(Target)-1] == 10) {
884 Target[strlen(Target)-1] = 0;
888 unlink(dialog_result);
892 strcpy(Target, DefValue);
897 void set_bool_val(int msgpos, int *ip, char *DefValue)
899 title(setup_titles[msgpos]);
900 *ip = yesno(setup_text[msgpos], *ip);
903 void set_str_val(int msgpos, char *Target, char *DefValue)
905 strprompt(setup_titles[msgpos],
911 void set_int_val(int msgpos, int *ip, char *DefValue)
914 snprintf(buf, sizeof buf, "%d", (int) *ip);
915 set_str_val(msgpos, buf, DefValue);
920 void set_char_val(int msgpos, char *ip, char *DefValue)
923 snprintf(buf, sizeof buf, "%d", (int) *ip);
924 set_str_val(msgpos, buf, DefValue);
925 *ip = (char) atoi(buf);
929 void set_long_val(int msgpos, long int *ip, char *DefValue)
932 snprintf(buf, sizeof buf, "%ld", *ip);
933 set_str_val(msgpos, buf, DefValue);
938 void edit_value(int curr)
942 char ctdluidname[256];
945 if (setup_type == UI_SILENT)
947 Value = getenv(EnvNames[curr]);
956 set_str_val(curr, config.c_sysadm, Value);
960 set_str_val(curr, admin_pass, Value);
964 if (setup_type == UI_SILENT)
967 config.c_ctdluid = atoi(Value);
973 config.c_ctdluid = 0; /* XXX Windows hack, prob. insecure */
975 i = config.c_ctdluid;
978 set_int_val(curr, &i, Value);
979 config.c_ctdluid = i;
982 strcpy(ctdluidname, pw->pw_name);
983 set_str_val(curr, ctdluidname, Value);
984 pw = getpwnam(ctdluidname);
986 config.c_ctdluid = pw->pw_uid;
988 else if (atoi(ctdluidname) > 0) {
989 config.c_ctdluid = atoi(ctdluidname);
997 set_str_val(curr, config.c_ip_addr, Value);
1001 set_int_val(curr, &config.c_port_number, Value);
1005 if (setup_type == UI_SILENT)
1008 config.c_auth_mode = AUTHMODE_NATIVE;
1012 if ((strcasecmp(auth, "yes") == 0) ||
1013 (strcasecmp(auth, "host") == 0))
1015 config.c_auth_mode = AUTHMODE_HOST;
1017 else if (strcasecmp(auth, "ldap") == 0){
1018 config.c_auth_mode = AUTHMODE_LDAP;
1020 else if ((strcasecmp(auth, "ldap_ad") == 0) ||
1021 (strcasecmp(auth, "active directory") == 0)){
1022 config.c_auth_mode = AUTHMODE_LDAP_AD;
1027 set_int_val(curr, &config.c_auth_mode, Value);
1032 set_str_val(curr, config.c_ldap_host, Value);
1036 if (config.c_ldap_port == 0) {
1037 config.c_ldap_port = 389;
1039 set_int_val(curr, &config.c_ldap_port, Value);
1043 set_str_val(curr, config.c_ldap_base_dn, Value);
1047 set_str_val(curr, config.c_ldap_bind_dn, Value);
1051 set_str_val(curr, config.c_ldap_bind_pw, Value);
1058 * (re-)write the config data to disk
1060 void write_config_to_disk(void)
1066 if ((fd = creat(file_citadel_config, S_IRUSR | S_IWUSR)) == -1) {
1067 display_error("%s citadel.config [%s][%s]\n", _("setup: cannot open"), file_citadel_config, strerror(errno));
1070 fp = fdopen(fd, "wb");
1072 display_error("%s citadel.config [%s][%s]\n", _("setup: cannot open"), file_citadel_config, strerror(errno));
1075 rv = fwrite((char *) &config, sizeof(struct config), 1, fp);
1083 * Figure out what type of user interface we're going to use
1085 int discover_ui(void)
1088 /* Use "dialog" if we have it */
1089 if (getenv("CTDL_DIALOG") != NULL) {
1098 void migrate_old_installs(void)
1101 rv = system("exec /bin/rm -fr ./rooms ./chatpipes ./expressmsgs ./sessions 2>/dev/null");
1102 unlink("citadel.log");
1108 * Strip "db" entries out of /etc/nsswitch.conf
1118 int file_changed = 0;
1119 char new_filename[64];
1122 fp_read = fopen(NSSCONF, "r");
1123 if (fp_read == NULL) {
1127 strcpy(new_filename, "/tmp/ctdl_fixnss_XXXXXX");
1128 fd_write = mkstemp(new_filename);
1134 while (fgets(buf, sizeof buf, fp_read) != NULL) {
1136 strcpy(buf_nc, buf);
1137 for (i=0; i<strlen(buf_nc); ++i) {
1138 if (buf_nc[i] == '#') {
1142 for (i=0; i<strlen(buf_nc); ++i) {
1143 if (!strncasecmp(&buf_nc[i], "db", 2)) {
1145 if ((isspace(buf_nc[i+2])) || (buf_nc[i+2]==0)) {
1148 strcpy(&buf_nc[i], &buf_nc[i+2]);
1149 strcpy(&buf[i], &buf[i+2]);
1151 strcpy(&buf_nc[i], &buf_nc[i+1]);
1152 strcpy(&buf[i], &buf[i+1]);
1158 if (write(fd_write, buf, strlen(buf)) != strlen(buf)) {
1161 unlink(new_filename);
1168 if (!file_changed) {
1169 unlink(new_filename);
1173 snprintf(question, sizeof question,
1176 "/etc/nsswitch.conf is configured to use the 'db' module for\n"
1177 "one or more services. This is not necessary on most systems,\n"
1178 "and it is known to crash the Citadel server when delivering\n"
1179 "mail to the Internet.\n"
1181 "Do you want this module to be automatically disabled?\n"
1186 if (yesno(question, 1)) {
1187 sprintf(buf, "/bin/mv -f %s %s", new_filename, NSSCONF);
1189 chmod(NSSCONF, 0644);
1191 unlink(new_filename);
1194 void check_init_script (char *relhome)
1200 * If we're running on SysV, install init scripts.
1202 if (!access("/var/run", W_OK)) {
1204 if (getenv("NO_INIT_SCRIPTS") == NULL) {
1205 install_init_scripts();
1208 if (!access("/etc/init.d/citadel", X_OK)) {
1209 rv = system("/etc/init.d/citadel start");
1213 if (test_server(relhome, enable_home) == 0) {
1217 if (config.c_auth_mode == AUTHMODE_NATIVE) {
1218 snprintf (admin_cmd, sizeof(admin_cmd), "%s/sendcommand \"CREU %s|%s\" 2>&1",
1219 ctdl_sbin_dir, config.c_sysadm, admin_pass);
1220 fp = popen(admin_cmd, "r");
1222 while (fgets(buf, sizeof buf, fp) != NULL)
1224 if ((atol(buf) == 574) || (atol(buf) == 200))
1230 if (found_it == 0) {
1231 important_message("Error","Setup failed to create your admin user");
1235 if (setup_type != UI_SILENT)
1236 important_message(_("Setup finished"),
1237 _("Setup of the Citadel server is complete.\n"
1238 "If you will be using WebCit, please run its\n"
1239 "setup program now; otherwise, run './citadel'\n"
1243 important_message(_("Setup failed"),
1244 _("Setup is finished, but the Citadel server failed to start.\n"
1245 "Go back and check your configuration.\n")
1252 important_message(_("Setup finished"),
1253 _("Setup is finished. You may now start the server."));
1259 #define GetDefaultVALINT(CFGNAME, DEFL) GetDefaultValInt(&config.CFGNAME, "CITADEL_"#CFGNAME, DEFL)
1260 void GetDefaultValInt(int *WhereTo, const char *VarName, int DefVal)
1263 if (*WhereTo == 0) *WhereTo = DefVal;
1265 if ((setup_type == UI_SILENT) &&
1266 (ch = getenv(VarName), ch != NULL))
1268 *WhereTo = atoi(ch);
1271 #define GetDefaultVALCHAR(CFGNAME, DEFL) GetDefaultValChar(&config.CFGNAME, "CITADEL_"#CFGNAME, DEFL)
1272 void GetDefaultValChar(char *WhereTo, const char *VarName, char DefVal)
1275 if (*WhereTo == 0) *WhereTo = DefVal;
1277 if ((setup_type == UI_SILENT) &&
1278 (ch = getenv(VarName), ch != NULL))
1280 *WhereTo = atoi(ch);
1283 #define GetDefaultVALSTR(CFGNAME, DEFL) GetDefaultValStr((char**)&config.CFGNAME, sizeof(config.CFGNAME), "CITADEL_"#CFGNAME, DEFL)
1284 void GetDefaultValStr(char **WhereTo, size_t nMax, const char *VarName, const char *DefVal)
1287 if (**WhereTo == '\0')
1288 safestrncpy(*WhereTo, DefVal, nMax);
1290 if ((setup_type == UI_SILENT) &&
1291 (ch = getenv(VarName), ch != NULL))
1293 safestrncpy(*WhereTo, ch, nMax);
1298 void set_default_values(void)
1301 struct utsname my_utsname;
1304 /* Determine our host name, in case we need to use it as a default */
1307 /* set some sample/default values in place of blanks... */
1308 GetDefaultVALSTR(c_nodename, my_utsname.nodename);
1309 strtok(config.c_nodename, ".");
1310 if (IsEmptyStr(config.c_fqdn) ) {
1311 if ((he = gethostbyname(my_utsname.nodename)) != NULL) {
1312 safestrncpy(config.c_fqdn, he->h_name, sizeof config.c_fqdn);
1314 safestrncpy(config.c_fqdn, my_utsname.nodename, sizeof config.c_fqdn);
1317 GetDefaultVALSTR(c_humannode, _("My System"));
1318 GetDefaultVALSTR(c_phonenum, _("US 800 555 1212"));
1320 GetDefaultVALCHAR(c_initax, 4);
1322 GetDefaultVALSTR(c_moreprompt, "<more>");
1323 GetDefaultVALSTR(c_twitroom, "Trashcan");
1324 GetDefaultVALSTR(c_baseroom, BASEROOM);
1325 GetDefaultVALSTR(c_aideroom, "Aide");
1326 GetDefaultVALINT(c_port_number, 504);
1328 GetDefaultVALINT(c_sleeping, 900);
1330 if (config.c_ctdluid == 0) {
1331 pw = getpwnam("citadel");
1333 config.c_ctdluid = pw->pw_uid;
1336 if (config.c_ctdluid == 0) {
1337 pw = getpwnam("bbs");
1339 config.c_ctdluid = pw->pw_uid;
1342 if (config.c_ctdluid == 0) {
1343 pw = getpwnam("guest");
1345 config.c_ctdluid = pw->pw_uid;
1348 if (config.c_createax == 0) {
1349 config.c_createax = 3;
1352 * Negative values for maxsessions are not allowed.
1354 if (config.c_maxsessions < 0) {
1355 config.c_maxsessions = 0;
1357 /* We need a system default message expiry policy, because this is
1358 * the top level and there's no 'higher' policy to fall back on.
1359 * By default, do not expire messages at all.
1361 if (config.c_ep.expire_mode == 0) {
1362 config.c_ep.expire_mode = EXPIRE_MANUAL;
1363 config.c_ep.expire_value = 0;
1367 * Default port numbers for various services
1369 GetDefaultVALINT(c_smtp_port, 25);
1370 GetDefaultVALINT(c_pop3_port, 110);
1371 GetDefaultVALINT(c_imap_port, 143);
1372 GetDefaultVALINT(c_msa_port, 587);
1373 GetDefaultVALINT(c_smtps_port, 465);
1374 GetDefaultVALINT(c_pop3s_port, 995);
1375 GetDefaultVALINT(c_imaps_port, 993);
1376 GetDefaultVALINT(c_pftcpdict_port, -1);
1377 GetDefaultVALINT(c_managesieve_port, 2020);
1378 GetDefaultVALINT(c_xmpp_c2s_port, 5222);
1379 GetDefaultVALINT(c_xmpp_s2s_port, 5269);
1383 void get_config (void)
1390 * What we're going to try to do here is append a whole bunch of
1391 * nulls to the citadel.config file, so we can keep the old config
1392 * values if they exist, but if the file is missing or from an
1393 * earlier version with a shorter config structure, when setup tries
1394 * to read the old config parameters, they'll all come up zero.
1395 * The length of the config file will be set to what it's supposed
1396 * to be when we rewrite it, because we replace the old file with a
1397 * completely new copy.
1399 if ((a = open(file_citadel_config, O_WRONLY | O_CREAT | O_APPEND,
1400 S_IRUSR | S_IWUSR)) == -1) {
1401 display_error("%s citadel.config [%s][%s]\n", _("setup: cannot append"), file_citadel_config, strerror(errno));
1404 fp = fdopen(a, "ab");
1406 display_error("%s citadel.config [%s][%s]\n", _("setup: cannot append"), file_citadel_config, strerror(errno));
1409 for (a = 0; a < sizeof(struct config); ++a) {
1414 /* now we re-open it, and read the old or blank configuration */
1415 fp = fopen(file_citadel_config, "rb");
1417 display_error("%s citadel.config [%s][%s]\n", _("setup: cannot open"), file_citadel_config, strerror(errno));
1420 rv = fread((char *) &config, sizeof(struct config), 1, fp);
1425 int main(int argc, char *argv[])
1430 int old_setup_level = 0;
1434 char relhome[PATH_MAX]="";
1435 char ctdldir[PATH_MAX]=CTDLDIR;
1440 /* set an invalid setup type */
1443 /* Check to see if we're running the web installer */
1444 if (getenv("CITADEL_INSTALLER") != NULL) {
1445 using_web_installer = 1;
1448 /* parse command line args */
1449 for (a = 0; a < argc; ++a) {
1450 if (!strncmp(argv[a], "-u", 2)) {
1451 strcpy(aaa, argv[a]);
1452 strcpy(aaa, &aaa[2]);
1453 setup_type = atoi(aaa);
1455 else if (!strcmp(argv[a], "-i")) {
1458 else if (!strcmp(argv[a], "-q")) {
1459 setup_type = UI_SILENT;
1461 else if (!strncmp(argv[a], "-h", 2)) {
1462 relh=argv[a][2]!='/';
1464 safestrncpy(ctdl_home_directory, &argv[a][2], sizeof ctdl_home_directory);
1466 safestrncpy(relhome, &argv[a][2], sizeof relhome);
1473 calc_dirs_n_files(relh, home, relhome, ctdldir, 0);
1476 /* If a setup type was not specified, try to determine automatically
1477 * the best one to use out of all available types.
1479 if (setup_type < 0) {
1480 setup_type = discover_ui();
1482 if (info_only == 1) {
1483 important_message(_("Citadel Setup"), CITADEL);
1487 enable_home = ( relh | home );
1489 if (chdir(ctdl_run_dir) != 0) {
1490 display_error(_("Citadel Setup"),
1492 _("The directory you specified does not exist"),
1498 /* Try to stop Citadel if we can */
1499 if (!access("/etc/init.d/citadel", X_OK)) {
1500 rv = system("/etc/init.d/citadel stop");
1503 /* Make sure Citadel is not running. */
1504 if (test_server(relhome, enable_home) == 0) {
1505 important_message(_("Citadel Setup"),
1506 _("The Citadel service is still running.\n"
1507 "Please stop the service manually and run "
1513 switch (setup_type) {
1518 _("Citadel setup program"));
1525 set_default_values();
1527 /* Go through a series of dialogs prompting for config info */
1528 for (curr = 1; curr <= MAXSETUP; ++curr) {
1530 if ((curr == 6) && (config.c_auth_mode != AUTHMODE_LDAP) && (config.c_auth_mode != AUTHMODE_LDAP_AD)) {
1531 curr += 5; /* skip LDAP questions if we're not authenticating against LDAP */
1535 /***** begin version update section *****/
1537 old_setup_level = config.c_setup_level;
1539 if (old_setup_level == 0) {
1543 if (old_setup_level < 555) {
1546 _("This Citadel installation is too old to be upgraded.")
1550 write_config_to_disk();
1552 old_setup_level = config.c_setup_level;
1554 /***** end of version update section *****/
1557 config.c_setup_level = REV_LEVEL;
1559 if ((pw = getpwuid(config.c_ctdluid)) == NULL) {
1565 create_run_directories(config.c_ctdluid, gid);
1567 write_config_to_disk();
1569 migrate_old_installs(); /* Delete files and directories used by older Citadel versions */
1571 if ( ((setup_type == UI_SILENT)
1572 && (getenv("ALTER_ETC_SERVICES")!=NULL))
1573 || (setup_type != UI_SILENT)
1575 check_services_entry(); /* Check /etc/services */
1579 delete_inittab_entry(); /* Remove obsolete /etc/inittab entry */
1580 check_xinetd_entry(); /* Check /etc/xinetd.d/telnet */
1581 disable_other_mtas(); /* Offer to disable other MTAs */
1582 fixnss(); /* Check for the 'db' nss and offer to disable it */
1585 progress(_("Setting file permissions"), 1, 3);
1586 rv = chown(file_citadel_config, config.c_ctdluid, gid);
1587 progress(_("Setting file permissions"), 2, 3);
1588 rv = chmod(file_citadel_config, S_IRUSR | S_IWUSR);
1589 progress(_("Setting file permissions"), 3, 3);
1591 check_init_script(relhome);